Pdf/Element/Reference.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: Reference.php 20096 2010-01-06 02:05:09Z bkarwin $
- Classes
- Zend_Pdf_Element_Reference
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_Reference
- Extends from
- Zend_Pdf_Element
- 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
- Properties
- $_ref
- $_objNum
- $_genNum
- $_context
- $_factory
- Methods
- __construct
- getFactory
- getType
- toString
- _dereference
- touch
- getObject
- __get
- __set
- __call
- cleanUp
- toPhp
Description
PDF file 'reference' element implementation
Properties
$_context
Zend_Pdf_Element_Reference_Context $_context = ''Reference context
Details
- $_context
-
Zend_Pdf_Element_Reference_Context
- visibility
- private
- default
- final
- false
- static
- false
$_factory
Zend_Pdf_ElementFactory $_factory = ''Reference 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.
Details
- $_factory
-
Zend_Pdf_ElementFactory
- visibility
- private
- default
- final
- false
- static
- false
$_genNum
integer $_genNum = ''Generation number
Details
- $_genNum
- integer
- visibility
- private
- default
- final
- false
- static
- false
$_objNum
integer $_objNum = ''Object number within PDF file
Details
- $_objNum
- integer
- visibility
- private
- default
- final
- false
- static
- false
$_ref
mixed $_ref = ''Object value The reference to the object
Details
- $_ref
- mixed
- visibility
- private
- default
- final
- false
- static
- false
Methods
__call
__call(
string $method, array $args
)
:
mixedCall handler
Arguments
- $method
- string
- $args
- array
Output
- mixed
Details
- visibility
- public
- final
- false
- static
- false
__construct
__construct(
integer $objNum, integer $genNum
=
0, Zend_Pdf_Element_Reference_Context $context, Zend_Pdf_ElementFactory $factory
)
:
Object constructor:
Arguments
- $objNum
- integer
- $genNum
- integer
- $context
- Zend_Pdf_Element_Reference_Context
- $factory
- Zend_Pdf_ElementFactory
Details
- visibility
- public
- final
- false
- static
- false
- throws
__get
__get(
string $property
)
:
mixedGet handler
Arguments
- $property
- string
Output
- mixed
Details
- visibility
- public
- final
- false
- static
- false
__set
__set(
string $property, mixed $value
)
:
Set handler
Arguments
- $property
- string
- $value
- mixed
Details
- visibility
- public
- final
- false
- static
- false
_dereference
_dereference(
)
:
Dereference.
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
Details
- visibility
- private
- final
- false
- static
- false
- throws
cleanUp
cleanUp(
)
:
Clean up resources
Details
- visibility
- public
- final
- false
- static
- false
getFactory
getFactory(
)
:
Zend_Pdf_ElementFactoryCheck, that object is generated by specified factory
Output
Details
- visibility
- public
- final
- false
- static
- false
getObject
getObject(
)
:
Zend_Pdf_Element_ObjectReturn object, which can be used to identify object and its references identity
Output
Details
- visibility
- public
- final
- false
- static
- false
getType
getType(
)
:
integerReturn type of the element.
Output
- integer
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
)
:
stringReturn reference to the object
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.
Details
- visibility
- public
- final
- false
- static
- false