Coverage index

src/Controller/DisplayLinkController.php

Lines: 0.00%

LineHitsSource
1
<?php
2
3
namespace Drupal\visitors\Controller;
4
5
use Drupal\Core\Ajax\AjaxResponse;
6
use Drupal\Core\Ajax\ReplaceCommand;
7
use Drupal\Core\Controller\ControllerBase;
8
use Drupal\views\Views;
9
use Symfony\Component\HttpFoundation\Request;
10
11
/**
12
 * Display Link Controller.
13
 *
14
 * Returns the display link for a given view and display.
15
 */
16
class DisplayLinkController extends ControllerBase {
17
18
  /**
19
   * Single-action controller.
20
   */
21
  public function __invoke(Request $request, string $view_id, string $display_id) {
220
    $blocks['path'] = [
230
      '#view_id'      => $view_id,
240
      '#view_display' => $display_id,
250
    ];
26
27
    // Store AJAX parameters to exclude from sort links in a static variable
28
    // that can be accessed by our theme preprocessing hook.
290
    $ajax_params_to_remove = [
300
      'class',
310
      '_wrapper_format',
320
      'ajax_form',
330
      '_drupal_ajax',
340
    ];
35
36
    // Store these in a static variable for the theme hook.
370
    $excluded_params = &drupal_static('visitors_excluded_sort_params', []);
380
    $excluded_params = $ajax_params_to_remove;
39
40
    // Get the referrer URL and extract sort/order parameters.
410
    $referrer = $request->headers->get('referer');
420
    $referrer_path = '';
430
    $sort_args = [];
44
450
    if ($referrer) {
460
      $referrer_parts = parse_url($referrer);
470
      $referrer_path = $referrer_parts['path'] ?? '';
48
49
      // Extract query parameters from referrer.
500
      if (!empty($referrer_parts['query'])) {
510
        parse_str($referrer_parts['query'], $referrer_query);
52
53
        // Check if referrer has sort/order parameters.
540
        if (isset($referrer_query['order'])) {
550
          $sort_args['order'] = $referrer_query['order'];
56
        }
570
        if (isset($referrer_query['sort'])) {
580
          $sort_args['sort'] = $referrer_query['sort'];
59
        }
60
      }
61
620
      $referrer_path_static = &drupal_static('visitors_referrer_path', '');
630
      $referrer_path_static = $referrer_path;
64
    }
65
66
    // The view render element is what views_embed_view() returns, and it
67
    // is available on every supported Drupal release.
680
    $rendered = [
690
      '#type'       => 'view',
700
      '#name'       => $view_id,
710
      '#display_id' => $display_id,
720
      '#arguments'  => [],
730
    ];
74
75
    // Apply sort parameters from referrer to the view.
760
    if (!empty($sort_args)) {
77
      // Load the view manually to apply sorting.
780
      $view = Views::getView($view_id);
790
      if ($view && $view->access($display_id)) {
800
        $view->setDisplay($display_id);
81
82
        // Apply the sort parameters to the view.
830
        if (isset($sort_args['order']) && isset($sort_args['sort'])) {
840
          $order_field = $sort_args['order'];
850
          $sort_direction = strtoupper($sort_args['sort']);
86
87
          // Set the sort on the view's table style plugin.
880
          if ($view->display_handler->getPlugin('style') &&
890
              method_exists($view->display_handler->getPlugin('style'), 'options')) {
900
            $style_plugin = $view->display_handler->getPlugin('style');
910
            $style_plugin->active = $order_field;
920
            $style_plugin->order = $sort_direction;
93
          }
94
95
          // Also set it via the request for the table style to pick up.
960
          $temp_query = $sort_args;
970
          $temp_request = $request->duplicate($temp_query);
980
          $view->setRequest($temp_request);
99
        }
100
101
        // Build the renderable array.
1020
        $rendered = $view->buildRenderable($display_id);
103
      }
104
    }
105
106
    // Set live preview mode to ensure sort links use current route.
1070
    if (isset($rendered['view_build']['#view'])) {
1080
      $view = $rendered['view_build']['#view'];
1090
      $view->live_preview = TRUE;
1100
      if (!empty($referrer_path)) {
1110
        $view->override_path = $referrer_path;
112
      }
113
    }
114
1150
    $settings = NULL;
1160
    $selector = $request->query->get('class');
117
1180
    $response = new AjaxResponse();
1190
    $response->addCommand(new ReplaceCommand($selector, $rendered, $settings));
120
1210
    return $response;
122
  }
123
124
  /**
125
   * Extract view ID and display ID from the class parameter.
126
   *
127
   * The class parameter contains the format:
128
   *  .view-id-{view_id}.view-display-id-{display_id}
129
   * This method extracts both the view ID and display ID from this format.
130
   *
131
   * @param string|null $class_selector
132
   *   The class selector string.
133
   *
134
   * @return array|null
135
   *   Array containing [view_id, display_id] if found, null otherwise.
136
   */
137
  protected function extractViewAndDisplayFromClass(?string $class_selector): ?array {
1380
    if (empty($class_selector)) {
1390
      return NULL;
140
    }
141
142
    // Extract view ID and display ID from the format:
143
    // .view-id-{view_id}.view-display-id-{display_id}.
1440
    if (preg_match('/\.view-id-([^.\s]+)\.view-display-id-([^.\s]+)/', $class_selector, $matches)) {
1450
      return [$matches[1], $matches[2]];
146
    }
147
1480
    return NULL;
149
  }
150
151
}