Docs For Class core

core

Description

This class contains general functions to use all over the system.

author: Jason Schoeman

Located in /includes/core.class.php (line 20)

Variable Summary

string $override_textdomain

Method Summary

string active_plugin ()

string alert_link (string $alert_msg)

string alert_submit (string $alert_msg)

string confirm_link (string $confirm_what)

string confirm_submit (string $confirm_what)

string create_random_string ([integer $length = 4], [boolean $uppercase_only = false])

void define_lang ()

string format_time_date (timestamp $time_stamp)

string get_template ()

string is_constant (string $is_variable_constant)

void load_default_plugin_language ()

void load_language (string $language_dir, [boolean $script = false], [boolean $set_textdomain = true])

void load_menu_language ()

void load_timezone_language ()

integer name_to_id (string $convert_to_id)

string right_trim (string $str, [string $remove = null])

mixed __ (string $say_what, [boolean $print = false])

Variables

string $override_textdomain (line 28)

Used to over ride safer textdomain to prevent crossed textdomains in deeper levels.

author: Jason Schoeman
access: public

Methods

active_plugin (line 349)

Function to return the current running/active plugin.

access: public

string active_plugin ()

alert_link (line 82)

This shows a simple "alert" box which notifies the user about a specified condition.

return: Javascript popup warning box.
author: Don Schoeman
access: public

string alert_link (string $alert_msg)

string $alert_msg: The actual warning message.

alert_submit (line 67)

This shows a simple "alert" box which notifies the user about a specified condition.

return: Javascript popup warning box.
author: Don Schoeman
access: public

string alert_submit (string $alert_msg)

string $alert_msg: The actual warning message.

confirm_link (line 37)

This creates a simple confirmation box to ask users input before performing a critical link click.

return: Javascript popup confirmation box.
author: Jason Schoeman
access: public

string confirm_link (string $confirm_what)

string $confirm_what: What is the question to be asked in the confirmation box.

confirm_submit (line 52)

This creates a simple confirmation box to ask users input before performing a critical submit.

return: Javascript popup confirmation box.
author: Jason Schoeman
access: public

string confirm_submit (string $confirm_what)

string $confirm_what: What is the question to be asked in the confirmation box.

create_random_string (line 138)

This method creates a random string with mixed alphabetic characters.

return: Will return required random string.
author: Andy Shellam, andy [at] andycc [dot] net
access: public

string create_random_string ([integer $length = 4], [boolean $uppercase_only = false])

integer $length: The lenght the string should be.
boolean $uppercase_only: Should the string be uppercase.

define_lang (line 327)

Turn $lang variables into constants.

author: Jason Schoeman
access: public

void define_lang ()

format_time_date (line 116)

Simply returns the provided time/date by order of the configuration.

return: Will return the nicely formatted date string ex. 1 June 2011 18:05 PM
author: Jason Schoeman
access: public

string format_time_date (timestamp $time_stamp)

timestamp $time_stamp: Unix timestamp.

get_template (line 363)

Get and return the supposed to run template.

return: if not found, return default.
author: Jason Schoeman
access: public

string get_template ()

is_constant (line 97)

Check and returns constant if constant is defined or returns normal variable if no constant defined.

return: The actual assigned constant value.
author: Jason Schoeman
access: public

string is_constant (string $is_variable_constant)

string $is_variable_constant: The string to check whether variable or constant.

load_default_plugin_language (line 293)

This method loads the plugin language with default items and icons array.

author: Jason Schoeman
access: public

void load_default_plugin_language ()

load_language (line 220)

This methods allows you to load a custom language by giving parameters.

author: Jason Schoeman
access: public

void load_language (string $language_dir, [boolean $script = false], [boolean $set_textdomain = true])

string $language_dir: This is the location where language is found.
boolean $script
boolean $set_textdomain

load_menu_language (line 270)

This method loads the default menu language array and assigns it to a variable.

author: Jason Schoeman
access: public

void load_menu_language ()

load_timezone_language (line 310)

This method loads the timezone language array.

author: Jason Schoeman
access: public

void load_timezone_language ()

name_to_id (line 386)

Convert string unsigned CRC32 value. This is unique and can help predict a entries id beforehand.

Use for folder names insuring unique id's.

author: Jason Schoeman
access: public

integer name_to_id (string $convert_to_id)

string $convert_to_id: To convert to integer.

right_trim (line 400)

Strip a string from the end of a string.

Is there no such function in PHP?

return: the modified string.
access: public

string right_trim (string $str, [string $remove = null])

string $str: The input string.
string $remove: OPTIONAL string to remove.

__ (line 177)

Method is used to wrap the gettext international language conversion tool inside PHPDevShell.

Converts text to use gettext PO system.

return: Depending on user selection.
author: Jason Schoeman
access: public

mixed __ (string $say_what, [boolean $print = false])

string $say_what: The string required to output or convert.
boolean $print: Should it be printed out or returned.

Documentation generated on Thu, 23 Oct 2008 13:58:30 +0200 by phpDocumentor 1.4.0