vendor/symfonycasts/reset-password-bundle/src/Util/ResetPasswordCleaner.php line 31

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the SymfonyCasts ResetPasswordBundle package.
  5.  * Copyright (c) SymfonyCasts <https://symfonycasts.com/>
  6.  * For the full copyright and license information, please view the LICENSE
  7.  * file that was distributed with this source code.
  8.  */
  10. namespace SymfonyCasts\Bundle\ResetPassword\Util;
  12. use SymfonyCasts\Bundle\ResetPassword\Persistence\ResetPasswordRequestRepositoryInterface;
  14. /**
  15.  * @author Jesse Rushlow <jr@rushlow.dev>
  16.  * @author Ryan Weaver   <ryan@symfonycasts.com>
  17.  *
  18.  * @internal
  19.  *
  20.  * @final
  21.  */
  22. class ResetPasswordCleaner
  23. {
  24.     /**
  25.      * @var bool Enable/disable garbage collection
  26.      */
  27.     private $enabled;
  29.     private $repository;
  31.     public function __construct(ResetPasswordRequestRepositoryInterface $repository, bool $enabled = true)
  32.     {
  33.         $this->repository = $repository;
  34.         $this->enabled = $enabled;
  35.     }
  37.     /**
  38.      * Clears expired reset password requests from persistence.
  39.      *
  40.      * Enable/disable in configuration. Calling with $force = true
  41.      * will attempt to remove expired requests regardless of
  42.      * configuration setting.
  43.      */
  44.     public function handleGarbageCollection(bool $force = false): int
  45.     {
  46.         if ($this->enabled || $force) {
  47.             return $this->repository->removeExpiredResetPasswordRequests();
  48.         }
  50.         return 0;
  51.     }
  52. }