PHP Class Xpressengine\User\Models\UserGroup

Author: XE Developers ([email protected])
Inheritance: extends Xpressengine\Database\Eloquent\DynamicModel, implements Xpressengine\User\GroupInterface
Show file Open project: xpressengine/xpressengine Class Usage Examples

Public Properties

Property Type Description
$fillable
$incrementing

Protected Properties

Property Type Description
$connection
$dynamic use dynamic query
$table

Public Methods

Method Description
addUser ( Xpressengine\User\UserInterface $user ) : static add User to this group
exceptUser ( Xpressengine\User\UserInterface $user ) : static except User
getCountAttribute ( ) : integer get user count
getUserCountAttribute ( ) : integer get user count
userCountRelation ( ) : mixed set relationship for user count
users ( ) : Illuminate\Database\Eloquent\Relations\BelongsToMany set relationship with user groups

Method Details

addUser() public method

add User to this group
public addUser ( Xpressengine\User\UserInterface $user ) : static
$user Xpressengine\User\UserInterface user
return static

exceptUser() public method

except User
public exceptUser ( Xpressengine\User\UserInterface $user ) : static
$user Xpressengine\User\UserInterface user
return static

getCountAttribute() public method

get user count
Deprecation: use getUserCountAttribute instead
public getCountAttribute ( ) : integer
return integer

getUserCountAttribute() public method

get user count
public getUserCountAttribute ( ) : integer
return integer

userCountRelation() public method

set relationship for user count
public userCountRelation ( ) : mixed
return mixed

users() public method

set relationship with user groups
public users ( ) : Illuminate\Database\Eloquent\Relations\BelongsToMany
return Illuminate\Database\Eloquent\Relations\BelongsToMany

Property Details

$connection protected property

protected $connection

$dynamic protected property

use dynamic query
protected $dynamic

$fillable public property

public $fillable

$incrementing public property

public $incrementing

$table protected property

protected $table