Adding type safety

Author: bryan-ente

README.md

@@ -125,6 +125,10 @@ DDNS(new API(__DIR__ . "/configurations", ".env-custom"), file_get_contents("/my
 
 ## Changes
 
+### v1.1.4: Type safety
+
+- Added type safety to the `DDNS.Helper.API.dnsserver.ente.php` class
+
 ### v1.1.3: Shell safe
 
 - Library is now shell safe (you are now required to specify the path to the `.env` file)

composer.json

@@ -2,7 +2,7 @@
     "name": "ente/technitium-dnsserver-php-api",
     "type": "library",
     "license": "GPL-3.0-only",
-    "version": "1.1.3",
+    "version": "1.1.4",
     "description": "API client to interact with the Technitium DNS Server",
     "authors": [
         {

src/helper/DDNS.Helper.API.dnsserver.ente.php

@@ -4,9 +4,9 @@
 use Technitium\DNSServer\API\Helper\Log;
 
 class DDNS {
-    private $API;
+    private \Technitium\DNSServer\API\API $API;
 
-    public function __construct($api, $configFile = null){
+    public function __construct(\Technitium\DNSServer\API\API $api, string $configFile = null){
         $this->API = $api;
         if ($configFile != null) {
             $this->updateRecords($configFile);
@@ -15,10 +15,10 @@ public function __construct($api, $configFile = null){
 
     /**
      * `getPublicIP()` function is used to get the public IP address of the server.
-     * @param mixed $uri The URI to get the public IP address from. Currently, it is set to "https://ipecho.net/plain".
+     * @param string $uri The URI to get the public IP address from. Currently, it is set to "https://ipecho.net/plain".
      * @return string The public IP address of the server.
      */
-    public function getPublicIP($uri = "https://ipecho.net/plain") {
+    public function getPublicIP(string $uri = "https://ipecho.net/plain") {
         return trim(file_get_contents($uri));
     }
 
@@ -41,11 +41,11 @@ public function updateRecords(string $configFile) {
 
     /**
      * `processRecord()` function is used to process the record.
-     * @param mixed $record The record to be processed.
-     * @param mixed $domain The domain the record belongs to.
+     * @param string $record The record to be processed.
+     * @param string $domain The domain the record belongs to.
      * @return void Either adds or updates the record.
      */
-    private function processRecord($record, $domain) {
+    private function processRecord(string $record, string $domain) {
         try {
             $allrecords = $this->API->zones()->records()->get($record)["records"];
         } catch (\Throwable $th) {
@@ -77,12 +77,12 @@ private function processRecord($record, $domain) {
 
     /**
      * `updateRecord()` function is used to update the record.
-     * @param mixed $record The record to be updated.
-     * @param mixed $domain The domain the record belongs to.
-     * @param mixed $newIP The new IP address to be used.
+     * @param string $record The record to be updated.
+     * @param string $domain The domain the record belongs to.
+     * @param string $newIP The new IP address to be used.
      * @return void Updates the record.
      */
-    private function updateRecord($record, $domain, $newIP) {
+    private function updateRecord(string $record, string $domain, string $newIP) {
         if (!$this->API->zones()->records()->update([
             "domain" => $record,
             "type" => "A",
@@ -97,12 +97,12 @@ private function updateRecord($record, $domain, $newIP) {
 
     /**
      * `addRecord()` function is used to add the record.
-     * @param mixed $record The record to be added.
-     * @param mixed $domain The domain the record belongs to.
-     * @param mixed $ipAddress The IP address to be used.
+     * @param string $record The record to be added.
+     * @param string $domain The domain the record belongs to.
+     * @param string $ipAddress The IP address to be used.
      * @return void Adds the record.
      */
-    private function addRecord($record, $domain, $ipAddress) {
+    private function addRecord(string $record, string $domain, string $ipAddress) {
         if (!$this->API->zones()->records()->add([
             "domain" => $record,
             "type" => "A",