Properties

$basic_tags

$basic_tags : 

Type

$en_noise_words

$en_noise_words : 

Type

$validation_rules

$validation_rules : 

Type

$filter_rules

$filter_rules : 

Type

$errors

$errors : 

Type

$fields

$fields : 

Type

$validation_methods

$validation_methods : 

Type

$filter_methods

$filter_methods : 

Type

Methods

is_valid()

is_valid(array  $data, array  $validators) : mixed

Shorthand method for inline validation

Parameters

array $data

The data to be validated

array $validators

The GUMP validators

Returns

mixed —

True(boolean) or the array of error messages

filter_input()

filter_input(array  $data, array  $filters) 

Shorthand method for running only the data filters

Parameters

array $data
array $filters

__toString()

__toString() : string

Magic method to generate the validation error messages

Returns

string

xss_clean()

xss_clean(array  $data) : array

Perform XSS clean to prevent cross site scripting

Parameters

array $data

Returns

array

add_validator()

add_validator(string  $rule, callable  $callback) : boolean

Adds a custom validation rule using a callback function

Parameters

string $rule
callable $callback

Returns

boolean

add_filter()

add_filter(string  $rule, callable  $callback) : boolean

Adds a custom filter using a callback function

Parameters

string $rule
callable $callback

Returns

boolean

validation_rules()

validation_rules(array  $rules = array()) : array

Getter/Setter for the validation rules

Parameters

array $rules

Returns

array

filter_rules()

filter_rules(array  $rules = array()) : array

Getter/Setter for the filter rules

Parameters

array $rules

Returns

array

run()

run(array  $data,   $check_fields = false) : array

Run the filtering and validation after each other

Parameters

array $data
$check_fields

Returns

array

sanitize()

sanitize(array  $input,   $fields = NULL,   $utf8_encode = true) : array

Sanitize the input data

Parameters

array $input
$fields
$utf8_encode

Returns

array

errors()

errors() : array

Return the error array from the last validation run

Returns

array

validate()

validate(mixed  $input, array  $ruleset) : mixed

Perform data validation against the provided ruleset

Parameters

mixed $input
array $ruleset

Returns

mixed

set_field_name()

set_field_name(  $field, string  $readable_name) : void

Set a readable name for a specified field names

Parameters

$field
string $readable_name

get_readable_errors()

get_readable_errors(boolean  $convert_to_string = false, string  $field_class = "field", string  $error_class = "error-message") : array

Process the validation errors and return human readable error messages

Parameters

boolean $convert_to_string

= false

string $field_class
string $error_class

Returns

array

filter()

filter(mixed  $input, array  $filterset) : mixed

Filter the input data according to the specified filter set

Parameters

mixed $input
array $filterset

Returns

mixed

filter_noise_words()

filter_noise_words(string  $value, array  $params = NULL) : string

Replace noise words in a string (http://tax.cchgroup.com/help/Avoiding_noise_words_in_your_search.htm)

Usage: '' => 'noise_words'

Parameters

string $value
array $params

Returns

string

filter_rmpunctuation()

filter_rmpunctuation(string  $value, array  $params = NULL) : string

Remove all known punctuation from a string

Usage: '' => 'rmpunctuataion'

Parameters

string $value
array $params

Returns

string

filter_sanitize_string()

filter_sanitize_string(string  $value, array  $params = NULL) : string

Sanitize the string by removing any script tags

Usage: '' => 'sanitize_string'

Parameters

string $value
array $params

Returns

string

filter_urlencode()

filter_urlencode(string  $value, array  $params = NULL) : string

Sanitize the string by urlencoding characters

Usage: '' => 'urlencode'

Parameters

string $value
array $params

Returns

string

filter_htmlencode()

filter_htmlencode(string  $value, array  $params = NULL) : string

Sanitize the string by converting HTML characters to their HTML entities

Usage: '' => 'htmlencode'

Parameters

string $value
array $params

Returns

string

filter_sanitize_email()

filter_sanitize_email(string  $value, array  $params = NULL) : string

Sanitize the string by removing illegal characters from emails

Usage: '' => 'sanitize_email'

Parameters

string $value
array $params

Returns

string

filter_sanitize_numbers()

filter_sanitize_numbers(string  $value, array  $params = NULL) : string

Sanitize the string by removing illegal characters from numbers

Parameters

string $value
array $params

Returns

string

filter_basic_tags()

filter_basic_tags(string  $value, array  $params = NULL) : string

Filter out all HTML tags except the defined basic tags

Parameters

string $value
array $params

Returns

string

filter_whole_number()

filter_whole_number(string  $value, array  $params = NULL) : string

Convert the provided numeric value to a whole number

Parameters

string $value
array $params

Returns

string

validate_contains()

validate_contains(string  $field, array  $input,   $param = NULL) : mixed

Verify that a value is contained within the pre-defined value set

Usage: '' => 'contains,value value value'

Parameters

string $field
array $input
$param

Returns

mixed

validate_required()

validate_required(string  $field, array  $input,   $param = NULL) : mixed

Check if the specified key is present and not empty

Usage: '' => 'required'

Parameters

string $field
array $input
$param

Returns

mixed

validate_valid_email()

validate_valid_email(string  $field, array  $input,   $param = NULL) : mixed

Determine if the provided email is valid

Usage: '' => 'valid_email'

Parameters

string $field
array $input
$param

Returns

mixed

validate_max_len()

validate_max_len(string  $field, array  $input,   $param = NULL) : mixed

Determine if the provided value length is less or equal to a specific value

Usage: '' => 'max_len,240'

Parameters

string $field
array $input
$param

Returns

mixed

validate_min_len()

validate_min_len(string  $field, array  $input,   $param = NULL) : mixed

Determine if the provided value length is more or equal to a specific value

Usage: '' => 'min_len,4'

Parameters

string $field
array $input
$param

Returns

mixed

validate_exact_len()

validate_exact_len(string  $field, array  $input,   $param = NULL) : mixed

Determine if the provided value length matches a specific value

Usage: '' => 'exact_len,5'

Parameters

string $field
array $input
$param

Returns

mixed

validate_alpha()

validate_alpha(string  $field, array  $input,   $param = NULL) : mixed

Determine if the provided value contains only alpha characters

Usage: '' => 'alpha'

Parameters

string $field
array $input
$param

Returns

mixed

validate_alpha_numeric()

validate_alpha_numeric(string  $field, array  $input,   $param = NULL) : mixed

Determine if the provided value contains only alpha-numeric characters

Usage: '' => 'alpha_numeric'

Parameters

string $field
array $input
$param

Returns

mixed

validate_alpha_dash()

validate_alpha_dash(string  $field, array  $input,   $param = NULL) : mixed

Determine if the provided value contains only alpha characters with dashed and underscores

Usage: '' => 'alpha_dash'

Parameters

string $field
array $input
$param

Returns

mixed

validate_numeric()

validate_numeric(string  $field, array  $input,   $param = NULL) : mixed

Determine if the provided value is a valid number or numeric string

Usage: '' => 'numeric'

Parameters

string $field
array $input
$param

Returns

mixed

validate_integer()

validate_integer(string  $field, array  $input,   $param = NULL) : mixed

Determine if the provided value is a valid integer

Usage: '' => 'integer'

Parameters

string $field
array $input
$param

Returns

mixed

validate_boolean()

validate_boolean(string  $field, array  $input,   $param = NULL) : mixed

Determine if the provided value is a PHP accepted boolean

Usage: '' => 'boolean'

Parameters

string $field
array $input
$param

Returns

mixed

validate_float()

validate_float(string  $field, array  $input,   $param = NULL) : mixed

Determine if the provided value is a valid float

Usage: '' => 'float'

Parameters

string $field
array $input
$param

Returns

mixed

validate_valid_url()

validate_valid_url(string  $field, array  $input,   $param = NULL) : mixed

Determine if the provided value is a valid URL

Usage: '' => 'valid_url'

Parameters

string $field
array $input
$param

Returns

mixed

validate_url_exists()

validate_url_exists(string  $field, array  $input,   $param = NULL) : mixed

Determine if a URL exists & is accessible

Usage: '' => 'url_exists'

Parameters

string $field
array $input
$param

Returns

mixed

validate_valid_ip()

validate_valid_ip(string  $field, array  $input,   $param = NULL) : mixed

Determine if the provided value is a valid IP address

Usage: '' => 'valid_ip'

Parameters

string $field
array $input
$param

Returns

mixed

validate_valid_ipv4()

validate_valid_ipv4(  $field,   $input,   $param = NULL) 

Parameters

$field
$input
$param

validate_valid_ipv6()

validate_valid_ipv6(string  $field, array  $input,   $param = NULL) : mixed

Determine if the provided value is a valid IPv6 address

Usage: '' => 'valid_ipv6'

Parameters

string $field
array $input
$param

Returns

mixed

validate_valid_name()

validate_valid_name(string  $field, array  $input,   $param = NULL) : mixed

Determine if the input is a valid human name [Credits to http://github.com/ben-s]

See: https://github.com/Wixel/GUMP/issues/5 Usage: '' => 'valid_name'

Parameters

string $field
array $input
$param

Returns

mixed

validate_street_address()

validate_street_address(string  $field, array  $input,   $param = NULL) : mixed

Determine if the provided input is likely to be a street address using weak detection

Usage: '' => 'street_address'

Parameters

string $field
array $input
$param

Returns

mixed

validate_iban()

validate_iban(string  $field, array  $input,   $param = NULL) : mixed

Determine if the provided value is a valid IBAN

Usage: '' => 'iban'

Parameters

string $field
array $input
$param

Returns

mixed

validate_date()

validate_date(string  $field, string  $input, null  $param = null) : mixed

Determine if the provided input is a valid date (ISO 8601)

Usage: '' => 'date'

Parameters

string $field
string $input

date ('Y-m-d') or datetime ('Y-m-d H:i:s')

null $param

Returns

mixed

validate_max_numeric()

validate_max_numeric(string  $field, array  $input, null  $param = null) : mixed

Determine if the provided numeric value is lower or equal to a specific value

Usage: '' => 'max_numeric,50'

Parameters

string $field
array $input
null $param

Returns

mixed

validate_min_numeric()

validate_min_numeric(string  $field, array  $input, null  $param = null) : mixed

Determine if the provided numeric value is higher or equal to a specific value

Usage: '' => 'min_numeric,1'

Parameters

string $field
array $input
null $param

Returns

mixed

check_fields()

check_fields(array  $data) 

Ensure that the field counts match the validation rule counts

Parameters

array $data

trimScalar()

trimScalar(mixed  $value) : mixed

Trims whitespace only when the value is a scalar

Parameters

mixed $value

Returns

mixed