class MessageForm in Courier 2.x

Same name and namespace in other branches

8 courier_message_composer/src/Form/MessageForm.php \Drupal\courier_message_composer\Form\MessageForm

Create a message.

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
- class \Drupal\courier_message_composer\Form\MessageForm uses CourierTokenElementTrait

Expanded class hierarchy of MessageForm

1 string reference to 'MessageForm'

courier_message_composer.routing.yml in courier_message_composer/courier_message_composer.routing.yml: courier_message_composer/courier_message_composer.routing.yml

File

courier_message_composer/src/Form/MessageForm.php, line 23

Namespace

Drupal\courier_message_composer\Form

View source

class MessageForm extends FormBase {
  use CourierTokenElementTrait;

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

  /**
   * The identity channel manager.
   *
   * @var \Drupal\courier\Service\IdentityChannelManager
   */
  protected $identityChannelManager;

  /**
   * The courier manager.
   *
   * @var \Drupal\courier\Service\CourierManagerInterface
   */
  protected $courierManager;

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

  /**
   * Constructs a MessageForm object.
   *
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entityTypeManager
   *   The entity type manager.
   * @param \Drupal\courier\Service\IdentityChannelManagerInterface $identity_channel_manager
   *   The identity channel manager.
   * @param \Drupal\courier\Service\CourierManagerInterface $courier_manager
   *   The courier manager.
   */
  public function __construct(EntityTypeManagerInterface $entityTypeManager, IdentityChannelManagerInterface $identity_channel_manager, CourierManagerInterface $courier_manager) {
    $this->entityTypeManager = $entityTypeManager;
    $this->identityChannelManager = $identity_channel_manager;
    $this->courierManager = $courier_manager;
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, ContentEntityTypeInterface $courier_channel = NULL) {
    $form['#title'] = $courier_channel
      ->getLabel();
    $t_args = [
      '@channel' => $courier_channel
        ->getLabel(),
    ];

    /** @var \Drupal\courier\ChannelInterface $message */
    $message = $this->entityTypeManager
      ->getStorage($courier_channel
      ->id())
      ->create();
    $form_state
      ->set('message_entity', $message);

    // Identity.
    $form['identity_information'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Recipient'),
      '#description' => $this
        ->t('Select a recipient for the message.'),
      '#open' => TRUE,
    ];
    $form['identity_information']['identity'] = [
      '#type' => 'radios',
      '#options' => NULL,
      // Kills \Drupal\Core\Render\Element\Radios::processRadios.
      '#process' => [],
      '#title' => $this
        ->t('Recipient'),
      '#required' => TRUE,
    ];
    $channels = $this->identityChannelManager
      ->getChannels();
    foreach ($channels[$courier_channel
      ->id()] as $entity_type_id) {
      $permission = 'courier_message_composer compose ' . $courier_channel
        ->id() . ' to ' . $entity_type_id;
      if (!$this
        ->currentUser()
        ->hasPermission($permission)) {
        continue;
      }
      $entity_type = $this->entityTypeManager
        ->getDefinition($entity_type_id);
      $form['identity_information']['identity'][$entity_type_id] = [
        '#prefix' => '<div class="form-item container-inline">',
        '#suffix' => '</div>',
      ];
      $form['identity_information']['identity'][$entity_type_id]['radio'] = [
        '#type' => 'radio',
        '#title' => $entity_type
          ->getLabel(),
        '#return_value' => "{$entity_type_id}:*",
        '#parents' => [
          'identity',
        ],
        '#default_value' => $entity_type_id == 'user' ?: '',
        '#error_no_message' => TRUE,
      ];
      $form['identity_information']['identity'][$entity_type_id]['autocomplete'] = [
        '#type' => 'entity_autocomplete',
        '#title' => $entity_type
          ->getLabel(),
        '#title_display' => 'invisible',
        '#target_type' => $entity_type_id,
        '#tags' => FALSE,
        '#parents' => [
          'entity',
          $entity_type_id,
        ],
      ];
      if ($entity_type_id == 'user' && !$this
        ->currentUser()
        ->isAnonymous()) {
        $user = User::load($this
          ->currentUser()
          ->id());
        $form['identity_information']['identity'][$entity_type_id]['autocomplete']['#default_value'] = $user;
      }
    }

    // Form display.

    /** @var \Drupal\Core\Entity\EntityDisplayRepositoryInterface $entityDisplayRepo */
    $entityDisplayRepo = \Drupal::service('entity_display.repository');
    $display = $entityDisplayRepo
      ->getFormDisplay($courier_channel
      ->id(), $courier_channel
      ->id(), 'default');
    $form_state
      ->set([
      'form_display',
    ], $display);
    $form['message'] = [
      '#tree' => TRUE,
    ];
    $display
      ->buildForm($message, $form['message'], $form_state);

    // Tokens.
    $form['tokens'] = [
      '#type' => 'container',
      '#title' => $this
        ->t('Tokens'),
      '#weight' => 51,
    ];
    $form['tokens']['list'] = $this
      ->courierTokenElement();
    $form['actions'] = [
      '#type' => 'actions',
    ];
    $form['actions']['submit'] = [
      '#type' => 'submit',
      '#value' => t('Send @channel', $t_args),
      '#button_type' => 'primary',
    ];
    return $form;
  }

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

    /** @var \Drupal\courier\ChannelInterface $message */
    $message = $form_state
      ->get('message_entity');
    $form_state
      ->get([
      'form_display',
    ])
      ->validateFormValues($message, $form, $form_state);

    // Identity.
    if ($form_state
      ->getValue('identity')) {
      $identity = NULL;
      [
        $entity_type,
        $entity_id,
      ] = explode(':', $form_state
        ->getValue('identity'));
      if (!empty($entity_type)) {
        $references = $form_state
          ->getValue('entity');
        if (is_numeric($references[$entity_type])) {
          $entity_id = $references[$entity_type];
          $identity = $this->entityTypeManager
            ->getStorage($entity_type)
            ->load($entity_id);
        }
      }
      if ($identity instanceof EntityInterface) {
        $form_state
          ->setValueForElement($form['identity_information']['identity'], $identity);
        $channel_types = $this->identityChannelManager
          ->getChannelsForIdentity($identity);
        if (!in_array($message
          ->getEntityTypeId(), $channel_types)) {
          $form_state
            ->setError($form['identity_information']['identity'], $this
            ->t('@identity cannot receive @channel.', [
            '@identity' => $identity
              ->label(),
            '@channel' => $message
              ->getEntityType()
              ->getLabel(),
          ]));
        }
      }
      else {
        $form_state
          ->setError($form['identity_information']['identity'], $this
          ->t('Invalid identity.'));
      }
    }
  }

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

    /** @var \Drupal\courier\ChannelInterface $message */
    $message = $form_state
      ->get('message_entity');
    $form_state
      ->get([
      'form_display',
    ])
      ->extractFormValues($message, $form, $form_state);
    $template_collection = TemplateCollection::create()
      ->setTemplate($message);
    $identity = $form_state
      ->getValue('identity');
    $mqi = $this->courierManager
      ->sendMessage($template_collection, $identity);
    if ($mqi instanceof MessageQueueItemInterface) {
      $this
        ->messenger()
        ->addMessage($this
        ->t('Message queued for delivery.'));
    }
    else {
      $this
        ->messenger()
        ->addMessage($this
        ->t('Failed to send message'), 'error');
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CourierTokenElementTrait::courierTokenElement	public	function	Render a token element.
CourierTokenElementTrait::templateCollectionTokenElement	public	function	Render a token element for a template collection.
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
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.
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.
MessageForm::$courierManager	protected	property	The courier manager.
MessageForm::$entityTypeManager	protected	property	Entity type manager.
MessageForm::$eventManager	protected	property	The RNG event manager.
MessageForm::$identityChannelManager	protected	property	The identity channel manager.
MessageForm::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
MessageForm::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
MessageForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
MessageForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
MessageForm::validateForm	public	function	Form validation handler. Overrides FormBase::validateForm
MessageForm::__construct	public	function	Constructs a MessageForm object.
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.

You are here

class MessageForm in Courier 2.x

Hierarchy

File

Namespace

Members

API Navigation