Créer un nouveau critère de personnalisation de contenu (criteria)

Utilisation de l’objet DataSource

Le système de critères de Victoire repose sur l’objet DataSource dont le rôle est de fournir :

• des méthodes qui retournent la valeur qui sert de filtre.
• des paramètres de formulaire qui seront utilisés dans la modale des widgets

Etude de cas

Victoire inclut de base 2 types de fitres :

• un filtre sur la locale (ou language courant) : _locale

• un filtre sur le protocole : scheme http

  https

Nous allons étudier le filtre sur la locale à titre d’exemple.

#Victoire\Bundle\CriteriaBundle\DataSource

[...]

class RequestDataSource
{
    /**
     * @var RequestStack
     */
    private $requestStack;
    private $availableLocales;

    /**
     * RequestCriteria constructor.
     *
     * @param RequestStack $requestStack
     * @param              $availableLocales
     */
    public function __construct(RequestStack $requestStack, $availableLocales)
    {
        $this->requestStack = $requestStack;
        $this->availableLocales = $availableLocales;
    }

    public function getLocale()
    {
        return $this->requestStack->getCurrentRequest()->getLocale();
    }

[...]

    public function getLocaleFormParams()
    {
        return [
            'type'    => ChoiceType::class,
            'options' => [
                'choices' => $this->availableLocales,
            ],
        ];
    }

[...]

}

• La méthode “getLocale” retourne la locale de la requête courante
• La méthode “getLocaleFormParams” retourne le tableau de paramètres nécessaires pour générer un élément de formulaire de type Choice avec les locales activées comme choix.

Créer un nouveau critère de personnalisation de contenu

A. Utilisation du BaseDataSourceProxy

La solution la plus simple pour créer un Critère est de définir n’importe quel object de votre application comme utilisable en tant que Critère. Pour cela, il faut tagger l’object en question de la façon suivante:

app.my_object:
    class: App\MyObject
    tags:
        - { name: victoire_criteria, group: yyy, method: getMyProperty, alias: my_property }

Lorsque ce Critère sera appelé, la méthode “getMyProperty” sera appelé et sa valeur sera comparée au critère saisi.

B. Création d’un Objet “DataSource”

Dans certains cas, l’usage d’un Objet DataSource est nécessaire. Un exemple concret est le RequestDataSource qui se base sur la requète courante. Il n’est pas possible de simplement tagger l’objet RequestStack car la méthode getLocale n’existe pas dans cet objet. Il a fallu créer un DataSource personnalisé afin de déclarer la méthode getLocale qui n’est qu’un proxy vers $requestStack->getCurrentRequest()->getLocale(). Voici la procédure pour créer un DataSource personnalisé.

1. Création de l’objet “DataSource”

Créer un nouvel objet “DataSource” qui implémente chacune des 2 méthodes :

• “getXxx” : définit la valeur Xxx servant de filtre
• “getXxxFormParams” : définit le formulaire intégrant les différentes variables possibles de la valeur Xxx

2. Déclaration de l’objet

Pour qu’il soit reconnu par Victoire comme un nouveau critère, il faut le déclarer en tant que service avec le tag suivant :

tags:
    - { name: victoire_criteria, group: yyy, method: getXxx, alias: xxx }

Le tag propose d’associer un group au critère. Ce groupe est utilisé pour afficher les différents critères par section. Vous êtes libres d’utiliser un groupe déjà existant ou d’en créer un nouveau.