class WebformCard in Webform 8.5

Provides a render element for a card container.

Plugin annotation

@RenderElement("webform_card");

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\webform_cards\Element\WebformCard

1 #type use of WebformCard

webform_test_test_cards_long in tests/modules/webform_test/includes/webform_test.test_cards_long.inc

Generate long webform card elements.

File

modules/webform_cards/src/Element/WebformCard.php, line 12

Namespace

Drupal\webform_cards\Element

class WebformCard extends RenderElement {

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $class = get_class($this);
    return [
      '#prev_button_label' => '',
      '#next_button_label' => '',
      '#process' => [
        [
          $class,
          'processGroup',
        ],
        [
          $class,
          'processAjaxForm',
        ],
      ],
      '#pre_render' => [
        [
          $class,
          'preRenderWebformCard',
        ],
        [
          $class,
          'preRenderGroup',
        ],
      ],
      '#value' => NULL,
      '#theme_wrappers' => [
        'webform_card',
      ],
    ];
  }

  /**
   * Adds form element theming to webform card.
   *
   * @param array $element
   *   An associative array containing the properties and children of the
   *   webform card.
   *
   * @return array
   *   The modified element.
   */
  public static function preRenderWebformCard(array $element) {
    $element['#attributes']['data-title'] = $element['#title'];
    if (!empty($element['#webform_key'])) {
      $element['#attributes']['data-webform-key'] = $element['#webform_key'];
    }
    if (!empty($element['#prev_button_label'])) {
      $element['#attributes']['data-prev-button-label'] = $element['#prev_button_label'];
    }
    if (!empty($element['#next_button_label'])) {
      $element['#attributes']['data-next-button-label'] = $element['#next_button_label'];
    }
    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
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.
WebformCard::getInfo	public	function	Returns the element properties for this element. Overrides ElementInterface::getInfo
WebformCard::preRenderWebformCard	public static	function	Adds form element theming to webform card.