class SalesforceAuthSettings in Salesforce Suite 8.4

Same name and namespace in other branches

5.0.x src/Form/SalesforceAuthSettings.php \Drupal\salesforce\Form\SalesforceAuthSettings

Class SalesforceAuthSettings.

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\salesforce\Form\SalesforceAuthSettings

Expanded class hierarchy of SalesforceAuthSettings

1 string reference to 'SalesforceAuthSettings'

salesforce.routing.yml in ./salesforce.routing.yml: salesforce.routing.yml

File

src/Form/SalesforceAuthSettings.php, line 17

Namespace

Drupal\salesforce\Form

View source

class SalesforceAuthSettings extends ConfigFormBase {

  /**
   * Auth provider plugin manager service.
   *
   * @var \Drupal\salesforce\SalesforceAuthProviderPluginManagerInterface
   */
  protected $salesforceAuth;

  /**
   * Event dispatcher service.
   *
   * @var \Symfony\Component\EventDispatcher\EventDispatcherInterface
   */
  protected $eventDispatcher;

  /**
   * Constructs a \Drupal\system\ConfigFormBase object.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   Config.
   * @param \Drupal\salesforce\SalesforceAuthProviderPluginManagerInterface $salesforceAuth
   *   Authman.
   * @param \Symfony\Component\EventDispatcher\EventDispatcherInterface $eventDispatcher
   *   Events.
   */
  public function __construct(ConfigFactoryInterface $config_factory, SalesforceAuthProviderPluginManagerInterface $salesforceAuth, EventDispatcherInterface $eventDispatcher) {
    parent::__construct($config_factory);
    $this->salesforceAuth = $salesforceAuth;
    $this->eventDispatcher = $eventDispatcher;
  }

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

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    if (!$this->salesforceAuth
      ->hasProviders()) {
      return [
        '#markup' => 'No auth providers have been enabled. Please enable an auth provider and create an auth config before continuing.',
      ];
    }
    $config = $this
      ->config('salesforce.settings');
    $form = parent::buildForm($form, $form_state);
    $options = [];
    foreach ($this->salesforceAuth
      ->getProviders() as $provider) {
      $options[$provider
        ->id()] = $provider
        ->label() . ' (' . $provider
        ->getPlugin()
        ->label() . ')';
    }
    if (empty($options)) {
      return [
        '#markup' => 'No auth providers found. Please add an auth provider before continuing.',
      ];
    }
    $options = [
      '' => '- None -',
    ] + $options;
    $form['provider'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Choose a default auth provider'),
      '#options' => $options,
      '#default_value' => $config
        ->get('salesforce_auth_provider') ? $config
        ->get('salesforce_auth_provider') : '',
    ];
    $form['#theme'] = 'system_config_form';
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $this
      ->config('salesforce.settings')
      ->set('salesforce_auth_provider', $form_state
      ->getValue('provider') ? $form_state
      ->getValue('provider') : NULL)
      ->save();
    $this
      ->messenger()
      ->addStatus($this
      ->t('Authorization settings have been saved.'));
    $this->eventDispatcher
      ->dispatch(SalesforceEvents::NOTICE, new SalesforceNoticeEvent(NULL, "Authorization provider changed to %provider.", [
      '%provider' => $form_state
        ->getValue('provider'),
    ]));
  }

}

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.
SalesforceAuthSettings::$eventDispatcher	protected	property	Event dispatcher service.
SalesforceAuthSettings::$salesforceAuth	protected	property	Auth provider plugin manager service.
SalesforceAuthSettings::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
SalesforceAuthSettings::create	public static	function	Instantiates a new instance of this class. Overrides ConfigFormBase::create
SalesforceAuthSettings::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
SalesforceAuthSettings::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
SalesforceAuthSettings::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
SalesforceAuthSettings::__construct	public	function	Constructs a \Drupal\system\ConfigFormBase 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 SalesforceAuthSettings in Salesforce Suite 8.4

Hierarchy

File

Namespace

Members

API Navigation