necktie/newsletter

Necktie Newsletter bundle

Trinity Grid

Trinity grid is part of Trinity package., _(*1)

Description:, _(*2)

• Converts an array of entities to array of strings.
• Array of string is convert to JSON:

Documentation

1) Create Grid

Create class extended by BaseGrid. Add templates for change attributes value., _(*3)

class ProductGrid extends BaseGrid
{
    public function setUp()
    {
        $this->addTemplate("ProductGrid.html.twig");
    }
}

Set up

addTemplate     - add new template for changing values. 
setColumnFormat - for basic chage value of date or simple text edit.

Template:, _(*4)

cell_attributeName for change value., _(*5)

{% block cell_name %} Template edit - {{ value }} {% endblock %}

Available variables are: - value - row - entity object, _(*6)

2) Register grid

File: services.yml, _(*7)

services:
  trinity.grid.test.product:
    class: Trinity\Bundle\GridBundle\Tests\Functional\Grid\ProductGrid
    tags:
        - { name: trinity.grid, alias: product }

Tag name: trinity.grid
Alias is mandatory value for searching grids from entity name., _(*8)

Product entity has product alias., _(*9)

Grid filters

Filters are used to change the attribute values., _(*10)

Special grid:

Special filters are used for changing specific attribute (id, name, etc.)., _(*11)

1) Create filter:, _(*12)

Filter -> BaseFilter or FilterInterface!, _(*13)

Attribute 'name' is necessary!, _(*14)

class IdFilter extends BaseFilter
{

    /**
     * @var string
     */
    protected $name = 'id';


    /**
     * @param string|object|int|bool $input
     * @param array $arguments
     * @return string
     */
    function process($input, array $arguments = []) : string
    {
        return $input.'.';
    }
}

2) Grid registration:, _(*15)

File: service.yml Tag: trinity.grid.filter, _(*16)

trinity.grid.filter.id: class: Trinity\Bundle\GridBundle\Filter\IdFilter tags: - {name: "trinity.grid.filter"}, _(*17)

3) Set up filter for current grid:, _(*18)

 $this->setColumnFilter('id', 'id');

First attribute 'id' -> column name., _(*19)

Second attribute -> filter name., _(*20)

Global filters

For global filter must be set attribute 'global' to TRUE;, _(*21)

Attribute 'name' is not necessary., _(*22)

class ObjectFilter extends BaseFilter
{
    protected $global = true;

    /**
     * @param string|object|int|bool $input
     * @param array $arguments
     * @return string
     */
    function process($input, array $arguments = []) : string
    {

        if ((is_object($input) && method_exists($input, 'getName'))) {
            $input = $input->getName();
        } elseif (is_object($input)) {
            $input = (string)$input;
        }

        return $input;
    }
}

3) Parse entity array to array of strings

From container pull service 'trinity.grid.manager', _(*23)

$manager = $container->get('trinity.grid.manager');

Parse array of entities:, _(*24)

$stringArray = $manager->convertEntitiesToArray(
            $this->getArrayOfEntities(),                                        // array of entities
            ['id', 'name', 'description', 'nonexistentColumn', 'createdAt']     // columns
        );

From the entity name is found grid. $stringArray is must be convert to JSON., _(*25)