class Entry in Zircon Profile 8

Hierarchy

• class \Zend\Feed\Writer\Extension\ITunes\Entry

2 string references to 'Entry'

core.services.yml in core/core.services.yml

core/core.services.yml

ExtensionPluginManager::validatePlugin in vendor/zendframework/zend-feed/src/Writer/ExtensionPluginManager.php

Validate the plugin

1 service uses Entry

feed.writer.itunesentry in core/core.services.yml

Zend\Feed\Writer\Extension\ITunes\Entry

File

vendor/zendframework/zend-feed/src/Writer/Extension/ITunes/Entry.php, line 19

Namespace

Zend\Feed\Writer\Extension\ITunes

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 Entry
   */
  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
   * @return Entry
   * @throws Writer\Exception\InvalidArgumentException
   */
  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
   *
   * @param  array $values
   * @return Entry
   */
  public function addItunesAuthors(array $values) {
    foreach ($values as $value) {
      $this
        ->addItunesAuthor($value);
    }
    return $this;
  }

  /**
   * Add author to itunes entry
   *
   * @param  string $value
   * @return Entry
   * @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 Entry
   * @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
   *
   * @param  bool $value
   * @return Entry
   * @throws Writer\Exception\InvalidArgumentException
   */
  public function setItunesExplicit($value) {
    if (!in_array($value, [
      'yes',
      'no',
      'clean',
    ])) {
      throw new Writer\Exception\InvalidArgumentException('invalid parameter: "explicit" may only' . ' be one of "yes", "no" or "clean"');
    }
    $this->data['explicit'] = $value;
    return $this;
  }

  /**
   * Set keywords
   *
   * @param  array $value
   * @return Entry
   * @throws Writer\Exception\InvalidArgumentException
   */
  public function setItunesKeywords(array $value) {
    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 subtitle
   *
   * @param  string $value
   * @return Entry
   * @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 Entry
   * @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;
  }

  /**
   * Overloading to itunes specific setters
   *
   * @param  string $method
   * @param  array $params
   * @throws Writer\Exception\BadMethodCallException
   * @return mixed
   */
  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];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Entry::$data	protected	property	Array of Feed data for rendering by Extension's renderers
Entry::$encoding	protected	property	Encoding of all text values
Entry::$stringWrapper	protected	property	The used string wrapper supporting encoding
Entry::addItunesAuthor	public	function	Add author to itunes entry
Entry::addItunesAuthors	public	function	Add authors to itunes entry
Entry::getEncoding	public	function	Get feed encoding
Entry::setEncoding	public	function	Set feed encoding
Entry::setItunesBlock	public	function	Set a block value of "yes" or "no". You may also set an empty string.
Entry::setItunesDuration	public	function	Set duration
Entry::setItunesExplicit	public	function	Set "explicit" flag
Entry::setItunesKeywords	public	function	Set keywords
Entry::setItunesSubtitle	public	function	Set subtitle
Entry::setItunesSummary	public	function	Set summary
Entry::__call	public	function	Overloading to itunes specific setters
Entry::__construct	public	function