API Documentation
Back to top  

Handles `` captions as defined in Media RSS.

Used by \SimplePie_Enclosure::get_caption() and \SimplePie_Enclosure::get_captions()

This class can be overloaded with \SimplePie::set_caption_class()

package SimplePie
subpackage API

 Methods

Constructor, used to input the data

__construct($type = null, $lang = null, $startTime = null, $endTime = null, $text = null) 

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

Parameters

$type

$lang

$startTime

$endTime

$text

String-ified version

__toString() : string

Returns

string

Get the end time

get_endtime() : string | null

Returns

stringnullTime in the format 'hh:mm:ss.SSS'

Get the language

get_language() : string | null
link http://tools.ietf.org/html/rfc3066

Returns

stringnullLanguage code as per RFC 3066

Get the start time

get_starttime() : string | null

Returns

stringnullTime in the format 'hh:mm:ss.SSS'

Get the text of the caption

get_text() : string | null

Returns

stringnull

Get the content type (not MIME type)

get_type() : string | null

Returns

stringnullEither 'text' or 'html'

 Properties

 

End time

$endTime : string

Default

see
 

Language

$lang : string

Default

see
 

Start time

$startTime : string

Default

see
 

Caption text

$text : string

Default

see
 

Content type

$type : string

Default

see