class TeamInvitationForm in Apigee Edge 8

Provides settings form for team_invitation..

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\Core\Form\ConfigFormBase uses ConfigFormBaseTrait
  - class \Drupal\apigee_edge_teams\Form\TeamInvitationForm

Expanded class hierarchy of TeamInvitationForm

1 string reference to 'TeamInvitationForm'

apigee_edge_teams.routing.yml in modules/apigee_edge_teams/apigee_edge_teams.routing.yml: modules/apigee_edge_teams/apigee_edge_teams.routing.yml

File

modules/apigee_edge_teams/src/Form/TeamInvitationForm.php, line 28

Namespace

Drupal\apigee_edge_teams\Form

View source

class TeamInvitationForm extends ConfigFormBase {

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() {
    return [
      'apigee_edge_teams.team_settings',
    ];
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('apigee_edge_teams.team_settings');
    $form['team_invitation_expiry_days'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Expiry days'),
      '#description' => $this
        ->t('Number of days before team invitations are expired.'),
      '#required' => TRUE,
      '#default_value' => $config
        ->get('team_invitation_expiry_days'),
    ];
    $form['email_for_existing_users'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Invitation email for existing users'),
      '#collapsible' => FALSE,
    ];
    $form['email_for_existing_users']['team_invitation_email_existing_subject'] = [
      '#title' => $this
        ->t('Subject'),
      '#type' => 'textfield',
      '#required' => TRUE,
      '#default_value' => $config
        ->get('team_invitation_email_existing.subject'),
    ];
    $form['email_for_existing_users']['team_invitation_email_existing_body'] = [
      '#title' => $this
        ->t('Body'),
      '#type' => 'textarea',
      '#rows' => 10,
      '#required' => TRUE,
      '#default_value' => $config
        ->get('team_invitation_email_existing.body'),
      '#description' => $this
        ->t('Available tokens: [user:display-name], [site:name], [site:url], [team_invitation:team_name], [team_invitation:url_accept], [team_invitation:url_decline], [team_invitation:uid:entity:display-name] (the display name of the user who sent the invitation) and [team_invitation:expiry_days]'),
    ];
    $form['email_for_new_users'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Invitation email for new users'),
      '#collapsible' => FALSE,
    ];
    $form['email_for_new_users']['team_invitation_email_new_subject'] = [
      '#title' => $this
        ->t('Subject'),
      '#type' => 'textfield',
      '#required' => TRUE,
      '#default_value' => $config
        ->get('team_invitation_email_new.subject'),
    ];
    $form['email_for_new_users']['team_invitation_email_new_body'] = [
      '#title' => $this
        ->t('Body'),
      '#type' => 'textarea',
      '#rows' => 10,
      '#required' => TRUE,
      '#default_value' => $config
        ->get('team_invitation_email_new.body'),
      '#description' => $this
        ->t('Available tokens: [site:name], [site:url], [team_invitation:team_name], [team_invitation:url_register], [team_invitation:url_accept], [team_invitation:url_decline], [team_invitation:uid:entity:display-name] (the display name of the user who sent the invitation) and [team_invitation:expiry_days].'),
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    if ((int) $form_state
      ->getValue('team_invitation_expiry_days') < 1) {
      $form_state
        ->setErrorByName('team_invitation_expiry_days', $this
        ->t('Expiry days must be 1 or more days.'));
    }
    parent::validateForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $this->configFactory
      ->getEditable('apigee_edge_teams.team_settings')
      ->set('team_invitation_expiry_days', $form_state
      ->getValue([
      'team_invitation_expiry_days',
    ]))
      ->set('team_invitation_email_existing.subject', $form_state
      ->getValue([
      'team_invitation_email_existing_subject',
    ]))
      ->set('team_invitation_email_existing.body', $form_state
      ->getValue([
      'team_invitation_email_existing_body',
    ]))
      ->set('team_invitation_email_new.subject', $form_state
      ->getValue([
      'team_invitation_email_new_subject',
    ]))
      ->set('team_invitation_email_new.body', $form_state
      ->getValue([
      'team_invitation_email_new_body',
    ]))
      ->save();
    parent::submitForm($form, $form_state);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigFormBase::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create	13
ConfigFormBase::__construct	public	function	Constructs a \Drupal\system\ConfigFormBase object.	11
ConfigFormBaseTrait::config	protected	function	Retrieves a configuration object.
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::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.
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.
TeamInvitationForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
TeamInvitationForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
TeamInvitationForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
TeamInvitationForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
TeamInvitationForm::validateForm	public	function	Form validation handler. Overrides FormBase::validateForm
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 TeamInvitationForm in Apigee Edge 8

Hierarchy

File

Namespace

Members

API Navigation