ParentObject
extends AbstractObject
in package
Pdf parent object class
Tags
Table of Contents
Properties
- $data : string|null
- PDF object data
- $index : int|null
- PDF parent object index
- $isImported : bool
- Imported flag
- $kids : array<string|int, mixed>
- PDF parent kids
Methods
- __construct() : mixed
- Constructor
- __toString() : string
- Method to print the parent object.
- addKid() : ParentObject
- Add a kid index to the parent object
- getCount() : int
- Get the parent object kid count
- 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
- getKids() : array<string|int, mixed>
- Get the parent object kid indices
- hasKid() : bool
- Determine whether the parent object contains a kid object index
- isImported() : bool
- Determine if the object is imported
- parse() : ParentObject
- Parse a parent object from a string
- removeKid() : ParentObject
- Remove a kid index from the parent object
- setData() : AbstractObject
- Set the object data
- setImported() : AbstractObject
- Set whether the object is imported
- setIndex() : AbstractObject
- Set the object index
- setKids() : ParentObject
- Set the parent object kids
Properties
$data
PDF object data
protected
string|null
$data
= null
$index
PDF parent object index
protected
int|null
$index
= 2
$isImported
Imported flag
protected
bool
$isImported
= false
$kids
PDF parent kids
protected
array<string|int, mixed>
$kids
= []
Methods
__construct()
Constructor
public
__construct([int $index = 2 ]) : mixed
Instantiate a PDF parent object.
Parameters
- $index : int = 2
__toString()
Method to print the parent object.
public
__toString() : string
Return values
stringaddKid()
Add a kid index to the parent object
public
addKid(int $kid) : ParentObject
Parameters
- $kid : int
Return values
ParentObjectgetCount()
Get the parent object kid count
public
getCount() : int
Return values
intgetData()
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|nullgetKids()
Get the parent object kid indices
public
getKids() : array<string|int, mixed>
Return values
array<string|int, mixed>hasKid()
Determine whether the parent object contains a kid object index
public
hasKid(int $kid) : bool
Parameters
- $kid : int
Return values
boolisImported()
Determine if the object is imported
public
isImported() : bool
Return values
boolparse()
Parse a parent object from a string
public
static parse(string $stream) : ParentObject
Parameters
- $stream : string
Return values
ParentObjectremoveKid()
Remove a kid index from the parent object
public
removeKid(int $kid) : ParentObject
Parameters
- $kid : int
Return values
ParentObjectsetData()
Set the object data
public
setData(string $data) : AbstractObject
Parameters
- $data : string
Return values
AbstractObjectsetImported()
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
AbstractObjectsetKids()
Set the parent object kids
public
setKids(array<string|int, mixed> $kids) : ParentObject
Parameters
- $kids : array<string|int, mixed>