MOTEUR DE RENDU GRAPHIQUE V1.2

Transcription

1 MOTEUR DE RENDU GRAPHIQUE V1.2

2 Table des matières Introduction... 3 Fonctionnalités... 3 Bibliothèques nécessaires... 3 Diagramme de classes UML... 4 La couche de rendu abstraite : ModuleGraphEngine... 5 La classe qui appelle les graphiques : ModuleGraph... 6 Le fichier qui dessine les graphiques : ~/admin/drawer.php... 7 Comment est gérée la période de temps... 7 Comment créer un module utilisant un graphique facilement... 8 Page 2

3 Introduction Surcouche qui permet de créer n importe quel type de graphique (camembert, courbe, histogramme ) en utilisant une bibliothèque graphique ou une technologie de rendu spécifique (GD2, Adobe Flash, Google API, Microsoft Silverlight ). Fonctionnalités Simple d utilisation : Le moteur n a besoin que d un tableau de données et il créera les graphiques à la volée. Facile à améliorer : On peut ajouter n importe quelle technologie de rendu, existante ou à venir simplement et rapidement. Bibliothèques nécessaires GD2 : Artichow Flash : XML/SWF Charts (dans ce cas, le navigateur Internet nécessitera le greffon Adobe Flash) Silverlight : Visifire (le navigateur Internet doit avoir le greffon Microsoft Silverlight) Page 3

4 Diagramme de classes UML Il y a 5 points à prendre en compte dans le but de comprendre comment le moteur fonctionne et comment créer un module qui génèrera des graphiques : La couche de rendu abstraite : ModuleGraphEngine La classe qui appelle les graphiques : ModuleGraph Le fichier qui dessine les graphiques : ~/admin/drawer.php Comment est gérée la période de temps Comment créer un module utilisant un graphique facilement. Page 4

5 La couche de rendu abstraite : ModuleGraphEngine Un graphique peut être créé en utilisant différents moteurs de rendus : GD, Adobe Flash, Microsoft Silverlight, ainsi que par le biais de bibliothèques graphiques. Chaque bibliothèque de rendu est spécifique et utilise un code qui lui est unique, c est pourquoi le moteur est complété d une surcouche qui permet de créer et d afficher n importe quel type de graphique, sans se soucier du moteur de rendu utilisé. ModuleGraphEngine est donc utilisé en tant que couche abstraite permettant de créer un graphique en utilisant n importe quel rendu. Chaque nouvelle classe de rendu devra par conséquent hériter de ModuleGraphEngine et devra implémenter chacune de ses méthodes, présentées ici : hookgraphengine($params, $drawer): contiendra le code qui appellera le moteur utilisé. $params est un tableau qui contiendra la taille et la hauteur du graphique. $drawer sera la page drawer.php qui sera appelée. createvalues($values): La méthode insérera le paramètre $values (qui est en fait un tableau qui contiendra toutes les valeurs dont le graphique a besoin) dans le graphique. setsize($width, $height) : Définie la taille du graphique. setlegend($legend) : Ajoute une légende (sous forme de tableau) dans le graphique. Le tableau legend doit avoir le même nombre d éléments que le tableau values, car c est une représentation textuelle de ces mêmes nombres. settitles($titles) : Définie les différents titres du graphique. $titles est un tableau composé de 3 parties : $titles['main'] qui est le titre principal du graphique. Si le graphique contient plusieurs couches (exemple 3 courbes sur le même graphique), $titles* main + est alors un tableau et $titles* main +*0+ contiendra le titre, $titles* main ][1 à x] contiendront les descriptions de chaque couche. Exemple : $titles* main ]*0+ = Visites et visiteurs ; $titles* main +*1+ = Visites ; $titles* main +*2+ = Visiteurs ; $titles['x'] qui représente l axe des X. $titles* y'+ qui est le titre représentant l axe des Y ModuleGraphEngine a également une méthode publique : getgraphengines() qui récupérera une liste de tous les différents moteurs de rendu. L attribut _type de cette classe est le type de graphique à générer : pie, column, line Il y a 4 principales classes filles qui héritent de ModuleGraphEngine : GraphArtichow GraphGoogleChart GraphXmlSwfCharts GraphVisifire. Page 5

6 La classe qui appelle les graphiques : ModuleGraph Chaque module utilisant un graphique doit hériter de ModuleGraph (qui hérite lui-même de Module). Cette classe est une fabrique (patron de conception) qui créera le type de graphique sélectionné en utilisant le type de rendu défini, en prenant compte les éventuels filtres sur la période de temps. La fonction remplira également par elle-même certaines informations comme la légende du graphique si le graphique est lié à une certaine période. Cette classe a certains attributs : $_render : La classe de rendu $_titles = array('main' => NULL, 'X' => NULL, 'Y' => NULL) : Titre du graphique $_values : Le nombre de tableau dont le graphique aura besoin $_legends : Un tableau de chaine de caractères (lié avec $_values) Par exemple, s il y a 40% d hommes et 60% de femmes : $_values*0+ = 40; $_values*1+ = 60; and $_legends*0+ = Hommes ; $_legends*1+ = Femmes ; Voici les différentes méthodes de la classe : getdatelike() : renverra des informations sur la date du graphique setdategraph($layers, $legend = false): utilisé par les modules qui ont besoin d une période de temps. Par exemple l évolution des ventes peut être détaillée sur un jour, un mois et même une année. Les modules de ce genre devront avoir les méthodes suivantes : setdayvalues($layers),setmonthvalues($layers), and setyearvalues($layers) qui rempliront à leur façon le tableau de données. $layers est le nombre de couches dans le graphique (defaut : 1) getdata($layers): doit être implémenté dans le module. Cette méthode devrait d abord appeler getdate() puis setdategraph(). create($render, $type, $width, $height, $layers): créée un objet Render (qui hérite de ModuleGraphEngine) et qui appellera this->getdata(), puis render->createvalues(), render- >setsize(), render->setlegend() et render->settitles();. La méthode create a besoin de ces paramètres : render: gd, flash, google, silverlight... type: pie, column, line width : largeur du graphique height : hauteur du graphique layers : nombre de couches sur le même graphique. draw() : dessinera le graphique engine($params): méthode qui peut être considérée comme une méthode qui en appelle d autres. $params est un tableau dans lequel on peut choisir le type de graphique désiré ($param* type + = column ;), ainsi que n importe quel autre paramètre intéressant. Cette méthode devrait être appelée par les différents modules qui ont besoin de graphique dans le but de les afficher. Page 6

7 Le fichier qui dessine les graphiques : ~/admin/drawer.php Précédemment, nous avons vu que ModuleGraph::engine() appelle les graphiques. Mais les graphiques ont besoin d être dessinés avant d être appelés. Par conséquent ; ModuleGraph::engine() appellera drawer.php qui dessinera le graphique. Voici les différents paramètres nécessaires par le fichier d appel. $_GET* module'+ : le nom du module qui doit être dessiné $_GET* render'+ : gd, flash, google, silverlight $_GET* type'+ : pie, column, line $_GET* option'+ : certains paramètres nécessaires par le module $_GET* width'+ : largeur du graphique $_GET* height'+ : hauteur du graphique $_GET* layers + : nombre de couches dans le même graphique. Le fichier qui dessine les graphiques va créer un objet $_GET* module + qui définira les options $_GET* option +, puis il va créer et dessiner le graphique à l aide de ModuleGraph::create() et de ModuleGraph::draw(). Comment est gérée la période de temps Il arrive que l utilisateur veuille voir un graphique sur une certaine période de temps. Par conséquent, l utilisateur a la possibilité de pouvoir choisir d afficher les données de son graphique sur un jour, un mois ou même une année. Dans Prestashop statistics, nous avons intégré un calendrier qui permet d aider l utilisateur à choisir et définir sa période de temps de façon simple et rapide. Le calendrier remplie la date sélectionnée dans un témoin $cookie->stats_day; $cookie->stats_month; $cookie->stats_year; Grâce à ce témoin, le moteur peut savoir si l utilisateur souhaite un graphique sur une journée spéciale, sur un mois et même une année : Si stats_day, stats_month et stats_year sont remplis (exemple : stats_day = 29; stats_month =5; stats_year = 2008), le moteur créera un graphique pour une journée spéciale (ici, 29/05/2008) Si seuls stats_month et stats_year sont remplis (exemple : stats_day = NULL; stats_month =5; stats_year = 2008), le moteur va créer un graphique sur un mois choisi (dans cet exemple Mai 2008) Si seul stats_year est rempli (exemple : stats_day = NULL; stats_month = NULL; stats_year = 2008), le moteur va créer un graphique pour une année spéciale (ici l année 2008). Si toutes les valeurs sont vides, le graphique ne dépendra pas du temps. Page 7

8 Comment créer un module utilisant un graphique facilement Avant tout chose ; il faut d abord comprendre comment les points d accroche des modules fonctionnent: Tout d abord, il y a 3 différents types de statistiques : AdminStatsActivity (activité), AdminStatsCatalog (analyse du catalogue) et AdminStatsCommercial (analyse commerciale). Le module devra appartenir (et être accroché) à l un des modules précédemment cités. Puis, une fois que l administrateur ira sur une de ses pages (dans l onglet Statistiques ), le module apparaîtra dans le cadre Navigation. Les modules de statistique devraient se situer dans des répertoires commençant par stats et doivent être dans le répertoire ~/modules/ Le nom du fichier doit être le même que le nom de son répertoire principal. Par exemple un module qui liste le nombre de ventes devra être placé dans ~/modules/statsventes/statsventes.php Il est aussi possible d ajouter un logotype pour le module, dans ~/modules/[nom du module]/logo.gif <?php class MyModule extends ModuleGraph function construct() $this->name = 'My module\'s name'; //Nom du module $this->tab = 'Stats'; //Ne devrait pas changer $this->version = 1.0; //Version du Module $this->page = basename( FILE, '.php'); //Ne devrait pas changer parent:: construct(); $this->displayname = $this->l('le nom de mon module'); $this->description = $this->l('voici une description de mon module'); public function install() return (parent::install() AND $this->registerhook(adminstatsmodules)); public function AdminStatsModules ($params) $html = 'Voici le contenu de mon module '.$this->displayname.' qui sera affiché'; Page 8

9 $html.= ModuleGraph::engine(array()); //Le moteur appellera drawer.php afin d afficher les statistiques //Si nous voulons un graphique en camembert (pie), nous pouvons écrire //$html.=modulegraph::engine(array('type' => 'pie')); //Si nous voulons un graphique avec plusieurs couches et un entier en option, nous pouvons écrire //$html.= ModuleGraph::engine(array('layers' => 2, 'type' => 'line', 'option' => 1)); return $html; protected function getdata() $this->_titles['main'] = $this->l('main title'); $this->getdate(); //Car le graphique peut être affiché pour une certaine période de temps $this->setdategraph(true); //Afin d afficher la légende de ces dates protected function setyearvalues() //Ici nous pouvons faire des requêtes qui récupéreront les données sur une année //et remplir le tableau $this->_values' protected function setmonthvalues($max) //Ici nous pouvons faire des requêtes qui récupéreront les données sur un mois //et remplir le tableau $this->_values' protected function setdayvalues() //Ici nous pouvons faire des requêtes qui récupéreront les données sur une journée //et remplir le tableau $this->_values' //Ici un exemple de code qui gère les options et couches Public function setoption($option, $layers = 1) if ($option == 1) $this->_titles['main'][0] = $this->l('mon titre'); $this->_titles['main'][1] = $this->l('titre couche 1'); $this->_titles['main'][2] = $this->l(' Titre couche 2'); //$this->_query[0] = ; //$this->_query[1] = ;?> Page 9