PHP Class ManaPHP\Http\Filter

Inheritance: extends ManaPHP\Component, implements ManaPHP\Http\FilterInterface
Show file Open project: manaphp/manaphp

Protected Properties

Property Type Description
$_attributes array
$_defaultMessage string
$_filters array
$_messages array | string
$_rules array
$_xssByReplace boolean

Public Methods

Method Description
__construct ( array $options = [] ) Filter constructor.
addFilter ( string $name, callable $method ) : static
addRule ( string $attribute, string $rule, string $name = null ) : static
dump ( ) : array
sanitize ( string $attribute, string $rule, string | integer | boolean | array $value ) : mixed

Protected Methods

Method Description
_filter_account ( string $value ) : string | null
_filter_alnum ( string $value ) : string | null
_filter_alpha ( string $value ) : string | null
_filter_bool ( string $value ) : boolean | null
_filter_date ( string $value ) : integer | null
_filter_default ( mixed $value, array $parameters ) : mixed
_filter_digit ( string $value ) : string | null
_filter_email ( string $value ) : string | null
_filter_equal ( string $value, array $parameters ) : string | null
_filter_float ( string $value ) : float | null
_filter_ignore ( mixed $value ) : mixed
_filter_in ( string $value, array $parameters ) : string | null
_filter_int ( string $value ) : integer | null
_filter_ip ( string $value ) : string | null
_filter_json ( string $value ) : mixed | null
_filter_length ( string $value, array $parameters ) : string | null
_filter_lower ( string $value ) : string
_filter_max ( string $value, array $parameters ) : float | null
_filter_maxLength ( string $value, array $parameters ) : string | null
_filter_min ( string $value, array $parameters ) : float | null
_filter_minLength ( string $value, array $parameters ) : string | null
_filter_mobile ( string $value ) : string | null
_filter_not_in ( string $value, array $parameters ) : string | null
_filter_password ( string $value ) : string | null
_filter_range ( string $value, array $parameters ) : integer | null
_filter_regex ( string $value, array $parameters ) : string | null
_filter_required ( string $value ) : string | null
_filter_secint ( string $value, array $parameters ) : integer | null
_filter_upper ( string $value ) : string
_filter_url ( string $value ) : string | null
_filter_xss ( string $value, array $parameters ) : string
_parseRule ( string $rule ) : array
_sanitize ( string $attribute, string $filter, array $parameters, mixed $value ) : mixed

Method Details

__construct() public method

Filter constructor.
public __construct ( array $options = [] )
$options array

_filter_account() protected method

protected _filter_account ( string $value ) : string | null
$value string
return string | null

_filter_alnum() protected method

protected _filter_alnum ( string $value ) : string | null
$value string
return string | null

_filter_alpha() protected method

protected _filter_alpha ( string $value ) : string | null
$value string
return string | null

_filter_bool() protected method

protected _filter_bool ( string $value ) : boolean | null
$value string
return boolean | null

_filter_date() protected method

protected _filter_date ( string $value ) : integer | null
$value string
return integer | null

_filter_default() protected method

protected _filter_default ( mixed $value, array $parameters ) : mixed
$value mixed
$parameters array
return mixed

_filter_digit() protected method

protected _filter_digit ( string $value ) : string | null
$value string
return string | null

_filter_email() protected method

protected _filter_email ( string $value ) : string | null
$value string
return string | null

_filter_equal() protected method

protected _filter_equal ( string $value, array $parameters ) : string | null
$value string
$parameters array
return string | null

_filter_float() protected method

protected _filter_float ( string $value ) : float | null
$value string
return float | null

_filter_ignore() protected method

protected _filter_ignore ( mixed $value ) : mixed
$value mixed
return mixed

_filter_in() protected method

protected _filter_in ( string $value, array $parameters ) : string | null
$value string
$parameters array
return string | null

_filter_int() protected method

protected _filter_int ( string $value ) : integer | null
$value string
return integer | null

_filter_ip() protected method

protected _filter_ip ( string $value ) : string | null
$value string
return string | null

_filter_json() protected method

protected _filter_json ( string $value ) : mixed | null
$value string
return mixed | null

_filter_length() protected method

protected _filter_length ( string $value, array $parameters ) : string | null
$value string
$parameters array
return string | null

_filter_lower() protected method

protected _filter_lower ( string $value ) : string
$value string
return string

_filter_max() protected method

protected _filter_max ( string $value, array $parameters ) : float | null
$value string
$parameters array
return float | null

_filter_maxLength() protected method

protected _filter_maxLength ( string $value, array $parameters ) : string | null
$value string
$parameters array
return string | null

_filter_min() protected method

protected _filter_min ( string $value, array $parameters ) : float | null
$value string
$parameters array
return float | null

_filter_minLength() protected method

protected _filter_minLength ( string $value, array $parameters ) : string | null
$value string
$parameters array
return string | null

_filter_mobile() protected method

protected _filter_mobile ( string $value ) : string | null
$value string
return string | null

_filter_not_in() protected method

protected _filter_not_in ( string $value, array $parameters ) : string | null
$value string
$parameters array
return string | null

_filter_password() protected method

protected _filter_password ( string $value ) : string | null
$value string
return string | null

_filter_range() protected method

protected _filter_range ( string $value, array $parameters ) : integer | null
$value string
$parameters array
return integer | null

_filter_regex() protected method

protected _filter_regex ( string $value, array $parameters ) : string | null
$value string
$parameters array
return string | null

_filter_required() protected method

protected _filter_required ( string $value ) : string | null
$value string
return string | null

_filter_secint() protected method

protected _filter_secint ( string $value, array $parameters ) : integer | null
$value string
$parameters array
return integer | null

_filter_upper() protected method

protected _filter_upper ( string $value ) : string
$value string
return string

_filter_url() protected method

protected _filter_url ( string $value ) : string | null
$value string
return string | null

_filter_xss() protected method

protected _filter_xss ( string $value, array $parameters ) : string
$value string
$parameters array
return string

_parseRule() protected method

protected _parseRule ( string $rule ) : array
$rule string
return array

_sanitize() protected method

protected _sanitize ( string $attribute, string $filter, array $parameters, mixed $value ) : mixed
$attribute string
$filter string
$parameters array
$value mixed
return mixed

addFilter() public method

public addFilter ( string $name, callable $method ) : static
$name string
$method callable
return static

addRule() public method

public addRule ( string $attribute, string $rule, string $name = null ) : static
$attribute string
$rule string
$name string
return static

dump() public method

public dump ( ) : array
return array

sanitize() public method

public sanitize ( string $attribute, string $rule, string | integer | boolean | array $value ) : mixed
$attribute string
$rule string
$value string | integer | boolean | array
return mixed

Property Details

$_attributes protected property

protected array $_attributes
return array

$_defaultMessage protected property

protected string $_defaultMessage
return string

$_filters protected property

protected array $_filters
return array

$_messages protected property

protected array|string $_messages
return array | string

$_rules protected property

protected array $_rules
return array

$_xssByReplace protected property

protected bool $_xssByReplace
return boolean