【PHP8.x】ArgumentCountError::codeプロパティの使い方

codeプロパティの使い方について、初心者にもわかりやすく解説します。

作成日: 2025年09月11日更新日: 2025年10月13日

基本的な使い方

『codeプロパティは例外コードを保持するプロパティです』このプロパティは、PHPの基本的な例外クラスであるExceptionクラスで定義されており、ArgumentCountErrorクラスはこれを継承して利用します。開発者は例外を意図的に発生させる際に、エラーメッセージと共に任意の整数コードを指定することができ、その値がこのcodeプロパティに格納されます。try...catch構文を用いて例外を捕捉した際には、getCode()メソッドを通じてこの数値を取得し、コードの値に応じて処理を分岐させることが可能です。これにより、同じ種類の例外であっても、発生原因ごとに異なる対応を行うといった、より詳細なエラーハンドリングを実装できます。ArgumentCountErrorは、主に関数やメソッドの引数の数が期待された数と異なるときにPHPエンジンによって自動的にスローされるエラーです。この場合、codeプロパティには通常、デフォルト値である0が設定されています。

構文(syntax)


1<?php
2
3function add(int $a, int $b) {
4    return $a + $b;
5}
6
7try {
8    // 引数を1つ不足させて関数を呼び出し、ArgumentCountErrorを発生させる
9    add(1);
10} catch (ArgumentCountError $e) {
11    // 捕捉したエラーオブジェクトの code プロパティの値を出力する
12    // public readonly int $code;
13    var_dump($e->code);
14}
15
16?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

int

ArgumentCountErrorクラスのcodeプロパティは、エラーコードを表す整数値を返します。

サンプルコード

PHP ArgumentCountErrorのcodeを取得する


1<?php
2
3namespace App\Libraries;
4
5use ArgumentCountError;
6
7class ErrorHandler
8{
9    /**
10     * ArgumentCountError の code プロパティを取得するサンプル
11     *
12     * @return int|null エラーコード、エラーが発生しない場合は null
13     */
14    public function getArgumentCountErrorCode(): ?int
15    {
16        try {
17            // 引数の数が間違っている関数を呼び出す
18            $this->myFunction("arg1", "arg2");
19            return null; // ここには到達しない
20        } catch (ArgumentCountError $e) {
21            // ArgumentCountError オブジェクトから code プロパティを取得
22            return $e->getCode();
23        }
24    }
25
26    /**
27     * 引数の数が正しくない場合に ArgumentCountError が発生する関数
28     *
29     * @param string $arg1
30     * @return void
31     */
32    private function myFunction(string $arg1): void
33    {
34        // この関数は引数を1つだけ受け取るように定義されています。
35    }
36}
37
38// 使用例：
39$errorHandler = new ErrorHandler();
40$errorCode = $errorHandler->getArgumentCountErrorCode();
41
42if ($errorCode !== null) {
43    echo "ArgumentCountError code: " . $errorCode . PHP_EOL;
44} else {
45    echo "ArgumentCountError は発生しませんでした。" . PHP_EOL;
46}
47
48?>

このサンプルコードは、PHP 8 における ArgumentCountError クラスの code プロパティの使用例を示しています。ArgumentCountError は、関数に渡された引数の数が、関数定義で期待される引数の数と一致しない場合に発生する例外です。

このコードでは、ErrorHandler クラス内で、引数の数が間違っている関数 myFunction を呼び出すことで、ArgumentCountError を発生させています。getArgumentCountErrorCode メソッドは、try-catch ブロックを使用し、ArgumentCountError が発生した場合に、その例外オブジェクト $e の getCode() メソッドを呼び出してエラーコードを取得します。code プロパティは ArgumentCountError オブジェクトに関連付けられたエラーコードを整数値として返します。

getCode() メソッドは引数を取りません。返り値は integer 型で、発生したエラーの種類を示す数値です。このサンプルでは、ArgumentCountError が発生した場合に、そのエラーコードを返し、エラーが発生しなかった場合には null を返すように設計されています。

最後に、取得したエラーコードを表示する例を示しています。エラーコードが null でない場合、つまり ArgumentCountError が発生した場合は、エラーコードの値を画面に出力します。

ArgumentCountErrorのcodeプロパティは、PHP 8以降で例外がスローされた際に設定されるエラーコードを取得するために使用します。このコードは、例外の種類や原因を特定するのに役立ちます。サンプルコードでは、try-catchブロックでArgumentCountErrorを捕捉し、getCode()メソッドでエラーコードを取得しています。ArgumentCountErrorは、関数に予期される数と異なる数の引数が渡された場合に発生します。codeプロパティが常に設定されるとは限らないため、取得した値が有効かどうかを確認することをお勧めします。また、例外処理を行う際は、具体的な例外クラスを指定して捕捉することで、予期しないエラーを防ぐことができます。CodeIgniter環境で使用する場合は、例外処理を適切に設定し、エラーログなどを活用してデバッグを行うことが重要です。

ArgumentCountError の code を取得する


1<?php
2
3/**
4 * ArgumentCountError を捕捉する例。
5 * 'code' プロパティは、エラーコードを整数値で返します。
6 */
7try {
8    // 必要な引数よりも少ない数で関数を呼び出すと、ArgumentCountError がスローされます。
9    strlen(); // 引数なしでstrlen関数を呼び出す
10} catch (ArgumentCountError $e) {
11    // エラーコードを取得
12    $errorCode = $e->getCode();
13
14    // エラーコードを出力 (通常は0)
15    echo "ArgumentCountError code: " . $errorCode . PHP_EOL;
16}

このサンプルコードは、PHP 8における ArgumentCountError クラスの code プロパティの使用例を示しています。ArgumentCountError は、関数やメソッドに必要とされる引数の数よりも少ない引数で呼び出した場合に発生するエラーです。

このコードでは、まず try-catch ブロックを使用し、ArgumentCountError を捕捉しています。try ブロック内では、引数を必要とする strlen() 関数を引数なしで呼び出すことで、意図的に ArgumentCountError を発生させています。

catch ブロックでは、発生した ArgumentCountError オブジェクト $e を受け取り、その $e オブジェクトの getCode() メソッドを呼び出すことで、エラーコードを取得しています。ArgumentCountError の code プロパティは、エラーを表す整数値を返します。通常、この値は0です。

最後に、取得したエラーコードを echo で出力しています。この例では、ArgumentCountError code: 0 と表示されます。この code プロパティは、エラーの種類を識別するために使用されることがありますが、ArgumentCountError の場合は通常0となります。PHP_EOL は改行を表す定義済みの定数です。

ArgumentCountErrorのcodeプロパティは、PHP 8ではほとんどの場合0を返します。これは従来の例外クラスとの互換性を保つための仕様です。エラーの種類を特定するには、codeプロパティではなく、例外オブジェクトのクラス名やメッセージを確認することが推奨されます。strlen()のような組み込み関数は、引数の数が不正な場合にArgumentCountErrorを発生させる可能性があります。try-catchブロックで例外を適切に捕捉し、エラー発生時の処理を記述することで、プログラムの安定性を高めることができます。PHP Codesnifferなどのツールを使用すると、コードの品質を保ち、エラーを早期に発見するのに役立ちます。