Documentation

UpcomingEvent
in package

Upcoming event for users

Table of Contents

Properties

$allContextCodes  : string
$appointmentGroupId  : int|null
$appointmentGroupUrl  : string|null
$availableSlots  : int|null
$childEvents  : array<string|int, mixed>
$childEventsCount  : int
$contextCode  : string
$createdAt  : string
$description  : string|null
$effectiveContextCode  : string|null
$endAt  : string
$group  : mixed
$hidden  : bool
$htmlUrl  : string
$locationAddress  : string|null
$locationName  : string|null
$ownReservation  : bool
$parentEventId  : int|null
$participantsPerAppointment  : int|null
$participantType  : string
$reserved  : bool
$reserveUrl  : string|null
$startAt  : string
$title  : string
$updatedAt  : string
$url  : string
$user  : mixed
$workflowState  : string

Methods

__construct()  : mixed
Constructor
getEndAtDate()  : DateTimeInterface|null
Get end time as DateTime
getStartAtDate()  : DateTimeInterface|null
Get start time as DateTime
hasLocation()  : bool
Check if event has location
isActive()  : bool
Check if event is active
toArray()  : array<string, mixed>
Convert to array

Properties

$allContextCodes

public string $allContextCodes

All context codes (comma separated)

$appointmentGroupId

public int|null $appointmentGroupId = null

Appointment group ID

$appointmentGroupUrl

public string|null $appointmentGroupUrl = null

Appointment group URL

$availableSlots

public int|null $availableSlots = null

Available slots

$childEvents

public array<string|int, mixed> $childEvents = []

Child events

$childEventsCount

public int $childEventsCount

Number of child events

$contextCode

public string $contextCode

Context code (e.g., "course_123")

$description

public string|null $description = null

Event description

$effectiveContextCode

public string|null $effectiveContextCode = null

Effective context code

$htmlUrl

public string $htmlUrl

URL to the event in Canvas web UI

$locationAddress

public string|null $locationAddress = null

Location address

$locationName

public string|null $locationName = null

Location name

$ownReservation

public bool $ownReservation

Whether this is user's own reservation

$parentEventId

public int|null $parentEventId = null

Parent event ID

$participantsPerAppointment

public int|null $participantsPerAppointment = null

Participants per appointment

$participantType

public string $participantType

Participant type

$reserved

public bool $reserved

Whether the event is reserved

$reserveUrl

public string|null $reserveUrl = null

Reserve URL

Methods

__construct()

Constructor

public __construct([array<string, mixed> $data = [] ]) : mixed
Parameters
$data : array<string, mixed> = []

getEndAtDate()

Get end time as DateTime

public getEndAtDate() : DateTimeInterface|null
Return values
DateTimeInterface|null

getStartAtDate()

Get start time as DateTime

public getStartAtDate() : DateTimeInterface|null
Return values
DateTimeInterface|null

hasLocation()

Check if event has location

public hasLocation() : bool
Return values
bool

isActive()

Check if event is active

public isActive() : bool
Return values
bool

toArray()

Convert to array

public toArray() : array<string, mixed>
Return values
array<string, mixed>

        
On this page

Search results