Search by

fahoba / plugin-api

pointia

Contracts and helpers for Fahoba plugins

0.2.0 2026-11-16 10:52 UTC

This package is auto-updated.

Last update: 2026-11-16 10:58:00 UTC


README

The contracts, data objects and helpers a Fahoba plugin talks to: providers, dashboard widgets, areas, extensions, photo rules.

MIT licensed — a plugin built only on this package may carry any licence its author chooses. Fahoba itself is under PolyForm Shield 1.0.0.

Start with the guide, Writing a Fahoba plugin, or let a Fahoba checkout write a package for you:

php artisan fahoba:make-plugin acme/waste --widget

Or start from the template repository (“Use this template”), which needs no Fahoba checkout.

Test your plugin in its own repository with the testkit:

final class WasteTest extends \PHPUnit\Framework\TestCase
{
    use \Fahoba\PluginApi\Testing\PluginAssertions;

    public function test_the_widget_works(): void
    {
        $this->assertWidgetWorks(new WasteWidget, ['street' => 'Hauptstraße']);
    }
}

0.x until plugins outside the monorepo have been built against it; from 1.0.0 on SemVer — see What stays stable in the guide.

This repository is a read-only split of the Fahoba monorepo, made on every release. Issues and pull requests go to the main repository.