Definition of views_handler_field_field.
View source
<?php
function _field_view_formatter_options($field_type = NULL) {
$options =& drupal_static(__FUNCTION__);
if (!isset($options)) {
$field_types = field_info_field_types();
$options = array();
foreach (field_info_formatter_types() as $name => $formatter) {
foreach ($formatter['field types'] as $formatter_field_type) {
if (isset($field_types[$formatter_field_type])) {
$options[$formatter_field_type][$name] = $formatter['label'];
}
}
}
}
if ($field_type) {
return !empty($options[$field_type]) ? $options[$field_type] : array();
}
return $options;
}
class views_handler_field_field extends views_handler_field {
public $items = array();
public $field_info = array();
public $multiple;
public $limit_values;
public $base_table;
public $instance;
public function init(&$view, &$options) {
parent::init($view, $options);
$this->field_info = $field = field_info_field($this->definition['field_name']);
$this->multiple = FALSE;
$this->limit_values = FALSE;
if ($field['cardinality'] > 1 || $field['cardinality'] == FIELD_CARDINALITY_UNLIMITED) {
$this->multiple = TRUE;
if (!$this->options['group_rows']) {
$this->limit_values = TRUE;
}
if (!empty($this->options['delta_first_last'])) {
$this->limit_values = TRUE;
}
if (intval($this->options['delta_limit']) && $this->options['delta_limit'] != $field['cardinality'] || intval($this->options['delta_offset'])) {
$this->limit_values = TRUE;
}
}
if ($this->options['group_column'] == 'entity id') {
$this->options['group_column'] = 'entity_id';
}
}
public function access() {
$base_table = $this
->get_base_table();
return isset($this->definition['entity_tables'][$base_table]) && field_access('view', $this->field_info, $this->definition['entity_tables'][$base_table]);
}
public function get_base_table() {
if (!isset($this->base_table)) {
$this->base_table = $this->view->base_table;
if (!empty($this->options['relationship']) && $this->options['relationship'] != 'none') {
$relationships = $this->view->display_handler
->get_option('relationships');
if (!empty($relationships[$this->options['relationship']])) {
$options = $relationships[$this->options['relationship']];
$data = views_fetch_data($options['table']);
$this->base_table = $data[$options['field']]['relationship']['base'];
}
}
}
return $this->base_table;
}
public function query($use_groupby = FALSE) {
$this
->get_base_table();
$params = array();
if ($use_groupby) {
$params = array(
'function' => 'min',
);
$this
->ensure_my_table();
}
$entity_type = $this->definition['entity_tables'][$this->base_table];
$entity_info = entity_get_info($entity_type);
if (isset($this->relationship)) {
$this->base_table_alias = $this->relationship;
}
else {
$this->base_table_alias = $this->base_table;
}
if (empty($this->definition['is revision'])) {
$this->field_alias = $this->query
->add_field($this->base_table_alias, $entity_info['entity keys']['id'], '', $params);
}
else {
$this->field_alias = $this->query
->add_field($this->base_table_alias, $entity_info['entity keys']['revision'], '', $params);
$this->aliases['entity_id'] = $this->query
->add_field($this->base_table_alias, $entity_info['entity keys']['id'], '', $params);
}
$entity_type_alias = $this->definition['table'] . '_' . $entity_type . '_entity_type';
$this->aliases['entity_type'] = $this->query
->add_field(NULL, "'{$entity_type}'", $entity_type_alias);
$fields = $this->additional_fields;
$entity_type_key = array_search('entity_type', $fields);
if ($entity_type_key !== FALSE) {
unset($fields[$entity_type_key]);
}
if ($use_groupby) {
$options = array();
if ($this->options['group_column'] != 'entity_id') {
$options = array(
$this->options['group_column'] => $this->options['group_column'],
);
}
$options += is_array($this->options['group_columns']) ? $this->options['group_columns'] : array();
$fields = array();
$rkey = $this->definition['is revision'] ? 'FIELD_LOAD_REVISION' : 'FIELD_LOAD_CURRENT';
foreach ($options as $column) {
$name = $column;
if (isset($this->field_info['storage']['details']['sql'][$rkey][$this->table][$column])) {
$name = $this->field_info['storage']['details']['sql'][$rkey][$this->table][$column];
}
$fields[$column] = $name;
}
$this->group_fields = $fields;
}
if ($this
->add_field_table($use_groupby)) {
$this
->ensure_my_table();
$this
->add_additional_fields($fields);
$field = $this->field_info;
if (field_is_translatable($entity_type, $field) && !empty($this->view->display_handler->options['field_language_add_to_query'])) {
$column = $this->table_alias . '.language';
global $language_content;
$default_language = language_default('language');
$language = str_replace(array(
'***CURRENT_LANGUAGE***',
'***DEFAULT_LANGUAGE***',
), array(
$language_content->language,
$default_language,
), $this->view->display_handler->options['field_language']);
$placeholder = $this
->placeholder();
$language_fallback_candidates = array(
$language,
);
if (variable_get('locale_field_language_fallback', TRUE)) {
require_once DRUPAL_ROOT . '/includes/language.inc';
$language_fallback_candidates = array_merge($language_fallback_candidates, language_fallback_get_candidates());
}
else {
$language_fallback_candidates[] = LANGUAGE_NONE;
}
$this->query
->add_where_expression(0, "{$column} IN({$placeholder}) OR {$column} IS NULL", array(
$placeholder => $language_fallback_candidates,
));
}
}
if ($use_groupby || empty($this->definition['add fields to query'])) {
return;
}
$this
->add_additional_fields(array(
'revision_id',
));
}
public function add_field_table($use_groupby) {
if ($use_groupby || !empty($this->definition['add fields to query'])) {
return TRUE;
}
if ($this->multiple && !$this->options['group_rows']) {
return TRUE;
}
return FALSE;
}
public function click_sortable() {
if (empty($this->definition['click sortable'])) {
return FALSE;
}
if ($this->multiple && $this->options['group_rows']) {
return FALSE;
}
return TRUE;
}
public function click_sort($order) {
if (empty($this->options['click_sort_column'])) {
return;
}
$this
->ensure_my_table();
$column = _field_sql_storage_columnname($this->definition['field_name'], $this->options['click_sort_column']);
if (!isset($this->aliases[$column])) {
$this->aliases[$column] = $this->table_alias . '.' . $column;
}
$this->query
->add_orderby(NULL, NULL, $order, $this->aliases[$column]);
}
public function option_definition() {
$options = parent::option_definition();
$field = field_info_field($this->definition['field_name']);
$field_type = field_info_field_types($field['type']);
$column_names = array_keys($field['columns']);
$default_column = '';
if (count($column_names) == 1) {
$default_column = $column_names[0];
}
elseif (in_array('value', $column_names)) {
$default_column = 'value';
}
$options['click_sort_column'] = array(
'default' => $default_column,
);
$options['type'] = array(
'default' => $field_type['default_formatter'],
);
$options['settings'] = array(
'default' => array(),
);
$options['group_column'] = array(
'default' => $default_column,
);
$options['group_columns'] = array(
'default' => array(),
);
$options['group_rows'] = array(
'default' => TRUE,
'bool' => TRUE,
);
$options['delta_limit'] = array(
'default' => $field['cardinality'] > 1 ? $field['cardinality'] : 'all',
);
$options['delta_offset'] = array(
'default' => 0,
);
$options['delta_reversed'] = array(
'default' => FALSE,
'bool' => TRUE,
);
$options['delta_first_last'] = array(
'default' => FALSE,
'bool' => TRUE,
);
$options['delta_random'] = array(
'default' => FALSE,
'bool' => TRUE,
);
$options['multi_type'] = array(
'default' => 'separator',
);
$options['separator'] = array(
'default' => ', ',
);
$options['field_api_classes'] = array(
'default' => FALSE,
'bool' => TRUE,
);
return $options;
}
public function options_form(&$form, &$form_state) {
parent::options_form($form, $form_state);
$field = $this->field_info;
$formatters = _field_view_formatter_options($field['type']);
$column_names = array_keys($field['columns']);
if ($this->multiple) {
$this
->multiple_options_form($form, $form_state);
}
if (count($field['columns']) == 1) {
$form['click_sort_column'] = array(
'#type' => 'value',
'#value' => isset($column_names[0]) ? $column_names[0] : '',
);
}
else {
$form['click_sort_column'] = array(
'#type' => 'select',
'#title' => t('Column used for click sorting'),
'#options' => drupal_map_assoc($column_names),
'#default_value' => $this->options['click_sort_column'],
'#description' => t('Used by Style: Table to determine the actual column to click sort the field on. The default is usually fine.'),
'#fieldset' => 'more',
);
}
$form['type'] = array(
'#type' => 'select',
'#title' => t('Formatter'),
'#options' => $formatters,
'#default_value' => $this->options['type'],
'#ajax' => array(
'path' => views_ui_build_form_url($form_state),
),
'#submit' => array(
'views_ui_config_item_form_submit_temporary',
),
'#executes_submit_callback' => TRUE,
);
$form['field_api_classes'] = array(
'#title' => t('Use field template'),
'#type' => 'checkbox',
'#default_value' => $this->options['field_api_classes'],
'#description' => t('If checked, field api classes will be added using field.tpl.php (or equivalent). This is not recommended unless your CSS depends upon these classes. If not checked, template will not be used.'),
'#fieldset' => 'style_settings',
'#weight' => 20,
);
if ($this->multiple) {
$form['field_api_classes']['#description'] .= ' ' . t('Checking this option will cause the group Display Type and Separator values to be ignored.');
}
$format = $this->options['type'];
$formatter = field_info_formatter_types($format);
$settings = $this->options['settings'] + field_info_formatter_settings($format);
ctools_include('fields');
$this->instance = ctools_fields_fake_field_instance($this->definition['field_name'], '_custom', $formatter, $settings);
$this->instance['display']['_custom'] = array(
'type' => $format,
'settings' => $settings,
);
$settings_form = array(
'#value' => array(),
);
$function = $formatter['module'] . '_field_formatter_settings_form';
if (function_exists($function)) {
$settings_form = $function($field, $this->instance, '_custom', $form, $form_state);
}
$form['settings'] = $settings_form;
}
public function multiple_options_form(&$form, &$form_state) {
$field = $this->field_info;
$form['multiple_field_settings'] = array(
'#type' => 'fieldset',
'#title' => t('Multiple field settings'),
'#collapsible' => TRUE,
'#collapsed' => TRUE,
'#weight' => 5,
);
$form['group_rows'] = array(
'#title' => t('Display all values in the same row'),
'#type' => 'checkbox',
'#default_value' => $this->options['group_rows'],
'#description' => t('If checked, multiple values for this field will be shown in the same row. If not checked, each value in this field will create a new row. If using group by, please make sure to group by "Entity ID" for this setting to have any effect.'),
'#fieldset' => 'multiple_field_settings',
);
list($prefix, $suffix) = explode('@count', t('Display @count value(s)'));
if ($field['cardinality'] == FIELD_CARDINALITY_UNLIMITED) {
$type = 'textfield';
$options = NULL;
$size = 5;
}
else {
$type = 'select';
$options = drupal_map_assoc(range(1, $field['cardinality']));
$size = 1;
}
$form['multi_type'] = array(
'#type' => 'radios',
'#title' => t('Display type'),
'#options' => array(
'ul' => t('Unordered list'),
'ol' => t('Ordered list'),
'separator' => t('Simple separator'),
'count' => t('Count'),
),
'#dependency' => array(
'edit-options-group-rows' => array(
TRUE,
),
),
'#default_value' => $this->options['multi_type'],
'#fieldset' => 'multiple_field_settings',
);
$form['separator'] = array(
'#type' => 'textfield',
'#title' => t('Separator'),
'#default_value' => $this->options['separator'],
'#dependency' => array(
'radio:options[multi_type]' => array(
'separator',
),
'edit-options-group-rows' => array(
TRUE,
),
),
'#dependency_count' => 2,
'#fieldset' => 'multiple_field_settings',
);
$form['delta_limit'] = array(
'#type' => $type,
'#size' => $size,
'#field_prefix' => $prefix,
'#field_suffix' => $suffix,
'#options' => $options,
'#default_value' => $this->options['delta_limit'],
'#prefix' => '<div class="container-inline">',
'#dependency' => array(
'edit-options-group-rows' => array(
TRUE,
),
),
'#fieldset' => 'multiple_field_settings',
);
list($prefix, $suffix) = explode('@count', t('starting from @count'));
$form['delta_offset'] = array(
'#type' => 'textfield',
'#size' => 5,
'#field_prefix' => $prefix,
'#field_suffix' => $suffix,
'#default_value' => $this->options['delta_offset'],
'#dependency' => array(
'edit-options-group-rows' => array(
TRUE,
),
),
'#description' => t('(first item is 0)'),
'#fieldset' => 'multiple_field_settings',
);
$form['delta_reversed'] = array(
'#title' => t('Reversed'),
'#type' => 'checkbox',
'#default_value' => $this->options['delta_reversed'],
'#suffix' => $suffix,
'#dependency' => array(
'edit-options-group-rows' => array(
TRUE,
),
),
'#description' => t('(start from last values)'),
'#fieldset' => 'multiple_field_settings',
);
$form['delta_first_last'] = array(
'#title' => t('First and last only'),
'#type' => 'checkbox',
'#default_value' => $this->options['delta_first_last'],
'#suffix' => $suffix,
'#dependency' => array(
'edit-options-group-rows' => array(
TRUE,
),
),
'#fieldset' => 'multiple_field_settings',
);
$form['delta_random'] = array(
'#title' => t('Random order'),
'#type' => 'checkbox',
'#default_value' => $this->options['delta_random'],
'#suffix' => '</div>',
'#dependency' => array(
'edit-options-group-rows' => array(
TRUE,
),
),
'#fieldset' => 'multiple_field_settings',
);
}
public function groupby_form(&$form, &$form_state) {
parent::groupby_form($form, $form_state);
$group_columns = array(
'entity_id' => t('Entity ID'),
) + drupal_map_assoc(array_keys($this->field_info['columns']), 'ucfirst');
$form['group_column'] = array(
'#type' => 'select',
'#title' => t('Group column'),
'#default_value' => $this->options['group_column'],
'#description' => t('Select the column of this field to apply the grouping function selected above.'),
'#options' => $group_columns,
);
$options = drupal_map_assoc(array(
'bundle',
'language',
'entity_type',
), 'ucfirst');
$form['group_columns'] = array(
'#type' => 'checkboxes',
'#title' => t('Group columns (additional)'),
'#default_value' => $this->options['group_columns'],
'#description' => t('Select any additional columns of this field to include in the query and to group on.'),
'#options' => $options + $group_columns,
);
}
public function groupby_form_submit(&$form, &$form_state) {
parent::groupby_form_submit($form, $form_state);
$item =& $form_state['handler']->options;
$item['group_column'] = $form_state['values']['options']['group_column'];
$item['group_columns'] = array_filter($form_state['values']['options']['group_columns']);
}
public function post_execute(&$values) {
if (!empty($values)) {
$entities_by_type = array();
foreach ($values as $key => $object) {
if (isset($this->aliases['entity_type']) && isset($object->{$this->aliases['entity_type']}) && isset($object->{$this->field_alias}) && !isset($values[$key]->_field_data[$this->field_alias])) {
$entity_type = $object->{$this->aliases['entity_type']};
if (empty($this->definition['is revision'])) {
$entity_id = $object->{$this->field_alias};
$entities_by_type[$entity_type][$key] = $entity_id;
}
else {
$revision_id = $object->{$this->field_alias};
$entity_id = $object->{$this->aliases['entity_id']};
$entities_by_type[$entity_type][$key] = array(
$entity_id,
$revision_id,
);
}
}
}
foreach ($entities_by_type as $entity_type => $entity_ids) {
$entity_info = entity_get_info($entity_type);
if (empty($this->definition['is revision'])) {
$entities = entity_load($entity_type, $entity_ids);
$keys = $entity_ids;
}
else {
$entities = array();
$keys = array();
foreach ($entity_ids as $key => $combined) {
list($entity_id, $revision_id) = $combined;
$entity = entity_load($entity_type, array(
$entity_id,
), array(
$entity_info['entity keys']['revision'] => $revision_id,
));
if ($entity) {
$entities[$revision_id] = array_shift($entity);
$keys[$key] = $revision_id;
}
}
}
foreach ($keys as $key => $entity_id) {
if (isset($entities[$entity_id])) {
$values[$key]->_field_data[$this->field_alias] = array(
'entity_type' => $entity_type,
'entity' => $entities[$entity_id],
);
}
}
}
foreach ($values as $row_id => &$value) {
$value->{'field_' . $this->options['id']} = $this
->set_items($value, $row_id);
}
unset($value);
}
}
public function render_items($items) {
if (!empty($items)) {
if (!$this->options['group_rows']) {
return implode('', $items);
}
if ($this->options['multi_type'] == 'separator') {
return implode(filter_xss_admin($this->options['separator']), $items);
}
elseif ($this->options['multi_type'] == 'count') {
return count($items);
}
else {
return theme('item_list', array(
'items' => $items,
'title' => NULL,
'type' => $this->options['multi_type'],
));
}
}
}
public function get_items($values) {
return $values->{'field_' . $this->options['id']};
}
public function get_value($values, $field = NULL) {
if (!isset($values->_field_data[$this->field_alias]['entity']) || !is_object($values->_field_data[$this->field_alias]['entity'])) {
return array();
}
$entity = clone $values->_field_data[$this->field_alias]['entity'];
$entity_type = $values->_field_data[$this->field_alias]['entity_type'];
$langcode = $this
->field_language($entity_type, $entity);
if (!empty($this->group_fields)) {
$base_value = array();
$data = FALSE;
foreach ($this->group_fields as $field_name => $column) {
if (property_exists($values, $this->aliases[$column])) {
$base_value[$field_name] = $values->{$this->aliases[$column]};
if (isset($base_value[$field_name])) {
$data = TRUE;
}
}
}
if ($data) {
$entity->{$this->definition['field_name']}[$langcode] = array(
$base_value,
);
}
else {
$entity->{$this->definition['field_name']}[$langcode] = array();
}
}
if (!isset($entity->{$this->definition['field_name']})) {
return array();
}
if ($this->options['delta_random'] && !empty($entity->{$this->definition['field_name']})) {
shuffle($entity->{$this->definition['field_name']}[$langcode]);
}
if ($this->limit_values && !empty($entity->{$this->definition['field_name']})) {
$all_values = !empty($entity->{$this->definition['field_name']}[$langcode]) ? $entity->{$this->definition['field_name']}[$langcode] : array();
if ($this->options['delta_reversed']) {
$all_values = array_reverse($all_values);
}
if (!$this->options['group_rows'] && isset($this->aliases['delta']) && isset($values->{$this->aliases['delta']})) {
$delta_limit = 1;
$offset = $values->{$this->aliases['delta']};
}
elseif (!$this->options['group_rows'] && !$this->multiple) {
$delta_limit = 1;
$offset = 0;
}
else {
$delta_limit = $this->options['delta_limit'];
$offset = intval($this->options['delta_offset']);
if ($delta_limit == 'all') {
$delta_limit = count($all_values) - $offset;
}
}
$delta_first_last = $this->options['delta_first_last'];
$new_values = array();
for ($i = 0; $i < $delta_limit; $i++) {
$new_delta = $offset + $i;
if (isset($all_values[$new_delta])) {
if (!$delta_first_last || $new_delta == $offset || $new_delta == $delta_limit + $offset - 1) {
$new_values[] = $all_values[$new_delta];
}
}
}
$entity->{$this->definition['field_name']}[$langcode] = $new_values;
}
if ($field == 'entity') {
return $entity;
}
else {
return !empty($entity->{$this->definition['field_name']}[$langcode]) ? $entity->{$this->definition['field_name']}[$langcode] : array();
}
}
public function set_items($values, $row_id) {
if (empty($values->_field_data[$this->field_alias]) || empty($values->_field_data[$this->field_alias]['entity']) || !isset($values->_field_data[$this->field_alias]['entity']->{$this->definition['field_name']})) {
return array();
}
$display = array(
'type' => $this->options['type'],
'settings' => $this->options['settings'],
'label' => 'hidden',
'views_view' => $this->view,
'views_field' => $this,
'views_row_id' => $row_id,
);
$entity_type = $values->_field_data[$this->field_alias]['entity_type'];
$entity = $this
->get_value($values, 'entity');
if (!$entity) {
return array();
}
$langcode = $this
->field_language($entity_type, $entity);
$render_array = field_view_field($entity_type, $entity, $this->definition['field_name'], $display, $langcode);
$items = array();
if ($this->options['field_api_classes']) {
return array(
array(
'rendered' => drupal_render($render_array),
),
);
}
foreach (element_children($render_array) as $count) {
$items[$count]['rendered'] = $render_array[$count];
if (isset($render_array['#access'])) {
$items[$count]['rendered']['#access'] = $render_array['#access'];
}
if ((!isset($items[$count]['rendered']['#access']) || $items[$count]['rendered']['#access']) && !empty($render_array['#items'][$count])) {
$items[$count]['raw'] = $render_array['#items'][$count];
}
}
return $items;
}
public function render_item($count, $item) {
return render($item['rendered']);
}
public function document_self_tokens(&$tokens) {
$field = $this->field_info;
foreach ($field['columns'] as $id => $column) {
$tokens['[' . $this->options['id'] . '-' . $id . ']'] = t('Raw @column', array(
'@column' => $id,
));
}
}
public function add_self_tokens(&$tokens, $item) {
$field = $this->field_info;
foreach ($field['columns'] as $id => $column) {
if (isset($item['raw'])) {
$raw = is_array($item['raw']) ? $item['raw'] : (is_object($item['raw']) ? (array) $item['raw'] : NULL);
}
if (isset($raw) && isset($raw[$id]) && is_scalar($raw[$id])) {
$tokens['[' . $this->options['id'] . '-' . $id . ']'] = filter_xss_admin($raw[$id]);
}
else {
$tokens['[' . $this->options['id'] . '-' . $id . ']'] = '';
}
}
}
public function field_language($entity_type, $entity) {
global $language_content;
if (field_is_translatable($entity_type, $this->field_info)) {
$default_language = language_default('language');
$language = str_replace(array(
'***CURRENT_LANGUAGE***',
'***DEFAULT_LANGUAGE***',
), array(
$language_content->language,
$default_language,
), $this->view->display_handler->options['field_language']);
$language = field_language($entity_type, $entity, $this->field_info['field_name'], $language);
return $language;
}
else {
return LANGUAGE_NONE;
}
}
}