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 CakePHP4

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

Message コメントをキャンセル

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

: CakePHP 2.3でファイルのアップロード処理を作る

CakePHPでプラグインを使わないファイルアップロード処理を解説します。簡単です。DBにファイルを格納する方法も。

: CakePHP3でDocumentRootやtmp、webroot、logsなどのフォルダへのパスの定数

CakePHP3で特定フォルダのパスの定数を解説。root、DocumentRoot、app、config、webroot、tests、tmp、cache、vendor、コア、コアの srcが設定済み。realpath()関数を使うと柔軟なパス指定が可能。

: CakePHP 2.3　Search Pluginで検索処理　その７queryを使って日付の範囲検索

CakePHPの検索プラグイン Search Pluginの検索処理の中で queryを使って日付の範囲検索の方法です。

: CakePHP3のCakeDC/Usersの画面、メール本文テンプレートのカスタマイズ方法解説

CakeDC謹製Usersプラグインの紹介。ユーザ新規登録の流れを紹介しつつテンプレートファイルがどこにあるか、設定情報ファイルがどこにあるか、を説明しつつカスタマイズの方法を解説します。

: CakePHP3のメッセージ日本語化の設定（国際化と地域化の機能の使い方の解説）

CakePHP3の英語のメッセージを日本語化（多言語化）する手順を解説。オリジナルのメッセージを作成する方法やプログラムで文言を追加する場合の対応なども解説。

: CakePHP3のCakeDC/Usersのログイン後のリダイレクトとユーザ権限管理の設定解説

CakeDC謹製Usersプラグインの紹介。ログイン認証後にリダイレクトする先の設定方法についての解説と実運用するために必要なコツを解説。便利な仕組みも仕様の理解があって初めてうまく使いこなせる。

: CakePHP3のユーザ管理・ログイン認証プラグインCakeDC/Usersのインストール解説・3.6以降対応

CakePHP3のユーザ管理プラグイン Usersは、ユーザ登録、メール認証、ログイン認証、ユーザ管理、権限管理、reCAPTCHAなど会員制のサイトを簡単に実現可能。その導入方法、カスタマイズ方法を解説。

: CakePHP3でPHPExcelを使ってエクセルファイルを生成、出力する方法

CakePHP3でPHPExcelを利用してエクセルを編集、出力するサンプルソース＋解説。PHPExcelのインストール方法の解説からファイル保存とダウンロードの方法なども解説。

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

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