Avi documentation

Filter
in package

Filter class

Tags
author

aviato-vasile

Table of Contents

Constants

FILTER_ACTIONS  = ['validate', 'sanitize']
FILTER_DEF_GROUP_BY_TYPE  = 1
FILTER_DEF_GROUP_BY_VAR  = 2
FILTER_DEF_INVALID  = 0
FILTER_INPUT_TYPE  = [INPUT_POST, INPUT_GET, INPUT_COOKIE, INPUT_ENV, INPUT_SERVER]

Properties

$input  : mixed
$data  : mixed
$definition  : mixed

Methods

__construct()  : mixed
add()  : mixed
check()  : mixed
get()  : null|mixed
Return a filtered get value if set
post()  : null|mixed
Return a filtered post value if set
request()  : null|mixed
Return a filtered request value made from concatenation of get and post
var()  : null|mixed
Return a filtered variable of type
xssClean()  : mixed
Xss Clean for variable $var
customFilter()  : mixed
getDefinitionGroup()  : string|int
Determinate the definition group pattern (by variable | by input type } invalid)
parseDefinition()  : bool|array<string|int, mixed>
Parse the definition array, return false on invalid definition
sanitizeData()  : void
Wrapper for finlter_var_array
transformDefGroupByVarToType()  : mixed
validateAntiXssData()  : mixed
validateInput()  : mixed
Simple wrapper for filter_input_array

Constants

FILTER_ACTIONS

public mixed FILTER_ACTIONS = ['validate', 'sanitize']

FILTER_DEF_GROUP_BY_TYPE

public mixed FILTER_DEF_GROUP_BY_TYPE = 1

FILTER_DEF_GROUP_BY_VAR

public mixed FILTER_DEF_GROUP_BY_VAR = 2

FILTER_DEF_INVALID

public mixed FILTER_DEF_INVALID = 0

FILTER_INPUT_TYPE

public mixed FILTER_INPUT_TYPE = [INPUT_POST, INPUT_GET, INPUT_COOKIE, INPUT_ENV, INPUT_SERVER]

Properties

$definition

protected mixed $definition

Methods

__construct()

public __construct([array<string|int, mixed> $definition = null ]) : mixed
Parameters
$definition : array<string|int, mixed> = null

is an array of filtering definitions

add()

public add(int $input_type, string $action, array<string|int, mixed> $filterVariable) : mixed
Parameters
$input_type : int
$action : string
$filterVariable : array<string|int, mixed>

check()

public check([mixed $add_empty = false ]) : mixed
Parameters
$add_empty : mixed = false

get()

Return a filtered get value if set

public get(string $key[, array<string|int, mixed> $filter = [] ]) : null|mixed
Parameters
$key : string
$filter : array<string|int, mixed> = []
Return values
null|mixed

post()

Return a filtered post value if set

public post(string $key[, array<string|int, mixed> $filter = [] ]) : null|mixed
Parameters
$key : string
$filter : array<string|int, mixed> = []
Return values
null|mixed

request()

Return a filtered request value made from concatenation of get and post

public request(string $key[, array<string|int, mixed> $filter = [] ]) : null|mixed
Parameters
$key : string
$filter : array<string|int, mixed> = []
Return values
null|mixed

var()

Return a filtered variable of type

public var(string $key[, int $type = INPUT_POST ][, array<string|int, mixed> $filterOpt = [] ]) : null|mixed
Parameters
$key : string
$type : int = INPUT_POST

: GET|POST|COOKIE|SERVER

$filterOpt : array<string|int, mixed> = []

  • a simple array containing the filter id + options e.g. filterOpt = [ id=>FILTER_VALIDATE_INT ]

      filterOpt = [
  	id = FILTER_VALIDATE_INT,
  	options => [
  		min_range => 1
  		max_range => 100
  	]
  	flags => FILTER_FLAG_ALLOW_OCTAL | FILTER_FLAG_ALLOW_HEX | FILTER_NULL_ON_FAILURE
  ]

  filterOpt = [
  	id = FILTER_VALIDATE_REGEXP
  	options = [
  		regex =
  	]
  ]
Tags
see
https://www.php.net/manual/en/filter.filters.validate.php
Return values
null|mixed

xssClean()

Xss Clean for variable $var

public xssClean(mixed $var) : mixed
Parameters
$var : mixed

customFilter()

private customFilter([mixed $opt = [] ]) : mixed
Parameters
$opt : mixed = []

getDefinitionGroup()

Determinate the definition group pattern (by variable | by input type } invalid)

private getDefinitionGroup(array<string|int, mixed> $definition) : string|int
Parameters
$definition : array<string|int, mixed>
Return values
string|int

parseDefinition()

Parse the definition array, return false on invalid definition

private parseDefinition(array<string|int, mixed> $definition) : bool|array<string|int, mixed>
Parameters
$definition : array<string|int, mixed>
Return values
bool|array<string|int, mixed>

sanitizeData()

Wrapper for finlter_var_array

private sanitizeData([bool $add_empty = false ]) : void
Parameters
$add_empty : bool = false

transformDefGroupByVarToType()

private transformDefGroupByVarToType(mixed $definition) : mixed
Parameters
$definition : mixed

validateAntiXssData()

private validateAntiXssData() : mixed
Return values
mixed —

filtered var by antixss

validateInput()

Simple wrapper for filter_input_array

private validateInput([bool $add_empty = null ]) : mixed
Parameters
$add_empty : bool = null
Return values
mixed —

filtered array


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results