【PHP8.x】method_exists関数の使い方

Copy
1<?php
2
3/**
4 * method_exists関数の動作を確認するためのサンプルクラス。
5 */
6class ExampleClass
7{
8    /**
9     * テスト用の公開メソッド。
10     * このメソッドの存在を method_exists で確認します。
11     */
12    public function myMethod()
13    {
14        // このメソッドは呼び出しませんが、その存在を確認するために定義されています。
15    }
16}
17
18// クラス名を文字列として指定
19$className = 'ExampleClass';
20
21echo "method_exists関数がメソッド名の大文字・小文字を区別するか (case sensitive) を確認します。\n\n";
22
23// 1. 正しい大文字・小文字のメソッド名で確認
24echo "メソッド名 'myMethod' の存在確認 (正しい大文字・小文字):\n";
25var_dump(method_exists($className, 'myMethod')); // 結果: true (正しいメソッド名なので存在します)
26echo "\n";
27
28// 2. 全て小文字のメソッド名で確認
29echo "メソッド名 'mymethod' (全て小文字) の存在確認:\n";
30var_dump(method_exists($className, 'mymethod')); // 結果: false (method_existsは大文字・小文字を区別します)
31echo "\n";
32
33// 3. 全て大文字のメソッド名で確認
34echo "メソッド名 'MYMETHOD' (全て大文字) の存在確認:\n";
35var_dump(method_exists($className, 'MYMETHOD')); // 結果: false (method_existsは大文字・小文字を区別します)
36echo "\n";
37
38// 4. 先頭のみ大文字のメソッド名で確認
39echo "メソッド名 'MyMethod' (先頭のみ大文字) の存在確認:\n";
40var_dump(method_exists($className, 'MyMethod')); // 結果: false (method_existsは大文字・小文字を区別します)
41echo "\n";
42
43echo "PHPの method_exists 関数は、メソッド名の大文字・小文字を厳密に区別します。\n";
44echo "そのため、メソッド名がわずかでも異なる場合、存在しないと判断されます。\n";
45

PHPのmethod_exists関数は、指定したクラスやオブジェクト内に特定のメソッドが存在するかどうかを安全に確認するために使用されます。この関数は、システム開発において、メソッドが予期せず存在しないことによるエラーを防ぐために有効な機能です。

第一引数には、メソッドを確認したい対象としてクラス名（文字列）またはオブジェクトそのものを指定します。第二引数には、確認したいメソッド名を文字列で渡します。関数が返す戻り値はブール値（bool）で、メソッドが存在すればtrueを、存在しなければfalseを返します。

特に重要な点として、method_exists関数はメソッド名の大文字・小文字を厳密に区別します（case sensitive）。例えば、ExampleClassというクラスにmyMethodという名前のメソッドが定義されている場合、method_exists('ExampleClass', 'myMethod')を実行するとtrueが返されます。しかし、メソッド名が'mymethod'（全て小文字）や'MYMETHOD'（全て大文字）、あるいは'MyMethod'（先頭のみ大文字）のように、わずかでも大文字・小文字が異なると、メソッドは存在しないと判断されfalseが返されます。

このため、method_existsを使用する際は、確認したいメソッド名の大文字・小文字を正確に指定する必要があります。

Copy
1<?php
2
3/**
4 * Demonstrates the use of method_exists() within a class context
5 * to check for the presence of methods in the current class.
6 *
7 * This class includes various types of methods (public, protected, static)
8 * to showcase how method_exists works with different access levels and types
9 * when called from within the class itself, using $this and self::class.
10 */
11class MethodChecker
12{
13    // A public instance method
14    public function publicInstanceMethod(): void
15    {
16        // This method exists.
17    }
18
19    // A protected instance method
20    protected function protectedInstanceMethod(): void
21    {
22        // This method also exists.
23    }
24
25    // A public static method
26    public static function staticMethod(): void
27    {
28        // This static method exists.
29    }
30
31    /**
32     * Checks for the existence of various methods within this class.
33     * Uses both $this (for instance methods) and self::class (for class/static methods).
34     */
35    public function demonstrateMethodExistsInCurrentClass(): void
36    {
37        echo "--- Checking method existence within " . self::class . " ---\n\n";
38
39        // 1. Check for a public instance method using $this
40        if (method_exists($this, 'publicInstanceMethod')) {
41            echo "✅ 'publicInstanceMethod' exists on the current object (\$this).\n";
42        } else {
43            echo "❌ 'publicInstanceMethod' does not exist on the current object (\$this).\n";
44        }
45
46        // 2. Check for a protected instance method using $this
47        // From within the class, method_exists can see protected/private methods.
48        if (method_exists($this, 'protectedInstanceMethod')) {
49            echo "✅ 'protectedInstanceMethod' exists on the current object (\$this).\n";
50        } else {
51            echo "❌ 'protectedInstanceMethod' does not exist on the current object (\$this).\n";
52        }
53
54        // 3. Check for a public static method using self::class
55        if (method_exists(self::class, 'staticMethod')) {
56            echo "✅ 'staticMethod' exists on " . self::class . ".\n";
57        } else {
58            echo "❌ 'staticMethod' does not exist on " . self::class . ".\n";
59        }
60
61        // 4. Check for a non-existent method using $this
62        if (method_exists($this, 'nonExistentInstanceMethod')) {
63            echo "❌ 'nonExistentInstanceMethod' unexpectedly exists on the current object (\$this).\n";
64        } else {
65            echo "✅ 'nonExistentInstanceMethod' correctly does not exist on the current object (\$this).\n";
66        }
67
68        // 5. Check for a non-existent method using self::class
69        if (method_exists(self::class, 'nonExistentStaticMethod')) {
70            echo "❌ 'nonExistentStaticMethod' unexpectedly exists on " . self::class . ".\n";
71        } else {
72            echo "✅ 'nonExistentStaticMethod' correctly does not exist on " . self::class . ".\n";
73        }
74    }
75}
76
77// To run the demonstration:
78// 1. Create an instance of the MethodChecker class.
79$checkerInstance = new MethodChecker();
80
81// 2. Call the method that demonstrates method_exists within the current class.
82$checkerInstance->demonstrateMethodExistsInCurrentClass();

method_exists関数は、指定されたオブジェクトまたはクラスに特定のメソッドが存在するかどうかを確認するために使用されます。この関数は、PHP 8.4.12で利用可能です。

最初の引数$object_or_classには、メソッドの存在を確認したいオブジェクトのインスタンス、またはクラス名を文字列で渡します。2番目の引数$methodには、確認したいメソッドの名前を文字列で指定します。メソッドが存在すればtrueを、存在しなければfalseをブール値で返します。

サンプルコードでは、MethodCheckerクラスが自身のクラスに定義されたメソッドの存在をmethod_existsでチェックしています。インスタンスメソッド（publicInstanceMethodやprotectedInstanceMethod）の確認には$thisを使用し、静的メソッド（staticMethod）の確認にはクラス名を表すself::classを使用しています。クラス内部からmethod_existsを呼び出す場合、protectedメソッドも存在すると判定されます。存在しないメソッド名を指定した場合は、期待通りfalseが返されることが確認できます。これにより、メソッド呼び出し前の安全性確認に活用できます。

Copy
1<?php
2
3/**
4 * method_exists() 関数の 'static' な使い方を示すサンプルクラス。
5 * このクラスは、静的メソッドとインスタンスメソッドの両方を含みます。
6 */
7class MyUtilityClass
8{
9    /**
10     * これは静的メソッドです。
11     * オブジェクトのインスタンスを作成することなく、クラス名から直接呼び出すことができます。
12     */
13    public static function performStaticAction(string $message): string
14    {
15        return "静的メソッドが実行されました: " . strtoupper($message);
16    }
17
18    /**
19     * これはインスタンスメソッドです。
20     * このメソッドを呼び出すには、MyUtilityClass のオブジェクトを先に作成する必要があります。
21     */
22    public function performInstanceAction(string $data): string
23    {
24        return "インスタンスメソッドが実行されました: " . strtolower($data);
25    }
26}
27
28// --- method_exists() を使って静的メソッドの存在を確認する例 ---
29echo "--- クラス名文字列でメソッドの存在をチェック ---\n\n";
30
31// キーワード 'static' に最も関連性の高い使用例:
32// method_exists() の第一引数にクラス名文字列 ('MyUtilityClass') を渡し、
33// 第二引数にチェックしたい静的メソッド名 ('performStaticAction') を渡します。
34// method_exists() は、メソッドが静的であるかインスタンスメソッドであるかを区別せず、
35// 指定されたクラスにその名前のメソッドが存在すれば true を返します。
36if (method_exists('MyUtilityClass', 'performStaticAction')) {
37    echo "1. 'performStaticAction' メソッドは 'MyUtilityClass' クラスに存在します。\n";
38    // 存在が確認できたので、静的メソッドを直接呼び出すことができます。
39    echo MyUtilityClass::performStaticAction("Hello Static World") . "\n";
40} else {
41    echo "1. 'performStaticAction' メソッドは 'MyUtilityClass' クラスに存在しません。\n";
42}
43
44echo "\n";
45
46// 参考: インスタンスメソッドもクラス名文字列で存在チェックできます。
47if (method_exists('MyUtilityClass', 'performInstanceAction')) {
48    echo "2. 'performInstanceAction' メソッドは 'MyUtilityClass' クラスに存在します。\n";
49    // インスタンスメソッドは、クラス名だけでは直接呼び出せません。
50    // オブジェクトのインスタンスを作成してから呼び出す必要があります。
51    $instance = new MyUtilityClass();
52    echo $instance->performInstanceAction("HELLO INSTANCE WORLD") . "\n";
53} else {
54    echo "2. 'performInstanceAction' メソッドは 'MyUtilityClass' クラスに存在しません。\n";
55}
56
57echo "\n";
58
59// 存在しないメソッドのチェック
60if (method_exists('MyUtilityClass', 'nonExistentMethod')) {
61    echo "3. 'nonExistentMethod' は 'MyUtilityClass' クラスに存在します。\n";
62} else {
63    echo "3. 'nonExistentMethod' は 'MyUtilityClass' クラスに存在しません。\n";
64}
65
66?>

method_exists関数は、指定されたクラスやオブジェクトに特定のメソッドが存在するかどうかを確認するために使用されます。第一引数には、チェック対象となるオブジェクト、またはクラス名を文字列で渡します。第二引数には、確認したいメソッド名を文字列で指定します。メソッドが存在すれば true を、存在しなければ false を真偽値で返します。

サンプルコードでは、MyUtilityClassというクラスが静的メソッドとインスタンスメソッドの両方を含んでいます。method_exists関数の第一引数にクラス名文字列 'MyUtilityClass' を指定し、第二引数にメソッド名 'performStaticAction' を渡すことで、performStaticActionという静的メソッドの存在を確認しています。この関数は、メソッドが静的であるかインスタンスメソッドであるかを区別せず、指定された名前のメソッドがクラスに存在すれば true を返します。したがって、静的メソッドだけでなく、インスタンスメソッドの存在もクラス名文字列で確認可能です。メソッドの存在が確認できた場合、静的メソッドはMyUtilityClass::performStaticAction()のようにクラス名から直接呼び出せますが、インスタンスメソッドはオブジェクトを生成してから呼び出す必要があります。存在しないメソッドに対してはfalseが返されます。

Copy
1<?php
2
3/**
4 * サンプルクラス：インスタンスメソッドと静的メソッドを持つ
5 */
6class ExampleClass
7{
8    /**
9     * これはインスタンスメソッドです。
10     * オブジェクトのインスタンスを作成してから呼び出します。
11     */
12    public function instanceMethod(): string
13    {
14        return "インスタンスメソッドが実行されました。";
15    }
16
17    /**
18     * これは静的メソッドです。
19     * オブジェクトのインスタンスを作成せずに、クラス名で直接呼び出せます。
20     */
21    public static function staticMethod(): string
22    {
23        return "静的メソッドが実行されました。";
24    }
25}
26
27// ----------------------------------------------------
28// method_exists の使用例
29// ----------------------------------------------------
30
31echo "--- オブジェクトインスタンスを使ったチェック ---\n";
32
33// ExampleClass のインスタンスを作成
34$myObject = new ExampleClass();
35
36// インスタンスメソッド 'instanceMethod' の存在をチェック
37if (method_exists($myObject, 'instanceMethod')) {
38    echo "myObject に 'instanceMethod' が存在します。\n";
39} else {
40    echo "myObject に 'instanceMethod' が存在しません。\n";
41}
42
43// 静的メソッド 'staticMethod' の存在を、インスタンスを使ってチェック
44// 静的メソッドもインスタンスを通してチェックできます。
45if (method_exists($myObject, 'staticMethod')) {
46    echo "myObject に 'staticMethod' が存在します (静的メソッド)。\n";
47} else {
48    echo "myObject に 'staticMethod' が存在しません (静的メソッド)。\n";
49}
50
51// 存在しないメソッドのチェック
52if (method_exists($myObject, 'nonExistentMethod')) {
53    echo "myObject に 'nonExistentMethod' が存在します。\n";
54} else {
55    echo "myObject に 'nonExistentMethod' が存在しません。\n";
56}
57
58echo "\n--- クラス名（文字列）を使ったチェック ---\n";
59
60// クラス名 'ExampleClass' を直接指定して、静的メソッドの存在をチェック
61if (method_exists('ExampleClass', 'staticMethod')) {
62    echo "'ExampleClass' に 'staticMethod' が存在します。\n";
63} else {
64    echo "'ExampleClass' に 'staticMethod' が存在しません。\n";
65}
66
67// クラス名 'ExampleClass' を直接指定して、インスタンスメソッドの存在をチェック
68// インスタンスメソッドもクラス名でチェック可能です。
69if (method_exists('ExampleClass', 'instanceMethod')) {
70    echo "'ExampleClass' に 'instanceMethod' が存在します。\n";
71} else {
72    echo "'ExampleClass' に 'instanceMethod' が存在しません。\n";
73}
74
75// 存在しないメソッドのチェック
76if (method_exists('ExampleClass', 'anotherNonExistentMethod')) {
77    echo "'ExampleClass' に 'anotherNonExistentMethod' が存在します。\n";
78} else {
79    echo "'ExampleClass' に 'anotherNonExistentMethod' が存在しません。\n";
80}
81
82// 無効なクラス名のチェック (エラーにはならず、falseを返す)
83if (method_exists('NonExistentClass', 'someMethod')) {
84    echo "'NonExistentClass' に 'someMethod' が存在します。\n";
85} else {
86    echo "'NonExistentClass' に 'someMethod' が存在しません。\n";
87}
88

PHP 8.4のmethod_exists関数は、指定したオブジェクトまたはクラスに特定のメソッドが存在するかどうかを確認するために使われます。この関数は、動的にメソッドの存在をチェックし、プログラムの安定性を高めるのに役立ちます。

第一引数には、メソッドをチェックしたい「オブジェクトのインスタンス」または「クラス名を文字列」で渡します。第二引数には、確認したい「メソッドの名前を文字列」で指定します。例えば、'instanceMethod'や'staticMethod'のように記述します。

戻り値は真偽値（bool）で、指定されたオブジェクトやクラスにそのメソッドが存在すればtrueを返し、存在しなければfalseを返します。この関数は、通常のインスタンスメソッドだけでなく、staticキーワードで定義された静的メソッドの存在も確認できます。また、第一引数にクラス名（文字列）を渡した場合でも、そのクラスのインスタンスメソッドや静的メソッドの存在を正しく判別します。存在しないクラス名を第一引数に指定した場合でも、エラーとはならずfalseが返されるため、安全にメソッドの有無を判断できます。