user_guide_src/source/general/common_functions.rst

################
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()
========

.. function:: is_php($version = '5.3.0')

	:param	string	$version: Version number
	:returns:	bool

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()
====================

.. function:: is_really_writable($file)

	:param	string	$file: File path
	:returns:	bool

``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()
=============

.. function:: config_item($key)

	:param	string	$key: Config item key
	:returns:	mixed

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.

show_error()
============

.. function:: show_error($message, $status_code, $heading = 'An Error Was Encountered')

	:param	mixed	$message: Error message
	:param	int	$status_code: HTTP Response status code
	:param	string	$heading: Error page heading
	:returns:	void

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

show_404()
==========

.. function:: show_404($page = '', $log_error = TRUE)

	:param	string	$page: URI string
	:param	bool	$log_error: Whether to log the error
	:returns:	void

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

log_message()
=============

.. function:: log_message($level, $message, $php_error = FALSE)

	:param	string	$level: Log level: 'error', 'debug' or 'info'
	:param	string	$message: Message to log
	:param	bool	$php_error: Whether we're logging a native PHP error message
	:returns:	void

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

set_status_header()
===============================

.. function:: set_status_header($code, $text = '')

	:param	int	$code: HTTP Reponse status code
	:param	string	$text: A custom message to set with the status code
	:returns:	void

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

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

`See here <http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html>`_ for
a full list of headers.

remove_invisible_characters()
=============================

.. function:: remove_invisible_characters($str, $url_encoded = TRUE)

	:param	string	$str: Input string
	:param	bool	$url_encoded: Whether to remove URL-encoded characters as well
	:returns:	string

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

Example::

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

html_escape()
=============

.. function:: html_escape($var)

	:param	mixed	$var: Variable to escape
			(string or array)
	:returns:	mixed

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()
===========

.. function:: get_mimes()

	:returns:	array

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

is_https()
==========

.. function:: is_https()

	:returns:	bool

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

function_usable()
=================

.. function:: function_usable($function_name)

	:param	string	$function_name: Function name
	:returns:	bool

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.