Download the PHP package messerli90/teamwork without Composer
On this page you can find all versions of the php package messerli90/teamwork. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download messerli90/teamwork
More information about messerli90/teamwork
Files in messerli90/teamwork
Package teamwork
Short Description User to Team associations with invitation system for Laravel
License MIT
Homepage https://github.com/messerli90/teamwork
Informations about the package teamwork
Teamwork -
Teamwork adds User - Team association with an invite system to your Laravel App
Installation
You can install the package via composer:
Configuration
To publish Teamwork's configuration file, run:
This will create config/teamwork.php
. The default configuration should work just fine for you, but if you need to change the table / model names you should do that here. The config also supplies an array of possible roles a teammember can have, which can be changed.
Migrations
Run the migration
command to generate all tables needed for Teamwork. If your users or teams are not stored in users
and teams
tables be sure to modify the the config/teamwork.php
configuration.
After the migration, 2 new tables will be created:
- team_user -- pivot table that stores a many-to-many relation between teams and their (users) members. Also includes a 'roles' column, defaults to: member.
- team_invites -- stores pending invites between teams and email addresses.
Usage
Teamwork Facade
You can invite a User to a Team either by passing the User model, or an email address
Check if the given user or email address has a pending invite for the provided Team
Get instance of Invite model from accept / deny token
Accept / Deny Invite
Team - HasMembers trait
Create your own Team model and add the HasMembers
. Trait adds relation for invites
, users
, owner
.
Determine if a User is part of Team
User - HasTeams trait
Add the HasTeams
trait to your User model. Trait adds relation for teams
, ownedTeams
, invites
.
Check if User owns any team, or provided team
Attach User to Team
Detach User from Team
Switch User's role
Testing
Changelog
Please see CHANGELOG for more information what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
Credits
- Michael Messerli
- All Contributors
Special Thanks
This package used mpociot/teamwork as a starting point.
License
The MIT License (MIT). Please see License File for more information.