[Summary view] [Print] [Text view]

   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 [email protected] so we can send you a copy immediately.
  15   *
  16   * @category   Zend
  17   * @package    Zend_Gdata
  18   * @subpackage Calendar
  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   * @version    $Id$
  22   */
  23  
  24  /**
  25   * @see Zend_Gdata_Extension
  26   */
  27  require_once 'Zend/Gdata/Extension.php';
  28  
  29  /**
  30   * Represents the gCal:hidden element used by the Calendar data API
  31   *
  32   * @category   Zend
  33   * @package    Zend_Gdata
  34   * @subpackage Calendar
  35   * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
  36   * @license    http://framework.zend.com/license/new-bsd     New BSD License
  37   */
  38  class Zend_Gdata_Calendar_Extension_Hidden extends Zend_Gdata_Extension
  39  {
  40  
  41      protected $_rootNamespace = 'gCal';
  42      protected $_rootElement = 'hidden';
  43      protected $_value = null;
  44  
  45      /**
  46       * Constructs a new Zend_Gdata_Calendar_Extension_Hidden object.
  47       * @param bool $value (optional) The value of the element.
  48       */
  49      public function __construct($value = null)
  50      {
  51          $this->registerAllNamespaces(Zend_Gdata_Calendar::$namespaces);
  52          parent::__construct();
  53          $this->_value = $value;
  54      }
  55  
  56      /**
  57       * Retrieves a DOMElement which corresponds to this element and all
  58       * child properties.  This is used to build an entry back into a DOM
  59       * and eventually XML text for sending to the server upon updates, or
  60       * for application storage/persistence.
  61       *
  62       * @param DOMDocument $doc The DOMDocument used to construct DOMElements
  63       * @return DOMElement The DOMElement representing this element and all
  64       * child properties.
  65       */
  66      public function getDOM($doc = null, $majorVersion = 1, $minorVersion = null)
  67      {
  68          $element = parent::getDOM($doc, $majorVersion, $minorVersion);
  69          if ($this->_value !== null) {
  70              $element->setAttribute('value', ($this->_value ? "true" : "false"));
  71          }
  72          return $element;
  73      }
  74  
  75      /**
  76       * Given a DOMNode representing an attribute, tries to map the data into
  77       * instance members.  If no mapping is defined, the name and value are
  78       * stored in an array.
  79       *
  80       * @param DOMNode $attribute The DOMNode attribute needed to be handled
  81       */
  82      protected function takeAttributeFromDOM($attribute)
  83      {
  84          switch ($attribute->localName) {
  85          case 'value':
  86              if ($attribute->nodeValue == "true") {
  87                  $this->_value = true;
  88              }
  89              else if ($attribute->nodeValue == "false") {
  90                  $this->_value = false;
  91              }
  92              else {
  93                  require_once 'Zend/Gdata/App/InvalidArgumentException.php';
  94                  throw new Zend_Gdata_App_InvalidArgumentException("Expected 'true' or 'false' for gCal:selected#value.");
  95              }
  96              break;
  97          default:
  98              parent::takeAttributeFromDOM($attribute);
  99          }
 100      }
 101  
 102      /**
 103       * Get the value for this element's value attribute.
 104       *
 105       * @return string The requested attribute.
 106       */
 107      public function getValue()
 108      {
 109          return $this->_value;
 110      }
 111  
 112      /**
 113       * Set the value for this element's value attribute.
 114       *
 115       * @param bool $value The desired value for this attribute.
 116       * @return Zend_Gdata_Calendar_Extension_Hidden The element being modified.
 117       */
 118      public function setValue($value)
 119      {
 120          $this->_value = $value;
 121          return $this;
 122      }
 123  
 124      /**
 125       * Magic toString method allows using this directly via echo
 126       * Works best in PHP >= 4.2.0
 127       */
 128      public function __toString()
 129      {
 130          return $this->_value;
 131      }
 132  
 133  }
 134