Docs For Class auction

Class auction

Description

Auction class to perform the majority of functions dealing with anything to do with auctions within ILance.

author: ILance
version: $Revision: 1.0.0 $

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

Direct descendents

Class	Description
auction_award	Auction award class to perform the majority of functions dealing with anything to do with auctions and awarding details within ILance.
auction_expiry	Auction award class to perform the majority of functions dealing with anything to do with listing expiry within ILance.
auction_listing	Auction listing class to perform the majority of printing and displaying of auction listing page in the front end.
auction_post	Auction posting class to perform the majority of printing and displaying of filters and other form elements for service and product auctions.
auction_questions	Class to handle the auction posting interface for any type of auction supported in ILance.
auction_rfp	Class to handle inserting new product or service auctions within the database.
auction_tabs	Auction tabs class to perform the majority of printing and displaying of auction tabs within the MyCP areas of the front end.

Method Summary

void archive_expired_auctions ()

string auction_icons ([array $res = array()])

string auction_timeleft ([integer $projectid = 0], [string $class = 'alt1'], [string $valign = 'center'], [boolean $timeintext = 0], [boolean $showlivebids = 0], [boolean $forcenoflash = 0], [boolean $showfullformat = false], [string $date_starts = ''], [string $mytime = ''], [string $starttime = ''])

string calculate_insertion_fee_in_budget_group ([string $groupname = ''])

string calculate_time_left (integer $datestarts, integer $starttime, integer $mytime)

string category_listing_count_fixer ()

string construct_bidamounttype ([string $selected = ''])

string construct_bidamounttype_pulldown ([integer $selected = ''], [bool $disable = 0], [bool $dojs = 1], [integer $cid = ''], [string $cattype = ''])

string construct_budget_overview ([integer $cid = 0], [integer $selected = 0], [boolean $notext = false], [boolean $nobrackets = false], [boolean $forcenocategory = false])

string construct_budget_pulldown (integer $cid, [integer $selected = ''], [string $fieldname = 'filtered_budgetid'], [bool $dojs = 1], [bool $showselect = 0], [bool $showinsertionfees = 0])

string construct_invoice_icon ([integer $sellerid = 0], [integer $buyerid = 0], [integer $projectid = 0])

string construct_measure ([string $selected = ''])

string construct_mediashare_icon ([integer $buyerid = 0], [integer $sellerid = 0], [integer $projectid = 0], [boolean $active = true])

string construct_pmb_icon ([integer $fromid = 0], [integer $toid = 0], [integer $projectid = 0], [boolean $adminmode = 0], [boolean $showicon = false])

string expire_featured_status_listings ()

string fetch_auction_type ([integer $projectid = 0])

integer fetch_auction_winner ([integer $projectid = 0])

string fetch_ending_soon_auctions ([string $auctiontype = ''], [integer $columns = 5], [integer $rows = 1], [integer $cid = 0], [string $keywords = ''], [boolean $forcenoflash = false])

string fetch_featured_auctions ([string $auctiontype = ''], [integer $columns = 4], [integer $rows = 1], [integer $cid = 0], [string $keywords = ''], [boolean $forcenoflash = false], [array $excludelist = array()])

string fetch_latest_auctions ([string $auctiontype = ''], [integer $columns = 5], [integer $rows = 1], [integer $cid = 0], [string $keywords = ''], [boolean $forcenoflash = false])

string fetch_purchase_now ([integer $projectid = 0])

string fetch_recently_viewed_auctions ([string $auctiontype = ''], [integer $columns = 5], [integer $rows = 1], [integer $cid = 0], [string $keywords = ''], [boolean $forcenoflash = false])

integer fetch_reserve_price ([integer $auctionid = 0])

string fetch_reserve_price_bit ([integer $projectid = 0])

string fetch_rfp_budget ([integer $projectid = 0], [ $showicon = false])

string fetch_transfer_ownership ([integer $projectid = 0])

string fetch_users_other_listings ([integer $userid = 0], [string $auctiontype = ''], [integer $limit = 5], [array $excludelist = array()], [boolean $forcenoflash = false])

nothing relist_product_auction ([ $id = 0])

nothing relist_service_auction ([ $id = 0])

string remove_answers_from_deleted_listings ()

string remove_photos_from_deleted_listings ()

string remove_shipping_regions_from_deleted_listings ()

nothing rewrite_photos ( $old_id, $new_id)

Methods

archive_expired_auctions (line 3751)

void archive_expired_auctions ()

auction_icons (line 32)

Function to print auction icons based on the selected filters of the associated auction id.

return: HTML representation of icons for the associated listing.

string auction_icons ([array $res = array()])

array $res: auction result set

auction_timeleft (line 349)

Function to calculate the exact time left based on a few date and time parameters and prints text or flash countdown applets.

This function is optimized to prevent a new call to the database.

return: HTML representation of the countdown text or countdown flash applet

integer $projectid: project id
string $class: class background color (default alt1)
string $valign: vert. alignment (default center)
boolean $timeintext: show the time left in text? (true or false) (default false)
boolean $showlivebids: show live bids placed in applet? (true or false) (default false)
boolean $forcenoflash: force no flash applet (true or false) (default false)
boolean $showfullformat: show the full timeleft string? (default false) ie: 2d, 1h, 3m, 5+ vs. 2d, 1h+
string $date_starts: date starts (datetime) format
string $mytime: timestamp of date end - now
string $starttime: timestamp of start date - now

calculate_insertion_fee_in_budget_group (line 1627)

Function to fetch the insertion fee amount associated within a particular budget group

return: Insertion fee amount

string calculate_insertion_fee_in_budget_group ([string $groupname = ''])

string $groupname: insertion group name

calculate_time_left (line 237)

Function to calculate the exact time left based on a few date and time parameters.

return: phrased value of the time left (eg: 1h, 3m)

string calculate_time_left (integer $datestarts, integer $starttime, integer $mytime)

integer $datestarts: date starts
integer $starttime: start time
integer $mytime: time now

category_listing_count_fixer (line 3079)

Function to handle the verification of auction counters in the category system. This function runs daily within cron.dailyrfp.php

return: Report on the number of rebuilt category counters performed.

string category_listing_count_fixer ()

construct_bidamounttype (line 1455)

Function to print the bid amount types overview.

return: HTML representation of the bid amount types

string construct_bidamounttype ([string $selected = ''])

string $selected: selected bid amount type (optional)

construct_bidamounttype_pulldown (line 1231)

Function to print the bid amount types pulldown menu.

return: HTML representation of the bid amount types pulldown values

string construct_bidamounttype_pulldown ([integer $selected = ''], [bool $disable = 0], [bool $dojs = 1], [integer $cid = ''], [string $cattype = ''])

integer $selected: selected bid amount type value
bool $disable: disable the bid amount type pulldown menu (true or false)
bool $dojs: enable javascript (true or false)
integer $cid: selected category id (optional)
string $cattype: category type (service / product)

construct_budget_overview (line 1111)

Function to print the budget overview details

return: HTML representation of the budget values

string construct_budget_overview ([integer $cid = 0], [integer $selected = 0], [boolean $notext = false], [boolean $nobrackets = false], [boolean $forcenocategory = false])

integer $cid: category id
integer $selected: selected id (optional)
boolean $notext: don't show range title (default false)
boolean $nobrackets: don't show brackets (default false)
boolean $forcenocategory: force function to use raw budget id vs. the budget in place for the actual category. This is required for the search system if subcategories are also being called

construct_budget_pulldown (line 1021)

Function to print the budget pulldown details

return: HTML representation of the budget pulldown values

string construct_budget_pulldown (integer $cid, [integer $selected = ''], [string $fieldname = 'filtered_budgetid'], [bool $dojs = 1], [bool $showselect = 0], [bool $showinsertionfees = 0])

integer $cid: category id
integer $selected: selected id (optional)
string $fieldname: field name to use
bool $dojs: are we enabling javascript (true or false)
bool $showselect: will we show the "please select" option as well?
bool $showinsertionfees: will we show insertion fees within the pulldown menu that is generated?

construct_invoice_icon (line 697)

Function to create the invoice icon to be clicked so providers can generate new transaction to their buyers.

return: HTML representation of the clickable invoice icon

string construct_invoice_icon ([integer $sellerid = 0], [integer $buyerid = 0], [integer $projectid = 0])

integer $sellerid: seller id
integer $buyerid: buyer id
integer $projectid: project id

construct_measure (line 1509)

Function to print the phrased measure values of the selected bid amount types.

return: HTML representation of the bid amount types

string construct_measure ([string $selected = ''])

string $selected: selected bid amount type (optional)

construct_mediashare_icon (line 932)

Function to create the mediashare (workspace) icon.

return: HTML representation of the clickable mediashare icon

string construct_mediashare_icon ([integer $buyerid = 0], [integer $sellerid = 0], [integer $projectid = 0], [boolean $active = true])

integer $buyerid: buyer id
integer $sellerid: seller id
integer $projectid: project id
boolean $active: force if icon is active or disabled (active by default)

construct_pmb_icon (line 532)

Function to create the private message board icons within various sections of the client control panel.

return: HTML representation of private message board icon

string construct_pmb_icon ([integer $fromid = 0], [integer $toid = 0], [integer $projectid = 0], [boolean $adminmode = 0], [boolean $showicon = false])

integer $fromid: from user id
integer $toid: to user id
integer $projectid: project id
boolean $adminmode: force admin mode (true or false)
boolean $showicon: show icon vs text? (default false)

expire_featured_status_listings (line 3040)

Function to handle the expiry of featured status listings

return: Report on the number of rebuilt category counters performed.

string expire_featured_status_listings ()

fetch_auction_type (line 208)

Function to fetch the type (project state) of an auction.

return: auction type (project state)

string fetch_auction_type ([integer $projectid = 0])

integer $projectid: auction id

fetch_auction_winner (line 777)

Function to fetch a clickable link to the auction winner for a particular auction id.

return: clickable link with the username

integer fetch_auction_winner ([integer $projectid = 0])

integer $projectid: project id

fetch_ending_soon_auctions (line 2143)

Function to return template array data for recently viewed auctions stored in the users cookie.

Function now takes into consideration if a member is not active (don't display the listing).

return: Returns template array data for use with parse_loop() function

string fetch_ending_soon_auctions ([string $auctiontype = ''], [integer $columns = 5], [integer $rows = 1], [integer $cid = 0], [string $keywords = ''], [boolean $forcenoflash = false])

string $auctiontype: auction type
integer $columns: auction result columns (default 5)
integer $rows: auction result rows (default 1)
integer $cid: (optional) category id to pull listings from if specified
string $keywords: (optional) keywords to search (titles & descriptions) when pulling listing results if specified
boolean $forcenoflash: force no-flash for auction timers (default no force)

fetch_featured_auctions (line 2434)

Function to return template array data for featured auctions in picture grid mode.

This function also take lowest unique bidding into account when displaying number of bids

Function now takes into consideration if a member is not active (don't display the listing).

return: Returns template array data for use with parse_loop() function

string $auctiontype: auction type
integer $columns: number of columns to display (default 4)
integer $rows: number of rows to display (default 1)
integer $cid: (optional) category id to pull listings from if specified
string $keywords: (optional) keywords to search (titles & descriptions) when pulling listing results if specified
boolean $forcenoflash: force no-flash for auction timers (default no force)
array $excludelist: excluded project ids (to prevent search results showing both featured and regular listings simultaneously)

fetch_latest_auctions (line 2755)

Function to return template array data for featured auctions in picture grid mode.

This function also take lowest unique bidding into account when displaying number of bids

Function now takes into consideration if a member is not active (don't display the listing).

return: Returns template array data for use with parse_loop() function

string fetch_latest_auctions ([string $auctiontype = ''], [integer $columns = 5], [integer $rows = 1], [integer $cid = 0], [string $keywords = ''], [boolean $forcenoflash = false])

string $auctiontype: auction type
integer $columns: auction limit (default 5)
integer $rows: auction rows limit (default 1)
integer $cid: (optional) category id to pull listings from if specified
string $keywords: (optional) keywords to search (titles & descriptions) when pulling listing results if specified
boolean $forcenoflash: force no-flash for auction timers (default no force)

fetch_purchase_now (line 865)

Function to fetch the current purchase now price of a particular auction id.

return: HTML representation of the purchase now details

string fetch_purchase_now ([integer $projectid = 0])

integer $projectid: project id

fetch_recently_viewed_auctions (line 1822)

Function to return template array data for recently viewed auctions stored in the users cookie.

This function additionally provides {photo} variable to let the designer show the related photo for the item being shown within the HTML template.

Function now takes into consideration if a member is not active (don't display the listing). Additionally, this function will no longer show "ended" listings so only active open listings will appear in the recently viewed blocks.

return: Returns template array data for use with parse_loop() function

string fetch_recently_viewed_auctions ([string $auctiontype = ''], [integer $columns = 5], [integer $rows = 1], [integer $cid = 0], [string $keywords = ''], [boolean $forcenoflash = false])

string $auctiontype: auction type
integer $columns: auction result limit (default 5)
integer $rows: auction rows limit (default 1)
integer $cid: (optional) category id to pull listings from if specified
string $keywords: (optional) keywords to search (titles & descriptions) when pulling listing results if specified
boolean $forcenoflash: force no-flash for auction timers (default no force)

fetch_reserve_price (line 807)

Function to fetch the current reserve price of a particular auction id.

return: reserve price amount

integer fetch_reserve_price ([integer $auctionid = 0])

integer $auctionid: auction id

fetch_reserve_price_bit (line 835)

Function to fetch the current reserve price bit of a particular auction id.

return: HTML representation of the reserve price details

string fetch_reserve_price_bit ([integer $projectid = 0])

integer $projectid: project id

fetch_rfp_budget (line 1568)

Function to fetch the request for proposal budget amount for a particular project

return: HTML representation of the duration pulldown menu

string fetch_rfp_budget ([integer $projectid = 0], [ $showicon = false])

integer $projectid: project id
$showicon

fetch_transfer_ownership (line 896)

Function to fetch the current transfer of ownership details

return: HTML representation of the auction transfer of ownership details

string fetch_transfer_ownership ([integer $projectid = 0])

integer $projectid: project id

fetch_users_other_listings (line 1662)

Function to return template array data for a the buyer or seller currently being viewed. This function is usually called from the actual listing or profile page of the marketplace letting users see other related listings from the same seller (product listings) or buyer (service auction listings)

return: Returns template array data for use with parse_loop() function

string fetch_users_other_listings ([integer $userid = 0], [string $auctiontype = ''], [integer $limit = 5], [array $excludelist = array()], [boolean $forcenoflash = false])

integer $userid: user id
string $auctiontype: auction type (service or product)
integer $limit: auction result limit (default 5)
array $excludelist: array of project id's not to include in sellers listings
boolean $forcenoflash: force no-flash for auction timers (default no force)

relist_product_auction (line 3117)

Function to relist product auction

nothing relist_product_auction ([ $id = 0])

relist_service_auction (line 3315)

Function to relist service auction

nothing relist_service_auction ([ $id = 0])

remove_answers_from_deleted_listings (line 3646)

Function to handle the removal of item question / answers from deleted listings in the database. This function runs daily within cron.dailyrfp.php

return: Report on the number of images removed from unlinked projects.

string remove_answers_from_deleted_listings ()

remove_photos_from_deleted_listings (line 3596)

Function to handle the removal of item photos and slideshow images from deleted auctions in the database. This function runs daily within cron.dailyrfp.php

return: Report on the number of images removed from unlinked projects.

string remove_photos_from_deleted_listings ()

remove_shipping_regions_from_deleted_listings (line 3714)

Function to handle the removal of item shipping regions from deleted listings in the database. This function runs daily within cron.dailyrfp.php

return: Report on the number of images removed from unlinked projects.

string remove_shipping_regions_from_deleted_listings ()

rewrite_photos (line 3558)

Function to rewrite photos based on orginal auction to new relisted auction

nothing rewrite_photos ( $old_id, $new_id)

$old_id
$new_id

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