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

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

diff --git a/inc/3rdparty/simplepie/SimplePie/Restriction.php b/inc/3rdparty/libraries/simplepie/library/SimplePie/Restriction.php
similarity index 70%
rename from inc/3rdparty/simplepie/SimplePie/Restriction.php
rename to inc/3rdparty/libraries/simplepie/library/SimplePie/Restriction.php
index b0e7667ac611325ecc8537462eea195998975598..4ba371bfbca2decd430eecf61c7b8dfa2c0d6c10 100644 (file)
--- a/inc/3rdparty/simplepie/SimplePie/Restriction.php
+++ b/inc/3rdparty/libraries/simplepie/library/SimplePie/Restriction.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,24 +33,57 @@
  * 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
  */
 
-
+/**
+ * Handles `<media:restriction>` as defined in Media RSS
+ *
+ * Used by {@see SimplePie_Enclosure::get_restriction()} and {@see SimplePie_Enclosure::get_restrictions()}
+ *
+ * This class can be overloaded with {@see SimplePie::set_restriction_class()}
+ *
+ * @package SimplePie
+ * @subpackage API
+ */
 class SimplePie_Restriction
 {
+       /**
+        * Relationship ('allow'/'deny')
+        *
+        * @var string
+        * @see get_relationship()
+        */
        var $relationship;
+
+       /**
+        * Type of restriction
+        *
+        * @var string
+        * @see get_type()
+        */
        var $type;
+
+       /**
+        * Restricted values
+        *
+        * @var string
+        * @see get_value()
+        */
        var $value;
 
-       // Constructor, used to input the data
+       /**
+        * Constructor, used to input the data
+        *
+        * For documentation on all the parameters, see the corresponding
+        * properties and their accessors
+        */
        public function __construct($relationship = null, $type = null, $value = null)
        {
                $this->relationship = $relationship;
@@ -58,12 +91,22 @@ class SimplePie_Restriction
                $this->value = $value;
        }
 
+       /**
+        * String-ified version
+        *
+        * @return string
+        */
        public function __toString()
        {
                // There is no $this->data here
                return md5(serialize($this));
        }
 
+       /**
+        * Get the relationship
+        *
+        * @return string|null Either 'allow' or 'deny'
+        */
        public function get_relationship()
        {
                if ($this->relationship !== null)
@@ -76,6 +119,11 @@ class SimplePie_Restriction
                }
        }
 
+       /**
+        * Get the type
+        *
+        * @return string|null
+        */
        public function get_type()
        {
                if ($this->type !== null)
@@ -88,6 +136,11 @@ class SimplePie_Restriction
                }
        }
 
+       /**
+        * Get the list of restricted things
+        *
+        * @return string|null
+        */
        public function get_value()
        {
                if ($this->value !== null)