Overview

Namespaces

  • Charcoal
    • Loader
    • Model
      • Service
      • ServiceProvider
    • Source
      • Database
    • Validator

Classes

  • AbstractSource
  • DatabaseSource
  • DatabaseSourceConfig
  • Filter
  • Order
  • Pagination
  • SourceConfig

Interfaces

  • DatabaseSourceInterface
  • FilterInterface
  • OrderInterface
  • PaginationInterface
  • SourceInterface
  • StorableInterface

Traits

  • StorableTrait
  • Overview
  • Namespace
  • Class

Interface FilterInterface

Direct known implementers

Charcoal\Source\Filter

Indirect known implementers

Charcoal\Source\Database\DatabaseFilter
Namespace: Charcoal\Source
Located at Charcoal/Source/FilterInterface.php
Methods summary
public Charcoal\Source\Filter
# setData( array $data )

Parameters

$data
The filter data.

Returns

Charcoal\Source\Filter
Chainable
public Charcoal\Source\FilterInterface
# setActive( boolean $active )

Parameters

$active
The active flag.

Returns

Charcoal\Source\FilterInterface
Chainable
public boolean
# active( )

Returns

boolean
public Charcoal\Source\FilterInterface
# setProperty( string $property )

Parameters

$property
The filter's property.

Returns

Charcoal\Source\FilterInterface
Chainable

Throws

InvalidArgumentException
If the property argument is not a string.
public string
# property( )

Returns

string
public Charcoal\Source\FilterInterface
# setVal( mixed $val )

Parameters

$val
The filter value.

Returns

Charcoal\Source\FilterInterface
Chainable
public mixed
# val( )

Returns

mixed
public Charcoal\Source\FilterInterface
# setOperator( string $operator )

Parameters

$operator
The filter operator.

Returns

Charcoal\Source\FilterInterface
Chainable
public string
# operator( )

Returns

string
public Charcoal\Source\FilterInterface
# setFunc( string $func )

Parameters

$func
The filter function.

Returns

Charcoal\Source\FilterInterface
Chainable
public string
# func( )

Returns

string
public Charcoal\Source\FilterInterface
# setOperand( string $operand )

Parameters

$operand
The filter operand.

Returns

Charcoal\Source\FilterInterface
Chainable
public string
# operand( )

Returns

string
public Charcoal\Source\FilterInterface
# setTableName( string $tableName )

Parameters

$tableName
The table name (default to objTable).

Returns

Charcoal\Source\FilterInterface
Chainable
public string
# tableName( )

Returns

string
public Charcoal\Source\FilterInterface
# setString( string $sql )

Parameters

$sql
The filter SQL string.

Returns

Charcoal\Source\FilterInterface
Chainable
public string
# string( )

Returns

string
API documentation generated by ApiGen