225 lines
7.7 KiB
PHP
225 lines
7.7 KiB
PHP
<?php
|
|
|
|
/**
|
|
* Implements hook_features_api().
|
|
*/
|
|
function field_features_api() {
|
|
return array(
|
|
'field' => array(
|
|
'name' => t('Fields'),
|
|
'default_hook' => 'field_default_fields',
|
|
'default_file' => FEATURES_DEFAULTS_INCLUDED,
|
|
'feature_source' => TRUE,
|
|
)
|
|
);
|
|
}
|
|
|
|
|
|
/**
|
|
* Implements hook_features_export_options().
|
|
*/
|
|
function field_features_export_options() {
|
|
$options = array();
|
|
$instances = field_info_instances();
|
|
foreach ($instances as $entity_type => $bundles) {
|
|
foreach ($bundles as $bundle => $fields) {
|
|
foreach ($fields as $field) {
|
|
$identifier = "{$entity_type}-{$bundle}-{$field['field_name']}";
|
|
$options[$identifier] = $identifier;
|
|
}
|
|
}
|
|
}
|
|
return $options;
|
|
}
|
|
|
|
/**
|
|
* Implements hook_features_export().
|
|
*/
|
|
function field_features_export($data, &$export, $module_name = '') {
|
|
$pipe = array();
|
|
$map = features_get_default_map('field');
|
|
|
|
// The field_default_fields() hook integration is provided by the
|
|
// features module so we need to add it as a dependency.
|
|
$export['dependencies']['features'] = 'features';
|
|
|
|
foreach ($data as $identifier) {
|
|
if ($field = features_field_load($identifier)) {
|
|
// If this field is already provided by another module, remove the field
|
|
// and add the other module as a dependency.
|
|
if (isset($map[$identifier]) && $map[$identifier] != $module_name) {
|
|
if (isset($export['features']['field'][$identifier])) {
|
|
unset($export['features']['field'][$identifier]);
|
|
}
|
|
$module = $map[$identifier];
|
|
$export['dependencies'][$module] = $module;
|
|
}
|
|
// If the field has not yet been exported, add it
|
|
else {
|
|
$export['features']['field'][$identifier] = $identifier;
|
|
$export['dependencies'][$field['field_config']['module']] = $field['field_config']['module'];
|
|
if ($field['field_config']['storage']['type'] != variable_get('field_storage_default', 'field_sql_storage')) {
|
|
$export['dependencies'][$field['field_config']['storage']['module']] = $field['field_config']['storage']['module'];
|
|
}
|
|
$export['dependencies'][$field['field_instance']['widget']['module']] = $field['field_instance']['widget']['module'];
|
|
foreach ($field['field_instance']['display'] as $key => $display) {
|
|
if (isset($display['module'])) {
|
|
$export['dependencies'][$display['module']] = $display['module'];
|
|
// @TODO: handle the pipe to image styles
|
|
}
|
|
}
|
|
// If taxonomy field, add in the vocabulary
|
|
if ($field['field_config']['type'] == 'taxonomy_term_reference' && !empty($field['field_config']['settings']['allowed_values'])) {
|
|
foreach ($field['field_config']['settings']['allowed_values'] as $allowed_values) {
|
|
if (!empty($allowed_values['vocabulary'])) {
|
|
$pipe['taxonomy'][] = $allowed_values['vocabulary'];
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
return $pipe;
|
|
}
|
|
|
|
/**
|
|
* Implements hook_features_export_render().
|
|
*/
|
|
function field_features_export_render($module, $data, $export = NULL) {
|
|
$translatables = $code = array();
|
|
|
|
$code[] = ' $fields = array();';
|
|
$code[] = '';
|
|
foreach ($data as $identifier) {
|
|
if ($field = features_field_load($identifier)) {
|
|
unset($field['field_config']['columns']);
|
|
// Only remove the 'storage' declaration if the field is using the default
|
|
// storage type.
|
|
if ($field['field_config']['storage']['type'] == variable_get('field_storage_default', 'field_sql_storage')) {
|
|
unset($field['field_config']['storage']);
|
|
}
|
|
// If we still have a storage declaration here it means that a non-default
|
|
// storage type was altered into to the field definition. And noone would
|
|
// never need to change the 'details' key, so don't render it.
|
|
if (isset($field['field_config']['storage']['details'])) {
|
|
unset($field['field_config']['storage']['details']);
|
|
}
|
|
|
|
_field_features_export_sort($field);
|
|
$field_export = features_var_export($field, ' ');
|
|
$field_identifier = features_var_export($identifier);
|
|
$code[] = " // Exported field: {$field_identifier}.";
|
|
$code[] = " \$fields[{$field_identifier}] = {$field_export};";
|
|
$code[] = "";
|
|
|
|
// Add label and description to translatables array.
|
|
if (!empty($field['field_instance']['label'])) {
|
|
$translatables[] = $field['field_instance']['label'];
|
|
}
|
|
if (!empty($field['field_instance']['description'])) {
|
|
$translatables[] = $field['field_instance']['description'];
|
|
}
|
|
}
|
|
}
|
|
if (!empty($translatables)) {
|
|
$code[] = features_translatables_export($translatables, ' ');
|
|
}
|
|
$code[] = ' return $fields;';
|
|
$code = implode("\n", $code);
|
|
return array('field_default_fields' => $code);
|
|
}
|
|
|
|
// Helper to enforce consistency in field export arrays.
|
|
function _field_features_export_sort(&$field, $sort = TRUE) {
|
|
|
|
// Some arrays are not sorted to preserve order (for example allowed_values).
|
|
static $sort_blacklist = array(
|
|
'allowed_values',
|
|
'format_handlers',
|
|
);
|
|
|
|
if ($sort) {
|
|
ksort($field);
|
|
}
|
|
foreach ($field as $k => $v) {
|
|
if (is_array($v)) {
|
|
_field_features_export_sort($field[$k], !in_array($k, $sort_blacklist));
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Implements hook_features_revert().
|
|
*/
|
|
function field_features_revert($module) {
|
|
field_features_rebuild($module);
|
|
}
|
|
|
|
/**
|
|
* Implements of hook_features_rebuild().
|
|
* Rebuilds fields from code defaults.
|
|
*/
|
|
function field_features_rebuild($module) {
|
|
if ($fields = features_get_default('field', $module)) {
|
|
field_info_cache_clear();
|
|
|
|
// Load all the existing fields and instance up-front so that we don't
|
|
// have to rebuild the cache all the time.
|
|
$existing_fields = field_info_fields();
|
|
$existing_instances = field_info_instances();
|
|
|
|
foreach ($fields as $field) {
|
|
// Create or update field.
|
|
$field_config = $field['field_config'];
|
|
if (isset($existing_fields[$field_config['field_name']])) {
|
|
$existing_field = $existing_fields[$field_config['field_name']];
|
|
if ($field_config + $existing_field != $existing_field) {
|
|
field_update_field($field_config);
|
|
}
|
|
}
|
|
else {
|
|
field_create_field($field_config);
|
|
$existing_fields[$field_config['field_name']] = $field_config;
|
|
}
|
|
|
|
// Create or update field instance.
|
|
$field_instance = $field['field_instance'];
|
|
if (isset($existing_instances[$field_instance['entity_type']][$field_instance['bundle']][$field_instance['field_name']])) {
|
|
$existing_instance = $existing_instances[$field_instance['entity_type']][$field_instance['bundle']][$field_instance['field_name']];
|
|
if ($field_instance + $existing_instance != $existing_instance) {
|
|
field_update_instance($field_instance);
|
|
}
|
|
}
|
|
else {
|
|
field_create_instance($field_instance);
|
|
$existing_instances[$field_instance['entity_type']][$field_instance['bundle']][$field_instance['field_name']] = $field_instance;
|
|
}
|
|
}
|
|
|
|
if ($fields) {
|
|
variable_set('menu_rebuild_needed', TRUE);
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Load a field's configuration and instance configuration by an
|
|
* entity_type-bundle-field_name identifier.
|
|
*/
|
|
function features_field_load($identifier) {
|
|
list($entity_type, $bundle, $field_name) = explode('-', $identifier);
|
|
$field_info = field_info_field($field_name);
|
|
$instance_info = field_info_instance($entity_type, $field_name, $bundle);
|
|
if ($field_info && $instance_info) {
|
|
unset($field_info['id']);
|
|
unset($field_info['bundles']);
|
|
unset($instance_info['id']);
|
|
unset($instance_info['field_id']);
|
|
return array(
|
|
'field_config' => $field_info,
|
|
'field_instance' => $instance_info,
|
|
);
|
|
}
|
|
return FALSE;
|
|
}
|