Feature/php8 enhancements (#74)

* Add void return type. * Update to str_contains, and add mixed return types. * Add void return types. * Add mixed return type. * Add PHP 8 return types * PHP 8 updated. * Formatting * Add void types * Phpcs fixes. * Php8 updates
dwnload · Jun 23, 2023 · a3953d4 · a3953d4
1 parent 0a78cb5
commit a3953d4
Show file tree

Hide file tree

Showing 10 changed files with 108 additions and 131 deletions.
diff --git a/src/Api/LocalizeScripts.php b/src/Api/LocalizeScripts.php
@@ -1,4 +1,6 @@
-<?php declare(strict_types=1);
+<?php
+
+declare(strict_types=1);
 
 namespace Dwnload\WpSettingsApi\Api;
 
@@ -15,7 +17,7 @@ class LocalizeScripts
 
     /**
      * Localized array to pass from PHP to JS.
-     * @var array $vars
+     * @var string[] $vars
      */
     protected static array $vars = [];
 
@@ -24,7 +26,7 @@ class LocalizeScripts
      * @param string $key
      * @param string $value
      */
-    public function add(string $key, string $value)
+    public function add(string $key, string $value): void
     {
         self::$vars[$key] = html_entity_decode($value, ENT_QUOTES, 'UTF-8');
     }

diff --git a/src/Api/Options.php b/src/Api/Options.php
@@ -1,4 +1,5 @@
-<?php declare(strict_types=1);
+<?php
+declare(strict_types=1);
 
 namespace Dwnload\WpSettingsApi\Api;
 
@@ -7,9 +8,9 @@
 use function array_key_exists;
 use function get_option;
 use function is_array;
+use function str_contains;
 use function str_repeat;
 use function strlen;
-use function strpos;
 use function substr;
 
 /**
@@ -26,10 +27,8 @@ class Options
      * @param mixed $default (Optional) Default value if option is not found.
      *                          Defaults to an empty string.
      * @return mixed
-     * phpcs:disable Inpsyde.CodeQuality.ReturnTypeDeclaration.NoReturnType
-     * phpcs:disable Inpsyde.CodeQuality.ArgumentTypeDeclaration.NoArgumentType
      */
-    public static function getOption(string $option_key, string $section_id = null, $default = '')
+    public static function getOption(string $option_key, ?string $section_id = null, mixed $default = ''): mixed
     {
         if (empty($section_id)) {
             $section_id = self::getSectionId($option_key);
@@ -43,24 +42,27 @@ public static function getOption(string $option_key, string $section_id = null,
      * Get the full settings Section ID array.
      * @param string $section_id The Section object ID the option belongs too.
      * @return mixed Value set for the option. Defaults to an empty array.
-     * phpcs:disable Inpsyde.CodeQuality.ReturnTypeDeclaration.NoReturnType
      */
-    public static function getOptions(string $section_id)
+    public static function getOptions(string $section_id): mixed
     {
         return get_option($section_id, []);
     }
 
     /**
+     * Get the obfuscated option value.
      * @param string $option_key Settings field key name in the section option array.
      * @param string $section_id The Section object ID the option belongs too.
      * @param mixed $default (Optional) Default value if option is not found.
      *                          Defaults to an empty string.
      * @param int $len (Optional) The Length of the un-obfuscated string. Defaults to `6`.
      * @return mixed|string
-     * phpcs:disable Inpsyde.CodeQuality.ArgumentTypeDeclaration.NoArgumentType
      */
-    public static function getObfuscatedOption(string $option_key, string $section_id, $default = '', int $len = 6)
-    {
+    public static function getObfuscatedOption(
+        string $option_key,
+        string $section_id,
+        mixed $default = '',
+        int $len = 6
+    ): mixed {
         $value = self::getOption($option_key, $section_id, $default);
 
         if (!empty($value)) {
@@ -77,10 +79,11 @@ public static function getObfuscatedOption(string $option_key, string $section_i
      */
     public static function isObfuscated(string $value): bool
     {
-        return strpos($value, '****') !== false;
+        return str_contains($value, '****');
     }
 
     /**
+     * Get the Section ID by option key.
      * @param string $option_key
      * @return string
      */

diff --git a/src/Api/PluginSettings.php b/src/Api/PluginSettings.php
@@ -10,6 +10,8 @@
 /**
  * Class PluginInfo
  * @package Dwnload\WpSettingsApi\Api
+ * phpcs:disable Generic.Commenting.DocComment.MissingShort
+ * phpcs:disable Squiz.Commenting.FunctionComment.Missing
  */
 class PluginSettings extends BaseModel
 {
@@ -43,7 +45,7 @@ public function getDomain(): string
         return $this->domain;
     }
 
-    protected function setDomain(string $domain)
+    protected function setDomain(string $domain): void
     {
         $this->domain = $domain;
     }
@@ -53,7 +55,7 @@ public function getFile(): string
         return $this->file;
     }
 
-    protected function setFile(string $file)
+    protected function setFile(string $file): void
     {
         $this->file = $file;
     }
@@ -68,7 +70,7 @@ public function getMenuSlug(): string
         return $this->menu_slug ?? $this->domain;
     }
 
-    protected function setMenuSlug(string $slug)
+    protected function setMenuSlug(string $slug): void
     {
         $this->menu_slug = $slug;
     }
@@ -78,7 +80,7 @@ public function getMenuTitle(): string
         return $this->menu_title;
     }
 
-    protected function setMenuTitle(string $title)
+    protected function setMenuTitle(string $title): void
     {
         $this->menu_title = $title;
     }
@@ -88,7 +90,7 @@ public function getPageTitle(): string
         return $this->page_title;
     }
 
-    protected function setPageTitle(string $title)
+    protected function setPageTitle(string $title): void
     {
         $this->page_title = $title;
     }
@@ -98,7 +100,7 @@ public function getPrefix(): string
         return $this->prefix;
     }
 
-    protected function setPrefix(string $prefix)
+    protected function setPrefix(string $prefix): void
     {
         $this->prefix = $prefix;
     }
@@ -108,7 +110,7 @@ public function getVersion(): string
         return $this->version;
     }
 
-    protected function setVersion(string $version)
+    protected function setVersion(string $version): void
     {
         $this->version = $version;
     }

diff --git a/src/Api/Sanitize.php b/src/Api/Sanitize.php
@@ -1,12 +1,13 @@
-<?php declare(strict_types=1);
+<?php
+
+declare(strict_types=1);
 
 namespace Dwnload\WpSettingsApi\Api;
 
 use Dwnload\WpSettingsApi\Settings\FieldManager;
 
 /**
  * Class Sanitize
- *
  * @package Dwnload\WpSettingsApi\Api
  */
 class Sanitize
@@ -17,16 +18,12 @@ class Sanitize
      * If the value is obscured (meaning it contains as least 4 stars "*****" in a row, we need
      * to get the value from the database instead of the new incoming value from the settings view
      * so that the obscured setting doesn't override the actual value in the DB.
-     *
      * @param mixed $value
      * @param array $options
      * @param string $option_slug
-     *
      * @return mixed
-     * phpcs:disable Inpsyde.CodeQuality.ArgumentTypeDeclaration.NoArgumentType
-     * phpcs:disable Inpsyde.CodeQuality.ReturnTypeDeclaration.NoReturnType
      */
-    public static function sanitizeObfuscated($value, array $options, string $option_slug)
+    public static function sanitizeObfuscated(mixed $value, array $options, string $option_slug): mixed
     {
         $section_id = self::getSectionId($option_slug);
 
@@ -39,16 +36,17 @@ public static function sanitizeObfuscated($value, array $options, string $option
 
     /**
      * Gets the Section ID of the option.
-     *
      * @param string $option_slug
-     *
      * @return string
      */
     private static function getSectionId(string $option_slug): string
     {
-        // Iterate over registered fields and see if we can find proper callback
+        // Iterate over registered fields and see if we can find proper callback.
         foreach (FieldManager::getFields() as $fields) {
-            /** @var SettingField $field */
+            /**
+             * Filed object.
+             * @var SettingField $field
+             */
             foreach ($fields as $field) {
                 if ($field->getName() === $option_slug) {
                     return $field->getSectionId();