目录

PHP 方法检测函数

作者收录于 PHP

2018-03-04 约 1292 字预计阅读 3 分钟

目录

PHP 中一共提供了 3 种方法检测函数，分别是：function_exists / method_exists / is_callable，这三个函数分别适用于不同的场景，现将其用法做一说明。

检测函数是否存在

这类函数一般指 PHP 内核提供的一些工具函数或者用户自定义的函数

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
<?php

if (! function_exists('dd')) {
    function dd(...$vars)
    {
        foreach ($vars as $var) {
            print_r($var);
            echo PHP_EOL;
        }
        die(1);
    }
}

dd('test', 'hello', 'world');

// 结果
test
hello
world

检测类的方法是否存在

能检测出的方法

method_exists() 能检测出对象中的 static, final, abstract 方法，还能检测出 public, protected, private 修饰的方法

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
<?php

abstract class Foo
{
    public function __construct()
    {
        if (method_exists($this, 'publicMethod')) {
            $this->publicMethod();
        }
    }

    abstract public function abstractMethod();

    final public function finalMethod()
    {
    }
}

class Bar extends Foo
{
    public function publicMethod()
    {
    }

    protected function protectedMethod()
    {
    }

    private function privateMethod()
    {
    }

    public function abstractMethod()
    {
    }

    public static function staticMethod()
    {
    }
}

$result = [
    method_exists(Bar::class, '__construct'),
    method_exists(Bar::class, 'publicMethod'),
    method_exists(Bar::class, 'protectedMethod'),
    method_exists(Bar::class, 'privateMethod'),
    method_exists(Bar::class, 'abstractMethod'),
    method_exists(Bar::class, 'staticMethod'),
    method_exists(Bar::class, 'finalMethod'),
];
var_dump($result);

// 结果
array(7) {
  [0] =>
  bool(true)
  [1] =>
  bool(true)
  [2] =>
  bool(true)
  [3] =>
  bool(true)
  [4] =>
  bool(true)
  [5] =>
  bool(true)
  [6] =>
  bool(true)
}

不能检测出的方法

method_exists() 无法检测出使用魔法方法 __call 调用的函数

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
<?php

class Foo
{
    public function getName()
    {
        return __METHOD__;
    }

    public function __call($method, $arguments)
    {
        if (method_exists($this, $method)) {
            return call_user_func_array([$this, $method], $arguments);
        }

        return null;
    }
}

$foo = new Foo();
var_dump($foo->getName());
var_dump($foo->getDescription());
var_dump(method_exists($foo, 'getName'));
var_dump(method_exists($foo, 'getDescription'));

// 结果
string(12) "Foo::getName"
NULL
bool(true)
bool(false)

检测参数是否为合法的可调用结构

默认调用

is_callable() 可以判断出是否能够进行调用。默认第二个参数为 false，表示该回调操作有权限能够被调用，如果为 true 的话，仅仅验证传递的可能是函数或方法，表示只检测其存在具有可回调的格式

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
<?php

abstract class Foo
{
    public function __construct()
    {
        if (method_exists($this, 'publicMethod')) {
            $this->publicMethod();
        }
    }

    abstract public function abstractMethod();

    final public function finalMethod()
    {
    }
}

class Bar extends Foo
{
    public function publicMethod()
    {
    }

    protected function protectedMethod()
    {
    }

    private function privateMethod()
    {
    }

    public function abstractMethod()
    {
    }

    public static function staticMethod()
    {
    }
}

$bar = new Bar();
$callables = [
    is_callable([$bar, '__construct'], false, $a),
    is_callable([$bar, 'publicMethod'], false, $b),
    is_callable([$bar, 'protectedMethod'], false, $c),
    is_callable([$bar, 'privateMethod'], false, $d),
    is_callable([$bar, 'abstractMethod'], false, $e),
    is_callable([$bar, 'staticMethod'], false, $f),
    is_callable([$bar, 'finalMethod'], false, $g),
];
$names = [$a, $b, $c, $d, $e, $f, $g];
var_dump($callables);
var_dump($names);

// 结果
array(7) {
  [0] =>
  bool(true)
  [1] =>
  bool(true)
  [2] =>
  bool(false)
  [3] =>
  bool(false)
  [4] =>
  bool(true)
  [5] =>
  bool(true)
  [6] =>
  bool(true)
}

array(7) {
  [0] =>
  string(16) "Bar::__construct"
  [1] =>
  string(17) "Bar::publicMethod"
  [2] =>
  string(20) "Bar::protectedMethod"
  [3] =>
  string(18) "Bar::privateMethod"
  [4] =>
  string(19) "Bar::abstractMethod"
  [5] =>
  string(17) "Bar::staticMethod"
  [6] =>
  string(16) "Bar::finalMethod"
}

魔术方法中调用

如果设置了 __call() 方法的话，那么检测出来的任何方法都是返回 true

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
<?php

abstract class Foo
{
    public function __construct()
    {
        if (method_exists($this, 'publicMethod')) {
            $this->publicMethod();
        }
    }

    abstract public function abstractMethod();

    final public function finalMethod()
    {
    }
}

class Bar extends Foo
{
    public function publicMethod()
    {
    }

    protected function protectedMethod()
    {
    }

    private function privateMethod()
    {
    }

    public function abstractMethod()
    {
    }

    public static function staticMethod()
    {
    }

    public function __call($method, $arguments)
    {
    }
}

$bar = new Bar();
$callables = [
    is_callable([$bar, '__construct'], false, $a),
    is_callable([$bar, 'publicMethod'], false, $b),
    is_callable([$bar, 'protectedMethod'], false, $c),
    is_callable([$bar, 'privateMethod'], false, $d),
    is_callable([$bar, 'abstractMethod'], false, $e),
    is_callable([$bar, 'staticMethod'], false, $f),
    is_callable([$bar, 'finalMethod'], false, $g),
    is_callable([$bar, 'notExistMethod'], true, $h),
];
$names = [$a, $b, $c, $d, $e, $f, $g, $h];
var_dump($callables);
var_dump($names);

// 结果
array(8) {
  [0] =>
  bool(true)
  [1] =>
  bool(true)
  [2] =>
  bool(true)
  [3] =>
  bool(true)
  [4] =>
  bool(true)
  [5] =>
  bool(true)
  [6] =>
  bool(true)
  [7] =>
  bool(true)
}

array(8) {
  [0] =>
  string(16) "Bar::__construct"
  [1] =>
  string(17) "Bar::publicMethod"
  [2] =>
  string(20) "Bar::protectedMethod"
  [3] =>
  string(18) "Bar::privateMethod"
  [4] =>
  string(19) "Bar::abstractMethod"
  [5] =>
  string(17) "Bar::staticMethod"
  [6] =>
  string(16) "Bar::finalMethod"
  [7] =>
  string(19) "Bar::notExistMethod"
}

结论

如果 is_callable() 的第一个参数是 string，那么和 function_exists() 相似；如果是数组则和 method_exists() 相似，但又有不同

method_exists() 不会考虑类方法的定义范围 public、protected、private，只要存在就返回 true；而 is_callable() 会在方法是被 protected、private 时返回 false
is_callable() 会去调用 __call() 魔术方法来判断，而 method_exists() 不会