Tinker on ララジャパン

request()ヘルパーが変？

Sun, 29 Aug 2021 05:37:09 +0900

以前に「ティンカーでリクエスト（Request）」で、ティンカーにおいてRequestのオブジェクトをシミュレートできることを紹介しました。あれから数年、ヘルパー関数のrequest()にもティンカーで値を追加できる技を取得しました。

request()に値がない

まず、以前のティンカーでのRequestオブジェクトの作成をここで再現します。

Psy Shell v0.10.8 (PHP 7.4.21 — cli) by Justin Hileman
>>>  $request = \Illuminate\Http\Request::create('http://localhost', 'GET', ['name' => 'test']);
=> Illuminate\Http\Request {#5238
     +attributes: Symfony\Component\HttpFoundation\ParameterBag {#5234},
     +request: Symfony\Component\HttpFoundation\InputBag {#5236},
     +query: Symfony\Component\HttpFoundation\InputBag {#5235},
     +server: Symfony\Component\HttpFoundation\ServerBag {#5231},
     +files: Symfony\Component\HttpFoundation\FileBag {#5232},
     +cookies: Symfony\Component\HttpFoundation\InputBag {#5233},
     +headers: Symfony\Component\HttpFoundation\HeaderBag {#5230},
   }
>>>  $request->all()
=> [
     "name" => "test",
   ]
>>> $request->name
=> "test"
>>>

そして、このRequestオブジェクトを利用して簡単にバリデーションのテストもできます。

>>> $request->validate(['name' => 'required|alpha'])
=> [
     "name" => "test",
   ]
>>> $request->validate(['name' => 'required|numeric'])
Illuminate\Validation\ValidationException with message 'The given data was invalid.'
>>>

しかし、このオブジェクトでは、ヘルバーを使うと期待した値が返ってきません。

>>> request('name')
=> null　// "test"と返ってきて欲しい！

どうしてでしょう？

グローバルのRequestオブジェクト

request()の定義を見ると、

vendor/laravel/framework/src/Illuminate/Foundation/helpers.php

...
    /**
     * Get an instance of the current request or an input item from the request.
     *
     * @param  array|string|null  $key
     * @param  mixed  $default
     * @return \Illuminate\Http\Request|string|array
     */
    function request($key = null, $default = null)
    {
        if (is_null($key)) {
            return app('request');
        }

        if (is_array($key)) {
            return app('request')->only($key);
        }

        $value = app('request')->__get($key);

        return is_null($value) ? value($default) : $value;
    }
...

app(‘request’)というのがヘルパーで使用しているRequestのオブジェクトのようです。ティンカーでタイプしてみると、

>>> app('request');
=> Illuminate\Http\Request {#77
     +attributes: Symfony\Component\HttpFoundation\ParameterBag {#68},
     +request: Symfony\Component\HttpFoundation\InputBag {#70},
     +query: Symfony\Component\HttpFoundation\InputBag {#65},
     +server: Symfony\Component\HttpFoundation\ServerBag {#69},
     +files: Symfony\Component\HttpFoundation\FileBag {#74},
     +cookies: Symfony\Component\HttpFoundation\InputBag {#73},
     +headers: Symfony\Component\HttpFoundation\HeaderBag {#76},
   }

先に作成したRequestのオブジェクトのIDは、#5238なのにこちらは#77で、Laravelのプログラムの実行（ティンカーの実行）のかなり初期に作成されたオブジェクトということがわかります。そして、そのオブジェクトはLaravelがサービスコンテナーとして管理するグローバルにアクセス可能なRequestのオブジェクトです。

そして、以下のようにこのオブジェクトに値を追加することも可能なのです。

>>> app('request')->all();
=> []
>>> app('request')->merge(['name' => 'test']);
=> Illuminate\Http\Request {#77
     +attributes: Symfony\Component\HttpFoundation\ParameterBag {#68},
     +request: Symfony\Component\HttpFoundation\InputBag {#70},
     +query: Symfony\Component\HttpFoundation\InputBag {#65},
     +server: Symfony\Component\HttpFoundation\ServerBag {#69},
     +files: Symfony\Component\HttpFoundation\FileBag {#74},
     +cookies: Symfony\Component\HttpFoundation\InputBag {#73},
     +headers: Symfony\Component\HttpFoundation\HeaderBag {#76},
   }
>>> app('request')->all();
=> [
     "name" => "test",
   ]
>>> app('request')->name
=> "test"

そして、ヘルパーでも値を取得できるようになります。

>>> request('name')
=> "test"

tinkerでartisanを実行

Mon, 18 Jan 2021 04:23:35 +0900

debugbarを使うとコントローラでのDB処理に使用されるSQL文をブラウザ画面でデバッグ文をわざわざ挿入することなしに見ることができます。しかし、php artisanのコマンドラインの実行では同様なことできません。さて、どうしたらよいでしょうか？

まず、テストコマンドの作成から、

$ php artisan make:command TestCommand

この実行で、TestCommand.php が作成されます。これを以下のように編集します。

app/Console/Commands/TestCommand.php

namespace App\Console\Commands;

use App\User;
use Illuminate\Console\Command;

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

    /**
     * The console command description.
     *
     * @var string
     */
    protected $description = 'テストコマンド';

    /**
     * Create a new command instance.
     *
     * @return void
     */
    public function __construct()
    {
        parent::__construct();
    }

    /**
     * Execute the console command.
     *
     * @return int
     */
    public function handle()
    {
        $count = User::count();

        echo "会員の数：$count\n";

        return 0;
    }
}

まず、通常のコマンドラインからの実行で動作確認です。

$ php artisan command:test
会員の数：1

大丈夫ですね。

さて、その実行でどのようなSQL文が実行されているかをチェックするには、そう、tinkerの登場です。以下はtinkerの１セッションですが、説明のために分割されているので注意を。

$ php artisan tinker
Psy Shell v0.10.4 (PHP 7.3.14 — cli) by Justin Hileman

まず、DBクエリのログ機能をオンにします。

>>> DB::enableQueryLog();
=> null

次に、コマンドの実行です。そうです、Artisan::call()の関数の引数にコマンド名を指定するだけなのです。

>>> Artisan::call('command:test');
会員の数：1
=> 0

次に、貯めたログを出力します。

>>> DB::getQueryLog();
=> [
     [
       "query" => "select count(*) as aggregate from `users`",
       "bindings" => [],
       "time" => 14.32,
     ],
   ]
>>>

SQL文が見れましたね。

DB::enableQueryLog()などを毎回毎回tinkerのセッションでタイプするのが面倒なら、以前のこの記事のようにブートストラップのファイルを作成しておくと、

$ php artisan tinker ~/tinker.php
>>> Artisan::call('command:test');
会員の数：1
=> 0
>>> sql()
=> [
     [
       "query" => "select count(*) as aggregate from `users`",
       "bindings" => [],
       "time" => 14.29,
     ],
   ]
>>>

と簡単になります。

私は、シェルのエイリアスとして、.zshrcファイルに入れています。

...
alias tinker='php artisan tinker ~/tinker.php'
...

route()ヘルパー

Sat, 19 Sep 2020 06:44:13 +0900

Laravelのヘルパーの関数は本当に便利なもので、日常よく使うものです。しかし、こんな使い方もあったのか、と知らない使い方を知って嬉しくなることあります。今回は私を嬉しくさせる、route()のヘルパーの紹介です。

私はrouteに名前を付けるのが好きで、プログラムのrouteにはすべて名前がついています。それゆえに、route()のヘルパーは欠かせないものです。

以下は、Laravel 7.xバージョンの新規プロジェクトを作成してユーザー認証もインストールしたプロジェクトのrouteです。

+----------+------------------------+------------------+------------------------------------------------------------------------+
| Method   | URI                    | Name             | Action                                                                 |
+----------+------------------------+------------------+------------------------------------------------------------------------+
| GET|HEAD | /                      |                  | Closure                                                                |
| GET|HEAD | api/user               |                  | Closure                                                                |
| GET|HEAD | home                   | home             | App\Http\Controllers\HomeController@index                              |
| GET|HEAD | login                  | login            | App\Http\Controllers\Auth\LoginController@showLoginForm                |
| POST     | login                  |                  | App\Http\Controllers\Auth\LoginController@login                        |
| POST     | logout                 | logout           | App\Http\Controllers\Auth\LoginController@logout                       |
| GET|HEAD | password/confirm       | password.confirm | App\Http\Controllers\Auth\ConfirmPasswordController@showConfirmForm    |
| POST     | password/confirm       |                  | App\Http\Controllers\Auth\ConfirmPasswordController@confirm            |
| POST     | password/email         | password.email   | App\Http\Controllers\Auth\ForgotPasswordController@sendResetLinkEmail  |
| GET|HEAD | password/reset         | password.request | App\Http\Controllers\Auth\ForgotPasswordController@showLinkRequestForm |
| POST     | password/reset         | password.update  | App\Http\Controllers\Auth\ResetPasswordController@reset                |
| GET|HEAD | password/reset/{token} | password.reset   | App\Http\Controllers\Auth\ResetPasswordController@showResetForm        |
| GET|HEAD | register               | register         | App\Http\Controllers\Auth\RegisterController@showRegistrationForm      |
| POST     | register               |                  | App\Http\Controllers\Auth\RegisterController@register                  |
+----------+------------------------+------------------+------------------------------------------------------------------------+

第３番目のNameの列がrouteの名前です。この値をもとにtinkerで、route()を使っていろいろなurlを作成してみます。まずは基本からで、route()の最初の引数に、route名を渡します。

>>> route('home');
=> "http://localhost/home"

作成されたurlの、http://localhostの部分は、.envのAPP_URLの定義から来ています。 .envにおいて、

.env

...
APP_URL=http://www.example.com
...

と定義すると、

>>> route('home');
=> "http://www.example.com/home"

となります。

今度は、route()に２番目の引数を与えます。

>>> route('password.reset', ['token' => '1232457890']);
=> "http://www.example.com/password/reset/1232457890"

このtokenは上のrouteの表のURIで password/reset/{token}と定義されているので、与えた値に置き換わります。

しかし、定義されていない変数も渡すこと可能です。

>>> route('password.reset', ['token' => '1232457890', 'type' => 'user']);
=> "http://www.example.com/password/reset/1232457890?type=user"

この値は、コントローラの引数の$requestを使って、$request->typeとかで取得できますね。

さらに、‘type’ => ‘user’の配列の形でなくても、単に、‘user’とかでも与えることできます。

>>> route('password.reset', ['token' => '1232457890', 'user']);
=> "http://www.example.com/password/reset/1232457890?user"

この場合は、コントローラ側では、$request->has(‘user’)とかでブーリアン値で取得できます。

今度は、route()の第３の引数です。これはブーリアン値で、デフォルトがtrueでfalseを与えるとドメイン名がついた絶対URLではなくパス名だけを生成してくれます。

>>> route('home', null, false);
=> "/home"

最後に、redirect()にもroute()を使えます。

SomeController.php

]
...
return redirect(route('home'));

でもOKですが、

...
return redirect()->route('home');

とチェーンできます。

UUID　ユニークなID

Sun, 28 Jun 2020 07:29:45 +0900

商品のページのURLが例えばhttps://localhost/product/5734とかだと、5734はproductsテーブルのidの値だな、とわかってしまいます。しかしこれが、商品のIDではなく会員のIDや注文のIDなら大きな問題です。もちろん通常は認証で保護してログインした人のみしか閲覧できないようにしますが、プログラムのバグで認証が外れていたら。。。そんなときにIDがシーケンスの数字でなかったら、例えば、043a9c43-26cd-432f-bb25-a0eb045815b7とかのわけのわからない数字だったら安心です。今回はidの難読化のためのuuidを紹介です。

UUIDとは

wikiによると、

UUID（Universally Unique Identifier）とは、ソフトウェア上でオブジェクトを一意に識別するための識別子である。UUIDは128ビットの数値だが、16進法による550e8400-e29b-41d4-a716-446655440000というような文字列による表現が使われることが多い。元来は分散システム上で統制なしに作成できる識別子として設計されており、したがって将来にわたって重複や偶然の一致が起こらないという前提で用いることができる。

とあります。「重複が起こらないという前提で用いる」、これがidの代わりとして使用できる理由です。

Laravelで使用するには

phpにはuuidを作成する関数はないのですが、Laravelではもちろんパッケージを通して対応しています。

まず、migrationを使用してproductsのDBテーブルの項目として追加してみます。プライマリキーのidはキープして、ユニークなキーを持つuuidとして別に定義します。そうでないと、joinする他のDBテーブルのjoin keyも36文字の長い値を保存することになり効率的ではありません。

database/migrations/2020_06_25_172420_create_products.php

use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;

class CreateProducts extends Migration
{
    /**
     * Run the migrations.
     *
     * @return void
     */
    public function up()
    {
        Schema::create('products', function (Blueprint $table) {
            $table->bigIncrements('id');
            $table->uuid('uuid')->unique();
            $table->char('name', 100);
            $table->decimal('price', 10, 0);
            $table->timestamps();
        });
    }

    /**
     * Reverse the migrations.
     *
     * @return void
     */
    public function down()
    {
        Schema::dropIfExists('products');
    }
}

これをmigrateして、

$ php artisan migrate

mysqlで作成されたテーブルの定義を見ると、

mysql> describe products;
+------------+---------------------+------+-----+---------+----------------+
| Field      | Type                | Null | Key | Default | Extra          |
+------------+---------------------+------+-----+---------+----------------+
| id         | bigint(20) unsigned | NO   | PRI | NULL    | auto_increment |
| uuid       | char(36)            | NO   | UNI | NULL    |                |
| name       | char(100)           | NO   |     | NULL    |                |
| price      | decimal(10,0)       | NO   |     | NULL    |                |
| created_at | timestamp           | YES  |     | NULL    |                |
| updated_at | timestamp           | YES  |     | NULL    |                |
+------------+---------------------+------+-----+---------+----------------+

36文字長のユニークなキーを持つuuidの項目が作成されています。

早速、DBレコードを作成してみます。

まず、Productのモデルを作成して、

app/Product.php

namespace App;

use Illuminate\Database\Eloquent\Model;

class Product extends Model
{
    protected $fillable = [
        'uuid', 'name', 'price',
    ];
}

そして、tinkerでレコード作成してみます。

>>> Product::create(['uuid' => (string) Str::uuid(), 'name' => '商品名', 'price' => 1000]);
=> App\Product {#3986
     uuid: "043a9c43-26cd-432f-bb25-a0eb045815b7",
     name: "商品名",
     price: 1000,
     updated_at: "2020-06-25 18:03:45",
     created_at: "2020-06-25 18:03:45",
     id: 1,
   }

Str::uuid()はLaravelのヘルパーです。ヘルパーはLaravelが使用しているパッケージのオブジェクトを返すので、stringで文字列にキャストしています。

idを隠す

せっかく、uuidの項目があるのだから、プライマリキーのidが表に出ないように隠しましょう。

モデルにおいて、hiddenの属性にidを入れます。

app/Product.php

...
class Product extends Model
{
    protected $fillable = [
        'uuid', 'name', 'price',
    ];

    protected $hidden = [
    	'id'
    ];
}

idが隠れているか、tinkerで確認です。

>>> Product::find(1);
=> App\Product {#3996
     uuid: "043a9c43-26cd-432f-bb25-a0eb045815b7",
     name: "商品名",
     price: "1000",
     created_at: "2020-06-25 18:03:45",
     updated_at: "2020-06-25 18:03:45",
   }

idの項目表示されないですね。

しかし、直接ならアクセスできます。

>>> Product::find(1)->id;
=> 1

しかし、配列として変換などするとidの値は入ってきません。

>>> Product::find(1)->toArray();
=> [
     "uuid" => "043a9c43-26cd-432f-bb25-a0eb045815b7",
     "name" => "商品名",
     "price" => "1000",
     "created_at" => "2020-06-25 18:03:45",
     "updated_at" => "2020-06-25 18:03:45",
   ]

コントローラからuuidでアクセス

以下のように、getRouteKeyNane()で、uuidを指定すると、コントローラのURLでuuidを指定してレコードの取得可能です。

app/Product.php

...
class Product extends Model
{
    protected $fillable = [
        'uuid', 'name', 'price',
    ];

    protected $hidden = [
    	'id'
    ];

    public function getRouteKeyName()
    {
    	return 'uuid';
    }
}

コントローラを作成して、

app/Http/Controllers/ProductController.php

namespace App\Http\Controllers;

use App\Product;
use App\Http\Controllers\Controller;

class ProductController extends Controller
{
    public function show(Product $product)
    {
        return $product;
    }
}

ルートを設定します。

routes/web.php

...
Route::resource('/product', 'ProductController')->only('show');
...

通常のように、uuidでなくidの値でhttps::/local/product/1としてアクセスすると、

>>> $option = [ 'ssl' => ['verify_peer' => false, 'verify_peer_name' => false]];　//これはSSL認証のエラーを抑えるために必要。
=> [
     "ssl" => [
       "verify_peer" => false,
       "verify_peer_name" => false,
     ],
   ]
>>> file_get_contents('https://localhost/product/1', false, stream_context_create($option));
PHP Warning:  file_get_contents(https://localhost/product/1): failed to open stream: HTTP request failed! HTTP/1.1 404 Not Found
 in Psy Shell code on line 1
=> false

404のページが見つからない、のエラーです。

しかし、https://localhost/product/043a9c43-26cd-432f-bb25-a0eb045815b7のようにuuidでアクセスすると、以下のようにレコードを取得してくれます。

>>> file_get_contents('https://localhost/product/043a9c43-26cd-432f-bb25-a0eb045815b7', false, stream_context_create($option));
=> "{"uuid":"043a9c43-26cd-432f-bb25-a0eb045815b7","name":"\u5546\u54c1\u540d","price":"1000","created_at":"2020-06-25 18:03:45","updated_at":"2020-06-25 18:03:45"}"
>>>

ダウンロードファイル名禁止文字に対応

Sun, 14 Jun 2020 08:58:25 +0900

Windows 10では、ファイル名として使用してはいけない文字がいくつかあります。入力しようとすると、「ファイル名に次の文字は使えません」とエラーになります。さて、ダウンロードのファイルにこれらの禁止文字が使用されていたらどうしましょう？

例えば、サーバーにアップされているファイル名は「567.jpg」と商品ID.jpgのフォーマットとします。しかし、ユーザーがダウンロードする時には「世界一おいしい? りんご、4/1から販売.jpg」と商品名.jpgにしたいときです。しかし、商品名に含まれる、?（半角疑問符）や/（半角バックスラッシュ）が禁止文字なのです。

手っ取り早いのは、半角の禁止文字を皆全角に置き換えてしまえばよいです。

ということでヘルパーの関数を作成します。

app/Helpers/MyHelper.php

namespace App\Helpers;

class MyHelper
{
    /**
     * 禁止半角文字を全角に
     * @param  string $value
     * @return  string
     */
    public static function convertToValidFilename($value)
    {
        $from = ['\\', '/', ':', '*', '?', '"', '>', '<', '|'];
        $to = ['￥', '／', '：', '＊', '？', '”', '＞', '＜', '｜'];

        $patterns = array_map(function($val) { return '#\\'.$val.'#'; }, $from);

        return preg_replace($patterns, $to, $value);
    }
}

preg_replace()の最初の引数に、その前の行のarray_map()で作成された配列を与えているところに注意してください。

通常は、

>>> preg_replace('/123/', 'xyz', '01234');
=> "0xyz4"

のように、パターンには/（半角スラッシュ）で囲んだ文字列を与えますが、配列を与えて複数の置き換えをすべて実行することもできます。

convertToValidFilename()では、$patternsが以下のような配列となり、

Array
(
    [0] => #\\#
    [1] => #\/#
    [2] => #\:#
    [3] => #\*#
    [4] => #\?#
    [5] => #\"#
    [6] => #\>#
    [7] => #\<#
    [8] => #\|#
)

これらは、以下の対応する$toに、

Array
(
    [0] => \
    [1] => /
    [2] => :
    [3] => *
    [4] => ?
    [5] => "
    [6] => >
    [7] => <
    [8] => |
)

に置き換えます。

パターンにおいて、通常使われる/（半角バックスラッシュ）の代わりに、#（半角シャープ）で囲まれているのは、/（半角バックスラッシュ）がパターン内の文字としてありエスケープ文字となってしまうからです。preg_replace()のパターンの境界文字は、そのように必要に応じて変えることができるのです。

早速、tinkerを使用して試してみましょう。

>>> use App\Helpers\MyHelper;
>>> MyHelper::convertToValidFileName('世界一おいしい? りんご、4/1から販売.jpg');
=> "世界一おいしい？ りんご、4／1から販売.jpg"

禁止文字が半角から全角に置き換わりましたね。

最後に、これを用いたコントローラのダウンロードメソッドは、こんな感じとなります。

public function download(Product $product)
{
    Storage::download(storage_path().'/'.$product->product-id.'.jpg',     
        MyHelper::convertToValidFileName($product->name).'jpg');
}

ブラウザからtinkerにアクセス

Fri, 13 Sep 2019 23:14:31 +0900

tinker好きの私としては、嬉しいニュースです。今までコンソールからでしか使用できなかったtinkerがブラウザでアクセスできるようになりました。と言っても、Laravelのパッケージの一部ではなく、Laravelのtinkerにフロントエンドを追加したphpのパッケージ、Web Tinkerのことです。

インストール

まず、パッケージのレポは以下のGitHubです。

https://github.com/spatie/laravel-web-tinker

これによると、まずcomposerの実行です。–devのオプションが必要なことに注意してください。ウェブからのアクセスが可能なので、これなしではproduction版でアクセスされて、セキュリティの問題となります。

$ composer require spatie/laravel-web-tinker --dev

次に、以下の実行でWeb Tinkerのアセットをpublic/vendor/web-tinkerのディレクトリにインストールします。

$ php artisan web-tinker:install

フロントエンド

早速、ブラウザからアクセスしてみましょう。url + ‘/tinker’でアクセスできます。

実行には、cmd+enter あるいは ctrl+enterとあります。コンソール版のtinkerとは違って、１行タイプしてenterで実行とはいかないようです。

とりあえず、以下のように実行してみました。

結果が右パネルに出ましたね。

しかし、以下のように２行タイプすると、右パネルがクリアされて最後の行の結果のみが出力されます。

コンソール版のtinkerと違い、実行の ctrl+enterを押すと、画面に入力したコードすべて（複数行あっても）が実行されるようです。たとえ最初の１行目にカーソルを持っていき実行しても同じ結果です。これは、複雑なコードのテストには理想かもしれません。例えば、以前に掲載した複雑なコードは、コンソール版にtinkerでは以下のように１行１行タイプ実行していきます。８行目のファクトリーの実行では長い１行となっているので、括弧の数など間違わないように注意が必要です。

$ php artisan tinker
sy Shell v0.9.9 (PHP 7.2.16 — cli) by Justin Hileman
>>> use App\User;
>>> use App\Address;
>>> User::truncate();
>>> Address::truncate();
=> Illuminate\Database\Eloquent\Builder {#2974}
>>> factory(App\User::class)->create()->each(function ($user) { $user->addresses()->saveMany(factory(App\Address::class, 2)->make()); });
=> true
...

しかし、Web Tinkerでは、以下のように直接プログラムからのチャンクのコードをコピペしてそのまま実行できます。

これは便利です。

それから、コンソール版と比べて、毎回の実行において環境がリロードされるので、コンソール版のように、プログラム変更するたびに、exitして再度php artisan tinkerする必要がないのもプラスです。

マイナーなマイナスの面では、編集にemacsのキー、つまり、control + a（行先頭へ移動）、control + e （行末へ移動）などが使えないことです。私（だけ？）にとっては少し残念なことです。コンソール版ではそれらのキーは重宝しています。

結論としては、コンソール版のtinkerを捨てて、このウェブ版のtinkerに乗り換えることはできませんが、目的によって使い分けをすれば十分パワフルなツールとして使えそうです。

fresh() vs refresh()

Sat, 31 Aug 2019 03:40:54 +0900

tinkerを使用して開発中の関数をいろいろ試験します。Eloquent関連の関数で複数のDBテーブルに渡り値を更新する関数ゆえに、tinkerがとても役に立つのです。しかし、試験中に不思議なことが起こりました。ちょっと格闘して、なるほどそこではこうすればいいのだな、という話を共有です。

まず、説明のためにhasManyのフェイクデータの作成のポストで環境を作成します。

以前のレコードが残っているかもしれないので、truncate()を実行して空にします。そこでfactory()を実行して、Userのレコードを１つ、Addressのレコードを２つ作成します。$user->addressesは、Userのモデルのrelationshipです。

$ php artisan tinker
sy Shell v0.9.9 (PHP 7.2.16 — cli) by Justin Hileman
>>> use App\User;
>>> use App\Address;
>>> User::truncate();
>>> Address::truncate();
=> Illuminate\Database\Eloquent\Builder {#2974}
>>> factory(App\User::class)->create()->each(function ($user) { $user->addresses()->saveMany(factory(App\Address::class, 2)->make()); });
=> true
>>> $user = User::find(1);
=> App\User {#2976
     id: 1,
     name: "三宅 桃子",
     email: "kaori01@example.org",
     email_verified_at: "2019-08-29 20:45:31",
     created_at: "2019-08-13 07:57:01",
     updated_at: "2019-08-13 07:57:01",
   }
>>> $user->addresses;
=> Illuminate\Database\Eloquent\Collection {#2986
     all: [
       App\Address {#2982
         id: 1,
         user_id: 1,
         address: "8427481  東京都松本市西区山田町廣川6-3-5 ハイツ喜嶋108号",
         created_at: "2019-08-29 20:45:31",
         updated_at: "2019-08-29 20:45:31",
       },
       App\Address {#2974
         id: 2,
         user_id: 1,
         address: "9979251  茨城県加藤市北区原田町山口7-7-5",
         created_at: "2019-08-29 20:45:31",
         updated_at: "2019-08-29 20:45:31",
       },
     ],
   }

さて、ここで$userの名前を変更してみます。

>>> $user->name = 'TEST';
=> "TEST"
>>> $user
=> App\User {#2976
     id: 1,
     name: "TEST",
     email: "kaori01@example.org",
     email_verified_at: "2019-08-29 20:45:31",
     created_at: "2019-08-13 07:57:01",
     updated_at: "2019-08-13 07:57:01",
     addresses: Illuminate\Database\Eloquent\Collection {#2986
       all: [
         App\Address {#2982
           id: 1,
           user_id: 1,
           address: "8427481  東京都松本市西区山田町廣川6-3-5 ハイツ喜嶋108号",
           created_at: "2019-08-29 20:45:31",
           updated_at: "2019-08-29 20:45:31",
         },
         App\Address {#2974
           id: 2,
           user_id: 1,
           address: "9979251  茨城県加藤市北区原田町山口7-7-5",
           created_at: "2019-08-29 20:45:31",
           updated_at: "2019-08-29 20:45:31",
         },
       ],
     },
   }

変わりましたね。しかし、まだ$user->save()を実行していないので、単に$userのインスタンスの値が変わっただけです。これをリセットするには、fresh()を使用します。

>>> $user->fresh();
=> App\User {#2979
     id: 1,
     name: "三宅 桃子",
     email: "kaori01@example.org",
     email_verified_at: "2019-08-29 20:45:31",
     created_at: "2019-08-13 07:57:01",
     updated_at: "2019-08-13 07:57:01",
   }
>>>

戻りましたね。しかし、$user自体は戻っていません。

>>> $user
=> App\User {#2976
     id: 1,
     name: "TEST",
     email: "kaori01@example.org",
     email_verified_at: "2019-08-29 20:45:31",
     created_at: "2019-08-13 07:57:01",
     updated_at: "2019-08-13 07:57:01",
     addresses: Illuminate\Database\Eloquent\Collection {#2986
       all: [
         App\Address {#2982
           id: 1,
           user_id: 1,
           address: "8427481  東京都松本市西区山田町廣川6-3-5 ハイツ喜嶋108号",
           created_at: "2019-08-29 20:45:31",
           updated_at: "2019-08-29 20:45:31",
         },
         App\Address {#2974
           id: 2,
           user_id: 1,
           address: "9979251  茨城県加藤市北区原田町山口7-7-5",
           created_at: "2019-08-29 20:45:31",
           updated_at: "2019-08-29 20:45:31",
         },
       ],
     },
   }

不思議ですね。

APIのマニュアルを見てみましょう。 https://laravel.com/api/5.8/Illuminate/Database/Eloquent/Model.html#method_fresh

そこの説明では、

Reload a fresh model instance from the database.

DBから新しいインスタンスをリロード、とありますが、元のインスタンスをリセットするのではなく、新しいインスタンスを作成して返しているようです。

つまり、元のインスタンスのリセットには、

>>> $user = $user->fresh();
=> App\User {#2979
     id: 1,
     name: "三宅 桃子",
     email: "kaori01@example.org",
     email_verified_at: "2019-08-29 20:45:31",
     created_at: "2019-08-13 07:57:01",
     updated_at: "2019-08-13 07:57:01",
   }
>>> $user
=> App\User {#2979
     id: 1,
     name: "三宅 桃子",
     email: "kaori01@example.org",
     email_verified_at: "2019-08-29 20:45:31",
     created_at: "2019-08-13 07:57:01",
     updated_at: "2019-08-13 07:57:01",
   }

と元のインスタンスに割り当てが必要となります。面倒ですね。fresh()は違う使用ケースがあるのでしょうか。と思っていたら、そのためにもう１つのメソッドrefersh()がありました。

>>> $user->name = 'TEST';
=> "TEST"
>>> $user;
=> App\User {#2979
     id: 1,
     name: "TEST",
     email: "kaori01@example.org",
     email_verified_at: "2019-08-29 20:45:31",
     created_at: "2019-08-13 07:57:01",
     updated_at: "2019-08-13 07:57:01",
   }
>>> $user->refresh();
=> App\User {#2979
     id: 1,
     name: "三宅 桃子",
     email: "kaori01@example.org",
     email_verified_at: "2019-08-29 20:45:31",
     created_at: "2019-08-13 07:57:01",
     updated_at: "2019-08-13 07:57:01",
   }
>>> $user
=> App\User {#2979
     id: 1,
     name: "三宅 桃子",
     email: "kaori01@example.org",
     email_verified_at: "2019-08-29 20:45:31",
     created_at: "2019-08-13 07:57:01",
     updated_at: "2019-08-13 07:57:01",
   }
>>>

一件落着です。このrefresh()のメソッド、関連しているレコードの反映にも役立つことわかりました。

例えば、

>>> $user->addresses;
=> Illuminate\Database\Eloquent\Collection {#2986
     all: [
       App\Address {#2982
         id: 1,
         user_id: 1,
         address: "8427481  東京都松本市西区山田町廣川6-3-5 ハイツ喜嶋108号",
         created_at: "2019-08-29 20:45:31",
         updated_at: "2019-08-29 20:45:31",
       },
       App\Address {#2974
         id: 2,
         user_id: 1,
         address: "9979251  茨城県加藤市北区原田町山口7-7-5",
         created_at: "2019-08-29 20:45:31",
         updated_at: "2019-08-29 20:45:31",
       },
     ],
   }

のように、ユーザーには２つの住所があります。ここの１つを更新してみます。

>>> $address = Address::find(1);
=> App\Address {#3015
     id: 1,
     user_id: 1,
     address: "8427481  東京都松本市西区山田町廣川6-3-5 ハイツ喜嶋108号",
     created_at: "2019-08-29 20:45:31",
     updated_at: "2019-08-29 21:16:30",
   }
>>> $address->update(['address' => 'TEST ADDRESS']);
=> true

しかし、以下を実行すると、

>>> $user->addresses
=> Illuminate\Database\Eloquent\Collection {#2971
     all: [
       App\Address {#2970
         id: 1,
         user_id: 1,
         address: "8427481  東京都松本市西区山田町廣川6-3-5 ハイツ喜嶋108号",
         created_at: "2019-08-29 20:45:31",
         updated_at: "2019-08-29 20:45:31",
       },
       App\Address {#2981
         id: 2,
         user_id: 1,
         address: "9979251  茨城県加藤市北区原田町山口7-7-5",
         created_at: "2019-08-29 20:45:31",
         updated_at: "2019-08-29 20:45:31",
       },
     ],
   }

最初のアドレスのレコードは、オリジナルのままですね。

そこで、refersh()を使いましょう。

>>> $user->refresh();
=> App\User {#2979
     id: 1,
     name: "三宅 桃子",
     email: "kaori01@example.org",
     email_verified_at: "2019-08-29 20:45:31",
     created_at: "2019-08-13 07:57:01",
     updated_at: "2019-08-13 07:57:01",
     addresses: Illuminate\Database\Eloquent\Collection {#3022
       all: [
         App\Address {#3020
           id: 1,
           user_id: 1,
           address: "TEST ADDRESS",
           created_at: "2019-08-29 20:45:31",
           updated_at: "2019-08-29 21:17:12",
         },
         App\Address {#3023
           id: 2,
           user_id: 1,
           address: "9979251  茨城県加藤市北区原田町山口7-7-5",
           created_at: "2019-08-29 20:45:31",
           updated_at: "2019-08-29 20:45:31",
         },
       ],
     },
   }

変更が反映されましたね。しかし、fresh()はいったいどういうときに使用するのでしょうかね。

isDirty() vs wasChanged()

Fri, 05 Jul 2019 01:07:02 +0900

このブログの一番最初に書いた記事において、isDirty()に関して書きました。もう4年くらい前のことです。最近必要になって使用したところ、新たな発見がありました。

更新あります！

まず、tinkerを使用して、isDirty()の復習です。 factory()を使って、１つレコードを作成します。

>>> factory(App\User::class)->create();
=> App\User {#2987
     name: "小林 春香",
     email: "kana.yamamoto@example.org",
     email_verified_at: "2019-07-02 03:01:25",
     updated_at: "2019-07-02 03:01:25",
     created_at: "2019-07-02 03:01:25",
     id: 1,
   }

作成したレコードの名前を更新しますが、DBでなくオブジェクトのみの更新のために、fill()を使用します。

>>> $user = User::find(1);
=> App\User {#2950
     id: 1,
     name: "小林 春香",
     email: "kana.yamamoto@example.org",
     email_verified_at: "2019-07-02 03:01:25",
     created_at: "2019-07-02 03:01:25",
     updated_at: "2019-07-02 03:01:25",
   }
>>> $user->fill(['name' => '山田花子']);
=> App\User {#2950
     id: 1,
     name: "山田花子",
     email: "kana.yamamoto@example.org",
     email_verified_at: "2019-07-02 03:01:25",
     created_at: "2019-07-02 03:01:25",
     updated_at: "2019-07-02 03:01:25",
   }

nameが変わりましたね。実際、オブジェクトが更新したかどうかは、isDirty()を使います。

>>> $user->isDirty();
=> true

変更していますね。項目ごとはどうでしょう？

>>> $user->isDirty('name');
=> true
>>> $user->isDirty('email');
=> false

nameの変更がありますが、emailの変更はなしです。正しいです。

ここで、変更したオブジェクトをもとに対応するレコードをDBに保存します。

>>> $user->save();
=> true

さて、この時点でのisDirty()の返り値は？

>>> $user->isDirty();
=> false
>>> $user->isDirty('name');
=> false

もう、isDirty()では、変更があったかどうかの判断はできません、何もDirtyではありません。

この時点、つまりオブジェクトの更新をDBに反映した時点でレコードが更新したかどうかを判断するには、isDirty()ではなく、wasChanged()を使用します。

>>> $user->wasChanged();
=> true
>>> $user->wasChanged('name');
=> true
>>> $user->wasChanged('email');
=> false

save()前のisDirty()の結果とまったく同じです。

実際には、こんなコードでwasChanged()は使われます。

...
$user->fill(['name' => '山田花子']);

if ($user->isDirty()) {
    $user->save();
    if ($user->wasChagned('name')) {
        //nameが更新されたときのみ、以下のコードを実行
        ...
    }
}
...

カスタムルールオブジェクト

Mon, 01 Apr 2019 09:44:21 +0900

5.5より前のバージョンのLaravelでプログラムをしていたひとたちに取っては、5.5で登場したルールオブジェクトは神の恵みと言ってもいいくらい。カスタムバリデーションを作成するために、Validator::extendはどこに宣言するの？とか、グローバルでどう作成したバリデーションを共有するの？とか、取り掛かる前に悩んでいたのがウソのよう。新登場のルールオブジェクトのおかげで、カスタムルールの作成が楽しくなりました。

カスタムルールが必要となるときは、たくさんあります。なぜなら既存のバリデーションでは簡単にいかないルールが世の中にたくさんあるからです。

例えば、登録したユーザーのリストが欲しいとして、開始日を指定して今日までに登録したユーザーのみとします。しかし、開始日は今日から2か月までしか遡れない、とします。以下のようなカレンダーで開始日をしてもらいますが、開始日が2か月以上前ならバリデーションでチェックしてエラーを表示としたいです。

このバリデーションには既存のバリデーションのafter_or_equalが使えます、しかし渡すパラメータには、「今日マイナス2か月」が必要です。もちろん前もって計算して渡すこともできます。

Psy Shell v0.9.9 (PHP 7.2.16 — cli) by Justin Hileman
>>> $from = \Carbon\Carbon::today()->subMonth(2)->toDateString();
=> "2019-01-29"
>>> $input = ['start_date' => '2019-01-01'];
=> [
     "start_date" => "2019-01-01",
   ]
>>> validator($input, ['start_date' => 'required|date|after_or_equal:$from'])->errors()->all();
=> []
>>> validator($input, ['start_date' => "required|date|after_or_equal:$from"])->errors()->all();
=> [
     "start dateは2019-01-29以後の日付が必要です",
   ]
>>>

しかし、もしかしたら2か月でなく3ヶ月となるかもしれないし、一般的なバリデーションがあってもいいですね。こんな感じで呼び出したいです。

['start_date' => ['required', 'date', new RestrictPeriodRule(2)]];

そこで、ルールオブジェクトの出番です。

まず、コマンドでルールのファイルを作成します。

$ php artisan make:rule RestrictPeriodRule

中身を以下のように編集します。

appRulesRestrictPeriodRule.php

<?php

namespace App\Rules;

use Carbon\Carbon;
use Illuminate\Contracts\Validation\Rule;

class RestrictPeriodRule implements Rule
{
    protected $months;
    protected $start;

    /**
     * Create a new rule instance.
     *
     * @return void
     */
    public function __construct($months)
    {
        $this->months = $months;
    }

    /**
     * Determine if the validation rule passes.
     *
     * @param  string  $attribute
     * @param  mixed  $value
     * @return bool
     */
    public function passes($attribute, $value)
    {
        $this->start = Carbon::today()
                  ->subMonth($this->months)
                  ->toDateString();

        return ($value >= $this->start);
    }

    /**
     * Get the validation error message.
     *
     * @return string
     */
    public function message()
    {
        return $this->start.'以降を指定してください';
    }
}

出来たところでテストしてみましょう。

Psy Shell v0.9.9 (PHP 7.2.16 — cli) by Justin Hileman
>>> $input = ['start_date' => '2019-01-01'];
=> [
     "start_date" => "2019-01-01",
   ]
>>> validator($input, ['start_date' => ['required', 'date', new App\Rules\RestrictPeriodRule(2)]])->errors()->all();
=> [
     "2019-01-29以降を指定してください",
   ]
>>>

Laravel 5.6で追加されたバリデーション

Sat, 23 Mar 2019 00:58:11 +0900

私が使用しているLaravelのバージョンは5.5、ついこの前にリリースされたと思いきや、なんと8/30/2017のことらしくもう1年半以上も経過。LTSということで2年間の長期サポートだからのんびりとしていたら、もうこの夏でサポートの期限切れです。キャッチアップ、ということで去年の2月にリリースされた5.6バージョン（しかし、もうサポートされていない）に追加されたバリデーションをチェックします。

これが、5.6のバリデーションの一覧です。ブルーでハイライトしているのが5.5にはなく5.6に追加されたバリデーションです。

追加されたもので、すぐに使えそうなものは、

Greater Than gt Greater Than Or Equal　gte Less Than　lt Less Than Or Equal　lte

早速使ってみましょう。validator()はLaravelのヘルパーですが、こちらも読んでください。

Psy Shell v0.9.9 (PHP 7.1.14 — cli) by Justin Hileman
>>> $input = ['quantity' => 5];
=> [
     "quantity" => 5,
   ]
>>> validator($input, ['quantity' => 'required|integer|gt:4'])->errors()->all();
=> []
>>> validator($input, ['quantity' => 'required|integer|gt:5'])->errors()->all();
=> [
     "The quantity must be greater than 0.",
   ]
>>> validator($input, ['quantity' => 'required|integer|gte:5'])->errors()->all();
=> []
>>> validator($input, ['quantity' => 'required|integer|lt:6'])->errors()->all();
=> []
>>> validator($input, ['quantity' => 'required|integer|lte:5'])->errors()->all();
=> []

ちなみに、これらがない5.5では、以下のようにmin, max, not_inを組み合わせて同じようなバリデーションが可能です。

>>> validator($input, ['quantity' => 'required|integer|min:5'])->errors()->all();
=> []
>>> validator($input, ['quantity' => 'required|integer|min:5|not_in:5'])->errors()->all();
=> [
     "The selected quantity is invalid.",
   ]

しかし、このメッセージでわかりにくいので、

>>> validator($input, ['quantity' => 'required|integer|min:5|not_in:5'], ['not_in' => 'The quantity must be greater than :input.'])->errors()->all();
=> [
     "The quantity must be greater than 5.",
   ]

と、カスタムメッセージを与える必要あります。面倒ですね。

こういうときにwhereRawを使う

Sat, 09 Mar 2019 06:37:58 +0900

これも、前回と同様「実はそうでなかった」のトピックです。今度は、Eloquentのクエリーにおいてwhere()で条件を指定するとき。

早速、tinkerを使って具体的な例を作成します。

Psy Shell v0.9.3 (PHP 7.1.14 — cli) by Justin Hileman
>>>  factory(App\User::class,2)->create()
=> Illuminate\Database\Eloquent\Collection {#2341
     all: [
       App\User {#2337
         name: "笹田 洋介",
         email: "jun91@example.com",
         updated_at: "2019-03-08 08:24:36",
         created_at: "2019-03-08 08:24:36",
         id: 1,
       },
       App\User {#2333
         name: "高橋 舞",
         email: "hideki31@example.com",
         updated_at: "2019-03-08 08:24:36",
         created_at: "2019-03-08 08:24:36",
         id: 2,
       },
     ],
   }

factory()を使用して、２つレコードをusersのテーブルに作成しました。これら、もちろんですが作成したばかりなので、作成時間と更新時間はどちらのレコードも同じ、つまりcreated_at == updated_at　です。

ということは、where()でその条件を指定してやれば、両方のレコードとも取得できますよね。早速クエリを実行してみます。

>>> User::where('created_at', '=', 'updated_at')->get();
=> Illuminate\Database\Eloquent\Collection {#2340
     all: [],
   }

あれれ、結果は空ですね。この前作成した、tinkerのsql()で実行されたSQL文を見てみると、

>>> sql()
=> [
...
     [
       "query" => "select * from `users` where `created_at` = ?",
       "bindings" => [
         "updated_at",
       ],
       "time" => 3.5,
     ],
   ]

そう、usersテーブルの項目を指定しているのでなく、文字列の“updated_at”の指定となっているのです。どうりで空の取得となるわけです。

正しくは、

>>> User::whereRaw('created_at = updated_at')->get();
=> Illuminate\Database\Eloquent\Collection {#2345
     all: [
       App\User {#2332
         id: 1,
         name: "笹田 洋介",
         email: "jun91@example.com",
         created_at: "2019-03-08 08:24:36",
         updated_at: "2019-03-08 08:24:36",
       },
       App\User {#2339
         id: 2,
         name: "高橋 舞",
         email: "hideki31@example.com",
         created_at: "2019-03-08 08:24:36",
         updated_at: "2019-03-08 08:24:36",
       },
     ],
   }

と、whereRaw()を使用して、生の条件文を入れてやるのです。実行されたSQL文を見てみると、

>>> sql()
=> [
...
     [
       "query" => "select * from `users` where created_at = updated_at",
       "bindings" => [],
       "time" => 0.8,
     ],
   ]

と正しいSQL文となっています。

正しいのは、isEmptyでした

Sat, 02 Mar 2019 03:57:47 +0900

日常、いつもの考えや習慣で仮定してしまい、「実はそうでなかった」と後で冷や汗なること多々あります。Laravelのプログラミングもそうです。その過ちを繰り返さないために、出会ったらブログに書いていくことにします。

今回はCollectionに関して、最近うっかりしたこと。

例えば、tinkerで空の結果のEloquentのCollectionを作成して、

>>> $users = User::where('email', '=', '')->get(); // 空のCollection

=> Illuminate\Database\Eloquent\Collection {#2319
     all: [],
   } 

>>> if (empty($users)) echo "空です！"

empty()で空の判断を試みるが、「実はそうでなかった」。 empty()は引数が配列ならＯＫだけれど、Collectionのオブジェクトなら空を判断できません。

正しくは、Collectionのメソッド、isEmpty()を使います。

>>> if ($users->isEmpty()) echo "空です！"

空です！

同様に、count()でレコード数を数えてもＯＫですが、否定の!が必要。

>>> if (!$users->count()) echo "空です！"

空です！

また、配列を取り出すなら、empty()も使えます。

>>> if (empty($users->all())) echo "空です！"

空です！

tinkerのブートストラップファイル

Fri, 22 Feb 2019 23:44:13 +0900

先日、tinkerに関して私が知らなかった機能を見つけました。tinkerを好んで日夜使用する私としては、これは作業効率が上がるわ、とわくわくする機能です。

tinkerで私がよく使うのは、以下のようなEloquentの関数で実行される裏側のSQL文の表示です。

Psy Shell v0.9.3 (PHP 7.1.14 — cli) by Justin Hileman
>>> DB::enableQueryLog()
=> null
>>> User::find(1)
[!] Aliasing 'User' to 'App\User' for this Tinker session.
=> App\User {#2316
     id: 1,
     name: "江古田 明美",
     email: "kazuya24@example.net",
     created_at: "2019-01-18 14:02:42",
     updated_at: "2019-01-18 14:02:42",
   }
>>> DB::getQueryLog()
=> [
     [
       "query" => "select * from `users` where `users`.`id` = ? limit 1",
       "bindings" => [
         1,
       ],
       "time" => 8.01,
     ],
   ]
>>>

この例ではシンプルなSQL文ですが、これがhasManyThroughとかbelongsToManyだとかの複雑なリレーションになると、joinの接続が本当にこちらの期待通りなのか、などのチェックしたくなります。しかし、 DB::enableQueryLog()やDB::getQueryLog()を覚えるのも大変であるし、毎回毎回それをタイプするのも面倒！

なんか簡単にエイリアスみたいなことができないかと、探していてわかったのが、tinkerのブートストラップファイル。

まず、以下の内容のPHPファイルを作成します。

start.php

<?php
DB::enableQueryLog();

function sql() {
   return DB::getQueryLog();
}

そして、そのファイル名を引数として、tinkerを実行します。

$ php artisan tinker start.php
[bash]
Psy Shell v0.9.3 (PHP 7.1.14 — cli) by Justin Hileman
>>> User::find(1)
[!] Aliasing 'User' to 'App\User' for this Tinker session.
=> App\User {#2316
     id: 1,
     name: "江古田 明美",
     email: "kazuya24@example.net",
     created_at: "2019-01-18 14:02:42",
     updated_at: "2019-01-18 14:02:42",
   }
>>> sql()
=> [
     [
       "query" => "select * from `users` where `users`.`id` = ? limit 1",
       "bindings" => [
         1,
       ],
       "time" => 8.01,
     ],
   ]
>>>

そう、start.phpはすでにtinker内で先に実行されるので、SQLのログ機能はすでにオンとなっているし、SQL文を見たいときは、sql()とだけタイプすればいいのです。これなら忘れませんね。

mapとfilter

Mon, 28 Jan 2019 06:34:47 +0900

ファイルのアップロードに関連したコードの開発で、LaravelのStorageのクラスを使用する機会がありました。そのクラスを使用しての出力処理で学んだことを今回は共有します。

まず、Laravelではアップロードしたファイルや生成したファイルの保管場所としてstorage/appのディレクトリが設けられています。

例えば、現在開発しているプロジェクトでは以下のようです。

$ tree storage/app
storage/app
├── public
├── shop
│   ├── 2
│   │   ├── order.csv
│   │   ├── products20181227-024348.csv
│   │   ├── products20181227-034433.csv

storage/app/shop/2のディレクトリのファイルのリストが欲しいなら、tinkerでは、

>>> Storage::files('shop/2')
=> [
     "shop/2/order.csv",
     "shop/2/products20181227-024348.csv",
     "shop/2/products20181227-034433.csv",
   ]

さて、ここで以下のようなファイル名だけの配列のデータが欲しいです。

[
     "order.csv",
     "products20181227-024348.csv",
     "products20181227-034433.csv",
]

foreachも使えますが、array_mapを使ってみましょう。

>>> $files = Storage::files('shop/2');
=> [
     "shop/2/order.csv",
     "shop/2/products20181227-024348.csv",
     "shop/2/products20181227-034433.csv",
   ]
>>> array_map(function($file) { return basename($file); }, $files);
=> [
     "order.csv",
     "products20181227-024348.csv",
     "products20181227-034433.csv",
   ]

さらに、productsで始まるファイル名だけが欲しいとすると、

>>> $products = array_map(function($file) { \
... if (substr(basename($file), 0, 8) == 'products') return basename($file); \
... }, $files)
=> [
     null,
     "products20181227-024348.csv",
     "products20181227-034433.csv",
   ]

あれれ、これでは余計なnullのファイル名が出てきます。それを抜くために、今度はarray_filterです。

>>> array_filter($products, function($file) { return ($file !== null); });
=> [
     1 => "products20181227-024348.csv",
     2 => "products20181227-034433.csv",
   ]

ややこしいですね。残念ながら一発で両方を行う関数はphpにはありません。

Laravelならどうでしょうか。Storage::diskは配列を返すので、まずCollectionに変えます。

>>> $files = collect(Storage::files('shop/2'));
=> Illuminate\Support\Collection {#3522
     all: [
       "shop/2/order.csv",
       "shop/2/products20181227-024348.csv",
       "shop/2/products20181227-034433.csv",
     ],
   }
>>> $files->map(function($file) { \
... if (substr(basename($file), 0, 8) == 'products') return basename($file); } \
... )->filter(function($file) { return ($file !== null); });
=> Illuminate\Support\Collection {#3534
     all: [
       1 => "products20181227-024348.csv",
       2 => "products20181227-034433.csv",
     ],
   }

phpの関数とは違ってチェーンできるので少しはすっきりします。しかし、foreachの方が簡単かな、とも思うときでもあります。

最後に、保管場所をstorage/app以外にしたいなら、config/filesystemes.phpの設定で変更できます。

...
    'disks' => [

        'local' => [
            'driver' => 'local',
            'root' => storage_path('app'), //ここを編集する
        ],
...

DBにインデックスを追加

Sun, 20 Jan 2019 03:17:58 +0900

正直言って、Laravelのmigration機能は私のLaravelのプロジェクトでは使用したことありません。よく理解していないこともあり、失敗してクライアントのデータベースを空にしてしまうことを考えると悪夢です。とか言ってコマンドラインでSQL文を実行する現状もリスクはそう変わりません。ということで、前回においてmigrationを使用する機会があったので、この際にmigrationの理解を深めたいです。

DBにインデックスを追加

まず、前回においては以下のようなmigrationを作成することで新規のテーブルaddressesを作成しました。

use Illuminate\Support\Facades\Schema;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Database\Migrations\Migration;
 
class CreateAddressesTable extends Migration
{
    /**
     * Run the migrations.
     *
     * @return void
     */
    public function up()
    {
        Schema::create('addresses', function (Blueprint $table) {
            $table->increments('id');
            $table->integer('user_id')->unsigned();
            $table->string('address');
            $table->timestamps();
        });
    }
 
    /**
     * Reverse the migrations.
     *
     * @return void
     */
    public function down()
    {
        Schema::dropIfExists('addresses');
    }
}

そして、以下を実行することで、addressesのテーブルを作成できます。

$ php artisan migrate
Migrating: 2019_01_10_140631_create_addresses_table
Migrated:  2019_01_10_140631_create_addresses_table

しかし、これではusersのテーブルとのjoinにおいてパフォーマンスが良くありません。例えば、以下のようなクエリを実行するときです。

Psy Shell v0.9.3 (PHP 7.1.14 — cli) by Justin Hileman
>>> User::join('addresses', 'users.id', '=', 'addresses.user_id')->get();

SQL文では以下となります。

mysql> select * from `users` inner join `addresses` on `users`.`id` = `addresses`.`user_id`

しかし、このjoinでは、データベースはマッチするuser_idを探すために毎回addressesのレコードをすべてチェックしなければなりません。レコード数が多くなれば、クエリの実行時間はとても長くなります。

しかし、これは、addresses.user_idにインデックスを追加するだけで簡単に解決できます。

migrationを作成してインデックスを追加してみましょう。

まず、migrationを作成します。

$ php artisan make:migration change_addresses --table=addresses

作成されたファイルを編集します。

use Illuminate\Support\Facades\Schema;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Database\Migrations\Migration;

class ChangeAddressesTable extends Migration
{
    /**
     * Run the migrations.
     *
     * @return void
     */
    public function up()
    {
        Schema::table('addresses', function (Blueprint $table) {
            $table->index('user_id');
        });
    }

    /**
     * Reverse the migrations.
     *
     * @return void
     */
    public function down()
    {
        Schema::table('addresses', function (Blueprint $table) {
            $table->dropIndex('addresses_user_id_index');
        });
    }
}

これだけです。rollbackのためにdown()も定義することを忘れないように。dropIndex()の引数は、DBの項目名ではなく、間に下線文字を入れて、テーブル名と項目名とindexの文字列をコンバインします（例：addresses_user_id_index）。

次は、このmigrationの反映ですが、その前に–pretendのオプションでどんなSQL文が実行されるかチェックしてみます。

$ php artisan migrate --pretend
ChangeAddressesTable: alter table `addresses` add index `addresses_user_id_index`(`user_id`)

いいですね。思い通りです。

実際にmigrateします。

$ php artisan migrate
Migrating: 2019_01_15_132109_change_addresses_table
Migrated:  2019_01_15_132109_change_addresses_table

住所タイプの導入とユニークインデックスの追加

次は、もう少し複雑なケースを見てみましょう。

現在は、1ユーザー(usersの1レコード）において、複数の住所（addressesのレコード）を紐づけることができますが、住所が会社のものか自宅なのか別荘（夢）なのかわかりません。そこで、その情報を保存するために住所タイプなるtypeという項目を追加します。

migrationを作成します。

$ php artisan make:migration change_addresses2 --table=addresses

作成されたファイルを編集します。

use Illuminate\Support\Facades\Schema;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Database\Migrations\Migration;

class ChangeAddresses2Table extends Migration
{
    /**
     * Run the migrations.
     *
     * @return void
     */
    public function up()
    {
        Schema::table('addresses', function (Blueprint $table) {
            // 項目の追加
            $table->string('type')->after('user_id');

            // インデックスを付け直す
            $table->dropIndex('addresses_user_id_index');
            $table->unique(['user_id','type']);
        });
    }

    /**
     * Reverse the migrations.
     *
     * @return void
     */
    public function down()
    {
        Schema::table('addresses', function (Blueprint $table) {
            $table->string('type')->after('user_id');                                                                                                                                                              
                                                                                                                                                                                                                   
            $table->dropIndex('addresses_user_id_index');                                                                                                                                                          
            $table->unique(['user_id','type']);  
        });
    }
}

typeの項目の追加の後には、現在のインデックスを削除して新規にuser_idとtypeをコンバインしたインデックスを追加しなおします。そして、1ユーザーに対して住所タイプは同じものを使用できない制限のために、unique()の関数を使用します。

またもや、–pretendでSQL文をチェックします。

$ php artisan migrate --pretend
ChangeAddresses2Table: alter table `addresses` add `type` varchar(191) not null after `user_id`
ChangeAddresses2Table: alter table `addresses` drop index `addresses_user_id_index`
ChangeAddresses2Table: alter table `addresses` add unique `addresses_user_id_type_unique`(`user_id`, `type`)

次は、migrateの実行なのですが、すでにデータがある状態で実行するとレコード重複のエラーが出る可能性あります。とくにすでに１ユーザーに対して複数の住所のレコードがある場合は、それらの項目に新規の項目typeに空が入ってくるからです。

今回は、このエラーを避けるために、migrate:freshを実行します。すべてのテーブルをdropしてから作成したmigrationをすべて実行してくれます。

$ php artisan migrate:fresh
Dropped all tables successfully.
Migration table created successfully.
Migrating: 2014_10_12_000000_create_users_table
Migrated:  2014_10_12_000000_create_users_table
Migrating: 2014_10_12_100000_create_password_resets_table
Migrated:  2014_10_12_100000_create_password_resets_table
Migrating: 2019_01_10_140631_create_addresses_table
Migrated:  2019_01_10_140631_create_addresses_table
Migrating: 2019_01_15_132109_change_addresses_table
Migrated:  2019_01_15_132109_change_addresses_table
Migrating: 2019_01_18_131940_change_addresses2_table
Migrated:  2019_01_18_131940_change_addresses2_table

しかし、実際のプロダクションではできないことですね。データ皆空になってしまうし。その対応は課題としましょう。

フェイクデータの作成

さて、DBテーブルができたところで、前回のようにフェイクデータの作成をしてみたいです。

今回追加したtypeの項目のために、database/factories/AddressFactory.phpを編集します。

use Faker\Generator as Faker;

$factory->define(App\Address::class, function (Faker $faker) {
    return [
       'type'    => $faker->randomElement(['自宅', '会社']),
       'address' => $faker->address
    ];
});

tinkerで実行してみます。

>>> factory(App\User::class,3)->create()->each(function ($user) { $user->addresses()->save(factory(App\Address::class)->make()); });
...
User::join('addresses', 'users.id', '=', 'addresses.user_id')->get();
=> Illuminate\Database\Eloquent\Collection {#2346
     all: [
       App\User {#2307
         id: 1,
         name: "山本 七夏",
         email: "hirokawa.osamu@example.org",
         created_at: "2019-01-19 02:33:51",
         updated_at: "2019-01-19 02:33:51",
         user_id: 1,
         type: "自宅",
         address: "5212837  京都府佐々木市西区近藤町加納9-4-4 コーポ宮沢110号",
       },
       App\User {#2353
         id: 2,
         name: "若松 裕樹",
         email: "tsuda.rika@example.com",
         created_at: "2019-01-19 02:33:51",
         updated_at: "2019-01-19 02:33:51",
         user_id: 2,
         type: "自宅",
         address: "4853444  奈良県佐々木市南区鈴木町廣川8-3-9",
       },
       App\User {#2355
         id: 3,
         name: "江古田 裕太",
         email: "ksato@example.org",
         created_at: "2019-01-19 02:33:51",
         updated_at: "2019-01-19 02:33:51",
         user_id: 3,
         type: "会社",
         address: "8386040  愛知県宮沢市中央区井高町加納4-2-10",
       },
     ],
   }

うまくフェイクデータが作成されましたね。

最後に１つ有用なコマンドとして、migrate:status。現在のmigrationのステータスを一覧できます。左の1列目がすべてＹとなっているのは現在あるmigrationがすべて実行された状態です。

$ php artisan migrate:status
+------+------------------------------------------------+
| Ran? | Migration                                      |
+------+------------------------------------------------+
| Y    | 2014_10_12_000000_create_users_table           |
| Y    | 2014_10_12_100000_create_password_resets_table |
| Y    | 2019_01_10_140631_create_addresses_table       |
| Y    | 2019_01_15_132109_change_addresses_table       |
| Y    | 2019_01_18_131940_change_addresses2_table      |
+------+------------------------------------------------+

migrate:rollbackしたなら、すべてNoのＮとなります。

+------+------------------------------------------------+
| Ran? | Migration                                      |
+------+------------------------------------------------+
| N    | 2014_10_12_000000_create_users_table           |
| N    | 2014_10_12_100000_create_password_resets_table |
| N    | 2019_01_10_140631_create_addresses_table       |
| N    | 2019_01_15_132109_change_addresses_table       |
| N    | 2019_01_18_131940_change_addresses2_table      |
+------+------------------------------------------------+

hasManyのフェイクデータの作成

Sun, 13 Jan 2019 02:19:08 +0900

hasManyリレーションは、Eloquentのモデル間（つまり、DBのテーブル間）に1対多の関係を持たせるリレーションです。今回は、factory()を使って、このhasManyのリレーションを持つDBテーブルにフェイクデータを作成してみます。

hasMany

DBにおける1対多の関係では、2つのDBテーブルを親子とみなすと、親の１レコードに対してそれに紐づく子のレコードが１あるいは複数存在します。

例えば、親をusers（ユーザー）、子をaddresses（住所）とし、それぞれのEloquentのモデル、User、Addressを定義し、User::addresses()のリレーションを定義すれば、以下のようなデータとなります。

>>> User::find(1)->load('addresses');
=> App\User {#2312
     id: 1,
     name: "原田 涼平",
     email: "esasada@example.com",
     created_at: "2019-01-12 01:53:58",
     updated_at: "2019-01-12 01:53:58",
     addresses: Illuminate\Database\Eloquent\Collection {#2340
       all: [
         App\Address {#2349
           id: 1,
           user_id: 1,
           address: "8731301  山口県石田市中央区田中町高橋1-5-6 コーポ高橋110号",
           created_at: "2019-01-12 01:53:58",
           updated_at: "2019-01-12 01:53:58",
         },
         App\Address {#2348
           id: 2,
           user_id: 1,
           address: "7159410  京都府坂本市北区加納町加藤9-7-8",
           created_at: "2019-01-12 01:53:58",
           updated_at: "2019-01-12 01:53:58",
         },
       ],
     },
   }

ここでは、原田さんは２つの住所を持つことが表示されています。もちろん、これらはフェイクデータですが、次の準備をすればこれがtinkerの１行の実行で親子のレコードを作成できます。

準備

Laravelの新規のプロジェクトを作成すると、usersのmigration、model、factoryがすでに定義されています。ここで必要なのは、addressesにおいて同様な定義です。

まず、migrationから

$ php artisan make:migration create_addresses_table --create=addresses

上のコマンドラインでの実行で、

$ ls -1 database/migrations 
2014_10_12_000000_create_users_table.php
2014_10_12_100000_create_password_resets_table.php
2019_01_10_140631_create_addresses_table.php

2019_01_10_140631_create_addresses_table.phpのファイルが作成されます。これを以下のように編集。

use Illuminate\Support\Facades\Schema;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Database\Migrations\Migration;

class CreateAddressesTable extends Migration
{
    /**
     * Run the migrations.
     *
     * @return void
     */
    public function up()
    {
        Schema::create('addresses', function (Blueprint $table) {
            $table->increments('id');
            $table->integer('user_id')->unsigned();
            $table->string('address');
            $table->timestamps();
        });
    }

    /**
     * Reverse the migrations.
     *
     * @return void
     */
    public function down()
    {
        Schema::dropIfExists('addresses');
    }
}

users.idと紐づけるために、addresses.user_idの項目が追加されていることに注意してください。

そして、次を実行して、addressesのDBテーブルを作成します。

$ php artisan migrate
Migrating: 2019_01_10_140631_create_addresses_table
Migrated:  2019_01_10_140631_create_addresses_table

次に、モデルを作成。これもコマンドラインで実行。

$ php artian make:model Address

以下のファイルが作成されます。

app/Address.php

そしてこれを以下のように編集。

namespace App;

use Illuminate\Database\Eloquent\Model;

class Address extends Model
{
    protected $fillable = [
        'address'
    ];
}

Addressのモデルができたところで、UserのモデルにhasManyのリレーション、addresses()を定義します。

app/User.php

namespace App;

use Illuminate\Notifications\Notifiable;
use Illuminate\Foundation\Auth\User as Authenticatable;
use App\Auth\Passwords\CanResetPassword;

class User extends Authenticatable
{
    use Notifiable;
	use CanResetPassword;

    /**
     * The attributes that are mass assignable.
     *
     * @var array
     */
    protected $fillable = [
        'name', 'email', 'password',
    ];

    /**
     * The attributes that should be hidden for arrays.
     *
     * @var array
     */
    protected $hidden = [
        'password', 'remember_token',
    ];

    public function addresses()
    {
        return $this->hasMany('App\Address');
    }
}

そして、Addressのフェイクデータを作成するためにfactoryを作成します。

$ php artisan make:factory AddressFactory

この実行でAddressFactory.phpのファイルが作成されます。

$ ls -1 database/factories 
AddressFactory.php
UserFactory.php

これを以下のように編集。

use Faker\Generator as Faker;                                                                                                                                                                                      
                                                                                                                                                                                                                   
$factory->define(App\Address::class, function (Faker $faker) {                                                                                                                                                     
    return [                                                                                                                                                                                                       
       'address' => $faker->address                                                                                                                                                                                
    ];                                                                                                                                                                                                             
});

最後に、フェイクデータを日本語で作成するために、config/app.phpに以下を追加します。

..
    'faker_locale' => 'ja_JP', 
..

これで準備終わり。

フェイクデータの作成

さて、tinkerの出番です。

$ php artisan tinker

>>> factory(App\User::class)->create()->each(function ($user) { $user->addresses()->save(factory(App\Address::class)->make()); });
=> true
>>> User::find(1)->load('addresses');
=> App\User {#2310
     id: 1,
     name: "近藤 亮介",
     email: "mikako.koizumi@example.net",
     created_at: "2019-01-12 02:56:16",
     updated_at: "2019-01-12 02:56:16",
     addresses: Illuminate\Database\Eloquent\Collection {#2347
       all: [
         App\Address {#2349
           id: 1,
           user_id: 1,
           address: "8657778  滋賀県松本市南区中島町笹田9-6-2",
           created_at: "2019-01-12 02:56:16",
           updated_at: "2019-01-12 02:56:16",
         },
       ],
     },
   }

factoryの実行文が長いので、整形して表示してみましょう。

factory(App\User::class)->create()
    ->each(function ($user) {
        $user->addresses()
            ->save(
               factory(App\Address::class)->make()
　　　　     ); 
    });

1行目で、usersのレコードが作成され、それぞれのusersのレコードにおいて、addresses()のリレーションをもとにaddressesのレコードが作成されます。

１つのusersのレコードに対して、addressesのレコードが複数欲しいなら、save()の部分を

saveMany(factory(App\Address::class, 2)

に置き換えます。以下のように２つaddressesのレコード作成となります。

>>> factory(App\User::class)->create()->each(function ($user) { $user->addresses()->saveMany(factory(App\Address::class, 2)->make()); });
=> true
>>> User::find(2)->load('addresses');
=> App\User {#2368
     id: 2,
     name: "津田 七夏",
     email: "kudo.kaori@example.org",
     created_at: "2019-01-12 02:59:24",
     updated_at: "2019-01-12 02:59:24",
     addresses: Illuminate\Database\Eloquent\Collection {#2369
       all: [
         App\Address {#2354
           id: 4,
           user_id: 2,
           address: "8621292  長崎県石田市中央区大垣町渡辺3-6-8",
           created_at: "2019-01-12 02:59:24",
           updated_at: "2019-01-12 02:59:24",
         },
         App\Address {#2357
           id: 5,
           user_id: 2,
           address: "6857809  沖縄県三宅市南区山本町山岸9-5-9 コーポ山口101号",
           created_at: "2019-01-12 02:59:24",
           updated_at: "2019-01-12 02:59:24",
         },
       ],
     },
   }

DBレコードのコピー

Sun, 06 Jan 2019 05:34:12 +0900

レコードのコピーという作業は結構起こることです。例えば、Eコーマースのサイトなら、サイズだけが違う商品は、説明などの他の属性はほとんど同じなので、わざわざ新規の商品の情報をすべて手入力というよりは、既存の商品をもとに編集する方がもちろん簡単です。

さて、このレコードのコピー作業、Eloquentではどうやるのでしょう？

tinkerを立ち上げます。

まず、usersのテーブルを空にしましょう。

Psy Shell v0.9.9 (PHP 7.1.14 — cli) by Justin Hileman
>>> User::truncate();
=> Illuminate\Database\Eloquent\Builder {#2862}
>>> User::count();
=> 0

次に、ファクトリーを利用してレコードを１つ作成します。

>>> factory(App\User::class, 1)->create();
=> Illuminate\Database\Eloquent\Collection {#2896
     all: [
       App\User {#2892
         name: "Yessenia Jast",
         email: "modesto24@example.org",
         updated_at: "2019-01-06 05:13:54",
         created_at: "2019-01-06 05:13:54",
         id: 1,
       },
     ],
   }
>>>

そして、このレコードをcloneして保存。

>>> $user = User::find(1);
=> App\User {#121
     id: 1,
     name: "Yessenia Jast",
     email: "modesto24@example.org",
     created_at: "2019-01-06 05:13:54",
     updated_at: "2019-01-06 05:13:54",
   }
>>> $clone = clone $user;
=> App\User {#2894
     id: 1,
     name: "Yessenia Jast",
     email: "modesto24@example.org",
     created_at: "2019-01-06 05:13:54",
     updated_at: "2019-01-06 05:13:54",
   }
>>> $clone->save();
=> true
>>> User::count();
=> 1
>>>

あれれ、新規のレコードを作成してくれませんね。レコード数はオリジナルのレコードの1個です。$cloneは単に同じDBレコードを違うオブジェクトとしただけなので、$clone->save()は新規登録ではなく既存のレコードの編集となってしまうようです。

正しいやり方は、Eloquentのreplicate()を使用してコピーのオブジェクトを作成します。

>>> $clone = $user->replicate();
=> App\User {#2862
     name: "Yessenia Jast",
     email: "modesto24@example.org",
   }
>>> $clone->email = 'test@example.com';
=> "test@example.com"
>>> $clone->save();
=> true

emailはユニークな値でないとDBの重複エラーとなるので違う値にしてsaveしていることに注意してください。

以下のように、レコードは２つになり、複製が作成されています。

>>> User::all();
=> Illuminate\Database\Eloquent\Collection {#2863
     all: [
       App\User {#2888
         id: 1,
         name: "Yessenia Jast",
         email: "modesto24@example.org",
         created_at: "2019-01-06 05:13:54",
         updated_at: "2019-01-06 05:13:54",
       },
       App\User {#2893
         id: 2,
         name: "Yessenia Jast",
         email: "test@example.com",
         created_at: "2019-01-06 05:16:06",
         updated_at: "2019-01-06 05:16:06",
       },
     ],
   }

連想配列のマージ

Sat, 08 Sep 2018 06:15:58 +0900

今回はLaravelを離れてPHPのベーシックの話となります。連想配列（associative array）のマージに関してです。なかな知っているようで使用を間違うことがあります。

そういうきは、私が大好きなツール、tinkerを使ってちょいちょいと実行して確認してみるのが一番。

array_merge

まずは、array_mergeを使用して２つの配列、$productと$moreをマージ。

>>> $product = ['product_id' => 1, 'name' => '商品名']
=> [
     "product_id" => 1,
     "name" => "商品名",
   ]
>>> $more = ['price' => 200]
=> [
     "price" => 200,
   ]
>>> array_merge($product, $more)
=> [
     "product_id" => 1,
     "name" => "商品名",
     "price" => 200,
   ]

両方の配列の項目が１つに収まります。

さて、両方の配列に同じ項目があるときはどうでしょう？

>>> $product = ['product_id' => 1, 'name' => '商品名']
=> [
     "product_id" => 1,
     "name" => "商品名",
   ]
>>> $more = ['price' => 200, 'name' => '上書き商品名']
=> [
     "price" => 200,
     "name" => "上書き商品名",
   ]
>>> array_merge($product, $more)
=> [
     "product_id" => 1,
     "name" => "上書き商品名",
     "price" => 200,
   ]

後者の配列に前者と同じ項目があるなら、後者の配列の値が前者を上書きとなります。

+

連想配列をマージできるのは、array_mergeだけではありません。足し算の+のオペレータも同様なことができます。

>>> $product = ['product_id' => 1, 'name' => '商品名']
=> [
     "product_id" => 1,
     "name" => "商品名",
   ]
>>> $more = ['price' => 200, 'name' => '上書き商品名']
=> [
     "price" => 200,
     "name" => "上書き商品名",
   ]
>>> $product + $more
=> [
     "product_id" => 1,
     "name" => "商品名",
     "price" => 200,
   ]

しかし今度は、後者の配列に前者と同じ項目があるなら、上書きは起こりません。

キーが数字のとき

上の例は、連想配列のキーが文字列でしたが、数字のときにはどうなるでしょう？　例えば、キーにDBのレコードのID（数字）を入れて配列を作成するケースは良くあります。

>>> $products = [11 => '商品A', 12 =>'商品B']
=> [
     11 => "商品A",
     12 => "商品B",
   ]
>>> $more_products = [13 => '商品C', 14 => '商品D']
=> [
     13 => "商品C",
     14 => "商品D",
   ]
>>> array_merge($products, $more_products)
=> [
     [
       "商品A",
     ],
     [
       "商品B",
     ],
     [
       "商品C",
     ],
     [
       "商品D",
     ],
   ]
>>> $products + $more_products
=> [
     11 => [
       "商品A",
     ],
     12 => [
       "商品B",
     ],
     13 => [
       "商品C",
     ],
     14 => [
       "商品D",
     ],
   ]

サプライズ！上の例のように両方の配列のキーがどれも数字なら、array_mergeでは、割り当てたキーが皆消えてしまいます。実際には消えるのではなく、キーが0,1,2,3と順番に与えられて通常の配列になります。しかし、+で足し算をするなら、キーは結果においてキープされます。しかし、両者の配列に同じキーがあるなら、さきほどのように後者は前者を上書きはしません。

>>> $products = [11 => '商品A', 12 =>'商品B']
=> [
     11 => "商品A",
     12 => "商品B",
   ]
>>> $more_products = [12 => '商品C', 13 => '商品D']
=> [
     12 => "商品C",
     13 => "商品D",
   ]
>>> $products + $more_products
=> [
     11 => "商品A",
     12 => "商品B",
     13 => "商品D",
   ]

ティンカーでリクエスト（Request）

Sat, 09 Jun 2018 09:00:44 +0900

前回に引き続いてリクエストの話です。ブラウザがないとリクエスト（Request）のオブジェクトが作成できない、とは限りません。Laravelならコマンドラインで作成できます。どうやって？

リクエストオブジェクトの作成

コマンドラインと言えばもちろん、tinkerのことです。以下のように、クラスのcreate()メソッドを使って、リクエストのオブジェクトを作成できます。

Psy Shell v0.9.3 (PHP 7.1.14 — cli) by Justin Hileman

>>> $request = \Illuminate\Http\Request::create('http://localhost', 'GET', ['name' => 'test']);

=> Illuminate\Http\Request {#2324
     ⚠: Symfony\Component\VarDumper\Exception\ThrowingCasterException {#2309
       #message: "Unexpected ErrorException thrown from a caster: Undefined index: ",
     },
     +attributes: Symfony\Component\HttpFoundation\ParameterBag {#2320},
     +request: Symfony\Component\HttpFoundation\ParameterBag {#2322},
     +query: Symfony\Component\HttpFoundation\ParameterBag {#2321},
     +server: Symfony\Component\HttpFoundation\ServerBag {#2317},
     +files: Symfony\Component\HttpFoundation\FileBag {#2318},
     +cookies: Symfony\Component\HttpFoundation\ParameterBag {#2319},
     +headers: Symfony\Component\HttpFoundation\HeaderBag {#2316},
   }

Laravelのリクエストは、Symfonyのクラスがベースになっているようです。createは、Laravelのクラスのメソッドではなく、Symfonyのクラスのメソッドです。参考のために、以下にその定義の一部を掲載します。

SymfonyComponentHttpFoundationRequest.php

    /**
     * Creates a Request based on a given URI and configuration.
     *
     * The information contained in the URI always take precedence
     * over the other information (server and parameters).
     *
     * @param string               $uri        The URI
     * @param string               $method     The HTTP method
     * @param array                $parameters The query (GET) or request (POST) parameters
     * @param array                $cookies    The request cookies ($_COOKIE)
     * @param array                $files      The request files ($_FILES)
     * @param array                $server     The server parameters ($_SERVER)
     * @param string|resource|null $content    The raw body data
     *
     * @return static
     */
    public static function create($uri, $method = 'GET', $parameters = array(), $cookies = array(), $files = array(), $server = array(), $content = null)
    {
    ..

先のtinkerの実行では、create()の3番目のパラメータに、連想配列で値（[’name’ => ’test’]）を渡しました。ということは、以下のtinkerの実行で変数の取り出し可能です。

>>> $request->all();

=> [
     "name" => "test",
   ]

>>> $request->input();

=> [
     "name" => "test",
   ]

>>> $request->name;

=> "test"

>>> $request->input('name');

=> "test"

>>> $request->get('name');

=> "test"
>>>

前回に説明したことが、ここで簡単にシミュレートできるのです。

そして、さらに、こんなこともテストできます。簡単なValidationのテストです。

>>> $request->validate(['name' => 'required']);

=> [
     "name" => "test",
   ]

>>> $request->validate(['name' => 'required|alpha']);

=> [
     "name" => "test",
   ]

>>> $request->validate(['name' => 'alpha']);
=> [
     "name" => "test",
   ]

>>> $request->validate(['name' => 'numeric']);
Illuminate/Validation/ValidationException with message 'The given data was invalid.'
>>>

Validationに成功したら、入力の連想配列を返し、失敗したらValidationExceptionを返します。

tinkerの便利さは、いちいちプログラムを書かずに、ブラウザを立ち上げることなしに、テストできることです。こんな便利なツールを習得せずに、Laravelを語ることはできません。

もっとティンカー(tinker)を使おう！

Wed, 27 Dec 2017 06:29:23 +0900

今年最後の投稿です。まだまだ投稿のネタはたくさんあります。来年も楽しみに！

tinkerに関しては、以前に紹介していますが、私には現在もなくてはならないコマンドラインツール。

このツール、実は機能が豊富にあるということ最近気づきました。ますます好きになりました。

私がtinkerを利用する一番の理由は、Laravelの知らない、あるいは正確なシンタックスを覚えていないメソッドをテストしたいときです。dd()入れてブラウザで実行して結果をチェックするのは面倒、unit testを書くには大袈裟なとき、tinkerが一番です。

例えば、以下pluckの関数のパラメータ、どっちが配列のインデックスになるのだっけ？　all()のコールは必要だっけ？　・・というときに。

$ php artisan tinker
Psy Shell v0.8.11 (PHP 7.0.23 — cli) by Justin Hileman
>>> use App\User;
>>> User::all()->pluck('id', 'name');
=> Illuminate\Support\Collection {#705
     all: [
       "kenji" => 1,
       "test" => 2,
     ],
   }
>>> User::all()->pluck('name', 'id');
=> Illuminate\Support\Collection {#703
     all: [
       1 => "kenji",
       2 => "test",
     ],
   }
>>> User::pluck('name', 'id');
=> Illuminate\Support\Collection {#705
     all: [
       1 => "kenji",
       2 => "test",
     ],
   }
>>>

と、いちいちマニュアルをチェックすることなしに、まずは実行して試す。

実行した結果だけでなく、プログラム自体の表示も可能です。

>>> show User
  >  9| class User extends Authenticatable
    10| {
    11|     use Notifiable;
    12|         use CanResetPassword;
    13| 
    14|     /**
    15|      * The attributes that are mass assignable.
    16|      *
    17|      * @var array
    18|      */
    19|     protected $fillable = [
    20|         'name', 'email', 'password',
    21|     ];
    22| 
    23|     /**
    24|      * The attributes that should be hidden for arrays.
    25|      *
    26|      * @var array
    27|      */
    28|     protected $hidden = [
    29|         'password', 'remember_token',
    30|     ];
    31| }

クラス全体だけでなく、指定のメソッドのコード部分も。実際は以下の画像のように、綺麗な色付きで表示されるので読みやすいです。

bashのhistoryのように、今まで実行した履歴も閲覧可能です。

>>> hist
0: use App\User;
1: User::all()->pluck('id', 'name');
2: User::all()->pluck('name', 'id');
3: User::pluck('name', 'id');

histの結果は、とても長くなるので、一部だけを閲覧することも可能です。

>>> hist --show 1..3
0: use App\User;
1: User::all()->pluck('id', 'name');
2: User::all()->pluck('name', 'id');
3: User::pluck('name', 'id');

さらに、履歴を–replayで再実行可能です。

>>> hist --show 2 --replay
Replaying 1 line of history
-->   User::all()->pluck('name', 'id');
=> Illuminate\Support\Collection {#708
     all: [
       1 => "kenji",
       2 => "test",
     ],
   }

histには、他にも–head、–tail、–grepのオプションがあります。

さらに、tinkerは、php関数のマニュアルも出力することも可能です。

まず、設定として、マニュアルをダウンロードします。ファイルは11MBのサイズです。

mkdir ~/.local/share/psysh
cd ~/.local/share/psysh
wget http://psysh.org/manual/ja/php_manual.sqlite

関数のマニュアルを表示するには、docを利用します。例えば、

>>> doc array_shift

とタイプすれば、

と日本語で表示してくれます。また、Laravelの関数では、クラスのパス名を指定すれば、

>>> doc \Illuminate\Http\Request::input
public function input($key = null, $default = null)

Description:
  Retrieve an input item from the request.

Param:
  string             $key     
  string|array|null  $default 

Return:
  string|array

と説明が見れます。

最後に、Laravelのtinkerは、以下のPsySHのラッパーです。 https://github.com/bobthecow/psysh こんな便利なツールを開発してくれて、ありがとう！

アーティザンのティンカー

Wed, 12 Aug 2015 12:44:26 +0900

前回の投稿「ダーティーなレコード」で、DBレコードが更新されたかどうか、簡単に実験してチェックできるツールを紹介しましょう。

ララベルにはコマンドで実行できる強力なツール、その名もアーティザン(Artisan)があります。このアーティザン、Macを含めてUnix系の開発者には便利でこのうえないツール。しかも、複数のコマンドがあるわけでなく、１つのコマンドでオプションを変えるだけでいろいろなことができる優れもの。

$ php artisan list

とタイプすればたくさんのオプションのヘルプがでてきます。

さて、この中でとてもユニークなのが、今回紹介するTinker

$ php artisan tinker

Psy Shell v0.4.4 (PHP 5.5.25 - cli) by Justin Hileman
>>>

まず、Eloquentのモデルを利用してレコードを取ってきましょう.

>>> use App\Models\Product
=> false
>>> $product = Product::find(1)
=> <App\Models\Product #000000000db510bc000000004b81eec1> {
       product_id: 1,
       created_at: "2015-04-25 12:22:10",
       updated_at: "2015-08-05 13:15:25",
       name: "test product",
       price: "1000"
   }
>>>

次に、価格（price）を更新してみます。

>>> $product->price = "2000"
=> "2000"
>>> $porduct->isDirty()
=> true
>>> $product->save()
=> true
>>> $product
=> <App\Models\Product #000000000ee7a5b70000000066692faa> {
       product_id: 1,
       created_at: "2015-04-25 12:22:10",
       updated_at: "2015-08-11 09:33:23",
       name: "test product",
       price: "2000"
   }
>>>

isDirty()は変更されたのでもちろんtrue、また update_atも更新時の日時に更新されています。

今までのDBのクエリの履歴を見たいなら、

>>> DB::getQueryLog()
=> [
       [
           "query"    => "select * from `product` where `product`.`product_id` = ? limit 1",
           "bindings" => [
               3
           ],
           "time"     => 0.56
       ],
       [
           "query"    => "update `product` set `updated_at` = ?, `price` = ? where `product_id` = ?",
           "bindings" => [
               "2015-08-11 09:33:23",
               "2000",
               3
           ],
           "time"     => 3.13
       ]
   ]
>>>

さて、今度は同じ値を入れてみましょう。

>>> $product->price = "2000"
=> "2000"
>>> $product->isDirty()
=> false
>>> $product->save()
=> true
>>> $product
=> <App\Models\Product #000000000ee7a5b70000000066692faa> {
       product_id: 1,
       created_at: "2015-04-25 12:22:10",
       updated_at: "2015-08-11 09:33:23",
       name: "test product",
       price: "2000"
   }
>>>

レコードではダーティーではなく(false)、またsave()しているにもかかわらず、update_atの値にも変化ありませんね。

ここで、DB::geQueryLog()を実行すれば、さきとまったく同じ履歴が出てきます。つまり、DBの処理は何もなかったを証明します。

ティンカー便利ですね。ブラウザを使わなくとも、ユニットテストを書かなくても、ここでテストができるのが便利です。

追記：

今回のティンカーは、バージョン5.1のララベルを使用しています。他のバージョンでは、コマンドのプロンプトのシンボルが違ったりや行末のセミコロンの必須となったります。ご注意を。

Tinker on ララジャパン

request()ヘルパーが変？

request()に値がない

グローバルのRequestオブジェクト

tinkerでartisanを実行

route()ヘルパー

UUID ユニークなID

UUIDとは

Laravelで使用するには

idを隠す

コントローラからuuidでアクセス

ダウンロードファイル名禁止文字に対応

ブラウザからtinkerにアクセス

インストール

フロントエンド

fresh() vs refresh()

isDirty() vs wasChanged()

カスタムルールオブジェクト

Laravel 5.6で追加されたバリデーション

こういうときにwhereRawを使う

正しいのは、isEmptyでした

tinkerのブートストラップファイル

mapとfilter

DBにインデックスを追加

DBにインデックスを追加

住所タイプの導入とユニークインデックスの追加

フェイクデータの作成

hasManyのフェイクデータの作成

hasMany

準備

フェイクデータの作成

DBレコードのコピー

連想配列のマージ

array_merge

+

キーが数字のとき

ティンカーでリクエスト（Request）

リクエストオブジェクトの作成

もっとティンカー(tinker)を使おう！

アーティザンのティンカー

UUID　ユニークなID