PHP Class Cartalyst\Sentinel\Users\EloquentUser

Inheritance: extends Illuminate\Database\Eloquent\Model, implements Cartalyst\Sentinel\Roles\RoleableInterface, implements Cartalyst\Sentinel\Permissions\PermissibleInterface, implements Cartalyst\Sentinel\Persistences\PersistableInterface, implements Cartalyst\Sentinel\Users\UserInterface, use trait Cartalyst\Sentinel\Permissions\PermissibleTrait
Show file Open project: cartalyst/sentinel Class Usage Examples

Protected Properties

Property Type Description
$activationsModel string The Eloquent activations model name.
$fillable {@inheritDoc}
$hidden {@inheritDoc}
$loginNames array Array of login column names.
$persistableKey {@inheritDoc}
$persistableRelationship {@inheritDoc}
$persistencesModel string The Eloquent persistences model name.
$remindersModel string The Eloquent reminders model name.
$rolesModel string The Eloquent roles model name.
$table {@inheritDoc}
$throttlingModel string The Eloquent throttling model name.

Public Methods

Method Description
__call ( string $method, array $parameters ) : mixed Dynamically pass missing methods to the user.
activations ( ) : Illuminate\Database\Eloquent\Relations\HasMany Returns the activations relationship.
delete ( ) {@inheritDoc}
generatePersistenceCode ( ) {@inheritDoc}
getActivationsModel ( ) : string Returns the activations model.
getLoginNames ( ) : array Returns an array of login column names.
getPermissionsAttribute ( mixed $permissions ) : array Get mutator for the "permissions" attribute.
getPersistableId ( ) {@inheritDoc}
getPersistableKey ( ) {@inheritDoc}
getPersistableRelationship ( ) {@inheritDoc}
getPersistencesModel ( ) : string Returns the persistences model.
getRemindersModel ( ) : string Returns the reminders model.
getRoles ( ) {@inheritDoc}
getRolesModel ( ) : string Returns the roles model.
getThrottlingModel ( ) : string Returns the throttling model.
getUserId ( ) {@inheritDoc}
getUserLogin ( ) {@inheritDoc}
getUserLoginName ( ) {@inheritDoc}
getUserPassword ( ) {@inheritDoc}
inRole ( $role ) {@inheritDoc}
persistences ( ) : Illuminate\Database\Eloquent\Relations\HasMany Returns the persistences relationship.
reminders ( ) : Illuminate\Database\Eloquent\Relations\HasMany Returns the reminders relationship.
roles ( ) : Illuminate\Database\Eloquent\Relations\BelongsToMany Returns the roles relationship.
setActivationsModel ( string $activationsModel ) : void Sets the activations model.
setPermissionsAttribute ( array $permissions ) : void Set mutator for the "permissions" attribute.
setPersistableKey ( $key ) {@inheritDoc}
setPersistableRelationship ( $persistableRelationship ) {@inheritDoc}
setPersistencesModel ( string $persistencesModel ) : void Sets the persistences model.
setRemindersModel ( string $remindersModel ) : void Sets the reminders model.
setRolesModel ( string $rolesModel ) : void Sets the roles model.
setThrottlingModel ( string $throttlingModel ) : void Sets the throttling model.
throttle ( ) : Illuminate\Database\Eloquent\Relations\HasMany Returns the throttle relationship.

Protected Methods

Method Description
createPermissions ( ) : Cartalyst\Sentinel\Permissions\PermissionsInterface Creates a permissions object.

Method Details

__call() public method

Dynamically pass missing methods to the user.
public __call ( string $method, array $parameters ) : mixed
$method string
$parameters array
return mixed

activations() public method

Returns the activations relationship.
public activations ( ) : Illuminate\Database\Eloquent\Relations\HasMany
return Illuminate\Database\Eloquent\Relations\HasMany

createPermissions() protected method

Creates a permissions object.
protected createPermissions ( ) : Cartalyst\Sentinel\Permissions\PermissionsInterface
return Cartalyst\Sentinel\Permissions\PermissionsInterface

delete() public method

{@inheritDoc}
public delete ( )

generatePersistenceCode() public method

{@inheritDoc}

getActivationsModel() public static method

Returns the activations model.
public static getActivationsModel ( ) : string
return string

getLoginNames() public method

Returns an array of login column names.
public getLoginNames ( ) : array
return array

getPermissionsAttribute() public method

Get mutator for the "permissions" attribute.
public getPermissionsAttribute ( mixed $permissions ) : array
$permissions mixed
return array

getPersistableId() public method

{@inheritDoc}
public getPersistableId ( )

getPersistableKey() public method

{@inheritDoc}
public getPersistableKey ( )

getPersistableRelationship() public method

{@inheritDoc}

getPersistencesModel() public static method

Returns the persistences model.
public static getPersistencesModel ( ) : string
return string

getRemindersModel() public static method

Returns the reminders model.
public static getRemindersModel ( ) : string
return string

getRoles() public method

{@inheritDoc}
public getRoles ( )

getRolesModel() public static method

Returns the roles model.
public static getRolesModel ( ) : string
return string

getThrottlingModel() public static method

Returns the throttling model.
public static getThrottlingModel ( ) : string
return string

getUserId() public method

{@inheritDoc}
public getUserId ( )

getUserLogin() public method

{@inheritDoc}
public getUserLogin ( )

getUserLoginName() public method

{@inheritDoc}
public getUserLoginName ( )

getUserPassword() public method

{@inheritDoc}
public getUserPassword ( )

inRole() public method

{@inheritDoc}
public inRole ( $role )

persistences() public method

Returns the persistences relationship.
public persistences ( ) : Illuminate\Database\Eloquent\Relations\HasMany
return Illuminate\Database\Eloquent\Relations\HasMany

reminders() public method

Returns the reminders relationship.
public reminders ( ) : Illuminate\Database\Eloquent\Relations\HasMany
return Illuminate\Database\Eloquent\Relations\HasMany

roles() public method

Returns the roles relationship.
public roles ( ) : Illuminate\Database\Eloquent\Relations\BelongsToMany
return Illuminate\Database\Eloquent\Relations\BelongsToMany

setActivationsModel() public static method

Sets the activations model.
public static setActivationsModel ( string $activationsModel ) : void
$activationsModel string
return void

setPermissionsAttribute() public method

Set mutator for the "permissions" attribute.
public setPermissionsAttribute ( array $permissions ) : void
$permissions array
return void

setPersistableKey() public method

{@inheritDoc}
public setPersistableKey ( $key )

setPersistableRelationship() public method

{@inheritDoc}
public setPersistableRelationship ( $persistableRelationship )

setPersistencesModel() public static method

Sets the persistences model.
public static setPersistencesModel ( string $persistencesModel ) : void
$persistencesModel string
return void

setRemindersModel() public static method

Sets the reminders model.
public static setRemindersModel ( string $remindersModel ) : void
$remindersModel string
return void

setRolesModel() public static method

Sets the roles model.
public static setRolesModel ( string $rolesModel ) : void
$rolesModel string
return void

setThrottlingModel() public static method

Sets the throttling model.
public static setThrottlingModel ( string $throttlingModel ) : void
$throttlingModel string
return void

throttle() public method

Returns the throttle relationship.
public throttle ( ) : Illuminate\Database\Eloquent\Relations\HasMany
return Illuminate\Database\Eloquent\Relations\HasMany

Property Details

$activationsModel protected static property

The Eloquent activations model name.
protected static string $activationsModel
return string

$fillable protected property

{@inheritDoc}
protected $fillable

$hidden protected property

{@inheritDoc}
protected $hidden

$loginNames protected property

Array of login column names.
protected array $loginNames
return array

$persistableKey protected property

{@inheritDoc}
protected $persistableKey

$persistableRelationship protected property

{@inheritDoc}
protected $persistableRelationship

$persistencesModel protected static property

The Eloquent persistences model name.
protected static string $persistencesModel
return string

$remindersModel protected static property

The Eloquent reminders model name.
protected static string $remindersModel
return string

$rolesModel protected static property

The Eloquent roles model name.
protected static string $rolesModel
return string

$table protected property

{@inheritDoc}
protected $table

$throttlingModel protected static property

The Eloquent throttling model name.
protected static string $throttlingModel
return string