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
- class views_object
- class views_handler
- class views_handler_field
- class views_handler
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
Name | Modifiers | Type | Description |
---|---|---|---|
views_object:: |
function | ||
views_object:: |
public | function | Unpacks each handler to store translatable texts. |
views_object:: |
public | function | Unpack a single option definition. |
views_object:: |
function | Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. | |
views_object:: |
function | Let the handler know what its full definition is. | |
views_object:: |
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:: |
function | Set default options on this object. Called by the constructor in a complex chain to deal with backward compatibility. | |
views_object:: |
function | ||
views_handler_field_entity:: |
function |
Overridden to add the field for the entity ID. Overrides views_handler_field:: |
|
views_handler_field_entity:: |
function |
Load the entities for all rows that are about to be displayed. Overrides views_handler_field:: |
|
views_handler_field_entity:: |
public | function |
Initialize the entity type. Overrides views_handler_field:: |
views_handler_field_entity:: |
function |
Overridden to return the entity object, or a certain property of the entity. Overrides views_handler_field:: |
|
views_handler_field_entity:: |
public | property | Stores the entity type which is loaded by this field. |
views_handler_field_entity:: |
public | property | Stores all entities that are in the result. |
views_handler_field_entity:: |
public | property | The base field of the entity type associated with this field. |
views_handler_field:: |
function | Determines if this field will be available as an option to group the result by in the style settings. | |
views_handler_field:: |
function |
Return a string representing this handler's name in the UI. Overrides views_handler:: |
|
views_handler_field:: |
function | Replace a value with tokens from the last field. | |
views_handler_field:: |
function | ||
views_handler_field:: |
function | Call out to the theme() function, which probably just calls render() but allows sites to override output more easily. | |
views_handler_field:: |
function | Trim the field down to the specified length. | |
views_handler_field:: |
function | Perform an advanced text render for the item. | |
views_handler_field:: |
function | Render this field as a link, with the info from a fieldset set by the user. | |
views_handler_field:: |
function | Render this field as altered text, from a fieldset set by the user. | |
views_handler_field:: |
function | Render the field. | |
views_handler_field:: |
function |
Information about options for all kinds of purposes will be held here.
@code
'option_name' => array( Overrides views_handler:: |
|
views_handler_field:: |
function |
Performs some cleanup tasks on the options array before saving it. Overrides views_handler:: |
|
views_handler_field:: |
function |
Default options form that provides the label widget that all fields
should have. Overrides views_handler:: |
|
views_handler_field:: |
function | Get this field's label. | |
views_handler_field:: |
function | Checks if a field value is empty. | |
views_handler_field:: |
function | Recursive function to add replacements for nested query string parameters. | |
views_handler_field:: |
function | Get the 'render' tokens to use for advanced rendering. | |
views_handler_field:: |
function | Provide a list of elements valid for field HTML. | |
views_handler_field:: |
function | Return an HTML element for the wrapper based upon the field's element type. | |
views_handler_field:: |
function | Return the class of the field's wrapper. | |
views_handler_field:: |
function | Return an HTML element based upon the field's element type. | |
views_handler_field:: |
function | Return an HTML element for the label based upon the field's element type. | |
views_handler_field:: |
function | Return the class of the field's label. | |
views_handler_field:: |
function | Return the class of the field. | |
views_handler_field:: |
function | Document any special tokens this field might use for itself. | |
views_handler_field:: |
function |
Construct a new field handler. Overrides views_object:: |
|
views_handler_field:: |
function | Determine if this field is click sortable. | |
views_handler_field:: |
function | Called to determine what to tell the clicksorter. | |
views_handler_field:: |
function | Determine if this field can allow advanced rendering. | |
views_handler_field:: |
function | Render a field using advanced settings. | |
views_handler_field:: |
function |
Provide extra data to the administration form Overrides views_handler:: |
|
views_handler_field:: |
function | Add any special tokens this field might use for itself. | |
views_handler_field:: |
function | Add 'additional' fields to the query. | |
views_handler_field:: |
public | property | The field value prior to any rewriting. |
views_handler:: |
function | Validates the handler against the complete View. | |
views_handler:: |
function | Provides the handler some groupby. | |
views_handler:: |
function | If set to remember exposed input in the session, store it there. | |
views_handler:: |
function | Shortcut to display the exposed options form. | |
views_handler:: |
function | Shortcut to display the expose/hide button. | |
views_handler:: |
function | Called just prior to query(), this lets a handler set up any relationship it needs. | |
views_handler:: |
function | Sanitize the value for output. | |
views_handler:: |
function | Run before the view is built. | |
views_handler:: |
function | Run after the view is executed, before the result is cached. | |
views_handler:: |
function | Provides a unique placeholders for handlers. | |
views_handler:: |
function | Validate the options form. | |
views_handler:: |
function | Determine if the argument needs a style plugin. | |
views_handler:: |
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:: |
function | Determine if this item is 'exposed', meaning it provides form elements to let users modify the view. | |
views_handler:: |
function | Returns TRUE if the exposed filter works like a grouped filter. | |
views_handler:: |
function | If a handler has 'extra options' it will get a little settings widget and another form called extra_options. | |
views_handler:: |
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:: |
function | Provide a form for aggregation settings. | |
views_handler:: |
function | Get the join object that should be used for this handler. | |
views_handler:: |
function | Shortcut to get a handler's raw field value. | |
views_handler:: |
function | Validate the options form. | |
views_handler:: |
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:: |
function | Provide a form for setting options. | |
views_handler:: |
function | Provide defaults for the handler. | |
views_handler:: |
function | Validate the options form. | |
views_handler:: |
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:: |
function | Set new exposed option defaults when exposed setting is flipped on. | |
views_handler:: |
function | Form for exposed handler options. | |
views_handler:: |
function | Validate the exposed handler form | |
views_handler:: |
function | Submit the exposed handler form | |
views_handler:: |
function | Get information about the exposed form for the form renderer. | |
views_handler:: |
function | Render our chunk of the exposed handler form when selecting | |
views_handler:: |
function | Ensure the main table for this handler is in the query. This is used a lot. | |
views_handler:: |
function | Transform a string by a certain method. | |
views_handler:: |
function | Determine if a handler can be exposed. | |
views_handler:: |
function | Determine if the handler is considered 'broken', meaning it's a a placeholder used when a handler can't be found. | |
views_handler:: |
function | Check whether current user has access to this handler. | |
views_handler:: |
function | Take input from exposed handlers and assign to this handler, if necessary. | |
views_handler:: |
public | property | The alias of the table of this handler which is used in the query. |
views_handler:: |
public | property | The Views name of the table on which this handler effects. |