calebdw/larastan-livewire

A Larastan / PHPStan extension for Livewire.

v1.1.0 2024-09-06 23:14 UTC

Requires

• php: ^8.1
• illuminate/support: ^10.0 || ^11.0
• livewire/livewire: ^3.3
• phpstan/phpstan: ^1.10

Requires (Dev)

• phpunit/phpunit: ^10.5

MIT

• Caleb White

• static analysis
• PHPStan
• larastan
• livewire

README

A Larastan / PHPStan extension for Laravel Livewire.

Install

composer require calebdw/larastan-livewire --dev

If you have the PHPStan extension installer installed then nothing more is needed, otherwise you will need to manually include the extension in the phpstan.neon(.dist) configuration file:

includes:
    - ./vendor/calebdw/larastan-livewire/extension.neon

Features

Computed Properties

Computed properties are properly resolved from methods that have the Computed attribute applied.

<?php

use Livewire\Attributes\Computed;
use Livewire\Component;

class ShowPost extends Component
{
    #[Computed]
    public function post()
    {
        return Post::find($this->postId);
    }
}

Getter Style

The older, "getter" style attributes are supported as well:

<?php

use Livewire\Component;

class ShowPost extends Component
{
    // Computed Property
    public function getPostProperty()
    {
        return Post::find($this->postId);
    }
}

Contributing

Thank you for considering contributing! You can read the contribution guide here.

License

Larastan-Livewire is open-sourced software licensed under the MIT license.