PhysicalLocationParametersGroup extends ParametersGroup
in package
Uses PaginableItemsParametersGroupTrait

This is the physical location parameters group class.

Table of Contents

$countryCode  : string
$deliveryPoint  : bool
$idList  : string
$latitude  : float
$locationId  : int
$longitude  : float
$page  : int
$perPage  : int
$returnPoint  : bool
$validator  : ParametersValidator
$visibleOnMap  : bool
setCountryCode() Sets the country ISO identifier parameter for this parameters group.  : void
setDeliveryPoint() Sets if the elements will be filtered using this parameters group in function of if they are delivery points.  : void
setIdList() Sets a list of internal identifiers for this parameters group.  : void
setLatitude() Sets the latitude parameter for this parameters group.  : void
setLocationId() Sets the Location internal identifier parameter for this parameters group.  : void
setLongitude() Sets the longitude parameter for this parameters group.  : void
setPage() Sets the page parameter for this parameters group.  : void
setPerPage() Sets the per page parameter for this parameters group.  : void
setReturnPoint() Sets if the elements will be filtered using this parameters group in function of if they are refund points.  : void
setVisibleOnMap() Sets if the elements will be filtered using this parameters group in function of if they are visible on map.  : void
toArray() Returns the object data on array format.  : array<string|int, mixed>
filter()  : array<string|int, mixed>
getInstantiatedValidator()  : ParametersValidator
getValidator()  : ParametersValidator

Properties

Methods

setCountryCode()

Sets the country ISO identifier parameter for this parameters group.

public setCountryCode(string $countryCode) : void
Parameters
$countryCode : string
Return values
void —

setDeliveryPoint()

Sets if the elements will be filtered using this parameters group in function of if they are delivery points.

public setDeliveryPoint(bool $deliveryPoint) : void
Parameters
$deliveryPoint : bool
Return values
void —

setIdList()

Sets a list of internal identifiers for this parameters group.

public setIdList(string $idList) : void
Parameters
$idList : string
Return values
void —

setLatitude()

Sets the latitude parameter for this parameters group.

public setLatitude(float $latitude) : void
Parameters
$latitude : float
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 —

setLongitude()

Sets the longitude parameter for this parameters group.

public setLongitude(float $longitude) : void
Parameters
$longitude : float
Return values
void —

setPerPage()

Sets the per page parameter for this parameters group.

public setPerPage(int $perPage) : void
Parameters
$perPage : int
Return values
void —

setReturnPoint()

Sets if the elements will be filtered using this parameters group in function of if they are refund points.

public setReturnPoint(bool $returnPoint) : void
Parameters
$returnPoint : bool
Return values
void —

setVisibleOnMap()

Sets if the elements will be filtered using this parameters group in function of if they are visible on map.

public setVisibleOnMap(bool $visibleOnMap) : void
Parameters
$visibleOnMap : bool
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> —

Search results