Update page 'Architecture de module'

Shikiryu 2016-11-17 12:57:11 +01:00
parent cd4a04c173
commit 7a63adcfea

@ -77,5 +77,39 @@ Elle initialise un peu tout : Elle récupère tous les modules présents dans le
De base, plusieurs fonctions sont réutilisables et utile : De base, plusieurs fonctions sont réutilisables et utile :
- @make\_draggable($(\#idDe - `make_draggable($('#idDeVotreModule'));` : permet 2 fonctionnalités sur la `div` de votre module :
- La `div` peut ainsi être déplacée sur votre ***accueil***
- La position suite à la fin du déplacement est enregistrée sur le serveur
<!-- -->
- `$('#menu-bar').prepend($('#idDuLienDeConfigDuModule'));` : (*optionnel*) Si votre module a besoin dun menu de config et afin de rester dans la charte de l***accueil***, merci de rentrer ce script afin de placer le lien de config dans la barre de menu. (Il est conseillé de donner ce style à ce lien : `#idDuLienDeConfigDuModule{float:right; margin:12px 10px 0 0;}`
Comment construire votre module
-------------------------------
- `class _monmodule_ extends Module` : permet de créer le module ayant comme nom *monmodule* (\_/! important, lid de votre module doit avoir exactement le même nom que votre classe, les 2 **en miniscule** !)
<!-- -->
- `protected $moduleTitle = 'Mon module';` : indiquez le libellé de votre module (facultatif, non utilisé)
<!-- -->
- `protected $paramsList = array('visibility','x','y');` : la liste des paramètres de votre module présent dans le fichier de configuration, très important.
<!-- -->
- `public function __construct($params){ parent::__construct(__CLASS__, $params); }` : constructeur comme ça.
<!-- -->
- `public function build(){ echo '<script type="text/javascript" src="'.$this->pathToModule.'js/'.$this->moduleName.'.js"></script><link rel="stylesheet" href="'.$this->pathToModule.'css/'.$this->moduleName.'.css" type="text/css" />'; echo '<div id="monmodule">pwetpwet</div>'; }` : La construction de votre module en html et CSS. le 1er `echo` est recommandé. Après, à vous de gérer HTML, JS et CSS ;)
Pour aider : la structure de base en fichier
--------------------------------------------
[moduletest.zip]
[moduletest.zip]: http://www.xp-dev.com/file/4370