Docs For Class Zend_Pdf

Description

PDF file element implementation

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

Direct descendents

Class	Description
Zend_Pdf_Element_Name	PDF file 'name' element implementation
Zend_Pdf_Element_Array	PDF file 'array' element implementation
Zend_Pdf_Element_Numeric	PDF file 'numeric' element implementation
Zend_Pdf_Element_Boolean	PDF file 'boolean' element implementation
Zend_Pdf_Element_Null	PDF file 'null' element implementation
Zend_Pdf_Element_Reference	PDF file 'reference' element implementation
Zend_Pdf_Element_String	PDF file 'string' element implementation
Zend_Pdf_Element_Stream	PDF file 'stream' element implementation
Zend_Pdf_Element_Dictionary	PDF file 'dictionary' element implementation
Zend_Pdf_Element_Object	PDF file 'indirect object' element implementation

Class Constant Summary

TYPE_ARRAY = 5

TYPE_BOOL = 1

TYPE_DICTIONARY = 6

TYPE_NAME = 4

TYPE_NULL = 11

TYPE_NUMERIC = 2

TYPE_STREAM = 7

TYPE_STRING = 3

Method Summary

static Zend_Pdf_Element phpToPdf (mixed $input)

void cleanUp ()

Zend_Pdf_Element_Object getParentObject ()

integer getType ()

void setParentObject (Zend_Pdf_Element_Object $parent)

mixed toPhp ()

string toString ([Zend_Pdf_Factory $factory = null])

void touch ()

Methods

static phpToPdf (line 127)

Convert PHP value into PDF element.

access: public

static Zend_Pdf_Element phpToPdf (mixed $input)

mixed $input

cleanUp (line 106)

Clean up resources, used by object

access: public

void cleanUp ()

Redefined in descendants as:

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

getParentObject (line 84)

Get top level parent indirect object.

access: public

Zend_Pdf_Element_Object getParentObject ()

getType (line 54)

Return type of the element.

See ZPdfPDFConst for possible values

abstract:
access: public

integer getType ()

Redefined in descendants as:

Zend_Pdf_Element_Name::getType() : Return type of the element.
Zend_Pdf_Element_Array::getType() : Return type of the element.
Zend_Pdf_Element_Numeric::getType() : Return type of the element.
Zend_Pdf_Element_Boolean::getType() : Return type of the element.
Zend_Pdf_Element_Null::getType() : Return type of the element.
Zend_Pdf_Element_Reference::getType() : Return type of the element.
Zend_Pdf_Element_String::getType() : Return type of the element.
Zend_Pdf_Element_Stream::getType() : Return type of the element.
Zend_Pdf_Element_Dictionary::getType() : Return type of the element.
Zend_Pdf_Element_Object::getType() : Return type of the element.

setParentObject (line 73)

Set top level parent indirect object.

access: public

void setParentObject (Zend_Pdf_Element_Object $parent)

Zend_Pdf_Element_Object $parent

toPhp (line 116)

Convert PDF element to PHP type.

access: public

mixed toPhp ()

Redefined in descendants as:

Zend_Pdf_Element_Array::toPhp() : Convert PDF element to PHP type.
Zend_Pdf_Element_Reference::toPhp() : Convert PDF element to PHP type.
Zend_Pdf_Element_Dictionary::toPhp() : Convert PDF element to PHP type.
Zend_Pdf_Element_Object::toPhp() : Convert PDF element to PHP type.

toString (line 65)

Convert element to a string, which can be directly written to a PDF file.

$factory parameter defines operation context.

abstract:
access: public

string toString ([Zend_Pdf_Factory $factory = null])

Zend_Pdf_Factory $factory

Redefined in descendants as:

Zend_Pdf_Element_Name::toString() : Return object as string
Zend_Pdf_Element_Array::toString() : Return object as string
Zend_Pdf_Element_Numeric::toString() : Return object as string
Zend_Pdf_Element_Boolean::toString() : Return object as string
Zend_Pdf_Element_Null::toString() : Return object as string
Zend_Pdf_Element_Reference::toString() : Return reference to the object
Zend_Pdf_Element_String::toString() : Return object as string
Zend_Pdf_Element_String_Binary::toString() : Return object as string
Zend_Pdf_Element_Stream::toString() : Return object as string
Zend_Pdf_Element_Dictionary::toString() : Return object as string
Zend_Pdf_Element_Object::toString() : Return reference to the object

touch (line 96)

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

We don't automate this action to keep control on PDF update process. All new objects are treated as "modified" automatically.

access: public

void touch ()

Redefined in descendants as:

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

Class Constants

TYPE_ARRAY = 5 (line 36)

TYPE_BOOL = 1 (line 32)

TYPE_DICTIONARY = 6 (line 37)

TYPE_NAME = 4 (line 35)

TYPE_NULL = 11 (line 39)

TYPE_NUMERIC = 2 (line 33)

TYPE_STREAM = 7 (line 38)

TYPE_STRING = 3 (line 34)