WordPress 4.5

[autoinstalls/wordpress.git] / wp-includes / class-feed.php

diff --git a/wp-includes/class-feed.php b/wp-includes/class-feed.php
index c33b30247e047ffb41dc8d7249ecdf2a469af699..f0ae19633dd6bfd0afcadfa9b052214cf1309e73 100644 (file)
--- a/wp-includes/class-feed.php
+++ b/wp-includes/class-feed.php
@@ -1,6 +1,6 @@
 <?php
 
-if ( !class_exists('SimplePie') )
+if ( ! class_exists( 'SimplePie', false ) )
        require_once( ABSPATH . WPINC . '/class-simplepie.php' );
 
 class WP_Feed_Cache extends SimplePie_Cache {
@@ -9,18 +9,30 @@ class WP_Feed_Cache extends SimplePie_Cache {
         *
         * @static
         * @access public
+        *
+        * @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'.
+        * @return WP_Feed_Cache_Transient Feed cache handler object that uses transients.
         */
-       function create($location, $filename, $extension) {
+       public function create($location, $filename, $extension) {
                return new WP_Feed_Cache_Transient($location, $filename, $extension);
        }
 }
 
 class WP_Feed_Cache_Transient {
-       var $name;
-       var $mod_name;
-       var $lifetime = 43200; //Default lifetime in cache of 12 hours
+       public $name;
+       public $mod_name;
+       public $lifetime = 43200; //Default lifetime in cache of 12 hours
 
-       function __construct($location, $filename, $extension) {
+       /**
+        * Class instantiator.
+        * 
+        * @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'.
+        */
+       public function __construct($location, $filename, $extension) {
                $this->name = 'feed_' . $filename;
                $this->mod_name = 'feed_mod_' . $filename;
 
@@ -36,28 +48,47 @@ class WP_Feed_Cache_Transient {
                $this->lifetime = apply_filters( 'wp_feed_cache_transient_lifetime', $lifetime, $filename);
        }
 
-       function save($data) {
-               if ( is_a($data, 'SimplePie') )
+       /**
+        * @access public
+        *
+        * @param SimplePie $data Data to save.
+        * @return true Always true.
+        */
+       public function save($data) {
+               if ( $data instanceof SimplePie ) {
                        $data = $data->data;
+               }
 
                set_transient($this->name, $data, $this->lifetime);
                set_transient($this->mod_name, time(), $this->lifetime);
                return true;
        }
 
-       function load() {
+       /**
+        * @access public
+        */
+       public function load() {
                return get_transient($this->name);
        }
 
-       function mtime() {
+       /**
+        * @access public
+        */
+       public function mtime() {
                return get_transient($this->mod_name);
        }
 
-       function touch() {
+       /**
+        * @access public
+        */
+       public function touch() {
                return set_transient($this->mod_name, time(), $this->lifetime);
        }
 
-       function unlink() {
+       /**
+        * @access public
+        */
+       public function unlink() {
                delete_transient($this->name);
                delete_transient($this->mod_name);
                return true;
@@ -66,7 +97,7 @@ class WP_Feed_Cache_Transient {
 
 class WP_SimplePie_File extends SimplePie_File {
 
-       function __construct($url, $timeout = 10, $redirects = 5, $headers = null, $useragent = null, $force_fsockopen = false) {
+       public function __construct($url, $timeout = 10, $redirects = 5, $headers = null, $useragent = null, $force_fsockopen = false) {
                $this->url = $url;
                $this->timeout = $timeout;
                $this->redirects = $redirects;