class PerformanceForm

Same name and namespace in other branches
  1. 9 core/modules/system/src/Form/PerformanceForm.php \Drupal\system\Form\PerformanceForm
  2. 10 core/modules/system/src/Form/PerformanceForm.php \Drupal\system\Form\PerformanceForm
  3. 11.x core/modules/system/src/Form/PerformanceForm.php \Drupal\system\Form\PerformanceForm

Configure performance settings for this site.

@internal

Hierarchy

Expanded class hierarchy of PerformanceForm

1 string reference to 'PerformanceForm'
system.routing.yml in core/modules/system/system.routing.yml
core/modules/system/system.routing.yml

File

core/modules/system/src/Form/PerformanceForm.php, line 19

Namespace

Drupal\system\Form
View source
class PerformanceForm extends ConfigFormBase {
    
    /**
     * The date formatter service.
     *
     * @var \Drupal\Core\Datetime\DateFormatterInterface
     */
    protected $dateFormatter;
    
    /**
     * The CSS asset collection optimizer service.
     *
     * @var \Drupal\Core\Asset\AssetCollectionOptimizerInterface
     */
    protected $cssCollectionOptimizer;
    
    /**
     * The JavaScript asset collection optimizer service.
     *
     * @var \Drupal\Core\Asset\AssetCollectionOptimizerInterface
     */
    protected $jsCollectionOptimizer;
    
    /**
     * The module handler.
     *
     * @var \Drupal\Core\Extension\ModuleHandlerInterface
     */
    protected $moduleHandler;
    
    /**
     * Constructs a PerformanceForm object.
     *
     * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
     *   The factory for configuration objects.
     * @param \Drupal\Core\Datetime\DateFormatterInterface $date_formatter
     *   The date formatter service.
     * @param \Drupal\Core\Asset\AssetCollectionOptimizerInterface $css_collection_optimizer
     *   The CSS asset collection optimizer service.
     * @param \Drupal\Core\Asset\AssetCollectionOptimizerInterface $js_collection_optimizer
     *   The JavaScript asset collection optimizer service.
     * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
     *   The module handler.
     */
    public function __construct(ConfigFactoryInterface $config_factory, DateFormatterInterface $date_formatter, AssetCollectionOptimizerInterface $css_collection_optimizer, AssetCollectionOptimizerInterface $js_collection_optimizer, ModuleHandlerInterface $module_handler) {
        parent::__construct($config_factory);
        $this->dateFormatter = $date_formatter;
        $this->cssCollectionOptimizer = $css_collection_optimizer;
        $this->jsCollectionOptimizer = $js_collection_optimizer;
        $this->moduleHandler = $module_handler;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container) {
        return new static($container->get('config.factory'), $container->get('date.formatter'), $container->get('asset.css.collection_optimizer'), $container->get('asset.js.collection_optimizer'), $container->get('module_handler'));
    }
    
    /**
     * {@inheritdoc}
     */
    public function getFormId() {
        return 'system_performance_settings';
    }
    
    /**
     * {@inheritdoc}
     */
    protected function getEditableConfigNames() {
        return [
            'system.performance',
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildForm(array $form, FormStateInterface $form_state) {
        $form['#attached']['library'][] = 'system/drupal.system';
        $config = $this->config('system.performance');
        $form['clear_cache'] = [
            '#type' => 'details',
            '#title' => t('Clear cache'),
            '#open' => TRUE,
        ];
        $form['clear_cache']['clear'] = [
            '#type' => 'submit',
            '#value' => t('Clear all caches'),
            '#submit' => [
                '::submitCacheClear',
            ],
        ];
        $form['caching'] = [
            '#type' => 'details',
            '#title' => t('Caching'),
            '#open' => TRUE,
        ];
        // Identical options to the ones for block caching.
        // @see \Drupal\Core\Block\BlockBase::buildConfigurationForm()
        $period = [
            0,
            60,
            180,
            300,
            600,
            900,
            1800,
            2700,
            3600,
            10800,
            21600,
            32400,
            43200,
            86400,
        ];
        $period = array_map([
            $this->dateFormatter,
            'formatInterval',
        ], array_combine($period, $period));
        $period[0] = '<' . t('no caching') . '>';
        $form['caching']['page_cache_maximum_age'] = [
            '#type' => 'select',
            '#title' => t('Browser and proxy cache maximum age'),
            '#default_value' => $config->get('cache.page.max_age'),
            '#options' => $period,
            '#description' => t('This is used as the value for max-age in Cache-Control headers.'),
        ];
        $form['caching']['internal_page_cache'] = [
            '#markup' => $this->t('Drupal provides an <a href=":module_enable">Internal Page Cache module</a> that is recommended for small to medium-sized websites.', [
                ':module_enable' => Url::fromRoute('system.modules_list')->toString(),
            ]),
            '#access' => !$this->moduleHandler
                ->moduleExists('page_cache'),
        ];
        $directory = 'public://';
        $is_writable = is_dir($directory) && is_writable($directory);
        $disabled = !$is_writable;
        $disabled_message = '';
        if (!$is_writable) {
            $disabled_message = ' ' . t('<strong class="error">Set up the <a href=":file-system">public files directory</a> to make these optimizations available.</strong>', [
                ':file-system' => Url::fromRoute('system.file_system_settings')->toString(),
            ]);
        }
        $form['bandwidth_optimization'] = [
            '#type' => 'details',
            '#title' => t('Bandwidth optimization'),
            '#open' => TRUE,
            '#description' => t('External resources can be optimized automatically, which can reduce both the size and number of requests made to your website.') . $disabled_message,
        ];
        $form['bandwidth_optimization']['preprocess_css'] = [
            '#type' => 'checkbox',
            '#title' => t('Aggregate CSS files'),
            '#default_value' => $config->get('css.preprocess'),
            '#disabled' => $disabled,
        ];
        $form['bandwidth_optimization']['preprocess_js'] = [
            '#type' => 'checkbox',
            '#title' => t('Aggregate JavaScript files'),
            '#default_value' => $config->get('js.preprocess'),
            '#disabled' => $disabled,
        ];
        return parent::buildForm($form, $form_state);
    }
    
    /**
     * {@inheritdoc}
     */
    public function submitForm(array &$form, FormStateInterface $form_state) {
        $this->cssCollectionOptimizer
            ->deleteAll();
        $this->jsCollectionOptimizer
            ->deleteAll();
        $this->config('system.performance')
            ->set('cache.page.max_age', $form_state->getValue('page_cache_maximum_age'))
            ->set('css.preprocess', $form_state->getValue('preprocess_css'))
            ->set('js.preprocess', $form_state->getValue('preprocess_js'))
            ->save();
        parent::submitForm($form, $form_state);
    }
    
    /**
     * Clears the caches.
     */
    public function submitCacheClear(array &$form, FormStateInterface $form_state) {
        drupal_flush_all_caches();
        $this->messenger()
            ->addStatus($this->t('Caches cleared.'));
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title 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. 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. 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 73
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. 17
MessengerTrait::messenger public function Gets the messenger. 17
MessengerTrait::setMessenger public function Sets the messenger.
PerformanceForm::$cssCollectionOptimizer protected property The CSS asset collection optimizer service.
PerformanceForm::$dateFormatter protected property The date formatter service.
PerformanceForm::$jsCollectionOptimizer protected property The JavaScript asset collection optimizer service.
PerformanceForm::$moduleHandler protected property The module handler.
PerformanceForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
PerformanceForm::create public static function Instantiates a new instance of this class. Overrides ConfigFormBase::create
PerformanceForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
PerformanceForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
PerformanceForm::submitCacheClear public function Clears the caches.
PerformanceForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
PerformanceForm::__construct public function Constructs a PerformanceForm object. Overrides ConfigFormBase::__construct
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a &#039;destination&#039; 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.
StringTranslationTrait::$stringTranslation protected property The string translation service.
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.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.