Docs For Class common

Class common

Description

Common class which holds the majority of common ILance functions in the system

author: ILance
version: $Revision: 1.0.0 $

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

Method Summary

string admin_login_include (string 0)

string construct_random_value (string $num)

string download_file ([string $filestring = ''], [ $filename = ''], [ $filetype = ''])

string entities_to_numeric ([string $text = ''], [ $flip = 0], [ $skip = ''])

string fetch_browser_name ([string $showicon = 0], [ $readname = ''])

void fetch_os_name ([ $agent = ''], [ $forceicon = false])

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

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

string is_username_banned ([string $username = ''])

string is_webbrowser (string $browser, [integer $version = 0])

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

string last_seen (string $userid, [ $location = false])

string login_include (string 0)

string numeric_to_utf8 ([string $t = ''])

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

string xss_clean (string &$var)

Methods

admin_login_include (line 739)

Function to display the login information bar for admins

string admin_login_include (string 0)

string 0: text

construct_random_value (line 939)

Function to generate a random string based on a supplied number of characters.

string construct_random_value (string $num)

string $num: text

download_file (line 906)

Function to download a file to a web browser.

string download_file ([string $filestring = ''], [ $filename = ''], [ $filetype = ''])

string $filestring: text
$filename
$filetype

entities_to_numeric (line 229)

Function to return numeric entities from htmlentity characters

string entities_to_numeric ([string $text = ''], [ $flip = 0], [ $skip = ''])

string $text
$flip
$skip

fetch_browser_name (line 1063)

Function to fetch the active web browser name.

string fetch_browser_name ([string $showicon = 0], [ $readname = ''])

string $showicon: text
$readname

fetch_os_name (line 1302)

void fetch_os_name ([ $agent = ''], [ $forceicon = false])

$agent
$forceicon

is_email_banned (line 835)

Function to determine if an email address is banned.

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

string $email: text

is_email_valid (line 823)

Function to determine if an email address is valid.

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

string $email: text

is_username_banned (line 869)

Function to determine if a username is banned.

string is_username_banned ([string $username = ''])

string $username: text

is_webbrowser (line 33)

Function to determine what the visiting users web browser is

return: Returns browser info

string is_webbrowser (string $browser, [integer $version = 0])

string $browser: browser
integer $version: version (optional)

js_escaped_to_xhtml_entities (line 635)

Function to

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

string $text: text

last_seen (line 792)

Function to display a date when a supplied user id was last seen

string last_seen (string $userid, [ $location = false])

string $userid: text
$location

login_include (line 665)

Function to display the login information bar for members

string login_include (string 0)

string 0: text

numeric_to_utf8 (line 215)

Function to return a utf-8 string based on a numeric entity string

return: Returns utf-8 character based on numeric entities supplied

string numeric_to_utf8 ([string $t = ''])

string $t: numeric entity character eg: &320;

xhtml_entities_to_numeric_entities (line 616)

Function to

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

string $text: text

xss_clean (line 648)

Function to strips invalid html such as javascript code

string xss_clean (string &$var)

string &$var: text

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