category |
Zend |
package |
Zend_Pdf |
copyright |
Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com) |
license |
New BSD License |
inherited_from |
\Zend_Pdf_Element_Object |
Methods
Call handler
__call(string $method, array $args) : mixed
inherited_from |
\Zend_Pdf_Element_Object::__call() |
Parameters
$method
string
$args
array
Returns
mixed
Call handler
__call(string $method, array $args) : mixed
Inherited
Parameters
$method
string
$args
array
Returns
mixed
Object constructor
__construct(mixed $val, integer $objNum, integer $genNum, \Zend_Pdf_ElementFactory $factory, \Zend_Pdf_Element_Dictionary|null $dictionary = null
)
inherited_from |
\Zend_Pdf_Element_Object::__construct() |
Parameters
$val
mixed
$objNum
integer
$genNum
integer
$factory
\Zend_Pdf_ElementFactory
$dictionary
\Zend_Pdf_Element_Dictionary
null
Exceptions
Object constructor
__construct(\Zend_Pdf_Element $val, integer $objNum, integer $genNum, \Zend_Pdf_ElementFactory $factory)
Inherited
Parameters
$val
\Zend_Pdf_Element
$objNum
integer
$genNum
integer
$factory
\Zend_Pdf_ElementFactory
Exceptions
Get handler
__get(string $property) : mixed
inherited_from |
\Zend_Pdf_Element_Object::__get() |
Parameters
$property
string
Exceptions
Returns
mixed
Get handler
__get(string $property) : mixed
Inherited
Parameters
$property
string
Returns
mixed
Set handler
__set(string $property, mixed $value)
inherited_from |
\Zend_Pdf_Element_Object::__set() |
Parameters
$property
string
$value
mixed
Set handler
__set(string $property, mixed $value)
Inherited
Parameters
$property
string
$value
mixed
Clean up resources, used by object
cleanUp()
inherited_from |
\Zend_Pdf_Element_Object::cleanUp() |
Clean up resources, used by object
cleanUp()
Inherited
Dump object to a string to save within PDF file
dump(\Zend_Pdf_ElementFactory $factory) : string
$factory parameter defines operation context.
inherited_from |
\Zend_Pdf_Element_Object::dump() |
Parameters
$factory
\Zend_Pdf_ElementFactory
Returns
string
Dump object to a string to save within PDF file.
dump(\Zend_Pdf_ElementFactory $factory) : string
Inherited
$factory parameter defines operation context.
Parameters
$factory
\Zend_Pdf_ElementFactory
Returns
string
Check, that object is generated by specified factory
getFactory() : \Zend_Pdf_ElementFactory
Inherited
Returns
\Zend_Pdf_ElementFactory
Get generation number
getGenNum() : integer
Inherited
Get object number
getObjNum() : integer
Inherited
Return object, which can be used to identify object and its references identity
getObject() : \Zend_Pdf_Element_Object
Inherited
Returns
\Zend_Pdf_Element_Object
Get top level parent indirect object.
getParentObject() : \Zend_Pdf_Element_Object
Inherited
Returns
\Zend_Pdf_Element_Object
Return type of the element.
getType() : integer
Inherited
See ZPdfPDFConst for possible values
Returns
integer
Detach PDF object from the factory (if applicable), clone it and attach to new factory.
makeClone(\Zend_Pdf_ElementFactory $factory, array $processed, integer $mode)
returns |
Zend_Pdf_Element |
inherited_from |
\Zend_Pdf_Element_Object::makeClone() |
Parameters
$factory
\Zend_Pdf_ElementFactory
The factory to attach
$processed
$mode
integer
Cloning mode (defines filter for objects cloning)
Detach PDF object from the factory (if applicable), clone it and attach to new factory.
makeClone(\Zend_Pdf_ElementFactory $factory, array $processed, integer $mode)
Inherited
todo |
It's nevessry to check if SplObjectStorage class works faster
(Needs PHP 5.3.x to attach object _with_ additional data to storage) |
returns |
Zend_Pdf_Element |
Parameters
$factory
\Zend_Pdf_ElementFactory
The factory to attach
$processed
$mode
integer
Cloning mode (defines filter for objects cloning)
Convert PHP value into PDF element.
phpToPdf(mixed $input) : \Zend_Pdf_Element
InheritedStatic
Parameters
$input
mixed
Returns
\Zend_Pdf_Element
Set top level parent indirect object.
setParentObject(\Zend_Pdf_Element_Object $parent)
Inherited
Parameters
$parent
\Zend_Pdf_Element_Object
Treat stream data as already encoded
skipFilters()
Convert PDF element to PHP type.
toPhp() : mixed
Inherited
Convert element to a string, which can be directly
written to a PDF file.
toString(\Zend_Pdf_Factory $factory = null
) : string
Inherited
$factory parameter defines operation context.
Parameters
$factory
\Zend_Pdf_Factory
Returns
string
Mark object as modified, to include it into new PDF file segment.
touch()
Inherited
We don't automate this action to keep control on PDF update process.
All new objects are treated as "modified" automatically.
Decode stream
_decodeStream()
Encode stream
_encodeStream()
Properties
Reference to the factory.
$_factory : \Zend_Pdf_ElementFactory
Generation number
$_genNum : integer
Object number within PDF file
$_objNum : integer
Object value
$_value : \Zend_Pdf_Element
StreamObject dictionary
Required enries:
Length
$_dictionary : \Zend_Pdf_Element_Dictionary
Stored original stream object dictionary.
$_initialDictionaryData : array | null
Used to decode stream at access time.
The only properties affecting decoding are sored here.
Reference to the top level indirect object, which contains this element.
$_parentObject : \Zend_Pdf_Element_Object
Flag which signals, that stream is decoded
$_streamDecoded : boolean
Constants
CLONE_MODE_FORCE_CLONING
CLONE_MODE_FORCE_CLONING = 2
CLONE_MODE_SKIP_PAGES
CLONE_MODE_SKIP_PAGES = 1
TYPE_ARRAY
TYPE_ARRAY = 5
TYPE_DICTIONARY
TYPE_DICTIONARY = 6
TYPE_NUMERIC
TYPE_NUMERIC = 2
TYPE_STREAM
TYPE_STREAM = 7
TYPE_STRING
TYPE_STRING = 3