ActivityGroup
extends BaseEntity
in package
ActivityGroup Entity
Represents a logical grouping of related activities, providing categorical organization for activities within the Activities plugin. Extends BaseEntity to inherit audit trail functionality and branch authorization integration.
Key Responsibilities:
- Provide logical categorization for related activities
- Support administrative organization of activities
- Enable activity discovery through group-based navigation
- Maintain audit trail through inherited BaseEntity behaviors
Database Fields:
id: Primary key identifiername: Unique display name for the group- Inherits audit fields: created, modified, created_by, modified_by
Relationships:
- hasMany Activities: One group contains multiple activities
Mass Assignment: Only name field is accessible via newEntity()/patchEntity()
For detailed documentation including usage examples, relationships, validation rules,
and integration patterns, see /docs/5.6.6-activity-groups-entity-reference.md.
Tags
Table of Contents
Properties
- $branch_id : int|null
- $created : DateTime|null
- $id : int
- $modified : DateTime|null
- $name : string
- $_accessible : array<string, bool>
- Fields that can be mass assigned using newEntity() or patchEntity().
Methods
- getBranchId() : int|null
- Get the branch ID for authorization checks.
Properties
$branch_id
public
int|null
$branch_id
Associated branch ID (when applicable)
$created
public
DateTime|null
$created
Creation timestamp
$id
public
int
$id
Primary key identifier
$modified
public
DateTime|null
$modified
Last modification timestamp
$name
public
string
$name
Display name for the activity group
$_accessible
Fields that can be mass assigned using newEntity() or patchEntity().
protected
array<string, bool>
$_accessible
= ["name" => true]
Note that when '' is set to true, this allows all unspecified fields to be mass assigned. For security purposes, it is advised to set '' to false (or remove it), and explicitly make individual fields accessible as needed.
Methods
getBranchId()
Get the branch ID for authorization checks.
public
getBranchId() : int|null
Child classes should override for complex branch relationships.
Return values
int|null —The branch ID, or null if no association