Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Tree: d0c30ab416
Fetching contributors…

Cannot retrieve contributors at this time

197 lines (134 sloc) 5.217 kB

Common Functions

CodeIgniter uses a few functions for its operation that are globally defined, and are available to you at any point. These do not require loading any libraries or helpers.

is_php()

Determines of the PHP version being used is greater than the supplied version number.

Example:

if (is_php('5.3'))
{
        $str = quoted_printable_encode($str);
}

Returns boolean TRUE if the installed version of PHP is equal to or greater than the supplied version number. Returns FALSE if the installed version of PHP is lower than the supplied version number.

is_really_writable()

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.

This function determines if a file is actually writable by attempting to write to it first. Generally only recommended on platforms where this information may be unreliable.

Example:

if (is_really_writable('file.txt'))
{
        echo "I could write to this if I wanted to";
}
else
{
        echo "File is not writable";
}

config_item()

The :doc:`Config Library <../libraries/config>` is the preferred way of accessing configuration information, however config_item() can be used to retrieve single keys. See :doc:`Config Library <../libraries/config>` documentation for more information.

Important

This function only returns values set in your configuration files. It does not take into account config values that are dynamically set at runtime.

show_error()

This function calls CI_Exception::show_error(). For more info, please see the :doc:`Error Handling <errors>` documentation.

show_404()

This function calls CI_Exception::show_404(). For more info, please see the :doc:`Error Handling <errors>` documentation.

log_message()

This function is an alias for CI_Log::write_log(). For more info, please see the :doc:`Error Handling <errors>` documentation.

set_status_header()

Permits you to manually set a server status header. Example:

set_status_header(401);
// Sets the header as:  Unauthorized

See here for a full list of headers.

remove_invisible_characters()

This function prevents inserting NULL characters between ASCII characters, like Java\0script.

Example:

remove_invisible_characters('Java\\0script');
// Returns: 'Javascript'

html_escape()

This function acts as an alias for PHP's native htmlspecialchars() function, with the advantage of being able to accept an array of strings.

It is useful in preventing Cross Site Scripting (XSS).

get_mimes()

This function returns a reference to the MIMEs array from application/config/mimes.php.

is_https()

Returns TRUE if a secure (HTTPS) connection is used and FALSE in any other case (including non-HTTP requests).

function_usable()

Returns TRUE if a function exists and is usable, FALSE otherwise.

This function runs a function_exists() check and if the Suhosin extension <http://www.hardened-php.net/suhosin/> is loaded, checks if it doesn't disable the function being checked.

It is useful if you want to check for the availability of functions such as eval() and exec(), which are dangerous and might be disabled on servers with highly restrictive security policies.

Jump to Line
Something went wrong with that request. Please try again.