You are here

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

class ContentDuplicateTitles in Site Audit 8.3

Provides the ContentDuplicateTitles Check.

Plugin annotation


@SiteAuditCheck(
 id = "content_duplicate_titles",
 name = @Translation("Duplicate titles"),
 description = @Translation("Scan nodes for duplicate titles within a particular content type"),
 report = "content"
)

Hierarchy

Expanded class hierarchy of ContentDuplicateTitles

File

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

Namespace

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

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

  /**
   * {@inheritdoc}.
   */
  public function getResultInfo() {
    return $this
      ->t('No nodes exist, which also means no duplicate titles.');
  }

  /**
   * {@inheritdoc}.
   */
  public function getResultPass() {
    return $this
      ->t('No nodes with duplicate titles exist.');
  }

  /**
   * {@inheritdoc}.
   */
  public function getResultWarn() {
    $ret_val = [
      '#theme' => 'table',
      '#header' => [
        $this
          ->t('Content Type'),
        $this
          ->t('Title'),
        $this
          ->t('Count'),
      ],
      '#rows' => [],
    ];
    foreach ($this->registry->nodes_duplicate_titles as $content_type => $title_counts) {
      foreach ($title_counts as $title => $count) {
        $ret_val['#rows'][] = [
          $content_type,
          $title,
          $count,
        ];
      }
    }
    return $ret_val;
  }

  /**
   * {@inheritdoc}.
   */
  public function getAction() {
    if ($this
      ->getScore() == SiteAuditCheckBase::AUDIT_CHECK_SCORE_WARN) {
      return $this
        ->t('Consider reviewing your content and finding a way to disambiguate the duplicate titles.');
    }
  }

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

      // This hasn't been checked, so check it// make sure we have entities
      // \Drupal\site_audit\Plugin\SiteAuditCheck\ContentEntityTypes::calculateScore();
      $this
        ->checkInvokeCalculateScore('content_entity_types');
    }
    if (empty($this->registry->content_entity_type_counts)) {
      return SiteAuditCheckBase::AUDIT_CHECK_SCORE_INFO;
    }
    $query = \Drupal::database()
      ->select('node_field_data', 'nfd');
    $query
      ->addExpression('COUNT(nfd.title)', 'duplicate_count');
    $query
      ->fields('nfd', [
      'title',
      'type',
    ]);
    $query
      ->groupBy('nfd.title');
    $query
      ->groupBy('nfd.type');
    $query
      ->having('COUNT(nfd.title) > 1');
    $query
      ->orderBy('duplicate_count', 'DESC');
    $result = $query
      ->execute();
    $this->registry->nodes_duplicate_titles = [];
    $this->registry->nodes_duplicate_title_count = 0;
    $content_types = $content_types = \Drupal::service('entity_type.bundle.info')
      ->getBundleInfo("node");
    while ($row = $result
      ->fetchAssoc()) {
      $label = $content_types[$row['type']]['label'];
      $title = Html::escape($row['title']);
      $this->registry->nodes_duplicate_titles[$label][$title] = $row['duplicate_count'];
      $this->registry->nodes_duplicate_title_count += $row['duplicate_count'];
    }
    if (!empty($this->registry->nodes_duplicate_titles)) {
      return SiteAuditCheckBase::AUDIT_CHECK_SCORE_WARN;
    }
    return SiteAuditCheckBase::AUDIT_CHECK_SCORE_PASS;
  }

}

Members

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