Zend Framework  1.12
Public Member Functions | List of all members
Zend_Pdf_Element_Dictionary Class Reference

Public Member Functions

 __construct ($val=null)
 Object constructor.
 
Zend_Pdf_Element_Name $name

Add element to an array

Parameters
Zend_Pdf_Element$val- Zend_Pdf_Element object
Exceptions
Zend_Pdf_Exception
 add (Zend_Pdf_Element_Name $name, Zend_Pdf_Element $val)
 
 getKeys ()
 Return dictionary keys.
 
 __get ($item)
 Get handler.
 
 __set ($item, $value)
 Set handler.
 
 getType ()
 Return type of the element.
 
 toString ($factory=null)
 Return object as string.
 
 makeClone (Zend_Pdf_ElementFactory $factory, array &$processed, $mode)
 Detach PDF object from the factory (if applicable), clone it and attach to new factory.
 
 setParentObject (Zend_Pdf_Element_Object $parent)
 Set top level parent indirect object.
 
 toPhp ()
 Convert PDF element to PHP type.
 
- Public Member Functions inherited from Zend_Pdf_Element
 getType ()
 Return type of the element.
 
 toString ($factory=null)
 Convert element to a string, which can be directly written to a PDF file.
 
 makeClone (Zend_Pdf_ElementFactory $factory, array &$processed, $mode)
 Detach PDF object from the factory (if applicable), clone it and attach to new factory.
 
 setParentObject (Zend_Pdf_Element_Object $parent)
 Set top level parent indirect object.
 
 getParentObject ()
 Get top level parent indirect object.
 
 touch ()
 Mark object as modified, to include it into new PDF file segment.
 
 cleanUp ()
 Clean up resources, used by object.
 
 toPhp ()
 Convert PDF element to PHP type.
 

Additional Inherited Members

- Static Public Member Functions inherited from Zend_Pdf_Element
static phpToPdf ($input)
 Convert PHP value into PDF element.
 
- Public Attributes inherited from Zend_Pdf_Element
const TYPE_BOOL = 1
 
const TYPE_NUMERIC = 2
 
const TYPE_STRING = 3
 
const TYPE_NAME = 4
 
const TYPE_ARRAY = 5
 
const TYPE_DICTIONARY = 6
 
const TYPE_STREAM = 7
 
const TYPE_NULL = 11
 
const CLONE_MODE_SKIP_PAGES = 1
 
const CLONE_MODE_FORCE_CLONING = 2
 

Constructor & Destructor Documentation

__construct (   $val = null)

Object constructor.

Parameters
array$val- array of Zend_Pdf_Element objects
Exceptions
Zend_Pdf_Exception

Member Function Documentation

__get (   $item)

Get handler.

Parameters
string$property
Returns
Zend_Pdf_Element | null
__set (   $item,
  $value 
)

Set handler.

Parameters
string$property
mixed$value
add ( Zend_Pdf_Element_Name  $name,
Zend_Pdf_Element  $val 
)
getKeys ( )

Return dictionary keys.

Returns
array
getType ( )

Return type of the element.

Returns
integer
makeClone ( Zend_Pdf_ElementFactory  $factory,
array &  $processed,
  $mode 
)

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

Parameters
Zend_Pdf_ElementFactory$factoryThe factory to attach
array&$processedList of already processed indirect objects, used to avoid objects duplication
integer$modeCloning mode (defines filter for objects cloning)
Returns
Zend_Pdf_Element
Exceptions
Zend_Pdf_Exception
setParentObject ( Zend_Pdf_Element_Object  $parent)

Set top level parent indirect object.

Parameters
Zend_Pdf_Element_Object$parent
toPhp ( )

Convert PDF element to PHP type.

Dictionary is returned as an associative array

Returns
mixed
toString (   $factory = null)

Return object as string.

Parameters
Zend_Pdf_Factory$factory
Returns
string