Merge branch 'veare-route-improvement' into 3.0

Author: jrean

README.md

@@ -43,19 +43,19 @@ Or run the following command:
     composer require jrean/laravel-user-verification
 
 
-### Add the Service Provider
+### Add the Service Provider & Facade/Alias
 
-Once Larvel User Verification is installed, you need to register the service provider.
-
-Open up `config/app.php` and add the following to the `providers` key:
+Once Larvel User Verification is installed, you need to register the service provider in `config/app.php`. Make sure to add the following line **above** the `RouteServiceProvider`.
 
+```php
     Jrean\UserVerification\UserVerificationServiceProvider::class,
+```
 
-### Add the Facade/Alias
-
-Open up `config/app.php` and add the following to the `aliases` key:
+You may add the following `aliases` to your `config/app.php`:
 
+```php
     'UserVerification' => Jrean\UserVerification\Facades\UserVerification::class
+```
 
 ## CONFIGURATION
 
@@ -161,7 +161,7 @@ Here is a sample e-mail view content to get you started with:
 query string with the user's e-mail as parameter.**
 
 ```
-Click here to verify your account: <a href="{{ $link = url('verification', $user->verification_token) . '?email=' . urlencode($user->email) }}"> {{ $link }}</a>
+Click here to verify your account: <a href="{{ $link = route('email-verification.check', $user->verification_token) . '?email=' . urlencode($user->email) }}"> {{ $link }}</a>
 ```
 
 ## ERRORS
@@ -189,7 +189,7 @@ No user found for the given e-mail adresse.
 
 ### Error View
 
-By default the `user-verification.blade.php` view will be loaded for the verification error route `/verification/error`. If an error occurs, the user will be redirected to this route and this view will be rendered.
+By default the `user-verification.blade.php` view will be loaded for the verification error route `/email-verification/error`. If an error occurs, the user will be redirected to this route and this view will be rendered.
 
 **You may customize this view to your needs.** To do so first publish the view to your resources folder:
 
@@ -203,12 +203,11 @@ The view will be available in the `resources/views/vendor/laravel-user-verificat
 
 ### Routes
 
-Add the two (2) default routes to the `routes/web.php` file. Routes are
-customizable.
+By default this packages ships with two routes, if you want to change them, you can simply define your own routes. Make sure you added the packages service provider **before** Laravels `RouteServiceProvider`, otherwise you can not overwrite the routes.
 
 ```PHP
-    Route::get('verification/error', 'Auth\RegisterController@getVerificationError');
-    Route::get('verification/{token}', 'Auth\RegisterController@getVerification');
+    Route::get('email-verification/error', 'Auth\RegisterController@getVerificationError')->name('email-verification.error');
+    Route::get('email-verification/check/{token}', 'Auth\RegisterController@getVerification')->name('email-verification.check');
 ```
 
 ### Trait
@@ -292,7 +291,7 @@ Where to reditect if the authenticated user is already verified.
 
 Where to redirect after a successful verification token verification.
 
-* `$redirectIfVerificationFails = '/verification/error';`
+* `$redirectIfVerificationFails = '/email-verification/error';`
 
 Where to redirect after a failling token verification.
 
@@ -333,15 +332,6 @@ following Laravel logic. You are free to implement the way you want.
 It is highly recommended to read and to understand the way Laravel implements
 registration/authentication.
 
-Edit the `routes/web.php` file.
-
-- Define two (2) new routes.
-
-```PHP
-    Route::get('verification/error', 'Auth\RegisterController@getVerificationError');
-    Route::get('verification/{token}', 'Auth\RegisterController@getVerification');
-```
-
 - Define the e-mail view.
 
 Edit the `app\Http\Controllers\Auth\RegisterController.php` file.
@@ -455,16 +445,16 @@ update the middleware exception to allow `getVerification` and
 `getVerificationError` routes to be accessed.
 
 ```PHP
-$this->middleware('guest', ['except' => ['getVerification', 'getVerificationError']]);
+    $this->middleware('guest', ['except' => ['getVerification', 'getVerificationError']]);
 ```
 
 ## Relaunch the process anytime
 
 If you want to regenerate and resend the verification token, you can do this with the following two lines:
 
-```php
-UserVerification::generate($user);
-UserVerification::send($user, 'My Custom E-mail Subject');
+```PHP
+    UserVerification::generate($user);
+    UserVerification::send($user, 'My Custom E-mail Subject');
 ```
 
 The `generate` method will generate a new token for the given user and change the `verified` column to 0. The `send` method will send a new e-mail to the user.

src/Traits/RedirectsUsers.php

@@ -29,12 +29,12 @@ public function redirectAfterVerification()
     }
 
     /**
-     * Get the redirect path for a failing verification token verification.
+     * Get the redirect path for a failing token verification.
      *
      * @return string
      */
     public function redirectIfVerificationFails()
     {
-        return property_exists($this, 'redirectIfVerificationFails') ? $this->redirectIfVerificationFails : '/verification/error';
+        return property_exists($this, 'redirectIfVerificationFails') ? $this->redirectIfVerificationFails : route('email-verification.error');
     }
 }

src/UserVerificationServiceProvider.php

@@ -18,12 +18,17 @@ class UserVerificationServiceProvider extends ServiceProvider
      */
     public function boot()
     {
-        $this->loadViewsFrom(__DIR__.'/resources/views', 'laravel-user-verification');
+        if (! $this->app->routesAreCached()) {
+            require __DIR__ . '/routes.php';
+        }
+
+        $this->loadViewsFrom(__DIR__ . '/resources/views', 'laravel-user-verification');
 
         $this->publishes([
-                __DIR__.'/resources/views' => resource_path('views/vendor/laravel-user-verification'),
+                __DIR__ . '/resources/views' => resource_path('views/vendor/laravel-user-verification'),
             ], 'laravel-user-verification-views');
     }
+
     /**
      * Register the service provider.
      *

src/routes.php

@@ -0,0 +1,9 @@
+<?php
+
+/*
+|--------------------------------------------------------------------------
+| Laravel user verification routes
+|--------------------------------------------------------------------------
+*/
+Route::get('email-verification/error', 'Auth\RegisterController@getVerificationError')->name('email-verification.error');
+Route::get('email-verification/check/{token}', 'Auth\RegisterController@getVerification')->name('email-verification.check');