Docs For Class Services_Yahoo_Search

Services_Yahoo_AbstractSearch adultContentOK(
)

Set that the results will include adult content

Even if not all searches support this parameter, it is common enough to be part of the abstract base class.

Return: Object which contains the method
Access: public

[ Top ]

Services_Yahoo_AbstractSearch inFormat(
string
$format)

Set the format to search for

The allowed values of the parameter depend on the search type. If unsure, please consult Yahoo's documentation at http://developer.yahoo.net/.

Even if not all searches support this parameter, it is common enough to be part of the abstract base class.

Return: Object which contains the method
Access: public

Parameters:

string $format — Format of search

[ Top ]

object Services_Yahoo_Response searchFor(

$query)

Submits the search

This method submits the search and handles the response. It returns an instance of Services_Yahoo_Result which may be used to further make use of the result.

Return: Search result
Throws: Services_Yahoo_Exception
Access: public

Parameters:

$query —

[ Top ]

Services_Yahoo_AbstractSearch startingAt(
int
$start)

Set the starting result position to return (1-based)

Even if not all searches support this parameter, it is common enough to be part of the abstract base class.

Return: Object which contains the method
Access: public

Parameters:

int $start — Starting position

[ Top ]

Services_Yahoo_AbstractSearch withAppID(
string
$id)

Set Application ID for the search

An Application ID is a string that uniquely identifies your application. Think of it as like a User-Agent string. If you have multiple applications, you should use a different ID for each one. You can register your ID and make sure nobody is already using your ID on Yahoo's Application ID registration page.

The ID defaults to "PEAR_Services_Yahoo", but you are free to change it to whatever you want. Please note that the access to the Yahoo API is not limited via the Application ID but via the IP address of the host where the package is used.

Return: Object which contains the method
Link: http://api.search.yahoo.com/webservices/register_application
Link: http://developer.yahoo.net/documentation/rate.html
Access: public

Parameters:

string $id — Application ID

[ Top ]

Services_Yahoo_AbstractSearch withResults(
int
$count)

Set the number of results to return.

Even if not all searches support this parameter, it is common enough to be part of the abstract base class.

Return: Object which contains the method
Access: public

Parameters:

int $count — Number of results

[ Top ]

Services_Yahoo_AbstractSearch withType(
string
$type)

Set the kind of search to submit

The allowed values of the parameter depend on the search type. If unsure, please consult Yahoo's documentation at http://developer.yahoo.net/.

Even if not all searches support this parameter, it is common enough to be part of the abstract base class.

Return: Object which contains the method
Access: public

Parameters:

string $type — Kind of search

[ Top ]

Class: Services_Yahoo_Search_AbstractSearch

Class Overview

Author(s):

Version:

Copyright:

Variables

Methods

Child classes:

Inherited Variables

Inherited Methods

Class Details

Class Variables

$parameters = array("appid" => "PEAR_Services_Yahoo", "output" => "php")

Method Detail

adultContentOK [line 206]

inFormat [line 190]

Parameters:

searchFor [line 62]

Parameters:

startingAt [line 169]

Parameters:

withAppID [line 110]

Parameters:

withResults [line 148]

Parameters:

withType [line 131]

Parameters: