Gdata Gapps Exception class. This is thrown when an AppsForYourDomainErrors message is received from the Google Apps servers.

Several different errors may be represented by this exception. For a list of error codes available, 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_Exception

 Methods

Overloading

__call(string $method, array $args) : mixed
Inherited

For PHP < 5.3.0, provides access to the getPrevious() method.

Parameters

$method

string

$args

array

Returns

mixed

Create a new ServiceException.

__construct($errors = null) : array
inherited_from \Zend_Exception::__construct()

Parameters

$errors

Returns

arrayAn array containing a collection of Zend_Gdata_Gapps_Error objects.

Construct the exception

__construct(string $msg = '', integer $code = 0, \Exception $previous = null) : void
Inherited

Parameters

$msg

string

$code

integer

$previous

\Exception

Get a human readable version of this exception.

__toString() : string
inherited_from \Zend_Exception::__toString()

Returns

string

String representation of the exception

__toString() : string
Inherited

Returns

string

Add a single Error object to the list of errors received by the server.

addError(\Zend_Gdata_Gapps_Error $error) 

Parameters

$error

\Zend_Gdata_Gapps_Error

An instance of an error returned by the server. The error's errorCode must be set.

Exceptions

\Zend_Gdata_App_Exception

Return the Error object associated with a specific error code.

getError($errorCode) : \Zend_Gdata_Gapps_Error

Parameters

$errorCode

Returns

\Zend_Gdata_Gapps_ErrorThe Error object requested, or null if not found.

Get the list of errors as sent by the server inside of an AppsForYourDomainErrors tag.

getErrors() : array

Returns

arrayAn associative array containing a collection of Zend_Gdata_Gapps_Error objects, indexed by error code.

Check whether or not a particular error code was returned by the server.

hasError(integer $errorCode) : boolean

Parameters

$errorCode

integer

The error code to check against.

Returns

booleanWhether or not the supplied error code was returned by the server.

Import an AppsForYourDomain error from XML.

importFromString(string $string) : \Zend_Gdata_Gapps_ServiceException

Parameters

$string

string

The XML data to be imported

Exceptions

\Zend_Gdata_App_Exception

Returns

\Zend_Gdata_Gapps_ServiceExceptionProvides a fluent interface.

Set the list of errors as sent by the server inside of an AppsForYourDomainErrors tag.

setErrors(array $array) 

Parameters

$array

array

An associative array containing a collection of Zend_Gdata_Gapps_Error objects. All errors must have their errorCode value set.

Exceptions

\Zend_Gdata_App_Exception

Returns previous Exception

_getPrevious() : \Exception | null
Inherited

Returns

\Exceptionnull

 Properties

 

Array of Zend_Gdata_Error objects indexed by error code.

$_errors : array

Default

array()
 

$_rootElement

$_rootElement 

Default

"AppsForYourDomainErrors"
 

$_previous

$_previous : null | \Exception

Default

null