Docs : update and complete comments

This commit is contained in:
Philippe GRAND 2018-07-09 19:04:50 +02:00
parent b4b3e33e3e
commit df1bead49b
8 changed files with 33 additions and 19 deletions

View File

@ -62,7 +62,7 @@ class modModuleBuilder extends DolibarrModules
//------------- //-------------
$this->config_page_url = array('setup@modulebuilder'); $this->config_page_url = array('setup@modulebuilder');
// Dependancies // Dependencies
//------------- //-------------
$this->hidden = false; // A condition to disable module $this->hidden = false; // A condition to disable module
$this->depends = array(); // List of modules id that must be enabled if this module is enabled $this->depends = array(); // List of modules id that must be enabled if this module is enabled

View File

@ -88,7 +88,7 @@ class modMultiCurrency extends DolibarrModules
$this->depends = array(); // List of modules id that must be enabled if this module is enabled $this->depends = array(); // List of modules id that must be enabled if this module is enabled
$this->requiredby = array(); // List of modules id to disable if this one is disabled $this->requiredby = array(); // List of modules id to disable if this one is disabled
$this->conflictwith = array(); // List of modules id this module is in conflict with $this->conflictwith = array(); // List of modules id this module is in conflict with
$this->phpmin = array(5, 0); // Minimum version of PHP required by module $this->phpmin = array(5, 4); // Minimum version of PHP required by module
$this->need_dolibarr_version = array(3, 0); // Minimum version of Dolibarr required by module $this->need_dolibarr_version = array(3, 0); // Minimum version of Dolibarr required by module
$this->langfiles = array("multicurrency"); $this->langfiles = array("multicurrency");

View File

@ -55,8 +55,11 @@ class modNotification extends DolibarrModules
$this->dirs = array(); $this->dirs = array();
// Dependencies // Dependencies
$this->depends = array(); $this->hidden = false; // A condition to hide module
$this->requiredby = array(); $this->depends = array(); // List of module class names as string that must be enabled if this module is enabled
$this->requiredby = array(); // List of module ids to disable if this one is disabled
$this->conflictwith = array(); // List of module class names as string this module is in conflict with
$this->phpmin = array(5,4); // Minimum version of PHP required by module
$this->langfiles = array("mails"); $this->langfiles = array("mails");
// Config pages // Config pages

View File

@ -67,9 +67,11 @@ class modOauth extends DolibarrModules
$this->config_page_url = array("oauth.php"); $this->config_page_url = array("oauth.php");
// Dependencies // Dependencies
$this->depends = array(); $this->hidden = false; // A condition to hide module
$this->requiredby = array(); $this->depends = array(); // List of module class names as string that must be enabled if this module is enabled
$this->phpmin = array(5,1); // Minimum version of PHP required by module $this->requiredby = array(); // List of module ids to disable if this one is disabled
$this->conflictwith = array(); // List of module class names as string this module is in conflict with
$this->phpmin = array(5,4); // Minimum version of PHP required by module // Minimum version of PHP required by module
$this->need_dolibarr_version = array(3,7,-2); // Minimum version of Dolibarr required by module $this->need_dolibarr_version = array(3,7,-2); // Minimum version of Dolibarr required by module
$this->conflictwith = array(); $this->conflictwith = array();
$this->langfiles = array("oauth"); $this->langfiles = array("oauth");

View File

@ -72,9 +72,11 @@ class modOpenSurvey extends DolibarrModules
//$this->dirs[1] = DOL_DATA_ROOT.'/mymodule/temp; //$this->dirs[1] = DOL_DATA_ROOT.'/mymodule/temp;
// Dependencies // Dependencies
$this->depends = array(); // List of modules id that must be enabled if this module is enabled $this->hidden = false; // A condition to hide module
$this->requiredby = array(); // List of modules id to disable if this one is disabled $this->depends = array(); // List of module class names as string that must be enabled if this module is enabled
$this->phpmin = array(4,1); // Minimum version of PHP required by module $this->requiredby = array(); // List of module ids to disable if this one is disabled
$this->conflictwith = array(); // List of module class names as string this module is in conflict with
$this->phpmin = array(5,4); // Minimum version of PHP required by module
$this->need_dolibarr_version = array(3,4,0); // Minimum version of Dolibarr required by module $this->need_dolibarr_version = array(3,4,0); // Minimum version of Dolibarr required by module
// Constants // Constants

View File

@ -69,9 +69,11 @@ class modPayBox extends DolibarrModules
$this->config_page_url = array("paybox.php@paybox"); $this->config_page_url = array("paybox.php@paybox");
// Dependencies // Dependencies
$this->depends = array(); // List of modules id that must be enabled if this module is enabled $this->hidden = false; // A condition to hide module
$this->requiredby = array(); // List of modules id to disable if this one is disabled $this->depends = array(); // List of module class names as string that must be enabled if this module is enabled
$this->phpmin = array(4,1); // Minimum version of PHP required by module $this->requiredby = array(); // List of module ids to disable if this one is disabled
$this->conflictwith = array(); // List of module class names as string this module is in conflict with
$this->phpmin = array(5,4); // Minimum version of PHP required by module
$this->need_dolibarr_version = array(2,6); // Minimum version of Dolibarr required by module $this->need_dolibarr_version = array(2,6); // Minimum version of Dolibarr required by module
$this->langfiles = array("paybox"); $this->langfiles = array("paybox");

View File

@ -70,9 +70,11 @@ class modPaypal extends DolibarrModules
$this->config_page_url = array("paypal.php@paypal"); $this->config_page_url = array("paypal.php@paypal");
// Dependencies // Dependencies
$this->depends = array(); // List of modules id that must be enabled if this module is enabled $this->hidden = false; // A condition to hide module
$this->requiredby = array('modPaypalPlus'); // List of modules id to disable if this one is disabled $this->depends = array(); // List of module class names as string that must be enabled if this module is enabled
$this->phpmin = array(5,2); // Minimum version of PHP required by module $this->requiredby = array('modPaypalPlus'); // List of module ids to disable if this one is disabled
$this->conflictwith = array(); // List of module class names as string this module is in conflict with
$this->phpmin = array(5,4); // Minimum version of PHP required by module
$this->need_dolibarr_version = array(3,0); // Minimum version of Dolibarr required by module $this->need_dolibarr_version = array(3,0); // Minimum version of Dolibarr required by module
$this->langfiles = array("paypal"); $this->langfiles = array("paypal");

View File

@ -63,9 +63,12 @@ class modPrelevement extends DolibarrModules
// Data directories to create when module is enabled // Data directories to create when module is enabled
$this->dirs = array("/prelevement/temp","/prelevement/receipts"); $this->dirs = array("/prelevement/temp","/prelevement/receipts");
// Dependancies // Dependencies
$this->depends = array("modFacture","modBanque"); $this->hidden = false; // A condition to hide module
$this->requiredby = array(); $this->depends = array("modFacture","modBanque"); // List of module class names as string that must be enabled if this module is enabled
$this->requiredby = array(); // List of module ids to disable if this one is disabled
$this->conflictwith = array(); // List of module class names as string this module is in conflict with
$this->phpmin = array(5,4); // Minimum version of PHP required by module
// Config pages // Config pages
$this->config_page_url = array("prelevement.php"); $this->config_page_url = array("prelevement.php");