class views_handler_field_prerender_list
Same name in other branches
- 6.x-3.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 extends \views_object
- class \views_handler_field extends \views_handler
- class \views_handler_field_prerender_list extends \views_handler_field
- class \views_handler_field extends \views_handler
- class \views_handler extends \views_object
Expanded class hierarchy of views_handler_field_prerender_list
Related topics
File
-
handlers/
views_handler_field_prerender_list.inc, line 18
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
*/
public $items = array();
/**
* {@inheritdoc}
*/
public function option_definition() {
$options = parent::option_definition();
$options['type'] = array(
'default' => 'separator',
);
$options['separator'] = array(
'default' => ', ',
);
return $options;
}
/**
* {@inheritdoc}
*/
public 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.
*/
public 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.
*/
public 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.
*
* @param mixed $values
*
* @return array
* The items.
*/
public 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 object $values
* An object containing all retrieved values.
* @param string $field
* Optional name of the field where the value is stored.
* @param bool $raw
* Use the raw data and not the data defined in pre_render.
*/
public 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.
*
* @return bool
* Whether or not the the render method exists.
*/
public 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
Title Sort descending | Deprecated | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|---|
views_handler::$handler_type | public | property | The type of the handler, for example filter/footer/field. | |||
views_handler::$query | public | property | Where the $query object will reside:. | 1 | ||
views_handler::$real_field | public | property | The actual field in the database table, maybe different on other kind of query plugins/special handlers. |
|||
views_handler::$relationship | public | property | The relationship used for this field. | |||
views_handler::$table_alias | public | property | The alias of the table of this handler which is used in the query. | |||
views_handler::$view | public | property | The top object of a view. | Overrides views_object::$view | ||
views_handler::accept_exposed_input | public | function | Take input from exposed handlers and assign to this handler, if necessary. | 1 | ||
views_handler::access | public | function | Check whether current user has access to this handler. | 10 | ||
views_handler::broken | public | function | Determine if the handler is considered 'broken'. | 6 | ||
views_handler::can_expose | public | function | Determine if a handler can be exposed. | 2 | ||
views_handler::case_transform | public | function | Transform a string by a certain method. | |||
views_handler::ensure_my_table | public | function | Ensure the main table for this handler is in the query. This is used a lot. |
8 | ||
views_handler::exposed_form | public | function | Render our chunk of the exposed handler form when selecting. | 1 | ||
views_handler::exposed_info | public | function | Get information about the exposed form for the form renderer. | 1 | ||
views_handler::exposed_submit | public | function | Submit the exposed handler form. | |||
views_handler::exposed_validate | public | function | Validate the exposed handler form. | 4 | ||
views_handler::expose_form | public | function | Form for exposed handler options. | 2 | ||
views_handler::expose_options | public | function | Set new exposed option defaults when exposed setting is flipped on. |
2 | ||
views_handler::expose_submit | public | 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_validate | public | function | Validate the options form. | 1 | ||
views_handler::extra_options | public | function | Provide defaults for the handler. | |||
views_handler::extra_options_form | public | function | Provide a form for setting options. | 1 | ||
views_handler::extra_options_submit | public | 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 | public | function | Validate the options form. | |||
views_handler::get_field | public | function | Shortcut to get a handler's raw field value. | |||
views_handler::get_join | public | function | Get the join object that should be used for this handler. | |||
views_handler::groupby_form | public | function | Provide a form for aggregation settings. | 1 | ||
views_handler::groupby_form_submit | public | 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::has_extra_options | public | function | If a handler has 'extra options' it will get a little settings widget and another form called extra_options. |
1 | ||
views_handler::is_a_group | public | function | Returns TRUE if the exposed filter works like a grouped filter. | 1 | ||
views_handler::is_exposed | public | function | Determine if this item is 'exposed', meaning it provides form elements to let users modify the view. |
|||
views_handler::multiple_exposed_input | public | function | Define if the exposed input has to be submitted multiple times. This is TRUE when exposed filters grouped are using checkboxes as widgets. |
1 | ||
views_handler::needs_style_plugin | public | function | Determine if the argument needs a style plugin. | 1 | ||
views_handler::options_validate | public | function | Validate the options form. | 4 | ||
views_handler::placeholder | public | function | Provides a unique placeholders for handlers. | |||
views_handler::post_execute | public | function | Run after the view is executed, before the result is cached. | 1 | ||
views_handler::pre_query | public | function | Run before the view is built. | 1 | ||
views_handler::sanitize_value | public | function | Sanitize the value for output. | |||
views_handler::set_relationship | public | function | Called just prior to query(), this lets a handler set up any relationship it needs. |
|||
views_handler::show_expose_button | public | function | Shortcut to display the expose/hide button. | 2 | ||
views_handler::show_expose_form | public | function | Shortcut to display the exposed options form. | |||
views_handler::store_exposed_input | public | function | If set to remember exposed input in the session, store it there. | 1 | ||
views_handler::use_group_by | public | function | Provides the handler some groupby. | 2 | ||
views_handler::validate | public | function | Validates the handler against the complete View. | 1 | ||
views_handler_field::$additional_fields | public | property | Stores additional fields which get added to the query. The generated aliases are stored in $aliases. |
|||
views_handler_field::$aliases | public | property | ||||
views_handler_field::$field_alias | public | property | ||||
views_handler_field::$last_render_index | protected | property | Keeps track of the last render index. | |||
views_handler_field::$original_value | public | property | The field value prior to any rewriting. | |||
views_handler_field::add_additional_fields | public | function | Add 'additional' fields to the query. | |||
views_handler_field::add_self_tokens | public | function | Add any special tokens this field might use for itself. | 4 | ||
views_handler_field::admin_summary | public | function | Provide extra data to the administration form. | Overrides views_handler::admin_summary | ||
views_handler_field::advanced_render | public | function | Render a field using advanced settings. | |||
views_handler_field::click_sort | public | function | Called to determine what to tell the clicksorter. | 1 | ||
views_handler_field::click_sortable | public | function | Determine if this field is click sortable. | 1 | ||
views_handler_field::construct | public | function | Construct a new field handler. | Overrides views_object::construct | 17 | |
views_handler_field::document_self_tokens | public | function | Document any special tokens this field might use for itself. | 4 | ||
views_handler_field::element_classes | public | function | Return the class of the field. | |||
views_handler_field::element_label_classes | public | function | Return the class of the field's label. | |||
views_handler_field::element_label_type | public | function | Return an HTML element for the label based upon the field's element type. | |||
views_handler_field::element_type | public | function | Return an HTML element based upon the field's element type. | 2 | ||
views_handler_field::element_wrapper_classes | public | function | Return the class of the field's wrapper. | |||
views_handler_field::element_wrapper_type | public | function | Return an HTML element for the wrapper based upon the field's element type. | |||
views_handler_field::get_elements | public | function | Provide a list of elements valid for field HTML. | |||
views_handler_field::get_render_tokens | public | function | Get the 'render' tokens to use for advanced rendering. | |||
views_handler_field::get_token_values_recursive | public | function | Recursive function to add replacements for nested query string parameters. | |||
views_handler_field::init | public | function | Init the handler with necessary data. | Overrides views_handler::init | 11 | |
views_handler_field::is_value_empty | public | function | Checks if a field value is empty. | |||
views_handler_field::label | public | function | Get this field's label. | |||
views_handler_field::options_submit | public | function | Performs some cleanup tasks on the options array before saving it. | Overrides views_handler::options_submit | 1 | |
views_handler_field::pre_render | public | function | Run before any fields are rendered. | 8 | ||
views_handler_field::query | public | function | Called to add the field to a query. | 22 | ||
views_handler_field::render_altered | public | function | Render this field as altered text, from a fieldset set by the user. | |||
views_handler_field::render_as_link | public | function | Render this field as a link, with info from a fieldset set by the user. | |||
views_handler_field::render_text | public | function | Perform an advanced text render for the item. | |||
views_handler_field::render_trim_text | public | function | Trim the field down to the specified length. | |||
views_handler_field::theme | public | function | Call out to the theme() function. | |||
views_handler_field::theme_functions | public | function | Build a list of suitable theme functions for this view. | |||
views_handler_field::tokenize_value | public | function | Replace a value with tokens from the last field. | |||
views_handler_field::ui_name | public | function | Return a string representing this handler's name in the UI. | Overrides views_handler::ui_name | 1 | |
views_handler_field::use_string_group_by | public | function | Determines if this field will be available as an option to group the result by in the style settings. |
|||
views_handler_field_prerender_list::$items | public | property | Stores all items which are used to render the items. | |||
views_handler_field_prerender_list::allow_advanced_render | public | function | Determine if advanced rendering is allowed. | Overrides views_handler_field::allow_advanced_render | ||
views_handler_field_prerender_list::get_items | public | function | Return an array of items for the field. | |||
views_handler_field_prerender_list::get_value | public | function | Get the value that's supposed to be rendered. | Overrides views_handler_field::get_value | ||
views_handler_field_prerender_list::options_form | public | function | Default options form provides the label widget that all fields should have. | Overrides views_handler_field::options_form | 2 | |
views_handler_field_prerender_list::option_definition | public | function | Information about options for all kinds of purposes will be held here. | Overrides views_handler_field::option_definition | 2 | |
views_handler_field_prerender_list::render | public | function | Render the field. | Overrides views_handler_field::render | ||
views_handler_field_prerender_list::render_items | public | function | Render all items in this field together. | |||
views_object::$definition | public | property | Handler's definition. | |||
views_object::$options | public | property | Except for displays, options for the object will be held here. | 1 | ||
views_object::altered_option_definition | public | function | Collect this handler's option definition and alter them, ready for use. | |||
views_object::destroy | public | function | Destructor. | 2 | ||
views_object::export_option | public | function | 1 | |||
views_object::export_options | public | function | ||||
views_object::export_option_always | public | function | Always exports the option, regardless of the default value. | |||
views_object::options | Deprecated | public | function | Set default options on this object. | 1 | |
views_object::set_default_options | public | function | Set default options. | |||
views_object::set_definition | public | function | Let the handler know what its full definition is. | |||
views_object::unpack_options | public | function | Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. |
|||
views_object::unpack_translatable | public | function | Unpack a single option definition. | |||
views_object::unpack_translatables | public | function | Unpacks each handler to store translatable texts. | |||
views_object::_set_option_defaults | public | function |