first import
This commit is contained in:
Bachir Soussi Chiadmi
@@ -0,0 +1,521 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* @file
|
||||
* Contains the EntityFieldHandlerHelper class.
|
||||
*/
|
||||
|
||||
/**
|
||||
* Helper class containing static implementations of common field handler methods.
|
||||
*
|
||||
* Used by the data selection entity field handlers to avoid code duplication.
|
||||
*
|
||||
* @see entity_views_table_definition()
|
||||
*/
|
||||
class EntityFieldHandlerHelper {
|
||||
|
||||
/**
|
||||
* Provide appropriate default options for a handler.
|
||||
*/
|
||||
public static function option_definition($handler) {
|
||||
if (entity_property_list_extract_type($handler->definition['type'])) {
|
||||
$options['list']['contains']['mode'] = array('default' => 'collapse');
|
||||
$options['list']['contains']['separator'] = array('default' => ', ');
|
||||
$options['list']['contains']['type'] = array('default' => 'ul');
|
||||
}
|
||||
$options['link_to_entity'] = array('default' => FALSE);
|
||||
|
||||
return $options;
|
||||
}
|
||||
|
||||
/**
|
||||
* Provide an appropriate default option form for a handler.
|
||||
*/
|
||||
public static function options_form($handler, &$form, &$form_state) {
|
||||
if (entity_property_list_extract_type($handler->definition['type'])) {
|
||||
$form['list']['mode'] = array(
|
||||
'#type' => 'select',
|
||||
'#title' => t('List handling'),
|
||||
'#options' => array(
|
||||
'collapse' => t('Concatenate values using a seperator'),
|
||||
'list' => t('Output values as list'),
|
||||
'first' => t('Show first (if present)'),
|
||||
'count' => t('Show item count'),
|
||||
),
|
||||
'#default_value' => $handler->options['list']['mode'],
|
||||
);
|
||||
$form['list']['separator'] = array(
|
||||
'#type' => 'textfield',
|
||||
'#title' => t('List seperator'),
|
||||
'#default_value' => $handler->options['list']['separator'],
|
||||
'#dependency' => array('edit-options-list-mode' => array('collapse')),
|
||||
);
|
||||
$form['list']['type'] = array(
|
||||
'#type' => 'select',
|
||||
'#title' => t('List type'),
|
||||
'#options' => array(
|
||||
'ul' => t('Unordered'),
|
||||
'ol' => t('Ordered'),
|
||||
),
|
||||
'#default_value' => $handler->options['list']['type'],
|
||||
'#dependency' => array('edit-options-list-mode' => array('list')),
|
||||
);
|
||||
}
|
||||
$form['link_to_entity'] = array(
|
||||
'#type' => 'checkbox',
|
||||
'#title' => t('Link this field to its entity'),
|
||||
'#description' => t("When using this, you should not set any other link on the field."),
|
||||
'#default_value' => $handler->options['link_to_entity'],
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Add the field for the entity ID (if necessary).
|
||||
*/
|
||||
public static function query($handler) {
|
||||
// Copied over from views_handler_field_entity::query().
|
||||
// Sets table_alias (entity table), base_field (entity id field) and
|
||||
// field_alias (the field's alias).
|
||||
$handler->table_alias = $base_table = $handler->view->base_table;
|
||||
$handler->base_field = $handler->view->base_field;
|
||||
|
||||
if (!empty($handler->relationship)) {
|
||||
foreach ($handler->view->relationship as $relationship) {
|
||||
if ($relationship->alias == $handler->relationship) {
|
||||
$base_table = $relationship->definition['base'];
|
||||
$handler->table_alias = $relationship->alias;
|
||||
|
||||
$table_data = views_fetch_data($base_table);
|
||||
$handler->base_field = empty($relationship->definition['base field']) ? $table_data['table']['base']['field'] : $relationship->definition['base field'];
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Add the field if the query back-end implements an add_field() method,
|
||||
// just like the default back-end.
|
||||
if (method_exists($handler->query, 'add_field')) {
|
||||
$handler->field_alias = $handler->query->add_field($handler->table_alias, $handler->base_field, '');
|
||||
}
|
||||
else {
|
||||
// To ensure there is an alias just set the field alias to the real field.
|
||||
$handler->field_alias = $handler->real_field;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Extracts the innermost field name from a data selector.
|
||||
*
|
||||
* @param $selector
|
||||
* The data selector.
|
||||
*
|
||||
* @return
|
||||
* The last component of the data selector.
|
||||
*/
|
||||
public static function get_selector_field_name($selector) {
|
||||
return ltrim(substr($selector, strrpos($selector, ':')), ':');
|
||||
}
|
||||
|
||||
/**
|
||||
* Adds a click-sort to the query.
|
||||
*
|
||||
* @param $order
|
||||
* Either 'ASC' or 'DESC'.
|
||||
*/
|
||||
public static function click_sort($handler, $order) {
|
||||
// The normal orderby() method for this usually won't work here. So we need
|
||||
// query plugins to provide their own method for this.
|
||||
if (method_exists($handler->query, 'add_selector_orderby')) {
|
||||
$selector = self::construct_property_selector($handler, TRUE);
|
||||
$handler->query->add_selector_orderby($selector, $order);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Load the entities for all rows that are about to be displayed.
|
||||
*
|
||||
* Automatically takes care of relationships, including data selection
|
||||
* relationships. Results are written into @code $handler->wrappers @endcode
|
||||
* and @code $handler->entity_type @endcode is set.
|
||||
*/
|
||||
public static function pre_render($handler, &$values, $load_always = FALSE) {
|
||||
if (empty($values)) {
|
||||
return;
|
||||
}
|
||||
if (!$load_always && empty($handler->options['link_to_entity'])) {
|
||||
// Check whether we even need to load the entities.
|
||||
$selector = self::construct_property_selector($handler, TRUE);
|
||||
$load = FALSE;
|
||||
foreach ($values as $row) {
|
||||
if (empty($row->_entity_properties) || !array_key_exists($selector, $row->_entity_properties)) {
|
||||
$load = TRUE;
|
||||
break;
|
||||
}
|
||||
}
|
||||
if (!$load) {
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
if (method_exists($handler->query, 'get_result_wrappers')) {
|
||||
list($handler->entity_type, $handler->wrappers) = $handler->query->get_result_wrappers($values, $handler->relationship, $handler->real_field);
|
||||
}
|
||||
else {
|
||||
list($handler->entity_type, $entities) = $handler->query->get_result_entities($values, $handler->relationship, $handler->real_field);
|
||||
$handler->wrappers = array();
|
||||
foreach ($entities as $id => $entity) {
|
||||
$handler->wrappers[$id] = entity_metadata_wrapper($handler->entity_type, $entity);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Return an Entity API data selector for the given handler's relationship.
|
||||
*
|
||||
* A data selector is a concatenation of properties which should be followed
|
||||
* to arrive at a desired property that may be nested in related entities or
|
||||
* structures. The separate properties are herein concatenated with colons.
|
||||
*
|
||||
* For instance, a data selector of "author:roles" would mean to first
|
||||
* access the "author" property of the given wrapper, and then for this new
|
||||
* wrapper to access and return the "roles" property.
|
||||
*
|
||||
* Lists of entities are handled automatically by always returning only the
|
||||
* first entity.
|
||||
*
|
||||
* @param $handler
|
||||
* The handler for which to construct the selector.
|
||||
* @param $complete
|
||||
* If TRUE, the complete selector for the field is returned, not just the
|
||||
* one for its parent. Defaults to FALSE.
|
||||
*
|
||||
* @return
|
||||
* An Entity API data selector for the given handler's relationship.
|
||||
*/
|
||||
public static function construct_property_selector($handler, $complete = FALSE) {
|
||||
$return = '';
|
||||
if ($handler->relationship) {
|
||||
$current_handler = $handler;
|
||||
$view = $current_handler->view;
|
||||
while (!empty($current_handler->relationship) && !empty($view->relationship[$current_handler->relationship])) {
|
||||
$current_handler = $view->relationship[$current_handler->relationship];
|
||||
$return = $current_handler->real_field . ($return ? ":$return" : '');
|
||||
}
|
||||
}
|
||||
|
||||
if ($complete) {
|
||||
$return .= ($return ? ':' : '') . $handler->real_field;
|
||||
}
|
||||
elseif ($pos = strrpos($handler->real_field, ':')) {
|
||||
// If we have a selector as the real_field, append this to the returned
|
||||
// relationship selector.
|
||||
$return .= ($return ? ':' : '') . substr($handler->real_field, 0, $pos);
|
||||
}
|
||||
|
||||
return $return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Extracts data from several metadata wrappers based on a data selector.
|
||||
*
|
||||
* All metadata wrappers passed to this function have to be based on the exact
|
||||
* same property information. The data will be returned wrapped by one or more
|
||||
* metadata wrappers.
|
||||
*
|
||||
* Can be used in query plugins for the get_result_entities() and
|
||||
* get_result_wrappers() methods.
|
||||
*
|
||||
* @param array $wrappers
|
||||
* The EntityMetadataWrapper objects from which to extract data.
|
||||
* @param $selector
|
||||
* The selector specifying the data to extract.
|
||||
*
|
||||
* @return array
|
||||
* An array with numeric indices, containing the type of the extracted
|
||||
* wrappers in the first element. The second element of the array contains
|
||||
* the extracted property value(s) for each wrapper, keyed to the same key
|
||||
* that was used for the respecive wrapper in $wrappers. All extracted
|
||||
* properties are returned as metadata wrappers.
|
||||
*/
|
||||
public static function extract_property_multiple(array $wrappers, $selector) {
|
||||
$parts = explode(':', $selector, 2);
|
||||
$name = $parts[0];
|
||||
|
||||
$results = array();
|
||||
$entities = array();
|
||||
$type = '';
|
||||
foreach ($wrappers as $i => $wrapper) {
|
||||
try {
|
||||
$property = $wrapper->$name;
|
||||
$type = $property->type();
|
||||
if ($property instanceof EntityDrupalWrapper) {
|
||||
// Remember the entity IDs to later load all at once (so as to
|
||||
// properly utilize multiple load functionality).
|
||||
$id = $property->getIdentifier();
|
||||
// Only accept valid ids. $id can be FALSE for entity values that are
|
||||
// NULL.
|
||||
if ($id) {
|
||||
$entities[$type][$i] = $id;
|
||||
}
|
||||
}
|
||||
elseif ($property instanceof EntityStructureWrapper) {
|
||||
$results[$i] = $property;
|
||||
}
|
||||
elseif ($property instanceof EntityListWrapper) {
|
||||
foreach ($property as $item) {
|
||||
$results[$i] = $item;
|
||||
$type = $item->type();
|
||||
break;
|
||||
}
|
||||
}
|
||||
// Do nothing in case it cannot be applied.
|
||||
}
|
||||
catch (EntityMetadataWrapperException $e) {
|
||||
// Skip single empty properties.
|
||||
}
|
||||
}
|
||||
|
||||
if ($entities) {
|
||||
// Map back the loaded entities back to the results array.
|
||||
foreach ($entities as $type => $id_map) {
|
||||
$loaded = entity_load($type, $id_map);
|
||||
foreach ($id_map as $i => $id) {
|
||||
if (isset($loaded[$id])) {
|
||||
$results[$i] = entity_metadata_wrapper($type, $loaded[$id]);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// If there are no further parts in the selector, we are done now.
|
||||
if (empty($parts[1])) {
|
||||
return array($type, $results);
|
||||
}
|
||||
return self::extract_property_multiple($results, $parts[1]);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the value of a certain data selector.
|
||||
*
|
||||
* Uses $values->_entity_properties to look for already extracted properties.
|
||||
*
|
||||
* @param $handler
|
||||
* The field handler for which to return a value.
|
||||
* @param $values
|
||||
* The values for the current row retrieved from the Views query, as an
|
||||
* object.
|
||||
* @param $field
|
||||
* The field to extract. If no value is given, the field of the given
|
||||
* handler is used instead. The special "entity object" value can be used to
|
||||
* get the base entity instead of a special field.
|
||||
* @param $default
|
||||
* The value to return if the entity or field are not present.
|
||||
*/
|
||||
public static function get_value($handler, $values, $field = NULL, $default = NULL) {
|
||||
// There is a value cache on each handler so parent handlers rendering a
|
||||
// single field value from a list will get the single value, not the whole
|
||||
// list.
|
||||
if (!isset($field) && isset($handler->current_value)) {
|
||||
return $handler->current_value;
|
||||
}
|
||||
$field = isset($field) ? $field : self::get_selector_field_name($handler->real_field);
|
||||
$selector = self::construct_property_selector($handler);
|
||||
$selector = $selector ? "$selector:$field" : $field;
|
||||
if (!isset($values->_entity_properties)) {
|
||||
$values->_entity_properties = array();
|
||||
}
|
||||
if (!array_key_exists($selector, $values->_entity_properties)) {
|
||||
if (!isset($handler->wrappers[$handler->view->row_index])) {
|
||||
$values->_entity_properties[$selector] = $default;
|
||||
}
|
||||
elseif (is_array($handler->wrappers[$handler->view->row_index])) {
|
||||
$values->_entity_properties[$selector] = self::extract_list_wrapper_values($handler->wrappers[$handler->view->row_index], $field);
|
||||
}
|
||||
else {
|
||||
$wrapper = $handler->wrappers[$handler->view->row_index];
|
||||
try {
|
||||
if ($field === 'entity object') {
|
||||
$values->_entity_properties[$selector] = $wrapper->value();
|
||||
}
|
||||
else {
|
||||
$values->_entity_properties[$selector] = isset($wrapper->$field) ? $wrapper->$field->value(array('identifier' => TRUE)) : $default;
|
||||
}
|
||||
}
|
||||
catch (EntityMetadataWrapperException $e) {
|
||||
$values->_entity_properties[$selector] = $default;
|
||||
}
|
||||
}
|
||||
}
|
||||
return $values->_entity_properties[$selector];
|
||||
}
|
||||
|
||||
/**
|
||||
* Helper method for extracting the values from an array of wrappers.
|
||||
*
|
||||
* Nested arrays of wrappers are also handled, the values are returned in a
|
||||
* flat (not nested) array.
|
||||
*/
|
||||
public static function extract_list_wrapper_values(array $wrappers, $field) {
|
||||
$return = array();
|
||||
foreach ($wrappers as $wrapper) {
|
||||
if (is_array($wrapper)) {
|
||||
$values = self::extract_list_wrapper_values($wrapper, $field);
|
||||
if ($values) {
|
||||
$return = array_merge($return, $values);
|
||||
}
|
||||
}
|
||||
else {
|
||||
try {
|
||||
if ($field == 'entity object') {
|
||||
$return[] = $wrapper->value();
|
||||
}
|
||||
elseif (isset($wrapper->$field)) {
|
||||
$return[] = $wrapper->$field->value(array('identifier' => TRUE));
|
||||
}
|
||||
}
|
||||
catch (EntityMetadataWrapperException $e) {
|
||||
// An exception probably signifies a non-present property, so we just
|
||||
// ignore it.
|
||||
}
|
||||
}
|
||||
}
|
||||
return $return;
|
||||
}
|
||||
|
||||
/**
|
||||
* Render the field.
|
||||
*
|
||||
* Implements the entity link functionality and list handling. Basic handling
|
||||
* of the single values is delegated back to the field handler.
|
||||
*
|
||||
* @param $handler
|
||||
* The field handler whose field should be rendered.
|
||||
* @param $values
|
||||
* The values for the current row retrieved from the Views query, as an
|
||||
* object.
|
||||
*
|
||||
* @return
|
||||
* The rendered value for the field.
|
||||
*/
|
||||
public static function render($handler, $values) {
|
||||
$value = $handler->get_value($values);
|
||||
if (is_array($value)) {
|
||||
return self::render_list($handler, $value, $values);
|
||||
}
|
||||
return self::render_entity_link($handler, $value, $values);
|
||||
}
|
||||
|
||||
/**
|
||||
* Render a list of values.
|
||||
*
|
||||
* @param $handler
|
||||
* The field handler whose field is rendered.
|
||||
* @param $list
|
||||
* The list of values to render.
|
||||
* @param $values
|
||||
* The values for the current row retrieved from the Views query, as an
|
||||
* object.
|
||||
*
|
||||
* @return
|
||||
* The rendered value for the given list.
|
||||
*/
|
||||
public static function render_list($handler, $list, $values) {
|
||||
// Allow easy overriding of this behaviour in the specific field handler.
|
||||
if (method_exists($handler, 'render_list')) {
|
||||
return $handler->render_list($list, $values);
|
||||
}
|
||||
$mode = isset($handler->options['list']['mode']) ? $handler->options['list']['mode'] : NULL;
|
||||
switch ($mode) {
|
||||
case 'first':
|
||||
$list = count($list) ? array_shift($list) : NULL;
|
||||
if (is_array($list)) {
|
||||
return self::render_list($handler, $list, $values);
|
||||
}
|
||||
elseif (isset($list)) {
|
||||
return self::render_entity_link($handler, $list, $values);
|
||||
}
|
||||
return NULL;
|
||||
|
||||
case 'count':
|
||||
return count($list);
|
||||
|
||||
// Handles both collapse and list output. Fallback is to collapse.
|
||||
default:
|
||||
$inner_values = array();
|
||||
foreach ($list as $value) {
|
||||
$value = is_array($value) ? self::render_list($handler, $value, $values) : self::render_entity_link($handler, $value, $values);
|
||||
if ($value) {
|
||||
$inner_values[] = $value;
|
||||
}
|
||||
}
|
||||
|
||||
// Format output as list.
|
||||
if ($mode == 'list') {
|
||||
$type = isset($handler->options['list']['type']) ? $handler->options['list']['type'] : 'ul';
|
||||
return theme('item_list', array(
|
||||
'items' => $inner_values,
|
||||
'type' => $type,
|
||||
));
|
||||
}
|
||||
|
||||
$separator = isset($handler->options['list']['separator']) ? $handler->options['list']['separator'] : ', ';
|
||||
return implode($separator, $inner_values);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Render a single value as a link to the entity if applicable.
|
||||
*
|
||||
* @param $handler
|
||||
* The field handler whose field is rendered.
|
||||
* @param $value
|
||||
* The single value to render.
|
||||
* @param $values
|
||||
* The values for the current row retrieved from the Views query, as an
|
||||
* object.
|
||||
*
|
||||
* @return
|
||||
* The rendered value.
|
||||
*/
|
||||
public static function render_entity_link($handler, $value, $values) {
|
||||
// Allow easy overriding of this behaviour in the specific field handler.
|
||||
if (method_exists($handler, 'render_entity_link')) {
|
||||
return $handler->render_entity_link($value, $values);
|
||||
}
|
||||
$render = self::render_single_value($handler, $value, $values);
|
||||
if (!$handler->options['link_to_entity']) {
|
||||
return $render;
|
||||
}
|
||||
$entity = $handler->get_value($values, 'entity object');
|
||||
if (is_object($entity) && ($url = entity_uri($handler->entity_type, $entity))) {
|
||||
return l($render, $url['path'], array('html' => TRUE) + $url['options']);
|
||||
}
|
||||
return $render;
|
||||
}
|
||||
|
||||
/**
|
||||
* Render a single value.
|
||||
*
|
||||
* @param $handler
|
||||
* The field handler whose field is rendered.
|
||||
* @param $value
|
||||
* The single value to render.
|
||||
* @param $values
|
||||
* The values for the current row retrieved from the Views query, as an
|
||||
* object.
|
||||
*
|
||||
* @return
|
||||
* The rendered value.
|
||||
*/
|
||||
public static function render_single_value($handler, $value, $values) {
|
||||
// Try to use the method in the specific field handler.
|
||||
if (method_exists($handler, 'render_single_value')) {
|
||||
$handler->current_value = $value;
|
||||
$return = $handler->render_single_value($value, $values);
|
||||
unset($handler->current_value);
|
||||
return $return;
|
||||
}
|
||||
// Default fallback in case the field handler doesn't provide the method.
|
||||
return is_scalar($value) ? check_plain($value) : nl2br(check_plain(print_r($value, TRUE)));
|
||||
}
|
||||
|
||||
}
|
||||
@@ -0,0 +1,111 @@
|
||||
<?php
|
||||
/**
|
||||
* @file
|
||||
* Renders a full entity in a views area.
|
||||
*/
|
||||
|
||||
class entity_views_handler_area_entity extends views_handler_area {
|
||||
public function option_definition() {
|
||||
$options = parent::option_definition();
|
||||
$options['entity_type'] = array('default' => 'node');
|
||||
$options['entity_id'] = array('default' => '');
|
||||
$options['view_mode'] = array('default' => 'full');
|
||||
return $options;
|
||||
}
|
||||
|
||||
function options_form(&$form, &$form_state) {
|
||||
parent::options_form($form, $form_state);
|
||||
|
||||
$entity_type_options = array();
|
||||
foreach (entity_get_info() as $entity_type => $entity_info) {
|
||||
$entity_type_options[$entity_type] = $entity_info['label'];
|
||||
}
|
||||
|
||||
$entity_type = $this->options['entity_type'];
|
||||
|
||||
$form['entity_type'] = array(
|
||||
'#type' => 'select',
|
||||
'#title' => t('Entity type'),
|
||||
'#options' => $entity_type_options,
|
||||
'#description' => t('Choose the entity type you want to display in the area.'),
|
||||
'#default_value' => $entity_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['entity_id'] = array(
|
||||
'#type' => 'textfield',
|
||||
'#title' => t('Entity id'),
|
||||
'#description' => t('Choose the entity you want to display in the area.'),
|
||||
'#default_value' => $this->options['entity_id'],
|
||||
);
|
||||
|
||||
if ($entity_type) {
|
||||
$entity_info = entity_get_info($entity_type);
|
||||
$options = array();
|
||||
if (!empty($entity_info['view modes'])) {
|
||||
foreach ($entity_info['view modes'] as $mode => $settings) {
|
||||
$options[$mode] = $settings['label'];
|
||||
}
|
||||
}
|
||||
|
||||
if (count($options) > 1) {
|
||||
$form['view_mode'] = array(
|
||||
'#type' => 'select',
|
||||
'#options' => $options,
|
||||
'#title' => t('View mode'),
|
||||
'#default_value' => $this->options['view_mode'],
|
||||
);
|
||||
}
|
||||
else {
|
||||
$form['view_mode_info'] = array(
|
||||
'#type' => 'item',
|
||||
'#title' => t('View mode'),
|
||||
'#description' => t('Only one view mode is available for this entity type.'),
|
||||
'#markup' => $options ? current($options) : t('Default'),
|
||||
);
|
||||
$form['view_mode'] = array(
|
||||
'#type' => 'value',
|
||||
'#value' => $options ? key($options) : 'default',
|
||||
);
|
||||
}
|
||||
}
|
||||
return $form;
|
||||
}
|
||||
|
||||
public function admin_summary() {
|
||||
$label = parent::admin_summary();
|
||||
if (!empty($this->options['entity_id'])) {
|
||||
return t('@label @entity_type:@entity_id', array(
|
||||
'@label' => $label,
|
||||
'@entity_type' => $this->options['entity_type'],
|
||||
'@entity_id' => $this->options['entity_id'],
|
||||
));
|
||||
}
|
||||
}
|
||||
|
||||
public function render($empty = FALSE) {
|
||||
if (!$empty || !empty($this->options['empty'])) {
|
||||
return $this->render_entity($this->options['entity_type'], $this->options['entity_id'], $this->options['view_mode']);
|
||||
}
|
||||
return '';
|
||||
}
|
||||
|
||||
/**
|
||||
* Render an entity using the view mode.
|
||||
*/
|
||||
public function render_entity($entity_type, $entity_id, $view_mode) {
|
||||
if (!empty($entity_type) && !empty($entity_id) && !empty($view_mode)) {
|
||||
$entities = entity_load($entity_type, array($entity_id));
|
||||
$render = entity_view($entity_type, $entities, $view_mode);
|
||||
$render_entity = reset($render);
|
||||
return drupal_render($render_entity);
|
||||
}
|
||||
else {
|
||||
return '';
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,99 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* @file
|
||||
* Contains the entity_views_handler_field_boolean class.
|
||||
*/
|
||||
|
||||
/**
|
||||
* A handler to provide proper displays for booleans.
|
||||
*
|
||||
* Overrides the default Views handler to retrieve the data from an entity via
|
||||
* data selection.
|
||||
*
|
||||
* This handler may only be used in conjunction with data selection based Views
|
||||
* tables or other base tables using a query plugin that supports data
|
||||
* selection.
|
||||
*
|
||||
* @see entity_views_field_definition()
|
||||
* @ingroup views_field_handlers
|
||||
*/
|
||||
class entity_views_handler_field_boolean extends views_handler_field_boolean {
|
||||
|
||||
/**
|
||||
* Stores the entity type of the result entities.
|
||||
*/
|
||||
public $entity_type;
|
||||
|
||||
/**
|
||||
* Stores the result entities' metadata wrappers.
|
||||
*/
|
||||
public $wrappers = array();
|
||||
|
||||
/**
|
||||
* Stores the current value when rendering list fields.
|
||||
*/
|
||||
public $current_value;
|
||||
|
||||
/**
|
||||
* Overridden to add the field for the entity ID (if necessary).
|
||||
*/
|
||||
public function query() {
|
||||
EntityFieldHandlerHelper::query($this);
|
||||
}
|
||||
|
||||
/**
|
||||
* Adds a click-sort to the query.
|
||||
*/
|
||||
public function click_sort($order) {
|
||||
EntityFieldHandlerHelper::click_sort($this, $order);
|
||||
}
|
||||
|
||||
/**
|
||||
* Load the entities for all rows that are about to be displayed.
|
||||
*/
|
||||
public function pre_render(&$values) {
|
||||
parent::pre_render($values);
|
||||
EntityFieldHandlerHelper::pre_render($this, $values);
|
||||
}
|
||||
|
||||
/**
|
||||
* Overridden to use a metadata wrapper.
|
||||
*/
|
||||
public function get_value($values, $field = NULL) {
|
||||
return EntityFieldHandlerHelper::get_value($this, $values, $field);
|
||||
}
|
||||
|
||||
/**
|
||||
* Provide options for this handler.
|
||||
*/
|
||||
public function option_definition() {
|
||||
return parent::option_definition() + EntityFieldHandlerHelper::option_definition($this);
|
||||
}
|
||||
|
||||
/**
|
||||
* Provide a options form for this handler.
|
||||
*/
|
||||
public function options_form(&$form, &$form_state) {
|
||||
parent::options_form($form, $form_state);
|
||||
EntityFieldHandlerHelper::options_form($this, $form, $form_state);
|
||||
}
|
||||
|
||||
/**
|
||||
* Render the field.
|
||||
*
|
||||
* @param $values
|
||||
* The values retrieved from the database.
|
||||
*/
|
||||
public function render($values) {
|
||||
return EntityFieldHandlerHelper::render($this, $values);
|
||||
}
|
||||
|
||||
/**
|
||||
* Render a single field value.
|
||||
*/
|
||||
public function render_single_value($value, $values) {
|
||||
return parent::render($values);
|
||||
}
|
||||
|
||||
}
|
||||
@@ -0,0 +1,99 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* @file
|
||||
* Contains the entity_views_handler_field_date class.
|
||||
*/
|
||||
|
||||
/**
|
||||
* A handler to provide proper displays for dates.
|
||||
*
|
||||
* Overrides the default Views handler to retrieve the data from an entity via
|
||||
* data selection.
|
||||
*
|
||||
* This handler may only be used in conjunction with data selection based Views
|
||||
* tables or other base tables using a query plugin that supports data
|
||||
* selection.
|
||||
*
|
||||
* @see entity_views_field_definition()
|
||||
* @ingroup views_field_handlers
|
||||
*/
|
||||
class entity_views_handler_field_date extends views_handler_field_date {
|
||||
|
||||
/**
|
||||
* Stores the entity type of the result entities.
|
||||
*/
|
||||
public $entity_type;
|
||||
|
||||
/**
|
||||
* Stores the result entities' metadata wrappers.
|
||||
*/
|
||||
public $wrappers = array();
|
||||
|
||||
/**
|
||||
* Stores the current value when rendering list fields.
|
||||
*/
|
||||
public $current_value;
|
||||
|
||||
/**
|
||||
* Overridden to add the field for the entity ID (if necessary).
|
||||
*/
|
||||
public function query() {
|
||||
EntityFieldHandlerHelper::query($this);
|
||||
}
|
||||
|
||||
/**
|
||||
* Adds a click-sort to the query.
|
||||
*/
|
||||
public function click_sort($order) {
|
||||
EntityFieldHandlerHelper::click_sort($this, $order);
|
||||
}
|
||||
|
||||
/**
|
||||
* Load the entities for all rows that are about to be displayed.
|
||||
*/
|
||||
public function pre_render(&$values) {
|
||||
parent::pre_render($values);
|
||||
EntityFieldHandlerHelper::pre_render($this, $values);
|
||||
}
|
||||
|
||||
/**
|
||||
* Overridden to use a metadata wrapper.
|
||||
*/
|
||||
public function get_value($values, $field = NULL) {
|
||||
return EntityFieldHandlerHelper::get_value($this, $values, $field);
|
||||
}
|
||||
|
||||
/**
|
||||
* Provide options for this handler.
|
||||
*/
|
||||
public function option_definition() {
|
||||
return parent::option_definition() + EntityFieldHandlerHelper::option_definition($this);
|
||||
}
|
||||
|
||||
/**
|
||||
* Provide a options form for this handler.
|
||||
*/
|
||||
public function options_form(&$form, &$form_state) {
|
||||
parent::options_form($form, $form_state);
|
||||
EntityFieldHandlerHelper::options_form($this, $form, $form_state);
|
||||
}
|
||||
|
||||
/**
|
||||
* Render the field.
|
||||
*
|
||||
* @param $values
|
||||
* The values retrieved from the database.
|
||||
*/
|
||||
public function render($values) {
|
||||
return EntityFieldHandlerHelper::render($this, $values);
|
||||
}
|
||||
|
||||
/**
|
||||
* Render a single field value.
|
||||
*/
|
||||
public function render_single_value($value, $values) {
|
||||
return parent::render($values);
|
||||
}
|
||||
|
||||
}
|
||||
@@ -0,0 +1,130 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* @file
|
||||
* Contains the entity_views_handler_field_duration class.
|
||||
*/
|
||||
|
||||
/**
|
||||
* A handler to provide proper displays for duration properties retrieved via data selection.
|
||||
*
|
||||
* This handler may only be used in conjunction with data selection based Views
|
||||
* tables or other base tables using a query plugin that supports data
|
||||
* selection.
|
||||
*
|
||||
* @see entity_views_field_definition()
|
||||
* @ingroup views_field_handlers
|
||||
*/
|
||||
class entity_views_handler_field_duration extends views_handler_field {
|
||||
|
||||
/**
|
||||
* Stores the entity type of the result entities.
|
||||
*/
|
||||
public $entity_type;
|
||||
|
||||
/**
|
||||
* Stores the result entities' metadata wrappers.
|
||||
*/
|
||||
public $wrappers = array();
|
||||
|
||||
/**
|
||||
* Stores the current value when rendering list fields.
|
||||
*/
|
||||
public $current_value;
|
||||
|
||||
/**
|
||||
* Overridden to add the field for the entity ID (if necessary).
|
||||
*/
|
||||
public function query() {
|
||||
EntityFieldHandlerHelper::query($this);
|
||||
}
|
||||
|
||||
/**
|
||||
* Adds a click-sort to the query.
|
||||
*/
|
||||
public function click_sort($order) {
|
||||
EntityFieldHandlerHelper::click_sort($this, $order);
|
||||
}
|
||||
|
||||
/**
|
||||
* Load the entities for all rows that are about to be displayed.
|
||||
*/
|
||||
public function pre_render(&$values) {
|
||||
parent::pre_render($values);
|
||||
EntityFieldHandlerHelper::pre_render($this, $values);
|
||||
}
|
||||
|
||||
/**
|
||||
* Overridden to use a metadata wrapper.
|
||||
*/
|
||||
public function get_value($values, $field = NULL) {
|
||||
return EntityFieldHandlerHelper::get_value($this, $values, $field);
|
||||
}
|
||||
|
||||
public function option_definition() {
|
||||
$options = parent::option_definition();
|
||||
$options += EntityFieldHandlerHelper::option_definition($this);
|
||||
|
||||
$options['format_interval'] = array('default' => TRUE);
|
||||
$options['granularity'] = array('default' => 2);
|
||||
$options['prefix'] = array('default' => '', 'translatable' => TRUE);
|
||||
$options['suffix'] = array('default' => '', 'translatable' => TRUE);
|
||||
|
||||
return $options;
|
||||
}
|
||||
|
||||
public function options_form(&$form, &$form_state) {
|
||||
parent::options_form($form, $form_state);
|
||||
EntityFieldHandlerHelper::options_form($this, $form, $form_state);
|
||||
|
||||
$form['format_interval'] = array(
|
||||
'#type' => 'checkbox',
|
||||
'#title' => t('Format interval'),
|
||||
'#description' => t('If checked, the value will be formatted as a time interval. Otherwise, just the number of seconds will be displayed.'),
|
||||
'#default_value' => $this->options['format_interval'],
|
||||
);
|
||||
$form['granularity'] = array(
|
||||
'#type' => 'textfield',
|
||||
'#title' => t('Granularity'),
|
||||
'#default_value' => $this->options['granularity'],
|
||||
'#description' => t('Specify how many different units to display.'),
|
||||
'#dependency' => array('edit-options-format-interval' => array(TRUE)),
|
||||
'#size' => 2,
|
||||
);
|
||||
$form['prefix'] = array(
|
||||
'#type' => 'textfield',
|
||||
'#title' => t('Prefix'),
|
||||
'#default_value' => $this->options['prefix'],
|
||||
'#description' => t('Text to put before the duration text.'),
|
||||
);
|
||||
$form['suffix'] = array(
|
||||
'#type' => 'textfield',
|
||||
'#title' => t('Suffix'),
|
||||
'#default_value' => $this->options['suffix'],
|
||||
'#description' => t('Text to put after the duration text.'),
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Render the field.
|
||||
*
|
||||
* @param $values
|
||||
* The values retrieved from the database.
|
||||
*/
|
||||
public function render($values) {
|
||||
return EntityFieldHandlerHelper::render($this, $values);
|
||||
}
|
||||
|
||||
/**
|
||||
* Render a single field value.
|
||||
*/
|
||||
public function render_single_value($value, $values) {
|
||||
if ($this->options['format_interval']) {
|
||||
$value = format_interval($value, (int) $this->options['granularity']);
|
||||
}
|
||||
return $this->sanitize_value($this->options['prefix'], 'xss') .
|
||||
$this->sanitize_value($value) .
|
||||
$this->sanitize_value($this->options['suffix'], 'xss');
|
||||
}
|
||||
|
||||
}
|
||||
@@ -0,0 +1,199 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* @file
|
||||
* Contains the entity_views_handler_field_entity class.
|
||||
*/
|
||||
|
||||
/**
|
||||
* A handler to provide proper displays for entities retrieved via data selection.
|
||||
*
|
||||
* This handler may only be used in conjunction with data selection based Views
|
||||
* tables or other base tables using a query plugin that supports data
|
||||
* selection.
|
||||
*
|
||||
* @see entity_views_field_definition()
|
||||
* @ingroup views_field_handlers
|
||||
*/
|
||||
class entity_views_handler_field_entity extends views_handler_field {
|
||||
|
||||
/**
|
||||
* Stores the entity type of the result entities.
|
||||
*/
|
||||
public $entity_type;
|
||||
|
||||
/**
|
||||
* Stores the result entities' metadata wrappers.
|
||||
*/
|
||||
public $wrappers = array();
|
||||
|
||||
/**
|
||||
* The entity type of the entity displayed by this field.
|
||||
*/
|
||||
public $field_entity_type;
|
||||
|
||||
/**
|
||||
* Stores the current value when rendering list fields.
|
||||
*/
|
||||
public $current_value;
|
||||
|
||||
/**
|
||||
* Initialize the entity type with the field's entity type.
|
||||
*/
|
||||
public function init(&$view, &$options) {
|
||||
parent::init($view, $options);
|
||||
$this->field_entity_type = entity_property_extract_innermost_type($this->definition['type']);
|
||||
}
|
||||
|
||||
/**
|
||||
* Overridden to add the field for the entity ID (if necessary).
|
||||
*/
|
||||
public function query() {
|
||||
EntityFieldHandlerHelper::query($this);
|
||||
}
|
||||
|
||||
/**
|
||||
* Adds a click-sort to the query.
|
||||
*/
|
||||
public function click_sort($order) {
|
||||
EntityFieldHandlerHelper::click_sort($this, $order);
|
||||
}
|
||||
|
||||
/**
|
||||
* Load the entities for all rows that are about to be displayed.
|
||||
*/
|
||||
public function pre_render(&$values) {
|
||||
EntityFieldHandlerHelper::pre_render($this, $values);
|
||||
}
|
||||
|
||||
/**
|
||||
* Overridden to use a metadata wrapper.
|
||||
*/
|
||||
public function get_value($values, $field = NULL) {
|
||||
return EntityFieldHandlerHelper::get_value($this, $values, $field);
|
||||
}
|
||||
|
||||
public function option_definition() {
|
||||
$options = parent::option_definition();
|
||||
$options += EntityFieldHandlerHelper::option_definition($this);
|
||||
|
||||
$options['display'] = array('default' => 'label');
|
||||
$options['link_to_entity']['default'] = TRUE;
|
||||
$options['view_mode'] = array('default' => 'default');
|
||||
|
||||
return $options;
|
||||
}
|
||||
|
||||
public function options_form(&$form, &$form_state) {
|
||||
parent::options_form($form, $form_state);
|
||||
EntityFieldHandlerHelper::options_form($this, $form, $form_state);
|
||||
// We want a different form field at a different place.
|
||||
unset($form['link_to_entity']);
|
||||
|
||||
$options = array(
|
||||
'label' => t('Show entity label'),
|
||||
'id' => t('Show entity ID'),
|
||||
'view' => t('Show complete entity'),
|
||||
);
|
||||
$form['display'] = array(
|
||||
'#type' => 'select',
|
||||
'#title' => t('Display'),
|
||||
'#description' => t('Decide how this field will be displayed.'),
|
||||
'#options' => $options,
|
||||
'#default_value' => $this->options['display'],
|
||||
);
|
||||
$form['link_to_entity'] = array(
|
||||
'#type' => 'checkbox',
|
||||
'#title' => t('Link to entity'),
|
||||
'#description' => t('Link this field to the entity.'),
|
||||
'#default_value' => $this->options['link_to_entity'],
|
||||
'#dependency' => array('edit-options-display' => array('label', 'id')),
|
||||
);
|
||||
|
||||
// Stolen from entity_views_plugin_row_entity_view.
|
||||
$entity_info = entity_get_info($this->field_entity_type);
|
||||
$options = array();
|
||||
if (!empty($entity_info['view modes'])) {
|
||||
foreach ($entity_info['view modes'] as $mode => $settings) {
|
||||
$options[$mode] = $settings['label'];
|
||||
}
|
||||
}
|
||||
|
||||
if (count($options) > 1) {
|
||||
$form['view_mode'] = array(
|
||||
'#type' => 'select',
|
||||
'#options' => $options,
|
||||
'#title' => t('View mode'),
|
||||
'#default_value' => $this->options['view_mode'],
|
||||
'#dependency' => array('edit-options-display' => array('view')),
|
||||
);
|
||||
}
|
||||
else {
|
||||
$form['view_mode'] = array(
|
||||
'#type' => 'value',
|
||||
'#value' => $options ? key($options) : 'default',
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
public function render($values) {
|
||||
return EntityFieldHandlerHelper::render($this, $values);
|
||||
}
|
||||
|
||||
/**
|
||||
* Render a value as a link to the entity if applicable.
|
||||
*
|
||||
* @param $value
|
||||
* The value to render.
|
||||
* @param $values
|
||||
* The values for the current row retrieved from the Views query, as an
|
||||
* object.
|
||||
*/
|
||||
public function render_entity_link($entity, $values) {
|
||||
$type = $this->field_entity_type;
|
||||
if (!is_object($entity) && isset($entity) && $entity !== FALSE) {
|
||||
$entity = entity_load_single($type, $entity);
|
||||
}
|
||||
if (!$entity) {
|
||||
return '';
|
||||
}
|
||||
$render = $this->render_single_value($entity, $values);
|
||||
if (!$this->options['link_to_entity'] || $this->options['display'] == 'view') {
|
||||
return $render;
|
||||
}
|
||||
if (is_object($entity) && ($url = entity_uri($type, $entity))) {
|
||||
return l($render, $url['path'], array('html' => TRUE) + $url['options']);
|
||||
}
|
||||
return $render;
|
||||
}
|
||||
|
||||
/**
|
||||
* Render a single field value.
|
||||
*/
|
||||
public function render_single_value($entity, $values) {
|
||||
$type = $this->field_entity_type;
|
||||
if (!is_object($entity) && isset($entity) && $entity !== FALSE) {
|
||||
$entity = entity_load_single($type, $entity);
|
||||
}
|
||||
if (!$entity) {
|
||||
return '';
|
||||
}
|
||||
|
||||
if ($this->options['display'] === 'view') {
|
||||
$entity_view = entity_view($type, array($entity), $this->options['view_mode']);
|
||||
return render($entity_view);
|
||||
}
|
||||
|
||||
if ($this->options['display'] == 'label') {
|
||||
$value = entity_label($type, $entity);
|
||||
}
|
||||
// Either $options[display] == 'id', or we have no label.
|
||||
if (empty($value)) {
|
||||
$value = entity_id($type, $entity);
|
||||
}
|
||||
$value = $this->sanitize_value($value);
|
||||
|
||||
return $value;
|
||||
}
|
||||
|
||||
}
|
||||
@@ -0,0 +1,105 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* @file
|
||||
* Contains the entity_views_handler_field_field class.
|
||||
*/
|
||||
|
||||
/**
|
||||
* A handler to provide proper displays for Field API fields.
|
||||
*
|
||||
* Overrides the default Views handler to retrieve the data from an entity via
|
||||
* data selection.
|
||||
*
|
||||
* This handler may only be used in conjunction with data selection based Views
|
||||
* tables or other base tables using a query plugin that supports data
|
||||
* selection.
|
||||
*
|
||||
* @see entity_views_field_definition()
|
||||
* @ingroup views_field_handlers
|
||||
*/
|
||||
class entity_views_handler_field_field extends views_handler_field_field {
|
||||
|
||||
/**
|
||||
* Stores the entity type of the result entities.
|
||||
*/
|
||||
public $entity_type;
|
||||
|
||||
/**
|
||||
* Stores the result entities' metadata wrappers.
|
||||
*/
|
||||
public $wrappers = array();
|
||||
|
||||
/**
|
||||
* The entity for which this field is currently rendered.
|
||||
*/
|
||||
public $entity;
|
||||
|
||||
/**
|
||||
* Return TRUE if the user has access to view this field.
|
||||
*/
|
||||
public function access() {
|
||||
return field_access('view', $this->field_info, $this->definition['entity type']);
|
||||
}
|
||||
|
||||
/**
|
||||
* Overridden to add the field for the entity ID (if necessary).
|
||||
*/
|
||||
public function query($use_groupby = FALSE) {
|
||||
EntityFieldHandlerHelper::query($this);
|
||||
}
|
||||
|
||||
/**
|
||||
* Adds a click-sort to the query.
|
||||
*/
|
||||
public function click_sort($order) {
|
||||
EntityFieldHandlerHelper::click_sort($this, $order);
|
||||
}
|
||||
|
||||
/**
|
||||
* Override so it doesn't do any harm (or, anything at all).
|
||||
*/
|
||||
public function post_execute(&$values) { }
|
||||
|
||||
/**
|
||||
* Load the entities for all rows that are about to be displayed.
|
||||
*/
|
||||
public function pre_render(&$values) {
|
||||
parent::pre_render($values);
|
||||
EntityFieldHandlerHelper::pre_render($this, $values, TRUE);
|
||||
}
|
||||
|
||||
/**
|
||||
* Overridden to get the items our way.
|
||||
*/
|
||||
public function get_items($values) {
|
||||
$items = array();
|
||||
// Set the entity type for the parent handler.
|
||||
$values->_field_data[$this->field_alias]['entity_type'] = $this->entity_type;
|
||||
// We need special handling for lists of entities as the base.
|
||||
$entities = EntityFieldHandlerHelper::get_value($this, $values, 'entity object');
|
||||
if (!is_array($entities)) {
|
||||
$entities = $entities ? array($entities) : array();
|
||||
}
|
||||
foreach ($entities as $entity) {
|
||||
// Only try to render the field if it is even present on this bundle.
|
||||
// Otherwise, field_view_field() will trigger a fatal.
|
||||
list (, , $bundle) = entity_extract_ids($this->entity_type, $entity);
|
||||
if (field_info_instance($this->entity_type, $this->definition['field_name'], $bundle)) {
|
||||
// Set the currently rendered entity.
|
||||
$values->_field_data[$this->field_alias]['entity'] = $entity;
|
||||
$items = array_merge($items, $this->set_items($values, $this->view->row_index));
|
||||
}
|
||||
}
|
||||
return $items;
|
||||
}
|
||||
|
||||
/**
|
||||
* Overridden to force displaying multiple values in a single row.
|
||||
*/
|
||||
function multiple_options_form(&$form, &$form_state) {
|
||||
parent::multiple_options_form($form, $form_state);
|
||||
$form['group_rows']['#default_value'] = TRUE;
|
||||
$form['group_rows']['#disabled'] = TRUE;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,99 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* @file
|
||||
* Contains the entity_views_handler_field_numeric class.
|
||||
*/
|
||||
|
||||
/**
|
||||
* Render a field as a numeric value.
|
||||
*
|
||||
* Overrides the default Views handler to retrieve the data from an entity via
|
||||
* data selection.
|
||||
*
|
||||
* This handler may only be used in conjunction with data selection based Views
|
||||
* tables or other base tables using a query plugin that supports data
|
||||
* selection.
|
||||
*
|
||||
* @see entity_views_field_definition()
|
||||
* @ingroup views_field_handlers
|
||||
*/
|
||||
class entity_views_handler_field_numeric extends views_handler_field_numeric {
|
||||
|
||||
/**
|
||||
* Stores the entity type of the result entities.
|
||||
*/
|
||||
public $entity_type;
|
||||
|
||||
/**
|
||||
* Stores the result entities' metadata wrappers.
|
||||
*/
|
||||
public $wrappers = array();
|
||||
|
||||
/**
|
||||
* Stores the current value when rendering list fields.
|
||||
*/
|
||||
public $current_value;
|
||||
|
||||
/**
|
||||
* Overridden to add the field for the entity ID (if necessary).
|
||||
*/
|
||||
public function query() {
|
||||
EntityFieldHandlerHelper::query($this);
|
||||
}
|
||||
|
||||
/**
|
||||
* Adds a click-sort to the query.
|
||||
*/
|
||||
public function click_sort($order) {
|
||||
EntityFieldHandlerHelper::click_sort($this, $order);
|
||||
}
|
||||
|
||||
/**
|
||||
* Load the entities for all rows that are about to be displayed.
|
||||
*/
|
||||
public function pre_render(&$values) {
|
||||
parent::pre_render($values);
|
||||
EntityFieldHandlerHelper::pre_render($this, $values);
|
||||
}
|
||||
|
||||
/**
|
||||
* Overridden to use a metadata wrapper.
|
||||
*/
|
||||
public function get_value($values, $field = NULL) {
|
||||
return EntityFieldHandlerHelper::get_value($this, $values, $field);
|
||||
}
|
||||
|
||||
/**
|
||||
* Provide options for this handler.
|
||||
*/
|
||||
public function option_definition() {
|
||||
return parent::option_definition() + EntityFieldHandlerHelper::option_definition($this);
|
||||
}
|
||||
|
||||
/**
|
||||
* Provide a options form for this handler.
|
||||
*/
|
||||
public function options_form(&$form, &$form_state) {
|
||||
parent::options_form($form, $form_state);
|
||||
EntityFieldHandlerHelper::options_form($this, $form, $form_state);
|
||||
}
|
||||
|
||||
/**
|
||||
* Render the field.
|
||||
*
|
||||
* @param $values
|
||||
* The values retrieved from the database.
|
||||
*/
|
||||
public function render($values) {
|
||||
return EntityFieldHandlerHelper::render($this, $values);
|
||||
}
|
||||
|
||||
/**
|
||||
* Render a single field value.
|
||||
*/
|
||||
public function render_single_value($value, $values) {
|
||||
return parent::render($values);
|
||||
}
|
||||
|
||||
}
|
||||
@@ -0,0 +1,119 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* @file
|
||||
* Contains the entity_views_handler_field_options class.
|
||||
*/
|
||||
|
||||
/**
|
||||
* A handler to provide proper displays for values chosen from a set of options.
|
||||
*
|
||||
* This handler may only be used in conjunction with data selection based Views
|
||||
* tables or other base tables using a query plugin that supports data
|
||||
* selection.
|
||||
*
|
||||
* @see entity_views_field_definition()
|
||||
* @ingroup views_field_handlers
|
||||
*/
|
||||
class entity_views_handler_field_options extends views_handler_field {
|
||||
|
||||
/**
|
||||
* Stores the entity type of the result entities.
|
||||
*/
|
||||
public $entity_type;
|
||||
|
||||
/**
|
||||
* Stores the result entities' metadata wrappers.
|
||||
*/
|
||||
public $wrappers = array();
|
||||
|
||||
/**
|
||||
* Stores the current value when rendering list fields.
|
||||
*/
|
||||
public $current_value;
|
||||
|
||||
/**
|
||||
* The key / name mapping for the options.
|
||||
*/
|
||||
public $option_list;
|
||||
|
||||
/**
|
||||
* Overridden to add the field for the entity ID (if necessary).
|
||||
*/
|
||||
public function query() {
|
||||
EntityFieldHandlerHelper::query($this);
|
||||
}
|
||||
|
||||
/**
|
||||
* Adds a click-sort to the query.
|
||||
*/
|
||||
public function click_sort($order) {
|
||||
EntityFieldHandlerHelper::click_sort($this, $order);
|
||||
}
|
||||
|
||||
/**
|
||||
* Load the entities for all rows that are about to be displayed.
|
||||
*/
|
||||
public function pre_render(&$values) {
|
||||
parent::pre_render($values);
|
||||
EntityFieldHandlerHelper::pre_render($this, $values);
|
||||
}
|
||||
|
||||
/**
|
||||
* Overridden to use a metadata wrapper.
|
||||
*/
|
||||
public function get_value($values, $field = NULL) {
|
||||
return EntityFieldHandlerHelper::get_value($this, $values, $field);
|
||||
}
|
||||
|
||||
/**
|
||||
* Specifies the options this handler uses.
|
||||
*/
|
||||
public function option_definition() {
|
||||
$options = parent::option_definition();
|
||||
$options += EntityFieldHandlerHelper::option_definition($this);
|
||||
$options['format_name'] = array('default' => TRUE);
|
||||
return $options;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns an option form for setting this handler's options.
|
||||
*/
|
||||
public function options_form(&$form, &$form_state) {
|
||||
parent::options_form($form, $form_state);
|
||||
EntityFieldHandlerHelper::options_form($this, $form, $form_state);
|
||||
|
||||
$form['format_name'] = array(
|
||||
'#title' => t('Use human-readable name'),
|
||||
'#type' => 'checkbox',
|
||||
'#description' => t("If this is checked, the values' names will be displayed instead of their internal identifiers."),
|
||||
'#default_value' => $this->options['format_name'],
|
||||
'#weight' => -5,
|
||||
);
|
||||
}
|
||||
|
||||
public function render($values) {
|
||||
return EntityFieldHandlerHelper::render($this, $values);
|
||||
}
|
||||
|
||||
/**
|
||||
* Render a single field value.
|
||||
*/
|
||||
public function render_single_value($value, $values) {
|
||||
if (!isset($this->option_list)) {
|
||||
$this->option_list = array();
|
||||
$callback = $this->definition['options callback'];
|
||||
if (is_callable($callback['function'])) {
|
||||
// If a selector is used, get the name of the selected field.
|
||||
$field_name = EntityFieldHandlerHelper::get_selector_field_name($this->real_field);
|
||||
$this->option_list = call_user_func($callback['function'], $field_name, $callback['info'], 'view');
|
||||
}
|
||||
}
|
||||
if ($this->options['format_name'] && isset($this->option_list[$value])) {
|
||||
$value = $this->option_list[$value];
|
||||
}
|
||||
|
||||
return $this->sanitize_value($value);
|
||||
}
|
||||
|
||||
}
|
||||
@@ -0,0 +1,99 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* @file
|
||||
* Contains the entity_views_handler_field_text class.
|
||||
*/
|
||||
|
||||
/**
|
||||
* A handler to display text data.
|
||||
*
|
||||
* Overrides the default Views handler to retrieve the data from an entity via
|
||||
* data selection.
|
||||
*
|
||||
* This handler may only be used in conjunction with data selection based Views
|
||||
* tables or other base tables using a query plugin that supports data
|
||||
* selection.
|
||||
*
|
||||
* @see entity_views_field_definition()
|
||||
* @ingroup views_field_handlers
|
||||
*/
|
||||
class entity_views_handler_field_text extends views_handler_field {
|
||||
|
||||
/**
|
||||
* Stores the entity type of the result entities.
|
||||
*/
|
||||
public $entity_type;
|
||||
|
||||
/**
|
||||
* Stores the result entities' metadata wrappers.
|
||||
*/
|
||||
public $wrappers = array();
|
||||
|
||||
/**
|
||||
* Stores the current value when rendering list fields.
|
||||
*/
|
||||
public $current_value;
|
||||
|
||||
/**
|
||||
* Overridden to add the field for the entity ID (if necessary).
|
||||
*/
|
||||
public function query() {
|
||||
EntityFieldHandlerHelper::query($this);
|
||||
}
|
||||
|
||||
/**
|
||||
* Adds a click-sort to the query.
|
||||
*/
|
||||
public function click_sort($order) {
|
||||
EntityFieldHandlerHelper::click_sort($this, $order);
|
||||
}
|
||||
|
||||
/**
|
||||
* Load the entities for all rows that are about to be displayed.
|
||||
*/
|
||||
public function pre_render(&$values) {
|
||||
parent::pre_render($values);
|
||||
EntityFieldHandlerHelper::pre_render($this, $values);
|
||||
}
|
||||
|
||||
/**
|
||||
* Overridden to use a metadata wrapper.
|
||||
*/
|
||||
public function get_value($values, $field = NULL) {
|
||||
return EntityFieldHandlerHelper::get_value($this, $values, $field);
|
||||
}
|
||||
|
||||
/**
|
||||
* Provide options for this handler.
|
||||
*/
|
||||
public function option_definition() {
|
||||
return parent::option_definition() + EntityFieldHandlerHelper::option_definition($this);
|
||||
}
|
||||
|
||||
/**
|
||||
* Provide a options form for this handler.
|
||||
*/
|
||||
public function options_form(&$form, &$form_state) {
|
||||
parent::options_form($form, $form_state);
|
||||
EntityFieldHandlerHelper::options_form($this, $form, $form_state);
|
||||
}
|
||||
|
||||
/**
|
||||
* Render the field.
|
||||
*
|
||||
* @param $values
|
||||
* The values retrieved from the database.
|
||||
*/
|
||||
public function render($values) {
|
||||
return EntityFieldHandlerHelper::render($this, $values);
|
||||
}
|
||||
|
||||
/**
|
||||
* Render a single field value.
|
||||
*/
|
||||
public function render_single_value($value, $values) {
|
||||
return $this->sanitize_value($value, 'xss');
|
||||
}
|
||||
|
||||
}
|
||||
@@ -0,0 +1,99 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* @file
|
||||
* Contains the entity_views_handler_field_uri class.
|
||||
*/
|
||||
|
||||
/**
|
||||
* Field handler to provide simple renderer that turns a URL into a clickable link.
|
||||
*
|
||||
* Overrides the default Views handler to retrieve the data from an entity via
|
||||
* data selection.
|
||||
*
|
||||
* This handler may only be used in conjunction with data selection based Views
|
||||
* tables or other base tables using a query plugin that supports data
|
||||
* selection.
|
||||
*
|
||||
* @see entity_views_field_definition()
|
||||
* @ingroup views_field_handlers
|
||||
*/
|
||||
class entity_views_handler_field_uri extends views_handler_field_url {
|
||||
|
||||
/**
|
||||
* Stores the entity type of the result entities.
|
||||
*/
|
||||
public $entity_type;
|
||||
|
||||
/**
|
||||
* Stores the result entities' metadata wrappers.
|
||||
*/
|
||||
public $wrappers = array();
|
||||
|
||||
/**
|
||||
* Stores the current value when rendering list fields.
|
||||
*/
|
||||
public $current_value;
|
||||
|
||||
/**
|
||||
* Overridden to add the field for the entity ID (if necessary).
|
||||
*/
|
||||
public function query() {
|
||||
EntityFieldHandlerHelper::query($this);
|
||||
}
|
||||
|
||||
/**
|
||||
* Adds a click-sort to the query.
|
||||
*/
|
||||
public function click_sort($order) {
|
||||
EntityFieldHandlerHelper::click_sort($this, $order);
|
||||
}
|
||||
|
||||
/**
|
||||
* Load the entities for all rows that are about to be displayed.
|
||||
*/
|
||||
public function pre_render(&$values) {
|
||||
parent::pre_render($values);
|
||||
EntityFieldHandlerHelper::pre_render($this, $values);
|
||||
}
|
||||
|
||||
/**
|
||||
* Overridden to use a metadata wrapper.
|
||||
*/
|
||||
public function get_value($values, $field = NULL) {
|
||||
return EntityFieldHandlerHelper::get_value($this, $values, $field);
|
||||
}
|
||||
|
||||
/**
|
||||
* Provide options for this handler.
|
||||
*/
|
||||
public function option_definition() {
|
||||
return parent::option_definition() + EntityFieldHandlerHelper::option_definition($this);
|
||||
}
|
||||
|
||||
/**
|
||||
* Provide a options form for this handler.
|
||||
*/
|
||||
public function options_form(&$form, &$form_state) {
|
||||
parent::options_form($form, $form_state);
|
||||
EntityFieldHandlerHelper::options_form($this, $form, $form_state);
|
||||
}
|
||||
|
||||
/**
|
||||
* Render the field.
|
||||
*
|
||||
* @param $values
|
||||
* The values retrieved from the database.
|
||||
*/
|
||||
public function render($values) {
|
||||
return EntityFieldHandlerHelper::render($this, $values);
|
||||
}
|
||||
|
||||
/**
|
||||
* Render a single field value.
|
||||
*/
|
||||
public function render_single_value($value, $values) {
|
||||
return parent::render($values);
|
||||
}
|
||||
|
||||
}
|
||||
@@ -0,0 +1,51 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* @file
|
||||
* Contains the entity_views_handler_relationship class.
|
||||
*/
|
||||
|
||||
/**
|
||||
* Relationship handler for data selection tables.
|
||||
*
|
||||
* This handler may only be used in conjunction with data selection based Views
|
||||
* tables or other base tables using a query plugin that supports data
|
||||
* selection.
|
||||
*
|
||||
* @see entity_views_field_definition()
|
||||
* @ingroup views_field_handlers
|
||||
*/
|
||||
class entity_views_handler_relationship extends views_handler_relationship {
|
||||
|
||||
/**
|
||||
* Slightly modify the options form provided by the parent handler.
|
||||
*/
|
||||
public function options_form(&$form, &$form_state) {
|
||||
parent::options_form($form, $form_state);
|
||||
// This won't work with data selector-based relationships, as we only
|
||||
// inspect those *after* the results are known.
|
||||
$form['required']['#access'] = FALSE;
|
||||
// Notify the user of our restrictions regarding lists of entities, if
|
||||
// appropriate.
|
||||
if (!empty($this->definition['multiple'])) {
|
||||
$form['multiple_note'] = array(
|
||||
'#markup' => t('<strong>Note:</strong> This is a multi-valued relationship, which is currently not supported. ' .
|
||||
'Only the first related entity will be shown.'),
|
||||
'#weight' => -5,
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Called to implement a relationship in a query.
|
||||
*
|
||||
* As we don't add any data to the query itself, we don't have to do anything
|
||||
* here. Views just don't thinks we have been called unless we set our
|
||||
* $alias property. Otherwise, this override is just here to keep PHP from
|
||||
* blowing up by calling inexistent methods on the query plugin.
|
||||
*/
|
||||
public function query() {
|
||||
$this->alias = $this->options['id'];
|
||||
}
|
||||
|
||||
}
|
||||
@@ -0,0 +1,117 @@
|
||||
<?php
|
||||
/**
|
||||
* @file
|
||||
* Contains the entity_views_handler_relationship_by_bundle class.
|
||||
*/
|
||||
|
||||
/**
|
||||
* Relationship handler for entity relationships that may limit the join to one or more bundles.
|
||||
*
|
||||
* This handler is only applicable for entities that are using bundle entities,
|
||||
* i.e. entities having the 'bundle of' entity info key set.
|
||||
*
|
||||
* For example, this allows a relationship from users to profiles of a certain
|
||||
* profile type.
|
||||
*
|
||||
* @see entity_crud_hook_entity_info()
|
||||
* @ingroup views_field_handlers
|
||||
*/
|
||||
class entity_views_handler_relationship_by_bundle extends views_handler_relationship {
|
||||
function option_definition() {
|
||||
$options = parent::option_definition();
|
||||
$options['bundle_types'] = array('default' => array());
|
||||
|
||||
return $options;
|
||||
}
|
||||
|
||||
/**
|
||||
* Add an entity type option.
|
||||
*/
|
||||
function options_form(&$form, &$form_state) {
|
||||
parent::options_form($form, $form_state);
|
||||
|
||||
// Get the entity type and info from the table data for the base on the
|
||||
// right hand side of the relationship join.
|
||||
$table_data = views_fetch_data($this->definition['base']);
|
||||
$entity_type = $table_data['table']['entity type'];
|
||||
$entity_info = entity_get_info($entity_type);
|
||||
|
||||
// Get the info of the bundle entity.
|
||||
foreach (entity_get_info() as $type => $info) {
|
||||
if (isset($info['bundle of']) && $info['bundle of'] == $entity_type) {
|
||||
$entity_bundle_info = $info;
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
$plural_label = isset($entity_bundle_info['plural label']) ? $entity_bundle_info['plural label'] : $entity_bundle_info['label'] . 's';
|
||||
$bundle_options = array();
|
||||
foreach ($entity_info['bundles'] as $name => $info) {
|
||||
$bundle_options[$name] = $info['label'];
|
||||
}
|
||||
|
||||
$form['bundle_types'] = array(
|
||||
'#title' => $plural_label,
|
||||
'#type' => 'checkboxes',
|
||||
'#description' => t('Restrict this relationship to one or more @bundles.', array('@bundles' => strtolower($entity_bundle_info['plural label']))),
|
||||
'#options' => $bundle_options,
|
||||
'#default_value' => $this->options['bundle_types'],
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Make sure only checked bundle types are left.
|
||||
*/
|
||||
function options_submit(&$form, &$form_state) {
|
||||
$form_state['values']['options']['bundle_types'] = array_filter($form_state['values']['options']['bundle_types']);
|
||||
parent::options_submit($form, $form_state);
|
||||
}
|
||||
|
||||
/**
|
||||
* Called to implement a relationship in a query.
|
||||
*
|
||||
* Mostly the same as the parent method, except we add an extra clause to
|
||||
* the join.
|
||||
*/
|
||||
function query() {
|
||||
$table_data = views_fetch_data($this->definition['base']);
|
||||
$base_field = empty($this->definition['base field']) ? $table_data['table']['base']['field'] : $this->definition['base field'];
|
||||
$this->ensure_my_table();
|
||||
|
||||
$def = $this->definition;
|
||||
$def['table'] = $this->definition['base'];
|
||||
$def['field'] = $base_field;
|
||||
$def['left_table'] = $this->table_alias;
|
||||
$def['left_field'] = $this->field;
|
||||
if (!empty($this->options['required'])) {
|
||||
$def['type'] = 'INNER';
|
||||
}
|
||||
|
||||
// Add an extra clause to the join if there are bundle types selected.
|
||||
if ($this->options['bundle_types']) {
|
||||
$entity_info = entity_get_info($table_data['table']['entity type']);
|
||||
$def['extra'] = array(
|
||||
array(
|
||||
// The table and the IN operator are implicit.
|
||||
'field' => $entity_info['bundle keys']['bundle'],
|
||||
'value' => $this->options['bundle_types'],
|
||||
),
|
||||
);
|
||||
}
|
||||
|
||||
if (!empty($def['join_handler']) && class_exists($def['join_handler'])) {
|
||||
$join = new $def['join_handler'];
|
||||
}
|
||||
else {
|
||||
$join = new views_join();
|
||||
}
|
||||
|
||||
$join->definition = $def;
|
||||
$join->construct();
|
||||
$join->adjusted = TRUE;
|
||||
|
||||
// Use a short alias for this.
|
||||
$alias = $def['table'] . '_' . $this->table;
|
||||
$this->alias = $this->query->add_relationship($alias, $join, $this->definition['base'], $this->relationship);
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user