class views_foundation_plugin_style_orbit in Views Foundation 7

Style plugin to render rows in a Foundation Orbit slider.

Hierarchy

• class \views_object
  • class \views_plugin
    • class \views_plugin_style
      • class \views_foundation_plugin_style_orbit

1 string reference to 'views_foundation_plugin_style_orbit'

views_foundation_views_plugins in ./views_foundation.views.inc

Implements hook_views_plugins().

File

view/views_foundation_plugin_style_orbit.inc, line 14

Views Foundation Orbit plugin.

class views_foundation_plugin_style_orbit extends views_plugin_style {

  /**
   * Set default options.
   */
  function option_definition() {
    $options = parent::option_definition();
    $options['animation'] = array(
      'default' => 'horizontal-slide',
    );
    $options['animation_speed'] = array(
      'default' => 800,
    );
    $options['advance_speed'] = array(
      'default' => 4000,
    );
    $options['directional_nav'] = array(
      'default' => TRUE,
    );
    $options['timer'] = array(
      'default' => TRUE,
    );
    $options['fluid'] = array(
      'default' => 'true',
    );
    $options['bullets'] = array(
      'default' => FALSE,
    );
    return $options;
  }

  /**
   * Provide a form for setting options.
   */
  function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);

    // Pre-build option list for the caption field.
    $fields = array(
      '' => t('- None -'),
    );
    foreach ($this->display->handler
      ->get_handlers('field') as $field => $handler) {
      $fields[$field] = $handler
        ->ui_name();
    }
    $form['animation'] = array(
      '#type' => 'select',
      '#title' => t('Animation type'),
      '#description' => t('Specify the Animation Style'),
      '#required' => TRUE,
      '#options' => array(
        'horizontal-slide' => t('horizontal-slide'),
        'vertical-slide' => t('vertical-slide'),
        'horizontal-push' => t('horizontal-push'),
        'fade' => t('fade'),
      ),
      '#default_value' => $this->options['animation'],
    );
    $form['animation_speed'] = array(
      '#type' => 'textfield',
      '#title' => t('Animation speed'),
      '#required' => TRUE,
      '#size' => 10,
      '#maxlength' => 10,
      '#description' => t('Specify the Animation Speed'),
      '#default_value' => $this->options['animation_speed'],
      '#element_validate' => array(
        'element_validate_integer_positive',
      ),
    );
    $form['advance_speed'] = array(
      '#type' => 'textfield',
      '#title' => t('Advanced speed'),
      '#description' => t('If timer is enables, time between transitions'),
      '#required' => TRUE,
      '#size' => 10,
      '#maxlength' => 10,
      '#default_value' => $this->options['advance_speed'],
      '#element_validate' => array(
        'element_validate_integer_positive',
      ),
    );
    $form['directional_nav'] = array(
      '#type' => 'checkbox',
      '#title' => t('Directional Nav'),
      '#description' => t('Do you want directional nav?'),
      '#default_value' => $this->options['directional_nav'],
    );
    $form['timer'] = array(
      '#type' => 'checkbox',
      '#title' => t('Timer'),
      '#description' => t('Do you want a timer or not?'),
      '#default_value' => $this->options['timer'],
    );
    $form['caption_field'] = array(
      '#type' => 'select',
      '#title' => t('Caption field'),
      '#options' => $fields,
      '#default_value' => $this->options['caption_field'],
      '#description' => t('Select the field that will be used as the image caption.'),
    );
    $form['fluid'] = array(
      '#type' => 'textfield',
      '#title' => t('Fluid'),
      '#required' => TRUE,
      '#size' => 10,
      '#maxlength' => 10,
      '#description' => t("Control responsiveness of Orbit slides. Type true, or Aspect Ratio (eg. 16x6)"),
      '#default_value' => $this->options['fluid'],
    );
    $form['bullets'] = array(
      '#type' => 'checkbox',
      '#title' => t('Bullets'),
      '#description' => t('Do you want bullet navigation?'),
      '#default_value' => $this->options['bullets'],
    );
  }

  /**
   * Validating the inputs.
   */
  function options_validate($form, &$form_state) {
    parent::options_validate($form, $form_state);
    $options =& $form_state['values']['style_options'];
    if ($options['fluid'] != 'true') {
      if (!preg_match('/^[0-9]*[x][0-9]$/', $options['fluid'])) {
        form_error($form['fluid'], t('Please specify a correct aspect ratio.'));
      }
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
views_foundation_plugin_style_orbit::options_form		function	Provide a form for setting options. Overrides views_plugin_style::options_form
views_foundation_plugin_style_orbit::options_validate		function	Validating the inputs. Overrides views_plugin_style::options_validate
views_foundation_plugin_style_orbit::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::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