Services_Yahoo
[ class tree: Services_Yahoo ] [ index: Services_Yahoo ] [ all elements ]

Class: Services_Yahoo_Search_Response

Source Location: /Services_Yahoo-0.1.0/Yahoo/Search/Response.php

Class Overview


Services_Yahoo Search Response class


Author(s):

Version:

  • CVS: $Id: Response.php,v 1.1 2005/03/22 11:21:18 mj Exp $

Copyright:

  • 2005 Martin Jansen

Methods


Inherited Variables

Inherited Methods


Class Details

[line 38]
Services_Yahoo Search Response class

This class provides methods for accessing the response of a search request.

  • Version: CVS: $Id: Response.php,v 1.1 2005/03/22 11:21:18 mj Exp $
  • License: PHP License 3.0
  • Copyright: 2005 Martin Jansen
  • Author: Martin Jansen <mailto:mj@php.net>
  • Extends: Exception


[ Top ]


Method Detail

current   [line 160]

void current( )


[ Top ]

getFirstResultPosition   [line 88]

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 152]

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 116]

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 77]

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 102]

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 134]

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 173]

void key( )


[ Top ]

next   [line 165]

void next( )


[ Top ]

rewind   [line 178]

void rewind( )


[ Top ]

valid   [line 183]

void valid( )


[ Top ]


Documentation generated on Mon, 06 Jun 2005 07:30:12 -0400 by phpDocumentor 1.2.3. PEAR Logo Copyright © PHP Group 2004.