PHP Interface Cartalyst\Sentinel\Roles\RoleInterface

Show file Open project: cartalyst/sentinel

Public Methods

Method Description
getRoleId ( ) : integer Returns the role's primary key.
getRoleSlug ( ) : string Returns the role's slug.
getUsers ( ) : IteratorAggregate Returns all users for the role.
getUsersModel ( ) : string Returns the users model.
setUsersModel ( string $usersModel ) : void Sets the users model.

Method Details

getRoleId() public method

Returns the role's primary key.
public getRoleId ( ) : integer
return integer

getRoleSlug() public method

Returns the role's slug.
public getRoleSlug ( ) : string
return string

getUsers() public method

Returns all users for the role.
public getUsers ( ) : IteratorAggregate
return IteratorAggregate

getUsersModel() public static method

Returns the users model.
public static getUsersModel ( ) : string
return string

setUsersModel() public static method

Sets the users model.
public static setUsersModel ( string $usersModel ) : void
$usersModel string
return void