tyler.durden/icingaweb2
1
0
Fork 0
mirror of https://github.com/Icinga/icingaweb2.git synced 2025-07-30 01:04:09 +02:00
Code Issues Packages Projects Releases Wiki Activity

Modules\Module: clean up phpdoc blocks

Browse Source
This commit is contained in:
Thomas Gelf 2014-05-26 14:14:34 +00:00
parent 5b87d6238b
commit 7c68d0a30f
1 changed files with 34 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

60
library/Icinga/Application/Modules/Module.php
View File

@ -200,9 +200,9 @@ class Module
/** /**
* Test for an enabled module by name * Test for an enabled module by name
* *
* @param string $name * @param string $name
* *
* @return boolean * @return boolean
*/ */
public static function exists($name) public static function exists($name)
{ {
@ -212,12 +212,12 @@ class Module
/** /**
* Get module by name * Get module by name
* *
* @param string $name * @param string $name
* @param bool $autoload * @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) public static function get($name, $autoload = false)
{ {
@ -429,6 +429,11 @@ class Module
return $this->basedir; return $this->basedir;
} }
/**
* Get the controller directory
*
* @return string
*/
public function getControllerDir() public function getControllerDir()
{ {
return $this->controllerdir; return $this->controllerdir;
@ -467,21 +472,20 @@ class Module
/** /**
* Getter for module config object * Getter for module config object
* *
* @param string $file * @param string $file
* *
* @return Config * @return Config
*/ */
public function getConfig($file = null) public function getConfig($file = null)
{ {
return $this->app return $this->app->getConfig()->module($this->name, $file);
->getConfig()
->module($this->name, $file);
} }
/** /**
* Retrieve provided permissions * Retrieve provided permissions
* *
* @param string $name Permission name * @param string $name Permission name
*
* @return array * @return array
*/ */
public function getProvidedPermissions() public function getProvidedPermissions()
@ -505,7 +509,8 @@ class Module
/** /**
* Whether the given permission name is supported * Whether the given permission name is supported
* *
* @param string $name Permission name * @param string $name Permission name
*
* @return bool * @return bool
*/ */
public function providesPermission($name) public function providesPermission($name)
@ -517,7 +522,8 @@ class Module
/** /**
* Whether the given restriction name is supported * Whether the given restriction name is supported
* *
* @param string $name Restriction name * @param string $name Restriction name
*
* @return bool * @return bool
*/ */
public function providesRestriction($name) public function providesRestriction($name)
@ -529,9 +535,10 @@ class Module
/** /**
* Provide a named permission * Provide a named permission
* *
* @param string $name Unique permission name * @param string $name Unique permission name
* @param string $name Permission description * @param string $name Permission description
* @return void *
* @return void
*/ */
protected function providePermission($name, $description) protected function providePermission($name, $description)
{ {
@ -549,9 +556,10 @@ class Module
/** /**
* Provide a named restriction * Provide a named restriction
* *
* @param string $name Unique restriction name * @param string $name Unique restriction name
* @param string $name Restriction description * @param string $description Restriction description
* @return void *
* @return void
*/ */
protected function provideRestriction($name, $description) protected function provideRestriction($name, $description)
{ {
@ -671,9 +679,9 @@ class Module
/** /**
* Include a php script if it is readable * 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) protected function includeScript($file)
{ {
@ -703,11 +711,11 @@ class Module
/** /**
* Register hook * Register hook
* *
* @param string $name * @param string $name
* @param string $class * @param string $class
* @param string $key * @param string $key
* *
* @return self * @return self
*/ */
protected function registerHook($name, $class, $key = null) protected function registerHook($name, $class, $key = null)
{ {