<?php

/**

 * Zend Framework

 *

 * LICENSE

 *

 * This source file is subject to the new BSD license that is bundled

 * with this package in the file LICENSE.txt.

 * It is also available through the world-wide-web at this URL:

 * http://framework.zend.com/license/new-bsd

 * If you did not receive a copy of the license and are unable to

 * obtain it through the world-wide-web, please send an email

 * to license@zend.com so we can send you a copy immediately.

 *

 * @category   Zend

 * @package    Zend_Gdata

 * @subpackage App

 * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)

 * @license    http://framework.zend.com/license/new-bsd     New BSD License

 * @version    $Id: FeedEntryParent.php 20096 2010-01-06 02:05:09Z bkarwin $

 */

/**

 * @see Zend_Gdata_App_Extension_Element

*/

require_once 'Zend/Gdata/App/Extension/Element.php';

/**

 * @see Zend_Gdata_App_Extension_Author

*/

require_once 'Zend/Gdata/App/Extension/Author.php';

/**

 * @see Zend_Gdata_App_Extension_Category

*/

require_once 'Zend/Gdata/App/Extension/Category.php';

/**

 * @see Zend_Gdata_App_Extension_Contributor

*/

require_once 'Zend/Gdata/App/Extension/Contributor.php';

/**

 * @see Zend_Gdata_App_Extension_Id

 */

require_once 'Zend/Gdata/App/Extension/Id.php';

/**

 * @see Zend_Gdata_App_Extension_Link

 */

require_once 'Zend/Gdata/App/Extension/Link.php';

/**

 * @see Zend_Gdata_App_Extension_Rights

 */

require_once 'Zend/Gdata/App/Extension/Rights.php';

/**

 * @see Zend_Gdata_App_Extension_Title

 */

require_once 'Zend/Gdata/App/Extension/Title.php';

/**

 * @see Zend_Gdata_App_Extension_Updated

 */

require_once 'Zend/Gdata/App/Extension/Updated.php';

/**

 * Zend_Version

 */

require_once 'Zend/Version.php';

/**

 * Abstract class for common functionality in entries and feeds

 *

 * @category   Zend

 * @package    Zend_Gdata

 * @subpackage App

 * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)

 * @license    http://framework.zend.com/license/new-bsd     New BSD License

 */

abstract class Zend_Gdata_App_FeedEntryParent extends Zend_Gdata_App_Base

{

    /**

     * Service instance used to make network requests.

     *

     * @see setService(), getService()

     */

    protected $_service = null;

    /**

     * The HTTP ETag associated with this entry. Used for optimistic

     * concurrency in protoco v2 or greater.

     *

     * @var string|null

     */

    protected $_etag = NULL;

    protected $_author = array();

    protected $_category = array();

    protected $_contributor = array();

    protected $_id = null;

    protected $_link = array();

    protected $_rights = null;

    protected $_title = null;

    protected $_updated = null;

    /**

      * Indicates the major protocol version that should be used.

      * At present, recognized values are either 1 or 2. However, any integer

      * value >= 1 is considered valid.

      *

      * @see setMajorProtocolVersion()

      * @see getMajorProtocolVersion()

      */

    protected $_majorProtocolVersion = 1;

    /**

      * Indicates the minor protocol version that should be used. Can be set

      * to either an integer >= 0, or NULL if no minor version should be sent

      * to the server.

      *

      * @see setMinorProtocolVersion()

      * @see getMinorProtocolVersion()

      */

    protected $_minorProtocolVersion = null;

    /**

     * Constructs a Feed or Entry

     */

    public function __construct($element = null)

    {

        if (!($element instanceof DOMElement)) {

            if ($element) {

                $this->transferFromXML($element);

            }

        } else {

            $this->transferFromDOM($element);

        }

    }

    /**

     * Set the HTTP client instance

     *

     * Sets the HTTP client object to use for retrieving the feed.

     *

     * @deprecated Deprecated as of Zend Framework 1.7. Use

     *             setService() instead.

     * @param  Zend_Http_Client $httpClient

     * @return Zend_Gdata_App_FeedEntryParent Provides a fluent interface

     */

    public function setHttpClient(Zend_Http_Client $httpClient)

    {

        if (!$this->_service) {

            $this->_service = new Zend_Gdata_App();

        }

        $this->_service->setHttpClient($httpClient);

        return $this;

    }

    /**

     * Gets the HTTP client object. If none is set, a new Zend_Http_Client

     * will be used.

     *

     * @deprecated Deprecated as of Zend Framework 1.7. Use

     *             getService() instead.

     * @return Zend_Http_Client_Abstract

     */

    public function getHttpClient()

    {

        if (!$this->_service) {

            $this->_service = new Zend_Gdata_App();

        }

        $client = $this->_service->getHttpClient();

        return $client;

    }

    /**

     * Set the active service instance for this object. This will be used to

     * perform network requests, such as when calling save() and delete().

     *

     * @param Zend_Gdata_App $instance The new service instance.

     * @return Zend_Gdata_App_FeedEntryParent Provides a fluent interface.

     */

    public function setService($instance)

    {

        $this->_service = $instance;

        return $this;

    }

    /**

     * Get the active service instance for this object. This will be used to

     * perform network requests, such as when calling save() and delete().

     *

     * @return Zend_Gdata_App|null The current service instance, or null if

     *         not set.

     */

    public function getService()

    {

        return $this->_service;

    }

    public function getDOM($doc = null, $majorVersion = 1, $minorVersion = null)

    {

        $element = parent::getDOM($doc, $majorVersion, $minorVersion);

        foreach ($this->_author as $author) {

            $element->appendChild($author->getDOM($element->ownerDocument));

        }

        foreach ($this->_category as $category) {

            $element->appendChild($category->getDOM($element->ownerDocument));

        }

        foreach ($this->_contributor as $contributor) {

            $element->appendChild($contributor->getDOM($element->ownerDocument));

        }

        if ($this->_id != null) {

            $element->appendChild($this->_id->getDOM($element->ownerDocument));

        }

        foreach ($this->_link as $link) {

            $element->appendChild($link->getDOM($element->ownerDocument));

        }

        if ($this->_rights != null) {

            $element->appendChild($this->_rights->getDOM($element->ownerDocument));

        }

        if ($this->_title != null) {

            $element->appendChild($this->_title->getDOM($element->ownerDocument));

        }

        if ($this->_updated != null) {

            $element->appendChild($this->_updated->getDOM($element->ownerDocument));

        }

        return $element;

    }

    protected function takeChildFromDOM($child)

    {

        $absoluteNodeName = $child->namespaceURI . ':' . $child->localName;

        switch ($absoluteNodeName) {

        case $this->lookupNamespace('atom') . ':' . 'author':

            $author = new Zend_Gdata_App_Extension_Author();

            $author->transferFromDOM($child);

            $this->_author[] = $author;

            break;

        case $this->lookupNamespace('atom') . ':' . 'category':

            $category = new Zend_Gdata_App_Extension_Category();

            $category->transferFromDOM($child);

            $this->_category[] = $category;

            break;

        case $this->lookupNamespace('atom') . ':' . 'contributor':

            $contributor = new Zend_Gdata_App_Extension_Contributor();

            $contributor->transferFromDOM($child);

            $this->_contributor[] = $contributor;

            break;

        case $this->lookupNamespace('atom') . ':' . 'id':

            $id = new Zend_Gdata_App_Extension_Id();

            $id->transferFromDOM($child);

            $this->_id = $id;

            break;

        case $this->lookupNamespace('atom') . ':' . 'link':

            $link = new Zend_Gdata_App_Extension_Link();

            $link->transferFromDOM($child);

            $this->_link[] = $link;

            break;

        case $this->lookupNamespace('atom') . ':' . 'rights':

            $rights = new Zend_Gdata_App_Extension_Rights();

            $rights->transferFromDOM($child);

            $this->_rights = $rights;

            break;

        case $this->lookupNamespace('atom') . ':' . 'title':

            $title = new Zend_Gdata_App_Extension_Title();

            $title->transferFromDOM($child);

            $this->_title = $title;

            break;

        case $this->lookupNamespace('atom') . ':' . 'updated':

            $updated = new Zend_Gdata_App_Extension_Updated();

            $updated->transferFromDOM($child);

            $this->_updated = $updated;

            break;

        default:

            parent::takeChildFromDOM($child);

            break;

        }

    }

    /**

     * @return Zend_Gdata_App_Extension_Author

     */

    public function getAuthor()

    {

        return $this->_author;

    }

    /**

     * Sets the list of the authors of this feed/entry.  In an atom feed, each

     * author is represented by an atom:author element

     *

     * @param array $value

     * @return Zend_Gdata_App_FeedEntryParent Provides a fluent interface

     */

    public function setAuthor($value)

    {

        $this->_author = $value;

        return $this;

    }

    /**

     * Returns the array of categories that classify this feed/entry.  Each

     * category is represented in an atom feed by an atom:category element.

     *

     * @return array Array of Zend_Gdata_App_Extension_Category

     */

    public function getCategory()

    {

        return $this->_category;

    }

    /**

     * Sets the array of categories that classify this feed/entry.  Each

     * category is represented in an atom feed by an atom:category element.

     *

     * @param array $value Array of Zend_Gdata_App_Extension_Category

     * @return Zend_Gdata_App_FeedEntryParent Provides a fluent interface

     */

    public function setCategory($value)

    {

        $this->_category = $value;

        return $this;

    }

    /**

     * Returns the array of contributors to this feed/entry.  Each contributor

     * is represented in an atom feed by an atom:contributor XML element

     *

     * @return array An array of Zend_Gdata_App_Extension_Contributor

     */

    public function getContributor()

    {

        return $this->_contributor;

    }

    /**

     * Sets the array of contributors to this feed/entry.  Each contributor

     * is represented in an atom feed by an atom:contributor XML element

     *

     * @param array $value

     * @return Zend_Gdata_App_FeedEntryParent Provides a fluent interface

     */

    public function setContributor($value)

    {

        $this->_contributor = $value;

        return $this;

    }

    /**

     * @return Zend_Gdata_App_Extension_Id

     */

    public function getId()

    {

        return $this->_id;

    }

    /**

     * @param Zend_Gdata_App_Extension_Id $value

     * @return Zend_Gdata_App_FeedEntryParent Provides a fluent interface

     */

    public function setId($value)

    {

        $this->_id = $value;

        return $this;

    }

    /**

     * Given a particular 'rel' value, this method returns a matching

     * Zend_Gdata_App_Extension_Link element.  If the 'rel' value

     * is not provided, the full array of Zend_Gdata_App_Extension_Link

     * elements is returned.  In an atom feed, each link is represented

     * by an atom:link element.  The 'rel' value passed to this function

     * is the atom:link/@rel attribute.  Example rel values include 'self',

     * 'edit', and 'alternate'.

     *

     * @param string $rel The rel value of the link to be found.  If null,

     *     the array of Zend_Gdata_App_Extension_link elements is returned

     * @return mixed Either a single Zend_Gdata_App_Extension_link element,

     *     an array of the same or null is returned depending on the rel value

     *     supplied as the argument to this function

     */

    public function getLink($rel = null)

    {

        if ($rel == null) {

            return $this->_link;

        } else {

            foreach ($this->_link as $link) {

                if ($link->rel == $rel) {

                    return $link;

                }

            }

            return null;

        }

    }

    /**

     * Returns the Zend_Gdata_App_Extension_Link element which represents

     * the URL used to edit this resource.  This link is in the atom feed/entry

     * as an atom:link with a rel attribute value of 'edit'.

     *

     * @return Zend_Gdata_App_Extension_Link The link, or null if not found

     */

    public function getEditLink()

    {

        return $this->getLink('edit');

    }

    /**

     * Returns the Zend_Gdata_App_Extension_Link element which represents

     * the URL used to retrieve the next chunk of results when paging through

     * a feed.  This link is in the atom feed as an atom:link with a

     * rel attribute value of 'next'.

     *

     * @return Zend_Gdata_App_Extension_Link The link, or null if not found

     */

    public function getNextLink()

    {

        return $this->getLink('next');

    }

    /**

     * Returns the Zend_Gdata_App_Extension_Link element which represents

     * the URL used to retrieve the previous chunk of results when paging

     * through a feed.  This link is in the atom feed as an atom:link with a

     * rel attribute value of 'previous'.

     *

     * @return Zend_Gdata_App_Extension_Link The link, or null if not found

     */

    public function getPreviousLink()

    {

        return $this->getLink('previous');

    }

    /**

     * @return Zend_Gdata_App_Extension_Link

     */

    public function getLicenseLink()

    {

        return $this->getLink('license');

    }

    /**

     * Returns the Zend_Gdata_App_Extension_Link element which represents

     * the URL used to retrieve the entry or feed represented by this object

     * This link is in the atom feed/entry as an atom:link with a

     * rel attribute value of 'self'.

     *