Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\views\Plugin\Derivative;
Chris@0: 
Chris@0: use Drupal\Core\Entity\EntityStorageInterface;
Chris@0: use Drupal\Core\State\StateInterface;
Chris@0: use Drupal\Component\Plugin\Derivative\DeriverBase;
Chris@0: use Drupal\Core\Plugin\Discovery\ContainerDeriverInterface;
Chris@0: use Drupal\Core\Routing\RouteProviderInterface;
Chris@0: use Drupal\views\Views;
Chris@0: use Symfony\Component\DependencyInjection\ContainerInterface;
Chris@0: 
Chris@0: /**
Chris@0:  * Provides local task definitions for all views configured as local tasks.
Chris@0:  */
Chris@0: class ViewsLocalTask extends DeriverBase implements ContainerDeriverInterface {
Chris@0: 
Chris@0:   /**
Chris@0:    * The route provider.
Chris@0:    *
Chris@0:    * @var \Drupal\Core\Routing\RouteProviderInterface
Chris@0:    */
Chris@0:   protected $routeProvider;
Chris@0: 
Chris@0:   /**
Chris@0:    * The state key value store.
Chris@0:    *
Chris@0:    * @var \Drupal\Core\State\StateInterface
Chris@0:    */
Chris@0:   protected $state;
Chris@0: 
Chris@0:   /**
Chris@0:    * The view storage.
Chris@0:    *
Chris@0:    * @var \Drupal\Core\Entity\EntityStorageInterface
Chris@0:    */
Chris@0:   protected $viewStorage;
Chris@0: 
Chris@0:   /**
Chris@0:    * Constructs a \Drupal\views\Plugin\Derivative\ViewsLocalTask instance.
Chris@0:    *
Chris@0:    * @param \Drupal\Core\Routing\RouteProviderInterface $route_provider
Chris@0:    *   The route provider.
Chris@0:    * @param \Drupal\Core\State\StateInterface $state
Chris@0:    *   The state key value store.
Chris@0:    * @param \Drupal\Core\Entity\EntityStorageInterface $view_storage
Chris@0:    *   The view storage.
Chris@0:    */
Chris@0:   public function __construct(RouteProviderInterface $route_provider, StateInterface $state, EntityStorageInterface $view_storage) {
Chris@0:     $this->routeProvider = $route_provider;
Chris@0:     $this->state = $state;
Chris@0:     $this->viewStorage = $view_storage;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public static function create(ContainerInterface $container, $base_plugin_id) {
Chris@0:     return new static(
Chris@0:       $container->get('router.route_provider'),
Chris@0:       $container->get('state'),
Chris@0:       $container->get('entity.manager')->getStorage('view')
Chris@0:     );
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getDerivativeDefinitions($base_plugin_definition) {
Chris@0:     $this->derivatives = [];
Chris@0: 
Chris@0:     $view_route_names = $this->state->get('views.view_route_names');
Chris@0:     foreach ($this->getApplicableMenuViews() as $pair) {
Chris@0:       /** @var $executable \Drupal\views\ViewExecutable */
Chris@0:       list($view_id, $display_id) = $pair;
Chris@0:       $executable = $this->viewStorage->load($view_id)->getExecutable();
Chris@0: 
Chris@0:       $executable->setDisplay($display_id);
Chris@0:       $menu = $executable->display_handler->getOption('menu');
Chris@0:       if (in_array($menu['type'], ['tab', 'default tab'])) {
Chris@0:         $plugin_id = 'view.' . $executable->storage->id() . '.' . $display_id;
Chris@0:         $route_name = $view_route_names[$executable->storage->id() . '.' . $display_id];
Chris@0: 
Chris@0:         // Don't add a local task for views which override existing routes.
Chris@0:         // @todo Alternative it could just change the existing entry.
Chris@0:         if ($route_name != $plugin_id) {
Chris@0:           continue;
Chris@0:         }
Chris@0: 
Chris@0:         $this->derivatives[$plugin_id] = [
Chris@0:           'route_name' => $route_name,
Chris@0:           'weight' => $menu['weight'],
Chris@0:           'title' => $menu['title'],
Chris@0:         ] + $base_plugin_definition;
Chris@0: 
Chris@0:         // Default local tasks have themselves as root tab.
Chris@0:         if ($menu['type'] == 'default tab') {
Chris@0:           $this->derivatives[$plugin_id]['base_route'] = $route_name;
Chris@0:         }
Chris@0:       }
Chris@0:     }
Chris@0:     return $this->derivatives;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Alters base_route and parent_id into the views local tasks.
Chris@0:    */
Chris@0:   public function alterLocalTasks(&$local_tasks) {
Chris@0:     $view_route_names = $this->state->get('views.view_route_names');
Chris@0: 
Chris@0:     foreach ($this->getApplicableMenuViews() as $pair) {
Chris@0:       list($view_id, $display_id) = $pair;
Chris@0:       /** @var $executable \Drupal\views\ViewExecutable */
Chris@0:       $executable = $this->viewStorage->load($view_id)->getExecutable();
Chris@0: 
Chris@0:       $executable->setDisplay($display_id);
Chris@0:       $menu = $executable->display_handler->getOption('menu');
Chris@0: 
Chris@0:       // We already have set the base_route for default tabs.
Chris@0:       if (in_array($menu['type'], ['tab'])) {
Chris@0:         $plugin_id = 'view.' . $executable->storage->id() . '.' . $display_id;
Chris@0:         $view_route_name = $view_route_names[$executable->storage->id() . '.' . $display_id];
Chris@0: 
Chris@0:         // Don't add a local task for views which override existing routes.
Chris@0:         if ($view_route_name != $plugin_id) {
Chris@0:           unset($local_tasks[$plugin_id]);
Chris@0:           continue;
Chris@0:         }
Chris@0: 
Chris@0:         // Find out the parent route.
Chris@0:         // @todo Find out how to find both the root and parent tab.
Chris@0:         $path = $executable->display_handler->getPath();
Chris@0:         $split = explode('/', $path);
Chris@0:         array_pop($split);
Chris@0:         $path = implode('/', $split);
Chris@0: 
Chris@0:         $pattern = '/' . str_replace('%', '{}', $path);
Chris@0:         if ($routes = $this->routeProvider->getRoutesByPattern($pattern)) {
Chris@0:           foreach ($routes->all() as $name => $route) {
Chris@0:             $local_tasks['views_view:' . $plugin_id]['base_route'] = $name;
Chris@0:             // Skip after the first found route.
Chris@0:             break;
Chris@0:           }
Chris@0:         }
Chris@0:       }
Chris@0:     }
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Return a list of all views and display IDs that have a menu entry.
Chris@0:    *
Chris@0:    * @return array
Chris@0:    *   A list of arrays containing the $view and $display_id.
Chris@0:    * @code
Chris@0:    * array(
Chris@0:    *   array($view, $display_id),
Chris@0:    *   array($view, $display_id),
Chris@0:    * );
Chris@0:    * @endcode
Chris@0:    */
Chris@0:   protected function getApplicableMenuViews() {
Chris@0:     return Views::getApplicableViews('uses_menu_links');
Chris@0:   }
Chris@0: 
Chris@0: }