manipulate_rows_data.md

Manipulate rows data

You can set a callback to manipulate the row of the grid.
If the callback returns null or don't return the row, the row won't be displayed.

Usage

<?php
...
$source->manipulateRow($callback);

$grid->setSource($source);
...

Method Source::manipulateRow parameters

|parameter|Type|Default value|Description| |:--:|:--|:--|:--|:--| |callback|\Closure or callable|null|Callback to manipulate rows. Null means no callback.|

Callback parameters

|parameter|Type|Description| |:--:|:--|:--|:--|:--| |row|instance of Row|The current row to manipulate|

Examples

<?php
...
$source->manipulateRow(
    function ($row)
    {
        if ($row->getField('enabled') == '1') {
            $row->setClass('border-enabled');  // add a css class to the <tr> tag
            $row->setColor('#00ff00');  // set background-color as inline style
        }
        
        // Don't show the row if the price is greater than 10
        if ($row->getField('price')>10) {
            return null;
        }
        
        return $row;
    }
);

$grid->setSource($source);
...

If you want to pass some context parameters:

<?php
...
$maxPrice = 10;
$soldOutLabel = 'Sold out';

$source->manipulateRow(
    function ($row) use ($maxPrice, $soldOutLabel)
    {
        // Don't show the row if the price is greater than $maxPrice
        if ($row->getField('price') > $maxPrice) {
            return null;
        }
        
        // Change the ouput of the column quantity if anarticle is sold out
        if ($row->getField('quantity') == 0) {
            $row->setField('quantity', $soldOutLabel);
        }
        
        return $row;
    }
);

$grid->setSource($source);
...

Or if you want use the entity of the row:

<?php
class AnEntity{
	private $price;
	private $tax;
	
	...

	public function getPriceWithTax(){
		//Some code in the business layer of your entity

		return $this->price * (1 + $this->tax);
	}
}
?>

<?php
...

$source->manipulateRow(
    function ($row) 
    {       
        // Change the output of the new column with your own code at entity.
        $row->setField('myNewColumn', $row->getEntity()->getPriceWithTax());
    }
);

$grid->setSource($source);