abstract class SensorThresholds in Monitoring 7

Abstract class providing configuration form for Sensor with thresholds.

Sensors may provide thresholds that apply by default. Threshold values are validated for sequence.

Hierarchy

• class \Drupal\monitoring\Sensor\Sensor implements SensorInterface
  • class \Drupal\monitoring\Sensor\SensorConfigurable implements SensorConfigurableInterface
    • class \Drupal\monitoring\Sensor\SensorThresholds implements SensorThresholdsInterface

7 files declare their use of SensorThresholds

SensorCronLastRunAge.php in lib/Drupal/monitoring/Sensor/Sensors/SensorCronLastRunAge.php

Contains \Drupal\monitoring\Sensor\Sensors\SensorCronLastRunAge.

SensorDatabaseAggregator.php in lib/Drupal/monitoring/Sensor/Sensors/SensorDatabaseAggregator.php

Contains \Drupal\monitoring\Sensor\Sensors\SensorDatabaseAggregator.

SensorElysiaCron.php in lib/Drupal/monitoring/Sensor/Sensors/SensorElysiaCron.php

Contains \Drupal\monitoring\Sensor\Sensors\SensorElysiaCron.

SensorQueue.php in lib/Drupal/monitoring/Sensor/Sensors/SensorQueue.php

Contains \Drupal\monitoring\Sensor\Sensors\SensorQueue.

SensorSearchApi.php in lib/Drupal/monitoring/Sensor/Sensors/SensorSearchApi.php

Contains \Drupal\monitoring\Sensor\Sensors\SensorSearchApi.

... See full list

File

lib/Drupal/monitoring/Sensor/SensorThresholds.php, line 15

Contains \Drupal\monitoring\Sensor\SensorThresholds.

Namespace

Drupal\monitoring\Sensor

abstract class SensorThresholds extends SensorConfigurable implements SensorThresholdsInterface {

  /**
   * {@inheritdoc}
   */
  public function settingsForm($form, &$form_state) {
    $form = parent::settingsForm($form, $form_state);
    $form['thresholds'] = array(
      '#type' => 'fieldset',
      '#title' => t('Sensor thresholds'),
      '#description' => t('Here you can set limit values that switch the sensor to a given status.'),
      '#prefix' => '<div id="monitoring-sensor-thresholds">',
      '#suffix' => '</div>',
    );
    if (isset($form_state['values'][monitoring_sensor_settings_key($this
      ->getSensorName())]['thresholds']['type'])) {
      $type = $form_state['values'][monitoring_sensor_settings_key($this
        ->getSensorName())]['thresholds']['type'];
    }
    else {
      $type = $this->info
        ->getThresholdsType();
    }
    $form['thresholds']['type'] = array(
      '#type' => 'select',
      '#title' => t('Threshold type'),
      '#options' => array(
        'exceeds' => t('Exceeds'),
        'falls' => t('Falls'),
        'inner_interval' => t('Inner interval'),
        'outer_interval' => t('Outer interval'),
      ),
      '#default_value' => $type,
      '#ajax' => array(
        'callback' => 'monitoring_sensor_thresholds_ajax',
        'wrapper' => 'monitoring-sensor-thresholds',
      ),
    );
    switch ($type) {
      case 'exceeds':
        $form['thresholds']['#description'] = t('The sensor will be set to the corresponding status if the value exceeds the limits.');
        $form['thresholds']['warning'] = array(
          '#type' => 'textfield',
          '#title' => t('Warning'),
          '#default_value' => $this->info
            ->getThresholdValue('warning'),
          '#element_validate' => array(
            'element_validate_number',
          ),
        );
        $form['thresholds']['critical'] = array(
          '#type' => 'textfield',
          '#title' => t('Critical'),
          '#default_value' => $this->info
            ->getThresholdValue('critical'),
          '#element_validate' => array(
            'element_validate_number',
          ),
        );
        break;
      case 'falls':
        $form['thresholds']['#description'] = t('The sensor will be set to the corresponding status if the value falls below the limits.');
        $form['thresholds']['warning'] = array(
          '#type' => 'textfield',
          '#title' => t('Warning'),
          '#default_value' => $this->info
            ->getThresholdValue('warning'),
          '#element_validate' => array(
            'element_validate_number',
          ),
        );
        $form['thresholds']['critical'] = array(
          '#type' => 'textfield',
          '#title' => t('Critical'),
          '#default_value' => $this->info
            ->getThresholdValue('critical'),
          '#element_validate' => array(
            'element_validate_number',
          ),
        );
        break;
      case 'inner_interval':
        $form['thresholds']['#description'] = t('The sensor will be set to the corresponding status if the value is within the limits.');
        $form['thresholds']['warning_low'] = array(
          '#type' => 'textfield',
          '#title' => t('Warning low'),
          '#default_value' => $this->info
            ->getThresholdValue('warning_low'),
          '#element_validate' => array(
            'element_validate_number',
          ),
        );
        $form['thresholds']['warning_high'] = array(
          '#type' => 'textfield',
          '#title' => t('Warning high'),
          '#default_value' => $this->info
            ->getThresholdValue('warning_high'),
          '#element_validate' => array(
            'element_validate_number',
          ),
        );
        $form['thresholds']['critical_low'] = array(
          '#type' => 'textfield',
          '#title' => t('Critical low'),
          '#default_value' => $this->info
            ->getThresholdValue('critical_low'),
          '#element_validate' => array(
            'element_validate_number',
          ),
        );
        $form['thresholds']['critical_high'] = array(
          '#type' => 'textfield',
          '#title' => t('Critical high'),
          '#default_value' => $this->info
            ->getThresholdValue('critical_high'),
          '#element_validate' => array(
            'element_validate_number',
          ),
        );
        break;
      case 'outer_interval':
        $form['thresholds']['#description'] = t('The sensor will be set to the corresponding status if the value is outside of the limits.');
        $form['thresholds']['warning_low'] = array(
          '#type' => 'textfield',
          '#title' => t('Warning low'),
          '#default_value' => $this->info
            ->getThresholdValue('warning_low'),
          '#element_validate' => array(
            'element_validate_number',
          ),
        );
        $form['thresholds']['warning_high'] = array(
          '#type' => 'textfield',
          '#title' => t('Warning high'),
          '#default_value' => $this->info
            ->getThresholdValue('warning_high'),
          '#element_validate' => array(
            'element_validate_number',
          ),
        );
        $form['thresholds']['critical_low'] = array(
          '#type' => 'textfield',
          '#title' => t('Critical low'),
          '#default_value' => $this->info
            ->getThresholdValue('critical_low'),
          '#element_validate' => array(
            'element_validate_number',
          ),
        );
        $form['thresholds']['critical_high'] = array(
          '#type' => 'textfield',
          '#title' => t('Critical high'),
          '#default_value' => $this->info
            ->getThresholdValue('critical_high'),
          '#element_validate' => array(
            'element_validate_number',
          ),
        );
        break;
    }
    return $form;
  }

  /**
   * Sets a form error for the given threshold key.
   *
   * @param string $threshold_key
   *   Key of the treshold value form element.
   * @param string $message
   *   The validation message.
   */
  protected function setFormError($threshold_key, $message) {
    $form_key = monitoring_sensor_settings_key($this->info
      ->getName());
    form_set_error($form_key . '][thresholds][' . $threshold_key, $message);
  }

  /**
   * {@inheritdoc}
   */
  public function settingsFormValidate($form, &$form_state) {
    $form_key = monitoring_sensor_settings_key($this->info
      ->getName());
    $values = $form_state['values'][$form_key]['thresholds'];
    $type = $values['type'];
    switch ($type) {
      case 'exceeds':
        if (!empty($values['warning']) && !empty($values['critical']) && $values['warning'] >= $values['critical']) {
          $this
            ->setFormError('warning', t('Warning must be lower than critical or empty.'));
        }
        break;
      case 'falls':
        if (!empty($values['warning']) && !empty($values['critical']) && $values['warning'] <= $values['critical']) {
          $this
            ->setFormError('warning', t('Warning must be higher than critical or empty.'));
        }
        break;
      case 'inner_interval':
        if (empty($values['warning_low']) && !empty($values['warning_high']) || !empty($values['warning_low']) && empty($values['warning_high'])) {
          $this
            ->setFormError('warning_low', t('Either both warning values must be provided or none.'));
        }
        elseif (empty($values['critical_low']) && !empty($values['critical_high']) || !empty($values['critical_low']) && empty($values['critical_high'])) {
          $this
            ->setFormError('critical_low', t('Either both critical values must be provided or none.'));
        }
        elseif (!empty($values['warning_low']) && !empty($values['warning_high']) && $values['warning_low'] >= $values['warning_high']) {
          $this
            ->setFormError('warning_low', t('Warning low must be lower than warning high or empty.'));
        }
        elseif (!empty($values['critical_low']) && !empty($values['critical_high']) && $values['critical_low'] >= $values['critical_high']) {
          $this
            ->setFormError('warning_low', t('Critical low must be lower than critical high or empty.'));
        }
        elseif (!empty($values['warning_low']) && !empty($values['critical_low']) && $values['warning_low'] >= $values['critical_low']) {
          $this
            ->setFormError('warning_low', t('Warning low must be lower than critical low or empty.'));
        }
        elseif (!empty($values['warning_high']) && !empty($values['critical_high']) && $values['warning_high'] <= $values['critical_high']) {
          $this
            ->setFormError('warning_high', t('Warning high must be higher than critical high or empty.'));
        }
        break;
      case 'outer_interval':
        if (empty($values['warning_low']) && !empty($values['warning_high']) || !empty($values['warning_low']) && empty($values['warning_high'])) {
          $this
            ->setFormError('warning_low', t('Either both warning values must be provided or none.'));
        }
        elseif (empty($values['critical_low']) && !empty($values['critical_high']) || !empty($values['critical_low']) && empty($values['critical_high'])) {
          $this
            ->setFormError('critical_low', t('Either both critical values must be provided or none.'));
        }
        elseif (!empty($values['warning_low']) && !empty($values['warning_high']) && $values['warning_low'] >= $values['warning_high']) {
          $this
            ->setFormError('warning_low', t('Warning low must be lower than warning high or empty.'));
        }
        elseif (!empty($values['critical_low']) && !empty($values['critical_high']) && $values['critical_low'] >= $values['critical_high']) {
          $this
            ->setFormError('warning_low', t('Critical low must be lower than critical high or empty.'));
        }
        elseif (!empty($values['warning_low']) && !empty($values['critical_low']) && $values['warning_low'] <= $values['critical_low']) {
          $this
            ->setFormError('warning_low', t('Warning low must be higher than critical low or empty.'));
        }
        elseif (!empty($values['warning_high']) && !empty($values['critical_high']) && $values['warning_high'] >= $values['critical_high']) {
          $this
            ->setFormError('warning_high', t('Warning high must be lower than critical high or empty.'));
        }
        break;
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Sensor::$info	protected	property	Current sensor info object.
Sensor::getSensorName	public	function	Gets sensor name (not the label). Overrides SensorInterface::getSensorName
Sensor::isEnabled	public	function	Determines if sensor is enabled. Overrides SensorInterface::isEnabled
Sensor::__construct		function	Instantiates a sensor object.	1
SensorInterface::runSensor		function	Runs the sensor, updating $sensor_result.	13
SensorThresholds::setFormError	protected	function	Sets a form error for the given threshold key.
SensorThresholds::settingsForm	public	function	Gets settings form for a specific sensor. Overrides SensorConfigurable::settingsForm	1
SensorThresholds::settingsFormValidate	public	function	Form validator for a sensor settings form. Overrides SensorConfigurable::settingsFormValidate