Docs For Class Zend_Pdf_Element

Description

PDF file 'reference' element implementation

license: Zend Framework License version 1.0
copyright: Copyright (c) 2005-2006 Zend Technologies USA Inc. (http://www.zend.com)

Located in /Zend/Pdf/Element/Reference.php (line 38)

Zend_Pdf_Element
   |
   --Zend_Pdf_Element_Reference

Variable Summary

Zend_Pdf_Reference_Context $_context

Zend_Pdf_ElementFactory $_factory

integer $_genNum

integer $_objNum

mixed $_ref

Method Summary

Zend_Pdf_Element_Reference __construct (integer $objNum, integer $genNum, Zend_Pdf_Element_Reference_Context $context, Zend_Pdf_ElementFactory $factory)

Zend_Pdf_ElementFactory getFactory ()

integer getType ()

string toString ([Zend_Pdf_Factory $factory = null])

void touch ()

void _dereference ()

mixed __call (string $method, array $args)

mixed __get (string $property)

void __set (string $property, mixed $value)

Variables

Zend_Pdf_Reference_Context $_context (line 67)

Reference context

access: private

Zend_Pdf_ElementFactory $_factory (line 80)

Reference to the factory.

It's the same as referenced object factory, but we save it here to avoid unnecessary dereferencing, whech can produce cascade dereferencing and parsing. The same for duplication of getFactory() function. It can be processed by __call() method, but we catch it here.

access: private

integer $_genNum (line 60)

Generation number

access: private

integer $_objNum (line 53)

Object number within PDF file

access: private

mixed $_ref (line 46)

Object value The reference to the object

access: private

Inherited Variables

Inherited from Zend_Pdf_Element

Zend_Pdf_Element::$_parentObject

Methods

Constructor __construct (line 91)

Object constructor:

access: public
throws: Zend_Pdf_Exception

Zend_Pdf_Element_Reference __construct (integer $objNum, integer $genNum, Zend_Pdf_Element_Reference_Context $context, Zend_Pdf_ElementFactory $factory)

integer $objNum
integer $genNum
Zend_Pdf_Element_Reference_Context $context
Zend_Pdf_ElementFactory $factory

getFactory (line 112)

Check, that object is generated by specified factory

access: public

Zend_Pdf_ElementFactory getFactory ()

getType (line 123)

Return type of the element.

access: public

integer getType ()

Redefinition of:

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

toString (line 139)

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

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.

_dereference (line 160)

Dereference.

Take inderect object, take $value member of this object (must be Zend_Pdf_Element), take reference to the $value member of this object and assign it to $value member of current PDF Reference object $obj can be null

access: private
throws: Zend_Pdf_Exception

void _dereference ()

__call (line 230)

Call handler

access: public

mixed __call (string $method, array $args)

string $method
array $args

__get (line 199)

Get handler

access: public

mixed __get (string $property)

string $property

__set (line 214)

Set handler

access: public

void __set (string $property, mixed $value)

string $property
mixed $value

Inherited Methods

Inherited From Zend_Pdf_Element

Zend_Pdf_Element::getParentObject()
Zend_Pdf_Element::getType()
Zend_Pdf_Element::setParentObject()
Zend_Pdf_Element::toString()
Zend_Pdf_Element::touch()

Class Constants

Inherited Constants

Inherited from Zend_Pdf_Element