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

Class: ProductInfo

Source Location: /other.class.php

Class Overview

AmazonResponse
   |
   --ProductInfo
This is one of the classes returned when querying AWS.

Author(s):

Version: 0.3RC1

Copyright: 2004 (c) Mauricio Diaz Orlich

Methods


Inherited Methods:

Class: AmazonResponse

AmazonResponse::getErrorMessage()
An error message returned by AWS.
AmazonResponse::isBlendedSearch()
Test to determine if the top node of the search is a BlendedSearch node.
AmazonResponse::isProductInfo()
Test to determine if the top node of the search is a ProductInfo node.
AmazonResponse::isShoppingCart()
Test to determine if the top node of the search is a ShoppingCartResponse node.
AmazonResponse::requestArgument()
Gets an argument from the Request node of the AWS feed.

Class Details [line 180]

This is one of the classes returned when querying AWS.

This class is returned when you do one of the following queries:

  • Actor
  • Artist
  • ASIN (*)
  • ISBN (*)
  • Author
  • BrowseNode
  • Director
  • Keywords
  • Manufacturer
  • Power (not supported yet)
  • Similarity
  • UPC (*)
(*) Will return at the most one product detail

This class is also part of the results of a BlendedSearch




Tags:

License:  GNU General Public License
  
Version:  0.3RC1
  
Copyright:  2004 (c) Mauricio Diaz Orlich
  
Author:  Mauricio Diaz <madd0@users.sourceforge.net>
  
See:  AmazonQuery::getCategory()
See:  AmazonQuery::query()


[ Top ]


Class Methods


constructor ProductInfo [line 218]

ProductInfo ProductInfo( )

Default constructor.

Prepares the class.




[ Top ]

method getDetails [line 309]

LiteDetails|HeavyDetails|boolean getDetails( [integer $number = 0])

Gets one of the objects containing product details.

This object can be of type LiteDetails or HeavyDetails, depending on what type of search you are making.




Tags:

Return:  the details of the requested product from the list, or false if the requested position of the list does not contain product details.
  
See:  HeavyDetails
See:  LiteDetails


Parameters:

integer   $number   the object you want to get from the list. If set to 0 (default), a random object from the list is returned.

[ Top ]

method getTotalPages [line 285]

integer getTotalPages( )

Number of pages of results generated by a search.



Tags:

Return:  the number of pages of results generated by the search.


[ Top ]

method getTotalResults [line 271]

integer getTotalResults( )

Number of results (products) generated by a search.

A search may genereate a large number of results, nevertheless only a maximum of ten will be returned in each query. To obtain the next set of results, you must requet the next page of your serach.




Tags:

Return:  the total number of results generated by the search.


[ Top ]

method resultsHigh [line 254]

integer resultsHigh( )

The number of the last result returned.

For example, if you are on page one, the last result can be result number 10, or a lower number. If you are in page 3, the last result is result can be 30, or a lower number, and so on...




Tags:

Return:  the number of the last result generated by the search.
  
See:  ProductInfo::resultsLow()


[ Top ]

method resultsLow [line 234]

integer resultsLow( )

The number of the first result returned.

For example, if you are on page one, the first result is result number 1, if you are in page 3, the first result is result 21, and so on...




Tags:

Return:  the number of the first result generated by the search.
  
See:  ProductInfo::resultsHigh()


[ Top ]

 
Documentation generated on Sat, 21 Aug 2004 17:40:42 +0200 by phpDocumentor 1.3.0RC3
hosted by
SourceForge.net Logo