API Documentation

Zend/Gdata/Gapps/Extension/Quota.php

Show: inherited
Table of Contents

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  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Gdata  
Subpackage
Gapps  
Version
$Id: Quota.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_Gdata_Gapps_Extension_Quota

Package: Zend\Gdata\Gapps

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.

Parent(s)
\Zend_Gdata_Extension < \Zend_Gdata_App_Extension < \Zend_Gdata_App_Base
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprotectedinteger  $_limit= 'null'

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

Default valuenullDetails
Type
integer
Propertyprotected  $_rootElement= ''quota''
Default value'quota'Details
Type
Propertyprotected  $_rootNamespace= ''apps''
Default value'apps'Details
Type

Methods

methodpublic__construct( string $limit = null ) : void

Constructs a new Zend_Gdata_Gapps_Extension_Quota object.

Parameters
Name Type Description
$limit string

(optional) The limit, in bytes, for this quota.

methodpublic__toString( ) : void

Magic toString method allows using this directly via echo Works best in PHP >= 4.2.0

methodpublicgetDOM( \DOMDocument $doc = null,  $majorVersion = 1,  $minorVersion = null ) : \DOMElement

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.

Parameters
Name Type Description
$doc \DOMDocument

The DOMDocument used to construct DOMElements

$majorVersion
$minorVersion
Returns
Type Description
\DOMElement The DOMElement representing this element and all child properties.
methodpublicgetLimit( ) : string

Get the value for this element's limit attribute.

Returns
Type Description
string The requested attribute.
Details
See
\setLimit  
methodpublicsetLimit( string $value ) : \Zend_Gdata_Gapps_Extension_Quota

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.

Parameters
Name Type Description
$value string

The desired value for this attribute.

Returns
Type Description
\Zend_Gdata_Gapps_Extension_Quota Provides a fluent interface.
methodprotectedtakeAttributeFromDOM( \DOMNode $attribute ) : void

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.

Parameters
Name Type Description
$attribute \DOMNode

The DOMNode attribute needed to be handled

Documentation was generated by DocBlox 0.15.1.