views_field_default_views_data(FieldStorageConfigInterface $field_storage)
Default views data implementation for a field.
Parameters
\Drupal\field\FieldStorageConfigInterface $field_storage: The field definition.
Return value
array The default views data for the field.
File
- core/modules/views/views.views.inc, line 287
- Provide views data that isn't tied to any other module.
Code
function views_field_default_views_data(FieldStorageConfigInterface $field_storage) { $data = array(); // Check the field type is available. if (!\Drupal::service('plugin.manager.field.field_type')->hasDefinition($field_storage->getType())) { return $data; } // Check the field storage has fields. if (!$field_storage->getBundles()) { return $data; } // Ignore custom storage too. if ($field_storage->hasCustomStorage()) { return $data; } // Check whether the entity type storage is supported. $storage = _views_field_get_entity_type_storage($field_storage); if (!$storage) { return $data; } $field_name = $field_storage->getName(); $field_columns = $field_storage->getColumns(); // Grab information about the entity type tables. // We need to join to both the base table and the data table, if available. $entity_manager = \Drupal::entityManager(); $entity_type_id = $field_storage->getTargetEntityTypeId(); $entity_type = $entity_manager->getDefinition($entity_type_id); if (!$base_table = $entity_type->getBaseTable()) { // We cannot do anything if for some reason there is no base table. return $data; } $entity_tables = array($base_table => $entity_type_id); // Some entities may not have a data table. $data_table = $entity_type->getDataTable(); if ($data_table) { $entity_tables[$data_table] = $entity_type_id; } $entity_revision_table = $entity_type->getRevisionTable(); $supports_revisions = $entity_type->hasKey('revision') && $entity_revision_table; if ($supports_revisions) { $entity_tables[$entity_revision_table] = $entity_type_id; $entity_revision_data_table = $entity_type->getRevisionDataTable(); if ($entity_revision_data_table) { $entity_tables[$entity_revision_data_table] = $entity_type_id; } } // Description of the field tables. // @todo Generalize this code to make it work with any table layout. See // https://www.drupal.org/node/2079019. $table_mapping = $storage->getTableMapping(); $field_tables = array( EntityStorageInterface::FIELD_LOAD_CURRENT => array( 'table' => $table_mapping->getDedicatedDataTableName($field_storage), 'alias' => "{$entity_type_id}__{$field_name}", ), ); if ($supports_revisions) { $field_tables[EntityStorageInterface::FIELD_LOAD_REVISION] = array( 'table' => $table_mapping->getDedicatedRevisionTableName($field_storage), 'alias' => "{$entity_type_id}_revision__{$field_name}", ); } // Build the relationships between the field table and the entity tables. $table_alias = $field_tables[EntityStorageInterface::FIELD_LOAD_CURRENT]['alias']; if ($data_table) { // Tell Views how to join to the base table, via the data table. $data[$table_alias]['table']['join'][$data_table] = array( 'table' => $table_mapping->getDedicatedDataTableName($field_storage), 'left_field' => $entity_type->getKey('id'), 'field' => 'entity_id', 'extra' => array( array('field' => 'deleted', 'value' => 0, 'numeric' => TRUE), array('left_field' => 'langcode', 'field' => 'langcode'), ), ); } else { // If there is no data table, just join directly. $data[$table_alias]['table']['join'][$base_table] = array( 'table' => $table_mapping->getDedicatedDataTableName($field_storage), 'left_field' => $entity_type->getKey('id'), 'field' => 'entity_id', 'extra' => array( array('field' => 'deleted', 'value' => 0, 'numeric' => TRUE), ), ); } if ($supports_revisions) { $table_alias = $field_tables[EntityStorageInterface::FIELD_LOAD_REVISION]['alias']; if ($entity_revision_data_table) { // Tell Views how to join to the revision table, via the data table. $data[$table_alias]['table']['join'][$entity_revision_data_table] = array( 'table' => $table_mapping->getDedicatedRevisionTableName($field_storage), 'left_field' => $entity_type->getKey('revision'), 'field' => 'revision_id', 'extra' => array( array('field' => 'deleted', 'value' => 0, 'numeric' => TRUE), array('left_field' => 'langcode', 'field' => 'langcode'), ), ); } else { // If there is no data table, just join directly. $data[$table_alias]['table']['join'][$entity_revision_table] = array( 'table' => $table_mapping->getDedicatedRevisionTableName($field_storage), 'left_field' => $entity_type->getKey('revision'), 'field' => 'revision_id', 'extra' => array( array('field' => 'deleted', 'value' => 0, 'numeric' => TRUE), ), ); } } $group_name = $entity_type->getLabel(); // Get the list of bundles the field appears in. $bundles_names = $field_storage->getBundles(); // Build the list of additional fields to add to queries. $add_fields = array('delta', 'langcode', 'bundle'); foreach (array_keys($field_columns) as $column) { $add_fields[] = $table_mapping->getFieldColumnName($field_storage, $column); } // Determine the label to use for the field. We don't have a label available // at the field level, so we just go through all fields and take the one // which is used the most frequently. list($label, $all_labels) = views_entity_field_label($entity_type_id, $field_name); // Expose data for the field as a whole. foreach ($field_tables as $type => $table_info) { $table = $table_info['table']; $table_alias = $table_info['alias']; if ($type == EntityStorageInterface::FIELD_LOAD_CURRENT) { $group = $group_name; $field_alias = $field_name; } else { $group = t('@group (historical data)', array('@group' => $group_name)); $field_alias = $field_name . '-revision_id'; } $data[$table_alias][$field_alias] = array( 'group' => $group, 'title' => $label, 'title short' => $label, 'help' => t('Appears in: @bundles.', array('@bundles' => implode(', ', $bundles_names))), ); // Go through and create a list of aliases for all possible combinations of // entity type + name. $aliases = array(); $also_known = array(); foreach ($all_labels as $label_name => $true) { if ($type == EntityStorageInterface::FIELD_LOAD_CURRENT) { if ($label != $label_name) { $aliases[] = array( 'base' => $base_table, 'group' => $group_name, 'title' => $label_name, 'help' => t('This is an alias of @group: @field.', array('@group' => $group_name, '@field' => $label)), ); $also_known[] = t('@group: @field', array('@group' => $group_name, '@field' => $label_name)); } } elseif ($supports_revisions && $label != $label_name) { $aliases[] = array( 'base' => $table, 'group' => t('@group (historical data)', array('@group' => $group_name)), 'title' => $label_name, 'help' => t('This is an alias of @group: @field.', array('@group' => $group_name, '@field' => $label)), ); $also_known[] = t('@group (historical data): @field', array('@group' => $group_name, '@field' => $label_name)); } } if ($aliases) { $data[$table_alias][$field_alias]['aliases'] = $aliases; // The $also_known variable contains markup that is HTML escaped and that // loses safeness when imploded. The help text is used in #description // and therefore XSS admin filtered by default. Escaped HTML is not // altered by XSS filtering, therefore it is safe to just concatenate the // strings. Afterwards we mark the entire string as safe, so it won't be // escaped, no matter where it is used. // Considering the dual use of this help data (both as metadata and as // help text), other patterns such as use of #markup would not be correct // here. $data[$table_alias][$field_alias]['help'] = Markup::create($data[$table_alias][$field_alias]['help'] . ' ' . t('Also known as:') . ' ' . implode(', ', $also_known)); } $keys = array_keys($field_columns); $real_field = reset($keys); $data[$table_alias][$field_alias]['field'] = array( 'table' => $table, 'id' => 'field', 'field_name' => $field_name, 'entity_type' => $entity_type_id, // Provide a real field for group by. 'real field' => $field_alias . '_' . $real_field, 'additional fields' => $add_fields, // Default the element type to div, let the UI change it if necessary. 'element type' => 'div', 'is revision' => $type == EntityStorageInterface::FIELD_LOAD_REVISION, ); } // Expose data for each field property individually. foreach ($field_columns as $column => $attributes) { $allow_sort = TRUE; // Identify likely filters and arguments for each column based on field type. switch ($attributes['type']) { case 'int': case 'mediumint': case 'tinyint': case 'bigint': case 'serial': case 'numeric': case 'float': $filter = 'numeric'; $argument = 'numeric'; $sort = 'standard'; if ($field_storage->getType() == 'boolean') { $filter = 'boolean'; } break; case 'text': case 'blob': // It does not make sense to sort by blob or text. $allow_sort = FALSE; default: $filter = 'string'; $argument = 'string'; $sort = 'standard'; break; } if (count($field_columns) == 1 || $column == 'value') { $title = t('@label (@name)', array('@label' => $label, '@name' => $field_name)); $title_short = $label; } else { $title = t('@label (@name:@column)', array('@label' => $label, '@name' => $field_name, '@column' => $column)); $title_short = t('@label:@column', array('@label' => $label, '@column' => $column)); } // Expose data for the property. foreach ($field_tables as $type => $table_info) { $table = $table_info['table']; $table_alias = $table_info['alias']; if ($type == EntityStorageInterface::FIELD_LOAD_CURRENT) { $group = $group_name; } else { $group = t('@group (historical data)', array('@group' => $group_name)); } $column_real_name = $table_mapping->getFieldColumnName($field_storage, $column); // Load all the fields from the table by default. $additional_fields = $table_mapping->getAllColumns($table); $data[$table_alias][$column_real_name] = array( 'group' => $group, 'title' => $title, 'title short' => $title_short, 'help' => t('Appears in: @bundles.', array('@bundles' => implode(', ', $bundles_names))), ); // Go through and create a list of aliases for all possible combinations of // entity type + name. $aliases = array(); $also_known = array(); foreach ($all_labels as $label_name => $true) { if ($label != $label_name) { if (count($field_columns) == 1 || $column == 'value') { $alias_title = t('@label (@name)', array('@label' => $label_name, '@name' => $field_name)); } else { $alias_title = t('@label (@name:@column)', array('@label' => $label_name, '@name' => $field_name, '@column' => $column)); } $aliases[] = array( 'group' => $group_name, 'title' => $alias_title, 'help' => t('This is an alias of @group: @field.', array('@group' => $group_name, '@field' => $title)), ); $also_known[] = t('@group: @field', array('@group' => $group_name, '@field' => $title)); } } if ($aliases) { $data[$table_alias][$column_real_name]['aliases'] = $aliases; // The $also_known variable contains markup that is HTML escaped and // that loses safeness when imploded. The help text is used in // #description and therefore XSS admin filtered by default. Escaped // HTML is not altered by XSS filtering, therefore it is safe to just // concatenate the strings. Afterwards we mark the entire string as // safe, so it won't be escaped, no matter where it is used. // Considering the dual use of this help data (both as metadata and as // help text), other patterns such as use of #markup would not be // correct here. $data[$table_alias][$column_real_name]['help'] = Markup::create($data[$table_alias][$column_real_name]['help'] . ' ' . t('Also known as:') . ' ' . implode(', ', $also_known)); } $data[$table_alias][$column_real_name]['argument'] = array( 'field' => $column_real_name, 'table' => $table, 'id' => $argument, 'additional fields' => $additional_fields, 'field_name' => $field_name, 'entity_type' => $entity_type_id, 'empty field name' => t('- No value -'), ); $data[$table_alias][$column_real_name]['filter'] = array( 'field' => $column_real_name, 'table' => $table, 'id' => $filter, 'additional fields' => $additional_fields, 'field_name' => $field_name, 'entity_type' => $entity_type_id, 'allow empty' => TRUE, ); if (!empty($allow_sort)) { $data[$table_alias][$column_real_name]['sort'] = array( 'field' => $column_real_name, 'table' => $table, 'id' => $sort, 'additional fields' => $additional_fields, 'field_name' => $field_name, 'entity_type' => $entity_type_id, ); } // Set click sortable if there is a field definition. if (isset($data[$table_alias][$field_name]['field'])) { $data[$table_alias][$field_name]['field']['click sortable'] = $allow_sort; } // Expose additional delta column for multiple value fields. if ($field_storage->isMultiple()) { $title_delta = t('@label (@name:delta)', array('@label' => $label, '@name' => $field_name)); $title_short_delta = t('@label:delta', array('@label' => $label)); $data[$table_alias]['delta'] = array( 'group' => $group, 'title' => $title_delta, 'title short' => $title_short_delta, 'help' => t('Delta - Appears in: @bundles.', array('@bundles' => implode(', ', $bundles_names))), ); $data[$table_alias]['delta']['field'] = array( 'id' => 'numeric', ); $data[$table_alias]['delta']['argument'] = array( 'field' => 'delta', 'table' => $table, 'id' => 'numeric', 'additional fields' => $additional_fields, 'empty field name' => t('- No value -'), 'field_name' => $field_name, 'entity_type' => $entity_type_id, ); $data[$table_alias]['delta']['filter'] = array( 'field' => 'delta', 'table' => $table, 'id' => 'numeric', 'additional fields' => $additional_fields, 'field_name' => $field_name, 'entity_type' => $entity_type_id, 'allow empty' => TRUE, ); $data[$table_alias]['delta']['sort'] = array( 'field' => 'delta', 'table' => $table, 'id' => 'standard', 'additional fields' => $additional_fields, 'field_name' => $field_name, 'entity_type' => $entity_type_id, ); } } } return $data; }
Please login to continue.