Docs For Class admincp

Description

AdminCP importer handler for emails, language phrases and css styles within ILance.

This class will allow better functionality whereby it can support command line import tools and/or import/export functionality from within the ILance Admin CP keeping code updated from a central place.

author: ILance
version: $Revision: 1.0.0 $

Located in /api/class.admincp_importexport.inc.php (line 31)

admincp
   |
   --admincp_importexport

Method Summary

boolean export ([string $what = ''], [string $where = 'admincp'], [integer $languageid = 0], [string $pathtofile = ''], [boolean $slientmode = false], [boolean $untranslated = 0], [integer $styleid = 0], [string $product = ''])

boolean import ([string $what = ''], [string $where = 'admincp'], [string $xml = ''], [boolean $slientmode = false], [boolean $noversioncheck = 1], [boolean $overwritephrases = 0], [boolean $setasdefault = 0])

Methods

export (line 766)

Function to export emails, phrases or css styles via XML

return: Returns true or false

boolean export ([string $what = ''], [string $where = 'admincp'], [integer $languageid = 0], [string $pathtofile = ''], [boolean $slientmode = false], [boolean $untranslated = 0], [integer $styleid = 0], [string $product = ''])

string $what: export what? [email, phrase or css]
string $where: location/area we're performing the export from [admincp or commandline]
integer $languageid: language id for export
string $pathtofile: location/file path to exported file [used only when commandline argument is used]
boolean $slientmode: determines if we should not run print_notice(), print_action_success(), or print_action_failed() [default false, use true when using commandline argument]
boolean $untranslated: determines if we should only export language phrases that haven't been translated
integer $styleid: default style id we're attempting to export to XML (when we're exporting CSS only)
string $product: default product to export

import (line 46)

Function to import emails, phrases or css styles via XML

return: Returns true or false

boolean import ([string $what = ''], [string $where = 'admincp'], [string $xml = ''], [boolean $slientmode = false], [boolean $noversioncheck = 1], [boolean $overwritephrases = 0], [boolean $setasdefault = 0])

string $what: import what? [email, phrase or css]
string $where: location/area we're performing the import from [admincp or commandline]
string $xml: location/file path to the file we're importing
boolean $slientmode: determines if we should not run print_notice(), print_action_success(), or print_action_failed() [default false, use true when using commandline argument]
boolean $noversioncheck: determines if we should skip the version checkup of the xml file being imported (default true)
boolean $overwritephrases: determines if we should overwrite our current phrases with phrases found from imported xml file (default false)
boolean $setasdefault: determines if we should set the newly uploaded style XML file as the default marketplace style everyone sees (default false)

Inherited Methods

Inherited From admincp

admincp::activate_user()
admincp::api_phrasegroupname()
admincp::auction_details_pulldown()
admincp::auction_details_pulldown2()
admincp::auction_state_pulldown()
admincp::auction_status_pulldown()
admincp::ban_user()
admincp::cancel_user()
admincp::category_pulldown()
admincp::construct_admin_input()
admincp::construct_bidamounttypes()
admincp::construct_budget_group_pulldown()
admincp::construct_csv_data()
admincp::construct_escrow_balance()
admincp::construct_finalvalue_group_pulldown()
admincp::construct_html_table()
admincp::construct_increment_group_pulldown()
admincp::construct_insertion_group_pulldown()
admincp::construct_new_member()
admincp::construct_parent_int_input()
admincp::construct_parent_pulldown_input()
admincp::construct_parent_textarea_input()
admincp::construct_parent_yesno_input()
admincp::construct_paymodules_input()
admincp::construct_paymodules_parent_int_input()
admincp::construct_paymodules_parent_pass_input()
admincp::construct_paymodules_parent_pulldown_input()
admincp::construct_paymodules_parent_textarea_input()
admincp::construct_paymodules_parent_text_input()
admincp::construct_paymodules_parent_yesno_input()
admincp::construct_revenue_balance()
admincp::construct_tsv_data()
admincp::decode_entities()
admincp::default_gateway_pulldown()
admincp::email_departments_pulldown()
admincp::fetch_admincp_news()
admincp::fetch_auction_enhancements_list()
admincp::fetch_budget_catcount()
admincp::fetch_cron_schedule()
admincp::fetch_custom_phrases_count()
admincp::fetch_email_department_count()
admincp::fetch_email_department_title()
admincp::fetch_fv_catcount()
admincp::fetch_increment_catcount()
admincp::fetch_insertion_budget_catcount()
admincp::fetch_insertion_catcount()
admincp::fetch_language_name()
admincp::fetch_latest_news()
admincp::fetch_master_phrases_count()
admincp::fetch_moved_phrases_count()
admincp::fetch_reporting_fields()
admincp::fetch_task_varname()
admincp::fetch_total_phrases_count()
admincp::insert_bid_increment()
admincp::insert_budget_group()
admincp::insert_budget_range()
admincp::insert_fv_fee()
admincp::insert_fv_group()
admincp::insert_increment_group()
admincp::insert_insertion_fee()
admincp::insert_insertion_group()
admincp::phrasegroup_pulldown()
admincp::phraselist_pulldown()
admincp::print_admincp_nav()
admincp::print_admincp_subnav()
admincp::print_admins_pulldown()
admincp::print_audit_scripts_pulldown()
admincp::print_budget_group_pulldown()
admincp::print_from_to_date_range()
admincp::print_fv_group_pulldown()
admincp::print_increment_group_pulldown()
admincp::print_insertion_group_pulldown()
admincp::print_invoicetype_pulldown()
admincp::print_members_pulldown()
admincp::print_migrate_billing_pulldown()
admincp::print_migrate_to_pulldown()
admincp::print_moderation_pulldown()
admincp::print_profile_filtertype_pulldown()
admincp::print_roletype_pulldown()
admincp::print_roleusertype_pulldown()
admincp::print_scheduled_tasks_pulldown()
admincp::print_template_filelist_pulldown()
admincp::print_version()
admincp::products_pulldown()
admincp::rebuild_language_cache()
admincp::remove_bid_increment()
admincp::remove_budget_group()
admincp::remove_budget_range()
admincp::remove_fv_fee()
admincp::remove_fv_group()
admincp::remove_increment_group()
admincp::remove_insertion_fee()
admincp::remove_insertion_group()
admincp::remove_registration_question()
admincp::remove_user()
admincp::scheduled_task_phrase()
admincp::suspend_user()
admincp::template_groups()
admincp::unsuspend_user()
admincp::unverify_user()
admincp::update_bid_increment()
admincp::update_budget_group()
admincp::update_budget_range()
admincp::update_fv_fee()
admincp::update_increment_group()
admincp::update_insertion_fee()

Class admincp_importexport

Inherited Methods