You are here

Home » API reference » Site Audit 8.3 » ContentVocabularies.php

class ContentVocabularies in Site Audit 8.3

Provides the ContentVocabularies Check.

Plugin annotation


@SiteAuditCheck(
 id = "content_vocabularies",
 name = @Translation("Taxonomy vocabularies"),
 description = @Translation("Available vocabularies and term counts"),
 report = "content",
 weight = 6,
)

Hierarchy

Expanded class hierarchy of ContentVocabularies

File

src/Plugin/SiteAuditCheck/ContentVocabularies.php, line 18

Namespace

Drupal\site_audit\Plugin\SiteAuditCheck
View source 
class ContentVocabularies extends SiteAuditCheckBase {

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

  /**
   * {@inheritdoc}.
   */
  public function getResultInfo() {
    if (!isset($this->registry->vocabulary_counts)) {
      return $this
        ->t('The taxonomy module is not enabled.');
    }
    if (empty($this->registry->vocabulary_counts)) {
      if ($this->options['detail']) {
        return $this
          ->t('No vocabularies exist.');
      }
      return '';
    }
    $ret_val = '';
    $table_rows = [];
    foreach ($this->registry->vocabulary_counts as $vocabulary => $count) {
      $table_rows[] = [
        $vocabulary,
        $count,
      ];
    }
    $header = [
      $this
        ->t('Vocabulary'),
      $this
        ->t('Terms'),
    ];
    return [
      '#theme' => 'table',
      '#class' => 'table-condensed',
      '#header' => $header,
      '#rows' => $table_rows,
    ];
  }

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

  /**
   * {@inheritdoc}.
   */
  public function getResultWarn() {
    return $this
      ->getResultInfo();
  }

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

  /**
   * {@inheritdoc}.
   */
  public function calculateScore() {
    if (!\Drupal::moduleHandler()
      ->moduleExists('taxonomy')) {
      return SiteAuditCheckBase::AUDIT_CHECK_SCORE_INFO;
    }
    if (!isset($this->registry->vocabulary_unused)) {
      $this->registry->vocabulary_unused = [];
      $vocabularies = \Drupal::service('entity_type.bundle.info')
        ->getBundleInfo("taxonomy_term");
      $query = \Drupal::database()
        ->select('taxonomy_term_field_data');
      $query
        ->addExpression('COUNT(tid)', 'count');
      $query
        ->addField('taxonomy_term_field_data', 'vid');
      $query
        ->orderBy('count', 'DESC');
      $query
        ->groupBy('vid');
      $result = $query
        ->execute();
      $this->registry->vocabulary_counts = $this->registry->vocabulary_unused = [];
      while ($row = $result
        ->fetchAssoc()) {
        $label = $vocabularies[$row['vid']]['label'];
        $this->registry->vocabulary_counts[$label] = $row['count'];
      }

      // Check for unused vocabularies.
      foreach ($vocabularies as $vocabulary) {
        if (array_search($vocabulary['label'], array_keys($this->registry->vocabulary_counts)) === FALSE) {
          $this->registry->vocabulary_unused[] = $vocabulary['label'];
          $this->registry->vocabulary_counts[$vocabulary['label']] = 0;
        }
      }

      // No need to check for unused vocabularies if there aren't any.
      if (empty($this->registry->vocabulary_counts)) {
        $this->abort = TRUE;
      }
    }
    return SiteAuditCheckBase::AUDIT_CHECK_SCORE_INFO;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ContentVocabularies::calculateScore public function . Overrides SiteAuditCheckBase::calculateScore
ContentVocabularies::getAction public function . Overrides SiteAuditCheckBase::getAction
ContentVocabularies::getResultFail public function . Overrides SiteAuditCheckBase::getResultFail
ContentVocabularies::getResultInfo public function . Overrides SiteAuditCheckBase::getResultInfo
ContentVocabularies::getResultPass public function . Overrides SiteAuditCheckBase::getResultPass
ContentVocabularies::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.