category | Zend |
---|---|
package | Zend_Service |
subpackage | Yahoo |
copyright | Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com) |
license | New BSD License |
__construct(string $appId) : void
string
specified the developer's appid
getRestClient() : \Zend_Rest_Client
\Zend_Rest_Client
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.
string
the query to be run
array
an optional array of query options
\Zend_Service_Exception |
---|
\Zend_Service_Yahoo_ImageResultSet
the search resultsinlinkDataSearch(string $query, array $options = array()
) : \Zend_Service_Yahoo_ResultSet
string
the query being run
array
any optional parameters
\Zend_Service_Exception |
---|
\Zend_Service_Yahoo_ResultSet
The return setlocalSearch(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
string
The query string you want to run
array
The search options, including location
\Zend_Service_Exception |
---|
\Zend_Service_Yahoo_LocalResultSet
The resultsnewsSearch(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
string
The query to run
array
The array of optional parameters
\Zend_Service_Exception |
---|
\Zend_Service_Yahoo_NewsResultSet
The query return setpageDataSearch(string $query, array $options = array()
) : \Zend_Service_Yahoo_ResultSet
string
the query being run
array
any optional parameters
\Zend_Service_Exception |
---|
\Zend_Service_Yahoo_ResultSet
The return setvideoSearch(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.
string
the query to be run
array
an optional array of query options
\Zend_Service_Exception |
---|
\Zend_Service_Yahoo_VideoResultSet
the search resultswebSearch(string $query, array $options = array()
) : \Zend_Service_Yahoo_WebResultSet
string
the query being run
array
any optional parameters
\Zend_Service_Exception |
---|
\Zend_Service_Yahoo_WebResultSet
The return set_checkErrors(\DOMDocument $dom) : void
\DOMDocument
DOM Object representing the result XML
\Zend_Service_Exception |
Thrown when the result from Yahoo! is an error |
---|
_compareOptions(array $options, array $validOptions) : void
array
User specified options
array
Valid options
\Zend_Service_Exception |
if difference is found (e.g., unsupported query option) |
---|
_prepareOptions(string $query, array $options, array $defaultOptions = array()
) : array
string
Search Query
array
User specified options
array
Required/Default options
array
_validateImageSearch(array $options) : void
array
\Zend_Service_Exception |
---|
_validateInArray(string $name, mixed $value, array $array) : void
string
Name associated with the value
mixed
Value
array
Array in which to check for the value
\Zend_Service_Exception |
---|
_validateInlinkDataSearch(array $options) : void
array
\Zend_Service_Exception |
---|
_validateLanguage(string $lang) : void
string
Language code
\Zend_Service_Exception |
---|
_validateLocalSearch(array $options) : void
array
\Zend_Service_Exception |
---|
_validateNewsSearch(array $options) : void
array
\Zend_Service_Exception |
---|
_validatePageDataSearch(array $options) : void
array
\Zend_Service_Exception |
---|
_validateVideoSearch(array $options) : void
array
\Zend_Service_Exception |
---|
_validateWebSearch(array $options) : void
array
\Zend_Service_Exception |
---|
$appId : string
$_rest : \Zend_Rest_Client