class BootstrapModal in Express 8

Pre-processes variables for the "bootstrap_modal" theme hook.

Plugin annotation

@BootstrapPreprocess("bootstrap_modal");

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\bootstrap\Plugin\PluginBase
      • class \Drupal\bootstrap\Plugin\Preprocess\PreprocessBase implements PreprocessInterface
        • class \Drupal\bootstrap\Plugin\Preprocess\BootstrapModal implements PreprocessInterface

File

themes/contrib/bootstrap/src/Plugin/Preprocess/BootstrapModal.php, line 20

Contains \Drupal\bootstrap\Plugin\Preprocess\BootstrapModal.

Namespace

Drupal\bootstrap\Plugin\Preprocess

class BootstrapModal extends PreprocessBase implements PreprocessInterface {

  /**
   * {@inheritdoc}
   */
  protected function preprocessVariables(Variables $variables) {

    // Immediately log an error and return if Bootstrap modals are not enabled.
    if (!$this->theme
      ->getSetting('modal_enabled')) {
      \Drupal::logger('bootstrap')
        ->error(t('Bootstrap modals are not enabled.'));
      return;
    }

    // Retrieve the ID, generating one if needed.
    $id = $variables
      ->getAttribute('id', Html::getUniqueId($variables
      ->offsetGet('id', 'bootstrap-modal')));
    $variables
      ->setAttribute('id', $id);
    unset($variables['id']);
    if ($variables->title) {
      $title_id = $variables
        ->getAttribute('id', "{$id}--title", $variables::TITLE);
      $variables
        ->setAttribute('id', $title_id, $variables::TITLE);
      $variables
        ->setAttribute('aria-labelledby', $title_id);
    }

    // Use a provided modal size or retrieve the default theme setting.
    $variables->size = $variables->size ?: $this->theme
      ->getSetting('modal_size');

    // Convert the description variable.
    $this
      ->preprocessDescription();

    // Ensure all attributes are proper objects.
    $this
      ->preprocessAttributes();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
BootstrapModal::preprocessVariables	protected	function	Preprocess the variables array. Overrides PreprocessBase::preprocessVariables
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
PreprocessBase::$hook	protected	property	The theme hook invoked.
PreprocessBase::$info	protected	property	The theme hook info array from the theme registry.
PreprocessBase::$variables	protected	property	The Variables object.
PreprocessBase::preprocess	public	function	Preprocess theme hook variables. Overrides PreprocessInterface::preprocess
PreprocessBase::preprocessAttributes	protected	function	Ensures all attributes have been converted to an Attribute object.
PreprocessBase::preprocessDescription	protected	function	Converts any set description variable into a traversable array.
PreprocessBase::preprocessElement	protected	function	Preprocess the variables array if an element is present.	8
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.