\Charcoal\SourceFilterInterface

Summary

Methods
Constants
setData()
setActive()
active()
setProperty()
property()
setVal()
val()
setOperator()
operator()
setFunc()
func()
setOperand()
operand()
setTableName()
tableName()
setString()
string()
No constants found
No protected methods found
N/A
No private methods found
N/A

Methods

setData()

setData(array  $data) : \Charcoal\Source\Filter

Parameters

array $data

The filter data.

Returns

\Charcoal\Source\Filter

Chainable

setActive()

setActive(boolean  $active) : \Charcoal\Source\FilterInterface

Parameters

boolean $active

The active flag.

Returns

\Charcoal\Source\FilterInterface

Chainable

active()

active() : boolean

Returns

boolean

setProperty()

setProperty(string  $property) : \Charcoal\Source\FilterInterface

Parameters

string $property

The filter's property.

Throws

\Charcoal\Source\InvalidArgumentException

If the property argument is not a string.

Returns

\Charcoal\Source\FilterInterface

Chainable

property()

property() : string

Returns

string

val()

val() : mixed

Returns

mixed

setOperator()

setOperator(string  $operator) : \Charcoal\Source\FilterInterface

Parameters

string $operator

The filter operator.

Returns

\Charcoal\Source\FilterInterface

Chainable

operator()

operator() : string

Returns

string

setFunc()

setFunc(string  $func) : \Charcoal\Source\FilterInterface

Parameters

string $func

The filter function.

Returns

\Charcoal\Source\FilterInterface

Chainable

func()

func() : string

Returns

string

setOperand()

setOperand(string  $operand) : \Charcoal\Source\FilterInterface

Parameters

string $operand

The filter operand.

Returns

\Charcoal\Source\FilterInterface

Chainable

operand()

operand() : string

Returns

string

setTableName()

setTableName(string  $tableName) : \Charcoal\Source\FilterInterface

Parameters

string $tableName

The table name (default to objTable).

Returns

\Charcoal\Source\FilterInterface

Chainable

tableName()

tableName() : string

Returns

string

setString()

setString(string  $sql) : \Charcoal\Source\FilterInterface

Parameters

string $sql

The filter SQL string.

Returns

\Charcoal\Source\FilterInterface

Chainable

string()

string() : string

Returns

string