kilowhat/flarum-database-requirements

Reusable code to ensure the database requirements of a Flarum extension are met

1.0.0 2022-12-15 18:01 UTC

Requires

• flarum/core: ^1.0

mit

• Clark Winkelmann

• database
• flarum

README

This is a library re-used across multiple KILOWHAT extensions to ensure the database requirements are met before an extension can be enabled.

It will not appear in the Flarum admin panel.

There is currently a single feature: ensure the JSON column type is supported by the database.

To use in an extension, create a new migration that executes before all other migrations with the following code (where vendor-name is the internal Flarum extension ID for your extension):

<?php

use Kilowhat\DatabaseRequirements\Migration;

return Migration::ensureJsonColumnSupport('vendor-name');

To work around false positives, the kilowhat.ignore-mysql-requirement key can be set to true in config.php.

After the migrations have run, the requirements will not be checked again.