class UIkitViewsPluginStyleGrid in UIkit Components 7.3

Style plugin to render each item in a UIkit grid component.

Hierarchy

• class \views_object
  • class \views_plugin
    • class \views_plugin_style
      • class \UIkitViewsPluginStyleGrid

1 string reference to 'UIkitViewsPluginStyleGrid'

uikit_views_views_plugins in uikit_views/uikit_views.views.inc

Implements hook_views_plugins().

File

uikit_views/plugins/UIkitViewsPluginStyleGrid.inc, line 13

Contains the UIkit Views grid style plugin.

class UIkitViewsPluginStyleGrid extends views_plugin_style {

  /**
   * Set default options
   */
  function option_definition() {
    $options = parent::option_definition();
    $options['row_class'] = array(
      'default' => '',
    );
    $options['width_@s'] = array(
      'default' => 'uk-child-width-1-1@s',
    );
    $options['width_@m'] = array(
      'default' => 'uk-child-width-1-2@m',
    );
    $options['width_@l'] = array(
      'default' => 'uk-child-width-1-3@l',
    );
    $options['width_@xl'] = array(
      'default' => 'uk-child-width-1-4@xl',
    );
    $options['grid_divider'] = array(
      'default' => FALSE,
    );
    $options['grid_gutter'] = array(
      'default' => 'default',
    );
    return $options;
  }

  /**
   * Render the given style.
   */
  function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);
    $args = array(
      '@href' => 'https://getuikit.com/docs/grid#child-width',
      '@title' => 'Grid component - UIkit documentation',
    );
    $breakpoints = array(
      '@s' => t('Affects device widths of 640px and higher.'),
      '@m' => t('Affects device widths of 960px and higher.'),
      '@l' => t('Affects device widths of 1200px and higher.'),
      '@xl' => t('Affects device widths of 1600px and higher.'),
    );
    $form['column_widths'] = array(
      '#type' => 'item',
      '#title' => t('Grid columns'),
      '#description' => t("To create a grid whose child elements' widths are evenly split, we apply one class to the grid for each breakpoint. Each item in the grid is then automatically applied a width based on the number of columns selected for each breakpoint. See <a href='@href' target='_blank' title='@title'>Grid component</a> for more details.", $args),
    );
    foreach ([
      '@s',
      '@m',
      '@l',
      '@xl',
    ] as $size) {
      $form["width_{$size}"] = array(
        '#type' => 'select',
        '#title' => t("uk-child-width-*{$size}"),
        '#required' => TRUE,
        '#default_value' => $this->options["width_{$size}"],
        '#options' => array(
          "uk-child-width-1-1{$size}" => 1,
          "uk-child-width-1-2{$size}" => 2,
          "uk-child-width-1-3{$size}" => 3,
          "uk-child-width-1-4{$size}" => 4,
          "uk-child-width-1-5{$size}" => 5,
          "uk-child-width-1-6{$size}" => 6,
          "uk-child-width-1-10{$size}" => 10,
        ),
        '#description' => $breakpoints[$size],
      );
    }
    $form['grid_divider'] = array(
      '#type' => 'checkbox',
      '#title' => t('Grid divider'),
      '#default_value' => $this->options['grid_divider'],
      '#description' => t('Separate grid cells with lines.'),
    );
    $form['grid_gutter'] = array(
      '#type' => 'select',
      '#title' => t('Grid gutter'),
      '#required' => TRUE,
      '#default_value' => $this->options['grid_gutter'],
      '#options' => array(
        'default' => t('Default gutter'),
        'uk-grid-small' => t('Small gutter'),
        'uk-grid-medium' => t('Medium gutter'),
        'uk-grid-large' => t('Large gutter'),
        'uk-grid-collapse' => t('Collapse gutter'),
      ),
      '#description' => t('By default, the grid gutter is wider on large screens.<br /><strong>Note</strong>: <em class="placeholder">Grid collapse</em> removes the grid gutter.'),
    );
  }

}

Members

Name	Modifiers	Type	Description	Overrides
UIkitViewsPluginStyleGrid::options_form		function	Render the given style. Overrides views_plugin_style::options_form
UIkitViewsPluginStyleGrid::option_definition		function	Set default options Overrides views_plugin_style::option_definition
views_object::$definition	public	property	Handler's definition.
views_object::$options	public	property	Except for displays, options for the object will be held here.	1
views_object::altered_option_definition		function	Collect this handler's option definition and alter them, ready for use.
views_object::construct	public	function	Views handlers use a special construct function.	4
views_object::export_option	public	function		1
views_object::export_options	public	function
views_object::export_option_always	public	function	Always exports the option, regardless of the default value.
views_object::options Deprecated	public	function	Set default options on this object.	1
views_object::set_default_options	public	function	Set default options.
views_object::set_definition	public	function	Let the handler know what its full definition is.
views_object::unpack_options	public	function	Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
views_object::unpack_translatable	public	function	Unpack a single option definition.
views_object::unpack_translatables	public	function	Unpacks each handler to store translatable texts.
views_object::_set_option_defaults	public	function
views_plugin::$display	public	property	The current used views display.
views_plugin::$plugin_name	public	property	The plugin name of this plugin, for example table or full.
views_plugin::$plugin_type	public	property	The plugin type of this plugin, for example style or query.
views_plugin::$view	public	property	The top object of a view. Overrides views_object::$view	1
views_plugin::additional_theme_functions	public	function	Provide a list of additional theme functions for the theme info page.
views_plugin::options_submit	public	function	Handle any special handling on the validate form.	9
views_plugin::plugin_title	public	function	Return the human readable name of the display.
views_plugin::summary_title	public	function	Returns the summary of the settings in the display.	8
views_plugin::theme_functions	public	function	Provide a full list of possible theme templates used by this style.
views_plugin_style::$row_plugin	public	property	The row plugin, if it's initialized and the style itself supports it.
views_plugin_style::$row_tokens	public	property	Store all available tokens row rows.
views_plugin_style::build_sort	public	function	Called by the view builder to see if this style handler wants to interfere with the sorts. If so it should build; if it returns any non-TRUE value, normal sorting will NOT be added to the query.	1
views_plugin_style::build_sort_post	public	function	Called by the view builder to let the style build a second set of sorts that will come after any other sorts in the view.	1
views_plugin_style::destroy	public	function	Destructor. Overrides views_object::destroy
views_plugin_style::even_empty	public	function	Should the output of the style plugin be rendered even if it's empty.	1
views_plugin_style::get_field	public	function	Get a rendered field.
views_plugin_style::get_field_value	public	function	Get the raw field value.
views_plugin_style::get_row_class	public	function	Return the token replaced row class for the specified row.
views_plugin_style::init	public	function	Initialize a style plugin.
views_plugin_style::options_validate	public	function	Validate the options form. Overrides views_plugin::options_validate
views_plugin_style::pre_render	public	function	Allow the style to do stuff before each row is rendered.
views_plugin_style::query	public	function	Add anything to the query that we might need to. Overrides views_plugin::query	2
views_plugin_style::render	public	function	Render the display in this style.	5
views_plugin_style::render_fields	public	function	Render all of the fields for a given style and store them on the object.
views_plugin_style::render_grouping	public	function	Group records as needed for rendering.
views_plugin_style::render_grouping_sets	public	function	Render the grouping sets.
views_plugin_style::tokenize_value	public	function	Take a value and apply token replacement logic to it.
views_plugin_style::uses_fields	public	function	Return TRUE if this style also uses fields.
views_plugin_style::uses_row_class	public	function	Return TRUE if this style also uses a row plugin.
views_plugin_style::uses_row_plugin	public	function	Return TRUE if this style also uses a row plugin.
views_plugin_style::uses_tokens	public	function	Return TRUE if this style uses tokens.
views_plugin_style::validate	public	function	Validate that the plugin is correct and can be saved. Overrides views_plugin::validate