Same name in this branch
  1. 6.0.x advagg_bundler/src/Form/SettingsForm.php \Drupal\advagg_bundler\Form\SettingsForm
  2. 6.0.x advagg_css_minify/src/Form/SettingsForm.php \Drupal\advagg_css_minify\Form\SettingsForm
  3. 6.0.x advagg_js_minify/src/Form/SettingsForm.php \Drupal\advagg_js_minify\Form\SettingsForm
  4. 6.0.x src/Form/SettingsForm.php \Drupal\advagg\Form\SettingsForm
  5. 6.0.x advagg_ext_minify/src/Form/SettingsForm.php \Drupal\advagg_ext_minify\Form\SettingsForm
Same name and namespace in other branches
  1. 5.0.x advagg_old_ie_compatibility/src/Form/SettingsForm.php \Drupal\advagg_old_ie_compatibility\Form\SettingsForm 1 comment
  2. 5.0.x advagg_bundler/src/Form/SettingsForm.php \Drupal\advagg_bundler\Form\SettingsForm 1 comment
  3. 5.0.x advagg_css_minify/src/Form/SettingsForm.php \Drupal\advagg_css_minify\Form\SettingsForm 1 comment
  4. 5.0.x advagg_js_minify/src/Form/SettingsForm.php \Drupal\advagg_js_minify\Form\SettingsForm 1 comment
  5. 5.0.x src/Form/SettingsForm.php \Drupal\advagg\Form\SettingsForm 1 comment
  6. 5.0.x advagg_cdn/src/Form/SettingsForm.php \Drupal\advagg_cdn\Form\SettingsForm 1 comment
  7. 5.0.x advagg_ext_minify/src/Form/SettingsForm.php \Drupal\advagg_ext_minify\Form\SettingsForm 1 comment
  8. 5.0.x advagg_mod/src/Form/SettingsForm.php \Drupal\advagg_mod\Form\SettingsForm 1 comment
  9. 8.x-2.x advagg_bundler/src/Form/SettingsForm.php \Drupal\advagg_bundler\Form\SettingsForm 1 comment
  10. 8.x-2.x advagg_css_minify/src/Form/SettingsForm.php \Drupal\advagg_css_minify\Form\SettingsForm 1 comment
  11. 8.x-2.x advagg_js_minify/src/Form/SettingsForm.php \Drupal\advagg_js_minify\Form\SettingsForm 1 comment
  12. 8.x-2.x src/Form/SettingsForm.php \Drupal\advagg\Form\SettingsForm 1 comment
  13. 8.x-2.x advagg_cdn/src/Form/SettingsForm.php \Drupal\advagg_cdn\Form\SettingsForm 1 comment
  14. 8.x-2.x advagg_ext_minify/src/Form/SettingsForm.php \Drupal\advagg_ext_minify\Form\SettingsForm 1 comment
  15. 8.x-2.x advagg_mod/src/Form/SettingsForm.php \Drupal\advagg_mod\Form\SettingsForm 1 comment
  16. 8.x-3.x advagg_old_ie_compatibility/src/Form/SettingsForm.php \Drupal\advagg_old_ie_compatibility\Form\SettingsForm 1 comment
  17. 8.x-3.x advagg_bundler/src/Form/SettingsForm.php \Drupal\advagg_bundler\Form\SettingsForm 1 comment
  18. 8.x-3.x advagg_css_minify/src/Form/SettingsForm.php \Drupal\advagg_css_minify\Form\SettingsForm 1 comment
  19. 8.x-3.x advagg_js_minify/src/Form/SettingsForm.php \Drupal\advagg_js_minify\Form\SettingsForm 1 comment
  20. 8.x-3.x src/Form/SettingsForm.php \Drupal\advagg\Form\SettingsForm 1 comment
  21. 8.x-3.x advagg_cdn/src/Form/SettingsForm.php \Drupal\advagg_cdn\Form\SettingsForm 1 comment
  22. 8.x-3.x advagg_ext_minify/src/Form/SettingsForm.php \Drupal\advagg_ext_minify\Form\SettingsForm 1 comment
  23. 8.x-3.x advagg_mod/src/Form/SettingsForm.php \Drupal\advagg_mod\Form\SettingsForm 1 comment
  24. 8.x-4.x advagg_old_ie_compatibility/src/Form/SettingsForm.php \Drupal\advagg_old_ie_compatibility\Form\SettingsForm 1 comment
  25. 8.x-4.x advagg_bundler/src/Form/SettingsForm.php \Drupal\advagg_bundler\Form\SettingsForm 1 comment
  26. 8.x-4.x advagg_css_minify/src/Form/SettingsForm.php \Drupal\advagg_css_minify\Form\SettingsForm 1 comment
  27. 8.x-4.x advagg_js_minify/src/Form/SettingsForm.php \Drupal\advagg_js_minify\Form\SettingsForm 1 comment
  28. 8.x-4.x src/Form/SettingsForm.php \Drupal\advagg\Form\SettingsForm 1 comment
  29. 8.x-4.x advagg_cdn/src/Form/SettingsForm.php \Drupal\advagg_cdn\Form\SettingsForm 1 comment
  30. 8.x-4.x advagg_ext_minify/src/Form/SettingsForm.php \Drupal\advagg_ext_minify\Form\SettingsForm 1 comment
  31. 8.x-4.x advagg_mod/src/Form/SettingsForm.php \Drupal\advagg_mod\Form\SettingsForm 1 comment

Configure advagg_mod settings for this site.

Hierarchy

Expanded class hierarchy of SettingsForm

1 file declares its use of SettingsForm
SettingsFormTest.php in advagg_mod/tests/src/Kernel/Form/SettingsFormTest.php
1 string reference to 'SettingsForm'
advagg_mod.routing.yml in advagg_mod/advagg_mod.routing.yml
advagg_mod/advagg_mod.routing.yml

File

advagg_mod/src/Form/SettingsForm.php, line 16

Namespace

Drupal\advagg_mod\Form
View source
class SettingsForm extends ConfigFormBase {
    use AdvaggSettersTrait;
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container) {
        
        /**
         * @var \Drupal\advagg_mod\Form\SettingsForm
         */
        $instance = parent::create($container);
        $instance->setCache($container->get('cache.advagg'));
        $instance->setLanguageManager($container->get('language_manager'));
        $instance->setModuleHandler($container->get('module_handler'));
        return $instance;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getFormId() {
        return 'advagg_mod_settings';
    }
    
    /**
     * {@inheritdoc}
     */
    protected function getEditableConfigNames() {
        return [
            'advagg_mod.settings',
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildForm(array $form, FormStateInterface $form_state) {
        $config = $this->config('advagg_mod.settings');
        $form = [];
        $form['js'] = [
            '#type' => 'details',
            '#title' => $this->t('JS'),
            '#open' => TRUE,
        ];
        $form['js']['js_preprocess'] = [
            '#type' => 'checkbox',
            '#title' => $this->t('Enable preprocess on all JS'),
            '#default_value' => $config->get('js_preprocess'),
            '#description' => $this->t('Force all JavaScript to have the preprocess attribute be set to TRUE. All JavaScript files will be aggregated if enabled.'),
        ];
        $form['js']['js_remove_console_log'] = [
            '#type' => 'checkbox',
            '#title' => $this->t('Remove console logging from JS files.'),
            '#default_value' => $config->get('js_remove_console_log'),
            '#description' => $this->t('Harmless under most cases, but may make debugging difficult. WARNING: experimental.'),
        ];
        // Optimize JavaScript Ordering.
        $form['js']['adjust_sort'] = [
            '#type' => 'details',
            '#open' => TRUE,
            '#title' => $this->t('Optimize JavaScript Ordering'),
            '#description' => $this->t('The settings in here might change the order in which the JavaScript is loaded. It will move the scripts around so that more optimal aggregates are built. In most cases enabling these checkboxes will cause no negative side effects.'),
        ];
        $form['js']['adjust_sort']['js_adjust_sort_external'] = [
            '#type' => 'checkbox',
            '#title' => $this->t('Move all external scripts to the top of the execution order'),
            '#default_value' => $config->get('js_adjust_sort_external'),
            '#description' => $this->t('This will group all external JavaScript files to be above all other JavaScript.'),
        ];
        $form['js']['adjust_sort']['js_adjust_sort_browsers'] = [
            '#type' => 'checkbox',
            '#title' => $this->t('Move all browser conditional JavaScript to the bottom of the group'),
            '#default_value' => $config->get('js_adjust_sort_browsers'),
            '#description' => $this->t('This will group all browser conditional JavaScript to be in the lowest group of that conditional rule.'),
        ];
        // Adjust javascript location and execution.
        $form['js']['placement'] = [
            '#type' => 'details',
            '#open' => TRUE,
            '#title' => $this->t('Adjust javascript location and execution'),
            '#description' => $this->t('Most of the time adjusting the settings are safe but in some rare cases adjusting these can cause serious JavaScript issues with your site.'),
        ];
        $form['js']['placement']['js_defer'] = [
            '#type' => 'radios',
            '#title' => $this->t('Deferred JavaScript Execution: Add The defer Tag To All Script Tags'),
            '#default_value' => $config->get('js_defer'),
            '#options' => [
                0 => $this->t('Disabled'),
                2 => $this->t('All but external scripts'),
                1 => $this->t('All (might break things)'),
            ],
            '#description' => $this->t('This will delay the script execution until the HTML parser has finished. This will have a similar effect to moving all JavaScript to the footer. This might break javascript (especially inline); only use after extensive testing! <a href="@link">More Info</a>', [
                '@link' => 'http://peter.sh/experiments/asynchronous-and-deferred-javascript-execution-explained/',
            ]),
        ];
        $form['js']['placement']['expert'] = [
            '#type' => 'details',
            '#title' => $this->t('Experimental Settings'),
            '#open' => $config->get('js_async'),
        ];
        $form['js']['placement']['expert']['js_async'] = [
            '#type' => 'checkbox',
            '#title' => $this->t('Here there be dragons! Asynchronous JavaScript Execution: Add The async Tag To All Script Tags'),
            '#default_value' => $config->get('js_async'),
            '#description' => $this->t('This will cause the script to be downloaded in the background and executed out of order. This will break most javascript as most code is not async safe; only use after extensive testing! <a href="@link">More Info</a>', [
                '@link' => 'http://peter.sh/experiments/asynchronous-and-deferred-javascript-execution-explained/',
            ]),
        ];
        $form['js']['placement']['expert']['js_async_in_header'] = [
            '#type' => 'checkbox',
            '#title' => $this->t('Asynchronous JavaScript Execution: Group together in the header'),
            '#default_value' => $config->get('js_async_in_header'),
            '#description' => $this->t('This will move all async JavaScript code to the header in the same group.'),
        ];
        $form['css'] = [
            '#type' => 'details',
            '#title' => $this->t('CSS'),
            '#open' => TRUE,
        ];
        $form['css']['css_preprocess'] = [
            '#type' => 'checkbox',
            '#title' => $this->t('Enable preprocess on all CSS'),
            '#default_value' => $config->get('css_preprocess'),
            '#description' => $this->t('Force all CSS to have the preprocess attribute be set to TRUE. All CSS files will be aggregated if enabled.'),
        ];
        $form['css']['css_preprocess']['#description'] .= $this->moduleHandler
            ->moduleExists('advagg_bundler') ? ' ' . $this->t('You might want to increase the <a href="@link">CSS Bundles Per Page</a> if this is checked.', [
            '@link' => Url::fromRoute('advagg_bundler.settings')->toString(),
        ]) : '';
        // Only test the translate option if
        // the locale function is defined OR
        // the locale_custom_strings variable is not empty.
        $lang = isset($this->languageManager
            ->getCurrentLanguage()->language) ? $this->languageManager
            ->getCurrentLanguage()->language : 'en';
        $locale_custom_strings = Settings::get('locale_custom_strings_' . $lang, []);
        if (function_exists('locale') || !empty($locale_custom_strings)) {
            $form['css']['css_translate'] = [
                '#type' => 'checkbox',
                '#title' => $this->t('Translate CSS content strings'),
                '#default_value' => $config->get('css_translate'),
                '#description' => $this->t('Run strings inside of quotes of the content attribute through the <a href="@t">t() function</a>. An alternative to this can be found in this <a href="@post">blog post</a>.', [
                    '@t' => 'https://api.drupal.org/api/drupal/includes!bootstrap.inc/function/t/7',
                    '@post' => 'http://fourkitchens.com/blog/2013/08/15/multilingual-css-generated-content-drupal',
                ]),
            ];
        }
        // Optimize CSS Ordering.
        $form['css']['adjust_sort'] = [
            '#type' => 'details',
            '#open' => TRUE,
            '#title' => $this->t('Optimize CSS Ordering'),
            '#description' => $this->t('The settings in here might change the order in which the CSS is loaded. It will move the CSS around so that more optimal aggregates are built. In most cases enabling these checkboxes will cause no negative side effects.'),
        ];
        $form['css']['adjust_sort']['css_adjust_sort_external'] = [
            '#type' => 'checkbox',
            '#title' => $this->t('Move all external CSS to the top of the execution order'),
            '#default_value' => $config->get('css_adjust_sort_external'),
            '#description' => $this->t('This will group all external CSS files to be above all other CSS.'),
        ];
        $form['css']['adjust_sort']['css_adjust_sort_browsers'] = [
            '#type' => 'checkbox',
            '#title' => $this->t('Move all browser conditional CSS to the bottom of the group'),
            '#default_value' => $config->get('css_adjust_sort_browsers'),
            '#description' => $this->t('This will group all browser conditional CSS to be in the lowest group of that conditional rule.'),
        ];
        // Adjust CSS location and execution.
        $form['css']['placement'] = [
            '#type' => 'details',
            '#title' => $this->t('Adjust CSS location and execution (Experimental)'),
            '#open' => $config->get('css_defer'),
        ];
        $form['css']['placement']['css_defer'] = [
            '#type' => 'radios',
            '#title' => $this->t('Deferred CSS Execution: Use JS to load CSS'),
            '#default_value' => $config->get('css_defer'),
            '#options' => [
                0 => $this->t('Disabled'),
                1 => $this->t('Enabled (In head)'),
            ],
            '#description' => $this->t('This will try to optimize CSS delivery by using JavaScript to load the CSS. This might break CSS on different browsers and will cause a flash of unstyled content (FOUC). Only enable after extensive testing! <a href="@link">More Info</a>', [
                '@link' => 'http://stackoverflow.com/questions/19374843/css-delivery-optimization-how-to-defer-css-loading',
            ]),
        ];
        $form['css']['placement']['css_defer_admin'] = [
            '#type' => 'checkbox',
            '#title' => $this->t('Use JS to load CSS in the admin theme'),
            '#default_value' => $config->get('css_defer_admin'),
            '#description' => $this->t('This will optimize CSS delivery with JavaScript when viewing the admin theme.'),
            '#states' => [
                'disabled' => [
                    ':input[name="css_defer"]' => [
                        'value' => '0',
                    ],
                ],
            ],
        ];
        $form['css']['placement']['css_defer_external'] = [
            '#type' => 'checkbox',
            '#title' => $this->t('Use JS to load external CSS'),
            '#default_value' => $config->get('css_defer_external'),
            '#description' => $this->t('This will optimize CSS delivery with JavaScript for external stylesheets.'),
            '#states' => [
                'disabled' => [
                    ':input[name="css_defer"]' => [
                        'value' => '0',
                    ],
                ],
            ],
        ];
        $form['css']['placement']['css_defer_js_code'] = [
            '#type' => 'radios',
            '#title' => $this->t('How to include the JS loading code'),
            '#default_value' => $config->get('css_defer_js_code'),
            '#options' => [
                0 => $this->t('Inline javascript loader library (If enabled this is recommended)'),
                2 => $this->t('Local file included in aggregate'),
                4 => $this->t('Externally load the latest from github'),
            ],
            '#description' => $this->t('The <a href="@link">loadCSS</a> library can be included in various ways.', [
                '@link' => 'https://github.com/filamentgroup/loadCSS',
            ]),
            '#states' => [
                'disabled' => [
                    ':input[name="css_defer"]' => [
                        'value' => '0',
                    ],
                ],
            ],
        ];
        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_mod.settings');
        $config->set('css_adjust_sort_browsers', $form_state->getValue('css_adjust_sort_browsers'))
            ->set('css_adjust_sort_external', $form_state->getValue('css_adjust_sort_external'))
            ->set('css_defer', $form_state->getValue('css_defer'))
            ->set('css_defer_admin', $form_state->getValue('css_defer_admin'))
            ->set('css_defer_external', $form_state->getValue('css_defer_external'))
            ->set('css_defer_js_code', $form_state->getValue('css_defer_js_code'))
            ->set('css_preprocess', $form_state->getValue('css_preprocess'))
            ->set('css_translate', $form_state->getValue('css_translate'))
            ->set('js_adjust_sort_browsers', $form_state->getValue('js_adjust_sort_browsers'))
            ->set('js_adjust_sort_external', $form_state->getValue('js_adjust_sort_external'))
            ->set('js_async', $form_state->getValue('js_async'))
            ->set('js_async_in_header', $form_state->getValue('js_async_in_header'))
            ->set('js_defer', $form_state->getValue('js_defer'))
            ->set('js_footer', $form_state->getValue('js_footer'))
            ->set('js_preprocess', $form_state->getValue('js_preprocess'))
            ->set('js_remove_console_log', $form_state->getValue('js_remove_console_log'))
            ->set('prefetch', $form_state->getValue('prefetch'))
            ->set('unified_multisite_dir', $form_state->getValue('unified_multisite_dir'))
            ->save();
        // Clear relevant caches.
        Cache::invalidateTags([
            'library_info',
        ]);
        $this->cache
            ->invalidateAll();
        parent::submitForm($form, $form_state);
    }

}

Members

Title Sort descending Modifiers Object type Summary Overrides
AdvaggSettersTrait::$cache protected property The AdvAgg cache. 2
AdvaggSettersTrait::$cssCollectionOptimizer protected property The CSS asset collection optimizer service.
AdvaggSettersTrait::$dateFormatter protected property The date formatter service. 1
AdvaggSettersTrait::$fileSystem protected property The File System service.
AdvaggSettersTrait::$httpClient protected property The Guzzle HTTP Client. 1
AdvaggSettersTrait::$jsCollectionOptimizer protected property The JavaScript asset collection optimizer service.
AdvaggSettersTrait::$languageManager protected property The core language manager service.
AdvaggSettersTrait::$moduleHandler protected property The module handler service.
AdvaggSettersTrait::$privateKey protected property The private key service.
AdvaggSettersTrait::$renderer protected property The Drupal renderer. 1
AdvaggSettersTrait::$state protected property The state service.
AdvaggSettersTrait::$themeRegistry protected property The theme registry service. 1
AdvaggSettersTrait::$time protected property Obtaining system time.
AdvaggSettersTrait::setCache public function The set cache backend.
AdvaggSettersTrait::setCssCollectionOptimizer public function Set CSS asset collection optimizer service.
AdvaggSettersTrait::setDateFomatter public function Set date formatter service.
AdvaggSettersTrait::setFileSystem public function Set File System service.
AdvaggSettersTrait::setHttpClient public function Set http client.
AdvaggSettersTrait::setJsCollectionOptimizer public function Set JavaScript asset collection optimizer service.
AdvaggSettersTrait::setLanguageManager public function Set language manager service.
AdvaggSettersTrait::setModuleHandler public function Set module handler.
AdvaggSettersTrait::setPrivateKey public function Set private key service.
AdvaggSettersTrait::setRenderer public function Set renderer.
AdvaggSettersTrait::setState public function Set state service.
AdvaggSettersTrait::setThemeRegistry public function The theme registry service.
AdvaggSettersTrait::setTime public function Obtaining system time.
SettingsForm::buildForm public function
SettingsForm::create public static function
SettingsForm::getEditableConfigNames protected function
SettingsForm::getFormId public function
SettingsForm::submitForm public function