Classer les articles par nombre de commentaires

et plus largement compter le nombre d’éléments liés à chaque objet remonté par la boucle.

Voir aussi : Le plugin Bonux intègre un critère compteur inspiré de ce code. Bonux est également valable pour SPIP 3 et SPIP 3.1

Origine de cette contribution

Cette contribution est la suite d’un échange sur la liste de discussion. Les codes ont été écrits par bill. Elle a été créée pour classer les articles par nombre de commentaires mais plus largement elle peut servir à compter le nombre d’éléments liés à chaque objet remonté par la boucle.

Nous commencerons par présenter le cas pratique à l’origine du code pour dans un second temps mieux expliquer la démarche.

I. Exemple d’utilisation

Classer les articles par nombre de commentaires peut donner un plus à tous les sites qui font appel à la participation des internautes via les forums des articles et veulent mettre en valeur celle-ci.

Vous allez copier deux fonctions dans votre fichier mes_fonctions.php et utiliser une boucle avec le critère {compteur_publie forum}.

1. Code à copier dans le fichier mes_fonctions.php

function critere_compteur_publie($idb, &$boucles, $crit){
 $op='';
 $boucle = &$boucles[$idb];
 $params = $crit->param;
 $type = array_shift($params);
 $type = $type[0]->texte;
 if(preg_match(',^(\w+)([<>=])([0-9]+)$,',$type,$r)){
     $type=$r[1];
     $op=$r[2];
     $op_val=$r[3];
 }
 $type_id = 'compt.id_'.$type;
 $type_requete = $boucle->type_requete;
 $id_table = $boucle->id_table . '.' . $boucle->primary;
 $boucle->select[]= 'COUNT('.$type_id.') AS compteur_'.$type;
 $boucle->from['compt']="spip_".$type;
 $boucle->where[]= array("'='", "'".$id_table."'", "'compt.".$boucle->primary."'");
 $boucle->where[]= array("'='", "'compt.statut'" , "'\"publie\"'"); 
 $boucle->group[]=$id_table;
 if ($op)
     $boucle->having[]= array("'".$op."'", "'compteur_".$type."'",$op_val);

} 

function balise_COMPTEUR_FORUM_dist($p) {
   $p->code = '$Pile[$SP][\'compteur_forum\']';
   $p->interdire_scripts = false;
   return $p;
} 

2. Boucle pour classer les articles par nombre de commentaires

<B_m>
#ANCRE_PAGINATION 
<BOUCLE_m(ARTICLES){compteur_publie forum>0}{!par compteur_forum}{pagination}>
#TITRE contient #COMPTEUR_FORUM messages<br />
</BOUCLE_m> 
#PAGINATION
</B_m> 

II. Pour aller plus loin : l’objectif du code

Le but est de créer un critère qui réalise une jointure et compte le nombre d’éléments liés à chaque objet remonté par la boucle.

Il faut donc nommer la table sur laquelle on souhaite réaliser la jointure.

Cette table devra impérativement contenir la clé primaire de la boucle utilisée comme clé étrangère.

On pourra donc typiquement compter le nombre d’article par rubrique, le nombre de mots par groupe ou le nombre de messages d’un article.

Attention : Ce code ne s’applique pas aux relations n<->n, il faut alors utiliser le critère {frequence xxx} du plugin nuage.

function critere_compteur($idb, &$boucles, $crit){
 $op='';
 $boucle = &$boucles[$idb];
 $params = $crit->param;
 $type = array_shift($params);
 $type = $type[0]->texte;
 if(preg_match(',^(\w+)([<>=])([0-9]+)$,',$type,$r)){
     $type=$r[1];
     $op=$r[2];
     $op_val=$r[3];
 }
 $type_id = 'compt.id_'.$type;
 $type_requete = $boucle->type_requete;
 $id_table = $boucle->id_table . '.' . $boucle->primary;
 $boucle->select[]= 'COUNT('.$type_id.') AS compteur_'.$type;
 $boucle->from['compt']="spip_".$type;
 $boucle->where[]= array("'='", "'".$id_table."'", "'compt.".$boucle->primary."'");
 $boucle->group[]=$id_table;
 if ($op)
     $boucle->having[]= array("'".$op."'", "'compteur_".$type."'",$op_val);

} 

La requête générée par la boucle contiendra donc une jointure et un champ « count ».

La syntaxe à utiliser est la suivante :

<BOUCLE_X(XXX){compteur yyy>0}{!par compteur_yyy}>

On peut utiliser le compteur comme critère de tri, mais pour pouvoir afficher le nombre d’element yyy liés à chaque objet XXX, il faudra définir la balise :

function balise_COMPTEUR_YYY_dist($p) {
   $p->code = '$Pile[$SP][\'compteur_yyy\']';
   $p->interdire_scripts = false;
   return $p;
}

Par exemple, on pourra chercher les 3 groupes de mots contenant le plus de mots :

<BOUCLE_G(GROUPES_MOTS){compteur mots>0}{!par compteur_mots}{0,3}>

ou les rubriques ne contenant moins de 10 articles :

<BOUCLE_R(RUBRIQUES){compteur articles<10}{par compteur_articles}>

NB : Pour réaliser le critère {compteur_publie forum}, nous avons en ajouté $boucle->where[]= array("'='", "'compt.statut'" , "'\"publie\"'");.

On filtre les statuts des objets comptés pour ne prendre en compte que ceux ayant un statut publié. Ce critère n’est donc applicable qu’aux objets ayant un statut et ne pourra donc pas s’utiliser sur les groupes de mots pour compter les mots.

Le critère compteur de Bonux

Le plugin Bonux propose un critère « compteur » inspiré de cette contribution.

Discussion

4 discussions

  • 2

    Bonjour

    Je viens d’essayer ce script (celui proposé dans le commentaire par Cédric) qui fonctionne parfaitement avec un Spip 2 mais qui ne retourne aucun résultat en Spip3

    Une subtilité de Spip3 que je n’aurais pas capté ?

    • pour infos, le plugin SPIP Bonux intègre maintenant le critère compteur. (disponible pour SPIP 2 et 3).

      Inutile d’avoir à ajouter des choses dans le mes_fonctions.php

    • Certes, le compteur intégré au plugin Bonux est utile lorsqu’on veut connaître la totalité des articles, tous statuts confondus - ce qui en pratique, est -relativement - peu usité. On souhaite plutôt connaître, en l’occurrence pour les articles, le nombre d’articles en fonction de leur statut. Un chiffre global simple n’a que peu d’intérêt et serait facilement récupérable en faisant la somme (via le filtre |plus...) tandis que l’inverse est impossible. Si vous pouviez améliorer la méthode de génération du compteur Bonus ce serait super - sinon, il nous faut bidouiller avec les fonctions. Je comprends que le compteur dépend de la rubrique (lorsqu’il est associé à une boucle RUBRIQUES), qui acquiert le statut « publie » dès le premier article est publié. L’amélioration du compteur nécessite sans doute beaucoup de temps de développement, je n’en doute pas.

    Répondre à ce message

  • 2

    Sur contrib, pour la page auteurs, j’ai generalise la fonction :

    function critere_compteur($idb, &$boucles, $crit){
    	$boucle = &$boucles[$idb];
    	
    	$params = $crit->param;
    	$table = array_shift($params);
    	$table = $table[0]->texte;
    	if(preg_match(',^(\w+)([<>=])([0-9]+)$,',$table,$r)){
    		$table=$r[1];
    		$op=$r[2];
    		$op_val=$r[3];
    	}
    	$type = objet_type($table);
    	$type_id = id_table_objet($type);
    	$table_sql = table_objet_sql($type);
    	
    	$trouver_table = charger_fonction('trouver_table','base');
    	$arrivee = array($table, $trouver_table($table, $boucle->sql_serveur));
    	$depart = array($boucle->id_table,$trouver_table($boucle->id_table, $boucle->sql_serveur));
    
    	if ($compt = calculer_jointure($boucle,$depart,$arrivee)){
    
    		$boucle->select[]= "COUNT($compt.$type_id) AS compteur_$table";	
    		if ($op)
    			$boucle->having[]= array("'".$op."'", "'compteur_".$table."'",$op_val);
    	}
    }
    
    function balise_COMPTEUR_dist($p) {
    	$p->code = '';
    	if (isset($p->param[0][1][0])
    	AND $champ = ($p->param[0][1][0]->texte))
    		return rindex_pile($p, "compteur_$champ", 'compteur');
      return $p;
    }

    Ce qui permet d’ecrire simplement la boucle

    <BOUCLE_auteurs(AUTEURS){compteur articles}{0,20}{par compteur_articles}{articles.statut=publie}>
    #NOM : #ID_AUTEUR : #COMPTEUR{articles} <br />
    </BOUCLE_auteurs>
    • Très bon boulot !
      Cependant, attention aux jointures forcées (cf. doc) ; il faut bien spécifier la table du champ de calcul, sinon, (sauf erreur de ma part) ça supprime une des tables défini.
      Par exemple, faire un équivalent SPIP de cette simple requête SQL (requête comptant le nombre d’article associés à chaque mot clé, trié par ce comptage décroissant) :

      SELECT titre, count(id_article) as nombre_articles
      FROM spip_mots_articles NATURAL JOIN spip_mots
      GROUP BY titre
      ORDER BY nombre_articles DESC

      SPIP :

      <BOUCLE_test(MOTS_ARTICLES mots){fusion titre}{!par nombre_articles}>
      	#TITRE : [(#EXPRESSION{COUNT(mots_articles.id_article), nombre_articles})]<br/>
      </BOUCLE_test>

      Si on code COUNT(id_article) au lieu de COUNT(mots_articles.id_article) , la requête fini avec FROM spip_mots sans jointure avec l’autre table définie.
      Du coup, SPIP retourne une erreur indiquant que id_article est un champ inconnu.

    • Bonjour
      Souhaitant classer les auteurs en fonction du nombre d’article j’ai voulu reprendre ta fonction Cedric, mais elle ne fonctionne pas de mon côté !
      Ça me renvoie une erreur concernant la ligne

       $type = objet_type($table);

      Pour info il s’agit d’une installation sur une version spip 1.9.1 (pas mise à jour à cause de beaucoup de modifs et pas mal de fainéantise surtout)

    Répondre à ce message

  • Félicitations, voilà une contrib extrêmement utile qui comble ce qui était jusqu’à présent une lacune de SPIP. Un tout grand merci.

    (soit dit en passant, je pense que ça vaudrait la peine de suggérer l’intégration des critères et balises définis ici dans la distribution officielle de SPIP)

    Répondre à ce message

  • 1

    Merci pour ce script très brillant. J’en voit de multiples applications. Cependant quelques petits commentaires sur le code pour un spipeur débutant auraient été bienvennues.

    Je vais essayer de l’utiliser pour faire un tri par nombre d’occurences d’un mot-clé.

    Merci encore
    Laurent

    • Ah ben non, pas du tout, pour ca c’est le critère frequence du plugin nuage (+ voir article de James sur le sujet)

      Il faudrait sans doute expliquer un peu mieux la différence relation 1 <-> n / relation n <-> n

      @++

    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 :

  • Désactiver tous les plugins que vous ne voulez pas tester afin de vous assurer que le bug vient bien du plugin X. Cela vous évitera d’écrire sur le forum d’une contribution qui n’est finalement pas en cause.
  • Cherchez et notez les numéros de version de tout ce qui est en place au moment du test :
    • version de SPIP, en bas de la partie privée
    • version du plugin testé et des éventuels plugins nécessités
    • version de PHP (exec=info en partie privée)
    • version de MySQL / SQLite
  • Si votre problème concerne la partie publique de votre site, donnez une URL où le bug est visible, pour que les gens puissent voir par eux-mêmes.
  • En cas de page blanche, merci d’activer l’affichage des erreurs, et d’indiquer ensuite l’erreur qui apparaît.

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.

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