CakePHP 2.3 Model、Controllerの見たい変数の中身をログ出力

2014/11/14 2014/11/14

CakePHPで Model、Controllerの変数をログに出力

変数の情報をログに出力する方法

　
CakePHPのプログラムを組んでいるとき、Modelの中の変数がどうなっているのかを見たいなぁ、思うことがあると思いますが、その方法を確認しましたので、メモをしておきます。
　
　
CakePHPの Search Pluginの使い方を探しているときに下記のサイトを見つけました。
http://kamakurasoft.net/blog/?p=1479
　
ここに、Modelの中の変数をログとして出力する方法が書かれていましたので、参考にさせていただきました。
　
　
例を挙げます。
今回の例は、「CakePHP 2.3　Search Pluginで検索処理　その５入力項目に複数項目入力した場合の AND検索、OR検索」で作成をしました IDを IN句による検索をする場合の処理をベースに作成しました。
この処理の際に function内の変数を見る場合などは下記の様に「$this->log( $data );」「$this->log( $query );」を設定します。
　
そうすることで、「/app/tmp/logs/error.log」にエラーメッセージとともにログが出力されます。
　
————–（/app/Model/User.php）

<?php
class User extends AppModel {
    :
    :
  // 検索対象のフィルタ設定
  public $filterArgs = array(
    array('name' => 'id',       'type' => 'subquery', 'method' => 'searchIn', 'field' => 'User.id'),
    array('name' => 'username', 'type' => 'like',  'field' => 'User.username'),
    array('name' => 'nickname', 'type' => 'like',  'field' => 'Profile.nickname'),
  );


  function searchIn($data = array()) {

$this->log( $data );

    $data['id'] .= ',20';
    $query = mb_ereg_replace ( '[^0-9]', ',', $data['id'] );
    $query = mb_ereg_replace ( ',+', ',', $query );
    $query = mb_ereg_replace ( '^,', '', $query );
    $query = mb_ereg_replace ( ',$', '', $query );

$this->log( $query );

    return $query;
  }

    :
    :
}

<?php

class User extends AppModel {

// 検索対象のフィルタ設定

public $filterArgs = array(

array('name' => 'id', 'type' => 'subquery', 'method' => 'searchIn', 'field' => 'User.id'),

array('name' => 'username', 'type' => 'like', 'field' => 'User.username'),

array('name' => 'nickname', 'type' => 'like', 'field' => 'Profile.nickname'),

);

function searchIn($data = array()) {

$this->log( $data );

$data['id'] .= ',20';

$query = mb_ereg_replace ( '[^0-9]', ',', $data['id'] );

$query = mb_ereg_replace ( ',+', ',', $query );

$query = mb_ereg_replace ( '^,', '', $query );

$query = mb_ereg_replace ( ',$', '', $query );

$this->log( $query );

return $query;

}

————–
　
Modelの中は、そもそも変数をどのように処理しているのかが分からない場合が多く、マニュアル、もしくは、解説していただいているサイトがないとどうしようもない場合が多々あります。
それでも、こうやってログとして変数の中身を確認できることで変数の中身の理解が進み、より安心してプログラムが書けるようになると思います。
　
　
この「$this->log( $query );」の記述を controllerに置くこともできます。
それによって、Viewに表示させるのではなくログに出力させる方法で編集の確認をすることも可能になります。

- CakePHP 2.x　3.x

最後までお読みいただきましてありがとうございます。
この記事が参考になったと思いましたらソーシャルメディアで共有していただけると嬉しいです！

Message コメントをキャンセル

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

: CakePHP 2.3　Search Pluginで検索処理　その１設置方法

CakePHPの検索プラグイン Search Pluginの設置方法と基本的な検索処理の解説です。

: CakePHP 2.3　テーブルの項目を演算した結果を条件として抽出する方法

アソシエーション（連携）している先のテーブルの項目で演算をする場合の考え方と注意点をサンプルソースを用いて説明しています。分かってしまえば簡単です。

: CakePHP3でcomposerを利用してライブラリ・プラグインをインストールする方法

CakePHP3でcomposerを使ってパッケージ（ライブラリ、プラグイン）をインストールする方法の解説。PHPを使うのはCakePHP3が初めてというような方への使い方から解説。

: CakePHP3チュートリアルで日付と時刻のDateTimeでエラーが出たときの対処方法

CakePHP3のブックマークチュートリアルには記載ミスもあり、そのまま動かない個所もある。CakePHP3では namespaceを使うようになったので、classを呼び出すときに￥を追加する必要が！