Zend_Pdf_Annotation_FileAttachment Class Reference

Inheritance diagram for Zend_Pdf_Annotation_FileAttachment:

Public Member Functions
	__construct (Zend_Pdf_Element $annotationDictionary)
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, $fileSpecification)
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 44 of file FileAttachment.php.

Constructor & Destructor Documentation

__construct()

__construct

(

Zend_Pdf_Element

$annotationDictionary

)

Annotation object constructor

Exceptions

Zend_Pdf_Exception

Definition at line 51 of file FileAttachment.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 != 'FileAttachment') {
            #require_once 'Zend/Pdf/Exception.php';
            throw new Zend_Pdf_Exception('Subtype => FileAttachment entry is requires');
        }

        parent::__construct($annotationDictionary);
    }

Member Function Documentation

create()

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

static

Create link annotation object

Parameters

float	$x1
float	$y1
float	$x2
float	$y2
string	$fileSpecification

Returns

Zend_Pdf_Annotation_FileAttachment

Definition at line 78 of file FileAttachment.php.

    {
        $annotationDictionary = new Zend_Pdf_Element_Dictionary();

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

        $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;

        $fsDictionary = new Zend_Pdf_Element_Dictionary();
        $fsDictionary->Type = new Zend_Pdf_Element_Name('Filespec');
        $fsDictionary->F    = new Zend_Pdf_Element_String($fileSpecification);

        $annotationDictionary->FS = $fsDictionary;


        return new Zend_Pdf_Annotation_FileAttachment($annotationDictionary);
    }

---

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

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