Mercurial > hg > isophonics-drupal-site
view core/modules/views/src/Plugin/EntityReferenceSelection/ViewsSelection.php @ 18:af1871eacc83
Update to Drupal core 8.7.1
author | Chris Cannam |
---|---|
date | Thu, 09 May 2019 15:33:08 +0100 |
parents | 129ea1e6d783 |
children |
line wrap: on
line source
<?php namespace Drupal\views\Plugin\EntityReferenceSelection; use Drupal\Core\DependencyInjection\DeprecatedServicePropertyTrait; use Drupal\Core\Entity\EntityReferenceSelection\SelectionPluginBase; use Drupal\Core\Entity\EntityTypeManagerInterface; use Drupal\Core\Extension\ModuleHandlerInterface; use Drupal\Core\Form\FormStateInterface; use Drupal\Core\Plugin\ContainerFactoryPluginInterface; use Drupal\Core\Session\AccountInterface; use Drupal\Core\Url; use Drupal\views\Views; use Symfony\Component\DependencyInjection\ContainerInterface; /** * Plugin implementation of the 'selection' entity_reference. * * @EntityReferenceSelection( * id = "views", * label = @Translation("Views: Filter by an entity reference view"), * group = "views", * weight = 0 * ) */ class ViewsSelection extends SelectionPluginBase implements ContainerFactoryPluginInterface { use DeprecatedServicePropertyTrait; /** * {@inheritdoc} */ protected $deprecatedProperties = ['entityManager' => 'entity.manager']; /** * The loaded View object. * * @var \Drupal\views\ViewExecutable */ protected $view; /** * The entity type manager service. * * @var \Drupal\Core\Entity\EntityManagerInterface */ protected $entityTypeManager; /** * The module handler service. * * @var \Drupal\Core\Extension\ModuleHandlerInterface */ protected $moduleHandler; /** * The current user. * * @var \Drupal\Core\Session\AccountInterface */ protected $currentUser; /** * Constructs a new ViewsSelection object. * * @param array $configuration * A configuration array containing information about the plugin instance. * @param string $plugin_id * The plugin_id for the plugin instance. * @param mixed $plugin_definition * The plugin implementation definition. * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager * The entity type manager service. * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler * The module handler service. * @param \Drupal\Core\Session\AccountInterface $current_user * The current user. */ public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityTypeManagerInterface $entity_type_manager, ModuleHandlerInterface $module_handler, AccountInterface $current_user) { parent::__construct($configuration, $plugin_id, $plugin_definition); $this->entityTypeManager = $entity_type_manager; $this->moduleHandler = $module_handler; $this->currentUser = $current_user; } /** * {@inheritdoc} */ public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) { return new static( $configuration, $plugin_id, $plugin_definition, $container->get('entity_type.manager'), $container->get('module_handler'), $container->get('current_user') ); } /** * {@inheritdoc} */ public function defaultConfiguration() { return [ 'view' => [ 'view_name' => NULL, 'display_name' => NULL, 'arguments' => [], ], ] + parent::defaultConfiguration(); } /** * {@inheritdoc} */ public function buildConfigurationForm(array $form, FormStateInterface $form_state) { $form = parent::buildConfigurationForm($form, $form_state); $view_settings = $this->getConfiguration()['view']; $displays = Views::getApplicableViews('entity_reference_display'); // Filter views that list the entity type we want, and group the separate // displays by view. $entity_type = $this->entityTypeManager->getDefinition($this->configuration['target_type']); $view_storage = $this->entityTypeManager->getStorage('view'); $options = []; foreach ($displays as $data) { list($view_id, $display_id) = $data; $view = $view_storage->load($view_id); if (in_array($view->get('base_table'), [$entity_type->getBaseTable(), $entity_type->getDataTable()])) { $display = $view->get('display'); $options[$view_id . ':' . $display_id] = $view_id . ' - ' . $display[$display_id]['display_title']; } } // The value of the 'view_and_display' select below will need to be split // into 'view_name' and 'view_display' in the final submitted values, so // we massage the data at validate time on the wrapping element (not // ideal). $form['view']['#element_validate'] = [[get_called_class(), 'settingsFormValidate']]; if ($options) { $default = !empty($view_settings['view_name']) ? $view_settings['view_name'] . ':' . $view_settings['display_name'] : NULL; $form['view']['view_and_display'] = [ '#type' => 'select', '#title' => $this->t('View used to select the entities'), '#required' => TRUE, '#options' => $options, '#default_value' => $default, '#description' => '<p>' . $this->t('Choose the view and display that select the entities that can be referenced.<br />Only views with a display of type "Entity Reference" are eligible.') . '</p>', ]; $default = !empty($view_settings['arguments']) ? implode(', ', $view_settings['arguments']) : ''; $form['view']['arguments'] = [ '#type' => 'textfield', '#title' => $this->t('View arguments'), '#default_value' => $default, '#required' => FALSE, '#description' => $this->t('Provide a comma separated list of arguments to pass to the view.'), ]; } else { if ($this->currentUser->hasPermission('administer views') && $this->moduleHandler->moduleExists('views_ui')) { $form['view']['no_view_help'] = [ '#markup' => '<p>' . $this->t('No eligible views were found. <a href=":create">Create a view</a> with an <em>Entity Reference</em> display, or add such a display to an <a href=":existing">existing view</a>.', [ ':create' => Url::fromRoute('views_ui.add')->toString(), ':existing' => Url::fromRoute('entity.view.collection')->toString(), ]) . '</p>', ]; } else { $form['view']['no_view_help']['#markup'] = '<p>' . $this->t('No eligible views were found.') . '</p>'; } } return $form; } /** * Initializes a view. * * @param string|null $match * (Optional) Text to match the label against. Defaults to NULL. * @param string $match_operator * (Optional) The operation the matching should be done with. Defaults * to "CONTAINS". * @param int $limit * Limit the query to a given number of items. Defaults to 0, which * indicates no limiting. * @param array|null $ids * Array of entity IDs. Defaults to NULL. * * @return bool * Return TRUE if the view was initialized, FALSE otherwise. */ protected function initializeView($match = NULL, $match_operator = 'CONTAINS', $limit = 0, $ids = NULL) { $view_name = $this->getConfiguration()['view']['view_name']; $display_name = $this->getConfiguration()['view']['display_name']; // Check that the view is valid and the display still exists. $this->view = Views::getView($view_name); if (!$this->view || !$this->view->access($display_name)) { \Drupal::messenger()->addWarning(t('The reference view %view_name cannot be found.', ['%view_name' => $view_name])); return FALSE; } $this->view->setDisplay($display_name); // Pass options to the display handler to make them available later. $entity_reference_options = [ 'match' => $match, 'match_operator' => $match_operator, 'limit' => $limit, 'ids' => $ids, ]; $this->view->displayHandlers->get($display_name)->setOption('entity_reference_options', $entity_reference_options); return TRUE; } /** * {@inheritdoc} */ public function getReferenceableEntities($match = NULL, $match_operator = 'CONTAINS', $limit = 0) { $display_name = $this->getConfiguration()['view']['display_name']; $arguments = $this->getConfiguration()['view']['arguments']; $result = []; if ($this->initializeView($match, $match_operator, $limit)) { // Get the results. $result = $this->view->executeDisplay($display_name, $arguments); } $return = []; if ($result) { foreach ($this->view->result as $row) { $entity = $row->_entity; $return[$entity->bundle()][$entity->id()] = $entity->label(); } } return $return; } /** * {@inheritdoc} */ public function countReferenceableEntities($match = NULL, $match_operator = 'CONTAINS') { $this->getReferenceableEntities($match, $match_operator); return $this->view->pager->getTotalItems(); } /** * {@inheritdoc} */ public function validateReferenceableEntities(array $ids) { $display_name = $this->getConfiguration()['view']['display_name']; $arguments = $this->getConfiguration()['view']['arguments']; $result = []; if ($this->initializeView(NULL, 'CONTAINS', 0, $ids)) { // Get the results. $entities = $this->view->executeDisplay($display_name, $arguments); $result = array_keys($entities); } return $result; } /** * Element validate; Check View is valid. */ public static function settingsFormValidate($element, FormStateInterface $form_state, $form) { // Split view name and display name from the 'view_and_display' value. if (!empty($element['view_and_display']['#value'])) { list($view, $display) = explode(':', $element['view_and_display']['#value']); } else { $form_state->setError($element, t('The views entity selection mode requires a view.')); return; } // Explode the 'arguments' string into an actual array. Beware, explode() // turns an empty string into an array with one empty string. We'll need an // empty array instead. $arguments_string = trim($element['arguments']['#value']); if ($arguments_string === '') { $arguments = []; } else { // array_map() is called to trim whitespaces from the arguments. $arguments = array_map('trim', explode(',', $arguments_string)); } $value = ['view_name' => $view, 'display_name' => $display, 'arguments' => $arguments]; $form_state->setValueForElement($element, $value); } }