library/Zend/Pdf/Annotation/Link.php

   1 <?php
   2 /**
   3  * Zend Framework
   4  *
   5  * LICENSE
   6  *
   7  * This source file is subject to the new BSD license that is bundled
   8  * with this package in the file LICENSE.txt.
   9  * It is also available through the world-wide-web at this URL:
  10  * http://framework.zend.com/license/new-bsd
  11  * If you did not receive a copy of the license and are unable to
  12  * obtain it through the world-wide-web, please send an email
  13  * to license@zend.com so we can send you a copy immediately.
  14  *
  15  * @category   Zend
  16  * @package    Zend_Pdf
  17  * @subpackage Annotation
  18  * @copyright  Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
  19  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  20  * @version    $Id:
  21  */
  22
  23 /** Zend_Pdf_Annotation */
  24 require_once 'Zend/Pdf/Annotation.php';
  25
  26 /** Zend_Pdf_Destination */
  27 require_once 'Zend/Pdf/Destination.php';
  28
  29
  30 /**
  31  * A link annotation represents either a hypertext link to a destination elsewhere in
  32  * the document or an action to be performed.
  33  *
  34  * Only destinations are used now since only GoTo action can be created by user
  35  * in current implementation.
  36  *
  37  * @package    Zend_Pdf
  38  * @subpackage Annotation
  39  * @copyright  Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
  40  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  41  */
  42 class Zend_Pdf_Annotation_Link extends Zend_Pdf_Annotation
  43 {
  44     /**
  45      * Annotation object constructor
  46      *
  47      * @throws Zend_Pdf_Exception
  48      */
  49     public function __construct(Zend_Pdf_Element $annotationDictionary)
  50     {
  51         if ($annotationDictionary->getType() != Zend_Pdf_Element::TYPE_DICTIONARY) {
  52             require_once 'Zend/Pdf/Exception.php';
  53             throw new Zend_Pdf_Exception('Annotation dictionary resource has to be a dictionary.');
  54         }
  55
  56         if ($annotationDictionary->Subtype === null  ||
  57             $annotationDictionary->Subtype->getType() != Zend_Pdf_Element::TYPE_NAME  ||
  58             $annotationDictionary->Subtype->value != 'Link') {
  59             require_once 'Zend/Pdf/Exception.php';
  60             throw new Zend_Pdf_Exception('Subtype => Link entry is requires');
  61         }
  62
  63         parent::__construct($annotationDictionary);
  64     }
  65
  66     /**
  67      * Create link annotation object
  68      *
  69      * @param float $x1
  70      * @param float $y1
  71      * @param float $x2
  72      * @param float $y2
  73      * @param Zend_Pdf_Target|string $target
  74      * @return Zend_Pdf_Annotation_Link
  75      */
  76     public static function create($x1, $y1, $x2, $y2, $target)
  77     {
  78         if (is_string($target)) {
  79             require_once 'Zend/Pdf/Destination/Named.php';
  80             $destination = Zend_Pdf_Destination_Named::create($target);
  81         }
  82         if (!$target instanceof Zend_Pdf_Target) {
  83             require_once 'Zend/Pdf/Exception.php';
  84             throw new Zend_Pdf_Exception('$target parameter must be a Zend_Pdf_Target object or a string.');
  85         }
  86
  87         $annotationDictionary = new Zend_Pdf_Element_Dictionary();
  88
  89         $annotationDictionary->Type    = new Zend_Pdf_Element_Name('Annot');
  90         $annotationDictionary->Subtype = new Zend_Pdf_Element_Name('Link');
  91
  92         $rectangle = new Zend_Pdf_Element_Array();
  93         $rectangle->items[] = new Zend_Pdf_Element_Numeric($x1);
  94         $rectangle->items[] = new Zend_Pdf_Element_Numeric($y1);
  95         $rectangle->items[] = new Zend_Pdf_Element_Numeric($x2);
  96         $rectangle->items[] = new Zend_Pdf_Element_Numeric($y2);
  97         $annotationDictionary->Rect = $rectangle;
  98
  99         if ($target instanceof Zend_Pdf_Destination) {
 100             $annotationDictionary->Dest = $target->getResource();
 101         } else {
 102             $annotationDictionary->A = $target->getResource();
 103         }
 104
 105         return new Zend_Pdf_Annotation_Link($annotationDictionary);
 106     }
 107
 108     /**
 109      * Set link annotation destination
 110      *
 111      * @param Zend_Pdf_Target|string $target
 112      * @return Zend_Pdf_Annotation_Link
 113      */
 114     public function setDestination($target)
 115     {
 116         if (is_string($target)) {
 117             require_once 'Zend/Pdf/Destination/Named.php';
 118             $destination = Zend_Pdf_Destination_Named::create($target);
 119         }
 120         if (!$target instanceof Zend_Pdf_Target) {
 121             require_once 'Zend/Pdf/Exception.php';
 122             throw new Zend_Pdf_Exception('$target parameter must be a Zend_Pdf_Target object or a string.');
 123         }
 124
 125         $this->_annotationDictionary->touch();
 126         $this->_annotationDictionary->Dest = $destination->getResource();
 127         if ($target instanceof Zend_Pdf_Destination) {
 128             $this->_annotationDictionary->Dest = $target->getResource();
 129             $this->_annotationDictionary->A    = null;
 130         } else {
 131             $this->_annotationDictionary->Dest = null;
 132             $this->_annotationDictionary->A    = $target->getResource();
 133         }
 134
 135         return $this;
 136     }
 137
 138     /**
 139      * Get link annotation destination
 140      *
 141      * @return Zend_Pdf_Target|null
 142      */
 143     public function getDestination()
 144     {
 145         if ($this->_annotationDictionary->Dest === null  &&
 146             $this->_annotationDictionary->A    === null) {
 147             return null;
 148         }
 149
 150         if ($this->_annotationDictionary->Dest !== null) {
 151             return Zend_Pdf_Destination::load($this->_annotationDictionary->Dest);
 152         } else {
 153             return Zend_Pdf_Action::load($this->_annotationDictionary->A);
 154         }
 155     }
 156 }