12 * obtain it through the world-wide-web, please send an email |
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. |
13 * to license@zend.com so we can send you a copy immediately. |
14 * |
14 * |
15 * @category Zend |
15 * @category Zend |
16 * @package Zend_Feed_Writer |
16 * @package Zend_Feed_Writer |
17 * @copyright Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com) |
17 * @copyright Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com) |
18 * @license http://framework.zend.com/license/new-bsd New BSD License |
18 * @license http://framework.zend.com/license/new-bsd New BSD License |
19 * @version $Id: RendererInterface.php 20096 2010-01-06 02:05:09Z bkarwin $ |
19 * @version $Id: RendererInterface.php 24593 2012-01-05 20:35:02Z matthew $ |
20 */ |
20 */ |
21 |
21 |
22 /** |
22 /** |
23 * @category Zend |
23 * @category Zend |
24 * @package Zend_Feed_Writer |
24 * @package Zend_Feed_Writer |
25 * @copyright Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com) |
25 * @copyright Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com) |
26 * @license http://framework.zend.com/license/new-bsd New BSD License |
26 * @license http://framework.zend.com/license/new-bsd New BSD License |
27 */ |
27 */ |
28 interface Zend_Feed_Writer_Renderer_RendererInterface |
28 interface Zend_Feed_Writer_Renderer_RendererInterface |
29 { |
29 { |
30 /** |
30 /** |
31 * Render feed/entry |
31 * Render feed/entry |
32 * |
32 * |
33 * @return void |
33 * @return void |
34 */ |
34 */ |
35 public function render(); |
35 public function render(); |
36 |
36 |
37 /** |
37 /** |
38 * Save feed and/or entry to XML and return string |
38 * Save feed and/or entry to XML and return string |
39 * |
39 * |
40 * @return string |
40 * @return string |
41 */ |
41 */ |
42 public function saveXml(); |
42 public function saveXml(); |
43 |
43 |
44 /** |
44 /** |
45 * Get DOM document |
45 * Get DOM document |
46 * |
46 * |
47 * @return DOMDocument |
47 * @return DOMDocument |
48 */ |
48 */ |
49 public function getDomDocument(); |
49 public function getDomDocument(); |
50 |
50 |
51 /** |
51 /** |
52 * Get document element from DOM |
52 * Get document element from DOM |
53 * |
53 * |
54 * @return DOMElement |
54 * @return DOMElement |
55 */ |
55 */ |
56 public function getElement(); |
56 public function getElement(); |
57 |
57 |
58 /** |
58 /** |
59 * Get data container containing feed items |
59 * Get data container containing feed items |
60 * |
60 * |
61 * @return mixed |
61 * @return mixed |
62 */ |
62 */ |
63 public function getDataContainer(); |
63 public function getDataContainer(); |
64 |
64 |
65 /** |
65 /** |
66 * Should exceptions be ignored? |
66 * Should exceptions be ignored? |
67 * |
67 * |
68 * @return mixed |
68 * @return mixed |
69 */ |
69 */ |
70 public function ignoreExceptions(); |
70 public function ignoreExceptions(); |
71 |
71 |
72 /** |
72 /** |
73 * Get list of thrown exceptions |
73 * Get list of thrown exceptions |
74 * |
74 * |
75 * @return array |
75 * @return array |
76 */ |
76 */ |
77 public function getExceptions(); |
77 public function getExceptions(); |
78 |
78 |
79 /** |
79 /** |
80 * Set the current feed type being exported to "rss" or "atom". This allows |
80 * Set the current feed type being exported to "rss" or "atom". This allows |
81 * other objects to gracefully choose whether to execute or not, depending |
81 * other objects to gracefully choose whether to execute or not, depending |
82 * on their appropriateness for the current type, e.g. renderers. |
82 * on their appropriateness for the current type, e.g. renderers. |
83 * |
83 * |
84 * @param string $type |
84 * @param string $type |
85 */ |
85 */ |
86 public function setType($type); |
86 public function setType($type); |
87 |
87 |
88 /** |
88 /** |
89 * Retrieve the current or last feed type exported. |
89 * Retrieve the current or last feed type exported. |
90 * |
90 * |
91 * @return string Value will be "rss" or "atom" |
91 * @return string Value will be "rss" or "atom" |
92 */ |
92 */ |
93 public function getType(); |
93 public function getType(); |
94 |
94 |
95 /** |
95 /** |
96 * Sets the absolute root element for the XML feed being generated. This |
96 * Sets the absolute root element for the XML feed being generated. This |
97 * helps simplify the appending of namespace declarations, but also ensures |
97 * helps simplify the appending of namespace declarations, but also ensures |
98 * namespaces are added to the root element - not scattered across the entire |
98 * namespaces are added to the root element - not scattered across the entire |
99 * XML file - may assist namespace unsafe parsers and looks pretty ;). |
99 * XML file - may assist namespace unsafe parsers and looks pretty ;). |
100 * |
100 * |
101 * @param DOMElement $root |
101 * @param DOMElement $root |
102 */ |
102 */ |
103 public function setRootElement(DOMElement $root); |
103 public function setRootElement(DOMElement $root); |
104 |
104 |
105 /** |
105 /** |
106 * Retrieve the absolute root element for the XML feed being generated. |
106 * Retrieve the absolute root element for the XML feed being generated. |
107 * |
107 * |
108 * @return DOMElement |
108 * @return DOMElement |
109 */ |
109 */ |