Page manager contexts unavailable with Panelizer variant

There really is no way to know if the page manager page that the panelizer might be used on will have extra contexts or not. Once you stipulate that, you're suddenly requiring knowledge of where the panelized entity might be used. Remember that the bulk of panelizer configuration is done away from Page Manager and has no knowledge of it. Just because you made a page and used the panelizer task handler, that has to get communicated back to panelizer. but what if you made another page, added the panelizer entity, and used different contexts?

The only way I can think to do it might be to allow 'required contexts' but that's going to get kind of ugly. The basic node_view template simply won't have any other contexts, so for 99% of users, the required contexts would become very confusing and hard to use.

This is absolutely not a bug.

That makes them there on render, but they're useless if they're not there on edit.

Editing the panelizer page is completely separated from the page manager page.

Panels Everywhere has the same problem -- you often want templates to inherit context from the inner content, and it's very difficult to do.

Oh I see. That's interested. I hadn't considered that possibility.

Can you create a proper patch?

+function _panelizer_panelizer_task_get_extra_contexts($handler, $base_contexts, $context) {
+  $extra_contexts = ctools_context_handler_get_handler_contexts($base_contexts, $handler);
+
+  // Prevent the panelized context from appearing again in the extra contexts.
+  foreach ($extra_contexts as $id => $extra_context) {
+    if ($extra_context->identifier == $context->identifier) {
+      unset($extra_contexts[$id]);
+    }
+  }
+
+  return $extra_contexts;
+}

I don't think relying on the identifier is a good way to do this. While it probably works in most cases, I worry it might not work in all. We need to think about a better way to figure out which of the contexts from Page Manager is the entity we're using. I think that in most cases, we actually have a setting that marks this in the current code. We should use that and make sure the setting is up to date -- I believe there is already code that tries to account for task handlers created prior to the setting existing.

There is a context selector here: http://drupalcode.org/project/panelizer.git/blob/refs/heads/7.x-2.x:/plu...

This needs to be reviewed for v3, and probably rerolled.

Lets leave it as Needs Work for the v3 branch until someone rerolls it.

Here's a re-roll :)
Seems to work as expected.
I've made a slight change - I didn't understand why following include is conditional:

 function panelizer_panelizer_task_test($handler, $base_contexts) {
   if (empty($base_contexts)) {
     ctools_include('context');
   }

So I got rid of the condition.

This isn't working for me.

From panelizer_node.inc

    $extra_contexts = _panelizer_panelizer_task_get_extra_contexts($handler, $base_contexts);
    $info = $entity_handler->render_entity($context->data, 'page_manager', NULL, $args, $address, $extra_contexts);

Here it is passing $extra_contexts to render_entity, however \PanelizerEntityNode's render_entity expects

  function render_entity($entity, $view_mode, $langcode = NULL, $args = array(), $address = NULL) {
    $info = parent::render_entity($entity, $view_mode, $langcode, $args, $address);

Meaning that, from my debug step through, contexts get lost immediately after being retrieved.

Edit: Looks like Node is the only entity that would have this issue. Reroll incoming.

Here's patch with updated PanelizerEntityNode

Committed! Thank you all for your help in completing this!