[ Index ]

PHP Cross Reference of DokuWiki




/vendor/simplepie/simplepie/src/ -> Caption.php (summary)

SimplePie A PHP-Based RSS and Atom Feed Framework. Takes the hard work out of managing a complete RSS/Atom solution.

Author: Ryan Parman
Author: Sam Sneddon
Author: Ryan McCue
Copyright: 2004-2016 Ryan Parman, Sam Sneddon, Ryan McCue
License: http://www.opensource.org/licenses/bsd-license.php BSD License
Link: http://simplepie.org/ SimplePie
File Size: 198 lines (5 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

Caption:: (7 methods):

Class: Caption  - X-Ref

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()}

__construct($type = null, $lang = null, $startTime = null, $endTime = null, $text = null)   X-Ref
Constructor, used to input the data

For documentation on all the parameters, see the corresponding
properties and their accessors

__toString()   X-Ref
String-ified version

return: string

get_endtime()   X-Ref
Get the end time

return: string|null Time in the format 'hh:mm:ss.SSS'

get_language()   X-Ref
Get the language

return: string|null Language code as per RFC 3066
link: http://tools.ietf.org/html/rfc3066

get_starttime()   X-Ref
Get the start time

return: string|null Time in the format 'hh:mm:ss.SSS'

get_text()   X-Ref
Get the text of the caption

return: string|null

get_type()   X-Ref
Get the content type (not MIME type)

return: string|null Either 'text' or 'html'