[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 / Memcache.php

diff --git a/inc/3rdparty/simplepie/SimplePie/Cache/Memcache.php b/inc/3rdparty/libraries/simplepie/library/SimplePie/Cache/Memcache.php
similarity index 61%
rename from inc/3rdparty/simplepie/SimplePie/Cache/Memcache.php
rename to inc/3rdparty/libraries/simplepie/library/SimplePie/Cache/Memcache.php
index 3535fecc9228695095d653ad02d6f63ae06f417f..fd4478060924dceb656f571905257cb2c423e658 100644 (file)
--- a/inc/3rdparty/simplepie/SimplePie/Cache/Memcache.php
+++ b/inc/3rdparty/libraries/simplepie/library/SimplePie/Cache/Memcache.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,23 +33,59 @@
  * 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 memcache
+ *
+ * Registered for URLs with the "memcache" protocol
+ *
+ * For example, `memcache://localhost:11211/?timeout=3600&prefix=sp_` will
+ * connect to memcache on `localhost` on port 11211. All tables will be
+ * prefixed with `sp_` and data will expire after 3600 seconds
+ *
+ * @package SimplePie
+ * @subpackage Caching
+ * @uses Memcache
+ */
 class SimplePie_Cache_Memcache implements SimplePie_Cache_Base
 {
+       /**
+        * Memcache instance
+        *
+        * @var Memcache
+        */
        protected $cache;
+
+       /**
+        * Options
+        *
+        * @var array
+        */
        protected $options;
+
+       /**
+        * Cache name
+        *
+        * @var string
+        */
        protected $name;
 
-       public function __construct($url, $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->options = array(
                        'host' => '127.0.0.1',
@@ -59,22 +95,36 @@ class SimplePie_Cache_Memcache implements SimplePie_Cache_Base
                                'prefix' => 'simplepie_',
                        ),
                );
-               $this->options = array_merge_recursive($this->options, SimplePie_Cache::parse_URL($url));
-               $this->name = $this->options['extras']['prefix'] . md5("$filename:$extension");
+               $parsed = SimplePie_Cache::parse_URL($location);
+               $this->options['host'] = empty($parsed['host']) ? $this->options['host'] : $parsed['host'];
+               $this->options['port'] = empty($parsed['port']) ? $this->options['port'] : $parsed['port'];
+               $this->options['extras'] = array_merge($this->options['extras'], $parsed['extras']);
+               $this->name = $this->options['extras']['prefix'] . md5("$name:$type");
 
                $this->cache = new Memcache();
                $this->cache->addServer($this->options['host'], (int) $this->options['port']);
        }
 
+       /**
+        * 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 (is_a($data, 'SimplePie'))
+               if ($data instanceof SimplePie)
                {
                        $data = $data->data;
                }
                return $this->cache->set($this->name, serialize($data), MEMCACHE_COMPRESSED, (int) $this->options['extras']['timeout']);
        }
 
+       /**
+        * Retrieve the data saved to the cache
+        *
+        * @return array Data for SimplePie::$data
+        */
        public function load()
        {
                $data = $this->cache->get($this->name);
@@ -86,6 +136,11 @@ class SimplePie_Cache_Memcache implements SimplePie_Cache_Base
                return false;
        }
 
+       /**
+        * Retrieve the last modified time for the cache
+        *
+        * @return int Timestamp
+        */
        public function mtime()
        {
                $data = $this->cache->get($this->name);
@@ -99,6 +154,11 @@ class SimplePie_Cache_Memcache implements SimplePie_Cache_Base
                return false;
        }
 
+       /**
+        * Set the last modified time to the current time
+        *
+        * @return bool Success status
+        */
        public function touch()
        {
                $data = $this->cache->get($this->name);
@@ -111,8 +171,13 @@ class SimplePie_Cache_Memcache implements SimplePie_Cache_Base
                return false;
        }
 
+       /**
+        * Remove the cache
+        *
+        * @return bool Success status
+        */
        public function unlink()
        {
-               return $this->cache->delete($this->name);
+               return $this->cache->delete($this->name, 0);
        }
 }