cs: Fix code style (safe rules only).

2025-08-21 07:03:49 +00:00 · 2021-11-23 14:06:38 +01:00
parent 149d7ce991
commit 8f96a1121d
1223 changed files with 65199 additions and 64625 deletions
--- a/src/Bundle/ChillMainBundle/Entity/Address.php
+++ b/src/Bundle/ChillMainBundle/Entity/Address.php
@@ -1,79 +1,36 @@
 <?php

+/**
+ * Chill is a software for social workers
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
 namespace Chill\MainBundle\Entity;

-use Doctrine\ORM\Mapping as ORM;
-use Symfony\Component\Validator\Context\ExecutionContextInterface;
-use Symfony\Component\Serializer\Annotation\Groups;
 use Chill\MainBundle\Doctrine\Model\Point;
 use Chill\ThirdPartyBundle\Entity\ThirdParty;
+use DateTime;
+use DateTimeInterface;
+use Doctrine\ORM\Mapping as ORM;
+use Symfony\Component\Serializer\Annotation\Groups;
+use Symfony\Component\Validator\Context\ExecutionContextInterface;

 /**
- * Address
+ * Address.
 *
 * @ORM\Entity
 * @ORM\Table(name="chill_main_address")
- * @ORM\HasLifecycleCallbacks()
+ * @ORM\HasLifecycleCallbacks
 */
 class Address
 {
    /**
-     * @var integer
-     *
-     * @ORM\Id
-     * @ORM\Column(name="id", type="integer")
-     * @ORM\GeneratedValue(strategy="AUTO")
+     * @ORM\ManyToOne(targetEntity=AddressReference::class)
     * @Groups({"write"})
     */
-    private $id;
-
-    /**
-     * @var string
-     *
-     * @ORM\Column(type="string", length=255)
-     * @Groups({"write"})
-     */
-    private $street = '';
-
-    /**
-     * @var string
-     *
-     * @ORM\Column(type="string", length=255)
-     * @Groups({"write"})
-     */
-    private $streetNumber = '';
-
-    /**
-     * @var PostalCode
-     *
-     * @ORM\ManyToOne(targetEntity="Chill\MainBundle\Entity\PostalCode")
-     * @Groups({"write"})
-     */
-    private $postcode;
-
-    /**
-     * @var string|null
-     *
-     * @ORM\Column(type="string", length=16, nullable=true)
-     * @Groups({"write"})
-     */
-    private $floor;
-
-    /**
-     * @var string|null
-     *
-     * @ORM\Column(type="string", length=16, nullable=true)
-     * @Groups({"write"})
-     */
-    private $corridor;
-
-    /**
-     * @var string|null
-     *
-     * @ORM\Column(type="string", length=16, nullable=true)
-     * @Groups({"write"})
-     */
-    private $steps;
+    private ?AddressReference $addressReference = null;

    /**
     * @var string|null
@@ -89,7 +46,14 @@ class Address
     * @ORM\Column(type="string", length=16, nullable=true)
     * @Groups({"write"})
     */
-    private $flat;
+    private $corridor;
+
+    /**
+     * A list of metadata, added by customizable fields.
+     *
+     * @var array
+     */
+    private $customs = [];

    /**
     * @var string|null
@@ -108,29 +72,34 @@ class Address
    private $extra;

    /**
-     * Indicates when the address starts validation. Used to build an history
-     * of address. By default, the current date.
+     * @var string|null
     *
-     * @var \DateTime
-     *
-     * @ORM\Column(type="date")
+     * @ORM\Column(type="string", length=16, nullable=true)
     * @Groups({"write"})
     */
-    private \DateTime $validFrom;
+    private $flat;

    /**
-     * Indicates when the address ends. Used to build an history
-     * of address.
+     * @var string|null
     *
-     * @var \DateTime|null
-     *
-     * @ORM\Column(type="date", nullable=true)
+     * @ORM\Column(type="string", length=16, nullable=true)
     * @Groups({"write"})
     */
-    private ?\DateTime $validTo = null;
+    private $floor;
+
+    /**
+     * @var int
+     *
+     * @ORM\Id
+     * @ORM\Column(name="id", type="integer")
+     * @ORM\GeneratedValue(strategy="AUTO")
+     * @Groups({"write"})
+     */
+    private $id;

    /**
     * True if the address is a "no address", aka homeless person, ...
+     *
     * @Groups({"write"})
     * @ORM\Column(type="boolean")
     *
@@ -139,17 +108,7 @@ class Address
    private $isNoAddress = false;

    /**
-     * A geospatial field storing the coordinates of the Address
-     *
-     * @var Point|null
-     *
-     * @ORM\Column(type="point", nullable=true)
-     * @Groups({"write"})
-     */
-    private $point;
-
-    /**
-     * A ThirdParty reference for person's addresses that are linked to a third party
+     * A ThirdParty reference for person's addresses that are linked to a third party.
     *
     * @var ThirdParty|null
     *
@@ -160,226 +119,71 @@ class Address
    private $linkedToThirdParty;

    /**
-     * A list of metadata, added by customizable fields
+     * A geospatial field storing the coordinates of the Address.
     *
-     * @var array
-     */
-    private $customs = [];
-
-    /**
-     * @ORM\ManyToOne(targetEntity=AddressReference::class)
+     * @var Point|null
+     *
+     * @ORM\Column(type="point", nullable=true)
     * @Groups({"write"})
     */
-    private ?AddressReference $addressReference = null;
+    private $point;
+
+    /**
+     * @var PostalCode
+     *
+     * @ORM\ManyToOne(targetEntity="Chill\MainBundle\Entity\PostalCode")
+     * @Groups({"write"})
+     */
+    private $postcode;
+
+    /**
+     * @var string|null
+     *
+     * @ORM\Column(type="string", length=16, nullable=true)
+     * @Groups({"write"})
+     */
+    private $steps;
+
+    /**
+     * @var string
+     *
+     * @ORM\Column(type="string", length=255)
+     * @Groups({"write"})
+     */
+    private $street = '';
+
+    /**
+     * @var string
+     *
+     * @ORM\Column(type="string", length=255)
+     * @Groups({"write"})
+     */
+    private $streetNumber = '';
+
+    /**
+     * Indicates when the address starts validation. Used to build an history
+     * of address. By default, the current date.
+     *
+     * @ORM\Column(type="date")
+     * @Groups({"write"})
+     */
+    private DateTime $validFrom;
+
+    /**
+     * Indicates when the address ends. Used to build an history
+     * of address.
+     *
+     * @ORM\Column(type="date", nullable=true)
+     * @Groups({"write"})
+     */
+    private ?DateTime $validTo = null;

    public function __construct()
    {
-        $this->validFrom = new \DateTime();
+        $this->validFrom = new DateTime();
    }

-    /**
-     * Get id
-     *
-     * @return integer
-     */
-    public function getId()
-    {
-        return $this->id;
-    }
-
-    /**
-     * Set streetAddress1 (legacy function)
-     *
-     * @param string $streetAddress1
-     *
-     * @return Address
-     */
-    public function setStreetAddress1($streetAddress1)
-    {
-        $this->street = $streetAddress1 === NULL ? '' : $streetAddress1;
-
-        return $this;
-    }
-
-    /**
-     * Get streetAddress1 (legacy function)
-     *
-     * @return string
-     */
-    public function getStreetAddress1()
-    {
-        return $this->street;
-    }
-
-    /**
-     * Set streetAddress2 (legacy function)
-     *
-     * @param string $streetAddress2
-     *
-     * @return Address
-     */
-    public function setStreetAddress2($streetAddress2)
-    {
-        $this->streetNumber = $streetAddress2 === NULL ? '' : $streetAddress2;
-
-        return $this;
-    }
-
-    /**
-     * Get streetAddress2 (legacy function)
-     *
-     * @return string
-     */
-    public function getStreetAddress2()
-    {
-        return $this->streetNumber;
-    }
-
-    /**
-     * Set postcode
-     *
-     * @param PostalCode $postcode
-     *
-     * @return Address
-     */
-    public function setPostcode(PostalCode $postcode = null)
-    {
-        $this->postcode = $postcode;
-
-        return $this;
-    }
-
-    /**
-     * Get postcode
-     *
-     * @return PostalCode
-     */
-    public function getPostcode()
-    {
-        return $this->postcode;
-    }
-
-    /**
-     * @return \DateTime
-     */
-    public function getValidFrom()
-    {
-        return $this->validFrom;
-    }
-
-    /**
-     * @param \DateTime $validFrom
-     * @return Address
-     */
-    public function setValidFrom(\DateTime $validFrom)
-    {
-        $this->validFrom = $validFrom;
-        return $this;
-    }
-
-    /**
-     * Get IsNoAddress
-     *
-     * Indicate true if the address is a fake address (homeless, ...)
-     *
-     * @return bool
-     */
-    public function getIsNoAddress(): bool
-    {
-        return $this->isNoAddress;
-    }
-
-    /**
-     * @return bool
-     */
-    public function isNoAddress(): bool
-    {
-        return $this->getIsNoAddress();
-    }
-
-    /**
-     * Set IsNoAddress
-     *
-     * Indicate true if the address is a fake address (homeless, ...)
-     *
-     * @param bool $isNoAddress
-     * @return $this
-     */
-    public function setIsNoAddress(bool $isNoAddress): self
-    {
-        $this->isNoAddress = $isNoAddress;
-        return $this;
-    }
-
-    /**
-     * Get customs informations in the address
-     *
-     * @return array
-     */
-    public function getCustoms(): array
-    {
-        return $this->customs;
-    }
-
-    /**
-     * Store custom informations in the address
-     *
-     * @param array $customs
-     * @return $this
-     */
-    public function setCustoms(array $customs): self
-    {
-        $this->customs = $customs;
-
-        return $this;
-    }
-
-    /**
-     * Validate the address.
-     *
-     * Check that:
-     *
-     * * if the address is not home address:
-     *     * the postal code is present
-     *     * the valid from is not null
-     *     * the address street 1 is greater than 2
-     *
-     * @param ExecutionContextInterface $context
-     * @param array $payload
-     */
-    public function validate(ExecutionContextInterface $context, $payload)
-    {
-        if (!$this->getValidFrom() instanceof \DateTime) {
-            $context
-                ->buildViolation("address.date-should-be-set")
-                ->atPath('validFrom')
-                ->addViolation();
-        }
-
-        if ($this->isNoAddress()) {
-            return;
-        }
-
-        if (empty($this->getStreetAddress1())) {
-            $context
-                ->buildViolation("address.street1-should-be-set")
-                ->atPath('streetAddress1')
-                ->addViolation();
-        }
-
-        if (!$this->getPostcode() instanceof PostalCode) {
-            $context
-                ->buildViolation("address.postcode-should-be-set")
-                ->atPath('postCode')
-                ->addViolation();
-        }
-    }
-
-    /**
-     * @param Address $original
-     * @return Address
-     */
-    public static function createFromAddress(Address $original) : Address
+    public static function createFromAddress(Address $original): Address
    {
        return (new Address())
            ->setAddressReference($original->getAddressReference())
@@ -398,8 +202,7 @@ class Address
            ->setStreet($original->getStreet())
            ->setStreetNumber($original->getStreetNumber())
            ->setValidFrom($original->getValidFrom())
-            ->setValidTo($original->getValidTo())
-            ;
+            ->setValidTo($original->getValidTo());
    }

    public static function createFromAddressReference(AddressReference $original): Address
@@ -409,44 +212,17 @@ class Address
            ->setPostcode($original->getPostcode())
            ->setStreet($original->getStreet())
            ->setStreetNumber($original->getStreetNumber())
-            ->setAddressReference($original)
-            ;
+            ->setAddressReference($original);
    }

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

-    public function setStreet(string $street): self
+    public function getBuildingName(): ?string
    {
-        $this->street = $street;
-
-        return $this;
-    }
-
-    public function getStreetNumber(): ?string
-    {
-        return $this->streetNumber;
-    }
-
-    public function setStreetNumber(string $streetNumber): self
-    {
-        $this->streetNumber = $streetNumber;
-
-        return $this;
-    }
-
-    public function getFloor(): ?string
-    {
-        return $this->floor;
-    }
-
-    public function setFloor(?string $floor): self
-    {
-        $this->floor = $floor;
-
-        return $this;
+        return $this->buildingName;
    }

    public function getCorridor(): ?string
@@ -454,11 +230,72 @@ class Address
        return $this->corridor;
    }

-    public function setCorridor(?string $corridor): self
+    /**
+     * Get customs informations in the address.
+     */
+    public function getCustoms(): array
    {
-        $this->corridor = $corridor;
+        return $this->customs;
+    }

-        return $this;
+    public function getDistribution(): ?string
+    {
+        return $this->distribution;
+    }
+
+    public function getExtra(): ?string
+    {
+        return $this->extra;
+    }
+
+    public function getFlat(): ?string
+    {
+        return $this->flat;
+    }
+
+    public function getFloor(): ?string
+    {
+        return $this->floor;
+    }
+
+    /**
+     * Get id.
+     *
+     * @return int
+     */
+    public function getId()
+    {
+        return $this->id;
+    }
+
+    /**
+     * Get IsNoAddress.
+     *
+     * Indicate true if the address is a fake address (homeless, ...)
+     */
+    public function getIsNoAddress(): bool
+    {
+        return $this->isNoAddress;
+    }
+
+    public function getLinkedToThirdParty()
+    {
+        return $this->linkedToThirdParty;
+    }
+
+    public function getPoint(): ?Point
+    {
+        return $this->point;
+    }
+
+    /**
+     * Get postcode.
+     *
+     * @return PostalCode
+     */
+    public function getPostcode()
+    {
+        return $this->postcode;
    }

    public function getSteps(): ?string
@@ -466,16 +303,59 @@ class Address
        return $this->steps;
    }

-    public function setSteps(?string $steps): self
+    public function getStreet(): ?string
    {
-        $this->steps = $steps;
-
-        return $this;
+        return $this->street;
    }

-    public function getBuildingName(): ?string
+    /**
+     * Get streetAddress1 (legacy function).
+     *
+     * @return string
+     */
+    public function getStreetAddress1()
    {
-        return $this->buildingName;
+        return $this->street;
+    }
+
+    /**
+     * Get streetAddress2 (legacy function).
+     *
+     * @return string
+     */
+    public function getStreetAddress2()
+    {
+        return $this->streetNumber;
+    }
+
+    public function getStreetNumber(): ?string
+    {
+        return $this->streetNumber;
+    }
+
+    /**
+     * @return DateTime
+     */
+    public function getValidFrom()
+    {
+        return $this->validFrom;
+    }
+
+    public function getValidTo(): ?DateTimeInterface
+    {
+        return $this->validTo;
+    }
+
+    public function isNoAddress(): bool
+    {
+        return $this->getIsNoAddress();
+    }
+
+    public function setAddressReference(?AddressReference $addressReference = null): Address
+    {
+        $this->addressReference = $addressReference;
+
+        return $this;
    }

    public function setBuildingName(?string $buildingName): self
@@ -485,21 +365,23 @@ class Address
        return $this;
    }

-    public function getFlat(): ?string
+    public function setCorridor(?string $corridor): self
    {
-        return $this->flat;
-    }
-
-    public function setFlat(?string $flat): self
-    {
-        $this->flat = $flat;
+        $this->corridor = $corridor;

        return $this;
    }

-    public function getDistribution(): ?string
+    /**
+     * Store custom informations in the address.
+     *
+     * @return $this
+     */
+    public function setCustoms(array $customs): self
    {
-        return $this->distribution;
+        $this->customs = $customs;
+
+        return $this;
    }

    public function setDistribution(?string $distribution): self
@@ -509,11 +391,6 @@ class Address
        return $this;
    }

-    public function getExtra(): ?string
-    {
-        return $this->extra;
-    }
-
    public function setExtra(?string $extra): self
    {
        $this->extra = $extra;
@@ -521,33 +398,32 @@ class Address
        return $this;
    }

-    public function getValidTo(): ?\DateTimeInterface
+    public function setFlat(?string $flat): self
    {
-        return $this->validTo;
-    }
-
-    public function setValidTo(?\DateTimeInterface $validTo = null): self
-    {
-        $this->validTo = $validTo;
+        $this->flat = $flat;

        return $this;
    }

-    public function getPoint(): ?Point
+    public function setFloor(?string $floor): self
    {
-        return $this->point;
-    }
-
-    public function setPoint(?Point $point): self
-    {
-        $this->point = $point;
+        $this->floor = $floor;

        return $this;
    }

-    public function getLinkedToThirdParty()
+    /**
+     * Set IsNoAddress.
+     *
+     * Indicate true if the address is a fake address (homeless, ...)
+     *
+     * @return $this
+     */
+    public function setIsNoAddress(bool $isNoAddress): self
    {
-        return $this->linkedToThirdParty;
+        $this->isNoAddress = $isNoAddress;
+
+        return $this;
    }

    public function setLinkedToThirdParty($linkedToThirdParty): self
@@ -557,22 +433,130 @@ class Address
        return $this;
    }

-    /**
-     * @return AddressReference|null
-     */
-    public function getAddressReference(): ?AddressReference
+    public function setPoint(?Point $point): self
    {
-        return $this->addressReference;
-    }
+        $this->point = $point;

-    /**
-     * @param AddressReference|null $addressReference
-     * @return Address
-     */
-    public function setAddressReference(?AddressReference $addressReference = null): Address
-    {
-        $this->addressReference = $addressReference;
        return $this;
    }
-}

+    /**
+     * Set postcode.
+     *
+     * @param PostalCode $postcode
+     *
+     * @return Address
+     */
+    public function setPostcode(?PostalCode $postcode = null)
+    {
+        $this->postcode = $postcode;
+
+        return $this;
+    }
+
+    public function setSteps(?string $steps): self
+    {
+        $this->steps = $steps;
+
+        return $this;
+    }
+
+    public function setStreet(string $street): self
+    {
+        $this->street = $street;
+
+        return $this;
+    }
+
+    /**
+     * Set streetAddress1 (legacy function).
+     *
+     * @param string $streetAddress1
+     *
+     * @return Address
+     */
+    public function setStreetAddress1($streetAddress1)
+    {
+        $this->street = null === $streetAddress1 ? '' : $streetAddress1;
+
+        return $this;
+    }
+
+    /**
+     * Set streetAddress2 (legacy function).
+     *
+     * @param string $streetAddress2
+     *
+     * @return Address
+     */
+    public function setStreetAddress2($streetAddress2)
+    {
+        $this->streetNumber = null === $streetAddress2 ? '' : $streetAddress2;
+
+        return $this;
+    }
+
+    public function setStreetNumber(string $streetNumber): self
+    {
+        $this->streetNumber = $streetNumber;
+
+        return $this;
+    }
+
+    /**
+     * @return Address
+     */
+    public function setValidFrom(DateTime $validFrom)
+    {
+        $this->validFrom = $validFrom;
+
+        return $this;
+    }
+
+    public function setValidTo(?DateTimeInterface $validTo = null): self
+    {
+        $this->validTo = $validTo;
+
+        return $this;
+    }
+
+    /**
+     * Validate the address.
+     *
+     * Check that:
+     *
+     * * if the address is not home address:
+     *     * the postal code is present
+     *     * the valid from is not null
+     *     * the address street 1 is greater than 2
+     *
+     * @param array $payload
+     */
+    public function validate(ExecutionContextInterface $context, $payload)
+    {
+        if (!$this->getValidFrom() instanceof DateTime) {
+            $context
+                ->buildViolation('address.date-should-be-set')
+                ->atPath('validFrom')
+                ->addViolation();
+        }
+
+        if ($this->isNoAddress()) {
+            return;
+        }
+
+        if (empty($this->getStreetAddress1())) {
+            $context
+                ->buildViolation('address.street1-should-be-set')
+                ->atPath('streetAddress1')
+                ->addViolation();
+        }
+
+        if (!$this->getPostcode() instanceof PostalCode) {
+            $context
+                ->buildViolation('address.postcode-should-be-set')
+                ->atPath('postCode')
+                ->addViolation();
+        }
+    }
+}