Docs For Class escrow

Description

Escrow class to perform the majority of escrow and related payment functions in ILance

author: ILance
version: $Revision: 1.0.0 $

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

Direct descendents

Class	Description
escrow_buynow	Function to handle escrow payments for buy now items
escrow_handler	Function to handle escrow activity
escrow_payment	Function to handle escrow payments

Method Summary

void cancel_unlinked_escrow_invoices ()

string fetch_escrow_commission ([string $ctype = ''])

string fetch_escrow_commission_logic ([string $ctype = ''])

string fetch_escrow_opponent ([integer $projectid = 0], [integer $invoiceid = 0], [string $mode = ''])

string fetch_escrow_owner ([integer $projectid = 0], [integer $invoiceid = 0], [string $mode = ''])

bool status ([integer $projectid = 0])

Methods

cancel_unlinked_escrow_invoices (line 397)

Function to find all escrow related invoices and check the escrow table for a match if we do not have a match,

chances are the escrow account was not created or the admin removed the invoiceid # in the escrow table tied to the auction .. so in these situations we'll set that invoice to 'cancelled'

void cancel_unlinked_escrow_invoices ()

fetch_escrow_commission (line 212)

Function to fetch the escrow commission amount defined by the admin based on a custom commission argument.

return: calculated amount

string fetch_escrow_commission ([string $ctype = ''])

string $ctype: commission type

fetch_escrow_commission_logic (line 305)

Function to fetch the escrow commission logic defined by the admin based on a custom commission argument.

return: returns a string (fixed/percentage)

string fetch_escrow_commission_logic ([string $ctype = ''])

string $ctype: commission type

fetch_escrow_opponent (line 157)

Function to obtain the opponent's username of an escrow account between a buyer and seller.

return: username of escrow opponent

string fetch_escrow_opponent ([integer $projectid = 0], [integer $invoiceid = 0], [string $mode = ''])

integer $projectid: auction id
integer $invoiceid: invoice id
string $mode: mode (service or product)

fetch_escrow_owner (line 98)

Function to obtain the owner of an escrow account.

return: username of escrow account owner

string fetch_escrow_owner ([integer $projectid = 0], [integer $invoiceid = 0], [string $mode = ''])

integer $projectid: auction id
integer $invoiceid: invoice id
string $mode: mode (service or product)

status (line 32)

Function to fetch the escrow status

return: Returns the status of the escrow account

bool status ([integer $projectid = 0])

integer $projectid: project id