Pdf/Element/Object.php

Show:

inherited

Classes
- \Zend_Pdf_Element_Object

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: Object.php 24593 2012-01-05 20:35:02Z matthew $

\Zend_Pdf_Element_Object
jump to top

Package: Zend\Pdf

PDF file 'indirect object' element implementation

Parent(s): \Zend_Pdf_Element
Children: \Zend_Pdf_Element_Object_Stream
Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Constants

 
                TYPE_BOOL
                = 1

inheritedInherited from: \Zend_Pdf_Element::TYPE_BOOL

Inherited_from: \Zend_Pdf_Element::TYPE_BOOL

 
                TYPE_NUMERIC
                = 2

inheritedInherited from: \Zend_Pdf_Element::TYPE_NUMERIC

Inherited_from: \Zend_Pdf_Element::TYPE_NUMERIC

 
                TYPE_STRING
                = 3

inheritedInherited from: \Zend_Pdf_Element::TYPE_STRING

Inherited_from: \Zend_Pdf_Element::TYPE_STRING

 
                TYPE_NAME
                = 4

inheritedInherited from: \Zend_Pdf_Element::TYPE_NAME

Inherited_from: \Zend_Pdf_Element::TYPE_NAME

 
                TYPE_ARRAY
                = 5

inheritedInherited from: \Zend_Pdf_Element::TYPE_ARRAY

Inherited_from: \Zend_Pdf_Element::TYPE_ARRAY

 
                TYPE_DICTIONARY
                = 6

inheritedInherited from: \Zend_Pdf_Element::TYPE_DICTIONARY

Inherited_from: \Zend_Pdf_Element::TYPE_DICTIONARY

 
                TYPE_STREAM
                = 7

inheritedInherited from: \Zend_Pdf_Element::TYPE_STREAM

Inherited_from: \Zend_Pdf_Element::TYPE_STREAM

 
                TYPE_NULL
                = 11

inheritedInherited from: \Zend_Pdf_Element::TYPE_NULL

Inherited_from: \Zend_Pdf_Element::TYPE_NULL

 
                CLONE_MODE_SKIP_PAGES
                = 1

inheritedInherited from: \Zend_Pdf_Element::CLONE_MODE_SKIP_PAGES

Inherited_from: \Zend_Pdf_Element::CLONE_MODE_SKIP_PAGES

 
                CLONE_MODE_FORCE_CLONING
                = 2

inheritedInherited from: \Zend_Pdf_Element::CLONE_MODE_FORCE_CLONING

Inherited_from: \Zend_Pdf_Element::CLONE_MODE_FORCE_CLONING

Properties

\Zend_Pdf_ElementFactory $_factory

Reference to the factory.

Details

Type: \Zend_Pdf_ElementFactory

integer $_genNum

Generation number

Details

Type: integer

integer $_objNum

Object number within PDF file

Details

Type: integer

\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

\Zend_Pdf_Element $_value

Object value

Details

Type: \Zend_Pdf_Element

Methods

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

Call handler

Parameters

Name	Type	Description
$method	string
$args	array

Returns

Type	Description
mixed

__construct(\Zend_Pdf_Element $val, integer $objNum, integer $genNum, \Zend_Pdf_ElementFactory $factory) : void

Object constructor

Parameters

Name	Type	Description
$val	\Zend_Pdf_Element
$objNum	integer
$genNum	integer
$factory	\Zend_Pdf_ElementFactory

Throws

Exception	Description
\Zend_Pdf_Exception

__get(string $property) : mixed

Get handler

Parameters

Name	Type	Description
$property	string

Returns

Type	Description
mixed

__set(string $property, mixed $value) : void

Set handler

Parameters

Name	Type	Description
$property	string
$value	mixed

cleanUp() : void

Clean up resources, used by object

dump(\Zend_Pdf_ElementFactory $factory) : string

Dump object to a string to save within PDF file.

$factory parameter defines operation context.

Parameters

Name	Type	Description
$factory	\Zend_Pdf_ElementFactory

Returns

Type	Description
string

getFactory() : \Zend_Pdf_ElementFactory

Check, that object is generated by specified factory

Returns

Type	Description
\Zend_Pdf_ElementFactory

getGenNum() : integer

Get generation number

Returns

Type	Description
integer

getObjNum() : integer

Get object number

Returns

Type	Description
integer

getObject() : \Zend_Pdf_Element_Object

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

Returns

Type	Description
\Zend_Pdf_Element_Object

getParentObject() : \Zend_Pdf_Element_Object

inherited

Get top level parent indirect object.

Inherited from: \Zend_Pdf_Element::getParentObject()

Returns

Type	Description
\Zend_Pdf_Element_Object

getType() : integer

Return type of the element.

See ZPdfPDFConst for possible values

Returns

Type	Description
integer

makeClone(\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

phpToPdf(mixed $input) : \Zend_Pdf_Element

staticinherited

Convert PHP value into PDF element.

Inherited from: \Zend_Pdf_Element::phpToPdf()

Parameters

Name	Type	Description
$input	mixed

Returns

Type	Description
\Zend_Pdf_Element

setParentObject(\Zend_Pdf_Element_Object $parent) : void

inherited

Set top level parent indirect object.

Inherited from: \Zend_Pdf_Element::setParentObject()

Parameters

Name	Type	Description
$parent	\Zend_Pdf_Element_Object

toPhp() : mixed

Convert PDF element to PHP type.

Returns

Type	Description
mixed

toString(\Zend_Pdf_Factory $factory = null) : string

Return reference to the object

$factory parameter defines operation context.

Parameters

Name	Type	Description
$factory	\Zend_Pdf_Factory

Returns

Type	Description
string

touch() : 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.

Pdf/Element/Object.php

\Zend_Pdf_Element_Objectjump to top

Constants

Properties

Methods

\Zend_Pdf_Element_Object
jump to top