[change] we now use Full-Text RSS 3.1, thank you so much @fivefilters

[github/wallabag/wallabag.git] / inc / 3rdparty / libraries / simplepie / library / SimplePie / Cache / File.php

diff --git a/inc/3rdparty/simplepie/SimplePie/Cache/File.php b/inc/3rdparty/libraries/simplepie/library/SimplePie/Cache/File.php
similarity index 68%
rename from inc/3rdparty/simplepie/SimplePie/Cache/File.php
rename to inc/3rdparty/libraries/simplepie/library/SimplePie/Cache/File.php
index f496ff50452d1a0dc0ec76c90ec0b0c6b3d4c22c..5797b3aedea23e7eb9c1afaa02c4c61cb87942e8 100644 (file)
--- a/inc/3rdparty/simplepie/SimplePie/Cache/File.php
+++ b/inc/3rdparty/libraries/simplepie/library/SimplePie/Cache/File.php
@@ -5,7 +5,7 @@
  * A PHP-Based RSS and Atom Feed Framework.
  * Takes the hard work out of managing a complete RSS/Atom solution.
  *
- * Copyright (c) 2004-2009, Ryan Parman, Geoffrey Sneddon, Ryan McCue, and contributors
+ * Copyright (c) 2004-2012, Ryan Parman, Geoffrey Sneddon, Ryan McCue, and contributors
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without modification, are
@@ -33,37 +33,78 @@
  * POSSIBILITY OF SUCH DAMAGE.
  *
  * @package SimplePie
- * @version 1.3-dev
- * @copyright 2004-2010 Ryan Parman, Geoffrey Sneddon, Ryan McCue
+ * @version 1.3.1
+ * @copyright 2004-2012 Ryan Parman, Geoffrey Sneddon, Ryan McCue
  * @author Ryan Parman
  * @author Geoffrey Sneddon
  * @author Ryan McCue
  * @link http://simplepie.org/ SimplePie
  * @license http://www.opensource.org/licenses/bsd-license.php BSD License
- * @todo phpDoc comments
  */
 
-
+/**
+ * Caches data to the filesystem
+ *
+ * @package SimplePie
+ * @subpackage Caching
+ */
 class SimplePie_Cache_File implements SimplePie_Cache_Base
 {
+       /**
+        * Location string
+        *
+        * @see SimplePie::$cache_location
+        * @var string
+        */
        protected $location;
+
+       /**
+        * Filename
+        *
+        * @var string
+        */
        protected $filename;
+
+       /**
+        * File extension
+        *
+        * @var string
+        */
        protected $extension;
+
+       /**
+        * File path
+        *
+        * @var string
+        */
        protected $name;
 
-       public function __construct($location, $filename, $extension)
+       /**
+        * Create a new cache object
+        *
+        * @param string $location Location string (from SimplePie::$cache_location)
+        * @param string $name Unique ID for the cache
+        * @param string $type Either TYPE_FEED for SimplePie data, or TYPE_IMAGE for image data
+        */
+       public function __construct($location, $name, $type)
        {
                $this->location = $location;
-               $this->filename = $filename;
-               $this->extension = $extension;
+               $this->filename = $name;
+               $this->extension = $type;
                $this->name = "$this->location/$this->filename.$this->extension";
        }
 
+       /**
+        * Save data to the cache
+        *
+        * @param array|SimplePie $data Data to store in the cache. If passed a SimplePie object, only cache the $data property
+        * @return bool Successfulness
+        */
        public function save($data)
        {
                if (file_exists($this->name) && is_writeable($this->name) || file_exists($this->location) && is_writeable($this->location))
                {
-                       if (is_a($data, 'SimplePie'))
+                       if ($data instanceof SimplePie)
                        {
                                $data = $data->data;
                        }
@@ -74,6 +115,11 @@ class SimplePie_Cache_File implements SimplePie_Cache_Base
                return false;
        }
 
+       /**
+        * Retrieve the data saved to the cache
+        *
+        * @return array Data for SimplePie::$data
+        */
        public function load()
        {
                if (file_exists($this->name) && is_readable($this->name))
@@ -83,6 +129,11 @@ class SimplePie_Cache_File implements SimplePie_Cache_Base
                return false;
        }
 
+       /**
+        * Retrieve the last modified time for the cache
+        *
+        * @return int Timestamp
+        */
        public function mtime()
        {
                if (file_exists($this->name))
@@ -92,6 +143,11 @@ class SimplePie_Cache_File implements SimplePie_Cache_Base
                return false;
        }
 
+       /**
+        * Set the last modified time to the current time
+        *
+        * @return bool Success status
+        */
        public function touch()
        {
                if (file_exists($this->name))
@@ -101,6 +157,11 @@ class SimplePie_Cache_File implements SimplePie_Cache_Base
                return false;
        }
 
+       /**
+        * Remove the cache
+        *
+        * @return bool Success status
+        */
        public function unlink()
        {
                if (file_exists($this->name))