Modules\Module: clean up phpdoc blocks
This commit is contained in:
parent
5b87d6238b
commit
7c68d0a30f
|
@ -200,9 +200,9 @@ class Module
|
|||
/**
|
||||
* Test for an enabled module by name
|
||||
*
|
||||
* @param string $name
|
||||
* @param string $name
|
||||
*
|
||||
* @return boolean
|
||||
* @return boolean
|
||||
*/
|
||||
public static function exists($name)
|
||||
{
|
||||
|
@ -212,12 +212,12 @@ class Module
|
|||
/**
|
||||
* Get module by name
|
||||
*
|
||||
* @param string $name
|
||||
* @param bool $autoload
|
||||
* @param string $name
|
||||
* @param bool $autoload
|
||||
*
|
||||
* @return mixed
|
||||
* @return mixed
|
||||
*
|
||||
* @throws \Icinga\Exception\ProgrammingError When the module is not yet loaded
|
||||
* @throws ProgrammingError When the module is not yet loaded
|
||||
*/
|
||||
public static function get($name, $autoload = false)
|
||||
{
|
||||
|
@ -429,6 +429,11 @@ class Module
|
|||
return $this->basedir;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the controller directory
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function getControllerDir()
|
||||
{
|
||||
return $this->controllerdir;
|
||||
|
@ -467,21 +472,20 @@ class Module
|
|||
/**
|
||||
* Getter for module config object
|
||||
*
|
||||
* @param string $file
|
||||
* @param string $file
|
||||
*
|
||||
* @return Config
|
||||
* @return Config
|
||||
*/
|
||||
public function getConfig($file = null)
|
||||
{
|
||||
return $this->app
|
||||
->getConfig()
|
||||
->module($this->name, $file);
|
||||
return $this->app->getConfig()->module($this->name, $file);
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieve provided permissions
|
||||
*
|
||||
* @param string $name Permission name
|
||||
* @param string $name Permission name
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function getProvidedPermissions()
|
||||
|
@ -505,7 +509,8 @@ class Module
|
|||
/**
|
||||
* Whether the given permission name is supported
|
||||
*
|
||||
* @param string $name Permission name
|
||||
* @param string $name Permission name
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
public function providesPermission($name)
|
||||
|
@ -517,7 +522,8 @@ class Module
|
|||
/**
|
||||
* Whether the given restriction name is supported
|
||||
*
|
||||
* @param string $name Restriction name
|
||||
* @param string $name Restriction name
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
public function providesRestriction($name)
|
||||
|
@ -529,9 +535,10 @@ class Module
|
|||
/**
|
||||
* Provide a named permission
|
||||
*
|
||||
* @param string $name Unique permission name
|
||||
* @param string $name Permission description
|
||||
* @return void
|
||||
* @param string $name Unique permission name
|
||||
* @param string $name Permission description
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
protected function providePermission($name, $description)
|
||||
{
|
||||
|
@ -549,9 +556,10 @@ class Module
|
|||
/**
|
||||
* Provide a named restriction
|
||||
*
|
||||
* @param string $name Unique restriction name
|
||||
* @param string $name Restriction description
|
||||
* @return void
|
||||
* @param string $name Unique restriction name
|
||||
* @param string $description Restriction description
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
protected function provideRestriction($name, $description)
|
||||
{
|
||||
|
@ -671,9 +679,9 @@ class Module
|
|||
/**
|
||||
* Include a php script if it is readable
|
||||
*
|
||||
* @param string $file File to include
|
||||
* @param string $file File to include
|
||||
*
|
||||
* @return self
|
||||
* @return self
|
||||
*/
|
||||
protected function includeScript($file)
|
||||
{
|
||||
|
@ -703,11 +711,11 @@ class Module
|
|||
/**
|
||||
* Register hook
|
||||
*
|
||||
* @param string $name
|
||||
* @param string $class
|
||||
* @param string $key
|
||||
* @param string $name
|
||||
* @param string $class
|
||||
* @param string $key
|
||||
*
|
||||
* @return self
|
||||
* @return self
|
||||
*/
|
||||
protected function registerHook($name, $class, $key = null)
|
||||
{
|
||||
|
|
Loading…
Reference in New Issue