You are here

Home » API reference » Apigee Edge 8 » StatusPropertyElement.php

class StatusPropertyElement in Apigee Edge 8

Provides a status property element.

Plugin annotation

@RenderElement("status_property");

Hierarchy

Expanded class hierarchy of StatusPropertyElement

4 files declare their use of StatusPropertyElement
apigee_edge.module in ./apigee_edge.module
Copyright 2018 Google Inc.
AppEditForm.php in src/Entity/Form/AppEditForm.php
StatusPropertyFormatter.php in src/Plugin/Field/FieldFormatter/StatusPropertyFormatter.php
TeamListBuilder.php in modules/apigee_edge_teams/src/Entity/ListBuilder/TeamListBuilder.php
5 #type uses of StatusPropertyElement
AppEditForm::form in src/Entity/Form/AppEditForm.php
Gets the actual form array to be built.
StatusPropertyFormatter::viewElements in src/Plugin/Field/FieldFormatter/StatusPropertyFormatter.php
Builds a renderable array for a field value.
TeamListBuilder::buildRow in modules/apigee_edge_teams/src/Entity/ListBuilder/TeamListBuilder.php
Builds a row for an entity in the entity listing.
template_preprocess_app_credential in ./apigee_edge.module
Prepares variables for app_credential templates.
template_preprocess_app_credential_product_list in ./apigee_edge.module
Prepares variables for app_credential_product_list templates.

File

src/Element/StatusPropertyElement.php, line 29

Namespace

Drupal\apigee_edge\Element
View source 
class StatusPropertyElement extends RenderElement {

  /**
   * Indicator status configuration id: OK.
   *
   * @var string
   */
  public const INDICATOR_STATUS_OK = 'indicator_status_ok';

  /**
   * Indicator status configuration id: Warning.
   *
   * @var string
   */
  public const INDICATOR_STATUS_WARNING = 'indicator_status_warning';

  /**
   * Indicator status configuration id: Error.
   *
   * @var string
   */
  public const INDICATOR_STATUS_ERROR = 'indicator_status_error';

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $class = get_class($this);
    return [
      '#theme' => 'status_property',
      '#value' => '',
      '#indicator_status' => '',
      '#pre_render' => [
        [
          $class,
          'preRenderStatusProperty',
        ],
      ],
    ];
  }

  /**
   * Prepare the render array for the template.
   *
   * @param array $element
   *   A renderable array.
   *
   * @return array
   *   A renderable array.
   */
  public static function preRenderStatusProperty(array $element) : array {
    $element['#attached']['library'][] = 'apigee_edge/apigee_edge.status_property';
    return $element;
  }

}

Members

Namesort descending 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.
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
StatusPropertyElement::getInfo public function Returns the element properties for this element. Overrides ElementInterface::getInfo
StatusPropertyElement::INDICATOR_STATUS_ERROR public constant Indicator status configuration id: Error.
StatusPropertyElement::INDICATOR_STATUS_OK public constant Indicator status configuration id: OK.
StatusPropertyElement::INDICATOR_STATUS_WARNING public constant Indicator status configuration id: Warning.
StatusPropertyElement::preRenderStatusProperty public static function Prepare the render array for the template.
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.