abstract class ChangeUserRoleBase

Provides a base class for operations to change a user's role.

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements PluginInspectionInterface
- class \Drupal\Core\Plugin\ContainerFactoryPluginBase implements ContainerFactoryPluginInterface
  - class \Drupal\Core\Action\ActionBase implements ActionInterface
    class \Drupal\Core\Action\ConfigurableActionBase implements ConfigurableActionInterface
    class \Drupal\user\Plugin\Action\ChangeUserRoleBase

Expanded class hierarchy of ChangeUserRoleBase

2 files declare their use of ChangeUserRoleBase

File

drupal/core/modules/user/lib/Drupal/user/Plugin/Action/ChangeUserRoleBase.php, line 15: Contains \Drupal\user\Plugin\Action\ChangeUserRoleBase.

Namespace

Drupal\user\Plugin\Action

View source

abstract class ChangeUserRoleBase extends ConfigurableActionBase {

  /**
   * {@inheritdoc}
   */
  protected function getDefaultConfiguration() {
    return array(
      'rid' => '',
    );
  }

  /**
   * {@inheritdoc}
   */
  public function form(array $form, array &$form_state) {
    $roles = user_role_names(TRUE);
    unset($roles[DRUPAL_AUTHENTICATED_RID]);
    $form['rid'] = array(
      '#type' => 'radios',
      '#title' => t('Role'),
      '#options' => $roles,
      '#default_value' => $this->configuration['rid'],
      '#required' => TRUE,
    );
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submit(array &$form, array &$form_state) {
    $this->configuration['rid'] = $form_state['values']['rid'];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ActionBase::executeMultiple	public	function	Executes the plugin for an array of objects. Overrides ActionInterface::executeMultiple	2
ChangeUserRoleBase::form	public	function	Form constructor. Overrides ConfigurableActionInterface::form
ChangeUserRoleBase::getDefaultConfiguration	protected	function	Returns default configuration for this action. Overrides ConfigurableActionBase::getDefaultConfiguration
ChangeUserRoleBase::submit	public	function	Form submission handler. Overrides ConfigurableActionInterface::submit
ConfigurableActionBase::getConfiguration	public	function	Returns this plugin's configuration. Overrides ConfigurableActionInterface::getConfiguration
ConfigurableActionBase::validate	public	function	Form validation handler. Overrides ConfigurableActionInterface::validate	2
ConfigurableActionBase::__construct	public	function	Constructs a Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct	3
ContainerFactoryPluginBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create	11
ExecutableInterface::execute	public	function	Executes the plugin.	25
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::getPluginDefinition	public	function	Returns the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition
PluginBase::getPluginId	public	function	Returns the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId

Main menu

Search Drupal 8.x

API Navigation

abstract class ChangeUserRoleBase

Hierarchy

File

Namespace

Members

Main menu

You are here

Search Drupal 8.x

API Navigation

abstract class ChangeUserRoleBase

Hierarchy

File

Namespace

Members