class SiteAuditCheckContentDuplicateTitles in Site Audit 8.2

Class SiteAuditCheckContentDuplicateTitles.

Hierarchy

• class \SiteAuditCheckAbstract
  • class \SiteAuditCheckContentDuplicateTitles

File

Check/Content/DuplicateTitles.php, line 12

Contains \SiteAudit\Check\Content\DuplicateTitles.

class SiteAuditCheckContentDuplicateTitles extends SiteAuditCheckAbstract {

  /**
   * Implements \SiteAudit\Check\Abstract\getLabel().
   */
  public function getLabel() {
    return dt('Duplicate titles');
  }

  /**
   * Implements \SiteAudit\Check\Abstract\getDescription().
   */
  public function getDescription() {
    return dt('Scan nodes for duplicate titles within a particular content type');
  }

  /**
   * Implements \SiteAudit\Check\Abstract\getResultFail().
   */
  public function getResultFail() {
  }

  /**
   * Implements \SiteAudit\Check\Abstract\getResultInfo().
   */
  public function getResultInfo() {
    return dt('No nodes exist, which also means no duplicate titles.');
  }

  /**
   * Implements \SiteAudit\Check\Abstract\getResultPass().
   */
  public function getResultPass() {
    return dt('No nodes with duplicate titles exist.');
  }

  /**
   * Implements \SiteAudit\Check\Abstract\getResultWarn().
   */
  public function getResultWarn() {
    if (!drush_get_option('detail')) {
      return dt('There are @count duplicate titles in the following types: @types', array(
        '@count' => $this->registry['nodes_duplicate_title_count'],
        '@types' => implode(', ', array_keys($this->registry['nodes_duplicate_titles'])),
      ));
    }
    $ret_val = '';
    if (drush_get_option('html') == TRUE) {
      $ret_val .= '<table class="table table-condensed">';
      $ret_val .= '<thead><tr><th>' . dt('Content Type') . '</th><th>' . dt('Title') . '</th><th>' . dt('Count') . '</th></tr></thead>';
      foreach ($this->registry['nodes_duplicate_titles'] as $content_type => $title_counts) {
        foreach ($title_counts as $title => $count) {
          $ret_val .= "<tr><td>{$content_type}</td><td>{$title}</td><td>{$count}</td></tr>";
        }
      }
      $ret_val .= '</table>';
    }
    else {
      $ret_val = dt('Content Type: "Title" (Count)') . PHP_EOL;
      if (!drush_get_option('json')) {
        $ret_val .= str_repeat(' ', 4);
      }
      $ret_val .= '-----------------------------';
      foreach ($this->registry['nodes_duplicate_titles'] as $content_type => $title_counts) {
        foreach ($title_counts as $title => $count) {
          $ret_val .= PHP_EOL;
          if (!drush_get_option('json')) {
            $ret_val .= str_repeat(' ', 4);
          }
          $ret_val .= "{$content_type}: \"{$title}\" ({$count})";
        }
      }
    }
    return $ret_val;
  }

  /**
   * Implements \SiteAudit\Check\Abstract\getAction().
   */
  public function getAction() {
    if ($this
      ->getScore() == SiteAuditCheckAbstract::AUDIT_CHECK_SCORE_WARN) {
      return dt('Consider reviewing your content and finding a way to disambiguate the duplicate titles.');
    }
  }

  /**
   * Implements \SiteAudit\Check\Abstract\calculateScore().
   */
  public function calculateScore() {
    if (empty($this->registry['content_entity_type_counts'])) {
      return SiteAuditCheckAbstract::AUDIT_CHECK_SCORE_INFO;
    }
    $sql_query = 'SELECT title, type, COUNT(0) AS duplicate_count ';
    $sql_query .= 'FROM {node_field_data} ';
    $sql_query .= 'GROUP BY title, type ';
    $sql_query .= 'HAVING (COUNT(0) > 1) ';
    $sql_query .= 'ORDER BY duplicate_count DESC, title ASC ';
    $result = db_query($sql_query);
    $this->registry['nodes_duplicate_titles'] = array();
    $this->registry['nodes_duplicate_title_count'] = 0;
    $content_types = $content_types = \Drupal::entityManager()
      ->getBundleInfo("node");
    foreach ($result as $row) {
      $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 SiteAuditCheckAbstract::AUDIT_CHECK_SCORE_WARN;
    }
    return SiteAuditCheckAbstract::AUDIT_CHECK_SCORE_PASS;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
SiteAuditCheckAbstract::$abort	protected	property	Indicate that no other checks should be run after this check.
SiteAuditCheckAbstract::$customCode	private static	property	Use for checking whether custom code paths have been validated.
SiteAuditCheckAbstract::$optOut	protected	property	User has opted out of this check in configuration.
SiteAuditCheckAbstract::$percentOverride	protected	property	If set, will override the Report's percentage.
SiteAuditCheckAbstract::$registry	protected	property	Use for passing data between checks within a report.
SiteAuditCheckAbstract::$score	protected	property	Quantifiable number associated with result on a scale of 0 to 2.
SiteAuditCheckAbstract::AUDIT_CHECK_SCORE_FAIL		constant
SiteAuditCheckAbstract::AUDIT_CHECK_SCORE_INFO		constant
SiteAuditCheckAbstract::AUDIT_CHECK_SCORE_PASS		constant
SiteAuditCheckAbstract::AUDIT_CHECK_SCORE_WARN		constant
SiteAuditCheckAbstract::getCustomCodePaths	public	function	Returns an array containing custom code paths or AUDIT_CHECK_SCORE_INFO.
SiteAuditCheckAbstract::getExecPath	public	function	Returns the path of the executable.
SiteAuditCheckAbstract::getOptions	public	function	Returns the values of the valid options for a command.
SiteAuditCheckAbstract::getPercentOverride	public	function	Get the report percent override, if any.
SiteAuditCheckAbstract::getRegistry	public	function	Get the check registry.
SiteAuditCheckAbstract::getRelativePath	public	function	Gives path relative to DRUPAL_ROOT of the path is inside Drupal.
SiteAuditCheckAbstract::getResult	public	function	Determine the result message based on the score.
SiteAuditCheckAbstract::getScore	public	function	Get a quantifiable number representing a check result; lazy initialization.
SiteAuditCheckAbstract::getScoreCssClass	public	function	Get the CSS class associated with a score.
SiteAuditCheckAbstract::getScoreDrushLevel	public	function	Get the Drush message level associated with a score.
SiteAuditCheckAbstract::getScoreLabel	public	function	Get a human readable label for a score.
SiteAuditCheckAbstract::logXmlError	public	function	Logs error if unable to parse XML output.
SiteAuditCheckAbstract::renderAction	public	function	Display action items for a user to perform.
SiteAuditCheckAbstract::shouldAbort	public	function	Determine whether the check failed so badly that the report must stop.
SiteAuditCheckAbstract::__construct	public	function	Constructor.
SiteAuditCheckContentDuplicateTitles::calculateScore	public	function	Implements \SiteAudit\Check\Abstract\calculateScore(). Overrides SiteAuditCheckAbstract::calculateScore
SiteAuditCheckContentDuplicateTitles::getAction	public	function	Implements \SiteAudit\Check\Abstract\getAction(). Overrides SiteAuditCheckAbstract::getAction
SiteAuditCheckContentDuplicateTitles::getDescription	public	function	Implements \SiteAudit\Check\Abstract\getDescription(). Overrides SiteAuditCheckAbstract::getDescription
SiteAuditCheckContentDuplicateTitles::getLabel	public	function	Implements \SiteAudit\Check\Abstract\getLabel(). Overrides SiteAuditCheckAbstract::getLabel
SiteAuditCheckContentDuplicateTitles::getResultFail	public	function	Implements \SiteAudit\Check\Abstract\getResultFail(). Overrides SiteAuditCheckAbstract::getResultFail
SiteAuditCheckContentDuplicateTitles::getResultInfo	public	function	Implements \SiteAudit\Check\Abstract\getResultInfo(). Overrides SiteAuditCheckAbstract::getResultInfo
SiteAuditCheckContentDuplicateTitles::getResultPass	public	function	Implements \SiteAudit\Check\Abstract\getResultPass(). Overrides SiteAuditCheckAbstract::getResultPass
SiteAuditCheckContentDuplicateTitles::getResultWarn	public	function	Implements \SiteAudit\Check\Abstract\getResultWarn(). Overrides SiteAuditCheckAbstract::getResultWarn