Pdf/Element.php

Show:

inherited

Classes
- \Zend_Pdf_Element

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

\Zend_Pdf_Element
jump to top

Package: Zend\Pdf

PDF file element implementation

Children: \Zend_Pdf_Element_Array; \Zend_Pdf_Element_Null; \Zend_Pdf_Element_Name; \Zend_Pdf_Element_String; \Zend_Pdf_Element_Object; \Zend_Pdf_Element_Numeric; \Zend_Pdf_Element_Boolean; \Zend_Pdf_Element_Dictionary; \Zend_Pdf_Element_Reference; \Zend_Pdf_Element_Stream
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Constants

 
                TYPE_BOOL
                = 1

 
                TYPE_NUMERIC
                = 2

 
                TYPE_STRING
                = 3

 
                TYPE_NAME
                = 4

 
                TYPE_ARRAY
                = 5

 
                TYPE_DICTIONARY
                = 6

 
                TYPE_STREAM
                = 7

 
                TYPE_NULL
                = 11

 
                CLONE_MODE_SKIP_PAGES
                = 1

 
                CLONE_MODE_FORCE_CLONING
                = 2

Properties

\Zend_Pdf_Element_Object $_parentObject = null

Reference to the top level indirect object, which contains this element.

Default valuenullDetails

Type: \Zend_Pdf_Element_Object

Methods

cleanUp() : void

Clean up resources, used by object

getParentObject() : \Zend_Pdf_Element_Object

Get top level parent indirect object.

Returns

Type	Description
\Zend_Pdf_Element_Object

getType() : integer

abstract

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
Todo: It's nevessry to check if SplObjectStorage class works faster (Needs PHP 5.3.x to attach object _with_ additional data to storage)

phpToPdf(mixed $input) : \Zend_Pdf_Element

static

Convert PHP value into PDF element.

Parameters

Name	Type	Description
$input	mixed

Returns

Type	Description
\Zend_Pdf_Element

setParentObject(\Zend_Pdf_Element_Object $parent) : void

Set top level parent indirect object.

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

abstract

Convert element to a string, which can be directly written to a PDF file.

$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.php

\Zend_Pdf_Elementjump to top

Constants

Properties

Methods

\Zend_Pdf_Element
jump to top