API Documentation

Pdf/Action.php

Includes Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Pdf
subpackage
Actions
version
$Id: Action.php 22438 2010-06-15 16:15:51Z alexander $
Classes
Zend_Pdf_Action

Description

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.

Zend_Pdf_Action
jump to top

Extends from
Zend_Pdf_Target
Implements
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Pdf
subpackage
Actions
Properties
$_actionDictionary
$_originalNextList
$next
Methods
__construct
load
getResource
dumpAction
current
key
next
rewind
valid
getChildren
hasChildren
count

Description

Abstract PDF action representation class

Properties

$_actionDictionary
jump to class

Zend_Pdf_Element_Dictionary|Zend_Pdf_Element_Object|Zend_Pdf_Element_Reference $_actionDictionary = ''

Action dictionary

Details

$_actionDictionary
Zend_Pdf_Element_Dictionary|Zend_Pdf_Element_Object|Zend_Pdf_Element_Reference
visibility
protected
default
final
false
static
false

$_originalNextList
jump to class

array $_originalNextList = ''

An original list of chained actions

Details

$_originalNextList
array
Array of Zend_Pdf_Action objects
visibility
protected
default
final
false
static
false

$next
jump to class

array $next = 'array'

A list of next actions in actions tree (used for actions chaining)

Details

$next
array
Array of Zend_Pdf_Action objects
visibility
public
default
array
final
false
static
false

Methods

__construct
jump to class

__construct( Zend_Pdf_Element_Dictionary $dictionary, SplObjectStorage $processedActions ) :

Object constructor

Arguments
$dictionary
Zend_Pdf_Element_Dictionary
$processedActions
SplObjectStorage
list of already processed action dictionaries, used to avoid cyclic references
Details
visibility
public
final
false
static
false
throws

count
jump to class

count( ) : int

count()

Output
int
Details
visibility
public
final
false
static
false

current
jump to class

current( ) : Zend_Pdf_Action

Returns current child action.

Output
Zend_Pdf_Action
Details
visibility
public
final
false
static
false

dumpAction
jump to class

dumpAction( Zend_Pdf_ElementFactory $factory, SplObjectStorage $processedActions = null ) : Zend_Pdf_Element_Object|Zend_Pdf_Element_Reference

Dump Action and its child actions into PDF structures

Returns dictionary indirect object or reference

Arguments
$factory
Zend_Pdf_ElementFactory
Object factory for newly created indirect objects
$processedActions
SplObjectStorage
list of already processed actions (used to prevent infinity loop caused by cyclic references)
Output
Zend_Pdf_Element_Object|Zend_Pdf_Element_Reference
Dictionary indirect object
Details
visibility
public
final
false
static
false
internal

getChildren
jump to class

getChildren( ) : Zend_Pdf_Action|null

Returns the child action.

Output
Zend_Pdf_Action|null
Details
visibility
public
final
false
static
false

getResource
jump to class

getResource( ) : Zend_Pdf_Element

Get resource

Output
Zend_Pdf_Element
Details
visibility
public
final
false
static
false
internal

hasChildren
jump to class

hasChildren( ) : bool

Implements RecursiveIterator interface.

Output
bool
whether container has any pages
Details
visibility
public
final
false
static
false

key
jump to class

key( ) : integer

Returns current iterator key

Output
integer
Details
visibility
public
final
false
static
false

load
jump to class

load( Zend_Pdf_Element $dictionary, SplObjectStorage $processedActions = null ) : Zend_Pdf_Action

Load PDF action object using specified dictionary

Arguments
$dictionary
Zend_Pdf_Element
(It's actually Dictionary or Dictionary Object or Reference to a Dictionary Object)
$processedActions
SplObjectStorage
list of already processed action dictionaries, used to avoid cyclic references
Output
Zend_Pdf_Action
Details
visibility
public
final
false
static
true
internal
throws

next
jump to class

next( ) :

Go to next child

Details
visibility
public
final
false
static
false

rewind
jump to class

rewind( ) :

Rewind children

Details
visibility
public
final
false
static
false

valid
jump to class

valid( ) : boolean

Check if current position is valid

Output
boolean
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.