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

<sect1 id="zend.service.flickr">
    <title>Zend_Service_Flickr</title>
    <sect2 id="zend.service.flickr.introduction">
        <title>Введение</title>
        <para>
            <code>Zend_Service_Flickr</code> является простым API для
            использования веб-вервиса Flickr. Чтобы использовать
            веб-вервисы Flickr, вы должны иметь ключ к API. Для того, чтобы
            получить ключ и больше информации о сервисе Flickr, обратитесь
            к <ulink url="http://www.flickr.com/services/api/">документации по
            API веб-вервиса Flickr</ulink>.
        </para>
        <para>
            В следующем примере мы используем метод <code>tagSearch()</code>
            для поиска фотографий со словом "php" в тегах.
        </para>
        <example>
            <title>Простой поиск фотографий в Flickr</title>
            <programlisting language="php"><![CDATA[<?php
require_once 'Zend/Service/Flickr.php';

$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>
            <code>Zend_Service_Flickr</code> предоставляет несколько
            способов получения информации о пользователях Flickr:
        </para>
        <itemizedlist>
            <listitem>
                <para>
                    <code>userSearch()</code>: Принимает строку запроса,
                    состоящую из разделенных пробелами тегов, массив опций
                    поиска как опциональный второй параметр и возвращает
                    набор фотографий в виде объекта
                    <code>Zend_Service_Flickr_ResultSet</code>.
                </para>
            </listitem>
            <listitem>
                <para>
                    <code>getIdByUsername()</code>: Возвращает ID
                    пользователя, связанного с данным именем.
                </para>
            </listitem>
            <listitem>
                <para>
                    <code>getIdByEmail()</code>: Возвращает ID пользователя,
                    связанного с данным e-mail адресом.
                </para>
            </listitem>
        </itemizedlist>
        <example>
            <title>Поиск открытых фотографий пользователя по адресу e-mail</title>
            <para>
                В этом примере мы, имея e-mail пользователя Flickr, ищем его
                открытые фотографии, используя метод <code>userSearch()</code>:
            </para>
            <programlisting language="php"><![CDATA[<?php
require_once 'Zend/Service/Flickr.php';

$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>
            <code>Zend_Service_Flickr</code> позволяет извлекать фотографии из
            пула группы (group's pool), используя ID группы. Используйте метод
            <code>groupPoolGetPhotos()</code>:
        </para>
        <example id="zend.service.flickr.grouppoolgetphotos.example-1">
            <title>Извлечение фотографий из пула группы через ID группы</title>
            <programlisting language="php"><![CDATA[<?php
    require_once 'Zend/Service/Flickr.php';

    $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>
            <code>Zend_Service_Flickr</code> делает быстрым и легким получение
            данных по изображению через его ID. Просто используйте метод
            <code>getImageDetails()</code>, как показано в следующем примере:
        </para>
        <example>
            <title>Получение данных по изображению в Flickr</title>
            <para>
                Имея ID изображения, легко извлечь информацию об этом
                изображении:
            </para>
            <programlisting language="php"><![CDATA[<?php
require_once 'Zend/Service/Flickr.php';

$flickr = new Zend_Service_Flickr('MY_API_KEY');

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

echo "Image ID $imageId is $image->width x $image->height pixels.<br />\n";
echo "<a href=\"$image->clickUri\">Click for Image</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"><code>Zend_Service_Flickr_ResultSet</code></link>
                    </para>
                </listitem>
                <listitem>
                    <para>
                        <link linkend="zend.service.flickr.classes.result"><code>Zend_Service_Flickr_Result</code></link>
                    </para>
                </listitem>
                <listitem>
                    <para>
                        <link linkend="zend.service.flickr.classes.image"><code>Zend_Service_Flickr_Image</code></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>
                    <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>
                    <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>Фотография доступна потому, что вы являетесь членом семьи владельца.<!--The photo is visible to you because you are family of the owner.--></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>Уменьшенная копия изображения 100x100</entry>
                            </row>
                            <row>
                                <entry>Small</entry>
                                <entry><link linkend="zend.service.flickr.classes.image">Zend_Service_Flickr_Image</link></entry>
                                <entry>Уменьшенная копия изображения 240x240</entry>
                            </row>
                            <row>
                                <entry>Medium</entry>
                                <entry><link linkend="zend.service.flickr.classes.image">Zend_Service_Flickr_Image</link></entry>
                                <entry>Уменьшенная копия изображения 500x500</entry>
                            </row>
                            <row>
                                <entry>Large</entry>
                                <entry><link linkend="zend.service.flickr.classes.image">Zend_Service_Flickr_Image</link></entry>
                                <entry>Уменьшенная копия изображения 640x640</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>
                Представляет изображение, возвращенное в результате поиска.
            </para>
            <sect4 id="zend.service.flickr.classes.image.properties">
                <title>Свойства класса</title>
                <table>
                    <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)</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:
-->