PHP Class Mpociot\Teamwork\Teamwork

Show file Open project: mpociot/teamwork Class Usage Examples

Public Properties

Property Type Description
$app Illuminate\Foundation\Application Laravel application

Public Methods

Method Description
__construct ( Illuminate\Foundation\Application $app ) Create a new Teamwork instance.
acceptInvite ( Mpociot\Teamwork\TeamInvite $invite )
denyInvite ( Mpociot\Teamwork\TeamInvite $invite )
getInviteFromAcceptToken ( $token ) : mixed
getInviteFromDenyToken ( $token ) : mixed
hasPendingInvite ( $email, Team | array | integer $team ) : boolean Checks if the given email address has a pending invite for the provided Team
inviteToTeam ( string | User $user, null | Team $team = null, callable $success = null ) Invite an email adress to a team.
user ( ) Get the currently authenticated user or null.

Method Details

__construct() public method

Create a new Teamwork instance.
public __construct ( Illuminate\Foundation\Application $app )
$app Illuminate\Foundation\Application

acceptInvite() public method

public acceptInvite ( Mpociot\Teamwork\TeamInvite $invite )
$invite Mpociot\Teamwork\TeamInvite

denyInvite() public method

public denyInvite ( Mpociot\Teamwork\TeamInvite $invite )
$invite Mpociot\Teamwork\TeamInvite

getInviteFromAcceptToken() public method

public getInviteFromAcceptToken ( $token ) : mixed
$token
return mixed

getInviteFromDenyToken() public method

public getInviteFromDenyToken ( $token ) : mixed
$token
return mixed

hasPendingInvite() public method

Checks if the given email address has a pending invite for the provided Team
public hasPendingInvite ( $email, Team | array | integer $team ) : boolean
$email
$team Team | array | integer
return boolean

inviteToTeam() public method

Either provide a email address or an object with an email property. If no team is given, the current_team_id will be used instead.
public inviteToTeam ( string | User $user, null | Team $team = null, callable $success = null )
$user string | User
$team null | Team
$success callable

user() public method

Get the currently authenticated user or null.
public user ( )

Property Details

$app public property

Laravel application
public Application,Illuminate\Foundation $app
return Illuminate\Foundation\Application