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
<?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\Renderer;
use Zend\View\Exception;
use Zend\View\Model\FeedModel;
use Zend\View\Model\ModelInterface as Model;
use Zend\View\Resolver\ResolverInterface as Resolver;
/**
* Class for Zend\View\Strategy\FeedStrategy compatible template engine implementations
*/
class FeedRenderer implements RendererInterface
{
/**
* @var Resolver
*/
protected $resolver;
/**
* @var string 'rss' or 'atom'; defaults to 'rss'
*/
protected $feedType = 'rss';
/**
* Return the template engine object, if any
*
* If using a third-party template engine, such as Smarty, patTemplate,
* phplib, etc, return the template engine object. Useful for calling
* methods on these objects, such as for setting filters, modifiers, etc.
*
* @return mixed
*/
public function getEngine()
{
return $this;
}
/**
* Set the resolver used to map a template name to a resource the renderer may consume.
*
* @todo Determine use case for resolvers for feeds
* @param Resolver $resolver
* @return FeedRenderer
*/
public function setResolver(Resolver $resolver)
{
$this->resolver = $resolver;
return $this;
}
/**
* Renders values as JSON
*
* @todo Determine what use case exists for accepting only $nameOrModel
* @param string|Model $nameOrModel The script/resource process, or a view model
* @param null|array|\ArrayAccess $values Values to use during rendering
* @throws Exception\InvalidArgumentException
* @return string The script output.
*/
public function render($nameOrModel, $values = null)
{
if ($nameOrModel instanceof Model) {
// Use case 1: View Model provided
// Non-FeedModel: cast to FeedModel
if (! $nameOrModel instanceof FeedModel) {
$vars = $nameOrModel->getVariables();
$options = $nameOrModel->getOptions();
$type = $this->getFeedType();
if (isset($options['feed_type'])) {
$type = $options['feed_type'];
} else {
$this->setFeedType($type);
}
$nameOrModel = new FeedModel($vars, ['feed_type' => $type]);
}
} elseif (is_string($nameOrModel)) {
// Use case 2: string $nameOrModel + array|Traversable|Feed $values
$nameOrModel = new FeedModel($values, (array) $nameOrModel);
} else {
// Use case 3: failure
throw new Exception\InvalidArgumentException(sprintf(
'%s expects a ViewModel or a string feed type as the first argument; received "%s"',
__METHOD__,
(is_object($nameOrModel) ? get_class($nameOrModel) : gettype($nameOrModel))
));
}
// Get feed and type
$feed = $nameOrModel->getFeed();
$type = $nameOrModel->getFeedType();
if (! $type) {
$type = $this->getFeedType();
} else {
$this->setFeedType($type);
}
// Render feed
return $feed->export($type);
}
/**
* Set feed type ('rss' or 'atom')
*
* @param string $feedType
* @throws Exception\InvalidArgumentException
* @return FeedRenderer
*/
public function setFeedType($feedType)
{
$feedType = strtolower($feedType);
if (! in_array($feedType, ['rss', 'atom'])) {
throw new Exception\InvalidArgumentException(sprintf(
'%s expects a string of either "rss" or "atom"',
__METHOD__
));
}
$this->feedType = $feedType;
return $this;
}
/**
* Get feed type
*
* @return string
*/
public function getFeedType()
{
return $this->feedType;
}
}