class MediaForm
Same name and namespace in other branches
- 11.x core/modules/media/src/MediaForm.php \Drupal\media\MediaForm
Form controller for the media edit forms.
@internal
Hierarchy
- class \Drupal\Core\Form\FormBase extends \Drupal\Core\Form\FormInterface, \Drupal\Core\DependencyInjection\ContainerInjectionInterface uses \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Logger\LoggerChannelTrait, \Drupal\Core\Messenger\MessengerTrait, \Drupal\Core\Routing\RedirectDestinationTrait, \Drupal\Core\StringTranslation\StringTranslationTrait
- class \Drupal\Core\Entity\EntityForm extends \Drupal\Core\Entity\EntityFormInterface implements \Drupal\Core\Form\FormBase
- class \Drupal\Core\Entity\ContentEntityForm extends \Drupal\Core\Entity\ContentEntityFormInterface implements \Drupal\Core\Entity\EntityForm
- class \Drupal\media\MediaForm implements \Drupal\Core\Entity\ContentEntityForm
- class \Drupal\Core\Entity\ContentEntityForm extends \Drupal\Core\Entity\ContentEntityFormInterface implements \Drupal\Core\Entity\EntityForm
- class \Drupal\Core\Entity\EntityForm extends \Drupal\Core\Entity\EntityFormInterface implements \Drupal\Core\Form\FormBase
Expanded class hierarchy of MediaForm
2 files declare their use of MediaForm
- claro.theme in core/
themes/ claro/ claro.theme - Functions to support theming in the Claro theme.
- seven.theme in core/
themes/ seven/ seven.theme - Functions to support theming in the Seven theme.
File
-
core/
modules/ media/ src/ MediaForm.php, line 13
Namespace
Drupal\mediaView source
class MediaForm extends ContentEntityForm {
/**
* {@inheritdoc}
*/
public function form(array $form, FormStateInterface $form_state) {
$form = parent::form($form, $form_state);
/** @var \Drupal\media\MediaTypeInterface $media_type */
$media_type = $this->entity->bundle->entity;
if ($this->operation === 'edit') {
$form['#title'] = $this->t('Edit %type_label @label', [
'%type_label' => $media_type->label(),
'@label' => $this->entity
->label(),
]);
}
// Media author information for administrators.
if (isset($form['uid']) || isset($form['created'])) {
$form['author'] = [
'#type' => 'details',
'#title' => $this->t('Authoring information'),
'#group' => 'advanced',
'#attributes' => [
'class' => [
'media-form-author',
],
],
'#weight' => 90,
'#optional' => TRUE,
];
}
if (isset($form['uid'])) {
$form['uid']['#group'] = 'author';
}
if (isset($form['created'])) {
$form['created']['#group'] = 'author';
}
$form['#attached']['library'][] = 'media/form';
return $form;
}
/**
* {@inheritdoc}
*/
public function save(array $form, FormStateInterface $form_state) {
$saved = parent::save($form, $form_state);
$context = [
'@type' => $this->entity
->bundle(),
'%label' => $this->entity
->label(),
'link' => $this->entity
->toLink($this->t('View'))
->toString(),
];
$logger = $this->logger('media');
$t_args = [
'@type' => $this->entity->bundle->entity
->label(),
'%label' => $this->entity
->toLink($this->entity
->label())
->toString(),
];
if ($saved === SAVED_NEW) {
$logger->notice('@type: added %label.', $context);
$this->messenger()
->addStatus($this->t('@type %label has been created.', $t_args));
}
else {
$logger->notice('@type: updated %label.', $context);
$this->messenger()
->addStatus($this->t('@type %label has been updated.', $t_args));
}
// Redirect the user to the media overview if the user has the 'access media
// overview' permission. If not, redirect to the canonical URL of the media
// item.
if ($this->currentUser()
->hasPermission('access media overview')) {
$form_state->setRedirectUrl($this->entity
->toUrl('collection'));
}
else {
$form_state->setRedirectUrl($this->entity
->toUrl());
}
return $saved;
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
ContentEntityForm::$entity | protected | property | The entity being used by this form. | ||
ContentEntityForm::$entityRepository | protected | property | The entity repository service. | ||
ContentEntityForm::$entityTypeBundleInfo | protected | property | The entity type bundle info service. | ||
ContentEntityForm::$time | protected | property | The time service. | ||
ContentEntityForm::addRevisionableFormFields | protected | function | Add revision form fields if the entity enabled the UI. | ||
ContentEntityForm::buildEntity | public | function | 1 | ||
ContentEntityForm::buildEntity | public | function | 1 | ||
ContentEntityForm::copyFormValuesToEntity | protected | function | |||
ContentEntityForm::create | public static | function | 2 | ||
ContentEntityForm::create | public static | function | 2 | ||
ContentEntityForm::flagViolations | protected | function | Flags violations for the current form. | 1 | |
ContentEntityForm::flagViolations | protected | function | Flags violations for the current form. | 1 | |
ContentEntityForm::getBundleEntity | protected | function | Returns the bundle entity of the entity, or NULL if there is none. | ||
ContentEntityForm::getEditedFieldNames | protected | function | Gets the names of all fields edited in the form. | 1 | |
ContentEntityForm::getEditedFieldNames | protected | function | Gets the names of all fields edited in the form. | 1 | |
ContentEntityForm::getFormDisplay | public | function | |||
ContentEntityForm::getFormLangcode | public | function | |||
ContentEntityForm::getNewRevisionDefault | protected | function | Should new revisions created on default. | ||
ContentEntityForm::init | protected | function | Initializes the form state and the entity before the first form build. | 1 | |
ContentEntityForm::init | protected | function | Initializes the form state and the entity before the first form build. | 1 | |
ContentEntityForm::initFormLangcodes | protected | function | Initializes form language code values. | ||
ContentEntityForm::isDefaultFormLangcode | public | function | |||
ContentEntityForm::prepareEntity | protected | function | |||
ContentEntityForm::setFormDisplay | public | function | |||
ContentEntityForm::showRevisionUi | protected | function | Checks whether the revision form fields should be added to the form. | ||
ContentEntityForm::submitForm | public | function | 1 | ||
ContentEntityForm::submitForm | public | function | 1 | ||
ContentEntityForm::updateChangedTime | public | function | Updates the changed time of the entity. | ||
ContentEntityForm::updateFormLangcode | public | function | Updates the form language to reflect any change to the entity language. | ||
ContentEntityForm::validateForm | public | function | Button-level validation handlers are highly discouraged for entity forms, as they will prevent entity validation from running. If the entity is going to be saved during the form submission, this method should be manually invoked from the button-level… |
||
ContentEntityForm::__construct | public | function | Constructs a ContentEntityForm object. | 2 | |
ContentEntityForm::__construct | public | function | Constructs a ContentEntityForm object. | 2 | |
DependencySerializationTrait::$_entityStorages | protected | property | An array of entity type IDs keyed by the property name of their storages. | ||
DependencySerializationTrait::$_serviceIds | protected | property | An array of service IDs keyed by property name used for serialization. | ||
DependencySerializationTrait::__sleep | public | function | |||
DependencySerializationTrait::__wakeup | public | function | #[\ReturnTypeWillChange] | ||
EntityForm::$entityTypeManager | protected | property | The entity type manager. | 1 | |
EntityForm::$entityTypeManager | protected | property | The entity type manager. | 1 | |
EntityForm::$moduleHandler | protected | property | The module handler service. | ||
EntityForm::$operation | protected | property | The name of the current operation. | ||
EntityForm::actions | protected | function | Returns an array of supported actions for the current entity form. | 7 | |
EntityForm::actions | protected | function | Returns an array of supported actions for the current entity form. | 7 | |
EntityForm::actionsElement | protected | function | Returns the action form element for the current entity form. | ||
EntityForm::afterBuild | public | function | Form element #after_build callback: Updates the entity with submitted data. | ||
EntityForm::buildForm | public | function | 5 | ||
EntityForm::buildForm | public | function | 5 | ||
EntityForm::getBaseFormId | public | function | 2 | ||
EntityForm::getBaseFormId | public | function | 2 | ||
EntityForm::getEntity | public | function | |||
EntityForm::getEntityFromRouteMatch | public | function | 1 | ||
EntityForm::getEntityFromRouteMatch | public | function | 1 | ||
EntityForm::getFormId | public | function | 4 | ||
EntityForm::getFormId | public | function | 4 | ||
EntityForm::getOperation | public | function | |||
EntityForm::prepareInvokeAll | protected | function | Invokes the specified prepare hook variant. | ||
EntityForm::processForm | public | function | Process callback: assigns weights and hides extra fields. | ||
EntityForm::setEntity | public | function | |||
EntityForm::setEntityTypeManager | public | function | |||
EntityForm::setModuleHandler | public | function | |||
EntityForm::setOperation | public | function | |||
FormBase::$configFactory | protected | property | The config factory. | ||
FormBase::$requestStack | protected | property | The request stack. | ||
FormBase::$routeMatch | protected | property | The route match. | ||
FormBase::config | protected | function | Retrieves a configuration object. | ||
FormBase::configFactory | protected | function | Gets the config factory for this form. | ||
FormBase::container | private | function | Returns the service container. | ||
FormBase::currentUser | protected | function | Gets the current user. | ||
FormBase::getRequest | protected | function | Gets the request object. | ||
FormBase::getRouteMatch | protected | function | Gets the route match. | ||
FormBase::logger | protected | function | Gets the logger for a specific channel. | ||
FormBase::redirect | protected | function | Returns a redirect response object for the specified route. | ||
FormBase::resetConfigFactory | public | function | Resets the configuration factory. | ||
FormBase::setConfigFactory | public | function | Sets the config factory for this form. | ||
FormBase::setRequestStack | public | function | Sets the request stack object to use. | ||
LoggerChannelTrait::$loggerFactory | protected | property | The logger channel factory service. | ||
LoggerChannelTrait::getLogger | protected | function | Gets the logger for a specific channel. | ||
LoggerChannelTrait::setLoggerFactory | public | function | Injects the logger channel factory. | ||
MediaForm::form | public | function | Gets the actual form array to be built. | Overrides ContentEntityForm::form | |
MediaForm::save | public | function | Form submission handler for the 'save' action. | Overrides EntityForm::save | |
MessengerTrait::$messenger | protected | property | The messenger. | 7 | |
MessengerTrait::$messenger | protected | property | The messenger. | 7 | |
MessengerTrait::messenger | public | function | Gets the messenger. | 7 | |
MessengerTrait::messenger | public | function | Gets the messenger. | 7 | |
MessengerTrait::setMessenger | public | function | Sets the messenger. | ||
RedirectDestinationTrait::$redirectDestination | protected | property | The redirect destination service. | ||
RedirectDestinationTrait::getDestinationArray | protected | function | Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url. | ||
RedirectDestinationTrait::getRedirectDestination | protected | function | Returns the redirect destination service. | ||
RedirectDestinationTrait::setRedirectDestination | public | function | Sets the redirect destination service. | ||
StringTranslationTrait::$stringTranslation | protected | property | The string translation service. | ||
StringTranslationTrait::formatPlural | protected | function | Formats a string containing a count of items. | ||
StringTranslationTrait::getNumberOfPlurals | protected | function | Returns the number of plurals supported by a given language. | ||
StringTranslationTrait::getStringTranslation | protected | function | Gets the string translation service. | ||
StringTranslationTrait::setStringTranslation | public | function | Sets the string translation service to use. | ||
StringTranslationTrait::t | protected | function | Translates a string to the current language or to a given language. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.