MainDetail: Fix doc strings

refs #4611
This commit is contained in:
Marius Hein 2013-09-24 11:21:09 +02:00
parent 8bb89d7d34
commit ff0760e507
2 changed files with 23 additions and 1 deletions

View File

@ -28,9 +28,16 @@
*/ */
// {{{ICINGA_LICENSE_HEADER}}} // {{{ICINGA_LICENSE_HEADER}}}
/**
* Helper to render main and detail contents into a container
*/
class Zend_View_Helper_MainDetail extends Zend_View_Helper_Abstract class Zend_View_Helper_MainDetail extends Zend_View_Helper_Abstract
{ {
/**
* HTML template
*
* @var string
*/
private static $tpl = <<<'EOT' private static $tpl = <<<'EOT'
<div id='icingamain' class='{{MAIN_CLASS}}'> <div id='icingamain' class='{{MAIN_CLASS}}'>
{{MAIN_CONTENT}} {{MAIN_CONTENT}}
@ -41,6 +48,11 @@ class Zend_View_Helper_MainDetail extends Zend_View_Helper_Abstract
</div> </div>
EOT; EOT;
/**
* Css class map when detail pane is expanded
*
* @var array
*/
private static $expanded = array( private static $expanded = array(
'xs' => 12, 'xs' => 12,
'sm' => 12, 'sm' => 12,
@ -48,6 +60,14 @@ EOT;
'lg' => 5 'lg' => 5
); );
/**
* Content render function
*
* @param string $mainContent HTML for main
* @param string $detailContent HTML for detail
*
* @return string HTML all together
*/
public function mainDetail($mainContent, $detailContent = '') public function mainDetail($mainContent, $detailContent = '')
{ {
$detailCls = 'hidden'; $detailCls = 'hidden';

View File

@ -48,6 +48,8 @@ class Monitoring_ListController extends ActionController
*/ */
protected $backend; protected $backend;
/** /**
* Compact layout name
*
* Set to a string containing the compact layout name to use when * Set to a string containing the compact layout name to use when
* 'compact' is set as the layout parameter, otherwise null * 'compact' is set as the layout parameter, otherwise null
* *