EntityHierarchyArgumentPluginBase.php in Entity Reference Hierarchy 3.x

Namespace

Drupal\entity_hierarchy\Plugin\views\argument

File

src/Plugin/views/argument/EntityHierarchyArgumentPluginBase.php

<?php

namespace Drupal\entity_hierarchy\Plugin\views\argument;

use Drupal\Core\Database\Connection;
use Drupal\Core\Entity\EntityTypeManagerInterface;
use Drupal\Core\Form\FormStateInterface;
use Drupal\entity_hierarchy\Storage\NestedSetNodeKeyFactory;
use Drupal\entity_hierarchy\Storage\NestedSetStorageFactory;
use Drupal\views\Plugin\views\argument\ArgumentPluginBase;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Defines a base argument plugin.
 */
abstract class EntityHierarchyArgumentPluginBase extends ArgumentPluginBase {

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

  /**
   * Entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * Node key factory.
   *
   * @var \Drupal\entity_hierarchy\Storage\NestedSetNodeKeyFactory
   */
  protected $nodeKeyFactory;

  /**
   * Table prefix for nested set.
   *
   * DBAL doesn't support table prefixes, so we must ensure to respect it.
   *
   * @var string
   */
  protected $nestedSetPrefix = '';

  /**
   * Constructs a new HierarchyIsParentOfEntity object.
   *
   * @param array $configuration
   *   Configuration.
   * @param string $plugin_id
   *   Plugin ID.
   * @param mixed $plugin_definition
   *   Definition.
   * @param \Drupal\entity_hierarchy\Storage\NestedSetStorageFactory $nestedSetStorageFactory
   *   Nested set storage.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entityTypeManager
   *   Entity type manager.
   * @param \Drupal\entity_hierarchy\Storage\NestedSetNodeKeyFactory $nodeKeyFactory
   *   Node key factory.
   * @param \Drupal\Core\Database\Connection $database
   *   Database connection.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, NestedSetStorageFactory $nestedSetStorageFactory, EntityTypeManagerInterface $entityTypeManager, NestedSetNodeKeyFactory $nodeKeyFactory, Connection $database) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->nestedSetStorageFactory = $nestedSetStorageFactory;
    $this->entityTypeManager = $entityTypeManager;
    $this->nodeKeyFactory = $nodeKeyFactory;
    $this->nestedSetPrefix = $database
      ->tablePrefix();
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('entity_hierarchy.nested_set_storage_factory'), $container
      ->get('entity_type.manager'), $container
      ->get('entity_hierarchy.nested_set_node_factory'), $container
      ->get('database'));
  }

  /**
   * {@inheritdoc}
   */
  public function buildOptionsForm(&$form, FormStateInterface $form_state) {
    $options = range(1, 50);
    $form['depth'] = [
      '#type' => 'select',
      '#empty_option' => $this
        ->t('No restriction'),
      '#empty_value' => 0,
      '#options' => array_combine($options, $options),
      '#title' => $this
        ->t('Depth'),
      '#default_value' => $this->options['depth'],
      '#description' => $this
        ->t('Filter to children that are at most this many levels deeper than their parent. E.g. for immediate children, select 1.'),
    ];
    parent::buildOptionsForm($form, $form_state);
  }

  /**
   * Returns the tree storage.
   *
   * @return \Drupal\entity_hierarchy\Storage\NestedSetStorage
   *   Tree storage.
   */
  protected function getTreeStorage() {
    return $this->nestedSetStorageFactory
      ->fromTableName($this->nestedSetPrefix . $this->table);
  }

  /**
   * {@inheritdoc}
   */
  protected function defineOptions() {
    $options = parent::defineOptions();

    // Allow filtering depth as well.
    $options['depth'] = [
      'default' => 0,
    ];
    return $options;
  }

  /**
   * Loads the parent entity from the argument.
   *
   * @return \Drupal\Core\Entity\EntityInterface
   *   Parent entity if exists.
   */
  protected function loadEntity() {
    return $this->entityTypeManager
      ->getStorage($this
      ->getEntityType())
      ->load($this->argument);
  }

}

Classes

Name	Description
EntityHierarchyArgumentPluginBase	Defines a base argument plugin.