Merge pull request #137 from NottingHack/Profile-fixes

Profile: add back in the return types now we have 7.1 ...

Author: roberthunt

app/HMS/Entities/Profile.php

@@ -12,37 +12,37 @@ class Profile
     /** @var User The user to which this profile belongs. */
     protected $user;
 
-    /** @var Carbon|null */
+    /** @var ?Carbon */
     protected $joinDate;
 
-    /** @var string */
+    /** @var ?string */
     protected $unlockText;
 
     /** @var int */
     protected $creditLimit;
 
-    /** @var string */
+    /** @var ?string */
     protected $address1;
 
-    /** @var string */
+    /** @var ?string */
     protected $address2;
 
-    /** @var string */
+    /** @var ?string */
     protected $address3;
 
-    /** @var string */
+    /** @var ?string */
     protected $addressCity;
 
-    /** @var string */
+    /** @var ?string */
     protected $addressCounty;
 
-    /** @var string */
+    /** @var ?string */
     protected $addressPostcode;
 
-    /** @var string */
+    /** @var ?string */
     protected $contactNumber;
 
-    /** @var Carbon|null */
+    /** @var ?Carbon */
     protected $dateOfBirth;
 
     /**
@@ -69,45 +69,45 @@ public function getUser() : User
      * @param User $user
      * @return self
      */
-    public function setUser(User $user)
+    public function setUser(User $user): Profile
     {
         $this->user = $user;
 
         return $this;
     }
 
     /**
-     * @return Carbon|null
+     * @return ?Carbon
      */
-    public function getJoinDate()
+    public function getJoinDate(): ?Carbon
     {
         return $this->joinDate;
     }
 
     /**
-     * @param Carbon $joinDate
+     * @param ?Carbon $joinDate
      * @return self
      */
-    public function setJoinDate(Carbon $joinDate)
+    public function setJoinDate(?Carbon $joinDate): Profile
     {
         $this->joinDate = $joinDate;
 
         return $this;
     }
 
     /**
-     * @return string
+     * @return ?string
      */
-    public function getUnlockText()
+    public function getUnlockText(): ?string
     {
         return $this->unlockText;
     }
 
     /**
-     * @param string $unlockText
+     * @param ?string $unlockText
      * @return self
      */
-    public function setUnlockText(string $unlockText)
+    public function setUnlockText(?string $unlockText): Profile
     {
         $this->unlockText = $unlockText;
 
@@ -126,26 +126,26 @@ public function getCreditLimit(): int
      * @param int $creditLimit
      * @return self
      */
-    public function setCreditLimit(int $creditLimit)
+    public function setCreditLimit(int $creditLimit): Profile
     {
         $this->creditLimit = $creditLimit;
 
         return $this;
     }
 
     /**
-     * @return string
+     * @return ?string
      */
-    public function getAddress1()
+    public function getAddress1(): ?string
     {
         return $this->address1;
     }
 
     /**
-     * @param string $address1
+     * @param ?string $address1
      * @return self
      */
-    public function setAddress1(string $address1)
+    public function setAddress1(?string $address1): Profile
     {
         $this->address1 = $address1;
 
@@ -155,7 +155,7 @@ public function setAddress1(string $address1)
     /**
      * @return string
      */
-    public function getAddress2()
+    public function getAddress2(): ?string
     {
         return $this->address2;
     }
@@ -164,7 +164,7 @@ public function getAddress2()
      * @param string $address2
      * @return self
      */
-    public function setAddress2(string $address2)
+    public function setAddress2(?string $address2): Profile
     {
         $this->address2 = $address2;
 
@@ -174,7 +174,7 @@ public function setAddress2(string $address2)
     /**
      * @return string
      */
-    public function getAddress3()
+    public function getAddress3(): ?string
     {
         return $this->address3;
     }
@@ -183,7 +183,7 @@ public function getAddress3()
      * @param string $address3
      * @return self
      */
-    public function setAddress3(string $address3)
+    public function setAddress3(?string $address3): Profile
     {
         $this->address3 = $address3;
 
@@ -193,7 +193,7 @@ public function setAddress3(string $address3)
     /**
      * @return string
      */
-    public function getAddressCity()
+    public function getAddressCity(): ?string
     {
         return $this->addressCity;
     }
@@ -202,7 +202,7 @@ public function getAddressCity()
      * @param string $addressCity
      * @return self
      */
-    public function setAddressCity(string $addressCity)
+    public function setAddressCity(?string $addressCity): Profile
     {
         $this->addressCity = $addressCity;
 
@@ -212,7 +212,7 @@ public function setAddressCity(string $addressCity)
     /**
      * @return string
      */
-    public function getAddressCounty()
+    public function getAddressCounty(): ?string
     {
         return $this->addressCounty;
     }
@@ -221,7 +221,7 @@ public function getAddressCounty()
      * @param string $addressCounty
      * @return self
      */
-    public function setAddressCounty(string $addressCounty)
+    public function setAddressCounty(?string $addressCounty): Profile
     {
         $this->addressCounty = $addressCounty;
 
@@ -231,7 +231,7 @@ public function setAddressCounty(string $addressCounty)
     /**
      * @return string
      */
-    public function getAddressPostcode()
+    public function getAddressPostcode(): ?string
     {
         return $this->addressPostcode;
     }
@@ -240,7 +240,7 @@ public function getAddressPostcode()
      * @param string $addressPostcode
      * @return self
      */
-    public function setAddressPostcode(string $addressPostcode)
+    public function setAddressPostcode(?string $addressPostcode): Profile
     {
         $this->addressPostcode = $addressPostcode;
 
@@ -250,35 +250,35 @@ public function setAddressPostcode(string $addressPostcode)
     /**
      * @return string
      */
-    public function getContactNumber()
+    public function getContactNumber(): ?string
     {
         return $this->contactNumber;
     }
 
     /**
-     * @param string $contactNumber
+     * @param ?string $contactNumber
      * @return self
      */
-    public function setContactNumber(string $contactNumber)
+    public function setContactNumber(?string $contactNumber): Profile
     {
         $this->contactNumber = $contactNumber;
 
         return $this;
     }
 
     /**
-     * @return Carbon|null
+     * @return ?Carbon
      */
-    public function getDateOfBirth()
+    public function getDateOfBirth(): ?Carbon
     {
         return Carbon::instance($this->dateOfBirth);
     }
 
     /**
-     * @param Carbon $dateOfBirth
+     * @param ?Carbon $dateOfBirth
      * @return self
      */
-    public function setDateOfBirth(Carbon $dateOfBirth)
+    public function setDateOfBirth(?Carbon $dateOfBirth): Profile
     {
         $this->dateOfBirth = $dateOfBirth;
 

app/HMS/User/ProfileManager.php

@@ -43,16 +43,16 @@ public function __construct(ProfileRepository $profileRepository, UserRepository
      * Bulk populate a user profile, used on registration.
      * @param User $user
      * @param string $address1
-     * @param string $address2
-     * @param string $address3
+     * @param ?string $address2
+     * @param ?string $address3
      * @param string $addressCity
      * @param string $addressCounty
      * @param string $addressPostcode
      * @param string $contactNumber
-     * @param string $dateOfBirth
+     * @param ?string $dateOfBirth
      * @return User
      */
-    public function create(User $user, string $address1, string $address2, string $address3, string $addressCity, string $addressCounty, string $addressPostcode, string $contactNumber, string $dateOfBirth)
+    public function create(User $user, string $address1, ?string $address2, ?string $address3, string $addressCity, string $addressCounty, string $addressPostcode, string $contactNumber, ?string $dateOfBirth): User
     {
         $profile = new Profile($user);