Using filters with CGridView and CArrayDataProvider Follow @yiiframework

Awesome post :D

Blacklisting possible user input and using eval(), damn scary indeed!

Why don't make a more rigid and secure code using switch with cases for your comparison operators, at the same time teaching readers how to do this properly?

@karmraj : the problem is not with the filters, but with CArrayProvider you created. try something like this :

$dataProvider=new CArrayDataProvider($filteredData, array('keyField'=>'branch_id'));

when you dont have column 'id' in your data, then you need to defined the unique key for CArrayDataProvider manually, as the default value is column with the name 'id'. In the example above the keyField is assigned to branch_id column, change the value "branch_id' to whatever primary key you have in you data.

@marcovtwout : i got little bit solution regarding this issue. when i will change my table column name branch_id to id then above issue will solve except the filter is not working...

@marcovtwout : Thanx for quick response. I have already declare branch_id as primary key in branch table. And now i have also set filter false in columns attributes. But still getting same result.

$columns = array(

    array(
    'header'=>CHtml::encode('branch name'),
    'name'=>'branch_name',
    'filter'=>false,
    ),

);1.

Your problem has nothing to do with the filtering, I think (try setting filter=>false). Have you set your column branch_id in table Branch to be the primary key? Also, consider naming the column "id", calling it branch_id is redundant, and it plays nice with Yii's default expectations.

You can also try to set the property keyAttribute to 'branch_id' in the construction of the dataprovider: http://www.yiiframework.com/doc/api/1.1/CActiveDataProvider#keyAttribute-detail

Following my code which i have use. I dont get what is an issue. I am constantly getting same error as : Property "Branch.id" is not defined. There no field in my branch table name as id.

FiltersForm model file

class FiltersForm extends CFormModel { public $filters = array();

/**
 * Override magic getter for filters
 */
public function __get($name)
{
//print_r($name); exit;
    if(!array_key_exists($name, $this->filters))
        $this->filters[$name] = null;
    return $this->filters[$name];
}

/**
 * Filter input array by key value pairs
 * @param array $data rawData
 * @return array filtered data array
 */
public function filter(array $data)
{
    foreach($data AS $rowIndex => $row) {
        foreach($this->filters AS $key => $value) {
            // unset if filter is set, but doesn't match
            if(array_key_exists($key, $row) AND !empty($value)) {
                if(stripos($row[$key], $value) === false)
                    unset($data[$rowIndex]);
            }
        }
    }
    return $data;
}

}

Controller Action

public function actionAdminNew()
{
    $filtersForm=new FiltersForm;
    if (isset($_GET['FiltersForm']))
        $filtersForm->filters=$_GET['FiltersForm'];

    // Get rawData and create dataProvider
    $rawData=Branch::model()->findAll();
    $filteredData=$filtersForm->filter($rawData);
    $dataProvider=new CArrayDataProvider($filteredData);

    // Render
    $this->render('adminNew', array(
        'filtersForm' => $filtersForm,
        'dataProvider' => $dataProvider,
    ));
}

view file :

Whoops, totally missed out on this wiki article. Just updated wrong example code in Controller, it was not using critical filter function!

I looked at the other comments but decided to keep the article as is: filter the data BEFORE creating the data provider, bit easier. :)

Thanks for your nice post. You will also need to set "totalItemCount" before returning data in the "filter" function, to get pagination works correctly after filtering.

$data->totalItemCount=count($data->rawData);

i use Chessspider approach, but with minor modification on the filter() function to refresh dataprovider rawData so the pagination will be correct and filter can be perform nicely as we want to.

so here's the filter() function

/**
     * Filter input array by key value pairs
     * @param CarrayDataProvider $data
     * @return CarrayDataProvider Filtered data array
     */
    public function filter(CArrayDataProvider $data)
    {
        $temp = $data->rawData;
 
        foreach ($temp AS $index => $item)
        {
            foreach ($this->filters AS $key => $value)
            {
                if($value == '') continue; // bypass empty filter
 
                $test = false;  // value to test for
 
                if($item instanceof CModel)
                {
                    if(isset($item->$key) == false ) throw new CException("Property ".get_class($item)."::{$key} does not exist!");
                    $test = $item->$key;
                }
                elseif(is_array($item))
                {
                    if(!array_key_exists($key, $item)) throw new CException("Key {$key} does not exist in Array!");
                    $test = $item[$key];
                }
                else
                    throw new CException("Data in CArrayDataProvider must be an array of arrays or CModels!");
 
                if(stripos($test, $value) === false)
                    unset($temp[$index]);
            }
        }
 
        $data->rawData = array_values($temp);
        return $data;
    }

I had to modify the filter() method to this:

/**
     * Filter input array by key value pairs
     * @param CarrayDataProvider $data
     * @return CarrayDataProvider Filtered data array
     */
    public function filter(CArrayDataProvider $data)
    {
        $temp = $data->getData();
 
        foreach ($temp AS $index => $item)
        {
            foreach ($this->filters AS $key => $value)
            {
                if($value == '') continue; // bypass empty filter
 
                $test = false;  // value to test for
 
                if($item instanceof CModel)
                {
                    if(isset($item->$key) == false ) throw new CException("Property ".get_class($item)."::{$key} does not exist!");
                    $test = $item->$key;
                }
                elseif(is_array($item))
                {
                    if(!array_key_exists($key, $item)) throw new CException("Key {$key} does not exist in Array!");
                    $test = $item[$key];
                }
                else
                    throw new CException("Data in CArrayDataProvider must be an array of arrays or CModels!");
 
                if(stripos($test, $value) === false)
                    unset($temp[$index]);
            }
        }
 
        $data->setData(array_values($temp));
        return $data;
    }

and the controller Render-call to this:

$this->render('missingcomputers', array(
            'dataProvider' => $filtersForm->filter($dataProvider),
            'filtersForm' => $filtersForm,
        ));

I copied it over 1:1, literally. Yet it still refuses to do any filtering whatsoever.

It shows all data, and the filter box appears. However when I enter text in it, no filtering occurs. There is no change whatsoever.

Any ideas what could be the problem?