RootObject
extends AbstractObject
in package
Pdf root object class
Tags
Table of Contents
Properties
- $data : string|null
- PDF object data
- $index : int|null
- PDF root object index
- $isImported : bool
- Imported flag
- $parent : int
- PDF root parent index
- $version : float
- PDF version
Methods
- __construct() : mixed
- Constructor
- __toString() : string
- Method to print the root object.
- getData() : string|null
- Get the object stream
- getDictionaryReferences() : array<string|int, mixed>
- Get the integer references within a dictionary stream
- getIndex() : int|null
- Get the object index
- getParentIndex() : int
- Get the root object parent index
- getVersion() : float
- Get the root object version
- isImported() : bool
- Determine if the object is imported
- parse() : RootObject
- Parse a root object from a string
- setData() : AbstractObject
- Set the object data
- setFormReferences() : RootObject
- Set the root object form index
- setImported() : AbstractObject
- Set whether the object is imported
- setIndex() : AbstractObject
- Set the object index
- setParentIndex() : RootObject
- Set the root object parent index
- setVersion() : RootObject
- Set the root object version
Properties
$data
PDF object data
protected
string|null
$data
= null
$index
PDF root object index
protected
int|null
$index
= 1
$isImported
Imported flag
protected
bool
$isImported
= false
$parent
PDF root parent index
protected
int
$parent
= 2
$version
PDF version
protected
float
$version
= 1.7
Methods
__construct()
Constructor
public
__construct([int $index = 1 ]) : mixed
Instantiate a PDF root object.
Parameters
- $index : int = 1
__toString()
Method to print the root object.
public
__toString() : string
Return values
stringgetData()
Get the object stream
public
getData() : string|null
Return values
string|nullgetDictionaryReferences()
Get the integer references within a dictionary stream
public
getDictionaryReferences(string $dictionary) : array<string|int, mixed>
Parameters
- $dictionary : string
Return values
array<string|int, mixed>getIndex()
Get the object index
public
getIndex() : int|null
Return values
int|nullgetParentIndex()
Get the root object parent index
public
getParentIndex() : int
Return values
intgetVersion()
Get the root object version
public
getVersion() : float
Return values
floatisImported()
Determine if the object is imported
public
isImported() : bool
Return values
boolparse()
Parse a root object from a string
public
static parse(string $stream) : RootObject
Parameters
- $stream : string
Return values
RootObjectsetData()
Set the object data
public
setData(string $data) : AbstractObject
Parameters
- $data : string
Return values
AbstractObjectsetFormReferences()
Set the root object form index
public
setFormReferences(string $forms) : RootObject
Parameters
- $forms : string
Return values
RootObjectsetImported()
Set whether the object is imported
public
setImported(bool $imported) : AbstractObject
Parameters
- $imported : bool
Return values
AbstractObjectsetIndex()
Set the object index
public
setIndex(int $i) : AbstractObject
Parameters
- $i : int
Return values
AbstractObjectsetParentIndex()
Set the root object parent index
public
setParentIndex(int $p) : RootObject
Parameters
- $p : int
Return values
RootObjectsetVersion()
Set the root object version
public
setVersion(float $version) : RootObject
Parameters
- $version : float