Zend_Pdf_Action Class Reference

Inheritance diagram for Zend_Pdf_Action:

Public Member Functions
	__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	load (Zend_Pdf_Element $dictionary, SplObjectStorage $processedActions=null)
Static Public Member Functions inherited from Zend_Pdf_Target
static	load (Zend_Pdf_Element $resource)

Data Fields
	$next = array()

Protected Attributes
	$_actionDictionary
	$_originalNextList

Detailed Description

Definition at line 41 of file Action.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 72 of file Action.php.

    {
        #require_once 'Zend/Pdf/Element.php';
        if ($dictionary->getType() != Zend_Pdf_Element::TYPE_DICTIONARY) {
            #require_once 'Zend/Pdf/Exception.php';
            throw new Zend_Pdf_Exception('$dictionary mast be a direct or an indirect dictionary object.');
        }

        $this->_actionDictionary = $dictionary;

        if ($dictionary->Next !== null) {
            if ($dictionary->Next instanceof Zend_Pdf_Element_Dictionary) {
                // Check if dictionary object is not already processed
                if (!$processedActions->contains($dictionary->Next)) {
                    $processedActions->attach($dictionary->Next);
                    $this->next[] = Zend_Pdf_Action::load($dictionary->Next, $processedActions);
                }
            } else if ($dictionary->Next instanceof Zend_Pdf_Element_Array) {
                foreach ($dictionary->Next->items as $chainedActionDictionary) {
                    // Check if dictionary object is not already processed
                    if (!$processedActions->contains($chainedActionDictionary)) {
                        $processedActions->attach($chainedActionDictionary);
                        $this->next[] = Zend_Pdf_Action::load($chainedActionDictionary, $processedActions);
                    }
                }
            } else {
                #require_once 'Zend/Pdf/Exception.php';
                throw new Zend_Pdf_Exception('PDF Action dictionary Next entry must be a dictionary or an array.');
            }
        }

        $this->_originalNextList = $this->next;
    }

Member Function Documentation

count()

count

(

)

count()

Returns

int

Definition at line 400 of file Action.php.

    {
        return count($this->childOutlines);
    }

current()

current

(

)

Returns current child action.

Returns

Zend_Pdf_Action

Definition at line 329 of file Action.php.

    {
        return current($this->next);
    }

dumpAction()

dumpAction	(	Zend_Pdf_ElementFactory_Interface	$factory,
		SplObjectStorage	$processedActions = null
	)

Dump Action and its child actions into PDF structures

Returns dictionary indirect object or reference

Definition at line 255 of file Action.php.

    {
        if ($processedActions === null) {
            $processedActions = new SplObjectStorage();
        }
        if ($processedActions->contains($this)) {
            #require_once 'Zend/Pdf/Exception.php';
            throw new Zend_Pdf_Exception('Action chain cyclyc reference is detected.');
        }
        $processedActions->attach($this);

        $childListUpdated = false;
        if (count($this->_originalNextList) != count($this->next)) {
            // If original and current children arrays have different size then children list was updated
            $childListUpdated = true;
        } else if ( !(array_keys($this->_originalNextList) === array_keys($this->next)) ) {
            // If original and current children arrays have different keys (with a glance to an order) then children list was updated
            $childListUpdated = true;
        } else {
            foreach ($this->next as $key => $childAction) {
                if ($this->_originalNextList[$key] !== $childAction) {
                    $childListUpdated = true;
                    break;
                }
            }
        }

        if ($childListUpdated) {
            $this->_actionDictionary->touch();
            switch (count($this->next)) {
                case 0:
                    $this->_actionDictionary->Next = null;
                    break;

                case 1:
                    $child = reset($this->next);
                    $this->_actionDictionary->Next = $child->dumpAction($factory, $processedActions);
                    break;

                default:
                    #require_once 'Zend/Pdf/Element/Array.php';
                    $pdfChildArray = new Zend_Pdf_Element_Array();
                    foreach ($this->next as $child) {

                        $pdfChildArray->items[] = $child->dumpAction($factory, $processedActions);
                    }
                    $this->_actionDictionary->Next = $pdfChildArray;
                    break;
            }
        } else {
            foreach ($this->next as $child) {
                $child->dumpAction($factory, $processedActions);
            }
        }

        if ($this->_actionDictionary instanceof Zend_Pdf_Element_Dictionary) {
            // It's a newly created action. Register it within object factory and return indirect object
            return $factory->newObject($this->_actionDictionary);
        } else {
            // It's a loaded object
            return $this->_actionDictionary;
        }
    }

getChildren()

getChildren

(

)

Returns the child action.

Returns

Zend_Pdf_Action|null

Definition at line 375 of file Action.php.

    {
        return current($this->next);
    }

getResource()

getResource

(

)

Get resource

Definition at line 240 of file Action.php.

    {
        return $this->_actionDictionary;
    }

hasChildren()

hasChildren

(

)

Implements RecursiveIterator interface.

Returns

bool whether container has any pages

Definition at line 385 of file Action.php.

    {
        return count($this->next) > 0;
    }

key()

key

(

)

Returns current iterator key

Returns

integer

Definition at line 339 of file Action.php.

    {
        return key($this->next);
    }

load()

static load ( Zend_Pdf_Element  $dictionary, SplObjectStorage  $processedActions = null  )

static

Load PDF action object using specified dictionary

Definition at line 115 of file Action.php.

    {
        if ($processedActions === null) {
            $processedActions = new SplObjectStorage();
        }

        #require_once 'Zend/Pdf/Element.php';
        if ($dictionary->getType() != Zend_Pdf_Element::TYPE_DICTIONARY) {
            #require_once 'Zend/Pdf/Exception.php';
            throw new Zend_Pdf_Exception('$dictionary mast be a direct or an indirect dictionary object.');
        }
        if (isset($dictionary->Type)  &&  $dictionary->Type->value != 'Action') {
            #require_once 'Zend/Pdf/Exception.php';
            throw new Zend_Pdf_Exception('Action dictionary Type entry must be set to \'Action\'.');
        }

        if ($dictionary->S === null) {
            #require_once 'Zend/Pdf/Exception.php';
            throw new Zend_Pdf_Exception('Action dictionary must contain S entry');
        }

        switch ($dictionary->S->value) {
            case 'GoTo':
                #require_once 'Zend/Pdf/Action/GoTo.php';
                return new Zend_Pdf_Action_GoTo($dictionary, $processedActions);
                break;

            case 'GoToR':
                #require_once 'Zend/Pdf/Action/GoToR.php';
                return new Zend_Pdf_Action_GoToR($dictionary, $processedActions);
                break;

            case 'GoToE':
                #require_once 'Zend/Pdf/Action/GoToE.php';
                return new Zend_Pdf_Action_GoToE($dictionary, $processedActions);
                break;

            case 'Launch':
                #require_once 'Zend/Pdf/Action/Launch.php';
                return new Zend_Pdf_Action_Launch($dictionary, $processedActions);
                break;

            case 'Thread':
                #require_once 'Zend/Pdf/Action/Thread.php';
                return new Zend_Pdf_Action_Thread($dictionary, $processedActions);
                break;

            case 'URI':
                #require_once 'Zend/Pdf/Action/URI.php';
                return new Zend_Pdf_Action_URI($dictionary, $processedActions);
                break;

            case 'Sound':
                #require_once 'Zend/Pdf/Action/Sound.php';
                return new Zend_Pdf_Action_Sound($dictionary, $processedActions);
                break;

            case 'Movie':
                #require_once 'Zend/Pdf/Action/Movie.php';
                return new Zend_Pdf_Action_Movie($dictionary, $processedActions);
                break;

            case 'Hide':
                #require_once 'Zend/Pdf/Action/Hide.php';
                return new Zend_Pdf_Action_Hide($dictionary, $processedActions);
                break;

            case 'Named':
                #require_once 'Zend/Pdf/Action/Named.php';
                return new Zend_Pdf_Action_Named($dictionary, $processedActions);
                break;

            case 'SubmitForm':
                #require_once 'Zend/Pdf/Action/SubmitForm.php';
                return new Zend_Pdf_Action_SubmitForm($dictionary, $processedActions);
                break;

            case 'ResetForm':
                #require_once 'Zend/Pdf/Action/ResetForm.php';
                return new Zend_Pdf_Action_ResetForm($dictionary, $processedActions);
                break;

            case 'ImportData':
                #require_once 'Zend/Pdf/Action/ImportData.php';
                return new Zend_Pdf_Action_ImportData($dictionary, $processedActions);
                break;

            case 'JavaScript':
                #require_once 'Zend/Pdf/Action/JavaScript.php';
                return new Zend_Pdf_Action_JavaScript($dictionary, $processedActions);
                break;

            case 'SetOCGState':
                #require_once 'Zend/Pdf/Action/SetOCGState.php';
                return new Zend_Pdf_Action_SetOCGState($dictionary, $processedActions);
                break;

            case 'Rendition':
                #require_once 'Zend/Pdf/Action/Rendition.php';
                return new Zend_Pdf_Action_Rendition($dictionary, $processedActions);
                break;

            case 'Trans':
                #require_once 'Zend/Pdf/Action/Trans.php';
                return new Zend_Pdf_Action_Trans($dictionary, $processedActions);
                break;

            case 'GoTo3DView':
                #require_once 'Zend/Pdf/Action/GoTo3DView.php';
                return new Zend_Pdf_Action_GoTo3DView($dictionary, $processedActions);
                break;

            default:
                #require_once 'Zend/Pdf/Action/Unknown.php';
                return new Zend_Pdf_Action_Unknown($dictionary, $processedActions);
                break;
        }
    }

next()

next

(

)

Go to next child

Definition at line 347 of file Action.php.

    {
        return next($this->next);
    }

rewind()

rewind

(

)

Rewind children

Definition at line 355 of file Action.php.

    {
        return reset($this->next);
    }

valid()

valid

(

)

Check if current position is valid

Returns

boolean

Definition at line 365 of file Action.php.

    {
        return current($this->next) !== false;
    }

Field Documentation

$_actionDictionary

$_actionDictionary

protected

Definition at line 48 of file Action.php.

$_originalNextList

$_originalNextList

protected

Definition at line 56 of file Action.php.

$next

$next = array()

Definition at line 63 of file Action.php.

---

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

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