Documentation

AbstractFilter
in package
implements FilterInterface

AbstractYes

Abstract filter class

Tags
category

Pop

author

Nick Sagona, III dev@nolainteractive.com

copyright

Copyright (c) 2009-2024 NOLA Interactive, LLC. (http://www.nolainteractive.com)

license

http://www.popphp.org/license New BSD License

version
4.0.0

Table of Contents

Interfaces

FilterInterface
Filter interface

Properties

$callable  : CallableObject
Filter callable
$excludeByName  : array<string|int, mixed>
Exclude by name
$excludeByType  : array<string|int, mixed>
Exclude by type

Methods

__construct()  : mixed
Constructor
filter()  : mixed
Filter value
getCallable()  : CallableObject
Get callable
getExcludeByName()  : array<string|int, mixed>
Get exclude by name
getExcludeByType()  : array<string|int, mixed>
Get exclude by type
getParams()  : array<string|int, mixed>
Get params
hasCallable()  : bool
Has callable
hasExcludeByName()  : bool
Has exclude by name
hasExcludeByType()  : bool
Has exclude by type
hasParams()  : bool
Has params
setCallable()  : AbstractFilter
Set callable
setExcludeByName()  : AbstractFilter
Set exclude by name
setExcludeByType()  : AbstractFilter
Set exclude by type
setParams()  : AbstractFilter
Set params

Properties

$excludeByName

Exclude by name

protected array<string|int, mixed> $excludeByName = []

$excludeByType

Exclude by type

protected array<string|int, mixed> $excludeByType = []

Methods

__construct()

Constructor

public __construct(mixed $callable[, mixed $params = null ][, mixed $excludeByName = null ][, mixed $excludeByType = null ]) : mixed

Instantiate the form filter object

Parameters
$callable : mixed
$params : mixed = null
$excludeByName : mixed = null
$excludeByType : mixed = null

filter()

Filter value

public filter(mixed $value[, string|null $name = null ][, mixed $type = null ]) : mixed
Parameters
$value : mixed
$name : string|null = null
$type : mixed = null

getExcludeByName()

Get exclude by name

public getExcludeByName() : array<string|int, mixed>
Return values
array<string|int, mixed>

getExcludeByType()

Get exclude by type

public getExcludeByType() : array<string|int, mixed>
Return values
array<string|int, mixed>

getParams()

Get params

public getParams() : array<string|int, mixed>
Return values
array<string|int, mixed>

hasCallable()

Has callable

public hasCallable() : bool
Return values
bool

hasExcludeByName()

Has exclude by name

public hasExcludeByName() : bool
Return values
bool

hasExcludeByType()

Has exclude by type

public hasExcludeByType() : bool
Return values
bool

hasParams()

Has params

public hasParams() : bool
Return values
bool

        
On this page

Search results