| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782 |
- <?xml version="1.0" encoding="UTF-8"?>
- <!-- Reviewed: no -->
- <sect1 id="zend.service.yahoo">
- <title>Zend_Service_Yahoo</title>
- <sect2 id="zend.service.yahoo.introduction">
- <title>Introduction</title>
- <para>
- <classname>Zend_Service_Yahoo</classname> is a simple API for using many of the Yahoo! REST APIs.
- <classname>Zend_Service_Yahoo</classname> allows you to search Yahoo! Web search, Yahoo! News, Yahoo! Local, Yahoo!
- Images. In order to use the Yahoo! REST API, you must have a Yahoo! Application ID. To obtain an Application ID, please complete and submit the
- <ulink url="http://developer.yahoo.com/wsregapp/">Application ID Request Form</ulink>.
- </para>
- </sect2>
- <sect2 id="zend.service.yahoo.websearch">
- <title>Searching the Web with Yahoo!</title>
- <para>
- <classname>Zend_Service_Yahoo</classname> enables you to search the Web with Yahoo! using the
- <code>webSearch()</code> method, which accepts a string query parameter and an optional second parameter
- as an array of search options. For full details and an option list, please visit the
- <ulink url="http://developer.yahoo.com/search/web/V1/webSearch.html">Yahoo! Web Search
- Documentation</ulink>. The <code>webSearch()</code> method returns a
- <classname>Zend_Service_Yahoo_WebResultSet</classname> object.
- </para>
- <example id="zend.service.yahoo.websearch.example-1">
- <title>Searching the Web with Yahoo!</title>
- <programlisting language="php"><![CDATA[
- $yahoo = new Zend_Service_Yahoo("YAHOO_APPLICATION_ID");
- $results = $yahoo->webSearch('PHP');
- foreach ($results as $result) {
- echo $result->Title .'<br />';
- }
- ]]></programlisting>
- </example>
- </sect2>
- <sect2 id="zend.service.yahoo.imagesearch">
- <title>Finding Images with Yahoo!</title>
- <para>
- You can search for Images with Yahoo using <classname>Zend_Service_Yahoo</classname>'s <code>imageSearch()</code>
- method. This method accepts a string query parameter and an optional array of search options, as for the
- <link linkend="zend.service.yahoo.websearch"><code>webSearch()</code> method</link>. For full details
- and an option list, please visit the
- <ulink url="http://developer.yahoo.com/search/image/V1/imageSearch.html">Yahoo! Image Search
- Documentation</ulink>.
- </para>
- <example id="zend.service.yahoo.imagesearch.example-1">
- <title>Finding Images with Yahoo!</title>
- <programlisting language="php"><![CDATA[
- $yahoo = new Zend_Service_Yahoo("YAHOO_APPLICATION_ID");
- $results = $yahoo->imageSearch('PHP');
- foreach ($results as $result) {
- echo $result->Title .'<br />';
- }
- ]]></programlisting>
- </example>
- </sect2>
- <sect2 id="zend.service.yahoo.videosearch">
- <title>Finding videos with Yahoo!</title>
- <para>
- You can search for videos with Yahoo using <classname>Zend_Service_Yahoo</classname>'s <code>videoSearch()</code>
- method. For full details and an option list, please visit the
- <ulink url="http://developer.yahoo.com/search/video/V1/videoSearch.html">Yahoo! Video Search
- Documentation</ulink>.
- </para>
- <example id="zend.service.yahoo.videosearch.example-1">
- <title>Finding videos with Yahoo!</title>
- <programlisting language="php"><![CDATA[
- $yahoo = new Zend_Service_Yahoo("YAHOO_APPLICATION_ID");
- $results = $yahoo->videoSearch('PHP');
- foreach ($results as $result) {
- echo $result->Title .'<br />';
- }
- ]]></programlisting>
- </example>
- </sect2>
- <sect2 id="zend.service.yahoo.localsearch">
- <title>Finding Local Businesses and Services with Yahoo!</title>
- <para>
- You can search for local businesses and services with Yahoo! by using the <code>localSearch()</code> method.
- For full details, please see the
- <ulink url="http://developer.yahoo.com/search/local/V1/localSearch.html">Yahoo! Local Search
- Documentation</ulink>.
- </para>
- <example id="zend.service.yahoo.localsearch.example-1">
- <title>Finding Local Businesses and Services with Yahoo!</title>
- <programlisting language="php"><![CDATA[
- $yahoo = new Zend_Service_Yahoo("YAHOO_APPLICATION_ID");
- $results = $yahoo->localSearch('Apple Computers', array('zip' => '95014'));
- foreach ($results as $result) {
- echo $result->Title .'<br />';
- }
- ]]></programlisting>
- </example>
- </sect2>
- <sect2 id="zend.service.yahoo.newssearch">
- <title>Searching Yahoo! News</title>
- <para>
- Searching Yahoo! News is simple; just use the <code>newsSearch()</code> method, as in the following
- example. For full details, please see the
- <ulink url="http://developer.yahoo.com/search/news/V1/newsSearch.html">Yahoo! News Search
- Documentation</ulink>.
- </para>
- <example id="zend.service.yahoo.newssearch.example-1">
- <title>Searching Yahoo! News</title>
- <programlisting language="php"><![CDATA[
- $yahoo = new Zend_Service_Yahoo("YAHOO_APPLICATION_ID");
- $results = $yahoo->newsSearch('PHP');
- foreach ($results as $result) {
- echo $result->Title .'<br />';
- }
- ]]></programlisting>
- </example>
- </sect2>
- <sect2 id="zend.service.yahoo.inlinkdatasearch">
- <title>Searching Yahoo! Site Explorer Inbound Links</title>
- <para>
- Searching Yahoo! Site Explorer Inbound Links is simple; just use the <code>inlinkDataSearch()</code>
- method, as in the following example. For full details, please see the
- <ulink url="http://developer.yahoo.com/search/siteexplorer/V1/inlinkData.html">Yahoo!
- Site Explorer Inbound Links Documentation</ulink>.
- </para>
- <example id="zend.service.yahoo.inlinkdatasearch.example-1">
- <title>Searching Yahoo! Site Explorer Inbound Links</title>
- <programlisting language="php"><![CDATA[
- $yahoo = new Zend_Service_Yahoo("YAHOO_APPLICATION_ID");
- $results = $yahoo->inlinkDataSearch('http://framework.zend.com/');
- foreach ($results as $result) {
- echo $result->Title .'<br />';
- }
- ]]></programlisting>
- </example>
- </sect2>
- <sect2 id="zend.service.yahoo.pagedatasearch">
- <title>Searching Yahoo! Site Explorer's PageData</title>
- <para>
- Searching Yahoo! Site Explorer's PageData is simple; just use the <code>pageDataSearch()</code>
- method, as in the following example. For full details, please see the
- <ulink url="http://developer.yahoo.com/search/siteexplorer/V1/pageData.html">Yahoo!
- Site Explorer PageData Documentation</ulink>.
- </para>
- <example id="zend.service.yahoo.pagedatasearch.example-1">
- <title>Searching Yahoo! Site Explorer's PageData</title>
- <programlisting language="php"><![CDATA[
- $yahoo = new Zend_Service_Yahoo("YAHOO_APPLICATION_ID");
- $results = $yahoo->pageDataSearch('http://framework.zend.com/');
- foreach ($results as $result) {
- echo $result->Title .'<br />';
- }
- ]]></programlisting>
- </example>
- </sect2>
- <sect2 id="zend.service.yahoo.classes">
- <title>Zend_Service_Yahoo Classes</title>
- <para>
- The following classes are all returned by the various Yahoo! searches. Each search type returns a
- type-specific result set which can be easily iterated, with each result being contained in a type result
- object. All result set classes implement the <code>SeekableIterator</code> interface, allowing for easy
- iteration and seeking to a specific result.
- <itemizedlist>
- <listitem><para><link linkend="zend.service.yahoo.classes.resultset"><classname>Zend_Service_Yahoo_ResultSet</classname></link></para></listitem>
- <listitem><para><link linkend="zend.service.yahoo.classes.webresultset"><classname>Zend_Service_Yahoo_WebResultSet</classname></link></para></listitem>
- <listitem><para><link linkend="zend.service.yahoo.classes.imageresultset"><classname>Zend_Service_Yahoo_ImageResultSet</classname></link></para></listitem>
- <listitem><para><link linkend="zend.service.yahoo.classes.videoresultset"><classname>Zend_Service_Yahoo_VideoResultSet</classname></link></para></listitem>
- <listitem><para><link linkend="zend.service.yahoo.classes.localresultset"><classname>Zend_Service_Yahoo_LocalResultSet</classname></link></para></listitem>
- <listitem><para><link linkend="zend.service.yahoo.classes.newsresultset"><classname>Zend_Service_Yahoo_NewsResultSet</classname></link></para></listitem>
- <listitem><para><link linkend="zend.service.yahoo.classes.inlinkdataresultset"><classname>Zend_Service_Yahoo_InlinkDataResultSet</classname></link></para></listitem>
- <listitem><para><link linkend="zend.service.yahoo.classes.pagedataresultset"><classname>Zend_Service_Yahoo_PageDataResultSet</classname></link></para></listitem>
- <listitem><para><link linkend="zend.service.yahoo.classes.result"><classname>Zend_Service_Yahoo_Result</classname></link></para></listitem>
- <listitem><para><link linkend="zend.service.yahoo.classes.webresult"><classname>Zend_Service_Yahoo_WebResult</classname></link></para></listitem>
- <listitem><para><link linkend="zend.service.yahoo.classes.imageresult"><classname>Zend_Service_Yahoo_ImageResult</classname></link></para></listitem>
- <listitem><para><link linkend="zend.service.yahoo.classes.videoresult"><classname>Zend_Service_Yahoo_VideoResult</classname></link></para></listitem>
- <listitem><para><link linkend="zend.service.yahoo.classes.localresult"><classname>Zend_Service_Yahoo_LocalResult</classname></link></para></listitem>
- <listitem><para><link linkend="zend.service.yahoo.classes.newsresult"><classname>Zend_Service_Yahoo_NewsResult</classname></link></para></listitem>
- <listitem><para><link linkend="zend.service.yahoo.classes.inlinkdataresult"><classname>Zend_Service_Yahoo_InlinkDataResult</classname></link></para></listitem>
- <listitem><para><link linkend="zend.service.yahoo.classes.pagedataresult"><classname>Zend_Service_Yahoo_PageDataResult</classname></link></para></listitem>
- <listitem><para><link linkend="zend.service.yahoo.classes.image"><classname>Zend_Service_Yahoo_Image</classname></link></para></listitem>
- </itemizedlist>
- </para>
- <sect3 id="zend.service.yahoo.classes.resultset">
- <title>Zend_Service_Yahoo_ResultSet</title>
- <para>
- Each of the search specific result sets is extended from this base class.
- </para>
- <para>
- Each of the specific result sets returns a search specific
- <link linkend="zend.service.yahoo.classes.result">Zend_Service_Yahoo_Result</link> objects.
- </para>
- <sect4 id="zend.service.yahoo.classes.resultset.totalResults">
- <title>Zend_Service_Yahoo_ResultSet::totalResults()</title>
- <para>
- <methodsynopsis>
- <type>int</type>
- <methodname>totalResults</methodname>
- <void />
- </methodsynopsis>
- </para>
- <para>
- Returns the number of results returned for the search.
- </para>
- </sect4>
- <sect4 id="zend.service.yahoo.classes.resultset.properties">
- <title>Properties</title>
- <table id="zend.service.yahoo.classes.resultset.properties.table-1">
- <title>Zend_Service_Yahoo_ResultSet</title>
- <tgroup cols="3">
- <thead>
- <row>
- <entry>Name</entry>
- <entry>Type</entry>
- <entry>Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>totalResultsAvailable</entry>
- <entry>int</entry>
- <entry>
- Total number of results found.
- </entry>
- </row>
- <row>
- <entry>totalResultsReturned</entry>
- <entry>int</entry>
- <entry>Number of results in the current result set</entry>
- </row>
- <row>
- <entry>firstResultPosition</entry>
- <entry>int</entry>
- <entry>Position of the first result in this set relative to the total number of results.</entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- <para>
- <link linkend="zend.service.yahoo.classes">Back to Class List</link>
- </para>
- </sect4>
- </sect3>
- <sect3 id="zend.service.yahoo.classes.webresultset">
- <title>Zend_Service_Yahoo_WebResultSet</title>
- <para>
- <classname>Zend_Service_Yahoo_WebResultSet</classname> represents a Yahoo! Web Search result set.
- </para>
- <note>
- <para>
- <classname>Zend_Service_Yahoo_WebResultSet</classname> extends <link linkend="zend.service.yahoo.classes.resultset">Zend_Service_Yahoo_ResultSet</link>
- </para>
- </note>
- <para>
- <link linkend="zend.service.yahoo.classes">Back to Class List</link>
- </para>
- </sect3>
- <sect3 id="zend.service.yahoo.classes.imageresultset">
- <title>Zend_Service_Yahoo_ImageResultSet</title>
- <para>
- <classname>Zend_Service_Yahoo_ImageResultSet</classname> represents a Yahoo! Image Search result set.
- </para>
- <note>
- <para>
- <classname>Zend_Service_Yahoo_ImageResultSet</classname> extends <link linkend="zend.service.yahoo.classes.resultset">Zend_Service_Yahoo_ResultSet</link>
- </para>
- </note>
- <para>
- <link linkend="zend.service.yahoo.classes">Back to Class List</link>
- </para>
- </sect3>
- <sect3 id="zend.service.yahoo.classes.videoresultset">
- <title>Zend_Service_Yahoo_VideoResultSet</title>
- <para>
- <classname>Zend_Service_Yahoo_VideoResultSet</classname> represents a Yahoo! Video Search result set.
- </para>
- <note>
- <para>
- <classname>Zend_Service_Yahoo_VideoResultSet</classname> extends <link linkend="zend.service.yahoo.classes.resultset">Zend_Service_Yahoo_ResultSet</link>
- </para>
- </note>
- <para>
- <link linkend="zend.service.yahoo.classes">Back to Class List</link>
- </para>
- </sect3>
- <sect3 id="zend.service.yahoo.classes.localresultset">
- <title>Zend_Service_Yahoo_LocalResultSet</title>
- <para>
- <classname>Zend_Service_Yahoo_LocalResultSet</classname> represents a Yahoo! Local Search result set.
- </para>
- <table id="zend.service.yahoo.classes.localresultset.table-1">
- <title>Zend_Service_Yahoo_LocalResultSet Properties</title>
- <tgroup cols="3">
- <thead>
- <row>
- <entry>Name</entry>
- <entry>Type</entry>
- <entry>Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>resultSetMapURL</entry>
- <entry>string</entry>
- <entry>The URL of a webpage containing a map graphic with all returned results plotted on it.</entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- <note>
- <para>
- <classname>Zend_Service_Yahoo_LocalResultSet</classname> extends <link linkend="zend.service.yahoo.classes.resultset">Zend_Service_Yahoo_ResultSet</link>
- </para>
- </note>
- <para>
- <link linkend="zend.service.yahoo.classes">Back to Class List</link>
- </para>
- </sect3>
- <sect3 id="zend.service.yahoo.classes.newsresultset">
- <title>Zend_Service_Yahoo_NewsResultSet</title>
- <para>
- <classname>Zend_Service_Yahoo_NewsResultSet</classname> represents a Yahoo! News Search result set.
- </para>
- <note>
- <para>
- <classname>Zend_Service_Yahoo_NewsResultSet</classname> extends <link linkend="zend.service.yahoo.classes.resultset">Zend_Service_Yahoo_ResultSet</link>
- </para>
- </note>
- <para>
- <link linkend="zend.service.yahoo.classes">Back to Class List</link>
- </para>
- </sect3>
- <sect3 id="zend.service.yahoo.classes.inlinkdataresultset">
- <title>Zend_Service_Yahoo_InlinkDataResultSet</title>
- <para>
- <classname>Zend_Service_Yahoo_InlinkDataResultSet</classname> represents a Yahoo! Inbound Link Search result set.
- </para>
- <note>
- <para>
- <classname>Zend_Service_Yahoo_InlinkDataResultSet</classname> extends <link linkend="zend.service.yahoo.classes.resultset">Zend_Service_Yahoo_ResultSet</link>
- </para>
- </note>
- <para>
- <link linkend="zend.service.yahoo.classes">Back to Class List</link>
- </para>
- </sect3>
- <sect3 id="zend.service.yahoo.classes.pagedataresultset">
- <title>Zend_Service_Yahoo_PageDataResultSet</title>
- <para>
- <classname>Zend_Service_Yahoo_PageDataResultSet</classname> represents a Yahoo! PageData Search result set.
- </para>
- <note>
- <para>
- <classname>Zend_Service_Yahoo_PageDataResultSet</classname> extends <link linkend="zend.service.yahoo.classes.resultset">Zend_Service_Yahoo_ResultSet</link>
- </para>
- </note>
- <para>
- <link linkend="zend.service.yahoo.classes">Back to Class List</link>
- </para>
- </sect3>
- <sect3 id="zend.service.yahoo.classes.result">
- <title>Zend_Service_Yahoo_Result</title>
- <para>
- Each of the search specific results is extended from this base class.
- </para>
- <sect4 id="zend.service.yahoo.classes.result.properties">
- <title>Properties</title>
- <table id="zend.service.yahoo.classes.result.properties.table-1">
- <title>Zend_Service_Yahoo_Result Properties</title>
- <tgroup cols="3">
- <thead>
- <row>
- <entry>Name</entry>
- <entry>Type</entry>
- <entry>Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>Title</entry>
- <entry>string</entry>
- <entry>Title of the Result item</entry>
- </row>
- <row>
- <entry>Url</entry>
- <entry>string</entry>
- <entry>The URL of the result item</entry>
- </row>
- <row>
- <entry>ClickUrl</entry>
- <entry>string</entry>
- <entry>The URL for linking to the result item</entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- <para>
- <link linkend="zend.service.yahoo.classes">Back to Class List</link>
- </para>
- </sect4>
- </sect3>
- <sect3 id="zend.service.yahoo.classes.webresult">
- <title>Zend_Service_Yahoo_WebResult</title>
- <para>
- Each Web Search result is returned as a <classname>Zend_Service_Yahoo_WebResult</classname> object.
- </para>
- <sect4 id="zend.service.yahoo.classes.webresult.properties">
- <title>Properties</title>
- <table id="zend.service.yahoo.classes.webresult.properties.table-1">
- <title>Zend_Service_Yahoo_WebResult Properties</title>
- <tgroup cols="3">
- <thead>
- <row>
- <entry>Name</entry>
- <entry>Type</entry>
- <entry>Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>Summary</entry>
- <entry>string</entry>
- <entry>Result summary</entry>
- </row>
- <row>
- <entry>MimeType</entry>
- <entry>string</entry>
- <entry>Result MIME type</entry>
- </row>
- <row>
- <entry>ModificationDate</entry>
- <entry>string</entry>
- <entry>The last modification date of the result as a UNIX timestamp.</entry>
- </row>
- <row>
- <entry>CacheUrl</entry>
- <entry>string</entry>
- <entry>Yahoo! web cache URL for the result, if it exists.</entry>
- </row>
- <row>
- <entry>CacheSize</entry>
- <entry>int</entry>
- <entry>The size of the Cache entry</entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- <para>
- <link linkend="zend.service.yahoo.classes">Back to Class List</link>
- </para>
- </sect4>
- </sect3>
- <sect3 id="zend.service.yahoo.classes.imageresult">
- <title>Zend_Service_Yahoo_ImageResult</title>
- <para>
- Each Image Search result is returned as a <classname>Zend_Service_Yahoo_ImageResult</classname> object.
- </para>
- <sect4 id="zend.service.yahoo.classes.imageresult.properties">
- <title>Properties</title>
- <table id="zend.service.yahoo.classes.imageresult.properties.table-1">
- <title>Zend_Service_Yahoo_ImageResult Properties</title>
- <tgroup cols="3">
- <thead>
- <row>
- <entry>Name</entry>
- <entry>Type</entry>
- <entry>Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>Summary</entry>
- <entry>string</entry>
- <entry>Result summary</entry>
- </row>
- <row>
- <entry>RefererUrl</entry>
- <entry>string</entry>
- <entry>The URL of the page which contains the image</entry>
- </row>
- <row>
- <entry>FileSize</entry>
- <entry>int</entry>
- <entry>The size of the image file in bytes</entry>
- </row>
- <row>
- <entry>FileFormat</entry>
- <entry>string</entry>
- <entry>The format of the image (bmp, gif, jpeg, png, etc.)</entry>
- </row>
- <row>
- <entry>Height</entry>
- <entry>int</entry>
- <entry>The height of the image</entry>
- </row>
- <row>
- <entry>Width</entry>
- <entry>int</entry>
- <entry>The width of the image</entry>
- </row>
- <row>
- <entry>Thumbnail</entry>
- <entry><link linkend="zend.service.yahoo.classes.image">Zend_Service_Yahoo_Image</link></entry>
- <entry>Image thumbnail</entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- <para>
- <link linkend="zend.service.yahoo.classes">Back to Class List</link>
- </para>
- </sect4>
- </sect3>
- <sect3 id="zend.service.yahoo.classes.videoresult">
- <title>Zend_Service_Yahoo_VideoResult</title>
- <para>
- Each Video Search result is returned as a <classname>Zend_Service_Yahoo_VideoResult</classname> object.
- </para>
- <sect4 id="zend.service.yahoo.classes.videoresult.properties">
- <title>Properties</title>
- <table id="zend.service.yahoo.classes.videoresult.properties.table-1">
- <title>Zend_Service_Yahoo_VideoResult Properties</title>
- <tgroup cols="3">
- <thead>
- <row>
- <entry>Name</entry>
- <entry>Type</entry>
- <entry>Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>Summary</entry>
- <entry>string</entry>
- <entry>Result summary</entry>
- </row>
- <row>
- <entry>RefererUrl</entry>
- <entry>string</entry>
- <entry>The URL of the page which contains the video</entry>
- </row>
- <row>
- <entry>FileSize</entry>
- <entry>int</entry>
- <entry>The size of the video file in bytes</entry>
- </row>
- <row>
- <entry>FileFormat</entry>
- <entry>string</entry>
- <entry>The format of the video (avi, flash, mpeg, msmedia, quicktime, realmedia, etc.)</entry>
- </row>
- <row>
- <entry>Height</entry>
- <entry>int</entry>
- <entry>The height of the video in pixels</entry>
- </row>
- <row>
- <entry>Width</entry>
- <entry>int</entry>
- <entry>The width of the video in pixels</entry>
- </row>
- <row>
- <entry>Duration</entry>
- <entry>int</entry>
- <entry>The length of the video in seconds</entry>
- </row>
- <row>
- <entry>Channels</entry>
- <entry>int</entry>
- <entry>Number of audio channels in the video</entry>
- </row>
- <row>
- <entry>Streaming</entry>
- <entry>boolean</entry>
- <entry>Whether the video is streaming or not</entry>
- </row>
- <row>
- <entry>Thumbnail</entry>
- <entry><link linkend="zend.service.yahoo.classes.image">Zend_Service_Yahoo_Image</link></entry>
- <entry>Image thumbnail</entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- <para>
- <link linkend="zend.service.yahoo.classes">Back to Class List</link>
- </para>
- </sect4>
- </sect3>
- <sect3 id="zend.service.yahoo.classes.localresult">
- <title>Zend_Service_Yahoo_LocalResult</title>
- <para>
- Each Local Search result is returned as a <classname>Zend_Service_Yahoo_LocalResult</classname> object.
- </para>
- <sect4 id="zend.service.yahoo.classes.localresult.properties">
- <title>Properties</title>
- <table id="zend.service.yahoo.classes.localresult.properties.table-1">
- <title>Zend_Service_Yahoo_LocalResult Properties</title>
- <tgroup cols="3">
- <thead>
- <row>
- <entry>Name</entry>
- <entry>Type</entry>
- <entry>Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>Address</entry>
- <entry>string</entry>
- <entry>Street Address of the result</entry>
- </row>
- <row>
- <entry>City</entry>
- <entry>string</entry>
- <entry>City in which the result resides in</entry>
- </row>
- <row>
- <entry>State</entry>
- <entry>string</entry>
- <entry>State in which the result resides in</entry>
- </row>
- <row>
- <entry>Phone</entry>
- <entry>string</entry>
- <entry>Phone number for the result</entry>
- </row>
- <row>
- <entry>Rating</entry>
- <entry>int</entry>
- <entry>User submitted rating for the result</entry>
- </row>
- <row>
- <entry>Distance</entry>
- <entry>float</entry>
- <entry>The distance to the result from your specified location</entry>
- </row>
- <row>
- <entry>MapUrl</entry>
- <entry>string</entry>
- <entry>A URL of a map for the result</entry>
- </row>
- <row>
- <entry>BusinessUrl</entry>
- <entry>string</entry>
- <entry>The URL for the business website, if known</entry>
- </row>
- <row>
- <entry>BusinessClickUrl</entry>
- <entry>string</entry>
- <entry>The URL for linking to the business website, if known</entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- <para>
- <link linkend="zend.service.yahoo.classes">Back to Class List</link>
- </para>
- </sect4>
- </sect3>
- <sect3 id="zend.service.yahoo.classes.newsresult">
- <title>Zend_Service_Yahoo_NewsResult</title>
- <para>
- Each News Search result is returned as a <classname>Zend_Service_Yahoo_NewsResult</classname> object.
- </para>
- <sect4 id="zend.service.yahoo.classes.newsresult.properties">
- <title>Properties</title>
- <table id="zend.service.yahoo.classes.newsresult.properties.table-1">
- <title>Zend_Service_Yahoo_NewsResult Properties</title>
- <tgroup cols="3">
- <thead>
- <row>
- <entry>Name</entry>
- <entry>Type</entry>
- <entry>Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>Summary</entry>
- <entry>string</entry>
- <entry>Result summary</entry>
- </row>
- <row>
- <entry>NewsSource</entry>
- <entry>string</entry>
- <entry>The company who distributed the article</entry>
- </row>
- <row>
- <entry>NewsSourceUrl</entry>
- <entry>string</entry>
- <entry>The URL for the company who distributed the article</entry>
- </row>
- <row>
- <entry>Language</entry>
- <entry>string</entry>
- <entry>The language the article is in</entry>
- </row>
- <row>
- <entry>PublishDate</entry>
- <entry>string</entry>
- <entry>The date the article was published as a UNIX timestamp</entry>
- </row>
- <row>
- <entry>ModificationDate</entry>
- <entry>string</entry>
- <entry>The date the article was last modified as a UNIX timestamp</entry>
- </row>
- <row>
- <entry>Thumbnail</entry>
- <entry><link linkend="zend.service.yahoo.classes.image">Zend_Service_Yahoo_Image</link></entry>
- <entry>Image Thumbnail for the article, if it exists</entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- <para>
- <link linkend="zend.service.yahoo.classes">Back to Class List</link>
- </para>
- </sect4>
- </sect3>
- <sect3 id="zend.service.yahoo.classes.inlinkdataresult">
- <title>Zend_Service_Yahoo_InlinkDataResult</title>
- <para>
- Each Inbound Link Search result is returned as a
- <classname>Zend_Service_Yahoo_InlinkDatabResult</classname> object.
- </para>
- <para>
- <link linkend="zend.service.yahoo.classes">Back to Class List</link>
- </para>
- </sect3>
- <sect3 id="zend.service.yahoo.classes.pagedataresult">
- <title>Zend_Service_Yahoo_PageDataResult</title>
- <para>
- Each Page Data Search result is returned as a
- <classname>Zend_Service_Yahoo_PageDatabResult</classname> object.
- </para>
- <para>
- <link linkend="zend.service.yahoo.classes">Back to Class List</link>
- </para>
- </sect3>
- <sect3 id="zend.service.yahoo.classes.image">
- <title>Zend_Service_Yahoo_Image</title>
- <para>
- All images returned either by the Yahoo! Image Search or the Yahoo! News Search
- are represented by <classname>Zend_Service_Yahoo_Image</classname> objects
- </para>
- <sect4 id="zend.service.yahoo.classes.image.properties">
- <title>Properties</title>
- <table id="zend.service.yahoo.classes.image.properties.table-1">
- <title>Zend_Service_Yahoo_Image Properties</title>
- <tgroup cols="3">
- <thead>
- <row>
- <entry>Name</entry>
- <entry>Type</entry>
- <entry>Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>Url</entry>
- <entry>string</entry>
- <entry>Image URL</entry>
- </row>
- <row>
- <entry>Width</entry>
- <entry>int</entry>
- <entry>Image Width</entry>
- </row>
- <row>
- <entry>Height</entry>
- <entry>int</entry>
- <entry>Image Height</entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- <para>
- <link linkend="zend.service.yahoo.classes">Back to Class List</link>
- </para>
- </sect4>
- </sect3>
- </sect2>
- </sect1>
- <!--
- vim:se ts=4 sw=4 et:
- -->
|