naked.inc in Brainstorm profile 7

Implimentation of an Adaptivetheme Page Layout plugin

This is an example of a Page Layout plugin for Adaptivetheme. If enabled this will be picked up by the Plugin system and added as a page layout option for the specified 'device_groups'.

You can enable the "naked" example layout plugin by uncommenting the info file entry in your subthemes info file. Look for: Custom Page Layout Plugins: plugins[page_layout][layouts] = custom_layouts

Where "custom_layouts" is the directory holding this file. Remember to clear the cache after you make changes to your info file.

The three_col_grail.inc AT Core layout holds extensive documentation on Page Layout plugins, its well worth reviewing that file.

NOTE: when making changes to layout plugins you must clear cache all - plugin data is cached in the database!

@SEE adaptivetheme/at_core/layouts/core/three_col_grail/three_col_grail.inc @SEE at_subtheme.info (Custom Page Layout Plugins).

File

themes/brainstorm_theme/layouts/page/naked/naked.inc

<?php

/**
 * @file
 * Implimentation of an Adaptivetheme Page Layout plugin
 *
 * This is an example of a Page Layout plugin for Adaptivetheme. If enabled this
 * will be picked up by the Plugin system and added as a page layout option for
 * the specified 'device_groups'.
 *
 * You can enable the "naked" example layout plugin by uncommenting the
 * info file entry in your subthemes info file. Look for:
 * Custom Page Layout Plugins:
 * plugins[page_layout][layouts] = custom_layouts
 *
 * Where "custom_layouts" is the directory holding this file. Remember to clear
 * the cache after you make changes to your info file.
 *
 * The three_col_grail.inc AT Core layout holds extensive documentation on Page
 * Layout plugins, its well worth reviewing that file.
 *
 * NOTE: when making changes to layout plugins you must clear cache all - plugin
 * data is cached in the database!
 *
 * @SEE adaptivetheme/at_core/layouts/core/three_col_grail/three_col_grail.inc
 * @SEE at_subtheme.info (Custom Page Layout Plugins).
 */
function naked() {
  $page_layout['naked'] = [
    'title' => t('Naked'),
    'category' => t('AT Subtheme Custom Page Layout'),
    'method' => 'naked',
    'type' => 'page_layout',
    'admin css' => 'naked.admin.css',
    'device_groups' => [
      'bigscreen',
      'tablet_landscape',
      'tablet_portrait',
      'smalltouch_landscape',
    ],
  ];
  return $page_layout;
}

/**
 * CSS Builder for the naked layout.
 *
 * Page layout functions are called during theme settings submit to process and
 * return CSS to be written to file. Sidebar width and unit values are set in
 * theme settings and passed to this function as parameters.
 *
 * In essense you just write CSS here using the parameters as placeholders for
 * inserting the values. You might do some logic with those values first
 * depending on the complexity and nature of your layout. Its worth taking some
 * time to review AT Cores Page layouts for examples.
 *
 * @param $sidebar_first , an arbitary numeric value.
 * @param $sidebar_second , an arbitary numeric value.
 * @param $sidebar_unit , a value unit, one of px, em or %.
 *
 * @return string
 */
function naked_layout($sidebar_first, $sidebar_second, $sidebar_unit) {
  $styles = <<<EOF
/* Nothing to output, this style is naked! */
EOF;
  return $styles;
}

Functions

Name	Description
naked	@file Implimentation of an Adaptivetheme Page Layout plugin
naked_layout	CSS Builder for the naked layout.