Add ability to provide local actions and tasks

Local tasks and actions are plugins, and have stable APIs.
Menu links are currently entities, but are in flux: #2227441: New plan, Phase 1:Review the architecture and overall implementation proposal for menu links as plugins

I think they should be split to another issue.

1. +++ b/page_manager.module
   @@ -15,3 +18,21 @@ function page_manager_permission() {
   +/**
   + * Implements hook_local_tasks_alter().
   + */
   +function page_manager_local_tasks_alter(&$local_tasks) {
   +  $container = \Drupal::getContainer();
   +  $local_task = PageManagerLocalTask::create($container, 'page_manager_page');
   +  $local_task->alterLocalTasks($local_tasks);
   +}
   +
   +/**
   + * Implements hook_menu_local_actions_alter().
   + */
   +function page_manager_menu_local_actions_alter(&$local_actions) {
   +  $container = \Drupal::getContainer();
   +  $local_action = PageManagerLocalAction::create($container, 'page_manager_page');
   +  $local_action->alterLocalActions($local_actions);
   +}
   

   Ughhhh I *hate* that we have to do this. /me shakes fist at core

2. +++ b/src/Entity/Page.php
   @@ -70,6 +70,13 @@ class Page extends ConfigEntityBase implements PageInterface {
   +  protected $menu = array();
   
   @@ -167,6 +185,13 @@ class Page extends ConfigEntityBase implements PageInterface {
   +      $this->menu = array(
   +        'type' => 'none',
   +      );
   

   Couldn't these be combined?

3. +++ b/src/Plugin/Derivative/PageManagerLocalAction.php
   @@ -0,0 +1,117 @@
   +        $route_name = "page_manager.page_view_$entity_id";
   +        // @todo: Add a routeName method to the page entity?
   

   Yeahhhh this is tricky. If you look at PageManagerRoutes, we do work to ensure that existing pages are properly taken over.

4. +++ b/src/Plugin/Derivative/PageManagerLocalAction.php
   @@ -0,0 +1,117 @@
   +        $pattern = str_replace('%', '{}', $path);
   

   Do we actually need to do this? In RouteParamContext I have $routes = $this->routeProvider->getRoutesByPattern($page->getPath())->all();

5. +++ b/src/Plugin/Derivative/PageManagerLocalTask.php
   @@ -0,0 +1,121 @@
   +    foreach ($this->entityStorage->loadMultiple() as $entity_id => $entity) {
   ...
   +    foreach ($this->entityStorage->loadMultiple() as $entity_id => $entity) {
   

   I think we should mimic Views' RouteSubscriber and encapsulate this in a protected method, storing them between the two methods.

Let's go with tests next, it will help clarify what we have covered and what we still need.

@rlmumford++

This still needs to address my comments from #5. Unassigning for now since there is a sprint coming up, but @rlmumford if you want it back, assign it back.

Going to work on this issue as part of the layout sprint https://groups.drupal.org/node/423448

Addressed #5.2/4/5 Not sure what to do with #5.3

Installed and tested.

Works well, based on url/paths. Can be applied on own default paths (pm/; pm/tab1; pm/tab2) or on existing ones (admin/tab1). It also works with wildcards /node/%/local1).

For local actions it should be possible to attach them to several paths (analog to the local_action.yml) . This could be achieved by adding a path list or pattern list to the menu definition.

And it needs some help text/documentation to be understood by the user.

Implemented the ability to attach an action link to multiple pages. See screenshot for the UX details.

Really sorry for letting this sit. It needs a reroll now, unfortunately.

+++ b/config/schema/page_manager.schema.yml
index 66724f2..a3eef8a 100644
--- a/page_manager.local_actions.yml

--- a/page_manager.local_actions.yml
+++ b/page_manager.local_actions.yml

+++ b/page_manager.local_actions.yml
+++ b/page_manager.local_actions.yml
@@ -3,3 +3,6 @@ page_manager.page_add:

@@ -3,3 +3,6 @@ page_manager.page_add:
+page_manager_page:
+  class: Drupal\Core\Menu\LocalActionDefault
+  derivative: \Drupal\page_manager\Plugin\Derivative\PageManagerLocalAction

+++ b/page_manager.module
@@ -15,3 +18,21 @@ function page_manager_permission() {
+ * Implements hook_local_tasks_alter().
+ */
+function page_manager_local_tasks_alter(&$local_tasks) {
+  $container = \Drupal::getContainer();
+  $local_task = PageManagerLocalTask::create($container, 'page_manager_page');
+  $local_task->alterLocalTasks($local_tasks);
+}
+
+/**
+ * Implements hook_menu_local_actions_alter().
+ */
+function page_manager_menu_local_actions_alter(&$local_actions) {
+  $container = \Drupal::getContainer();
+  $local_action = PageManagerLocalAction::create($container, 'page_manager_page');
+  $local_action->alterLocalActions($local_actions);
+}

Does the following code still looks like this with all the event subscriber work? Looking around core I still don't see a better way?

I'd love to tackle this issue but would need some instruction on how best to approach this given the codebase is entirely different since this was last looked at.

Any news on this? This is something badly needed :) I also tried to figure out how to reroll, but code base is completely different :(

I am also looking for news on this. Any progress?

Is this a feature that we can just not look forward to having or is it possible to get it functional?

Is there anyone looking into this for 8.7? IMHO this is quite an important piece of functionality.

I'm with you that it is a really required feature. I trying to convince my boss of spending more time in contrib, but no case by now ;)

In the mean time, menu links can be added in a custom module as follows:

"your_module.links.menu.yml":

your_module.you_menu_link_id:
  title: 'Menu item'
  description: 'An example menu item.'
  menu_name: some_menu
  route_name: page_manager.page_id-variant_id
  weight: 10

Drupal Console can be used to get a list of the available page manager pages in your system:

$ console debug:router | grep "page_manager.page"

Thanks @manuel.adan! I was just looking into how to do this. Appreciate the help.

Actually, my menu requirements are a bit different as I am trying to add a tabs (menu local tasks) to a node view (example /node/43/my-tab). Any advice is appreciated.

If anyone else runs into this, you need to create a dynamic local task... I used entity_clone as an example and then trimmer it down to what I needed. I would recommend reading this: https://www.drupal.org/docs/8/api/menu-api/providing-module-defined-loca... and then create a mymodule.links.task.yml file to generate the local tasks in the derivative class placed at src/Plugin/Derivative/DynamicLocalTasks.php as follows:

mymodule.local_tasks:
  deriver: 'Drupal\mymodule\Plugin\Derivative\DynamicLocalTasks'
  weight: 100

And then create the deriver something like as follows:

/**
 * Defines dynamic local tasks.
 */
class DynamicLocalTasks extends DeriverBase implements ContainerDeriverInterface {

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * The translation manager.
   *
   * @var \Drupal\Core\StringTranslation\TranslationManager
   */
  protected $translationManager;

  /**
   * Constructs a new DynamicLocalTasks.
   *
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Drupal\Core\StringTranslation\TranslationManager $string_translation
   *   The translation manager.
   */
  public function __construct(EntityTypeManagerInterface $entity_type_manager, TranslationManager $string_translation) {
    $this->entityTypeManager = $entity_type_manager;
    $this->translationManager = $string_translation;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, $base_plugin_id) {
    return new static(
      $container->get('entity_type.manager'),
      $container->get('string_translation')
    );
  }

  /**
   * {@inheritdoc}
   */
  public function getDerivativeDefinitions($base_plugin_definition) {
    $this->derivatives = [];

    $this->derivatives["node.example_tab"] = [
      'route_name' => "page_manager.page_view_example_tab_example_tab-panels_variant-0",
      'title' => $this->translationManager->translate('My tab'),
      'base_route' => "entity.node.canonical",
      'weight' => 100,
    ];

    return $this->derivatives;
  }

}

Patch flying in with a brain-dead reroll of #18. I'm quite impressed that this is even possible after 6 years. Let's see what breaks.

TODO: Port the simpletests from #18.

Missed some API runaways.

Nice to see this resurrected)

I tested this locally and besides showing the config form it's not yet useful. So NW.

I'm closing this one as a duplicate of #2620036: Allow pages to have menu items.

That issue also provides support for local tasks and actions (in addition to normal menu items), and it has an up-to-date, working patch.

Looking at the latest patch on this issue, there are some small features here than aren't implemented there, for example, setting additional visibility paths on local actions. However, I think it'd be easier to add those into the patch on the other issue (or in a follow-up) rather than trying to resurrect this one.