You are here

Home » API reference » RNG - Events and Registrations 3.x » EventAccessResetForm.php

class EventAccessResetForm in RNG - Events and Registrations 3.x

Same name and namespace in other branches
  1. 8.2 src/Form/EventAccessResetForm.php \Drupal\rng\Form\EventAccessResetForm
  2. 8 src/Form/EventAccessResetForm.php \Drupal\rng\Form\EventAccessResetForm

Form controller to reset event access to defaults.

Deletes existing access rules and adds default rules back onto the event.

Hierarchy

Expanded class hierarchy of EventAccessResetForm

File

src/Form/EventAccessResetForm.php, line 18

Namespace

Drupal\rng\Form
View source 
class EventAccessResetForm extends ConfirmFormBase {

  /**
   * The event entity.
   *
   * @var \Drupal\Core\Entity\EntityInterface
   */
  protected $event;

  /**
   * The event meta wrapper.
   *
   * @var \Drupal\rng\EventMetaInterface
   */
  protected $eventMeta;

  /**
   * The RNG event manager.
   *
   * @var \Drupal\rng\EventManagerInterface
   */
  protected $eventManager;

  /**
   * Constructs a new event access reset form.
   *
   * @param \Drupal\rng\EventManagerInterface $event_manager
   *   The RNG event manager.
   */
  public function __construct(EventManagerInterface $event_manager) {
    $this->eventManager = $event_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('rng.event_manager'));
  }

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

  /**
   * {@inheritdoc}
   */
  public function getQuestion() {
    if (!$this->eventMeta
      ->isDefaultRules('rng_event.register')) {
      return $this
        ->t('Are you sure you want to reset access rules to site defaults?');
    }
    else {
      return $this
        ->t('Are you sure you want to customize access rules?');
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getDescription() {
    if (!$this->eventMeta
      ->isDefaultRules('rng_event.register')) {
      return $this
        ->t('Custom access rules will be deleted.');
    }
    else {
      return $this
        ->t('Rules for this event will no longer match site defaults.');
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getConfirmText() {
    if (!$this->eventMeta
      ->isDefaultRules('rng_event.register')) {
      return $this
        ->t('Delete existing access rules');
    }
    else {
      return $this
        ->t('Customize');
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getCancelUrl() {
    return new Url('rng.event.' . $this->event
      ->getEntityTypeId() . '.access', [
      $this->event
        ->getEntityTypeId() => $this->event
        ->id(),
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, EntityInterface $rng_event = NULL) {
    $this->event = clone $rng_event;
    $this->eventMeta = $this->eventManager
      ->getMeta($this->event);
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    if ($rules = $this->eventMeta
      ->getRules('rng_event.register')) {
      foreach ($rules as $rule) {
        $rule
          ->delete();
      }
      $this
        ->messenger()
        ->addMessage($this
        ->t('Access rules reset to site defaults.'));
    }
    else {
      $this->eventMeta
        ->addDefaultAccess();
      $this
        ->messenger()
        ->addMessage($this
        ->t('Access rules can now be customized using edit operations.'));
    }
    Cache::invalidateTags($this->event
      ->getCacheTagsToInvalidate());
    $form_state
      ->setRedirectUrl($this
      ->getCancelUrl());
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfirmFormBase::getCancelText public function Returns a caption for the link which cancels the action. Overrides ConfirmFormInterface::getCancelText 2
ConfirmFormBase::getFormName public function Returns the internal name used to refer to the confirmation item. Overrides ConfirmFormInterface::getFormName
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
EventAccessResetForm::$event protected property The event entity.
EventAccessResetForm::$eventManager protected property The RNG event manager.
EventAccessResetForm::$eventMeta protected property The event meta wrapper.
EventAccessResetForm::buildForm public function Form constructor. Overrides ConfirmFormBase::buildForm
EventAccessResetForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
EventAccessResetForm::getCancelUrl public function Returns the route to go to if the user cancels the action. Overrides ConfirmFormInterface::getCancelUrl
EventAccessResetForm::getConfirmText public function Returns a caption for the button that confirms the action. Overrides ConfirmFormBase::getConfirmText
EventAccessResetForm::getDescription public function Returns additional text to display as a description. Overrides ConfirmFormBase::getDescription
EventAccessResetForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
EventAccessResetForm::getQuestion public function Returns the question to ask the user. Overrides ConfirmFormInterface::getQuestion
EventAccessResetForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
EventAccessResetForm::__construct public function Constructs a new event access reset form.
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.
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 72
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. 27
MessengerTrait::messenger public function Gets the messenger. 27
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. 4
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.