You are here

Home » API reference » Responsive wrappers 2.0.x » ResponsiveWrappersSettings.php

class ResponsiveWrappersSettings in Responsive wrappers 2.0.x

Same name and namespace in other branches
  1. 8 src/Form/ResponsiveWrappersSettings.php \Drupal\responsivewrappers\Form\ResponsiveWrappersSettings

Configure Responsive wrappers settings.

Hierarchy

Expanded class hierarchy of ResponsiveWrappersSettings

1 string reference to 'ResponsiveWrappersSettings'
responsivewrappers.routing.yml in ./responsivewrappers.routing.yml
responsivewrappers.routing.yml

File

src/Form/ResponsiveWrappersSettings.php, line 11

Namespace

Drupal\responsivewrappers\Form
View source 
class ResponsiveWrappersSettings extends ConfigFormBase {

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'responsivewrappers_settings';
  }

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() {
    return [
      'responsivewrappers.settings',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('responsivewrappers.settings');
    $form['version'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Bootstrap output version'),
      '#options' => [
        3 => $this
          ->t('Bootstrap 3'),
        4 => $this
          ->t('Bootstrap 4'),
        5 => $this
          ->t('Bootstrap 5'),
        0 => $this
          ->t('Custom'),
      ],
      '#default_value' => $config
        ->get('version'),
      '#description' => $this
        ->t('The HTML output for responsive images or tables has changed between Bootstrap 3 and Bootstrap 4/5. You can choose witch output version you want, for example bootstrap 3 uses img-responsive class and bootstrap 4/5 img-fluid.'),
    ];
    $form['add_css'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Attach responsive wrappers CSS'),
      '#options' => [
        0 => $this
          ->t('No'),
        1 => $this
          ->t('Yes'),
      ],
      '#default_value' => $config
        ->get('add_css'),
      '#description' => $this
        ->t('If you are using a Bootstrap 3/4/5 theme or subtheme the responsive classes works without any extra CSS, if not you can use this to add the CSS styles needed to work.'),
    ];

    // Custom classes.
    $form['custom_classes'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Custom classes'),
      '#description' => $this
        ->t('Custom responsive classes. Choose "Custom" in bootstrap output version to change this custom classes.'),
    ];
    $form['custom_classes']['image_class'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Custom image class'),
      '#default_value' => $config
        ->get('image_class'),
    ];
    $form['custom_classes']['iframe_wrapper_class'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Custom iframe wrapper class'),
      '#default_value' => $config
        ->get('iframe_wrapper_class'),
    ];
    $form['custom_classes']['iframe_class'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Custom iframe class'),
      '#default_value' => $config
        ->get('iframe_class'),
    ];
    $form['custom_classes']['table_wrapper_class'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Custom table wrapper class'),
      '#default_value' => $config
        ->get('table_wrapper_class'),
    ];
    $form['custom_classes']['table_class'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Custom table class'),
      '#default_value' => $config
        ->get('table_class'),
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $version = (int) $form_state
      ->getValue('version');

    // Bootstrap image classes.
    if (3 === $version) {
      $image_class = 'img-responsive';
    }
    elseif (4 === $version || 5 === $version) {
      $image_class = 'img-fluid';
    }
    else {
      $image_class = trim($form_state
        ->getValue('image_class'));
    }

    // Bootstrap iframe classes.
    if ($version > 0) {
      $iframe_wrapper_class = 'embed-responsive embed-responsive-16by9';
      $iframe_class = 'embed-responsive-item';
    }
    else {
      $iframe_wrapper_class = trim($form_state
        ->getValue('iframe_wrapper_class'));
      $iframe_class = trim($form_state
        ->getValue('iframe_class'));
    }

    // Bootstrap table classes.
    if ($version > 0) {
      $table_wrapper_class = 'table-responsive';
      $table_class = 'table';
    }
    else {
      $table_wrapper_class = trim($form_state
        ->getValue('table_wrapper_class'));
      $table_class = trim($form_state
        ->getValue('table_class'));
    }
    $config = $this
      ->config('responsivewrappers.settings');
    $config
      ->set('add_css', $form_state
      ->getValue('add_css'))
      ->set('version', $version)
      ->set('image_class', $image_class)
      ->set('iframe_wrapper_class', $iframe_wrapper_class)
      ->set('iframe_class', $iframe_class)
      ->set('table_wrapper_class', $table_wrapper_class)
      ->set('table_class', $table_class)
      ->save();
    parent::submitForm($form, $form_state);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigFormBase::create public static function Instantiates a new instance of this class. Overrides FormBase::create 18
ConfigFormBase::__construct public function Constructs a \Drupal\system\ConfigFormBase object. 16
ConfigFormBaseTrait::config protected function Retrieves a configuration object.
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
FormBase::$configFactory protected property The config factory. 3
FormBase::$requestStack protected property The request stack. 1
FormBase::$routeMatch protected property The route match.
FormBase::configFactory protected function Gets the config factory for this form. 3
FormBase::container private function Returns the service container.
FormBase::currentUser protected function Gets the current user.
FormBase::getRequest protected function Gets the request object.
FormBase::getRouteMatch protected function Gets the route match.
FormBase::logger protected function Gets the logger for a specific channel.
FormBase::redirect protected function Returns a redirect response object for the specified route.
FormBase::resetConfigFactory public function Resets the configuration factory.
FormBase::setConfigFactory public function Sets the config factory for this form.
FormBase::setRequestStack public function Sets the request stack object to use.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 72
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 27
MessengerTrait::messenger public function Gets the messenger. 27
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
ResponsiveWrappersSettings::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
ResponsiveWrappersSettings::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
ResponsiveWrappersSettings::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
ResponsiveWrappersSettings::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
StringTranslationTrait::$stringTranslation protected property The string translation service. 4
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.