Hook Invokers

---

Detailed Description

Functions in this list invoke one of Panels' numerous hooks. This includes hooks provided by the Panels API itself, as well the client modules that are packaged with Panels.

Functions
	panels_get_include_directories ($plugin_type)
	panels_get_pane_content ($display, $pane, $args=array(), $context=NULL, $incoming_content= '')
	panels_load_displays ($dids)
	panels_load_hooks ($hook)
	panels_mini_default_panels ()
	panels_page_default_panels ()
	panels_render_display (&$display)
	panels_views_default_panels ()

---

Function Documentation

panels_get_include_directories

(

$

plugin_type

)

Invocation of panels_include_directory(), part of the main panels API.

See also:

panels_panels_include_directory()

This hook allows other modules to create their own panels .inc files according to the same filename and directory schema utilized by Panels itself, or some other arbitrary schema defined in implementations of the hook. Essentially, instead of having to declare all all callback definitions for a given plugin in a single hook implementation specific to that plugin calling this hook allows the caller to define a directory where Panels will then look for .inc files with callback declarations that conform to the naming scheme. The net result is the same, but implementing this hook does allow for better organization and flexibility in your .inc files, which is particularly preferable if you're implementing a lot of them.

PLEASE NOTE: There are strict naming conventions on implementing this hook; failure to follow the conventions will likely cause your plugins not to work. Possibly even worse, failure to follow the conventions can result in namespace collisions between your module and other modules invoking the panels API.

Parameters:

string

$plugintype The type of Panels plugin being requested. Can be any of the following seven: 'content_types', 'contexts', 'arguments', 'layouts', 'styles', 'relationships', 'cache', 'switchers'

Returns:

array $directories Returns an array of include subdirectories to call for the requested plugin type. Subdirectories should be ONLY the subdirectory of your module where the appropriate types of .inc files reside.

Definition at line 1380 of file plugins.inc.

Referenced by panels_load_includes().

                                                      {
  $directories = array();
  foreach (module_implements('panels_include_directory') as $module) {
    $result = module_invoke($module, 'panels_include_directory', $plugin_type);
    if (isset($result) && is_string($result)) {
      $directories[$module] = drupal_get_path('module', $module) .'/'. $result;
    }
  }
  return $directories;
}

Here is the caller graph for this function:

panels_get_pane_content	(	$	display,
		$	pane,
		$	args = array(),
		$	context = NULL,
		$	incoming_content = ''
	)

Get the content from a given pane.

Parameters:

	$pane	The pane to retrieve content from.
	$args	The arguments sent to the display.
	$context	The panels context.
	$incoming_content	Any incoming content if this display is a wrapper.

Definition at line 523 of file plugins.inc.

References panels_ct_get_content(), panels_get_cached_content(), and panels_set_cached_content().

Referenced by panels_render_pane_content().

                                                                                                            {
  if (!$context) {
    $context = new panels_context;
  }
  // FIXME misplaced bang?
  if (!$incoming_content === '') {
    $incoming_content = t('Incoming content will be displayed here.');
  }

  $content = FALSE;
  $caching = !empty($pane->cache['method']) ? TRUE : FALSE;
  if ($caching && ($cache = panels_get_cached_content($display, $args, $context, $pane))) {
    $content = $cache->content;
  }
  else {
    $content = panels_ct_get_content($pane->type, $pane->configuration, $args, $context, $incoming_content);
    foreach (module_implements('panels_pane_content_alter') as $module) {
      // TODO This makes the third hook invocation on the render path. How badly is this hindering performance?
      $function = $module . '_panels_pane_content_alter';
      $function($content, $pane, $args, $context);
    }
    if ($caching) {
      $cache = new panels_cache_object();
      $cache->set_content($content);
      panels_set_cached_content($cache, $display, $args, $context, $pane);
    }
  }

  return $content;
}

Here is the call graph for this function:

Here is the caller graph for this function:

panels_load_displays

(

$

dids

)

Load and fill the requested $display object(s).

Helper function primarily for for panels_load_display().

Parameters:

array

$dids An indexed array of dids to be loaded from the database.

Returns:

$displays An array of displays, keyed by their display dids.

Definition at line 657 of file panels.module.

Referenced by panels_load_display(), panels_mini_list_page(), and panels_page_list_page().

                                     {
  $displays = array();
  if (empty($dids) || !is_array($dids)) {
    return $displays;
  }

  $subs = implode(', ', array_fill(0, count($dids), '%d'));

  $result = db_query("SELECT * FROM {panels_display} WHERE did IN ($subs)", $dids);

  while ($obj = db_fetch_array($result)) {
    $display = new panels_display();

    foreach ($obj as $key => $value) {
      $display->$key = $value;
      // unserialize important bits
      if (in_array($key, array('layout_settings', 'panel_settings', 'cache'))) {
        $display->$key = empty($display->$key) ? array() : unserialize($display->$key);
      }
    }

    $display->panels = $display->content = array();

    $displays[$display->did] = $display;
  }

  foreach (module_implements('panels_layout_content_alter') as $module) {
    $function = $module . '_panels_layout_content_alter';
    $function($content, $layout, $settings);
  }

  $result = db_query("SELECT * FROM {panels_pane} WHERE did IN ($subs) ORDER BY did, panel, position", $dids);

  while ($pane = db_fetch_object($result)) {
    $pane->configuration = unserialize($pane->configuration);
    $pane->cache = empty($pane->cache) ? array() : unserialize($pane->cache);
    $pane->access = ($pane->access ? explode(', ', $pane->access) : array());
    // Old panels may not have shown property, so enable by default when loading.
    $pane->shown = isset($pane->shown) ? $pane->shown : TRUE;

    $displays[$pane->did]->panels[$pane->panel][] = $pane->pid;
    $displays[$pane->did]->content[$pane->pid] = $pane;
  }
  return $displays;
}

Here is the caller graph for this function:

panels_load_hooks

(

$

hook

)

Load plugin info for the provided hook; this is handled separately from plugins from files.

IMPORTANT: The hooks invoked by this function do work, but it is _not_ the preferred method, as it is left up to the module invoking the hook to handle including separate .inc files with potentially unneeded functions - and there is no way for any entity external to the Panels engine to know if that inclusion is necessary. Consequently, hook_panels_include_directory() should be used unless some aspect of the client's implementation is incompatible with that approach.

See also:

panels_get_include_directories()

Parameters:

$hook

The hook being invoked.

Returns:

An array of info supplied by any hook implementations.

Definition at line 1452 of file plugins.inc.

References _panels_process_plugin().

Referenced by panels_get_plugins().

                                  {
  $info = array();
  foreach (module_implements($hook) as $module) {
    $result = _panels_process_plugin($module, $module, drupal_get_path('module', $module), $hook);
    if (is_array($result)) {
      $info = array_merge($info, $result);
    }
  }
  return $info;
}

Here is the call graph for this function:

Here is the caller graph for this function:

panels_mini_default_panels

(

)

Get all 'default' mini panels.

Definition at line 1182 of file panels_mini.module.

Referenced by panels_mini_disable_page(), panels_mini_enable_page(), panels_mini_load(), and panels_mini_load_all().

                                      {
  $panels = module_invoke_all('default_panel_minis');
  if (!is_array($panels)) {
    $panels = array();
  }

  return $panels;
}

Here is the caller graph for this function:

panels_page_default_panels

(

)

Get all 'default' panels.

Definition at line 1101 of file panels_page.module.

Referenced by panels_page_disable_page(), panels_page_enable_page(), panels_page_load(), panels_page_load_all(), and panels_page_view_page().

                                      {
  $panels = module_invoke_all('default_panel_pages');
  if (!is_array($panels)) {
    $panels = array();
  }

  return $panels;
}

Here is the caller graph for this function:

panels_render_display

(

&$

display

)

Render a display by loading the content into an appropriate array and then passing through to panels_render_layout.

if $incoming_content is NULL, default content will be applied. Use an empty string to indicate no content.

Definition at line 912 of file panels.module.

References panels_get_layout(), panels_load_include(), panels_render_layout(), and panels_sanitize_display().

Referenced by panels_mini_block(), panels_mini_content(), panels_mini_preview_panel(), panels_node_view(), panels_page_view_page(), and theme_panels_page_render_form().

                                          {
  panels_load_include('plugins');
  $layout = panels_get_layout($display->layout);
  if (!$layout) {
    return NULL;
  }

  // TODO: This may not be necessary now. Check this.
  panels_sanitize_display($display);

  $output = '';

  // Let modules act just prior to render.
  foreach (module_implements('panels_pre_render') as $module) {
    $function = $module . '_panels_pre_render';
    $output .= $function($display);
  }

  $output .= panels_render_layout($layout, $display, $display->css_id, $display->layout_settings);

  // Let modules act just after render.
  foreach (module_implements('panels_post_render') as $module) {
    $function = $module . '_panels_post_render';
    $output .= $function($display);
  }
  return $output;
}

Here is the call graph for this function:

Here is the caller graph for this function:

panels_views_default_panels

(

)

Get all 'default' view panes.

Definition at line 1442 of file panels_views.module.

Referenced by panels_views_disable_page(), panels_views_enable_page(), panels_views_load(), and panels_views_load_all().

                                       {
  $panels = module_invoke_all('default_panel_views');
  if (!is_array($panels)) {
    $panels = array();
  }

  return $panels;
}

Here is the caller graph for this function: