Chris@0: <?php
Chris@0: /**
Chris@0:  * Zend Framework (http://framework.zend.com/)
Chris@0:  *
Chris@0:  * @link      http://github.com/zendframework/zf2 for the canonical source repository
Chris@0:  * @copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
Chris@0:  * @license   http://framework.zend.com/license/new-bsd New BSD License
Chris@0:  */
Chris@0: 
Chris@0: namespace Zend\Feed\Writer\Renderer\Feed;
Chris@0: 
Chris@0: use DateTime;
Chris@0: use DOMDocument;
Chris@0: use DOMElement;
Chris@0: use Zend\Feed\Writer;
Chris@0: use Zend\Feed\Writer\Renderer;
Chris@0: use Zend\Feed\Writer\Version;
Chris@0: 
Chris@0: /**
Chris@0: */
Chris@0: class AbstractAtom extends Renderer\AbstractRenderer
Chris@0: {
Chris@0:     /**
Chris@0:      * Constructor
Chris@0:      *
Chris@0:      * @param  Writer\AbstractFeed $container
Chris@0:      */
Chris@0:     public function __construct($container)
Chris@0:     {
Chris@0:         parent::__construct($container);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Set feed language
Chris@0:      *
Chris@0:      * @param  DOMDocument $dom
Chris@0:      * @param  DOMElement $root
Chris@0:      * @return void
Chris@0:      */
Chris@12:     // @codingStandardsIgnoreStart
Chris@0:     protected function _setLanguage(DOMDocument $dom, DOMElement $root)
Chris@0:     {
Chris@12:         // @codingStandardsIgnoreEnd
Chris@0:         if ($this->getDataContainer()->getLanguage()) {
Chris@0:             $root->setAttribute('xml:lang', $this->getDataContainer()
Chris@0:                 ->getLanguage());
Chris@0:         }
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Set feed title
Chris@0:      *
Chris@0:      * @param  DOMDocument $dom
Chris@0:      * @param  DOMElement $root
Chris@0:      * @return void
Chris@0:      * @throws Writer\Exception\InvalidArgumentException
Chris@0:      */
Chris@12:     // @codingStandardsIgnoreStart
Chris@0:     protected function _setTitle(DOMDocument $dom, DOMElement $root)
Chris@0:     {
Chris@12:         // @codingStandardsIgnoreEnd
Chris@12:         if (! $this->getDataContainer()->getTitle()) {
Chris@0:             $message = 'Atom 1.0 feed elements MUST contain exactly one'
Chris@0:             . ' atom:title element but a title has not been set';
Chris@0:             $exception = new Writer\Exception\InvalidArgumentException($message);
Chris@12:             if (! $this->ignoreExceptions) {
Chris@0:                 throw $exception;
Chris@0:             } else {
Chris@0:                 $this->exceptions[] = $exception;
Chris@0:                 return;
Chris@0:             }
Chris@0:         }
Chris@0: 
Chris@0:         $title = $dom->createElement('title');
Chris@0:         $root->appendChild($title);
Chris@0:         $title->setAttribute('type', 'text');
Chris@0:         $text = $dom->createTextNode($this->getDataContainer()->getTitle());
Chris@0:         $title->appendChild($text);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Set feed description
Chris@0:      *
Chris@0:      * @param  DOMDocument $dom
Chris@0:      * @param  DOMElement $root
Chris@0:      * @return void
Chris@0:      */
Chris@12:     // @codingStandardsIgnoreStart
Chris@0:     protected function _setDescription(DOMDocument $dom, DOMElement $root)
Chris@0:     {
Chris@12:         // @codingStandardsIgnoreEnd
Chris@12:         if (! $this->getDataContainer()->getDescription()) {
Chris@0:             return;
Chris@0:         }
Chris@0:         $subtitle = $dom->createElement('subtitle');
Chris@0:         $root->appendChild($subtitle);
Chris@0:         $subtitle->setAttribute('type', 'text');
Chris@0:         $text = $dom->createTextNode($this->getDataContainer()->getDescription());
Chris@0:         $subtitle->appendChild($text);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Set date feed was last modified
Chris@0:      *
Chris@0:      * @param  DOMDocument $dom
Chris@0:      * @param  DOMElement $root
Chris@0:      * @return void
Chris@0:      * @throws Writer\Exception\InvalidArgumentException
Chris@0:      */
Chris@12:     // @codingStandardsIgnoreStart
Chris@0:     protected function _setDateModified(DOMDocument $dom, DOMElement $root)
Chris@0:     {
Chris@12:         // @codingStandardsIgnoreEnd
Chris@12:         if (! $this->getDataContainer()->getDateModified()) {
Chris@0:             $message = 'Atom 1.0 feed elements MUST contain exactly one'
Chris@0:             . ' atom:updated element but a modification date has not been set';
Chris@0:             $exception = new Writer\Exception\InvalidArgumentException($message);
Chris@12:             if (! $this->ignoreExceptions) {
Chris@0:                 throw $exception;
Chris@0:             } else {
Chris@0:                 $this->exceptions[] = $exception;
Chris@0:                 return;
Chris@0:             }
Chris@0:         }
Chris@0: 
Chris@0:         $updated = $dom->createElement('updated');
Chris@0:         $root->appendChild($updated);
Chris@0:         $text = $dom->createTextNode(
Chris@0:             $this->getDataContainer()->getDateModified()->format(DateTime::ATOM)
Chris@0:         );
Chris@0:         $updated->appendChild($text);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Set feed generator string
Chris@0:      *
Chris@0:      * @param  DOMDocument $dom
Chris@0:      * @param  DOMElement $root
Chris@0:      * @return void
Chris@0:      */
Chris@12:     // @codingStandardsIgnoreStart
Chris@0:     protected function _setGenerator(DOMDocument $dom, DOMElement $root)
Chris@0:     {
Chris@12:         // @codingStandardsIgnoreEnd
Chris@12:         if (! $this->getDataContainer()->getGenerator()) {
Chris@12:             $this->getDataContainer()->setGenerator(
Chris@12:                 'Zend_Feed_Writer',
Chris@12:                 Version::VERSION,
Chris@12:                 'http://framework.zend.com'
Chris@12:             );
Chris@0:         }
Chris@0: 
Chris@0:         $gdata = $this->getDataContainer()->getGenerator();
Chris@0:         $generator = $dom->createElement('generator');
Chris@0:         $root->appendChild($generator);
Chris@0:         $text = $dom->createTextNode($gdata['name']);
Chris@0:         $generator->appendChild($text);
Chris@0:         if (array_key_exists('uri', $gdata)) {
Chris@0:             $generator->setAttribute('uri', $gdata['uri']);
Chris@0:         }
Chris@0:         if (array_key_exists('version', $gdata)) {
Chris@0:             $generator->setAttribute('version', $gdata['version']);
Chris@0:         }
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Set link to feed
Chris@0:      *
Chris@0:      * @param  DOMDocument $dom
Chris@0:      * @param  DOMElement $root
Chris@0:      * @return void
Chris@0:      */
Chris@12:     // @codingStandardsIgnoreStart
Chris@0:     protected function _setLink(DOMDocument $dom, DOMElement $root)
Chris@0:     {
Chris@12:         // @codingStandardsIgnoreEnd
Chris@12:         if (! $this->getDataContainer()->getLink()) {
Chris@0:             return;
Chris@0:         }
Chris@0:         $link = $dom->createElement('link');
Chris@0:         $root->appendChild($link);
Chris@0:         $link->setAttribute('rel', 'alternate');
Chris@0:         $link->setAttribute('type', 'text/html');
Chris@0:         $link->setAttribute('href', $this->getDataContainer()->getLink());
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Set feed links
Chris@0:      *
Chris@0:      * @param  DOMDocument $dom
Chris@0:      * @param  DOMElement $root
Chris@0:      * @return void
Chris@0:      * @throws Writer\Exception\InvalidArgumentException
Chris@0:      */
Chris@12:     // @codingStandardsIgnoreStart
Chris@0:     protected function _setFeedLinks(DOMDocument $dom, DOMElement $root)
Chris@0:     {
Chris@12:         // @codingStandardsIgnoreEnd
Chris@0:         $flinks = $this->getDataContainer()->getFeedLinks();
Chris@12:         if (! $flinks || ! array_key_exists('atom', $flinks)) {
Chris@0:             $message = 'Atom 1.0 feed elements SHOULD contain one atom:link '
Chris@0:             . 'element with a rel attribute value of "self".  This is the '
Chris@0:             . 'preferred URI for retrieving Atom Feed Documents representing '
Chris@0:             . 'this Atom feed but a feed link has not been set';
Chris@0:             $exception = new Writer\Exception\InvalidArgumentException($message);
Chris@12:             if (! $this->ignoreExceptions) {
Chris@0:                 throw $exception;
Chris@0:             } else {
Chris@0:                 $this->exceptions[] = $exception;
Chris@0:                 return;
Chris@0:             }
Chris@0:         }
Chris@0: 
Chris@0:         foreach ($flinks as $type => $href) {
Chris@0:             $mime = 'application/' . strtolower($type) . '+xml';
Chris@0:             $flink = $dom->createElement('link');
Chris@0:             $root->appendChild($flink);
Chris@0:             $flink->setAttribute('rel', 'self');
Chris@0:             $flink->setAttribute('type', $mime);
Chris@0:             $flink->setAttribute('href', $href);
Chris@0:         }
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Set feed authors
Chris@0:      *
Chris@0:      * @param  DOMDocument $dom
Chris@0:      * @param  DOMElement $root
Chris@0:      * @return void
Chris@0:      */
Chris@12:     // @codingStandardsIgnoreStart
Chris@0:     protected function _setAuthors(DOMDocument $dom, DOMElement $root)
Chris@0:     {
Chris@12:         // @codingStandardsIgnoreEnd
Chris@0:         $authors = $this->container->getAuthors();
Chris@12:         if (! $authors || empty($authors)) {
Chris@0:             /**
Chris@0:              * Technically we should defer an exception until we can check
Chris@0:              * that all entries contain an author. If any entry is missing
Chris@0:              * an author, then a missing feed author element is invalid
Chris@0:              */
Chris@0:             return;
Chris@0:         }
Chris@0:         foreach ($authors as $data) {
Chris@0:             $author = $this->dom->createElement('author');
Chris@0:             $name = $this->dom->createElement('name');
Chris@0:             $author->appendChild($name);
Chris@0:             $root->appendChild($author);
Chris@0:             $text = $dom->createTextNode($data['name']);
Chris@0:             $name->appendChild($text);
Chris@0:             if (array_key_exists('email', $data)) {
Chris@0:                 $email = $this->dom->createElement('email');
Chris@0:                 $author->appendChild($email);
Chris@0:                 $text = $dom->createTextNode($data['email']);
Chris@0:                 $email->appendChild($text);
Chris@0:             }
Chris@0:             if (array_key_exists('uri', $data)) {
Chris@0:                 $uri = $this->dom->createElement('uri');
Chris@0:                 $author->appendChild($uri);
Chris@0:                 $text = $dom->createTextNode($data['uri']);
Chris@0:                 $uri->appendChild($text);
Chris@0:             }
Chris@0:         }
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Set feed identifier
Chris@0:      *
Chris@0:      * @param  DOMDocument $dom
Chris@0:      * @param  DOMElement $root
Chris@0:      * @return void
Chris@0:      * @throws Writer\Exception\InvalidArgumentException
Chris@0:      */
Chris@12:     // @codingStandardsIgnoreStart
Chris@0:     protected function _setId(DOMDocument $dom, DOMElement $root)
Chris@0:     {
Chris@12:         // @codingStandardsIgnoreEnd
Chris@12:         if (! $this->getDataContainer()->getId()
Chris@12:         && ! $this->getDataContainer()->getLink()) {
Chris@0:             $message = 'Atom 1.0 feed elements MUST contain exactly one '
Chris@0:             . 'atom:id element, or as an alternative, we can use the same '
Chris@0:             . 'value as atom:link however neither a suitable link nor an '
Chris@0:             . 'id have been set';
Chris@0:             $exception = new Writer\Exception\InvalidArgumentException($message);
Chris@12:             if (! $this->ignoreExceptions) {
Chris@0:                 throw $exception;
Chris@0:             } else {
Chris@0:                 $this->exceptions[] = $exception;
Chris@0:                 return;
Chris@0:             }
Chris@0:         }
Chris@0: 
Chris@12:         if (! $this->getDataContainer()->getId()) {
Chris@0:             $this->getDataContainer()->setId(
Chris@12:                 $this->getDataContainer()->getLink()
Chris@12:             );
Chris@0:         }
Chris@0:         $id = $dom->createElement('id');
Chris@0:         $root->appendChild($id);
Chris@0:         $text = $dom->createTextNode($this->getDataContainer()->getId());
Chris@0:         $id->appendChild($text);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Set feed copyright
Chris@0:      *
Chris@0:      * @param  DOMDocument $dom
Chris@0:      * @param  DOMElement $root
Chris@0:      * @return void
Chris@0:      */
Chris@12:     // @codingStandardsIgnoreStart
Chris@0:     protected function _setCopyright(DOMDocument $dom, DOMElement $root)
Chris@0:     {
Chris@12:         // @codingStandardsIgnoreEnd
Chris@0:         $copyright = $this->getDataContainer()->getCopyright();
Chris@12:         if (! $copyright) {
Chris@0:             return;
Chris@0:         }
Chris@0:         $copy = $dom->createElement('rights');
Chris@0:         $root->appendChild($copy);
Chris@0:         $text = $dom->createTextNode($copyright);
Chris@0:         $copy->appendChild($text);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Set feed level logo (image)
Chris@0:      *
Chris@0:      * @param DOMDocument $dom
Chris@0:      * @param DOMElement $root
Chris@0:      * @return void
Chris@0:      */
Chris@12:     // @codingStandardsIgnoreStart
Chris@0:     protected function _setImage(DOMDocument $dom, DOMElement $root)
Chris@0:     {
Chris@12:         // @codingStandardsIgnoreEnd
Chris@0:         $image = $this->getDataContainer()->getImage();
Chris@12:         if (! $image) {
Chris@0:             return;
Chris@0:         }
Chris@0:         $img = $dom->createElement('logo');
Chris@0:         $root->appendChild($img);
Chris@0:         $text = $dom->createTextNode($image['uri']);
Chris@0:         $img->appendChild($text);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Set date feed was created
Chris@0:      *
Chris@0:      * @param  DOMDocument $dom
Chris@0:      * @param  DOMElement $root
Chris@0:      * @return void
Chris@0:      */
Chris@12:     // @codingStandardsIgnoreStart
Chris@0:     protected function _setDateCreated(DOMDocument $dom, DOMElement $root)
Chris@0:     {
Chris@12:         // @codingStandardsIgnoreEnd
Chris@12:         if (! $this->getDataContainer()->getDateCreated()) {
Chris@0:             return;
Chris@0:         }
Chris@12:         if (! $this->getDataContainer()->getDateModified()) {
Chris@0:             $this->getDataContainer()->setDateModified(
Chris@0:                 $this->getDataContainer()->getDateCreated()
Chris@0:             );
Chris@0:         }
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Set base URL to feed links
Chris@0:      *
Chris@0:      * @param  DOMDocument $dom
Chris@0:      * @param  DOMElement $root
Chris@0:      * @return void
Chris@0:      */
Chris@12:     // @codingStandardsIgnoreStart
Chris@0:     protected function _setBaseUrl(DOMDocument $dom, DOMElement $root)
Chris@0:     {
Chris@12:         // @codingStandardsIgnoreEnd
Chris@0:         $baseUrl = $this->getDataContainer()->getBaseUrl();
Chris@12:         if (! $baseUrl) {
Chris@0:             return;
Chris@0:         }
Chris@0:         $root->setAttribute('xml:base', $baseUrl);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Set hubs to which this feed pushes
Chris@0:      *
Chris@0:      * @param  DOMDocument $dom
Chris@0:      * @param  DOMElement $root
Chris@0:      * @return void
Chris@0:      */
Chris@12:     // @codingStandardsIgnoreStart
Chris@0:     protected function _setHubs(DOMDocument $dom, DOMElement $root)
Chris@0:     {
Chris@12:         // @codingStandardsIgnoreEnd
Chris@0:         $hubs = $this->getDataContainer()->getHubs();
Chris@12:         if (! $hubs) {
Chris@0:             return;
Chris@0:         }
Chris@0:         foreach ($hubs as $hubUrl) {
Chris@0:             $hub = $dom->createElement('link');
Chris@0:             $hub->setAttribute('rel', 'hub');
Chris@0:             $hub->setAttribute('href', $hubUrl);
Chris@0:             $root->appendChild($hub);
Chris@0:         }
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Set feed categories
Chris@0:      *
Chris@0:      * @param  DOMDocument $dom
Chris@0:      * @param  DOMElement $root
Chris@0:      * @return void
Chris@0:      */
Chris@12:     // @codingStandardsIgnoreStart
Chris@0:     protected function _setCategories(DOMDocument $dom, DOMElement $root)
Chris@0:     {
Chris@12:         // @codingStandardsIgnoreEnd
Chris@0:         $categories = $this->getDataContainer()->getCategories();
Chris@12:         if (! $categories) {
Chris@0:             return;
Chris@0:         }
Chris@0:         foreach ($categories as $cat) {
Chris@0:             $category = $dom->createElement('category');
Chris@0:             $category->setAttribute('term', $cat['term']);
Chris@0:             if (isset($cat['label'])) {
Chris@0:                 $category->setAttribute('label', $cat['label']);
Chris@0:             } else {
Chris@0:                 $category->setAttribute('label', $cat['term']);
Chris@0:             }
Chris@0:             if (isset($cat['scheme'])) {
Chris@0:                 $category->setAttribute('scheme', $cat['scheme']);
Chris@0:             }
Chris@0:             $root->appendChild($category);
Chris@0:         }
Chris@0:     }
Chris@0: }