naugrim/laravel-strict-config-helper

Ensures your config returns the correct types

1.1.0 2024-04-03 06:20 UTC

Requires

• php: ^8.1
• laravel/framework: ^8.0|^9.0|^10.0|^11.0

MIT

• Erik Anders

README

This package is mainly intended to work together with PHPStan.

Laravel's helper config($key, $default) returns mixed. In higher PHPStan levels, you cannot perform certain operations on mixed types.

Example:

https://phpstan.org/r/39022f87-cbae-4e7b-bb44-8a4a655d2f00

<?php 

$value = config('foo');

if (strpos($value, 'bar')) {
  // do something	
}

This produces the following error:

Line	Message
10	Parameter #1 $haystack of function strpos expects string, mixed given

With this package, you can do:

https://phpstan.org/r/0c0e3e10-2dbd-418b-966d-2930016d803d

$value = config_string('foo');

if (strpos($value, 'bar')) {
  // do something	
}

No error is returned, as $value is guaranteed to be a string.

A RuntimeException is thrown if the value in the config has the wrong type.

Note: The helper functions in this package cannot return NULL. So if the value is not set in your config and you do not provide a $default value, an exception will be thrown.

Installation

composer require naugrim/laravel-strict-config-helper

Available Functions

config_string(string $key, ?string $default = null): string
config_int(string $key, ?int $default = null): int
config_float(string $key, ?float $default = null): float
config_numeric(string $key, int | float | null $default = null): int | float
config_bool(string $key, ?bool $default = null): bool

IDE config key autocompletion

If you are using the awesome Laravel IDEA plugin for PHPStorm, you can create a file named ide.json in your project with the following content to have autocompletion of the config keys:

{
  "$schema": "https://laravel-ide.com/schema/laravel-ide-v2.json",
  "completions": [
    {
      "complete": "configKey",
      "condition": [
        {
          "functionNames": ["config_bool", "config_float", "config_int", "config_numeric", "config_string"],
          "parameters": [1]
        }
      ]
    }
  ]
}