* @author Icinga Development Team */ // {{{ICINGA_LICENSE_HEADER}}} /** * Module action controller */ namespace Icinga\Web; use \Icinga\Application\Config as IcingaConfig; use Icinga\Application\Icinga; /** * Base class for all module action controllers * * All Icinga Web module controllers should extend this class * * @copyright Copyright (c) 2013 Icinga-Web Team * @author Icinga-Web Team * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License */ class ModuleActionController extends ActionController { protected $module; protected $module_dir; /** * Gives you this modules base directory * * @return string */ public function getModuleDir() { if ($this->module_dir === null) { $this->module_dir = $this->getModule()->getBaseDir(); } return $this->module_dir; } public function getModule() { if ($this->module === null) { $this->module = Icinga::app()->getModule( $this->module_name ); } return $this->module; } /** * Translates the given string with the modules translation catalog * * @param string $string The string that should be translated * * @return string */ public function translate($string) { return mt($this->module_name, $string); } /** * This is where the module configuration is going to be loaded * * @return void */ protected function loadConfig() { $this->config = IcingaConfig::module($this->module_name); } /** * Once dispatched we are going to place each modules output in a div * container having the icinga-module and the icinga-$module-name classes * * @return void */ public function postDispatch() { parent::postDispatch(); $this->_helper->layout()->moduleStart = '

' . "\n" ; $this->_helper->layout()->moduleEnd = "

\n"; } }