Laravel 5 の独自パッケージを作成する手順

少し前に第二の故郷、カナダのバンクーバーでの生活が始まり、最近は少し落ち着いてきたので、そろそろLaravel５（現在5.1）を見据えた活動をしていきたいと考えています。
ということで、今回はLaravel ５ の独自パッケージを作る手順を今回も備忘録的にお届けしたいと思います。

※ここでの開発手順を自動でやってくれるパッケージ「PackageCreator」を公開しました。詳しくは以下のページをご覧ください。
Laravel の独自パッケージを作成する「PackageCreator」を公開しました。

[結論] おそらく自由度が上がった分、より根本を理解する必要がでてきたなー、という印象です。


まず、前提として

１．Laravel 5以上（私の場合は5.1）がインストールされていること。
２．composer がインストールされていること。

として話を進めます。


では！
実際にパッケージの作成に移りましょう。
手順は以下の６点です。

１．パッケージ開発をするためのフォルダ構造を作成
２．composer.json を作成
３．Rootフォルダ直下にある composer.json にパッケージを追加
４．ServiceProvider を作成
５．パッケージのクラス本体を作成
６．ServiceProvider を登録

１．パッケージ開発をするためのフォルダ構造を作成


まずパッケージを開発するためのフォルダを作成します。

（Laravel５のフォルダ）/packages/Vendor/Package/src


※便宜上、ベンダー名には「Vendor」、パッケージ名は「Package」として説明します。
そのため、もしあなたの開発者名が「Sukohi」で、これから開発する独自パッケージが「Own」の場合は「（Laravel５のフォルダ）/packages/Sukohi/Own/src」となります。


２．composer.json を作成


１番で作成した （Laravel５のフォルダ）/package/Vendor/Package へコマンドで移動し、

composer init

を実行してください。色々と質問を聞かれるので自分にあった情報を打ち込み composer.json を作成します。

※composer.json は後でエディタで変更可能ですので、あまり深く考える必要はありません。


３．Rootフォルダ直下にある composer.json にパッケージを追加

以下のように「autoload/psr-4」内に独自パッケージのネームスペースとパスを追加します。

"autoload": {
    "psr-4": {
        "App\\": "app/",
        "Vendor\\Package\\": "packages/Vendor/Package/src"
    }
}

※もちろんカンマで区切ることで複数のパッケージを指定できます。



４．ServiceProvider を作成

「 （Laravel５のフォルダ）/packages/Vendor/Package/src」 内に PackageServiceProvider.php を作成し、以下をコピペする。

<?php namespace Vendor\Package;

use Illuminate\Support\ServiceProvider;

class PackageServiceProvider extends ServiceProvider {

    /**
     * Indicates if loading of the provider is deferred.
     *
     * @var bool
     */
    protected $defer = true;

    /**
     * Bootstrap the application events.
     *
     * @return void
     */
    public function boot()
    {
        //
    }

    /**
     * Register the service provider.
     *
     * @return void
     */
    public function register()
    {
        $this->app['package'] = $this->app->share(function($app)
        {
            return new Package;
        });
    }

    /**
     * Get the services provided by the provider.
     *
     * @return array
     */
    public function provides()
    {
        return ['package'];
    }

}

※実際には　　を以下のようにあなたのベンダー名とパッケージ名に置き換える必要があります。

PackageServiceProvider　・・・　（独自パッケージ名）ServiceProvider
package　・・・　（独自パッケージ名）
Vendor　・・・　（あなたの開発者名）


※独自に view を利用する場合は boot() 内に「loadViewsFrom()」で読み込みができます。
※独自にpublishする必要がある場合は同じく boot() 内で publishes() を使う。

詳しくはこちら
↓↓↓

Resources
Publishing File Groups


５．パッケージのクラス本体を作成

以下のようにネームスペース付きでクラスを作成

<?php namespace Vendor\Package;

class Package {

    // ここにプログラムを作成

}

６．ServiceProvider を登録


（Laravel５のフォルダ）/config/app.php に、


（i）ServiceProvider を登録

    'providers' => [

        // その他のServiceProvider

        /*
         * Package Service Providers
         */

        Vendor\Package\PackageServiceProvider::class,

    ],

（ii）エイリアスを登録

    'aliases' => [

        'Package'       => Illuminate\Support\Facades\Package::class,

    ]

（iii）コマンドラインでルートフォルダへ移動し、以下のコマンドを実行

composer dumpautoload -o

はい！
これで Controller 内などから

 Package::something();

という形で独自パッケージを呼び出すことができます。


[参考ページ]（参考というかほぼ全体的に訳しただけです^-^;）

https://laracasts.com/discuss/channels/tips/developing-your-packages-in-laravel-5

Thank you, davidxd33!
Your tip helped me out. :)))



■おまけ（Laravel5.1に関して）

※これからは実際に Laravel 5.1を使って開発をしていきたいと考えています。だけど、5.1は要件がPHP5.5.9以上ということもあり、いわゆるレンタルサーバーと呼ばれる環境では使えるようになるにはまだまだ時間がかかりそうってとこがネックになりそうですねー。


以上です。
おつかれさまでした！