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

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

diff --git a/inc/3rdparty/simplepie/SimplePie/Caption.php b/inc/3rdparty/libraries/simplepie/library/SimplePie/Caption.php
similarity index 66%
rename from inc/3rdparty/simplepie/SimplePie/Caption.php
rename to inc/3rdparty/libraries/simplepie/library/SimplePie/Caption.php
index df6fedc59a283618822a32b8334d254a1d84e07a..52922c5d95624e3f75e79c1371b4891d29ed7db4 100644 (file)
--- a/inc/3rdparty/simplepie/SimplePie/Caption.php
+++ b/inc/3rdparty/libraries/simplepie/library/SimplePie/Caption.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,26 +33,74 @@
  * 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:text>` captions as defined in Media RSS.
+ *
+ * Used by {@see SimplePie_Enclosure::get_caption()} and {@see SimplePie_Enclosure::get_captions()}
+ *
+ * This class can be overloaded with {@see SimplePie::set_caption_class()}
+ *
+ * @package SimplePie
+ * @subpackage API
+ */
 class SimplePie_Caption
 {
+       /**
+        * Content type
+        *
+        * @var string
+        * @see get_type()
+        */
        var $type;
+
+       /**
+        * Language
+        *
+        * @var string
+        * @see get_language()
+        */
        var $lang;
+
+       /**
+        * Start time
+        *
+        * @var string
+        * @see get_starttime()
+        */
        var $startTime;
+
+       /**
+        * End time
+        *
+        * @var string
+        * @see get_endtime()
+        */
        var $endTime;
+
+       /**
+        * Caption text
+        *
+        * @var string
+        * @see get_text()
+        */
        var $text;
 
-       // 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($type = null, $lang = null, $startTime = null, $endTime = null, $text = null)
        {
                $this->type = $type;
@@ -62,12 +110,22 @@ class SimplePie_Caption
                $this->text = $text;
        }
 
+       /**
+        * String-ified version
+        *
+        * @return string
+        */
        public function __toString()
        {
                // There is no $this->data here
                return md5(serialize($this));
        }
 
+       /**
+        * Get the end time
+        *
+        * @return string|null Time in the format 'hh:mm:ss.SSS'
+        */
        public function get_endtime()
        {
                if ($this->endTime !== null)
@@ -80,6 +138,12 @@ class SimplePie_Caption
                }
        }
 
+       /**
+        * Get the language
+        *
+        * @link http://tools.ietf.org/html/rfc3066
+        * @return string|null Language code as per RFC 3066
+        */
        public function get_language()
        {
                if ($this->lang !== null)
@@ -92,6 +156,11 @@ class SimplePie_Caption
                }
        }
 
+       /**
+        * Get the start time
+        *
+        * @return string|null Time in the format 'hh:mm:ss.SSS'
+        */
        public function get_starttime()
        {
                if ($this->startTime !== null)
@@ -104,6 +173,11 @@ class SimplePie_Caption
                }
        }
 
+       /**
+        * Get the text of the caption
+        *
+        * @return string|null
+        */
        public function get_text()
        {
                if ($this->text !== null)
@@ -116,6 +190,11 @@ class SimplePie_Caption
                }
        }
 
+       /**
+        * Get the content type (not MIME type)
+        *
+        * @return string|null Either 'text' or 'html'
+        */
        public function get_type()
        {
                if ($this->type !== null)