从文件中获取类名

Dan*_*ani 23 php reflection

我有一个只包含一个类的php文件.通过了解文件名,我怎么知道哪个类?我知道我可以用regexp匹配做一些事情,但是有标准的php方式吗?(该文件已包含在试图找出类名的页面中).

net*_*der 51

这个问题有多种可能的解决方案,每种方案都有其优点和缺点.他们在这里,知道决定你想要哪一个.

标记生成器

此方法使用标记生成器并读取文件的某些部分,直到找到类定义.

好处

  • 不必完全解析文件
  • 快速(仅读取文件的开头)
  • 几乎没有误报的可能性

缺点

  • 最长的解决方案

$fp = fopen($file, 'r');
$class = $buffer = '';
$i = 0;
while (!$class) {
    if (feof($fp)) break;

    $buffer .= fread($fp, 512);
    $tokens = token_get_all($buffer);

    if (strpos($buffer, '{') === false) continue;

    for (;$i<count($tokens);$i++) {
        if ($tokens[$i][0] === T_CLASS) {
            for ($j=$i+1;$j<count($tokens);$j++) {
                if ($tokens[$j] === '{') {
                    $class = $tokens[$i+2][1];
                }
            }
        }
    }
}
Run Code Online (Sandbox Code Playgroud)

常用表达

使用正则表达式解析文件的开头,直到找到类定义.

好处

  • 不必完全解析文件
  • 快速(仅读取文件的开头)

缺点

  • 误报的几率高(如:echo "class Foo {";)

$fp = fopen($file, 'r');
$class = $buffer = '';
$i = 0;
while (!$class) {
    if (feof($fp)) break;

    $buffer .= fread($fp, 512);
    if (preg_match('/class\s+(\w+)(.*)?\{/', $buffer, $matches)) {
        $class = $matches[1];
        break;
    }
}
Run Code Online (Sandbox Code Playgroud)

注意:正则表达式可能会得到改进,但没有正则表达式可以完美地做到这一点.

获取声明的类列表

此方法使用get_declared_classes()并查找include后定义的第一个类.

好处

  • 最短的解决方案
  • 没有假阳性的可能性

缺点

  • 必须加载整个文件
  • 必须在内存中加载整个类列表两次
  • 必须在内存中加载类定义

$classes = get_declared_classes();
include 'test2.php';
$diff = array_diff(get_declared_classes(), $classes);
$class = reset($diff);
Run Code Online (Sandbox Code Playgroud)

注意:您不能end()像其他人建议的那样简单地做.如果该类包含另一个类,则会得到错误的结果.


这是Tokenizer解决方案,修改为包含一个包含类命名空间的$ namespace变量(如果适用):

$fp = fopen($file, 'r');
$class = $namespace = $buffer = '';
$i = 0;
while (!$class) {
    if (feof($fp)) break;

    $buffer .= fread($fp, 512);
    $tokens = token_get_all($buffer);

    if (strpos($buffer, '{') === false) continue;

    for (;$i<count($tokens);$i++) {
        if ($tokens[$i][0] === T_NAMESPACE) {
            for ($j=$i+1;$j<count($tokens); $j++) {
                if ($tokens[$j][0] === T_STRING) {
                     $namespace .= '\\'.$tokens[$j][1];
                } else if ($tokens[$j] === '{' || $tokens[$j] === ';') {
                     break;
                }
            }
        }

        if ($tokens[$i][0] === T_CLASS) {
            for ($j=$i+1;$j<count($tokens);$j++) {
                if ($tokens[$j] === '{') {
                    $class = $tokens[$i+2][1];
                }
            }
        }
    }
}
Run Code Online (Sandbox Code Playgroud)

说你有这个班:

namespace foo\bar {
    class hello { }
}
Run Code Online (Sandbox Code Playgroud)

...或替代语法:

namespace foo\bar;
class hello { }
Run Code Online (Sandbox Code Playgroud)

您应该得到以下结果:

var_dump($namespace); // \foo\bar
var_dump($class);     // hello
Run Code Online (Sandbox Code Playgroud)

您还可以使用上面的方法来检测文件声明的命名空间,无论它是否包含类.

  • 使用Tokenizer解决方案时出现问题,`fread($ fp,512)`返回带有"未完成"注释的代码,将此字符串传递给`token_get_all`将导致PHP警告"未终止的注释起始行x ..."此呈现如果您在代码中使用注释,则Tokenizer解决方案无用. (5认同)
  • @Swader:好问题,看看更新的答案. (3认同)
  • 如何包含该类的命名空间?如在,返回以名称空间为前缀的FULL类名? (2认同)
  • @netcoder,`if(strpos($ buffer,'{')=== false)continue;如果一个类有一个带有内联phpdoc注释的docblock(`/**bla bla {@see SomeClass),`会导致误报} {@link http://example.com}`).所以你需要在检查前过滤它们(T_DOC_COMMENT). (2认同)

hak*_*kre 6

您可以通过包含文件并获取最后声明的类来使PHP完成工作:

$file = 'class.php'; # contains class Foo

include($file);
$classes = get_declared_classes();
$class = end($classes);
echo $class; # Foo
Run Code Online (Sandbox Code Playgroud)

如果需要将其隔离,请将其包装到命令行脚本中并通过shell_exec以下方式执行:

$file = 'class.php'; # contains class Foo

$class = shell_exec("php -r \"include('$file'); echo end(get_declared_classes());\"");    
echo $class; # Foo
Run Code Online (Sandbox Code Playgroud)

如果您不喜欢命令行脚本,您可以像在这个问题中那样执行它,但是该代码不反映命名空间.


kar*_*ser 6

我修改了Nette\Reflection\AnnotationsParser它,因此它返回文件中定义的命名空间+类名的数组

$parser = new PhpParser();
$parser->extractPhpClasses('src/Path/To/File.php');


class PhpParser
{
    public function extractPhpClasses(string $path)
    {
        $code = file_get_contents($path);
        $tokens = @token_get_all($code);
        $namespace = $class = $classLevel = $level = NULL;
        $classes = [];
        while (list(, $token) = each($tokens)) {
            switch (is_array($token) ? $token[0] : $token) {
                case T_NAMESPACE:
                    $namespace = ltrim($this->fetch($tokens, [T_STRING, T_NS_SEPARATOR]) . '\\', '\\');
                    break;
                case T_CLASS:
                case T_INTERFACE:
                    if ($name = $this->fetch($tokens, T_STRING)) {
                        $classes[] = $namespace . $name;
                    }
                    break;
            }
        }
        return $classes;
    }

    private function fetch(&$tokens, $take)
    {
        $res = NULL;
        while ($token = current($tokens)) {
            list($token, $s) = is_array($token) ? $token : [$token, $token];
            if (in_array($token, (array) $take, TRUE)) {
                $res .= $s;
            } elseif (!in_array($token, [T_DOC_COMMENT, T_WHITESPACE, T_COMMENT], TRUE)) {
                break;
            }
            next($tokens);
        }
        return $res;
    }
}
Run Code Online (Sandbox Code Playgroud)


小智 5

$st = get_declared_classes();
include "classes.php"; //one or more classes in file, contains class class1, class2, etc...

$res = array_values(array_diff_key(get_declared_classes(),$st));
print_r($res); # Array ([0] => class1 [1] => class2 [2] ...)
Run Code Online (Sandbox Code Playgroud)


Mah*_*alt 5

感谢 Stackoverflow 和 Github 的一些人,我能够编写这个令人惊叹的完全工作的解决方案:

/**
 * get the full name (name \ namespace) of a class from its file path
 * result example: (string) "I\Am\The\Namespace\Of\This\Class"
 *
 * @param $filePathName
 *
 * @return  string
 */
public function getClassFullNameFromFile($filePathName)
{
    return $this->getClassNamespaceFromFile($filePathName) . '\\' . $this->getClassNameFromFile($filePathName);
}


/**
 * build and return an object of a class from its file path
 *
 * @param $filePathName
 *
 * @return  mixed
 */
public function getClassObjectFromFile($filePathName)
{
    $classString = $this->getClassFullNameFromFile($filePathName);

    $object = new $classString;

    return $object;
}





/**
 * get the class namespace form file path using token
 *
 * @param $filePathName
 *
 * @return  null|string
 */
protected function getClassNamespaceFromFile($filePathName)
{
    $src = file_get_contents($filePathName);

    $tokens = token_get_all($src);
    $count = count($tokens);
    $i = 0;
    $namespace = '';
    $namespace_ok = false;
    while ($i < $count) {
        $token = $tokens[$i];
        if (is_array($token) && $token[0] === T_NAMESPACE) {
            // Found namespace declaration
            while (++$i < $count) {
                if ($tokens[$i] === ';') {
                    $namespace_ok = true;
                    $namespace = trim($namespace);
                    break;
                }
                $namespace .= is_array($tokens[$i]) ? $tokens[$i][1] : $tokens[$i];
            }
            break;
        }
        $i++;
    }
    if (!$namespace_ok) {
        return null;
    } else {
        return $namespace;
    }
}

/**
 * get the class name form file path using token
 *
 * @param $filePathName
 *
 * @return  mixed
 */
protected function getClassNameFromFile($filePathName)
{
    $php_code = file_get_contents($filePathName);

    $classes = array();
    $tokens = token_get_all($php_code);
    $count = count($tokens);
    for ($i = 2; $i < $count; $i++) {
        if ($tokens[$i - 2][0] == T_CLASS
            && $tokens[$i - 1][0] == T_WHITESPACE
            && $tokens[$i][0] == T_STRING
        ) {

            $class_name = $tokens[$i][1];
            $classes[] = $class_name;
        }
    }

    return $classes[0];
}
Run Code Online (Sandbox Code Playgroud)