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

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

: CakePHP3にデザインテンプレートBootstrapを導入する方法・friendsofcake/bootstrap-ui使用

CakePHP3にプラグイン「friendsofcake/bootstrap-ui」、デザインテンプレート「Bootstrap」を設置する手順を解説。Bootstrapの簡単な使い方やデフォルトのデザインとの混在方法なども解説。

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

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

: CakePHP 2.3　ID以外のカラムでアソシエーション（連携）をさせる場合の詳細ページの注意点

ID以外のカラムでアソシエーション（連携）させて詳細ページを表示させる際の考え方と注意点をサンプルソースを用いて解説しています。

: CakePHP4で定数の設定と呼び出し方法の解説（defineとConfigure）

CakePHP4で定数を設定、使用する方法を解説。定数定義はdefineとConfigureを使用する方法を解説。また、bootstrap.phpに直接記述する方法と別のファイルにする方法を解説。

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

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