function views_handler_field_file::option_definition

3.x views_handler_field_file.inc views_handler_field_file::option_definition()
2.x views_handler_field_file.inc views_handler_field_file::option_definition()

Information about options for all kinds of purposes will be held here. @code 'option_name' => array(

  • 'default' => default value,
  • 'translatable' => (optional) TRUE/FALSE (wrap in t() on export if true),
  • 'contains' => (optional) array of items this contains, with its own defaults, etc. If contains is set, the default will be ignored and assumed to be array().
  • 'bool' => (optional) TRUE/FALSE Is the value a boolean value. This will change the export format to TRUE/FALSE instead of 1/0.
  • 'export' => (optional) FALSE or a callback for special export handling if necessary.
  • 'unpack_translatable' => (optional) callback for special handling for translating data within the option, if necessary.

),

Return value

array Returns the options of this handler/plugin.

Overrides views_handler_field::option_definition

See also

views_object::export_option()

views_object::export_option_always()

views_object::unpack_translatable()

2 calls to views_handler_field_file::option_definition()
views_handler_field_file_filemime::option_definition in modules/system/views_handler_field_file_filemime.inc
Information about options for all kinds of purposes will be held here. @code 'option_name' => array(
views_handler_field_file_uri::option_definition in modules/system/views_handler_field_file_uri.inc
Information about options for all kinds of purposes will be held here. @code 'option_name' => array(
2 methods override views_handler_field_file::option_definition()
views_handler_field_file_filemime::option_definition in modules/system/views_handler_field_file_filemime.inc
Information about options for all kinds of purposes will be held here. @code 'option_name' => array(
views_handler_field_file_uri::option_definition in modules/system/views_handler_field_file_uri.inc
Information about options for all kinds of purposes will be held here. @code 'option_name' => array(

File

modules/system/views_handler_field_file.inc, line 24
Definition of views_handler_field_file.

Class

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

Code

function option_definition() {
  $options = parent::option_definition();
  $options['link_to_file'] = array('default' => FALSE, 'bool' => TRUE);
  return $options;
}