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

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

: URL短縮サービス「TTTオンライン（https://ttt.onl）」公開

URL短縮サービス「TTTオンライン（https://ttt.onl）」を公開。メールやSNSでは使いにくい長いURLを短いURLに変換するサービス。QRコードも。Google URL Shortenerが2019年3月にサービス終了。

: Windows環境の XAMPPを利用して CakePHPの開発する際の注意点

WindowsベースにXAMPPで環境を構築しCakePHP4を利用したWebシステムを構築する際は、大文字と小文字の違いを意識する必要がある。LinuxベースのWebサーバに移動させたときに不具合で動作しないこともある。

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

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

: CakePHP3でファイルのアップロード処理を自作・解説付き・その１

CakePHP3でファイルをアップロードする処理を、php.netにある「エラーを起こさない」と説明がある処理を参考に作成。サンプルソースとその解説付きで、コピペでも動くし、カスタマイズも簡単！

: CakePHP3のOGPはHTMLヘルパーの$this->Html->meta()を使って設定

CakePHP3でOGPを設定する方法を解説。metaタグを編集するHTMLヘルパーを利用してOGPのタグを編集する。また、エレメントとして分割することでメンテナンス性も向上させる。

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

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

: CakePHP4系でJSONレスポンスの処理ではwithStringBodyを使う。3との違い解説

responseの値を指定する方法は3系では「body」だが、4系では「withStringBody」になりる。加えてJSON形式なら「withType」で指定するなど4系では結構異なる処理がある。

: getParam('action')で取得するアクション名は別関数に移動しても不変

CakePHP4系、5系では「getParam()」で処理中のアクション名を取得できる。そのアクションから別関数を呼び出してた関数でアクション名を調べたが同一の名称だった。

: CakePHP4 でコマンドプログラム（シェルプログラム）を作成する方法解説

CakePHP4でバッチ処理を行うためのコマンド・シェルの実装方法について解説。bakeでテンプレートファイルを作成し、「execute()」に処理を記述する方法を解説。

: CakePHP3でQRコードを作成、表示するライブラリ「cakePHP-QR-Code-Helper」

CakePHPでQRコードを生成するライブラリ「cakePHP-QR-Code-Helper」の紹介。GDライブラリのインストールも必要ないHelperとして提供されているため、ファイルを設置すればすぐに使用可能。