API Documentation

Zend/Pdf/Element/Reference/Table.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: Table.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Pdf_Element_Reference_Table

Package: Zend\Pdf

PDF file reference table

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprivatearray  $_free= ''

Free entries 'reference' => next free object number

Details
Type
array
Propertyprivatearray  $_generations= ''

Generation numbers for free objects.

Array: objNum => nextGeneration

Details
Type
array
Propertyprivatearray  $_inuse= ''

In use entries 'reference' => offset

Details
Type
array
Propertyprivate\Zend_Pdf_Element_Reference_Table  $_parent= ''

Parent reference table

Propertyprivatearray  $_usedObjects= ''

Generation numbers for free objects.

Array: objNum => objGeneration

Details
Type
array

Methods

methodpublic__construct( ) : void

Object constructor

methodpublicaddReference( string $ref, integer $offset, boolean $inuse = true ) : void

Add reference to the reference table

Parameters
Name Type Description
$ref string
$offset integer
$inuse boolean
methodpublicgetNewGeneration( integer $objNum ) : \unknown

Get next generation number for free object

Parameters
Name Type Description
$objNum integer
Returns
Type Description
\unknown
methodpublicgetNextFree( string $ref ) : integer

Get next object from a list of free objects.

Parameters
Name Type Description
$ref string
Returns
Type Description
integer
Throws
Exception Description
\Zend_Pdf_Exception
methodpublicgetOffset( string $ref ) : integer

Get object offset

Parameters
Name Type Description
$ref string
Returns
Type Description
integer
methodpublicsetParent( \Zend_Pdf_Element_Reference_Table $parent ) : void

Set parent reference table

Parameters
Name Type Description
$parent \Zend_Pdf_Element_Reference_Table
Documentation was generated by DocBlox 0.15.1.