README

此包包含一个PackageServiceProvider，您可以在包中使用它来轻松注册配置文件、迁移等。

以下是如何使用它的一个示例。

use Spatie\LaravelPackageTools\PackageServiceProvider;
use Spatie\LaravelPackageTools\Package;
use MyPackage\ViewComponents\Alert;

class YourPackageServiceProvider extends PackageServiceProvider
{
    public function configurePackage(Package $package): void
    {
        $package
            ->name('your-package-name')
            ->hasConfigFile()
            ->hasViews()
            ->hasViewComponent('spatie', Alert::class)
            ->hasViewComposer('*', MyViewComposer::class)
            ->sharesDataWithAllViews('downloads', 3)
            ->hasTranslations()
            ->hasAssets()
            ->hasRoute('web')
            ->hasMigration('create_package_tables')
            ->hasCommand(YourCoolPackageCommand::class);
    }
}

在内部，它将执行必要的操作来注册必要的内容并使各种文件可发布。

支持我们

我们在创建最佳开源包上投入了大量资源。您可以通过购买我们的付费产品来支持我们。

我们非常感谢您从家乡寄来明信片，说明您使用了我们的哪个包。您可以在我们的联系页面上找到我们的地址。我们将发布收到的所有明信片在我们的虚拟明信片墙上。

入门

此包对您应该如何构建包有意见。为了轻松入门，请考虑使用我们的package-skeleton存储库来开始您的包。该骨架结构完美地与包中的PackageServiceProvider配合使用。

用法

在您的包中，应该让您的服务提供程序扩展Spatie\LaravelPackageTools\PackageServiceProvider。

use Spatie\LaravelPackageTools\PackageServiceProvider;
use Spatie\LaravelPackageTools\Package;

class YourPackageServiceProvider extends PackageServiceProvider
{
    public function configurePackage(Package $package) : void
    {
        $package->name('your-package-name');
    }
}

传递包名称到name是强制性的。

处理配置文件

要注册配置文件，您应该在您的包的config目录中创建一个带有您的包名称的PHP文件。在此示例中，它应该位于<package root>/config/your-package-name.php。

如果您的包名称以laravel-开头，我们希望您的配置文件不包含该前缀。因此，如果您的包名称是laravel-cool-package，则配置文件应命名为cool-package.php。

要注册该配置文件，请在configurePackage方法中对$package调用hasConfigFile()。

$package
    ->name('your-package-name')
    ->hasConfigFile();

hasConfigFile方法还将使配置文件可发布。您的包的用户将能够使用此命令发布配置文件。

php artisan vendor:publish --tag=your-package-name-config

处理视图

您的包提供的任何视图都应该放置在<package root>/resources/views目录中。

您可以使用hasViews命令注册这些视图。

$package
    ->name('your-package-name')
    ->hasViews();

这将注册您的视图与Laravel。

如果您有一个视图<package root>/resources/views/myView.blade.php，您可以使用它像这样：view('your-package-name::myView')。当然，您也可以使用子目录来组织您的视图。位于<package root>/resources/views/subdirectory/myOtherView.blade.php的视图可以使用view('your-package-name::subdirectory.myOtherView')。

调用hasViews还将使视图可发布。您的包的用户将能够使用此命令发布视图

php artisan vendor:publish --tag=your-package-name-views

与视图共享全局数据

您可以使用sharesDataWithAllViews方法与所有视图共享数据。这将使共享变量对所有视图都可用。

$package
    ->name('your-package-name')
    ->sharesDataWithAllViews('companyName', 'Spatie');

处理Blade视图组件

您的包提供的任何Blade视图组件都应该放置在<package root>/Components目录中。

您可以使用 hasViewComponents 命令来注册这些视图。

$package
    ->name('your-package-name')
    ->hasViewComponents('spatie', [Alert::class]);

这将注册您的视图组件到 Laravel。对于 Alert::class，您可以在视图中使用 <x-spatie-alert /> 来引用，其中 spatie 是注册时提供的名称前缀。

调用 hasViewComponents 还会使视图组件可发布，并将发布到 app/Views/Components/vendor/<包名>。

您的包用户可以使用此命令发布视图组件

php artisan vendor:publish --tag=your-package-name-components

处理视图组合器

您可以使用 hasViewComposers 方法注册项目中使用的任何视图组合器。您也可以注册一个接收 $view 参数的回调，而不是类名。

要为所有视图注册视图组合器，请使用通配符作为视图名称 '*'。

$package
    ->name('your-package-name')
    ->hasViewComposer('viewName', MyViewComposer::class)
    ->hasViewComposer('*', function($view) { 
        $view->with('sharedVariable', 123); 
    });

处理翻译

您的包提供的任何翻译都应该放在 <包根目录>/resources/lang/<语言代码> 目录中。

您可以使用 hasTranslations 命令来注册这些翻译。

$package
    ->name('your-package-name')
    ->hasTranslations();

这将注册翻译到 Laravel。

假设您将此翻译文件保存在 <包根目录>/resources/lang/en/translations.php...

<?php

return [
    'translatable' => 'translation',
];

...您的包和用户可以使用以下方式检索翻译

trans('your-package-name::translations.translatable'); // returns 'translation'

如果您的包名以 laravel- 开头，那么在上面的示例中您应该省略它。

调用 hasTranslations 也会使翻译可发布。您的包用户可以使用此命令发布翻译

php artisan vendor:publish --tag=your-package-name-translations

处理资产

您的包提供的任何资产都应该放在 <包根目录>/resources/dist/ 目录中。

您可以使用 hasAssets 方法使这些资产可发布。

$package
    ->name('your-package-name')
    ->hasAssets();

您的包用户可以使用此命令发布资产

php artisan vendor:publish --tag=your-package-name-assets

这将把资产复制到您的包安装的应用的 public/vendor/<您的包名> 目录中。

处理迁移

PackageServiceProvider 假设任何迁移都放在此目录中：<包根目录>/database/migrations。在此目录中您可以放置任何迁移。确保它们都具有 php.stub 扩展。使用此扩展将确保静态分析器在迁移发布时不会因类存在于多个位置而混淆。

要注册迁移，您应将没有扩展的迁移名称传递给 hasMigration 表。

如果您的迁移文件名为 create_my_package_tables.php.stub，您可以这样注册它们

$package
    ->name('your-package-name')
    ->hasMigration('create_my_package_tables');

如果您的包包含多个迁移文件，您只需多次调用 hasMigration 或使用 hasMigrations。

$package
    ->name('your-package-name')
    ->hasMigrations(['my_package_tables', 'some_other_migration']);

调用 hasMigration 也会使迁移可发布。您的包用户可以使用此命令发布迁移

php artisan vendor:publish --tag=your-package-name-migrations

正如您所期望的，发布的迁移文件将使用当前日期和时间进行前缀。

注册命令

您可以使用 hasCommand 函数注册您的包提供的任何命令。

$package
    ->name('your-package-name')
    ->hasCommand(YourCoolPackageCommand::class);

如果您的包提供多个命令，您可以使用多次 hasCommand 或将数组传递给 hasCommands

$package
    ->name('your-package-name')
    ->hasCommands([
        YourCoolPackageCommand::class,
        YourOtherCoolPackageCommand::class,
    ]);

处理路由

PackageServiceProvider 假设任何路由文件都放在此目录中：<包根目录>/routes。在此目录中您可以放置任何路由文件。

要注册您的路由，您应将没有扩展的路由名称传递给 hasRoute 方法。

如果您的路由文件名为 web.php，您可以这样注册它们

$package
    ->name('your-package-name')
    ->hasRoute('web');

如果您的包包含多个路由文件，您只需多次调用 hasRoute 或使用 hasRoutes。

$package
    ->name('your-package-name')
    ->hasRoutes(['web', 'admin']);

使用生命周期钩子

您可以在以下方法之一中放置您包启动时需要的任何自定义逻辑

• registeringPackage：将在 PackageServiceProvider 的 register 方法开始时被调用
• packageRegistered：将在 PackageServiceProvider 的 register 方法结束时调用
• bootingPackage：将在 PackageServiceProvider 的 boot 方法开始时调用
• packageBooted：将在 PackageServiceProvider 的 boot 方法结束时调用

测试

composer test

变更日志

请参阅 变更日志 了解最近的变化信息。

贡献

请参阅 贡献指南 了解详细信息。

安全漏洞

请查看 我们的安全策略 了解如何报告安全漏洞。

鸣谢

• Freek Van der Herten
• 所有贡献者

许可证

MIT 许可证 (MIT)。请参阅 许可证文件 了解更多信息。