Medical Appointments API

PostalCodeEntity extends BaseEntity
in package

This class represents an entity for postal codes, extending the BaseEntity class.

The template parameter <array<int, int>> specifies that the entity's ID is an array of integers in this case.

Tags
extends

BaseEntity

author

Luis Graciano contacto@luisgraciano.dev

Table of Contents

$id  : mixed
$municipalityId  : int|null
$postalCodeId  : 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.
getId()  : I
Get the ID of the entity.
getMunicipalityId()  : int|null
Get the ID of the municipality associated with the postal code.
getPostalCodeId()  : int|null
Get the ID of the postal code.
setId()  : void
Set the ID of the entity.
setMunicipalityId()  : void
Set the ID of the municipality associated with the postal code.
setPostalCodeId()  : void
Set the ID of the postal code.
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

$id

private mixed $id

The ID of the entity. The type of the ID is determined by the template parameter.

$municipalityId

private int|null $municipalityId

The ID of the municipality associated with the postal code.

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.

getId()

Get the ID of the entity.

public getId() : I
Return values
I —

The ID of the entity.

getMunicipalityId()

Get the ID of the municipality associated with the postal code.

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

The ID of the municipality associated with the postal code.

getPostalCodeId()

Get the ID of the postal code.

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

The ID of the postal code.

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 —

setMunicipalityId()

Set the ID of the municipality associated with the postal code.

public setMunicipalityId(int|null $municipalityId) : void
Parameters
$municipalityId : int|null

The ID of the municipality to set for the postal code.

Return values
void —

setPostalCodeId()

Set the ID of the postal code.

public setPostalCodeId(int|null $postalCodeId) : void
Parameters
$postalCodeId : int|null

The ID of the postal code to set.

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.

Search results