Filtrage des boucles DATA selon des contenus divers, et extension des filtrages / validations
Je suis tombé sur un cas de boucle DATA qui m'a ennuyé car le filtrage que je souhaitais n'était pas directement possible actuellement avec les critères dont on dispose.
Soit le tableau, disons #TAB
suivant :
$tab = [ [ 'id' => 1, 'mots' => [ 11, 120, 53 ]], [ 'id' => 2, 'mots' => [ 32, 11, 20 ]], [ 'id' => 3, 'mots' => [ 11, 78, 34 ]], [ 'id' => 4, 'mots' => [ 120, 26, 91 ]], ];
Je souhaitais boucler sur les éléments ayant le mot 11 par exemple, dans la clé 'mots'. De base la boucle serait :
#ID
Il faudrait ajouter un critère pour restreindre aux seuls éléments contenant le mot 11, mais {mots = 11}
ne va pas, ni {mots IN 11}
vu que c'est le champ "mots" qui est un tableau.
On pourrait imaginer pouvoir écrire {11 IN mots}
qui serait probablement plus clair, mais ce n'est pas permis.
Il n'y a actuellement pas moyen de réaliser ce filtre, ni d'étendre simplement les filtres à appliquer.
On propose ici de réfléchir à éventuellement permettre l'extension de ces tests de validation en fonction des contenus, ce qui s'apparente à ajouter quelque chose dans le WHERE en SQL, mais pour les itérateurs, c'est plutôt ajouter une contrainte sur la méthode valid()
. Les critères tel que {id=3}
ajoutent déjà des contraintes, même {chemin/du/tableau > 5}
fonctionne.
Une idée serait d'ajouter un critère {filtre NN}
ou {valider NN}
et de définir une fonction NN()
dans son code (mes_fonctions.php par exemple) qui recevrait la clé et la valeur en cours de validation et retournerait true ou false pour indiquer si cette entrée est acceptée ou pas. La fonction à créer serait au minimum donc NN($cle, $valeur) { return true; }
On pourrait transmettre des paramètres supplémentaires, tel que {filtre nom, p1, p2}
qui arriveraient dans un tableau d'arguments en 3è paramètre : NN($cle, $valeur, $args)
.
Voici un diff qui permet :
- de prendre en compte
$command['filtres']
dans les itérateurs. Chaque entrée de ce tableau est un tableau décrivant 1 filtre, avec comme premier élément le nom de la fonction à appeler, et les suivants les éventuels arguments. - de déclarer un critère
filtre
sur les boucles DATA qui remplissent ce tableau de filtres - de montrer un exemple d'un filtre (mal nommé) 'contient' avec 2 arguments
Index: public/iterateur.php =================================================================== --- public/iterateur.php (revision 23091) +++ public/iterateur.php (working copy) `` -300,6 +300,18 `` $this->limit = $limit[1]; } + // filtres explicites {filtre nom_fonction, param, param} + if (!empty($this->command['filtres'])) { + foreach ($this->command['filtres'] as $args) { + $nom = array_shift($args); + if (function_exists($nom)) { + $this->filtre[] = $nom . '( $me->key(), $me->current(), ' . var_export($args, true) . ')'; + } else { + spip_log("Filtre d'itérateur non connu : " . (string)$filtre); // [todo] mettre une erreur de squelette + } + } + } +
/** * Compile le critère `filtre` d'une boucle DATA * * `syntaxe `{filtre nom, [arg1, [arg2, [...]]]}` * `example `{filtre contient, mots, 3}` * * `param string $idb Identifiant de la boucle * `param array $boucles AST du squelette * `param Critere $crit Paramètres du critère dans cette boucle */ function critere_DATA_filtre_dist($idb, &$boucles, $crit) { $boucle = &$boucles[$idb]; // créer le tableau de tous filtres de la boucle $boucle->hash .= "\n\tif (!isset(\$filtres_init)) { \$command['filtres'] = array(); \$filtres_init = true; }\n"; // créer le tableau de ce filtre $boucle->hash .= "\t\$i = count(\$command['filtres']); \$command['filtres'][\$i] = array();\n"; // ajouter les arguments du filtre foreach ($crit->param as $param) { $boucle->hash .= "\t" . '$command[\'filtres\'][$i][] = ' . calculer_liste($param, array(), $boucles, $boucles[$idb]->id_parent) . ";\n"; } } /** * Conserve les éléments de la boucle dont le chemin indiqué contient une certaine valeur * sous entendu que ce chemin pointe sur une liste de valeurs possibles * * `syntaxe `{filtre contient, chemin, val}` * `example `{filtre contient, mots, 3}` * * - chemin : est un parcours qui sera fait dans le tableau $valeurs, * chaque / entrant dans un sous élément {`see table_valeur()} * - val : est une valeur à trouver dans le tableau retrouvé du chemin indiqué * dans l'exemple le chemin 'mots' retourne pour une entrée une liste tel que `array(12, 31, 21)` * * `param int|string $cle Clé analysée * `param mixed $valeur Valeur analysée * `param array $args Arguments passés au filtre * `return bool True pour accepter cette entrée, false sinon. **/ function contient($cle, $valeur, $args) { if (count($args) != 2) { return false; } list($chemin, $val) = $args; if ($valeurs = table_valeur($valeur, $chemin)) { return in_array($val, $valeurs); } return false; }
Et un exemple d'utilisation en squelettes
#SET{objets,#LISTE} #SET{objets,#GET{objets}|push{#ARRAY{id,1,mots,#LISTE{10,11,12}}}} #SET{objets,#GET{objets}|push{#ARRAY{id,2,mots,#LISTE{30,31,32}}}} #SET{objets,#GET{objets}|push{#ARRAY{id,3,mots,#LISTE{50,51,52}}}} #SET{objets,#GET{objets}|push{#ARRAY{id,4,mots,#LISTE{32,11}}}} #SET{objets,#GET{objets}|push{#ARRAY{id,5,mots,#LISTE{52,10}}}} #SET{id,32} #ID Test
À réfléchir…