Skip to content

Commit a9909bc

Browse files
authored
Merge pull request #585 from jrushlow/doc/reset-password-help
Add help doc for reset-password
2 parents 31396f2 + c8e71b9 commit a9909bc

File tree

2 files changed

+19
-0
lines changed

2 files changed

+19
-0
lines changed

src/Maker/MakeResetPassword.php

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@ public function configureCommand(Command $command, InputConfiguration $inputConf
5252
{
5353
$command
5454
->setDescription('Create controller, entity, and repositories for use with symfonycasts/reset-password-bundle.')
55+
->setHelp(file_get_contents(__DIR__.'/../Resources/help/MakeResetPassword.txt'))
5556
;
5657
}
5758

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
The <info>%command.name%</info> command generates all the files needed to implement
2+
a fully-functional & secure password reset system.
3+
4+
The SymfonycastsResetPasswordBundle is required and can be added using composer:
5+
<info>composer require symfonycasts/reset-password-bundle</info>
6+
7+
For more information on the <info>reset-password-bundle</info> check out:
8+
<href=https://github.com/symfonycasts/reset-password-bundle>https://github.com/symfonycasts/reset-password-bundle</>
9+
10+
<info>%command.name%</info> requires a user entity with an email property,
11+
email getter method, and a password setter method. Maker will ask for these
12+
interactively if they cannot be guessed.
13+
14+
Maker will also update your <info>reset-password.yaml</info> configuration file
15+
if one exists. If you have customized the configuration file, maker will attempt
16+
to modify it accordingly but preserve your customizations.
17+
18+
<info>php %command.full_name%</info>

0 commit comments

Comments
 (0)