Class admincp

Description

AdminCP class to perform the majority of functions within the ILance Admin Control Panel

  • author: ILance
  • version: $Revision: 1.0.0 $

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


	
			
Direct descendents
Class Description
admincp_category AdminCP category system class to perform the majority category functions
admincp_importexport AdminCP importer handler for emails, language phrases and css styles within ILance.
admincp_products AdminCP Product Add-On system class to perform the majority install/uninstall related product functionality within ILance.
Method Summary
string activate_user ([array $ids = array()])
string api_phrasegroupname ([integer $phrasegroup = ''])
string auction_details_pulldown ([integer $selected = ''], [bool $showall = 0], [ $type = 'service'])
string auction_details_pulldown2 ([string $selected = ''], [bool $showall = 0], [string $type = 'product'])
string auction_state_pulldown ([integer $projectid = 0])
string auction_status_pulldown ([integer $selected = ''], [ $showall = true], [ $type = 'service'])
string ban_user ([array $ids = array()])
string cancel_user ([array $ids = array()])
string category_pulldown ([integer $cid = 0], [string $cattype = 'service'], [string $slng = 'eng'])
string construct_admin_input ([string $configgroup = ''], [ $returnurl = ''])
string construct_bidamounttypes ([integer $cid = 0], [boolean $entiredefault = 1])
string construct_budget_group_pulldown (string $budgetgroup, string $cattype)
string construct_csv_data (array $data, array $headings)
string construct_finalvalue_group_pulldown (string $finalvaluegroup, string $cattype)
string construct_html_table (array $data, array $headings)
string construct_increment_group_pulldown (string $incrementgroup, string $cattype)
string construct_insertion_group_pulldown (string $insertiongroup, string $cattype)
void construct_new_member ([string $username = ''], [string $password = ''], [string $salt = ''], [string $secretquestion = ''], [string $secretanswer = ''], [string $email = ''], [string $first = ''], [string $last = ''], [string $address = ''], [string $address2 = ''], [string $city = ''], [string $state = ''], [string $zipcode = ''], [string $phone = ''], [integer $country = ''], [string $dob = ''], [string $rid = ''], [integer $languageid = ''], [integer $currencyid = ''], [integer $usertimezone = ''], [boolean $usertimezone_dst = 0], [string $categories = ''], [integer $isadmin = 0])
string construct_parent_int_input ([integer $variableinfo = ''], [string $value = ''], [string $description = ''], [string $inputtype = ''], [string $class = 'alt1'], [ $sort = '0'], [ $help = ''])
string construct_parent_pulldown_input ([integer $variableinfo = ''], [string $value = ''], [string $description = ''], [string $inputtype = ''], [string $class = 'alt1'], [ $sort = '0'], [ $inputcode = ''], [ $help = ''])
string construct_parent_textarea_input ([integer $variableinfo = ''], [string $value = ''], [string $description = ''], [string $inputtype = ''], [string $class = 'alt1'], [ $sort = '0'], [ $help = ''])
string construct_parent_yesno_input ([integer $variableinfo = ''], [string $value = ''], [string $description = ''], [string $inputtype = ''], [string $class = 'alt1'], [ $sort = '0'], [ $help = ''])
string construct_paymodules_input ([string $configgroup = ''], [ $returnurl = ''])
string construct_paymodules_parent_int_input ([integer $id = 0], [string $value = ''], [string $description = ''], [string $inputtype = ''], [string $class = 'alt1'], [ $variableinfo = ''], [ $help = ''], [ $sort = 0], string $ilconfig[])
string construct_paymodules_parent_pass_input ([integer $id = 0], [string $value = ''], [string $description = ''], [string $inputtype = ''], [string $class = 'alt1'], [ $variableinfo = ''], [ $help = ''], [ $sort = 0], string $ilconfig[])
string construct_paymodules_parent_pulldown_input ([integer $id = 0], [string $value = ''], [string $description = ''], [string $inputtype = ''], [string $class = 'alt1'], [ $variableinfo = ''], [string $inputcode = ''], [ $help = ''], [ $sort = 0], string $ilconfig[])
string construct_paymodules_parent_textarea_input ([integer $id = 0], [string $value = ''], [string $description = ''], [string $inputtype = ''], [string $class = 'alt1'], [ $variableinfo = ''], [ $help = ''], [ $sort = 0], string $ilconfig[])
string construct_paymodules_parent_text_input ([integer $id = 0], [string $value = ''], [string $description = ''], [string $inputtype = ''], [string $class = 'alt1'], [ $variableinfo = ''], [ $help = ''], [ $sort = 0], string $ilconfig[])
string construct_paymodules_parent_yesno_input ([integer $id = 0], [string $value = ''], [string $description = ''], [string $inputtype = ''], [string $class = 'alt1'], [ $variableinfo = ''], [ $help = ''], [ $sort = 0], string $ilconfig[])
string construct_tsv_data (array $data, array $headings)
string decode_entities (string $text, [string $quote_style = ENT_COMPAT], [ $characterset = 'ISO-8859-1'])
string default_gateway_pulldown ([string $value = ''], [string $key = 'use_internal_gateway'])
string email_departments_pulldown ([ $selected = ''])
string fetch_auction_enhancements_list ([integer $projectid = 0])
integer fetch_budget_catcount (string $group)
string fetch_cron_schedule (array $cron)
void fetch_email_department_count ([ $departmentid = 0])
string fetch_email_department_title ([ $selected = ''])
integer fetch_fv_catcount (string $cattype, string $group)
integer fetch_increment_catcount (string $group)
integer fetch_insertion_budget_catcount (string $group)
integer fetch_insertion_catcount (string $cattype, string $group)
string fetch_language_name ([integer $languageid = 0])
array fetch_reporting_fields ( $sql,  $fields)
string fetch_task_varname (integer $cronid)
void insert_bid_increment ([string $from = 0], [string $to = 0], [string $amount = 0], [integer $cid = 0], [integer $sort = 0], [string $groupname = ''])
void insert_budget_group ([string $groupname = ''], [string $description = ''])
void insert_budget_range ([string $title = ''], [string $fieldname = ''], [string $budgetfrom = 0], [string $budgetto = 0], [integer $groupname = ''], [string $insgroupname = ''], [ $sort = 0])
void insert_fv_fee ([string $from = 0], [string $to = 0], [bool $amountfixed = 0], [bool $amountpercent = 0], [integer $sort = 100], [string $groupname = ''], [string $state = ''])
void insert_fv_group ([string $groupname = ''], [string $state = ''], [string $description = ''])
void insert_increment_group ([string $groupname = ''], [string $description = ''])
void insert_insertion_fee ([string $from = 0], [string $to = 0], [string $amount = 0], [string $groupname = ''], [integer $sort = 0], [string $state = ''])
void insert_insertion_group ([string $groupname = ''], [string $state = ''], [string $description = ''])
string phraselist_pulldown ([integer $phrasegroup = ''], [integer $languageid = 0])
string print_admincp_nav ([string $slng = 'eng'], [string $currenturl = ''])
string print_admincp_subnav ([string $rootnav = ''], [string $currenturl = ''], [string $slng = 'eng'])
string print_admins_pulldown ([string $selected = ''])
string print_audit_scripts_pulldown ([string $selected = ''])
string print_budget_group_pulldown ([string $selected = ''], [bool $shownoneselected = ''])
string print_fv_group_pulldown ([string $selected = ''], [bool $shownoneselected = ''], [string $state = ''])
string print_increment_group_pulldown ([string $selected = ''], [bool $shownoneselected = ''], [string $state = ''])
string print_insertion_group_pulldown ([integer $selected = ''], [bool $shownoneselected = 0], [string $state = ''], [ $fieldname = 'groupid'])
string print_invoicetype_pulldown ([string $invoicetype = ''], [ $fieldname = 'invoicetype'])
string print_members_pulldown ([string $selected = ''], [boolean $showallusers = 1])
string print_migrate_billing_pulldown ([string $selected = ''])
string print_migrate_to_pulldown ([string $selected = ''])
string print_moderation_pulldown ([string $value = ''], [string $variableinfo = ''])
string print_profile_filtertype_pulldown ([string $selected = ''])
string print_roletype_pulldown ([string $selected = ''])
string print_roleusertype_pulldown ([string $selected = ''])
string print_scheduled_tasks_pulldown ([string $selected = ''])
string print_version ()
string products_pulldown ([ $selected = 'ilance'])
void remove_bid_increment ([integer $id = 0])
void remove_budget_group ([integer $groupid = 0])
void remove_budget_range ([integer $budgetid = 0])
void remove_fv_fee ([integer $id = 0])
void remove_fv_group ([integer $id = 0])
void remove_increment_group ([integer $groupid = 0])
void remove_insertion_fee ([integer $id = 0])
void remove_insertion_group ([integer $id = 0])
void remove_registration_question ([integer $id = 0])
string remove_user ([array $ids = array()], [bool $removeinvoices = true], [bool $removelistings = true], [bool $removeescrow = true], [bool $removebuynoworders = true], [bool $removebids = true])
string scheduled_task_phrase (string $selected)
string suspend_user ([array $ids = array()])
string template_groups ()
string unsuspend_user ([array $ids = array()])
string unverify_user ([array $ids = array()])
void update_bid_increment ([integer $incrementid = 0], [string $from = 0], [string $to = 0], [string $amount = 0], [integer $cid = 0], [integer $sort = 0], [string $groupname = ''])
void update_budget_group ([integer $groupid = 0], [string $groupname = ''], [string $description = ''])
void update_budget_range ([integer $budgetid = 0], [string $title = ''], [string $budgetfrom = 0], [string $budgetto = 0], [integer $groupid = 0], [integer $insertiongroupid = '-1'], [ $sort = 10])
void update_fv_fee ([string $from = 0], [string $to = 0], [bool $amountfixed = 0], [bool $amountpercent = 0], [integer $groupid = 0], [integer $tierid = 0], [integer $sort = 10])
void update_increment_group ([integer $groupid = 0], [string $newgroupname = ''], [string $newdescription = ''])
void update_insertion_fee ([string $from = 0], [string $to = 0], [string $amount = 0], [integer $groupid = 0], [integer $insertionid = ''], [ $sort = 0])
Methods
activate_user (line 4161)

Function to activate single or multiple users from the marketplace

  • return: Returns HTML string of users activated separated by a comma for display purposes
string activate_user ([array $ids = array()])
  • array $ids: array with user ids flagged for activation
api_phrasegroupname (line 2209)

Function to fetch the description of a particular phrase group within the datastore

  • return: HTML representation of the pulldown menu with auction type values
string api_phrasegroupname ([integer $phrasegroup = ''])
  • integer $phrasegroup: phrase group
auction_details_pulldown (line 3219)

Function to generate a pulldown menu based on auction details.

  • return: HTML representation of the pulldown menu with auction type values
string auction_details_pulldown ([integer $selected = ''], [bool $showall = 0], [ $type = 'service'])
  • integer $selected: project id (or currently selected auction id value)
  • bool $showall: determines if we should display "Select all" as an option in the pulldown
  • $type
auction_details_pulldown2 (line 3249)

Function to generate a pulldown menu based on auction details.

  • return: HTML representation of the pulldown menu with auction type values
string auction_details_pulldown2 ([string $selected = ''], [bool $showall = 0], [string $type = 'product'])
  • string $selected: text which will be selected in the pulldown
  • bool $showall: determines if we should display "Select all" as an option in the pulldown
  • string $type: auction type service/product
auction_state_pulldown (line 3308)

Function to generate a pulldown menu based on auction state details.

  • return: HTML representation of the pulldown menu with auction state values
string auction_state_pulldown ([integer $projectid = 0])
  • integer $projectid: project id (or currently selected auction id value)
auction_status_pulldown (line 3272)

Function to generate a pulldown menu based on auction status details.

  • return: HTML representation of the pulldown menu with auction status values
string auction_status_pulldown ([integer $selected = ''], [ $showall = true], [ $type = 'service'])
  • integer $selected: project id (or currently selected auction id value)
  • $showall
  • $type
ban_user (line 4202)

Function to ban single or multiple users from the marketplace

  • return: Returns HTML string of users banned separated by a comma for display purposes
string ban_user ([array $ids = array()])
  • array $ids: array with user ids flagged for ban
cancel_user (line 4250)

Function to ban single or multiple users from the marketplace

  • return: Returns HTML string of users banned separated by a comma for display purposes
string cancel_user ([array $ids = array()])
  • array $ids: array with user ids flagged for ban
category_pulldown (line 1696)

Function to construct and print a category pulldown menu.

  • return: HTML representation of the category pulldown menu
string category_pulldown ([integer $cid = 0], [string $cattype = 'service'], [string $slng = 'eng'])
  • integer $cid: category id
  • string $cattype: category tyoe
  • string $slng: short language identifier (eng is default)
construct_admin_input (line 2685)

Function to print the admininstration configuration input template menus.

  • return: HTML representation of the configuration template
string construct_admin_input ([string $configgroup = ''], [ $returnurl = ''])
  • string $configgroup: config group
  • $returnurl
construct_bidamounttypes (line 2445)

Function to print out bid amount types

  • return: HTML representation of the bid amount types
string construct_bidamounttypes ([integer $cid = 0], [boolean $entiredefault = 1])
  • integer $cid: category id
  • boolean $entiredefault: set default type as entire project? (default true)
construct_budget_group_pulldown (line 2274)

Function to construct and print out the budget group pulldown menu

  • return: HTML representation of the pulldown menu
string construct_budget_group_pulldown (string $budgetgroup, string $cattype)
  • string $budgetgroup: budget group name
  • string $cattype: category type (service or product)
construct_csv_data (line 1633)

Function to construct and print comma separated data with predefined headings.

  • return: Text representation of the comma separated values
string construct_csv_data (array $data, array $headings)
  • array $data: data
  • array $headings: heading array
construct_escrow_balance (line 3733)
void construct_escrow_balance ()
construct_finalvalue_group_pulldown (line 2312)

Function to construct and print out the final value group pulldown menu

  • return: HTML representation of the pulldown menu
string construct_finalvalue_group_pulldown (string $finalvaluegroup, string $cattype)
  • string $finalvaluegroup: final value group name
  • string $cattype: category type (service or product)
construct_html_table (line 1429)

Function to construct and print an html table with predefined headings.

  • return: HTML representation of the html table
string construct_html_table (array $data, array $headings)
  • array $data: data
  • array $headings: heading array
construct_increment_group_pulldown (line 2352)

Function to construct and print out the increment group pulldown menu

  • return: HTML representation of the pulldown menu
string construct_increment_group_pulldown (string $incrementgroup, string $cattype)
  • string $incrementgroup: increment group name
  • string $cattype: category type (service or product)
construct_insertion_group_pulldown (line 2234)

Function to construct and print out the insertion group pulldown menu

  • return: HTML representation of the pulldown menu
string construct_insertion_group_pulldown (string $insertiongroup, string $cattype)
  • string $insertiongroup: insertion group name
  • string $cattype: category type (service or product)
construct_new_member (line 1777)

Function to create a new user.

void construct_new_member ([string $username = ''], [string $password = ''], [string $salt = ''], [string $secretquestion = ''], [string $secretanswer = ''], [string $email = ''], [string $first = ''], [string $last = ''], [string $address = ''], [string $address2 = ''], [string $city = ''], [string $state = ''], [string $zipcode = ''], [string $phone = ''], [integer $country = ''], [string $dob = ''], [string $rid = ''], [integer $languageid = ''], [integer $currencyid = ''], [integer $usertimezone = ''], [boolean $usertimezone_dst = 0], [string $categories = ''], [integer $isadmin = 0])
  • string $username: username
  • string $password: password
  • string $salt: password salt
  • string $secretquestion: secret question
  • string $secretanswer: secret answer
  • string $email: email
  • string $first: first name
  • string $last: last name
  • string $address: address 1
  • string $address2: address 2
  • string $city: city
  • string $state: state
  • string $zipcode: zip code
  • string $phone: phone number
  • integer $country: country id
  • string $dob: date of birth
  • string $rid: referral code
  • integer $languageid: language id
  • integer $currencyid: currency id
  • integer $usertimezone: timezone id
  • boolean $usertimezone_dst: use dst? (default disabled)
  • string $categories: newsletter categories (default none)
  • integer $isadmin: is admin (default off)
construct_parent_int_input (line 2840)

Function to print out a parents integer text input field

  • return: HTML representation of the integer text input selection
string construct_parent_int_input ([integer $variableinfo = ''], [string $value = ''], [string $description = ''], [string $inputtype = ''], [string $class = 'alt1'], [ $sort = '0'], [ $help = ''])
  • integer $variableinfo: configuration varname
  • string $value: value
  • string $description: description
  • string $inputtype: input type
  • string $class: class (default alt1)
  • $sort
  • $help
construct_parent_pulldown_input (line 2936)

Function to print out a parents pulldown menu input field

  • return: HTML representation of the integer textarea input selection
string construct_parent_pulldown_input ([integer $variableinfo = ''], [string $value = ''], [string $description = ''], [string $inputtype = ''], [string $class = 'alt1'], [ $sort = '0'], [ $inputcode = ''], [ $help = ''])
  • integer $variableinfo: configuration varname
  • string $value: value
  • string $description: description
  • string $inputtype: input type
  • string $class: class (default alt1)
  • $sort
  • $inputcode
  • $help
construct_parent_textarea_input (line 2894)

Function to print out a parents textarea text input field

  • return: HTML representation of the integer textarea input selection
string construct_parent_textarea_input ([integer $variableinfo = ''], [string $value = ''], [string $description = ''], [string $inputtype = ''], [string $class = 'alt1'], [ $sort = '0'], [ $help = ''])
  • integer $variableinfo: configuration varname
  • string $value: value
  • string $description: description
  • string $inputtype: input type
  • string $class: class (default alt1)
  • $sort
  • $help
construct_parent_yesno_input (line 2788)

Function to print out a parents "yes or no" input field (based on radio buttons)

  • return: HTML representation of the Yes/No radio button input selection
string construct_parent_yesno_input ([integer $variableinfo = ''], [string $value = ''], [string $description = ''], [string $inputtype = ''], [string $class = 'alt1'], [ $sort = '0'], [ $help = ''])
  • integer $variableinfo: configuration varname
  • string $value: value
  • string $description: description
  • string $inputtype: input type
  • string $class: class (default alt1)
  • $sort
  • $help
construct_paymodules_input (line 913)

Function to print the payment modules configuration input template menus.

  • return: HTML representation of the configuration template
string construct_paymodules_input ([string $configgroup = ''], [ $returnurl = ''])
  • string $configgroup: config group
  • $returnurl
construct_paymodules_parent_int_input (line 1061)

Function to print integer type settings.

  • return: HTML representation of the configuration template
string construct_paymodules_parent_int_input ([integer $id = 0], [string $value = ''], [string $description = ''], [string $inputtype = ''], [string $class = 'alt1'], [ $variableinfo = ''], [ $help = ''], [ $sort = 0], string $ilconfig[])
  • string $ilconfig[]: name
  • integer $id: config id
  • string $value: value
  • string $description: description
  • string $inputtype: input type
  • string $class: background color
  • $variableinfo
  • $help
  • $sort
construct_paymodules_parent_pass_input (line 1105)

Function to print password field type settings.

  • return: HTML representation of the configuration template
string construct_paymodules_parent_pass_input ([integer $id = 0], [string $value = ''], [string $description = ''], [string $inputtype = ''], [string $class = 'alt1'], [ $variableinfo = ''], [ $help = ''], [ $sort = 0], string $ilconfig[])
  • string $ilconfig[]: name
  • integer $id: config id
  • string $value: value
  • string $description: description
  • string $inputtype: input type
  • string $class: background color
  • $variableinfo
  • $help
  • $sort
construct_paymodules_parent_pulldown_input (line 1150)

Function to print pulldown selection menu field type settings.

  • return: HTML representation of the configuration template
string construct_paymodules_parent_pulldown_input ([integer $id = 0], [string $value = ''], [string $description = ''], [string $inputtype = ''], [string $class = 'alt1'], [ $variableinfo = ''], [string $inputcode = ''], [ $help = ''], [ $sort = 0], string $ilconfig[])
  • string $ilconfig[]: name
  • integer $id: config id
  • string $value: value
  • string $description: description
  • string $inputtype: input type
  • string $class: background color
  • string $inputcode: pulldown menu input code
  • $variableinfo
  • $help
  • $sort
construct_paymodules_parent_textarea_input (line 1127)

Function to print textarea field type settings.

  • return: HTML representation of the configuration template
string construct_paymodules_parent_textarea_input ([integer $id = 0], [string $value = ''], [string $description = ''], [string $inputtype = ''], [string $class = 'alt1'], [ $variableinfo = ''], [ $help = ''], [ $sort = 0], string $ilconfig[])
  • string $ilconfig[]: name
  • integer $id: config id
  • string $value: value
  • string $description: description
  • string $inputtype: input type
  • string $class: background color
  • $variableinfo
  • $help
  • $sort
construct_paymodules_parent_text_input (line 1083)

Function to print text field type settings.

  • return: HTML representation of the configuration template
string construct_paymodules_parent_text_input ([integer $id = 0], [string $value = ''], [string $description = ''], [string $inputtype = ''], [string $class = 'alt1'], [ $variableinfo = ''], [ $help = ''], [ $sort = 0], string $ilconfig[])
  • string $ilconfig[]: name
  • integer $id: config id
  • string $value: value
  • string $description: description
  • string $inputtype: input type
  • string $class: background color
  • $variableinfo
  • $help
  • $sort
construct_paymodules_parent_yesno_input (line 1024)

Function to print yes or no type radio boxes for yes / no type settings.

  • return: HTML representation of the configuration template
string construct_paymodules_parent_yesno_input ([integer $id = 0], [string $value = ''], [string $description = ''], [string $inputtype = ''], [string $class = 'alt1'], [ $variableinfo = ''], [ $help = ''], [ $sort = 0], string $ilconfig[])
  • string $ilconfig[]: name
  • integer $id: config id
  • string $value: value
  • string $description: description
  • string $inputtype: input type
  • string $class: css class
  • $variableinfo
  • $help
  • $sort
construct_revenue_balance (line 3684)
void construct_revenue_balance ()
construct_tsv_data (line 1663)

Function to construct and print tab separated data with predefined headings.

  • return: HTML representation of the html table
string construct_tsv_data (array $data, array $headings)
  • array $data: data
  • array $headings: heading array
decode_entities (line 2526)

Function to decode HTML entities

  • return: HTML representation of the decoded string
string decode_entities (string $text, [string $quote_style = ENT_COMPAT], [ $characterset = 'ISO-8859-1'])
  • string $text: text
  • string $quote_style: quotes style (default ENT_COMPAT)
  • $characterset
default_gateway_pulldown (line 845)

Function to print the default payment gateway within a pulldown menu.

  • return: HTML representation of the pulldown menu
string default_gateway_pulldown ([string $value = ''], [string $key = 'use_internal_gateway'])
  • string $value: config value
  • string $key: config key
email_departments_pulldown (line 1213)

Function to print the email departments pulldown menu.

  • return: HTML representation of the pulldown menu
string email_departments_pulldown ([ $selected = ''])
  • $selected
fetch_admincp_news (line 3635)
void fetch_admincp_news ()
fetch_auction_enhancements_list (line 3348)

Function to fetch the current auction enhancements details

  • return: HTML representation of the auction enhancements details
string fetch_auction_enhancements_list ([integer $projectid = 0])
  • integer $projectid: project id
fetch_budget_catcount (line 1899)

Function to fetch how many categories are currently associated with this particular budget group.

  • return: category count
integer fetch_budget_catcount (string $group)
  • string $group: budget group name
fetch_cron_schedule (line 3016)

Function to fetch the schedule details of a task used in the self-cron automation system

string fetch_cron_schedule (array $cron)
  • array $cron: array data of schedule
fetch_custom_phrases_count (line 3551)
void fetch_custom_phrases_count ()
fetch_email_department_count (line 3604)
void fetch_email_department_count ([ $departmentid = 0])
  • $departmentid
fetch_email_department_title (line 1249)

Function to print the email departments pulldown menu.

  • return: HTML representation of the pulldown menu
string fetch_email_department_title ([ $selected = ''])
  • $selected
fetch_fv_catcount (line 1950)

Function to fetch how many categories are currently associated with this particular final value group.

  • return: category count
integer fetch_fv_catcount (string $cattype, string $group)
  • string $cattype: category type (service or product)
  • string $group: final value group name
fetch_increment_catcount (line 1924)

Function to fetch how many categories are currently associated with this particular bid increment group.

  • return: category count
integer fetch_increment_catcount (string $group)
  • string $group: increment group name
fetch_insertion_budget_catcount (line 1874)

Function to fetch how many budget ranges are currently associated with this particular insertion group.

  • return: category count
integer fetch_insertion_budget_catcount (string $group)
  • string $group: insertion group name
fetch_insertion_catcount (line 1848)

Function to fetch how many categories are currently associated with this particular insertion group.

  • return: category count
integer fetch_insertion_catcount (string $cattype, string $group)
  • string $cattype: category type (service or product)
  • string $group: insertion group name
fetch_language_name (line 1379)

Function to print all phrase groups in the database within a pulldown menu.

  • return: language title
string fetch_language_name ([integer $languageid = 0])
  • integer $languageid: language id
fetch_latest_news (line 3626)
void fetch_latest_news ()
fetch_master_phrases_count (line 3533)
void fetch_master_phrases_count ()
fetch_moved_phrases_count (line 3569)
void fetch_moved_phrases_count ()
fetch_reporting_fields (line 1401)

Function to fetch all fields to use within the Reporting section of the AdminCP

  • return: data array returned with fields
array fetch_reporting_fields ( $sql,  $fields)
  • $sql
  • $fields
fetch_task_varname (line 3071)

Function to fetch the task variable name for a given cron job within the automation system

  • return: HTML representation of the string
string fetch_task_varname (integer $cronid)
  • integer $cronid: cron job id
fetch_total_phrases_count (line 3587)
void fetch_total_phrases_count ()
insert_bid_increment (line 35)

Function for inserting a new bid increment in the database.

void insert_bid_increment ([string $from = 0], [string $to = 0], [string $amount = 0], [integer $cid = 0], [integer $sort = 0], [string $groupname = ''])
  • string $from: increment from
  • string $to: increment to
  • string $amount: increment amount
  • integer $cid: category id (optional)
  • integer $sort: display sort order in the admincp
  • string $groupname: bid increment group name
insert_budget_group (line 290)

Function for inserting a new budget group.

void insert_budget_group ([string $groupname = ''], [string $description = ''])
  • string $groupname: group name
  • string $description: description
insert_budget_range (line 162)

Function for inserting a new insertion fee.

void insert_budget_range ([string $title = ''], [string $fieldname = ''], [string $budgetfrom = 0], [string $budgetto = 0], [integer $groupname = ''], [string $insgroupname = ''], [ $sort = 0])
  • string $title: insertion fee from
  • string $fieldname: insertion fee to
  • string $budgetfrom: insertion fee amount
  • string $budgetto: insertion group name
  • integer $groupname: insertion sorting display order
  • string $insgroupname: state
  • $sort
insert_fv_fee (line 421)

Function to insert a new final value fee.

void insert_fv_fee ([string $from = 0], [string $to = 0], [bool $amountfixed = 0], [bool $amountpercent = 0], [integer $sort = 100], [string $groupname = ''], [string $state = ''])
  • string $from: final value from
  • string $to: final value to
  • bool $amountfixed: is amount fixed?
  • bool $amountpercent: is amount percentage?
  • integer $sort: display sorting order
  • string $groupname: final value group name
  • string $state: state
insert_fv_group (line 109)

Function for inserting a new final value group.

void insert_fv_group ([string $groupname = ''], [string $state = ''], [string $description = ''])
  • string $groupname: final value group
  • string $state: state
  • string $description: description
insert_increment_group (line 310)

Function for inserting a new bid increment group. Additionally, the groupname will be replaced with underscores if the string contains spaces.

void insert_increment_group ([string $groupname = ''], [string $description = ''])
  • string $groupname: group name
  • string $description: description
insert_insertion_fee (line 134)

Function for inserting a new insertion fee.

void insert_insertion_fee ([string $from = 0], [string $to = 0], [string $amount = 0], [string $groupname = ''], [integer $sort = 0], [string $state = ''])
  • string $from: insertion fee from
  • string $to: insertion fee to
  • string $amount: insertion fee amount
  • string $groupname: insertion group name
  • integer $sort: insertion sorting display order
  • string $state: state
insert_insertion_group (line 87)

Function for inserting a new insertion group.

void insert_insertion_group ([string $groupname = ''], [string $state = ''], [string $description = ''])
  • string $groupname: insertion group
  • string $state: state
  • string $description: description
phrasegroup_pulldown (line 1353)

Function to print all phrase groups in the database within a pulldown menu.

  • return: HTML representation of the pulldown menu
string phrasegroup_pulldown ()
phraselist_pulldown (line 1277)

Function to print all phrases in the database within a pulldown menu.

  • return: HTML representation of the pulldown menu
string phraselist_pulldown ([integer $phrasegroup = ''], [integer $languageid = 0])
  • integer $phrasegroup: phrase group
  • integer $languageid: language id
print_admincp_nav (line 2009)

Function to print the AdminCP navigation menu

  • return: HTML representation of the AdminCP nav
string print_admincp_nav ([string $slng = 'eng'], [string $currenturl = ''])
  • string $slng: short form language identifier
  • string $currenturl: current url
print_admincp_subnav (line 2100)

Function to print the AdminCP sub navigation menus

  • return: HTML representation of the AdminCP sub nav
string print_admincp_subnav ([string $rootnav = ''], [string $currenturl = ''], [string $slng = 'eng'])
  • string $rootnav: current root nav we're on
  • string $currenturl: current url we're on
  • string $slng: short form language identifier
print_admins_pulldown (line 2630)

Function to print the admin users pulldown menu

  • return: HTML representation of the pulldown menu
string print_admins_pulldown ([string $selected = ''])
  • string $selected: selected option
print_audit_scripts_pulldown (line 2552)

Function to print a pulldown menu with any available scripts that can be tracked and auditted

  • return: HTML representation of the pulldown menu
string print_audit_scripts_pulldown ([string $selected = ''])
  • string $selected: selected option
print_budget_group_pulldown (line 797)

Function to print a pulldown with budget group values as the options.

  • return: HTML representation of the pulldown selection menu
string print_budget_group_pulldown ([string $selected = ''], [bool $shownoneselected = ''])
  • string $selected: selected value
  • bool $shownoneselected: if true, will show "please select value" option
print_from_to_date_range (line 3888)
void print_from_to_date_range ()
print_fv_group_pulldown (line 704)

Function to print a pulldown with final value group values as the options.

  • return: HTML representation of the pulldown selection menu
string print_fv_group_pulldown ([string $selected = ''], [bool $shownoneselected = ''], [string $state = ''])
  • string $selected: selected value
  • bool $shownoneselected: if true, will show "please select value" option
  • string $state: category state
print_increment_group_pulldown (line 753)

Function to print a pulldown with bid increment group values as the options.

  • return: HTML representation of the pulldown selection menu
string print_increment_group_pulldown ([string $selected = ''], [bool $shownoneselected = ''], [string $state = ''])
  • string $selected: selected value
  • bool $shownoneselected: if true, will show "please select value" option
  • string $state: category state
print_insertion_group_pulldown (line 654)

Function to print a pulldown with insertion group values as the options.

  • return: HTML representation of the pulldown selection menu
string print_insertion_group_pulldown ([integer $selected = ''], [bool $shownoneselected = 0], [string $state = ''], [ $fieldname = 'groupid'])
  • integer $selected: selected insertion group id
  • bool $shownoneselected: if true, will show "please select value" option
  • string $state: category state
  • $fieldname
print_invoicetype_pulldown (line 3390)

Function to print the invoice types pulldown menu

string print_invoicetype_pulldown ([string $invoicetype = ''], [ $fieldname = 'invoicetype'])
  • string $invoicetype: invoice type
  • $fieldname
print_members_pulldown (line 2588)

Function to print the members pulldown menu

  • return: HTML representation of the pulldown menu
string print_members_pulldown ([string $selected = ''], [boolean $showallusers = 1])
  • string $selected: selected option
  • boolean $showallusers: show all users (default true)
print_migrate_billing_pulldown (line 3491)

Function to print the migration billing pulldown menu

string print_migrate_billing_pulldown ([string $selected = ''])
  • string $selected: selected option
print_migrate_to_pulldown (line 3440)

Function to print the "migrate to" pulldown menu for subscription plans within the AdminCP

string print_migrate_to_pulldown ([string $selected = ''])
  • string $selected: selected option
print_moderation_pulldown (line 1977)

Function to print a pulldown for enabling or disabling moderation

  • return: HTML representation of the pulldown menu
string print_moderation_pulldown ([string $value = ''], [string $variableinfo = ''])
  • string $value: value
  • string $variableinfo: key
print_profile_filtertype_pulldown (line 3196)

Function to print out the profile filter types pulldown menu

  • return: HTML representation of the pulldown menu
string print_profile_filtertype_pulldown ([string $selected = ''])
  • string $selected: selected option
print_roletype_pulldown (line 2390)

Function to construct and print out the role type pulldown menu

  • return: HTML representation of the pulldown menu
string print_roletype_pulldown ([string $selected = ''])
  • string $selected: selected role type
print_roleusertype_pulldown (line 2417)

Function to construct and print out the role user type pulldown menu

  • return: HTML representation of the pulldown menu
string print_roleusertype_pulldown ([string $selected = ''])
  • string $selected: selected role user type
print_scheduled_tasks_pulldown (line 3152)

Function to print out the scheduled tasks pulldown menu

  • return: HTML representation of the pulldown
string print_scheduled_tasks_pulldown ([string $selected = ''])
  • string $selected: selected option
print_template_filelist_pulldown (line 2183)

Function to print out a pulldown menu with all files used in ILance.

  • return: HTML representation of the pulldown menu with auction type values
string print_template_filelist_pulldown ()
print_version (line 2671)

Function to fetch the latest version of ILance

  • return: HTML representation of the latest version of ILance
string print_version ()
products_pulldown (line 1165)

Function to print the products or add-ons installed pulldown menu.

  • return: HTML representation of the pulldown menu
string products_pulldown ([ $selected = 'ilance'])
  • $selected
rebuild_language_cache (line 2971)

Function to remove & allow rebuild of the javascript phrase cache file

nothing rebuild_language_cache ()
remove_bid_increment (line 502)

Function to remove an existing bid increment.

void remove_bid_increment ([integer $id = 0])
  • integer $id: increment id
remove_budget_group (line 216)

Function for removing an existing budget group.

void remove_budget_group ([integer $groupid = 0])
  • integer $groupid: group id
remove_budget_range (line 274)

Function for removing an existing budget range.

void remove_budget_range ([integer $budgetid = 0])
  • integer $budgetid: budget id
remove_fv_fee (line 534)

Function to remove an existing final value fee.

void remove_fv_fee ([integer $id = 0])
  • integer $id: final value fee id
remove_fv_group (line 589)

Function to remove an existing final value group

void remove_fv_group ([integer $id = 0])
  • integer $id: final value group id
remove_increment_group (line 242)

Function for removing an existing bid increment group. This function will additionally deassociate any categories using this group.

void remove_increment_group ([integer $groupid = 0])
  • integer $groupid: group id
remove_insertion_fee (line 518)

Function to remove an existing insertion fee.

void remove_insertion_fee ([integer $id = 0])
  • integer $id: insertion fee id
remove_insertion_group (line 550)

Function to remove an existing insertion group.

void remove_insertion_group ([integer $id = 0])
  • integer $id: insertion group id
remove_registration_question (line 628)

Function to remove a registration question from the database.

void remove_registration_question ([integer $id = 0])
  • integer $id: registration question id
remove_user (line 3927)

Function to remove single or multiple users from the marketplace

  • return: Returns HTML string of users removed separated by a comma for display purposes
string remove_user ([array $ids = array()], [bool $removeinvoices = true], [bool $removelistings = true], [bool $removeescrow = true], [bool $removebuynoworders = true], [bool $removebids = true])
  • array $ids: array with user ids flagged for removal
  • bool $removeinvoices: remove invoices for user? (default no)
  • bool $removelistings: remove listings for user? (default no)
  • bool $removeescrow: remove escrow for user? (default no)
  • bool $removebuynoworders: remove buynow orders for user? (default no)
  • bool $removebids: remove bids for user? (default no)
scheduled_task_phrase (line 3097)

Function to print out a phrase based on a text string for the scheduled task

  • return: HTML representation of the string
string scheduled_task_phrase (string $selected)
  • string $selected: selected task
suspend_user (line 4061)

Function to suspend single or multiple users from the marketplace

  • return: Returns HTML string of users suspended separated by a comma for display purposes
string suspend_user ([array $ids = array()])
  • array $ids: array with user ids flagged for suspension
template_groups (line 1315)

Function to print all template groups within a multiple select list menu.

  • return: HTML representation of the selection menu
string template_groups ()
unsuspend_user (line 4111)

Function to unsuspend single or multiple users from the marketplace

  • return: Returns HTML string of users unsuspended separated by a comma for display purposes
string unsuspend_user ([array $ids = array()])
  • array $ids: array with user ids flagged for unsuspension
unverify_user (line 4297)

Function to unverify single or multiple users from the marketplace

  • return: Returns HTML string of users unverified separated by a comma for display purposes
string unverify_user ([array $ids = array()])
  • array $ids: array with user ids flagged for unverification
update_bid_increment (line 64)

Function for inserting a new bid increment in the database.

void update_bid_increment ([integer $incrementid = 0], [string $from = 0], [string $to = 0], [string $amount = 0], [integer $cid = 0], [integer $sort = 0], [string $groupname = ''])
  • integer $incrementid: increment id (optional)
  • string $from: increment from
  • string $to: increment to
  • string $amount: increment amount
  • integer $cid: category id (optional)
  • integer $sort: display sort order in the admincp
  • string $groupname: bid increment group name
update_budget_group (line 334)

Function to update an existing budget group

void update_budget_group ([integer $groupid = 0], [string $groupname = ''], [string $description = ''])
  • integer $groupid: group id
  • string $groupname: group name
  • string $description: description
update_budget_range (line 191)

Function for updating an existing budget range.

void update_budget_range ([integer $budgetid = 0], [string $title = ''], [string $budgetfrom = 0], [string $budgetto = 0], [integer $groupid = 0], [integer $insertiongroupid = '-1'], [ $sort = 10])
  • integer $budgetid: budget id
  • string $title: title
  • string $budgetfrom: budget from
  • string $budgetto: budget to
  • integer $groupid: group id
  • integer $insertiongroupid: sort display order
  • $sort
update_fv_fee (line 478)

Function to update an existing final value fee.

void update_fv_fee ([string $from = 0], [string $to = 0], [bool $amountfixed = 0], [bool $amountpercent = 0], [integer $groupid = 0], [integer $tierid = 0], [integer $sort = 10])
  • string $from: final value fee from
  • string $to: final value fee to
  • bool $amountfixed: is amount fixed?
  • bool $amountpercent: is amount percentage?
  • integer $groupid: final value group id
  • integer $tierid: final value tier id
  • integer $sort: sort display order
update_increment_group (line 372)

Function to update an existing increment group

void update_increment_group ([integer $groupid = 0], [string $newgroupname = ''], [string $newdescription = ''])
  • integer $groupid: group id
  • string $newgroupname: group name
  • string $newdescription: description
update_insertion_fee (line 449)

Function to update an existing insertion fee.

void update_insertion_fee ([string $from = 0], [string $to = 0], [string $amount = 0], [integer $groupid = 0], [integer $insertionid = ''], [ $sort = 0])
  • string $from: insertion fee from
  • string $to: insertion fee to
  • string $amount: insertion fee amount
  • integer $groupid: insertion id
  • integer $insertionid: sort display order
  • $sort

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