CakePHP 4 でパンくずリストを実装して Bootstrap 4 に対応する方法

はじめに

Web サイトやシステムを構築する際には、パンくずリストを使うことが良くあります。トピックパスともいわれていますが、 英語だと Breadcrumbs と言うらしいです。

ところで CakePHP 4 にもパンくずリストを実装する便利な機能があります。

今日は CakePHP 4 でパンくずリストを実装する方法をご紹介します。

また、先日投稿した「CakePHP 4 で Bootstrap 4 準拠のページリンクをつくる」と同様に、 パンくずリストを Bootstrap 4 準拠にする方法 も併せてご紹介します。

CakePHP
4.0.7
Bootstrap
4.5.0
目次
  1. 下準備
  2. パンくずリストの実装方法
  3. setTemplates() で Boostrap 4 対応
  4. 設定ファイルでテンプレ変更
  5. おわりに

1. 下準備

今回も CDN を使って下記テンプレート用意しました。

CDN へのリンクは変更になっている可能性がありますので、下記公式サイトで紹介しているタグをコピペすることをおススメします。
Quick start (Introduction · Bootstrap v4.5)
https://getbootstrap.com/docs/4.5/getting-started/introduction/#quick-start
/templates/layout/default.php
<!doctype html>
<html lang="ja">
<head>
  <meta charset="utf-8">
  <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
  <title>Sample</title>
  <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.5.0/css/bootstrap.min.css" integrity="sha384-9aIt2nRpC12Uk9gS9baDl411NQApFmC26EwAOH8WgZl5MYYxFfc+NcPb1dKGj7Sk" crossorigin="anonymous">
  <script src="https://code.jquery.com/jquery-3.5.1.slim.min.js" integrity="sha384-DfXdz2htPH0lsSSs5nCTpuj/zy4C+OGpamoFVy38MVBnE+IbbVYUew+OrCXaRkfj" crossorigin="anonymous"></script>
  <script src="https://cdn.jsdelivr.net/npm/popper.js@1.16.0/dist/umd/popper.min.js" integrity="sha384-Q6E9RHvbIyZFJoft+2mJbHaEWldlvI9IOYy5n3zV9zzTtmI3UksdQRVvoxMfooAo" crossorigin="anonymous"></script>
  <script src="https://stackpath.bootstrapcdn.com/bootstrap/4.5.0/js/bootstrap.min.js" integrity="sha384-OgVRvuATP1z7JjHLkuOU7Xw704+h835Lr+6QL9UvYjZE3Ipu6Tp75j7Bh/kR0JKI" crossorigin="anonymous"></script>
</head>
<body>
  <?= $this->fetch('content') ?>
</body>
</html>

コントローラとアクションは「記事の新規登録」画面を想定して、下記のようにしました。

/src/Controller/ArticlesController.php
<?php
declare(strict_types=1);

namespace App\Controller;

class ArticlesController extends AppController
{
    public function add()
    {
    }
}

3. setTemplates() で Boostrap 4 対応

パンくずリストのテンプレートは Breadcrumbs ヘルパーの setTemplates() 関数で変更可能です。

Boostrap 4 に対応するためには、下記のように指定します。

/templates/layout/default.php
<body>
  <!-- ▼追加 -->
  <?php $this->Breadcrumbs->setTemplates([
    'wrapper' => '<nav aria-label="breadcrumb"{{attrs}}><ol class="breadcrumb">{{content}}</ol></nav>',
    'item' => '<li class="breadcrumb-item"{{attrs}}><a href="{{url}}"{{innerAttrs}}>{{title}}</a></li>',
    'itemWithoutLink' => '<li class="breadcrumb-item active"{{attrs}}>{{title}}</li>',
    'separator' => null,
]); ?>

  <?= $this->Breadcrumbs->render() ?>
Customizing the Output (CakePHP 4.x Cookbook)
https://book.cakephp.org/4/en/views/helpers/breadcrumbs.html#customizing-the-output
Breadcrumb · Bootstrap v4.5
https://getbootstrap.com/docs/4.5/components/breadcrumb/

4. 設定ファイルでテンプレ変更

公式ドキュメントに説明が見当たならかったのですが、ページリンクのときと同様に、テンプレート設定ファイルで変更することもできます。

ファイル名は自分で決めることが可能で、今回はページリンクと同様の形にしています。

setTemplates() のコードは削除してください
/src/View/AppView.php
public function initialize(): void
{
    // ▼ 追加
    $this->loadHelper('Breadcrumbs', ['templates' => 'breadcrumb-templates']);
}
/config/breadcrumb-templates.php
<?php
return [
    'wrapper' => '<nav aria-label="breadcrumb"{{attrs}}><ol class="breadcrumb">{{content}}</ol></nav>',
    'item' => '<li class="breadcrumb-item"{{attrs}}><a href="{{url}}"{{innerAttrs}}>{{title}}</a></li>',
    'itemWithoutLink' => '<li class="breadcrumb-item active"{{attrs}}>{{title}}</li>',
    'separator' => null,
];

5. おわりに

個人的には設定ファイルが便利だと思うのですが、テンプレートなのに config に置くのはチョット違和感があります。

一方で setTemplates() を使えばテンプレートに書けるので、好みや状況に応じて使い分けると良いのかなと思っています。