class User in Rabbit Hole 2.x

Implements rabbit hole behavior for users.

Plugin annotation

@RabbitHoleEntityPlugin(
 id = "rh_user",
 label = @Translation("User"),
 entityType = "user"
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\rabbit_hole\Plugin\RabbitHoleEntityPluginBase implements RabbitHoleEntityPluginInterface
    • class \Drupal\rh_user\Plugin\RabbitHoleEntityPlugin\User

File

modules/rh_user/src/Plugin/RabbitHoleEntityPlugin/User.php, line 17

Namespace

Drupal\rh_user\Plugin\RabbitHoleEntityPlugin

class User extends RabbitHoleEntityPluginBase {

  /**
   * {@inheritdoc}
   */
  public function getGlobalConfigFormId() {
    return "user_admin_settings";
  }

  /**
   * {@inheritdoc}
   */
  public function getGlobalFormSubmitHandlerAttachLocations(array $form, FormStateInterface $form_state) {
    return [
      '#submit',
    ];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	2
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	98
RabbitHoleEntityPluginBase::getBundleFormSubmitHandlerAttachLocations	public	function	Return locations to attach submit handlers to entity bundle form. Overrides RabbitHoleEntityPluginInterface::getBundleFormSubmitHandlerAttachLocations	1
RabbitHoleEntityPluginBase::getEntityTokenMap	public	function	Return a map of entity IDs used by this plugin to token IDs. Overrides RabbitHoleEntityPluginInterface::getEntityTokenMap	1
RabbitHoleEntityPluginBase::getFormSubmitHandlerAttachLocations	public	function	Return locations to attach submit handlers to entities. Overrides RabbitHoleEntityPluginInterface::getFormSubmitHandlerAttachLocations
User::getGlobalConfigFormId	public	function	Return the form ID of the config form for this plugin's entity. Overrides RabbitHoleEntityPluginBase::getGlobalConfigFormId
User::getGlobalFormSubmitHandlerAttachLocations	public	function	Return locations to attach submit handlers to the global config form. Overrides RabbitHoleEntityPluginBase::getGlobalFormSubmitHandlerAttachLocations