Copied!

MapLocationDistance

MapLocationDistance.php : 21
Extends Criterion
Implements CustomFieldInterface

The MapLocationDistance Criterion class.

Provides content filtering based on distance from geographical location.

Properties

public $operator

Criterion.php : 21

The operator used by the Criterion.

 
public string $operator

public $target

Criterion.php : 33

The target used by the criteria (field, metadata...).

 
public string|null $target

public $value

Criterion.php : 28

The value(s) matched by the criteria.

 
public array<string|int, scalar>|scalar $value

public $valueData

Criterion.php : 38

Additional value data, required by some criteria, MapLocationDistance for instance.

 
public Value|null $valueData

protected $customFields

MapLocationDistance.php : 28

Custom field definitions to query instead of default field.

 
protected array<string, array<string, string>> $customFields = []

Methods

public__construct()

MapLocationDistance.php : 38

Creates a Criterion.

 
public __construct(string $target, string $operator, float|array<string|int, float> $distance, float $latitude, float $longitude)

Parameters

Name Type Default value Description
$target string -

FieldDefinition identifier
$operator string -

One of the supported Operator constants
$distance float|array<string|int, float> -

The match value in kilometers, either as an array or as a single value, depending on the operator
$latitude float -

Latitude of the location that distance is calculated from
$longitude float -

Longitude of the location that distance is calculated from

publicgetCustomField()

MapLocationDistance.php : 72

Return custom field.

 
public getCustomField(string $type, string $field) : string|null

If no custom field is set, return null

Parameters

Name Type Default value Description
$type string - -
$field string - -

Return values

string|null

If no custom field is set, return null

publicgetSpecifications()

MapLocationDistance.php : 44

Criterion description function.

 
public getSpecifications() : array<int, Specifications>

Returns the combination of the Criterion's supported operator/value, as an array of Specifications objects

// IN and EQ are supported
return [
    // The EQ operator expects a single value, either as an integer or a string
    new Specifications(
        Operator::EQ,
        Specifications::FORMAT_SINGLE,
        Specifications::TYPE_INTEGER | Specifications::TYPE_STRING
    ),
    // The IN operator expects an array of values, of either integers or strings
    new Specifications(
        Operator::IN,
        Specifications::FORMAT_ARRAY,
        Specifications::TYPE_INTEGER | Specifications::TYPE_STRING
    )
]

Return values

array<int, Specifications>

publicsetCustomField()

MapLocationDistance.php : 62

Set a custom field to query.

 
public setCustomField(string $type, string $field, string $customField) : void

Set a custom field to query for a defined field in a defined type.

Parameters

Name Type Default value Description
$type string - -
$field string - -
$customField string - -