class views_plugin_row_file_view in File Entity (fieldable files) 7.2

Plugin which performs a file_view on the resulting object.

Most of the code on this object is in the theme function.

Hierarchy

• class \views_object
  • class \views_plugin
    • class \views_plugin_row
      • class \views_plugin_row_file_view

1 string reference to 'views_plugin_row_file_view'

file_entity_views_plugins in ./file_entity.views.inc

Implements hook_views_plugins().

File

views/views_plugin_row_file_view.inc, line 13

Contains the file view row style plugin.

class views_plugin_row_file_view extends views_plugin_row {

  // Basic properties that let the row style follow relationships.
  var $base_table = 'file_managed';
  var $base_field = 'fid';

  // Stores the files loaded with pre_render.
  var $files = array();
  function option_definition() {
    $options = parent::option_definition();
    $options['view_mode'] = array(
      'default' => 'default',
    );
    $options['links'] = array(
      'default' => TRUE,
    );
    return $options;
  }
  function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);
    $form['view_mode'] = array(
      '#type' => 'select',
      '#options' => file_entity_view_mode_labels(),
      '#title' => t('View mode'),
      '#default_value' => $this->options['view_mode'],
    );
    $form['links'] = array(
      '#type' => 'checkbox',
      '#title' => t('Display links'),
      '#default_value' => $this->options['links'],
    );
  }
  function summary_title() {
    $view_mode_label = file_entity_view_mode_label($this->options['view_mode'], t('Unknown'));
    return check_plain($view_mode_label);
  }
  function pre_render($values) {
    $fids = array();
    foreach ($values as $row) {
      $fids[] = $row->{$this->field_alias};
    }
    $this->files = file_load_multiple($fids);
  }
  function render($row) {
    $file = $this->files[$row->{$this->field_alias}];
    $file->view = $this->view;
    $build = file_view($file, $this->options['view_mode']);
    return drupal_render($build);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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::destroy	public	function	Destructor.	2
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::theme_functions	public	function	Provide a full list of possible theme templates used by this style.
views_plugin::validate	public	function	Validate that the plugin is correct and can be saved.	3
views_plugin_row::init	public	function		2
views_plugin_row::options_submit	public	function	Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data. Overrides views_plugin::options_submit	1
views_plugin_row::options_validate	public	function	Validate the options form. Overrides views_plugin::options_validate
views_plugin_row::query	public	function	Add anything to the query that we might need to. Overrides views_plugin::query
views_plugin_row::uses_fields	public	function
views_plugin_row_file_view::$base_field		property
views_plugin_row_file_view::$base_table		property
views_plugin_row_file_view::$files		property
views_plugin_row_file_view::options_form		function	Provide a form for setting options. Overrides views_plugin_row::options_form
views_plugin_row_file_view::option_definition		function	Information about options for all kinds of purposes will be held here. Overrides views_plugin_row::option_definition
views_plugin_row_file_view::pre_render		function	Allow the style to do stuff before each row is rendered. Overrides views_plugin_row::pre_render
views_plugin_row_file_view::render		function	Render a row object. This usually passes through to a theme template of some form, but not always. Overrides views_plugin_row::render
views_plugin_row_file_view::summary_title		function	Returns the summary of the settings in the display. Overrides views_plugin::summary_title