jForms : added a new datasource based on a class

[laurentj]

We could define a datasource based on a class :

  <menulist dsclass="mymodule~myclass">

Then you can create a class which should implements a new interface, jIDatasourceClass

interface jIDatasourceClass {
   function getDatas();
}

The class in mymodule/classes/myclass.class.php :

class myclass implements jIDatasourceClass {

   function getDatas(){
       return array('value1'=>'label1', 'value2'=>'label2',...);
   }

Why an interface and why not an attribute to indicates a specific method ? because to avoid an untrusted jforms file to call anything.

[Uriel C]

Je pense que getDatas() pourrait prendre en paramètre $id l'identifiant du record que l'on modifie, ou null en cas de création d'un nouvel enregistrement. Ca permettrait de ne pas toujours retourner les mêmes valeurs lorsque c'est nécessaire.

[Uriel C]

J'attache un patch qui implémente une version légèrement différente de ce ticket.

Les classes métier dérivent directement de jIFormDatasource. On peut y adjoindre un constructeur, qui prend en paramètre l'id du formulaire.

Exemple de classe :

class listDatas implements jIFormDatasource
{
  protected $formId = 0;

  protected $datas = array();

  function __construct($id)
  {
    $this->formId = $id;
    $this->datas = array(0 => 'test',
                         1 => 'test 2',
                         2 => 'Id = '. $id);
  }

  public function getDatas()
  {
    return ($this->datas);
  }

  public function getLabel($key)
  {
    if(isset($this->datas[$key]))
      return $this->datas[$key];
    else
      return null;
  }

}

et le contrôle jForm correspondant :

<menulist ref="icone" dsclass="monmodule~listDatas">
        <label locale="elements.crud.label.icone" />
</menulist>

Avec cette solution le patch est bien plus court, moins de 10 lignes, et les classes sont simples à construire.

[laurentj]

Oui, c'est bien plus simple effectivement :-) Peut être faudrait-il ajouter un test (instanceof avant d'assigner l'objet à la propriété datasource) pour savoir si la classe en question implémente bien jIFormDatasource. Cela serait une protection pour éviter d'appeler n'importe quelle classe quand le fichier jforms est uploadé par un utilisateur dans une appli CMS par ex.

[Uriel C]

Version sécurisée qui fait un instanceof jIFormDatasource avant d'assigner la datasource

[Uriel C]

Précision avant que j'oublie : cette version modifiée fait la vérification au runtime et pas à la compilation, des fois qu'une classe serait modifiée entre temps.

Le code compilé en est un peu plus lourd mais rien de dramatique.

[laurentj]

Oui, c'est mieux de le faire au runtime.

[laurentj]

Patch landed in the trunk. Thanks for this patch !