diff options
| author | Horus3 | 2014-02-24 16:42:14 +0100 |
|---|---|---|
| committer | Horus3 | 2014-02-24 16:42:14 +0100 |
| commit | 06f945f27840b53e57795dadbc38e76f7e11ab1c (patch) | |
| tree | 689d5c7f4ffa15460c7e90f47c6a7dd59ce4e8bd /zend/documentation/api/core/files/Gdata.Docs.html | |
| download | random-06f945f27840b53e57795dadbc38e76f7e11ab1c.tar.gz | |
init
Diffstat (limited to 'zend/documentation/api/core/files/Gdata.Docs.html')
| -rw-r--r-- | zend/documentation/api/core/files/Gdata.Docs.html | 348 |
1 files changed, 348 insertions, 0 deletions
diff --git a/zend/documentation/api/core/files/Gdata.Docs.html b/zend/documentation/api/core/files/Gdata.Docs.html new file mode 100644 index 0000000..b5d8ff0 --- /dev/null +++ b/zend/documentation/api/core/files/Gdata.Docs.html @@ -0,0 +1,348 @@ +<!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/Docs.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_Docs">\Zend_Gdata_Docs</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>Docs + + </dd><dt>Version</dt><dd>$Id: Docs.php 24593 2012-01-05 20:35:02Z matthew $ + + </dd></dl><a name="classes" class="anchor"></a><a id="\Zend_Gdata_Docs" class="anchor"></a><h2 class="class">\Zend_Gdata_Docs<div class="to-top"><a href="#top">jump to top</a></div></h2><div class="class"><small class="package"><b>Package: </b>Zend\Gdata\Docs</small><div class="short-description">Service class for interacting with the Google Document List data API</div><div class="long-description"><p>As the Google data API protocol is based upon the Atom Publishing Protocol +(APP), Gdata functionality extends the appropriate Zend_Gdata_App classes</p></div><dl class="class-info"><dt>Parent(s)</dt><dd><a href="../files/Gdata.html#\Zend_Gdata">\Zend_Gdata</a> + < + <a href="../files/Gdata.App.html#\Zend_Gdata_App" style="color: gray; font-size: 0.8em + ">\Zend_Gdata_App</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><dt>Link</dt><dd><a href="http://code.google.com/apis/documents/">http://code.google.com/apis/documents/</a> + + </dd></dl><h3>Constants</h3><div><a id="\Zend_Gdata_Docs::DOCUMENTS_LIST_FEED_URI" class="anchor"></a><div class="constant publicC"><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/constant.png" alt="Constant"></img> + <span class="highlight">DOCUMENTS_LIST_FEED_URI</span> + = 'https://docs.google.com/feeds/documents/private/full'</code><div class="description"></div><div class="code-tabs"></div><div class="clear"></div></div><a id="\Zend_Gdata_Docs::DOCUMENTS_FOLDER_FEED_URI" class="anchor"></a><div class="constant publicC"><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/constant.png" alt="Constant"></img> + <span class="highlight">DOCUMENTS_FOLDER_FEED_URI</span> + = 'https://docs.google.com/feeds/folders/private/full'</code><div class="description"></div><div class="code-tabs"></div><div class="clear"></div></div><a id="\Zend_Gdata_Docs::DOCUMENTS_CATEGORY_SCHEMA" class="anchor"></a><div class="constant publicC"><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/constant.png" alt="Constant"></img> + <span class="highlight">DOCUMENTS_CATEGORY_SCHEMA</span> + = 'http://schemas.google.com/g/2005#kind'</code><div class="description"></div><div class="code-tabs"></div><div class="clear"></div></div><a id="\Zend_Gdata_Docs::DOCUMENTS_CATEGORY_TERM" class="anchor"></a><div class="constant publicC"><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/constant.png" alt="Constant"></img> + <span class="highlight">DOCUMENTS_CATEGORY_TERM</span> + = 'http://schemas.google.com/docs/2007#folder'</code><div class="description"></div><div class="code-tabs"></div><div class="clear"></div></div><a id="\Zend_Gdata_Docs::AUTH_SERVICE_NAME" class="anchor"></a><div class="constant publicC"><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/constant.png" alt="Constant"></img>string + <span class="highlight">AUTH_SERVICE_NAME</span> + = 'writely'</code><div class="description"><div class="short-description">Service name for use with Google's authentication mechanisms</div></div><div class="code-tabs"><div class="long-description"></div><dl class="constant-info"><dt></dt><dd>string<br></br><em></em></dd></dl></div><div class="clear"></div></div><a id="\Zend_Gdata_Docs::DEFAULT_MAJOR_PROTOCOL_VERSION" class="anchor"></a><div class="constant publicC 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/constant.png" alt="Constant"></img> + <span class="highlight">DEFAULT_MAJOR_PROTOCOL_VERSION</span> + = 1</code><div class="description"><span class="attribute">inherited</span><div class="short-description">Default major protocol version.</div><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::DEFAULT_MAJOR_PROTOCOL_VERSION">\Zend_Gdata_App::DEFAULT_MAJOR_PROTOCOL_VERSION</a><a href="../files/Gdata.html#\Zend_Gdata::DEFAULT_MAJOR_PROTOCOL_VERSION">\Zend_Gdata::DEFAULT_MAJOR_PROTOCOL_VERSION</a></small></div><div class="code-tabs"><div class="long-description"></div><dl class="constant-info"><dt>Inherited_from</dt><dd><a href="../files/ + Gdata.App.html#\Zend_Gdata_App::DEFAULT_MAJOR_PROTOCOL_VERSION">\Zend_Gdata_App::DEFAULT_MAJOR_PROTOCOL_VERSION</a> + + </dd><dt>Inherited_from</dt><dd><a href="../files/ + Gdata.html#\Zend_Gdata::DEFAULT_MAJOR_PROTOCOL_VERSION">\Zend_Gdata::DEFAULT_MAJOR_PROTOCOL_VERSION</a> + + </dd><dt>See</dt><dd>\_majorProtocolVersion + + </dd></dl></div><div class="clear"></div></div><a id="\Zend_Gdata_Docs::DEFAULT_MINOR_PROTOCOL_VERSION" class="anchor"></a><div class="constant publicC 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/constant.png" alt="Constant"></img> + <span class="highlight">DEFAULT_MINOR_PROTOCOL_VERSION</span> + = null</code><div class="description"><span class="attribute">inherited</span><div class="short-description">Default minor protocol version.</div><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::DEFAULT_MINOR_PROTOCOL_VERSION">\Zend_Gdata_App::DEFAULT_MINOR_PROTOCOL_VERSION</a><a href="../files/Gdata.html#\Zend_Gdata::DEFAULT_MINOR_PROTOCOL_VERSION">\Zend_Gdata::DEFAULT_MINOR_PROTOCOL_VERSION</a></small></div><div class="code-tabs"><div class="long-description"></div><dl class="constant-info"><dt>Inherited_from</dt><dd><a href="../files/ + Gdata.App.html#\Zend_Gdata_App::DEFAULT_MINOR_PROTOCOL_VERSION">\Zend_Gdata_App::DEFAULT_MINOR_PROTOCOL_VERSION</a> + + </dd><dt>Inherited_from</dt><dd><a href="../files/ + Gdata.html#\Zend_Gdata::DEFAULT_MINOR_PROTOCOL_VERSION">\Zend_Gdata::DEFAULT_MINOR_PROTOCOL_VERSION</a> + + </dd><dt>See</dt><dd>\_minorProtocolVersion + + </dd></dl></div><div class="clear"></div></div></div><h3>Properties</h3><div><a id="\Zend_Gdata_Docs::$SUPPORTED_FILETYPES" class="anchor"></a><div class="property private"><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><span class="highlight">$SUPPORTED_FILETYPES</span> = array('TXT' => 'text/plain', 'CSV' => 'text/csv', 'TSV' => 'text/tab-separated-values', 'TAB' => 'text/tab-separated-values', 'HTML' => 'text/html', 'HTM' => 'text/html', 'DOC' => 'application/msword', 'ODS' => 'application/vnd.oasis.opendocument.spreadsheet', 'ODT' => 'application/vnd.oasis.opendocument.text', 'RTF' => 'application/rtf', 'SXW' => 'application/vnd.sun.xml.writer', 'XLS' => 'application/vnd.ms-excel', 'XLSX' => 'application/vnd.ms-excel', 'PPT' => 'application/vnd.ms-powerpoint', 'PPS' => 'application/vnd.ms-powerpoint')</code><div class="description"><span class="attribute">static</span></div><div class="code-tabs"><strong>Default value</strong><code>array('TXT' => 'text/plain', 'CSV' => 'text/csv', 'TSV' => 'text/tab-separated-values', 'TAB' => 'text/tab-separated-values', 'HTML' => 'text/html', 'HTM' => 'text/html', 'DOC' => 'application/msword', 'ODS' => 'application/vnd.oasis.opendocument.spreadsheet', 'ODT' => 'application/vnd.oasis.opendocument.text', 'RTF' => 'application/rtf', 'SXW' => 'application/vnd.sun.xml.writer', 'XLS' => 'application/vnd.ms-excel', 'XLSX' => 'application/vnd.ms-excel', 'PPT' => 'application/vnd.ms-powerpoint', 'PPS' => 'application/vnd.ms-powerpoint')</code><strong>Details</strong><dl class="property-info"><dt>Type</dt><dd>n/a</dd></dl></div><div class="clear"></div></div><a id="\Zend_Gdata_Docs::$_defaultPostUri" 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>string <span class="highlight">$_defaultPostUri</span> = self::DOCUMENTS_LIST_FEED_URI</code><div class="description"><div class="short-description">Default URI to which to POST.</div></div><div class="code-tabs"><div class="long-description"></div><strong>Default value</strong><code>self::DOCUMENTS_LIST_FEED_URI</code><strong>Details</strong><dl class="property-info"><dt>Type</dt><dd>string</dd></dl></div><div class="clear"></div></div><a id="\Zend_Gdata_Docs::$_gzipEnabled" class="anchor"></a><div class="property protected 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_protected.png" style="margin-right: 5px" alt="protected"></img>boolean <span class="highlight">$_gzipEnabled</span> = false</code><div class="description"><span class="attribute">static</span><span class="attribute">inherited</span><div class="short-description">Enable gzipped responses?</div><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::$$_gzipEnabled">\Zend_Gdata_App::$$_gzipEnabled</a><a href="../files/Gdata.html#\Zend_Gdata::$$_gzipEnabled">\Zend_Gdata::$$_gzipEnabled</a></small></div><div class="code-tabs"><div class="long-description"></div><strong>Default value</strong><code>false</code><strong>Details</strong><dl class="property-info"><dt>Type</dt><dd>boolean</dd><dt>Inherited_from</dt><dd><a href="../files/ + Gdata.App.html#\Zend_Gdata_App::$$_gzipEnabled">\Zend_Gdata_App::$$_gzipEnabled</a> + + </dd><dt>Inherited_from</dt><dd><a href="../files/ + Gdata.html#\Zend_Gdata::$$_gzipEnabled">\Zend_Gdata::$$_gzipEnabled</a> + + </dd></dl></div><div class="clear"></div></div><a id="\Zend_Gdata_Docs::$_httpClient" class="anchor"></a><div class="property protected 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_protected.png" style="margin-right: 5px" alt="protected"></img>\Zend_Gdata_HttpClient <span class="highlight">$_httpClient</span></code><div class="description"><span class="attribute">inherited</span><div class="short-description">Client object used to communicate</div><small class="inherited_from">Inherited from: + <a href="../files/Gdata.html#\Zend_Gdata::$$_httpClient">\Zend_Gdata::$$_httpClient</a></small></div><div class="code-tabs"><div class="long-description"></div><strong>Details</strong><dl class="property-info"><dt>Type</dt><dd><a href="../files/Gdata.HttpClient.html#\Zend_Gdata_HttpClient">\Zend_Gdata_HttpClient</a></dd><dt>Inherited_from</dt><dd><a href="../files/ + Gdata.html#\Zend_Gdata::$$_httpClient">\Zend_Gdata::$$_httpClient</a> + + </dd></dl></div><div class="clear"></div></div><a id="\Zend_Gdata_Docs::$_httpMethodOverride" class="anchor"></a><div class="property protected 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_protected.png" style="margin-right: 5px" alt="protected"></img>boolean <span class="highlight">$_httpMethodOverride</span> = false</code><div class="description"><span class="attribute">static</span><span class="attribute">inherited</span><div class="short-description">Override HTTP PUT and DELETE request methods?</div><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::$$_httpMethodOverride">\Zend_Gdata_App::$$_httpMethodOverride</a><a href="../files/Gdata.html#\Zend_Gdata::$$_httpMethodOverride">\Zend_Gdata::$$_httpMethodOverride</a></small></div><div class="code-tabs"><div class="long-description"></div><strong>Default value</strong><code>false</code><strong>Details</strong><dl class="property-info"><dt>Type</dt><dd>boolean</dd><dt>Inherited_from</dt><dd><a href="../files/ + Gdata.App.html#\Zend_Gdata_App::$$_httpMethodOverride">\Zend_Gdata_App::$$_httpMethodOverride</a> + + </dd><dt>Inherited_from</dt><dd><a href="../files/ + Gdata.html#\Zend_Gdata::$$_httpMethodOverride">\Zend_Gdata::$$_httpMethodOverride</a> + + </dd></dl></div><div class="clear"></div></div><a id="\Zend_Gdata_Docs::$_majorProtocolVersion" class="anchor"></a><div class="property protected 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_protected.png" style="margin-right: 5px" alt="protected"></img><span class="highlight">$_majorProtocolVersion</span></code><div class="description"><span class="attribute">inherited</span><div class="short-description">Indicates the major protocol version that should be used.</div><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::$$_majorProtocolVersion">\Zend_Gdata_App::$$_majorProtocolVersion</a><a href="../files/Gdata.html#\Zend_Gdata::$$_majorProtocolVersion">\Zend_Gdata::$$_majorProtocolVersion</a></small></div><div class="code-tabs"><div class="long-description"><p>At present, recognized values are either 1 or 2. However, any integer +value >= 1 is considered valid.</p> + +<p>Under most circumtances, this will be automatically set by +Zend_Gdata_App subclasses.</p></div><strong>Details</strong><dl class="property-info"><dt>Type</dt><dd>n/a</dd><dt>Inherited_from</dt><dd><a href="../files/ + Gdata.App.html#\Zend_Gdata_App::$$_majorProtocolVersion">\Zend_Gdata_App::$$_majorProtocolVersion</a> + + </dd><dt>Inherited_from</dt><dd><a href="../files/ + Gdata.html#\Zend_Gdata::$$_majorProtocolVersion">\Zend_Gdata::$$_majorProtocolVersion</a> + + </dd><dt>See</dt><dd>\setMajorProtocolVersion() + + </dd><dt>See</dt><dd>\getMajorProtocolVersion() + + </dd></dl></div><div class="clear"></div></div><a id="\Zend_Gdata_Docs::$_maxRedirects" class="anchor"></a><div class="property protected 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_protected.png" style="margin-right: 5px" alt="protected"></img>int <span class="highlight">$_maxRedirects</span> = 5</code><div class="description"><span class="attribute">static</span><span class="attribute">inherited</span><div class="short-description">Maximum number of redirects to follow during HTTP operations</div><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::$$_maxRedirects">\Zend_Gdata_App::$$_maxRedirects</a><a href="../files/Gdata.html#\Zend_Gdata::$$_maxRedirects">\Zend_Gdata::$$_maxRedirects</a></small></div><div class="code-tabs"><div class="long-description"></div><strong>Default value</strong><code>5</code><strong>Details</strong><dl class="property-info"><dt>Type</dt><dd>int</dd><dt>Inherited_from</dt><dd><a href="../files/ + Gdata.App.html#\Zend_Gdata_App::$$_maxRedirects">\Zend_Gdata_App::$$_maxRedirects</a> + + </dd><dt>Inherited_from</dt><dd><a href="../files/ + Gdata.html#\Zend_Gdata::$$_maxRedirects">\Zend_Gdata::$$_maxRedirects</a> + + </dd></dl></div><div class="clear"></div></div><a id="\Zend_Gdata_Docs::$_minorProtocolVersion" class="anchor"></a><div class="property protected 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_protected.png" style="margin-right: 5px" alt="protected"></img><span class="highlight">$_minorProtocolVersion</span></code><div class="description"><span class="attribute">inherited</span><div class="short-description">Indicates the minor protocol version that should be used.</div><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::$$_minorProtocolVersion">\Zend_Gdata_App::$$_minorProtocolVersion</a><a href="../files/Gdata.html#\Zend_Gdata::$$_minorProtocolVersion">\Zend_Gdata::$$_minorProtocolVersion</a></small></div><div class="code-tabs"><div class="long-description"><p>Can be set +to either an integer >= 0, or NULL if no minor version should be sent +to the server.</p> + +<p>At present, this field is not used by any Google services, but may be +used in the future.</p> + +<p>Under most circumtances, this will be automatically set by +Zend_Gdata_App subclasses.</p></div><strong>Details</strong><dl class="property-info"><dt>Type</dt><dd>n/a</dd><dt>Inherited_from</dt><dd><a href="../files/ + Gdata.App.html#\Zend_Gdata_App::$$_minorProtocolVersion">\Zend_Gdata_App::$$_minorProtocolVersion</a> + + </dd><dt>Inherited_from</dt><dd><a href="../files/ + Gdata.html#\Zend_Gdata::$$_minorProtocolVersion">\Zend_Gdata::$$_minorProtocolVersion</a> + + </dd><dt>See</dt><dd>\setMinorProtocolVersion() + + </dd><dt>See</dt><dd>\getMinorProtocolVersion() + + </dd></dl></div><div class="clear"></div></div><a id="\Zend_Gdata_Docs::$_registeredPackages" class="anchor"></a><div class="property protected 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_protected.png" style="margin-right: 5px" alt="protected"></img>array <span class="highlight">$_registeredPackages</span> = array('Zend_Gdata_Kind', 'Zend_Gdata_Extension', 'Zend_Gdata', 'Zend_Gdata_App_Extension', 'Zend_Gdata_App')</code><div class="description"><span class="attribute">inherited</span><div class="short-description">Packages to search for classes when using magic __call method, in order.</div><small class="inherited_from">Inherited from: + <a href="../files/Gdata.html#\Zend_Gdata::$$_registeredPackages">\Zend_Gdata::$$_registeredPackages</a></small></div><div class="code-tabs"><div class="long-description"></div><strong>Default value</strong><code>array('Zend_Gdata_Kind', 'Zend_Gdata_Extension', 'Zend_Gdata', 'Zend_Gdata_App_Extension', 'Zend_Gdata_App')</code><strong>Details</strong><dl class="property-info"><dt>Type</dt><dd>array</dd><dt>Inherited_from</dt><dd><a href="../files/ + Gdata.html#\Zend_Gdata::$$_registeredPackages">\Zend_Gdata::$$_registeredPackages</a> + + </dd></dl></div><div class="clear"></div></div><a id="\Zend_Gdata_Docs::$_staticHttpClient" class="anchor"></a><div class="property protected 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_protected.png" style="margin-right: 5px" alt="protected"></img>\Zend_Gdata_HttpClient <span class="highlight">$_staticHttpClient</span> = null</code><div class="description"><span class="attribute">static</span><span class="attribute">inherited</span><div class="short-description">Client object used to communicate in static context</div><small class="inherited_from">Inherited from: + <a href="../files/Gdata.html#\Zend_Gdata::$$_staticHttpClient">\Zend_Gdata::$$_staticHttpClient</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><a href="../files/Gdata.HttpClient.html#\Zend_Gdata_HttpClient">\Zend_Gdata_HttpClient</a></dd><dt>Inherited_from</dt><dd><a href="../files/ + Gdata.html#\Zend_Gdata::$$_staticHttpClient">\Zend_Gdata::$$_staticHttpClient</a> + + </dd></dl></div><div class="clear"></div></div><a id="\Zend_Gdata_Docs::$_useObjectMapping" class="anchor"></a><div class="property protected 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_protected.png" style="margin-right: 5px" alt="protected"></img>boolean <span class="highlight">$_useObjectMapping</span> = true</code><div class="description"><span class="attribute">inherited</span><div class="short-description">Whether we want to use XML to object mapping when fetching data.</div><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::$$_useObjectMapping">\Zend_Gdata_App::$$_useObjectMapping</a><a href="../files/Gdata.html#\Zend_Gdata::$$_useObjectMapping">\Zend_Gdata::$$_useObjectMapping</a></small></div><div class="code-tabs"><div class="long-description"></div><strong>Default value</strong><code>true</code><strong>Details</strong><dl class="property-info"><dt>Type</dt><dd>boolean</dd><dt>Inherited_from</dt><dd><a href="../files/ + Gdata.App.html#\Zend_Gdata_App::$$_useObjectMapping">\Zend_Gdata_App::$$_useObjectMapping</a> + + </dd><dt>Inherited_from</dt><dd><a href="../files/ + Gdata.html#\Zend_Gdata::$$_useObjectMapping">\Zend_Gdata::$$_useObjectMapping</a> + + </dd></dl></div><div class="clear"></div></div><a id="\Zend_Gdata_Docs::$_verboseExceptionMessages" class="anchor"></a><div class="property protected 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_protected.png" style="margin-right: 5px" alt="protected"></img>boolean <span class="highlight">$_verboseExceptionMessages</span> = true</code><div class="description"><span class="attribute">static</span><span class="attribute">inherited</span><div class="short-description">Use verbose exception messages.</div><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::$$_verboseExceptionMessages">\Zend_Gdata_App::$$_verboseExceptionMessages</a><a href="../files/Gdata.html#\Zend_Gdata::$$_verboseExceptionMessages">\Zend_Gdata::$$_verboseExceptionMessages</a></small></div><div class="code-tabs"><div class="long-description"><p>In the case of HTTP errors, +use the body of the HTTP response in the exception message.</p></div><strong>Default value</strong><code>true</code><strong>Details</strong><dl class="property-info"><dt>Type</dt><dd>boolean</dd><dt>Inherited_from</dt><dd><a href="../files/ + Gdata.App.html#\Zend_Gdata_App::$$_verboseExceptionMessages">\Zend_Gdata_App::$$_verboseExceptionMessages</a> + + </dd><dt>Inherited_from</dt><dd><a href="../files/ + Gdata.html#\Zend_Gdata::$$_verboseExceptionMessages">\Zend_Gdata::$$_verboseExceptionMessages</a> + + </dd></dl></div><div class="clear"></div></div><a id="\Zend_Gdata_Docs::$namespaces" class="anchor"></a><div class="property public 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_public.png" style="margin-right: 5px" alt="public"></img>array <span class="highlight">$namespaces</span> = array(array('gd', 'http://schemas.google.com/g/2005', 1, 0), array('openSearch', 'http://a9.com/-/spec/opensearchrss/1.0/', 1, 0), array('openSearch', 'http://a9.com/-/spec/opensearch/1.1/', 2, 0), array('rss', 'http://blogs.law.harvard.edu/tech/rss', 1, 0))</code><div class="description"><span class="attribute">static</span><span class="attribute">inherited</span><div class="short-description">Namespaces used for Gdata data</div><small class="inherited_from">Inherited from: + <a href="../files/Gdata.html#\Zend_Gdata::$$namespaces">\Zend_Gdata::$$namespaces</a></small></div><div class="code-tabs"><div class="long-description"></div><strong>Default value</strong><code>array(array('gd', 'http://schemas.google.com/g/2005', 1, 0), array('openSearch', 'http://a9.com/-/spec/opensearchrss/1.0/', 1, 0), array('openSearch', 'http://a9.com/-/spec/opensearch/1.1/', 2, 0), array('rss', 'http://blogs.law.harvard.edu/tech/rss', 1, 0))</code><strong>Details</strong><dl class="property-info"><dt>Type</dt><dd>array</dd><dt>Inherited_from</dt><dd><a href="../files/ + Gdata.html#\Zend_Gdata::$$namespaces">\Zend_Gdata::$$namespaces</a> + + </dd></dl></div><div class="clear"></div></div></div><h3>Methods</h3><div><a id="\Zend_Gdata_Docs::__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> : void</code><div class="description"><span class="attribute">inherited</span><p class="short_description">Provides a magic factory method to instantiate new objects with +shorter syntax than would otherwise be required by the Zend Framework +naming conventions.</p><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::__call()">\Zend_Gdata_App::__call()</a><a href="../files/Gdata.html#\Zend_Gdata::__call()">\Zend_Gdata::__call()</a></small></div><div class="code-tabs"><div class="long-description"><p>For instance, to construct a new +Zend_Gdata_Calendar_Extension_Color, a developer simply needs to do +$gCal->newColor(). For this magic constructor, packages are searched +in the same order as which they appear in the $_registeredPackages +array</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><p>The method name being called</p></em></td></tr><tr><th>$args</th><td>array</td><td><em><p>The arguments passed to the call</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_Docs::__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">(<a href="../files/Http.Client.html#\Zend_Http_Client">\Zend_Http_Client</a> $client = null, string $applicationId = 'MyCompany-MyApp-1.0')</span> : void</code><div class="description"><p class="short_description">Create Gdata_Docs object</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>$client</th><td><a href="../files/Http.Client.html#\Zend_Http_Client">\Zend_Http_Client</a></td><td><em><p>(optional) The HTTP client to use when + when communicating with the Google servers.</p> +</em></td></tr><tr><th>$applicationId</th><td>string</td><td><em><p>The identity of the app in the form of Company-AppName-Version</p> +</em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Docs::createFolder()" 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">createFolder</span><span class="nb-faded-text">(string $folderName, string | null $folderResourceId = null)</span> : <a href="../files/Gdata.Entry.html#\Zend_Gdata_Entry">\Zend_Gdata_Entry</a></code><div class="description"><p class="short_description">Creates a new folder in Google Docs</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>$folderName</th><td>string</td><td><em><p>The folder name to create</p></em></td></tr><tr><th>$folderResourceId</th><td>string | null</td><td><em><p>The parent folder to create it in + ("folder%3Amy_parent_folder")</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.Entry.html#\Zend_Gdata_Entry">\Zend_Gdata_Entry</a></td><td>The folder entry created.</td></tr></table><strong>Details</strong><dl class="function-info"><dt>Todo</dt><dd>ZF-8732: This should return a *subclass* of Zend_Gdata_Entry, but + the appropriate type doesn't exist yet. + + </dd></dl></div><div class="clear"></div></div><a id="\Zend_Gdata_Docs::delete()" 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">delete</span><span class="nb-faded-text">(mixed $data, $remainingRedirects = null)</span> : void</code><div class="description"><span class="attribute">inherited</span><p class="short_description">DELETE entry with client object</p><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::delete()">\Zend_Gdata_App::delete()</a><a href="../files/Gdata.html#\Zend_Gdata::delete()">\Zend_Gdata::delete()</a></small></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>$data</th><td>mixed</td><td><em><p>The Zend_Gdata_App_Entry or URL to delete</p></em></td></tr><tr><th>$remainingRedirects</th><td></td><td><em></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><tr><td><a href="../files/Gdata.App.HttpException.html#\Zend_Gdata_App_HttpException">\Zend_Gdata_App_HttpException</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.App.InvalidArgumentException.html#\Zend_Gdata_App_InvalidArgumentException">\Zend_Gdata_App_InvalidArgumentException</a></td><td><em></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Docs::enableRequestDebugLogging()" 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">enableRequestDebugLogging</span><span class="nb-faded-text">(string $logfile)</span> : void</code><div class="description"><span class="attribute">inherited</span><p class="short_description">This method enables logging of requests by changing the +Zend_Http_Client_Adapter used for performing the requests.</p><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::enableRequestDebugLogging()">\Zend_Gdata_App::enableRequestDebugLogging()</a><a href="../files/Gdata.html#\Zend_Gdata::enableRequestDebugLogging()">\Zend_Gdata::enableRequestDebugLogging()</a></small></div><div class="code-tabs"><div class="long-description"><p>NOTE: This will not work if you have customized the adapter +already to use a proxy server or other interface.</p></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$logfile</th><td>string</td><td><em><p>The logfile to use when logging the requests</p></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Docs::generateIfMatchHeaderData()" 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">generateIfMatchHeaderData</span><span class="nb-faded-text">( $data, $allowWeek)</span> : string | null</code><div class="description"><span class="attribute">inherited</span><p class="short_description">Returns the data for an If-Match header based on the current Etag +property.</p><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::generateIfMatchHeaderData()">\Zend_Gdata_App::generateIfMatchHeaderData()</a><a href="../files/Gdata.html#\Zend_Gdata::generateIfMatchHeaderData()">\Zend_Gdata::generateIfMatchHeaderData()</a></small></div><div class="code-tabs"><div class="long-description"><p>If Etags are not supported by the server or cannot be +extracted from the data, then null will be returned.</p></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$data</th><td></td><td><em></em></td></tr><tr><th>$allowWeek</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>string | null</td><td>$data</td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Docs::get()" 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">get</span><span class="nb-faded-text">(string $uri, array $extraHeaders = array())</span> : <a href="../files/Http.Response.html#\Zend_Http_Response">\Zend_Http_Response</a></code><div class="description"><span class="attribute">inherited</span><p class="short_description">GET a URI using client object.</p><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::get()">\Zend_Gdata_App::get()</a><a href="../files/Gdata.html#\Zend_Gdata::get()">\Zend_Gdata::get()</a></small></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>$uri</th><td>string</td><td><em><p>GET URI</p></em></td></tr><tr><th>$extraHeaders</th><td>array</td><td><em><p>Extra headers to add to the request, as an + array of string-based key/value pairs.</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/Http.Response.html#\Zend_Http_Response">\Zend_Http_Response</a></td><td></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.HttpException.html#\Zend_Gdata_App_HttpException">\Zend_Gdata_App_HttpException</a></td><td><em></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Docs::getDoc()" 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">getDoc</span><span class="nb-faded-text">(string $docId, string $docType)</span> : <a href="../files/Gdata.Docs.DocumentListEntry.html#\Zend_Gdata_Docs_DocumentListEntry">\Zend_Gdata_Docs_DocumentListEntry</a></code><div class="description"><p class="short_description">Retreive entry object representing a single document.</p></div><div class="code-tabs"><div class="long-description"><p>This method builds the URL where this item is stored using the type +and the id of the document.</p></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$docId</th><td>string</td><td><em><p>The URL key for the document. Examples: + dcmg89gw_62hfjj8m, pKq0CzjiF3YmGd0AIlHKqeg</p></em></td></tr><tr><th>$docType</th><td>string</td><td><em><p>The type of the document as used in the Google + Document List URLs. Examples: document, spreadsheet, presentation</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.Docs.DocumentListEntry.html#\Zend_Gdata_Docs_DocumentListEntry">\Zend_Gdata_Docs_DocumentListEntry</a></td><td></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Docs::getDocument()" 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">getDocument</span><span class="nb-faded-text">(string $id)</span> : void</code><div class="description"><p class="short_description">Retreive entry object for the desired word processing document.</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>$id</th><td>string</td><td><em><p>The URL id for the document. Example: + dcmg89gw_62hfjj8m</p></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Docs::getDocumentListEntry()" 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">getDocumentListEntry</span><span class="nb-faded-text">(mixed $location = null)</span> : <a href="../files/Gdata.Docs.DocumentListEntry.html#\Zend_Gdata_Docs_DocumentListEntry">\Zend_Gdata_Docs_DocumentListEntry</a></code><div class="description"><p class="short_description">Retreive entry object representing a single document.</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>$location</th><td>mixed</td><td><em><p>The location for the entry, as a URL or Query</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.Docs.DocumentListEntry.html#\Zend_Gdata_Docs_DocumentListEntry">\Zend_Gdata_Docs_DocumentListEntry</a></td><td></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Docs::getDocumentListFeed()" 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">getDocumentListFeed</span><span class="nb-faded-text">(mixed $location = null)</span> : <a href="../files/Gdata.Docs.DocumentListFeed.html#\Zend_Gdata_Docs_DocumentListFeed">\Zend_Gdata_Docs_DocumentListFeed</a></code><div class="description"><p class="short_description">Retreive feed object containing entries for the user's documents.</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>$location</th><td>mixed</td><td><em><p>The location for the feed, as a URL or Query</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.Docs.DocumentListFeed.html#\Zend_Gdata_Docs_DocumentListFeed">\Zend_Gdata_Docs_DocumentListFeed</a></td><td></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Docs::getEntry()" 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">getEntry</span><span class="nb-faded-text">(mixed $location, $className = 'Zend_Gdata_Entry')</span> : string | <a href="../files/Gdata.App.Entry.html#\Zend_Gdata_App_Entry">\Zend_Gdata_App_Entry</a></code><div class="description"><span class="attribute">inherited</span><p class="short_description">Retrieve entry as string or object</p><small class="inherited_from">Inherited from: + <a href="../files/Gdata.html#\Zend_Gdata::getEntry()">\Zend_Gdata::getEntry()</a></small></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>$location</th><td>mixed</td><td><em><p>The location as string or Zend_Gdata_Query</p></em></td></tr><tr><th>$className</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>string | <a href="../files/Gdata.App.Entry.html#\Zend_Gdata_App_Entry">\Zend_Gdata_App_Entry</a></td><td>Returns string only if the object + mapping has been disabled explicitly + by passing false to the + useObjectMapping() function.</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.InvalidArgumentException.html#\Zend_Gdata_App_InvalidArgumentException">\Zend_Gdata_App_InvalidArgumentException</a></td><td><em></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Docs::getFeed()" 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">getFeed</span><span class="nb-faded-text">(mixed $location, string $className = 'Zend_Gdata_Feed')</span> : string | <a href="../files/Gdata.App.Feed.html#\Zend_Gdata_App_Feed">\Zend_Gdata_App_Feed</a></code><div class="description"><span class="attribute">inherited</span><p class="short_description">Retrieve feed as string or object</p><small class="inherited_from">Inherited from: + <a href="../files/Gdata.html#\Zend_Gdata::getFeed()">\Zend_Gdata::getFeed()</a></small></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>$location</th><td>mixed</td><td><em><p>The location as string or Zend_Gdata_Query</p></em></td></tr><tr><th>$className</th><td>string</td><td><em><p>The class type to use for returning the feed</p></em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>string | <a href="../files/Gdata.App.Feed.html#\Zend_Gdata_App_Feed">\Zend_Gdata_App_Feed</a></td><td>Returns string only if the object + mapping has been disabled explicitly + by passing false to the + useObjectMapping() function.</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.InvalidArgumentException.html#\Zend_Gdata_App_InvalidArgumentException">\Zend_Gdata_App_InvalidArgumentException</a></td><td><em></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Docs::getGzipEnabled()" 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">getGzipEnabled</span><span class="nb-faded-text">()</span> : boolean</code><div class="description"><span class="attribute">static</span><span class="attribute">inherited</span><p class="short_description">Get the HTTP override state</p><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::getGzipEnabled()">\Zend_Gdata_App::getGzipEnabled()</a><a href="../files/Gdata.html#\Zend_Gdata::getGzipEnabled()">\Zend_Gdata::getGzipEnabled()</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>boolean</td><td></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Docs::getHttpClient()" 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">getHttpClient</span><span class="nb-faded-text">()</span> : <a href="../files/Http.Client.html#\Zend_Http_Client">\Zend_Http_Client</a></code><div class="description"><span class="attribute">inherited</span><p class="short_description">Get the Zend_Http_Client object used for communication</p><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::getHttpClient()">\Zend_Gdata_App::getHttpClient()</a><a href="../files/Gdata.html#\Zend_Gdata::getHttpClient()">\Zend_Gdata::getHttpClient()</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.Client.html#\Zend_Http_Client">\Zend_Http_Client</a></td><td></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Docs::getHttpMethodOverride()" 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">getHttpMethodOverride</span><span class="nb-faded-text">()</span> : boolean</code><div class="description"><span class="attribute">static</span><span class="attribute">inherited</span><p class="short_description">Get the HTTP override state</p><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::getHttpMethodOverride()">\Zend_Gdata_App::getHttpMethodOverride()</a><a href="../files/Gdata.html#\Zend_Gdata::getHttpMethodOverride()">\Zend_Gdata::getHttpMethodOverride()</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>boolean</td><td></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Docs::getMajorProtocolVersion()" 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">getMajorProtocolVersion</span><span class="nb-faded-text">()</span> : int</code><div class="description"><span class="attribute">inherited</span><p class="short_description">Get the major protocol version that is in use.</p><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::getMajorProtocolVersion()">\Zend_Gdata_App::getMajorProtocolVersion()</a><a href="../files/Gdata.html#\Zend_Gdata::getMajorProtocolVersion()">\Zend_Gdata::getMajorProtocolVersion()</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>int</td><td>The major protocol version in use.</td></tr></table><strong>Details</strong><dl class="function-info"><dt>See</dt><dd>\_majorProtocolVersion + + </dd></dl></div><div class="clear"></div></div><a id="\Zend_Gdata_Docs::getMaxRedirects()" 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">getMaxRedirects</span><span class="nb-faded-text">()</span> : int</code><div class="description"><span class="attribute">static</span><span class="attribute">inherited</span><p class="short_description">Get the maximum number of redirects to follow during HTTP operations</p><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::getMaxRedirects()">\Zend_Gdata_App::getMaxRedirects()</a><a href="../files/Gdata.html#\Zend_Gdata::getMaxRedirects()">\Zend_Gdata::getMaxRedirects()</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>int</td><td>Maximum number of redirects to follow</td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Docs::getMinorProtocolVersion()" 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">getMinorProtocolVersion</span><span class="nb-faded-text">()</span> : \(int | \NULL)</code><div class="description"><span class="attribute">inherited</span><p class="short_description">Get the minor protocol version that is in use.</p><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::getMinorProtocolVersion()">\Zend_Gdata_App::getMinorProtocolVersion()</a><a href="../files/Gdata.html#\Zend_Gdata::getMinorProtocolVersion()">\Zend_Gdata::getMinorProtocolVersion()</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>\(int | \NULL)</td><td>The major protocol version in use, or NULL if no + minor version is specified.</td></tr></table><strong>Details</strong><dl class="function-info"><dt>See</dt><dd>\_minorProtocolVersion + + </dd></dl></div><div class="clear"></div></div><a id="\Zend_Gdata_Docs::getNextFeed()" 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">getNextFeed</span><span class="nb-faded-text">(<a href="../files/Gdata.App.Feed.html#\Zend_Gdata_App_Feed">\Zend_Gdata_App_Feed</a> $feed, string $className = null)</span> : <a href="../files/Gdata.App.Feed.html#\Zend_Gdata_App_Feed">\Zend_Gdata_App_Feed</a> | null</code><div class="description"><span class="attribute">inherited</span><p class="short_description">Retrieve next set of results based on a given feed.</p><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::getNextFeed()">\Zend_Gdata_App::getNextFeed()</a><a href="../files/Gdata.html#\Zend_Gdata::getNextFeed()">\Zend_Gdata::getNextFeed()</a></small></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>$feed</th><td><a href="../files/Gdata.App.Feed.html#\Zend_Gdata_App_Feed">\Zend_Gdata_App_Feed</a></td><td><em><p>The feed from which to + retreive the next set of results.</p></em></td></tr><tr><th>$className</th><td>string</td><td><em><p>(optional) The class of feed to be returned. + If null, the next feed (if found) will be the same class as + the feed that was given as the first argument.</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.App.Feed.html#\Zend_Gdata_App_Feed">\Zend_Gdata_App_Feed</a> | null</td><td>Returns a + Zend_Gdata_App_Feed or null if no next set of results + exists.</td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Docs::getPresentation()" 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">getPresentation</span><span class="nb-faded-text">(string $id)</span> : void</code><div class="description"><p class="short_description">Retreive entry object for the desired presentation.</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>$id</th><td>string</td><td><em><p>The URL id for the document. Example: + dcmg89gw_21gtrjcn</p></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Docs::getPreviousFeed()" 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">getPreviousFeed</span><span class="nb-faded-text">(<a href="../files/Gdata.App.Feed.html#\Zend_Gdata_App_Feed">\Zend_Gdata_App_Feed</a> $feed, string $className = null)</span> : <a href="../files/Gdata.App.Feed.html#\Zend_Gdata_App_Feed">\Zend_Gdata_App_Feed</a> | null</code><div class="description"><span class="attribute">inherited</span><p class="short_description">Retrieve previous set of results based on a given feed.</p><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::getPreviousFeed()">\Zend_Gdata_App::getPreviousFeed()</a><a href="../files/Gdata.html#\Zend_Gdata::getPreviousFeed()">\Zend_Gdata::getPreviousFeed()</a></small></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>$feed</th><td><a href="../files/Gdata.App.Feed.html#\Zend_Gdata_App_Feed">\Zend_Gdata_App_Feed</a></td><td><em><p>The feed from which to + retreive the previous set of results.</p></em></td></tr><tr><th>$className</th><td>string</td><td><em><p>(optional) The class of feed to be returned. + If null, the previous feed (if found) will be the same class as + the feed that was given as the first argument.</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.App.Feed.html#\Zend_Gdata_App_Feed">\Zend_Gdata_App_Feed</a> | null</td><td>Returns a + Zend_Gdata_App_Feed or null if no previous set of results + exists.</td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Docs::getSpreadsheet()" 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">getSpreadsheet</span><span class="nb-faded-text">(string $id)</span> : void</code><div class="description"><p class="short_description">Retreive entry object for the desired spreadsheet.</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>$id</th><td>string</td><td><em><p>The URL id for the document. Example: + pKq0CzjiF3YmGd0AIlHKqeg</p></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Docs::getStaticHttpClient()" 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">getStaticHttpClient</span><span class="nb-faded-text">()</span> : <a href="../files/Http.Client.html#\Zend_Http_Client">\Zend_Http_Client</a></code><div class="description"><span class="attribute">static</span><span class="attribute">inherited</span><p class="short_description">Gets the HTTP client object.</p><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::getStaticHttpClient()">\Zend_Gdata_App::getStaticHttpClient()</a><a href="../files/Gdata.html#\Zend_Gdata::getStaticHttpClient()">\Zend_Gdata::getStaticHttpClient()</a></small></div><div class="code-tabs"><div class="long-description"><p>If none is set, a new Zend_Http_Client will be used.</p></div><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td><a href="../files/Http.Client.html#\Zend_Http_Client">\Zend_Http_Client</a></td><td></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Docs::getVerboseExceptionMessages()" 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">getVerboseExceptionMessages</span><span class="nb-faded-text">()</span> : boolean</code><div class="description"><span class="attribute">static</span><span class="attribute">inherited</span><p class="short_description">Get whether to use verbose exception messages</p><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::getVerboseExceptionMessages()">\Zend_Gdata_App::getVerboseExceptionMessages()</a><a href="../files/Gdata.html#\Zend_Gdata::getVerboseExceptionMessages()">\Zend_Gdata::getVerboseExceptionMessages()</a></small></div><div class="code-tabs"><div class="long-description"><p>In the case of HTTP errors, use the body of the HTTP response +in the exception message.</p></div><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>boolean</td><td></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Docs::import()" 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">import</span><span class="nb-faded-text">(string $uri, <a href="../files/Http.Client.html#\Zend_Http_Client">\Zend_Http_Client</a> $client = null, string $className = 'Zend_Gdata_Feed')</span> : string | <a href="../files/Gdata.App.Feed.html#\Zend_Gdata_App_Feed">\Zend_Gdata_App_Feed</a></code><div class="description"><span class="attribute">static</span><span class="attribute">inherited</span><p class="short_description">Imports a feed located at $uri.</p><small class="inherited_from">Inherited from: + <a href="../files/Gdata.html#\Zend_Gdata::import()">\Zend_Gdata::import()</a></small></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>$uri</th><td>string</td><td><em></em></td></tr><tr><th>$client</th><td><a href="../files/Http.Client.html#\Zend_Http_Client">\Zend_Http_Client</a></td><td><em><p>The client used for communication</p></em></td></tr><tr><th>$className</th><td>string</td><td><em><p>The class which is used as the return type</p></em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>string | <a href="../files/Gdata.App.Feed.html#\Zend_Gdata_App_Feed">\Zend_Gdata_App_Feed</a></td><td>Returns string only if the object + mapping has been disabled explicitly + by passing false to the + useObjectMapping() function.</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_Docs::importFile()" 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">importFile</span><span class="nb-faded-text">(string $filename, string $className = 'Zend_Gdata_App_Feed', string $useIncludePath = false)</span> : <a href="../files/Gdata.App.Feed.html#\Zend_Gdata_App_Feed">\Zend_Gdata_App_Feed</a></code><div class="description"><span class="attribute">static</span><span class="attribute">inherited</span><p class="short_description">Imports a feed from a file located at $filename.</p><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::importFile()">\Zend_Gdata_App::importFile()</a><a href="../files/Gdata.html#\Zend_Gdata::importFile()">\Zend_Gdata::importFile()</a></small></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>$filename</th><td>string</td><td><em></em></td></tr><tr><th>$className</th><td>string</td><td><em><p>The class which is used as the return type</p></em></td></tr><tr><th>$useIncludePath</th><td>string</td><td><em><p>Whether the include_path should be searched</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.App.Feed.html#\Zend_Gdata_App_Feed">\Zend_Gdata_App_Feed</a></td><td></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_Docs::importString()" 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">importString</span><span class="nb-faded-text">(string $string, string $className = 'Zend_Gdata_App_Feed', $majorProtocolVersion = null, $minorProtocolVersion = null)</span> : <a href="../files/Gdata.App.Feed.html#\Zend_Gdata_App_Feed">\Zend_Gdata_App_Feed</a></code><div class="description"><span class="attribute">static</span><span class="attribute">inherited</span><p class="short_description">Imports a feed represented by $string.</p><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::importString()">\Zend_Gdata_App::importString()</a><a href="../files/Gdata.html#\Zend_Gdata::importString()">\Zend_Gdata::importString()</a></small></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></em></td></tr><tr><th>$className</th><td>string</td><td><em><p>The class which is used as the return type</p></em></td></tr><tr><th>$majorProtocolVersion</th><td></td><td><em></em></td></tr><tr><th>$minorProtocolVersion</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.App.Feed.html#\Zend_Gdata_App_Feed">\Zend_Gdata_App_Feed</a></td><td></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_Docs::importUrl()" 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">importUrl</span><span class="nb-faded-text">(string $url, string $className = 'Zend_Gdata_App_Feed', array $extraHeaders = array())</span> : string | <a href="../files/Gdata.App.Feed.html#\Zend_Gdata_App_Feed">\Zend_Gdata_App_Feed</a></code><div class="description"><span class="attribute">inherited</span><p class="short_description">Imports the specified URL (non-statically).</p><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::importUrl()">\Zend_Gdata_App::importUrl()</a><a href="../files/Gdata.html#\Zend_Gdata::importUrl()">\Zend_Gdata::importUrl()</a></small></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>$url</th><td>string</td><td><em><p>The URL to import</p></em></td></tr><tr><th>$className</th><td>string</td><td><em><p>The class which is used as the return type</p></em></td></tr><tr><th>$extraHeaders</th><td>array</td><td><em><p>Extra headers to add to the request, as an + array of string-based key/value pairs.</p> +</em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>string | <a href="../files/Gdata.App.Feed.html#\Zend_Gdata_App_Feed">\Zend_Gdata_App_Feed</a></td><td>Returns string only if the object + mapping has been disabled explicitly + by passing false to the + useObjectMapping() function.</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_Docs::insertDocument()" 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">insertDocument</span><span class="nb-faded-text">(mixed $data, string $uri, string $className = 'Zend_Gdata_Docs_DocumentListEntry')</span> : <a href="../files/Gdata.Docs.DocumentListEntry.html#\Zend_Gdata_Docs_DocumentListEntry">\Zend_Gdata_Docs_DocumentListEntry</a></code><div class="description"><p class="short_description">Inserts an entry to a given URI and returns the response as an Entry.</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>$data</th><td>mixed</td><td><em><p>The Zend_Gdata_Docs_DocumentListEntry or media + source to post. If it is a DocumentListEntry, the mediaSource + should already have been set. If $data is a mediaSource, it + should have the correct slug header and mime type.</p> +</em></td></tr><tr><th>$uri</th><td>string</td><td><em><p>POST URI</p></em></td></tr><tr><th>$className</th><td>string</td><td><em><p>(optional) The class of entry to be returned. + The default is a 'Zend_Gdata_Docs_DocumentListEntry'.</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.Docs.DocumentListEntry.html#\Zend_Gdata_Docs_DocumentListEntry">\Zend_Gdata_Docs_DocumentListEntry</a></td><td>The entry returned by the + service after insertion.</td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Docs::insertEntry()" 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">insertEntry</span><span class="nb-faded-text">(mixed $data, string $uri, string $className = 'Zend_Gdata_App_Entry', array $extraHeaders = array())</span> : <a href="../files/Gdata.App.Entry.html#\Zend_Gdata_App_Entry">\Zend_Gdata_App_Entry</a></code><div class="description"><span class="attribute">inherited</span><p class="short_description">Inserts an entry to a given URI and returns the response as a +fully formed Entry.</p><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::insertEntry()">\Zend_Gdata_App::insertEntry()</a><a href="../files/Gdata.html#\Zend_Gdata::insertEntry()">\Zend_Gdata::insertEntry()</a></small></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>$data</th><td>mixed</td><td><em><p>The Zend_Gdata_App_Entry or XML to post</p></em></td></tr><tr><th>$uri</th><td>string</td><td><em><p>POST URI</p></em></td></tr><tr><th>$className</th><td>string</td><td><em><p>The class of entry to be returned.</p></em></td></tr><tr><th>$extraHeaders</th><td>array</td><td><em><p>Extra headers to add to the request, as an + array of string-based key/value pairs.</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.App.Entry.html#\Zend_Gdata_App_Entry">\Zend_Gdata_App_Entry</a></td><td>The entry returned by the service after + insertion.</td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Docs::isAuthenticated()" 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">isAuthenticated</span><span class="nb-faded-text">()</span> : boolean</code><div class="description"><span class="attribute">inherited</span><p class="short_description">Determines whether service object is authenticated.</p><small class="inherited_from">Inherited from: + <a href="../files/Gdata.html#\Zend_Gdata::isAuthenticated()">\Zend_Gdata::isAuthenticated()</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>boolean</td><td>True if service object is authenticated, false otherwise.</td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Docs::lookupMimeType()" 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">lookupMimeType</span><span class="nb-faded-text">(string $fileExtension)</span> : string</code><div class="description"><span class="attribute">static</span><p class="short_description">Looks up the mime type based on the file name extension.</p></div><div class="code-tabs"><div class="long-description"><p>For example, +calling this method with 'csv' would return +'text/comma-separated-values'. The Mime type is sent as a header in +the upload HTTP POST request.</p></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$fileExtension</th><td>string</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>string</td><td>The mime type to be sent to the server to tell it how the + multipart mime data should be interpreted.</td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Docs::performHttpRequest()" 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">performHttpRequest</span><span class="nb-faded-text">(string $method, string $url, array $headers = array(), string $body = null, string $contentType = null, int $remainingRedirects = null)</span> : <a href="../files/Http.Response.html#\Zend_Http_Response">\Zend_Http_Response</a></code><div class="description"><span class="attribute">inherited</span><p class="short_description">Performs a HTTP request using the specified method.</p><small class="inherited_from">Inherited from: + <a href="../files/Gdata.html#\Zend_Gdata::performHttpRequest()">\Zend_Gdata::performHttpRequest()</a></small></div><div class="code-tabs"><div class="long-description"><p>Overrides the definition in the parent (Zend_Gdata_App) +and uses the Zend_Gdata_HttpClient functionality +to filter the HTTP requests and responses.</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><p>The HTTP method for the request - + 'GET', 'POST', 'PUT', 'DELETE'</p> +</em></td></tr><tr><th>$url</th><td>string</td><td><em><p>The URL to which this request is being performed, + or null if found in $data</p> +</em></td></tr><tr><th>$headers</th><td>array</td><td><em><p>An associative array of HTTP headers + for this request</p></em></td></tr><tr><th>$body</th><td>string</td><td><em><p>The body of the HTTP request</p></em></td></tr><tr><th>$contentType</th><td>string</td><td><em><p>The value for the content type of the + request body</p></em></td></tr><tr><th>$remainingRedirects</th><td>int</td><td><em><p>Number of redirects to follow + if requests results in one</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/Http.Response.html#\Zend_Http_Response">\Zend_Http_Response</a></td><td>The response object</td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Docs::post()" 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">post</span><span class="nb-faded-text">(mixed $data, string $uri = null, $remainingRedirects = null, string $contentType = null, array $extraHeaders = null)</span> : <a href="../files/Http.Response.html#\Zend_Http_Response">\Zend_Http_Response</a></code><div class="description"><span class="attribute">inherited</span><p class="short_description">POST data with client object</p><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::post()">\Zend_Gdata_App::post()</a><a href="../files/Gdata.html#\Zend_Gdata::post()">\Zend_Gdata::post()</a></small></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>$data</th><td>mixed</td><td><em><p>The Zend_Gdata_App_Entry or XML to post</p></em></td></tr><tr><th>$uri</th><td>string</td><td><em><p>POST URI</p></em></td></tr><tr><th>$remainingRedirects</th><td></td><td><em></em></td></tr><tr><th>$contentType</th><td>string</td><td><em><p>Content-type of the data</p> +</em></td></tr><tr><th>$extraHeaders</th><td>array</td><td><em><p>Extra headers to add to the request, as an + array of string-based key/value pairs.</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/Http.Response.html#\Zend_Http_Response">\Zend_Http_Response</a></td><td></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><tr><td><a href="../files/Gdata.App.HttpException.html#\Zend_Gdata_App_HttpException">\Zend_Gdata_App_HttpException</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.App.InvalidArgumentException.html#\Zend_Gdata_App_InvalidArgumentException">\Zend_Gdata_App_InvalidArgumentException</a></td><td><em></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Docs::prepareRequest()" 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">prepareRequest</span><span class="nb-faded-text">(string $method, string $url = null, array $headers = array(), mixed $data = null, string $contentTypeOverride = null)</span> : array</code><div class="description"><span class="attribute">inherited</span><p class="short_description">Provides pre-processing for HTTP requests to APP services.</p><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::prepareRequest()">\Zend_Gdata_App::prepareRequest()</a><a href="../files/Gdata.html#\Zend_Gdata::prepareRequest()">\Zend_Gdata::prepareRequest()</a></small></div><div class="code-tabs"><div class="long-description"><ol> +<li>Checks the $data element and, if it's an entry, extracts the XML, +multipart data, edit link (PUT,DELETE), etc.</li> +<li>If $data is a string, sets the default content-type header as +'application/atom+xml' if it's not already been set.</li> +<li>Adds a x-http-method override header and changes the HTTP method +to 'POST' if necessary as per getHttpMethodOverride()</li> +</ol></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><p>The HTTP method for the request - 'GET', 'POST', + 'PUT', 'DELETE'</p> +</em></td></tr><tr><th>$url</th><td>string</td><td><em><p>The URL to which this request is being performed, + or null if found in $data</p> +</em></td></tr><tr><th>$headers</th><td>array</td><td><em><p>An associative array of HTTP headers for this + request</p></em></td></tr><tr><th>$data</th><td>mixed</td><td><em><p>The Zend_Gdata_App_Entry or XML for the + body of the request</p></em></td></tr><tr><th>$contentTypeOverride</th><td>string</td><td><em><p>The override value for the + content type of the request body</p></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 associative array containing the determined + 'method', 'url', 'data', 'headers', 'contentType'</td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Docs::put()" 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">put</span><span class="nb-faded-text">(mixed $data, string $uri = null, $remainingRedirects = null, string $contentType = null, array $extraHeaders = null)</span> : <a href="../files/Http.Response.html#\Zend_Http_Response">\Zend_Http_Response</a></code><div class="description"><span class="attribute">inherited</span><p class="short_description">PUT data with client object</p><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::put()">\Zend_Gdata_App::put()</a><a href="../files/Gdata.html#\Zend_Gdata::put()">\Zend_Gdata::put()</a></small></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>$data</th><td>mixed</td><td><em><p>The Zend_Gdata_App_Entry or XML to post</p></em></td></tr><tr><th>$uri</th><td>string</td><td><em><p>PUT URI</p></em></td></tr><tr><th>$remainingRedirects</th><td></td><td><em></em></td></tr><tr><th>$contentType</th><td>string</td><td><em><p>Content-type of the data</p> +</em></td></tr><tr><th>$extraHeaders</th><td>array</td><td><em><p>Extra headers to add to the request, as an + array of string-based key/value pairs.</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/Http.Response.html#\Zend_Http_Response">\Zend_Http_Response</a></td><td></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><tr><td><a href="../files/Gdata.App.HttpException.html#\Zend_Gdata_App_HttpException">\Zend_Gdata_App_HttpException</a></td><td><em></em></td></tr><tr><td><a href="../files/Gdata.App.InvalidArgumentException.html#\Zend_Gdata_App_InvalidArgumentException">\Zend_Gdata_App_InvalidArgumentException</a></td><td><em></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Docs::registerPackage()" 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">registerPackage</span><span class="nb-faded-text">(string $name)</span> : void</code><div class="description"><span class="attribute">inherited</span><p class="short_description">Adds a Zend Framework package to the $_registeredPackages array.</p><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::registerPackage()">\Zend_Gdata_App::registerPackage()</a><a href="../files/Gdata.html#\Zend_Gdata::registerPackage()">\Zend_Gdata::registerPackage()</a></small></div><div class="code-tabs"><div class="long-description"><p>This array is searched when using the magic __call method below +to instantiante new objects.</p></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$name</th><td>string</td><td><em><p>The name of the package (eg Zend_Gdata_App)</p> +</em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Docs::retrieveAllEntriesForFeed()" 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">retrieveAllEntriesForFeed</span><span class="nb-faded-text">(object $feed)</span> : mixed</code><div class="description"><span class="attribute">inherited</span><p class="short_description">Retrieve all entries for a feed, iterating through pages as necessary.</p><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::retrieveAllEntriesForFeed()">\Zend_Gdata_App::retrieveAllEntriesForFeed()</a><a href="../files/Gdata.html#\Zend_Gdata::retrieveAllEntriesForFeed()">\Zend_Gdata::retrieveAllEntriesForFeed()</a></small></div><div class="code-tabs"><div class="long-description"><p>Be aware that calling this function on a large dataset will take a +significant amount of time to complete. In some cases this may cause +execution to timeout without proper precautions in place.</p></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$feed</th><td>object</td><td><em><p>The feed to iterate through.</p></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>A new feed of the same type as the one originally + passed in, containing all relevent entries.</td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Docs::setGzipEnabled()" 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">setGzipEnabled</span><span class="nb-faded-text">(boolean $enabled = false)</span> : void</code><div class="description"><span class="attribute">static</span><span class="attribute">inherited</span><p class="short_description">Toggle requesting gzip encoded responses</p><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::setGzipEnabled()">\Zend_Gdata_App::setGzipEnabled()</a><a href="../files/Gdata.html#\Zend_Gdata::setGzipEnabled()">\Zend_Gdata::setGzipEnabled()</a></small></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>$enabled</th><td>boolean</td><td><em><p>Whether or not to enable gzipped responses</p></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Docs::setHttpClient()" 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">setHttpClient</span><span class="nb-faded-text">(<a href="../files/Http.Client.html#\Zend_Http_Client">\Zend_Http_Client</a> $client, $applicationId = 'MyCompany-MyApp-1.0')</span> : <a href="../files/Gdata.App.html#\Zend_Gdata_App">\Zend_Gdata_App</a></code><div class="description"><span class="attribute">inherited</span><p class="short_description">Set the Zend_Http_Client object used for communication</p><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::setHttpClient()">\Zend_Gdata_App::setHttpClient()</a><a href="../files/Gdata.html#\Zend_Gdata::setHttpClient()">\Zend_Gdata::setHttpClient()</a></small></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>$client</th><td><a href="../files/Http.Client.html#\Zend_Http_Client">\Zend_Http_Client</a></td><td><em><p>The client to use for communication</p></em></td></tr><tr><th>$applicationId</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.App.html#\Zend_Gdata_App">\Zend_Gdata_App</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.HttpException.html#\Zend_Gdata_App_HttpException">\Zend_Gdata_App_HttpException</a></td><td><em></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Docs::setHttpMethodOverride()" 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">setHttpMethodOverride</span><span class="nb-faded-text">(boolean $override = true)</span> : void</code><div class="description"><span class="attribute">static</span><span class="attribute">inherited</span><p class="short_description">Toggle using POST instead of PUT and DELETE HTTP methods</p><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::setHttpMethodOverride()">\Zend_Gdata_App::setHttpMethodOverride()</a><a href="../files/Gdata.html#\Zend_Gdata::setHttpMethodOverride()">\Zend_Gdata::setHttpMethodOverride()</a></small></div><div class="code-tabs"><div class="long-description"><p>Some feed implementations do not accept PUT and DELETE HTTP +methods, or they can't be used because of proxies or other +measures. This allows turning on using POST where PUT and +DELETE would normally be used; in addition, an +X-Method-Override header will be sent with a value of PUT or +DELETE as appropriate.</p></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$override</th><td>boolean</td><td><em><p>Whether to override PUT and DELETE with POST.</p></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Docs::setMajorProtocolVersion()" 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">setMajorProtocolVersion</span><span class="nb-faded-text">(int $value)</span> : void</code><div class="description"><span class="attribute">inherited</span><p class="short_description">Set the major protocol version that should be used.</p><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::setMajorProtocolVersion()">\Zend_Gdata_App::setMajorProtocolVersion()</a><a href="../files/Gdata.html#\Zend_Gdata::setMajorProtocolVersion()">\Zend_Gdata::setMajorProtocolVersion()</a></small></div><div class="code-tabs"><div class="long-description"><p>Values < 1 will +cause a Zend_Gdata_App_InvalidArgumentException to be thrown.</p></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$value</th><td>int</td><td><em><p>The major protocol version to use.</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.InvalidArgumentException.html#\Zend_Gdata_App_InvalidArgumentException">\Zend_Gdata_App_InvalidArgumentException</a></td><td><em></em></td></tr></table><strong>Details</strong><dl class="function-info"><dt>See</dt><dd>\_majorProtocolVersion + + </dd></dl></div><div class="clear"></div></div><a id="\Zend_Gdata_Docs::setMaxRedirects()" 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">setMaxRedirects</span><span class="nb-faded-text">(int $maxRedirects)</span> : void</code><div class="description"><span class="attribute">static</span><span class="attribute">inherited</span><p class="short_description">Set the maximum number of redirects to follow during HTTP operations</p><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::setMaxRedirects()">\Zend_Gdata_App::setMaxRedirects()</a><a href="../files/Gdata.html#\Zend_Gdata::setMaxRedirects()">\Zend_Gdata::setMaxRedirects()</a></small></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>$maxRedirects</th><td>int</td><td><em><p>Maximum number of redirects to follow</p></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Docs::setMinorProtocolVersion()" 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">setMinorProtocolVersion</span><span class="nb-faded-text">(\(int | \NULL) $value)</span> : void</code><div class="description"><span class="attribute">inherited</span><p class="short_description">Set the minor protocol version that should be used.</p><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::setMinorProtocolVersion()">\Zend_Gdata_App::setMinorProtocolVersion()</a><a href="../files/Gdata.html#\Zend_Gdata::setMinorProtocolVersion()">\Zend_Gdata::setMinorProtocolVersion()</a></small></div><div class="code-tabs"><div class="long-description"><p>If set to NULL, no +minor protocol version will be sent to the server. Values < 0 will +cause a Zend_Gdata_App_InvalidArgumentException to be thrown.</p></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$value</th><td>\(int | \NULL)</td><td><em><p>The minor protocol version to use.</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.InvalidArgumentException.html#\Zend_Gdata_App_InvalidArgumentException">\Zend_Gdata_App_InvalidArgumentException</a></td><td><em></em></td></tr></table><strong>Details</strong><dl class="function-info"><dt>See</dt><dd>\_minorProtocolVersion + + </dd></dl></div><div class="clear"></div></div><a id="\Zend_Gdata_Docs::setStaticHttpClient()" 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">setStaticHttpClient</span><span class="nb-faded-text">(<a href="../files/Http.Client.html#\Zend_Http_Client">\Zend_Http_Client</a> $httpClient)</span> : void</code><div class="description"><span class="attribute">static</span><span class="attribute">inherited</span><p class="short_description">Set the static HTTP client instance</p><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::setStaticHttpClient()">\Zend_Gdata_App::setStaticHttpClient()</a><a href="../files/Gdata.html#\Zend_Gdata::setStaticHttpClient()">\Zend_Gdata::setStaticHttpClient()</a></small></div><div class="code-tabs"><div class="long-description"><p>Sets the static HTTP client object to use for retrieving the feed.</p></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$httpClient</th><td><a href="../files/Http.Client.html#\Zend_Http_Client">\Zend_Http_Client</a></td><td><em></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Docs::setVerboseExceptionMessages()" 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">setVerboseExceptionMessages</span><span class="nb-faded-text">(boolean $verbose)</span> : void</code><div class="description"><span class="attribute">static</span><span class="attribute">inherited</span><p class="short_description">Set whether to use verbose exception messages</p><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::setVerboseExceptionMessages()">\Zend_Gdata_App::setVerboseExceptionMessages()</a><a href="../files/Gdata.html#\Zend_Gdata::setVerboseExceptionMessages()">\Zend_Gdata::setVerboseExceptionMessages()</a></small></div><div class="code-tabs"><div class="long-description"><p>In the case of HTTP errors, use the body of the HTTP response +in the exception message.</p></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$verbose</th><td>boolean</td><td><em><p>Whether to use verbose exception messages</p></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Docs::updateEntry()" 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">updateEntry</span><span class="nb-faded-text">(mixed $data, string | null $uri = null, string | null $className = null, array $extraHeaders = array())</span> : <a href="../files/Gdata.App.Entry.html#\Zend_Gdata_App_Entry">\Zend_Gdata_App_Entry</a></code><div class="description"><span class="attribute">inherited</span><p class="short_description">Update an entry</p><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::updateEntry()">\Zend_Gdata_App::updateEntry()</a><a href="../files/Gdata.html#\Zend_Gdata::updateEntry()">\Zend_Gdata::updateEntry()</a></small></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>$data</th><td>mixed</td><td><em><p>Zend_Gdata_App_Entry or XML (w/ID and link rel='edit')</p> +</em></td></tr><tr><th>$uri</th><td>string | null</td><td><em><p>The URI to send requests to, or null if $data + contains the URI.</p> +</em></td></tr><tr><th>$className</th><td>string | null</td><td><em><p>The name of the class that should be deserialized + from the server response. If null, then 'Zend_Gdata_App_Entry' + will be used.</p> +</em></td></tr><tr><th>$extraHeaders</th><td>array</td><td><em><p>Extra headers to add to the request, as an + array of string-based key/value pairs.</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.App.Entry.html#\Zend_Gdata_App_Entry">\Zend_Gdata_App_Entry</a></td><td>The entry returned from the server</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_Docs::uploadFile()" 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">uploadFile</span><span class="nb-faded-text">(string $fileLocation, string $title = null, string $mimeType = null, string $uri = null)</span> : <a href="../files/Gdata.Docs.DocumentListEntry.html#\Zend_Gdata_Docs_DocumentListEntry">\Zend_Gdata_Docs_DocumentListEntry</a></code><div class="description"><p class="short_description">Upload a local file to create a new Google Document entry.</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>$fileLocation</th><td>string</td><td><em><p>The full or relative path of the file to + be uploaded.</p></em></td></tr><tr><th>$title</th><td>string</td><td><em><p>The name that this document should have on the + server. If set, the title is used as the slug header in the + POST request. If no title is provided, the location of the + file will be used as the slug header in the request. If no + mimeType is provided, this method attempts to determine the + mime type based on the slugHeader by looking for .doc, + .csv, .txt, etc. at the end of the file name. + Example value: 'test.doc'.</p> +</em></td></tr><tr><th>$mimeType</th><td>string</td><td><em><p>Describes the type of data which is being sent + to the server. This must be one of the accepted mime types + which are enumerated in SUPPORTED_FILETYPES.</p></em></td></tr><tr><th>$uri</th><td>string</td><td><em><p>(optional) The URL to which the upload should be + made. + Example: 'https://docs.google.com/feeds/documents/private/full'.</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.Docs.DocumentListEntry.html#\Zend_Gdata_Docs_DocumentListEntry">\Zend_Gdata_Docs_DocumentListEntry</a></td><td>The entry for the newly + created Google Document.</td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Docs::useObjectMapping()" 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">useObjectMapping</span><span class="nb-faded-text">(boolean $value)</span> : void</code><div class="description"><span class="attribute">inherited</span><p class="short_description">Enable/disable the use of XML to object mapping.</p><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::useObjectMapping()">\Zend_Gdata_App::useObjectMapping()</a><a href="../files/Gdata.html#\Zend_Gdata::useObjectMapping()">\Zend_Gdata::useObjectMapping()</a></small></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>$value</th><td>boolean</td><td><em><p>Pass in true to use the XML to object mapping. + Pass in false or null to disable it.</p></em></td></tr></table></div><div class="clear"></div></div><a id="\Zend_Gdata_Docs::usingObjectMapping()" 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">usingObjectMapping</span><span class="nb-faded-text">()</span> : boolean</code><div class="description"><span class="attribute">inherited</span><p class="short_description">Determine whether service object is using XML to object mapping.</p><small class="inherited_from">Inherited from: + <a href="../files/Gdata.App.html#\Zend_Gdata_App::usingObjectMapping()">\Zend_Gdata_App::usingObjectMapping()</a><a href="../files/Gdata.html#\Zend_Gdata::usingObjectMapping()">\Zend_Gdata::usingObjectMapping()</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>boolean</td><td>True if service object is using XML to object mapping, + false otherwise.</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> |