SimplePie: PHP-based RSS and Atom feed handling
 
  • Overview
  • Demo
  • Blog
  • Download
  • Documentation
  • API Docs
  • Support
  • Issue Tracker
  • FAQ
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated

Packages

  • SimplePie
    • API
    • Caching
    • HTTP
    • Parsing

Classes

  • SimplePie
  • SimplePie_Author
  • SimplePie_Caption
  • SimplePie_Category
  • SimplePie_Copyright
  • SimplePie_Core
  • SimplePie_Credit
  • SimplePie_Enclosure
  • SimplePie_Item
  • SimplePie_Rating
  • SimplePie_Restriction
  • SimplePie_Source

Class SimplePie_Caption

Handles <media:text> 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\API
Copyright: 2004-2012 Ryan Parman, Geoffrey Sneddon, Ryan McCue
License: BSD License
Author: Ryan Parman
Author: Geoffrey Sneddon
Author: Ryan McCue
Located at SimplePie/Caption.php
Methods summary
public
# __construct( $type = null, $lang = null, $startTime = null, $endTime = null, $text = null )

Constructor, used to input the data

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

public string
# __toString( )

String-ified version

Returns

string
public string|null
# get_endtime( )

Get the end time

Returns

string|null
Time in the format 'hh:mm:ss.SSS'
public string|null
# get_language( )

Get the language

Returns

string|null
Language code as per RFC 3066

Link

http://tools.ietf.org/html/rfc3066
public string|null
# get_starttime( )

Get the start time

Returns

string|null
Time in the format 'hh:mm:ss.SSS'
public string|null
# get_text( )

Get the text of the caption

Returns

string|null
public string|null
# get_type( )

Get the content type (not MIME type)

Returns

string|null
Either 'text' or 'html'
Properties summary
public string $type
#

Content type

See

SimplePie_Caption::get_type()
public string $lang
#

Language

See

SimplePie_Caption::get_language()
public string $startTime
#

Start time

See

SimplePie_Caption::get_starttime()
public string $endTime
#

End time

See

SimplePie_Caption::get_endtime()
public string $text
#

Caption text

See

SimplePie_Caption::get_text()

Show some love! Wishlists for Geoffrey, Ryan P., and Ryan M.

SimplePie is © 2004–2012 Ryan Parman, Geoffrey Sneddon, Ryan McCue and contributors. Licensed under the BSD License. Hosted thanks to Matt Mullenweg, API documentation generated by ApiGen 2.6.1. Variation on the Feed Icon by Wolfgang Bartelme.