repo_zf1/documentation/manual/pt-br/module_specs/Zend_Service_Flickr.xml

<sect1 id="zend.service.flickr">
  <title>Zend_Service_Flickr</title>

  <sect2 id="zend.service.flickr.introduction">
    <title>Introdução às Pesquisas Flickr</title>

    <para><code>Zend_Service_Flickr</code> é uma simples API para usar o
    Flickr REST Web Service. Para poder usar os Flickr web services, você deve
    possuir uma API key. Para obter uma chave e maiores informações sobre o
    Flickr REST Web Service, visite a <ulink
    url="http://www.flickr.com/services/api/">Flickr API
    Documentation</ulink>.</para>

    <para>No exemplo seguinte, nós usamos o método <code>tagSearch()</code>
    para pesquisar por fotos que tenham o valor "php" nas tags.</para>

    <example>
      <title>Simples pesquisa por fotos Flickr</title>

      <programlisting role="php">&lt;?php
require_once 'Zend/Service/Flickr.php';

$flickr = new Zend_Service_Flickr('MY_API_KEY');

$results = $flickr-&gt;tagSearch("php");

foreach ($results as $result) {
    echo $result-&gt;title . '&lt;br /&gt;';
}
?&gt;       </programlisting>
    </example>

    <note>
      <para><code>tagSearch()</code>
      aceita um array de opções como segundo parâmetro opcional. </para>
    </note>
  </sect2>

  <sect2 id="zend.service.flickr.finding-users">
    <title>Localizando Usuários Flickr</title>

    <para><code>Zend_Service_Flickr</code> fornece três caminhos variados para
    obter informações sobre usuários Flickr:</para>

    <itemizedlist>
      <listitem>
          <para>
              <code>userSearch()</code>
              : Aceita uma string de busca com tags delimitadas por espaços e um array de opções como segundo parâmetro opcional, retornando um objeto
              <code>Zend_Service_Flickr_ResultSet</code>.
          </para>
      </listitem>
      <listitem>
          <para>
              <code>getIdByUsername()</code>
              : Retorna um user ID associado ao nome de usuário informado.
          </para>
      </listitem>
      <listitem>
          <para>
              <code>getIdByEmail()</code>
              : Retorna um user ID associado ao endereço de email informado.
          </para>
      </listitem>
    </itemizedlist>

    <example>
      <title>Localizando um usuário Flickr pelo endereço de E-Mail </title>

      <para>Neste exemplo, nós temos um endereço de email de um usuário do
      Flickr, e usamos o método <code>userSearch()</code> para recuperar
      informações do usuário:</para>

      <programlisting role="php">&lt;?php
require_once 'Zend/Service/Flickr.php';

$flickr = new Zend_Service_Flickr('MY_API_KEY');

$results = $flickr-&gt;userSearch($userEmail);

foreach ($results as $result) {
    echo $result-&gt;title . '&lt;br /&gt;';
}
?&gt;       </programlisting>
    </example>
  </sect2>

  <sect2 id="zend.service.flickr.getimagedetails">


    <title>Recuperando Detalhes de Imagens Flickr Image Details</title>



    <para>
    <code>Zend_Service_Flickr</code>

     torna fácil e rápida a recuperação de detalhes de imagens baseada em um dado "image ID". Basta usar o método

    <code>getImageDetails()</code>

    , como mostrado no exemplo seguinte:
    </para>

    <example>
      <title>Recuperando Flickr Image Details</title>

      <para>Desde que você conheça o Flickr image ID, recuperar informações
      sobre a imagem é tarefa simples:</para>

      <programlisting role="php">&lt;?php
require_once 'Zend/Service/Flickr.php';

$flickr = new Zend_Service_Flickr('MY_API_KEY');

$image = $flickr-&gt;getImageDetails($imageId);

echo "Image ID $imageId is $image-&gt;width x $image-&gt;height pixels.&lt;br /&gt;\n";
echo "&lt;a href=\"$image-&gt;clickUri\"&gt;Click for Image&lt;/a&gt;\n";
?&gt;       </programlisting>
    </example>


  </sect2>

<sect2 id="zend.service.flickr.classes">
  <title>Classes Zend_Service_Flickr</title>

  <para>As seguintes classes são todas retornadas por <code>tagSearch()</code>
  e <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>Representa um conjunto de resultados de uma pesquisa Flickr.</para>

    <note>
      <para>Implemente o <code>SeekableIterator</code> para facilitar a
      iteração (ex: usando <code>foreach</code> ), como também o acesso direto
      a um resultado específico usando <code>seek()</code> .</para>
    </note>

    <sect4 id="zend.service.flickr.classes.resultset.properties">
      <title>Propriedades</title>

      <table>
        <title>Propriedades de Zend_Service_Flickr_ResultSet </title>

        <tgroup cols="3">
          <thead>
            <row>
              <entry>Nome</entry>

              <entry>Tipo</entry>

              <entry>Descrição</entry>
            </row>
          </thead>

          <tbody>
            <row>
              <entry>totalResultsAvailable</entry>

              <entry>int</entry>

              <entry>Total de resultados disponível</entry>
            </row>

            <row>
              <entry>totalResultsReturned</entry>

              <entry>int</entry>

              <entry>Total de resultados retornados </entry>
            </row>

            <row>
              <entry>firstResultPosition</entry>

              <entry>int</entry>

              <entry>O deslocamento deste subconjunto de resultados no
              conjunto de resultados total</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>Retorna o total de resultados deste conjunto de resultados.</para>
      <para>
        <link linkend="zend.service.flickr.classes">Retornar para a Lista de
        Classes </link>
      </para>
    </sect4>
  </sect3>

  <sect3 id="zend.service.flickr.classes.result">
    <title>Zend_Service_Flickr_Result</title>

    <para>Um simples imagem resultante de uma busca Flickr</para>

    <sect4 id="zend.service.flickr.classes.result.properties">
      <title>Propriedades</title>

      <table>
        <title>Propriedades de Zend_Service_Flickr_Result</title>

        <tgroup cols="3">
          <thead>
            <row>
              <entry>Nome</entry>

              <entry>Tipo</entry>

              <entry>Descrição</entry>
            </row>
          </thead>

          <tbody>
            <row>
              <entry>id</entry>

              <entry>int</entry>

              <entry>ID da imagem</entry>
            </row>

            <row>
              <entry>owner</entry>

              <entry>int</entry>

              <entry>NSID do proprietário da imagem.</entry>
            </row>

            <row>
              <entry>secret</entry>

              <entry>string</entry>

              <entry>Uma chave usada na construção da URL.</entry>
            </row>

            <row>
              <entry>server</entry>

              <entry>string</entry>

              <entry>O nome do servidor usado na construção da URL.</entry>
            </row>

            <row>
              <entry>title</entry>

              <entry>string</entry>

              <entry>O título da foto.</entry>
            </row>

            <row>
              <entry>ispublic</entry>

              <entry>boolean</entry>

              <entry>A foto é pública.</entry>
            </row>

            <row>
              <entry>isfriend</entry>

              <entry>boolean</entry>

              <entry>A foto é visível para você porque você é amigo do
              proprietário.</entry>
            </row>

            <row>
              <entry>isfamily</entry>

              <entry>boolean</entry>

              <entry>A foto é visível para você porque você é parente do
              proprietário.</entry>
            </row>

            <row>
              <entry>license</entry>

              <entry>string</entry>

              <entry>Licença sob qual a foto foi publicada.</entry>
            </row>

            <row>
              <entry>date_upload</entry>

              <entry>string</entry>

              <entry>Data em que a foto foi enviada.</entry>
            </row>

            <row>
              <entry>date_taken</entry>

              <entry>string</entry>

              <entry>Data em que a foto foi produzida.</entry>
            </row>

            <row>
              <entry>owner_name</entry>

              <entry>string</entry>

              <entry>O nome de tela do proprietário.</entry>
            </row>

            <row>
              <entry>icon_server</entry>

              <entry>string</entry>

              <entry>O servidor usado na montagem das URLs dos ícones.</entry>
            </row>

            <row>
              <entry>Square</entry>

              <entry>
                <link
                linkend="zend.service.flickr.classes.image">Zend_Service_Flickr_Image</link>
              </entry>

              <entry>Um slide de 75x75 da imagem.</entry>
            </row>

            <row>
              <entry>Thumbnail</entry>

              <entry>
                <link
                linkend="zend.service.flickr.classes.image">Zend_Service_Flickr_Image</link>
              </entry>

              <entry>Um slide de 100 pixels da imagem.</entry>
            </row>

            <row>
              <entry>Small</entry>

              <entry>
                <link
                linkend="zend.service.flickr.classes.image">Zend_Service_Flickr_Image</link>
              </entry>

              <entry>Um slide de 240 pixels da imagem.</entry>
            </row>

            <row>
              <entry>Medium</entry>

              <entry>
                <link
                linkend="zend.service.flickr.classes.image">Zend_Service_Flickr_Image</link>
              </entry>

              <entry>Um slide de 500 pixels da imagem.</entry>
            </row>

            <row>
              <entry>Large</entry>

              <entry>
                <link
                linkend="zend.service.flickr.classes.image">Zend_Service_Flickr_Image</link>
              </entry>

              <entry>Um slide de 640 pixels da imagem.</entry>
            </row>

            <row>
              <entry>Original</entry>

              <entry>
                <link
                linkend="zend.service.flickr.classes.image">Zend_Service_Flickr_Image</link>
              </entry>

              <entry>A imagem original.</entry>
            </row>
          </tbody>
        </tgroup>
      </table>
      <para>
        <link linkend="zend.service.flickr.classes">Retornar para a Lista de
        Classes </link>
      </para>
    </sect4>
  </sect3>

  <sect3 id="zend.service.flickr.classes.image">
    <title>Zend_Service_Flickr_Image</title>

    <para>Representa uma imagem retornada por uma busca Flickr.</para>

    <sect4 id="zend.service.flickr.classes.image.properties">
      <title>Propriedades</title>

      <table>
        <title>Propriedades de Zend_Service_Flickr_Image </title>

        <tgroup cols="3">
          <thead>
            <row>
              <entry>Nome</entry>

              <entry>Tipo</entry>

              <entry>Descrição</entry>
            </row>
          </thead>

          <tbody>
            <row>
              <entry>uri</entry>

              <entry>string</entry>

              <entry>URI para a imagem original </entry>
            </row>

            <row>
              <entry>clickUri</entry>

              <entry>string</entry>

              <entry>URI clicável (ex. a página Flickr) para a imagem</entry>
            </row>

            <row>
              <entry>width</entry>

              <entry>int</entry>

              <entry>Largura da imagem</entry>
            </row>

            <row>
              <entry>height</entry>

              <entry>int</entry>

              <entry>Altura da imagem</entry>
            </row>
          </tbody>
        </tgroup>
      </table>
      <para>
        <link linkend="zend.service.flickr.classes">Retornar para a Lista de
        Classes </link>
      </para>
    </sect4>
  </sect3>
</sect2>
</sect1>
<!--
vim:se ts=4 sw=4 et:
-->