PhysicalLocations
in package
This is the PhysicalLocations class, a macro class for the utilViewHelper.
The purpose of this class is to encapsulate the logic that calculates the view parameters for the util's pagination.
Tags
Table of Contents
| $addAllOption | : bool | |
|---|---|---|
| $addCitySelector | : bool | |
| $addCountrySelector | : bool | |
| $addPostalCodeSelector | : bool | |
| $addStateSelector | : bool | |
| $changeOptionFunction | : string | |
| $defaultPhysicalLocationId | : int|null | |
| $mapsApiKey | : string|null | |
| $optionClass | : string | |
| $optionName | : string | |
| $physicalLocationFields | : array<string|int, mixed> | |
| $physicalLocations | : ElementCollection|null | |
| $showDirections | : bool | |
| $showInMap | : bool | |
| $showPlacesAutocomplete | : bool | |
| __construct() | Constructor method for PhysicalLocations | : mixed |
| getViewParameters() | This method returns all calculated arguments and new parameters for UtilViewHelper.php | : array<string|int, mixed> |
| getProperties() | Return macro use properties | : array<string|int, mixed> |
| getSelector() | Return Select form item | : FormItem |
Properties
$addAllOption
public
bool
$addAllOption
= false
$addCitySelector
public
bool
$addCitySelector
= false
$addCountrySelector
public
bool
$addCountrySelector
= false
$addPostalCodeSelector
public
bool
$addPostalCodeSelector
= false
$addStateSelector
public
bool
$addStateSelector
= false
$changeOptionFunction
public
string
$changeOptionFunction
= ''
$defaultPhysicalLocationId
public
int|null
$defaultPhysicalLocationId
= 0
$mapsApiKey
public
string|null
$mapsApiKey
= null
$optionClass
public
string
$optionClass
= ''
$optionName
public
string
$optionName
= 'physicalLocation'
$physicalLocationFields
public
array<string|int, mixed>
$physicalLocationFields
= ['address', 'postalCode', 'city', 'state', 'country', 'phone', 'email', 'information']
$physicalLocations
public
ElementCollection|null
$physicalLocations
= null
$showDirections
public
bool
$showDirections
= true
$showInMap
public
bool
$showInMap
= false
$showPlacesAutocomplete
public
bool
$showPlacesAutocomplete
= false
Methods
__construct()
Constructor method for PhysicalLocations
public
__construct(array<string|int, mixed> $arguments) : mixed
Parameters
- $arguments : array<string|int, mixed>
Tags
Return values
mixed —getViewParameters()
This method returns all calculated arguments and new parameters for UtilViewHelper.php
public
getViewParameters() : array<string|int, mixed>
Return values
array<string|int, mixed> —getProperties()
Return macro use properties
protected
getProperties() : array<string|int, mixed>
Return values
array<string|int, mixed> —getSelector()
Return Select form item
protected
getSelector(string $name, string $label) : FormItem
Parameters
- $name : string
- $label : string