class views_handler_field_file in Views (for Drupal 7) 6.2

Field handler to provide simple renderer that allows linking to a file.

Hierarchy

• class \views_object
  • class \views_handler
    • class \views_handler_field
      • class \views_handler_field_file

1 string reference to 'views_handler_field_file'

system_views_data in modules/system.views.inc

Implementation of hook_views_data()

File

modules/system/views_handler_field_file.inc, line 5

class views_handler_field_file extends views_handler_field {

  /**
   * Constructor to provide additional field to add.
   */
  function init(&$view, $options) {
    parent::init($view, $options);
    if (!empty($options['link_to_file'])) {
      $this->additional_fields['filepath'] = 'filepath';
    }
  }
  function option_definition() {
    $options = parent::option_definition();
    $options['link_to_file'] = array(
      'default' => FALSE,
    );
    return $options;
  }

  /**
   * Provide link to file option
   */
  function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);
    $form['link_to_file'] = array(
      '#title' => t('Link this field to download the file'),
      '#description' => t('This will override any other link you have set.'),
      '#type' => 'checkbox',
      '#default_value' => !empty($this->options['link_to_file']),
    );
  }

  /**
   * Render whatever the data is as a link to the file.
   *
   * Data should be made XSS safe prior to calling this function.
   */
  function render_link($data, $values) {
    if (!empty($this->options['link_to_file']) && $data !== NULL && $data !== '') {
      $this->options['alter']['make_link'] = TRUE;
      $this->options['alter']['path'] = file_create_url($values->{$this->aliases['filepath']});
    }
    return $data;
  }
  function render($values) {
    return $this
      ->render_link(check_plain($values->{$this->field_alias}), $values);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
views_handler::accept_exposed_input		function	Take input from exposed filters and assign to this handler, if necessary.	1
views_handler::access		function	Check whether current user has access to this handler.	5
views_handler::broken		function	Determine if the handler is considered 'broken', meaning it's a a placeholder used when a handler can't be found.	5
views_handler::can_expose		function	Determine if a handler can be exposed.	1
views_handler::ensure_my_table		function	Ensure the main table for this handler is in the query. This is used a lot.	7
views_handler::exposed_form		function	Render our chunk of the exposed filter form when selecting	1
views_handler::exposed_info		function	Get information about the exposed form for the form renderer.	1
views_handler::exposed_submit		function	Submit the exposed filter form
views_handler::exposed_validate		function	Validate the exposed filter form	4
views_handler::expose_options		function	Set new exposed option defaults when exposed setting is flipped on.	1
views_handler::extra_options		function	Provide defaults for the handler.
views_handler::extra_options_form		function	Provide a form for setting options.	1
views_handler::extra_options_submit		function	Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data.
views_handler::extra_options_validate		function	Validate the options form.
views_handler::get_join		function	Get the join object that should be used for this handler.
views_handler::has_extra_options		function	If a handler has 'extra options' it will get a little settings widget and another form called extra_options.	1
views_handler::is_exposed		function	Determine if this item is 'exposed', meaning it provides form elements to let users modify the view.
views_handler::needs_style_plugin		function	Determine if the argument needs a style plugin.	1
views_handler::options_submit		function	Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data.	1
views_handler::options_validate		function	Validate the options form.	1
views_handler::pre_query		function	Run before the view is built.	1
views_handler::set_relationship		function	Called just prior to query(), this lets a handler set up any relationship it needs.
views_handler::store_exposed_input		function	If set to remember exposed input in the session, store it there.	1
views_handler::ui_name		function	Return a string representing this handler's name in the UI.	5
views_handler::validate		function	Validates the handler against the complete View.
views_handler_field::$aliases		property
views_handler_field::$field_alias		property
views_handler_field::add_additional_fields		function	Add 'additional' fields to the query.
views_handler_field::add_self_tokens		function	Add any special tokens this field might use for itself.	4
views_handler_field::admin_summary		function	Provide extra data to the administration form Overrides views_handler::admin_summary
views_handler_field::advanced_render		function	Render a field using advanced settings.
views_handler_field::allow_advanced_render		function	Determine if this field can allow advanced rendering.	1
views_handler_field::click_sort		function	Called to determine what to tell the clicksorter.	1
views_handler_field::click_sortable		function	Determine if this field is click sortable.
views_handler_field::construct		function	Construct a new field handler. Overrides views_object::construct	18
views_handler_field::document_self_tokens		function	Document any special tokens this field might use for itself.	4
views_handler_field::element_type		function	Return DIV or SPAN based upon the field's element type.	2
views_handler_field::get_render_tokens		function	Get the 'render' tokens to use for advanced rendering.
views_handler_field::label		function	Get this field's label.
views_handler_field::pre_render		function	Run before any fields are rendered.	6
views_handler_field::query		function	Called to add the field to a query. Overrides views_handler::query	19
views_handler_field::render_altered		function	Render this field as altered text, from a fieldset set by the user.
views_handler_field::render_as_link		function	Render this field as a link, with the info from a fieldset set by the user.
views_handler_field::render_text		function	Perform an advanced text render for the item.
views_handler_field::render_trim_text		function	Trim the field down to the specified length.
views_handler_field::theme		function	Call out to the theme() function, which probably just calls render() but allows sites to override output fairly easily.
views_handler_field::theme_functions		function
views_handler_field_file::init		function	Constructor to provide additional field to add. Overrides views_handler_field::init
views_handler_field_file::options_form		function	Provide link to file option Overrides views_handler_field::options_form
views_handler_field_file::option_definition		function	Information about options for all kinds of purposes will be held here. Overrides views_handler_field::option_definition
views_handler_field_file::render		function	Render the field. Overrides views_handler_field::render
views_handler_field_file::render_link		function	Render whatever the data is as a link to the file.
views_object::$options		property	Except for displays, options for the object will be held here.	1
views_object::destroy		function		2
views_object::options		function	Set default options on this object. Called by the constructor in a complex chain to deal with backward compatibility.	1
views_object::set_default_options		function	Set default options. For backward compatibility, it sends the options array; this is a feature that will likely disappear at some point.
views_object::set_definition		function	Let the handler know what its full definition is.
views_object::unpack_options		function	Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
views_object::_set_option_defaults		function		1