\Pop\Pdf\Build\ObjectRootObject

Pdf root object class

Summary

Methods
Properties
Constants
setIndex()
setData()
setImported()
getIndex()
getData()
isImported()
getDictionaryReferences()
__toString()
__construct()
parse()
setVersion()
setParentIndex()
setFormReferences()
getVersion()
getParentIndex()
getFormIndex()
No public properties found
No constants found
No protected methods found
$index
$data
$isImported
$version
$parent
N/A
No private methods found
No private properties found
N/A

Properties

$index

$index : integer

PDF root object index

Type

integer

$data

$data : string

PDF object data

Type

string

$isImported

$isImported : string

Imported flag

Type

string

$version

$version : float

PDF version

Type

float

$parent

$parent : integer

PDF root parent index

Type

integer

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 root object.

Returns

string

__construct()

__construct(integer  $index = 1) 

Constructor

Instantiate a PDF root object.

Parameters

integer $index

parse()

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

Parse a root object from a string

Parameters

string $stream

Returns

\Pop\Pdf\Build\Object\RootObject

setVersion()

setVersion(float  $version) : \Pop\Pdf\Build\Object\RootObject

Set the root object version

Parameters

float $version

Returns

\Pop\Pdf\Build\Object\RootObject

setParentIndex()

setParentIndex(integer  $p) : \Pop\Pdf\Build\Object\RootObject

Set the root object parent index

Parameters

integer $p

Returns

\Pop\Pdf\Build\Object\RootObject

setFormReferences()

setFormReferences(string  $forms) : \Pop\Pdf\Build\Object\RootObject

Set the root object form index

Parameters

string $forms

Returns

\Pop\Pdf\Build\Object\RootObject

getVersion()

getVersion() : float

Get the root object version

Returns

float

getParentIndex()

getParentIndex() : integer

Get the root object parent index

Returns

integer

getFormIndex()

getFormIndex() : integer

Get the root object form index

Returns

integer