You are here

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

class ContentEntityTypes in Site Audit 8.3

Provides the ContentEntityTypes Check.

Plugin annotation


@SiteAuditCheck(
 id = "content_entity_types",
 name = @Translation("Content entity types"),
 description = @Translation("Available content entity types and counts"),
 report = "content"
)

Hierarchy

Expanded class hierarchy of ContentEntityTypes

File

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

Namespace

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

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

  /**
   * {@inheritdoc}.
   */
  public function getResultInfo() {
    $ret_val = '';
    if (empty($this->registry->content_entity_type_counts)) {
      if ($this->options['detail']) {
        return $this
          ->t('No entities exist.');
      }
      return $ret_val;
    }
    $table_rows = [];
    foreach ($this->registry->content_entity_type_counts as $entity_type => $bundles) {
      foreach ($bundles as $bundle => $count) {
        $table_rows[] = [
          $entity_type,
          $bundle,
          $count,
        ];
      }
    }
    $header = [
      $this
        ->t('Content Entity'),
      $this
        ->t('Bundle'),
      $this
        ->t('Count'),
    ];
    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 (!isset($this)) {
      return SiteAuditCheckBase::AUDIT_CHECK_SCORE_INFO;
    }
    $all_bundles = \Drupal::service('entity_type.bundle.info')
      ->getAllBundleInfo();

    // This might have already been run by Drupal\site_audit\Plugin\SiteAuditCheck\ContentEntityTypesUnused
    // if so we don't need to do it again.
    if (!isset($this->registry->content_entity_type_counts)) {
      $this->registry->content_types_unused = [];
      foreach ($all_bundles as $entity_type => $bundles) {
        $bundle_column_name = \Drupal::service('entity_type.manager')
          ->getDefinition($entity_type)
          ->getKey('bundle');
        $interfaces = class_implements(\Drupal::service('entity_type.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(\Drupal::service('entity_type.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 SiteAuditCheckBase::AUDIT_CHECK_SCORE_INFO;
  }

}

Members

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