Zend_Pdf_Annotation_Link Class Reference

Inheritance diagram for Zend_Pdf_Annotation_Link:

Public Member Functions
	__construct (Zend_Pdf_Element $annotationDictionary)
	setDestination ($target)
	getDestination ()
Public Member Functions inherited from Zend_Pdf_Annotation
	getResource ()
	setBottom ($bottom)
	getBottom ()
	setTop ($top)
	getTop ()
	setRight ($right)
	getRight ()
	setLeft ($left)
	getLeft ()
	getText ()
	setText ($text)
	__construct (Zend_Pdf_Element $annotationDictionary)

Static Public Member Functions
static	create ($x1, $y1, $x2, $y2, $target)
Static Public Member Functions inherited from Zend_Pdf_Annotation
static	load (Zend_Pdf_Element $resource)

Additional Inherited Members
Protected Attributes inherited from Zend_Pdf_Annotation
	$_annotationDictionary

Detailed Description

Definition at line 46 of file Link.php.

Constructor & Destructor Documentation

__construct()

__construct

(

Zend_Pdf_Element

$annotationDictionary

)

Annotation object constructor

Exceptions

Zend_Pdf_Exception

Definition at line 53 of file Link.php.

    {
        if ($annotationDictionary->getType() != Zend_Pdf_Element::TYPE_DICTIONARY) {
            #require_once 'Zend/Pdf/Exception.php';
            throw new Zend_Pdf_Exception('Annotation dictionary resource has to be a dictionary.');
        }

        if ($annotationDictionary->Subtype === null  ||
            $annotationDictionary->Subtype->getType() != Zend_Pdf_Element::TYPE_NAME  ||
            $annotationDictionary->Subtype->value != 'Link') {
            #require_once 'Zend/Pdf/Exception.php';
            throw new Zend_Pdf_Exception('Subtype => Link entry is requires');
        }

        parent::__construct($annotationDictionary);
    }

Member Function Documentation

create()

static create (   $x1,   $y1,   $x2,   $y2,   $target  )

static

Create link annotation object

Parameters

float	$x1
float	$y1
float	$x2
float	$y2
Zend_Pdf_Target | string	$target

Returns

Zend_Pdf_Annotation_Link

Exceptions

Zend_Pdf_Exception

Definition at line 81 of file Link.php.

    {
        if (is_string($target)) {
            #require_once 'Zend/Pdf/Destination/Named.php';
            $target = Zend_Pdf_Destination_Named::create($target);
        }
        if (!$target instanceof Zend_Pdf_Target) {
            #require_once 'Zend/Pdf/Exception.php';
            throw new Zend_Pdf_Exception('$target parameter must be a Zend_Pdf_Target object or a string.');
        }

        $annotationDictionary = new Zend_Pdf_Element_Dictionary();

        $annotationDictionary->Type    = new Zend_Pdf_Element_Name('Annot');
        $annotationDictionary->Subtype = new Zend_Pdf_Element_Name('Link');

        $rectangle = new Zend_Pdf_Element_Array();
        $rectangle->items[] = new Zend_Pdf_Element_Numeric($x1);
        $rectangle->items[] = new Zend_Pdf_Element_Numeric($y1);
        $rectangle->items[] = new Zend_Pdf_Element_Numeric($x2);
        $rectangle->items[] = new Zend_Pdf_Element_Numeric($y2);
        $annotationDictionary->Rect = $rectangle;

        if ($target instanceof Zend_Pdf_Destination) {
            $annotationDictionary->Dest = $target->getResource();
        } else {
            $annotationDictionary->A = $target->getResource();
        }

        return new Zend_Pdf_Annotation_Link($annotationDictionary);
    }

getDestination()

getDestination

(

)

Get link annotation destination

Returns

Zend_Pdf_Target|null

Definition at line 148 of file Link.php.

    {
        if ($this->_annotationDictionary->Dest === null  &&
            $this->_annotationDictionary->A    === null) {
            return null;
        }

        if ($this->_annotationDictionary->Dest !== null) {
            #require_once 'Zend/Pdf/Destination.php';
            return Zend_Pdf_Destination::load($this->_annotationDictionary->Dest);
        } else {
            #require_once 'Zend/Pdf/Action.php';
            return Zend_Pdf_Action::load($this->_annotationDictionary->A);
        }
    }

setDestination()

setDestination

(

$target

)

Set link annotation destination

Parameters

Zend_Pdf_Target | string

$target

Returns

Zend_Pdf_Annotation_Link

Definition at line 119 of file Link.php.

    {
        if (is_string($target)) {
            #require_once 'Zend/Pdf/Destination/Named.php';
            $destination = Zend_Pdf_Destination_Named::create($target);
        }
        if (!$target instanceof Zend_Pdf_Target) {
            #require_once 'Zend/Pdf/Exception.php';
            throw new Zend_Pdf_Exception('$target parameter must be a Zend_Pdf_Target object or a string.');
        }

        $this->_annotationDictionary->touch();
        $this->_annotationDictionary->Dest = $destination->getResource();
        if ($target instanceof Zend_Pdf_Destination) {
            $this->_annotationDictionary->Dest = $target->getResource();
            $this->_annotationDictionary->A    = null;
        } else {
            $this->_annotationDictionary->Dest = null;
            $this->_annotationDictionary->A    = $target->getResource();
        }

        return $this;
    }

---

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

• vendor/magento/zendframework1/library/Zend/Pdf/Annotation/Link.php