Ibexa >
Contracts >
Core >
Repository >
Values >
Content >
Query >
SortClause >
MapLocationDistance

MapLocationDistance

MapLocationDistance.php : 19 Copy path

Extends SortClause

Implements CustomFieldInterface

Sets sort direction on the MapLocation distance for a content query.

Properties¶

$direction ¶

SortClause.php : 26 Copy path

Sort direction One of Query::SORT_ASC or Query::SORT_DESC;.

    
                        public string $direction = \Ibexa\Contracts\Core\Repository\Values\Content\Query::SORT_ASC

$target ¶

SortClause.php : 33 Copy path

Sort target, high level: section_identifier, attribute_value, etc.

public string $target

$targetData ¶

SortClause.php : 40 Copy path

Extra target data, required by some sort clauses, field for instance.

public Target|null $targetData

$customFields ¶

MapLocationDistance.php : 26 Copy path

Custom fields to sort by instead of the default field.

protected array<string|int, mixed> $customFields = []

Methods¶

__construct() ¶

MapLocationDistance.php : 37 Copy path

Constructs a new MapLocationDistance SortClause on Type $typeIdentifier and Field $fieldIdentifier.

    
                        public __construct(string $typeIdentifier, string $fieldIdentifier, float $latitude, float $longitude[, string $sortDirection = Query::SORT_ASC ])

Parameters

Name	Type	Default value	Description
$typeIdentifier	string	-	ContentType identifier
$fieldIdentifier	string	-	FieldDefinition identifier
$latitude	float	-	Latitude of the location that distance is calculated from
$longitude	float	-	Longitude of the location that distance is calculated from
$sortDirection	string	Query::SORT_ASC	-

getCustomField() ¶

MapLocationDistance.php : 80 Copy path

Return custom field.

public getCustomField(string $type, string $field) : mixed

If no custom field is set, return null

Parameters

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

setCustomField() ¶

MapLocationDistance.php : 65 Copy path

Set a custom field to sort by.

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

Set a custom field to sort by for a defined field in a defined type.

Parameters

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