Pdf/Element/Reference.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 license@zend.com 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_Reference
Package: Zend_Pdf
PDF file 'reference' element implementation
- Parent(s)
- \Zend_Pdf_Element
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
\Zend_Pdf_Element_Reference_Context $_contextReference context
Details
\Zend_Pdf_ElementFactory $_factoryReference to the factory.
It's the same as referenced object factory, but we save it here to avoid
unnecessary dereferencing, whech can produce cascade dereferencing and parsing.
The same for duplication of getFactory() function. It can be processed by __call()
method, but we catch it here.
Detailsinteger $_genNumGeneration number
Details
- Type
- integer
integer $_objNumObject number within PDF file
Details
- Type
- integer
mixed $_refObject value
The reference to the object
Details
- Type
- mixed
Methods
__call(string $method, array $args) : mixedCall handler
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $method | string | |
| $args | array |
| Type | Description |
|---|---|
| mixed |
__construct(integer $objNum, integer $genNum = 0, \Zend_Pdf_Element_Reference_Context $context, \Zend_Pdf_ElementFactory $factory) : voidObject constructor:
Parameters
Throws
| Name | Type | Description |
|---|---|---|
| $objNum | integer | |
| $genNum | integer | |
| $context | \Zend_Pdf_Element_Reference_Context | |
| $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 |
_dereference() : voidDereference.
Take inderect object, take $value member of this object (must be Zend_Pdf_Element),
take reference to the $value member of this object and assign it to
$value member of current PDF Reference object
$obj can be null
Throws| Exception | Description |
|---|---|
| \Zend_Pdf_Exception |
cleanUp() : voidClean up resources
getFactory() : \Zend_Pdf_ElementFactoryCheck, that object is generated by specified factory
Returns
| Type | Description |
|---|---|
| \Zend_Pdf_ElementFactory |
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.