zendAPI 项目使用教程

zendAPI 项目使用教程

zendapi The C++ wrapper of zend engine 项目地址: https://gitcode.com/gh_mirrors/ze/zendapi

1. 项目介绍

zendAPI 是一个对 Zend Engine 的 C 接口使用 C++11 进行面向对象封装的项目。它旨在简化 PHP 扩展的开发过程，屏蔽底层 Zend Engine API 的复杂性，使开发者能够专注于业务逻辑的实现。zendAPI 提供了简洁、鲁棒且面向对象的 API，帮助开发者快速开发 PHP 扩展。

项目特点

• 完全面向对象：对 Zend Engine API 进行二次定义，提供面向对象的接口。
• 使用现代 C++11 语法：便于维护和开发。
• 屏蔽 PHP 版本差异：最大化减少 PHP 版本对扩展开发的影响。
• 高覆盖的单元测试：保证代码质量。
• 高性能：在封装时尽最大能力保证性能。
• 二进制兼容：致力于项目库的二进制兼容。

2. 项目快速启动

环境准备

• 安装 PHP 开发环境
• 安装 C++ 编译器（支持 C++11）
• 安装 CMake

下载项目

git clone https://github.com/qcoreteam/zendapi.git
cd zendapi

编译项目

mkdir build
cd build
cmake ..
make

安装扩展

sudo make install

配置 PHP 加载扩展

在 php.ini 文件中添加以下配置：

extension=zendapi.so

验证安装

重启 PHP 服务，并运行以下 PHP 脚本验证扩展是否加载成功：

<?php
if (extension_loaded('zendapi')) {
    echo "zendAPI 扩展加载成功！\n";
} else {
    echo "zendAPI 扩展加载失败！\n";
}
?>

3. 应用案例和最佳实践

案例1：自定义函数扩展

使用 zendAPI 开发一个自定义的 PHP 函数 hello_world，该函数返回字符串 "Hello, World!"。

#include "zendapi.h"

using namespace zendapi;

PHP_FUNCTION(hello_world) {
    RETURN_STRING("Hello, World!");
}

extern "C" {
    ZEND_MODULE_STARTUP_D(zendapi_example) {
        REGISTER_FUNCTION(hello_world);
        return SUCCESS;
    }
}

案例2：类扩展

使用 zendAPI 开发一个自定义的 PHP 类 MyClass，该类包含一个方法 sayHello，返回字符串 "Hello from MyClass!"。

#include "zendapi.h"

using namespace zendapi;

class MyClass : public zendapi::ClassEntry {
public:
    MyClass() : zendapi::ClassEntry("MyClass") {
        addMethod("sayHello", &MyClass::sayHello);
    }

    PHP_METHOD(MyClass, sayHello) {
        RETURN_STRING("Hello from MyClass!");
    }
};

extern "C" {
    ZEND_MODULE_STARTUP_D(zendapi_example) {
        REGISTER_CLASS(MyClass);
        return SUCCESS;
    }
}

4. 典型生态项目

PHP-X

PHP-X 是另一个国内开发的 PHP 扩展开发框架，由 swoole 项目作者开发。它与 zendAPI 类似，提供了面向对象的 PHP 扩展开发接口。

• 项目地址：https://github.com/swoole/PHP-X

PHPCPP

PHPCPP 是一个国外开发的 PHP 扩展开发框架，zendAPI 在开发过程中参考了 PHPCPP 的设计思想，并引用了部分代码。

• 项目地址：https://github.com/CopernicaMarketingSoftware/PHP-CPP

zendapi The C++ wrapper of zend engine 项目地址: https://gitcode.com/gh_mirrors/ze/zendapi