\Pop\Pdf\Build\ObjectParentObject

Pdf parent object class

Summary

Methods
Properties
Constants
setIndex()
setData()
setImported()
getIndex()
getData()
isImported()
getDictionaryReferences()
__toString()
__construct()
parse()
addKid()
removeKid()
setKids()
getCount()
getKids()
hasKid()
No public properties found
No constants found
No protected methods found
$index
$data
$isImported
$kids
N/A
No private methods found
No private properties found
N/A

Properties

$index

$index : integer

PDF parent object index

Type

integer

$data

$data : string

PDF object data

Type

string

$isImported

$isImported : string

Imported flag

Type

string

$kids

$kids : array

PDF parent kids

Type

array

Methods

setImported()

setImported(boolean  $imported) : \Pop\Pdf\Build\Object\AbstractObject

Set whether the object is imported

Parameters

boolean $imported

Returns

\Pop\Pdf\Build\Object\AbstractObject

getIndex()

getIndex() : integer

Get the object index

Returns

integer

getData()

getData() : string

Get the object stream

Returns

string

isImported()

isImported() : boolean

Determine if the object is imported

Returns

boolean

getDictionaryReferences()

getDictionaryReferences(string  $dictionary) : array

Get the integer references within a dictionary stream

Parameters

string $dictionary

Returns

array

__toString()

__toString() : string

Method to print the parent object.

Returns

string

__construct()

__construct(integer  $index = 2) 

Constructor

Instantiate a PDF parent object.

Parameters

integer $index

parse()

parse(string  $stream) : \Pop\Pdf\Build\Object\ParentObject

Parse a parent object from a string

Parameters

string $stream

Returns

\Pop\Pdf\Build\Object\ParentObject

addKid()

addKid(integer  $kid) : \Pop\Pdf\Build\Object\ParentObject

Add a kid index to the parent object

Parameters

integer $kid

Returns

\Pop\Pdf\Build\Object\ParentObject

removeKid()

removeKid(integer  $kid) : \Pop\Pdf\Build\Object\ParentObject

Remove a kid index from the parent object

Parameters

integer $kid

Returns

\Pop\Pdf\Build\Object\ParentObject

getCount()

getCount() : integer

Get the parent object kid count

Returns

integer

getKids()

getKids() : array

Get the parent object kid indices

Returns

array

hasKid()

hasKid(integer  $kid) : boolean

Determine whether the parent object contains a kid object index

Parameters

integer $kid

Returns

boolean