Medical Appointments API

ScheduleDomain
in package
implements JsonSerializable

Tags
OA\Schema

( schema="Schedule", title="Schedule", description="Schedule model", required={"medicalCenterId", "appointmentDurationId", "canBeScheduled", "timeSlots", "createdAt", "active"}, @OA\Property ( property="id", type="integer", format="int64", description="Unique identifier of the schedule", example=1 ), @OA\Property ( property="medicalCenterId", type="integer", format="int32", description="Unique identifier of the medical center", example=1 ), @OA\Property ( property="appointmentDurationId", type="integer", format="int32", description="Unique identifier of the appointment duration", example=1 ), @OA\Property ( property="canBeScheduled", type="boolean", description="Indicates if the schedule can be scheduled", example=true ), @OA\Property ( property="timeSlots", type="array", description="List of time slots", @OA\Items(ref="#/components/schemas/ScheduleTimeSlot") ), @OA\Property ( property="createdAt", type="integer", format="int64", description="Creation date and time of the schedule in Unix timestamp", example=1616598000 ), @OA\Property ( property="active", type="boolean", description="Indicates if the schedule is active", example=true ) )

Interfaces, Classes, Traits and Enums

JsonSerializable

Table of Contents

$active  : bool|null
$appointmentDuration  : AppointmentDurationDomain|null
$appointmentDurationId  : int|null
$canBeScheduled  : bool|null
$createdAt  : DateTime|null
$id  : int|null
$medicalCenterId  : int|null
$timeSlots  : array<string|int, mixed>|null
fromArray()  : ScheduleDomain
Creates an ScheduleDomain object from an array.
getActive()  : bool|null
Get whether the schedule is active.
getAppointmentDuration()  : AppointmentDurationDomain|null
Get the appointment duration domain object.
getAppointmentDurationId()  : int|null
Get the appointment duration ID.
getCanBeScheduled()  : bool|null
Get whether the schedule can be scheduled.
getCreatedAt()  : DateTime|null
Get the creation date and time.
getId()  : int|null
Get the schedule ID.
getMedicalCenterId()  : int|null
Get the medical center ID.
getTimeSlots()  : array<string, ScheduleTimeSlotDomain>|null
Get the list of time slots.
jsonSerialize()  : array<string|int, mixed>
Returns an array representation of the ScheduleDomain object.
setActive()  : void
Set whether the schedule is active.
setAppointmentDuration()  : void
Set the appointment duration domain object.
setAppointmentDurationId()  : void
Set the appointment duration ID.
setCanBeScheduled()  : void
Set whether the schedule can be scheduled.
setCreatedAt()  : void
Set the creation date and time.
setId()  : void
Set the schedule ID.
setMedicalCenterId()  : void
Set the medical center ID.
setTimeSlots()  : void
Set the list of time slots.

Properties

$active

private bool|null $active = null

Whether the schedule is active.

$appointmentDurationId

private int|null $appointmentDurationId = null

The appointment duration ID.

$canBeScheduled

private bool|null $canBeScheduled = null

Whether the schedule can be scheduled.

$createdAt

private DateTime|null $createdAt = null

The creation date and time.

$medicalCenterId

private int|null $medicalCenterId = null

The medical center ID.

$timeSlots

private array<string|int, mixed>|null $timeSlots = null

The list of time slots.

Methods

fromArray()

Creates an ScheduleDomain object from an array.

public static fromArray(array<string|int, mixed> $data) : ScheduleDomain
Parameters
$data : array<string|int, mixed>

The array to create the object from.

Tags
throws
Exception

If there is an error creating the object.

Return values
ScheduleDomain —

The created ScheduleDomain object.

getActive()

Get whether the schedule is active.

public getActive() : bool|null
Return values
bool|null —

Whether the schedule is active.

getAppointmentDurationId()

Get the appointment duration ID.

public getAppointmentDurationId() : int|null
Return values
int|null —

The appointment duration ID.

getCanBeScheduled()

Get whether the schedule can be scheduled.

public getCanBeScheduled() : bool|null
Return values
bool|null —

Whether the schedule can be scheduled.

getCreatedAt()

Get the creation date and time.

public getCreatedAt() : DateTime|null
Return values
DateTime|null —

The creation date and time.

getId()

Get the schedule ID.

public getId() : int|null
Return values
int|null —

The schedule ID.

getMedicalCenterId()

Get the medical center ID.

public getMedicalCenterId() : int|null
Return values
int|null —

The medical center ID.

jsonSerialize()

Returns an array representation of the ScheduleDomain object.

public jsonSerialize() : array<string|int, mixed>
Return values
array<string|int, mixed> —

The array representation of the ScheduleDomain object.

setActive()

Set whether the schedule is active.

public setActive(bool|null $active) : void
Parameters
$active : bool|null

Whether the schedule is active.

Return values
void —

setAppointmentDurationId()

Set the appointment duration ID.

public setAppointmentDurationId(int|null $appointmentDurationId) : void
Parameters
$appointmentDurationId : int|null

The appointment duration ID.

Return values
void —

setCanBeScheduled()

Set whether the schedule can be scheduled.

public setCanBeScheduled(bool|null $canBeScheduled) : void
Parameters
$canBeScheduled : bool|null

Whether the schedule can be scheduled.

Return values
void —

setCreatedAt()

Set the creation date and time.

public setCreatedAt(DateTime|null $createdAt) : void
Parameters
$createdAt : DateTime|null

The creation date and time.

Return values
void —

setId()

Set the schedule ID.

public setId(int|null $id) : void
Parameters
$id : int|null

The schedule ID.

Return values
void —

setMedicalCenterId()

Set the medical center ID.

public setMedicalCenterId(int|null $medicalCenterId) : void
Parameters
$medicalCenterId : int|null

The medical center ID.

Return values
void —

Search results