# php_manual

id: uopz_get_mock
type: function
doc:
<comment>Description:</comment>
  Get the current mock for a class
  
  Returns the current mock for <strong>$class</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$class</strong>  The name of the mocked class.

<comment>Return:</comment>
  <info>mixed</info>  Either a string containing the name of the mock, or an object, or <info>null</info> if no mock has been
         set.

<comment>See Also:</comment>
   * <strong>uopz_set_mock()</strong>
   * <strong>uopz_unset_mock()</strong>


id: uopz_get_property
type: function
doc:
<comment>Description:</comment>
  Gets value of class or instance property
  
  Gets the value of a static class property, if <strong>$class</strong> is given, or the value of an instance
  property, if <strong>$instance</strong> is given.

<comment>Param:</comment>
  <info>string</info>  <strong>$class</strong>     The name of the class.
  <info>object</info>  <strong>$instance</strong>  The object instance.
  <info>string</info>  <strong>$property</strong>  The name of the property.

<comment>Return:</comment>
  <info>mixed</info>  Returns the value of the class or instance property, or <info>null</info> if the property is not
         defined.

<comment>See Also:</comment>
   * <strong>uopz_set_property()</strong>


id: uopz_get_return
type: function
doc:
<comment>Description:</comment>
  Gets a previous set return value for a function
  
  Gets the return value of the <strong>$function</strong> previously set by uopz_set_return.

<comment>Param:</comment>
  <info>string</info>  <strong>$class</strong>     The name of the class containing the function
  <info>string</info>  <strong>$function</strong>  The name of the function

<comment>Return:</comment>
  <info>mixed</info>  The return value or Closure previously set.


id: uopz_get_static
type: function
doc:
<comment>Description:</comment>
  Gets the static variables from function or method scope
  
  Gets the static variables from function or method scope.

<comment>Param:</comment>
  <info>string</info>  <strong>$class</strong>     The name of the class.
  <info>string</info>  <strong>$function</strong>  The name of the function or method.

<comment>Return:</comment>
  <info>array</info>  Returns an associative <info>array</info> of variable names mapped to their current values on success,
         or <info>null</info> if the function or method does not exist.

<comment>See Also:</comment>
   * <strong>uopz_set_static()</strong>


id: uopz_implement
type: function
doc:
<comment>Description:</comment>
  実行時にインターフェイスを実装させる
  
  <strong>$class</strong> に<strong>$interface</strong> を実装させます。

<comment>Param:</comment>
  <info>string</info>  <strong>$class</strong>      
  <info>string</info>  <strong>$interface</strong>  

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。


id: uopz_overload
type: function
doc:
<comment>Description:</comment>
  Overload a VM opcode
  
  Overloads the specified <strong>$opcode</strong> with the user defined function

<comment>Param:</comment>
  <info>int</info>       <strong>$opcode</strong>    A valid opcode, see constants for details of supported codes
  <info>Callable</info>  <strong>$callable</strong>  

<comment>Return:</comment>
  <info>void</info>  


id: uopz_redefine
type: function
doc:
<comment>Description:</comment>
  定数を再定義
  
  指定された <strong>$constant</strong> を <strong>$value</strong> として再定義します。

<comment>Param:</comment>
  <info>string</info>  <strong>$class</strong>     定数を含むクラスの名前
  <info>string</info>  <strong>$constant</strong>  定数名
  <info>mixed</info>   <strong>$value</strong>     定数の新しい値。定数のバリアブルに対して有効な型にする必要があります。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。


id: uopz_rename
type: function
doc:
<comment>Description:</comment>
  Rename a function at runtime
  
  Renames <strong>$function</strong> to <strong>$rename</strong>
  
  If both functions exist, this effectively swaps their names

<comment>Param:</comment>
  <info>string</info>  <strong>$class</strong>     The name of the class containing the function
  <info>string</info>  <strong>$function</strong>  The name of an existing function
  <info>string</info>  <strong>$rename</strong>    The new name for the function

<comment>Return:</comment>
  <info>void</info>  


id: uopz_restore
type: function
doc:
<comment>Description:</comment>
  Restore a previously backed up function
  
  Restore a previously backed up function

<comment>Param:</comment>
  <info>string</info>  <strong>$class</strong>     The name of the class containing the function to restore
  <info>string</info>  <strong>$function</strong>  The name of the function

<comment>Return:</comment>
  <info>void</info>  


id: uopz_set_hook
type: function
doc:
<comment>Description:</comment>
  Sets hook to execute when entering a function or method
  
  Sets a hook to execute when entering a function or method.

<comment>Param:</comment>
  <info>string</info>   <strong>$class</strong>     The name of the class.
  <info>string</info>   <strong>$function</strong>  The name of the function or method.
  <info>Closure</info>  <strong>$hook</strong>      A closure to execute when entering the function or method.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>uopz_get_hook()</strong>
   * <strong>uopz_unset_hook()</strong>


id: uopz_set_mock
type: function
doc:
<comment>Description:</comment>
  新しいオブジェクトを生成する際に、クラスの代わりにモックを使う
  
  <strong>$mock</strong> がクラス名を含んだ文字列だった場合、 <strong>$class</strong> の代わりにそれがインスタンス化されます。 <strong>$mock</strong>
  はオブジェクトであっても構いません。
  
  プロパティやメソッドに動的にアクセスした場合にだけ、 <strong>$mock</strong> オブジェクトを使います。 静的にアクセス
  した場合には、オリジナルの <strong>$class</strong> を使います。 後に示す 例 を参照ください。

<comment>Param:</comment>
  <info>string</info>  <strong>$class</strong>  モックで代替するクラスの名前
  <info>mixed</info>   <strong>$mock</strong>   モックとして使うクラス名を含む文字列。またはオブジェクト。 文字列を渡す場合、完全
                  修飾されたクラス名でなければいけません。 この場合、マジック定数 ::class を使うこと
                  を推奨します。

<comment>Return:</comment>
  <info>void</info>  値を返しません。

<comment>See Also:</comment>
   * <strong>uopz_get_mock()</strong>
   * <strong>uopz_unset_mock()</strong>


id: uopz_set_property
type: function
doc:
<comment>Description:</comment>
  Sets value of existing class or instance property
  
  Sets the value of an existing static class property, if <strong>$class</strong> is given, or the value of an
  instance property (regardless whether the instance property already exists), if <strong>$instance</strong> is
  given.

<comment>Param:</comment>
  <info>string</info>  <strong>$class</strong>     The name of the class.
  <info>object</info>  <strong>$instance</strong>  The object instance.
  <info>string</info>  <strong>$property</strong>  The name of the property.
  <info>mixed</info>   <strong>$value</strong>     The value to assign to the property.

<comment>Return:</comment>
  <info>void</info>  値を返しません。

<comment>See Also:</comment>
   * <strong>uopz_get_property()</strong>


id: uopz_set_return
type: function
doc:
<comment>Description:</comment>
  Provide a return value for an existing function
  
  Sets the return value of the <strong>$function</strong> to <strong>$value</strong>. If <strong>$value</strong> is a Closure and <strong>$execute</strong> is set, the
  Closure will be executed in place of the original function. It is possible to call the original
  function from the Closure.
  
  This function replaces uopz_rename.

<comment>Param:</comment>
  <info>string</info>  <strong>$class</strong>     The name of the class containing the function
  <info>string</info>  <strong>$function</strong>  The name of an existing function
  <info>mixed</info>   <strong>$value</strong>     The value the function should return. If a Closure is provided and the execute
                     flag is set, the Closure will be executed in place of the original function.
  <info>bool</info>    <strong>$execute</strong>   If true, and a Closure was provided as the value, the Closure will be executed
                     in place of the original function.

<comment>Return:</comment>
  <info>bool</info>  True if succeeded, false otherwise.


id: uopz_set_static
type: function
doc:
<comment>Description:</comment>
  Sets the static variables in function or method scope
  
  Sets the static variables in function or method scope.

<comment>Param:</comment>
  <info>string</info>  <strong>$class</strong>     The name of the class.
  <info>string</info>  <strong>$function</strong>  The name of the function or method.
  <info>array</info>   <strong>$static</strong>    The associative <info>array</info> of variable names mapped to their values.

<comment>Return:</comment>
  <info>void</info>  値を返しません。

<comment>See Also:</comment>
   * <strong>uopz_get_static()</strong>


id: uopz_undefine
type: function
doc:
<comment>Description:</comment>
  定数を未定義化
  
  実行時に定数を除去します。

<comment>Param:</comment>
  <info>string</info>  <strong>$class</strong>     <strong>$constant</strong> を含むクラスの名前
  <info>string</info>  <strong>$constant</strong>  既存の定数名

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。


id: uopz_unset_hook
type: function
doc:
<comment>Description:</comment>
  Removes previously set hook on function or method
  
  Removes the previously set hook on a function or method.

<comment>Param:</comment>
  <info>string</info>  <strong>$class</strong>     The name of the class.
  <info>string</info>  <strong>$function</strong>  The name of the function or method.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>uopz_set_hook()</strong>
   * <strong>uopz_get_hook()</strong>


id: uopz_unset_mock
type: function
doc:
<comment>Description:</comment>
  以前に設定したモックを削除する
  
  以前に <strong>$class</strong> で設定したモックを削除します。

<comment>Param:</comment>
  <info>string</info>  <strong>$class</strong>  モックで代替されているクラス。

<comment>Return:</comment>
  <info>void</info>  値を返しません。

<comment>See Also:</comment>
   * <strong>uopz_set_mock()</strong>
   * <strong>uopz_get_mock()</strong>


id: uopz_unset_return
type: function
doc:
<comment>Description:</comment>
  Unsets a previously set return value for a function
  
  Unsets the return value of the <strong>$function</strong> previously set by uopz_set_return.

<comment>Param:</comment>
  <info>string</info>  <strong>$class</strong>     The name of the class containing the function
  <info>string</info>  <strong>$function</strong>  The name of the function

<comment>Return:</comment>
  <info>bool</info>  True on success


id: urldecode
type: function
doc:
<comment>Description:</comment>
  URL エンコードされた文字列をデコードする
  
  与えられた文字列中のあらゆるエンコード文字 <return>%##</return> をデコードします。 プラス記号 ('<return>+</return>') は、スペース文
  字にデコードします。

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  デコードする文字列。

<comment>Return:</comment>
  <info>string</info>  デコードした文字列を返します。

<comment>See Also:</comment>
   * <strong>urlencode()</strong>
   * <strong>rawurlencode()</strong>
   * <strong>rawurldecode()</strong>
   * RFC 3986


id: urlencode
type: function
doc:
<comment>Description:</comment>
  文字列を URL エンコードする
  
  この関数は、URL の問い合わせ部分に使用する文字列のエンコードや 次のページへ変数を渡す際に便利で
  す。

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  エンコードする文字列。

<comment>Return:</comment>
  <info>string</info>  <return>-_.</return> を除くすべての非英数文字が % 記号 (<return>%</return>)に続く二桁の16進数で置き換えられ、 空白は + 記号
          (<return>+</return>)にエンコードされます。 同様の方法で、WWW のフォームからポストされたデータはエンコードさ
          れ、 <return>application/x-www-form-urlencoded</return> メディア型も同様です。歴史的な理由により、この関数
          は RFC 3986 エンコード( <strong>rawurlencode()</strong> を参照ください) とは異なり、 空白を + 記号にエン
          コードします。

<comment>See Also:</comment>
   * <strong>urldecode()</strong>
   * <strong>htmlentities()</strong>
   * <strong>rawurlencode()</strong>
   * <strong>rawurldecode()</strong>
   * RFC 3986


id: use_soap_error_handler
type: function
doc:
<comment>Description:</comment>
  SOAP エラーハンドラを使用するかどうかを設定する
  
  この関数は、SOAP サーバーで SOAP エラーハンドラを使用するかどうかを設定します。 それまでに設定され
  ていた値を返します。 <info>true</info> に設定すると、 <class>SoapServer</class> アプリケーションでのエラーの詳細が SOAP フォー
  ルトメッセージとしてクライアントに送信されます。 <info>false</info> の場合は PHP の標準エラーハンドラを使いま
  す。 デフォルトは、エラーを SOAP フォールトメッセージとしてクライアントに送信します。

<comment>Param:</comment>
  <info>bool</info>  <strong>$enable</strong>  <info>true</info> に設定すると、エラーの詳細をクライアントに送信します。

<comment>Return:</comment>
  <info>bool</info>  元の値を返します。

<comment>See Also:</comment>
   * <strong>set_error_handler()</strong>
   * <strong>set_exception_handler()</strong>


id: user_error
type: function
doc:
<comment>Description:</comment>
  trigger_error のエイリアス
  
  この関数は次の関数のエイリアスです。 <strong>trigger_error()</strong>.


id: usleep
type: function
doc:
<comment>Description:</comment>
  マイクロ秒単位で実行を遅延する
  
  指定したマイクロ秒数だけプログラムの実行を遅延させます。

<comment>Param:</comment>
  <info>int</info>  <strong>$microseconds</strong>  実行を停止するマイクロ秒数。マイクロ秒とは、一秒の百万分の一です。
                      
                      <return>1000000</return> より大きな値を指定すること (つまり、1秒以上スリープさせること) は、 オ
                      ペレーティングシステムによってはサポートしていないかもしれません。 その場合
                      は、<strong>sleep()</strong> を代わりに使ってください。
                      
                      スリープする時間は、わずかに長く (つまり、 <strong>$microseconds</strong> 以上に) なる可能性が
                      あります。 これは、システムの動作、 呼び出し処理に時間が掛かること、 およびシ
                      ステムタイマの精度が原因です。

<comment>Return:</comment>
  <info>void</info>  値を返しません。

<comment>See Also:</comment>
   * <strong>sleep()</strong>
   * <strong>time_nanosleep()</strong>
   * <strong>time_sleep_until()</strong>
   * <strong>set_time_limit()</strong>


id: usort
type: function
doc:
<comment>Description:</comment>
  ユーザー定義の比較関数を使用して、配列を値でソートする
  
  順序を決めるユーザー定義の比較関数により、 <strong>$array</strong> をその値でソートします。
  
  比較結果が等しくなる二つの要素があった場合、それらの並び順は保持されます。PHP 8.0.0 より前のバー
  ジョンでは、ソートした配列におけるそれらの並び順は不定でした。
  
  この関数は、
  <strong>$array</strong> パラメータの要素に対して新しいキーを割り当てます。
  その際、単純にキーを並べ替える代わりに、
  すでに割り当てられている既存のキーを削除してしまいます。

<comment>Param:</comment>
  <info>array</info>     <strong>$array</strong>     入力の配列。
  <info>callable</info>  <strong>$callback</strong>  比較関数は、最初の引数と二番目の引数の比較結果を返します。最初の引数のほうが
                       二番目の引数より大きい場合は正の整数を、二番目の引数と等しい場合はゼロを、そ
                       して二番目の引数より小さい場合は負の整数を返す必要があります。
                       
                       <info>float</info> のような 非整数 を比較関数が返すと、その返り値を内部的に <info>int</info> にキャスト
                       して使います。 つまり、<return>0.99</return> や <return>0.1</return> といった値は整数値 <return>0</return> にキャストされ、 値が
                       等しいとみなされます。

<comment>Return:</comment>
  <info>true</info>  常に <info>true</info> を返します。

<comment>See Also:</comment>
   * <strong>uasort()</strong>
   * <strong>uksort()</strong>
   * 配列ソート関数の比較


id: utf8_decode
type: function
doc:
<comment>Description:</comment>
  UTF-8 エンコードされた文字列を、ISO-8859-1 に変換し、表現できない文字を置換する
    
  
  この関数は、文字列 <strong>$string</strong> を <return>UTF-8</return> エンコードから <return>ISO-8859-1</return> へ変換します。 有効な <return>UTF-8</return> ではない
  文字列バイト、 および <return>ISO-8859-1</return> に存在しない <return>UTF-8</return> の文字 (つまり、<return>U+00FF</return> 以降のコードポイント)
  は、 <return>?</return> に置き換えられます。
  
  <return>ISO-8859-1</return> 文字エンコーディングを使っているとマークされている 多くの Web ページが、実際にはそれと
  似た <return>Windows-1252</return> を使っており、 Web ブラウザは <return>ISO-8859-1</return> Web ページを <return>Windows-1252</return> として解釈し
  ています。<return>Windows-1252</return> は <return>ISO-8859-1</return> のある制御文字の代わりに、ユーロ記号 (<return>€</return>) や curly quote (<return>“</return> <return>”</return>)
  を印字可能な文字として追加しています。 この関数はそうした <return>Windows-1252</return> 文字を正しく変換しません。
  <return>Windows-1252</return> の変換が必要な場合は、別の関数を使ってください。

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  UTF-8 エンコードされた文字列。

<comment>Return:</comment>
  <info>string</info>  <strong>$string</strong> を ISO-8859-1 に変換した結果を返します。

<comment>See Also:</comment>
   * <strong>utf8_encode()</strong>
   * <strong>mb_convert_encoding()</strong>
   * UConverter::transcode
   * <strong>iconv()</strong>


id: utf8_encode
type: function
doc:
<comment>Description:</comment>
  ISO-8859-1 文字列を UTF-8 に変換する
  
  この関数は、文字列 <strong>$string</strong> を <return>ISO-8859-1</return> エンコードから <return>UTF-8</return> へ変換します。
  
  この関数は、指定された文字列の現在の文字エンコーディングを推測しません。 代わりに、 ISO-8859-1
  ("Latin 1" とも呼ばれています) としてエンコードされていると解釈し、UTF-8 に変換します。 全てのバイ
  ト列は有効な ISO-8859-1 の文字列であるため、 この関数は決してエラーになりません。 しかし、異なるエ
  ンコーディングを意図していた場合、 有用な結果にはならないでしょう。
  
  <return>ISO-8859-1</return> 文字エンコーディングを使っているとマークされている 多くの Web ページが、実際にはそれと
  似た <return>Windows-1252</return> を使っており、 Web ブラウザは <return>ISO-8859-1</return> Web ページを <return>Windows-1252</return> として解釈し
  ています。<return>Windows-1252</return> は <return>ISO-8859-1</return> のある制御文字の代わりに、ユーロ記号 (<return>€</return>) や curly quote (<return>“</return> <return>”</return>)
  を印字可能な文字として追加しています。 この関数はそうした <return>Windows-1252</return> 文字を正しく変換しません。
  <return>Windows-1252</return> の変換が必要な場合は、別の関数を使ってください。

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  ISO-8859-1 形式の文字列。

<comment>Return:</comment>
  <info>string</info>  <strong>$string</strong> を UTF-8 に変換した結果を返します。

<comment>See Also:</comment>
   * <strong>utf8_decode()</strong>
   * <strong>mb_convert_encoding()</strong>
   * UConverter::transcode
   * <strong>iconv()</strong>


id: var_dump
type: function
doc:
<comment>Description:</comment>
  変数に関する情報をダンプする
    
  
  この関数は、指定した式に関してその型や値を含む構造化された情報を 返します。配列の場合、その構造を
  表示するために各値について再帰的に 探索されます。
  
  オブジェクトのすべての public、private および protected なプロパティが出力されます。ただし、そのオ
  ブジェクトが __debugInfo() メソッド を実装している場合は、その限りではありません。
  
  ブラウザに直接結果を出力する
  すべてのものと同様に、出力制御関数
  を使用してこの関数の出力をキャプチャーし、(例えば)文字列
  (<info>string</info>)に保存することが可能です。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>   ダンプしたい変数。
  <info>mixed</info>  <strong>$values</strong>  ダンプしたい追加の変数。

<comment>Return:</comment>
  <info>void</info>  値を返しません。

<comment>See Also:</comment>
   * <strong>print_r()</strong>
   * <strong>debug_zval_dump()</strong>
   * <strong>var_export()</strong>
   * __debugInfo()


id: var_export
type: function
doc:
<comment>Description:</comment>
  変数の文字列表現を出力または返す
    
  
  <strong>var_export()</strong> は、 渡された変数に関する構造化された情報を返します。この関数は <strong>var_dump()</strong> に似ていま
  すが、 返される表現が有効な PHP コードであるところが異なります。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>   エクスポートしたい変数
  <info>bool</info>   <strong>$return</strong>  使用されかつ <info>true</info> に設定された場合、<strong>var_export()</strong> は変数表現を出力する代わりに返し
                  ます。

<comment>Return:</comment>
  <info>string|null</info>  <strong>$return</strong> パラメータが使用され <info>true</info> と評価される場合、 変数表現を返します。そうでない場
               合、この関数は <info>null</info> を返します。

<comment>See Also:</comment>
   * <strong>print_r()</strong>
   * <strong>serialize()</strong>
   * <strong>var_dump()</strong>


id: var_representation
type: function
doc:
<comment>Description:</comment>
  Returns a short, readable, parsable string representation of a variable
  
  <strong>var_representation()</strong> (from the var_representation PECL) returns a string with structured
  information about the  given variable. It is similar to <strong>var_export()</strong> with differences in
  indentation, string escaping, and array representations.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  The variable to generate a representation of.
  <info>int</info>    <strong>$flags</strong>  Bitmask consisting of <info>VAR_REPRESENTATION_SINGLE_LINE</info>,
                 <info>VAR_REPRESENTATION_UNESCAPED</info>. The behaviour of these constants is described on the
                 var_representation constants page.

<comment>Return:</comment>
  <info>string</info>  Returns the variable representation.

<comment>See Also:</comment>
   * <strong>var_export()</strong>


id: variant
type: class
doc:
<comment>Description:</comment>
  VARIANT は、PHP の zval と同等の COM の値です。構造体形式になっており、 異なる型の値を含めることが
  可能です。COM 拡張モジュールが提供する variant クラスによって、PHP と COM の間のデータの受け渡しを
  制御できるように なります。


id: variant::__construct
type: function
doc:
<comment>Description:</comment>
  variant クラスのコンストラクタ
  
  新しい variant オブジェクトを構築します。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>     初期値。省略するか <info>null</info> を設定すると、VT_EMPTY オブジェクトが作成されます。
  <info>int</info>    <strong>$type</strong>      variant オブジェクトの型を指定します。 有効な値は  の <info>VT_XXX</info> のうちの一つです。
                    
                    PHP は参照渡しを自動で認識できます。 つまり、variant オブジェクトとして渡す必要
                    すらないということです。
                    
                    VARIANT 型に関する追加情報は、MSDN ライブラリを調べてください。
  <info>int</info>    <strong>$codepage</strong>  文字列をUnicodeに変換するのに使うコードページ。 詳細な情報は  クラスの同じ名前の
                    パラメータを参照ください。


id: variant_abs
type: function
doc:
<comment>Description:</comment>
  variant の絶対値を返す
  
  variant の絶対値を返します。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  variant。

<comment>Return:</comment>
  <info>variant</info>  <strong>$value</strong> の絶対値を返します。

<comment>See Also:</comment>
   * <strong>abs()</strong>


id: variant_add
type: function
doc:
<comment>Description:</comment>
  2 つの variant 値を「加算」し、結果を返す
  
  (MSDN ライブラリによる) 以下の規則に従い、 <strong>$left</strong> を <strong>$right</strong> に加算します。この規則は Visual Basic
  の規則と一致します。 Variant の加算規則もし～ならこのようにします両者ともに文字列型連結一方が文字
  列型で、もう一方が文字追加一方が数値で、もう一方が文字列追加両者ともに数値加算どちらか一方が
  NULLNULL が返される両者ともに空の値Integer 型が返される

<comment>Param:</comment>
  <info>mixed</info>  <strong>$left</strong>   左オペランド。
  <info>mixed</info>  <strong>$right</strong>  右オペランド。

<comment>Return:</comment>
  <info>variant</info>  結果を返します。

<comment>See Also:</comment>
   * <strong>variant_sub()</strong>


id: variant_and
type: function
doc:
<comment>Description:</comment>
  2 つの variant の論理積を計算し、結果を返す
  
  以下の表に基づいた論理 AND 処理を行います。通常の AND 操作とは 少し違いがあることに注意しましょ
  う。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$left</strong>   左オペランド。
  <info>mixed</info>  <strong>$right</strong>  右オペランド。

<comment>Return:</comment>
  <info>variant</info>  Variant の AND 規則<strong>$left</strong><strong>$right</strong>結果
           <info>true</info><info>true</info><info>true</info><info>true</info><info>false</info><info>false</info><info>true</info><info>null</info><info>null</info><info>false</info><info>true</info><info>false</info><info>false</info><info>false</info><info>false</info><info>false</info><info>null</info><info>false</info><info>null</info><info>true</info><info>null</info><info>null</info><info>false</info><info>false</info><info>null</info><info>null</info><info>null</info>

<comment>See Also:</comment>
   * <strong>variant_or()</strong>


id: variant_cast
type: function
doc:
<comment>Description:</comment>
  variant を、別の型の新しい variant に変換する
  
  この関数は、<strong>$variant</strong> のコピーを作成して、 それを指定した <strong>$type</strong> に強制的に変換します。
  
  この関数は、COM ライブラリの VariantChangeType() をラップしたものです。 詳細な情報は MSDN ライブラ
  リを参照ください。

<comment>Param:</comment>
  <info>variant</info>  <strong>$variant</strong>  variant。
  <info>int</info>      <strong>$type</strong>     <strong>$type</strong> は、定数 <info>VT_XXX</info> の中のひとつでなければなりません。

<comment>Return:</comment>
  <info>variant</info>  与えられた <strong>$type</strong> の variant を返します。

<comment>See Also:</comment>
   * <strong>variant_set_type()</strong>


id: variant_cat
type: function
doc:
<comment>Description:</comment>
  2 つの variant 値を連結し、その結果を返す
  
  <strong>$left</strong> と <strong>$right</strong> を連結し、その結果を返します。
  
  この関数は、理論上は <strong>$left</strong> <return>.</return> <strong>$right</strong> と等価です。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$left</strong>   左オペランド。
  <info>mixed</info>  <strong>$right</strong>  右オペランド。

<comment>Return:</comment>
  <info>variant</info>  連結した結果を返します。

<comment>See Also:</comment>
   * 文字列の連結演算子については 


id: variant_cmp
type: function
doc:
<comment>Description:</comment>
  2 つの variant を比較する
  
  <strong>$left</strong> と <strong>$right</strong> を比較します。
  
  この関数はスカラー値のみを比較します。配列や variant レコードは比較しません。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$left</strong>       左オペランド。
  <info>mixed</info>  <strong>$right</strong>      右オペランド。
  <info>int</info>    <strong>$locale_id</strong>  文字列の比較に使用する有効なロケール識別子です (これは文字列の比較に影響しま
                     す)。
  <info>int</info>    <strong>$flags</strong>      <strong>$flags</strong> は、以下のひとつあるいは複数の値を OR で組み合わせたもので、文字列の比較
                     に影響します。 Variant の比較フラグ値意味<info>NORM_IGNORECASE</info>大文字小文字を区別せず
                     に比較する<info>NORM_IGNORENONSPACE</info>非スペーシング文字を無視する<info>NORM_IGNORESYMBOLS</info>記号
                     を無視する<info>NORM_IGNOREWIDTH</info>全角半角を区別しない<info>NORM_IGNOREKANATYPE</info>ひらがなカタカ
                     ナを区別しない<info>NORM_IGNOREKASHIDA</info>アラビア語の kashida 文字を無視する

<comment>Return:</comment>
  <info>int</info>  以下のいずれかを返します。 Variant の比較結果値意味<info>VARCMP_LT</info><strong>$left</strong> は <strong>$right</strong> より小さい
       <info>VARCMP_EQ</info><strong>$left</strong> は <strong>$right</strong> と等しい <info>VARCMP_GT</info><strong>$left</strong> は <strong>$right</strong> より大きい <info>VARCMP_NULL</info><strong>$left</strong> と
       <strong>$right</strong> のいずれか、あるいは両方が <info>null</info>


id: variant_date_from_timestamp
type: function
doc:
<comment>Description:</comment>
  Unix タイムスタンプを、日付形式の variant で返す
  
  unix タイムスタンプ値 <strong>$timestamp</strong> を <info>VT_DATE</info> 型の variant に変換します。 これにより、PHP の unix 的
  な部分と COM とのやりとりが容易になります。

<comment>Param:</comment>
  <info>int</info>  <strong>$timestamp</strong>  unix タイムスタンプ。

<comment>Return:</comment>
  <info>variant</info>  <info>VT_DATE</info> 型の variant を返します。

<comment>See Also:</comment>
   * <strong>variant_date_to_timestamp()</strong>
   * <strong>mktime()</strong>
   * <strong>time()</strong>


id: variant_date_to_timestamp
type: function
doc:
<comment>Description:</comment>
  日付/時刻の variant 値を Unix タイムスタンプに変換する
  
  <strong>$variant</strong> を、<info>VT_DATE</info> (あるいはそれに似た型) から Unix タイムスタンプに変換します。 これにより、PHP
  の Unix 的な部分と COM とのやりとりが容易になります。

<comment>Param:</comment>
  <info>variant</info>  <strong>$variant</strong>  variant。

<comment>Return:</comment>
  <info>int|null</info>  unix タイムスタンプを返します。 失敗時には <info>null</info> を返します。

<comment>See Also:</comment>
   * <strong>variant_date_from_timestamp()</strong>
   * <strong>date()</strong>
   * <strong>strftime()</strong>


id: variant_div
type: function
doc:
<comment>Description:</comment>
  2 つの variant の除算結果を返す
  
  <strong>$left</strong> を <strong>$right</strong> で割り、その結果を返します。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$left</strong>   左オペランド。
  <info>mixed</info>  <strong>$right</strong>  右オペランド。

<comment>Return:</comment>
  <info>mixed</info>  Variant の除算規則もし～ならこのようにします両者ともに文字列型・日付型・文字・論理型Double
         型を返す一方が文字列型で、もう一方が文字除算結果を double 型で返す一方が数値で、もう一方が
         文字列除算結果を double 型で返す両者ともに数値除算結果を double 型で返すどちらか一方が
         NULLNULL が返される<strong>$right</strong> が空の値で <strong>$left</strong> がそれ以外の型コード <info>DISP_E_DIVBYZERO</info> を持った
         <class>com_exception</class> がスローされる<strong>$left</strong> が空の値で <strong>$right</strong> がそれ以外の型double 型の 0 が返される
         両者ともに空の値コード <info>DISP_E_OVERFLOW</info> を持った <class>com_exception</class> がスローされる

<comment>See Also:</comment>
   * <strong>variant_idiv()</strong>


id: variant_eqv
type: function
doc:
<comment>Description:</comment>
  2 つの variant のビット値が等しいかどうかを調べる
  
  2 つの variant のビット値が等しいかどうかを調べます。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$left</strong>   左オペランド。
  <info>mixed</info>  <strong>$right</strong>  右オペランド。

<comment>Return:</comment>
  <info>variant</info>  <strong>$left</strong> の各ビットが <strong>$right</strong> の対応するビットに等しい場合に <info>true</info> を、それ以外の場合に <info>false</info>
           を返します。


id: variant_fix
type: function
doc:
<comment>Description:</comment>
  variant の整数部を返す
  
  variant の整数部を取得します。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  variant。

<comment>Return:</comment>
  <info>variant</info>  <strong>$value</strong> が負の数の場合、variant の値以上の 最初の整数値を返します。それ以外の場合は <strong>$value</strong>
           の値の整数部分を返します。

<comment>See Also:</comment>
   * <strong>variant_int()</strong>
   * <strong>variant_round()</strong>
   * <strong>floor()</strong>
   * <strong>ceil()</strong>
   * <strong>round()</strong>


id: variant_get_type
type: function
doc:
<comment>Description:</comment>
  variant オブジェクトの型を返す
  
  variant オブジェクトの型を返します。

<comment>Param:</comment>
  <info>variant</info>  <strong>$variant</strong>  variant オブジェクト。

<comment>Return:</comment>
  <info>int</info>  この関数は、<strong>$variant</strong> の型を表す整数値を返します。 <strong>$variant</strong> は 、  あるいは  クラスのインスタ
       ンスです。 返される値は、<info>VT_XXX</info> 定数のいずれかと比較することが可能です。
       
       COM および DOTNET オブジェクトの返す値は、通常 <info>VT_DISPATCH</info> です。これらのクラスに対して この
       関数が動作する理由は、単に COM および DOTNET が VARIANT を 継承しているからというだけのことで
       す。

<comment>See Also:</comment>
   * <strong>variant_set_type()</strong>


id: variant_idiv
type: function
doc:
<comment>Description:</comment>
  variants を整数に変換し、除算の結果を返す
  
  <strong>$left</strong> および <strong>$right</strong> を 整数値に変換し、整数の除算を行います。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$left</strong>   左オペランド。
  <info>mixed</info>  <strong>$right</strong>  右オペランド。

<comment>Return:</comment>
  <info>variant</info>  Variant の整数除算規則もし～ならこのようにします両者ともに文字列型・日付型・文字・論理型
           除算結果を integer 型で返す一方が文字列型で、もう一方が文字除算一方が数値で、もう一方が文
           字列除算両者ともに数値除算どちらか一方が NULLNULL が返される両者ともに空の値<class>com_exception</class>
           コード <info>DISP_E_DIVBYZERO</info> がスローされる

<comment>See Also:</comment>
   * <strong>variant_div()</strong>


id: variant_imp
type: function
doc:
<comment>Description:</comment>
  2 つの variant のビット implication を行う
  
  ビットの implication 操作を行います。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$left</strong>   左オペランド。
  <info>mixed</info>  <strong>$right</strong>  右オペランド。

<comment>Return:</comment>
  <info>variant</info>  Variant Implication テーブル<strong>$left</strong><strong>$right</strong>結果
           <info>true</info><info>true</info><info>true</info><info>true</info><info>false</info><info>false</info><info>true</info><info>null</info><info>true</info><info>false</info><info>true</info><info>true</info><info>false</info><info>false</info><info>true</info><info>false</info><info>null</info><info>true</info><info>null</info><info>true</info><info>true</info><info>null</info><info>false</info><info>null</info><info>null</info><info>null</info><info>null</info>


id: variant_int
type: function
doc:
<comment>Description:</comment>
  variant の整数部を返す
  
  variant の整数部を返します。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  variant。

<comment>Return:</comment>
  <info>variant</info>  <strong>$value</strong> が負の数の場合、variant の値以上の 最初の整数値を返します。それ以外の場合は <strong>$value</strong>
           の値の整数部分を返します。

<comment>See Also:</comment>
   * <strong>variant_fix()</strong>
   * <strong>variant_round()</strong>
   * <strong>floor()</strong>
   * <strong>ceil()</strong>
   * <strong>round()</strong>


id: variant_mod
type: function
doc:
<comment>Description:</comment>
  2 つの variant の除算を行い、剰余を返す
  
  <strong>$left</strong> を <strong>$right</strong> で除算し、剰余を返します。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$left</strong>   左オペランド。
  <info>mixed</info>  <strong>$right</strong>  右オペランド。

<comment>Return:</comment>
  <info>variant</info>  除算の剰余を返します。

<comment>See Also:</comment>
   * <strong>variant_div()</strong>
   * <strong>variant_idiv()</strong>


id: variant_mul
type: function
doc:
<comment>Description:</comment>
  2 つの variant の乗算を行い、その結果を返す
  
  <strong>$left</strong> と <strong>$right</strong> の乗算を行います。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$left</strong>   左オペランド。
  <info>mixed</info>  <strong>$right</strong>  右オペランド。

<comment>Return:</comment>
  <info>variant</info>  Variant の乗算規則もし～ならこのようにします両者ともに文字列型・日付型・文字・論理型乗算
           一方が文字列型で、もう一方が文字乗算一方が数値で、もう一方が文字列乗算両者ともに数値乗算
           どちらか一方が NULLNULL が返される両者ともに空の値空の文字列が返される

<comment>See Also:</comment>
   * <strong>variant_div()</strong>
   * <strong>variant_idiv()</strong>


id: variant_neg
type: function
doc:
<comment>Description:</comment>
  variant の論理否定演算を行う
  
  <strong>$value</strong> の論理否定演算を行います。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  variant。

<comment>Return:</comment>
  <info>variant</info>  論理否定演算の結果を返します。


id: variant_not
type: function
doc:
<comment>Description:</comment>
  variant のビット否定演算を行う
  
  <strong>$value</strong> のビット否定演算を行い、その結果を返します。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  variant。

<comment>Return:</comment>
  <info>variant</info>  ビット否定演算の結果を返します。 <strong>$value</strong> が <info>null</info> の場合、 結果も <info>null</info> となります。


id: variant_or
type: function
doc:
<comment>Description:</comment>
  2 つの variant の論理和を計算する
  
  論理 OR 処理を行います。通常の OR 操作とは少し違いがあることに注意しましょう。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$left</strong>   左オペランド。
  <info>mixed</info>  <strong>$right</strong>  右オペランド。

<comment>Return:</comment>
  <info>variant</info>  Variant の OR 規則<strong>$left</strong><strong>$right</strong>結果
           <info>true</info><info>true</info><info>true</info><info>true</info><info>false</info><info>true</info><info>true</info><info>null</info><info>true</info><info>false</info><info>true</info><info>true</info><info>false</info><info>false</info><info>false</info><info>false</info><info>null</info><info>null</info><info>null</info><info>true</info><info>true</info><info>null</info><info>false</info><info>null</info><info>null</info><info>null</info><info>null</info>

<comment>See Also:</comment>
   * <strong>variant_and()</strong>
   * <strong>variant_xor()</strong>


id: variant_pow
type: function
doc:
<comment>Description:</comment>
  2 つの variant の累乗計算を行い、その結果を返す
  
  <strong>$left</strong> の <strong>$right</strong> 乗を返します。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$left</strong>   左オペランド。
  <info>mixed</info>  <strong>$right</strong>  右オペランド。

<comment>Return:</comment>
  <info>variant</info>  <strong>$left</strong> の <strong>$right</strong> 乗を返します。

<comment>See Also:</comment>
   * <strong>pow()</strong>


id: variant_round
type: function
doc:
<comment>Description:</comment>
  指定した桁で variant を丸める
  
  <strong>$value</strong> を、 <strong>$decimals</strong> で指定した桁で丸めた結果を返します。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>     variant。
  <info>int</info>    <strong>$decimals</strong>  小数点の位置。

<comment>Return:</comment>
  <info>variant|null</info>  丸めた結果を返します。 失敗した場合は <info>null</info> を返します。

<comment>See Also:</comment>
   * <strong>round()</strong>


id: variant_set
type: function
doc:
<comment>Description:</comment>
  variant オブジェクトに新しい値を代入する
  
  <strong>$value</strong> を variant に変換し、それを <strong>$variant</strong> オブジェクトに代入します。 新しい variant オブジェクト
  は作成されず、 <strong>$variant</strong> の元の値は開放されます。

<comment>Param:</comment>
  <info>variant</info>  <strong>$variant</strong>  variant。
  <info>mixed</info>    <strong>$value</strong>    

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: variant_set_type
type: function
doc:
<comment>Description:</comment>
  variant を「その場で」別の型に変換する
  
  この関数は <strong>variant_cast()</strong> に似ていますが、 「その場で」変換されるという点が異なります。新しい
  variant は 作成されません。この関数に渡すパラメータの意味は <strong>variant_cast()</strong> の場合と同じです。

<comment>Param:</comment>
  <info>variant</info>  <strong>$variant</strong>  variant。
  <info>int</info>      <strong>$type</strong>     

<comment>Return:</comment>
  <info>void</info>  値を返しません。

<comment>See Also:</comment>
   * <strong>variant_cast()</strong>
   * <strong>variant_get_type()</strong>


id: variant_sub
type: function
doc:
<comment>Description:</comment>
  左の variant から右の variant を引き、その結果を返す
  
  <strong>$right</strong> を <strong>$left</strong> から引きます。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$left</strong>   左オペランド。
  <info>mixed</info>  <strong>$right</strong>  右オペランド。

<comment>Return:</comment>
  <info>variant</info>  Variant の減算規則もし～ならこのようにします両者ともに文字列型減算一方が文字列型で、もう
           一方が文字減算一方が数値で、もう一方が文字列減算両者ともに数値減算どちらか一方が NULLNULL
           が返される両者ともに空の値空の文字列が返される

<comment>See Also:</comment>
   * <strong>variant_add()</strong>


id: variant_xor
type: function
doc:
<comment>Description:</comment>
  2 つの variant の排他的論理和を計算する
  
  排他的論理和を計算します。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$left</strong>   左オペランド。
  <info>mixed</info>  <strong>$right</strong>  右オペランド。

<comment>Return:</comment>
  <info>variant</info>  Variant の XOR 規則<strong>$left</strong><strong>$right</strong>結果
           <info>true</info><info>true</info><info>false</info><info>true</info><info>false</info><info>true</info><info>false</info><info>true</info><info>true</info><info>false</info><info>false</info><info>false</info><info>null</info><info>null</info><info>null</info>

<comment>See Also:</comment>
   * <strong>variant_or()</strong>
   * <strong>variant_and()</strong>


id: version_compare
type: function
doc:
<comment>Description:</comment>
  ふたつの "PHP 標準" バージョン番号文字列を比較する
  
  <strong>version_compare()</strong>は、ふたつの "PHP 標準" バージョン 番号文字列を比較します。
  
  この関数はまず、バージョン文字列の <return>_</return>, <return>-</return>, <return>+</return> をドット <return>.</return> で置き換えます。 さらに、数値でない部分の前
  後にドット <return>.</return> を追加します。 例えば '4.3.2RC1' は '4.3.2.RC.1' となります。 次に、左から右へ 各部分
  を比較していきます。特殊な文字列が含まれている場合は以下の順で 並べ替えます: <return>ここにないすべての文
  字列</return> \<  <return>dev</return> \< <return>alpha</return> =  <return>a</return> \< <return>beta</return> =  <return>b</return> \< <return>RC</return> =   <return>rc</return> \< <return>#</return> \< <return>pl</return> = <return>p</return> この方法により、'4.1' と
  '4.1.2' のようなバージョンの違いだけではなく PHP 固有の開発ステータスの違いも判断することが可能と
  なります。

<comment>Param:</comment>
  <info>string</info>       <strong>$version1</strong>  最初のバージョン番号。
  <info>string</info>       <strong>$version2</strong>  ふたつめのバージョン番号。
  <info>string|null</info>  <strong>$operator</strong>  オプションの演算子。 指定可能な演算子を以下に示します。 <return>\<</return>, <return>lt</return>, <return>\<=</return>, <return>le</return>, <return>&gt;</return>, <return>gt</return>, <return>&gt;=</return>, <return>ge</return>, <return>==</return>, <return>=</return>, <return>eq</return>, <return>!=</return>, <return>\<&gt;</return>, <return>ne</return>
                          
                          このパラメータは大文字小文字を区別するので、すべて小文字で指定しなければな
                          りません。

<comment>Return:</comment>
  <info>int|bool</info>  デフォルトでは、<strong>version_compare()</strong> の戻り値は 最初のバージョンが 2 番目のバージョンより小
            さい場合に <return>-1</return>、 同じ場合に <return>0</return>、そして 2 番目のバージョンのほうが小さい場合に <return>1</return> となりま
            す。
            
            オプションの引数 <strong>$operator</strong> を使用すると、 指定した演算子による関係を満たす場合に <info>true</info>、
            それ以外の場合に <info>false</info> を返すようになります。

<comment>See Also:</comment>
   * <strong>phpversion()</strong>
   * <strong>php_uname()</strong>
   * <strong>function_exists()</strong>


id: vfprintf
type: function
doc:
<comment>Description:</comment>
  フォーマットされた文字列をストリームに書き込む
  
  <strong>$format</strong> によって作成された文字列を <strong>$stream</strong> で指定したストリームに書き込みます。
  
  <strong>fprintf()</strong> と同様の動作をしますが、 可変引数ではなく引数の配列を受け取って処理します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  
  <info>string</info>    <strong>$format</strong>  0個以上のディレクティブで構成されるフォーマット文字列:
                      変換結果に直接コピーされる通常文字列 (<return>%</return> は除きます) と、変換仕様。 これらのい
                     ずれも、自分が持つパラメータを取得します。
                     
                     変換の仕様は、以下のプロトタイプに従います:
                     <return>%[argnum$][flags][width][.precision]specifier</return>.
                     
                     何番目の引数を変換の対象にするかを指定するために、 数値の後にドル記号 <return>$</return> を続け
                     ます。
                     
                     フラグ一覧フラグ説明<return>-</return> 与えられたフィールドの幅を左寄せにします。 右寄せがデフォ
                     ルトです。 <return>+</return> 正の数値の前に付ける <return>+</return> 符号です; デフォルトは、負の数にだけマイナ
                     スの符号が数値の前に付きます。 <return> </return>(space) スペースに変換される詰め物です。 これが
                     デフォルトです。 <return>0</return> 数値の左側を0埋めします。 <return>s</return> 指定子を使うと、 右側にも0埋めで
                     きます。 <return>'</return>(char) 指定された (char) で埋めます。
                     
                     (最小で)何文字がこの変換結果に含まれるかを数値で指定するか、 <return>*</return> を指定します。 <return>*</return>
                     を指定した場合、 指定子によってフォーマットされる値の前に、 幅を追加の数値とし
                     て指定します。
                     
                     ピリオド <return>.</return> の後に数値を続けるか、 <return>*</return> を続けますが、 その意味は指定子に依存しま
                     す: <return>e</return>, <return>E</return>, <return>f</return> と <return>F</return> 指定子の場合: 小数点の後に表示する桁数 (デフォルトでは、この値
                     は6です) <return>g</return>, <return>G</return>, <return>h</return>, <return>H</return> 指定子の場合: 表示する最大の有効桁数 <return>s</return> 指定子の場合: 文字列
                     を切り捨てる時点、つまり、文字列の最大の長さを設定します。   明示的に精度を指定
                     せず、ピリオドを指定した場合、精度は0として扱われます。 <return>*</return> を使った場合、 精度は
                     指定子によってフォーマットされる値の前に、 追加の数値として指定します。
                     
                     <return>e</return>, <return>E</return>, <return>f</return> と <return>F</return> 指定子の場合: 小数点の後に表示する桁数 (デフォルトでは、この値は
                     6です)
                     
                     <return>g</return>, <return>G</return>, <return>h</return>, <return>H</return> 指定子の場合: 表示する最大の有効桁数
                     
                     <return>s</return> 指定子の場合: 文字列を切り捨てる時点、つまり、文字列の最大の長さを設定しま
                     す。
                     
                     明示的に精度を指定せず、ピリオドを指定した場合、精度は0として扱われます。 <return>*</return> を
                     使った場合、 精度は指定子によってフォーマットされる値の前に、 追加の数値として
                     指定します。
                     
                     指定子の一覧指定子説明<return>%</return> 文字通り、パーセント文字です。 引数は不要です。 <return>b</return> 引数
                     は整数として扱われ、バイナリ値として表現されます。 <return>c</return> 引数は整数として扱われ、
                     ASCII文字として表現されます。 <return>d</return> 引数は整数として扱われ、(符号付き)10進数値とし
                     て表現されます。 <return>e</return> 引数は科学的記法で表現された値(e.g. 1.2e+2)として扱われま
                     す。 <return>E</return><return>e</return> 指定子に似ていますが、 大文字を使います(e.g. 1.2E+2) <return>f</return> 引数は小数として
                     扱われ、浮動小数点数値として表現されます(ロケールを考慮します)。 <return>F</return> 引数は小数と
                     して扱われ、浮動小数点数値として表現されます(ロケールを考慮しません)。 <return>g</return> 汎用
                     フォーマット  P を精度を表す、ゼロでない値とします。 精度が省略された場合、Pの
                     値は6です。 精度に0を指定した場合、Pの値は1になります。 この場合、 <return>E</return> 指定子の変
                     換結果は、 X乗になります。  P &gt; X ≥ −4 の場合、<return>E</return> 指定子の変換結果となり、精
                     度は、P − (X + 1) になります。 そうでない場合、<return>e</return> 指定子の変換結果となり、 精度
                     は、P - 1 になります。 <return>G</return><return>g</return> 指定子に似ていますが、 <return>E</return> と <return>f</return> を使います。 <return>h</return><return>g</return> 指定子
                     に似ていますが、 <return>F</return> を使います。 PHP 8.0.0 以降で利用可能です。 <return>H</return><return>g</return> 指定子に似て
                     いますが、 <return>E</return> と <return>F</return> を使います。 PHP 8.0.0 以降で利用可能です。 <return>o</return> 引数は整数とし
                     て扱われ、8進数値として表現されます。 <return>s</return> 引数は文字列として扱われ、文字列として
                     表現されます。 <return>u</return> 引数は整数として扱われ、符号なし10進数値として表現されます。 <return>x</return>
                     引数は整数として扱われ、16進数値(小文字)として表現されます。 <return>X</return> 引数は整数として
                     扱われ、16進数値(大文字)として表現されます。
                     
                     汎用フォーマット
                     
                     P を精度を表す、ゼロでない値とします。 精度が省略された場合、Pの値は6です。 精
                     度に0を指定した場合、Pの値は1になります。 この場合、 <return>E</return> 指定子の変換結果は、 X乗
                     になります。
                     
                     P &gt; X ≥ −4 の場合、<return>E</return> 指定子の変換結果となり、精度は、P − (X + 1) になりま
                     す。 そうでない場合、<return>e</return> 指定子の変換結果となり、 精度は、P - 1 になります。
                     
                     <return>c</return> 指定子はパディングと幅を無視します
                     
                     文字列と width 指定子を、1文字の表現に1バイト以上必要な文字セットと一緒に使おう
                     とすると、 期待しない結果になるかもしれません。
                     
                     値は、指定子の型に合うように強制されます: 型のハンドリング型指定子<info>string</info><return>s</return><info>int</info><return>d</return>,
                     <return>u</return>, <return>c</return>, <return>o</return>, <return>x</return>, <return>X</return>, <return>b</return><info>float</info><return>e</return>, <return>E</return>, <return>f</return>, <return>F</return>, <return>g</return>, <return>G</return>, <return>h</return>, <return>H</return>
  <info>array</info>     <strong>$values</strong>  

<comment>Return:</comment>
  <info>int</info>  出力された文字列の長さを返します。

<comment>See Also:</comment>
   * <strong>printf()</strong>
   * <strong>sprintf()</strong>
   * <strong>fprintf()</strong>
   * <strong>vprintf()</strong>
   * <strong>vsprintf()</strong>
   * <strong>sscanf()</strong>
   * <strong>fscanf()</strong>
   * <strong>number_format()</strong>
   * <strong>date()</strong>


id: virtual
type: function
doc:
<comment>Description:</comment>
  Apache サブリクエストを実行する
  
  <strong>virtual()</strong> は、<return>mod_include</return> の <return>\<!--#include virtual...--&gt;</return> と似ている Apache 用関数です。 この関数は、Apache サブリクエストを実行します。 CGI スクリプトまたは .shtml ファイル、Apache を通して解釈を行う 他のものがある場合にこの関数は有用です。 CGI スクリプトの場合、そのスクリプトは、有効な CGI ヘッダを生成する 必要があることに注意してください。 最低でも、<return>Content-Type</return> ヘッダを生成する必要があります。
  
  サブリクエストを実行するには、全てのバッファを終了、ブラウザへフラッシュし、 待機状態のヘッダも送
  信しておきます。
  
  この関数は、
  PHP が apache モジュールとしてインストールされた場合のみサポートされます。

<comment>Param:</comment>
  <info>string</info>  <strong>$uri</strong>  virtual コマンドが実行されるファイル

<comment>Return:</comment>
  <info>bool</info>  成功時は virtual コマンドの実行、失敗時は <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>apache_note()</strong>


id: vprintf
type: function
doc:
<comment>Description:</comment>
  フォーマットされた文字列を出力する
  
  <strong>$format</strong>に基づき文字列フォーマットされた文字列を出力します (フォーマットは <strong>sprintf()</strong> のドキュメント
  に既述されています)。
  
  <strong>printf()</strong> と動作は同じですが、可変長の引数ではなく、 配列を引数として受け取ります。

<comment>Param:</comment>
  <info>string</info>  <strong>$format</strong>  0個以上のディレクティブで構成されるフォーマット文字列:
                    変換結果に直接コピーされる通常文字列 (<return>%</return> は除きます) と、変換仕様。 これらのいず
                   れも、自分が持つパラメータを取得します。
                   
                   変換の仕様は、以下のプロトタイプに従います:
                   <return>%[argnum$][flags][width][.precision]specifier</return>.
                   
                   何番目の引数を変換の対象にするかを指定するために、 数値の後にドル記号 <return>$</return> を続けま
                   す。
                   
                   フラグ一覧フラグ説明<return>-</return> 与えられたフィールドの幅を左寄せにします。 右寄せがデフォル
                   トです。 <return>+</return> 正の数値の前に付ける <return>+</return> 符号です; デフォルトは、負の数にだけマイナスの
                   符号が数値の前に付きます。 <return> </return>(space) スペースに変換される詰め物です。 これがデフォ
                   ルトです。 <return>0</return> 数値の左側を0埋めします。 <return>s</return> 指定子を使うと、 右側にも0埋めできます。
                   <return>'</return>(char) 指定された (char) で埋めます。
                   
                   (最小で)何文字がこの変換結果に含まれるかを数値で指定するか、 <return>*</return> を指定します。 <return>*</return>
                   を指定した場合、 指定子によってフォーマットされる値の前に、 幅を追加の数値として
                   指定します。
                   
                   ピリオド <return>.</return> の後に数値を続けるか、 <return>*</return> を続けますが、 その意味は指定子に依存します:
                   <return>e</return>, <return>E</return>, <return>f</return> と <return>F</return> 指定子の場合: 小数点の後に表示する桁数 (デフォルトでは、この値は6で
                   す) <return>g</return>, <return>G</return>, <return>h</return>, <return>H</return> 指定子の場合: 表示する最大の有効桁数 <return>s</return> 指定子の場合: 文字列を切り
                   捨てる時点、つまり、文字列の最大の長さを設定します。   明示的に精度を指定せず、ピ
                   リオドを指定した場合、精度は0として扱われます。 <return>*</return> を使った場合、 精度は指定子に
                   よってフォーマットされる値の前に、 追加の数値として指定します。
                   
                   <return>e</return>, <return>E</return>, <return>f</return> と <return>F</return> 指定子の場合: 小数点の後に表示する桁数 (デフォルトでは、この値は6で
                   す)
                   
                   <return>g</return>, <return>G</return>, <return>h</return>, <return>H</return> 指定子の場合: 表示する最大の有効桁数
                   
                   <return>s</return> 指定子の場合: 文字列を切り捨てる時点、つまり、文字列の最大の長さを設定します。
                   
                   明示的に精度を指定せず、ピリオドを指定した場合、精度は0として扱われます。 <return>*</return> を
                   使った場合、 精度は指定子によってフォーマットされる値の前に、 追加の数値として指
                   定します。
                   
                   指定子の一覧指定子説明<return>%</return> 文字通り、パーセント文字です。 引数は不要です。 <return>b</return> 引数は
                   整数として扱われ、バイナリ値として表現されます。 <return>c</return> 引数は整数として扱われ、
                   ASCII文字として表現されます。 <return>d</return> 引数は整数として扱われ、(符号付き)10進数値として
                   表現されます。 <return>e</return> 引数は科学的記法で表現された値(e.g. 1.2e+2)として扱われます。 <return>E</return><return>e</return>
                   指定子に似ていますが、 大文字を使います(e.g. 1.2E+2) <return>f</return> 引数は小数として扱われ、浮
                   動小数点数値として表現されます(ロケールを考慮します)。 <return>F</return> 引数は小数として扱われ、
                   浮動小数点数値として表現されます(ロケールを考慮しません)。 <return>g</return> 汎用フォーマット  P
                   を精度を表す、ゼロでない値とします。 精度が省略された場合、Pの値は6です。 精度に
                   0を指定した場合、Pの値は1になります。 この場合、 <return>E</return> 指定子の変換結果は、 X乗になり
                   ます。  P &gt; X ≥ −4 の場合、<return>E</return> 指定子の変換結果となり、精度は、P − (X + 1) にな
                   ります。 そうでない場合、<return>e</return> 指定子の変換結果となり、 精度は、P - 1 になります。 <return>G</return><return>g</return>
                   指定子に似ていますが、 <return>E</return> と <return>f</return> を使います。 <return>h</return><return>g</return> 指定子に似ていますが、 <return>F</return> を使いま
                   す。 PHP 8.0.0 以降で利用可能です。 <return>H</return><return>g</return> 指定子に似ていますが、 <return>E</return> と <return>F</return> を使います。
                   PHP 8.0.0 以降で利用可能です。 <return>o</return> 引数は整数として扱われ、8進数値として表現されま
                   す。 <return>s</return> 引数は文字列として扱われ、文字列として表現されます。 <return>u</return> 引数は整数として扱
                   われ、符号なし10進数値として表現されます。 <return>x</return> 引数は整数として扱われ、16進数値(小
                   文字)として表現されます。 <return>X</return> 引数は整数として扱われ、16進数値(大文字)として表現さ
                   れます。
                   
                   汎用フォーマット
                   
                   P を精度を表す、ゼロでない値とします。 精度が省略された場合、Pの値は6です。 精度
                   に0を指定した場合、Pの値は1になります。 この場合、 <return>E</return> 指定子の変換結果は、 X乗にな
                   ります。
                   
                   P &gt; X ≥ −4 の場合、<return>E</return> 指定子の変換結果となり、精度は、P − (X + 1) になります。
                   そうでない場合、<return>e</return> 指定子の変換結果となり、 精度は、P - 1 になります。
                   
                   <return>c</return> 指定子はパディングと幅を無視します
                   
                   文字列と width 指定子を、1文字の表現に1バイト以上必要な文字セットと一緒に使おうと
                   すると、 期待しない結果になるかもしれません。
                   
                   値は、指定子の型に合うように強制されます: 型のハンドリング型指定子<info>string</info><return>s</return><info>int</info><return>d</return>, <return>u</return>,
                   <return>c</return>, <return>o</return>, <return>x</return>, <return>X</return>, <return>b</return><info>float</info><return>e</return>, <return>E</return>, <return>f</return>, <return>F</return>, <return>g</return>, <return>G</return>, <return>h</return>, <return>H</return>
  <info>array</info>   <strong>$values</strong>  

<comment>Return:</comment>
  <info>int</info>  出力された文字列の長さを返します。

<comment>See Also:</comment>
   * <strong>printf()</strong>
   * <strong>sprintf()</strong>
   * <strong>fprintf()</strong>
   * <strong>vsprintf()</strong>
   * <strong>vfprintf()</strong>
   * <strong>sscanf()</strong>
   * <strong>fscanf()</strong>
   * <strong>number_format()</strong>
   * <strong>date()</strong>


id: vsprintf
type: function
doc:
<comment>Description:</comment>
  フォーマットされた文字列を返す
  
  <strong>sprintf()</strong>と動作は同じですが、 可変長の引数ではなく配列を引数とします。

<comment>Param:</comment>
  <info>string</info>  <strong>$format</strong>  0個以上のディレクティブで構成されるフォーマット文字列:
                    変換結果に直接コピーされる通常文字列 (<return>%</return> は除きます) と、変換仕様。 これらのいず
                   れも、自分が持つパラメータを取得します。
                   
                   変換の仕様は、以下のプロトタイプに従います:
                   <return>%[argnum$][flags][width][.precision]specifier</return>.
                   
                   何番目の引数を変換の対象にするかを指定するために、 数値の後にドル記号 <return>$</return> を続けま
                   す。
                   
                   フラグ一覧フラグ説明<return>-</return> 与えられたフィールドの幅を左寄せにします。 右寄せがデフォル
                   トです。 <return>+</return> 正の数値の前に付ける <return>+</return> 符号です; デフォルトは、負の数にだけマイナスの
                   符号が数値の前に付きます。 <return> </return>(space) スペースに変換される詰め物です。 これがデフォ
                   ルトです。 <return>0</return> 数値の左側を0埋めします。 <return>s</return> 指定子を使うと、 右側にも0埋めできます。
                   <return>'</return>(char) 指定された (char) で埋めます。
                   
                   (最小で)何文字がこの変換結果に含まれるかを数値で指定するか、 <return>*</return> を指定します。 <return>*</return>
                   を指定した場合、 指定子によってフォーマットされる値の前に、 幅を追加の数値として
                   指定します。
                   
                   ピリオド <return>.</return> の後に数値を続けるか、 <return>*</return> を続けますが、 その意味は指定子に依存します:
                   <return>e</return>, <return>E</return>, <return>f</return> と <return>F</return> 指定子の場合: 小数点の後に表示する桁数 (デフォルトでは、この値は6で
                   す) <return>g</return>, <return>G</return>, <return>h</return>, <return>H</return> 指定子の場合: 表示する最大の有効桁数 <return>s</return> 指定子の場合: 文字列を切り
                   捨てる時点、つまり、文字列の最大の長さを設定します。   明示的に精度を指定せず、ピ
                   リオドを指定した場合、精度は0として扱われます。 <return>*</return> を使った場合、 精度は指定子に
                   よってフォーマットされる値の前に、 追加の数値として指定します。
                   
                   <return>e</return>, <return>E</return>, <return>f</return> と <return>F</return> 指定子の場合: 小数点の後に表示する桁数 (デフォルトでは、この値は6で
                   す)
                   
                   <return>g</return>, <return>G</return>, <return>h</return>, <return>H</return> 指定子の場合: 表示する最大の有効桁数
                   
                   <return>s</return> 指定子の場合: 文字列を切り捨てる時点、つまり、文字列の最大の長さを設定します。
                   
                   明示的に精度を指定せず、ピリオドを指定した場合、精度は0として扱われます。 <return>*</return> を
                   使った場合、 精度は指定子によってフォーマットされる値の前に、 追加の数値として指
                   定します。
                   
                   指定子の一覧指定子説明<return>%</return> 文字通り、パーセント文字です。 引数は不要です。 <return>b</return> 引数は
                   整数として扱われ、バイナリ値として表現されます。 <return>c</return> 引数は整数として扱われ、
                   ASCII文字として表現されます。 <return>d</return> 引数は整数として扱われ、(符号付き)10進数値として
                   表現されます。 <return>e</return> 引数は科学的記法で表現された値(e.g. 1.2e+2)として扱われます。 <return>E</return><return>e</return>
                   指定子に似ていますが、 大文字を使います(e.g. 1.2E+2) <return>f</return> 引数は小数として扱われ、浮
                   動小数点数値として表現されます(ロケールを考慮します)。 <return>F</return> 引数は小数として扱われ、
                   浮動小数点数値として表現されます(ロケールを考慮しません)。 <return>g</return> 汎用フォーマット  P
                   を精度を表す、ゼロでない値とします。 精度が省略された場合、Pの値は6です。 精度に
                   0を指定した場合、Pの値は1になります。 この場合、 <return>E</return> 指定子の変換結果は、 X乗になり
                   ます。  P &gt; X ≥ −4 の場合、<return>E</return> 指定子の変換結果となり、精度は、P − (X + 1) にな
                   ります。 そうでない場合、<return>e</return> 指定子の変換結果となり、 精度は、P - 1 になります。 <return>G</return><return>g</return>
                   指定子に似ていますが、 <return>E</return> と <return>f</return> を使います。 <return>h</return><return>g</return> 指定子に似ていますが、 <return>F</return> を使いま
                   す。 PHP 8.0.0 以降で利用可能です。 <return>H</return><return>g</return> 指定子に似ていますが、 <return>E</return> と <return>F</return> を使います。
                   PHP 8.0.0 以降で利用可能です。 <return>o</return> 引数は整数として扱われ、8進数値として表現されま
                   す。 <return>s</return> 引数は文字列として扱われ、文字列として表現されます。 <return>u</return> 引数は整数として扱
                   われ、符号なし10進数値として表現されます。 <return>x</return> 引数は整数として扱われ、16進数値(小
                   文字)として表現されます。 <return>X</return> 引数は整数として扱われ、16進数値(大文字)として表現さ
                   れます。
                   
                   汎用フォーマット
                   
                   P を精度を表す、ゼロでない値とします。 精度が省略された場合、Pの値は6です。 精度
                   に0を指定した場合、Pの値は1になります。 この場合、 <return>E</return> 指定子の変換結果は、 X乗にな
                   ります。
                   
                   P &gt; X ≥ −4 の場合、<return>E</return> 指定子の変換結果となり、精度は、P − (X + 1) になります。
                   そうでない場合、<return>e</return> 指定子の変換結果となり、 精度は、P - 1 になります。
                   
                   <return>c</return> 指定子はパディングと幅を無視します
                   
                   文字列と width 指定子を、1文字の表現に1バイト以上必要な文字セットと一緒に使おうと
                   すると、 期待しない結果になるかもしれません。
                   
                   値は、指定子の型に合うように強制されます: 型のハンドリング型指定子<info>string</info><return>s</return><info>int</info><return>d</return>, <return>u</return>,
                   <return>c</return>, <return>o</return>, <return>x</return>, <return>X</return>, <return>b</return><info>float</info><return>e</return>, <return>E</return>, <return>f</return>, <return>F</return>, <return>g</return>, <return>G</return>, <return>h</return>, <return>H</return>
  <info>array</info>   <strong>$values</strong>  

<comment>Return:</comment>
  <info>string</info>  <strong>$format</strong> に基づき、 フォーマットされた文字列の配列を返します。

<comment>See Also:</comment>
   * <strong>printf()</strong>
   * <strong>sprintf()</strong>
   * <strong>fprintf()</strong>
   * <strong>vprintf()</strong>
   * <strong>vfprintf()</strong>
   * <strong>sscanf()</strong>
   * <strong>fscanf()</strong>
   * <strong>number_format()</strong>
   * <strong>date()</strong>


id: wddx_add_vars
type: function
doc:
<comment>Description:</comment>
  指定した ID の WDDX パケットに変数を追加する
  
  渡された変数をシリアライズし、 指定したパケットに結果を追加します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$packet_id</strong>  <strong>wddx_packet_start()</strong> が返す WDDX パケット。
  <info>mixed</info>     <strong>$var_name</strong>   変数名を表す文字列、あるいは配列。 配列の中身は、変数名を表す文字列あるいは
                        別の配列などとなります。
  <info>mixed</info>     <strong>$var_names</strong>  

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。


id: wddx_deserialize
type: function
doc:
<comment>Description:</comment>
  WDDX パケットをアンシリアライズする
  
  WDDX <strong>$packet</strong> をアンシリアライズします。
  
  信頼できないユーザーの入力を <strong>wddx_deserialize()</strong> 関数に渡してはいけません。 アンシリアライズ処理
  が、オブジェクトのインスタンス化とオートローディングのために、 コードをロードして実行してしまいか
  ねませんし、悪意のあるユーザーがこれを悪用できてしまいます。 シリアライズされた値をユーザーに渡す
  必要があるなら、 (<strong>json_decode()</strong> や <strong>json_encode()</strong> 経由で) JSON のような安全で、標準になっているデー
  タ交換フォーマットを使ってください。

<comment>Param:</comment>
  <info>string</info>  <strong>$packet</strong>  WDDX パケット。文字列あるいはストリームで指定します。

<comment>Return:</comment>
  <info>mixed</info>  アンシリアライズした値を返します。値は文字列か数値、あるいは配列のいずれかとなります。 構造
         体は連想配列に変換されることに注意しましょう。


id: wddx_packet_end
type: function
doc:
<comment>Description:</comment>
  指定した ID の WDDX パケットを終了する
  
  指定した WDDX パケットを終了し、 パケットを含む文字列を返します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$packet_id</strong>  <strong>wddx_packet_start()</strong> が返す WDDX パケット。

<comment>Return:</comment>
  <info>string</info>  WDDX パケットを含む文字列を返します。


id: wddx_packet_start
type: function
doc:
<comment>Description:</comment>
  新規の WDDX パケットを内部の構造体を用いて開始する
  
  変数を順に追加していくための新しい WDDX パケットを開始します。 この関数は、パケットの内部に自動的
  に構造体の定義を作成し、 そこに変数を保持します。

<comment>Param:</comment>
  <info>string</info>  <strong>$comment</strong>  オプションのコメント文字列。

<comment>Return:</comment>
  <info>resource</info>  後で他の関数で使用するためのパケット ID、あるいはエラー時に <info>false</info> を返します。


id: wddx_serialize_value
type: function
doc:
<comment>Description:</comment>
  単一の値を WDDX パケットにシリアライズする
  
  指定した単一の値をもとにして WDDX パケットを作成します。

<comment>Param:</comment>
  <info>mixed</info>   <strong>$var</strong>      シリアライズする値。
  <info>string</info>  <strong>$comment</strong>  オプションのコメント文字列。これはヘッダ内で用いられます。

<comment>Return:</comment>
  <info>string</info>  WDDX パケット、あるいはエラー時に <info>false</info> を返します。


id: wddx_serialize_vars
type: function
doc:
<comment>Description:</comment>
  変数を WDDX パケットにシリアライズする
  
  指定された変数をシリアライズしたものを含む構造体を用いて WDDX パケットを作成します。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$var_name</strong>   変数名を表す文字列、あるいは配列。 配列の中身は、変数名を表す文字列あるいは別の
                     配列などとなります。
  <info>mixed</info>  <strong>$var_names</strong>  

<comment>Return:</comment>
  <info>string</info>  WDDX パケット、あるいはエラー時に <info>false</info> を返します。


id: win32_continue_service
type: function
doc:
<comment>Description:</comment>
  中断したサービスを再開する
  
  指定した名前の、中断しているサービスを再開します。 管理者権限、 またはサービスのACLで適切な権限が
  設定されたアカウントが必要です。

<comment>Param:</comment>
  <info>string</info>  <strong>$servicename</strong>  サービスの短い名前。
  <info>string</info>  <strong>$machine</strong>      マシン名。省略可能で、省略した場合はローカルマシンを使います。

<comment>Return:</comment>
  <info>void</info>  値を返しません。
        
        バージョン 1.0.0 より前では、 成功した場合に <info>WIN32_NO_ERROR</info> を返していました。パラメータに問
        題がある場合は <info>false</info>、失敗した場合は Win32 エラーコード を返します。

<comment>See Also:</comment>
   * <strong>win32_start_service()</strong>
   * <strong>win32_stop_service()</strong>
   * <strong>win32_pause_service()</strong>
   * <strong>win32_send_custom_control()</strong>
   * Win32 エラーコード


id: win32_create_service
type: function
doc:
<comment>Description:</comment>
  SCM データベースに新しいサービスのエントリを作成する
  
  SCM データベースに新しいサービスの追加を試みます。 この操作を成功させるには、管理者権限が必要で
  す。

<comment>Param:</comment>
  <info>array</info>   <strong>$details</strong>                サービスの詳細情報を含む配列。 <strong>$service</strong> サービスの短い名前。<return>net</return> コ
                                  マンドでサービスを 制御する際に、この名前を使用します。この名前は
                                  一意である（同名の サービスが 2 つ存在することがない）必要があり、
                                  スペースを含む 名前は可能な限り避けるべきです。 <strong>$display</strong> サービス
                                  の表示名。これは、サービスアプレットに表示される名前です。
                                  <strong>$description</strong> サービスの長い名前。これは「サービス」アプレットで表
                                  示される名前です。 <strong>$user</strong> サービスを実行するユーザー名。指定しな
                                  かった場合、サービスは LocalSystem アカウントで実行されます。ユー
                                  ザー名が指定された場合、 password も指定する必要があります。
                                  <strong>$password</strong><strong>$user</strong> に対応するパスワード。 <strong>$path</strong> サービスの開始時に起動
                                  される実行モジュールのフルパス。 指定しなかった場合、現在の PHP プ
                                  ロセスへのパスが使用されます。 <strong>$params</strong> サービスの開始時に渡される
                                  コマンドラインパラメータ。 PHP スクリプトをサービスとして実行した
                                  い場合は、最初のパラメータは 実行するスクリプトへのフルパスとなり
                                  ます。 スクリプト名やパスにスペースを含む場合は、PHP スクリプトへ
                                  のフルパスを <return>"</return> で囲まなければなりません。 <strong>$load_order</strong> load_order
                                  を制御します。現時点では完全にはサポートされていません。 <strong>$svc_type</strong>
                                  サービスの型を指定します。指定しなかった場合、デフォルト値は
                                  <info>WIN32_SERVICE_WIN32_OWN_PROCESS</info> です。 よくわからない場合はこの値
                                  を変更しないでください。 <strong>$start_type</strong> サービスをどのように開始させ
                                  るかを指定します。デフォルトは <info>WIN32_SERVICE_AUTO_START</info> で、これは
                                  マシンの起動時にサービスを開始させることを意味します。
                                  <strong>$error_control</strong> サービスに問題が発生した際にとるべき行動を SCM に指
                                  示します。 デフォルトは <info>WIN32_SERVER_ERROR_IGNORE</info> です。 この値を
                                  変更することは、現時点では完全にはサポートされていません。
                                  <strong>$delayed_start</strong><strong>$delayed_start</strong> を <info>true</info> にすると、 他の自動起動サービ
                                  スが開始したあとで少し間をおいてサービスが起動するようになります。
                                  任意のサービスに対してこれを指定することができますが、そのサービス
                                  の <strong>$start_type</strong> が <info>WIN32_SERVICE_AUTO_START</info> でない場合は何の効果も
                                  及ぼしません。  この設定が使えるのは、Windows Vista および Windows
                                  Server 2008 以降のみです。 <strong>$base_priority</strong> プロセッサの使用状況への
                                  影響を考慮すると、 ベース優先度は通常より低めに設定しておかなけれ
                                  ばなりません。 <strong>$base_priority</strong> には、 Win32 ベース優先度クラス で定
                                  義された定数のいずれかを設定します。 <strong>$dependencies</strong> サービスへの依
                                  存性を定義します。 サービス名の一覧を配列として設定する必要がある
                                  かもしれません。 <strong>$recovery_delay</strong> 失敗時とリカバリアクションの実行
                                  の間に取る時間を定義します。 この値はマイクロ秒単位です。  デフォ
                                  ルトは 60000 です。 <strong>$recovery_action_1</strong> 最初の失敗時に実行されるア
                                  クションです。 デフォルトの値は <info>WIN32_SC_ACTION_NONE</info> です。
                                  <strong>$recovery_action_1</strong> は、  Win32 Recovery action で定義された定数の
                                  うちのひとつを設定できます。 <strong>$recovery_action_2</strong> 二回目の失敗時に実
                                  行されるアクションです。 デフォルトの値は <info>WIN32_SC_ACTION_NONE</info> で
                                  す。 <strong>$recovery_action_2</strong> は、  Win32 Recovery action で定義された定
                                  数のうちのひとつを設定できます。 <strong>$recovery_action_3</strong> 3回目以降の失
                                  敗時に実行されるアクションです。 デフォルトの値は
                                  <info>WIN32_SC_ACTION_NONE</info> です。 <strong>$recovery_action_3</strong> は、  Win32
                                  Recovery action で定義された定数のうちのひとつを設定できます。
                                  <strong>$recovery_reset_period</strong> ここで定義された時間が経過すると、失敗のカ
                                  ウンタがリセットされます。 秒単位で設定します。  デフォルト値は
                                  <return>86400</return> です。 <strong>$recovery_enabled</strong> リカバリ設定を有効にする場合は <info>true</info>
                                  を設定します。 無効にする場合は <info>false</info> を設定します。  デフォルトは
                                  <info>false</info> です。 <strong>$recovery_reboot_msg</strong> リブート時に Windows のイベント
                                  ログに記録されるメッセージを設定します。 アクションを
                                  <info>WIN32_SC_ACTION_REBOOT</info> に設定する場合にだけ使ってください。
                                  <strong>$recovery_command</strong> アクションが <info>WIN32_SC_ACTION_RUN_COMMAND</info> に設定
                                  された場合に、実行されるコマンドを設定します。
                                  
                                  サービスの短い名前。<return>net</return> コマンドでサービスを 制御する際に、この名
                                  前を使用します。この名前は一意である（同名の サービスが 2 つ存在す
                                  ることがない）必要があり、スペースを含む 名前は可能な限り避けるべ
                                  きです。
                                  
                                  サービスの表示名。これは、サービスアプレットに表示される名前です。
                                  
                                  サービスの長い名前。これは「サービス」アプレットで表示される名前で
                                  す。
                                  
                                  サービスを実行するユーザー名。指定しなかった場合、サービスは
                                  LocalSystem アカウントで実行されます。ユーザー名が指定された場合、
                                  password も指定する必要があります。
                                  
                                  <strong>$user</strong> に対応するパスワード。
                                  
                                  サービスの開始時に起動される実行モジュールのフルパス。 指定しな
                                  かった場合、現在の PHP プロセスへのパスが使用されます。
                                  
                                  サービスの開始時に渡されるコマンドラインパラメータ。 PHP スクリプ
                                  トをサービスとして実行したい場合は、最初のパラメータは 実行するス
                                  クリプトへのフルパスとなります。 スクリプト名やパスにスペースを含
                                  む場合は、PHP スクリプトへのフルパスを <return>"</return> で囲まなければなりませ
                                  ん。
                                  
                                  load_order を制御します。現時点では完全にはサポートされていませ
                                  ん。
                                  
                                  サービスの型を指定します。指定しなかった場合、デフォルト値は
                                  <info>WIN32_SERVICE_WIN32_OWN_PROCESS</info> です。 よくわからない場合はこの値
                                  を変更しないでください。
                                  
                                  サービスをどのように開始させるかを指定します。デフォルトは
                                  <info>WIN32_SERVICE_AUTO_START</info> で、これは マシンの起動時にサービスを開始
                                  させることを意味します。
                                  
                                  サービスに問題が発生した際にとるべき行動を SCM に指示します。 デ
                                  フォルトは <info>WIN32_SERVER_ERROR_IGNORE</info> です。 この値を変更すること
                                  は、現時点では完全にはサポートされていません。
                                  
                                  <strong>$delayed_start</strong> を <info>true</info> にすると、 他の自動起動サービスが開始したあ
                                  とで少し間をおいてサービスが起動するようになります。
                                  
                                  任意のサービスに対してこれを指定することができますが、そのサービス
                                  の <strong>$start_type</strong> が <info>WIN32_SERVICE_AUTO_START</info> でない場合は何の効果も
                                  及ぼしません。
                                  
                                  この設定が使えるのは、Windows Vista および Windows Server 2008 以
                                  降のみです。
                                  
                                  プロセッサの使用状況への影響を考慮すると、 ベース優先度は通常より
                                  低めに設定しておかなければなりません。
                                  
                                  <strong>$base_priority</strong> には、 Win32 ベース優先度クラス で定義された定数の
                                  いずれかを設定します。
                                  
                                  サービスへの依存性を定義します。 サービス名の一覧を配列として設定
                                  する必要があるかもしれません。
                                  
                                  失敗時とリカバリアクションの実行の間に取る時間を定義します。 この
                                  値はマイクロ秒単位です。
                                  
                                  デフォルトは 60000 です。
                                  
                                  最初の失敗時に実行されるアクションです。 デフォルトの値は
                                  <info>WIN32_SC_ACTION_NONE</info> です。
                                  
                                  <strong>$recovery_action_1</strong> は、  Win32 Recovery action で定義された定数の
                                  うちのひとつを設定できます。
                                  
                                  二回目の失敗時に実行されるアクションです。 デフォルトの値は
                                  <info>WIN32_SC_ACTION_NONE</info> です。
                                  
                                  <strong>$recovery_action_2</strong> は、  Win32 Recovery action で定義された定数の
                                  うちのひとつを設定できます。
                                  
                                  3回目以降の失敗時に実行されるアクションです。 デフォルトの値は
                                  <info>WIN32_SC_ACTION_NONE</info> です。
                                  
                                  <strong>$recovery_action_3</strong> は、  Win32 Recovery action で定義された定数の
                                  うちのひとつを設定できます。
                                  
                                  ここで定義された時間が経過すると、失敗のカウンタがリセットされま
                                  す。 秒単位で設定します。
                                  
                                  デフォルト値は <return>86400</return> です。
                                  
                                  リカバリ設定を有効にする場合は <info>true</info> を設定します。 無効にする場合
                                  は <info>false</info> を設定します。
                                  
                                  デフォルトは <info>false</info> です。
                                  
                                  リブート時に Windows のイベントログに記録されるメッセージを設定し
                                  ます。 アクションを <info>WIN32_SC_ACTION_REBOOT</info> に設定する場合にだけ
                                  使ってください。
                                  
                                  アクションが <info>WIN32_SC_ACTION_RUN_COMMAND</info> に設定された場合に、実行
                                  されるコマンドを設定します。
  <info></info>        <strong>$service</strong>                サービスの短い名前。<return>net</return> コマンドでサービスを 制御する際に、この名
                                  前を使用します。この名前は一意である（同名の サービスが 2 つ存在す
                                  ることがない）必要があり、スペースを含む 名前は可能な限り避けるべ
                                  きです。
  <info></info>        <strong>$display</strong>                サービスの表示名。これは、サービスアプレットに表示される名前です。
  <info></info>        <strong>$description</strong>            サービスの長い名前。これは「サービス」アプレットで表示される名前で
                                  す。
  <info></info>        <strong>$user</strong>                   サービスを実行するユーザー名。指定しなかった場合、サービスは
                                  LocalSystem アカウントで実行されます。ユーザー名が指定された場合、
                                  password も指定する必要があります。
  <info></info>        <strong>$password</strong>               <strong>$user</strong> に対応するパスワード。
  <info></info>        <strong>$path</strong>                   サービスの開始時に起動される実行モジュールのフルパス。 指定しな
                                  かった場合、現在の PHP プロセスへのパスが使用されます。
  <info></info>        <strong>$params</strong>                 サービスの開始時に渡されるコマンドラインパラメータ。 PHP スクリプ
                                  トをサービスとして実行したい場合は、最初のパラメータは 実行するス
                                  クリプトへのフルパスとなります。 スクリプト名やパスにスペースを含
                                  む場合は、PHP スクリプトへのフルパスを <return>"</return> で囲まなければなりませ
                                  ん。
  <info></info>        <strong>$load_order</strong>             load_order を制御します。現時点では完全にはサポートされていませ
                                  ん。
  <info></info>        <strong>$svc_type</strong>               サービスの型を指定します。指定しなかった場合、デフォルト値は
                                  <info>WIN32_SERVICE_WIN32_OWN_PROCESS</info> です。 よくわからない場合はこの値
                                  を変更しないでください。
  <info></info>        <strong>$start_type</strong>             サービスをどのように開始させるかを指定します。デフォルトは
                                  <info>WIN32_SERVICE_AUTO_START</info> で、これは マシンの起動時にサービスを開始
                                  させることを意味します。
  <info></info>        <strong>$error_control</strong>          サービスに問題が発生した際にとるべき行動を SCM に指示します。 デ
                                  フォルトは <info>WIN32_SERVER_ERROR_IGNORE</info> です。 この値を変更すること
                                  は、現時点では完全にはサポートされていません。
  <info></info>        <strong>$delayed_start</strong>          <strong>$delayed_start</strong> を <info>true</info> にすると、 他の自動起動サービスが開始したあ
                                  とで少し間をおいてサービスが起動するようになります。
                                  
                                  任意のサービスに対してこれを指定することができますが、そのサービス
                                  の <strong>$start_type</strong> が <info>WIN32_SERVICE_AUTO_START</info> でない場合は何の効果も
                                  及ぼしません。
                                  
                                  この設定が使えるのは、Windows Vista および Windows Server 2008 以
                                  降のみです。
  <info></info>        <strong>$base_priority</strong>          プロセッサの使用状況への影響を考慮すると、 ベース優先度は通常より
                                  低めに設定しておかなければなりません。
                                  
                                  <strong>$base_priority</strong> には、 Win32 ベース優先度クラス で定義された定数の
                                  いずれかを設定します。
  <info></info>        <strong>$dependencies</strong>           サービスへの依存性を定義します。 サービス名の一覧を配列として設定
                                  する必要があるかもしれません。
  <info></info>        <strong>$recovery_delay</strong>         失敗時とリカバリアクションの実行の間に取る時間を定義します。 この
                                  値はマイクロ秒単位です。
                                  
                                  デフォルトは 60000 です。
  <info></info>        <strong>$recovery_action_1</strong>      最初の失敗時に実行されるアクションです。 デフォルトの値は
                                  <info>WIN32_SC_ACTION_NONE</info> です。
                                  
                                  <strong>$recovery_action_1</strong> は、  Win32 Recovery action で定義された定数の
                                  うちのひとつを設定できます。
  <info></info>        <strong>$recovery_action_2</strong>      二回目の失敗時に実行されるアクションです。 デフォルトの値は
                                  <info>WIN32_SC_ACTION_NONE</info> です。
                                  
                                  <strong>$recovery_action_2</strong> は、  Win32 Recovery action で定義された定数の
                                  うちのひとつを設定できます。
  <info></info>        <strong>$recovery_action_3</strong>      3回目以降の失敗時に実行されるアクションです。 デフォルトの値は
                                  <info>WIN32_SC_ACTION_NONE</info> です。
                                  
                                  <strong>$recovery_action_3</strong> は、  Win32 Recovery action で定義された定数の
                                  うちのひとつを設定できます。
  <info></info>        <strong>$recovery_reset_period</strong>  ここで定義された時間が経過すると、失敗のカウンタがリセットされま
                                  す。 秒単位で設定します。
                                  
                                  デフォルト値は <return>86400</return> です。
  <info></info>        <strong>$recovery_enabled</strong>       リカバリ設定を有効にする場合は <info>true</info> を設定します。 無効にする場合
                                  は <info>false</info> を設定します。
                                  
                                  デフォルトは <info>false</info> です。
  <info></info>        <strong>$recovery_reboot_msg</strong>    リブート時に Windows のイベントログに記録されるメッセージを設定し
                                  ます。 アクションを <info>WIN32_SC_ACTION_REBOOT</info> に設定する場合にだけ
                                  使ってください。
  <info></info>        <strong>$recovery_command</strong>       アクションが <info>WIN32_SC_ACTION_RUN_COMMAND</info> に設定された場合に、実行
                                  されるコマンドを設定します。
  <info>string</info>  <strong>$machine</strong>                オプションで、サービスを作成したいマシン名を指定します。 指定しな
                                  かった場合は、ローカルマシンを使用します。

<comment>Return:</comment>
  <info>void</info>  値を返しません。
        
        バージョン 1.0.0 より前では、成功した場合に <info>WIN32_NO_ERROR</info> を返していました。パラメータに問
        題がある場合は <info>false</info>、失敗した場合は Win32 エラーコード を返します。

<comment>See Also:</comment>
   * <strong>win32_delete_service()</strong>
   * Win32 Base Priority Classes
   * Win32 Recovery action
   * Win32 Error Codes


id: win32_delete_service
type: function
doc:
<comment>Description:</comment>
  SCM データベースからサービスのエントリを削除する
  
  SCM データベースからサービスの削除を試みます。管理者権限が必要です。
  
  この関数は、単にサービスに削除マークをつけるだけです。もし他のプロセス （サービスアプレットなど）
  が開かれた場合、削除処理はそのアプリケーションが 終了するまで延期されます。サービスに削除マークが
  つけられると、それ以降は 同じサービスに対する削除の試行は失敗します。また同名の新規サービスを作成
  しようとする処理も失敗します。

<comment>Param:</comment>
  <info>string</info>  <strong>$servicename</strong>  サービスの短い名前。
  <info>string</info>  <strong>$machine</strong>      オプションのマシン名。指定しなかった場合、ローカルマシンが使用されます。

<comment>Return:</comment>
  <info>void</info>  値を返しません。
        
        バージョン 1.0.0 より前では、 成功した場合に <info>WIN32_NO_ERROR</info> を返していました。パラメータに問
        題がある場合は <info>false</info>、失敗した場合は Win32 エラーコード を返します。

<comment>See Also:</comment>
   * <strong>win32_create_service()</strong>
   * Win32 エラーコード


id: win32_get_last_control_message
type: function
doc:
<comment>Description:</comment>
  サービスに送信された直近の制御メッセージを返す
  
  サービスプロセスに送信された、直近の制御コードを返します。 サービスの実行中は、サービスを停止させ
  る必要がないかを調べるために 定期的にこれをチェックすべきです。
  
  0.2.0 以降では、この関数は "cli" SAPI でのみ動作します。 他の SAPI では、この関数は無効になってい
  ます。

<comment>Return:</comment>
  <info>int</info>  制御コード定数を返します。以下の Win32Service サービス制御メッセージ定数 のひとつです。
       <info>WIN32_SERVICE_CONTROL_CONTINUE</info>, <info>WIN32_SERVICE_CONTROL_DEVICEEVENT</info>,
       <info>WIN32_SERVICE_CONTROL_HARDWAREPROFILECHANGE</info>, <info>WIN32_SERVICE_CONTROL_INTERROGATE</info>,
       <info>WIN32_SERVICE_CONTROL_NETBINDADD</info>, <info>WIN32_SERVICE_CONTROL_NETBINDDISABLE</info>,
       <info>WIN32_SERVICE_CONTROL_NETBINDENABLE</info>, <info>WIN32_SERVICE_CONTROL_NETBINDREMOVE</info>,
       <info>WIN32_SERVICE_CONTROL_PARAMCHANGE</info>, <info>WIN32_SERVICE_CONTROL_PAUSE</info>,
       <info>WIN32_SERVICE_CONTROL_POWEREVENT</info>, <info>WIN32_SERVICE_CONTROL_PRESHUTDOWN</info>,
       <info>WIN32_SERVICE_CONTROL_SESSIONCHANGE</info>, <info>WIN32_SERVICE_CONTROL_SHUTDOWN</info>,
       <info>WIN32_SERVICE_CONTROL_STOP</info>。
       
       値が 128 から 255 の場合、制御コードはカスタムの値です。

<comment>See Also:</comment>
   * <strong>win32_start_service_ctrl_dispatcher()</strong>
   * <strong>win32_set_service_status()</strong>
   * <strong>win32_set_service_exit_mode()</strong>
   * <strong>win32_set_service_exit_code()</strong>
   * Win32Service サービス制御メッセージ定数


id: win32_pause_service
type: function
doc:
<comment>Description:</comment>
  サービスを中断する
  
  指定した名前のサービスを中断します。 管理者権限、 またはサービスのACLで適切な権限が設定されたアカ
  ウントが必要です。

<comment>Param:</comment>
  <info>string</info>  <strong>$servicename</strong>  サービスの短い名前。
  <info>string</info>  <strong>$machine</strong>      マシン名。省略可能で、省略した場合はローカルマシンを使います。

<comment>Return:</comment>
  <info>void</info>  値を返しません。
        
        バージョン 1.0.0 より前では、 成功した場合に <info>WIN32_NO_ERROR</info> を返していました。パラメータに問
        題がある場合は <info>false</info>、失敗した場合は Win32 エラーコード を返します。

<comment>See Also:</comment>
   * <strong>win32_start_service()</strong>
   * <strong>win32_stop_service()</strong>
   * <strong>win32_continue_service()</strong>
   * <strong>win32_send_custom_control()</strong>
   * Win32 エラーコード


id: win32_query_service_status
type: function
doc:
<comment>Description:</comment>
  サービスの状態を問い合わせる
  
  サービスの稼動状況を問い合わせ、情報を配列で返します。

<comment>Param:</comment>
  <info>string</info>  <strong>$servicename</strong>  サービスの短い名前。
  <info>string</info>  <strong>$machine</strong>      オプションのマシン名。指定しなかった場合、ローカルマシンが使用されます。

<comment>Return:</comment>
  <info>array</info>  成功した場合に以下の情報を含む配列を返します。
         
         バージョン 1.0.0 より前では、パラメータに問題がある場合は <info>false</info>、失敗した場合は Win32 エ
         ラーコード を返します。
         
         <strong>$ServiceType</strong> dwServiceType Win32Service サービス型のビットマスク を参照ください。
         <strong>$CurrentState</strong> dwCurrentState Win32Service サービスステータス定数 を参照ください。
         <strong>$ControlsAccepted</strong> サービスが許可しているコントロール。 Win32Service サービス制御メッセージ
         が受領されたときのビットマスク を参照ください。 <strong>$Win32ExitCode</strong> サービスが終了した際にプロセ
         スが返すコード。 この値は終了モードがgracefulでなかった場合、
         <info>WIN32_ERROR_SERVICE_SPECIFIC_ERROR</info> と同じです。 Win32Service エラーコード および
         <strong>win32_set_service_exit_mode()</strong> も参照ください。 <strong>$ServiceSpecificExitCode</strong> サービスが異常終了
         した際にイベントログに記録されるコード。 この値は <strong>win32_set_service_exit_code()</strong> で定義され
         た値と同じです。 <strong>$CheckPoint</strong> サービスが終了する際に、現在のチェックポイント番号を保持しま
         す。 SCM はこれをいわゆる心拍のように扱い、反応しなくなったサービスを 検出するために使用し
         ます。この値は、WaitHint の値と組み合わせて 用いられます。 <strong>$WaitHint</strong> サービスが終了する際
         に、WaitHint を checkpoint の値に設定します。 この処理が終了した時点でサービスの終了処理が
         100% 完了したことを示します。 これは、進捗状況のインジケータを実装する際に使用します。
         <strong>$ProcessId</strong> Windows のプロセス ID 。0 の場合、プロセスは実行していません。 <strong>$ServiceFlags</strong>
         dwServiceFlags Win32Service サービスフラグ定数 を参照ください。
         
         dwServiceType Win32Service サービス型のビットマスク を参照ください。
         
         dwCurrentState Win32Service サービスステータス定数 を参照ください。
         
         サービスが許可しているコントロール。 Win32Service サービス制御メッセージが受領されたときの
         ビットマスク を参照ください。
         
         サービスが終了した際にプロセスが返すコード。 この値は終了モードがgracefulでなかった場合、
         <info>WIN32_ERROR_SERVICE_SPECIFIC_ERROR</info> と同じです。 Win32Service エラーコード および
         <strong>win32_set_service_exit_mode()</strong> も参照ください。
         
         サービスが異常終了した際にイベントログに記録されるコード。 この値は
         <strong>win32_set_service_exit_code()</strong> で定義された値と同じです。
         
         サービスが終了する際に、現在のチェックポイント番号を保持します。 SCM はこれをいわゆる心拍の
         ように扱い、反応しなくなったサービスを 検出するために使用します。この値は、WaitHint の値と
         組み合わせて 用いられます。
         
         サービスが終了する際に、WaitHint を checkpoint の値に設定します。 この処理が終了した時点で
         サービスの終了処理が 100% 完了したことを示します。 これは、進捗状況のインジケータを実装する
         際に使用します。
         
         Windows のプロセス ID 。0 の場合、プロセスは実行していません。
         
         dwServiceFlags Win32Service サービスフラグ定数 を参照ください。

<comment>See Also:</comment>
   * Win32Service 定義済み定数


id: win32_send_custom_control
type: function
doc:
<comment>Description:</comment>
  Send a custom control to the service
  
  See Microsoft ControlService function for more details

<comment>Param:</comment>
  <info>string</info>  <strong>$servicename</strong>  The short name of the service.
  <info>int</info>     <strong>$control</strong>      The custom contole value between 128 and 255.
  <info>string</info>  <strong>$machine</strong>      Optional machine name.  If omitted, the local machine is used.

<comment>Return:</comment>
  <info>void</info>  値を返しません。
        
        Prior to version 1.0.0, 成功した場合に <info>WIN32_NO_ERROR</info> を返していました。パラメータに問題があ
        る場合は <info>false</info>、失敗した場合は Win32 エラーコード を返します。

<comment>See Also:</comment>
   * <strong>win32_start_service()</strong>
   * <strong>win32_stop_service()</strong>
   * <strong>win32_pause_service()</strong>
   * <strong>win32_continue_service()</strong>
   * Win32 Error Codes


id: win32_set_service_exit_code
type: function
doc:
<comment>Description:</comment>
  Define or return the exit code for the current running service
  
  Change or return the exit code. The exit code is used only if the exit mode is not graceful.  If
  the value is not zero, the recovery configuration can be used after  service fail. See  Microsoft
  system error codes  for more details
  
  This function work only in "cli" SAPI. On other SAPI  this function is disabled.

<comment>Param:</comment>
  <info>int</info>  <strong>$exitCode</strong>  The return code used on exit.

<comment>Return:</comment>
  <info>int</info>  Return the current or old exit code.

<comment>See Also:</comment>
   * <strong>win32_start_service_ctrl_dispatcher()</strong>
   * <strong>win32_set_service_status()</strong>
   * <strong>win32_set_service_exit_mode()</strong>


id: win32_set_service_exit_mode
type: function
doc:
<comment>Description:</comment>
  Define or return the exit mode for the current running service
  
  If <strong>$gracefulMode</strong> parameter is provided, the exit mode 
  is changed. When the exit mode is not gracefuly, the exit code used can be set 
  with the <strong>win32_set_service_exit_code()</strong> function.
  
  This function work only in "cli" SAPI. On other SAPI  this function is disabled.

<comment>Param:</comment>
  <info>bool</info>  <strong>$gracefulMode</strong>  <info>true</info> for exit graceful. <info>false</info> for exit with error.

<comment>Return:</comment>
  <info>bool</info>  Return the current or old exit mode.

<comment>See Also:</comment>
   * <strong>win32_start_service_ctrl_dispatcher()</strong>
   * <strong>win32_set_service_status()</strong>
   * <strong>win32_set_service_exit_code()</strong>


id: win32_set_service_status
type: function
doc:
<comment>Description:</comment>
  サービスの状態を更新する
  
  SCM に、実行中のサービスの現在の状態を通知します。 この関数のコールは、現在実行中のサービスについ
  てのみ有効です。
  
  バージョン 0.2.0 以降は、この関数は "cli" SAPI でのみ動作します。 他の SAPI では、この関数は無効に
  なっています。

<comment>Param:</comment>
  <info>int</info>  <strong>$status</strong>      以下のステータスコードのうちのひとつ。 <info>WIN32_SERVICE_RUNNING</info>、
                    <info>WIN32_SERVICE_STOPPED</info>、 <info>WIN32_SERVICE_STOP_PENDING</info>、
                    <info>WIN32_SERVICE_START_PENDING</info>、 <info>WIN32_SERVICE_CONTINUE_PENDING</info>、
                    <info>WIN32_SERVICE_PAUSE_PENDING</info>、 <info>WIN32_SERVICE_PAUSED</info>。
  <info>int</info>  <strong>$checkpoint</strong>  start, stop, pause や continue の操作がとても時間がかかる場合に、 その状態を報告
                    する目的で定期的にインクリメントされるチェックポイントの値。 たとえば、サービス
                    が起動中の場合は、 初期化のステップがひとつ終了するたびに、 この値をインクリメン
                    トすべきです。
                    
                    <strong>$checkpoint</strong> の値は、 <strong>$status</strong> が以下の場合のみ、正しい値です:
                    <info>WIN32_SERVICE_STOP_PENDING</info>, <info>WIN32_SERVICE_START_PENDING</info>,
                    <info>WIN32_SERVICE_CONTINUE_PENDING</info>, <info>WIN32_SERVICE_PAUSE_PENDING</info>.

<comment>Return:</comment>
  <info>void</info>  値を返しません。
        
        バージョン 1.0.0 より前では、成功した場合に <info>WIN32_NO_ERROR</info> を返していました。パラメータに問
        題がある場合は <info>false</info>、失敗した場合は Win32 エラーコード を返します。

<comment>See Also:</comment>
   * <strong>win32_start_service_ctrl_dispatcher()</strong>
   * <strong>win32_get_last_control_message()</strong>
   * <strong>win32_set_service_exit_mode()</strong>
   * <strong>win32_set_service_exit_code()</strong>
   * Win32Service サービスステータス定数


id: win32_start_service
type: function
doc:
<comment>Description:</comment>
  サービスを開始する
  
  指定したサービスの開始を試みます。 管理者権限、 またはサービスのACLで適切な権限が設定されたアカウ
  ントが必要です。

<comment>Param:</comment>
  <info>string</info>  <strong>$servicename</strong>  サービスの短い名前。
  <info>string</info>  <strong>$machine</strong>      オプションのマシン名。指定しなかった場合、ローカルマシンが使用されます。

<comment>Return:</comment>
  <info>void</info>  値を返しません。
        
        バージョン 1.0.0 より前では、 成功した場合に <info>WIN32_NO_ERROR</info> を返していました。パラメータに問
        題がある場合は <info>false</info>、失敗した場合は Win32 エラーコード を返します。

<comment>See Also:</comment>
   * <strong>win32_stop_service()</strong>
   * <strong>win32_pause_service()</strong>
   * <strong>win32_continue_service()</strong>
   * <strong>win32_send_custom_control()</strong>
   * Win32 エラーコード


id: win32_start_service_ctrl_dispatcher
type: function
doc:
<comment>Description:</comment>
  スクリプトを SCM に登録し、指定した名前でサービスとして稼動させる
     ようにする
    
  
  サービスコントロールマネージャ経由で起動させる際、サービスプロセスは 「チェックイン」を要求され、
  これによってサービスのモニタリングや 通信の機能を確立します。この関数は、サービスコントロールマ
  ネージャとの 低レベル通信を処理するスレッドを生成し、チェックインを実行します。
  
  サービスが開始したら、サービスプロセスで行わなければならないことは次のふたつです。 まず最初は、
  サービスが実行中であることをサービスコントロールマネージャに通知することです。 これは、
  <strong>win32_set_service_status()</strong> に定数 <info>WIN32_SERVICE_RUNNING</info> を指定してコールすれば実現できます。 サー
  ビスが実際に動き出すまでに何らかの長い処理を要する場合は、定数 <info>WIN32_SERVICE_START_PENDING</info> を使う
  こともできます。 もうひとつは、常にサービスコントロールマネージャにチェックインし続け、 サービスを
  いつ終了させるべきかを確認することです。 これは、定期的に <strong>win32_get_last_control_message()</strong> をコー
  ルして戻り値を適切に処理することで実現できます。
  
  0.2.0 以降では、この関数は "cli" SAPI でのみ動作します。 他の SAPI では、この関数は無効になってい
  ます。

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>          サービスの短い名前。<strong>win32_create_service()</strong> で登録されたもの。
  <info>bool</info>    <strong>$gracefulMode</strong>  <info>true</info> の場合、graceful に終了します。 <info>false</info> の場合、エラーで終了します。 詳
                         細は <strong>win32_set_service_exit_mode()</strong> を参照ください。

<comment>Return:</comment>
  <info>void</info>  値を返しません。
        
        バージョン 1.0.0 より前では、成功した場合に <info>WIN32_NO_ERROR</info> を返していました。パラメータに問
        題がある場合は <info>false</info>、失敗した場合は Win32 エラーコード を返します。

<comment>See Also:</comment>
   * <strong>win32_set_service_status()</strong>
   * <strong>win32_get_last_control_message()</strong>
   * <strong>win32_set_service_exit_mode()</strong>
   * <strong>win32_set_service_exit_code()</strong>
   * Win32 エラーコード


id: win32_stop_service
type: function
doc:
<comment>Description:</comment>
  サービスを停止する
  
  サービスを停止します。管理者権限、 またはサービスのACLで適切な権限が設定されたアカウントが必要で
  す。

<comment>Param:</comment>
  <info>string</info>  <strong>$servicename</strong>  サービスの短い名前。
  <info>string</info>  <strong>$machine</strong>      オプションのマシン名。指定しなかった場合、ローカルマシンが使用されます。

<comment>Return:</comment>
  <info>void</info>  値を返しません。
        
        バージョン 1.0.0 より前では、 成功した場合に <info>WIN32_NO_ERROR</info> を返していました。パラメータに問
        題がある場合は <info>false</info>、失敗した場合は Win32 エラーコード を返します。

<comment>See Also:</comment>
   * <strong>win32_start_service()</strong>
   * <strong>win32_pause_service()</strong>
   * <strong>win32_continue_service()</strong>
   * <strong>win32_send_custom_control()</strong>
   * Win32 エラーコード


id: wincache_fcache_fileinfo
type: function
doc:
<comment>Description:</comment>
  ファイルキャッシュにキャッシュされたファイルについての情報を取得する
    
  
  ファイルキャッシュの中身とその利用状況についての情報を取得します。

<comment>Param:</comment>
  <info>bool</info>  <strong>$summaryonly</strong>  返される配列に、ファイルキャッシュの概要に加えて個々のキャッシュエントリの情報
                      を含めるかどうか。

<comment>Return:</comment>
  <info>array|false</info>  ファイルキャッシュについてのメタデータの配列を返します。失敗した場合に <info>false</info> を返しま
               す
               
               この関数が返す配列には次の要素が含まれます。 <return>total_cache_uptime</return> - ファイルキャッシュ
               がアクティブになってからの経過秒数。 <return>total_file_count</return> - 現在ファイルキャッシュに入っ
               ているファイルの数。 <return>total_hit_count</return> - ファイルキャッシュからファイルが取り出された回
               数。 <return>total_miss_count</return> - ファイルがファイルキャッシュに見つからなかった回数。
               <return>file_entries</return> - キャッシュされているファイルに関する情報を含む配列。 <return>file_name</return> -
               キャッシュされているファイルの絶対パスでのファイル名。 <return>add_time</return> - ファイルキャッシュ
               に追加されてからの経過秒数。 <return>use_time</return> - ファイルキャッシュ内でアクセスされてからの経
               過秒数。 <return>last_check</return> - ファイルの変更をチェックされてからの経過秒数。 <return>hit_count</return> - ファ
               イルがキャッシュから取り出された回数。 <return>file_size</return> - キャッシュされたファイルのサイズ
               (バイト単位)。
               
               <return>total_cache_uptime</return> - ファイルキャッシュがアクティブになってからの経過秒数。
               
               <return>total_file_count</return> - 現在ファイルキャッシュに入っているファイルの数。
               
               <return>total_hit_count</return> - ファイルキャッシュからファイルが取り出された回数。
               
               <return>total_miss_count</return> - ファイルがファイルキャッシュに見つからなかった回数。
               
               <return>file_entries</return> - キャッシュされているファイルに関する情報を含む配列。 <return>file_name</return> -
               キャッシュされているファイルの絶対パスでのファイル名。 <return>add_time</return> - ファイルキャッシュ
               に追加されてからの経過秒数。 <return>use_time</return> - ファイルキャッシュ内でアクセスされてからの経
               過秒数。 <return>last_check</return> - ファイルの変更をチェックされてからの経過秒数。 <return>hit_count</return> - ファ
               イルがキャッシュから取り出された回数。 <return>file_size</return> - キャッシュされたファイルのサイズ
               (バイト単位)。
               
               <return>file_name</return> - キャッシュされているファイルの絶対パスでのファイル名。
               
               <return>add_time</return> - ファイルキャッシュに追加されてからの経過秒数。
               
               <return>use_time</return> - ファイルキャッシュ内でアクセスされてからの経過秒数。
               
               <return>last_check</return> - ファイルの変更をチェックされてからの経過秒数。
               
               <return>hit_count</return> - ファイルがキャッシュから取り出された回数。
               
               <return>file_size</return> - キャッシュされたファイルのサイズ (バイト単位)。

<comment>See Also:</comment>
   * <strong>wincache_fcache_meminfo()</strong>
   * <strong>wincache_ocache_fileinfo()</strong>
   * <strong>wincache_ocache_meminfo()</strong>
   * <strong>wincache_rplist_fileinfo()</strong>
   * <strong>wincache_rplist_meminfo()</strong>
   * <strong>wincache_refresh_if_changed()</strong>
   * <strong>wincache_ucache_meminfo()</strong>
   * <strong>wincache_ucache_info()</strong>
   * <strong>wincache_scache_info()</strong>
   * <strong>wincache_scache_meminfo()</strong>


id: wincache_fcache_meminfo
type: function
doc:
<comment>Description:</comment>
  ファイルキャッシュのメモリ使用状況についての情報を取得する
    
  
  ファイルキャッシュによるメモリ使用状況についての情報を取得します。

<comment>Return:</comment>
  <info>array|false</info>  ファイルキャッシュのメモリ使用状況についてのメタデータの配列を返します。失敗した場合
               に <info>false</info> を返します
               
               この関数が返す配列には次の要素が含まれます。 <return>memory_total</return> - ファイルキャッシュ用に確
               保されたメモリのバイト数。 <return>memory_free</return> - ファイルキャッシュで使える空きメモリのバイト
               数。 <return>num_used_blks</return> - ファイルキャッシュが使っているメモリブロック数。 <return>num_free_blks</return> -
               ファイルキャッシュで使える空きメモリブロック数。 <return>memory_overhead</return> - ファイルキャッシュ
               が内部的に使っているメモリのバイト数。
               
               <return>memory_total</return> - ファイルキャッシュ用に確保されたメモリのバイト数。
               
               <return>memory_free</return> - ファイルキャッシュで使える空きメモリのバイト数。
               
               <return>num_used_blks</return> - ファイルキャッシュが使っているメモリブロック数。
               
               <return>num_free_blks</return> - ファイルキャッシュで使える空きメモリブロック数。
               
               <return>memory_overhead</return> - ファイルキャッシュが内部的に使っているメモリのバイト数。

<comment>See Also:</comment>
   * <strong>wincache_fcache_fileinfo()</strong>
   * <strong>wincache_ocache_fileinfo()</strong>
   * <strong>wincache_ocache_meminfo()</strong>
   * <strong>wincache_rplist_fileinfo()</strong>
   * <strong>wincache_rplist_meminfo()</strong>
   * <strong>wincache_refresh_if_changed()</strong>
   * <strong>wincache_ucache_meminfo()</strong>
   * <strong>wincache_ucache_info()</strong>
   * <strong>wincache_scache_info()</strong>
   * <strong>wincache_scache_meminfo()</strong>


id: wincache_lock
type: function
doc:
<comment>Description:</comment>
  指定したキーで排他ロックを確保する
    
  
  指定したキーについての排他ロックを確保します。 ロックを確保するまでは、現在のスクリプトの実行はブ
  ロックされます。 ロックを確保できたら、その後は他のスクリプトから同じキーのロックを要求があっても
  それをブロックします。 現在のスクリプトが <strong>wincache_unlock()</strong> でロックを解放するまでは他のスクリプト
  からロックを確保できません。
  
  <strong>wincache_lock()</strong> および <strong>wincache_unlock()</strong> を使っていると、FastCGI のようなマルチプロセス環境におい
  て PHP スクリプトがデッドロックを引き起こすことがあります。 本当にそれが必要である場合でない限り、
  これらの関数は使わないようにしましょう。 キャッシュ上でのさまざまな操作の大半は、これらの関数を使
  う必要のないものです。

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>       ロックを取得したいキャッシュ内のキーの名前。
  <info>bool</info>    <strong>$isglobal</strong>  ロックのスコープをシステム全体にするかローカルにするかを制御します。 ローカル
                     ロックのスコープは、IIS FastCGI のアプリケーションプール内 あるいは同一の親プロ
                     セス ID を持つ PHP プロセス群全体となります。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>wincache_unlock()</strong>
   * <strong>wincache_ucache_set()</strong>
   * <strong>wincache_ucache_get()</strong>
   * <strong>wincache_ucache_delete()</strong>
   * <strong>wincache_ucache_clear()</strong>
   * <strong>wincache_ucache_exists()</strong>
   * <strong>wincache_ucache_meminfo()</strong>
   * <strong>wincache_ucache_info()</strong>
   * <strong>wincache_scache_info()</strong>


id: wincache_ocache_fileinfo
type: function
doc:
<comment>Description:</comment>
  opcode キャッシュにキャッシュされたファイルについての情報を取得する
    
  
  opcode キャッシュの中身とその利用状況についての情報を取得します。
  
  この機能は
  PHP 7.0.0 で 削除 されました。

<comment>Param:</comment>
  <info>bool</info>  <strong>$summaryonly</strong>  返される配列に、opcode キャッシュの概要に加えて個々のキャッシュエントリの情報
                      を含めるかどうか。

<comment>Return:</comment>
  <info>array|false</info>  opcode キャッシュについてのメタデータの配列を返します。失敗した場合に <info>false</info> を返しま
               す
               
               この関数が返す配列には次の要素が含まれます。 <return>total_cache_uptime</return> - opcode キャッシュが
               アクティブになってからの経過秒数。 <return>total_file_count</return> - 現在 opcode キャッシュに入って
               いるファイルの数。 <return>total_hit_count</return> - opcode キャッシュからファイルが取り出された回
               数。 <return>total_miss_count</return> - ファイルが opcode キャッシュに見つからなかった回数。
               <return>is_local_cache</return> - ローカルキャッシュインスタンスのメタデータである場合は true、 グロー
               バルキャッシュのメタデータである場合は false。 <return>file_entries</return> - キャッシュされている
               ファイルに関する情報を含む配列。 <return>file_name</return> - キャッシュされているファイルの絶対パスで
               のファイル名。 <return>add_time</return> - opcode キャッシュに追加されてからの経過秒数。 <return>use_time</return> -
               opcode キャッシュ内でアクセスされてからの経過秒数。 <return>last_check</return> - ファイルの変更を
               チェックされてからの経過秒数。 <return>hit_count</return> - ファイルがキャッシュから取り出された回数。
               <return>function_count</return> - キャッシュされたファイル内の関数の数。 <return>class_count</return> - キャッシュされ
               たファイルの中のクラスの数。
               
               <return>total_cache_uptime</return> - opcode キャッシュがアクティブになってからの経過秒数。
               
               <return>total_file_count</return> - 現在 opcode キャッシュに入っているファイルの数。
               
               <return>total_hit_count</return> - opcode キャッシュからファイルが取り出された回数。
               
               <return>total_miss_count</return> - ファイルが opcode キャッシュに見つからなかった回数。
               
               <return>is_local_cache</return> - ローカルキャッシュインスタンスのメタデータである場合は true、 グロー
               バルキャッシュのメタデータである場合は false。
               
               <return>file_entries</return> - キャッシュされているファイルに関する情報を含む配列。 <return>file_name</return> -
               キャッシュされているファイルの絶対パスでのファイル名。 <return>add_time</return> - opcode キャッシュに
               追加されてからの経過秒数。 <return>use_time</return> - opcode キャッシュ内でアクセスされてからの経過秒
               数。 <return>last_check</return> - ファイルの変更をチェックされてからの経過秒数。 <return>hit_count</return> - ファイル
               がキャッシュから取り出された回数。 <return>function_count</return> - キャッシュされたファイル内の関数
               の数。 <return>class_count</return> - キャッシュされたファイルの中のクラスの数。
               
               <return>file_name</return> - キャッシュされているファイルの絶対パスでのファイル名。
               
               <return>add_time</return> - opcode キャッシュに追加されてからの経過秒数。
               
               <return>use_time</return> - opcode キャッシュ内でアクセスされてからの経過秒数。
               
               <return>last_check</return> - ファイルの変更をチェックされてからの経過秒数。
               
               <return>hit_count</return> - ファイルがキャッシュから取り出された回数。
               
               <return>function_count</return> - キャッシュされたファイル内の関数の数。
               
               <return>class_count</return> - キャッシュされたファイルの中のクラスの数。

<comment>See Also:</comment>
   * <strong>wincache_fcache_fileinfo()</strong>
   * <strong>wincache_fcache_meminfo()</strong>
   * <strong>wincache_ocache_meminfo()</strong>
   * <strong>wincache_rplist_fileinfo()</strong>
   * <strong>wincache_rplist_meminfo()</strong>
   * <strong>wincache_refresh_if_changed()</strong>
   * <strong>wincache_ucache_meminfo()</strong>
   * <strong>wincache_ucache_info()</strong>
   * <strong>wincache_scache_info()</strong>
   * <strong>wincache_scache_meminfo()</strong>


id: wincache_ocache_meminfo
type: function
doc:
<comment>Description:</comment>
  opcode キャッシュのメモリ使用状況についての情報を取得する
    
  
  opcode キャッシュによるメモリ使用状況についての情報を取得します。

<comment>Return:</comment>
  <info>array|false</info>  opcode キャッシュのメモリ使用状況についてのメタデータの配列を返します。失敗した場合に
               <info>false</info> を返します
               
               この関数が返す配列には次の要素が含まれます。 <return>memory_total</return> - opcode キャッシュ用に確保
               されたメモリのバイト数。 <return>memory_free</return> - opcode キャッシュで使える空きメモリのバイト
               数。 <return>num_used_blks</return> - opcode キャッシュが使っているメモリブロック数。 <return>num_free_blks</return> -
               opcode キャッシュで使える空きメモリブロック数。 <return>memory_overhead</return> - opcode キャッシュが
               内部的に使っているメモリのバイト数。
               
               <return>memory_total</return> - opcode キャッシュ用に確保されたメモリのバイト数。
               
               <return>memory_free</return> - opcode キャッシュで使える空きメモリのバイト数。
               
               <return>num_used_blks</return> - opcode キャッシュが使っているメモリブロック数。
               
               <return>num_free_blks</return> - opcode キャッシュで使える空きメモリブロック数。
               
               <return>memory_overhead</return> - opcode キャッシュが内部的に使っているメモリのバイト数。
               
               この機能は
               PHP 7.0.0 で 削除 されました。

<comment>See Also:</comment>
   * <strong>wincache_fcache_fileinfo()</strong>
   * <strong>wincache_fcache_meminfo()</strong>
   * <strong>wincache_ocache_fileinfo()</strong>
   * <strong>wincache_rplist_fileinfo()</strong>
   * <strong>wincache_rplist_meminfo()</strong>
   * <strong>wincache_refresh_if_changed()</strong>
   * <strong>wincache_ucache_meminfo()</strong>
   * <strong>wincache_ucache_info()</strong>
   * <strong>wincache_scache_info()</strong>
   * <strong>wincache_scache_meminfo()</strong>


id: wincache_refresh_if_changed
type: function
doc:
<comment>Description:</comment>
  キャッシュされたファイルのキャッシュエントリをリフレッシュする
    
  
  ファイルのキャッシュエントリをリフレッシュします。ファイル名は引数で渡します。  引数を指定しなかっ
  た場合は、キャッシュ内のすべてのエントリをリフレッシュします。

<comment>Param:</comment>
  <info>array</info>  <strong>$files</strong>  リフレッシュしたいファイル名の配列。 絶対パスあるいは相対パスのどちらでもかまいませ
                 ん。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>wincache_fcache_fileinfo()</strong>
   * <strong>wincache_fcache_meminfo()</strong>
   * <strong>wincache_ocache_fileinfo()</strong>
   * <strong>wincache_ocache_meminfo()</strong>
   * <strong>wincache_rplist_fileinfo()</strong>
   * <strong>wincache_rplist_meminfo()</strong>
   * <strong>wincache_ucache_meminfo()</strong>
   * <strong>wincache_ucache_info()</strong>


id: wincache_rplist_fileinfo
type: function
doc:
<comment>Description:</comment>
  ファイルパス解決キャッシュについての情報を取得する
    
  
  相対ファイルパスとそれに対応する絶対ファイルパスとの対応を記録したキャッシュについての情報を取得し
  ます。

<comment>Param:</comment>
  <info>bool</info>  <strong>$summaryonly</strong>  

<comment>Return:</comment>
  <info>array|false</info>  ファイルパス解決キャッシュについてのメタデータの配列を返します。失敗した場合に <info>false</info>
               を返します
               
               この関数が返す配列には次の要素が含まれます。 <return>total_file_count</return> - キャッシュに格納され
               たファイルパスのマッピングの数。 <return>rplist_entries</return> - キャッシュされたすべてのファイルパ
               スに関する情報を含む配列。 <return>resolve_path</return> - ファイルへのパス。 <return>subkey_data</return> - 対応する絶
               対パス。
               
               <return>total_file_count</return> - キャッシュに格納されたファイルパスのマッピングの数。
               
               <return>rplist_entries</return> - キャッシュされたすべてのファイルパスに関する情報を含む配列。
               <return>resolve_path</return> - ファイルへのパス。 <return>subkey_data</return> - 対応する絶対パス。
               
               <return>resolve_path</return> - ファイルへのパス。
               
               <return>subkey_data</return> - 対応する絶対パス。

<comment>See Also:</comment>
   * <strong>wincache_fcache_meminfo()</strong>
   * <strong>wincache_fcache_fileinfo()</strong>
   * <strong>wincache_ocache_fileinfo()</strong>
   * <strong>wincache_ocache_meminfo()</strong>
   * <strong>wincache_rplist_meminfo()</strong>
   * <strong>wincache_refresh_if_changed()</strong>
   * <strong>wincache_ucache_meminfo()</strong>
   * <strong>wincache_ucache_info()</strong>
   * <strong>wincache_scache_info()</strong>
   * <strong>wincache_scache_meminfo()</strong>


id: wincache_rplist_meminfo
type: function
doc:
<comment>Description:</comment>
  ファイルパス解決キャッシュのメモリ使用状況についての情報を取得する
    
  
  ファイルパス解決キャッシュによるメモリ使用状況についての情報を取得します。

<comment>Return:</comment>
  <info>array|false</info>  ファイルパス解決キャッシュのメモリ使用状況についてのメタデータの配列を返します。失敗
               した場合に <info>false</info> を返します
               
               The array returned by this function contains the following elements: <return>memory_total</return> -
               ファイルパス解決キャッシュ用に確保されたメモリのバイト数。 <return>memory_free</return> - ファイルパス
               解決キャッシュで使える空きメモリのバイト数。 <return>num_used_blks</return> - ファイルパス解決キャッ
               シュが使っているメモリブロック数。 <return>num_free_blks</return> - ファイルパス解決キャッシュで使える
               空きメモリブロック数。 <return>memory_overhead</return> - ファイルパス解決キャッシュが内部的に使ってい
               るメモリのバイト数。
               
               <return>memory_total</return> - ファイルパス解決キャッシュ用に確保されたメモリのバイト数。
               
               <return>memory_free</return> - ファイルパス解決キャッシュで使える空きメモリのバイト数。
               
               <return>num_used_blks</return> - ファイルパス解決キャッシュが使っているメモリブロック数。
               
               <return>num_free_blks</return> - ファイルパス解決キャッシュで使える空きメモリブロック数。
               
               <return>memory_overhead</return> - ファイルパス解決キャッシュが内部的に使っているメモリのバイト数。

<comment>See Also:</comment>
   * <strong>wincache_fcache_fileinfo()</strong>
   * <strong>wincache_fcache_meminfo()</strong>
   * <strong>wincache_ocache_fileinfo()</strong>
   * <strong>wincache_ocache_meminfo()</strong>
   * <strong>wincache_rplist_fileinfo()</strong>
   * <strong>wincache_refresh_if_changed()</strong>
   * <strong>wincache_ucache_meminfo()</strong>
   * <strong>wincache_ucache_info()</strong>
   * <strong>wincache_scache_info()</strong>
   * <strong>wincache_scache_meminfo()</strong>


id: wincache_scache_info
type: function
doc:
<comment>Description:</comment>
  セッションキャッシュにキャッシュされたファイルについての情報を取得する
    
  
  セッションキャッシュの中身とその利用状況についての情報を取得します。

<comment>Param:</comment>
  <info>bool</info>  <strong>$summaryonly</strong>  返される配列に、セッションキャッシュの概要に加えて個々のキャッシュエントリの情
                      報を含めるかどうか。

<comment>Return:</comment>
  <info>array|false</info>  セッションキャッシュについてのメタデータの配列を返します。失敗した場合に <info>false</info> を返し
               ます
               
               この関数が返す配列には次の要素が含まれます。 <return>total_cache_uptime</return> - セッションキャッ
               シュがアクティブになってからの経過秒数。 <return>total_item_count</return> - 現在セッションキャッシュ
               に入っている要素の数。 <return>is_local_cache</return> - メタデータがローカルキャッシュ用のものである
               場合に true、 グローバルキャッシュ用のものである場合に false。 <return>total_hit_count</return> -
               キャッシュからファイルが取り出された回数。 <return>total_miss_count</return> - ファイルがキャッシュに
               見つからなかった回数。 <return>scache_entries</return> - キャッシュされているアイテムに関する情報を含
               む配列。 <return>key_name</return> - データを保存する際に使うキーの名前。 <return>value_type</return> - キーに関連づけ
               て格納する値の型。 <return>use_time</return> - セッションキャッシュ内でアクセスされてからの経過秒数。
               <return>last_check</return> - ファイルの変更をチェックされてからの経過秒数。 <return>ttl_seconds</return> - データを
               キャッシュ内に残す残り時間。0 は無制限。 <return>age_seconds</return> - データがキャッシュに追加されて
               からのおよその経過時間。 <return>hitcount</return> - キャッシュからファイルが取り出された回数。
               
               <return>total_cache_uptime</return> - セッションキャッシュがアクティブになってからの経過秒数。
               
               <return>total_item_count</return> - 現在セッションキャッシュに入っている要素の数。
               
               <return>is_local_cache</return> - メタデータがローカルキャッシュ用のものである場合に true、 グローバル
               キャッシュ用のものである場合に false。
               
               <return>total_hit_count</return> - キャッシュからファイルが取り出された回数。
               
               <return>total_miss_count</return> - ファイルがキャッシュに見つからなかった回数。
               
               <return>scache_entries</return> - キャッシュされているアイテムに関する情報を含む配列。 <return>key_name</return> - デー
               タを保存する際に使うキーの名前。 <return>value_type</return> - キーに関連づけて格納する値の型。
               <return>use_time</return> - セッションキャッシュ内でアクセスされてからの経過秒数。 <return>last_check</return> - ファイ
               ルの変更をチェックされてからの経過秒数。 <return>ttl_seconds</return> - データをキャッシュ内に残す残り
               時間。0 は無制限。 <return>age_seconds</return> - データがキャッシュに追加されてからのおよその経過時
               間。 <return>hitcount</return> - キャッシュからファイルが取り出された回数。
               
               <return>key_name</return> - データを保存する際に使うキーの名前。
               
               <return>value_type</return> - キーに関連づけて格納する値の型。
               
               <return>use_time</return> - セッションキャッシュ内でアクセスされてからの経過秒数。
               
               <return>last_check</return> - ファイルの変更をチェックされてからの経過秒数。
               
               <return>ttl_seconds</return> - データをキャッシュ内に残す残り時間。0 は無制限。
               
               <return>age_seconds</return> - データがキャッシュに追加されてからのおよその経過時間。
               
               <return>hitcount</return> - キャッシュからファイルが取り出された回数。

<comment>See Also:</comment>
   * <strong>wincache_fcache_fileinfo()</strong>
   * <strong>wincache_fcache_meminfo()</strong>
   * <strong>wincache_ocache_meminfo()</strong>
   * <strong>wincache_rplist_fileinfo()</strong>
   * <strong>wincache_rplist_meminfo()</strong>
   * <strong>wincache_refresh_if_changed()</strong>
   * <strong>wincache_ucache_meminfo()</strong>
   * <strong>wincache_ucache_info()</strong>
   * <strong>wincache_scache_meminfo()</strong>


id: wincache_scache_meminfo
type: function
doc:
<comment>Description:</comment>
  セッションキャッシュのメモリ使用状況についての情報を取得する
    
  
  セッションキャッシュによるメモリ使用状況についての情報を取得します。

<comment>Return:</comment>
  <info>array|false</info>  セッションキャッシュのメモリ使用状況についてのメタデータの配列を返します。失敗した場
               合に <info>false</info> を返します
               
               この関数が返す配列には次の要素が含まれます。 <return>memory_total</return> - セッションキャッシュ用に
               確保されたメモリのバイト数。 <return>memory_free</return> - セッションキャッシュで使える空きメモリのバ
               イト数。 <return>num_used_blks</return> - セッションキャッシュが使っているメモリブロック数。
               <return>num_free_blks</return> - セッションキャッシュで使える空きメモリブロック数。 <return>memory_overhead</return> -
               セッションキャッシュが内部的に使っているメモリのバイト数。
               
               <return>memory_total</return> - セッションキャッシュ用に確保されたメモリのバイト数。
               
               <return>memory_free</return> - セッションキャッシュで使える空きメモリのバイト数。
               
               <return>num_used_blks</return> - セッションキャッシュが使っているメモリブロック数。
               
               <return>num_free_blks</return> - セッションキャッシュで使える空きメモリブロック数。
               
               <return>memory_overhead</return> - セッションキャッシュが内部的に使っているメモリのバイト数。

<comment>See Also:</comment>
   * <strong>wincache_fcache_fileinfo()</strong>
   * <strong>wincache_fcache_meminfo()</strong>
   * <strong>wincache_ocache_fileinfo()</strong>
   * <strong>wincache_rplist_fileinfo()</strong>
   * <strong>wincache_rplist_meminfo()</strong>
   * <strong>wincache_refresh_if_changed()</strong>
   * <strong>wincache_ucache_info()</strong>
   * <strong>wincache_scache_info()</strong>


id: wincache_ucache_add
type: function
doc:
<comment>Description:</comment>
  変数が既にキャッシュに存在しない場合にのみ変数をユーザーキャッシュに追加する
    
  
  変数が既にキャッシュに存在しない場合にのみ変数をユーザーキャッシュに追加します。 追加された変数
  は、有効期限に達するか、 <strong>wincache_ucache_delete()</strong> あるいは <strong>wincache_ucache_clear()</strong> で削除されるま
  ではキャッシュに残り続けます。

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>     変数を格納するときに、この名前のキーを使います。 同じキーで既に変数が格納されてい
                   るときは、この関数は失敗して <info>false</info> を返します。 <strong>$key</strong> は大文字小文字を区別します。
                   同じキーがあっても値を上書きしたい場合は <strong>wincache_ucache_set()</strong> 関数をかわりに使い
                   ます。 <strong>$key</strong> には name =&gt; value のペアの配列を渡すこともできます。 この場合は
                   name がキーとなります。 この形式を使えば複数の値を一度の操作でキャッシュに格納で
                   きるので、競合状態になることを防げます。
  <info>mixed</info>   <strong>$value</strong>   格納したい変数の値。ファイルハンドルのようなリソース型以外のすべてのデータ型をサ
                   ポートしています。 最初のパラメータが配列の場合は、このパラメータは無視されます。
                   一般的な指針として、<strong>$key</strong> に配列を渡す場合は <strong>$value</strong> を <info>null</info> にしておきましょう。
                   <strong>$value</strong> がオブジェクト、あるいはオブジェクトを含む配列である場合は、 オブジェクト
                   がシリアライズされます。オブジェクトのシリアライズについての詳細は __sleep() を参
                   照ください。
  <info>array</info>   <strong>$values</strong>  キーと値の連想配列。
  <info>int</info>     <strong>$ttl</strong>     変数のキャッシュ内での生存時間を秒単位で指定します。 <strong>$ttl</strong> で指定した秒数が経過す
                   ると、 格納されている変数はキャッシュから削除されます。 このパラメータのデフォル
                   ト値は <return>0</return> で、これは <strong>wincache_ucache_delete()</strong> あるいは <strong>wincache_ucache_clear()</strong> で
                   明示的に削除するまでキャッシュに残り続けることを意味します。

<comment>Return:</comment>
  <info>bool</info>  <strong>$key</strong> が文字列のときは、成功した場合に <info>true</info>、失敗した場合に <info>false</info> を返します。
        
        <strong>$key</strong> が配列のときの戻り値は、次のようになります。  配列内のすべての name =&gt; value ペアが
        設定できた場合は、空の配列を返します。  配列内の name =&gt; value ペアがひとつも設定できな
        かった場合は、<info>false</info> を返します。  成功したペアと失敗したペアがある場合は、ユーザーキャッシュ
        への追加に失敗した name=&gt;value ペアを含む配列を返します。
        
        配列内のすべての name =&gt; value ペアが設定できた場合は、空の配列を返します。
        
        配列内の name =&gt; value ペアがひとつも設定できなかった場合は、<info>false</info> を返します。
        
        成功したペアと失敗したペアがある場合は、ユーザーキャッシュへの追加に失敗した name=&gt;value
        ペアを含む配列を返します。

<comment>See Also:</comment>
   * <strong>wincache_ucache_set()</strong>
   * <strong>wincache_ucache_get()</strong>
   * <strong>wincache_ucache_delete()</strong>
   * <strong>wincache_ucache_clear()</strong>
   * <strong>wincache_ucache_exists()</strong>
   * <strong>wincache_ucache_meminfo()</strong>
   * <strong>wincache_ucache_info()</strong>
   * __sleep()


id: wincache_ucache_cas
type: function
doc:
<comment>Description:</comment>
  変数を古い値と比較して新しい値を代入する
    
  
  指定したキーの変数を <strong>$old_value</strong> と比較し、 マッチした場合はそこに <strong>$new_value</strong> を代入します。

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>        変数をキャッシュに格納するときに使ったキーの名前。 <strong>$key</strong> は大文字小文字を区別し
                      ます。
  <info>int</info>     <strong>$old_value</strong>  ユーザーキャッシュ内の <strong>$key</strong> が指す変数の古い値。 この値は <return>long</return> 型でなければな
                      らず、 それ以外の場合はこの関数は <info>false</info> を返します。
  <info>int</info>     <strong>$new_value</strong>  マッチしたときに <strong>$key</strong> が指す変数に代入する新しい値。  この値は <return>long</return> 型でなけれ
                      ばならず、 それ以外の場合はこの関数は <info>false</info> を返します。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>wincache_ucache_inc()</strong>
   * <strong>wincache_ucache_dec()</strong>


id: wincache_ucache_clear
type: function
doc:
<comment>Description:</comment>
  ユーザーキャッシュの中身全体を削除する
    
  
  ユーザーキャッシュに格納されているすべての値を消去/削除します。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>wincache_ucache_set()</strong>
   * <strong>wincache_ucache_add()</strong>
   * <strong>wincache_ucache_delete()</strong>
   * <strong>wincache_ucache_get()</strong>
   * <strong>wincache_ucache_exists()</strong>
   * <strong>wincache_ucache_meminfo()</strong>
   * <strong>wincache_ucache_info()</strong>


id: wincache_ucache_dec
type: function
doc:
<comment>Description:</comment>
  キーに関連づけられた値を減少させる
    
  
  <strong>$key</strong> に関連づけられた値を、1 あるいは <strong>$dec_by</strong> で指定した数だけ減らします。

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>      変数をキャッシュに格納するときに使ったキーの名前。 <strong>$key</strong> は大文字小文字を区別しま
                    す。
  <info>int</info>     <strong>$dec_by</strong>   <strong>$key</strong> に関連づけられた変数の減少幅。 浮動小数点数を指定した場合は、最も近い整数に
                    丸められます。 <strong>$key</strong> に関連づけられた変数は <return>long</return> 型でなければならず、 それ以外の
                    場合はこの関数は失敗して <info>false</info> を返します。
  <info>bool</info>    <strong>$success</strong>  成功した場合に <info>true</info>、失敗した場合に <info>false</info> が設定されます。

<comment>Return:</comment>
  <info>mixed</info>  成功した場合に減少後の値、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>wincache_ucache_inc()</strong>
   * <strong>wincache_ucache_cas()</strong>


id: wincache_ucache_delete
type: function
doc:
<comment>Description:</comment>
  変数をユーザーキャッシュから削除する
    
  
  <strong>$key</strong> が指す要素をユーザーキャッシュから削除します。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$key</strong>  変数をキャッシュに格納するときに使ったキーの名前。 <strong>$key</strong> は大文字小文字を区別します。
               <strong>$key</strong> にはキーの配列を指定することもできます。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。
        
        <strong>$key</strong> が配列のときは、配列の要素がどれも削除できなかった場合に <info>false</info> を返します。それ以外の場
        合は、削除されたすべてのキーを含む配列を返します。

<comment>See Also:</comment>
   * <strong>wincache_ucache_set()</strong>
   * <strong>wincache_ucache_add()</strong>
   * <strong>wincache_ucache_get()</strong>
   * <strong>wincache_ucache_clear()</strong>
   * <strong>wincache_ucache_exists()</strong>
   * <strong>wincache_ucache_meminfo()</strong>
   * <strong>wincache_ucache_info()</strong>


id: wincache_ucache_exists
type: function
doc:
<comment>Description:</comment>
  変数がユーザーキャッシュに存在するかどうかを調べる
    
  
  指定したキーの変数がユーザーキャッシュに存在するかどうかを調べます。

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>  変数をキャッシュに格納するときに使ったキーの名前。 <strong>$key</strong> は大文字小文字を区別します。

<comment>Return:</comment>
  <info>bool</info>  指定したキーの変数が存在する場合に <info>true</info>、 それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>wincache_ucache_set()</strong>
   * <strong>wincache_ucache_add()</strong>
   * <strong>wincache_ucache_get()</strong>
   * <strong>wincache_ucache_clear()</strong>
   * <strong>wincache_ucache_delete()</strong>
   * <strong>wincache_ucache_meminfo()</strong>
   * <strong>wincache_ucache_info()</strong>


id: wincache_ucache_get
type: function
doc:
<comment>Description:</comment>
  ユーザーキャッシュに格納された変数を取得する
    
  
  ユーザーキャッシュに格納された変数を取得します。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$key</strong>      変数をキャッシュに格納するときに使ったキーの名前。 <strong>$key</strong> は大文字小文字を区別しま
                   す。 <strong>$key</strong> にはキーの配列を指定することもできます。 その場合の戻り値は、<strong>$key</strong> 配列
                   の各要素の値の配列となります。 オブジェクト、あるいはオブジェクトを含む配列が返さ
                   れるときには、 オブジェクトがアンシリアライズされます。シリアライズしたオブジェク
                   トの復元についての詳細は __wakeup() を参照ください。
  <info>bool</info>   <strong>$success</strong>  成功した場合に <info>true</info>、失敗した場合に <info>false</info> が設定されます。

<comment>Return:</comment>
  <info>mixed</info>  <strong>$key</strong> が文字列のときは、そのキーに格納された変数の値を返します。 <strong>$success</strong> には、成功した場合
         に <info>true</info>、 失敗した場合に <info>false</info> が設定されます。
         
         <strong>$key</strong> が配列のときは、<strong>$success</strong> には常に <info>true</info> が設定されます。返される配列 (name =&gt; value
         のペア) には、取得に成功したペアだけが含まれます。指定したキーがひとつもユーザーキャッシュ
         から見つからなかった場合は 空の配列を返します。

<comment>See Also:</comment>
   * <strong>wincache_ucache_add()</strong>
   * <strong>wincache_ucache_set()</strong>
   * <strong>wincache_ucache_delete()</strong>
   * <strong>wincache_ucache_clear()</strong>
   * <strong>wincache_ucache_exists()</strong>
   * <strong>wincache_ucache_meminfo()</strong>
   * <strong>wincache_ucache_info()</strong>
   * __wakeup()


id: wincache_ucache_inc
type: function
doc:
<comment>Description:</comment>
  キーに関連づけられた値を増加させる
    
  
  <strong>$key</strong> に関連づけられた値を、1 あるいは <strong>$inc_by</strong> で指定した数だけ増やします。

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>      変数をキャッシュに格納するときに使ったキーの名前。 <strong>$key</strong> は大文字小文字を区別しま
                    す。
  <info>int</info>     <strong>$inc_by</strong>   <strong>$key</strong> に関連づけられた変数の増加幅。 浮動小数点数を指定した場合は、最も近い整数に
                    丸められます。 <strong>$key</strong> に関連づけられた変数は <return>long</return> 型でなければならず、 それ以外の
                    場合はこの関数は失敗して <info>false</info> を返します。
  <info>bool</info>    <strong>$success</strong>  成功した場合に <info>true</info>、失敗した場合に <info>false</info> が設定されます。

<comment>Return:</comment>
  <info>mixed</info>  成功した場合に増加後の値、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>wincache_ucache_dec()</strong>
   * <strong>wincache_ucache_cas()</strong>


id: wincache_ucache_info
type: function
doc:
<comment>Description:</comment>
  ユーザーキャッシュにキャッシュされたファイルについての情報を取得する
    
  
  ユーザーキャッシュに格納されたデータについての情報を取得します。

<comment>Param:</comment>
  <info>bool</info>    <strong>$summaryonly</strong>  返される配列に、ユーザーキャッシュの概要に加えて個々のキャッシュエントリの情
                        報を含めるかどうか。
  <info>string</info>  <strong>$key</strong>          ユーザーキャッシュ内のエントリのキー。 これを指定すると、返される配列にはそ
                        のキャッシュエントリの情報だけを含むようになります。 これを指定せず、さらに
                        <strong>$summaryonly</strong> が <info>false</info> の場合は、 返される配列にはキャッシュ内のすべてのエン
                        トリについての情報を含むようになります。

<comment>Return:</comment>
  <info>array|false</info>  ユーザーキャッシュについてのメタデータの配列を返します。失敗した場合に <info>false</info> を返しま
               す
               
               この関数が返す配列には次の要素が含まれます。 <return>total_cache_uptime</return> - ユーザーキャッシュ
               がアクティブになってからの経過秒数。 <return>total_item_count</return> - 現在ユーザーキャッシュに入っ
               ている要素の数。 <return>is_local_cache</return> - メタデータがローカルキャッシュ用のものである場合に
               true、 グローバルキャッシュ用のものである場合に false。 <return>total_hit_count</return> - キャッシュ
               からファイルが取り出された回数。 <return>total_miss_count</return> - ファイルがキャッシュに見つからな
               かった回数。 <return>ucache_entries</return> - キャッシュされているアイテムに関する情報を含む配列。
               <return>key_name</return> - データを保存する際に使うキーの名前。 <return>value_type</return> - キーに関連づけて格納する
               値の型。 <return>use_time</return> - ユーザーキャッシュ内でアクセスされてからの経過秒数。 <return>last_check</return> -
               ファイルの変更をチェックされてからの経過秒数。 <return>is_session</return> - データがセッション変数で
               あることを示します。 <return>ttl_seconds</return> - データをキャッシュ内に残す残り時間。0 は無制限。
               <return>age_seconds</return> - データがキャッシュに追加されてからのおよその経過時間。 <return>hitcount</return> -
               キャッシュからファイルが取り出された回数。
               
               <return>total_cache_uptime</return> - ユーザーキャッシュがアクティブになってからの経過秒数。
               
               <return>total_item_count</return> - 現在ユーザーキャッシュに入っている要素の数。
               
               <return>is_local_cache</return> - メタデータがローカルキャッシュ用のものである場合に true、 グローバル
               キャッシュ用のものである場合に false。
               
               <return>total_hit_count</return> - キャッシュからファイルが取り出された回数。
               
               <return>total_miss_count</return> - ファイルがキャッシュに見つからなかった回数。
               
               <return>ucache_entries</return> - キャッシュされているアイテムに関する情報を含む配列。 <return>key_name</return> - デー
               タを保存する際に使うキーの名前。 <return>value_type</return> - キーに関連づけて格納する値の型。
               <return>use_time</return> - ユーザーキャッシュ内でアクセスされてからの経過秒数。 <return>last_check</return> - ファイル
               の変更をチェックされてからの経過秒数。 <return>is_session</return> - データがセッション変数であること
               を示します。 <return>ttl_seconds</return> - データをキャッシュ内に残す残り時間。0 は無制限。
               <return>age_seconds</return> - データがキャッシュに追加されてからのおよその経過時間。 <return>hitcount</return> -
               キャッシュからファイルが取り出された回数。
               
               <return>key_name</return> - データを保存する際に使うキーの名前。
               
               <return>value_type</return> - キーに関連づけて格納する値の型。
               
               <return>use_time</return> - ユーザーキャッシュ内でアクセスされてからの経過秒数。
               
               <return>last_check</return> - ファイルの変更をチェックされてからの経過秒数。
               
               <return>is_session</return> - データがセッション変数であることを示します。
               
               <return>ttl_seconds</return> - データをキャッシュ内に残す残り時間。0 は無制限。
               
               <return>age_seconds</return> - データがキャッシュに追加されてからのおよその経過時間。
               
               <return>hitcount</return> - キャッシュからファイルが取り出された回数。

<comment>See Also:</comment>
   * <strong>wincache_fcache_meminfo()</strong>
   * <strong>wincache_ocache_fileinfo()</strong>
   * <strong>wincache_ocache_meminfo()</strong>
   * <strong>wincache_rplist_meminfo()</strong>
   * <strong>wincache_rplist_fileinfo()</strong>
   * <strong>wincache_refresh_if_changed()</strong>
   * <strong>wincache_ucache_meminfo()</strong>
   * <strong>wincache_scache_info()</strong>
   * <strong>wincache_scache_meminfo()</strong>


id: wincache_ucache_meminfo
type: function
doc:
<comment>Description:</comment>
  ユーザーキャッシュのメモリ使用状況についての情報を取得する
    
  
  ユーザーキャッシュによるメモリ使用状況についての情報を取得します。

<comment>Return:</comment>
  <info>array|false</info>  ユーザーキャッシュのメモリ使用状況についてのメタデータの配列を返します。失敗した場合
               に <info>false</info> を返します
               
               この関数が返す配列には次の要素が含まれます。 <return>memory_total</return> - ユーザーキャッシュ用に確
               保されたメモリのバイト数。 <return>memory_free</return> - ユーザーキャッシュで使える空きメモリのバイト
               数。 <return>num_used_blks</return> - ユーザーキャッシュが使っているメモリブロック数。 <return>num_free_blks</return> -
               ユーザーキャッシュで使える空きメモリブロック数。 <return>memory_overhead</return> - ユーザーキャッシュ
               が内部的に使っているメモリのバイト数。
               
               <return>memory_total</return> - ユーザーキャッシュ用に確保されたメモリのバイト数。
               
               <return>memory_free</return> - ユーザーキャッシュで使える空きメモリのバイト数。
               
               <return>num_used_blks</return> - ユーザーキャッシュが使っているメモリブロック数。
               
               <return>num_free_blks</return> - ユーザーキャッシュで使える空きメモリブロック数。
               
               <return>memory_overhead</return> - ユーザーキャッシュが内部的に使っているメモリのバイト数。

<comment>See Also:</comment>
   * <strong>wincache_fcache_fileinfo()</strong>
   * <strong>wincache_fcache_meminfo()</strong>
   * <strong>wincache_ocache_fileinfo()</strong>
   * <strong>wincache_rplist_fileinfo()</strong>
   * <strong>wincache_rplist_meminfo()</strong>
   * <strong>wincache_refresh_if_changed()</strong>
   * <strong>wincache_ucache_info()</strong>
   * <strong>wincache_scache_info()</strong>
   * <strong>wincache_scache_meminfo()</strong>


id: wincache_ucache_set
type: function
doc:
<comment>Description:</comment>
  変数をユーザーキャッシュに追加し、変数が既にキャッシュに存在する場合はそれを上書きする
    
  
  変数をユーザーキャッシュに追加します。変数が既にキャッシュに存在する場合はそれを上書きします。 追
  加あるいは更新された変数は、有効期限に達するか、 <strong>wincache_ucache_delete()</strong> あるいは
  <strong>wincache_ucache_clear()</strong> で削除されるまではキャッシュに残り続けます。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$key</strong>     変数を格納するときに、この名前のキーを使います。 同じキーで既に変数が格納されてい
                  るときは、元の値を新しい値で上書きします。 <strong>$key</strong> には name =&gt; value のペアの配列
                  を渡すこともできます。 この場合は name がキーとなります。 この形式を使えば複数の値
                  を一度の操作でキャッシュに格納できるので、競合状態になることを防げます。
  <info>mixed</info>  <strong>$value</strong>   格納したい変数の値。ファイルハンドルのようなリソース型以外のすべてのデータ型をサ
                  ポートしています。 最初のパラメータが配列の場合は、このパラメータは無視されます。
                  一般的な指針として、<strong>$key</strong> に配列を渡す場合は <strong>$value</strong> を <info>null</info> にしておきましょう。
                  <strong>$value</strong> がオブジェクト、あるいはオブジェクトを含む配列である場合は、 オブジェクトが
                  シリアライズされます。オブジェクトのシリアライズについての詳細は __sleep() を参照
                  ください。
  <info>array</info>  <strong>$values</strong>  キーと値の連想配列。
  <info>int</info>    <strong>$ttl</strong>     変数のキャッシュ内での生存時間を秒単位で指定します。 <strong>$ttl</strong> で指定した秒数が経過する
                  と、 格納されている変数はキャッシュから削除されます。 このパラメータのデフォルト値
                  は <return>0</return> で、これは <strong>wincache_ucache_delete()</strong> あるいは <strong>wincache_ucache_clear()</strong> で明示的
                  に削除するまでキャッシュに残り続けることを意味します。

<comment>Return:</comment>
  <info>bool</info>  <strong>$key</strong> が文字列のときは、成功した場合に <info>true</info>、失敗した場合に <info>false</info> を返します。
        
        <strong>$key</strong> が配列のときの戻り値は、次のようになります。  配列内のすべての name =&gt; value ペアが
        設定できた場合は、空の配列を返します。  配列内の name =&gt; value ペアがひとつも設定できな
        かった場合は、<info>false</info> を返します。  成功したペアと失敗したペアがある場合は、ユーザーキャッシュ
        への追加に失敗した name=&gt;value ペアを含む配列を返します。
        
        配列内のすべての name =&gt; value ペアが設定できた場合は、空の配列を返します。
        
        配列内の name =&gt; value ペアがひとつも設定できなかった場合は、<info>false</info> を返します。
        
        成功したペアと失敗したペアがある場合は、ユーザーキャッシュへの追加に失敗した name=&gt;value
        ペアを含む配列を返します。

<comment>See Also:</comment>
   * <strong>wincache_ucache_add()</strong>
   * <strong>wincache_ucache_get()</strong>
   * <strong>wincache_ucache_delete()</strong>
   * <strong>wincache_ucache_clear()</strong>
   * <strong>wincache_ucache_exists()</strong>
   * <strong>wincache_ucache_meminfo()</strong>
   * <strong>wincache_ucache_info()</strong>
   * __sleep()


id: wincache_unlock
type: function
doc:
<comment>Description:</comment>
  指定したキーの排他ロックを解放する
    
  
  指定したキーに対して、<strong>wincache_lock()</strong> を使って取得した排他ロックを解放します。  別のプロセスがこの
  キーに対するロックをブロックされて待機している場合は、 そのプロセスがロックを取得できるようになり
  ます。
  
  <strong>wincache_lock()</strong> および <strong>wincache_unlock()</strong> を使っていると、FastCGI のようなマルチプロセス環境におい
  て PHP スクリプトがデッドロックを引き起こすことがあります。 本当にそれが必要である場合でない限り、
  これらの関数は使わないようにしましょう。 キャッシュ上でのさまざまな操作の大半は、これらの関数を使
  う必要のないものです。

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>  ロックを解放したいキャッシュ内のキーの名前。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>wincache_lock()</strong>
   * <strong>wincache_ucache_set()</strong>
   * <strong>wincache_ucache_get()</strong>
   * <strong>wincache_ucache_delete()</strong>
   * <strong>wincache_ucache_clear()</strong>
   * <strong>wincache_ucache_exists()</strong>
   * <strong>wincache_ucache_meminfo()</strong>
   * <strong>wincache_ucache_info()</strong>
   * <strong>wincache_scache_info()</strong>


id: wkhtmltox\Image\Converter::__construct
type: function
doc:
<comment>Description:</comment>
  Create a new Image converter
  
  Creates an Image converter, optionally taking an input buffer and configuration settings

<comment>Param:</comment>
  <info>string</info>  <strong>$buffer</strong>    HTML
  <info>array</info>   <strong>$settings</strong>  NameDescriptionValuesChangeloginURL or path of the input file, if "-" stdin is
                     used/path/to/markup.html&gt;= 0.1.0outpath of output file, if "-" stdout is
                     used, by default an internal buffer is used/path/to/output.png&gt;=
                     0.1.0fmtoutput format to use""defaultjpgoutput as JPEGpngoutput as PNGbmpoutput
                     as bitmapsvgoutput as SVG&gt;= 0.1.0transparentwhen outputting a PNG or SVG,
                     make the white background transparentboolean&gt;= 0.1.0screenWidththe with of
                     the screen used to render in pixels800&gt;= 0.1.0smartWidthwhen true,
                     screenWidth is expanded to the content widthboolean&gt;=
                     0.1.0qualitycompression factor to use when outputting a JPEG image94&gt;=
                     0.1.0crop.leftleft/x coordinate of the window to capture in pixels200&gt;=
                     0.1.0crop.toptop/y coordinate of the window to capture in pixels200&gt;=
                     0.1.0crop.widthwidth of the window to capture in pixels200&gt;=
                     0.1.0crop.heightheight of the window to capture in pixels200&gt;=
                     0.1.0load.cookieJarpath of file used to load and store
                     cookies/tmp/cookies.txt&gt;= 0.1.0load.usernameuser name to use when loging
                     into a websitebart&gt;= 0.1.0load.passwordthe password to used when logging
                     into a websiteelbarto&gt;= 0.1.0load.jsdelaythe amount of time in milliseconds
                     to wait after a page is loaded until it is captured1200&gt;=
                     0.1.0load.zoomFactorhow much zoom should be applied to the content2.2&gt;=
                     0.1.0load.customHeaderscustom headers to send when requesting the main web
                     page&gt;= 0.1.0load.repertCustomHeadersset true to send with all
                     requestsboolean&gt;= 0.1.0load.cookiescookie string to send when requesting the
                     main web page&gt;= 0.1.0load.postpost string to send when requesting the main
                     web page&gt;= 0.1.0load.blockLocalFileAccessdisallow local and piped files to
                     access other local filesboolean&gt;= 0.1.0load.stopSlowScriptstop slow running
                     javascriptbooleanload.debugJavascriptallow javascript to raise
                     warningsboolean&gt;= 0.1.0load.loadErrorHandlingset error handling
                     strategyabortabort the convertion processskipdo not add the object to the final
                     outputignoretry to add the object to the final output&gt;= 0.1.0load.proxy&gt;=
                     0.1.0web.backgroundinclude background image in outputboolean&gt;=
                     0.1.0web.loadImagesinclude images in outputboolean&gt;=
                     0.1.0web.enableJavascriptenable or disable javascriptboolean&gt;=
                     0.1.0web.enableIntelligentShrinkingenable to attempt to fit more content on
                     page, only applies to PDF outputboolean&gt;= 0.1.0web.minimumFontSizethe
                     minimum font size allowed9&gt;= 0.1.0web.printMediaTypeprint content using
                     print media type instead of screen media typeboolean&gt;=
                     0.1.0web.defaultEncodingcontent to use where no encoding is specifiedutf-8&gt;=
                     0.1.0web.userStyleSheetURL or path to a user specified style
                     sheet/path/to/style.css&gt;= 0.1.0web.enablePluginsenable or disable NS
                     pluginsboolean&gt;= 0.1.0


id: wkhtmltox\Image\Converter::convert
type: function
doc:
<comment>Description:</comment>
  Perform Image conversion
  
  Performs conversion of the input buffer

<comment>Return:</comment>
  <info>string|null</info>  Where the return value is used, it will be populated with the contents of the
               conversion buffer


id: wkhtmltox\Image\Converter::getVersion
type: function
doc:
<comment>Description:</comment>
  Determine version of Converter
  
  Determines the version of Converter as reported by libwkhtmltox

<comment>Return:</comment>
  <info>string</info>  Returns a version string
          
          This is not yet implemented by libwkhtmltox


id: wkhtmltox\PDF\Converter::__construct
type: function
doc:
<comment>Description:</comment>
  Create a new PDF converter
  
  Creates a PDF converter, using optional configuration settings

<comment>Param:</comment>
  <info>array</info>  <strong>$settings</strong>  NameDescriptionValuesChangelogsize.pageSizepaper size of output documentA4&gt;=
                    0.1.0size.widthwith of the output document210mm&gt;= 0.1.0size.heightheight of
                    the output document297mm&gt;= 0.1.0orientationorientation of the output
                    documentLandscapePortrait&gt;= 0.1.0colorModecolor mode of the output
                    documentColorGreyscale&gt;= 0.1.0resolutionresoluition of the output
                    documentmost likely has no effect&gt;= 0.1.0dpidpi to use while printing80&gt;=
                    0.1.0pageOffsetinteger added to page numbers generating headers, footers, and
                    toc&gt;= 0.1.0copies&gt;= 0.1.0collatecollate copiesboolean&gt;=
                    0.1.0outlinegenerate PDF outlineboolean&gt;= 0.1.0outlineDepthmaximum depth of
                    outline&gt;= 0.1.0dumpOutlinepath of file to dump outline XML&gt;= 0.1.0outpath
                    of output file, if "-" stdout is used&gt;= 0.1.0documentTitletitle for the
                    output document&gt;= 0.1.0useCompressionenable or disable lossless
                    compressionboolean&gt;= 0.1.0margin.topsize of the top margin2cm&gt;=
                    0.1.0margin.bottomsize of the bottom margin2cm&gt;= 0.1.0margin.leftsize of the
                    left margin2cm&gt;= 0.1.0margin.rightsize of the right margin2cm&gt;=
                    0.1.0imageDPImaximum DPI for images in the output document&gt;=
                    0.1.0imageQualitythe jpeg compression factor for images in the output
                    document94&gt;= 0.1.0load.cookieJarpath of file used to load and store
                    cookies/tmp/cookies.txt&gt;= 0.1.0


id: wkhtmltox\PDF\Converter::add
type: function
doc:
<comment>Description:</comment>
  Add an object for conversion
  
  Adds the given object to conversion

<comment>Param:</comment>
  <info>wkhtmltox\PDF\Object</info>  <strong>$object</strong>  The object to add

<comment>Return:</comment>
  <info>void</info>  


id: wkhtmltox\PDF\Converter::convert
type: function
doc:
<comment>Description:</comment>
  Perform PDF conversion
  
  Performs conversion of all previously added Objects

<comment>Return:</comment>
  <info>string|null</info>  Where the return value is used, it will be populated with the contents of the
               conversion buffer


id: wkhtmltox\PDF\Converter::getVersion
type: function
doc:
<comment>Description:</comment>
  Determine version of Converter
  
  Determines the version of Converter as reported by libwkhtmltox

<comment>Return:</comment>
  <info>string</info>  Returns a version string


id: wkhtmltox\PDF\Object::__construct
type: function
doc:
<comment>Description:</comment>
  Create a new PDF Object
  
  Creates a new PDF Object from the given buffer and optional configuration settings

<comment>Param:</comment>
  <info>string</info>  <strong>$buffer</strong>    HTML
  <info>array</info>   <strong>$settings</strong>  NameDescriptionValuesChangelogpageURL or path of the HTML to convert&gt;=
                     0.1.0useExternalLinksset true to convert external links in the input into
                     external PDF links in the outputboolean&gt;= 0.1.0useLocalLinksset true to
                     convert internal links in the input into internal PDF links in the
                     outputboolean&gt;= 0.1.0produceFormsset true to turn HTML forms into PDF
                     formsboolean&gt;= 0.1.0replacementsundocumented&gt;= 0.1.0includeInOutlineset
                     true to include sections from this object in the outline and tocboolean&gt;=
                     0.1.0pagesCountset true to make page count in toc inclusive of the number of
                     pages in this objectboolean&gt;= 0.1.0tocXslset to style sheet to convert this
                     object into a toc object&gt;= 0.1.0toc.useDottedLinesset true to use dotted
                     lines in tocboolean&gt;= 0.1.0toc.captionTextthe caption text for toc&gt;=
                     0.1.0toc.forwardLinksset true to create links from toc to contentboolean&gt;=
                     0.1.0toc.backLinksset true to create links from content to tocboolean&gt;=
                     0.1.0toc.indentationindentation for toc2em&gt;= 0.1.0toc.fontScalethe factor to
                     scale down the font at every toc level0.8&gt;= 0.1.0header.fontSizefont size
                     for use in header13&gt;= 0.1.0header.fontNamename of font for use in
                     headertimes&gt;= 0.1.0header.lefttext for left of header&gt;=
                     0.1.0header.centertext for center of header&gt;= 0.1.0header.righttext for
                     right of header&gt;= 0.1.0header.lineenable or disable horizontal rule under
                     headerboolean&gt;= 0.1.0header.spacingspace between header and content1.8&gt;=
                     0.1.0header.htmlUrlURL or path of HTML to use in header&gt;=
                     0.1.0footer.fontSizefont size for use in footer13&gt;= 0.1.0footer.fontNamename
                     of font for use in footertimes&gt;= 0.1.0footer.lefttext for left of
                     footer&gt;= 0.1.0footer.centertext for center of footer&gt;=
                     0.1.0footer.righttext for right of footer&gt;= 0.1.0footer.lineenable or
                     disable horizontal rule under footerboolean&gt;= 0.1.0footer.spacingspace
                     between footer and content1.8&gt;= 0.1.0footer.htmlUrlURL or path of HTML to
                     use in footer&gt;= 0.1.0load.usernameuser name to use when loging into a
                     websitebart&gt;= 0.1.0load.passwordthe password to used when logging into a
                     websiteelbarto&gt;= 0.1.0load.jsdelaythe amount of time in milliseconds to wait
                     after a page is loaded until it is captured1200&gt;= 0.1.0load.zoomFactorhow
                     much zoom should be applied to the content2.2&gt;=
                     0.1.0load.customHeaderscustom headers to send when requesting the main web
                     page&gt;= 0.1.0load.repertCustomHeadersset true to send with all
                     requestsboolean&gt;= 0.1.0load.cookiescookie string to send when requesting the
                     main web page&gt;= 0.1.0load.postpost string to send when requesting the main
                     web page&gt;= 0.1.0load.blockLocalFileAccessdisallow local and piped files to
                     access other local filesboolean&gt;= 0.1.0load.stopSlowScriptstop slow running
                     javascriptbooleanload.debugJavascriptallow javascript to raise
                     warningsboolean&gt;= 0.1.0load.loadErrorHandlingset error handling
                     strategyabortabort the convertion processskipdo not add the object to the final
                     outputignoretry to add the object to the final output&gt;= 0.1.0load.proxy&gt;=
                     0.1.0web.backgroundinclude background image in outputboolean&gt;=
                     0.1.0web.loadImagesinclude images in outputboolean&gt;=
                     0.1.0web.enableJavascriptenable or disable javascriptboolean&gt;=
                     0.1.0web.enableIntelligentShrinkingenable to attempt to fit more content on
                     page, only applies to PDF outputboolean&gt;= 0.1.0web.minimumFontSizethe
                     minimum font size allowed9&gt;= 0.1.0web.printMediaTypeprint content using
                     print media type instead of screen media typeboolean&gt;=
                     0.1.0web.defaultEncodingcontent to use where no encoding is specifiedutf-8&gt;=
                     0.1.0web.userStyleSheetURL or path to a user specified style
                     sheet/path/to/style.css&gt;= 0.1.0web.enablePluginsenable or disable NS
                     pluginsboolean&gt;= 0.1.0


id: wordwrap
type: function
doc:
<comment>Description:</comment>
  指定した文字数で文字列を分割する
  
  指定した文字数で、指定した文字を用いて文字列を分割します。

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>          入力文字列。
  <info>int</info>     <strong>$width</strong>           文字列を分割するときの文字数。
  <info>string</info>  <strong>$break</strong>           オプションのパラメータ <strong>$break</strong> を用いて行を分割します。
  <info>bool</info>    <strong>$cut_long_words</strong>  <strong>$cut_long_words</strong> を <info>true</info> に設定すると、 文字列は常に指定した <strong>$width</strong> でラッ
                           プされます。このため、 指定した幅よりも長い単語がある場合には、分割されま
                           す (2 番目の例を参照ください)。 <info>false</info> にすると、たとえ <strong>$width</strong> が単語の長
                           さより短かった場合でも、その単語を分割しません。

<comment>Return:</comment>
  <info>string</info>  受け取った文字列を指定した長さで分割したものを返します。

<comment>See Also:</comment>
   * <strong>nl2br()</strong>
   * <strong>chunk_split()</strong>


id: xattr_get
type: function
doc:
<comment>Description:</comment>
  拡張属性を取得する
    
  
  この関数は、ファイルの拡張属性の値を取得します。
  
  拡張属性には二種類の異なる名前空間、つまり、ユーザーとルートがあります。
  ユーザー名前空間は、すべてのユーザーで利用可能ですが、ルート名前空間は、ルート権限を有するユーザー
  のみ利用可能です。
  xattr はデフォルトでユーザー名前空間で処理を行いますが、 <strong>$flags</strong>
  引数によりこれを変更することができます。

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  属性を取得するファイル。
  <info>string</info>  <strong>$name</strong>      属性の名前。
  <info>int</info>     <strong>$flags</strong>     サポートされる xattr のフラグ<info>XATTR_DONTFOLLOW</info>シンボリックリンクのリンク先をたど
                     らず、リンクそのものを操作します。<info>XATTR_ROOT</info>root (信頼された) 名前空間に属性を
                     設定します。root 権限が必要です。

<comment>Return:</comment>
  <info>string</info>  値を含む文字列、あるいは属性が存在しない場合には <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>xattr_list()</strong>
   * <strong>xattr_set()</strong>
   * <strong>xattr_remove()</strong>


id: xattr_list
type: function
doc:
<comment>Description:</comment>
  拡張属性の一覧を取得する
    
  
  この関数は、ファイルの拡張属性の名前の一覧を取得します。
  
  拡張属性には二種類の異なる名前空間、つまり、ユーザーとルートがあります。
  ユーザー名前空間は、すべてのユーザーで利用可能ですが、ルート名前空間は、ルート権限を有するユーザー
  のみ利用可能です。
  xattr はデフォルトでユーザー名前空間で処理を行いますが、 <strong>$flags</strong>
  引数によりこれを変更することができます。

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  ファイルのパス。
  <info>int</info>     <strong>$flags</strong>     サポートされる xattr のフラグ<info>XATTR_DONTFOLLOW</info>シンボリックリンクのリンク先をたど
                     らず、リンクそのものを操作します。<info>XATTR_ROOT</info>root (信頼された) 名前空間に属性を
                     設定します。root 権限が必要です。

<comment>Return:</comment>
  <info>array</info>  この関数は、拡張属性の名前を配列で返します。

<comment>See Also:</comment>
   * <strong>xattr_get()</strong>


id: xattr_remove
type: function
doc:
<comment>Description:</comment>
  拡張属性を削除する
    
  
  この関数は、ファイルの拡張属性を削除します。
  
  拡張属性には二種類の異なる名前空間、つまり、ユーザーとルートがあります。
  ユーザー名前空間は、すべてのユーザーで利用可能ですが、ルート名前空間は、ルート権限を有するユーザー
  のみ利用可能です。
  xattr はデフォルトでユーザー名前空間で処理を行いますが、 <strong>$flags</strong>
  引数によりこれを変更することができます。

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  属性を削除するファイル。
  <info>string</info>  <strong>$name</strong>      削除する属性の名前。
  <info>int</info>     <strong>$flags</strong>     サポートされる xattr のフラグ<info>XATTR_DONTFOLLOW</info>シンボリックリンクのリンク先をたど
                     らず、リンクそのものを操作します。<info>XATTR_ROOT</info>root (信頼された) 名前空間に属性を
                     設定します。root 権限が必要です。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>xattr_list()</strong>
   * <strong>xattr_set()</strong>
   * <strong>xattr_get()</strong>


id: xattr_set
type: function
doc:
<comment>Description:</comment>
  拡張属性を設定する
    
  
  この関数は、ファイルの拡張属性の値を設定します。
  
  拡張属性には二種類の異なる名前空間、つまり、ユーザーとルートがあります。
  ユーザー名前空間は、すべてのユーザーで利用可能ですが、ルート名前空間は、ルート権限を有するユーザー
  のみ利用可能です。
  xattr はデフォルトでユーザー名前空間で処理を行いますが、 <strong>$flags</strong>
  引数によりこれを変更することができます。

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  属性を設定するファイル。
  <info>string</info>  <strong>$name</strong>      拡張属性の名前。もし属性が存在しない場合は新しく作成され、 存在する場合は上書き
                     されます。この振る舞いは、 <strong>$flags</strong> パラメータを使用することで変更可能です。
  <info>string</info>  <strong>$value</strong>     属性の値。
  <info>int</info>     <strong>$flags</strong>     サポートされる xattr のフラグ<info>XATTR_CREATE</info>拡張属性が既に存在する場合、関数は失敗
                     します。<info>XATTR_REPLACE</info>拡張属性が存在しない場合、関数は失敗します。
                     <info>XATTR_DONTFOLLOW</info>シンボリックリンクのリンク先をたどらず、リンクそのものを操作し
                     ます。<info>XATTR_ROOT</info>root (信頼された) 名前空間に属性を設定します。root 権限が必要で
                     す。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>xattr_get()</strong>
   * <strong>xattr_remove()</strong>


id: xattr_supported
type: function
doc:
<comment>Description:</comment>
  ファイルシステムが拡張属性をサポートしているかどうかを調べる
    
  
  この関数は、指定したファイルを保持するファイルシステムが 拡張属性をサポートしているかどうかを調べ
  ます。ファイルに対する 読み込みアクセス権限が必要です。

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  調べるファイルのパス。
  <info>int</info>     <strong>$flags</strong>     サポートされる xattr のフラグ<info>XATTR_DONTFOLLOW</info>シンボリックリンクのリンク先をたど
                     らず、リンクそのものを操作します。

<comment>Return:</comment>
  <info>bool</info>  この関数は、ファイルシステムが拡張属性をサポートしている場合に <info>true</info>、 していない場合に
        <info>false</info>、そして判断できない場合 (たとえばパスが 間違っていたりファイルへのアクセス権限がない場
        合) には <info>null</info> を返します。

<comment>See Also:</comment>
   * <strong>xattr_get()</strong>
   * <strong>xattr_list()</strong>


id: xdiff_file_bdiff
type: function
doc:
<comment>Description:</comment>
  2 つのファイルのバイナリ diff を作成する
  
  ふたつのファイルのバイナリ diff を作成し、その結果をパッチファイルとして保存します。 この関数はテ
  キストファイルとバイナリファイルの両方に適用可能です。 できあがったパッチファイルを後で適用するに
  は <strong>xdiff_file_bpatch()</strong>/<strong>xdiff_string_bpatch()</strong> を使用します。

<comment>Param:</comment>
  <info>string</info>  <strong>$old_file</strong>  最初のファイルへのパス。"旧" ファイルです。
  <info>string</info>  <strong>$new_file</strong>  2 番目のファイルへのパス。"新" ファイルです。
  <info>string</info>  <strong>$dest</strong>      結果のパッチファイルへのパス。 "旧" ファイルと "新" ファイルの差分がこのファイ
                     ルの内容となります。 このファイルはバイナリフォーマットで、人間には読めない形式
                     です。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>xdiff_file_bpatch()</strong>


id: xdiff_file_bdiff_size
type: function
doc:
<comment>Description:</comment>
  バイナリ diff を適用して作成するファイルのサイズを読み込む
  
  ファイル <strong>$file</strong> のバイナリパッチを 元ファイルに適用して作成するファイルのサイズを返します。

<comment>Param:</comment>
  <info>string</info>  <strong>$file</strong>  <strong>xdiff_string_bdiff()</strong> 関数あるいは <strong>xdiff_string_rabdiff()</strong> 関数で作成したバイナリパッ
                 チファイルへのパス。

<comment>Return:</comment>
  <info>int</info>  作成されるファイルのサイズを返します。

<comment>See Also:</comment>
   * <strong>xdiff_file_bdiff()</strong>
   * <strong>xdiff_file_rabdiff()</strong>
   * <strong>xdiff_file_bpatch()</strong>


id: xdiff_file_bpatch
type: function
doc:
<comment>Description:</comment>
  ファイルにバイナリ diff 形式のパッチを適用する
  
  ファイル <strong>$file</strong> にバイナリ形式のパッチファイル <strong>$patch</strong> を適用し、結果をファイル <strong>$dest</strong> に保存します。
  この関数は、<strong>xdiff_file_bdiff()</strong> 関数あるいは <strong>xdiff_file_rabdiff()</strong>、 そしてそれぞれの文字列版が作成
  したパッチを受け取ることができます。

<comment>Param:</comment>
  <info>string</info>  <strong>$file</strong>   元のファイル。
  <info>string</info>  <strong>$patch</strong>  バイナリのパッチファイル。
  <info>string</info>  <strong>$dest</strong>   結果のファイルへのパス。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>xdiff_file_bdiff()</strong>
   * <strong>xdiff_file_rabdiff()</strong>


id: xdiff_file_diff
type: function
doc:
<comment>Description:</comment>
  2 つのファイルの unified diff を作成する
  
  <strong>$old_file</strong> と <strong>$new_file</strong> の差分を含む unified diff を作成し、ファイル <strong>$dest</strong> に保存します。結果は可読
  形式のファイルとなります。 オプションのパラメータ <strong>$context</strong> で、 変更部分の前後にどれだけの行を含め
  るかを指定します。 パラメータ <strong>$minimal</strong> を true にすると、 できる限り短い長さのパッチファイルを出力
  します (長い時間がかかります)。

<comment>Param:</comment>
  <info>string</info>  <strong>$old_file</strong>  最初のファイルへのパス。"旧" ファイルです。
  <info>string</info>  <strong>$new_file</strong>  2 番目のファイルへのパス。"新" ファイルです。
  <info>string</info>  <strong>$dest</strong>      結果のパッチファイルへのパス。
  <info>int</info>     <strong>$context</strong>   diff の結果の前後に含める行の数を指定します。
  <info>bool</info>    <strong>$minimal</strong>   このパラメータを <info>true</info> にすると、結果のファイルが最小になります (長い時間がかか
                     ります)。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>xdiff_file_patch()</strong>


id: xdiff_file_diff_binary
type: function
doc:
<comment>Description:</comment>
  xdiff_file_bdiff のエイリアス
  
  ふたつのファイルのバイナリ diff を作成し、その結果をパッチファイルとして保存します。 この関数はテ
  キストファイルとバイナリファイルの両方に適用可能です。 できあがったパッチファイルを後で適用するに
  は <strong>xdiff_file_bpatch()</strong>. を使用します。
  
  バージョン 1.5.0 以降では、この関数は <strong>xdiff_file_bdiff()</strong> のエイリアスです。

<comment>Param:</comment>
  <info>string</info>  <strong>$old_file</strong>  最初のファイルへのパス。"旧" ファイルです。
  <info>string</info>  <strong>$new_file</strong>  2 番目のファイルへのパス。"新" ファイルです。
  <info>string</info>  <strong>$dest</strong>      結果のパッチファイルへのパス。 "旧" ファイルと "新" ファイルの差分がこのファイ
                     ルの内容となります。 このファイルはバイナリフォーマットで、人間には読めない形式
                     です。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>xdiff_file_bdiff()</strong>
   * <strong>xdiff_file_bpatch()</strong>


id: xdiff_file_merge3
type: function
doc:
<comment>Description:</comment>
  3 つのファイルをひとつに統合する
  
  3 つのファイルをひとつに統合し、結果をファイル <strong>$dest</strong> に保存します。 <strong>$old_file</strong> が元のバージョンで、
  <strong>$new_file1</strong> と <strong>$new_file2</strong> が修正したバージョンとなります。

<comment>Param:</comment>
  <info>string</info>  <strong>$old_file</strong>   最初のファイルへのパス。"旧" ファイルです。
  <info>string</info>  <strong>$new_file1</strong>  2 番目のファイルへのパス。<strong>$old_file</strong> の修正版です。
  <info>string</info>  <strong>$new_file2</strong>  3 番目のファイルへのパス。<strong>$old_file</strong> の修正版です。
  <info>string</info>  <strong>$dest</strong>       結果のファイルへのパス。<strong>$new_file1</strong> と <strong>$new_file2</strong> の両方の変更点をマージした結
                      果が保存されます。

<comment>Return:</comment>
  <info>mixed</info>  成功した場合に <info>true</info> 、もし拒否された部分がある場合にはその文字列、 内部エラーが発生した場合
         に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>xdiff_string_merge3()</strong>


id: xdiff_file_patch
type: function
doc:
<comment>Description:</comment>
  ファイルに unified diff 形式のパッチを適用する
  
  ファイル <strong>$file</strong> にパッチファイル <strong>$patch</strong> を適用し、結果をファイルに保存します。 <strong>$patch</strong> は、
  <strong>xdiff_file_diff()</strong>/<strong>xdiff_string_diff()</strong> 関数で作成した unified diff 形式でなければなりません。 オプ
  ションのパラメータ <strong>$flags</strong> で、操作モードを指定します。

<comment>Param:</comment>
  <info>string</info>  <strong>$file</strong>   元のファイル。
  <info>string</info>  <strong>$patch</strong>  unified 形式のパッチファイル。 <strong>xdiff_string_diff()</strong> 関数や <strong>xdiff_file_diff()</strong> 関数、
                  あるいは互換性のあるツールで作成したものでなければなりません。
  <info>string</info>  <strong>$dest</strong>   結果のファイルへのパス。
  <info>int</info>     <strong>$flags</strong>  <info>XDIFF_PATCH_NORMAL</info>（デフォルト。通常のパッチ）あるいは <info>XDIFF_PATCH_REVERSE</info>（逆パッ
                  チ） のいずれか。
                  
                  バージョン 1.5.0 以降では、バイナリ OR を使用して <info>XDIFF_PATCH_IGNORESPACE</info> フラグを
                  有効にすることもできます。

<comment>Return:</comment>
  <info>mixed</info>  内部エラーが発生した場合に <info>false</info> を返します。 パッチの適用に失敗した場合はパッチが拒否され
         た部分の文字列、 そして成功した場合は <info>true</info> を返します。

<comment>See Also:</comment>
   * <strong>xdiff_file_diff()</strong>


id: xdiff_file_patch_binary
type: function
doc:
<comment>Description:</comment>
  xdiff_file_bpatch のエイリアス
  
  ファイル <strong>$file</strong> にバイナリ形式のパッチファイル <strong>$patch</strong> を適用し、結果をファイル <strong>$dest</strong> に保存します。
  この関数は、<strong>xdiff_file_bdiff()</strong> 関数あるいは <strong>xdiff_file_rabdiff()</strong>、 そしてそれぞれの文字列版が作成
  したパッチを受け取ることができます。
  
  バージョン 1.5.0 以降、この関数は <strong>xdiff_file_bpatch()</strong> のエイリアスとなりました。

<comment>Param:</comment>
  <info>string</info>  <strong>$file</strong>   元のファイル。
  <info>string</info>  <strong>$patch</strong>  バイナリのパッチファイル。
  <info>string</info>  <strong>$dest</strong>   結果のファイルへのパス。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>xdiff_string_patch_binary()</strong>


id: xdiff_file_rabdiff
type: function
doc:
<comment>Description:</comment>
  2 つのファイルのバイナリ diff を、Rabin の polynomial fingerprinting アルゴリズムで作成する
  
  ふたつのファイルのバイナリ diff を作成し、その結果をパッチファイルとして保存します。 この関数と
  <strong>xdiff_file_bdiff()</strong> との違いは、 使用するアルゴリズムです。この関数のほうが実行速度が速く、より小さ
  な diff を生成します。 この関数はテキストファイルとバイナリファイルの両方に適用可能です。 できあ
  がったパッチファイルを後で適用するには <strong>xdiff_file_bpatch()</strong>/<strong>xdiff_string_bpatch()</strong> を使用します。
  
  アルゴリズムの違いについての詳細は、 libxdiff のウェブサイトを参照ください。

<comment>Param:</comment>
  <info>string</info>  <strong>$old_file</strong>  最初のファイルへのパス。"旧" ファイルです。
  <info>string</info>  <strong>$new_file</strong>  2 番目のファイルへのパス。"新" ファイルです。
  <info>string</info>  <strong>$dest</strong>      結果のパッチファイルへのパス。 "旧" ファイルと "新" ファイルの差分がこのファイ
                     ルの内容となります。 このファイルはバイナリフォーマットで、人間には読めない形式
                     です。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>xdiff_file_bpatch()</strong>


id: xdiff_string_bdiff
type: function
doc:
<comment>Description:</comment>
  2 つの文字列のバイナリ diff を作成する
  
  ふたつの文字列のバイナリ diff を作成して結果を返します。 この関数はテキストファイルとバイナリファ
  イルの両方に適用可能です。 できあがったパッチファイルを後で適用するには
  <strong>xdiff_string_bpatch()</strong>/<strong>xdiff_file_bpatch()</strong> を使用します。

<comment>Param:</comment>
  <info>string</info>  <strong>$old_data</strong>  バイナリデータを含む最初の文字列。"旧" データです。
  <info>string</info>  <strong>$new_data</strong>  バイナリデータを含む 2 番目の文字列。"新" データです。

<comment>Return:</comment>
  <info>string</info>  "旧" データと "新" データの差分を含むバイナリ diff 文字列、 あるいは内部エラーが発生した場
          合は <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>xdiff_string_bpatch()</strong>


id: xdiff_string_bdiff_size
type: function
doc:
<comment>Description:</comment>
  バイナリ diff を適用して作成するファイルのサイズを読み込む
  
  バイナリパッチ <strong>$patch</strong> を元ファイルに適用して作成するファイルのサイズを返します。

<comment>Param:</comment>
  <info>string</info>  <strong>$patch</strong>  <strong>xdiff_string_bdiff()</strong> 関数あるいは <strong>xdiff_string_rabdiff()</strong> 関数で作成したバイナリ
                  パッチ。

<comment>Return:</comment>
  <info>int</info>  作成されるファイルのサイズを返します。

<comment>See Also:</comment>
   * <strong>xdiff_string_bdiff()</strong>
   * <strong>xdiff_string_rabdiff()</strong>
   * <strong>xdiff_string_bpatch()</strong>


id: xdiff_string_bpatch
type: function
doc:
<comment>Description:</comment>
  文字列にバイナリ diff 形式のパッチを適用する
  
  文字列 <strong>$str</strong> に、バイナリ形式のパッチ <strong>$patch</strong> を適用します。 この関数は、<strong>xdiff_string_bdiff()</strong> 関数あ
  るいは <strong>xdiff_string_rabdiff()</strong> そしてそれぞれのファイル版が作成したパッチを受け取ることができます。

<comment>Param:</comment>
  <info>string</info>  <strong>$str</strong>    元のバイナリ文字列。
  <info>string</info>  <strong>$patch</strong>  バイナリパッチ文字列。

<comment>Return:</comment>
  <info>string</info>  パッチ適用後の文字列、あるいはエラー時に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>xdiff_string_bdiff()</strong>
   * <strong>xdiff_string_rabdiff()</strong>


id: xdiff_string_diff
type: function
doc:
<comment>Description:</comment>
  2 つの文字列の unified diff を作成する
  
  <strong>$old_data</strong> 文字列と <strong>$new_data</strong> 文字列の差分を含む unified diff を作成し、 結果を返します。結果は可読
  形式となります。 オプションのパラメータ <strong>$context</strong> で、 変更部分の前後にどれだけの行を含めるかを指定
  します。 パラメータ <strong>$minimal</strong> を true にすると、 できる限り短い長さのパッチファイルを出力します (長
  い時間がかかります)。

<comment>Param:</comment>
  <info>string</info>  <strong>$old_data</strong>  データを含む最初の文字列。"旧" データです。
  <info>string</info>  <strong>$new_data</strong>  データを含む 2 番目の文字列。"新" データです。
  <info>int</info>     <strong>$context</strong>   diff の結果の前後に含める行の数を指定します。
  <info>bool</info>    <strong>$minimal</strong>   このパラメータを <info>true</info> にすると、結果のファイルが最小になります (非常に時間がか
                     かります)。結果のファイルは可読形式となります。

<comment>Return:</comment>
  <info>string</info>  成功した場合はその結果の diff、内部エラーが発生した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>xdiff_string_patch()</strong>


id: xdiff_string_diff_binary
type: function
doc:
<comment>Description:</comment>
  xdiff_string_bdiff のエイリアス
  
  ふたつの文字列のバイナリ diff を作成して結果を返します。 この関数はテキストファイルとバイナリファ
  イルの両方に適用可能です。 できあがったパッチファイルを後で適用するには
  <strong>xdiff_string_bpatch()</strong>/<strong>xdiff_file_bpatch()</strong> を使用します。
  
  バージョン 1.5.0 以降では、この関数は <strong>xdiff_string_bdiff()</strong> のエイリアスです。

<comment>Param:</comment>
  <info>string</info>  <strong>$old_data</strong>  バイナリデータを含む最初の文字列。"旧" データです。
  <info>string</info>  <strong>$new_data</strong>  バイナリデータを含む 2 番目の文字列。"新" データです。

<comment>Return:</comment>
  <info>string</info>  成功した場合に結果の文字列、内部エラーが発生した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>xdiff_string_bdiff()</strong>
   * <strong>xdiff_string_bpatch()</strong>


id: xdiff_string_merge3
type: function
doc:
<comment>Description:</comment>
  3 つの文字列をひとつに統合する
  
  3 つの文字列をひとつに結合し、その結果を返します。 <strong>$old_data</strong> が元のバージョンで、 <strong>$new_data1</strong> と
  <strong>$new_data2</strong> が修正したバージョンとなります。オプションの <strong>$error</strong> を使用すると、結合時に拒否された部
  分がそこに渡されます。

<comment>Param:</comment>
  <info>string</info>  <strong>$old_data</strong>   最初のデータ文字列。"旧" データです。
  <info>string</info>  <strong>$new_data1</strong>  2 番目のデータ文字列。<strong>$old_data</strong> の修正版です。
  <info>string</info>  <strong>$new_data2</strong>  3 番目のデータ文字列。<strong>$old_data</strong> の修正版です。
  <info>string</info>  <strong>$error</strong>      指定した場合、パッチを拒否された部分がこの変数に保存されます。

<comment>Return:</comment>
  <info>mixed</info>  統合された文字列を返します。内部エラーが発生した場合は <info>false</info>、 統合された文字列が空の文字列
         の場合は <info>true</info> を返します。

<comment>See Also:</comment>
   * <strong>xdiff_file_merge3()</strong>


id: xdiff_string_patch
type: function
doc:
<comment>Description:</comment>
  文字列に unified diff 形式のパッチを適用する
  
  ある文字列 <strong>$str</strong> に、unified 形式のパッチ文字列 <strong>$patch</strong> を適用してその結果を返します。 <strong>$patch</strong> は、
  <strong>xdiff_file_diff()</strong>/<strong>xdiff_string_diff()</strong> 関数で作成した unified diff 形式でなければなりません。 オプ
  ションのパラメータ <strong>$flags</strong> で、操作モードを指定します。パッチが拒否された部分については、 もし
  <strong>$error</strong> を指定していればそこに保存されます。

<comment>Param:</comment>
  <info>string</info>  <strong>$str</strong>    元の文字列。
  <info>string</info>  <strong>$patch</strong>  unified 形式のパッチ文字列。 <strong>xdiff_string_diff()</strong> 関数や <strong>xdiff_file_diff()</strong> 関数、
                  あるいは互換性のあるツールで作成したものでなければなりません。
  <info>int</info>     <strong>$flags</strong>  <strong>$flags</strong> は <info>XDIFF_PATCH_NORMAL</info> (デフォルト。通常のパッチ) あるいは
                  <info>XDIFF_PATCH_REVERSE</info> (逆パッチ) のいずれかです。
                  
                  バージョン 1.5.0 以降では、バイナリ OR を使用して <info>XDIFF_PATCH_IGNORESPACE</info> フラグを
                  有効にすることもできます。
  <info>string</info>  <strong>$error</strong>  これを指定すると、パッチを拒否された部分がここに保存されます。

<comment>Return:</comment>
  <info>string</info>  パッチ適用後の文字列、あるいはエラー時に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>xdiff_string_diff()</strong>


id: xdiff_string_patch_binary
type: function
doc:
<comment>Description:</comment>
  xdiff_string_bpatch のエイリアス
  
  文字列 <strong>$str</strong> に、バイナリ形式のパッチ <strong>$patch</strong> を適用します。 この関数は、<strong>xdiff_string_bdiff()</strong> 関数あ
  るいは <strong>xdiff_string_rabdiff()</strong> そしてそれぞれのファイル版が作成したパッチを受け取ることができます。
  
  バージョン 1.5.0 以降、この関数は <strong>xdiff_string_bpatch()</strong> のエイリアスとなりました。

<comment>Param:</comment>
  <info>string</info>  <strong>$str</strong>    元のバイナリ文字列。
  <info>string</info>  <strong>$patch</strong>  バイナリパッチ文字列。

<comment>Return:</comment>
  <info>string</info>  パッチ適用後の文字列、あるいはエラー時に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>xdiff_string_bpatch()</strong>
   * <strong>xdiff_string_bdiff()</strong>
   * <strong>xdiff_string_rabdiff()</strong>


id: xdiff_string_rabdiff
type: function
doc:
<comment>Description:</comment>
  2 つの文字列のバイナリ diff を、Rabin の polynomial fingerprinting アルゴリズムで作成する
  
  ふたつの文字列のバイナリ diff を作成して結果を返します。 この関数と <strong>xdiff_string_bdiff()</strong> との違い
  は、 使用するアルゴリズムです。この関数のほうが実行速度が速く、より小さな diff を生成します。 この
  関数はテキストファイルとバイナリファイルの両方に適用可能です。 できあがったパッチファイルを後で適
  用するには <strong>xdiff_string_bpatch()</strong>/<strong>xdiff_file_bpatch()</strong> を使用します。
  
  アルゴリズムの違いについての詳細は、 libxdiff のウェブサイトを参照ください。

<comment>Param:</comment>
  <info>string</info>  <strong>$old_data</strong>  バイナリデータを含む最初の文字列。"旧" データです。
  <info>string</info>  <strong>$new_data</strong>  バイナリデータを含む 2 番目の文字列。"新" データです。

<comment>Return:</comment>
  <info>string</info>  "旧" データと "新" データの差分を含むバイナリ diff 文字列、 あるいは内部エラーが発生した場
          合は <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>xdiff_string_bpatch()</strong>


id: xhprof_disable
type: function
doc:
<comment>Description:</comment>
  xhprof プロファイラを終了する
  
  プロファイラを終了して、xhprof の実行結果データを返します。

<comment>Return:</comment>
  <info>array</info>  実行結果の xhprof データを配列で返します。


id: xhprof_enable
type: function
doc:
<comment>Description:</comment>
  xhprof プロファイラを開始する
  
  xhprof のプロファイリングを開始します。

<comment>Param:</comment>
  <info>int</info>    <strong>$flags</strong>    オプションのフラグで、プロファイル用の追加情報を指定します。フラグの詳細な情報は
                   XHprof 定数 を参照ください。たとえば <info>XHPROF_FLAGS_MEMORY</info> はメモリのプロファイリン
                   グを有効にします。
  <info>array</info>  <strong>$options</strong>  オプション項目の配列。つまり、 'ignored_functions' オプションで関数を渡すと、 そ
                   の関数のプロファイリングを無視したりできます。

<comment>Return:</comment>
  <info>void</info>  <info>null</info>

<comment>See Also:</comment>
   * <strong>xhprof_disable()</strong>
   * <strong>xhprof_sample_enable()</strong>
   * <strong>memory_get_usage()</strong>
   * <strong>getrusage()</strong>


id: xhprof_sample_disable
type: function
doc:
<comment>Description:</comment>
  xhprof サンプルプロファイラを終了する
  
  サンプルモードの xhprof プロファイラを終了します。

<comment>Return:</comment>
  <info>array</info>  xhprof のサンプルデータの配列を返します。


id: xhprof_sample_enable
type: function
doc:
<comment>Description:</comment>
  サンプリングモードでの XHProf プロファイリングを開始する
  
  サンプルモードでのプロファイルを開始します。これは <strong>xhprof_enable()</strong> の軽量版です。 サンプリング間隔
  は 0.1 秒で、完全な関数のコールスタックを記録します。 主な使い道は、パフォーマンス監視や調査などで
  オーバーヘッドを極力抑えたい場合です。

<comment>Return:</comment>
  <info>void</info>  <info>null</info>

<comment>See Also:</comment>
   * <strong>xhprof_sample_disable()</strong>
   * <strong>xhprof_enable()</strong>
   * <strong>memory_get_usage()</strong>
   * <strong>getrusage()</strong>


id: xml_error_string
type: function
doc:
<comment>Description:</comment>
  XML パーサのエラー文字列を得る
  
  エラーコード <strong>$error_code</strong> の説明を有する文字列を 返します。

<comment>Param:</comment>
  <info>int</info>  <strong>$error_code</strong>  <strong>xml_get_error_code()</strong> からのエラーコード。

<comment>Return:</comment>
  <info>string|null</info>  エラーコード <strong>$error_code</strong> の説明を有する文字列を 返します。説明がない場合には <info>null</info> を
               返します。

<comment>See Also:</comment>
   * <strong>xml_get_error_code()</strong>


id: xml_get_current_byte_index
type: function
doc:
<comment>Description:</comment>
  XML パーサのカレントのバイトインデックスを得る
  
  指定した XML パーサのカレントのバイトインデックスを取得します。

<comment>Param:</comment>
  <info>XMLParser</info>  <strong>$parser</strong>  バイトインデックスを得る XML パーサへのリファレンス。

<comment>Return:</comment>
  <info>int</info>  データバッファにおいて、パーサが現在処理中のバイトインデックス (先頭が 0) を返します。

<comment>See Also:</comment>
   * <strong>xml_get_current_column_number()</strong>
   * <strong>xml_get_current_line_number()</strong>


id: xml_get_current_column_number
type: function
doc:
<comment>Description:</comment>
  XML パーサのカレントのカラム番号を取得する
    
  
  指定した XML パーサのカレントのカラム番号を取得します。

<comment>Param:</comment>
  <info>XMLParser</info>  <strong>$parser</strong>  カラム番号を得る XML パーサへのリファレンス。

<comment>Return:</comment>
  <info>int</info>  現在のパーサの (<strong>xml_get_current_line_number()</strong> で取得した) 現在の行のカラムを返します。

<comment>See Also:</comment>
   * <strong>xml_get_current_byte_index()</strong>
   * <strong>xml_get_current_line_number()</strong>


id: xml_get_current_line_number
type: function
doc:
<comment>Description:</comment>
  XML パーサのカレントの行番号を得る
  
  指定した XML パーサのカレントの行番号を取得します。

<comment>Param:</comment>
  <info>XMLParser</info>  <strong>$parser</strong>  行番号を得る XML パーサへのリファレンス。

<comment>Return:</comment>
  <info>int</info>  データバッファの中で、現在パーサが処理中の行番号を返します。

<comment>See Also:</comment>
   * <strong>xml_get_current_column_number()</strong>
   * <strong>xml_get_current_byte_index()</strong>


id: xml_get_error_code
type: function
doc:
<comment>Description:</comment>
  XML パーサのエラーコードを得る
  
  XML パーサのエラーコードを取得します。

<comment>Param:</comment>
  <info>XMLParser</info>  <strong>$parser</strong>  エラーコードを得る XML パーサへのリファレンス。

<comment>Return:</comment>
  <info>int</info>  エラーコードセクション に 一覧が示されたエラーコードを返します。

<comment>See Also:</comment>
   * <strong>xml_error_string()</strong>


id: xml_parse
type: function
doc:
<comment>Description:</comment>
  XML ドキュメントの処理を開始する
  
  <strong>xml_parse()</strong> は XML ドキュメントを処理します。 設定されているイベントのハンドラが、必要に応じてコー
  ルされます。

<comment>Param:</comment>
  <info>XMLParser</info>  <strong>$parser</strong>    使用する XML パーサへのリファレンス。
  <info>string</info>     <strong>$data</strong>      処理するデータ。ドキュメントは、 <strong>$is_final</strong> パラメータが設定され、 最後のデー
                        タが処理され <info>true</info> になるまで、新規のデータに関して 複数回 <strong>xml_parse()</strong> をコー
                        ルすることにより、 部分毎で処理することが可能です。
  <info>bool</info>       <strong>$is_final</strong>  <info>true</info> が設定された場合、<strong>$data</strong> は この処理の間に送られた最後のデータということ
                        になります。

<comment>Return:</comment>
  <info>int</info>  成功した場合に 1、失敗した場合に 0 を返します。
       
       処理が成功しなかった場合、エラー情報を <strong>xml_get_error_code()</strong>, <strong>xml_error_string()</strong>,
       <strong>xml_get_current_line_number()</strong>, <strong>xml_get_current_column_number()</strong> および
       <strong>xml_get_current_byte_index()</strong> により取得可能です。
       
       エンティティのエラーが報告されるのは、ドキュメントの最後で行われます。 つまり <strong>$is_final</strong> が
       <info>true</info> に設定されている場合だけです。


id: xml_parse_into_struct
type: function
doc:
<comment>Description:</comment>
  配列構造体に XML データを処理する
  
  この関数は、XML 文字列を処理し、2つの配列構造体に代入します。 ひとつめの配列 (<strong>$index</strong>) は、配列
  <strong>$values</strong> にある適当な値の位置を指すポインタを保持しています。 これら最後の二つのパラメータは参照渡
  しとする必要があります。

<comment>Param:</comment>
  <info>XMLParser</info>  <strong>$parser</strong>  XML パーサへの参照。
  <info>string</info>     <strong>$data</strong>    XML データを含む文字列。
  <info>array</info>      <strong>$values</strong>  XML データの値を含む配列。
  <info>array</info>      <strong>$index</strong>   $values 内の適切な値の場所をさすポインタの配列。

<comment>Return:</comment>
  <info>int</info>  <strong>xml_parse_into_struct()</strong> は失敗した場合に 0、 成功した場合に 1 を返します。これは <info>false</info> および
       <info>true</info> とは 異なるものですので、=== のような演算子を使用する場合は注意しましょう。


id: xml_parser_create
type: function
doc:
<comment>Description:</comment>
  XML パーサを作成する
  
  <strong>xml_parser_create()</strong> は新しい XML パーサを作成し、 他の XML 関数が使用する <class>XMLParser</class> のインスタンス
  を返します。

<comment>Param:</comment>
  <info>string|null</info>  <strong>$encoding</strong>  入力のエンコーディングは 自動判定されるので、<strong>$encoding</strong> パラメータは 出力の
                          エンコーディングのみを指定することになります。 もし空の文字列が渡された場
                          合、先頭の 3 あるいは 4 バイトの内容をもとに パーサがエンコーディングの判
                          別を試みます。 ではデフォルトの出力文字セットは UTF-8 です。 サポートされ
                          るエンコーディングは <return>ISO-8859-1</return>、<return>UTF-8</return> および <return>US-ASCII</return> です。

<comment>Return:</comment>
  <info>XMLParser</info>  新しい <class>XMLParser</class> のインスタンスを返します。

<comment>See Also:</comment>
   * <strong>xml_parser_create_ns()</strong>
   * <strong>xml_parser_free()</strong>


id: xml_parser_create_ns
type: function
doc:
<comment>Description:</comment>
  名前空間をサポートした XML パーサを生成する
  
  <strong>xml_parser_create_ns()</strong> は XML 名前空間をサポートした 新しい XML パーサを作成し、他の XML 関数が使
  用する <class>XMLParser</class> インスタンスを返します。

<comment>Param:</comment>
  <info>string|null</info>  <strong>$encoding</strong>   入力のエンコーディングは 自動判定されるので、<strong>$encoding</strong> パラメータは 出力
                           のエンコーディングのみを指定することになります。 デフォルトの出力文字セッ
                           トは UTF-8 です。 サポートされるエンコーディングは <return>ISO-8859-1</return>、<return>UTF-8</return> およ
                           び <return>US-ASCII</return> です。
  <info>string</info>       <strong>$separator</strong>  名前空間を含めたタグパラメータをハンドラ関数に渡す際には、 名前空間名とタ
                           グ名を文字列 <strong>$separator</strong> でつなげたものが使用されます。

<comment>Return:</comment>
  <info>XMLParser</info>  新しい <class>XMLParser</class> のインスタンスを返します。

<comment>See Also:</comment>
   * <strong>xml_parser_create()</strong>
   * <strong>xml_parser_free()</strong>


id: xml_parser_free
type: function
doc:
<comment>Description:</comment>
  XML パーサを解放する
  
  この関数を実行しても何も起こりません。PHP 8.0.0 より前のバージョンでは、この関数はリソースを閉じる
  のに使われていました。
  
  指定した XML パーサ <strong>$parser</strong> を解放します。
  
  パースが終了した際、 <strong>xml_parser_free()</strong> 関数を呼び出すのに加えて、 PHP 8.0.0 より前のバージョンでは
  オブジェクトがパーサのリソースを参照している場合に、 メモリリークを避けるために <strong>$parser</strong> の参照を
  明示的に unset することも必要になっています。

<comment>Param:</comment>
  <info>XMLParser</info>  <strong>$parser</strong>  解放したい XML パーサへのリファレンス。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。


id: xml_parser_get_option
type: function
doc:
<comment>Description:</comment>
  XML パーサからオプションを得る
  
  XML パーサからオプションの値を取得します。

<comment>Param:</comment>
  <info>XMLParser</info>  <strong>$parser</strong>  オプションを取得する XML パーサへのリファレンス。
  <info>int</info>        <strong>$option</strong>  取得するオプション。<info>XML_OPTION_CASE_FOLDING</info>, <info>XML_OPTION_SKIP_TAGSTART</info>,
                      <info>XML_OPTION_SKIP_WHITE</info> あるいは <info>XML_OPTION_TARGET_ENCODING</info> が使用可能です。 詳
                      細は <strong>xml_parser_set_option()</strong> を参照ください。

<comment>Return:</comment>
  <info>string|int|bool</info>  オプションの値を返します。


id: xml_parser_set_option
type: function
doc:
<comment>Description:</comment>
  XML パーサのオプションを設定する
  
  XML パーサのオプションを設定します。

<comment>Param:</comment>
  <info>XMLParser</info>        <strong>$parser</strong>  オプションを設定する XML パーサへのリファレンス。
  <info>int</info>              <strong>$option</strong>  設定するオプション。以下を参照ください。
                            
                            次のオプションが利用可能です。 XML パーサオプションオプション定数データ
                            型説明<info>XML_OPTION_CASE_FOLDING</info>bool XMLパーサの大文字変換  を有効にするか
                            どうかを制御する。デフォルトで有効。 <info>XML_OPTION_SKIP_TAGSTART</info>integer タ
                            グ名の最初の何文字を読み飛ばすかどうかを設定する。
                            <info>XML_OPTION_SKIP_WHITE</info>bool 空白文字からなる値を読み飛ばすかどうかを設定す
                            る。 <info>XML_OPTION_TARGET_ENCODING</info>string XML パーサについてどの ターゲット
                            エンコーディング を使用するかを設定する。デフォルトでは、
                            <strong>xml_parser_create()</strong> により使用されたソース エンコーディングと同じエン
                            コーディングが設定されます。 サポートされるターゲットエンコーディング
                            は、 <return>ISO-8859-1</return>, <return>US-ASCII</return>, <return>UTF-8</return> です。
  <info>string|int|bool</info>  <strong>$value</strong>   そのオプションの新しい設定値。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を返します。 失敗した場合、<info>false</info> を返します。


id: xml_set_character_data_handler
type: function
doc:
<comment>Description:</comment>
  文字データハンドラを設定する
  
  XML パーサ <strong>$parser</strong> の文字データ用ハンドラ関数を設定します。

<comment>Param:</comment>
  <info>XMLParser</info>  <strong>$parser</strong>   XMLパーサ
  <info>callable</info>   <strong>$handler</strong>  <info>null</info> や空文字列を渡すと、ハンドラはデフォルトの状態にリセットされます。
                       
                       <strong>$handler</strong> が <info>callable</info> の場合、その callable がハンドラとして設定されます。
                       
                       <strong>$handler</strong> が文字列の場合、<strong>xml_set_object()</strong> で設定されたオブジェクトのメソッド
                       名になります。
                       
                       <strong>$handler</strong> のシグネチャは、以下でなければいけません:
                       <info>void</info>handler<info>XMLParser</info><strong>$parser</strong><info>string</info><strong>$data</strong> <strong>$parser</strong> ハンドラをコールするXMLパーサ
                       <strong>$data</strong> 文字データを文字列として指定します。
                       
                       ハンドラをコールするXMLパーサ
                       
                       文字データを文字列として指定します。
                       
                       文字データハンドラは、XML ドキュメントのすべてのテキストに対してコールされま
                       す。 (たとえば非 ASCII 文字列などで) ひとつのフラグメント内で複数回コールされ
                       ることもあります。
  <info>XMLParser</info>  <strong>$parser</strong>   ハンドラをコールするXMLパーサ
  <info>string</info>     <strong>$data</strong>     文字データを文字列として指定します。

<comment>Return:</comment>
  <info>true</info>  常に <info>true</info> を返します。


id: xml_set_default_handler
type: function
doc:
<comment>Description:</comment>
  デフォルトのハンドラを設定する
  
  XMLパーサ <strong>$parser</strong> のデフォルトのハンドラ関数を設定します。

<comment>Param:</comment>
  <info>XMLParser</info>  <strong>$parser</strong>   XMLパーサ
  <info>callable</info>   <strong>$handler</strong>  <info>null</info> や空文字列を渡すと、ハンドラはデフォルトの状態にリセットされます。
                       
                       <strong>$handler</strong> が <info>callable</info> の場合、その callable がハンドラとして設定されます。
                       
                       <strong>$handler</strong> が文字列の場合、<strong>xml_set_object()</strong> で設定されたオブジェクトのメソッド
                       名になります。
                       
                       <strong>$handler</strong> のシグネチャは、以下でなければいけません:
                       <info>void</info>handler<info>XMLParser</info><strong>$parser</strong><info>string</info><strong>$data</strong> <strong>$parser</strong> ハンドラをコールするXMLパーサ
                       <strong>$data</strong><strong>$data</strong> には、文字データを文字列として指定します。 これは、XML 宣言または
                       ドキュメント型宣言、エンティティ、 他にハンドラがない別のデータとすることが可
                       能です。
                       
                       ハンドラをコールするXMLパーサ
                       
                       <strong>$data</strong> には、文字データを文字列として指定します。 これは、XML 宣言またはドキュ
                       メント型宣言、エンティティ、 他にハンドラがない別のデータとすることが可能で
                       す。
  <info>XMLParser</info>  <strong>$parser</strong>   ハンドラをコールするXMLパーサ
  <info>string</info>     <strong>$data</strong>     <strong>$data</strong> には、文字データを文字列として指定します。 これは、XML 宣言またはドキュ
                       メント型宣言、エンティティ、 他にハンドラがない別のデータとすることが可能で
                       す。

<comment>Return:</comment>
  <info>true</info>  常に <info>true</info> を返します。


id: xml_set_element_handler
type: function
doc:
<comment>Description:</comment>
  開始要素および終了要素のハンドラを設定する
  
  XML パーサ <strong>$parser</strong> の要素ハンドラ関数を設定します。
  
  <strong>$start_handler</strong> は、新しいXML要素が開始された場合にコールされます。<strong>$end_handler</strong> は、XML要素が終了し
  た場合にコールされます。

<comment>Param:</comment>
  <info>XMLParser</info>  <strong>$parser</strong>         XMLパーサ
  <info>callable</info>   <strong>$start_handler</strong>  <info>null</info> や空文字列を渡すと、ハンドラはデフォルトの状態にリセットされます。
                             
                             <strong>$handler</strong> が <info>callable</info> の場合、その callable がハンドラとして設定されま
                             す。
                             
                             <strong>$handler</strong> が文字列の場合、<strong>xml_set_object()</strong> で設定されたオブジェクトのメ
                             ソッド名になります。
                             
                             シグネチャは、以下でなければいけません:
                             <info>void</info>start_element_handler<info>XMLParser</info><strong>$parser</strong><info>string</info><strong>$name</strong><info>array</info><strong>$attributes</strong>
                             <strong>$parser</strong> ハンドラをコールするXMLパーサ <strong>$name</strong> このハンドラがコールされた
                             要素の名前です。 大文字変換 がこのパーサに関して有効な場合、要素の名前
                             は大文字になります。 <strong>$attributes</strong> 要素の属性に関する連想配列です。 要素
                             に属性がない場合、配列は空になります。 この配列のキーは属性の名前であ
                             り、 値は属性の値です。属性の名前は、要素名と同様に 大文字変換 となりま
                             す。 属性の値は、大文字変換 されません。 <strong>$attributes</strong> を順次アクセスする
                             ことにより、 属性を宣言した元の順序で取得することができます。
                             
                             ハンドラをコールするXMLパーサ
                             
                             このハンドラがコールされた要素の名前です。 大文字変換 がこのパーサに関
                             して有効な場合、要素の名前は大文字になります。
                             
                             要素の属性に関する連想配列です。 要素に属性がない場合、配列は空になりま
                             す。 この配列のキーは属性の名前であり、 値は属性の値です。属性の名前
                             は、要素名と同様に 大文字変換 となります。 属性の値は、大文字変換 され
                             ません。
                             
                             <strong>$attributes</strong> を順次アクセスすることにより、 属性を宣言した元の順序で取得
                             することができます。
  <info>XMLParser</info>  <strong>$parser</strong>         ハンドラをコールするXMLパーサ
  <info>string</info>     <strong>$name</strong>           このハンドラがコールされた要素の名前です。 大文字変換 がこのパーサに関
                             して有効な場合、要素の名前は大文字になります。
  <info>array</info>      <strong>$attributes</strong>     要素の属性に関する連想配列です。 要素に属性がない場合、配列は空になりま
                             す。 この配列のキーは属性の名前であり、 値は属性の値です。属性の名前
                             は、要素名と同様に 大文字変換 となります。 属性の値は、大文字変換 され
                             ません。
                             
                             <strong>$attributes</strong> を順次アクセスすることにより、 属性を宣言した元の順序で取得
                             することができます。
  <info>callable</info>   <strong>$end_handler</strong>    <info>null</info> や空文字列を渡すと、ハンドラはデフォルトの状態にリセットされます。
                             
                             <strong>$handler</strong> が <info>callable</info> の場合、その callable がハンドラとして設定されま
                             す。
                             
                             <strong>$handler</strong> が文字列の場合、<strong>xml_set_object()</strong> で設定されたオブジェクトのメ
                             ソッド名になります。
                             
                             ハンドラのシグネチャは、以下でなければいけません:
                             <info>void</info>end_element_handler<info>XMLParser</info><strong>$parser</strong><info>string</info><strong>$name</strong> <strong>$parser</strong> ハンドラを
                             コールするXMLパーサ <strong>$name</strong> このハンドラがコールされた要素の名前です。 こ
                             のパーサにおいて 大文字変換  が有効な場合、要素名は大文字になります。
                             
                             ハンドラをコールするXMLパーサ
                             
                             このハンドラがコールされた要素の名前です。 このパーサにおいて 大文字変
                             換  が有効な場合、要素名は大文字になります。
  <info>XMLParser</info>  <strong>$parser</strong>         ハンドラをコールするXMLパーサ
  <info>string</info>     <strong>$name</strong>           このハンドラがコールされた要素の名前です。 このパーサにおいて 大文字変
                             換  が有効な場合、要素名は大文字になります。

<comment>Return:</comment>
  <info>true</info>  常に <info>true</info> を返します。


id: xml_set_end_namespace_decl_handler
type: function
doc:
<comment>Description:</comment>
  名前空間終了ハンドラを設定する
  
  名前空間宣言のスコープを抜けるときにコールされるハンドラを設定します。 これがコールされるのは、各
  名前空間宣言において、 名前空間が宣言された要素の終了タグのハンドラがコールされた後のことです。
  
  このイベントは libXML ではサポートされていません。 そのため、登録されたハンドラは呼ばれません。

<comment>Param:</comment>
  <info>XMLParser</info>     <strong>$parser</strong>   XMLパーサ
  <info>callable</info>      <strong>$handler</strong>  <info>null</info> や空文字列を渡すと、ハンドラはデフォルトの状態にリセットされます。
                          
                          <strong>$handler</strong> が <info>callable</info> の場合、その callable がハンドラとして設定されます。
                          
                          <strong>$handler</strong> が文字列の場合、<strong>xml_set_object()</strong> で設定されたオブジェクトのメソッ
                          ド名になります。
                          
                          <strong>$handler</strong> のシグネチャは、以下でなければいけません:
                          handler<info>XMLParser</info><strong>$parser</strong><info>string</info><info>false</info></info><strong>$prefix</strong> <strong>$parser</strong> ハンドラをコールする
                          XMLパーサ <strong>$prefix</strong> XML オブジェクト内の名前空間を参照する際に使う文字列。
                          prefix が存在しない場合は、<info>false</info> になります。
                          
                          ハンドラをコールするXMLパーサ
                          
                          XML オブジェクト内の名前空間を参照する際に使う文字列。 prefix が存在しない
                          場合は、<info>false</info> になります。
  <info>XMLParser</info>     <strong>$parser</strong>   ハンドラをコールするXMLパーサ
  <info>string|false</info>  <strong>$prefix</strong>   XML オブジェクト内の名前空間を参照する際に使う文字列。 prefix が存在しない
                          場合は、<info>false</info> になります。

<comment>Return:</comment>
  <info>true</info>  常に <info>true</info> を返します。

<comment>See Also:</comment>
   * <strong>xml_set_start_namespace_decl_handler()</strong>


id: xml_set_external_entity_ref_handler
type: function
doc:
<comment>Description:</comment>
  外部エンティティリファレンスハンドラを設定する
  
  XML パーサ <strong>$parser</strong> の外部エンティティ参照用ハンドラ関数を設定します。

<comment>Param:</comment>
  <info>XMLParser</info>     <strong>$parser</strong>             XMLパーサ
  <info>callable</info>      <strong>$handler</strong>            <info>null</info> や空文字列を渡すと、ハンドラはデフォルトの状態にリセットさ
                                    れます。
                                    
                                    <strong>$handler</strong> が <info>callable</info> の場合、その callable がハンドラとして設定
                                    されます。
                                    
                                    <strong>$handler</strong> が文字列の場合、<strong>xml_set_object()</strong> で設定されたオブジェク
                                    トのメソッド名になります。
                                    
                                    <strong>$handler</strong> のシグネチャは、以下でなければいけません:
                                    <info>bool</info>handler<info>XMLParser</info><strong>$parser</strong><info>string</info><strong>$open_entity_names</strong><info>string</info><info>false</info></info><strong>$base</strong><info>string</info><strong>$system_id</strong><info>string</info><info>false</info></info><strong>$public_id</strong>
                                    <strong>$parser</strong> ハンドラをコールするXMLパーサ <strong>$open_entity_names</strong> エン
                                    ティティの処理を行うためにオープンされたエンティティの 名前のス
                                    ペース区切りのリストです (参照されるエンティティの名前を含みま
                                    す)。 <strong>$base</strong> これは外部エンティティのシステム ID (<strong>$systemid</strong>) の
                                    ベースとして解決されます。 <strong>$system_id</strong> エンティティ宣言で指定され
                                    たシステム ID です。 <strong>$public_id</strong> エンティティ宣言で 指定されたパ
                                    ブリック ID または指定されない場合は空の 文字列です。パブリック
                                    ID の中の空白文字は、XML 仕様で規定された 正規化を行っています。
                                    
                                    ハンドラをコールするXMLパーサ
                                    
                                    エンティティの処理を行うためにオープンされたエンティティの 名前
                                    のスペース区切りのリストです (参照されるエンティティの名前を含み
                                    ます)。
                                    
                                    これは外部エンティティのシステム ID (<strong>$systemid</strong>) のベースとして解
                                    決されます。
                                    
                                    エンティティ宣言で指定されたシステム ID です。
                                    
                                    エンティティ宣言で 指定されたパブリック ID または指定されない場
                                    合は空の 文字列です。パブリック ID の中の空白文字は、XML 仕様で
                                    規定された 正規化を行っています。
                                    
                                    ハンドラは、エンティティを処理された場合、<info>true</info> を返す必要があり
                                    ます。 そうでない場合、<info>false</info> を返すべきです。 ハンドラから返され
                                    た値が <info>false</info> の場合、XML パーサは処理を中断し、
                                    <strong>xml_get_error_code()</strong> は <info>XML_ERROR_EXTERNAL_ENTITY_HANDLING</info> を返
                                    します。
  <info>XMLParser</info>     <strong>$parser</strong>             ハンドラをコールするXMLパーサ
  <info>string</info>        <strong>$open_entity_names</strong>  エンティティの処理を行うためにオープンされたエンティティの 名前
                                    のスペース区切りのリストです (参照されるエンティティの名前を含み
                                    ます)。
  <info>string|false</info>  <strong>$base</strong>               これは外部エンティティのシステム ID (<strong>$systemid</strong>) のベースとして解
                                    決されます。
  <info>string</info>        <strong>$system_id</strong>          エンティティ宣言で指定されたシステム ID です。
  <info>string|false</info>  <strong>$public_id</strong>          エンティティ宣言で 指定されたパブリック ID または指定されない場
                                    合は空の 文字列です。パブリック ID の中の空白文字は、XML 仕様で
                                    規定された 正規化を行っています。

<comment>Return:</comment>
  <info>true</info>  常に <info>true</info> を返します。


id: xml_set_notation_decl_handler
type: function
doc:
<comment>Description:</comment>
  表記法宣言ハンドラを設定する
  
  XML パーサ <strong>$parser</strong> の表記法宣言用ハンドラ関数を設定します。
  
  表記法の宣言は、ドキュメントの DTD の一部であり、 次のようなフォーマットとなります。 $name</strong>
  { <strong>$systemId</strong> | <strong>$publicId</strong>?>
  ]]> 表記法宣言の定義に関しては、 XML 1.0 仕様の 4.7 節  を参照ください。

<comment>Param:</comment>
  <info>XMLParser</info>     <strong>$parser</strong>         XMLパーサ
  <info>callable</info>      <strong>$handler</strong>        <info>null</info> や空文字列を渡すと、ハンドラはデフォルトの状態にリセットされま
                                す。
                                
                                <strong>$handler</strong> が <info>callable</info> の場合、その callable がハンドラとして設定され
                                ます。
                                
                                <strong>$handler</strong> が文字列の場合、<strong>xml_set_object()</strong> で設定されたオブジェクトの
                                メソッド名になります。
                                
                                ハンドラのシグネチャは、以下でなければいけません:
                                <info>void</info>handler<info>XMLParser</info><strong>$parser</strong><info>string</info><strong>$notation_name</strong><info>string</info><info>false</info></info><strong>$base</strong><info>string</info><strong>$system_id</strong><info>string</info><info>false</info></info><strong>$public_id</strong>
                                <strong>$parser</strong> ハンドラをコールするXMLパーサ <strong>$notation_name</strong> これは、前述の
                                表記用フォーマットに示すように表記法の名前です。 <strong>$base</strong> 外部エンティ
                                ティのシステムID(<return>system_id</return>)を 取得する際の基本となります。
                                <strong>$system_id</strong> 外部表記用宣言のシステム ID <strong>$public_id</strong> 外部表記用宣言のパ
                                ブリック ID
                                
                                ハンドラをコールするXMLパーサ
                                
                                これは、前述の表記用フォーマットに示すように表記法の名前です。
                                
                                外部エンティティのシステムID(<return>system_id</return>)を 取得する際の基本となりま
                                す。
                                
                                外部表記用宣言のシステム ID
                                
                                外部表記用宣言のパブリック ID
  <info>XMLParser</info>     <strong>$parser</strong>         ハンドラをコールするXMLパーサ
  <info>string</info>        <strong>$notation_name</strong>  これは、前述の表記用フォーマットに示すように表記法の名前です。
  <info>string|false</info>  <strong>$base</strong>           外部エンティティのシステムID(<return>system_id</return>)を 取得する際の基本となりま
                                す。
  <info>string</info>        <strong>$system_id</strong>      外部表記用宣言のシステム ID
  <info>string|false</info>  <strong>$public_id</strong>      外部表記用宣言のパブリック ID

<comment>Return:</comment>
  <info>true</info>  常に <info>true</info> を返します。


id: xml_set_object
type: function
doc:
<comment>Description:</comment>
  オブジェクト内部で XML パーサを使用する
  
  この関数は、<strong>$object</strong> の内部から <strong>$parser</strong> を使用可能にします。 <strong>xml_set_element_handler()</strong> 等により設定
  される 全てのコールバック関数は、<strong>$object</strong> のメソッドであると仮定されます。

<comment>Param:</comment>
  <info>XMLParser</info>  <strong>$parser</strong>  オブジェクト内部で使う XML パーサへの参照。
  <info>object</info>     <strong>$object</strong>  XML パーサを使うオブジェクト。

<comment>Return:</comment>
  <info>true</info>  常に <info>true</info> を返します。


id: xml_set_processing_instruction_handler
type: function
doc:
<comment>Description:</comment>
  処理命令 (PI) 用ハンドラを設定する
    
  
  XML パーサ <strong>$parser</strong>の処理命令 (PI) 用ハンドラ関数を設定します。
  
  処理命令のフォーマットは以下のとおりです: 
  ]]>
  
  PHP コードは、処理命令 <return>\<?php</return> によって区切られます。 よって、XMLドキュメントに PHP コードを入れることが可能です。 しかし、PI 終了タグ (<return>?&gt;</return>) をデータに含めてはいけません。 PI 終了タグ が埋め込まれたPHPコードの一部として存在していた場合、 残りの PHP コードは、"真の" PI 終了タグと同じく文字データとして処理されます。

<comment>Param:</comment>
  <info>XMLParser</info>  <strong>$parser</strong>   XMLパーサ
  <info>callable</info>   <strong>$handler</strong>  <info>null</info> や空文字列を渡すと、ハンドラはデフォルトの状態にリセットされます。
                       
                       <strong>$handler</strong> が <info>callable</info> の場合、その callable がハンドラとして設定されます。
                       
                       <strong>$handler</strong> が文字列の場合、<strong>xml_set_object()</strong> で設定されたオブジェクトのメソッド
                       名になります。
                       
                       <strong>$handler</strong> のシグネチャは、下記でなければいけません:
                       <info>void</info>handler<info>XMLParser</info><strong>$parser</strong><info>string</info><strong>$target</strong><info>string</info><strong>$data</strong> <strong>$parser</strong> ハンドラをコール
                       するXMLパーサ <strong>$target</strong> 処理命令のターゲット <strong>$data</strong> 処理命令のデータ
                       
                       ハンドラをコールするXMLパーサ
                       
                       処理命令のターゲット
                       
                       処理命令のデータ
  <info>XMLParser</info>  <strong>$parser</strong>   ハンドラをコールするXMLパーサ
  <info>string</info>     <strong>$target</strong>   処理命令のターゲット
  <info>string</info>     <strong>$data</strong>     処理命令のデータ

<comment>Return:</comment>
  <info>true</info>  常に <info>true</info> を返します。


id: xml_set_start_namespace_decl_handler
type: function
doc:
<comment>Description:</comment>
  名前空間開始ハンドラを設定する
    
  
  名前空間を宣言したところでコールされるハンドラを設定します。 名前空間の宣言は、開始タグの中で行い
  ます。 しかし、名前空間宣言の開始ハンドラがコールされるのは、 その開始タグのハンドラがコールされる
  より前になります。

<comment>Param:</comment>
  <info>XMLParser</info>     <strong>$parser</strong>   XMLパーサ
  <info>callable</info>      <strong>$handler</strong>  <info>null</info> や空文字列を渡すと、ハンドラはデフォルトの状態にリセットされます。
                          
                          <strong>$handler</strong> が <info>callable</info> の場合、その callable がハンドラとして設定されます。
                          
                          <strong>$handler</strong> が文字列の場合、<strong>xml_set_object()</strong> で設定されたオブジェクトのメソッ
                          ド名になります。
                          
                          <strong>$handler</strong> のシグネチャは、以下でなければいけません:
                          <info>void</info>handler<info>XMLParser</info><strong>$parser</strong><info>string</info><info>false</info></info><strong>$prefix</strong><info>string</info><strong>$uri</strong> <strong>$parser</strong> ハンドラを
                          コールするXMLパーサ <strong>$prefix</strong> XML オブジェクト内の名前空間を参照する際に使う
                          文字列。 存在しない場合は <info>false</info> になります。 <strong>$uri</strong> 名前空間の URI。
                          
                          ハンドラをコールするXMLパーサ
                          
                          XML オブジェクト内の名前空間を参照する際に使う文字列。 存在しない場合は
                          <info>false</info> になります。
                          
                          名前空間の URI。
  <info>XMLParser</info>     <strong>$parser</strong>   ハンドラをコールするXMLパーサ
  <info>string|false</info>  <strong>$prefix</strong>   XML オブジェクト内の名前空間を参照する際に使う文字列。 存在しない場合は
                          <info>false</info> になります。
  <info>string</info>        <strong>$uri</strong>      名前空間の URI。

<comment>Return:</comment>
  <info>true</info>  常に <info>true</info> を返します。

<comment>See Also:</comment>
   * <strong>xml_set_end_namespace_decl_handler()</strong>


id: xml_set_unparsed_entity_decl_handler
type: function
doc:
<comment>Description:</comment>
  処理されないエンティティ宣言用ハンドラを設定する
    
  
  XML パーサ <strong>$parser</strong> の、 処理されないエンティティ宣言用ハンドラ関数を設定します。
  
  このハンドラは、XML パーサが次のような NDATA 宣言を有する 外部エンティティ宣言を処理する際にコール
  されます。 $name</strong> {<strong>$publicId</strong> | <strong>$systemId</strong>} NDATA <strong>$notationName</strong>
  ]]>
  
  外部エンティティ宣言の記述用定義に関しては、 XML 1.0 仕様の 4.2.2 節を参照ください。

<comment>Param:</comment>
  <info>XMLParser</info>     <strong>$parser</strong>         XMLパーサ
  <info>callable</info>      <strong>$handler</strong>        <info>null</info> や空文字列を渡すと、ハンドラはデフォルトの状態にリセットされま
                                す。
                                
                                <strong>$handler</strong> が <info>callable</info> の場合、その callable がハンドラとして設定され
                                ます。
                                
                                <strong>$handler</strong> が文字列の場合、<strong>xml_set_object()</strong> で設定されたオブジェクトの
                                メソッド名になります。
                                
                                <strong>$handler</strong> のシグネチャは、以下でなければいけません:
                                <info>void</info>handler<info>XMLParser</info><strong>$parser</strong><info>string</info><strong>$entity_name</strong><info>string</info><info>false</info></info><strong>$base</strong><info>string</info><strong>$system_id</strong><info>string</info><info>false</info></info><strong>$public_id</strong><info>string</info><info>false</info></info><strong>$notation_name</strong>
                                <strong>$parser</strong> ハンドラをコールするXMLパーサ <strong>$entity_name</strong> 定義しようとする
                                エンティティの名前。 <strong>$base</strong> 外部エンティティのシステム ID(<strong>$systemId</strong>)
                                を取得する際のベースになります。 <strong>$system_id</strong> 外部エンティティのシステ
                                ム ID。 <strong>$public_id</strong>  外部エンティティのパブリック ID。 <strong>$notation_name</strong>
                                このエンティティの表記法の名前 (<strong>xml_set_notation_decl_handler()</strong> を参
                                照ください)。
                                
                                ハンドラをコールするXMLパーサ
                                
                                定義しようとするエンティティの名前。
                                
                                外部エンティティのシステム ID(<strong>$systemId</strong>) を取得する際のベースになり
                                ます。
                                
                                外部エンティティのシステム ID。
                                
                                外部エンティティのパブリック ID。
                                
                                このエンティティの表記法の名前 (<strong>xml_set_notation_decl_handler()</strong> を参
                                照ください)。
  <info>XMLParser</info>     <strong>$parser</strong>         ハンドラをコールするXMLパーサ
  <info>string</info>        <strong>$entity_name</strong>    定義しようとするエンティティの名前。
  <info>string|false</info>  <strong>$base</strong>           外部エンティティのシステム ID(<strong>$systemId</strong>) を取得する際のベースになり
                                ます。
  <info>string</info>        <strong>$system_id</strong>      外部エンティティのシステム ID。
  <info>string|false</info>  <strong>$public_id</strong>      外部エンティティのパブリック ID。
  <info>string|false</info>  <strong>$notation_name</strong>  このエンティティの表記法の名前 (<strong>xml_set_notation_decl_handler()</strong> を参
                                照ください)。

<comment>Return:</comment>
  <info>true</info>  常に <info>true</info> を返します。


id: xmlrpc_decode
type: function
doc:
<comment>Description:</comment>
  XML をネイティブな PHP 型にデコードする
  
  この関数は、
  実験的 なものです。この関数の動作・
  名前・その他ドキュメントに書かれている事項は、予告なく、将来的な PHP
  のリリースにおいて変更される可能性があります。
  この関数は自己責任で使用してください。

<comment>Param:</comment>
  <info>string</info>  <strong>$xml</strong>       XMLRPC メソッドが返す XML レスポンス。
  <info>string</info>  <strong>$encoding</strong>  iconv がサポートする入力エンコーディング。

<comment>Return:</comment>
  <info>mixed</info>  XMLRPC メソッドのレスポンスをもとに作成した、 配列あるいは整数、文字列、boolean 値を返しま
         す。

<comment>See Also:</comment>
   * <strong>xmlrpc_encode_request()</strong>
   * <strong>xmlrpc_is_fault()</strong>


id: xmlrpc_decode_request
type: function
doc:
<comment>Description:</comment>
  XML をネイティブなPHP 型にデコードする
  
  この関数は、
  実験的 なものです。この関数の動作・
  名前・その他ドキュメントに書かれている事項は、予告なく、将来的な PHP
  のリリースにおいて変更される可能性があります。
  この関数は自己責任で使用してください。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>mixed</info>  


id: xmlrpc_encode
type: function
doc:
<comment>Description:</comment>
  PHP の値に関する XML を生成する
  
  この関数は、
  実験的 なものです。この関数の動作・
  名前・その他ドキュメントに書かれている事項は、予告なく、将来的な PHP
  のリリースにおいて変更される可能性があります。
  この関数は自己責任で使用してください。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>string</info>  


id: xmlrpc_encode_request
type: function
doc:
<comment>Description:</comment>
  メソッドリクエスト用の XML を生成する
  
  この関数は、
  実験的 なものです。この関数の動作・
  名前・その他ドキュメントに書かれている事項は、予告なく、将来的な PHP
  のリリースにおいて変更される可能性があります。
  この関数は自己責任で使用してください。

<comment>Param:</comment>
  <info>string</info>  <strong>$method</strong>          コールするメソッドの名前。
  <info>mixed</info>   <strong>$params</strong>          メソッドのシグネチャに対応したパラメータ。
  <info>array</info>   <strong>$output_options</strong>  出力オプションを指定する配列。以下の内容が指定できます (強調してあるもの
                           がデフォルトです)。 output_type: php, xmlverbosity: no_white_space,
                           newlines_only, prettyescaping: cdata, non-ascii, non-print, markup (単一
                           の値を表す文字列、あるいは複数の値の配列となります)version: simple,
                           xmlrpc, soap 1.1, autoencoding: iso-8859-1, その他 iconv がサポートする文
                           字セット
                           
                           output_type: php, xml
                           
                           verbosity: no_white_space, newlines_only, pretty
                           
                           escaping: cdata, non-ascii, non-print, markup (単一の値を表す文字列、ある
                           いは複数の値の配列となります)
                           
                           version: simple, xmlrpc, soap 1.1, auto
                           
                           encoding: iso-8859-1, その他 iconv がサポートする文字セット

<comment>Return:</comment>
  <info>string</info>  リクエストを表す XML 文字列を返します。

<comment>See Also:</comment>
   * <strong>stream_context_create()</strong>
   * <strong>file_get_contents()</strong>
   * <strong>xmlrpc_decode()</strong>


id: xmlrpc_get_type
type: function
doc:
<comment>Description:</comment>
  PHP の値に関する xmlrpc 型を取得する
  
  この関数は、
  実験的 なものです。この関数の動作・
  名前・その他ドキュメントに書かれている事項は、予告なく、将来的な PHP
  のリリースにおいて変更される可能性があります。
  この関数は自己責任で使用してください。
  
  この関数は特に base64 及び datetime 文字列で有用です。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  PHP の値。

<comment>Return:</comment>
  <info>string</info>  XML-RPC の型を返します。

<comment>See Also:</comment>
   * <strong>xmlrpc_set_type()</strong>


id: xmlrpc_is_fault
type: function
doc:
<comment>Description:</comment>
  配列の値が XMLRPC の失敗であるかどうかを調べる
  
  この関数は、
  実験的 なものです。この関数の動作・
  名前・その他ドキュメントに書かれている事項は、予告なく、将来的な PHP
  のリリースにおいて変更される可能性があります。
  この関数は自己責任で使用してください。

<comment>Param:</comment>
  <info>array</info>  <strong>$arg</strong>  <strong>xmlrpc_decode()</strong> が返す配列。

<comment>Return:</comment>
  <info>bool</info>  引数が失敗を表す場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。 失敗の内容は
        <return>$arg["faultString"]</return>、失敗のコードは <return>$arg["faultCode"]</return> に格納されます。

<comment>See Also:</comment>
   * <strong>xmlrpc_decode()</strong>


id: xmlrpc_parse_method_descriptions
type: function
doc:
<comment>Description:</comment>
  XML を、メソッド説明のリストにデコードする
  
  この関数は、
  実験的 なものです。この関数の動作・
  名前・その他ドキュメントに書かれている事項は、予告なく、将来的な PHP
  のリリースにおいて変更される可能性があります。
  この関数は自己責任で使用してください。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>array</info>  


id: xmlrpc_server_add_introspection_data
type: function
doc:
<comment>Description:</comment>
  introspection ドキュメントを追加する
  
  この関数は、
  実験的 なものです。この関数の動作・
  名前・その他ドキュメントに書かれている事項は、予告なく、将来的な PHP
  のリリースにおいて変更される可能性があります。
  この関数は自己責任で使用してください。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>int</info>  


id: xmlrpc_server_call_method
type: function
doc:
<comment>Description:</comment>
  XML リクエストをパースし、メソッドをコールする
  
  この関数は、
  実験的 なものです。この関数の動作・
  名前・その他ドキュメントに書かれている事項は、予告なく、将来的な PHP
  のリリースにおいて変更される可能性があります。
  この関数は自己責任で使用してください。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>string</info>  


id: xmlrpc_server_create
type: function
doc:
<comment>Description:</comment>
  xmlrpc サーバーを作成する
  
  この関数は、
  実験的 なものです。この関数の動作・
  名前・その他ドキュメントに書かれている事項は、予告なく、将来的な PHP
  のリリースにおいて変更される可能性があります。
  この関数は自己責任で使用してください。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>resource</info>  


id: xmlrpc_server_destroy
type: function
doc:
<comment>Description:</comment>
  サーバーリソースを破棄する
  
  この関数は、
  実験的 なものです。この関数の動作・
  名前・その他ドキュメントに書かれている事項は、予告なく、将来的な PHP
  のリリースにおいて変更される可能性があります。
  この関数は自己責任で使用してください。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>bool</info>  


id: xmlrpc_server_register_introspection_callback
type: function
doc:
<comment>Description:</comment>
  ドキュメントを生成する PHP 関数を登録する
  
  この関数は、
  実験的 なものです。この関数の動作・
  名前・その他ドキュメントに書かれている事項は、予告なく、将来的な PHP
  のリリースにおいて変更される可能性があります。
  この関数は自己責任で使用してください。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>bool</info>  


id: xmlrpc_server_register_method
type: function
doc:
<comment>Description:</comment>
  メソッド名が一致するメソッドリソースに PHP 関数を登録する
  
  この関数は、
  実験的 なものです。この関数の動作・
  名前・その他ドキュメントに書かれている事項は、予告なく、将来的な PHP
  のリリースにおいて変更される可能性があります。
  この関数は自己責任で使用してください。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>bool</info>  


id: xmlrpc_set_type
type: function
doc:
<comment>Description:</comment>
  PHP 文字列型用に xmlrpc 型、base64 または datetime を設定する
  
  PHP の文字列用の xmlrpc 型を、base64 あるいは datetime に設定します。
  
  この関数は、
  実験的 なものです。この関数の動作・
  名前・その他ドキュメントに書かれている事項は、予告なく、将来的な PHP
  のリリースにおいて変更される可能性があります。
  この関数は自己責任で使用してください。

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>  型を設定する値。
  <info>string</info>  <strong>$type</strong>   'base64' あるいは 'datetime'。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。 成功した場合、<strong>$value</strong> はオブジェク
        ト型に変換されます。


id: yaml_emit
type: function
doc:
<comment>Description:</comment>
  YAML 形式にした値を返す
  
  <strong>$data</strong> で渡したデータを YAML 形式にして返します。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$data</strong>       エンコードしたいデータ。リソース型以外の任意の型が使えます。
  <info>int</info>    <strong>$encoding</strong>   出力時の文字エンコーディング。 <info>YAML_ANY_ENCODING</info>、 <info>YAML_UTF8_ENCODING</info>、
                     <info>YAML_UTF16LE_ENCODING</info>、 <info>YAML_UTF16BE_ENCODING</info> のいずれか。
  <info>int</info>    <strong>$linebreak</strong>  出力時の改行形式。 <info>YAML_ANY_BREAK</info>、 <info>YAML_CR_BREAK</info>、 <info>YAML_LN_BREAK</info>、
                     <info>YAML_CRLN_BREAK</info> のいずれか。
  <info>array</info>  <strong>$callbacks</strong>  YAML ノードの発行用のコンテンツハンドラ。 クラス名 =&gt; <info>callable</info> 形式の連想配
                     列となります。 詳細は発行コールバック を参照ください。

<comment>Return:</comment>
  <info>string</info>  成功した場合に YAML 形式の文字列を返します。

<comment>See Also:</comment>
   * <strong>yaml_emit_file()</strong>
   * <strong>yaml_parse()</strong>


id: yaml_emit_file
type: function
doc:
<comment>Description:</comment>
  YAML 形式にした値をファイルに送る
  
  <strong>$data</strong> で渡したデータを YAML 形式にして <strong>$filename</strong> に書き込みます。

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>   ファイルへのパス。
  <info>mixed</info>   <strong>$data</strong>       エンコードしたいデータ。リソース型以外の任意の型が使えます。
  <info>int</info>     <strong>$encoding</strong>   出力時の文字エンコーディング。 <info>YAML_ANY_ENCODING</info>、 <info>YAML_UTF8_ENCODING</info>、
                      <info>YAML_UTF16LE_ENCODING</info>、 <info>YAML_UTF16BE_ENCODING</info> のいずれか。
  <info>int</info>     <strong>$linebreak</strong>  出力時の改行形式。 <info>YAML_ANY_BREAK</info>、 <info>YAML_CR_BREAK</info>、 <info>YAML_LN_BREAK</info>、
                      <info>YAML_CRLN_BREAK</info> のいずれか。
  <info>array</info>   <strong>$callbacks</strong>  YAML ノードの発行用のコンテンツハンドラ。 クラス名 =&gt; <info>callable</info> 形式の連想配
                      列となります。 詳細は発行コールバック を参照ください。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を返します。

<comment>See Also:</comment>
   * <strong>yaml_emit()</strong>
   * <strong>yaml_parse()</strong>


id: yaml_parse
type: function
doc:
<comment>Description:</comment>
  YAML ストリームをパースする
  
  YAML ドキュメントストリーム全体あるいはその一部を、PHP の変数に変換します。

<comment>Param:</comment>
  <info>string</info>  <strong>$input</strong>      YAML ドキュメントストリームとしてパースする文字列。
  <info>int</info>     <strong>$pos</strong>        ストリームから取り出すドキュメント (<return>-1</return> はすべてのドキュメント、<return>0</return> は最初のド
                      キュメント、...)。
  <info>int</info>     <strong>$ndocs</strong>      <strong>$ndocs</strong> を渡すと、 ストリーム内で見つかったドキュメントの数がそこに格納されま
                      す。
  <info>array</info>   <strong>$callbacks</strong>  YAML ノードのコンテンツハンドラ。 YAML タグ =&gt; <info>callable</info> 形式の連想配列とな
                      ります。 詳細はパースコールバック を参照ください。

<comment>Return:</comment>
  <info>mixed</info>  適切な PHP の型に変換した結果を返します。 失敗した場合に <info>false</info> を返します。 <strong>$pos</strong> が <return>-1</return> の場
         合は配列を返します。 配列の各要素が、ストリーム内で見つかった個々のドキュメントとなります。

<comment>See Also:</comment>
   * <strong>yaml_parse_file()</strong>
   * <strong>yaml_parse_url()</strong>
   * <strong>yaml_emit()</strong>


id: yaml_parse_file
type: function
doc:
<comment>Description:</comment>
  ファイルからの YAML ストリームをパースする
  
  指定したファイルから読み込んだ YAML ドキュメントストリーム全体あるいはその一部を、PHP の変数に変換
  します。

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>   ファイルへのパス。
  <info>int</info>     <strong>$pos</strong>        ストリームから取り出すドキュメント (<return>-1</return> はすべてのドキュメント、<return>0</return> は最初のド
                      キュメント、...)。
  <info>int</info>     <strong>$ndocs</strong>      <strong>$ndocs</strong> を渡すと、 ストリーム内で見つかったドキュメントの数がそこに格納されま
                      す。
  <info>array</info>   <strong>$callbacks</strong>  YAML ノードのコンテンツハンドラ。 YAML タグ =&gt; <info>callable</info> 形式の連想配列とな
                      ります。 詳細はパースコールバック を参照ください。

<comment>Return:</comment>
  <info>mixed</info>  適切な PHP の型に変換した結果を返します。 失敗した場合に <info>false</info> を返します。 <strong>$pos</strong> が <return>-1</return> の場
         合は配列を返します。 配列の各要素が、ストリーム内で見つかった個々のドキュメントとなります。

<comment>See Also:</comment>
   * <strong>yaml_parse()</strong>
   * <strong>yaml_parse_url()</strong>
   * <strong>yaml_emit()</strong>


id: yaml_parse_url
type: function
doc:
<comment>Description:</comment>
  URL からの YAML ストリームをパースする
  
  指定した URL から読み込んだ YAML ドキュメントストリーム全体あるいはその一部を、PHP の変数に変換し
  ます。

<comment>Param:</comment>
  <info>string</info>  <strong>$url</strong>        <strong>$url</strong> は "scheme://..." 形式でなければなりません。 PHP は、このスキームを見てプ
                      ロトコルハンドラ (ラッパー) を探します。 対応するラッパーが登録されていない場
                      合は notice を発し、 そのまま通常のファイルとみなして処理を続けます。
  <info>int</info>     <strong>$pos</strong>        ストリームから取り出すドキュメント (<return>-1</return> はすべてのドキュメント、<return>0</return> は最初のド
                      キュメント、...)。
  <info>int</info>     <strong>$ndocs</strong>      <strong>$ndocs</strong> を渡すと、 ストリーム内で見つかったドキュメントの数がそこに格納されま
                      す。
  <info>array</info>   <strong>$callbacks</strong>  YAML ノードのコンテンツハンドラ。 YAML タグ =&gt; <info>callable</info> 形式の連想配列とな
                      ります。 詳細はパースコールバック を参照ください。

<comment>Return:</comment>
  <info>mixed</info>  適切な PHP の型に変換した結果を返します。 失敗した場合に <info>false</info> を返します。 <strong>$pos</strong> が <return>-1</return> の場
         合は配列を返します。 配列の各要素が、ストリーム内で見つかった個々のドキュメントとなります。

<comment>See Also:</comment>
   * <strong>yaml_parse()</strong>
   * <strong>yaml_parse_file()</strong>
   * <strong>yaml_emit()</strong>


id: yaz_addinfo
type: function
doc:
<comment>Description:</comment>
  詳細なエラー情報を返す
  
  サーバー上での直近のリクエストに関する詳細なエラーメッセージを返します。
  
  サーバーによっては、この関数は <strong>yaz_error()</strong> と同じ 文字列を返すことがあります。

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>  <strong>yaz_connect()</strong> が返す接続リソース。

<comment>Return:</comment>
  <info>string</info>  エラーの詳細情報を文字列で返します。直近の処理が成功したか、あるいは サーバーから詳細な情
          報が提供されていない場合には、空の文字列を返します。

<comment>See Also:</comment>
   * <strong>yaz_error()</strong>
   * <strong>yaz_errno()</strong>


id: yaz_ccl_conf
type: function
doc:
<comment>Description:</comment>
  CCL パーサを設定する
  
  この関数は、アクセスポイント(CCL限定辞)が定義するサーバーに関して CCL クエリパーサと RPN へのマッ
  ピングを設定します。
  
  特定の CCL クエリを後で RPN にマップするには、 <strong>yaz_ccl_parse()</strong> 関数をコールしてください。

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>      <strong>yaz_connect()</strong> が返す接続リソース。
  <info>array</info>     <strong>$config</strong>  設定の配列。配列の各キーが CCL フィールドの名前で、対応する値は RPN へのマッピ
                     ングを指定する文字列です。
                     
                     マッピングは、属性型と属性値の組が並んだものです。 属性型と属性値は、等号（<return>=</return>）
                     で区切られ、 組と組の間は空白で区切られます。
                     
                     詳細な情報は CCL のページを 参照ください。

<comment>Return:</comment>
  <info>void</info>  値を返しません。

<comment>See Also:</comment>
   * <strong>yaz_ccl_parse()</strong>


id: yaz_ccl_parse
type: function
doc:
<comment>Description:</comment>
  CCL パーサを起動する
  
  この関数は、CCL パーサを起動します。パーサは、指定された CCL FIND クエリを RPN クエリに変換しま
  す。これは検索を実行する <strong>yaz_search()</strong> 関数に渡すためのものです。
  
  有効な CCL フィールドの組を定義するには、この関数の前に <strong>yaz_ccl_conf()</strong> をコールします。

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>      <strong>yaz_connect()</strong> が返す接続リソース。
  <info>string</info>    <strong>$query</strong>   CCL FIND クエリ。
  <info>array</info>     <strong>$result</strong>  関数が成功した場合、キー <return>rpn</return> に有効な RPN クエリを含む配列となります。
                     
                     失敗した場合は、以下の 3 つの添え字を含む配列となり、失敗の原因を示します。
                     <return>errorcode</return> - CCL エラーコード（整数） <return>errorstring</return> - CCL エラー文字列 <return>errorpos</return> -
                     クエリが失敗したおおよその位置 （文字の位置を整数で表す）
                     
                     <return>errorcode</return> - CCL エラーコード（整数）
                     
                     <return>errorstring</return> - CCL エラー文字列
                     
                     <return>errorpos</return> - クエリが失敗したおおよその位置 （文字の位置を整数で表す）

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。


id: yaz_close
type: function
doc:
<comment>Description:</comment>
  YAZ 接続をクローズする
  
  <strong>$id</strong> で指定した接続をクローズします。
  
  この関数は、<return>persistent</return> オプションを <info>false</info> にして <strong>yaz_connect()</strong> でオープンした 持続的でない接続のみ
  をクローズします。

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>  <strong>yaz_connect()</strong> が返す接続リソース。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>yaz_connect()</strong>


id: yaz_connect
type: function
doc:
<comment>Description:</comment>
  Z39.50 サーバーへの接続を準備する
    
  
  この関数は、成功した場合に接続リソース、失敗した場合にゼロを返します。
  
  <strong>yaz_connect()</strong> は Z39.50 サーバーへの接続を準備します。 この関数は非ブロックモードで動作し、接続を
  確立しようとしません - 単にあとで <strong>yaz_wait()</strong> がコールされた際に 接続を実行する準備を行うだけです。
  
  YAZ プロキシ は、フリーで使用可能な Z39.50 のプロキシです。

<comment>Param:</comment>
  <info>string</info>  <strong>$zurl</strong>     <return>host[:port][/database]</return> という形式の文字列です。 port が省略された場合、210 が使
                    用されます。database が省略された 場合、<return>Default</return> が使用されます。
  <info>mixed</info>   <strong>$options</strong>  文字列が指定された場合、 Z39.50 V2 認証文字列(OpenAuth)として処理されます。
                    
                    配列が指定された場合、その配列の内容はオプションとして処理されます。 user 認証用
                    のユーザー名 group 認証用のグループ password 認証用のパスワード cookie セッショ
                    ンクッキー（YAZ プロキシ） proxy 接続用プロキシ（YAZ プロキシ） persistent 論理
                    値。<info>true</info> の場合、接続は持続的となります。<info>false</info> の 場合、接続は持続的ではありませ
                    ん。デフォルトでは 接続は持続的です。  持続的な接続をオープンした場合、後でそれ
                    を <strong>yaz_close()</strong> によってクローズすることは できません。 piggyback 論理値。<info>true</info> の
                    場合、検索時の piggyback が有効になります。 <info>false</info> の場合、piggyback が無効になり
                    ます。デフォルトでは piggyback は有効です。  piggyback を有効にするとより効率的
                    となり、 通常、レコードを最初に取得する際のネットワーク往復時間を 節約することが
                    可能です。しかし、少数の Z39.50 ターゲットは piggyback をサポートしていないか、
                    エレメント集合名を無視します。 この場合、piggyback を無効とする必要があります。
                    charset Z39.50 の言語および文字セットネゴシエーションに使用する 文字セットを指定
                    する文字列。以下のような文字列を使用します。 <return>ISO-8859-1</return>、<return>UTF-8</return>、 <return>UTF-16</return> 。  ほと
                    んどの Z39.50 サーバーはこの機能をサポートしません（そのため、 無視されます）。
                    ほとんどのサーバーは、クエリやメッセージに ISO-8859-1 エンコーディングを使用しま
                    す。MARC21/USMARC レコードは この設定の影響を受けません。 preferredMessageSize
                    ターゲットから取得される全レコードの最大バイト数を指定する整数値。 詳細な情報は
                    Z39.50 standard を参照ください。  このオプションは PECL YAZ 1.0.5 以降でサポート
                    されます。 maximumRecordSize ターゲットから取得される単一のレコードの最大バイト
                    数を指定する 整数値。この項目は、 Z39.50 standard の Exceptional-record-size と
                    して参照されます。  このオプションは PECL YAZ 1.0.5 以降でサポートされます。
                    
                    認証用のユーザー名
                    
                    認証用のグループ
                    
                    認証用のパスワード
                    
                    セッションクッキー（YAZ プロキシ）
                    
                    接続用プロキシ（YAZ プロキシ）
                    
                    論理値。<info>true</info> の場合、接続は持続的となります。<info>false</info> の 場合、接続は持続的ではあり
                    ません。デフォルトでは 接続は持続的です。
                    
                    持続的な接続をオープンした場合、後でそれを <strong>yaz_close()</strong> によってクローズすること
                    は できません。
                    
                    論理値。<info>true</info> の場合、検索時の piggyback が有効になります。 <info>false</info> の場合、
                    piggyback が無効になります。デフォルトでは piggyback は有効です。
                    
                    piggyback を有効にするとより効率的となり、 通常、レコードを最初に取得する際の
                    ネットワーク往復時間を 節約することが可能です。しかし、少数の Z39.50 ターゲット
                    は piggyback をサポートしていないか、エレメント集合名を無視します。 この場合、
                    piggyback を無効とする必要があります。
                    
                    Z39.50 の言語および文字セットネゴシエーションに使用する 文字セットを指定する文字
                    列。以下のような文字列を使用します。 <return>ISO-8859-1</return>、<return>UTF-8</return>、 <return>UTF-16</return> 。
                    
                    ほとんどの Z39.50 サーバーはこの機能をサポートしません（そのため、 無視されま
                    す）。ほとんどのサーバーは、クエリやメッセージに ISO-8859-1 エンコーディングを使
                    用します。MARC21/USMARC レコードは この設定の影響を受けません。
                    
                    ターゲットから取得される全レコードの最大バイト数を指定する整数値。 詳細な情報は
                    Z39.50 standard を参照ください。
                    
                    このオプションは PECL YAZ 1.0.5 以降でサポートされます。
                    
                    ターゲットから取得される単一のレコードの最大バイト数を指定する 整数値。この項目
                    は、 Z39.50 standard の Exceptional-record-size として参照されます。
                    
                    このオプションは PECL YAZ 1.0.5 以降でサポートされます。

<comment>Return:</comment>
  <info>mixed</info>  成功した場合に接続リソース、エラー時に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>yaz_close()</strong>


id: yaz_database
type: function
doc:
<comment>Description:</comment>
  セッション内のデータベースを指定する
    
  
  この関数は、検索、取得等で使用する１つまたは複数のデータベースを指定します。 <strong>yaz_connect()</strong> をコー
  ルする際に指定したデータベースを上書きします。

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>         <strong>yaz_connect()</strong> が返す接続リソース。
  <info>string</info>    <strong>$databases</strong>  ひとつあるいは複数のデータベースを表す文字列。複数のデータベースは、可算記号
                        <return>+</return> で区切ります。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。


id: yaz_element
type: function
doc:
<comment>Description:</comment>
  取得時の要素集合の名前を指定する
    
  
  この関数は、取得時の要素集合の名前を指定します。
  
  この関数は、<strong>yaz_search()</strong> あるいは <strong>yaz_present()</strong> をコールする前に、 取得するレコードの要素集合の名
  前を指定するために使用します。
  
  この関数が動作していないように見える場合は、 <strong>yaz_connect()</strong> の <return>piggybacking</return> オプションについての説
  明を 参照ください。

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>          <strong>yaz_connect()</strong> が返す接続リソース。
  <info>string</info>    <strong>$elementset</strong>  ほとんどのサーバーは、 <return>F</return>（完全版）および <return>B</return>（短縮版） をサポートします。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。


id: yaz_errno
type: function
doc:
<comment>Description:</comment>
  エラー番号を返す
  
  <strong>$id</strong> で表される サーバーの（直近のリクエストについての）エラー番号を返します。
  
  <strong>yaz_errno()</strong> は、各ターゲットへのネットワーク接続が 確立された後(つまり、<strong>yaz_wait()</strong>の後)に コールさ
  れる必要があり、直近の操作(例えば検索)が成功したか 失敗したかを判定します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>  <strong>yaz_connect()</strong> が返す接続リソース。

<comment>Return:</comment>
  <info>int</info>  エラーコードを返します。エラーコードは Z39.50 診断コード （通常は Bib-1 診断）あるいは
       PHP/YAZ が生成するクライアント側の エラーコード（たとえば "Connect failed"、"Init Rejected"
       など） のいずれかです。

<comment>See Also:</comment>
   * <strong>yaz_error()</strong>
   * <strong>yaz_addinfo()</strong>


id: yaz_error
type: function
doc:
<comment>Description:</comment>
  エラーの内容を返す
  
  <strong>yaz_error()</strong> は、<strong>yaz_errno()</strong> で返された直近のエラー番号に対応する英語のメッセージを返します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>  <strong>yaz_connect()</strong> が返す接続リソース。

<comment>Return:</comment>
  <info>string</info>  <strong>$id</strong> で表される(直近のリクエストの) サーバーに関するエラーメッセージを返します。 直近の操作
          が成功した場合には空の文字列が返されます。

<comment>See Also:</comment>
   * <strong>yaz_errno()</strong>
   * <strong>yaz_addinfo()</strong>


id: yaz_es
type: function
doc:
<comment>Description:</comment>
  拡張サービスのリクエストを準備する
    
  
  この関数は、拡張サービスのリクエストを準備します。 拡張サービスとは、レコードの更新や蔵書の注文、
  データベースの管理などの Z39.50 のさまざまな機能のことです。
  
  Z39.50 サーバーの多くは、拡張サービスをサポートしていません。
  
  <strong>yaz_es()</strong> は、拡張サービスリクエストのパッケージを作成し、 それを操作キューに配置します。リクエスト
  をサーバーに送信するには <strong>yaz_wait()</strong> を使用します。 <strong>yaz_wait()</strong> の処理が完了すると、拡張サービス操作
  の結果が <strong>yaz_es_result()</strong> で取得できるようになります。

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>    <strong>yaz_connect()</strong> が返す接続リソース。
  <info>string</info>    <strong>$type</strong>  拡張サービスの形式を表す文字列。 <return>itemorder</return> (蔵書の注文)、 <return>create</return> (データベースの
                   作成)、 <return>drop</return> (データベースの削除)、 <return>commit</return> (操作のコミット)、 <return>update</return> (レコードの
                   更新)、 <return>xmlupdate</return> (XMLの更新) のいずれかです。 個々の形式については、以下の節で指
                   定されます。
  <info>array</info>     <strong>$args</strong>  拡張サービスのオプションに加えてパッケージ固有のオプションを指定する配列。 オプ
                   ションの形式は、ZOOM C の C API で提供されているものと同じです。 ZOOM Extended
                   Services を参照ください。

<comment>Return:</comment>
  <info>void</info>  値を返しません。

<comment>See Also:</comment>
   * <strong>yaz_es_result()</strong>


id: yaz_es_result
type: function
doc:
<comment>Description:</comment>
  拡張サービスの結果を調査する
    
  
  この関数は、サーバーから返された直近の拡張サービスの結果を調査します。 拡張サービスは、
  <strong>yaz_item_order()</strong> あるいは <strong>yaz_es()</strong> で起動します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>  <strong>yaz_connect()</strong> が返す接続リソース。

<comment>Return:</comment>
  <info>array</info>  要素 <return>targetReference</return> を持つ配列を返します。 この要素には (サーバー側で生成して返された) 拡
         張サービス操作への参照が格納されます。

<comment>See Also:</comment>
   * <strong>yaz_es()</strong>


id: yaz_get_option
type: function
doc:
<comment>Description:</comment>
  接続に関するオプションの値を返す
  
  <strong>$name</strong> で指定したオプションの値を返します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>    <strong>yaz_connect()</strong> が返す接続リソース。
  <info>string</info>    <strong>$name</strong>  オプションの名前。

<comment>Return:</comment>
  <info>string</info>  指定したオプションの値を返します。オプションが設定されていない場合は 空文字列を返します。

<comment>See Also:</comment>
   * 
     使用可能なオプションについては、<strong>yaz_set_option()</strong>
     を参照ください。
    


id: yaz_hits
type: function
doc:
<comment>Description:</comment>
  直近の検索に関するヒット数を返す
  
  <strong>yaz_hits()</strong> は、直近の検索に関するヒット数を返します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>            <strong>yaz_connect()</strong> が返す接続リソース。
  <info>array</info>     <strong>$searchresult</strong>  詳細な検索結果情報の配列。

<comment>Return:</comment>
  <info>int</info>  直近の検索に関するヒット数を返します。検索が行われていない場合は 0 を返します。
       
       検索結果配列がもし指定されていた場合、そこには Z39.50 サーバーが返す情報が 含まれます。この情
       報の形式は、検索結果の応答の一部である SearchResult-1 フォーマットとなります。 SearchResult-1
       フォーマットは、さまざまなクエリ(サブクエリ)のヒット数に 関する情報を取得するために使用可能で
       す。 特に、クエリ内の個々の検索語句に関するヒット数を得ることが可能です。 最初のサブクエリに
       ついての情報が $array[0] に、2 番目のサブクエリについての 情報が $array[1] に、というような形
       式となります。
       
       SearchResult 機能を使用するには、PECL YAZ 1.0.5 以降 および YAZ 2.1.9 以降が必要です。
       
       SearchResult 機能をサポートしている Z39.50 実装は ほとんどありません。


id: yaz_itemorder
type: function
doc:
<comment>Description:</comment>
  ILL リクエストパッケージを関して Z39.50 Item Order を準備する
    
  
  この関数は、Transport ILL (Profile/1) への Z39.50 Item Order Extended Service 用のプロファイルを使
  用する Extended Services リクエストを準備します。 このページ および 仕様 を参照ください。

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>    <strong>yaz_connect()</strong> が返す接続リソース。
  <info>array</info>     <strong>$args</strong>  送信する Item Order リクエストに関する情報を有するハッシュ配列とする必要がありま
                   す。 このハッシュ配列のキーは、対応する ASN.1 タグのパス名です。たとえば、
                   Item-ID 以下に ISBN がある場合のキーは item-id,ISBN となります。
                   
                   ILL-Request パラメータは次のようになります。
                   
                   Extended Services Request パッケージおよび ItemOrder パッケージにも 次のようない
                   くつかのパラメータがあります。

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: yaz_present
type: function
doc:
<comment>Description:</comment>
  (Z39.50による)取得の準備を行う
    
  
  この関数は、検索に成功した後でレコードを取得するための準備を行います。
  
  この関数をコールする前に、取得するレコードの範囲を指定するために まず <strong>yaz_range()</strong> をコールしておく
  必要があります。

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>  <strong>yaz_connect()</strong> が返す接続リソース。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。


id: yaz_range
type: function
doc:
<comment>Description:</comment>
  取得するレコードの範囲を指定する
    
  
  取得するレコードの範囲を指定します。
  
  この関数は、<strong>yaz_search()</strong> あるいは <strong>yaz_present()</strong> の前にコールしなければなりません。

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>      <strong>yaz_connect()</strong> が返す接続リソース。
  <info>int</info>       <strong>$start</strong>   取得する最初のレコードの位置を指定します。レコード番号は 1 から <strong>yaz_hits()</strong> まで
                     です。
  <info>int</info>       <strong>$number</strong>  取得するレコードの数を指定します。

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: yaz_record
type: function
doc:
<comment>Description:</comment>
  レコードを返す
  
  <strong>yaz_record()</strong> 関数は、現在の結果セットの <strong>$pos</strong> で指定した位置にあるレコードを調べます。

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>      <strong>yaz_connect()</strong> が返す接続リソース。
  <info>int</info>       <strong>$pos</strong>     レコードの位置。結果セット内の位置は 1, 2, ... $hits で表されます。 ここで、
                     $hits は <strong>yaz_hits()</strong> が返す値です。
  <info>string</info>    <strong>$type</strong>    <strong>$type</strong> は、返されるレコードの型を指定します。
                     
                     Z39.50/SRW サーバーから適切な形式でレコードが返されたことを 確認するのは、アプ
                     リケーション側の役目です。このパラメータは 単にクライアント側（PHP/YAZ 内）での
                     型変換についてのみ設定します。
                     
                     レコードを文字列/配列に変換することに加え、PHP/YAZ はレコードの 文字セットを変
                     換することも可能です。 特に USMARC/MARC21 の場合に文字セット変換が推奨されま
                     す。なぜなら これらは一般的に結果を MARC-8 文字セットで返しますが、ブラウザでは
                     この文字セットがサポートされていないからです。変換を指定するには、 <return>;
                     charset=</return>from<return>, </return>to を追加します。 from はレコードの元の文字セットで、 to は結果の
                     文字セット（PHP によって 表示されるもの）です。
                     
                     レコードは、単純な形式の文字列で返されます。 このモードではすべての MARC レコー
                     ドが ISO2709 の行単位 フォーマットに変換されますが、これは非常に読みにくいもの
                     です。 XML レコードおよび SUTRS は、本来のフォーマットのまま返されます。 GRS-1
                     は（醜い）行単位フォーマットで返されます。
                     
                     このフォーマットが役に立つのは、結果を手っ取り早く表示したい場合 - デバッグ中な
                     ど - の場合です。適切な形式で表示するのには適していません。
                     
                     レコードは、可能ならば XML 文字列として返されます。 このモードでは、すべての
                     MARC レコードは MARCXML に変換されます。 XML レコードおよび SUTRS は、本来の
                     フォーマットのままで返されます。 GRS-1 はサポートしていません。
                     
                     このフォーマットは <strong>$string</strong> と似ていますが、 MARC レコードが MARCXML に変換され
                     る点が違います。
                     
                     このフォーマットは、レコードが XML パーサや XSLT プロセッサに 渡される場合に役
                     立ちます。
                     
                     レコードは、その本来のフォーマットのままで返されます。 MARC、XML および SUTRS
                     で使用可能です。GRS-1 では動作しません。
                     
                     MARC レコードは ISO2709 文字列として返されます。XML および SUTRS は文字列として
                     返されます。
                     
                     レコードの構文が文字列で返されます。たとえば <return>USmarc</return>、<return>GRS-1</return>、 <return>XML</return> などです。
                     
                     レコードの該当位置に関連するデータベースの名前を文字列で返します。
                     
                     レコードは、GRS-1 の構造を反映した配列で返されます。 この型は MARC および GRS-1
                     で使用可能です。XML、SUTRS はサポートされておらず、実際のレコードが XML あるい
                     は SUTRS であった場合は空文字列が返されます。
                     
                     返される配列には、GRS-1 の各リーフ/内部ノードに対応するリストが 含まれます。
                     個々のリスト内にもリストがあり、 最初の要素が path でその次が data です（もし
                     data が存在する場合）。
                     
                     path は、ルートから各リーフまでの（構造化された GRS-1 レコードの） ツリーコン
                     ポーネントの一覧を保持します。各コンポーネントはタグ型で、 タグの値は <return>(</return>type<return>,</return>
                     value のような形式のペアとなります。
                     
                     tags 文字列は、一般に type 3 の tag に対応します。 MARC は配列で返すことも可能
                     です（内部で GRS-1 に変換されます）。
  <info></info>          <strong>$string</strong>  レコードは、可能ならば XML 文字列として返されます。 このモードでは、すべての
                     MARC レコードは MARCXML に変換されます。 XML レコードおよび SUTRS は、本来の
                     フォーマットのままで返されます。 GRS-1 はサポートしていません。
                     
                     このフォーマットは <strong>$string</strong> と似ていますが、 MARC レコードが MARCXML に変換され
                     る点が違います。
                     
                     このフォーマットは、レコードが XML パーサや XSLT プロセッサに 渡される場合に役
                     立ちます。

<comment>Return:</comment>
  <info>string</info>  位置 <strong>$pos</strong> のレコードを返します。もし指定した位置に レコードが存在しない場合は空文字列を返
          します。
          
          もし指定した位置にデータベースのレコードが存在しない場合、 空文字列が返されます。


id: yaz_scan
type: function
doc:
<comment>Description:</comment>
  スキャンの準備をする
  
  この関数は、指定した接続上で Z39.50 スキャンリクエストの 準備をします。
  
  実際にスキャンリクエストをサーバーへ送信して応答を受信するには、 <strong>yaz_wait()</strong> をコールする必要があり
  ます。 <strong>yaz_wait()</strong> のコールが完了した後、応答を処理するために <strong>yaz_error()</strong> および <strong>yaz_scan_result()</strong>
  をコールします。

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>         <strong>yaz_connect()</strong> が返す接続リソース。
  <info>string</info>    <strong>$type</strong>       現時点では <return>rpn</return> 型のみがサポートされています。
  <info>string</info>    <strong>$startterm</strong>  スキャンを開始する項目の位置。
                        
                        開始項目の形式は、パラメータ <strong>$type</strong> で与えられます。
                        
                        このパラメータの構文は、 <strong>yaz_search()</strong> で説明した RPN クエリに似ています。
                        startterm は、ゼロ以上の <return>@attr</return> 演算子の後に トークンがひとつだけ続く形式とな
                        ります。
  <info>array</info>     <strong>$flags</strong>      オプションのパラメータで、スキャンリクエストの動作を制御する 追加情報を指定
                        します。現在、次の3つの添字が flags 配列から 読み込まれます。 <return>number</return>（リクエ
                        ストされた語の数）、 <return>position</return>（要求された語の位置）、 <return>stepSize</return>（要求されたス
                        テップ数）

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: yaz_scan_result
type: function
doc:
<comment>Description:</comment>
  スキャンリクエストの結果を返す
  
  <strong>yaz_scan_result()</strong> は、直近の <strong>yaz_scan()</strong> の実行時にサーバーから受信した 項目と関連情報を返します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>      <strong>yaz_connect()</strong> が返す接続リソース。
  <info>array</info>     <strong>$result</strong>  指定された場合、この配列にスキャン時の応答から得られた追加情報が 代入されます。
                     <return>number</return> - 返されたエントリの数。 <return>stepsize</return> - ステップサイズ。 <return>position</return> - 項目の位
                     置。 <return>status</return> - スキャンステータス。
                     
                     <return>number</return> - 返されたエントリの数。
                     
                     <return>stepsize</return> - ステップサイズ。
                     
                     <return>position</return> - 項目の位置。
                     
                     <return>status</return> - スキャンステータス。

<comment>Return:</comment>
  <info>array</info>  配列 (0..n-1) を返します。n は返された項目の数です。個々の値は ペアになっており、最初の値が
         項目名、2 つめの値が結果の数となります。


id: yaz_schema
type: function
doc:
<comment>Description:</comment>
  取得するスキーマを指定する
    
  
  <strong>yaz_schema()</strong> は取得するスキーマを指定します。
  
  この関数は、 <strong>yaz_search()</strong> あるいは <strong>yaz_present()</strong> より前にコールしなければなりません。

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>      <strong>yaz_connect()</strong> が返す接続リソース。
  <info>string</info>    <strong>$schema</strong>  ドット記法の（<return>1.2.840.10003.13.4</return> のような） OID あるいは登録されているスキーマ
                     のひとつ、たとえば <return>GILS-schema</return>、<return>Holdings</return>、 <return>Zthes</return> などのいずれかで指定する必要が
                     あります。

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: yaz_search
type: function
doc:
<comment>Description:</comment>
  検索を準備する
  
  <strong>yaz_search()</strong> は、指定した接続で検索を行う準備をします。
  
  <strong>yaz_connect()</strong> と同様にこの関数は非ブロックモードで 動作し、後で <strong>yaz_wait()</strong> がコールされたときのた
  めに 検索の準備をするだけです。

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>     <strong>yaz_connect()</strong> が返す接続リソース。
  <info>string</info>    <strong>$type</strong>   クエリの型を表します。現在は <return>"rpn"</return> のみがサポート されており、この場合 3 番目の
                    引数には Type-1 クエリを前置表記で 指定します。
  <info>string</info>    <strong>$query</strong>  RPN クエリは、Z39.50 規格により定義された Type-1 クエリのテキスト 表現です。しか
                    し、YAZ により使用されるテキスト表現では、演算子が オペランドの前にある前置表記
                    が使用されます。クエリ文字列はトークンの 並びであり、このトークンでは 2 重引用符
                    で括られない限り空白文字は 無視されます。アットマーク(<return>@</return>)で始まるトークンは 演算
                    子とみなされ、そうでない場合は検索項目として処理されます。
                    
                    属性についての情報は Z39.50 Maintenance Agency サイトにあります。
                    
                    もう少しわかりやすい記法を利用したい場合は、CCL パーサ関数 - <strong>yaz_ccl_conf()</strong> およ
                    び <strong>yaz_ccl_parse()</strong> を使用してください。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。


id: yaz_set_option
type: function
doc:
<comment>Description:</comment>
  接続に関するひとつあるいは複数のオプションを設定する
  
  指定した接続について、ひとつあるいは複数のオプションを設定します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>     <strong>yaz_connect()</strong> が返す接続リソース。
  <info>string</info>    <strong>$name</strong>   文字列あるいは配列です。
                    
                    文字列を指定すると、指定するオプションの名前として扱われます。 その <strong>$value</strong> を指
                    定する必要があります。
                    
                    配列を指定すると、連想配列（オプション名 -&gt; オプションの値）として 扱われま
                    す。
  <info>string</info>    <strong>$value</strong>  オプションの新しい値。変更前の値が文字列である場合にのみ これを使用します。

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: yaz_sort
type: function
doc:
<comment>Description:</comment>
  ソート条件を設定する
  
  この関数は、ソート条件を設定して Z39.50 Sort を有効にします。
  
  この関数は、<strong>yaz_search()</strong> の前に コールします。この関数を単独で使用しても何も意味はありません。
  <strong>yaz_search()</strong> と組み合わせて使用した場合、 検索応答が受信されてから全ての Z39.50 Present で取得され
  る前に Z39.50 Sort が送信されます。

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>        <strong>yaz_connect()</strong> が返す接続リソース。
  <info>string</info>    <strong>$criteria</strong>  field1 flags1 field2 flags2 のような 形式の文字列。field1 は最初にソートする
                       属性を、そして field2 は 2 番目の属性を… のように指定します。
                       
                       フィールドは、カンマで区切られた 型 = 値 の組からなる数値属性の 組み合わせ
                       （例 <return>1=4,2=1</return>）、または 文字列の方法を指定することも可能です（例 <return>title</return>）。 フ
                       ラグは次の文字の並びからなり、空白により区切ることはありません。
                       
                       ソートフラグ<return>a</return> 昇順ソート <return>d</return> 降順ソート <return>i</return> 大文字小文字を区別しないソート <return>s</return> 大文
                       字小文字を区別するソート
                       
                       昇順ソート
                       
                       降順ソート
                       
                       大文字小文字を区別しないソート
                       
                       大文字小文字を区別するソート

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: yaz_syntax
type: function
doc:
<comment>Description:</comment>
  取得用に適当なレコード構文を指定する
    
  
  <strong>yaz_syntax()</strong> は、取得するレコードの構文を指定します。
  
  この関数は <strong>yaz_search()</strong> あるいは <strong>yaz_present()</strong> より前にコールしなければなりません。

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>      <strong>yaz_connect()</strong> が返す接続リソース。
  <info>string</info>    <strong>$syntax</strong>  ドット記法の（<return>1.2.840.10003.5.10</return> のような） OID あるいは登録されている構文のひ
                     とつ（たとえば sutrs、 usmarc、grs1、xml など）のいずれかで指定する必要がありま
                     す。

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: yaz_wait
type: function
doc:
<comment>Description:</comment>
  Z39.50 リクエストが完了するまで待つ
  
  この関数は、関数 <strong>yaz_connect()</strong>、 <strong>yaz_search()</strong>、<strong>yaz_present()</strong>、 <strong>yaz_scan()</strong>、<strong>yaz_itemorder()</strong> により
  準備された発行済のリクエストを、ネットワーク経由で（ブロック モードで）伝送します。
  
  <strong>yaz_wait()</strong>は、全てのターゲットが全てのリクエストを 完了したか、（エラーの場合には）中断された場合
  に処理を戻します。

<comment>Param:</comment>
  <info>array</info>  <strong>$options</strong>  オプションの連想配列。 <return>timeout</return> タイムアウトの秒数を設定します。ターゲットが時間内
                   に応答しなかった 場合は動作していないとみなされ、<strong>yaz_wait()</strong> は終了します。タイム
                   アウトのデフォルト値は 15 秒です。 <return>event</return> 論理型の値。
                   
                   タイムアウトの秒数を設定します。ターゲットが時間内に応答しなかった 場合は動作して
                   いないとみなされ、<strong>yaz_wait()</strong> は終了します。タイムアウトのデフォルト値は 15 秒で
                   す。
                   
                   論理型の値。

<comment>Return:</comment>
  <info>mixed</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。 イベントモードでは、成功した場合
         にリソース、失敗した場合に <info>false</info> を返します。


id: zend_thread_id
type: function
doc:
<comment>Description:</comment>
  現在のスレッドの一意な ID を返す
  
  この関数は、現在のスレッドの一意な ID を返します。

<comment>Return:</comment>
  <info>int</info>  スレッドの ID を表す整数値を返します。


id: zend_version
type: function
doc:
<comment>Description:</comment>
  現在の Zend Engine のバージョンを取得する
  
  現在実行中の Zend Engine のバージョンを含む文字列を返します。

<comment>Return:</comment>
  <info>string</info>  Zend Engine のバージョン番号を文字列で返します。

<comment>See Also:</comment>
   * <strong>phpinfo()</strong>
   * <strong>phpcredits()</strong>
   * <strong>phpversion()</strong>


id: zip_close
type: function
doc:
<comment>Description:</comment>
  ZIP ファイルアーカイブを閉じる
  
  ZIP ファイルアーカイブを閉じます。

<comment>Param:</comment>
  <info>resource</info>  <strong>$zip</strong>  事前に <strong>zip_open()</strong> でオープンされた ZIP ファイル。

<comment>Return:</comment>
  <info>void</info>  値を返しません。

<comment>See Also:</comment>
   * <strong>zip_open()</strong>
   * <strong>zip_read()</strong>


id: zip_entry_close
type: function
doc:
<comment>Description:</comment>
  ディレクトリエントリを閉じる
  
  指定されたディレクトリエントリを閉じます。

<comment>Param:</comment>
  <info>resource</info>  <strong>$zip_entry</strong>  <strong>zip_entry_open()</strong>によりオープンされたディレクトリの エントリ

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>zip_entry_open()</strong>
   * <strong>zip_entry_read()</strong>


id: zip_entry_compressedsize
type: function
doc:
<comment>Description:</comment>
  ディレクトリエントリの圧縮時のサイズを取得する
  
  ディレクトリエントリの圧縮時のサイズを取得します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$zip_entry</strong>  <strong>zip_read()</strong>により返されたディレクトリのエントリ

<comment>Return:</comment>
  <info>int|false</info>  圧縮後のサイズを返します。 失敗した場合に <info>false</info> を返します

<comment>See Also:</comment>
   * <strong>zip_open()</strong>
   * <strong>zip_read()</strong>


id: zip_entry_compressionmethod
type: function
doc:
<comment>Description:</comment>
  ディレクトリエントリの圧縮方法を取得する
  
  <strong>$zip_entry</strong>により指定されたディレクトリエントリの 圧縮方法を返します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$zip_entry</strong>  <strong>zip_read()</strong>により返されたディレクトリのエントリ

<comment>Return:</comment>
  <info>string|false</info>  圧縮方法を返します。 失敗した場合に <info>false</info> を返します

<comment>See Also:</comment>
   * <strong>zip_open()</strong>
   * <strong>zip_read()</strong>


id: zip_entry_filesize
type: function
doc:
<comment>Description:</comment>
  ディレクトリエントリの実際のファイルサイズを取得する
  
  ディレクトリエントリの実際のファイルサイズを返します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$zip_entry</strong>  <strong>zip_read()</strong>により返されたディレクトリのエントリ

<comment>Return:</comment>
  <info>int|false</info>  ディレクトリエントリのサイズを返します。 失敗した場合に <info>false</info> を返します

<comment>See Also:</comment>
   * <strong>zip_open()</strong>
   * <strong>zip_read()</strong>


id: zip_entry_name
type: function
doc:
<comment>Description:</comment>
  ディレクトリエントリの名前を取得する
  
  指定したディレクトリエントリの名前を返します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$zip_entry</strong>  <strong>zip_read()</strong>により返されたディレクトリエントリ

<comment>Return:</comment>
  <info>string|false</info>  ディレクトリエントリの名前を返します。 失敗した場合に <info>false</info> を返します

<comment>See Also:</comment>
   * <strong>zip_open()</strong>
   * <strong>zip_read()</strong>


id: zip_entry_open
type: function
doc:
<comment>Description:</comment>
  読込み用にディレクトリエントリをオープンする
  
  読込み用にzipファイルの中にディレクトリエントリをオープンします。

<comment>Param:</comment>
  <info>resource</info>  <strong>$zip_dp</strong>     <strong>zip_open()</strong>により返された有効なリソースハンドル
  <info>resource</info>  <strong>$zip_entry</strong>  <strong>zip_read()</strong>により返されたディレクトリエントリ
  <info>string</info>    <strong>$mode</strong>       <strong>fopen()</strong>のマニュアルで指定されたモードのどれか
                        
                        現在、<strong>$mode</strong>は無視され、 常に<return>"rb"</return>となります。 これは、PHPのzipサポートが読み
                        込みのみのアクセスであるためです。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。
        
        <strong>fopen()</strong>や他の同種の関数と異なり、 <strong>zip_entry_open()</strong>の戻り値は、 処理の結果のみを示し、ディレ
        クトリエントリの読み込みやクローズの際には 必要とされません。

<comment>See Also:</comment>
   * <strong>zip_entry_close()</strong>
   * <strong>zip_entry_read()</strong>


id: zip_entry_read
type: function
doc:
<comment>Description:</comment>
  オープンされたディレクトリエントリから読み込む
  
  オープンされたディレクトリエントリから読み込みます。

<comment>Param:</comment>
  <info>resource</info>  <strong>$zip_entry</strong>  <strong>zip_read()</strong>により返されたディレクトリエントリ
  <info>int</info>       <strong>$len</strong>        返すバイト数。
                        
                        これは、読み込むデータの非圧縮時の長さとなります。

<comment>Return:</comment>
  <info>string|false</info>  読み込んだデータを返します。ファイルの終端に達した場合は空文字列、エラー時には <info>false</info>
                を返します。

<comment>See Also:</comment>
   * <strong>zip_entry_open()</strong>
   * <strong>zip_entry_close()</strong>
   * <strong>zip_entry_filesize()</strong>


id: zip_open
type: function
doc:
<comment>Description:</comment>
  Zip ファイルアーカイブをオープンする
  
  読み込み用に新規に Zip アーカイブをオープンします。

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  オープンする ZIP アーカイブのファイル名。

<comment>Return:</comment>
  <info>resource|int|false</info>  後で <strong>zip_read()</strong> および <strong>zip_close()</strong> で使用されるリソースハンドル、または、
                      <strong>$filename</strong> が存在しない場合やその他のエラーが発生した場合は <info>false</info> か エラーの番
                      号を返します。

<comment>See Also:</comment>
   * <strong>zip_read()</strong>
   * <strong>zip_close()</strong>


id: zip_read
type: function
doc:
<comment>Description:</comment>
  Zip ファイルアーカイブの中の次のエントリを読み込む
  
  Zip ファイルアーカイブの中の次のエントリを読み込みます。

<comment>Param:</comment>
  <info>resource</info>  <strong>$zip</strong>  <strong>zip_open()</strong> でオープン済みの ZIP ファイル。

<comment>Return:</comment>
  <info>resource|false</info>  後で <return>zip_entry_...</return> 関数で使用されるディレクトリエントリリソース、または、 読み込む
                  エントリがもうない場合に <info>false</info>、 その他のエラーが発生した場合はエラー番号を返しま
                  す。

<comment>See Also:</comment>
   * <strong>zip_open()</strong>
   * <strong>zip_close()</strong>
   * <strong>zip_entry_open()</strong>
   * <strong>zip_entry_read()</strong>


id: zlib_decode
type: function
doc:
<comment>Description:</comment>
  raw/gzip/zlib で符号化されたデータを復元する
  
  raw/gzip/zlib で符号化されたデータを復元します。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>        
  <info>int</info>     <strong>$max_length</strong>  

<comment>Return:</comment>
  <info>string|false</info>  圧縮されていないデータを返します。失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>zlib_encode()</strong>


id: zlib_encode
type: function
doc:
<comment>Description:</comment>
  指定した符号化方式でデータを圧縮する
  
  指定した符号化方式でデータを圧縮します。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>      圧縮するデータ。
  <info>int</info>     <strong>$encoding</strong>  圧縮アルゴリズム。 <info>ZLIB_ENCODING_RAW</info>、 <info>ZLIB_ENCODING_DEFLATE</info> または
                     <info>ZLIB_ENCODING_GZIP</info> 。
  <info>int</info>     <strong>$level</strong>     

<comment>Return:</comment>
  <info>string|false</info>  

<comment>See Also:</comment>
   * <strong>zlib_decode()</strong>


id: zlib_get_coding_type
type: function
doc:
<comment>Description:</comment>
  出力圧縮に使用されたコーディングの種類を返す
  
  出力圧縮に使用されたコーディングの種類を返します。

<comment>Return:</comment>
  <info>string|false</info>  返される値は <return>gzip</return>, <return>deflate</return>, もしくは <info>false</info> です。

<comment>See Also:</comment>
   * zlib.output_compression
     ディレクティブ
    


id: zookeeper_dispatch
type: function
doc:
<comment>Description:</comment>
  Calls callbacks for pending operations
  
  The <strong>zookeeper_dispatch()</strong> function calls the callbacks passed by operations like Zookeeper::get or
  Zookeeper::exists.
  
  Since version 0.4.0, this function must be called manually to achieve asynchronous operations. If
  you want that to be done automatically, you also can declare ticks at the beginning of your
  program.
  
  After PHP 7.1, you can ignore this function. This extension uses EG(vm_interrupt) to implement
  async dispatch.

<comment>Return:</comment>
  <info>void</info>  値を返しません。

<comment>See Also:</comment>
   * Zookeeper::addAuth
   * Zookeeper::connect
   * Zookeeper::__construct
   * Zookeeper::exists
   * Zookeeper::get
   * Zookeeper::getChildren
   * Zookeeper::setWatcher


