class PushNotificationsSendMessageForm in Push Notifications 8

Class PushNotificationsSendMessageForm.

@package Drupal\push_notifications\Form

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\push_notifications\Form\PushNotificationsSendMessageForm

Expanded class hierarchy of PushNotificationsSendMessageForm

1 string reference to 'PushNotificationsSendMessageForm'

push_notifications.routing.yml in ./push_notifications.routing.yml: push_notifications.routing.yml

File

src/Form/PushNotificationsSendMessageForm.php, line 13

Namespace

Drupal\push_notifications\Form

View source

class PushNotificationsSendMessageForm extends FormBase {

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form['instructions'] = array(
      '#type' => 'item',
      '#markup' => $this
        ->t('Compose the elements of your push notification message.'),
    );
    $form['message'] = array(
      '#type' => 'textfield',
      '#title' => $this
        ->t('Push Message'),
      '#description' => $this
        ->t('Compose the message to send out (@limit characters max.)', array(
        '@limit' => PUSH_NOTIFICATIONS_APNS_PAYLOAD_SIZE_LIMIT,
      )),
      '#required' => TRUE,
      '#size' => 128,
      '#maxlength' => PUSH_NOTIFICATIONS_APNS_PAYLOAD_SIZE_LIMIT,
    );

    // Only show Android option if GCM Api Key is available..
    $recipients_options = array(
      PUSH_NOTIFICATIONS_NETWORK_ID_IOS => t('iOS (Apple Push Notifications)'),
    );
    if (!empty(\Drupal::config('push_notifications.gcm')
      ->get('api_key'))) {
      $recipients_options[PUSH_NOTIFICATIONS_NETWORK_ID_ANDROID] = t('Android (Google Cloud Messaging)');
    }
    $form['networks'] = array(
      '#type' => 'checkboxes',
      '#title' => t('Target Networks'),
      '#description' => t('Select the networks you want to reach with this message.'),
      '#options' => $recipients_options,
    );
    $form['submit'] = array(
      '#type' => 'submit',
      '#value' => t('Send Push Notification'),
    );
    return $form;
  }

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

    // Make sure at least one network is selected.
    $networks = $form_state
      ->getValue('networks');
    if (empty(array_filter($networks))) {
      $form_state
        ->setErrorByName('networks', $this
        ->t('Please select at least one of the target networks.'));
    }

    // Determine recipients.
    $tokens = push_notifications_get_tokens(array(
      'networks' => $networks,
    ));
    if (empty($tokens)) {

      // Onlyproceed if tokens were found.
      $form_state
        ->setErrorByName('networks', $this
        ->t('No tokens found for your selected networks.'));
    }
    else {

      // Pass the tokens to the submit handler.
      $form_state
        ->setTemporaryValue('tokens', $tokens);
    }
    parent::validateForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $messageSender = \Drupal::service('push_notifications.message_sender_list');
    $messageSender
      ->setTokens($form_state
      ->getTemporaryValue('tokens'));
    $messageSender
      ->setMessage($form_state
      ->getValue('message'));
    $messageSender
      ->dispatch();
    $results = $messageSender
      ->getResults();

    // Display result for each network.
    foreach ($results as $network => $result) {
      if (empty($result['count_attempted'])) {

        // Only display results for networks with tokens.
        continue;
      }
      drupal_set_message($this
        ->t('@network: Attempted to send @count_attempted tokens, sent @count_success.', array(
        '@network' => strtoupper($network),
        '@count_attempted' => $result['count_attempted'],
        '@count_success' => $result['count_success'],
      )));
    }
  }

}

Members

Name	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::create	public static	function	Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create	87
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.
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.
PushNotificationsSendMessageForm::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
PushNotificationsSendMessageForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
PushNotificationsSendMessageForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
PushNotificationsSendMessageForm::validateForm	public	function	Form validation handler. Overrides FormBase::validateForm
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 PushNotificationsSendMessageForm in Push Notifications 8

Hierarchy

File

Namespace

Members

API Navigation