theriddleofenigma/laravel-package-tools

Laravel 包创建工具

维护者

详细信息

github.com/theriddleofenigma/laravel-package-tools

主页

源代码

问题

安装: 8

依赖者: 0

建议者: 0

安全: 0

星标: 0

关注者: 1

分支: 0

开放问题: 0

v0.1.2 2022-02-25 17:31 UTC

Requires

Requires (Dev)

MIT d2650460170c19b400190d180d6380fc2b6aa600

laravel-package-toolstheriddleofenigma

This package is auto-updated.

Last update: 2024-09-25 22:53:23 UTC

README

Latest Version on Packagist Tests Total Downloads

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

以下是一个使用示例。

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

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

在底层，它将执行必要的操作来注册必要的事物，并使各种文件可发布。

入门指南

此包对您应如何构建包的结构有意见。要轻松入门，请考虑使用 我们的package-skeleton仓库 来开始您的包。该骨架结构得非常好，可以与该包中的 PackageServiceProvider 完美配合。

用法

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

use Enigma\LaravelPackageTools\PackageServiceProvider;
use Enigma\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

如果您的包有多个配置文件，您可以将它们的名称作为数组传递给 hasConfigFile。

$package
    ->name('your-package-name')
    ->hasConfigFile(['my-config-file', 'another-config-file']);

处理视图

您的包提供的任何视图都应放置在 <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 方法。

$package
    ->name('your-package-name')
    ->hasViews('custom-view-namespace');

现在您可以使用包的视图如下

view('custom-view-namespace::myView');

发布视图

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

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

与视图共享全局数据

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

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

处理 Blade 视图组件

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

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

$package
    ->name('your-package-name')
    ->hasViewComponents('enigma', Alert::class);

这将注册您的视图组件与 Laravel。对于 Alert::class，在视图中可以引用为 <x-enigma-alert />，其中 enigma 是您在注册过程中提供的前缀。

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

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

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); 
    });

与翻译一起工作

您的包提供的任何翻译都应放在 <package root>/resources/lang/<language-code> 目录中。

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

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

这将注册翻译到 Laravel。

假设您将此翻译文件保存到 <package root>/resources/lang/en/translations.php...

<?php

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

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

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

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

使用翻译字符串作为键进行编码，您应该在 <package root>/resources/lang/<language-code>.json 中创建 JSON 文件。

例如，创建一个类似这样的 <package root>/resources/lang/it.json 文件

{
    "Hello!": "Ciao!"
}

...的输出...

trans('Hello!');

...如果应用程序使用意大利语，输出将是 Ciao!。

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

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

与资产一起工作

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

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

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

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

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

这将把资产复制到应用程序中的 public/vendor/<your-package-name> 目录中，其中您的包已安装。

与迁移一起工作

PackageServiceProvider 假设任何迁移都放在此目录中：<package root>/database/migrations。在该目录中，您可以放置任何迁移。

要注册您的迁移，您应将不带扩展名的迁移名称传递给 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 假设任何路由文件都放在此目录中：<package root>/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

贡献

有关详细信息，请参阅CONTRIBUTING

安全漏洞

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

鸣谢

许可证

MIT 许可证 (MIT)。有关更多信息，请参阅许可证文件