CakePHP3にてシェルとタスクを利用してコマンドラインからデータベースのデータを操作する

開発環境は、Windows 10 Pro(64bit) + PHP 7.2.12 + CakePHP 3.6.14 + XAMPP Control Panel v3.2.2。

基本的な操作

以下のプログラムをHelloShell.phpの名前でsrc/Shellディレクトリ内に保存する。

<?php

namespace App\Shell;

use Cake\Console\Shell;

class HelloShell extends Shell
{
    public function main()
    {
        $this->out(__('Hello world.'));
    }
}

?>

コマンドラインのカレントディレクトリをアプリのルートディレクトリにしてから、

bin\cake hello

と入力すると、Hello world.と表示されます。
main()関数の中に処理を書いておくと、

bin\cake hello main

のように書かなくても、省略して実行できます。なので、main()関数以外の名前で、関数を使いたければ、例えば、hoge()と書いて、その中の処理を書いて、実行する際は、

bin\cake hello hoge

と入力すればOKです。

データベースへアクセスして操作してみる

1.テストのために以下のテーブルを作成します。

create table samples(
  id int auto_increment primary key,
  data varchar(255) not null,
  created datetime,
  modified datetime
)charset=utf8mb4;

2.カレントディレクトリをアプリのルートディレクトリにして以下のコマンドを入力して、作成したテーブルに関係するファイルを自動的に作成しておきます。

bin\cake bake all samples

3.上記のHelloShell.phpを以下のソースコードに置き換えてください

<?php
namespace App\Shell;

use Cake\Console\Shell;

class HelloShell extends Shell
{
    public $tasks = ['Template'];

    public function main($taskname = '')
    {
				if($taskname === 'add'){
					$this->Template->main();
				}else if($taskname === 'delete'){
					$this->Template->delete();
				}else{
					$this->out(__('No Task.'));
				}
    }
}
?>

関数に引数を書くとコマンドラインから入力された値を受け取ることができます。

4. .src/Shellディレクトリ内にTaskディレクトリを作成します。

5.次に、Taskディレクトリ内に、TemplateTask.phpの名前で以下のコードを保存します。

<?php
namespace App\Shell\Task;

use Cake\Console\Shell;
use Cake\I18n\Time;
use Cake\ORM\TableRegistry;

class TemplateTask extends Shell
{

		public function initialize(){
			  date_default_timezone_set('Asia/Tokyo');
		}

    public function main()
    {
				$samples = TableRegistry::getTableLocator()->get('Samples');
				$query = $samples->query();
				$query->insert(['data','created','modified'])
					->values([
						'data' => '投稿しました',
						'created' => Time::now(),
						'modified' => Time::now()
					])
					->execute();
        $this->out(__('Insert Data.'));
    }

		public function delete(){
				$samples = TableRegistry::getTableLocator()->get('Samples');
				$query = $samples->query();
				$query->delete()
				->where(function($exp, $q){
					return $exp->lte("created", new Time('1 hours ago') );
				})
				->execute();

		$this->out(__('Delete Data.'));
		}
}
?>

6.カレントディレクトリをアプリのルートディレクトリにして、
以下のコマンドを実行すると、データが追加されます。

bin\cake hello add

以下のコマンドを実行すると、データを入力して１時間経過したデータを削除します。

bin\cake hello delete

それ以外に、単に、

bin\cake hello

と入力したり、hello以降に適当な値を入力しても、

bin\cake hello hoge

No Task.というメッセージが表示されるだけになります。

・Authコンポーネントを利用して認証機能を実装して、ログインしないと、データを追加や更新や削除できないようにしても、シェル経由で、データを追加や更新や削除することができるみたいです。

■本番環境ではどうなのか？(ロリポップの場合)
レンタルサーバーのロリポップのスタンダードプランでやってみたところ、CakePHPは普通に動作できるが、cronを使用したり、SSLでアクセスして、手動で実行させようと、bin/cake.phpを動作させると、PHPのバージョンはPHP 5.5.35 (cli) で、CakePHPを使用するには、5.6.0以上にしろと表示され、実行できない。

そこで、推奨できないが、緊急策として、CakePHPを介さずに、PHPでデータベースに直接アクセスして、データを追加するプログラムを作ってみた。このプログラムを実行するたびに、samplesテーブルにデータが追加される。

<?php

date_default_timezone_set('Asia/Tokyo');
$now = date("Y/m/d H:i:s");
$url = "";
$user = "";
$password = "";
$database = "";
$connect = mysql_connect($url,$user,$password) or die("can't connect");
$db = mysql_select_db($database, $connect) or die("can't Select database");
$sql = "INSERT INTO samples (data,created,modified) VALUES ('test', '$now', '$now');";
$result = mysql_query($sql,$connect);
echo $result;

?>

ただ、

上記のプログラムを検証してみると、SSLでログインして、php 絶対パスor 相対パスでのphpのプログラム名では、うまく動作するが、cronで、そのプログラムを指定すると、うまく動作しなかった。原因は分からないが、検証したところ、どうも、mysql_connect部分がおかしいみたい。

そこで、以下のようなPDOを利用したプログラムに切り替えると、cronでもきちんと動作した。

<?php

date_default_timezone_set('Asia/Tokyo');
$now = date("Y/m/d H:i:s");

$url = "";
$user = "";
$password = "";
$database = "";

$dbh = new PDO("mysql:dbname=$database;host=$url",$username,$password);

$count = $dbh->exec("INSERT INTO samples (data,created,modified) VALUES ('test', '$now', '$now')");
echo $count;

?>

参考リンク
シェル - 3.7
日付と時刻 - 3.7
データベースアクセス & ORM - 3.7
クエリービルダー - 3.7
PHPでデータベースに接続するときのまとめ - Qiita
データの追加(INSERT文) - データの追加と削除 - MySQLの使い方
PHPでmysql_connect関数を使いMySQLへ接続するサンプルです。 · GitHub
PHP: PDO - Manual
データの削除(DELETE文) - データの追加と削除 - MySQLの使い方