Commit d4fec165 authored by Olivier Lezoray's avatar Olivier Lezoray 🇫🇷
Browse files

update README

parent 4cf82e2b
......@@ -39,13 +39,50 @@ $result=$myAdeEdtReader->retrieveEDT($_GET["ressource"], $_GET["format"]);
echo json_encode($result);
?>
```
Le web service repose sur l'utilisation d'une classe PHP "AdeEdtReader" qui effectue une interrogation du webservice ADE. Ce web service renvoie en réponse du JSON qui contient l'emploi du temps de la ressource pour la semaine entière à venir (week), la journée en cours (day), ou l'heure en cours (hour). Le JSON peut ensuite être récupéré en Javascript coté client et l'emploi du temps affiché dans un document HTML.
Le web service repose sur l'utilisation d'une classe PHP "AdeEdtReader" qui effectue une interrogation du webservice ADE. Ce web service renvoie en réponse du JSON qui contient l'emploi du temps de la ressource pour la semaine entière à venir (week), la journée en cours (day), ou l'heure en cours (hour). Le JSON peut ensuite être récupéré en Javascript coté client et l'emploi du temps affiché dans un document HTML. La figure suivante résume le fonctionnement général d'exploitation du webservice.
### Principe de récupération puis affichage de l'EDT d'une ressource ADE
![Demo une ressource](https://git.unicaen.fr/olivier.lezoray/edt/raw/master/img/demos/SchemaRecapitulatif.png)
### Utilisation de l'outil
Pour pouvoir utiliser le webservice "EDTReader.php", il faut connaître l'URL d'interrogation du webservice d'ADE. Celle-ci peut être récupérée dans l'interface d'export d'ADE.
L'affichage de l'emploi du temps peut alors ensuite se faire de plusieurs manières :
- statique : l'emploi du temps d'une ressource spécifique est affiché
- interactif : l'emploi du temps d'une ressource est affiché après en avoir choisi une parmi plusieurs
- dynamique : l'emploi du temps de plusieurs ressources est affiché en passant automatiquement toutes les X secondes d'une ressource à l'autre.
Ces affichages sont d'un fort intérêt pour disposer d'outils de consultation des emploi du temps, comme par exemple celui-ci :
https://www.stlo.unicaen.fr/edt/
mais également pour disposer d'outils d'affichage dynamique des emploi du temps (dans des écrans tactiles ou des écrans d'affichage). Plusieurs exemples d'utilisation sont présentés ci-dessous pour le Département MMI de l'IUT à Saint-Lô.
Afin de permettre une utilisation simple de l'outil, des fonctions JavaScript sont founies dans le fichier "weekSchedule.js". Elle permettent d'afficher d'un emploi du temps récupéré au format JSON par le web service "EDTReader.php" sous la forme d'une grille d'emploi du temps. Le script JavaScript ci-dessous illustre cela pour afficher l'emploi d'une ressource dans une div.
```html
<script type="text/javascript">
//sets global vars
//the sole ADE ressource to be diplayed
var ADERessource=2480;
//the URL of the EDT Reader webservice
var _webservice="https://dev-lezoray.users.greyc.fr/edt/php/EDTReader.php";
//the format of EDT display
var _format="week";
/**
* Initializes the whole display of the schedule
*
* @returns {none}
*/
$(document).ready(function(){
displayDate("_date");
showEDT(ADERessource,"edt");
}
);
</script>
<div id="edt">
<!-- The div that will display the schedule -->
</div>
```
## Exemples d'utilisation pour le Département MMI de l'IUT à Saint-Lô
### Affichage de l'EDT à la semaine d'une ressource spécifique
![Demo une ressource](https://git.unicaen.fr/olivier.lezoray/edt/raw/master/img/demos/displayEDTOfOneRessource.png)
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment