class views_handler_field_prerender_list
- 3.x handlers/views_handler_field_prerender_list.inc views_handler_field_prerender_list
- 2.x handlers/views_handler_field_prerender_list.inc views_handler_field_prerender_list
Field handler to provide a list of items.
The items are expected to be loaded by a child object during pre_render, and 'my field' is expected to be the pointer to the items in the list.
Items to render should be in a list in $this->items
Hierarchy
- class \views_object
- class \views_handler
- class \views_handler_field
- class \views_handler
Expanded class hierarchy of views_handler_field_prerender_list
Related topics
File
- handlers/
views_handler_field_prerender_list.inc, line 18 - Definition of views_handler_field_prerender_list.
View source
class views_handler_field_prerender_list extends views_handler_field {
/**
* Stores all items which are used to render the items.
* It should be keyed first by the id of the base table, for example nid.
* The second key is the id of the thing which is displayed multiple times
* per row, for example the tid.
*
* @var array
*/
var $items = array();
function option_definition() {
$options = parent::option_definition();
$options['type'] = array('default' => 'separator');
$options['separator'] = array('default' => ', ');
return $options;
}
function options_form(&$form, &$form_state) {
$form['type'] = array(
'#type' => 'radios',
'#title' => t('Display type'),
'#options' => array(
'ul' => t('Unordered list'),
'ol' => t('Ordered list'),
'separator' => t('Simple separator'),
),
'#default_value' => $this->options['type'],
);
$form['separator'] = array(
'#type' => 'textfield',
'#title' => t('Separator'),
'#default_value' => $this->options['separator'],
'#dependency' => array('radio:options[type]' => array('separator')),
);
parent::options_form($form, $form_state);
}
/**
* Render the field.
*
* This function is deprecated, but left in for older systems that have not
* yet or won't update their prerender list fields. If a render_item method
* exists, this will not get used by advanced_render.
*/
function render($values) {
$field = $this->get_value($values);
if (!empty($this->items[$field])) {
if ($this->options['type'] == 'separator') {
return implode($this->sanitize_value($this->options['separator']), $this->items[$field]);
}
else {
return theme('item_list',
array(
'items' => $this->items[$field],
'title' => NULL,
'type' => $this->options['type']
));
}
}
}
/**
* Render all items in this field together.
*
* When using advanced render, each possible item in the list is rendered
* individually. Then the items are all pasted together.
*/
function render_items($items) {
if (!empty($items)) {
if ($this->options['type'] == 'separator') {
return implode($this->sanitize_value($this->options['separator'], 'xss_admin'), $items);
}
else {
return theme('item_list',
array(
'items' => $items,
'title' => NULL,
'type' => $this->options['type']
));
}
}
}
/**
* Return an array of items for the field.
*
* Items should be stored in the result array, if possible, as an array
* with 'value' as the actual displayable value of the item, plus
* any items that might be found in the 'alter' options array for
* creating links, such as 'path', 'fragment', 'query' etc, such a thing
* is to be made. Additionally, items that might be turned into tokens
* should also be in this array.
*/
function get_items($values) {
// Only the parent get_value returns a single field.
$field = parent::get_value($values);
if (!empty($this->items[$field])) {
return $this->items[$field];
}
return array();
}
/**
* Get the value that's supposed to be rendered.
*
* @param $values
* An object containing all retrieved values.
* @param $field
* Optional name of the field where the value is stored.
* @param $raw
* Use the raw data and not the data defined in pre_render
*/
function get_value($values, $field = NULL, $raw = FALSE) {
if ($raw) {
return parent::get_value($values, $field);
}
$item = $this->get_items($values);
$item = (array) $item;
if (isset($field) && isset($item[$field])) {
return $item[$field];
}
return $item;
}
/**
* Determine if advanced rendering is allowed.
*
* By default, advanced rendering will NOT be allowed if the class
* inheriting from this does not implement a 'render_items' method.
*/
function allow_advanced_render() {
// Note that the advanced render bits also use the presence of
// this method to determine if it needs to render items as a list.
return method_exists($this, 'render_item');
}
}
Members
Name | Modifiers | Type | Description |
---|---|---|---|
views_handler_field:: |
function | ||
views_object:: |
function | ||
views_object:: |
function | ||
views_object:: |
function | ||
views_object:: |
function | ||
views_handler_field:: |
function | Add 'additional' fields to the query. | |
views_handler_field:: |
function | Add any special tokens this field might use for itself. | |
views_object:: |
function | Always exports the option, regardless of the default value. | |
views_handler_field:: |
function | Call out to the theme() function, which probably just calls render() but allows sites to override output fairly easily. | |
views_handler:: |
function | Called just prior to query(), this lets a handler set up any relationship it needs. | |
views_handler_field:: |
function | Called to add the field to a query. | |
views_handler_field:: |
function | Called to determine what to tell the clicksorter. | |
views_handler:: |
function | Check whether current user has access to this handler. | |
views_handler_field:: |
function | Checks if a field value is empty. | |
views_handler_field:: |
function |
Construct a new field handler. Overrides views_object:: |
|
views_handler_field_prerender_list:: |
function |
Default options form that provides the label widget that all fields
should have. Overrides views_handler_field:: |
|
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 a handler can be exposed. | |
views_handler_field_prerender_list:: |
function |
Determine if advanced rendering is allowed. Overrides views_handler_field:: |
|
views_handler:: |
function | Determine if the argument needs a style plugin. | |
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_field:: |
function | Determine if this field is click sortable. | |
views_handler:: |
function | Determine if this item is 'exposed', meaning it provides form elements to let users modify the view. | |
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 | Document any special tokens this field might use for itself. | |
views_handler:: |
function | Ensure the main table for this handler is in the query. This is used a lot. | |
views_handler:: |
function | Form for exposed handler options. | |
views_handler:: |
function | Get information about the exposed form for the form renderer. | |
views_handler_field:: |
function | Get the 'render' tokens to use for advanced rendering. | |
views_handler:: |
function | Get the join object that should be used for this handler. | |
views_handler_field_prerender_list:: |
function |
Get the value that's supposed to be rendered. Overrides views_handler_field:: |
|
views_handler_field:: |
function | Get this field's label. | |
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 | If set to remember exposed input in the session, store it there. | |
views_handler_field_prerender_list:: |
function |
Information about options for all kinds of purposes will be held here.
@code
'option_name' => array( Overrides views_handler_field:: |
|
views_handler_field:: |
function |
init the handler with necessary data. Overrides views_handler:: |
|
views_object:: |
function | Let the handler know what its full definition is. | |
views_handler_field:: |
function | Perform an advanced text render for the item. | |
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 | 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 | 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_field:: |
function |
Performs some cleanup tasks on the options array before saving it. Overrides views_handler:: |
|
views_handler:: |
function | Provide a form for aggregation settings. | |
views_handler:: |
function | Provide a form for setting options. | |
views_handler_field:: |
function | Provide a list of elements valid for field HTML. | |
views_handler:: |
function | Provide defaults for the handler. | |
views_handler_field:: |
function |
Provide extra data to the administration form Overrides views_handler:: |
|
views_handler:: |
function | Provides a unique placeholders for handlers. | |
views_handler:: |
function | Provides the handler some groupby. | |
views_handler_field:: |
function | Recursive function to add replacements for nested query string parameters. | |
views_handler_field:: |
function | Render a field using advanced settings. | |
views_handler_field_prerender_list:: |
function | Render all items in this field together. | |
views_handler:: |
function | Render our chunk of the exposed handler form when selecting | |
views_handler_field_prerender_list:: |
function |
Render the field. Overrides views_handler_field:: |
|
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 | Replace a value with tokens from the last field. | |
views_handler_field:: |
function |
Return a string representing this handler's name in the UI. Overrides views_handler:: |
|
views_handler_field_prerender_list:: |
function | Return an array of items for the field. | |
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 an HTML element for the wrapper 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's wrapper. | |
views_handler_field:: |
function | Return the class of the field. | |
views_handler:: |
function | Returns TRUE if the exposed filter works like a grouped filter. | |
views_handler:: |
function | Run after the view is executed, before the result is cached. | |
views_handler_field:: |
function | Run before any fields are rendered. | |
views_handler:: |
function | Run before the view is built. | |
views_handler:: |
function | Sanitize the value for output. | |
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 | Set default options. For backward compatibility, it sends the options array; this is a feature that will likely disappear at some point. | |
views_handler:: |
function | Set new exposed option defaults when exposed setting is flipped on. | |
views_handler:: |
function | Shortcut to display the expose/hide button. | |
views_handler:: |
function | Shortcut to display the exposed options form. | |
views_handler:: |
function | Shortcut to get a handler's raw field value. | |
views_handler:: |
function | Submit the exposed handler form | |
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_field:: |
public | property | The field value prior to any rewriting. |
views_handler:: |
function | Transform a string by a certain method. | |
views_handler_field:: |
function | Trim the field down to the specified length. | |
views_object:: |
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 | Unpacks each handler to store translatable texts. | |
views_handler:: |
function | Validate the exposed handler form | |
views_handler:: |
function | Validate the options form. | |
views_handler:: |
function | Validate the options form. | |
views_handler:: |
function | Validate the options form. | |
views_handler:: |
function | Validates the handler against the complete View. |