Zend_Service_Yahoo.xml 40 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- Reviewed: no -->
  3. <sect1 id="zend.service.yahoo">
  4. <title>Zend_Service_Yahoo</title>
  5. <sect2 id="zend.service.yahoo.introduction">
  6. <title>Introduction</title>
  7. <para>
  8. <classname>Zend_Service_Yahoo</classname> is a simple <acronym>API</acronym> for using many of the Yahoo! REST <acronym>API</acronym>s.
  9. <classname>Zend_Service_Yahoo</classname> allows you to search Yahoo! Web search, Yahoo! News, Yahoo! Local, Yahoo!
  10. Images. In order to use the Yahoo! REST <acronym>API</acronym>, you must have a Yahoo! Application ID. To obtain an Application ID, please complete and submit the
  11. <ulink url="http://developer.yahoo.com/wsregapp/">Application ID Request Form</ulink>.
  12. </para>
  13. </sect2>
  14. <sect2 id="zend.service.yahoo.websearch">
  15. <title>Searching the Web with Yahoo!</title>
  16. <para>
  17. <classname>Zend_Service_Yahoo</classname> enables you to search the Web with Yahoo! using the
  18. <methodname>webSearch()</methodname> method, which accepts a string query parameter and an optional second parameter
  19. as an array of search options. For full details and an option list, please visit the
  20. <ulink url="http://developer.yahoo.com/search/web/V1/webSearch.html">Yahoo! Web Search
  21. Documentation</ulink>. The <methodname>webSearch()</methodname> method returns a
  22. <classname>Zend_Service_Yahoo_WebResultSet</classname> object.
  23. </para>
  24. <example id="zend.service.yahoo.websearch.example-1">
  25. <title>Searching the Web with Yahoo!</title>
  26. <programlisting language="php"><![CDATA[
  27. $yahoo = new Zend_Service_Yahoo("YAHOO_APPLICATION_ID");
  28. $results = $yahoo->webSearch('PHP');
  29. foreach ($results as $result) {
  30. echo $result->Title .'<br />';
  31. }
  32. ]]></programlisting>
  33. </example>
  34. </sect2>
  35. <sect2 id="zend.service.yahoo.imagesearch">
  36. <title>Finding Images with Yahoo!</title>
  37. <para>
  38. You can search for Images with Yahoo using <classname>Zend_Service_Yahoo</classname>'s <methodname>imageSearch()</methodname>
  39. method. This method accepts a string query parameter and an optional array of search options, as for the
  40. <link linkend="zend.service.yahoo.websearch"><methodname>webSearch()</methodname> method</link>. For full details
  41. and an option list, please visit the
  42. <ulink url="http://developer.yahoo.com/search/image/V1/imageSearch.html">Yahoo! Image Search
  43. Documentation</ulink>.
  44. </para>
  45. <example id="zend.service.yahoo.imagesearch.example-1">
  46. <title>Finding Images with Yahoo!</title>
  47. <programlisting language="php"><![CDATA[
  48. $yahoo = new Zend_Service_Yahoo("YAHOO_APPLICATION_ID");
  49. $results = $yahoo->imageSearch('PHP');
  50. foreach ($results as $result) {
  51. echo $result->Title .'<br />';
  52. }
  53. ]]></programlisting>
  54. </example>
  55. </sect2>
  56. <sect2 id="zend.service.yahoo.videosearch">
  57. <title>Finding videos with Yahoo!</title>
  58. <para>
  59. You can search for videos with Yahoo using <classname>Zend_Service_Yahoo</classname>'s <methodname>videoSearch()</methodname>
  60. method. For full details and an option list, please visit the
  61. <ulink url="http://developer.yahoo.com/search/video/V1/videoSearch.html">Yahoo! Video Search
  62. Documentation</ulink>.
  63. </para>
  64. <example id="zend.service.yahoo.videosearch.example-1">
  65. <title>Finding videos with Yahoo!</title>
  66. <programlisting language="php"><![CDATA[
  67. $yahoo = new Zend_Service_Yahoo("YAHOO_APPLICATION_ID");
  68. $results = $yahoo->videoSearch('PHP');
  69. foreach ($results as $result) {
  70. echo $result->Title .'<br />';
  71. }
  72. ]]></programlisting>
  73. </example>
  74. </sect2>
  75. <sect2 id="zend.service.yahoo.localsearch">
  76. <title>Finding Local Businesses and Services with Yahoo!</title>
  77. <para>
  78. You can search for local businesses and services with Yahoo! by using the <methodname>localSearch()</methodname> method.
  79. For full details, please see the
  80. <ulink url="http://developer.yahoo.com/search/local/V1/localSearch.html">Yahoo! Local Search
  81. Documentation</ulink>.
  82. </para>
  83. <example id="zend.service.yahoo.localsearch.example-1">
  84. <title>Finding Local Businesses and Services with Yahoo!</title>
  85. <programlisting language="php"><![CDATA[
  86. $yahoo = new Zend_Service_Yahoo("YAHOO_APPLICATION_ID");
  87. $results = $yahoo->localSearch('Apple Computers', array('zip' => '95014'));
  88. foreach ($results as $result) {
  89. echo $result->Title .'<br />';
  90. }
  91. ]]></programlisting>
  92. </example>
  93. </sect2>
  94. <sect2 id="zend.service.yahoo.newssearch">
  95. <title>Searching Yahoo! News</title>
  96. <para>
  97. Searching Yahoo! News is simple; just use the <methodname>newsSearch()</methodname> method, as in the following
  98. example. For full details, please see the
  99. <ulink url="http://developer.yahoo.com/search/news/V1/newsSearch.html">Yahoo! News Search
  100. Documentation</ulink>.
  101. </para>
  102. <example id="zend.service.yahoo.newssearch.example-1">
  103. <title>Searching Yahoo! News</title>
  104. <programlisting language="php"><![CDATA[
  105. $yahoo = new Zend_Service_Yahoo("YAHOO_APPLICATION_ID");
  106. $results = $yahoo->newsSearch('PHP');
  107. foreach ($results as $result) {
  108. echo $result->Title .'<br />';
  109. }
  110. ]]></programlisting>
  111. </example>
  112. </sect2>
  113. <sect2 id="zend.service.yahoo.inlinkdatasearch">
  114. <title>Searching Yahoo! Site Explorer Inbound Links</title>
  115. <para>
  116. Searching Yahoo! Site Explorer Inbound Links is simple; just use the <methodname>inlinkDataSearch()</methodname>
  117. method, as in the following example. For full details, please see the
  118. <ulink url="http://developer.yahoo.com/search/siteexplorer/V1/inlinkData.html">Yahoo!
  119. Site Explorer Inbound Links Documentation</ulink>.
  120. </para>
  121. <example id="zend.service.yahoo.inlinkdatasearch.example-1">
  122. <title>Searching Yahoo! Site Explorer Inbound Links</title>
  123. <programlisting language="php"><![CDATA[
  124. $yahoo = new Zend_Service_Yahoo("YAHOO_APPLICATION_ID");
  125. $results = $yahoo->inlinkDataSearch('http://framework.zend.com/');
  126. foreach ($results as $result) {
  127. echo $result->Title .'<br />';
  128. }
  129. ]]></programlisting>
  130. </example>
  131. </sect2>
  132. <sect2 id="zend.service.yahoo.pagedatasearch">
  133. <title>Searching Yahoo! Site Explorer's PageData</title>
  134. <para>
  135. Searching Yahoo! Site Explorer's PageData is simple; just use the <methodname>pageDataSearch()</methodname>
  136. method, as in the following example. For full details, please see the
  137. <ulink url="http://developer.yahoo.com/search/siteexplorer/V1/pageData.html">Yahoo!
  138. Site Explorer PageData Documentation</ulink>.
  139. </para>
  140. <example id="zend.service.yahoo.pagedatasearch.example-1">
  141. <title>Searching Yahoo! Site Explorer's PageData</title>
  142. <programlisting language="php"><![CDATA[
  143. $yahoo = new Zend_Service_Yahoo("YAHOO_APPLICATION_ID");
  144. $results = $yahoo->pageDataSearch('http://framework.zend.com/');
  145. foreach ($results as $result) {
  146. echo $result->Title .'<br />';
  147. }
  148. ]]></programlisting>
  149. </example>
  150. </sect2>
  151. <sect2 id="zend.service.yahoo.classes">
  152. <title>Zend_Service_Yahoo Classes</title>
  153. <para>
  154. The following classes are all returned by the various Yahoo! searches. Each search type
  155. returns a type-specific result set which can be easily iterated, with each result being
  156. contained in a type result object. All result set classes implement the
  157. <classname>SeekableIterator</classname> interface, allowing for easy iteration and
  158. seeking to a specific result.
  159. <itemizedlist>
  160. <listitem><para><link linkend="zend.service.yahoo.classes.resultset"><classname>Zend_Service_Yahoo_ResultSet</classname></link></para></listitem>
  161. <listitem><para><link linkend="zend.service.yahoo.classes.webresultset"><classname>Zend_Service_Yahoo_WebResultSet</classname></link></para></listitem>
  162. <listitem><para><link linkend="zend.service.yahoo.classes.imageresultset"><classname>Zend_Service_Yahoo_ImageResultSet</classname></link></para></listitem>
  163. <listitem><para><link linkend="zend.service.yahoo.classes.videoresultset"><classname>Zend_Service_Yahoo_VideoResultSet</classname></link></para></listitem>
  164. <listitem><para><link linkend="zend.service.yahoo.classes.localresultset"><classname>Zend_Service_Yahoo_LocalResultSet</classname></link></para></listitem>
  165. <listitem><para><link linkend="zend.service.yahoo.classes.newsresultset"><classname>Zend_Service_Yahoo_NewsResultSet</classname></link></para></listitem>
  166. <listitem><para><link linkend="zend.service.yahoo.classes.inlinkdataresultset"><classname>Zend_Service_Yahoo_InlinkDataResultSet</classname></link></para></listitem>
  167. <listitem><para><link linkend="zend.service.yahoo.classes.pagedataresultset"><classname>Zend_Service_Yahoo_PageDataResultSet</classname></link></para></listitem>
  168. <listitem><para><link linkend="zend.service.yahoo.classes.result"><classname>Zend_Service_Yahoo_Result</classname></link></para></listitem>
  169. <listitem><para><link linkend="zend.service.yahoo.classes.webresult"><classname>Zend_Service_Yahoo_WebResult</classname></link></para></listitem>
  170. <listitem><para><link linkend="zend.service.yahoo.classes.imageresult"><classname>Zend_Service_Yahoo_ImageResult</classname></link></para></listitem>
  171. <listitem><para><link linkend="zend.service.yahoo.classes.videoresult"><classname>Zend_Service_Yahoo_VideoResult</classname></link></para></listitem>
  172. <listitem><para><link linkend="zend.service.yahoo.classes.localresult"><classname>Zend_Service_Yahoo_LocalResult</classname></link></para></listitem>
  173. <listitem><para><link linkend="zend.service.yahoo.classes.newsresult"><classname>Zend_Service_Yahoo_NewsResult</classname></link></para></listitem>
  174. <listitem><para><link linkend="zend.service.yahoo.classes.inlinkdataresult"><classname>Zend_Service_Yahoo_InlinkDataResult</classname></link></para></listitem>
  175. <listitem><para><link linkend="zend.service.yahoo.classes.pagedataresult"><classname>Zend_Service_Yahoo_PageDataResult</classname></link></para></listitem>
  176. <listitem><para><link linkend="zend.service.yahoo.classes.image"><classname>Zend_Service_Yahoo_Image</classname></link></para></listitem>
  177. </itemizedlist>
  178. </para>
  179. <sect3 id="zend.service.yahoo.classes.resultset">
  180. <title>Zend_Service_Yahoo_ResultSet</title>
  181. <para>
  182. Each of the search specific result sets is extended from this base class.
  183. </para>
  184. <para>
  185. Each of the specific result sets returns a search specific
  186. <link linkend="zend.service.yahoo.classes.result">Zend_Service_Yahoo_Result</link> objects.
  187. </para>
  188. <sect4 id="zend.service.yahoo.classes.resultset.totalResults">
  189. <title>Zend_Service_Yahoo_ResultSet::totalResults()</title>
  190. <para>
  191. <methodsynopsis>
  192. <type>int</type>
  193. <methodname>totalResults</methodname>
  194. <void />
  195. </methodsynopsis>
  196. </para>
  197. <para>
  198. Returns the number of results returned for the search.
  199. </para>
  200. </sect4>
  201. <sect4 id="zend.service.yahoo.classes.resultset.properties">
  202. <title>Properties</title>
  203. <table id="zend.service.yahoo.classes.resultset.properties.table-1">
  204. <title>Zend_Service_Yahoo_ResultSet</title>
  205. <tgroup cols="3">
  206. <thead>
  207. <row>
  208. <entry>Name</entry>
  209. <entry>Type</entry>
  210. <entry>Description</entry>
  211. </row>
  212. </thead>
  213. <tbody>
  214. <row>
  215. <entry>totalResultsAvailable</entry>
  216. <entry>int</entry>
  217. <entry>
  218. Total number of results found.
  219. </entry>
  220. </row>
  221. <row>
  222. <entry>totalResultsReturned</entry>
  223. <entry>int</entry>
  224. <entry>Number of results in the current result set</entry>
  225. </row>
  226. <row>
  227. <entry>firstResultPosition</entry>
  228. <entry>int</entry>
  229. <entry>Position of the first result in this set relative to the total number of results.</entry>
  230. </row>
  231. </tbody>
  232. </tgroup>
  233. </table>
  234. <para>
  235. <link linkend="zend.service.yahoo.classes">Back to Class List</link>
  236. </para>
  237. </sect4>
  238. </sect3>
  239. <sect3 id="zend.service.yahoo.classes.webresultset">
  240. <title>Zend_Service_Yahoo_WebResultSet</title>
  241. <para>
  242. <classname>Zend_Service_Yahoo_WebResultSet</classname> represents a Yahoo! Web Search result set.
  243. </para>
  244. <note>
  245. <para>
  246. <classname>Zend_Service_Yahoo_WebResultSet</classname> extends <link linkend="zend.service.yahoo.classes.resultset">Zend_Service_Yahoo_ResultSet</link>
  247. </para>
  248. </note>
  249. <para>
  250. <link linkend="zend.service.yahoo.classes">Back to Class List</link>
  251. </para>
  252. </sect3>
  253. <sect3 id="zend.service.yahoo.classes.imageresultset">
  254. <title>Zend_Service_Yahoo_ImageResultSet</title>
  255. <para>
  256. <classname>Zend_Service_Yahoo_ImageResultSet</classname> represents a Yahoo! Image Search result set.
  257. </para>
  258. <note>
  259. <para>
  260. <classname>Zend_Service_Yahoo_ImageResultSet</classname> extends <link linkend="zend.service.yahoo.classes.resultset">Zend_Service_Yahoo_ResultSet</link>
  261. </para>
  262. </note>
  263. <para>
  264. <link linkend="zend.service.yahoo.classes">Back to Class List</link>
  265. </para>
  266. </sect3>
  267. <sect3 id="zend.service.yahoo.classes.videoresultset">
  268. <title>Zend_Service_Yahoo_VideoResultSet</title>
  269. <para>
  270. <classname>Zend_Service_Yahoo_VideoResultSet</classname> represents a Yahoo! Video Search result set.
  271. </para>
  272. <note>
  273. <para>
  274. <classname>Zend_Service_Yahoo_VideoResultSet</classname> extends <link linkend="zend.service.yahoo.classes.resultset">Zend_Service_Yahoo_ResultSet</link>
  275. </para>
  276. </note>
  277. <para>
  278. <link linkend="zend.service.yahoo.classes">Back to Class List</link>
  279. </para>
  280. </sect3>
  281. <sect3 id="zend.service.yahoo.classes.localresultset">
  282. <title>Zend_Service_Yahoo_LocalResultSet</title>
  283. <para>
  284. <classname>Zend_Service_Yahoo_LocalResultSet</classname> represents a Yahoo! Local Search result set.
  285. </para>
  286. <table id="zend.service.yahoo.classes.localresultset.table-1">
  287. <title>Zend_Service_Yahoo_LocalResultSet Properties</title>
  288. <tgroup cols="3">
  289. <thead>
  290. <row>
  291. <entry>Name</entry>
  292. <entry>Type</entry>
  293. <entry>Description</entry>
  294. </row>
  295. </thead>
  296. <tbody>
  297. <row>
  298. <entry>resultSetMapURL</entry>
  299. <entry>string</entry>
  300. <entry>The <acronym>URL</acronym> of a webpage containing a map graphic with all returned results plotted on it.</entry>
  301. </row>
  302. </tbody>
  303. </tgroup>
  304. </table>
  305. <note>
  306. <para>
  307. <classname>Zend_Service_Yahoo_LocalResultSet</classname> extends <link linkend="zend.service.yahoo.classes.resultset">Zend_Service_Yahoo_ResultSet</link>
  308. </para>
  309. </note>
  310. <para>
  311. <link linkend="zend.service.yahoo.classes">Back to Class List</link>
  312. </para>
  313. </sect3>
  314. <sect3 id="zend.service.yahoo.classes.newsresultset">
  315. <title>Zend_Service_Yahoo_NewsResultSet</title>
  316. <para>
  317. <classname>Zend_Service_Yahoo_NewsResultSet</classname> represents a Yahoo! News Search result set.
  318. </para>
  319. <note>
  320. <para>
  321. <classname>Zend_Service_Yahoo_NewsResultSet</classname> extends <link linkend="zend.service.yahoo.classes.resultset">Zend_Service_Yahoo_ResultSet</link>
  322. </para>
  323. </note>
  324. <para>
  325. <link linkend="zend.service.yahoo.classes">Back to Class List</link>
  326. </para>
  327. </sect3>
  328. <sect3 id="zend.service.yahoo.classes.inlinkdataresultset">
  329. <title>Zend_Service_Yahoo_InlinkDataResultSet</title>
  330. <para>
  331. <classname>Zend_Service_Yahoo_InlinkDataResultSet</classname> represents a Yahoo! Inbound Link Search result set.
  332. </para>
  333. <note>
  334. <para>
  335. <classname>Zend_Service_Yahoo_InlinkDataResultSet</classname> extends <link linkend="zend.service.yahoo.classes.resultset">Zend_Service_Yahoo_ResultSet</link>
  336. </para>
  337. </note>
  338. <para>
  339. <link linkend="zend.service.yahoo.classes">Back to Class List</link>
  340. </para>
  341. </sect3>
  342. <sect3 id="zend.service.yahoo.classes.pagedataresultset">
  343. <title>Zend_Service_Yahoo_PageDataResultSet</title>
  344. <para>
  345. <classname>Zend_Service_Yahoo_PageDataResultSet</classname> represents a Yahoo! PageData Search result set.
  346. </para>
  347. <note>
  348. <para>
  349. <classname>Zend_Service_Yahoo_PageDataResultSet</classname> extends <link linkend="zend.service.yahoo.classes.resultset">Zend_Service_Yahoo_ResultSet</link>
  350. </para>
  351. </note>
  352. <para>
  353. <link linkend="zend.service.yahoo.classes">Back to Class List</link>
  354. </para>
  355. </sect3>
  356. <sect3 id="zend.service.yahoo.classes.result">
  357. <title>Zend_Service_Yahoo_Result</title>
  358. <para>
  359. Each of the search specific results is extended from this base class.
  360. </para>
  361. <sect4 id="zend.service.yahoo.classes.result.properties">
  362. <title>Properties</title>
  363. <table id="zend.service.yahoo.classes.result.properties.table-1">
  364. <title>Zend_Service_Yahoo_Result Properties</title>
  365. <tgroup cols="3">
  366. <thead>
  367. <row>
  368. <entry>Name</entry>
  369. <entry>Type</entry>
  370. <entry>Description</entry>
  371. </row>
  372. </thead>
  373. <tbody>
  374. <row>
  375. <entry>Title</entry>
  376. <entry>string</entry>
  377. <entry>Title of the Result item</entry>
  378. </row>
  379. <row>
  380. <entry>Url</entry>
  381. <entry>string</entry>
  382. <entry>The <acronym>URL</acronym> of the result item</entry>
  383. </row>
  384. <row>
  385. <entry>ClickUrl</entry>
  386. <entry>string</entry>
  387. <entry>The <acronym>URL</acronym> for linking to the result item</entry>
  388. </row>
  389. </tbody>
  390. </tgroup>
  391. </table>
  392. <para>
  393. <link linkend="zend.service.yahoo.classes">Back to Class List</link>
  394. </para>
  395. </sect4>
  396. </sect3>
  397. <sect3 id="zend.service.yahoo.classes.webresult">
  398. <title>Zend_Service_Yahoo_WebResult</title>
  399. <para>
  400. Each Web Search result is returned as a <classname>Zend_Service_Yahoo_WebResult</classname> object.
  401. </para>
  402. <sect4 id="zend.service.yahoo.classes.webresult.properties">
  403. <title>Properties</title>
  404. <table id="zend.service.yahoo.classes.webresult.properties.table-1">
  405. <title>Zend_Service_Yahoo_WebResult Properties</title>
  406. <tgroup cols="3">
  407. <thead>
  408. <row>
  409. <entry>Name</entry>
  410. <entry>Type</entry>
  411. <entry>Description</entry>
  412. </row>
  413. </thead>
  414. <tbody>
  415. <row>
  416. <entry>Summary</entry>
  417. <entry>string</entry>
  418. <entry>Result summary</entry>
  419. </row>
  420. <row>
  421. <entry>MimeType</entry>
  422. <entry>string</entry>
  423. <entry>Result <acronym>MIME</acronym> type</entry>
  424. </row>
  425. <row>
  426. <entry>ModificationDate</entry>
  427. <entry>string</entry>
  428. <entry>The last modification date of the result as a <acronym>UNIX</acronym> timestamp.</entry>
  429. </row>
  430. <row>
  431. <entry>CacheUrl</entry>
  432. <entry>string</entry>
  433. <entry>Yahoo! web cache <acronym>URL</acronym> for the result, if it exists.</entry>
  434. </row>
  435. <row>
  436. <entry>CacheSize</entry>
  437. <entry>int</entry>
  438. <entry>The size of the Cache entry</entry>
  439. </row>
  440. </tbody>
  441. </tgroup>
  442. </table>
  443. <para>
  444. <link linkend="zend.service.yahoo.classes">Back to Class List</link>
  445. </para>
  446. </sect4>
  447. </sect3>
  448. <sect3 id="zend.service.yahoo.classes.imageresult">
  449. <title>Zend_Service_Yahoo_ImageResult</title>
  450. <para>
  451. Each Image Search result is returned as a <classname>Zend_Service_Yahoo_ImageResult</classname> object.
  452. </para>
  453. <sect4 id="zend.service.yahoo.classes.imageresult.properties">
  454. <title>Properties</title>
  455. <table id="zend.service.yahoo.classes.imageresult.properties.table-1">
  456. <title>Zend_Service_Yahoo_ImageResult Properties</title>
  457. <tgroup cols="3">
  458. <thead>
  459. <row>
  460. <entry>Name</entry>
  461. <entry>Type</entry>
  462. <entry>Description</entry>
  463. </row>
  464. </thead>
  465. <tbody>
  466. <row>
  467. <entry>Summary</entry>
  468. <entry>string</entry>
  469. <entry>Result summary</entry>
  470. </row>
  471. <row>
  472. <entry>RefererUrl</entry>
  473. <entry>string</entry>
  474. <entry>The <acronym>URL</acronym> of the page which contains the image</entry>
  475. </row>
  476. <row>
  477. <entry>FileSize</entry>
  478. <entry>int</entry>
  479. <entry>The size of the image file in bytes</entry>
  480. </row>
  481. <row>
  482. <entry>FileFormat</entry>
  483. <entry>string</entry>
  484. <entry>The format of the image (bmp, gif, jpeg, png, etc.)</entry>
  485. </row>
  486. <row>
  487. <entry>Height</entry>
  488. <entry>int</entry>
  489. <entry>The height of the image</entry>
  490. </row>
  491. <row>
  492. <entry>Width</entry>
  493. <entry>int</entry>
  494. <entry>The width of the image</entry>
  495. </row>
  496. <row>
  497. <entry>Thumbnail</entry>
  498. <entry><link linkend="zend.service.yahoo.classes.image">Zend_Service_Yahoo_Image</link></entry>
  499. <entry>Image thumbnail</entry>
  500. </row>
  501. </tbody>
  502. </tgroup>
  503. </table>
  504. <para>
  505. <link linkend="zend.service.yahoo.classes">Back to Class List</link>
  506. </para>
  507. </sect4>
  508. </sect3>
  509. <sect3 id="zend.service.yahoo.classes.videoresult">
  510. <title>Zend_Service_Yahoo_VideoResult</title>
  511. <para>
  512. Each Video Search result is returned as a <classname>Zend_Service_Yahoo_VideoResult</classname> object.
  513. </para>
  514. <sect4 id="zend.service.yahoo.classes.videoresult.properties">
  515. <title>Properties</title>
  516. <table id="zend.service.yahoo.classes.videoresult.properties.table-1">
  517. <title>Zend_Service_Yahoo_VideoResult Properties</title>
  518. <tgroup cols="3">
  519. <thead>
  520. <row>
  521. <entry>Name</entry>
  522. <entry>Type</entry>
  523. <entry>Description</entry>
  524. </row>
  525. </thead>
  526. <tbody>
  527. <row>
  528. <entry>Summary</entry>
  529. <entry>string</entry>
  530. <entry>Result summary</entry>
  531. </row>
  532. <row>
  533. <entry>RefererUrl</entry>
  534. <entry>string</entry>
  535. <entry>The <acronym>URL</acronym> of the page which contains the video</entry>
  536. </row>
  537. <row>
  538. <entry>FileSize</entry>
  539. <entry>int</entry>
  540. <entry>The size of the video file in bytes</entry>
  541. </row>
  542. <row>
  543. <entry>FileFormat</entry>
  544. <entry>string</entry>
  545. <entry>The format of the video (avi, flash, mpeg, msmedia, quicktime, realmedia, etc.)</entry>
  546. </row>
  547. <row>
  548. <entry>Height</entry>
  549. <entry>int</entry>
  550. <entry>The height of the video in pixels</entry>
  551. </row>
  552. <row>
  553. <entry>Width</entry>
  554. <entry>int</entry>
  555. <entry>The width of the video in pixels</entry>
  556. </row>
  557. <row>
  558. <entry>Duration</entry>
  559. <entry>int</entry>
  560. <entry>The length of the video in seconds</entry>
  561. </row>
  562. <row>
  563. <entry>Channels</entry>
  564. <entry>int</entry>
  565. <entry>Number of audio channels in the video</entry>
  566. </row>
  567. <row>
  568. <entry>Streaming</entry>
  569. <entry>boolean</entry>
  570. <entry>Whether the video is streaming or not</entry>
  571. </row>
  572. <row>
  573. <entry>Thumbnail</entry>
  574. <entry><link linkend="zend.service.yahoo.classes.image">Zend_Service_Yahoo_Image</link></entry>
  575. <entry>Image thumbnail</entry>
  576. </row>
  577. </tbody>
  578. </tgroup>
  579. </table>
  580. <para>
  581. <link linkend="zend.service.yahoo.classes">Back to Class List</link>
  582. </para>
  583. </sect4>
  584. </sect3>
  585. <sect3 id="zend.service.yahoo.classes.localresult">
  586. <title>Zend_Service_Yahoo_LocalResult</title>
  587. <para>
  588. Each Local Search result is returned as a <classname>Zend_Service_Yahoo_LocalResult</classname> object.
  589. </para>
  590. <sect4 id="zend.service.yahoo.classes.localresult.properties">
  591. <title>Properties</title>
  592. <table id="zend.service.yahoo.classes.localresult.properties.table-1">
  593. <title>Zend_Service_Yahoo_LocalResult Properties</title>
  594. <tgroup cols="3">
  595. <thead>
  596. <row>
  597. <entry>Name</entry>
  598. <entry>Type</entry>
  599. <entry>Description</entry>
  600. </row>
  601. </thead>
  602. <tbody>
  603. <row>
  604. <entry>Address</entry>
  605. <entry>string</entry>
  606. <entry>Street Address of the result</entry>
  607. </row>
  608. <row>
  609. <entry>City</entry>
  610. <entry>string</entry>
  611. <entry>City in which the result resides in</entry>
  612. </row>
  613. <row>
  614. <entry>State</entry>
  615. <entry>string</entry>
  616. <entry>State in which the result resides in</entry>
  617. </row>
  618. <row>
  619. <entry>Phone</entry>
  620. <entry>string</entry>
  621. <entry>Phone number for the result</entry>
  622. </row>
  623. <row>
  624. <entry>Rating</entry>
  625. <entry>int</entry>
  626. <entry>User submitted rating for the result</entry>
  627. </row>
  628. <row>
  629. <entry>Distance</entry>
  630. <entry>float</entry>
  631. <entry>The distance to the result from your specified location</entry>
  632. </row>
  633. <row>
  634. <entry>MapUrl</entry>
  635. <entry>string</entry>
  636. <entry>A <acronym>URL</acronym> of a map for the result</entry>
  637. </row>
  638. <row>
  639. <entry>BusinessUrl</entry>
  640. <entry>string</entry>
  641. <entry>The <acronym>URL</acronym> for the business website, if known</entry>
  642. </row>
  643. <row>
  644. <entry>BusinessClickUrl</entry>
  645. <entry>string</entry>
  646. <entry>The <acronym>URL</acronym> for linking to the business website, if known</entry>
  647. </row>
  648. </tbody>
  649. </tgroup>
  650. </table>
  651. <para>
  652. <link linkend="zend.service.yahoo.classes">Back to Class List</link>
  653. </para>
  654. </sect4>
  655. </sect3>
  656. <sect3 id="zend.service.yahoo.classes.newsresult">
  657. <title>Zend_Service_Yahoo_NewsResult</title>
  658. <para>
  659. Each News Search result is returned as a <classname>Zend_Service_Yahoo_NewsResult</classname> object.
  660. </para>
  661. <sect4 id="zend.service.yahoo.classes.newsresult.properties">
  662. <title>Properties</title>
  663. <table id="zend.service.yahoo.classes.newsresult.properties.table-1">
  664. <title>Zend_Service_Yahoo_NewsResult Properties</title>
  665. <tgroup cols="3">
  666. <thead>
  667. <row>
  668. <entry>Name</entry>
  669. <entry>Type</entry>
  670. <entry>Description</entry>
  671. </row>
  672. </thead>
  673. <tbody>
  674. <row>
  675. <entry>Summary</entry>
  676. <entry>string</entry>
  677. <entry>Result summary</entry>
  678. </row>
  679. <row>
  680. <entry>NewsSource</entry>
  681. <entry>string</entry>
  682. <entry>The company who distributed the article</entry>
  683. </row>
  684. <row>
  685. <entry>NewsSourceUrl</entry>
  686. <entry>string</entry>
  687. <entry>The <acronym>URL</acronym> for the company who distributed the article</entry>
  688. </row>
  689. <row>
  690. <entry>Language</entry>
  691. <entry>string</entry>
  692. <entry>The language the article is in</entry>
  693. </row>
  694. <row>
  695. <entry>PublishDate</entry>
  696. <entry>string</entry>
  697. <entry>The date the article was published as a <acronym>UNIX</acronym> timestamp</entry>
  698. </row>
  699. <row>
  700. <entry>ModificationDate</entry>
  701. <entry>string</entry>
  702. <entry>The date the article was last modified as a <acronym>UNIX</acronym> timestamp</entry>
  703. </row>
  704. <row>
  705. <entry>Thumbnail</entry>
  706. <entry><link linkend="zend.service.yahoo.classes.image">Zend_Service_Yahoo_Image</link></entry>
  707. <entry>Image Thumbnail for the article, if it exists</entry>
  708. </row>
  709. </tbody>
  710. </tgroup>
  711. </table>
  712. <para>
  713. <link linkend="zend.service.yahoo.classes">Back to Class List</link>
  714. </para>
  715. </sect4>
  716. </sect3>
  717. <sect3 id="zend.service.yahoo.classes.inlinkdataresult">
  718. <title>Zend_Service_Yahoo_InlinkDataResult</title>
  719. <para>
  720. Each Inbound Link Search result is returned as a
  721. <classname>Zend_Service_Yahoo_InlinkDatabResult</classname> object.
  722. </para>
  723. <para>
  724. <link linkend="zend.service.yahoo.classes">Back to Class List</link>
  725. </para>
  726. </sect3>
  727. <sect3 id="zend.service.yahoo.classes.pagedataresult">
  728. <title>Zend_Service_Yahoo_PageDataResult</title>
  729. <para>
  730. Each Page Data Search result is returned as a
  731. <classname>Zend_Service_Yahoo_PageDatabResult</classname> object.
  732. </para>
  733. <para>
  734. <link linkend="zend.service.yahoo.classes">Back to Class List</link>
  735. </para>
  736. </sect3>
  737. <sect3 id="zend.service.yahoo.classes.image">
  738. <title>Zend_Service_Yahoo_Image</title>
  739. <para>
  740. All images returned either by the Yahoo! Image Search or the Yahoo! News Search
  741. are represented by <classname>Zend_Service_Yahoo_Image</classname> objects
  742. </para>
  743. <sect4 id="zend.service.yahoo.classes.image.properties">
  744. <title>Properties</title>
  745. <table id="zend.service.yahoo.classes.image.properties.table-1">
  746. <title>Zend_Service_Yahoo_Image Properties</title>
  747. <tgroup cols="3">
  748. <thead>
  749. <row>
  750. <entry>Name</entry>
  751. <entry>Type</entry>
  752. <entry>Description</entry>
  753. </row>
  754. </thead>
  755. <tbody>
  756. <row>
  757. <entry>Url</entry>
  758. <entry>string</entry>
  759. <entry>Image <acronym>URL</acronym></entry>
  760. </row>
  761. <row>
  762. <entry>Width</entry>
  763. <entry>int</entry>
  764. <entry>Image Width</entry>
  765. </row>
  766. <row>
  767. <entry>Height</entry>
  768. <entry>int</entry>
  769. <entry>Image Height</entry>
  770. </row>
  771. </tbody>
  772. </tgroup>
  773. </table>
  774. <para>
  775. <link linkend="zend.service.yahoo.classes">Back to Class List</link>
  776. </para>
  777. </sect4>
  778. </sect3>
  779. </sect2>
  780. </sect1>
  781. <!--
  782. vim:se ts=4 sw=4 et:
  783. -->