Phpstan Psr3 Laravel Package

Getting Started

1. Install the package via Composer:
   composer require --dev staabm/phpstan-psr3
2. Enable it in your PHPStan config (phpstan.neon):

   includes:
       - vendor/staabm/phpstan-psr3/config.neon
   

3. First use case: Write a logging call using a PSR-3 logger (e.g., Monolog\Logger or any implementation of Psr\Log\LoggerInterface), and PHPStan will now validate placeholders and context keys at compile time — e.g., flagging log('error', 'User {id} not found', ['user_id' => 123]) as invalid because {id} ≠ {user_id}.

Implementation Patterns

• Standard PSR-3 usage: Use context arrays with consistent keys matching placeholders ({key} in the message). The extension validates that all placeholders are covered and no extra context is provided.
• Typed context arrays: Define custom context structures (e.g., ['userId' => int, 'action' => string]) in PHPDocs or via generics, and PHPStan will check type conformance.
• Integrations: Works seamlessly with Laravel’s Log::channel(), Symfony’s Logger, or direct Psr\Log\LoggerInterface injection — ideal for service classes where structured logging is enforced.
• Gradual adoption: Start by enabling only strict level (level: 5) and progressively tighten; the extension adds no new errors to pre-existing code unless mismatches exist.

Gotchas and Tips

• Message placeholder syntax: Only {placeholder} (curly braces) is supported; %placeholder% (Symfony-style) won’t be validated — ensure your messages follow PSR-3.
• Context key case sensitivity: {UserId} and {userid} are treated as different placeholders — match exactly in your context keys.
• False positives? Some monolog handlers or processors may mutate context — ignore via ignoreErrors or use @phpstan-ignore-next-line for edge cases where context is dynamically altered.
• Extensibility: You can extend validation by creating custom rules for domain-specific context keys (e.g., ['tenantId' => string]) using PHPStan’s Custom Rules API — the package doesn’t enforce strict schemas, just checks for consistency with placeholders.
• Laravel tip: For Log::info('...', ['some_key' => ...]), ensure PHPStan can infer the type via @method annotations if using facades; the extension works best when the logger instance type is unambiguous.