class CssLintForm in Advanced CSS/JS Aggregation 8.3

Configure form for CSSHint validation of CSS files.

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\Form\AdvaggFormBase
      • class \Drupal\advagg_validator\Form\BaseValidatorForm
        • class \Drupal\advagg_validator\Form\CssLintForm

1 string reference to 'CssLintForm'

advagg_validator.routing.yml in advagg_validator/advagg_validator.routing.yml

advagg_validator/advagg_validator.routing.yml

File

advagg_validator/src/Form/CssLintForm.php, line 10

Namespace

Drupal\advagg_validator\Form

class CssLintForm extends BaseValidatorForm {

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form = parent::generateForm('css');
    $rules = [];
    if (file_exists(DRUPAL_ROOT . '/.csslintrc')) {
      $rule_string = file_get_contents(DRUPAL_ROOT . '/.csslintrc');
      if (empty($rule_string)) {
      }
      elseif (substr($rule_string, 0, 1) === '{') {
        $rules = json_decode($rule_string, TRUE);
      }
      elseif (substr($rule_string, 0, 1) === '-') {
        $rules = $this
          ->decodeRules($rule_string);
      }
    }
    $form['#attached']['library'][] = 'advagg_validator/csslint';
    $form['#attached']['drupalSettings']['csslint'] = [
      'rules' => $rules,
    ];
    $form = parent::buildForm($form, $form_state);
    unset($form['actions']);
    return $form;
  }

  /**
   * Decode a .csslintrc file to rules array.
   *
   * @param string $rule_string
   *   The raw rule string.
   *
   * @return array
   *   The rules array.
   */
  protected function decodeRules($rule_string) {
    $values = [
      'errors' => 2,
      'warning' => 1,
      'ignore' => 0,
      'exclude-list' => 1,
    ];
    $rules = [];
    $group = '';
    $raw = explode("\n", $rule_string);
    foreach ($raw as $rule) {
      if (empty($rule)) {
        continue;
      }
      if (substr($rule, 0, 1) === '-') {
        $split = explode('=', trim($rule, " \t\n\r\0\v-,"));
        $group = $split[0];
        $rules[$group] = [];
        if (isset($split[1])) {
          $rules[$group][$split[1]] = $values[$group];
        }
        continue;
      }
      $rules[$group][trim($rule, " \t\n\r\0\v,")] = $values[$group];
    }
    return $rules;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AdvaggFormBase::$requestStack	protected	property	The request stack. Overrides FormBase::$requestStack
AdvaggFormBase::create	public static	function	Instantiates a new instance of this class. Overrides ConfigFormBase::create	1
AdvaggFormBase::isAjax	protected	function	Checks if the form was submitted by AJAX.
AdvaggFormBase::__construct	public	function	Constructs a SettingsForm object. Overrides ConfigFormBase::__construct	1
BaseValidatorForm::domExtractor	protected	function	Extract info from the DOMNode Object.
BaseValidatorForm::generateForm	public	function	Generate a hierarchical form sorted by path from asset files.
BaseValidatorForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
BaseValidatorForm::getElement	protected	function	Get array element that corresponds to directory.
BaseValidatorForm::hideGoodFiles	protected	function	Do not display info on a file if it is valid.
BaseValidatorForm::scanAllDirs	protected	function	Recursively scan the drupal webroot for files matching the given extension.
BaseValidatorForm::scanDirectory	protected	function	Finds all files that match a given mask in a given directory.
BaseValidatorForm::testFiles	protected	function	Perform server side test(s) on all given files.	1
ConfigFormBase::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm	26
ConfigFormBaseTrait::config	protected	function	Retrieves a configuration object.
CssLintForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
CssLintForm::decodeRules	protected	function	Decode a .csslintrc file to rules array.
CssLintForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
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::$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.