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

<?xml version="1.0" encoding="UTF-8"?>
<!-- EN-Revision: 15157 -->
<!-- Reviewed: no -->
<sect1 id="zend.service.flickr">
    <title>Zend_Service_Flickr</title>
    <sect2 id="zend.service.flickr.introduction">
        <title>Einführung</title>
        <para>
            <classname>Zend_Service_Flickr</classname> ist eine einfache API um den Flickr REST Web Service zu nutzen.
            Für die Benutzung des Flickr Web Service, benötigt man einen API Schlüssel.
            Um diesen Schlüssel zu bekommen und für weitergehende Informationen über den Flickr REST Web Service
            besuchen Sie bitte die <ulink url="http://www.flickr.com/services/api/">Flickr API Dokumentation</ulink>.
        </para>
        <para>
            Im folgenden Bespiel benutzen wir die <code>tagSearch()</code> Methode um Photos zu suchen welche
            "php" im Tag haben.
        </para>
        <example id="zend.service.flickr.introduction.example-1">
            <title>Simple Flickr Photo Suche</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>Optionale Parameter</title>
            <para>
                <code>tagSearch()</code> aktepziert als optionalen zweiten Parameter ein Array mit Optionen.
            </para>
        </note>
    </sect2>
    <sect2 id="zend.service.flickr.finding-users">
        <title>Bilder und Informationen von Flickr Benutzern finden</title>
        <para>
            <classname>Zend_Service_Flickr</classname> stellt verschiedene unterschiedliche Wege zur Verfügung um
            Informationen von Flickr Benutzern zu bekommen:
        </para>
        <itemizedlist>
            <listitem>
                <para>
                    <code>userSearch()</code>: Akzeptiert ein String Abfrage von mit Leerzeichen getrennten Tags
                    und als optionalen zweiten Parameter ein Array mit Such Optionen. Zurückgegeben wird ein
                    Set von Photos als <classname>Zend_Service_Flickr_ResultSet</classname> Objekt.
                </para>
            </listitem>
            <listitem>
                <para>
                    <code>getIdByUsername()</code>: Gibt die Benutzer ID als String zurück, welcher mit dem
                    übergebenen String des Benutzernamens verknüpft ist.
                </para>
            </listitem>
            <listitem>
                <para>
                    <code>getIdByEmail()</code>: Gibt die Benutzer ID als String zurück, welcher mit dem übergebenen
                    String der Email Adresse verknüpft ist.
                </para>
            </listitem>
        </itemizedlist>
        <example id="zend.service.flickr.finding-users.example-1">
            <title>Finden von öffentlichen Photos eines Flickr Benutzers durch seine E-Mail Adresse</title>
            <para>
                In diesem Beispiel haben wir die E-Mail adresse eines Flickr Benutzers und wir holen uns die
                öffentlichen Photos eines Benutzer durch Verwendung der <code>userSearch()</code> Methode:
            </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>Photos in einem Gruppenpool finden</title>
        <para>
            <classname>Zend_Service_Flickr</classname> erlaubt es Photos eines Gruppenpools basierend auf der
            ID zu empfangen. Hierfür kann die <code>groupPoolGetPhotos()</code> Methode verwendet
            werden:
        </para>
        <example id="zend.service.flickr.grouppoolgetphotos.example-1">
            <title>Empfangen von Photos aus einem Gruppenpool durch die Gruppen 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>Optionale Parameter</title>
            <para>
                <code>groupPoolGetPhotos()</code> akzeptiert einen optionalen zweiten Parameter als
                ein Array von Optionen.
            </para>
        </note>
    </sect2>
    <sect2 id="zend.service.flickr.getimagedetails">
        <title>Empfangen von Details zu Bildern durch Flickr</title>
        <para>
            <classname>Zend_Service_Flickr</classname> erlaubt es schnell und einfach an Details zu Bilders zu kommen,
            basieren auf einer übergebenen ID des Bildes. Einfach durch benutzen der  <code>getImageDetails()</code> Methode,
            wie im folgenden Beispiel:
        </para>
        <example id="zend.service.flickr.getimagedetails.example-1">
            <title>Empfangen von Details zu Bildern durch Flickr</title>
            <para>
                Sobald man eine Flickr Bild ID hat, ist es eine einfache Angelegenheit, Informationen über
                ein Bild zu bekommen:
            </para>
            <programlisting role="php"><![CDATA[
$flickr = new Zend_Service_Flickr('MY_API_KEY');
$image = $flickr->getImageDetails($imageId);

echo "Bild ID $imageId ist $image->width x $image->height Pixel groß.<br />\n";
echo "<a href=\"$image->clickUri\">Klicken für das Bild</a>\n";
]]></programlisting>
        </example>
    </sect2>
    <sect2 id="zend.service.flickr.classes">
        <title>Zend_Service_Flickr Ergebnis Klassen</title>
        <para>
            Die folgenden Klassen werden durch <code>tagSearch()</code> und <code>userSearch()</code> zurückgegeben:
            <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>Repräsentiert ein Set von Ergebnissen von einer Flickr Suche.</para>
            <note>
                <para>
                    Implementiert das <code>SeekableIterator</code> Interface für einfache Iteration
                    (z.B. benutzen von <code>foreach</code>), sowie einen direkten Zugriff auf ein
                    spezielles Ergebnis durch Benutzen von <code>seek()</code>.
                </para>
            </note>
            <sect4 id="zend.service.flickr.classes.resultset.properties">
                <title>Eigenschaften</title>
                <table id="zend.service.flickr.classes.resultset.properties.table-1">
                    <title>Zend_Service_Flickr_ResultSet Eigenschaften</title>
                    <tgroup cols="3">
                        <thead>
                            <row>
                                <entry>Name</entry>
                                <entry>Typ</entry>
                                <entry>Beschreibung</entry>
                            </row>
                        </thead>
                        <tbody>
                            <row>
                                <entry>totalResultsAvailable</entry>
                                <entry>int</entry>
                                <entry>Gesamt Anzahl aller gefundenen Ergebnisse</entry>
                            </row>
                            <row>
                                <entry>totalResultsReturned</entry>
                                <entry>int</entry>
                                <entry>Gesamt Anzahl der zurückgegebenen Ergebnisse</entry>
                            </row>
                            <row>
                                <entry>firstResultPosition</entry>
                                <entry>int</entry>
                                <entry>Das Offset im Gesamtergebnis für dieses Ergebnis Set</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>
                    Gibt die Gesamt Anzahl der Ergebnisse für dieses Ergebnis Set zurück.
                </para>
                <para>
                    <link linkend="zend.service.flickr.classes">Zurück zur Liste der Klassen</link>
                </para>
            </sect4>
        </sect3>
        <sect3 id="zend.service.flickr.classes.result">
            <title>Zend_Service_Flickr_Result</title>
            <para>
                Ein einzelnes Bild Ergebnis von einer Flickr Suche
            </para>
            <sect4 id="zend.service.flickr.classes.result.properties">
                <title>Eigenschaften</title>
                <table id="zend.service.flickr.classes.result.properties.table-1">
                    <title>Zend_Service_Flickr_Result Eigenschaften</title>
                    <tgroup cols="3">
                        <thead>
                            <row>
                                <entry>Name</entry>
                                <entry>Typ</entry>
                                <entry>Beschreibung</entry>
                            </row>
                        </thead>
                        <tbody>
                            <row>
                                <entry>id</entry>
                                <entry>string</entry>
                                <entry>Image ID</entry>
                            </row>
                            <row>
                                <entry>owner</entry>
                                <entry>string</entry>
                                <entry>Die NSID des Eigentümers des Photos.</entry>
                            </row>
                            <row>
                                <entry>secret</entry>
                                <entry>string</entry>
                                <entry>Ein Schlüssel welcher beim URL Aufbau benutzt wird.</entry>
                            </row>
                            <row>
                                <entry>server</entry>
                                <entry>string</entry>
                                <entry>Der Servername welcher beim URL Aufbau benutzt wird.</entry>
                            </row>
                            <row>
                                <entry>title</entry>
                                <entry>string</entry>
                                <entry>Die Überschrift des Bildes.</entry>
                            </row>
                            <row>
                                <entry>ispublic</entry>
                                <entry>string</entry>
                                <entry>Ist das Bild öffentlich ?</entry>
                            </row>
                            <row>
                                <entry>isfriend</entry>
                                <entry>string</entry>
                                <entry>Das Bild ist sichtbar, weil man ein Freund des Eigentümers ist.</entry>
                            </row>
                            <row>
                                <entry>isfamily</entry>
                                <entry>string</entry>
                                <entry>Das Bild ist sichtbar, weil man Familienmitglied des Eigentümers ist.</entry>
                            </row>
                            <row>
                                <entry>license</entry>
                                <entry>string</entry>
                                <entry>Die Lizenz des Bildes ist erreichbar unter.</entry>
                            </row>
                            <row>
                                <entry>dateupload</entry>
                                <entry>string</entry>
                                <entry>Das Datum an dem das Bild hochgeladen wurde.</entry>
                            </row>
                            <row>
                                <entry>datetaken</entry>
                                <entry>string</entry>
                                <entry>Das Datum an dem das Bild gemacht wurde.</entry>
                            </row>
                            <row>
                                <entry>ownername</entry>
                                <entry>string</entry>
                                <entry>Der Bildschirmname des Eigentümers.</entry>
                            </row>
                            <row>
                                <entry>iconserver</entry>
                                <entry>string</entry>
                                <entry>Der Server welcher benutzt wurde um die Icon URL zu erstellen.</entry>
                            </row>
                            <row>
                                <entry>Square</entry>
                                <entry><link linkend="zend.service.flickr.classes.image">Zend_Service_Flickr_Image</link></entry>
                                <entry>Ein 75x75 Thumbnail des Bildes.</entry>
                            </row>
                            <row>
                                <entry>Thumbnail</entry>
                                <entry><link linkend="zend.service.flickr.classes.image">Zend_Service_Flickr_Image</link></entry>
                                <entry>Ein 100 Pixel Thumbnail des Bildes.</entry>
                            </row>
                            <row>
                                <entry>Small</entry>
                                <entry><link linkend="zend.service.flickr.classes.image">Zend_Service_Flickr_Image</link></entry>
                                <entry>Eine 240 Pixel Version des Bildes.</entry>
                            </row>
                            <row>
                                <entry>Medium</entry>
                                <entry><link linkend="zend.service.flickr.classes.image">Zend_Service_Flickr_Image</link></entry>
                                <entry>Eine 500 Pixel Version des Bildes.</entry>
                            </row>
                            <row>
                                <entry>Large</entry>
                                <entry><link linkend="zend.service.flickr.classes.image">Zend_Service_Flickr_Image</link></entry>
                                <entry>Eine 640 Pixel Version des Bildes.</entry>
                            </row>
                            <row>
                                <entry>Original</entry>
                                <entry><link linkend="zend.service.flickr.classes.image">Zend_Service_Flickr_Image</link></entry>
                                <entry>Das Original Bild.</entry>
                            </row>
                        </tbody>
                    </tgroup>
                </table>
                <para>
                    <link linkend="zend.service.flickr.classes">Zurück zur Liste der Klassen</link>
                </para>
            </sect4>
        </sect3>
        <sect3 id="zend.service.flickr.classes.image">
            <title>Zend_Service_Flickr_Image</title>
            <para>Repräsentiert ein Bild welches durch eine Flickr Suche zurückgegeben wird.</para>
            <sect4 id="zend.service.flickr.classes.image.properties">
                <title>Eigenschaften</title>
                <table id="zend.service.flickr.classes.image.properties.table-1">
                    <title>Zend_Service_Flickr_Image Eigenschaften</title>
                    <tgroup cols="3">
                        <thead>
                            <row>
                                <entry>Name</entry>
                                <entry>Typ</entry>
                                <entry>Beschreibung</entry>
                            </row>
                        </thead>
                        <tbody>
                            <row>
                                <entry>uri</entry>
                                <entry>string</entry>
                                <entry>URI des Original Bildes</entry>
                            </row>
                            <row>
                                <entry>clickUri</entry>
                                <entry>string</entry>
                                <entry>Klickbare URI (z.B. die Flickr Seite) für das Bild</entry>
                            </row>
                            <row>
                                <entry>width</entry>
                                <entry>int</entry>
                                <entry>Breite des Bildes</entry>
                            </row>
                            <row>
                                <entry>height</entry>
                                <entry>int</entry>
                                <entry>Höhe des Bildes</entry>
                            </row>
                        </tbody>
                    </tgroup>
                </table>
                <para>
                    <link linkend="zend.service.flickr.classes">Zurück zur Liste der Klassen</link>
                </para>
            </sect4>
        </sect3>
    </sect2>
</sect1>
<!--
vim:se ts=4 sw=4 et:
-->