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 コメントをキャンセル

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

: CakePHPを学ぶ際にはオブジェクト指向を学ぼう

CakePHPはオブジェクト指向で書かれていますので、CakePHPを学ぶにはオブジェクト指向も学びましょう。

: CakePHP3で現在処理しているコントローラー名、アクション名を取得する方法

CakePHP3で現在処理しているコントローラー名、アクション名を取得する方法を解説。複数の方法があるが、getParam()メソッドを使う方法が汎用性があって便利かも。

: CakePHP3でPHP Simple HTML DOM Parserを使ってスクレイピングする方法

CakePHP3でPHP Simple HTML DOM Parserを使ってスクレイピングをする方法を解説。インストール方法、読み込み方法。および、具体的なスクレイピングを実行するサンプルソースも。

: CakePHP3ログファイルへの出力・$this->log()、独自ログへの出力方法の解説

コントロール、モデルの変数の中身を見るときはログに出力する方法が有効です。$this->log()を利用すると変数だけじゃなく、連想配列、オブジェクトも簡単にログ出力ができます。

: CakePHP 2.3で PDFを作成する方法を調査「mpdf」「TCPDF」「FPDF」

CakePHPで PDFを編集、出力するには「mpdf」「TCPDF」「FPDF」といったプラグインがあり、使い勝手を比較検討しました。TCPDFが一番良さそうでした。

: CakePHP3でWarning Error: SplFileInfo::openFile()エラーが発生した場合の対処方法

CakePHP3のキャッシュファイルのパーミッションエラー Error: SplFileInfo::openFile()が発生した場合の対応方法解説。app.phpにキャッシュファイルのパーミッション設定を行い、既存のファイルは削除。

: CakePHP 2.3 主キー（ID）以外のキーで更新方法 updateAll

主キー（ID）以外のカラムをキーとして更新する方法、updateAllの使い方をサンプルを用いて解説します。

: CakePHP4でロギングスコープやログレベルを使用してログを出し分ける方法を解説

CakePHPのログ出力方法の解説。app.phpにログ設定をし、スコープやレベルを指定してログ出力を振り分ける方法、CakePHP4で配列出力にはvar_exportが必要なことなどを解説。

: CakePHP3にWYSIWYGエディタのCKEditor4を設置、カスタマイズ方法を解説

WYSIWYGエディタであるCKEditor4をCDNを利用して簡単にCakePHP3に導入する方法とカスタマイズする方法を解説。CakePHP3にはページごとの振り分けを行うブロック化を利用する。

: CakePHP3のHtmlHelperのLink設定のまとめ。mailto、URL、Root／Homeのリンクなども

CakePHP3でHtmlHelperを使ってリンクの設定をする方法のまとめ。基本形からURLを指定、class、id、targetを指定、mailtoのリンク、画像をアンカーに、JavaScriptのダイアログなどの解説。

PREV: CakePHP4、CakePHP5の「warning: DebugKit is disabling．．．」の対処方法
NEXT: CakePHP4系でJSONレスポンスの処理ではwithStringBodyを使う。3との違い解説

日	月	火	水	木	金	土
1	2	3	4	5	6	7
8	9	10	11	12	13	14
15	16	17	18	19	20	21
22	23	24	25	26	27	28

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

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

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

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

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

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

CakePHP5の関連記事

GoogleAdwords

GoogleAdwords

Message コメントをキャンセル

関連記事

CakePHPを学ぶ際にはオブジェクト指向を学ぼう

CakePHP3で現在処理しているコントローラー名、アクション名を取得する方法

CakePHP3でPHP Simple HTML DOM Parserを使ってスクレイピングする方法

CakePHP3ログファイルへの出力・$this->log()、独自ログへの出力方法の解説

CakePHP 2.3で PDFを作成する方法を調査「mpdf」「TCPDF」「FPDF」

CakePHP3でWarning Error: SplFileInfo::openFile()エラーが発生した場合の対処方法

CakePHP 2.3 主キー（ID）以外のキーで更新方法 updateAll

CakePHP4でロギングスコープやログレベルを使用してログを出し分ける方法を解説

CakePHP3にWYSIWYGエディタのCKEditor4を設置、カスタマイズ方法を解説

CakePHP3のHtmlHelperのLink設定のまとめ。mailto、URL、Root／Homeのリンクなども

WordPress投稿にPHPを記述するショートコードの使い方add_shortcode

コピーコンテンツ対策.htaccessで直リンク禁止しリダイレクトで対応

評価点投票プラグイン10個を比較！WordPressで口コミサイトを構築

BackWPupでバックアップ・リストア（復元）の具体的手順

コンパクトキーボード・KEK-EA9AU・FKB1420の魅力

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

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

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

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

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

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

CakePHP5の関連記事

GoogleAdwords

GoogleAdwords

Message コメントをキャンセル

関連記事

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