Pdf/Element/Object.php
Show:
inherited
inherited
Classes
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 [email protected] so we can send you a copy immediately.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Pdf
- Version
- $Id$
\Zend_Pdf_Element_Object
Package: Zend_Pdf
Returns
PDF file 'indirect object' element implementation
- Parent(s)
- \Zend_Pdf_Element
- Children
- \Zend_Pdf_Element_Object_Stream
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
integer $_genNumGeneration number
Details
- Type
- integer
integer $_objNumObject number within PDF file
Details
- Type
- integer
Methods
__call(string $method, array $args) : mixedCall handler
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $method | string | |
| $args | array |
| Type | Description |
|---|---|
| mixed |
__construct(\Zend_Pdf_Element $val, integer $objNum, integer $genNum, \Zend_Pdf_ElementFactory $factory) : voidObject constructor
Parameters
Throws
| Name | Type | Description |
|---|---|---|
| $val | \Zend_Pdf_Element | |
| $objNum | integer | |
| $genNum | integer | |
| $factory | \Zend_Pdf_ElementFactory |
| Exception | Description |
|---|---|
| \Zend_Pdf_Exception |
__get(string $property) : mixedGet handler
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $property | string |
| Type | Description |
|---|---|
| mixed |
__set(string $property, mixed $value) : voidSet handler
Parameters
| Name | Type | Description |
|---|---|---|
| $property | string | |
| $value | mixed |
cleanUp() : voidClean up resources, used by object
dump(\Zend_Pdf_ElementFactory $factory) : stringDump object to a string to save within PDF file.
$factory parameter defines operation context.
Parameters| Name | Type | Description |
|---|---|---|
| $factory | \Zend_Pdf_ElementFactory |
| Type | Description |
|---|---|
| string |
getFactory() : \Zend_Pdf_ElementFactoryCheck, that object is generated by specified factory
Returns
| Type | Description |
|---|---|
| \Zend_Pdf_ElementFactory |
getGenNum() : integerGet generation number
Returns
| Type | Description |
|---|---|
| integer |
getObjNum() : integerGet object number
Returns
| Type | Description |
|---|---|
| integer |
getObject() : \Zend_Pdf_Element_ObjectReturn object, which can be used to identify object and its references identity
Returns
| Type | Description |
|---|---|
| \Zend_Pdf_Element_Object |
getType() : integerReturn type of the element.
Returns
| Type | Description |
|---|---|
| integer |
makeClone(\Zend_Pdf_ElementFactory $factory, $processed, integer $mode) : voidDetach PDF object from the factory (if applicable), clone it and attach to new factory.
Parameters
Details
| Name | Type | Description |
|---|---|---|
| $factory | \Zend_Pdf_ElementFactory | The factory to attach |
| $processed | ||
| $mode | integer | Cloning mode (defines filter for objects cloning) |
- Returns
- Zend_Pdf_Element
toPhp() : mixedConvert PDF element to PHP type.
Returns
| Type | Description |
|---|---|
| mixed |
toString(\Zend_Pdf_Factory $factory = null) : stringReturn reference to the object
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $factory | \Zend_Pdf_Factory |
| Type | Description |
|---|---|
| string |
touch() : voidMark object as modified, to include it into new PDF file segment