class BestPracticesSitesSuperfluous in Site Audit 8.3
Provides the BestPracticesSitesSuperfluous Check.
Plugin annotation
@SiteAuditCheck(
id = "best_practices_sites_superflouous",
name = @Translation("Superfluous files in /sites"),
description = @Translation("Detect unnecessary files."),
report = "best_practices"
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\site_audit\Plugin\SiteAuditCheckBase implements SiteAuditCheckInterface uses StringTranslationTrait
- class \Drupal\site_audit\Plugin\SiteAuditCheck\BestPracticesSitesSuperfluous
- class \Drupal\site_audit\Plugin\SiteAuditCheckBase implements SiteAuditCheckInterface uses StringTranslationTrait
Expanded class hierarchy of BestPracticesSitesSuperfluous
File
- src/
Plugin/ SiteAuditCheck/ BestPracticesSitesSuperfluous.php, line 17
Namespace
Drupal\site_audit\Plugin\SiteAuditCheckView source
class BestPracticesSitesSuperfluous extends SiteAuditCheckBase {
/**
* {@inheritdoc}.
*/
public function getResultFail() {
}
/**
* {@inheritdoc}.
*/
public function getResultInfo() {
}
/**
* {@inheritdoc}.
*/
public function getResultPass() {
return $this
->t('No unnecessary files detected.');
}
/**
* {@inheritdoc}.
*/
public function getResultWarn() {
return $this
->t('The following extra files were detected: @list', [
'@list' => implode(', ', $this->registry->superfluous),
]);
}
/**
* {@inheritdoc}.
*/
public function getAction() {
if ($this->score == SiteAuditCheckBase::AUDIT_CHECK_SCORE_WARN) {
return $this
->t('Unless you have an explicit need for it, don\'t store anything other than settings here.');
}
}
/**
* {@inheritdoc}.
*/
public function calculateScore() {
$handle = opendir(DRUPAL_ROOT . '/sites/');
$this->registry->superfluous = [];
while (FALSE !== ($entry = readdir($handle))) {
if (!in_array($entry, [
'.',
'..',
'default',
'all',
'example.sites.php',
'development.services.yml',
'example.settings.local.php',
'README.txt',
'.DS_Store',
])) {
if (is_file(DRUPAL_ROOT . '/sites/' . $entry)) {
// Support multi-site directory aliasing for non-Pantheon sites.
if ($entry != 'sites.php' || $this->options['vendor'] == 'pantheon') {
$this->registry->superfluous[] = $entry;
}
}
}
}
closedir($handle);
if (!empty($this->registry->superfluous)) {
return SiteAuditCheckBase::AUDIT_CHECK_SCORE_WARN;
}
return SiteAuditCheckBase::AUDIT_CHECK_SCORE_PASS;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
BestPracticesSitesSuperfluous:: |
public | function |
. Overrides SiteAuditCheckBase:: |
|
BestPracticesSitesSuperfluous:: |
public | function |
. Overrides SiteAuditCheckBase:: |
|
BestPracticesSitesSuperfluous:: |
public | function |
. Overrides SiteAuditCheckBase:: |
|
BestPracticesSitesSuperfluous:: |
public | function |
. Overrides SiteAuditCheckBase:: |
|
BestPracticesSitesSuperfluous:: |
public | function |
. Overrides SiteAuditCheckBase:: |
|
BestPracticesSitesSuperfluous:: |
public | function |
. Overrides SiteAuditCheckBase:: |
|
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
3 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
SiteAuditCheckBase:: |
protected | property | Names of checks that should not run as a result of this check. | |
SiteAuditCheckBase:: |
protected | property | Options passed in for reports and checks. | |
SiteAuditCheckBase:: |
protected | property | User has opted out of this check in configuration. | |
SiteAuditCheckBase:: |
protected | property | If set, will override the Report's percentage. | |
SiteAuditCheckBase:: |
protected | property | Use for passing data between checks within a report. | |
SiteAuditCheckBase:: |
protected | property | Quantifiable number associated with result on a scale of 0 to 2. | |
SiteAuditCheckBase:: |
protected | property | Are we in a static context. | |
SiteAuditCheckBase:: |
constant | |||
SiteAuditCheckBase:: |
constant | |||
SiteAuditCheckBase:: |
constant | |||
SiteAuditCheckBase:: |
constant | |||
SiteAuditCheckBase:: |
protected | function | Invoke another check's calculateScore() method if it is needed. | |
SiteAuditCheckBase:: |
public | function | Get a more verbose description of what is being checked. | |
SiteAuditCheckBase:: |
public | function | Get the ID or machine name for the check. | |
SiteAuditCheckBase:: |
public | function | Get the label for the check that describes, high level what is happening. | |
SiteAuditCheckBase:: |
public | function | Get the report percent override, if any. | |
SiteAuditCheckBase:: |
public | function | Get the check registry. | |
SiteAuditCheckBase:: |
public | function | Determine the result message based on the score. | |
SiteAuditCheckBase:: |
public | function | Get a quantifiable number representing a check result; lazy initialization. | |
SiteAuditCheckBase:: |
public | function | Get a human readable label for a score. | |
SiteAuditCheckBase:: |
public | function | Display action items for a user to perform. | |
SiteAuditCheckBase:: |
public | function | Determine whether the check failed so badly that the report must stop. | |
SiteAuditCheckBase:: |
public | function |
Constructor. Overrides PluginBase:: |
|
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |