Laravel の paginate は一体何をやっているのか

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

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

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

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

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

Laravel の paginate は一体何をやっているのか

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

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

• の戻り値
13
links()

14

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

16

17
DBから取得できる
（わかる）

18
（わかる）
引数でもらう
（わかる）

19
（わかる）
引数でもらう
（わかる）
算出できる
（わかる）

20
（わかる）
引数でもらう
（わかる）
算出できる
（わかる）
？？（わからない）

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

• の戻り値
22
links()

23
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,
]);
}

24
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 を解決してそう

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;
}

26
{
}
return $default;
}
/**
*
* @return void
*/
{
}
$currentPageResolver を呼び出している
$currentPageResolver は……？

27
{
}
return $default;
}
/**
*
* @return void
*/
{
}
ここでセットされてる！

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

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;
});
}

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} を取得

31
（わかる）
引数でもらう
（わかる）
算出できる
（わかる）
？？（わからない）

32
（わかる）
引数でもらう
（わかる）
算出できる
（わかる）
わかった！

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

Laravel の paginate は一体何をやっているのか

More Related Content

What's hot (20)

More from Shohei Okada (20)

Laravel の paginate は一体何をやっているのか