从文件中获取类名

时间:2011-08-22 20:08:44

标签: php reflection

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

11 个答案:

答案 0 :(得分:47)

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

标记生成器

此方法使用tokenizer并读取文件的某些部分,直到找到类定义。

<强>优点

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

<强>缺点

  • 最长的解决方案

<强>代码

$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];
                }
            }
        }
    }
}

正则表达式

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

<强>优点

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

<强>缺点

  • 误报的可能性很高(例如: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;
    }
}

注意:正则表达式可能会有所改进,但单独的正则表达式无法完美地完成此任务。

获取已声明的类列表

此方法使用get_declared_classes()并查找包含后定义的第一个类。

<强>优点

  • 最短的解决方案
  • 没有误报的可能性

<强>缺点

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

<强>代码

$classes = get_declared_classes();
include 'test2.php';
$diff = array_diff(get_declared_classes(), $classes);
$class = reset($diff);

注意:您不能像其他人建议的那样简单地执行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];
                }
            }
        }
    }
}

假设你有这门课程:

namespace foo\bar {
    class hello { }
}

...或替代语法:

namespace foo\bar;
class hello { }

您应该得到以下结果:

var_dump($namespace); // \foo\bar
var_dump($class);     // hello

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

答案 1 :(得分:6)

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

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

include($file);
$classes = get_declared_classes();
$class = end($classes);
echo $class; # Foo

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

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

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

如果您不喜欢命令行脚本,可以像this question那样执行此操作,但该代码不反映命名空间。

答案 2 :(得分:4)

感谢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];
}

答案 3 :(得分:3)

我修改了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;
    }
}

答案 4 :(得分:2)

在使用get_declared_classes包含文件之前,您可以获取所有声明的类。在包含它之后做同样的事情,并将它们与array_diff之类的东西进行比较,并且你有新添加的类。

答案 5 :(得分:2)

$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] ...)

答案 6 :(得分:1)

您可以通过两种方式执行此操作:

  • 复杂解决方案:打开文件并通过正则表达式提取类名(如/class ([a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*)/
  • 简单解决方案:为所有包含类名的php文件命名(例如:文件TestFoo中的类TestFoo.phpTestFoo.class.php)< / LI>

答案 7 :(得分:1)

此示例返回所有类。如果您正在寻找一个派生特定类的类,请使用is_subclass_of

$php_code = file_get_contents ( $file );
    $classes = array ();
    $namespace="";
    $tokens = token_get_all ( $php_code );
    $count = count ( $tokens );

    for($i = 0; $i < $count; $i ++)
    {
        if ($tokens[$i][0]===T_NAMESPACE)
        {
            for ($j=$i+1;$j<$count;++$j)
            {
                if ($tokens[$j][0]===T_STRING)
                    $namespace.="\\".$tokens[$j][1];
                elseif ($tokens[$j]==='{' or $tokens[$j]===';')
                    break;
            }
        }
        if ($tokens[$i][0]===T_CLASS)
        {
            for ($j=$i+1;$j<$count;++$j)
                if ($tokens[$j]==='{')
                {
                    $classes[]=$namespace."\\".$tokens[$i+2][1];
                }
        }
    }
    return $classes;

答案 8 :(得分:1)

我花了很多时间寻找解决方法。 从@ netcoder的解决方案来看,到目前为止,所有解决方案都有很多缺点。

所以我决定这样做。 由于大多数PHP类的类名与filename相同,我们可以从文件名中获取类名。根据您的项目,您还可以拥有命名约定。 注意:这假设类没有命名空间

<?php
    $path = '/path/to/a/class/file.php';

    include $path;

    /*get filename without extension which is the classname*/
    $classname = pathinfo(basename($path), PATHINFO_FILENAME);

    /* you can do all this*/
    $classObj = new $classname();

    /*dough the file name is classname you can still*/
    get_class($classObj); //still return classname

答案 9 :(得分:0)

您可以使用自动加载功能。

function __autoload($class_name) {
    include "special_directory/" .$class_name . '.php';
}

你可以回显$ class_name。但这需要一个目录只有一个文件。

但在PHP中的每个文件中都有一个类是标准做法。所以Main.class.php将包含Main类。如果您是编码标准,则可以使用该标准。

答案 10 :(得分:0)

让我添加一个兼容 PHP 8 的解决方案。这将相应地扫描文件并返回所有 FQCN:

$file      = 'whatever.php';
$classes   = [];
$namespace = '';
$tokens    = PhpToken::tokenize(file_get_contents($file));

for ($i = 0; $i < count($tokens); $i++) {
    if ($tokens[$i]->getTokenName() === 'T_NAMESPACE') {
        for ($j = $i + 1; $j < count($tokens); $j++) {
            if ($tokens[$j]->getTokenName() === 'T_NAME_QUALIFIED') {
                $namespace = $tokens[$j]->text;
                break;
            }
        }
    }

    if ($tokens[$i]->getTokenName() === 'T_CLASS') {
        for ($j = $i + 1; $j < count($tokens); $j++) {
            if ($tokens[$j]->getTokenName() === 'T_WHITESPACE') {
                continue;
            }

            if ($tokens[$j]->getTokenName() === 'T_STRING') {
                $classes[] = $namespace . '\\' . $tokens[$j]->text;
            } else {
                break;
            }
        }
    }
}

// Contains all FQCNs found in a file.
$classes;