Your IP : 216.73.216.43
<?php
declare(strict_types=1);
namespace Laminas\Feed\Writer\Extension\ITunes;
use Laminas\Feed\Uri;
use Laminas\Feed\Writer;
use Laminas\Stdlib\StringUtils;
use Laminas\Stdlib\StringWrapper\StringWrapperInterface;
use function array_key_exists;
use function count;
use function ctype_alpha;
use function ctype_digit;
use function gettype;
use function implode;
use function in_array;
use function is_bool;
use function is_float;
use function is_numeric;
use function is_object;
use function is_string;
use function lcfirst;
use function method_exists;
use function preg_match;
use function sprintf;
use function strlen;
use function substr;
use function trigger_error;
use function ucfirst;
use function var_export;
use const E_USER_DEPRECATED;
class Entry
{
/**
* Array of Feed data for rendering by Extension's renderers
*
* @var array
*/
protected $data = [];
/**
* Encoding of all text values
*
* @var string
*/
protected $encoding = 'UTF-8';
/**
* The used string wrapper supporting encoding
*
* @var StringWrapperInterface
*/
protected $stringWrapper;
public function __construct()
{
$this->stringWrapper = StringUtils::getWrapper($this->encoding);
}
/**
* Set feed encoding
*
* @param string $enc
* @return $this
*/
public function setEncoding($enc)
{
$this->stringWrapper = StringUtils::getWrapper($enc);
$this->encoding = $enc;
return $this;
}
/**
* Get feed encoding
*
* @return string
*/
public function getEncoding()
{
return $this->encoding;
}
/**
* Set a block value of "yes" or "no". You may also set an empty string.
*
* @param string $value
* @throws Writer\Exception\InvalidArgumentException
* @return void
*/
public function setItunesBlock($value)
{
if (! ctype_alpha($value) && strlen($value) > 0) {
throw new Writer\Exception\InvalidArgumentException(
'invalid parameter: "block" may only contain alphabetic characters'
);
}
if ($this->stringWrapper->strlen($value) > 255) {
throw new Writer\Exception\InvalidArgumentException(
'invalid parameter: "block" may only contain a maximum of 255 characters'
);
}
$this->data['block'] = $value;
}
/**
* Add authors to itunes entry
*
* @return $this
*/
public function addItunesAuthors(array $values)
{
foreach ($values as $value) {
$this->addItunesAuthor($value);
}
return $this;
}
/**
* Add author to itunes entry
*
* @param string $value
* @return $this
* @throws Writer\Exception\InvalidArgumentException
*/
public function addItunesAuthor($value)
{
if ($this->stringWrapper->strlen($value) > 255) {
throw new Writer\Exception\InvalidArgumentException(
'invalid parameter: any "author" may only contain a maximum of 255 characters each'
);
}
if (! isset($this->data['authors'])) {
$this->data['authors'] = [];
}
$this->data['authors'][] = $value;
return $this;
}
/**
* Set duration
*
* @param int $value
* @return $this
* @throws Writer\Exception\InvalidArgumentException
*/
public function setItunesDuration($value)
{
$value = (string) $value;
if (
! ctype_digit($value)
&& ! preg_match('/^\d+:[0-5]{1}[0-9]{1}$/', $value)
&& ! preg_match('/^\d+:[0-5]{1}[0-9]{1}:[0-5]{1}[0-9]{1}$/', $value)
) {
throw new Writer\Exception\InvalidArgumentException(
'invalid parameter: "duration" may only be of a specified [[HH:]MM:]SS format'
);
}
$this->data['duration'] = $value;
return $this;
}
/**
* Set "explicit" flag
*
* @see https://help.apple.com/itc/podcasts_connect/#/itcb54353390
*
* @param bool $value
* @return $this
* @throws Writer\Exception\InvalidArgumentException
*/
public function setItunesExplicit($value)
{
// "yes", "no" and "clean" are valid values for a previous version
if (! is_bool($value) && ! in_array($value, ['yes', 'no', 'clean'])) {
throw new Writer\Exception\InvalidArgumentException(
'invalid parameter: "explicit" must be a boolean value'
);
}
switch ($value) {
case 'yes':
$value = true;
break;
case 'no':
case 'clean':
$value = false;
break;
}
$this->data['explicit'] = $value ? 'true' : 'false';
return $this;
}
/**
* Set keywords
*
* @deprecated since 2.10.0; itunes:keywords is no longer part of the
* iTunes podcast RSS specification.
*
* @param string[] $value
* @return $this
* @throws Writer\Exception\InvalidArgumentException
*/
public function setItunesKeywords(array $value)
{
trigger_error(
'itunes:keywords has been deprecated in the iTunes podcast RSS specification,'
. ' and should not be relied on.',
E_USER_DEPRECATED
);
if (count($value) > 12) {
throw new Writer\Exception\InvalidArgumentException(
'invalid parameter: "keywords" may only contain a maximum of 12 terms'
);
}
$concat = implode(',', $value);
if ($this->stringWrapper->strlen($concat) > 255) {
throw new Writer\Exception\InvalidArgumentException(
'invalid parameter: "keywords" may only have a concatenated length'
. ' of 255 chars where terms are delimited by a comma'
);
}
$this->data['keywords'] = $value;
return $this;
}
/**
* Set title
*
* @param string $value
* @return $this
* @throws Writer\Exception\InvalidArgumentException
*/
public function setItunesTitle($value)
{
if ($this->stringWrapper->strlen($value) > 255) {
throw new Writer\Exception\InvalidArgumentException(
'invalid parameter: "title" may only contain a maximum of 255 characters'
);
}
$this->data['title'] = $value;
return $this;
}
/**
* Set subtitle
*
* @param string $value
* @return $this
* @throws Writer\Exception\InvalidArgumentException
*/
public function setItunesSubtitle($value)
{
if ($this->stringWrapper->strlen($value) > 255) {
throw new Writer\Exception\InvalidArgumentException(
'invalid parameter: "subtitle" may only contain a maximum of 255 characters'
);
}
$this->data['subtitle'] = $value;
return $this;
}
/**
* Set summary
*
* @param string $value
* @return $this
* @throws Writer\Exception\InvalidArgumentException
*/
public function setItunesSummary($value)
{
if ($this->stringWrapper->strlen($value) > 4000) {
throw new Writer\Exception\InvalidArgumentException(
'invalid parameter: "summary" may only contain a maximum of 4000 characters'
);
}
$this->data['summary'] = $value;
return $this;
}
/**
* Set entry image (icon)
*
* @param string $value
* @return $this
* @throws Writer\Exception\InvalidArgumentException
*/
public function setItunesImage($value)
{
if (! is_string($value) || ! Uri::factory($value)->isValid()) {
throw new Writer\Exception\InvalidArgumentException(
'invalid parameter: "image" may only be a valid URI/IRI'
);
}
if (! in_array(substr($value, -3), ['jpg', 'png'])) {
throw new Writer\Exception\InvalidArgumentException(
'invalid parameter: "image" may only use file extension "jpg"'
. ' or "png" which must be the last three characters of the URI'
. ' (i.e. no query string or fragment)'
);
}
$this->data['image'] = $value;
return $this;
}
/**
* Set the episode number
*
* @param int $number
* @return $this
* @throws Writer\Exception\InvalidArgumentException
*/
public function setItunesEpisode($number)
{
if (! is_numeric($number) || is_float($number)) {
throw new Writer\Exception\InvalidArgumentException(sprintf(
'invalid parameter: "number" may only be an integer; received %s',
is_object($number) ? $number::class : gettype($number)
));
}
$this->data['episode'] = (int) $number;
return $this;
}
/**
* Set the episode type
*
* @param string $type One of "full", "trailer", or "bonus".
* @return $this
* @throws Writer\Exception\InvalidArgumentException
*/
public function setItunesEpisodeType($type)
{
$validTypes = ['full', 'trailer', 'bonus'];
if (! in_array($type, $validTypes, true)) {
throw new Writer\Exception\InvalidArgumentException(sprintf(
'invalid parameter: "episodeType" MUST be one of the strings [%s]; received %s',
implode(', ', $validTypes),
is_object($type) ? $type::class : var_export($type, true)
));
}
$this->data['episodeType'] = $type;
return $this;
}
/**
* Set the status of closed captioning
*
* @param bool $status
* @return $this
* @throws Writer\Exception\InvalidArgumentException
*/
public function setItunesIsClosedCaptioned($status)
{
if (! is_bool($status)) {
throw new Writer\Exception\InvalidArgumentException(sprintf(
'invalid parameter: "isClosedCaptioned" MUST be a boolean; received %s',
is_object($status) ? $status::class : var_export($status, true)
));
}
if (! $status) {
return $this;
}
$this->data['isClosedCaptioned'] = true;
return $this;
}
/**
* Set the season number to which the episode belongs
*
* @param int $number
* @return $this
* @throws Writer\Exception\InvalidArgumentException
*/
public function setItunesSeason($number)
{
if (! is_numeric($number) || is_float($number)) {
throw new Writer\Exception\InvalidArgumentException(sprintf(
'invalid parameter: "season" may only be an integer; received %s',
is_object($number) ? $number::class : gettype($number)
));
}
$this->data['season'] = (int) $number;
return $this;
}
/**
* Overloading to itunes specific setters
*
* @param string $method
* @return mixed
* @throws Writer\Exception\BadMethodCallException
*/
public function __call($method, array $params)
{
$point = lcfirst(substr($method, 9));
if (
! method_exists($this, 'setItunes' . ucfirst($point))
&& ! method_exists($this, 'addItunes' . ucfirst($point))
) {
throw new Writer\Exception\BadMethodCallException(
'invalid method: ' . $method
);
}
if (
! array_key_exists($point, $this->data)
|| empty($this->data[$point])
) {
return;
}
return $this->data[$point];
}
}