API Documentation

Zend/Pdf/Element/Reference.php

Show: inherited
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 24594 2012-01-05 21:27:01Z 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  

Properties

Propertyprivate\Zend_Pdf_Element_Reference_Context  $_context= ''

Reference context

Propertyprivate\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
Propertyprivateinteger  $_genNum= ''

Generation number

Details
Type
integer
Propertyprivateinteger  $_objNum= ''

Object number within PDF file

Details
Type
integer
Propertyprivatemixed  $_ref= ''

Object value The reference to the object

Details
Type
mixed

Methods

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

Call handler

Parameters
Name Type Description
$method string
$args array
Returns
Type Description
mixed
methodpublic__construct( integer $objNum, integer $genNum = 0, \Zend_Pdf_Element_Reference_Context $context, \Zend_Pdf_ElementFactory $factory ) : void

Object constructor:

Parameters
Name Type Description
$objNum integer
$genNum integer
$context \Zend_Pdf_Element_Reference_Context
$factory \Zend_Pdf_ElementFactory
Throws
Exception Description
\Zend_Pdf_Exception
methodpublic__get( string $property ) : mixed

Get handler

Parameters
Name Type Description
$property string
Returns
Type Description
mixed
methodpublic__set( string $property, mixed $value ) : void

Set handler

Parameters
Name Type Description
$property string
$value mixed
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
Exception Description
\Zend_Pdf_Exception
methodpubliccleanUp( ) : void

Clean up resources

methodpublicgetFactory( ) : \Zend_Pdf_ElementFactory

Check, that object is generated by specified factory

Returns
Type Description
\Zend_Pdf_ElementFactory
methodpublicgetObject( ) : \Zend_Pdf_Element_Object

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

Returns
Type Description
\Zend_Pdf_Element_Object
methodpublicgetType( ) : integer

Return type of the element.

Returns
Type Description
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
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)

Details
Returns
Zend_Pdf_Element  
methodpublictoPhp( ) : mixed

Convert PDF element to PHP type.

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

Return reference to the object

Parameters
Name Type Description
$factory \Zend_Pdf_Factory
Returns
Type Description
string
methodpublictouch( ) : void

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

Documentation was generated by DocBlox 0.15.1.