Pdf/Element/Reference.php

Show: PublicProtectedPrivateinherited
Table of Contents
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-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Pdf  
Version
$Id: Reference.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_Pdf_Element_Reference

Package: Zend\Pdf
PDF file 'reference' element implementation
Parent(s)
\Zend_Pdf_Element
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Constants

>VConstant  TYPE_BOOL = 1
inheritedInherited from: \Zend_Pdf_Element::TYPE_BOOL
>VConstant  TYPE_NUMERIC = 2
inheritedInherited from: \Zend_Pdf_Element::TYPE_NUMERIC
>VConstant  TYPE_STRING = 3
inheritedInherited from: \Zend_Pdf_Element::TYPE_STRING
>VConstant  TYPE_NAME = 4
inheritedInherited from: \Zend_Pdf_Element::TYPE_NAME
>VConstant  TYPE_ARRAY = 5
inheritedInherited from: \Zend_Pdf_Element::TYPE_ARRAY
>VConstant  TYPE_DICTIONARY = 6
inheritedInherited from: \Zend_Pdf_Element::TYPE_DICTIONARY
>VConstant  TYPE_STREAM = 7
inheritedInherited from: \Zend_Pdf_Element::TYPE_STREAM
>VConstant  TYPE_NULL = 11
inheritedInherited from: \Zend_Pdf_Element::TYPE_NULL
>VConstant  CLONE_MODE_SKIP_PAGES = 1
>VConstant  CLONE_MODE_FORCE_CLONING = 2

Properties

>VPropertyprivate\Zend_Pdf_Element_Reference_Context $_context
Reference context
>VPropertyprivate\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
Type
\Zend_Pdf_ElementFactory
>VPropertyprivateinteger $_genNum
Generation number
Details
Type
integer
>VPropertyprivateinteger $_objNum
Object number within PDF file
Details
Type
integer
>VPropertyprivate\Zend_Pdf_Element_Object $_parentObject = null
inherited
Reference to the top level indirect object, which contains this element.
Inherited from: \Zend_Pdf_Element::$$_parentObject
Default valuenullDetails
Type
\Zend_Pdf_Element_Object
Inherited_from
\Zend_Pdf_Element::$$_parentObject  
>VPropertyprivatemixed $_ref
Object value The reference to the object
Details
Type
mixed

Methods

methodpublic__call(string $method, array $args) : mixed

Call handler

Parameters
NameTypeDescription
$methodstring
$argsarray
Returns
TypeDescription
mixed
methodpublic__construct(integer $objNum, integer $genNum = 0, \Zend_Pdf_Element_Reference_Context $context, \Zend_Pdf_ElementFactory $factory) : void

Object constructor:

Parameters
NameTypeDescription
$objNuminteger
$genNuminteger
$context\Zend_Pdf_Element_Reference_Context
$factory\Zend_Pdf_ElementFactory
Throws
ExceptionDescription
\Zend_Pdf_Exception
methodpublic__get(string $property) : mixed

Get handler

Parameters
NameTypeDescription
$propertystring
Returns
TypeDescription
mixed
methodpublic__set(string $property, mixed $value) : void

Set handler

Parameters
NameTypeDescription
$propertystring
$valuemixed
methodprivate_dereference() : void

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

Throws
ExceptionDescription
\Zend_Pdf_Exception
methodpubliccleanUp() : void

Clean up resources

methodpublicgetFactory() : \Zend_Pdf_ElementFactory

Check, that object is generated by specified factory

Returns
TypeDescription
\Zend_Pdf_ElementFactory
methodpublicgetObject() : \Zend_Pdf_Element_Object

Return object, which can be used to identify object and its references identity

Returns
TypeDescription
\Zend_Pdf_Element_Object
methodpublicgetParentObject() : \Zend_Pdf_Element_Object
inherited

Get top level parent indirect object.

Inherited from: \Zend_Pdf_Element::getParentObject()
Returns
TypeDescription
\Zend_Pdf_Element_Object
methodpublicgetType() : integer

Return type of the element.

See ZPdfPDFConst for possible values

Returns
TypeDescription
integer
methodpublicmakeClone(\Zend_Pdf_ElementFactory $factory, array $processed, integer $mode) : void

Detach PDF object from the factory (if applicable), clone it and attach to new factory.

Parameters
NameTypeDescription
$factory\Zend_Pdf_ElementFactory

The factory to attach

$processedarray

&$processed List of already processed indirect objects, used to avoid objects duplication

$modeinteger

Cloning mode (defines filter for objects cloning)

Details
Returns
Zend_Pdf_Element  
methodpublicphpToPdf(mixed $input) : \Zend_Pdf_Element
staticinherited

Convert PHP value into PDF element.

Inherited from: \Zend_Pdf_Element::phpToPdf()
Parameters
NameTypeDescription
$inputmixed
Returns
TypeDescription
\Zend_Pdf_Element
methodpublicsetParentObject(\Zend_Pdf_Element_Object $parent) : void
inherited

Set top level parent indirect object.

Inherited from: \Zend_Pdf_Element::setParentObject()
Parameters
NameTypeDescription
$parent\Zend_Pdf_Element_Object
methodpublictoPhp() : mixed

Convert PDF element to PHP type.

Returns
TypeDescription
mixed
methodpublictoString(\Zend_Pdf_Factory $factory = null) : string

Return reference to the object

$factory parameter defines operation context.

Parameters
NameTypeDescription
$factory\Zend_Pdf_Factory
Returns
TypeDescription
string
methodpublictouch() : void

Mark object as modified, to include it into new PDF file segment.

We don't automate this action to keep control on PDF update process. All new objects are treated as "modified" automatically.

Documentation was generated by phpDocumentor 2.0.0a12.