class RoleExpireConfigurationForm in Role Expire 8

Same name and namespace in other branches

2.x src/Form/RoleExpireConfigurationForm.php \Drupal\role_expire\Form\RoleExpireConfigurationForm

Configure order for this site.

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\Core\Form\ConfigFormBase uses ConfigFormBaseTrait
  - class \Drupal\role_expire\Form\RoleExpireConfigurationForm

Expanded class hierarchy of RoleExpireConfigurationForm

1 string reference to 'RoleExpireConfigurationForm'

role_expire.routing.yml in ./role_expire.routing.yml: role_expire.routing.yml

File

src/Form/RoleExpireConfigurationForm.php, line 13

Namespace

Drupal\role_expire\Form

View source

class RoleExpireConfigurationForm extends ConfigFormBase {

  /**
   * Role expire API service.
   *
   * @var \Drupal\role_expire\RoleExpireApiService
   */
  protected $roleExpireApi;

  /**
   * {@inheritdoc}
   */
  public function __construct(RoleExpireApiService $roleExpireApi) {
    $this->roleExpireApi = $roleExpireApi;
  }

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

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $excluded_roles = [
      'anonymous',
      'authenticated',
    ];
    $parsed_roles = [];
    $roles = user_roles();
    foreach ($roles as $role) {
      $parsed_roles[$role
        ->id()] = $role
        ->label();
    }
    $values = $this->roleExpireApi
      ->getRolesAfterExpiration();
    $valuesStatus = $this->roleExpireApi
      ->getRolesExpirationStatus();
    $default = [
      0 => $this
        ->t('- None -'),
    ];

    // It is important to respect the keys on this array merge.
    $roles_select = $default + $parsed_roles;
    unset($roles_select['anonymous']);
    unset($roles_select['authenticated']);
    $form['general'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('General settings'),
      '#weight' => 1,
    ];
    $form['general']['role_after'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Role assignment after expiration'),
      '#weight' => 1,
      '#open' => TRUE,
    ];
    foreach ($parsed_roles as $rid => $role_name) {
      if (!in_array($rid, $excluded_roles)) {
        $form['general']['role_after'][$rid] = [
          '#type' => 'select',
          '#options' => $roles_select,
          '#title' => $this
            ->t('Role to assign after the role ":r" expires', [
            ':r' => $role_name,
          ]),
          '#default_value' => isset($values[$rid]) ? $values[$rid] : 0,
        ];
      }
    }
    $form['general']['disabled_role'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Role expiration scope'),
      '#weight' => 1,
      '#open' => TRUE,
    ];
    foreach ($parsed_roles as $rid => $role_name) {
      if (!in_array($rid, $excluded_roles)) {
        $form['general']['disabled_role']['disable_' . $rid] = [
          '#type' => 'checkbox',
          '#title' => $this
            ->t('Disable role expiration for :r', [
            ':r' => $role_name,
          ]),
          '#default_value' => isset($valuesStatus[$rid]) ? $valuesStatus[$rid] : 1,
        ];
      }
    }
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $values = $form_state
      ->getValues();
    $excluded_roles = [
      'anonymous',
      'authenticated',
    ];
    $data = [];
    $dataDisabled = [];
    $parsed_roles = [];
    $roles = user_roles();
    foreach ($roles as $role) {
      $parsed_roles[$role
        ->id()] = $role
        ->label();
    }
    foreach ($parsed_roles as $rid => $role_name) {
      if (!in_array($rid, $excluded_roles)) {
        $data[$rid] = $values[$rid];
        $dataDisabled[$rid] = $values['disable_' . $rid];
      }
    }
    $this
      ->config('role_expire.config')
      ->set('role_expire_default_roles', json_encode($data))
      ->save();
    $this
      ->config('role_expire.config')
      ->set('role_expire_disabled_roles', json_encode($dataDisabled))
      ->save();
    parent::submitForm($form, $form_state);
  }

}

Members

Name	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
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.
RoleExpireConfigurationForm::$roleExpireApi	protected	property	Role expire API service.
RoleExpireConfigurationForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
RoleExpireConfigurationForm::create	public static	function	Instantiates a new instance of this class. Overrides ConfigFormBase::create
RoleExpireConfigurationForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
RoleExpireConfigurationForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
RoleExpireConfigurationForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
RoleExpireConfigurationForm::__construct	public	function	Constructs a \Drupal\system\ConfigFormBase object. Overrides ConfigFormBase::__construct
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.

You are here

class RoleExpireConfigurationForm in Role Expire 8

Hierarchy

File

Namespace

Members

API Navigation