Inheritance diagram for Zend_Gdata_Gapps_Error:

Collaboration diagram for Zend_Gdata_Gapps_Error:

Public Member Functions
	__construct ($errorCode=null, $reason=null, $invalidInput=null)
	setErrorCode ($value)
	getErrorCode ()
	setReason ($value)
	getReason ()
	setInvalidInput ($value)
	getInvalidInput ()
	getDOM ($doc=null, $majorVersion=1, $minorVersion=null)
	__toString ()
Data Fields
const	UNKNOWN_ERROR = 1000
const	USER_DELETED_RECENTLY = 1100
const	USER_SUSPENDED = 1101
const	DOMAIN_USER_LIMIT_EXCEEDED = 1200
const	DOMAIN_ALIAS_LIMIT_EXCEEDED = 1201
const	DOMAIN_SUSPENDED = 1202
const	DOMAIN_FEATURE_UNAVAILABLE = 1203
const	ENTITY_EXISTS = 1300
const	ENTITY_DOES_NOT_EXIST = 1301
const	ENTITY_NAME_IS_RESERVED = 1302
const	ENTITY_NAME_NOT_VALID = 1303
const	INVALID_GIVEN_NAME = 1400
const	INVALID_FAMILY_NAME = 1401
const	INVALID_PASSWORD = 1402
const	INVALID_USERNAME = 1403
const	INVALID_HASH_FUNCTION_NAME = 1404
const	INVALID_HASH_DIGEST_LENGTH = 1405
const	INVALID_EMAIL_ADDRESS = 1406
const	INVALID_QUERY_PARAMETER_VALUE = 1407
const	TOO_MANY_RECIPIENTS_ON_EMAIL_LIST = 1500
Protected Member Functions
	takeAttributeFromDOM ($attribute)
Protected Attributes
	$_errorCode = null
	$_reason = null
	$_invalidInput = null

Detailed Description

Definition at line 45 of file Error.php.

Constructor & Destructor Documentation

__construct	(	$	errorCode = `null`,
		$	reason = `null`,
		$	invalidInput = `null`
	)

Definition at line 76 of file Error.php.

Here is the call graph for this function:

Member Function Documentation

__toString ( )

Get a human readable version of this exception.

Returns:: string

Reimplemented from Zend_Gdata_App_Base.

Definition at line 228 of file Error.php.

Here is the call graph for this function:

getDOM	(	$	doc = `null`,
		$	majorVersion = `1`,
		$	minorVersion = `null`
	)

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.

Parameters:

DOMDocument $doc The DOMDocument used to construct DOMElements

Returns:: DOMElement The DOMElement representing this element and all child properties.

Reimplemented from Zend_Gdata_App_Base.

Definition at line 184 of file Error.php.

getErrorCode ( )

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.

Google Apps Provisioning API Reference: Appendix D - Gdata Error Codes setErrorCode integer The error code returned by the Google Apps server.

Definition at line 131 of file Error.php.

Here is the caller graph for this function:

getInvalidInput ( )

Set the invalid input which caused this exception.

See also:: setInvalidInput

Returns:: string The reason this exception occurred.

Definition at line 171 of file Error.php.

Here is the caller graph for this function:

getReason ( )

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

See also:: setReason

Returns:: string The reason this exception occurred.

Definition at line 151 of file Error.php.

Here is the caller graph for this function:

setErrorCode ( $ value )

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

See also:: getErrorCode

Parameters:

integer $value The new value for the error code.

Definition at line 91 of file Error.php.

setInvalidInput ( $ value )

Set the invalid input which caused this exception.

See also:: getInvalidInput

Parameters:

string $value The invalid input that triggered this exception.

Definition at line 161 of file Error.php.

setReason ( $ value )

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

See also:: getReason

Parameters:

string $value The reason this exception occurred.

Definition at line 141 of file Error.php.

takeAttributeFromDOM ( $ attribute ) [protected]

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:

DOMNode $attribute The DOMNode attribute needed to be handled

Reimplemented from Zend_Gdata_App_Base.

Definition at line 206 of file Error.php.