class SensorConfig in Monitoring 8

Represents a sensor config entity class.

@todo more

Plugin annotation


@ConfigEntityType(
  id = "monitoring_sensor_config",
  label = @Translation("Monitoring Sensor"),
  handlers = {
    "access" = "Drupal\monitoring\SensorConfigAccessControlHandler",
    "list_builder" = "Drupal\monitoring\SensorListBuilder",
    "form" = {
      "add" = "Drupal\monitoring\Form\SensorForm",
      "delete" = "Drupal\monitoring\Form\SensorDeleteForm",
      "edit" = "Drupal\monitoring\Form\SensorForm",
      "details" = "Drupal\monitoring\Form\SensorDetailForm"
    }
  },
  admin_permission = "administer monitoring",
  config_prefix = "sensor_config",
  entity_keys = {
    "id" = "id",
    "label" = "label"
  },
  config_export = {
    "id",
    "label",
    "description",
    "category",
    "plugin_id",
    "result_class",
    "value_label",
    "value_type",
    "status",
    "caching_time",
    "settings",
    "thresholds",
  },
  links = {
    "delete-form" = "/admin/config/system/monitoring/sensors/{monitoring_sensor_config}/delete",
    "edit-form" = "/admin/config/system/monitoring/sensors/{monitoring_sensor_config}",
    "details-form" = "/admin/reports/monitoring/sensors/{monitoring_sensor_config}",
    "force-run-sensor" = "/monitoring/sensors/force/{monitoring_sensor_config}"
  }
)

Hierarchy

class \Drupal\Core\Entity\EntityBase implements EntityInterface uses RefinableCacheableDependencyTrait, DependencySerializationTrait
- class \Drupal\Core\Config\Entity\ConfigEntityBase implements ConfigEntityInterface uses SynchronizableEntityTrait, PluginDependencyTrait
  - class \Drupal\monitoring\Entity\SensorConfig implements SensorConfigInterface

Expanded class hierarchy of SensorConfig

37 files declare their use of SensorConfig

CommerceTurnoverSensorPlugin.php in src/Plugin/monitoring/SensorPlugin/CommerceTurnoverSensorPlugin.php
ContentEntityAggregatorSensorPlugin.php in src/Plugin/monitoring/SensorPlugin/ContentEntityAggregatorSensorPlugin.php: Contains \Drupal\monitoring\Plugin\monitoring\SensorPlugin\ContentEntityAggregatorSensorPlugin.
DatabaseDiskUsagePlugin.php in src/Plugin/monitoring/SensorPlugin/DatabaseDiskUsagePlugin.php
DiskUsageSensorPlugin.php in src/Plugin/monitoring/SensorPlugin/DiskUsageSensorPlugin.php
ForceRunController.php in src/Controller/ForceRunController.php

... See full list

File

src/Entity/SensorConfig.php, line 60: Contains \Drupal\monitoring\Entity\SensorConfig.

Namespace

Drupal\monitoring\Entity

View source

class SensorConfig extends ConfigEntityBase implements SensorConfigInterface {

  /**
   * The config id.
   *
   * @var string
   */
  public $id;

  /**
   * The sensor label.
   *
   * @var string
   */
  public $label;

  /**
   * The sensor description.
   *
   * @var string
   */
  public $description = '';

  /**
   * The sensor category.
   *
   * @var string
   */
  public $category = 'Other';

  /**
   * The sensor id.
   *
   * @var string
   */
  public $plugin_id;

  /**
   * The sensor result class.
   *
   * @var string
   */
  public $result_class;

  /**
   * The sensor settings.
   *
   * @var array
   */
  public $settings = array();

  /**
   * The sensor value label.
   *
   * @var string
   */
  public $value_label;

  /**
   * The sensor value type.
   *
   * @var string
   */
  public $value_type = 'number';

  /**
   * The sensor caching time.
   *
   * @var integer
   */
  public $caching_time;

  /**
   * The sensor enabled/disabled flag.
   *
   * @var bool
   */
  public $status = TRUE;

  /**
   * The sensor thresholds.
   *
   * @var array
   */
  public $thresholds = array(
    'type' => 'none',
  );

  /**
   * {@inheritdoc}
   */
  public function getLabel() {
    return $this->label;
  }

  /**
   * {@inheritdoc}
   */
  public function getDescription() {
    return $this->description;
  }

  /**
   * {@inheritdoc}
   */
  public function getSensorClass() {
    $definition = monitoring_sensor_manager()
      ->getDefinition($this->plugin_id);
    return $definition['class'];
  }

  /**
   * {@inheritdoc}
   */
  public function getPlugin() {
    $configuration = array(
      'sensor_config' => $this,
    );
    $plugin = monitoring_sensor_manager()
      ->createInstance($this->plugin_id, $configuration);
    return $plugin;
  }

  /**
   * {@inheritdoc}
   */
  public function getCategory() {
    return $this->category;
  }

  /**
   * {@inheritdoc}
   */
  public function getValueLabel() {
    if ($this->value_label) {
      return $this->value_label;
    }
    if ($this->value_type) {
      $value_types = monitoring_value_types();
      if (isset($value_types[$this->value_type]['value_label'])) {
        return $value_types[$this->value_type]['value_label'];
      }
    }
    return NULL;
  }

  /**
   * {@inheritdoc}
   */
  public function getValueType() {
    return $this->value_type;
  }

  /**
   * {@inheritdoc}
   */
  public function isNumeric() {
    $value_types = monitoring_value_types();
    if (empty($this->value_type)) {
      return FALSE;
    }
    return $value_types[$this->value_type]['numeric'];
  }

  /**
   * {@inheritdoc}
   */
  public function isBool() {
    return $this
      ->getValueType() == 'bool';
  }

  /**
   * {@inheritdoc}
   */
  public function getCachingTime() {
    return $this->caching_time;
  }

  /**
   * {@inheritdoc}
   */
  public function getThresholdsType() {
    if (!empty($this->thresholds['type'])) {
      return $this->thresholds['type'];
    }
    return 'none';
  }

  /**
   * {@inheritdoc}
   */
  public function getThresholdValue($key) {
    if (isset($this->thresholds[$key]) && $this->thresholds[$key] !== '') {
      return $this->thresholds[$key];
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getSettings() {
    return $this->settings;
  }

  /**
   * {@inheritdoc}
   */
  public function getThresholds() {
    return $this->thresholds;
  }

  /**
   * {@inheritdoc}
   */
  public function getTimeIntervalValue() {
    return $this
      ->getSetting('time_interval_value', NULL);
  }

  /**
   * {@inheritdoc}
   */
  public function getSetting($key, $default = NULL) {
    return isset($this->settings[$key]) ? $this->settings[$key] : $default;
  }

  /**
   * {@inheritdoc}
   */
  public function isEnabled() {
    return (bool) $this->status;
  }

  /**
   * {@inheritdoc}
   */
  public function isExtendedInfo() {
    return in_array('Drupal\\monitoring\\SensorPlugin\\ExtendedInfoSensorPluginInterface', class_implements($this
      ->getSensorClass()));
  }

  /**
   * {@inheritdoc}
   */
  public function isDefiningThresholds() {
    return $this
      ->isNumeric() && $this
      ->getThresholdsType() != 'none';
  }

  /**
   * {@inheritdoc}
   */
  public function getDefinition() {
    $config = array(
      'sensor' => $this
        ->id(),
      'label' => $this
        ->getLabel(),
      'category' => $this
        ->getCategory(),
      'description' => $this
        ->getDescription(),
      'numeric' => $this
        ->isNumeric(),
      'value_label' => $this
        ->getValueLabel(),
      'caching_time' => $this
        ->getCachingTime(),
      'time_interval' => $this
        ->getTimeIntervalValue(),
      'enabled' => $this
        ->isEnabled(),
    );
    if ($this
      ->isDefiningThresholds()) {
      $config['thresholds'] = $this
        ->getThresholds();
    }
    return $config;
  }

  /**
   * {@inheritdoc}
   */
  public static function sort(ConfigEntityInterface $a, ConfigEntityInterface $b) {

    /**
     * @var \Drupal\monitoring\Entity\SensorConfig $a
     * @var \Drupal\monitoring\Entity\SensorConfig $b
     */

    // Checks whether both labels and categories are equal.
    if ($a
      ->getLabel() == $b
      ->getLabel() && $a
      ->getCategory() == $b
      ->getCategory()) {
      return 0;
    }
    elseif ($a
      ->getCategory() != $b
      ->getCategory()) {
      return $a
        ->getCategory() < $b
        ->getCategory() ? -1 : 1;
    }

    // In the end, the label's order is determined.
    return $a
      ->getLabel() < $b
      ->getLabel() ? -1 : 1;
  }

  /**
   * {@inheritdoc}
   */
  public function calculateDependencies() {
    parent::calculateDependencies();

    // Include the module of the sensor plugin as dependency and also allow it
    // to add additional dependencies based on the configuration.
    $instance = $this
      ->getPlugin();
    $definition = $instance
      ->getPluginDefinition();
    $this
      ->addDependency('module', $definition['provider']);

    // If a plugin is configurable, calculate its dependencies.
    if ($plugin_dependencies = $instance
      ->calculateDependencies()) {
      $this
        ->addDependencies($plugin_dependencies);
    }
    return $this->dependencies;
  }

  /**
   * {@inheritdoc}
   */
  public function postSave(EntityStorageInterface $storage, $update = TRUE) {
    parent::postSave($storage, $update);
    \Drupal::service('monitoring.sensor_runner')
      ->resetCache(array(
      $this->id,
    ));
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CacheableDependencyTrait::$cacheContexts	protected	property	Cache contexts.
CacheableDependencyTrait::$cacheMaxAge	protected	property	Cache max-age.
CacheableDependencyTrait::$cacheTags	protected	property	Cache tags.
CacheableDependencyTrait::setCacheability	protected	function	Sets cacheability; useful for value object constructors.
ConfigEntityBase::$isUninstalling	private	property	Whether the config is being deleted by the uninstall process.
ConfigEntityBase::$langcode	protected	property	The language code of the entity's default language.
ConfigEntityBase::$originalId	protected	property	The original ID of the configuration entity.
ConfigEntityBase::$third_party_settings	protected	property	Third party entity settings.
ConfigEntityBase::$trustedData	protected	property	Trust supplied data and not use configuration schema on save.
ConfigEntityBase::$uuid	protected	property	The UUID for this entity.
ConfigEntityBase::$_core	protected	property	Information maintained by Drupal core about configuration.
ConfigEntityBase::addDependency	protected	function	Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
ConfigEntityBase::createDuplicate	public	function	Creates a duplicate of the entity. Overrides EntityBase::createDuplicate	1
ConfigEntityBase::disable	public	function	Disables the configuration entity. Overrides ConfigEntityInterface::disable	1
ConfigEntityBase::enable	public	function	Enables the configuration entity. Overrides ConfigEntityInterface::enable
ConfigEntityBase::get	public	function	Returns the value of a property. Overrides ConfigEntityInterface::get
ConfigEntityBase::getCacheTagsToInvalidate	public	function	Returns the cache tags that should be used to invalidate caches. Overrides EntityBase::getCacheTagsToInvalidate	1
ConfigEntityBase::getConfigDependencyName	public	function	Gets the configuration dependency name. Overrides EntityBase::getConfigDependencyName
ConfigEntityBase::getConfigManager	protected static	function	Gets the configuration manager.
ConfigEntityBase::getConfigTarget	public	function	Gets the configuration target identifier for the entity. Overrides EntityBase::getConfigTarget
ConfigEntityBase::getDependencies	public	function	Gets the configuration dependencies. Overrides ConfigEntityInterface::getDependencies
ConfigEntityBase::getOriginalId	public	function	Gets the original ID. Overrides EntityBase::getOriginalId
ConfigEntityBase::getThirdPartyProviders	public	function	Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
ConfigEntityBase::getThirdPartySetting	public	function	Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
ConfigEntityBase::getThirdPartySettings	public	function	Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
ConfigEntityBase::getTypedConfig	protected	function	Gets the typed config manager.
ConfigEntityBase::hasTrustedData	public	function	Gets whether on not the data is trusted. Overrides ConfigEntityInterface::hasTrustedData
ConfigEntityBase::invalidateTagsOnDelete	protected static	function	Override to never invalidate the individual entities' cache tags; the config system already invalidates them. Overrides EntityBase::invalidateTagsOnDelete
ConfigEntityBase::invalidateTagsOnSave	protected	function	Override to never invalidate the entity's cache tag; the config system already invalidates it. Overrides EntityBase::invalidateTagsOnSave
ConfigEntityBase::isInstallable	public	function	Checks whether this entity is installable. Overrides ConfigEntityInterface::isInstallable	2
ConfigEntityBase::isNew	public	function	Overrides Entity::isNew(). Overrides EntityBase::isNew
ConfigEntityBase::isUninstalling	public	function	Returns whether this entity is being changed during the uninstall process. Overrides ConfigEntityInterface::isUninstalling
ConfigEntityBase::link	public	function	Deprecated way of generating a link to the entity. See toLink(). Overrides EntityBase::link
ConfigEntityBase::onDependencyRemoval	public	function	Informs the entity that entities it depends on will be deleted. Overrides ConfigEntityInterface::onDependencyRemoval	7
ConfigEntityBase::preDelete	public static	function	Acts on entities before they are deleted and before hooks are invoked. Overrides EntityBase::preDelete	8
ConfigEntityBase::preSave	public	function	Acts on an entity before the presave hook is invoked. Overrides EntityBase::preSave	13
ConfigEntityBase::save	public	function	Saves an entity permanently. Overrides EntityBase::save	1
ConfigEntityBase::set	public	function	Sets the value of a property. Overrides ConfigEntityInterface::set
ConfigEntityBase::setOriginalId	public	function	Sets the original ID. Overrides EntityBase::setOriginalId
ConfigEntityBase::setStatus	public	function	Sets the status of the configuration entity. Overrides ConfigEntityInterface::setStatus
ConfigEntityBase::setThirdPartySetting	public	function	Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
ConfigEntityBase::setUninstalling	public	function
ConfigEntityBase::status	public	function	Returns whether the configuration entity is enabled. Overrides ConfigEntityInterface::status	4
ConfigEntityBase::toArray	public	function	Gets an array of all property values. Overrides EntityBase::toArray	2
ConfigEntityBase::toUrl	public	function	Gets the URL object for the entity. Overrides EntityBase::toUrl
ConfigEntityBase::trustData	public	function	Sets that the data should be trusted. Overrides ConfigEntityInterface::trustData
ConfigEntityBase::unsetThirdPartySetting	public	function	Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
ConfigEntityBase::url	public	function	Gets the public URL for this entity. Overrides EntityBase::url
ConfigEntityBase::urlInfo	public	function	Gets the URL object for the entity. Overrides EntityBase::urlInfo
ConfigEntityBase::__construct	public	function	Constructs an Entity object. Overrides EntityBase::__construct	10
ConfigEntityBase::__sleep	public	function	Overrides EntityBase::__sleep	4
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function	Aliased as: traitSleep	1
DependencySerializationTrait::__wakeup	public	function		2
DependencyTrait::$dependencies	protected	property	The object's dependencies.
DependencyTrait::addDependencies	protected	function	Adds multiple dependencies.
DependencyTrait::addDependency	protected	function	Adds a dependency. Aliased as: addDependencyTrait
EntityBase::$enforceIsNew	protected	property	Boolean indicating whether the entity should be forced to be new.
EntityBase::$entityTypeId	protected	property	The entity type.
EntityBase::$typedData	protected	property	A typed data object wrapping this entity.
EntityBase::access	public	function	Checks data value access. Overrides AccessibleInterface::access	1
EntityBase::bundle	public	function	Gets the bundle of the entity. Overrides EntityInterface::bundle	1
EntityBase::create	public static	function	Constructs a new entity object, without permanently saving it. Overrides EntityInterface::create
EntityBase::delete	public	function	Deletes an entity permanently. Overrides EntityInterface::delete	2
EntityBase::enforceIsNew	public	function	Enforces an entity to be new. Overrides EntityInterface::enforceIsNew
EntityBase::entityManager Deprecated	protected	function	Gets the entity manager.
EntityBase::entityTypeBundleInfo	protected	function	Gets the entity type bundle info service.
EntityBase::entityTypeManager	protected	function	Gets the entity type manager.
EntityBase::getCacheContexts	public	function	The cache contexts associated with this object. Overrides CacheableDependencyTrait::getCacheContexts
EntityBase::getCacheMaxAge	public	function	The maximum age for which this object may be cached. Overrides CacheableDependencyTrait::getCacheMaxAge
EntityBase::getCacheTags	public	function	The cache tags associated with this object. Overrides CacheableDependencyTrait::getCacheTags
EntityBase::getConfigDependencyKey	public	function	Gets the key that is used to store configuration dependencies. Overrides EntityInterface::getConfigDependencyKey
EntityBase::getEntityType	public	function	Gets the entity type definition. Overrides EntityInterface::getEntityType
EntityBase::getEntityTypeId	public	function	Gets the ID of the type of the entity. Overrides EntityInterface::getEntityTypeId
EntityBase::getListCacheTagsToInvalidate	protected	function	The list cache tags to invalidate for this entity.
EntityBase::getTypedData	public	function	Gets a typed data object for this entity object. Overrides EntityInterface::getTypedData
EntityBase::hasLinkTemplate	public	function	Indicates if a link template exists for a given key. Overrides EntityInterface::hasLinkTemplate
EntityBase::id	public	function	Gets the identifier. Overrides EntityInterface::id	11
EntityBase::label	public	function	Gets the label of the entity. Overrides EntityInterface::label	6
EntityBase::language	public	function	Gets the language of the entity. Overrides EntityInterface::language	1
EntityBase::languageManager	protected	function	Gets the language manager.
EntityBase::linkTemplates	protected	function	Gets an array link templates.	1
EntityBase::load	public static	function	Loads an entity. Overrides EntityInterface::load
EntityBase::loadMultiple	public static	function	Loads one or more entities. Overrides EntityInterface::loadMultiple
EntityBase::postCreate	public	function	Acts on a created entity before hooks are invoked. Overrides EntityInterface::postCreate	4
EntityBase::postDelete	public static	function	Acts on deleted entities before the delete hook is invoked. Overrides EntityInterface::postDelete	16
EntityBase::postLoad	public static	function	Acts on loaded entities. Overrides EntityInterface::postLoad	2
EntityBase::preCreate	public static	function	Changes the values of an entity before it is created. Overrides EntityInterface::preCreate	5
EntityBase::referencedEntities	public	function	Gets a list of entities referenced by this entity. Overrides EntityInterface::referencedEntities	1
EntityBase::toLink	public	function	Generates the HTML for a link to this entity. Overrides EntityInterface::toLink
EntityBase::uriRelationships	public	function	Gets a list of URI relationships supported by this entity. Overrides EntityInterface::uriRelationships
EntityBase::urlRouteParameters	protected	function	Gets an array of placeholders for this entity.	2
EntityBase::uuid	public	function	Gets the entity UUID (Universally Unique Identifier). Overrides EntityInterface::uuid	1
EntityBase::uuidGenerator	protected	function	Gets the UUID generator.
PluginDependencyTrait::calculatePluginDependencies	protected	function	Calculates and adds dependencies of a specific plugin instance.	1
PluginDependencyTrait::getPluginDependencies	protected	function	Calculates and returns dependencies of a specific plugin instance.
PluginDependencyTrait::moduleHandler	protected	function	Wraps the module handler.	1
PluginDependencyTrait::themeHandler	protected	function	Wraps the theme handler.	1
RefinableCacheableDependencyTrait::addCacheableDependency	public	function		1
RefinableCacheableDependencyTrait::addCacheContexts	public	function
RefinableCacheableDependencyTrait::addCacheTags	public	function
RefinableCacheableDependencyTrait::mergeCacheMaxAge	public	function
SensorConfig::$caching_time	public	property	The sensor caching time.
SensorConfig::$category	public	property	The sensor category.
SensorConfig::$description	public	property	The sensor description.
SensorConfig::$id	public	property	The config id.
SensorConfig::$label	public	property	The sensor label.
SensorConfig::$plugin_id	public	property	The sensor id.
SensorConfig::$result_class	public	property	The sensor result class.
SensorConfig::$settings	public	property	The sensor settings.
SensorConfig::$status	public	property	The sensor enabled/disabled flag. Overrides ConfigEntityBase::$status
SensorConfig::$thresholds	public	property	The sensor thresholds.
SensorConfig::$value_label	public	property	The sensor value label.
SensorConfig::$value_type	public	property	The sensor value type.
SensorConfig::calculateDependencies	public	function	Calculates dependencies and stores them in the dependency property. Overrides ConfigEntityBase::calculateDependencies
SensorConfig::getCachingTime	public	function	Gets sensor caching time. Overrides SensorConfigInterface::getCachingTime
SensorConfig::getCategory	public	function	Gets sensor categories. Overrides SensorConfigInterface::getCategory
SensorConfig::getDefinition	public	function	Compiles sensor values to an associative array. Overrides SensorConfigInterface::getDefinition
SensorConfig::getDescription	public	function	Gets sensor description. Overrides SensorConfigInterface::getDescription
SensorConfig::getLabel	public	function	Gets sensor label. Overrides SensorConfigInterface::getLabel
SensorConfig::getPlugin	public	function	Gets the sensor plugin. Overrides SensorConfigInterface::getPlugin
SensorConfig::getSensorClass	public	function	Gets sensor plugin class. Overrides SensorConfigInterface::getSensorClass
SensorConfig::getSetting	public	function	Gets the setting of a key. Overrides SensorConfigInterface::getSetting
SensorConfig::getSettings	public	function	Gets all settings. Overrides SensorConfigInterface::getSettings
SensorConfig::getThresholds	public	function	Gets thresholds. Overrides SensorConfigInterface::getThresholds
SensorConfig::getThresholdsType	public	function	Gets configured threshold type. Overrides SensorConfigInterface::getThresholdsType
SensorConfig::getThresholdValue	public	function	Gets the configured threshold value. Overrides SensorConfigInterface::getThresholdValue
SensorConfig::getTimeIntervalValue	public	function	Gets the time interval value. Overrides SensorConfigInterface::getTimeIntervalValue
SensorConfig::getValueLabel	public	function	Gets sensor value label. Overrides SensorConfigInterface::getValueLabel
SensorConfig::getValueType	public	function	Gets sensor value type. Overrides SensorConfigInterface::getValueType
SensorConfig::isBool	public	function	Determines if the sensor value type is boolean. Overrides SensorConfigInterface::isBool
SensorConfig::isDefiningThresholds	public	function	Checks if sensor defines thresholds. Overrides SensorConfigInterface::isDefiningThresholds
SensorConfig::isEnabled	public	function	Checks if sensor is enabled. Overrides SensorConfigInterface::isEnabled
SensorConfig::isExtendedInfo	public	function	Checks if sensor provides extended info. Overrides SensorConfigInterface::isExtendedInfo
SensorConfig::isNumeric	public	function	Determines if the sensor value is numeric. Overrides SensorConfigInterface::isNumeric
SensorConfig::postSave	public	function	Acts on a saved entity before the insert or update hook is invoked. Overrides EntityBase::postSave
SensorConfig::sort	public static	function	Helper callback for uasort() to sort configuration entities by weight and label. Overrides ConfigEntityBase::sort
SynchronizableEntityTrait::$isSyncing	protected	property	Whether this entity is being created, updated or deleted through a synchronization process.
SynchronizableEntityTrait::isSyncing	public	function
SynchronizableEntityTrait::setSyncing	public	function

You are here

class SensorConfig in Monitoring 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation