更新日: 2016年1月28日
PHP & CakePHP

CakePHPでシェル/コマンドラインからタスク実行

CakePHP 3でシェル(コマンドライン)により実行するタスクを作成する方法です。Ruby/Rails でいう Rake タスクのようなものを作りたかった。src/Shell/***Shell.php というファイルを作成して処理を実装する。

— 環境 —
PHP 5.5.19
CakePHP 3.1.1

【お知らせ】英単語を画像イメージで楽に暗記できる辞書サイトを作りました。英語学習中の方は、ぜひご利用ください！

画像付き英語辞書 Imagict | 英単語をイメージで暗記
【開発記録】
英単語を画像イメージで暗記できる英語辞書サービスを作って公開しました

HelloShell タスクの例

以下 Hello World 的な例。

src/Shell/HelloShell.php

<?php
namespace App\Shell;

use Cake\Console\Shell;

class HelloShell extends Shell
{
    public function main()
    {
        $this->out('Hello, World');
    }

    public function hiThere($name = 'Anonymous')
    {
        $this->out('Hi there, ' . $name);
    }
}

<?php

namespace App\Shell;

use Cake\Console\Shell;

class HelloShell extends Shell

{

public function main()

{

$this->out('Hello, World');

}

public function hiThere($name = 'Anonymous')

{

$this->out('Hi there, ' . $name);

}

実装したメソッドを bin/cake コマンドで呼び出すことができます。

デフォルトでは main() アクションが呼ばれる。


$ bin/cake hello
Hello, World

$ bin/cake hello

Hello, World

hiThere() を呼び出す。


$ bin/cake hello hiThere
Hi there, Anonymous

$ bin/cake hello hiThere

Hi there, Anonymous

hiThere() に引数を渡して呼び出す。


$ bin/cake hello hiThere CakePHP
Hi there, CakePHP

$ bin/cake hello hiThere CakePHP

Hi there, CakePHP

シェル中でモデルを使う

モデルを利用するには、initialize() で $this->loadModel() を使ってモデルをロードします。以下は登録ユーザーのEメールを出力するシェルのタスク。

<?php
namespace App\Shell;

use Cake\Console\Shell;

class HelloShell extends Shell
{
    public function initialize()
    {
        parent::initialize();
        $this->loadModel('Users');
    }

    public function showUserEmails() {
        $query = $this->Users->find();
        foreach ($query as $user) {
            var_dump($user->email);
        }
    }

    // ...

<?php

namespace App\Shell;

use Cake\Console\Shell;

class HelloShell extends Shell

{

public function initialize()

{

parent::initialize();

$this->loadModel('Users');

}

public function showUserEmails() {

$query = $this->Users->find();

foreach ($query as $user) {

var_dump($user->email);

}

// ...


$ bin/cake hello showUserEmails
string(17) "admin@example.com"
string(18) "normal@example.com"

$ bin/cake hello showUserEmails

string(17) "admin@example.com"

string(18) "normal@example.com"

上記の出力のように、Eメール一覧を表示できました。CakePHP 3のシェルタスクは、作成が簡単でなかなか良い感じです。

– 参考リンク –
Shells, Tasks & Console Tools – CakePHP Cookbook 3.x documentation

私は Ruby on Rails の前は、PHP & CakePHP を使っていました（今も使いますけど）。PHP についてはオライリーの本を中心に軽く10冊以上は読み込みました。

CakePHP3 ビギナーズガイド: 最新のPHPフレームワークをマスターせよ！ PRIMERシリーズ (libroブックス)

プログラミングPHP 第3版

>> 次の記事 : CakePHPでカラム追加のマイグレーション

<< 前の記事 : CakePHPのbakeコマンドでディレクトリにコントローラー・ビューを生成

CakePHPでシェル/コマンドラインからタスク実行

HelloShell タスクの例

シェル中でモデルを使う

Leave Your Message! コメントをキャンセル