Cakephp3で共通のコードをコンポーネント化？まとめたいです。

Question

こんにちは、学年度によってデータを表示するページを作っています。
セレクトボックスに年度を表示し、それを選択してボタンを押すとセッションに年度価を書き込んで、その値に基づいてデータを表示するという形です。
現在は実装でき、問題なく動いてはいます。

やりたいのは、複数のページに全く同じコードが入っているので、それを何とかの形でまとめたいと思います。共通の部分が複数のコントローラーとビューにあるので修正も大変ですし、無駄という気がします。
ビューは、/template/Element/OOO.ctpという風に作り、<?= $this->element('OOO'); ?>でビューに表示させればいい、ということは分かりました。
しかし、コントローラー内の共通コードはどうすればいいしょうか？あと、共通化したコントローラー（？）とビューはどんな感じで繋げばいいですか？年度更新ボタンを押すとコントローラー名とアクション名を書かないといけませんが、よく分かりません。

方法がありましたら教えてください。
宜しくお願い致します。

以下は現在のコード一部です。

//class ArticlesController extends AppController　
//このソースコードが約15ページに重複されていますので、１つにしたいです。

public function index()
    {
        // 学年度を表示するための年度調整,　ここから共通化したいです。
        $startDay = '04-01';
        $todayDate = new DateTime();
        $theDate = new DateTime($todayDate->format('Y-m-d'));
        $diff = (new DateTime($theDate->format('Y') . '-' . $startDay))->diff($theDate);
        if ( $diff->invert ) 
        {
            $curYear = intval($theDate->format('Y')) - 1;
        }
        else
        {
            $curYear = intval($theDate->format('Y'));
        }
        //　次年度を表示するための値
        $nexYear = $curYear + 1;

        // セッションに値がなかったら今年を入れる
        if($this->Session->check('Year.year'))
        {
          $year = $this->Session->read('Year.year');
        }
        else
        {
          $this->Session->write('Year.year',$curYear);
          $year = $this->Session->read('Year.year');
        }

        if($this->request->is('post'))
        {
          //  POSTで投げられた学年度をセッションに入れることで学年度更新を行う。
          $year = $this->request->data['year'];
          $this->Session->write('Year.year',$year);
          $this->Flash->success(__('学年度が変更されました。'));
        }

        $this->set('curYear', $curYear);
        $this->set('nexYear', $nexYear);　　//ここまで共通化できますかね？

        //  ビューに表示するためのデータセット生成
        $subject = $this->Subject->find();

        $subject = $this->paginate($subject);

        $this->set(compact('subject'));
        $this->set('_serialize', ['subject']);
    }

    <!--他のコードは省略-->
    <!--年度選択リストの表示-->
    <div class="row">
      <div class="col-md-6" align="left">
        <?= $this->Form->create() ?>
        <?php
          $setYear = $this->request->session()->read('Year.year');
          echo $this->Form->select('year',
          [
            $curYear => $curYear,
            $nexYear => $nexYear
          ],['default' => ($setYear==$curYear)?$curYear:$nexYear, 'class'=>'form-group', 'data-width'=>'150px']);
        ?>
      </div>
      <div class="col-md-6" align="left">
        <?= $this->Form->button('学年度更新', ['type'=>'submit','controller' => '', 'action' => 'index', 'class' => 'btn btn-primary btn-sm']); ?>
      </div>
      <?= $this->Form->end() ?>
    </div>
    <!--他のコードは省略-->

Answer 1

CakePHP のバージョンが書かれてないのですが、3.x 系でとりあえず回答しておきます。

クックブックにあるように、
コントローラー内のコードの共通化には、Contorollers\Component\ の下にコンポーネントを作り、
使いたいコントローラーの initialize の中でloadComponentしてやればよいです。

Controllers\Component\CommonComponent.php

namespace App\Controller\Component;
use Cake\Controller\Component;

class CommonComponent extends Component {
  public function getCurYearData() {
    // ここに共通化したコードを書く
  }
}

Controllers\SampleController.php

class SampleController extends AppController {
  public function initialize() {
    parent::initialize();
    $this->loadComponent('Common');
  }

  public function index() {
    $curData = $this->Common->getCurYearData();
    ...
}

すべてのコントローラーで共通で読み込んでよいなら、AppController の initialize で読み込ませてもよいです。

Comments

[lovelydai]

ありがとうございました！役に立ちました。