README.md

Kaliber5SyliusResourceExtensionBundle

SonataAdmin

This Bundle replaces the ModelManager from the "sonata-project/doctrine-orm-admin-bundle". So you have register this bundle AFTER the SonataAdminBundle in your AppKernel.php

public function registerBundles()
{
    $bundles = array(
        ...
        new Sonata\AdminBundle\SonataAdminBundle(),
        ...
        new Kaliber5\SyliusResourceExtensionBundle\Kaliber5SyliusResourceExtensionBundle(),
        ...
    );
    ...
}

If your entity implements the

Sylius\Component\Translation\Model\TranslatableInterface

you should use the

Kaliber5\SyliusResourceExtensionBundle\SonataAdmin\TranslatableAdminTrait

in your Admin class to inject a default- and fallbackLocale on new created objects.

<php

use Sonata\AdminBundle\Admin\Admin;
use Kaliber5\SyliusResourceExtensionBundle\SonataAdmin\TranslatableAdminTrait;

class ExampleAdmin extends Admin
{
    use TranslatableAdminTrait;
    
    //...   
}

ResourceLoader

This Bundle replace the Sylius ResourceLoader to provide generated URL's compatible with JsonApi. It will remove the trailing slashes from the index routes.

RequestConfiguration

This Bundle replace the Sylius RequestConfiguration class with

Kaliber5\SyliusResourceExtensionBundle\Request\JsonApiRequestConfiguration

It provides the filter query parameter, like suggested in JsonApi:

http://api.example.de/api/users?filter[username]=user1

the filters will be merged with the criteria and applied to the ResourceProviders

Futhermore you'll be able to whitelist your fields in your route configuration under the defaults._sylius.filter key:

//routing.yml
app_user:
    resource: |
      alias: app.user
      only: ['index', 'show']
    type: sylius.resource_api
    prefix: /api
    defaults:
      _format: json
      _sylius:
        filterable: true
        filter: ['username', 'email']

The filter key must be an array if used.

SyliusFilterEntityRepository

Your Repository can extend the

Kaliber5\SyliusResourceExtensionBundle\Repository\SyliusFilterEntityRepository

Then your Repository can apply criteria that contains Json-Data for advanced filtering like:

http://api.example.de/api/users?filter[age]={">":18, "<=":40}

The Json object

For numeric values:

     {">":50, "<=":100}

This will result in the following query expression: key > 50 AND key <= 100

For discrete values:

{"=":["excellent", "good"]}

or:

{"<>":["excellent", "good"]}

This will result in the following query expression: key IN ("excellent", "good") respectively key NOT IN ("excellent", "good")

By default, the criterias will be joined with an "AND" condition, to use an "OR" condition, use:

{"or":{"<":50, ">=":100}}

This will result in the following query expression: key < 50 OR key >= 100

Allowed comparison operators: =, >, >=, <, <=, <>