変数の作成

概要

実行中のスクリプトによって「外部から」見える変数を新しく作成するには、 まず新しい zval コンテナを確保してそこに値を格納し、 それを Zend の内部シンボルテーブルに登録しなければなりません。 これは、変数を作成する際のお決まりの手順です。

zval *new_variable;   /* 新しいコンテナを確保して初期化します */ MAKE_STD_ZVAL(new_variable);   /* 型や値をここで設定します。これ以降の節を参照ください */   /* この変数を "new_variable_name" という名前でシンボルテーブルに登録します */ ZEND_SET_SYMBOL(EG(active_symbol_table), "new_variable_name", new_variable);   /* これで、$new_variable_name という名前でスクリプトからアクセスできるようになります */

マクロ MAKE_STD_ZVAL は、 ALLOC_ZVAL を使用して新しい zval コンテナを確保し、 INIT_ZVAL でそれを初期化します。 これを書いている時点の Zend の実装では、 初期化 というのは参照カウンタを 1 にして is_ref フラグをクリアすることを指します。 しかし、これは今後拡張される可能性があります。そのため、 ALLOC_ZVAL を直接使用するのではなく MAKE_STD_ZVAL を用いるようにしておくことが大切です。 実行速度を最適化したい場合 (そして、ここで明示的に zval コンテナを初期化する必要がない場合) は ALLOC_ZVAL を使用することも可能です。 しかし、データの整合性を保証できなくなるため、 この方法は推奨されません。

ZEND_SET_SYMBOL の役割は、新しい変数を Zend のシンボルテーブルに登録することです。このマクロは、 その値が既にシンボルテーブルに存在するかどうかを調べ、 もし存在すれば新しいシンボルを参照に変換します (古い zval コンテナが使用していたメモリは、 自動的に開放されます)。速度を気にする必要がない場合には この方法がお勧めです。メモリの使用量を抑えることができます。

ZEND_SET_SYMBOL は、マクロ EG 経由で Zend executor のグローバル変数を使用することに注意しましょう。 EG(active_symbol_table) を指定することで、 現在アクティブなシンボルテーブルを、アクティブなローカルスコープで扱えるようになります。 ローカルスコープは、その関数が関数内でコールされたかどうかによって異なります。

とにかく速度を最適化したい、メモリの消費量はあまり気にしない という場合には、同じ値が既存の変数に登録されているかどうかの チェックを省略することができます。その代わりに、 zend_hash_update() を使用して 強制的にシンボルテーブルに挿入します。

zval *new_variable;  /* 新しいコンテナを確保して初期化します */ MAKE_STD_ZVAL(new_variable);  /* 型や値をここで設定します。これ以降の節を参照ください */   /* この変数を "new_variable_name" という名前でシンボルテーブルに登録します */ zend_hash_update(     EG(active_symbol_table),     "new_variable_name",     strlen("new_variable_name") + 1,     &new_variable,     sizeof(zval *),     NULL );

上の例で作成された変数は、常にローカルスコープにあります。 つまり、その関数がコールされたコンテキスト内に存在するということです。 新しい変数をグローバルスコープに作成するにも同じメソッドを使用しますが、 別のシンボルテーブルを参照します。

zval *new_variable;       // 新しいコンテナを確保して初期化します MAKE_STD_ZVAL(new_variable);  // // 型や値をここで設定します //  // この変数を "new_variable_name" という名前でグローバルシンボルテーブルに登録します ZEND_SET_SYMBOL(&EG(symbol_table), "new_variable_name", new_variable);

注意: 変数 active_symbol_table はポインタですが、 symbol_table はそうではありません。 これは、 EG(active_symbol_table) および &EG(symbol_table) を ZEND_SET_SYMBOL へのパラメータとして使用する必要があるからです - ここにはポインタが必要です。

同様に、より効率的なバージョンとして、 シンボルテーブルの更新をハードコーディングすることもできます。

zval *new_variable;  // 新しいコンテナを確保して初期化します MAKE_STD_ZVAL(new_variable);  // // 型や値をここで設定します //  // この変数を "new_variable_name" という名前でグローバルシンボルテーブルに登録します zend_hash_update(     &EG(symbol_table),     "new_variable_name",     strlen("new_variable_name") + 1,     &new_variable,     sizeof(zval *),     NULL );

注意: グローバル変数は、実際には関数内からアクセスできないことにお気づきでしょう。 これは、PHP ソース内で global $global_variable; のようにローカルスコープにインポートしていないからです。

ZEND_FUNCTION(variable_creation) {     zval *new_var1, *new_var2;      MAKE_STD_ZVAL(new_var1);     MAKE_STD_ZVAL(new_var2);      ZVAL_LONG(new_var1, 10);     ZVAL_LONG(new_var2, 5);      ZEND_SET_SYMBOL(EG(active_symbol_table), "local_variable", new_var1);     ZEND_SET_SYMBOL(&EG(symbol_table), "global_variable", new_var2);      RETURN_NULL();  }

Long (整数型)

さあ、それではデータを変数に代入していきましょう。まずは long 型からです。long は PHP の整数型で、非常にシンプルな形式で保存されます。 この章の最初のほうで説明した zval.value コンテナの 構造を見てみましょう。long 型のデータは、共用体の lval フィールドに直接格納されることがおわかりでしょう。 long 型に対応する type の値は IS_LONG です ( 例46-10 を参照ください)。

zval *new_long;  MAKE_STD_ZVAL(new_long);  new_long->type = IS_LONG; new_long->value.lval = 10;

zval *new_long;  MAKE_STD_ZVAL(new_long); ZVAL_LONG(new_long, 10);

Double (浮動小数点型)

double 型は PHP の浮動小数点型で、long 型と同様に簡単に代入できます。 この値もまた共用体に直接格納されるからです。 zval.value コンテナで対応するメンバは dval です。また、対応する type は IS_DOUBLE となります。

zval *new_double;  MAKE_STD_ZVAL(new_double);  new_double->type = IS_DOUBLE; new_double->value.dval = 3.45;

zval *new_double;  MAKE_STD_ZVAL(new_double); ZVAL_DOUBLE(new_double, 3.45);

文字列

文字列についてはもう少し手間を掛けなければなりません。 先に説明したように、Zend の内部データ構造に関連付けられる すべての文字列は、Zend 自身のメモリ管理関数を使用して管理しなければなりません。 静的な文字列を参照したり、標準関数を使用して割り当てた文字列を使用することはできません。 文字列を代入するには、 zval.value コンテナの構造体 str にアクセスしなければなりません。 対応する type は IS_STRING です。

zval *new_string; char *string_contents = "This is a new string variable";  MAKE_STD_ZVAL(new_string);  new_string->type = IS_STRING; new_string->value.str.len = strlen(string_contents); new_string->value.str.val = estrdup(string_contents);

zval *new_string; char *string_contents = "This is a new string variable";  MAKE_STD_ZVAL(new_string); ZVAL_STRING(new_string, string_contents, 1);

ある場所で文字列を切り捨てたい場合、 あるいは文字列の長さが事前にわかっている場合は、 ZVAL_STRINGL(zval, string, length, duplicate) を使用して 新しい文字列の長さを明示的に指定することができます。 このマクロは ZVAL_STRING より高速に動作し、 バイナリセーフです。

空の文字列を作成するには、文字列の長さを 0 にしたうえで、中身に empty_string を使用します。

new_string->type = IS_STRING; new_string->value.str.len = 0; new_string->value.str.val = empty_string;

MAKE_STD_ZVAL(new_string); ZVAL_EMPTY_STRING(new_string);

論理型

論理型の作り方は long 型と同じです。ただ、type は IS_BOOL となります。 lval に指定できる値は 0 および 1 です。

zval *new_bool;  MAKE_STD_ZVAL(new_bool);  new_bool->type = IS_BOOL; new_bool->value.lval = 1;

配列

配列は、Zend の内部ハッシュテーブルに格納されます。 このハッシュテーブルにアクセスするには zend_hash_*() API を使用します。配列を作成するたびに、新しいハッシュテーブルの ハンドルが必要となります。これは、 zval.value コンテナのメンバ ht に格納されます。

単に配列を作成するためだけの API があります。これは非常に便利です。 新しい配列を開始するには、 array_init() をコールします。

zval *new_array;  MAKE_STD_ZVAL(new_array);  array_init(new_array);

配列に新しい要素を追加するには、 やりたいことに応じてさまざまな関数を使用できます。 表46-8 、 表46-9 および 表46-10 で、これらの関数について説明しています。これらの関数はすべて、 失敗した場合に FAILURE 、 成功した場合に SUCCESS を返します。

これらの関数はすべて、Zend 内部のハッシュ API を抽象化して使用しやすくしたものです。 もちろん、ハッシュ関数を直接使用することも可能です。例えば、すでに割り当て済みの zval コンテナを配列に挿入する場合などが考えられます。 これを行うには、連想配列の場合は zend_hash_update() ( 例46-11 を参照ください)、 数値添字配列の場合は zend_hash_index_update() ( 例46-12 を参照ください) を使用します。

zval *new_array, *new_element; char *key = "element_key";        MAKE_STD_ZVAL(new_array); MAKE_STD_ZVAL(new_element);  array_init(new_array);  ZVAL_LONG(new_element, 10);  if(zend_hash_update(new_array->value.ht, key, strlen(key) + 1, (void *)&new_element, sizeof(zval *), NULL) == FAILURE) {     // エラー処理をここで行います }

zval *new_array, *new_element; int key = 2;  MAKE_STD_ZVAL(new_array); MAKE_STD_ZVAL(new_element);  array_init(new_array);  ZVAL_LONG(new_element, 10);  if(zend_hash_index_update(new_array->value.ht, key, (void *)&new_element, sizeof(zval *), NULL) == FAILURE) {     // エラー処理をここで行います }

add_next_index_*() の機能をエミュレートするには、 これを使用します。

zend_hash_next_index_insert(ht, zval **new_element, sizeof(zval *), NULL)

注意: 関数から配列を返すには、まず array_init() を使用し、それ以降の操作は定義済み変数 return_value で行います (エクスポートする関数への引数として渡します。 呼び出しインターフェイスについての先ほどの議論を参照ください)。 ここで MAKE_STD_ZVAL を使用してはいけません。

Tip: 毎回 new_array->value.ht を書く手間を省くためには HASH_OF(new_array) を使用します。 これは、互換性やコーディングスタイルの観点からもお勧めです。

オブジェクト

オブジェクトは配列に変換できる (その逆も可能) ので、 PHP の配列と多くの共通点があるであろうことはお気づきでしょう。 オブジェクトを処理するには、同じようなハッシュ関数を使用しますが、 オブジェクトを作成する際には異なる API を使用します。

オブジェクトを初期化するには、関数 object_init() を使用します。

zval *new_object;  MAKE_STD_ZVAL(new_object);  if(object_init(new_object) != SUCCESS) {     // エラー処理をここで行います }

リソース

リソースは、PHP における特殊なデータ型です。 リソース (resources) は何らかの特定の型を表すわけではなく、 さまざまな情報を扱うための抽象化した方法を表しています。 リソースは、Zend の内部では特別なリストの中に保持されます。 リストの各エントリは、そのリソースが指すデータを表す型定義を持っています。 Zend は、内部でリソースを扱う際には、常にこれを使用します。 リソースに直接アクセスすることはできず、提供されている API を通じてアクセスしなければなりません。特定のリソースに対する 参照がすべて失われると、対応するシャットダウン関数がすぐにコールされます。

例えば、リソースは、 データベースへのリンクやファイル記述子を格納するために使用されます。 事実上の 標準実装となっているのは MySQL モジュールです。しかし、例えば Oracle モジュールのような その他のモジュールでもリソースを使用しています。

新しいリソースを作成するには、そのリソースを開放するためのハンドラを 登録しなければなりません。リソースにはあらゆる種類のデータを保存できるので、 Zend は、それが不要になった際にどのように開放するのかを知っておく必要があるのです。 これを実現するために、自分が作成したリソース開放ハンドラを Zend に登録します。これは、(手動・自動にかかわらず) リソースを開放することになった際に、Zend によってコールされます。 リソースハンドラを Zend に登録すると、そのリソースについての リソース型ハンドル が Zend から返されます。 このハンドルは、後でこの型のリソースにアクセスする際には常に必要となり、 たいていは拡張モジュール内のグローバルな静的変数として保存されます。 スレッドセーフであるかどうかについて心配する必要はありません。 なぜなら、リソースハンドラの登録は モジュールの初期化時に一度行うだけだからです。

リソースハンドラを登録するための Zend の関数は、次のように宣言されています。

ZEND_API int zend_register_list_destructors_ex(rsrc_dtor_func_t ld, rsrc_dtor_func_t pld, char *type_name, int module_number);

この関数には、二種類の異なるリソース破壊ハンドラを渡すことが可能です。 それぞれ、通常のリソース用のものと持続的なリソース用のものになります。 持続的なリソースとは、例えばデータベース接続などに使用されるものです。 リソースを登録する際には、これらのどちらかのハンドラを必ず指定しなければなりません。 もう一方のほうには、単に NULL を渡すようにします。

zend_register_list_destructors_ex() は、次のパラメータを受け取ります。

リソース破壊ハンドラ (通常版および持続的リソース版のどちらも) のプロトタイプは次のようになります。

void resource_destruction_handler(zend_rsrc_list_entry *rsrc TSRMLS_DC);

typedef struct _zend_rsrc_list_entry {           void *ptr;     int type;     int refcount;  } zend_rsrc_list_entry;

これでやるべきことがわかりました。Zend に登録したいリソースを、 実際に定義してみましょう。 ここでは、ふたつの整数型メンバからなる単純な構造体を考えます。 members:

typedef struct {           int resource_link;     int resource_type;  } my_resource;

void my_destruction_handler(zend_rsrc_list_entry *rsrc TSRMLS_DC) {      // たいていは void ポインタを構造体の型にキャストすることになるでしょう。      my_resource *my_rsrc = (my_resource *) rsrc->ptr;      // ここで、そのリソースに対して必要な作業を行います。たとえば     // ファイルやソケットを閉じたり、内部で新たに確保したメモリを開放したりなどです。     // もちろん、このリソース自身が使っているメモリを開放することも忘れないようにしましょう。      do_whatever_needs_to_be_done_with_the_resource(my_rsrc); }

ここまでで、

1. どんなリソースなのか

2. そのリソースを破壊する際のハンドラ

1. 拡張モジュール内のグローバル変数を作成し、 リソース ID を保持させる。必要に応じて、 これは全ての関数からアクセス可能となる

2. リソース名を定義する

3. リソース破壊ハンドラを記述する

4. そしてそのハンドラを登録する

// 拡張モジュール内のどこかで、登録したリソース用の変数を定義します。     // 'le' って何のことだって? 単に 'list entry' を略しただけです。     static int le_myresource;      // リソース名もどこかで定義しておくとよいでしょう。     #define le_myresource_name  "My type of resource"      [...]      // 実際にリソース破壊ハンドラを登録します。     void my_destruction_handler(zend_rsrc_list_entry *rsrc TSRMLS_DC) {          my_resource *my_rsrc = (my_resource *) rsrc->ptr;         do_whatever_needs_to_be_done_with_the_resource(my_rsrc);     }      [...]      PHP_MINIT_FUNCTION(my_extension) {          // 'module_number' は、PHP_MINIT_FUNCTION() 関数の         // 定義で既に提供されていることに注意しましょう。          le_myresource = zend_register_list_destructors_ex(my_destruction_handler, NULL, le_myresource_name, module_number);          // 別のリソースを登録したり、グローバル変数や定数を         // 初期化したりします。     }

実際に新しいリソースを登録するには、 zend_register_resource() 関数あるいは ZEND_REGISTER_RESOURE() マクロのいずれかを使用します。 これらはどちらも zend_list.h で定義されています。 それぞれの引数は一対一対応しているので、 将来の互換性を考えると常にマクロを使用するようにすることをお勧めします。

int ZEND_REGISTER_RESOURCE(zval *rsrc_result, void *rsrc_pointer, int rsrc_type);

新しいリソースを登録する際に実際には何が行われているのかというと、 まずそれが Zend の内部リストに挿入されます。そして、 結果は単に与えられた zval * コンテナに保存されます。

rsrc_id = zend_list_insert(rsrc_pointer, rsrc_type);           if (rsrc_result) {         rsrc_result->value.lval = rsrc_id;         rsrc_result->type = IS_RESOURCE;     }      return rsrc_id;

RETURN_RESOURCE(rsrc_id)

Zend はこれ以降、このリソースに対するすべての参照を管理できるようになります。 リソースへの参照がすべて失われると、リソースに対して事前に定義した デストラクタがすぐにコールされます。この設定の利点は、 あなたのモジュール内で発生するメモリリークを気にしなくてもすむということです。 呼び出し元スクリプトで割り当てているすべてのメモリはリソースを参照しています。 メモリが必要なくなったとスクリプトが判断した時点で、 Zend はすぐにそれを検出して通知してくれます。

さて、利用者がリソースを取得したあとで、 それをまたあなたの作成した関数に渡してきたとしましょう。 zval * コンテナ内の value.lval にはあなたのリソースのキーが含まれているので、 それを使用して次のマクロでリソースを取得することができます。 ZEND_FETCH_RESOURCE :

ZEND_FETCH_RESOURCE(rsrc, rsrc_type, rsrc_id, default_rsrc_id, resource_type_name, resource_type)

リソースをリストから強制的に削除するには、関数 zend_list_delete() を使用します。 また事前に割り当てた値への新たな参照を作成した場合 (例えば、デフォルトのデータベースリンクを再利用する場合) などは、強制的に参照カウンタを増加させることができます。 このような場合は、関数 zend_list_addref() を使用します。事前に割り当てたリソースエントリを探すには zend_list_find() を使用します。 これらの完全な API は、 zend_list.h で確認できます。

自動グローバル変数の作成のためのマクロ

先ほど説明したマクロに加え、 単純なグローバル変数を簡単に作成するためのマクロがあります。 これらは、例えばグローバルなフラグなどを作成する際に知っておくと便利です。 あまり行儀のよいやり方ではありませんが、 表46-12 で説明するマクロは まさにこの作業を行うためのものです。 これらは zval を確保する必要がありません。 単純に、変数名と値を渡すだけでいいのです。

定数の作成

Zend は (通常の変数ではなく) 真の定数の作成もサポートしています。 定数へのアクセスにはドル記号 ( $ ) の接頭辞が不要で、すべてのスコープで使用可能です。 例としては TRUE や FALSE などがあります。

独自の定数を作成するには、 表46-13 のマクロを使用します。 これらのマクロは、指定した名前と値の定数を作成します。

各定数に対して、フラグを指定することもできます。

• CONST_CS - この定数名は、大文字小文字を区別して扱われます。

• CONST_PERSISTENT - この定数は持続的に扱われ、この定数を保持しているプロセスが 終了した後も「忘れられる」ことはありません。

// "long" 型の新しい定数を登録します。      REGISTER_LONG_CONSTANT("NEW_MEANINGFUL_CONSTANT", 324, CONST_CS |      CONST_PERSISTENT);