class TermStorage in Drupal 9

Same name and namespace in other branches

8 core/modules/taxonomy/src/TermStorage.php \Drupal\taxonomy\TermStorage

Defines a Controller class for taxonomy terms.

Hierarchy

class \Drupal\Core\Entity\EntityHandlerBase uses DependencySerializationTrait, StringTranslationTrait
- class \Drupal\Core\Entity\EntityStorageBase implements EntityHandlerInterface, EntityStorageInterface
  - class \Drupal\Core\Entity\ContentEntityStorageBase implements ContentEntityStorageInterface, DynamicallyFieldableEntityStorageInterface
    class \Drupal\Core\Entity\Sql\SqlContentEntityStorage implements EntityBundleListenerInterface, DynamicallyFieldableEntityStorageSchemaInterface, SqlEntityStorageInterface
    class \Drupal\taxonomy\TermStorage implements TermStorageInterface

Expanded class hierarchy of TermStorage

File

core/modules/taxonomy/src/TermStorage.php, line 12

Namespace

Drupal\taxonomy

View source

class TermStorage extends SqlContentEntityStorage implements TermStorageInterface {

  /**
   * Array of term parents keyed by vocabulary ID and child term ID.
   *
   * @var array
   */
  protected $treeParents = [];

  /**
   * Array of term ancestors keyed by vocabulary ID and parent term ID.
   *
   * @var array
   */
  protected $treeChildren = [];

  /**
   * Array of terms in a tree keyed by vocabulary ID and term ID.
   *
   * @var array
   */
  protected $treeTerms = [];

  /**
   * Array of loaded trees keyed by a cache id matching tree arguments.
   *
   * @var array
   */
  protected $trees = [];

  /**
   * Array of all loaded term ancestry keyed by ancestor term ID, keyed by term
   * ID.
   *
   * @var \Drupal\taxonomy\TermInterface[][]
   */
  protected $ancestors;

  /**
   * The type of hierarchy allowed within a vocabulary.
   *
   * Possible values:
   * - VocabularyInterface::HIERARCHY_DISABLED: No parents.
   * - VocabularyInterface::HIERARCHY_SINGLE: Single parent.
   * - VocabularyInterface::HIERARCHY_MULTIPLE: Multiple parents.
   *
   * @var int[]
   *   An array of one the possible values above, keyed by vocabulary ID.
   */
  protected $vocabularyHierarchyType;

  /**
   * {@inheritdoc}
   *
   * @param array $values
   *   An array of values to set, keyed by property name. A value for the
   *   vocabulary ID ('vid') is required.
   */
  public function create(array $values = []) {

    // Save new terms with no parents by default.
    if (empty($values['parent'])) {
      $values['parent'] = [
        0,
      ];
    }
    $entity = parent::create($values);
    return $entity;
  }

  /**
   * {@inheritdoc}
   */
  public function resetCache(array $ids = NULL) {
    $this->ancestors = [];
    $this->treeChildren = [];
    $this->treeParents = [];
    $this->treeTerms = [];
    $this->trees = [];
    $this->vocabularyHierarchyType = [];
    parent::resetCache($ids);
  }

  /**
   * {@inheritdoc}
   */
  public function deleteTermHierarchy($tids) {
  }

  /**
   * {@inheritdoc}
   */
  public function updateTermHierarchy(EntityInterface $term) {
  }

  /**
   * {@inheritdoc}
   */
  public function loadParents($tid) {
    $terms = [];

    /** @var \Drupal\taxonomy\TermInterface $term */
    if ($tid && ($term = $this
      ->load($tid))) {
      foreach ($this
        ->getParents($term) as $id => $parent) {

        // This method currently doesn't return the <root> parent.
        // @see https://www.drupal.org/node/2019905
        if (!empty($id)) {
          $terms[$id] = $parent;
        }
      }
    }
    return $terms;
  }

  /**
   * Returns a list of parents of this term.
   *
   * @return \Drupal\taxonomy\TermInterface[]
   *   The parent taxonomy term entities keyed by term ID. If this term has a
   *   <root> parent, that item is keyed with 0 and will have NULL as value.
   *
   * @internal
   * @todo Refactor away when TreeInterface is introduced.
   */
  protected function getParents(TermInterface $term) {
    $parents = $ids = [];

    // Cannot use $this->get('parent')->referencedEntities() here because that
    // strips out the '0' reference.
    foreach ($term
      ->get('parent') as $item) {
      if ($item->target_id == 0) {

        // The <root> parent.
        $parents[0] = NULL;
        continue;
      }
      $ids[] = $item->target_id;
    }

    // @todo Better way to do this? AND handle the NULL/0 parent?
    // Querying the terms again so that the same access checks are run when
    // getParents() is called as in Drupal version prior to 8.3.
    $loaded_parents = [];
    if ($ids) {
      $query = \Drupal::entityQuery('taxonomy_term')
        ->accessCheck(TRUE)
        ->condition('tid', $ids, 'IN');
      $loaded_parents = static::loadMultiple($query
        ->execute());
    }
    return $parents + $loaded_parents;
  }

  /**
   * {@inheritdoc}
   */
  public function loadAllParents($tid) {

    /** @var \Drupal\taxonomy\TermInterface $term */
    return !empty($tid) && ($term = $this
      ->load($tid)) ? $this
      ->getAncestors($term) : [];
  }

  /**
   * Returns all ancestors of this term.
   *
   * @return \Drupal\taxonomy\TermInterface[]
   *   A list of ancestor taxonomy term entities keyed by term ID.
   *
   * @internal
   * @todo Refactor away when TreeInterface is introduced.
   */
  protected function getAncestors(TermInterface $term) {
    if (!isset($this->ancestors[$term
      ->id()])) {
      $this->ancestors[$term
        ->id()] = [
        $term
          ->id() => $term,
      ];
      $search[] = $term
        ->id();
      while ($tid = array_shift($search)) {
        foreach ($this
          ->getParents(static::load($tid)) as $id => $parent) {
          if ($parent && !isset($this->ancestors[$term
            ->id()][$id])) {
            $this->ancestors[$term
              ->id()][$id] = $parent;
            $search[] = $id;
          }
        }
      }
    }
    return $this->ancestors[$term
      ->id()];
  }

  /**
   * {@inheritdoc}
   */
  public function loadChildren($tid, $vid = NULL) {

    /** @var \Drupal\taxonomy\TermInterface $term */
    return !empty($tid) && ($term = $this
      ->load($tid)) ? $this
      ->getChildren($term) : [];
  }

  /**
   * Returns all children terms of this term.
   *
   * @return \Drupal\taxonomy\TermInterface[]
   *   A list of children taxonomy term entities keyed by term ID.
   *
   * @internal
   * @todo Refactor away when TreeInterface is introduced.
   */
  public function getChildren(TermInterface $term) {
    $query = \Drupal::entityQuery('taxonomy_term')
      ->accessCheck(TRUE)
      ->condition('parent', $term
      ->id());
    return static::loadMultiple($query
      ->execute());
  }

  /**
   * {@inheritdoc}
   */
  public function loadTree($vid, $parent = 0, $max_depth = NULL, $load_entities = FALSE) {
    $cache_key = implode(':', func_get_args());
    if (!isset($this->trees[$cache_key])) {

      // We cache trees, so it's not CPU-intensive to call on a term and its
      // children, too.
      if (!isset($this->treeChildren[$vid])) {
        $this->treeChildren[$vid] = [];
        $this->treeParents[$vid] = [];
        $this->treeTerms[$vid] = [];
        $query = $this->database
          ->select($this
          ->getDataTable(), 't');
        $query
          ->join('taxonomy_term__parent', 'p', '[t].[tid] = [p].[entity_id]');
        $query
          ->addExpression('[parent_target_id]', 'parent');
        $result = $query
          ->addTag('taxonomy_term_access')
          ->fields('t')
          ->condition('t.vid', $vid)
          ->condition('t.default_langcode', 1)
          ->orderBy('t.weight')
          ->orderBy('t.name')
          ->execute();
        foreach ($result as $term) {
          $this->treeChildren[$vid][$term->parent][] = $term->tid;
          $this->treeParents[$vid][$term->tid][] = $term->parent;
          $this->treeTerms[$vid][$term->tid] = $term;
        }
      }

      // Load full entities, if necessary. The entity controller statically
      // caches the results.
      $term_entities = [];
      if ($load_entities) {
        $term_entities = $this
          ->loadMultiple(array_keys($this->treeTerms[$vid]));
      }
      $max_depth = !isset($max_depth) ? count($this->treeChildren[$vid]) : $max_depth;
      $tree = [];

      // Keeps track of the parents we have to process, the last entry is used
      // for the next processing step.
      $process_parents = [];
      $process_parents[] = $parent;

      // Loops over the parent terms and adds its children to the tree array.
      // Uses a loop instead of a recursion, because it's more efficient.
      while (count($process_parents)) {
        $parent = array_pop($process_parents);

        // The number of parents determines the current depth.
        $depth = count($process_parents);
        if ($max_depth > $depth && !empty($this->treeChildren[$vid][$parent])) {
          $has_children = FALSE;
          $child = current($this->treeChildren[$vid][$parent]);
          do {
            if (empty($child)) {
              break;
            }
            $term = $load_entities ? $term_entities[$child] : $this->treeTerms[$vid][$child];
            if (isset($this->treeParents[$vid][$load_entities ? $term
              ->id() : $term->tid])) {

              // Clone the term so that the depth attribute remains correct
              // in the event of multiple parents.
              $term = clone $term;
            }
            $term->depth = $depth;
            if (!$load_entities) {
              unset($term->parent);
            }
            $tid = $load_entities ? $term
              ->id() : $term->tid;
            $term->parents = $this->treeParents[$vid][$tid];
            $tree[] = $term;
            if (!empty($this->treeChildren[$vid][$tid])) {
              $has_children = TRUE;

              // We have to continue with this parent later.
              $process_parents[] = $parent;

              // Use the current term as parent for the next iteration.
              $process_parents[] = $tid;

              // Reset pointers for child lists because we step in there more
              // often with multi parents.
              reset($this->treeChildren[$vid][$tid]);

              // Move pointer so that we get the correct term the next time.
              next($this->treeChildren[$vid][$parent]);
              break;
            }
          } while ($child = next($this->treeChildren[$vid][$parent]));
          if (!$has_children) {

            // We processed all terms in this hierarchy-level, reset pointer
            // so that this function works the next time it gets called.
            reset($this->treeChildren[$vid][$parent]);
          }
        }
      }
      $this->trees[$cache_key] = $tree;
    }
    return $this->trees[$cache_key];
  }

  /**
   * {@inheritdoc}
   */
  public function nodeCount($vid) {
    $query = $this->database
      ->select('taxonomy_index', 'ti');
    $query
      ->addExpression('COUNT(DISTINCT [ti].[nid])');
    $query
      ->leftJoin($this
      ->getBaseTable(), 'td', '[ti].[tid] = [td].[tid]');
    $query
      ->condition('td.vid', $vid);
    $query
      ->addTag('vocabulary_node_count');
    return $query
      ->execute()
      ->fetchField();
  }

  /**
   * {@inheritdoc}
   */
  public function resetWeights($vid) {
    $this->database
      ->update($this
      ->getDataTable())
      ->fields([
      'weight' => 0,
    ])
      ->condition('vid', $vid)
      ->execute();
  }

  /**
   * {@inheritdoc}
   */
  public function getNodeTerms(array $nids, array $vocabs = [], $langcode = NULL) {
    $query = $this->database
      ->select($this
      ->getDataTable(), 'td');
    $query
      ->innerJoin('taxonomy_index', 'tn', '[td].[tid] = [tn].[tid]');
    $query
      ->fields('td', [
      'tid',
    ]);
    $query
      ->addField('tn', 'nid', 'node_nid');
    $query
      ->orderby('td.weight');
    $query
      ->orderby('td.name');
    $query
      ->condition('tn.nid', $nids, 'IN');
    $query
      ->addTag('taxonomy_term_access');
    if (!empty($vocabs)) {
      $query
        ->condition('td.vid', $vocabs, 'IN');
    }
    if (!empty($langcode)) {
      $query
        ->condition('td.langcode', $langcode);
    }
    $results = [];
    $all_tids = [];
    foreach ($query
      ->execute() as $term_record) {
      $results[$term_record->node_nid][] = $term_record->tid;
      $all_tids[] = $term_record->tid;
    }
    $all_terms = $this
      ->loadMultiple($all_tids);
    $terms = [];
    foreach ($results as $nid => $tids) {
      foreach ($tids as $tid) {
        $terms[$nid][$tid] = $all_terms[$tid];
      }
    }
    return $terms;
  }

  /**
   * {@inheritdoc}
   */
  public function getTermIdsWithPendingRevisions() {
    $table_mapping = $this
      ->getTableMapping();
    $id_field = $table_mapping
      ->getColumnNames($this->entityType
      ->getKey('id'))['value'];
    $revision_field = $table_mapping
      ->getColumnNames($this->entityType
      ->getKey('revision'))['value'];
    $rta_field = $table_mapping
      ->getColumnNames($this->entityType
      ->getKey('revision_translation_affected'))['value'];
    $langcode_field = $table_mapping
      ->getColumnNames($this->entityType
      ->getKey('langcode'))['value'];
    $revision_default_field = $table_mapping
      ->getColumnNames($this->entityType
      ->getRevisionMetadataKey('revision_default'))['value'];
    $query = $this->database
      ->select($this
      ->getRevisionDataTable(), 'tfr');
    $query
      ->fields('tfr', [
      $id_field,
    ]);
    $query
      ->addExpression("MAX([tfr].[{$revision_field}])", $revision_field);
    $query
      ->join($this
      ->getRevisionTable(), 'tr', "[tfr].[{$revision_field}] = [tr].[{$revision_field}] AND [tr].[{$revision_default_field}] = 0");
    $inner_select = $this->database
      ->select($this
      ->getRevisionDataTable(), 't');
    $inner_select
      ->condition("t.{$rta_field}", '1');
    $inner_select
      ->fields('t', [
      $id_field,
      $langcode_field,
    ]);
    $inner_select
      ->addExpression("MAX([t].[{$revision_field}])", $revision_field);
    $inner_select
      ->groupBy("t.{$id_field}")
      ->groupBy("t.{$langcode_field}");
    $query
      ->join($inner_select, 'mr', "[tfr].[{$revision_field}] = [mr].[{$revision_field}] AND [tfr].[{$langcode_field}] = [mr].[{$langcode_field}]");
    $query
      ->groupBy("tfr.{$id_field}");
    return $query
      ->execute()
      ->fetchAllKeyed(1, 0);
  }

  /**
   * {@inheritdoc}
   */
  public function getVocabularyHierarchyType($vid) {

    // Return early if we already computed this value.
    if (isset($this->vocabularyHierarchyType[$vid])) {
      return $this->vocabularyHierarchyType[$vid];
    }
    $parent_field_storage = $this->entityFieldManager
      ->getFieldStorageDefinitions($this->entityTypeId)['parent'];
    $table_mapping = $this
      ->getTableMapping();
    $target_id_column = $table_mapping
      ->getFieldColumnName($parent_field_storage, 'target_id');
    $delta_column = $table_mapping
      ->getFieldColumnName($parent_field_storage, TableMappingInterface::DELTA);
    $query = $this->database
      ->select($table_mapping
      ->getFieldTableName('parent'), 'p');
    $query
      ->addExpression("MAX([{$target_id_column}])", 'max_parent_id');
    $query
      ->addExpression("MAX([{$delta_column}])", 'max_delta');
    $query
      ->condition('bundle', $vid);
    $result = $query
      ->execute()
      ->fetchAll();

    // If all the terms have the same parent, the parent can only be root (0).
    if ((int) $result[0]->max_parent_id === 0) {
      $this->vocabularyHierarchyType[$vid] = VocabularyInterface::HIERARCHY_DISABLED;
    }
    elseif ((int) $result[0]->max_delta === 0) {
      $this->vocabularyHierarchyType[$vid] = VocabularyInterface::HIERARCHY_SINGLE;
    }
    else {
      $this->vocabularyHierarchyType[$vid] = VocabularyInterface::HIERARCHY_MULTIPLE;
    }
    return $this->vocabularyHierarchyType[$vid];
  }

  /**
   * {@inheritdoc}
   */
  public function __sleep() {
    $vars = parent::__sleep();

    // Do not serialize static cache.
    unset($vars['ancestors'], $vars['treeChildren'], $vars['treeParents'], $vars['treeTerms'], $vars['trees'], $vars['vocabularyHierarchyType']);
    return $vars;
  }

  /**
   * {@inheritdoc}
   */
  public function __wakeup() {
    parent::__wakeup();

    // Initialize static caches.
    $this->ancestors = [];
    $this->treeChildren = [];
    $this->treeParents = [];
    $this->treeTerms = [];
    $this->trees = [];
    $this->vocabularyHierarchyType = [];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ContentEntityStorageBase::$bundleKey	protected	property	The entity bundle key.
ContentEntityStorageBase::$cacheBackend	protected	property	Cache backend.
ContentEntityStorageBase::$entityFieldManager	protected	property	The entity field manager service.
ContentEntityStorageBase::$entityTypeBundleInfo	protected	property	The entity bundle info.
ContentEntityStorageBase::$latestRevisionIds	protected	property	Stores the latest revision IDs for entities.
ContentEntityStorageBase::cleanIds	protected	function	Ensures integer entity key values are valid.
ContentEntityStorageBase::createRevision	public	function	Creates a new revision starting off from the specified entity object. Overrides TranslatableRevisionableStorageInterface::createRevision
ContentEntityStorageBase::createTranslation	public	function	Constructs a new entity translation object, without permanently saving it. Overrides TranslatableStorageInterface::createTranslation
ContentEntityStorageBase::createWithSampleValues	public	function	Creates an entity with sample field values. Overrides ContentEntityStorageInterface::createWithSampleValues	1
ContentEntityStorageBase::deleteRevision	public	function	Delete a specific entity revision. Overrides EntityStorageInterface::deleteRevision	1
ContentEntityStorageBase::doCreate	protected	function	Performs storage-specific creation of entities. Overrides EntityStorageBase::doCreate
ContentEntityStorageBase::doDelete	protected	function	Performs storage-specific entity deletion. Overrides EntityStorageBase::doDelete	1
ContentEntityStorageBase::doPostSave	protected	function	Performs post save entity processing. Overrides EntityStorageBase::doPostSave
ContentEntityStorageBase::doPreSave	protected	function	Performs presave entity processing. Overrides EntityStorageBase::doPreSave
ContentEntityStorageBase::doSave	protected	function	Performs storage-specific saving of the entity. Overrides EntityStorageBase::doSave	1
ContentEntityStorageBase::getFromPersistentCache	protected	function	Gets entities from the persistent cache backend.
ContentEntityStorageBase::getLatestRevisionId	public	function	Returns the latest revision identifier for an entity. Overrides RevisionableStorageInterface::getLatestRevisionId
ContentEntityStorageBase::getLatestTranslationAffectedRevisionId	public	function	Returns the latest revision affecting the specified translation. Overrides TranslatableRevisionableStorageInterface::getLatestTranslationAffectedRevisionId
ContentEntityStorageBase::getRevisionTranslationMergeSkippedFieldNames	protected	function	Returns an array of field names to skip when merging revision translations.
ContentEntityStorageBase::hasFieldValueChanged	protected	function	Checks whether the field values changed compared to the original entity.
ContentEntityStorageBase::initFieldValues	protected	function	Initializes field values.
ContentEntityStorageBase::invokeFieldMethod	protected	function	Invokes a method on the Field objects within an entity.
ContentEntityStorageBase::invokeFieldPostSave	protected	function	Invokes the post save method on the Field objects within an entity.
ContentEntityStorageBase::invokeHook	protected	function	Invokes a hook on behalf of the entity. Overrides EntityStorageBase::invokeHook
ContentEntityStorageBase::invokeStorageLoadHook	protected	function	Invokes hook_entity_storage_load().
ContentEntityStorageBase::invokeTranslationHooks	protected	function	Checks translation statuses and invoke the related hooks if needed.
ContentEntityStorageBase::isAnyRevisionTranslated	protected	function	Checks whether any entity revision is translated.
ContentEntityStorageBase::isAnyStoredRevisionTranslated	protected	function	Checks whether any stored entity revision is translated.
ContentEntityStorageBase::loadMultipleRevisions	public	function	Loads multiple entity revisions. Overrides RevisionableStorageInterface::loadMultipleRevisions	1
ContentEntityStorageBase::loadRevision	public	function	Load a specific entity revision. Overrides EntityStorageInterface::loadRevision	1
ContentEntityStorageBase::loadUnchanged	public	function	Loads an unchanged entity from the database. Overrides EntityStorageBase::loadUnchanged
ContentEntityStorageBase::onFieldDefinitionCreate	public	function	Reacts to the creation of a field. Overrides FieldDefinitionListenerInterface::onFieldDefinitionCreate
ContentEntityStorageBase::onFieldDefinitionUpdate	public	function	Reacts to the update of a field. Overrides FieldDefinitionListenerInterface::onFieldDefinitionUpdate
ContentEntityStorageBase::populateAffectedRevisionTranslations	protected	function	Populates the affected flag for all the revision translations.
ContentEntityStorageBase::preLoad	protected	function	Gathers entities from a 'preload' step. Overrides EntityStorageBase::preLoad
ContentEntityStorageBase::purgeFieldData	public	function	Purges a batch of field data. Overrides FieldableEntityStorageInterface::purgeFieldData
ContentEntityStorageBase::setPersistentCache	protected	function	Stores entities in the persistent cache backend.
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
EntityHandlerBase::$moduleHandler	protected	property	The module handler to invoke hooks on.	5
EntityHandlerBase::moduleHandler	protected	function	Gets the module handler.	5
EntityHandlerBase::setModuleHandler	public	function	Sets the module handler for this handler.
EntityStorageBase::$entityClass	protected	property	Name of the entity class.
EntityStorageBase::$entityType	protected	property	Information about the entity type.
EntityStorageBase::$entityTypeId	protected	property	Entity type ID for this storage.
EntityStorageBase::$idKey	protected	property	Name of the entity's ID field in the entity database table.
EntityStorageBase::$memoryCache	protected	property	The memory cache.
EntityStorageBase::$memoryCacheTag	protected	property	The memory cache cache tag.
EntityStorageBase::$uuidKey	protected	property	Name of entity's UUID database table field, if it supports UUIDs.	1
EntityStorageBase::$uuidService	protected	property	The UUID service.	1
EntityStorageBase::buildCacheId	protected	function	Builds the cache ID for the passed in entity ID.	1
EntityStorageBase::getAggregateQuery	public	function	Gets an aggregated query instance. Overrides EntityStorageInterface::getAggregateQuery
EntityStorageBase::getEntityType	public	function	Gets the entity type definition. Overrides EntityStorageInterface::getEntityType
EntityStorageBase::getEntityTypeId	public	function	Gets the entity type ID. Overrides EntityStorageInterface::getEntityTypeId
EntityStorageBase::getFromStaticCache	protected	function	Gets entities from the static cache.
EntityStorageBase::getQuery	public	function	Gets an entity query instance. Overrides EntityStorageInterface::getQuery
EntityStorageBase::hasData	public	function	Determines if the storage contains any data. Overrides EntityStorageInterface::hasData	3
EntityStorageBase::load	public	function	Loads one entity. Overrides EntityStorageInterface::load	2
EntityStorageBase::loadByProperties	public	function	Load entities by their property values. Overrides EntityStorageInterface::loadByProperties	3
EntityStorageBase::loadMultiple	public	function	Loads one or more entities. Overrides EntityStorageInterface::loadMultiple	1
EntityStorageBase::postLoad	protected	function	Attaches data to entities upon loading.
EntityStorageBase::setStaticCache	protected	function	Stores entities in the static entity cache.
EntityStorageInterface::FIELD_LOAD_CURRENT		constant	Load the most recent version of an entity's field data.
EntityStorageInterface::FIELD_LOAD_REVISION		constant	Load the version of an entity's field data specified in the entity.
SqlContentEntityStorage::$baseTable	protected	property	The base table of the entity.
SqlContentEntityStorage::$database	protected	property	Active database connection.
SqlContentEntityStorage::$dataTable	protected	property	The table that stores properties, if the entity has multilingual support.
SqlContentEntityStorage::$defaultLangcodeKey	protected	property	The default language entity key.
SqlContentEntityStorage::$entityTypeManager	protected	property	The entity type manager.
SqlContentEntityStorage::$fieldStorageDefinitions	protected	property	The entity type's field storage definitions.
SqlContentEntityStorage::$langcodeKey	protected	property	The entity langcode key. Overrides EntityStorageBase::$langcodeKey
SqlContentEntityStorage::$languageManager	protected	property	The language manager.
SqlContentEntityStorage::$revisionDataTable	protected	property	The table that stores revision field data if the entity supports revisions.
SqlContentEntityStorage::$revisionKey	protected	property	Name of entity's revision database table field, if it supports revisions.
SqlContentEntityStorage::$revisionTable	protected	property	The table that stores revisions, if the entity supports revisions.
SqlContentEntityStorage::$storageSchema	protected	property	The entity type's storage schema object.
SqlContentEntityStorage::$tableMapping	protected	property	The mapping of field columns to SQL tables.
SqlContentEntityStorage::$temporary	protected	property	Whether this storage should use the temporary table mapping.
SqlContentEntityStorage::buildPropertyQuery	protected	function	Builds an entity query. Overrides EntityStorageBase::buildPropertyQuery
SqlContentEntityStorage::buildQuery	protected	function	Builds the query to load the entity.
SqlContentEntityStorage::countFieldData	public	function	Determines the number of entities with values for a given field. Overrides FieldableEntityStorageInterface::countFieldData
SqlContentEntityStorage::createInstance	public static	function	Instantiates a new instance of this entity handler. Overrides ContentEntityStorageBase::createInstance	1
SqlContentEntityStorage::delete	public	function	Deletes permanently saved entities. Overrides EntityStorageBase::delete
SqlContentEntityStorage::deleteFromDedicatedTables	protected	function	Deletes values of fields in dedicated tables for all revisions.
SqlContentEntityStorage::deleteRevisionFromDedicatedTables	protected	function	Deletes values of fields in dedicated tables for all revisions.
SqlContentEntityStorage::doDeleteFieldItems	protected	function	Deletes entity field values from the storage. Overrides ContentEntityStorageBase::doDeleteFieldItems
SqlContentEntityStorage::doDeleteRevisionFieldItems	protected	function	Deletes field values of an entity revision from the storage. Overrides ContentEntityStorageBase::doDeleteRevisionFieldItems
SqlContentEntityStorage::doLoadMultiple	protected	function	Performs storage-specific loading of entities. Overrides EntityStorageBase::doLoadMultiple
SqlContentEntityStorage::doLoadMultipleRevisionsFieldItems	protected	function	Actually loads revision field item values from the storage. Overrides ContentEntityStorageBase::doLoadMultipleRevisionsFieldItems
SqlContentEntityStorage::doSaveFieldItems	protected	function	Writes entity field values to the storage. Overrides ContentEntityStorageBase::doSaveFieldItems	1
SqlContentEntityStorage::finalizePurge	public	function	Performs final cleanup after all data of a field has been purged. Overrides ContentEntityStorageBase::finalizePurge
SqlContentEntityStorage::getBaseTable	public	function	Gets the base table name.
SqlContentEntityStorage::getCustomTableMapping	public	function	Gets a table mapping for the specified entity type and storage definitions.
SqlContentEntityStorage::getDataTable	public	function	Gets the data table name.
SqlContentEntityStorage::getFromStorage	protected	function	Gets entities from the storage.
SqlContentEntityStorage::getQueryServiceName	protected	function	Gets the name of the service for the query for this entity storage. Overrides EntityStorageBase::getQueryServiceName
SqlContentEntityStorage::getRevisionDataTable	public	function	Gets the revision data table name.
SqlContentEntityStorage::getRevisionTable	public	function	Gets the revision table name.
SqlContentEntityStorage::getStorageSchema	protected	function	Gets the entity type's storage schema object.
SqlContentEntityStorage::getTableMapping	public	function	Gets a table mapping for the entity's SQL tables. Overrides SqlEntityStorageInterface::getTableMapping
SqlContentEntityStorage::has	protected	function	Determines if this entity already exists in storage. Overrides EntityStorageBase::has
SqlContentEntityStorage::initTableLayout	protected	function	Initializes table name variables.
SqlContentEntityStorage::isColumnSerial	protected	function	Checks whether a field column should be treated as serial.
SqlContentEntityStorage::loadFromDedicatedTables	protected	function	Loads values of fields stored in dedicated tables for a group of entities.
SqlContentEntityStorage::loadFromSharedTables	protected	function	Loads values for fields stored in the shared data tables.
SqlContentEntityStorage::mapFromStorageRecords	protected	function	Maps from storage records to entity objects, and attaches fields. Overrides EntityStorageBase::mapFromStorageRecords
SqlContentEntityStorage::mapToDataStorageRecord	protected	function	Maps from an entity object to the storage record of the field data.
SqlContentEntityStorage::mapToStorageRecord	protected	function	Maps from an entity object to the storage record.
SqlContentEntityStorage::onBundleCreate	public	function	Reacts to a bundle being created. Overrides EntityBundleListenerInterface::onBundleCreate
SqlContentEntityStorage::onBundleDelete	public	function	Reacts to a bundle being deleted. Overrides EntityBundleListenerInterface::onBundleDelete
SqlContentEntityStorage::onEntityTypeCreate	public	function	Reacts to the creation of the entity type. Overrides EntityTypeListenerInterface::onEntityTypeCreate
SqlContentEntityStorage::onEntityTypeDelete	public	function	Reacts to the deletion of the entity type. Overrides EntityTypeListenerInterface::onEntityTypeDelete
SqlContentEntityStorage::onEntityTypeUpdate	public	function	Reacts to the update of the entity type. Overrides EntityTypeListenerInterface::onEntityTypeUpdate
SqlContentEntityStorage::onFieldableEntityTypeCreate	public	function	Reacts to the creation of the fieldable entity type. Overrides EntityTypeListenerInterface::onFieldableEntityTypeCreate
SqlContentEntityStorage::onFieldableEntityTypeUpdate	public	function	Reacts to the update of a fieldable entity type. Overrides EntityTypeListenerInterface::onFieldableEntityTypeUpdate
SqlContentEntityStorage::onFieldDefinitionDelete	public	function	Reacts to the deletion of a field. Overrides ContentEntityStorageBase::onFieldDefinitionDelete
SqlContentEntityStorage::onFieldStorageDefinitionCreate	public	function	Reacts to the creation of a field storage definition. Overrides ContentEntityStorageBase::onFieldStorageDefinitionCreate
SqlContentEntityStorage::onFieldStorageDefinitionDelete	public	function	Reacts to the deletion of a field storage definition. Overrides ContentEntityStorageBase::onFieldStorageDefinitionDelete
SqlContentEntityStorage::onFieldStorageDefinitionUpdate	public	function	Reacts to the update of a field storage definition. Overrides ContentEntityStorageBase::onFieldStorageDefinitionUpdate
SqlContentEntityStorage::purgeFieldItems	protected	function	Removes field items from storage per entity during purge. Overrides ContentEntityStorageBase::purgeFieldItems
SqlContentEntityStorage::readFieldItemsToPurge	protected	function	Reads values to be purged for a single field. Overrides ContentEntityStorageBase::readFieldItemsToPurge
SqlContentEntityStorage::requiresEntityDataMigration	public	function	Checks if existing data would be lost if the schema changes were applied. Overrides EntityStorageSchemaInterface::requiresEntityDataMigration
SqlContentEntityStorage::requiresEntityStorageSchemaChanges	public	function	Checks if the changes to the entity type requires storage schema changes. Overrides EntityStorageSchemaInterface::requiresEntityStorageSchemaChanges
SqlContentEntityStorage::requiresFieldDataMigration	public	function	Checks if existing data would be lost if the schema changes were applied. Overrides DynamicallyFieldableEntityStorageSchemaInterface::requiresFieldDataMigration
SqlContentEntityStorage::requiresFieldStorageSchemaChanges	public	function	Checks if the changes to the storage definition requires schema changes. Overrides DynamicallyFieldableEntityStorageSchemaInterface::requiresFieldStorageSchemaChanges
SqlContentEntityStorage::restore	public	function	Restores a previously saved entity. Overrides EntityStorageBase::restore
SqlContentEntityStorage::save	public	function	Saves the entity permanently. Overrides EntityStorageBase::save	1
SqlContentEntityStorage::saveRevision	protected	function	Saves an entity revision.
SqlContentEntityStorage::saveToDedicatedTables	protected	function	Saves values of fields that use dedicated tables.	1
SqlContentEntityStorage::saveToSharedTables	protected	function	Saves fields that use the shared tables.
SqlContentEntityStorage::setEntityType	public	function	Updates the wrapped entity type definition.
SqlContentEntityStorage::setFieldStorageDefinitions	public	function	Updates the internal list of field storage definitions.
SqlContentEntityStorage::setTableMapping	public	function	Sets the wrapped table mapping definition.
SqlContentEntityStorage::setTemporary	public	function	Changes the temporary state of the storage.
SqlContentEntityStorage::wrapSchemaException	protected	function	Wraps a database schema exception into an entity storage exception.
SqlContentEntityStorage::__construct	public	function	Constructs a SqlContentEntityStorage object. Overrides ContentEntityStorageBase::__construct	1
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	4
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.
TermStorage::$ancestors	protected	property	Array of all loaded term ancestry keyed by ancestor term ID, keyed by term ID.
TermStorage::$treeChildren	protected	property	Array of term ancestors keyed by vocabulary ID and parent term ID.
TermStorage::$treeParents	protected	property	Array of term parents keyed by vocabulary ID and child term ID.
TermStorage::$trees	protected	property	Array of loaded trees keyed by a cache id matching tree arguments.
TermStorage::$treeTerms	protected	property	Array of terms in a tree keyed by vocabulary ID and term ID.
TermStorage::$vocabularyHierarchyType	protected	property	The type of hierarchy allowed within a vocabulary.
TermStorage::create	public	function	Overrides EntityStorageBase::create
TermStorage::deleteTermHierarchy	public	function	Removed reference to terms from term_hierarchy. Overrides TermStorageInterface::deleteTermHierarchy
TermStorage::getAncestors	protected	function	Returns all ancestors of this term.
TermStorage::getChildren	public	function	Returns all children terms of this term.
TermStorage::getNodeTerms	public	function	Returns all terms used to tag some given nodes. Overrides TermStorageInterface::getNodeTerms
TermStorage::getParents	protected	function	Returns a list of parents of this term.
TermStorage::getTermIdsWithPendingRevisions	public	function	Gets a list of term IDs with pending revisions. Overrides TermStorageInterface::getTermIdsWithPendingRevisions
TermStorage::getVocabularyHierarchyType	public	function	Returns the hierarchy type for a specific vocabulary ID. Overrides TermStorageInterface::getVocabularyHierarchyType
TermStorage::loadAllParents	public	function	Finds all ancestors of a given term ID. Overrides TermStorageInterface::loadAllParents
TermStorage::loadChildren	public	function	Finds all children of a term ID. Overrides TermStorageInterface::loadChildren
TermStorage::loadParents	public	function	Finds all parents of a given term ID. Overrides TermStorageInterface::loadParents
TermStorage::loadTree	public	function	Finds all terms in a given vocabulary ID. Overrides TermStorageInterface::loadTree
TermStorage::nodeCount	public	function	Count the number of nodes in a given vocabulary ID. Overrides TermStorageInterface::nodeCount
TermStorage::resetCache	public	function	Resets the internal entity cache. Overrides ContentEntityStorageBase::resetCache
TermStorage::resetWeights	public	function	Reset the weights for a given vocabulary ID. Overrides TermStorageInterface::resetWeights
TermStorage::updateTermHierarchy	public	function	Updates terms hierarchy information with the hierarchy trail of it. Overrides TermStorageInterface::updateTermHierarchy
TermStorage::__sleep	public	function	Overrides DependencySerializationTrait::__sleep
TermStorage::__wakeup	public	function	Overrides DependencySerializationTrait::__wakeup

You are here

class TermStorage in Drupal 9

Hierarchy

File

Namespace

Members

API Navigation