PDF 'Resolve a uniform resource identifier' action

A URI action causes a URI to be resolved.

package Zend_Pdf
subpackage Actions
copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license New BSD License
inherited_from \Zend_Pdf_Action

 Methods

Object constructor

__construct(\Zend_Pdf_Element_Dictionary $dictionary, \SplObjectStorage $processedActions) 
inherited_from \Zend_Pdf_Action::__construct()

Parameters

$dictionary

\Zend_Pdf_Element_Dictionary

$processedActions

\SplObjectStorage

list of already processed action dictionaries, used to avoid cyclic references

Exceptions

\Zend_Pdf_Exception

Object constructor

__construct(\Zend_Pdf_Element_Dictionary $dictionary, \SplObjectStorage $processedActions) 
Inherited

Parameters

$dictionary

\Zend_Pdf_Element_Dictionary

$processedActions

\SplObjectStorage

list of already processed action dictionaries, used to avoid cyclic references

Exceptions

\Zend_Pdf_Exception

count()

count() : integer
Inherited

Returns

integer

Create new Zend_Pdf_Action_URI object using specified uri

create(string $uri, boolean $isMap = false) : \Zend_Pdf_Action_URI
Static

Parameters

$uri

string

The URI to resolve, encoded in 7-bit ASCII

$isMap

boolean

A flag specifying whether to track the mouse position when the URI is resolved

Returns

\Zend_Pdf_Action_URI

Returns current child action.

current() : \Zend_Pdf_Action
Inherited

Returns

\Zend_Pdf_Action

Returns the child action.

getChildren() : \Zend_Pdf_Action | null
Inherited

Returns

\Zend_Pdf_Actionnull

Get IsMap property

getIsMap() : boolean

If the IsMap flag is true and the user has triggered the URI action by clicking an annotation, the coordinates of the mouse position at the time the action is performed should be transformed from device space to user space and then offset relative to the upper-left corner of the annotation rectangle.

Returns

boolean

Get URI to resolve

getUri() : string

Returns

string

Implements RecursiveIterator interface.

hasChildren() : boolean
Inherited

Returns

booleanwhether container has any pages

Returns current iterator key

key() : integer
Inherited

Returns

integer

Parse resource and return it as an Action or Explicit Destination

load(\Zend_Pdf_Element $resource) : \Zend_Pdf_Destination
InheritedStatic

$param Zend_Pdf_Element $resource

Parameters

$resource

Exceptions

\Zend_Pdf_Exception

Returns

\Zend_Pdf_Destination

Go to next child

next() 
Inherited

Rewind children

rewind() 
Inherited

Set IsMap property

setIsMap(boolean $isMap) : \Zend_Pdf_Action_URI

If the IsMap flag is true and the user has triggered the URI action by clicking an annotation, the coordinates of the mouse position at the time the action is performed should be transformed from device space to user space and then offset relative to the upper-left corner of the annotation rectangle.

Parameters

$isMap

boolean

A flag specifying whether to track the mouse position when the URI is resolved

Returns

\Zend_Pdf_Action_URI

Set URI to resolve

setUri(string $uri) : \Zend_Pdf_Action_URI

Parameters

$uri

string

The uri to resolve, encoded in 7-bit ASCII.

Returns

\Zend_Pdf_Action_URI

Check if current position is valid

valid() : boolean
Inherited

Returns

boolean

Validate URI

_validateUri(string $uri) : true
Static

Parameters

$uri

string

Exceptions

\Zend_Pdf_Exception

Returns

true

 Properties

 

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

$next : array

Default

array()
 

Action dictionary

$_actionDictionary : \Zend_Pdf_Element_Dictionary | \Zend_Pdf_Element_Object | \Zend_Pdf_Element_Reference

Default

 

An original list of chained actions

$_originalNextList : array

Default