A handler to display data from entity objects.

Fields based upon this handler work with all query-backends if the tables used by the query backend have an 'entity type' specified. In order to make fields based upon this handler automatically available to all compatible query backends, the views field can be defined in the table

views_entity_{ENTITY_TYPE} 

.

Hierarchy

Expanded class hierarchy of views_handler_field_entity

Related topics

File

core/modules/views/handlers/views_handler_field_entity.inc, line 18
Definition of views_handler_field_entity.

Members

Contains filters are case sensitive
Namesort ascending Modifiers Type Description
views_object::_set_option_defaults function
views_object::unpack_translatables public function Unpacks each handler to store translatable texts.
views_object::unpack_translatable public function Unpack a single option definition.
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_definition function Let the handler know what its full definition is.
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::options Deprecated function Set default options on this object. Called by the constructor in a complex chain to deal with backward compatibility.
views_object::destroy function
views_handler_field_entity::query function Overriden to add the field for the entity id. Overrides views_handler_field::query
views_handler_field_entity::pre_render function Load the entities for all rows that are about to be displayed. Overrides views_handler_field::pre_render
views_handler_field_entity::init public function Initialize the entity type. Overrides views_handler_field::init
views_handler_field_entity::get_value function Overridden to return the entity object, or a certain property of the entity. Overrides views_handler_field::get_value
views_handler_field_entity::$entity_type public property Stores the entity type which is loaded by this field.
views_handler_field_entity::$entities public property Stores all entites which are in the result.
views_handler_field_entity::$base_field public property The base field of the entity type assosiated with this field.
views_handler_field::use_string_group_by function Determines if this field will be available as an option to group the result by in the style settings.
views_handler_field::ui_name function Return a string representing this handler's name in the UI. Overrides views_handler::ui_name
views_handler_field::tokenize_value function Replace a value with tokens from the last field.
views_handler_field::theme_functions function
views_handler_field::theme function Call out to the theme() function, which probably just calls render() but allows sites to override output more easily.
views_handler_field::render_trim_text function Trim the field down to the specified length.
views_handler_field::render_text function Perform an advanced text render for the item.
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_altered function Render this field as altered text, from a fieldset set by the user.
views_handler_field::render function Render the field.
views_handler_field::option_definition function Information about options for all kinds of purposes will be held here. @code 'option_name' => array( Overrides views_handler::option_definition
views_handler_field::options_submit function Performs some cleanup tasks on the options array before saving it. Overrides views_handler::options_submit
views_handler_field::options_form function Default options form that provides the label widget that all fields should have. Overrides views_handler::options_form
views_handler_field::label function Get this field's label.
views_handler_field::is_value_empty function Checks if a field value is empty.
views_handler_field::get_token_values_recursive function Recursive function to add replacements for nested query string parameters.
views_handler_field::get_render_tokens function Get the 'render' tokens to use for advanced rendering.
views_handler_field::get_elements function Provide a list of elements valid for field HTML.
views_handler_field::element_wrapper_type function Return an HTML element for the wrapper based upon the field's element type.
views_handler_field::element_wrapper_classes function Return the class of the field's wrapper.
views_handler_field::element_type function Return an HTML element based upon the field's element type.
views_handler_field::element_label_type function Return an HTML element for the label based upon the field's element type.
views_handler_field::element_label_classes function Return the class of the field's label.
views_handler_field::element_classes function Return the class of the field.
views_handler_field::document_self_tokens function Document any special tokens this field might use for itself.
views_handler_field::construct function Construct a new field handler. Overrides views_object::construct
views_handler_field::click_sortable function Determine if this field is click sortable.
views_handler_field::click_sort function Called to determine what to tell the clicksorter.
views_handler_field::allow_advanced_render function Determine if this field can allow advanced rendering.
views_handler_field::advanced_render function Render a field using advanced settings.
views_handler_field::admin_summary function Provide extra data to the administration form Overrides views_handler::admin_summary
views_handler_field::add_self_tokens function Add any special tokens this field might use for itself.
views_handler_field::add_additional_fields function Add 'additional' fields to the query.
views_handler_field::$original_value public property The field value prior to any rewriting.
views_handler::validate function Validates the handler against the complete View.
views_handler::use_group_by function Provides the handler some groupby.
views_handler::store_exposed_input function If set to remember exposed input in the session, store it there.
views_handler::show_expose_form function Shortcut to display the exposed options form.
views_handler::show_expose_button function Shortcut to display the expose/hide button.
views_handler::set_relationship function Called just prior to query(), this lets a handler set up any relationship it needs.
views_handler::sanitize_value function Sanitize the value for output.
views_handler::pre_query function Run before the view is built.
views_handler::post_execute function Run after the view is executed, before the result is cached.
views_handler::placeholder function Provides a unique placeholders for handlers.
views_handler::options_validate function Validate the options form.
views_handler::needs_style_plugin function Determine if the argument needs a style plugin.
views_handler::multiple_exposed_input function Define if the exposed input has to be submitted multiple times. This is TRUE when exposed filters grouped are using checkboxes as widgets.
views_handler::is_exposed function Determine if this item is 'exposed', meaning it provides form elements to let users modify the view.
views_handler::is_a_group function Returns TRUE if the exposed filter works like a grouped filter.
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.
views_handler::groupby_form_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::groupby_form function Provide a form for aggregation settings.
views_handler::get_join function Get the join object that should be used for this handler.
views_handler::get_field function Shortcut to get a handler's raw field value.
views_handler::extra_options_validate function Validate the options form.
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_form function Provide a form for setting options.
views_handler::extra_options function Provide defaults for the handler.
views_handler::expose_validate function Validate the options form.
views_handler::expose_submit function Perform any necessary changes to the form exposes prior to storage. There is no need for this function to actually store the data.
views_handler::expose_options function Set new exposed option defaults when exposed setting is flipped on.
views_handler::expose_form function Form for exposed handler options.
views_handler::exposed_validate function Validate the exposed handler form
views_handler::exposed_submit function Submit the exposed handler form
views_handler::exposed_info function Get information about the exposed form for the form renderer.
views_handler::exposed_form function Render our chunk of the exposed handler form when selecting
views_handler::ensure_my_table function Ensure the main table for this handler is in the query. This is used a lot.
views_handler::case_transform function Transform a string by a certain method.
views_handler::can_expose function Determine if a handler can be exposed.
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.
views_handler::access function Check whether current user has access to this handler.
views_handler::accept_exposed_input function Take input from exposed handlers and assign to this handler, if necessary.
views_handler::$table_alias public property The alias of the table of this handler which is used in the query.
views_handler::$table public property The Views name of the table on which this handler effects.