class EntityDefaultFeaturesController in Entity API 7
Default controller handling features integration.
Hierarchy
Expanded class hierarchy of EntityDefaultFeaturesController
1 string reference to 'EntityDefaultFeaturesController'
- entity_features_get_controller in ./
entity.features.inc - Returns the configured entity features controller.
File
- ./
entity.features.inc, line 30 - Provides Features integration for entity types using the CRUD API.
View source
class EntityDefaultFeaturesController {
protected $type, $info;
public function __construct($type) {
$this->type = $type;
$this->info = entity_get_info($type);
$this->info['entity keys'] += array(
'module' => 'module',
'status' => 'status',
);
$this->statusKey = $this->info['entity keys']['status'];
$this->moduleKey = $this->info['entity keys']['module'];
if (!empty($this->info['bundle of'])) {
$entity_info = entity_get_info($this->info['bundle of']);
$this->bundleKey = $entity_info['bundle keys']['bundle'];
}
}
/**
* Defines the result for hook_features_api().
*/
public function api() {
return array(
// The entity type has to be the features component name.
$this->type => array(
'name' => $this->info['label'],
'feature_source' => TRUE,
'default_hook' => isset($this->info['export']['default hook']) ? $this->info['export']['default hook'] : 'default_' . $this->type,
// Use the provided component callbacks making use of the controller.
'base' => 'entity',
'file' => drupal_get_path('module', 'entity') . '/entity.features.inc',
),
);
}
/**
* Generates the result for hook_features_export_options().
*/
public function export_options() {
$options = array();
foreach (entity_load_multiple_by_name($this->type, FALSE) as $name => $entity) {
$options[$name] = entity_label($this->type, $entity);
}
return $options;
}
/**
* Generates the result for hook_features_export().
*/
public function export($data, &$export, $module_name = '') {
$pipe = array();
foreach (entity_load_multiple_by_name($this->type, $data) as $name => $entity) {
// If this entity is provided by a different module, add it as dependency.
if ($entity->{$this->statusKey} & ENTITY_IN_CODE && $entity->{$this->moduleKey} != $module_name) {
$module = $entity->{$this->moduleKey};
$export['dependencies'][$module] = $module;
}
else {
$export['features'][$this->type][$name] = $name;
// If this is a bundle of a fieldable entity add its fields to the pipe.
if (!empty($this->info['bundle of'])) {
$fields = field_info_instances($this->info['bundle of'], $entity->{$this->bundleKey});
foreach ($fields as $name => $field) {
$pipe['field'][] = "{$field['entity_type']}-{$field['bundle']}-{$field['field_name']}";
$pipe['field_instance'][] = "{$field['entity_type']}-{$field['bundle']}-{$field['field_name']}";
}
}
}
}
// Add the module providing the entity type as dependency.
if ($data && !empty($this->info['module'])) {
$export['dependencies'][$this->info['module']] = $this->info['module'];
// In case entity is not already an indirect dependency, add it.
// We can do so without causing redundant dependencies because,
// if entity is an indirect dependency, Features will filter it out.
$export['dependencies']['entity'] = 'entity';
}
return $pipe;
}
/**
* Generates the result for hook_features_export_render().
*/
public function export_render($module, $data, $export = NULL) {
$output = array();
$output[] = ' $items = array();';
foreach (entity_load_multiple_by_name($this->type, $data) as $name => $entity) {
$export = " \$items['{$name}'] = entity_import('{$this->type}', '";
// Make sure to escape the characters \ and '.
$export .= addcslashes(entity_export($this->type, $entity, ' '), '\\\'');
$export .= "');";
$output[] = $export;
}
$output[] = ' return $items;';
$output = implode("\n", $output);
$hook = isset($this->info['export']['default hook']) ? $this->info['export']['default hook'] : 'default_' . $this->type;
return array(
$hook => $output,
);
}
/**
* Generates the result for hook_features_revert().
*/
public function revert($module = NULL) {
if ($defaults = features_get_default($this->type, $module)) {
entity_delete_multiple($this->type, array_keys($defaults));
}
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
EntityDefaultFeaturesController:: |
protected | property | ||
EntityDefaultFeaturesController:: |
public | function | Defines the result for hook_features_api(). | |
EntityDefaultFeaturesController:: |
public | function | Generates the result for hook_features_export(). | |
EntityDefaultFeaturesController:: |
public | function | Generates the result for hook_features_export_options(). | |
EntityDefaultFeaturesController:: |
public | function | Generates the result for hook_features_export_render(). | |
EntityDefaultFeaturesController:: |
public | function | Generates the result for hook_features_revert(). | |
EntityDefaultFeaturesController:: |
public | function |