class EntityHierarchy in Entity Reference Hierarchy 3.x

Defines a class for entity reference selection that includes lineage.

Plugin annotation

@EntityReferenceSelection(
  id = "entity_hierarchy",
  label = @Translation("Entity Hierarchy"),
  group = "entity_hierarchy",
  weight = 0,
  deriver = "Drupal\entity_hierarchy\Plugin\Derivative\EntityHierarchySelectionDeriver"
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\Core\Entity\EntityReferenceSelection\SelectionPluginBase implements ConfigurableInterface, DependentPluginInterface, SelectionInterface
      • class \Drupal\Core\Entity\Plugin\EntityReferenceSelection\DefaultSelection implements SelectionWithAutocreateInterface, ContainerFactoryPluginInterface
        • class \Drupal\entity_hierarchy\Plugin\EntityReferenceSelection\EntityHierarchy uses AncestryLabelTrait

File

src/Plugin/EntityReferenceSelection/EntityHierarchy.php, line 27

Namespace

Drupal\entity_hierarchy\Plugin\EntityReferenceSelection

class EntityHierarchy extends DefaultSelection {
  use AncestryLabelTrait;

  /**
   * Storage factory.
   *
   * @var \Drupal\entity_hierarchy\Storage\NestedSetStorageFactory
   */
  protected $nestedSetStorageFactory;

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {

    /** @var self $instance */
    $instance = parent::create($container, $configuration, $plugin_id, $plugin_definition);
    $instance->entityTreeNodeMapper = $container
      ->get('entity_hierarchy.entity_tree_node_mapper');
    $instance->keyFactory = $container
      ->get('entity_hierarchy.nested_set_node_factory');
    $instance->nestedSetStorageFactory = $container
      ->get('entity_hierarchy.nested_set_storage_factory');
    return $instance;
  }

  /**
   * {@inheritdoc}
   */
  public function getReferenceableEntities($match = NULL, $match_operator = 'CONTAINS', $limit = 0) {
    $target_type = $this->configuration['target_type'];
    $query = $this
      ->buildEntityQuery($match, $match_operator);
    if ($limit > 0) {
      $query
        ->range(0, $limit);
    }
    $result = $query
      ->execute();
    if (empty($result)) {
      return [];
    }
    $options = [];
    $entities = $this->entityTypeManager
      ->getStorage($target_type)
      ->loadMultiple($result);

    // We assume target and definition are one and the same, as there is no
    // point in a hierarchy if you're referencing something else, you can't
    // go more than one level deep.

    /** @var \PNX\NestedSet\NestedSetInterface $storage */
    $storage = $this->nestedSetStorageFactory
      ->get($this->pluginDefinition['field_name'], $target_type);
    foreach ($entities as $entity_id => $entity) {
      $bundle = $entity
        ->bundle();
      $label = $this
        ->generateEntityLabelWithAncestry($entity, $storage, $target_type);
      $options[$bundle][$entity_id] = Html::escape($label);
    }
    return $options;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AncestryLabelTrait::$entityTreeNodeMapper	protected	property	Tree node mapper.
AncestryLabelTrait::$keyFactory	protected	property	Key factory.
AncestryLabelTrait::generateEntityLabelWithAncestry	protected	function	Generate labels including ancestry.
DefaultSelection::$currentUser	protected	property	The current user.
DefaultSelection::$entityFieldManager	protected	property	The entity field manager service.
DefaultSelection::$entityRepository	protected	property	The entity repository.
DefaultSelection::$entityTypeBundleInfo	public	property	Entity type bundle info service.
DefaultSelection::$entityTypeManager	protected	property	The entity type manager service.
DefaultSelection::$moduleHandler	protected	property	The module handler service.
DefaultSelection::buildConfigurationForm	public	function	Form constructor. Overrides SelectionPluginBase::buildConfigurationForm	3
DefaultSelection::buildEntityQuery	protected	function	Builds an EntityQuery to get referenceable entities.	7
DefaultSelection::countReferenceableEntities	public	function	Counts entities that are referenceable. Overrides SelectionInterface::countReferenceableEntities	2
DefaultSelection::createNewEntity	public	function	Creates a new entity object that can be used as a valid reference. Overrides SelectionWithAutocreateInterface::createNewEntity	6
DefaultSelection::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides SelectionPluginBase::defaultConfiguration	3
DefaultSelection::elementValidateFilter	public static	function	Form element validation handler; Filters the #value property of an element.
DefaultSelection::reAlterQuery	protected	function	Helper method: Passes a query to the alteration system again.
DefaultSelection::validateConfigurationForm	public	function	Form validation handler. Overrides SelectionPluginBase::validateConfigurationForm
DefaultSelection::validateReferenceableEntities	public	function	Validates which existing entities can be referenced. Overrides SelectionInterface::validateReferenceableEntities
DefaultSelection::validateReferenceableNewEntities	public	function	Validates which newly created entities can be referenced. Overrides SelectionWithAutocreateInterface::validateReferenceableNewEntities	6
DefaultSelection::__construct	public	function	Constructs a new DefaultSelection object. Overrides SelectionPluginBase::__construct	1
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
EntityHierarchy::$nestedSetStorageFactory	protected	property	Storage factory.
EntityHierarchy::create	public static	function	Creates an instance of the plugin. Overrides DefaultSelection::create
EntityHierarchy::getReferenceableEntities	public	function	Gets the list of referenceable entities. Overrides DefaultSelection::getReferenceableEntities
MessengerTrait::$messenger	protected	property	The messenger.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
MessengerTrait::setMessenger	public	function	Sets the messenger.
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	2
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.
SelectionPluginBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
SelectionPluginBase::entityQueryAlter	public	function	Allows the selection to alter the SelectQuery generated by EntityFieldQuery. Overrides SelectionInterface::entityQueryAlter	2
SelectionPluginBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
SelectionPluginBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
SelectionPluginBase::submitConfigurationForm	public	function	Form submission handler. Overrides PluginFormInterface::submitConfigurationForm
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.