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 コメントをキャンセル

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

: CakePHP 2.3で PDFを作成する方法を調査「mpdf」「TCPDF」「FPDF」

CakePHPで PDFを編集、出力するには「mpdf」「TCPDF」「FPDF」といったプラグインがあり、使い勝手を比較検討しました。TCPDFが一番良さそうでした。

: CakePHP3のForm Helperの使い方のまとめ

CakePHP3になりフォームヘルパーの使い方も大きく変わりましたので、使い方をまとめました。基本的な使い方からプラスアルファの便利な使い方まで紹介。

: URL短縮サービス「TTTオンライン（https://ttt.onl）」公開

URL短縮サービス「TTTオンライン（https://ttt.onl）」を公開。メールやSNSでは使いにくい長いURLを短いURLに変換するサービス。QRコードも。Google URL Shortenerが2019年3月にサービス終了。

: CakePHP 2.3で saveの便利な使い方・サンプルソース付き

CakePHPのレコードを保存、更新する際に使う Saveを詳細解説します。

: CakePHP3でシェルを作成しコマンドラインから実行・CakePHP2との違い

CakePHP3のシェルスクリプトを作成し、コマンドラインから実行する方法を解説。複数単語をつなげる場合の対応方法がCakePHP2より制限が厳しくなったのでCakePHP3の命名規則の確認が必要だ。

: CakePHPのpostlinkで生成した削除リンクをクリックしても処理が実行されない対処法

CakePHP環境にてpostLinkで生成した削除のリンクをクリックしても処理が実行されず、JavaScriptでUncaught TypeErrorが発生。原因は同一IDを複数記述していることだった。