From 41b2630087ec026ee671b51ca778f24bccb71700 Mon Sep 17 00:00:00 2001 From: Hossein Azizabadi Farahani Date: Mon, 16 Dec 2024 09:01:51 +0330 Subject: [PATCH] Fix PHP docs --- src/Model/Account/Account.php | 3 + src/Model/Account/AccountProfile.php | 5 +- src/Model/Account/Credential.php | 2 +- src/Model/Account/Profile.php | 133 +++------------------------ src/Model/Permission/Resource.php | 2 +- src/Model/Permission/Role.php | 2 +- src/Model/Role/Account.php | 4 +- src/Model/Role/Resource.php | 4 +- 8 files changed, 25 insertions(+), 130 deletions(-) diff --git a/src/Model/Account/Account.php b/src/Model/Account/Account.php index 904f565..6be1eb2 100644 --- a/src/Model/Account/Account.php +++ b/src/Model/Account/Account.php @@ -91,6 +91,9 @@ public function getTimeCreated(): int|null return $this->time_created; } + /** + * @return int + */ public function getMultiFactorStatus(): int { return $this->multi_factor_status; diff --git a/src/Model/Account/AccountProfile.php b/src/Model/Account/AccountProfile.php index 08d594b..8f6d63c 100644 --- a/src/Model/Account/AccountProfile.php +++ b/src/Model/Account/AccountProfile.php @@ -115,7 +115,7 @@ public function getFirstName(): ?string } /** - * @return string + * @return string|null */ public function getLastName(): ?string { @@ -146,6 +146,9 @@ public function getAvatar(): ?string return $this->avatar; } + /** + * @return string|null + */ public function getInformation(): ?string { return $this->information; diff --git a/src/Model/Account/Credential.php b/src/Model/Account/Credential.php index 413e51f..cdf6718 100644 --- a/src/Model/Account/Credential.php +++ b/src/Model/Account/Credential.php @@ -26,7 +26,7 @@ public function getId(): ?int } /** - * @return string + * @return string|null */ public function getCredential(): string|null { diff --git a/src/Model/Account/Profile.php b/src/Model/Account/Profile.php index 5ba288e..13cb385 100644 --- a/src/Model/Account/Profile.php +++ b/src/Model/Account/Profile.php @@ -13,21 +13,6 @@ class Profile private mixed $birthdate; private mixed $gender; private mixed $avatar; - //private mixed $id_number; - //private mixed $ip_register; - //private mixed $register_source; - //private mixed $homepage; - //private mixed $phone; - //private mixed $address_1; - //private mixed $address_2; - //private mixed $item_id; - //private mixed $country; - //private mixed $state; - //private mixed $city; - //private mixed $zip_code; - //private mixed $bank_name; - //private mixed $bank_card; - //private mixed $bank_account; private mixed $information; public function __construct( @@ -37,21 +22,6 @@ public function __construct( $birthdate, $gender, $avatar, - //$id_number, - //$ip_register, - //$register_source, - //$homepage, - //$phone, - //$address_1, - //$address_2, - //$item_id, - //$country, - //$state, - //$city, - //$zip_code, - //$bank_name, - //$bank_card, - //$bank_account, $information, $id = null ) { @@ -61,37 +31,28 @@ public function __construct( $this->birthdate = $birthdate; $this->gender = $gender; $this->avatar = $avatar; - //$this->id_number = $id_number; - //$this->ip_register = $ip_register; - //$this->register_source = $register_source; - //$this->homepage = $homepage; - //$this->phone = $phone; - //$this->address_1 = $address_1; - //$this->address_2 = $address_2; - //$this->item_id = $item_id; - //$this->country = $country; - //$this->state = $state; - //$this->city = $city; - //$this->zip_code = $zip_code; - //$this->bank_name = $bank_name; - //$this->bank_card = $bank_card; - //$this->bank_account = $bank_account; $this->information = $information; $this->id = $id; } + /** + * @return int|null + */ public function getId(): ?int { return $this->id; } + /** + * @return int + */ public function getUserId(): int { return $this->user_id; } /** - * @return string + * @return string|null */ public function getFirstName(): ?string { @@ -99,7 +60,7 @@ public function getFirstName(): ?string } /** - * @return string + * @return string|null */ public function getLastName(): ?string { @@ -130,81 +91,9 @@ public function getAvatar(): ?string return $this->avatar; } - /* public function getIdNumber(): ?string - { - return $this->id_number; - } - - public function getIpRegister(): ?string - { - return $this->ip_register; - } - - public function getRegisterSource(): ?string - { - return $this->register_source; - } - - public function getHomepage(): ?string - { - return $this->homepage; - } - - public function getPhone(): ?string - { - return $this->phone; - } - - public function getAddress1(): ?string - { - return $this->address_1; - } - - public function getAddress2(): ?string - { - return $this->address_2; - } - - public function getItemId(): ?string - { - return $this->item_id; - } - - public function getCountry(): ?string - { - return $this->country; - } - - public function getState(): ?string - { - return $this->state; - } - - public function getCity(): ?string - { - return $this->city; - } - - public function getZipCode(): ?string - { - return $this->zip_code; - } - - public function getBankName(): ?string - { - return $this->bank_name; - } - - public function getBankCard(): ?string - { - return $this->bank_card; - } - - public function getBankAccount(): ?string - { - return $this->bank_account; - } */ - + /** + * @return string|null + */ public function getInformation(): ?string { return $this->information; diff --git a/src/Model/Permission/Resource.php b/src/Model/Permission/Resource.php index 6be7b6d..f1ec86d 100644 --- a/src/Model/Permission/Resource.php +++ b/src/Model/Permission/Resource.php @@ -6,7 +6,7 @@ class Resource { - private $id; + private mixed $id; private string $title; private string $section; private string $module; diff --git a/src/Model/Permission/Role.php b/src/Model/Permission/Role.php index d4424b4..4b0677d 100644 --- a/src/Model/Permission/Role.php +++ b/src/Model/Permission/Role.php @@ -6,7 +6,7 @@ class Role { - private $id; + private mixed $id; private string $resource; private string $section; private string $module; diff --git a/src/Model/Role/Account.php b/src/Model/Role/Account.php index a12a120..f558f8e 100644 --- a/src/Model/Role/Account.php +++ b/src/Model/Role/Account.php @@ -6,8 +6,8 @@ class Account { - private $id; - private ?int $user_id; + private mixed $id; + private ?int $user_id; private string $role; private string $section; diff --git a/src/Model/Role/Resource.php b/src/Model/Role/Resource.php index 4de09ea..6faf82b 100644 --- a/src/Model/Role/Resource.php +++ b/src/Model/Role/Resource.php @@ -6,11 +6,11 @@ class Resource { - private $id; + private mixed $id; private string $name; private string $title; private string $section; - private $status; + private mixed $status; public function __construct( $name,