You are here

function panels_renderer_standard::prepare in Panels 6.3

Same name and namespace in other branches
  1. 7.3 plugins/display_renderers/panels_renderer_standard.class.php \panels_renderer_standard::prepare()

Prepare the attached display for rendering.

This is the outermost prepare method. It calls several sub-methods as part of the overall preparation process. This compartmentalization is intended to ease the task of modifying renderer behavior in child classes.

If you override this method, it is important that you either call this method via parent::prepare(), or manually set $this->prep_run = TRUE.

Parameters

mixed $external_settings: An optional parameter allowing external code to pass in additional settings for use in the preparation process. Not used in the default renderer, but included for interface consistency.

1 call to panels_renderer_standard::prepare()
panels_renderer_standard::render_layout in plugins/display_renderers/panels_renderer_standard.class.php
Perform display/layout-level render operations.
2 methods override panels_renderer_standard::prepare()
panels_renderer_simple::prepare in plugins/display_renderers/panels_renderer_simple.class.php
Prepare the attached display for rendering.
panels_renderer_single_pane::prepare in plugins/display_renderers/panels_renderer_single_pane.class.php
Prepare the attached display for rendering.

File

plugins/display_renderers/panels_renderer_standard.class.php, line 194

Class

panels_renderer_standard
The standard render pipeline for a Panels display object.

Code

function prepare($external_settings = NULL) {
  $this
    ->prepare_panes($this->display->content);
  $this
    ->prepare_regions($this->display->panels, $this->display->panel_settings);
  $this->prep_run = TRUE;
}