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.
category | Zend |
---|---|
package | Zend_Gdata |
subpackage | Gapps |
copyright | Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com) |
license | New BSD License |
inherited_from | \Zend_Gdata_App_Base |
__construct($errorCode= null
, $reason= null
, $invalidInput= null
)
inherited_from | \Zend_Gdata_App_Base::__construct() |
---|
__construct()
__get(string $name)
TODO Remove ability to bypass getFoo() methods??
string
The variable name sought
__isset(string $name)
string
__set(string $name, $val)
Alternatively, if no setFoo() is defined, but a $_foo protected variable is defined, this is returned.
TODO Remove ability to bypass getFoo() methods??
string
__toString() : string
inherited_from | \Zend_Gdata_App_Base::__toString() |
---|
string
__toString() : string
string
The text representation of this object__unset(string $name)
string
encode() : string
Can be overridden by children to provide more complex representations of entries.
string
Encoded string contentflushNamespaceLookupCache()
Empties the namespace lookup cache. Call this function if you have added data to the namespace lookup table that contradicts values that may have been cached during a previous call to lookupNamespace().
getDOM(\DOMDocument $doc= null
, $majorVersion= 1
, $minorVersion= null
) : \DOMElement
inherited_from | \Zend_Gdata_App_Base::getDOM() |
---|
\DOMDocument
The DOMDocument used to construct DOMElements
\DOMElement
The DOMElement representing this element and all
child properties.getDOM(\DOMDocument $doc= null
, $majorVersion= 1
, $minorVersion= null
) : \DOMElement
\DOMDocument
The DOMDocument used to construct DOMElements
\DOMElement
The DOMElement representing this element and all
child properties.getErrorCode() : integer
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.
link | Google Apps Provisioning API Reference: Appendix D - Gdata Error Codes |
---|---|
see |
integer
The error code returned by the Google Apps server.getExtensionAttributes() : array
array
All extension attributesgetExtensionElements() : array
array
All elements not matched to data model classes during parsinggetInvalidInput() : string
getReason() : string
getText($trim = true
) : string
string
Child text nodegetXML() : string
string
XML contentlookupNamespace(string $prefix, integer $majorVersion= 1
, integer $minorVersion= null
) : string
Looks up a prefix (atom:, etc.) in the list of registered namespaces and returns the full namespace URI if available. Returns the prefix, unmodified, if it's not registered.
string
The namespace prefix to lookup.
integer
The major protocol version in effect. Defaults to '1'.
integer
The minor protocol version in effect. Defaults to null (use latest).
string
registerAllNamespaces(array $namespaceArray) : void
Takes an array in the format of: namespace prefix, namespace URI, major protocol version, minor protocol version and adds them with calls to ->registerNamespace()
array
An array of namespaces.
registerNamespace(string $prefix, string $namespaceUri, integer $majorVersion= 1
, integer $minorVersion= 0
) : void
Takes a prefix and a full namespace URI and adds them to the list of registered namespaces for use by $this->lookupNamespace().
WARNING: Currently, registering a namespace will NOT invalidate any memoized data stored in $_namespaceLookupCache. Under normal use, this behavior is acceptable. If you are adding contradictory data to the namespace lookup table, you must call flushNamespaceLookupCache().
string
The namespace prefix
string
The full namespace URI
integer
The major protocol version in effect. Defaults to '1'.
integer
The minor protocol version in effect. Defaults to null (use latest).
saveXML() : string
string
XML contentsetErrorCode(integer $value)
setExtensionAttributes(array $value) : \Zend_Gdata_App_Base
array
All extension attributes
\Zend_Gdata_App_Base
Returns an object of the same type as 'this' to provide a fluent interface.setExtensionElements(array $value) : \Zend_Gdata_App_Base
array
All extension elements
\Zend_Gdata_App_Base
Returns an object of the same type as 'this' to provide a fluent interface.setInvalidInput(string $value)
setReason(string $value)
setText(string $value) : \Zend_Gdata_App_Base
string
Child text node
\Zend_Gdata_App_Base
Returns an object of the same type as 'this' to provide a fluent interface.transferFromDOM(\DOMNode $node)
This is called when XML is received over the wire and the data model needs to be built to represent this XML.
\DOMNode
The DOMNode that represents this object's data
transferFromXML(string $xml)
string
The XML text to parse
takeAttributeFromDOM(\DOMNode $attribute)
inherited_from | \Zend_Gdata_App_Base::takeAttributeFromDOM() |
---|
\DOMNode
The DOMNode attribute needed to be handled
takeAttributeFromDOM(\DOMNode $attribute)
\DOMNode
The DOMNode attribute needed to be handled
takeChildFromDOM(\DOMNode $child)
\DOMNode
The DOMNode needed to be handled
$_errorCode
null
$_extensionAttributes : array
array()
$_extensionElements : array
array()
$_invalidInput
null
$_namespaceLookupCache : array
array()
$_namespaces : array
array('atom' => array(1 => array(0 => 'http://www.w3.org/2005/Atom')), 'app' => array(1 => array(0 => 'http://purl.org/atom/app#'), 2 => array(0 => 'http://www.w3.org/2007/app')))
$_reason
null
$_rootElement : string
null
$_rootNamespace : string
'atom'
$_rootNamespaceURI : string
null
$_text : string
null
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