Facade Methods


Import facade:

Copied!
use Nwidart\Modules\Facades\Module;

Get all modules.

Copied!
Module::all();

Get all cached modules.

Copied!
Module::getCached()

Get ordered modules. The modules will be ordered by the priority key in module.json file.

Copied!
Module::getOrdered();

Get scanned modules.

Copied!
Module::scan();

Find a specific module.

Copied!
Module::find('name');
// OR
Module::get('name');

Find a module, if there is one, return the Module instance, otherwise throw Nwidart\Modules\Exeptions\ModuleNotFoundException.

Copied!
Module::findOrFail('module-name');

Get scanned paths.

Copied!
Module::getScanPaths();

Get all modules as a collection instance.

Copied!
Module::toCollection();

Get modules by the status. 1 for active and 0 for inactive.

Copied!
Module::getByStatus(1);

Check the specified module. If it exists, will return true, otherwise false.

Copied!
Module::has('blog');

Get all enabled modules.

Copied!
Module::allEnabled();

Check if module is enabled

Copied!
Module::isEnabled('ModuleName');

Get all disabled modules.

Copied!
Module::allDisabled();

Check if module is disabled

Copied!
Module::isDisabled('ModuleName');

Enable module

Copied!
Module::enable('ModuleName');

Disable module

Copied!
Module::disable('ModuleName');

Delete module

Copied!
Module::delete('ModuleName');

Update dependencies for the specified module.

Copied!
Module::update('hello');

Install the specified module by given module name.

Copied!
Module::install('nwidart/hello');

Get count of all modules.

Copied!
Module::count();

Get module root path.

Copied!
Module::getPath();

Get the module's app path. If the module doesn't have an app folder, the result is the same as getPath method.

Copied!
Module::getAppPath();

Register the modules.

Copied!
Module::register();

Boot all available modules.

Copied!
Module::boot();

Get all enabled modules as collection instance.

Copied!
Module::collections();

Get module path from the specified module.

Copied!
Module::getModulePath('name');

Get assets path from the specified module.

Copied!
Module::assetPath('name');

Get config value from this package.

Copied!
Module::config('composer.vendor');

Get used storage path.

Copied!
Module::getUsedStoragePath();

Get used module for cli session.

Copied!
Module::getUsedNow();
// OR
Module::getUsed();

Set used module for cli session.

Copied!
Module::setUsed('name');

Get modules's assets path.

Copied!
Module::getAssetsPath();

Get asset url from specific module.

Copied!
Module::asset('blog:img/logo.img');

Add a macro to the module repository.

Copied!
Module::macro('hello', function() {
echo "I'm a macro";
});

Call a macro from the module repository.

Copied!
Module::hello();

Get all required modules of a module

Copied!
Module::getRequirements('module name');


Laravel Package built by Nicolas Widart.

Maintained by David Carr follow on X @dcblogdev