Laravel – クエリーパラメーター

2021-07-05 / tau / コメントする

概要

クエリーパラメーターは、フォームの送信時にGETメソッドを指定した時に送信されるパラメーター形式。

ルートパラメーターが直接URIの一部としてパラメーターの値を送るのに対して、クエリーパラメーターはパラメーターの名前と値をセットで送る。たとえば以下の様に。

http://www.my_bbs.com/search_post?user_id=10

このパラメーターをコントローラーで取得するには、以下の2通りの方法がある。

アクションの引数でRequestオブジェクトを指定し、その属性でパラメーター名を指定する。
アクション内でrequest()関数の引数にパラメーター名を指定する

いずれの場合も、コントローラーで以下の指定が必要。

use Illuminate\Http\Request;

ルーティング

ルーティング設定では、パラメーターを送信するパスとそれを受け取るコントローラー・アクションを指定するだけで、特別の記述はない。

Route::get('パス', 'ルーティング先');

たとえばmy_bbsというアプリケーションで以下のようにルーティングを設定した場合、

Requeset::get('/search_post/', 'PostController@searchPost');

1	Requeset::get('/search_post/', 'PostController@searchPost');

リクエスト側のURLは以下のようになる。

http://www.my_bbs.com/search_post?user_id=5

複数のパラメーターを送る場合は以下の様に'&'で区切る。

http://www.my_bbs.com/search_post?user_id=5&keyword=hello

ルーティングではパラメーターの数や名前には関与せず、コントローラー・アクションにおいてこれらを扱う。

コントローラー

必須事項

Request使用の宣言

コントローラー定義前に以下の定義が必要。artisanでコントローラーを生成すると、この定義は自動的に含まれる。

use Illuminate\Http\Request;

アクションの引数での`Request`オブジェクト指定

コントローラーでクエリーパラメーターを扱うのに、Requestパラメーターをアクションの引数に指定する方法と、request()関数を使う方法があるが、いずれの場合でも、アクションの引数にRequestクラスのオブジェクトを引数として指定する。

public function アクション名(Request $request) { ... }

引数の変数名は、必ずしも$requestでなくてもよい。

共通のコントローラー・アクションの形式

上記2つをまとめたコントローラー・アクションの一般形は以下のとおり。

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;

class コントローラー名 extends Controller
{
  public function アクション名(Request $request) {
    .....
  }
}

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;

class コントローラー名 extends Controller

{

public function アクション名(Request $request) {

.....

}

アクションにおけるパラメーターの取得

Requestオブジェクトの属性からパラメーターを受け取る方法

アクションの引数に指定したオブジェクトの属性値に、パラメーター名を指定して値を取り出す。引数の変数名は$requestである必要はなく任意。

$request->パラメーター名

たとえば先のリクエストの項で挙げた例の場合、以下のような処理例となる。ビューではコントローラーで設定された変数を使う。

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;

class PostController extends Controller
{
  public function searchPost(Request $request) {
    $user_id = $request->user_id;

    return view(
      'samples.posts',
      [
        'title' => 'クエリーパラメーターのサンプル',
        'user_id' => $user_id,
      ]
    );
  }
}

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;

class PostController extends Controller

{

public function searchPost(Request $request) {

$user_id = $request->user_id;

return view(

'samples.posts',

[

'title' => 'クエリーパラメーターのサンプル',

'user_id' => $user_id,

]

);

}

複数パラメーターが送られる場合は、Request引数の属性で順次パラメーター名を指定して取り出す。

  public function searchPost(Request $request) {
    $user_id = $request->user_id;
    $post_id = $request->post_id;

    return view(
      'samples.route_parameter',
      [
        'title' => 'ルートパラメーターのサンプル',
        'user_id' => $user_id,
        'post_id' => $post_id,
      ]
    );
  }

public function searchPost(Request $request) {

$user_id = $request->user_id;

$post_id = $request->post_id;

return view(

'samples.route_parameter',

[

'title' => 'ルートパラメーターのサンプル',

'user_id' => $user_id,

'post_id' => $post_id,

]

);

}

request()関数にパラメーター名を指定して受け取る方法

request()関数の引数に、クエリーのパラメーター名を指定して値を取り出す。

request('パラメーター名');

上記の複数パラメーターの例をこの方法で書き換えると以下のとおり。

  public function searchPost(Request $request) {
    $user_id = request(user_id);
    $post_id = request(post_id);

    return view(
      'samples.route_parameter',
      [
        'title' => 'ルートパラメーターのサンプル',
        'user_id' => $user_id,
        'post_id' => $post_id,
      ]
    );
  }

public function searchPost(Request $request) {

$user_id = request(user_id);

$post_id = request(post_id);

return view(

'samples.route_parameter',

[

'title' => 'ルートパラメーターのサンプル',

'user_id' => $user_id,

'post_id' => $post_id,

]

);

}

パラメーター省略時

リクエスト送信時にパラメーターを送信した時など、コントローラーで想定したパラメーターが存在しないときはエラーにならず、値が空文字列となる。

Laravel – ルートパラメーター

2021-07-05 / tau / コメントする

概要

ブラウザーなどからのリクエストの際、URLにパラメーターを指定して、それをLaravelで利用することができる。

クエリーパラメーター(URIパラメーター)と異なり、ルーティングのパスそのものにパラメーターを含める方法。

たとえば以下のようにリクエストでパラメーターとして'1'を送り、

http://.../myapp/1

1	http://.../myapp/1

ルーティングで以下のようにパラメーターを受け取り、

Route::get('/myapp/{param}', 'MyController@useParameter');

1	Route::get('/myapp/{param}', 'MyController@useParameter');

アクションで変数として受け取って利用する。

class MyController extends Controller
{
  public funtion($param) {
    // $param(内容は1)を利用する
  }
}る

class MyController extends Controller

{

public funtion($param) {

// $param(内容は1)を利用する

}

}る

ルーティングでの設定

パラメーターを受信する場合、ルーティングでパラメーターの部分を{}で囲む。

Route::get('パス/{パラメーター}', 'ルーティング先');

これ呼び出すリクエスト側のパラメーター指定は以下の通り。

http://ホスト名/パス/パラメーター

たとえばmy_bbsというアプリケーションで以下のようにルーティングを設定した場合、

Requeset::get('/user/{id}', 'UserController@getProfile');

1	Requeset::get('/user/{id}', 'UserController@getProfile');

リクエスト側でid=3を送る場合ののURLは以下のようになる。

http://www.my_bbs.com/user/3

コントローラーでの受け取り方

ルートパラメーター付きでルーティングされたコントローラーのアクションでは、その引数にパラメーターを指定する。

class コントローラー名 extends Controller
{
  public function アクション名(パラメーター変数) {
    // パラメーター変数の利用
  }
}

class コントローラー名 extends Controller

{

public function アクション名(パラメーター変数) {

// パラメーター変数の利用

}

先のルーティングのパラメーターを利用する場合、たとえば以下のようなコントローラー・アクションになる。

class UserController extends Controller
{
  public function getProfile($id) {
    return view('user.profile',['id' => $id]);
  }
}

class UserController extends Controller

{

public function getProfile($id) {

return view('user.profile',['id' => $id]);

}

なお、ルーティングで指定したパラメーターの名前とアクションの引数に使う変数名は、必ずしも一致させなくてもよい。

デフォルトパラメーター

ルーティングでパラメーター設定を{パラメーター?}のように書き、アクションで引数のデフォルト値を指定すると、パラメーターが省略されたときのデフォルト値を設定できる。

ルーティングの例

Route::get('/user/{id?}', 'UserController@getProfile');

1	Route::get('/user/{id?}', 'UserController@getProfile');

アクションの例

class UserController extends Controller
{
  public function getProfile($id=0) {
    return view(
      'samples.route_parameter',
      [
        'id' => $id,
      ]
    );
  }
}

class UserController extends Controller

{

public function getProfile($id=0) {

return view(

'samples.route_parameter',

[

'id' => $id,

]

);

}

この場合、http://www.my_bbs.com/userのようにパラメーターを指定しないと、id=0として処理される。

複数のパラメーター

ルートパラメーターは複数設定することもできる。

たとえば以下のように、ユーザーIDと投稿IDを想定してルーティングできる。

Route::get('/user/{user_id}/post/{post_id}', 'PostController@getPost');

1	Route::get('/user/{user_id}/post/{post_id}', 'PostController@getPost');

これを受け取るアクション側では、パラメーターの順番に合わせて引数を指定する。

class PostController extends Controller
{
  public function getPost($user_id, $post_id) {
    return view(
      'samples.route_parameter',
      [
        'user_id' => $user_id,
        'post_id' => $post_id,
      ]
    );
  }
}

class PostController extends Controller

{

public function getPost($user_id, $post_id) {

return view(

'samples.route_parameter',

[

'user_id' => $user_id,

'post_id' => $post_id,

]

);

}

この場合もパラメーターの名前と変数名は同じである必要はなく、その順番のみに従ってパラメーターの値が変数に割り当てられる。

なお複数パラメーターの場合のデフォルトパラメーターについては、最後のパラメーターには設定できるが、それより前のパラメーターには設定できない。

たとえばRequest::get(/user/{user_id?}/post/{post_id?}としてアクションの引数でそれぞれに対応する引数にデフォルト値を設定しても、

http:/www.my_bbs.com/usr/3/post

のように最後のパラメーターを省略するのは可能だが

http:/www.my_bbs.com/usr/post

のように全パラメーターを省略したり

http:/www.my_bbs.com/usr//post

途中のパラメーターを省略すると正しくリクエストできない。

Laravel – ルーティング

2021-07-04 / tau / コメントする

ルーティングの基本形

Route::メソッド('パス', ルーティング先);

たとえばGETメソッドで'ドメイン/bbs/show_posts'がリクエストされ、そのコントローラがBbsController、メソッドがshowPostsの場合は以下のように書く。

Route::get('/bbs/show_posts', 'BbsController@showPosts');

1	Route::get('/bbs/show_posts', 'BbsController@showPosts');

メソッド

HTTPメソッドに対応したRouteクラスのスタティックメソッドが準備されている。

get
post
put
patch
delete
options

URL

HTTPリクエストで指定されるURLを記述する。

ドメイン以下のパスを書く
頭の'/'はあってもなくてもよい

たとえばGETメソッドによるhttp://www.my_site/bbs/show_postsへのリクエストを扱う場合は以下のようになる。

Route::get('/bbs/show_posts', ...);

1	Route::get('/bbs/show_posts', ...);

または

Route::get('bbs/show_posts', ...);

1	Route::get('bbs/show_posts', ...);

ルーティング先

コントローラーとアクションを指定

'コントローラー名@アクション名'で指定する。

たとえば上記のURLへのリクエストをBbsControllerコントローラーのshowPostsアクションにルーティングしたい場合は以下のように指定する。

Route::get('/bbs/show_posts', 'BbsController@showPosts);

1	Route::get('/bbs/show_posts', 'BbsController@showPosts);

シングルアクションコントローラーを指定

'コントローラー名'で指定する。

たとえば上記のURLへのリクエストでシングルアクションコントローラー'ShowPosts'にルーティングしたい場合は以下のように指定する。

Route::get('/bbs/show_posts', 'ShowPosts);

1	Route::get('/bbs/show_posts', 'ShowPosts);

直接ビューを指定

コントローラーを介さずに直接ビューを指定する方法。無名関数を使い、戻り値にビューを指定したview()関数を渡す。

Route::get('パス', function () { return view('ビュー'); });

たとえば先のURLへのリクエストでビューファイルが以下のように配置されているとする。

resources/views/bbs/profile.blade.php

この場合のルーティングは以下のようになる。

Route::get('/bbs/show_posts', function() {
  return view('bbs.profile');
});

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

return view('bbs.profile');

});

ビューで参照する変数がある場合、以下のようにコントローラーと同じように無名関数の中で設定できる。

Route::get('/bbs/show_posts', function() {
  $title = 'プロフィール;

  return view('bbs.profile');
});

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

$title = 'プロフィール;

return view('bbs.profile');

});

直接出力

無名関数の戻り値に直接文字列を渡すと、それがそのまま送信される。

Route::get('パス', function () { return '文字列'; });

以下の例では、ブラウザーに単に「こんにちは」とだけ表示される。

Route::get('URL', function () { return 'こんにちは'; });

1	Route::get('URL', function () { return 'こんにちは'; });

直接HTMLを送ることも可能。

Route::get('URL', function () { return '
<!DOCTYPE html>
<html lang="ja">
  <head>
  .....
</html>
'; });

Route::get('URL', function () { return '

<!DOCTYPE html>

<head>

.....

</html>

'; });

ルートパラメーター

ルートパラメーターは、以下の様にリクエストURIの一部としてパラメーターの値が送信される。

http://ドメイン/.../パラメーター

パラメーターの値のみ送り、それを扱う変数の名前はLaravelで指定する。

Larave- コントローラーの基礎

2021-07-03 / tau / コメントする

コントローラーの生成

artisanで作成する

php artisan make:controller コントローラー名

$ php artisan make:controller SampleController
Controller created successfully.

1 2	$ php artisan make:controller SampleController Controller created successfully.

コントローラーが配置される場所。

app/Http/Controllers

$ ls -Al app/Http/Controllers/

drwxrwxrwx. 2 vagrant vagrant 205  7月  1 20:44 Auth
-rwxrwxrwx. 1 vagrant vagrant 361  7月  1 20:14 Controller.php
-rw-rw-r--. 1 vagrant vagrant 123  7月  3 11:18 SampleController.php

$ ls -Al app/Http/Controllers/

drwxrwxrwx. 2 vagrant vagrant 205 7月 1 20:44 Auth

-rwxrwxrwx. 1 vagrant vagrant 361 7月 1 20:14 Controller.php

-rw-rw-r--. 1 vagrant vagrant 123 7月 3 11:18 SampleController.php

初期状態のコントローラーの内容。

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;

class コントローラー名 extends Controller
{
    //
}

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;

class コントローラー名 extends Controller

{

}

$ cat app/Http/Controllers/SampleController.php
<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;

class SampleController extends Controller
{
    //
}

$ cat app/Http/Controllers/SampleController.php

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;

class SampleController extends Controller

{

}

一般的な構成

ビューの基礎で使ったblade_sampleはルーティングファイルに変数などを記述して呼び出していた。しかし一般的には、ビューに必要な処理はコントローラーのメソッド＝アクションを記述し、ルーティングではコントローラーのアクションを呼び出す、という方法が取られる。

そこで、このルーティングに書かれた処理をコントローラーに記述しなおし、ルーティングはコントローラーを呼び出すだけの構成に変更する。

コントローラーの記述

先に生成したSampleControllerクラスのメソッドとして、sampleAction()を定義し、その中に変数定義などの処理とビューの呼び出しを記述する。

?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;

class SampleController extends Controller
{
  public function sampleAction() {
    $assoc_array = [
        'head' => 'bladeテンプレートでの変数展開',
        'mechanism1' => '連想配列をview()の第2引数に渡す',
        'mechanism2' => 'それを受け取ったビューでは、キーが変数名、値が変数の内容となる',
        'escaped' => 'HTML特殊文字は<strike>自動的に</strike>エスケープされる',
        'unescaped' => '{{...}}}ではなく{!!...!!}で囲むとエスケープ<strike>される</strike>されない', 
    ];

    return view('samples.blade_sample', $assoc_array);
  }
}

?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;

class SampleController extends Controller

{

public function sampleAction() {

$assoc_array = [

'head' => 'bladeテンプレートでの変数展開',

'mechanism1' => '連想配列をview()の第2引数に渡す',

'mechanism2' => 'それを受け取ったビューでは、キーが変数名、値が変数の内容となる',

'escaped' => 'HTML特殊文字は<strike>自動的に</strike>エスケープされる',

'unescaped' => '{{...}}}ではなく{!!...!!}で囲むとエスケープ<strike>される</strike>されない',

];

return view('samples.blade_sample', $assoc_array);

}

ルーティングでのアクションの定義

ルーティングの無名関数で処理を記述していた部分を、アクション呼び出しの書き方に変更する。

Route::get('sample_action', 'SampleController@sampleAction');

1	Route::get('sample_action', 'SampleController@sampleAction');

このように変更することで、ルーティングはURLとメソッドをアクションに結びつけることに専念し、シンプルになる。

Laravel – レイアウト

2021-07-01 / tau / コメントする

概要

複数のビューで共通の部分がある場合、それらをまとめたビューを作って親とする(レイアウト)
共通レイアウトの中で、個々のビューごとに内容が異なる部分に@yieldディレクティブを書く
個々のビューの最初で、レイアウトとして使うビューを@extendsで指定する
レイアウトの中で@yieldを書いた部分の具体の内容を@sectionディレクティブで書く
異なるレイアウトでまとめられる部分がある場合は親のレイアウトにまとめて、異なる部分を親レイアウトの@yieldと子レイアウトの@sectionで書き、階層化する

レイアウトとビュー

レイアウトもビューファイルだが、複数のビューで共通化できる部分をまとめたのがレイアウト。

個別のページごとの内容に対応する部分を、レイアウト中で@yieldディレクティブで名前を付けて仮置きしておく。

たとえば以下は各ページ共通のヘッダーをレイアウトに持たせて、個別ページのタイトルと内容はtitle、contentという名前で仮置きしている。

{{-- views/layouts/common.blade.php --}}

<!DOCTYPE html>
<html lang="ja">
  <head>
    <meta charset="utf-8">
    <title>@yield('title')</title>
  </head>
  <body>
    <header style="background-color: #ccc">
      <p>共通レイアウトに各ページ共通のヘッダーなどを置けます</p>
    </header>
    @yield('content')
  </body>
</html>

<!DOCTYPE html>

<head>

<title>@yield('title')</title>

</head>

<body>

<p>共通レイアウトに各ページ共通のヘッダーなどを置けます</p>

</header>

@yield('content')

</body>

</html>

個別のページでは、

レイアウトとして使うビューを@extendsディレクティブで指定する
レイアウト中@yieldで仮置きした部分に対応する内容を@sectionディレクトリーで具体に書いていく

@extends('layouts.common')

@section('title', '個別ページ')

@section('content')
  <p>個々のページの内容</p>
@endsection

@extends('layouts.common')

@section('title', '個別ページ')

@section('content')

<p>個々のページの内容</p>

@endsection

この例では、全体のレイアウトとして上で準備したビューファイルを指定して、タイトルと内容を@sectionディレクティブで具体に書いている。

@sectionディレクティブには以下の書き方がある。

2つ目の引数で内容を渡す方法
@section～@endsectionの間に具体の内容を書く方法

レイアウトの階層化と継承

レイアウトが一部共通部分を持ちながら、いくつかの種類に分けられるような場合、レイアウトを階層化する。

例えばログイン前のページ、ログイン後のページが複数あり、ログイン前後でヘッダーメニューの構成が変わる場合。

ログイン前後でヘッダーメニューの内容は異なるが、ヘッダーメニューがあるという点は共通。

共通レイアウト

まず、大元のlayouts/common.blade.phpを以下のように準備する。

{{-- views/layouts/common.blade.php --}}

<!DOCTYPE html>
<html lang="ja">
  <head>
    <meta charset="utf-8">
    <title>@yield('title')</title>
  </head>
  <body>
    @yield('header')
    @yield('content')
  </body>
</html>

<!DOCTYPE html>

<head>

<title>@yield('title')</title>

</head>

<body>

@yield('header')

@yield('content')

</body>

</html>

このレイアウトでは、タイトル、ヘッダー、内容の3つを@yieldでプレースホルダーとしている。

個別レイアウト

次に、ログイン前とログイン後それぞれのレイアウトを準備する。

全体構造は共通のcommonから@extendsで継承し、それぞれで異なる内容となる@yield('header')に対応する部分だけを具体に書いていく。

個々のページによって異なる@yield('title')と@yield('content')についてはここでは対応せず、具体のビューで内容を埋める。

以下はログイン前のレイアウト。

{{-- views/layouts/logged_out.blade.php --}}

@extends('layouts.common')

@section('header')
  <header>
    {{-- ここにログイン前のメニューを書く --}}
  </header>
@endsection

@extends('layouts.common')

@section('header')

</header>

@endsection

また、以下はログイン後のレイアウト。

{{-- views/layouts/logged_in.blade.php --}}

@extends('layouts.common')

@section('header')
  <header>
    {{-- ここにログイン後のメニューを書く --}}
  </header>
@endsection

@extends('layouts.common')

@section('header')

</header>

@endsection

個別ビュー

個別のビューでは、大元の共通レイアウトを継承したログイン前／後いずれかのレイアウトを指定する。そして未対応@yield('title')と@yield('content')に対応する内容を@sectionで埋めていく。

たとえばログイン前のログインページの例。

@extends('layouts.logged_out')

@section('title', 'ログインページ')

@section('content')
  <h1>{{ 'ログインページ' }}</h1>
  {{-- ここにログインページの内容を書く --}}
@endsection

@extends('layouts.logged_out')

@section('title', 'ログインページ')

@section('content')

<h1>{{ 'ログインページ' }}</h1>

@endsection

またログイン後のトップページの例は以下の通り。

@extends('layouts.logged_in')

@section('title', 'トップページ')

@section('content')
  <h1>{{ 'トップページ' }}</h1>
  {{-- ここにトップページの内容を書く --}}
@endsection

@extends('layouts.logged_in')

@section('title', 'トップページ')

@section('content')

<h1>{{ 'トップページ' }}</h1>

@endsection

Laravel – ビューの基礎

2021-07-01 / tau / コメントする

基本的なビューの表示方法

概要

routes/viewsディレクトリー下かそのサブディレクトリー下にビューファイルを置き、ルーティングでそれを指定する。

ビューファイル名には.blade.phpが付加され、HTML以外にLaravelの機能を持たせるための記述を含む、Bladeテンプレートとして扱われる。

ビューファイルは
- resources/viewsディレクトリー下、あるいはそのサブディレクトリー下に置く
- ファイル名は[ビュー名].blade.phpにする
ルーティングでビューファイルを指定するときは
- 無名関数の処理内容をreturn view('ビュー名');とする
  - ビュー名はビューファイル名から.blade.phpを除いたもの
- ビューファイルをサブディレクトリー下に配置した場合、resources/viewより下のパスを、デリミターを'.'として記述する

例1

Laravelプロジェクト生成直後に表示される”Laravel”の初期ページ。ルーティングファイルに以下だけ記述されている。

Route::get('/', function () {
    return view('welcome');
});

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

return view('welcome');

});

また、resource/viewsディレクトリーにはwelcome.blade.phpファイルのみ準備されている。

[vagrant@localhost laravel_tutorial]$ ls resources/views
welcome.blade.php

1 2	[vagrant@localhost laravel_tutorial]$ ls resources/views welcome.blade.php

内容は以下のとおり。

<!DOCTYPE html>
<html lang="{{ str_replace('_', '-', app()->getLocale()) }}">
    <head>
        <meta charset="utf-8">
        <meta name="viewport" content="width=device-width, initial-scale=1">

        <title>Laravel</title>

        <!-- Fonts -->
        <link href="https://fonts.googleapis.com/css2?family=Nunito:wght@200;600&display=swap" rel="stylesheet">

        <!-- Styles -->
        <style>
            .....
        </style>
    </head>
    <body>
        <div class="flex-center position-ref full-height">
            .....

            <div class="content">
                <div class="title m-b-md">
                    Laravel
                </div>

                <div class="links">
                    <a href="https://laravel.com/docs">Docs</a>
                    <a href="https://laracasts.com">Laracasts</a>
                    <a href="https://laravel-news.com">News</a>
                    <a href="https://blog.laravel.com">Blog</a>
                    <a href="https://nova.laravel.com">Nova</a>
                    <a href="https://forge.laravel.com">Forge</a>
                    <a href="https://vapor.laravel.com">Vapor</a>
                    <a href="https://github.com/laravel/laravel">GitHub</a>
                </div>
            </div>
        </div>
    </body>
</html>

<!DOCTYPE html>

<html lang="{{ str_replace('_', '-', app()->getLocale()) }}">

<head>

<title>Laravel</title>

<style>

.....

</style>

</head>

<body>

.....

Laravel

</div>

<a href="https://laracasts.com">Laracasts</a>

<a href="https://forge.laravel.com">Forge</a>

<a href="https://vapor.laravel.com">Vapor</a>

<a href="https://github.com/laravel/laravel">GitHub</a>

</div>

</body>

</html>

例2

resourcesディレクトリーの下にsamplesディレクトリーをつくり、その中にview_sample.blade.phpというファイル名で以下の内容のファイルを作成する。

<!DOCTYPE html>
<html lang="ja">
  <head>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <meta http-equiv="X-UA-Compatible" content="ie=edge">
    <title>はじめてのView</title>
    <title>簡単なView</title>
  </head>
  <body>
    <h1>簡単なView</h1>
    <p>
      Viewファイルはルーティングファイル(web.php)から呼ばれて表示される。
    </p>
  </body>
</html>

<!DOCTYPE html>

<head>

<title>はじめてのView</title>

<title>簡単なView</title>

</head>

<body>

<h1>簡単なView</h1>

<p>

Viewファイルはルーティングファイル(web.php)から呼ばれて表示される。

</p>

</body>

</html>

routes/web.phpファイルに以下のルーティングを追加する。

Route::get('/view_sample', function() {
    return view('samples.view_sample');
});

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

return view('samples.view_sample');

});

サーバーが起動している状態でブラウザーからドメイン/view_sampleにアクセスすると、view_sample.blade.phpがパースされて表示される。

この場合のビューファイルとview()メソッドでの指定の仕方は以下のとおり。

ビューファイルをviewsディレクトリーのサブディレクトリーsamples下に作成
- views/samples/view_sample.blade.php
view()メソッドで呼び出すときは'.blade.php'を除き、パスのデリミターを'.'にした形で指定
- samples.view_sample

URIの/view_sampleとファイル名のview_sample.blade.phpは必ずしも同じである必要はない。

変数の展開

概要

ビューファイル内に、PHPの変数を埋め込んで内容を反映させることができる。

ビューに対して変数を渡すときは、[変数名]=>[内容]を要素とする連想配列で渡す
ビュー側では、連想配列のキーが変数名、値が内容として解釈される
ビュー内で{{ 変数 }}とすると変数の内容が展開され、HTMLに埋め込まれる

例

resources/samplesディレクトリー下に、ファイル名blade_sample.blade.phpで以下の内容のファイルを作成する。

<!DOCTYPE html>
<html lang="ja">
  <head>
    <meta charset="utf-8">
    <meta name="viewport" content="with=device-width, initial-scale=1.0">
    <meta http-equiv="X-UA-Compatible" content="ie=edge">
    <title>{{ $head }}</title>
  </head>
  <body>
    <h1>{{ $head }}</h1>
    <ul>
      <li>{{ $mechanism1 }}</li>
      <li>{{ $mechanism2 }}</li>
    </ul>
  </body>
</html>

<!DOCTYPE html>

<head>

</head>

<body>

<ul>

<li>{{ $mechanism1 }}</li>

<li>{{ $mechanism2 }}</li>

</ul>

</body>

</html>

このビューに対して、routes/web.php内で以下の様にルーティングを設定。

Route::get('blade_sample', function() {
    $assoc_array = [
      'head' => 'bladeテンプレートでの変数展開',
      'mechanism1' => '連想配列をview()の第2引数に渡す',
      'mechanism2' => 'それを受け取ったビューでは、キーが変数名、値が変数の内容となる',
    ];
    return view('samples.blade_sample', $assoc_array);
});

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

$assoc_array = [

'head' => 'bladeテンプレートでの変数展開',

'mechanism1' => '連想配列をview()の第2引数に渡す',

'mechanism2' => 'それを受け取ったビューでは、キーが変数名、値が変数の内容となる',

];

return view('samples.blade_sample', $assoc_array);

});

ビューファイルのパース時に変数が展開され、内容がHTMLに埋め込まれるため、ブラウザーでの表示結果は以下のようなイメージになる。

bladeテンプレートでの変数展開

連想配列をview()の第2引数に渡す
それを受け取ったビューでは、キーが変数名、値が変数の内容となる

出力エスケープ

変数埋め込みで内容を展開する際、HTML特殊文字はエンティティーに変換されるが、エスケープを抑制してHTML特殊文字をそのまま出力する方法もある。

概要

ビューで{{ ... }}とするとHTMLの特殊文字はLaravelによってエスケープされる
{!! ... !!}とするとHTMLの特殊文字はエスケープされず、HTMLとして機能する

例

ルーティングファイルweb.phpに以下の2行を追加する。

Route::get('blade_sample', function() {
    $assoc_value = '変数内容になる値は、リテラルでも任意の前の変数でもよい';
    $assoc_array = [
      'head' => 'bladeテンプレートでの変数展開',
      'mechanism1' => '連想配列をview()の第2引数に渡す',
      'mechanism2' => 'それを受け取ったビューでは、キーが変数名、値が変数の内容となる',
      'escaped' => 'HTML特殊文字は<strike>自動的に</strike>エスケープされる',
      'unescaped' => '{{...}}}ではなく{!!...!!}で囲むとエスケープ<strike>される</strike>されない',
    ];
    return view('samples.blade_sample', $assoc_array);
});

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

$assoc_value = '変数内容になる値は、リテラルでも任意の前の変数でもよい';

$assoc_array = [

'head' => 'bladeテンプレートでの変数展開',

'mechanism1' => '連想配列をview()の第2引数に渡す',

'mechanism2' => 'それを受け取ったビューでは、キーが変数名、値が変数の内容となる',

'escaped' => 'HTML特殊文字は<strike>自動的に</strike>エスケープされる',

'unescaped' => '{{...}}}ではなく{!!...!!}で囲むとエスケープ<strike>される</strike>されない',

];

return view('samples.blade_sample', $assoc_array);

});

また、先に作成したビューファイルblade_sample.blade.phpに以下の2行を追加する。

<!DOCTYPE html>
<html lang="ja">
  <head>
    <meta charset="utf-8">
    <meta name="viewport" content="with=device-width, initial-scale=1.0">
    <meta http-equiv="X-UA-Compatible" content="ie=edge">
    <title>{{ $head }}</title>
  </head>
  <body>
    <h1>{{ $head }}</h1>
    <ul>
      <li>{{ $mechanism1 }}</li>
      <li>{{ $mechanism2 }}</li>
    </ul>
    <p>{{ $escaped }}</p>
    <p>{!! $unescaped !!}</p>
  </body>
</html>

<!DOCTYPE html>

<head>

</head>

<body>

<ul>

<li>{{ $mechanism1 }}</li>

<li>{{ $mechanism2 }}</li>

</ul>

<p>{{ $escaped }}</p>

<p>{!! $unescaped !!}</p>

</body>

</html>

この場合のブラウザーの表示結果は以下のイメージ。

bladeテンプレートでの変数展開

連想配列をview()の第2引数に渡す
それを受け取ったビューでは、キーが変数名、値が変数の内容となる

HTML特殊文字は<strike>自動的に</strike>エスケープされる

{{…}}}ではなく{!!…!!}で囲むとエスケープされるされない

Bladeテンプレート内にコメントを書くことができ、HTMLへのパース時にはコメント行は無視される。

概要

Bladeテンプレートのコメントは{{-- ... --}}で記述する
Bladeのコメントはパース後のHTMLには現れない

例

最初に使ったview_sample.blade.phpファイルに以下の2行を追加する。

<!DOCTYPE html>
<html lang="ja">
  <head>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <meta http-equiv="X-UA-Compatible" content="ie=edge">
    <title>はじめてのView</title>
    <title>簡単なView</title>
  </head>
  <body>
    <h1>簡単なView</h1>
    {{-- Blade用のコメント文はパース時に無視される --}}
    <!-- HTML用のコメントはHTMLソースに残る -->
    <p>
      Viewファイルはルーティングファイル(web.php)から呼ばれて表示される。
    </p>
  </body>
</html>

<!DOCTYPE html>

<head>

<title>はじめてのView</title>

<title>簡単なView</title>

</head>

<body>

<h1>簡単なView</h1>

<p>

Viewファイルはルーティングファイル(web.php)から呼ばれて表示される。

</p>

</body>

</html>

これがパースされた後のHTMLソースは以下の様になり、Blade用のコメントはソースに反映されていない。

<!DOCTYPE html>
<html lang="ja">
  <head>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <meta http-equiv="X-UA-Compatible" content="ie=edge">
    <title>はじめてのView</title>
    <title>簡単なView</title>
  </head>
  <body>
    <h1>簡単なView</h1>
    
    <!-- HTML用のコメントはHTMLソースに残る -->
    <p>
      Viewファイルはルーティングファイル(web.php)から呼ばれて表示される。
    </p>
  </body>
</html>

<!DOCTYPE html>

<head>

<title>はじめてのView</title>

<title>簡単なView</title>

</head>

<body>

<h1>簡単なView</h1>

<p>

Viewファイルはルーティングファイル(web.php)から呼ばれて表示される。

</p>

</body>

</html>

ディレクティブ

概要

Bladeテンプレート内に条件分岐やループなどを行うディレクティブを書くことができる。

ディレクティブはBladeテンプレートに記述し、ロジック制御やレイアウト処理などPHPとしての処理を埋め込む
ディレクティブは@キーワード...のように記述する

例

まず、ルーティングでビューに配列を渡す。

Route::get('/directive_sample', function() {
  $dreams = ['一富士', '二鷹', '三茄子'];
  return view('samples.directive_sample', [
      'head' => '初夢',
      'dreams' => $dreams]);
});

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

$dreams = ['一富士', '二鷹', '三茄子'];

return view('samples.directive_sample', [

'head' => '初夢',

'dreams' => $dreams]);

});

ビューでは、配列の要素を一つずつ取り出して表示させている。

<!DOCTYPE html>
<html lang="ja">
  <head>
    <meta charset="utf-8">
    <meta name="viewport" content="with=device-width, initial-scale=1.0">
    <meta http-equiv="X-UA-Compatible" content="ie=edge">
    <title>{{ $head }}</title>
  </head>
  <body>
    <h1>{{ $head }}</h1>
    <ol>
      @foreach($dreams as $dream)
        <li>{{ $dream }}</li>
      @endforeach
    </ol>
  </body>
</html>

<!DOCTYPE html>

<head>

</head>

<body>

<ol>

@foreach($dreams as $dream)

<li>{{ $dream }}</li>

@endforeach

</ol>

</body>

</html>

ここで使われている@foreachや@endforeachがディレクティブで、ビューの中でPHPの処理・制御をしたり、レイアウトを扱ったりすることができる。

ディレクティブの詳細はこちら。

レイアウト

レイアウトに関するディレクティブを使って、ファイルの共通のレイアウトをまとめることができる。

概要

共通レイアウトのビューを親とする
- プレースホルダーとして@yieldディレクティブを書く
- @yieldごとにその場所に入るべきセクション名を指定
共通レイアウトを利用するビューを子とする
- 親とするレイアウトビューを@extendsディレクティブで指定する
- 親の各@yieldに対応するセクションを@sectionディレクティブで定義し、その内容を記述する

例

共通のレイアウトとして、views/layouts/common.blade.phpを以下の内容で準備する。

titlle要素に'title'セクションの内容を反映
main要素に'content'セクションの内容を反映
header要素の部分は、このページが変わっても同じ内容が表示される

<!DOCTYPE html>
<html lang="ja">
  <head>
    <meta charset="utf-8">
    <title>@yield('title')</title>
  </head>
  <body>
    <header style="background-color: #ccc">
      共通レイアウトに各ページ共通のヘッダーなどを置けます
    </header>
    <main>
      @yield('content')
    </main>
  </body>
</html>

<!DOCTYPE html>

<head>

<title>@yield('title')</title>

</head>

<body>

共通レイアウトに各ページ共通のヘッダーなどを置けます

</header>

<main>

@yield('content')

</main>

</body>

</html>

この共通レイアウトを使うページを、views/samples/layout_sample.blade.phpとして以下の内容で準備する。

@extendsディレクティブで、レイアウトとして使うビューを指定している
1つ目の@sectionディレクティブでtitleセクションに反映させる内容を$title変数で与えている
2つ目の@sectionディレクティブでcontentsセクションに反映させる内容を記述している

{{-- レイアウトファイルを指定 --}}
@extends('layouts.common')

{{-- @yield('title') の内容 --}}
@section('title', $title)

{{-- @yield('content') の内容--}}
@section('content')
  <h1>{{ $title }}</h1>
  @for ($i = 1; $i <= 10; $i++)
      @if ($i % 3 == 0)
        <p>{{ $i }}は3の倍数</p>
      @elseif ($i % 5 == 0)
        <p>{{ $i }}は5の倍数</p>
      @endif
  @endfor
@endsection

@extends('layouts.common')

@section('title', $title)

@section('content')

<h1>{{ $title }}</h1>

@for ($i = 1; $i <= 10; $i++)

@if ($i % 3 == 0)

@elseif ($i % 5 == 0)

@endif

@endfor

@endsection

これらについて以下のルーティングを設定し、ブラウザーからアクセスする。

Route::get('/layout_sample', function() {
    return view('samples.layout_sample', [
        'title' => 'レイアウトの例',
    ]);
});

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

return view('samples.layout_sample', [

'title' => 'レイアウトの例',

]);

});

出力イメージは以下の様になる。

共通レイアウトに各ページ共通のヘッダーなどを置けます

bladeテンプレートでの変数展開

3は3の倍数
5は5の倍数
6は3の倍数
9は3の倍数
10は5の倍数

スタイル

概要

publicディレクトリー下、あるいはそのサブディレクトリー下にCSSファイルを配置する
linkタグでCSSファイルを指定する

publicディレクトリー以下に配置されたファイルをlinkタグで指定するには、以下の様に記述する。

<link rel="stylesheet" href="{{ asset('publicより下のパス') }}">

1	<link rel="stylesheet" href="{{ asset('publicより下のパス') }}">

例

たとえばpublicディレクトリー下にcssディレクトリーを作成し、その下にstayles.cssを作成、CSSを記述したとする。

このファイルをビューから呼び出すには、以下の様に記述する。

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

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

Larave – ディレクティブ

2021-07-01 / tau / コメントする

概要

ディレクティブ(directive)はBladeテンプレート内に記述し、テンプレート内でPHPの処理・制御をおこなったり、共通のレイアウトを扱うといった処理を指示する。

ディレクティブは@キーワードのように書き、そのキーワードに応じて必要な表現が続く。

ロジック制御系ディレクティブ

分岐系ディレクティブ

@if

@if (条件)
  .....
@elseif (条件)
  .....
@else
  .....
@endif

@if (条件)

.....

@elseif (条件)

.....

@else

.....

@endif

@unless

@unless (条件)
  .....
@else
  .....
@endunless

@unless (条件)

.....

@else

.....

@endunless

@empty

@empty (変数)
  .....
@else
  .....
@endempty

@empty (変数)

.....

@else

.....

@endempty

@isset

@isset (変数)
  .....
@else
  .....
@endisset

@isset (変数)

.....

@else

.....

@endisset

ループ系ディレクティブ

@for

@for (初期条件; 終了条件; 変更)
  .....
@endfor

@for (初期条件; 終了条件; 変更)

.....

@endfor

@foreach

@foreach (コレクション as 変数)
  .....
@endforeach

@foreach (コレクション as 変数)

.....

@endforeach

@forelse…@empty

@forelse (コレクション as 変数)
  ....コレクションがemptyでない場合
@empty
  ....コレクションがemptyの場合
@endfor

@forelse (コレクション as 変数)

....コレクションがemptyでない場合

@empty

....コレクションがemptyの場合

@endfor

@while

@while (継続条件)
  .....
@endwhile

@while (継続条件)

.....

@endwhile

@break

PHPのbreakと同じ使い方。

@continue

PHPのcontinueと同じ使い方。

$loop変数

`$loop->index`	現在のインデックス(0, 1, 2, …)
`$loop->iteration`	現在の繰り返し数(1, 2, 3, …)
`$loop->remaining`	あと何回繰り返すか
`$loop->count`	配列の要素数
`$loop->first`	繰り返しの最初かどうか
`$loop->last`	繰り返しの最後かどうか
`$loop->depth`	繰り返しのネストの深さ
`$loop->parent`	ネストしている場合の親のループ変数

共通化・再利用関係ディレクティブ

レイアウト関係ディレクティブ

レイアウト関係はこちらにまとめている。

@extends/@yields/@section

@extendsでレイアウトとして使う親のビューを指定
@yieldで個別ビューで埋めるべきプレースホルダーを指定
個別ビューやサブレイアウトで@sectionを指定し、対応する@yieldを具体の内容で埋める

@show

@parent

部分HTML関係ディレクティブ

@include

@includeディレクティブは、別に準備された共通の部分ビューをその場所に読み込む。第2引数に連想配列を指定して、引数を渡すことができる。

@include('ビュー')

@include('ビュー', 連想配列)

@include('ビュー')

@include('ビュー', 連想配列)

例として、以下は共通して読み込まれる部分ビュー。

{{-- view/samples/include_sub.blade.php --}}

<ul>
  <li>inludeされた共通HTML</li>
  <li>{{ $item }}</li>
</ul>

<ul>

<li>inludeされた共通HTML</li>

</ul>

そして以下は、@includeで上のHTMLを読み込むビュー。

{{-- view/samples/include_sumple.blade.php --}}

<!DOCTYPE html>
<html lang="ja">
  <head>
    <meta charset="utf-8">
    <title>&#64;includeサンプル</title>
  </head>
  <body>
    <h1>&#64;includeサンプル</h1>
    <p>以下は1つ目の&#64;include。</p>
    @include('samples.include_sub', ['item' => '1つ目の@include'])
    <p>以下は2つ目の&#64;include。</p>
    @include('samples.include_sub', ['item' => '2つ目の@include'])
  </body>
</html>

<!DOCTYPE html>

<head>

<title>@includeサンプル</title>

</head>

<body>

<h1>@includeサンプル</h1>

<p>以下は1つ目の@include。</p>

@include('samples.include_sub', ['item' => '1つ目の@include'])

<p>以下は2つ目の@include。</p>

@include('samples.include_sub', ['item' => '2つ目の@include'])

</body>

</html>

@component/@slot

@includeと同じように共通の部分ビューを読み込むが、変数を指定するのに連想配列で渡す方法と@slotディレクティブで指定する方法がある。

@component('ビュー', 連想配列)

@component('ビュー')
  @slot('変数名')
    部分HTML
  @endslot
  .....
@endcomponent

@component('ビュー', 連想配列)

@component('ビュー')

@slot('変数名')

部分HTML

@endslot

.....

@endcomponent

以下は@componentで読み込まれる部品側のファイル。

{{-- views/samples/component_example.blade.php --}}

<h3>{{ $os_title }}</h3>
<p>{{ $os_list }}</p>

<h3>{{ $os_title }}</h3>

そして以下は、この部品を読み込んで使う親のファイル。

{{-- views/samples/component_sample.blade.php --}}

<!DOCTYPE html>
<html lang="ja">
  <head>
    <meta charset="utf-8">
    <title>&#64;componentサンプル</title>
  </head>
  <body>
    <h1>&#64;componentのサンプル</h1>
    @component('samples.component_example')
      @slot('os_title')
      　使用中のOS
      @endslot
      @slot('os_list')
        <li>Windows10</li>
        <li>CentOS7</li>
        <li>AmaxonLinux2</li>
        <li>DewwBSD</li>
      @endslot
    @endcomponent
  </body>
</html>

<!DOCTYPE html>

<head>

<title>@componentサンプル</title>

</head>

<body>

<h1>@componentのサンプル</h1>

@component('samples.component_example')

@slot('os_title')

　使用中のOS

@endslot

@slot('os_list')

<li>Windows10</li>

<li>CentOS7</li>

<li>AmaxonLinux2</li>

<li>DewwBSD</li>

@endslot

@endcomponent

</body>

</html>

@each

@eachディレクティブは、配列やコレクションの内容を取り出しながら、その内容を繰り返してビューに適用していく。

@each('ビュー', コレクション, '変数名')

@each('ビュー', コレクション, '変数名', 'ビュー2')

@each('ビュー', コレクション, '変数名')

@each('ビュー', コレクション, '変数名', 'ビュー2')

ビュー2はコレクションが空のときに使われるビュー。

たとえば以下のような部分ビューを準備しておいて、

{{-- views/samples/each_sub.blade.php --}}

<li>{{ $item }}</li>

以下のように@eachを使うことで、配列の要素1つずつに同じ部分ビューの内容を適用させることができる。

{{-- views/samples/each_sample.blade.php --}}

<!DOCTYPE html>
<html lang="ja">
  <head>
    <meta charset="utf-8">
    <title>&#64;eachサンプル</title>
  </head>
  <body>
    <h1>&#64;eachのサンプル</h1>
    <h1>使用しているOS</h1>
    @php
      $os_list = ['Windows10', 'CentOS7', 'AmazonLinux2', 'FreeBSD'];
    @endphp
    <ul>
      @each('samples.each_sub', $os_list, 'item')
    </ul>
  </body>
</html>

<!DOCTYPE html>

<head>

<title>@eachサンプル</title>

</head>

<body>

<h1>@eachのサンプル</h1>

<h1>使用しているOS</h1>

@php

$os_list = ['Windows10', 'CentOS7', 'AmazonLinux2', 'FreeBSD'];

@endphp

<ul>

@each('samples.each_sub', $os_list, 'item')

</ul>

</body>

</html>

この結果、@componentの時と同じようなリストが配列の要素に対応して作られる。

@import/@component/@eachの使い分け

これら3つを使い分けるシーンについて、以下のように考えてみた。

@import: ある程度の規模の定型部分ビューの一部を変数で与えながら再利用する場合。
@component: 個別ビューでHTMLの一部を設定しながら一定の構造を持たせる場合。
@each: コレクションの内容に応じたリスト項目の表示など、部分HTMLに対して定型で内容が変化する場合。

Laravel – ルーティングの基礎

2021-06-29 / tau / コメントする

ルーティングファイル

Laravelのルーティングはルーティングファイルに書く
ルーティングファイルの場所はapp/routes/web.php

ルーティングの書き方

ビューの雛形

生成直後のルーティングファイルでは下記のルーティングのみが書かれており、準備されたビューファイルが返されるようになっている。

Route::get('/', function () {
    return view('welcome');
});

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

return view('welcome');

});

無名関数の中でview()メソッドが呼ばれているが、このメソッドの引数文字列に.blade.phpを付けたファイル名のビューファイルが、resources/viewsディレクトリー下で検索されて表示される。

直接出力

ブラウザーに文字列だけを表示する簡単な例として、GETで/topにルーティングして’ようこそ’と表示するには以下の様に書く。

Route::get('top', function() { return 'ようこそ'; });

get()メソッドの第1引数にURI、第2引数にそのURLにGETしたときに返されるコンテンツを指定している。

第1引数のURIは、ドメイン以降のディレクトリー・ファイルで、冒頭の’/‘は付けても付けなくてもよい
第2引数の無名関数は、コントローラーに渡されるコールバック

無名関数の戻り値に直接HTMLを書けば、その内容がブラウザーでパースされて表示される。つまり以下のような書き方もできる(現実的ではないが)。

Route::get('/tutorial/raw-html', function() {
    return '
      <!DOCTYPE html>
      <html lang="ja">
        <head>
          <meta charset="utf-8">
          <title>ルーティングファイル内のHTML</title>
        </head>
        <body>
          <h1>HTMLの例</h1>
          <p>
          この内容は、ルーティングファイルの無名関数内に直接書いています。
          </p>
        </body>
      </html>
    ';
});

Route::get('/tutorial/raw-html', function() {

return '

<!DOCTYPE html>

<head>

<title>ルーティングファイル内のHTML</title>

</head>

<body>

<h1>HTMLの例</h1>

<p>

この内容は、ルーティングファイルの無名関数内に直接書いています。

</p>

</body>

</html>

});

リクエスト元の指定

第1引数はドメインより後のパスを指定する。たとえばリクエストが

http://www.myapp.com/user/profile

の場合は以下のようになる。

Request::get('/usr/profile', ...);

または

Request::get('usr/profile', ...);

コントローラー・アクション指定

コントローラーとアクションを指定する以下の書き方が一般的。

Route::get('パス', 'コントローラー名@アクション名');

Laravel – データベース – 準備

2021-06-28 / tau / コメントする

概要

Laravelのプロジェクト開始時の、データベースの準備・設定についてまとめる。

データベースの準備

CREATE DATABASEなどによってプロジェクトで使うデータベースを作成する。以下は新たなデータベースlaravel_test_developmentを作成した例。

mysql> CREATE DATABASE laravel_test;
Query OK, 1 row affected (0.01 sec)

1 2	mysql> CREATE DATABASE laravel_test; Query OK, 1 row affected (0.01 sec)

.envファイルの修正

DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=laravel_test←作成したデータベース名
DB_USERNAME=root
DB_PASSWORD=ログインパスワード

DB_CONNECTION=mysql

DB_HOST=127.0.0.1

DB_PORT=3306

DB_DATABASE=laravel_test←作成したデータベース名

DB_USERNAME=root

DB_PASSWORD=ログインパスワード

データベース接続確認

php artisan migrateでマイグレーションが実行されればデータベースは正常に接続されている。

[vagrant@localhost laravel_test]$ php artisan migrate
Migration table created successfully.
Migrating: 2014_10_12_000000_create_users_table
Migrated:  2014_10_12_000000_create_users_table (0.03 seconds)
Migrating: 2014_10_12_100000_create_password_resets_table
Migrated:  2014_10_12_100000_create_password_resets_table (0.03 seconds)
Migrating: 2019_08_19_000000_create_failed_jobs_table
Migrated:  2019_08_19_000000_create_failed_jobs_table (0.01 seconds)

[vagrant@localhost laravel_test]$ php artisan migrate

Migration table created successfully.

Migrating: 2014_10_12_000000_create_users_table

Migrated: 2014_10_12_000000_create_users_table (0.03 seconds)

Migrating: 2014_10_12_100000_create_password_resets_table

Migrated: 2014_10_12_100000_create_password_resets_table (0.03 seconds)

Migrating: 2019_08_19_000000_create_failed_jobs_table

Migrated: 2019_08_19_000000_create_failed_jobs_table (0.01 seconds)

マイグレーションの結果生成されたファイル。

[vagrant@localhost laravel_test]$ ls -al database/migrations
合計 12
drwxrwxr-x. 2 vagrant vagrant 166  5月 12 05:47 .
drwxrwxr-x. 5 vagrant vagrant  72  5月 12 05:47 ..
-rw-rw-r--. 1 vagrant vagrant 813  5月 12 05:47 2014_10_12_000000_create_users_table.php
-rw-rw-r--. 1 vagrant vagrant 683  5月 12 05:47 2014_10_12_100000_create_password_resets_table.php
-rw-rw-r--. 1 vagrant vagrant 789  5月 12 05:47 2019_08_19_000000_create_failed_jobs_table.php

[vagrant@localhost laravel_test]$ ls -al database/migrations

合計 12

drwxrwxr-x. 2 vagrant vagrant 166 5月 12 05:47 .

drwxrwxr-x. 5 vagrant vagrant 72 5月 12 05:47 ..

-rw-rw-r--. 1 vagrant vagrant 813 5月 12 05:47 2014_10_12_000000_create_users_table.php

-rw-rw-r--. 1 vagrant vagrant 683 5月 12 05:47 2014_10_12_100000_create_password_resets_table.php

-rw-rw-r--. 1 vagrant vagrant 789 5月 12 05:47 2019_08_19_000000_create_failed_jobs_table.php

MySQL側でもテーブルが生成されている。

mysql> use laravel_test
Reading table information for completion of table and column names
You can turn off this feature to get a quicker startup with -A

Database changed
mysql> show tables;
+------------------------+
| Tables_in_laravel_test |
+------------------------+
| failed_jobs            |
| migrations             |
| password_resets        |
| users                  |
+------------------------+
5 rows in set (0.00 sec)

mysql> use laravel_test

Reading table information for completion of table and column names

You can turn off this feature to get a quicker startup with -A

Database changed

mysql> show tables;

+------------------------+

| Tables_in_laravel_test |

+------------------------+

| failed_jobs |

| migrations |

| password_resets |

| users |

+------------------------+

5 rows in set (0.00 sec)

データベースに接続できないとき

MySQLとPHPのバージョンによっては、認証方法の違いで接続できない場合がある。その対応方法はこちら。

Laravel – データベースに接続できない

2021-06-28 / tau / コメントする

エラー発生

Laravel導入直後にデータベースを接続しようとしたところ、エラーが発生した。

[vagrant@localhost laravel_test]$ php artisan migrate

   Illuminate\Database\QueryException  : SQLSTATE[HY000] [2054] The server requested authentication method unknown to the client (SQL: select * from information_schema.tables where table_schema = laravel_test_development and table_name = migrations and table_type = 'BASE TABLE')

  at /home/vagrant/app/laravel/laravel_test/vendor/laravel/framework/src/Illuminate/Database/Connection.php:669
    665|         // If an exception occurs when attempting to run a query, we'll format the error
    666|         // message to include the bindings with SQL, which will make this exception a
    667|         // lot more helpful to the developer instead of just the database's errors.
    668|         catch (Exception $e) {
  > 669|             throw new QueryException(
    670|                 $query, $this->prepareBindings($bindings), $e
    671|             );
    672|         }
    673|

  Exception trace:

  1   PDOException::("PDO::__construct(): The server requested authentication method unknown to the client [caching_sha2_password]")
      /home/vagrant/app/laravel/laravel_test/vendor/laravel/framework/src/Illuminate/Database/Connectors/Connector.php:70

  2   PDO::__construct("mysql:host=127.0.0.1;port=3306;dbname=laravel_test_development", "root", "vagrant", [])
      /home/vagrant/app/laravel/laravel_test/vendor/laravel/framework/src/Illuminate/Database/Connectors/Connector.php:70

  Please use the argument -v to see more details.

[vagrant@localhost laravel_test]$ php artisan migrate

Illuminate\Database\QueryException : SQLSTATE[HY000] [2054] The server requested authentication method unknown to the client (SQL: select * from information_schema.tables where table_schema = laravel_test_development and table_name = migrations and table_type = 'BASE TABLE')

at /home/vagrant/app/laravel/laravel_test/vendor/laravel/framework/src/Illuminate/Database/Connection.php:669

665| // If an exception occurs when attempting to run a query, we'll format the error

666| // message to include the bindings with SQL, which will make this exception a

667| // lot more helpful to the developer instead of just the database's errors.

668| catch (Exception $e) {

> 669| throw new QueryException(

670| $query, $this->prepareBindings($bindings), $e

671| );

672| }

673|

Exception trace:

1 PDOException::("PDO::__construct(): The server requested authentication method unknown to the client [caching_sha2_password]")

/home/vagrant/app/laravel/laravel_test/vendor/laravel/framework/src/Illuminate/Database/Connectors/Connector.php:70

2 PDO::__construct("mysql:host=127.0.0.1;port=3306;dbname=laravel_test_development", "root", "vagrant", [])

/home/vagrant/app/laravel/laravel_test/vendor/laravel/framework/src/Illuminate/Database/Connectors/Connector.php:70

Please use the argument -v to see more details.

MySQLのバージョンは8.0.23、PHPのバージョンは7.3.28で、MySQLのデフォルトの認証はcacing_sha2_passwordだが、PHPは7.3でもこれに対応しておらずmysql_native_passwordらしい。

MySQLの認証方法変更

認証方法の確認。

mysql> SELECT user, host, plugin FROM mysql.user;
+------------------+-----------+-----------------------+
| user             | host      | plugin                |
+------------------+-----------+-----------------------+
| mysql.infoschema | localhost | caching_sha2_password |
| mysql.session    | localhost | caching_sha2_password |
| mysql.sys        | localhost | caching_sha2_password |
| root             | localhost | caching_sha2_password |
+------------------+-----------+-----------------------+
4 rows in set (0.00 sec)

mysql> SELECT user, host, plugin FROM mysql.user;

+------------------+-----------+-----------------------+

| user | host | plugin |

+------------------+-----------+-----------------------+

| mysql.infoschema | localhost | caching_sha2_password |

| mysql.session | localhost | caching_sha2_password |

| mysql.sys | localhost | caching_sha2_password |

| root | localhost | caching_sha2_password |

+------------------+-----------+-----------------------+

4 rows in set (0.00 sec)

rootの認証方法をmysql_native_passwordに変更しようとするが、エラー。

mysql> ALTER USER 'root'@'localhost' IDENTIFIED WITH mysql_native_password BY 'vagrant';
ERROR 1819 (HY000): Your password does not satisfy the current policy requirements

1 2	mysql> ALTER USER 'root'@'localhost' IDENTIFIED WITH mysql_native_password BY 'vagrant'; ERROR 1819 (HY000): Your password does not satisfy the current policy requirements

パスワードがポリシーに適合していない。これは新たにMySQLをインストールした時にある状況。パスワード検証内容を確認してみる。

mysql> SHOW VARIABLES LIKE 'validate_password%';
+--------------------------------------+--------+
| Variable_name                        | Value  |
+--------------------------------------+--------+
| validate_password.check_user_name    | ON     |
| validate_password.dictionary_file    |        |
| validate_password.length             | 8      |
| validate_password.mixed_case_count   | 1      |
| validate_password.number_count       | 1      |
| validate_password.policy             | MEDIUM |
| validate_password.special_char_count | 1      |
+--------------------------------------+--------+
7 rows in set (0.00 sec)

mysql> SHOW VARIABLES LIKE 'validate_password%';

+--------------------------------------+--------+

| Variable_name | Value |

+--------------------------------------+--------+

| validate_password.check_user_name | ON |

| validate_password.dictionary_file | |

| validate_password.length | 8 |

| validate_password.mixed_case_count | 1 |

| validate_password.number_count | 1 |

| validate_password.policy | MEDIUM |

| validate_password.special_char_count | 1 |

+--------------------------------------+--------+

7 rows in set (0.00 sec)

設定するパスワードに合わせてポリシーなどを変更。

mysql> SET GLOBAL validate_password.policy=LOW;
Query OK, 0 rows affected (0.00 sec)

mysql> SET GLOBAL validate_password.length=6;
Query OK, 0 rows affected (0.00 sec)

mysql> SHOW VARIABLES LIKE 'validate_password%';
+--------------------------------------+-------+
| Variable_name                        | Value |
+--------------------------------------+-------+
| validate_password.check_user_name    | ON    |
| validate_password.dictionary_file    |       |
| validate_password.length             | 6     |
| validate_password.mixed_case_count   | 1     |
| validate_password.number_count       | 1     |
| validate_password.policy             | LOW   |
| validate_password.special_char_count | 1     |
+--------------------------------------+-------+
7 rows in set (0.00 sec)

mysql> SET GLOBAL validate_password.policy=LOW;

Query OK, 0 rows affected (0.00 sec)

mysql> SET GLOBAL validate_password.length=6;

Query OK, 0 rows affected (0.00 sec)

mysql> SHOW VARIABLES LIKE 'validate_password%';

+--------------------------------------+-------+

| Variable_name | Value |

+--------------------------------------+-------+

| validate_password.check_user_name | ON |

| validate_password.dictionary_file | |

| validate_password.length | 6 |

| validate_password.mixed_case_count | 1 |

| validate_password.number_count | 1 |

| validate_password.policy | LOW |

| validate_password.special_char_count | 1 |

+--------------------------------------+-------+

7 rows in set (0.00 sec)

改めてrootユーザーの認証方法を変更・確認。

mysql> ALTER USER 'root'@'localhost' IDENTIFIED WITH mysql_native_password BY 'パスワード';
Query OK, 0 rows affected (0.00 sec)

mysql> SELECT USER, host, plugin FROM mysql.user;
+------------------+-----------+-----------------------+
| USER             | host      | plugin                |
+------------------+-----------+-----------------------+
| mysql.infoschema | localhost | caching_sha2_password |
| mysql.session    | localhost | caching_sha2_password |
| mysql.sys        | localhost | caching_sha2_password |
| root             | localhost | mysql_native_password |
+------------------+-----------+-----------------------+
4 rows in set (0.00 sec)

mysql> ALTER USER 'root'@'localhost' IDENTIFIED WITH mysql_native_password BY 'パスワード';

Query OK, 0 rows affected (0.00 sec)

mysql> SELECT USER, host, plugin FROM mysql.user;

+------------------+-----------+-----------------------+

| USER | host | plugin |

+------------------+-----------+-----------------------+

| mysql.infoschema | localhost | caching_sha2_password |

| mysql.session | localhost | caching_sha2_password |

| mysql.sys | localhost | caching_sha2_password |

| root | localhost | mysql_native_password |

+------------------+-----------+-----------------------+

4 rows in set (0.00 sec)

これでPHP7.3以下で接続可能になる。

概要

ルーティング

コントローラー

必須事項

Request使用の宣言

アクションの引数でのRequestオブジェクト指定

共通のコントローラー・アクションの形式

アクションにおけるパラメーターの取得

Requestオブジェクトの属性からパラメーターを受け取る方法

request()関数にパラメーター名を指定して受け取る方法

パラメーター省略時

概要

ルーティングでの設定

コントローラーでの受け取り方

デフォルトパラメーター

複数のパラメーター

ルーティングの基本形

メソッド

URL

ルーティング先

コントローラーとアクションを指定

シングルアクションコントローラーを指定

直接ビューを指定

直接出力

ルートパラメーター

コントローラーの生成

一般的な構成

コントローラーの記述

ルーティングでのアクションの定義

概要

レイアウトとビュー

レイアウトの階層化と継承

共通レイアウト

個別レイアウト

個別ビュー

基本的なビューの表示方法

概要

例1

例2

変数の展開

概要

例

出力エスケープ

概要

例

コメント

概要

例

ディレクティブ

概要

例

レイアウト

概要

例

スタイル

概要

例

概要

ロジック制御系ディレクティブ

分岐系ディレクティブ

@if

@unless

@empty

@isset

ループ系ディレクティブ

@for

@foreach

@forelse…@empty

@while

@break

@continue

$loop変数

共通化・再利用関係ディレクティブ

レイアウト関係ディレクティブ

@extends/@yields/@section

@show

@parent

部分HTML関係ディレクティブ

@include

@component/@slot

アクションの引数での`Request`オブジェクト指定