CakePHP4 のコマンドプログラムからコンポーネントを読み込む方法解説

2024/06/20 2024/06/21

CakePHP4 のコマンドプログラムからコンポーネントを読み込む

　
今回は「CakePHP4でコマンドプログラムを作成する」の全 4回のうちの 2回目で、「コマンドプログラムからコンポーネントを呼び出す方法」について解説します。
　

共通関数のコンポーネントについて

　
プログラムを作成する中で、他の「コントローラー（Controller）」でも使用する共通処理は、「コンポーネント（Component）」として別ファイルにまとめて管理をします。
（「モデル（Model）」の場合は「ビヘイビア（Behavior）」で、「ビュー（View）」の場合は「ヘルパー（Helper）」ですね。）
　
コマンドプログラムからは、「コントローラー（Controller）」用に作成されたものも含めて、「コンポーネント（Component）」の処理を呼び出して利用することができるようになっています。
　
　
今回の記事では、そのコンポーネントを呼び出して、コマンド内で利用する方法について解説します。
　
　

コマンドから共通関数のコンポーネントを読み込む処理

　
コンポーネントを読み込む処理を追記したコマンドプログラムが下記となります。
　

<?php
declare(strict_types=1);

namespace App\Command;

use Cake\Command\Command;
use Cake\Console\Arguments;
use Cake\Console\ConsoleIo;
use Cake\Console\ConsoleOptionParser;

use Cake\Controller\ComponentRegistry;         // コンポーネントの使用を可能にする
use App\Controller\Component\CommonComponent;  // 使用するコンポーネントを指定

/**
 * Hello command.
 */
class HelloCommand extends Command
{
  /**
   * Hook method for defining this command's option parser.
   *
   * @see https://book.cakephp.org/4/en/console-commands/commands.html#defining-arguments-and-options
   * @param \Cake\Console\ConsoleOptionParser $parser The parser to be defined
   * @return \Cake\Console\ConsoleOptionParser The built parser.
   */
  public function buildOptionParser(ConsoleOptionParser $parser): ConsoleOptionParser
  {
    $parser = parent::buildOptionParser($parser);

    return $parser;
  }


  public function initialize(): void
  {
    parent::initialize();

    // Commonコンポーネントの読み込み
    $this->Common   = new CommonComponent(new ComponentRegistry());
  }

  /**
   * Implement this method with your command's logic.
   *
   * @param \Cake\Console\Arguments $args The command arguments.
   * @param \Cake\Console\ConsoleIo $io The console io
   * @return null|void|int The exit code or null for success
   */
  public function execute(Arguments $args, ConsoleIo $io)
  {
    $io->out('Hello world.');

    print_r("Hello world. \n");
    echo "Hello world. \n";

//  // Commonコンポーネントの読み込み
//  $this->Common   = new CommonComponent(new ComponentRegistry());

    $getSample = $this->Common->getSample();
    print_r($getSample);
  }
}

<?php

declare(strict_types=1);

namespace App\Command;

use Cake\Command\Command;

use Cake\Console\Arguments;

use Cake\Console\ConsoleIo;

use Cake\Console\ConsoleOptionParser;

use Cake\Controller\ComponentRegistry; // コンポーネントの使用を可能にする

use App\Controller\Component\CommonComponent; // 使用するコンポーネントを指定

/**

* Hello command.

class HelloCommand extends Command

{

/**

* Hook method for defining this command's option parser.

* @see https://book.cakephp.org/4/en/console-commands/commands.html#defining-arguments-and-options

* @param \Cake\Console\ConsoleOptionParser $parser The parser to be defined

* @return \Cake\Console\ConsoleOptionParser The built parser.

public function buildOptionParser(ConsoleOptionParser $parser): ConsoleOptionParser

{

$parser = parent::buildOptionParser($parser);

return $parser;

}

public function initialize(): void

{

parent::initialize();

// Commonコンポーネントの読み込み

$this->Common = new CommonComponent(new ComponentRegistry());

}

/**

* Implement this method with your command's logic.

* @param \Cake\Console\Arguments $args The command arguments.

* @param \Cake\Console\ConsoleIo $io The console io

* @return null|void|int The exit code or null for success

public function execute(Arguments $args, ConsoleIo $io)

{

$io->out('Hello world.');

print_r("Hello world. \n");

echo "Hello world. \n";

// // Commonコンポーネントの読み込み

// $this->Common = new CommonComponent(new ComponentRegistry());

$getSample = $this->Common->getSample();

print_r($getSample);

}

利用するコンポーネントを use句で指定

　
まず初めに、「use句」を記述する箇所に 11～12行目の 2行を追記します。
11行目は固定の文字列ですが、12行目は使用するコンポーネントの名称に書き換えてください。
上記では「CommonComponent.php」と言うコンポーネントを呼び出す想定の記述になっています。
　
　

コンポーネントをオブジェクトとして取得

　
続けて、コンポーネントをオブジェクトとして取得する「39行目」か「57行目」のいずれかを記述します。
　
コンポーネントだけを呼び出すのであれば 57行目の記述方法の方が簡単かと思います。
　
ただ、個人的には「initialize()」に、そのコマンド（コントローラー）内で使用するコンポーネントだけではなく、モデルの読み込みもまとめて記述する方法が好きですので、34～40行目の「initialize()」に記述する方法をオススメしたいですね。
　
　

  public function initialize(): void
  {
    parent::initialize();

    // 各モデルの読み込み
    $this->Users        = TableRegistry::getTableLocator()->get('Users');

    // Commonコンポーネントの読み込み
    $this->Common   = new CommonComponent(new ComponentRegistry());
  }

public function initialize(): void

{

parent::initialize();

// 各モデルの読み込み

$this->Users = TableRegistry::getTableLocator()->get('Users');

// Commonコンポーネントの読み込み

$this->Common = new CommonComponent(new ComponentRegistry());

}

コンポーネントを作成

　
コンポーネントは下記コマンドでコンポーネントのテンプレートファイルを生成することができます。
　

$ cake bake component Common

1	$ cake bake component Common

　
　
これに対して、先のコマンドから利用する「getSample()」関数を追記すると下記のようになります。
　

<?php
declare(strict_types=1);

namespace App\Controller\Component;

use Cake\Controller\Component;
use Cake\Controller\ComponentRegistry;

/**
 * Common component
 */
class CommonComponent extends Component
{

  /**
   * Default configuration.
   *
   * @var array<string, mixed>
   */
  protected $_defaultConfig = [];

  public function getSample()
  {
    return "Sample";
  }
}

<?php

declare(strict_types=1);

namespace App\Controller\Component;

use Cake\Controller\Component;

use Cake\Controller\ComponentRegistry;

/**

* Common component

class CommonComponent extends Component

{

/**

* Default configuration.

* @var array<string, mixed>

protected $_defaultConfig = [];

public function getSample()

{

return "Sample";

}

コマンドプログラムからコンポーネントを読み込む方法のまとめ

　
基本的に、コントローラーからとコマンドからと、コンポーネントを読み込む方法はあまり違いはありません。
ただ、少し記述の仕方が違うことと、use句で使用するコンポーネントを指定する点が違うなどしていますので、少し確認が必要かと思います。
　
　

- CakePHP 3.x 4.x 5.x CakePHP4

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

Message コメントをキャンセル

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

: CakePHP4の規約外のカラムをキーにアソシエーション（テーブル連結）する方法

CakePHPで規定外のカラム名のキーを指定してアソシエーション（テーブル連結）をする方法を解説。アソシエーション名によってはミスが発生しやすい点もあるので注意も必要。

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

CakePHP5のヘルパーで他のヘルパーを読み込む方法を解説。公式の日本語CookbookはCakePHP4のソースのままで間違っているため注意が必要。CakePHP4からの移行の際も同じ点に注意が必要。

: CakePHP3で環境変数を設定して本番環境と開発環境を分けて処理をする場合

CakePHP3で開発環境と本番環境とで違う設定ファイルを読み込ませて環境ごとに定数を切り替える方法を解説。Apacheのhttpd.confに環境変数を設定し、それを読み込み判別する。

: Google Analytics APIを CakePHP3で動かしてレポートデータを取得する方法の解説

CakePHP3で Google Analytics APIからレポートデータを取得する処理の解説。PHPのサンプルソースをCakePHP3で動くように改造。加えて、ディメンションやメトリックスを条件に設定する方法なども。

: CakePHP3でComposerでインストールできないプラグイン、外部ライブラリを vendorに入れて手動で読み込む方法

CakePHP3にComposerからインストールできないプラグインやライブラリなどを利用する方法、vendorにファイルを設置し、composer.jsonを更新し、それを呼び出す方法を詳細に解説。

: CakePHP3のルーティング（routes.php）の変更が反映されない時はキャッシュのクリアを

CakePHP3でルーティングの設定変更をしたけど反映されない！そんなときは慌てず騒がずキャッシュをクリアしよう！ルーティングの設定もキャッシュされることがあるらしい。

: CakePHP4、5の認証処理で認証が通らない際の確認方法と確認箇所の紹介

CakePHP4、5系の認証処理でログイン認証が通らない場合の確認方法、確認箇所を解説。ログ出力し、ステータスを確認するが、ステータスの内容も紹介。それはそのままusernameを変更する際のポイントでもある。

: CakePHP3で他のテーブルのマスタテーブルからセレクトボックス（プルダウンリスト）を作る

他のテーブルのマスタのレコードからプルダウンリストを作成し、選択できるようにするサンプルプログラムと解説。ORMの設定によりデータベースの値を取得し、配列を作成し optionsに与える。

: CakePHP4のcake cache clear_allでPermission deniedはパーミッションの変更が必要

CakePHP4でキャッシュをクリアするコマンドcake cache clear_allでPermission deniedのエラーが出るのはcakeにパーミッションが足りないとき。その対処方法を解説。