library/Zend/Feed/Reader/EntryInterface.php

   1 <?php
   2 /**
   3  * Zend Framework
   4  *
   5  * LICENSE
   6  *
   7  * This source file is subject to the new BSD license that is bundled
   8  * with this package in the file LICENSE.txt.
   9  * It is also available through the world-wide-web at this URL:
  10  * http://framework.zend.com/license/new-bsd
  11  * If you did not receive a copy of the license and are unable to
  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.
  14  *
  15  * @category   Zend
  16  * @package    Zend_Feed_Reader
  17  * @copyright  Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
  18  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  19  * @version    $Id: EntryInterface.php 16953 2009-07-22 11:57:25Z padraic $
  20  */
  21
  22 /**
  23  * @category   Zend
  24  * @package    Zend_Feed_Reader
  25  * @copyright  Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
  26  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  27  */
  28 interface Zend_Feed_Reader_EntryInterface
  29 {
  30     /**
  31      * Get the specified author
  32      *
  33      * @param  int $index
  34      * @return string|null
  35      */
  36     public function getAuthor($index = 0);
  37
  38     /**
  39      * Get an array with feed authors
  40      *
  41      * @return array
  42      */
  43     public function getAuthors();
  44
  45     /**
  46      * Get the entry content
  47      *
  48      * @return string
  49      */
  50     public function getContent();
  51
  52     /**
  53      * Get the entry creation date
  54      *
  55      * @return string
  56      */
  57     public function getDateCreated();
  58
  59     /**
  60      * Get the entry modification date
  61      *
  62      * @return string
  63      */
  64     public function getDateModified();
  65
  66     /**
  67      * Get the entry description
  68      *
  69      * @return string
  70      */
  71     public function getDescription();
  72
  73     /**
  74      * Get the entry enclosure
  75      *
  76      * @return stdClass
  77      */
  78     public function getEnclosure();
  79
  80     /**
  81      * Get the entry ID
  82      *
  83      * @return string
  84      */
  85     public function getId();
  86
  87     /**
  88      * Get a specific link
  89      *
  90      * @param  int $index
  91      * @return string
  92      */
  93     public function getLink($index = 0);
  94
  95     /**
  96      * Get all links
  97      *
  98      * @return array
  99      */
 100     public function getLinks();
 101
 102     /**
 103      * Get a permalink to the entry
 104      *
 105      * @return string
 106      */
 107     public function getPermalink();
 108
 109     /**
 110      * Get the entry title
 111      *
 112      * @return string
 113      */
 114     public function getTitle();
 115
 116     /**
 117      * Get the number of comments/replies for current entry
 118      *
 119      * @return integer
 120      */
 121     public function getCommentCount();
 122
 123     /**
 124      * Returns a URI pointing to the HTML page where comments can be made on this entry
 125      *
 126      * @return string
 127      */
 128     public function getCommentLink();
 129
 130     /**
 131      * Returns a URI pointing to a feed of all comments for this entry
 132      *
 133      * @return string
 134      */
 135     public function getCommentFeedLink();
 136 }