Yii Advanced Filters Extension
  • Package
  • Class

Packages

  • advancedfilters
    • components
    • dbhelpers
    • filters

Classes

  • AfDbCriteria
  • AfException
  • AfParser

Class AfDbCriteria

This class extends CDbCriteria to provide methods to easily add advanced filter conditions.

As long as you aren't using an extended version of CDbCriteria, you can make use of this class. It should be instantiated using the AdvancedFilters::createCriteria() method.

CDbCriteria
Extended by AfDbCriteria
Package: advancedfilters\components
Author: Keith Burton kburton@kappasoft.net
Located at components/AfDbCriteria.php

Methods summary

public
# __construct( array $data = array(), array $config = array() )

Construct a new criteria object.

Construct a new criteria object.

Parameters

$data

the initial property values to pass to the base CDbCriteria class.

$config

override the application level AdvancedFilters configuration.

public AfDbCriteria
# addAdvancedFilterCondition( string $columnExpression, string $filterExpression, string $operator = 'AND', array $config = array() )

Add an advanced filter condition to the existing criteria.

Add an advanced filter condition to the existing criteria.

Parameters

$columnExpression

the disambiguated column name (or a valid SQL expression).

$filterExpression
the entered filter expression.
$operator

the operator used to concatenate the new condition with the existing one. Defaults to 'AND'.

$config

override the application and instance level AdvancedFilters configuration.

Returns

AfDbCriteria
the criteria object to allow chaining.

Magic methods summary

Yii Advanced Filters Extension API documentation generated by ApiGen