miarau / rssfeed

src/simplepie/simplepie_1.3.1.mini.php

Doc Comments +137 added lines

@@ -960,6 +960,10 @@ 
         return null;
     }
     
+    /**
+     * @param string $namespace
+     * @param string $tag
+     */
     public function get_channel_tags($namespace, $tag)
     {
         $type = $this->get_type();
@@ -1003,6 +1007,10 @@ 
         return null;
     }
     
+    /**
+     * @param string $namespace
+     * @param string $tag
+     */
     public function get_image_tags($namespace, $tag)
     {
         $type = $this->get_type();
@@ -1039,6 +1047,9 @@ 
         return null;
     }
     
+    /**
+     * @return string
+     */
     public function get_base($element = array())
     {
         if (!($this->get_type() & SIMPLEPIE_TYPE_RSS_SYNDICATION) && !empty($element['xml_base_explicit']) && isset($element['xml_base']))
@@ -1316,6 +1327,9 @@ 
         }
     }
     
+    /**
+     * @return string
+     */
     public function get_link($key = 0, $rel = 'alternate')
     {
         $links = $this->get_links($rel);
@@ -1960,6 +1974,9 @@ 
 abstract class SimplePie_Cache_DB implements SimplePie_Cache_Base
 {
     
+    /**
+     * @param SimplePie $data
+     */
     protected static function prepare_simplepie_object_for_cache($data)
     {
         $items = $data->get_items();
@@ -3049,6 +3066,9 @@ 
         }
     }
     
+    /**
+     * @param string $chars
+     */
     public function consume_range($chars)
     {
         if ($len = strspn($this->data, $chars, $this->position))
@@ -4682,6 +4702,9 @@ 
         trigger_error("Cannot write property $name", E_USER_ERROR);
     }
     
+    /**
+     * @param string $data
+     */
     public function __construct($data)
     {
         $this->compressed_data = $data;
@@ -5295,6 +5318,9 @@ 
         $this->set_iri($iri);
     }
     
+    /**
+     * @param SimplePie_IRI $base
+     */
     public static function absolutize($base, $relative)
     {
         if (!($relative instanceof SimplePie_IRI))
@@ -5382,6 +5408,9 @@ 
         }
     }
     
+    /**
+     * @param string $iri
+     */
     protected function parse_iri($iri)
     {
         $iri = trim($iri, "\x20\x09\x0A\x0C\x0D");
@@ -5470,6 +5499,9 @@ 
         return $output . $input;
     }
     
+    /**
+     * @param string $extra_chars
+     */
     protected function replace_invalid_with_pct_encoding($string, $extra_chars, $iprivate = false)
     {
         // Normalize as many pct-encoded sections as possible
@@ -5808,6 +5840,9 @@ 
         }
     }
     
+    /**
+     * @param string|null $scheme
+     */
     public function set_scheme($scheme)
     {
         if ($scheme === null)
@@ -5826,6 +5861,9 @@ 
         return true;
     }
     
+    /**
+     * @param string|null $authority
+     */
     public function set_authority($authority)
     {
         static $cache;
@@ -5881,6 +5919,9 @@ 
         }
     }
     
+    /**
+     * @param string|null $iuserinfo
+     */
     public function set_userinfo($iuserinfo)
     {
         if ($iuserinfo === null)
@@ -5940,6 +5981,9 @@ 
         return true;
     }
     
+    /**
+     * @param null|string $port
+     */
     public function set_port($port)
     {
         if ($port === null)
@@ -5960,6 +6004,9 @@ 
         }
     }
     
+    /**
+     * @param string|null $ipath
+     */
     public function set_path($ipath)
     {
         static $cache;
@@ -5983,6 +6030,9 @@ 
         return true;
     }
     
+    /**
+     * @param string|null $iquery
+     */
     public function set_query($iquery)
     {
         if ($iquery === null)
@@ -5997,6 +6047,9 @@ 
         return true;
     }
     
+    /**
+     * @param string|null $ifragment
+     */
     public function set_fragment($ifragment)
     {
         if ($ifragment === null)
@@ -6011,6 +6064,9 @@ 
         return true;
     }
     
+    /**
+     * @param false|string $string
+     */
     public function to_uri($string)
     {
         static $non_ascii;
@@ -6135,6 +6191,10 @@ 
         }
     }
     
+    /**
+     * @param string $namespace
+     * @param string $tag
+     */
     public function get_item_tags($namespace, $tag)
     {
         if (isset($this->data['child'][$namespace][$tag]))
@@ -6147,11 +6207,17 @@ 
         }
     }
     
+    /**
+     * @return string
+     */
     public function get_base($element = array())
     {
         return $this->feed->get_base($element);
     }
     
+    /**
+     * @return string
+     */
     public function sanitize($data, $type, $base = '')
     {
         return $this->feed->sanitize($data, $type, $base);
@@ -8755,6 +8821,10 @@ 
             return null;
         }
     }
+
+    /**
+     * @param string $name
+     */
     protected function search_elements_by_tag($name, &$done, $feeds)
     {
         if ($this->dom === null)
@@ -9102,6 +9172,11 @@ 
         return strtr($string, $convert_table);
     }
     
+    /**
+     * @param string $data
+     * @param string $input
+     * @param string $output
+     */
     public static function change_encoding($data, $input, $output)
     {
         $input = SimplePie_Misc::encoding($input);
@@ -10243,6 +10318,10 @@ 
                 return $charset;
         }
     }
+
+    /**
+     * @return string
+     */
     public static function get_curl_version()
     {
         if (is_array($curl = curl_version()))
@@ -10287,6 +10366,9 @@ 
         return $parser->parse($dt);
     }
     
+    /**
+     * @param string|false $data
+     */
     public static function entities_decode($data)
     {
         $decoder = new SimplePie_Decode_HTML_Entities($data);
@@ -10766,6 +10848,9 @@ 
         return $ip;
     }
     
+    /**
+     * @param string $ip
+     */
     public static function compress($ip)
     {
         // Prepare the IP to be compressed
@@ -11852,6 +11937,10 @@ 
     {
         return $this->data;
     }
+
+    /**
+     * @param string $tag
+     */
     public function tag_open($parser, $tag, $attributes)
     {
         list($this->namespace[], $this->element[]) = $this->split_ns($tag);
@@ -11914,6 +12003,10 @@ 
             }
         }
     }
+
+    /**
+     * @param string $cdata
+     */
     public function cdata($parser, $cdata)
     {
         if ($this->current_xhtml_construct >= 0)
@@ -11925,6 +12018,10 @@ 
             $this->data['data'] .= $cdata;
         }
     }
+
+    /**
+     * @param string $tag
+     */
     public function tag_close($parser, $tag)
     {
         if ($this->current_xhtml_construct >= 0)
@@ -12057,6 +12154,10 @@ 
     
     public function __construct() { }
     
+    /**
+     * @param string $type
+     * @param string $class
+     */
     public function register($type, $class, $legacy = false)
     {
         if (!is_subclass_of($class, $this->default[$type]))
@@ -12084,6 +12185,9 @@ 
         return null;
     }
     
+    /**
+     * @param string $type
+     */
     public function &create($type, $parameters = array())
     {
         $class = $this->get_class($type);
@@ -12115,6 +12219,10 @@ 
         return $instance;
     }
     
+    /**
+     * @param string $type
+     * @param string $method
+     */
     public function &call($type, $method, $parameters = array())
     {
         $class = $this->get_class($type);
@@ -12146,6 +12254,10 @@ 
     
     var $value;
     
+    /**
+     * @param string $relationship
+     * @param string $value
+     */
     public function __construct($relationship = null, $type = null, $value = null)
     {
         $this->relationship = $relationship;
@@ -12472,6 +12584,10 @@ 
         }
         return $data;
     }
+
+    /**
+     * @param string $html
+     */
     protected function preprocess($html, $type)
     {
         $ret = '';
@@ -12493,6 +12609,10 @@ 
         $ret .= '</head><body>' . $html . '</body></html>';
         return $ret;
     }
+
+    /**
+     * @param DOMDocument $document
+     */
     public function replace_urls($document, $tag, $attributes)
     {
         if (!is_array($attributes))
@@ -12542,6 +12662,10 @@ 
             return '';
         }
     }
+
+    /**
+     * @param DOMDocument $document
+     */
     protected function strip_tag($tag, $document, $type)
     {
         $xpath = new DOMXPath($document);
@@ -12617,6 +12741,10 @@ 
             }
         }
     }
+
+    /**
+     * @param DOMDocument $document
+     */
     protected function strip_attr($attrib, $document)
     {
         $xpath = new DOMXPath($document);
@@ -12645,6 +12773,11 @@ 
     {
         return md5(serialize($this->data));
     }
+
+    /**
+     * @param string $namespace
+     * @param string $tag
+     */
     public function get_source_tags($namespace, $tag)
     {
         if (isset($this->data['child'][$namespace][$tag]))
@@ -12656,6 +12789,10 @@ 
             return null;
         }
     }
+
+    /**
+     * @return string
+     */
     public function get_base($element = array())
     {
         return $this->item->get_base($element);

src/RSSFeed/CRSSFeed.php

Doc Comments +4 added lines

@@ -15,6 +15,10 @@
 class CRSSFeed {

   

   // constructor - initialize SimplePie.

+
+  /**
+   * @param string[] $feedArr
+   */
   public function __construct($feedArr, $duration = 3600) {

       $this->object = new SimplePie();

       $this->object->set_cache_location(CACHE);