class UsermailDebuggerForm in Mail Debugger 8

Class UsermailDebuggerForm.

This class provides user email debugger form.

@package Drupal\mail_debugger\Form

Hierarchy

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

Expanded class hierarchy of UsermailDebuggerForm

1 string reference to 'UsermailDebuggerForm'

mail_debugger.routing.yml in ./mail_debugger.routing.yml: mail_debugger.routing.yml

File

src/Form/UsermailDebuggerForm.php, line 19

Namespace

Drupal\mail_debugger\Form

View source

class UsermailDebuggerForm extends FormBase {

  /**
   * The Key value storage object.
   *
   * @var \Drupal\Core\KeyValueStore\KeyValueStoreInterface
   */
  protected $defaultsStorage;

  /**
   * The user Storage Object.
   *
   * @var \Drupal\Core\Entity\EntityStorageInterface
   */
  protected $userStorage;

  /**
   * The user Mail config.
   *
   * @var \Drupal\Core\Config\ImmutableConfig
   */
  protected $userMailConfig;

  /**
   * UsermailDebuggerForm constructor.
   *
   * @param \Drupal\Core\TempStore\PrivateTempStoreFactory $storageFactory
   *   The storage Factory.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entityTypeManager
   *   The entity Type Manager.
   * @param \Drupal\Core\Config\ConfigFactoryInterface $configFactory
   *   The config Factory.
   *
   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   */
  public function __construct(PrivateTempStoreFactory $storageFactory, EntityTypeManagerInterface $entityTypeManager, ConfigFactoryInterface $configFactory) {
    $this->defaultsStorage = $storageFactory
      ->get(static::class);
    $this->userStorage = $entityTypeManager
      ->getStorage('user');
    $this->userMailConfig = $configFactory
      ->get('user.mail');
  }

  /**
   * Instantiates a new instance of this class.
   *
   * @param \Symfony\Component\DependencyInjection\ContainerInterface $container
   *   The service container this instance should use.
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('tempstore.private'), $container
      ->get('entity_type.manager'), $container
      ->get('config.factory'));
  }

  /**
   * Function returns form id.
   */
  public function getFormId() {
    return "usermail_debugger_form";
  }

  /**
   * Build Form function.
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    return [
      'user' => [
        '#title' => $this
          ->t("Send for"),
        '#type' => 'entity_autocomplete',
        '#target_type' => 'user',
        '#default_value' => $this->userStorage
          ->load($this->defaultsStorage
          ->get('user') ?? $this
          ->currentUser()
          ->id()),
        '#selection_handler' => 'default:user',
        '#selection_settings' => [
          'include_anonymous' => FALSE,
        ],
        '#required' => TRUE,
      ],
      'operation' => [
        '#title' => $this
          ->t("Subject"),
        '#type' => 'radios',
        '#options' => $this
          ->getOperations(),
        '#default_value' => $this->defaultsStorage
          ->get('operation'),
        '#required' => TRUE,
      ],
      'actions' => [
        '#type' => 'actions',
        'submit' => [
          '#type' => 'submit',
          '#value' => $this
            ->t("Send"),
        ],
      ],
    ];
  }

  /**
   * Function returns operations array.
   *
   * @return array
   *   array of operations.
   */
  protected function getOperations() {
    $result = [];
    foreach ($this->userMailConfig
      ->get() as $maybeOperation => $config) {

      // Operation?
      if (!empty($config['subject'])) {

        // Tokens intentionally unprocessed.
        $result[$maybeOperation] = $config['subject'];
      }
    }
    return $result;
  }

  /**
   * Submit Form Handler.
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $this->defaultsStorage
      ->set('user', $form_state
      ->getValue('user'));
    $this->defaultsStorage
      ->set('operation', $form_state
      ->getValue('operation'));

    /** @var \Drupal\user\Entity\User $user */
    $user = $this->userStorage
      ->load($form_state
      ->getValue('user'));
    $result = _user_mail_notify($form_state
      ->getValue('operation'), $user);
    if ($result) {
      $this
        ->messenger()
        ->addStatus($this
        ->t("Sent a message to :mail.", [
        ':mail' => $user
          ->getEmail(),
      ]));
    }
  }

}

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::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.
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.
UsermailDebuggerForm::$defaultsStorage	protected	property	The Key value storage object.
UsermailDebuggerForm::$userMailConfig	protected	property	The user Mail config.
UsermailDebuggerForm::$userStorage	protected	property	The user Storage Object.
UsermailDebuggerForm::buildForm	public	function	Build Form function. Overrides FormInterface::buildForm
UsermailDebuggerForm::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
UsermailDebuggerForm::getFormId	public	function	Function returns form id. Overrides FormInterface::getFormId
UsermailDebuggerForm::getOperations	protected	function	Function returns operations array.
UsermailDebuggerForm::submitForm	public	function	Submit Form Handler. Overrides FormInterface::submitForm
UsermailDebuggerForm::__construct	public	function	UsermailDebuggerForm constructor.

You are here

class UsermailDebuggerForm in Mail Debugger 8

Hierarchy

File

Namespace

Members

API Navigation