class ContentEntityTypesUnused in Site Audit 8.3

Provides the ContentEntityTypesUnused Check.

Plugin annotation

@SiteAuditCheck(
 id = "content_enity_types_unused",
 name = @Translation("Unused content entity types"),
 description = @Translation("Check for unused content entity types"),
 report = "content"
)

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\ContentEntityTypesUnused

File

src/Plugin/SiteAuditCheck/ContentEntityTypesUnused.php, line 17

Namespace

Drupal\site_audit\Plugin\SiteAuditCheck

class ContentEntityTypesUnused extends SiteAuditCheckBase {

  /**
   * {@inheritdoc}.
   */
  public function getResultFail() {
  }

  /**
   * {@inheritdoc}.
   */
  public function getResultInfo() {
  }

  /**
   * {@inheritdoc}.
   */
  public function getResultPass() {
    return $this
      ->t('There are no unused content types.');
  }

  /**
   * {@inheritdoc}.
   */
  public function getResultWarn() {
    $report = [];
    foreach ($this->registry->content_types_unused as $entity_type => $bundle) {
      $report[] = $entity_type .= ': ' . implode(', ', $bundle);
    }
    return $this
      ->t('The following content entity types are unused: @content_types_unused', [
      '@content_types_unused' => implode('; ', $report),
    ]);
  }

  /**
   * {@inheritdoc}.
   */
  public function getAction() {
    if ($this
      ->getScore() == SiteAuditCheckBase::AUDIT_CHECK_SCORE_WARN) {
      return $this
        ->t('Consider removing unused content types.');
    }
  }

  /**
   * {@inheritdoc}.
   */
  public function calculateScore() {
    if (!isset($this->registry->content_types_unused)) {

      // This hasn't been checked, so check it.
      $this
        ->checkInvokeCalculateScore('content_entity_types');
    }
    if (empty($this->registry->content_types_unused)) {
      return SiteAuditCheckBase::AUDIT_CHECK_SCORE_PASS;
    }
    return SiteAuditCheckBase::AUDIT_CHECK_SCORE_WARN;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ContentEntityTypesUnused::calculateScore	public	function	. Overrides SiteAuditCheckBase::calculateScore
ContentEntityTypesUnused::getAction	public	function	. Overrides SiteAuditCheckBase::getAction
ContentEntityTypesUnused::getResultFail	public	function	. Overrides SiteAuditCheckBase::getResultFail
ContentEntityTypesUnused::getResultInfo	public	function	. Overrides SiteAuditCheckBase::getResultInfo
ContentEntityTypesUnused::getResultPass	public	function	. Overrides SiteAuditCheckBase::getResultPass
ContentEntityTypesUnused::getResultWarn	public	function	. Overrides SiteAuditCheckBase::getResultWarn
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
SiteAuditCheckBase::$abort	protected	property	Names of checks that should not run as a result of this check.
SiteAuditCheckBase::$options	protected	property	Options passed in for reports and checks.
SiteAuditCheckBase::$optOut	protected	property	User has opted out of this check in configuration.
SiteAuditCheckBase::$percentOverride	protected	property	If set, will override the Report's percentage.
SiteAuditCheckBase::$registry	protected	property	Use for passing data between checks within a report.
SiteAuditCheckBase::$score	protected	property	Quantifiable number associated with result on a scale of 0 to 2.
SiteAuditCheckBase::$static	protected	property	Are we in a static context.
SiteAuditCheckBase::AUDIT_CHECK_SCORE_FAIL		constant
SiteAuditCheckBase::AUDIT_CHECK_SCORE_INFO		constant
SiteAuditCheckBase::AUDIT_CHECK_SCORE_PASS		constant
SiteAuditCheckBase::AUDIT_CHECK_SCORE_WARN		constant
SiteAuditCheckBase::checkInvokeCalculateScore	protected	function	Invoke another check's calculateScore() method if it is needed.
SiteAuditCheckBase::getDescription	public	function	Get a more verbose description of what is being checked.
SiteAuditCheckBase::getId	public	function	Get the ID or machine name for the check.
SiteAuditCheckBase::getLabel	public	function	Get the label for the check that describes, high level what is happening.
SiteAuditCheckBase::getPercentOverride	public	function	Get the report percent override, if any.
SiteAuditCheckBase::getRegistry	public	function	Get the check registry.
SiteAuditCheckBase::getResult	public	function	Determine the result message based on the score.
SiteAuditCheckBase::getScore	public	function	Get a quantifiable number representing a check result; lazy initialization.
SiteAuditCheckBase::getScoreLabel	public	function	Get a human readable label for a score.
SiteAuditCheckBase::renderAction	public	function	Display action items for a user to perform.
SiteAuditCheckBase::shouldAbort	public	function	Determine whether the check failed so badly that the report must stop.
SiteAuditCheckBase::__construct	public	function	Constructor. Overrides PluginBase::__construct
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.