class RngSettingsForm in RNG - Events and Registrations 8

Same name and namespace in other branches

8.2 src/Form/RngSettingsForm.php \Drupal\rng\Form\RngSettingsForm
3.x src/Form/RngSettingsForm.php \Drupal\rng\Form\RngSettingsForm

Configure primary RNG settings.

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\rng\Form\RngSettingsForm

Expanded class hierarchy of RngSettingsForm

1 string reference to 'RngSettingsForm'

rng.routing.yml in ./rng.routing.yml: rng.routing.yml

File

src/Form/RngSettingsForm.php, line 15

Namespace

Drupal\rng\Form

View source

class RngSettingsForm extends ConfigFormBase {

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

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

  /**
   * Constructs a RegistrantSettingsForm object.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The factory for configuration objects.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Drupal\courier\Service\IdentityChannelManagerInterface $identity_channel_manager
   *   The identity channel manager.
   */
  public function __construct(ConfigFactoryInterface $config_factory, EntityTypeManagerInterface $entity_type_manager, IdentityChannelManagerInterface $identity_channel_manager) {
    parent::__construct($config_factory);
    $this->entityTypeManager = $entity_type_manager;
    $this->identityChannelManager = $identity_channel_manager;
  }

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

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form = parent::buildForm($form, $form_state);
    $config = $this
      ->config('rng.settings');
    $identity_types = $config
      ->get('identity_types');
    $identity_types = is_array($identity_types) ? $identity_types : [];
    $form['contactables'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('People types'),
      '#description' => $this
        ->t('Enable people types who can register for events.'),
      '#open' => TRUE,
      '#tree' => TRUE,
    ];
    foreach ($this->identityChannelManager
      ->getIdentityTypes() as $identity_type) {
      $channels = $this->identityChannelManager
        ->getChannelsForIdentityType($identity_type);
      $channels_string = [];
      foreach ($channels as $channel) {
        if ($channel_entity_type = $this->entityTypeManager
          ->getDefinition($channel, FALSE)) {
          $channels_string[] = $channel_entity_type
            ->getLabel();
        }
      }
      if (!($entity_type = $this->entityTypeManager
        ->getDefinition($identity_type, FALSE))) {
        continue;
      }
      $form['contactables'][$identity_type] = [
        '#type' => 'checkbox',
        '#title' => $this
          ->t('@label (@provider)', [
          '@label' => $entity_type
            ->getLabel(),
          '@provider' => $entity_type
            ->getProvider(),
        ]),
        '#description' => $this
          ->t('Supported channels: @channels', [
          '@channels' => implode(', ', $channels_string),
        ]),
        '#default_value' => in_array($identity_type, $identity_types),
      ];
    }
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $identity_types = [];
    foreach ($form_state
      ->getValue('contactables') as $entity_type => $enabled) {
      if ($enabled) {
        $identity_types[] = $entity_type;
      }
    }
    $config = $this
      ->config('rng.settings');
    $config
      ->set('identity_types', $identity_types);
    $config
      ->save();
    drupal_set_message(t('RNG settings updated.'));
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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.
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.
RngSettingsForm::$entityTypeManager	protected	property	The entity manager.
RngSettingsForm::$identityChannelManager	protected	property	The identity channel manager.
RngSettingsForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
RngSettingsForm::create	public static	function	Instantiates a new instance of this class. Overrides ConfigFormBase::create
RngSettingsForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
RngSettingsForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
RngSettingsForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
RngSettingsForm::__construct	public	function	Constructs a RegistrantSettingsForm object. Overrides ConfigFormBase::__construct
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 RngSettingsForm in RNG - Events and Registrations 8

Hierarchy

File

Namespace

Members

API Navigation