Permalink
Browse files

Update Security helper docs

  • Loading branch information...
1 parent f33091f commit f9491c984d56a9fb363f572bd4c10a185e5f186b @derekjones derekjones committed Jul 19, 2013
Showing with 39 additions and 41 deletions.
  1. +39 −41 user_guide_src/source/helpers/security_helper.rst
@@ -4,7 +4,12 @@ Security Helper
The Security Helper file contains security related functions.
-.. contents:: Page Contents
+.. contents::
+ :local:
+
+.. raw:: html
+
+ <div class="custom-index container"></div>
Loading this Helper
===================
@@ -13,92 +18,85 @@ This helper is loaded using the following code::
$this->load->helper('security');
+Available Functions
+===================
+
The following functions are available:
-xss_clean()
-===========
-.. function:: xss_clean($str, $is_image = FALSE)
+.. function:: xss_clean($str[, $is_image = FALSE])
:param string $str: Input data
:param bool $is_image: Whether we're dealing with an image
:returns: string
-Provides Cross Site Script Hack filtering.
+ Provides Cross Site Script Hack filtering.
-This function is an alias for ``CI_Input::xss_clean()``. For more info,
-please see the :doc:`Input Library <../libraries/input>` documentation.
+ This function is an alias for ``CI_Input::xss_clean()``. For more info,
+ please see the :doc:`Input Library <../libraries/input>` documentation.
-sanitize_filename()
-===================
.. function:: sanitize_filename($filename)
:param string $filename: Filename
:returns: string
-Provides protection against directory traversal.
+ Provides protection against directory traversal.
-This function is an alias for ``CI_Security::sanitize_filename()``.
-For more info, please see the :doc:`Security Library <../libraries/security>`
-documentation.
+ This function is an alias for ``CI_Security::sanitize_filename()``.
+ For more info, please see the :doc:`Security Library <../libraries/security>`
+ documentation.
-do_hash()
-=========
-.. function:: do_hash($str, $type = 'sha1')
+.. function:: do_hash($str[, $type = 'sha1'])
:param string $str: Input
:param string $type: Algorithm
:returns: string
-Permits you to create one way hashes suitable for encrypting
-passwords. Will use SHA1 by default.
+ Permits you to create one way hashes suitable for encrypting
+ passwords. Will use SHA1 by default.
-See `hash_algos() <http://php.net/function.hash_algos>`_
-for a full list of supported algorithms.
+ See `hash_algos() <http://php.net/function.hash_algos>`_
+ for a full list of supported algorithms.
-Examples::
+ Examples::
- $str = do_hash($str); // SHA1
- $str = do_hash($str, 'md5'); // MD5
+ $str = do_hash($str); // SHA1
+ $str = do_hash($str, 'md5'); // MD5
-.. note:: This function was formerly named ``dohash()``, which has been
- removed in favor of ``do_hash()``.
+ .. note:: This function was formerly named ``dohash()``, which has been
+ removed in favor of ``do_hash()``.
-.. note:: This function is DEPRECATED. Use the native ``hash()`` instead.
+ .. note:: This function is DEPRECATED. Use the native ``hash()`` instead.
-strip_image_tags()
-==================
.. function:: strip_image_tags($str)
:param string $str: Input
:returns: string
-This is a security function that will strip image tags from a string.
-It leaves the image URL as plain text.
+ This is a security function that will strip image tags from a string.
+ It leaves the image URL as plain text.
-Example::
+ Example::
- $string = strip_image_tags($string);
+ $string = strip_image_tags($string);
-This function is an alias for ``CI_Security::strip_image_tags()``. For
-more info, please see the :doc:`Security Library <../libraries/security>`
-documentation.
+ This function is an alias for ``CI_Security::strip_image_tags()``. For
+ more info, please see the :doc:`Security Library <../libraries/security>`
+ documentation.
-encode_php_tags()
-=================
.. function:: encode_php_tags($str)
:param string $str: Input
:returns: string
-This is a security function that converts PHP tags to entities.
+ This is a security function that converts PHP tags to entities.
-.. note: :func:`xss_clean()` does this automatically, if you use it.
+ .. note:: :func:`xss_clean()` does this automatically, if you use it.
-Example::
+ Example::
- $string = encode_php_tags($string);
+ $string = encode_php_tags($string);

0 comments on commit f9491c9

Please sign in to comment.