SCR Websolution. Guide de référence SDK

Transcription

1 Guide de référence SDK Auteur : Alexandre Kovacs Date de création : 08/06/2011 Révision : 2 Date de révision : 08/06/2011 Destinataires : Globale

2 Sommaire 1. Présentation Gestion des images contenues dans le template Modèle HTML Feuille de style Module PHP Base de données Fonctions disponibles Administration Front office Package disponibles Révision 2 Page 2/14

3 1. Présentation Le SDK (software development kit) a été développé par l équipe Research & Development du Groupe SCR dans le but d aider à la réalisation de packages intégrés au framework et CMS Scr Websolution. Le SDK se présente sous la forme d une interface Homme/Machine (IHM) permettant l intégration rapide et le test en temps réel de contenu HTML mis en forme au moyen de CSS et interfacés avec un script de type PHP. Le SDK permet de tester les packages dans tous les templates créés pour le site, rendant ainsi disponible au développeur de visualiser le rendu sous toutes les formes disponibles. Révision 2 Page 3/14

4 2. Gestion des images contenues dans le template Cet écran permet de visualiser les images contenues dans le template en cours d utilisation. Ces images sont directement en rapport avec la notion de charte graphique et ne constituent en aucun cas du contenu rédactionnel (à charge des éditeurs). Il est possible d envoyer par ce biais un fichier directement sur le serveur dans le répertoire /images du template en cours de visualisation ou de pré visualiser chaque image en cliquant sur l icône en forme de loupe ( ) située à gauche de chaque nom d image (ouverture d une popup) Révision 2 Page 4/14

5 3. Modèle HTML L Editeur HTML permet de créer de toute pièce ou de charger un template existant en le sélectionnant dans le menu déroulant. Chaque modification du squelette HTML est automatiquement répercutée dans la partie dédiée à la prévisualisation située à droite. Le développeur peut ainsi constater en temps réel la cohérence du code. En cas d erreur de rafraichissement, un bouton «rafraichir» permet de forcer la mise à jour du bloc droit. Révision 2 Page 5/14

6 4. Feuille de style Cette fonctionnalité est constituée de deux parties : Partie haute : Contient le code CSS spécifique au package en cours d édition. Il est conseillé d utiliser des règles de nommage ne permettant pas la surcharge du CSS déjà en place pour la mise en forme du site (dans notre exemple de package de nouvelles, chaque déclaration CSS est précédée de l indicatif _packn_. Partie basse : Contient le code CSS générique du site. Cette fonctionnalité permet au développeur de visualiser les déclarations génériques du site pour les utiliser si besoin est dans le package en cours de création et ainsi d assurer son homogénéité graphique vis-à-vis du site. Le bouton d édition ( ) quitte le sdk et permet d éditer le css du template. Toute modification de la partie haute (code CSS spécifique) est directement répercutée dans la partie de prévisualisation à droite de l écran. Révision 2 Page 6/14

7 5. Module PHP L Editeur PHP permet de créer de toute pièce ou de charger un module existant en le sélectionnant dans le menu déroulant. Les modifications au module PHP ne sont répercutées sur le coté droit de prévisualisation que lors d un clic sur le bouton «Tester» : Ce système permet au développeur de valider son code en temps réel. L utilisation d un IDE externe pour ce faire reste totalement possible de deux façons : - Soit en copiant / collant le code développé dans l IDE externe et en le testant dans le SDK Révision 2 Page 7/14

8 - Soit en déclarant temporairement une inclusion de fichier php require_once(../dev_en_cours.php ) et en éditant ce fichier PHP directement dans l IDE du développeur qui conserve ainsi ses habitudes, sa souplesse de développement et peut toutefois en tester le résultat en temps réel sans autre manipulation que de cliquer sur le bouton «tester». (Notez qu à l issue, il est conseillé de rapatrier le code dans l éditeur interne pour le sauvegarder). Le SDK permet ainsi aux développeurs de conserver leurs habitudes de développement tout en offrant un outil souple de test et débogage. Le bouton «sauvegarder» permet d écraser un module ou un modèle existant, ou d en créer de nouveaux : Une fois l enregistrement effectué, le SDK donne l opportunité d aller mettre à jour les pages contenant le modèle HTML en cours d édition pour mettre à jour tout le site. Révision 2 Page 8/14

9 Dans le cas ou aucune page ne contiendrait le package en cours de réalisation, il suffit alors d aller éditer une page en mode architecture et d inclure dans une boite le modèle et le module ainsi créés : Vos pages contiendront alors toutes les fonctionnalités intégrées : Révision 2 Page 9/14

10 6. Base de données La partie base de données permet au développeur de ne pas à avoir à basculer continuellement de fenêtre pour consulter son interface de gestion de données pour connaître le nom d une table, le détail de ses champs ou son format. Cet écran est plus un support et une aide au développement qu une interface active. Révision 2 Page 10/14

11 7. Fonctions disponibles La partie fonctions permet au développeur de visualiser rapidement toutes les fonctions contenues dans le framework, de savoir de quel module elle provient ainsi que ses paramètres. Un clic sur le nom d une fonction l intègre directement à la fin du code PHP en cours d édition avec ses paramètres. Révision 2 Page 11/14

12 8. Administration Grâce à son intégration complète, les packages ainsi développés peuvent recevoir un puissant outil d administration grâce aux générateurs de formulaires d administration en version 1.0 et 2.0 suivant les besoins. Les modules ainsi créés dans des répertoires dédiés peuvent facilement être portés d un site à un autre sous la forme de packs. Révision 2 Page 12/14

13 9. Front office En adéquation avec le module de génération de formulaire en front-office. Le SDK est l outil idéal pour mettre en forme et retoucher des pages générées par le «Front maker» : Révision 2 Page 13/14

14 10. Package disponibles Les packages actuellement disponibles sont : - Package de nouvelles o Paramétrable o Possibilité d insertion d images et génération des miniatures o Insertion fichiers attachés à télécharger o Interfaçage avec le package de Diaporama o Gestion des commentaires visiteurs modelables ou non avec option CAPCHA - Package d inscription newsletter simple Les packages en cours de développement au sein de la R&D : - Package d identification utilisateur et de création de comptes - Package e-commerce. o Gestion de familles de produits o Interfaçage avec le package de Diaporama o Gestion des commentaires visiteurs modelables ou non avec option CAPCHA o Option Panier o Interfaçage avec le package d identification utilisateur o Module SISP ATOS CB/VISA/PAYPAL Groupe SCR Reste à la disposition de ses clients pour l adaptation ou le développement de nouveaux packages servant leur activité. Révision 2 Page 14/14