KMP PHP API Reference

Gathering extends BaseEntity
in package

Gathering Entity

Represents an SCA gathering (tournament, practice, feast, etc.). Gatherings have activities and can require waivers.

Table of Contents

Properties

$branch  : Branch
$branch_id  : int
$cancellation_reason  : string|null
$cancelled_at  : DateTime|null
$created  : DateTime
$created_by  : int
$creator  : Member
$description  : string|null
$end_date  : DateTime
$gathering_activities  : array<string|int, GatheringActivity>
$gathering_attendances  : array<string|int, GatheringAttendance>
$gathering_scheduled_activities  : array<string|int, GatheringScheduledActivity>
$gathering_staff  : array<string|int, GatheringStaff>
$gathering_type  : GatheringType
$gathering_type_id  : int
$gathering_waivers  : array<string|int, GatheringWaiver>
$id  : int
$latitude  : float|null
$location  : string|null
$longitude  : float|null
$modified  : DateTime
$name  : string
$public_page_enabled  : bool
$start_date  : DateTime
$timezone  : string|null
$_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.
_getDateRange()  : string
Virtual field for date range display
_getIsCancelled()  : bool
Virtual field to check if gathering is cancelled
_getIsMultiDay()  : bool
Virtual field to check if gathering is multi-day

Properties

$cancellation_reason

public string|null $cancellation_reason

$cancelled_at

public DateTime|null $cancelled_at

$gathering_type_id

public int $gathering_type_id

$public_page_enabled

public bool $public_page_enabled

$_accessible

Fields that can be mass assigned using newEntity() or patchEntity().

protected array<string, bool> $_accessible = [ 'branch_id' => true, 'gathering_type_id' => true, 'name' => true, 'description' => true, 'start_date' => true, 'end_date' => true, 'location' => true, 'timezone' => true, 'latitude' => true, 'longitude' => true, 'public_page_enabled' => true, 'cancelled_at' => true, 'cancellation_reason' => true, 'created_by' => true, 'created' => true, 'modified' => true, 'branch' => true, 'gathering_type' => true, 'creator' => true, // Guard association; manage via controller actions 'gathering_activities' => false, 'gathering_attendances' => false, 'gathering_scheduled_activities' => false, 'gathering_staff' => false, 'gathering_waivers' => false, ]

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

_getDateRange()

Virtual field for date range display

protected _getDateRange() : string

Shows dates in the gathering's timezone for accurate representation of when the event occurs at its location.

Return values
string

_getIsCancelled()

Virtual field to check if gathering is cancelled

protected _getIsCancelled() : bool
Return values
bool

_getIsMultiDay()

Virtual field to check if gathering is multi-day

protected _getIsMultiDay() : bool

Compares dates in the gathering's timezone (not UTC) to accurately determine if the event spans multiple calendar days at its location.

Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results