class SettingsForm in Salesforce Suite 8.3

Base form for key add and edit forms.

Hierarchy

• class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
  • class \Drupal\salesforce_encrypt\Form\SettingsForm

1 string reference to 'SettingsForm'

salesforce_encrypt.routing.yml in modules/salesforce_encrypt/salesforce_encrypt.routing.yml

modules/salesforce_encrypt/salesforce_encrypt.routing.yml

File

modules/salesforce_encrypt/src/Form/SettingsForm.php, line 17

Namespace

Drupal\salesforce_encrypt\Form

class SettingsForm extends FormBase {

  /**
   * Profile manager.
   *
   * @var \Drupal\encrypt\EncryptionProfileManagerInterface
   */
  protected $encryptionProfileManager;

  /**
   * SettingsForm constructor.
   *
   * @param \Drupal\Core\State\StateInterface $state
   *   State service.
   * @param \Drupal\encrypt\EncryptionProfileManagerInterface $encryptionProfileManager
   *   Encryption profile manager service.
   * @param \Drupal\salesforce_encrypt\Rest\EncryptedRestClientInterface $client
   *   Rest client service.
   */
  public function __construct(StateInterface $state, EncryptionProfileManagerInterface $encryptionProfileManager, EncryptedRestClientInterface $client) {
    $this->encryptionProfileManager = $encryptionProfileManager;
    $this->state = $state;
    $this->client = $client;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('state'), $container
      ->get('encrypt.encryption_profile.manager'), $container
      ->get('salesforce.client'));
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $options = $this->encryptionProfileManager
      ->getEncryptionProfileNamesAsOptions();
    $default = NULL;
    try {
      $profile = $this->client
        ->getEncryptionProfile();
      if (!empty($profile)) {
        $default = $profile
          ->id();
      }
    } catch (EntityNotFoundException $e) {
      drupal_set_message($e
        ->getFormattableMessage(), 'error');
      drupal_set_message($this
        ->t('Error while loading encryption profile. You will need to <a href=":encrypt">assign a new encryption profile</a>, then <a href=":oauth">re-authenticate to Salesforce</a>.', [
        ':encrypt' => Url::fromRoute('salesforce_encrypt.settings')
          ->toString(),
        ':oauth' => Url::fromRoute('salesforce.authorize')
          ->toString(),
      ]), 'error');
    }
    $form['profile'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Encryption Profile'),
      '#description' => $this
        ->t('Choose an encryption profile with which to encrypt Salesforce information.'),
      '#options' => $options,
      '#default_value' => $default,
      '#empty_option' => $this
        ->t('Do not use encryption'),
    ];
    $form['actions']['#type'] = 'actions';
    $form['actions']['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Save configuration'),
      '#button_type' => 'primary',
    ];

    // By default, render the form using system-config-form.html.twig.
    $form['#theme'] = 'system_config_form';
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $old_profile_id = $this->state
      ->get('salesforce_encrypt.profile');
    $profile_id = $form_state
      ->getValue('profile');
    if ($old_profile_id == $profile_id) {

      // No change to encryption profile. Do nothing.
      return;
    }
    $profile = $this->encryptionProfileManager
      ->getEncryptionProfile($profile_id);
    if (empty($profile_id)) {

      // New profile id empty: disable encryption.
      $this->client
        ->disableEncryption();
    }
    elseif (empty($old_profile_id)) {

      // Old profile id empty: enable encryption anew.
      $this->client
        ->enableEncryption($profile);
    }
    else {

      // Changing encryption profiles: disable, then re-enable.
      $this->client
        ->disableEncryption();
      $this->client
        ->enableEncryption($profile);
    }
    $this->state
      ->resetCache();
    drupal_set_message($this
      ->t('The configuration options have been saved.'));
  }

}

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.
SettingsForm::$encryptionProfileManager	protected	property	Profile manager.
SettingsForm::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
SettingsForm::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
SettingsForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
SettingsForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
SettingsForm::__construct	public	function	SettingsForm constructor.
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.