/zf/library/Zend/Gdata/Gapps/EmailListRecipientEntry.php
PHP | 146 lines | 44 code | 13 blank | 89 comment | 2 complexity | 05854045742aa1fe5f3fc0b7bceab0f6 MD5 | raw file
Possible License(s): MIT, BSD-3-Clause, Apache-2.0, LGPL-2.1, LGPL-3.0, BSD-2-Clause
- <?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-2011 Zend Technologies USA Inc. (http://www.zend.com)
- * @license http://framework.zend.com/license/new-bsd New BSD License
- * @version $Id: EmailListRecipientEntry.php 23775 2011-03-01 17:25:24Z ralph $
- */
- /**
- * @see Zend_Gdata_Entry
- */
- require_once 'Zend/Gdata/Entry.php';
- /**
- * @see Zend_Gdata_Extension_Who
- */
- require_once 'Zend/Gdata/Extension/Who.php';
- /**
- * Data model class for a Google Apps Email List Recipient Entry.
- *
- * Each instance of this class represents a recipient of an email list
- * hosted on a Google Apps domain. Each email list may contain multiple
- * recipients. Email lists themselves are described by
- * Zend_Gdata_EmailListEntry. Multiple recipient entries are contained within
- * instances of Zend_Gdata_Gapps_EmailListRecipientFeed.
- *
- * To transfer email list recipients to and from the Google Apps servers,
- * including creating new recipients, refer to the Google Apps service class,
- * Zend_Gdata_Gapps.
- *
- * This class represents <atom:entry> in the Google Data protocol.
- *
- * @category Zend
- * @package Zend_Gdata
- * @subpackage Gapps
- * @copyright Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)
- * @license http://framework.zend.com/license/new-bsd New BSD License
- */
- class Zend_Gdata_Gapps_EmailListRecipientEntry extends Zend_Gdata_Entry
- {
- protected $_entryClassName = 'Zend_Gdata_Gapps_EmailListRecipientEntry';
- /**
- * <gd:who> element used to store the email address of the current
- * recipient. Only the email property of this element should be
- * populated.
- *
- * @var Zend_Gdata_Extension_Who
- */
- protected $_who = null;
- /**
- * Create a new instance.
- *
- * @param DOMElement $element (optional) DOMElement from which this
- * object should be constructed.
- */
- public function __construct($element = null)
- {
- $this->registerAllNamespaces(Zend_Gdata_Gapps::$namespaces);
- parent::__construct($element);
- }
- /**
- * 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 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->_who !== null) {
- $element->appendChild($this->_who->getDOM($element->ownerDocument));
- }
- return $element;
- }
- /**
- * Creates individual Entry objects of the appropriate type and
- * stores them as members of this entry based upon DOM data.
- *
- * @param DOMNode $child The DOMNode to process
- */
- protected function takeChildFromDOM($child)
- {
- $absoluteNodeName = $child->namespaceURI . ':' . $child->localName;
- switch ($absoluteNodeName) {
- case $this->lookupNamespace('gd') . ':' . 'who';
- $who = new Zend_Gdata_Extension_Who();
- $who->transferFromDOM($child);
- $this->_who = $who;
- break;
- default:
- parent::takeChildFromDOM($child);
- break;
- }
- }
- /**
- * Get the value of the who property for this object.
- *
- * @see setWho
- * @return Zend_Gdata_Extension_Who The requested object.
- */
- public function getWho()
- {
- return $this->_who;
- }
- /**
- * Set the value of the who property for this object. This property
- * is used to store the email address of the current recipient.
- *
- * @param Zend_Gdata_Extension_Who $value The desired value for this
- * instance's who property.
- * @return Zend_Gdata_Gapps_EventEntry Provides a fluent interface.
- */
- public function setWho($value)
- {
- $this->_who = $value;
- return $this;
- }
- }