Gdata/Gapps/ServiceException.php
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-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Gdata
- Subpackage
- Gapps
- Version
- $Id$
\Zend_Gdata_Gapps_ServiceException
Package: Zend_Gdata\GappsGdata 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-2014 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.
Default valuearray()Details- Type
- array
$_rootElement = "AppsForYourDomainErrors"Default value"AppsForYourDomainErrors"Details- Type
- n/a
Methods
__construct( $errors = null) : arrayCreate a new ServiceException.
Parameters| Name | Type | Description |
|---|
| $errors | | |
|---|
Returns| Type | Description |
|---|
| array | An array containing a collection of
Zend_Gdata_Gapps_Error objects. |
addError(\Zend_Gdata_Gapps_Error $error) : voidAdd a single Error object to the list of errors received by the
server.
Parameters| Name | Type | Description |
|---|
| $error | \Zend_Gdata_Gapps_Error | An instance of an error returned
by the server. The error's errorCode must be set.
|
|---|
Throws getError( $errorCode) : \Zend_Gdata_Gapps_ErrorReturn the Error object associated with a specific error code.
Parameters| Name | Type | Description |
|---|
| $errorCode | | |
|---|
Returns getErrors() : arrayGet the list of errors as sent by the server inside of an
AppsForYourDomainErrors tag.
Returns| 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.
Parameters| Name | Type | Description |
|---|
| $errorCode | integer | The error code to check against. |
|---|
Returns| 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.
Parameters| Name | Type | Description |
|---|
| $string | string | The XML data to be imported |
|---|
ReturnsThrows setErrors(array $array) : voidSet the list of errors as sent by the server inside of an
AppsForYourDomainErrors tag.
Parameters| 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. |
|---|
Throws 
inherited
Classes