PHP擴展開發教程4 - 開發咱們本身的接口類

PHP擴展是高級PHP程序員必須瞭解的技能之一，對於一個初入門的PHP擴展開發者，怎麼才能開發一個成熟的擴展，進入PHP開發的高級領域呢？本系列開發教程將手把手帶您從入門進入高級階段。
本教程系列在linux下面開發（推薦使用centos），php版本用的是5.6，並假設您有必定的linux操做經驗和c/c++基礎。
有問題須要溝通的朋友請加QQ技術交流羣32550793和我溝通。

上一章演示瞭如何在PHP擴展中導出普通函數，本章介紹怎麼樣在擴展中導出類。使得PHP可以在腳本中直接訪問擴展中的C++類。

1、如何在PHP擴展中導出C++類

下面是使用PHP-CPP開發的一個擴展骨架代碼，編譯能夠導出一個演示C++類。

工程的源碼見github，能夠用git客戶端下或者打開網址打包下載。

# git clone https://github.com/elvisszhang/phpcpp_counter.git

如今咱們的類名是 Counter, 擴展裏面註冊類的語法是這樣子的

Php::Class<Counter> counter("Counter");

Counter類裏面有個函數叫 increment，經過下面語法告訴擴展讓php腳本能訪問這個函數。

counter.method<&Counter::increment> ("increment");

main.cpp 的C++源碼以下。

#include <phpcpp.h>
#include <time.h>

//擴展的導出類 Counter
class Counter : public Php::Base
{
private:
    int _value = 0;
public:
    Counter() = default;
    virtual ~Counter() = default;
    //類的普通成員函數
    Php::Value increment() { return ++_value; }
    Php::Value decrement() { return --_value; }
    Php::Value value() const { return _value; }
    //類的靜態成員函數
    static Php::Value gettime() {return time();}
};

//告訴編譯器get_module是個純C函數
extern "C" {
    //get_module是擴展的入口函數
    PHPCPP_EXPORT void *get_module() {
        static Php::Extension myExtension("counter", "1.0.0");
        
        //初始化導出類
        Php::Class<Counter> counter("Counter");
        
        //註冊導出類的可訪問普通函數
        counter.method<&Counter::increment> ("increment");
        counter.method<&Counter::decrement> ("decrement");
        counter.method<&Counter::value> ("value");
        
        //註冊導出類的可訪問靜態函數
        counter.method<&Counter::gettime>("gettime");

        //註冊導出類，使用右值引用方式，優化資源使用
        myExtension.add(std::move(counter));
        
        //返回擴展對象指針
        return myExtension;
    }
}

對應上述例子的php測試代碼以下。

<?php
$counter = new Counter;
echo 'result of increment() = '. $counter->increment() . PHP_EOL;
echo 'result of increment() = '. $counter->increment() . PHP_EOL;
echo 'result of decrement() = '. $counter->decrement() . PHP_EOL;
echo 'result of value() = '. $counter->value() . PHP_EOL;
echo 'result of gettime() = '. Counter::gettime() . PHP_EOL;
?>

上述php代碼運行後的輸出信息以下。

result of increment() = 1
result of increment() = 2
result of decrement() = 1
result of value() = 1
result of gettime() = 1523363778

2、擴展類的普通函數支持的樣式

擴展類的函數，必須按照必定的規範來寫，返回值和參數的名稱、類型都是有規定。不然就不能被PHP腳本認識。

最多見的是下面4種函數樣式，跟上一章的普通函數的樣式其實差很少，返回值和參數的用法也徹底同樣，因此就再也不多說。

// signatures of supported regular methods
void        YourClass::example1();
void        YourClass::example2(Php::Parameters &params);
Php::Value  YourClass::example3();
Php::Value  YourClass::example4(Php::Parameters &params);

另外函數若是帶上修飾符 const。還有下面4種變化的樣式。

void        YourClass::example5() const;
void        YourClass::example6(Php::Parameters &params) const;
Php::Value  YourClass::example7() const;
Php::Value  YourClass::example8(Php::Parameters &params) const;

3、參考文獻

PHP-CPP幫助：classes-and-objects