minor #17246 [UserBundle] Deprecate pin configuration parameter (GSadee)

This PR was merged into the 1.14 branch.

Discussion
----------

| Q               | A
|-----------------|-----
| Branch?         | 1.14
| Bug fix?        | no
| New feature?    | no
| BC breaks?      | no
| Deprecations?   |yes <!-- don't forget to update the UPGRADE-*.md file -->
| Related tickets | 
| License         | MIT

<!--
 - Bug fixes must be submitted against the 1.13 branch
 - Features and deprecations must be submitted against the 1.14 branch
 - Features, removing deprecations and BC breaks must be submitted against the 2.0 branch
 - Make sure that the correct base branch is set

 To be sure you are not breaking any Backward Compatibilities, check the documentation:
 https://docs.sylius.com/en/latest/book/organization/backward-compatibility-promise.html
-->


Commits
-------
  [UserBundle] Deprecate pin configuration parameter
This commit is contained in:
Jan Góralski 2024-10-17 09:19:53 +02:00 committed by GitHub
commit b7c0a85f63
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
8 changed files with 11 additions and 0 deletions

View file

@ -514,3 +514,7 @@
1. The `sylius_core.state_machine` configuration parameter is deprecated and will be removed in 2.0.
Use `sylius_state_machine_abstraction.state_machine` instead.
1. The `sylius_user.resources.{name}.user.resetting.pin` configuration parameter is deprecated and will be removed in 2.0.
The corresponding email `reset_password_pin` and `Sylius\Bundle\UserBundle\Controller\UserController::requestPasswordResetPinAction`
method have been also deprecated and will be removed in 2.0.

View file

@ -39,6 +39,7 @@ final class MailerListener
$this->sendEmail($event->getSubject(), UserBundleEmails::RESET_PASSWORD_TOKEN);
}
/** @deprecated since Sylius 1.14 and will be removed in Sylius 2.0. */
public function sendResetPasswordPinEmail(GenericEvent $event): void
{
$this->sendEmail($event->getSubject(), UserBundleEmails::RESET_PASSWORD_PIN);

View file

@ -18,6 +18,7 @@ sylius_mailer:
reset_password_token:
subject: sylius.emails.user.password_reset.subject
template: "@SyliusShop/Email/passwordReset.html.twig"
# This email is deprecated since Sylius 1.14 and will be removed in 2.0.
reset_password_pin:
subject: sylius.emails.user.password_reset.subject
template: "@SyliusShop/Email/passwordReset.html.twig"

View file

@ -73,6 +73,7 @@ class UserController extends ResourceController
return $this->prepareResetPasswordRequest($request, $generator, UserEvents::REQUEST_RESET_PASSWORD_TOKEN);
}
/** @deprecated since Sylius 1.14 and will be removed in Sylius 2.0. */
public function requestPasswordResetPinAction(Request $request): Response
{
/** @var GeneratorInterface $generator */

View file

@ -102,6 +102,7 @@ final class Configuration implements ConfigurationInterface
->end()
->end()
->arrayNode('pin')
->setDeprecated('sylius/user-bundle', '1.14', 'The "%path%.%node%" is deprecated and will be removed in 2.0.')
->addDefaultsIfNotSet()
->children()
->integerNode('length')

View file

@ -30,6 +30,7 @@ class MailerListener
$this->sendEmail($event->getSubject(), Emails::RESET_PASSWORD_TOKEN);
}
/** @deprecated since Sylius 1.14 and will be removed in Sylius 2.0. */
public function sendResetPasswordPinEmail(GenericEvent $event): void
{
$this->sendEmail($event->getSubject(), Emails::RESET_PASSWORD_PIN);

View file

@ -17,6 +17,7 @@ final class Emails
{
public const RESET_PASSWORD_TOKEN = 'reset_password_token';
/** @deprecated since Sylius 1.14 and will be removed in Sylius 2.0. */
public const RESET_PASSWORD_PIN = 'reset_password_pin';
public const EMAIL_VERIFICATION_TOKEN = 'verification_token';

View file

@ -17,6 +17,7 @@ interface UserEvents
{
public const REQUEST_RESET_PASSWORD_TOKEN = 'sylius.user.password_reset.request.token';
/** @deprecated since Sylius 1.14 and will be removed in Sylius 2.0. */
public const REQUEST_RESET_PASSWORD_PIN = 'sylius.user.password_reset.request.pin';
public const REQUEST_VERIFICATION_TOKEN = 'sylius.user.email_verification.token';