Merge pull request #65 from QuentinGab/master

Add usable translations for the notification and fix readme

Author: freekmurze

README.md

@@ -203,9 +203,51 @@ When the user clicks the download link in the mail that gets sent after creating
 
 If you don't want to enforce that a user should be logged in to able to download a personal data export, you can set the `authentication_required` config value to `false`. Setting the value to `false` is less secure because anybody with a link to a zip file will be able to download it, but because the name of the zip file contains many random characters, it will be hard to guess it.
 
+### Translate the mail
+
+You need to publish the translations:
+
+```bash
+php artisan vendor:publish --provider="Spatie\PersonalDataExport\PersonalDataExportServiceProvider" --tag="translations"
+```
+
 ### Customizing the mail
 
-You can customize the mailable itself by creating your own mailable that extends `\Spatie\PersonalDataExport\Mail\PersonalDataExportCreatedMail` and register the class name of your mailable in the `mailable` config key of `config/personal-data-export.php`.
+You can customize the mailable itself by creating your own mailable that extends `Spatie\PersonalDataExport\Notifications\PersonalDataExportedNotification` and register the class name of your mailable in the `mailable` config key of `config/personal-data-export.php`.
+
+Here is an example:
+
+```php
+use Spatie\PersonalDataExport\Notifications\PersonalDataExportedNotification as SpatiePersonalDataExportedNotification;
+class PersonalDataExportedNotification extends SpatiePersonalDataExportedNotification
+{
+    public function via($notifiable)
+    {
+        return ['mail'];
+    }
+    public function toMail($notifiable)
+    {
+        $downloadUrl = route('personal-data-exports', $this->zipFilename);
+        if (static::$toMailCallback) {
+            return call_user_func(static::$toMailCallback, $notifiable, $downloadUrl);
+        }
+        return (new MailMessage)
+            ->subject(trans('personal-data-exports.notifications.subject'))
+            ->line(trans('personal-data-exports.notifications.instructions'))
+            ->action(trans('personal-data-exports.notifications.action'), $downloadUrl)
+            ->line(trans('personal-data-exports.notifications.deletion_message', ['date' => $this->deletionDatetime->format('Y-m-d H:i:s')]));
+    }
+}
+```
+
+Then register the class name of your mailable in the `mailable` config key of `config/personal-data-export.php`
+
+```php
+    /*
+     * Something like that
+     */
+    'notification' => \App\Notifications\PersonalDataExportedNotification::class,
+```
 
 ### Customizing the queue
 
@@ -273,4 +315,4 @@ If you discover any security related issues, please email freek@spatie.be instea
 
 ## License
 
-The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
+The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

resources/lang/en/notifications.php

@@ -0,0 +1,8 @@
+<?php
+
+return [
+    'subject' => 'Personal Data Download',
+    'instructions' => 'Please click the button below to download a zip file containg all data we got for your account.',
+    'action' => 'Download Zip File',
+    'deletion_message' => 'This file will be deleted at :date.',
+];

src/Notifications/PersonalDataExportedNotification.php

@@ -42,10 +42,13 @@ public function toMail($notifiable)
         }
 
         return (new MailMessage)
-            ->subject(Lang::get('Personal Data Download'))
-            ->line(Lang::get('Please click the button below to download a zip file containg all data we got for your account.'))
-            ->action(Lang::get('Download Zip File'), $downloadUrl)
-            ->line(Lang::get('This file will be deleted at ' . $this->deletionDatetime->format('Y-m-d H:i:s') . '.'));
+            ->subject(trans('personal-data-export::notifications.subject'))
+            ->line(trans('personal-data-export::notifications.instructions'))
+            ->action(trans('personal-data-export::notifications.action'), $downloadUrl)
+            ->line(trans(
+                'personal-data-export::notifications.deletion_message',
+                ['date' => $this->deletionDatetime->format('Y-m-d H:i:s')]
+            ));
     }
 
     public static function toMailUsing($callback)

src/PersonalDataExportServiceProvider.php

@@ -12,7 +12,7 @@ public function boot()
     {
         if ($this->app->runningInConsole()) {
             $this->publishes([
-                __DIR__.'/../config/personal-data-export.php' => config_path('personal-data-export.php'),
+                __DIR__ . '/../config/personal-data-export.php' => config_path('personal-data-export.php'),
             ], 'config');
         }
 
@@ -21,13 +21,22 @@ public function boot()
                 ->name('personal-data-exports');
         });
 
+        $this->loadTranslationsFrom(
+            __DIR__ . '/../resources/lang/',
+            "personal-data-export"
+        );
+
+        $this->publishes([
+            __DIR__ . '/../resources/lang' => resource_path("lang/vendor/personal-data-export"),
+        ], "translations");
+
         $this->commands([
             CleanOldPersonalDataExportsCommand::class,
         ]);
     }
 
     public function register()
     {
-        $this->mergeConfigFrom(__DIR__.'/../config/personal-data-export.php', 'personal-data-export');
+        $this->mergeConfigFrom(__DIR__ . '/../config/personal-data-export.php', 'personal-data-export');
     }
 }