ScheduleEntity
extends BaseEntity
in package
This class represents an entity for schedules, extending the BaseEntity class.
The template parameter
Tags
Table of Contents
- $active : int|null
- $appointmentDurationId : int|null
- $canBeScheduled : int|null
- $createdAt : string|null
- $id : mixed
- $medicalCenterId : int|null
- bind() : void
- Bind data to the entity properties.
- fields() : array<string|int, mixed>
- Get the names of the entity properties as an array.
- getActive() : int|null
- Get the value indicating if the schedule is active or not.
- getAppointmentDurationId() : int|null
- Get the ID of the associated appointment duration.
- getCanBeScheduled() : int|null
- Get the value indicating if the schedule can be used for appointment scheduling.
- getCreatedAt() : string|null
- Get the creation date of the schedule.
- getId() : I
- Get the ID of the entity.
- getMedicalCenterId() : int|null
- Get the ID of the associated medical center.
- setActive() : void
- Set the value indicating if the schedule is active or not.
- setAppointmentDurationId() : void
- Set the ID of the associated appointment duration.
- setCanBeScheduled() : void
- Set the value indicating if the schedule can be used for appointment scheduling.
- setCreatedAt() : void
- Set the creation date of the schedule.
- setId() : void
- Set the ID of the entity.
- setMedicalCenterId() : void
- Set the ID of the associated medical center.
- values() : array<string|int, mixed>
- Get the values of the entity properties as an array.
- valuesAsMap() : array<string|int, mixed>
- Get the values of the entity properties as a map.
Properties
$active
private
int|null
$active
= null
Indicates if the schedule is active or not.
$appointmentDurationId
private
int|null
$appointmentDurationId
= null
The ID of the appointment duration associated with the schedule.
$canBeScheduled
private
int|null
$canBeScheduled
= null
Indicates if the schedule can be used for appointment scheduling.
$createdAt
private
string|null
$createdAt
= null
The creation date of the schedule.
$id
private
mixed
$id
The ID of the entity. The type of the ID is determined by the template parameter.
$medicalCenterId
private
int|null
$medicalCenterId
= null
The ID of the medical center associated with the schedule.
Methods
bind()
Bind data to the entity properties.
public
bind(array<string|int, mixed> $data) : void
This method takes an associative array of data and binds the values to the entity's properties. It matches the keys of the data array with the properties defined in the entity's database model class, and if there is a match, it sets the property value using the corresponding setter method.
Parameters
- $data : array<string|int, mixed>
-
An associative array containing the data to bind to the entity properties.
Return values
void —fields()
Get the names of the entity properties as an array.
public
fields() : array<string|int, mixed>
Return values
array<string|int, mixed> —An array containing the names of the entity properties.
getActive()
Get the value indicating if the schedule is active or not.
public
getActive() : int|null
Return values
int|null —The value indicating if the schedule is active or not.
getAppointmentDurationId()
Get the ID of the associated appointment duration.
public
getAppointmentDurationId() : int|null
Return values
int|null —The ID of the associated appointment duration.
getCanBeScheduled()
Get the value indicating if the schedule can be used for appointment scheduling.
public
getCanBeScheduled() : int|null
Return values
int|null —The value indicating if the schedule can be used for appointment scheduling.
getCreatedAt()
Get the creation date of the schedule.
public
getCreatedAt() : string|null
Return values
string|null —The creation date of the schedule.
getId()
Get the ID of the entity.
public
getId() : I
Return values
I —The ID of the entity.
getMedicalCenterId()
Get the ID of the associated medical center.
public
getMedicalCenterId() : int|null
Return values
int|null —The ID of the associated medical center.
setActive()
Set the value indicating if the schedule is active or not.
public
setActive(int|null $active) : void
Parameters
- $active : int|null
-
The value indicating if the schedule is active or not.
Return values
void —setAppointmentDurationId()
Set the ID of the associated appointment duration.
public
setAppointmentDurationId(int|null $appointmentDurationId) : void
Parameters
- $appointmentDurationId : int|null
-
The ID of the associated appointment duration.
Return values
void —setCanBeScheduled()
Set the value indicating if the schedule can be used for appointment scheduling.
public
setCanBeScheduled(int|null $canBeScheduled) : void
Parameters
- $canBeScheduled : int|null
-
The value indicating if the schedule can be used for appointment scheduling.
Return values
void —setCreatedAt()
Set the creation date of the schedule.
public
setCreatedAt(string|null $createdAt) : void
Parameters
- $createdAt : string|null
-
The creation date of the schedule.
Return values
void —setId()
Set the ID of the entity.
public
setId(I $id) : void
Parameters
- $id : I
-
The ID to set for the entity.
Return values
void —setMedicalCenterId()
Set the ID of the associated medical center.
public
setMedicalCenterId(int|null $medicalCenterId) : void
Parameters
- $medicalCenterId : int|null
-
The ID of the associated medical center.
Return values
void —values()
Get the values of the entity properties as an array.
public
values() : array<string|int, mixed>
This method retrieves the values of all properties defined in the entity's database model class and returns them as an array. The array represents the values that can be used in database operations.
Return values
array<string|int, mixed> —An array containing the values of the entity properties.
valuesAsMap()
Get the values of the entity properties as a map.
public
valuesAsMap() : array<string|int, mixed>
This method retrieves the values of all properties defined in the entity's database model class and returns them as an associative array, where the keys represent the property names and the values are the corresponding property values.
Return values
array<string|int, mixed> —An associative array containing the values of the entity properties.