LANCARD.LAB｜ランカードコムのスタッフブログ

シェル書いてる時とか Web でも Ajax のときとか

「画面にクエリだされても見えないし、困る〜」

ってときありますよね？

「つーか、なんで画面にだすんだ？ログファイルに出してくれればいいのに 」

とか思いません？

で、調べたらみなさんDBのドライバを拡張して対応されてるようです。
ですが、常にクエリをログに書いて欲しいわけでもないし、ドライバ拡張とか面倒。

クエリを画面にだしてるとこどうなってるのかなぁ、と思って調べたら

cake/libs/view/elements/sql_dump.ctp

にゴリゴリに書いてありました。

これマネしてapp_model.phpにでもメソッド作ればいいんじゃないかなーってことで、作りました。

    /**
     * 通常画面に表示されるログを取得してdebug.logに出力する。
     */
    function sqlToLog(){
        $db =& $this->getDataSource();
        if ($db->isInterfaceSupported('getLog')){
            $this->log($db->getLog(), LOG_DEBUG);
        }
    }

元のログ表示と違って明示的に呼び出すものなのでgetLogインターフェースの確認とか要らない気がしますが、一応。

このメソッドを実行すると debug.log にそれまでに実行されたクエリやら付帯情報(画面に表示されてますよね)が書き出されます。注意点として、画面に出すデータを横取りしているのでログに書き出されたものは画面には表示されません。

配列を print_r で出力した形式なので見やすくはないですが、まぁ、十分かな。

CakePHP にはデバッグで便利な pr() って関数があります。
出力の前後に pre タグ を付けてくれる print_r() のラッパーです。当然Web用。

シェルにも欲しいです。てなわけで作りました。

    function pr($obj){
        $pr = print_r($obj, true);
        $this->out($pr);
    }

簡単。こんな感じで使います。

    $popopopooon = array('こんにちわ' => 'こんにちワン', 'ありがとう' => 'ありがとウサギ');
    $this->pr($popopopooon);

このようにコンソールに出力されます。

 Array
(
    [こんにちわ] => こんにちワン
    [ありがとう] => ありがとウサギ
)

print_r() は第２引数に true を渡すと出力せずに結果を返してくれるのでオブジェクト構造をログに出したりするときにも便利です。
 
でもコレ、全部のシェルに書きたくない。

どこに集約したらいいのか悩んだのですが、実際に実行するシェルの親クラスを作成して継承することにしました。継承の段数が増えるのはあまりすきじゃないのですが、Shellクラス をそのまま継承するよりも１段増やしといたほうがいいかな？って気もしたので。

appbase.php

class AppbaseShell extends Shell {

    function initialize() {
        parent::initialize();
    }

    function startup() {
        //ウェルカムメッセージを消すためにオーバーライド
    }

    /**
     * デバッグ用
     */
    protected function pr($obj){
        $pr = print_r($obj, true);
        $this->out($pr);
    }
}

ついでに startup() をオーバライドしてウェルカムメッセージを消しました。
こういう事やるには１段あいだに入ってるほうがいいですね。

実際に起動するシェルは AppbaseShellクラス を継承します。

aisatu.php

App::import('Shell', 'Appbase');
class AisatuShell extends AppbaseShell {
    function initialize() {
        parent::initialize();
    }

    function main() {
        $popopopooon = array('こんにちわ' => 'こんにちワン', 'ありがとう' => 'ありがとウサギ');
        $this->pr($popopopooon);
    }
}

サンプルコードは今テキトーに書いたのでちょっとあやしいかも。

最後にオチを。

このprメソッド、実際に作ったんですが普通に print_r() すればコンソールに出力されるんですよねー。「そりゃそうだ」と後で気づいたわけで。

CakePHP のシェルでは $this->out() でコンソールへの出力をすることになってますが、開発中にしか使わないし print_r() をそのまま使えばいいかなと。親クラスは機能の集約に役立ってます。