forked from zendframework/ZendPdf
/
Uri.php
159 lines (144 loc) · 4.93 KB
/
Uri.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
<?php
/**
* Zend Framework
*
* LICENSE
*
* This source file is subject to the new BSD license that is bundled
* with this package in the file LICENSE.txt.
* It is also available through the world-wide-web at this URL:
* http://framework.zend.com/license/new-bsd
* If you did not receive a copy of the license and are unable to
* obtain it through the world-wide-web, please send an email
* to license@zend.com so we can send you a copy immediately.
*
* @category Zend
* @package Zend_PDF
* @subpackage Zend_PDF_Action
* @copyright Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
*/
namespace Zend\Pdf\Action;
use Zend\Pdf\Exception;
use Zend\Pdf;
use Zend\Pdf\InternalType;
/**
* PDF 'Resolve a uniform resource identifier' action
*
* A URI action causes a URI to be resolved.
*
* @package Zend_PDF
* @subpackage Zend_PDF_Action
* @copyright Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
*/
class Uri extends AbstractAction
{
/**
* Object constructor
*
* @param \Zend\Pdf\InternalType\DictionaryObject $dictionary
* @param SplObjectStorage $processedActions list of already processed action dictionaries,
* used to avoid cyclic references
* @throws \Zend\Pdf\Exception
*/
public function __construct(InternalType\AbstractTypeObject $dictionary, \SplObjectStorage $processedActions)
{
parent::__construct($dictionary, $processedActions);
if ($dictionary->URI === null) {
throw new Exception\CorruptedPdfException('URI action dictionary entry is required');
}
}
/**
* Validate URI
*
* @param string $uri
* @return true
* @throws \Zend\Pdf\Exception
*/
protected static function _validateUri($uri)
{
$scheme = parse_url((string)$uri, PHP_URL_SCHEME);
if ($scheme === false || $scheme === null) {
throw new Exception\InvalidArgumentException('Invalid URI');
}
}
/**
* Create new \Zend\Pdf\Action\Uri object using specified uri
*
* @param string $uri The URI to resolve, encoded in 7-bit ASCII
* @param boolean $isMap A flag specifying whether to track the mouse position when the URI is resolved
* @return \Zend\Pdf\Action\Uri
*/
public static function create($uri, $isMap = false)
{
self::_validateUri($uri);
$dictionary = new InternalType\DictionaryObject();
$dictionary->Type = new InternalType\NameObject('Action');
$dictionary->S = new InternalType\NameObject('URI');
$dictionary->Next = null;
$dictionary->URI = new InternalType\StringObject($uri);
if ($isMap) {
$dictionary->IsMap = new InternalType\BooleanObject(true);
}
return new self($dictionary, new \SplObjectStorage());
}
/**
* Set URI to resolve
*
* @param string $uri The uri to resolve, encoded in 7-bit ASCII.
* @return \Zend\Pdf\Action\Uri
*/
public function setUri($uri)
{
$this->_validateUri($uri);
$this->_actionDictionary->touch();
$this->_actionDictionary->URI = new InternalType\StringObject($uri);
return $this;
}
/**
* Get URI to resolve
*
* @return string
*/
public function getUri()
{
return $this->_actionDictionary->URI->value;
}
/**
* Set IsMap property
*
* If the IsMap flag is true and the user has triggered the URI action by clicking
* an annotation, the coordinates of the mouse position at the time the action is
* performed should be transformed from device space to user space and then offset
* relative to the upper-left corner of the annotation rectangle.
*
* @param boolean $isMap A flag specifying whether to track the mouse position when the URI is resolved
* @return \Zend\Pdf\Action\Uri
*/
public function setIsMap($isMap)
{
$this->_actionDictionary->touch();
if ($isMap) {
$this->_actionDictionary->IsMap = new InternalType\BooleanObject(true);
} else {
$this->_actionDictionary->IsMap = null;
}
return $this;
}
/**
* Get IsMap property
*
* If the IsMap flag is true and the user has triggered the URI action by clicking
* an annotation, the coordinates of the mouse position at the time the action is
* performed should be transformed from device space to user space and then offset
* relative to the upper-left corner of the annotation rectangle.
*
* @return boolean
*/
public function getIsMap()
{
return $this->_actionDictionary->IsMap !== null &&
$this->_actionDictionary->IsMap->value;
}
}