Group
class
Group extends Model
Represents a group of people within a community.
Properties
integer $id
ModelRelations $relations
int $community
int $parent
string $title
int $admin_only
int $level
Methods
static boolean
exists(integer $id, integer|Community $community = null)
Check if a group with a given ID exists.
User[]
getMembers()
Get User objects for all of the group's members.
Group|null
getParent()
Get parent group object, or null.
Community
getCommunity()
Returns Community object for group.
boolean
isAdminOnly()
Whether group is admin-only.
boolean
addUser(integer|User $user, integer $weight = 200)
Add a user to the group.
boolean
removeUser(integer|User $user)
Remove a user from the group.
boolean
remove(boolean $cleanRelations = true)
Remove the whole group.
boolean
setPermission(string $key, integer $value)
Set a permission for the users of the group.
static boolean
updatePermission(string $key, integer $value, integer $group, string $type = 'group')
Set permission for a certain group or community.
static Group|false
createWithTitle(string $title, integer|Community $community, integer $parent, boolean $admin = false)
Create a new group. Returns group object after successful creation, or false otherwise.
Inherited from Fillable
static boolean|Fillable
create($fields)
Insert a new entry into the model's database table.
Inherited from Model
__construct(mixed $source = null, boolean $disable_global = false)
Model constructor. Pass in an ID (numeric) or object to start the model.
static Model[]
getAll(integer $limit = null)
Get array of all table rows as model instances.
static integer
getCount(array|string $where = null)
Get the number of items in the model that match the query.
static Model|null
find(integer $id)
Get the item of this model with the given ID if it exists. Returns null otherwise.
Note that any value passed to this function is converted into an integer!
static Model|null
findWith(string|array $field, mixed $value = null)
Check if an item with a given field value (exact match) exists.
static Model|null
getBy(string|array $field, mixed $value = null)
Get item by a specific field (exact match). Returns null on failure.
static Model[]
getManyBy(string|array $field, mixed $value = null)
Get array of items that have a specific field value (exact match).
static boolean
existsWith(string $field, mixed $value = null)
Check if an item with a given field value (exact match) exists.
boolean
update(string|array $field, mixed $value = null)
Update a field of this entry.
boolean
del()
Delete the resource from the database.
object
barebones()
Get a bare bones version of the Model (without db, relations, etc.).