abstract class AddMediaFormBase in Media Directories 8
Same name and namespace in other branches
- 3.x modules/media_directories_ui/src/Form/AddMediaFormBase.php \Drupal\media_directories_ui\Form\AddMediaFormBase
- 2.x modules/media_directories_ui/src/Form/AddMediaFormBase.php \Drupal\media_directories_ui\Form\AddMediaFormBase
Class AddMediaFormBase.
Uses code and logic from core. We could try to integrate core directly, but it might be too unstable in this stage.
@package Drupal\media_directories_ui\Form
Hierarchy
- class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\media_directories_ui\Form\AddMediaFormBase
Expanded class hierarchy of AddMediaFormBase
File
- modules/
media_directories_ui/ src/ Form/ AddMediaFormBase.php, line 34
Namespace
Drupal\media_directories_ui\FormView source
abstract class AddMediaFormBase extends FormBase {
/**
* Entity type manager service.
*
* @var \Drupal\Core\Entity\EntityTypeManagerInterface
*/
protected $entityTypeManager;
/**
* Current user service.
*
* @var \Drupal\Core\Session\AccountProxyInterface
*/
protected $currentUser;
/**
* The token replacement instance.
*
* @var \Drupal\Core\Utility\Token
*/
protected $token;
/**
* The theme manager.
*
* @var \Drupal\Core\Theme\ThemeManagerInterface
*/
protected $themeManager;
/**
* AddMediaFormBase constructor.
*
* @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
* The entity type manager.
* @param \Drupal\Core\Session\AccountProxyInterface $current_user
* The current user.
* @param \Drupal\Core\Utility\Token $token
* The token service.
* @param \Drupal\Core\Theme\ThemeManagerInterface $theme_manager
* The theme manager.
*/
public function __construct(EntityTypeManagerInterface $entity_type_manager, AccountProxyInterface $current_user, Token $token, ThemeManagerInterface $theme_manager) {
$this->entityTypeManager = $entity_type_manager;
$this->currentUser = $current_user;
$this->token = $token;
$this->themeManager = $theme_manager;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container) {
return new static($container
->get('entity_type.manager'), $container
->get('current_user'), $container
->get('token'), $container
->get('theme.manager'));
}
/**
* {@inheritdoc}
*/
public function getFormId() {
return 'media_directories_add_form';
}
/**
* Get the media type from the form state.
*
* @param \Drupal\Core\Form\FormStateInterface $form_state
* The current form state.
*
* @return \Drupal\media\MediaTypeInterface
* The media type.
*
* @throws \InvalidArgumentException
* If the selected media type does not exist.
*/
protected function getMediaType(FormStateInterface $form_state) {
if (!$form_state
->get('media_type')) {
throw new \InvalidArgumentException("The media type does not exist.");
}
return $form_state
->get('media_type');
}
/**
* Gets the current active directory from the form state.
*
* @param \Drupal\Core\Form\FormStateInterface $form_state
* The form state.
*
* @return int
* The directory id.
*/
protected function getDirectory(FormStateInterface $form_state) {
$directory_id = $form_state
->get('active_directory');
if (empty($directory_id)) {
return MEDIA_DIRECTORY_ROOT;
}
return (int) $directory_id;
}
/**
* Get the allowed target bundles from the form state.
*
* @param \Drupal\Core\Form\FormStateInterface $form_state
* The form state.
*
* @return array
* All allowed target bundle names.
*/
protected function getTargetBundles(FormStateInterface $form_state) {
$bundles = $form_state
->get('target_bundles');
return $bundles;
}
/**
* Get the current selection mode from the form state.
*
* @param \Drupal\Core\Form\FormStateInterface $form_state
* The form state.
*
* @return string
* The current selection mode.
*/
protected function getSelectionMode(FormStateInterface $form_state) {
$selection_mode = $form_state
->get('selection_mode');
return $selection_mode;
}
/**
* Get the current cardinality from the form state.
*
* @param \Drupal\Core\Form\FormStateInterface $form_state
* The form state.
*
* @return int
* The current cardinality, or -1 for unlimited.
*/
protected function getCardinality(FormStateInterface $form_state) {
$cardinality = intval($form_state
->get('cardinality'));
if ($cardinality == 0) {
return -1;
}
return $cardinality;
}
/**
* Determines the URI for a file field.
*
* @param array $settings
* The array of field settings.
*
* @return string
* An un-sanitized file directory URI with tokens replaced. The result of
* the token replacement is then converted to plain text and returned.
*/
protected function getUploadLocation(array $settings) {
$destination = trim($settings['file_directory'], '/');
// Replace tokens. As the tokens might contain HTML we convert it to plain
// text.
$destination = PlainTextOutput::renderFromHtml($this->token
->replace($destination, []));
return $settings['uri_scheme'] . '://' . $destination;
}
/**
* Returns the upload validators for a field.
*
* @param \Drupal\media\MediaTypeInterface $media_type
* The array of field settings.
*
* @return array
* The file fields upload validators argument.
*
* @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
*/
protected function getUploadValidators(MediaTypeInterface $media_type) {
$upload_validators = $this
->createFileItem($media_type)
->getUploadValidators();
$source_field = $media_type
->getSource()
->getConfiguration()['source_field'];
$field_config = $this->entityTypeManager
->getStorage('field_config')
->load('media.' . $media_type
->id() . '.' . $source_field);
if ($field_config
->getSetting('max_resolution') || $field_config
->getSetting('min_resolution')) {
$upload_validators['file_validate_is_image'] = [];
$upload_validators['file_validate_image_resolution'] = [
$field_config
->getSetting('max_resolution'),
$field_config
->getSetting('min_resolution'),
];
}
if (!isset($upload_validators['file_validate_size'])) {
$max_filesize = Environment::getUploadMaxSize();
$upload_validators['file_validate_size'] = [
$max_filesize,
];
}
return $upload_validators;
}
/**
* Form constructor.
*
* @param array $form
* An associative array containing the structure of the form.
* @param \Drupal\Core\Form\FormStateInterface $form_state
* The current state of the form.
*
* @return array
* The form structure.
*/
public function buildForm(array $form, FormStateInterface $form_state) {
$form['#prefix'] = '<div id="media-library-add-form-wrapper" class="media-library-add-form-wrapper">';
$form['#suffix'] = '</div>';
$theme_name = $this->themeManager
->getActiveTheme()
->getName();
if (in_array($theme_name, [
'claro',
'gin',
])) {
$form['#attached']['library'][] = 'claro/media_library.theme';
}
else {
// By default we add the seven styles.
$form['#attached']['library'][] = 'seven/media_library';
}
// The form is posted via AJAX. When there are messages set during the
// validation or submission of the form, the messages need to be shown to
// the user.
$form['status_messages'] = [
'#type' => 'status_messages',
];
$form['#attributes']['class'] = [
'media-library-add-form',
'js-media-library-add-form',
];
/** @var \Drupal\media\Entity\Media[] $added_media */
$added_media = $form_state
->get('media');
$form['active_directory'] = [
'#type' => 'hidden',
'#value' => $this
->getDirectory($form_state),
];
$media_type = $form_state
->get('media_type');
$form['media_type'] = [
'#type' => 'hidden',
'#value' => is_object($media_type) ? $media_type
->id() : $media_type,
];
$target_bundles = $this
->getTargetBundles($form_state);
$form['target_bundles'] = [
'#tree' => TRUE,
];
foreach ($target_bundles as $bundle) {
$form['target_bundles'][$bundle] = [
'#type' => 'hidden',
'#value' => $bundle,
];
}
$form['selection_mode'] = [
'#type' => 'hidden',
'#value' => $this
->getSelectionMode($form_state),
];
$form['cardinality'] = [
'#type' => 'hidden',
'#value' => $this
->getCardinality($form_state),
];
if (empty($added_media)) {
$form['#attributes']['class'][] = 'media-library-add-form--without-input';
$form = $this
->buildInputElement($form, $form_state);
}
else {
$form['#attributes']['class'][] = 'media-library-add-form--with-input';
$form['media'] = [
'#type' => 'container',
'#attributes' => [
'class' => [
'media-library-add-form__added-media',
],
'aria-label' => $this
->t('Added media items'),
'role' => 'list',
// Add the tabindex '-1' to allow the focus to be shifted to the added
// media wrapper when items are added. We set focus to the container
// because a media item does not necessarily have required fields and
// we do not want to set focus to the remove button automatically.
// @see ::updateFormCallback()
'tabindex' => '-1',
],
];
$form['media']['description'] = [
'#type' => 'html_tag',
'#tag' => 'p',
'#value' => $this
->formatPlural(count($added_media), 'The media item has been created but has not yet been saved. Fill in any required fields and save to add it to the media library.', 'The media items have been created but have not yet been saved. Fill in any required fields and save to add them to the media library.'),
'#attributes' => [
'class' => [
'media-library-add-form__description',
],
],
];
foreach ($added_media as $delta => $media) {
// $media->set('directory', $this->directoryId);
$form['media'][$delta] = $this
->buildEntityFormElement($media, $form, $form_state, $delta);
}
$form['actions'] = $this
->buildActions($form, $form_state);
}
// Allow the current selection to be set in a hidden field so the selection
// can be passed between different states of the form. This field is filled
// via JavaScript so the default value should be empty.
// @see Drupal.behaviors.MediaLibraryItemSelection
$form['current_selection'] = [
'#type' => 'hidden',
'#default_value' => '',
'#attributes' => [
'class' => [
'js-media-library-add-form-current-selection',
],
],
];
return $form;
}
/**
* Inheriting classes need to build the desired input element.
*/
protected abstract function buildInputElement(array $form, FormStateInterface $form_state);
/**
* Form submission handler.
*
* @param array $form
* An associative array containing the structure of the form.
* @param \Drupal\Core\Form\FormStateInterface $form_state
* The current state of the form.
*/
public function submitForm(array &$form, FormStateInterface $form_state) {
$added_media = $form_state
->get('media');
// Support multi value fields.
$tmp_tid_mids = [];
$all_mids = [];
foreach ($added_media as $delta => $media) {
EntityFormDisplay::collectRenderDisplay($media, 'media_library')
->extractFormValues($media, $form['media'][$delta]['fields'], $form_state);
// $this->prepareMediaEntityForSave($media);
$media
->save();
$tmp_tid_mids[isset($media
->get('directory')->target_id) ? $media
->get('directory')->target_id : MEDIA_DIRECTORY_ROOT][] = $media
->id();
$all_mids[] = $media
->id();
}
$tid_holding_most_mids = -1;
foreach ($tmp_tid_mids as $tid => $mids) {
if (!isset($tmp_tid_mids[$tid_holding_most_mids]) || count($tmp_tid_mids[$tid_holding_most_mids]) < count($tmp_tid_mids[$tid])) {
$tid_holding_most_mids = $tid;
}
}
$cardinality = $this
->getCardinality($form_state);
if ($form_state
->get('selection_mode') != 'keep') {
$newly_added_media_ids = $tmp_tid_mids[$tid_holding_most_mids];
if (count($newly_added_media_ids) < count($all_mids)) {
$this
->messenger()
->addStatus($this
->t('You uploaded medias to different folders. Only medias in the current folder (having the most uploaded media count) are selected.'));
}
if ($cardinality > -1 && $cardinality < count($newly_added_media_ids)) {
$newly_added_media_ids = array_slice($newly_added_media_ids, 0, $cardinality);
$this
->messenger()
->addStatus($this
->formatPlural(count($cardinality), 'As this field only accepts one media, only the first one uploaded is selected.', 'You uploaded more medias then allowed for the field, only the first @count are selected.'));
}
$form_state
->setValue('newly_added_media_ids', $newly_added_media_ids);
}
else {
if ($cardinality > -1 && $cardinality < count($all_mids)) {
$newly_added_media_ids = array_slice($all_mids, 0, $cardinality);
$this
->messenger()
->addStatus($this
->formatPlural(count($cardinality), 'As this field only accepts one media, only the first one uploaded is selected.', 'You uploaded more medias then allowed for the field, only the first @count are selected.'));
}
$form_state
->setValue('newly_added_media_ids', $all_mids);
}
$form_state
->setValue('most_choosen_directory_tid', $tid_holding_most_mids);
}
/**
* Builds the sub-form for setting required fields on a new media item.
*
* @param \Drupal\media\MediaInterface $media
* A new, unsaved media item.
* @param array $form
* The complete form.
* @param \Drupal\Core\Form\FormStateInterface $form_state
* The current form state.
* @param int $delta
* The delta of the media item.
*
* @return array
* The element containing the required fields sub-form.
*
* @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
*/
protected function buildEntityFormElement(MediaInterface $media, array $form, FormStateInterface $form_state, $delta) {
// We need to make sure each button has a unique name attribute. The default
// name for button elements is 'op'. If the name is not unique, the
// triggering element is not set correctly and the wrong media item is
// removed.
// @see ::removeButtonSubmit()
$parents = isset($form['#parents']) ? $form['#parents'] : '';
$id_suffix = $parents ? '-' . implode('-', $parents) : '';
$element = [
'#type' => 'container',
'#attributes' => [
'class' => [
'media-library-add-form__media',
],
'aria-label' => $media
->getName(),
'role' => 'listitem',
// Add the tabindex '-1' to allow the focus to be shifted to the next
// media item when an item is removed. We set focus to the container
// because a media item does not necessarily have required fields and we
// do not want to set focus to the remove button automatically.
// @see ::updateFormCallback()
'tabindex' => '-1',
// Add a data attribute containing the delta to allow us to easily shift
// the focus to a specific media item.
// @see ::updateFormCallback()
'data-media-library-added-delta' => $delta,
],
'preview' => [
'#type' => 'container',
'#weight' => 10,
'#attributes' => [
'class' => [
'media-library-add-form__preview',
],
],
],
'fields' => [
'#type' => 'container',
'#weight' => 20,
'#attributes' => [
'class' => [
'media-library-add-form__fields',
],
],
// The '#parents' are set here because the entity form display needs it
// to build the entity form fields.
'#parents' => [
'media',
$delta,
'fields',
],
],
'remove_button' => [
'#type' => 'submit',
'#value' => $this
->t('Remove'),
'#name' => 'media-' . $delta . '-remove-button' . $id_suffix,
'#weight' => 30,
'#attributes' => [
'class' => [
'media-library-add-form__remove-button',
],
'aria-label' => $this
->t('Remove @label', [
'@label' => $media
->getName(),
]),
],
'#ajax' => [
'callback' => '::updateFormCallback',
'wrapper' => 'media-library-add-form-wrapper',
'message' => $this
->t('Removing @label.', [
'@label' => $media
->getName(),
]),
],
'#submit' => [
'::removeButtonSubmit',
],
// Ensure errors in other media items do not prevent removal.
'#limit_validation_errors' => [],
],
];
// @todo Make the image style configurable in
// https://www.drupal.org/node/2988223
$source = $media
->getSource();
$plugin_definition = $source
->getPluginDefinition();
if ($thumbnail_uri = $source
->getMetadata($media, $plugin_definition['thumbnail_uri_metadata_attribute'])) {
$element['preview']['thumbnail'] = [
'#theme' => 'image_style',
'#style_name' => 'media_library',
'#uri' => $thumbnail_uri,
];
}
$form_display = EntityFormDisplay::collectRenderDisplay($media, 'media_library');
// When the name is not added to the form as an editable field, output
// the name as a fixed element to confirm the right file was uploaded.
if (!$form_display
->getComponent('name')) {
$element['fields']['name'] = [
'#type' => 'item',
'#title' => $this
->t('Name'),
'#markup' => $media
->getName(),
];
}
$form_display
->buildForm($media, $element['fields'], $form_state);
/** @var \Drupal\media\Entity\MediaType $type */
$type = $this->entityTypeManager
->getStorage('media_type')
->load($media
->bundle());
$source_field_name = $this
->getSourceFieldName($type);
// Add a class and process function.
if (isset($element['fields'][$source_field_name])) {
$element['fields'][$source_field_name]['#attributes']['class'][] = 'media-library-add-form__source-field';
$element['fields'][$source_field_name]['widget'][0]['#process'][] = [
static::class,
'hideExtraSourceFieldComponents',
];
}
// Add source field name so that it can be identified in form alter and
// widget alter hooks.
$element['fields']['#source_field_name'] = $source_field_name;
// The revision log field is currently not configurable from the form
// display, so hide it by changing the access.
// @todo Make the revision_log_message field configurable in
// https://www.drupal.org/project/drupal/issues/2696555
if (isset($element['fields']['revision_log_message'])) {
$element['fields']['revision_log_message']['#access'] = FALSE;
}
return $element;
}
/**
* Processes an image or file source field element.
*
* @param array $element
* The entity form source field element.
* @param \Drupal\Core\Form\FormStateInterface $form_state
* The current form state.
* @param array $form
* The complete form.
*
* @return array
* The processed form element.
*/
public static function hideExtraSourceFieldComponents(array $element, FormStateInterface $form_state, array $form) {
// Remove original button added by ManagedFile::processManagedFile().
if (!empty($element['remove_button'])) {
$element['remove_button']['#access'] = FALSE;
}
// Remove preview added by ImageWidget::process().
if (!empty($element['preview'])) {
$element['preview']['#access'] = FALSE;
}
$element['#title_display'] = 'none';
$element['#description_display'] = 'none';
// Remove the filename display.
foreach ($element['#files'] as $file) {
$element['file_' . $file
->id()]['filename']['#access'] = FALSE;
}
return $element;
}
/**
* Returns the name of the source field for a media type.
*
* @param \Drupal\media\MediaTypeInterface $media_type
* The media type to get the source field name for.
*
* @return string
* The name of the media type's source field.
*/
protected function getSourceFieldName(MediaTypeInterface $media_type) {
return $media_type
->getSource()
->getSourceFieldDefinition($media_type)
->getName();
}
/**
* Create a file field item.
*
* @param \Drupal\media\MediaTypeInterface $media_type
* The media type of the media item.
*
* @return \Drupal\file\Plugin\Field\FieldType\FileItem
* A created file item.
*/
protected function createFileItem(MediaTypeInterface $media_type) {
$field_definition = $media_type
->getSource()
->getSourceFieldDefinition($media_type);
$data_definition = FieldItemDataDefinition::create($field_definition);
return new FileItem($data_definition);
}
/**
* Returns an array of supported actions for the form.
*
* @param array $form
* The complete form.
* @param \Drupal\Core\Form\FormStateInterface $form_state
* The current form state.
*
* @return array
* An actions element containing the actions of the form.
*/
protected function buildActions(array $form, FormStateInterface $form_state) {
return [
'#type' => 'actions',
'save_select' => [
'#type' => 'submit',
'#button_type' => 'primary',
'#value' => $this
->t('Save and select'),
'#ajax' => [
'callback' => '::updateLibrary',
'wrapper' => 'media-library-add-form-wrapper',
],
],
];
}
/**
* AJAX callback to update the entire form based on source field input.
*
* @param array $form
* The complete form.
* @param \Drupal\Core\Form\FormStateInterface $form_state
* The current form state.
*
* @return \Drupal\Core\Ajax\AjaxResponse|array
* The form render array or an AJAX response object.
*/
public function updateFormCallback(array &$form, FormStateInterface $form_state) {
$triggering_element = $form_state
->getTriggeringElement();
$wrapper_id = $triggering_element['#ajax']['wrapper'];
$added_media = $form_state
->get('media');
$media_type = $this
->getMediaType($form_state);
$response = new AjaxResponse();
// When the source field input contains errors, replace the existing form to
// let the user change the source field input. If the user input is valid,
// the entire modal is replaced with the second step of the form to show the
// form fields for each media item.
if ($form_state::hasAnyErrors()) {
$response
->addCommand(new ReplaceCommand('#media-library-add-form-wrapper', $form));
return $response;
}
// Check if the remove button is clicked.
if (end($triggering_element['#parents']) === 'remove_button') {
// When the list of added media is empty, return to the media library and
// shift focus back to the first tabbable element (which should be the
// source field).
if (empty($added_media)) {
$build = [
'#theme' => 'media_directories_add',
'#selected_type' => $media_type
->id(),
'#active_directory' => $this
->getDirectory($form_state),
'#target_bundles' => $this
->getTargetBundles($form_state),
'#media_library_form_rebuild' => TRUE,
];
$form_state
->setRebuild();
$response
->addCommand(new ReplaceCommand('#media-library-add-form-wrapper', $build));
// $response->addCommand(new InvokeCommand('#media-library-add-form-wrapper :tabbable', 'focus'));
}
else {
$response
->addCommand(new ReplaceCommand("#{$wrapper_id}", $form));
}
}
else {
$response
->addCommand(new ReplaceCommand("#{$wrapper_id}", $form));
}
return $response;
}
/**
* Submit handler for the remove button.
*
* @param array $form
* The form render array.
* @param \Drupal\Core\Form\FormStateInterface $form_state
* The form state.
*/
public function removeButtonSubmit(array $form, FormStateInterface $form_state) {
// Retrieve the delta of the media item from the parents of the remove
// button.
$triggering_element = $form_state
->getTriggeringElement();
$delta = array_slice($triggering_element['#array_parents'], -2, 1)[0];
$added_media = $form_state
->get('media');
$removed_media = $added_media[$delta];
// Update the list of added media items in the form state.
unset($added_media[$delta]);
// Update the media items in the form state.
$form_state
->set('media', $added_media)
->setRebuild();
// Show a message to the user to confirm the media is removed.
$this
->messenger()
->addStatus($this
->t('The media item %label has been removed.', [
'%label' => $removed_media
->label(),
]));
}
/**
* AJAX callback to send the new media item(s) to the media library.
*
* @param array $form
* The complete form.
* @param \Drupal\Core\Form\FormStateInterface $form_state
* The current form state.
*
* @return array|\Drupal\Core\Ajax\AjaxResponse
* The form array if there are validation errors, or an AJAX response to add
* the created items to the current selection.
*/
public function updateLibrary(array &$form, FormStateInterface $form_state) {
if ($form_state::hasAnyErrors()) {
return $form;
}
$form_state
->setStorage([]);
$form_state
->setRebuild();
$response = new AjaxResponse();
$response
->addCommand(new CloseModalDialogCommand());
$response
->addCommand(new RefreshDirectoryTree($form_state
->getValue('most_choosen_directory_tid'), $form_state
->getValue('newly_added_media_ids')));
$status_messages = [
'#type' => 'status_messages',
];
$messages = \Drupal::service('renderer')
->renderRoot($status_messages);
if (!empty($messages)) {
$response
->addCommand(new OpenModalDialogCommand('', $messages));
}
return $response;
}
/**
* Creates media items from source field input values.
*
* @param mixed[] $source_field_values
* The values for source fields of the media items.
* @param array $form
* The complete form.
* @param \Drupal\Core\Form\FormStateInterface $form_state
* The current form state.
*
* @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
*/
protected function processInputValues(array $source_field_values, array $form, FormStateInterface $form_state) {
$media_type = $this
->getMediaType($form_state);
$media_storage = $this->entityTypeManager
->getStorage('media');
$source_field_name = $this
->getSourceFieldName($media_type);
$media = array_map(function ($source_field_value) use ($media_type, $media_storage, $source_field_name, $form_state) {
return $this
->createMediaFromValue($media_type, $media_storage, $source_field_name, $source_field_value, $form_state);
}, $source_field_values);
// Re-key the media items before setting them in the form state.
$form_state
->set('media', array_values($media));
// Save the selected items in the form state so they are remembered when an
// item is removed.
// $form_state->set('current_selection', array_filter(explode(',', $form_state->getValue('current_selection'))));.
$form_state
->setRebuild();
}
/**
* Creates a new, unsaved media item from a source field value.
*
* @param \Drupal\media\MediaTypeInterface $media_type
* The media type of the media item.
* @param \Drupal\Core\Entity\EntityStorageInterface $media_storage
* The media storage.
* @param string $source_field_name
* The name of the media type's source field.
* @param mixed $source_field_value
* The value for the source field of the media item.
* @param \Drupal\Core\Form\FormStateInterface $form_state
* The form state.
*
* @return \Drupal\media\MediaInterface
* An unsaved media entity.
*/
protected function createMediaFromValue(MediaTypeInterface $media_type, EntityStorageInterface $media_storage, $source_field_name, $source_field_value, FormStateInterface $form_state) {
$media = $media_storage
->create([
'bundle' => $media_type
->id(),
$source_field_name => $source_field_value,
'directory' => $this
->getDirectory($form_state),
]);
$media
->setName($media
->getName());
return $media;
}
}Members
Name |
Modifiers | Type | Description | Overrides |
|---|---|---|---|---|
|
AddMediaFormBase:: |
protected | property | Current user service. | |
|
AddMediaFormBase:: |
protected | property | Entity type manager service. | |
|
AddMediaFormBase:: |
protected | property | The theme manager. | |
|
AddMediaFormBase:: |
protected | property | The token replacement instance. | |
|
AddMediaFormBase:: |
protected | function | Returns an array of supported actions for the form. | 1 |
|
AddMediaFormBase:: |
protected | function | Builds the sub-form for setting required fields on a new media item. | 1 |
|
AddMediaFormBase:: |
public | function |
Form constructor. Overrides FormInterface:: |
1 |
|
AddMediaFormBase:: |
abstract protected | function | Inheriting classes need to build the desired input element. | 3 |
|
AddMediaFormBase:: |
public static | function |
Instantiates a new instance of this class. Overrides FormBase:: |
2 |
|
AddMediaFormBase:: |
protected | function | Create a file field item. | |
|
AddMediaFormBase:: |
protected | function | Creates a new, unsaved media item from a source field value. | |
|
AddMediaFormBase:: |
protected | function | Get the current cardinality from the form state. | |
|
AddMediaFormBase:: |
protected | function | Gets the current active directory from the form state. | |
|
AddMediaFormBase:: |
public | function |
Returns a unique string identifying the form. Overrides FormInterface:: |
2 |
|
AddMediaFormBase:: |
protected | function | Get the media type from the form state. | 2 |
|
AddMediaFormBase:: |
protected | function | Get the current selection mode from the form state. | |
|
AddMediaFormBase:: |
protected | function | Returns the name of the source field for a media type. | 1 |
|
AddMediaFormBase:: |
protected | function | Get the allowed target bundles from the form state. | 1 |
|
AddMediaFormBase:: |
protected | function | Determines the URI for a file field. | |
|
AddMediaFormBase:: |
protected | function | Returns the upload validators for a field. | |
|
AddMediaFormBase:: |
public static | function | Processes an image or file source field element. | |
|
AddMediaFormBase:: |
protected | function | Creates media items from source field input values. | 1 |
|
AddMediaFormBase:: |
public | function | Submit handler for the remove button. | |
|
AddMediaFormBase:: |
public | function |
Form submission handler. Overrides FormInterface:: |
1 |
|
AddMediaFormBase:: |
public | function | AJAX callback to update the entire form based on source field input. | 1 |
|
AddMediaFormBase:: |
public | function | AJAX callback to send the new media item(s) to the media library. | |
|
AddMediaFormBase:: |
public | function | AddMediaFormBase constructor. | 2 |
|
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
|
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
|
DependencySerializationTrait:: |
public | function | 1 | |
|
DependencySerializationTrait:: |
public | function | 2 | |
|
FormBase:: |
protected | property | The config factory. | 1 |
|
FormBase:: |
protected | property | The request stack. | 1 |
|
FormBase:: |
protected | property | The route match. | |
|
FormBase:: |
protected | function | Retrieves a configuration object. | |
|
FormBase:: |
protected | function | Gets the config factory for this form. | 1 |
|
FormBase:: |
private | function | Returns the service container. | |
|
FormBase:: |
protected | function | Gets the current user. | |
|
FormBase:: |
protected | function | Gets the request object. | |
|
FormBase:: |
protected | function | Gets the route match. | |
|
FormBase:: |
protected | function | Gets the logger for a specific channel. | |
|
FormBase:: |
protected | function |
Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait:: |
|
|
FormBase:: |
public | function | Resets the configuration factory. | |
|
FormBase:: |
public | function | Sets the config factory for this form. | |
|
FormBase:: |
public | function | Sets the request stack object to use. | |
|
FormBase:: |
public | function |
Form validation handler. Overrides FormInterface:: |
62 |
|
LinkGeneratorTrait:: |
protected | property | The link generator. | 1 |
|
LinkGeneratorTrait:: |
protected | function | Returns the link generator. | |
|
LinkGeneratorTrait:: |
protected | function | Renders a link to a route given a route name and its parameters. | |
|
LinkGeneratorTrait:: |
public | function | Sets the link generator service. | |
|
LoggerChannelTrait:: |
protected | property | The logger channel factory service. | |
|
LoggerChannelTrait:: |
protected | function | Gets the logger for a specific channel. | |
|
LoggerChannelTrait:: |
public | function | Injects the logger channel factory. | |
|
MessengerTrait:: |
protected | property | The messenger. | 29 |
|
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
|
MessengerTrait:: |
public | function | Sets the messenger. | |
|
RedirectDestinationTrait:: |
protected | property | The redirect destination service. | 1 |
|
RedirectDestinationTrait:: |
protected | function | Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url. | |
|
RedirectDestinationTrait:: |
protected | function | Returns the redirect destination service. | |
|
RedirectDestinationTrait:: |
public | function | Sets the redirect destination service. | |
|
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
|
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
|
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
|
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
|
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
|
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. | |
|
UrlGeneratorTrait:: |
protected | property | The url generator. | |
|
UrlGeneratorTrait:: |
protected | function | Returns the URL generator service. | |
|
UrlGeneratorTrait:: |
public | function | Sets the URL generator service. | |
|
UrlGeneratorTrait:: |
protected | function | Generates a URL or path for a specific route based on the given parameters. |