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
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
<?php
/**
* Zend Framework (http://framework.zend.com/)
*
* @link http://github.com/zendframework/zf2 for the canonical source repository
* @copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
*/
namespace Zend\View\Resolver;
use ArrayIterator;
use IteratorAggregate;
use Traversable;
use Zend\Stdlib\ArrayUtils;
use Zend\View\Exception;
use Zend\View\Renderer\RendererInterface as Renderer;
class TemplateMapResolver implements IteratorAggregate, ResolverInterface
{
/**
* @var array
*/
protected $map = [];
/**
* Constructor
*
* Instantiate and optionally populate template map.
*
* @param array|Traversable $map
*/
public function __construct($map = [])
{
$this->setMap($map);
}
/**
* IteratorAggregate: return internal iterator
*
* @return Traversable
*/
public function getIterator()
{
return new ArrayIterator($this->map);
}
/**
* Set (overwrite) template map
*
* Maps should be arrays or Traversable objects with name => path pairs
*
* @param array|Traversable $map
* @throws Exception\InvalidArgumentException
* @return TemplateMapResolver
*/
public function setMap($map)
{
if (! is_array($map) && ! $map instanceof Traversable) {
throw new Exception\InvalidArgumentException(sprintf(
'%s: expects an array or Traversable, received "%s"',
__METHOD__,
(is_object($map) ? get_class($map) : gettype($map))
));
}
if ($map instanceof Traversable) {
$map = ArrayUtils::iteratorToArray($map);
}
$this->map = $map;
return $this;
}
/**
* Add an entry to the map
*
* @param string|array|Traversable $nameOrMap
* @param null|string $path
* @throws Exception\InvalidArgumentException
* @return TemplateMapResolver
*/
public function add($nameOrMap, $path = null)
{
if (is_array($nameOrMap) || $nameOrMap instanceof Traversable) {
$this->merge($nameOrMap);
return $this;
}
if (! is_string($nameOrMap)) {
throw new Exception\InvalidArgumentException(sprintf(
'%s: expects a string, array, or Traversable for the first argument; received "%s"',
__METHOD__,
(is_object($nameOrMap) ? get_class($nameOrMap) : gettype($nameOrMap))
));
}
if (empty($path)) {
if (isset($this->map[$nameOrMap])) {
unset($this->map[$nameOrMap]);
}
return $this;
}
$this->map[$nameOrMap] = $path;
return $this;
}
/**
* Merge internal map with provided map
*
* @param array|Traversable $map
* @throws Exception\InvalidArgumentException
* @return TemplateMapResolver
*/
public function merge($map)
{
if (! is_array($map) && ! $map instanceof Traversable) {
throw new Exception\InvalidArgumentException(sprintf(
'%s: expects an array or Traversable, received "%s"',
__METHOD__,
(is_object($map) ? get_class($map) : gettype($map))
));
}
if ($map instanceof Traversable) {
$map = ArrayUtils::iteratorToArray($map);
}
$this->map = array_replace_recursive($this->map, $map);
return $this;
}
/**
* Does the resolver contain an entry for the given name?
*
* @param string $name
* @return bool
*/
public function has($name)
{
return array_key_exists($name, $this->map);
}
/**
* Retrieve a template path by name
*
* @param string $name
* @return false|string
* @throws Exception\DomainException if no entry exists
*/
public function get($name)
{
if (! $this->has($name)) {
return false;
}
return $this->map[$name];
}
/**
* Retrieve the template map
*
* @return array
*/
public function getMap()
{
return $this->map;
}
/**
* Resolve a template/pattern name to a resource the renderer can consume
*
* @param string $name
* @param null|Renderer $renderer
* @return string
*/
public function resolve($name, Renderer $renderer = null)
{
return $this->get($name);
}
}