一、安装

composer require nwidart/laravel-modules

在composer 中配置：

配置完成后执行：

composer dump-autoload

二、基本使用

创建module：

php artisan module:make Blog

会在 Modules 目录下创建出一个类似APP的目录来，创建一个干净的module可以使用 --plain 或者 -p 标记。Lang View Config 在每个module中都有独立的命名空间，例如：

三、配置文件

框架自身带有一些配置选项，首先发布配置文件：
发布配置文件 php artisan vendor:publish --provider="Nwidart\Modules\LaravelModulesServiceProvider"

• Default namespace生成模块时默认的命名空间
• Overwrite the generated files覆盖生成模块时使用的默认生成存根。这对于定制不同文件的输出非常有用。
• Overwrite the paths覆盖包中使用的默认路径。
• Scan additional folders for modules这是默认禁用的。一旦启用，包将在指定的路径数组中查找模块。
• Composer file template文件模板composer
• Caching如果您有许多模块，那么最好缓存这些信息(比如多个模块)。例如多个module.json文件)。
• Registering custom namespace决定哪一个自定义命名空间需要使用package来注册。如果某个设置为false，package不会处理它的注册。

四、辅助方法

$path = module_path('Blog'); 获取模块路径

五、命令行工具

实用命令：

• module:make 创建一个新模块
• module:use 使用一个模块（这允许执行其他命令时不用输入模块名）
• module:unuse 和上面相反
• module:list 列出所有可用模块
• module:migrate 执行某个模块的数据迁移（或者所有模块的）
• php artisan module:migrate-rollback Blog 执行模块最近一次迁移的回滚
• php artisan module:migrate-refresh Blog 执行模块所有回滚后执行所有迁移
• php artisan module:migrate-reset Blog 执行模块所有回滚
• php artisan module:seed Blog 执行模块数据填充
• php artisan module:publish-migration Blog 发布迁移
• php artisan module:publish-config Blog 发布配置
• php artisan module:publish-translation Blog 发布语言包
• php artisan module:enable Blog 开启模块
• php artisan module:disable Blog 关闭模块
• php artisan module:update Blog 升级模块

生成器命令：

• php artisan module:make-command CreatePostCommand Blog
• php artisan module:make-migration create_posts_table Blog
• php artisan module:make-seed seed_fake_blog_posts Blog
• php artisan module:make-controller PostsController Blog
• php artisan module:make-model Post Blog （可以使用-m同步生成迁移文件）
• php artisan module:make-provider BlogServiceProvider Blog
• php artisan module:make-middleware CanReadPostsMiddleware Blog
• php artisan module:make-mail SendWeeklyPostsEmail Blog
• php artisan module:make-notification NotifyAdminOfNewComment Blog
• php artisan module:make-listener NotifyUsersOfANewPost Blog
• php artisan module:make-listener NotifyUsersOfANewPost Blog --event=PostWasCreated
• php artisan module:make-listener NotifyUsersOfANewPost Blog --event=PostWasCreated --queued
• php artisan module:make-request CreatePostRequest Blog
• php artisan module:make-event BlogPostWasUpdated Blog
• php artisan module:make-job JobName Blog（可以使用-sync生成同步任务）
• php artisan module:route-provider Blog 为指定的模块生成给定的路由服务提供程序。
• php artisan module:make-factory FactoryName Blog
• php artisan module:make-policy PolicyName Blog
• php artisan module:make-rule ValidationRule Blog
• php artisan module:make-resource PostResource Blog
• php artisan module:make-resource PostResource Blog --collection
• php artisan module:make-test EloquentPostRepositoryTest Blog

六、门面方法

• Module::all(); 获取所有模块
• Module::getCached() 获取所有缓存的模块
• Module::getOrdered(); 获取排序后的所有模块（按照module.json文件中的priority排序）
• Module::scan(); 获取扫描过的模块
• Module::find('name'); 查询某个模块（返回Module类）
• Module::get('name');
• Module::findOrFail('module-name');
• Module::getScanPaths(); 获取扫描的路径
• Module::toCollection(); 获取模块集合
• Module::getByStatus(1); 按照状态获取模块（1可用0不可用）
• Module::has('blog'); 判断模块是否存在
• Module::allEnabled(); 获取所有可用模块
• Module::allDisabled();
• Module::count(); 统计模块数量
• Module::getPath(); 获取模块路径
• Module::register(); 注册模块
• Module::boot(); 初始化模块
• Module::collections(); 获取所有可用模块的集合
• Module::getModulePath('name'); 获取某个模块路径
• Module::assetPath('name'); 获取某个模块的资源路径
• Module::config('composer.vendor'); 从这个包中获取配置值。
• Module::getUsedStoragePath(); 获取使用的存储路径。
• Module::getUsedNow(); 获取cli会话正在使用的模块。
• Module::getUsed();
• Module::setUsed('name'); 设置会话使用的模块
• Module::asset('blog:img/logo.img'); 从某个模块获取资源路径
• Module::install('nwidart/hello'); 根据给定的模块名称安装指定的模块。
• Module::update('hello'); 更新指定模块的依赖项。
  将宏添加到模块存储库。

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

• Module::hello(); 调用宏
• Module::getRequirements('module name'); 获取依赖的其他模块

七、模块Module方法

• $module = Module::find('blog');
• $module->getName();
• $module->getLowerName();
• $module->getStudlyName();
• $module->getPath(); 模块路径
• $module->getExtraPath('Assets'); 模块其他路劲
• $module->disable();
• $module->enable();
• $module->delete();
• $module->getRequires(); 获取模块依赖的其他模块

八、发布模块

将模块以composer包的形式发布

1. 创建一个模块
2. 确保 type 属性在 composer.json 文件中申明为 laravel-module
3. 包名必须以 -module 结尾，例如 <namespace>/<name>-module，将会被自动安装到 Module/<name> 目录
4. 发布到packagist

你需要执行额外一步确保模块安装到 Modules 目录下
安装 joshbrw/laravel-module-installer 插件，它会将文件自动移动到 Modules 目录

九、发布模块资源文件

模块可以像其他包一样发布文件（创建模块时不能使用 -plain 标志）

发布配置：

发布视图：

核心部分是loadViewsFrom方法的调用

发布语言包：

如果你想使用laravel工厂，你必须在你的服务提供商中添加以下内容：

十、模块命令行指令

回顾一下创建模块命令：
php artisan module:make-command CreatePostCommand Blog

您可以使用commands为laravel方法注册命令，该方法在服务提供者类中可用。

#

十一、模块事件

回顾一下创建模块事件和监听器：

php artisan module:make-event BlogPostWasUpdated Blog
php artisan module:make-listener NotifyAdminOfNewPost Blog

之后需要在laravel中注册他们，有两种办法：

1. 手动在模块的服务提供者中调用
   $this->app['events']->listen(BlogPostWasUpdated::class, NotifyAdminOfNewPost::class);
2. 在app/命名空间下为模块创建一个事件服务提供者（EventServiceProvider）包含他的所有事件

不要忘记加载此服务提供者，将其添加到module.json文件中。