Docs For Class Zend_Pdf_Element

Description

PDF file 'indirect object' element implementation

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

Located in /Pdf/Element/Object.php (line 35)

Zend_Pdf_Element
   |
   --Zend_Pdf_Element_Object

Direct descendents

Class	Description
Zend_Pdf_Element_Object_Stream	PDF file 'stream object' element implementation

Variable Summary

Zend_Pdf_ElementFactory $_factory

integer $_genNum

integer $_objNum

Zend_Pdf_Element $_value

Method Summary

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

void cleanUp ()

string dump (Zend_Pdf_ElementFactory $factory)

Zend_Pdf_ElementFactory getFactory ()

integer getGenNum ()

Zend_Pdf_Element_Object getObject ()

integer getObjNum ()

integer getType ()

mixed toPhp ()

string toString ([Zend_Pdf_Factory $factory = null])

void touch ()

mixed __call (string $method, array $args)

mixed __get (string $property)

void __set (string $property, mixed $value)

Variables

Zend_Pdf_ElementFactory $_factory (line 63)

Reference to the factory.

access: protected

integer $_genNum (line 56)

Generation number

access: protected

integer $_objNum (line 49)

Object number within PDF file

access: protected

Zend_Pdf_Element $_value (line 42)

Object value

access: protected

Methods

Constructor __construct (line 74)

Object constructor

throws: Zend_Pdf_Exception
access: public

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

Zend_Pdf_Element $val
integer $objNum
integer $genNum
Zend_Pdf_ElementFactory $factory

Redefined in descendants as:

Zend_Pdf_Element_Object_Stream::__construct() : Object constructor

cleanUp (line 236)

Clean up resources, used by object

access: public

void cleanUp ()

Redefinition of:

Zend_Pdf_Element::cleanUp(): Clean up resources, used by object

Redefined in descendants as:

Zend_Pdf_Element_Object_Stream::cleanUp() : Clean up resources, used by object

dump (line 171)

Dump object to a string to save within PDF file.

$factory parameter defines operation context.

access: public

string dump (Zend_Pdf_ElementFactory $factory)

Zend_Pdf_ElementFactory $factory

Redefined in descendants as:

Zend_Pdf_Element_Object_Stream::dump() : Dump object to a string to save within PDF file

getFactory (line 107)

Check, that object is generated by specified factory

access: public

Zend_Pdf_ElementFactory getFactory ()

getGenNum (line 139)

Get generation number

access: public

integer getGenNum ()

getObject (line 228)

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

access: public

Zend_Pdf_Element_Object getObject ()

getObjNum (line 128)

Get object number

access: public

integer getObjNum ()

getType (line 117)

Return type of the element.

access: public

integer getType ()

Redefinition of:

Zend_Pdf_Element::getType(): Return type of the element.

toPhp (line 246)

Convert PDF element to PHP type.

access: public

mixed toPhp ()

Redefinition of:

Zend_Pdf_Element::toPhp(): Convert PDF element to PHP type.

toString (line 151)

Return reference to the object

access: public

string toString ([Zend_Pdf_Factory $factory = null])

Zend_Pdf_Factory $factory

Redefinition of:

Zend_Pdf_Element::toString(): Convert element to a string, which can be directly written to a PDF file.

touch (line 218)

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

access: public

void touch ()

Redefinition of:

Zend_Pdf_Element::touch(): Mark object as modified, to include it into new PDF file segment.

__call (line 209)

Call handler

access: public

mixed __call (string $method, array $args)

string $method
array $args

Redefined in descendants as:

Zend_Pdf_Element_Object_Stream::__call() : Call handler

__get (line 186)

Get handler

access: public

mixed __get (string $property)

string $property

Redefined in descendants as:

Zend_Pdf_Element_Object_Stream::__get() : Get handler

__set (line 197)

Set handler

access: public

void __set (string $property, mixed $value)

string $property
mixed $value

Redefined in descendants as:

Zend_Pdf_Element_Object_Stream::__set() : Set handler

Inherited Methods

Inherited From Zend_Pdf_Element

Zend_Pdf_Element::cleanUp()
Zend_Pdf_Element::getParentObject()
Zend_Pdf_Element::getType()
Zend_Pdf_Element::phpToPdf()
Zend_Pdf_Element::setParentObject()
Zend_Pdf_Element::toPhp()
Zend_Pdf_Element::toString()
Zend_Pdf_Element::touch()

Class Constants

Inherited Constants

Inherited from Zend_Pdf_Element

Zend_Pdf_Element::TYPE_ARRAY
Zend_Pdf_Element::TYPE_BOOL
Zend_Pdf_Element::TYPE_DICTIONARY
Zend_Pdf_Element::TYPE_NAME
Zend_Pdf_Element::TYPE_NULL
Zend_Pdf_Element::TYPE_NUMERIC
Zend_Pdf_Element::TYPE_STREAM
Zend_Pdf_Element::TYPE_STRING