annotate vendor/zendframework/zend-feed/src/Reader/Entry/EntryInterface.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents af1871eacc83
children
rev   line source
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\Entry;
Chris@0 11
Chris@0 12 use Zend\Feed\Reader\Collection\Category;
Chris@0 13
Chris@0 14 interface EntryInterface
Chris@0 15 {
Chris@0 16 /**
Chris@0 17 * Get the specified author
Chris@0 18 *
Chris@0 19 * @param int $index
Chris@18 20 * @return array<string, string>|null
Chris@0 21 */
Chris@0 22 public function getAuthor($index = 0);
Chris@0 23
Chris@0 24 /**
Chris@0 25 * Get an array with feed authors
Chris@0 26 *
Chris@0 27 * @return array
Chris@0 28 */
Chris@0 29 public function getAuthors();
Chris@0 30
Chris@0 31 /**
Chris@0 32 * Get the entry content
Chris@0 33 *
Chris@0 34 * @return string
Chris@0 35 */
Chris@0 36 public function getContent();
Chris@0 37
Chris@0 38 /**
Chris@0 39 * Get the entry creation date
Chris@0 40 *
Chris@0 41 * @return \DateTime
Chris@0 42 */
Chris@0 43 public function getDateCreated();
Chris@0 44
Chris@0 45 /**
Chris@0 46 * Get the entry modification date
Chris@0 47 *
Chris@0 48 * @return \DateTime
Chris@0 49 */
Chris@0 50 public function getDateModified();
Chris@0 51
Chris@0 52 /**
Chris@0 53 * Get the entry description
Chris@0 54 *
Chris@0 55 * @return string
Chris@0 56 */
Chris@0 57 public function getDescription();
Chris@0 58
Chris@0 59 /**
Chris@0 60 * Get the entry enclosure
Chris@0 61 *
Chris@0 62 * @return \stdClass
Chris@0 63 */
Chris@0 64 public function getEnclosure();
Chris@0 65
Chris@0 66 /**
Chris@0 67 * Get the entry ID
Chris@0 68 *
Chris@0 69 * @return string
Chris@0 70 */
Chris@0 71 public function getId();
Chris@0 72
Chris@0 73 /**
Chris@0 74 * Get a specific link
Chris@0 75 *
Chris@0 76 * @param int $index
Chris@0 77 * @return string
Chris@0 78 */
Chris@0 79 public function getLink($index = 0);
Chris@0 80
Chris@0 81 /**
Chris@0 82 * Get all links
Chris@0 83 *
Chris@0 84 * @return array
Chris@0 85 */
Chris@0 86 public function getLinks();
Chris@0 87
Chris@0 88 /**
Chris@0 89 * Get a permalink to the entry
Chris@0 90 *
Chris@0 91 * @return string
Chris@0 92 */
Chris@0 93 public function getPermalink();
Chris@0 94
Chris@0 95 /**
Chris@0 96 * Get the entry title
Chris@0 97 *
Chris@0 98 * @return string
Chris@0 99 */
Chris@0 100 public function getTitle();
Chris@0 101
Chris@0 102 /**
Chris@0 103 * Get the number of comments/replies for current entry
Chris@0 104 *
Chris@0 105 * @return int
Chris@0 106 */
Chris@0 107 public function getCommentCount();
Chris@0 108
Chris@0 109 /**
Chris@0 110 * Returns a URI pointing to the HTML page where comments can be made on this entry
Chris@0 111 *
Chris@0 112 * @return string
Chris@0 113 */
Chris@0 114 public function getCommentLink();
Chris@0 115
Chris@0 116 /**
Chris@0 117 * Returns a URI pointing to a feed of all comments for this entry
Chris@0 118 *
Chris@0 119 * @return string
Chris@0 120 */
Chris@0 121 public function getCommentFeedLink();
Chris@0 122
Chris@0 123 /**
Chris@0 124 * Get all categories
Chris@0 125 *
Chris@0 126 * @return Category
Chris@0 127 */
Chris@0 128 public function getCategories();
Chris@0 129 }