class flexslider_views_plugin_style_flexslider in Flex Slider 7

Implements a style type plugin for the Views module.

Hierarchy

• class \views_object
  • class \views_plugin
    • class \views_plugin_style
      • class \flexslider_views_plugin_style_flexslider

1 string reference to 'flexslider_views_plugin_style_flexslider'

flexslider_views_views_plugins in flexslider_views/flexslider_views.views.inc

File

flexslider_views/flexslider_views_plugin_style_flexslider.inc, line 10

flexslider style plugin for the Views module.

class flexslider_views_plugin_style_flexslider extends views_plugin_style {

  /**
   * Set default options.
   */
  function option_definition() {
    $options = parent::option_definition();
    $options += array(
      'flexslider_optionset' => array(
        'default' => 'default',
      ),
      'caption_field' => array(
        '' => t('None'),
      ),
      'text_field' => array(
        '' => t('None'),
      ),
    );
    return $options;
  }

  /**
   * Show a form to edit the style options.
   */
  function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);
    $form['flexslider'] = array(
      '#type' => 'fieldset',
      '#title' => t('Flex Slider'),
    );
    $optionsets = array();
    foreach (flexslider_optionset_load_all() as $name => $optionset) {
      $optionsets[$name] = check_plain($optionset->title);
    }
    $form['flexslider']['flexslider_optionset'] = array(
      '#title' => t('Option set'),
      '#type' => 'select',
      '#options' => $optionsets,
      '#default_value' => $this->options['flexslider_optionset'],
    );
    $link_options = array(
      '' => t('None'),
    );
    foreach ($this->view->display_handler
      ->get_handlers('field') as $field => $handler) {
      $link_options[$field] = $handler
        ->ui_name();
    }
    $form['flexslider']['caption_field'] = array(
      '#type' => 'select',
      '#title' => t('Caption Field'),
      '#multiple' => FALSE,
      '#description' => t('Select a field to be used as a caption. This is typically the name of the image and can be used to link to the source content.'),
      '#options' => $link_options,
      '#default_value' => $this->options['caption_field'],
    );
    $form['flexslider']['text_field'] = array(
      '#type' => 'select',
      '#title' => t('Description Field'),
      '#multiple' => FALSE,
      '#description' => t('Select a field to be used as a description of the image or extra information for the viewer.'),
      '#options' => $link_options,
      '#default_value' => $this->options['text_field'],
    );
  }

  /**
   * Performs some cleanup tasks on the options array before saving it.
   */
  function options_submit(&$form, &$form_state) {
    $options =& $form_state['values']['style_options'];

    // Pull the fieldset values one level up
    $options += $options['flexslider'];
    unset($options['flexslider']);
  }

  /**
   * Searches for the image field to use.
   */
  function find_image_field() {
    foreach ($this->view->display_handler
      ->get_handlers('field') as $id => $handler) {
      if ($handler instanceof views_handler_field_field && $handler->field_info['type'] == 'image') {
        return $id;
        break;
      }
    }
    return FALSE;
  }

  /**
   * Render the display in this style.
   */
  function render() {
    $image_field = $this
      ->find_image_field();
    if ($image_field === FALSE) {
      drupal_set_message(t('Style @style requires an image field to be added.', array(
        '@style' => $this->definition['title'],
      )), 'error');
      return;
    }

    // Group the rows according to the grouping field, if specified.
    $sets = $this
      ->render_grouping($this->view->result, $this->options['grouping']);

    // Render each group separately and concatenate.
    $output = '';
    foreach ($sets as $title => $rows) {
      $output .= theme($this
        ->theme_functions(), array(
        'view' => $this->view,
        'options' => $this->options,
        'img_field_name' => $image_field,
        'rows' => $rows,
        'title' => $title,
      ));
    }
    return $output;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
flexslider_views_plugin_style_flexslider::find_image_field		function	Searches for the image field to use.
flexslider_views_plugin_style_flexslider::options_form		function	Show a form to edit the style options. Overrides views_plugin_style::options_form
flexslider_views_plugin_style_flexslider::options_submit		function	Performs some cleanup tasks on the options array before saving it. Overrides views_plugin::options_submit
flexslider_views_plugin_style_flexslider::option_definition		function	Set default options. Overrides views_plugin_style::option_definition
flexslider_views_plugin_style_flexslider::render		function	Render the display in this style. Overrides views_plugin_style::render
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::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_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