<?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 everything related to enclosures (including Media RSS and iTunes RSS)

[10] Fix | Delete

*

[11] Fix | Delete

* Used by {@see \SimplePie\Item::get_enclosure()} and {@see \SimplePie\Item::get_enclosures()}

[12] Fix | Delete

*

[13] Fix | Delete

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

[14] Fix | Delete

*/

[15] Fix | Delete

class Enclosure

[16] Fix | Delete

{

[17] Fix | Delete

/**

[18] Fix | Delete

* @var ?string

[19] Fix | Delete

* @see get_bitrate()

[20] Fix | Delete

*/

[21] Fix | Delete

public $bitrate;

[22] Fix | Delete

[23] Fix | Delete

/**

[24] Fix | Delete

* @var Caption[]|null

[25] Fix | Delete

* @see get_captions()

[26] Fix | Delete

*/

[27] Fix | Delete

public $captions;

[28] Fix | Delete

[29] Fix | Delete

/**

[30] Fix | Delete

* @var Category[]|null

[31] Fix | Delete

* @see get_categories()

[32] Fix | Delete

*/

[33] Fix | Delete

public $categories;

[34] Fix | Delete

[35] Fix | Delete

/**

[36] Fix | Delete

* @var ?int

[37] Fix | Delete

* @see get_channels()

[38] Fix | Delete

*/

[39] Fix | Delete

public $channels;

[40] Fix | Delete

[41] Fix | Delete

/**

[42] Fix | Delete

* @var ?Copyright

[43] Fix | Delete

* @see get_copyright()

[44] Fix | Delete

*/

[45] Fix | Delete

public $copyright;

[46] Fix | Delete

[47] Fix | Delete

/**

[48] Fix | Delete

* @var Credit[]|null

[49] Fix | Delete

* @see get_credits()

[50] Fix | Delete

*/

[51] Fix | Delete

public $credits;

[52] Fix | Delete

[53] Fix | Delete

/**

[54] Fix | Delete

* @var ?string

[55] Fix | Delete

* @see get_description()

[56] Fix | Delete

*/

[57] Fix | Delete

public $description;

[58] Fix | Delete

[59] Fix | Delete

/**

[60] Fix | Delete

* @var ?int

[61] Fix | Delete

* @see get_duration()

[62] Fix | Delete

*/

[63] Fix | Delete

public $duration;

[64] Fix | Delete

[65] Fix | Delete

/**

[66] Fix | Delete

* @var ?string

[67] Fix | Delete

* @see get_expression()

[68] Fix | Delete

*/

[69] Fix | Delete

public $expression;

[70] Fix | Delete

[71] Fix | Delete

/**

[72] Fix | Delete

* @var ?string

[73] Fix | Delete

* @see get_framerate()

[74] Fix | Delete

*/

[75] Fix | Delete

public $framerate;

[76] Fix | Delete

[77] Fix | Delete

/**

[78] Fix | Delete

* @var ?string

[79] Fix | Delete

* @see get_handler()

[80] Fix | Delete

*/

[81] Fix | Delete

public $handler;

[82] Fix | Delete

[83] Fix | Delete

/**

[84] Fix | Delete

* @var string[]|null

[85] Fix | Delete

* @see get_hashes()

[86] Fix | Delete

*/

[87] Fix | Delete

public $hashes;

[88] Fix | Delete

[89] Fix | Delete

/**

[90] Fix | Delete

* @var ?string

[91] Fix | Delete

* @see get_height()

[92] Fix | Delete

*/

[93] Fix | Delete

public $height;

[94] Fix | Delete

[95] Fix | Delete

/**

[96] Fix | Delete

* @deprecated

[97] Fix | Delete

* @var null

[98] Fix | Delete

*/

[99] Fix | Delete

public $javascript;

[100] Fix | Delete

[101] Fix | Delete

/**

[102] Fix | Delete

* @var string[]|null

[103] Fix | Delete

* @see get_keywords()

[104] Fix | Delete

*/

[105] Fix | Delete

public $keywords;

[106] Fix | Delete

[107] Fix | Delete

/**

[108] Fix | Delete

* @var ?string

[109] Fix | Delete

* @see get_language()

[110] Fix | Delete

*/

[111] Fix | Delete

public $lang;

[112] Fix | Delete

[113] Fix | Delete

/**

[114] Fix | Delete

* @var ?int

[115] Fix | Delete

* @see get_length()

[116] Fix | Delete

*/

[117] Fix | Delete

public $length;

[118] Fix | Delete

[119] Fix | Delete

/**

[120] Fix | Delete

* @var ?string

[121] Fix | Delete

* @see get_link()

[122] Fix | Delete

*/

[123] Fix | Delete

public $link;

[124] Fix | Delete

[125] Fix | Delete

/**

[126] Fix | Delete

* @var ?string

[127] Fix | Delete

* @see get_medium()

[128] Fix | Delete

*/

[129] Fix | Delete

public $medium;

[130] Fix | Delete

[131] Fix | Delete

/**

[132] Fix | Delete

* @var ?string

[133] Fix | Delete

* @see get_player()

[134] Fix | Delete

*/

[135] Fix | Delete

public $player;

[136] Fix | Delete

[137] Fix | Delete

/**

[138] Fix | Delete

* @var Rating[]|null

[139] Fix | Delete

* @see get_ratings()

[140] Fix | Delete

*/

[141] Fix | Delete

public $ratings;

[142] Fix | Delete

[143] Fix | Delete

/**

[144] Fix | Delete

* @var ?Restriction[]

[145] Fix | Delete

* @see get_restrictions()

[146] Fix | Delete

*/

[147] Fix | Delete

public $restrictions;

[148] Fix | Delete

[149] Fix | Delete

/**

[150] Fix | Delete

* @var ?string

[151] Fix | Delete

* @see get_sampling_rate()

[152] Fix | Delete

*/

[153] Fix | Delete

public $samplingrate;

[154] Fix | Delete

[155] Fix | Delete

/**

[156] Fix | Delete

* @var string[]|null

[157] Fix | Delete

* @see get_thumbnails()

[158] Fix | Delete

*/

[159] Fix | Delete

public $thumbnails;

[160] Fix | Delete

[161] Fix | Delete

/**

[162] Fix | Delete

* @var ?string

[163] Fix | Delete

* @see get_title()

[164] Fix | Delete

*/

[165] Fix | Delete

public $title;

[166] Fix | Delete

[167] Fix | Delete

/**

[168] Fix | Delete

* @var ?string

[169] Fix | Delete

* @see get_type()

[170] Fix | Delete

*/

[171] Fix | Delete

public $type;

[172] Fix | Delete

[173] Fix | Delete

/**

[174] Fix | Delete

* @var ?string

[175] Fix | Delete

* @see get_width()

[176] Fix | Delete

*/

[177] Fix | Delete

public $width;

[178] Fix | Delete

[179] Fix | Delete

/**

[180] Fix | Delete

* Constructor, used to input the data

[181] Fix | Delete

*

[182] Fix | Delete

* For documentation on all the parameters, see the corresponding

[183] Fix | Delete

* properties and their accessors

[184] Fix | Delete

*

[185] Fix | Delete

* @uses idn_to_ascii If available, this will convert an IDN

[186] Fix | Delete

*

[187] Fix | Delete

* @param null $javascript

[188] Fix | Delete

* @param Caption[]|null $captions

[189] Fix | Delete

* @param Category[]|null $categories

[190] Fix | Delete

* @param Credit[]|null $credits

[191] Fix | Delete

* @param string[]|null $hashes

[192] Fix | Delete

* @param string[]|null $keywords

[193] Fix | Delete

* @param Rating[]|null $ratings

[194] Fix | Delete

* @param Restriction[]|null $restrictions

[195] Fix | Delete

* @param string[]|null $thumbnails

[196] Fix | Delete

*/

[197] Fix | Delete

public function __construct(

[198] Fix | Delete

?string $link = null,

[199] Fix | Delete

?string $type = null,

[200] Fix | Delete

?int $length = null,

[201] Fix | Delete

$javascript = null,

[202] Fix | Delete

?string $bitrate = null,

[203] Fix | Delete

?array $captions = null,

[204] Fix | Delete

?array $categories = null,

[205] Fix | Delete

?int $channels = null,

[206] Fix | Delete

?Copyright $copyright = null,

[207] Fix | Delete

?array $credits = null,

[208] Fix | Delete

?string $description = null,

[209] Fix | Delete

?int $duration = null,

[210] Fix | Delete

?string $expression = null,

[211] Fix | Delete

?string $framerate = null,

[212] Fix | Delete

?array $hashes = null,

[213] Fix | Delete

?string $height = null,

[214] Fix | Delete

?array $keywords = null,

[215] Fix | Delete

?string $lang = null,

[216] Fix | Delete

?string $medium = null,

[217] Fix | Delete

?string $player = null,

[218] Fix | Delete

?array $ratings = null,

[219] Fix | Delete

?array $restrictions = null,

[220] Fix | Delete

?string $samplingrate = null,

[221] Fix | Delete

?array $thumbnails = null,

[222] Fix | Delete

?string $title = null,

[223] Fix | Delete

?string $width = null

[224] Fix | Delete

) {

[225] Fix | Delete

$this->bitrate = $bitrate;

[226] Fix | Delete

$this->captions = $captions;

[227] Fix | Delete

$this->categories = $categories;

[228] Fix | Delete

$this->channels = $channels;

[229] Fix | Delete

$this->copyright = $copyright;

[230] Fix | Delete

$this->credits = $credits;

[231] Fix | Delete

$this->description = $description;

[232] Fix | Delete

$this->duration = $duration;

[233] Fix | Delete

$this->expression = $expression;

[234] Fix | Delete

$this->framerate = $framerate;

[235] Fix | Delete

$this->hashes = $hashes;

[236] Fix | Delete

$this->height = $height;

[237] Fix | Delete

$this->keywords = $keywords;

[238] Fix | Delete

$this->lang = $lang;

[239] Fix | Delete

$this->length = $length;

[240] Fix | Delete

$this->link = $link;

[241] Fix | Delete

$this->medium = $medium;

[242] Fix | Delete

$this->player = $player;

[243] Fix | Delete

$this->ratings = $ratings;

[244] Fix | Delete

$this->restrictions = $restrictions;

[245] Fix | Delete

$this->samplingrate = $samplingrate;

[246] Fix | Delete

$this->thumbnails = $thumbnails;

[247] Fix | Delete

$this->title = $title;

[248] Fix | Delete

$this->type = $type;

[249] Fix | Delete

$this->width = $width;

[250] Fix | Delete

[251] Fix | Delete

if (function_exists('idn_to_ascii')) {

[252] Fix | Delete

$parsed = \SimplePie\Misc::parse_url($link ?? '');

[253] Fix | Delete

if ($parsed['authority'] !== '' && !ctype_print($parsed['authority'])) {

[254] Fix | Delete

$authority = (string) \idn_to_ascii($parsed['authority'], \IDNA_NONTRANSITIONAL_TO_ASCII, \INTL_IDNA_VARIANT_UTS46);

[255] Fix | Delete

$this->link = \SimplePie\Misc::compress_parse_url($parsed['scheme'], $authority, $parsed['path'], $parsed['query'], $parsed['fragment']);

[256] Fix | Delete

}

[257] Fix | Delete

}

[258] Fix | Delete

$this->handler = $this->get_handler(); // Needs to load last

[259] Fix | Delete

}

[260] Fix | Delete

[261] Fix | Delete

/**

[262] Fix | Delete

* String-ified version

[263] Fix | Delete

*

[264] Fix | Delete

* @return string

[265] Fix | Delete

*/

[266] Fix | Delete

public function __toString()

[267] Fix | Delete

{

[268] Fix | Delete

// There is no $this->data here

[269] Fix | Delete

return md5(serialize($this));

[270] Fix | Delete

}

[271] Fix | Delete

[272] Fix | Delete

/**

[273] Fix | Delete

* Get the bitrate

[274] Fix | Delete

*

[275] Fix | Delete

* @return string|null

[276] Fix | Delete

*/

[277] Fix | Delete

public function get_bitrate()

[278] Fix | Delete

{

[279] Fix | Delete

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

[280] Fix | Delete

return $this->bitrate;

[281] Fix | Delete

}

[282] Fix | Delete

[283] Fix | Delete

return null;

[284] Fix | Delete

}

[285] Fix | Delete

[286] Fix | Delete

/**

[287] Fix | Delete

* Get a single caption

[288] Fix | Delete

*

[289] Fix | Delete

* @param int $key

[290] Fix | Delete

* @return \SimplePie\Caption|null

[291] Fix | Delete

*/

[292] Fix | Delete

public function get_caption(int $key = 0)

[293] Fix | Delete

{

[294] Fix | Delete

$captions = $this->get_captions();

[295] Fix | Delete

if (isset($captions[$key])) {

[296] Fix | Delete

return $captions[$key];

[297] Fix | Delete

}

[298] Fix | Delete

[299] Fix | Delete

return null;

[300] Fix | Delete

}

[301] Fix | Delete

[302] Fix | Delete

/**

[303] Fix | Delete

* Get all captions

[304] Fix | Delete

*

[305] Fix | Delete

* @return Caption[]|null

[306] Fix | Delete

*/

[307] Fix | Delete

public function get_captions()

[308] Fix | Delete

{

[309] Fix | Delete

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

[310] Fix | Delete

return $this->captions;

[311] Fix | Delete

}

[312] Fix | Delete

[313] Fix | Delete

return null;

[314] Fix | Delete

}

[315] Fix | Delete

[316] Fix | Delete

/**

[317] Fix | Delete

* Get a single category

[318] Fix | Delete

*

[319] Fix | Delete

* @param int $key

[320] Fix | Delete

* @return \SimplePie\Category|null

[321] Fix | Delete

*/

[322] Fix | Delete

public function get_category(int $key = 0)

[323] Fix | Delete

{

[324] Fix | Delete

$categories = $this->get_categories();

[325] Fix | Delete

if (isset($categories[$key])) {

[326] Fix | Delete

return $categories[$key];

[327] Fix | Delete

}

[328] Fix | Delete

[329] Fix | Delete

return null;

[330] Fix | Delete

}

[331] Fix | Delete

[332] Fix | Delete

/**

[333] Fix | Delete

* Get all categories

[334] Fix | Delete

*

[335] Fix | Delete

* @return \SimplePie\Category[]|null

[336] Fix | Delete

*/

[337] Fix | Delete

public function get_categories()

[338] Fix | Delete

{

[339] Fix | Delete

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

[340] Fix | Delete

return $this->categories;

[341] Fix | Delete

}

[342] Fix | Delete

[343] Fix | Delete

return null;

[344] Fix | Delete

}

[345] Fix | Delete

[346] Fix | Delete

/**

[347] Fix | Delete

* Get the number of audio channels

[348] Fix | Delete

*

[349] Fix | Delete

* @return int|null

[350] Fix | Delete

*/

[351] Fix | Delete

public function get_channels()

[352] Fix | Delete

{

[353] Fix | Delete

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

[354] Fix | Delete

return $this->channels;

[355] Fix | Delete

}

[356] Fix | Delete

[357] Fix | Delete

return null;

[358] Fix | Delete

}

[359] Fix | Delete

[360] Fix | Delete

/**

[361] Fix | Delete

* Get the copyright information

[362] Fix | Delete

*

[363] Fix | Delete

* @return \SimplePie\Copyright|null

[364] Fix | Delete

*/

[365] Fix | Delete

public function get_copyright()

[366] Fix | Delete

{

[367] Fix | Delete

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

[368] Fix | Delete

return $this->copyright;

[369] Fix | Delete

}

[370] Fix | Delete

[371] Fix | Delete

return null;

[372] Fix | Delete

}

[373] Fix | Delete

[374] Fix | Delete

/**

[375] Fix | Delete

* Get a single credit

[376] Fix | Delete

*

[377] Fix | Delete

* @param int $key

[378] Fix | Delete

* @return \SimplePie\Credit|null

[379] Fix | Delete

*/

[380] Fix | Delete

public function get_credit(int $key = 0)

[381] Fix | Delete

{

[382] Fix | Delete

$credits = $this->get_credits();

[383] Fix | Delete

if (isset($credits[$key])) {

[384] Fix | Delete

return $credits[$key];

[385] Fix | Delete

}

[386] Fix | Delete

[387] Fix | Delete

return null;

[388] Fix | Delete

}

[389] Fix | Delete

[390] Fix | Delete

/**

[391] Fix | Delete

* Get all credits

[392] Fix | Delete

*

[393] Fix | Delete

* @return Credit[]|null

[394] Fix | Delete

*/

[395] Fix | Delete

public function get_credits()

[396] Fix | Delete

{

[397] Fix | Delete

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

[398] Fix | Delete

return $this->credits;

[399] Fix | Delete

}

[400] Fix | Delete

[401] Fix | Delete

return null;

[402] Fix | Delete

}

[403] Fix | Delete

[404] Fix | Delete

/**

[405] Fix | Delete

* Get the description of the enclosure

[406] Fix | Delete

*

[407] Fix | Delete

* @return string|null

[408] Fix | Delete

*/

[409] Fix | Delete

public function get_description()

[410] Fix | Delete

{

[411] Fix | Delete

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

[412] Fix | Delete

return $this->description;

[413] Fix | Delete

}

[414] Fix | Delete

[415] Fix | Delete

return null;

[416] Fix | Delete

}

[417] Fix | Delete

[418] Fix | Delete

/**

[419] Fix | Delete

* Get the duration of the enclosure

[420] Fix | Delete

*

[421] Fix | Delete

* @param bool $convert Convert seconds into hh:mm:ss

[422] Fix | Delete

* @return string|int|null 'hh:mm:ss' string if `$convert` was specified, otherwise integer (or null if none found)

[423] Fix | Delete

*/

[424] Fix | Delete

public function get_duration(bool $convert = false)

[425] Fix | Delete

{

[426] Fix | Delete

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

[427] Fix | Delete

if ($convert) {

[428] Fix | Delete

$time = \SimplePie\Misc::time_hms($this->duration);

[429] Fix | Delete

return $time;

[430] Fix | Delete

}

[431] Fix | Delete

[432] Fix | Delete

return $this->duration;

[433] Fix | Delete

}

[434] Fix | Delete

[435] Fix | Delete

return null;

[436] Fix | Delete

}

[437] Fix | Delete

[438] Fix | Delete

/**

[439] Fix | Delete

* Get the expression

[440] Fix | Delete

*

[441] Fix | Delete

* @return string Probably one of 'sample', 'full', 'nonstop', 'clip'. Defaults to 'full'

[442] Fix | Delete

*/

[443] Fix | Delete

public function get_expression()

[444] Fix | Delete

{

[445] Fix | Delete

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

[446] Fix | Delete

return $this->expression;

[447] Fix | Delete

}

[448] Fix | Delete

[449] Fix | Delete

return 'full';

[450] Fix | Delete

}

[451] Fix | Delete

[452] Fix | Delete

/**

[453] Fix | Delete

* Get the file extension

[454] Fix | Delete

*

[455] Fix | Delete

* @return string|null

[456] Fix | Delete

*/

[457] Fix | Delete

public function get_extension()

[458] Fix | Delete

{

[459] Fix | Delete

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

[460] Fix | Delete

$url = \SimplePie\Misc::parse_url($this->link);

[461] Fix | Delete

if ($url['path'] !== '') {

[462] Fix | Delete

return pathinfo($url['path'], PATHINFO_EXTENSION);

[463] Fix | Delete

}

[464] Fix | Delete

}

[465] Fix | Delete

return null;

[466] Fix | Delete

}

[467] Fix | Delete

[468] Fix | Delete

/**

[469] Fix | Delete

* Get the framerate (in frames-per-second)

[470] Fix | Delete

*

[471] Fix | Delete

* @return string|null

[472] Fix | Delete

*/

[473] Fix | Delete

public function get_framerate()

[474] Fix | Delete

{

[475] Fix | Delete

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

[476] Fix | Delete

return $this->framerate;

[477] Fix | Delete

}

[478] Fix | Delete

[479] Fix | Delete

return null;

[480] Fix | Delete

}

[481] Fix | Delete

[482] Fix | Delete

/**

[483] Fix | Delete

* Get the preferred handler

[484] Fix | Delete

*

[485] Fix | Delete

* @return string|null One of 'flash', 'fmedia', 'quicktime', 'wmedia', 'mp3'

[486] Fix | Delete

*/

[487] Fix | Delete

public function get_handler()

[488] Fix | Delete

{

[489] Fix | Delete

return $this->get_real_type(true);

[490] Fix | Delete

}

[491] Fix | Delete

[492] Fix | Delete

/**

[493] Fix | Delete

* Get a single hash

[494] Fix | Delete

*

[495] Fix | Delete

* @link http://www.rssboard.org/media-rss#media-hash

[496] Fix | Delete

* @param int $key

[497] Fix | Delete

* @return string|null Hash as per `media:hash`, prefixed with "$algo:"

[498] Fix | Delete

*/

[499] Fix | Delete