Zend/Gdata/Gapps/Extension/Nickname.php

   1 <?php
   2
   3 /**
   4  * Zend Framework
   5  *
   6  * LICENSE
   7  *
   8  * This source file is subject to the new BSD license that is bundled
   9  * with this package in the file LICENSE.txt.
  10  * It is also available through the world-wide-web at this URL:
  11  * http://framework.zend.com/license/new-bsd
  12  * If you did not receive a copy of the license and are unable to
  13  * obtain it through the world-wide-web, please send an email
  14  * to license@zend.com so we can send you a copy immediately.
  15  *
  16  * @category   Zend
  17  * @package    Zend_Gdata
  18  * @subpackage Gapps
  19  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
  20  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  21
  22  */
  23
  24 /**
  25  * @see Zend_Gdata_Extension
  26  */
  27 require_once 'Zend/Gdata/Extension.php';
  28
  29 /**
  30  * @see Zend_Gdata_Gapps
  31  */
  32 require_once 'Zend/Gdata/Gapps.php';
  33
  34 /**
  35  * Represents the apps:nickname element used by the Apps data API. This
  36  * is used to describe a nickname's properties, and is usually contained
  37  * within instances of Zend_Gdata_Gapps_NicknameEntry.
  38  *
  39  * @category   Zend
  40  * @package    Zend_Gdata
  41  * @subpackage Gapps
  42  * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
  43  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  44  */
  45 class Zend_Gdata_Gapps_Extension_Nickname extends Zend_Gdata_Extension
  46 {
  47
  48     protected $_rootNamespace = 'apps';
  49     protected $_rootElement = 'nickname';
  50
  51     /**
  52      * The name of the nickname. This name is used as the email address
  53      * for this nickname.
  54      *
  55      * @var string
  56      */
  57     protected $_name = null;
  58
  59     /**
  60      * Constructs a new Zend_Gdata_Gapps_Extension_Nickname object.
  61      * @param string $name (optional) The nickname being represented.
  62      */
  63     public function __construct($name = null)
  64     {
  65         $this->registerAllNamespaces(Zend_Gdata_Gapps::$namespaces);
  66         parent::__construct();
  67         $this->_name = $name;
  68     }
  69
  70     /**
  71      * Retrieves a DOMElement which corresponds to this element and all
  72      * child properties.  This is used to build an entry back into a DOM
  73      * and eventually XML text for sending to the server upon updates, or
  74      * for application storage/persistence.
  75      *
  76      * @param DOMDocument $doc The DOMDocument used to construct DOMElements
  77      * @return DOMElement The DOMElement representing this element and all
  78      * child properties.
  79      */
  80     public function getDOM($doc = null, $majorVersion = 1, $minorVersion = null)
  81     {
  82         $element = parent::getDOM($doc, $majorVersion, $minorVersion);
  83         if ($this->_name !== null) {
  84             $element->setAttribute('name', $this->_name);
  85         }
  86         return $element;
  87     }
  88
  89     /**
  90      * Given a DOMNode representing an attribute, tries to map the data into
  91      * instance members.  If no mapping is defined, the name and value are
  92      * stored in an array.
  93      *
  94      * @param DOMNode $attribute The DOMNode attribute needed to be handled
  95      */
  96     protected function takeAttributeFromDOM($attribute)
  97     {
  98         switch ($attribute->localName) {
  99         case 'name':
 100             $this->_name = $attribute->nodeValue;
 101             break;
 102         default:
 103             parent::takeAttributeFromDOM($attribute);
 104         }
 105     }
 106
 107     /**
 108      * Get the value for this element's name attribute.
 109      *
 110      * @see setName
 111      * @return string The requested attribute.
 112      */
 113     public function getName()
 114     {
 115         return $this->_name;
 116     }
 117
 118     /**
 119      * Set the value for this element's name attribute. This name uniquely
 120      * describes this nickname within the domain. Emails addressed to this
 121      * name will be delivered to the user who owns this nickname.
 122      *
 123      * @param string $value The desired value for this attribute.
 124      * @return Zend_Gdata_Gapps_Extension_Nickname Provides a fluent
 125      *          interface.
 126      */
 127     public function setName($value)
 128     {
 129         $this->_name = $value;
 130         return $this;
 131     }
 132
 133     /**
 134      * Magic toString method allows using this directly via echo
 135      * Works best in PHP >= 4.2.0
 136      */
 137     public function __toString()
 138     {
 139         return $this->getName();
 140     }
 141
 142 }