Ticket #36295: 36295.3.diff

src/wp-includes/class-feed.php

@@ -3 +3 @@
 if ( ! class_exists( 'SimplePie', false ) )
         require_once( ABSPATH . WPINC . '/class-simplepie.php' );
 
+/**
+ * WordPress Feed Cache Class.
+ *
+ * Caches feeds using SimplePie_Cache.
+ *
+ * @since 2.8.0
+ */
 class WP_Feed_Cache extends SimplePie_Cache {
+
         /**
-         * Create a new SimplePie_Cache object
+         * Creates a new SimplePie_Cache object.
          *
-         * @static
-         * @access public
+         * @since 2.8.0
          *
          * @param string $location  URL location (scheme is used to determine handler).
          * @param string $filename  Unique identifier for cache object.
@@ -20 +27 @@
         }
 }
 
+/**
+ * WordPress Feed Cache Transient Class.
+ *
+ * Caches feeds using SimplePie_Cache.
+ *
+ * @since 2.8.0
+ */
 class WP_Feed_Cache_Transient {
+
+        /**
+         * Holds the transient name.
+         *
+         * @since 2.8.0
+         * @access public
+         * @var string
+         */
         public $name;
+
+        /**
+         * Holds the transient mod name.
+         *
+         * @since 2.8.0
+         * @access public
+         * @var string
+         */
         public $mod_name;
-        public $lifetime = 43200; //Default lifetime in cache of 12 hours
 
         /**
-         * Class instantiator.
-         * 
+         * Holds the cache duration in seconds.
+         *
+         * Defaults to 43200 seconds (12 hours).
+         *
+         * @since 2.8.0
+         * @access public
+         * @var int
+         */
+        public $lifetime = 43200;
+
+        /**
+         * Constructor.
+         *
+         * @since 2.8.0
+         * @since 3.2.0 Update to PHP5 constructor
+         *
          * @param string $location  URL location (scheme is used to determine handler).
          * @param string $filename  Unique identifier for cache object.
          * @param string $extension 'spi' or 'spc'.
@@ -49 +92 @@
         }
 
         /**
-         * @access public
+         * Sets the transient.
          *
+         * @since 2.8.0
+         *
          * @param SimplePie $data Data to save.
          * @return true Always true.
          */
@@ -65 +110 @@
         }
 
         /**
-         * @access public
+         * Gets the transient.
+         *
+         * @since 2.8.0
+         * @return mixed Transient value.
          */
         public function load() {
                 return get_transient($this->name);
@@ -72 +120 @@
         }
 
         /**
-         * @access public
+         * Gets mod transient.
+         *
+         * @since 2.8.0
+         * @return mixed Transient value.
          */
         public function mtime() {
                 return get_transient($this->mod_name);
@@ -79 +130 @@
         }
 
         /**
-         * @access public
+         * Sets mod transient.
+         *
+         * @since 2.8.0
+         * @return bool False if value was not set and true if value was set.
          */
         public function touch() {
                 return set_transient($this->mod_name, time(), $this->lifetime);
@@ -86 +140 @@
         }
 
         /**
-         * @access public
+         * Deletes transients.
+         *
+         * @since 2.8.0
+         * @return true Always true.
          */
         public function unlink() {
                 delete_transient($this->name);
@@ -95 +152 @@
         }
 }
 
+/**
+ * WordPress SimplePie File Class.
+ *
+ * Fetches remote files and reads local files.
+ *
+ * @since 2.8.0
+ */
 class WP_SimplePie_File extends SimplePie_File {
 
+        /**
+         * Constructor.
+         *
+         * @since 2.8.0
+         * @since 3.2.0 Update to PHP5 constructor
+         *
+         * @param string       $url             Remote file URL.
+         * @param integer      $timeout         How long the connection should stay open in seconds. Default: 10.
+         * @param integer      $redirects       The number of allowed redirects. Default: 5.
+         * @param string|array $headers         Array or string of headers to send with the request. Default: null.
+         * @param string       $useragent       User-agent value sent. Default: null.
+         * @param boolean      $force_fsockopen Whether to force opening internet or unix domain socket connection
+         *                                      or not. Default: false.
+         */
         public function __construct($url, $timeout = 10, $redirects = 5, $headers = null, $useragent = null, $force_fsockopen = false) {
                 $this->url = $url;
                 $this->timeout = $timeout;
@@ -136 +214 @@
 }
 
 /**
- * WordPress SimplePie Sanitization Class
+ * WordPress SimplePie Sanitization Class.
  *
- * Extension of the SimplePie_Sanitize class to use KSES, because
- * we cannot universally count on DOMDocument being available
+ * Extends the SimplePie_Sanitize class to use KSES, because
+ * we cannot universally count on DOMDocument being available.
  *
- * @package WordPress
  * @since 3.5.0
  */
 class WP_SimplePie_Sanitize_KSES extends SimplePie_Sanitize {
+
+        /**
+         * WordPress SimplePie sanitization using KSES.
+         *
+         * Sanitizes the incoming data, to ensure that it matches the type of data expected, using KSES.
+         *
+         * @since 3.5.0
+         *
+         * @param mixed   $data The data that needs to be sanitized.
+         * @param integer $type The type of data that it's supposed to be.
+         * @param string  $base The `xml:base` value to use when converting relative URLs to absolute ones.
+         * @return mixed Sanitized data.
+         */
         public function sanitize( $data, $type, $base = '' ) {
                 $data = trim( $data );
                 if ( $type & SIMPLEPIE_CONSTRUCT_MAYBE_HTML ) {