前回に作成したLaravelの日本語レポジトリ(Laravel 5.3)。今回はその作成の仕方を説明します。
コマンドの実行
まずは、以下のcomposerのコマンドを実行します。
composer create-project --prefer-dist laravel/laravel larajapan 5.3.*
上で使用されているコマンドの引数は、
--prefer-dist laravel/laravel
https://packagist.org/packages/laravel/laravelからパッケージをダウンロードすることを指示します。
larajapan
パッケージのダウンロード先。その名前でディレクトリを作成します。このディレクトリ名は、先のコマンドラインで違う名前を指定可能であるし、実行完了してから改名も可能です。
5.3.*
パッケージのバージョンを指定。ここでは、laravelの5.3を使用します。マイナーバージョンを指定したいなら、5.3.30
のように指定します。
実行すると、パッケージに含まれるファイル、さらにパッケージが依存するパッケージのファイルが多数ダウンロードされ少々時間がかかります。
最終的には、実行したディレクトリのもとにlarajapan
のディレクトリが作成され、ダウンロードされたファイルが収納されます。
larajapan ├── app/ ├── bootstrap/ ├── config/ ├── database/ ├── public/ ├── resources/ ├── routes/ ├── storage/ ├── tests/ ├── vendor/ ├── artisan* ├── composer.json ├── composer.lock ├── gulpfile.js ├── package.json ├── phpunit.xml ├── readme.md └── server.php
次に、ユーザー認証のためのファイル作成を以下の実行で行います。
php artisan make:auth
この実行により、resources/views
のディレクトリにおいて、すでにインストールされている以下のコントローラで使用されるblade
ファイルが作成されます。
app/Http/Controllers ├── Auth/ │ ├── ForgotPasswordController.php(パスワードのリセットのリンク送信画面) │ ├── LoginController.php(ログイン画面) │ ├── RegisterController.php(会員登録画面) │ └── ResetPasswordController.php(パスワードリセット画面) ├── Controller.php └── HomeController.php(ログイン後のホーム画面)
最後に以下のコマンドを実行して、先のパスワードのリセットのリンク送信画面から発行されるEメールので使用されるHTMLのテンプレートを作成作成します。
php artisan vendor:publish
日本語化
さて、ここからが日本語化の作業です。
まず、config/app.php
の編集から。
... 'timezone' => 'UTC', 'locale' => 'en', ...
を
... 'timezone' => 'Asia/Tokyo', 'locale' => 'ja', ...
と変えて保存します。
timezone
これは、通常、プログラム内の日時設定のタイムゾーンとして使用されるもので、PHPの以下の関数で使用されます。
ここで設定すれば、後はLaravelが面倒みてくれます。
日本時間の場合は、Aisa/Tokyoの設定だけで十分。
locale
resources/lang
で言語のファイルが以下のように存在します。これらは、Laravelのプロジェクトでバリデーションのエラーメッセージなどを定義しています。
resources/lang └── en/ ├── auth.php ├── pagination.php ├── passwords.php └── validation.php
デフォルトの設定では、英語のen
のディレクトリしかありません。日本語の翻訳を作成するには、上で設定したja
と同じ名前のディレクトリをそこに作成します。以下の実行でディレクトリごとコピーしてください。
$ cp -pr en ja
バリデーションに関しては、見米氏のバリデーション(1)Validatorファサードのextend を参照してください。
次は、ユーザー認証画面などで使用されるブレードファイルの翻訳です。
私のLaravelの日本語レポジトリでは、以下は、すべて翻訳してあります。
resources/views ├── auth │ ├── login.blade.php │ ├── passwords │ │ ├── email.blade.php │ │ └── reset.blade.php │ └── register.blade.php ├── errors │ └── 503.blade.php ├── home.blade.php ├── layouts │ └── app.blade.php ├── vendor │ ├── notifications │ │ ├── email.blade.php │ │ └── email-plain.blade.php │ └── pagination │ ├── bootstrap-4.blade.php │ ├── default.blade.php │ ├── simple-bootstrap-4.blade.php │ └── simple-default.blade.php └── welcome.blade.php
翻訳とは関係ありませんが、app.blade.php
のレイアウトで参照されている、app.css
とapp.js
には、url()
を入れて、プロジェクトがインストールされるディレクトリが変わっても参照されるようにしてあります。
パスワードリセットで送信されるEメールの翻訳
ここまで来ても、残念ながら、パスワードを忘れたときに送信される、パスワードリセットを含むEメールの内容がまだ翻訳されていません。なぜなら、本文がハードコードされているからです。
これはちょっと頭をひねりましたが、多分以下が最小の変更で対応できると思います。
まず、
vendor/laravel/framework/src/Illuminate/Auth
のディレクトリからResetPassword.php
とCanResetPassword.php
のファイルを以下の場所にコピーします。
app/Auth ├── Notifications/ │ └── ResetPassword.php └── Passwords/ └── CanResetPassword.php
次に、以下のようにファイルを編集します。app/User.php
のファイルも変更必要です。
namespace App\Auth\Notifications; use Illuminate\Notifications\Notification; use Illuminate\Notifications\Messages\MailMessage; class ResetPassword extends Notification { ... /** * Build the mail representation of the notification. * * @param mixed $notifiable * @return \Illuminate\Notifications\Messages\MailMessage */ public function toMail($notifiable) { return (new MailMessage) ->subject('パスワードリセット') ->greeting('パスワードリセット') ->line('パスワードリセットリンクの送信のリクエストがありました。') ->action('リセットパスワード', url('password/reset', $this->token)) ->line('リクエストされていなかったら、無視してください。'); } }
namespace App\Auth\Passwords; use App\Auth\Notifications\ResetPassword as ResetPasswordNotification; trait CanResetPassword { /** * Get the e-mail address where password reset links are sent. * * @return string */ public function getEmailForPasswordReset() { return $this->email; } /** * Send the password reset notification. * * @param string $token * @return void */ public function sendPasswordResetNotification($token) { $this->notify(new ResetPasswordNotification($token)); } }
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; ...
認証のroutesの設定
日本語化とは関係ないですが、私がこうした方がわかりやすいと思ったことです。
オリジナルのroutes.php
は、
Route::get('/', function () { return view('welcome'); }); Auth::routes(); Route::get('/home', 'HomeController@index');
とシンプルですが、Auth::routes()
で認証のrouteが隠されてしまって不透明。
ということで、私のLaravelの日本語レポジトリでは、以下のように編集しました。
// 以下は、Auth::routes()の中身を移したもの。将来において変更が可能なように // Authentication Routes... Route::get('login', 'Auth\LoginController@showLoginForm')->name('login'); Route::post('login', 'Auth\LoginController@login'); Route::post('logout', 'Auth\LoginController@logout')->name('logout'); // Registration Routes... Route::get('register', 'Auth\RegisterController@showRegistrationForm')->name('register'); Route::post('register', 'Auth\RegisterController@register'); // Password Reset Routes... Route::get('password/reset', 'Auth\ForgotPasswordController@showLinkRequestForm'); Route::post('password/email', 'Auth\ForgotPasswordController@sendResetLinkEmail'); Route::get('password/reset/{token}', 'Auth\ResetPasswordController@showResetForm'); Route::post('password/reset', 'Auth\ResetPasswordController@reset'); Route::get('/home', 'HomeController@index');
最後に
Laravelの最新バージョンは今週に5.3から5.4となりました。今回説明した(前回に作成したLaravelの日本語レポジトリも)はバージョン5.3をベースにしたものです。しかし、バージョン5.4での日本語レポジトリ作成もいくつかファイルは違いますが、基本的には、最初のcomposerの実行で、5.3.*
の代わりに、5.4.*
と指定すれば、同じような手順で作成できます。