*/ protected $liveItems = []; /** * A pointer for the iterator to keep track of the live items array * * @var int */ protected $liveItemKey = 0; /** * 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 */ public function setEncoding(string $enc): Feed { $this->stringWrapper = StringUtils::getWrapper($enc); $this->encoding = $enc; return $this; } /** * Get feed encoding */ public function getEncoding(): string { return $this->encoding; } /** * Set a locked value of "yes" or "no" with an "owner" field. * * @param LockedArray $value * @throws Writer\Exception\InvalidArgumentException */ public function setPodcastIndexLocked(array $value): Feed { $this->data['locked'] = Validator::validateLocked($value); return $this; } /** * Sets a single feed funding tag. * * @deprecated Use `setPodcastIndexFundings()` or `addPodcastIndexFunding()` instead. * * @param FundingArray $value * @return $this */ public function setPodcastIndexFunding(array $value): Feed { $this->data['funding'] = Validator::validateFunding($value); return $this; } /** * Adds a feed funding tag. * * @param FundingArray $value * @return $this */ public function addPodcastIndexFunding(array $value): self { if (! isset($this->data['fundings'])) { $this->data['fundings'] = []; } /** @var list $this->data['fundings'] */ $this->data['fundings'][] = Validator::validateFunding($value); return $this; } /** * Set multiple funding tags * * @param list $values * @return $this */ public function setPodcastIndexFundings(array $values = []): self { $this->data['fundings'] = []; foreach ($values as $value) { $this->addPodcastIndexFunding($value); } return $this; } /** * Set feed license * * @param LicenseArray $value * @return $this */ public function setPodcastIndexLicense(array $value): self { $this->data['license'] = Validator::validateLicense($value); return $this; } /** * Sets a single feed location tag * * @deprecated Use `setPodcastIndexLocations()` or `addPodcastIndexLocation()` instead. * * @param LocationArray $value * @return $this */ public function setPodcastIndexLocation(array $value): self { $this->data['location'] = Validator::validateLocation($value); return $this; } /** * Adds a feed location tag. * * @param LocationArray $value * @return $this */ public function addPodcastIndexLocation(array $value): self { if (! isset($this->data['locations'])) { $this->data['locations'] = []; } /** @var list $this->data['locations'] */ $this->data['locations'][] = Validator::validateLocation($value); return $this; } /** * Sets multiple location tags * * @param list $values * @return $this */ public function setPodcastIndexLocations(array $values = []): self { $this->data['locations'] = []; foreach ($values as $value) { $this->addPodcastIndexLocation($value); } return $this; } /** * Sets a single `images` element with a srcset value. * _Note: The namespace `images` is deprecated in PodcastIndex. * Instead, you may set one or more `image` tags using the `setPodcastIndexDetailedImages()` method._ * * @deprecated * * @param ImagesArray $value * @return $this */ public function setPodcastIndexImages(array $value): self { $this->data['images'] = Validator::validateImages($value); return $this; } /** * Adds a feed `image` element. * * @param DetailedImageArray $value * @return $this */ public function addPodcastIndexDetailedImage(array $value): self { if (! isset($this->data['detailedImages'])) { $this->data['detailedImages'] = []; } /** @var list $this->data['detailedImages'] */ $this->data['detailedImages'][] = Validator::validateDetailedImage($value); return $this; } /** * Sets multiple feed `image` elements. * If no argument is passed, all existing image entries are removed. * * @param list $values * @return $this */ public function setPodcastIndexDetailedImages(array $values = []): self { $this->data['detailedImages'] = []; foreach ($values as $value) { $this->addPodcastIndexDetailedImage($value); } return $this; } /** * Set feed update frequency * * @param UpdateFrequencyArray $value * @return $this */ public function setPodcastIndexUpdateFrequency(array $value): self { $this->data['updateFrequency'] = Validator::validateUpdateFrequency($value); return $this; } /** * Add feed person * * @psalm-param PersonArray $value * @return $this */ public function addPodcastIndexPerson(array $value): self { if (! isset($this->data['people'])) { $this->data['people'] = []; } /** @var list $this->data['people'] */ $this->data['people'][] = Validator::validatePerson($value); return $this; } /** * Set a new array of people. * If no argument is passed, all existing person entries are removed. * * @psalm-param list $values * @return $this */ public function setPodcastIndexPeople(array $values = []): self { $this->data['people'] = []; foreach ($values as $value) { $this->addPodcastIndexPerson($value); } return $this; } /** * Set a new array of persons. (alias of setPodcastIndexPeople) * If no argument is passed, all existing person entries are removed. * * @psalm-param list $values * @return $this */ public function setPodcastIndexPersons(array $values = []): self { return $this->setPodcastIndexPeople($values); } /** * Set feed trailer * * @param TrailerArray $value * @return $this */ public function setPodcastIndexTrailer(array $value): self { $this->data['trailer'] = Validator::validateTrailer($value); return $this; } /** * Set feed guid * * @param array{value: string} $value * @return $this */ public function setPodcastIndexGuid(array $value): self { $this->data['guid'] = Validator::validateGuid($value); return $this; } /** * Set feed medium * * @param array{value: string} $value * @return $this */ public function setPodcastIndexMedium(array $value): self { $this->data['medium'] = Validator::validateMedium($value); return $this; } /** * Add feed block * * @param BlockArray $value * @return $this */ public function addPodcastIndexBlock(array $value): self { if (! isset($this->data['blocks'])) { $this->data['blocks'] = []; } /** @var list $this->data['blocks'] */ $this->data['blocks'][] = Validator::validateBlock($value); return $this; } /** * Set a new array of blocks. * If no argument is passed, it will just remove all existing block entries. * * @psalm-param list $values * @return $this */ public function setPodcastIndexBlocks(array $values = []): self { $this->data['blocks'] = []; foreach ($values as $value) { $this->addPodcastIndexBlock($value); } return $this; } /** * Add feed txt * * @param TxtArray $value * @return $this */ public function addPodcastIndexTxt(array $value): self { if (! isset($this->data['txts'])) { $this->data['txts'] = []; } /** @var list $this->data['txts'] */ $this->data['txts'][] = Validator::validateTxt($value); return $this; } /** * Set a new array of txts. * If no argument is passed, it will just remove all existing txt entries. * * @psalm-param list $values * @return $this */ public function setPodcastIndexTxts(array $values = []): self { $this->data['txts'] = []; foreach ($values as $value) { $this->addPodcastIndexTxt($value); } return $this; } /** * Set feed podping * * @param array{usesPodping: bool} $value * @return $this */ public function setPodcastIndexPodping(array $value): self { $this->data['podping'] = Validator::validatePodping($value); return $this; } /** * Add a feed remote item. * The remote item will be treated as a direct child of the current channel element. * To create remote items as nested children of other elements, use their respective methods instead. * * @param RemoteItemArray $value * @return $this */ public function addPodcastIndexRemoteItem(array $value): self { if (! isset($this->data['remoteItems'])) { $this->data['remoteItems'] = []; } /** @var list $this->data['remoteItems'] */ $this->data['remoteItems'][] = Validator::validateRemoteItem($value); return $this; } /** * Create a new set of remote items for the feed. * If no argument is passed, it will just remove all existing remote items of this feed. * The remote items will be treated as direct children of the current channel element. * If they should be treated as nested children of other elements, use their respective methods instead. * * @psalm-param list $values * @return $this */ public function setPodcastIndexRemoteItems(array $values = []): self { $this->data['remoteItems'] = []; foreach ($values as $value) { $this->addPodcastIndexRemoteItem($value); } return $this; } /** * Set a podroll element with and array of remote items * that will be set as the podroll's child elements. * If no argument is passed, it will remove the entire podroll entry and all its nested remote items. * * @psalm-param list $values * @return $this */ public function setPodcastIndexPodroll(array $values = []): self { $this->data['podroll'] = []; foreach ($values as $value) { $this->addPodcastIndexPodrollRemoteItem($value); } return $this; } /** * Add a remote item to the podroll element. * * @psalm-param RemoteItemArray $value * @return $this */ public function addPodcastIndexPodrollRemoteItem(array $value): self { if (! isset($this->data['podroll'])) { $this->data['podroll'] = []; } /** @var list $this->data['podroll'] */ $this->data['podroll'][] = Validator::validateRemoteItem($value); return $this; } /** * Set a publisher element. * It contains exactly one remote item as child element * and expects only an array of the remote item attributes. * * @psalm-param RemoteItemArray $value * @return $this */ public function setPodcastIndexPublisher(array $value): self { $this->data['publisher'] = Validator::validateRemoteItem($value); return $this; } /** * Reset all value elements. * All value entries will be removed, including their nested valueRecipients. * * @return $this */ public function resetPodcastIndexValues(): self { $this->data['values'] = []; return $this; } /** * Add a value element with one or more valueRecipients as children. * The method expects one array with the value attributes as first argument * and an array of arrays with the valueRecipients' attributes as second argument. * * @psalm-param ValueArray $value * @psalm-param list $valueRecipients * @return $this * @throws Writer\Exception\InvalidArgumentException */ public function addPodcastIndexValue(array $value, array $valueRecipients): self { if (count($valueRecipients) < 1) { throw new Writer\Exception\InvalidArgumentException( 'invalid parameter: the second argument of "value" must be an array ' . 'containing one or more "valueRecipients"' ); } $value = Validator::validateValue($value); foreach ($valueRecipients as $valueRecipient) { $value['valueRecipients'][] = Validator::validateValueRecipient($valueRecipient); } if (! isset($this->data['values'])) { $this->data['values'] = []; } /** @var list $this->data['values'] */ $this->data['values'][] = $value; return $this; } /** * Add a social interact for the feed. * * @param SocialInteractArray $value * @return $this */ public function addPodcastIndexSocialInteract(array $value): self { if (! isset($this->data['socialInteracts'])) { $this->data['socialInteracts'] = []; } /** @var list $this->data['socialInteracts'] */ $this->data['socialInteracts'][] = Validator::validateSocialInteract($value); return $this; } /** * Create a new set of social interacts for the feed. * If no argument is passed, any existing social interact entry will be removed. * * @psalm-param list $values * @return $this */ public function setPodcastIndexSocialInteracts(array $values = []): self { $this->data['socialInteracts'] = []; foreach ($values as $value) { $this->addPodcastIndexSocialInteract($value); } return $this; } /** * Creates a new Laminas\Feed\Writer\Extension\PodcastIndex\LiveItem data container for use. * This is NOT added to the current feed automatically, but is necessary to create a * container with some initial values preset based on the current feed data. * * @param LiveItemArray $value */ public function createPodcastIndexLiveItem(array $value): LiveItem { $value = Validator::validateLiveItem($value); $liveItem = new LiveItem($value); if ($this->getEncoding()) { $liveItem->setEncoding($this->getEncoding()); } return $liveItem; } /** * Appends a Laminas\Feed\Writer\Extension\PodcastIndex\LiveItem object. * * @return $this */ public function addPodcastIndexLiveItem(LiveItem $liveItem): self { $this->liveItems[] = $liveItem; return $this; } /** * Removes a specific indexed liveItem from the internal queue. LiveItems must be * added to a feed container in order to be indexed. * * @param int $index * @return $this * @throws InvalidArgumentException */ public function removePodcastIndexLiveItem($index) { if (! isset($this->liveItems[$index])) { throw new InvalidArgumentException('Undefined index: ' . $index . '. LiveItem does not exist.'); } unset($this->liveItems[$index]); return $this; } /** * Set a chat element. * * @psalm-param ChatArray $value * @return $this */ public function setPodcastIndexChat(array $value): self { $this->data['chat'] = Validator::validateChat($value); return $this; } /** * Overloading: proxy to internal setters * * @return mixed * @throws Writer\Exception\BadMethodCallException */ public function __call(string $method, array $params) { $point = lcfirst(substr($method, 15)); if ( ! method_exists($this, 'setPodcastIndex' . ucfirst($point)) && ! method_exists($this, 'addPodcastIndex' . ucfirst($point)) && ! method_exists($this, 'addPodcastIndex' . rtrim(ucfirst($point), 's')) ) { throw new Writer\Exception\BadMethodCallException( 'invalid method: ' . $method ); } if (! array_key_exists($point, $this->data) || empty($this->data[$point])) { return; } return $this->data[$point]; } /** * Is locked. * Specific get call for non-default naming. */ public function isLocked(): bool { return $this->isPodcastIndexLocked(); } /** * Is locked. * Specific get call for non-default naming. */ public function isPodcastIndexLocked(): bool { if (isset($this->data['locked'], $this->data['locked']['value'])) { return $this->data['locked']['value'] === 'yes'; } return false; } /** * Get lock owner. * Specific get call for non-default naming. */ public function getLockOwner(): string|null { return $this->getPodcastIndexLockOwner(); } /** * Get lock owner. * Specific get call for non-default naming. */ public function getPodcastIndexLockOwner(): string|null { if (isset($this->data['locked'], $this->data['locked']['owner'])) { /** @psalm-var string $this->data['locked']['owner'] */ return $this->data['locked']['owner']; } return null; } /** * Get persons. * Specific get call for non-default naming. */ public function getPodcastIndexPersons(): array|null { /** @var list $persons */ $persons = $this->getPodcastIndexPeople(); return $persons; } /** * Get live items. * Specific get call for non-default naming. */ public function getPodcastIndexLiveItems(): array|null { if (count($this->liveItems) > 0) { return $this->liveItems; } return null; } /** * Get multiple funding tags * Specific get call for non-default naming. * * @return null|list */ public function getPodcastIndexFundings(): array|null { $fundings = null; if (isset($this->data['fundings'])) { /** @var list $fundings */ $fundings = $this->data['fundings']; } if (isset($this->data['funding'])) { /** @var FundingArray $single */ $single = $this->data['funding']; $fundings[] = $single; } return $fundings; } /** * Get multiple location tags * Specific get call for non-default naming. * * @return null|list */ public function getPodcastIndexLocations(): array|null { $locations = null; if (isset($this->data['locations'])) { /** @var list $locations */ $locations = $this->data['locations']; } if (isset($this->data['location'])) { /** @var LocationArray $single */ $single = $this->data['location']; $locations[] = $single; } return $locations; } }