Tweet
Tweet

Slide 1

Slide 1 text

Laravel の paginate は 一体何をやっているのか 第127回 PHP勉強会＠東京

Slide 2

Slide 2 text

岡田 正平（おかだ しょうへい）@okashoi • 株式会社ウィルゲート 2015年新卒入社 • 開発室 ソリューションユニット 所属 • PHP, Laravel, Vue.js 2 自己紹介 Slides:

Slide 3

Slide 3 text

① Laravel の paginate は何をやっているのか • タイトル通り ② フレームワークのソースコードの追うときの思考プロセス 3 このスライドでつたえたい

Slide 4

Slide 4 text

https://laravel.com/docs/5.6/pagination

Slide 5

Slide 5 text

// Controller にて $users = App¥User::paginate(15); {{-- blade template にて --}}
@foreach ($users as $user) {{ $user->name }} @endforeach
{{ $users->links() }}

Slide 6

Slide 6 text

// Controller にて $users = App¥User::paginate(15); {{-- blade template にて --}}
@foreach ($users as $user) {{ $user->name }} @endforeach
{{ $users->links() }}

Slide 7

Slide 7 text

No content

Slide 8

Slide 8 text

routing を触らずに ページネーション用の URL (?page=x) が生まれる • 勝手に routing が生成される？ だけでいい感じにページネーションのリンクが生まれる 8 なんか気持ち悪い…… $users->links()

Slide 9

Slide 9 text

……

Slide 10

Slide 10 text

// Controller にて $users = App¥User::paginate(15); {{-- blade template にて --}}
@foreach ($users as $user) {{ $user->name }} @endforeach
{{ $users->links() }}

Slide 11

Slide 11 text

// Controller にて $users = App¥User::paginate(15); {{-- blade template にて --}}
@foreach ($users as $user) {{ $user->name }} @endforeach
{{ $users->links() }}

Slide 12

Slide 12 text

• の戻り値 • ページネーションに必要な情報を持っている • もこのクラスに生えている 12 ¥Illuminate¥Pagination¥LengthAwarePaginator // Controller にて $users = App¥User::paginate(15); ¥Illuminate¥Database¥Query¥Builder::paginate() links()

Slide 13

Slide 13 text

• の戻り値 • ページネーションに必要な情報を持っている • もこのクラスに生えている 13 ¥Illuminate¥Pagination¥LengthAwarePaginator // Controller にて $users = App¥User::paginate(15); ¥Illuminate¥Database¥Query¥Builder::paginate() links()

Slide 14

Slide 14 text

14 ¥Illuminate¥Pagination¥LengthAwarePaginator // Controller にて $users = App¥User::paginate(15);

Slide 15

Slide 15 text

これらの情報から、ページネーション部分の HTML を生成することはできる（わかる）

Slide 16

Slide 16 text

16 ¥Illuminate¥Pagination¥LengthAwarePaginator // Controller にて $users = App¥User::paginate(15);

Slide 17

Slide 17 text

17 ¥Illuminate¥Pagination¥LengthAwarePaginator // Controller にて $users = App¥User::paginate(15); DBから取得できる （わかる）

Slide 18

Slide 18 text

18 ¥Illuminate¥Pagination¥LengthAwarePaginator // Controller にて $users = App¥User::paginate(15); DBから取得できる （わかる） 引数でもらう （わかる）

Slide 19

Slide 19 text

19 ¥Illuminate¥Pagination¥LengthAwarePaginator // Controller にて $users = App¥User::paginate(15); DBから取得できる （わかる） 引数でもらう （わかる） 算出できる （わかる）

Slide 20

Slide 20 text

20 ¥Illuminate¥Pagination¥LengthAwarePaginator // Controller にて $users = App¥User::paginate(15); DBから取得できる （わかる） 引数でもらう （わかる） 算出できる （わかる） ？？（わからない）

Slide 21

Slide 21 text

ここからは勘と執念の戦い （なのでちょっと駆け足）

Slide 22

Slide 22 text

• の戻り値 • ページネーションに必要な情報を持っている • もこのクラスに生えている 22 ¥Illuminate¥Pagination¥LengthAwarePaginator // Controller にて $users = App¥User::paginate(15); ¥Illuminate¥Database¥Query¥Builder::paginate() links()

Slide 23

Slide 23 text

23 ¥Illuminate¥Database¥Query¥Builder::paginate() public function paginate($perPage = 15, $columns = ['*'], $pageName = 'page', $page = null) { $page = $page ?: Paginator::resolveCurrentPage($pageName); $total = $this->getCountForPagination($columns); $results = $total ? $this->forPage($page, $perPage)->get($columns) : collect(); return $this->paginator($results, $total, $perPage, $page, [ 'path' => Paginator::resolveCurrentPath(), 'pageName' => $pageName, ]); }

Slide 24

Slide 24 text

24 ¥Illuminate¥Database¥Query¥Builder::paginate() public function paginate($perPage = 15, $columns = ['*'], $pageName = 'page', $page = null) { $page = $page ?: Paginator::resolveCurrentPage($pageName); $total = $this->getCountForPagination($columns); $results = $total ? $this->forPage($page, $perPage)->get($columns) : collect(); return $this->paginator($results, $total, $perPage, $page, [ 'path' => Paginator::resolveCurrentPath(), 'pageName' => $pageName, ]); } currentPage を解決してそう

Slide 25

Slide 25 text

25 ¥Illuminate¥Pagination¥AbstractPaginator public static function resolveCurrentPage($pageName = 'page', $default = 1) { if (isset(static::$currentPageResolver)) { return call_user_func(static::$currentPageResolver, $pageName); } return $default; } /** * Set the current page resolver callback. * * @param ¥Closure $resolver * @return void */ public static function currentPageResolver(Closure $resolver) { static::$currentPageResolver = $resolver; }

Slide 26

Slide 26 text

26 ¥Illuminate¥Pagination¥AbstractPaginator public static function resolveCurrentPage($pageName = 'page', $default = 1) { if (isset(static::$currentPageResolver)) { return call_user_func(static::$currentPageResolver, $pageName); } return $default; } /** * Set the current page resolver callback. * * @param ¥Closure $resolver * @return void */ public static function currentPageResolver(Closure $resolver) { static::$currentPageResolver = $resolver; } $currentPageResolver を呼び出している $currentPageResolver は……？

Slide 27

Slide 27 text

27 ¥Illuminate¥Pagination¥AbstractPaginator public static function resolveCurrentPage($pageName = 'page', $default = 1) { if (isset(static::$currentPageResolver)) { return call_user_func(static::$currentPageResolver, $pageName); } return $default; } /** * Set the current page resolver callback. * * @param ¥Closure $resolver * @return void */ public static function currentPageResolver(Closure $resolver) { static::$currentPageResolver = $resolver; } ここでセットされてる！

Slide 28

Slide 28 text

順当にクラス定義をさかのぼって行くと、ここで行き止まる ＝ の呼び出し箇所が見つからない → Laravel には ServiceProvider という仕組みがある • アプリケーションの各所初期処理が行われる場所 28 行き止まり？ Paginator::currentPageResolver()

Slide 29

Slide 29 text

29 ¥Illuminate¥Pagination¥PaginationServiceProvider public function register() { Paginator::viewFactoryResolver(function () { return $this->app['view']; }); Paginator::currentPathResolver(function () { return $this->app['request']->url(); }); Paginator::currentPageResolver(function ($pageName = 'page') { $page = $this->app['request']->input($pageName); if (filter_var($page, FILTER_VALIDATE_INT) !== false && (int) $page >= 1) { return (int) $page; } return 1; }); }

Slide 30

Slide 30 text

30 ¥Illuminate¥Pagination¥PaginationServiceProvider public function register() { Paginator::viewFactoryResolver(function () { return $this->app['view']; }); Paginator::currentPathResolver(function () { return $this->app['request']->url(); }); Paginator::currentPageResolver(function ($pageName = 'page') { $page = $this->app['request']->input($pageName); if (filter_var($page, FILTER_VALIDATE_INT) !== false && (int) $page >= 1) { return (int) $page; } return 1; }); } リクエストパラメータ ${pageName} を取得

Slide 31

Slide 31 text

31 ¥Illuminate¥Pagination¥LengthAwarePaginator // Controller にて $users = App¥User::paginate(15); DBから取得できる （わかる） 引数でもらう （わかる） 算出できる （わかる） ？？（わからない）

Slide 32

Slide 32 text

32 ¥Illuminate¥Pagination¥LengthAwarePaginator // Controller にて $users = App¥User::paginate(15); DBから取得できる （わかる） 引数でもらう （わかる） 算出できる （わかる） わかった！

Slide 33

Slide 33 text

No content

Slide 34

Slide 34 text

• Laravel の paginate は一見アクロバティックだが 意外と副作用が無い形になっていた • Laravel のコードを追って行って abstract class や interface で行き止まったら それっぽい ServiceProvider を探すと良い • こういうの調査するのに PhpStorm が便利！（Go To Declaration） • 要 larvae-ide-helper https://github.com/barryvdh/laravel-ide-helper 34 まとめ