You are here

list.inc in Panels 7.3

Same filename and directory in other branches
  1. 6.3 plugins/styles/list.inc

Definition of the 'list' panel style.

File

plugins/styles/list.inc
View source
<?php

/**
 * @file
 * Definition of the 'list' panel style.
 */

// Plugin definition.
$plugin = array(
  'title' => t('List'),
  'description' => t('Presents the panes in the form of an HTML list.'),
  'render region' => 'panels_list_style_render_region',
  'settings form' => 'panels_list_style_settings_form',
  'settings validate' => 'panels_list_style_settings_validate',
);

/**
 * Render callback.
 *
 * @ingroup themeable
 */
function theme_panels_list_style_render_region($vars) {
  $display = $vars['display'];
  $region_id = $vars['region_id'];
  $panes = $vars['panes'];
  $settings = $vars['settings'];
  $items = array();
  foreach ($panes as $pane_id => $item) {
    $items[] = $item;
  }
  if (empty($settings['list_type'])) {
    $settings['list_type'] = 'ul';
  }
  return theme('item_list', array(
    'items' => $items,
    'type' => $settings['list_type'],
  ));
}

/**
 * Settings form callback.
 */
function panels_list_style_settings_form($style_settings) {
  $form['list_type'] = array(
    '#type' => 'select',
    '#title' => t('List type'),
    '#options' => array(
      'ul' => t('Unordered'),
      'ol' => t('Ordered'),
    ),
    '#default_value' => isset($style_settings['list_type']) ? $style_settings['list_type'] : 'ul',
  );
  return $form;
}

Functions

Namesort descending Description
panels_list_style_settings_form Settings form callback.
theme_panels_list_style_render_region Render callback.