Zend_Service_Yahoo Class Reference

Public Member Functions
	__construct ($appId)
	Sets the application ID and instantiates the REST client.
	inlinkDataSearch ($query, array $options=array())
	Retrieve Inlink Data from siteexplorer.yahoo.com.
	imageSearch ($query, array $options=array())
	Perform a search of images.
	localSearch ($query, array $options=array())
	Perform a search on local.yahoo.com.
	newsSearch ($query, array $options=array())
	Execute a search on news.yahoo.com.
	pageDataSearch ($query, array $options=array())
	Retrieve Page Data from siteexplorer.yahoo.com.
	videoSearch ($query, array $options=array())
	Perform a search of videos.
	webSearch ($query, array $options=array())
	Perform a web content search on search.yahoo.com.
	getRestClient ()
	Returns a reference to the REST client.

Public Attributes
	$appId

Protected Member Functions
	_validateInlinkDataSearch (array $options)
	Validate Inlink Data Search Options.
	_validateImageSearch (array $options)
	Validate Image Search Options.
	_validateLocalSearch (array $options)
	Validate Local Search Options.
	_validateNewsSearch (array $options)
	Validate News Search Options.
	_validatePageDataSearch (array $options)
	Validate Page Data Search Options.
	_validateVideoSearch (array $options)
	Validate Video Search Options.
	_validateWebSearch (array $options)
	Validate Web Search Options.
	_prepareOptions ($query, array $options, array $defaultOptions=array())
	Prepare options for sending to Yahoo!
	_validateLanguage ($lang)
	Throws an exception if the chosen language is not supported.
	_compareOptions (array $options, array $validOptions)
	Utility function to check for a difference between two arrays.
	_validateInArray ($name, $value, array $array)
	Check that a named value is in the given array.

Static Protected Member Functions
static	_checkErrors (DOMDocument $dom)
	Check if response is an error.

Protected Attributes
	$_rest

Constructor & Destructor Documentation

__construct

(

$appId

)

Sets the application ID and instantiates the REST client.

Parameters

string

$appId

specified the developer's appid

Returns

void

See Also

Zend_Rest_Client

Member Function Documentation

static _checkErrors ( DOMDocument  $dom )

staticprotected

Check if response is an error.

Parameters

DOMDocument

$dom

DOM Object representing the result XML

Returns

void

Exceptions

Zend_Service_Exception

Thrown when the result from Yahoo! is an error

See Also

Zend_Service_Exception

_compareOptions ( array  $options, array  $validOptions  )

protected

Utility function to check for a difference between two arrays.

Parameters

array	$options	User specified options
array	$validOptions	Valid options

Returns

void

Exceptions

Zend_Service_Exception

if difference is found (e.g., unsupported query option)

See Also

Zend_Service_Exception

_prepareOptions (   $query, array  $options, array  $defaultOptions = array()  )

protected

Prepare options for sending to Yahoo!

Parameters

string	$query	Search Query
array	$options	User specified options
array	$defaultOptions	Required/Default options

Returns

array

_validateImageSearch ( array  $options )

protected

Validate Image Search Options.

Parameters

array

$options

Returns

void

Exceptions

Zend_Service_Exception

See Also

Zend_Service_Exception

Zend_Validate_Between

Zend_Service_Exception

Zend_Service_Exception

Zend_Service_Exception

Zend_Service_Exception

_validateInArray (   $name,   $value, array  $array  )

protected

Check that a named value is in the given array.

Parameters

string	$name	Name associated with the value
mixed	$value	Value
array	$array	Array in which to check for the value

Returns

void

Exceptions

Zend_Service_Exception

See Also

Zend_Service_Exception

_validateInlinkDataSearch ( array  $options )

protected

Validate Inlink Data Search Options.

Parameters

array

$options

Returns

void

Exceptions

Zend_Service_Exception

See Also

Zend_Validate_Between

Zend_Service_Exception

Zend_Service_Exception

_validateLanguage (   $lang )

protected

Throws an exception if the chosen language is not supported.

Parameters

string

$lang

Language code

Returns

void

Exceptions

Zend_Service_Exception

See Also

Zend_Service_Exception

_validateLocalSearch ( array  $options )

protected

Validate Local Search Options.

Parameters

array

$options

Returns

void

Exceptions

Zend_Service_Exception

See Also

Zend_Validate_Between

Zend_Service_Exception

Zend_Service_Exception

Zend_Service_Exception

Zend_Service_Exception

Zend_Service_Exception

Zend_Service_Exception

Zend_Service_Exception

_validateNewsSearch ( array  $options )

protected

Validate News Search Options.

Parameters

array

$options

Returns

void

Exceptions

Zend_Service_Exception

See Also

Zend_Validate_Between

Zend_Service_Exception

Zend_Service_Exception

_validatePageDataSearch ( array  $options )

protected

Validate Page Data Search Options.

Parameters

array

$options

Returns

void

Exceptions

Zend_Service_Exception

See Also

Zend_Validate_Between

Zend_Service_Exception

Zend_Service_Exception

_validateVideoSearch ( array  $options )

protected

Validate Video Search Options.

Parameters

array

$options

Returns

void

Exceptions

Zend_Service_Exception

See Also

Zend_Validate_Between

Zend_Service_Exception

Zend_Service_Exception

_validateWebSearch ( array  $options )

protected

Validate Web Search Options.

Parameters

array

$options

Returns

void

Exceptions

Zend_Service_Exception

See Also

Zend_Validate_Between

Zend_Service_Exception

Zend_Service_Exception

getRestClient

(

)

Returns a reference to the REST client.

Returns

Zend_Rest_Client

imageSearch	(		$query,
		array	$options = array()
	)

Perform a search of images.

The most basic query consists simply of a plain text search, but you can also specify the type of image, the format, color, etc.

The specific options are: 'type' => (all|any|phrase) How to parse the query terms 'results' => int How many results to return, max is 50 'start' => int The start offset for search results 'format' => (any|bmp|gif|jpeg|png) The type of images to search for 'coloration' => (any|color|bw) The coloration of images to search for 'adult_ok' => bool Flag to allow 'adult' images.

Parameters

string	$query	the query to be run
array	$options	an optional array of query options

Returns

Zend_Service_Yahoo_ImageResultSet the search results

Exceptions

Zend_Service_Exception

See Also

Zend_Service_Exception

Zend_Service_YahooImageResultSet

inlinkDataSearch	(		$query,
		array	$options = array()
	)

Retrieve Inlink Data from siteexplorer.yahoo.com.

A basic query consists simply of a URL. Additional options that can be specified consist of: 'results' => int How many results to return, max is 100 'start' => int The start offset for search results 'entire_site' => bool Data for the whole site or a single page 'omit_inlinks' => (none|domain|subdomain) Filter inlinks from these sources

Parameters

string	$query	the query being run
array	$options	any optional parameters

Returns

Zend_Service_Yahoo_ResultSet The return set

Exceptions

Zend_Service_Exception

See Also

Zend_Service_Exception

Zend_Service_Yahoo_InlinkDataResultSet

localSearch	(		$query,
		array	$options = array()
	)

Perform a search on local.yahoo.com.

The basic search consists of a query and some fragment of location information; for example zipcode, latitude/longitude, or street address.

Query options include: 'results' => int How many results to return, max is 50 'start' => int The start offset for search results 'sort' => (relevance|title|distance|rating) How to order your results

'radius' => float The radius (in miles) in which to search

'longitude' => float The longitude of the location to search around 'latitude' => float The latitude of the location to search around

'zip' => string The zipcode to search around

'street' => string The street address to search around 'city' => string The city for address search 'state' => string The state for address search 'location' => string An adhoc location string to search around

Parameters

string	$query	The query string you want to run
array	$options	The search options, including location

Returns

Zend_Service_Yahoo_LocalResultSet The results

Exceptions

Zend_Service_Exception

See Also

Zend_Service_Exception

Zend_Service_Yahoo_LocalResultSet

newsSearch	(		$query,
		array	$options = array()
	)

Execute a search on news.yahoo.com.

This method minimally takes a text query to search on.

Query options coonsist of:

'results' => int How many results to return, max is 50 'start' => int The start offset for search results 'sort' => (rank|date) How to order your results 'language' => lang The target document language to match 'type' => (all|any|phrase) How the query should be parsed 'site' => string A site to which your search should be restricted

Parameters

string	$query	The query to run
array	$options	The array of optional parameters

Returns

Zend_Service_Yahoo_NewsResultSet The query return set

Exceptions

Zend_Service_Exception

See Also

Zend_Service_Exception

Zend_Service_Yahoo_NewsResultSet

pageDataSearch	(		$query,
		array	$options = array()
	)

Retrieve Page Data from siteexplorer.yahoo.com.

A basic query consists simply of a URL. Additional options that can be specified consist of: 'results' => int How many results to return, max is 100 'start' => int The start offset for search results 'domain_only' => bool Data for just the given domain or all sub-domains also

Parameters

string	$query	the query being run
array	$options	any optional parameters

Returns

Zend_Service_Yahoo_ResultSet The return set

Exceptions

Zend_Service_Exception

See Also

Zend_Service_Exception

Zend_Service_Yahoo_PageDataResultSet

videoSearch	(		$query,
		array	$options = array()
	)

Perform a search of videos.

The most basic query consists simply of a plain text search, but you can also specify the format of video.

The specific options are: 'type' => (all|any|phrase) How to parse the query terms 'results' => int How many results to return, max is 50 'start' => int The start offset for search results 'format' => (any|avi|flash|mpeg|msmedia|quicktime|realmedia) The type of videos to search for 'adult_ok' => bool Flag to allow 'adult' videos.

Parameters

string	$query	the query to be run
array	$options	an optional array of query options

Returns

Zend_Service_Yahoo_VideoResultSet the search results

Exceptions

Zend_Service_Exception

See Also

Zend_Service_Exception

Zend_Service_YahooVideoResultSet

webSearch	(		$query,
		array	$options = array()
	)

Perform a web content search on search.yahoo.com.

A basic query consists simply of a text query. Additional options that can be specified consist of: 'results' => int How many results to return, max is 50 'start' => int The start offset for search results 'language' => lang The target document language to match 'type' => (all|any|phrase) How the query should be parsed 'site' => string A site to which your search should be restricted 'format' => (any|html|msword|pdf|ppt|rss|txt|xls) 'adult_ok' => bool permit 'adult' content in the search results 'similar_ok' => bool permit similar results in the result set 'country' => string The country code for the content searched 'license' => (any|cc_any|cc_commercial|cc_modifiable) The license of content being searched 'region' => The regional search engine on which the service performs the search. default us.

Parameters

string	$query	the query being run
array	$options	any optional parameters

Returns

Zend_Service_Yahoo_WebResultSet The return set

Exceptions

Zend_Service_Exception

See Also

Zend_Service_Exception

Zend_Service_Yahoo_WebResultSet

Member Data Documentation

$_rest

protected

$appId