emptyregionrender.inc in Display Suite 6.3

File

plugins/ds_extension/emptyregionrender.inc

<?php

/**
 * @file
 * dsEmptyRegionRender: Plugin to render an empty region.
 */
$plugin = array(
  'name' => t('Empty region renderer'),
  'class' => 'dsEmptyRegionRender',
  'description' => t('Renders a region when there is no content in it.'),
  'target' => 'all',
);
class dsEmptyRegionRender {

  /**
   * Constructor().
   */
  function __construct() {
  }

  /**
   * plugin_form().
   */
  public function plugin_form(&$form, $display_settings) {
    $form['emptyregionrender'] = array(
      '#type' => 'fieldset',
      '#collapsible' => FALSE,
      '#collapsed' => FALSE,
      '#description' => t('Toggle regions you want to render when there are no fields in it or when field values are empty.'),
    );
    $build_mode = $form['#build_mode'];
    $regions = ds_regions();
    foreach ($regions as $region => $title) {
      if ($region != 'disabled') {
        $form['emptyregionrender']['region-render-' . $region] = array(
          '#title' => $title,
          '#type' => 'checkbox',
          '#default_value' => ds_default_value($display_settings, 'emptyregionrender', 'render', $region, ''),
        );
      }
    }
  }

  /**
   * plugin_form_submit().
   */
  public function plugin_form_submit($form, $form_state, &$display_settings) {
    $regions = ds_regions();
    $regions_save = array();
    $build_mode = $form['#build_mode'];
    foreach ($regions as $region => $title) {
      if (isset($form_state['values']['emptyregionrender']['region-render-' . $region])) {
        $regions_save['render'][$region] = $form_state['values']['emptyregionrender']['region-render-' . $region];
      }
    }
    $display_settings[$build_mode]['emptyregionrender'] = $regions_save;
  }

  /**
   * execute().
   */
  public function execute($vars, &$display, $display_settings, $object_type, $module) {
    $themed_regions = array();
    foreach ($display->all_regions as $region_name => $region_title) {
      $render = ds_default_value($display_settings, 'emptyregionrender', 'render', $region_name, FALSE);
      if ($render == TRUE && !isset($display->themed_regions[$region_name])) {

        // Add content for this region, simply a whitespace.
        $themed_regions[$region_name] = array(
          'content' => '&nbsp;',
          'count' => 1,
        );
        if ($region_name == 'left' || $region_name == 'right') {
          $display->region_classes[$region_name] = $region_name;
        }
      }
      elseif (isset($display->themed_regions[$region_name])) {
        $themed_regions[$region_name] = $display->themed_regions[$region_name];
      }
    }
    $display->themed_regions = $themed_regions;
  }

}

Classes

Name	Description
dsEmptyRegionRender