Medical Appointments API

ExceptionDomain
in package
implements JsonSerializable

Represents an exception domain object.

Tags
OA\Schema

( schema="Exception", title="Exception", description="Exception model", required={"date", "fullDay", "medicalCenterId"}, @OA\Property ( property="id", type="integer", format="int64", description="Unique identifier of the exception", example=1 ), @OA\Property ( property="date", type="string", format="date", description="Date of the exception in the format YYYY-MM-DD", example="2021-03-24" ), @OA\Property ( property="fullDay", type="boolean", description="Indicates if the exception is for the full day", example=false ), @OA\Property ( property="startTime", type="string", description="Start time of the exception in the format HH:mm", example="08:00" ), @OA\Property ( property="endTime", type="string", description="End time of the exception in the format HH:mm", example="09:00" ), @OA\Property ( property="comment", type="string", description="Comment of the exception", example="Comment" ), @OA\Property ( property="createdAt", type="integer", format="int64", description="Creation date and time of the exception in Unix timestamp", example=1616598000 ), @OA\Property ( property="medicalCenterId", type="integer", format="int32", description="Unique identifier of the medical center", example=1 ), @OA\Property ( property="active", type="boolean", description="Indicates if the exception is active", example=true ) )

Interfaces, Classes, Traits and Enums

JsonSerializable

Table of Contents

$active  : bool|null
$comment  : string|null
$createdAt  : DateTime|null
$date  : DateTime|null
$endTime  : string|null
$fullDay  : bool|null
$id  : int|null
$medicalCenterId  : int|null
$startTime  : string|null
fromArray()  : ExceptionDomain
Creates an ExceptionDomain object from an array.
getActive()  : bool|null
Returns whether the exception is active.
getComment()  : string|null
Returns the comment of the exception.
getCreatedAt()  : DateTime|null
Returns the creation date and time of the exception.
getDate()  : DateTime|null
Returns the date of the exception.
getEndTime()  : string|null
Returns the end time of the exception.
getFullDay()  : bool|null
Returns whether the exception is for the full day.
getId()  : int|null
Returns the unique identifier of the exception.
getMedicalCenterId()  : int|null
Returns the unique identifier of the medical center.
getStartTime()  : string|null
Returns the start time of the exception.
jsonSerialize()  : array<string|int, mixed>
Returns an array representation of the ExceptionDomain object.
setActive()  : void
Sets whether the exception is active.
setComment()  : void
Sets the comment of the exception.
setCreatedAt()  : void
Sets the creation date and time of the exception.
setDate()  : void
Sets the date of the exception.
setEndTime()  : void
Sets the end time of the exception.
setFullDay()  : void
Sets whether the exception is for the full day.
setId()  : void
Sets the unique identifier of the exception.
setMedicalCenterId()  : void
Sets the unique identifier of the medical center.
setStartTime()  : void
Sets the start time of the exception.

Properties

$active

private bool|null $active = null

Indicates if the exception is active.

$comment

private string|null $comment = null

The comment of the exception.

$createdAt

private DateTime|null $createdAt = null

The creation date and time of the exception.

$endTime

private string|null $endTime = null

The end time of the exception in the format HH:mm.

$fullDay

private bool|null $fullDay = null

Indicates if the exception is for the full day.

$id

private int|null $id = null

The unique identifier of the exception.

$medicalCenterId

private int|null $medicalCenterId = null

The unique identifier of the medical center.

$startTime

private string|null $startTime = null

The start time of the exception in the format HH:mm.

Methods

fromArray()

Creates an ExceptionDomain object from an array.

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

The array to create the object from.

Tags
throws
Exception

If there is an error creating the object.

Return values
ExceptionDomain —

The created ExceptionDomain object.

getActive()

Returns whether the exception is active.

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

Whether the exception is active.

getComment()

Returns the comment of the exception.

public getComment() : string|null
Return values
string|null —

The comment of the exception.

getCreatedAt()

Returns the creation date and time of the exception.

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

The creation date and time of the exception.

getDate()

Returns the date of the exception.

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

The date of the exception.

getEndTime()

Returns the end time of the exception.

public getEndTime() : string|null
Return values
string|null —

The end time of the exception.

getFullDay()

Returns whether the exception is for the full day.

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

Whether the exception is for the full day.

getId()

Returns the unique identifier of the exception.

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

The unique identifier of the exception.

getMedicalCenterId()

Returns the unique identifier of the medical center.

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

The unique identifier of the medical center.

getStartTime()

Returns the start time of the exception.

public getStartTime() : string|null
Return values
string|null —

The start time of the exception.

jsonSerialize()

Returns an array representation of the ExceptionDomain object.

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

The array representation of the ExceptionDomain object.

setActive()

Sets whether the exception is active.

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

Whether the exception is active.

Return values
void —

setComment()

Sets the comment of the exception.

public setComment(string|null $comment) : void
Parameters
$comment : string|null

The comment of the exception.

Return values
void —

setCreatedAt()

Sets the creation date and time of the exception.

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

The creation date and time of the exception.

Return values
void —

setDate()

Sets the date of the exception.

public setDate(DateTime|null $date) : void
Parameters
$date : DateTime|null

The date of the exception.

Return values
void —

setEndTime()

Sets the end time of the exception.

public setEndTime(string|null $endTime) : void
Parameters
$endTime : string|null

The end time of the exception.

Return values
void —

setFullDay()

Sets whether the exception is for the full day.

public setFullDay(bool|null $fullDay) : void
Parameters
$fullDay : bool|null

Whether the exception is for the full day.

Return values
void —

setId()

Sets the unique identifier of the exception.

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

The unique identifier of the exception.

Return values
void —

setMedicalCenterId()

Sets the unique identifier of the medical center.

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

The unique identifier of the medical center.

Return values
void —

setStartTime()

Sets the start time of the exception.

public setStartTime(string|null $startTime) : void
Parameters
$startTime : string|null

The start time of the exception.

Return values
void —

Search results