Pdf/Element/Dictionary.php
Show:
inherited
inherited
Classes
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-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Pdf
- Version
- $Id$
\Zend_Pdf_Element_Dictionary
Package: Zend_Pdf
PDF file 'dictionary' element implementation
- Parent(s)
- \Zend_Pdf_Element
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
array $_items = array()Dictionary elements
Array of Zend_Pdf_Element objects ('name' => Zend_Pdf_Element)
Default value
array()Details- Type
- array
Methods
__construct(array $val = null) : voidObject constructor
Parameters
Throws
| Name | Type | Description |
|---|---|---|
| $val | array |
|
| Exception | Description |
|---|---|
| \Zend_Pdf_Exception |
__get( $item) : \Zend_Pdf_ElementGet handler
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $item |
| Type | Description |
|---|---|
| \Zend_Pdf_Element | | null |
__set( $item, mixed $value) : voidSet handler
Parameters
| Name | Type | Description |
|---|---|---|
| $item | ||
| $value | mixed |
add( $name, \Zend_Pdf_Element $val) : voidAdd element to an array
Parameters
Throws
Details
| Name | Type | Description |
|---|---|---|
| $name | ||
| $val | \Zend_Pdf_Element |
|
| Exception | Description |
|---|---|
| \Zend_Pdf_Exception |
- Name
- Zend_Pdf_Element_Name $name
getKeys() : arrayReturn dictionary keys
Returns
| Type | Description |
|---|---|
| array |
getType() : integerReturn type of the element.
Returns
| Type | Description |
|---|---|
| integer |
makeClone(\Zend_Pdf_ElementFactory $factory, $processed, integer $mode) : voidDetach PDF object from the factory (if applicable), clone it and attach to new factory.
Parameters
Throws
Details
| Name | Type | Description |
|---|---|---|
| $factory | \Zend_Pdf_ElementFactory | The factory to attach |
| $processed | ||
| $mode | integer | Cloning mode (defines filter for objects cloning) |
| Exception | Description |
|---|---|
| \Zend_Pdf_Exception |
- Returns
- Zend_Pdf_Element
setParentObject(\Zend_Pdf_Element_Object $parent) : voidSet top level parent indirect object.
Parameters
| Name | Type | Description |
|---|---|---|
| $parent | \Zend_Pdf_Element_Object |
toPhp() : mixedConvert PDF element to PHP type.
Dictionary is returned as an associative array
Returns| Type | Description |
|---|---|
| mixed |
toString(\Zend_Pdf_Factory $factory = null) : stringReturn object as string
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $factory | \Zend_Pdf_Factory |
| Type | Description |
|---|---|
| string |