class StatusReport

Same name and namespace in other branches
  1. 8.9.x core/lib/Drupal/Core/Render/Element/StatusReport.php \Drupal\Core\Render\Element\StatusReport
  2. 10 core/lib/Drupal/Core/Render/Element/StatusReport.php \Drupal\Core\Render\Element\StatusReport
  3. 11.x core/lib/Drupal/Core/Render/Element/StatusReport.php \Drupal\Core\Render\Element\StatusReport

Creates status report page element.

Plugin annotation

@RenderElement("status_report");

Hierarchy

Expanded class hierarchy of StatusReport

1 file declares its use of StatusReport
StatusReportPage.php in core/modules/system/src/Element/StatusReportPage.php
2 #type uses of StatusReport
DbUpdateController::requirements in core/modules/system/src/Controller/DbUpdateController.php
Renders a list of requirement errors or warnings.
StatusReportPage::preRenderRequirements in core/modules/system/src/Element/StatusReportPage.php
#pre_render callback to create status report requirements.

File

core/lib/Drupal/Core/Render/Element/StatusReport.php, line 10

Namespace

Drupal\Core\Render\Element
View on git.drupalcode.org
View source 
class StatusReport extends RenderElement {
    
    /**
     * {@inheritdoc}
     */
    public function getInfo() {
        $class = static::class;
        return [
            '#theme' => 'status_report_grouped',
            '#priorities' => [
                'error',
                'warning',
                'checked',
                'ok',
            ],
            '#pre_render' => [
                [
                    $class,
                    'preRenderGroupRequirements',
                ],
            ],
        ];
    }
    
    /**
     * #pre_render callback to group requirements.
     */
    public static function preRenderGroupRequirements($element) {
        $severities = static::getSeverities();
        $grouped_requirements = [];
        foreach ($element['#requirements'] as $key => $requirement) {
            $severity = $severities[REQUIREMENT_INFO];
            if (isset($requirement['severity'])) {
                $requirement_severity = (int) $requirement['severity'] === REQUIREMENT_OK ? REQUIREMENT_INFO : (int) $requirement['severity'];
                $severity = $severities[$requirement_severity];
            }
            elseif (defined('MAINTENANCE_MODE') && MAINTENANCE_MODE == 'install') {
                $severity = $severities[REQUIREMENT_OK];
            }
            $grouped_requirements[$severity['status']]['title'] = $severity['title'];
            $grouped_requirements[$severity['status']]['type'] = $severity['status'];
            $grouped_requirements[$severity['status']]['items'][$key] = $requirement;
        }
        // Order the grouped requirements by a set order.
        $order = array_flip($element['#priorities']);
        uksort($grouped_requirements, function ($a, $b) use ($order) {
            return $order[$a] <=> $order[$b];
        });
        $element['#grouped_requirements'] = $grouped_requirements;
        return $element;
    }
    
    /**
     * Gets the severities.
     *
     * @return array
     */
    public static function getSeverities() {
        return [
            REQUIREMENT_INFO => [
                'title' => t('Checked', [], [
                    'context' => 'Examined',
                ]),
                'status' => 'checked',
            ],
            REQUIREMENT_OK => [
                'title' => t('OK'),
                'status' => 'ok',
            ],
            REQUIREMENT_WARNING => [
                'title' => t('Warnings found'),
                'status' => 'warning',
            ],
            REQUIREMENT_ERROR => [
                'title' => t('Errors found'),
                'status' => 'error',
            ],
        ];
    }

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2
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&#039;s class attribute. Overrides ElementInterface::setAttributes
StatusReport::getInfo public function Returns the element properties for this element. Overrides ElementInterface::getInfo
StatusReport::getSeverities public static function Gets the severities.
StatusReport::preRenderGroupRequirements public static function #pre_render callback to group requirements.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.