panelizer_node.inc in Panelizer 6

This is the task handler plugin to handle node_view.

File

plugins/task_handlers/panelizer_node.inc

<?php

/**
 * @file
 *
 * This is the task handler plugin to handle node_view.
 */

// Plugin definition
$plugin = array(
  // is a 'context' handler type, meaning it supports the API of the
  // context handlers provided by ctools context plugins.
  'handler type' => 'context',
  // may NOT be added up front.
  'visible' => FALSE,
  // Administrative fields.
  'title' => t('Panelizer'),
  'admin summary' => 'panelizer_panelizer_task_admin_summary',
  'operations' => array(),
  // Callback to render the data.
  'render' => 'panelizer_panelizer_task_render',
  'test' => 'panelizer_panelizer_task_test',
);

/**
 * Callback to provide administrative summary of the task handler.
 */
function panelizer_panelizer_task_admin_summary($handler, $task, $subtask, $page, $show_title = TRUE) {
  $output = '';
  $output .= '<div class="clear-block">';
  if ($show_title) {

    // Get the operations
    $operations = page_manager_get_operations($page);

    // Get operations for just this handler.
    $operations = $operations['handlers']['children'][$handler->name]['children']['actions']['children'];
    $args = array(
      'handlers',
      $handler->name,
      'actions',
    );
    $rendered_operations = page_manager_render_operations($page, $operations, array(), array(
      'class' => 'actions',
    ), 'actions', $args);
    $output .= '<div class="handler-title clear-block">';
    $output .= '<div class="actions handler-actions">' . $rendered_operations['actions'] . '</div>';
    $output .= '<span class="title-label">' . t('Panelizer') . '</span>';
    $output .= '</div>';
  }
  $access = t('This variant will be selected if the node being viewed is panelized. This variant must be enabled and selected for panelizer to work!');
  $rows[] = array(
    array(
      'class' => t('page-summary-label'),
      'data' => t('Selection rule'),
    ),
    array(
      'class' => t('page-summary-data'),
      'data' => $access,
    ),
    array(
      'class' => t('page-summary-operation'),
      '',
    ),
  );
  $output .= theme('table', array(), $rows, array(
    'class' => 'page-manager-handler-summary',
  ));
  $output .= '</div>';
  return $output;
}

/**
 * Render a node that has been panelized.
 */
function panelizer_panelizer_task_render($handler, $base_contexts, $args, $test = TRUE) {

  // The node this is for should always be the first context available. If
  // this is not a node, bail. This should allow us to be used on things
  // that aren't node_view if, for some weird reason, people want to.
  if (empty($base_contexts)) {
    return;
  }
  $context = reset($base_contexts);
  if ($context->type != 'node' || empty($context->data)) {
    return;
  }

  // Extract the node from the context so we can load the panelizer.
  $node =& $context->data;

  // Load the panelizer and render the display.
  ctools_include('node', 'panelizer');
  return panelizer_render_node($node, $args);
}

/**
 * Determine if the panelizer task handler should fire.
 *
 * This returns true if the configured node is panelized and has
 * a display.
 */
function panelizer_panelizer_task_test($handler, $base_contexts) {
  if (empty($base_contexts)) {
    return;
  }
  $context = reset($base_contexts);
  if (empty($context->data)) {
    return;
  }
  $node =& $context->data;
  ctools_include('node', 'panelizer');
  $panelizer = panelizer_load_node_panelizer($node);
  if (empty($panelizer)) {
    return FALSE;
  }

  // Load the display
  $display = panelizer_load_display($panelizer);
  if (empty($display)) {
    return FALSE;
  }
  return TRUE;
}

Functions

Name	Description
panelizer_panelizer_task_admin_summary	Callback to provide administrative summary of the task handler.
panelizer_panelizer_task_render	Render a node that has been panelized.
panelizer_panelizer_task_test	Determine if the panelizer task handler should fire.