Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/laratipsofficial/password-changed-notification
If you want to see how this package is build, have a look at the YouTube playlist.
https://github.com/laratipsofficial/password-changed-notification
laravel php
Last synced: 2 months ago
JSON representation
If you want to see how this package is build, have a look at the YouTube playlist.
- Host: GitHub
- URL: https://github.com/laratipsofficial/password-changed-notification
- Owner: Laratipsofficial
- License: mit
- Created: 2021-12-16T17:04:52.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-10-09T09:54:35.000Z (over 1 year ago)
- Last Synced: 2024-05-16T20:03:19.746Z (8 months ago)
- Topics: laravel, php
- Language: PHP
- Homepage: https://www.youtube.com/playlist?list=PL2DahmvUpeuu8HkpbNT-cKernolVdqZq_
- Size: 50.8 KB
- Stars: 28
- Watchers: 4
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# Password Changed Notification
[](https://packagist.org/packages/asdh/password-changed-notification)
[](https://github.com/asdh/password-changed-notification/actions?query=workflow%3Arun-tests+branch%3Amain)
[](https://github.com/asdh/password-changed-notification/actions?query=workflow%3A"Check+%26+fix+styling"+branch%3Amain)
[](https://packagist.org/packages/asdh/password-changed-notification)
A simple package to send mail notification to the user when their password is changed.
## Installation
You can install the package via composer:
```bash
composer require asdh/password-changed-notification
```
## Usage
After installing the package, you can go to your `User` model or any other model that has password and email fields and use `PasswordChangedNotificationTrait` trait and implement `PasswordChangedNotificationContract` interface
```php
use Asdh\PasswordChangedNotification\Contracts\PasswordChangedNotificationContract;
use Asdh\PasswordChangedNotification\Traits\PasswordChangedNotificationTrait;
class User extends Authenticatable implements PasswordChangedNotificationContract
{
use PasswordChangedNotificationTrait;
}
```
Now whenever you change the password of the user, a mail will be automatically sent to that user. Isn't that easy.
By default the package will assume the columns name to be `email` and `password`. But if you have different column name for those fields then you can modify those as well.
Let's say you have the `email` column as `user_email` in your `User` model or any other model, then you can add `emailColumnName` method on the `User` model and return `user_email` from here like so:
```php
public function emailColumnName(): string
{
return 'user_email';
}
```
You can also modify the `password` column by adding this method.
```php
public function passwordColumnName(): string
{
return 'user_password';
}
```
You can also modify the `name` column by adding this method. This will be used in the mail like Hi `Adam`.
```php
public function nameColumnName(): string
{
return 'full_name';
}
```
Further, if you want to modify the mail that is being sent to the user, you can publish the mail view using
```bash
php artisan vendor:publish --tag="password-changed-notification-views"
```
The views view will now be published in `resources/views/vendor/password-changed-notification/emails/password-changed-notification.blade.php`. You can modify this file as per your need and when mail is sent to the user, it will be used.
You can also create your own mailable (the one that you create using `php artisan make:mail` command) and use that instead. For that you need to return the mailable that you have created by adding `passwordChangedNotificationMail` method on the `User` model and returning the mailable.
```php
public function passwordChangedNotificationMail(): Mailable
{
return new YourOwnPasswordChangedNotificationMail($this);
}
```
## Testing
```bash
composer test
```
## Credits
- [Laratips](https://github.com/Laratipsofficial)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.