class BreakLockForm in Rules 8.3

Builds the form to break the lock of an edited rule.

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\Core\Form\ConfirmFormBase implements ConfirmFormInterface
  - class \Drupal\rules\Form\BreakLockForm

Expanded class hierarchy of BreakLockForm

File

src/Form/BreakLockForm.php, line 15

Namespace

Drupal\rules\Form

View source

class BreakLockForm extends ConfirmFormBase {

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * The rendering service.
   *
   * @var \Drupal\Core\Render\RendererInterface
   */
  protected $renderer;

  /**
   * The RulesUI handler of the currently active UI.
   *
   * @var \Drupal\rules\Ui\RulesUiHandlerInterface
   */
  protected $rulesUiHandler;

  /**
   * Constructor.
   */
  public function __construct(EntityTypeManagerInterface $entity_type_manager, RendererInterface $renderer) {
    $this->entityTypeManager = $entity_type_manager;
    $this->renderer = $renderer;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('entity_type.manager'), $container
      ->get('renderer'));
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'rules_break_lock_confirm';
  }

  /**
   * {@inheritdoc}
   */
  public function getQuestion() {
    return $this
      ->t('Do you want to break the lock on %label?', [
      '%label' => $this->rulesUiHandler
        ->getComponentLabel(),
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public function getDescription() {
    $locked = $this->rulesUiHandler
      ->getLockMetaData();
    $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' => $this->renderer
        ->render($username),
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public function getCancelUrl() {
    return $this->rulesUiHandler
      ->getBaseRouteUrl();
  }

  /**
   * {@inheritdoc}
   */
  public function getConfirmText() {
    return $this
      ->t('Break lock');
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, RulesUiHandlerInterface $rules_ui_handler = NULL) {
    $this->rulesUiHandler = $rules_ui_handler;
    if (!$rules_ui_handler
      ->isLocked()) {
      $form['message']['#markup'] = $this
        ->t('There is no lock on %label to break.', [
        '%label' => $rules_ui_handler
          ->getComponentLabel(),
      ]);
      return $form;
    }
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $this->rulesUiHandler
      ->clearTemporaryStorage();
    $form_state
      ->setRedirectUrl($this->rulesUiHandler
      ->getBaseRouteUrl());
    $this
      ->messenger()
      ->addMessage($this
      ->t('The lock has been broken and you may now edit this @component_type.', [
      '@component_type' => $this->rulesUiHandler
        ->getPluginDefinition()->component_type_label,
    ]));
  }

}

Members

Name	Modifiers	Type	Description	Overrides
BreakLockForm::$entityTypeManager	protected	property	The entity type manager.
BreakLockForm::$renderer	protected	property	The rendering service.
BreakLockForm::$rulesUiHandler	protected	property	The RulesUI handler of the currently active UI.
BreakLockForm::buildForm	public	function	Form constructor. Overrides ConfirmFormBase::buildForm
BreakLockForm::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
BreakLockForm::getCancelUrl	public	function	Returns the route to go to if the user cancels the action. Overrides ConfirmFormInterface::getCancelUrl
BreakLockForm::getConfirmText	public	function	Returns a caption for the button that confirms the action. Overrides ConfirmFormBase::getConfirmText
BreakLockForm::getDescription	public	function	Returns additional text to display as a description. Overrides ConfirmFormBase::getDescription
BreakLockForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
BreakLockForm::getQuestion	public	function	Returns the question to ask the user. Overrides ConfirmFormInterface::getQuestion
BreakLockForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
BreakLockForm::__construct	public	function	Constructor.
ConfirmFormBase::getCancelText	public	function	Returns a caption for the link which cancels the action. Overrides ConfirmFormInterface::getCancelText	1
ConfirmFormBase::getFormName	public	function	Returns the internal name used to refer to the confirmation item. Overrides ConfirmFormInterface::getFormName
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
FormBase::$configFactory	protected	property	The config factory.	1
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.	1
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	Form validation handler. Overrides FormInterface::validateForm	62
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.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
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.	1
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.

You are here

class BreakLockForm in Rules 8.3

Hierarchy

File

Namespace

Members

API Navigation