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

Public Member Functions

 __construct ($val, $objNum, $genNum, Zend_Pdf_ElementFactory $factory, $dictionary=null)
 Object constructor.
 
 __get ($property)
 Get handler.
 
 __set ($property, $value)
 Set handler.
 
 skipFilters ()
 Treat stream data as already encoded.
 
 __call ($method, $args)
 Call handler.
 
 makeClone (Zend_Pdf_ElementFactory $factory, array &$processed, $mode)
 Detach PDF object from the factory (if applicable), clone it and attach to new factory.
 
 dump (Zend_Pdf_ElementFactory $factory)
 Dump object to a string to save within PDF file.
 
 cleanUp ()
 Clean up resources, used by object.
 
- Public Member Functions inherited from Zend_Pdf_Element_Object
 __construct (Zend_Pdf_Element $val, $objNum, $genNum, Zend_Pdf_ElementFactory $factory)
 Object constructor.
 
 getFactory ()
 Check, that object is generated by specified factory.
 
 getType ()
 Return type of the element.
 
 getObjNum ()
 Get object number.
 
 getGenNum ()
 Get generation number.
 
 toString ($factory=null)
 Return reference to the object.
 
 dump (Zend_Pdf_ElementFactory $factory)
 Dump object to a string to save within PDF file.
 
 __get ($property)
 Get handler.
 
 __set ($property, $value)
 Set handler.
 
 __call ($method, $args)
 Call handler.
 
 makeClone (Zend_Pdf_ElementFactory $factory, array &$processed, $mode)
 Detach PDF object from the factory (if applicable), clone it and attach to new factory.
 
 touch ()
 Mark object as modified, to include it into new PDF file segment.
 
 getObject ()
 Return object, which can be used to identify object and its references identity.
 
 cleanUp ()
 Clean up resources, used by 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
 
- Protected Attributes inherited from Zend_Pdf_Element_Object
 $_value
 
 $_objNum
 
 $_genNum
 
 $_factory
 

Constructor & Destructor Documentation

__construct (   $val,
  $objNum,
  $genNum,
Zend_Pdf_ElementFactory  $factory,
  $dictionary = null 
)

Object constructor.

Parameters
mixed$val
integer$objNum
integer$genNum
Zend_Pdf_ElementFactory$factory
Zend_Pdf_Element_Dictionary | null$dictionary
Exceptions
Zend_Pdf_Exception

Member Function Documentation

__call (   $method,
  $args 
)

Call handler.

Parameters
string$method
array$args
Returns
mixed
__get (   $property)

Get handler.

Parameters
string$property
Returns
mixed
Exceptions
Zend_Pdf_Exception

If stream is not decoded yet, then store original decoding options (do it only once).

__set (   $property,
  $value 
)

Set handler.

Parameters
string$property
mixed$value
cleanUp ( )

Clean up resources, used by object.

dump ( Zend_Pdf_ElementFactory  $factory)

Dump object to a string to save within PDF file.

$factory parameter defines operation context.

Parameters
Zend_Pdf_ElementFactory$factory
Returns
string
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
skipFilters ( )

Treat stream data as already encoded.