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

Public Member Functions

 __construct ($val)
 Object constructor.
 
 getType ()
 Return type of the element.
 
 length ()
 Stream length.
 
 clear ()
 Clear stream.
 
 append ($val)
 Append value to a stream.
 
 makeClone (Zend_Pdf_ElementFactory $factory, array &$processed, $mode)
 Detach PDF object from the factory (if applicable), clone it and attach to new factory.
 
 toString ($factory=null)
 Return object as string.
 
- 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.
 

Public Attributes

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

Additional Inherited Members

- Static Public Member Functions inherited from Zend_Pdf_Element
static phpToPdf ($input)
 Convert PHP value into PDF element.
 

Constructor & Destructor Documentation

__construct (   $val)

Object constructor.

Parameters
string$val

Member Function Documentation

append (   $val)

Append value to a stream.

Parameters
mixed$val
clear ( )

Clear stream.

getType ( )

Return type of the element.

Returns
integer
length ( )

Stream length.

(Method is used to avoid string copying, which may occurs in some cases)

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
toString (   $factory = null)

Return object as string.

Parameters
Zend_Pdf_Factory$factory
Returns
string

Member Data Documentation

$value