コマンド on ララジャパン

Laravel Zero（２）データベースを使う

Wed, 21 Aug 2024 06:45:57 +0900

前回に紹介したLaravel Zeroはとても有用そうです。しかし、データベースの操作を行うことができなければですね。ということで、今回はその機能を追加します。さらに、もちろん私の好きなtinkerも使えるようにします。

データベース機能の追加

前回と同じプロジェクトの続きとして、データベース機能を追加します。前回では、applicationをartisanに改名したことをお忘れずに。

$ php artisan app:install database
Installing database component...
...
Require package via Composer: ✔
Creating a default SQLite database: ✔
Creating migrations folder: ✔
Creating seeders folders and files: ✔
Creating factories folder: ✔
Creating default database configuration: ✔
Updating .gitignore: ✔
...

上の実行により、Laravelでお馴染みのconfig/database.phpも追加されるので、.envに以下を追加します。

.env

...
DB_CONNECTION=mysql
DB_HOST=localhost
DB_DATABASE=zero
DB_USERNAME=root
DB_PASSWORD=password

準備が整ったら、これまたLaravelでお馴染みのEloquentのクエリの実行などが使えます。

use App\User;
use Illuminate\Support\Facades\DB;

$users = User::all(); // Eloquent

$users = DB::table('users')->get(); // Query Builder

Tinker

私には大好きなツールですが、これもデフォルトではLaravel Zeroにはデフォルトで装備されていません。外部パッケージとなっているので、composerでインストールします。

$ composer require intonate/tinker-zero

さらに、config/app.phpを編集して以下の行を追加します。

config/app.php

'providers' => [
    App\Providers\AppServiceProvider::class,
　　Intonate\TinkerZero\TinkerZeroServiceProvider::class, // これを追加！
],

実行してみましょう。こちらも、前回にapplicationをartisanに改名したことをお忘れずに。

$ php artisan tinker
Psy Shell v0.12.4 (PHP 8.2.15 — cli) by Justin Hileman
> use App\User;
> User::count();
> 4

参照

Laravel Zero（１）コマンドの作成

Thu, 15 Aug 2024 00:10:23 +0900

今でも覚えています。Laravelを使い始めた時にとても気に入ったのがartisanコマンドであったことを。その当時の他のPHPフレームワークと異なり、Laravelでは最初からコマンドの開発がMVCのUIの開発と肩を並べて上級扱いされていました。Unix系のコマンドに慣れている私には感激でした。しかし、コマンドだけの開発しか必要ないときがあります。つまりブラウザの画面を必要としない開発です。そのようなときにLaravelをインストールすると、ウェブのためのコントローラなどが一緒についてくるので煩わしく思えます。そこで登場するのが、Laravel Zeroです。

Laravel Zeroとは

Laravel Zero（ゼロ）は、Laravelのコアの開発者であるNuno Maduros氏が開発したコマンド開発に特化したフレームワークです。ここでは、以前に記事としたGoogle AnalyticsのデータをAPIで取得（２）コマンドを作成のコマンドを、Laravel Zeroでその説明とともに書き直します。

インストール

Laravelと同様に、Laravel Zeroはcomposerを利用してプロジェクトを作成します。

$ composer create-project --prefer-dist laravel-zero/laravel-zero ga4

現時点では、Laravel 11xをもとにしているのでPHP 8.2が必要ですが、まだその環境が用意されていないなら、例えばLaravel 10xのPHP 8.1なら、以下のようにブランチを指定してインストールも可能です。

$ composer create-project --prefer-dist laravel-zero/laravel-zero:10.x ga4

インストール後に、ディレクトリを見てみましょう。

$ ls -al
app/
bootstrap/
config/
tests/
vendor/
application
box.json
composer.json
composer.lock
.editorconfig
.gitattributes
.gitignore
phpunit.xml.dist
README.md

Laravelがインストールされたディレクトリと似ていますが、database, public, resources, routes, storageなどのディレクトリがありません。また、artisanや.envのファイルもありません。

appのディレクトリの中身を見てみると、

$ tree app
app
├── Commands
│   └── InspireCommand.php
└── Providers
    └── AppServiceProvider.php

すっきりしてこれだけなのです。しかも、InsupireCommand.phpはデモのコマンドです。

最初のコマンドの作成

早速、Google Analyticsからデータを取得するコマンドを作成しましょう。

コマンドの作成のためのコマンドはLaravelと似ていますが、以下のようにartisanの代わりにapplicationを使います。

$ php application make:command Ga4Command

上で作成されるファイルは、app/Console/Commandsではなくapp/Commandsに置かれます。これを編集します。

app/Commands/Ga4Command.php

namespace App\Commands;

use Google\Analytics\Data\V1beta\Metric;
use Google\Analytics\Data\V1beta\OrderBy;
use Google\Analytics\Data\V1beta\DateRange;
use Google\Analytics\Data\V1beta\Dimension;
use Google\Analytics\Data\V1beta\OrderBy\MetricOrderBy;
use Google\Analytics\Data\V1beta\BetaAnalyticsDataClient;
use Illuminate\Support\Str;
use LaravelZero\Framework\Commands\Command;

class Ga4Command extends Command
{
    /**
     * The name and signature of the console command.
     *
     * @var string
     */
    protected $signature = 'ga4';

    /**
     * The console command description.
     *
     * @var string
     */
    protected $description = 'Get GA4 data';

    /**
     * Execute the console command.
     */
    public function handle()
    {
        $client = new BetaAnalyticsDataClient([
            'credentials' => storage_path('ga4.key'),
        ]);

        $response = $client->runReport([
            'property' => 'properties/'.config('google.ga4.property_id'),
            'dateRanges' => [
                new DateRange([
                    'start_date' => '28daysAgo',
                    'end_date'   => 'today',
                ]),
            ],
            'dimensions' => [
                new Dimension(['name' => 'pageTitle']),
                new Dimension(['name' => 'pagePath']),
            ],
            'metrics' => [
                new Metric(['name' => 'screenPageViews']),
            ],
            'orderBys' => [
                new OrderBy([
                    'metric' => new MetricOrderBy([
                        'metric_name' => 'screenPageViews',
                    ]),
                    'desc'   => true,
                ]),
            ],
            'limit' => 100,
        ]);

        $rows = [];

        foreach ($response->getRows() as $row) {
            $title = $row->getDimensionValues()[0]->getValue() ?? null;
            $url = $row->getDimensionValues()[1]->getValue() ?? null;
            $count = $row->getMetricValues()[0]->getValue() ?? null;

            if ($url === '/') {
                continue;
            }

            $rows[] = (object) [
                'title' => Str::before($title, ' – ララジャパン'),
                'url'   => $url,
                'views' => $count,
            ];
        }

        $html = view('ranking', compact('rows'))->render();

        echo $html;

        return Command::SUCCESS;
    }
}

Google AnalyticsのデータをAPIで取得（２）コマンドを作成に掲載されているコードと比べると、唯一の違いはnamespaceのパスと継承するCommandのクラスがLaravelZero\Framework\Commands\Commandと変わっただけです。

このコマンドを実行可能とさせるには、インストールすべきライブラリがいくつかあります。

まず、Googleのライブラリです。

$ composer require google/analytics-data

そして、Google AnalyticsのプロパティIDを保存する、.envも必要なのでdotenvのライブラリを以下のようにインストールします。しかし、composerではなく、ゼロのコマンドのapp:installオプションでインストールします。以下のように、.env, .env.exampleなどのLaravelではお馴染みのファイルがここで初めて作成されます。どうしてこれがプロジェクトを作成したときにインストールされないのはちょいと不思議。

$ php application app:install dotenv
Installing dotenv component...
Creating .env: ✔
Creating .env.example: ✔
Updating .gitignore: ✔

さらに、Ga4Commandでは、出力にブレードを使うのでview()のヘルパーも必要です。こちらのインストールはこれもapp:installを使用します。

$ php application app:install view
Installing view component...
...
Require package via Composer: ✔
Creating resources/views folder: ✔
Creating default view configuration: ✔
Creating cache storage folder: ✔

これで、resources/viewsのディレクトリや、storageのディレクトリも作成されます。だんだんとLaravelらしくなってきましたね。

実行をartisanとする

コマンドが作成されたところで、実行と行きましょう。実行するには、以下のコマンドラインとなります。

$ php application ga4

このapplicationが気に入らないなら違う名前にもできます。例えば、Laravelに合わせてartisanにしてみましょう。以下の改名コマンドにおいてartisanを指定します。

$ php application app:rename artisan
Renaming the application...
Renaming application to "artisan": ✔
Updating config/app.php "name" property: ✔
Updating composer "bin": ✔

実行のコマンドラインは、以下のようになります。

$ php artisan ga4

参照

Laravel Zero（２）データベースを使う

メンテナンス画面：php artisan up & down

Sun, 08 Nov 2020 05:10:45 +0900

Laravelの経験が長くなると、つまり初期のバージョンから使用していると、昔のやり方しか知らずに過ごしていることがあります。以前にメンテナンス画面の裏口のポストがありますが、それはバージョン5.1の話で、大昔です。ということでやり方学びなおします。

メンテンナンス画面

プログラムの更新をインストールしたり、データベースに変更をしたりするときは、誰にも作業中にアクセスしてもらいたくありません。そのときに、以下を実行します。

$ php artisan down

これを実行すると、アクセスしてきたら、以下のような画面が表示されます。それで安心して、プログラムを更新したり、データベースを変更したり、など好き勝手なことできます。

メンテナンスが完了したら、

$ php artisan up

を実行して、皆にアクセスできるようにします。

メンテンナンス画面にメッセージを表示したいなら、

$ php artisan down --message="メンテナンス中です。午前３時に終了します。"

と実行すると以下のように、メッセージが表示されます。

便利ですね。

私がアクセスしたい

メンテナンスの間、好き勝手なことをするのはいいのですが、私自身がサイトにアクセスできないと困ります。プログラムの更新をテストすることなどができません。

特定のIPアドレスからアクセスできるようにする、つまり裏口を作る必要あります。

ここが以前（古いLaravelのバージョン）と最近のバージョンが違うところです。

$ php artisan down --message="メンテナンス中です。午前３時に終了します。" --allow=192.168.56.1

のように、–allowの引数で自分のIPアドレスを指定するだけで、私にとってはアクセス可能となります。

さらに、毎回毎回コマンドラインで指定するのが面倒なら、以前のように

app/Http/Middleware/CheckForMaintenanceMode.php

namespace App\Http\Middleware;

use Closure;
use Symfony\Component\HttpFoundation\IpUtils;

use Illuminate\Foundation\Http\Middleware\CheckForMaintenanceMode as Middleware;

class CheckForMaintenanceMode extends Middleware
{
    /**
     * The URIs that should be reachable while maintenance mode is enabled.
     *
     * @var array
     */
    protected $except = [
    	//
    ];

    protected $allowed = [
    	'192.168.56.1'　// ここで許可するIPを登録
    ];

    /**
     * Handle an incoming request.
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  \Closure  $next
     * @return mixed
     *
     * @throws \Symfony\Component\HttpKernel\Exception\HttpException
     * @throws \Illuminate\Foundation\Http\Exceptions\MaintenanceModeException
     */
    public function handle($request, Closure $next)
    {
        if ($this->app->isDownForMaintenance()) {

            if (IpUtils::checkIp($request->ip(), (array) $this->allowed)) {
                return $next($request);
            }
        }

        return parent::handle($request, $next);　// ここで親の関数を呼ぶ
    }
}

と編集します。

メンテナンス画面をカスタマイズしたいなら

メンテナンス画面をカスタマイズしたいなら、まず、以下を実行してブレードを作成します。

$ php artisan vendor:publish --tag=laravel-errors

resources/viewsのディレクトリにerrorsサブディレクトリが作成されて以下のファイルがコピーされます。

errors
├── 401.blade.php
├── 403.blade.php
├── 404.blade.php
├── 419.blade.php
├── 429.blade.php
├── 500.blade.php
├── 503.blade.php
├── illustrated-layout.blade.php
├── layout.blade.php
└── minimal.blade.php

メンテナンス画面のカスタマイズのために編集するファイル、503.blade.phpです。503は、Service Unavailable、つまり「サービスは利用できません」のウェブステータスです。

artisanのコマンドは実行できる？

最後に、メンテナンス中に、クロンで設定されているphp artisanのコマンドは実行されるかどうかですが、php aritsan upが実行できるのだからもちろん実行可能です。ということは、メンテナンス中においてクロンのサービスをいったん止めることも必要かもしれません。ご注意を。

Laravel 5.6でわかりやすくなったコマンドエラー表示

Mon, 13 May 2019 04:11:12 +0900

まだまだLaravelのバージョン5.5から進まない私ですが、5.6以降のバージョン（最新は5.8）を使い始めて、いいと思った改善です。

Laravel5.5では、ウェブアプリなら実行でエラーがあると、以下のようにエラーの情報を見せてくれてすぐにどこが悪いかわかります。

しかし、コマンドライン実行のartisanのコマンドでは、以下のようにエラーがあるのはわかるのだけれど、laravel.logを見なければすぐにどこが問題かわからない。

これが、5.6以降のバージョンとなると、以下のように表示してくれて、わかりやすくなりました。

知らなかったコマンドの自動登録

Sat, 06 Apr 2019 03:01:35 +0900

これまた、5.5で登場した機能で今まで知らなかった機能がありました。

Laravelではウェブだけでなく、コマンドラインで実行できるプログラムの開発も対応しています。開発は非常に簡単で、以下を実行すると、

$ php artisan make:command CommandProgram

app/Console/Commands/CommandProgram.phpの雛形のファイルを作成してくれます。

そのプログラムの実行には、app/Console/Kernel.phpを編集して、$commandsに以下の14行目のように追加して登録します。

app/Console/Kernel.php

namespace App\Console;

use Illuminate\Console\Scheduling\Schedule;
use Illuminate\Foundation\Console\Kernel as ConsoleKernel;

class Kernel extends ConsoleKernel
{
    /**
     * The Artisan commands provided by your application.
     *
     * @var array
     */
    protected $commands = [
        Commands\CommandProgram::class, //ここに新規のコマンドを入れる
    ];

    /**
     * Define the application's command schedule.
     *
     * @param  \Illuminate\Console\Scheduling\Schedule  $schedule
     * @return void
     */
    protected function schedule(Schedule $schedule)
    {
        // $schedule->command('inspire')
        //          ->hourly();
    }

    /**
     * Register the Closure based commands for the application.
     *
     * @return void
     */
    protected function commands()
    {
        require base_path('routes/console.php');
    }
}

登録されたら、artisanコマンドのリストに表示されます。

$ php artisan
Available commands:
...
 command
  command:name         Command description
...

というのが5.4までだったのですが、5.5からはもうこの手間はもうなくなりました。 app/Console/Commandsのディレクトリにファイルを作成すれば、Kernel.phpを編集しなくても自動的に登録してくれます。

どうしてこうなるかというと、5.5のKernel.phpを見てみましょう。

namespace App\Console;

use Illuminate\Console\Scheduling\Schedule;
use Illuminate\Foundation\Console\Kernel as ConsoleKernel;

class Kernel extends ConsoleKernel
{
    /**
     * The Artisan commands provided by your application.
     *
     * @var array
     */
    protected $commands = [
        //
    ];

    /**
     * Define the application's command schedule.
     *
     * @param  \Illuminate\Console\Scheduling\Schedule  $schedule
     * @return void
     */
    protected function schedule(Schedule $schedule)
    {
        // $schedule->command('inspire')
        //          ->hourly();
    }

    /**
     * Register the commands for the application.
     *
     * @return void
     */
    protected function commands()
    {
        $this->load(__DIR__.'/Commands'); // ここが5.5から追加された行

        require base_path('routes/console.php');
    }
}

メソッドのcommands()に、新しい行（36行目）が追加されています。そして、その1行が自動登録を行ってくれるのです！

コマンドラインで実行するプログラムのほとんどは、クロンジョブでスケジュールして実行されるプログラムですが、ときどき、アップした画像のサイズを変えるとか、DBのある項目の値をすべて更新変するとか、のバッチジョブが必要になることあります。

そのようなときは、管理のために、app/Console/Tasksのディレクトリを作成して、クロンジョブのプログラムと分けます。そして、もちろんこれらの登録は、以下のようにして自動にすればよいです。今度は配列で引数を渡していることに注意を。

...
    protected function commands()
    {
        $this->load([__DIR__.'/Commands', __DIR__.'/Tasks']); // ここが5.5から追加された行

        require base_path('routes/console.php');
    }
}