survos/api-grid-bundle

incorporate DatatablesNet, using twig and stimulus, twig_component requires ^2.2

1.5.529 2025-02-24 18:21 UTC

Requires

• php: ^8.3
• doctrine/doctrine-bundle: ^2.7
• doctrine/orm: ^2.12 || ^3.3
• doctrine/persistence: ^2.0 || ^3.0
• survos/inspection-bundle: ^1.5
• symfony/config: ^6.4 || ^7.1
• symfony/dependency-injection: ^6.4 || ^7.1
• symfony/dom-crawler: ^6.4 || ^7.1
• symfony/http-kernel: ^6.4 || ^7.1
• symfony/options-resolver: ^6.4 || ^7.1
• symfony/ux-twig-component: ^2.8
• twig/twig: ^3.18
• zenstruck/console-extra: ^1.4

Requires (Dev)

• api-platform/doctrine-orm: ^4.0
• api-platform/symfony: ^3.2||^4.0
• meilisearch/meilisearch-php: ^1.6
• nyholm/psr7: ^1.0
• phpstan/phpstan: ^2.0
• rector/rector: ^2.0
• roave/security-advisories: dev-latest
• symfony/browser-kit: ^6.4 || ^7.1
• symfony/framework-bundle: ^6.4 || ^7.1
• symfony/http-client: ^6.4 || ^7.1
• symfony/intl: ^6.4 || ^7.1
• symfony/phpunit-bridge: ^6.4 || ^7.1
• symfony/stopwatch: ^6.4 || ^7.1
• symfony/twig-bundle: ^6.4 || ^7.1
• symfony/ux-chartjs: ^2.21
• symfony/var-dumper: ^6.4 || ^7.1
• zenstruck/class-metadata: ^1.1

Suggests

• api-platform/doctrine-common: doctrine integration
• api-platform/symfony: For javascript-based grid rendering
• friendsofsymfony/jsrouting-bundle: use path() in javascript grid rendering
• monolog/monolog: Allows more advanced logging of the application flow

MIT

• Tac Tacelosky

• symfony-ux
• symfony6

README

Use the DataTables.net javascript library with Symfony, Twig and API Platform. requires survos/grid-bundle, which loads the datatables libraries.

composer req survos/api-grid-bundle

Ideas

Import the datasets at https://domohelp.domo.com/hc/en-us/articles/360043931814-Fun-Sample-DataSets https://www.mytechylife.com/2015/09/29/next-and-previous-row-with-jquery-datatables/ https://github.com/lerocha/chinook-database http://2016.padjo.org/tutorials/sqlite-data-starterpacks/#more-info-simplefolks-for-simple-sql

Dev only...

composer config repositories.survos_grid_bundle '{"type": "vcs", "url": "[e-mail]:survos/SurvosApiGridBundle.git"}'

setup

Inorder to use api-grid we need to follow below:

1) Add Survos\CoreBundle\Traits\QueryBuilderHelperTrait in your repository class of the entity for which you want apiGrid

2) you need to set columns variable like below:

        {% set columns = [
        'code',
        'description',
        {name: 'code', sortable: true},
        'description',
        {name: 'countrycode', sortable: true,  browsable: true, searchable: true},
        {name: 'privacyPolicy', browsable: true},
        {name: 'projectLocale', browsable: true},
        ] %}

By default, sortable, browsable, searchable are false.

For those columns you want sortable add sortable: true

For those columns you want to add searchPanes add browsable: true

For those columns you want to add searchable: true

3) For search you need to include below

use Survos\ApiGrid\Api\Filter\MultiFieldSearchFilter;


#[ApiFilter(MultiFieldSearchFilter::class, properties: ['name', 'code'])]
#[ApiFilter(MultiFieldSearchFilter::class, properties: ['firstName', 'lastName', 'officialName'])]
#[ApiFilter(FacetsFieldSearchFilter::class, properties: ['gender', 'currentParty'])]

Here name and code are columns in which you need to search

4) Use below for doctrine searchpane filters

First, make sure you have the necessary counts method by adding the helper trait to the repository class

class OfficialRepository extends ServiceEntityRepository implements QueryBuilderHelperInterface
{
    use QueryBuilderHelperTrait;

Then add the filterable properties to the entity class. You may want to index them to speed up the count query

use Survos\ApiGrid\Api\Filter\FacetsFieldSearchFilter;


#[ApiFilter(FacetsFieldSearchFilter::class, properties: ['gender','state'])]

5) Use below for doctrine order filters

use ApiPlatform\Doctrine\Orm\Filter\OrderFilter;


#[ApiFilter(OrderFilter::class, properties: ['id','objectCount','countryCode'])]

symfony new phpunit-bug --webapp && cd phpunit-bug
composer require --dev symfony/phpunit-bridge
vendor/bin/simple-phpunit

API Bug with doctrine

symfony new api-bug --webapp && cd api-bug
composer config extra.symfony.allow-contrib true
echo "DATABASE_URL=sqlite:///%kernel.project_dir%/var/data.db" > .env.local
composer require api
echo "title,string,80,yes," | sed "s/,/\n/g"  | bin/console -a make:entity Book
bin/console doctrine:schema:update --force --complete

symfony server:start -d
symfony open:local --path=/api

Now add a Book via post

curl -X 'POST' \
  'https://127.0.0.1:8000/api/books' \
  -H 'accept: application/ld+json' \
  -H 'Content-Type: application/ld+json' \
  -d '{
  "title": "Symfony Fast Track"
}'

Brainstorm: jstwig component

<twig:jstwig :data="data>
<section class="containers">
        <h3>
            {{ row.s|length }} Results
        </h3>

    {% for row in row %}
            <div>
                {{- 'Overlay ' ~ i -}}
            </div>
    {% endfor %}
</section>
</twig:jstwig>