CakePHP 2.3 コマンドラインからPHPのシェル実行の方法解説

2014/05/01 2017/04/29

CakePHPのプログラムをコマンドラインから実行する方法

　
CakePHPで Webシステムを作っている中で、cronなどで定期的に自動処理を実行したいと思う場面も出てくるでしょう。
　
CakePHPには、そんな時も CakePHPの処理を使ってコマンドラインから実行する方法が用意されています。
ここでは、その説明を行います。
　
　

CakePHPの 1.系と 2.系のシェルの作り方は全く違う

　
CakePHPの処理をコマンドラインから実行する際は、シェルという処理を使って作成をしますが、その作成の方法が CakePHPの 1.*系と、2.*系とで違っています。
　
ここでは CakePHP 2.*系の説明しかしませんが、1.*系の作成方法について知りたい方は、下記のサイトなどが参考になると思います。ファイルを置く場所も変っていますね。
　
　CakePHP 1.*系のシェルについて
　http://ucwd.jp/blog/570
　
　

コマンドラインから PHPを実行できるかの確認

　
CakePHP 2.*系のシェルの作成をする前に、1点確認です。
　
ここでコマンドラインから実行するコマンドは PHPのパスが通っていることを想定して書いています。
コマンドラインから PHPが実行できるかどうかを試すには下記のコマンドを実行してみるといいでしょう。
　

php -v

php -v

　
このコマンドは、PHPのバージョンを表示させる際に実行するものですが、下記の様に PHPのバージョンが表示されれば PHPのパスは通っていることが確認できます。
　

C:\Users\user1>php -v
PHP 5.4.7 (cli) (built: Sep 12 2012 23:48:31)
Copyright (c) 1997-2012 The PHP Group
Zend Engine v2.4.0, Copyright (c) 1998-2012 Zend Technologies

C:\Users\user1>php -v

PHP 5.4.7 (cli) (built: Sep 12 2012 23:48:31)

　
　
PHPのパスが通っていない場合は、PHPのパスを通す設定を検索していただいて、設定してください。　
　

CakePHPの 2.*系のシェルの基本的な作り方、使い方

　
ここから CakePHP 2.*においてシェルの作り方を説明していきます。
　
まず、標準出力するだけのサンプルを作ってみましょう。
　
/cake1/app/Console/Command/TestShell.php
——————–

<?php 
class TestShell extends Shell { 
  function main () { 
    $this->out('test.'); // 標準出力には $this->out() を利用。 
  } 

  function test2 () { 
    $this->out('test2.'); // 標準出力には $this->out() を利用。 
  } 
}

<?php

class TestShell extends Shell {

function main () {

$this->out('test.'); // 標準出力には $this->out() を利用。

}

function test2 () {

$this->out('test2.'); // 標準出力には $this->out() を利用。

}

——————–
　
ソース内にもコメントとして書いていますが「$this->out()」を利用して標準出力を行います。（コマンドを入力したコンソールに出力を返す処理です。）
　
そして、上記のサンプルで作成した CakePHPの shellをコマンドラインから実行する方法は、以下の通りとなります。
この実験は、Windowsの XAMPP環境で実行していますが、Linuxでも記述方法は同じです。
　

php /{CakePHPがインストールされているパス}/app/console/cake.php test

1	php /{CakePHPがインストールされているパス}/app/console/cake.php test

　
cake.phpファイルがあるディレクトリ（/{CakePHPがインストールされているパス}/app/console/）に移動した場合は、下記のコマンドでも実行できます。
　

php cake.php test

1	php cake.php test

　
一つ上位の親ディレクトリに移動した場合は、下記の様に相対パスの指定でも実行できます。（カレントディレクトリが　/{CakePHPがインストールされているパス}/app/　にある場合）
　

php ./Console/cake.php test

1	php ./Console/cake.php test

　
このパスの指定のイメージは、bakeを行う場合と同じです。
例えば、カレントディレクトリが「/{CakePHPがインストールされているパス}/app/console/」の場合は、下記の指定で bakeを起動できることと同じです。

php ./cake.php bake

1	php ./cake.php bake

　
　
また、ここで cake.phpの引数として設定している「test」は、「/app/Console/Command/」フォルダの中にある「TestShell.php」を呼び出して実行することを指定していることになります。
　
ファイル名が「SampleShell.php」の場合は、「php cake.php sample」になります。
　
また、サンプルソースの中には、「function main ()」と「function test2 ()」とありますが、引数に何も指定しない場合は、「function main ()」の方がデフォルトとして実行されます。
ブラウザでアクセスして画面を表示させる際に引数がない場合は「function index ()」が呼び出されるのと同じイメージで、コマンドから実行する場合はデフォルトで「function main ()」が呼び出されると覚えておきましょう。
　
では、「function test2 ()」の方を実行する場合は、というと下記の様に「test」に続けて関数名（test2）を指定します。
　

php ./Console/cake.php test test2

1	php ./Console/cake.php test test2

CakePHP2 実践入門 (WEB+DB PRESS plus)

CakePHPの 2.*系のシェルの作り方、使い方　その２

　
複数の単語を組み合わせたファイル名を付けた場合はどのようになるのか、の実験もしてみました。　
　
/cake1/app/Console/Command/TestFileShell.php
——————–

<?php 
class TestFileShell extends Shell { 
  function main () { 
    $this->out('testfile.'); // 標準出力には $this->out() を利用。 
  } 

  function test2 () { 
    $this->out('testfile2.'); // 標準出力には $this->out() を利用。 
  } 

  function test_test () { 
    $this->out('testfile_test.'); // 標準出力には $this->out() を利用。 
  } 
}

<?php

class TestFileShell extends Shell {

function main () {

$this->out('testfile.'); // 標準出力には $this->out() を利用。

}

function test2 () {

$this->out('testfile2.'); // 標準出力には $this->out() を利用。

}

function test_test () {

$this->out('testfile_test.'); // 標準出力には $this->out() を利用。

}

——————–
　
上記のプログラムを実行する場合、下記のいずれも OKでした。

php cake.php test_file
php cake.php testfile
php cake.php TestFile

php cake.php test_file

php cake.php testfile

php cake.php TestFile

　
また、関数を指定する場合は、下記の場合は、正しく関数「test_test」が呼び出されました。

php cake.php test_file test_test
php cake.php testfile test_test
php cake.php TestFile test_test

php cake.php test_file test_test

php cake.php testfile test_test

php cake.php TestFile test_test

　
ですが、下記のような記述方法では正しく関数「test_test」は呼び出されず「main」が呼び出されました。

php cake.php test_file testtest
php cake.php test_file TestTest
php cake.php testfile testtest
php cake.php testfile TestTest
php cake.php TestFile testtest
php cake.php TestFile TestTest

php cake.php test_file testtest

php cake.php test_file TestTest

php cake.php testfile testtest

php cake.php testfile TestTest

php cake.php TestFile testtest

php cake.php TestFile TestTest

　
当たり前と言えば当たり前ですが、関数名を「TestTest」とした場合は、「testtest」「TestTest」を引数にすると呼び出すことができ「test_test」とした場合は呼び出すことはできません。
CakePHPの命名規則上は、「test_test」が正しいのだと思いますが．．．
　
また、引数として指定した関数が存在しない場合は「main」が呼び出されるようです。
　
　

CakePHPの 2.*系のシェルに引数を渡す方法

　
CakePHPのシェルに引数（パラメータ、オプション）を渡す方法も 2.*系なって変更になっています。
　
こちらに関しては、また改めて実験をしてから記事にしたいと思いますが、下記の記事などが参考になるのではないでしょうか。
　http://karasunouta.com/blog/2012/10/07/cakephp2-shell-params/
　http://lab.adn-mobasia.net/?p=1014

- CakePHP 3.x 4.x 5.x

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

Message コメントをキャンセル

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

: CakePHP3の更新画面でUpload Plugin 3.0を使う方法、viewで使う方法解説・その３

CakePHP3でファイル、画像をアップロードするプラグイン、upload plugin 3を導入する手順を解説した記事。3部作のその3で記事を更新する際のファイルの取り回しなどについてを解説。

: CakePHP4、5のユーザ認証でID、PASS以外の削除フラグなども条件加える方法

CakePHP4系、5系ではAuthenticationを使用してログイン認証を行う。その認証でID、PASS以外の削除フラグなどの条件を加えたいときの対応方法について解説。

: CakePHP4、CakePHP5の「warning: DebugKit is disabling．．．」の対処方法

CakePHPのデバッグ用のツールであるDebugKitは適切な設定をしないとエラーログにワーニングメッセージが出力される。それを解消する方法を解説。

: CakePHP4、5のnewEmptyEntityで作成したオブジェクトは空なのか、確認してみた

CakePHPでレコードを新規登録をする際にnewEmptyEntity()を使って空のEntityを作成するが、これのempty、is_nullなどのでの判定結果がtrueかfalseか確認してみた。

: CakePHP4で「app_local.php」「.env」を利用して環境ごとの定数を振り分ける方法

CakePHP4で.env、app_local.phpに定数を定義してそれを呼び出す方法の解説。Gitでは管理せず本番環境と開発環境とで異なる定数を定義するためそれを利用する方法。

: CakePHP3のCakeDC/Usersでログインユーザの所有レコードのみ更新、削除する権限管理の設定方法

CakePHP3のユーザ管理、ログイン認証プラグイン「CakeDC/Users」の権限管理を行う方法やアクセスできるコントローラー、アクションを設定、所有権を持つレコードのみ更新できる設定方法を解説。

: CakePHP3でファイルのアップロード処理を自作・解説付き・その１

CakePHP3でファイルをアップロードする処理を、php.netにある「エラーを起こさない」と説明がある処理を参考に作成。サンプルソースとその解説付きで、コピペでも動くし、カスタマイズも簡単！

: CakePHP3、CakePHP4、CakePHP5のバージョンを指定してインストールする詳細な手順を解説

CakePHP3のバージョンを指定してインストールする方法を詳細解説。CakePHP3のインストールはComposerを使うため設定もほぼ自動で完了。データベースの接続情報を記載すればアプリ開発のベースが整う。

: CakePHP4のCSS、JavaScript、画像のブラウザへのキャッシュをコントロールする

CakePHP4、CakePHP3でブラウザにキャッシュさせる設定の解説。CSS、JavaScript、画像をブラウザにキャッシュさせるのか、定期的にリロードする設定にするのかの設定が可能。