Merge branch 'phpdoc-improvements' into 'master'

Improved php doc See merge request transip/restapi-php-library!161
transip · Dec 23, 2021 · 5d42430 · 5d42430
2 parents 8ded616 + 735d6eb
commit 5d42430
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 38 deletions.
diff --git a/src/Entity/OpenStackProject.php b/src/Entity/OpenStackProject.php
@@ -5,40 +5,37 @@
 class OpenStackProject extends AbstractEntity
 {
     /**
-     * @description Identifier
-     * @example `7a7a3bcb46c6450f95c53edb8dcebc7b`
-     * @type string
-     * @readonly
+     * Identifier
+     *
+     * @var string
      */
     protected $id;
 
     /**
-     * @description Name of the project
-     * @example `hosting101-datacenter`
-     * @type string
+     * Name of the project
+     *
+     * @var string
      */
     protected $name;
 
     /**
-     * @description Describes this project
-     * @example This is an example project
-     * @type string
+     * Describes this project
+     *
+     * @var string
      */
     protected $description;
 
     /**
-     * @description When an ongoing process blocks the project from being modified, this is set to `true`
-     * @example false
-     * @type boolean
-     * @readonly
+     * When an ongoing process blocks the project from being modified, this is set to `true`
+     *
+     * @var bool
      */
     protected $isLocked;
 
     /**
-     * @description Set to `true` when a project has been administratively blocked
-     * @example false
-     * @type boolean
-     * @readonly
+     * Set to `true` when a project has been administratively blocked
+     *
+     * @var bool
      */
     protected $isBlocked;
 
@@ -67,17 +64,11 @@ public function isBlocked(): bool
         return $this->isBlocked;
     }
 
-    /**
-     * @param string $name
-     */
     public function setName(string $name): void
     {
         $this->name = $name;
     }
 
-    /**
-     * @param string $description
-     */
     public function setDescription(string $description): void
     {
         $this->description = $description;

diff --git a/src/Entity/OpenStackUser.php b/src/Entity/OpenStackUser.php
@@ -14,24 +14,23 @@ class OpenStackUser extends AbstractEntity
     protected $id;
 
     /**
-     * @description Login name
-     * @example `hosting101-support`
-     * @readonly
-     * @type string
+     * Login name
+     *
+     * @var string
      */
     protected $username;
 
     /**
-     * @description Description
-     * @example `Supporter account`
-     * @type string
+     * Description
+     *
+     * @var string
      */
     protected $description;
 
     /**
-     * @description Email address
-     * @example `[email protected]`
-     * @type string
+     * Email address
+     *
+     * @var string
      */
     protected $email;
 

diff --git a/src/Repository/OpenStack/ProjectRepository.php b/src/Repository/OpenStack/ProjectRepository.php
@@ -9,7 +9,7 @@ class ProjectRepository extends ApiRepository
 {
     public const RESOURCE_NAME = 'openstack/projects';
 
-    public const RESOURCE_PARAMETER_SINGUlAR = 'project';
+    public const RESOURCE_PARAMETER_SINGULAR = 'project';
     public const RESOURCE_PARAMETER_PLURAL   = 'projects';
 
     protected function getRepositoryResourceNames(): array
@@ -49,7 +49,7 @@ public function create(string $name, string $description): void
     public function getByProjectId(string $projectId): OpenStackProject
     {
         $response  = $this->httpClient->get($this->getResourceUrl($projectId));
-        $projectArray = $this->getParameterFromResponse($response, self::RESOURCE_PARAMETER_SINGUlAR);
+        $projectArray = $this->getParameterFromResponse($response, self::RESOURCE_PARAMETER_SINGULAR);
 
         return new OpenStackProject($projectArray);
     }

diff --git a/src/Repository/OpenStack/UserRepository.php b/src/Repository/OpenStack/UserRepository.php
@@ -9,7 +9,7 @@ class UserRepository extends ApiRepository
 {
     public const RESOURCE_NAME = 'openstack/users';
 
-    public const RESOURCE_PARAMETER_SINGUlAR = 'user';
+    public const RESOURCE_PARAMETER_SINGULAR = 'user';
     public const RESOURCE_PARAMETER_PLURAL   = 'users';
 
     protected function getRepositoryResourceNames(): array
@@ -36,7 +36,7 @@ public function getAll(): array
     public function getByUserId(string $userId): OpenStackUser
     {
         $response  = $this->httpClient->get($this->getResourceUrl($userId));
-        $userArray = $this->getParameterFromResponse($response, self::RESOURCE_PARAMETER_SINGUlAR);
+        $userArray = $this->getParameterFromResponse($response, self::RESOURCE_PARAMETER_SINGULAR);
 
         return new OpenStackUser($userArray);
     }