使用Nikic PhpParser修改PHP文件中的数组变量-php教程-PHP中文网

使用Nikic PhpParser修改PHP文件中的数组变量

心靈之曲

发布： 2025-10-14 08:32:21

原创

648人浏览过

使用Nikic PhpParser修改PHP文件中的数组变量

本文详细介绍了如何利用nikic phpparser库在php文件中程序化地修改数组变量，特别是如何正确地向现有数组中添加新元素。文章通过解析php代码为抽象语法树（ast），演示了在遍历ast时识别目标数组，并使用`phpparser\node\expr\arrayitem`和`phpparser\node\scalar\string_`等ast节点类来构造和插入新数组项的正确方法，避免了直接混用原始数据与ast节点导致的错误。

利用Nikic PhpParser修改PHP文件中的数组变量

在进行代码自动化、重构或静态分析等任务时，我们可能需要程序化地读取、分析甚至修改PHP代码。Nikic PhpParser是一个强大的工具，它能够将PHP代码解析成抽象语法树（AST），并允许我们遍历和操作这些树结构。本文将重点讲解如何使用Nikic PhpParser来修改PHP文件中的数组变量，特别是如何正确地向现有数组中添加新的键值对。

1. 准备工作：解析PHP代码

首先，我们需要一个包含目标数组变量的PHP文件。假设我们有first.php文件，内容如下：

<?php

define("CONSTANT1", "cons1value");

$variable1 = "var1value";

$variable2 = array(
    "key1" => "value1",
    "key2" => "value2"
);

登录后复制

我们的目标是将$variable2修改为：

<?php

define("CONSTANT1", "cons1value_updated");

$variable1 = "var1value_updated";

$variable2 = array(
    "key1" => "value1_updated",
    "key2" => "value2", // 假设这个值不变，或者按需修改
    "key_3_added" => "value3_added"
);

登录后复制

要实现这一点，我们需要使用Nikic PhpParser来解析first.php文件并获取其AST。

立即学习“PHP免费学习笔记（深入）”；

<?php

require 'vendor/autoload.php'; // 确保Composer自动加载器已配置

use PhpParser\Error;
use PhpParser\ParserFactory;
use PhpParser\NodeTraverser;
use PhpParser\PrettyPrinter\Standard;
use PhpParser\Node\Expr\ArrayItem;
use PhpParser\Node\Scalar\String_;
use PhpParser\Node\Expr\Assign;
use PhpParser\Node\Expr\Array_;
use PhpParser\Node\Expr\Variable;

$parser = (new ParserFactory)->create(ParserFactory::PREFER_PHP7);
$prettyPrinter = new Standard;
$traverser = new NodeTraverser;

$source = file_get_contents("first.php");

try {
    $stmts = $parser->parse($source);
    // 在这里我们可以添加一个自定义的NodeVisitor来处理修改
    // $traverser->addVisitor(new MyNodeVisitor());
    // $stmts = $traverser->traverse($stmts);
} catch (Error $error) {
    echo "Parse error: {$error->getMessage()}\n";
    exit();
}

// $stmts 现在包含了 first.php 的抽象语法树

登录后复制

2. 遍历AST并定位目标数组

为了修改$variable2，我们需要遍历AST，找到对应的变量赋值语句。在AST中，变量赋值通常表示为PhpParser\Node\Expr\Assign节点，其左侧是变量（PhpParser\Node\Expr\Variable），右侧是值（例如PhpParser\Node\Expr\Array_）。

图改改

在线修改图片文字

455

查看详情

// ... (接上面的代码)

foreach ($stmts as $stmt) {
    // 检查是否是表达式语句 (ExprStmt) 且表达式是赋值操作 (Assign)
    if ($stmt instanceof PhpParser\Node\Stmt\Expression && $stmt->expr instanceof Assign) {
        $assign = $stmt->expr;

        // 检查赋值的左侧是否是变量
        if ($assign->var instanceof Variable) {
            // 检查变量名是否为 'variable2'
            if ($assign->var->name === 'variable2') {
                // 检查赋值的右侧是否是数组
                if ($assign->expr instanceof Array_) {
                    $arrayNode = $assign->expr;

                    // 现在 $arrayNode 是我们想要修改的数组节点
                    // 遍历现有数组项并修改 'key1' 的值
                    foreach ($arrayNode->items as $item) {
                        if ($item instanceof ArrayItem && $item->key instanceof String_) {
                            switch ($item->key->value) {
                                case 'key1':
                                    // 修改 'key1' 的值
                                    $item->value = new String_("value1_updated");
                                    break;
                                case 'key2':
                                    // 假设我们也要修改 'key2'
                                    // $item->value = new String_("value2_updated");
                                    break;
                            }
                        }
                    }

                    // 尝试添加新元素
                    // 错误的方式：直接添加PHP数组
                    // $arrayNode->items[] = ["key3_added" => "value3_added"];
                    // 这会导致错误，因为AST节点列表期望的是AST节点对象，而不是原始PHP数组。
                }
            }
        }
    }
}

// 打印修改后的代码
// echo $prettyPrinter->prettyPrintFile($stmts);

登录后复制

3. 正确添加新的数组元素

上述代码中，直接将PHP数组["key3_added" => "value3_added"]添加到$arrayNode->items中是错误的。Nikic PhpParser处理的是抽象语法树，$arrayNode->items期望的是PhpParser\Node\Expr\ArrayItem类型的对象，而不是普通的PHP数组。

要正确地添加一个键值对，我们需要构造一个ArrayItem节点，其中包含键和值作为PhpParser\Node\Scalar\String_或其他适当的表达式节点。

// ... (接上面的代码)

foreach ($stmts as $stmt) {
    if ($stmt instanceof PhpParser\Node\Stmt\Expression && $stmt->expr instanceof Assign) {
        $assign = $stmt->expr;
        if ($assign->var instanceof Variable && $assign->var->name === 'variable2') {
            if ($assign->expr instanceof Array_) {
                $arrayNode = $assign->expr;

                // 遍历并修改现有项
                foreach ($arrayNode->items as $item) {
                    if ($item instanceof ArrayItem && $item->key instanceof String_) {
                        if ($item->key->value === 'key1') {
                            $item->value = new String_("value1_updated");
                        }
                    }
                }

                // 正确添加新元素
                // 创建一个表示新键的字符串节点
                $newKey = new String_("key_3_added");
                // 创建一个表示新值的字符串节点
                $newValue = new String_("value3_added");
                // 创建一个ArrayItem节点，将键和值关联起来
                $newArrayItem = new ArrayItem($newValue, $newKey);

                // 将新创建的ArrayItem节点添加到数组节点的items列表中
                $arrayNode->items[] = $newArrayItem;

                // 也可以直接写成一行
                // $arrayNode->items[] = new ArrayItem(new String_("value3_added"), new String_("key_3_added"));
            }
        }
    }
}

// 打印修改后的代码
echo $prettyPrinter->prettyPrintFile($stmts);

登录后复制

运行上述代码，你将得到如下输出（或类似格式，取决于PrettyPrinter的配置）：

<?php

define("CONSTANT1", "cons1value");
$variable1 = "var1value";
$variable2 = array(
    "key1" => "value1_updated",
    "key2" => "value2",
    "key_3_added" => "value3_added"
);

登录后复制

4. 完整示例代码

为了更清晰地展示整个过程，以下是一个包含所有步骤的完整示例：

<?php

require 'vendor/autoload.php';

use PhpParser\Error;
use PhpParser\ParserFactory;
use PhpParser\NodeTraverser;
use PhpParser\PrettyPrinter\Standard;
use PhpParser\Node\Expr\ArrayItem;
use PhpParser\Node\Scalar\String_;
use PhpParser\Node\Expr\Assign;
use PhpParser\Node\Expr\Array_;
use PhpParser\Node\Expr\Variable;
use PhpParser\Node\Stmt\Expression; // 引入 Expression 节点

// 1. 创建一个示例PHP文件
file_put_contents('first.php', '<?php

define("CONSTANT1", "cons1value");

$variable1 = "var1value";

$variable2 = array(
    "key1" => "value1",
    "key2" => "value2"
);
');

// 2. 初始化解析器和打印器
$parser = (new ParserFactory)->create(ParserFactory::PREFER_PHP7);
$prettyPrinter = new Standard;
$traverser = new NodeTraverser; // 虽然本例直接遍历，但NodeTraverser是更通用的方式

$source = file_get_contents("first.php");

try {
    $stmts = $parser->parse($source);
} catch (Error $error) {
    echo "Parse error: {$error->getMessage()}\n";
    exit();
}

// 3. 遍历AST并进行修改
foreach ($stmts as $stmt) {
    // 检查是否是表达式语句 (Stmt\Expression)
    if ($stmt instanceof Expression && $stmt->expr instanceof Assign) {
        $assign = $stmt->expr;

        // 检查赋值的左侧是否是变量，并且变量名为 'variable2'
        if ($assign->var instanceof Variable && $assign->var->name === 'variable2') {
            // 检查赋值的右侧是否是数组
            if ($assign->expr instanceof Array_) {
                $arrayNode = $assign->expr;

                // 遍历现有数组项并修改 'key1' 的值
                foreach ($arrayNode->items as $item) {
                    if ($item instanceof ArrayItem && $item->key instanceof String_) {
                        if ($item->key->value === 'key1') {
                            // 修改 'key1' 的值
                            $item->value = new String_("value1_updated");
                        }
                    }
                }

                // 添加新的数组元素 'key_3_added' => 'value3_added'
                $arrayNode->items[] = new ArrayItem(
                    new String_("value3_added"), // 值节点
                    new String_("key_3_added")    // 键节点
                );
            }
        }
    }
}

// 4. 打印修改后的代码
$modifiedCode = $prettyPrinter->prettyPrintFile($stmts);
echo "--- Modified PHP Code ---\n";
echo $modifiedCode;

// 5. 清理示例文件
unlink('first.php');

登录后复制

5. 注意事项与总结

理解AST结构： Nikic PhpParser的核心是抽象语法树。所有代码元素都被表示为特定的PhpParser\Node对象。当你需要修改或添加代码时，必须使用相应的Node子类来构造。
区分原始数据与AST节点： 这是一个常见的陷阱。例如，在数组操作中，$arrayNode->items是一个ArrayItem对象的列表，而不是普通PHP数组的列表。尝试直接添加PHP数组会导致类型不匹配的错误。
使用正确的节点类： 对于字符串字面量，应使用PhpParser\Node\Scalar\String_；对于整数，使用PhpParser\Node\Scalar\LNumber；对于变量，使用PhpParser\Node\Expr\Variable等。
use语句的重要性： 在使用PhpParser的各种节点类时，务必在文件顶部添加正确的use语句，例如use PhpParser\Node\Expr\ArrayItem;，以避免完全限定类名冗长。
版本兼容性： Nikic PhpParser库在不同版本之间可能存在API差异。本文示例基于较新的版本（如nikic/php-parser 4.x系列），请确保你的项目使用的库版本与之兼容。

通过遵循这些原则，你可以有效地利用Nikic PhpParser进行复杂的PHP代码操作和转换。理解AST的内部结构是成功进行程序化代码修改的关键。

以上就是使用Nikic PhpParser修改PHP文件中的数组变量的详细内容，更多请关注php中文网其它相关文章！