class TaxonomyTreeBuilder in Entity Reference Tree Widget 2.x

Provides a class for building a tree from taxonomy entity.

Hierarchy

• class \Drupal\entity_reference_tree\Tree\TaxonomyTreeBuilder implements TreeBuilderInterface

See also

\Drupal\entity_reference_tree\Tree\TreeBuilderInterface

1 string reference to 'TaxonomyTreeBuilder'

entity_reference_tree.services.yml in ./entity_reference_tree.services.yml

entity_reference_tree.services.yml

1 service uses TaxonomyTreeBuilder

entity_reference_taxonomy_term_tree_builder in ./entity_reference_tree.services.yml

Drupal\entity_reference_tree\Tree\TaxonomyTreeBuilder

File

src/Tree/TaxonomyTreeBuilder.php, line 15

Namespace

Drupal\entity_reference_tree\Tree

class TaxonomyTreeBuilder implements TreeBuilderInterface {

  /**
   * The permission name to access the tree.
   *
   * @var string
   *
   */
  private $accessPermission = 'access taxonomy overview';

  /**
   * The Language code.
   *
   * @var string
   */
  protected $langCode;

  /**
   * Load all entities from an entity bundle for the tree.
   *
   * @param string $entityType
   *   The type of the entity.
   *
   * @param string $bundleID
   *   The bundle ID.
   *
   * @return array
   *   All entities in the entity bundle.
   */
  public function loadTree(string $entityType, string $bundleID, string $langCode = NULL, int $parent = 0, int $max_depth = NULL) {

    // Setup the language code for this tree.
    // Use current language by default.
    if (empty($langCode)) {
      $this->langCode = \Drupal::service('language_manager')
        ->getCurrentLanguage()
        ->getId();
    }
    else {
      $this->langCode = $langCode;
    }
    if ($this
      ->hasAccess()) {
      return \Drupal::entityTypeManager()
        ->getStorage($entityType)
        ->loadTree($bundleID, $parent, $max_depth);
    }

    // The user is not allowed to access taxonomy overviews.
    return NULL;
  }

  /**
   * Create a tree node.
   *
   * @param \Drupal\taxonomy\TermInterface $entity
   *   The entity for the tree node.
   *
   * @param array $selected
   *   An anrray for all selected nodes.
   *
   * @return array
   *   The tree node for the entity.
   */
  public function createTreeNode($entity, array $selected = []) {
    $parent = $entity->parents[0];
    $text = $entity->name;
    \Drupal::moduleHandler()
      ->alter('entity_reference_tree_create_term_node', $text, $entity);
    if ($parent === '0') {
      $parent = '#';
    }

    // Compare the current language with the term's language.
    // If the language is different,
    // It need to be translated.
    if ($entity->langcode !== $this->langCode) {
      $term = Term::load($entity->tid);

      // Get the translated content.
      if ($term
        ->hasTranslation($this->langCode)) {
        $trans = $term
          ->getTranslation($this->langCode);
        $text = $trans
          ->getName();
      }
    }
    $node = [
      // Required.
      'id' => $entity->tid,
      // Required.
      'parent' => $parent,
      // Node text.
      'text' => $text,
      'state' => [
        'selected' => FALSE,
      ],
    ];
    if (in_array($entity->tid, $selected)) {

      // Initially selected node.
      $node['state']['selected'] = TRUE;
    }
    return $node;
  }

  /**
   * Get the ID of a tree node.
   *
   * @param \Drupal\taxonomy\TermInterface $entity
   *   The entity for the tree node.
   *
   * @return string|int|null
   *   The id of the tree node for the entity.
   */
  public function getNodeId($entity) {
    return $entity->tid;
  }

  /**
   * Check if a user has the access to the tree.
   *
   * @param \Drupal\Core\Session\AccountProxyInterface $user
   *   The user object to check.
   *
   * @return bool
   *   If the user has the access to the tree return TRUE,
   *   otherwise return FALSE.
   */
  private function hasAccess(AccountProxyInterface $user = NULL) {

    // Check current user as default.
    if (empty($user)) {
      $user = \Drupal::currentUser();
    }
    return $user
      ->hasPermission($this->accessPermission);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
TaxonomyTreeBuilder::$accessPermission	private	property	The permission name to access the tree.
TaxonomyTreeBuilder::$langCode	protected	property	The Language code.
TaxonomyTreeBuilder::createTreeNode	public	function	Create a tree node. Overrides TreeBuilderInterface::createTreeNode
TaxonomyTreeBuilder::getNodeId	public	function	Get the ID of a tree node. Overrides TreeBuilderInterface::getNodeId
TaxonomyTreeBuilder::hasAccess	private	function	Check if a user has the access to the tree.
TaxonomyTreeBuilder::loadTree	public	function	Load all entities from an entity bundle for the tree. Overrides TreeBuilderInterface::loadTree