class panels_renderer_single_pane in Panels 6.3

Hierarchy

• class \panels_renderer_standard
  • class \panels_renderer_single_pane

1 string reference to 'panels_renderer_single_pane'

single_pane.inc in plugins/display_renderers/single_pane.inc

File

plugins/display_renderers/panels_renderer_single_pane.class.php, line 3

class panels_renderer_single_pane extends panels_renderer_standard {

  /**
   * The pane id of the pane that will be rendered by a call to the render()
   * method. Numeric int or string (typically if a new-# id has been used).
   * @var mixed
   */
  var $render_pid;

  /**
   * Modified build method (vs. panels_renderer_standard::build()); takes just
   * the display, no layout is necessary.
   *
   * @param array $plugin
   *   The definition of the renderer plugin.
   *
   * @param panels_display $display
   *   The panels display object to be rendered.
   */
  function init($plugin, &$display) {
    $this->plugin = $plugin;
    $this->display =& $display;
  }
  function prepare($external_settings = NULL) {
    $this->render_pid = $external_settings;
  }
  function render() {

    // If no requested pid, or requested pid does not exist,
    if (empty($this->render_pid) || empty($this->display->content[$this->render_pid])) {
      return NULL;
    }
    return $this
      ->render_pane($this->display->content[$this->render_pid]);
  }
  function render_single($pid) {
    return $this
      ->render_pane($this->display->content[$pid]);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
panels_renderer_single_pane::$render_pid		property	The pane id of the pane that will be rendered by a call to the render() method. Numeric int or string (typically if a new-# id has been used).
panels_renderer_single_pane::init		function	Modified build method (vs. panels_renderer_standard::build()); takes just the display, no layout is necessary. Overrides panels_renderer_standard::init
panels_renderer_single_pane::prepare		function	Prepare the attached display for rendering. Overrides panels_renderer_standard::prepare
panels_renderer_single_pane::render		function	Build inner content, then hand off to layout-specified theme function for final render step. Overrides panels_renderer_standard::render
panels_renderer_single_pane::render_single		function
panels_renderer_standard::$admin		property	TRUE if this renderer is rendering in administrative mode which will allow layouts to have extra functionality.	1
panels_renderer_standard::$display		property	The fully-loaded Panels display object that is to be rendered. "Fully loaded" is defined as: 1. Having been produced by panels_load_displays(), whether or this page request or at some time in the past and the object was exported. 2. Having…
panels_renderer_standard::$meta_location		property	Where to add standard meta information. There are three possibilities:
panels_renderer_standard::$plugin		property	The plugin that defines this handler.
panels_renderer_standard::$plugins		property	An associative array of loaded plugins. Used primarily as a central location for storing plugins that require additional loading beyond reading the plugin definition, which is already statically cached by ctools_get_plugins(). An example is layout…
panels_renderer_standard::$prefix		property	Include rendered HTML prior to the layout.
panels_renderer_standard::$prepared		property	A multilevel array of data prepared for rendering. The first level of the array indicates the type of prepared data. The standard renderer populates and uses two top-level keys, 'panes' and 'regions':
panels_renderer_standard::$prep_run		property	Boolean state variable, indicating whether or not the prepare() method has been run.
panels_renderer_standard::$rendered		property	A multilevel array of rendered data. The first level of the array indicates the type of rendered data, typically with up to three keys: 'layout', 'regions', and 'panes'. The relevant rendered data is stored as the value…
panels_renderer_standard::$suffix		property	Include rendered HTML after the layout.
panels_renderer_standard::add_css		function	Add CSS information to the renderer.
panels_renderer_standard::add_meta		function	Attach out-of-band page metadata (e.g., CSS and JS).	1
panels_renderer_standard::prepare_panes		function	Prepare the list of panes to be rendered, accounting for visibility/access settings and rendering order.
panels_renderer_standard::prepare_regions		function	Prepare the list of regions to be rendered.
panels_renderer_standard::render_layout		function	Perform display/layout-level render operations.
panels_renderer_standard::render_pane		function	Render a pane using its designated style.	1
panels_renderer_standard::render_panes		function	Render all prepared panes, first by dispatching to their plugin's render callback, then handing that output off to the pane's style plugin.	1
panels_renderer_standard::render_pane_content		function	Render the interior contents of a single pane.	1
panels_renderer_standard::render_region		function	Render a single panel region.	1
panels_renderer_standard::render_regions		function	Render all prepared regions, placing already-rendered panes into their appropriate positions therein.	1