panels_page.render.inc in Panels 6.2

panels_page.render.inc Functions utilized during the panels_page render process. On any given page request, this file is lazy-loaded by panels_page itself only after it has been absolutely verified that a panels_page render should be done.

File

panels_page/panels_page.render.inc

<?php

/**
 * @file panels_page.render.inc
 *  Functions utilized during the panels_page render process. On any given page
 *  request, this file is lazy-loaded by panels_page itself only after it has
 *  been absolutely verified that a panels_page render should be done.
 */

/**
 * Load the $load object with all the necessary data for the current panels_page
 * callback.
 *
 * @param $load
 *   A single panels_page master loader object.
 * @param $panel_page
 * @param $args
 */
function panels_page_prepare_panels_render(&$load, &$panel_page) {
  _panels_page_prepare_panels_render($panel_page);

  // TODO the original logic is commented out, but retained; switch back to it if anything quirky happens
  // $load->title          = (!$panel_page->display->hide_title && $title = filter_xss_admin(panels_page_get_title($panel_page, 'page', ''))) ? $title : '';
  $load->title = $panel_page->display->hide_title ? '' : filter_xss_admin(panels_page_get_title($panel_page, 'page', ''));
  $load->page_callback = 'panels_page_render_page_' . ($panel_page->form ? 'form' : 'normal');

  // Pass by ref to ENSURE php4/5 consistency and minimize static cache size.
  $load->panel_page =& $panel_page;
  $load->page_arguments = array(
    &$load->panel_page,
    $load->panel_args,
    FALSE,
  );
  return $load;
}
function _panels_page_prepare_panels_render(&$panel_page) {
  _panels_page_check_switchers($panel_page);
  $panel_page->context = panels_context_load_contexts($panel_page, FALSE, $panel_page->context);

  // The below does not make sense.
  //  $panel_page->context = panels_context_load_contexts($panel_page);
  // If we're wrapping FAPI with with panel, this function gets the data.
  $panel_page->form = panels_context_get_form($panel_page->context);

  // Get any keywords (for title substitution in panes)
  $panel_page->keywords = panels_context_get_keywords($panel_page->context);

  // Figure out which display to use, then retrieve it into the current spot.
  panels_page_fetch_display($panel_page, panels_argument_get_display($panel_page->arguments, $panel_page->context));
  panels_page_set_current($panel_page);
}
function _panels_page_check_switchers(&$panel_page) {
  $switchers = panels_get_switchers();
  if ($switchers) {
    $candidates = $list = array();
    $result = db_query("SELECT name FROM {panels_page} WHERE switcher_name = '%s'", $panel_page->name);

    // get a list of all pages that might switch for this one
    while ($candidate = db_fetch_object($result)) {
      $list[] = $candidate->name;
    }

    // Add default panels that apply to the list as well
    foreach (panels_page_default_panels() as $page) {
      if ($page->switcher_name == $panel_page->name) {
        $candidates[$page->name] = $page;
      }
    }
    if ($list) {
      $candidates += count($list) > 1 ? panels_page_load_all($list) : array(
        panels_page_load($list[0]),
      );
    }
    if ($candidates) {

      // separate them based on switcher type
      $pages = array();
      foreach ($candidates as $candidate) {
        $pages[$candidate->switcher_type][$candidate->name] = $candidate;
      }

      // go through switcher types and switch the first one that matches.
      foreach ($pages as $plugin => $candidates) {
        if ($page = panels_switcher_switch($plugin, 'panel_page', $panel_page->name, $candidates)) {
          $panel_page = $page;
          break;
        }
      }
    }
  }
}
function _panels_page_prepare_display($panel_page, $args = array()) {
  $panel_page->display->args = $args;
  $panel_page->display->context = $panel_page->context;
  $panel_page->display->keywords = $panel_page->keywords;
  $panel_page->display->css_id = $panel_page->css_id;
  $panel_page->display->owner =& $panel_page;

  // TODO ref/value php4/5 compat problem?
  $panel_page->display->owner->id = $panel_page->name;
  $panel_page->display->type = 'panel_page';
}

/**
 * Execute a normal (i.e., non-form embedded) panels_page render.
 *
 * @param object $panel_page
 * @param array $args
 */
function panels_page_render_page_normal($panel_page, $args) {
  _panels_page_prepare_display($panel_page, $args);
  $output = panels_render_display($panel_page->display);
  panels_page_custom_css($panel_page);
  if ($panel_page->no_blocks) {
    print theme('page', $output, FALSE);
  }
  else {
    return $output;
  }
}

/**
 * Execute a panels_page render with an embedded form.
 *
 * @param $panel_page
 * @param $args
 */
function panels_page_render_page_form($panel_page, $args) {
  _panels_page_prepare_display($panel_page, $args);
  $form = drupal_clone($panel_page->form);
  $form->form['#theme'] = 'panels_page_render_form';
  $form->form['#display'] = $panel_page->display;
  $output = drupal_render_form($form->form_id, $form->form);
  panels_page_custom_css($panel_page);
  if ($panel_page->no_blocks) {
    print theme('page', $output, FALSE);
  }
  else {
    return $output;
  }
}

/**
 * Add custom css entered on the configuration form, if any. Filter it first.
 *
 * @param $panel_page
 */
function panels_page_custom_css($panel_page) {
  if ($panel_page->css) {
    panels_load_include('panels_page.css_filter', 'panels_page/');
    $css = panels_page_filter_css(panels_page_disassemble_css($panel_page->css));

    // If the custom css didn't survive filtering, don't bother adding it.
    if (!empty($css)) {
      drupal_set_html_head("<style type=\"text/css\" media=\"all\">" . panels_page_compress_css($css) . "</style>\n");
    }
  }
}

Functions

Name	Description
panels_page_custom_css	Add custom css entered on the configuration form, if any. Filter it first.
panels_page_prepare_panels_render	Load the $load object with all the necessary data for the current panels_page callback.
panels_page_render_page_form	Execute a panels_page render with an embedded form.
panels_page_render_page_normal	Execute a normal (i.e., non-form embedded) panels_page render.
_panels_page_check_switchers
_panels_page_prepare_display
_panels_page_prepare_panels_render