Gdata/Gapps/ServiceException.php
- 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: ServiceException.php 20096 2010-01-06 02:05:09Z bkarwin $
- Classes
- Zend_Gdata_Gapps_ServiceException
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_ServiceException
- Extends from
- Zend_Exception
- 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
- Properties
- $_rootElement
- $_errors
- Methods
- __construct
- addError
- setErrors
- getErrors
- getError
- hasError
- importFromString
- __toString
Description
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.
Properties
$_errors
array $_errors = 'array'Array of Zend_Gdata_Error objects indexed by error code.
Details
- $_errors
- array
- visibility
- protected
- default
- array
- final
- false
- static
- false
$_rootElement
$_rootElement = 'AppsForYourDomainErrors'
Details
- visibility
- protected
- default
- AppsForYourDomainErrors
- final
- false
- static
- false
Methods
__construct
__construct(
$errors
=
null
)
:
arrayCreate a new ServiceException.
Arguments
- $errors
Output
- array
- An array containing a collection of Zend_Gdata_Gapps_Error objects.
Details
- visibility
- public
- final
- false
- static
- false
__toString
__toString(
)
:
stringGet a human readable version of this exception.
Output
- string
Details
- visibility
- public
- final
- false
- static
- false
addError
addError(
Zend_Gdata_Gapps_Error $error
)
:
Add a single Error object to the list of errors received by the server.
Arguments
- $error
- Zend_Gdata_Gapps_Error
An instance of an error returned by the server. The error's errorCode must be set.
Details
- visibility
- public
- final
- false
- static
- false
- throws
getError
getError(
$errorCode
)
:
Zend_Gdata_Gapps_ErrorReturn the Error object associated with a specific error code.
Arguments
- $errorCode
Output
- Zend_Gdata_Gapps_Error
- The Error object requested, or null if not found.
Details
- visibility
- public
- final
- false
- static
- false
getErrors
getErrors(
)
:
arrayGet the list of errors as sent by the server inside of an AppsForYourDomainErrors tag.
Output
- array
- An associative array containing a collection of Zend_Gdata_Gapps_Error objects, indexed by error code.
Details
- visibility
- public
- final
- false
- static
- false
hasError
hasError(
integer $errorCode
)
:
booleanCheck whether or not a particular error code was returned by the server.
Arguments
- $errorCode
- integer
The error code to check against.
Output
- boolean
- Whether or not the supplied error code was returned by the server.
Details
- visibility
- public
- final
- false
- static
- false
importFromString
importFromString(
string $string
)
:
Zend_Gdata_Gapps_ServiceExceptionImport an AppsForYourDomain error from XML.
Arguments
- $string
- string
The XML data to be imported
Output
- Zend_Gdata_Gapps_ServiceException
- Provides a fluent interface.
Details
- visibility
- public
- final
- false
- static
- false
- throws
setErrors
setErrors(
array $array
)
:
Set the list of errors as sent by the server inside of an AppsForYourDomainErrors tag.
Arguments
- $array
- array
An associative array containing a collection of Zend_Gdata_Gapps_Error objects. All errors must have their errorCode value set.
Details
- visibility
- public
- final
- false
- static
- false
- throws