Class SetaPDF_Merger_Collection_Schema in SetaPDF v2 API Reference

Index

\SetaPDF
1. Merger
2. Merger
  1. Collection
  2. Collection
    1. Schema
    2. Schema
      1. Field

SetaPDF_Merger_Collection_Schema Class for handling data schemas in PDF Collections/Portfolios/Packages.

File: /SetaPDF v2/Merger/Collection/Schema.php

Class hierarchy

SetaPDF_Merger_Collection_Schema

Summary

Constants

DATA_COMPRESSED_SIZE

public const string SetaPDF_Merger_Collection_Schema::DATA_COMPRESSED_SIZE = 'CompressedSize'

Constant defining the compressed size property

DATA_CREATION_DATE

public const string SetaPDF_Merger_Collection_Schema::DATA_CREATION_DATE = 'CreationDate'

Constant defining the creation date property

DATA_DESCRIPTION

public const string SetaPDF_Merger_Collection_Schema::DATA_DESCRIPTION = 'Desc'

Constant defining the description property

DATA_FILE_NAME

public const string SetaPDF_Merger_Collection_Schema::DATA_FILE_NAME = 'F'

Constant defining the file name property

DATA_MODIFICATION_DATE

public const string SetaPDF_Merger_Collection_Schema::DATA_MODIFICATION_DATE = 'ModDate'

Constant defining the modification date property

DATA_SIZE

public const string SetaPDF_Merger_Collection_Schema::DATA_SIZE = 'Size'

Constant defining the size property

TYPE_DATE

public const string SetaPDF_Merger_Collection_Schema::TYPE_DATE = 'D'

Constant defining a date data type

TYPE_NUMBER

public const string SetaPDF_Merger_Collection_Schema::TYPE_NUMBER = 'N'

Constant defining a number type

TYPE_STRING

public const string SetaPDF_Merger_Collection_Schema::TYPE_STRING = 'S'

Constant defining a string data type (value needs to be in PdfDocEncoding or UTF-16BE)

Properties

$_collection

protected SetaPDF_Merger_Collection SetaPDF_Merger_Collection_Schema::$_collection

The collection instance.

Methods

__construct()

public SetaPDF_Merger_Collection_Schema::__construct (

SetaPDF_Merger_Collection $collection

)

The constructor.

Parameters

$collection : SetaPDF_Merger_Collection

addField()

public SetaPDF_Merger_Collection_Schema::addField (

string $name [, null|string|SetaPDF_Merger_Collection_Schema_Field $fieldOrFieldName = null [, null|string $dataType = null [, null|integer $order = null ]]]

): SetaPDF_Merger_Collection_Schema_Field

Add a field to the schema.

Parameters

$name : string: The internal field key name.
$fieldOrFieldName : null|string|SetaPDF_Merger_Collection_Schema_Field: The field name or an instance of a field.
$dataType : null|string: The data field or type. See class constants for possible values.
$order : null|integer: The relative order of the field name in the user interface. You should set this, otherwise you will get an unexpected result in different PDF viewers.