aleph1.co.uk Git - yaffs-website/blob - vendor/zendframework/zend-feed/src/Reader/Entry/EntryInterface.php

   1 <?php
   2 /**
   3  * Zend Framework (http://framework.zend.com/)
   4  *
   5  * @link      http://github.com/zendframework/zf2 for the canonical source repository
   6  * @copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
   7  * @license   http://framework.zend.com/license/new-bsd New BSD License
   8  */
   9
  10 namespace Zend\Feed\Reader\Entry;
  11
  12 use Zend\Feed\Reader\Collection\Category;
  13
  14 interface EntryInterface
  15 {
  16     /**
  17      * Get the specified author
  18      *
  19      * @param  int $index
  20      * @return string|null
  21      */
  22     public function getAuthor($index = 0);
  23
  24     /**
  25      * Get an array with feed authors
  26      *
  27      * @return array
  28      */
  29     public function getAuthors();
  30
  31     /**
  32      * Get the entry content
  33      *
  34      * @return string
  35      */
  36     public function getContent();
  37
  38     /**
  39      * Get the entry creation date
  40      *
  41      * @return \DateTime
  42      */
  43     public function getDateCreated();
  44
  45     /**
  46      * Get the entry modification date
  47      *
  48      * @return \DateTime
  49      */
  50     public function getDateModified();
  51
  52     /**
  53      * Get the entry description
  54      *
  55      * @return string
  56      */
  57     public function getDescription();
  58
  59     /**
  60      * Get the entry enclosure
  61      *
  62      * @return \stdClass
  63      */
  64     public function getEnclosure();
  65
  66     /**
  67      * Get the entry ID
  68      *
  69      * @return string
  70      */
  71     public function getId();
  72
  73     /**
  74      * Get a specific link
  75      *
  76      * @param  int $index
  77      * @return string
  78      */
  79     public function getLink($index = 0);
  80
  81     /**
  82      * Get all links
  83      *
  84      * @return array
  85      */
  86     public function getLinks();
  87
  88     /**
  89      * Get a permalink to the entry
  90      *
  91      * @return string
  92      */
  93     public function getPermalink();
  94
  95     /**
  96      * Get the entry title
  97      *
  98      * @return string
  99      */
 100     public function getTitle();
 101
 102     /**
 103      * Get the number of comments/replies for current entry
 104      *
 105      * @return int
 106      */
 107     public function getCommentCount();
 108
 109     /**
 110      * Returns a URI pointing to the HTML page where comments can be made on this entry
 111      *
 112      * @return string
 113      */
 114     public function getCommentLink();
 115
 116     /**
 117      * Returns a URI pointing to a feed of all comments for this entry
 118      *
 119      * @return string
 120      */
 121     public function getCommentFeedLink();
 122
 123     /**
 124      * Get all categories
 125      *
 126      * @return Category
 127      */
 128     public function getCategories();
 129 }