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

\Zend_Pdf_Element_Array

Package: Zend\Pdf
PDF file 'array' 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_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  
>VPropertypublicarray $items
Array element items

Array of Zend_Pdf_Element objects

Details
Type
array

Methods

methodpublic__construct(array $val = null) : void

Object constructor

Parameters
NameTypeDescription
$valarray
  • array of Zend_Pdf_Element objects
Throws
ExceptionDescription
\Zend_Pdf_Exception
methodpublic__get(string $property) : void

Getter

Parameters
NameTypeDescription
$propertystring
Throws
ExceptionDescription
\Zend_Pdf_Exception
methodpublic__set( $property, mixed $value) : void

Setter

Parameters
NameTypeDescription
$property
$valuemixed
Throws
ExceptionDescription
\Zend_Pdf_Exception
methodpubliccleanUp() : void
inherited

Clean up resources, used by object

Inherited from: \Zend_Pdf_Element::cleanUp()
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

Set top level parent indirect object.

Parameters
NameTypeDescription
$parent\Zend_Pdf_Element_Object
methodpublictoPhp() : mixed

Convert PDF element to PHP type.

Dictionary is returned as an associative array

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

Return object as string

$factory parameter defines operation context.

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

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

Inherited from: \Zend_Pdf_Element::touch()

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.