PHP Class Flarum\Core\Group

Inheritance: extends Flarum\Database\AbstractModel, use trait Flarum\Core\Support\EventGeneratorTrait, use trait Flarum\Core\Support\ScopeVisibilityTrait
Datei anzeigen Open project: flarum/core Class Usage Examples

Protected Properties

Property Type Description
$table

Public Methods

Method Description
boot ( ) : void Boot the model.
build ( string $nameSingular, string $namePlural, string $color, string $icon ) : static Create a new group.
permissions ( ) : Illuminate\Database\Eloquent\Relations\HasMany Define the relationship with the group's permissions.
rename ( string $nameSingular, string $namePlural ) Rename the group.
users ( ) : Illuminate\Database\Eloquent\Relations\BelongsToMany Define the relationship with the group's users.

Method Details

boot() public static method

Boot the model.
public static boot ( ) : void
return void

build() public static method

Create a new group.
public static build ( string $nameSingular, string $namePlural, string $color, string $icon ) : static
$nameSingular string
$namePlural string
$color string
$icon string
return static

permissions() public method

Define the relationship with the group's permissions.
public permissions ( ) : Illuminate\Database\Eloquent\Relations\HasMany
return Illuminate\Database\Eloquent\Relations\HasMany

rename() public method

Rename the group.
public rename ( string $nameSingular, string $namePlural )
$nameSingular string
$namePlural string

users() public method

Define the relationship with the group's users.
public users ( ) : Illuminate\Database\Eloquent\Relations\BelongsToMany
return Illuminate\Database\Eloquent\Relations\BelongsToMany

Property Details

$table protected_oe property

protected $table