class PasswordReset in GraphQL 8.4

Resets the user's password (mutation).

Plugin annotation


@DataProducer(
  id = "password_reset",
  name = @Translation("Password reset"),
  description = @Translation("Allows to reset the password."),
  consumes = {
    "email" = @ContextDefinition("email",
      label = @Translation("Email")
    )
  }
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Component\Plugin\ContextAwarePluginBase implements ContextAwarePluginInterface
  - class \Drupal\Core\Plugin\ContextAwarePluginBase implements CacheableDependencyInterface, ContextAwarePluginInterface uses DependencySerializationTrait, StringTranslationTrait, TypedDataTrait
    class \Drupal\graphql\Plugin\GraphQL\DataProducer\DataProducerPluginBase implements DataProducerPluginInterface uses DataProducerPluginCachingTrait
    class \Drupal\graphql\Plugin\GraphQL\DataProducer\User\PasswordReset implements ContainerFactoryPluginInterface uses StringTranslationTrait

Expanded class hierarchy of PasswordReset

File

src/Plugin/GraphQL/DataProducer/User/PasswordReset.php, line 29

Namespace

Drupal\graphql\Plugin\GraphQL\DataProducer\User

View source

class PasswordReset extends DataProducerPluginBase implements ContainerFactoryPluginInterface {
  use StringTranslationTrait;

  /**
   * The current request.
   *
   * @var \Symfony\Component\HttpFoundation\Request
   */
  protected $currentRequest;

  /**
   * The logger service.
   *
   * @var \Drupal\Core\Logger\LoggerChannelInterface
   */
  protected $logger;

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {

    /** @var \Symfony\Component\HttpFoundation\RequestStack $request_stack */
    $request_stack = $container
      ->get('request_stack');

    /** @var \Drupal\Core\Logger\LoggerChannelInterface $logger */
    $logger = $container
      ->get('logger.channel.graphql');
    return new static($configuration, $plugin_id, $plugin_definition, $request_stack
      ->getCurrentRequest(), $logger);
  }

  /**
   * UserRegister constructor.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param array $plugin_definition
   *   The plugin implementation definition.
   * @param \Symfony\Component\HttpFoundation\Request $current_request
   *   The current request.
   * @param \Drupal\Core\Logger\LoggerChannelInterface $logger
   *   The logger service.
   */
  public function __construct(array $configuration, string $plugin_id, array $plugin_definition, Request $current_request, LoggerChannelInterface $logger) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->currentRequest = $current_request;
    $this->logger = $logger;
  }

  /**
   * Creates an user.
   *
   * @param string $email
   *   The email address to reset the password for.
   *
   * @return \Drupal\graphql\GraphQL\Response\ResponseInterface
   *   Response for password reset mutation with violations in case of failure.
   */
  public function resolve(string $email) : ResponseInterface {
    $content = [
      'mail' => $email,
    ];

    // Drupal does not have a user authentication service so we need to use the
    // authentication controller instead.
    $controller = UserAuthenticationController::create(\Drupal::getContainer());

    // Build up an authentication request for controller out of current request
    // but replace the request body with proper content. This way most of the
    // data are reused including the client's IP which is needed for flood
    // control. The request body is the only thing (besides client's IP) which
    // is pulled from the request within controller.
    $auth_request = new Request($this->currentRequest->query
      ->all(), $this->currentRequest->request
      ->all(), $this->currentRequest->attributes
      ->all(), $this->currentRequest->cookies
      ->all(), $this->currentRequest->files
      ->all(), $this->currentRequest->server
      ->all(), json_encode($content));
    $auth_request
      ->setRequestFormat('json');
    $response = new Response();
    try {
      $controller_response = $controller
        ->resetPassword($auth_request);
    } catch (\Exception $e) {

      // Show general error message so potential attacker cannot abuse endpoint
      // to eg check if some email exist or not. Log to watchdog for potential
      // further investigation.
      $this->logger
        ->warning($e
        ->getMessage());
      $response
        ->addViolation($this
        ->t('Unable to reset password, please try again later.'));
      return $response;
    }

    // Show general error message also in case of unexpected response. Log to
    // watchdog for potential further investigation.
    if ($controller_response
      ->getStatusCode() !== 200) {
      $this->logger
        ->warning("Unexpected response code @code during password reset.", [
        '@code' => $controller_response
          ->getStatusCode(),
      ]);
      $response
        ->addViolation($this
        ->t('Unable to reset password, please try again later.'));
    }
    return $response;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ContextAwarePluginBase::$context	protected	property	The data objects representing the context of this plugin.
ContextAwarePluginBase::$contexts Deprecated	private	property	Data objects representing the contexts passed in the plugin configuration.
ContextAwarePluginBase::contextHandler	protected	function	Wraps the context handler.
ContextAwarePluginBase::createContextFromConfiguration	protected	function	Overrides ContextAwarePluginBase::createContextFromConfiguration
ContextAwarePluginBase::getCacheContexts	public	function	The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts	9
ContextAwarePluginBase::getCacheMaxAge	public	function	The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge	7
ContextAwarePluginBase::getCacheTags	public	function	The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags	4
ContextAwarePluginBase::getContext	public	function	This code is identical to the Component in order to pick up a different Context class. Overrides ContextAwarePluginBase::getContext
ContextAwarePluginBase::getContextMapping	public	function	Gets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::getContextMapping
ContextAwarePluginBase::getContexts	public	function	Gets the defined contexts. Overrides ContextAwarePluginInterface::getContexts
ContextAwarePluginBase::getContextValue	public	function	Gets the value for a defined context. Overrides ContextAwarePluginInterface::getContextValue
ContextAwarePluginBase::setContext	public	function	Set a context on this plugin. Overrides ContextAwarePluginBase::setContext
ContextAwarePluginBase::setContextMapping	public	function	Sets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::setContextMapping
ContextAwarePluginBase::setContextValue	public	function	Sets the value for a defined context. Overrides ContextAwarePluginBase::setContextValue
ContextAwarePluginBase::validateContexts	public	function	Validates the set values for the defined contexts. Overrides ContextAwarePluginInterface::validateContexts
ContextAwarePluginBase::__get	public	function	Implements magic __get() method.
DataProducerPluginBase::getContextDefinition	public	function	Overrides ContextAwarePluginBase::getContextDefinition
DataProducerPluginBase::getContextDefinitions	public	function	Gets the context definitions of the plugin. Overrides ContextAwarePluginBase::getContextDefinitions
DataProducerPluginBase::resolveField	public	function	Resolves the queried field with the given context. Overrides DataProducerPluginInterface::resolveField
DataProducerPluginCachingTrait::edgeCachePrefix	public	function
DataProducerPluginCachingTrait::getContextValues	abstract public	function
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
PasswordReset::$currentRequest	protected	property	The current request.
PasswordReset::$logger	protected	property	The logger service.
PasswordReset::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
PasswordReset::resolve	public	function	Creates an user.
PasswordReset::__construct	public	function	UserRegister constructor. Overrides ContextAwarePluginBase::__construct
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.
TypedDataTrait::$typedDataManager	protected	property	The typed data manager used for creating the data types.
TypedDataTrait::getTypedDataManager	public	function	Gets the typed data manager.	2
TypedDataTrait::setTypedDataManager	public	function	Sets the typed data manager.	2

You are here

class PasswordReset in GraphQL 8.4

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation