Class: Services_Yahoo_Search_local

Source Location: /Services_Yahoo-0.2.0/Yahoo/Search/local.php

Class Overview

Services_Yahoo_Search_AbstractSearch
   |
   --Services_Yahoo_Search_local

Local search class

Author(s):

Martin Jansen <mj at php.net>

Version:

CVS: $Id: local.php,v 1.6 2006/10/04 15:08:56 mj Exp $

Copyright:

2005-2006 Martin Jansen

Inherited Variables

Class: Services_Yahoo_Search_AbstractSearch

Services_Yahoo_Search_AbstractSearch::$parameters

Inherited Methods

Class: Services_Yahoo_Search_AbstractSearch

Services_Yahoo_Search_AbstractSearch::adultContentOK(): Set that the results will include adult content
Services_Yahoo_Search_AbstractSearch::inFormat(): Set the format to search for
Services_Yahoo_Search_AbstractSearch::searchFor(): Submits the search
Services_Yahoo_Search_AbstractSearch::startingAt(): Set the starting result position to return (1-based)
Services_Yahoo_Search_AbstractSearch::withAppID(): Set Application ID for the search
Services_Yahoo_Search_AbstractSearch::withResults(): Set the number of results to return.
Services_Yahoo_Search_AbstractSearch::withType(): Set the kind of search to submit

Class Details

[line 47]
Local search class

This class implements an interface to Yahoo's Local search by using the Yahoo API.

Author: Martin Jansen <mj@php.net>
Version: CVS: $Id: local.php,v 1.6 2006/10/04 15:08:56 mj Exp $
Copyright: 2005-2006 Martin Jansen
Link: http://pear.php.net/package/Services_Yahoo
Link: http://developer.yahoo.net/local/V1/localSearch.html
License: Apache License, Version 2.0

[ Top ]

Class Variables

$requestURL = "http://local.yahooapis.com/LocalSearchService/V3/localSearch"

[line 49]

Access: protected

Type:

mixed

[ Top ]

Method Detail

atLocation [line 153]

Services_Yahoo_AbstractSearch atLocation(
string
$location)

Set a location description

This free field lets users enter any of the following:

city, state
city, state, ZIP
ZIP
street, city, state
street, city, state, ZIP
street, ZIP

If location is specified, it will take priority over the individual fields in determining the location for the query. City, state and ZIP will be ignored.

Return: Object which contains the method
Access: public

Parameters:

string $location — Location description

[ Top ]

inCity [line 90]

Services_Yahoo_AbstractSearch inCity(
string
$city)

Set the city name

Return: Object which contains the method
Access: public

Parameters:

string $city — City name

[ Top ]

inRadius [line 60]

Services_Yahoo_AbstractSearch inRadius(
string
$radius)

Set how far (in miles) from the specified location to search for the query terms

The default radius varies according to the location given.

Return: Object which contains the method
Access: public

Parameters:

string $radius — Radius as a float number

[ Top ]

inState [line 108]

Services_Yahoo_AbstractSearch inState(
string
$state, string
1)

Set the United States state

Return: Object which contains the method
Link: http://en.wikipedia.org/wiki/State_codes
Access: public

Parameters:

string	`1`	—	State name
string	`$state`	—	State name. You can spell out the full state name or you can use the two-letter abbreviation.

[ Top ]

inStreet [line 76]

Services_Yahoo_AbstractSearch inStreet(
string
$street)

Set the street name

The number is optional.

Return: Object which contains the method
Access: public

Parameters:

string $street — Name of the street

[ Top ]

withZIP [line 127]

Services_Yahoo_AbstractSearch withZIP(
string
$code)

Set the ZIP code

The parameter can be a five-digit ZIP code, or the five-digit code plus four-digit extension. If this location contradicts the city and state specified, the ZIP code will be used for determining the location and the city and state will be ignored.

Return: Object which contains the method
Access: public

Parameters:

string $code — ZIP code as described

[ Top ]