class videojs_style_plugin in Video.js (HTML5 Video Player) 7

Style plugin to display a Video.js.

Hierarchy

• class \views_object
  • class \views_plugin
    • class \views_plugin_style
      • class \videojs_style_plugin

1 string reference to 'videojs_style_plugin'

videojs_views_plugins in includes/videojs.views.inc

Implements hook_views_plugins().

File

includes/videojs_style_plugin.inc, line 10

Display style plugin for Views that renders rows as a Video.js.

class videojs_style_plugin extends views_plugin_style {

  // Allow some options for the style.
  function option_definition() {
    $options = parent::option_definition();
    $options['path_field'] = array(
      'default' => NULL,
    );
    $options['label_field'] = array(
      'default' => NULL,
    );
    return $options;
  }

  // Create the options form.
  function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);

    // Build a list of all fields.
    $options = array();
    foreach ($this->display->handler
      ->get_handlers('field') as $field => $handler) {
      if ($label = $handler
        ->label()) {
        $options[$field] = $label;
      }
      else {
        $options[$field] = $handler
          ->ui_name();
      }
    }
    if (empty($options)) {
      $options[''] = t('No available fields');
    }
    $form['path_field'] = array(
      '#type' => 'select',
      '#title' => t('File path fields'),
      '#options' => $options,
      '#multiple' => TRUE,
      '#size' => 4,
      '#default_value' => $this->options['path_field'],
      '#description' => t('Select the fields that will contain a file path to an video file. If multiple fields are selected, the first one that contains a value will be used. This field will not be visible in the view unless there are no other fields visible'),
      '#weight' => -5,
    );
  }

  // Ensure we have all the settings necessary to render into tabs.
  function validate() {
    $errors = parent::validate();

    // Ensure that we're using the field row style.
    if (!$this->row_plugin
      ->uses_fields()) {
      $errors[] = t('Display "@display" uses the "@style" row style, but the Video.js display style requires use of the "Fields" row style.', array(
        '@display' => $this->display->display_title,
        '@style' => $this->row_plugin->definition['title'],
      ));
    }

    // Ensure that a file path field is selected.
    if (empty($this->options['path_field'])) {
      $errors[] = t('The Video.js display style requires being configured so that at least one field is selected to provide a file path.');
    }
    return $errors;
  }

  // Override the render functionality.
  function render() {
    if (empty($this->row_plugin)) {
      vpr('views_plugin_style_default: Missing row plugin');
      return;
    }
    $view = $this->view;

    // Group the rows according to the grouping field, if specified.
    $sets = $this
      ->render_grouping($this->view->result, $this->options['grouping']);
    $fields = $this->display->handler
      ->get_handlers('field');
    $items = array();
    foreach ($sets as $title => $records) {
      foreach ($records as $row_index => $row) {
        $filepath = NULL;
        $fileid = NULL;
        foreach ($this->options['path_field'] as $field_name) {
          if (isset($row->{$fields[$field_name]->field_alias})) {
            $fileid = $row->{$fields[$field_name]->field_alias};
            break;
          }
        }
        $file = db_fetch_object(db_query("SELECT filepath FROM {files} WHERE fid = %d", $fileid));
        $filepath = $file->filepath;
        $this->view->row_index = $row_index;

        // get the file path from the file object
        $items[] = array(
          'uri' => $filepath,
          'description' => trim(strip_tags($this->row_plugin
            ->render($row))),
        );
      }
    }
    $view->rows = array(
      '#theme' => 'videojs',
      '#items' => $items,
      '#player_id' => 'videojs-view-' . str_replace('_', '-', $view->name),
      '#attached' => videojs_add(FALSE),
    );
    return drupal_render($view->rows);
  }

  // Because we don't provide templates, but Views may complain when visiting
  // the theme information if it can't find any. Specify the name of our theme
  // function to keep it from causing any errors.
  function theme_functions() {
    return array(
      'videojs',
    );
  }

}

Members

Name	Modifiers	Type	Description	Overrides
videojs_style_plugin::options_form		function	Provide a form to edit options for this plugin. Overrides views_plugin_style::options_form
videojs_style_plugin::option_definition		function	Information about options for all kinds of purposes will be held here. Overrides views_plugin_style::option_definition
videojs_style_plugin::render		function	Render the display in this style. Overrides views_plugin_style::render
videojs_style_plugin::theme_functions		function	Provide a full list of possible theme templates used by this style. Overrides views_plugin::theme_functions
videojs_style_plugin::validate		function	Validate that the plugin is correct and can be saved. Overrides views_plugin_style::validate
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_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.