CreateReservationDTO
extends AbstractBaseDto
in package
CreateReservationDTO
Data Transfer Object for creating reservations on calendar event time slots. Used when reserving appointment slots created by appointment groups.
Table of Contents
Properties
- $cancelExisting : bool|null
- Defaults to false If true, cancel any previous reservation(s) for this participant and appointment group
- $comments : string|null
- Comments to associate with this reservation
- $participantId : int|null
- User or group id for whom you are making the reservation Depends on the participant type of the appointment group Defaults to the current user (or user's candidate group)
- $apiPropertyName : string
- The name of the property in the API
Methods
- __construct() : mixed
- BaseDto constructor.
- toApiArray() : array<int, array{name: string, contents: string}>
- Convert DTO to API-compatible array format
- toArray() : array<string|int, mixed>
- Convert the DTO to an array
Properties
$cancelExisting
Defaults to false If true, cancel any previous reservation(s) for this participant and appointment group
public
bool|null
$cancelExisting
= null
$comments
Comments to associate with this reservation
public
string|null
$comments
= null
$participantId
User or group id for whom you are making the reservation Depends on the participant type of the appointment group Defaults to the current user (or user's candidate group)
public
int|null
$participantId
= null
$apiPropertyName
The name of the property in the API
protected
string
$apiPropertyName
= ''
Methods
__construct()
BaseDto constructor.
public
__construct(array<string|int, mixed> $data) : mixed
Parameters
- $data : array<string|int, mixed>
Tags
toApiArray()
Convert DTO to API-compatible array format
public
toApiArray() : array<int, array{name: string, contents: string}>
Return values
array<int, array{name: string, contents: string}>toArray()
Convert the DTO to an array
public
toArray() : array<string|int, mixed>