Zend/Gdata/Gapps/ServiceException.php
Show:
inherited
inherited
Classes
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: ServiceException.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_Gdata_Gapps_ServiceException
Package: Zend\Gdata\Gapps
Default value
Parameters
Returns
Returns
Parameters
Throws
Parameters
Returns
Returns
Parameters
Returns
Parameters
Returns
Throws
Parameters
Throws
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.
- Parent(s)
- \Zend_Exception < \Exception
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
array
$_errors= 'array()'
Array of Zend_Gdata_Error objects indexed by error code.
array()Details- Type
- array
$_rootElement= '"AppsForYourDomainErrors"'
Default value
"AppsForYourDomainErrors"Details- Type
Methods
__construct(
$errors
=
null
)
:
arrayCreate a new ServiceException.
| Name | Type | Description |
|---|---|---|
| $errors |
| Type | Description |
|---|---|
| array | An array containing a collection of Zend_Gdata_Gapps_Error objects. |
__toString(
)
:
stringGet a human readable version of this exception.
| Type | Description |
|---|---|
| string |
addError(
\Zend_Gdata_Gapps_Error $error
)
:
voidAdd a single Error object to the list of errors received by the server.
| Name | Type | Description |
|---|---|---|
| $error | \Zend_Gdata_Gapps_Error | An instance of an error returned by the server. The error's errorCode must be set. |
| Exception | Description |
|---|---|
| \Zend_Gdata_App_Exception |
getError(
$errorCode
)
:
\Zend_Gdata_Gapps_ErrorReturn the Error object associated with a specific error code.
| Name | Type | Description |
|---|---|---|
| $errorCode |
| Type | Description |
|---|---|
| \Zend_Gdata_Gapps_Error | The Error object requested, or null if not found. |
getErrors(
)
:
arrayGet the list of errors as sent by the server inside of an AppsForYourDomainErrors tag.
| Type | Description |
|---|---|
| array | An associative array containing a collection of Zend_Gdata_Gapps_Error objects, indexed by error code. |
hasError(
integer $errorCode
)
:
booleanCheck whether or not a particular error code was returned by the server.
| Name | Type | Description |
|---|---|---|
| $errorCode | integer | The error code to check against. |
| Type | Description |
|---|---|
| boolean | Whether or not the supplied error code was returned by the server. |
importFromString(
string $string
)
:
\Zend_Gdata_Gapps_ServiceExceptionImport an AppsForYourDomain error from XML.
| Name | Type | Description |
|---|---|---|
| $string | string | The XML data to be imported |
| Type | Description |
|---|---|
| \Zend_Gdata_Gapps_ServiceException | Provides a fluent interface. |
| Exception | Description |
|---|---|
| \Zend_Gdata_App_Exception |
setErrors(
array $array
)
:
voidSet the list of errors as sent by the server inside of an AppsForYourDomainErrors tag.
| Name | Type | Description |
|---|---|---|
| $array | array | An associative array containing a collection of Zend_Gdata_Gapps_Error objects. All errors must have their errorCode value set. |
| Exception | Description |
|---|---|
| \Zend_Gdata_App_Exception |