Ce plugin permet d’utiliser dans SPIP la librairie QueryPath dans le code PHP d’un plugin. Cette librairie est entre autre un portage en PHP des sélecteurs et des manipulateurs de document de jQuery. Cela dit QueryPath permet bien d’autres choses également.
Pour l’utiliser, il faut charger inc/querypath.php
:
include_spip('inc/querypath');
Une fois le fichier chargé, vous avez à disposition les fonctions prévues par la librairie :
-
qp()
-
htmlqp()
- ou encore directement la classe
QueryPath
Reportez vous à la documentation de QueryPath pour connaître les paramètres et fonctions.
Ce plugin requiert une version de PHP >= 5.3
Manipuler du HTML
J’ai été confronté à différents problèmes lors de mon utilisation avec pour source un morceau de page HTML issu d’un pipeline de SPIP. Aussi, pour faciliter l’utilisation, une fonction apportée par ce plugin est aussi disponible avec les mêmes paramètres que les fonctions d’origine :
-
spip_query_path()
La fonction retourne pareillement un objet QueryPath, mais le chargement modifie certaines propriétés (lire inc/querypath.php
pour plus de détails) pour que le fonctionnement soit le plus simple et transparent pour les développeurs.
Je n’ai pas encore tout le recul nécessaire pour savoir si cela fonctionne à tous les coups, mais vos tests le diront certainement :)
Exemple d’utilisation
Dans le plugin Groupes de mots arborescents, j’utilise ce plugin pour ajouter du code HTML sous le formulaire d’édition d’un groupe après le titre, et pour enlever une partie du HTML également lorsque nous sommes dans un groupe enfant d’un autre. Cela se fait (le jour de l’écriture) de la sorte :
function gma_formulaire_fond($flux) {
// sur le formulaire d'édition de groupe de mot
if ($flux['args']['form'] == 'editer_groupe_mot') {
$html = $flux['data'];
$env = $flux['args']['contexte'];
// charger QueryPath
include_spip('inc/querypath');
$qp = spip_query_path($html, 'body');
// la parenté sur tous
// on récupère le sélecteur et on l'ajoute après le titre...
$selecteur_parent = recuperer_fond('formulaires/selecteur_groupe_parent', $env);
$qp->top('body')->find('li.editer_titre')->after($selecteur_parent);
// les paramètres techniques sont uniquement sur les groupes racine
if ($env['id_parent']) {
$qp->top('body')->find('li.fieldset_config')->remove();
}
// retourner le HTML modifie
$flux['data'] = $qp->top('body>div')->xhtml();
}
return $flux;
}
Manipulez du HTML5
6 mai 2020
Avec la dernière version du plugin Querypath V2.0.0 avec la librairie https://github.com/technosophos/querypath
$qp = html5qp("path/to/file.html");
Voici un exemple dans une fonction pour insérer du html avant le tag $class
function inserer_du_html($html, $class, $a_inserer) {
if(isset($html) AND isset($a_inserer) AND isset($class)){
include_spip('lib/querypath-3.0.4/vendor/autoload');
if (function_exists("html5qp")){
$qp = html5qp($html);
$qp->find($class)->before($a_inserer);
return $qp->html5();
}
} else {
return $html;
}
}
Discussions par date d’activité
5 discussions
Bonjour,
Je teste ce plugin avec un plugin qui l’utilise : spip_bible.
Cela sous SPIP 4.1.2 Git + PHP 8.1.6.
J’ai juste créé un article en écrivant dans le texte :
<bible|passage=Gn1,1-2,1>
Et j’ai des warnings PHP. Voici ce que me dit xdebug :
Il y en a d’autres, mais impossible de coller tout ici, voilà juste les lignes
Par ailleurs, il ne m’est pas possible de poster un ticket via https://git.spip.net/spip-contrib-extensions/querypath.git
Et enfin, il y a une version 3.0.5 de la lib ici https://github.com/technosophos/querypath/releases/tag/3.0.5 qui apporte quelque chose pour HTML5.
Répondre à ce message
Comme je le signale ici http://zone.spip.org/trac/spip-zone/changeset/91788 il y a un gros bug avec la librairie libxml2 qui affecte querypath dans certaines versions récentes de PHP (5.6.4 en ce qui me concerne, avec libxml version 2.9.2).
Pas d’alternative au bug, qui a lieu dès qu’un attribut ID est présent dans le code HTML, c’est à dire… quasiment tout le temps !
Donc voilà, si vous avez « PHP Warning : DOMNode::cloneNode() : ID XXXXX already defined in quelquechose/DOMQuery.php on line 3176 » ou proche, c’est que ça provient certainement de ce bug :/
Répondre à ce message
Avec le pipeline _afficher_contenu_objet, on peut afficher différemment les champs extra. Ce code efface ces champs (div.afficher) de la page d’un auteur pour ajouter le squelette « auteur_extras_vue ».
Avec Querypath, difficile de trouver une solution à l’utf-8 et au Bom des fichiers de lang, par contre le remplacement est assez fort pour respecter la chaine traduite. Pour ne pas avoir un « Qui est l ?auteur ? » mais bien un « Qui est l’auteur » ce code récupère la chaine et la remet en place :
Répondre à ce message
Merci pour ce plugin, je suis tombé dessus presque par hasard au moment même où j’avais besoin de quelque sorte de la sorte.
Très pratique pour modifier des morceaux de squelettes sans avoir à les surcharger, ou en complément des champs extras afin d’afficher les nouveaux champs exactement où on veut dans la page.
Dommage que la doc oficielle soit un peu spartiate cependant.
Ah, et un truc étrange : je n’ai pas testé avec spip_query_path(), mais pour moi seul htmlqp() fonctionne avec l’espace privé, qp() me renvoit plein d’erreurs, même en désactivant l’option correspondante.
Pourtant si j’ai bien lu, htmlqp est réservé au pages html de ’mauvaise’ qualité... Mystère.
Répondre à ce message
Intéressant... Cela pourrait donc être utilisé, lorsque l’on veut des formulaires un peu simplifiés par rapport ceux de la dist, de ne pas les surcharger dans notre plugin par une réécriture, mais en éliminant par QueryPath les champs d’édition non désirés ? ...
Répondre à ce message
Ajouter un commentaire
Avant de faire part d’un problème sur un plugin X, merci de lire ce qui suit :
Merci d’avance pour les personnes qui vous aideront !
Par ailleurs, n’oubliez pas que les contributeurs et contributrices ont une vie en dehors de SPIP.
Suivre les commentaires : |