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

<?xml version="1.0" encoding="UTF-8"?>
<!-- Reviewed: no -->
<!-- EN-Revision: 15103 -->
<sect1 id="zend.service.flickr">
    <title>Zend_Service_Flickr</title>
    <sect2 id="zend.service.flickr.introduction">
        <title>導入</title>
        <para>
            <classname>Zend_Service_Flickr</classname> は、Flickr の REST Web Service
            を使用するためのシンプルな API です。
            Flickr ウェブサービスを使用するには API キーが必要です。
            キーを取得したり Flickr REST Web Service の詳細情報を取得したりするには
            <ulink url="http://www.flickr.com/services/api/">Flickr API Documentation</ulink>
            を参照ください。
        </para>
        <para>
            以下の例では、"php" というタグがつけられた写真を
            <code>tagSearch()</code> メソッドを使用して検索します。
        </para>
        <example id="zend.service.flickr.introduction.example-1">
            <title>単純な Flickr 検索</title>
            <programlisting role="php"><![CDATA[
$flickr = new Zend_Service_Flickr('MY_API_KEY');

$results = $flickr->tagSearch("php");

foreach ($results as $result) {
    echo $result->title . '<br />';
}
]]>
            </programlisting>
        </example>
        <note>
            <title>オプションのパラメータ</title>
            <para>
                <code>tagSearch()</code> は、オプションの
                二番目の引数に検索オプションを指定することができます。
            </para>
        </note>
    </sect2>
    <sect2 id="zend.service.flickr.finding-users">
        <title>Flickr ユーザの写真や情報の検索</title>
        <para>
            <classname>Zend_Service_Flickr</classname> では、いくつかの方法で
            Flickr ユーザについての情報を取得することができます。
        </para>
        <itemizedlist>
            <listitem>
                <para>
                    <code>userSearch()</code>:
                    タグをスペースで区切ったクエリ文字列、
                    そしてオプションの二番目のパラメータで検索オプションの配列を指定して検索し、
                    結果の写真を <classname>Zend_Service_Flickr_ResultSet</classname> オブジェクトで返します。
                </para>
            </listitem>
            <listitem>
                <para>
                    <code>getIdByUsername()</code>:
                    指定したユーザ名に対応するユーザ ID を文字列で返します。
                </para>
            </listitem>
            <listitem>
                <para>
                    <code>getIdByEmail()</code>:
                    指定したメールアドレスに対応するユーザ ID を文字列で返します。
                </para>
            </listitem>
        </itemizedlist>
        <example id="zend.service.flickr.finding-users.example-1">
            <title>メールアドレスからの Flickr ユーザの公開している写真の検索</title>
            <para>
                この例では、メールアドレスがわかっている Flickr ユーザが公開している写真を
                <code>userSearch()</code> メソッドを用いて探します。
            </para>
            <programlisting role="php"><![CDATA[
$flickr = new Zend_Service_Flickr('MY_API_KEY');

$results = $flickr->userSearch($userEmail);

foreach ($results as $result) {
    echo $result->title . '<br />';
}
]]>
            </programlisting>
        </example>
    </sect2>
    <sect2 id="zend.service.flickr.grouppoolgetphotos">
        <title>グループプールからの写真の検索</title>
        <para>
            <classname>Zend_Service_Flickr</classname> は、
            グループにプールされている写真をグループ ID を指定して取得することができます。
            <code>groupPoolGetPhotos()</code> メソッドを使用します。
        </para>
        <example id="zend.service.flickr.grouppoolgetphotos.example-1">
            <title>グループ ID を指定し、グループにプールされている写真を取得する</title>
            <programlisting role="php"><![CDATA[
$flickr = new Zend_Service_Flickr('MY_API_KEY');

    $results = $flickr->groupPoolGetPhotos($groupId);

    foreach ($results as $result) {
        echo $result->title . '<br />';
    }
]]>
            </programlisting>
        </example>
        <note>
            <title>オプションのパラメータ</title>
            <para>
                <code>groupPoolGetPhotos()</code> は、オプションの
                二番目の引数に設定の配列を指定することができます。
            </para>
        </note>
    </sect2>
    <sect2 id="zend.service.flickr.getimagedetails">
        <title>Flickr 画像の詳細の取得</title>
        <para>
            <classname>Zend_Service_Flickr</classname> を使用すると、指定した画像 ID
            の画像についての詳細情報をすばやく簡単に取得できます。
            そのためには、以下の例のように単純に
            <code>getImageDetails()</code> メソッドを使用します。
        </para>
        <example id="zend.service.flickr.getimagedetails.example-1">
            <title>Flickr 画像の詳細の取得</title>
            <para>
                Flickr 画像 ID を使用すると、簡単に画像の情報が取得できます。
            </para>
            <programlisting role="php"><![CDATA[
$flickr = new Zend_Service_Flickr('MY_API_KEY');

$image = $flickr->getImageDetails($imageId);

echo "画像 ID $imageId は $image->width x $image->height ピクセルです。<br />\n";
echo "<a href=\"$image->clickUri\">クリックすると画像を表示します</a>\n";
]]>
            </programlisting>
        </example>
    </sect2>
    <sect2 id="zend.service.flickr.classes">
        <title>Zend_Service_Flickr 結果クラス群</title>
        <para>
            <code>tagSearch()</code> あるいは <code>userSearch()</code>
            から返されるのは、以下のクラスのいずれかです。
            <itemizedlist>
                <listitem><para><link linkend="zend.service.flickr.classes.resultset"><classname>Zend_Service_Flickr_ResultSet</classname></link></para></listitem>
                <listitem><para><link linkend="zend.service.flickr.classes.result"><classname>Zend_Service_Flickr_Result</classname></link></para></listitem>
                <listitem><para><link linkend="zend.service.flickr.classes.image"><classname>Zend_Service_Flickr_Image</classname></link></para></listitem>
            </itemizedlist>
        </para>
        <sect3 id="zend.service.flickr.classes.resultset">
            <title>Zend_Service_Flickr_ResultSet</title>
            <para>Flickr 検索からの結果セットを表します。</para>
            <note>
                <para>
                    操作性を高めるため、<code>SeekableIterator</code> インターフェイスを実装しています。
                    これにより、一般的な順次処理 (例えば <code>foreach</code> など)
                    だけでなく <code>seek()</code> を使用した特定の結果への直接アクセスも可能です。
                </para>
            </note>
            <sect4 id="zend.service.flickr.classes.resultset.properties">
                <title>プロパティ</title>
                <table id="zend.service.flickr.classes.resultset.properties.table-1">
                    <title>Zend_Service_Flickr_ResultSet のプロパティ</title>
                    <tgroup cols="3">
                        <thead>
                            <row>
                                <entry>名前</entry>
                                <entry>型</entry>
                                <entry>説明</entry>
                            </row>
                        </thead>
                        <tbody>
                            <row>
                                <entry>totalResultsAvailable</entry>
                                <entry>int</entry>
                                <entry>使用可能な結果の総数</entry>
                            </row>
                            <row>
                                <entry>totalResultsReturned</entry>
                                <entry>int</entry>
                                <entry>返された結果の総数</entry>
                            </row>
                            <row>
                                <entry>firstResultPosition</entry>
                                <entry>int</entry>
                                <entry>すべての結果セットの中でのこの結果セットの位置</entry>
                            </row>
                        </tbody>
                    </tgroup>
                </table>
            </sect4>
            <sect4 id="zend.service.flickr.classes.resultset.totalResults">
                <title>Zend_Service_Flickr_ResultSet::totalResults()</title>
                <para>
                    <methodsynopsis>
                        <type>int</type>
                        <methodname>totalResults</methodname>
                        <void />
                    </methodsynopsis>
                </para>
                <para>
                    この結果セット内の結果の数を返します。
                </para>
                <para>
                    <link linkend="zend.service.flickr.classes">クラス一覧に戻る</link>
                </para>
            </sect4>
        </sect3>
        <sect3 id="zend.service.flickr.classes.result">
            <title>Zend_Service_Flickr_Result</title>
            <para>
                Flickr クエリから返される結果の画像情報を表します。
            </para>
            <sect4 id="zend.service.flickr.classes.result.properties">
                <title>プロパティ</title>
                <table id="zend.service.flickr.classes.result.properties.table-1">
                    <title>Zend_Service_Flickr_Result のプロパティ</title>
                    <tgroup cols="3">
                        <thead>
                            <row>
                                <entry>名前</entry>
                                <entry>型</entry>
                                <entry>説明</entry>
                            </row>
                        </thead>
                        <tbody>
                            <row>
                                <entry>id</entry>
                                <entry>string</entry>
                                <entry>画像 ID</entry>
                            </row>
                            <row>
                                <entry>owner</entry>
                                <entry>string</entry>
                                <entry>画像の所有者の NSID</entry>
                            </row>
                            <row>
                                <entry>secret</entry>
                                <entry>string</entry>
                                <entry>URL の作成に使用されるキー</entry>
                            </row>
                            <row>
                                <entry>server</entry>
                                <entry>string</entry>
                                <entry>URL の作成に使用されるサーバ名</entry>
                            </row>
                            <row>
                                <entry>title</entry>
                                <entry>string</entry>
                                <entry>写真のタイトル</entry>
                            </row>
                            <row>
                                <entry>ispublic</entry>
                                <entry>string</entry>
                                <entry>写真が公開されているかどうか</entry>
                            </row>
                            <row>
                                <entry>isfriend</entry>
                                <entry>string</entry>
                                <entry>画像の所有者の友達であるかどうか</entry>
                            </row>
                            <row>
                                <entry>isfamily</entry>
                                <entry>string</entry>
                                <entry>画像の所有者の家族であるかどうか</entry>
                            </row>
                            <row>
                                <entry>license</entry>
                                <entry>string</entry>
                                <entry>写真についてのライセンス情報</entry>
                            </row>
                            <row>
                                <entry>dateupload</entry>
                                <entry>string</entry>
                                <entry>写真がアップロードされた日付</entry>
                            </row>
                            <row>
                                <entry>datetaken</entry>
                                <entry>string</entry>
                                <entry>写真が撮影された日付</entry>
                            </row>
                            <row>
                                <entry>ownername</entry>
                                <entry>string</entry>
                                <entry>所有者のスクリーンネーム</entry>
                            </row>
                            <row>
                                <entry>iconserver</entry>
                                <entry>string</entry>
                                <entry>アイコンの URL を組み立てるために使用するサーバ</entry>
                            </row>
                            <row>
                                <entry>Square</entry>
                                <entry><link linkend="zend.service.flickr.classes.image">Zend_Service_Flickr_Image</link></entry>
                                <entry>75x75 の、画像のサムネイル</entry>
                            </row>
                            <row>
                                <entry>Thumbnail</entry>
                                <entry><link linkend="zend.service.flickr.classes.image">Zend_Service_Flickr_Image</link></entry>
                                <entry>100 ピクセルの、画像のサムネイル</entry>
                            </row>
                            <row>
                                <entry>Small</entry>
                                <entry><link linkend="zend.service.flickr.classes.image">Zend_Service_Flickr_Image</link></entry>
                                <entry>240 ピクセル版の画像</entry>
                            </row>
                            <row>
                                <entry>Medium</entry>
                                <entry><link linkend="zend.service.flickr.classes.image">Zend_Service_Flickr_Image</link></entry>
                                <entry>500 ピクセル版の画像</entry>
                            </row>
                            <row>
                                <entry>Large</entry>
                                <entry><link linkend="zend.service.flickr.classes.image">Zend_Service_Flickr_Image</link></entry>
                                <entry>640 ピクセル版の画像</entry>
                            </row>
                            <row>
                                <entry>Original</entry>
                                <entry><link linkend="zend.service.flickr.classes.image">Zend_Service_Flickr_Image</link></entry>
                                <entry>元の画像</entry>
                            </row>
                        </tbody>
                    </tgroup>
                </table>
                <para>
                    <link linkend="zend.service.flickr.classes">クラス一覧に戻る</link>
                </para>
            </sect4>
        </sect3>
        <sect3 id="zend.service.flickr.classes.image">
            <title>Zend_Service_Flickr_Image</title>
            <para>Flickr 検索が返す画像を表します。</para>
            <sect4 id="zend.service.flickr.classes.image.properties">
                <title>プロパティ</title>
                <table id="zend.service.flickr.classes.image.properties.table-1">
                    <title>Zend_Service_Flickr_Image のプロパティ</title>
                    <tgroup cols="3">
                        <thead>
                            <row>
                                <entry>名前</entry>
                                <entry>型</entry>
                                <entry>説明</entry>
                            </row>
                        </thead>
                        <tbody>
                            <row>
                                <entry>uri</entry>
                                <entry>string</entry>
                                <entry>元の画像の URI</entry>
                            </row>
                            <row>
                                <entry>clickUri</entry>
                                <entry>string</entry>
                                <entry>もとの画像 (Flickr のページ) へのリンク用 URI</entry>
                            </row>
                            <row>
                                <entry>width</entry>
                                <entry>int</entry>
                                <entry>画像の幅</entry>
                            </row>
                            <row>
                                <entry>height</entry>
                                <entry>int</entry>
                                <entry>画像の高さ</entry>
                            </row>
                        </tbody>
                    </tgroup>
                </table>
                <para>
                    <link linkend="zend.service.flickr.classes">クラス一覧に戻る</link>
                </para>
            </sect4>
        </sect3>
    </sect2>
</sect1>
<!--
vim:se ts=4 sw=4 et:
-->