You are here

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

class EventTypeRuleDeleteAll in RNG - Events and Registrations 3.x

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

Form controller to delete all custom rules for an event type.

Hierarchy

Expanded class hierarchy of EventTypeRuleDeleteAll

1 string reference to 'EventTypeRuleDeleteAll'
rng.routing.yml in ./rng.routing.yml
rng.routing.yml

File

src/Form/EventTypeRuleDeleteAll.php, line 16

Namespace

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

  /**
   * The event type entity.
   *
   * @var \Drupal\rng\Entity\EventTypeInterface
   */
  protected $eventType;

  /**
   * Rule storage.
   *
   * @var \Drupal\Core\Entity\EntityStorageInterface
   */
  protected $ruleStorage;

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

  /**
   * Constructs a EventTypeRuleDeleteAll form.
   *
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Drupal\rng\EventManagerInterface $event_manager
   *   The RNG event manager.
   */
  public function __construct(EntityTypeManagerInterface $entity_type_manager, EventManagerInterface $event_manager) {
    $this->ruleStorage = $entity_type_manager
      ->getStorage('rng_rule');
    $this->eventManager = $event_manager;
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function getQuestion() {
    return $this
      ->t('Are you sure you want to delete custom access rules for all events?');
  }

  /**
   * {@inheritdoc}
   */
  public function getDescription() {
    return $this
      ->t('All custom rules for events will be deleted. All events will use event type defaults.');
  }

  /**
   * {@inheritdoc}
   */
  public function getConfirmText() {
    return $this
      ->t('Delete all existing access rules');
  }

  /**
   * {@inheritdoc}
   */
  public function getCancelUrl() {
    return Url::fromRoute('entity.rng_event_type.access_defaults', [
      'event_type' => $this->eventType
        ->id(),
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, EventTypeInterface $event_type = NULL) {
    $this->eventType = $event_type;
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {

    /** @var \Drupal\rng\Entity\RuleInterface[] $rules */
    $rules = $this->ruleStorage
      ->loadByProperties([
      'event__target_type' => $this->eventType
        ->getEventEntityTypeId(),
    ]);

    // There is no bundle field on rules. Load all rules one-by-one and find
    // the bundle for each event.
    $count = 0;
    foreach ($rules as $rule) {
      $event = $rule
        ->getEvent();

      // If event no longer exists then delete the rules while we're here.
      if (!$event || $event
        ->bundle() == $this->eventType
        ->getEventBundle()) {
        $rule
          ->delete();
        $count++;
      }
    }
    $this
      ->messenger()
      ->addMessage($this
      ->formatPlural($count, '@count custom access rule deleted.', '@count custom access rules deleted.'));
    $this->eventManager
      ->invalidateEventType($this->eventType);
    $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
EventTypeRuleDeleteAll::$eventManager protected property The RNG event manager.
EventTypeRuleDeleteAll::$eventType protected property The event type entity.
EventTypeRuleDeleteAll::$ruleStorage protected property Rule storage.
EventTypeRuleDeleteAll::buildForm public function Form constructor. Overrides ConfirmFormBase::buildForm
EventTypeRuleDeleteAll::create public static function Instantiates a new instance of this class. Overrides FormBase::create
EventTypeRuleDeleteAll::getCancelUrl public function Returns the route to go to if the user cancels the action. Overrides ConfirmFormInterface::getCancelUrl
EventTypeRuleDeleteAll::getConfirmText public function Returns a caption for the button that confirms the action. Overrides ConfirmFormBase::getConfirmText
EventTypeRuleDeleteAll::getDescription public function Returns additional text to display as a description. Overrides ConfirmFormBase::getDescription
EventTypeRuleDeleteAll::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
EventTypeRuleDeleteAll::getQuestion public function Returns the question to ask the user. Overrides ConfirmFormInterface::getQuestion
EventTypeRuleDeleteAll::submitForm public function Form submission handler. Overrides FormInterface::submitForm
EventTypeRuleDeleteAll::__construct public function Constructs a EventTypeRuleDeleteAll 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.