class SettingsForm in Advanced CSS/JS Aggregation 8.3

Configure advagg bundler settings for this site.

Hierarchy

• class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
  • class \Drupal\Core\Form\ConfigFormBase uses ConfigFormBaseTrait
    • class \Drupal\advagg_bundler\Form\SettingsForm

1 string reference to 'SettingsForm'

advagg_bundler.routing.yml in advagg_bundler/advagg_bundler.routing.yml

advagg_bundler/advagg_bundler.routing.yml

File

advagg_bundler/src/Form/SettingsForm.php, line 15

Namespace

Drupal\advagg_bundler\Form

class SettingsForm extends ConfigFormBase {

  /**
   * The AdvAgg cache.
   *
   * @var \Drupal\Core\Cache\CacheBackendInterface
   */
  protected $cache;

  /**
   * Constructs a SettingsForm object.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The factory for configuration objects.
   * @param \Drupal\Core\Cache\CacheBackendInterface $cache
   *   The AdvAgg cache service.
   */
  public function __construct(ConfigFactoryInterface $config_factory, CacheBackendInterface $cache) {
    parent::__construct($config_factory);
    $this->cache = $cache;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('config.factory'), $container
      ->get('cache.advagg'));
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {

    /** @var \Drupal\Core\Config\Config $config */
    $config = $this
      ->config('advagg_bundler.settings');
    $form['active'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Bundler is Active'),
      '#default_value' => $config
        ->get('active'),
      '#description' => $this
        ->t('If not checked, the bundler will not split up aggregates.'),
    ];
    $options = [
      0 => 0,
      1 => 1,
      2 => 2,
      3 => 3,
      4 => 4,
      5 => 5,
      6 => 6,
      7 => 7,
      8 => 8,
      9 => 9,
      10 => 10,
      11 => 11,
      12 => 12,
      13 => 13,
      14 => 14,
      15 => 15,
    ];
    $form['css'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('CSS Bundling options.'),
    ];
    $form['css']['max_css'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Target Number Of CSS Bundles Per Page'),
      '#default_value' => $config
        ->get('css.max'),
      '#options' => $options,
      '#description' => $this
        ->t('If 0 is selected then the bundler is disabled'),
      '#states' => [
        'disabled' => [
          '#edit-active' => [
            'checked' => FALSE,
          ],
        ],
      ],
    ];
    $form['css']['css_logic'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Grouping logic'),
      '#default_value' => $config
        ->get('css.logic'),
      '#options' => [
        0 => $this
          ->t('File count'),
        1 => $this
          ->t('File size'),
      ],
      '#description' => $this
        ->t('If file count is selected then each bundle will try to have a similar number of original files aggregated inside of it. If file size is selected then each bundle will try to have a similar file size.'),
      '#states' => [
        'disabled' => [
          '#edit-active' => [
            'checked' => FALSE,
          ],
        ],
      ],
    ];
    $form['js'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('JavaScript Bundling options.'),
    ];
    $form['js']['max_js'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Target Number Of JS Bundles Per Page'),
      '#default_value' => $config
        ->get('js.max'),
      '#options' => $options,
      '#description' => $this
        ->t('If 0 is selected then the bundler is disabled'),
      '#states' => [
        'disabled' => [
          '#edit-active' => [
            'checked' => FALSE,
          ],
        ],
      ],
    ];
    $form['js']['js_logic'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Grouping logic'),
      '#default_value' => $config
        ->get('js.logic'),
      '#options' => [
        0 => $this
          ->t('File count'),
        1 => $this
          ->t('File size'),
      ],
      '#description' => $this
        ->t('If file count is selected then each bundle will try to have a similar number of original files aggregated inside of it. If file size is selected then each bundle will try to have a similar file size.'),
      '#states' => [
        'disabled' => [
          '#edit-active' => [
            'checked' => FALSE,
          ],
        ],
      ],
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {

    /** @var \Drupal\Core\Config\Config $config */
    $config = $this
      ->config('advagg_bundler.settings')
      ->set('active', $form_state
      ->getValue('active'))
      ->set('css.max', $form_state
      ->getValue('max_css'))
      ->set('css.logic', $form_state
      ->getValue('css_logic'))
      ->set('js.max', $form_state
      ->getValue('max_js'))
      ->set('js.logic', $form_state
      ->getValue('js_logic'));
    $config
      ->save();

    // Clear Caches.
    Cache::invalidateTags([
      'library_info',
    ]);
    $this->cache
      ->invalidateAll();
    parent::submitForm($form, $form_state);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigFormBaseTrait::config	protected	function	Retrieves a configuration object.
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
FormBase::$configFactory	protected	property	The config factory.	1
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.	1
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. Overrides UrlGeneratorTrait::redirect
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	62
LinkGeneratorTrait::$linkGenerator	protected	property	The link generator.	1
LinkGeneratorTrait::getLinkGenerator Deprecated	protected	function	Returns the link generator.
LinkGeneratorTrait::l Deprecated	protected	function	Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated	public	function	Sets the link generator service.
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.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
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.
SettingsForm::$cache	protected	property	The AdvAgg cache.
SettingsForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
SettingsForm::create	public static	function	Instantiates a new instance of this class. Overrides ConfigFormBase::create
SettingsForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
SettingsForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
SettingsForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
SettingsForm::__construct	public	function	Constructs a SettingsForm object. Overrides ConfigFormBase::__construct
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.
UrlGeneratorTrait::$urlGenerator	protected	property	The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated	protected	function	Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated	public	function	Sets the URL generator service.
UrlGeneratorTrait::url Deprecated	protected	function	Generates a URL or path for a specific route based on the given parameters.