Download the PHP package laravel-enso/migrator without Composer
On this page you can find all versions of the php package laravel-enso/migrator. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download laravel-enso/migrator
More information about laravel-enso/migrator
Files in laravel-enso/migrator
Package migrator
Short Description Structure-aware migration helpers for Laravel Enso packages
License MIT
Homepage https://github.com/laravel-enso/migrator
Informations about the package migrator
Migrator
Description
Migrator provides a structure-aware migration helper for Laravel Enso packages.
The package exposes an abstract migration base class that wraps permission creation and menu creation into the normal Laravel migration lifecycle. It is intended for Enso packages that need to register permissions and menu entries together with the database changes that introduce a new module or page.
Instead of duplicating the same permission and menu provisioning logic in each package, Enso migrations can declare a permission array, a menu payload, and an optional parent menu path, and let the package handle validation, creation, and rollback.
Installation
This package is normally installed as part of the Enso backend stack.
For standalone installation in an Enso-based application:
The package depends on:
laravel-enso/corelaravel-enso/menuslaravel-enso/permissionslaravel-enso/roles
Features
- Abstract migration class for permission and menu provisioning.
- Transaction-wrapped
up()anddown()flows. - Permission creation with default-role and all-roles assignment logic.
- Menu creation linked automatically to the declared route permission.
- Parent menu resolution through dot-notated menu paths.
- Validation for required permission and menu attributes.
- Structure-specific exceptions for invalid elements or unresolved parents.
Usage
Extend LaravelEnso\Migrator\Database\Migration in a package migration:
When the migration runs:
up()creates the declared permissions- default permissions are attached to every role
- non-default permissions are attached only to the configured default role
- the menu entry is created and linked to the permission behind the declared route
When the migration rolls back:
- the menu entry is removed first
- the permissions are deleted afterwards
API
Abstract Migration
LaravelEnso\Migrator\Database\Migration
Protected properties:
protected array $permissions = []protected array $menu = []protected ?string $parentMenu = null
Lifecycle methods:
up()down()
Both directions are executed inside a database transaction.
Permission Payload
Each permission entry must contain:
namedescriptionis_default
Behavior:
is_default = trueattaches the permission to all rolesis_default = falseattaches it only to the configured default role fromenso.config.defaultRole
Menu Payload
The menu payload must contain:
nameiconrouteorder_indexhas_children
Behavior:
routeis used to resolve the matching permission- the permission id is stored on the created menu
routeitself is removed from the persisted menu payload after resolution
Services
Main services:
LaravelEnso\Migrator\Services\PermissionsLaravelEnso\Migrator\Services\MenusLaravelEnso\Migrator\Services\ParentMenuLaravelEnso\Migrator\Services\Validator
Parent Menu Resolution
ParentMenu accepts a dot-notated menu chain such as:
It resolves the menu from the last segment upwards and throws when the full ancestry chain cannot be matched.
Exceptions
The package throws LaravelEnso\Migrator\Exceptions\EnsoStructure for:
- invalid permission or menu payload types
- missing required attributes
- unresolved parent menu paths
Depends On
Required Enso packages:
Contributions
are welcome. Pull requests are great, but issues are good too.
Thank you to all the people who already contributed to Enso!
All versions of migrator with dependencies
laravel-enso/menus Version ^5.0
laravel-enso/permissions Version ^5.0
laravel-enso/roles Version ^5.0