このブログは、爺による「備忘録」です。
言葉の使い方をはじめ、間違っていることも多々あるかもしれません。
あくまでも「備忘録」ですので、これのブログを見て「怒っちゃやーよ！」

いつもの如く、まずはチョイいじりから。

公式：Bake の拡張

プラグイン内に拡張 Bake コマンドを配置したい場合は

を配置。

Task.php の template メソッド内の文字列を任意に指定。

/**
 * {@inheritDoc}
 */
public function template()
{
    return 'View/my_cell';
}

コントローラを伴ったエレメント。

公式：ビューセル

コントローラと同じ感覚でいればよいみたい。

bin/cake bake cell --plugin MyVendor/MyPlugin --theme MyVendor/MyPlugin hoge_moge

Creating file /myApp/plugins/MyVendor/MyPlugin/src/Template/Cell/HogeMoge/display.ctp
Wrote `/myApp/plugins/MyVendor/MyPlugin/src/Template/Cell/HogeMoge/display.ctp`

Creating file /myApp/plugins/MyVendor/MyPlugin/src/View/Cell/HogeMogeCell.php
Wrote `/myApp/plugins/MyVendor/MyPlugin/src/View/Cell/HogeMogeCell.php`

Baking test case for MyVendor/MyPlugin\View\Cell\HogeMogeCell ...

Creating file /myApp/plugins/MyVendor/MyPlugin/tests/TestCase/View/Cell/HogeMogeCellTest.php
Wrote `/myApp/plugins/MyVendor/MyPlugin/tests/TestCase/View/Cell/HogeMogeCellTest.php`

namespace MyVendor\MyPlugin\View\Cell;

use Cake\View\Cell;

/**
 * PullDown cell
 */
class PullDownCell extends Cell
{

    /**
     * List of valid options that can be passed into this
     * cell's constructor.
     *
     * @var array
     */
    protected $_validCellOptions = [];

    /**
     * Default display method.
     *
     * @return void
     */
    public function display()
    {
    }
}

公式：ビューセル　セルのオプション
らしいけど。。。下記公式の例を見ても、どこで利用しているのか分からず
利用方法がわからない。

namespace App\View\Cell;

use Cake\View\Cell;
use Cake\Datasource\Paginator;

class FavoritesCell extends Cell
{
    protected $_validCellOptions = ['limit'];

    protected $limit = 3;

    public function display($userId)
    {
        $this->loadModel('Users');
        $result = $this->Users->find('friends', ['for' => $userId]);
        $this->set('favorites', $result);
    }
}

// テンプレート側
$cell = $this->cell('Favorites', [$user->id], ['limit' => 10])

と思ったら、素敵な記事を発見！
Qiita：CakePHP3新機能 Cellメソッドの引数について（2016-12-21）

// テンプレート側
echo $this->cell('Hoge', [], ['xxx' => 1, 'yyy' => 2])->render();

// Cell 側
class HogeCell extends Cell
{
     protected $_validCellOptions = ['xxx'];

     public function display()
     {
         echo $this->xxx;
         echo $this->yyy;
     }
}

$_validCellOptions にて定義されたものだけを第3引数で受け取れ、
$this->xxx の形で呼び出せる。

でもいまいち用途がわからない。

公式：Class Cell　$_validCellOptions
こんな記述も発見したけど、よくわからない。。。

デフォルトが display アクションらしい。
だから、自動生成されるテンプレートファイルも display.ctp。

新たにアクションを追加できる。

// テンプレート側
echo $this->cell('Hoge::displayHoge')->render();

// Cell 側
class HogeCell extends Cell
{
     protected $_validCellOptions = ['xxx'];

     public function displayHoge()
     {
     }
}

displayHoge を追加した場合、display_hoge.ctp を用意してやれば
自動的に利用される。

コントローラと同じでメソッド（アクション）名と同名の .ctp ファイルが自動で利用される。

公式：ビューセル　別のテンプレートの描画

// テンプレートで指定
$cell->viewBuilder()->setTemplate('messages');

// セルアクションで指定
$this->viewBuilder()->setTemplate('messages');

プラグイン記法は上手くいかなかった。

隣のプラグインのセルを利用したら
テンプレートがないと怒られた。

プラグインA からプラグインB のセルを呼び出したら
A に display.ctp がないぞ！
と怒られた。

B のセルなんだから、B のテンプレートを読んでくれると思っていたのに。。。

しばらく時間が経ったら怒られなくなり、
ちゃんと B のテンプレートを読んでくれた。

キャッシュの問題かしらね。

保存前にゴニョゴニョしたい場合は
Table クラスに save メソッドを追加して
そこに処理を記述する。

/**
 * Save method
 *
 * @see \Cake\ORM\Table
 */
public function save(EntityInterface $entity, $options = [])
{
    $entity->total = $entity->kokugo + $entity->sansu;

    return parent::save($entity);
}

公式：アソシエーション – モデル同士を繋ぐ

各 Table クラスの initialize 内。

public function initialize(array $config)
{
    $this->hasOne('Addresses')
        ->setName('Addresses')
        ->setConditions(['Addresses.primary' => '1'])
        ->setDependent(true);
}

上記4メソッドとも、最終的には下記 Association オブジェクトのコンストラクタが呼ばれる。

public function __construct($alias, array $options = [])

第1引数：エイリアス名。contain オプションに指定する名称
第2引数：オプション

公式：セッション

公式：セッション　セッションオブジェクトへのアクセス
こちらに下記リストが書いてあるけど、これで使いたい場所は全部カバーされているのかしらね。

• Controllers
• Views
• Helpers
• Cells
• Components

$this->Session = $this->request->getSession(); // CakePHP 3.5~
$this->Session = $this->request->session();    // CakePHP ~3.4

• read
• 読み込み
• write
• 書き込み
• delete
• 削除
• check
• 存在チェック
• destroy
• ログアウト処理などで利用する破棄
• renew
• セッション ID を手動で切り替え

入れ子にすることが可能。

$session->write([
  'Config.theme' => 'blue',
  'Config.language' => 'en',
]);

CakePHP3 Tips：CakePHP3 セッション(session)使い方（2018-03-22）

公式：キャッシュ

public function cache($key, $config = 'default')

↓ が呼ばれる。

public function cache($key, $config = 'default')

公式：クエリービルダー　ロードされた結果をキャッシュする

$query->cache('recent_articles');

// 文字列で Config 名
$query->cache('recent_articles', 'dbResults');

// CacheEngine のインスタンス
$query->cache('recent_articles', $memcache);

// クエリーの where 句の単純なチェックサムに基づくキーを生成します
$query->cache(function ($q) {
    return 'articles-' . md5(serialize($q->clause('where')));
});

つまり、find や get をする際に cache 設定をしておけば
次回からはキャッシュが存在すれば、そちらから取得してくれる
と理解してみた。。。

公式：データの取り出しと結果セット　主キーで単一のエンティティーを取得する

// オプション指定
$article = $articles->get($id, [
    'cache' => 'custom',
]);

あちこち見た感じでは、チェーン指定も可能な気がしたけど
気のせいだった。。。

// チェーン指定
$article = $articles->get($id)
->cache('custom');

公式：キャッシュ

public function cache($since, $time = '+1 day')

非推奨。

public function cache(callable $block, array $options = [])

クエリキャッシュ

公式：データの保存

public function patchEntity(EntityInterface $entity, array $data, array $options = [])

public function patchEntities($entities, array $data, array $options = [])

公式：データの保存

• newEntity：挿入 時
• patchEntity：更新 時

のような使い分けがあるみたいだけど
いまだピンと来ず。

Controller にもあるように
Bake コマンドによる Controller 生成時に自動生成される add メソッド内で
newEntity() 後に patchEntity() をしているから。

ん～、どう理解したら良いのかしらね～。

公式：データの検証

1. バリデーションルール
• リクエストデータがエンティティーにコンバートされる前、 データ型や書式まわりのバリデーションルールが適用されます。
2. アプリケーションルール（ドメインルール）
• データが保存される前、ドメインまたはアプリケーションルールが適用されます。 これらのルールはアプリケーションのデータの一貫性の保証に役立ちます。

Qiita：CakePHP3のバリデーションは2度動く！（2015-12-11）
→バリデーションルールとアプリケーションルールの違いがわかりやすかった