## 前言
我們經常使用的一些擴展,有的會在php.ini文件中會有一些配置項。這些配置項控制擴展的行為。如 opcache擴展,經常使用的配置項如下:
```ini
[opcache]
; 模塊地址
zend_extension=opcache.so
; 開關打開
opcache.enable=1
; 開啟CLI
opcache.enable_cli=1
; 可用內存, 酌情而定, 單位為:Mb
opcache.memory_consumption=528
; Zend Optimizer + 暫存池中字符串的占內存總量.(單位:MB)
opcache.interned_strings_buffer=8
; 對多緩存文件限制, 命中率不到 100% 的話, 可以試著提高這個值
opcache.max_accelerated_files=10000
; Opcache 會在一定時間內去檢查文件的修改時間, 這里設置檢查的時間周期, 默認為 2, 定位為秒
opcache.revalidate_freq=60
; 打開快速關閉, 打開這個在PHP Request Shutdown的時候回收內存的速度會提高
opcache.fast_shutdown=1
```
那么如何實現讀取配置文件中的配置項,并應用到擴展中呢?這個是本節要討論的話題。本文將定義幾個配置項,并演示如何讀取和修改配置項。配置項如下:
```ini
[say]
extension=say.so
say.number=101
say.string=abc
say.boolean=1
```
## 代碼
### 基礎代碼
這個擴展,我們將在say擴展上增加相關代碼。say擴展相關代碼大家請看這篇博文。PHP7擴展開發之hello word 文中已經詳細介紹了如何創建一個擴展和提供了源碼下載。
### 代碼實現
使用ext_skel命令生成的代碼默認已經有配置項相關的代碼,只是出于被注釋狀態。配置項的實現分以下幾步。
#### 第一步:聲明變量
這一步聲明的變量用于存儲從配置文件中讀取的配置項值。
```
//定義一個全局變量類型,代碼在php_say.h文件中
ZEND_BEGIN_MODULE_GLOBALS(say)
zend_long global_number;
char *global_string;
zend_bool global_boolean;
ZEND_END_MODULE_GLOBALS(say)
//聲明一個全局變量
ZEND_DECLARE_MODULE_GLOBALS(say)
```
#### 第二步:設置配置項參數
這一步主要是指定一些處理配置項的參數。
所有的配置項參數都必須在`PHP_INI_BEGIN() `和 `PHP_INI_END()`之間。代碼如下:
```c
PHP_INI_BEGIN()
STD_PHP_INI_ENTRY("say.number", "100", PHP_INI_ALL, OnUpdateLong, global_value, zend_say_globals, say_globals)
STD_PHP_INI_ENTRY("say.string", "ab", PHP_INI_ALL, OnUpdateString, global_string, zend_say_globals, say_globals)
STD_PHP_INI_ENTRY("say.boolean", "0", PHP_INI_ALL, OnUpdateBool, global_string, zend_say_globals, say_globals)
PHP_INI_END()
```
#### 第三步:加載配置項
這一步主要是把配置項從配置文件中讀取出來,根據第二步設置的參數,賦值給第一步聲明的變量。
宏方法`REGISTER_INI_ENTRIES();`是用于加載配置文件的。這個宏方法默認是被注釋掉,在`PHP_MINIT_FUNCTION`方法中。只要把注釋給去掉即可。
```
PHP_MINIT_FUNCTION(say)
{
......
REGISTER_INI_ENTRIES();
}
```
#### 第四步:讀取配置項
在PHP擴展中讀取配置項值,需要使用一個宏方法`SAY_G()`。這個宏方法定義在php_say.h中。
現在,我們定義一個方法`show_ini()`來顯示配置項內容。代碼如下:
```c
PHP_FUNCTION(show_ini)
{
zval arr;
array_init(&arr);
add_assoc_long_ex(&arr, "say.number", 10, SAY_G(global_number));
add_assoc_string_ex(&arr, "say.string", 10, SAY_G(global_string));
add_assoc_bool_ex(&arr, "say.boolean", 11, SAY_G(global_boolean));
RETURN_ZVAL(&arr, 0, 1);
}
```
調用show_ini()方法
```
<?php
$ini = show_ini();
var_dump($ini);
?>
```
輸出結果如下:
```
$ php ./test.php
array(3) {
["say.number"]=>
int(101)
["say.string"]=>
string(3) "abc"
["say.boolean"]=>
bool(true)
}
```
#### 第五步:銷毀配置項
這一步主要是為了在PHP進程結束時,釋放配置項占用的資源。
銷毀配置項是通過宏方法`UNREGISTER_INI_ENTRIES()`來實現的。這個方法默認在`PHP_MSHUTDOWN_FUNCTION`方法中。默認是被注釋掉的。只要把注釋去掉就可以了。代碼如下:
```c
PHP_MSHUTDOWN_FUNCTION(say)
{
UNREGISTER_INI_ENTRIES();
......
}
```
### 代碼解讀
`ZEND_BEGIN_MODULE_GLOBALS() `和 `ZEND_END_MODULE_GLOBALS()` 用于定義一個全局變量結構體類型。把宏方法展開后的代碼如下:
```c
typedef struct _zend_say_globals {
zend_long global_number; //數字
char *global_string; //字符串
zend_bool global_boolean; //布爾
} zend_say_globals;
```
`ZEND_DECLARE_MODULE_GLOBALS()`是使用上面定義的類型,聲明一個全局變量。展開后如下:
```c
zend_say_globals say_globals;
```
定義了一個全局變量`say_globals`。
`STD_PHP_INI_ENTRY()`用于設置每個配置項的參數。這個宏方法有這么幾個參數:
- 第一個參數:配置項在配置文件ini中的名稱
- 第二個參數:默認值。當ini文件中不存在這個配置項時,使用這個默認值
- 第三個參數:修改范圍。就是設置都在那些場景下可以修改。詳細的可以查 PHP_INI_ALL
- 第四個參數:當賦值給全局變量前,會調用的函數。PHP內核已經給出了常用的幾個函數。如OnUpdateLong。
- 第五個參數:全局變量的成員名。對應zend_say_globals結構體中的成員。表明讀取的值會賦值給這個成員。
- 第六個參數:全局變量的類型。就是上面定義的結構體。
- 第七個參數:全局變量名稱。
`SAY_G()`用于讀取全局變量的值。如,`SAY_G(global_number)`展開后的代碼如下:
```c
say_globals.global_number
```