Pdf/Element.php
- category
- Zend
- copyright
- Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
- license
- http://framework.zend.com/license/new-bsd New BSD License
- package
- Zend_Pdf
- version
- $Id: Element.php 20096 2010-01-06 02:05:09Z bkarwin $
- Classes
- Zend_Pdf_Element
Description
Zend Framework
LICENSE
This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.
Zend_Pdf_Element
- copyright
- Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
- license
- http://framework.zend.com/license/new-bsd New BSD License
- package
- Zend_Pdf
- Constants
- TYPE_BOOL
- TYPE_NUMERIC
- TYPE_STRING
- TYPE_NAME
- TYPE_ARRAY
- TYPE_DICTIONARY
- TYPE_STREAM
- TYPE_NULL
- Properties
- $_parentObject
- Methods
- getType
- toString
- setParentObject
- getParentObject
- touch
- cleanUp
- toPhp
- phpToPdf
Description
PDF file element implementation
Constants
TYPE_BOOL
TYPE_BOOL = '1'
Details
- value
- 1
TYPE_NUMERIC
TYPE_NUMERIC = '2'
Details
- value
- 2
TYPE_STRING
TYPE_STRING = '3'
Details
- value
- 3
TYPE_NAME
TYPE_NAME = '4'
Details
- value
- 4
TYPE_ARRAY
TYPE_ARRAY = '5'
Details
- value
- 5
TYPE_DICTIONARY
TYPE_DICTIONARY = '6'
Details
- value
- 6
TYPE_STREAM
TYPE_STREAM = '7'
Details
- value
- 7
TYPE_NULL
TYPE_NULL = '11'
Details
- value
- 11
Properties
$_parentObject
Zend_Pdf_Element_Object $_parentObject = 'null'Reference to the top level indirect object, which contains this element.
Details
- $_parentObject
-
Zend_Pdf_Element_Object
- visibility
- private
- default
- null
- final
- false
- static
- false
Methods
cleanUp
cleanUp(
)
:
Clean up resources, used by object
Details
- visibility
- public
- final
- false
- static
- false
getParentObject
getParentObject(
)
:
Zend_Pdf_Element_ObjectGet top level parent indirect object.
Output
Details
- visibility
- public
- final
- false
- static
- false
getType
getType(
)
:
integerReturn type of the element.
See ZPdfPDFConst for possible values
Output
- integer
Details
- visibility
- public
- final
- false
- static
- false
phpToPdf
phpToPdf(
mixed $input
)
:
Zend_Pdf_ElementConvert PHP value into PDF element.
Arguments
- $input
- mixed
Output
Details
- visibility
- public
- final
- false
- static
- true
setParentObject
setParentObject(
Zend_Pdf_Element_Object $parent
)
:
Set top level parent indirect object.
Arguments
- $parent
- Zend_Pdf_Element_Object
Details
- visibility
- public
- final
- false
- static
- false
toPhp
toPhp(
)
:
mixedConvert PDF element to PHP type.
Output
- mixed
Details
- visibility
- public
- final
- false
- static
- false
toString
toString(
Zend_Pdf_Factory $factory
=
null
)
:
stringConvert element to a string, which can be directly written to a PDF file.
$factory parameter defines operation context.
Arguments
- $factory
- Zend_Pdf_Factory
Output
- string
Details
- visibility
- public
- final
- false
- static
- false
touch
touch(
)
:
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.
Details
- visibility
- public
- final
- false
- static
- false