Wallogit.com
2017 © Pedro Peláez
, (*1)
This package provides a user model and simple login, plus remind and register views. It integrates nicely with other ipunkt packages like ipunkt/roles and ipunkt/social-auth to provide a pull-in-and-use-it environment., (*2)
Add to your composer.json following lines, (*3)
"require": {
"ipunkt/auth": "1.*"
}
Add, (*4)
'Ipunkt\Auth\AuthServiceProvider'
to your service provider list., (*5)
Publish the config by doing, (*6)
`php artisan config:publish ipunkt/auth`
Edit the user_table config file to suit your needs, (*7)
table_name - The name the table will go by in the databaselogin_through_field - Which field is used to identify the user for login. Default is email. Username is also commonextra_fields - Array of additional fields which you want your user model to have. Each field should have the following keysname - The field name in the Databasedatabase_type - The field type in the databaseform_type - The input type to use in the register and edit formvalidation_rules - The laravel Validator rules to validate this field when registering or editingnot during register - if set to true then this field will not be available during registration. Only when editing
the userMigrate the user table by doing, (*8)
`php artisan migrate --package=ipunkt/auth`
The registration strategy can be choosen in the config.php through the field registration_strategy, (*9)
Currently only single-opt-in is provided by the package. This means the user will be logged in and activated once they
send valid user data to register.
Config Value: single_opt_in, (*10)
In the future a native double-opt-in will be provided. This means the user will be created, but disabled after they send
valid user data. An email will be sent to their email address with a confirmation link. Their user account will be enabled
once the registration link has been visited
Config Value: double_opt_in, (*11)
Link your users to the route auth.register to allow them to register, (*12)
Link your users to the route auth.login for logging a user in, (*13)
Link your users to the route auth.logout for logging a user out, (*14)
If you wish to publish a list of all users you can use to the auth.user.login route. There are 3 ways to decide access to this:, (*15)
publish_user_index to true in this packages config then everyone will be able to view it.index on itself Auth::user()->can('index', Auth::user()).
PermissionChecker which is included in this package then adding index to the user_actions array will grant access to all usersPermissionChecker for your user model. See ipunkt/permissions for detailpublish_user_index nor allow index in your user models PermissionChecker then it will fail through App::abort(403)
The default behaviour is to deny access., (*16)
To let your users edit a profile link them to the auth.user.edit route, with the user id / $user->getKey() as Parameter, (*17)
This will ask the User model for edit permission, (*18)
PermissionChecker which is included in this package then adding edit to the user_actions array will grant permission to edit the users own profilePermissionChecker for your user model. See ipunkt/permissions for detailThe default behaviour is to allow editing permissions to the users own profile., (*19)
To let your users delete an account, link them to the auth.user.delete route, with the user id / $user->getKey() as Parameter.
Also if a user has permission to delete an account while viewing the auth.user.edit view of said account, a deletion link will be shown., (*20)
This will ask the user model for delete permission, (*21)
PermissionChecker which is included in this package then adding delete to the user_actions array will grant permission to edit the users own profilePermissionChecker for your user model. See ipunkt/permissions for detailThe default behaviour is to to deny deletion permission, (*22)
php artisan view:publish ipunkt/authset_usermodelDefault value: true
When left at true then the AuthServiceProvider will set auth.model to the Model provided by this package
Set to false if you wish to use your own user model., (*23)
set_repositoryDefault value: true
When left at true then the AuthServiceProvider will bind this packages UserRepository to Ipunkt\Auth\Repositories\RepositoryInterface.
The default repository will instanciate the Model set in the config value auth.model.
Set to false if you do not use Eloquent or want to bind your own Repository for the User creation for some reason. see
Change out user model below, (*24)
route_prefixDefault value: ''
This prefix is prepended to all routes set by this package. This enables you to bundle your authentication users under a
single path, like auth/
If you set this, then make sure to check your auth filter. The default Laravel4 implementation sends the user to /login
upon failing, (*25)
set_reminderDefault value: true
When left at true then the AuthServiceProvider will use auth::reminder/email as the View for reminder emails
Set to false if you wish to load a view from your app instead of customizing the package view, (*26)
publish_user_indexDefault value: false
When set to true then $route_prefix/user/ will show a listing of all registered users if the $user->can('index', $dummyUser)
See ipunkt/permissions for specifics about giving permissions, (*27)
user_actionsDefault value: ['edit']
This value configures the default PermissionChecker for the user model this package brings.
Any action listed in this config variable is see as on a user by user base and will be allowed if the user attempts to
do it to his own account., (*28)
routesDefault value: ['logout' => 'auth.login']
This decides where varios actions redirect after they have successfuly finished.
Currently:
- logout User has logged out, (*29)
To create your own registration strategy you will have to register an event listener to Ipunkt.Auth.*, (*30)
Example:, (*31)
class RegistrationServiceProvider extends ServiceProvider {
public function boot() {
if(Config::get('auth::registration_strategy') == 'test_opt_in')
Event::listen('Ipunkt.Auth.*', 'Acme\Listeners\TestOptInListener');
}
public function register() {}
}
whenUserWasCreated(UserWasCreated $event)
UserWasCreated: UserInterface $user
This is called when a User has successfully sent valid registration data.
It is this events responsibility to write the user to the database.
The default way to do this is by calling the UserStoreCommand:
$this->execute( 'Ipunkt\Auth\Commands\UserStoreCommand', ['user' => $event->user] );
whenConfirmationWasAttempted(ConfirmationWasAttempted $confirmation)
This is called when a user comes back from a registration link, (*32)
whenConfirmationWasSuccessful(ConfirmationWasSuccessful $confirmation)
This is called when confirmation was successful, (*33)
whenConfirmationHasFailed(ConfirmationHasFailed $confirmation)
This is called when confirmation has failed, (*34)
Also see Ipunkt\Auth\Listeners\SingleOptInListener for reference, (*35)
To use your own model set the config value 'auth.model' to its classpath., (*36)
If your model does not inherit from eloquent you will also have to replace 'Ipunkt\Auth\Repositories\RepositoryInterface' in the Laravel IoC, (*37)
If you simply want to extend the model brought by this package have your own model inherit from Eloquent and implement Ipunkt\Auth\User\UserInterface., (*38)
All prebuild functionality is capsulated in traits and can be used directly in your new model, (*39)
EloquentUserTrait combines
EloquentUserInterfaceTrait implements the laravel UserInterface for you (pre-4.2)EloquentUserRemindableTrait implements the laravel RemindableInterface for you (pre-4.2)
MIT
MIT
MIT