Je vous présente aujourd'hui un petit plugin qui répond à une problématique professionnelle très simple sur Joomla Content qui se trouve être la suivante :
Nous utilisons sur notre site un petit composant écrit avec Ajax qui permet par une méthode d'auto completion, d'afficher le résultat de recherche suite à un saisie par l'utilisateur, d'une chaîne de caractères. En d'autres termes, nous utilisons un composant de recherche.
Toutefois, nous avons dans notre système d'information, l'obligation de posséder des URL "uniques", qui pointent sur des pages spécifiques. En d'autres termes, une URL. Ces URL sont appelées d'ailleurs, de l'exterieur à Joomla et sont TOUJOURS, dans le cas qui nous concerne ici, des URL vers des fichier pdf.
La problématique
D'une manière historique, chacun de nos noms de fichiers comporte une sous-chaîne "unique" : la date.
Le problème est le suivant, chaque fois que je mets à jour un fichier dans Joomla dans lequel la date est contenue dans son nom, l'URL précédente devient caduque. C'est ainsi que nous nous retrouvons avec des liens de type 404 qui pointent sur rien.. Et il faut refaire les mises à jours depuis chacun des appels, ces appels se trouvant essentiellement dans des applications métiers.
Or, la date contenue dans le champ du nom du fichier n'est pas le premier élément. Il se trouve donc que l'on peut effectuer une recherche, en spécifiant une sous-chaine de caractères qui correspond à une partie du nom du fichier que je souhaite rechercher. Je dirais même, que je souhaite trouver.
Par exemple, un nom de fichier peut être 20230102-KIT-00000005-vehicule-voiture-twingo-5-portes.pdf
Ce nom de fichier comporte :
- une date
- un type de fichier (je parle de type "métier" du fichier
- un identifiant auquel se rattache ce fichier
- le reste est une chaine libre aves des tirets séparateurs
- une extension de fichier (pdf)
À partir de là, nous sommes bien d'accord que si nous faisons une recherche sur une chaîne de caractères qui se trouve être unique, bien qu'incomplète pour le nom d'un fichier que nous recherchons, nous avons tout de même trouvé un et un seul résultat.
Partant de ce constat, je me suis dit que j'allais réutiliser non pas le moteur de recherche de Joomla, mais de simples requêtes SQL qui vont me permettre de faire une recherche sur une sous-chaiêne de caractères, qui donc se trouve être unique, et qui va me retourner le ou les articles de Joomla content qui contiennent ces sous chaînes de caractères.
Statistiquement, 1 et un seul résultat sera retourné dans 95 % des cas. Cela vient du fait que nous nommons nos fichiers avec des noms qui arrivent à peu près à être presque uniques, même si je fais abstraction de l'identifiant date dans ce nom.
Mon plugin
Après avoir analysé longuement (plusieurs semaines mais pas à temps complet) la situation afin de trouver une manière simple d'obtenir le résultat escompté, je me suis rendu compte que si nous pouvions dans Joomla récupérer un paramètre de URL passé en get, et réutiliser ce résultat dans une requête SQL. Ainsi, je pouvais récupérer l'ensemble des articles dans lesquels cette souus-chaîne de caractères est contenue. Or, si cette chaîne de caractères est le nom du fichier, dans lequel je fais un lien hypertexte sur ce fichier se trouvant sur mon serveur ou un autre, je récupère l'article qui concerne cette chaines de caractères. Je pourrais passer mon article pour me récupérer que l'URL mais je n'en suis encore pas là.
Pour le moment, mon petit plugin que j'intègre à un article Joomla par la balise {recherche_get}, me récupère le paramètre passé dans URL de la chaîne que j'ai à rechercher, et me renvoie une liste des articles qui contient cette chaîne.
Bien entendu je parle de nom de fichier, mais dans la mesure où je travaille avec des chaînes de caractères, vous pouvez réutiliser ce plugin pour rechercher n'importe quelle chaîne de caractères contenue dans un article de type Joomla content en GET.
Et dans le retour, je n'affiche que les ID + titres des articles, mais ils serait possible d'aller plus loin, en faisant des extractions au moyen de regex pour afficher le contenu de l'article où la chaine a été trouvée.
rechercheget.php
<?php
defined('_JEXEC') or die('Access deny');
class plgContentRechercheGET extends JPlugin
{
function onContentPrepare($content, $article, $params, $limit){
$doc = JFactory::getDocument();
$doc->addStyleSheet('plugins/content/rechercheget/style.css');
$re = '/\{recherche_get\}/mi';
$sql = "SELECT #__content.id, #__categories.title, #__content.title, #__content.introtext
FROM #__content, #__categories
WHERE `introtext` LIKE '%".$_GET["chaine_recherchee"]."%'
AND #__categories.id = #__content.catid
ORDER BY #__content.id DESC";
echo $sql;
$db = JFactory::getDBO();
$db->setQuery($sql);
$row = $db->loadObjectList();
$ch = '<div class="mes-resultats-de-recherches-get">';
$ch .= '<div class="libelle">Liste des articles dans lesquel le terme <span class="terme">'.$_GET["chaine_recherchee"].'</span> a été trouvé :</div>';
foreach($row as $z)
{
$url = $_SERVER["REQUEST_SCHEME"]."://".$_SERVER["SERVER_NAME"].$_SERVER["SCRIPT_NAME"]."?option=com_content&view=article&id=".$z->id;
$ch .= '<div class="un-resultat"><div class="id">'.$z->id.'</div><div class="title"><a href="'.$url.'">'.$z->title."</a></div></div>";
}
$ch .= '</div>';
$article->text = str_replace('{recherche_get}', $ch , $article->text);
}
}
rechercheget.xml
<?xml version="1.0" encoding="utf-8"?>
<extension version="1.0" type="plugin" group="Content">
<name>Plugin de recherche en méthode GET</name>
<author>Sebastien LHUILLIER</author>
<creationDate>Janvier 2023</creationDate>
<copyright>Sébastien LHUILLIER</copyright>
<license>GNU General Public License version 2 or later; see LICENSE.txt</license>
<authorEmail>Cette adresse e-mail est protégée contre les robots spammeurs. Vous devez activer le JavaScript pour la visualiser.</authorEmail>
<authorUrl>www.sebastien-lhuillier.com</authorUrl>
<version>1.0</version>
<description>Récupère la chaine passée en URL et lance une recherche ans les articles</description>
<files>
<filename plugin="rechercheget">rechercheget.php</filename>
<filename>rechercheget.xml</filename>
<filename>style.css</filename>
</files>
</extension>
style.css
.resultats-recherche-get{
text-align:left;
}
.resultats-recherche-get .resultat-get a .un-resultat-id::before {
content: "Article : ";
}
.resultats-recherche-get .resultat-get a .un-resultat-id {
color:red;
}
.mes-resultats-de-recherches-get .libelle {
color: red;
font-size: 120%;
font-weight: bold;
}
.mes-resultats-de-recherches-get .libelle .terme {
color: blue;
}
.mes-resultats-de-recherches-get .libelle .terme::before {
color: blue;
content:open-quote;
}
.mes-resultats-de-recherches-get .libelle .terme::after {
color: blue;
content:close-quote;
}
.mes-resultats-de-recherches-get .un-resultat {
text-align: left;
}
.mes-resultats-de-recherches-get .un-resultat .id {
color: red;
float: left;
min-width: 4%;
}
.mes-resultats-de-recherches-get .un-resultat .title {
margin-left: 10px;
}Le paramètre et l'utilisation de ce plugin
Je ne l'ai pas précisié mais il vous assufit de lire mon code pour le trouver, le paramètre de l'URL est ?chaine_recherchee.
Pour utiliser ce plugin, il vous suffit donc :
- de créer un article (dont le rôle est simplement d'etre le récipient du plugin)
- l'intégrer le plugin dans cet aprticle via son shortcode : {recherche_get}
- d'enregistrer l'article et de connaitre son URL d'accès (que ce soit en moed directe avec les paramètres de base, ou en URL rewritée
- de générer son url de recherche. Attenntion ici, si votre serveur est configuré en url rewritée ou pas (je vous mets en bleu les paramètres) :
- en URL Rewritée : index.php/liste-des-articles-articles-non-categorises/71-recherche-en-get?chaine_recherchee=Monkit
- en URL non rewritée
index.php?option=com_content&view=article&id=71&chaine_recherchee=KIT