You are here

Home » API reference » Bootstrap - Photo Gallery 7.3 » views_bootstrap_gallery_plugin_style_bootstrap_gallery.inc

class views_bootstrap_gallery_plugin_style_bootstrap_gallery in Bootstrap - Photo Gallery 7.3

Style plugin to render each item in an ordered or unordered list.

Hierarchy

Expanded class hierarchy of views_bootstrap_gallery_plugin_style_bootstrap_gallery

1 string reference to 'views_bootstrap_gallery_plugin_style_bootstrap_gallery'
bootstrap_gallery_views_plugins in ./bootstrap_gallery.views.inc
Implements hook_views_plugins().

File

./views_bootstrap_gallery_plugin_style_bootstrap_gallery.inc, line 13
Contains the Bootstrap Gallery style plugin.

View source 
class views_bootstrap_gallery_plugin_style_bootstrap_gallery extends views_plugin_style_grid {

  /**
   * Set default options
   */
  function option_definition() {
    $options = parent::option_definition();
    $options['image_field'] = array(
      'default' => '',
    );
    $options['image_title'] = array(
      'default' => 'default',
    );
    $options['controls'] = array(
      'default' => false,
    );
    $options['borderless'] = array(
      'default' => false,
    );
    return $options;
  }

  /**
   * Render the given style.
   */
  function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);

    // Flatten options to deal with the various hierarchy changes.
    $options = bootstrap_gallery_get_options($this->options);
    $form['bootstrap_gallery'] = array(
      '#type' => 'fieldset',
      '#title' => t('Bootstrap Gallery'),
      '#description' => t('Display options for bootstrap gallery.'),
      '#collapsible' => TRUE,
      '#weight' => -10,
    );
    $form['bootstrap_gallery']['image_field'] = array(
      '#type' => 'select',
      '#title' => t('Image Field'),
      '#default_value' => $options['image_field'],
      '#options' => $this->display->handler
        ->get_field_labels(),
      '#description' => t('Field that contains image or thumbnail to be used with Bootstrap Gallery.'),
      '#required' => TRUE,
    );
    $form['bootstrap_gallery']['image_style'] = array(
      '#type' => 'select',
      '#title' => t('Image Style'),
      '#default_value' => $options['image_style'],
      '#options' => bootstrap_gallery_image_styles(),
      '#description' => t('Image Style preset to be used for rendering the full image.'),
      '#required' => TRUE,
    );
    $form['bootstrap_gallery']['image_title'] = array(
      '#type' => 'select',
      '#title' => t('Image Title'),
      '#default_value' => $options['image_title'],
      '#options' => array(
        'default' => 'HTML title attribute',
      ) + $this->display->handler
        ->get_field_labels(),
      '#description' => t('Source of headline text to be displayed as a title for the image'),
      '#required' => TRUE,
    );
    $form['bootstrap_gallery']['controls'] = array(
      '#type' => 'checkbox',
      '#title' => t('Display controls'),
      '#default_value' => $options['controls'],
      '#options' => array(
        TRUE,
        FALSE,
      ),
      '#description' => t('Display Bootstrap Carousel Controls.'),
    );
    $form['bootstrap_gallery']['borderless'] = array(
      '#type' => 'checkbox',
      '#title' => t('Borderless overlay'),
      '#default_value' => $options['borderless'],
      '#options' => array(
        TRUE,
        FALSE,
      ),
      '#description' => t('Disable Bootstrap Modal. Display a full page gallery.'),
    );
  }

  /**
   * Validate option form.
   */
  function options_validate(&$form, &$form_state) {

    // Don't run validation on style plugins without the grouping setting.
    if (isset($form_state['values']['style_options']['bootstrap_gallery']) && ($options = $form_state['values']['style_options']['bootstrap_gallery'])) {
      $image_field = $options['image_field'];
      $field_info = field_info_field($image_field);
      $allowed_field_types = array(
        'image',
        'file',
      );
      if (!in_array($field_info['type'], $allowed_field_types)) {
        form_set_error('style_options[bootstrap_gallery][image_field]', t('Selected image field must be of type: Image'));
      }
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
views_bootstrap_gallery_plugin_style_bootstrap_gallery::options_form function Render the given style. Overrides views_plugin_style_grid::options_form
views_bootstrap_gallery_plugin_style_bootstrap_gallery::options_validate function Validate option form. Overrides views_plugin_style::options_validate
views_bootstrap_gallery_plugin_style_bootstrap_gallery::option_definition function Set default options Overrides views_plugin_style_grid::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::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