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

    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:quota element used by the Apps data API. This is

    36  * used to indicate the amount of storage space available to a user. Quotas

    37  * may not be able to be set, depending on the domain used. This class

    38  * is usually contained within an instance of Zend_Gdata_Gapps_UserEntry.

    39  *

    40  * @category   Zend

    41  * @package    Zend_Gdata

    42  * @subpackage Gapps

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

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

    45  */

    46 class Zend_Gdata_Gapps_Extension_Quota extends Zend_Gdata_Extension

    47 {

    48 

    49     protected $_rootNamespace = 'apps';

    50     protected $_rootElement = 'quota';

    51 

    52     /**

    53      * The amount of storage space available to the user in megabytes.

    54      *

    55      * @var integer

    56      */

    57     protected $_limit = null;

    58 

    59     /**

    60      * Constructs a new Zend_Gdata_Gapps_Extension_Quota object.

    61      *

    62      * @param string $limit (optional) The limit, in bytes, for this quota.

    63      */

    64     public function __construct($limit = null)

    65     {

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

    67         parent::__construct();

    68         $this->_limit = $limit;

    69     }

    70 

    71     /**

    72      * Retrieves a DOMElement which corresponds to this element and all

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

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

    75      * for application storage/persistence.

    76      *

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

    78      * @return DOMElement The DOMElement representing this element and all

    79      * child properties.

    80      */

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

    82     {

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

    84         if ($this->_limit !== null) {

    85             $element->setAttribute('limit', $this->_limit);

    86         }

    87         return $element;

    88     }

    89 

    90     /**

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

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

    93      * stored in an array.

    94      *

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

    96      */

    97     protected function takeAttributeFromDOM($attribute)

    98     {

    99         switch ($attribute->localName) {

   100         case 'limit':

   101             $this->_limit = $attribute->nodeValue;

   102             break;

   103         default:

   104             parent::takeAttributeFromDOM($attribute);

   105         }

   106     }

   107 

   108     /**

   109      * Get the value for this element's limit attribute.

   110      *

   111      * @see setLimit

   112      * @return string The requested attribute.

   113      */

   114     public function getLimit()

   115     {

   116         return $this->_limit;

   117     }

   118 

   119     /**

   120      * Set the value for this element's limit attribute. This is the amount

   121      * of storage space, in bytes, that should be made available to

   122      * the associated user.

   123      *

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

   125      * @return Zend_Gdata_Gapps_Extension_Quota Provides a fluent interface.

   126      */

   127     public function setLimit($value)

   128     {

   129         $this->_limit = $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->getLimit();

   140     }

   141 

   142 }