interface SensorConfigInterface in Monitoring 8

Hierarchy

interface \Drupal\Core\Entity\EntityInterface; interface \Drupal\Core\Config\Entity\ThirdPartySettingsInterface; interface \Drupal\Core\Entity\SynchronizableInterface
- interface \Drupal\Core\Config\Entity\ConfigEntityInterface
  - interface \Drupal\monitoring\SensorConfigInterface

Expanded class hierarchy of SensorConfigInterface

All classes that implement SensorConfigInterface

4 files declare their use of SensorConfigInterface

SensorConfig.php in src/Entity/SensorConfig.php: Contains \Drupal\monitoring\Entity\SensorConfig.
SensorDetailForm.php in src/Form/SensorDetailForm.php: Contains \Drupal\monitoring\Form\SensorDetailForm.
SensorForm.php in src/Form/SensorForm.php: Contains \Drupal\monitoring\Form\SensorForm.
TemporaryFilesController.php in src/Controller/TemporaryFilesController.php

File

src/SensorConfigInterface.php, line 12: Contains \Drupal\monitoring\SensorConfigInterface.

Namespace

Drupal\monitoring

View source

interface SensorConfigInterface extends ConfigEntityInterface {

  /**
   * Gets sensor label.
   *
   * The sensor label might not be self-explaining enough or unique without
   * the category, the category should always be present when the label is
   * displayed.
   *
   * @return string
   *   Sensor label.
   */
  public function getLabel();

  /**
   * Gets sensor description.
   *
   * @return string
   *   Sensor description.
   */
  public function getDescription();

  /**
   * Gets sensor plugin class.
   *
   * @return string
   *   SensorPlugin class
   */
  public function getSensorClass();

  /**
   * Gets the sensor plugin.
   *
   * @return \Drupal\monitoring\SensorPlugin\SensorPluginInterface
   *   Instantiated sensor.
   */
  public function getPlugin();

  /**
   * Gets sensor categories.
   *
   * @return string
   *   Categories.
   */
  public function getCategory();

  /**
   * Gets sensor value label.
   *
   * In case the sensor defined a value_label, it will use it as label.
   *
   * Next if the sensor defines a value_type, it will use the label provided for
   * that type by monitoring_value_types().
   *
   * If nothing is defined, it returns NULL.
   *
   * @return string|null
   *   Sensor value label.
   */
  public function getValueLabel();

  /**
   * Gets sensor value type.
   *
   * @return string|null
   *   Sensor value type.
   *
   * @see \monitoring_value_types().
   */
  public function getValueType();

  /**
   * Determines if the sensor value is numeric.
   *
   * @return bool
   *   TRUE if the sensor value is numeric.
   */
  public function isNumeric();

  /**
   * Determines if the sensor value type is boolean.
   *
   * @return bool
   *   TRUE if the sensor value type is boolean.
   */
  public function isBool();

  /**
   * Gets sensor caching time.
   *
   * @return int
   *   Caching time in seconds.
   */
  public function getCachingTime();

  /**
   * Gets configured threshold type.
   *
   * Defaults to none.
   *
   * @return string|null
   *   Threshold type.
   */
  public function getThresholdsType();

  /**
   * Gets the configured threshold value.
   *
   * @param string $key
   *   Name of the threshold, for example warning or critical.
   *
   * @return int|null
   *   The threshold value or NULL if not configured.
   */
  public function getThresholdValue($key);

  /**
   * Gets all settings.
   *
   * @return array
   *   Settings as an array.
   */
  public function getSettings();

  /**
   * Gets thresholds.
   *
   * @return array
   *   Thresholds as an array.
   */
  public function getThresholds();

  /**
   * Gets the time interval value.
   *
   * @return int
   *   Number of seconds of the time interval.
   *   NULL in case the sensor does not define the time interval.
   */
  public function getTimeIntervalValue();

  /**
   * Gets the setting of a key.
   *
   * @param string $key
   *   Setting key.
   * @param mixed $default
   *   Default value if the setting does not exist.
   *
   * @return mixed
   *   Setting value.
   */
  public function getSetting($key, $default = NULL);

  /**
   * Checks if sensor is enabled.
   *
   * @return bool
   */
  public function isEnabled();

  /**
   * Checks if sensor provides extended info.
   *
   * @return bool
   */
  public function isExtendedInfo();

  /**
   * Checks if sensor defines thresholds.
   *
   * @return bool
   */
  public function isDefiningThresholds();

  /**
   * Compiles sensor values to an associative array.
   *
   * @return array
   *   Sensor config associative array.
   */
  public function getDefinition();

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

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

  /**
   * {@inheritdoc}
   */
  public function postSave(EntityStorageInterface $storage, $update = TRUE);

}

Members

Name	Modifiers	Type	Description	Overrides
AccessibleInterface::access	public	function	Checks data value access.	9
CacheableDependencyInterface::getCacheContexts	public	function	The cache contexts associated with this object.	34
CacheableDependencyInterface::getCacheMaxAge	public	function	The maximum age for which this object may be cached.	34
CacheableDependencyInterface::getCacheTags	public	function	The cache tags associated with this object.	27
ConfigEntityInterface::disable	public	function	Disables the configuration entity.	2
ConfigEntityInterface::enable	public	function	Enables the configuration entity.	2
ConfigEntityInterface::get	public	function	Returns the value of a property.	2
ConfigEntityInterface::getDependencies	public	function	Gets the configuration dependencies.	2
ConfigEntityInterface::hasTrustedData	public	function	Gets whether on not the data is trusted.	2
ConfigEntityInterface::isInstallable	public	function	Checks whether this entity is installable.	2
ConfigEntityInterface::isUninstalling	public	function	Returns whether this entity is being changed during the uninstall process.	2
ConfigEntityInterface::onDependencyRemoval	public	function	Informs the entity that entities it depends on will be deleted.	2
ConfigEntityInterface::set	public	function	Sets the value of a property.	2
ConfigEntityInterface::setStatus	public	function	Sets the status of the configuration entity.	2
ConfigEntityInterface::status	public	function	Returns whether the configuration entity is enabled.	2
ConfigEntityInterface::trustData	public	function	Sets that the data should be trusted.	2
EntityInterface::bundle	public	function	Gets the bundle of the entity.	2
EntityInterface::create	public static	function	Constructs a new entity object, without permanently saving it.	2
EntityInterface::createDuplicate	public	function	Creates a duplicate of the entity.	2
EntityInterface::delete	public	function	Deletes an entity permanently.	2
EntityInterface::enforceIsNew	public	function	Enforces an entity to be new.	2
EntityInterface::getCacheTagsToInvalidate	public	function	Returns the cache tags that should be used to invalidate caches.	2
EntityInterface::getConfigDependencyKey	public	function	Gets the key that is used to store configuration dependencies.	2
EntityInterface::getConfigDependencyName	public	function	Gets the configuration dependency name.	2
EntityInterface::getConfigTarget	public	function	Gets the configuration target identifier for the entity.	2
EntityInterface::getEntityType	public	function	Gets the entity type definition.	2
EntityInterface::getEntityTypeId	public	function	Gets the ID of the type of the entity.	2
EntityInterface::getOriginalId	public	function	Gets the original ID.	2
EntityInterface::getTypedData	public	function	Gets a typed data object for this entity object.	2
EntityInterface::hasLinkTemplate	public	function	Indicates if a link template exists for a given key.	2
EntityInterface::id	public	function	Gets the identifier.	2
EntityInterface::isNew	public	function	Determines whether the entity is new.	2
EntityInterface::label	public	function	Gets the label of the entity.	2
EntityInterface::language	public	function	Gets the language of the entity.	2
EntityInterface::link Deprecated	public	function	Deprecated way of generating a link to the entity. See toLink().	2
EntityInterface::load	public static	function	Loads an entity.	2
EntityInterface::loadMultiple	public static	function	Loads one or more entities.	2
EntityInterface::postCreate	public	function	Acts on a created entity before hooks are invoked.	2
EntityInterface::postDelete	public static	function	Acts on deleted entities before the delete hook is invoked.	2
EntityInterface::postLoad	public static	function	Acts on loaded entities.	3
EntityInterface::preCreate	public static	function	Changes the values of an entity before it is created.	2
EntityInterface::preDelete	public static	function	Acts on entities before they are deleted and before hooks are invoked.	2
EntityInterface::preSave	public	function	Acts on an entity before the presave hook is invoked.	2
EntityInterface::referencedEntities	public	function	Gets a list of entities referenced by this entity.	2
EntityInterface::save	public	function	Saves an entity permanently.	2
EntityInterface::setOriginalId	public	function	Sets the original ID.	2
EntityInterface::toArray	public	function	Gets an array of all property values.	3
EntityInterface::toLink	public	function	Generates the HTML for a link to this entity.	2
EntityInterface::toUrl	public	function	Gets the URL object for the entity.	2
EntityInterface::uriRelationships	public	function	Gets a list of URI relationships supported by this entity.	2
EntityInterface::url Deprecated	public	function	Gets the public URL for this entity.	2
EntityInterface::urlInfo Deprecated	public	function	Gets the URL object for the entity.	2
EntityInterface::uuid	public	function	Gets the entity UUID (Universally Unique Identifier).	2
RefinableCacheableDependencyInterface::addCacheableDependency	public	function	Adds a dependency on an object: merges its cacheability metadata.	1
RefinableCacheableDependencyInterface::addCacheContexts	public	function	Adds cache contexts.	1
RefinableCacheableDependencyInterface::addCacheTags	public	function	Adds cache tags.	1
RefinableCacheableDependencyInterface::mergeCacheMaxAge	public	function	Merges the maximum age (in seconds) with the existing maximum age.	1
SensorConfigInterface::calculateDependencies	public	function	Calculates dependencies and stores them in the dependency property. Overrides ConfigEntityInterface::calculateDependencies
SensorConfigInterface::getCachingTime	public	function	Gets sensor caching time.	1
SensorConfigInterface::getCategory	public	function	Gets sensor categories.	1
SensorConfigInterface::getDefinition	public	function	Compiles sensor values to an associative array.	1
SensorConfigInterface::getDescription	public	function	Gets sensor description.	1
SensorConfigInterface::getLabel	public	function	Gets sensor label.	1
SensorConfigInterface::getPlugin	public	function	Gets the sensor plugin.	1
SensorConfigInterface::getSensorClass	public	function	Gets sensor plugin class.	1
SensorConfigInterface::getSetting	public	function	Gets the setting of a key.	1
SensorConfigInterface::getSettings	public	function	Gets all settings.	1
SensorConfigInterface::getThresholds	public	function	Gets thresholds.	1
SensorConfigInterface::getThresholdsType	public	function	Gets configured threshold type.	1
SensorConfigInterface::getThresholdValue	public	function	Gets the configured threshold value.	1
SensorConfigInterface::getTimeIntervalValue	public	function	Gets the time interval value.	1
SensorConfigInterface::getValueLabel	public	function	Gets sensor value label.	1
SensorConfigInterface::getValueType	public	function	Gets sensor value type.	1
SensorConfigInterface::isBool	public	function	Determines if the sensor value type is boolean.	1
SensorConfigInterface::isDefiningThresholds	public	function	Checks if sensor defines thresholds.	1
SensorConfigInterface::isEnabled	public	function	Checks if sensor is enabled.	1
SensorConfigInterface::isExtendedInfo	public	function	Checks if sensor provides extended info.	1
SensorConfigInterface::isNumeric	public	function	Determines if the sensor value is numeric.	1
SensorConfigInterface::postSave	public	function	Acts on a saved entity before the insert or update hook is invoked. Overrides EntityInterface::postSave
SensorConfigInterface::sort	public static	function
SynchronizableInterface::isSyncing	public	function	Returns whether this entity is being changed as part of a synchronization.	1
SynchronizableInterface::setSyncing	public	function	Sets the status of the synchronization flag.	1
ThirdPartySettingsInterface::getThirdPartyProviders	public	function	Gets the list of third parties that store information.	5
ThirdPartySettingsInterface::getThirdPartySetting	public	function	Gets the value of a third-party setting.	5
ThirdPartySettingsInterface::getThirdPartySettings	public	function	Gets all third-party settings of a given module.	5
ThirdPartySettingsInterface::setThirdPartySetting	public	function	Sets the value of a third-party setting.	5
ThirdPartySettingsInterface::unsetThirdPartySetting	public	function	Unsets a third-party setting.	5

You are here

interface SensorConfigInterface in Monitoring 8

Hierarchy

File

Namespace

Members

API Navigation