Docs for page functions.php

/core/functions.php

Description

Core Functions in ILance to perform the majority operations within the Front End and Admin Control Panel.

author: ILance
version: $Revision: 1.0.0 $

Functions

add_category_viewcount (line 1633)

Function to increment a category's view count + 1. This function now supports recursively tracking all views within a parent and child relationship.

nothing add_category_viewcount ([integer $cid = 0], [string $mode = 'add'])

integer $cid: category id
string $mode: mode (add or subtract) default add

build_category_count (line 1689)

Function to handle the auction counts within category logic. This function is usually called after a new auction is added or removed from the system.

Additionally, this function works recursively.

nothing build_category_count ([integer $cid = 0], [string $mode = 'add'], [ $notes = ''])

integer $cid: category id
string $mode: mode (add or subtract)
$notes

build_user_session (line 4170)

Function to build a valid user session after successful sign-in. This function was created because we've implemented the new admin user switcher and it's pointless to handle 2 large pieces of code for session building- so this was created.

nothing build_user_session ([array $userinfo = array()])

array $userinfo: array of user from the database

can_display_financials (line 1501)

Function to determine if we can display the financials for a particular user (if they allow it from their profile menu)

return: Returns true or false

bool can_display_financials ([integer $userid = 0])

integer $userid: user id

cloud_tags_alphasort (line 2386)

Function to compile and process alpha sorting based on a keywords array

return: Returns HTML formatted top search keywords cloud

string cloud_tags_alphasort (array $tag1, array $tag2)

array $tag1: first tag array
array $tag2: second tag array

cloud_tags_asort (line 2368)

Function to compile and process ascending sorting based on a keywords array

return: tag count

string cloud_tags_asort (array $tag1, array $tag2)

array $tag1: first tag array
array $tag2: second tag array

construct_account_bonus (line 654)

Function to generate an account bonus feature to a particular user

return: Returns the amount (if any) of the account bonus rate

string construct_account_bonus ([integer $userid = 0], [string $mode = 'active'])

integer $userid: user id
string $mode: mode (active, inactive, etc)

construct_account_number (line 635)

Function to generate a unique user account number for the billing and payments system

return: Returns a formatted account number

string construct_account_number ()

construct_country_pulldown (line 3439)

Function to construct a country pulldown menu

return: HTML formatted country pulldown menu

string construct_country_pulldown ([integer $countryid = 0], [string $countryname = ''], [string $fieldname = 'country'], [boolean $disablestates = false], [string $statesfieldname = 'state'], [boolean $showworldwide = false], [boolean $usacanadafirst = false], [boolean $regionsonly = false], [ $statesdivid = 'stateid'], [ $onlyiso = false])

integer $countryid: country id
string $countryname: country name
string $fieldname: country fieldname
boolean $disablestates: disable states pulldown (default false)
string $statesfieldname: states field name
boolean $showworldwide: show worldwide as an option (default false)
boolean $usacanadafirst: show usa/canada at top of list (default false)
boolean $regionsonly: output option code as regions instead of countries (default false)
$statesdivid
$onlyiso

construct_form_name (line 624)

Function to generate a random form field name based on a supplied character length limit

return: Returns the random form field name

string construct_form_name ([integer $length = 10])

integer $length: length (default 10)

construct_state_pulldown (line 3492)

Function to construct a state pulldown menu

return: HTML formatted state pulldown menu

string construct_state_pulldown ([ $locationid = ''], [ $statename = ''], [ $fieldname = 'state'])

$locationid
$statename
$fieldname

construct_transaction_id (line 1415)

Function to create a unique transaction id used within the billing and payment system

return: Returns unique transaction id

string construct_transaction_id ()

construct_username_bits (line 1761)

Function to process and print out a username bit with icons based on various bits of information

return: Formatted text

string construct_username_bits ([integer $userid = 0])

integer $userid: user id

convert_int2utf8 (line 71)

Converts an integer into a UTF-8 string

string convert_int2utf8 (integer $intval)

integer $intval: Integer to be converted into utf8

convert_unicode_char_to_charset (line 2155)

Callback function for convert_urlencoded_unicode() which will also use iconv library if installed

return: Returns a numeric entity

string convert_unicode_char_to_charset (string $unicodeint, string $charset)

string $unicodeint: hexidecimal character
string $charset: character set

convert_urlencoded_unicode (line 2182)

Function to conver a urlencoded string into unicode for formatting purposes

return: Returns a formatted unicode string

string convert_urlencoded_unicode (string $text)

string $text: text

create_referral_code (line 610)

Function to generate a referral code based on a limiter argument

return: Returns the formatted referral code

string create_referral_code ([integer $length = 6])

integer $length: length limiter

cutstring (line 146)

Function to cut a string of characters apart using an argument limiter as the amount of characters to cut between

return: HTML representation of the string which has been cut

string cutstring ([string $string = ''], integer $limit)

string $string: html string
integer $limit: limiter amount (ie: 50)

decrypt_url (line 1379)

Function to decrypt a url

return: decoded url array

array decrypt_url ([string $encrypted = ''])

string $encrypted: encoded url

display_profile (line 2074)

Function to determine if we can display the profile of a particular user

return: Returns true or false

string display_profile ([integer $userid = 0])

integer $userid: user id

encrypt_url (line 1363)

Function to encrypt a url

return: encoded url

string encrypt_url ([array $array = array()])

array $array: url array

format_zipcode (line 3801)

Function to format a zipcode for ILance by removing spaces and dashes

return: Returns HTML formatted string

string format_zipcode ([string $zipcode = ''])

string $zipcode: zip code to format

handle_input_keywords (line 3627)

Function to convert javascript tags to entities

return: HTML formatted string

string handle_input_keywords ([ $text = ''], [ $entities = false])

$text
$entities

has_answered_profile_questions (line 2088)

Function to determine if a particular user has answered any profile questions.

return: Returns true or false

string has_answered_profile_questions ([integer $userid = 0])

integer $userid: user id

has_portfolio (line 980)

Function to determine if a user has a portfolio setup

return: Returns true or false

bool has_portfolio ([integer $userid = 0])

integer $userid: user id

ilance_htmlentities (line 3639)

Encodes HTML safely for UTF-8. Use instead of htmlentities.

return: Returns a valid UTF-8 string

string ilance_htmlentities ([ $text = ''], string $var)

string $var
$text

init_referral_tracker (line 231)

Function to initialize the referral code tracking system

void init_referral_tracker ()

init_server_overload_checkup (line 3140)

Function to init server overload checkup on Linux/Unix machines

return: returns true or false if server is overloaded

boolean init_server_overload_checkup ()

insert_income_reported (line 1440)

Function to track income reported for a particular user for a certain amount based on a certain action.

nothing insert_income_reported ([integer $userid = 0], [integer $amount = 0], [string $action = ''])

integer $userid: user id
integer $amount: amount to process
string $action: action to perform (credit or debit)

insert_income_spent (line 1472)

Function to track income spent for a particular user for a certain amount based on a certain action.

nothing insert_income_spent ([integer $userid = 0], [integer $amount = 0], [string $action = ''])

integer $userid: user id
integer $amount: amount to process
string $action: action to perform (credit or debit)

insert_public_message (line 790)

Function to insert a public message from a detailed auction page

void insert_public_message ([integer $projectid = 0], [integer $sellerid = 0], [integer $fromid = 0], [string $username = ''], [string $message = ''], [integer $visible = '1'])

integer $projectid: project id
integer $sellerid: seller id
integer $fromid: from id
string $username: user name
string $message: message being posted
integer $visible: is visible?

invoice_payment_handler (line 3733)

Function to handle all related invoice payments in ILance.

return: Returns true or false

mixed invoice_payment_handler ([integer $invoiceid = 0], [string $invoicetype = 'debit'], [integer $amount = 0], [integer $userid = 0], [string $paymethod = 'account'], [string $gateway = ''], [string $gatewaytxn = ''], [boolean $silentmode = false])

integer $invoiceid: invoice id
string $invoicetype: invoice type
integer $amount: amount
integer $userid: user id
string $paymethod: payment method (default account)
string $gateway: payment gateway (default blank)
string $gatewaytxn: payment gateway return transaction id
boolean $silentmode: silent mode (default false; when true it returns only true or false responses)

ip_address_banned (line 3044)

Function to determine if a particular ip address being supplied is banned. This function takes the ip blacklist from the admin cp into consideration.

return: Returns true or false

string ip_address_banned ([integer $ipaddress = ''])

integer $ipaddress: ip address

ip_address_excluded (line 3094)

Function to determine if a particular ip address being supplied is excluded from being blocked during maintenance mode.

return: Returns true or false

string ip_address_excluded ([integer $ipaddress = ''])

integer $ipaddress: ip address

is_bidder_invited (line 3325)

Function to determine if a bidder is invited to an invite only project

return: returns true or false if bidder is invited

boolean is_bidder_invited ([integer $userid = 0], [integer $projectid = 0])

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

is_duplicate_txn_id (line 2291)

Function to determine if a transaction id being passed already exists within the invoice and billing system

return: Returns true or false

boolean is_duplicate_txn_id ([string $txn_id = ''])

string $txn_id: transaction id

is_inviteonly_auction (line 2269)

Function to determine if a particular auction event is by invitation only

return: Returns true or false

boolean is_inviteonly_auction ([integer $projectid = 0])

integer $projectid: project id

is_last_category (line 2981)

Function to respond as true or false based on the supplied category being the last category (leaf) in the category tree.

return: Returns true or false

string is_last_category ([integer $cid = 0])

integer $cid: category id

is_postable_category (line 3007)

Function to respond as true or false based on the supplied category being the last category (leaf) in the category tree.

return: Returns true or false

string is_postable_category ([integer $cid = 0])

integer $cid: category id

is_profile_cat_prepared (line 3310)

Function to determine if a user's profile within the selected category exists or not

return: returns true or false if profile category is prepared

boolean is_profile_cat_prepared ([integer $userid = 0], [integer $cid = 0])

integer $userid: user id
integer $cid: category id

is_question_multiplechoice (line 2690)

Function to determine if a question is multiple choice

return: Returns true or false

boolean is_question_multiplechoice ([integer $qid = 0], [string $mode = ''])

integer $qid: question id
string $mode: mode (register, project, product or profile)

is_sealed_auction (line 2240)

Function to determine if a particular auction event has sealed bidding enabled

return: Returns true or false

boolean is_sealed_auction ([integer $projectid = 0])

integer $projectid: project id

is_search_crawler (line 3163)

Function to determine if the current user is a search engine or real user based on the crawlers.xml robot file

return: returns true or false if server is overloaded

boolean is_search_crawler ()

is_serialized (line 3297)

Function to determine if a string being supplied is already php serailzed() or not

return: returns true or false

boolean is_serialized ([ $data = ''])

$data

is_valid_email (line 2204)

Function to determine if a supplied email address is valid based on it's apperence

return: Returns true or false if email address is valid

string is_valid_email ([string $email = ''])

string $email: email address

is_valid_project_id (line 2216)

Function to determine if a project id being specified is actually a valid auction listing id

return: Returns true or false

boolean is_valid_project_id ([integer $projectid = 0])

integer $projectid: project id

log_event (line 172)

Function to log an event based on a particular action engaged by a user data mined within the AdminCP > Audit Manager

nothing log_event ([integer $userid = 0], [string $script = ''], [string $cmd = ''], [string $subcmd = ''], [string $otherinfo = ''])

integer $userid: user id
string $script: script
string $cmd: cmd invoked
string $subcmd: sub cmd invoked
string $otherinfo: message of action performed

members_online (line 2747)

Function to calculate the sum of the total users logged into the marketplace

return: Returns total members online count in phrase format (ie: 3 members online)

string members_online ([integer 0 = user id])

integer 0: user id

move_listing_category_from_to (line 4081)

Function to move a listing from one category to another category within the marketplace.

return: Returns true or false if listing was moved to the new category

string move_listing_category_from_to ([integer $pid = 0], [integer $old_catid = 0], [integer $cid = 0], [string $ctype = ''], [string $old_status = ''], [string $status = ''])

integer $pid: listing id
integer $old_catid: old category id
integer $cid: new category id
string $ctype: new category type
string $old_status: old listing status
string $status: new listing status

parse_php_in_html (line 1013)

Function to handle parsing PHP code internally for add-on and product support in ILance and accepts code with or without <?php and ?> tags

return: Returns mixed output

mixed parse_php_in_html (string $html_str)

string $html_str: php code to parse

parse_youtube_video_url (line 3713)

Function to parse and recreate a user-supplied youtube cut n' paste url

return: returns true or false

boolean parse_youtube_video_url ([string $url = ''])

string $url: youtube video url

physically_remove_listing (line 4363)

Function to physically remove a listing from the marketplace generally used within the admin control panel.

return: Returns true

boolean physically_remove_listing ([integer $value = 0])

integer $value: listing id to remove

print_abuse_type_pulldown (line 3207)

Function to print out the abuse type pulldown menu letting a user select a pre-defined abuse type

return: returns true or false if string is seralized

boolean print_abuse_type_pulldown ([string $abusetype = 'listing'], [integer $abuseid = 0])

string $abusetype: abuse type (listing, bid, portfolio, profile)
integer $abuseid: abuse iddentifier (listing id, bid id, profile id, portfolio id, etc)

print_active_bankaccount_options (line 1126)

Function for printing only the <option> values for active bank deposit accounts file for the user.

Additionally, this function will present a withdrawal fee defined by the admin within the admincp.

return: HTML representation of the options

string print_active_bankaccount_options ([integer $userid = 0])

integer $userid: user id

print_active_creditcard_options (line 1045)

Function for printing only the <option> values for active credit cards on file for the user.

return: HTML representation of the options

string print_active_creditcard_options ([integer $userid = 0])

integer $userid: user id

print_active_ipn_options (line 1168)

Function for printing only the <option> values for enabled ipn gateway processor methods

return: HTML representation of the options

string print_active_ipn_options ([string $area = ''])

string $area: the custom location we are parsing this function from

print_active_offline_deposit_methods (line 1218)

Function for printing only the <option> values for enabled offline deposit processor methods

return: HTML representation of the options

string print_active_offline_deposit_methods ()

print_array_to_datetime (line 899)

Function that will take an date array and rebuild into a valid date time string

return: Returns valid date and time string

string print_array_to_datetime (array $date, [ $time = ''])

array $date: date array
$time

print_auction_bit (line 2316)

Function to print out in verbose terms the auction bit (type of auction). This function now takes service and product into consideration.

return: Returns phrase based on the auction event type

string print_auction_bit ([integer $projectid = 0], [ $filtered_auctiontype = ''], [ $project_details = ''], [ $project_state = ''], [ $buynow_price = ''], [ $buynow_qty = ''], [ $reserve = 0], [ $cid = 0])

integer $projectid: project id
$filtered_auctiontype
$project_details
$project_state
$buynow_price
$buynow_qty
$reserve
$cid

print_auction_location (line 4288)

Function to print the listing location bit based on a particular listing id.

return: Returns HTML representation of the listing location bit

string print_auction_location ([integer $pid = 0], [integer $slng = 'eng'], [string $country = ''], [string $state = ''], [string $city = ''], [string $zip = ''])

integer $pid: listing id
integer $slng: short language identifier (i.e.: eng)
string $country: supplied country name
string $state: supplied state name
string $city: supplied city name
string $zip: supplied zip code name

print_auction_status (line 2502)

Function to print an auction event status phrase

return: Returns auction event status phrase

string print_auction_status ([string $status = ''])

string $status: status type (draft, open, closed, expired, delisted, wait_approval, approval_accepted, frozen, finished or archived)

print_boolean (line 3030)

Produces the phrase enabled or disabled based on a supplied boolean value

string print_boolean ( $value)

$value

print_charities_pulldown (line 3367)

Function to print the various charities within a pulldown menu

return: Returns HTML formatted presentation of a pulldown menu

string print_charities_pulldown ([integer $charityid = 0])

integer $charityid: (optional) charity id to be as default selection

print_convert_to_timestamp (line 887)

Function wrapper for strtotime

return: Returns strtotime formatted string

string print_convert_to_timestamp (string $str)

string $str: date range

print_country_name (line 1951)

Function to print a country name based on a supplied country id and a short language identifier to display the proper country name in the appropriate language

return: Returns the user's country name

string print_country_name (integer $countryid, [string $slng = 'eng'], [boolean $shortform = false])

integer $countryid: country id
string $slng: short language identifier (default eng)
boolean $shortform: short form output? (default false)

print_date (line 918)

Function to handle display the date and time within ILance

return: Returns the formatted strftime() date and time string including a timezone identifier if requested

string print_date (string $datetime, [string $format = ''], [bool $showtimezone = false], [bool $yesterdaytoday = false])

string $datetime: date and time string
string $format: format of string (optional)
bool $showtimezone: should we show the time zone in the string?
bool $yesterdaytoday: should we treat the date display with "Yesterday and Today" instead of the actual date?

print_datetime_from_timestamp (line 875)

Function to print a valid date and time string based on a unix timestamp

return: Returns formatted date time string (YYYY-MM-DD HH:MM:SS)

string print_datetime_from_timestamp (integer $time)

integer $time: unix timestamp

print_donation_percentage (line 3404)

Function to print the donation percentage pulldown menu

return: Returns HTML formatted presentation of a pulldown menu

string print_donation_percentage ([ $percentage = 0])

$percentage

print_filesize (line 760)

Function to print a human-readable filesize based on bytes being sent as an argument

return: Returns formatted filesize like 1.3KB, 2.5MB, 1.7GB, etc

string print_filesize ([integer $bytes = 0])

integer $bytes: size in bytes

print_income_reported (line 428)

Function to fetch and print the total income reported by a particular user

return: Returns the formatted income reported string (ie: USD$50,000.00)

string print_income_reported ([integer $userid = 0])

integer $userid: user id

print_income_spent (line 466)

Function to fetch and print the total income spent by a particular user

return: Returns the formatted income spent string (ie: USD$50,000.00)

string print_income_spent ([integer $userid = 0])

integer $userid: user id

print_item_photo (line 1532)

Function to print an item photo via <img src> for a particular auction id

return: Returns HTML representation of the item photo via <img src> tag

bool print_item_photo ([string $url = 'javascript:void(0)'], [string $mode = ''], [integer $projectid = 0], [integer $borderwidth = '0'], [string $bordercolor = '#ffffff'], [integer $start_from_image = 0], [ $attachtype = ''])

string $url: url where the photo should link to
string $mode: mode (thumb, full, checkup)
integer $projectid: auction id
integer $borderwidth: border width
string $bordercolor: border color (default #ffffff)
integer $start_from_image: if there are mulitple photos it is a photo id to read
$attachtype

print_js_cities_pulldown (line 2841)

Function to print the states pulldown menu using the dynamic javascript.

return: Returns the Cities within a selected province pulldown menu

string print_js_cities_pulldown ([string $fieldname = ''], [bool $dojs = false], [string $jscountryname = ''], [string $jsstatename = ''], [string $jscityname = ''], [string $formid = ''])

string $fieldname: field name of the city pulldown menu
bool $dojs: do javascript (default false)
string $jscountryname: javascript country checkbox fieldname
string $jsstatename: javascript state checkbox fieldname
string $jscityname: javascript city checkbox fieldname
string $formid: form id

print_js_countries_pulldown (line 2785)

Function to print the countries pulldown menu using the dynamic javascript method of pre-populating states as well.

return: Returns the Country pulldown menu

string print_js_countries_pulldown ([string $fieldname = ''], [string $statefieldname = ''], [string $cityfieldname = ''], [bool $dojs = false], [string $jscountryname = ''], [string $jsstatename = ''], [string $jscityname = ''], [string $formid = ''])

string $fieldname: field name of the country pulldown menu
string $statefieldname: field name of the state pulldown menu
string $cityfieldname: field name of the city pulldown menu
bool $dojs: do javascript (default false)
string $jscountryname: javascript country checkbox fieldname
string $jsstatename: javascript state checkbox fieldname
string $jscityname: javascript city checkbox fieldname
string $formid: form id

print_js_pulldown_end (line 2868)

Function to print the ending javascript for the dynamic country and states pulldown menu.

return: Returns the Javascript

string print_js_pulldown_end ([string $countryfieldname = ''], [string $statefieldname = ''], [string $cityfieldname = ''], [string $selectedcountry = ''], [string $selectedstate = ''], [string $selectedcity = ''], [ $formid = ''], [ $focus = ''])

string $countryfieldname: field name of the country pulldown menu
string $statefieldname: field name of the state pulldown menu
string $cityfieldname: javascript selected country name
string $selectedcountry: javascript selected state name
string $selectedstate: form id
string $selectedcity: focus field
$formid
$focus

print_js_states_pulldown (line 2813)

Function to print the states pulldown menu using the dynamic javascript.

return: Returns the States/Provinces pulldown menu

string print_js_states_pulldown ([string $fieldname = ''], [string $cityfieldname = ''], [bool $dojs = false], [string $jscountryname = ''], [string $jsstatename = ''], [string $jscityname = ''], [string $formid = ''])

string $fieldname: field name of the state pulldown menu
string $cityfieldname: field name of the city pulldown menu
bool $dojs: do javascript (default false)
string $jscountryname: javascript country checkbox fieldname
string $jsstatename: javascript state checkbox fieldname
string $jscityname: javascript city checkbox fieldname
string $formid: form id

print_latest_feedback_received (line 849)

Function to print the latest feedback received based on a particular user

return: Returns HTML representation of the latest feedback response received

string print_latest_feedback_received ([integer $userid = 0], [string $feedbacktype = ''], [ $shownone = false])

integer $userid: user id
string $feedbacktype: feedback type (service/product)
$shownone

print_listing_video (line 2939)

Function to print the ending javascript for the dynamic country and states pulldown menu.

return: Returns the profile video

string print_listing_video ([integer $projectid = 0], [integer $videowidth = '290'], [integer $videoheight = '240'], [string $scriptextra = ''])

integer $projectid: user id
integer $videowidth: video width (default 290px)
integer $videoheight: video height (default 240px)
string $scriptextra: additional custom script code

print_next_category (line 3832)

Function to print the next category box for the AJAX category selector

return: Returns HTML formatted string

string print_next_category ([integer $cid = 0], [string $box = ''], [string $cidfield = 'cid'], [boolean $showcontinue = 1], [boolean $showthumb = 1], [boolean $showcidbox = 1], [boolean $showyouselectedstring = 1], [boolean $readonly = 0], [boolean $showcheckmarkafterstring = 1], [boolean $categoryfinderjs = 0], [integer $id = 0], [string $cmd = ''], [boolean $rss = 0], [boolean $news = 0], [boolean $showaddanother = 0], [boolean $categoryfinderapi = 0])

integer $cid: category id
string $box: box identifier
string $cidfield: category string identifier
boolean $showcontinue: show continue button? (default 1 = true)
boolean $showthumb: show thumb's up icon (default 1 = true)
boolean $showcidbox: show the category id mini box to the far right bottom (default 1 = yes)
boolean $showyouselectedstring: show the you selected x category string (default 1 = yes)
boolean $readonly: read-mode only (default 0 = false)
boolean $showcheckmarkafterstring: show the checkmark after the you selected x category (default 1 = yes)
boolean $categoryfinderjs: show the default category finder javascript logic handler (default 0 = false)
integer $id: id
string $cmd: cmd action string
boolean $rss: do rss (default 0 = false)
boolean $news: do news (default 0 = false)
boolean $showaddanother: show add another category link (default 0 = false) mainly used in preferences > category notifications
boolean $categoryfinderapi: show our category finder output in API mode (so sellers know how to use it within bulk CSV files) (default 0 = false)

print_notice (line 34)

Function to print a viewable notice template to the web browser using the regular ILance template parsed with the header and footer

return: Message with domain phrases blocked

string print_notice ([string $header_text = ''], [string $body_text = ''], [string $return_url = ''], [string $return_name = ''], [ $custom = ''])

string $header_text: header text
string $body_text: body text
string $return_url: return url
string $return_name: return url title
$custom

print_online_status (line 513)

Function to print the online status of a particular user. This function is also LanceAlert ready where if the user is online and logged into the app it will show the online status of the IM user status (away, busy, online, dnd, etc) vs the status of online or offline

return: Returns the HTML representation of the online status

string print_online_status ([integer $userid = 0], [string $offlinecolor = ''], [string $onlinecolor = ''])

integer $userid: user id
string $offlinecolor: offline user color (example: gray)
string $onlinecolor: online user color (example: green)

print_paymethod_icon (line 3555)

Function to print out a payment method icon

return: HTML formatted image (<img> tag)

string print_paymethod_icon ([ $paymethod = 'account'], [ $showicon = true])

$paymethod
$showicon

print_paymethod_method (line 3612)

Function to print out a payment method type based on a valid transaction

return: HTML formatted image (<img> tag)

string print_paymethod_method ([integer $invoiceid = 0])

integer $invoiceid: invoice id

print_paymethod_pulldown (line 1258)

Function for printing the appropriate payment processor options within the payment menu pulldown's

return: HTML representation of the pulldown menu

string print_paymethod_pulldown ([string $location = ''], [string $fieldname = 'paymethod'], [integer $userid = 0], [string $javascript = ''])

string $location: the custom location we are parsing this function from
string $fieldname: fieldname of the pulldown selection menu (paymethod is default)
integer $userid: user id
string $javascript: javascript string to include in the onchange event

print_paymethod_source (line 3578)

Function to print out a payment method funding source based on a valid transaction

return: HTML formatted image (<img> tag)

string print_paymethod_source ([integer $invoiceid = 0])

integer $invoiceid: invoice id

print_paymethod_target (line 3595)

Function to print out a payment method funding target based on a valid transaction

return: HTML formatted image (<img> tag)

string print_paymethod_target ([integer $invoiceid = 0])

integer $invoiceid: invoice id

print_profile_video (line 2894)

Function to print the ending javascript for the dynamic country and states pulldown menu.

return: Returns the profile video

string print_profile_video ([integer $userid = 0], [integer $videowidth = '320'], [integer $videoheight = '240'])

integer $userid: user id
integer $videowidth: video width (default 290px)
integer $videoheight: video height (default 240px)

print_referred_by_username (line 4329)

Function to print a referred by "username" using plain text mode or href url link edition.

return: Returns HTML representation of the username

string print_referred_by_username ([integer $refererid = 0], [boolean $acplink = false])

integer $refererid: user id of the referrer
boolean $acplink: show admin control panel url link? (default false)

print_string_wrap (line 1747)

Function to break up a long string with no spaces based on a supplied character limit Upgraded to be aware of multibyte UTF-8 encoded strings

return: Formatted text

string print_string_wrap ([string $str = ''], [integer $width = 65], [ $break = ' '])

string $str: text
integer $width: chracter limit to break up
$break

print_subscription_renewal_datetime (line 2136)

Function to print the subscription renewal date/timestamp based on days.

return: Returns datetime stamp (ie: 2007-02-01 22:00:00)

string print_subscription_renewal_datetime (integer $days)

integer $days: days

print_tag_cloud (line 2441)

Function to print a HTML formatted top search keywords tag cloud with the most searched in various font sizes and attributes

return: Returns HTML formatted top search keywords cloud

string print_tag_cloud ()

print_transaction_type (line 2020)

Function to print an invoice type phrase based on the currently selected language

return: Returns formatted final value feee (if applicable)

string print_transaction_type ([string $invoicetype = ''])

string $invoicetype: invoice type (subscription, commission, p2b, buynow, credential, debit, credit, escrow, refund or storesubscription)

print_unit (line 1986)

Function to fetch a user's email address from the datastore based on an actual user id

return: Returns the actual unit type phrase in the appropriate language

string print_unit ([string $unit = ''])

string $unit: unit type (D, M or Y)

print_username (line 1823)

Function to print a user's username based on seo and other elements such as icons, subscription info, etc

return: Returns a formatted version of the user's username

string print_username ([integer $userid = 0], [string $mode = 'href'], [boolean $bold = 0], [string $extra = ''], [string $extraseo = ''], [string $displayname = ''])

integer $userid: user id
string $mode: mode
boolean $bold: is bold? (default false)
string $extra: extra info
string $extraseo: extra seo info
string $displayname: display name

print_user_country (line 1922)

Function to print a user's country based on a supplied user id and a short language identifier to display the proper country name in the appropriate language

return: Returns the user's country name

string print_user_country (integer $userid, [string $slng = 'eng'])

integer $userid: user id
string $slng: short language identifier (default eng)

print_user_location (line 4243)

Function to print the user location bit based on a particular user id.

return: Returns HTML representation of the user location bit

string print_user_location ([integer $uid = 0], [integer $slng = 'eng'], [string $country = ''], [string $state = ''], [string $city = ''], [string $zip = ''])

integer $uid: user id
integer $slng: user short language identifier (i.e.: eng)
string $country: supplied country name
string $state: supplied state name
string $city: supplied city name
string $zip: supplied zip code name

process_cloud_tags (line 2401)

Function to compile and process an array with top keywords for presentation

return: Returns HTML formatted top search keywords cloud

string process_cloud_tags ( $tags)

$tags

refresh (line 263)

Function to hard refresh a page and to show a please wait while we direct you to the specified location message

void refresh ([string $url = ''], [string $custom = ''])

string $url: url to send user
string $custom: custom argument (unused)

shorten (line 123)

Function to shorten a string of characters using an argument limiter as the amount of characters to reveal

return: HTML representation of the shortened string

string shorten ([string $string = ''], integer $limit)

string $string: html string
integer $limit: limiter amount (ie: 50)

short_string (line 391)

Function to shorten a string based on a supplied argument length to cut off as well as a custom symbol to represent at the end of the string (ie: .....)

return: Returns the formatted text with the ending limiter symbol to represent more text is available

string short_string ([string $text = ''], integer $length, [string $symbol = ' .....'])

string $text: text
integer $length: limiter length
string $symbol: limiter symbol (ie: .....)

un_htmlspecialchars (line 105)

Function to return a string where HTML entities have been converted to their original characters

string un_htmlspecialchars ([string $text = ''], [bool $parseunicode = false])

string $text: html string to parse
bool $parseunicode: convert unicode string back from HTML entities?

update_referral_action (line 2531)

Function to update a specific referred user (from a rid referral) with a particular action being taken

nothing update_referral_action ([string $type = ''], [integer $userid = 0], [boolean $dontsendemail = 0])

string $type: referral action type (postauction, awardauction, fvf, ins, lanceads, portfolio, credential, enhancement or subscription)
integer $userid: user id
boolean $dontsendemail: don't dispatch email on completion (default false)

update_untranslated_phrases_to_master (line 3661)

Function to update untranslated phrases to their master phrase so translators can have something to work from (instead of a blank phrase) This script is used when languages are being imported from AdminCP and when a old version of ILance is being upgraded to a newer version

nothing update_untranslated_phrases_to_master ()

verify_referral_clickthrough (line 201)

Function to verify a referral clickthrough based on a supplied referral code being passed as one of the arguments

void verify_referral_clickthrough ([string $clientip = ''], [string $clientbrowser = ''], [string $clienturl = ''], [string $rid = ''])

string $clientip: ip address
string $clientbrowser: client browser agent
string $clienturl: client referrer location (where click came from)
string $rid: referral code being clicked

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