API Documentation

Gdata/Gapps/Error.php

Includes Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Gdata
subpackage
Gapps
version
$Id: Error.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Gdata_Gapps_Error

Description

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Zend_Gdata_Gapps_Error
jump to top

Extends from
Zend_Gdata_App_Base
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Gdata
subpackage
Gapps
Constants
UNKNOWN_ERROR
USER_DELETED_RECENTLY
USER_SUSPENDED
DOMAIN_USER_LIMIT_EXCEEDED
DOMAIN_ALIAS_LIMIT_EXCEEDED
DOMAIN_SUSPENDED
DOMAIN_FEATURE_UNAVAILABLE
ENTITY_EXISTS
ENTITY_DOES_NOT_EXIST
ENTITY_NAME_IS_RESERVED
ENTITY_NAME_NOT_VALID
INVALID_GIVEN_NAME
INVALID_FAMILY_NAME
INVALID_PASSWORD
INVALID_USERNAME
INVALID_HASH_FUNCTION_NAME
INVALID_HASH_DIGEST_LENGTH
INVALID_EMAIL_ADDRESS
INVALID_QUERY_PARAMETER_VALUE
TOO_MANY_RECIPIENTS_ON_EMAIL_LIST
Properties
$_errorCode
$_reason
$_invalidInput
Methods
__construct
setErrorCode
getErrorCode
setReason
getReason
setInvalidInput
getInvalidInput
getDOM
takeAttributeFromDOM
__toString

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.

Constants

UNKNOWN_ERROR
jump to class

 UNKNOWN_ERROR = '1000'

Details

value
1000

USER_DELETED_RECENTLY
jump to class

 USER_DELETED_RECENTLY = '1100'

Details

value
1100

USER_SUSPENDED
jump to class

 USER_SUSPENDED = '1101'

Details

value
1101

DOMAIN_USER_LIMIT_EXCEEDED
jump to class

 DOMAIN_USER_LIMIT_EXCEEDED = '1200'

Details

value
1200

DOMAIN_ALIAS_LIMIT_EXCEEDED
jump to class

 DOMAIN_ALIAS_LIMIT_EXCEEDED = '1201'

Details

value
1201

DOMAIN_SUSPENDED
jump to class

 DOMAIN_SUSPENDED = '1202'

Details

value
1202

DOMAIN_FEATURE_UNAVAILABLE
jump to class

 DOMAIN_FEATURE_UNAVAILABLE = '1203'

Details

value
1203

ENTITY_EXISTS
jump to class

 ENTITY_EXISTS = '1300'

Details

value
1300

ENTITY_DOES_NOT_EXIST
jump to class

 ENTITY_DOES_NOT_EXIST = '1301'

Details

value
1301

ENTITY_NAME_IS_RESERVED
jump to class

 ENTITY_NAME_IS_RESERVED = '1302'

Details

value
1302

ENTITY_NAME_NOT_VALID
jump to class

 ENTITY_NAME_NOT_VALID = '1303'

Details

value
1303

INVALID_GIVEN_NAME
jump to class

 INVALID_GIVEN_NAME = '1400'

Details

value
1400

INVALID_FAMILY_NAME
jump to class

 INVALID_FAMILY_NAME = '1401'

Details

value
1401

INVALID_PASSWORD
jump to class

 INVALID_PASSWORD = '1402'

Details

value
1402

INVALID_USERNAME
jump to class

 INVALID_USERNAME = '1403'

Details

value
1403

INVALID_HASH_FUNCTION_NAME
jump to class

 INVALID_HASH_FUNCTION_NAME = '1404'

Details

value
1404

INVALID_HASH_DIGEST_LENGTH
jump to class

 INVALID_HASH_DIGEST_LENGTH = '1405'

Details

value
1405

INVALID_EMAIL_ADDRESS
jump to class

 INVALID_EMAIL_ADDRESS = '1406'

Details

value
1406

INVALID_QUERY_PARAMETER_VALUE
jump to class

 INVALID_QUERY_PARAMETER_VALUE = '1407'

Details

value
1407

TOO_MANY_RECIPIENTS_ON_EMAIL_LIST
jump to class

 TOO_MANY_RECIPIENTS_ON_EMAIL_LIST = '1500'

Details

value
1500

Properties

$_errorCode
jump to class

 $_errorCode = 'null'

Details

visibility
protected
default
null
final
false
static
false

$_invalidInput
jump to class

 $_invalidInput = 'null'

Details

visibility
protected
default
null
final
false
static
false

$_reason
jump to class

 $_reason = 'null'

Details

visibility
protected
default
null
final
false
static
false

Methods

__construct
jump to class

__construct(  $errorCode = null,  $reason = null,  $invalidInput = null ) :
Arguments
$errorCode
$reason
$invalidInput
Details
visibility
public
final
false
static
false

__toString
jump to class

__toString( ) : string

Get a human readable version of this exception.

Output
string
Details
visibility
public
final
false
static
false

getDOM
jump to class

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

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.

Arguments
$doc
DOMDocument
The DOMDocument used to construct DOMElements
$majorVersion
$minorVersion
Output
DOMElement
The DOMElement representing this element and all child properties.
Details
visibility
public
final
false
static
false

getErrorCode
jump to class

getErrorCode( ) : integer

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.

Output
integer
The error code returned by the Google Apps server.
Details
visibility
public
final
false
static
false
link
Google Apps Provisioning API Reference: Appendix D - Gdata Error Codes
see
setErrorCode

getInvalidInput
jump to class

getInvalidInput( ) : string

Set the invalid input which caused this exception.

Output
string
The reason this exception occurred.
Details
visibility
public
final
false
static
false
see
setInvalidInput

getReason
jump to class

getReason( ) : string

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

Output
string
The reason this exception occurred.
Details
visibility
public
final
false
static
false
see
setReason

setErrorCode
jump to class

setErrorCode( integer $value ) :

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

Arguments
$value
integer
The new value for the error code.
Details
visibility
public
final
false
static
false
see
getErrorCode

setInvalidInput
jump to class

setInvalidInput( string $value ) :

Set the invalid input which caused this exception.

Arguments
$value
string
The invalid input that triggered this exception.
Details
visibility
public
final
false
static
false
see
getInvalidInput

setReason
jump to class

setReason( string $value ) :

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

Arguments
$value
string
The reason this exception occurred.
Details
visibility
public
final
false
static
false
see
getReason

takeAttributeFromDOM
jump to class

takeAttributeFromDOM( DOMNode $attribute ) :

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.

Arguments
$attribute
DOMNode
The DOMNode attribute needed to be handled
Details
visibility
protected
final
false
static
false
Documentation was generated by DocBlox.