Zend_Pdf_Action_GoTo Class Reference

Inheritance diagram for Zend_Pdf_Action_GoTo:

Public Member Functions
	__construct (Zend_Pdf_Element $dictionary, SplObjectStorage $processedActions)
	setDestination (Zend_Pdf_Destination $destination)
	getDestination ()
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 ($destination)
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)

Protected Attributes
	$_destination
Protected Attributes inherited from Zend_Pdf_Action
	$_actionDictionary
	$_originalNextList

Additional Inherited Members
Data Fields inherited from Zend_Pdf_Action
	$next = array()

Detailed Description

Definition at line 41 of file GoTo.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

Definition at line 57 of file GoTo.php.

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

        $this->_destination = Zend_Pdf_Destination::load($dictionary->D);
    }

Member Function Documentation

create()

static create (   $destination )

static

Create new Zend_Pdf_Action_GoTo object using specified destination

Parameters

Zend_Pdf_Destination | string

$destination

Returns

Zend_Pdf_Action_GoTo

Definition at line 70 of file GoTo.php.

    {
        if (is_string($destination)) {
            #require_once 'Zend/Pdf/Destination/Named.php';
            $destination = Zend_Pdf_Destination_Named::create($destination);
        }

        if (!$destination instanceof Zend_Pdf_Destination) {
            #require_once 'Zend/Pdf/Exception.php';
            throw new Zend_Pdf_Exception('$destination parameter must be a Zend_Pdf_Destination object or string.');
        }

        $dictionary = new Zend_Pdf_Element_Dictionary();
        $dictionary->Type = new Zend_Pdf_Element_Name('Action');
        $dictionary->S    = new Zend_Pdf_Element_Name('GoTo');
        $dictionary->Next = null;
        $dictionary->D    = $destination->getResource();

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

getDestination()

getDestination

(

)

Get goto action destination

Returns

Zend_Pdf_Destination

Definition at line 112 of file GoTo.php.

    {
        return $this->_destination;
    }

setDestination()

setDestination

(

Zend_Pdf_Destination

$destination

)

Set goto action destination

Parameters

Zend_Pdf_Destination | string

$destination

Returns

Zend_Pdf_Action_GoTo

Definition at line 97 of file GoTo.php.

    {
        $this->_destination = $destination;

        $this->_actionDictionary->touch();
        $this->_actionDictionary->D = $destination->getResource();

        return $this;
    }

Field Documentation

$_destination

$_destination

protected

Definition at line 48 of file GoTo.php.

---

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

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