Zend_Pdf_Annotation Class Reference

Inheritance diagram for Zend_Pdf_Annotation:

Public Member Functions
	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	load (Zend_Pdf_Element $resource)

Protected Attributes
	$_annotationDictionary

Detailed Description

Definition at line 38 of file Annotation.php.

Constructor & Destructor Documentation

__construct()

__construct

(

Zend_Pdf_Element

$annotationDictionary

)

Annotation object constructor

Exceptions

Zend_Pdf_Exception

Definition at line 189 of file Annotation.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.');
        }

        $this->_annotationDictionary = $annotationDictionary;

        if ($this->_annotationDictionary->Type !== null  &&
            $this->_annotationDictionary->Type->value != 'Annot') {
            #require_once 'Zend/Pdf/Exception.php';
            throw new Zend_Pdf_Exception('Wrong resource type. \'Annot\' expected.');
        }

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

        if (count($this->_annotationDictionary->Rect->items) != 4 ||
            $this->_annotationDictionary->Rect->items[0]->getType() != Zend_Pdf_Element::TYPE_NUMERIC ||
            $this->_annotationDictionary->Rect->items[1]->getType() != Zend_Pdf_Element::TYPE_NUMERIC ||
            $this->_annotationDictionary->Rect->items[2]->getType() != Zend_Pdf_Element::TYPE_NUMERIC ||
            $this->_annotationDictionary->Rect->items[3]->getType() != Zend_Pdf_Element::TYPE_NUMERIC ) {
            #require_once 'Zend/Pdf/Exception.php';
            throw new Zend_Pdf_Exception('\'Rect\' dictionary entry must be an array of four numeric elements.');
        }
    }

Member Function Documentation

getBottom()

getBottom

(

)

Get bottom edge of the annotation rectangle.

Returns

float

Definition at line 77 of file Annotation.php.

                                {
        return $this->_annotationDictionary->Rect->items[1]->value;
    }

getLeft()

getLeft

(

)

Get left edge of the annotation rectangle.

Returns

float

Definition at line 143 of file Annotation.php.

                              {
        return $this->_annotationDictionary->Rect->items[0]->value;
    }

getResource()

getResource

(

)

Get annotation dictionary

Definition at line 53 of file Annotation.php.

    {
        return $this->_annotationDictionary;
    }

getRight()

getRight

(

)

Get right edge of the annotation rectangle.

Returns

float

Definition at line 121 of file Annotation.php.

                               {
        return $this->_annotationDictionary->Rect->items[2]->value;
    }

getText()

getText

(

)

Return text to be displayed for the annotation or, if this type of annotation does not display text, an alternate description of the annotation’s contents in human-readable form.

Returns

string

Definition at line 154 of file Annotation.php.

                              {
        if ($this->_annotationDictionary->Contents === null) {
            return '';
        }

        return $this->_annotationDictionary->Contents->value;
    }

getTop()

getTop

(

)

Get top edge of the annotation rectangle.

Returns

float

Definition at line 99 of file Annotation.php.

                             {
        return $this->_annotationDictionary->Rect->items[3]->value;
    }

load()

static load ( Zend_Pdf_Element  $resource )

static

Load Annotation object from a specified resource

Todo:

implementation

Definition at line 226 of file Annotation.php.

    {
    }

setBottom()

setBottom

(

$bottom

)

Set bottom edge of the annotation rectangle.

Parameters

float

$bottom

Returns

Zend_Pdf_Annotation

Definition at line 65 of file Annotation.php.

                                       {
        $this->_annotationDictionary->Rect->items[1]->touch();
        $this->_annotationDictionary->Rect->items[1]->value = $bottom;

        return $this;
    }

setLeft()

setLeft

(

$left

)

Set left edge of the annotation rectangle.

Parameters

float

$left

Returns

Zend_Pdf_Annotation

Definition at line 131 of file Annotation.php.

                                   {
        $this->_annotationDictionary->Rect->items[0]->touch();
        $this->_annotationDictionary->Rect->items[0]->value = $left;

        return $this;
    }

setRight()

setRight

(

$right

)

Set right edge of the annotation rectangle.

Parameters

float

$right

Returns

Zend_Pdf_Annotation

Definition at line 109 of file Annotation.php.

                                     {
        $this->_annotationDictionary->Rect->items[2]->touch();
        $this->_annotationDictionary->Rect->items[2]->value = $right;

        return $this;
    }

setText()

setText

(

$text

)

Set text to be displayed for the annotation or, if this type of annotation does not display text, an alternate description of the annotation’s contents in human-readable form.

Parameters

string

$text

Returns

Zend_Pdf_Annotation

Definition at line 170 of file Annotation.php.

                                   {
        #require_once 'Zend/Pdf/Element/String.php';

        if ($this->_annotationDictionary->Contents === null) {
            $this->_annotationDictionary->touch();
            $this->_annotationDictionary->Contents = new Zend_Pdf_Element_String($text);
        } else {
            $this->_annotationDictionary->Contents->touch();
            $this->_annotationDictionary->Contents->value = new Zend_Pdf_Element_String($text);
        }

        return $this;
    }

setTop()

setTop

(

$top

)

Set top edge of the annotation rectangle.

Parameters

float

$top

Returns

Zend_Pdf_Annotation

Definition at line 87 of file Annotation.php.

                                 {
        $this->_annotationDictionary->Rect->items[3]->touch();
        $this->_annotationDictionary->Rect->items[3]->value = $top;

        return $this;
    }

Field Documentation

$_annotationDictionary

$_annotationDictionary

protected

Definition at line 45 of file Annotation.php.

---

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

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