Enforce type checks for better code quality

Author: sibprogrammer

src/Api/Operator.php

@@ -27,7 +27,7 @@ public function __construct(Client $client)
      *
      * @return XmlResponse
      */
-    public function request($request, $mode = Client::RESPONSE_SHORT)
+    public function request($request, $mode = Client::RESPONSE_SHORT): XmlResponse
     {
         $wrapperTag = $this->wrapperTag;
 
@@ -69,9 +69,9 @@ protected function deleteBy(string $field, $value, string $deleteMethodName = 'd
      * @param int|string|null $value
      * @param callable|null $filter
      *
-     * @return mixed
+     * @return array
      */
-    protected function getItems($structClass, $infoTag, $field = null, $value = null, callable $filter = null)
+    protected function getItems($structClass, $infoTag, $field = null, $value = null, callable $filter = null): array
     {
         $packet = $this->client->getPacket();
         $getTag = $packet->addChild($this->wrapperTag)->addChild('get');

src/Api/Operator/Certificate.php

@@ -7,12 +7,7 @@
 
 class Certificate extends \PleskX\Api\Operator
 {
-    /**
-     * @param array $properties
-     *
-     * @return Struct\Info
-     */
-    public function generate($properties)
+    public function generate(array $properties): Struct\Info
     {
         $packet = $this->client->getPacket();
         $info = $packet->addChild($this->wrapperTag)->addChild('generate')->addChild('info');

src/Api/Operator/Customer.php

@@ -7,12 +7,7 @@
 
 class Customer extends \PleskX\Api\Operator
 {
-    /**
-     * @param array $properties
-     *
-     * @return Struct\Info
-     */
-    public function create($properties)
+    public function create(array $properties): Struct\Info
     {
         $packet = $this->client->getPacket();
         $info = $packet->addChild($this->wrapperTag)->addChild('add')->addChild('gen_info');
@@ -32,7 +27,7 @@ public function create($properties)
      *
      * @return bool
      */
-    public function delete($field, $value)
+    public function delete(string $field, $value): bool
     {
         return $this->deleteBy($field, $value);
     }
@@ -43,7 +38,7 @@ public function delete($field, $value)
      *
      * @return Struct\GeneralInfo
      */
-    public function get($field, $value)
+    public function get(string $field, $value): Struct\GeneralInfo
     {
         $items = $this->getItems(Struct\GeneralInfo::class, 'gen_info', $field, $value);
 
@@ -53,7 +48,7 @@ public function get($field, $value)
     /**
      * @return Struct\GeneralInfo[]
      */
-    public function getAll()
+    public function getAll(): array
     {
         return $this->getItems(Struct\GeneralInfo::class, 'gen_info');
     }

src/Api/Operator/Database.php

@@ -4,36 +4,21 @@
 namespace PleskX\Api\Operator;
 
 use PleskX\Api\Struct\Database as Struct;
+use PleskX\Api\XmlResponse;
 
 class Database extends \PleskX\Api\Operator
 {
-    /**
-     * @param array $properties
-     *
-     * @return Struct\Info
-     */
-    public function create($properties)
+    public function create(array $properties): Struct\Info
     {
         return new Struct\Info($this->process('add-db', $properties));
     }
 
-    /**
-     * @param array $properties
-     *
-     * @return Struct\UserInfo
-     */
-    public function createUser($properties)
+    public function createUser(array $properties): Struct\UserInfo
     {
         return new Struct\UserInfo($this->process('add-db-user', $properties));
     }
 
-    /**
-     * @param string $command
-     * @param array $properties
-     *
-     * @return \PleskX\Api\XmlResponse
-     */
-    private function process($command, array $properties)
+    private function process(string $command, array $properties): XmlResponse
     {
         $packet = $this->client->getPacket();
         $info = $packet->addChild($this->wrapperTag)->addChild($command);
@@ -49,12 +34,7 @@ private function process($command, array $properties)
         return $this->client->request($packet);
     }
 
-    /**
-     * @param array $properties
-     *
-     * @return bool
-     */
-    public function updateUser(array $properties)
+    public function updateUser(array $properties): bool
     {
         $response = $this->process('set-db-user', $properties);
 
@@ -67,7 +47,7 @@ public function updateUser(array $properties)
      *
      * @return Struct\Info
      */
-    public function get($field, $value)
+    public function get(string $field, $value): Struct\Info
     {
         $items = $this->getAll($field, $value);
 
@@ -80,7 +60,7 @@ public function get($field, $value)
      *
      * @return Struct\UserInfo
      */
-    public function getUser($field, $value)
+    public function getUser(string $field, $value): Struct\UserInfo
     {
         $items = $this->getAllUsers($field, $value);
 
@@ -93,7 +73,7 @@ public function getUser($field, $value)
      *
      * @return Struct\Info[]
      */
-    public function getAll($field, $value)
+    public function getAll(string $field, $value): array
     {
         $response = $this->getBy('get-db', $field, $value);
         $items = [];
@@ -110,7 +90,7 @@ public function getAll($field, $value)
      *
      * @return Struct\UserInfo[]
      */
-    public function getAllUsers($field, $value)
+    public function getAllUsers(string $field, $value): array
     {
         $response = $this->getBy('get-db-users', $field, $value);
         $items = [];
@@ -126,9 +106,9 @@ public function getAllUsers($field, $value)
      * @param string $field
      * @param int|string $value
      *
-     * @return \PleskX\Api\XmlResponse
+     * @return XmlResponse
      */
-    private function getBy(string $command, string $field, $value)
+    private function getBy(string $command, string $field, $value): XmlResponse
     {
         $packet = $this->client->getPacket();
         $getTag = $packet->addChild($this->wrapperTag)->addChild($command);
@@ -145,7 +125,7 @@ private function getBy(string $command, string $field, $value)
      *
      * @return bool
      */
-    public function delete($field, $value)
+    public function delete(string $field, $value): bool
     {
         return $this->deleteBy($field, $value, 'del-db');
     }
@@ -156,7 +136,7 @@ public function delete($field, $value)
      *
      * @return bool
      */
-    public function deleteUser($field, $value)
+    public function deleteUser(string $field, $value): bool
     {
         return $this->deleteBy($field, $value, 'del-db-user');
     }

src/Api/Operator/DatabaseServer.php

@@ -9,10 +9,7 @@ class DatabaseServer extends \PleskX\Api\Operator
 {
     protected string $wrapperTag = 'db_server';
 
-    /**
-     * @return array
-     */
-    public function getSupportedTypes()
+    public function getSupportedTypes(): array
     {
         $response = $this->request('get-supported-types');
 
@@ -25,7 +22,7 @@ public function getSupportedTypes()
      *
      * @return Struct\Info
      */
-    public function get(string $field, $value)
+    public function get(string $field, $value): Struct\Info
     {
         $items = $this->getBy($field, $value);
 
@@ -35,7 +32,7 @@ public function get(string $field, $value)
     /**
      * @return Struct\Info[]
      */
-    public function getAll()
+    public function getAll(): array
     {
         return $this->getBy();
     }
@@ -46,7 +43,7 @@ public function getAll()
      *
      * @return Struct\Info[]
      */
-    private function getBy($field = null, $value = null)
+    private function getBy($field = null, $value = null): array
     {
         $packet = $this->client->getPacket();
         $getTag = $packet->addChild($this->wrapperTag)->addChild('get');

src/Api/Operator/Dns.php

@@ -7,12 +7,7 @@
 
 class Dns extends \PleskX\Api\Operator
 {
-    /**
-     * @param array $properties
-     *
-     * @return Struct\Info
-     */
-    public function create($properties)
+    public function create(array $properties): Struct\Info
     {
         $packet = $this->client->getPacket();
         $info = $packet->addChild($this->wrapperTag)->addChild('add_rec');
@@ -58,7 +53,7 @@ public function bulkCreate(array $records): array
      *
      * @return Struct\Info
      */
-    public function get(string $field, $value)
+    public function get(string $field, $value): Struct\Info
     {
         $items = $this->getAll($field, $value);
 

src/Api/Operator/DnsTemplate.php

@@ -14,7 +14,7 @@ class DnsTemplate extends \PleskX\Api\Operator
      *
      * @return Struct\Info
      */
-    public function create(array $properties)
+    public function create(array $properties): Struct\Info
     {
         $packet = $this->client->getPacket();
         $info = $packet->addChild($this->wrapperTag)->addChild('add_rec');
@@ -31,9 +31,9 @@ public function create(array $properties)
      * @param string $field
      * @param int|string $value
      *
-     * @return Struct\Info|null
+     * @return Struct\Info
      */
-    public function get($field, $value)
+    public function get(string $field, $value): Struct\Info
     {
         $items = $this->getAll($field, $value);
 

src/Api/Operator/EventLog.php

@@ -12,7 +12,7 @@ class EventLog extends \PleskX\Api\Operator
     /**
      * @return Struct\Event[]
      */
-    public function get()
+    public function get(): array
     {
         $records = [];
         $response = $this->request('get');
@@ -27,7 +27,7 @@ public function get()
     /**
      * @return Struct\DetailedEvent[]
      */
-    public function getDetailedLog()
+    public function getDetailedLog(): array
     {
         $records = [];
         $response = $this->request('get_events');
@@ -39,10 +39,7 @@ public function getDetailedLog()
         return $records;
     }
 
-    /**
-     * @return int
-     */
-    public function getLastId()
+    public function getLastId(): int
     {
         return (int) $this->request('get-last-id')->getValue('id');
     }

src/Api/Operator/Ip.php

@@ -10,7 +10,7 @@ class Ip extends \PleskX\Api\Operator
     /**
      * @return Struct\Info[]
      */
-    public function get()
+    public function get(): array
     {
         $ips = [];
         $packet = $this->client->getPacket();

src/Api/Operator/Mail.php

@@ -9,15 +9,7 @@
 
 class Mail extends Operator
 {
-    /**
-     * @param string $name
-     * @param int $siteId
-     * @param bool $mailbox
-     * @param string $password
-     *
-     * @return Struct\Info
-     */
-    public function create($name, $siteId, $mailbox = false, $password = '')
+    public function create(string $name, int $siteId, bool $mailbox = false, string $password = ''): Struct\Info
     {
         $packet = $this->client->getPacket();
         $info = $packet->addChild($this->wrapperTag)->addChild('create');
@@ -45,7 +37,7 @@ public function create($name, $siteId, $mailbox = false, $password = '')
      *
      * @return bool
      */
-    public function delete(string $field, $value, $siteId): bool
+    public function delete(string $field, $value, int $siteId): bool
     {
         $packet = $this->client->getPacket();
         $filter = $packet->addChild($this->wrapperTag)->addChild('remove')->addChild('filter');
@@ -58,13 +50,7 @@ public function delete(string $field, $value, $siteId): bool
         return 'ok' === (string) $response->status;
     }
 
-    /**
-     * @param string $name
-     * @param int $siteId
-     *
-     * @return Struct\GeneralInfo
-     */
-    public function get($name, $siteId)
+    public function get(string $name, int $siteId): Struct\GeneralInfo
     {
         $items = $this->getAll($siteId, $name);
 
@@ -77,7 +63,7 @@ public function get($name, $siteId)
      *
      * @return Struct\GeneralInfo[]
      */
-    public function getAll($siteId, $name = null)
+    public function getAll(int $siteId, $name = null): array
     {
         $packet = $this->client->getPacket();
         $getTag = $packet->addChild($this->wrapperTag)->addChild('get_info');