blob: 2c51ce8b90c555e39d87999187b101fd3d226615 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Zend Gdata API Documentation</title><meta http-equiv="Content-Type" content="text/html; charset=utf-8"></meta><link rel="stylesheet" href="../css/template.css" type="text/css"></link><script type="text/javascript" src="../js/jquery-1.4.2.min.js"></script><script type="text/javascript" src="../js/jquery.tools.min.js"></script><script type="text/javascript" src="../js/jquery-ui-1.8.2.custom.min.js"></script><script type="text/javascript" src="../js/template.js"></script></head><body><div id="content"><h1 class="file">Gdata/Gapps/ServiceException.php</h1><div id="file-nav-box"><div id="file-nav-options">
Show:
<img src="../images/icons/visibility_public.png" alt="Public" id="show-public"></img><img src="../images/icons/visibility_protected.png" alt="Protected" id="show-protected"></img><img src="../images/icons/visibility_private.png" alt="Private" id="show-private"></img><span class="attribute" id="show-inherited">inherited</span></div><div id="file-nav-container"><ul id="file-nav"><li><a href="#classes"><img src="../images/icons/class.png" alt="Class" height="14"></img>
Classes
</a><ul><li><a href="#\Zend_Gdata_Gapps_ServiceException">\Zend_Gdata_Gapps_ServiceException</a></li></ul></li></ul><div style="clear: left;"></div></div><div id="file-nav-tab">
Table of Contents
</div></div><a name="top" class="anchor"></a><div id="file-description"><div class="short-description">Zend Framework</div><div class="long-description"><p>LICENSE</p>
<p>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.</p></div></div><dl class="file-info"><dt>Category</dt><dd>Zend
</dd><dt>Copyright</dt><dd>Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
</dd><dt>License</dt><dd><a href="http://framework.zend.com/license/new-bsd">New BSD License</a>
</dd><dt>Package</dt><dd>Zend_Gdata
</dd><dt>Subpackage</dt><dd>Gapps
</dd><dt>Version</dt><dd>$Id: ServiceException.php 24593 2012-01-05 20:35:02Z matthew $
</dd></dl><a name="classes" class="anchor"></a><a id="\Zend_Gdata_Gapps_ServiceException" class="anchor"></a><h2 class="class">\Zend_Gdata_Gapps_ServiceException<div class="to-top"><a href="#top">jump to top</a></div></h2><div class="class"><small class="package"><b>Package: </b>Zend\Gdata\Gapps</small><div class="short-description">Gdata Gapps Exception class.</div><div class="long-description"><p>This is thrown when an
AppsForYourDomainErrors message is received from the Google Apps
servers.</p>
<p>Several different errors may be represented by this exception. For a list
of error codes available, see getErrorCode.</p></div><dl class="class-info"><dt>Parent(s)</dt><dd><a href="../files/Exception.html#\Zend_Exception">\Zend_Exception</a>
<
<a href="../files/http://php.net/manual/en/class.exception.php">\Exception</a></dd><dt>Category</dt><dd>Zend
</dd><dt>Copyright</dt><dd>Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
</dd><dt>License</dt><dd><a href="http://framework.zend.com/license/new-bsd">New BSD License</a>
</dd></dl><h3>Properties</h3><div><a id="\Zend_Gdata_Gapps_ServiceException::$_errors" class="anchor"></a><div class="property protected"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt=">"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/property.png" alt="Property"></img><img src="../images/icons/visibility_protected.png" style="margin-right: 5px" alt="protected"></img>array <span class="highlight">$_errors</span> = array()</code><div class="description"><div class="short-description">Array of Zend_Gdata_Error objects indexed by error code.</div></div><div class="code-tabs"><div class="long-description"></div><strong>Default value</strong><code>array()</code><strong>Details</strong><dl class="property-info"><dt>Type</dt><dd>array</dd></dl></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps_ServiceException::$_previous" class="anchor"></a><div class="property private inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt=">"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/property.png" alt="Property"></img><img src="../images/icons/visibility_private.png" style="margin-right: 5px" alt="private"></img>null|\Exception <span class="highlight">$_previous</span> = null</code><div class="description"><span class="attribute">inherited</span><div class="short-description"></div><small class="inherited_from">Inherited from:
<a href="../files/Exception.html#\Zend_Exception::$$_previous">\Zend_Exception::$$_previous</a></small></div><div class="code-tabs"><div class="long-description"></div><strong>Default value</strong><code>null</code><strong>Details</strong><dl class="property-info"><dt>Type</dt><dd>null | <a href="../files/http://php.net/manual/en/class.exception.php">\Exception</a></dd><dt>Inherited_from</dt><dd><a href="../files/
Exception.html#\Zend_Exception::$$_previous">\Zend_Exception::$$_previous</a>
</dd></dl></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps_ServiceException::$_rootElement" class="anchor"></a><div class="property protected"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png" alt=">"></img><img src="../images/icons/arrow_down.png" alt="V" style="display: none;"></img></a><code class="title"><img src="../images/icons/property.png" alt="Property"></img><img src="../images/icons/visibility_protected.png" style="margin-right: 5px" alt="protected"></img><span class="highlight">$_rootElement</span> = "AppsForYourDomainErrors"</code><div class="description"></div><div class="code-tabs"><strong>Default value</strong><code>"AppsForYourDomainErrors"</code><strong>Details</strong><dl class="property-info"><dt>Type</dt><dd>n/a</dd></dl></div><div class="clear"></div></div></div><h3>Methods</h3><div><a id="\Zend_Gdata_Gapps_ServiceException::__call()" class="anchor"></a><div class="method public inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">__call</span><span class="nb-faded-text">(string $method, array $args)</span> : mixed</code><div class="description"><span class="attribute">inherited</span><p class="short_description">Overloading</p><small class="inherited_from">Inherited from:
<a href="../files/Exception.html#\Zend_Exception::__call()">\Zend_Exception::__call()</a></small></div><div class="code-tabs"><div class="long-description"><p>For PHP < 5.3.0, provides access to the getPrevious() method.</p></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$method</th><td>string</td><td><em></em></td></tr><tr><th>$args</th><td>array</td><td><em></em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>mixed</td><td></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps_ServiceException::__construct()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">__construct</span><span class="nb-faded-text">( $errors = null)</span> : array</code><div class="description"><p class="short_description">Create a new ServiceException.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$errors</th><td></td><td><em></em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>array</td><td>An array containing a collection of
Zend_Gdata_Gapps_Error objects.</td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps_ServiceException::__toString()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">__toString</span><span class="nb-faded-text">()</span> : string</code><div class="description"><p class="short_description">Get a human readable version of this exception.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>string</td><td></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps_ServiceException::_getPrevious()" class="anchor"></a><div class="method protected inherited_from "><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_protected.png" style="margin-right: 5px" alt="protected"></img><span class="highlight">_getPrevious</span><span class="nb-faded-text">()</span> : <a href="../files/http://php.net/manual/en/class.exception.php">\Exception</a> | null</code><div class="description"><span class="attribute">inherited</span><p class="short_description">Returns previous Exception</p><small class="inherited_from">Inherited from:
<a href="../files/Exception.html#\Zend_Exception::_getPrevious()">\Zend_Exception::_getPrevious()</a></small></div><div class="code-tabs"><div class="long-description"></div><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td><a href="../files/http://php.net/manual/en/class.exception.php">\Exception</a> | null</td><td></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps_ServiceException::addError()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">addError</span><span class="nb-faded-text">(<a href="../files/Gdata.Gapps.Error.html#\Zend_Gdata_Gapps_Error">\Zend_Gdata_Gapps_Error</a> $error)</span> : void</code><div class="description"><p class="short_description">Add a single Error object to the list of errors received by the
server.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$error</th><td><a href="../files/Gdata.Gapps.Error.html#\Zend_Gdata_Gapps_Error">\Zend_Gdata_Gapps_Error</a></td><td><em><p>An instance of an error returned
by the server. The error's errorCode must be set.</p>
</em></td></tr></table><strong>Throws</strong><table class="argument-info"><thead><tr><th>Exception</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.App.Exception.html#\Zend_Gdata_App_Exception">\Zend_Gdata_App_Exception</a></td><td><em></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps_ServiceException::getError()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">getError</span><span class="nb-faded-text">( $errorCode)</span> : <a href="../files/Gdata.Gapps.Error.html#\Zend_Gdata_Gapps_Error">\Zend_Gdata_Gapps_Error</a></code><div class="description"><p class="short_description">Return the Error object associated with a specific error code.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$errorCode</th><td></td><td><em></em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.Gapps.Error.html#\Zend_Gdata_Gapps_Error">\Zend_Gdata_Gapps_Error</a></td><td>The Error object requested, or null
if not found.</td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps_ServiceException::getErrors()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">getErrors</span><span class="nb-faded-text">()</span> : array</code><div class="description"><p class="short_description">Get the list of errors as sent by the server inside of an
AppsForYourDomainErrors tag.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>array</td><td>An associative array containing a collection of
Zend_Gdata_Gapps_Error objects, indexed by error code.</td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps_ServiceException::hasError()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">hasError</span><span class="nb-faded-text">(integer $errorCode)</span> : boolean</code><div class="description"><p class="short_description">Check whether or not a particular error code was returned by the
server.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$errorCode</th><td>integer</td><td><em><p>The error code to check against.</p></em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>boolean</td><td>Whether or not the supplied error code was returned
by the server.</td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps_ServiceException::importFromString()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">importFromString</span><span class="nb-faded-text">(string $string)</span> : <a href="../files/Gdata.Gapps.ServiceException.html#\Zend_Gdata_Gapps_ServiceException">\Zend_Gdata_Gapps_ServiceException</a></code><div class="description"><p class="short_description">Import an AppsForYourDomain error from XML.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$string</th><td>string</td><td><em><p>The XML data to be imported</p></em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.Gapps.ServiceException.html#\Zend_Gdata_Gapps_ServiceException">\Zend_Gdata_Gapps_ServiceException</a></td><td>Provides a fluent interface.</td></tr></table><strong>Throws</strong><table class="argument-info"><thead><tr><th>Exception</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.App.Exception.html#\Zend_Gdata_App_Exception">\Zend_Gdata_App_Exception</a></td><td><em></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Gapps_ServiceException::setErrors()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">setErrors</span><span class="nb-faded-text">(array $array)</span> : void</code><div class="description"><p class="short_description">Set the list of errors as sent by the server inside of an
AppsForYourDomainErrors tag.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$array</th><td>array</td><td><em><p>An associative array containing a collection of
Zend_Gdata_Gapps_Error objects. All errors must have their
errorCode value set.</p></em></td></tr></table><strong>Throws</strong><table class="argument-info"><thead><tr><th>Exception</th><th>Description</th></tr></thead><tr><td><a href="../files/Gdata.App.Exception.html#\Zend_Gdata_App_Exception">\Zend_Gdata_App_Exception</a></td><td><em></em></td></tr></table></div><div class="clear"></div></div></div></div></div><small class="footer">
Documentation was generated by
<a href="http://phpdoc.org">phpDocumentor
2.0.0a12</a>.
</small></body></html>
|
