Skip to content

Modularous ​

Facade: Unusualify\Modularous\Facades\Modularous
Accessor: modularous
Underlying: Unusualify\Modularous\Modularous

The primary facade for interacting with the Modularous module registry. Used throughout controllers, service providers, and helpers to resolve modules, check existence, and manage module state.

Methods ​

MethodSignatureDescription
getModules(): arrayReturns all registered modules
getEnabledModules(): arrayReturns only enabled modules
hasModule(string $name): boolChecks if a module is registered
find(string $name): ModuleFinds a module by name, returns null if not found
findOrFail(string $name): ModuleFinds a module, throws if not found
getModulePath(string $moduleName): stringReturns the filesystem path to a module
assetPath(string $module): stringReturns the public asset path for a module
moduleAsset(string $module, string $asset): stringReturns the full URL for a module asset
enableModule(string $moduleName): voidEnables a module
disableModule(string $moduleName): voidDisables a module
deleteModule(string $moduleName): voidRemoves a module

Usage ​

php
use Unusualify\Modularous\Facades\Modularous;

// Find a module and call methods on it
$module = Modularous::find('Blog');
$routeUrl = $module->getRouteActionUrl('posts', 'index');

// Check availability
if (Modularous::hasModule('Payment')) {
    // payment features available
}

// Iterate all enabled modules
foreach (Modularous::getEnabledModules() as $module) {
    echo $module->getName();
}

Notes ​

  • find() is the most-used method across the codebase, also available as the global curtModule() helper.
  • Module instances returned are Nwidart\Modules\Module objects extended by Modularous.