class YamlFormMessage in YAML Form 8

Same name in this branch

8 src/Element/YamlFormMessage.php \Drupal\yamlform\Element\YamlFormMessage
8 src/Plugin/YamlFormElement/YamlFormMessage.php \Drupal\yamlform\Plugin\YamlFormElement\YamlFormMessage

Provides a 'yamlform_message' element.

Plugin annotation


@YamlFormElement(
  id = "yamlform_message",
  label = @Translation("Message"),
  category = @Translation("Markup elements"),
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\yamlform\YamlFormElementBase implements YamlFormElementInterface uses StringTranslationTrait
  - class \Drupal\yamlform\Plugin\YamlFormElement\YamlFormMarkupBase
    class \Drupal\yamlform\Plugin\YamlFormElement\YamlFormMessage

Expanded class hierarchy of YamlFormMessage

File

src/Plugin/YamlFormElement/YamlFormMessage.php, line 18

Namespace

Drupal\yamlform\Plugin\YamlFormElement

View source

class YamlFormMessage extends YamlFormMarkupBase {

  /**
   * {@inheritdoc}
   */
  public function getDefaultProperties() {
    return parent::getDefaultProperties() + [
      // Attributes.
      'attributes' => [],
      // Message settings.
      'message_type' => 'status',
      'message_message' => '',
      'message_close' => FALSE,
      'message_close_effect' => 'slide',
      'message_id' => '',
      'message_storage' => '',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function getTranslatableProperties() {
    return array_merge(parent::getTranslatableProperties(), [
      'message_message',
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public function prepare(array &$element, YamlFormSubmissionInterface $yamlform_submission) {
    parent::prepare($element, $yamlform_submission);
    if (!empty($element['#message_storage']) && empty($element['#message_id'])) {

      // Use
      // [yamlform:id]--[source_entity:type]-[source_entity:id]--[element:key]
      // as the message id.
      $id = [];
      if ($yamlform = $yamlform_submission
        ->getYamlForm()) {
        $id[] = $yamlform
          ->id();
      }
      if ($source_entity = $yamlform_submission
        ->getSourceEntity()) {
        $id[] = $source_entity
          ->getEntityTypeId() . '-' . $source_entity
          ->id();
      }
      $id[] = $element['#yamlform_key'];
      $element['#message_id'] = implode('--', $id);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function form(array $form, FormStateInterface $form_state) {
    $form = parent::form($form, $form_state);
    $form['markup']['#title'] = $this
      ->t('Message settings');
    $form['markup']['message_type'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Message type'),
      '#options' => [
        'status' => t('Status'),
        'error' => t('Error'),
        'warning' => t('Warning'),
        'info' => t('Info'),
      ],
    ];
    $form['markup']['message_message'] = [
      '#type' => 'yamlform_html_editor',
      '#title' => $this
        ->t('Message content'),
    ];
    $form['markup']['message_close'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Allow users to close the message.'),
      '#return_value' => TRUE,
    ];
    $form['markup']['message_close_effect'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Message close effect'),
      '#options' => [
        'hide' => $this
          ->t('Hide'),
        'slide' => $this
          ->t('Slide'),
        'fade' => $this
          ->t('Fade'),
      ],
      '#states' => [
        'visible' => [
          ':input[name="properties[message_close]"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $form['markup']['message_storage'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Message storage'),
      '#options' => [
        YamlFormMessageElement::STORAGE_NONE => $this
          ->t('None: Message state is never stored.'),
        YamlFormMessageElement::STORAGE_SESSION => $this
          ->t('Session storage: Message state is reset after the browser is closed.'),
        YamlFormMessageElement::STORAGE_LOCAL => $this
          ->t('Local storage: Message state persists after the browser is closed.'),
        YamlFormMessageElement::STORAGE_USER => $this
          ->t("User data: Message state is saved to the current user's data. (Applies to authenticated users only)"),
        YamlFormMessageElement::STORAGE_STATE => $this
          ->t("State API: Message state is saved to the site's system state. (Applies to authenticated users only)"),
      ],
      '#states' => [
        'visible' => [
          ':input[name="properties[message_close]"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $form['markup']['message_id'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Message ID'),
      '#description' => $this
        ->t("Unique ID used to store the message's closed state. Please enter only lower-case letters, numbers, dashes, and underscores.") . '<br/>' . $this
        ->t('Defaults to: %value', [
        '%value' => '[yamlform:id]--[element:key]',
      ]),
      '#pattern' => '/^[a-z0-9-_]+$/',
      '#states' => [
        'visible' => [
          ':input[name="properties[message_close]"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    return $form;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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.
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.
YamlFormElementBase::$configFactory	protected	property	The configuration factory.
YamlFormElementBase::$currentUser	protected	property	The current user.
YamlFormElementBase::$elementInfo	protected	property	A element info manager.
YamlFormElementBase::$elementManager	protected	property	The form element manager.
YamlFormElementBase::$entityTypeManager	protected	property	The entity type manager.
YamlFormElementBase::$logger	protected	property	A logger instance.
YamlFormElementBase::$tokenManager	protected	property	The token manager.
YamlFormElementBase::build	protected	function	Build an element as text or HTML.	2
YamlFormElementBase::buildConfigurationForm	public	function	Form constructor. Overrides PluginFormInterface::buildConfigurationForm	1
YamlFormElementBase::buildExportHeader	public	function	Build an element's export header. Overrides YamlFormElementInterface::buildExportHeader	3
YamlFormElementBase::buildExportOptionsForm	public	function	Get an element's export options form. Overrides YamlFormElementInterface::buildExportOptionsForm	4
YamlFormElementBase::buildExportRecord	public	function	Build an element's export row. Overrides YamlFormElementInterface::buildExportRecord	5
YamlFormElementBase::checkAccessRules	public	function	Check element access (rules). Overrides YamlFormElementInterface::checkAccessRules
YamlFormElementBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
YamlFormElementBase::displayDisabledWarning	public	function	Display element disabled warning. Overrides YamlFormElementInterface::displayDisabledWarning	1
YamlFormElementBase::formatHtml	public	function	Format an element's value as HTML. Overrides YamlFormElementInterface::formatHtml	15
YamlFormElementBase::formatTableColumn	public	function	Format an element's table column value. Overrides YamlFormElementInterface::formatTableColumn	2
YamlFormElementBase::formatText	public	function	Format an element's value as plain text. Overrides YamlFormElementInterface::formatText	13
YamlFormElementBase::getAdminLabel	public	function	Get an element's admin label (#admin_title, #title or #yamlform_key). Overrides YamlFormElementInterface::getAdminLabel
YamlFormElementBase::getConfigurationFormProperties	public	function	Get an associative array of element properties from configuration form. Overrides YamlFormElementInterface::getConfigurationFormProperties	2
YamlFormElementBase::getConfigurationFormProperty	protected	function	Get configuration property value.	1
YamlFormElementBase::getDefaultBaseProperties	protected	function	Get default base properties used by all elements.
YamlFormElementBase::getDefaultFormat	public	function	Get an element's default format name. Overrides YamlFormElementInterface::getDefaultFormat	17
YamlFormElementBase::getElementSelectorInputsOptions	protected	function	Get an element's (sub)inputs selectors as options.	7
YamlFormElementBase::getElementStateOptions	public	function	Get an element's supported states as options. Overrides YamlFormElementInterface::getElementStateOptions
YamlFormElementBase::getExportDefaultOptions	public	function	Get an element's default export options. Overrides YamlFormElementInterface::getExportDefaultOptions	4
YamlFormElementBase::getFormat	public	function	Get element's format name by looking for '#format' property, global settings, and finally default settings. Overrides YamlFormElementInterface::getFormat	1
YamlFormElementBase::getFormats	public	function	Get an element's available formats. Overrides YamlFormElementInterface::getFormats	18
YamlFormElementBase::getInfo	public	function	Retrieves the default properties for the defined element type. Overrides YamlFormElementInterface::getInfo
YamlFormElementBase::getKey	public	function	Get an element's key/name. Overrides YamlFormElementInterface::getKey
YamlFormElementBase::getLabel	public	function	Get an element's label (#title or #yamlform_key). Overrides YamlFormElementInterface::getLabel
YamlFormElementBase::getPluginApiLink	public	function	Get link to element's API documentation. Overrides YamlFormElementInterface::getPluginApiLink
YamlFormElementBase::getPluginApiUrl	public	function	Get the URL for the element's API documentation. Overrides YamlFormElementInterface::getPluginApiUrl
YamlFormElementBase::getPluginLabel	public	function	Gets the label of the plugin instance. Overrides YamlFormElementInterface::getPluginLabel
YamlFormElementBase::getTableColumn	public	function	Get element's table column(s) settings. Overrides YamlFormElementInterface::getTableColumn	3
YamlFormElementBase::getTestValue	public	function	Get test value for an element. Overrides YamlFormElementInterface::getTestValue	7
YamlFormElementBase::getTypeName	public	function	Gets the type name (aka id) of the plugin instance with the 'yamlform_' prefix. Overrides YamlFormElementInterface::getTypeName
YamlFormElementBase::hasMultipleValues	public	function	Checks if element value has multiple values. Overrides YamlFormElementInterface::hasMultipleValues	3
YamlFormElementBase::hasProperty	public	function	Determine if an element supports a specified property. Overrides YamlFormElementInterface::hasProperty
YamlFormElementBase::hasWrapper	public	function	Checks if the element has a wrapper. Overrides YamlFormElementInterface::hasWrapper
YamlFormElementBase::initialize	public	function	Initialize an element to be displayed, rendered, or exported. Overrides YamlFormElementInterface::initialize	1
YamlFormElementBase::isComposite	public	function	Checks if element is a composite element. Overrides YamlFormElementInterface::isComposite
YamlFormElementBase::isDisabled	public	function	Checks if element is disabled. Overrides YamlFormElementInterface::isDisabled
YamlFormElementBase::isEnabled	public	function	Checks if element is enabled. Overrides YamlFormElementInterface::isEnabled	1
YamlFormElementBase::isHidden	public	function	Checks if element is hidden. Overrides YamlFormElementInterface::isHidden
YamlFormElementBase::isMultiline	public	function	Checks if element value could contain multiple lines. Overrides YamlFormElementInterface::isMultiline	3
YamlFormElementBase::isRoot	public	function	Checks if element is a root element. Overrides YamlFormElementInterface::isRoot	1
YamlFormElementBase::postCreate	public	function	Acts on a form submission element after it is created. Overrides YamlFormElementInterface::postCreate	1
YamlFormElementBase::postDelete	public	function	Delete any additional value associated with an element. Overrides YamlFormElementInterface::postDelete	2
YamlFormElementBase::postLoad	public	function	Acts on loaded form submission. Overrides YamlFormElementInterface::postLoad	1
YamlFormElementBase::postSave	public	function	Acts on a saved form submission element before the insert or update hook is invoked. Overrides YamlFormElementInterface::postSave	2
YamlFormElementBase::preCreate	public	function	Changes the values of an entity before it is created. Overrides YamlFormElementInterface::preCreate	1
YamlFormElementBase::preDelete	public	function		1
YamlFormElementBase::prefixExportHeader	protected	function	Prefix an element's export header.
YamlFormElementBase::prepareWrapper	protected	function	Set an elements Flexbox and #states wrapper.	1
YamlFormElementBase::preSave	public	function	Acts on a form submission element before the presave hook is invoked. Overrides YamlFormElementInterface::preSave	2
YamlFormElementBase::setConfigurationFormDefaultValue	protected	function	Set an element's configuration form element default value.	2
YamlFormElementBase::setConfigurationFormDefaultValueRecursive	protected	function	Set configuration form default values recursively.
YamlFormElementBase::setDefaultValue	public	function	Set an element's default value using saved data. Overrides YamlFormElementInterface::setDefaultValue	8
YamlFormElementBase::submitConfigurationForm	public	function	Form submission handler. Overrides PluginFormInterface::submitConfigurationForm
YamlFormElementBase::validateConfigurationForm	public	function	Form validation handler. Overrides PluginFormInterface::validateConfigurationForm	3
YamlFormElementBase::validateUnique	public static	function	Form API callback. Validate #unique value.
YamlFormElementBase::__construct	public	function	Constructs a Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct
YamlFormMarkupBase::buildHtml	public	function	Build an element as HTML element. Overrides YamlFormElementBase::buildHtml
YamlFormMarkupBase::buildText	public	function	Build an element as text element. Overrides YamlFormElementBase::buildText	2
YamlFormMarkupBase::getElementSelectorOptions	public	function	Get an element's selectors as options. Overrides YamlFormElementBase::getElementSelectorOptions
YamlFormMarkupBase::getRelatedTypes	public	function	Get related element types. Overrides YamlFormElementBase::getRelatedTypes
YamlFormMarkupBase::isContainer	public	function	Checks if element is a container that can contain elements. Overrides YamlFormElementBase::isContainer
YamlFormMarkupBase::isInput	public	function	Checks if the element carries a value. Overrides YamlFormElementBase::isInput
YamlFormMessage::form	public	function	Gets the actual configuration form array to be built. Overrides YamlFormMarkupBase::form
YamlFormMessage::getDefaultProperties	public	function	Only a few elements don't inherit these default properties. Overrides YamlFormMarkupBase::getDefaultProperties
YamlFormMessage::getTranslatableProperties	public	function	Get translatable properties. Overrides YamlFormElementBase::getTranslatableProperties
YamlFormMessage::prepare	public	function	Prepare an element to be rendered within a form. Overrides YamlFormMarkupBase::prepare

You are here

class YamlFormMessage in YAML Form 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation