class BestPracticesFolderStructure in Site Audit 8.3
Provides the BestPracticesFolderStructure Check.
Plugin annotation
@SiteAuditCheck(
id = "best_practices_folder_structure",
name = @Translation("Folder Structure"),
description = @Translation("Checks if modules/contrib and modules/custom directory is present"),
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\BestPracticesFolderStructure
- class \Drupal\site_audit\Plugin\SiteAuditCheckBase implements SiteAuditCheckInterface uses StringTranslationTrait
Expanded class hierarchy of BestPracticesFolderStructure
File
- src/
Plugin/ SiteAuditCheck/ BestPracticesFolderStructure.php, line 17
Namespace
Drupal\site_audit\Plugin\SiteAuditCheckView source
class BestPracticesFolderStructure extends SiteAuditCheckBase {
/**
* {@inheritdoc}.
*/
public function getResultFail() {
}
/**
* {@inheritdoc}.
*/
public function getResultInfo() {
}
/**
* {@inheritdoc}.
*/
public function getResultPass() {
return $this
->t('modules/contrib and modules/custom directories exist.');
}
/**
* {@inheritdoc}.
*/
public function getResultWarn() {
if (!$this->registry->contrib && !$this->registry->custom) {
return $this
->t('Neither modules/contrib nor modules/custom directories are present!');
}
if (!$this->registry->contrib) {
return $this
->t('modules/contrib directory is not present!');
}
if (!$this->registry->custom) {
return $this
->t('modules/custom directory is not present!');
}
}
/**
* {@inheritdoc}.
*/
public function getAction() {
$message = '';
if ($this->score == SiteAuditCheckBase::AUDIT_CHECK_SCORE_WARN) {
if (!$this->registry->contrib && !$this->registry->custom) {
$message .= $this
->t('Put all the contrib modules inside the ./modules/contrib directory and custom modules inside the ./modules/custom directory.');
}
elseif (!$this->registry->contrib) {
$message .= $this
->t('Put all the contrib modules inside the ./modules/contrib directory.');
}
elseif (!$this->registry->custom) {
$message .= $this
->t('Put all the custom modules inside the ./modules/custom directory.');
}
return $message . ' ' . $this
->t('Moving modules may cause errors, so refer to https://www.drupal.org/node/183681 for information on how to best proceed.');
}
}
/**
* {@inheritdoc}.
*/
public function calculateScore() {
$this->registry->contrib = is_dir(DRUPAL_ROOT . '/modules/contrib');
$this->registry->custom = is_dir(DRUPAL_ROOT . '/modules/custom');
if (!$this->registry->contrib || !$this->registry->custom) {
return SiteAuditCheckBase::AUDIT_CHECK_SCORE_WARN;
}
return SiteAuditCheckBase::AUDIT_CHECK_SCORE_PASS;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
BestPracticesFolderStructure:: |
public | function |
. Overrides SiteAuditCheckBase:: |
|
BestPracticesFolderStructure:: |
public | function |
. Overrides SiteAuditCheckBase:: |
|
BestPracticesFolderStructure:: |
public | function |
. Overrides SiteAuditCheckBase:: |
|
BestPracticesFolderStructure:: |
public | function |
. Overrides SiteAuditCheckBase:: |
|
BestPracticesFolderStructure:: |
public | function |
. Overrides SiteAuditCheckBase:: |
|
BestPracticesFolderStructure:: |
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. |