Zend_Pdf_Action_URI Class Reference

Inheritance diagram for Zend_Pdf_Action_URI:

Public Member Functions
	__construct (Zend_Pdf_Element $dictionary, SplObjectStorage $processedActions)
	setUri ($uri)
	getUri ()
	setIsMap ($isMap)
	getIsMap ()
Public Member Functions inherited from Zend_Pdf_Action
	__construct (Zend_Pdf_Element $dictionary, SplObjectStorage $processedActions)
	getResource ()
	dumpAction (Zend_Pdf_ElementFactory_Interface $factory, SplObjectStorage $processedActions=null)
	current ()
	key ()
	next ()
	rewind ()
	valid ()
	getChildren ()
	hasChildren ()
	count ()
Public Member Functions inherited from Zend_Pdf_Target
	getResource ()

Static Public Member Functions
static	create ($uri, $isMap=false)
Static Public Member Functions inherited from Zend_Pdf_Action
static	load (Zend_Pdf_Element $dictionary, SplObjectStorage $processedActions=null)
Static Public Member Functions inherited from Zend_Pdf_Target
static	load (Zend_Pdf_Element $resource)

Static Protected Member Functions
static	_validateUri ($uri)

Additional Inherited Members
Data Fields inherited from Zend_Pdf_Action
	$next = array()
Protected Attributes inherited from Zend_Pdf_Action
	$_actionDictionary
	$_originalNextList

Detailed Description

Definition at line 44 of file URI.php.

Constructor & Destructor Documentation

__construct()

__construct	(	Zend_Pdf_Element	$dictionary,
		SplObjectStorage	$processedActions
	)

Object constructor

Parameters

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

Exceptions

Zend_Pdf_Exception

Definition at line 53 of file URI.php.

    {
        parent::__construct($dictionary, $processedActions);

        if ($dictionary->URI === null) {
            #require_once 'Zend/Pdf/Exception.php';
            throw new Zend_Pdf_Exception('URI action dictionary entry is required');
        }
    }

Member Function Documentation

_validateUri()

static _validateUri (   $uri )

staticprotected

Validate URI

Parameters

string

$uri

Returns

true

Exceptions

Zend_Pdf_Exception

Definition at line 70 of file URI.php.

    {
        $scheme = parse_url((string)$uri, PHP_URL_SCHEME);
        if ($scheme === false || $scheme === null) {
            #require_once 'Zend/Pdf/Exception.php';
            throw new Zend_Pdf_Exception('Invalid URI');
        }
    }

create()

static create (   $uri,   $isMap = false  )

static

Create new Zend_Pdf_Action_URI object using specified uri

Parameters

string	$uri	The URI to resolve, encoded in 7-bit ASCII
boolean	$isMap	A flag specifying whether to track the mouse position when the URI is resolved

Returns

Zend_Pdf_Action_URI

Definition at line 86 of file URI.php.

    {
        self::_validateUri($uri);

        $dictionary = new Zend_Pdf_Element_Dictionary();
        $dictionary->Type = new Zend_Pdf_Element_Name('Action');
        $dictionary->S    = new Zend_Pdf_Element_Name('URI');
        $dictionary->Next = null;
        $dictionary->URI  = new Zend_Pdf_Element_String($uri);
        if ($isMap) {
            $dictionary->IsMap = new Zend_Pdf_Element_Boolean(true);
        }

        return new Zend_Pdf_Action_URI($dictionary, new SplObjectStorage());
    }

getIsMap()

getIsMap

(

)

Get IsMap property

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

Definition at line 162 of file URI.php.

    {
        return $this->_actionDictionary->IsMap !== null  &&
               $this->_actionDictionary->IsMap->value;
    }

getUri()

getUri

(

)

Get URI to resolve

Returns

string

Definition at line 123 of file URI.php.

    {
        return $this->_actionDictionary->URI->value;
    }

setIsMap()

setIsMap

(

$isMap

)

Set IsMap property

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

boolean

$isMap

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

Returns

Zend_Pdf_Action_URI

Definition at line 139 of file URI.php.

    {
        $this->_actionDictionary->touch();

        if ($isMap) {
            $this->_actionDictionary->IsMap = new Zend_Pdf_Element_Boolean(true);
        } else {
            $this->_actionDictionary->IsMap = null;
        }

        return $this;
    }

setUri()

setUri

(

$uri

)

Set URI to resolve

Parameters

string

$uri

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

Returns

Zend_Pdf_Action_URI

Definition at line 108 of file URI.php.

    {
        $this->_validateUri($uri);

        $this->_actionDictionary->touch();
        $this->_actionDictionary->URI = new Zend_Pdf_Element_String($uri);

        return $this;
    }

---

The documentation for this class was generated from the following file:

• vendor/magento/zendframework1/library/Zend/Pdf/Action/URI.php