You are here

Home » API reference » RNG - Events and Registrations 8 » MessageActionForm.php

class MessageActionForm in RNG - Events and Registrations 8

Same name and namespace in other branches
  1. 8.2 src/Form/MessageActionForm.php \Drupal\rng\Form\MessageActionForm
  2. 3.x src/Form/MessageActionForm.php \Drupal\rng\Form\MessageActionForm

Creates a rule with a rng_courier_message action.

Hierarchy

Expanded class hierarchy of MessageActionForm

File

src/Form/MessageActionForm.php, line 19

Namespace

Drupal\rng\Form
View source 
class MessageActionForm extends FormBase {

  /**
   * @var \Drupal\rng\Plugin\Action\CourierTemplateCollection $actionPlugin
   */
  protected $actionPlugin;

  /**
   * The entity manager.
   *
   * @var \Drupal\Core\Entity\EntityManagerInterface
   */
  protected $entityManager;

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

  /**
   * Constructs a new MessageActionForm object.
   *
   * @param \Drupal\Core\Action\ActionManager $action_manager
   *   The action manager.
   * @param \Drupal\Core\Entity\EntityManagerInterface $entity_manager
   *   The entity manager.
   * @param \Drupal\rng\EventManagerInterface $event_manager
   *   The RNG event manager.
   */
  public function __construct(ActionManager $action_manager, EntityManagerInterface $entity_manager, EventManagerInterface $event_manager) {
    $this->actionPlugin = $action_manager
      ->createInstance('rng_courier_message');
    $this->entityManager = $entity_manager;
    $this->eventManager = $event_manager;
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, EntityInterface $rng_event = NULL) {
    $event = clone $rng_event;
    $this->actionPlugin
      ->setConfiguration([
      'active' => FALSE,
    ]);
    $form_state
      ->set('event', $event);
    $triggers = array(
      'rng:custom:date' => $this
        ->t('To all registrations, on a date.'),
      (string) $this
        ->t('Registrations') => array(
        'entity:registration:new' => $this
          ->t('To a single registration, when it is created.'),
        'entity:registration:update' => $this
          ->t('To a single registration, when it is updated.'),
      ),
    );
    $form['trigger'] = array(
      '#type' => 'select',
      '#title' => $this
        ->t('Trigger'),
      '#description' => $this
        ->t('When should this message be sent?'),
      '#options' => $triggers,
      '#default_value' => 'now',
    );
    $form['actions'] = array(
      '#type' => 'actions',
    );
    $form['actions']['submit'] = array(
      '#type' => 'submit',
      '#value' => t('Create message'),
    );
    $form['actions']['cancel'] = array(
      '#type' => 'link',
      '#title' => $this
        ->t('Cancel'),
      '#url' => Url::fromRoute('rng.event.' . $event
        ->getEntityTypeId() . '.messages', array(
        $event
          ->getEntityTypeId() => $event
          ->id(),
      )),
    );
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $this->actionPlugin
      ->submitConfigurationForm($form, $form_state);
    if (!($template_collection = $this->actionPlugin
      ->getTemplateCollection())) {
      drupal_set_message(t('Unable to create templates.', 'error'));
      return;
    }
    $event = $form_state
      ->get('event');
    $context = $this->entityManager
      ->getStorage('courier_context')
      ->load('rng_registration_' . $event
      ->getEntityTypeId());
    if (!$context) {
      throw new \Exception(sprintf('No context available for %s', $event
        ->getEntityTypeId()));
    }
    $template_collection
      ->setContext($context);
    $template_collection
      ->setOwner($event);
    $template_collection
      ->save();
    drupal_set_message(t('Templates created.'));
    $action = RuleComponent::create([])
      ->setPluginId($this->actionPlugin
      ->getPluginId())
      ->setConfiguration($this->actionPlugin
      ->getConfiguration())
      ->setType('action');
    $trigger_id = $form_state
      ->getValue('trigger');
    $rule = Rule::create([
      'event' => array(
        'entity' => $event,
      ),
      'trigger_id' => $trigger_id,
    ]);
    $rule
      ->save();
    $action
      ->setRule($rule)
      ->save();
    if ($trigger_id == 'rng:custom:date') {
      $rule_component = RuleComponent::create()
        ->setRule($rule)
        ->setType('condition')
        ->setPluginId('rng_rule_scheduler');
      $rule_component
        ->save();

      // Save the ID into config.
      $rule_component
        ->setConfiguration([
        'rng_rule_component' => $rule_component
          ->id(),
      ]);
      $rule_component
        ->save();
    }
    $entity_type = $event
      ->getEntityTypeId();
    $form_state
      ->setRedirectUrl(Url::fromRoute('rng.event.' . $entity_type . '.messages', [
      $entity_type => $event
        ->id(),
    ]));
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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.
MessageActionForm::$actionPlugin protected property
MessageActionForm::$entityManager protected property The entity manager.
MessageActionForm::$eventManager protected property The RNG event manager.
MessageActionForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
MessageActionForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
MessageActionForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
MessageActionForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
MessageActionForm::__construct public function Constructs a new MessageActionForm object.
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.