class SalesforceAuthForm in Salesforce Suite 8.4
Same name and namespace in other branches
- 5.0.x src/Form/SalesforceAuthForm.php \Drupal\salesforce\Form\SalesforceAuthForm
Entity form for salesforce_auth.
Hierarchy
- class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\Core\Entity\EntityForm implements EntityFormInterface
- class \Drupal\salesforce\Form\SalesforceAuthForm
- class \Drupal\Core\Entity\EntityForm implements EntityFormInterface
Expanded class hierarchy of SalesforceAuthForm
File
- src/
Form/ SalesforceAuthForm.php, line 11
Namespace
Drupal\salesforce\FormView source
class SalesforceAuthForm extends EntityForm {
/**
* The config entity.
*
* @var \Drupal\salesforce\Entity\SalesforceAuthConfig
*/
protected $entity;
/**
* {@inheritdoc}
*/
public function form(array $form, FormStateInterface $form_state) {
$auth = $this->entity;
if (empty($auth
->getPluginsAsOptions())) {
$this
->messenger()
->addError('No auth provider plugins found. Please enable an auth provider module, e.g. salesforce_jwt, before adding an auth config.');
$form['#access'] = FALSE;
return $form;
}
$form_state
->setBuildInfo($form_state
->getBuildInfo() + [
'auth_config' => $this
->config($auth
->getConfigDependencyName()),
]);
$form['label'] = [
'#title' => $this
->t('Label'),
'#type' => 'textfield',
'#description' => $this
->t('User-facing label for this project, e.g. "OAuth Full Sandbox"'),
'#default_value' => $auth
->label(),
'#required' => TRUE,
];
$form['id'] = [
'#type' => 'machine_name',
'#default_value' => $auth
->id(),
'#maxlength' => 32,
'#machine_name' => [
'exists' => [
$this,
'exists',
],
'source' => [
'label',
],
],
'#required' => TRUE,
];
// This is the element that contains all of the dynamic parts of the form.
$form['settings'] = [
'#type' => 'details',
'#title' => $this
->t('Settings'),
'#open' => TRUE,
];
$form['settings']['provider'] = [
'#type' => 'select',
'#title' => $this
->t('Auth provider'),
'#options' => $auth
->getPluginsAsOptions(),
'#required' => TRUE,
'#default_value' => $auth
->getPluginId(),
'#ajax' => [
'callback' => [
$this,
'ajaxUpdateSettings',
],
'event' => 'change',
'wrapper' => 'auth-settings',
],
];
$default = [
'#type' => 'container',
'#title' => $this
->t('Auth provider settings'),
'#title_display' => FALSE,
'#tree' => TRUE,
'#prefix' => '<div id="auth-settings">',
'#suffix' => '</div>',
];
$form['settings']['provider_settings'] = $default;
if ($auth
->getPlugin() && !$form_state
->isRebuilding()) {
$form['settings']['provider_settings'] += $auth
->getPlugin()
->buildConfigurationForm([], $form_state);
}
elseif ($form_state
->getValue('provider')) {
$plugin = $this->entity
->authManager()
->createInstance($form_state
->getValue('provider'));
$form['settings']['provider_settings'] += $plugin
->buildConfigurationForm([], $form_state);
}
elseif ($form_state
->getUserInput()) {
$input = $form_state
->getUserInput();
if (!empty($input['provider'])) {
$plugin = $this->entity
->authManager()
->createInstance($input['provider']);
$form['settings']['provider_settings'] += $plugin
->buildConfigurationForm([], $form_state);
}
}
$form['save_default'] = [
'#type' => 'checkbox',
'#title' => 'Save and set default',
'#default_value' => $this->entity
->isNew() || $this->entity
->authManager()
->getProvider() && $this->entity
->authManager()
->getProvider()
->id() == $this->entity
->id(),
];
return parent::form($form, $form_state);
}
/**
* AJAX callback to update the dynamic settings on the form.
*
* @param array $form
* The form.
* @param \Drupal\Core\Form\FormStateInterface $form_state
* The form state.
*
* @return array
* The element to update in the form.
*/
public function ajaxUpdateSettings(array &$form, FormStateInterface $form_state) {
return $form['settings']['provider_settings'];
}
/**
* {@inheritdoc}
*/
public function validateForm(array &$form, FormStateInterface $form_state) {
parent::validateForm($form, $form_state);
if (!$form_state
->isSubmitted()) {
return;
}
if (!empty($form_state
->getErrors())) {
// Don't bother processing plugin validation if we already have errors.
return;
}
$this->entity
->getPlugin()
->validateConfigurationForm($form, $form_state);
}
/**
* {@inheritdoc}
*/
public function submitForm(array &$form, FormStateInterface $form_state) {
parent::submitForm($form, $form_state);
$this->entity
->getPlugin()
->submitConfigurationform($form, $form_state);
// If redirect is not already set, and we have no errors, send user back to
// the AuthConfig listing page.
if (!$form_state
->getErrors() && !$form_state
->getResponse() && !$form_state
->getRedirect()) {
$form_state
->setRedirectUrl($this->entity
->toUrl('collection'));
}
}
/**
* {@inheritdoc}
*/
public function save(array $form, FormStateInterface $form_state) {
parent::save($form, $form_state);
$this->entity
->getPlugin()
->save($form, $form_state);
if ($form_state
->getValue('save_default')) {
$this
->configFactory()
->getEditable('salesforce.settings')
->set('salesforce_auth_provider', $this->entity
->id())
->save();
}
}
/**
* Determines if the config already exists.
*
* @param string $id
* The config ID.
*
* @return bool
* TRUE if the config exists, FALSE otherwise.
*
* @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
*/
public function exists($id) {
$action = \Drupal::entityTypeManager()
->getStorage($this->entity
->getEntityTypeId())
->load($id);
return !empty($action);
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
EntityForm:: |
protected | property | The entity type manager. | 3 |
EntityForm:: |
protected | property | The module handler service. | |
EntityForm:: |
protected | property | The name of the current operation. | |
EntityForm:: |
private | property | The entity manager. | |
EntityForm:: |
protected | function | Returns an array of supported actions for the current entity form. | 29 |
EntityForm:: |
protected | function | Returns the action form element for the current entity form. | |
EntityForm:: |
public | function | Form element #after_build callback: Updates the entity with submitted data. | |
EntityForm:: |
public | function |
Builds an updated entity object based upon the submitted form values. Overrides EntityFormInterface:: |
2 |
EntityForm:: |
public | function |
Form constructor. Overrides FormInterface:: |
10 |
EntityForm:: |
protected | function | Copies top-level form values to entity properties | 7 |
EntityForm:: |
public | function |
Returns a string identifying the base form. Overrides BaseFormIdInterface:: |
5 |
EntityForm:: |
public | function |
Gets the form entity. Overrides EntityFormInterface:: |
|
EntityForm:: |
public | function |
Determines which entity will be used by this form from a RouteMatch object. Overrides EntityFormInterface:: |
1 |
EntityForm:: |
public | function |
Returns a unique string identifying the form. Overrides FormInterface:: |
10 |
EntityForm:: |
public | function |
Gets the operation identifying the form. Overrides EntityFormInterface:: |
|
EntityForm:: |
protected | function | Initialize the form state and the entity before the first form build. | 3 |
EntityForm:: |
protected | function | Prepares the entity object before the form is built first. | 3 |
EntityForm:: |
protected | function | Invokes the specified prepare hook variant. | |
EntityForm:: |
public | function | Process callback: assigns weights and hides extra fields. | |
EntityForm:: |
public | function |
Sets the form entity. Overrides EntityFormInterface:: |
|
EntityForm:: |
public | function |
Sets the entity manager for this form. Overrides EntityFormInterface:: |
|
EntityForm:: |
public | function |
Sets the entity type manager for this form. Overrides EntityFormInterface:: |
|
EntityForm:: |
public | function |
Sets the module handler for this form. Overrides EntityFormInterface:: |
|
EntityForm:: |
public | function |
Sets the operation for this form. Overrides EntityFormInterface:: |
|
EntityForm:: |
public | function | ||
EntityForm:: |
public | function | ||
FormBase:: |
protected | property | The config factory. | 1 |
FormBase:: |
protected | property | The request stack. | 1 |
FormBase:: |
protected | property | The route match. | |
FormBase:: |
protected | function | Retrieves a configuration object. | |
FormBase:: |
protected | function | Gets the config factory for this form. | 1 |
FormBase:: |
private | function | Returns the service container. | |
FormBase:: |
public static | function |
Instantiates a new instance of this class. Overrides ContainerInjectionInterface:: |
87 |
FormBase:: |
protected | function | Gets the current user. | |
FormBase:: |
protected | function | Gets the request object. | |
FormBase:: |
protected | function | Gets the route match. | |
FormBase:: |
protected | function | Gets the logger for a specific channel. | |
FormBase:: |
protected | function |
Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait:: |
|
FormBase:: |
public | function | Resets the configuration factory. | |
FormBase:: |
public | function | Sets the config factory for this form. | |
FormBase:: |
public | function | Sets the request stack object to use. | |
LinkGeneratorTrait:: |
protected | property | The link generator. | 1 |
LinkGeneratorTrait:: |
protected | function | Returns the link generator. | |
LinkGeneratorTrait:: |
protected | function | Renders a link to a route given a route name and its parameters. | |
LinkGeneratorTrait:: |
public | function | Sets the link generator service. | |
LoggerChannelTrait:: |
protected | property | The logger channel factory service. | |
LoggerChannelTrait:: |
protected | function | Gets the logger for a specific channel. | |
LoggerChannelTrait:: |
public | function | Injects the logger channel factory. | |
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
RedirectDestinationTrait:: |
protected | property | The redirect destination service. | 1 |
RedirectDestinationTrait:: |
protected | function | Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url. | |
RedirectDestinationTrait:: |
protected | function | Returns the redirect destination service. | |
RedirectDestinationTrait:: |
public | function | Sets the redirect destination service. | |
SalesforceAuthForm:: |
protected | property |
The config entity. Overrides EntityForm:: |
|
SalesforceAuthForm:: |
public | function | AJAX callback to update the dynamic settings on the form. | |
SalesforceAuthForm:: |
public | function | Determines if the config already exists. | |
SalesforceAuthForm:: |
public | function |
Gets the actual form array to be built. Overrides EntityForm:: |
|
SalesforceAuthForm:: |
public | function |
Form submission handler for the 'save' action. Overrides EntityForm:: |
|
SalesforceAuthForm:: |
public | function |
This is the default entity object builder function. It is called before any
other submit handler to build the new entity object to be used by the
following submit handlers. At this point of the form workflow the entity is
validated and the form state… Overrides EntityForm:: |
|
SalesforceAuthForm:: |
public | function |
Form validation handler. Overrides FormBase:: |
|
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. | |
UrlGeneratorTrait:: |
protected | property | The url generator. | |
UrlGeneratorTrait:: |
protected | function | Returns the URL generator service. | |
UrlGeneratorTrait:: |
public | function | Sets the URL generator service. | |
UrlGeneratorTrait:: |
protected | function | Generates a URL or path for a specific route based on the given parameters. |