CakePHP5でヘルパーから他のヘルパーを読み込む方法・CakePHP4からの変更点

2024/12/13 2025/01/31

CakePHP5でヘルパーから他のヘルパーを読み込む方法・CakePHP4からの変更点

　
CakePHP5でオリジナルのヘルパーを作成し、そのヘルパー内で HTMLヘルパーや Formヘルパーなどを使用する場合もあるかと思います。
　
https://book.cakephp.org/5/ja/views/helpers.html#id10
ですが、上記の日本語の Cookbookは間違っておりまして、そのままでは動作しません。
また、CakePHP4のソースをそのままコピペしても動作しませんので、併せてご注意ください。（上記の Cookbookのソースは CakePHP4の時のものとなっています。）
　
次項が正しいソースとなりますのでご注意ください。
　
　

CakePHP5でヘルパーから他のヘルパーを読み込む際の正しいソースコード

　
/src/View/Helper/LinkHelper.php
上記に「LinkHelper.php」というオリジナルのヘルパーファイルを作成したとします。
　
この時の正しいソースコードは下記となります。
　

<?php

namespace App\View\Helper;
use Cake\View\Helper;

class LinkHelper extends Helper
{
    protected array $helpers = ['Html'];

    public function makeEdit($title, $url)
    {
        // 出力に HTML ヘルパーを使用
        // 整形されたデータ:

        $link = $this->Html->link($title, $url, ['class' => 'edit']);

        return '<div class="editOuter">' . $link . '</div>';
    }
}

<?php

namespace App\View\Helper;

use Cake\View\Helper;

class LinkHelper extends Helper

{

protected array $helpers = ['Html'];

public function makeEdit($title, $url)

{

// 出力に HTML ヘルパーを使用

// 整形されたデータ:

$link = $this->Html->link($title, $url, ['class' => 'edit']);

return '<div class="editOuter">' . $link . '</div>';

}

CakePHP5の日本語 Cookbookの間違い箇所、および、CakePHP4からの変更点

　
https://book.cakephp.org/5/ja/views/helpers.html#id10
下記のソースコードは上記の CakePHP5の日本語 Cookbookに記載があるソースコードです。
　

<?php
namespace App\View\Helper;

use Cake\View\Helper;

class LinkHelper extends Helper
{
    public $helpers = ['Html'];

    public function makeEdit($title, $url)
    {
        // 出力に HTML ヘルパーを使用
        // 整形されたデータ:

        $link = $this->Html->link($title, $url, ['class' => 'edit']);

        return '<div class="editOuter">' . $link . '</div>';
    }
}

<?php

namespace App\View\Helper;

use Cake\View\Helper;

class LinkHelper extends Helper

{

public $helpers = ['Html'];

public function makeEdit($title, $url)

{

// 出力に HTML ヘルパーを使用

// 整形されたデータ:

$link = $this->Html->link($title, $url, ['class' => 'edit']);

return '<div class="editOuter">' . $link . '</div>';

}

　
　
先に紹介した正しいソースコードと何が違うかというと、8行目の「$helpers」の前に型を定義する「array」があるかどうか、です。
「array」を付けると正しく動作します。
　

//【正しい記述】
    protected array $helpers = ['Html'];

//【間違いの記述】
    public $helpers = ['Html'];

//【正しい記述】

protected array $helpers = ['Html'];

//【間違いの記述】

public $helpers = ['Html'];

　
「protected」か「public」かの違いもありますが、これはどちらでも動作します。
（「protected」と「public」の違いが分からない方は別途調べてみてください。）
　
　

`Fatal error: Type of App\View\Helper\LinkHelper::$helpers must be array`のエラーメッセージが表示される

　
間違っている方の記述で実行すると、下記のようなエラーメッセージが表示されます。
「Fatal error: Type of App\View\Helper\LinkHelper::$helpers must be array (as in class Cake\View\Helper) in C:\xampp\htdocs\src\View\Helper\LinkHelper.php on line 6」
　
「$helpers は配列型である必要があるよ」というエラーなので、型を指定すればよさそうだということに気づく可能性はゼロではありませんが、公式の Cookbook通りに記述しても動作しないので、延々と悩んでしまいました。
　
　
ちなみに、最初の正しいソースコードは、下記の英語版の Cookbookに記載があるソースコードです。
https://book.cakephp.org/5/en/views/helpers.html#including-other-helpers
　
というワケで、日本語の Cookbookで動作しない場合は、英語版の Cookbookを参照してみるのもいいかもしれません。
　
　
　

CakePHP5の日本語 Cookbookの間違いの原因は CakePHP4のソースコードのままである点

　
なぜ、日本語の公式 Cookbookのソースコードが間違っているか、というと CakePHP4のヘルパーのソースコードがそのままコピペされていて、CakePHP5版に変更されていないためです。
　
CakePHP4　Cookbook　ヘルパー
https://book.cakephp.org/4/ja/views/helpers.html#id10
　
というワケで、オリジナルのヘルパーから他のヘルパーを読み込む処理で、CakePHP4と CakePHP5との違いは、ここで紹介した「$helpers」の型指定の「array」の有無ということになります。
　
CakePHP4のソースコードを利用して CakePHP5の開発を行う際は、この点を注意する必要があるということになりますね。
　
　

- CakePHP 3.x 4.x 5.x CakePHP5

最後までお読みいただきましてありがとうございます。
この記事が参考になったと思いましたらソーシャルメディアで共有していただけると嬉しいです！

Message コメントをキャンセル

※入力いただいたコメントは管理者の承認後に掲載されます。

: CakePHP4、5のユーザ認証でID、PASS以外の削除フラグなども条件加える方法

CakePHP4系、5系ではAuthenticationを使用してログイン認証を行う。その認証でID、PASS以外の削除フラグなどの条件を加えたいときの対応方法について解説。

: CakePHP4、5のnewEmptyEntityで作成したオブジェクトは空なのか、確認してみた

CakePHPでレコードを新規登録をする際にnewEmptyEntity()を使って空のEntityを作成するが、これのempty、is_nullなどのでの判定結果がtrueかfalseか確認してみた。

: CakePHP3のInsert On Duplicate Key Update（upsert）構文を解説・バルク処理も

CakePHP3で Insert … On Duplicate Key Update構文（upsert）を実行する方法を解説。バルク処理の方法も用意されているため大量処理の場合も対応可能。

: CakePHPで favicon.icoやapple-touch-icon-144-precomposed.pngが could not be foundのエラーが出るときの対処方法

CakePHPで「CakeDC/Users」などルーティングを行うプラグインを利用するときに、favicon.icoやapple-touch-icon-144-precomposed.pngがNotFoundエラーになることがある。その対処方法の解説。

: CakePHP 2.3 Model、Controllerの見たい変数の中身をログ出力

CakePHPの Modelや Controllerの変数の中身をログとして出力して見る方法を提供します。

: CakePHP4、5で$_SERVERと同じようにURIを取得する「getUri()」の紹介

PHPでサーバ情報、環境情報を取得する際は「$_SERVER」を利用するが、似たような情報をCakePHPの関数で取得する際は「getUri()」を使用する。取得出来る値は一致するものもあるが、違うものもあり便利な使い方もある。