summaryrefslogtreecommitdiffstats
path: root/system/core/Common.php
diff options
context:
space:
mode:
Diffstat (limited to 'system/core/Common.php')
-rw-r--r--system/core/Common.php200
1 files changed, 84 insertions, 116 deletions
diff --git a/system/core/Common.php b/system/core/Common.php
index 9e05f3db4..b0921fe0c 100644
--- a/system/core/Common.php
+++ b/system/core/Common.php
@@ -47,6 +47,7 @@
* Since there are a few places where we conditionally test for PHP > 5
* we'll set a static variable.
*
+* @access public
* @param string
* @return bool TRUE if the current version is $version or higher
*/
@@ -75,6 +76,7 @@ if ( ! function_exists('is_php'))
* the file, based on the read-only attribute. is_writable() is also unreliable
* on Unix servers if safe_mode is on.
*
+ * @access private
* @return void
*/
if ( ! function_exists('is_really_writable'))
@@ -116,17 +118,18 @@ if ( ! function_exists('is_really_writable'))
// ------------------------------------------------------------------------
/**
- * Class registry
- *
- * This function acts as a singleton. If the requested class does not
- * exist it is instantiated and set to a static variable. If it has
- * previously been instantiated the variable is returned.
- *
- * @param string the class name being requested
- * @param string the directory where the class should be found
- * @param string the class name prefix
- * @return object
- */
+* Class registry
+*
+* This function acts as a singleton. If the requested class does not
+* exist it is instantiated and set to a static variable. If it has
+* previously been instantiated the variable is returned.
+*
+* @access public
+* @param string the class name being requested
+* @param string the directory where the class should be found
+* @param string the class name prefix
+* @return object
+*/
if ( ! function_exists('load_class'))
{
function &load_class($class, $directory = 'libraries', $prefix = 'CI_')
@@ -188,11 +191,12 @@ if ( ! function_exists('load_class'))
// --------------------------------------------------------------------
/**
- * Keeps track of which libraries have been loaded. This function is
- * called by the load_class() function above
- *
- * @return array
- */
+* Keeps track of which libraries have been loaded. This function is
+* called by the load_class() function above
+*
+* @access public
+* @return array
+*/
if ( ! function_exists('is_loaded'))
{
function is_loaded($class = '')
@@ -211,13 +215,14 @@ if ( ! function_exists('is_loaded'))
// ------------------------------------------------------------------------
/**
- * Loads the main config.php file
- *
- * This function lets us grab the config file even if the Config class
- * hasn't been instantiated yet
- *
- * @return array
- */
+* Loads the main config.php file
+*
+* This function lets us grab the config file even if the Config class
+* hasn't been instantiated yet
+*
+* @access private
+* @return array
+*/
if ( ! function_exists('get_config'))
{
function &get_config($replace = array())
@@ -268,10 +273,11 @@ if ( ! function_exists('get_config'))
// ------------------------------------------------------------------------
/**
- * Returns the specified config item
- *
- * @return mixed
- */
+* Returns the specified config item
+*
+* @access public
+* @return mixed
+*/
if ( ! function_exists('config_item'))
{
function config_item($item)
@@ -296,16 +302,17 @@ if ( ! function_exists('config_item'))
// ------------------------------------------------------------------------
/**
- * Error Handler
- *
- * This function lets us invoke the exception class and
- * display errors using the standard error template located
- * in application/errors/errors.php
- * This function will send the error page directly to the
- * browser and exit.
- *
- * @return void
- */
+* Error Handler
+*
+* This function lets us invoke the exception class and
+* display errors using the standard error template located
+* in application/errors/errors.php
+* This function will send the error page directly to the
+* browser and exit.
+*
+* @access public
+* @return void
+*/
if ( ! function_exists('show_error'))
{
function show_error($message, $status_code = 500, $heading = 'An Error Was Encountered')
@@ -319,14 +326,15 @@ if ( ! function_exists('show_error'))
// ------------------------------------------------------------------------
/**
- * 404 Page Handler
- *
- * This function is similar to the show_error() function above
- * However, instead of the standard error template it displays
- * 404 errors.
- *
- * @return void
- */
+* 404 Page Handler
+*
+* This function is similar to the show_error() function above
+* However, instead of the standard error template it displays
+* 404 errors.
+*
+* @access public
+* @return void
+*/
if ( ! function_exists('show_404'))
{
function show_404($page = '', $log_error = TRUE)
@@ -340,13 +348,14 @@ if ( ! function_exists('show_404'))
// ------------------------------------------------------------------------
/**
- * Error Logging Interface
- *
- * We use this as a simple mechanism to access the logging
- * class and send messages to be logged.
- *
- * @return void
- */
+* Error Logging Interface
+*
+* We use this as a simple mechanism to access the logging
+* class and send messages to be logged.
+*
+* @access public
+* @return void
+*/
if ( ! function_exists('log_message'))
{
function log_message($level = 'error', $message, $php_error = FALSE)
@@ -368,6 +377,7 @@ if ( ! function_exists('log_message'))
/**
* Set HTTP Status Header
*
+ * @access public
* @param int the status code
* @param string
* @return void
@@ -454,18 +464,19 @@ if ( ! function_exists('set_status_header'))
// --------------------------------------------------------------------
/**
- * Exception Handler
- *
- * This is the custom exception handler that is declaired at the top
- * of Codeigniter.php. The main reason we use this is to permit
- * PHP errors to be logged in our own log files since the user may
- * not have access to server logs. Since this function
- * effectively intercepts PHP errors, however, we also need
- * to display errors based on the current error_reporting level.
- * We do that with the use of a PHP error template.
- *
- * @return void
- */
+* Exception Handler
+*
+* This is the custom exception handler that is declaired at the top
+* of Codeigniter.php. The main reason we use this is to permit
+* PHP errors to be logged in our own log files since the user may
+* not have access to server logs. Since this function
+* effectively intercepts PHP errors, however, we also need
+* to display errors based on the current error_reporting level.
+* We do that with the use of a PHP error template.
+*
+* @access private
+* @return void
+*/
if ( ! function_exists('_exception_handler'))
{
function _exception_handler($severity, $message, $filepath, $line)
@@ -507,6 +518,7 @@ if ( ! function_exists('_exception_handler'))
* This prevents sandwiching null characters
* between ascii characters, like Java\0script.
*
+ * @access public
* @param string
* @return string
*/
@@ -540,11 +552,12 @@ if ( ! function_exists('remove_invisible_characters'))
// ------------------------------------------------------------------------
/**
- * Returns HTML escaped variable
- *
- * @param mixed
- * @return mixed
- */
+* Returns HTML escaped variable
+*
+* @access public
+* @param mixed
+* @return mixed
+*/
if ( ! function_exists('html_escape'))
{
function html_escape($var)
@@ -553,57 +566,12 @@ if ( ! function_exists('html_escape'))
{
return array_map('html_escape', $var);
}
-
- return htmlspecialchars($var, ENT_QUOTES, config_item('charset'));
- }
-}
-
-// ------------------------------------------------------------------------
-
-/**
- * Load Environmental config directory files.
- *
- * In several places we check to see if the environment is loaded up and if the file
- * that is being requested lives in said environment. Otherwise load up the file from
- * the main CI config dir.
- *
- * @todo Optimize a bit to lessen the file system hits if the file has been loaded.
- * @param string filename without extension. eg: 'config' or 'hooks'
- * @param boolean whether or not to do a `require_once()` or a simple `include()`
- * @return void
- */
- if ( ! function_exists('load_environ_config'))
- {
- function load_environ_config($file, $require=FALSE)
- {
- if (defined('ENVIRONMENT') AND file_exists(APPPATH.'config/'.ENVIRONMENT.'/'.$file.'.php'))
- {
- if ($require)
- {
- require_once(APPPATH.'config/'.ENVIRONMENT.'/'.$file.'.php');
- }
- else
- {
- include(APPPATH.'config/'.ENVIRONMENT.'/'.$file.'.php');
- }
-
- return;
- }
-
- if ($require)
- {
- require_once(APPPATH.'config/'.$file.'.php');
- }
else
{
- include(APPPATH.'config/'.$file.'.php');
+ return htmlspecialchars($var, ENT_QUOTES, config_item('charset'));
}
-
- return;
}
- }
-
-// ------------------------------------------------------------------------
+}
/* End of file Common.php */
/* Location: ./system/core/Common.php */ \ No newline at end of file