Chris@0
|
1 <?php
|
Chris@0
|
2
|
Chris@0
|
3 namespace Drupal\views\Plugin\Derivative;
|
Chris@0
|
4
|
Chris@0
|
5 use Drupal\Core\Entity\EntityStorageInterface;
|
Chris@0
|
6 use Drupal\Core\State\StateInterface;
|
Chris@0
|
7 use Drupal\Component\Plugin\Derivative\DeriverBase;
|
Chris@0
|
8 use Drupal\Core\Plugin\Discovery\ContainerDeriverInterface;
|
Chris@0
|
9 use Drupal\Core\Routing\RouteProviderInterface;
|
Chris@0
|
10 use Drupal\views\Views;
|
Chris@0
|
11 use Symfony\Component\DependencyInjection\ContainerInterface;
|
Chris@0
|
12
|
Chris@0
|
13 /**
|
Chris@0
|
14 * Provides local task definitions for all views configured as local tasks.
|
Chris@0
|
15 */
|
Chris@0
|
16 class ViewsLocalTask extends DeriverBase implements ContainerDeriverInterface {
|
Chris@0
|
17
|
Chris@0
|
18 /**
|
Chris@0
|
19 * The route provider.
|
Chris@0
|
20 *
|
Chris@0
|
21 * @var \Drupal\Core\Routing\RouteProviderInterface
|
Chris@0
|
22 */
|
Chris@0
|
23 protected $routeProvider;
|
Chris@0
|
24
|
Chris@0
|
25 /**
|
Chris@0
|
26 * The state key value store.
|
Chris@0
|
27 *
|
Chris@0
|
28 * @var \Drupal\Core\State\StateInterface
|
Chris@0
|
29 */
|
Chris@0
|
30 protected $state;
|
Chris@0
|
31
|
Chris@0
|
32 /**
|
Chris@0
|
33 * The view storage.
|
Chris@0
|
34 *
|
Chris@0
|
35 * @var \Drupal\Core\Entity\EntityStorageInterface
|
Chris@0
|
36 */
|
Chris@0
|
37 protected $viewStorage;
|
Chris@0
|
38
|
Chris@0
|
39 /**
|
Chris@0
|
40 * Constructs a \Drupal\views\Plugin\Derivative\ViewsLocalTask instance.
|
Chris@0
|
41 *
|
Chris@0
|
42 * @param \Drupal\Core\Routing\RouteProviderInterface $route_provider
|
Chris@0
|
43 * The route provider.
|
Chris@0
|
44 * @param \Drupal\Core\State\StateInterface $state
|
Chris@0
|
45 * The state key value store.
|
Chris@0
|
46 * @param \Drupal\Core\Entity\EntityStorageInterface $view_storage
|
Chris@0
|
47 * The view storage.
|
Chris@0
|
48 */
|
Chris@0
|
49 public function __construct(RouteProviderInterface $route_provider, StateInterface $state, EntityStorageInterface $view_storage) {
|
Chris@0
|
50 $this->routeProvider = $route_provider;
|
Chris@0
|
51 $this->state = $state;
|
Chris@0
|
52 $this->viewStorage = $view_storage;
|
Chris@0
|
53 }
|
Chris@0
|
54
|
Chris@0
|
55 /**
|
Chris@0
|
56 * {@inheritdoc}
|
Chris@0
|
57 */
|
Chris@0
|
58 public static function create(ContainerInterface $container, $base_plugin_id) {
|
Chris@0
|
59 return new static(
|
Chris@0
|
60 $container->get('router.route_provider'),
|
Chris@0
|
61 $container->get('state'),
|
Chris@0
|
62 $container->get('entity.manager')->getStorage('view')
|
Chris@0
|
63 );
|
Chris@0
|
64 }
|
Chris@0
|
65
|
Chris@0
|
66 /**
|
Chris@0
|
67 * {@inheritdoc}
|
Chris@0
|
68 */
|
Chris@0
|
69 public function getDerivativeDefinitions($base_plugin_definition) {
|
Chris@0
|
70 $this->derivatives = [];
|
Chris@0
|
71
|
Chris@0
|
72 $view_route_names = $this->state->get('views.view_route_names');
|
Chris@0
|
73 foreach ($this->getApplicableMenuViews() as $pair) {
|
Chris@0
|
74 /** @var $executable \Drupal\views\ViewExecutable */
|
Chris@0
|
75 list($view_id, $display_id) = $pair;
|
Chris@0
|
76 $executable = $this->viewStorage->load($view_id)->getExecutable();
|
Chris@0
|
77
|
Chris@0
|
78 $executable->setDisplay($display_id);
|
Chris@0
|
79 $menu = $executable->display_handler->getOption('menu');
|
Chris@0
|
80 if (in_array($menu['type'], ['tab', 'default tab'])) {
|
Chris@0
|
81 $plugin_id = 'view.' . $executable->storage->id() . '.' . $display_id;
|
Chris@0
|
82 $route_name = $view_route_names[$executable->storage->id() . '.' . $display_id];
|
Chris@0
|
83
|
Chris@0
|
84 // Don't add a local task for views which override existing routes.
|
Chris@0
|
85 // @todo Alternative it could just change the existing entry.
|
Chris@0
|
86 if ($route_name != $plugin_id) {
|
Chris@0
|
87 continue;
|
Chris@0
|
88 }
|
Chris@0
|
89
|
Chris@0
|
90 $this->derivatives[$plugin_id] = [
|
Chris@0
|
91 'route_name' => $route_name,
|
Chris@0
|
92 'weight' => $menu['weight'],
|
Chris@0
|
93 'title' => $menu['title'],
|
Chris@0
|
94 ] + $base_plugin_definition;
|
Chris@0
|
95
|
Chris@0
|
96 // Default local tasks have themselves as root tab.
|
Chris@0
|
97 if ($menu['type'] == 'default tab') {
|
Chris@0
|
98 $this->derivatives[$plugin_id]['base_route'] = $route_name;
|
Chris@0
|
99 }
|
Chris@0
|
100 }
|
Chris@0
|
101 }
|
Chris@0
|
102 return $this->derivatives;
|
Chris@0
|
103 }
|
Chris@0
|
104
|
Chris@0
|
105 /**
|
Chris@0
|
106 * Alters base_route and parent_id into the views local tasks.
|
Chris@0
|
107 */
|
Chris@0
|
108 public function alterLocalTasks(&$local_tasks) {
|
Chris@0
|
109 $view_route_names = $this->state->get('views.view_route_names');
|
Chris@0
|
110
|
Chris@0
|
111 foreach ($this->getApplicableMenuViews() as $pair) {
|
Chris@0
|
112 list($view_id, $display_id) = $pair;
|
Chris@0
|
113 /** @var $executable \Drupal\views\ViewExecutable */
|
Chris@0
|
114 $executable = $this->viewStorage->load($view_id)->getExecutable();
|
Chris@0
|
115
|
Chris@0
|
116 $executable->setDisplay($display_id);
|
Chris@0
|
117 $menu = $executable->display_handler->getOption('menu');
|
Chris@0
|
118
|
Chris@0
|
119 // We already have set the base_route for default tabs.
|
Chris@0
|
120 if (in_array($menu['type'], ['tab'])) {
|
Chris@0
|
121 $plugin_id = 'view.' . $executable->storage->id() . '.' . $display_id;
|
Chris@0
|
122 $view_route_name = $view_route_names[$executable->storage->id() . '.' . $display_id];
|
Chris@0
|
123
|
Chris@0
|
124 // Don't add a local task for views which override existing routes.
|
Chris@0
|
125 if ($view_route_name != $plugin_id) {
|
Chris@0
|
126 unset($local_tasks[$plugin_id]);
|
Chris@0
|
127 continue;
|
Chris@0
|
128 }
|
Chris@0
|
129
|
Chris@0
|
130 // Find out the parent route.
|
Chris@0
|
131 // @todo Find out how to find both the root and parent tab.
|
Chris@0
|
132 $path = $executable->display_handler->getPath();
|
Chris@0
|
133 $split = explode('/', $path);
|
Chris@0
|
134 array_pop($split);
|
Chris@0
|
135 $path = implode('/', $split);
|
Chris@0
|
136
|
Chris@0
|
137 $pattern = '/' . str_replace('%', '{}', $path);
|
Chris@0
|
138 if ($routes = $this->routeProvider->getRoutesByPattern($pattern)) {
|
Chris@0
|
139 foreach ($routes->all() as $name => $route) {
|
Chris@0
|
140 $local_tasks['views_view:' . $plugin_id]['base_route'] = $name;
|
Chris@0
|
141 // Skip after the first found route.
|
Chris@0
|
142 break;
|
Chris@0
|
143 }
|
Chris@0
|
144 }
|
Chris@0
|
145 }
|
Chris@0
|
146 }
|
Chris@0
|
147 }
|
Chris@0
|
148
|
Chris@0
|
149 /**
|
Chris@0
|
150 * Return a list of all views and display IDs that have a menu entry.
|
Chris@0
|
151 *
|
Chris@0
|
152 * @return array
|
Chris@0
|
153 * A list of arrays containing the $view and $display_id.
|
Chris@0
|
154 * @code
|
Chris@0
|
155 * array(
|
Chris@0
|
156 * array($view, $display_id),
|
Chris@0
|
157 * array($view, $display_id),
|
Chris@0
|
158 * );
|
Chris@0
|
159 * @endcode
|
Chris@0
|
160 */
|
Chris@0
|
161 protected function getApplicableMenuViews() {
|
Chris@0
|
162 return Views::getApplicableViews('uses_menu_links');
|
Chris@0
|
163 }
|
Chris@0
|
164
|
Chris@0
|
165 }
|