Docs For Class Services_Yahoo_Search

__construct (Constructor) [line 58]

Services_Yahoo_Search_Response __construct(
HTTP_Request
$request)

Constructor

Throws: Services_Yahoo_Exception
Access: public

Parameters:

object HTTP_Request $request — Instance of HTTP_Request that was used for the request

[ Top ]

current [line 166]

void current(
)

Access: public

[ Top ]

getFirstResultPosition [line 94]

integer getFirstResultPosition(
)

Get the position of the first result in the overall search

Return: Position of the first result in the overall search
Access: public

[ Top ]

getRequest [line 158]

object HTTP_Request getRequest(
)

Get the HTTP_Request instance that was used for the query

Access to the HTTP_Request instance is useful for introspecting into the request details. (E.g. for getting the HTTP response code.)

Return: Instance of HTTP_Request
Access: public

[ Top ]

getResultSetMapUrl [line 122]

string getResultSetMapUrl(
)

Get the URL of a webpage containing a map graphic with all returned results plotted on it

This URL is not part of all search responses, but it is used often enough to be part of the general response class.

Return: Map URL
Access: public

[ Top ]

getTotal [line 83]

integer getTotal(
)

Get number of query matches in the database

This method returns the overall number of matches in the database.

Return: Number of query matches
Access: public

[ Top ]

getTotalResultsReturned [line 108]

integer getTotalResultsReturned(
)

Get number of query matches returned from the search

This may be lower than the number of results requested if there were fewer total results available.

Return: Number of query matches returned
Access: public

[ Top ]

hasMore [line 140]

boolean hasMore(
)

Determine if there are more matches than the ones that have been returned

This method may be used as the criteria for displaying "Next" links or similar.

Return: True if more results are available, false otherwise.
Access: public

[ Top ]

key [line 179]

void key(
)

Access: public

[ Top ]

next [line 171]

void next(
)

Access: public

[ Top ]

rewind [line 184]

void rewind(
)

Access: public

[ Top ]

valid [line 189]

void valid(
)

Access: public

[ Top ]

Class: Services_Yahoo_Search_Response

Class Overview

Author(s):

Version:

Copyright:

Methods

Inherited Variables

Inherited Methods

Class Details

Method Detail

__construct (Constructor) [line 58]

Parameters:

current [line 166]

getFirstResultPosition [line 94]

getRequest [line 158]

getResultSetMapUrl [line 122]

getTotal [line 83]

getTotalResultsReturned [line 108]

hasMore [line 140]

key [line 179]

next [line 171]

rewind [line 184]

valid [line 189]