Merge pull request #4802 from paulbalandan/phpdoc-param-return-types

Phpdoc param return types

Author: paulbalandan

admin/module/tests/_support/DatabaseTestCase.php

@@ -12,7 +12,7 @@ class DatabaseTestCase extends CIUnitTestCase
     /**
      * Should the database be refreshed before each test?
      *
-     * @var boolean
+     * @var bool
      */
     protected $refresh = true;
 

admin/module/tests/_support/Libraries/ConfigReader.php

@@ -30,9 +30,11 @@
  * THE SOFTWARE.
  *
  * @package    CodeIgniter
+ *
  * @author     CodeIgniter Dev Team
  * @copyright  2019-2021 CodeIgniter Foundation
  * @license    https://opensource.org/licenses/MIT	MIT License
+ *
  * @link       https://codeigniter.com
  * @since      Version 4.0.0
  * @filesource

admin/starter/tests/_support/DatabaseTestCase.php

@@ -12,7 +12,7 @@ class DatabaseTestCase extends CIUnitTestCase
     /**
      * Should the database be refreshed before each test?
      *
-     * @var boolean
+     * @var bool
      */
     protected $refresh = true;
 

admin/starter/tests/_support/Libraries/ConfigReader.php

@@ -30,9 +30,11 @@
  * THE SOFTWARE.
  *
  * @package    CodeIgniter
+ *
  * @author     CodeIgniter Dev Team
  * @copyright  2019-2021 CodeIgniter Foundation
  * @license    https://opensource.org/licenses/MIT	MIT License
+ *
  * @link       https://codeigniter.com
  * @since      Version 4.0.0
  * @filesource

app/Config/App.php

@@ -81,7 +81,7 @@ class App extends BaseConfig
      *
      * If false, no automatic detection will be performed.
      *
-     * @var boolean
+     * @var bool
      */
     public $negotiateLocale = false;
 
@@ -134,7 +134,7 @@ class App extends BaseConfig
      * secure, the user will be redirected to a secure version of the page
      * and the HTTP Strict Transport Security header will be set.
      *
-     * @var boolean
+     * @var bool
      */
     public $forceGlobalSecureRequests = false;
 
@@ -172,7 +172,7 @@ class App extends BaseConfig
      * The number of SECONDS you want the session to last.
      * Setting to 0 (zero) means expire when the browser is closed.
      *
-     * @var integer
+     * @var int
      */
     public $sessionExpiration = 7200;
 
@@ -205,7 +205,7 @@ class App extends BaseConfig
      * WARNING: If you're using the database driver, don't forget to update
      *          your session table's PRIMARY KEY when changing this setting.
      *
-     * @var boolean
+     * @var bool
      */
     public $sessionMatchIP = false;
 
@@ -216,7 +216,7 @@ class App extends BaseConfig
      *
      * How many seconds between CI regenerating the session ID.
      *
-     * @var integer
+     * @var int
      */
     public $sessionTimeToUpdate = 300;
 
@@ -229,7 +229,7 @@ class App extends BaseConfig
      * when auto-regenerating the session ID. When set to FALSE, the data
      * will be later deleted by the garbage collector.
      *
-     * @var boolean
+     * @var bool
      */
     public $sessionRegenerateDestroy = false;
 
@@ -279,7 +279,7 @@ class App extends BaseConfig
      *
      * Cookie will only be set if a secure HTTPS connection exists.
      *
-     * @var boolean
+     * @var bool
      *
      * @deprecated use Config\Cookie::$secure property instead.
      */
@@ -292,7 +292,7 @@ class App extends BaseConfig
      *
      * Cookie will only be accessible via HTTP(S) (no JavaScript).
      *
-     * @var boolean
+     * @var bool
      *
      * @deprecated use Config\Cookie::$httponly property instead.
      */
@@ -392,7 +392,7 @@ class App extends BaseConfig
      *
      * @deprecated Use `Config\Security` $expire property instead of using this property.
      *
-     * @var integer
+     * @var int
      */
     public $CSRFExpire = 7200;
 
@@ -405,7 +405,7 @@ class App extends BaseConfig
      *
      * @deprecated Use `Config\Security` $regenerate property instead of using this property.
      *
-     * @var boolean
+     * @var bool
      */
     public $CSRFRegenerate = true;
 
@@ -418,7 +418,7 @@ class App extends BaseConfig
      *
      * @deprecated Use `Config\Security` $redirect property instead of using this property.
      *
-     * @var boolean
+     * @var bool
      */
     public $CSRFRedirect = true;
 
@@ -436,7 +436,6 @@ class App extends BaseConfig
      * Defaults to `Lax` as recommended in this link:
      *
      * @see https://portswigger.net/web-security/csrf/samesite-cookies
-     *
      * @deprecated Use `Config\Security` $samesite property instead of using this property.
      *
      * @var string
@@ -459,7 +458,7 @@ class App extends BaseConfig
      * @see http://www.html5rocks.com/en/tutorials/security/content-security-policy/
      * @see http://www.w3.org/TR/CSP/
      *
-     * @var boolean
+     * @var bool
      */
     public $CSPEnabled = false;
 }

app/Config/Autoload.php

@@ -37,6 +37,7 @@ class Autoload extends AutoloadConfig
      *       'App'	       => APPPATH
      *   ];
      *```
+     *
      * @var array<string, string>
      */
     public $psr4 = [
@@ -60,6 +61,7 @@ class Autoload extends AutoloadConfig
      *       'MyClass'   => '/path/to/class/file.php'
      *   ];
      *```
+     *
      * @var array<string, string>
      */
     public $classmap = [];
@@ -78,6 +80,7 @@ class Autoload extends AutoloadConfig
      *	 	   '/path/to/my/file.php',
      *    ];
      * ```
+     *
      * @var array<int, string>
      */
     public $files = [];

app/Config/Cache.php

@@ -66,7 +66,7 @@ class Cache extends BaseConfig
      *    array('q') = Enabled, but only take into account the specified list
      *                 of query parameters.
      *
-     * @var boolean|string[]
+     * @var bool|string[]
      */
     public $cacheQueryString = false;
 
@@ -93,7 +93,7 @@ class Cache extends BaseConfig
      * hard-coded, but may be useful to projects and modules. This will replace
      * the hard-coded value in a future release.
      *
-     * @var integer
+     * @var int
      */
     public $ttl = 60;
 

app/Config/ContentSecurityPolicy.php

@@ -22,7 +22,7 @@ class ContentSecurityPolicy extends BaseConfig
     /**
      * Default CSP report context
      *
-     * @var boolean
+     * @var bool
      */
     public $reportOnly = false;
 
@@ -39,7 +39,7 @@ class ContentSecurityPolicy extends BaseConfig
      * HTTP to HTTPS. This directive is for websites with
      * large numbers of old URLs that need to be rewritten.
      *
-     * @var boolean
+     * @var bool
      */
     public $upgradeInsecureRequests = false;
 

app/Config/Cookie.php

@@ -27,7 +27,7 @@ class Cookie extends BaseConfig
      * cookie will not have the `Expires` attribute and will behave as a session
      * cookie.
      *
-     * @var DateTimeInterface|integer|string
+     * @var DateTimeInterface|int|string
      */
     public $expires = 0;
 
@@ -60,7 +60,7 @@ class Cookie extends BaseConfig
      *
      * Cookie will only be set if a secure HTTPS connection exists.
      *
-     * @var boolean
+     * @var bool
      */
     public $secure = false;
 
@@ -71,7 +71,7 @@ class Cookie extends BaseConfig
      *
      * Cookie will only be accessible via HTTP(S) (no JavaScript).
      *
-     * @var boolean
+     * @var bool
      */
     public $httponly = true;
 
@@ -110,7 +110,7 @@ class Cookie extends BaseConfig
      * If this is set to `true`, cookie names should be compliant of RFC 2616's
      * list of allowed characters.
      *
-     * @var boolean
+     * @var bool
      *
      * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie#attributes
      * @see https://tools.ietf.org/html/rfc2616#section-2.2

app/Config/Email.php

@@ -66,21 +66,21 @@ class Email extends BaseConfig
     /**
      * SMTP Port
      *
-     * @var integer
+     * @var int
      */
     public $SMTPPort = 25;
 
     /**
      * SMTP Timeout (in seconds)
      *
-     * @var integer
+     * @var int
      */
     public $SMTPTimeout = 5;
 
     /**
      * Enable persistent SMTP connections
      *
-     * @var boolean
+     * @var bool
      */
     public $SMTPKeepAlive = false;
 
@@ -94,14 +94,14 @@ class Email extends BaseConfig
     /**
      * Enable word-wrap
      *
-     * @var boolean
+     * @var bool
      */
     public $wordWrap = true;
 
     /**
      * Character count to wrap at
      *
-     * @var integer
+     * @var int
      */
     public $wrapChars = 76;
 
@@ -122,14 +122,14 @@ class Email extends BaseConfig
     /**
      * Whether to validate the email address
      *
-     * @var boolean
+     * @var bool
      */
     public $validate = false;
 
     /**
      * Email Priority. 1 = highest. 5 = lowest. 3 = normal
      *
-     * @var integer
+     * @var int
      */
     public $priority = 3;
 
@@ -150,21 +150,21 @@ class Email extends BaseConfig
     /**
      * Enable BCC Batch Mode.
      *
-     * @var boolean
+     * @var bool
      */
     public $BCCBatchMode = false;
 
     /**
      * Number of emails in each BCC batch
      *
-     * @var integer
+     * @var int
      */
     public $BCCBatchSize = 200;
 
     /**
      * Enable notify message from server
      *
-     * @var boolean
+     * @var bool
      */
     public $DSN = false;
 }

app/Config/Encryption.php

@@ -50,7 +50,7 @@ class Encryption extends BaseConfig
      *
      * See the user guide for more information on padding.
      *
-     * @var integer
+     * @var int
      */
     public $blockSize = 16;
 

app/Config/Exceptions.php

@@ -18,7 +18,7 @@ class Exceptions extends BaseConfig
      *
      * Default: true
      *
-     * @var boolean
+     * @var bool
      */
     public $log = true;
 

app/Config/Honeypot.php

@@ -9,7 +9,7 @@ class Honeypot extends BaseConfig
     /**
      * Makes Honeypot visible or not to human
      *
-     * @var boolean
+     * @var bool
      */
     public $hidden = true;
 

app/Config/Logger.php

@@ -35,7 +35,7 @@ class Logger extends BaseConfig
      * For a live site you'll usually enable Critical or higher (3) to be logged otherwise
      * your log files will fill up very fast.
      *
-     * @var integer|array
+     * @var int|array
      */
     public $threshold = 4;
 

app/Config/Migrations.php

@@ -16,7 +16,7 @@ class Migrations extends BaseConfig
      * You should enable migrations whenever you intend to do a schema migration
      * and disable it back when you're done.
      *
-     * @var boolean
+     * @var bool
      */
     public $enabled = true;