Group
in package
Generic group class. This can be used for any logged in group or group related function.
Tags
Table of Contents
Properties
- $active : bool
- $description : string
- $id : int
- $name : string
Methods
- Delete() : bool
- Deletes the group from the database
- load() : Group
- Load a Group given it's id.
- load_all() : array<string|int, mixed>
- Load all groups
- Save() : bool
- Persists the group to the database.
- validate() : mixed
- Validate this object.
Properties
$active
public
bool
$active
Indicates active status of this group.
$description
public
string
$description
The group description
$id read-only
public
int
$id
The group id
$name
public
string
$name
The group name
Methods
Delete()
Deletes the group from the database
public
Delete() : bool
Tags
Return values
bool —True if the delete was successful, false if not.
load()
Load a Group given it's id.
public
static & load(int $id) : Group
Parameters
- $id : int
Tags
Return values
Groupload_all()
Load all groups
public
static load_all() : array<string|int, mixed>
Return values
array<string|int, mixed> —Array of group records.
Save()
Persists the group to the database.
public
Save() : bool
Return values
bool —true if the save was successful, false if not.
validate()
Validate this object.
public
validate() : mixed