PHPで関数が正常終了したかステータスを取るプログラム

Question

PHPで関数が正常終了したかステータスを取ることが必要か迷っています
下記マニュアル記載のeixt()で何かできそうな感じもします。
https://www.php.net/manual/ja/function.exit.php

正しい方法（コーディング）、そもそもの考え方をご教示いただけると幸いです。

追記：ステータスコードが必要か迷うコードの一例を記載します。DBからデータを取得してます。

public function GetMachineToolData($MysqlToolDataTableName){

    $MachineToolData;

    try{
      $pdo = new PDO(self::DSN,self::USER,self::PASSWORD);
    }catch(PDOException $e){
      echo "MySQL接続エラー: " .$e->getMessage();
    }

    $stmt = $pdo->query('select '.$MysqlToolDataTableName . '.id,pkno,tno,gno,tool_name.name,nom,tool_suf.suf_name,sufatr,
                                  lengthA,diameter,lifetime,usetime,lifenumber,usenumber,tool_itf.itf,taprfeed,taptype,thrust,horsepower 
                          from '.$MysqlToolDataTableName .',tool_name,tool_suf,tool_itf 
                          where ' .$MysqlToolDataTableName .'.name=tool_name.t_id 
                                  and ' .$MysqlToolDataTableName .'.suf=tool_suf.suf_id 
                                  and '.$MysqlToolDataTableName . '.itf=tool_itf.itf_id 
                          order by id desc');

    $Cnt=0;
    while ($result = $stmt->fetch(PDO::FETCH_ASSOC)) {

        $MachineToolData[$Cnt]=array( $result['id'],$result['pkno'],$result['tno'],$result['gno'],$result['name'],$result['nom'],$result['suf_name'],
                                      $result['sufatr'],$result['lengthA'],$result['diameter'],$result['lifetime'],$result['usetime'],
                                      $result['lifenumber'],$result['usenumber'],$result['itf'],$result['taprfeed'],$result['taptype'],
                                      $result['thrust'],$result['horsepower']);
    
      $Cnt++;
    }

    return $MachineToolData;

  }

Comments

[m.ts10806]

eixt？

そもそも、どこからどのように実行される前提で、どこで結果を受け取るときの話ですか？
それなしに語れるものはないです。
というか結局「決め」の問題になるのでは。
それも要件次第なのでやはり現時点では何も。

[m.ts10806]

ちなみにexitでは関数どころPHPプログラムが終了します。

[tanat]

質問だけだとよくわからないので、中途半端でも良いので想定しているコードを書くと回答が得やすいかと思いますよ。

[tomoyuki500219]

ご回答ありがとうございます
場合による決め、要件の問題で、必要な時に使うもので必須ではないという感じを受けました。
質問本文に関数を１つ載せてみました。

[m.ts10806]

eixt…

Answer 1

PHPで関数が正常終了したかステータスを取ることが必要か迷っています

まず、exit()は通常のwebアプリケーションで使うことは殆ど無いので、コマンドラインから使用するアプリケーションを作る場合以外は忘れて良いです。

正しい方法（コーディング）、そもそもの考え方をご教示いただけると幸いです。
追記：ステータスコードが必要か迷うコードの一例を記載します。DBからデータを取得してます。

関数の通常仕様としてあり得る場合は関数の呼び出し元で結果から判断します。
通常の仕様としてあり得ない、リカバリーが不可能である場合は例外を使うのが楽です。
PHP エラーハンドリングとかPHP 例外とかで基本的な考えを調べてみると良いです。

例えば質問中のメソッドの場合、ざっと考えて

1. データが取得できる
2. 該当するデータが一つもないので取得できない
3. DBに接続出来ないのでデータが取得できない、SQLが間違っていてデータが取得できない

というケースが考えられます。
1と2については通常あり得るケースなので、呼び出し元側の処理として正しいかどうかは呼び出し元が結果を判断するのが良いでしょう。（=結果を判断しやすいような戻り値を返すと楽です。例えば結果が一つもない場合はnullやfalseを返すとか）

3については、DB接続情報が間違っていたり、DBが死んでいたり、コーディングミスがあったりという呼び出し元としてはどうにもならないものなので処理全体を停止してエラー画面を出すしかありません。
そういう場合には例外をthrowして、呼び出し元でキャッチする様にすると楽です。

• 例示の場合はechoして握りつぶしているので呼び出し元では問題を検知できません。

例えばこういう関数があったとしたら(try-catchで例外を握りつぶさない)

function GetMachineToolData($MysqlToolDataTableName){

    $MachineToolData;

      $pdo = new PDO(self::DSN,self::USER,self::PASSWORD);


    $stmt = $pdo->query('select '.$MysqlToolDataTableName . '.id,pkno,tno,gno,tool_name.name,nom,tool_suf.suf_name,sufatr,
                                  lengthA,diameter,lifetime,usetime,lifenumber,usenumber,tool_itf.itf,taprfeed,taptype,thrust,horsepower 
                          from '.$MysqlToolDataTableName .',tool_name,tool_suf,tool_itf 
                          where ' .$MysqlToolDataTableName .'.name=tool_name.t_id 
                                  and ' .$MysqlToolDataTableName .'.suf=tool_suf.suf_id 
                                  and '.$MysqlToolDataTableName . '.itf=tool_itf.itf_id 
                          order by id desc');

    $Cnt=0;
    while ($result = $stmt->fetch(PDO::FETCH_ASSOC)) {

        $MachineToolData[$Cnt]=array( $result['id'],$result['pkno'],$result['tno'],$result['gno'],$result['name'],$result['nom'],$result['suf_name'],
                                      $result['sufatr'],$result['lengthA'],$result['diameter'],$result['lifetime'],$result['usetime'],
                                      $result['lifenumber'],$result['usenumber'],$result['itf'],$result['taprfeed'],$result['taptype'],
                                      $result['thrust'],$result['horsepower']);

      $Cnt++;
    }

    return $MachineToolData;
  }

こんな感じで処理をすると、どうにもならない時はとりあえずエラー画面を出しつつ、
正常なケースについてはそれに沿った処理を行えます。

• ここではPDOExceptionを含む全ての例外をそのままcatchしていますが、例外の種類でエラー画面の表示を変えたい場合などはcatchブロックを複数設定するなりすると良いです。

PHPマニュアル Exceptionをじっくり読んでみて下さい。

//呼び出し元
try{
   $MachineToolData = GetMachineToolData('テーブル名');
   if(count($MachineToolData) > 0){
      //データが存在する時の処理を記述
   }else{
      //データが存在しない時の処理を記述
        //もし一連の処理の流れで必ずデータが存在しないとおかしいようなｂ
   }


}catch(Exception $e){
   //例外をログに吐き出しつつエラー画面を表示


}

Comments

[tomoyuki500219]

丁寧にご回答いただき誠にありがとうございます
今後、必ず意識してコーディングするようにします。

Answer 2

GetMachineToolData
というメソッド名から、何かしらのデータが取得される機能なので、その成果物を以て、成否を判断されると良いです。
あとはアプリケーションとしての決め事です。
取れなかったときにnullにするのか0にするのかfalseにするのか。
「ベスト」というものはなく、「関数の役割」と「決め事」によって適宜決めるべきものです。それはPHPの標準関数も同じです。

つまり「仕様を決める」こと。
関数を使う方は仕様に則り使うことになるわけですし、関数自体はいつどこから呼び出されるのか知りません。
所定の処理をするだけ。呼び出し元に結果を返すだけ。これもリクエストとレスポンス。

返却値の型宣言をしておくと、より厳格な実装を目指せます。

Comments

[tomoyuki500219]

我流だった考えを、正しくプログラムの設計、コーディングをしたくて迷っています。
大変参考になっている感がしています。
実際に戻す方法は戻り値にすればよいものでしょうか？
return $MachineToolData,status;のように…。

返却値の型宣言も参考にしてみます。

[m.ts10806]

回答読まれましたか？
「何をもって成否を判断するかは決めてください」が回答の主旨です。
「ベストはない」=「正しいはない」
決めたとおりに動けばそれが正しいです。決めた内容が正しいのかどうかは要件次第です。
関数名と処理で判断できるものではありません。なぜなら関数名も処理も決めた結果の実装だからです。

[tomoyuki500219]

回答読ませていただきましたが、再度、コメントいただき、再認識できた気がします。ありがとうございます

Answer 3

不正終了したときに例外処理にとばせば、
実行直後のチェックは正常終了ということでは？

Comments

[tomoyuki500219]

ご回答ありがとうございます
アドバイスいただいた通りだとは思います。