classy_panel_styles.inc in Classy Panel Styles 7

Classy Panel Styles plugin file.

File

plugins/styles/classy_panel_styles/classy_panel_styles.inc

<?php

/**
 * @file
 * Classy Panel Styles plugin file.
 */

// Define the parent plugin.
$plugin = array(
  'title' => 'CPS ' . t('Parent Style'),
  'description' => 'CPS ' . t('parent style providing user-defined substyles'),
  'get child' => 'classy_panel_styles_get_substyle',
  'get children' => 'classy_panel_styles_get_substyles',
  'settings form' => 'classy_panel_styles_settings_form',
  'pane settings form' => 'classy_panel_styles_settings_form',
);

/**
 * Implements MODULE_preprocess_HOOK() for panels_pane.
 *
 * It would be cleaner to just preprocess the CPS pane theme hook, but that
 * doesn't work because Panels overwrites the 'classes_array' variable, grr!
 */
function classy_panel_styles_preprocess_panels_pane(&$vars) {
  if (isset($vars['pane']->style['style']) && _classy_panel_styles_is($vars['pane']->style['style'])) {
    _classy_panel_styles_preprocess($vars, $vars['classes_array'], 'pane', $vars['pane']->pid);
  }
}

/**
 * Implements template_preprocess_HOOK() for classy_panel_styles_region.
 */
function template_preprocess_classy_panel_styles_region(&$vars) {
  if (!isset($vars['attributes_array']['class'])) {
    $vars['attributes_array']['class'] = array();
  }
  _classy_panel_styles_preprocess($vars, $vars['attributes_array']['class'], 'region', $vars['region_id']);

  // Add a helpful class.
  $vars['content_attributes_array']['class'][] = 'cps-region-inner';
}

/**
 * Adds CSS to response; Adds classes to the template variable or JS settings.
 *
 * @param array $vars
 *   The template variables.
 * @param array $classes
 *   The subelement of $vars to be updated with CPS classes.
 * @param string $type
 *   Pane or region.
 * @param string $id
 *   The unique ID of the pane or region.
 */
function _classy_panel_styles_preprocess(array &$vars, array &$classes, $type, $id) {

  // Add Classy Panel Styles CSS.
  _classy_panel_styles_add_css();

  // For IPE, let javascript inject the classes.
  if (isset($vars['display']->renderer_handler) && $vars['display']->renderer_handler instanceof panels_renderer_ipe) {
    drupal_add_js(drupal_get_path('module', 'classy_panel_styles') . '/js/classy_panel_styles.js');
    _classy_panel_styles_apply($type, $id, 'classy_panel_styles:cps_default', $vars['settings'], 'panels_renderer_ipe');
    return;
  }

  // Filter out disabled styles.
  $filtered = _classy_panel_styles_filter_conf($vars['settings']);

  // Combine with existing classes, if any.
  $classes = empty($classes) ? $filtered : array_unique(array_merge($classes, $filtered));
}

/**
 * Implements template_process_HOOK() for classy_panel_styles_pane.
 */
function template_process_classy_panel_styles_pane(&$vars) {
  $vars['content'] = theme('panels_pane', $vars);
}

/**
 * Implements template_process_HOOK() for classy_panel_styles_region.
 */
function template_process_classy_panel_styles_region(&$vars) {

  // Determine in which style to render this region.
  $hook = variable_get(CLASSY_PANEL_STYLES_REGION_STYLE, 'panels_default_style_render_region');

  // Generate the standard region markup.
  $vars['content'] = theme($hook, $vars);
}

/**
 * Theme callback for classy_panel_styles_pane.
 */
function theme_classy_panel_styles_pane(&$vars) {
  return $vars['content'];
}

/**
 * Theme callback for classy_panel_styles_region.
 */
function theme_classy_panel_styles_region(&$vars) {
  if (empty($vars['content'])) {
    return;
  }
  $markup = $vars['content'];
  $wrappers = array(
    'content_attributes_array',
    'attributes_array',
  );
  foreach ($wrappers as $wrapper) {
    if (!empty($vars[$wrapper])) {
      $attributes = drupal_attributes($vars[$wrapper]);
      $markup = "<div{$attributes}>{$markup}</div>";
    }
  }
  return $markup;
}

/**
 * Returns the settings form for panes and regions.
 *
 * @return array
 *   The settings form.
 */
function classy_panel_styles_settings_form($settings, $panel_obj, $pane_id, $type, $form_state) {
  $form = array();

  // Get the pane/region mask.
  switch ($type) {
    case 'pane':
      $bitmask = CLASSY_PANEL_STYLES_PANE_MASK;
      break;
    case 'region':
    case 'display':
      $type = 'region';
      $bitmask = CLASSY_PANEL_STYLES_REGION_MASK;
      break;
    default:

      // Default to both panes and regions.
      $bitmask = CLASSY_PANEL_STYLES_PANE_MASK | CLASSY_PANEL_STYLES_REGION_MASK;
  }

  // Add admin CSS file.
  $admin_css_path = drupal_get_path('module', 'classy_panel_styles') . '/admin_styles/css/classy_panel_styles.admin.css';
  $form['#attached']['css'][] = $admin_css_path;

  // Load the Classy Panel Styles objects.
  ctools_include('export');
  $styles = ctools_export_load_object('classy_panel_styles');

  // Get the layout name.
  $layout = $panel_obj->layout;

  // Add style settings to form.
  foreach ($styles as $name => $style) {

    // Skip if this style is disabled.
    if (!empty($style->disabled)) {
      continue;
    }

    // Skip if this style does not apply to this type (pane/region).
    if (!($style->visibility & $bitmask)) {
      continue;
    }

    // Skip if this style does not apply to this layout.
    if ($layouts_setting = $style->layouts_setting) {
      $layouts = unserialize($style->layouts);
      $in_array = in_array($layout, $layouts);
      if (CLASSY_PANEL_STYLES_LAYOUTS_EXCLUDE == $layouts_setting && $in_array || CLASSY_PANEL_STYLES_LAYOUTS_INCLUDE == $layouts_setting && !$in_array) {
        continue;
      }
    }

    // Translate options.
    if (!empty($style->options)) {
      $options = unserialize($style->options);
      foreach ($options as $key => $option) {
        $options[$key] = t($option);
      }
    }

    // Add the form element.
    $form[$name] = array(
      '#type' => 'select',
      '#title' => t(check_plain($style->title)),
      '#required' => $style->required,
      '#description' => t(filter_xss($style->description)),
      '#options' => $options,
      '#default_value' => isset($settings[$name]) ? $settings[$name] : $style->default_value,
      '#empty_option' => $style->required ? t('- Select -') : t('- None -'),
    );
  }

  // Add a textbox for additional CSS classes.
  $form[CLASSY_PANEL_STYLES_CUSTOM_CLASSES] = array(
    '#type' => 'textfield',
    '#title' => t('Additional CSS classes'),
    '#description' => t('Space-separated, please. For example: float-left clearfix make-pretty'),
    '#required' => FALSE,
    '#default_value' => isset($settings[CLASSY_PANEL_STYLES_CUSTOM_CLASSES]) ? $settings[CLASSY_PANEL_STYLES_CUSTOM_CLASSES] : '',
  );

  // Add some default classes.
  $form['classy_panel_styles_flag'] = array(
    '#type' => 'value',
    '#value' => "classy-panel-styles {$type}",
  );
  return $form;
}

/**
 * Adds Classy Panel Styles CSS to output.
 */
function _classy_panel_styles_add_css() {
  $runonce =& drupal_static(__FUNCTION__);
  if (isset($runonce)) {
    return;
  }
  $runonce = TRUE;

  // Add custom CSS file.
  $css_path = variable_get(CLASSY_PANEL_STYLES_CSS_PATH, FALSE);
  $css_path = explode(',', strtr($css_path, array(
    '%b' => base_path(),
    '%t' => drupal_get_path('theme', variable_get('theme_default', NULL)),
  )));
  $css_path = implode($css_path);
  if ($css_path && file_exists($css_path)) {
    drupal_add_css($css_path);
    return;
  }
  drupal_set_message(t('Missing or invalid Classy Panel Styles CSS path.'), 'warning');
}

/**
 * Provides the list of substyles.
 *
 * @param string $substyle_name
 *   The name of the substyle to return. If not specified, returns all
 *   substyles.
 *
 * @return array
 *   Either a single substyle definition or an array of all substyles.
 *
 * @TODO Load the CPS styles' groups instead of hard-coding.
 */
function classy_panel_styles_load_substyles($substyle_name = NULL) {
  $substyles = drupal_static(__FUNCTION__);
  if (!isset($substyles)) {
    $substyles = array(
      'cps_default' => array(
        'name' => 'cps_default',
        'title' => 'Classy Panel Styles',
        'description' => t('Thin panel pane and region wrappers with custom classes.'),
        'weight' => -99,
      ),
    );
  }
  if ($substyle_name) {
    return $substyles[$substyle_name];
  }
  return $substyles;
}

/**
 * CTools style plugin callback: Provides a single substyle.
 */
function classy_panel_styles_get_substyle($plugin, $style_name, $substyle_name) {
  $substyle = classy_panel_styles_load_substyles($substyle_name);
  return classy_panel_styles_merge_plugin($plugin, $style_name, $substyle);
}

/**
 * CTools style plugin callback: Provides all substyles.
 */
function classy_panel_styles_get_substyles($plugin, $style_name) {
  $data = classy_panel_styles_load_substyles();
  $substyles = array();
  foreach ($data as $substyle_name => $substyle) {
    $substyles[$style_name . ':' . $substyle_name] = classy_panel_styles_merge_plugin($plugin, $style_name, $substyle);
  }
  return $substyles;
}

/**
 * Merges the main style plugin with a substyle to create a sub-plugin.
 *
 * @param array $plugin
 *   The plugin array to be modified.
 * @param string $style_name
 *   The name of the parent style plugin.
 * @param array $substyle
 *   The substyle definition from classy_panel_styles_load_substyles().
 *
 * @return array
 *   The result of merging the parent plugin with the sub-style definition.
 */
function classy_panel_styles_merge_plugin(array $plugin, $style_name, array $substyle) {
  return array(
    'name' => $style_name . ':' . $substyle['name'],
    'title' => check_plain($substyle['title']),
    'substyle' => $substyle,
    'description' => check_plain($substyle['description']),
    'weight' => $substyle['weight'],
    'render pane' => 'classy_panel_styles_pane',
    'render region' => 'classy_panel_styles_region',
  ) + $plugin;
}

Functions

Name	Description
classy_panel_styles_get_substyle	CTools style plugin callback: Provides a single substyle.
classy_panel_styles_get_substyles	CTools style plugin callback: Provides all substyles.
classy_panel_styles_load_substyles	Provides the list of substyles.
classy_panel_styles_merge_plugin	Merges the main style plugin with a substyle to create a sub-plugin.
classy_panel_styles_preprocess_panels_pane	Implements MODULE_preprocess_HOOK() for panels_pane.
classy_panel_styles_settings_form	Returns the settings form for panes and regions.
template_preprocess_classy_panel_styles_region	Implements template_preprocess_HOOK() for classy_panel_styles_region.
template_process_classy_panel_styles_pane	Implements template_process_HOOK() for classy_panel_styles_pane.
template_process_classy_panel_styles_region	Implements template_process_HOOK() for classy_panel_styles_region.
theme_classy_panel_styles_pane	Theme callback for classy_panel_styles_pane.
theme_classy_panel_styles_region	Theme callback for classy_panel_styles_region.
_classy_panel_styles_add_css	Adds Classy Panel Styles CSS to output.
_classy_panel_styles_preprocess	Adds CSS to response; Adds classes to the template variable or JS settings.