Phraseanet/lib/classes/Feed/XML/Abstract.class.php

<?php

/*
 * This file is part of Phraseanet
 *
 * (c) 2005-2010 Alchemy
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

/**
 *
 * @package     Feeds
 * @license     http://opensource.org/licenses/gpl-3.0 GPLv3
 * @link        www.phraseanet.com
 */
abstract class Feed_XML_Abstract
{

  /**
   *
   * @var DateTime
   */
  protected $updated_on;
  /**
   *
   * @var string
   */
  protected $title;
  /**
   *
   * @var string
   */
  protected $subtitle;
  /**
   *
   * @var Array
   */
  protected $items = array();
  /**
   *
   * @var Feed_Link
   */
  protected $next_page;
  /**
   *
   * @var Feed_Link
   */
  protected $previous_page;
  /**
   *
   * @var Feed_Link
   */
  protected $link;
  /**
   *
   * @var string
   */
  protected $generator;
  /**
   *
   * @var string
   */
  protected $mimetype;

  /**
   *
   * @param string $title
   */
  public function set_title($title)
  {
    $this->title = $title;

    return $this;
  }

  /**
   *
   * @param DateTime $datetime
   * @return Feed_XML_Interface
   */
  public function set_updated_on(DateTime $datetime)
  {
    $this->updated_on = $datetime;

    return $this;
  }

  /**
   *
   * @param string $subtitle
   * @return Feed_XML_Interface
   */
  public function set_subtitle($subtitle)
  {
    $this->subtitle = $subtitle;

    return $this;
  }

  /**
   *
   * @param Feed_Link $link
   * @return Feed_XML_Interface
   */
  public function set_link(Feed_Link $link)
  {
    $this->link = $link;

    return $this;
  }

  /**
   *
   * @param Feed_Link $next_page
   * @return Feed_XML_Interface
   */
  public function set_next_page(Feed_Link $next_page)
  {
    $this->next_page = $next_page;

    return $this;
  }

  /**
   *
   * @param Feed_Link $previous_page
   * @return Feed_XML_Interface
   */
  public function set_previous_page(Feed_Link $previous_page)
  {
    $this->previous_page = $previous_page;

    return $this;
  }

  /**
   *
   * @param Feed_Entry_Adapter $entry
   * @return Feed_XML_Interface
   */
  public function set_item(Feed_Entry_Adapter $entry)
  {
    $this->items[] = $entry;

    return $this;
  }

  /**
   *
   * @param string $generator
   * @return Feed_XML_Interface
   */
  public function set_generator($generator)
  {
    $this->generator = $generator;

    return $this;
  }

  /**
   *
   * @param DOMDocument $document
   * @param DOMNode $node
   * @param boolean $namespaced
   * @return Feed_XML_Interface
   */
  public function add_navigation(DOMDocument $document, DOMNode $node, $namespaced)
  {
    $prefix = $namespaced ? 'atom:' : '';

    if ($this->previous_page instanceof Feed_Link)
    {
      $prev_link = $this->addTag($document, $node, $prefix . 'link');
      $prev_link->setAttribute('rel', 'previous');
      $prev_link->setAttribute('href', $this->previous_page->get_href());
    }

    if ($this->next_page instanceof Feed_Link)
    {
      $next_link = $this->addTag($document, $node, $prefix . 'link');
      $next_link->setAttribute('rel', 'next');
      $next_link->setAttribute('href', $this->next_page->get_href());
    }

    return $this;
  }

  /**
   *
   * @param DOMDocument $document
   * @param DOMNode $node
   * @param string $tagname
   * @param string $tagcontent
   * @return DOMElement
   */
  protected function addTag(DOMDocument &$document, DOMNode &$node, $tagname, $tagcontent = null)
  {
    $tag = $document->createElement($tagname);

    if (trim($tagcontent) !== '')
      $tag->appendChild($document->createTextNode($tagcontent));
    $node->appendChild($tag);

    return $tag;
  }

  /**
   *
   * @param DOMDocument $document
   * @param DOMNode $item
   * @param Feed_Entry_Item $content
   * @return Feed_XML_Interface
   */
  protected function addContent(DOMDocument $document, DOMNode $item, Feed_Entry_Item $content)
  {
    $preview_sd = $content->get_record()->get_subdef('preview');
    $preview_permalink = $preview_sd->get_permalink();
    $thumbnail_sd = $content->get_record()->get_thumbnail();
    $thumbnail_permalink = $thumbnail_sd->get_permalink();

    $medium = strtolower($content->get_record()->get_type());

    if (!in_array($medium, array('image', 'audio', 'video')))

      return $this;

    if (!$preview_permalink || !$thumbnail_permalink)

      return $this;

    $group = $this->addTag($document, $item, 'media:group');

    $title_field = $content->get_record()->get_caption()->get_dc_field(databox_Field_DCESAbstract::Title);
    if ($title_field)
    {
      $str_title = $title_field->get_serialized_values(' ');
      $title = $this->addTag($document, $group, 'media:title', $str_title);
      $title->setAttribute('type', 'plain');
    }

    $desc_field = $content->get_record()->get_caption()->get_dc_field(databox_Field_DCESAbstract::Description);
    if ($desc_field)
    {
      $str_desc = $desc_field->get_serialized_values(' ');
      $desc = $this->addTag($document, $group, 'media:description', $str_desc);
      $desc->setAttribute('type', 'plain');
    }

    $contrib_field = $content->get_record()->get_caption()->get_dc_field(databox_Field_DCESAbstract::Contributor);
    if ($contrib_field)
    {
      $str_contrib = $contrib_field->get_serialized_values(' ');
      $contrib = $this->addTag($document, $group, 'media:credit', $str_contrib);
      $contrib->setAttribute('role', 'contributor');
      $contrib->setAttribute('scheme', 'urn:ebu');
    }

    $director_field = $content->get_record()->get_caption()->get_dc_field(databox_Field_DCESAbstract::Creator);
    if ($director_field)
    {
      $str_director = $director_field->get_serialized_values(' ');
      $director = $this->addTag($document, $group, 'media:credit', $str_director);
      $director->setAttribute('role', 'director');
      $director->setAttribute('scheme', 'urn:ebu');
    }

    $publisher_field = $content->get_record()->get_caption()->get_dc_field(databox_Field_DCESAbstract::Publisher);
    if ($publisher_field)
    {
      $str_publisher = $publisher_field->get_serialized_values(' ');
      $publisher = $this->addTag($document, $group, 'media:credit', $str_publisher);
      $publisher->setAttribute('role', 'publisher');
      $publisher->setAttribute('scheme', 'urn:ebu');
    }

    $rights_field = $content->get_record()->get_caption()->get_dc_field(databox_Field_DCESAbstract::Rights);
    if ($rights_field)
    {
      $str_rights = $rights_field->get_serialized_values(' ');
      $rights = $this->addTag($document, $group, 'media:copyright', $str_rights);
    }

    $keyword_field = $content->get_record()->get_caption()->get_dc_field(databox_Field_DCESAbstract::Subject);
    if ($keyword_field)
    {
      $str_keywords = $keyword_field->get_serialized_values(', ');
      $keywords = $this->addTag($document, $group, 'media:keywords', $str_keywords);
    }

    $duration = $content->get_record()->get_duration();

    if ($preview_permalink)
    {
      $preview = $this->addTag($document, $group, 'media:content');

      $preview->setAttribute('url', $preview_permalink->get_url());
      $preview->setAttribute('fileSize', $preview_sd->get_size());
      $preview->setAttribute('type', $preview_sd->get_mime());
      $preview->setAttribute('medium', $medium);
      $preview->setAttribute('expression', 'full');
      $preview->setAttribute('isDefault', 'true');

      if ($preview_sd->get_width())
        $preview->setAttribute('width', $preview_sd->get_width());
      if ($preview_sd->get_height())
        $preview->setAttribute('height', $preview_sd->get_height());
      if ($duration)
        $preview->setAttribute('duration', $duration);
    }

    if ($thumbnail_permalink)
    {
      $thumbnail = $this->addTag($document, $group, 'media:thumbnail');

      $thumbnail->setAttribute('url', $thumbnail_permalink->get_url());

      if ($thumbnail_sd->get_width())
        $thumbnail->setAttribute('width', $thumbnail_sd->get_width());
      if ($thumbnail_sd->get_height())
        $thumbnail->setAttribute('height', $thumbnail_sd->get_height());


      $thumbnail = $this->addTag($document, $group, 'media:content');

      $thumbnail->setAttribute('url', $thumbnail_permalink->get_url());
      $thumbnail->setAttribute('fileSize', $thumbnail_sd->get_size());
      $thumbnail->setAttribute('type', $thumbnail_sd->get_mime());
      $thumbnail->setAttribute('medium', $medium);
      $thumbnail->setAttribute('isDefault', 'false');

      if ($thumbnail_sd->get_width())
        $thumbnail->setAttribute('width', $thumbnail_sd->get_width());
      if ($thumbnail_sd->get_height())
        $thumbnail->setAttribute('height', $thumbnail_sd->get_height());
      if ($duration)
        $thumbnail->setAttribute('duration', $duration);
    }

    return $this;
  }

  /**
   *
   * @return string
   */
  public function get_mimetype()
  {
    return $this->mimetype;
  }

  abstract public function render();
}