Docs For Class ilance

Description

ILance class to perform the majority of the main common ILance functions.

author: ILance
version: $Revision: 1.0.0 $

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

Variable Summary

$apihooks $apihooks

$config $config

$GPC $GPC

$pluginsxml $plugins

Method Summary

ilance ilance ()

string addon_css_count ([string $addon = ''])

string addon_email_count ([string $addon = ''])

string addon_phrase_count ([string $addon = ''])

string addon_task_count ([string $addon = ''])

string api ([string $location = ''])

nothing clean_gpc (string $gpc, array $variable, [string $type = ''])

string escape_string ([string $text = ''])

none fetch_installed_plugins ()

integer fetch_language_locale ([itneger $languageid = 1])

none init_configuration ()

string latest_addon_version ([string $versioncheckurl = ''])

nothing parse_incoming (array $array)

void post_request_protection ()

nothing strip_slashes_array (array &$array)

nothing unset_globals (array $array)

integer usercount ()

Variables

$apihooks $apihooks = array() (line 37)

Will store {apihook[xxx]}'s that are being loaded to prevent double loading

$config $config = array() (line 44)

Will store $ilconfig as $this->config['xxx'] (will use more in future)

$GPC $GPC = array() (line 30)

$_GET, $_POST and $_COOKIE array

$pluginsxml $plugins = array() (line 51)

Will store all plugins currently installed into an array for future processing

Methods

Constructor ilance (line 56)

Constructor

ilance ilance ()

addon_css_count (line 618)

Function to fetch the css element count for an add-on product

return: Returns formatted number (i.e.: 3,201)

string addon_css_count ([string $addon = ''])

string $addon: addon name (simple version, i.e.: lanceads, lancekb, stores, wantads, etc)

addon_email_count (line 654)

Function to fetch the email templates count for an add-on product

return: Returns formatted number (i.e.: 3,201)

string addon_email_count ([string $addon = ''])

string $addon: addon name (simple version, i.e.: lanceads, lancekb, stores, wantads, etc)

addon_phrase_count (line 582)

Function to fetch the phrases count for an add-on product

return: Returns formatted number (i.e.: 3,201)

string addon_phrase_count ([string $addon = ''])

string $addon: addon name (simple version, i.e.: lanceads, lancekb, stores, wantads, etc)

addon_task_count (line 690)

Function to fetch the automated tasks count for an add-on product

return: Returns formatted number (i.e.: 3,201)

string addon_task_count ([string $addon = ''])

string $addon: addon name (simple version, i.e.: lanceads, lancekb, stores, wantads, etc)

api (line 726)

Function to search and locate any inline php or html code to be parsed within an official ILance api hook.

return: Returns formatted HTML or PHP code to be parsed inline as called.

string api ([string $location = ''])

string $location: api location hook name (ie: init_configuration_end)

clean_gpc (line 266)

Function to clean $_GLOBAL, $_POST and $_COOKIE input

nothing clean_gpc (string $gpc, array $variable, [string $type = ''])

string $gpc: g, p or c values
array $variable: array or value to clean
string $type: variable clean type selector (ie: TYPE_INT, TYPE_NUM, etc)

escape_string (line 209)

Function wrapper for the xx_escape_string function for escaping valid sql input

return: Returns xx_escape_string value

string escape_string ([string $text = ''])

string $text: string to escape

fetch_installed_plugins (line 823)

Function to fetch all installed plugin_*.xml files and build the plugin array with any installed add-on products

none fetch_installed_plugins ()

fetch_language_locale (line 865)

Function to fetch the language locale settings to setup our environment

return: Returns an array with locale settings (locale, decimal and thousands)

integer fetch_language_locale ([itneger $languageid = 1])

itneger $languageid: language id

init_configuration (line 911)

Initializes the $ilconfig array as well as the payment modules configuration construction

none init_configuration ()

latest_addon_version (line 549)

Function to connect to the ilance.com web site to fetch the latest version of any specific add-on product supported by ILance.

return: Returns formatted HTML or PHP code to be parsed inline as called.

string latest_addon_version ([string $versioncheckurl = ''])

string $versioncheckurl: version checkup url (ie: http://www.ilance.com/lancebb/versioncheck)

parse_incoming (line 189)

Function to parse any incoming input and tranform it into our reusable $ilance->GPC array used in the software.

nothing parse_incoming (array $array)

array $array: array

post_request_protection (line 89)

$_POST request site forgery protection and whitelist control

void post_request_protection ()

strip_slashes_array (line 222)

Function to strip any slashes within a regular or recursive array

nothing strip_slashes_array (array &$array)

array &$array: array

unset_globals (line 244)

Function to unset $_GLOBAL's from being set by users via URL manipulation

nothing unset_globals (array $array)

array $array: array value to clean

usercount (line 889)

Function to fetch the user count

return: Returns number (i.e.: 3201)

integer usercount ()