diff --git a/src/Reader/AbstractFeed.php b/src/Reader/AbstractFeed.php index 167e2b7c..3417a257 100644 --- a/src/Reader/AbstractFeed.php +++ b/src/Reader/AbstractFeed.php @@ -72,7 +72,7 @@ abstract class AbstractFeed implements Feed\FeedInterface /** * Constructor * - * @param DomDocument The DOM object for the feed's XML + * @param DomDocument $domDocument The DOM object for the feed's XML * @param string $type Feed type */ public function __construct(DOMDocument $domDocument, $type = null) diff --git a/src/Reader/Entry/AbstractEntry.php b/src/Reader/Entry/AbstractEntry.php index 5a21d5e8..db36d31b 100644 --- a/src/Reader/Entry/AbstractEntry.php +++ b/src/Reader/Entry/AbstractEntry.php @@ -39,7 +39,7 @@ abstract class AbstractEntry /** * Entry instance * - * @var Zend_Feed_Entry_Interface + * @var DOMElement */ protected $entry = null; @@ -160,7 +160,7 @@ public function getXpath() * Set the XPath query * * @param DOMXPath $xpath - * @return Zend_Feed_Reader_Entry_EntryAbstract + * @return AbstractEntry */ public function setXpath(DOMXPath $xpath) { @@ -182,7 +182,7 @@ public function getExtensions() * Return an Extension object with the matching name (postfixed with _Entry) * * @param string $name - * @return Zend_Feed_Reader_Extension_EntryAbstract + * @return Reader\Extension\AbstractEntry */ public function getExtension($name) { diff --git a/src/Reader/Entry/EntryInterface.php b/src/Reader/Entry/EntryInterface.php index 4d0fc31d..57a0b2eb 100644 --- a/src/Reader/Entry/EntryInterface.php +++ b/src/Reader/Entry/EntryInterface.php @@ -64,7 +64,7 @@ public function getDescription(); /** * Get the entry enclosure * - * @return stdClass + * @return \stdClass */ public function getEnclosure(); diff --git a/src/Reader/Entry/Rss.php b/src/Reader/Entry/Rss.php index 586a5f6a..ca73049d 100644 --- a/src/Reader/Entry/Rss.php +++ b/src/Reader/Entry/Rss.php @@ -71,7 +71,7 @@ public function __construct(DOMElement $entry, $entryKey, $type = null) /** * Get an author entry * - * @param DOMElement $element + * @param int $index * @return string */ public function getAuthor($index = 0) @@ -185,6 +185,7 @@ public function getDateCreated() /** * Get the entry's date of modification * + * @throws Exception\RuntimeException * @return string */ public function getDateModified() diff --git a/src/Reader/Extension/AbstractEntry.php b/src/Reader/Extension/AbstractEntry.php index e60d2de6..c040f0bd 100644 --- a/src/Reader/Extension/AbstractEntry.php +++ b/src/Reader/Extension/AbstractEntry.php @@ -38,7 +38,7 @@ abstract class AbstractEntry /** * Entry instance * - * @var Zend_Feed_Entry_Abstract + * @var DOMElement */ protected $entry = null; diff --git a/src/Reader/Extension/AbstractFeed.php b/src/Reader/Extension/AbstractFeed.php index 3770fc83..557e114e 100644 --- a/src/Reader/Extension/AbstractFeed.php +++ b/src/Reader/Extension/AbstractFeed.php @@ -166,6 +166,7 @@ public function getXpathPrefix() /** * Set the XPath prefix * + * @param string $prefix * @return void */ public function setXpathPrefix($prefix) diff --git a/src/Reader/Extension/Atom/Entry.php b/src/Reader/Extension/Atom/Entry.php index 5e0dbd2c..31226203 100644 --- a/src/Reader/Extension/Atom/Entry.php +++ b/src/Reader/Extension/Atom/Entry.php @@ -453,6 +453,7 @@ public function getCommentLink() /** * Returns a URI pointing to a feed of all comments for this entry * + * @param string $type * @return string */ public function getCommentFeedLink($type = 'atom') @@ -612,6 +613,8 @@ protected function registerNamespaces() /** * Detect the presence of any Atom namespaces in use + * + * @return string */ protected function getAtomType() { diff --git a/src/Reader/Extension/CreativeCommons/Entry.php b/src/Reader/Extension/CreativeCommons/Entry.php index 551d5f90..77c529a3 100644 --- a/src/Reader/Extension/CreativeCommons/Entry.php +++ b/src/Reader/Extension/CreativeCommons/Entry.php @@ -22,6 +22,7 @@ class Entry extends Extension\AbstractEntry /** * Get the entry license * + * @param int $index * @return string|null */ public function getLicense($index = 0) diff --git a/src/Reader/Extension/CreativeCommons/Feed.php b/src/Reader/Extension/CreativeCommons/Feed.php index dc443fa2..2129c13c 100644 --- a/src/Reader/Extension/CreativeCommons/Feed.php +++ b/src/Reader/Extension/CreativeCommons/Feed.php @@ -22,6 +22,7 @@ class Feed extends Extension\AbstractFeed /** * Get the entry license * + * @param int $index * @return string|null */ public function getLicense($index = 0) diff --git a/src/Reader/Extension/DublinCore/Entry.php b/src/Reader/Extension/DublinCore/Entry.php index beb04c42..f446c25d 100644 --- a/src/Reader/Extension/DublinCore/Entry.php +++ b/src/Reader/Extension/DublinCore/Entry.php @@ -25,7 +25,7 @@ class Entry extends Extension\AbstractEntry /** * Get an author entry * - * @param DOMElement $element + * @param int $index * @return string */ public function getAuthor($index = 0) diff --git a/src/Reader/Extension/Thread/Entry.php b/src/Reader/Extension/Thread/Entry.php index 604154fd..81012b46 100644 --- a/src/Reader/Extension/Thread/Entry.php +++ b/src/Reader/Extension/Thread/Entry.php @@ -44,7 +44,6 @@ public function getCommentCount() * Get the entry data specified by name * * @param string $name - * @param string $type * @return mixed|null */ protected function getData($name) diff --git a/src/Reader/Feed/AbstractFeed.php b/src/Reader/Feed/AbstractFeed.php index 73b42f00..fe6435da 100644 --- a/src/Reader/Feed/AbstractFeed.php +++ b/src/Reader/Feed/AbstractFeed.php @@ -11,6 +11,7 @@ namespace Zend\Feed\Reader\Feed; use DOMDocument; +use DOMElement; use DOMXPath; use Zend\Feed\Reader; use Zend\Feed\Reader\Exception; @@ -73,7 +74,7 @@ abstract class AbstractFeed implements FeedInterface /** * Constructor * - * @param DOMDocument The DOM object for the feed's XML + * @param DOMDocument $domDocument The DOM object for the feed's XML * @param string $type Feed type */ public function __construct(DOMDocument $domDocument, $type = null) @@ -210,7 +211,7 @@ public function getType() /** * Return the current feed key * - * @return unknown + * @return int */ public function key() { diff --git a/src/Reader/Feed/Rss.php b/src/Reader/Feed/Rss.php index b0b1e0b9..656d7c37 100644 --- a/src/Reader/Feed/Rss.php +++ b/src/Reader/Feed/Rss.php @@ -253,6 +253,7 @@ public function getDateModified() /** * Get the feed lastBuild date * + * @throws Exception\RuntimeException * @return DateTime */ public function getLastBuildDate() diff --git a/src/Reader/Reader.php b/src/Reader/Reader.php index 2edc6851..70a6f61a 100644 --- a/src/Reader/Reader.php +++ b/src/Reader/Reader.php @@ -183,13 +183,13 @@ public static function useHttpConditionalGet($bool = true) } /** - * Import a feed by providing a URL + * Import a feed by providing a URI * - * @param string $url The URL to the feed + * @param string $uri The URI to the feed * @param string $etag OPTIONAL Last received ETag for this resource * @param string $lastModified OPTIONAL Last-Modified value for this resource * @return Reader - * @throws Exception\ExceptionInterface + * @throws Exception\RuntimeException */ public static function import($uri, $etag = null, $lastModified = null) { @@ -264,6 +264,7 @@ public static function import($uri, $etag = null, $lastModified = null) * * @param string $string * @return Feed\FeedInterface + * @throws Exception\InvalidArgumentException * @throws Exception\RuntimeException */ public static function importString($string) @@ -372,8 +373,10 @@ public static function findFeedLinks($uri) * Detect the feed type of the provided feed * * @param Feed\AbstractFeed|DOMDocument|string $feed + * @param bool $specOnly * @return string - * @throws Exception\ExceptionInterface + * @throws Exception\InvalidArgumentException + * @throws Exception\RuntimeException */ public static function detectType($feed, $specOnly = false) { diff --git a/src/Writer/AbstractFeed.php b/src/Writer/AbstractFeed.php index faea8933..9afc0b25 100644 --- a/src/Writer/AbstractFeed.php +++ b/src/Writer/AbstractFeed.php @@ -109,7 +109,7 @@ public function addAuthors(array $authors) /** * Set the copyright entry * - * @return string|null + * @param string $copyright * @throws Exception\InvalidArgumentException */ public function setCopyright($copyright) @@ -180,7 +180,7 @@ public function setLastBuildDate($date = null) /** * Set the feed description * - * @return string|null + * @param string $description * @throws Exception\InvalidArgumentException */ public function setDescription($description) @@ -194,8 +194,11 @@ public function setDescription($description) /** * Set the feed generator entry * - * @return string|null + * @param array|string $name + * @param null|string $version + * @param null|string $uri * @throws Exception\InvalidArgumentException + * @return string|null */ public function setGenerator($name, $version = null, $uri = null) { @@ -310,7 +313,7 @@ public function setImage(array $data) /** * Set the feed language * - * @return string|null + * @param string $language * @throws Exception\InvalidArgumentException */ public function setLanguage($language) @@ -338,7 +341,8 @@ public function setLink($link) /** * Set a link to an XML feed for any feed type/version * - * @return string|null + * @param string $link + * @param string $type * @throws Exception\InvalidArgumentException */ public function setFeedLink($link, $type) @@ -355,7 +359,7 @@ public function setFeedLink($link, $type) /** * Set the feed title * - * @return string|null + * @param string $title * @throws Exception\InvalidArgumentException */ public function setTitle($title) @@ -428,7 +432,7 @@ public function addHubs(array $urls) /** * Add a feed category * - * @param string $category + * @param array $category * @throws Exception\InvalidArgumentException */ public function addCategory(array $category) @@ -769,6 +773,7 @@ public function __call($method, $args) /** * Load extensions from Zend_Feed_Writer * + * @throws Exception\RuntimeException * @return void */ protected function _loadExtensions() diff --git a/src/Writer/Entry.php b/src/Writer/Entry.php index 11925d7c..9e757f93 100644 --- a/src/Writer/Entry.php +++ b/src/Writer/Entry.php @@ -112,7 +112,7 @@ public function addAuthors(array $authors) /** * Set the feed character encoding * - * @return string|null + * @param string $encoding * @throws Exception\InvalidArgumentException */ public function setEncoding($encoding) @@ -139,7 +139,7 @@ public function getEncoding() /** * Set the copyright entry * - * @return string|null + * @param string $copyright * @throws Exception\InvalidArgumentException */ public function setCopyright($copyright) @@ -153,7 +153,7 @@ public function setCopyright($copyright) /** * Set the entry's content * - * @return string|null + * @param string $content * @throws Exception\InvalidArgumentException */ public function setContent($content) @@ -167,7 +167,7 @@ public function setContent($content) /** * Set the feed creation date * - * @return string|null|DateTime + * @param string|null|DateTime $date * @throws Exception\InvalidArgumentException */ public function setDateCreated($date = null) @@ -185,7 +185,7 @@ public function setDateCreated($date = null) /** * Set the feed modification date * - * @return string|null|DateTime + * @param string|null|DateTime $date * @throws Exception\InvalidArgumentException */ public function setDateModified($date = null) @@ -203,7 +203,7 @@ public function setDateModified($date = null) /** * Set the feed description * - * @return string|null + * @param string $description * @throws Exception\InvalidArgumentException */ public function setDescription($description) @@ -217,7 +217,7 @@ public function setDescription($description) /** * Set the feed ID * - * @return string|null + * @param string $id * @throws Exception\InvalidArgumentException */ public function setId($id) @@ -231,7 +231,7 @@ public function setId($id) /** * Set a link to the HTML source of this entry * - * @return string|null + * @param string $link * @throws Exception\InvalidArgumentException */ public function setLink($link) @@ -245,7 +245,7 @@ public function setLink($link) /** * Set the number of comments associated with this entry * - * @return string|null + * @param int $count * @throws Exception\InvalidArgumentException */ public function setCommentCount($count) @@ -259,7 +259,7 @@ public function setCommentCount($count) /** * Set a link to a HTML page containing comments associated with this entry * - * @return string|null + * @param string $link * @throws Exception\InvalidArgumentException */ public function setCommentLink($link) @@ -273,7 +273,7 @@ public function setCommentLink($link) /** * Set a link to an XML feed for any comments associated with this entry * - * @return string|null + * @param array $link * @throws Exception\InvalidArgumentException */ public function setCommentFeedLink(array $link) @@ -296,7 +296,7 @@ public function setCommentFeedLink(array $link) * Each link is an array with keys "uri" and "type", where type is one of: * "atom", "rss" or "rdf". * - * @return string|null + * @param array $links */ public function setCommentFeedLinks(array $links) { @@ -308,7 +308,7 @@ public function setCommentFeedLinks(array $links) /** * Set the feed title * - * @return string|null + * @param string $title * @throws Exception\InvalidArgumentException */ public function setTitle($title) @@ -493,7 +493,7 @@ public function getCommentFeedLinks() /** * Add a entry category * - * @param string $category + * @param array $category * @throws Exception\InvalidArgumentException */ public function addCategory(array $category) diff --git a/src/Writer/Extension/ITunes/Entry.php b/src/Writer/Extension/ITunes/Entry.php index ce6c400a..d6b9ce9c 100644 --- a/src/Writer/Extension/ITunes/Entry.php +++ b/src/Writer/Extension/ITunes/Entry.php @@ -37,7 +37,7 @@ class Entry * Set feed encoding * * @param string $enc - * @return Zend_Feed_Writer_Extension_ITunes_Entry + * @return Entry */ public function setEncoding($enc) { @@ -209,6 +209,7 @@ public function setItunesSummary($value) * * @param string $method * @param array $params + * @throws Writer\Exception\BadMethodCallException * @return mixed */ public function __call($method, array $params) diff --git a/src/Writer/Extension/ITunes/Feed.php b/src/Writer/Extension/ITunes/Feed.php index 33a3684b..25d1d7bf 100644 --- a/src/Writer/Extension/ITunes/Feed.php +++ b/src/Writer/Extension/ITunes/Feed.php @@ -264,7 +264,7 @@ public function addItunesOwners(array $values) /** * Add feed owner * - * @param string $value + * @param array $value * @return Feed * @throws Writer\Exception\InvalidArgumentException */ diff --git a/src/Writer/FeedFactory.php b/src/Writer/FeedFactory.php index 2abc8bc3..899895e2 100644 --- a/src/Writer/FeedFactory.php +++ b/src/Writer/FeedFactory.php @@ -23,6 +23,7 @@ abstract class FeedFactory * Create and return a Feed based on data provided. * * @param array|\Traversable $data + * @throws Exception\InvalidArgumentException * @return Feed */ public static function factory($data) @@ -88,6 +89,7 @@ protected static function convertKey($key) * * @param array|Traversable $entries * @param Feed $feed + * @throws Exception\InvalidArgumentException * @return void */ protected static function createEntries($entries, Feed $feed) diff --git a/src/Writer/Renderer/AbstractRenderer.php b/src/Writer/Renderer/AbstractRenderer.php index 7704ecde..d914fdbd 100644 --- a/src/Writer/Renderer/AbstractRenderer.php +++ b/src/Writer/Renderer/AbstractRenderer.php @@ -27,7 +27,7 @@ class AbstractRenderer protected $extensions = array(); /** - * @var mixed + * @var Writer\AbstractFeed */ protected $container = null; @@ -69,7 +69,7 @@ class AbstractRenderer /** * Constructor * - * @param mixed $container + * @param Writer\AbstractFeed $container */ public function __construct($container) { @@ -111,7 +111,7 @@ public function getElement() /** * Get data container of items being rendered * - * @return mixed + * @return Writer\AbstractFeed */ public function getDataContainer() { diff --git a/src/Writer/Renderer/Feed/AbstractAtom.php b/src/Writer/Renderer/Feed/AbstractAtom.php index 10d8b551..c8012a06 100644 --- a/src/Writer/Renderer/Feed/AbstractAtom.php +++ b/src/Writer/Renderer/Feed/AbstractAtom.php @@ -26,9 +26,9 @@ class AbstractAtom extends Renderer\AbstractRenderer /** * Constructor * - * @param Zend_Feed_Writer_Feed $container + * @param Writer\AbstractFeed $container */ - public function __construct ($container) + public function __construct($container) { parent::__construct($container); } diff --git a/src/Writer/Renderer/Feed/AtomSource.php b/src/Writer/Renderer/Feed/AtomSource.php index b71fa1e7..34d519ce 100644 --- a/src/Writer/Renderer/Feed/AtomSource.php +++ b/src/Writer/Renderer/Feed/AtomSource.php @@ -25,7 +25,7 @@ class AtomSource extends AbstractAtom implements Renderer\RendererInterface /** * Constructor * - * @param Zend_Feed_Writer_Feed_Source $container + * @param Writer\Source $container */ public function __construct (Writer\Source $container) { diff --git a/src/Writer/Renderer/Feed/Rss.php b/src/Writer/Renderer/Feed/Rss.php index aa456397..549e568b 100644 --- a/src/Writer/Renderer/Feed/Rss.php +++ b/src/Writer/Renderer/Feed/Rss.php @@ -27,7 +27,7 @@ class Rss extends Renderer\AbstractRenderer implements Renderer\RendererInterfac /** * Constructor * - * @param Zend_Feed_Writer_Feed $container + * @param Writer\Feed $container */ public function __construct (Writer\Feed $container) { @@ -37,7 +37,7 @@ public function __construct (Writer\Feed $container) /** * Render RSS feed * - * @return Zend_Feed_Writer_Renderer_Feed_Rss + * @return self */ public function render() {