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

Class: Services_Yahoo_JP_Auction_Response

Source Location: /Services_Yahoo_JP-0.1.1/Yahoo/JP/Auction/Response.php

Class Overview


Services_Yahoo Auction Response class


Author(s):

Version:

  • Release: 0.0.1

Copyright:

  • 2008 Tetsuya Nakase

Methods


Inherited Variables

Inherited Methods


Class Details

[line 39]
Services_Yahoo Auction Response class

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



[ Top ]


Method Detail

__construct (Constructor)   [line 89]

Services_Yahoo_JP_Auction_Response __construct( HTTP_Request $request)

Constructor
  • Throws: Services_Yahoo_Exception
  • Access: public

Parameters:

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

[ Top ]

current   [line 137]

array current( )

get current result of response
  • Return: current result of response
  • Access: public

[ Top ]

getRequest   [line 124]

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 ]

getTotalResultsReturned   [line 110]

integer getTotalResultsReturned( )

Get number of result sets returned by the content analysis
  • Return: Number of result sets returned
  • Access: public

[ Top ]

key   [line 160]

string key( )

get counter for iterator
  • Return: counter
  • Access: public

[ Top ]

next   [line 147]

array next( )

get next result of response
  • Return: next result of response
  • Access: public

[ Top ]

returnAttribute   [line 256]

string returnAttribute( string $name)

get Attribute
  • Return: value of attribute
  • Access: public

Parameters:

string   $name   —  key in result

[ Top ]

rewind   [line 170]

void rewind( )

clear counter for iterator
  • Access: public

[ Top ]

setIndexKey   [line 244]

void setIndexKey( string $key)

Set Key for Response Loop Field
  • Access: public

Parameters:

string   $key   —  key for loop in result

[ Top ]

valid   [line 180]

bool valid( )

get validate status
  • Return: validate status
  • Access: public

[ Top ]


Documentation generated on Mon, 11 Mar 2019 15:25:31 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.