class VerboseTableResult in Monitoring 8

Provides the verbose output for a table result of a sensor plugin.

Usage Example:

$output[] = array(
  '#type' => 'verbose_table_result',
  '#title' => t('Title of sensor results'),
  '#header' => $table_header,
  '#rows' => $table_rows,
  '#query' => $query_string,
  '#query_args' => $query_args,
);

Plugin annotation

@FormElement("verbose_table_result");

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\Core\Render\Element\RenderElement implements ElementInterface
    class \Drupal\Core\Render\Element\FormElement implements FormElementInterface
    class \Drupal\monitoring\Element\VerboseTableResult

Expanded class hierarchy of VerboseTableResult

10 #type uses of VerboseTableResult

ContentEntityAggregatorSensorPlugin::verboseResultUnaggregated in src/Plugin/monitoring/SensorPlugin/ContentEntityAggregatorSensorPlugin.php: Adds unaggregated verbose output to the render array $output.
CoreRequirementsSensorPlugin::resultVerbose in src/Plugin/monitoring/SensorPlugin/CoreRequirementsSensorPlugin.php: Provide additional info about sensor call.
DatabaseAggregatorSensorPlugin::verboseResultHistory in src/Plugin/monitoring/SensorPlugin/DatabaseAggregatorSensorPlugin.php: Adds history verbose output to the render array $output.
DatabaseAggregatorSensorPlugin::verboseResultUnaggregated in src/Plugin/monitoring/SensorPlugin/DatabaseAggregatorSensorPlugin.php: Adds unaggregated verbose output to the render array $output.
ImageMissingStyleSensorPlugin::verboseResultCounting in src/Plugin/monitoring/SensorPlugin/ImageMissingStyleSensorPlugin.php: Get the aggregated table verbose output.

... See full list

File

src/Element/VerboseTableResult.php, line 29: Contains \Drupal\monitoring\Element\VerboseTableResult.

Namespace

Drupal\monitoring\Element

View source

class VerboseTableResult extends FormElement {

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $class = get_class($this);
    return [
      '#title' => 'Result',
      '#header' => [],
      '#rows' => [],
      '#empty' => 'There are no results for this sensor to display.',
      '#query' => '',
      '#query_args' => [],
      '#pre_render' => [
        [
          $class,
          'preRenderVerboseTableResult',
        ],
      ],
      '#description' => '',
    ];
  }

  /**
   * Prepares a #type 'verbose_table_result' render element.
   *
   * @param array $element
   *   An associative array containing the properties of the element.
   *   Properties used: #title, #header, #rows, #query, #arguments.
   *
   * @return array
   *   The $element with prepared variables.
   */
  public static function preRenderVerboseTableResult(array $element) {
    $id = $string = str_replace(" ", "_", strtolower($element['#title']));
    $element[$id] = [
      '#type' => 'fieldset',
      '#title' => $element['#title'],
      '#attributes' => [
        'id' => $id,
      ],
      '#description' => $element['#description'],
    ];
    $element[$id]['table'] = [
      '#type' => 'table',
      '#header' => $element['#header'],
      '#rows' => $element['#rows'],
      '#empty' => t(':empty', [
        ':empty' => $element['#empty'],
      ]),
    ];
    if (!empty($element['#query'])) {
      $element[$id]['query'] = [
        '#type' => 'details',
        '#open' => FALSE,
        '#title' => t('Query'),
        '#attributes' => [
          'class' => [
            'monitoring-verbose-query',
          ],
        ],
      ];
      $element[$id]['query']['query'] = [
        '#type' => 'item',
        '#markup' => '<pre>' . $element['#query'] . '</pre>',
      ];
      if (!empty($element['#query_args'])) {
        $element[$id]['query']['query_args'] = [
          '#type' => 'item',
          '#title' => t('Arguments'),
          '#markup' => '<pre>' . var_export($element['#query_args'], TRUE) . '</pre>',
        ];
      }
    }
    return $element;
  }

}

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
FormElement::processAutocomplete	public static	function	Adds autocomplete functionality to elements.
FormElement::processPattern	public static	function	#process callback for #pattern form element property.
FormElement::validatePattern	public static	function	#element_validate callback for #pattern form element property.
FormElement::valueCallback	public static	function	Determines how user input is mapped to an element's #value property. Overrides FormElementInterface::valueCallback	15
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
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.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	92
RenderElement::preRenderAjaxForm	public static	function	Adds Ajax information about an element to communicate with JavaScript.
RenderElement::preRenderGroup	public static	function	Adds members of this group as actual elements for rendering.
RenderElement::processAjaxForm	public static	function	Form element processing handler for the #ajax form property.	1
RenderElement::processGroup	public static	function	Arranges elements into groups.
RenderElement::setAttributes	public static	function	Sets a form element's class attribute. Overrides ElementInterface::setAttributes
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.
VerboseTableResult::getInfo	public	function	Returns the element properties for this element. Overrides ElementInterface::getInfo
VerboseTableResult::preRenderVerboseTableResult	public static	function	Prepares a #type 'verbose_table_result' render element.

You are here

class VerboseTableResult in Monitoring 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation