DomCI : Update all the PHPDoc
git-svn-id: https://svn.fournier38.fr/svn/ProgSVN/trunk@3279 bf3deb0d-5f1a-0410-827f-c0cc1f45334c
This commit is contained in:
28
module.php
28
module.php
@@ -7,14 +7,16 @@
|
||||
class module
|
||||
{
|
||||
/** The modules are not allowed if $toplevel=0
|
||||
The modules can be in a module directory if $toplevel=1
|
||||
The modules can be in the parent directory if $toplevel=2
|
||||
The modules can be in the local directory if $toplevel=4
|
||||
The values can be added to allow multiple possibilities */
|
||||
* The modules can be in a module directory if $toplevel=1
|
||||
* The modules can be in the parent directory if $toplevel=2
|
||||
* The modules can be in the local directory if $toplevel=4
|
||||
* The values can be added to allow multiple possibilities
|
||||
*/
|
||||
public $toplevel = 0;
|
||||
|
||||
/** List all the available (enable or disable) modules
|
||||
@return array The list of the available modules names with the path */
|
||||
* @return array The list of the available modules names with the path
|
||||
*/
|
||||
public function listAvailable ()
|
||||
{
|
||||
$list = array ();
|
||||
@@ -47,10 +49,11 @@ class module
|
||||
}
|
||||
|
||||
/** List all the enable modules coming from the configuration and available
|
||||
in the system
|
||||
@param array $confModules the list of the available modules coming from
|
||||
the configuration. Can have some non available modules.
|
||||
@return array the list of the available modules names with the path */
|
||||
* in the system
|
||||
* @param array $confModules the list of the available modules coming from
|
||||
* the configuration. Can have some non available modules.
|
||||
* @return array the list of the available modules names with the path
|
||||
*/
|
||||
public function listEnable ($confModules)
|
||||
{
|
||||
$listAvailable = $this->listAvailable ();
|
||||
@@ -65,8 +68,10 @@ class module
|
||||
}
|
||||
|
||||
/** Return the name of the module translated in the provided language
|
||||
The module name must be defined in the translation under the "modulename"
|
||||
item
|
||||
* The module name must be defined in the translation under the "modulename"
|
||||
* item
|
||||
* @param string $modulepath The module path
|
||||
* @param string $lang The lang to use
|
||||
*/
|
||||
public function translateName ($modulepath, $lang)
|
||||
{
|
||||
@@ -75,4 +80,3 @@ class module
|
||||
return basename ($modulepath);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
Reference in New Issue
Block a user