www.aleph1.co.uk Git - yaffs-website/blob - web/modules/contrib/entityqueue/src/Form/EntityQueueForm.php

   1 <?php
   2
   3 namespace Drupal\entityqueue\Form;
   4
   5 use Drupal\Component\Plugin\PluginManagerInterface;
   6 use Drupal\Component\Utility\Html;
   7 use Drupal\Core\Entity\BundleEntityFormBase;
   8 use Drupal\Core\Entity\EntityReferenceSelection\SelectionPluginManagerInterface;
   9 use Drupal\Core\Entity\EntityTypeRepositoryInterface;
  10 use Drupal\Core\Field\Plugin\Field\FieldType\EntityReferenceItem;
  11 use Drupal\Core\Form\FormStateInterface;
  12 use Psr\Log\LoggerInterface;
  13 use Symfony\Component\DependencyInjection\ContainerInterface;
  14
  15 /**
  16  * Base form for entity queue edit forms.
  17  */
  18 class EntityQueueForm extends BundleEntityFormBase {
  19
  20   /**
  21    * The entity being used by this form.
  22    *
  23    * @var \Drupal\entityqueue\EntityQueueInterface
  24    */
  25   protected $entity;
  26
  27   /**
  28    * The entity type repository.
  29    *
  30    * @var \Drupal\Core\Entity\EntityTypeRepositoryInterface
  31    */
  32   protected $entityTypeRepository;
  33
  34   /**
  35    * The entity queue handler plugin manager.
  36    *
  37    * @var \Drupal\Component\Plugin\PluginManagerInterface
  38    */
  39   protected $entityQueueHandlerManager;
  40
  41   /**
  42    * Selection manager service.
  43    *
  44    * @var \Drupal\Core\Entity\EntityReferenceSelection\SelectionPluginManagerInterface
  45    */
  46   protected $selectionManager;
  47
  48   /**
  49    * A logger instance.
  50    *
  51    * @var \Psr\Log\LoggerInterface
  52    */
  53   protected $logger;
  54
  55   /**
  56    * {@inheritdoc}
  57    */
  58   public static function create(ContainerInterface $container) {
  59     return new static(
  60       $container->get('entity_type.repository'),
  61       $container->get('plugin.manager.entityqueue.handler'),
  62       $container->get('plugin.manager.entity_reference_selection'),
  63       $container->get('logger.factory')->get('entityqueue')
  64     );
  65   }
  66
  67   /**
  68    * Constructs a EntityQueueForm.
  69    *
  70    * @param \Drupal\Core\Entity\EntityTypeRepositoryInterface
  71    *   The entity type repository.
  72    * @param \Drupal\Component\Plugin\PluginManagerInterface
  73    *   The entity queue handler plugin manager.
  74    * @param \Psr\Log\LoggerInterface $logger
  75    *   A logger instance.
  76    */
  77   public function __construct(EntityTypeRepositoryInterface $entity_type_repository, PluginManagerInterface $entity_queue_handler_manager, SelectionPluginManagerInterface $selection_manager, LoggerInterface $logger) {
  78     $this->entityTypeRepository = $entity_type_repository;
  79     $this->entityQueueHandlerManager = $entity_queue_handler_manager;
  80     $this->selectionManager = $selection_manager;
  81     $this->logger = $logger;
  82   }
  83
  84   /**
  85    * {@inheritdoc}
  86    */
  87   public function form(array $form, FormStateInterface $form_state) {
  88     $form = parent::form($form, $form_state);
  89     $queue = $this->entity;
  90
  91     // Default to nodes as the queue target entity type.
  92     $target_entity_type_id = $queue->getTargetEntityTypeId() ?: 'node';
  93
  94     $form['label'] = [
  95       '#type' => 'textfield',
  96       '#title' => $this->t('Name'),
  97       '#maxlength' => 255,
  98       '#default_value' => $queue->label(),
  99       '#description' => $this->t('The human-readable name of this entity queue. This name must be unique.'),
 100       '#required' => TRUE,
 101     ];
 102
 103     $form['id'] = [
 104       '#type' => 'machine_name',
 105       '#default_value' => $queue->id(),
 106       '#machine_name' => [
 107         'exists' => '\Drupal\entityqueue\Entity\EntityQueue::load',
 108       ],
 109       '#disabled' => !$queue->isNew(),
 110     ];
 111
 112     $handlers = $this->entityQueueHandlerManager->getAllEntityQueueHandlers();
 113     $form['handler'] = [
 114       '#type' => 'radios',
 115       '#title' => $this->t('Type'),
 116       '#options' => $handlers,
 117       '#default_value' => $queue->getHandler(),
 118       '#required' => TRUE,
 119       '#disabled' => !$queue->isNew(),
 120     ];
 121
 122     $form['settings'] = [
 123       '#type' => 'vertical_tabs',
 124     ];
 125
 126     $form['queue_settings'] = [
 127       '#type' => 'details',
 128       '#title' => $this->t('Queue settings'),
 129       '#open' => TRUE,
 130       '#tree' => TRUE,
 131       '#group' => 'settings',
 132     ];
 133     $form['queue_settings']['size'] = [
 134       '#type' => 'container',
 135       '#attributes' => ['class' => ['form--inline', 'clearfix']],
 136       '#process' => [
 137         [EntityReferenceItem::class, 'formProcessMergeParent']
 138       ],
 139     ];
 140     $form['queue_settings']['size']['min_size'] = [
 141       '#type' => 'number',
 142       '#size' => 2,
 143       '#default_value' => $queue->getMinimumSize(),
 144       '#field_prefix' => $this->t('Restrict this queue to a minimum of'),
 145     ];
 146     $form['queue_settings']['size']['max_size'] = [
 147       '#type' => 'number',
 148       '#default_value' => $queue->getMaximumSize(),
 149       '#field_prefix' => $this->t('and a maximum of'),
 150       '#field_suffix' => $this->t('items.'),
 151     ];
 152     $form['queue_settings']['act_as_queue'] = [
 153       '#type' => 'checkbox',
 154       '#title' => $this->t('Act as queue'),
 155       '#default_value' => $queue->getActAsQueue(),
 156       '#description' => $this->t('When enabled, adding more than the maximum number of items will remove extra items from the top of the queue.'),
 157       '#states' => [
 158         'invisible' => [
 159           ':input[name="queue_settings[max_size]"]' => ['value' => 0],
 160         ],
 161       ],
 162     ];
 163     $form['queue_settings']['reverse_in_admin'] = [
 164       '#type' => 'checkbox',
 165       '#title' => $this->t('Reverse order in admin view'),
 166       '#default_value' => $queue->getReverseInAdmin(),
 167       '#description' => $this->t('Ordinarily queues are arranged with the front of the queue (where items will be removed) on top and the back (where items will be added) on the bottom. If checked, this will display the queue such that items will be added to the top and removed from the bottom.'),
 168     ];
 169
 170     // We have to duplicate all the code from
 171     // \Drupal\Core\Field\Plugin\Field\FieldType\EntityReferenceItem::fieldSettingsForm()
 172     // because field settings forms are not easily embeddable.
 173     $form['entity_settings'] = [
 174       '#type' => 'details',
 175       '#title' => $this->t('Entity settings'),
 176       '#open' => TRUE,
 177       '#tree' => TRUE,
 178       '#group' => 'settings',
 179       '#weight' => -1,
 180     ];
 181
 182     // Get all selection plugins for this entity type.
 183     $selection_plugins = $this->selectionManager->getSelectionGroups($target_entity_type_id);
 184     $selection_handlers_options = [];
 185     foreach (array_keys($selection_plugins) as $selection_group_id) {
 186       // We only display base plugins (e.g. 'default', 'views', ...) and not
 187       // entity type specific plugins (e.g. 'default:node', 'default:user',
 188       // ...).
 189       if (array_key_exists($selection_group_id, $selection_plugins[$selection_group_id])) {
 190         $selection_handlers_options[$selection_group_id] = Html::escape($selection_plugins[$selection_group_id][$selection_group_id]['label']);
 191       }
 192       elseif (array_key_exists($selection_group_id . ':' . $target_entity_type_id, $selection_plugins[$selection_group_id])) {
 193         $selection_group_plugin = $selection_group_id . ':' . $target_entity_type_id;
 194         $selection_handlers_options[$selection_group_plugin] = Html::escape($selection_plugins[$selection_group_id][$selection_group_plugin]['base_plugin_label']);
 195       }
 196     }
 197     ksort($selection_handlers_options);
 198
 199     $form['entity_settings']['settings'] = [
 200       '#type' => 'container',
 201       '#process' => [
 202         [EntityReferenceItem::class, 'fieldSettingsAjaxProcess'],
 203         [EntityReferenceItem::class, 'formProcessMergeParent']
 204       ],
 205       '#element_validate' => [[get_class($this), 'entityReferenceSelectionSettingsValidate']],
 206     ];
 207
 208     // @todo It should be up to the queue handler to determine what entity types
 209     // are queue-able.
 210     $form['entity_settings']['settings']['target_type'] = [
 211       '#type' => 'select',
 212       '#title' => $this->t('Type of items to queue'),
 213       '#options' => $this->entityTypeRepository->getEntityTypeLabels(TRUE),
 214       '#default_value' => $target_entity_type_id,
 215       '#required' => TRUE,
 216       '#disabled' => !$queue->isNew(),
 217       '#size' => 1,
 218       '#ajax' => TRUE,
 219       '#limit_validation_errors' => [],
 220     ];
 221
 222     $form['entity_settings']['settings']['handler'] = [
 223       '#type' => 'select',
 224       '#title' => $this->t('Reference method'),
 225       '#options' => $selection_handlers_options,
 226       '#default_value' => $queue->getEntitySettings()['handler'],
 227       '#required' => TRUE,
 228       '#ajax' => TRUE,
 229       '#limit_validation_errors' => [],
 230     ];
 231     $form['entity_settings']['settings']['handler_submit'] = [
 232       '#type' => 'submit',
 233       '#value' => $this->t('Change handler'),
 234       '#limit_validation_errors' => [],
 235       '#attributes' => [
 236         'class' => ['js-hide'],
 237       ],
 238       '#submit' => [[EntityReferenceItem::class, 'settingsAjaxSubmit']],
 239     ];
 240
 241     $form['entity_settings']['settings']['handler_settings'] = [
 242       '#type' => 'container',
 243     ];
 244
 245     $selection_handler = $this->selectionManager->getInstance($queue->getEntitySettings());
 246     $form['entity_settings']['settings']['handler_settings'] += $selection_handler->buildConfigurationForm([], $form_state);
 247
 248     // For entityqueue's purposes, the 'target_bundles' setting of the 'default'
 249     // selection handler does not have to be required.
 250     if (isset($form['entity_settings']['settings']['handler_settings']['target_bundles'])) {
 251       $form['entity_settings']['settings']['handler_settings']['target_bundles']['#required'] = FALSE;
 252     }
 253
 254     return $form;
 255   }
 256
 257   /**
 258    * Form element validation handler; Invokes selection plugin's validation.
 259    *
 260    * @param array $form
 261    *   The form where the settings form is being included in.
 262    * @param \Drupal\Core\Form\FormStateInterface $form_state
 263    *   The form state of the (entire) configuration form.
 264    */
 265   public static function entityReferenceSelectionSettingsValidate(array $form, FormStateInterface $form_state) {
 266     /** @var \Drupal\entityqueue\EntityQueueInterface $queue */
 267     $queue = $form_state->getFormObject()->getEntity();
 268
 269     $selection_handler = \Drupal::service('plugin.manager.entity_reference_selection')->getInstance($queue->getEntitySettings());
 270
 271     // @todo Take care of passing the right $form and $form_state structures to
 272     // the selection validation method. For now, we just have to duplicate the
 273     // validation of the 'default' selection plugin.
 274     $selection_handler->validateConfigurationForm($form, $form_state);
 275
 276     // If no checkboxes were checked for 'target_bundles', store NULL ("all
 277     // bundles are referenceable") rather than empty array ("no bundle is
 278     // referenceable".
 279     if ($form_state->getValue(['entity_settings', 'handler_settings', 'target_bundles']) === []) {
 280       $form_state->setValue(['entity_settings', 'handler_settings', 'target_bundles'], NULL);
 281     }
 282   }
 283
 284   /**
 285    * {@inheritdoc}
 286    */
 287   public function buildEntity(array $form, FormStateInterface $form_state) {
 288     $entity = parent::buildEntity($form, $form_state);
 289     if ($handler = $entity->get('handler')) {
 290       $entity->setHandler($handler);
 291     }
 292     return $entity;
 293   }
 294
 295   /**
 296    * {@inheritdoc}
 297    */
 298   public function save(array $form, FormStateInterface $form_state) {
 299     $queue = $this->entity;
 300     $status = $queue->save();
 301
 302     $edit_link = $queue->toLink($this->t('Edit'), 'edit-form')->toString();
 303     if ($status == SAVED_UPDATED) {
 304       drupal_set_message($this->t('The entity queue %label has been updated.', ['%label' => $queue->label()]));
 305       $this->logger->notice('The entity queue %label has been updated.', ['%label' => $queue->label(), 'link' => $edit_link]);
 306     }
 307     else {
 308       drupal_set_message($this->t('The entity queue %label has been added.', ['%label' => $queue->label()]));
 309       $this->logger->notice('The entity queue %label has been added.', ['%label' => $queue->label(), 'link' =>  $edit_link]);
 310     }
 311
 312     $form_state->setRedirectUrl($queue->toUrl('collection'));
 313   }
 314
 315 }