462 lines
15 KiB
PHP
462 lines
15 KiB
PHP
<?php
|
|
|
|
/**
|
|
* @file
|
|
* Administrative interface for custom field type creation.
|
|
*/
|
|
|
|
/**
|
|
* Page callback: Lists all defined fields for quick reference.
|
|
*
|
|
* @see field_ui_menu()
|
|
*/
|
|
function field_ui_fields_list() {
|
|
$instances = field_info_instances();
|
|
$field_types = field_info_field_types();
|
|
$bundles = entity_get_bundles();
|
|
$entity_manager = Drupal::entityManager();
|
|
|
|
$modules = system_rebuild_module_data();
|
|
|
|
$header = array(
|
|
t('Field name'),
|
|
array('data' => t('Field type'), 'class' => array(RESPONSIVE_PRIORITY_MEDIUM)),
|
|
t('Used in'),
|
|
);
|
|
$rows = array();
|
|
foreach ($instances as $entity_type => $type_bundles) {
|
|
foreach ($type_bundles as $bundle => $bundle_instances) {
|
|
foreach ($bundle_instances as $field_name => $instance) {
|
|
$field = field_info_field($field_name);
|
|
|
|
// Initialize the row if we encounter the field for the first time.
|
|
if (!isset($rows[$field_name])) {
|
|
$rows[$field_name]['class'] = $field['locked'] ? array('menu-disabled') : array('');
|
|
$rows[$field_name]['data'][0] = $field['locked'] ? t('@field_name (Locked)', array('@field_name' => $field_name)) : $field_name;
|
|
$module_name = $field_types[$field['type']]['module'];
|
|
$rows[$field_name]['data'][1] = $field_types[$field['type']]['label'] . ' ' . t('(module: !module)', array('!module' => $modules[$module_name]->info['name']));
|
|
}
|
|
|
|
// Add the current instance.
|
|
$admin_path = $entity_manager->getAdminPath($entity_type, $bundle);
|
|
$rows[$field_name]['data'][2][] = $admin_path ? l($bundles[$entity_type][$bundle]['label'], $admin_path . '/fields') : $bundles[$entity_type][$bundle]['label'];
|
|
}
|
|
}
|
|
}
|
|
foreach ($rows as $field_name => $cell) {
|
|
$rows[$field_name]['data'][2] = implode(', ', $cell['data'][2]);
|
|
}
|
|
if (empty($rows)) {
|
|
$output = t('No fields have been defined yet.');
|
|
}
|
|
else {
|
|
// Sort rows by field name.
|
|
ksort($rows);
|
|
$output = theme('table', array('header' => $header, 'rows' => $rows));
|
|
}
|
|
return $output;
|
|
}
|
|
|
|
/**
|
|
* Displays a message listing the inactive fields of a given bundle.
|
|
*/
|
|
function field_ui_inactive_message($entity_type, $bundle) {
|
|
$inactive_instances = field_ui_inactive_instances($entity_type, $bundle);
|
|
if (!empty($inactive_instances)) {
|
|
$field_types = field_info_field_types();
|
|
|
|
foreach ($inactive_instances as $field_name => $instance) {
|
|
$field = field_info_field($instance['field_name']);
|
|
$list[] = t('%field (@field_name) field requires the %field_type field type provided by %field_type_module module', array(
|
|
'%field' => $instance['label'],
|
|
'@field_name' => $instance['field_name'],
|
|
'%field_type' => isset($field_types[$field['type']]) ? $field_types[$field['type']]['label'] : $field['type'],
|
|
'%field_type_module' => $field['module'],
|
|
));
|
|
}
|
|
drupal_set_message(t('Inactive fields are not shown unless their providing modules are enabled. The following fields are not enabled: !list', array('!list' => theme('item_list', array('items' => $list)))), 'error');
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Determines the rendering order of an array representing a tree.
|
|
*
|
|
* Callback for array_reduce() within field_ui_table_pre_render().
|
|
*/
|
|
function _field_ui_reduce_order($array, $a) {
|
|
$array = !isset($array) ? array() : $array;
|
|
if ($a['name']) {
|
|
$array[] = $a['name'];
|
|
}
|
|
if (!empty($a['children'])) {
|
|
uasort($a['children'], 'drupal_sort_weight');
|
|
$array = array_merge($array, array_reduce($a['children'], '_field_ui_reduce_order'));
|
|
}
|
|
return $array;
|
|
}
|
|
|
|
/**
|
|
* Returns the region to which a row in the 'Manage fields' screen belongs.
|
|
*
|
|
* This function is used as a #region_callback in
|
|
* Drupal\field_ui\DisplayOverview::form(). It is called during
|
|
* field_ui_table_pre_render().
|
|
*/
|
|
function field_ui_field_overview_row_region($row) {
|
|
switch ($row['#row_type']) {
|
|
case 'field':
|
|
case 'extra_field':
|
|
return 'content';
|
|
case 'add_new_field':
|
|
// If no input in 'label', assume the row has not been dragged out of the
|
|
// 'add new' section.
|
|
return (!empty($row['label']['#value']) ? 'content' : 'hidden');
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Returns the region to which a row in the 'Manage display' screen belongs.
|
|
*
|
|
* This function is used as a #region_callback in
|
|
* Drupal\field_ui\FieldOverview::form(), and is called during
|
|
* field_ui_table_pre_render().
|
|
*/
|
|
function field_ui_display_overview_row_region($row) {
|
|
switch ($row['#row_type']) {
|
|
case 'field':
|
|
case 'extra_field':
|
|
return ($row['format']['type']['#value'] == 'hidden' ? 'hidden' : 'content');
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Render API callback: Performs pre-render tasks on field_ui_table elements.
|
|
*
|
|
* This function is assigned as a #pre_render callback in
|
|
* field_ui_element_info().
|
|
*
|
|
* @see drupal_render().
|
|
*/
|
|
function field_ui_table_pre_render($elements) {
|
|
$js_settings = array();
|
|
|
|
// For each region, build the tree structure from the weight and parenting
|
|
// data contained in the flat form structure, to determine row order and
|
|
// indentation.
|
|
$regions = $elements['#regions'];
|
|
$tree = array('' => array('name' => '', 'children' => array()));
|
|
$trees = array_fill_keys(array_keys($regions), $tree);
|
|
|
|
$parents = array();
|
|
$list = drupal_map_assoc(element_children($elements));
|
|
|
|
// Iterate on rows until we can build a known tree path for all of them.
|
|
while ($list) {
|
|
foreach ($list as $name) {
|
|
$row = &$elements[$name];
|
|
$parent = $row['parent_wrapper']['parent']['#value'];
|
|
// Proceed if parent is known.
|
|
if (empty($parent) || isset($parents[$parent])) {
|
|
// Grab parent, and remove the row from the next iteration.
|
|
$parents[$name] = $parent ? array_merge($parents[$parent], array($parent)) : array();
|
|
unset($list[$name]);
|
|
|
|
// Determine the region for the row.
|
|
$function = $row['#region_callback'];
|
|
$region_name = $function($row);
|
|
|
|
// Add the element in the tree.
|
|
$target = &$trees[$region_name][''];
|
|
foreach ($parents[$name] as $key) {
|
|
$target = &$target['children'][$key];
|
|
}
|
|
$target['children'][$name] = array('name' => $name, 'weight' => $row['weight']['#value']);
|
|
|
|
// Add tabledrag indentation to the first row cell.
|
|
if ($depth = count($parents[$name])) {
|
|
$children = element_children($row);
|
|
$cell = current($children);
|
|
$row[$cell]['#prefix'] = theme('indentation', array('size' => $depth)) . (isset($row[$cell]['#prefix']) ? $row[$cell]['#prefix'] : '');
|
|
}
|
|
|
|
// Add row id and associate JS settings.
|
|
$id = drupal_html_class($name);
|
|
$row['#attributes']['id'] = $id;
|
|
if (isset($row['#js_settings'])) {
|
|
$row['#js_settings'] += array(
|
|
'rowHandler' => $row['#row_type'],
|
|
'name' => $name,
|
|
'region' => $region_name,
|
|
);
|
|
$js_settings[$id] = $row['#js_settings'];
|
|
}
|
|
}
|
|
}
|
|
}
|
|
// Determine rendering order from the tree structure.
|
|
foreach ($regions as $region_name => $region) {
|
|
$elements['#regions'][$region_name]['rows_order'] = array_reduce($trees[$region_name], '_field_ui_reduce_order');
|
|
}
|
|
|
|
$elements['#attached']['js'][] = array(
|
|
'type' => 'setting',
|
|
'data' => array('fieldUIRowsData' => $js_settings),
|
|
);
|
|
|
|
return $elements;
|
|
}
|
|
|
|
/**
|
|
* Returns HTML for Field UI overview tables.
|
|
*
|
|
* @param $variables
|
|
* An associative array containing:
|
|
* - elements: An associative array containing a Form API structure to be
|
|
* rendered as a table.
|
|
*
|
|
* @ingroup themeable
|
|
*/
|
|
function theme_field_ui_table($variables) {
|
|
$elements = $variables['elements'];
|
|
$table = array();
|
|
$js_settings = array();
|
|
|
|
// Add table headers and attributes.
|
|
foreach (array('header', 'attributes') as $key) {
|
|
if (isset($elements["#$key"])) {
|
|
$table[$key] = $elements["#$key"];
|
|
}
|
|
}
|
|
|
|
// Determine the colspan to use for region rows, by checking the number of
|
|
// columns in the headers.
|
|
$columns_count = 0;
|
|
foreach ($table['header'] as $header) {
|
|
$columns_count += (is_array($header) && isset($header['colspan']) ? $header['colspan'] : 1);
|
|
}
|
|
|
|
// Render rows, region by region.
|
|
foreach ($elements['#regions'] as $region_name => $region) {
|
|
$region_name_class = drupal_html_class($region_name);
|
|
|
|
// Add region rows.
|
|
if (isset($region['title']) && empty($region['invisible'])) {
|
|
$table['rows'][] = array(
|
|
'class' => array('region-title', 'region-' . $region_name_class . '-title'),
|
|
'no_striping' => TRUE,
|
|
'data' => array(
|
|
array('data' => $region['title'], 'colspan' => $columns_count),
|
|
),
|
|
);
|
|
}
|
|
if (isset($region['message'])) {
|
|
$class = (empty($region['rows_order']) ? 'region-empty' : 'region-populated');
|
|
$table['rows'][] = array(
|
|
'class' => array('region-message', 'region-' . $region_name_class . '-message', $class),
|
|
'no_striping' => TRUE,
|
|
'data' => array(
|
|
array('data' => $region['message'], 'colspan' => $columns_count),
|
|
),
|
|
);
|
|
}
|
|
|
|
// Add form rows, in the order determined at pre-render time.
|
|
foreach ($region['rows_order'] as $name) {
|
|
$element = $elements[$name];
|
|
|
|
$row = array('data' => array());
|
|
if (isset($element['#attributes'])) {
|
|
$row += $element['#attributes'];
|
|
}
|
|
|
|
// Render children as table cells.
|
|
foreach (element_children($element) as $cell_key) {
|
|
$child = &$element[$cell_key];
|
|
// Do not render a cell for children of #type 'value'.
|
|
if (!(isset($child['#type']) && $child['#type'] == 'value')) {
|
|
$cell = array('data' => drupal_render($child));
|
|
if (isset($child['#cell_attributes'])) {
|
|
$cell += $child['#cell_attributes'];
|
|
}
|
|
$row['data'][] = $cell;
|
|
}
|
|
}
|
|
$table['rows'][] = $row;
|
|
}
|
|
}
|
|
|
|
return theme('table', $table);
|
|
}
|
|
|
|
/**
|
|
* Render API callback: Checks if a field machine name is taken.
|
|
*
|
|
* @param $value
|
|
* The machine name, not prefixed with 'field_'.
|
|
*
|
|
* @return
|
|
* Whether or not the field machine name is taken.
|
|
*/
|
|
function _field_ui_field_name_exists($value) {
|
|
// Prefix with 'field_'.
|
|
$field_name = 'field_' . $value;
|
|
|
|
// We need to check inactive fields as well, so we can't use
|
|
// field_info_fields().
|
|
return (bool) field_read_fields(array('field_name' => $field_name), array('include_inactive' => TRUE));
|
|
}
|
|
|
|
/**
|
|
* Returns an array of field_type options.
|
|
*/
|
|
function field_ui_field_type_options() {
|
|
$options = &drupal_static(__FUNCTION__);
|
|
|
|
if (!isset($options)) {
|
|
$options = array();
|
|
$field_types = field_info_field_types();
|
|
$field_type_options = array();
|
|
foreach ($field_types as $name => $field_type) {
|
|
// Skip field types which have no widget types, or should not be add via
|
|
// uesr interface.
|
|
if (field_ui_widget_type_options($name) && empty($field_type['no_ui'])) {
|
|
$options[$name] = $field_type['label'];
|
|
}
|
|
}
|
|
asort($options);
|
|
}
|
|
return $options;
|
|
}
|
|
|
|
/**
|
|
* Returns an array of widget type options for a field type.
|
|
*
|
|
* If no field type is provided, returns a nested array of all widget types,
|
|
* keyed by field type human name.
|
|
*/
|
|
function field_ui_widget_type_options($field_type = NULL, $by_label = FALSE) {
|
|
$options = &drupal_static(__FUNCTION__);
|
|
|
|
if (!isset($options)) {
|
|
$options = array();
|
|
$field_types = field_info_field_types();
|
|
$widget_types = field_info_widget_types();
|
|
uasort($widget_types, 'drupal_sort_weight');
|
|
foreach ($widget_types as $name => $widget_type) {
|
|
foreach ($widget_type['field_types'] as $widget_field_type) {
|
|
// Check that the field type exists.
|
|
if (isset($field_types[$widget_field_type])) {
|
|
$options[$widget_field_type][$name] = $widget_type['label'];
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
if (isset($field_type)) {
|
|
return !empty($options[$field_type]) ? $options[$field_type] : array();
|
|
}
|
|
if ($by_label) {
|
|
$field_types = field_info_field_types();
|
|
$options_by_label = array();
|
|
foreach ($options as $field_type => $widgets) {
|
|
$options_by_label[$field_types[$field_type]['label']] = $widgets;
|
|
}
|
|
return $options_by_label;
|
|
}
|
|
return $options;
|
|
}
|
|
|
|
/**
|
|
* Returns an array of formatter options for a field type.
|
|
*
|
|
* If no field type is provided, returns a nested array of all formatters, keyed
|
|
* by field type.
|
|
*/
|
|
function field_ui_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) {
|
|
// Check that the field type exists.
|
|
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;
|
|
}
|
|
|
|
/**
|
|
* Returns an array of existing fields to be added to a bundle.
|
|
*/
|
|
function field_ui_existing_field_options($entity_type, $bundle) {
|
|
$info = array();
|
|
$field_types = field_info_field_types();
|
|
|
|
foreach (field_info_instances() as $existing_entity_type => $bundles) {
|
|
foreach ($bundles as $existing_bundle => $instances) {
|
|
// No need to look in the current bundle.
|
|
if (!($existing_bundle == $bundle && $existing_entity_type == $entity_type)) {
|
|
foreach ($instances as $instance) {
|
|
$field = field_info_field($instance['field_name']);
|
|
// Don't show
|
|
// - locked fields,
|
|
// - fields already in the current bundle,
|
|
// - fields that cannot be added to the entity type,
|
|
// - fields that should not be added via user interface.
|
|
|
|
if (empty($field['locked'])
|
|
&& !field_info_instance($entity_type, $field['field_name'], $bundle)
|
|
&& (empty($field['entity_types']) || in_array($entity_type, $field['entity_types']))
|
|
&& empty($field_types[$field['type']]['no_ui'])) {
|
|
$widget = entity_get_form_display($instance['entity_type'], $instance['bundle'], 'default')->getComponent($instance['field_name']);
|
|
$info[$instance['field_name']] = array(
|
|
'type' => $field['type'],
|
|
'type_label' => $field_types[$field['type']]['label'],
|
|
'field' => $field['field_name'],
|
|
'label' => $instance['label'],
|
|
'widget_type' => $widget['type'],
|
|
);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
return $info;
|
|
}
|
|
|
|
/**
|
|
* Extracts next redirect path from an array of multiple destinations.
|
|
*
|
|
* @see field_ui_next_destination()
|
|
*/
|
|
function field_ui_get_destinations($destinations) {
|
|
$path = array_shift($destinations);
|
|
$options = drupal_parse_url($path);
|
|
if ($destinations) {
|
|
$options['query']['destinations'] = $destinations;
|
|
}
|
|
return array($options['path'], $options);
|
|
}
|
|
|
|
/**
|
|
* Returns the next redirect path in a multipage sequence.
|
|
*/
|
|
function field_ui_next_destination($entity_type, $bundle) {
|
|
$destinations = !empty($_REQUEST['destinations']) ? $_REQUEST['destinations'] : array();
|
|
if (!empty($destinations)) {
|
|
unset($_REQUEST['destinations']);
|
|
return field_ui_get_destinations($destinations);
|
|
}
|
|
$admin_path = Drupal::entityManager()->getAdminPath($entity_type, $bundle);
|
|
return $admin_path . '/fields';
|
|
}
|