PHP Class ApaiIO\Operations\Search

See also: http://docs.aws.amazon.com/AWSECommerceService/2011-08-01/DG/ItemSearch.html
Author: Jan Eichhorn ([email protected])
Inheritance: extends AbstractOperation
Show file Open project: exeu/apai-io Class Usage Examples

Public Methods

Method Description
getAvailability ( ) : string Returns the availability.
getBrowseNode ( ) : integer Returns the browseNodeId
getCategory ( ) : string Return the amazon category
getCondition ( ) : string Returns the condition of the items to return. New | Used | Collectible | Refurbished | All
getKeywords ( ) : string Returns the keywords
getMaximumPrice ( ) : mixed Returns the maximum price as integer so 8.99$ will be returned as 899
getMinimumPrice ( ) : integer Return the minimum price as integer so 8.99$ will be returned as 899
getName ( )
getPage ( ) : integer Return the resultpage
setAvailability ( string $availability ) : Search Sets the availability. Don't use method if you want the default Amazon behaviour.
setBrowseNode ( integer $browseNodeId ) : Search Sets the browseNodeId
setCategory ( string $category ) : Search Sets the amazon category
setCondition ( string $condition ) : Search Sets the condition of the items to return: New | Used | Collectible | Refurbished | All
setKeywords ( string $keywords ) : Search Sets the keywords
setMaximumPrice ( integer $price ) : Search Sets the maximum price to a specified value for the search Currency will be given by the site you are querying: EUR for IT, USD for COM Price should be given as integer. 8.99$ USD becomes 899
setMinimumPrice ( integer $price ) : Search Sets the minimum price to a specified value for the search Currency will be given by the site you are querying: EUR for IT, USD for COM Price should be given as integer. 8.99$ USD becomes 899
setPage ( integer $page ) : Search Sets the resultpage to a specified value Allows to browse resultsets which have more than one page

Protected Methods

Method Description
validatePrice ( integer $price ) Validates the given price.

Method Details

getAvailability() public method

Returns the availability.
public getAvailability ( ) : string
return string

getBrowseNode() public method

Returns the browseNodeId
public getBrowseNode ( ) : integer
return integer

getCategory() public method

Return the amazon category
public getCategory ( ) : string
return string

getCondition() public method

Returns the condition of the items to return. New | Used | Collectible | Refurbished | All
public getCondition ( ) : string
return string

getKeywords() public method

Returns the keywords
public getKeywords ( ) : string
return string

getMaximumPrice() public method

Returns the maximum price as integer so 8.99$ will be returned as 899
public getMaximumPrice ( ) : mixed
return mixed

getMinimumPrice() public method

Return the minimum price as integer so 8.99$ will be returned as 899
public getMinimumPrice ( ) : integer
return integer

getName() public method

public getName ( )

getPage() public method

Return the resultpage
public getPage ( ) : integer
return integer

setAvailability() public method

Only valid value = Available
See also: http://docs.aws.amazon.com/AWSECommerceService/latest/DG/CHAP_ReturningPriceAndAvailabilityInformation-itemsearch.html
public setAvailability ( string $availability ) : Search
$availability string
return Search

setBrowseNode() public method

Sets the browseNodeId
public setBrowseNode ( integer $browseNodeId ) : Search
$browseNodeId integer
return Search

setCategory() public method

Sets the amazon category
public setCategory ( string $category ) : Search
$category string
return Search

setCondition() public method

Defaults to New.
public setCondition ( string $condition ) : Search
$condition string
return Search

setKeywords() public method

Sets the keywords
public setKeywords ( string $keywords ) : Search
$keywords string
return Search

setMaximumPrice() public method

Sets the maximum price to a specified value for the search Currency will be given by the site you are querying: EUR for IT, USD for COM Price should be given as integer. 8.99$ USD becomes 899
public setMaximumPrice ( integer $price ) : Search
$price integer
return Search

setMinimumPrice() public method

Sets the minimum price to a specified value for the search Currency will be given by the site you are querying: EUR for IT, USD for COM Price should be given as integer. 8.99$ USD becomes 899
public setMinimumPrice ( integer $price ) : Search
$price integer
return Search

setPage() public method

Sets the resultpage to a specified value Allows to browse resultsets which have more than one page
public setPage ( integer $page ) : Search
$page integer
return Search

validatePrice() protected method

Validates the given price.
protected validatePrice ( integer $price )
$price integer