{{plugin}}.plugin.php 3.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122
  1. {"label":"Plugin","syntax":"php"}
  2. <?php
  3. //Déclaration d'un item de menu dans le menu principal
  4. function {{plugin}}_menu(&$menuItems){
  5. global $_,$myUser;
  6. if(!$myUser->can('{{plugin}}','read')) return;
  7. $menuItems[] = array(
  8. 'sort'=>3,
  9. 'url'=>'index.php?module={{plugin}}',
  10. 'label'=>'{{plugin}}',
  11. 'icon'=> 'far fa-question-circle',
  12. 'color'=> '#3498db'
  13. );
  14. }
  15. //Cette fonction va generer une page quand on clique sur {{plugin}} dans menu
  16. function {{plugin}}_page(){
  17. global $_,$myUser;
  18. if(!isset($_['module']) || $_['module'] !='{{plugin}}') return;
  19. $page = !isset($_['page']) ? 'list.{{entity.readable}}' : $_['page'];
  20. $file = __DIR__.SLASH.'page.'.$page.'.php';
  21. if(!file_exists($file)) throw new Exception("Page ".$page." inexistante");
  22. require_once($file);
  23. }
  24. //Fonction executée lors de l'activation du plugin
  25. function {{plugin}}_install($id){
  26. if($id != 'fr.idleman.{{plugin}}') return;
  27. Entity::install(__DIR__);
  28. }
  29. //Fonction executée lors de la désactivation du plugin
  30. function {{plugin}}_uninstall($id){
  31. if($id != 'fr.idleman.{{plugin}}') return;
  32. Entity::uninstall(__DIR__);
  33. }
  34. //Déclaration des sections de droits du plugin
  35. function {{plugin}}_section(&$sections){
  36. $sections['{{plugin}}'] = "Gestion des droits sur le plugin {{plugin}}";
  37. // $sections['{{entity}}'] = "Gestion des droits sur l'entité {{entity}}";
  38. }
  39. //cette fonction comprends toutes les actions du plugin qui ne nécessitent pas de vue html
  40. function {{plugin}}_action(){
  41. require_once(__DIR__.SLASH.'action.php');
  42. }
  43. {{~! Pas de page réglages }}//Déclaration du menu de réglages
  44. function {{plugin}}_menu_setting(&$settingMenu){
  45. global $_, $myUser;
  46. if(!$myUser->can('{{plugin}}','configure')) return;
  47. $settingMenu[]= array(
  48. 'sort' =>1,
  49. 'url' => 'setting.php?section=global.{{plugin}}',
  50. 'icon' => 'fas fa-angle-right',
  51. 'label' => '{{plugin}} Général'
  52. );
  53. $settingMenu[]= array(
  54. 'sort' =>1,
  55. 'url' => 'setting.php?section=list.{{plugin}}.{{entity.readable}}',
  56. 'icon' => 'fas fa-angle-right',
  57. 'label' => '{{plugin}}'
  58. );
  59. }
  60. {{/~}}
  61. {{~! Pas de page réglages }}//Déclaration des pages de réglages
  62. function {{plugin}}_content_setting(){
  63. global $_;
  64. if(file_exists(__DIR__.SLASH.'setting.'.$_['section'].'.php'))
  65. require_once(__DIR__.SLASH.'setting.'.$_['section'].'.php');
  66. }
  67. {{/~}}
  68. {{~! Pas de page réglages }}//Déclaration des settings de base
  69. //Types possibles : text,select ( + "values"=> array('1'=>'Val 1'),password,checkbox. Un simple string définit une catégorie.
  70. Configuration::setting('{{plugin}}',array(
  71. "Général",
  72. '{{plugin}}_enable' => array("label"=>"Activer","type"=>"checkbox"),
  73. ));
  74. {{/~}}
  75. {{~ Widget de dashboard }}
  76. //Affichage du/des widget(s)
  77. function {{plugin}}_widget(&$widgets){
  78. global $myUser;
  79. require_once(__DIR__.SLASH.'..'.SLASH.'dashboard'.SLASH.'DashboardWidget.class.php');
  80. $modelWidget = new DashboardWidget();
  81. $modelWidget->model = '{{plugin}}';
  82. $modelWidget->title = '{{Plugin}}';
  83. $modelWidget->icon = 'far fa-bookmark';
  84. $modelWidget->background = '#273c75';
  85. $modelWidget->load = 'action.php?action={{plugin}}_widget_load';
  86. $modelWidget->js = [Plugin::url().'/js/widget.js?v=1'];
  87. $modelWidget->css = [Plugin::url().'/css/widget.css?v=2'];
  88. $modelWidget->description = "{{description}}";
  89. $widgets[] = $modelWidget;
  90. }
  91. {{/~}}
  92. //Déclation des assets
  93. Plugin::addCss("/css/main.css");
  94. Plugin::addJs("/js/main.js");
  95. //Mapping hook / fonctions
  96. Plugin::addHook("install", "{{plugin}}_install");
  97. Plugin::addHook("uninstall", "{{plugin}}_uninstall");
  98. Plugin::addHook("section", "{{plugin}}_section");
  99. Plugin::addHook("menu_main", "{{plugin}}_menu");
  100. Plugin::addHook("page", "{{plugin}}_page");
  101. Plugin::addHook("action", "{{plugin}}_action");
  102. {{~! Pas de page réglages }}Plugin::addHook("menu_setting", "{{plugin}}_menu_setting");{{/~}}
  103. {{~! Pas de page réglages }}Plugin::addHook("content_setting", "{{plugin}}_content_setting");{{/~}}
  104. {{~ Widget de dashboard }}Plugin::addHook("widget", "{{plugin}}_widget");{{/~}}
  105. ?>