class MonitoringSensorConfigResource in Monitoring 8

Provides a resource for monitoring sensors.

Plugin annotation


@RestResource(
  id = "monitoring-sensor",
  label = @Translation("Monitoring sensor config")
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\rest\Plugin\ResourceBase implements ContainerFactoryPluginInterface, ResourceInterface
    class \Drupal\monitoring\Plugin\rest\resource\MonitoringSensorConfigResource

Expanded class hierarchy of MonitoringSensorConfigResource

File

src/Plugin/rest/resource/MonitoringSensorConfigResource.php, line 29: Definition of Drupal\monitoring\Plugin\rest\resource\MonitoringSensorResource.

Namespace

Drupal\monitoring\Plugin\rest\resource

View source

class MonitoringSensorConfigResource extends ResourceBase {

  /**
   * The sensor manager.
   *
   * @var \Drupal\monitoring\Sensor\SensorManager
   */
  protected $sensorManager;
  public function __construct(array $configuration, $plugin_id, array $plugin_definition, array $serializer_formats, SensorManager $sensor_manager, LoggerInterface $logger) {
    parent::__construct($configuration, $plugin_id, $plugin_definition, $serializer_formats, $logger);
    $this->sensorManager = $sensor_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->getParameter('serializer.formats'), $container
      ->get('monitoring.sensor_manager'), $container
      ->get('logger.factory')
      ->get('rest'));
  }

  /**
   * {@inheritdoc}
   */
  public function routes() {
    $path_prefix = strtr($this->pluginId, ':', '/');
    $route_name = strtr($this->pluginId, ':', '.');
    $collection = parent::routes();
    $route = new Route("/{$path_prefix}", array(
      '_controller' => 'Drupal\\rest\\RequestHandler::handle',
      // Pass the resource plugin ID along as default property.
      '_plugin' => $this->pluginId,
    ), array(
      '_permission' => "restful get {$this->pluginId}",
    ));
    $route
      ->setMethods([
      'GET',
    ]);
    foreach ($this->serializerFormats as $format_name) {

      // Expose one route per available format.
      $format_route = clone $route;
      $format_route
        ->addRequirements(array(
        '_format' => $format_name,
      ));
      $collection
        ->add("{$route_name}.list.{$format_name}", $format_route);
    }
    return $collection;
  }

  /**
   * Responds to sensor INFO GET requests.
   *
   * @param string $id
   *   (optional) The sensor name, returns a list of all sensors when empty.
   *
   * @return \Drupal\rest\ResourceResponse
   *   The response containing the sensor config.
   *
   * @throws \Symfony\Component\HttpKernel\Exception\HttpException
   */
  public function get($id = NULL) {
    $format = \Drupal::request()
      ->getRequestFormat('ĵson');
    if ($id) {
      try {
        $sensor_config = $this->sensorManager
          ->getSensorConfigByName($id);
      } catch (NonExistingSensorException $e) {
        throw new NotFoundHttpException($e
          ->getMessage(), $e);
      }
      $response = $sensor_config
        ->getDefinition();
      $url = Url::fromRoute('rest.monitoring-sensor.GET', [
        'id' => $id,
        '_format' => $format,
      ])
        ->setAbsolute()
        ->toString(TRUE);
      $response['uri'] = $url
        ->getGeneratedUrl();
      $response = new ResourceResponse($response);
      $response
        ->addCacheableDependency($url);
      $response
        ->addCacheableDependency($sensor_config);
      return $response;
    }
    $list = array();
    $cacheable_metadata = new CacheableMetadata();
    foreach ($this->sensorManager
      ->getAllSensorConfig() as $id => $sensor_config) {
      $list[$id] = $sensor_config
        ->getDefinition();
      $url = Url::fromRoute('rest.monitoring-sensor.GET', [
        'id' => $id,
        '_format' => $format,
      ])
        ->setAbsolute()
        ->toString(TRUE);
      $list[$id]['uri'] = $url
        ->getGeneratedUrl();
      $cacheable_metadata = $cacheable_metadata
        ->merge($url);
      $cacheable_metadata = $cacheable_metadata
        ->merge(CacheableMetadata::createFromObject($sensor_config));
    }
    $response = new ResourceResponse($list);
    $response
      ->addCacheableDependency($cacheable_metadata);
    return $response;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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		1
DependencySerializationTrait::__wakeup	public	function		2
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
MonitoringSensorConfigResource::$sensorManager	protected	property	The sensor manager.
MonitoringSensorConfigResource::create	public static	function	Creates an instance of the plugin. Overrides ResourceBase::create
MonitoringSensorConfigResource::get	public	function	Responds to sensor INFO GET requests.
MonitoringSensorConfigResource::routes	public	function	Returns a collection of routes with URL path information for the resource. Overrides ResourceBase::routes
MonitoringSensorConfigResource::__construct	public	function	Constructs a Drupal\rest\Plugin\ResourceBase object. Overrides ResourceBase::__construct
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
ResourceBase::$logger	protected	property	A logger instance.
ResourceBase::$serializerFormats	protected	property	The available serialization formats.
ResourceBase::availableMethods	public	function	Returns the available HTTP request methods on this plugin. Overrides ResourceInterface::availableMethods	1
ResourceBase::getBaseRoute	protected	function	Gets the base route for a particular method.	2
ResourceBase::getBaseRouteRequirements	protected	function	Gets the base route requirements for a particular method.	1
ResourceBase::permissions	public	function	Implements ResourceInterface::permissions(). Overrides ResourceInterface::permissions	2
ResourceBase::requestMethods	protected	function	Provides predefined HTTP request methods.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.

You are here

class MonitoringSensorConfigResource in Monitoring 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation