class BreakLockForm
Same name and namespace in other branches
- 9 core/modules/views_ui/src/Form/BreakLockForm.php \Drupal\views_ui\Form\BreakLockForm
- 10 core/modules/views_ui/src/Form/BreakLockForm.php \Drupal\views_ui\Form\BreakLockForm
- 11.x core/modules/views_ui/src/Form/BreakLockForm.php \Drupal\views_ui\Form\BreakLockForm
Builds the form to break the lock of an edited view.
@internal
Hierarchy
- class \Drupal\Core\Form\FormBase extends \Drupal\Core\Form\FormInterface, \Drupal\Core\DependencyInjection\ContainerInjectionInterface uses \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Routing\LinkGeneratorTrait, \Drupal\Core\Logger\LoggerChannelTrait, \Drupal\Core\Messenger\MessengerTrait, \Drupal\Core\Routing\RedirectDestinationTrait, \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\Routing\UrlGeneratorTrait
- class \Drupal\Core\Entity\EntityForm extends \Drupal\Core\Entity\EntityFormInterface implements \Drupal\Core\Form\FormBase
- class \Drupal\Core\Entity\EntityConfirmFormBase extends \Drupal\Core\Form\ConfirmFormInterface implements \Drupal\Core\Entity\EntityForm
- class \Drupal\views_ui\Form\BreakLockForm uses \Drupal\Core\DependencyInjection\DeprecatedServicePropertyTrait implements \Drupal\Core\Entity\EntityConfirmFormBase
- class \Drupal\Core\Entity\EntityConfirmFormBase extends \Drupal\Core\Form\ConfirmFormInterface implements \Drupal\Core\Entity\EntityForm
- class \Drupal\Core\Entity\EntityForm extends \Drupal\Core\Entity\EntityFormInterface implements \Drupal\Core\Form\FormBase
Expanded class hierarchy of BreakLockForm
File
-
core/
modules/ views_ui/ src/ Form/ BreakLockForm.php, line 17
Namespace
Drupal\views_ui\FormView source
class BreakLockForm extends EntityConfirmFormBase {
use DeprecatedServicePropertyTrait;
/**
* {@inheritdoc}
*/
protected $deprecatedProperties = [
'entityManager' => 'entity.manager',
];
/**
* Stores the entity type manager.
*
* @var \Drupal\Core\Entity\EntityTypeManagerInterface
*/
protected $entityTypeManager;
/**
* Stores the shared tempstore.
*
* @var \Drupal\Core\TempStore\SharedTempStore
*/
protected $tempStore;
/**
* Constructs a \Drupal\views_ui\Form\BreakLockForm object.
*
* @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
* The Entity manager.
* @param \Drupal\Core\TempStore\SharedTempStoreFactory $temp_store_factory
* The factory for the temp store object.
*/
public function __construct(EntityTypeManagerInterface $entity_type_manager, SharedTempStoreFactory $temp_store_factory) {
$this->entityTypeManager = $entity_type_manager;
$this->tempStore = $temp_store_factory->get('views');
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container) {
return new static($container->get('entity_type.manager'), $container->get('tempstore.shared'));
}
/**
* {@inheritdoc}
*/
public function getFormId() {
return 'views_ui_break_lock_confirm';
}
/**
* {@inheritdoc}
*/
public function getQuestion() {
return $this->t('Do you want to break the lock on view %name?', [
'%name' => $this->entity
->id(),
]);
}
/**
* {@inheritdoc}
*/
public function getDescription() {
$locked = $this->tempStore
->getMetadata($this->entity
->id());
$account = $this->entityTypeManager
->getStorage('user')
->load($locked->getOwnerId());
$username = [
'#theme' => 'username',
'#account' => $account,
];
return $this->t('By breaking this lock, any unsaved changes made by @user will be lost.', [
'@user' => \Drupal::service('renderer')->render($username),
]);
}
/**
* {@inheritdoc}
*/
public function getCancelUrl() {
return $this->entity
->toUrl('edit-form');
}
/**
* {@inheritdoc}
*/
public function getConfirmText() {
return $this->t('Break lock');
}
/**
* {@inheritdoc}
*/
public function buildForm(array $form, FormStateInterface $form_state) {
if (!$this->tempStore
->getMetadata($this->entity
->id())) {
$form['message']['#markup'] = $this->t('There is no lock on view %name to break.', [
'%name' => $this->entity
->id(),
]);
return $form;
}
return parent::buildForm($form, $form_state);
}
/**
* {@inheritdoc}
*/
public function submitForm(array &$form, FormStateInterface $form_state) {
$this->tempStore
->delete($this->entity
->id());
$form_state->setRedirectUrl($this->entity
->toUrl('edit-form'));
$this->messenger()
->addStatus($this->t('The lock has been broken and you may now edit this view.'));
}
}
Members
Title Sort descending | Deprecated | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|---|
BreakLockForm::$deprecatedProperties | protected | property | ||||
BreakLockForm::$entityTypeManager | protected | property | Stores the entity type manager. | Overrides EntityForm::$entityTypeManager | ||
BreakLockForm::$tempStore | protected | property | Stores the shared tempstore. | |||
BreakLockForm::buildForm | public | function | Overrides EntityConfirmFormBase::buildForm | |||
BreakLockForm::create | public static | function | Overrides FormBase::create | |||
BreakLockForm::getCancelUrl | public | function | Overrides ConfirmFormInterface::getCancelUrl | |||
BreakLockForm::getConfirmText | public | function | Overrides EntityConfirmFormBase::getConfirmText | |||
BreakLockForm::getDescription | public | function | Overrides EntityConfirmFormBase::getDescription | |||
BreakLockForm::getFormId | public | function | Overrides EntityForm::getFormId | |||
BreakLockForm::getQuestion | public | function | Overrides ConfirmFormInterface::getQuestion | |||
BreakLockForm::submitForm | public | function | Overrides EntityForm::submitForm | |||
BreakLockForm::__construct | public | function | Constructs a \Drupal\views_ui\Form\BreakLockForm object. | |||
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 | 1 | |||
DependencySerializationTrait::__wakeup | public | function | 2 | |||
DeprecatedServicePropertyTrait::__get | public | function | Allows to access deprecated/removed properties. | |||
EntityConfirmFormBase::actions | protected | function | Overrides EntityForm::actions | 1 | ||
EntityConfirmFormBase::delete | public | function | The delete() method is not used in EntityConfirmFormBase. This overrides the default implementation that redirects to the delete-form confirmation form. |
|||
EntityConfirmFormBase::getBaseFormId | public | function | Overrides EntityForm::getBaseFormId | |||
EntityConfirmFormBase::getCancelText | public | function | Overrides ConfirmFormInterface::getCancelText | |||
EntityConfirmFormBase::getFormName | public | function | Overrides ConfirmFormInterface::getFormName | |||
EntityConfirmFormBase::save | public | function | The save() method is not used in EntityConfirmFormBase. This overrides the default implementation that saves the entity. |
Overrides EntityForm::save | ||
EntityForm::$entity | protected | property | The entity being used by this form. | 11 | ||
EntityForm::$moduleHandler | protected | property | The module handler service. | |||
EntityForm::$operation | protected | property | The name of the current operation. | |||
EntityForm::$privateEntityManager | private | property | The entity manager. | |||
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::buildEntity | public | function | Overrides EntityFormInterface::buildEntity | 3 | ||
EntityForm::copyFormValuesToEntity | protected | function | Copies top-level form values to entity properties | 9 | ||
EntityForm::form | public | function | Gets the actual form array to be built. | 36 | ||
EntityForm::getEntity | public | function | Overrides EntityFormInterface::getEntity | |||
EntityForm::getEntityFromRouteMatch | public | function | Overrides EntityFormInterface::getEntityFromRouteMatch | 3 | ||
EntityForm::getOperation | public | function | Overrides EntityFormInterface::getOperation | |||
EntityForm::init | protected | function | Initialize the form state and the entity before the first form build. | 3 | ||
EntityForm::prepareEntity | protected | function | Prepares the entity object before the form is built first. | 3 | ||
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 | Overrides EntityFormInterface::setEntity | |||
EntityForm::setEntityManager | public | function | Overrides EntityFormInterface::setEntityManager | |||
EntityForm::setEntityTypeManager | public | function | Overrides EntityFormInterface::setEntityTypeManager | |||
EntityForm::setModuleHandler | public | function | Overrides EntityFormInterface::setModuleHandler | |||
EntityForm::setOperation | public | function | Overrides EntityFormInterface::setOperation | |||
EntityForm::__set | public | function | ||||
FormBase::$configFactory | protected | property | The config factory. | 3 | ||
FormBase::$requestStack | protected | property | The request stack. | 1 | ||
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. | 3 | ||
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. | Overrides UrlGeneratorTrait::redirect | ||
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. | |||
FormBase::validateForm | public | function | Overrides FormInterface::validateForm | 73 | ||
LinkGeneratorTrait::$linkGenerator | protected | property | The link generator. | 1 | ||
LinkGeneratorTrait::getLinkGenerator | Deprecated | protected | function | Returns the link generator. | ||
LinkGeneratorTrait::l | Deprecated | protected | function | Renders a link to a route given a route name and its parameters. | ||
LinkGeneratorTrait::setLinkGenerator | Deprecated | public | function | Sets the link generator service. | ||
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. | |||
MessengerTrait::$messenger | protected | property | The messenger. | 17 | ||
MessengerTrait::messenger | public | function | Gets the messenger. | 17 | ||
MessengerTrait::setMessenger | public | function | Sets the messenger. | |||
RedirectDestinationTrait::$redirectDestination | protected | property | The redirect destination service. | 1 | ||
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. | 2 | ||
StringTranslationTrait::t | protected | function | Translates a string to the current language or to a given language. | |||
UrlGeneratorTrait::$urlGenerator | protected | property | The url generator. | |||
UrlGeneratorTrait::getUrlGenerator | Deprecated | protected | function | Returns the URL generator service. | ||
UrlGeneratorTrait::setUrlGenerator | Deprecated | public | function | Sets the URL generator service. | ||
UrlGeneratorTrait::url | Deprecated | protected | function | Generates a URL or path for a specific route based on the given parameters. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.