Zend_Gdata_Gapps_Error Class Reference

Public Member Functions
	__construct ($errorCode=null, $reason=null, $invalidInput=null)
	setErrorCode ($value)
	Set the error code for this exception.
	getErrorCode ()
	Get the error code for this exception.
	setReason ($value)
	Set human-readable text describing the reason this exception occurred.
	getReason ()
	Get human-readable text describing the reason this exception occurred.
	setInvalidInput ($value)
	Set the invalid input which caused this exception.
	getInvalidInput ()
	Set the invalid input which caused this exception.
	getDOM ($doc=null, $majorVersion=1, $minorVersion=null)
	Retrieves a DOMElement which corresponds to this element and all child properties.
	__toString ()
	Get a human readable version of this exception.
Public Member Functions inherited from Zend_Gdata_App_Base
	__construct ()
	getText ($trim=true)
	Returns the child text node of this element This represents any raw text contained within the XML element.
	setText ($value)
	Sets the child text node of this element This represents any raw text contained within the XML element.
	getExtensionElements ()
	Returns an array of all elements not matched to data model classes during the parsing of the XML.
	setExtensionElements ($value)
	Sets an array of all elements not matched to data model classes during the parsing of the XML.
	getExtensionAttributes ()
	Returns an array of all extension attributes not transformed into data model properties during parsing of the XML.
	setExtensionAttributes ($value)
	Sets an array of all extension attributes not transformed into data model properties during parsing of the XML.
	getDOM ($doc=null, $majorVersion=1, $minorVersion=null)
	Retrieves a DOMElement which corresponds to this element and all child properties.
	transferFromDOM ($node)
	Transfers each child and attribute into member variables.
	transferFromXML ($xml)
	Parses the provided XML text and generates data model classes for each know element by turning the XML text into a DOM tree and calling transferFromDOM($element).
	saveXML ()
	Converts this element and all children into XML text using getDOM()
	getXML ()
	Alias for saveXML() returns XML content for this element and all children.
	encode ()
	Alias for saveXML()
	lookupNamespace ($prefix, $majorVersion=1, $minorVersion=null)
	Get the full version of a namespace prefix.
	registerNamespace ($prefix, $namespaceUri, $majorVersion=1, $minorVersion=0)
	Add a namespace and prefix to the registered list.
	registerAllNamespaces ($namespaceArray)
	Add an array of namespaces to the registered list.
	__get ($name)
	Magic getter to allow access like $entry->foo to call $entry->getFoo() Alternatively, if no getFoo() is defined, but a $_foo protected variable is defined, this is returned.
	__set ($name, $val)
	Magic setter to allow acces like $entry->foo='bar' to call $entry->setFoo('bar') automatically.
	__isset ($name)
	Magic __isset method.
	__unset ($name)
	Magic __unset method.
	__toString ()
	Magic toString method allows using this directly via echo Works best in PHP >= 4.2.0.

Public Attributes
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)
	Given a DOMNode representing an attribute, tries to map the data into instance members.
Protected Member Functions inherited from Zend_Gdata_App_Base
	takeChildFromDOM ($child)
	Given a child DOMNode, tries to determine how to map the data into object instance members.
	takeAttributeFromDOM ($attribute)
	Given a DOMNode representing an attribute, tries to map the data into instance members.

Protected Attributes
	$_errorCode = null
	$_reason = null
	$_invalidInput = null
Protected Attributes inherited from Zend_Gdata_App_Base
	$_rootElement = null
	$_rootNamespace = 'atom'
	$_rootNamespaceURI = null
	$_extensionElements = array()
	$_extensionAttributes = array()
	$_text = null
	$_namespaces

Additional Inherited Members
Static Public Member Functions inherited from Zend_Gdata_App_Base
static	flushNamespaceLookupCache ()
	Flush namespace lookup cache.
Static Protected Attributes inherited from Zend_Gdata_App_Base
static	$_namespaceLookupCache = array()

Constructor & Destructor Documentation

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

Member Function Documentation

__toString

(

)

Get a human readable version of this exception.

Returns

string

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.

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.

getInvalidInput

(

)

Set the invalid input which caused this exception.

See Also

setInvalidInput

Returns

string The reason this exception occurred.

getReason

(

)

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

See Also

setReason

Returns

string The reason this exception occurred.

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.

setInvalidInput

(

$value

)

Set the invalid input which caused this exception.

See Also

getInvalidInput

Parameters

string

$value

The invalid input that triggered this exception.

setReason

(

$value

)

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

See Also

getReason

Parameters

string

$value

The reason this exception occurred.

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

Member Data Documentation

$_errorCode = null

protected

$_invalidInput = null

protected

$_reason = null

protected

const DOMAIN_ALIAS_LIMIT_EXCEEDED = 1201

const DOMAIN_FEATURE_UNAVAILABLE = 1203

const DOMAIN_SUSPENDED = 1202

const DOMAIN_USER_LIMIT_EXCEEDED = 1200

const ENTITY_DOES_NOT_EXIST = 1301

const ENTITY_EXISTS = 1300

const ENTITY_NAME_IS_RESERVED = 1302

const ENTITY_NAME_NOT_VALID = 1303

const INVALID_EMAIL_ADDRESS = 1406

const INVALID_FAMILY_NAME = 1401

const INVALID_GIVEN_NAME = 1400

const INVALID_HASH_DIGEST_LENGTH = 1405

const INVALID_HASH_FUNCTION_NAME = 1404

const INVALID_PASSWORD = 1402

const INVALID_QUERY_PARAMETER_VALUE = 1407

const INVALID_USERNAME = 1403

const TOO_MANY_RECIPIENTS_ON_EMAIL_LIST = 1500

const UNKNOWN_ERROR = 1000

const USER_DELETED_RECENTLY = 1100

const USER_SUSPENDED = 1101