Documentation technique Back-office

Transcription

1 MEEVY Documentation technique Back-office Juillet 2010 MEEVY a pour but de fournir aux artistes des outils pour promouvoir leur musique sur internet et proposer à l auditeur une plateforme de musique en ligne gratuite disponible sur plusieurs applications, pour découvrir et partager de la musique de groupes indépendants. Ce document présente la structure du back-office de Meevy.

2 Chapitre : Pré-requis SOMMAIRE SOMMAIRE... 2 A savoir... 3 Pré-requis... 3 Langage et technologies utilises... 3 Architecture fichier... 4 Principe de l architecture... 4 Les fichiers PHP docheck() doinsert() doupdate() dodelete() doselect () doselectall ()... 5 Les fichiers _edit... 5 Diagramme de la base de données... 7 Liens Documentations externes... 8 jquery... 8 PHP... 8 HTML/CSS... 8 TinyMCE Editor

3 Chapitre : Pré-requis A savoir Pré-requis Le back-office est développé sous forme de site internet. Il est donc accessible uniquement via un navigateur web tel que : - Internet explorer - Firefox - Opera - Safari - Chrome - Il est nécessaire de posséder une connexion internet puisque le back-office est héberge sur un serveur web. Langage et technologies utilises Du fait que le back-office est sous forme de site internet, l apparence du site est réalisée a partir des technologies suivantes : - HTML 4 - CSS Afin de rendre ce site internet plus ergonomique, sont utilisés : - jquery, framework javascript/ajax - ainsi que certains plugins dont le richtext tinymce Le back-office est relie a une base de données de type MySQL. Cette liaison est permise via le langage PHP 5. 3

4 Chapitre : Architecture fichier Principe de l architecture Chaque table de la base de donnees possede sa classe de type PHP_[NOM_TABLE].php qui est appellee par : - un fichier PHP de type [NOM_TABLE]_edit.php : page formulaire d ajout ou d édition - un fichier PHP de type [NOM_TABLE]_list.php : page listant le contenu de la table Les fichiers PHP Chaque fichier contient une classe contenant les méthodes suivantes : - docheck() : méthode qui permet de checker quels sont les champs obligatoires a remplir, si les champs sont bien numériques En cas de champs non rempli, celle-ci renvoi un tableau contenant le nom des champs a faire corriger par l utilisateur. Si aucun problème, renvoi un tableau vide. - doinsert() : méthode permettant de récolter dans un tableau les données a insérer en base de données. Le tableau est a double dimension de type array[{key}] = {VALUE}. La {KEY} correspond au nom de la colonne. Ce tableau est ensuite envoyer a la méthode execinsert() qui se charge d écrire la requête d insertion et de l exécuter. Si aucun problème, renvoi l id d insertion. - doupdate() : méthode permettant de récolter dans un tableau les données tableau permettant de savoir quelles sont les données a supprimer. Le tableau est a double dimension de type array[{key}] = {VALUE}. La {KEY} correspond au nom de la colonne. Ce tableau est ensuite envoyer a la méthode execdelete() qui se charge d écrire la requête de suppression et de l exécuter. Si aucun problème, renvoi le nombre de champs affectes. 4

5 Chapitre : Les fichiers _edit - dodelete() : méthode permettant de récolter dans un tableau les données a modifier en base de données ainsi qu un tableau permettant de savoir quelles sont les données a modifier. Le tableau est a double dimension de type array[{key}] = {VALUE}. La {KEY} correspond au nom de la colonne. Ce tableau est ensuite envoyer a la méthode execupdate() qui se charge d écrire la requête d update et de l exécuter. Si aucun problème, renvoi le nombre de champs affectes. - doselect () : méthode permettant de récupérer toutes les données d un champ en fonction d une variable GET envoyé via url. Principalement utilisée par les fichiers _list dans le cadre d une modification de données. - doselectall () : méthode permettant de récupérer toutes les données de la table. Principalement utilisée par les fichiers _list.php. Les fichiers _edit Les fichiers _edit.php correspondent aux formulaires d ajout ou d édition. Ceux-ci font appels au fichier PHP correspondant qui permet de récupérer toutes les informations supplémentaires tel que la valeur des champs dans le cadre d une édition Chaque champ de formulaire possède son label. En cas d erreur tel que champ obligatoire non renseigne ou champ numérique erroné, le label ainsi que le champ deviennent rouges. Les fichiers _list Les fichiers _list.php correspondent aux listings des différentes tables. Ceux-ci font appels au fichier PHP correspondant qui permet de récupérer toutes les informations supplémentaires tel que la liste des insertions de la base de données en question. 5

6 Chapitre : Les fichiers _edit Chaque listing comporte : - Formulaire de filtrage - Pagination - Choix du nombre de résultats par page 6

7 Chapitre : Les fichiers _edit Diagramme de la base de données 7

8 Chapitre : jquery Liens Documentations externes jquery PHP HTML/CSS TinyMCE Editor 8