diff --git a/library/Icinga/Web/View.php b/library/Icinga/Web/View.php index 071b7643d..9781757b8 100644 --- a/library/Icinga/Web/View.php +++ b/library/Icinga/Web/View.php @@ -1,19 +1,59 @@ + * @license http://www.gnu.org/licenses/gpl-2.0.txt GPL, version 2 + * @author Icinga Development Team + */ +// {{{ICINGA_LICENSE_HEADER}}} namespace Icinga\Web; -use Zend_View_Abstract as ZfViewAbstract; -use Icinga\Web\Url; -use Icinga\Util\Format; +use \Zend_View_Abstract; +use \Icinga\Web\Url; +use \Icinga\Util\Format; -class View extends ZfViewAbstract +/** + * Icinga view + */ +class View extends Zend_View_Abstract { - private $_useViewStream = false; + /** + * Flag to register stream wrapper + * + * @var bool + */ + private $useViewStream = false; + /** + * Create a new view object + * + * @param array $config + * @see Zend_View_Abstract::__construct + */ public function __construct($config = array()) { - $this->_useViewStream = (bool) ini_get('short_open_tag') ? false : true; - if ($this->_useViewStream) { + $this->useViewStream = (bool) ini_get('short_open_tag') ? false : true; + if ($this->useViewStream) { if (!in_array('zend.view', stream_get_wrappers())) { stream_wrapper_register('zend.view', '\Icinga\Web\ViewStream'); } @@ -21,12 +61,20 @@ class View extends ZfViewAbstract parent::__construct($config); } + /** + * Initialize the view + * + * @see Zend_View_Abstract::init + */ public function init() { $this->loadGlobalHelpers(); } - protected function loadGlobalHelpers() + /** + * Load helpers + */ + private function loadGlobalHelpers() { $pattern = dirname(__FILE__) . '/View/helpers/*.php'; $files = glob($pattern); @@ -35,19 +83,37 @@ class View extends ZfViewAbstract } } + // @codingStandardsIgnoreStart + /** + * Use to include the view script in a scope that only allows public + * members. + * + * @return mixed + * + * @see Zend_View_Abstract::run + */ protected function _run() { foreach ($this->getVars() as $k => $v) { // Exporting global variables to view scripts: $$k = $v; } - if ($this->_useViewStream) { - include 'zend.view://' . func_get_arg(0); + if ($this->useViewStream) { + include 'zend.view://' . func_get_arg(0); } else { include func_get_arg(0); } } + // @codingStandardsIgnoreEnd + /** + * Accesses a helper object from within a script + * + * @param string $name + * @param array $args + * + * @return string + */ public function __call($name, $args) { $namespaced = '\\Icinga\\Web\\View\\' . $name;