Documentation du module MysqlFinder Page 1 sur 18 Historique des révisions du document
SIST
o Module MYSQLFINDER
Manuel d’utilisation :
Module MySqlFinder
0.0.1 19/01/2006 Version initiale Olivier DOUARCHE
1.0 25/01/2006 Relecture Cédric CHAMBERLIN
Sommaire
1 INTRODUCTION...4
1.1 PRÉAMBULE... 4
1.2 OBJECTIFS... 4
1.3 PRÉREQUISTECHNIQUES... 4
2 PRÉSENTATION...5
3 FONCTIONNALITÉS...6
3.1 CHOIXDELASOURCE... 6
3.2 LARECHERCHE SIMPLE... 7
3.3 LARECHERCHEAVANCÉE... 8
3.4 RÉSULTATDELARECHERCHE... 9
4 ADMINISTRATION...12
4.1 GESTIONDESSOURCES... 12
4.2 EXPORT RSS... 16
5 PARAMÉTRAGE MYSQLFINDER...18
1 INTRODUCTION
1.1 P RÉAMBULE
Le module MySQLFinder est un requêteur de base de données Mysql. Toute base accessible depuis la plateforme est susceptible d’être interrogée.
Cet outil permet donc de référencer des bases connectées MySQL et de proposer un formulaire d’interrogation simple ou avancé, basé sur une table la base en question dont les champs interrogeables auront été définis par le webmestre.
Parallèlement à sa fonctionnalité de recherche cet outil est également un producteur de fil RSS.
1.2 O BJECTIFS
L’objectif de ce document et de décrire les fonctionnalités du module MySqlFinder et la manière de le mettre en œuvre via son interface d’administration.
1.3 P RÉ REQUIS TECHNIQUES
Le module MySqlFinder fonctionne sur la plateforme suivante : - PHP v4.3 est supérieure,
- Base MySql v3.23 est supérieure, - Environnement Linux,
- Javascript activé,
- Nécessite le dossier Commun au même niveau que le répertoire du module.
2 PRÉSENTATION
Dans sa partie publique, ce module se présente comme un formulaire d’interrogation disponible selon deux interfaces d’interrogation, simples et avancées.
Une fois la source choisie, et selon la recherche que l’on souhaite effectuer, les formulaires d’interrogation sont générés automatiquement à partir des champs sélectionnés pour cette source.
3 FONCTIONNALITÉS
3.1 C HOIX DE LA SOURCE
Lorsque l’on arrive sur la page du module, celui-ci nous demande de choisir préalablement une source.
Une source est une base de donnée référencée dans la partie administration du composant pour laquelle une table a été définie comme cible de la recherche et dont certains champs ont été identifiés comme étant requêtables.
A ce stade il faut donc choisir le « Nom de la source » pour accéder au formulaire d’interrogation.
Lorsque le nom de la source a été choisi le module se positionne sur l’onglet de la
« Recherche Simple ».
3.2 L A RECHERCHE S IMPLE
La recherche simple est accessible par l’onglet « Recherche simple ».
Pour effectuer une recherche il suffit de renseigner un ou plusieurs critères de recherche dans le champ de saisi intitulé « Rechercher ».
Si plusieurs critères sont saisis, la recherche effectuera une opération logique ET entre les critères.
Il est possible de choisir éventuellement un champ dans la liste déroulante :
Cette liste déroulante est fonction des champs identifiés comme interrogeable pour cette source.
La recherche est effectuée en cliquant sur le bouton « »
3.3 L A RECHERCHE AVANCÉE
La recherche avancée est accessible par l’onglet « Recherche avancée ».
Lors d’une recherche avancée, on peut renseigner les critères définis comme interrogeable lors de la création de la source.
A chaque champ est associée une liste d’opérateurs disponible en fonction du type du champ :
- Texte
- Numérique, date ou binaire
- Dépendance vers une autre table (clé étrangère) A pour élément
Avec la liste des éléments possibles de la table de dépendance.
Attention, pour la recherche avancée les critères renseignés pour chacun des champs seront considérés comme une phrase complète de recherche.
Si plusieurs mots sont rentrés, la recherche se portera sur la phrase et non sur chacun des mots.
La recherche est effectuée en cliquant sur le bouton « »
Par défaut la recherche s’effectue avec l’opérateur logique ET entre les différents critères.
Dans le cas ou l’option « Combiner tous les champs de la recherche » est activée, la recherche s’effectuera avec l’opérateur logique OU.
3.4 R ÉSULTAT DE LA RECHERCHE
Pour chaque occurrence de résultat, on retrouve les informations suivantes : - Le titre
- Le résumé
- D’autres champs spécifiques
La définition de ces champs est exprimée lors de la déclaration de la source dans la partie administration du composant.
Le lien « Voir la fiche » permet d’accéder à la fiche complète de l’occurrence de résultat.
La liste déroulante « Export » permet d’exporter le résultat dans différents formats.
La fiche d’une occurrence de résultat est accessible depuis le lien « Voir la fiche » du résultat de la recherche.
La fiche présente l’ensemble des champs affichables définis lors de la création de la source.
Le lien « Retour » permet de revenir à la liste des résultats.
3.4.2 Exporter les résultats
Depuis la liste des résultats la liste « Export » permet d’exporter les résultats dans plusieurs formats :
Lors du choix d’un format, une fenêtre s’affiche :
Jusqu’à ce que le document soit disponible au téléchargement.
4 ADMINISTRATION
Pour administrer ce composant, rendez-vous au niveau de la gestion des modules dans la partie back-office du framework
4.1 G ESTION DES SOURCES
En cliquant sur le l’entrée « Gestion des sources de données » du menu du composant, on accède à la liste des sources de données.
4.1.1 Ajouter ou Modifier une source de données
Depuis la liste des sources, en cliquant sur le bouton de création « » ou sur le bouton de modification « », le formulaire de gestion d’une source de donnée s’affiche.
Dans une première étape, il convient de renseigner les paramètres d’accès au serveur de données :
- Le nom de la source - Le login
- Le Mot de passe
- Le serveur (nom canonique ou adresse IP) -
Le bouton :
- « » Permet de lancer la connexion au serveur avec les paramètres définis et de passer à la deuxième étape
Une fois la connexion effectuée la liste « Base » du serveur devient disponible :
En choisissant une entrée dans la liste « Base », la liste « Table » devient disponible :
Une fois le choix de la table réalise dans la liste « Table », l’ensemble des champs de la table apparaît :
Pour cela, il faut procéder de la manière suivante :
- Identifier un champ comme étant le titre (obligatoire) - Identifier un champ qui sera le résumé (obligatoire)
- Identifier d’autres champs et leur ordre d’apparence dans le résultat.
Certains champs peuvent avoir une dépendance vers d’autres tables (par exemple les clefs étrangères), dans ce cas là il suffit de cocher la case « Dépendances vers d’autres tables » pour voir apparaître une liste de sélection permettant de sélection la table de dépendance et le champ de cette table qui devra être affiché.
Pour chacun des champs identifiés la colonne « Libellé » doit être renseignée.
Les boutons :
- « » procède à l’enregistrement de la source de données - « » permet de revenir à la liste des sources de données
4.1.2 Supprimer une source de données
En cliquant sur le bouton « Ok », la suppression devient effective.
4.2 E XPORT RSS
4.2.1 Définition des items RSS
Une source de donnée peut devenir une source de production de fil RSS.
Pour ce faire, dans le formulaire de gestion d’une source, il suffit d’associer aux champs de la source, l’item RSS correspondant dans la colonne « Export RSS ».
4.2.2 Génération du flux RSS
Une fois les champs RSS affectés et la source enregistrée, l’obtention du flux RSS s’effectuera à l’adresse suivante :
[URL_SITE]/modules/Mysqlfinder/Metier/MysqlfinderRSS.php Ainsi l’url aura la forme :
[URL_SITE]/modules/Mysqlfinder/Metier/MysqlfinderRSS.php?
MYSQLFINDER_SOURCE_ID=[SOURCE_ID]
&MYSQLFINDER_CRITERES=[CRITERES DE RECHERCHE]
&MYSQLFINDER_FIELD_NAME=[CHAMP]
&MYSQLFINDER_PROFONDEUR=[PROFONDEUR]
[SOURCE_ID]= Identifiant de la source (obligatoire)
[CRITERES DE RECHERCHE] = Mots à rechercher (obligatoire)
[CHAMP]= Champ spécifique sur lequel doit porter la recherche (facultatif) [PROFONDEUR]= Nombre maximum de résultats à renvoyer (facultatif)
Le module de requête générique MySqli nécessite un paramétrage pour définir certaines variables.
Editez le fichier MysqlfinderParam.inc visible dans le répertoire [PATH_SITE]/modules/MysqlFinder
Paramétrez les variables suivantes :
GLOBALS["MYSQLFINDER"]["NB_ELEMENT_PAR_PAGE"] = 10;
Nombre maximum d’occurrence de résultat visible par page.
Donner les droits d’écriture sur le répertoire Mysqlfinder/Temp pour le user Apache afin de pouvoir écrire les fichies d’export.
