Covivo/mobicoop

View on GitHub
api/src/Geography/Entity/Address.php

Summary

Maintainability
C
1 day
Test Coverage
<?php

/**
 * Copyright (c) 2018, MOBICOOP. All rights reserved.
 * This project is dual licensed under AGPL and proprietary licence.
 ***************************
 *    This program is free software: you can redistribute it and/or modify
 *    it under the terms of the GNU Affero General Public License as
 *    published by the Free Software Foundation, either version 3 of the
 *    License, or (at your option) any later version.
 *
 *    This program is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *    GNU Affero General Public License for more details.
 *
 *    You should have received a copy of the GNU Affero General Public License
 *    along with this program.  If not, see <gnu.org/licenses>.
 ***************************
 *    Licence MOBICOOP described in the file
 *    LICENSE
 */

namespace App\Geography\Entity;

use ApiPlatform\Core\Annotation\ApiFilter;
use ApiPlatform\Core\Annotation\ApiProperty;
use ApiPlatform\Core\Annotation\ApiResource;
use ApiPlatform\Core\Bridge\Doctrine\Orm\Filter\OrderFilter;
use App\Carpool\Entity\Waypoint;
use App\Community\Entity\Community;
use App\Event\Entity\Event;
use App\Geography\Ressource\Point as RessourcePoint;
use App\Image\Entity\Icon;
use App\RelayPoint\Entity\RelayPoint;
use App\User\Entity\User;
use CrEOF\Spatial\PHP\Types\Geometry\Point;
use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\ORM\Mapping as ORM;
use Symfony\Component\Serializer\Annotation\Groups;
use Symfony\Component\Serializer\Annotation\MaxDepth;
use Symfony\Component\Validator\Constraints as Assert;

/**
 * A postal address (including textual informations and / or geometric coordinates).
 *
 * @ORM\Entity
 *
 * @ORM\Table(indexes={
 *
 *  @ORM\Index(name="IDX_LATITUDE_LONGITUDE", columns={"latitude", "longitude"}),
 *  @ORM\Index(name="FULL_TEXT_LOCALITY", columns={"address_locality"}, flags={"fulltext"})
 * })
 *
 * @ORM\HasLifecycleCallbacks
 *
 * @ApiResource(
 *      attributes={
 *          "force_eager"=false,
 *          "normalization_context"={"groups"={"read","pt","mass","search","readRelayPoint","readPayment"}, "enable_max_depth"="true"},
 *          "denormalization_context"={"groups"={"write", "writeSolidary"}}
 *      },
 *      collectionOperations={
 *          "search"={
 *              "method"="GET",
 *              "path"="/addresses/search",
 *              "swagger_context"={
 *                  "tags"={"Geography"},
 *                  "parameters"={
 *                     {
 *                         "name" = "q",
 *                         "in" = "query",
 *                         "required" = "true",
 *                         "type" = "string",
 *                         "description" = "The query"
 *                     },
 *                     {
 *                         "name" = "token",
 *                         "in" = "query",
 *                         "type" = "string",
 *                         "description" = "The geographic token authorization"
 *                     }
 *                  }
 *              }
 *          },
 *          "reverse"={
 *              "method"="GET",
 *              "path"="/addresses/reverse",
 *              "swagger_context"={
 *                  "tags"={"Geography"},
 *                  "parameters"={
 *                     {
 *                         "name" = "latitude",
 *                         "in" = "query",
 *                         "required" = "true",
 *                         "type" = "string",
 *                         "description" = "Latitude of the point"
 *                     },
 *                     {
 *                         "name" = "longitude",
 *                         "in" = "query",
 *                         "type" = "string",
 *                         "description" = "Longitude of the point"
 *                     }
 *                   }
 *              }
 *          },
 *          "completion"={
 *              "method"="GET",
 *              "path"="/addresses/completion",
 *              "security"="is_granted('import_create',object)",
 *              "swagger_context" = {
 *                  "tags"={"Geography"}
 *              }
 *          },
 *          "post"={
 *              "method"="POST",
 *              "path"="/address",
 *              "security"="is_granted('address_post',object)",
 *              "swagger_context" = {
 *                  "tags"={"Geography"}
 *              }
 *          },
 *          "ADMIN_search"={
 *              "method"="GET",
 *              "path"="/addresses/admin/search",
 *              "normalization_context"={"groups"={"aRead"}},
 *              "swagger_context" = {
 *                  "tags"={"Administration"}
 *              }
 *          },
 *      },
 *      itemOperations={
 *          "get"={
 *              "swagger_context" = {
 *                  "tags"={"Geography"}
 *              }
 *          },
 *          "put"={
 *              "security"="is_granted('address_update',object)",
 *              "swagger_context" = {
 *                  "tags"={"Geography"}
 *              }
 *          }
 *      }
 * )
 *
 * @ApiFilter(OrderFilter::class, properties={"id", "streetAddress", "postalCode", "addressLocality", "addressCountry"}, arguments={"orderParameterName"="order"})
 */
class Address implements \JsonSerializable
{
    public const DEFAULT_ID = 999999999999;
    public const HOME_ADDRESS = 'homeAddress';

    public const LAYER_LOCALITY = 1;
    public const LAYER_ADDRESS = 2;
    public const LAYER_LOCALADMIN = 3;

    /**
     * @var int the id of this address
     *
     * @ORM\Id
     *
     * @ORM\GeneratedValue
     *
     * @ORM\Column(type="integer")
     *
     * @Groups({"read", "readUser", "readEvent", "readRelayPoint","writePayment"})
     *
     * @ApiProperty(identifier=true)
     */
    private $id;

    /**
     * @var null|int the layer identified for the address
     *
     * @ORM\Column(type="integer", nullable=true)
     *
     * @Groups({"read","readUser","results","write","writeRelayPoint","pt","mass","massCompute","readCommunity"})
     */
    private $layer;

    /**
     * @var string the house number
     *
     * @ORM\Column(type="string", length=45, nullable=true)
     *
     * @Groups({"aRead", "aReadCol", "aReadItem", "aWrite", "read","readUser","readEvent","results","write","writeRelayPoint","pt","mass","massCompute","threads","thread","readRelayPoint", "writeSolidary","writePayment","readPayment","readCommunityAds"})
     */
    private $houseNumber;

    /**
     * @var string the street
     *
     * @ORM\Column(type="string", length=255, nullable=true)
     *
     * @Groups({"aRead", "aReadCol", "aReadItem", "aWrite", "read","readUser","readEvent","results","write","writeRelayPoint","pt","mass","massCompute","readRelayPoint", "writeSolidary","readPayment","readCommunityAds"})
     *
     * @Assert\NotBlank(groups={"massCompute","threads","thread"})
     */
    private $street;

    /**
     * @var string the full street address
     *
     * @ORM\Column(type="string", length=255, nullable=true)
     *
     * @Groups({"aRead", "aReadCol", "aReadItem", "aWrite", "read","readUser","readEvent","results","write","writeRelayPoint","pt","mass","massCompute","threads","thread","externalJourney","readRelayPoint", "writeSolidary", "readPayment", "writePayment","readCommunityAds"})
     */
    private $streetAddress;

    /**
     * @var null|string the postal code of the address
     *
     * @ORM\Column(type="string", length=15, nullable=true)
     *
     * @Groups({"aRead", "aReadCol", "aReadItem", "aWrite", "read","readUser","readEvent","results","write","writeRelayPoint","pt","mass","massCompute","externalJourney","readRelayPoint", "writeSolidary", "readPayment", "writePayment","readCommunityAds"})
     *
     * @Assert\NotBlank(groups={"massCompute","threads","thread"})
     */
    private $postalCode;

    /**
     * @var null|string the sublocality of the address
     *
     * @ORM\Column(type="string", length=100, nullable=true)
     *
     * @Groups({"aRead", "aReadCol", "aReadItem", "aWrite", "read","readUser","results","write","writeRelayPoint","pt","mass","massCompute","threads","thread","readRelayPoint", "writeSolidary"})
     */
    private $subLocality;

    /**
     * @var null|string the locality of the address
     *
     * @ORM\Column(type="string", length=100, nullable=true)
     *
     * @Groups({"aRead", "aReadCol", "aReadItem", "aWrite", "read","readUser","readEvent","results","write","writeRelayPoint","pt","mass","massCompute","threads","thread","externalJourney","readCommunity","readRelayPoint", "writeSolidary", "readPayment", "writePayment", "readExport","readCommunityAds","readEvent"})
     *
     * @Assert\NotBlank(groups={"massCompute","threads","thread"})
     */
    private $addressLocality;

    /**
     * @var null|string the locality admin of the address
     *
     * @ORM\Column(type="string", length=100, nullable=true)
     *
     * @Groups({"aRead", "aReadCol", "aReadItem", "aWrite", "read","readUser","results","write","writeRelayPoint","pt","mass","massCompute","threads","thread","readRelayPoint", "writeSolidary"})
     */
    private $localAdmin;

    /**
     * @var null|string the county of the address
     *
     * @ORM\Column(type="string", length=100, nullable=true)
     *
     * @Groups({"aRead", "aReadCol", "aReadItem", "aWrite", "read","readUser","results","write","writeRelayPoint","pt","mass","massCompute","threads","thread","readRelayPoint", "writeSolidary"})
     */
    private $county;

    /**
     * @var null|string the macro county of the address
     *
     * @ORM\Column(type="string", length=100, nullable=true)
     *
     * @Groups({"aRead", "aReadCol", "aReadItem", "aWrite", "read","readUser","results","write","writeRelayPoint","pt","mass","massCompute","threads","thread","readRelayPoint", "writeSolidary", "writePayment"})
     */
    private $macroCounty;

    /**
     * @var null|string the region of the address
     *
     * @ORM\Column(type="string", length=100, nullable=true)
     *
     * @Groups({"aRead", "aReadCol", "aReadItem", "aWrite", "read","readUser","readEvent","results","write","writeRelayPoint","pt","mass","massCompute","threads","thread","readRelayPoint", "writeSolidary", "readPayment", "writePayment"})
     */
    private $region;

    /**
     * @var null|string the macro region of the address
     *
     * @ORM\Column(type="string", length=100, nullable=true)
     *
     * @Groups({"aRead", "aReadCol", "aReadItem", "aWrite", "read","readUser","readEvent","results","write","writeRelayPoint","pt","mass","massCompute","threads","thread","readRelayPoint", "writeSolidary", "writePayment"})
     */
    private $macroRegion;

    /**
     * @var null|string the country of the address
     *
     * @ORM\Column(type="string", length=100, nullable=true)
     *
     * @Groups({"aRead", "aReadCol", "aReadItem", "aWrite", "read","readUser","readEvent","results","write","writeRelayPoint","pt","mass","massCompute","threads","thread","externalJourney","readRelayPoint", "writeSolidary", "writePayment","readCommunityAds"})
     */
    private $addressCountry;

    /**
     * @var null|string the country code of the address
     *
     * @ORM\Column(type="string", length=10, nullable=true)
     *
     * @Groups({"aRead", "aReadCol", "aReadItem", "aWrite", "read","readUser","readEvent","results","write","writeRelayPoint","pt","mass","massCompute","threads","thread","readRelayPoint", "writeSolidary", "readPayment", "writePayment","readCommunityAds"})
     */
    private $countryCode;

    /**
     * @var null|float the latitude of the address
     *
     * @ORM\Column(type="decimal", precision=10, scale=6, nullable=true)
     *
     * @Groups({"aRead", "aReadCol", "aReadItem", "aWrite", "read","readUser","readCommunity","readEvent","results","write","writeRelayPoint","pt","mass","massCompute","threads","thread","externalJourney","readRelayPoint", "writeSolidary","readCommunityAds","writePayment"})
     */
    private $latitude;

    /**
     * @var null|float the longitude of the address
     *
     * @ORM\Column(type="decimal", precision=10, scale=6, nullable=true)
     *
     * @Groups({"aRead", "aReadCol", "aReadItem", "aWrite", "read","readUser","readCommunity","readEvent","results","write","writeRelayPoint","pt","mass","massCompute","threads","thread","externalJourney","readRelayPoint", "writeSolidary","readCommunityAds","writePayment"})
     */
    private $longitude;

    /**
     * @var null|int the elevation of the address in metres
     *
     * @ORM\Column(type="integer", nullable=true)
     *
     * @Groups({"read","results","write","writeRelayPoint","pt","mass","massCompute","readRelayPoint"})
     */
    private $elevation;

    /**
     * @var null|string the geoJson point of the address
     *
     * @ORM\Column(type="point", nullable=true)
     *
     * @Groups({"read","write","writeRelayPoint","readEvent"})
     */
    private $geoJson;

    /**
     * @var null|string the name of this address
     *
     * @ORM\Column(type="string", length=255, nullable=true)
     *
     * @Groups({"aRead", "aReadCol", "aReadItem", "aWrite", "read","readUser","results","write","readRelayPoint","writeRelayPoint","readEvent"})
     */
    private $name;

    /**
     * @var null|string the venue name of this address
     *
     * @ORM\Column(type="string", length=255, nullable=true)
     *
     * @Groups({"read","readUser","readEvent","results","write","writeRelayPoint","readRelayPoint"})
     */
    private $venue;

    /**
     * @var null|User the owner of the address
     *
     * @ORM\ManyToOne(targetEntity="App\User\Entity\User", inversedBy="addresses")
     *
     * @ORM\JoinColumn(onDelete="CASCADE")
     */
    private $user;

    /**
     * @var bool the address is a home address
     *
     * @ORM\Column(type="boolean", nullable=true)
     *
     * @Groups({"aRead", "aReadCol", "aReadItem", "aWrite", "read","readUser","results","write","writeRelayPoint"})
     */
    private $home;

    /**
     * @var null|array Label for display
     *
     * @Groups({"aRead", "aReadCol", "aReadItem", "aWrite", "read","readUser","readCommunity","readEvent","results","pt","readRelayPoint", "readExport", "readCommunityAds"})
     */
    private $displayLabel;

    /**
     * @var null|RelayPoint the relaypoint related to the address
     *
     * @ORM\OneToOne(targetEntity="App\RelayPoint\Entity\RelayPoint", mappedBy="address")
     *
     * @Groups({"read","pt"})
     *
     * @MaxDepth(1)
     */
    private $relayPoint;

    /**
     * @var null|Event the event of the address
     *
     * @ORM\OneToOne(targetEntity="App\Event\Entity\Event", mappedBy="address")
     *
     * @Groups({"read","pt","readEvent","write","writeRelayPoint"})
     */
    private $event;

    /**
     * @var null|Community the community of the address
     *
     * @ORM\OneToOne(targetEntity="App\Community\Entity\Community", mappedBy="address")
     *
     * @Groups({"read"})
     */
    private $community;

    /**
     * @var null|Waypoint the waypoint of the address
     *
     * @ORM\OneToOne(targetEntity="App\Carpool\Entity\Waypoint", mappedBy="address")
     */
    private $waypoint;

    /**
     * @var \DateTimeInterface creation date
     *
     * @ORM\Column(type="datetime", nullable=true)
     *
     * @Groups({"read"})
     */
    private $createdDate;

    /**
     * @var \DateTimeInterface updated date
     *
     * @ORM\Column(type="datetime", nullable=true)
     *
     * @Groups({"read"})
     */
    private $updatedDate;

    /**
     * @var null|ArrayCollection the territories of this address
     *
     * @ORM\ManyToMany(targetEntity="\App\Geography\Entity\Territory")
     */
    private $territories;

    /**
     * @var null|string icon fileName
     *
     * @Groups({"aRead", "aReadCol", "aReadItem", "read","readRelayPoint"})
     */
    private $icon;

    /**
     * @var null|array the provider of the address
     *
     * @Groups({"read"})
     */
    private $providedBy;

    /**
     * @var null|int The similarity of the address with a search
     *               In autocomplete context using Levenstein algorithm between the search termes and the addressLocality
     *
     * @Groups({"read"})
     */
    private $similarityWithSearch;

    /**
     * @var null|array the distance to the focus point if relevant
     *
     * @Groups({"read"})
     */
    private $distance;

    /**
     * @var null|string the type of the address
     *
     * @Groups({"read","readUser","readEvent","aRead","readRelayPoint"})
     */
    private $type;

    /**
     * @var null|string the region code of the address
     *
     * @Groups({"read","readUser","readEvent","readRelayPoint","aRead"})
     */
    private $regionCode;

    public function __construct($id = null)
    {
        $this->id = self::DEFAULT_ID;
        if ($id) {
            $this->id = $id;
        }
        $this->displayLabel = new ArrayCollection();
        $this->territories = new ArrayCollection();
    }

    public function __clone()
    {
        // when we clone an Address we exclude the id
        $this->id = null;
        if (is_null($this->user)) {
            $this->setHome(null);
        }
        $this->territories = new ArrayCollection();
    }

    public function getId(): ?int
    {
        return $this->id;
    }

    public function setId($id)
    {
        $this->id = $id;
    }

    public function getLayer(): ?int
    {
        return $this->layer;
    }

    public function setLayer($layer)
    {
        $this->layer = $layer;
    }

    public function getHouseNumber(): ?string
    {
        return $this->houseNumber;
    }

    public function setHouseNumber(?string $houseNumber)
    {
        $this->houseNumber = $houseNumber;
    }

    public function getStreet(): ?string
    {
        return $this->street;
    }

    public function setStreet(?string $street)
    {
        $this->street = $street;
    }

    public function getStreetAddress(): ?string
    {
        return $this->streetAddress;
    }

    public function setStreetAddress(?string $streetAddress)
    {
        $this->streetAddress = $streetAddress;
    }

    public function getPostalCode(): ?string
    {
        return $this->postalCode;
    }

    public function setPostalCode(?string $postalCode)
    {
        $this->postalCode = $postalCode;
    }

    public function getSubLocality(): ?string
    {
        return $this->subLocality;
    }

    public function setSubLocality(?string $subLocality)
    {
        $this->subLocality = $subLocality;
    }

    public function getAddressLocality(): ?string
    {
        return $this->addressLocality;
    }

    public function setAddressLocality(?string $addressLocality)
    {
        $this->addressLocality = $addressLocality;
    }

    public function getLocalAdmin(): ?string
    {
        return $this->localAdmin;
    }

    public function setLocalAdmin(?string $localAdmin)
    {
        $this->localAdmin = $localAdmin;
    }

    public function getCounty(): ?string
    {
        return $this->county;
    }

    public function setCounty(?string $county)
    {
        $this->county = $county;
    }

    public function getMacroCounty(): ?string
    {
        return $this->macroCounty;
    }

    public function setMacroCounty(?string $macroCounty)
    {
        $this->macroCounty = $macroCounty;
    }

    public function getRegion(): ?string
    {
        return $this->region;
    }

    public function setRegion(?string $region)
    {
        $this->region = $region;
    }

    public function getMacroRegion(): ?string
    {
        return $this->macroRegion;
    }

    public function setMacroRegion(?string $macroRegion)
    {
        $this->macroRegion = $macroRegion;
    }

    public function getAddressCountry(): ?string
    {
        return $this->addressCountry;
    }

    public function setAddressCountry(?string $addressCountry)
    {
        $this->addressCountry = $addressCountry;
    }

    public function getCountryCode(): ?string
    {
        return $this->countryCode;
    }

    public function setCountryCode(?string $countryCode)
    {
        $this->countryCode = $countryCode;
    }

    public function getLatitude()
    {
        return $this->latitude;
    }

    public function setLatitude($latitude)
    {
        $this->latitude = $latitude;
    }

    public function getLongitude()
    {
        return $this->longitude;
    }

    public function setLongitude($longitude)
    {
        $this->longitude = $longitude;
    }

    public function getElevation(): ?int
    {
        return $this->elevation;
    }

    public function setElevation(?int $elevation)
    {
        $this->elevation = $elevation;
    }

    public function getGeoJson()
    {
        return $this->geoJson;
    }

    public function setGeoJson($geoJson): self
    {
        $this->geoJson = $geoJson;

        return $this;
    }

    public function getName(): ?string
    {
        return $this->name;
    }

    public function setName(?string $name)
    {
        $this->name = $name;
    }

    public function getVenue(): ?string
    {
        return $this->venue;
    }

    public function setVenue(?string $venue)
    {
        $this->venue = $venue;
    }

    public function getUser(): ?User
    {
        return $this->user;
    }

    public function setUser(?User $user)
    {
        if (!is_null($user)) {
            $user->setHomeAddress($this);
        }

        $this->user = $user;
    }

    public function isHome(): ?bool
    {
        return $this->home;
    }

    public function setHome(?bool $isHome): self
    {
        $this->home = $isHome;

        return $this;
    }

    public function getDisplayLabel()
    {
        return $this->displayLabel;
    }

    public function setDisplayLabel(?array $displayLabel)
    {
        $this->displayLabel = $displayLabel;
    }

    public function getRelayPoint(): ?RelayPoint
    {
        return $this->relayPoint;
    }

    public function setRelayPoint(?RelayPoint $relayPoint)
    {
        $this->relayPoint = $relayPoint;
    }

    public function getCreatedDate(): ?\DateTimeInterface
    {
        return $this->createdDate;
    }

    public function setCreatedDate(\DateTimeInterface $createdDate): self
    {
        $this->createdDate = $createdDate;

        return $this;
    }

    public function getUpdatedDate(): ?\DateTimeInterface
    {
        return $this->updatedDate;
    }

    public function setUpdatedDate(\DateTimeInterface $updatedDate): self
    {
        $this->updatedDate = $updatedDate;

        return $this;
    }

    public function getIcon(): ?string
    {
        return $this->icon;
    }

    public function setIcon(?string $icon)
    {
        $this->icon = $icon;

        return $this;
    }

    public function getSimilarityWithSearch(): ?int
    {
        return $this->similarityWithSearch;
    }

    public function setSimilarityWithSearch($similarityWithSearch)
    {
        $this->similarityWithSearch = $similarityWithSearch;
    }

    public function getProvidedBy(): ?string
    {
        return $this->providedBy;
    }

    public function setProvidedBy(?string $providedBy)
    {
        $this->providedBy = $providedBy;

        return $this;
    }

    public function getDistance(): ?float
    {
        return $this->distance;
    }

    public function setDistance(?float $distance)
    {
        $this->distance = $distance;

        return $this;
    }

    public function getEvent(): ?Event
    {
        return $this->event;
    }

    public function setEvent(?Event $event): self
    {
        $this->event = $event;

        return $this;
    }

    public function getCommunity(): ?Community
    {
        return $this->community;
    }

    public function setCommunity(?Community $community): self
    {
        $this->community = $community;

        return $this;
    }

    public function getWaypoint(): ?Waypoint
    {
        return $this->waypoint;
    }

    public function setWaypoint(?Waypoint $waypoint): self
    {
        $this->waypoint = $waypoint;

        return $this;
    }

    public function getTerritories()
    {
        return $this->territories->getValues();
    }

    public function addTerritory(Territory $territory): self
    {
        if (!$this->territories->contains($territory)) {
            $this->territories[] = $territory;
        }

        return $this;
    }

    public function removeTerritory(Territory $territory): self
    {
        if ($this->territories->contains($territory)) {
            $this->territories->removeElement($territory);
        }

        return $this;
    }

    public function removeTerritories(): self
    {
        $this->territories->clear();

        return $this;
    }

    public function getRegionCode()
    {
        switch (strtolower($this->countryCode)) {
            case 'fr':
                if ($this->postalCode && strlen($this->postalCode >= 5)) {
                    return substr($this->postalCode, 0, 2);
                }

                return null;

            default:
                return null;
        }
    }

    public function getType(): string
    {
        if (
            $this->venue
            && $this->name
            && $this->addressLocality) {
            return 'venue';
        }
        if (
            $this->event
            && $this->addressLocality) {
            return 'event';
        }
        if (
            $this->relayPoint
        ) {
            return 'relaypoint';
        }
        if (
            $this->houseNumber && (
                $this->street || $this->streetAddress
            )
            && $this->addressLocality) {
            return 'housenumber';
        }
        if (
            (
                $this->street || $this->streetAddress
            )
            && $this->addressLocality) {
            return 'street';
        }

        if (
            $this->user
            && $this->isHome()) {
            return 'user';
        }

        return 'locality';
    }

    // DOCTRINE EVENTS

    /**
     * Creation date.
     *
     * @ORM\PrePersist
     */
    public function setAutoCreatedDate()
    {
        $this->setCreatedDate(new \DateTime());
    }

    /**
     * Update date.
     *
     * @ORM\PreUpdate
     */
    public function setAutoUpdatedDate()
    {
        $this->setUpdatedDate(new \DateTime());
    }

    /**
     * GeoJson representation.
     *
     * @ORM\PrePersist
     *
     * @ORM\PreUpdate
     */
    public function setAutoGeoJson()
    {
        if (!is_null($this->getLatitude()) && !is_null($this->getLongitude())) {
            $this->setGeoJson(new Point($this->getLongitude(), $this->getLatitude()));
        }
    }

    /**
     * Check if the current address is the same than the one given as an array.
     * Note : the method checks only geographical data.
     *
     * @param array $compare The array thant contains the address to compare
     *
     * @return bool
     */
    public function isSame(array $compare, bool $replace = false)
    {
        if (isset($compare['streetAddress']) && $this->getStreetAddress() != $compare['streetAddress']) {
            return false;
        }
        if (isset($compare['postalCode']) && $this->getPostalCode() != $compare['postalCode']) {
            return false;
        }
        if (isset($compare['addressLocality']) && $this->getAddressLocality() != $compare['addressLocality']) {
            return false;
        }
        if (isset($compare['addressCountry']) && $this->getAddressCountry() != $compare['addressCountry']) {
            return false;
        }
        if (isset($compare['latitude']) && $this->getLatitude() != $compare['latitude']) {
            return false;
        }
        if (isset($compare['longitude']) && $this->getLongitude() != $compare['longitude']) {
            return false;
        }
        if (isset($compare['houseNumber']) && $this->getHouseNumber() != $compare['houseNumber']) {
            return false;
        }
        if (isset($compare['subLocality']) && $this->getSubLocality() != $compare['subLocality']) {
            return false;
        }
        if (isset($compare['localAdmin']) && $this->getLocalAdmin() != $compare['localAdmin']) {
            return false;
        }
        if (isset($compare['county']) && $this->getCounty() != $compare['county']) {
            return false;
        }
        if (isset($compare['macroCounty']) && $this->getMacroCounty() != $compare['macroCounty']) {
            return false;
        }
        if (isset($compare['region']) && $this->getRegion() != $compare['region']) {
            return false;
        }
        if (isset($compare['macroRegion']) && $this->getMacroRegion() != $compare['macroRegion']) {
            return false;
        }
        if (isset($compare['countryCode']) && $this->getCountryCode() != $compare['countryCode']) {
            return false;
        }

        return true;
    }

    /**
     * Replace elements of an address with the given array.
     *
     * @param array $fields The array thant contains the new address elements
     *
     * @return bool True if the address was updated
     */
    public function replaceBy(array $fields): bool
    {
        $updated = false;
        if (isset($fields['streetAddress']) && $this->getStreetAddress() != $fields['streetAddress']) {
            $updated = true;
            $this->setStreetAddress($fields['streetAddress']);
        }
        if (isset($fields['postalCode']) && $this->getPostalCode() != $fields['postalCode']) {
            $updated = true;
            $this->setPostalCode($fields['postalCode']);
        }
        if (isset($fields['addressLocality']) && $this->getAddressLocality() != $fields['addressLocality']) {
            $updated = true;
            $this->setAddressLocality($fields['addressLocality']);
        }
        if (isset($fields['addressCountry']) && $this->getAddressCountry() != $fields['addressCountry']) {
            $updated = true;
            $this->setAddressCountry($fields['addressCountry']);
        }
        if (isset($fields['latitude']) && $this->getLatitude() != $fields['latitude']) {
            $updated = true;
            $this->setLatitude($fields['latitude']);
        }
        if (isset($fields['longitude']) && $this->getLongitude() != $fields['longitude']) {
            $updated = true;
            $this->setLongitude($fields['longitude']);
        }
        if (isset($fields['houseNumber']) && $this->getHouseNumber() != $fields['houseNumber']) {
            $updated = true;
            $this->setHouseNumber($fields['houseNumber']);
        }
        if (isset($fields['subLocality']) && $this->getSubLocality() != $fields['subLocality']) {
            $updated = true;
            $this->setSubLocality($fields['subLocality']);
        }
        if (isset($fields['localAdmin']) && $this->getLocalAdmin() != $fields['localAdmin']) {
            $updated = true;
            $this->setLocalAdmin($fields['localAdmin']);
        }
        if (isset($fields['county']) && $this->getCounty() != $fields['county']) {
            $updated = true;
            $this->setCounty($fields['county']);
        }
        if (isset($fields['macroCounty']) && $this->getMacroCounty() != $fields['macroCounty']) {
            $updated = true;
            $this->setMacroCounty($fields['macroCounty']);
        }
        if (isset($fields['region']) && $this->getRegion() != $fields['region']) {
            $updated = true;
            $this->setRegion($fields['region']);
        }
        if (isset($fields['macroRegion']) && $this->getMacroRegion() != $fields['macroRegion']) {
            $updated = true;
            $this->setMacroRegion($fields['macroRegion']);
        }
        if (isset($fields['countryCode']) && $this->getCountryCode() != $fields['countryCode']) {
            $updated = true;
            $this->setCountryCode($fields['countryCode']);
        }

        return $updated;
    }

    public function createFromPoint(RessourcePoint $point): self
    {
        $this->setStreetAddress($point->getStreetName());
        $this->setPostalCode($point->getPostalCode());
        $this->setAddressLocality($point->getLocality());
        $this->setAddressCountry($point->getCountry());
        $this->setCountryCode($point->getCountryCode());
        $this->setLatitude($point->getLat());
        $this->setLongitude($point->getLon());
        $this->setRegion($point->getRegion());
        $this->setMacroRegion($point->getMacroRegion());
        $this->setGeoJson($this->setAutoGeoJson());

        return $this;
    }

    public function jsonSerialize()
    {
        return
            [
                'id' => $this->getId(),
                'houseNumber' => $this->getHouseNumber(),
                'street' => $this->getStreet(),
                'streetAddress' => $this->getStreetAddress(),
                'postalCode' => $this->getPostalCode(),
                'addressLocality' => $this->getAddressLocality(),
                'name' => $this->getName(),
                'addressCountry' => $this->getAddressCountry(),
                'countryCode' => $this->getCountryCode(),
                'county' => $this->getCounty(),
                'latitude' => $this->getLatitude(),
                'localAdmin' => $this->getLocalAdmin(),
                'longitude' => $this->getLongitude(),
                'macroCounty' => $this->getMacroCounty(),
                'macroRegion' => $this->getMacroRegion(),
                'region' => $this->getRegion(),
                'subLocality' => $this->getSubLocality(),
                'displayLabel' => $this->getDisplayLabel(),
                'home' => $this->isHome(),
                'icon' => $this->getIcon(),
                'venue' => $this->getVenue(),
                'event' => $this->getEvent(),
                'layer' => $this->getLayer(),
                'similarityWithSearch' => $this->getSimilarityWithSearch(),
                'type' => $this->getType(),
                'regionCode' => $this->getRegionCode(),
            ];
    }
}