class FileEditForm in File Entity (fieldable files) 8.2
Form controller for file type forms.
Hierarchy
- class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\Core\Entity\EntityForm implements EntityFormInterface
- class \Drupal\Core\Entity\ContentEntityForm implements ContentEntityFormInterface
- class \Drupal\file_entity\Form\FileEditForm uses UploadValidatorsTrait
- class \Drupal\Core\Entity\ContentEntityForm implements ContentEntityFormInterface
- class \Drupal\Core\Entity\EntityForm implements EntityFormInterface
Expanded class hierarchy of FileEditForm
File
- src/
Form/ FileEditForm.php, line 22
Namespace
Drupal\file_entity\FormView source
class FileEditForm extends ContentEntityForm {
use UploadValidatorsTrait;
/**
* The renderer.
*
* @var \Drupal\Core\Render\RendererInterface
*/
protected $renderer;
/**
* The file system service.
*
* @var \Drupal\Core\File\FileSystemInterface
*/
protected $fileSystem;
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container) {
/** @var static $form */
$form = parent::create($container);
$form->renderer = $container
->get('renderer');
$form->fileSystem = $container
->get('file_system');
return $form;
}
/**
* {@inheritdoc}
*/
public function prepareEntity() {
if ($this->entity
->bundle() == FILE_TYPE_NONE) {
$this->entity
->updateBundle();
}
}
/**
* {@inheritdoc}
*/
public function form(array $form, FormStateInterface $form_state) {
/** @var FileInterface $file */
$file = $this->entity;
if ($this->operation == 'edit') {
if ($file
->bundle() == 'undefined') {
$type = $this
->t('file');
}
else {
$type = FileType::load($file
->bundle())
->label();
}
$form['#title'] = $this
->t('<em>Edit @type</em> "@title"', array(
'@type' => $type,
'@title' => $file
->label(),
));
// Add a 'replace this file' upload field if the file is writeable.
if ($file
->isWritable()) {
// Set up replacement file validation.
$replacement_options = array();
// Replacement file must have the same extension as the original file.
$replacement_options['file_extensions'] = pathinfo($file
->getFilename(), PATHINFO_EXTENSION);
$form['replace_upload'] = array(
'#type' => 'managed_file',
'#title' => $this
->t('Replace file'),
'#upload_validators' => $this
->getUploadValidators($replacement_options),
);
$file_upload_help = array(
'#theme' => 'file_upload_help',
'#description' => $this
->t('This file will replace the existing file. This action cannot be undone.'),
'#upload_validators' => $form['replace_upload']['#upload_validators'],
);
$form['replace_upload']['#description'] = $this->renderer
->render($file_upload_help);
}
}
return parent::form($form, $form_state, $file);
}
/**
* {@inheritdoc}
*/
public function save(array $form, FormStateInterface $form_state) {
$file = $this->entity;
$insert = $file
->isNew();
$file
->save();
$t_args = array(
'%title' => $file
->label(),
);
if ($insert) {
$this
->messenger()
->addMessage(t('%title has been created.', $t_args));
}
else {
$this
->messenger()
->addMessage(t('%title has been updated.', $t_args));
}
// Check if file ID exists.
if ($file
->id()) {
$form_state
->setRedirectUrl($file
->toUrl());
}
else {
// In the unlikely case something went wrong on save, the file will be
// rebuilt and file form redisplayed the same way as in preview.
$this
->messenger()
->addMessage(t('The post could not be saved.'), 'error');
$form_state
->setRebuild();
}
}
/**
* {@inheritdoc}
*/
public function validateForm(array &$form, FormStateInterface $form_state) {
// Handle the replacement file if uploaded.
if ($form_state
->getValue('replace_upload')) {
// Save the file as a temporary file.
$file = file_save_upload('replace_upload', $form['replace_upload']['#upload_validators']);
if (!empty($file)) {
// Put the temporary file in form_state so we can save it on submit.
$form_state
->setValue('replace_upload', $file);
}
elseif ($file === FALSE) {
// File uploaded failed.
$form_state
->setError($form['replace_upload'], t('The replacement file could not be uploaded.'));
}
}
parent::validateForm($form, $form_state);
}
/**
* {@inheritdoc}
*/
public function submitForm(array &$form, FormStateInterface $form_state) {
// Check if a replacement file has been uploaded.
if ($form_state
->getValue('replace_upload')) {
$replacement = $form_state
->getValue('replace_upload')[0];
if ($replacement instanceof FileEntity) {
$entity_replacement = $replacement;
}
else {
$entity_replacement = File::load($replacement);
}
$log_args = array(
'@old' => $this->entity
->getFilename(),
'@new' => $entity_replacement
->getFileName(),
);
// Move file from temp to permanent home.
if ($this->fileSystem
->copy($entity_replacement
->getFileUri(), $this->entity
->getFileUri(), FileSystemInterface::EXISTS_REPLACE)) {
$entity_replacement
->delete();
\Drupal::logger('file_entity')
->info('File @old was replaced by @new', $log_args);
}
else {
\Drupal::logger('file_entity')
->notice('File @old failed to be replaced by @new', $log_args);
}
}
parent::submitForm($form, $form_state);
}
}
Members
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ContentEntityForm:: |
protected | property |
The entity being used by this form. Overrides EntityForm:: |
9 |
ContentEntityForm:: |
protected | property | The entity repository service. | |
ContentEntityForm:: |
protected | property | The entity type bundle info service. | |
ContentEntityForm:: |
protected | property | The time service. | |
ContentEntityForm:: |
protected | function | Add revision form fields if the entity enabled the UI. | |
ContentEntityForm:: |
public | function |
Builds an updated entity object based upon the submitted form values. Overrides EntityForm:: |
3 |
ContentEntityForm:: |
protected | function |
Copies top-level form values to entity properties Overrides EntityForm:: |
|
ContentEntityForm:: |
protected | function | Flags violations for the current form. | 4 |
ContentEntityForm:: |
protected | function | Returns the bundle entity of the entity, or NULL if there is none. | |
ContentEntityForm:: |
protected | function | Gets the names of all fields edited in the form. | 4 |
ContentEntityForm:: |
public | function |
Gets the form display. Overrides ContentEntityFormInterface:: |
|
ContentEntityForm:: |
public | function |
Gets the code identifying the active form language. Overrides ContentEntityFormInterface:: |
|
ContentEntityForm:: |
protected | function | Should new revisions created on default. | |
ContentEntityForm:: |
protected | function |
Initializes the form state and the entity before the first form build. Overrides EntityForm:: |
1 |
ContentEntityForm:: |
protected | function | Initializes form language code values. | |
ContentEntityForm:: |
public | function |
Checks whether the current form language matches the entity one. Overrides ContentEntityFormInterface:: |
|
ContentEntityForm:: |
public | function |
Sets the form display. Overrides ContentEntityFormInterface:: |
|
ContentEntityForm:: |
protected | function | Checks whether the revision form fields should be added to the form. | |
ContentEntityForm:: |
public | function | Updates the changed time of the entity. | |
ContentEntityForm:: |
public | function | Updates the form language to reflect any change to the entity language. | |
ContentEntityForm:: |
public | function | Constructs a ContentEntityForm object. | 9 |
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 | |
EntityForm:: |
protected | property | The entity type manager. | 3 |
EntityForm:: |
protected | property | The module handler service. | |
EntityForm:: |
protected | property | The name of the current operation. | |
EntityForm:: |
private | property | The entity manager. | |
EntityForm:: |
protected | function | Returns an array of supported actions for the current entity form. | 29 |
EntityForm:: |
protected | function | Returns the action form element for the current entity form. | |
EntityForm:: |
public | function | Form element #after_build callback: Updates the entity with submitted data. | |
EntityForm:: |
public | function |
Form constructor. Overrides FormInterface:: |
10 |
EntityForm:: |
public | function |
Returns a string identifying the base form. Overrides BaseFormIdInterface:: |
5 |
EntityForm:: |
public | function |
Gets the form entity. Overrides EntityFormInterface:: |
|
EntityForm:: |
public | function |
Determines which entity will be used by this form from a RouteMatch object. Overrides EntityFormInterface:: |
1 |
EntityForm:: |
public | function |
Returns a unique string identifying the form. Overrides FormInterface:: |
10 |
EntityForm:: |
public | function |
Gets the operation identifying the form. Overrides EntityFormInterface:: |
|
EntityForm:: |
protected | function | Invokes the specified prepare hook variant. | |
EntityForm:: |
public | function | Process callback: assigns weights and hides extra fields. | |
EntityForm:: |
public | function |
Sets the form entity. Overrides EntityFormInterface:: |
|
EntityForm:: |
public | function |
Sets the entity manager for this form. Overrides EntityFormInterface:: |
|
EntityForm:: |
public | function |
Sets the entity type manager for this form. Overrides EntityFormInterface:: |
|
EntityForm:: |
public | function |
Sets the module handler for this form. Overrides EntityFormInterface:: |
|
EntityForm:: |
public | function |
Sets the operation for this form. Overrides EntityFormInterface:: |
|
EntityForm:: |
public | function | ||
EntityForm:: |
public | function | ||
FileEditForm:: |
protected | property | The file system service. | |
FileEditForm:: |
protected | property | The renderer. | |
FileEditForm:: |
public static | function |
Instantiates a new instance of this class. Overrides ContentEntityForm:: |
|
FileEditForm:: |
public | function |
Gets the actual form array to be built. Overrides ContentEntityForm:: |
1 |
FileEditForm:: |
public | function |
Prepares the entity object before the form is built first. Overrides ContentEntityForm:: |
|
FileEditForm:: |
public | function |
Form submission handler for the 'save' action. Overrides EntityForm:: |
|
FileEditForm:: |
public | function |
This is the default entity object builder function. It is called before any
other submit handler to build the new entity object to be used by the
following submit handlers. At this point of the form workflow the entity is
validated and the form state… Overrides ContentEntityForm:: |
|
FileEditForm:: |
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… Overrides ContentEntityForm:: |
|
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. | |
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. | |
UploadValidatorsTrait:: |
public | function | Retrieves the upload validators for a file or archive. | |
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. |