README

Modulr

zenphp/modulr

Modulr 是一个用于 Laravel 应用的模块化系统。它使用 Composer 路径仓库 进行自动加载，以及 Laravel 包发现 进行模块初始化，并提供最小化的工具来填补任何空白。

Modulr 是对 InterNACHI/modular 的重新构思，并扩展了一些概念，例如使用我们的 modules:install 命令轻松将现有 composer 包模块化。能够将通常位于 vendor 文件夹之外的包引入您的应用，为您提供了巨大的灵活性，而无需承担维护自己的包的负担。

该项目既是一套约定，也是一个包。基本思想是您可以在单独的 modules/ 目录中创建“模块”，这有助于您更好地组织大型项目。这些模块使用现有的 Laravel 包系统，并遵循现有的 Laravel 约定。

• 安装
• 用法

安装

要开始使用，请运行

composer require zenphp/modulr

Laravel 将自动发现该包，并将为您自动设置一切。

发布配置

虽然不是必需的，但强烈建议您自定义模块的默认命名空间。默认情况下，这设置为 Modules\，这完全可以正常工作，但会使得将来您可能想要将模块提取到单独的包中时更加困难。

我们建议配置组织命名空间（例如，我们使用 "ZenPHP"）。为此，您需要发布包配置

php artisan vendor:publish --tag=modulr-config

创建模块

接下来，让我们创建一个模块

php artisan modules:make companies

Modulr 将为您搭建一个新的模块

modules/
  companies/
    composer.json
    src/
    tests/
    routes/
    resources/
    database/

它还会在您的应用 composer.json 文件中添加两个新条目。第一个条目将 ./modules/companies/ 注册为 路径仓库，第二个则要求 modules/companies:*（就像任何其他 Composer 依赖项一样）。

然后，Modulr 将提醒您执行 Composer 更新，所以现在让我们这样做

composer update modules/companies

可选：配置同步

您可以通过运行同步命令来确保您的项目已设置好模块支持

php artisan modules:sync

这将向您的 phpunit.xml 文件（如果存在）添加一个 Modules 测试套件，并更新您的 PhpStorm Laravel 插件 配置（如果存在），以便正确找到您的模块视图。

您可以在任何时候安全地运行此命令，因为它只会添加缺失的配置。您甚至可以将它添加到您的应用 composer.json 文件中的 post-autoload-dump 脚本中。

用法

所有模块都遵循现有的 Laravel 约定，并且在大多数情况下自动发现应该按预期工作。

• 命令将与 Artisan 自动注册
• 迁移将由迁移器运行
• 将为 factory() 自动加载工厂
• 将为您的模型自动发现策略
• Blade 组件将被自动发现
• 事件监听器将被自动发现

命令

包命令

我们提供了一些辅助命令

• php artisan modules:make — 搭建一个新模块 (--empty 用于创建空的模块目录)
• php artisan modules:install - 将任何已注册的 composer 包安装为模块。
• php artisan modules:cache — 缓存已加载的模块，以略微提高自动发现的速度
• php artisan modules:clear — 清除模块缓存
• php artisan modules:sync — 更新项目配置（如 phpunit.xml）以包含模块设置
• php artisan modules:list — 列出所有模块

Laravel “make:” 命令

我们还为大多数 Laravel make: 命令添加了 --module= 选项，以便您可以使用所有已知的现有工具。命令本身完全相同，这意味着您可以使用您自己的 自定义占位符 以及 Laravel 提供的一切

• php artisan make:cast MyModuleCast --module=[module name]
• php artisan make:controller MyModuleController --module=[module name]
• php artisan make:command MyModuleCommand --module=[module name]
• php artisan make:component MyModuleComponent --module=[module name]
• php artisan make:channel MyModuleChannel --module=[module name]
• php artisan make:event MyModuleEvent --module=[module name]
• php artisan make:exception MyModuleException --module=[module name]
• php artisan make:factory MyModuleFactory --module=[module name]
• php artisan make:job MyModuleJob --module=[module name]
• php artisan make:listener MyModuleListener --module=[module name]
• php artisan make:mail MyModuleMail --module=[module name]
• php artisan make:middleware MyModuleMiddleware --module=[module name]
• php artisan make:model MyModule --module=[module name]
• php artisan make:notification MyModuleNotification --module=[module name]
• php artisan make:observer MyModuleObserver --module=[module name]
• php artisan make:policy MyModulePolicy --module=[module name]
• php artisan make:provider MyModuleProvider --module=[module name]
• php artisan make:request MyModuleRequest --module=[module name]
• php artisan make:resource MyModule --module=[module name]
• php artisan make:rule MyModuleRule --module=[module name]
• php artisan make:seeder MyModuleSeeder --module=[module name]
• php artisan make:test MyModuleTest --module=[module name]

其他 Laravel 命令

除了在大多数 make: 命令中添加 --module 选项之外，我们还在 db:seed 命令中添加了相同的选项。如果您将 --module 选项传递给 db:seed，它将在您的模块命名空间中查找您的种子文件

• php artisan db:seed --module=[module name] 将尝试调用 Modules\MyModule\Database\Seeders\DatabaseSeeder
• php artisan db:seed --class=MySeeder --module=[module name] 将尝试调用 Modules\MyModule\Database\Seeders\MySeeder

Blade 组件

您的 Laravel Blade 组件 将自动注册到一个 组件命名空间 下。

一些示例

自定义默认模块结构

当您调用 modules:make 时，Modulr 会为您搭建一些基本的样板代码。如果您想自定义此行为，可以通过发布 modules.php 配置文件并添加自己的占位符来实现。

文件名和文件内容都支持许多占位符。这些包括

• StubBasePath
• StubModuleNamespace
• StubComposerNamespace
• StubModuleNameSingular
• StubModuleNamePlural
• StubModuleName
• StubClassNamePrefix
• StubComposerName
• StubMigrationPrefix
• StubFullyQualifiedTestCaseBase
• StubTestCaseBase