class views_handler_field in Views (for Drupal 7) 6.3
Same name and namespace in other branches
- 6.2 handlers/views_handler_field.inc \views_handler_field
- 7.3 handlers/views_handler_field.inc \views_handler_field
Base field handler that has no options and renders an unformatted field.
Definition terms:
- additional fields: An array of fields that should be added to the query for some purpose. The array is in the form of: array('identifier' => array('table' => tablename, 'field' => fieldname); as many fields as are necessary may be in this array.
- click sortable: If TRUE, this field may be click sorted.
Hierarchy
- class \views_object
- class \views_handler
- class \views_handler_field
- class \views_handler
Expanded class hierarchy of views_handler_field
Related topics
20 string references to 'views_handler_field'
- aggregator_views_handlers in modules/
aggregator.views.inc - Implementation of hook_views_handlers() to register all of the basic handlers views uses.
- comment_views_data in modules/
comment.views.inc - Implementation of hook_views_data()
- comment_views_handlers in modules/
comment.views.inc - Implementation of hook_views_handlers() to register all of the basic handlers views uses.
- filter_views_handlers in modules/
filter.views.inc - hook_views_data in docs/
docs.php - Describe table structure to Views.
File
- handlers/
views_handler_field.inc, line 20
View source
class views_handler_field extends views_handler {
var $field_alias = 'unknown';
var $aliases = array();
/**
* @var array
* Stores additional fields which get's added to the query.
* The generated aliases are stored in $aliases.
*/
var $additional_fields = array();
/**
* Construct a new field handler.
*/
function construct() {
parent::construct();
$this->additional_fields = array();
if (!empty($this->definition['additional fields'])) {
$this->additional_fields = $this->definition['additional fields'];
}
if (!isset($this->options['exclude'])) {
$this->options['exclude'] = '';
}
}
/**
* Determine if this field can allow advanced rendering.
*
* Fields can set this to FALSE if they do not wish to allow
* token based rewriting or link-making.
*/
function allow_advanced_render() {
return TRUE;
}
function init(&$view, $options) {
parent::init($view, $options);
}
/**
* Called to add the field to a query.
*/
function query() {
$this
->ensure_my_table();
// Add the field.
$this->field_alias = $this->query
->add_field($this->table_alias, $this->real_field);
$this
->add_additional_fields();
}
/**
* Add 'additional' fields to the query.
*
* @param $fields
* An array of fields. The key is an identifier used to later find the
* field alias used. The value is either a string in which case it's
* assumed to be a field on this handler's table; or it's an array in the
* form of
* @code array('table' => $tablename, 'field' => $fieldname) @endcode
*/
function add_additional_fields($fields = NULL) {
if (!isset($fields)) {
// notice check
if (empty($this->additional_fields)) {
return;
}
$fields = $this->additional_fields;
}
if (!empty($fields) && is_array($fields)) {
foreach ($fields as $identifier => $info) {
if (is_array($info)) {
if (isset($info['table'])) {
$table_alias = $this->query
->ensure_table($info['table'], $this->relationship);
}
else {
$table_alias = $this->table_alias;
}
if (empty($table_alias)) {
vpr(t('Handler @handler tried to add additional_field @identifier but @table could not be added!', array(
'@handler' => $this->definition['handler'],
'@identifier' => $identifier,
'@table' => $info['table'],
)));
$this->aliases[$identifier] = 'broken';
continue;
}
$params = array();
if (!empty($info['params'])) {
$params = $info['params'];
}
$this->aliases[$identifier] = $this->query
->add_field($table_alias, $info['field'], NULL, $params);
}
else {
$this->aliases[$info] = $this->query
->add_field($this->table_alias, $info);
}
}
}
}
/**
* Called to determine what to tell the clicksorter.
*/
function click_sort($order) {
if (isset($this->field_alias)) {
// Since fields should always have themselves already added, just
// add a sort on the field.
$this->query
->add_orderby(NULL, NULL, $order, $this->field_alias);
}
}
/**
* Determine if this field is click sortable.
*/
function click_sortable() {
return !empty($this->definition['click sortable']);
}
/**
* Get this field's label.
*/
function label() {
if (!isset($this->options['label'])) {
return '';
}
return $this->options['label'];
}
/**
* Return an HTML element based upon the field's element type.
*/
function element_type($none_supported = FALSE, $default_empty = FALSE, $inline = FALSE) {
if ($none_supported) {
if ($this->options['element_type'] === '0') {
return '';
}
}
if ($this->options['element_type']) {
return check_plain($this->options['element_type']);
}
if ($default_empty) {
return '';
}
if ($inline) {
return 'span';
}
if (isset($this->definition['element type'])) {
return $this->definition['element type'];
}
return 'span';
}
/**
* Return an HTML element for the label based upon the field's element type.
*/
function element_label_type($none_supported = FALSE, $default_empty = FALSE) {
if ($none_supported) {
if ($this->options['element_label_type'] === '0') {
return '';
}
}
if ($this->options['element_label_type']) {
return check_plain($this->options['element_label_type']);
}
if ($default_empty) {
return '';
}
return 'span';
}
/**
* Return an HTML element for the wrapper based upon the field's element type.
*/
function element_wrapper_type($none_supported = FALSE, $default_empty = FALSE) {
if ($none_supported) {
if ($this->options['element_wrapper_type'] === '0') {
return 0;
}
}
if ($this->options['element_wrapper_type']) {
return check_plain($this->options['element_wrapper_type']);
}
if ($default_empty) {
return '';
}
return 'div';
}
/**
* Provide a list of elements valid for field HTML.
*
* This function can be overridden by fields that want more or fewer
* elements available, though this seems like it would be an incredibly
* rare occurence.
*/
function get_elements() {
static $elements = NULL;
if (!isset($elements)) {
$elements = variable_get('views_field_rewrite_elements', array(
'' => t('- Use default -'),
'0' => t('- None -'),
'div' => 'DIV',
'span' => 'SPAN',
'h1' => 'H1',
'h2' => 'H2',
'h3' => 'H3',
'h4' => 'H4',
'h5' => 'H5',
'h6' => 'H6',
'p' => 'P',
'strong' => 'STRONG',
'em' => 'EM',
));
}
return $elements;
}
/**
* Return the class of the field.
*/
function element_classes($row_index = NULL) {
$classes = $this
->tokenize_value($this->options['element_class'], $row_index);
return views_css_safe($classes);
}
/**
* Replace a value with tokens from the last field.
*
* This function actually figures out which field was last and uses its
* tokens so they will all be available.
*/
function tokenize_value($value, $row_index = NULL) {
if (strpos($value, '[') !== FALSE || strpos($value, '!') !== FALSE || strpos($value, '%') !== FALSE) {
$fake_item = array(
'alter_text' => TRUE,
'text' => $value,
);
// Use isset() because empty() will trigger on 0 and 0 is
// the first row.
if (isset($row_index) && isset($this->view->style_plugin->render_tokens[$row_index])) {
$tokens = $this->view->style_plugin->render_tokens[$row_index];
}
else {
// Get tokens from the last field.
$last_field = end($this->view->field);
if (isset($last_field->last_tokens)) {
$tokens = $last_field->last_tokens;
}
else {
$tokens = $last_field
->get_render_tokens($fake_item);
}
}
$value = strip_tags($this
->render_altered($fake_item, $tokens));
if (!empty($this->options['alter']['trim_whitespace'])) {
$value = trim($value);
}
}
return $value;
}
/**
* Return the class of the field's label.
*/
function element_label_classes($row_index = NULL) {
$classes = $this
->tokenize_value($this->options['element_label_class'], $row_index);
return views_css_safe($classes);
}
/**
* Return the class of the field's wrapper.
*/
function element_wrapper_classes($row_index = NULL) {
$classes = $this
->tokenize_value($this->options['element_wrapper_class'], $row_index);
return views_css_safe($classes);
}
/**
* 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.
*/
function get_value($values, $field = NULL) {
$alias = isset($field) ? $this->aliases[$field] : $this->field_alias;
if (isset($values->{$alias})) {
return $values->{$alias};
}
}
function option_definition() {
$options = parent::option_definition();
$options['label'] = array(
'default' => $this->definition['title'],
'translatable' => TRUE,
);
$options['exclude'] = array(
'default' => FALSE,
'bool' => TRUE,
);
$options['alter'] = array(
'contains' => array(
'alter_text' => array(
'default' => FALSE,
),
'text' => array(
'default' => '',
'translatable' => TRUE,
),
'make_link' => array(
'default' => FALSE,
),
'path' => array(
'default' => '',
'translatable' => TRUE,
),
'absolute' => array(
'default' => '',
'translatable' => FALSE,
),
'external' => array(
'default' => '',
'translatable' => FALSE,
),
'replace_spaces' => array(
'default' => '',
'translatable' => FALSE,
),
'trim_whitespace' => array(
'default' => FALSE,
),
'alt' => array(
'default' => '',
'translatable' => TRUE,
),
'rel' => array(
'default' => '',
),
'link_class' => array(
'default' => '',
),
'prefix' => array(
'default' => '',
'translatable' => TRUE,
),
'suffix' => array(
'default' => '',
'translatable' => TRUE,
),
'target' => array(
'default' => '',
'translatable' => TRUE,
),
'nl2br' => array(
'default' => FALSE,
),
'max_length' => array(
'default' => '',
),
'word_boundary' => array(
'default' => TRUE,
),
'ellipsis' => array(
'default' => TRUE,
),
'strip_tags' => array(
'default' => FALSE,
),
'trim' => array(
'default' => FALSE,
),
'preserve_tags' => array(
'default' => '',
),
'html' => array(
'default' => FALSE,
),
),
);
$options['element_type'] = array(
'default' => '',
);
$options['element_class'] = array(
'default' => '',
);
$options['element_label_type'] = array(
'default' => '',
);
$options['element_label_class'] = array(
'default' => '',
);
$options['element_label_colon'] = array(
'default' => TRUE,
);
$options['element_wrapper_type'] = array(
'default' => '',
);
$options['element_wrapper_class'] = array(
'default' => '',
);
$options['element_default_classes'] = array(
'default' => TRUE,
);
$options['empty'] = array(
'default' => '',
'translatable' => TRUE,
);
$options['hide_empty'] = array(
'default' => FALSE,
);
$options['empty_zero'] = array(
'default' => FALSE,
);
$options['hide_alter_empty'] = array(
'default' => TRUE,
);
return $options;
}
/**
* Default options form that provides the label widget that all fields
* should have.
*/
function options_form(&$form, &$form_state) {
parent::options_form($form, $form_state);
// Use prefix and suffix to fake a fieldset because we use #tree.
$form['style_prefix'] = array(
'#value' => '<fieldset id="views-validator-options"><legend>' . t('Style settings') . '</legend>',
);
$form['exclude'] = array(
'#type' => 'checkbox',
'#title' => t('Exclude from display'),
'#default_value' => $this->options['exclude'],
'#description' => t('Check this box to not display this field, but still load it in the view. Use this option to not show a grouping field in each record, or when doing advanced theming, or when you want to use this field as a token in other fields.'),
);
$form['element_type'] = array(
'#title' => t('HTML element'),
'#options' => $this
->get_elements(),
'#type' => 'select',
'#default_value' => $this->options['element_type'],
'#description' => t('Most styles provide wrappers for fields. If the chosen style supports wrappers, wrap the field in this HTML element. The default will usually be either DIV or SPAN.'),
);
$form['element_class'] = array(
'#title' => t('Element class'),
'#description' => t('The class to provide on the wrapper element. You may enter data from this view as per the "Replacement patterns" used in "Rewrite the output of this field".'),
'#type' => 'textfield',
'#default_value' => $this->options['element_class'],
);
$form['label'] = array(
'#type' => 'textfield',
'#title' => t('Label'),
'#default_value' => isset($this->options['label']) ? $this->options['label'] : '',
'#description' => t('The label for this field that will be displayed to end users if the style requires it.'),
);
$form['element_label_type'] = array(
'#title' => t('Label HTML element'),
'#options' => $this
->get_elements(FALSE),
'#type' => 'select',
'#default_value' => $this->options['element_label_type'],
'#description' => t('What HTML Element type to use to wrap the label.'),
);
$form['element_label_class'] = array(
'#title' => t('Label class'),
'#description' => t('The class to provide on the label wrapper element.'),
'#type' => 'textfield',
'#default_value' => $this->options['element_label_class'],
);
$form['element_label_colon'] = array(
'#type' => 'checkbox',
'#title' => t('Place a colon after the label'),
'#default_value' => $this->options['element_label_colon'],
'#description' => t('If the label is to be inline with the value, place a colon between them. Not valid for styles such as table where the label is not placed with the value.'),
);
$form['element_wrapper_type'] = array(
'#title' => t('Wrapper HTML element'),
'#options' => $this
->get_elements(FALSE),
'#type' => 'select',
'#default_value' => $this->options['element_wrapper_type'],
'#description' => t('What HTML Element type to use to wrap the field (and the label). This is not supported by some styles such as tables.'),
);
$form['element_wrapper_class'] = array(
'#title' => t('Wrapper class'),
'#description' => t('The class to provide on the wrapper element.'),
'#type' => 'textfield',
'#default_value' => $this->options['element_wrapper_class'],
);
$form['element_default_classes'] = array(
'#type' => 'checkbox',
'#title' => t('Add default classes'),
'#default_value' => $this->options['element_default_classes'],
'#description' => t('Use default Views classes to identify the field, field label and field content.'),
);
$form['style_suffix'] = array(
'#value' => '</fieldset>',
);
$form['alter'] = array(
'#title' => t('Rewriting'),
'#type' => 'fieldset',
);
if ($this
->allow_advanced_render()) {
$form['alter']['#tree'] = TRUE;
$form['alter']['alter_text'] = array(
'#type' => 'checkbox',
'#title' => t('Rewrite the output of this field'),
'#description' => t('If checked, you can alter the output of this field by specifying a string of text with replacement tokens that can use any existing field output.'),
'#default_value' => $this->options['alter']['alter_text'],
);
$form['alter']['text'] = array(
'#title' => t('Text'),
'#type' => 'textarea',
'#default_value' => $this->options['alter']['text'],
'#description' => t('The text to display for this field. You may include HTML. You may enter data from this view as per the "Replacement patterns" below.'),
'#process' => array(
'views_process_dependency',
),
'#dependency' => array(
'edit-options-alter-alter-text' => array(
1,
),
),
);
$form['alter']['make_link'] = array(
'#type' => 'checkbox',
'#title' => t('Output this field as a link'),
'#description' => t('If checked, this field will be made into a link. The destination must be given below.'),
'#default_value' => $this->options['alter']['make_link'],
);
$form['alter']['path'] = array(
'#title' => t('Link path'),
'#type' => 'textfield',
'#default_value' => $this->options['alter']['path'],
'#description' => t('The Drupal path or absolute URL for this link. You may enter data from this view as per the "Replacement patterns" below.'),
'#process' => array(
'views_process_dependency',
),
'#dependency' => array(
'edit-options-alter-make-link' => array(
1,
),
),
'#maxlength' => 255,
);
$form['alter']['absolute'] = array(
'#type' => 'checkbox',
'#title' => t('Use absolute path'),
'#default_value' => $this->options['alter']['absolute'],
'#process' => array(
'views_process_dependency',
),
'#dependency' => array(
'edit-options-alter-make-link' => array(
1,
),
),
);
$form['alter']['replace_spaces'] = array(
'#type' => 'checkbox',
'#title' => t('Replace spaces with dashes'),
'#default_value' => $this->options['alter']['replace_spaces'],
'#process' => array(
'views_process_dependency',
),
'#dependency' => array(
'edit-options-alter-make-link' => array(
1,
),
),
);
$form['alter']['external'] = array(
'#type' => 'checkbox',
'#title' => t('External server URL'),
'#default_value' => $this->options['alter']['external'],
'#description' => t("Links to an external server using a full URL: e.g. 'http://www.example.com' or 'www.example.com'."),
'#process' => array(
'views_process_dependency',
),
'#dependency' => array(
'edit-options-alter-make-link' => array(
1,
),
),
);
$form['alter']['link_class'] = array(
'#title' => t('Link class'),
'#type' => 'textfield',
'#default_value' => $this->options['alter']['link_class'],
'#description' => t('The CSS class to apply to the link.'),
'#process' => array(
'views_process_dependency',
),
'#dependency' => array(
'edit-options-alter-make-link' => array(
1,
),
),
);
$form['alter']['alt'] = array(
'#title' => t('Title text'),
'#type' => 'textfield',
'#default_value' => $this->options['alter']['alt'],
'#description' => t('Text to place as "title" text which most browsers display as a tooltip when hovering over the link.'),
'#process' => array(
'views_process_dependency',
),
'#dependency' => array(
'edit-options-alter-make-link' => array(
1,
),
),
);
$form['alter']['rel'] = array(
'#title' => t('Rel Text'),
'#type' => 'textfield',
'#default_value' => $this->options['alter']['rel'],
'#description' => t('Include Rel attribute for use in lightbox2 or other javascript utility.'),
'#process' => array(
'views_process_dependency',
),
'#dependency' => array(
'edit-options-alter-make-link' => array(
1,
),
),
);
$form['alter']['prefix'] = array(
'#title' => t('Prefix text'),
'#type' => 'textfield',
'#default_value' => $this->options['alter']['prefix'],
'#description' => t('Any text to display before this link. You may include HTML.'),
'#process' => array(
'views_process_dependency',
),
'#dependency' => array(
'edit-options-alter-make-link' => array(
1,
),
),
);
$form['alter']['suffix'] = array(
'#title' => t('Suffix text'),
'#type' => 'textfield',
'#default_value' => $this->options['alter']['suffix'],
'#description' => t('Any text to display after this link. You may include HTML.'),
'#process' => array(
'views_process_dependency',
),
'#dependency' => array(
'edit-options-alter-make-link' => array(
1,
),
),
);
$form['alter']['target'] = array(
'#title' => t('Target'),
'#type' => 'textfield',
'#default_value' => $this->options['alter']['target'],
'#description' => t("Target of the link, such as _blank, _parent or an iframe's name. This field is rarely used."),
'#process' => array(
'views_process_dependency',
),
'#dependency' => array(
'edit-options-alter-make-link' => array(
1,
),
),
);
// Get a list of the available fields and arguments for token replacement.
$options = array();
foreach ($this->view->display_handler
->get_handlers('field') as $field => $handler) {
$options[t('Fields')]["[{$field}]"] = $handler
->ui_name();
// We only use fields up to (and including) this one.
if ($field == $this->options['id']) {
break;
}
}
$count = 0;
// This lets us prepare the key as we want it printed.
foreach ($this->view->display_handler
->get_handlers('argument') as $arg => $handler) {
$options[t('Arguments')]['%' . ++$count] = t('@argument title', array(
'@argument' => $handler
->ui_name(),
));
$options[t('Arguments')]['!' . $count] = t('@argument input', array(
'@argument' => $handler
->ui_name(),
));
}
$this
->document_self_tokens($options[t('Fields')]);
// Default text.
$output = t('<p>You must add some additional fields to this display before using this field. These fields may be marked as <em>Exclude from display</em> if you prefer. Note that due to rendering order, you cannot use fields that come after this field; if you need a field not listed here, rearrange your fields.</p>');
// We have some options, so make a list.
if (!empty($options)) {
$output = t('<p>The following tokens are available for this field. Note that due to rendering order, you cannot use fields that come after this field; if you need a field not listed here, rearrange your fields.
If you would like to have the characters %5B and %5D please use the html entity codes \'%5B\' or \'%5D\' or they will get replaced with empty space.</p>');
foreach (array_keys($options) as $type) {
if (!empty($options[$type])) {
$items = array();
foreach ($options[$type] as $key => $value) {
$items[] = $key . ' == ' . $value;
}
$output .= theme('item_list', $items, $type);
}
}
}
// This construct uses 'hidden' and not markup because process doesn't
// run. It also has an extra div because the dependency wants to hide
// the parent in situations like this, so we need a second div to
// make this work.
$form['alter']['help'] = array(
'#type' => 'hidden',
'#id' => 'views-tokens-help',
'#prefix' => '<div><fieldset id="views-tokens-help"><legend>' . t('Replacement patterns') . '</legend>' . $output . '</fieldset></div>',
'#process' => array(
'views_process_dependency',
),
'#dependency' => array(
'edit-options-alter-make-link' => array(
1,
),
'edit-options-alter-alter-text' => array(
1,
),
),
);
$form['alter']['trim'] = array(
'#type' => 'checkbox',
'#title' => t('Trim this field to a maximum length'),
'#description' => t('If checked, this field be trimmed to a maximum length in characters.'),
'#default_value' => $this->options['alter']['trim'],
);
$form['alter']['max_length'] = array(
'#title' => t('Maximum length'),
'#type' => 'textfield',
'#default_value' => $this->options['alter']['max_length'],
'#description' => t('The maximum number of characters this field can be.'),
'#process' => array(
'views_process_dependency',
),
'#dependency' => array(
'edit-options-alter-trim' => array(
1,
),
),
);
$form['alter']['word_boundary'] = array(
'#type' => 'checkbox',
'#title' => t('Trim only on a word boundary'),
'#description' => t('If checked, this field be trimmed only on a word boundary. This is guaranteed to be the maximum characters stated or less. If there are no word boundaries this could trim a field to nothing.'),
'#default_value' => $this->options['alter']['word_boundary'],
'#process' => array(
'views_process_dependency',
),
'#dependency' => array(
'edit-options-alter-trim' => array(
1,
),
),
);
$form['alter']['ellipsis'] = array(
'#type' => 'checkbox',
'#title' => t('Add an ellipsis'),
'#description' => t('If checked, a "..." will be added if a field was trimmed.'),
'#default_value' => $this->options['alter']['ellipsis'],
'#process' => array(
'views_process_dependency',
),
'#dependency' => array(
'edit-options-alter-trim' => array(
1,
),
),
);
$form['alter']['html'] = array(
'#type' => 'checkbox',
'#title' => t('Field can contain HTML'),
'#description' => t('If checked, HTML corrector will be run to ensure tags are properly closed after trimming.'),
'#default_value' => $this->options['alter']['html'],
'#process' => array(
'views_process_dependency',
),
'#dependency' => array(
'edit-options-alter-trim' => array(
1,
),
),
);
$form['alter']['strip_tags'] = array(
'#type' => 'checkbox',
'#title' => t('Strip HTML tags'),
'#description' => t('If checked, all HTML tags will be stripped.'),
'#default_value' => $this->options['alter']['strip_tags'],
);
$form['alter']['trim_whitespace'] = array(
'#type' => 'checkbox',
'#title' => t('Remove whitespace'),
'#description' => t('If checked, all whitespaces at the beginning and the end of the output will be removed.'),
'#default_value' => $this->options['alter']['trim_whitespace'],
);
$form['alter']['preserve_tags'] = array(
'#type' => 'textfield',
'#title' => t('Preserve certain tags'),
'#description' => t('List the tags that need to be preserved during the stripping process. example "<p> <br>" which will preserve all p and br elements'),
'#default_value' => $this->options['alter']['preserve_tags'],
'#dependency' => array(
'edit-options-alter-strip-tags' => array(
1,
),
),
'#process' => array(
'views_process_dependency',
),
);
$form['alter']['nl2br'] = array(
'#type' => 'checkbox',
'#title' => t('Convert newlines to HTML <br> tags'),
'#description' => t('If checked, all newlines chars (e.g. \\n) are converted into HTML <br> tags.'),
'#default_value' => $this->options['alter']['nl2br'],
'#process' => array(
'views_process_dependency',
),
);
}
// Use prefix and suffix to fake a fieldset because we use #tree.
$form['empty_prefix'] = array(
'#value' => '<fieldset id="views-validator-options"><legend>' . t('Empty field behavior') . '</legend>',
);
$form['empty'] = array(
'#type' => 'textarea',
'#title' => t('Empty text'),
'#default_value' => $this->options['empty'],
'#description' => t('Provide text to display if this field returns no results. You may include HTML. You may enter data from this view as per the "Replacement patterns" in the "Rewrite Results" section below.'),
);
$form['empty_zero'] = array(
'#type' => 'checkbox',
'#title' => t('Count the number 0 as empty'),
'#default_value' => $this->options['empty_zero'],
'#description' => t('If the field contains the number zero, display the empty text instead'),
);
$form['hide_empty'] = array(
'#type' => 'checkbox',
'#title' => t('Hide if empty'),
'#default_value' => $this->options['hide_empty'],
'#description' => t('Enable to hide this field if it is empty. Note that the field label or rewritten output may still be displayed. To hide labels, check the style or row style settings for empty fields. To hide rewritten content, check the "Hide rewriting if empty" checkbox.'),
'#fieldset' => 'empty_field_behavior',
);
$form['hide_alter_empty'] = array(
'#type' => 'checkbox',
'#title' => t('Hide rewriting if empty'),
'#default_value' => $this->options['hide_alter_empty'],
'#description' => t('Do not display rewritten content if this field is empty.'),
'#fieldset' => 'empty_field_behavior',
);
$form['empty_suffix'] = array(
'#value' => '</fieldset>',
);
}
/**
* Provide extra data to the administration form
*/
function admin_summary() {
return $this
->label();
}
/**
* Run before any fields are rendered.
*
* This gives the handlers some time to set up before any handler has
* been rendered.
*
* @param $values
* An array of all objects returned from the query.
*/
function pre_render($values) {
}
/**
* Render the field.
*
* @param $values
* The values retrieved from the database.
*/
function render($values) {
$value = $this
->get_value($values);
return $this
->sanitize_value($value);
}
/**
* Render a field using advanced settings.
*
* This renders a field normally, then decides if render-as-link and
* text-replacement rendering is necessary.
*/
function advanced_render($values) {
if ($this
->allow_advanced_render() && method_exists($this, 'render_item')) {
$raw_items = $this
->get_items($values);
}
else {
$this->last_render = $value = $this
->render($values);
$this->original_value = $value;
}
if ($this
->allow_advanced_render()) {
$tokens = NULL;
if (method_exists($this, 'render_item')) {
$items = array();
foreach ($raw_items as $count => $item) {
$this->last_render = $this
->render_item($count, $item);
$this->original_value = $this->last_render;
$alter = $item + $this->options['alter'];
$items[] = $this
->render_text($alter);
}
$value = $this
->render_items($items);
}
else {
$value = $this
->render_text($this->options['alter']);
}
// This happens here so that render_as_link can get the unaltered value of
// this field as a token rather than the altered value.
$this->last_render = $value;
}
if (empty($this->last_render)) {
if ($this->last_render !== 0 && $this->last_render !== '0' || !empty($this->options['empty_zero'])) {
$alter = $this->options['alter'];
$alter['alter_text'] = 1;
$alter['text'] = $this->options['empty'];
$this->last_render = $this
->render_text($alter);
}
}
return $this->last_render;
}
/**
* Perform an advanced text render for the item.
*
* This is separated out as some fields may render lists, and this allows
* each item to be handled individually.
*/
function render_text($alter) {
$value = $this->last_render;
if (!empty($alter['alter_text']) && $alter['text'] !== '') {
$tokens = $this
->get_render_tokens($alter);
$value = $this
->render_altered($alter, $tokens);
}
if (!empty($this->options['alter']['trim_whitespace'])) {
$value = trim($value);
}
// Check whether the value is empty and return nothing, so the field isn't rendered.
// First check whether the field should be hidden if the value(hide_alter_empty = TRUE) /the rewrite is empty (hide_alter_empty = FALSE).
// For numeric values you can specify whether "0"/0 should be empty.
if (($this->options['hide_empty'] && empty($value) || $this->options['hide_alter_empty'] && empty($this->original_value)) && ($value !== 0 && $value !== '0' || $this->options['empty_zero'])) {
return '';
}
if (!empty($alter['strip_tags'])) {
$value = strip_tags($value, $alter['preserve_tags']);
}
if (!empty($alter['trim']) && !empty($alter['max_length'])) {
$value = $this
->render_trim_text($alter, $value);
}
if (!empty($alter['nl2br'])) {
$value = nl2br($value);
}
if (!empty($alter['make_link']) && !empty($alter['path'])) {
if (!isset($tokens)) {
$tokens = $this
->get_render_tokens($alter);
}
$value = $this
->render_as_link($alter, $value, $tokens);
}
return $value;
}
/**
* Render this field as altered text, from a fieldset set by the user.
*/
function render_altered($alter, $tokens) {
// Filter this right away as our substitutions are already sanitized.
$value = filter_xss_admin($alter['text']);
$value = strtr($value, $tokens);
return $value;
}
/**
* Trim the field down to the specified length.
*/
function render_trim_text($alter, $value) {
if (!empty($alter['strip_tags'])) {
// NOTE: It's possible that some external fields might override the
// element type so if someone from, say, CCK runs into a bug here,
// this may be why =)
$this->definition['element type'] = 'span';
}
return views_trim_text($alter, $value);
}
/**
* Render this field as a link, with the info from a fieldset set by
* the user.
*/
function render_as_link($alter, $text, $tokens) {
$value = '';
if (!empty($alter['prefix'])) {
$value .= filter_xss_admin(strtr($alter['prefix'], $tokens));
}
$options = array(
'html' => TRUE,
'absolute' => !empty($alter['absolute']) ? TRUE : FALSE,
);
// $path will be run through check_url() by l() so we do not need to
// sanitize it ourselves.
$path = $alter['path'];
// html_entity_decode removes <front>, so check whether its different to front.
if ($path != '<front>') {
// Use strip tags as there should never be HTML in the path.
// However, we need to preserve special characters like " that
// were removed by check_plain().
$path = strip_tags(html_entity_decode(strtr($path, $tokens)));
if (!empty($alter['replace_spaces'])) {
$path = str_replace(' ', '-', $path);
}
}
// Parse the URL and move any query and fragment parameters out of the path.
$url = parse_url($path);
// Seriously malformed URLs may return FALSE or empty arrays.
if (empty($url)) {
return $text;
}
// If the path is empty do not build a link around the given text and return
// it as is.
// http://www.example.com URLs will not have a $url['path'], so check host as well.
if (empty($url['path']) && empty($url['host']) && empty($url['fragment'])) {
return $text;
}
// If no scheme is provided in the $path, assign the default 'http://'.
// This allows a url of 'www.example.com' to be converted to 'http://www.example.com'.
// Only do this on for external URLs.
if ($alter['external']) {
if (!isset($url['scheme'])) {
// There is no scheme, add the default 'http://' to the $path.
$path = "http://{$path}";
// Reset the $url array to include the new scheme.
$url = parse_url($path);
}
}
if (isset($url['query'])) {
$path = strtr($path, array(
'?' . $url['query'] => '',
));
$options['query'] = $url['query'];
}
if (isset($url['fragment'])) {
$path = strtr($path, array(
'#' . $url['fragment'] => '',
));
// If the path is empty we want to have a fragment for the current site.
if ($path == '') {
$options['external'] = TRUE;
}
$options['fragment'] = $url['fragment'];
}
$alt = strtr($alter['alt'], $tokens);
// Set the title attribute of the link only if it improves accessibility
if ($alt && $alt != $text) {
$options['attributes']['title'] = html_entity_decode($alt, ENT_QUOTES);
}
$class = strtr($alter['link_class'], $tokens);
if ($class) {
$options['attributes']['class'] = $class;
}
if (!empty($alter['rel']) && ($rel = strtr($alter['rel'], $tokens))) {
$options['attributes']['rel'] = $rel;
}
$target = check_plain(trim(strtr($alter['target'], $tokens)));
if (!empty($target)) {
$options['attributes']['target'] = $target;
}
// Allow the addition of arbitrary attributes to links. Additional attributes
// currently can only be altered in preprocessors and not within the UI.
if (isset($alter['link_attributes']) && is_array($alter['link_attributes'])) {
foreach ($alter['link_attributes'] as $key => $attribute) {
if (!isset($options['attributes'][$key])) {
$options['attributes'][$key] = strtr($attribute, $tokens);
}
}
}
// If the query and fragment were programatically assigned overwrite any
// parsed values.
if (isset($alter['query'])) {
$options['query'] = strtr($alter['query'], $tokens);
}
if (isset($alter['alias'])) {
// Alias is a boolean field, so no token.
$options['alias'] = $alter['alias'];
}
if (isset($alter['fragment'])) {
$options['fragment'] = strtr($alter['fragment'], $tokens);
}
if (isset($this->options['alter']['language'])) {
$options['language'] = $this->options['alter']['language'];
}
$value .= l($text, $path, $options);
if (!empty($alter['suffix'])) {
$value .= filter_xss_admin(strtr($alter['suffix'], $tokens));
}
return $value;
}
/**
* Get the 'render' tokens to use for advanced rendering.
*
* This runs through all of the fields and arguments that
* are available and gets their values. This will then be
* used in one giant str_replace().
*/
function get_render_tokens($item) {
$tokens = array();
if (!empty($this->view->build_info['substitutions'])) {
$tokens = $this->view->build_info['substitutions'];
}
$count = 0;
foreach ($this->view->display_handler
->get_handlers('argument') as $arg => $handler) {
$token = '%' . ++$count;
if (!isset($tokens[$token])) {
$tokens[$token] = '';
}
// Use strip tags as there should never be HTML in the path.
// However, we need to preserve special characters like " that
// were removed by check_plain().
$tokens['!' . $count] = isset($this->view->args[$count - 1]) ? strip_tags(html_entity_decode($this->view->args[$count - 1])) : '';
}
// Now add replacements for our fields.
foreach ($this->view->display_handler
->get_handlers('field') as $field => $handler) {
if (isset($handler->last_render)) {
$tokens["[{$field}]"] = $handler->last_render;
}
else {
$tokens["[{$field}]"] = '';
}
$this
->add_self_tokens($tokens, $item);
// We only use fields up to (and including) this one.
if ($field == $this->options['id']) {
break;
}
}
// Store the tokens for the row so we can reference them later if necessary.
$this->view->style_plugin->render_tokens[$this->view->row_index] = $tokens;
$this->last_tokens = $tokens;
return $tokens;
}
/**
* Add any special tokens this field might use for itself.
*
* This method is intended to be overridden by items that generate
* fields as a list. For example, the field that displays all terms
* on a node might have tokens for the tid and the term.
*
* By convention, tokens should follow the format of [token-subtoken]
* where token is the field ID and subtoken is the field. If the
* field ID is terms, then the tokens might be [terms-tid] and [terms-name].
*/
function add_self_tokens(&$tokens, $item) {
}
/**
* Document any special tokens this field might use for itself.
*
* @see add_self_tokens() for details.
*/
function document_self_tokens(&$tokens) {
}
/**
* Call out to the theme() function, which probably just calls render() but
* allows sites to override output fairly easily.
*/
function theme($values) {
return theme($this
->theme_functions(), $this->view, $this, $values);
}
function theme_functions() {
$themes = array();
$hook = 'views_view_field';
$display = $this->view->display[$this->view->current_display];
if (!empty($display)) {
$themes[] = $hook . '__' . $this->view->name . '__' . $display->id . '__' . $this->options['id'];
$themes[] = $hook . '__' . $this->view->name . '__' . $display->id;
$themes[] = $hook . '__' . $display->id . '__' . $this->options['id'];
$themes[] = $hook . '__' . $display->id;
if ($display->id != $display->display_plugin) {
$themes[] = $hook . '__' . $this->view->name . '__' . $display->display_plugin . '__' . $this->options['id'];
$themes[] = $hook . '__' . $this->view->name . '__' . $display->display_plugin;
$themes[] = $hook . '__' . $display->display_plugin . '__' . $this->options['id'];
$themes[] = $hook . '__' . $display->display_plugin;
}
}
$themes[] = $hook . '__' . $this->view->name . '__' . $this->options['id'];
$themes[] = $hook . '__' . $this->view->name;
$themes[] = $hook . '__' . $this->options['id'];
$themes[] = $hook;
return $themes;
}
}Members
Name |
Modifiers | Type | Description | Overrides |
|---|---|---|---|---|
|
views_handler:: |
property | The type of the handler, for example filter/footer/field. | ||
|
views_handler:: |
property | Where the $query object will reside: | 6 | |
|
views_handler:: |
property |
The top object of a view. Overrides views_object:: |
||
|
views_handler:: |
function | Take input from exposed handlers and assign to this handler, if necessary. | 1 | |
|
views_handler:: |
function | Check whether current user has access to this handler. | 6 | |
|
views_handler:: |
function | Determine if the handler is considered 'broken', meaning it's a a placeholder used when a handler can't be found. | 6 | |
|
views_handler:: |
function | Determine if a handler can be exposed. | 2 | |
|
views_handler:: |
function | Ensure the main table for this handler is in the query. This is used a lot. | 8 | |
|
views_handler:: |
function | Render our chunk of the exposed handler form when selecting | 2 | |
|
views_handler:: |
function | Get information about the exposed form for the form renderer. | 1 | |
|
views_handler:: |
function | Submit the exposed handler form | ||
|
views_handler:: |
function | Validate the exposed handler form | 4 | |
|
views_handler:: |
function | Overridable form for exposed handler options. | ||
|
views_handler:: |
function | 2 | ||
|
views_handler:: |
function | 2 | ||
|
views_handler:: |
function | Set new exposed option defaults when exposed setting is flipped on. | 2 | |
|
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 | Validate the options form. | 1 | |
|
views_handler:: |
function | Provide defaults for the handler. | ||
|
views_handler:: |
function | Provide a form for setting options. | 1 | |
|
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 | Validate the options form. | ||
|
views_handler:: |
function | Shortcut to get a handler's raw field value. | ||
|
views_handler:: |
function | Get the join object that should be used for this handler. | ||
|
views_handler:: |
function | If a handler has 'extra options' it will get a little settings widget and another form called extra_options. | 1 | |
|
views_handler:: |
function | Determine if this item is 'exposed', meaning it provides form elements to let users modify the view. | ||
|
views_handler:: |
function | Determine if the argument needs a style plugin. | 1 | |
|
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. | 4 | |
|
views_handler:: |
function | Validate the options form. | 4 | |
|
views_handler:: |
function | Run before the view is built. | 1 | |
|
views_handler:: |
function | Sanitize the value for output. | ||
|
views_handler:: |
function | Called just prior to query(), this lets a handler set up any relationship it needs. | ||
|
views_handler:: |
function | Shortcut to display the expose/hide button. | ||
|
views_handler:: |
function | Shortcut to display the exposed options form. | ||
|
views_handler:: |
function | If set to remember exposed input in the session, store it there. | 1 | |
|
views_handler:: |
function | Return a string representing this handler's name in the UI. | 10 | |
|
views_handler:: |
function | Provides the handler some groupby. | 2 | |
|
views_handler:: |
function | Validates the handler against the complete View. | 1 | |
|
views_handler_field:: |
property | Stores additional fields which get's added to the query. The generated aliases are stored in $aliases. | ||
|
views_handler_field:: |
property | |||
|
views_handler_field:: |
property | |||
|
views_handler_field:: |
function | Add 'additional' fields to the query. | ||
|
views_handler_field:: |
function | Add any special tokens this field might use for itself. | 4 | |
|
views_handler_field:: |
function |
Provide extra data to the administration form Overrides views_handler:: |
||
|
views_handler_field:: |
function | Render a field using advanced settings. | ||
|
views_handler_field:: |
function | Determine if this field can allow advanced rendering. | 1 | |
|
views_handler_field:: |
function | Called to determine what to tell the clicksorter. | 1 | |
|
views_handler_field:: |
function | Determine if this field is click sortable. | ||
|
views_handler_field:: |
function |
Construct a new field handler. Overrides views_object:: |
18 | |
|
views_handler_field:: |
function | Document any special tokens this field might use for itself. | 4 | |
|
views_handler_field:: |
function | Return the class of the field. | ||
|
views_handler_field:: |
function | Return the class of the field's label. | ||
|
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 based upon the field's element type. | 2 | |
|
views_handler_field:: |
function | Return the class of the field's wrapper. | ||
|
views_handler_field:: |
function | Return an HTML element for the wrapper based upon the field's element type. | ||
|
views_handler_field:: |
function | Provide a list of elements valid for field HTML. | ||
|
views_handler_field:: |
function | Get the 'render' tokens to use for advanced rendering. | ||
|
views_handler_field:: |
function | Get the value that's supposed to be rendered. | ||
|
views_handler_field:: |
function |
init the handler with necessary data. Overrides views_handler:: |
11 | |
|
views_handler_field:: |
function | Get this field's label. | ||
|
views_handler_field:: |
function |
Default options form that provides the label widget that all fields
should have. Overrides views_handler:: |
30 | |
|
views_handler_field:: |
function |
Information about options for all kinds of purposes will be held here. Overrides views_handler:: |
30 | |
|
views_handler_field:: |
function | Run before any fields are rendered. | 6 | |
|
views_handler_field:: |
function |
Called to add the field to a query. Overrides views_handler:: |
21 | |
|
views_handler_field:: |
function | Render the field. | 40 | |
|
views_handler_field:: |
function | Render this field as altered text, from a fieldset set by the user. | ||
|
views_handler_field:: |
function | Render this field as a link, with the info from a fieldset set by the user. | ||
|
views_handler_field:: |
function | Perform an advanced text render for the item. | ||
|
views_handler_field:: |
function | Trim the field down to the specified length. | ||
|
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_field:: |
function | |||
|
views_handler_field:: |
function | Replace a value with tokens from the last field. | ||
|
views_object:: |
property | Handler's definition | ||
|
views_object:: |
property | Except for displays, options for the object will be held here. | 1 | |
|
views_object:: |
function | 2 | ||
|
views_object:: |
function | 1 | ||
|
views_object:: |
function | |||
|
views_object:: |
function | Set default options on this object. Called by the constructor in a complex chain to deal with backward compatibility. | 1 | |
|
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 | Let the handler know what its full definition is. | ||
|
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 | Unpack a single option definition. | ||
|
views_object:: |
function | Unpacks each handler to store translatable texts. | ||
|
views_object:: |
function |