CakePHP3 Model/Entityで自分のテーブル名を知る。及び、フィールドの最大値をセットするコード

カテゴリー：CakePHP3

記事作成日：2017-05-07

CakePHP3.4.6のModel/Entity内で自分のテーブル名はどうやって知ればいいのか？分かっていればそのまま文字列で記述すればいいのだが、今回は都合によりその値を自動で得たい。

# Model/Entity内では$this->_registryAliasでテーブル名が得られる

この情報は公式で見つけたわけでは無いが、問題無く使用できているので良しとしよう。
公式サイトに書いてあるかは調べていない。

例：Model/Entity/Category.php

```php
namespace App\Model\Entity;
use Cake\ORM\Entity;

class Category extends Entity {
	public function modelNameTest() {
		$tableName = $this->_registryAlias;
	}
}
```

これで$tableNameには 'Categories' が入る。

何をしたかったかと言うと、以下の通りでまずはコード。

Model/Entity/Category.php

```php
namespace App\Model\Entity;
use Cake\ORM\Entity;
use Cake\ORM\TableRegistry;

class Category extends Entity {
	public function setNextSort() {
		$table = TableRegistry::get($this->_registryAlias);
		$query = $table->find()->select(['sort'])->max('sort');
		if (empty($query->sort) == false) {
			$this->sort = intval($query->sort) + 1;	//sortの最大値+1
		} else {
			$this->sort = 1;	//最初のレコードの場合は1
		}
	}
}
```

Categoriesにsortというフィールドが有るとする。

全レコードからsortフィールドの最大値を求めて新しいレコード作成時に+1をセットしたいという事。

コントローラは以下の通り

Controller/CategoriesController.php

```php
	$categories = TableRegistry::get('Categories');
	$entity = $categories->newEntity();
	$entity = $categories->patchEntity($entity,$this->request->getData());
	$entity->setNextSort();
	$categories->save($entity);
```

(エラー処理などは省略してある)

新レコード保存前に、sortフィールドの最大値+1が、これで保存される。

## 直接テーブル名を記述すれば？

```php
namespace App\Model\Entity;
use Cake\ORM\Entity;
use Cake\ORM\TableRegistry;

class Category extends Entity {
	public function setNextSort() {
		$table = TableRegistry::get('Categories');
		$query = $table->find()->select(['sort'])->max('sort');
		if (empty($query->sort) == false) {
			$this->sort = intval($query->sort) + 1;	//sortの最大値+1
		} else {
			$this->sort = 1;	//最初のレコードの場合は1
		}
	}
}
```

最初から 'Categories' って分かっていれば直接記述しても当然同じこと。

詳しくは別記事で書きますが、今回はこのsetNextSort()を共通関数として記述したかったため、このようにテーブル名を得る必要がありました。

# Entity のサブクラスを中間に挟む

Model/Entity/SEntity.php

```php
class SEntity extends Entity {
}
```

Model/Entity/Category.php

```php
class Category extends SEntity {
}
```

こんな感じで、EntityクラスとCategoryクラスの間にSEntityクラスを挟むとします。

setNextSort() は、SEntityクラスに記述します。

これで、Category.php からsetNextSort()は使用できますし、他のクラスからも利用可能になります。

このあたりの記述は別記事で。 [CakePHP3 Model/Entityのサブクラスを間に挟む](7)

CONTENTS