Form
in package
Pdf form class
Tags
Table of Contents
Properties
Methods
- __construct() : mixed
- Constructor
- addFieldIndex() : Form
- Add field index
- getFieldIndices() : array<string|int, mixed>
- Get field indices
- getName() : string|null
- Get the form name
- getNumberOfFields() : int
- Get number of fields
- getStream() : string
- Get the form stream
- setName() : Form
- Set form name
Properties
$fields
Form field indices
protected
array<string|int, mixed>
$fields
= []
$name
Form name
protected
string|null
$name
= null
Methods
__construct()
Constructor
public
__construct(string $name) : mixed
Instantiate a PDF form object.
Parameters
- $name : string
addFieldIndex()
Add field index
public
addFieldIndex(int $i) : Form
Parameters
- $i : int
Return values
FormgetFieldIndices()
Get field indices
public
getFieldIndices() : array<string|int, mixed>
Return values
array<string|int, mixed>getName()
Get the form name
public
getName() : string|null
Return values
string|nullgetNumberOfFields()
Get number of fields
public
getNumberOfFields() : int
Return values
intgetStream()
Get the form stream
public
getStream(int $i) : string
Parameters
- $i : int
Return values
stringsetName()
Set form name
public
setName(string $name) : Form
Parameters
- $name : string