class Mail in User protect 8

Protects user's mail address.

Plugin annotation

@UserProtection(
  id = "user_mail",
  label = @Translation("E-mail address"),
  weight = -9
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\userprotect\Plugin\UserProtection\UserProtectionBase implements UserProtectionInterface
      • class \Drupal\userprotect\Plugin\UserProtection\Mail

File

src/Plugin/UserProtection/Mail.php, line 16

Namespace

Drupal\userprotect\Plugin\UserProtection

class Mail extends UserProtectionBase {

  /**
   * {@inheritdoc}
   */
  public function applyAccountFormProtection(array &$form, FormStateInterface $form_state) {
    $build_info = $form_state
      ->getBuildInfo();
    $account = $build_info['callback_object']
      ->getEntity();

    // If for some reason the account has no mail, then don't protect it.
    if ($account
      ->getEmail() && isset($form['account']['mail'])) {
      $form['account']['mail']['#disabled'] = TRUE;
      $form['account']['mail']['#value'] = $account
        ->getEmail();
      return TRUE;
    }
    return FALSE;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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
Mail::applyAccountFormProtection	public	function	Implements applyAccountFormProtection::isEnabled(). Overrides UserProtectionBase::applyAccountFormProtection
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
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	3
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.
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.
UserProtectionBase::$provider	public	property	The name of the module that owns this plugin.
UserProtectionBase::$status	public	property	A boolean indicating whether this plugin is enabled.
UserProtectionBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
UserProtectionBase::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration
UserProtectionBase::description	public	function	Returns the description of the protection. Overrides UserProtectionInterface::description
UserProtectionBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
UserProtectionBase::getWeight	public	function	Returns the weight of the user protection. Overrides UserProtectionInterface::getWeight
UserProtectionBase::isEnabled	public	function	Implements UserProtectionInterface::isEnabled(). Overrides UserProtectionInterface::isEnabled
UserProtectionBase::isProtected	public	function	Checks if a given operation on an user should be protected. Overrides UserProtectionInterface::isProtected	2
UserProtectionBase::label	public	function	Returns the user protection label. Overrides UserProtectionInterface::label
UserProtectionBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
UserProtectionBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct