You are here

Home » API reference » Site Audit 8.2 » ContentEntityTypes.php

class SiteAuditCheckContentContentEntityTypes in Site Audit 8.2

Class SiteAuditCheckContentContentEntityTypes.

Hierarchy

Expanded class hierarchy of SiteAuditCheckContentContentEntityTypes

File

Check/Content/ContentEntityTypes.php, line 10
Contains \SiteAudit\Check\Content\ContentTypes.

View source 
class SiteAuditCheckContentContentEntityTypes extends SiteAuditCheckAbstract {

  /**
   * Implements \SiteAudit\Check\Abstract\getLabel().
   */
  public function getLabel() {
    return dt('Content entity types');
  }

  /**
   * Implements \SiteAudit\Check\Abstract\getDescription().
   */
  public function getDescription() {
    return dt('Available content entity types and counts');
  }

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

  /**
   * Implements \SiteAudit\Check\Abstract\getResultInfo().
   */
  public function getResultInfo() {
    $ret_val = '';
    if (empty($this->registry['content_entity_type_counts'])) {
      if (drush_get_option('detail')) {
        return dt('No entities exist.');
      }
      return $ret_val;
    }
    if (drush_get_option('html') == TRUE) {
      $ret_val .= '<table class="table table-condensed">';
      $ret_val .= '<thead><tr><th>' . dt('Content Entity') . '</th><th>' . dt('Bundle') . '</th><th>' . dt('Count') . '</th></tr></thead>';
      foreach ($this->registry['content_entity_type_counts'] as $entity_type => $bundles) {
        foreach ($bundles as $bundle => $count) {
          $ret_val .= "<tr><td>{$entity_type}</td><td>{$bundle}</td><td>{$count}</td></tr>";
        }
      }
      $ret_val .= '</table>';
    }
    else {
      $rows = 0;
      foreach ($this->registry['content_entity_type_counts'] as $entity_type => $bundles) {
        if ($rows++ > 0) {
          $ret_val .= PHP_EOL;
          if (!drush_get_option('json')) {
            $ret_val .= str_repeat(' ', 4);
          }
        }
        $ret_val .= dt('Entity: @entity_type, total: @total', array(
          '@entity_type' => $entity_type,
          '@total' => $this->registry['entity_count'][$entity_type],
        ));
        foreach ($bundles as $bundle => $count) {
          $ret_val .= PHP_EOL;
          if (!drush_get_option('json')) {
            $ret_val .= str_repeat(' ', 6);
          }
          $ret_val .= "{$bundle}: {$count}";
        }
      }
    }
    return $ret_val;
  }

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

  /**
   * Implements \SiteAudit\Check\Abstract\getResultWarn().
   */
  public function getResultWarn() {
    return $this
      ->getResultInfo();
  }

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

  /**
   * Implements \SiteAudit\Check\Abstract\calculateScore().
   */
  public function calculateScore() {
    $entity_manager = \Drupal::entityManager();
    $all_bundles = $entity_manager
      ->getAllBundleInfo();
    foreach ($all_bundles as $entity_type => $bundles) {
      $bundle_column_name = $entity_manager
        ->getDefinition($entity_type)
        ->getKey('bundle');
      $interfaces = class_implements($entity_manager
        ->getDefinition($entity_type)
        ->getClass());
      if ($bundle_column_name != FALSE && in_array("Drupal\\Core\\Entity\\ContentEntityInterface", $interfaces)) {
        $this->registry['entity_count'][$entity_type] = 0;
        foreach ($bundles as $bundle => $info) {
          if (get_class($entity_manager
            ->getStorage($entity_type)) != 'Drupal\\Core\\Entity\\ContentEntityNullStorage') {
            $query = \Drupal::entityQuery($entity_type)
              ->condition($bundle_column_name, $bundle)
              ->count();
            $field_count = $query
              ->execute();
            $label = $info['label'];
            if (is_object($label)) {
              $label = (string) $label;
            }
            $this->registry['content_entity_type_counts'][$entity_type][$label] = $field_count;
            $this->registry['entity_count'][$entity_type] += $field_count;
            if ($field_count == 0) {
              $this->registry['content_types_unused'][$entity_type][] = $info['label'];
            }
          }
        }
      }
    }
    return SiteAuditCheckAbstract::AUDIT_CHECK_SCORE_INFO;
  }

}

Members

Namesort descending 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.
SiteAuditCheckContentContentEntityTypes::calculateScore public function Implements \SiteAudit\Check\Abstract\calculateScore(). Overrides SiteAuditCheckAbstract::calculateScore
SiteAuditCheckContentContentEntityTypes::getAction public function Implements \SiteAudit\Check\Abstract\getAction(). Overrides SiteAuditCheckAbstract::getAction
SiteAuditCheckContentContentEntityTypes::getDescription public function Implements \SiteAudit\Check\Abstract\getDescription(). Overrides SiteAuditCheckAbstract::getDescription
SiteAuditCheckContentContentEntityTypes::getLabel public function Implements \SiteAudit\Check\Abstract\getLabel(). Overrides SiteAuditCheckAbstract::getLabel
SiteAuditCheckContentContentEntityTypes::getResultFail public function Implements \SiteAudit\Check\Abstract\getResultFail(). Overrides SiteAuditCheckAbstract::getResultFail
SiteAuditCheckContentContentEntityTypes::getResultInfo public function Implements \SiteAudit\Check\Abstract\getResultInfo(). Overrides SiteAuditCheckAbstract::getResultInfo
SiteAuditCheckContentContentEntityTypes::getResultPass public function Implements \SiteAudit\Check\Abstract\getResultPass(). Overrides SiteAuditCheckAbstract::getResultPass
SiteAuditCheckContentContentEntityTypes::getResultWarn public function Implements \SiteAudit\Check\Abstract\getResultWarn(). Overrides SiteAuditCheckAbstract::getResultWarn