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

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

diff --git a/inc/3rdparty/simplepie/SimplePie/Credit.php b/inc/3rdparty/libraries/simplepie/library/SimplePie/Credit.php
similarity index 70%
rename from inc/3rdparty/simplepie/SimplePie/Credit.php
rename to inc/3rdparty/libraries/simplepie/library/SimplePie/Credit.php
index 3894b30c27727b9bbc28a6978a1412d03fc53758..d3a3442ad91c62ee40ab4e1e88c21372369f361c 100644 (file)
--- a/inc/3rdparty/simplepie/SimplePie/Credit.php
+++ b/inc/3rdparty/libraries/simplepie/library/SimplePie/Credit.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:credit>` as defined in Media RSS
+ *
+ * Used by {@see SimplePie_Enclosure::get_credit()} and {@see SimplePie_Enclosure::get_credits()}
+ *
+ * This class can be overloaded with {@see SimplePie::set_credit_class()}
+ *
+ * @package SimplePie
+ * @subpackage API
+ */
 class SimplePie_Credit
 {
+       /**
+        * Credited role
+        *
+        * @var string
+        * @see get_role()
+        */
        var $role;
+
+       /**
+        * Organizational scheme
+        *
+        * @var string
+        * @see get_scheme()
+        */
        var $scheme;
+
+       /**
+        * Credited name
+        *
+        * @var string
+        * @see get_name()
+        */
        var $name;
 
-       // 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($role = null, $scheme = null, $name = null)
        {
                $this->role = $role;
@@ -58,12 +91,22 @@ class SimplePie_Credit
                $this->name = $name;
        }
 
+       /**
+        * String-ified version
+        *
+        * @return string
+        */
        public function __toString()
        {
                // There is no $this->data here
                return md5(serialize($this));
        }
 
+       /**
+        * Get the role of the person receiving credit
+        *
+        * @return string|null
+        */
        public function get_role()
        {
                if ($this->role !== null)
@@ -76,6 +119,11 @@ class SimplePie_Credit
                }
        }
 
+       /**
+        * Get the organizational scheme
+        *
+        * @return string|null
+        */
        public function get_scheme()
        {
                if ($this->scheme !== null)
@@ -88,6 +136,11 @@ class SimplePie_Credit
                }
        }
 
+       /**
+        * Get the credited person/entity's name
+        *
+        * @return string|null
+        */
        public function get_name()
        {
                if ($this->name !== null)