Class Zend_Gdata_Gapps_Extension_Quota

Description

Represents the apps:quota element used by the Apps data API. This is used to indicate the amount of storage space available to a user. Quotas may not be able to be set, depending on the domain used. This class is usually contained within an instance of Zend_Gdata_Gapps_UserEntry.

  • copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
  • license: New BSD License

Located in /Gdata/Gapps/Extension/Quota.php (line 46)

Zend_Gdata_App_Base
   |
   --Zend_Gdata_App_Extension
      |
      --Zend_Gdata_Extension
         |
         --Zend_Gdata_Gapps_Extension_Quota
Variable Summary
 integer $_limit
Method Summary
 Zend_Gdata_Gapps_Extension_Quota __construct ([string $limit = null])
 DOMElement getDOM ([DOMDocument $doc = null], [ $majorVersion = 1], [ $minorVersion = null])
 string getLimit ()
 void takeAttributeFromDOM (DOMNode $attribute)
 void __toString ()
Variables
integer $_limit = null (line 57)

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

  • access: protected
mixed $_rootElement = 'quota' (line 50)
  • access: protected

Redefinition of:
Zend_Gdata_App_Base::$_rootElement
mixed $_rootNamespace = 'apps' (line 49)
  • access: protected

Redefinition of:
Zend_Gdata_Extension::$_rootNamespace

Inherited Variables

Inherited from Zend_Gdata_App_Base

Zend_Gdata_App_Base::$_extensionAttributes
Zend_Gdata_App_Base::$_extensionElements
Zend_Gdata_App_Base::$_namespaceLookupCache
Zend_Gdata_App_Base::$_namespaces
Zend_Gdata_App_Base::$_rootNamespaceURI
Zend_Gdata_App_Base::$_text
Methods
Constructor __construct (line 64)

Constructs a new Zend_Gdata_Gapps_Extension_Quota object.

  • access: public
Zend_Gdata_Gapps_Extension_Quota __construct ([string $limit = null])
  • string $limit: (optional) The limit, in bytes, for this quota.

Redefinition of:
Zend_Gdata_Extension::__construct()
getDOM (line 81)

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.

  • return: The DOMElement representing this element and all child properties.
  • access: public
DOMElement getDOM ([DOMDocument $doc = null], [ $majorVersion = 1], [ $minorVersion = null])
  • DOMDocument $doc: The DOMDocument used to construct DOMElements
  • $majorVersion
  • $minorVersion

Redefinition of:
Zend_Gdata_App_Base::getDOM()
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.
getLimit (line 114)

Get the value for this element's limit attribute.

string getLimit ()
setLimit (line 127)

Set the value for this element's limit attribute. This is the amount of storage space, in bytes, that should be made available to the associated user.

  • return: Provides a fluent interface.
  • access: public
Zend_Gdata_Gapps_Extension_Quota setLimit (string $value)
  • string $value: The desired value for this attribute.
takeAttributeFromDOM (line 97)

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.

  • access: protected
void takeAttributeFromDOM (DOMNode $attribute)
  • DOMNode $attribute: The DOMNode attribute needed to be handled

Redefinition of:
Zend_Gdata_App_Base::takeAttributeFromDOM()
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.
__toString (line 137)

Magic toString method allows using this directly via echo

Works best in PHP >= 4.2.0

  • access: public
void __toString ()

Redefinition of:
Zend_Gdata_App_Base::__toString()
Magic toString method allows using this directly via echo Works best in PHP >= 4.2.0

Inherited Methods

Inherited From Zend_Gdata_Extension

 Zend_Gdata_Extension::__construct()

Inherited From Zend_Gdata_App_Base

 Zend_Gdata_App_Base::__construct()
 Zend_Gdata_App_Base::encode()
 Zend_Gdata_App_Base::flushNamespaceLookupCache()
 Zend_Gdata_App_Base::getDOM()
 Zend_Gdata_App_Base::getExtensionAttributes()
 Zend_Gdata_App_Base::getExtensionElements()
 Zend_Gdata_App_Base::getText()
 Zend_Gdata_App_Base::getXML()
 Zend_Gdata_App_Base::lookupNamespace()
 Zend_Gdata_App_Base::registerAllNamespaces()
 Zend_Gdata_App_Base::registerNamespace()
 Zend_Gdata_App_Base::saveXML()
 Zend_Gdata_App_Base::setExtensionAttributes()
 Zend_Gdata_App_Base::setExtensionElements()
 Zend_Gdata_App_Base::setText()
 Zend_Gdata_App_Base::takeAttributeFromDOM()
 Zend_Gdata_App_Base::takeChildFromDOM()
 Zend_Gdata_App_Base::transferFromDOM()
 Zend_Gdata_App_Base::transferFromXML()
 Zend_Gdata_App_Base::__get()
 Zend_Gdata_App_Base::__isset()
 Zend_Gdata_App_Base::__set()
 Zend_Gdata_App_Base::__toString()
 Zend_Gdata_App_Base::__unset()

Documentation generated on Mon, 21 Jun 2010 15:40:55 -0400 by phpDocumentor 1.4.3