class SettingsForm in Advanced CSS/JS Aggregation 8.2

Configure advagg_css_minify 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_css_minify\Form\SettingsForm

1 string reference to 'SettingsForm'

advagg_css_minify.routing.yml in advagg_css_minify/advagg_css_minify.routing.yml

advagg_css_minify/advagg_css_minify.routing.yml

File

advagg_css_minify/src/Form/SettingsForm.php, line 19

Namespace

Drupal\advagg_css_minify\Form

class SettingsForm extends ConfigFormBase {

  /**
   * The CSS asset collection optimizer service.
   *
   * @var \Drupal\Core\Asset\AssetCollectionOptimizerInterface
   */
  protected $cssCollectionOptimizer;

  /**
   * The AdvAgg file status state information storage service.
   *
   * @var \Drupal\Core\State\StateInterface
   */
  protected $advaggFiles;

  /**
   * A CSS asset optimizer.
   *
   * @var \Drupal\advagg_css_minify\Asset\CssOptimizer
   */
  protected $optimizer;

  /**
   * Constructs a SettingsForm object.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The factory for configuration objects.
   * @param \Drupal\Core\Asset\AssetCollectionOptimizerInterface $css_collection_optimizer
   *   The CSS asset collection optimizer service.
   * @param \Drupal\Core\State\StateInterface $advagg_files
   *   The AdvAgg file status state information storage service.
   * @param \Drupal\Core\Asset\AssetOptimizerInterface $optimizer
   *   The optimizer for a single CSS asset.
   */
  public function __construct(ConfigFactoryInterface $config_factory, AssetCollectionOptimizerInterface $css_collection_optimizer, StateInterface $advagg_files, AssetOptimizerInterface $optimizer) {
    parent::__construct($config_factory);
    $this->cssCollectionOptimizer = $css_collection_optimizer;
    $this->advaggFiles = $advagg_files;
    $this->optimizer = $optimizer;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('config.factory'), $container
      ->get('asset.css.collection_optimizer'), $container
      ->get('state.advagg.files'), $container
      ->get('asset.css.optimizer'));
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('advagg_css_minify.settings');
    $form = [];
    if ($this
      ->config('advagg.settings')
      ->get('cache_level') < 0) {
      $form['advagg_devel_msg'] = [
        '#markup' => '<p>' . $this
          ->t('The settings below will not have any effect because AdvAgg is currently in <a href="@devel">development mode</a>. Once the cache settings have been set to normal or higher, CSS minification will take place.', [
          '@devel' => Url::fromRoute('advagg.settings', [], [
            'fragment' => 'edit-advagg-cache-level',
          ])
            ->toString(),
        ]) . '</p>',
      ];
    }
    if (method_exists($this->optimizer, 'getConfiguration')) {
      list($options, $description) = $this->optimizer
        ->getConfiguration();
    }
    else {
      $description = '';
      $options = [
        0 => $this
          ->t('Disabled'),
        1 => $this
          ->t('Core'),
        2 => $this
          ->t('YUI'),
      ];

      // Allow for other modules to alter this list.
      $options_desc = [
        $options,
        $description,
      ];
      list($options, $description) = $options_desc;
    }
    $form['minifier'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Minification: Select a default minifier'),
      '#default_value' => $config
        ->get('minifier'),
      '#options' => $options,
      '#description' => Xss::filter($description),
    ];
    $options[-1] = $this
      ->t('Default');
    ksort($options);
    $form['per_file_settings'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Per File Settings'),
    ];
    $files = $this->advaggFiles
      ->getAll();
    $file_settings = $config
      ->get('file_settings');
    if ($file_settings) {
      $file_settings = array_column($file_settings, 'minifier', 'path');
    }
    foreach ($files as $name => $info) {
      if ($info['fileext'] !== 'css') {
        continue;
      }
      $dir = dirname($name);
      if (!isset($form['per_file_settings'][$dir])) {
        $form['per_file_settings'][$dir] = [
          '#type' => 'details',
          '#title' => $dir,
        ];
      }
      $form_api_filename = str_replace([
        '/',
        '.',
      ], [
        '__',
        '--',
      ], $name);
      $form['per_file_settings'][$dir]['advagg_css_minify_file_settings_' . $form_api_filename] = [
        '#type' => 'radios',
        '#title' => $this
          ->t('%filename: Select a minifier', [
          '%filename' => $name,
        ]),
        '#default_value' => isset($file_settings[$name]) ? $file_settings[$name] : -1,
        '#options' => $options,
      ];
      if ($form['per_file_settings'][$dir]['advagg_css_minify_file_settings_' . $form_api_filename]['#default_value'] != -1) {
        $form['per_file_settings'][$dir]['#open'] = TRUE;
        $form['per_file_settings']['#open'] = TRUE;
      }
    }

    // No css files are found.
    if (empty($files)) {
      $form['per_file_settings']['#description'] = $this
        ->t('No CSS files have been aggregated. You need to enable aggregation. No css files where found in the advagg_files table.');
    }
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $config = $this
      ->config('advagg_css_minify.settings');

    // Extract/combine per file settings.
    if ($file_settings = $config
      ->get('file_settings')) {
      $file_settings = array_column($file_settings, NULL, 'path');
    }
    else {
      $file_settings = [];
    }
    foreach ($form_state
      ->getValues() as $key => $value) {

      // Skip if not advagg_css_minify_file_settings.
      if (strpos($key, 'advagg_css_minify_file_settings_') === FALSE) {
        continue;
      }
      $path = str_replace([
        '__',
        '--',
      ], [
        '/',
        '.',
      ], substr($key, 32));
      if ($value == -1) {
        unset($file_settings[$path]);
        continue;
      }
      else {
        $file_settings[$path] = [
          'path' => $path,
          'minifier' => $value,
        ];
      }
    }

    // Clear relevant caches.
    $this->cssCollectionOptimizer
      ->deleteAll();
    Cache::invalidateTags([
      'library_info',
      'advagg_css',
    ]);
    $config = $this
      ->config('advagg_css_minify.settings')
      ->set('minifier', $form_state
      ->getValue('minifier'))
      ->set('file_settings', array_values($file_settings))
      ->save();
    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::$advaggFiles	protected	property	The AdvAgg file status state information storage service.
SettingsForm::$cssCollectionOptimizer	protected	property	The CSS asset collection optimizer service.
SettingsForm::$optimizer	protected	property	A CSS asset optimizer.
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.