Patchwork 技术文档

本文档旨在帮助用户安装、使用 Patchwork 项目，并详细解释其 API 使用方法。

1. 安装指南

环境要求

• PHP 版本：5.6 或更高版本

安装步骤

使用 Composer 安装 Patchwork：

composer require antecedent/patchwork

确保已正确安装 Composer，并且项目的 composer.json 文件中包含了相应的依赖。

2. 项目的使用说明

Patchwork 允许在 PHP 中重新定义函数和方法，包括用户定义的和内置的调用。这包括函数、类方法和实例方法，以及类似 exit 或 include 的函数样构造。

基本使用示例

以下是一个简单的示例，展示了如何使用 Patchwork 重定义一个函数：

use function Patchwork\{redefine, relay};

redefine('myFunction', function($arg) {
    echo "Before original function\n";
    relay(); // 调用原始函数定义
    echo "After original function\n";
});

在这个例子中，redefine 函数用于重新定义 myFunction，而 relay 函数用于调用原始的 myFunction。

重新绑定 $this

当重新定义类方法时，$this 会自动绑定到包含该方法的类。

use function Patchwork\redefine;

class MyClass {
    public function myMethod() {
        echo get_class($this);
    }
}

redefine('MyClass::myMethod', function() {
    echo get_class($this); // 输出 MyClass
});

获取原始方法信息

使用 getMethod() 和 getCalledClass() 可以在重新定义的方法内部获取原始方法的信息。

use function Patchwork\{redefine, getMethod, getCalledClass};

redefine('MyClass::myMethod', function() {
    echo getMethod() . "\n"; // 输出 MyClass::myMethod
    echo getCalledClass() . "\n"; // 输出 MyClass
});

3. 项目API使用文档

以下是一些核心函数的使用说明：

• redefine($callable, callable $redefinition): 重新定义一个可调用的函数或方法。
• relay(): 在重新定义的函数或方法中调用原始定义。
• restoreAll(): 恢复所有重新定义的函数或方法。
• restore($handle): 恢复一个特定的重新定义。

4. 项目安装方式

请参考上述“安装指南”部分，使用 Composer 进行安装。

---

希望这篇技术文档能够帮助您更好地理解和使用 Patchwork 项目。