You are here

Home » API reference » Express 8 » SettingBase.php

class SettingBase in Express 8

Base class for a setting.

Hierarchy

Expanded class hierarchy of SettingBase

54 files declare their use of SettingBase
Breadcrumb.php in themes/contrib/bootstrap/src/Plugin/Setting/Components/Breadcrumbs/Breadcrumb.php
Contains \Drupal\bootstrap\Plugin\Setting\Components\Breadcrumbs\Breadcrumb.
BreadcrumbHome.php in themes/contrib/bootstrap/src/Plugin/Setting/Components/Breadcrumbs/BreadcrumbHome.php
Contains \Drupal\bootstrap\Plugin\Setting\Components\Breadcrumbs\BreadcrumbHome.
BreadcrumbTitle.php in themes/contrib/bootstrap/src/Plugin/Setting/Components/Breadcrumbs/BreadcrumbTitle.php
Contains \Drupal\bootstrap\Plugin\Setting\Components\Breadcrumbs\BreadcrumbTitle.
ButtonColorize.php in themes/contrib/bootstrap/src/Plugin/Setting/General/Buttons/ButtonColorize.php
Contains \Drupal\bootstrap\Plugin\Setting\General\Buttons\ButtonColorize.
ButtonIconize.php in themes/contrib/bootstrap/src/Plugin/Setting/General/Buttons/ButtonIconize.php
Contains \Drupal\bootstrap\Plugin\Setting\General\Buttons\ButtonIconize.

... See full list

File

themes/contrib/bootstrap/src/Plugin/Setting/SettingBase.php, line 20
Contains \Drupal\bootstrap\Plugin\Setting\SettingBase.

Namespace

Drupal\bootstrap\Plugin\Setting
View source 
class SettingBase extends PluginBase implements SettingInterface {

  /**
   * {@inheritdoc}
   */
  public function alterForm(array &$form, FormStateInterface $form_state, $form_id = NULL) {
    $this
      ->alterFormElement(Element::create($form), $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function alterFormElement(Element $form, FormStateInterface $form_state, $form_id = NULL) {
    $this
      ->getSettingElement($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function drupalSettings() {
    return FALSE;
  }

  /**
   * {@inheritdoc}
   */
  public function getCacheTags() {
    return [
      'rendered',
    ];
  }

  /**
   * Retrieves all the form properties from the setting definition.
   *
   * @return array
   *   The form properties.
   */
  public function getElementProperties() {
    $properties = $this
      ->getPluginDefinition();
    foreach ($properties as $name => $value) {
      if (in_array($name, [
        'class',
        'defaultValue',
        'definition',
        'groups',
        'id',
        'provider',
        'see',
      ])) {
        unset($properties[$name]);
      }
    }
    return $properties;
  }

  /**
   * {@inheritdoc}
   */
  public function getDefaultValue() {
    return isset($this->pluginDefinition['defaultValue']) ? $this->pluginDefinition['defaultValue'] : NULL;
  }

  /**
   * {@inheritdoc}
   *
   * @deprecated Will be removed in a future release. Use \Drupal\bootstrap\Plugin\Setting\SettingInterface::getGroupElement
   */
  public function getGroup(array &$form, FormStateInterface $form_state) {
    Bootstrap::deprecated();
    return $this
      ->getGroupElement(Element::create($form), $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function getGroupElement(Element $form, FormStateInterface $form_state) {
    $groups = $this
      ->getGroups();
    $group = $form;
    $first = TRUE;
    foreach ($groups as $key => $title) {
      if (!isset($group->{$key})) {
        if ($title) {
          $group->{$key} = [
            '#type' => 'details',
            '#title' => $title,
          ];
        }
        else {
          $group->{$key} = [
            '#type' => 'container',
          ];
        }
        $group = Element::create($group->{$key}
          ->getArray());
        if ($first) {
          $group
            ->setProperty('group', 'bootstrap');
        }
        else {
          $group
            ->setProperty('open', FALSE);
        }
      }
      else {
        $group = Element::create($group->{$key}
          ->getArray());
      }
      $first = FALSE;
    }
    return $group;
  }

  /**
   * {@inheritdoc}
   */
  public function getGroups() {
    return !empty($this->pluginDefinition['groups']) ? $this->pluginDefinition['groups'] : [];
  }

  /**
   * {@inheritdoc}
   *
   * @deprecated Will be removed in a future release. Use \Drupal\bootstrap\Plugin\Setting\SettingInterface::getSettingElement
   */
  public function getElement(array &$form, FormStateInterface $form_state) {
    Bootstrap::deprecated();
    return $this
      ->getSettingElement(Element::create($form), $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function getOptions() {
    return isset($this->pluginDefinition['options']) ? (array) $this->pluginDefinition['options'] : [];
  }

  /**
   * {@inheritdoc}
   */
  public function getSettingElement(Element $form, FormStateInterface $form_state) {

    // Construct the group elements.
    $group = $this
      ->getGroupElement($form, $form_state);
    $plugin_id = $this
      ->getPluginId();
    if (!isset($group->{$plugin_id})) {

      // Set properties from the plugin definition.
      foreach ($this
        ->getElementProperties() as $name => $value) {
        $group->{$plugin_id}
          ->setProperty($name, $value);
      }

      // Set default value from the stored form state value or theme setting.
      $default_value = $form_state
        ->getValue($plugin_id, $this->theme
        ->getSetting($plugin_id));
      $group->{$plugin_id}
        ->setProperty('default_value', $default_value);

      // Append additional "see" link references to the description.
      $description = (string) $group->{$plugin_id}
        ->getProperty('description') ?: '';
      $links = [];
      foreach ($this->pluginDefinition['see'] as $url => $title) {
        $link = Element::createStandalone([
          '#type' => 'link',
          '#url' => Url::fromUri($url),
          '#title' => $title,
          '#attributes' => [
            'target' => '_blank',
          ],
        ]);
        $links[] = (string) $link
          ->renderPlain();
      }
      if (!empty($links)) {
        $description .= '<br>';
        $description .= t('See also:');
        $description .= ' ' . implode(', ', $links);
        $group->{$plugin_id}
          ->setProperty('description', $description);
      }
    }
    return $group->{$plugin_id};
  }

  /**
   * {@inheritdoc}
   */
  public function getTitle() {
    return !empty($this->pluginDefinition['title']) ? $this->pluginDefinition['title'] : NULL;
  }

  /**
   * {@inheritdoc}
   */
  public static function submitForm(array &$form, FormStateInterface $form_state) {
    static::submitFormElement(Element::create($form), $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public static function submitFormElement(Element $form, FormStateInterface $form_state) {
  }

  /**
   * {@inheritdoc}
   */
  public static function validateForm(array &$form, FormStateInterface $form_state) {
    static::validateFormElement(Element::create($form), $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public static function validateFormElement(Element $form, FormStateInterface $form_state) {
  }

}

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::$theme protected property The currently set theme object.
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. Overrides PluginBase::__construct 1
SettingBase::alterForm public function The alter method to store the code. Overrides FormInterface::alterForm
SettingBase::alterFormElement public function The alter method to store the code. Overrides FormInterface::alterFormElement 14
SettingBase::drupalSettings public function Determines whether a theme setting should added to drupalSettings. Overrides SettingInterface::drupalSettings 25
SettingBase::getCacheTags public function The cache tags associated with this object. Overrides SettingInterface::getCacheTags 6
SettingBase::getDefaultValue public function Retrieves the setting's default value. Overrides SettingInterface::getDefaultValue
SettingBase::getElement Deprecated public function Overrides SettingInterface::getElement
SettingBase::getElementProperties public function Retrieves all the form properties from the setting definition.
SettingBase::getGroup Deprecated public function Overrides SettingInterface::getGroup
SettingBase::getGroupElement public function Retrieves the group form element the setting belongs to. Overrides SettingInterface::getGroupElement
SettingBase::getGroups public function Retrieves the setting's groups. Overrides SettingInterface::getGroups
SettingBase::getOptions public function Retrieves the settings options, if set. Overrides SettingInterface::getOptions
SettingBase::getSettingElement public function Retrieves the form element for the setting. Overrides SettingInterface::getSettingElement
SettingBase::getTitle public function Retrieves the setting's human-readable title. Overrides SettingInterface::getTitle
SettingBase::submitForm public static function Form submission handler. Overrides FormInterface::submitForm
SettingBase::submitFormElement public static function Form submission handler. Overrides FormInterface::submitFormElement 1
SettingBase::validateForm public static function Form validation handler. Overrides FormInterface::validateForm
SettingBase::validateFormElement public static function Form validation handler. Overrides FormInterface::validateFormElement
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.