ronappleton/laravel-typed-config

This package is abandoned and no longer maintained. No replacement package was suggested.

PHP Stan compliant config helper for Laravel, use config without stan complaining!

1.0.2 2024-02-29 23:02 UTC

Requires (Dev)

• larastan/larastan: ^2.9
• laravel/framework: 10.*
• laravel/pint: ^1.14
• orchestra/testbench: 8.*

MIT

• Ron Appleton

README

Laravel Typed Config

Deprecated

I have archived this repository, what I didn't know was that 4 days before I produced this package, the Laravel team had just added this functionality to the illuminate config repository class.

See the commit

Overview

Super simple package, with a super simple job.

Provide type based config value accessors for use within Laravel to avoid Php Stan complaining about mixed types after fetching a value from a configuration file.

Installation

composer require ronappleton/laravel-typed-config

Usage

A facade is registered TypedConfig

Import Appleton\TypedConfig\Facades\TypedConfig

This will then give you access to:

TypedConfig::string(string $key, string $default = null): string

TypedConfig::int(string $key, int $default = null): int

TypedConfig::bool(string $key, bool $default = null): bool

TypedConfig::array(string $key, array $default = null): array

TypedConfig::float(string $key, float $default = null): float

TypedConfig::object(string $key, object $default = null): object

TypedConfig::classString(string $key, string $default = null): string

Note: classString is a special case, it will also check the class exists.

Also Repository macros have been added to allow the use through the config helper

config()->string('key', 'default')

config()->int('key', 1)

for example.