Query Path

Query Path (http://querypath.org/) est une librairie PHP permettant de récupérer, sélectionner et manipuler un contenu HTML comme le fait la librairie javascript jQuery. Ce plugin permet d’utiliser cette librairie dans SPIP.

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 :

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;
}

Discussion

4 discussions

  • 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

  • 1

    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 ».

    // charger QueryPath
    include_spip('inc/querypath');
                    
    $html = $flux['data'];
    $env = $flux['args']['contexte'];
    $qp = htmlqp($html, 'body');
                    
    //effacer tout les champs extras
    $qp->top('body')->find('div.afficher')->remove();
                    
    //stocker un squelette calculé
    $saisies_mieux = recuperer_fond('auteur_extras_vue', $env);
    
    // retourner le HTML modifie
    $flux['data'] = $saisies_mieux.$qp->top('body')->xhtml();
    • 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 :

      $qui_est_lauteur=_T('entree_infos_perso_2');
      $qp->top('body')->find('.editer_bio label')->html($qui_est_lauteur);

    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

Qui êtes-vous ?
  • [Se connecter]

Pour afficher votre trombine avec votre message, enregistrez-la d’abord sur gravatar.com (gratuit et indolore) et n’oubliez pas d’indiquer votre adresse e-mail ici.

Ajoutez votre commentaire ici

Ce champ accepte les raccourcis SPIP {{gras}} {italique} -*liste [texte->url] <quote> <code> et le code HTML <q> <del> <ins>. Pour créer des paragraphes, laissez simplement des lignes vides.

Ajouter un document

Suivre les commentaires : RSS 2.0 | Atom

Dernière modification de cette page le 12 novembre 2017