You are here

Home » API reference » SimpleSAMLphp Custom Attribute Mapping 8 » SimplesamlphpCustomAttributesEditForm.php

class SimplesamlphpCustomAttributesEditForm in SimpleSAMLphp Custom Attribute Mapping 8

Hierarchy

Expanded class hierarchy of SimplesamlphpCustomAttributesEditForm

1 string reference to 'SimplesamlphpCustomAttributesEditForm'
simplesamlphp_custom_attributes.routing.yml in ./simplesamlphp_custom_attributes.routing.yml
simplesamlphp_custom_attributes.routing.yml

File

src/Form/SimplesamlphpCustomAttributesEditForm.php, line 13

Namespace

Drupal\simplesamlphp_custom_attributes\Form
View source 
class SimplesamlphpCustomAttributesEditForm extends FormBase {

  /**
   * Mapping settings.
   *
   * @var \Drupal\Core\Config\Config
   */
  protected $mappingConfig;

  /**
   * Used to get field names for user entity.
   *
   * @var \Drupal\Core\Entity\EntityFieldManagerInterface
   */
  protected $entityFieldManager;

  /**
   * {@inheritdoc}
   */
  public function __construct(EntityFieldManagerInterface $entity_field_manager) {
    $configFactory = $this
      ->configFactory();
    $this->mappingConfig = $configFactory
      ->getEditable('simplesamlphp_custom_attributes.mappings');
    $this->entityFieldManager = $entity_field_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('entity_field.manager'));
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, $mapping = NULL) {
    $saml_attribute = '';
    $field_name = '';
    if ($mapping !== NULL) {

      // Get the mappings from the settings.
      $mappings = $this->mappingConfig
        ->get('mappings');

      // Get this specific mapping attribute name and field name.
      $saml_attribute = $mappings[$mapping]['attribute_name'];
      $field_name = $mappings[$mapping]['field_name'];
    }

    // Get any fields that are not provided by core's user module. They could be
    // added via Field API, or as base fields on the user entity.
    $options = [
      'custom' => $this
        ->t('Custom'),
    ];
    $fields = $this->entityFieldManager
      ->getFieldDefinitions('user', 'user');
    foreach ($fields as $name => $field) {
      if ($field
        ->getFieldStorageDefinition()
        ->getProvider() != 'user') {
        $options[$name] = $field
          ->getLabel();
      }
    }
    $form['attribute_name'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('SAML Attribute'),
      '#description' => $this
        ->t('The name of the SAML attribute you want to sync to the user profile.'),
      '#required' => TRUE,
      '#default_value' => $saml_attribute,
    ];
    $form['field_name'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('User Field'),
      '#description' => $this
        ->t('The user field you want to sync this attribute to.'),
      '#required' => TRUE,
      '#options' => $options,
      '#default_value' => $field_name,
    ];

    // Add this value so we know if it's an add or an edit.
    $form['mapping_id'] = [
      '#type' => 'hidden',
      '#value' => $mapping,
    ];
    $form['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Submit'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    $mappings = $this->mappingConfig
      ->get('mappings');

    // If this is a new mapping, check to make sure the same one isn't already
    // defined.
    if ($mappings && !$form_state
      ->getValue('mapping_id')) {
      foreach ($mappings as $mapping) {
        if ($mapping['attribute_name'] === $form_state
          ->getValue('attribute_name') && $mapping['field_name'] === $form_state
          ->getValue('field_name')) {
          $form_state
            ->setErrorByName('field_name', $this
            ->t('This SAML attribute has already been mapped to this field.'));
        }
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $mappings = $this->mappingConfig
      ->get('mappings');

    // Set up the new mapping to add to the array.
    $mapping = [
      'attribute_name' => $form_state
        ->getValue('attribute_name'),
      'field_name' => $form_state
        ->getValue('field_name'),
    ];

    // If we're editing, update the value, if we're adding, add it.
    $mapping_id = $form_state
      ->getValue('mapping_id');
    if (is_numeric($mapping_id)) {
      $mappings[$mapping_id] = $mapping;
    }
    else {
      $mappings[] = $mapping;
    }

    // Save the config with the new mappings.
    $this->mappingConfig
      ->set('mappings', $mappings)
      ->save();

    // Go back to the listing page.
    $form_state
      ->setRedirect('simplesamlphp_custom_attributes.list');
  }

}

Members

Namesort descending 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.
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.
SimplesamlphpCustomAttributesEditForm::$entityFieldManager protected property Used to get field names for user entity.
SimplesamlphpCustomAttributesEditForm::$mappingConfig protected property Mapping settings.
SimplesamlphpCustomAttributesEditForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
SimplesamlphpCustomAttributesEditForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
SimplesamlphpCustomAttributesEditForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
SimplesamlphpCustomAttributesEditForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
SimplesamlphpCustomAttributesEditForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
SimplesamlphpCustomAttributesEditForm::__construct public function
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.