class TermSelection

Provides specific access control for the taxonomy_term entity type.

Plugin annotation


@Plugin(
  id = "taxonomy_term_default",
  module = "taxonomy",
  label = @Translation("Taxonomy Term selection"),
  entity_types = {"taxonomy_term"},
  group = "default",
  weight = 1
)

Hierarchy

Expanded class hierarchy of TermSelection

File

drupal/core/modules/taxonomy/lib/Drupal/taxonomy/Plugin/entity_reference/selection/TermSelection.php, line 27
Contains \Drupal\taxonomy\Plugin\entity_reference\selection\TermSelection.

Namespace

Drupal\taxonomy\Plugin\entity_reference\selection
View source
class TermSelection extends SelectionBase {

  /**
   * Overrides SelectionBase::entityQueryAlter().
   */
  public function entityQueryAlter(SelectInterface $query) {

    // @todo: How to set access, as vocabulary is now config?
  }

  /**
   * Overrides SelectionBase::settingsForm().
   */
  public static function settingsForm(&$field, &$instance) {
    $form = parent::settingsForm($field, $instance);

    // @todo: Currently allow auto-create only on taxonomy terms.
    $form['auto_create'] = array(
      '#type' => 'checkbox',
      '#title' => t("Create referenced entities if they don't already exist"),
      '#default_value' => $instance['settings']['handler_settings']['auto_create'],
    );
    return $form;
  }

  /**
   * Overrides SelectionBase::getReferencableEntities().
   */
  public function getReferencableEntities($match = NULL, $match_operator = 'CONTAINS', $limit = 0) {
    if ($match || $limit) {
      return parent::getReferencableEntities($match, $match_operator, $limit);
    }
    $options = array();
    $bundles = entity_get_bundles('taxonomy_term');
    $bundle_names = !empty($this->instance['settings']['handler_settings']['target_bundles']) ? $this->instance['settings']['handler_settings']['target_bundles'] : array_keys($bundles);
    foreach ($bundle_names as $bundle) {
      if ($vocabulary = entity_load('taxonomy_vocabulary', $bundle)) {
        if ($terms = taxonomy_get_tree($vocabulary
          ->id(), 0)) {
          foreach ($terms as $term) {
            $options[$vocabulary
              ->id()][$term
              ->id()] = str_repeat('-', $term->depth) . check_plain($term->name);
          }
        }
      }
    }
    return $options;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
SelectionBase::$entity protected property The entity object, or NULL
SelectionBase::$field protected property The field array.
SelectionBase::$instance protected property The instance array.
SelectionBase::buildEntityQuery public function Builds an EntityQuery to get referencable entities. 4
SelectionBase::countReferencableEntities public function Implements SelectionInterface::countReferencableEntities(). Overrides SelectionInterface::countReferencableEntities
SelectionBase::reAlterQuery protected function Helper method: Passes a query to the alteration system again.
SelectionBase::validateAutocompleteInput public function Implements SelectionInterface::validateAutocompleteInput(). Overrides SelectionInterface::validateAutocompleteInput
SelectionBase::validateReferencableEntities public function Implements SelectionInterface::validateReferencableEntities(). Overrides SelectionInterface::validateReferencableEntities
SelectionBase::__construct public function Constructs a SelectionBase object.
TermSelection::entityQueryAlter public function Overrides SelectionBase::entityQueryAlter(). Overrides SelectionBase::entityQueryAlter
TermSelection::getReferencableEntities public function Overrides SelectionBase::getReferencableEntities(). Overrides SelectionBase::getReferencableEntities
TermSelection::settingsForm public static function Overrides SelectionBase::settingsForm(). Overrides SelectionBase::settingsForm