Modules

Sample documentation (demo only)
This is an incomplete, outdated docs snapshot shipped with the playground — screenshots were removed on purpose.
For the full, current manuals go to voodflow.com/docs.

Voodflow\Voodbuilder\Modules\AbstractVoodBuilderModule

• File: Modules/AbstractVoodBuilderModule.php
• Kind: class
• Implements: VoodBuilderModule
• Responsibility: Base module with default no-op register hooks and capability helpers.

Methods

• public function version(): string
  • Convenience base for internal modules. Prefer small contributor interfaces over growing this class.
• public function dependencies(): array
  • Module ids that must be enabled before this module boots.
• public function capabilities(): array
  • Capability identifiers contributed or required by this module.
• public function register(ModuleContext $context): void
  • Performs register side effects.
• public function boot(ModuleContext $context): void
  • }

Voodflow\Voodbuilder\Modules\Conditions\ConditionsModule

• File: Modules/Conditions/ConditionsModule.php
• Kind: class
• Extends: AbstractVoodBuilderModule
• Implements: RegistersConditions
• Responsibility: Conditions Module.

Methods

• public function id(): string
  • Stable identifier for this extension point.
• public function name(): string
  • Human-readable module name.
• public function capabilities(): array
  • Capability identifiers contributed or required by this module.
• public function conditionDefinitions(ModuleContext $context): array
  • Condition Definitions.
• public static function isEnabled(): bool
  • Boolean predicate isEnabled.

Voodflow\Voodbuilder\Modules\History\HistoryModule

• File: Modules/History/HistoryModule.php
• Kind: class
• Extends: AbstractVoodBuilderModule
• Implements: RegistersRoutes
• Responsibility: History Module.

Methods

• public function id(): string
  • Stable identifier for this extension point.
• public function name(): string
  • Human-readable module name.
• public function capabilities(): array
  • Capability identifiers contributed or required by this module.
• public function registerRoutes(Router $router, ModuleContext $context): void
  • Performs registerRoutes side effects.
• public function register(ModuleContext $context): void
  • Performs register side effects.
• public static function isEnabled(): bool
  • Boolean predicate isEnabled.

Voodflow\Voodbuilder\Modules\Layouts\LayoutsModule

• File: Modules/Layouts/LayoutsModule.php
• Kind: class
• Extends: AbstractVoodBuilderModule
• Implements: RegistersBlocks, RegistersRoutes
• Responsibility: Chrome layout admin/editor. Public shell resolution stays Core (ChromeLayoutResolver).

Methods

• public function id(): string
  • Stable identifier for this extension point.
• public function name(): string
  • Human-readable module name.
• public function capabilities(): array
  • Capability identifiers contributed or required by this module.
• public function registerRoutes(Router $router, ModuleContext $context): void
  • Performs registerRoutes side effects.
• public function registerBlocks(EditorBlockRegistry $blocks, ModuleContext $context): void
  • Performs registerBlocks side effects.
• public function register(ModuleContext $context): void
  • Performs register side effects.
• public static function isEnabled(): bool
  • Boolean predicate isEnabled.

Voodflow\Voodbuilder\Modules\Menus\MenusModule

• File: Modules/Menus/MenusModule.php
• Kind: class
• Extends: AbstractVoodBuilderModule
• Implements: RegistersAssets, RegistersRoutes
• Responsibility: Admin menus UI. Public navigation resolution remains Core.

Methods

• public function id(): string
  • Stable identifier for this extension point.
• public function name(): string
  • Human-readable module name.
• public function capabilities(): array
  • Capability identifiers contributed or required by this module.
• public function registerRoutes(Router $router, ModuleContext $context): void
  • Performs registerRoutes side effects.
• public function registerAssets(ModuleContext $context): void
  • Performs registerAssets side effects.
• public function register(ModuleContext $context): void
  • Performs register side effects.
• public static function isEnabled(): bool
  • Boolean predicate isEnabled.

Voodflow\Voodbuilder\Modules\ModuleContext

• File: Modules/ModuleContext.php
• Kind: class
• Responsibility: Context passed into module register methods (app, panel hooks, etc.).

Methods

• public function __construct( public readonly Application $app, public readonly array $config = [], public readonly bool $enabled = true, )
  • Constructor.
• public function config(string $key, mixed $default = null): mixed
  • Config.

Voodflow\Voodbuilder\Modules\ModuleRegistry

• File: Modules/ModuleRegistry.php
• Kind: class
• Responsibility: Registers and boots VoodBuilderModule instances; source of module enablement.

Methods

• public function __construct( private readonly Application $app, )
  • Constructor.
• public function register(VoodBuilderModule $module, bool $enabled = true): void
  • Performs register side effects.
• public function all(): Collection
  • All.
• public function enabled(): Collection
  • Enabled.
• public function get(string $id): ?VoodBuilderModule
  • Get.
• public function has(string $id): bool
  • Boolean predicate has.
• public function isEnabled(string $id): bool
  • Boolean predicate isEnabled.
• public function enable(string $id): void
  • Performs enable side effects.
• public function disable(string $id): void
  • Performs disable side effects.
• public function boot(): void
  • Performs boot side effects.
• public function booted(): bool
  • Model boot hooks (observers/events).
• public function contributors(string $interface): Collection
  • Contributors.

Voodflow\Voodbuilder\Modules\Pages\PagesModule

• File: Modules/Pages/PagesModule.php
• Kind: class
• Extends: AbstractVoodBuilderModule
• Implements: RegistersRoutes
• Responsibility: Site pages admin/editor + pages content channel. Public show routes remain in package routes/web.php behind pages.enabled.

Methods

• public function id(): string
  • Stable identifier for this extension point.
• public function name(): string
  • Human-readable module name.
• public function capabilities(): array
  • Capability identifiers contributed or required by this module.
• public function registerRoutes(Router $router, ModuleContext $context): void
  • Performs registerRoutes side effects.
• public function register(ModuleContext $context): void
  • Performs register side effects.
• public static function isEnabled(): bool
  • Boolean predicate isEnabled.

Voodflow\Voodbuilder\Modules\Templates\TemplatesModule

• File: Modules/Templates/TemplatesModule.php
• Kind: class
• Extends: AbstractVoodBuilderModule
• Implements: RegistersRoutes
• Responsibility: Templates Module.

Methods

• public function id(): string
  • Stable identifier for this extension point.
• public function name(): string
  • Human-readable module name.
• public function capabilities(): array
  • Capability identifiers contributed or required by this module.
• public function registerRoutes(Router $router, ModuleContext $context): void
  • Performs registerRoutes side effects.
• public function register(ModuleContext $context): void
  • Performs register side effects.
• public static function isEnabled(): bool
  • Boolean predicate isEnabled.

Voodflow\Voodbuilder\Modules\Themes\ThemesModule

• File: Modules/Themes/ThemesModule.php
• Kind: class
• Extends: AbstractVoodBuilderModule
• Implements: RegistersAssets
• Responsibility: Theme Studio UI (workspace + theme map). Built-in theme resolution stays in Core.

Methods

• public function id(): string
  • Stable identifier for this extension point.
• public function name(): string
  • Human-readable module name.
• public function capabilities(): array
  • Capability identifiers contributed or required by this module.
• public function registerAssets(ModuleContext $context): void
  • Performs registerAssets side effects.
• public function register(ModuleContext $context): void
  • Performs register side effects.
• public static function isEnabled(): bool
  • Boolean predicate isEnabled.