[ Index ]

PHP Cross Reference of moodle-2.8

title

Body

[close]

/lib/zend/Zend/Gdata/Gapps/ -> Error.php (summary)

Zend Framework LICENSE

Copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
License: http://framework.zend.com/license/new-bsd New BSD License
Version: $Id$
File Size: 233 lines (8 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

Zend_Gdata_Gapps_Error:: (10 methods):
  __construct()
  setErrorCode()
  getErrorCode()
  setReason()
  getReason()
  setInvalidInput()
  getInvalidInput()
  getDOM()
  takeAttributeFromDOM()
  __toString()


Class: Zend_Gdata_Gapps_Error  - X-Ref

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.

__construct($errorCode = null, $reason = null,$invalidInput = null)   X-Ref
No description

setErrorCode($value)   X-Ref
Set the error code for this exception. For more information about
error codes, see getErrorCode.

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

getErrorCode()   X-Ref
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: integer The error code returned by the Google Apps server.

setReason($value)   X-Ref
Set human-readable text describing the reason this exception occurred.

param: string $value The reason this exception occurred.

getReason()   X-Ref
Get human-readable text describing the reason this exception occurred.

return: string The reason this exception occurred.

setInvalidInput($value)   X-Ref
Set the invalid input which caused this exception.

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

getInvalidInput()   X-Ref
Set the invalid input which caused this exception.

return: string The reason this exception occurred.

getDOM($doc = null, $majorVersion = 1, $minorVersion = null)   X-Ref
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.

param: DOMDocument $doc The DOMDocument used to construct DOMElements
return: DOMElement The DOMElement representing this element and all

takeAttributeFromDOM($attribute)   X-Ref
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.

param: DOMNode $attribute The DOMNode attribute needed to be handled

__toString()   X-Ref
Get a human readable version of this exception.

return: string



Generated: Fri Nov 28 20:29:05 2014 Cross-referenced by PHPXref 0.7.1