ソフトウェアエンジニアの技術ブログ：Software engineer tech blog – Page 294 – 随机应变 ABCD: Always Be Coding and … : хороший

Laravel Collectiveを使用して入力フォームを作成するまで

Laravel Collectiveを使用して入力フォーム・バリデーションを作成するまでの一連の流れです。フォームを作成してから、requestsを作ります。

php composer.phar require laravelcollective/html

.config/app.php

Collective\Html\HtmlServiceProvider::class,

'Form' => Collective\Html\FormFacade::class,
'Html' => Collective\Html\HtmlFacade::class,

view: resources/view/admin/users/
create.blade.php

<h1>Create Users</h1>
	{!! Form::open(['method'=>'POST', 'action'=>'AdminUsersController@store', 'files'=>true]) !!}
        {{ csrf_field()}}
 
        <div class="form-group">
            {!! Form::label('name', 'Name') !!}
            {!! Form::text('name', null, ['class'=>'form-control']) !!}
        </div>
        <div class="form-group">
            {!! Form::submit('Create Post', ['class'=>'btn btn-primary']) !!}
        </div>
    {!! Form::close() !!}

AdminUsersController.php
テーブルからリストを呼び出す

public function create()
    {
        //
        $roles = Role::lists('name','id')->all();
        return view('admin.users.create', compact('roles'));
    }

create.blade.php
array(”=>’Choose Options’) + $rolesとして、rolesテーブルから自動的にselect文を生成する

{!! Form::open(['method'=>'POST', 'action'=>'AdminUsersController@store', 'files'=>true]) !!}
        {{ csrf_field()}}
 
        <div class="form-group">
            {!! Form::label('name', 'Name') !!}
            {!! Form::text('name', null, ['class'=>'form-control']) !!}
        </div>
        <div class="form-group">
            {!! Form::label('email', 'Email') !!}
            {!! Form::email('email', null, ['class'=>'form-control']) !!}
        </div>
        <div class="form-group">
            {!! Form::label('role_id', 'Roles') !!}
            {!! Form::select('role_id',array(''=>'Choose Options') + $roles, null, ['class'=>'form-control']) !!}
        </div>
        <div class="form-group">
            {!! Form::label('status', 'Status') !!}
            {!! Form::select('status',array(1 => 'Active', 0 =>'Not Active'), null, ['class'=>'form-control']) !!}
        </div>
        <div class="form-group">
            {!! Form::label('password', 'Password') !!}
            {!! Form::password('password', null, ['class'=>'form-control']) !!}
        </div>
        
        <div class="form-group">
            {!! Form::submit('Create Post', ['class'=>'btn btn-primary']) !!}
        </div>
    {!! Form::close() !!}

$ php artisan make:request UsersRequest

Request/UsersRequest.php
※authorizeをfalseのままだとforbiddenに遷移します

public function authorize()
    {
        return true;
    }
public function rules()
    {
        return [
            
            'name' => 'required',
            'email' => 'required',
            'role_id' => 'required',
            'password' => 'required'
        ];
    }

Controller: AdminUsersRequest.php

use App\Http\Requests\UsersRequest;
public function store(UsersRequest $request)
    {
        return $request->all();
    }

create.blade.php

@if(count($errors) > 0)
		
		<div class="alert alert-danger">
			<ul>
				@foreach($errors->all() as $error)
					<li>{{$error}}</li>
				@endforeach
			</ul>

		</div>

    @endif

### エラーはテンプレート化する

@include('includes.form_error')

LaravelCollectiveも、初めて使ったときはメリットが分かりませんでしたが、少しずつ実用性を体感していきます。

Laravel id 1 = aaa, 2 = bbb, 3 = cccのviewの書き方

ユーザがradioボタンで選択した値をDBから呼び込んでViewで表示させたい時
DB側には id 1, 2, 3というように、値にidを入れる

View側ではif statementで値を書くのではなく、値のtableを作って、modelでbelongsToで呼び込めば、{{$user->role->name}}というようにシンプルに書ける

<tr>
			  <td>{{$user->id}}</td>
			  <td>{{$user->name}}</td>
			  <td>{{$user->email}}</td>
			  <td>{{$user->role->name}}</td>
			  <td>{{$user->is_active == 1 ? 'Active' : 'No Active'}}</td>
			  <td>{{$user->created_at->diffForHumans()}}</td>
			  <td>{{$user->updated_at->diffForHumans()}}</td>
			</tr>

青天の霹靂🤮🤮🤮
ということは、table設計・ER図が大分変ってくる

作りながら学ぶ方が一見早道に見えたが、基礎を一通り学んでから作り始めた方が出戻りが少なく、結果的に効率的になりそう
危ないところだった。。

Laravel 日付の表示変換の書き方

日付の表示変換は、controllerではなく、viewに変数を渡して、view側で表示を変える。

##　前準備
admin用のテンプレートをlayoutsフォルダ配下に格納する
./resources/view/layouts/admin.blade.php

{{asset()}}はpublicディレクトリにリンクする

<link href="{{asset('css/app.css')}}" rel="stylesheet">
<link href="{{asset('css/libs.css')}}" rel="stylesheet">

./resources/view/admin/index.blade.php

@extends('layouts.admin')

route

Route::get('/admin', function(){
	return view('admin.index');
});

./resources/view/asset/sass/app.scss

#admin-page {
	padding-top: 0px;
}

$ gulp

## データ取り込み
Controller: AdminUserController.php

public function index()
    {
        //
        $users = User::all();

        return view('admin.users.index', compact('users'));
    }

## View
view: index.blade.php

<table class="table table-striped">
		<thead>
		<tr>
		  <th>Id</th>
		  <th>Name</th>
		  <th>Email</th>
		  <th>Created</th>
		  <th>Updated</th>
		</tr>
		</thead>
		<tbody>
		@if($users)
			@foreach($users as $user)
			<tr>
			  <td>{{$user->id}}</td>
			  <td>{{$user->name}}</td>
			  <td>{{$user->email}}</td>
			  <td>{{$user->created_at->diffForHumans()}}</td>
			  <td>{{$user->updated_at->diffForHumans()}}</td>
			</tr>
			@endforeach
		@endif
		</tbody>
	</table>

日付で表示を変えるのはわかったが、カラム同士の値の引き算で時間を計算する際も、view側で書くのだろか？要検討。

フロントエンドとサーバーサイドを分けて開発するのであれば、sassへのコンパイルはフロント側でやればいいのかもしれないが、フルスタックエンジニアで開発する場合や、保守開発でのフロント編集の場合は、そのまま/resources/assetsで編集して、./publicにコンパイルすれば良いという事です。
こう考えると、フロントエンジニアでもLaravelの仕組みが分かっているとかなりコミュニケーションが楽になりそうですし、フロントエンド・サーバーサイドのスキル・興味関心に応じてどういう体制にするか考えるポイントになりそうです。

プロジェクト作成からmake:controller –resourceまでの一連の流れ

make:authとした後、先にViewファイル, migration, modelを作ってから、Controllerを作成して挙動を確認する

$ php artisan migrate
$ php artisan make:auth

resourcesにファイルを作成
./resources/views/admin/index.blade.php
./resources/views/admin/users/index.blade.php
./resources/views/admin/users/create.blade.php
./resources/views/admin/users/edit.blade.php
./resources/views/admin/posts/index.blade.php
./resources/views/admin/posts/create.blade.php
./resources/views/admin/posts/edit.blade.php
./resources/views/admin/categories/index.blade.php
./resources/views/admin/categories/edit.blade.php

migration file:user

Schema::create('users', function (Blueprint $table) {
            $table->increments('id');
            $table->integer('role_id')->index()->unsigned()->nullable();
            $table->integer('is_active')->default(0);
            $table->string('name');
            $table->string('email')->unique();
            $table->string('password');
            $table->rememberToken();
            $table->timestamps();
        });

$ php artisan make:model Role -m

migration file: role

Schema::create('roles', function (Blueprint $table) {
            $table->increments('id');
            $table->string('name');
            $table->timestamps();
        });

Model: Role.php

public function role(){
        return $this->belongsTo('App\Role');
    }

$ php artisan migrate:refresh

insert into roles (name) values (‘administrator’);
insert into roles (name) values (‘author’);
insert into roles (name) values (‘subscriber’);

update users set role_id=1 where id=1;

$ php artisan tinker
Psy Shell v0.7.2 (PHP 7.1.7 — cli) by Justin Hileman
>>> $user = App\User::find(1);
=> App\User {#647
id: 1,
role_id: 1,
is_active: 0,
name: “peter”,
email: “peter@gmail.com”,
created_at: “2019-12-13 13:52:49”,
updated_at: “2019-12-13 13:52:49”,
}
>>> $user->role
=> App\Role {#637
id: 1,
name: “administrator”,
created_at: null,
updated_at: null,
}

Route

Route::resource('admin/users', 'AdminUsersController');

$ php artisan make:controller –resource Adm inUsersController

Controller: AdminUsersController.php

public function index()
    {
        //
        return view('admin.users.index');
    }

フロントのテンプレートファイルを流し込んで、controllerを作り、ログイン機能は後から実装するのかと思っていましたが、そうではなくmake:authは一番最初に実行し、ユーザモデルを先に作ってしまうんですね👻

Laravelからのメール送信

実際のアプリケーションではSMTPにAWS SESを使いますが、ここでは便宜上、mailgunを使って、仕組みを理解します。

### mailgun
https://www.mailgun.com/
sign inして、認証します。

Laravelからメールを送信する際には、.envファイルから設定します。

デフォルト

MAIL_DRIVER=mailgun
MAILGUN_DOMAIN=sandboxf*********************.org
MAILGUN_SECRET=*******************-********-********

設定ファイル
./config/mail.php
　送信元のメールアドレス、名前を設定する

'from' => ['address' => 'name@hpscript.com', 'name' => 'hpscript'],

./config/services.php

./resources/view/emails/test.blade.php

<!DOCTYPE html>
<html lang="en">
<head>
	<meta charset="UTF-8">
	<title><Document></Document></title>
</head>
<body>
	
</body>
</html>

Routeuse Illuminate\Support\Facades\Mail;

Route::get('/', function () {
    // return view('welcome');
    $data = [
    	'title'=>"hi Hpscript",
    	"content"=>"This is Laravel first mailgun mail"
    ];

    Mail::send('emails.test', $data, function($message){
    		$message->to('*****@gmail.com', '${name}')->subject('Hello, good day!');
    });

});

mailgunを使用するにはドライバを入れる
公式ドキュメント参照：https://readouble.com/laravel/*/ja/mail.html
$ php composer.phar require guzzlehttp/guzzle

./vendor/guzzle/src/Client.php

private function configureDefaults(array $config)
    {
        $defaults = [
            'allow_redirects' => RedirectMiddleware::$defaultSettings,
            'http_errors'     => true,
            'decode_content'  => true,
            'verify'          => false,
            'cookies'         => false
        ];
        // ...
      }

LaravelでのSessionの使い方

## sessionの表示
Requestメソッドを使う

public function index(Request $request)
    {
        return $request->session()->all();
    }

## Set session
$request->session()->put([‘$key’=>’$value’]);とします

public function index(Request $request)
    {
        $request->session()->put(['peter'=>'artist']);
        return view('home');
    }

## Global function of session
globaの場合は、putを書く必要がない

public function index(Request $request)
    {
        session(['peter'=>'hoge']);
        
        return $request->session()->all();
        // return view('home');
    }

## sessionの読み込み

public function index(Request $request)
    {
        return $request->session()->get('peter');
        // return view('home');
    }

globalの場合

return session('peter');

## session削除

public function index(Request $request)
    {
        $request->session()->forget('peter');
        return $request->session()->all();
    }

## sessionデータを全て削除

$request->session()->flush();

## flush

$request->session()->flush('message', 'Post has been created');
return $request->session()->get('message');

sessionが使えるということは、cookieも使えるのでしょうか？
sessionやcookieを扱えると、アプリケーションの幅が広がりますね。

Laravel Middlewareでユーザーロール(権限)によってページを出し分ける方法

$ php artisan make:model Role -m

migration file: user

Schema::create('users', function (Blueprint $table) {
            $table->increments('id');
            $table->integer('role_id');
            $table->string('name');
            $table->string('email')->unique();
            $table->string('password');
            $table->rememberToken();
            $table->timestamps();
        });

migration file: role

Schema::create('roles', function (Blueprint $table) {
            $table->increments('id');
            $table->string('name');
            $table->timestamps();
        });

$ php artisan migrate:refresh

Model: Role.php

protected $fillable = [
    	'name'
    ];

Model: User.php

public function role(){
        return $this->belongsTo('App\Role');
    }

$ php artisan make:middleware IsAdmin

Kernel.php

protected $routeMiddleware = [
        'auth' => \App\Http\Middleware\Authenticate::class,
        'auth.basic' => \Illuminate\Auth\Middleware\AuthenticateWithBasicAuth::class,
        'can' => \Illuminate\Foundation\Http\Middleware\Authorize::class,
        'guest' => \App\Http\Middleware\RedirectIfAuthenticated::class,
        'throttle' => \Illuminate\Routing\Middleware\ThrottleRequests::class,
        'role'=>\App\Http\Middleware\RoleMiddleware::class,
        'IsAdmin'=>\App\Http\Middleware\IsAdmin::class,
    ];

insert into roles (name) values (‘administrator’);
insert into roles (name) values (‘subscriber’);
update users set role_id=1 where id=1;

User.php

public function isAdmin(){
        if($this->role->name == 'administrator'){
            return true;
        }

        return false;
    }

Route

Route::get('/', function () {

	$user = Auth::user();

	if($user->isAdmin()){
		echo "this user is adminstrator";
	}
    // return view('welcome');
});

うまく権限の判定が上手く動いていたのを確認します

Middleware:IsAdmin.php

use Illuminate\Support\Facades\Auth;
public function handle($request, Closure $next)
    {

        $user = Auth::user();

        if($user->isAdmin()){
            return redirect()->intended('/admin');
        }

        return $next($request);
    }

Route

Route::get('/admin', 'AdminController@index');

$ php artisan make:controller AdminController

Controller:AdminController.php

class AdminController extends Controller
{
    public function __construct(){
    	$this->middleware('IsAdmin');
    }

    public function index(){
    	return "you are an administrator because you are seeing this page";
    }
}

Middleware:IsAdmin.php

use Illuminate\Support\Facades\Auth;
public function handle($request, Closure $next)
    {

        $user = Auth::user();

        if(!$user->isAdmin()){
            return redirect()->intended('/');
        }

        return $next($request);
    }

ロールを変更して、リダイレクトされるか確認します。
update users set role_id=2 where id=1;

ロールによって、表示を切り分けたいページのControllerでは、上記のように、AdminControllerで$this->middleware(‘IsAdmin’);の判定を行うか、もしくは、以下のようにルーティングでミドルウェアの判定を行います。

Route::get('/admin/user/roles', ['middleware'=>['IsAdmin',], function(){

	return "Middleware role";
}]);

出し分ける場合、Controllerで毎回if文を書くのではなく、middlewareに関数を書いて、それを読み込むのですね。
ロールを別テーブルでbelongsToとしていますが、ロールがUserテーブルの場合でも、ロジックは同じだと思います。

LaravelのMiddleware Security/Protection

Middlewareを学びます。Middlewareというと何を思い浮かべるでしょうか？
ミドルウェアはその名の通り、OSとアプリケーションの中間にあるソフトウェアという意味です。
フレームワークLaravelでのMiddlewareとはどういう意味でしょうか？そもそもLaravel自体はOSではなく、アプリケーションのソフトウェアです。そのフレームワークにミドルウェアという機能があるのは何か虎に睨まれたようです。では具体的に見ていきましょう。

まず、新規にプロジェクトを立ち上げます
$ php artisan make:auth
$ php artisan migrate

./app/Http/kernel.php

protected $routeMiddleware = [
        'auth' => \App\Http\Middleware\Authenticate::class,
        'auth.basic' => \Illuminate\Auth\Middleware\AuthenticateWithBasicAuth::class,
        'can' => \Illuminate\Foundation\Http\Middleware\Authorize::class,
        'guest' => \App\Http\Middleware\RedirectIfAuthenticated::class,
        'throttle' => \Illuminate\Routing\Middleware\ThrottleRequests::class,
    ];

./app/Http/Middleware
Authenticate.php
EncryptCookies.php
RedirectIfAutenticated.php
VerifyCsrfToken.php

Authenticate.php

public function handle($request, Closure $next, $guard = null)
    {
        if (Auth::guard($guard)->guest()) {
            if ($request->ajax() || $request->wantsJson()) {
                return response('Unauthorized.', 401);
            } else {
                return redirect()->guest('login');
            }
        }

        return $next($request);
    }

$ php artisan make:middleware RoleMiddleware
Middleware created successfully.

$ php artisan down

Kernel.php

protected $routeMiddleware = [
        'auth' => \App\Http\Middleware\Authenticate::class,
        'auth.basic' => \Illuminate\Auth\Middleware\AuthenticateWithBasicAuth::class,
        'can' => \Illuminate\Foundation\Http\Middleware\Authorize::class,
        'guest' => \App\Http\Middleware\RedirectIfAuthenticated::class,
        'throttle' => \Illuminate\Routing\Middleware\ThrottleRequests::class,
        'role'=>\App\Http\Middleware\RoleMiddleware::class,
    ];

Route

Route::get('/admin/user/roles', ['middleware'=>'role', function(){

	return "Middleware role";
}]);

app/Http/Middleware/RoleMiddleware.php

public function handle($request, Closure $next)
    {
        return redirect('/');

        return $next($request);
    }

/admin/user/roles にアクセスするとリダイレクトされます。

Laravel Login機能の基礎

$ php artisan make:auth
$ php artisan migrate

route

Route::get('/', function () {
    return view('welcome');
});
Route::auth();
Route::get('/home', 'HomeController@index');

Route::auth();で、login, logout, pasword/*, registerなどのURIをルーティングしている

$ php artisan route:list
+——–+———-+————————-+——+—————————————————————–+————+
| Domain | Method | URI | Name | Action | Middleware |
+——–+———-+————————-+——+—————————————————————–+————+
| | GET|HEAD | / | | Closure | web |
| | GET|HEAD | home | | App\Http\Controllers\HomeController@index | web,auth |
| | GET|HEAD | login | | App\Http\Controllers\Auth\AuthController@showLoginForm | web,guest |
| | POST | login | | App\Http\Controllers\Auth\AuthController@login | web,guest |
| | GET|HEAD | logout | | App\Http\Controllers\Auth\AuthController@logout | web |
| | POST | password/email | | App\Http\Controllers\Auth\PasswordController@sendResetLinkEmail | web,guest |
| | POST | password/reset | | App\Http\Controllers\Auth\PasswordController@reset | web,guest |
| | GET|HEAD | password/reset/{token?} | | App\Http\Controllers\Auth\PasswordController@showResetForm | web,guest |
| | GET|HEAD | register | | App\Http\Controllers\Auth\AuthController@showRegistrationForm | web,guest |
| | POST | register | | App\Http\Controllers\Auth\AuthController@register | web,guest |
+——–+———-+————————-+——+—————————————————————–+————+

デフォルトのビューは、resources/viewの以下のファイルになります。
bootstrapで書かれていますが、シンプルなので、確認しておきます
auth/emails/password.blade.php
auth/login.blade.php
auth/passwords/email.blade.php
auth/passwords/reset.blade.php
auth/register.blade.php
home.blade.php
welcome.blade.php

ログインの処理はAuthController.phpでしている
同様にPasswordController.phpも使用
両方とも、処理内容を確認しておきます

remember_tokenのカラムは、remember meにチェックを入れると、保存される。
キャッシュの$valueでしょうか？

homeController.php
$this->middleware(‘auth’);で認証処理を実装しています
ログインしていないと、login.blade.phpにリダイレクトされる

public function __construct()
    {
        $this->middleware('auth');
    }

Controller: HomeController.php

use Illuminate\Support\Facades\Auth;
public function index()
    {
        $user = Auth::user();
        return view('home', compact('user'));
    }

View: home.blade.php

<div class="panel-body">
                    You are logged in {{$user->name}}!
                </div>

Route

Route::get('/', function () {
    // return view('welcome');
    if(Auth::check()){
    	return "the user is logged in";
    }
});

Route::get('/', function () {
    // return view('welcome');
    // if(Auth::check()){
    // 	return "the user is logged in";
    // }
    $user = "";
    $password = ""; 
    if(Auth::attempt(['username'=>$username, 'password'=>$password])){
    	return 	redirect()->intended('/admin');
    }

});

Laravelのデフォルト機能に合わせて設計を修正するのはナンセンスのように思うので、
ログインも実装パターンを研究する必要がある。