You are here

Home » API reference » Form mode manager 8.2 » FormModeManagerRolesForm.php

class FormModeManagerRolesForm in Form mode manager 8.2

Configure Form for Form Mode Manager Role Assign settings.

Hierarchy

Expanded class hierarchy of FormModeManagerRolesForm

1 string reference to 'FormModeManagerRolesForm'
form_mode_user_roles_assign.routing.yml in modules/form_mode_user_roles_assign/form_mode_user_roles_assign.routing.yml
modules/form_mode_user_roles_assign/form_mode_user_roles_assign.routing.yml

File

modules/form_mode_user_roles_assign/src/Form/FormModeManagerRolesForm.php, line 17

Namespace

Drupal\form_mode_user_roles_assign\Form
View source 
class FormModeManagerRolesForm extends FormModeManagerFormBase {

  /**
   * {@inheritdoc}
   */
  public function __construct(ConfigFactoryInterface $config_factory, EntityDisplayRepositoryInterface $entity_display_repository, FormModeManagerInterface $form_mode_manager, CacheTagsInvalidatorInterface $cache_tags_invalidator, EntityTypeManagerInterface $entity_type_manager) {
    parent::__construct($config_factory, $entity_display_repository, $form_mode_manager, $cache_tags_invalidator, $entity_type_manager);
    $this->ignoreExcluded = FALSE;
    $this->ignoreActiveDisplay = FALSE;
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function getAvailableRoleOptions() {
    $roles = array_map([
      '\\Drupal\\Component\\Utility\\Html',
      'escape',
    ], user_role_names(TRUE));
    unset($roles[RoleInterface::AUTHENTICATED_ID]);
    return $roles;
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form = parent::buildForm($form, $form_state);
    if (isset($form['empty'])) {
      return $form;
    }
    $form['user_assign_form_mode_settings'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Automatic Role assign per form mode'),
      '#open' => TRUE,
    ];
    $form['user_assign_form_mode_settings']['vertical_tabs_per_modes'] = [
      '#type' => 'vertical_tabs',
    ];
    $this
      ->buildFormModeForm($form);
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function buildFormPerEntity(array &$form, array $form_modes, $entity_type_id) {
    if ('user' !== $entity_type_id) {
      return $this;
    }
    $entity_label = $this->entityTypeManager
      ->getStorage($entity_type_id)
      ->getEntityType()
      ->getLabel();
    $form['user_assign_form_mode_settings'][$entity_type_id] = [
      '#type' => 'details',
      '#title' => $entity_label,
      '#description' => $this
        ->t('Allows you to configure the user role automatically assigned for the entity <b>@entity_type_id</b> on registration form.', [
        '@entity_type_id' => $entity_label,
      ]),
      '#group' => 'vertical_tabs_per_modes',
    ];
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function buildFormPerFormMode(array &$form, array $form_mode, $entity_type_id) {
    if ('user' !== $entity_type_id) {
      return $this;
    }
    $form_mode_id = str_replace('.', '_', $form_mode['id']);
    $form['user_assign_form_mode_settings'][$entity_type_id]['form_modes'][$form_mode_id] = [
      '#type' => 'details',
      '#title' => $form_mode['label'],
      '#description' => $this
        ->t('Assign role to (<b>@form_mode_id</b>) form registration.', [
        '@form_mode_id' => $form_mode['label'],
      ]),
      '#open' => TRUE,
    ];
    $form['user_assign_form_mode_settings'][$entity_type_id]['form_modes'][$form_mode_id]["{$form_mode_id}_roles"] = [
      '#title' => $this
        ->t('Assign roles'),
      '#type' => 'select',
      '#empty_value' => [],
      '#empty_option' => $this
        ->t('- Any -'),
      '#options' => $this
        ->getAvailableRoleOptions(),
      '#default_value' => $this->settings
        ->get("form_modes.{$form_mode_id}.assign_roles"),
      '#description' => $this
        ->t("Select the type of theme you want to use. You can choose the themes defined by the drupal configuration (default or admin) or select one with the 'custom' option"),
      '#multiple' => TRUE,
    ];
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function setSettingsPerEntity(FormStateInterface $form_state, array $form_modes, $entity_type_id) {
    return FALSE;
  }

  /**
   * {@inheritdoc}
   */
  public function setSettingsPerFormMode(FormStateInterface $form_state, array $form_mode, $entity_type_id) {
    if ('user' !== $entity_type_id) {
      return $this;
    }
    $form_mode_id = str_replace('.', '_', $form_mode['id']);
    $this->settings
      ->set("form_modes.{$form_mode_id}.assign_roles", $form_state
      ->getValue("{$form_mode_id}_roles"));
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    parent::submitForm($form, $form_state);
    $this->cacheTagsInvalidator
      ->invalidateTags([
      'roles',
      'rendered',
    ]);
  }

}

Members

Namesort descending 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
FormModeManagerFormBase::$cacheTagsInvalidator protected property The cache tags invalidator.
FormModeManagerFormBase::$entityDisplayRepository protected property The entity display repository.
FormModeManagerFormBase::$entityTypeManager protected property The entity type manager service.
FormModeManagerFormBase::$formModeManager protected property The form_mode_manager service.
FormModeManagerFormBase::$ignoreActiveDisplay protected property Ignore Active display checks from list.
FormModeManagerFormBase::$ignoreExcluded protected property The form modes list to exclude are used or ignored.
FormModeManagerFormBase::$settings protected property The settings object.
FormModeManagerFormBase::buildFormModeForm public function Build Form Mode Manager settings form for each entity and form modes.
FormModeManagerFormBase::create public static function Instantiates a new instance of this class. Overrides ConfigFormBase::create 1
FormModeManagerFormBase::getConfig protected function Retrieve the current class editable config name.
FormModeManagerFormBase::setFormModeFormSettings public function Set Form Mode Manager settings from form for each entity and form modes.
FormModeManagerRolesForm::buildForm public function Form constructor. Overrides FormModeManagerFormBase::buildForm
FormModeManagerRolesForm::buildFormPerEntity public function Build form element per compatible entities. Overrides FormModeManagerFormBase::buildFormPerEntity
FormModeManagerRolesForm::buildFormPerFormMode public function Build form element per form modes linked by given entity type. Overrides FormModeManagerFormBase::buildFormPerFormMode
FormModeManagerRolesForm::getAvailableRoleOptions public function
FormModeManagerRolesForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
FormModeManagerRolesForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
FormModeManagerRolesForm::setSettingsPerEntity public function Set settings per compatible entities. Overrides FormModeManagerFormBase::setSettingsPerEntity
FormModeManagerRolesForm::setSettingsPerFormMode public function Set settings per form modes for a given entity type. Overrides FormModeManagerFormBase::setSettingsPerFormMode
FormModeManagerRolesForm::submitForm public function Form submission handler. Overrides FormModeManagerFormBase::submitForm
FormModeManagerRolesForm::__construct public function Constructs a CropWidgetForm object. Overrides FormModeManagerFormBase::__construct
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.
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.