class Entry in Zircon Profile 8.0

Hierarchy

• class \Zend\Feed\Writer\Extension\ITunes\Renderer\Entry extends \Extension\AbstractRenderer

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.itunesrendererentry in core/core.services.yml

Zend\Feed\Writer\Extension\ITunes\Renderer\Entry

File

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

Namespace

Zend\Feed\Writer\Extension\ITunes\Renderer

class Entry extends Extension\AbstractRenderer {

  /**
   * Set to TRUE if a rendering method actually renders something. This
   * is used to prevent premature appending of a XML namespace declaration
   * until an element which requires it is actually appended.
   *
   * @var bool
   */
  protected $called = false;

  /**
   * Render entry
   *
   * @return void
   */
  public function render() {
    $this
      ->_setAuthors($this->dom, $this->base);
    $this
      ->_setBlock($this->dom, $this->base);
    $this
      ->_setDuration($this->dom, $this->base);
    $this
      ->_setExplicit($this->dom, $this->base);
    $this
      ->_setKeywords($this->dom, $this->base);
    $this
      ->_setSubtitle($this->dom, $this->base);
    $this
      ->_setSummary($this->dom, $this->base);
    if ($this->called) {
      $this
        ->_appendNamespaces();
    }
  }

  /**
   * Append namespaces to entry root
   *
   * @return void
   */
  protected function _appendNamespaces() {
    $this
      ->getRootElement()
      ->setAttribute('xmlns:itunes', 'http://www.itunes.com/dtds/podcast-1.0.dtd');
  }

  /**
   * Set entry authors
   *
   * @param  DOMDocument $dom
   * @param  DOMElement $root
   * @return void
   */
  protected function _setAuthors(DOMDocument $dom, DOMElement $root) {
    $authors = $this
      ->getDataContainer()
      ->getItunesAuthors();
    if (!$authors || empty($authors)) {
      return;
    }
    foreach ($authors as $author) {
      $el = $dom
        ->createElement('itunes:author');
      $text = $dom
        ->createTextNode($author);
      $el
        ->appendChild($text);
      $root
        ->appendChild($el);
      $this->called = true;
    }
  }

  /**
   * Set itunes block
   *
   * @param  DOMDocument $dom
   * @param  DOMElement $root
   * @return void
   */
  protected function _setBlock(DOMDocument $dom, DOMElement $root) {
    $block = $this
      ->getDataContainer()
      ->getItunesBlock();
    if ($block === null) {
      return;
    }
    $el = $dom
      ->createElement('itunes:block');
    $text = $dom
      ->createTextNode($block);
    $el
      ->appendChild($text);
    $root
      ->appendChild($el);
    $this->called = true;
  }

  /**
   * Set entry duration
   *
   * @param  DOMDocument $dom
   * @param  DOMElement $root
   * @return void
   */
  protected function _setDuration(DOMDocument $dom, DOMElement $root) {
    $duration = $this
      ->getDataContainer()
      ->getItunesDuration();
    if (!$duration) {
      return;
    }
    $el = $dom
      ->createElement('itunes:duration');
    $text = $dom
      ->createTextNode($duration);
    $el
      ->appendChild($text);
    $root
      ->appendChild($el);
    $this->called = true;
  }

  /**
   * Set explicit flag
   *
   * @param  DOMDocument $dom
   * @param  DOMElement $root
   * @return void
   */
  protected function _setExplicit(DOMDocument $dom, DOMElement $root) {
    $explicit = $this
      ->getDataContainer()
      ->getItunesExplicit();
    if ($explicit === null) {
      return;
    }
    $el = $dom
      ->createElement('itunes:explicit');
    $text = $dom
      ->createTextNode($explicit);
    $el
      ->appendChild($text);
    $root
      ->appendChild($el);
    $this->called = true;
  }

  /**
   * Set entry keywords
   *
   * @param  DOMDocument $dom
   * @param  DOMElement $root
   * @return void
   */
  protected function _setKeywords(DOMDocument $dom, DOMElement $root) {
    $keywords = $this
      ->getDataContainer()
      ->getItunesKeywords();
    if (!$keywords || empty($keywords)) {
      return;
    }
    $el = $dom
      ->createElement('itunes:keywords');
    $text = $dom
      ->createTextNode(implode(',', $keywords));
    $el
      ->appendChild($text);
    $root
      ->appendChild($el);
    $this->called = true;
  }

  /**
   * Set entry subtitle
   *
   * @param  DOMDocument $dom
   * @param  DOMElement $root
   * @return void
   */
  protected function _setSubtitle(DOMDocument $dom, DOMElement $root) {
    $subtitle = $this
      ->getDataContainer()
      ->getItunesSubtitle();
    if (!$subtitle) {
      return;
    }
    $el = $dom
      ->createElement('itunes:subtitle');
    $text = $dom
      ->createTextNode($subtitle);
    $el
      ->appendChild($text);
    $root
      ->appendChild($el);
    $this->called = true;
  }

  /**
   * Set entry summary
   *
   * @param  DOMDocument $dom
   * @param  DOMElement $root
   * @return void
   */
  protected function _setSummary(DOMDocument $dom, DOMElement $root) {
    $summary = $this
      ->getDataContainer()
      ->getItunesSummary();
    if (!$summary) {
      return;
    }
    $el = $dom
      ->createElement('itunes:summary');
    $text = $dom
      ->createTextNode($summary);
    $el
      ->appendChild($text);
    $root
      ->appendChild($el);
    $this->called = true;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Entry::$called	protected	property	Set to TRUE if a rendering method actually renders something. This is used to prevent premature appending of a XML namespace declaration until an element which requires it is actually appended.
Entry::render	public	function	Render entry
Entry::_appendNamespaces	protected	function	Append namespaces to entry root
Entry::_setAuthors	protected	function	Set entry authors
Entry::_setBlock	protected	function	Set itunes block
Entry::_setDuration	protected	function	Set entry duration
Entry::_setExplicit	protected	function	Set explicit flag
Entry::_setKeywords	protected	function	Set entry keywords
Entry::_setSubtitle	protected	function	Set entry subtitle
Entry::_setSummary	protected	function	Set entry summary