class AgreementForm in Agreement 3.0.x

Agreement page form.

Hierarchy

• class \Drupal\agreement\Form\AgreementForm implements ContainerInjectionInterface, FormInterface uses StringTranslationTrait

File

src/Form/AgreementForm.php, line 25

Namespace

Drupal\agreement\Form

class AgreementForm implements FormInterface, ContainerInjectionInterface {
  use StringTranslationTrait;

  /**
   * Agreement handler.
   *
   * @var \Drupal\agreement\AgreementHandlerInterface
   */
  protected $agreementHandler;

  /**
   * Route match.
   *
   * @var \Drupal\Core\Routing\RouteMatchInterface
   */
  protected $routeMatch;

  /**
   * Language manager.
   *
   * @var \Drupal\Core\Language\LanguageManagerInterface
   */
  protected $languageManager;

  /**
   * Current user.
   *
   * @var \Drupal\Core\Session\AccountProxyInterface
   */
  protected $account;

  /**
   * Messenger service.
   *
   * @var \Drupal\Core\Messenger\MessengerInterface
   */
  protected $messenger;

  /**
   * Mail manager.
   *
   * @var \Drupal\Core\Mail\MailManagerInterface
   */
  protected $mailManager;

  /**
   * Initialize method.
   *
   * @param \Drupal\agreement\AgreementHandlerInterface $agreementHandler
   *   The agreement handler interface.
   * @param \Drupal\Core\Routing\RouteMatchInterface $routeMatch
   *   The current route match.
   * @param \Drupal\Core\Language\LanguageManagerInterface $languageManager
   *   The language manager.
   * @param \Drupal\Core\Session\AccountProxyInterface $account
   *   The current user account.
   * @param \Drupal\Core\Messenger\MessengerInterface $messenger
   *   The messenger service.
   * @param \Drupal\Core\Mail\MailManagerInterface $mailManager
   *   The mail service.
   */
  public function __construct(AgreementHandlerInterface $agreementHandler, RouteMatchInterface $routeMatch, LanguageManagerInterface $languageManager, AccountProxyInterface $account, MessengerInterface $messenger, MailManagerInterface $mailManager) {
    $this->agreementHandler = $agreementHandler;
    $this->routeMatch = $routeMatch;
    $this->languageManager = $languageManager;
    $this->account = $account;
    $this->messenger = $messenger;
    $this->mailManager = $mailManager;
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {

    /* @var \Drupal\agreement\Entity\Agreement $agreement */
    $agreement = $this->routeMatch
      ->getParameter('agreement');
    return 'agreement_' . $agreement
      ->id() . '_form';
  }

  /**
   * Get the page title.
   *
   * @param \Drupal\Core\Routing\RouteMatchInterface $routeMatch
   *   The route match object. Ignored.
   * @param \Drupal\agreement\Entity\Agreement $agreement
   *   The agreement entity.
   *
   * @return string
   *   The filtered title.
   */
  public function title(RouteMatchInterface $routeMatch, Agreement $agreement) {
    $settings = $agreement
      ->getSettings();
    return $this
      ->t('@title', [
      '@title' => $settings['title'],
    ]);
  }

  /**
   * Build the agreement page.
   *
   * @param array $form
   *   The form array.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The form state.
   * @param \Drupal\agreement\Entity\Agreement|null $agreement
   *   The agreement entity.
   *
   * @return array
   *   The form array.
   */
  public function buildForm(array $form, FormStateInterface $form_state, Agreement $agreement = NULL) {
    $settings = $agreement
      ->getSettings();
    $agreed = $this->agreementHandler
      ->hasAgreed($agreement, $this->account);
    $canAgree = $this->agreementHandler
      ->canAgree($agreement, $this->account);
    $canRevoke = $this->account
      ->hasPermission('revoke own agreement');
    $form_state
      ->setStorage([
      'agreement' => $agreement,
      'agreed' => $agreed,
    ]);
    $form['agreement'] = [
      '#type' => 'container',
      '#tree' => TRUE,
      'text' => [
        '#type' => 'processed_text',
        '#text' => $agreement
          ->get('agreement'),
        '#format' => $settings['format'],
        '#language' => $this->languageManager
          ->getCurrentLanguage(LanguageInterface::TYPE_CONTENT)
          ->getId(),
      ],
      'agree' => [
        '#type' => 'checkbox',
        '#title' => $this
          ->t('@agree', [
          '@agree' => $settings['checkbox'],
        ]),
        '#default_value' => $agreed,
        '#access' => (!$agreed || $canRevoke) && $canAgree,
        '#parents' => [
          'agree',
        ],
      ],
    ];
    $form['actions'] = [
      '#type' => 'actions',
      'submit' => [
        '#type' => 'submit',
        '#name' => 'submit',
        '#value' => $this
          ->t('@agree_submit', [
          '@agree_submit' => $settings['submit'],
        ]),
        '#access' => (!$agreed || $canRevoke) && $canAgree,
      ],
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    $storage = $form_state
      ->getStorage();
    if (!$form_state
      ->getValue('agree') && !$storage['agreed']) {
      $settings = $storage['agreement']
        ->getSettings();
      $form_state
        ->setErrorByName('agree', $this
        ->t('@agree_error', [
        '@agree_error' => $settings['failure'],
      ]));
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $storage = $form_state
      ->getStorage();

    /** @var \Drupal\agreement\Entity\Agreement $agreement */
    $agreement = $storage['agreement'];
    $settings = $agreement
      ->getSettings();
    $destination = '/';
    $agree = $form_state
      ->getValue('agree');
    if ($settings['destination']) {
      $destination = $settings['destination'];
    }
    elseif (isset($_SESSION['agreement_destination'])) {
      $destination = $_SESSION['agreement_destination'];
    }
    $successfulResponse = $this
      ->processAgreement($agreement, $agree, $storage, $destination);
    if ($successfulResponse) {
      $message = $agree ? $settings['success'] : $settings['revoked'];
      $this->messenger
        ->addStatus($this
        ->t('@success', [
        '@success' => $message,
      ]));
      if ($settings['recipient'] && (!$storage['agreed'] || !$agree)) {

        // Only spam the email recipient if its the users first acceptance of
        // the agreement. If this is desired, please file an issue to discuss.
        $mail_key = $agree ? 'notice' : 'revoked';
        $this
          ->notify($agreement, $this->account, $settings['recipient'], $mail_key);
      }
      $form_state
        ->setResponse($successfulResponse);
    }
    elseif (!$storage['agreed']) {
      $this->messenger
        ->addError($this
        ->t('An error occurred accepting the agreement. Please try again.'));
    }
  }

  /**
   * Process and generate a response for successful agreements.
   *
   * @param \Drupal\agreement\Entity\Agreement $agreement
   *   The agreement being processed.
   * @param int $agree
   *   An integer to set the agreement status to.
   * @param array $storage
   *   The form's set of arbitrary data.
   * @param string $destination
   *   The destination to send the user to upon successful agreement.
   *
   * @return bool|\Drupal\Core\Routing\LocalRedirectResponse
   *   A local redirect response if the agreement was processed successfully,
   *   otherwise FALSE.
   */
  protected function processAgreement(Agreement $agreement, int $agree, array $storage, string $destination) {
    $successfulResponse = new LocalRedirectResponse($destination);
    if ($this->agreementHandler
      ->isAnonymousAgreement($agreement, $this->account)) {
      $cookie = $this->agreementHandler
        ->agree($agreement, $this->account, $agree);
      if (!$cookie) {
        return FALSE;
      }
      $successfulResponse->headers
        ->setCookie($cookie);
      $successfulResponse
        ->addCacheableDependency((new CacheableMetadata())
        ->addCacheContexts([
        'cookies:' . $cookie
          ->getName(),
      ]));
      return $successfulResponse;
    }
    elseif ($this->agreementHandler
      ->agree($agreement, $this->account, $agree)) {
      return $successfulResponse;
    }
    return FALSE;
  }

  /**
   * Notify email recipient if provided.
   *
   * @param \Drupal\agreement\Entity\Agreement $agreement
   *   The agreement entity.
   * @param \Drupal\Core\Session\AccountInterface $account
   *   The user account.
   * @param string $mail
   *   The email recipient.
   * @param string $key
   *   The mail key to use.
   */
  protected function notify(Agreement $agreement, AccountInterface $account, $mail = '', $key = 'notice') {
    if ($mail) {
      $params = [
        'context' => [
          'agreement' => $agreement,
        ],
        'account' => $account,
      ];
      $this->mailManager
        ->mail('agreement', $key, $mail, $account
        ->getPreferredAdminLangcode(), $params);
    }
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('agreement.handler'), $container
      ->get('current_route_match'), $container
      ->get('language_manager'), $container
      ->get('current_user'), $container
      ->get('messenger'), $container
      ->get('plugin.manager.mail'));
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AgreementForm::$account	protected	property	Current user.
AgreementForm::$agreementHandler	protected	property	Agreement handler.
AgreementForm::$languageManager	protected	property	Language manager.
AgreementForm::$mailManager	protected	property	Mail manager.
AgreementForm::$messenger	protected	property	Messenger service.
AgreementForm::$routeMatch	protected	property	Route match.
AgreementForm::buildForm	public	function	Build the agreement page. Overrides FormInterface::buildForm
AgreementForm::create	public static	function	Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create
AgreementForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
AgreementForm::notify	protected	function	Notify email recipient if provided.
AgreementForm::processAgreement	protected	function	Process and generate a response for successful agreements.
AgreementForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
AgreementForm::title	public	function	Get the page title.
AgreementForm::validateForm	public	function	Form validation handler. Overrides FormInterface::validateForm
AgreementForm::__construct	public	function	Initialize method.
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.