diff options
Diffstat (limited to 'vendor/simplepie/simplepie/src/Caption.php')
-rw-r--r-- | vendor/simplepie/simplepie/src/Caption.php | 159 |
1 files changed, 150 insertions, 9 deletions
diff --git a/vendor/simplepie/simplepie/src/Caption.php b/vendor/simplepie/simplepie/src/Caption.php index f0cf271de..0795115c9 100644 --- a/vendor/simplepie/simplepie/src/Caption.php +++ b/vendor/simplepie/simplepie/src/Caption.php @@ -5,10 +5,7 @@ * A PHP-Based RSS and Atom Feed Framework. * Takes the hard work out of managing a complete RSS/Atom solution. * - * Please note: This file is automatically generated by a build script. The - * full original source is always available from http://simplepie.org/ - * - * Copyright (c) 2004-2016, Ryan Parman, Sam Sneddon, Ryan McCue, and contributors + * Copyright (c) 2004-2022, Ryan Parman, Sam Sneddon, Ryan McCue, and contributors * All rights reserved. * * Redistribution and use in source and binary forms, with or without modification, are @@ -46,10 +43,154 @@ namespace SimplePie; -class_exists('SimplePie_Caption'); +/** + * 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\SimplePie::set_caption_class()} + * + * @package SimplePie + * @subpackage API + */ +class Caption +{ + /** + * Content type + * + * @var string + * @see get_type() + */ + public $type; + + /** + * Language + * + * @var string + * @see get_language() + */ + public $lang; + + /** + * Start time + * + * @var string + * @see get_starttime() + */ + public $startTime; + + /** + * End time + * + * @var string + * @see get_endtime() + */ + public $endTime; + + /** + * Caption text + * + * @var string + * @see get_text() + */ + public $text; + + /** + * 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; + $this->lang = $lang; + $this->startTime = $startTime; + $this->endTime = $endTime; + $this->text = $text; + } -if (\false) { - class Caption extends \SimplePie_Caption - { - } + /** + * 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) { + return $this->endTime; + } + + return null; + } + + /** + * 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) { + return $this->lang; + } + + return null; + } + + /** + * Get the start time + * + * @return string|null Time in the format 'hh:mm:ss.SSS' + */ + public function get_starttime() + { + if ($this->startTime !== null) { + return $this->startTime; + } + + return null; + } + + /** + * Get the text of the caption + * + * @return string|null + */ + public function get_text() + { + if ($this->text !== null) { + return $this->text; + } + + return null; + } + + /** + * Get the content type (not MIME type) + * + * @return string|null Either 'text' or 'html' + */ + public function get_type() + { + if ($this->type !== null) { + return $this->type; + } + + return null; + } } + +class_alias('SimplePie\Caption', 'SimplePie_Caption'); |