PDF file element implementation

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

 Methods

Clean up resources, used by object

cleanUp() 

Get top level parent indirect object.

getParentObject() : \Zend_Pdf_Element_Object

Returns

\Zend_Pdf_Element_Object

Return type of the element.

getType() : integer

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) 
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
Static

Parameters

$input

mixed

Returns

\Zend_Pdf_Element

Set top level parent indirect object.

setParentObject(\Zend_Pdf_Element_Object $parent) 

Parameters

$parent

\Zend_Pdf_Element_Object

Convert PDF element to PHP type.

toPhp() : mixed

Returns

mixed

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

toString(\Zend_Pdf_Factory $factory = null) : string

$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.

 Properties

 

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