PDF file 'indirect object' element implementation

category Zend
package Zend_Pdf
copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license New BSD License
inherited_from \Zend_Pdf_Element

 Methods

Call handler

__call(string $method, array $args) : mixed

Parameters

$method

string

$args

array

Returns

mixed

Object constructor

__construct(\Zend_Pdf_Element $val, integer $objNum, integer $genNum, \Zend_Pdf_ElementFactory $factory) 

Parameters

$val

\Zend_Pdf_Element

$objNum

integer

$genNum

integer

$factory

\Zend_Pdf_ElementFactory

Exceptions

\Zend_Pdf_Exception

Get handler

__get(string $property) : mixed

Parameters

$property

string

Returns

mixed

Set handler

__set(string $property, mixed $value) 

Parameters

$property

string

$value

mixed

Clean up resources, used by object

cleanUp() 
inherited_from \Zend_Pdf_Element::cleanUp()

Clean up resources, used by object

cleanUp() 
Inherited

Dump object to a string to save within PDF file.

dump(\Zend_Pdf_ElementFactory $factory) : string

$factory parameter defines operation context.

Parameters

$factory

\Zend_Pdf_ElementFactory

Returns

string

Check, that object is generated by specified factory

getFactory() : \Zend_Pdf_ElementFactory

Returns

\Zend_Pdf_ElementFactory

Get generation number

getGenNum() : integer

Returns

integer

Get object number

getObjNum() : integer

Returns

integer

Return object, which can be used to identify object and its references identity

getObject() : \Zend_Pdf_Element_Object

Returns

\Zend_Pdf_Element_Object

Get top level parent indirect object.

getParentObject() : \Zend_Pdf_Element_Object
Inherited

Returns

\Zend_Pdf_Element_Object

Return type of the element.

getType() : integer

See ZPdfPDFConst for possible values

inherited_from \Zend_Pdf_Element::getType()

Returns

integer

Return type of the element.

getType() : integer
Inherited

See ZPdfPDFConst for possible values

Returns

integer

Detach PDF object from the factory (if applicable), clone it and attach to new factory.

makeClone(\Zend_Pdf_ElementFactory $factory, array $processed, integer $mode) 
returns Zend_Pdf_Element
inherited_from \Zend_Pdf_Element::makeClone()

Parameters

$factory

\Zend_Pdf_ElementFactory

The factory to attach

$processed

$mode

integer

Cloning mode (defines filter for objects cloning)

Detach PDF object from the factory (if applicable), clone it and attach to new factory.

makeClone(\Zend_Pdf_ElementFactory $factory, array $processed, integer $mode) 
Inherited
todo It's nevessry to check if SplObjectStorage class works faster (Needs PHP 5.3.x to attach object _with_ additional data to storage)
returns Zend_Pdf_Element

Parameters

$factory

\Zend_Pdf_ElementFactory

The factory to attach

$processed

$mode

integer

Cloning mode (defines filter for objects cloning)

Convert PHP value into PDF element.

phpToPdf(mixed $input) : \Zend_Pdf_Element
InheritedStatic

Parameters

$input

mixed

Returns

\Zend_Pdf_Element

Set top level parent indirect object.

setParentObject(\Zend_Pdf_Element_Object $parent) 
Inherited

Parameters

$parent

\Zend_Pdf_Element_Object

Convert PDF element to PHP type.

toPhp() : mixed
inherited_from \Zend_Pdf_Element::toPhp()

Returns

mixed

Convert PDF element to PHP type.

toPhp() : mixed
Inherited

Returns

mixed

Return reference to the object

toString(\Zend_Pdf_Factory $factory = null) : string

$factory parameter defines operation context.

inherited_from \Zend_Pdf_Element::toString()

Parameters

$factory

\Zend_Pdf_Factory

Returns

string

Convert element to a string, which can be directly written to a PDF file.

toString(\Zend_Pdf_Factory $factory = null) : string
Inherited

$factory parameter defines operation context.

Parameters

$factory

\Zend_Pdf_Factory

Returns

string

Mark object as modified, to include it into new PDF file segment

touch() 

We don't automate this action to keep control on PDF update process. All new objects are treated as "modified" automatically.

inherited_from \Zend_Pdf_Element::touch()

Mark object as modified, to include it into new PDF file segment.

touch() 
Inherited

We don't automate this action to keep control on PDF update process. All new objects are treated as "modified" automatically.

 Properties

 

Reference to the factory.

$_factory : \Zend_Pdf_ElementFactory

Default

 

Generation number

$_genNum : integer

Default

 

Object number within PDF file

$_objNum : integer

Default

 

Object value

$_value : \Zend_Pdf_Element

Default

 

Reference to the top level indirect object, which contains this element.

$_parentObject : \Zend_Pdf_Element_Object

Default

null

 Constants

 

CLONE_MODE_FORCE_CLONING

CLONE_MODE_FORCE_CLONING = 2 
 

CLONE_MODE_SKIP_PAGES

CLONE_MODE_SKIP_PAGES = 1 
 

TYPE_ARRAY

TYPE_ARRAY = 5 
 

TYPE_BOOL

TYPE_BOOL = 1 
 

TYPE_DICTIONARY

TYPE_DICTIONARY = 6 
 

TYPE_NAME

TYPE_NAME = 4 
 

TYPE_NULL

TYPE_NULL = 11 
 

TYPE_NUMERIC

TYPE_NUMERIC = 2 
 

TYPE_STREAM

TYPE_STREAM = 7 
 

TYPE_STRING

TYPE_STRING = 3