Download the PHP package bogardo/multiauth without Composer
On this page you can find all versions of the php package bogardo/multiauth. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package multiauth
Bogardo\Multiauth
Laravel authentication driver which enables you to use multiple Eloquent models for authentication.
This package supports Laravel's password reminders by default and needs no extra configuration.
Installation
Currently only compatible with Laravel 4.2
Support for Laravel 5 is on the roadmap
Install the package with composer
$ composer require bogardo\multiauth
Add the service provider
Add the following to your providers
array in app/config/app.php
'Bogardo\Multiauth\MultiauthServiceProvider',
Configuration
Change the following in your app/config/auth.php
file.
Set your driver to multiauth
Add your multiauth settings
Usage
Prepare your models
There are 2 things that must be changed in your models
- Add the
Bogardo\Multiauth\User\UserTrait
(replace it if it is already present) - Add a public
$authtype
property. The value of the property should match thetype
key defined in themultiauth
configuration.
Examples
User model
Admin model
Validation
When working with just one table for users you'd normally only check for unique emails/usernames in your users table. But when you're working with multiple tables you have to make sure that your emails/usernames are unique on all relevant tables.
This package provides a convient validation rule to do exactly that.
It will check if the supplied value (email/username) exists on any of the tables defined in the multiauth configuration. It will take note of the identifier (email/username/custom) defined in the configuration.
When using the rule without extra parameters it will make sure the supplied value does not exist in any of the tables. You'd probably use this for creating new users.
When updating an existing user you'd want to check if the supplied value is unique except for the record you are updating. You can do this by supplying two parameters:
- The
type
of the user being updated - The
id
of the user being updated
Usage
Creating new record
Updating an existing Admin user with an id of 5
API
Get the Multiauth service
Get a collection of all registered entities
The EntityCollection
extends Laravel's Collection
Get an entity by type
Filters example implementation
You could use this, for example, to create custom route filters for each user type.
This will create a route filter for every registered user type:
- user:
multiauth.user
- administrator:
multiauth.administrator
Which you could use to restrict access to a route which should only be accessible for a specific user type.
FAQ
- I'm unable to login using the loginUsingId and onceUsingId methods
The loginUsingId()
and onceUsingId()
methods should be passed the type and the id of the user, separated by a dot. This deviates from the default usage, where you'd only have to pass the ID of the user.
Changelog
v0.2.0
- Added Unit Tests
- Moved Validator to it's own class
- Added Badges
- Added Coverall
v0.1.0
- Multiauth implementation
- Updated docs (formatting)
v0.0.1
- Initial setup with just documentation
Todo
- Add support for Laravel 5