CakePHP 2.3 コマンドラインからPHPのシェル実行の方法解説
2017/04/29
CakePHPのプログラムをコマンドラインから実行する方法
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が実行できるかどうかを試すには下記のコマンドを実行してみるといいでしょう。
|
1 |
php -v |
このコマンドは、PHPのバージョンを表示させる際に実行するものですが、下記の様に PHPのバージョンが表示されれば PHPのパスは通っていることが確認できます。
|
1 2 3 4 |
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 |
PHPのパスが通っていない場合は、PHPのパスを通す設定を検索していただいて、設定してください。
CakePHPの 2.*系のシェルの基本的な作り方、使い方
ここから CakePHP 2.*においてシェルの作り方を説明していきます。
まず、標準出力するだけのサンプルを作ってみましょう。
/cake1/app/Console/Command/TestShell.php
——————–
|
1 2 3 4 5 6 7 8 9 10 |
<?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でも記述方法は同じです。
|
1 |
php /{CakePHPがインストールされているパス}/app/console/cake.php test |
cake.phpファイルがあるディレクトリ（/{CakePHPがインストールされているパス}/app/console/）に移動した場合は、下記のコマンドでも実行できます。
|
1 |
php cake.php test |
一つ上位の親ディレクトリに移動した場合は、下記の様に相対パスの指定でも実行できます。（カレントディレクトリが /{CakePHPがインストールされているパス}/app/ にある場合）
|
1 |
php ./Console/cake.php test |
このパスの指定のイメージは、bakeを行う場合と同じです。
例えば、カレントディレクトリが「/{CakePHPがインストールされているパス}/app/console/」の場合は、下記の指定で 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）を指定します。
|
1 |
php ./Console/cake.php test test2 |
CakePHPの 2.*系のシェルの作り方、使い方 その２
複数の単語を組み合わせたファイル名を付けた場合はどのようになるのか、の実験もしてみました。
/cake1/app/Console/Command/TestFileShell.php
——————–
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 |
<?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でした。
|
1 2 3 |
php cake.php test_file php cake.php testfile php cake.php TestFile |
また、関数を指定する場合は、下記の場合は、正しく関数「test_test」が呼び出されました。
|
1 2 3 |
php cake.php test_file test_test php cake.php testfile test_test php cake.php TestFile test_test |
ですが、下記のような記述方法では正しく関数「test_test」は呼び出されず「main」が呼び出されました。
|
1 2 3 4 5 6 |
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
GoogleAdwords
GoogleAdwords
この記事が参考になったと思いましたらソーシャルメディアで共有していただけると嬉しいです！
関連記事
-
-
MySQL、CakePHP 2.3で「tinyint(1)」の Boolean型の動作を再確認
MySQL＋CakePHPの環境で「tinyint(1)」を利用する際の動作を検証。「tinyint(1)」の Boolean型について CakePHPでは自動処理が実施されていることを確認しました。
-
-
CakePHP4系、CakePHP5系のexists()でカラムを指定して値の有無をチェックする方法解説
CakePHP4、5で指定したカラムに特定の値に該当のレコードの有無をチェックするにはexists()を使う。単純にカラムを指定する方法から複数条件をand、orで探すこともできる。
-
-
CakePHP3で画像・ファイルのアップロード処理を自作・解説付き・その２
ファイルのアップロード機能の自作サンプルコードとその解説のその２。アップロード機能に関連するファイルの更新や削除の処理や画像、フォルダのパスの指定方法などを含めて解説。
-
-
CakePHP3で静的ページの作成は webrootか pagesを使う。トップページを参考に解説
CakePHP3で静的なページを設置する場合の方法（webrootとpagesとを活用する方法）を解説。pagesの解説はデフォルトのトップページがどう表示されているかを参考に解説。ルーティングの機能も。
-
-
CakePHP2の検索Plugin CakeDC/Searchで重複を省くgroup by（distinct）の実装方法
CakePHP2の検索プラグイン「CakeDC/Search」で、重複レコードを省くgroup by、distinctを使う方法についての解説。設定する場所はpaginatorの条件とするので、find()関数と同じ。
-
-
CakePHP3のビューで受取ったテーブルのオブジェクトを連想配列に変換する方法
コントローラーからビューに送ったテーブルのオブジェクトを連想配列に変換し、ビューの中で自由に使えるようにするメソッド「toArray()」の解説。連想配列に変換できれば利用度アップ！
-
-
CakePHP3のプラグイン「CakeDC/Users」を日本語化・翻訳ファイルもダウンロード可
CakePHP3のユーザ管理、ログイン認証プラグインである「CakeDC/Users」のメッセージを日本語にする手順の解説とともに、日本語の翻訳ファイルを提供。ファイルを設置すれば日本語になる！
-
-
VirtualBoxにCakePHP3を設置。必要なCentOS、Apache、PHP、MySQL、Composerをインストールし設定する
VirtualBoxにCentOS、Apache、MySQL、PHPをインストールするところから初めてCakePHP3の開発環境を構築する手順を詳細解説。この記事1つで全ての設定が完了する。
-
-
CakePHP4、5の認証処理で認証が通らない際の確認方法と確認箇所の紹介
CakePHP4、5系の認証処理でログイン認証が通らない場合の確認方法、確認箇所を解説。ログ出力し、ステータスを確認するが、ステータスの内容も紹介。それはそのままusernameを変更する際のポイントでもある。
-
-
CakePHP3、CakePHP4、CakePHP5のバージョンを指定してインストールする詳細な手順を解説
CakePHP3のバージョンを指定してインストールする方法を詳細解説。CakePHP3のインストールはComposerを使うため設定もほぼ自動で完了。データベースの接続情報を記載すればアプリ開発のベースが整う。
