Sarah Golemonの 「Extension Writing Part I：Introduction to PHP and Zend」の翻訳。

はじめに

この記事を読んでいるのであれば、PHP言語の拡張機能を作成することに興味がある可能性が高いでしょう。 そうでない場合...おそらくこの記事を読んだとき、あなたはそれさえ疑わなかったという事実にもかかわらず、あなたはあなた自身にこの興味を発見するでしょう！



この記事で紹介する資料は、PHP言語自体とPHPインタープリターの作成言語であるCの両方に精通していることを意味します。



PHPの拡張機能を作成する理由を定義することから始めましょう。

1. 言語で受け入れられる抽象化レベルのために、PHPから直接作成できないライブラリまたは特定のOS呼び出しの存在。
2. PHPを非標準的な方法で動作させたい場合。
3. PHPで作成されたソリューションは既にありますが、プロセスの高速化、コンパクト化、およびメモリ消費の削減を実現できることはご存じでしょう。
4. 販売したい特別なコードがあります。 ただし、購入者がコードを実行できることは重要ですが、ソースを見ることはできません。

上記の理由はすべて十分ですが、拡張機能を作成するときは、まずこれが主に拡張機能であることを理解する必要があります。

拡張機能とは何ですか？

PHPを使用する必要がある場合は、拡張機能を使用しました。 いくつかの例外を除き、PHP言語で使用可能なすべての関数は特定の拡張機能にグループ化されます。 ほとんどの機能（400以上）は、 標準の拡張機能の一部です。 PHPのソースコードは、それぞれ約30個の関数を含む約86個の拡張機能とともに配布されます。 カウントすると、合計で約2500個の関数が得られます。 これだけでは不十分な場合、PECLリポジトリは100を超える追加の拡張機能を提供しますが、インターネットの広大な地域にはさらに多くの拡張機能があります。



「まあ、これだけ多くの機能が拡張機能に組み込まれているのに、それは拡張機能の外に残っていますか？」 「拡張機能とは何ですか？」 PHPの中核は何ですか？」



PHPのコアは、2つの独立した部分の形で実装されます。 言語の技術的な部分は、 Zend Engine （ZE）の形式で提示されます。 ZEは、人間が読めるスクリプトをコンピューターが使いやすいトークンに変換してから実行します。 さらに、ZEはメモリ管理、変数の範囲、および関数呼び出しの処理を担当します。

カーネルの2番目の部分は、直接「コア」と呼ばれるもの（ PHPコア ）です。 SAPIレイヤー（サーバーアプリケーションプログラミングインターフェイス、PHPインターフェイスと他のサーバーソフトウェア-CLI、CGI、Apacheなど）とのやり取りを担当します。 さらに、カーネルはsafe_modeおよびopen_basedirチェック用の一般化された制御層（これらの機能はバージョン5.3以降廃止されたと宣言されています）、およびファイルおよびネットワークI / O操作をfopen、fread、fwrite関数に関連付けるストリーム層を実装しています。

ライフサイクル

特定のSAPIが起動すると（たとえば、コマンド/ usr / local / apache / bin / apachectl startを使用してApacheサーバーを起動する場合）、PHPはカーネルサブシステムを起動して作業を開始します。 起動手順の終わりに向かって、各拡張機能のコードをダウンロードし、 モジュール初期化 （MINIT）関数を呼び出します。 これにより、各拡張機能は、内部変数を初期化し、リソースにメモリを割り当て、リソースハンドラーとその機能をZEに登録できるため、スクリプトがこの拡張機能の関数を呼び出すと、ZEは実行するコードを認識できます。



次に、PHPはSAPIレイヤーからのページ処理要求を予期します。 CGIまたはCLI SAPIの場合、これはすぐに一度だけ発生します。 SAPI Apache、IIS、または他の本格的なWebサーバーの場合、リモートユーザーが（競合する可能性がある）ページを要求するたびに、ページ処理の要求が発生します。 ただし、リクエストの送信方法に関係なく、その処理は、PHPコアがZEにスクリプトを実行するための環境を構成するように要求し 、各拡張機能のリクエスト初期化 （RINIT）関数を呼び出すことから始まります。 RINITは、特定の環境変数を構成し、特定の要求リソースにメモリを割り当て、他のタスクを実行する機能を拡張機能に与えます。 動作中のRINIT関数の好例はセッション拡張です。session.auto_startが有効になっている場合、RINIT関数は自動的にsession_start関数を呼び出し、 $ _SESSION変数を初期化します。



リクエストが初期化されると、ZEはPHPスクリプトをトークンに変換し、次に実行可能なオペコードに変換します。 これらのオペコードのいずれかが拡張機能からの関数呼び出しを要求する場合、ZEはこの関数を呼び出すための引数を生成し、完了するまで一時的に制御を転送します。



スクリプトの実行が完了すると、PHPは拡張機能ごとにシャットダウン要求 （RSHUTDOWN）関数を呼び出します。これは、クリーニングプロセスを完了するために必要です（たとえば、セッション変数をディスクに保存する）。 次のステップであるZEはクリーニングプロセス（ガベージコレクションとも呼ばれます）を実行し、実行されたスクリプトで使用される各変数に対してunsetメソッドを実際に実行します（PHP 5.3以降、ガベージコレクションメカニズムが大幅に改善されました）。



リクエストの処理が完了すると、PHPはSAPIから別のスクリプトを処理するリクエスト、または完了する信号を予期します。 CGIまたはCLI SAPIの場合、「次の要求」は不可能であるため、SAPIはPHPのシャットダウンをすぐに開始します。 完了時に、PHPはすべての拡張機能を反復処理し、それぞれに対してモジュールシャットダウン （MSHUTDOWN）関数を呼び出します。その後、独自のカーネルサブシステムを完了します。



このプロセスは最初は少し混乱しているように見えるかもしれませんが、拡張機能の作業に入ると、徐々にそれを感じます。

メモリ割り当て

不完全に記述された拡張機能でのメモリリークを回避するために、ZEは追加フラグに基づいて独自の内部メモリ管理メカニズムを使用して、データの有効期間を決定します。 永続的（ 永続的 ）メモリ割り当ては、単一ページ要求の処理中よりも多くのメモリが割り当てられることを意味します。 メモリの非永続的な割り当ては、解放関数が呼び出されたかどうかに関係なく、要求の処理後にメモリを解放することを意味します。 たとえば、ユーザー変数へのメモリの割り当ては本質的に一貫性がありません。リクエストの処理が完了すると、ユーザー変数が使用できなくなるためです。



理論上の拡張では、各リクエストの最後に揮発性メモリを自動的に解放することをZEに任せる可能性があるという事実にもかかわらず、これは推奨されません。 割り当てられたメモリは長い間要求されないままになり、このメモリに関連付けられたリソースが正しく閉じられる可能性が低くなり、最終的に、メモリの解放で混乱を引き起こすことは悪い習慣です。 後で見るように、すべてのデータが正しくクリーンアップされていることを確認するのは簡単です。



従来のメモリ割り当て関数（外部ライブラリを使用する場合にのみ使用する必要があります）と、PHP / ZEの定数および非永続メモリ割り当ての関数を簡単に比較してみましょう。

トラディショナル	気まぐれ	常設
malloc（カウント）	emalloc（カウント）	pemalloc（カウント、1） *
calloc（カウント、数値）	ecalloc（カウント、1）	pecalloc（カウント、数値、1）
strdup（str）	estrdup（str）	pestrdup（str、1）
strndup（str、len）	estrndup（str、len）	pemalloc（）およびmemcpy（）
無料（ptr）	efree（ptr）	pefree（ptr、1）
realloc（ptr、newsize）	erealloc（ptr、newsize）	perealloc（ptr、newsize、1）
malloc（count * num + extr） **	safe_emalloc（count、num、extr）	safe_pemalloc（count、num、extr）

* pemallocファミリーの関数は、パラメーターとして「永続性」フラグを受け入れます。これにより、それらの気まぐれな関数のように動作できます。

例：emalloc（1234）は、pemalloc（1234、0）と同じです

** safe_emalloc（）および（PHP 5）safe_pemallocは、整数オーバーフローの追加チェックを実装します。

環境のセットアップと構築

PHPとZend Engineの理論に精通したので、仕事に取り掛かり、何かを始めるのを待つことはできません。 ただし、その前に、いくつかのビルドツールを入手し、目的に合わせて環境を構成する必要があります。



まず、PHP自体と、PHPに必要なビルドツールのセットが必要です。 PHPをソースからビルドする必要がない場合は、 この記事をご覧になることをお勧めします。 PHPソースでバイナリパッケージを使用するのは魅力的かもしれませんが、そのようなアセンブリには多くの場合、開発プロセス中に非常に役立つ2つの重要なプログラムパラメーター./configureがありません。 1つ目はenable-debugです。 このオプションは、セグメンテーションエラー（segfault）が発生したときにカーネルダンプを取得し、gdbデバッガーを使用してエラーが発生した場所と理由を確認できるように、PHPを実行可能ファイルの追加デバッグ情報でコンパイルします。

2番目のオプションの名前は、使用するPHPのバージョンによって異なります。 PHP 4.3では、PHP 5から--enable-experimental-ztsと呼ばれ、 --enable-maintainer-ztsに名前が変更されました 。 このオプションを使用すると、PHPはマルチスレッド環境で動作すると見なし、スレッドレス環境では見えない一般的なエラーをキャッチできますが、マルチスレッド環境では拡張機能の動作が不安定になります。

追加オプションを使用してPHPをコンパイルし、開発サーバー（またはワークステーション）にインストールすると、最初の拡張機能を作成するというアイデアを打ち破ることができます。

ハローワールド

すでに必須のHello Worldプログラムの例がなければ、プログラミングに関するどの入門記事を完成させることができますか？ この場合、「Hello World」という単語を含む文字列を返す1つの関数をPHPに追加する拡張機能を作成することを検討します。 PHPでは、おそらく次のように実装します。

<?php



function hello_world() {

return 'Hello World' ;

}



?>

次に、この関数からPHP拡張機能を作成しましょう。 まず、PHPソースディレクトリツリーのext /ディレクトリにhelloサブディレクトリを作成し、そこにcdを作成します。 原則として、このディレクトリはソースのあるディレクトリツリーの内部または外部のどこにでも配置できますが、今後記事からリンクできるようにここに配置する必要があります。 ここでは、3つのファイルを作成する必要があります。

1. phpizeユーティリティがコンパイル用の拡張機能を準備するために使用する構成ファイル（ config.m4 ）：
   
   

   PHP_ARG_ENABLE(hello, whether to enable Hello World support,

[ --enable-hello Enable Hello World support])



if test "$PHP_HELLO" = "yes"; then

AC_DEFINE(HAVE_HELLO, 1, [Whether you have Hello World])

PHP_NEW_EXTENSION(hello, hello.c, $ext_shared)

fi


   
   
   
   

   
   
   
2. 拡張機能をダウンロードするためにPHPが使用する命令を含むヘッダーファイル（ php_hello.h ）：
   
   

   #ifndef PHP_HELLO_H

#define PHP_HELLO_H 1



#define PHP_HELLO_WORLD_VERSION "1.0"

#define PHP_HELLO_WORLD_EXTNAME "hello"



PHP_FUNCTION(hello_world);



extern zend_module_entry hello_module_entry;

#define phpext_hello_ptr &hello_module_entry



#endif




   
   
   
   

   
   
   
3. hello_world関数の本体を含むソースファイル（ hello.c ）：
   
   

   #ifdef HAVE_CONFIG_H

#include "config.h"

#endif



#include "php.h"

#include "php_hello.h"



static function_entry hello_functions[] = {

PHP_FE(hello_world, NULL)

{NULL, NULL, NULL}

};



zend_module_entry hello_module_entry = {

#if ZEND_MODULE_API_NO >= 20010901

STANDARD_MODULE_HEADER,

#endif

PHP_HELLO_WORLD_EXTNAME,

hello_functions,

NULL,

NULL,

NULL,

NULL,

NULL,

#if ZEND_MODULE_API_NO >= 20010901

PHP_HELLO_WORLD_VERSION,

#endif

STANDARD_MODULE_PROPERTIES

};



#ifdef COMPILE_DL_HELLO

ZEND_GET_MODULE(hello)

#endif



PHP_FUNCTION(hello_world)

{

RETURN_STRING( "Hello World" , 1);

}




   
   
   
   

   
   
   

前の例で見たコードのほとんどは、ある種の「接着剤」です。PHPで拡張機能を登録し、それらの間の対話を確立するためのプロトコルです。 実際のコードは、 hello.cファイルの最後の4行のみで、ユーザースクリプトから呼び出すことができるレベルでアクションを実行します。 間違いなく、このコードは以前見たPHPコードに非常に似ており、簡単に部分に分割できます。

• hello_worldという関数を宣言し、
• 文字列「Hello World」を戻り値として設定
• うーん... 1？ この1はどういう意味ですか？

ZEは、スクリプトの完了時にすべての要求されたリソースが解放されることを確認する高度なメモリ管理メカニズムを使用することを思い出してください。 メモリ管理の世界では、同じメモリブロックを再び解放することは大きなah-ahと見なされます。 このアクションは「ダブルリリース」と呼ばれ、セグメンテーションエラーの一般的な原因です。これは、プログラムが、もはや所属していないメモリブロックにアクセスしようとするためです。

簡単に言えば、ZEが静的文字列（この例では「Hello World」）によって占有されているメモリの解放を開始しないように、hello_world関数は呼び出されるたびに文字列のコピーを返す必要があります。

原則として、 RETURN_STRING関数は、渡された行をコピーする必要があるという事実に責任を持つことができるため、後でそのメモリを安全に解放できます。 ただし、文字列にメモリを割り当て、文字列をコピーし、結果としてコピーを返すことは内部ZE関数の標準的な動作ではないため、 RETURN_STRINGを使用すると、2番目の引数を使用して変数をコピーするかどうかを指定できます 。 この概念をより視覚的に説明するために、機能的には前のものと同じである次のコードフラグメントに注意してください。

PHP_FUNCTION(hello_world)

{

char *str;



str = estrdup( "Hello World" );

RETURN_STRING(str, 0);

}





この例では、「Hello World」行に揮発性メモリを手動で割り当てました。これは、RETURN_STRING 関数を使用して呼び出しスクリプトに返され、2番目のパラメーターとして0を指定します。

拡張アセンブリ

この演習の最後の手順は、動的にロードされるモジュールとして拡張機能を構築することです。 前の例を正しくコピーした場合、ext / hello /ディレクトリから3つのコマンドを実行するだけです。

$ phpize

$ ./configure --enable-hello

$ make



phpizeユーティリティが正しく機能するには、 m4およびautoconfユーティリティが必要であることに注意してください。

これらすべてのコマンドを実行すると、 ext / hello / modules /フォルダーにhello.soファイルが表示されます。 これで、他のPHP拡張機能と同様に、単にそのディレクトリを拡張機能でコピーできます（デフォルトでは/ usr / local / lib / php / extensions /ですが、 念のため、 php.iniの設定を確認するか、 php-configコマンドを使用します- -extension-dir ）そして、 php.iniにextension = hello.so行を追加して、PHPの起動時に拡張機能のロードを初期化します。 SAPIタイプのCGI / CLIの場合、これは次に実行されるスクリプトになり、SAPIタイプのApache Webサーバーの場合、これは次のサーバーの再起動になります。 コマンドラインから関数を呼び出してみましょう。

$ php –r 'echo hello_world();'



すべてが正常に実行されると、 hello_world関数がロードされた拡張機能から行を返すため、スクリプトの結果としてHello World行が表示され、 echoコマンドは送信されたものを表示します（この場合、 hello_world関数の結果）



この例では、文字列を返しましたが、他のスカラーデータ型も同様の原則に従って返すことができます：整数値の場合はRETURN_LONG 、浮動小数点数の場合はRETURN_DOUBLE 、TRUE / FALSEの場合はRETURN_BOOL 、NULL値の場合はRETURN_NULLです。 PHP_FEマクロを含む行をfunction_entity構造に追加し、 hello.cファイル内の対応するPHP_FUNCTIONマクロを追加して、それぞれの動作を見てみましょう。

static function_entry hello_functions[] = {

PHP_FE(hello_world, NULL)

PHP_FE(hello_long, NULL)

PHP_FE(hello_double, NULL)

PHP_FE(hello_bool, NULL)

PHP_FE(hello_null, NULL)

{NULL, NULL, NULL}

};



PHP_FUNCTION(hello_long)

{

RETURN_LONG(42);

}



PHP_FUNCTION(hello_double)

{

RETURN_DOUBLE(3.1415926535);

}



PHP_FUNCTION(hello_bool)

{

RETURN_BOOL(1);

}



PHP_FUNCTION(hello_null)

{

RETURN_NULL();

}





さらに、ビルドプロセスがスムーズに進むように、 php_hello.hヘッダーファイルのhello_world関数のプロトタイプの横にこれらの関数のプロトタイプを追加する必要があります。

PHP_FUNCTION(hello_world);

PHP_FUNCTION(hello_long);

PHP_FUNCTION(hello_double);

PHP_FUNCTION(hello_bool);

PHP_FUNCTION(hello_null);





config.m4ファイルに変更を加えていないため、技術的にはphpizeと./configureの手順を繰り返す必要はありませんが、すぐにmakeコマンドの実行に進むことができます。 ただし、今回は、問題がないことを確認するために、3つすべてのアセンブリ手順を再度実行するようにお願いします。 さらに、最後の手順として、 makeの代わりにmake clean all コマンドを使用して、すべてのソースファイルが再構築されるようにすることができます。 繰り返したが、これはあなたが行った変更の種類のために必要ではないが、エラーに遭遇するよりも安全にプレイする方が良い。 モジュールがアセンブルされたら、それを拡張ディレクトリにコピーして、古いバージョンに置き換えるだけです。



これで、PHPインタープリターを再度呼び出して、追加した機能をテストするために単純なスクリプトを渡すことができます。 実際に-今すぐやってみませんか？ ここであなたを待っています...



終わった？ いいね echoではなくvar_dumpを使用して各関数の結果を表示した場合、 hello_boolがTRUEを返すことに気づいたかもしれません。 これは、関数の引数の1つの引数が等しい結果です。 PHPスクリプトの場合のように、整数値0はFALSEと同等であり、その他の数値はTRUEと同等です。 拡張機能の作成者は、多くの場合、この番号が1である契約を使用します。ただし、この契約を順守することが望ましいですが、必須ではありません。 さらに、 RETURN_TRUEおよびRETURN_FALSEマクロはより便利に使用できます。 以下は、 RETURN_TRUEマクロを使用したhello_bool関数の例です 。

PHP_FUNCTION(hello_bool)

{

RETURN_TRUE;

}





マクロを呼び出すときに括弧が使用されていないことに注意してください。 この点で、マクロRETURN_TRUEとRETURN_FALSEは、 RETURN_ *ファミリーの残りのマクロとは異なるため、注意してください。



前のすべての例で、結果のコピーを作成するパラメーターを渡さないことに気づいたかもしれません。 この理由は、このような単純なスカラー量の場合、追加のメモリは必要ないか、解放されないためです。



さらに3つの戻りタイプがあります。RESOURCE （たとえば、 mysql_connect 、 fsockopenまたはftp_connectによって返されます）、 ARRAY （別名HASH ）、およびOBJECT （ 新しいキーワードによって返されます）。 それらについては後で説明します。

Ini設定

Zend Engineは、INIデータを操作するための2つのアプローチを提供します。 ここで、最も単純なものを検討し、グローバル変数に慣れてから、より一般的なものに戻ります。



拡張用のphp.iniファイルでhello.greeting設定を宣言するとします。これには、 hello_world関数による出力の値が含まれます。 これを行うには、 hello_module_entry構造変更の一部として、 hello.cおよびphp_hello.hファイルにいくつかの変更を追加する必要があります 。 php_hello.hファイルのユーザー関数プロトタイプのリストの前に、次のプロトタイプを追加することから始めます。

PHP_MINIT_FUNCTION(hello);

PHP_MSHUTDOWN_FUNCTION(hello);



PHP_FUNCTION(hello_world);

PHP_FUNCTION(hello_long);

PHP_FUNCTION(hello_double);

PHP_FUNCTION(hello_bool);

PHP_FUNCTION(hello_null);





次に、 hello.cファイルを開き、 hello_module_entryの現在のバージョンを次のものに置き換えます。

zend_module_entry hello_module_entry = {

#if ZEND_MODULE_API_NO >= 20010901

STANDARD_MODULE_HEADER,

#endif

PHP_HELLO_WORLD_EXTNAME,

hello_functions,

PHP_MINIT(hello),

PHP_MSHUTDOWN(hello),

NULL,

NULL,

NULL,

#if ZEND_MODULE_API_NO >= 20010901

PHP_HELLO_WORLD_VERSION,

#endif

STANDARD_MODULE_PROPERTIES

};



PHP_INI_BEGIN()

PHP_INI_ENTRY( "hello.greeting" , "Hello World" , PHP_INI_ALL, NULL)

PHP_INI_END()



PHP_MINIT_FUNCTION(hello)

{

REGISTER_INI_ENTRIES();



return SUCCESS;

}



PHP_MSHUTDOWN_FUNCTION(hello)

{

UNREGISTER_INI_ENTRIES();



return SUCCESS;

}





ここで、 hello.cファイルの先頭に適切な#includeディレクティブを追加して、INIファイルを操作するためのヘッダーを取得する必要があります。

#ifdef HAVE_CONFIG_H

#include "config.h"

#endif



#include "php.h"

#include "php_ini.h"

#include "php_hello.h"





最後に行う必要があるのは、 hello_world関数を変更して、INI設定を使用するようにすることです。

PHP_FUNCTION(hello_world)

{

RETURN_STRING(INI_STR( "hello.greeting" ), 1);

}





INI_STRから取得した値のコピーを作成していることに注意してください。 その理由は、 INI_STRによって返される文字列は静的であるためです。 つまり、変更しようとすると、PHP環境が不安定になったり、クラッシュしたりする可能性があります。



この章で行われた変更の最初のセットは、 MINITおよびMSHUTDOWNという2つの新しいメソッドを既に知っているはずです 。 前述のように、これらのメソッドは、SAPIレイヤーの最初の起動時と、その作業を完了する過程でそれぞれ呼び出されます。 リクエスト中またはリクエスト間では呼び出されません。 この例では、拡張機能で宣言されたphp.iniファイルからエントリを登録するために使用されます。 これらの関数リソースにも、オブジェクトとストリームハンドラを登録できます。



hello_world関数では、 INI_STRマクロを使用して、 hello.greatingエントリの現在の値を文字列として取得します。 以下にリストされている整数値、浮動小数点値、ブール値を取得するための関数は他にもたくさんあります。 さらに、これらの関数には、拡張子がORIGの重複があります。これにより、 php.iniファイルに書き込まれた形式でレコードの値を取得できます （ .htaccessファイルまたはini_set関数を使用して変更する前）。

現在の値	元の値	種類
INI_STR（名前）	INI_ORIG_STR（名前）	Char *（NULL終了）
INI_INT（名前）	INI_ORIG_INT（名前）	長い署名
INI_FLT（名前）	INI_ORIG_FLT（名前）	二重署名
INI_BOOL（名前）	INI_ORIG_BOOL（名前）	Zend_bool

PHP_INI_ENTRY関数に移りましょう。 最初のパラメーターは、関心のあるphp.iniファイルのエントリの名前を含む文字列です。 php.iniのエントリ名の衝突を避けるために、関数に名前を付けるときと同じ規則を使用する必要があります。名前は、拡張子の名前と一致するプレフィックスで始まる必要があります。 また、契約では、ピリオドは.iniファイルの元の構成名から拡張子名を分離する必要があると規定されています。 この場合、設定名はhello.greetingのようになります。

2番目のパラメーターは初期値で、値が数値であるかどうかに関係なく、常にchar *に設定されます。 これは、ファイル自体がテキストであるため、INIファイルのすべての設定が本質的にテキストであるという事実の結果です。 スクリプト内でINI_INT 、 INI_FLT、またはINI_BOOLマクロを後で使用すると、それらのタイプが変換されます。

3番目のパラメーターは、アクセスレベル修飾子です。 これは、特定のINI設定をいつどのように変更できるかを決定するビットマスクです。 register_globalsなどの一部の設定では、スクリプトが解決する機会が与えられる前のリクエスト処理の準備中にのみ意味があるため、 ini_set関数を使用してスクリプト内で値を変更することは許可されません。 allow_url_fopenなどのその他の設定は、ユーザーがini_setまたは.htaccessディレクティブを使用して変更することを許可しない管理設定です 。 このパラメーターのデフォルト値はPHP_INI_ALL値で、設定値はどこでも変更できることを示します。 PHP_INI_SYSTEM | PHP_INI_PERDIRの値も可能です。これは、設定値がphp.iniまたは.htaccessファイル内のディレクティブを介して、ini_set（）関数を介して変更できることを示します。 または、 PHP_INI_SYSTEM値が可能です。つまり、設定はphp.iniファイルでのみ変更でき 、他の場所では変更できません。



最後の4番目のパラメーターでは、 ini_set関数を使用して設定が変更されたときに呼び出されるコールバック関数を指定できます。 これにより、拡張機能は、設定を変更する条件をより完全に制御したり、新しい設定値に応じて対応する機能を呼び出すことができます。

グローバル変数

多くの場合、拡張機能は別のリクエストで変数を処理する必要があり、その値を同時に処理できる他のリクエストから独立しています。 マルチスレッドSAPIでは、これは非常に簡単に行えます。ソースファイルでグローバル変数を宣言し、必要なときに参照するだけです。 問題は、PHPはマルチスレッドWebサーバー（Apache 2やISSなど）で動作するように設計されているため、一方のスレッドで使用されるグローバル変数を他方のグローバル変数とは別に保存する必要があることです。 PHPは、 ZTS （Zend Thread Safety）と呼ばれることもあるTSRM （Thread Safe Resource Manager）抽象化レイヤーを使用することにより、このタスクを大幅に簡素化します。 実際、この記事ではTSRMの一部が既に使用されていますが、気づいていませんでした。 （今のところそれはあなたにとって難しすぎるので、それらを見つけようとしないでください）。



スレッドセーフグローバル変数を作成する最初の部分は、他のグローバル変数と同様に、宣言することです。 例として、初期値が0になるlong型のグローバル変数を1つ宣言します。hello_long関数が呼び出されるたびに、グローバル変数の値を増やしてその値を返します。

#define PHP_HELLO_H行の直後に、次のコードスニペットをphp_hello.hに追加します。

#ifdef ZTS

#include "TSRM.h"

#endif



ZEND_BEGIN_MODULE_GLOBALS(hello)

long counter;

ZEND_END_MODULE_GLOBALS(hello)



#ifdef ZTS

#define HELLO_G(v) TSRMG(hello_globals_id, zend_hello_globals *, v)

#else

#define HELLO_G(v) (hello_globals.v)

#endif





また、 RINITメソッドを使用する必要があるため、ヘッダーでプロトタイプを宣言する必要があります。

PHP_MINIT_FUNCTION(hello);

PHP_MSHUTDOWN_FUNCTION(hello);

PHP_RINIT_FUNCTION(hello);





hello.cファイルに移動して、インクルードブロックの後に次のコードを追加しましょう。

#ifdef HAVE_CONFIG_H

#include "config.h"

#endif



#include "php.h"

#include "php_ini.h"

#include "php_hello.h"



ZEND_DECLARE_MODULE_GLOBALS(hello)



PHP_RINIT（hello）を追加してhello_module_entryを変更します 。

zend_module_entry hello_module_entry = {

#if ZEND_MODULE_API_NO >= 20010901

STANDARD_MODULE_HEADER,

#endif

PHP_HELLO_WORLD_EXTNAME,

hello_functions,

PHP_MINIT(hello),

PHP_MSHUTDOWN(hello),

PHP_RINIT(hello),

NULL,

NULL,

#if ZEND_MODULE_API_NO >= 20010901

PHP_HELLO_WORLD_VERSION,

#endif

STANDARD_MODULE_PROPERTIES

};



そして、リクエストの開始時に初期化を処理する関数をいくつか追加するとともに、 MINIT関数を変更します。

static void php_hello_init_globals(zend_hello_globals *hello_globals)

{

}



PHP_RINIT_FUNCTION(hello)

{

HELLO_G(counter) = 0;



return SUCCESS;

}



PHP_MINIT_FUNCTION(hello)

{

ZEND_INIT_MODULE_GLOBALS(hello, php_hello_init_globals, NULL);



REGISTER_INI_ENTRIES();



return SUCCESS;

}





最後に、グローバル変数を追加してhello_long関数を変更できます。

PHP_FUNCTION(hello_long)

{

HELLO_G(counter)++;



RETURN_LONG(HELLO_G(counter));

}





php_hello.hファイルに加えた変更では、いくつかのマクロ-ZEND_BEGIN_MODULE_GLOBALSとZEND_END_MODULE_GLOBALSを使用しました。 彼らの助けにより、 zend_hello_globals構造体が定義され、long型の変数が1つ含まれています。 その後、 HELLO_Gマクロが定義されました。これにより、コンパイルモードに応じて（マルチスレッドの有無にかかわらず）スレッドプールから値を取得したり、グローバルスコープから値を取得したりできます。

hello.cファイルで、 ZEND_DECLARE_MODULE_GLBALSマクロを使用して、 zend_hello_globals構造体をグローバル（非スレッドセーフビルドの場合）またはストリームリソースプールのメンバーとして宣言しました。 拡張機能の作成者である私たちは、ZEがすべての作業を処理するため、このメカニズムについて考える必要はありません。 最後に、 ZEND_INIT_MODULE_GLOBALS関数を使用して、スレッドセーフなリソース識別子を割り当てます。

お気付きかもしれませんが、 php_hello_init_globals関数は実際には何もしません。 さらに、カウンターを0に初期化すると、 RINIT関数にあることが判明しました。 なんで？

この質問に答える鍵は、これらの関数が呼び出された瞬間にあります。 php_hello_init_globals関数は 、新しいプロセスまたはスレッドが開始されたときにのみ呼び出されます。 ただし、各プロセスは複数の要求を処理できるため、この関数を使用してカウンターを0に初期化することは、最初の要求に対してのみtrueになります。 同じプロセスへの後続のリクエストは、古いカウンタ値で引き続き機能するため、最初からレポートを開始することはありません。 リクエストごとにカウンタを0に初期化するために、 RINIT関数を使用しました。これは、既に読んだように、各スクリプト処理リクエストの前に呼び出されます。 少なくとも、対応するパラメーターZEND_INIT_MODULE_GLOBALSとしてNULLをinit関数に渡すと、スレッドサポートのないプラットフォームではセグメンテーションエラーが発生するため、 php_hello_init_globals関数をコードに含めました。

INI設定とグローバル変数

すでにご存知のように、 PHP_INI_ENTRY関数を使用して宣言されたphp.iniファイルの設定は文字列として読み取られ、必要に応じてINI_INT 、 INI_FLTおよびINI_BOOL関数を使用して他の形式に変換されます 。 ただし、スクリプトの実行中にいくつかの設定が頻繁に要求され、ファイルからの不要な読み取り操作が大量に発生する可能性があります。 幸いなことに、特定のデータ型にINI設定を保存し、設定値が変更されたときにのみ型変換を実行するようにZEに指示することができます。 作業中にこの可能性を確認するために、もう1つのINI設定を宣言します。今回はブール型で、現時点でカウンターをデクリメントするか増やすかを決定します。 p hp_hello.hの MODULE_GLOBALSブロックを次のように変更することから始めます。

ZEND_BEGIN_MODULE_GLOBALS(hello)

long counter;

zend_bool direction;

ZEND_END_MODULE_GLOBALS(hello)





次のステップは、 PHP_INI_BEGINブロックを変更してINI設定を宣言することです。

PHP_INI_BEGIN()

PHP_INI_ENTRY( "hello.greeting" , "Hello World" , PHP_INI_ALL, NULL)

STD_PHP_INI_ENTRY( "hello.direction" , "1" , PHP_INI_ALL, OnUpdateBool, direction, zend_hello_globals, hello_globals)

PHP_INI_END()





ここで、 init_globals関数の設定を初期化します。

static void php_hello_init_globals(zend_hello_globals *hello_globals)

{

hello_globals->direction = 1;

}





最後に、 hello_long関数のINI設定の値を使用して、カウンターの操作を選択します。

PHP_FUNCTION(hello_long)

{

if (HELLO_G(direction)) {

HELLO_G(counter)++;

} else {

HELLO_G(counter)--;

}



RETURN_LONG(HELLO_G(counter));

}





以上です！ STD_PHP_INI_ENTRYマクロの3番目のパラメーターとして渡されるOnUpdateBoolメソッド（メソッドはZEの一部）を使用して、 php.ini 、 .htaccessファイルから取得された設定値のタイプが、対応するTRUE / FALSE値にini_set関数を使用して自動的に変換されます。これをスクリプト内で直接取得できます。 STD_PHP_INI_ENTRY関数の最後の3つのパラメーターは、変更するグローバル変数、拡張機能のグローバル変数の構造、およびそれらが含まれるグローバル変数のコンテナーの名前をPHPに伝えます。

次は？

この記事では、値を返す関数をエクスポートし、INI設定をロードして処理し、リクエストの処理全体でそれらを保持する単純なPHP拡張の構造を調べました。



次の記事では、PHP変数の内部構造、それらのストレージと処理方法について見ていきます。 関数が呼び出されたときにプログラムからパラメーターを取得するために使用されるzend_parse_parameters関数を使用し、配列、オブジェクト、リソースなど、関数からより複雑な結果を返す方法を開きます。

PS

一部の場所では、翻訳はかなり自由な形式になっていますが、これは翻訳の難しさの結果であり、私はそれを完全に克服することはできませんでした。さらに、翻訳には、私に関係があると思われる小さな追加がいくつか含まれています。

この記事による拡張機能のビルドプロセスは、PHP 5.3.2のソースコードでテストされました。



で著者：このテーマに関するいくつかの記事がある1、2.1、2.2、3。4番目の記事は、明らかに、このテーマに焦点を当てた「PHPの拡張と埋め込み」の著者による出版物を考慮して、決して光を見ることはないでしょう。php.netで



Zend Engineについて読むこともできます。