CakePHP 3 でのコントローラー・テーブル・エンティティの名前空間の整理

岩佐孝浩

2017年10月26日

3 min read

CakePHP

この記事は、公開後3年以上が経過しています。

はじめに

CakePHP 3 のコントローラー、テーブル、エンティティを名前空間で整理することで、アプリケーションの構造を大幅に改善できます。本記事では、これらの各コンポーネントに名前空間を適用し、効率的に管理する方法を解説します。

コントローラーの名前空間を使用する

routes.php の prefix に名前空間を追加するには、App\Controller\<NAMESPACE> の形式を使用します。

$routes->connect('/employees', [
    'prefix'     => '<NAMESPACE>',
    'controller' => 'Employees',
    'action'     => 'index',
    '_method'    => ['GET'],
    '_ext'       => 'json',
]);

テーブルの名前空間を使用する

TableRegistry によるテーブルの登録

TableRegistry::get() を使用する際は、完全修飾名（ ...Table を含む）を指定してください。

$table = TableRegistry::get('App\Model\Table\<NAMESPACE>\EmployeesTable');

テーブルの初期化

デフォルトでは、テーブルのエイリアスは完全修飾名になります。この設定を上書きするには、initialize() メソッドを使用します。

public function initialize(array $config)
{
    parent::initialize($config);
    $this->alias('Employees');
}

アソシエーションの定義

belongsTo、hasOne、hasMany、belongsToMany などのアソシエーションを定義する際には、className に完全修飾名（...Table を含む）を指定してください。

$this->belongsTo('Estimates', [
    'className'    => 'App\Model\Table\<NAMESPACE>\CompaniesTable',
    'propertyName' => 'company',
]);

エンティティの名前空間を使用する

エンティティクラスを指定するには、Table->entityClass() メソッドを利用し、引数に 完全修飾名 を指定します。

$this->entityClass('App\Model\Entity\<NAMESPACE>\Employee');

まとめ

CakePHP 3 アプリケーションを名前空間で整理することで、大規模アプリケーションでもコード構造を最適化し、スケーラビリティを向上させることができます。コントローラー、テーブル、エンティティでの適切な名前空間の利用は、メンテナンスの効率化とモジュール設計の明確化につながります。

Happy Coding! 🚀