class AdminCssEditor in Admin CSS 8.2

Admin CSS editor form.

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\admincss\Form\AdminCssEditor

Expanded class hierarchy of AdminCssEditor

1 string reference to 'AdminCssEditor'

admincss.routing.yml in ./admincss.routing.yml: admincss.routing.yml

File

src/Form/AdminCssEditor.php, line 17

Namespace

Drupal\admincss\Form

View source

class AdminCssEditor extends ConfigFormBase {

  /**
   * The file system.
   *
   * @var \Drupal\Core\File\FileSystemInterface
   */
  protected $fileSystem;

  /**
   * The cache tag invalidator.
   *
   * @var \Drupal\Core\Cache\CacheTagsInvalidatorInterface
   */
  protected $cacheTagsInvalidator;

  /**
   * 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;

  /**
   * Constructs a PerformanceForm object.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The factory for configuration objects.
   * @param \Drupal\Core\File\FileSystemInterface $file_system
   *   The file system.
   * @param \Drupal\Core\Cache\CacheTagsInvalidatorInterface $cache_tags_invalidator
   *   The cache tags invalidator 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.
   */
  public function __construct(ConfigFactoryInterface $config_factory, FileSystemInterface $file_system, CacheTagsInvalidatorInterface $cache_tags_invalidator, AssetCollectionOptimizerInterface $css_collection_optimizer, AssetCollectionOptimizerInterface $js_collection_optimizer) {
    parent::__construct($config_factory);
    $this->fileSystem = $file_system;
    $this->cacheTagsInvalidator = $cache_tags_invalidator;
    $this->cssCollectionOptimizer = $css_collection_optimizer;
    $this->jsCollectionOptimizer = $js_collection_optimizer;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('config.factory'), $container
      ->get('file_system'), $container
      ->get('cache_tags.invalidator'), $container
      ->get('asset.css.collection_optimizer'), $container
      ->get('asset.js.collection_optimizer'));
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form['custom_css'] = [
      '#prefix' => '<div class="admincss-ace-editor">',
      '#suffix' => '</div>',
      '#type' => 'textarea',
      '#title' => $this
        ->t('Custom CSS'),
      '#description' => $this
        ->t('The custom CSS code.'),
      '#default_value' => $this
        ->config('admincss.settings')
        ->get('custom_css'),
      '#rows' => 10,
      '#attributes' => [
        'class' => [
          'admincss__editor',
          'admincss__custom-css',
        ],
        'data-ace-mode' => 'css',
      ],
    ];
    $form['#attached']['library'][] = 'admincss/admincss.editor';
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $config = $this
      ->config('admincss.settings');
    $custom_css = $form_state
      ->getValue('custom_css');
    $config
      ->set('custom_css', $custom_css);
    $config
      ->save();
    $changed = FALSE;
    $destination_uri = 'public://admin-style.css';
    if (empty($custom_css)) {

      // Empty CSS, delete the file.
      try {
        $this->fileSystem
          ->delete($destination_uri);
        $changed = TRUE;
      } catch (FileException $e) {

        // Ignore and continue.
      }
    }
    elseif (file_save_data($custom_css, $destination_uri, FileSystemInterface::EXISTS_REPLACE)) {
      $changed = TRUE;
    }
    if ($changed) {

      // Flush the css/js asset cache.
      $this
        ->flushAssetCache();
    }
    else {
      $this
        ->messenger()
        ->addWarning($this
        ->t('Failed to successfully write the changes to disk.'));
    }
    parent::submitForm($form, $form_state);
  }

  /**
   * Flush the asset cache.
   *
   * @see drupal_flush_all_caches()
   */
  protected function flushAssetCache() {
    if ($this
      ->config('system.performance')
      ->get('css.preprocess')) {

      /*
       * CSS aggregation is enabled.
       * Clear the asset resolver cache typically used for storing the
       * aggregated files.
       * @see \Drupal\Core\Asset\AssetResolver::getCssAssets
       * @see \Drupal\Core\Asset\AssetResolver::getJsAssets
       *
       * The invalidation call might be potentially expensive to run.
       * Drupal should add an AssetResolver asset specific tag.
       *
       * An alternative is to disable preprocessing on the admincss asset.
       * But you lose the various optimizations Drupal provides.
       */
      $this->cacheTagsInvalidator
        ->invalidateTags([
        'library_info',
      ]);

      // Delete the optimized CSS and JS asset file caches.
      $this->cssCollectionOptimizer
        ->deleteAll();
      $this->jsCollectionOptimizer
        ->deleteAll();
    }
    else {

      // Regenerate the dummy query string.
      _drupal_flush_css_js();
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AdminCssEditor::$cacheTagsInvalidator	protected	property	The cache tag invalidator.
AdminCssEditor::$cssCollectionOptimizer	protected	property	The CSS asset collection optimizer service.
AdminCssEditor::$fileSystem	protected	property	The file system.
AdminCssEditor::$jsCollectionOptimizer	protected	property	The JavaScript asset collection optimizer service.
AdminCssEditor::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
AdminCssEditor::create	public static	function	Instantiates a new instance of this class. Overrides ConfigFormBase::create
AdminCssEditor::flushAssetCache	protected	function	Flush the asset cache.
AdminCssEditor::getEditableConfigNames	public	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
AdminCssEditor::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
AdminCssEditor::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
AdminCssEditor::__construct	public	function	Constructs a PerformanceForm object. Overrides ConfigFormBase::__construct
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.
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.

You are here

class AdminCssEditor in Admin CSS 8.2

Hierarchy

File

Namespace

Members

API Navigation