From 06f945f27840b53e57795dadbc38e76f7e11ab1c Mon Sep 17 00:00:00 2001 From: Horus3 Date: Mon, 24 Feb 2014 16:42:14 +0100 Subject: init --- .../core/files/Gdata.Gapps.ServiceException.html | 63 ++++++++++++++++++++++ 1 file changed, 63 insertions(+) create mode 100644 zend/documentation/api/core/files/Gdata.Gapps.ServiceException.html (limited to 'zend/documentation/api/core/files/Gdata.Gapps.ServiceException.html') diff --git a/zend/documentation/api/core/files/Gdata.Gapps.ServiceException.html b/zend/documentation/api/core/files/Gdata.Gapps.ServiceException.html new file mode 100644 index 0000000..2c51ce8 --- /dev/null +++ b/zend/documentation/api/core/files/Gdata.Gapps.ServiceException.html @@ -0,0 +1,63 @@ + +Zend Gdata API Documentation

Gdata/Gapps/ServiceException.php

+ Show: + PublicProtectedPrivateinherited
+ 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: ServiceException.php 24593 2012-01-05 20:35:02Z matthew $ +   +

\Zend_Gdata_Gapps_ServiceException
jump to top

Package: Zend\Gdata\Gapps
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

>VPropertyprotectedarray $_errors = array()
Array of Zend_Gdata_Error objects indexed by error code.
Default valuearray()Details
Type
array
>VPropertyprivatenull|\Exception $_previous = null
inherited
Inherited from: + \Zend_Exception::$$_previous
Default valuenullDetails
Type
null | \Exception
Inherited_from
\Zend_Exception::$$_previous +   +
>VPropertyprotected$_rootElement = "AppsForYourDomainErrors"
Default value"AppsForYourDomainErrors"Details
Type
n/a

Methods

methodpublic__call(string $method, array $args) : mixed
inherited

Overloading

Inherited from: + \Zend_Exception::__call()

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

Parameters
NameTypeDescription
$methodstring
$argsarray
Returns
TypeDescription
mixed
methodpublic__construct( $errors = null) : array

Create a new ServiceException.

Parameters
NameTypeDescription
$errors
Returns
TypeDescription
arrayAn array containing a collection of + Zend_Gdata_Gapps_Error objects.
methodpublic__toString() : string

Get a human readable version of this exception.

Returns
TypeDescription
string
methodprotected_getPrevious() : \Exception | null
inherited

Returns previous Exception

Inherited from: + \Zend_Exception::_getPrevious()
Returns
TypeDescription
\Exception | null
methodpublicaddError(\Zend_Gdata_Gapps_Error $error) : void

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

Parameters
NameTypeDescription
$error\Zend_Gdata_Gapps_Error

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

+
Throws
ExceptionDescription
\Zend_Gdata_App_Exception
methodpublicgetError( $errorCode) : \Zend_Gdata_Gapps_Error

Return the Error object associated with a specific error code.

Parameters
NameTypeDescription
$errorCode
Returns
TypeDescription
\Zend_Gdata_Gapps_ErrorThe Error object requested, or null + if not found.
methodpublicgetErrors() : array

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

Returns
TypeDescription
arrayAn associative array containing a collection of + Zend_Gdata_Gapps_Error objects, indexed by error code.
methodpublichasError(integer $errorCode) : boolean

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

Parameters
NameTypeDescription
$errorCodeinteger

The error code to check against.

Returns
TypeDescription
booleanWhether or not the supplied error code was returned + by the server.
methodpublicimportFromString(string $string) : \Zend_Gdata_Gapps_ServiceException

Import an AppsForYourDomain error from XML.

Parameters
NameTypeDescription
$stringstring

The XML data to be imported

Returns
TypeDescription
\Zend_Gdata_Gapps_ServiceExceptionProvides a fluent interface.
Throws
ExceptionDescription
\Zend_Gdata_App_Exception
methodpublicsetErrors(array $array) : void

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

Parameters
NameTypeDescription
$arrayarray

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

Throws
ExceptionDescription
\Zend_Gdata_App_Exception
+ Documentation was generated by + phpDocumentor + 2.0.0a12. + -- cgit v1.2.3