Pdf/Action/GoTo.php

Show:

inherited

Classes
- \Zend_Pdf_Action_GoTo

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 [email protected] 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
Subpackage: Actions
Version: $Id: GoTo.php 24593 2012-01-05 20:35:02Z matthew $

\Zend_Pdf_Action_GoTo
jump to top

Package: Zend\Pdf\Actions

PDF 'Go to' action

Parent(s): \Zend_Pdf_Action < \Zend_Pdf_Target
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Properties

\Zend_Pdf_Element_Dictionary|\Zend_Pdf_Element_Object|\Zend_Pdf_Element_Reference $_actionDictionary =

inherited

Action dictionary

Inherited from: \Zend_Pdf_Action::$$_actionDictionary

Details

Type: \Zend_Pdf_Element_Dictionary | \Zend_Pdf_Element_Object | \Zend_Pdf_Element_Reference
Inherited_from: \Zend_Pdf_Action::$$_actionDictionary

\Zend_Pdf_Destination $_destination =

GoTo Action destination

Details

Type: \Zend_Pdf_Destination

array $_originalNextList =

inherited

An original list of chained actions

<p>Array of Zend_Pdf_Action objects</p>Inherited from: \Zend_Pdf_Action::$$_originalNextList

Details

Type: array
Inherited_from: \Zend_Pdf_Action::$$_originalNextList

array $next = array()

inherited

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

<p>Array of Zend_Pdf_Action objects</p>Inherited from: \Zend_Pdf_Action::$$next

Default valuearray()Details

Type: array
Inherited_from: \Zend_Pdf_Action::$$next

Methods

__construct(\Zend_Pdf_Element_Dictionary $dictionary, \SplObjectStorage $processedActions) : void

Object constructor

Parameters

Name	Type	Description
$dictionary	\Zend_Pdf_Element_Dictionary
$processedActions	\SplObjectStorage	list of already processed action dictionaries, used to avoid cyclic references

Throws

Exception	Description
\Zend_Pdf_Exception

count() : int

inherited

count()

Inherited from: \Zend_Pdf_Action::count()

Returns

Type	Description
int

create(\Zend_Pdf_Destination | string $destination) : \Zend_Pdf_Action_GoTo

static

Create new Zend_Pdf_Action_GoTo object using specified destination

Parameters

Name	Type	Description
$destination	\Zend_Pdf_Destination \| string

Returns

Type	Description
\Zend_Pdf_Action_GoTo

current() : \Zend_Pdf_Action

inherited

Returns current child action.

Inherited from: \Zend_Pdf_Action::current()

Returns

Type	Description
\Zend_Pdf_Action

getChildren() : \Zend_Pdf_Action | null

inherited

Returns the child action.

Inherited from: \Zend_Pdf_Action::getChildren()

Returns

Type	Description
\Zend_Pdf_Action \| null

getDestination() : \Zend_Pdf_Destination

Get goto action destination

Returns

Type	Description
\Zend_Pdf_Destination

hasChildren() : bool

inherited

Implements RecursiveIterator interface.

Inherited from: \Zend_Pdf_Action::hasChildren()

Returns

Type	Description
bool	whether container has any pages

key() : integer

inherited

Returns current iterator key

Inherited from: \Zend_Pdf_Action::key()

Returns

Type	Description
integer

next() : void

inherited

Go to next child

Inherited from: \Zend_Pdf_Action::next()

rewind() : void

inherited

Rewind children

Inherited from: \Zend_Pdf_Action::rewind()

setDestination(\Zend_Pdf_Destination | string $destination) : \Zend_Pdf_Action_GoTo

Set goto action destination

Parameters

Name	Type	Description
$destination	\Zend_Pdf_Destination \| string

Returns

Type	Description
\Zend_Pdf_Action_GoTo

valid() : boolean

inherited

Check if current position is valid

Inherited from: \Zend_Pdf_Action::valid()

Returns

Type	Description
boolean

Pdf/Action/GoTo.php

\Zend_Pdf_Action_GoTojump to top

Properties

Methods

\Zend_Pdf_Action_GoTo
jump to top