AddressQuery.php

<?php
/**
 * @link https://craftcms.com/
 * @copyright Copyright (c) Pixel & Tonic, Inc.
 * @license https://craftcms.github.io/license/
 */

namespace craft\elements\db;

use Craft;
use craft\db\QueryAbortedException;
use craft\db\Table;
use craft\elements\Address;
use craft\helpers\Db;
use yii\db\Expression;

/**
 * AddressQuery represents a SELECT SQL statement for categories in a way that is independent of DBMS.
 *
 * @template TKey of array-key
 * @template TElement of Address
 * @extends ElementQuery<TKey,TElement>
 *
 * @author Pixel & Tonic, Inc. <support@pixelandtonic.com>
 * @since 4.0.0
 * @doc-path addresses.md
 * @replace {element} address
 * @replace {elements} addresses
 * @replace {twig-method} craft.addresses()
 * @replace {myElement} myAddress
 * @replace {element-class} \craft\elements\Address
 */
class AddressQuery extends ElementQuery implements NestedElementQueryInterface
{
    use NestedElementQueryTrait {
        cacheTags as nestedTraitCacheTags;
    }

    /**
     * @var mixed The address countryCode(s) that the resulting address must be in.
     * ---
     * ```php
     * // fetch addresses that are located in AU
     * $addresses = \craft\elements\Address::find()
     *     ->countryCode('AU')
     *     ->all();
     * ```
     * ```twig
     * {# fetch addresses that are located in AU #}
     * {% set addresses = craft.addresses()
     *   .countryCode('AU')
     *   .all() %}
     * ```
     * @used-by countryCode()
     * @since 5.0.0
     */
    public mixed $countryCode = null;

    /**
     * @var mixed Narrows the query results based on the administrative areas the addresses belongs to.
     * ---
     * ```php
     * // fetch addresses that are located in Western Australia
     * $addresses = \craft\elements\Address::find()
     *     ->administrativeArea('WA')
     *     ->all();
     * ```
     * ```twig
     * {# fetch addresses that are located in Western Australia #}
     * {% set addresses = craft.addresses()
     *   .administrativeArea('WA')
     *   .all() %}
     * ```
     * @used-by administrativeArea()
     * @since 5.0.0
     */
    public mixed $administrativeArea = null;

    /**
     * @var string|null Narrows the query results based on the locality the addresses belong to.
     * ---
     * ```php
     * // fetch addresses by locality
     * $addresses = \craft\elements\Address::find()
     *     ->locality('Perth')
     *     ->all();
     * ```
     * ```twig
     * {# fetch addresses by locality #}
     * {% set addresses = craft.addresses()
     *   .locality('Perth')
     *   .all() %}
     * ```
     * @used-by locality()
     * @since 5.0.0
     */
    public ?string $locality = null;

    /**
     * @var string|null Narrows the query results based on the dependent locality the addresses belong to.
     * ---
     * ```php
     * // fetch addresses by dependent locality
     * $addresses = \craft\elements\Address::find()
     *     ->dependentLocality('Darlington')
     *     ->all();
     * ```
     * ```twig
     * {# fetch addresses by dependent locality #}
     * {% set addresses = craft.addresses()
     *   .dependentLocality('Darlington')
     *   .all() %}
     * ```
     * @used-by dependentLocality()
     * @since 5.0.0
     */
    public ?string $dependentLocality = null;

    /**
     * @var string|null Narrows the query results based on the postal code the addresses belong to.
     * ---
     * ```php
     * // fetch addresses by postal code
     * $addresses = \craft\elements\Address::find()
     *     ->postalCode('10001')
     *     ->all();
     * ```
     * ```twig
     * {# fetch addresses by postal code #}
     * {% set addresses = craft.addresses()
     *   .postalCode('10001')
     *   .all() %}
     * ```
     * @used-by postalCode()
     * @since 5.0.0
     */
    public ?string $postalCode = null;

    /**
     * @var string|null Narrows the query results based on the sorting code the addresses have.
     * ---
     * ```php
     * // fetch addresses by sorting code
     * $addresses = \craft\elements\Address::find()
     *     ->sortingCode('ABCD')
     *     ->all();
     * ```
     * ```twig
     * {# fetch addresses by sorting code #}
     * {% set addresses = craft.addresses()
     *   .sortingCode('ABCD')
     *   .all() %}
     * ```
     * @used-by sortingCode()
     * @since 5.0.0
     */
    public ?string $sortingCode = null;

    /**
     * @var string|null Narrows the query results based on the organization the addresses have.
     * ---
     * ```php
     * // fetch addresses by organization
     * $addresses = \craft\elements\Address::find()
     *     ->organization('Pixel & Tonic')
     *     ->all();
     * ```
     * ```twig
     * {# fetch addresses by organization #}
     * {% set addresses = craft.addresses()
     *   .organization('Pixel & Tonic')
     *   .all() %}
     * ```
     * @used-by organization()
     * @since 5.0.0
     */
    public ?string $organization = null;

    /**
     * @var string|null Narrows the query results based on the tax ID the addresses have.
     * ---
     * ```php
     * // fetch addresses by organization tax ID
     * $addresses = \craft\elements\Address::find()
     *     ->organizationTaxId('123-456-789')
     *     ->all();
     * ```
     * ```twig
     * {# fetch addresses by organization tax ID #}
     * {% set addresses = craft.addresses()
     *   .organizationTaxId('123-456-789')
     *   .all() %}
     * ```
     * @used-by organizationTaxId()
     * @since 5.0.0
     */
    public ?string $organizationTaxId = null;


    /**
     * @var string|null Narrows the query results based on the first address line the addresses have.
     * ---
     * ```php
     * // fetch addresses by address line 1
     * $addresses = \craft\elements\Address::find()
     *     ->addressLine1('23 Craft st')
     *     ->all();
     * ```
     * ```twig
     * {# fetch addresses by address line 1 #}
     * {% set addresses = craft.addresses()
     *   .addressLine1('23 Craft st')
     *   .all() %}
     * ```
     * @used-by addressLine1()
     * @since 5.0.0
     */
    public ?string $addressLine1 = null;

    /**
     * @var string|null Narrows the query results based on the second address line the addresses have.
     * ---
     * ```php
     * // fetch addresses by address line 2
     * $addresses = \craft\elements\Address::find()
     *     ->addressLine2('Apt 5B')
     *     ->all();
     * ```
     * ```twig
     * {# fetch addresses by address line 2 #}
     * {% set addresses = craft.addresses()
     *   .addressLine2('Apt 5B')
     *   .all() %}
     * ```
     * @used-by addressLine2()
     * @since 5.0.0
     */
    public ?string $addressLine2 = null;

    /**
     * @var string|null Narrows the query results based on the third address line the addresses have.
     * ---
     * ```php
     * // fetch addresses by address line 3
     * $addresses = \craft\elements\Address::find()
     *     ->addressLine3('Suite 212')
     *     ->all();
     * ```
     * ```twig
     * {# fetch addresses by address line 3 #}
     * {% set addresses = craft.addresses()
     *   .addressLine3('Suite 212')
     *   .all() %}
     * ```
     * @used-by addressLine3()
     * @since 5.0.0
     */
    public ?string $addressLine3 = null;

    /**
     * @var string|null Narrows the query results based on the full name the addresses have.
     * ---
     * ```php
     * // fetch addresses by full name
     * $addresses = \craft\elements\Address::find()
     *     ->fullName('John Doe')
     *     ->all();
     * ```
     * ```twig
     * {# fetch addresses by full name #}
     * {% set addresses = craft.addresses()
     *   .fullName('John Doe')
     *   .all() %}
     * ```
     * @used-by fullName()
     * @since 5.0.0
     */
    public ?string $fullName = null;

    /**
     * @var string|null Narrows the query results based on the first name the addresses have.
     * ---
     * ```php
     * // fetch addresses by first name
     * $addresses = \craft\elements\Address::find()
     *     ->firstName('Doe')
     *     ->all();
     * ```
     * ```twig
     * {# fetch addresses by first name #}
     * {% set addresses = craft.addresses()
     *   .firstName('Doe')
     *   .all() %}
     * ```
     * @used-by firstName()
     * @since 5.0.0
     */
    public ?string $firstName = null;

    /**
     * @var string|null Narrows the query results based on the last name the addresses have.
     * ---
     * ```php
     * // fetch addresses by last name
     * $addresses = \craft\elements\Address::find()
     *     ->lastName('Doe')
     *     ->all();
     * ```
     * ```twig
     * {# fetch addresses by last name #}
     * {% set addresses = craft.addresses()
     *   .lastName('Doe')
     *   .all() %}
     * ```
     * @used-by lastName()
     * @since 5.0.0
     */
    public ?string $lastName = null;

    /**
     * @var null|array Narrows the query results based on the distance to a set of coordinates.
     *                 ---
     *                 ```php
     *                 // Fetch addresses by distance to the given coordinates
     *                 $addresses = \craft\elements\Address::find()
     *                 ->distanceTo(['latitude' => 44.0473,'longitude' => -121.3338])
     *                 ->all();
     *                 ```
     *                 ```twig
     *                 {# Fetch addresses by distance to the given coordinates #}
     *                 {% set addresses = craft.addresses()
     *                 .distanceTo({ latitude: 44.0473, longitude: -121.3338 })
     *                 .all() %}
     *                 ```
     *
     * @used-by distanceTo()
     */
    public ?array $distanceTo = null;

    /**
     * Narrows the query results based on the country the addresses belong to.
     *
     * Possible values include:
     *
     * | Value | Fetches addresses…
     * | - | -
     * | `'AU'` | with a countryCode of `AU`.
     * | `'not US'` | not in a countryCode of `US`.
     * | `['AU', 'US']` | in a countryCode of `AU` or `US`.
     * | `['not', 'AU', 'US']` | not in a countryCode of `AU` or `US`.
     *
     * ---
     *
     * ```twig
     * {# Fetch Australian addresses #}
     * {% set {elements-var} = {twig-method}
     *   .countryCode('AU')
     *   .all() %}
     * ```
     *
     * ```php
     * // Fetch Australian addresses
     * ${elements-var} = {php-method}
     *     ->countryCode('AU')
     *     ->all();
     * ```
     *
     * @param string|string[]|null $value The property value
     * @return static self reference
     * @uses $countryCode
     */
    public function countryCode(array|string|null $value): static
    {
        $this->countryCode = $value;

        return $this;
    }

    /**
     * Narrows the query results based on the administrative areas the addresses belongs to.
     *
     * Possible values include:
     *
     * | Value | Fetches addresses…
     * | - | -
     * | `'WA'` | with a administrative area of `WA`.
     * | `'not WA'` | not in a administrative area of `WA`.
     * | `['WA', 'SA']` | in a administrative area of `WA` or `SA`.
     * | `['not', 'WA', 'SA']` | not in a administrative area of `WA` or `SA`.
     *
     * ---
     *
     * ```twig
     * {# Fetch addresses in Western Australia #}
     * {% set {elements-var} = {twig-method}
     *   .administrativeArea('WA')
     *   .all() %}
     * ```
     *
     * ```php
     * // Fetch addresses in Western Australia
     * ${elements-var} = {php-method}
     *     ->administrativeArea('WA')
     *     ->all();
     * ```
     *
     * @param string|string[]|null $value The property value
     * @return static self reference
     * @uses $administrativeArea
     * @since 5.0.0
     */
    public function administrativeArea(array|string|null $value): static
    {
        $this->administrativeArea = $value;

        return $this;
    }

    /**
     * Narrows the query results based on the locality the addresses belong to.
     *
     * Possible values include:
     *
     * | Value | Fetches addresses…
     * | - | -
     * | `'Perth'` | with a locality of `Perth`.
     * | `'*Perth*'` | with a locality containing `Perth`.
     * | `'Ner*'` | with a locality beginning with `Per`.
     *
     * ---
     *
     * ```twig
     * {# Fetch addresses in Perth #}
     * {% set {elements-var} = {twig-method}
     *   .locality('Perth')
     *   .all() %}
     * ```
     *
     * ```php
     * // Fetch addresses in Perth
     * ${elements-var} = {php-method}
     *     ->locality('Perth')
     *     ->all();
     * ```
     *
     * @param string|null $value The property value
     * @return static self reference
     * @uses $locality
     * @since 5.0.0
     */
    public function locality(?string $value): static
    {
        $this->locality = $value;

        return $this;
    }

    /**
     * Narrows the query results based on the dependent locality the addresses belong to.
     *
     * Possible values include:
     *
     * | Value | Fetches addresses…
     * | - | -
     * | `'Darlington'` | with a dependentLocality of `Darlington`.
     * | `'*Darling*'` | with a dependentLocality containing `Darling`.
     * | `'Dar*'` | with a dependentLocality beginning with `Dar`.
     *
     * ---
     *
     * ```twig
     * {# Fetch addresses in Darlington #}
     * {% set {elements-var} = {twig-method}
     *   .dependentLocality('Darlington')
     *   .all() %}
     * ```
     *
     * ```php
     * // Fetch addresses in Darlington
     * ${elements-var} = {php-method}
     *     ->dependentLocality('Darlington')
     *     ->all();
     * ```
     *
     * @param string|null $value The property value
     * @return static self reference
     * @uses $dependentLocality
     * @since 5.0.0
     */
    public function dependentLocality(?string $value): static
    {
        $this->dependentLocality = $value;

        return $this;
    }

    /**
     * Narrows the query results based on the postal code the addresses belong to.
     *
     * Possible values include:
     *
     * | Value | Fetches addresses…
     * | - | -
     * | `'10001'` | with a postalCode of `10001`.
     * | `'*001*'` | with a postalCode containing `001`.
     * | `'100*'` | with a postalCode beginning with `100`.
     *
     * ---
     *
     * ```twig
     * {# Fetch addresses with postal code 10001 #}
     * {% set {elements-var} = {twig-method}
     *   .postalCode('10001')
     *   .all() %}
     * ```
     *
     * ```php
     * // Fetch addresses with postal code 10001
     * ${elements-var} = {php-method}
     *     ->postalCode('10001')
     *     ->all();
     * ```
     *
     * @param string|null $value The property value
     * @return static self reference
     * @uses $postalCode
     * @since 5.0.0
     */
    public function postalCode(?string $value): static
    {
        $this->postalCode = $value;

        return $this;
    }

    /**
     * Narrows the query results based on the sorting code the addresses have.
     *
     * Possible values include:
     *
     * | Value | Fetches addresses…
     * | - | -
     * | `'ABCD'` | with a sortingCode of `ABCD`.
     * | `'*BC*'` | with a sortingCode containing `BC`.
     * | `'AB*'` | with a sortingCode beginning with `AB`.
     *
     * ---
     *
     * ```twig
     * {# Fetch addresses with sorting code ABCD #}
     * {% set {elements-var} = {twig-method}
     *   .sortingCode('ABCD')
     *   .all() %}
     * ```
     *
     * ```php
     * // Fetch addresses with sorting code ABCD
     * ${elements-var} = {php-method}
     *     ->sortingCode('ABCD')
     *     ->all();
     * ```
     *
     * @param string|null $value The property value
     * @return static self reference
     * @uses $sortingCode
     * @since 5.0.0
     */
    public function sortingCode(?string $value): static
    {
        $this->sortingCode = $value;

        return $this;
    }

    /**
     * Narrows the query results based on the organization the addresses have.
     *
     * Possible values include:
     *
     * | Value | Fetches addresses…
     * | - | -
     * | `'Pixel & Tonic'` | with an organization of `Pixel & Tonic`.
     * | `'*Pixel*'` | with an organization containing `Pixel`.
     * | `'Pixel*'` | with an organization beginning with `Pixel`.
     *
     * ---
     *
     * ```twig
     * {# Fetch addresses for Pixel & Tonic #}
     * {% set {elements-var} = {twig-method}
     *   .organization('Pixel & Tonic')
     *   .all() %}
     * ```
     *
     * ```php
     * // Fetch addresses for Pixel & Tonic
     * ${elements-var} = {php-method}
     *     ->organization('Pixel & Tonic')
     *     ->all();
     * ```
     *
     * @param string|null $value The property value
     * @return static self reference
     * @uses $organization
     * @since 5.0.0
     */
    public function organization(?string $value): static
    {
        $this->organization = $value;

        return $this;
    }

    /**
     * Narrows the query results based on the tax ID the addresses have.
     *
     * Possible values include:
     *
     * | Value | Fetches addresses…
     * | - | -
     * | `'123-456-789'` | with an organizationTaxId of `123-456-789`.
     * | `'*456*'` | with an organizationTaxId containing `456`.
     * | `'123*'` | with an organizationTaxId beginning with `123`.
     *
     * ---
     *
     * ```twig
     * {# Fetch addresses with tax ID 123-456-789 #}
     * {% set {elements-var} = {twig-method}
     *   .organizationTaxId('123-456-789')
     *   .all() %}
     * ```
     *
     * ```php
     * // Fetch addresses with tax ID 123-456-789
     * ${elements-var} = {php-method}
     *     ->organizationTaxId('123-456-789')
     *     ->all();
     * ```
     *
     * @param string $value The property value
     * @return static self reference
     * @uses $organizationTaxId
     * @since 5.0.0
     */
    public function organizationTaxId(string $value): static
    {
        $this->organizationTaxId = $value;

        return $this;
    }

    /**
     * Narrows the query results based on the first address line the addresses have.
     *
     * Possible values include:
     *
     * | Value | Fetches addresses…
     * | - | -
     * | `'23 Craft st'` | with a addressLine1 of `23 Craft st`.
     * | `'*23*'` | with a addressLine1 containing `23`.
     * | `'23*'` | with a addressLine1 beginning with `23`.
     *
     * ---
     *
     * ```twig
     * {# Fetch addresses at 23 Craft st #}
     * {% set {elements-var} = {twig-method}
     *   .addressLine1('23 Craft st')
     *   .all() %}
     * ```
     *
     * ```php
     * // Fetch addresses at 23 Craft st
     * ${elements-var} = {php-method}
     *     ->addressLine1('23 Craft st')
     *     ->all();
     * ```
     *
     * @param string|null $value The property value
     * @return static self reference
     * @uses $addressLine1
     * @since 5.0.0
     */
    public function addressLine1(?string $value): static
    {
        $this->addressLine1 = $value;

        return $this;
    }

    /**
     * Narrows the query results based on the second address line the addresses have.
     *
     * Possible values include:
     *
     * | Value | Fetches addresses…
     * | - | -
     * | `'Apt 5B'` | with an addressLine2 of `Apt 5B`.
     * | `'*5B*'` | with an addressLine2 containing `5B`.
     * | `'5B*'` | with an addressLine2 beginning with `5B`.
     *
     * ---
     *
     * ```twig
     * {# Fetch addresses at Apt 5B #}
     * {% set {elements-var} = {twig-method}
     *   .addressLine2('Apt 5B')
     *   .all() %}
     * ```
     *
     * ```php
     * // Fetch addresses at Apt 5B
     * ${elements-var} = {php-method}
     *     ->addressLine2('Apt 5B')
     *     ->all();
     * ```
     *
     * @param string|null $value The property value
     * @return static self reference
     * @uses $addressLine2
     * @since 5.0.0
     */
    public function addressLine2(?string $value): static
    {
        $this->addressLine2 = $value;

        return $this;
    }

    /**
     * Narrows the query results based on the third address line the addresses have.
     *
     * Possible values include:
     *
     * | Value | Fetches addresses…
     * | - | -
     * | `'Suite 212'` | with an addressLine3 of `Suite 212`.
     * | `'*Suite*'` | with an addressLine3 containing `Suite`.
     * | `'Suite*'` | with an addressLine3 beginning with `Suite`.
     *
     * ---
     *
     * ```twig
     * {# Fetch addresses at Suite 212 #}
     * {% set {elements-var} = {twig-method}
     *   .addressLine3('Suite 212')
     *   .all() %}
     * ```
     *
     * ```php
     * // Fetch addresses at Suite 212
     * ${elements-var} = {php-method}
     *     ->addressLine3('Suite 212')
     *     ->all();
     * ```
     *
     * @param string|null $value The property value
     * @return static self reference
     * @uses $addressLine3
     * @since 5.0.0
     */
    public function addressLine3(?string $value): static
    {
        $this->addressLine3 = $value;

        return $this;
    }

    /**
     * Narrows the query results based on the full name the addresses have.
     *
     * Possible values include:
     *
     * | Value | Fetches addresses…
     * | - | -
     * | `'John Doe'` | with a fullName of `John Doe`.
     * | `'*Doe*'` | with a fullName containing `Doe`.
     * | `'John*'` | with a fullName beginning with `John`.
     *
     * ---
     *
     * ```twig
     * {# Fetch addresses for John Doe #}
     * {% set {elements-var} = {twig-method}
     *   .fullName('John Doe')
     *   .all() %}
     * ```
     *
     * ```php
     * // Fetch addresses for John Doe
     * ${elements-var} = {php-method}
     *     ->fullName('John Doe')
     *     ->all();
     * ```
     *
     * @param string|null $value The property value
     * @return static self reference
     * @uses $fullName
     * @since 5.0.0
     */
    public function fullName(?string $value): static
    {
        $this->fullName = $value;

        return $this;
    }

    /**
     * Narrows the query results based on the first name the addresses have.
     *
     * Possible values include:
     *
     * | Value | Fetches addresses…
     * | - | -
     * | `'John'` | with a firstName of `John`.
     * | `'*Joh*'` | with a firstName containing `Joh`.
     * | `'Joh*'` | with a firstName beginning with `Joh`.
     *
     * ---
     *
     * ```twig
     * {# Fetch addresses with first name John #}
     * {% set {elements-var} = {twig-method}
     *   .firstName('John')
     *   .all() %}
     * ```
     *
     * ```php
     * // Fetch addresses with first name John
     * ${elements-var} = {php-method}
     *     ->firstName('John')
     *     ->all();
     * ```
     *
     * @param string|null $value The property value
     * @return static self reference
     * @uses $firstName
     * @since 5.0.0
     */
    public function firstName(?string $value): static
    {
        $this->firstName = $value;

        return $this;
    }

    /**
     * Narrows the query results based on the last name the addresses have.
     *
     * Possible values include:
     *
     * | Value | Fetches addresses…
     * | - | -
     * | `'Doe'` | with a lastName of `Doe`.
     * | `'*Do*'` | with a lastName containing `Do`.
     * | `'Do*'` | with a lastName beginning with `Do`.
     *
     * ---
     *
     * ```twig
     * {# Fetch addresses with last name Doe #}
     * {% set {elements-var} = {twig-method}
     *   .lastName('Doe')
     *   .all() %}
     * ```
     *
     * ```php
     * // Fetch addresses with last name Doe
     * ${elements-var} = {php-method}
     *     ->lastName('Doe')
     *     ->all();
     * ```
     *
     * @param string|null $value The property value
     * @return static self reference
     * @uses $lastName
     * @since 5.0.0
     */
    public function lastName(?string $value): static
    {
        $this->lastName = $value;

        return $this;
    }

    /**
     * Calculate the distance of the address to a given set of coordinates, and
     * optionally narrows the query results by minimum or maximum distance.
     * Excludes addresses without valid coordinates.
     *
     * The coordinates should be provided as an associative array with the following keys:
     *
     * | Key | Value
     * | - | -
     * | `latitude` | Required, the latitude of the point to measure distance to.
     * | `longitude` | Required, the longitude of the point to measure distance to.
     * | `min` | Minimum distance in meters to narrow results by.
     * | `max` | Maximum distance in meters to narrow results by.
     *
     * @return static self reference
     *
     * @uses $distanceTo
     */
    public function distanceTo(array $coordinates): static
    {
        $this->distanceTo = $coordinates;

        return $this;
    }

    /**
     * @inheritdoc
     */
    protected function beforePrepare(): bool
    {
        if (!parent::beforePrepare()) {
            return false;
        }

        $this->joinElementTable(Table::ADDRESSES);

        $this->query->addSelect([
            'addresses.id',
            'addresses.fieldId',
            'addresses.primaryOwnerId',
            'addresses.countryCode',
            'addresses.administrativeArea',
            'addresses.locality',
            'addresses.dependentLocality',
            'addresses.postalCode',
            'addresses.sortingCode',
            'addresses.addressLine1',
            'addresses.addressLine2',
            'addresses.addressLine3',
            'addresses.organization',
            'addresses.organizationTaxId',
            'addresses.fullName',
            'addresses.firstName',
            'addresses.lastName',
            'addresses.latitude',
            'addresses.longitude',
        ]);

        $this->normalizeNestedElementParams();

        // Only join the elements_owners table if fieldId is specified
        if (!empty($this->fieldId) && (!empty($this->ownerId) || !empty($this->primaryOwnerId))) {
            $this->applyNestedElementParams('addresses.fieldId', 'addresses.primaryOwnerId');
        } elseif (isset($this->primaryOwnerId) || isset($this->ownerId)) {
            // User addresses don't get rows in the elements_owners table
            if (!$this->primaryOwnerId && !$this->ownerId) {
                throw new QueryAbortedException();
            }
            $this->subQuery->andWhere(['addresses.primaryOwnerId' => $this->primaryOwnerId ?? $this->ownerId]);
        }

        if ($this->countryCode) {
            $this->subQuery->andWhere(Db::parseParam('addresses.countryCode', $this->countryCode));
        }

        if ($this->administrativeArea) {
            $this->subQuery->andWhere(Db::parseParam('addresses.administrativeArea', $this->administrativeArea));
        }

        if ($this->locality) {
            $this->subQuery->andWhere(Db::parseParam('addresses.locality', $this->locality));
        }

        if ($this->dependentLocality) {
            $this->subQuery->andWhere(Db::parseParam('addresses.dependentLocality', $this->dependentLocality));
        }

        if ($this->postalCode) {
            $this->subQuery->andWhere(Db::parseParam('addresses.postalCode', $this->postalCode));
        }

        if ($this->sortingCode) {
            $this->subQuery->andWhere(Db::parseParam('addresses.sortingCode', $this->sortingCode));
        }

        if ($this->organization) {
            $this->subQuery->andWhere(Db::parseParam('addresses.organization', $this->organization));
        }

        if ($this->organizationTaxId) {
            $this->subQuery->andWhere(Db::parseParam('addresses.organizationTaxId', $this->organizationTaxId));
        }

        if ($this->addressLine1) {
            $this->subQuery->andWhere(Db::parseParam('addresses.addressLine1', $this->addressLine1));
        }

        if ($this->addressLine2) {
            $this->subQuery->andWhere(Db::parseParam('addresses.addressLine2', $this->addressLine2));
        }

        if ($this->addressLine3) {
            $this->subQuery->andWhere(Db::parseParam('addresses.addressLine3', $this->addressLine3));
        }

        if ($this->lastName) {
            $this->subQuery->andWhere(Db::parseParam('addresses.lastName', $this->lastName));
        }

        if ($this->firstName) {
            $this->subQuery->andWhere(Db::parseParam('addresses.firstName', $this->firstName));
        }

        if ($this->fullName) {
            $this->subQuery->andWhere(Db::parseParam('addresses.fullName', $this->fullName));
        }

        if ($this->distanceTo) {
            $latitude = $this->distanceTo['latitude'];
            $longitude = $this->distanceTo['longitude'];
            $min = $this->distanceTo['min'] ?? null;
            $max = $this->distanceTo['max'] ?? null;

            $distance = new Expression(
                'ST_Distance_Sphere(
                    POINT([[addresses.longitude]], [[addresses.latitude]]),
                    POINT(:lng, :lat)
                )',
                [':lng' => $longitude, ':lat' => $latitude]
            );
            $this->subQuery->addSelect(['distance' => $distance]);
            $this->query->addSelect(['distance' => $distance]);

            $this->subQuery->andWhere(['not', ['[[addresses.latitude]]' => null]]);
            $this->subQuery->andWhere(['not', ['[[addresses.longitude]]' => null]]);

            if ($min) {
                $this->query->andWhere(['>=', $distance, $min]);
                $this->subQuery->andWhere(['>=', $distance, $min]);
            }

            if ($max) {
                $this->query->andWhere(['<=', $distance, $max]);
                $this->subQuery->andWhere(['<=', $distance, $max]);
            }
        }

        return true;
    }

    /**
     * @inheritdoc
     */
    protected function fieldLayouts(): array
    {
        return [
            Craft::$app->getAddresses()->getFieldLayout(),
        ];
    }
}