SetaPDF_Merger_Collection_Schema_Field Class representing a field in a schema.

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

Class hierarchy

Summary

Properties

$_dictionary

protected SetaPDF_Core_Type_Dictionary SetaPDF_Merger_Collection_Schema_Field::$_dictionary

The fields dictionary.


Static Methods

create()

public static SetaPDF_Merger_Collection_Schema_Field::create (
string $fieldName, string $dataType [, string $encoding = 'UTF-8' ]
): SetaPDF_Merger_Collection_Schema_Field

Create a schema field by a name and data type.

Parameters
$fieldName : string
 
$dataType : string
 
$encoding : string
 

Methods

__construct()

getAllowEdit()

Get a flag indicating whether the interactive PDF processor should provide support for editing the field value.

getDataType()

Get the data type.

getDictionary()

getName()

public SetaPDF_Merger_Collection_Schema_Field::getName (
[ string $encoding = 'UTF-8' ]
): string

Get the textual field name that shall be presented to the user by the interactive PDF processor.

Parameters
$encoding : string
 

getOrder()

public SetaPDF_Merger_Collection_Schema_Field::getOrder (
void
): integer|null

Get the relative order of the field name in the user interface.

getVisibility()

Get the initial visibility of the field in the user interface.

setAllowEdit()

Set a flag indicating whether the interactive PDF processor should provide support for editing the field value.

Parameters
$allowEdit : boolean
 

setDataType()

Set the data type.

Parameters
$dataType : string
 

setName()

public SetaPDF_Merger_Collection_Schema_Field::setName (
string $name [, string $encoding = 'UTF-8' ]
): SetaPDF_Merger_Collection_Schema_Field

Set the textual field name that shall be presented to the user by the interactive PDF processor.

Parameters
$name : string
 
$encoding : string
 

setOrder()

Set the relative order of the field name in the user interface.

If you set it, you should set this in all fields. Otherwise you will get an unexpected result in different PDF viewers.

Parameters
$order : integer
 

setVisibility()

Set the initial visibility of the field in the user interface.

Parameters
$visibility : boolean