Docs For Class Zend_Gdata_Gapps

Description

Gdata Gapps Error class. This class is used to represent errors returned within an AppsForYourDomainErrors message received from the Google Apps servers.

Several different errors may be represented by this class, determined by the error code returned by the server. For a list of error codes available at the time of this writing, see getErrorCode.

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

Located in /Gdata/Gapps/Error.php (line 45)

Zend_Gdata_App_Base
   |
   --Zend_Gdata_Gapps_Error

Class Constant Summary

DOMAIN_ALIAS_LIMIT_EXCEEDED = 1201

DOMAIN_FEATURE_UNAVAILABLE = 1203

DOMAIN_SUSPENDED = 1202

DOMAIN_USER_LIMIT_EXCEEDED = 1200

ENTITY_DOES_NOT_EXIST = 1301

ENTITY_EXISTS = 1300

ENTITY_NAME_IS_RESERVED = 1302

ENTITY_NAME_NOT_VALID = 1303

INVALID_EMAIL_ADDRESS = 1406

INVALID_FAMILY_NAME = 1401

INVALID_GIVEN_NAME = 1400

INVALID_HASH_DIGEST_LENGTH = 1405

INVALID_HASH_FUNCTION_NAME = 1404

INVALID_PASSWORD = 1402

INVALID_QUERY_PARAMETER_VALUE = 1407

INVALID_USERNAME = 1403

TOO_MANY_RECIPIENTS_ON_EMAIL_LIST = 1500

UNKNOWN_ERROR = 1000

USER_DELETED_RECENTLY = 1100

USER_SUSPENDED = 1101

Variable Summary

mixed $_errorCode

mixed $_invalidInput

mixed $_reason

Method Summary

DOMElement getDOM ([DOMDocument $doc = null], [ $majorVersion = 1], [ $minorVersion = null])

integer getErrorCode ()

string getInvalidInput ()

string getReason ()

void setErrorCode (integer $value)

void setInvalidInput (string $value)

void setReason (string $value)

void takeAttributeFromDOM (DOMNode $attribute)

Zend_Gdata_Gapps_Error __construct ([ $errorCode = null], [ $reason = null], [ $invalidInput = null])

string __toString ()

Variables

mixed $_errorCode = null (line 72)

access: protected

mixed $_invalidInput = null (line 74)

access: protected

mixed $_reason = null (line 73)

access: protected

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::$_rootElement
Zend_Gdata_App_Base::$_rootNamespace
Zend_Gdata_App_Base::$_rootNamespaceURI
Zend_Gdata_App_Base::$_text

Methods

getDOM (line 184)

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.

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.

getErrorCode (line 131)

Get the error code for this exception. Currently valid values are available as constants within this class. These values are:

UNKNOWN_ERROR (1000) USER_DELETED_RECENTLY (1100) USER_SUSPENDED (1101) DOMAIN_USER_LIMIT_EXCEEDED (1200) DOMAIN_ALIAS_LIMIT_EXCEEDED (1201) DOMAIN_SUSPENDED (1202) DOMAIN_FEATURE_UNAVAILABLE (1203) ENTITY_EXISTS (1300) ENTITY_DOES_NOT_EXIST (1301) ENTITY_NAME_IS_RESERVED (1302) ENTITY_NAME_NOT_VALID (1303) INVALID_GIVEN_NAME (1400) INVALID_FAMILY_NAME (1401) INVALID_PASSWORD (1402) INVALID_USERNAME (1403) INVALID_HASH_FUNCTION_NAME (1404) INVALID_HASH_DIGEST_LENGTH (1405) INVALID_EMAIL_ADDRESS (1406) INVALID_QUERY_PARAMETER_VALUE (1407) TOO_MANY_RECIPIENTS_ON_EMAIL_LIST (1500)

Numbers in parenthesis indicate the actual integer value of the constant. This list should not be treated as exhaustive, as additional error codes may be added at any time.

For more information about these codes and their meaning, please see Appendix D of the Google Apps Provisioning API Reference.

return: The error code returned by the Google Apps server.
see: Zend_Gdata_Gapps_Error::setErrorCode()
link: Google Apps Provisioning API Reference: Appendix D - Gdata Error Codes
access: public

integer getErrorCode ()

getInvalidInput (line 171)

Set the invalid input which caused this exception.

return: The reason this exception occurred.
see: Zend_Gdata_Gapps_Error::setInvalidInput()
access: public

string getInvalidInput ()

getReason (line 151)

Get human-readable text describing the reason this exception occurred.

return: The reason this exception occurred.
see: Zend_Gdata_Gapps_Error::setReason()
access: public

string getReason ()

setErrorCode (line 91)

Set the error code for this exception. For more information about error codes, see getErrorCode.

see: Zend_Gdata_Gapps_Error::getErrorCode()
access: public

void setErrorCode (integer $value)

integer $value: The new value for the error code.

setInvalidInput (line 161)

Set the invalid input which caused this exception.

see: Zend_Gdata_Gapps_Error::getInvalidInput()
access: public

void setInvalidInput (string $value)

string $value: The invalid input that triggered this exception.

setReason (line 141)

Set human-readable text describing the reason this exception occurred.

see: Zend_Gdata_Gapps_Error::getReason()
access: public

void setReason (string $value)

string $value: The reason this exception occurred.

takeAttributeFromDOM (line 206)

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.

Constructor __construct (line 76)

access: public

Zend_Gdata_Gapps_Error __construct ([ $errorCode = null], [ $reason = null], [ $invalidInput = null])

$errorCode
$reason
$invalidInput

Redefinition of:

Zend_Gdata_App_Base::__construct()

__toString (line 228)

Get a human readable version of this exception.

access: public

string __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_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()

Class Constants

DOMAIN_ALIAS_LIMIT_EXCEEDED = 1201 (line 55)

DOMAIN_FEATURE_UNAVAILABLE = 1203 (line 57)

DOMAIN_SUSPENDED = 1202 (line 56)

DOMAIN_USER_LIMIT_EXCEEDED = 1200 (line 54)

ENTITY_DOES_NOT_EXIST = 1301 (line 59)

ENTITY_EXISTS = 1300 (line 58)

ENTITY_NAME_IS_RESERVED = 1302 (line 60)

ENTITY_NAME_NOT_VALID = 1303 (line 61)

INVALID_EMAIL_ADDRESS = 1406 (line 68)

INVALID_FAMILY_NAME = 1401 (line 63)

INVALID_GIVEN_NAME = 1400 (line 62)

INVALID_HASH_DIGEST_LENGTH = 1405 (line 67)

INVALID_HASH_FUNCTION_NAME = 1404 (line 66)

INVALID_PASSWORD = 1402 (line 64)

INVALID_QUERY_PARAMETER_VALUE = 1407 (line 69)

INVALID_USERNAME = 1403 (line 65)

TOO_MANY_RECIPIENTS_ON_EMAIL_LIST = 1500 (line 70)

UNKNOWN_ERROR = 1000 (line 51)

USER_DELETED_RECENTLY = 1100 (line 52)

USER_SUSPENDED = 1101 (line 53)