You are here

Home » API reference » MediaFront 7 » mediafront_plugin_style_player_advanced.inc

class mediafront_plugin_style_player_advanced in MediaFront 7

@class Extension of the Views Plugin Syle for the Media Player from MediaFront

This class extended the default views plugin class to provide a style plugin for the MediaFront module.

Hierarchy

Expanded class hierarchy of mediafront_plugin_style_player_advanced

1 string reference to 'mediafront_plugin_style_player_advanced'
mediafront_views_plugins in views/mediafront.views.inc
Implementation of hook_views_plugins

File

views/mediafront_plugin_style_player_advanced.inc, line 17
This file holds style plugin for MediaFront Views

View source 
class mediafront_plugin_style_player_advanced extends views_plugin_style {

  /**
   * Set the default options.
   */
  function option_definition() {
    $options = parent::option_definition();
    $options['mediafront_preset'] = array(
      'default' => '',
    );
    $options['mediafront_media_field'] = array(
      'default' => '',
    );
    $options['mediafront_image_field'] = array(
      'default' => '',
    );
    $options['mediafront_title_field'] = array(
      'default' => '',
    );
    return $options;
  }

  /**
   * Shows the options form for the media player style
   */
  function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);
    $form['mediafront_preset'] = mediafront_preset_select_form($this->options);
    $field_options = array(
      '' => t('- None -'),
    );
    $field_options += $this->display->handler
      ->get_field_labels();
    $form['mediafront_media_field'] = array(
      '#type' => 'select',
      '#title' => t('Media (video/audio) field'),
      '#description' => t('Can be a text field outputting a URL, a file field or a media field.'),
      '#options' => $field_options,
      '#default_value' => $this->options['mediafront_media_field'],
      '#required' => TRUE,
    );
    $form['mediafront_image_field'] = array(
      '#type' => 'select',
      '#title' => t('Image field'),
      '#description' => t('Can be a text field outputting a URL, an image field or a media field.'),
      '#options' => $field_options,
      '#default_value' => $this->options['mediafront_image_field'],
    );
    $form['mediafront_title_field'] = array(
      '#type' => 'select',
      '#title' => t('Title field'),
      '#description' => t('This text field will be used as the video title.'),
      '#options' => $field_options,
      '#default_value' => $this->options['mediafront_title_field'],
    );
  }

  /**
   * Renders the media player.
   */
  function render() {
    $output = '';

    // Check for live preview.
    if (!empty($this->view->live_preview)) {
      return t('MediaFront views are not compatible with live preview.');
    }
    $i = 0;
    $params = array();
    $params['playlistObj']['nodes'] = array();
    foreach ($this->view->result as $index => $row) {
      $media_url = $this
        ->getFieldRawUrl($index, $this->options['mediafront_media_field']);
      $this->view->row_index = $index;
      if ($media_url) {
        $playlist_node = array(
          'mediafiles' => array(
            'media' => array(
              'media' => (object) array(
                'path' => $media_url,
              ),
            ),
          ),
        );
        if ($this->options['mediafront_title_field']) {
          $title = $this->view
            ->render_field($this->options['mediafront_title_field'], $index);
          if ($title) {
            $playlist_node['title'] = $title;
          }
        }
        if ($this->options['mediafront_image_field']) {
          $image_url = $this
            ->getFieldRawUrl($index, $this->options['mediafront_image_field']);
          if ($image_url) {
            $playlist_node['mediafiles']['images'] = array(
              'image' => (object) array(
                'path' => $image_url,
              ),
            );
          }
        }
        $params['playlistObj']['nodes'][] = $playlist_node;
      }
    }
    $params['playlistObj']['total_rows'] = count($params['playlistObj']['nodes']);

    // Now render the media player for this view.
    return mediafront_get_player($this->options['mediafront_preset'], $params);
  }

  /**
   * Returns a full URL to a media or file field.
   * Accepts media fields and raw text fields.
   */
  function getFieldRawUrl($row_id, $field_name) {
    $media_url = '';
    if (isset($this->display->handler->handlers['field'][$field_name]->field_info['type'])) {
      $field_type = $this->display->handler->handlers['field'][$field_name]->field_info['type'];
      switch ($field_type) {
        case 'file':
        case 'image':
        case 'media':
          if (isset($this->view->result[$row_id]->{"field_{$field_name}"}[0])) {
            if ($field_type == 'media') {
              $uri = $this->view->result[$row_id]->{"field_{$field_name}"}[0]['raw']['file']->uri;
            }
            else {
              $uri = $this->view->result[$row_id]->{"field_{$field_name}"}[0]['raw']['uri'];
            }
            $stream_wrapper = file_stream_wrapper_get_instance_by_uri($uri);
            if (is_object($stream_wrapper)) {
              $media_url = $stream_wrapper
                ->getExternalUrl();
            }
          }
          break;
        default:
          break;
      }
    }
    if (!$media_url) {
      $media_url = $this->view
        ->render_field($field_name, $row_id);
    }
    return $media_url;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
mediafront_plugin_style_player_advanced::getFieldRawUrl function Returns a full URL to a media or file field. Accepts media fields and raw text fields.
mediafront_plugin_style_player_advanced::options_form function Shows the options form for the media player style Overrides views_plugin_style::options_form
mediafront_plugin_style_player_advanced::option_definition function Set the default options. Overrides views_plugin_style::option_definition
mediafront_plugin_style_player_advanced::render function Renders the media player. 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::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_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