function entity_embed_dialog_form in Entity Embed 7.3
Same name and namespace in other branches
- 7 entity_embed.admin.inc \entity_embed_dialog_form()
- 7.2 entity_embed.admin.inc \entity_embed_dialog_form()
Form constructor for the entity embed dialog form.
Allows the user to select and embed an entity.
See also
entity_embed_dialog_form_validate()
3 string references to 'entity_embed_dialog_form'
- entity_embed_menu in ./
entity_embed.module - Implements hook_menu().
- goBack in ./
entity_embed.admin.inc - Form submission handler to go back to the previous step of the form.
- submitSelectForm in ./
entity_embed.admin.inc - Form submission handler that selects an entity and display embed settings.
File
- ./
entity_embed.admin.inc, line 16 - Admin page callbacks for the entity_embed module.
Code
function entity_embed_dialog_form($form, &$form_state, $filter_format, $embed_button) {
$values = isset($form_state['values']) ? $form_state['values'] : array();
$input = $_POST;
// Set embed button element in form state, so that it can be used later in
// validateForm() function.
$form['#embed_button'] = $embed_button;
// Initialize entity element with form attributes, if present.
$entity_element = empty($values['attributes']) ? array() : $values['attributes'];
// The default values are set directly from \Drupal::request()->request,
// provided by the editor plugin opening the dialog.
if (empty($form_state['entity_element'])) {
$form_state['entity_element'] = isset($input['editor_object']) ? $input['editor_object'] : array();
}
$entity_element += $form_state['entity_element'];
$entity_element += array(
'data-entity-type' => $embed_button->entity_type,
'data-entity-uuid' => '',
'data-entity-id' => '',
'data-entity-embed-display' => 'entityreference:entityreference_entity_view',
'data-entity-embed-settings' => array(),
'data-align' => '',
'data-caption' => '',
);
if (empty($form_state['step'])) {
// If an entity has been selected, then always skip to the embed options.
if (!empty($entity_element['data-entity-type']) && (!empty($entity_element['data-entity-uuid']) || !empty($entity_element['data-entity-id']))) {
$form_state['step'] = 'embed';
}
else {
$form_state['step'] = 'select';
}
}
$form['#tree'] = TRUE;
$form['#attached']['library'][] = array(
'editor',
'drupal.editor.dialog',
);
$form['#prefix'] = '<div id="entity-embed-dialog-form">';
$form['#suffix'] = '</div>';
switch ($form_state['step']) {
case 'select':
$form['#title'] = t('Embed entity');
$form['attributes']['data-entity-type'] = array(
'#type' => 'value',
'#value' => $entity_element['data-entity-type'],
);
$label = t('Label');
// Attempt to display a better label if we can by getting it from
// the label field definition.
$entity_info = entity_get_info($entity_element['data-entity-type']);
if (!empty($entity_info['label'])) {
$label = check_plain($entity_info['label']);
}
$default = '';
if (!empty($entity_element['data-entity-uuid']) && module_exists('uuid')) {
$entity = entity_uuid_load($entity_element['data-entity-type'], array(
$entity_element['data-entity-uuid'],
));
$entity = reset($entity);
}
else {
$entity = entity_load_single($entity_element['data-entity-type'], $entity_element['data-entity-id']);
}
if ($entity) {
$default = entity_label($entity_element['data-entity-type'], $entity);
}
$form['attributes']['data-entity-id'] = array(
'#type' => 'textfield',
'#title' => $label,
'#default_value' => $default,
'#autocomplete_path' => 'entity-embed/autocomplete-entity/' . $filter_format->format . '/' . $embed_button->name,
'#required' => TRUE,
'#description' => t('Type label and pick the right one from suggestions. Note that the unique ID will be saved.'),
);
// Integrate with the Media module to support selecting files to embed.
if ($entity_element['data-entity-type'] == 'file' && module_exists('media')) {
$form['attributes']['data-entity-id'] = array(
'#type' => 'media',
'#title' => $label,
'#default_value' => $entity_element['data-entity-id'],
'#required' => TRUE,
'#description' => t('Select a file to embed using the media browser.'),
'#media_options' => array(
'global' => array(
'types' => isset($embed_button->entity_type_bundles) ? $embed_button->entity_type_bundles : array(),
),
),
);
}
$form['attributes']['data-entity-uuid'] = array(
'#type' => 'value',
'#title' => $entity_element['data-entity-uuid'],
);
$form['actions'] = array(
'#type' => 'actions',
);
$form['actions']['save_modal'] = array(
'#attributes' => array(
'class' => array(
'button--primary',
),
),
'#type' => 'submit',
'#value' => t('Next'),
// No regular submit-handler. This form only works via JavaScript.
'#submit' => array(),
'#ajax' => array(
'callback' => 'submitSelectForm',
'event' => 'click',
),
);
break;
case 'embed':
$form['#title'] = t('Edit embedded entity');
if (!empty($entity_element['data-entity-uuid']) && module_exists('uuid')) {
$entity = entity_uuid_load($entity_element['data-entity-type'], array(
$entity_element['data-entity-uuid'],
));
$entity = reset($entity);
}
else {
$entity = entity_load_single($entity_element['data-entity-type'], $entity_element['data-entity-id']);
}
$text = t('Preview selected entity');
if ($entity) {
$text = entity_label($entity_element['data-entity-type'], $entity);
}
$uri = entity_uri($entity_element['data-entity-type'], $entity);
$form['entity'] = array(
'#type' => 'item',
'#title' => t('Selected entity'),
'#markup' => l($text, $uri['path'], $uri['options'] + array(
'attributes' => array(
'target' => '_blank',
),
)),
);
$form['attributes']['data-entity-type'] = array(
'#type' => 'value',
'#value' => $entity_element['data-entity-type'],
);
$form['attributes']['data-entity-id'] = array(
'#type' => 'value',
'#value' => $entity_element['data-entity-id'],
);
$form['attributes']['data-entity-uuid'] = array(
'#type' => 'value',
'#value' => $entity_element['data-entity-uuid'],
);
// Determine the available Display plugins for the current entity type.
$available_plugins = entity_embed_get_entity_field_formatters($entity_element['data-entity-type'], $entity);
// Retrieve the list of allowed Entity Embed Display plugins.
$allowed_plugins = $embed_button->display_plugins;
// If list of allowed options is empty, it means that all plugins are
// allowed. Else, take the intersection of allowed and available
// plugins.
$display_plugin_options = empty($allowed_plugins) ? $available_plugins : array_intersect_key($available_plugins, $allowed_plugins);
// If the currently selected display is not in the available options,
// use the first from the list instead. This can happen if an alter
// hook customizes the list based on the entity.
if (!isset($display_plugin_options[$entity_element['data-entity-embed-display']])) {
$entity_element['data-entity-embed-display'] = key($display_plugin_options);
}
// The default Entity Embed Display plugin has been deprecated by the
// rendered entity field formatter.
if ($entity_element['data-entity-embed-display'] === 'default') {
$entity_element['data-entity-embed-display'] = 'entityreference:entityreference_entity_view';
}
// @todo: Abstract formatters into 'display plugins'.
$form['attributes']['data-entity-embed-display'] = array(
'#type' => 'select',
'#title' => t('Display as'),
'#options' => $display_plugin_options,
'#default_value' => $entity_element['data-entity-embed-display'],
'#required' => TRUE,
'#ajax' => array(
'callback' => 'updatePluginConfigurationForm',
'wrapper' => 'data-entity-embed-settings-wrapper',
'effect' => 'fade',
),
// Hide the selection if only one option is available.
'#access' => count($display_plugin_options) > 1,
);
$form['attributes']['data-entity-embed-settings'] = array(
'#type' => 'container',
'#prefix' => '<div id="data-entity-embed-settings-wrapper">',
'#suffix' => '</div>',
);
$form['attributes']['data-embed-button'] = array(
'#type' => 'value',
'#value' => $embed_button->name,
);
$form['attributes']['data-entity-label'] = array(
'#type' => 'value',
'#value' => $embed_button->admin_title,
);
$plugin_id = !empty($values['attributes']['data-entity-embed-display']) ? $values['attributes']['data-entity-embed-display'] : $entity_element['data-entity-embed-display'];
// Split the formatter into separate parts.
$formatter_parts = explode(':', $plugin_id);
$formatter_module = $formatter_parts[0];
$formatter_type = $formatter_parts[1];
// Retrieve the settings appropriate for the currently selected formatter.
if (!empty($formatter_type)) {
if (is_string($entity_element['data-entity-embed-settings'])) {
$entity_element['data-entity-embed-settings'] = drupal_json_decode($entity_element['data-entity-embed-settings']);
}
$form['attributes']['data-entity-embed-settings'] += entity_embed_field_info_formatter_settings($entity_element['data-entity-type'], $entity, $formatter_type, $entity_element['data-entity-embed-settings'], $form, $form_state);
}
$filters = filter_list_format($filter_format->format);
// When Editor's editor_align is being used, the text editor may offer the
// ability to change the alignment.
if (isset($entity_element['data-align']) && isset($filters['editor_align']) && $filters['editor_align']->status) {
$form['attributes']['data-align'] = array(
'#title' => t('Align'),
'#type' => 'radios',
'#options' => array(
'none' => t('None'),
'left' => t('Left'),
'center' => t('Center'),
'right' => t('Right'),
),
'#default_value' => $entity_element['data-align'] === '' ? 'none' : $entity_element['data-align'],
'#wrapper_attributes' => array(
'class' => array(
'container-inline',
),
),
'#attributes' => array(
'class' => array(
'container-inline',
),
),
'#parents' => array(
'attributes',
'data-align',
),
);
}
// When Editor's editor_caption is being used, the text editor may offer
// the ability to add a caption.
if (isset($entity_element['data-caption']) && isset($filters['editor_caption']) && $filters['editor_caption']->status) {
$form['attributes']['data-caption'] = array(
'#title' => t('Caption'),
'#type' => 'textfield',
'#default_value' => $entity_element['data-caption'] === '' ? '' : $entity_element['data-caption'],
'#wrapper_attributes' => array(
'class' => array(
'container-inline',
),
),
'#attributes' => array(
'class' => array(
'container-inline',
),
),
'#parents' => array(
'attributes',
'data-caption',
),
);
}
$form['actions'] = array(
'#type' => 'actions',
);
$form['actions']['back'] = array(
'#type' => 'submit',
'#value' => t('Back'),
// No regular submit-handler. This form only works via JavaScript.
'#submit' => array(),
'#ajax' => array(
'callback' => 'goBack',
'event' => 'click',
),
);
$form['actions']['save_modal'] = array(
'#attributes' => array(
'class' => array(
'button--primary',
),
),
'#type' => 'submit',
'#value' => t('Embed'),
// No regular submit-handler. This form only works via JavaScript.
'#submit' => array(),
'#ajax' => array(
'callback' => 'submitEmbedForm',
'event' => 'click',
),
);
break;
}
return $form;
}