TimeZoneEntity
extends BaseEntity
in package
This class represents an entity for time zones, extending the BaseEntity class.
The template parameter
Tags
Table of Contents
- $abbreviation : string|null
- $countryCode : string|null
- $dst : int|null
- $gmtOffset : string|null
- $id : mixed
- $timeStart : int|null
- $zoneName : string|null
- bind() : void
- Bind data to the entity properties.
- fields() : array<string|int, mixed>
- Get the names of the entity properties as an array.
- getAbbreviation() : string|null
- Get the abbreviation for this time zone.
- getCountryCode() : string|null
- Get the country code for this time zone.
- getDst() : int|null
- Get the DST (Daylight Saving Time) value for this time zone.
- getGmtOffset() : string|null
- Get the GMT (Greenwich Mean Time) offset for this time zone.
- getId() : I
- Get the ID of the entity.
- getTimeStart() : int|null
- Get the start time for this time zone.
- getZoneName() : string|null
- Get the name of this time zone.
- setAbbreviation() : void
- Set the abbreviation for this time zone.
- setCountryCode() : void
- Set the country code for this time zone.
- setDst() : void
- Set the DST (Daylight Saving Time) value for this time zone.
- setGmtOffset() : void
- Set the GMT (Greenwich Mean Time) offset for this time zone.
- setId() : void
- Set the ID of the entity.
- setTimeStart() : void
- Set the start time for this time zone.
- setZoneName() : void
- Set the name of this time zone.
- 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
$abbreviation
private
string|null
$abbreviation
= null
The time zone abbreviation
$countryCode
private
string|null
$countryCode
= null
The country code associated with the time zone
$dst
private
int|null
$dst
= null
Whether the time zone observes daylight saving time (1) or not (0)
$gmtOffset
private
string|null
$gmtOffset
= null
The time zone's GMT offset
$id
private
mixed
$id
The ID of the entity. The type of the ID is determined by the template parameter.
$timeStart
private
int|null
$timeStart
= null
The start time of the time zone
$zoneName
private
string|null
$zoneName
= null
The name of the time zone
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.
getAbbreviation()
Get the abbreviation for this time zone.
public
getAbbreviation() : string|null
Return values
string|null —The abbreviation for this time zone, or null if not set.
getCountryCode()
Get the country code for this time zone.
public
getCountryCode() : string|null
Return values
string|null —The country code for this time zone, or null if not set.
getDst()
Get the DST (Daylight Saving Time) value for this time zone.
public
getDst() : int|null
Return values
int|null —The DST value for this time zone, or null if not set.
getGmtOffset()
Get the GMT (Greenwich Mean Time) offset for this time zone.
public
getGmtOffset() : string|null
Return values
string|null —The GMT offset for this time zone, or null if not set.
getId()
Get the ID of the entity.
public
getId() : I
Return values
I —The ID of the entity.
getTimeStart()
Get the start time for this time zone.
public
getTimeStart() : int|null
Return values
int|null —The start time for this time zone, or null if not set.
getZoneName()
Get the name of this time zone.
public
getZoneName() : string|null
Return values
string|null —The name of this time zone, or null if not set.
setAbbreviation()
Set the abbreviation for this time zone.
public
setAbbreviation(string|null $abbreviation) : void
Parameters
- $abbreviation : string|null
-
The abbreviation for this time zone, or null to unset.
Return values
void —setCountryCode()
Set the country code for this time zone.
public
setCountryCode(string|null $countryCode) : void
Parameters
- $countryCode : string|null
-
The country code for this time zone, or null to unset.
Return values
void —setDst()
Set the DST (Daylight Saving Time) value for this time zone.
public
setDst(int|null $dst) : void
Parameters
- $dst : int|null
-
The DST value for this time zone, or null to unset.
Return values
void —setGmtOffset()
Set the GMT (Greenwich Mean Time) offset for this time zone.
public
setGmtOffset(string|null $gmtOffset) : void
Parameters
- $gmtOffset : string|null
-
The GMT offset for this time zone, or null to unset.
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 —setTimeStart()
Set the start time for this time zone.
public
setTimeStart(int|null $timeStart) : void
Parameters
- $timeStart : int|null
-
The start time for this time zone, or null to unset.
Return values
void —setZoneName()
Set the name of this time zone.
public
setZoneName(string|null $zoneName) : void
Parameters
- $zoneName : string|null
-
The name of this time zone, or null to unset.
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.