From ef112c0830df4a31563351125888b0d522a1c965 Mon Sep 17 00:00:00 2001
From: Phil Sturgeon
The following is a list of all the native rules that are available to use:
-Rule | -Parameter | -Description | -Example | -
---|---|---|---|
required | -No | -Returns FALSE if the form element is empty. | -- |
matches | -Yes | -Returns FALSE if the form element does not match the one in the parameter. | -matches[form_item] | -
min_length | -Yes | -Returns FALSE if the form element is shorter then the parameter value. | -min_length[6] | -
max_length | -Yes | -Returns FALSE if the form element is longer then the parameter value. | -max_length[12] | -
exact_length | -Yes | -Returns FALSE if the form element is not exactly the parameter value. | -exact_length[8] | -
alpha | -No | -Returns FALSE if the form element contains anything other than alphabetical characters. | -- |
alpha_numeric | -No | -Returns FALSE if the form element contains anything other than alpha-numeric characters. | -- |
alpha_dash | -No | -Returns FALSE if the form element contains anything other than alpha-numeric characters, underscores or dashes. | -- |
numeric | -No | -Returns FALSE if the form element contains anything other than numeric characters. | -- |
integer | -No | -Returns FALSE if the form element contains anything other than an integer. | -- |
is_natural | -No | -Returns FALSE if the form element contains anything other than a natural number: 0, 1, 2, 3, etc. | -- |
is_natural_no_zero | -No | -Returns FALSE if the form element contains anything other than a natural number, but not zero: 1, 2, 3, etc. | -- |
valid_email | -No | -Returns FALSE if the form element does not contain a valid email address. | -- |
valid_emails | -No | -Returns FALSE if any value provided in a comma separated list is not a valid email. | -- |
valid_ip | -No | -Returns FALSE if the supplied IP is not valid. | -- |
valid_base64 | -No | -Returns FALSE if the supplied string contains anything other than valid Base64 characters. | -- |
Rule | +Parameter | +Description | +Example | +
required | +No | +Returns FALSE if the form element is empty. | ++ |
matches | +Yes | +Returns FALSE if the form element does not match the one in the parameter. | +matches[form_item] | +
min_length | +Yes | +Returns FALSE if the form element is shorter then the parameter value. | +min_length[6] | +
max_length | +Yes | +Returns FALSE if the form element is longer then the parameter value. | +max_length[12] | +
exact_length | +Yes | +Returns FALSE if the form element is not exactly the parameter value. | +exact_length[8] | +
greater_than | +Yes | +Returns FALSE if the form element is less than the parameter value or not numeric. | +greater_than[8] | +
less_than | +Yes | +Returns FALSE if the form element is greater than the parameter value or not numeric. | +less_than[8] | +
alpha | +No | +Returns FALSE if the form element contains anything other than alphabetical characters. | ++ |
alpha_numeric | +No | +Returns FALSE if the form element contains anything other than alpha-numeric characters. | ++ |
alpha_dash | +No | +Returns FALSE if the form element contains anything other than alpha-numeric characters, underscores or dashes. | ++ |
numeric | +No | +Returns FALSE if the form element contains anything other than numeric characters. | ++ |
integer | +No | +Returns FALSE if the form element contains anything other than an integer. | ++ |
decimal | +Yes | +Returns FALSE if the form element is not exactly the parameter value. | ++ |
is_natural | +No | +Returns FALSE if the form element contains anything other than a natural number: 0, 1, 2, 3, etc. | ++ |
is_natural_no_zero | +No | +Returns FALSE if the form element contains anything other than a natural number, but not zero: 1, 2, 3, etc. | ++ |
valid_email | +No | +Returns FALSE if the form element does not contain a valid email address. | ++ |
valid_emails | +No | +Returns FALSE if any value provided in a comma separated list is not a valid email. | ++ |
valid_ip | +No | +Returns FALSE if the supplied IP is not valid. | ++ |
valid_base64 | +No | +Returns FALSE if the supplied string contains anything other than valid Base64 characters. | ++ |
Name | -Parameter | -Description | -
---|---|---|
xss_clean | -No | -Runs the data through the XSS filtering function, described in the Input Class page. | -
prep_for_form | -No | -Converts special characters so that HTML data can be shown in a form field without breaking it. | -
prep_url | -No | -Adds "http://" to URLs if missing. | -
strip_image_tags | -No | -Strips the HTML from image tags leaving the raw URL. | -
encode_php_tags | -No | -Converts PHP tags to entities. | -
Name | +Parameter | +Description | +
xss_clean | +No | +Runs the data through the XSS filtering function, described in the Input Class page. | +
prep_for_form | +No | +Converts special characters so that HTML data can be shown in a form field without breaking it. | +
prep_url | +No | +Adds "http://" to URLs if missing. | +
strip_image_tags | +No | +Strips the HTML from image tags leaving the raw URL. | +
encode_php_tags | +No | +Converts PHP tags to entities. | +