class mediafront_plugin_style_player in MediaFront 7.2

@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

• class \views_object
  • class \views_plugin
    • class \views_plugin_style
      • class \mediafront_plugin_style_player

1 string reference to 'mediafront_plugin_style_player'

mediafront_views_plugins in views/mediafront.views.inc

Implementation of hook_views_plugins

File

views/mediafront_plugin_style_player.inc, line 17

This file holds style plugin for MediaFront Views

class mediafront_plugin_style_player extends views_plugin_style {

  /**
   * Initialize a style plugin.
   *
   * @param $view
   * @param $display
   * @param $options
   *   The style options might come externally as the style can be sourced
   *   from at least two locations. If it's not included, look on the display.
   */
  function init(&$view, &$display, $options = NULL) {
    parent::init($view, $display, $options);

    /**
    * This was keeping the view from being able to specify how many entries
    * were in the playlist... if we want this, we need to figure out how
    * to bring in the preset settings for pageLimit into the view to limit
    * the amount of results displayed.
    *
        $view->display_handler->set_option('pager', array(
     'type' => 'some',
     'options' => $view->display_handler->options['pager']['options'],
        ));
    *
    */

    // We want to get the total rows.
    $view->get_total_rows = TRUE;
  }

  /**
   * Set the default options.
   */
  function option_definition() {
    $options = parent::option_definition();
    $options['mediafront_preset'] = 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);
  }

  /**
   * Renders the media player.
   */
  function render() {
    if (empty($this->options['mediafront_preset'])) {
      return t('You must select a preset for the MediaFront Player style in the view.');
    }

    // Now render the media player for this view.
    return mediafront_get_player($this->options['mediafront_preset'], array(
      'id' => mediafront_views_get_id($this->view),
      'playlist' => mediafront_get_playlist_from_view($this->view),
    ));
  }

}

Members

Name	Modifiers	Type	Description	Overrides
mediafront_plugin_style_player::init		function	Initialize a style plugin. Overrides views_plugin_style::init
mediafront_plugin_style_player::options_form		function	Shows the options form for the media player style Overrides views_plugin_style::options_form
mediafront_plugin_style_player::option_definition		function	Set the default options. Overrides views_plugin_style::option_definition
mediafront_plugin_style_player::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::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