Transformers

Note

Le module Transformers utilise la classe statique TransformersManager pour gérer les transformations.

Les Transformers sont utilisés pour transformer les données après leur chargement depuis une base de données, ou avant leur affichage dans une vue.

Ajouter des transformers

Soit la classe Author que nous souhaitons utiliser dans notre application :

app/models/Author.php

namespace models;

use Ubiquity\attributes\items\Transformer;

class Author {

   #[Transformer('upper')]
   private $name;

   public function getName(){
      return $this->name;
   }

   public function setName($name){
      $this->name=$name;
   }
}

app/models/Author.php

namespace models;

class Author {
   /**
    * @var string
    * @transformer("upper")
    */
   private $name;

   public function getName(){
      return $this->name;
   }

   public function setName($name){
      $this->name=$name;
   }
}

Un transformer a été ajouté sur le membre name avec l’annotation @transformer , de façon à mettre en majuscules le nom dans les vues.

Génération du cache

Exécuter la commande suivante dans la console pour générer le cache de la classe Author :

Ubiquity init-cache -t=models

Le cache des transformers est généré avec les méta-données des models dans le dossier app/cache/models/Author.cache.php.

Les informations relatives aux transormers peuvent être affichées à partir des devtools :

Ubiquity info:model -m=Author -f=#transformers

Utilisation des transformers

Démarrer le manager TransformersManager depuis le fichier app/config/services.php :

app/config/services.php

\Ubiquity\contents\transformation\TransformersManager::startProd();

Le résultat peut être testé depuis l’interface d’administration :

ou en créant un contrôleur

app/controllers/Authors.php

namespace controllers;

class Authors {

   public function index(){
      DAO::transformersOp='toView';
      $authors=DAO::getAll(Author::class);
      $this->loadDefaultView(['authors'=>$authors]);
   }

}

app/views/Authors/index.html

<ul>
   {% for author in authors %}
      <li>{{ author.name }}</li>
   {% endfor %}
</ul>

Types de transformers

transform

Le type transform est basé sur l’interface TransformerInterface. Il est utilisé lorsque les données doivent être transformées en objet.
Le transormer DateTime est un bon exemple d’un tel transformer :

Au chargement des données, le transformer convertit les données de la base en une instance de php DateTime.
La méthode reverse effectue l’opération inverse ( php date vers date compatible avec la base de données).

toView

Le type toView est basé sur l’interface TransformerViewInterface. Il est utilisé dans le cas où les données transformées doivent être affichées dans une vue.

toForm

Le type toForm est basé sur l’interface TransformerFormInterface. Il est utilisé lorsque les données doivent être affichées dans un formulaire.

Utilisation des transformers

Transformation sur chargement des données

En cas d’omission, l’opération par défaut transformerOp est transform

$authors=DAO::getAll(Author::class);

Définit transformerOp à toView

DAO::transformersOp='toView';
$authors=DAO::getAll(Author::class);

Transformation après chargement

Retourne la valeur du membre transformée

TransformersManager::transform($author, 'name','toView');

Retourne une valeur transformée :

TransformersManager::applyTransformer($author, 'name','john doe','toView');

Transforme une instance en lui appliquant tous les transformers définis :

TransformersManager::transformInstance($author,'toView');

Transformers existants

Transformer	Type(s)	Description
datetime	transform, toView, toForm	Transforme une date issue de la base de données en une instance de DateTime php
upper	toView	Met la valeur du membre en majuscule
lower	toView	Met la valeur du membre en minuscule
firstUpper	toView	Met une majuscule sur la première lettre de la valeur du membre
password	toView	Masque les caractères de la valeur du membre
md5	toView	Hash la valeur en md5

Créer votre propre transformer

Création

Crée un transformer pour afficher un nom d’utilisateur comme une adresse email locale :

app/transformers/toLocalEmail.php

namespace transformers;
use Ubiquity\contents\transformation\TransformerViewInterface;

class ToLocalEmail implements TransformerViewInterface{

   public static function toView($value) {
      if($value!=null) {
         return sprintf('%s@mydomain.local',strtolower($value));
      }
   }

}

Enregistrement

Enregistrer le transformer en exécutant le script suivant :

TransformersManager::registerClassAndSave('localEmail',\transformers\ToLocalEmail::class);

Utilisation

app/models/User.php

namespace models;

use Ubiquity\attributes\items\Transformer;

class User {

   #[Transformer('localEmail')]
   private $name;

   public function getName(){
      return $this->name;
   }

   public function setName($name){
      $this->name=$name;
   }
}

app/models/User.php

namespace models;

class User {
   /**
    * @var string
    * @transformer("localEmail")
    */
   private $name;

   public function getName(){
      return $this->name;
   }

   public function setName($name){
      $this->name=$name;
   }
}

DAO::transformersOp='toView';
$user=DAO::getOne(User::class,"name='Smith'");
echo $user->getName();

Smith user name will be displayed as smith@mydomain.local.