Docs For Class Zend_Pdf_Element

## Class Zend_Pdf_Element

Description

PDF file element implementation

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

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

Direct descendents

Class | Description
--- | ---
Zend_Pdf_Element_Stream | PDF file 'stream' element implementation
Zend_Pdf_Element_Reference | PDF file 'reference' element implementation
Zend_Pdf_Element_Numeric | PDF file 'numeric' element implementation
Zend_Pdf_Element_Array | PDF file 'array' element implementation
Zend_Pdf_Element_Null | PDF file 'null' element implementation
Zend_Pdf_Element_Name | PDF file 'name' element implementation
Zend_Pdf_Element_Dictionary | PDF file 'dictionary' element implementation
Zend_Pdf_Element_Boolean | PDF file 'boolean' element implementation
Zend_Pdf_Element_Object | PDF file 'indirect object' element implementation
Zend_Pdf_Element_String | PDF file 'string' 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
Zend_Pdf_Element_Object getParentObject ()
integer getType ()
void setParentObject (Zend_Pdf_Element_Object $parent)
string toString ([Zend_Pdf_Factory $factory = null])
void touch ()
Methods
getParentObject (line 92)

Get top level parent indirect object.

- access: public

Zend_Pdf_Element_Object getParentObject ()
getType (line 62)

Return type of the element.

See ZPdfPDFConst for possible values

- access: public
- abstract:

integer getType ()

Redefined in descendants as:

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

setParentObject (line 81)

Set top level parent indirect object.

- access: public

void setParentObject (Zend_Pdf_Element_Object $parent)

- Zend_Pdf_Element_Object $parent

toString (line 73)

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

$factory parameter defines operation context.

- access: public
- abstract:

string toString ([Zend_Pdf_Factory $factory = null])

- Zend_Pdf_Factory $factory

Redefined in descendants as:

- Zend_Pdf_Element_Stream::toString() : Return object as string
- Zend_Pdf_Element_Reference::toString() : Return reference to the object
- Zend_Pdf_Element_Numeric::toString() : Return object as string
- Zend_Pdf_Element_Array::toString() : Return object as string
- Zend_Pdf_Element_Null::toString() : Return object as string
- Zend_Pdf_Element_Name::toString() : Return object as string
- Zend_Pdf_Element_Dictionary::toString() : Return object as string
- Zend_Pdf_Element_Boolean::toString() : Return object as string
- Zend_Pdf_Element_Object::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

touch (line 104)

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 44)
TYPE_BOOL = 1 (line 40)
TYPE_DICTIONARY = 6 (line 45)
TYPE_NAME = 4 (line 43)
TYPE_NULL = 11 (line 47)
TYPE_NUMERIC = 2 (line 41)
TYPE_STREAM = 7 (line 46)
TYPE_STRING = 3 (line 42)

Documentation generated on Sun, 29 Oct 2006 21:27:09 -0600 by phpDocumentor 1.3.0RC6