You are here

Home » API reference » Express 8 » CdnJsdelivrVersion.php

class CdnJsdelivrVersion in Express 8

The "cdn_jsdelivr_version" theme setting.

Plugin annotation


@BootstrapSetting(
  cdn_provider = "jsdelivr",
  id = "cdn_jsdelivr_version",
  type = "select",
  weight = -1,
  title = @Translation("Version"),
  description = @Translation("Choose the Bootstrap version from jsdelivr"),
  defaultValue = @BootstrapConstant("Drupal\bootstrap\Bootstrap::FRAMEWORK_VERSION"),
  groups = {
    "advanced" = @Translation("Advanced"),
    "cdn" = @Translation("CDN (Content Delivery Network)"),
    "jsdelivr" = false,
  },
)

Hierarchy

Expanded class hierarchy of CdnJsdelivrVersion

File

themes/contrib/bootstrap/src/Plugin/Setting/Advanced/Cdn/CdnJsdelivrVersion.php, line 37
Contains \Drupal\bootstrap\Plugin\Setting\Advanced\Cdn\CdnJsdelivrVersion.

Namespace

Drupal\bootstrap\Plugin\Setting\Advanced\Cdn
View source 
class CdnJsdelivrVersion extends CdnProvider {

  /**
   * {@inheritdoc}
   */
  public function alterFormElement(Element $form, FormStateInterface $form_state, $form_id = NULL) {
    $plugin_id = Html::cleanCssIdentifier($this->provider
      ->getPluginId());
    $setting = $this
      ->getSettingElement($form, $form_state);
    $setting
      ->setProperty('options', $this->provider
      ->getVersions());
    $setting
      ->setProperty('ajax', [
      'callback' => [
        get_class($this),
        'ajaxCallback',
      ],
      'wrapper' => 'cdn-provider-' . $plugin_id,
    ]);
    if (!$this->provider
      ->hasError() && !$this->provider
      ->isImported()) {
      $setting
        ->setProperty('description', t('These versions are automatically populated by the @provider API upon cache clear and newer versions may appear over time. It is highly recommended the version that the site was built with stays at that version. Until a newer version has been properly tested for updatability by the site maintainer, you should not arbitrarily "update" just because there is a newer version. This can cause many inconsistencies and undesired effects with an existing site.', [
        '@provider' => $this->provider
          ->getLabel(),
      ]));
    }
  }

  /**
   * AJAX callback for reloading CDN provider elements.
   *
   * @param array $form
   *   Nested array of form elements that comprise the form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   */
  public static function ajaxCallback(array $form, FormStateInterface $form_state) {
    return $form['advanced']['cdn'][$form_state
      ->getValue('cdn_provider', Bootstrap::getTheme()
      ->getSetting('cdn_provider'))];
  }

}

Members

Namesort descending Modifiers Type Description Overrides
CdnJsdelivrVersion::ajaxCallback public static function AJAX callback for reloading CDN provider elements. Overrides CdnProvider::ajaxCallback
CdnJsdelivrVersion::alterFormElement public function The alter method to store the code. Overrides CdnProvider::alterFormElement
CdnProvider::$provider protected property The current provider.
CdnProvider::$providerManager protected property The current provider manager instance.
CdnProvider::createProviderGroup private function Creates the necessary containers for each provider.
CdnProvider::getCacheTags public function The cache tags associated with this object. Overrides SettingBase::getCacheTags
CdnProvider::importProviderData private function Imports data for a provider that was manually uploaded in theme settings.
CdnProvider::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct
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.
SettingBase::alterForm public function The alter method to store the code. Overrides FormInterface::alterForm
SettingBase::drupalSettings public function Determines whether a theme setting should added to drupalSettings. Overrides SettingInterface::drupalSettings 25
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.