/core/functions_shipping.php

Description
Description | Functions

Shipping functions for ILance

  • author: ILance
  • version: $Revision: 1.0.0 $
Functions
Description | Functions
can_item_ship_to_countryid (line 547)

Function to to determine if a specific item / listing id can be shipped to a specific country

  • return: Returns true or false
boolean can_item_ship_to_countryid ([integer $projectid = 0], [integer $countryid = 0])
  • integer $projectid: listing id
  • integer $countryid: country id
fetch_ajax_ship_service_row (line 395)

Function to print the ajax shipping service rows called via AJAX from the listing page

This function will fetch the shipping service rows for an ajax related call from an auction listing page

  • return: Returns HTML formatted string of payment method output or radio button input logic
string fetch_ajax_ship_service_row ([integer $row = 0], [integer $pid = 0], [string $countrytitle = ''], [integer $region = ''], [ $qty = 1])
  • integer $row: shipping row number
  • integer $pid: auction listing id
  • string $countrytitle: country title $param string region title
  • integer $region: quantity
  • $qty
fetch_countries_by_region_array (line 697)

Function to

This function

  • return: Returns HTML formatted string
string fetch_countries_by_region_array ([string $region = ''])
  • string $region: region
fetch_listing_shipping_regions (line 627)
void fetch_listing_shipping_regions ([ $pid = 0])
  • $pid
fetch_lowest_shipping_cost (line 465)

Function to fetch the lowest possible shipping prices within a haystack of prices

This function will be used on the search results to display the lowest possible shipping cost to buyers

  • return: Returns HTML formatted string of lowest shipping price in the haystack
string fetch_lowest_shipping_cost ([array $prices = array()], [ $docurrencyformat = false], [ $pid = 0], [ $currencyid = ''])
  • array $prices: array with multiple shipping costs
  • $docurrencyformat
  • $pid
  • $currencyid
fetch_option_ship_service_row (line 197)

Function to print an options list for generation of a pulldown menu with buyer shipping choices available to them

This function will fetch the shipping service rows

  • return: Returns HTML formatted string of payment method output or radio button input logic
string fetch_option_ship_service_row ([integer $row = 0], [integer $pid = 0], [string $countrytitle = ''], [integer $region = ''], [ $qty = 1], [ $showprice = false])
  • integer $row: shipping row number
  • integer $pid: auction listing id
  • string $countrytitle: country title $param string region title
  • integer $region: quantity
  • $qty
  • $showprice
fetch_payment_method_email (line 806)

Function to fetch the email address associated with a selected payment gateway selected by the seller

This function will print a email address if applicable.

  • return: Returns HTML formatted string
string fetch_payment_method_email ([integer $projectid = 0], [string $selectedgateway = ''])
  • integer $projectid: auction listing id
  • string $selectedgateway: selected payment gateway
fetch_radio_ship_service_row (line 117)

Function to print the ajax shipping service rows called via AJAX from the listing page

This function will fetch the shipping service rows for an ajax related call from an auction listing page

  • return: Returns HTML formatted string of payment method output or radio button input logic
string fetch_radio_ship_service_row ([integer $row = 0], [integer $pid = 0], [string $countrytitle = ''], [integer $region = ''], [ $qty = 1])
  • integer $row: shipping row number
  • integer $pid: auction listing id
  • string $countrytitle: country title $param string region title
  • integer $region: quantity
  • $qty
fetch_region_by_countryid (line 662)

Function to fetch region title/name by a country id

This function

  • return: Returns HTML formatted string
string fetch_region_by_countryid ([integer $countryid = 0], [ $doformatting = true])
  • integer $countryid: country id
  • $doformatting
fetch_shipping_services_count (line 1777)

Function to fetch the total number of shipping services an item is using for their listing

  • return: Returns number of shipping services count
integer fetch_shipping_services_count ([integer $pid = 0])
  • integer $pid: listing id
fetch_ship_cost_by_shipperid (line 502)

Function to fetch and return an array the raw shipping costs by a shipper id for a specific project (including single or multiple qty)

  • return: Returns php array with $array['total'] and $array['amount'] values
string fetch_ship_cost_by_shipperid ([integer $projectid = 0], [integer $shipperid = 0], [integer $qty = 1])
  • integer $projectid: listing id
  • integer $shipperid: shipping service id
  • integer $qty: quantity (default 1)
mark_listing_as_paid (line 1213)

Function to mark a outside direct pay listing as paid (seller invokes this himself)

nothing mark_listing_as_paid ([ $pid = 0], [ $bid = 0], [ $winnermarkedaspaidmethod = ''])
  • $pid
  • $bid
  • $winnermarkedaspaidmethod
mark_listing_as_shipped (line 1118)

Function to mark a listing as shipped (by the seller themselves)

nothing mark_listing_as_shipped ([ $pid = 0], [ $bid = 0], [ $sellerid = 0], [ $buyerid = 0], [ $mode = ''])
  • $pid
  • $bid
  • $sellerid
  • $buyerid
  • $mode
mark_listing_as_unshipped (line 1046)

Function to mark a listing as un-shipped (by the seller themselves)

nothing mark_listing_as_unshipped ([ $pid = 0], [ $bid = 0], [ $sellerid = 0], [ $buyerid = 0], [ $mode = ''])
  • $pid
  • $bid
  • $sellerid
  • $buyerid
  • $mode
mark_lub_listing_as_paid (line 1264)

Function to mark a lowest unique bid listing as being paid in full to the seller

  • return: Returns true or false if the listing could be marked as paid
boolean mark_lub_listing_as_paid ([integer $pid = 0], [string $winnermarkedaspaidmethod = ''])
  • integer $pid: project id
  • string $winnermarkedaspaidmethod: string of payment method used
mark_lub_listing_as_unpaid (line 1438)

Function to mark a lowest unique bid listing as being unpaid to the seller

  • return: Returns true or false if the listing could be marked as unpaid
boolean mark_lub_listing_as_unpaid ([integer $pid = 0])
  • integer $pid: project id
print_cc_shipping_address_pulldown (line 1510)

Function to print address select field options based on the users credit card billing details

  • return: Returns the HTML representation of the select <option>'s
string print_cc_shipping_address_pulldown ([integer $userid = 0])
  • integer $userid: user id
print_cc_shipping_address_text (line 1559)

Function to print an address based on the users credit card billing details

  • return: Returns the HTML representation of the address
string print_cc_shipping_address_text ([integer $userid = 0])
  • integer $userid: user id
print_fixed_payment_method (line 840)

Function to print a fixed payment method recognized by ILance

This function print fixed payment method

  • return: Returns HTML formatted string
string print_fixed_payment_method ([string $selected = ''], [boolean $showtype = true])
  • string $selected: selected payment method
  • boolean $showtype: show the pay method type in the string?
print_item_shipping_countries_pulldown (line 265)

Function to print shipping countries pulldown based on a specific auction listing id

This function

  • return: Returns HTML formatted string
string print_item_shipping_countries_pulldown ([integer $projectid = 0], [boolean $string = false], [boolean $onlyregions = false], [boolean $worldwide = false], [ $selectedcid = 0])
  • integer $projectid: auction listing id
  • boolean $string: do string output? default false
  • boolean $onlyregions: do only regions output? default false
  • boolean $worldwide: do only worldwide? default false
  • $selectedcid
print_item_shipping_countries_string (line 324)

Function to print shipping countries string based on a specific auction listing id

This function

  • return: Returns HTML formatted string of payment method output or radio button input logic
string print_item_shipping_countries_string ([integer $projectid = 0], [boolean $forceall = false])
  • integer $projectid: auction listing id
  • boolean $forceall: force all countries? default false
print_orderid_methods (line 579)

Function to fetch and print order id radio combo buttons for a listing payment selection process

  • return: Returns HTML formatted string of radio including html markup
string print_orderid_methods ([integer $pid = 0], [integer $buyerid = 0], [integer $orderid = 0])
  • integer $pid: listing id
  • integer $buyerid: buyer id
  • integer $orderid: order id (if applicable)
print_payment_methods (line 881)

Function to print out a listings pre-defined payment methods.

This function can be used to show payment methods in a string or used to generate checkboxes based on a buyer payment selector process.

  • return: Returns HTML formatted string of payment method output or radio button input logic
string print_payment_methods ([integer $projectid = 0], [boolean $radiobuttons = false], [boolean $countonly = false])
  • integer $projectid: listing id
  • boolean $radiobuttons: print radio button logic (default false)
  • boolean $countonly: return the number of payment options only (default false)
print_payment_method_title (line 740)

Function to print the payment method title for an auction

This function will print the payment method title

  • return: Returns HTML formatted string
string print_payment_method_title ([integer $projectid = 0])
  • integer $projectid: auction listing id
print_shipping_address_pulldown (line 1608)

Function to print a shipping address pulldown menu based on the users personal details

  • return: Returns the HTML representation of the shipping address pulldown menu
string print_shipping_address_pulldown ([integer $userid = 0], [ $fieldname = 'shipping_address_id'], [ $class = ''])
  • integer $userid: user id
  • $fieldname
  • $class
print_shipping_address_text (line 1663)

Function to print a shipping address text based on the users personal details

  • return: Returns the HTML representation of the shipping address
string print_shipping_address_text ([integer $userid = 0])
  • integer $userid: user id
print_shipping_methods (line 37)

Function to print out a listings pre-defined shipping methods to a specific buyers location.

This function can be used to show payment methods in a string or used to generate radio boxes based on a buyer shipping selector process when multiple shipping services to a buyers location is defined.

  • return: Returns HTML formatted string of ship-to locations available to a specific buyers location
string print_shipping_methods ([integer $projectid = 0], [integer $qty = 1], [boolean $radiobuttons = false], [boolean $countonly = false], [ $pulldownmenu = false])
  • integer $projectid: listing id
  • integer $qty: order quantity (default 1)
  • boolean $radiobuttons: print radio button logic (default false)
  • boolean $countonly: return the number of shipping options only (default false)
  • $pulldownmenu
print_shipping_partner (line 1809)

Function to print the actual shipping partner based on a supplied shipping partner id

  • return: Returns HTML presentation
boolean print_shipping_partner ([integer $partnerid = 0])
  • integer $partnerid: shipping partner id
process_profile_questions (line 1701)

Function to process profile questions which is ultimately updated or inserted as new data within the database.

nothing process_profile_questions (array &$custom, [integer $userid = 0])
  • array &$custom: answers (keys and values)
  • integer $userid: user id

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