Pdf/Element/Object.php
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.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Pdf
- Version
- $Id: Object.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_Pdf_Element_Object
- Parent(s)
- \Zend_Pdf_Element
- Children
- \Zend_Pdf_Element_Object_Stream
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Constants

TYPE_BOOL
= 1
- Inherited_from
- \Zend_Pdf_Element::TYPE_BOOL

TYPE_NUMERIC
= 2
- Inherited_from
- \Zend_Pdf_Element::TYPE_NUMERIC

TYPE_STRING
= 3
- Inherited_from
- \Zend_Pdf_Element::TYPE_STRING

TYPE_NAME
= 4
- Inherited_from
- \Zend_Pdf_Element::TYPE_NAME

TYPE_ARRAY
= 5
- Inherited_from
- \Zend_Pdf_Element::TYPE_ARRAY

TYPE_DICTIONARY
= 6
- Inherited_from
- \Zend_Pdf_Element::TYPE_DICTIONARY

TYPE_STREAM
= 7
- Inherited_from
- \Zend_Pdf_Element::TYPE_STREAM

TYPE_NULL
= 11
- Inherited_from
- \Zend_Pdf_Element::TYPE_NULL

CLONE_MODE_SKIP_PAGES
= 1
- Inherited_from
- \Zend_Pdf_Element::CLONE_MODE_SKIP_PAGES

CLONE_MODE_FORCE_CLONING
= 2
- Inherited_from
- \Zend_Pdf_Element::CLONE_MODE_FORCE_CLONING
Properties


\Zend_Pdf_Element_Object $_parentObject = null
null
Details- Type
- \Zend_Pdf_Element_Object
- Inherited_from
- \Zend_Pdf_Element::$$_parentObject
Methods


__call(string $method, array $args) : mixed
Call handler
Name | Type | Description |
---|---|---|
$method | string | |
$args | array |
Type | Description |
---|---|
mixed |


__construct(\Zend_Pdf_Element $val, integer $objNum, integer $genNum, \Zend_Pdf_ElementFactory $factory) : void
Object constructor
Name | Type | Description |
---|---|---|
$val | \Zend_Pdf_Element | |
$objNum | integer | |
$genNum | integer | |
$factory | \Zend_Pdf_ElementFactory |
Exception | Description |
---|---|
\Zend_Pdf_Exception |


__get(string $property) : mixed
Get handler
Name | Type | Description |
---|---|---|
$property | string |
Type | Description |
---|---|
mixed |


__set(string $property, mixed $value) : void
Set handler
Name | Type | Description |
---|---|---|
$property | string | |
$value | mixed |


dump(\Zend_Pdf_ElementFactory $factory) : string
Dump object to a string to save within PDF file.
$factory parameter defines operation context.
Name | Type | Description |
---|---|---|
$factory | \Zend_Pdf_ElementFactory |
Type | Description |
---|---|
string |


getFactory() : \Zend_Pdf_ElementFactory
Check, that object is generated by specified factory
Type | Description |
---|---|
\Zend_Pdf_ElementFactory |


getObject() : \Zend_Pdf_Element_Object
Return object, which can be used to identify object and its references identity
Type | Description |
---|---|
\Zend_Pdf_Element_Object |


getType() : integer
Return type of the element.
See ZPdfPDFConst for possible values
Type | Description |
---|---|
integer |


makeClone(\Zend_Pdf_ElementFactory $factory, array $processed, integer $mode) : void
Detach PDF object from the factory (if applicable), clone it and attach to new factory.
Name | Type | Description |
---|---|---|
$factory | \Zend_Pdf_ElementFactory | The factory to attach |
$processed | array | &$processed List of already processed indirect objects, used to avoid objects duplication |
$mode | integer | Cloning mode (defines filter for objects cloning) |
- Returns
- Zend_Pdf_Element


phpToPdf(mixed $input) : \Zend_Pdf_Element
Name | Type | Description |
---|---|---|
$input | mixed |
Type | Description |
---|---|
\Zend_Pdf_Element |


setParentObject(\Zend_Pdf_Element_Object $parent) : void
Name | Type | Description |
---|---|---|
$parent | \Zend_Pdf_Element_Object |


toString(\Zend_Pdf_Factory $factory = null) : string
Return reference to the object
$factory parameter defines operation context.
Name | Type | Description |
---|---|---|
$factory | \Zend_Pdf_Factory |
Type | Description |
---|---|
string |