Common.php File Reference

Go to the source code of this file.

Functions
	is_really_writable ($file)
	Tests for file writability.
&	load_class ($class, $instantiate=TRUE)
	Class registry.
&	get_config ()
	Loads the main config.php file.
	config_item ($item)
	Gets a config item.
	show_error ($message)
	Error Handler.
	show_404 ($page= '')
	404 Page Handler
	log_message ($level= 'error', $message, $php_error=FALSE)
	Error Logging Interface.
	_exception_handler ($severity, $message, $filepath, $line)
	Exception Handler.

---

Function Documentation

_exception_handler	(	$	severity,
		$	message,
		$	filepath,
		$	line
	)

Exception Handler.

This is the custom exception handler that is declaired at the top of Codeigniter.php. The main reason we use this is permit PHP errors to be logged in our own log files since we 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.

private

Returns:

void

Definition at line 262 of file Common.php.

References $config, get_config(), and load_class().

{       
         // We don't bother with "strict" notices since they will fill up
         // the log file with information that isn't normally very
         // helpful.  For example, if you are running PHP 5 and you
         // use version 4 style class functions (without prefixes
         // like "public", "private", etc.) you'll get notices telling
         // you that these have been deprecated.
        
        if ($severity == E_STRICT)
        {
                return;
        }

        $error =& load_class('Exceptions');

        // Should we display the error?
        // We'll get the current error_reporting level and add its bits
        // with the severity bits to find out.
        
        if (($severity & error_reporting()) == $severity)
        {
                $error->show_php_error($severity, $message, $filepath, $line);
        }
        
        // Should we log the error?  No?  We're done...
        $config =& get_config();
        if ($config['log_threshold'] == 0)
        {
                return;
        }

        $error->log_exception($severity, $message, $filepath, $line);
}

Here is the call graph for this function:

config_item

(

$

item

)

Gets a config item.

public

Returns:

mixed

Definition at line 168 of file Common.php.

References $config, and get_config().

Referenced by CI_Loader::_ci_load(), CI_Loader::_ci_load_class(), CI_Loader::helper(), and load_class().

{
        static $config_item = array();

        if ( ! isset($config_item[$item]))
        {
                $config =& get_config();

                if ( ! isset($config[$item]))
                {
                        return FALSE;
                }
                $config_item[$item] = $config[$item];
        }

        return $config_item[$item];
}

Here is the call graph for this function:

Here is the caller graph for this function:

& get_config

(

)

Loads the main config.php file.

private

Returns:

array

Definition at line 139 of file Common.php.

References $config.

Referenced by _exception_handler(), CI_Config::CI_Config(), CI_Log::CI_Log(), config_item(), and log_message().

{
        static $main_conf;

        if ( ! isset($main_conf))
        {
                if ( ! file_exists(APPPATH.'config/config'.EXT))
                {
                        exit('The configuration file config'.EXT.' does not exist.');
                }

                require(APPPATH.'config/config'.EXT);

                if ( ! isset($config) OR ! is_array($config))
                {
                        exit('Your config file does not appear to be formatted correctly.');
                }

                $main_conf[0] =& $config;
        }
        return $main_conf[0];
}

Here is the caller graph for this function:

is_really_writable

(

$

file

)

Tests for file writability.

is_writable() returns TRUE on Windows servers when you really can't write to the file as the OS reports to PHP as FALSE only if the read-only attribute is marked. Ugh?

private

Returns:

void

Definition at line 43 of file Common.php.

Referenced by CI_Output::_display_cache(), CI_Output::_write_cache(), CI_DB_Cache::check_path(), CI_Log::CI_Log(), create_captcha(), and CI_Upload::validate_upload_path().

{
        if (is_dir($file))
        {
                $file = rtrim($file, '/').'/'.md5(rand(1,100));

                if (($fp = @fopen($file, FOPEN_WRITE_CREATE)) === FALSE)
                {
                        return FALSE;
                }

                fclose($fp);
                @chmod($file, DIR_WRITE_MODE);
                @unlink($file);
                return TRUE;
        }
        elseif (($fp = @fopen($file, FOPEN_WRITE_CREATE)) === FALSE)
        {
                return FALSE;
        }

        fclose($fp);
        return TRUE;
}

Here is the caller graph for this function:

& load_class	(	$	class,
		$	instantiate = TRUE
	)

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.

public

Parameters:

	string	the class name being requested
	bool	optional flag that lets classes get loaded but not instantiated

Returns:

object

Definition at line 82 of file Common.php.

References $class, and config_item().

Referenced by Controller::_ci_initialize(), _exception_handler(), CI_Hooks::_initialize(), CI_Input::CI_Input(), CI_Router::CI_Router(), CI_URI::CI_URI(), CI_DB_driver::display_error(), log_message(), CI_Loader::model(), show_404(), and show_error().

{
        static $objects = array();

        // Does the class exist?  If so, we're done...
        if (isset($objects[$class]))
        {
                return $objects[$class];
        }

        // If the requested class does not exist in the application/libraries
        // folder we'll load the native class from the system/libraries folder. 
        if (file_exists(APPPATH.'libraries/'.config_item('subclass_prefix').$class.EXT))
        {
                require(BASEPATH.'libraries/'.$class.EXT);      
                require(APPPATH.'libraries/'.config_item('subclass_prefix').$class.EXT);
                $is_subclass = TRUE;    
        }
        else
        {
                if (file_exists(APPPATH.'libraries/'.$class.EXT))
                {
                        require(APPPATH.'libraries/'.$class.EXT);       
                        $is_subclass = FALSE;   
                }
                else
                {
                        require(BASEPATH.'libraries/'.$class.EXT);
                        $is_subclass = FALSE;
                }
        }

        if ($instantiate == FALSE)
        {
                $objects[$class] = TRUE;
                return $objects[$class];
        }

        if ($is_subclass == TRUE)
        {
                $name = config_item('subclass_prefix').$class;
                $objects[$class] =& new $name();
                return $objects[$class];
        }

        $name = ($class != 'Controller') ? 'CI_'.$class : $class;
        
        $objects[$class] =& new $name();
        return $objects[$class];
}

Here is the call graph for this function:

Here is the caller graph for this function:

log_message	(	$	level = 'error',
		$	message,
		$	php_error = FALSE
	)

Error Logging Interface.

We use this as a simple mechanism to access the logging class and send messages to be logged.

public

Returns:

void

Definition at line 234 of file Common.php.

References $config, get_config(), and load_class().

Referenced by CI_Loader::_ci_load(), CI_Loader::_ci_load_class(), CI_Output::_display(), CI_Output::_display_cache(), CI_Input::_sanitize_globals(), CI_Router::_set_routing(), CI_Output::_write_cache(), CI_Calendar::CI_Calendar(), CI_Config::CI_Config(), CI_DB_driver::CI_DB_driver(), CI_DB_forge::CI_DB_forge(), CI_DB_utility::CI_DB_utility(), CI_Email::CI_Email(), CI_Encrypt::CI_Encrypt(), CI_FTP::CI_FTP(), CI_Hooks::CI_Hooks(), CI_Image_lib::CI_Image_lib(), CI_Input::CI_Input(), CI_Language::CI_Language(), CI_Loader::CI_Loader(), CI_Output::CI_Output(), CI_Pagination::CI_Pagination(), CI_Router::CI_Router(), CI_Session::CI_Session(), CI_SHA::CI_SHA(), CI_Table::CI_Table(), CI_Trackback::CI_Trackback(), CI_Unit_test::CI_Unit_test(), CI_Upload::CI_Upload(), CI_URI::CI_URI(), CI_User_agent::CI_User_agent(), CI_Validation::CI_Validation(), CI_Xmlrpc::CI_Xmlrpc(), CI_Xmlrpcs::CI_Xmlrpcs(), CI_Zip::CI_Zip(), Controller::Controller(), CI_DB_sqlite_driver::db_connect(), CI_DB_sqlite_driver::db_pconnect(), CI_Loader::helper(), CI_DB_driver::initialize(), CI_Language::load(), CI_Config::load(), CI_Exceptions::log_exception(), Model::Model(), CI_Loader::plugin(), CI_DB_driver::query(), Scaffolding::Scaffolding(), CI_Loader::script(), CI_Session::sess_gc(), CI_Session::sess_read(), CI_Session::sess_run(), CI_Upload::set_error(), CI_Trackback::set_error(), CI_Image_lib::set_error(), CI_Exceptions::show_404(), CI_DB_oci8_driver::stored_procedure(), CI_DB_driver::trans_complete(), and CI_Input::xss_clean().

{
        static $LOG;
        
        $config =& get_config();
        if ($config['log_threshold'] == 0)
        {
                return;
        }

        $LOG =& load_class('Log');      
        $LOG->write_log($level, $message, $php_error);
}

Here is the call graph for this function:

show_404

(

$

page = ''

)

404 Page Handler

This function is similar to the show_error() function above However, instead of the standard error template it displays 404 errors.

public

Returns:

void

Definition at line 217 of file Common.php.

References load_class().

Referenced by Controller::_ci_scaffolding(), and CI_Router::_validate_request().

{
        $error =& load_class('Exceptions');
        $error->show_404($page);
        exit;
}

Here is the call graph for this function:

Here is the caller graph for this function:

show_error

(

$

message

)

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.

public

Returns:

void

Definition at line 199 of file Common.php.

References load_class().

Referenced by CI_Loader::_ci_load(), CI_Loader::_ci_load_class(), CI_FTP::_error(), CI_Router::_set_routing(), CI_DB_forge::add_column(), CI_DB_forge::add_field(), CI_DB_forge::add_key(), CI_Pagination::create_links(), CI_DB_forge::create_table(), CI_DB_utility::csv_from_result(), DB(), CI_DB_forge::drop_column(), CI_Encrypt::get_key(), CI_Loader::helper(), CI_Language::load(), CI_Config::load(), CI_Loader::model(), CI_DB_forge::modify_column(), CI_DB_utility::optimize_table(), CI_Loader::plugin(), CI_DB_forge::rename_table(), CI_Loader::scaffolding(), CI_Loader::script(), and CI_DB_utility::xml_from_result().

{
        $error =& load_class('Exceptions');
        echo $error->show_error('An Error Was Encountered', $message);
        exit;
}

Here is the call graph for this function:

Here is the caller graph for this function: