PHPでファイル操作処理を一般化する関数func_registを作成したい

Question

ファイル操作処理を一般化する関数func_registを作成したい

今回作成したのはlog.datに　名前、年齢、電話番号を<>で区切って登録するプログラムです。
すでに登録してある場合はエラーを出します。

この処理を一般化し、好きなファイル名、任意の配列、チェックするデータ、重複時のメッセージを関数として処理を作りたいです。
どのようにすればよいでしょうか？

今回一般化したい処理は$file , $insertの部分、重複チェックする変数,重複時メッセージ
の４つです。

まず、一般化する前の処理を記載します。

$name = "田中太郎";
$age = "15";
$tel = "09012345678";


$file = "./log.dat";
$file_array = file($file);
foreach($file_array as $value){
list($list_name,$list_age,$list_tel) = explode('<>', $value);
if($name == $list_name){
$flag = 1;
}
}
if($flag) exit("お客様のお名前は登録済みです。");
$fp = fopen($file ,"r+") or exit("log.datが開けません");
if($fp && flock($fp, LOCK_EX)){
$insert = implode('<>', array($name,$age,$tel,"\n"));
array_unshift($file_array,$insert);
rewind($fp);
ftruncate($fp,0);
for($i=0; $i<count($file_array); $i++) {
fwrite($fp, $file_array[$i]);
}
fclose($fp);
}
echo "登録しました。";

一般化する前のこの処理を実行すれば新規登録の場合は「登録しました」と表示されます。
次に一般化する関数func_registを作成した際には
使うときには

$name = "田中太郎";
$age = "15";
$tel = "09012345678";
$file = "./log.dat";
$list = array($name,$age,$tel);
$errmsg = "お客様のお名前は登録済みです。";
func_regist($file,$list,$check,$errmsg);

一般化していると、これを次のように使えるようにしたいです。

生徒の名前<>学年<>テストの成績
をscore.datに保存する。新しく追加するときは　 $student_name , $rank , $score として追加する
例として、山田太郎君、小学6年生、80点とします。

$name = "山田次郎";
$rank = "6";
$score = "80";
$file = "./score.dat";
$data = list($name,$rank,$score);
$check = $name;
$errmsg = "その生徒の名前は登録済みです";
func_regist($file,$data,$check,$errmsg);

このfunc_regist関数にはどのように書けばよいか教えてください。

追記：自分で作ってみたコードです。

list($list_name,$list_age,$list_tel) = explode('<>', $value);

と書いていたところを一般化するときは

「$list_name,$list_age,$list_tel」

をデータとして渡す必要があります
それがわかりません。

また、これが渡せないと
重複のチェックであるこの部分がかけません。

if($name == $list_name){
$flag = 1;
}

name = "田中太郎";
$age = "15";
$tel = "09012345678";
$insert = implode('<>', array($name,$age,$tel,"\n"));
$data = array($name,$age,$tel);

func_regist("./log.dat",$data,$name,$insert,"その生徒の名前は登録済み");



function func_regist($file , array $data , $check, $insert,$errmsg){
$file_array = file($file);
foreach($file_array as $value){
//list($data) = explode('<>', $value);
//この処理をどうすればよいか
echo "list_name:".$list_name;
if($name == $list_name){
$flag = 1;
}
}
if($flag) exit($errmsg);
$fp = fopen($file ,"r+") or exit("{$file}が開けません");
if($fp && flock($fp, LOCK_EX)){
array_unshift($file_array,$insert);
rewind($fp);
ftruncate($fp,0);
for($i=0; $i<count($file_array); $i++) {
fwrite($fp, $file_array[$i]);
}
fclose($fp);
}
echo "登録しました。";



}

ここの処理をどうかくか　の部分を教えてください

list()の中身は変数として1つ1つしかいれられません。
list (array ($data)) = explode('<>', $value);
とできたら理想なのですが・・・

listで分割する変数を関数外から呼び出したいです。
ループの中で
echo "list_name:".$list_name;
と出力してもNULLになります。
2回目のアクセス時にはlist_nameにはすでに登録されている「田中太郎」と出力されたいです。

Comments

[tanat]

func_regist($file,$list,$check,$errmsg);
まで仕様が決まっているのであれば、あんまり悩む要素は無い様に思いますが、不明な点はどういうところでしょうか？

[d__..___]

list(変数1,変数2)...
とあるのですが変数を渡せません・

[tanat]

元のコードの該当部分についての挙動は正確に把握されていますか？
*質問は編集可能なので、以下について追記をお願いします。
1. func_registの中身を実際にどう書いてみたのか
2. どうやってデバッグして「list(変数1,変数2)...とあるのですが変数を渡せません・」という不明点に行き当たったのか。

[d__..___]

中身を掲載しました。確認お願いします

[退会済みユーザー]

目を離した隙にコードが変わってたか、おっとっと。

[退会済みユーザー]

動作確認を取ったコードを追記したあとで気づいたけど、 $insert ってなんだ？

[d__..___]

insertは新しく追加するデータです。
名前、年齢、電話番号を<>で区切って登録します。
今回は山田太郎でしたけど、フォームから任意のユーザー情報を登録します

Answer 1

$name = "田中太郎";
$age = "15";
$tel = "09012345678";
$file = "./log.dat";
$list = array($name,$age,$tel);
$errmsg = "お客様のお名前は登録済みです。";
func_regist($file,$list,$check,$errmsg);

このコードに$checkが出てこないの、なんでだろう？

$name = "山田次郎";
$rank = "6";
$score = "80";
$file = "./score.dat";
$data = list($name,$rank,$score);
$check = $name;
$errmsg = "その生徒の名前は登録済みです";
func_regist($file,$data,$check,$errmsg);

どちらのコードにも共通して、
登録用関数を呼び出す前からなぜエラーメッセージを引き渡す必要があるのかもわからないですね。

引数の参照渡しの項を読んでもらいたいのですが、
通常なんの工夫もなく引数を関数に与えると「値渡し」となって、
関数内でいくら書き換えても揮発して呼び出し元には何も影響を与えないのですが、
「参照渡し」として関数内で書き換えれば呼び出し元に返すことができたりします。
だから、例えば$errmsgの初期値はカラ文字列にして、
エラー発生時にはエラーメッセージを関数内で詰めるというやり方もあるんじゃないかと。

あと、3番目の引数$checkって必要ですか？
$dataの中に$nameを持たせているのだから冗長です。

また、やたらexit();を使ってますが、
ユーザー定義関数内で似たようなことをするために、
例えば、
$errmsgにエラー内容を代入した後、
return false;などとすればいいんじゃないかと。

func_regist()が返す値がfalseのときは何らかのエラーが発生した、
trueなら成功した、などと判定すれば、
falseだからエラーメッセージを表示しようってなりますよね。
登録用関数func_regist()内で勝手にエラーメッセージを表示されても困るでしょうし。

提案ですが、
配列の構文の例にあるような、
key => value
的なデータのもたせ方の方が楽な気がします。

$data = [
  'name' => "山田次郎",
  'rank' => 6,
  'score' => 80,
];
echo $data['name'];  // "山田次郎"

一応、改良したコードを手元で書いていますが、
もうちょっと寝かせておきます。

---

最小限(?)改変してます、動作確認取ったやーつー。

<?php
$name = "山田次郎";
$rank = "6";
$score = "80";
$file = "./262908_score.dat";
$data = [$name, $rank, $score];
$check = $name;
$errmsg = "";
$result = func_regist($file, $data, $errmsg);
echo $errmsg;

function func_regist($file, $data, &$errmsg) {
    $file_array = file($file);
    $flag = 0;
    foreach ($file_array as $value) {
        list($list_name, $list_age, $list_tel) = explode('<>', rtrim($value));  // rtrim()で改行コード撲滅
        if ($data[0] === $list_name) {
            $flag = 1;
            break;
        }
    }
    if ($flag === 1) {
        $errmsg = "名前は登録済みです。";
        return false;
    }
    $fp = fopen($file ,"r+");
    if ($fp === false) {
        $errmsg = $file . "が開けません";
        return false;
    }
    if ($fp && flock($fp, LOCK_EX)) {
        list($name, $age, $tel) = $data;
        $insert = implode('<>', array($name, $age, $tel)) . "\n";  // $dataのままでもいいんじゃね？ "\n"の連結の仕方をミスすると大変よ。
        array_unshift($file_array, $insert);
        rewind($fp);
        ftruncate($fp, 0);
        for ($i=0; $i < count($file_array); $i++) {
            fwrite($fp, $file_array[$i]);
        }
        fclose($fp);
    }
    $errmsg = "登録しました。";
    return true;
}

Answer 2

ファイル操作処理を一般化する関数

これ、どういった意味なんでしょうか？

中身はあまりちゃんと見ていませんが、一般化をするのであれば、まずはデータの構造を一般的なものにしてみては？

ファイルで扱うのであれば、csv, tsv あたりであれば、php での取り扱いが一般化(?)できます。

加工処理が頻発するのであれば、DB に突っ込むと良いです。排他処理の設計とかあまり気にしなくて良くなります。

Comments

[退会済みユーザー]

クラス設計しているわけでもないのだから、同じような処理を何度も書かない程度のリサイクルくらいの意味かな、って私は思ったけど、真意はわかりません。
データの格納や抽出は、早くデータベースを利用できるようにステップアップしていただきたいのは同意です。

Answer 3

foreach($file_array as $value){
//list($data) = explode('<>', $value);
//この処理をどうすればよいか
if($name == $list_name){
$flag = 1;
}
}

↓

foreach($file_array as $value){
    list($list_name,$list_age,$list_tel) = explode('<>', $value);
    if($name == $list_name){
        $flag = 1;
    }
}

とするのと、
function func_regist($file , array $data , $check, $insert,$errmsg){
で引数を受け取っているのに
if($name == $list_name){
と$nameという関数内では未定義の変数を使おうとしている事

• $checkで引数を受け取っているのであれば、関数内で使用するときは$checkで使わないといけない

辺りが原因かと思います。（他にもあるかもしれませんが）

以下、コード修正前に必要なこと

以下は、開発をする上で必ず必要になることです。

エラーを表示させる
今回のケースだと、noticeが表示されていれば原因に気付けたと思います。
コードの最初に以下のコードを書いておき、全エラーを表示させてください（質問にも必ず記載する、質問前にそのエラーで検索する）

ini_set("display_errors",1);
ini_set("error_reporting",E_ALL);

IDEを使用する
これは私の手元のIDEですが、未定義の変数に赤線を付けてくれていることがわかるかと思います。
PHP IDE等で検索して、開発の補助をしてくれる開発環境を使用してください。

インデントを整える
質問のコードのインデントが整っていないだけでコードを誤読しやすくなりますし、ミスも増えます。teratialにおいては回答者のモチベーションが限りなく下がります。
まともなIDEを使えばインデントを整えてくれる機能があるので、必ずインデントを整えてコードを書いてください。

問題個所の変数の中身を確認する
今回のケースだと

var_dump($name);
var_dump($list_name);
if($name == $list_name){

とすることで、$nameも$list_nameもnullであることがわかるので、そこから遡って行って$nameと$list_nameの発生個所が無いか、発生個所に問題があることが突き止められます。
IDEとxdebugを使ってブレークポイントを仕掛けるのが効率的ではありますが、まずはvar_dump()で変数の中身を確認するようにしてみてください。

Comments

[d__..___]

コメントありがとうございます！！
$list_name,$list_age,$list_telを関数内に定義すると一般化ではなくなってしまうので、関数外から
このデータを呼び出したいです。

一般化ができていれば
$name = "山田次郎";
$sex = "男性";
$rank = "6";
$score = "80";
$file = "./score.dat";

同じ関数で、このようなデーターも追加できるようにしたいです。

＞function func_regist($file , array $data , $check, $insert,$errmsg){
＞で引数を受け取っているのに
＞if($name == $list_name){
＞と$nameという関数内では未定義の変数を使おうとしている事

失礼しました！ミスでした。

[tanat]

このチェックしている部分は
「与えられた名前がファイルの中に存在するかを確認する」
という処理なので、関数の中で展開するのが正しいところだと思いますよ。
ファイルパスは外から与えられているので、使い勝手も悪くは無いと思います。

「一般化では無くなってしまう」の基準が間違っているように思います。
「一般化」という用語自体が具体的なものでは無いので、
1．関数に与える引数は何か
2. 関数実行結果としてどうなれば正しいのか
という関数の外部仕様（これをクリアしてればOK）を誰が読んでも判断出来るくらい厳密で具体的に書き出すと整理しやすいかと思います。

[退会済みユーザー]

文法エラーが有ると、ini_set()が通じなくなるので、php.iniに書くのが一番だと主張したいのコトヨ

[tanat]

>m6uさん
補足ありがとうございます。
php.iniに書けるのであればそれがベストですね。