Phpdoc and small text fixes

refs #4524
This commit is contained in:
Jannis Moßhammer 2013-08-16 17:38:00 +02:00
parent a45409c5f3
commit f081531585
6 changed files with 36 additions and 6 deletions

View File

@ -73,7 +73,7 @@ class AcknowledgeForm extends CommandForm
array( array(
'name' => 'commentnote', 'name' => 'commentnote',
'value' => t( 'value' => t(
' If you work with other administrators, you may find it useful to share information ' ' If you work with other administrators you may find it useful to share information '
. 'about a host or service that is having problems if more than one of you may be working on ' . 'about a host or service that is having problems if more than one of you may be working on '
. 'it. Make sure you enter a brief description of what you are doing.' . 'it. Make sure you enter a brief description of what you are doing.'
) )
@ -94,7 +94,7 @@ class AcknowledgeForm extends CommandForm
array( array(
'name' => 'persistentnote', 'name' => 'persistentnote',
'value' => t( 'value' => t(
'If you would like the comment to remain once the acknowledgement is removed, ' 'If you would like the comment to remain even when the acknowledgement is removed, '
. 'check this option.' . 'check this option.'
) )
) )
@ -133,8 +133,8 @@ class AcknowledgeForm extends CommandForm
array( array(
'name' => 'expiretimenote', 'name' => 'expiretimenote',
'value' => t( 'value' => t(
'Enter here the expire date/time for this acknowledgement. Icinga will ' 'Enter the expire date/time for this acknowledgement here. Icinga will '
. ' delete the acknowledgement after this time expired.' . ' delete the acknowledgement after this date expired.'
) )
) )
) )
@ -174,7 +174,7 @@ class AcknowledgeForm extends CommandForm
array( array(
'name' => 'sendnotificationnote', 'name' => 'sendnotificationnote',
'value' => t( 'value' => t(
'If you do not want an acknowledgement notification sent out to the appropriate ' 'If you do not want an acknowledgement notification to be sent out to the appropriate '
. 'contacts, uncheck this option.' . 'contacts, uncheck this option.'
) )
) )

View File

@ -37,6 +37,7 @@ class CommandWithIdentifierForm extends CommandForm
{ {
/** /**
* Identifier for data field * Identifier for data field
*
* @var string * @var string
*/ */
private $fieldName = 'objectid'; private $fieldName = 'objectid';
@ -52,6 +53,7 @@ class CommandWithIdentifierForm extends CommandForm
/** /**
* Setter for field label * Setter for field label
*
* @param string $fieldLabel * @param string $fieldLabel
*/ */
public function setFieldLabel($fieldLabel) public function setFieldLabel($fieldLabel)
@ -61,6 +63,7 @@ class CommandWithIdentifierForm extends CommandForm
/** /**
* Getter for field label * Getter for field label
*
* @return string * @return string
*/ */
public function getFieldLabel() public function getFieldLabel()
@ -70,6 +73,7 @@ class CommandWithIdentifierForm extends CommandForm
/** /**
* Setter for field name * Setter for field name
*
* @param string $fieldName * @param string $fieldName
*/ */
public function setFieldName($fieldName) public function setFieldName($fieldName)
@ -79,6 +83,7 @@ class CommandWithIdentifierForm extends CommandForm
/** /**
* Getter for field name * Getter for field name
*
* @return string * @return string
*/ */
public function getFieldName() public function getFieldName()

View File

@ -91,7 +91,7 @@ class CustomNotificationForm extends CommandForm
'name' => 'forcenote', 'name' => 'forcenote',
'value' => t( 'value' => t(
'Custom notifications normally follow the regular notification logic in Icinga. Selecting this ' 'Custom notifications normally follow the regular notification logic in Icinga. Selecting this '
. 'option will force the notification to be sent out, regardless of the time restrictions, ' . 'option will force the notification to be sent out, regardless of time restrictions, '
. 'whether or not notifications are enabled, etc.' . 'whether or not notifications are enabled, etc.'
) )
) )

View File

@ -85,6 +85,11 @@ class DelayNotificationForm extends CommandForm
parent::create(); parent::create();
} }
/**
* Return the currently set delay time in seconds
*
* @return integer
*/
public function getDelayTime() public function getDelayTime()
{ {
return $this->getValue('minutes') * 60; return $this->getValue('minutes') * 60;

View File

@ -108,6 +108,11 @@ class RescheduleNextCheckForm extends WithChildrenCommandForm
parent::create(); parent::create();
} }
/**
* Return whether this is a forced check (force is checked)
*
* @return bool
*/
public function isForced() public function isForced()
{ {
return $this->getValue('forcecheck') == true; return $this->getValue('forcecheck') == true;

View File

@ -209,16 +209,31 @@ class SubmitPassiveCheckResultForm extends CommandForm
parent::create(); parent::create();
} }
/**
* Return the entered object state as an integer
*
* @return int
*/
public function getState() public function getState()
{ {
return intval($this->getValue('pluginstate')); return intval($this->getValue('pluginstate'));
} }
/**
* Return the entered check output as a string
*
* @return string
*/
public function getOutput() public function getOutput()
{ {
return $this->getValue('checkoutput'); return $this->getValue('checkoutput');
} }
/**
* Return the entered performance data as a string
*
* @return string
*/
public function getPerformancedata() public function getPerformancedata()
{ {
return $this->getValue('performancedata'); return $this->getValue('performancedata');