naviisml/laravel-package

此包已被废弃，不再维护。未建议替代包。

创建 Laravel 包的工具

维护者

详细信息

github.com/naviisml/laravel-package

主页

源代码

问题

安装: 72

依赖: 0

建议者: 0

安全性: 0

星标: 0

关注者: 1

分支: 0

公开问题: 0

1.0.0 2024-05-07 21:26 UTC

Requires

MIT c442d926f510ba838fd0059575e8f4960965c635

  • Navi Ismail <contact.woop@navel.dev>

packagetoolslaravelnaviiisml

This package is auto-updated.

Last update: 2024-08-07 21:58:01 UTC

README

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

以下是如何使用的示例。

use Naviisml\Package\PackageServiceProvider;
use Naviisml\Package\Package;
use MyPackage\ViewComponents\Alert;
use Naviisml\Package\Commands\InstallCommand;

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()
            ->publishesServiceProvider('MyProviderName')
            ->hasRoute('web')
            ->hasMigration('create_package_tables')
            ->hasCommand(YourCoolPackageCommand::class)
            ->hasInstallCommand(function(InstallCommand $command) {
                $command
                    ->publishConfigFile()
                    ->publishMigrations()
                    ->copyAndRegisterServiceProviderInApp()
                    ->askToStarRepoOnGitHub();
            });
    }
}

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

支持我们

我们投入了大量资源来创建一流的开放式源代码包。您可以通过购买我们的付费产品之一来支持我们。

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

入门

此包对您如何构建包有一定的看法。为了轻松开始，请考虑使用我们的 package-skeleton 仓库来开始您的包。该框架结构得非常好，可以与包中的 PackageServiceProvider 完美配合。

用法

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

use Naviisml\Package\PackageServiceProvider;
use Naviisml\Package\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

注意

如果您使用自定义视图命名空间，则应将发布命令更改为如下

php artisan vendor:publish --tag=custom-view-namespace-views

使用视图共享全局数据

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

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

与Blade视图组件一起工作

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

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

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

这将注册您的视图组件到Laravel。在 Alert::class 的情况下，它可以在视图中引用为 <x-spatie-alert />，其中 spatie 是您在注册期间提供的前缀。

调用 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...

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

正如您所期望的，已发布的迁移文件将带有当前日期和时间的前缀。

您还可以启用迁移的注册，而无需用户发布它们

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

使用可发布的服务提供者

一些包需要在Laravel应用的 app\Providers 目录中复制一个示例服务提供者。例如，考虑 laravel/horizon 包，它将一个 HorizonServiceProvider 复制到您的应用程序中，并带有一些合理的默认设置。

$package
    ->name('your-package-name')
    ->publishesServiceProvider($nameOfYourServiceProvider);

需要复制到应用中的文件应存储在您的包中，路径为 /resources/stubs/{$nameOfYourServiceProvider}.php.stub。

当您的包安装到应用中时，运行以下命令...

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

... 将会将您的包中的 /resources/stubs/{$nameOfYourServiceProvider}.php.stub 复制到用户应用中的 app/Providers/{$nameOfYourServiceProvider}.php。

注册命令

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

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

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

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

添加安装命令

您可以选择添加一个安装命令，一次完成发布配置文件、迁移和其他文件的工作。Laravel Horizon 和 Livewire 等包提供了此类命令。

在使用 Laravel 包工具时，您无需自己编写 InstallCommand。相反，您可以直接调用 hasInstallCommand 并使用闭包进行配置。以下是一个示例。

use Naviisml\Package\PackageServiceProvider;
use Naviisml\Package\Package;
use Naviisml\Package\Commands\InstallCommand;

class YourPackageServiceProvider extends PackageServiceProvider
{
    public function configurePackage(Package $package): void
    {
        $package
            ->name('your-package-name')
            ->hasConfigFile()
            ->hasMigration('create_package_tables')
            ->publishesServiceProvider('MyServiceProviderName')
            ->hasInstallCommand(function(InstallCommand $command) {
                $command
                    ->publishConfigFile()
                    ->publishMigrations()
                    ->askToRunMigrations()
                    ->copyAndRegisterServiceProviderInApp()
                    ->askToStarRepoOnGitHub('your-vendor/your-repo-name')
            });
    }
}

配置完成后，包用户可以调用此命令

php artisan your-package-name:install

使用上述代码，该命令将

  • 发布配置文件
  • 发布迁移文件
  • 将您的包中的 /resources/stubs/MyProviderName.php.stub 复制到 app/Providers/MyServiceProviderName.php，并在 config/app.php 中注册该提供者
  • 询问是否现在运行迁移
  • 提示用户在浏览器中打开 https://github.com/'your-vendor/your-repo-name' 以星标该项目

您还可以在 InstallCommand 上调用 startWith 和 endWith。它们将分别在运行 php artisan your-package-name:install 时开始和结束时执行。您可以使用此功能执行额外的工作或显示额外的输出。

use use Naviisml\Package\Commands\InstallCommand;

public function configurePackage(Package $package): void
{
    $package
        // ... configure package
        ->hasInstallCommand(function(InstallCommand $command) {
            $command
                ->startWith(function(InstallCommand $command) {
                    $command->info('Hello, and welcome to my great new package!')
                })
                ->publishConfigFile()
                ->publishMigrations()
               ->askToRunMigrations()
                ->copyAndRegisterServiceProviderInApp()
                ->askToStarRepoOnGitHub('your-vendor/your-repo-name')
                ->endWith(function(InstallCommand $command) {
                    $command->info('Have a great day!');
                })
        });
}

处理路由

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

变更日志

有关最近更改的更多信息，请参阅 变更日志。

贡献

有关详细信息，请参阅 贡献指南。

安全漏洞

有关报告安全漏洞的说明，请参阅 我们的安全策略。

致谢

许可证

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