repo_zf1/documentation/manual/ja/module_specs/Zend_Gdata_Docs.xml

<?xml version="1.0" encoding="UTF-8"?>
<!-- Reviewed: no -->
<!-- EN-Revision: 15103 -->
<sect1 id="zend.gdata.docs">
    <title>Google Documents List Data API の使用法</title>

    <para>
        Google Documents List Data API は、
        クライアントアプリケーションから Google Documents
        にドキュメントをアップロードしたり、
        ドキュメントの一覧を Google Data API ("GData")
        形式のフィードで取得したりするためのものです。
        クライアントアプリケーションからユーザのドキュメントの一覧をリクエストしたり、
        ドキュメントの中身を問い合わせたりすることができます。
    </para>

    <para>
        Google Documents List API についての詳細は
        <ulink url="http://code.google.com/apis/documents/overview.html">http://code.google.com/apis/documents/overview.html</ulink>
        を参照ください。
    </para>

    <sect2 id="zend.gdata.docs.listdocuments">
        <title>ドキュメントの一覧の取得</title>
        <para>
            特定のユーザの Google Documents の一覧を取得するには、docs サービスの
            <code>getDocumentListFeed</code> メソッドを使用します。
            このサービスは <classname>Zend_Gdata_Docs_DocumentListFeed</classname>
            オブジェクトを返します。
            その中には、認証済みユーザに関連付けられたドキュメントの一覧が含まれます。
        </para>

        <programlisting role="php"><![CDATA[
$service = Zend_Gdata_Docs::AUTH_SERVICE_NAME;
$client = Zend_Gdata_ClientLogin::getHttpClient($user, $pass, $service);
$docs = new Zend_Gdata_Docs($client);
$feed = $docs->getDocumentListFeed();
]]>
        </programlisting>

        <para>
        結果として得られる <classname>Zend_Gdata_Docs_DocumentListFeed</classname>
        オブジェクトが、サーバからの応答を表します。
        このフィードには <classname>Zend_Gdata_Docs_DocumentListEntry</classname>
        オブジェクトの一覧 (<code>$feed->entries</code>) が含まれ、
        それぞれがひとつの Google Document を表します。
        </para>
    </sect2>

    <sect2 id="zend.gdata.docs.creating">
        <title>ドキュメントのアップロード</title>
        <para>
            新しい Google Document を作成するには、
            ワープロ文書やスプレッドシート、あるいはプレゼンテーションをアップロードします。
            この例はインタラクティブなサンプル Docs.php
            で、これはライブラリに同梱されています。
            これは、ファイルをアップロードした後で、
            サーバからその結果の情報を取得して表示するものです。
        </para>
        <programlisting role="php"><![CDATA[
/**
 * Upload the specified document
 *
 * @param Zend_Gdata_Docs $docs The service object to use for communicating
 *     with the Google Documents server.
 * @param boolean $html True if output should be formatted for display in a
 *     web browser.
 * @param string $originalFileName The name of the file to be uploaded. The
 *     MIME type of the file is determined from the extension on this file
 *     name. For example, test.csv is uploaded as a comma seperated volume
 *     and converted into a spreadsheet.
 * @param string $temporaryFileLocation (optional) The file in which the
 *     data for the document is stored. This is used when the file has been
 *     uploaded from the client's machine to the server and is stored in
 *     a temporary file which does not have an extension. If this parameter
 *     is null, the file is read from the originalFileName.
 */
function uploadDocument($docs, $html, $originalFileName,
                        $temporaryFileLocation) {
  $fileToUpload = $originalFileName;
  if ($temporaryFileLocation) {
    $fileToUpload = $temporaryFileLocation;
  }

  // Upload the file and convert it into a Google Document. The original
  // file name is used as the title of the document and the MIME type
  // is determined based on the extension on the original file name.
  $newDocumentEntry = $docs->uploadFile($fileToUpload, $originalFileName,
      null, Zend_Gdata_Docs::DOCUMENTS_LIST_FEED_URI);

  echo "New Document Title: ";

  if ($html) {
      // Find the URL of the HTML view of this document.
      $alternateLink = '';
      foreach ($newDocumentEntry->link as $link) {
          if ($link->getRel() === 'alternate') {
              $alternateLink = $link->getHref();
          }
      }
      // Make the title link to the document on docs.google.com.
      echo "<a href=\"$alternateLink\">\n";
  }
  echo $newDocumentEntry->title."\n";
  if ($html) {echo "</a>\n";}
}
]]>
        </programlisting>
    </sect2>

    <sect2 id="zend.gdata.docs.queries">
        <title>ドキュメントのフィードの検索</title>
        <para>
            ドキュメントの一覧を検索するには、<ulink
            url="http://code.google.com/apis/gdata/reference.html#Queries">
            標準的な Google Data API クエリパラメータ</ulink> を使用します。
            カテゴリを使用して、ドキュメントの種類 (ワープロ文書、
            スプレッドシート) を絞り込みます。
            フルテキストのクエリ文字列を使用して、ドキュメントの全文検索を行います。
            ドキュメントの一覧に固有のパラメータについての詳細な情報は、 <ulink
            url="http://code.google.com/apis/documents/reference.html#Parameters">
            Documents List Data API リファレンスガイド</ulink>
            を参照ください。
        </para>

        <sect3 id="zend.gdata.docs.listwpdocuments">
            <title>ワープロ文書の一覧の取得</title>
            <para>
                指定した型のすべてのドキュメントを含むフィードを取得することもできます。
                たとえば、ワープロ文書の一覧を取得するには、
                次のようなカテゴリクエリを使用します。
            </para>

            <programlisting role="php"><![CDATA[
$feed = $docs->getDocumentListFeed(
    'http://docs.google.com/feeds/documents/private/full/-/document');]]>
            </programlisting>
        </sect3>

        <sect3 id="zend.gdata.docs.listspreadsheets">
            <title>スプレッドシートの一覧の取得</title>
            <para>
                Google Spreadsheets の一覧を取得するには、
                次のようなカテゴリクエリを使用します。
            </para>

            <programlisting role="php"><![CDATA[
$feed = $docs->getDocumentListFeed(
    'http://docs.google.com/feeds/documents/private/full/-/spreadsheet');]]>
            </programlisting>
        </sect3>

        <sect3 id="zend.gdata.docs.textquery">
            <title>テキストクエリの実行</title>
            <para>
                ドキュメントの中身を検索するには、リクエスト内で
                <classname>Zend_Gdata_Docs_Query</classname> を使用します。
                クエリオブジェクトを使用してクエリ URI を組み立て、
                検索する単語をパラメータとして渡します。
                これは、ある文字列を含むドキュメントを一覧から探すクエリの例です。
            </para>
            <programlisting role="php"><![CDATA[
$docsQuery = new Zend_Gdata_Docs_Query();
$docsQuery->setQuery($query);
$feed = $client->getDocumentListFeed($docsQuery);]]>
            </programlisting>
        </sect3>

    </sect2>

</sect1>