category Zend
package Zend_Service
subpackage Yahoo
copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license New BSD License

 Methods

Sets the application ID and instantiates the REST client

__construct(string $appId) : void

Parameters

$appId

string

specified the developer's appid

Returns a reference to the REST client

getRestClient() : \Zend_Rest_Client

Returns

\Zend_Rest_Client

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.

imageSearch(string $query, array $options = array()) : \Zend_Service_Yahoo_ImageResultSet

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

$query

string

the query to be run

$options

array

an optional array of query options

Exceptions

\Zend_Service_Exception

Returns

\Zend_Service_Yahoo_ImageResultSetthe search results

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

inlinkDataSearch(string $query, array $options = array()) : \Zend_Service_Yahoo_ResultSet

Parameters

$query

string

the query being run

$options

array

any optional parameters

Exceptions

\Zend_Service_Exception

Returns

\Zend_Service_Yahoo_ResultSetThe return set

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.

localSearch(string $query, array $options = array()) : \Zend_Service_Yahoo_LocalResultSet

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

$query

string

The query string you want to run

$options

array

The search options, including location

Exceptions

\Zend_Service_Exception

Returns

\Zend_Service_Yahoo_LocalResultSetThe results

Execute a search on news.yahoo.com. This method minimally takes a text query to search on.

newsSearch(string $query, array $options = array()) : \Zend_Service_Yahoo_NewsResultSet

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

$query

string

The query to run

$options

array

The array of optional parameters

Exceptions

\Zend_Service_Exception

Returns

\Zend_Service_Yahoo_NewsResultSetThe query return set

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

pageDataSearch(string $query, array $options = array()) : \Zend_Service_Yahoo_ResultSet

Parameters

$query

string

the query being run

$options

array

any optional parameters

Exceptions

\Zend_Service_Exception

Returns

\Zend_Service_Yahoo_ResultSetThe return set

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.

videoSearch(string $query, array $options = array()) : \Zend_Service_Yahoo_VideoResultSet

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

$query

string

the query to be run

$options

array

an optional array of query options

Exceptions

\Zend_Service_Exception

Returns

\Zend_Service_Yahoo_VideoResultSetthe search results

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.

webSearch(string $query, array $options = array()) : \Zend_Service_Yahoo_WebResultSet

Parameters

$query

string

the query being run

$options

array

any optional parameters

Exceptions

\Zend_Service_Exception

Returns

\Zend_Service_Yahoo_WebResultSetThe return set

Check if response is an error

_checkErrors(\DOMDocument $dom) : void
Static

Parameters

$dom

\DOMDocument

DOM Object representing the result XML

Exceptions

\Zend_Service_Exception Thrown when the result from Yahoo! is an error

Utility function to check for a difference between two arrays.

_compareOptions(array $options, array $validOptions) : void

Parameters

$options

array

User specified options

$validOptions

array

Valid options

Exceptions

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

Prepare options for sending to Yahoo!

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

Parameters

$query

string

Search Query

$options

array

User specified options

$defaultOptions

array

Required/Default options

Returns

array

Validate Image Search Options

_validateImageSearch(array $options) : void

Parameters

$options

array

Exceptions

\Zend_Service_Exception

Check that a named value is in the given array

_validateInArray(string $name, mixed $value, array $array) : void

Parameters

$name

string

Name associated with the value

$value

mixed

Value

$array

array

Array in which to check for the value

Exceptions

\Zend_Service_Exception

Validate Inlink Data Search Options

_validateInlinkDataSearch(array $options) : void

Parameters

$options

array

Exceptions

\Zend_Service_Exception

Throws an exception if the chosen language is not supported

_validateLanguage(string $lang) : void

Parameters

$lang

string

Language code

Exceptions

\Zend_Service_Exception

Validate Local Search Options

_validateLocalSearch(array $options) : void

Parameters

$options

array

Exceptions

\Zend_Service_Exception

Validate News Search Options

_validateNewsSearch(array $options) : void

Parameters

$options

array

Exceptions

\Zend_Service_Exception

Validate Page Data Search Options

_validatePageDataSearch(array $options) : void

Parameters

$options

array

Exceptions

\Zend_Service_Exception

Validate Video Search Options

_validateVideoSearch(array $options) : void

Parameters

$options

array

Exceptions

\Zend_Service_Exception

Validate Web Search Options

_validateWebSearch(array $options) : void

Parameters

$options

array

Exceptions

\Zend_Service_Exception

 Properties

 

Yahoo Developer Application ID

$appId : string

Default

 

Reference to the REST client

$_rest : \Zend_Rest_Client

Default