From 06f945f27840b53e57795dadbc38e76f7e11ab1c Mon Sep 17 00:00:00 2001 From: Horus3 Date: Mon, 24 Feb 2014 16:42:14 +0100 Subject: init --- .../manual/core/en/zend.gdata.docs.html | 266 +++++++++++++++++++++ 1 file changed, 266 insertions(+) create mode 100644 zend/documentation/manual/core/en/zend.gdata.docs.html (limited to 'zend/documentation/manual/core/en/zend.gdata.docs.html') diff --git a/zend/documentation/manual/core/en/zend.gdata.docs.html b/zend/documentation/manual/core/en/zend.gdata.docs.html new file mode 100644 index 0000000..f219a46 --- /dev/null +++ b/zend/documentation/manual/core/en/zend.gdata.docs.html @@ -0,0 +1,266 @@ + + + + + Using Google Documents List Data API - Zend Framework Manual + + + + + + + + +
+ + + + + + + + +
+ Using Google Calendar + +
Zend_Gdata
+ Programmer's Reference Guide
+ 		+ +
+
+

Using Google Documents List Data API

+ + +

+ The Google Documents List Data API allows client applications to + upload documents to Google Documents and list them in the form of + Google Data API ("GData") feeds. Your client application can request + a list of a user's documents, and query the content in an existing + document. +

+ +

+ See » http://code.google.com/apis/documents/overview.html + for more information about the Google Documents List API. +

+ +

Get a List of Documents

+ + +

+ You can get a list of the Google Documents for a particular user by using + the getDocumentListFeed() method of the docs + service. The service will return a + Zend_Gdata_Docs_DocumentListFeed object + containing a list of documents associated with the authenticated + user. +

+ +
  1. $service = Zend_Gdata_Docs::AUTH_SERVICE_NAME;
    2. +
  2. $client = Zend_Gdata_ClientLogin::getHttpClient($user, $pass, $service);
    3. +
  3. $docs = new Zend_Gdata_Docs($client);
    4. +
  4. $feed = $docs->getDocumentListFeed();
+ + +

+ The resulting Zend_Gdata_Docs_DocumentListFeed object + represents the response from the server. This feed contains a list of + Zend_Gdata_Docs_DocumentListEntry objects + ($feed->entries), each of which represents a single + Google Document. +

+
+ +

Upload a Document

+ + +

+ You can create a new Google Document by uploading a word + processing document, spreadsheet, or presentation. This example + is from the interactive Docs.php sample which comes with the + library. It demonstrates uploading a file and printing + information about the result from the server. +

+ +
  1. /**
    2. +
  2. * Upload the specified document
    3. +
  3. *
    4. +
  4. * @param Zend_Gdata_Docs $docs The service object to use for communicating
    5. +
  5. *     with the Google Documents server.
    6. +
  6. * @param boolean $html True if output should be formatted for display in a
    7. +
  7. *     web browser.
    8. +
  8. * @param string $originalFileName The name of the file to be uploaded. The
    9. +
  9. *     MIME type of the file is determined from the extension on this file
    10. +
  10. *     name. For example, test.csv is uploaded as a comma separated volume
    11. +
  11. *     and converted into a spreadsheet.
    12. +
  12. * @param string $temporaryFileLocation (optional) The file in which the
    13. +
  13. *     data for the document is stored. This is used when the file has been
    14. +
  14. *     uploaded from the client's machine to the server and is stored in
    15. +
  15. *     a temporary file which does not have an extension. If this parameter
    16. +
  16. *     is null, the file is read from the originalFileName.
    17. +
  17. */
    18. +
  18. function uploadDocument($docs, $html, $originalFileName,
    19. +
  19.                         $temporaryFileLocation) {
    20. +
  20.   $fileToUpload = $originalFileName;
    21. +
  21.   if ($temporaryFileLocation) {
    22. +
  22.     $fileToUpload = $temporaryFileLocation;
    23. +
  23.   }
    24. +
  24.  
    25. +
  25.   // Upload the file and convert it into a Google Document. The original
    26. +
  26.   // file name is used as the title of the document and the MIME type
    27. +
  27.   // is determined based on the extension on the original file name.
    28. +
  28.   $newDocumentEntry = $docs->uploadFile($fileToUpload, $originalFileName,
    29. +
  29.       null, Zend_Gdata_Docs::DOCUMENTS_LIST_FEED_URI);
    30. +
  30.  
    31. +
  31.   echo "New Document Title: ";
    32. +
  32.  
    33. +
  33.   if ($html) {
    34. +
  34.       // Find the URL of the HTML view of this document.
    35. +
  35.       $alternateLink = '';
    36. +
  36.       foreach ($newDocumentEntry->link as $link) {
    37. +
  37.           if ($link->getRel() === 'alternate') {
    38. +
  38.               $alternateLink = $link->getHref();
    39. +
  39.           }
    40. +
  40.       }
    41. +
  41.       // Make the title link to the document on docs.google.com.
    42. +
  42.       echo "<a href=\"$alternateLink\">\n";
    43. +
  43.   }
    44. +
  44.   echo $newDocumentEntry->title."\n";
    45. +
  45.   if ($html) {echo "</a>\n";}
    46. +
  46. }
+ +
+ +

Searching the documents feed

+ + +

+ You can search the Document List using some of the » standard + Google Data API query parameters. Categories are used to + restrict the + type of document (word processor document, spreadsheet) returned. + The full-text query string is used to search the content of all + the documents. More detailed information on parameters specific + to the Documents List can be found in the » Documents List + Data API Reference Guide. +

+ +

Get a List of Word Processing Documents

+ + +

+ You can also request a feed containing all of your documents of a specific type. For + example, to see a list of your work processing documents, you would perform a + category query as follows. +

+ +
  1. $feed = $docs->getDocumentListFeed(
    2. +
  2.     'http://docs.google.com/feeds/documents/private/full/-/document');
+ +
+ +

Get a List of Spreadsheets

+ + +

+ To request a list of your Google Spreadsheets, use the following category query: +

+ +
  1. $feed = $docs->getDocumentListFeed(
    2. +
  2.     'http://docs.google.com/feeds/documents/private/full/-/spreadsheet');
+ +
+ +

Performing a text query

+ + +

+ You can search the content of documents by using a + Zend_Gdata_Docs_Query in your request. A Query object + can be used to construct the query URI, with the search term + being passed in as a parameter. Here is an example method which queries + the documents list for documents which contain the search string: +

+ +
  1. $docsQuery = new Zend_Gdata_Docs_Query();
    2. +
  2. $docsQuery->setQuery($query);
    3. +
  3. $feed = $client->getDocumentListFeed($docsQuery);
+ +
+
+
+
+ + + + + + + + + +
+ Using Google Calendar + +
Zend_Gdata
+ Programmer's Reference Guide
+ 		+ +
+		 + +
+ + \ No newline at end of file -- cgit v1.2.3