Chris@0
|
1 <?php
|
Chris@0
|
2 /**
|
Chris@0
|
3 * Zend Framework (http://framework.zend.com/)
|
Chris@0
|
4 *
|
Chris@0
|
5 * @link http://github.com/zendframework/zf2 for the canonical source repository
|
Chris@0
|
6 * @copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
|
Chris@0
|
7 * @license http://framework.zend.com/license/new-bsd New BSD License
|
Chris@0
|
8 */
|
Chris@0
|
9
|
Chris@0
|
10 namespace Zend\Feed\Reader\Feed;
|
Chris@0
|
11
|
Chris@0
|
12 use Countable;
|
Chris@0
|
13 use Iterator;
|
Chris@0
|
14
|
Chris@0
|
15 /**
|
Chris@0
|
16 */
|
Chris@0
|
17 interface FeedInterface extends Iterator, Countable
|
Chris@0
|
18 {
|
Chris@0
|
19 /**
|
Chris@0
|
20 * Get a single author
|
Chris@0
|
21 *
|
Chris@0
|
22 * @param int $index
|
Chris@0
|
23 * @return string|null
|
Chris@0
|
24 */
|
Chris@0
|
25 public function getAuthor($index = 0);
|
Chris@0
|
26
|
Chris@0
|
27 /**
|
Chris@0
|
28 * Get an array with feed authors
|
Chris@0
|
29 *
|
Chris@0
|
30 * @return array
|
Chris@0
|
31 */
|
Chris@0
|
32 public function getAuthors();
|
Chris@0
|
33
|
Chris@0
|
34 /**
|
Chris@0
|
35 * Get the copyright entry
|
Chris@0
|
36 *
|
Chris@0
|
37 * @return string|null
|
Chris@0
|
38 */
|
Chris@0
|
39 public function getCopyright();
|
Chris@0
|
40
|
Chris@0
|
41 /**
|
Chris@0
|
42 * Get the feed creation date
|
Chris@0
|
43 *
|
Chris@12
|
44 * @return \DateTime|null
|
Chris@0
|
45 */
|
Chris@0
|
46 public function getDateCreated();
|
Chris@0
|
47
|
Chris@0
|
48 /**
|
Chris@0
|
49 * Get the feed modification date
|
Chris@0
|
50 *
|
Chris@12
|
51 * @return \DateTime|null
|
Chris@0
|
52 */
|
Chris@0
|
53 public function getDateModified();
|
Chris@0
|
54
|
Chris@0
|
55 /**
|
Chris@0
|
56 * Get the feed description
|
Chris@0
|
57 *
|
Chris@0
|
58 * @return string|null
|
Chris@0
|
59 */
|
Chris@0
|
60 public function getDescription();
|
Chris@0
|
61
|
Chris@0
|
62 /**
|
Chris@0
|
63 * Get the feed generator entry
|
Chris@0
|
64 *
|
Chris@0
|
65 * @return string|null
|
Chris@0
|
66 */
|
Chris@0
|
67 public function getGenerator();
|
Chris@0
|
68
|
Chris@0
|
69 /**
|
Chris@0
|
70 * Get the feed ID
|
Chris@0
|
71 *
|
Chris@0
|
72 * @return string|null
|
Chris@0
|
73 */
|
Chris@0
|
74 public function getId();
|
Chris@0
|
75
|
Chris@0
|
76 /**
|
Chris@0
|
77 * Get the feed language
|
Chris@0
|
78 *
|
Chris@0
|
79 * @return string|null
|
Chris@0
|
80 */
|
Chris@0
|
81 public function getLanguage();
|
Chris@0
|
82
|
Chris@0
|
83 /**
|
Chris@0
|
84 * Get a link to the HTML source
|
Chris@0
|
85 *
|
Chris@0
|
86 * @return string|null
|
Chris@0
|
87 */
|
Chris@0
|
88 public function getLink();
|
Chris@0
|
89
|
Chris@0
|
90 /**
|
Chris@0
|
91 * Get a link to the XML feed
|
Chris@0
|
92 *
|
Chris@0
|
93 * @return string|null
|
Chris@0
|
94 */
|
Chris@0
|
95 public function getFeedLink();
|
Chris@0
|
96
|
Chris@0
|
97 /**
|
Chris@0
|
98 * Get the feed title
|
Chris@0
|
99 *
|
Chris@0
|
100 * @return string|null
|
Chris@0
|
101 */
|
Chris@0
|
102 public function getTitle();
|
Chris@0
|
103
|
Chris@0
|
104 /**
|
Chris@0
|
105 * Get all categories
|
Chris@0
|
106 *
|
Chris@0
|
107 * @return \Zend\Feed\Reader\Collection\Category
|
Chris@0
|
108 */
|
Chris@0
|
109 public function getCategories();
|
Chris@0
|
110 }
|