<?php

[0] Fix | Delete

[1] Fix | Delete

// SPDX-FileCopyrightText: 2004-2023 Ryan Parman, Sam Sneddon, Ryan McCue

[2] Fix | Delete

// SPDX-License-Identifier: BSD-3-Clause

[3] Fix | Delete

[4] Fix | Delete

declare(strict_types=1);

[5] Fix | Delete

[6] Fix | Delete

namespace SimplePie;

[7] Fix | Delete

[8] Fix | Delete

/**

[9] Fix | Delete

* Handles `<media:text>` captions as defined in Media RSS.

[10] Fix | Delete

*

[11] Fix | Delete

* Used by {@see \SimplePie\Enclosure::get_caption()} and {@see \SimplePie\Enclosure::get_captions()}

[12] Fix | Delete

*

[13] Fix | Delete

* This class can be overloaded with {@see \SimplePie\SimplePie::set_caption_class()}

[14] Fix | Delete

*/

[15] Fix | Delete

class Caption

[16] Fix | Delete

{

[17] Fix | Delete

/**

[18] Fix | Delete

* Content type

[19] Fix | Delete

*

[20] Fix | Delete

* @var ?string

[21] Fix | Delete

* @see get_type()

[22] Fix | Delete

*/

[23] Fix | Delete

public $type;

[24] Fix | Delete

[25] Fix | Delete

/**

[26] Fix | Delete

* Language

[27] Fix | Delete

*

[28] Fix | Delete

* @var ?string

[29] Fix | Delete

* @see get_language()

[30] Fix | Delete

*/

[31] Fix | Delete

public $lang;

[32] Fix | Delete

[33] Fix | Delete

/**

[34] Fix | Delete

* Start time

[35] Fix | Delete

*

[36] Fix | Delete

* @var ?string

[37] Fix | Delete

* @see get_starttime()

[38] Fix | Delete

*/

[39] Fix | Delete

public $startTime;

[40] Fix | Delete

[41] Fix | Delete

/**

[42] Fix | Delete

* End time

[43] Fix | Delete

*

[44] Fix | Delete

* @var ?string

[45] Fix | Delete

* @see get_endtime()

[46] Fix | Delete

*/

[47] Fix | Delete

public $endTime;

[48] Fix | Delete

[49] Fix | Delete

/**

[50] Fix | Delete

* Caption text

[51] Fix | Delete

*

[52] Fix | Delete

* @var ?string

[53] Fix | Delete

* @see get_text()

[54] Fix | Delete

*/

[55] Fix | Delete

public $text;

[56] Fix | Delete

[57] Fix | Delete

/**

[58] Fix | Delete

* Constructor, used to input the data

[59] Fix | Delete

*

[60] Fix | Delete

* For documentation on all the parameters, see the corresponding

[61] Fix | Delete

* properties and their accessors

[62] Fix | Delete

*/

[63] Fix | Delete

public function __construct(

[64] Fix | Delete

?string $type = null,

[65] Fix | Delete

?string $lang = null,

[66] Fix | Delete

?string $startTime = null,

[67] Fix | Delete

?string $endTime = null,

[68] Fix | Delete

?string $text = null

[69] Fix | Delete

) {

[70] Fix | Delete

$this->type = $type;

[71] Fix | Delete

$this->lang = $lang;

[72] Fix | Delete

$this->startTime = $startTime;

[73] Fix | Delete

$this->endTime = $endTime;

[74] Fix | Delete

$this->text = $text;

[75] Fix | Delete

}

[76] Fix | Delete

[77] Fix | Delete

/**

[78] Fix | Delete

* String-ified version

[79] Fix | Delete

*

[80] Fix | Delete

* @return string

[81] Fix | Delete

*/

[82] Fix | Delete

public function __toString()

[83] Fix | Delete

{

[84] Fix | Delete

// There is no $this->data here

[85] Fix | Delete

return md5(serialize($this));

[86] Fix | Delete

}

[87] Fix | Delete

[88] Fix | Delete

/**

[89] Fix | Delete

* Get the end time

[90] Fix | Delete

*

[91] Fix | Delete

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

[92] Fix | Delete

*/

[93] Fix | Delete

public function get_endtime()

[94] Fix | Delete

{

[95] Fix | Delete

if ($this->endTime !== null) {

[96] Fix | Delete

return $this->endTime;

[97] Fix | Delete

}

[98] Fix | Delete

[99] Fix | Delete

return null;

[100] Fix | Delete

}

[101] Fix | Delete

[102] Fix | Delete

/**

[103] Fix | Delete

* Get the language

[104] Fix | Delete

*

[105] Fix | Delete

* @link http://tools.ietf.org/html/rfc3066

[106] Fix | Delete

* @return string|null Language code as per RFC 3066

[107] Fix | Delete

*/

[108] Fix | Delete

public function get_language()

[109] Fix | Delete

{

[110] Fix | Delete

if ($this->lang !== null) {

[111] Fix | Delete

return $this->lang;

[112] Fix | Delete

}

[113] Fix | Delete

[114] Fix | Delete

return null;

[115] Fix | Delete

}

[116] Fix | Delete

[117] Fix | Delete

/**

[118] Fix | Delete

* Get the start time

[119] Fix | Delete

*

[120] Fix | Delete

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

[121] Fix | Delete

*/

[122] Fix | Delete

public function get_starttime()

[123] Fix | Delete

{

[124] Fix | Delete

if ($this->startTime !== null) {

[125] Fix | Delete

return $this->startTime;

[126] Fix | Delete

}

[127] Fix | Delete

[128] Fix | Delete

return null;

[129] Fix | Delete

}

[130] Fix | Delete

[131] Fix | Delete

/**

[132] Fix | Delete

* Get the text of the caption

[133] Fix | Delete

*

[134] Fix | Delete

* @return string|null

[135] Fix | Delete

*/

[136] Fix | Delete

public function get_text()

[137] Fix | Delete

{

[138] Fix | Delete

if ($this->text !== null) {

[139] Fix | Delete

return $this->text;

[140] Fix | Delete

}

[141] Fix | Delete

[142] Fix | Delete

return null;

[143] Fix | Delete

}

[144] Fix | Delete

[145] Fix | Delete

/**

[146] Fix | Delete

* Get the content type (not MIME type)

[147] Fix | Delete

*

[148] Fix | Delete

* @return string|null Either 'text' or 'html'

[149] Fix | Delete

*/

[150] Fix | Delete

public function get_type()

[151] Fix | Delete

{

[152] Fix | Delete

if ($this->type !== null) {

[153] Fix | Delete

return $this->type;

[154] Fix | Delete

}

[155] Fix | Delete

[156] Fix | Delete

return null;

[157] Fix | Delete

}

[158] Fix | Delete

}

[159] Fix | Delete

[160] Fix | Delete

class_alias('SimplePie\Caption', 'SimplePie_Caption');

[161] Fix | Delete

[162] Fix | Delete