<?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 Gapps

 * @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: EmailList.php 20096 2010-01-06 02:05:09Z bkarwin $

 */

/**

 * @see Zend_Gdata_Extension

 */

require_once 'Zend/Gdata/Extension.php';

/**

 * @see Zend_Gdata_Gapps

 */

require_once 'Zend/Gdata/Gapps.php';

/**

 * Represents the apps:emailList element used by the Apps data API. This

 * class represents properties of an email list and is usually contained

 * within an instance of Zend_Gdata_Gapps_EmailListEntry.

 *

 * @category   Zend

 * @package    Zend_Gdata

 * @subpackage Gapps

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

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

 */

class Zend_Gdata_Gapps_Extension_EmailList extends Zend_Gdata_Extension

{

    protected $_rootNamespace = 'apps';

    protected $_rootElement = 'emailList';

    /**

     * The name of the email list. This name is used as the email address

     * for this list.

     *

     * @var string

     */

    protected $_name = null;

    /**

     * Constructs a new Zend_Gdata_Gapps_Extension_EmailList object.

     *

     * @param string $name (optional) The name to be used for this email list.

     */

    public function __construct($name = null)

    {

        $this->registerAllNamespaces(Zend_Gdata_Gapps::$namespaces);

        parent::__construct();

        $this->_name = $name;

    }

    /**

     * Retrieves a DOMElement which corresponds to this element and all

     * child properties.  This is used to build an entry back into a DOM

     * and eventually XML text for sending to the server upon updates, or

     * for application storage/persistence.

     *

     * @param DOMDocument $doc The DOMDocument used to construct DOMElements

     * @return DOMElement The DOMElement representing this element and all

     * child properties.

     */

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

    {

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

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

            $element->setAttribute('name', $this->_name);

        }

        return $element;

    }

    /**

     * Given a DOMNode representing an attribute, tries to map the data into

     * instance members.  If no mapping is defined, the name and value are

     * stored in an array.

     *

     * @param DOMNode $attribute The DOMNode attribute needed to be handled

     */

    protected function takeAttributeFromDOM($attribute)

    {

        switch ($attribute->localName) {

        case 'name':

            $this->_name = $attribute->nodeValue;

            break;

        default:

            parent::takeAttributeFromDOM($attribute);

        }

    }

    /**

     * Get the value for this element's name attribute.

     *

     * @see setName

     * @return string The requested attribute.

     */

    public function getName()

    {

        return $this->_name;

    }

    /**

     * Set the value for this element's name attribute. This is the unique

     * name which will be used to identify this email list within this

     * domain, and will be used to form this email list's email address.

     *

     * @param string $value The desired value for this attribute.

     * @return Zend_Gdata_Gapps_Extension_EmailList The element being modified.

     */

    public function setName($value)

    {

        $this->_name = $value;

        return $this;

    }

    /**

     * Magic toString method allows using this directly via echo

     * Works best in PHP >= 4.2.0

     *

     * @return string

     */

    public function __toString()

    {

        return $this->getName();

    }

}