class MonitoringSensorResultResource in Monitoring 8

Provides a resource for monitoring sensors results.

Plugin annotation


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

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\MonitoringSensorResultResource

Expanded class hierarchy of MonitoringSensorResultResource

File

src/Plugin/rest/resource/MonitoringSensorResultResource.php, line 33: Definition of Drupal\monitoring\Plugin\rest\resource\MonitoringSensorInfoResource.

Namespace

Drupal\monitoring\Plugin\rest\resource

View source

class MonitoringSensorResultResource extends ResourceBase {

  /**
   * The sensor manager.
   *
   * @var \Drupal\monitoring\Sensor\SensorManager
   */
  protected $sensorManager;

  /**
   * The sensor runner.
   *
   * @var \Drupal\monitoring\SensorRunner
   */
  protected $sensorRunner;

  /**
   * @var \Drupal\Core\Render\RendererInterface
   */
  protected $renderer;
  public function __construct(array $configuration, $plugin_id, array $plugin_definition, array $serializer_formats, SensorManager $sensor_manager, SensorRunner $sensor_runner, LoggerInterface $logger, RendererInterface $renderer) {
    parent::__construct($configuration, $plugin_id, $plugin_definition, $serializer_formats, $logger);
    $this->sensorManager = $sensor_manager;
    $this->sensorRunner = $sensor_runner;
    $this->renderer = $renderer;
  }

  /**
   * {@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('monitoring.sensor_runner'), $container
      ->get('logger.factory')
      ->get('rest'), $container
      ->get('renderer'));
  }

  /**
   * {@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) {
    $request = \Drupal::request();
    $format = $request
      ->getRequestFormat('ĵson');
    if ($id) {
      try {
        $sensor_config[$id] = $this->sensorManager
          ->getSensorConfigByName($id);

        // Some sensors might render or do things that we can not properly
        // collect cacheability metadata for. So, run it in our own render
        // context. For example, one is the run cron link of the system.module
        // requirements hook.
        $context = new RenderContext();
        $sensor_runner = $this->sensorRunner;
        $result = $this->renderer
          ->executeInRenderContext($context, function () use ($sensor_runner, $sensor_config) {
          return $sensor_runner
            ->runSensors($sensor_config);
        });
        $response = $result[$id]
          ->toArray();
        $url = Url::fromRoute('rest.monitoring-sensor-result.GET', [
          'id' => $id,
          '_format' => $format,
        ])
          ->setAbsolute()
          ->toString(TRUE);
        $response['uri'] = $url
          ->getGeneratedUrl();
        if ($request
          ->get('expand') == 'sensor') {
          $response['sensor'] = $result[$id]
            ->getSensorConfig()
            ->toArray();
        }
        $response = new ResourceResponse($response);
        $response
          ->addCacheableDependency($result[$id]
          ->getSensorConfig());
        $response
          ->addCacheableDependency($url);
        $response
          ->addCacheableDependency(CacheableMetadata::createFromRenderArray([
          '#cache' => [
            'contexts' => [
              0 => 'url.query_args',
            ],
            'max-age' => 0,
          ],
        ]));
        if (!$context
          ->isEmpty()) {
          $response
            ->addCacheableDependency($context
            ->pop());
        }
        return $response;
      } catch (NonExistingSensorException $e) {
        throw new NotFoundHttpException($e
          ->getMessage(), $e);
      } catch (DisabledSensorException $e) {
        throw new NotFoundHttpException($e
          ->getMessage(), $e);
      }
    }
    else {
      $list = array();
      $cacheable_metadata = new CacheableMetadata();

      // Some sensors might render or do things that we can not properly
      // collect cacheability metadata for. So, run it in our own render
      // context. For example, one is the run cron link of the system.module
      // requirements hook.
      $context = new RenderContext();
      $sensor_runner = $this->sensorRunner;
      $results = \Drupal::service('renderer')
        ->executeInRenderContext($context, function () use ($sensor_runner) {
        return $sensor_runner
          ->runSensors();
      });
      foreach ($results as $id => $result) {
        $list[$id] = $result
          ->toArray();
        $url = Url::fromRoute('rest.monitoring-sensor-result.GET', [
          'id' => $id,
          '_format' => $format,
        ])
          ->setAbsolute()
          ->toString(TRUE);
        $list[$id]['uri'] = $url
          ->getGeneratedUrl();
        if ($request
          ->get('expand') == 'sensor') {
          $list[$id]['sensor'] = $result
            ->getSensorConfig()
            ->toArray();
        }
        $cacheable_metadata = $cacheable_metadata
          ->merge($url);
        $cacheable_metadata = $cacheable_metadata
          ->merge(CacheableMetadata::createFromObject($result
          ->getSensorConfig()));
        $cacheable_metadata = $cacheable_metadata
          ->merge(CacheableMetadata::createFromRenderArray([
          '#cache' => [
            'max-age' => 0,
          ],
        ]));
      }
      $response = new ResourceResponse($list);
      $response
        ->addCacheableDependency($cacheable_metadata);
      if (!$context
        ->isEmpty()) {
        $response
          ->addCacheableDependency($context
          ->pop());
      }
      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.
MonitoringSensorResultResource::$renderer	protected	property
MonitoringSensorResultResource::$sensorManager	protected	property	The sensor manager.
MonitoringSensorResultResource::$sensorRunner	protected	property	The sensor runner.
MonitoringSensorResultResource::create	public static	function	Creates an instance of the plugin. Overrides ResourceBase::create
MonitoringSensorResultResource::get	public	function	Responds to sensor INFO GET requests.
MonitoringSensorResultResource::routes	public	function	Returns a collection of routes with URL path information for the resource. Overrides ResourceBase::routes
MonitoringSensorResultResource::__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 MonitoringSensorResultResource in Monitoring 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation