LocationPathParametersGroup
extends ParametersGroup
in package
This is the geolocation model (locations path resource) parameters group class.
Table of Contents
| $countryCode | : string | |
|---|---|---|
| $locationId | : int | |
| $validator | : ParametersValidator | |
| setCountryCode() | Sets the country ISO identifier parameter for this parameters group. | : void |
| setLocationId() | Sets the Location internal identifier parameter for this parameters group. | : void |
| toArray() | Returns the object data on array format. | : array<string|int, mixed> |
| filter() | : array<string|int, mixed> | |
| getInstantiatedValidator() | : ParametersValidator | |
| getValidator() | : LocationPathParametersValidator |
Properties
$countryCode
protected
string
$countryCode
$locationId
protected
int
$locationId
$validator
protected
ParametersValidator
$validator
Methods
setCountryCode()
Sets the country ISO identifier parameter for this parameters group.
public
setCountryCode(string $countryCode) : void
Parameters
- $countryCode : string
Return values
void —setLocationId()
Sets the Location internal identifier parameter for this parameters group.
public
setLocationId(int $locationId) : void
Parameters
- $locationId : int
Return values
void —toArray()
Returns the object data on array format.
public
toArray() : array<string|int, mixed>
Return values
array<string|int, mixed> —filter()
protected
filter(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
Return values
array<string|int, mixed> —getInstantiatedValidator()
protected
getInstantiatedValidator() : ParametersValidator
Return values
ParametersValidator —getValidator()
protected
getValidator() : LocationPathParametersValidator