Documentation

InviteTeamMember
in package
implements InvitesTeamMembers

Interfaces, Classes, Traits and Enums

InvitesTeamMembers

Table of Contents

invite()  : void
Invite a new team member to the given team.
ensureUserIsNotAlreadyOnTeam()  : Closure
Ensure that the user is not already on the team.
rules()  : array<string|int, mixed>
Get the validation rules for inviting a team member.
validate()  : void
Validate the invite member operation.

Methods

invite()

Invite a new team member to the given team.

public invite(mixed $user, mixed $team, string $email[, string|null $role = null ]) : void
Parameters
$user : mixed
$team : mixed
$email : string
$role : string|null = null
Return values
void

ensureUserIsNotAlreadyOnTeam()

Ensure that the user is not already on the team.

protected ensureUserIsNotAlreadyOnTeam(mixed $team, string $email) : Closure
Parameters
$team : mixed
$email : string
Return values
Closure

rules()

Get the validation rules for inviting a team member.

protected rules(mixed $team) : array<string|int, mixed>
Parameters
$team : mixed
Return values
array<string|int, mixed>

validate()

Validate the invite member operation.

protected validate(mixed $team, string $email, string|null $role) : void
Parameters
$team : mixed
$email : string
$role : string|null
Return values
void

Search results