You are here

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

class SimplesamlphpCustomAttributesDeleteForm in SimpleSAMLphp Custom Attribute Mapping 8

Hierarchy

Expanded class hierarchy of SimplesamlphpCustomAttributesDeleteForm

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

File

src/Form/SimplesamlphpCustomAttributesDeleteForm.php, line 14

Namespace

Drupal\simplesamlphp_custom_attributes\Form
View source 
class SimplesamlphpCustomAttributesDeleteForm extends ConfirmFormBase {

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

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

  /**
   * The name of the attribute we're deleting (needed for the confirm message).
   *
   * @var string
   */
  protected $attributeName;

  /**
   * The name of the field we're deleting (needed for the confirm message).
   *
   * @var string
   */
  protected $fieldName;

  /**
   * {@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'));
  }

  /**
   * Returns a unique string identifying the form.
   *
   * @return string
   *   The unique string identifying the form.
   */
  public function getFormId() {
    return 'simplesamlphp_custom_attributes_delete_form';
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, $mapping = FALSE) {
    if (is_numeric($mapping)) {
      $mappings = $this->mappingConfig
        ->get('mappings');

      // Set these values for the confirm message to pick up on them.
      $this->attributeName = $mappings[$mapping]['attribute_name'];
      $this->fieldName = $mappings[$mapping]['field_name'];

      // Set the mapping id so the submit handler can delete it.
      $form_state
        ->set('simplesamlphp_custom_attributes_mapping', $mapping);
      return parent::buildForm($form, $form_state);
    }
    return FALSE;
  }

  /**
   * {@inheritdoc}
   */
  public function getQuestion() {

    // Get the pretty label for the message.
    $fields = $this->entityFieldManager
      ->getFieldDefinitions('user', 'user');
    if (isset($fields[$this->fieldName])) {
      $field_name = $fields[$this->fieldName]
        ->getLabel();
    }
    else {
      $field_name = $this
        ->t('Custom');
    }
    return $this
      ->t('Are you sure you want to delete the ":attribute > :field" mapping?', [
      ':attribute' => $this->attributeName,
      ':field' => $field_name,
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public function getCancelUrl() {
    return new Url('simplesamlphp_custom_attributes.list');
  }

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

    // Remove the mapping from the array.
    unset($mappings[$form_state
      ->get('simplesamlphp_custom_attributes_mapping')]);

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

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

}

Members

Namesort descending Modifiers Type Description Overrides
ConfirmFormBase::getCancelText public function Returns a caption for the link which cancels the action. Overrides ConfirmFormInterface::getCancelText 1
ConfirmFormBase::getConfirmText public function Returns a caption for the button that confirms the action. Overrides ConfirmFormInterface::getConfirmText 20
ConfirmFormBase::getDescription public function Returns additional text to display as a description. Overrides ConfirmFormInterface::getDescription 11
ConfirmFormBase::getFormName public function Returns the internal name used to refer to the confirmation item. Overrides ConfirmFormInterface::getFormName
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.
SimplesamlphpCustomAttributesDeleteForm::$attributeName protected property The name of the attribute we're deleting (needed for the confirm message).
SimplesamlphpCustomAttributesDeleteForm::$entityFieldManager protected property Used to get field names for user entity.
SimplesamlphpCustomAttributesDeleteForm::$fieldName protected property The name of the field we're deleting (needed for the confirm message).
SimplesamlphpCustomAttributesDeleteForm::$mappingConfig protected property Mapping settings.
SimplesamlphpCustomAttributesDeleteForm::buildForm public function Form constructor. Overrides ConfirmFormBase::buildForm
SimplesamlphpCustomAttributesDeleteForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
SimplesamlphpCustomAttributesDeleteForm::getCancelUrl public function Returns the route to go to if the user cancels the action. Overrides ConfirmFormInterface::getCancelUrl
SimplesamlphpCustomAttributesDeleteForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
SimplesamlphpCustomAttributesDeleteForm::getQuestion public function Returns the question to ask the user. Overrides ConfirmFormInterface::getQuestion
SimplesamlphpCustomAttributesDeleteForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
SimplesamlphpCustomAttributesDeleteForm::__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.