Files
opensourcepos/docs/class-Config.html
FrancescoUK f9fb9e44b3 Added apigen to generate OSPOS code documentation (see docs)
Added grunt-composer and grunt-apigen and scripted all the steps in Grunt
2017-04-29 23:43:15 +01:00

931 lines
20 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class Config</title>
<link rel="stylesheet" href="resources/style.css?c2f33731c1948fbed7c333554678bfa68d4817da">
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li>
<a href="namespace-emberlabs.html">
emberlabs<span></span>
</a>
<ul>
<li>
<a href="namespace-emberlabs.Barcode.html">
Barcode </a>
</li>
</ul></li>
<li class="active">
<a href="namespace-None.html">
None </a>
</li>
</ul>
</div>
<hr>
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Appconfig.html">Appconfig</a></li>
<li><a href="class-Barcode_lib.html">Barcode_lib</a></li>
<li class="active"><a href="class-Config.html">Config</a></li>
<li><a href="class-Customer.html">Customer</a></li>
<li><a href="class-Customer_rewards.html">Customer_rewards</a></li>
<li><a href="class-Customers.html">Customers</a></li>
<li><a href="class-Detailed_receivings.html">Detailed_receivings</a></li>
<li><a href="class-Detailed_sales.html">Detailed_sales</a></li>
<li><a href="class-Dinner_table.html">Dinner_table</a></li>
<li><a href="class-Email_lib.html">Email_lib</a></li>
<li><a href="class-Employee.html">Employee</a></li>
<li><a href="class-Employees.html">Employees</a></li>
<li><a href="class-Giftcard.html">Giftcard</a></li>
<li><a href="class-Giftcards.html">Giftcards</a></li>
<li><a href="class-Home.html">Home</a></li>
<li><a href="class-Inventory.html">Inventory</a></li>
<li><a href="class-Inventory_low.html">Inventory_low</a></li>
<li><a href="class-Inventory_summary.html">Inventory_summary</a></li>
<li><a href="class-Item.html">Item</a></li>
<li><a href="class-Item_kit.html">Item_kit</a></li>
<li><a href="class-Item_kit_items.html">Item_kit_items</a></li>
<li><a href="class-Item_kits.html">Item_kits</a></li>
<li><a href="class-Item_lib.html">Item_lib</a></li>
<li><a href="class-Item_quantity.html">Item_quantity</a></li>
<li><a href="class-Item_taxes.html">Item_taxes</a></li>
<li><a href="class-Items.html">Items</a></li>
<li><a href="class-Login.html">Login</a></li>
<li><a href="class-Mailchimp_lib.html">Mailchimp_lib</a></li>
<li><a href="class-MailchimpConnector.html">MailchimpConnector</a></li>
<li><a href="class-Messages.html">Messages</a></li>
<li><a href="class-Module.html">Module</a></li>
<li><a href="class-MY_Lang.html">MY_Lang</a></li>
<li><a href="class-No_Access.html">No_Access</a></li>
<li><a href="class-Person.html">Person</a></li>
<li><a href="class-Persons.html">Persons</a></li>
<li><a href="class-Receiving.html">Receiving</a></li>
<li><a href="class-Receiving_lib.html">Receiving_lib</a></li>
<li><a href="class-Receivings.html">Receivings</a></li>
<li><a href="class-Report.html">Report</a></li>
<li><a href="class-Reports.html">Reports</a></li>
<li><a href="class-Rewards.html">Rewards</a></li>
<li><a href="class-Rounding_code.html">Rounding_code</a></li>
<li><a href="class-Sale.html">Sale</a></li>
<li><a href="class-Sale_lib.html">Sale_lib</a></li>
<li><a href="class-Sale_suspended.html">Sale_suspended</a></li>
<li><a href="class-Sales.html">Sales</a></li>
<li><a href="class-Secure_Controller.html">Secure_Controller</a></li>
<li><a href="class-Sms_lib.html">Sms_lib</a></li>
<li><a href="class-Specific_customer.html">Specific_customer</a></li>
<li><a href="class-Specific_discount.html">Specific_discount</a></li>
<li><a href="class-Specific_employee.html">Specific_employee</a></li>
<li><a href="class-Stock_location.html">Stock_location</a></li>
<li><a href="class-Summary_categories.html">Summary_categories</a></li>
<li><a href="class-Summary_customers.html">Summary_customers</a></li>
<li><a href="class-Summary_discounts.html">Summary_discounts</a></li>
<li><a href="class-Summary_employees.html">Summary_employees</a></li>
<li><a href="class-Summary_items.html">Summary_items</a></li>
<li><a href="class-Summary_payments.html">Summary_payments</a></li>
<li><a href="class-Summary_report.html">Summary_report</a></li>
<li><a href="class-Summary_sales.html">Summary_sales</a></li>
<li><a href="class-Summary_suppliers.html">Summary_suppliers</a></li>
<li><a href="class-Summary_taxes.html">Summary_taxes</a></li>
<li><a href="class-Supplier.html">Supplier</a></li>
<li><a href="class-Suppliers.html">Suppliers</a></li>
<li><a href="class-Tax.html">Tax</a></li>
<li><a href="class-Tax_lib.html">Tax_lib</a></li>
<li><a href="class-Taxes.html">Taxes</a></li>
<li><a href="class-Token.html">Token</a></li>
<li><a href="class-Token_customer.html">Token_customer</a></li>
<li><a href="class-Token_invoice_count.html">Token_invoice_count</a></li>
<li><a href="class-Token_invoice_sequence.html">Token_invoice_sequence</a></li>
<li><a href="class-Token_lib.html">Token_lib</a></li>
<li><a href="class-Token_quote_sequence.html">Token_quote_sequence</a></li>
<li><a href="class-Token_suspended_invoice_count.html">Token_suspended_invoice_count</a></li>
<li><a href="class-Token_year_invoice_count.html">Token_year_invoice_count</a></li>
<li><a href="class-Tracking_lib.html">Tracking_lib</a></li>
</ul>
<h3>Functions</h3>
<ul>
<li><a href="function-currency_side.html">currency_side</a></li>
<li><a href="function-current_language.html">current_language</a></li>
<li><a href="function-current_language_code.html">current_language_code</a></li>
<li><a href="function-dateformat_bootstrap.html">dateformat_bootstrap</a></li>
<li><a href="function-dateformat_momentjs.html">dateformat_momentjs</a></li>
<li><a href="function-db_log_queries.html">db_log_queries</a></li>
<li><a href="function-get_customer_data_row.html">get_customer_data_row</a></li>
<li><a href="function-get_customer_manage_table_headers.html">get_customer_manage_table_headers</a></li>
<li><a href="function-get_giftcard_data_row.html">get_giftcard_data_row</a></li>
<li><a href="function-get_giftcards_manage_table_headers.html">get_giftcards_manage_table_headers</a></li>
<li><a href="function-get_item_data_row.html">get_item_data_row</a></li>
<li><a href="function-get_item_kit_data_row.html">get_item_kit_data_row</a></li>
<li><a href="function-get_item_kits_manage_table_headers.html">get_item_kits_manage_table_headers</a></li>
<li><a href="function-get_items_manage_table_headers.html">get_items_manage_table_headers</a></li>
<li><a href="function-get_people_manage_table_headers.html">get_people_manage_table_headers</a></li>
<li><a href="function-get_person_data_row.html">get_person_data_row</a></li>
<li><a href="function-get_sale_data_last_row.html">get_sale_data_last_row</a></li>
<li><a href="function-get_sale_data_row.html">get_sale_data_row</a></li>
<li><a href="function-get_sales_manage_payments_summary.html">get_sales_manage_payments_summary</a></li>
<li><a href="function-get_sales_manage_table_headers.html">get_sales_manage_table_headers</a></li>
<li><a href="function-get_supplier_data_row.html">get_supplier_data_row</a></li>
<li><a href="function-get_suppliers_manage_table_headers.html">get_suppliers_manage_table_headers</a></li>
<li><a href="function-get_tax_data_row.html">get_tax_data_row</a></li>
<li><a href="function-get_taxes_manage_table_headers.html">get_taxes_manage_table_headers</a></li>
<li><a href="function-load_config.html">load_config</a></li>
<li><a href="function-load_language_files.html">load_language_files</a></li>
<li><a href="function-load_stats.html">load_stats</a></li>
<li><a href="function-parse_decimals.html">parse_decimals</a></li>
<li><a href="function-pdf_create.html">pdf_create</a></li>
<li><a href="function-quantity_decimals.html">quantity_decimals</a></li>
<li><a href="function-show_report.html">show_report</a></li>
<li><a href="function-show_report_if_allowed.html">show_report_if_allowed</a></li>
<li><a href="function-to_currency.html">to_currency</a></li>
<li><a href="function-to_currency_no_money.html">to_currency_no_money</a></li>
<li><a href="function-to_decimals.html">to_decimals</a></li>
<li><a href="function-to_quantity_decimals.html">to_quantity_decimals</a></li>
<li><a href="function-to_tax_decimals.html">to_tax_decimals</a></li>
<li><a href="function-totals_decimals.html">totals_decimals</a></li>
<li><a href="function-transform_headers.html">transform_headers</a></li>
<li><a href="function-transform_headers_readonly.html">transform_headers_readonly</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="">
<input type="hidden" name="ie" value="UTF-8">
<input type="text" name="q" class="text" placeholder="Search">
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li class="active">
<span>Class</span> </li>
</ul>
<ul>
</ul>
<ul>
</ul>
</div>
<div id="content" class="class">
<h1>Class Config</h1>
<dl class="tree">
<dd style="padding-left:0px">
CI_Controller
</dd>
<dd style="padding-left:30px">
<img src="resources/inherit.png" alt="Extended by">
<a href="class-Secure_Controller.html"><span>Secure_Controller</span></a>
</dd>
<dd style="padding-left:60px">
<img src="resources/inherit.png" alt="Extended by">
<b><span>Config</span></b>
</dd>
</dl>
<div class="info">
<b>Located at</b> <a href="source-class-Config.html#5-836" title="Go to source code">controllers/Config.php</a>
<br>
</div>
<table class="summary methods" id="methods">
<caption>Methods summary</caption>
<tr data-order="__construct" id="___construct">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#___construct">#</a>
<code><a href="source-class-Config.html#7-13" title="Go to source code">__construct</a>( )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
<h4>Overrides</h4>
<div class="list"><code><a href="class-Secure_Controller.html#___construct">Secure_Controller::__construct()</a></code></div>
</div>
</div></td>
</tr>
<tr data-order="index" id="_index">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_index">#</a>
<code><a href="source-class-Config.html#197-231" title="Go to source code">index</a>( )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
<h4>Overrides</h4>
<div class="list"><code><a href="class-Secure_Controller.html#_index">Secure_Controller::index()</a></code></div>
</div>
</div></td>
</tr>
<tr data-order="save_info" id="_save_info">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_save_info">#</a>
<code><a href="source-class-Config.html#233-266" title="Go to source code">save_info</a>( )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="save_general" id="_save_general">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_save_general">#</a>
<code><a href="source-class-Config.html#268-305" title="Go to source code">save_general</a>( )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="check_number_locale" id="_check_number_locale">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_check_number_locale">#</a>
<code><a href="source-class-Config.html#307-324" title="Go to source code">check_number_locale</a>( )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="save_locale" id="_save_locale">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_save_locale">#</a>
<code><a href="source-class-Config.html#326-356" title="Go to source code">save_locale</a>( )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="save_email" id="_save_email">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_save_email">#</a>
<code><a href="source-class-Config.html#358-385" title="Go to source code">save_email</a>( )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="save_message" id="_save_message">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_save_message">#</a>
<code><a href="source-class-Config.html#387-410" title="Go to source code">save_message</a>( )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="ajax_check_mailchimp_api_key" id="_ajax_check_mailchimp_api_key">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_ajax_check_mailchimp_api_key">#</a>
<code><a href="source-class-Config.html#439-450" title="Go to source code">ajax_check_mailchimp_api_key</a>( )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="save_mailchimp" id="_save_mailchimp">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_save_mailchimp">#</a>
<code><a href="source-class-Config.html#452-475" title="Go to source code">save_mailchimp</a>( )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="stock_locations" id="_stock_locations">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_stock_locations">#</a>
<code><a href="source-class-Config.html#477-484" title="Go to source code">stock_locations</a>( )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="dinner_tables" id="_dinner_tables">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_dinner_tables">#</a>
<code><a href="source-class-Config.html#486-493" title="Go to source code">dinner_tables</a>( )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="customer_rewards" id="_customer_rewards">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_customer_rewards">#</a>
<code><a href="source-class-Config.html#495-502" title="Go to source code">customer_rewards</a>( )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="save_locations" id="_save_locations">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_save_locations">#</a>
<code><a href="source-class-Config.html#515-546" title="Go to source code">save_locations</a>( )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="save_tables" id="_save_tables">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_save_tables">#</a>
<code><a href="source-class-Config.html#548-587" title="Go to source code">save_tables</a>( )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="save_rewards" id="_save_rewards">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_save_rewards">#</a>
<code><a href="source-class-Config.html#589-640" title="Go to source code">save_rewards</a>( )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="save_barcode" id="_save_barcode">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_save_barcode">#</a>
<code><a href="source-class-Config.html#642-668" title="Go to source code">save_barcode</a>( )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="save_receipt" id="_save_receipt">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_save_receipt">#</a>
<code><a href="source-class-Config.html#670-695" title="Go to source code">save_receipt</a>( )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="save_invoice" id="_save_invoice">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_save_invoice">#</a>
<code><a href="source-class-Config.html#697-733" title="Go to source code">save_invoice</a>( )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="remove_logo" id="_remove_logo">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_remove_logo">#</a>
<code><a href="source-class-Config.html#735-740" title="Go to source code">remove_logo</a>( )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="backup_db" id="_backup_db">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_backup_db">#</a>
<code><a href="source-class-Config.html#807-835" title="Go to source code">backup_db</a>( )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
</table>
<table class="summary inherited">
<caption>Methods inherited from <a href="class-Secure_Controller.html#methods">Secure_Controller</a></caption>
<tr>
<td><code>
<a href="class-Secure_Controller.html#_check_numeric">check_numeric()</a>,
<a href="class-Secure_Controller.html#_delete">delete()</a>,
<a href="class-Secure_Controller.html#_numeric">numeric()</a>,
<a href="class-Secure_Controller.html#_save">save()</a>,
<a href="class-Secure_Controller.html#_search">search()</a>,
<a href="class-Secure_Controller.html#_suggest_search">suggest_search()</a>,
<a href="class-Secure_Controller.html#_track_event">track_event()</a>,
<a href="class-Secure_Controller.html#_track_page">track_page()</a>,
<a href="class-Secure_Controller.html#_view">view()</a>,
<a href="class-Secure_Controller.html#_xss_clean">xss_clean()</a>
</code></td>
</tr>
</table>
</div>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen</a>
</div>
</div>
</div>
<script src="resources/combined.js"></script>
<script src="elementlist.js"></script>
</body>
</html>