Zend/Gdata/Gapps/Error.php

Show:

inherited

Classes
- \Zend_Gdata_Gapps_Error

Table of Contents

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.

Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Gdata
Subpackage: Gapps
Version: $Id: Error.php 24593 2012-01-05 20:35:02Z matthew $

\Zend_Gdata_Gapps_Error
jump to top

Package: Zend\Gdata\Gapps

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.

Parent(s): \Zend_Gdata_App_Base
Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Constants

 
                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

Properties


                 $_errorCode= 'null'

Default valuenullDetails

Type


                 $_invalidInput= 'null'

Default valuenullDetails

Type


                 $_reason= 'null'

Default valuenullDetails

Type

Methods

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

Parameters

Name	Type	Description
$errorCode
$reason
$invalidInput

__toString(
          
          )
        
        :
          string

Get a human readable version of this exception.

Returns

Type	Description
string

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.

Parameters

Name	Type	Description
$doc	\DOMDocument	The DOMDocument used to construct DOMElements
$majorVersion
$minorVersion

Returns

Type	Description
\DOMElement	The DOMElement representing this element and all child properties.

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.

Returns

Type	Description
integer	The error code returned by the Google Apps server.

Details

Link: Google Apps Provisioning API Reference: Appendix D - Gdata Error Codes
See: \setErrorCode

getInvalidInput(
          
          )
        
        :
          string

Set the invalid input which caused this exception.

Returns

Type	Description
string	The reason this exception occurred.

Details

See: \setInvalidInput

getReason(
          
          )
        
        :
          string

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

Returns

Type	Description
string	The reason this exception occurred.

Details

See: \setReason

setErrorCode(
          integer $value
          )
        
        :
          void

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

Parameters

Name	Type	Description
$value	integer	The new value for the error code.

Details

See: \getErrorCode

setInvalidInput(
          string $value
          )
        
        :
          void

Set the invalid input which caused this exception.

Parameters

Name	Type	Description
$value	string	The invalid input that triggered this exception.

Details

See: \getInvalidInput

setReason(
          string $value
          )
        
        :
          void

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

Parameters

Name	Type	Description
$value	string	The reason this exception occurred.

Details

See: \getReason

takeAttributeFromDOM(
          \DOMNode $attribute
          )
        
        :
          void

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

Name	Type	Description
$attribute	\DOMNode	The DOMNode attribute needed to be handled

API Documentation

Zend/Gdata/Gapps/Error.php

\Zend_Gdata_Gapps_Errorjump to top

Constants

Properties

Methods

\Zend_Gdata_Gapps_Error
jump to top