SimplePie_Caption

Handles `` captions as defined in Media RSS.

Defined (1)

The class is defined in the following location(s).

/wp-includes/SimplePie/Caption.php  
  1. class SimplePie_Caption 
  2. { 
  3.     /** 
  4.      * Content type 
  5.      * 
  6.      * @var string 
  7.      * @see get_type() 
  8.      */ 
  9.     var $type; 
  10.  
  11.     /** 
  12.      * Language 
  13.      * 
  14.      * @var string 
  15.      * @see get_language() 
  16.      */ 
  17.     var $lang; 
  18.  
  19.     /** 
  20.      * Start time 
  21.      * 
  22.      * @var string 
  23.      * @see get_starttime() 
  24.      */ 
  25.     var $startTime; 
  26.  
  27.     /** 
  28.      * End time 
  29.      * 
  30.      * @var string 
  31.      * @see get_endtime() 
  32.      */ 
  33.     var $endTime; 
  34.  
  35.     /** 
  36.      * Caption text 
  37.      * 
  38.      * @var string 
  39.      * @see get_text() 
  40.      */ 
  41.     var $text; 
  42.  
  43.     /** 
  44.      * Constructor, used to input the data 
  45.      * 
  46.      * For documentation on all the parameters, see the corresponding 
  47.      * properties and their accessors 
  48.      */ 
  49.     public function __construct($type = null, $lang = null, $startTime = null, $endTime = null, $text = null) 
  50.     { 
  51.         $this->type = $type; 
  52.         $this->lang = $lang; 
  53.         $this->startTime = $startTime; 
  54.         $this->endTime = $endTime; 
  55.         $this->text = $text; 
  56.     } 
  57.  
  58.     /** 
  59.      * String-ified version 
  60.      * 
  61.      * @return string 
  62.      */ 
  63.     public function __toString() 
  64.     { 
  65.         // There is no $this->data here 
  66.         return md5(serialize($this)); 
  67.     } 
  68.  
  69.     /** 
  70.      * Get the end time 
  71.      * 
  72.      * @return string|null Time in the format 'hh:mm:ss.SSS' 
  73.      */ 
  74.     public function get_endtime() 
  75.     { 
  76.         if ($this->endTime !== null) 
  77.         { 
  78.             return $this->endTime; 
  79.         } 
  80.         else 
  81.         { 
  82.             return null; 
  83.         } 
  84.     } 
  85.  
  86.     /** 
  87.      * Get the language 
  88.      * 
  89.      * @link http://tools.ietf.org/html/rfc3066 
  90.      * @return string|null Language code as per RFC 3066 
  91.      */ 
  92.     public function get_language() 
  93.     { 
  94.         if ($this->lang !== null) 
  95.         { 
  96.             return $this->lang; 
  97.         } 
  98.         else 
  99.         { 
  100.             return null; 
  101.         } 
  102.     } 
  103.  
  104.     /** 
  105.      * Get the start time 
  106.      * 
  107.      * @return string|null Time in the format 'hh:mm:ss.SSS' 
  108.      */ 
  109.     public function get_starttime() 
  110.     { 
  111.         if ($this->startTime !== null) 
  112.         { 
  113.             return $this->startTime; 
  114.         } 
  115.         else 
  116.         { 
  117.             return null; 
  118.         } 
  119.     } 
  120.  
  121.     /** 
  122.      * Get the text of the caption 
  123.      * 
  124.      * @return string|null 
  125.      */ 
  126.     public function get_text() 
  127.     { 
  128.         if ($this->text !== null) 
  129.         { 
  130.             return $this->text; 
  131.         } 
  132.         else 
  133.         { 
  134.             return null; 
  135.         } 
  136.     } 
  137.  
  138.     /** 
  139.      * Get the content type (not MIME type) 
  140.      * 
  141.      * @return string|null Either 'text' or 'html' 
  142.      */ 
  143.     public function get_type() 
  144.     { 
  145.         if ($this->type !== null) 
  146.         { 
  147.             return $this->type; 
  148.         } 
  149.         else 
  150.         { 
  151.             return null; 
  152.         } 
  153.     } 
  154. }