Docs For Class bid_lowest

Class bid_lowest_unique

Description

Lowest Unique Bid class to perform the majority of lowest unique bidding functions within ILance.

author: ILance
version: $Revision: 1.0.0 $

Located in /api/class.bid_lowest_unique.inc.php (line 23)

bid
   |
   --bid_lowest_unique

Method Summary

integer fetch_bid_count ([integer $projectid = 0])

string fetch_feedback_status (integer 0, integer 1, integer 2)

string fetch_last_unique_bid_amount ([integer $userid = 0], [integer $projectid = 0])

integer fetch_lower_unique_bids ([integer $userid = 0], [integer $projectid = 0], [string $amount = 0])

string fetch_lowest_unique_bidamount ([integer $projectid = 0])

integer fetch_lowest_unique_bid_uid ([integer $projectid = 0])

string fetch_lowest_unique_bid_winner ([integer $projectid = 0], [ $returnusername = true])

string fetch_lowest_unique_bid_winner_amount ([integer $projectid = 0], [boolean $currencyformat = true])

integer fetch_similar_unique_bids ([integer $userid = 0], [integer $projectid = 0], [string $amount = 0])

integer fetch_total_similar_bids ([integer $projectid = 0], [integer $amount = 0])

string fetch_transaction_status ([integer $projectid = 0], [boolean $shortform = false])

string fetch_unique_bid_response ([integer $userid = 0], [integer $projectid = 0], [string $amount = 0])

string fetch_unique_bid_status ([integer $userid = 0], [integer $projectid = 0], [string $amount = 0])

bool has_lower_unique_bids ([integer $userid = 0], [integer $projectid = 0], [string $amount = 0])

bool has_unique_bid_winner ([integer $projectid = 0])

void insert_unique_bid ([integer $userid = 0], [integer $ownerid = 0], [integer $projectid = 0], [string $amount = 0], [ $shipperid = 0])

string is_lowest_unique_bidder_html ([integer $userid = 0], [integer $projectid = 0])

string print_unique_bid_response ([integer $userid = 0], [integer $projectid = 0], [integer $amount = 0])

void reassign_lowest_unique_bid ([integer $projectid = 0])

Methods

fetch_bid_count (line 32)

Function for returning the bid count for a particular unique auction.

return: number of bids

integer fetch_bid_count ([integer $projectid = 0])

integer $projectid: project id

fetch_feedback_status (line 154)

Function for returning the html display message in a unique bid auction listing page and will determine a live message based on the status of the bidder viewing.

return: HTML formatted representation of the response

string fetch_feedback_status (integer 0, integer 1, integer 2)

integer 0: user id
integer 1: project id
integer 2: amount

fetch_last_unique_bid_amount (line 572)

Function for returning the very last unique bid amount placed by the bidder for a particular auction event.

return: amount of last bid placed

string fetch_last_unique_bid_amount ([integer $userid = 0], [integer $projectid = 0])

integer $userid: user id
integer $projectid: project id

fetch_lower_unique_bids (line 322)

Function for returning the number of how many lower unique bids are currently placed based on the amount being sent to this function.

return: count of how many lower unique bids are placed

integer fetch_lower_unique_bids ([integer $userid = 0], [integer $projectid = 0], [string $amount = 0])

integer $userid: user id
integer $projectid: project id
string $amount: unique bid amount

fetch_lowest_unique_bidamount (line 602)

Function for returning the lowest unique bid amount for a particular auction event.

return: amount of lowest unique bid placed

string fetch_lowest_unique_bidamount ([integer $projectid = 0])

integer $projectid: project id

fetch_lowest_unique_bid_uid (line 431)

Function for returning the lowest unique bid uid key from the database

return: uid key of the lowest bid placed in the database

integer fetch_lowest_unique_bid_uid ([integer $projectid = 0])

integer $projectid: project id

fetch_lowest_unique_bid_winner (line 770)

Function for returning a boolean value if a particular project has a lowest unique bid winner

return: HTML representation of the lowest unique bidder and their bid

string fetch_lowest_unique_bid_winner ([integer $projectid = 0], [ $returnusername = true])

integer $projectid: project id
$returnusername

fetch_lowest_unique_bid_winner_amount (line 807)

Function for returning a bid amount value if a particular project has a lowest unique bid winner

return: HTML representation of the lowest unique bidder and their bid

string fetch_lowest_unique_bid_winner_amount ([integer $projectid = 0], [boolean $currencyformat = true])

integer $projectid: project id
boolean $currencyformat: return amount with currency formatting? default true

fetch_similar_unique_bids (line 353)

Function for returning the number of how many similiar bids are currently placed based on the same amount being sent to this function.

return: count of how many lower unique bids are placed

integer fetch_similar_unique_bids ([integer $userid = 0], [integer $projectid = 0], [string $amount = 0])

integer $userid: user id
integer $projectid: project id
string $amount: unique bid amount

fetch_total_similar_bids (line 630)

Function for returning the total amount of similar bids compared to an amount being provided

return: total count

integer fetch_total_similar_bids ([integer $projectid = 0], [integer $amount = 0])

integer $projectid: project id
integer $amount: amount

fetch_transaction_status (line 117)

Function to print out the lowest unique bid transaction status for a listing that is won by a winning bidder.

return: HTML formatted representation of the response

string fetch_transaction_status ([integer $projectid = 0], [boolean $shortform = false])

integer $projectid: project id
boolean $shortform: shortform notice? (default false)

Redefinition of:

bid::fetch_transaction_status(): Function to print out the bid transaction status for a listing that is won by a winning bidder.

fetch_unique_bid_response (line 385)

Function for returning the HTML representation of the actual bid response message that is included in the bid stamp when any bidder places a bid on a unique bid auction event.

return: HTML representation of the bid response message included in bid stamp

string fetch_unique_bid_response ([integer $userid = 0], [integer $projectid = 0], [string $amount = 0])

integer $userid: user id
integer $projectid: project id
string $amount: unique bid amount

fetch_unique_bid_status (line 513)

Function for returning a single status out of a combination of three: nonunique, unique and lowestunique.

return: actual database table status to use for placing the new bid amount

string fetch_unique_bid_status ([integer $userid = 0], [integer $projectid = 0], [string $amount = 0])

integer $userid: user id
integer $projectid: project id
string $amount: unique bid amount

has_lower_unique_bids (line 239)

Function for determining if an auction has a lower unique bid placed than the bidder currently placing their bid.

return: true or false

bool has_lower_unique_bids ([integer $userid = 0], [integer $projectid = 0], [string $amount = 0])

integer $userid: user id
integer $projectid: project id
string $amount: unique bid amount

has_unique_bid_winner (line 742)

Function for returning a boolean value if a particular project has a lowest unique bid winner

return: yes / no

bool has_unique_bid_winner ([integer $projectid = 0])

integer $projectid: project id

insert_unique_bid (line 681)

Function for inserting a new lowest unique bid within a unique bid auction event.

void insert_unique_bid ([integer $userid = 0], [integer $ownerid = 0], [integer $projectid = 0], [string $amount = 0], [ $shipperid = 0])

integer $userid: user id
integer $ownerid: owner id
integer $projectid: project id
string $amount: unique bid amount
$shipperid

is_lowest_unique_bidder_html (line 58)

Function for printing the lowest unique bid status on the detailed auction listing page.

return: HTML representation of the lowest unique bid status

string is_lowest_unique_bidder_html ([integer $userid = 0], [integer $projectid = 0])

integer $userid: user id
integer $projectid: project id

print_unique_bid_response (line 173)

Function for returning the html display message in a unique bid auction listing page and will determine a live message based on the status of the bidder viewing.

return: HTML formatted representation of the response

string print_unique_bid_response ([integer $userid = 0], [integer $projectid = 0], [integer $amount = 0])

integer $userid: user id
integer $projectid: project id
integer $amount: amount

reassign_lowest_unique_bid (line 461)

Function for determining if there are any lowestunique bid status in the database for the

current auction event and if not this function will find out if there is any other potential bid currently placed that could be candidate for a lowestunique bid status. There must be at least 1 lowestunique bid placed to win the auction and it is possible that a single auction might not always have a lowestunique bid status.

void reassign_lowest_unique_bid ([integer $projectid = 0])

integer $projectid: project id

Inherited Methods

Inherited From bid

bid::bid_filter_checkup()
bid::construct_bid_details_pulldown()
bid::fetch_auction_win_amount()
bid::fetch_auction_win_type()
bid::fetch_average_bid()
bid::fetch_average_lowest_highest_bid_amounts()
bid::fetch_awarded_bid_amount()
bid::fetch_bid_amount()
bid::fetch_declined_bids()
bid::fetch_highest_bid()
bid::fetch_highest_bidder()
bid::fetch_lowest_bidder_info()
bid::fetch_minimum_bid()
bid::fetch_retracted_bids()
bid::fetch_second_highest_bid()
bid::fetch_shortlisted_bids()
bid::fetch_transaction_status()
bid::has_bids()
bid::has_highest_bidder()
bid::has_winning_bidder()
bid::is_highest_bidder()
bid::is_outbid()
bid::is_valid_bid_range()
bid::is_winner()
bid::product_bid_filter_checkup()
bid::set_bid_counters()
bid::user_can_bid()
bid::wait_approval_unaward_cron()

Documentation generated on Mon, 08 Aug 2011 17:40:50 +0200 by phpDocumentor 1.4.1