21d90a64d2812b931711d2c2ed56ac870035eac2
[Packages/TYPO3.CMS.git] / typo3 / sysext / fluid / Classes / Core / ViewHelper / Arguments.php
1 <?php
2 namespace TYPO3\CMS\Fluid\Core\ViewHelper;
3
4 /* *
5 * This script is backported from the TYPO3 Flow package "TYPO3.Fluid". *
6 * *
7 * It is free software; you can redistribute it and/or modify it under *
8 * the terms of the GNU Lesser General Public License, either version 3 *
9 * of the License, or (at your option) any later version. *
10 * *
11 * *
12 * This script is distributed in the hope that it will be useful, but *
13 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHAN- *
14 * TABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser *
15 * General Public License for more details. *
16 * *
17 * You should have received a copy of the GNU Lesser General Public *
18 * License along with the script. *
19 * If not, see http://www.gnu.org/licenses/lgpl.html *
20 * *
21 * The TYPO3 project - inspiring people to share! *
22 * */
23 /**
24 * Arguments list. Wraps an array, but only allows read-only methods on it.
25 * Is available inside every view helper as $this->arguments - and you use it as if it was an array.
26 * However, you can only read, and not write to it.
27 *
28 * @api
29 */
30 class Arguments implements \ArrayAccess {
31
32 /**
33 * Array storing the arguments themselves
34 */
35 protected $arguments = array();
36
37 /**
38 * Constructor.
39 *
40 * @param array $arguments Array of arguments
41 * @api
42 */
43 public function __construct(array $arguments) {
44 $this->arguments = $arguments;
45 }
46
47 /**
48 * Checks if a given key exists in the array
49 *
50 * @param string $key Key to check
51 * @return bool true if exists
52 */
53 public function offsetExists($key) {
54 return array_key_exists($key, $this->arguments);
55 }
56
57 /**
58 * Returns the value to the given key.
59 *
60 * @param string $key Key to get.
61 * @return object associated value
62 */
63 public function offsetGet($key) {
64 if (!array_key_exists($key, $this->arguments)) {
65 return NULL;
66 }
67 return $this->arguments[$key];
68 }
69
70 /**
71 * Throw exception if you try to set a value.
72 *
73 * @param string $key
74 * @param object $value
75 */
76 public function offsetSet($key, $value) {
77 throw new \TYPO3\CMS\Fluid\Core\Exception('Tried to set argument "' . $key . '", but setting arguments is forbidden.', 1236080693);
78 }
79
80 /**
81 * Throw exception if you try to unset a value.
82 *
83 * @param string $key
84 */
85 public function offsetUnset($key) {
86 throw new \TYPO3\CMS\Fluid\Core\Exception('Tried to unset argument "' . $key . '", but setting arguments is forbidden.', 1236080702);
87 }
88
89 /**
90 * Checks if an argument with the specified name exists
91 *
92 * @param string $argumentName Name of the argument to check for
93 * @return bool TRUE if such an argument exists, otherwise FALSE
94 * @see offsetExists()
95 */
96 public function hasArgument($argumentName) {
97 return $this->offsetExists($argumentName) && $this->arguments[$argumentName] !== NULL;
98 }
99
100 }