Updated all the contrib modules to their latest versions.

[yaffs-website] / web / modules / contrib / entityqueue / src / Plugin / views / sort / EntityQueueInQueue.php

diff --git a/web/modules/contrib/entityqueue/src/Plugin/views/sort/EntityQueueInQueue.php b/web/modules/contrib/entityqueue/src/Plugin/views/sort/EntityQueueInQueue.php
new file mode 100644 (file)
index 0000000..b679675
--- /dev/null
+++ b/web/modules/contrib/entityqueue/src/Plugin/views/sort/EntityQueueInQueue.php
@@ -0,0 +1,103 @@
+<?php
+
+namespace Drupal\entityqueue\Plugin\views\sort;
+
+use Drupal\Core\Messenger\MessengerInterface;
+use Drupal\Core\Session\AccountInterface;
+use Drupal\entityqueue\Plugin\views\relationship\EntityQueueRelationship;
+use Drupal\views\Plugin\views\sort\SortPluginBase;
+use Drupal\Core\Messenger\Messenger;
+use Symfony\Component\DependencyInjection\ContainerInterface;
+
+/**
+ * Sort handler for ordering the results based on their queue position.
+ *
+ * @ingroup views_sort_handlers
+ *
+ * @ViewsSort("entity_queue_in_queue")
+ */
+class EntityQueueInQueue extends SortPluginBase {
+
+  /**
+   * The current user.
+   *
+   * @var \Drupal\Core\Session\AccountInterface
+   */
+  protected $currentUser;
+
+  /**
+   * The messenger.
+   *
+   * @var \Drupal\Core\Messenger\MessengerInterface
+   */
+  protected $messenger;
+
+  /**
+   * Constructs a new EntityQueueInQueue 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 array $plugin_definition
+   *   The plugin implementation definition.
+   * @param \Drupal\Core\Session\AccountInterface $current_user
+   *   The current user.
+   * @param \Drupal\Core\Messenger\MessengerInterface $messenger
+   *   The messenger.
+   */
+  public function __construct(array $configuration, $plugin_id, array $plugin_definition, AccountInterface $current_user, MessengerInterface $messenger) {
+    parent::__construct($configuration, $plugin_id, $plugin_definition);
+
+    $this->currentUser = $current_user;
+    $this->messenger = $messenger;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
+    return new static(
+      $configuration,
+      $plugin_id,
+      $plugin_definition,
+      $container->get('current_user'),
+      $container->get('messenger')
+    );
+  }
+
+  /**
+   * {@inheritdoc}.
+   */
+  public function query() {
+    $this->ensureMyTable();
+
+    // Try to find an entity queue relationship in this view, and pick the first
+    // one available.
+    $entity_queue_relationship = NULL;
+    foreach ($this->view->relationship as $id => $relationship) {
+      if ($relationship instanceof EntityQueueRelationship) {
+        $entity_queue_relationship = $relationship;
+        $this->options['relationship'] = $id;
+        $this->setRelationship();
+
+        break;
+      }
+    }
+
+    if ($entity_queue_relationship) {
+      // Add the field.
+      $subqueue_items_table_alias = $entity_queue_relationship->first_alias;
+      $this->query->addOrderBy($subqueue_items_table_alias, 'bundle', $this->options['order']);
+    }
+    else {
+      if ($this->currentUser->hasPermission('administer views')) {
+        $this->messenger->addMessage($this->t('In order to sort by in queue, you need to add the Entityqueue: Queue relationship on View: @view with display: @display',
+          ['@view' => $this->view->storage->label(),
+            '@display' => $this->view->current_display]
+        ),  Messenger::TYPE_ERROR);
+      }
+    }
+  }
+
+}