# php_manual

id: Random\Randomizer::getInt
type: function
doc:
<comment>Description:</comment>
  等確率に選ばれる整数を取得する
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>int</info>  <strong>$min</strong>  返される最小値。
  <info>int</info>  <strong>$max</strong>  返される最大値。

<comment>Return:</comment>
  <info>int</info>  閉区間 [<strong>$min</strong>, <strong>$max</strong>] の中から、 等確率に出るよう選ばれた整数値を返します。 <strong>$min</strong> と <strong>$max</strong> も返さ
       れる値に含みます。

<comment>See Also:</comment>
   * <strong>random_int()</strong>
   * Random\Randomizer::getFloat


id: Random\Randomizer::nextFloat
type: function
doc:
<comment>Description:</comment>
  半開区間 [0.0, 1.0) から、float の値を取得する
  
  半開区間(左閉右開) に一様に分散した float を等確率に返します。 区間には <return>0.0</return> を含み、<return>1.0</return> までです
  が、 <return>1.0</return> そのものは含みません。
  
  返される float の値が、指定された右開の部分区間にある確率は、 部分区間の大きさに比例します。
   つまり、返される float が <return>0.5</return> より小さい 確率は50%ということです。これは float が 少なくとも <return>0.5</return>
  以上である確率と等しくなります。
   同様に、返される float が、区間 <return>0.2</return> から <return>0.25</return> 未満までに収まる確率は、ちょうど 5% になります。
  
  この性質を使うと、Random\Randomizer::nextFloat を活用して返される float が指定された確率 より小さ
  い ことをチェックすることで、 指定された確率でランダムな boolean 値を生成することが可能になりま
  す。
  
  Random\Randomizer::nextFloat が返す可能性がある float の値の範囲は、 Randomizer::getFloat(0.0,
  1.0, IntervalBoundary::ClosedOpen) と同じです。
  
  ですが、内部的な Random\Randomizer::nextFloat の実装はより効率的です。
  
  乗算や加算(いわゆるアフィン変換)を使って、 この関数の戻り値を異なる区間に拡大/縮小すると、 結果の
  値に偏りが出るかもしれません。 なぜなら、浮動小数点数は数直線上で均一に分布するわけではないからで
  す。 全ての値が浮動小数点数によって正確に表現できるとは限らないので、 アフィン変換の結果が暗黙の丸
  め処理によって求める区間から外れた値になってしまう可能性もあります。
   アフィン変換の結果生じる問題の 詳細な説明 は、Random\Randomizer::getFloat のドキュメントに説明が
  あります。
  
  任意の区間内でランダムな float の値を生成するには、 Random\Randomizer::getFloat を使います。任意の
  区間内でランダムな整数を生成するには、 Random\Randomizer::getInt を使います。

<comment>Return:</comment>
  <info>float</info>  半開区間 [0.0, 1.0) (<return>IntervalBoundary::ClosedOpen</return>) に一様に分散した float を等確率に返しま
         す。 返される値には <return>0.0</return> を含みますが、 <return>1.0</return> は含みません。

<comment>See Also:</comment>
   * Random\Randomizer::getFloat


id: Random\Randomizer::nextInt
type: function
doc:
<comment>Description:</comment>
  正の整数を取得する
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>int</info>  Random\Engine::generate が返したバイト数に応じて、 0 から最大値までの正の整数を返します。 正
       確な最大値は、2$engine_bytes * 8 - 1 - 1 で計算できます。


id: Random\Randomizer::pickArrayKeys
type: function
doc:
<comment>Description:</comment>
  ランダムに配列のキーを選択する
  
  指定された <strong>$array</strong> に存在する、 <strong>$num</strong> 個の異なる配列のキーを等確率に選びます。
  
  指定された <strong>$array</strong> の、 個々のキーが返される確率は等しくなります。
  
  配列のキーの選ばれ方は、 指定された <strong>$array</strong> の内部構造に依存します。 ふたつの配列が等しく、かつ
  <class>Random\Engine</class> の内部的なステートが等しくても、 指定された配列の作られ方によっては返されるキーが異
  なる可能性があります。

<comment>Param:</comment>
  <info>array</info>  <strong>$array</strong>  キーを選ぶ配列
  <info>int</info>    <strong>$num</strong>    返すべき配列のキーの数。 <return>1</return> 以上かつ、 <strong>$array</strong> の要素数以下である必要があります。

<comment>Return:</comment>
  <info>array</info>  <strong>$array</strong> の 異なる <strong>$num</strong> 個のキーを含んだ配列を返します。
         
         返される配列はリスト (<strong>array_is_list()</strong>) になります。 これは <strong>array_keys()</strong> が返す配列のサブ
         セットです。

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


id: Random\Randomizer::shuffleArray
type: function
doc:
<comment>Description:</comment>
  配列の順列を取得する
  
  指定された <strong>$array</strong> のあり得る順列から、 等確率に選ばれた順列を返します。
  
  指定された <strong>$array</strong> のあり得る順列それぞれが、返される確率は等しくなります。

<comment>Param:</comment>
  <info>array</info>  <strong>$array</strong>  値をシャッフルする配列
                 
                 指定された配列は変更されません。

<comment>Return:</comment>
  <info>array</info>  <strong>$array</strong> の値の順列を返します。
         
         指定された <strong>$array</strong> のキーは保存されません。 つまり、返される配列はリスト (<strong>array_is_list()</strong>)
         になります。


id: Random\Randomizer::shuffleBytes
type: function
doc:
<comment>Description:</comment>
  指定された文字列の、バイト単位の順列を取得する
  
  指定された <strong>$bytes</strong> のあり得る順列から、 等確率に選ばれた順列を返します。
  
  指定された <strong>$bytes</strong> のあり得る順列それぞれが、返される確率は等しくなります。

<comment>Param:</comment>
  <info>string</info>  <strong>$bytes</strong>  バイト単位でシャッフルする文字列
                  
                  指定された文字列は変更されません。

<comment>Return:</comment>
  <info>string</info>  <strong>$bytes</strong> の、 バイト単位の順列を返します。


id: RarArchive
type: class
doc:
<comment>Description:</comment>
  このクラスは RAR アーカイブをあらわします。これは複数のパーツで構成されることもあり、 中に RAR エ
  ントリ (ファイルやディレクトリ、そしてシンボリックリンクなどの特殊なオブジェクト) を含みます。
  
  このクラスのオブジェクトの中身を走査したり、RAR アーカイブに格納されているエントリを取り出したりす
  ることができます。 このエントリは、RarArchive::getEntry や RarArchive::getEntries を使って取得する
  こともできます。


id: RarArchive::__toString
type: function
doc:
<comment>Description:</comment>
  テキスト形式で取得する
  
  この <info>RarArchive</info> オブジェクトの文字列表現を取得します。 現在表示されるのは、オープンしているアーカ
  イブボリュームのフルパスと、 そのリソースが有効なのか RarArchive::close で閉じられた後なのかという
  ことです。
  
  このメソッドはデバッグ用にだけ使うものです。 結果にどのような情報が含まれるか、そしてどういった書
  式になるかなどは保証されていません。

<comment>Return:</comment>
  <info>string</info>  この <info>RarArchive</info> オブジェクトのテキスト表現を返します。 テキストの中身については未定義で
          す。


id: RarArchive::close
type: function
doc:
<comment>Description:</comment>
  Rar アーカイブをクローズし、全リソースを開放する
  
  オブジェクト指向型 (メソッド)
  
  手続き型:
  
  Rar アーカイブをクローズし、割り当てられた全リソースを開放します。

<comment>Param:</comment>
  <info>RarArchive</info>  <strong>$rarfile</strong>  <strong>rar_open()</strong> でオープンした <info>RarArchive</info> オブジェクト。

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


id: RarArchive::getComment
type: function
doc:
<comment>Description:</comment>
  RAR アーカイブのコメントテキストを取得する
  
  オブジェクト指向型 (メソッド)
  
  手続き型:
  
  RAR アーカイブに格納された (グローバル) コメントを取得します。長さは最大 64 KiB までです。
  
  この拡張モジュールは、エントリごとのコメントをサポートしていません。

<comment>Param:</comment>
  <info>RarArchive</info>  <strong>$rarfile</strong>  <strong>rar_open()</strong> でオープンした <info>RarArchive</info> オブジェクト。

<comment>Return:</comment>
  <info>string</info>  コメントを返します。コメントがない場合は <info>null</info> を返します。
          
          RAR は現在 unicode のコメントに対応していません。この関数の結果のエンコーディングは指定さ
          れていませんが、 おそらく Windows-1252 となるでしょう。


id: RarArchive::getEntries
type: function
doc:
<comment>Description:</comment>
  RAR アーカイブからエントリの全一覧を取得する
  
  オブジェクト指向型 (メソッド)
  
  手続き型:
  
  エントリ (ファイルおよびディレクトリ) の一覧を RAR アーカイブから取得します。
  
  アーカイブの中に同じ名前のエントリが存在する場合は、このメソッドを <info>RarArchive</info> の <return>foreach</return> と組み合
  わせて 数値添字の配列形式で処理するのが唯一のアクセス方法となります (つまり、 RarArchive::getEntry
  と <return>rar://</return> ラッパー は使えないということです)。

<comment>Param:</comment>
  <info>RarArchive</info>  <strong>$rarfile</strong>  <strong>rar_open()</strong> でオープンした <info>RarArchive</info> オブジェクト。

<comment>Return:</comment>
  <info>array|false</info>  <strong>rar_list()</strong> は <info>RarEntry</info> オブジェクトの配列を返します。 失敗した場合に <info>false</info> を返しま
               す。

<comment>See Also:</comment>
   * RarArchive::getEntry
   * <return>rar://</return> ラッパー


id: RarArchive::getEntry
type: function
doc:
<comment>Description:</comment>
  Rar アーカイブからエントリオブジェクトを取得する
  
  オブジェクト指向型 (メソッド)
  
  手続き型:
  
  Rar アーカイブから、エントリオブジェクト (ファイルあるいはディレクトリ) を取得します。
  
  RarArchive::getEntries を使ってエントリオブジェクトを取得することもできます。
  
  RAR アーカイブには、同じ名前のエントリを複数格納することができます。 このメソッドでは、その中の最
  初のものしか取得できません。

<comment>Param:</comment>
  <info>RarArchive</info>  <strong>$rarfile</strong>    <strong>rar_open()</strong> でオープンした <info>RarArchive</info> オブジェクト。
  <info>string</info>      <strong>$entryname</strong>  Rar アーカイブ内のエントリへのパス。
                          
                          このパスは、 RarEntry::getName が返すものと同じでなければなりません。

<comment>Return:</comment>
  <info>RarEntry|false</info>  マッチした <info>RarEntry</info> オブジェクトを返します。失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * RarArchive::getEntries
   * <return>rar://</return> ラッパー


id: RarArchive::isBroken
type: function
doc:
<comment>Description:</comment>
  アーカイブが壊れている (未完成である) かどうかを調べる
  
  オブジェクト指向型 (メソッド)
  
  手続き型:
  
  この関数は、アーカイブが不完全である (ボリュームがなかったり、ボリュームが途中で終わっていたりす
  る) かどうかを調べます。

<comment>Param:</comment>
  <info>RarArchive</info>  <strong>$rarfile</strong>  <strong>rar_open()</strong> でオープンした <info>RarArchive</info> オブジェクト。

<comment>Return:</comment>
  <info>bool</info>  アーカイブが壊れている場合に <info>true</info>、壊れていない場合に <info>false</info> を返します。 この関数は、渡され
        たファイルがすでに閉じている場合にも <info>false</info> を返します。どちらの原因かを特定するには
        exceptions with RarException::setUsingExceptions で例外を有効にするしかありませんが、普通は
        閉じたファイルを操作することはないので これは不要なはずです。

<comment>See Also:</comment>
   * RarArchive::setAllowBroken


id: RarArchive::isSolid
type: function
doc:
<comment>Description:</comment>
  RAR アーカイブがソリッドであるかどうかを調べる
  
  オブジェクト指向型 (メソッド)
  
  手続き型:
  
  RAR アーカイブがソリッドであるかどうかを調べます。ソリッドなアーカイブでは、 個々のファイルの抽出
  速度が遅くなります。

<comment>Param:</comment>
  <info>RarArchive</info>  <strong>$rarfile</strong>  <strong>rar_open()</strong> でオープンした <info>RarArchive</info> オブジェクト。

<comment>Return:</comment>
  <info>bool</info>  アーカイブがソリッドである場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。


id: RarArchive::open
type: function
doc:
<comment>Description:</comment>
  Rar アーカイブをオープンする
  
  オブジェクト指向型 (メソッド)
  
  手続き型:
  
  指定した RAR アーカイブをオープンし、<info>RarArchive</info> インスタンスを返します。
  
  マルチボリュームのアーカイブをオープンするときには、 最初のボリュームのパスをパラメータに指定しま
  す。 そうしないとすべてのファイルを表示することはできません。これは仕様です。

<comment>Param:</comment>
  <info>string</info>    <strong>$filename</strong>         Rar アーカイブへのパス。
  <info>string</info>    <strong>$password</strong>         ヘッダの復号に必要な場合、プレーンテキストのパスワード。 暗号化された
                              ファイルが見つかったときにも、これがデフォルトのパスワードとして使われ
                              ます。 ヘッダのパスワードとファイルのパスワードは異なる場合があること
                              に注意しましょう。
  <info>callable</info>  <strong>$volume_callback</strong>  ひとつのパラメータ (見つからなかったボリュームのパス) を受け取ってその
                              ボリュームの正しいパスを返す関数。 この関数は、ボリュームが存在しな
                              かったり未知であったりする場合は <info>null</info> を返さなければなりません。 この
                              関数はループを引き起こさないようにしなければなりません。 前のコールで
                              返されたパスがそのボリュームに対応しない場合に 関数が繰り返しコールさ
                              れることがあるからです。 このパラメータを指定すると、ボリュームが見つ
                              からなかったときの notice は一切無視するようになります。したがって、
                              単に <info>null</info> を返すだけの実装を渡しておけば、 notice を無視させるためだけ
                              に使うこともできます。

<comment>Return:</comment>
  <info>RarArchive|false</info>  <info>RarArchive</info> インスタンスを返します。失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <return>rar://</return> wrapper


id: RarArchive::setAllowBroken
type: function
doc:
<comment>Description:</comment>
  壊れたアーカイブのオープンを許可するかどうかを設定する
  
  オブジェクト指向型 (メソッド)
  
  手続き型:
  
  このメソッドは、壊れたアーカイブの読み込みを許可するか、 あるいはアーカイブからエントリを抽出する
  操作をすべて失敗させるかを設定します。 壊れたアーカイブとは、ファイルのオープン時には何もエラーが
  検出されないのに エントリを読み込むときにエラーが発生するようなアーカイブのことです。

<comment>Param:</comment>
  <info>RarArchive</info>  <strong>$rarfile</strong>       <strong>rar_open()</strong> でオープンした <info>RarArchive</info> オブジェクト。
  <info>bool</info>        <strong>$allow_broken</strong>  壊れたファイルの読み込みを許可する (<info>true</info>) か許可しない (<info>false</info>) か。

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> を返します。失敗した場合に <info>false</info> を返します。 失敗するのは、既にファイルが閉じられてい
        るときだけです。

<comment>See Also:</comment>
   * RarArchive::isBroken


id: RarEntry
type: class
doc:
<comment>Description:</comment>
  A RAR entry, representing a directory or a compressed file inside a RAR archive.


id: RarEntry::ATTRIBUTE_UNIX_BLOCK_DEV
type: constant
doc:
<comment>Description:</comment>
  Unix block devices will have attributes whose last four bits have this value. To be used with
  RarEntry::getAttr on entries whose host OS is UNIX and with the constant
  <info>RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET</info>.


id: RarEntry::ATTRIBUTE_UNIX_CHAR_DEV
type: constant
doc:
<comment>Description:</comment>
  Unix character devices will have attributes whose last four bits have this value. To be used with
  RarEntry::getAttr on entries whose host OS is UNIX and with the constant
  <info>RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET</info>.


id: RarEntry::ATTRIBUTE_UNIX_DIRECTORY
type: constant
doc:
<comment>Description:</comment>
  Unix directories will have attributes whose last four bits have this value. To be used with
  RarEntry::getAttr on entries whose host OS is UNIX and with the constant
  <info>RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET</info>. See also RarEntry::isDirectory, which also works with
  entries that were added in other operating systems.


id: RarEntry::ATTRIBUTE_UNIX_FIFO
type: constant
doc:
<comment>Description:</comment>
  Unix FIFOs will have attributes whose last four bits have this value. To be used with
  RarEntry::getAttr on entries whose host OS is UNIX and with the constant
  <info>RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET</info>.


id: RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET
type: constant
doc:
<comment>Description:</comment>
  Mask to isolate the last four bits (nibble) of UNIX attributes (_S_IFMT, the type of file mask).
  To be used with RarEntry::getAttr on entries whose host OS is UNIX and with the constants
  <info>RarEntry::ATTRIBUTE_UNIX_FIFO</info>, <info>RarEntry::ATTRIBUTE_UNIX_CHAR_DEV</info>,
  <info>RarEntry::ATTRIBUTE_UNIX_DIRECTORY</info>, <info>RarEntry::ATTRIBUTE_UNIX_BLOCK_DEV</info>,
  <info>RarEntry::ATTRIBUTE_UNIX_REGULAR_FILE</info>, <info>RarEntry::ATTRIBUTE_UNIX_SYM_LINK</info> and
  <info>RarEntry::ATTRIBUTE_UNIX_SOCKET</info>.


id: RarEntry::ATTRIBUTE_UNIX_GROUP_EXECUTE
type: constant
doc:
<comment>Description:</comment>
  Bit that represents a UNIX entry that is group executable. To be used with RarEntry::getAttr on
  entries whose host OS is UNIX.


id: RarEntry::ATTRIBUTE_UNIX_GROUP_READ
type: constant
doc:
<comment>Description:</comment>
  Bit that represents a UNIX entry that is group readable. To be used with RarEntry::getAttr on
  entries whose host OS is UNIX.


id: RarEntry::ATTRIBUTE_UNIX_GROUP_WRITE
type: constant
doc:
<comment>Description:</comment>
  Bit that represents a UNIX entry that is group writable. To be used with RarEntry::getAttr on
  entries whose host OS is UNIX.


id: RarEntry::ATTRIBUTE_UNIX_OWNER_EXECUTE
type: constant
doc:
<comment>Description:</comment>
  Bit that represents a UNIX entry that is owner executable. To be used with RarEntry::getAttr on
  entries whose host OS is UNIX.


id: RarEntry::ATTRIBUTE_UNIX_OWNER_READ
type: constant
doc:
<comment>Description:</comment>
  Bit that represents a UNIX entry that is owner readable. To be used with RarEntry::getAttr on
  entries whose host OS is UNIX.


id: RarEntry::ATTRIBUTE_UNIX_OWNER_WRITE
type: constant
doc:
<comment>Description:</comment>
  Bit that represents a UNIX entry that is owner writable. To be used with RarEntry::getAttr on
  entries whose host OS is UNIX.


id: RarEntry::ATTRIBUTE_UNIX_REGULAR_FILE
type: constant
doc:
<comment>Description:</comment>
  Unix regular files (not directories) will have attributes whose last four bits have this value. To
  be used with RarEntry::getAttr on entries whose host OS is UNIX and with the constant
  <info>RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET</info>. See also RarEntry::isDirectory, which also works with
  entries that were added in other operating systems.


id: RarEntry::ATTRIBUTE_UNIX_SETGID
type: constant
doc:
<comment>Description:</comment>
  Bit that represents the UNIX setgid attribute. To be used with RarEntry::getAttr on entries whose
  host OS is UNIX.


id: RarEntry::ATTRIBUTE_UNIX_SETUID
type: constant
doc:
<comment>Description:</comment>
  Bit that represents the UNIX setuid attribute. To be used with RarEntry::getAttr on entries whose
  host OS is UNIX.


id: RarEntry::ATTRIBUTE_UNIX_SOCKET
type: constant
doc:
<comment>Description:</comment>
  Unix sockets will have attributes whose last four bits have this value. To be used with
  RarEntry::getAttr on entries whose host OS is UNIX and with the constant
  <info>RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET</info>.


id: RarEntry::ATTRIBUTE_UNIX_STICKY
type: constant
doc:
<comment>Description:</comment>
  Bit that represents the UNIX sticky bit. To be used with RarEntry::getAttr on entries whose host
  OS is UNIX.


id: RarEntry::ATTRIBUTE_UNIX_SYM_LINK
type: constant
doc:
<comment>Description:</comment>
  Unix symbolic links will have attributes whose last four bits have this value. To be used with
  RarEntry::getAttr on entries whose host OS is UNIX and with the constant
  <info>RarEntry::ATTRIBUTE_UNIX_FINAL_QUARTET</info>.


id: RarEntry::ATTRIBUTE_UNIX_WORLD_EXECUTE
type: constant
doc:
<comment>Description:</comment>
  Bit that represents a UNIX entry that is world executable. To be used with RarEntry::getAttr on
  entries whose host OS is UNIX.


id: RarEntry::ATTRIBUTE_UNIX_WORLD_READ
type: constant
doc:
<comment>Description:</comment>
  Bit that represents a UNIX entry that is world readable. To be used with RarEntry::getAttr on
  entries whose host OS is UNIX.


id: RarEntry::ATTRIBUTE_UNIX_WORLD_WRITE
type: constant
doc:
<comment>Description:</comment>
  Bit that represents a UNIX entry that is world writable. To be used with RarEntry::getAttr on
  entries whose host OS is UNIX.


id: RarEntry::ATTRIBUTE_WIN_ARCHIVE
type: constant
doc:
<comment>Description:</comment>
  Bit that represents a Windows entry with an archive attribute. To be used with RarEntry::getAttr
  on entries whose host OS is Microsoft Windows.


id: RarEntry::ATTRIBUTE_WIN_COMPRESSED
type: constant
doc:
<comment>Description:</comment>
  Bit that represents a Windows entry with a compressed attribute (NTFS only). To be used with
  RarEntry::getAttr on entries whose host OS is Microsoft Windows.


id: RarEntry::ATTRIBUTE_WIN_DEVICE
type: constant
doc:
<comment>Description:</comment>
  Bit that represents a Windows entry with a device attribute. To be used with RarEntry::getAttr on
  entries whose host OS is Microsoft Windows.


id: RarEntry::ATTRIBUTE_WIN_DIRECTORY
type: constant
doc:
<comment>Description:</comment>
  Bit that represents a Windows entry with a directory attribute (entry is a directory). To be used
  with RarEntry::getAttr on entries whose host OS is Microsoft Windows. See also
  RarEntry::isDirectory, which also works with entries that were not added in WinRAR.


id: RarEntry::ATTRIBUTE_WIN_ENCRYPTED
type: constant
doc:
<comment>Description:</comment>
  Bit that represents a Windows entry with an encrypted attribute (NTFS only). To be used with
  RarEntry::getAttr on entries whose host OS is Microsoft Windows.


id: RarEntry::ATTRIBUTE_WIN_HIDDEN
type: constant
doc:
<comment>Description:</comment>
  Bit that represents a Windows entry with a hidden attribute. To be used with RarEntry::getAttr on
  entries whose host OS is Microsoft Windows.


id: RarEntry::ATTRIBUTE_WIN_NORMAL
type: constant
doc:
<comment>Description:</comment>
  Bit that represents a Windows entry with a normal file attribute (entry is NOT a directory). To be
  used with RarEntry::getAttr on entries whose host OS is Microsoft Windows. See also
  RarEntry::isDirectory, which also works with entries that were not added in WinRAR.


id: RarEntry::ATTRIBUTE_WIN_NOT_CONTENT_INDEXED
type: constant
doc:
<comment>Description:</comment>
  Bit that represents a Windows entry with a not content indexed attribute (entry is to be indexed).
  To be used with RarEntry::getAttr on entries whose host OS is Microsoft Windows.


id: RarEntry::ATTRIBUTE_WIN_OFFLINE
type: constant
doc:
<comment>Description:</comment>
  Bit that represents a Windows entry with an offline attribute (entry is offline and not
  accessible). To be used with RarEntry::getAttr on entries whose host OS is Microsoft Windows.


id: RarEntry::ATTRIBUTE_WIN_READONLY
type: constant
doc:
<comment>Description:</comment>
  Bit that represents a Windows entry with a read-only attribute. To be used with RarEntry::getAttr
  on entries whose host OS is Microsoft Windows.


id: RarEntry::ATTRIBUTE_WIN_REPARSE_POINT
type: constant
doc:
<comment>Description:</comment>
  Bit that represents a Windows entry with a reparse point attribute (entry is an NTFS reparse
  point, e.g. a directory junction or a mount file system). To be used with RarEntry::getAttr on
  entries whose host OS is Microsoft Windows.


id: RarEntry::ATTRIBUTE_WIN_SPARSE_FILE
type: constant
doc:
<comment>Description:</comment>
  Bit that represents a Windows entry with a sparse file attribute (file is an NTFS sparse file). To
  be used with RarEntry::getAttr on entries whose host OS is Microsoft Windows.


id: RarEntry::ATTRIBUTE_WIN_SYSTEM
type: constant
doc:
<comment>Description:</comment>
  Bit that represents a Windows entry with a system attribute. To be used with RarEntry::getAttr on
  entries whose host OS is Microsoft Windows.


id: RarEntry::ATTRIBUTE_WIN_TEMPORARY
type: constant
doc:
<comment>Description:</comment>
  Bit that represents a Windows entry with a temporary attribute. To be used with RarEntry::getAttr
  on entries whose host OS is Microsoft Windows.


id: RarEntry::ATTRIBUTE_WIN_VIRTUAL
type: constant
doc:
<comment>Description:</comment>
  Bit that represents a Windows entry with a virtual attribute. To be used with RarEntry::getAttr on
  entries whose host OS is Microsoft Windows.


id: RarEntry::HOST_BEOS
type: constant
doc:
<comment>Description:</comment>
  If the return value of RarEntry::getHostOs equals this constant, BeOS was used to add this entry.
  Intended to replace <info>RAR_HOST_BEOS</info>.


id: RarEntry::HOST_MACOS
type: constant
doc:
<comment>Description:</comment>
  If the return value of RarEntry::getHostOs equals this constant, Mac OS was used to add this
  entry.


id: RarEntry::HOST_MSDOS
type: constant
doc:
<comment>Description:</comment>
  If the return value of RarEntry::getHostOs equals this constant, MS-DOS was used to add this
  entry. Use instead of <info>RAR_HOST_MSDOS</info>.


id: RarEntry::HOST_OS2
type: constant
doc:
<comment>Description:</comment>
  If the return value of RarEntry::getHostOs equals this constant, OS/2 was used to add this entry.
  Intended to replace <info>RAR_HOST_OS2</info>.


id: RarEntry::HOST_UNIX
type: constant
doc:
<comment>Description:</comment>
  If the return value of RarEntry::getHostOs equals this constant, an unspecified UNIX OS was used
  to add this entry. Intended to replace <info>RAR_HOST_UNIX</info>.


id: RarEntry::HOST_WIN32
type: constant
doc:
<comment>Description:</comment>
  If the return value of RarEntry::getHostOs equals this constant, Microsoft Windows was used to add
  this entry. Intended to replace <info>RAR_HOST_WIN32</info>.


id: RarEntry::__toString
type: function
doc:
<comment>Description:</comment>
  エントリのテキスト表現を取得する
  
  RarEntry::__toString は、このエントリのテキスト表現を返します。 その内容は、まずエントリがファイル
  であるかディレクトリであるか (シンボリックリンクやその他の特殊オブジェクトはファイルとみなされま
  す)、 そしてエントリ名を UTF-8 であらわしたものと CRC となります。 この形式と内容は将来変更される
  可能性があるので、これに依存してはいけません。

<comment>Return:</comment>
  <info>string</info>  エントリのテキスト表現を返します。


id: RarEntry::extract
type: function
doc:
<comment>Description:</comment>
  アーカイブのエントリを展開する
  
  RarEntry::extract は、エントリのデータを展開します。 二番目の引数が指定されていなければ、 指定した
  <strong>$dir</strong> にエントリの名前と同名の新しいファイルを作成します。 詳細は以下を参照ください。

<comment>Param:</comment>
  <info>string</info>  <strong>$dir</strong>            ファイルを展開するディレクトリへのパス。 このパラメータが考慮されるのは
                          <strong>$filepath</strong> が指定されていないときだけです。両方のパラメータが空の場合は、
                          カレントディレクトリへの展開を試みます。
  <info>string</info>  <strong>$filepath</strong>       取り出すファイルのディレクトリとファイル名を含むパス (相対パスあるいは絶対
                          パス)。 このパラメータは、<strong>$dir</strong> の内容と元のファイル名を両方とも上書きしま
                          す。
  <info>string</info>  <strong>$password</strong>       このエントリの暗号化に使うパスワード。 エントリが暗号化されていない場合
                          は、この値は使われずに無視されます。 このパラメータが省略されていてエント
                          リが暗号化されていた場合は、もし <strong>rar_open()</strong> でパスワードを指定していればそ
                          れを使います。 このパラメータや <strong>rar_open()</strong> で指定したパスワードが間違って
                          いたときは、 CRC チェックが失敗してこのメソッドが失敗し、<info>false</info> を返しま
                          す。 パスワードが要求されているときにパスワードを指定していなければ、 この
                          メソッドは失敗して <info>false</info> を返します。 エントリが暗号化されているかどうかを
                          知るには RarEntry::isEncrypted を使います。
  <info>bool</info>    <strong>$extended_data</strong>  <info>true</info> にすると、NTFS の ACL や Unix のオーナー情報といった拡張情報が アーカ
                          イブに設定されていれば、取り出したファイルにもそれを設定します。

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

<comment>See Also:</comment>
   * RarEntry::getStream
   * <return>rar://</return> wrapper


id: RarEntry::getAttr
type: function
doc:
<comment>Description:</comment>
  エントリの属性を取得する
  
  アーカイブエントリの、OS に依存する属性を返します。

<comment>Return:</comment>
  <info>int</info>  属性、あるいはエラー時に <info>false</info> を返します。

<comment>See Also:</comment>
   * RarEntry::getHostOs
   * The constants in <class>RarEntry</class>


id: RarEntry::getCrc
type: function
doc:
<comment>Description:</comment>
  エントリの CRC を取得する
  
  アーカイブエントリの CRC を、十六進文字列表現で返します。

<comment>Return:</comment>
  <info>string</info>  アーカイブエントリの CRC、あるいはエラー時に <info>false</info> を返します。


id: RarEntry::getFileTime
type: function
doc:
<comment>Description:</comment>
  エントリの最終更新時刻を取得する
  
  エントリの最終更新時刻を取得します。

<comment>Return:</comment>
  <info>string</info>  エントリの最終更新時刻を <return>YYYY-MM-DD HH:II:SS</return> 形式で表した文字列、あるいはエラー時に <info>false</info>
          を返します。


id: RarEntry::getHostOs
type: function
doc:
<comment>Description:</comment>
  エントリのホスト OS を取得する
  
  アーカイブエントリのホスト OS のコードを返します。

<comment>Return:</comment>
  <info>int</info>  ホスト OS のコード、あるいはエラー時に <info>false</info> を返します。

<comment>See Also:</comment>
   * RarEntry::extract


id: RarEntry::getMethod
type: function
doc:
<comment>Description:</comment>
  エントリの圧縮方法を取得する
  
  RarEntry::getMethod は、現在のアーカイブエントリを 追加する際に使用したメソッドの番号を返します。

<comment>Return:</comment>
  <info>int</info>  メソッド番号、あるいはエラー時に <info>false</info> を返します。


id: RarEntry::getName
type: function
doc:
<comment>Description:</comment>
  エントリの名前を取得する
  
  アーカイブエントリの名前 (パスつき) を返します。

<comment>Return:</comment>
  <info>string</info>  エントリ名を表す文字列、あるいはエラー時に <info>false</info> を返します。


id: RarEntry::getPackedSize
type: function
doc:
<comment>Description:</comment>
  圧縮後のエントリのサイズを取得する
  
  圧縮後のアーカイブエントリのサイズを取得します。
  
  調整数型が 32 ビットであるプラットフォーム (Windows x64 など) では、返されるサイズの上限は 2 GiB
  となります。定数 <info>PHP_INT_MAX</info> をチェックしましょう。

<comment>Return:</comment>
  <info>int</info>  圧縮後のサイズ、あるいはエラー時に <info>false</info> を返します。


id: RarEntry::getStream
type: function
doc:
<comment>Description:</comment>
  このエントリのファイルハンドラを取得する
  
  読み込み操作をサポートするファイルハンドラを返します。 このハンドラを使って、このエントリをその場
  で展開します。
  
  このハンドラは、<strong>rar_close()</strong> をコールしても無効にはなりません。
  
  返されるストリームでは、整合性の検証を行いません。 特に、ファイルの破損や間違ったキーによる復号は
  検出できません。 もし整合性を検証したいのなら、エントリの CRC を確認するのはプログラマ側の役割とな
  ります。

<comment>Param:</comment>
  <info>string</info>  <strong>$password</strong>  このエントリの暗号化に使うパスワード。 エントリが暗号化されていない場合は、この
                     値は使われずに無視されます。 このパラメータが省略されていてエントリが暗号化され
                     ていた場合は、もし <strong>rar_open()</strong> でパスワードを指定していればそれを使います。 この
                     パラメータや <strong>rar_open()</strong> で指定したパスワードが間違っていたときは、 このメソッド
                     の結果のストリームは間違った結果を出力します。 パスワードが要求されているときに
                     パスワードを指定していなければ、 このメソッドは失敗して <info>false</info> を返します。 エン
                     トリが暗号化されているかどうかを知るには RarEntry::isEncrypted を使います。

<comment>Return:</comment>
  <info>resource|false</info>  ファイルハンドラを返します。失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * RarEntry::extract
   * <return>rar://</return> ラッパー


id: RarEntry::getUnpackedSize
type: function
doc:
<comment>Description:</comment>
  展開後のエントリのサイズを取得する
  
  展開後のアーカイブエントリのサイズを取得します。
  
  調整数型が 32 ビットであるプラットフォーム (Windows x64 など) では、返されるサイズの上限は 2 GiB
  となります。定数 <info>PHP_INT_MAX</info> をチェックしましょう。

<comment>Return:</comment>
  <info>int</info>  展開後のサイズ、あるいはエラー時に <info>false</info> を返します。


id: RarEntry::getVersion
type: function
doc:
<comment>Description:</comment>
  このエントリを展開するのに必要な RAR プログラムの最低バージョンを取得する
  
  このエントリを展開するのに必要な RAR プログラム (WinRAR など) の最低バージョンを取得します。 10 *
  メジャーバージョン + マイナーバージョン 形式になります。

<comment>Return:</comment>
  <info>int</info>  バージョン、あるいはエラー時に <info>false</info> を返します。


id: RarEntry::isDirectory
type: function
doc:
<comment>Description:</comment>
  このエントリがディレクトリであるかどうかを調べる
  
  現在のエントリがディレクトリであるかどうかを調べます。

<comment>Return:</comment>
  <info>bool</info>  エントリがディレクトリである場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。


id: RarEntry::isEncrypted
type: function
doc:
<comment>Description:</comment>
  このエントリが暗号化されているかどうかを調べる
  
  現在のディレクトリが暗号化されているかどうかを調べます。
  
  同じ RAR アーカイブ内でも、ファイルによってパスワードが異なることがあります。

<comment>Return:</comment>
  <info>bool</info>  エントリが暗号化されている場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。


id: RarException
type: class
doc:
<comment>Description:</comment>
  このクラスの役割は、RAR 拡張モジュールの関数やメソッドからスローされた例外を表す型となることと
  staticメソッドを使ってエラーの詳細 (例外がスローされたのか、 それとも警告が発生しただけなのかなど)
  を得ることのふたつです。
  
  次のエラーコードを使います。
  
  -1 - UnRAR ライブラリ以外のエラー
  
  11 - メモリの不足
  
  12 - データ不良
  
  13 - アーカイブ不良
  
  14 - 未知のフォーマット
  
  15 - ファイルオープンエラー
  
  16 - ファイル作成エラー
  
  17 - ファイルクローズエラー
  
  18 - 読み込みエラー
  
  19 - 書き込みエラー
  
  20 - バッファ不足
  
  21 - 未知の RAR エラー
  
  22 - パスワードが要求されているのに指定しなかった


id: RarException::isUsingExceptions
type: function
doc:
<comment>Description:</comment>
  例外によるエラー処理を使っているかどうかを調べる
  
  RAR 関数が警告を発してエラー値を返すようになっているか、 あるいは例外をスローするようになっている
  かを調べます (引数の型を間違えるなどのプログラム上のエラーは含めません)。

<comment>Return:</comment>
  <info>bool</info>  例外を使っている場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * RarException::setUsingExceptions


id: RarException::setUsingExceptions
type: function
doc:
<comment>Description:</comment>
  例外によるエラー処理の有効化および無効化を行う
  
  引数に <info>true</info> を指定すると、UnRAR ライブラリがエラーに遭遇したときの挙動を変更し、 警告を発してエ
  ラーを示す値を返すのではなく <info>RarException</info> 型の例外をスローするようにします。
  
  例外は次のエラーのときにもスローされます。これらはライブラリの外部で発生します (エラーコードは -1
  です)。
  
  既に閉じた <info>RarArchive</info> オブジェクトやそれに関する <info>RarEntry</info> オブジェクトへのアクセスを試みたとき。
  
  存在しないエントリを RarArchive::getEntry で取得しようと試みたとき。

<comment>Param:</comment>
  <info>bool</info>  <strong>$using_exceptions</strong>  例外をスローさせるときは <info>true</info>、例外をスローさせないときは <info>false</info> (デフォル
                           ト)。

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

<comment>See Also:</comment>
   * RarException::isUsingExceptions


id: RecursiveArrayIterator
type: class
doc:
<comment>Description:</comment>
  このイテレータは、<info>ArrayIterator</info> と同じように配列やオブジェクトを反復処理しつつ、 そのキーや値を消
  去したり書き換えたりすることができます。 さらに、現在のイテレータのエントリを反復処理することも可
  能です。


id: RecursiveArrayIterator::getChildren
type: function
doc:
<comment>Description:</comment>
  現在のエントリが配列あるいはオブジェクトである場合に、そのイテレータを返す
  
  現在のエントリのイテレータを返します。

<comment>Return:</comment>
  <info>RecursiveArrayIterator|null</info>  現在のエントリが配列あるいはオブジェクトである場合に、 そのイテレータ
                               を返します。 失敗時に <info>null</info> を返します。

<comment>See Also:</comment>
   * <strong>RecursiveArrayIterator::hasChildren()</strong>


id: RecursiveArrayIterator::hasChildren
type: function
doc:
<comment>Description:</comment>
  現在のエントリが配列あるいはオブジェクトであるかどうかを返す
  
  現在のエントリが配列あるいはオブジェクトであるかどうか、つまり RecursiveArrayIterator::getChildren
  でイテレータを取得できるかどうかを返します。

<comment>Return:</comment>
  <info>bool</info>  現在のエントリが配列あるいはオブジェクトである場合に <info>true</info>、 それ以外の場合に <info>false</info> を返しま
        す。

<comment>See Also:</comment>
   * <strong>RecursiveArrayIterator::getChildren()</strong>


id: RecursiveCachingIterator::__construct
type: function
doc:
<comment>Description:</comment>
  コンストラクタ
  
  <strong>$iterator</strong> で渡されたイテレータをもとにして新しい <class>RecursiveCachingIterator</class> を作成します。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>Iterator</info>  <strong>$iterator</strong>  使用するイテレータ。
  <info>int</info>       <strong>$flags</strong>     フラグ。<info>CALL_TOSTRING</info> は RecursiveCachingIterator::__toString をすべての要素
                       に対してコールします (デフォルト)。 <info>CATCH_GET_CHILD</info> は 子を取得しようとしたと
                       きに発生する例外を捕捉します。

<comment>See Also:</comment>
   * CachingIterator::__construct


id: RecursiveCachingIterator::getChildren
type: function
doc:
<comment>Description:</comment>
  内部イテレータの子を RecursiveCachingIterator として返す
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>RecursiveCachingIterator|null</info>  内部イテレータの子を RecursiveCachingIterator として返します。 子が
                                 存在しない場合、<info>null</info> を返します。


id: RecursiveCachingIterator::hasChildren
type: function
doc:
<comment>Description:</comment>
  内部イテレータの現在の要素が子を持つかどうかチェックする
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>bool</info>  内部イテレータが子を持つ場合に <info>true</info>、そうでない場合に <info>false</info> を返します。


id: RecursiveCallbackFilterIterator::__construct
type: function
doc:
<comment>Description:</comment>
  RecursiveIterator から RecursiveCallbackFilterIterator を作成する
  
  <strong>$callback</strong> でフィルタリングした RecursiveIterator を作って、 どのアイテムを受け付けてどれを拒否する
  かを決めます。

<comment>Param:</comment>
  <info>RecursiveIterator</info>  <strong>$iterator</strong>  フィルタリングする再帰イテレータ。
  <info>callable</info>           <strong>$callback</strong>  コールバック。現在のアイテムを受け付ける場合に <info>true</info>、 拒否する場合に
                                <info>false</info> を返します。 例 を参照ください。
                                
                                任意の <info>callable</info> 値を指定できます。

<comment>See Also:</comment>
   * RecursiveCallbackFilterIterator の例
   * RecursiveCallbackFilterIterator::getChildren
   * RecursiveCallbackFilteriterator::hasChildren


id: RecursiveCallbackFilterIterator::getChildren
type: function
doc:
<comment>Description:</comment>
  RecursiveCallbackFilterIterator に含まれる内部イテレータの子を返す
  
  内部イテレータのフィルタリングした子を取得します。
  
  RecursiveCallbackFilterIterator::hasChildren を使って、取得できる子があるかどうかを調べなければな
  りません。

<comment>Return:</comment>
  <info>RecursiveCallbackFilterIterator</info>  子を含む <class>RecursiveCallbackFilterIterator</class> を返します。

<comment>See Also:</comment>
   * RecursiveCallbackFilterIterator の例
   * RecursiveCallbackFilterIterator::__construct
   * RecursiveCallbackFilteriterator::hasChildren


id: RecursiveCallbackFilterIterator::hasChildren
type: function
doc:
<comment>Description:</comment>
  内部イテレータの現在の要素が子を持つかどうかを調べる
  
  現在の要素が子を持つときに <info>true</info>、それ以外の場合に <info>false</info> を返します。

<comment>Return:</comment>
  <info>bool</info>  現在の要素が子を持つときに <info>true</info>、それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * RecursiveCallbackFilterIterator の例
   * RecursiveCallbackFilterIterator::__construct
   * RecursiveCallbackFilteriterator::getChildren


id: RecursiveDirectoryIterator
type: class
doc:
<comment>Description:</comment>
  <class>RecursiveDirectoryIterator</class> は、 ファイルシステムのディレクトリを再帰的に反復処理するためのインター
  フェイスです。


id: RecursiveDirectoryIterator::__construct
type: function
doc:
<comment>Description:</comment>
  RecursiveDirectoryIterator を作成する
  
  指定したパス <strong>$directory</strong> の RecursiveDirectoryIterator を作成します。

<comment>Param:</comment>
  <info>string</info>  <strong>$directory</strong>  反復処理の対象となるディレクトリのパス。
  <info>int</info>     <strong>$flags</strong>      フラグを指定して、いくつかのメソッドの振る舞いを変更することができます。 フラ
                      グの一覧は FilesystemIterator の定義済み定数 にあります。フラグは、あとから
                      FilesystemIterator::setFlags で設定することもできます。

<comment>See Also:</comment>
   * FilesystemIterator::__construct
   * RecursiveIteratorIterator::__construct
   * FilesystemIterator の定義済み定数


id: RecursiveDirectoryIterator::getChildren
type: function
doc:
<comment>Description:</comment>
  ディレクトリであれば、現在のエントリに対するイテレータを返す
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>RecursiveDirectoryIterator</info>  ファイル名、ファイル情報、あるいは $this のどれかを、 設定されているフ
                              ラグによって返します。 FilesystemIterator の定数 も参照ください。


id: RecursiveDirectoryIterator::getSubPath
type: function
doc:
<comment>Description:</comment>
  サブパスを取得する
  
  コンストラクタで渡されたディレクトリのサブパスを返します。

<comment>Return:</comment>
  <info>string</info>  サブパス(サブディレクトリ) を返します。

<comment>See Also:</comment>
   * RecursiveDirectoryIterator::getSubPathName
   * RecursiveDirectoryIterator::key


id: RecursiveDirectoryIterator::getSubPathname
type: function
doc:
<comment>Description:</comment>
  サブパスと名前を取得する
  
  サブパスとファイル名を取得します。

<comment>Return:</comment>
  <info>string</info>  サブパス (サブディレクトリ) とファイル名を返します。

<comment>See Also:</comment>
   * RecursiveDirectoryIterator::getSubPath
   * RecursiveDirectoryIterator::key


id: RecursiveDirectoryIterator::hasChildren
type: function
doc:
<comment>Description:</comment>
  現在のエントリがディレクトリかつ '.' もしくは '..' でないかどうかを返す
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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

<comment>Return:</comment>
  <info>bool</info>  現在のエントリが ('.' や '..' 以外の) ディレクトリであるかどうかを返します。


id: RecursiveDirectoryIterator::key
type: function
doc:
<comment>Description:</comment>
  現在のディレクトリエントリのパスとファイル名を返す
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>string</info>  現在のディレクトリエントリのパスとファイル名を返します。


id: RecursiveDirectoryIterator::next
type: function
doc:
<comment>Description:</comment>
  次のエントリに移動する
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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


id: RecursiveDirectoryIterator::rewind
type: function
doc:
<comment>Description:</comment>
  ディレクトリを最初に巻き戻す
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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


id: RecursiveFilterIterator
type: class
doc:
<comment>Description:</comment>
  この抽象イテレータは、不要な値を <class>RecursiveIterator</class> から取り除きます。 このクラスを継承して、独自の
  フィルタを実装することができます。 RecursiveFilterIterator::accept は、サブクラスで必ず実装しなけ
  ればなりません。


id: RecursiveFilterIterator::__construct
type: function
doc:
<comment>Description:</comment>
  RecursiveIterator から RecursiveFilterIterator を作成する
  
  <class>RecursiveIterator</class> から <class>RecursiveFilterIterator</class> を作成します。

<comment>Param:</comment>
  <info>RecursiveIterator</info>  <strong>$iterator</strong>  フィルタリングする <class>RecursiveIterator</class>。

<comment>See Also:</comment>
   * RecursiveFilterIterator::getChildren
   * RecursiveFilterIterator::hasChildren
   * FilterIterator::accept


id: RecursiveFilterIterator::getChildren
type: function
doc:
<comment>Description:</comment>
  RecursiveFilterIterator に含まれる内部イテレータの子を返す
  
  <class>RecursiveFilterIterator</class> に含まれる内部イテレータの子を返します。

<comment>Return:</comment>
  <info>RecursiveFilterIterator|null</info>  <class>RecursiveFilterIterator</class> に含まれる内部イテレータの子を返します。

<comment>See Also:</comment>
   * RecursiveFilterIterator::hasChildren
   * RecursiveIterator::getChildren


id: RecursiveFilterIterator::hasChildren
type: function
doc:
<comment>Description:</comment>
  内部イテレータの現在の要素が子を持つかどうかを調べる
  
  内部イテレータの現在の要素が子を持つかどうかを調べます。

<comment>Return:</comment>
  <info>bool</info>  内部イテレータが子を持つ場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * RecursiveFilterIterator::getChildren
   * RecursiveIterator::hasChildren


id: RecursiveIterator
type: class
doc:
<comment>Description:</comment>
  <class>RecursiveIterator</class> を実装したクラスは、 イテレータ群を再帰的に反復処理するときに使うことができま
  す。


id: RecursiveIterator::getChildren
type: function
doc:
<comment>Description:</comment>
  現在のエントリのイテレータを返す
  
  現在のエントリのイテレータを返します。

<comment>Return:</comment>
  <info>RecursiveIterator|null</info>  現在のエントリのイテレータが存在した場合、それを返します。 存在しない場
                          合、<info>null</info> を返します。

<comment>See Also:</comment>
   * <strong>RecursiveIterator::hasChildren()</strong>


id: RecursiveIterator::hasChildren
type: function
doc:
<comment>Description:</comment>
  現在のエントリのイテレータを作れるかどうかを返す
  
  現在のエントリのイテレータを作れるかどうかを返します。

<comment>Return:</comment>
  <info>bool</info>  現在のエントリが反復処理可能な場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>RecursiveIterator::getChildren()</strong>


id: RecursiveIteratorIterator::__construct
type: function
doc:
<comment>Description:</comment>
  RecursiveIteratorIterator を作成する
  
  <class>RecursiveIterator</class> から <class>RecursiveIteratorIterator</class> を作成します。

<comment>Param:</comment>
  <info>Traversable</info>  <strong>$iterator</strong>  作成する元となるイテレータ。 <class>RecursiveIterator</class> あるいは
                          <class>IteratorAggregate</class>。
  <info>int</info>          <strong>$mode</strong>      オプションのモード。これらの値が指定できます。
                          <info>RecursiveIteratorIterator::LEAVES_ONLY</info> - デフォルト。イテレーションで葉
                          ノードだけを取り上げます。 <info>RecursiveIteratorIterator::SELF_FIRST</info> - イテ
                          レーションで葉と親を (親から先に) 取り上げます。
                          <info>RecursiveIteratorIterator::CHILD_FIRST</info> - イテレーションで葉と親を (葉から
                          先に) 取り上げます。
  <info>int</info>          <strong>$flags</strong>     オプションのフラグ。指定できる値は
                          <info>RecursiveIteratorIterator::CATCH_GET_CHILD</info> で、
                          RecursiveIteratorIterator::getChildren のコール時にスローされた例外を無視
                          します。


id: RecursiveIteratorIterator::beginChildren
type: function
doc:
<comment>Description:</comment>
  子を開始する
  
  RecursiveIteratorIterator::getChildren と、それに関連する RecursiveIteratorIterator::rewind をコー
  ルした後でコールされます。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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


id: RecursiveIteratorIterator::beginIteration
type: function
doc:
<comment>Description:</comment>
  反復処理を開始する
  
  反復処理が始まるとき (最初に RecursiveIteratorIterator::rewind がコールされた後) にコールされま
  す。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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


id: RecursiveIteratorIterator::callGetChildren
type: function
doc:
<comment>Description:</comment>
  子を取得する
  
  現在の要素の子を取得します。

<comment>Return:</comment>
  <info>RecursiveIterator|null</info>  成功時に RecursiveIterator を返します。 失敗時に <info>null</info> を返します。


id: RecursiveIteratorIterator::callHasChildren
type: function
doc:
<comment>Description:</comment>
  子を持つかどうかを調べる
  
  各要素に対して、子を持っているかどうかを調べるためにコールします。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>bool</info>  要素に子があるかどうかを返します。


id: RecursiveIteratorIterator::current
type: function
doc:
<comment>Description:</comment>
  現在の要素の値にアクセスする
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>mixed</info>  現在の要素の値を返します。


id: RecursiveIteratorIterator::endChildren
type: function
doc:
<comment>Description:</comment>
  子を終了する
  
  そのレベルの再帰処理が終了したときにコールされます。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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


id: RecursiveIteratorIterator::endIteration
type: function
doc:
<comment>Description:</comment>
  反復処理を終了する
  
  反復処理が終了したとき (RecursiveIteratorIterator::valid が最初に <info>false</info> を返したとき) にコールされ
  ます。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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


id: RecursiveIteratorIterator::getDepth
type: function
doc:
<comment>Description:</comment>
  再帰的なイテレーションにおける現在の深さを取得する
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>int</info>  再帰的なイテレーションにおける現在の深さを返します。


id: RecursiveIteratorIterator::getInnerIterator
type: function
doc:
<comment>Description:</comment>
  内部イテレータを取得する
  
  現在アクティブなサブイテレータを取得します。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>RecursiveIterator</info>  現在アクティブなサブイテレータを返します。


id: RecursiveIteratorIterator::getMaxDepth
type: function
doc:
<comment>Description:</comment>
  最大の深さを取得する
  
  許可される最大の深さを取得します。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>int|false</info>  許可される最大の深さ、あるいは無制限の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * RecursiveIteratorIterator::setMaxDepth


id: RecursiveIteratorIterator::getSubIterator
type: function
doc:
<comment>Description:</comment>
  現在の有効なサブイテレータを取得する
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>int|null</info>  <strong>$level</strong>  

<comment>Return:</comment>
  <info>RecursiveIterator|null</info>  成功時に、現在の有効なサブイテレータを返します。 失敗時に <info>null</info> を返しま
                          す。


id: RecursiveIteratorIterator::key
type: function
doc:
<comment>Description:</comment>
  現在のキーにアクセスする
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>mixed</info>  現在のキーを返します。


id: RecursiveIteratorIterator::next
type: function
doc:
<comment>Description:</comment>
  次の要素に移動する
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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


id: RecursiveIteratorIterator::nextElement
type: function
doc:
<comment>Description:</comment>
  次の要素
  
  次の要素が利用可能となったときにコールされます。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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


id: RecursiveIteratorIterator::rewind
type: function
doc:
<comment>Description:</comment>
  トップレベルの内部イテレータの先頭要素にイテレータを巻き戻す
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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


id: RecursiveIteratorIterator::setMaxDepth
type: function
doc:
<comment>Description:</comment>
  最大の深さを設定する
  
  許可される最大の深さを設定します。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>int</info>  <strong>$maxDepth</strong>  許可される最大の深さ。<return>-1</return> を指定すると無制限にできます。

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


id: RecursiveIteratorIterator::valid
type: function
doc:
<comment>Description:</comment>
  現在の位置が有効かどうかをチェックする
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>bool</info>  現在の位置が有効な場合に <info>true</info>、そうでない場合に <info>false</info> を返します。


id: RecursiveRegexIterator::__construct
type: function
doc:
<comment>Description:</comment>
  新しい RecursiveRegexIterator を作成する
  
  新しい正規表現イテレータを作成します。

<comment>Param:</comment>
  <info>RecursiveIterator</info>  <strong>$iterator</strong>   この正規表現フィルタを適用するイテレータ。
  <info>string</info>             <strong>$pattern</strong>    マッチさせる正規表現。
  <info>int</info>                <strong>$mode</strong>       操作モード。モードの一覧は RegexIterator::setMode を参照ください。
  <info>int</info>                <strong>$flags</strong>      特殊なフラグ。フラグの一覧は RegexIterator::setFlags を参照くださ
                                 い。
  <info>int</info>                <strong>$pregFlags</strong>  正規表現フラグ。これらのフラグは操作モードに依存します。
                                 
                                 <class>RegexIterator</class> preg_flags操作モード使用可能なフラグ
                                 RecursiveRegexIterator::ALL_MATCHES<strong>preg_match_all()</strong> を参照くださ
                                 い。 RecursiveRegexIterator::GET_MATCH<strong>preg_match()</strong> を参照ください。
                                 RecursiveRegexIterator::MATCH<strong>preg_match()</strong> を参照ください。
                                 RecursiveRegexIterator::REPLACE なし。
                                 RecursiveRegexIterator::SPLIT<strong>preg_split()</strong> を参照ください。

<comment>See Also:</comment>
   * <strong>preg_match()</strong>
   * <strong>preg_match_all()</strong>
   * <strong>preg_replace()</strong>
   * <strong>preg_split()</strong>


id: RecursiveRegexIterator::getChildren
type: function
doc:
<comment>Description:</comment>
  現在のエントリのイテレータを返す
  
  現在のエントリのイテレータを返します。

<comment>Return:</comment>
  <info>RecursiveRegexIterator</info>  内部イテレータで反復処理が可能な場合に、現在のエントリのイテレータを返しま
                          す。

<comment>See Also:</comment>
   * <strong>RecursiveRegexIterator::hasChildren()</strong>


id: RecursiveRegexIterator::hasChildren
type: function
doc:
<comment>Description:</comment>
  現在のエントリのイテレータが取得可能かどうかを返す
  
  現在のエントリのイテレータが取得可能かどうかを返すこのイテレータは
  RecursiveRegexIterator::getChildren で取得します。

<comment>Return:</comment>
  <info>bool</info>  現在のエントリのイテレータが取得可能な場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>RecursiveRegexIterator::getChildren()</strong>


id: RecursiveTreeIterator::__construct
type: function
doc:
<comment>Description:</comment>
  RecursiveTreeIterator を作成する
  
  新しい <class>RecursiveTreeIterator</class> を、指定した再帰イテレータから作成します。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>RecursiveIterator|IteratorAggregate</info>  <strong>$iterator</strong>          <class>RecursiveIterator</class> あるいは
                                                          <class>IteratorAggregate</class>。
  <info>int</info>                                  <strong>$flags</strong>             フラグを指定して一部のメソッドの振る舞いを
                                                          変更することができます。 フラグの一覧は
                                                          RecursiveTreeIterator の定義済み定数 にあ
                                                          ります。
  <info></info>                                     <strong>$caching_it_flags</strong>  内部的に使う <class>RecursiveCachingIterator</class> の振
                                                          る舞いを変更するフラグ。
  <info>int</info>                                  <strong>$mode</strong>              内部的に使う <class>RecursiveIteratorIterator</class> の
                                                          振る舞いを変更するフラグ。


id: RecursiveTreeIterator::beginChildren
type: function
doc:
<comment>Description:</comment>
  子を開始する
  
  一段下がるときにコールされます。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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


id: RecursiveTreeIterator::beginIteration
type: function
doc:
<comment>Description:</comment>
  反復処理を開始する
  
  反復処理を開始するとき (最初に RecursiveTreeIterator::rewind がコールされた後) にコールされます。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>RecursiveIterator</info>  <class>RecursiveIterator</class> を返します。


id: RecursiveTreeIterator::callGetChildren
type: function
doc:
<comment>Description:</comment>
  子を取得する
  
  現在の要素の子を取得します。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>RecursiveIterator</info>  <class>RecursiveIterator</class> を返します。


id: RecursiveTreeIterator::callHasChildren
type: function
doc:
<comment>Description:</comment>
  子を持っているかどうかを調べる
  
  各要素が子を持っているかどうかを調べるときにコールします。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>bool</info>  子がある場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。


id: RecursiveTreeIterator::current
type: function
doc:
<comment>Description:</comment>
  現在の要素を取得する
  
  接頭辞と接尾辞をつけた現在の要素を取得します。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>mixed</info>  接頭辞と接尾辞をつけた現在の要素を返します。


id: RecursiveTreeIterator::endChildren
type: function
doc:
<comment>Description:</comment>
  子を終了する
  
  一段下の再帰処理が終了したときにコールされます。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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


id: RecursiveTreeIterator::endIteration
type: function
doc:
<comment>Description:</comment>
  反復処理を終了する
  
  反復処理が終了したとき (RecursiveTreeIterator::valid が最初に <info>false</info> を返したとき) にコールされま
  す。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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


id: RecursiveTreeIterator::getEntry
type: function
doc:
<comment>Description:</comment>
  現在のエントリを取得する
  
  現在の要素から作ったツリーを取得します。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>string</info>  現在の要素から作ったツリーを返します。


id: RecursiveTreeIterator::getPostfix
type: function
doc:
<comment>Description:</comment>
  接尾辞を取得する
  
  現在の要素の後に置く文字列を取得します。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>string</info>  現在の要素の後に置く文字列を返します。


id: RecursiveTreeIterator::getPrefix
type: function
doc:
<comment>Description:</comment>
  接頭辞を取得する
  
  現在の要素の前に置く文字列を取得します。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>string</info>  現在の要素の前に置く文字列を返します。


id: RecursiveTreeIterator::key
type: function
doc:
<comment>Description:</comment>
  現在の要素のキーを取得する
  
  接頭辞と接尾辞をつけた現在のキーを取得します。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>mixed</info>  接頭辞と接尾辞をつけた現在のキーを返します。


id: RecursiveTreeIterator::next
type: function
doc:
<comment>Description:</comment>
  次の要素に移動する
  
  次の要素に移動します。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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


id: RecursiveTreeIterator::rewind
type: function
doc:
<comment>Description:</comment>
  イテレータを巻き戻す
  
  トップレベルの内部イテレータの最初の要素にイテレータを巻き戻します。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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


id: RecursiveTreeIterator::setPostfix
type: function
doc:
<comment>Description:</comment>
  postfix を設定する
  
  RecursiveTreeIterator::getPostfix で使われる postfix を設定します。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>string</info>  <strong>$postfix</strong>  

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


id: RecursiveTreeIterator::setPrefixPart
type: function
doc:
<comment>Description:</comment>
  接頭辞の部分を設定する
  
  グラフィックツリーで使う接頭辞を設定します。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>int</info>     <strong>$part</strong>   RecursiveTreeIterator::PREFIX_* 定数のいずれか。
  <info>string</info>  <strong>$value</strong>  <strong>$part</strong> で指定した接頭辞に代入する値。

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


id: RecursiveTreeIterator::valid
type: function
doc:
<comment>Description:</comment>
  有効性を調べる
  
  現在位置が有効かどうかを調べます。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>bool</info>  現在位置が有効な場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。


id: Reflection::export
type: function
doc:
<comment>Description:</comment>
  エクスポートする
  
  リフレクションをエクスポートします。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>Reflector</info>  <strong>$reflector</strong>  エクスポートするリフレクション。
  <info>bool</info>       <strong>$return</strong>     <info>true</info> に設定すると、エクスポートを発行するのではなく返します。
                         <info>false</info> (デフォルト) の場合はその逆です。

<comment>Return:</comment>
  <info>string</info>  <strong>$return</strong> パラメータを
          <info>true</info> に設定すると、エクスポートを文字列で返します。それ以外の場合は
          <info>null</info> を返します。

<comment>See Also:</comment>
   * Reflection::getModifierNames


id: Reflection::getModifierNames
type: function
doc:
<comment>Description:</comment>
  修飾子の名前を取得する
  
  修飾子の名前を取得します。

<comment>Param:</comment>
  <info>int</info>  <strong>$modifiers</strong>  取得する主食師のビットフィールド

<comment>Return:</comment>
  <info>array</info>  修飾子の名前の配列を返します。

<comment>See Also:</comment>
   * ReflectionClass::getModifiers
   * ReflectionClassConstant::getModifiers
   * ReflectionMethod::getModifiers
   * ReflectionProperty::getModifiers


id: ReflectionAttribute::getArguments
type: function
doc:
<comment>Description:</comment>
  アトリビュートに渡された引数を取得する
  
  アトリビュートに渡された引数を取得します。

<comment>Return:</comment>
  <info>array</info>  アトリビュートに渡された引数を返します。


id: ReflectionAttribute::getName
type: function
doc:
<comment>Description:</comment>
  アトリビュートの名前を取得する
  
  アトリビュートの名前を取得します。

<comment>Return:</comment>
  <info>string</info>  アトリビュートの名前を返します。


id: ReflectionAttribute::getTarget
type: function
doc:
<comment>Description:</comment>
  アトリビュートのターゲットをビットマスクとして返す
  
  アトリビュートのターゲットをビットマスクとして取得します。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>int</info>   アトリビュートのターゲットをビットマスクとして返します。


id: ReflectionAttribute::isRepeated
type: function
doc:
<comment>Description:</comment>
  この名前のアトリビュートが、実際にコード上に繰り返し現れているかどうかを取得する
  
  この名前のアトリビュートが、実際にコード上に繰り返し現れているかどうかを取得します。

<comment>Return:</comment>
  <info>bool</info>  アトリビュートが繰り返し使われている場合は <info>true</info> を返します。 そうでない場合は、<info>false</info> を返し
        ます。


id: ReflectionAttribute::newInstance
type: function
doc:
<comment>Description:</comment>
  アトリビュートクラスをインスタンス化する
  
  この ReflectionAttribute クラスと引数を表現する、 アトリビュートクラスをインスタンス化します。

<comment>Return:</comment>
  <info>object</info>  アトリビュートの新しいインスタンスを返します。


id: ReflectionClass::__construct
type: function
doc:
<comment>Description:</comment>
  ReflectionClass を作成する
  
  新しい <class>ReflectionClass</class> オブジェクトを作成します。

<comment>Param:</comment>
  <info>object|string</info>  <strong>$objectOrClass</strong>  調べたいクラスのクラス名をあらわす文字列か、そのクラスのオブジェク
                                 ト。

<comment>See Also:</comment>
   * ReflectionObject::__construct
   * コンストラクタ


id: ReflectionClass::__toString
type: function
doc:
<comment>Description:</comment>
  ReflectionClass オブジェクトの文字列表現を返す
  
  ReflectionClass オブジェクトの文字列表現を返します。

<comment>Return:</comment>
  <info>string</info>  この <class>ReflectionClass</class> インスタンスの文字列表現を返します。

<comment>See Also:</comment>
   * ReflectionClass::export
   * __toString()


id: ReflectionClass::export
type: function
doc:
<comment>Description:</comment>
  クラスをエクスポートする
  
  調べているクラスをエクスポートします。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$argument</strong>  エクスポートするリフレクション。
  <info>bool</info>   <strong>$return</strong>    <info>true</info> に設定すると、エクスポートを発行するのではなく返します。
                    <info>false</info> (デフォルト) の場合はその逆です。

<comment>Return:</comment>
  <info>string</info>  <strong>$return</strong> パラメータを
          <info>true</info> に設定すると、エクスポートを文字列で返します。それ以外の場合は
          <info>null</info> を返します。

<comment>See Also:</comment>
   * ReflectionClass::getName
   * ReflectionClass::__toString


id: ReflectionClass::getAttributes
type: function
doc:
<comment>Description:</comment>
  アトリビュートを取得する
  
  このクラスで宣言されている全てのアトリビュートを <info>ReflectionAttribute</info> の配列として返します。

<comment>Param:</comment>
  <info>string|null</info>  <strong>$name</strong>   指定したクラス名にマッチするアトリビュートの、 <class>ReflectionAttribute</class> のみを含む
                       ようにフィルタします。
  <info>int</info>          <strong>$flags</strong>  <strong>$name</strong> が指定されていた場合に、 結果をどうフィルタするかを決めるフラグ。
                       
                       デフォルトは <return>0</return> です。 この場合、アトリビュートのクラス名が <strong>$name</strong> であるものだ
                       けを返します。
                       
                       他の利用可能なオプションは、 <info>ReflectionAttribute::IS_INSTANCEOF</info> です。 この場
                       合、フィルタリングに <return>instanceof</return> を使います。

<comment>Return:</comment>
  <info>array</info>  アトリビュートの配列を、 <class>ReflectionAttribute</class> オブジェクトの配列として返します。

<comment>See Also:</comment>
   * ReflectionClassConstant::getAttributes
   * ReflectionFunctionAbstract::getAttributes
   * ReflectionParameter::getAttributes
   * ReflectionProperty::getAttributes


id: ReflectionClass::getConstant
type: function
doc:
<comment>Description:</comment>
  定義されている定数を取得する
  
  定義されている定数を取得します。

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  取得する対象のクラス定数の名前。

<comment>Return:</comment>
  <info>mixed</info>  <strong>$name</strong> で指定した名前の定数の値を返します。 そのクラスに定数が見つからなかった場合は、<info>false</info>
         を返します。

<comment>See Also:</comment>
   * ReflectionClass::getConstants


id: ReflectionClass::getConstants
type: function
doc:
<comment>Description:</comment>
  定数を取得する
  
  アクセス権にかかわらず、クラスで定義されているすべての定数を取得します。

<comment>Param:</comment>
  <info>int|null</info>  <strong>$filter</strong>  オプションのフィルタで、取得したい定数の型を絞り込みます。
                     ReflectionClassConstant クラスの定数 で設定し、デフォルトではすべての定数を取得
                     します。

<comment>Return:</comment>
  <info>array</info>  定数の配列を返します。 キーは名前を保持し、値は定数の値を保持します。

<comment>See Also:</comment>
   * ReflectionClass::getConstant


id: ReflectionClass::getConstructor
type: function
doc:
<comment>Description:</comment>
  クラスのコンストラクタを取得する
  
  クラスのコンストラクタを取得します。

<comment>Return:</comment>
  <info>ReflectionMethod|null</info>  クラスのコンストラクタを表す <class>ReflectionMethod</class> オブジェクトを返します。 クラ
                         スのコンストラクタがない場合は <info>null</info> を返します。

<comment>See Also:</comment>
   * ReflectionClass::getName


id: ReflectionClass::getDefaultProperties
type: function
doc:
<comment>Description:</comment>
  デフォルトプロパティを取得する
  
  クラスのデフォルトプロパティ (継承したプロパティを含む) を取得します。
  
  このメソッドで static プロパティを扱えるのは、内部クラスの場合だけです。 ユーザー定義クラスで使っ
  た場合は、 クラスの static なプロパティのデフォルト値はこのメソッドでは追跡できません。

<comment>Return:</comment>
  <info>array</info>  デフォルトプロパティの配列を返します。プロパティ名が配列のキー、 そしてそのプロパティのデ
         フォルト値が配列の値 (デフォルト値が存在しない場合は <info>null</info>) となります。 この関数はstaticプ
         ロパティとそうでないプロパティを区別せず、 アクセス修飾子も考慮しません。

<comment>See Also:</comment>
   * ReflectionClass::getProperties
   * ReflectionClass::getStaticProperties
   * ReflectionClass::getProperty


id: ReflectionClass::getDocComment
type: function
doc:
<comment>Description:</comment>
  ドキュメントコメントを取得する
  
  クラスのドキュメントコメントを取得します。 ドキュメントコメントは、 <return>/**</return> で始まり、 ホワイトスペー
  スがその後に続きます。 クラス定義に複数のドキュメントコメントが存在した場合、 クラスに一番近いコメ
  ントを取得します。

<comment>Return:</comment>
  <info>string|false</info>  ドキュメントコメントが存在すればそれを返します。存在しなければ <info>false</info> を返します。

<comment>See Also:</comment>
   * ReflectionClass::getName


id: ReflectionClass::getEndLine
type: function
doc:
<comment>Description:</comment>
  終了行を取得する
  
  ユーザー定義クラスの定義の終了行を取得します。

<comment>Return:</comment>
  <info>int|false</info>  ユーザー定義クラスの定義の終了行を返します。不明な場合は <info>false</info> を返します。

<comment>See Also:</comment>
   * ReflectionClass::getStartLine


id: ReflectionClass::getExtension
type: function
doc:
<comment>Description:</comment>
  クラスを定義する拡張モジュールを表す ReflectionExtension オブジェクトを取得する
  
  クラスを定義する拡張モジュールを表す <class>ReflectionExtension</class> オブジェクトを取得します。

<comment>Return:</comment>
  <info>ReflectionExtension|null</info>  クラスを定義する拡張モジュールを表す <class>ReflectionExtension</class> オブジェクトを
                            返します。 ユーザー定義のクラスの場合は <info>null</info> を返します。

<comment>See Also:</comment>
   * ReflectionClass::getExtensionName


id: ReflectionClass::getExtensionName
type: function
doc:
<comment>Description:</comment>
  クラスを定義する拡張モジュールの名前を取得する
  
  クラスを定義する拡張モジュールの名前を取得します。

<comment>Return:</comment>
  <info>string|false</info>  クラスを定義する拡張モジュールの名前を返します。 ユーザー定義のクラスの場合は <info>false</info>
                を返します。

<comment>See Also:</comment>
   * ReflectionClass::getExtension


id: ReflectionClass::getFileName
type: function
doc:
<comment>Description:</comment>
  クラスが定義されているファイルのファイル名を取得する
  
  クラスが定義されているファイルのファイル名を取得します。

<comment>Return:</comment>
  <info>string|false</info>  クラスが定義されているファイルのファイル名を返します。 そのクラスが PHP のコアあるい
                は PHP の拡張モジュール内で定義されている場合は <info>false</info> を返します。

<comment>See Also:</comment>
   * ReflectionClass::getExtensionName


id: ReflectionClass::getInterfaceNames
type: function
doc:
<comment>Description:</comment>
  インターフェイスの名前を取得する
  
  インターフェイスの名前を取得します。

<comment>Return:</comment>
  <info>array</info>  インターフェイス名の配列を返します。

<comment>See Also:</comment>
   * ReflectionClass::getInterfaces


id: ReflectionClass::getInterfaces
type: function
doc:
<comment>Description:</comment>
  インターフェイスを取得する
  
  インターフェイスを取得します。

<comment>Return:</comment>
  <info>array</info>  インターフェイスの連想配列を返します。インターフェイス名が連想配列のキー、対応する値が
         <class>ReflectionClass</class> オブジェクトとなります。

<comment>See Also:</comment>
   * ReflectionClass::getInterfaceNames


id: ReflectionClass::getMethod
type: function
doc:
<comment>Description:</comment>
  クラスメソッドの ReflectionMethod を取得する
  
  クラスメソッドに関する <class>ReflectionMethod</class> を取得します。

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  調べたいメソッドの名前。

<comment>Return:</comment>
  <info>ReflectionMethod</info>  <class>ReflectionMethod</class> を返します。

<comment>See Also:</comment>
   * ReflectionClass::getMethods


id: ReflectionClass::getMethods
type: function
doc:
<comment>Description:</comment>
  メソッドの配列を取得する
  
  クラスのメソッドの配列を取得します。

<comment>Param:</comment>
  <info>int|null</info>  <strong>$filter</strong>  結果をフィルタして、特定の属性を持つメソッドだけを含めるようにします。 デフォル
                     トは、何もフィルタしません。
                     
                     <info>ReflectionMethod::IS_STATIC</info>、 <info>ReflectionMethod::IS_PUBLIC</info>、
                     <info>ReflectionMethod::IS_PROTECTED</info>、 <info>ReflectionMethod::IS_PRIVATE</info>、
                     <info>ReflectionMethod::IS_ABSTRACT</info>、 <info>ReflectionMethod::IS_FINAL</info> の任意の組み合わせ。
                     指定した属性の いずれか を持つすべてのメソッドを返します。
                     
                     その他のビット演算 (<return>~</return> など) は期待通りの挙動にはなりません。 つまり、たとえば
                     static ではないメソッドをすべて取得するなどといったことはできません。

<comment>Return:</comment>
  <info>array</info>  各メソッドを表す <class>ReflectionMethod</class> オブジェクトの配列を返します。

<comment>See Also:</comment>
   * ReflectionClass::getMethod
   * <strong>get_class_methods()</strong>


id: ReflectionClass::getModifiers
type: function
doc:
<comment>Description:</comment>
  クラス修飾子を取得する
  
  このクラスのアクセス修飾子のビットフィールドを返します。

<comment>Return:</comment>
  <info>int</info>   修飾子定数 のビットマスクを返します。

<comment>See Also:</comment>
   * ReflectionClass::getProperties
   * Reflection::getModifierNames


id: ReflectionClass::getName
type: function
doc:
<comment>Description:</comment>
  クラスの名前を取得する
  
  クラスの名前を取得します。

<comment>Return:</comment>
  <info>string</info>  クラスの名前を返します。

<comment>See Also:</comment>
   * ReflectionClass::getNamespaceName


id: ReflectionClass::getNamespaceName
type: function
doc:
<comment>Description:</comment>
  名前空間の名前を取得する
  
  名前空間の名前を取得します。

<comment>Return:</comment>
  <info>string</info>  名前空間の名前を返します。

<comment>See Also:</comment>
   * ReflectionClass::getParentClass
   * 名前空間


id: ReflectionClass::getParentClass
type: function
doc:
<comment>Description:</comment>
  親クラスを取得する
  
  親クラスを取得します。

<comment>Return:</comment>
  <info>ReflectionClass|false</info>  <class>ReflectionClass</class> を返します。 親が存在しない場合は、<info>false</info> を返します。

<comment>See Also:</comment>
   * ReflectionClass::__construct


id: ReflectionClass::getProperties
type: function
doc:
<comment>Description:</comment>
  プロパティを取得する
  
  プロパティを取得します。

<comment>Param:</comment>
  <info>int|null</info>  <strong>$filter</strong>  オプションのフィルタで、取得したいプロパティの型を絞り込みます。
                     ReflectionProperty の定数 で設定し、デフォルトではすべてのプロパティ型を取得し
                     ます。

<comment>Return:</comment>
  <info>array</info>  <class>ReflectionProperty</class> オブジェクトの配列を返します。

<comment>See Also:</comment>
   * ReflectionClass::getProperty
   * <class>ReflectionProperty</class>
   * ReflectionProperty の修飾子定数


id: ReflectionClass::getProperty
type: function
doc:
<comment>Description:</comment>
  クラスのプロパティを表す ReflectionProperty を取得する
  
  クラスのプロパティを表す <class>ReflectionProperty</class> を取得します。

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  プロパティの名前。

<comment>Return:</comment>
  <info>ReflectionProperty</info>  <class>ReflectionProperty</class> を返します。

<comment>See Also:</comment>
   * ReflectionClass::getProperties


id: ReflectionClass::getReflectionConstant
type: function
doc:
<comment>Description:</comment>
  クラス定数の ReflectionClassConstant を取得する
  
  クラスのプロパティの <class>ReflectionClassConstant</class> を取得します。

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  クラス定数の名前

<comment>Return:</comment>
  <info>ReflectionClassConstant|false</info>  <class>ReflectionClassConstant</class> を返します。 失敗した場合に <info>false</info> を返しま
                                 す

<comment>See Also:</comment>
   * ReflectionClass::getReflectionConstants
   * <class>ReflectionClassConstant</class>


id: ReflectionClass::getReflectionConstants
type: function
doc:
<comment>Description:</comment>
  クラス定数を取得する
  
  リフレクションされた定数を取得します。

<comment>Param:</comment>
  <info>int|null</info>  <strong>$filter</strong>  オプションのフィルタで、取得したい定数の型を絞り込みます。
                     ReflectionClassConstant の定数 で設定し、デフォルトではすべての定数を取得しま
                     す。

<comment>Return:</comment>
  <info>array</info>  <class>ReflectionClassConstant</class> の配列を返します。

<comment>See Also:</comment>
   * ReflectionClass::getReflectionConstant
   * <class>ReflectionClassConstant</class>


id: ReflectionClass::getShortName
type: function
doc:
<comment>Description:</comment>
  短い名前を取得する
  
  名前空間部分を除いた、クラスの短い名前を取得します。

<comment>Return:</comment>
  <info>string</info>  クラスの短い名前を返します。

<comment>See Also:</comment>
   * ReflectionClass::getName


id: ReflectionClass::getStartLine
type: function
doc:
<comment>Description:</comment>
  開始行を取得する
  
  開始行を取得します。

<comment>Return:</comment>
  <info>int|false</info>  開始行を整数で返します。 開始行が不明な場合は、<info>false</info> を返します。

<comment>See Also:</comment>
   * ReflectionClass::getEndLine


id: ReflectionClass::getStaticProperties
type: function
doc:
<comment>Description:</comment>
  staticプロパティを取得する
  
  staticプロパティを取得します。

<comment>Return:</comment>
  <info>array</info>  staticプロパティを配列で返します。

<comment>See Also:</comment>
   * ReflectionClass::getStaticPropertyValue
   * ReflectionClass::setStaticPropertyValue


id: ReflectionClass::getStaticPropertyValue
type: function
doc:
<comment>Description:</comment>
  staticプロパティの値を取得する
  
  このクラスのstaticプロパティの値を取得します。

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>       値を返したいstaticプロパティの名前。
  <info>mixed</info>   <strong>$def_value</strong>  指定した名前のstaticプロパティがそのクラスに存在しない場合に返す、デフォルト
                      値。 プロパティが存在せず、かつこの引数も省略されていた場合は、
                      <class>ReflectionException</class> が発生します。

<comment>Return:</comment>
  <info>mixed</info>  staticプロパティの値を返します。

<comment>See Also:</comment>
   * ReflectionClass::getStaticProperties
   * ReflectionClass::setStaticPropertyValue


id: ReflectionClass::getTraitAliases
type: function
doc:
<comment>Description:</comment>
  トレイトのエイリアスの配列を返す
  
  現在のクラスで定義された、トレイトのメソッドのエイリアスの配列を返します。

<comment>Return:</comment>
  <info>array</info>  新しいメソッド名をキー、その元の名前 (<return>"TraitName::original"</return> 形式) を値とする配列を返しま
         す。


id: ReflectionClass::getTraitNames
type: function
doc:
<comment>Description:</comment>
  このクラスが使うトレイトの名前の配列を返す
  
  このクラスが使うトレイトの名前を取得します。

<comment>Return:</comment>
  <info>array</info>  トレイト名を値とする配列を返します。


id: ReflectionClass::getTraits
type: function
doc:
<comment>Description:</comment>
  このクラスが使うトレイトの配列を返す
  
  このクラスが使うトレイトの配列を返します。

<comment>Return:</comment>
  <info>array</info>  トレイト名をキー、トレイトの <class>ReflectionClass</class> のインスタンスを値とする配列を返します。 エ
         ラー時には <info>null</info> を返します。


id: ReflectionClass::hasConstant
type: function
doc:
<comment>Description:</comment>
  定数が定義されているかどうかを調べる
  
  そのクラスで特定の定数が定義されているかどうかを調べます。

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  調べたい定数の名前。

<comment>Return:</comment>
  <info>bool</info>  定数が定義されている場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * ReflectionClass::hasMethod
   * ReflectionClass::hasProperty


id: ReflectionClass::hasMethod
type: function
doc:
<comment>Description:</comment>
  メソッドが定義されているかどうかを調べる
  
  そのクラスで特定のメソッドが定義されているかどうかを調べます。

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  調べたいメソッドの名前。

<comment>Return:</comment>
  <info>bool</info>  メソッドが定義されている場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * ReflectionClass::hasConstant
   * ReflectionClass::hasProperty


id: ReflectionClass::hasProperty
type: function
doc:
<comment>Description:</comment>
  プロパティが定義されているかどうかを調べる
  
  特定のプロパティが定義されているかどうかを調べます。

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  調べたいプロパティの名前。

<comment>Return:</comment>
  <info>bool</info>  プロパティが定義されている場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * ReflectionClass::hasConstant
   * ReflectionClass::hasMethod


id: ReflectionClass::implementsInterface
type: function
doc:
<comment>Description:</comment>
  インターフェイスの実装を調べる
  
  インターフェイスを実装しているかどうかを調べます。

<comment>Param:</comment>
  <info>ReflectionClass|string</info>  <strong>$interface</strong>  インターフェイスの名前。

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

<comment>See Also:</comment>
   * ReflectionClass::isInterface
   * ReflectionClass::isSubclassOf
   * <strong>interface_exists()</strong>
   * オブジェクト インターフェイス


id: ReflectionClass::inNamespace
type: function
doc:
<comment>Description:</comment>
  名前空間内にあるかどうかを調べる
  
  このクラスが名前空間内で定義されているかどうかを調べます。

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

<comment>See Also:</comment>
   * ReflectionClass::getNamespaceName
   * PHP 名前空間


id: ReflectionClass::isAbstract
type: function
doc:
<comment>Description:</comment>
  抽象クラスであるかどうかを調べる
  
  抽象クラスであるかどうかを調べます。

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

<comment>See Also:</comment>
   * ReflectionClass::isInterface
   * クラスの抽象化


id: ReflectionClass::isAnonymous
type: function
doc:
<comment>Description:</comment>
  クラスが無名クラスかを調べる
  
  クラスが無名クラスかを調べます。

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

<comment>See Also:</comment>
   * ReflectionClass::isFinal


id: ReflectionClass::isCloneable
type: function
doc:
<comment>Description:</comment>
  このクラスがクローン可能かどうかを返す
  
  このクラスがクローン可能かどうかを返します。

<comment>Return:</comment>
  <info>bool</info>  このクラスがクローン可能である場合に <info>true</info>、そうでない場合に <info>false</info> を返します。


id: ReflectionClass::isEnum
type: function
doc:
<comment>Description:</comment>
  列挙型であるかどうかを返す
  
  このクラスが、列挙型(Enum) かどうかを調べます。

<comment>Return:</comment>
  <info>bool</info>  このクラスが 列挙型(Enum) の場合に <info>true</info> を返します。 そうでない場合、<info>false</info> を返します。


id: ReflectionClass::isFinal
type: function
doc:
<comment>Description:</comment>
  final クラスであるかどうかを調べる
  
  final クラスであるかどうかを調べます。

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

<comment>See Also:</comment>
   * ReflectionClass::isAbstract
   * Final キーワード


id: ReflectionClass::isInstance
type: function
doc:
<comment>Description:</comment>
  クラスのインスタンスであるかどうかを調べる
  
  あるオブジェクトがクラスのインスタンスであるかどうかを調べます。

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  比べたいオブジェクト。

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

<comment>See Also:</comment>
   * ReflectionClass::isInterface
   * 型演算子 (instanceof)
   * オブジェクト インターフェイス
   * <strong>is_a()</strong>


id: ReflectionClass::isInstantiable
type: function
doc:
<comment>Description:</comment>
  クラスのインスタンス化が可能であるかどうかを調べる
  
  クラスのインスタンス化が可能であるかどうかを調べます。

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

<comment>See Also:</comment>
   * ReflectionClass::isInstance


id: ReflectionClass::isInterface
type: function
doc:
<comment>Description:</comment>
  このクラスがインターフェイスであるかどうかを調べる
  
  このクラスがインターフェイスであるかどうかを調べます。

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

<comment>See Also:</comment>
   * ReflectionClass::isInstance


id: ReflectionClass::isInternal
type: function
doc:
<comment>Description:</comment>
  拡張モジュールあるいはコアで定義された内部クラスであるかどうかを調べる
  
  そのクラスが拡張モジュールやコアで定義された内部クラスである (ユーザーが定義したものではない) かど
  うかを調べます。

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

<comment>See Also:</comment>
   * ReflectionClass::isUserDefined


id: ReflectionClass::isIterable
type: function
doc:
<comment>Description:</comment>
  このクラスがイテレーション可能かを調べる
  
  このクラスがイテレーション可能か(つまり、foreach の内部で使えるか)を調べます。

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

<comment>See Also:</comment>
   * ReflectionClass::__construct


id: ReflectionClass::isIterateable
type: function
doc:
<comment>Description:</comment>
  のエイリアス ReflectionClass::isIterable
  
  のエイリアス ReflectionClass::isIterable
  
  PHP 7.2.0 以降は、スペルミスがある RefectionClass::isIterateable の代わりに、
  ReflectionClass::isIterable  を使うのが好ましいです。


id: ReflectionClass::isReadOnly
type: function
doc:
<comment>Description:</comment>
  クラスが readonly かを調べる
  
  クラスが readonly かどうかを調べます。

<comment>Return:</comment>
  <info>bool</info>  クラスが readonly の場合は <info>true</info> を返します。そうでない場合、<info>false</info> を返します。

<comment>See Also:</comment>
   * ReflectionClass::isAbstract
   * 読み取り専用クラス


id: ReflectionClass::isSubclassOf
type: function
doc:
<comment>Description:</comment>
  サブクラスであるかどうかを調べる
  
  指定したクラスを継承している、あるいは指定したインターフェイスを実装しているかどうかを調べます。

<comment>Param:</comment>
  <info>ReflectionClass|string</info>  <strong>$class</strong>  調べたいクラス名の <info>string</info> または、<info>ReflectionClass</info> のオブジェクト

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

<comment>See Also:</comment>
   * ReflectionClass::isInterface
   * ReflectionClass::implementsInterface
   * <strong>is_subclass_of()</strong>
   * <strong>get_parent_class()</strong>


id: ReflectionClass::isTrait
type: function
doc:
<comment>Description:</comment>
  トレイトであるかどうかを返す
  
  <info>ReflectionClass</info> が、トレイトを参照しているかを調べます。

<comment>Return:</comment>
  <info>bool</info>  これがトレイトである場合に <info>true</info>、そうでない場合に <info>false</info> を返します。


id: ReflectionClass::isUserDefined
type: function
doc:
<comment>Description:</comment>
  ユーザー定義であるかどうかを調べる
  
  そのクラスが (内部クラスではなく) ユーザーが定義したものであるかどうかを調べます。

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

<comment>See Also:</comment>
   * ReflectionClass::isInternal


id: ReflectionClass::newInstance
type: function
doc:
<comment>Description:</comment>
  指定した引数でクラスの新しいインスタンスを作成する
  
  クラスの新しいインスタンスを作成します。指定した引数をクラスのコンストラクタに渡します。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$args</strong>  可変長の引数を受け付け、それを <strong>call_user_func()</strong> と同じ方式でクラスのコンストラクタに
                渡します。

<comment>Return:</comment>
  <info>object</info>  

<comment>See Also:</comment>
   * ReflectionClass::newInstanceArgs
   * ReflectionClass::newInstanceWithoutConstructor


id: ReflectionClass::newInstanceArgs
type: function
doc:
<comment>Description:</comment>
  指定した引数でクラスの新しいインスタンスを作成する
  
  クラスの新しいインスタンスを作成します。指定した引数をクラスのコンストラクタに渡します。

<comment>Param:</comment>
  <info>array</info>  <strong>$args</strong>  クラスのコンストラクタに渡すパラメータを配列で指定します。

<comment>Return:</comment>
  <info>object|null</info>  クラスの新しいインスタンスを返します。 失敗した場合は <info>null</info> を返します。

<comment>See Also:</comment>
   * ReflectionClass::newInstance
   * ReflectionClass::newInstanceWithoutConstructor


id: ReflectionClass::newInstanceWithoutConstructor
type: function
doc:
<comment>Description:</comment>
  コンストラクタを起動せずに新しいクラスのインスタンスを作成する
  
  クラスの新しいインスタンスを、そのクラスのコンストラクタを実行せずに作成します。

<comment>Return:</comment>
  <info>object</info>  

<comment>See Also:</comment>
   * ReflectionClass::newInstance
   * ReflectionClass::newInstanceArgs


id: ReflectionClass::setStaticPropertyValue
type: function
doc:
<comment>Description:</comment>
  staticプロパティの値を設定する
  
  staticプロパティの値を設定します。

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>   プロパティの名前。
  <info>mixed</info>   <strong>$value</strong>  新しいプロパティの値。

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

<comment>See Also:</comment>
   * ReflectionClass::getStaticPropertyValue


id: ReflectionClassConstant::IS_PRIVATE
type: constant
doc:
<comment>Description:</comment>
  アクセス権が private であることを示します。 PHP 7.4.0 より前のバージョンでは、この値は <return>1024</return> でし
  た。


id: ReflectionClassConstant::IS_PROTECTED
type: constant
doc:
<comment>Description:</comment>
  アクセス権が protected であることを示します。 PHP 7.4.0 より前のバージョンでは、この値は <return>512</return> でし
  た。


id: ReflectionClassConstant::IS_PUBLIC
type: constant
doc:
<comment>Description:</comment>
  アクセス権が public であることを示します。 PHP 7.4.0 より前のバージョンでは、この値は <return>256</return> でした。


id: ReflectionClassConstant::__construct
type: function
doc:
<comment>Description:</comment>
  ReflectionClassConstant を構築する
  
  新しい <class>ReflectionClassConstant</class> を構築します。

<comment>Param:</comment>
  <info>object|string</info>  <strong>$class</strong>     リフレクションするクラス名を含んだ文字列か、<info>object</info>
  <info>string</info>         <strong>$constant</strong>  クラス定数の名前

<comment>See Also:</comment>
   * Constructors


id: ReflectionClassConstant::__toString
type: function
doc:
<comment>Description:</comment>
  ReflectionClassConstant オブジェクトの文字列表現を返す
  
  ReflectionClassConstant オブジェクトの文字列表現を返します。

<comment>Return:</comment>
  <info>string</info>  この <class>ReflectionClassConstant</class> インスタンスの文字列表現を返します。

<comment>See Also:</comment>
   * ReflectionClassConstant::export
   * __toString()


id: ReflectionClassConstant::export
type: function
doc:
<comment>Description:</comment>
  リフレクションをエクスポートする
  
  リフレクションをエクスポートします。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>mixed</info>   <strong>$class</strong>   エクスポートするリフレクション。
  <info>string</info>  <strong>$name</strong>    クラス定数の名前
  <info>bool</info>    <strong>$return</strong>  <info>true</info> に設定すると、エクスポートを発行するのではなく返します。
                   <info>false</info> (デフォルト) の場合はその逆です。

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

<comment>See Also:</comment>
   * ReflectionClassConstant::__toString


id: ReflectionClassConstant::getAttributes
type: function
doc:
<comment>Description:</comment>
  アトリビュートを取得する
  
  このクラス定数上で宣言されている全てのアトリビュートを <info>ReflectionAttribute</info> の配列として返します。

<comment>Param:</comment>
  <info>string|null</info>  <strong>$name</strong>   指定したクラス名にマッチするアトリビュートの、 <class>ReflectionAttribute</class> のみを含む
                       ようにフィルタします。
  <info>int</info>          <strong>$flags</strong>  <strong>$name</strong> が指定されていた場合に、 結果をどうフィルタするかを決めるフラグ。
                       
                       デフォルトは <return>0</return> です。 この場合、アトリビュートのクラス名が <strong>$name</strong> であるものだ
                       けを返します。
                       
                       他の利用可能なオプションは、 <info>ReflectionAttribute::IS_INSTANCEOF</info> です。 この場
                       合、フィルタリングに <return>instanceof</return> を使います。

<comment>Return:</comment>
  <info>array</info>  アトリビュートの配列を、 <class>ReflectionAttribute</class> オブジェクトの配列として返します。

<comment>See Also:</comment>
   * ReflectionClass::getAttributes
   * ReflectionFunctionAbstract::getAttributes
   * ReflectionParameter::getAttributes
   * ReflectionProperty::getAttributes


id: ReflectionClassConstant::getDeclaringClass
type: function
doc:
<comment>Description:</comment>
  定数を宣言しているクラスを取得する
  
  定数を宣言しているクラスを取得します。

<comment>Return:</comment>
  <info>ReflectionClass</info>  <class>ReflectionClass</class> オブジェクトを返します。


id: ReflectionClassConstant::getDocComment
type: function
doc:
<comment>Description:</comment>
  クラス定数のドキュメントコメントを取得する
  
  クラス定数のドキュメントコメントを取得します。

<comment>Return:</comment>
  <info>string|false</info>  ドキュメントコメントが存在した場合その文字列。存在しない場合は <info>false</info> を返します。


id: ReflectionClassConstant::getModifiers
type: function
doc:
<comment>Description:</comment>
  クラス定数の修飾子を取得する
  
  クラス定数のアクセス修飾子のビットフィールドを返します。

<comment>Return:</comment>
  <info>int</info>  アクセス修飾子の数値表現を返します。 これらの修飾子の実際の意味は、 定義済みの定数 で説明して
       います。

<comment>See Also:</comment>
   * Reflection::getModifierNames


id: ReflectionClassConstant::getName
type: function
doc:
<comment>Description:</comment>
  定数名を取得する

<comment>Return:</comment>
  <info>string</info>  定数の名前を返します。


id: ReflectionClassConstant::getValue
type: function
doc:
<comment>Description:</comment>
  値を取得する
  
  クラス定数の値を取得します。

<comment>Return:</comment>
  <info>mixed</info>  クラス定数の値を返します。


id: ReflectionClassConstant::isEnumCase
type: function
doc:
<comment>Description:</comment>
  クラス定数が、列挙型の case かどうかを調べる
  
  クラス定数が、列挙型 の case かどうかを調べます。

<comment>Return:</comment>
  <info>bool</info>  クラス定数が、列挙型の case である場合に <info>true</info> を返します。 そうでない場合、<info>false</info> を返しま
        す。

<comment>See Also:</comment>
   * <class>ReflectionEnum</class>


id: ReflectionClassConstant::isFinal
type: function
doc:
<comment>Description:</comment>
  クラス定数が final かどうかを調べる
  
  クラス定数が final かどうかを調べます。

<comment>Return:</comment>
  <info>bool</info>  クラス定数が final の場合、<info>true</info> を返します。 そうでない場合、<info>false</info> を返します。

<comment>See Also:</comment>
   * ReflectionClassConstant::isPublic
   * ReflectionClassConstant::isPrivate
   * ReflectionClassConstant::isProtected


id: ReflectionClassConstant::isPrivate
type: function
doc:
<comment>Description:</comment>
  クラス定数がprivateかを調べる
  
  クラス定数がprivateかを調べます。

<comment>Return:</comment>
  <info>bool</info>  クラス定数が private なら <info>true</info> を返します。 そうでないなら <info>false</info> を返します。

<comment>See Also:</comment>
   * ReflectionClassConstant::isFinal
   * ReflectionClassConstant::isPublic
   * ReflectionClassConstant::isProtected


id: ReflectionClassConstant::isProtected
type: function
doc:
<comment>Description:</comment>
  クラス定数が protected かを調べる
  
  クラス定数が protected かを調べます。

<comment>Return:</comment>
  <info>bool</info>  クラス定数が protected なら <info>true</info> を返します。 そうでなければ <info>false</info> を返します。

<comment>See Also:</comment>
   * ReflectionClassConstant::isFinal
   * ReflectionClassConstant::isPublic
   * ReflectionClassConstant::isPrivate


id: ReflectionClassConstant::isPublic
type: function
doc:
<comment>Description:</comment>
  クラス定数が public かを調べる
  
  クラス定数が public かを調べます。

<comment>Return:</comment>
  <info>bool</info>  クラス定数が public なら <info>true</info> を返します。 そうでないなら、<info>false</info> を返します。

<comment>See Also:</comment>
   * ReflectionClassConstant::isFinal
   * ReflectionClassConstant::isPrivate
   * ReflectionClassConstant::isProtected


id: ReflectionEnum::__construct
type: function
doc:
<comment>Description:</comment>
  ReflectionEnum オブジェクトをインスタンス化する

<comment>Param:</comment>
  <info>object|string</info>  <strong>$objectOrClass</strong>  列挙型のインスタンス、またはその名前。


id: ReflectionEnum::getBackingType
type: function
doc:
<comment>Description:</comment>
  存在する場合に、列挙型が依存する型を取得する
  
  列挙型が Backed Enum の場合、 このメソッドは 列挙型が依存する型を <class>ReflectionType</class> のインスタンスと
  して返します。 Backed Enum でない場合は、<info>null</info> を返します。

<comment>Return:</comment>
  <info>ReflectionNamedType|null</info>  列挙型が依存する型を <class>ReflectionNamedType</class> として返します。依存する型がな
                            い場合は、<info>null</info> を返します。

<comment>See Also:</comment>
   * 列挙型(Enum)
   * ReflectionEnum::isBacked


id: ReflectionEnum::getCase
type: function
doc:
<comment>Description:</comment>
  列挙型の特定の case を返す
  
  列挙型の特定の case を名前で指定すると、 リフレクションオブジェクトを返します。 指定された case が
  定義されていない場合、 <class>ReflectionException</class> がスローされます。

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  取得する case の名前。

<comment>Return:</comment>
  <info>ReflectionEnumUnitCase</info>  <class>ReflectionEnumUnitCase</class> または <class>ReflectionEnumBackedCase</class> のインスタンスを適
                          切に返します。

<comment>See Also:</comment>
   * 列挙型(Enum)
   * ReflectionEnum::getCases
   * ReflectionEnum::hasCase
   * ReflectionEnum::isBacked


id: ReflectionEnum::getCases
type: function
doc:
<comment>Description:</comment>
  列挙型の全ての case を返す
  
  列挙型には、ひとつ以上の case を含めることができます。 このメソッドは、定義済みの全ての case を字
  句解析順 (つまり、ソースコードに現れる順) に取得します。

<comment>Return:</comment>
  <info>array</info>  列挙型のリフレクションオブジェクトの配列を返します。 ひとつひとつが、列挙型の case を表しま
         す。 Pure Enum の場合、すべてのインスタンスが <class>ReflectionEnumUnitCase</class> になります。 Backed
         Enum の場合、すべてのインスタンスが <class>ReflectionEnumBackedCase</class> になります。

<comment>See Also:</comment>
   * 列挙型(Enum)
   * ReflectionEnum::getCase
   * ReflectionEnum::isBacked


id: ReflectionEnum::hasCase
type: function
doc:
<comment>Description:</comment>
  列挙型が case を持つかを調べる
  
  指定された case が列挙型に定義されているかを判定します。

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  調べる case の名前。

<comment>Return:</comment>
  <info>bool</info>  case が定義されていたら <info>true</info> を返します。 そうでない場合、<info>false</info> を返します。

<comment>See Also:</comment>
   * 列挙型(Enum)
   * ReflectionEnum::getCase
   * ReflectionEnum::getCases


id: ReflectionEnum::isBacked
type: function
doc:
<comment>Description:</comment>
  列挙型が Backed Enum かを調べる
  
  Backed Enum は、 ネイティブのスカラー型と同等の情報を持つ列挙型です。 文字列か、整数のどちらかで
  す。 全ての列挙型が Backed Enum であるとは限りません。

<comment>Return:</comment>
  <info>bool</info>  列挙型がスカラーと同等の Backed Enum の場合は <info>true</info> を返します。 そうでない場合は、<info>false</info> を返
        します。

<comment>See Also:</comment>
   * 列挙型(Enum)
   * ReflectionEnum::getBackingType


id: ReflectionEnumBackedCase
type: class
doc:
<comment>Description:</comment>
  <class>ReflectionEnumBackedCase</class> クラスは、 Backed Enum の case に関する情報を報告します。 これは、スカ
  ラー型の情報を持っています。


id: ReflectionEnumBackedCase::__construct
type: function
doc:
<comment>Description:</comment>
  ReflectionEnumBackedCase オブジェクトをインスタンス化する

<comment>Param:</comment>
  <info>object|string</info>  <strong>$class</strong>     列挙型のインスタンス、またはその名前。
  <info>string</info>         <strong>$constant</strong>  列挙型の定数名。


id: ReflectionEnumBackedCase::getBackingValue
type: function
doc:
<comment>Description:</comment>
  Backed Enum の case が持つスカラー値を取得する
  
  Backed Enum の case が持つスカラー値を取得します。

<comment>Return:</comment>
  <info>int|string</info>  この列挙型の case が持つスカラーの値を返します。

<comment>See Also:</comment>
   * 列挙型(Enum)


id: ReflectionEnumUnitCase
type: class
doc:
<comment>Description:</comment>
  <class>ReflectionEnumUnitCase</class> クラスは、 列挙型 の case に関する情報を報告します。 これは、スカラー型の情
  報を持っていません。


id: ReflectionEnumUnitCase::__construct
type: function
doc:
<comment>Description:</comment>
  ReflectionEnumUnitCase オブジェクトをインスタンス化する

<comment>Param:</comment>
  <info>object|string</info>  <strong>$class</strong>     列挙型のインスタンス、またはその名前。
  <info>string</info>         <strong>$constant</strong>  列挙型の定数名。


id: ReflectionEnumUnitCase::getEnum
type: function
doc:
<comment>Description:</comment>
  この case が属するリフレクションオブジェクトを取得する
  
  この case が属するリフレクションオブジェクトを取得します。

<comment>Return:</comment>
  <info>ReflectionEnum</info>  この case が属する列挙型を示す <class>ReflectionEnum</class> のインスタンスを返します。

<comment>See Also:</comment>
   * 列挙型(Enum)


id: ReflectionEnumUnitCase::getValue
type: function
doc:
<comment>Description:</comment>
  このリフレクションオブジェクトが表す case オブジェクトを取得する
  
  このリフレクションオブジェクトが表す 列挙型の case オブジェクトを返します。

<comment>Return:</comment>
  <info>UnitEnum</info>  このリフレクションオブジェクトが表す 列挙型の case オブジェクトを返します。

<comment>See Also:</comment>
   * 列挙型(Enum)


id: ReflectionExtension::__clone
type: function
doc:
<comment>Description:</comment>
  クローンする
  
  このメソッドは、オブジェクトをクローンさせないようにします。 Reflection オブジェクトはクローンする
  ことができません。

<comment>Return:</comment>
  <info>void</info>  値は返しません。もしコールされれば致命的なエラーとなります。

<comment>See Also:</comment>
   * ReflectionExtension::__construct
   * オブジェクトのクローン作成


id: ReflectionExtension::__construct
type: function
doc:
<comment>Description:</comment>
  ReflectionExtension を作成する
  
  <class>ReflectionExtension</class> オブジェクトを作成します。

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  拡張モジュールの名前。

<comment>See Also:</comment>
   * ReflectionExtension::info
   * コンストラクタ


id: ReflectionExtension::__toString
type: function
doc:
<comment>Description:</comment>
  文字列に変換する
  
  調べた拡張モジュールをエクスポートし、文字列として返します。 これは、ReflectionExtension::export
  のパラメータ <strong>$return</strong> を <info>true</info> に設定するのと同じ意味です。

<comment>Return:</comment>
  <info>string</info>  エクスポートした拡張モジュールを文字列で返します。 ReflectionExtension::export と同じ形式
          となります。

<comment>See Also:</comment>
   * ReflectionExtension::__construct
   * ReflectionExtension::export
   * __toString()


id: ReflectionExtension::export
type: function
doc:
<comment>Description:</comment>
  エクスポートする
  
  拡張モジュールの情報をエクスポートします。この関数の出力フォーマットは CLI で引数 <return>--re [extension]</return>
  を指定したときのものと同じです。

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>    エクスポートするリフレクション。
  <info>string</info>  <strong>$return</strong>  <info>true</info> に設定すると、エクスポートを発行するのではなく返します。
                   <info>false</info> (デフォルト) の場合はその逆です。

<comment>Return:</comment>
  <info>string</info>  <strong>$return</strong> パラメータを
          <info>true</info> に設定すると、エクスポートを文字列で返します。それ以外の場合は
          <info>null</info> を返します。

<comment>See Also:</comment>
   * ReflectionExtension::info
   * ReflectionExtension::__toString


id: ReflectionExtension::getClassNames
type: function
doc:
<comment>Description:</comment>
  クラス名を取得する
  
  拡張モジュールで定義されているのクラス名の一覧を取得します。

<comment>Return:</comment>
  <info>array</info>  拡張モジュールで定義されているクラス名の配列を返します。 クラスが定義されていない場合は空の
         配列を返します。

<comment>See Also:</comment>
   * ReflectionExtension::getClasses
   * ReflectionExtension::getName


id: ReflectionExtension::getClasses
type: function
doc:
<comment>Description:</comment>
  クラスを取得する
  
  拡張モジュールのクラス一覧を取得します。

<comment>Return:</comment>
  <info>array</info>  <class>ReflectionClass</class> オブジェクトの配列を返します。 各要素が、拡張モジュール内のクラスを表しま
         す。 クラスが定義されていない場合は空の配列を返します。

<comment>See Also:</comment>
   * ReflectionExtension::getClassNames


id: ReflectionExtension::getConstants
type: function
doc:
<comment>Description:</comment>
  定数を取得する
  
  拡張モジュールで定義されている定数を取得します。

<comment>Return:</comment>
  <info>array</info>  定数名をキーとする連想配列を返します。

<comment>See Also:</comment>
   * ReflectionExtension::getINIEntries


id: ReflectionExtension::getDependencies
type: function
doc:
<comment>Description:</comment>
  依存性を取得する
  
  必須の依存性、衝突する依存性の両方を取得します。

<comment>Return:</comment>
  <info>array</info>  依存する拡張モジュールをキー、そして <return>Required</return>、<return>Optional</return> あるいは <return>Conflicts</return> のいずれかを値と
         する連想配列を返します。

<comment>See Also:</comment>
   * ReflectionClass::getVersion


id: ReflectionExtension::getFunctions
type: function
doc:
<comment>Description:</comment>
  拡張モジュールの関数を取得する
  
  拡張モジュールで定義されている関数を取得します。

<comment>Return:</comment>
  <info>array</info>  <class>ReflectionFunction</class> オブジェクトの連想配列を返します。 拡張モジュール内で定義されている関数
         名がキーとなります。 関数が定義されていない場合は空の配列を返します。

<comment>See Also:</comment>
   * ReflectionExtension::getClasses
   * <strong>get_extension_funcs()</strong>


id: ReflectionExtension::getINIEntries
type: function
doc:
<comment>Description:</comment>
  拡張モジュールの ini エントリを取得する
  
  拡張モジュールの ini エントリを取得します。

<comment>Return:</comment>
  <info>array</info>  ini エントリをキー、定義されている値をキーに対応する値とした連想配列を返します。

<comment>See Also:</comment>
   * <strong>ini_get_all()</strong>
   * ReflectionExtension::getConstants


id: ReflectionExtension::getName
type: function
doc:
<comment>Description:</comment>
  拡張モジュール名を取得する
  
  拡張モジュールの名前を取得します。

<comment>Return:</comment>
  <info>string</info>  拡張モジュールの名前を返します。

<comment>See Also:</comment>
   * ReflectionExtension::getClassNames


id: ReflectionExtension::getVersion
type: function
doc:
<comment>Description:</comment>
  拡張モジュールのバージョンを取得する
  
  拡張モジュールのバージョンを取得します。

<comment>Return:</comment>
  <info>string|null</info>  拡張モジュールのバージョンを返します。 バージョン情報がない場合は、<info>null</info> を返します。

<comment>See Also:</comment>
   * ReflectionExtension::info


id: ReflectionExtension::info
type: function
doc:
<comment>Description:</comment>
  拡張モジュールの情報を表示する
  
  指定した拡張モジュールに関する "<strong>phpinfo()</strong>" の情報を表示します。

<comment>Return:</comment>
  <info>void</info>  拡張モジュールの情報を返します。

<comment>See Also:</comment>
   * ReflectionExtension::getName
   * <strong>phpinfo()</strong>


id: ReflectionExtension::isPersistent
type: function
doc:
<comment>Description:</comment>
  この拡張モジュールが永続性のあるものかどうかを返す
  
  この拡張モジュールが永続性のあるものかどうかを調べます。
  
  php.ini を使って読み込まれている場合、拡張機能は永続性があります。 <strong>dl()</strong> を使って読み込まれている場
  合、拡張機能は一時的なもので、永続性はありません。

<comment>Return:</comment>
  <info>bool</info>  この拡張モジュールが <return>extension</return> で読み込まれたものである場合に <info>true</info>、そうでない場合に <info>false</info>
        を返します。

<comment>See Also:</comment>
   * ReflectionExtension::isTemporary


id: ReflectionExtension::isTemporary
type: function
doc:
<comment>Description:</comment>
  この拡張モジュールが一時的なものかどうかを返す
  
  この拡張モジュールが一時的なものかどうかを調べます。
  
  <strong>dl()</strong> を使って読み込まれている場合、 拡張モジュールは一時的なものです。

<comment>Return:</comment>
  <info>bool</info>  この拡張モジュールが <strong>dl()</strong> で読み込まれたものである場合に <info>true</info>、 そうでない場合に <info>false</info> を返
        します。

<comment>See Also:</comment>
   * ReflectionExtension::isPersistent


id: ReflectionFiber::__construct
type: function
doc:
<comment>Description:</comment>
  Constructs a ReflectionFiber オブジェクトを構築する
  
  <class>ReflectionFiber</class> オブジェクトを構築します。

<comment>Param:</comment>
  <info>Fiber</info>  <strong>$fiber</strong>  リフレクションする <class>Fiber</class> オブジェクト。


id: ReflectionFiber::getCallable
type: function
doc:
<comment>Description:</comment>
  Fiber の構築に使われた callable を取得する
  
  <class>Fiber</class> の構築に使われた callable を返します。 Fiber が既に終了している場合、 <class>Error</class> がスローされま
  す。

<comment>Return:</comment>
  <info>callable</info>  <class>Fiber</class> の構築に使われた callable を返します。


id: ReflectionFiber::getExecutingFile
type: function
doc:
<comment>Description:</comment>
  現在実行中のファイル名を取得する
  
  リフレクションされた <class>Fiber</class> が実行しているファイル名のフルパスを返します。 Fiber が開始していない
  か、既に終了している場合、 <class>Error</class> がスローされます。

<comment>Return:</comment>
  <info>string</info>  リフレクションされた Fiber が実行しているファイル名のフルパスを返します。


id: ReflectionFiber::getExecutingLine
type: function
doc:
<comment>Description:</comment>
  現在実行中の行番号を取得する
  
  リフレクションされた <class>Fiber</class> が現在実行している行番号を返します。 Fiber が開始していないか、既に終了
  している場合、 <class>Error</class> がスローされます。

<comment>Return:</comment>
  <info>int</info>  Fiber が現在実行している行番号を返します。


id: ReflectionFiber::getFiber
type: function
doc:
<comment>Description:</comment>
  リフレクションされた Fiber クラスのインスタンスを取得する
  
  リフレクションされた <class>Fiber</class> クラスのインスタンスを返します。

<comment>Return:</comment>
  <info>Fiber</info>  リフレクションされた <class>Fiber</class> クラスのインスタンスを返します。


id: ReflectionFiber::getTrace
type: function
doc:
<comment>Description:</comment>
  現在実行している時点のバックトレースを取得する
  
  リフレクションされた <class>Fiber</class> で、 現在実行している時点のバックトレースを取得します。

<comment>Param:</comment>
  <info>int</info>  <strong>$options</strong>  <strong>$options</strong> の値には、以下のフラグが指定できます。
                 
                 利用可能なオプションオプション説明<info>DEBUG_BACKTRACE_PROVIDE_OBJECT</info> これがデフォルトの
                 値です。 <info>DEBUG_BACKTRACE_IGNORE_ARGS</info> スタックトレースに、関数の引数に関する情報を含
                 めない。

<comment>Return:</comment>
  <info>array</info>  Fiber で、現在実行している時点のバックトレースを返します。


id: ReflectionFunction::__construct
type: function
doc:
<comment>Description:</comment>
  ReflectionFunction オブジェクトを作成する
  
  <class>ReflectionFunction</class> オブジェクトを作成します。

<comment>Param:</comment>
  <info>Closure|string</info>  <strong>$function</strong>  調べたい関数あるいはクロージャの名前。

<comment>See Also:</comment>
   * ReflectionMethod::__construct
   * コンストラクタ


id: ReflectionFunction::__toString
type: function
doc:
<comment>Description:</comment>
  ReflectionFunction を表現する文字列を返す
  
  関数を表現した、人間が読める説明を取得します。 パラメータと戻り値が含まれます。

<comment>Return:</comment>
  <info>string</info>  文字列を返します。

<comment>See Also:</comment>
   * ReflectionFunction::export
   * __toString()


id: ReflectionFunction::export
type: function
doc:
<comment>Description:</comment>
  関数をエクスポートする
  
  調べた関数をエクスポートします。

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>    エクスポートするリフレクション。
  <info>string</info>  <strong>$return</strong>  <info>true</info> に設定すると、エクスポートを発行するのではなく返します。
                   <info>false</info> (デフォルト) の場合はその逆です。

<comment>Return:</comment>
  <info>string</info>  <strong>$return</strong> パラメータを
          <info>true</info> に設定すると、エクスポートを文字列で返します。それ以外の場合は
          <info>null</info> を返します。

<comment>See Also:</comment>
   * ReflectionFunction::invoke
   * ReflectionFunction::__toString


id: ReflectionFunction::getClosure
type: function
doc:
<comment>Description:</comment>
  この関数に動的に作成されたクロージャを返す
  
  この関数に動的に作成されたクロージャを取得します。

<comment>Return:</comment>
  <info>Closure</info>  新しく作成された <class>Closure</class> を返します。

<comment>See Also:</comment>
   * 第一級callableを生成する記法


id: ReflectionFunction::invoke
type: function
doc:
<comment>Description:</comment>
  関数を起動する
  
  調べた関数を起動します。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$args</strong>  渡す引数のリスト。可変長の引数を指定でき、 <strong>call_user_func()</strong> と同じようにして関数に渡
                されます。

<comment>Return:</comment>
  <info>mixed</info>  起動した関数の結果を返します。

<comment>See Also:</comment>
   * ReflectionFunction::export
   * __invoke()
   * <strong>call_user_func()</strong>


id: ReflectionFunction::invokeArgs
type: function
doc:
<comment>Description:</comment>
  引数を指定して関数を起動する
  
  関数を起動して、その引数を配列として渡します。

<comment>Param:</comment>
  <info>array</info>  <strong>$args</strong>  関数に渡す引数を含む配列。 <strong>call_user_func_array()</strong> と同じように動作します。

<comment>Return:</comment>
  <info>mixed</info>  起動した関数の結果を返します。

<comment>See Also:</comment>
   * ReflectionFunction::invoke
   * ReflectionFunctionAbstract::getNumberOfParameters
   * __invoke()
   * <strong>call_user_func_array()</strong>


id: ReflectionFunction::isAnonymous
type: function
doc:
<comment>Description:</comment>
  関数が無名関数かどうかを調べる
  
  関数が 無名関数 かどうかを調べます。

<comment>Return:</comment>
  <info>bool</info>  関数が無名関数の場合、<info>true</info> を返します。そうでない場合、<info>false</info> を返します。

<comment>See Also:</comment>
   * 無名関数


id: ReflectionFunction::isDisabled
type: function
doc:
<comment>Description:</comment>
  関数が無効になっているかどうかを調べる
  
  disable_functions ディレクティブで関数が無効になっているかどうかを調べます。

<comment>Return:</comment>
  <info>bool</info>  無効になっている場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * ReflectionFunctionAbstract::isUserDefined
   * disable_functions ディレクティブ


id: ReflectionFunctionAbstract::__clone
type: function
doc:
<comment>Description:</comment>
  関数のクローンを作成する
  
  関数のクローンを作成します。

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

<comment>See Also:</comment>
   * オブジェクトのクローン作成


id: ReflectionFunctionAbstract::__toString
type: function
doc:
<comment>Description:</comment>
  ReflectionFunctionAbstract を表現する文字列を返す
  
  関数を表現した、人間が読める説明を取得します。 パラメータと戻り値が含まれます。

<comment>Return:</comment>
  <info>void</info>  文字列を返します。

<comment>See Also:</comment>
   * ReflectionFunction::__toString
   * ReflectionMethod::__toString
   * __toString()


id: ReflectionFunctionAbstract::getAttributes
type: function
doc:
<comment>Description:</comment>
  アトリビュートを取得する
  
  この関数で宣言されている全てのアトリビュートを、 <info>ReflectionAttribute</info> として返します。

<comment>Param:</comment>
  <info>string|null</info>  <strong>$name</strong>   指定したクラス名にマッチするアトリビュートの、 <class>ReflectionAttribute</class> のみを含む
                       ようにフィルタします。
  <info>int</info>          <strong>$flags</strong>  <strong>$name</strong> が指定されていた場合に、 結果をどうフィルタするかを決めるフラグ。
                       
                       デフォルトは <return>0</return> です。 この場合、アトリビュートのクラス名が <strong>$name</strong> であるものだ
                       けを返します。
                       
                       他の利用可能なオプションは、 <info>ReflectionAttribute::IS_INSTANCEOF</info> です。 この場
                       合、フィルタリングに <return>instanceof</return> を使います。

<comment>Return:</comment>
  <info>array</info>  アトリビュートの配列を、 <class>ReflectionAttribute</class> オブジェクトの配列として返します。

<comment>See Also:</comment>
   * ReflectionClass::getAttributes
   * ReflectionClassConstant::getAttributes
   * ReflectionParameter::getAttributes
   * ReflectionProperty::getAttributes


id: ReflectionFunctionAbstract::getClosureScopeClass
type: function
doc:
<comment>Description:</comment>
  クロージャに関連づけられたスコープクラスを返す
  
  クロージャの宣言を囲んだクラスを取得します。

<comment>Return:</comment>
  <info>ReflectionClass|null</info>  成功した場合にクラスを返します。 関数がクロージャでなかったり、クラスで囲ま
                        れていない場合は <info>null</info> を返します。


id: ReflectionFunctionAbstract::getClosureThis
type: function
doc:
<comment>Description:</comment>
  クロージャにバインドした this ポインタを返す
  
  関数が static でないクロージャの場合に、 クロージャ内部で $this にバインドされたオブジェクト所得し
  ます。

<comment>Return:</comment>
  <info>object|null</info>  $this ポインタを返します。 エラー時には <info>null</info> を返します。


id: ReflectionFunctionAbstract::getClosureUsedVariables
type: function
doc:
<comment>Description:</comment>
  クロージャ内で使われている変数の配列を返す
  
  <class>Closure</class> の中で内で使われている変数の配列を返します。

<comment>Return:</comment>
  <info>array</info>  <class>Closure</class> の中で内で使われている変数の配列を返します。

<comment>See Also:</comment>
   * <strong>ReflectionFunctionAbstract::getClosureScopeClass()</strong>
   * <strong>ReflectionFunctionAbstract::getClosureThis()</strong>


id: ReflectionFunctionAbstract::getDocComment
type: function
doc:
<comment>Description:</comment>
  ドキュメントコメントを取得する
  
  関数のドキュメントコメントを取得します。

<comment>Return:</comment>
  <info>string|false</info>  ドキュメントコメントが存在する場合はそれを返します。それ以外の場合は <info>false</info> を返しま
                す。

<comment>See Also:</comment>
   * ReflectionFunctionAbstract::getStartLine


id: ReflectionFunctionAbstract::getEndLine
type: function
doc:
<comment>Description:</comment>
  終了行番号を取得する
  
  終了行番号を取得します。

<comment>Return:</comment>
  <info>int|false</info>  ユーザー定義関数の終了行番号を返します。不明な場合は <info>false</info> を返します。

<comment>See Also:</comment>
   * ReflectionFunctionAbstract::getStartLine


id: ReflectionFunctionAbstract::getExtension
type: function
doc:
<comment>Description:</comment>
  拡張モジュールの情報を取得する
  
  関数の拡張モジュール情報を取得します。

<comment>Return:</comment>
  <info>ReflectionExtension|null</info>  拡張モジュールの情報を <class>ReflectionExtension</class> オブジェクトで返します。 ユー
                            ザー定義の関数の場合は、<info>null</info> を返します。

<comment>See Also:</comment>
   * ReflectionFunctionAbstract::getExtensionName


id: ReflectionFunctionAbstract::getExtensionName
type: function
doc:
<comment>Description:</comment>
  拡張モジュールの名前を取得する
  
  拡張モジュールの名前を取得します。

<comment>Return:</comment>
  <info>string|false</info>  拡張モジュールの名前を返します。 ユーザー定義の関数の場合は、<info>false</info> を返します。

<comment>See Also:</comment>
   * ReflectionFunctionAbstract::getExtension


id: ReflectionFunctionAbstract::getFileName
type: function
doc:
<comment>Description:</comment>
  ファイル名を取得する
  
  ユーザー定義関数のファイル名を取得します。

<comment>Return:</comment>
  <info>string|false</info>  関数が定義されたファイル名を返します。 PHP コアや拡張モジュールで定義されていた場合
                は、<info>false</info> を返します。

<comment>See Also:</comment>
   * ReflectionFunctionAbstract::getNamespaceName


id: ReflectionFunctionAbstract::getName
type: function
doc:
<comment>Description:</comment>
  関数名を取得する
  
  関数の名前を取得します。

<comment>Return:</comment>
  <info>string</info>  関数の名前を返します。

<comment>See Also:</comment>
   * ReflectionFunctionAbstract::getExtensionName
   * ReflectionFunctionAbstract::isUserDefined


id: ReflectionFunctionAbstract::getNamespaceName
type: function
doc:
<comment>Description:</comment>
  名前空間名を取得する
  
  クラスが定義されている名前空間の名前を取得します。

<comment>Return:</comment>
  <info>string</info>  名前空間名を返します。

<comment>See Also:</comment>
   * ReflectionFunctionAbstract::getFileName
   * 名前空間


id: ReflectionFunctionAbstract::getNumberOfParameters
type: function
doc:
<comment>Description:</comment>
  パラメータ数を取得する
  
  関数で定義されているパラメータの数を、必須と任意の両方を含めて取得します。

<comment>Return:</comment>
  <info>int</info>  パラメータの数を返します。

<comment>See Also:</comment>
   * ReflectionFunctionAbstract::getNumberOfRequiredParameters
   * <strong>func_num_args()</strong>


id: ReflectionFunctionAbstract::getNumberOfRequiredParameters
type: function
doc:
<comment>Description:</comment>
  必須パラメータの数を取得する
  
  関数で定義されている必須パラメータの数を取得します。

<comment>Return:</comment>
  <info>int</info>  必須パラメータの数を返します。

<comment>See Also:</comment>
   * ReflectionFunctionAbstract::getNumberOfParameters


id: ReflectionFunctionAbstract::getParameters
type: function
doc:
<comment>Description:</comment>
  パラメータを取得する
  
  パラメータをソースコードで定義された順に <info>ReflectionParameter</info> の配列で取得します。

<comment>Return:</comment>
  <info>array</info>  パラメータを <class>ReflectionParameter</class> オブジェクトの配列で返します。

<comment>See Also:</comment>
   * ReflectionFunctionAbstract::getNumberOfParameters
   * <strong>func_get_args()</strong>


id: ReflectionFunctionAbstract::getReturnType
type: function
doc:
<comment>Description:</comment>
  指定された関数の戻り値の型を取得する
  
  指定されたリフレクションされた関数の戻り値の型を取得します。

<comment>Return:</comment>
  <info>ReflectionType|null</info>  戻り値の型が指定されていた場合は <class>ReflectionType</class> オブジェクトを返します。 指定
                       されていない場合は <info>null</info> を返します。

<comment>See Also:</comment>
   * ReflectionFunctionAbstract::hasReturnType
   * ReflectionType::__toString


id: ReflectionFunctionAbstract::getShortName
type: function
doc:
<comment>Description:</comment>
  関数の短い名前を取得する
  
  関数の短い名前 (名前空間部分を除いた名前) を取得します。

<comment>Return:</comment>
  <info>string</info>  関数の短い名前を返します。

<comment>See Also:</comment>
   * ReflectionFunctionAbstract::getNamespaceName
   * 名前空間


id: ReflectionFunctionAbstract::getStartLine
type: function
doc:
<comment>Description:</comment>
  開始行番号を取得する
  
  関数の開始行番号を取得します。

<comment>Return:</comment>
  <info>int|false</info>  開始行番号を返します。 開始行が不明な場合は、<info>false</info> を返します。

<comment>See Also:</comment>
   * ReflectionFunctionAbstract::getEndLine


id: ReflectionFunctionAbstract::getStaticVariables
type: function
doc:
<comment>Description:</comment>
  static変数を取得する
  
  static変数を取得します。

<comment>Return:</comment>
  <info>array</info>  static変数の配列を返します。

<comment>See Also:</comment>
   * ReflectionFunctionAbstract::getParameters


id: ReflectionFunctionAbstract::getTentativeReturnType
type: function
doc:
<comment>Description:</comment>
  関数に関連付けられた仮の戻り値の型を返す
  
  関数に関連付けられた仮の戻り値の型を返します。

<comment>Return:</comment>
  <info>ReflectionType|null</info>  仮の戻り値の型が指定されている場合は <class>ReflectionType</class> オブジェクトを返します。
                       そうでない場合は、<info>null</info> を返します。

<comment>See Also:</comment>
   * ReflectionFunctionAbstract::getReturnType
   * ReflectionFunctionAbstract::hasTentativeReturnType
   * 内部クラスと戻り値の型の互換性


id: ReflectionFunctionAbstract::hasReturnType
type: function
doc:
<comment>Description:</comment>
  関数が戻り値の型を指定しているかを調べる
  
  リフレクションされた関数が、戻り値の型を指定しているかを調べます

<comment>Return:</comment>
  <info>bool</info>  関数が戻り値の型を指定しているなら <info>true</info> を返します。 指定していないなら <info>false</info> を返します。

<comment>See Also:</comment>
   * ReflectionFunctionAbstract::getReturnType


id: ReflectionFunctionAbstract::hasTentativeReturnType
type: function
doc:
<comment>Description:</comment>
  戻り値の型を仮で宣言しているかを返す
  
  関数が戻り値の型を仮で(とりあえず)宣言しているかどうかを返します。

<comment>Return:</comment>
  <info>bool</info>  関数が仮の(とりあえず)戻り値の型を持つ場合、<info>true</info> を返します。 そうでない場合、<info>false</info> を返しま
        す。

<comment>See Also:</comment>
   * ReflectionFunctionAbstract::getTentativeReturnType
   * ReflectionFunctionAbstract::hasReturnType
   * 内部クラスと戻り値の型の互換性


id: ReflectionFunctionAbstract::inNamespace
type: function
doc:
<comment>Description:</comment>
  関数が名前空間内にあるかどうかを調べる
  
  関数が名前空間内で定義されているかどうかを調べます。

<comment>Return:</comment>
  <info>bool</info>  名前空間内にある場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * ReflectionFunctionAbstract::getNamespaceName
   * 名前空間


id: ReflectionFunctionAbstract::isClosure
type: function
doc:
<comment>Description:</comment>
  クロージャであるかどうかを調べる
  
  この関数が <class>Closure</class> であるかどうかを調べます。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>bool</info>  この関数が <class>Closure</class> である場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * ReflectionFunctionAbstract::isGenerator


id: ReflectionFunctionAbstract::isDeprecated
type: function
doc:
<comment>Description:</comment>
  非推奨であるかどうかを調べる
  
  この関数が非推奨であるかどうかを調べます。

<comment>Return:</comment>
  <info>bool</info>  非推奨である場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * ReflectionFunctionAbstract::getDocComment


id: ReflectionFunctionAbstract::isGenerator
type: function
doc:
<comment>Description:</comment>
  この関数がジェネレータかどうかを返す

<comment>Return:</comment>
  <info>bool</info>  この関数がジェネレータである場合に <info>true</info>、そうでない場合に <info>false</info> を返します。 処理に失敗した
        場合に <info>null</info> を返します。


id: ReflectionFunctionAbstract::isInternal
type: function
doc:
<comment>Description:</comment>
  内部関数かどうかを調べる
  
  この関数が内部関数なのかユーザー定義関数なのかを調べます。

<comment>Return:</comment>
  <info>bool</info>  内部関数である場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * ReflectionFunctionAbstract::isUserDefined


id: ReflectionFunctionAbstract::isStatic
type: function
doc:
<comment>Description:</comment>
  関数が static であるかどうかを調べる
  
  関数が static であるかどうかを調べます。

<comment>Return:</comment>
  <info>bool</info>  関数が static である場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * ReflectionMethod::isFinal


id: ReflectionFunctionAbstract::isUserDefined
type: function
doc:
<comment>Description:</comment>
  ユーザー定義関数であるかどうかを調べる
  
  この関数がユーザー定義関数なのか内部関数なのかを調べます。

<comment>Return:</comment>
  <info>bool</info>  ユーザー定義関数である場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * ReflectionFunctionAbstract::isInternal


id: ReflectionFunctionAbstract::isVariadic
type: function
doc:
<comment>Description:</comment>
  この関数の引数が可変長かを調べる
  
  この関数の 引数が可変長 かを調べます。

<comment>Return:</comment>
  <info>bool</info>  この関数の引数が可変長なら <info>true</info> を返します。そうでないなら <info>false</info> を返します。


id: ReflectionFunctionAbstract::returnsReference
type: function
doc:
<comment>Description:</comment>
  参照返しかどうかを調べる
  
  関数が参照を返すかどうかを調べます。

<comment>Return:</comment>
  <info>bool</info>  参照返しである場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * ReflectionFunctionAbstract::isClosure


id: ReflectionGenerator::__construct
type: function
doc:
<comment>Description:</comment>
  ReflectionGenerator オブジェクトを構築する
  
  ReflectionGenerator オブジェクトを構築します。

<comment>Param:</comment>
  <info>Generator</info>  <strong>$generator</strong>  ジェネレータオブジェクト

<comment>See Also:</comment>
   * ReflectionGenerator::getFunction
   * ReflectionGenerator::getExecutingLine
   * ReflectionGenerator::getExecutingFile


id: ReflectionGenerator::getExecutingFile
type: function
doc:
<comment>Description:</comment>
  現在実行中のジェネレータのファイル名を取得する
  
  現在実行中のジェネレータのファイル名をフルパスで取得します。

<comment>Return:</comment>
  <info>string</info>  現在実行中のジェネレータのファイル名をフルパスを返します。

<comment>See Also:</comment>
   * ReflectionGenerator::getExecutingLine
   * ReflectionGenerator::getExecutingGenerator


id: ReflectionGenerator::getExecutingGenerator
type: function
doc:
<comment>Description:</comment>
  実行中の Generator オブジェクトを取得する
  
  実行中の <class>Generator</class> オブジェクトを取得します。

<comment>Return:</comment>
  <info>Generator</info>  現在実行中の <class>Generator</class> オブジェクトを返します。

<comment>See Also:</comment>
   * ReflectionGenerator::getExecutingLine
   * ReflectionGenerator::getExecutingFile


id: ReflectionGenerator::getExecutingLine
type: function
doc:
<comment>Description:</comment>
  現在実行中のジェネレータの行を取得する
  
  現在実行中のジェネレータの行を取得します。

<comment>Return:</comment>
  <info>int</info>  現在実行中のジェネレータの式の行番号を返します。

<comment>See Also:</comment>
   * ReflectionGenerator::getExecutingGenerator
   * ReflectionGenerator::getExecutingFile


id: ReflectionGenerator::getFunction
type: function
doc:
<comment>Description:</comment>
  ジェネレータの関数名を取得する
  
  <class>ReflectionFunctionAbstract</class> から派生したクラスを返すことによって、 取得したジェネレータの関数名を取
  得します。

<comment>Return:</comment>
  <info>ReflectionFunctionAbstract</info>  <class>ReflectionFunctionAbstract</class> クラスを返します。 これは 関数の場合は
                              <class>ReflectionFunction</class> ですし、 メソッドの場合は <class>ReflectionMethod</class> になりま
                              す。

<comment>See Also:</comment>
   * ReflectionGenerator::getThis
   * ReflectionGenerator::getTrace


id: ReflectionGenerator::getThis
type: function
doc:
<comment>Description:</comment>
  ジェネレータの $this の値を取得する
  
  ジェネレータがアクセスできる <return>$this</return> の値を取得します。

<comment>Return:</comment>
  <info>object|null</info>  <return>$this</return> の値を返します。  ジェネレータがクラスコンテキストの中で作られていない場合は
               <info>null</info> を返します。

<comment>See Also:</comment>
   * ReflectionGenerator::getFunction
   * ReflectionGenerator::getTrace


id: ReflectionGenerator::getTrace
type: function
doc:
<comment>Description:</comment>
  実行中のジェネレータのトレースを取得する
  
  現在実行中のジェネレータのトレースを取得します。

<comment>Param:</comment>
  <info>int</info>  <strong>$options</strong>  <strong>$options</strong> の値は以下のフラグのうちのいずれかです:
                 
                 利用可能なオプションオプション説明<info>DEBUG_BACKTRACE_PROVIDE_OBJECT</info> デフォルト
                 <info>DEBUG_BACKTRACE_IGNORE_ARGS</info> スタックトレース内の関数に引数の情報を含めない

<comment>Return:</comment>
  <info>array</info>  現在実行中のジェネレータのトレースを返します。

<comment>See Also:</comment>
   * ReflectionGenerator::getFunction
   * ReflectionGenerator::getThis


id: ReflectionIntersectionType::getTypes
type: function
doc:
<comment>Description:</comment>
  交差型に含まれている型を返す
  
  交差型に含まれている型を返します。

<comment>Return:</comment>
  <info>array</info>  <class>ReflectionType</class> オブジェクトの配列を返します。

<comment>See Also:</comment>
   * ReflectionType::allowsNull
   * ReflectionParameter::getType


id: ReflectionMethod::IS_ABSTRACT
type: constant
doc:
<comment>Description:</comment>
  メソッドが abstract であることを示します。 PHP 7.4.0 より前のバージョンでは、この値は <return>2</return> でした。


id: ReflectionMethod::IS_FINAL
type: constant
doc:
<comment>Description:</comment>
  メソッドが final であることを示します。 PHP 7.4.0 より前のバージョンでは、この値は <return>4</return> でした。


id: ReflectionMethod::IS_PRIVATE
type: constant
doc:
<comment>Description:</comment>
  メソッドが private であることを示します。 PHP 7.4.0 より前のバージョンでは、この値は <return>1024</return> でした。


id: ReflectionMethod::IS_PROTECTED
type: constant
doc:
<comment>Description:</comment>
  メソッドが protected であることを示します。 PHP 7.4.0 より前のバージョンでは、この値は <return>512</return> でし
  た。


id: ReflectionMethod::IS_PUBLIC
type: constant
doc:
<comment>Description:</comment>
  メソッドが public であることを示します。 PHP 7.4.0 より前のバージョンでは、この値は <return>256</return> でした。


id: ReflectionMethod::IS_STATIC
type: constant
doc:
<comment>Description:</comment>
  メソッドが static であることを示します。 PHP 7.4.0 より前のバージョンでは、この値は <return>1</return> でした。


id: ReflectionMethod::__construct
type: function
doc:
<comment>Description:</comment>
  ReflectionMethod を作成する
  
  代替のシグネチャ (名前付き引数をサポートしていません):
  
  新しい <class>ReflectionMethod</class> を作成します。

<comment>Param:</comment>
  <info>object|string</info>  <strong>$objectOrMethod</strong>  メソッドを含むクラスの名前あるいはオブジェクト (クラスのインスタン
                                  ス)。
  <info>string</info>         <strong>$method</strong>          メソッドの名前。
  <info>string</info>         <strong>$classMethod</strong>     クラス名とメソッド名を <return>::</return> で区切ったもの。

<comment>See Also:</comment>
   * ReflectionMethod::export
   * コンストラクタ


id: ReflectionMethod::__toString
type: function
doc:
<comment>Description:</comment>
  ReflectionMethod オブジェクトの文字列表現を返す
  
  ReflectionMethod オブジェクトの文字列表現を返します。

<comment>Return:</comment>
  <info>string</info>  <class>ReflectionMethod</class> のインスタンスの文字列表現を返します。

<comment>See Also:</comment>
   * ReflectionMethod::export
   * __toString()


id: ReflectionMethod::createFromMethodName
type: function
doc:
<comment>Description:</comment>
  ReflectionMethod を作成する
  
  新しい <class>ReflectionMethod</class> を作成します。

<comment>Param:</comment>
  <info>string</info>  <strong>$method</strong>  <return>::</return> で区切られたクラス名とメソッド名。

<comment>Return:</comment>
  <info>static</info>  成功した場合、新しい <class>ReflectionMethod</class> を返します。


id: ReflectionMethod::export
type: function
doc:
<comment>Description:</comment>
  メソッドをエクスポートする
  
  ReflectionMethod をエクスポートします。

<comment>Param:</comment>
  <info>string</info>  <strong>$class</strong>   クラス名。
  <info>string</info>  <strong>$name</strong>    メソッド名。
  <info>bool</info>    <strong>$return</strong>  <info>true</info> に設定すると、エクスポートを発行するのではなく返します。
                   <info>false</info> (デフォルト) の場合はその逆です。

<comment>Return:</comment>
  <info>string</info>  <strong>$return</strong> パラメータを
          <info>true</info> に設定すると、エクスポートを文字列で返します。それ以外の場合は
          <info>null</info> を返します。

<comment>See Also:</comment>
   * ReflectionMethod::__construct
   * ReflectionMethod::__toString


id: ReflectionMethod::getClosure
type: function
doc:
<comment>Description:</comment>
  このメソッドに動的に作成されたクロージャを返す
  
  メソッドをコールするクロージャを作成します。

<comment>Param:</comment>
  <info>object|null</info>  <strong>$object</strong>  staticメソッドの場合は不要、その他のメソッドの場合は必須となります。

<comment>Return:</comment>
  <info>Closure</info>  新しく作成した <class>Closure</class> を返します。

<comment>See Also:</comment>
   * 第一級callableを生成する記法


id: ReflectionMethod::getDeclaringClass
type: function
doc:
<comment>Description:</comment>
  メソッドが宣言されているクラスを取得する
  
  そのメソッドが宣言されているクラスを取得します。

<comment>Return:</comment>
  <info>ReflectionClass</info>  そのメソッドが属するクラスをあらわす <class>ReflectionClass</class> オブジェクトを返します。

<comment>See Also:</comment>
   * ReflectionMethod::isAbstract


id: ReflectionMethod::getModifiers
type: function
doc:
<comment>Description:</comment>
  メソッドの修飾子を取得する
  
  このメソッドのアクセス修飾子のビットフィールドを返します。

<comment>Return:</comment>
  <info>int</info>  修飾子をあらわす数値を返します。修飾子の一覧は以下のとおりです。 これらの修飾子の実際の意味に
       ついては 定義済みの定数 に説明があります。

<comment>See Also:</comment>
   * Reflection::getModifierNames


id: ReflectionMethod::getPrototype
type: function
doc:
<comment>Description:</comment>
  メソッドのプロトタイプを (存在すれば) 取得する
  
  メソッドのプロトタイプを取得します。

<comment>Return:</comment>
  <info>ReflectionMethod</info>  メソッドのプロトタイプの <class>ReflectionMethod</class> オブジェクトを返します。

<comment>See Also:</comment>
   * ReflectionMethod::getModifiers
   * ReflectionMethod::hasPrototype


id: ReflectionMethod::hasPrototype
type: function
doc:
<comment>Description:</comment>
  メソッドがプロトタイプを持つかを調べる
  
  メソッドがプロトタイプを持つかを返します。

<comment>Return:</comment>
  <info>bool</info>  メソッドがプロトタイプを持つ場合、<info>true</info> を返します。そうでない場合、<info>false</info> を返します。

<comment>See Also:</comment>
   * ReflectionMethod::getPrototype


id: ReflectionMethod::invoke
type: function
doc:
<comment>Description:</comment>
  実行する
  
  メソッドを実行します。

<comment>Param:</comment>
  <info>object|null</info>  <strong>$object</strong>  メソッドを実行するオブジェクト。staticメソッドを実行する場合は、このパラメー
                        タには <info>null</info> を渡すことができます。
  <info>mixed</info>        <strong>$args</strong>    メソッドに渡すパラメータ。可変長のパラメータを渡すことができます。

<comment>Return:</comment>
  <info>mixed</info>  メソッドの結果を返します。

<comment>See Also:</comment>
   * ReflectionMethod::invokeArgs
   * __invoke()
   * <strong>call_user_func()</strong>


id: ReflectionMethod::invokeArgs
type: function
doc:
<comment>Description:</comment>
  実行する
  
  リフレクション対象のメソッドを実行し、その引数を配列として渡します。

<comment>Param:</comment>
  <info>object|null</info>  <strong>$object</strong>  メソッドを実行するオブジェクト。staticメソッドを実行する場合は、このパラメー
                        タには <info>null</info> を渡すことができます。
  <info>array</info>        <strong>$args</strong>    メソッドに渡すパラメータを配列で指定します。

<comment>Return:</comment>
  <info>mixed</info>  メソッドの結果を返します。

<comment>See Also:</comment>
   * ReflectionMethod::invoke
   * __invoke()
   * <strong>call_user_func_array()</strong>


id: ReflectionMethod::isAbstract
type: function
doc:
<comment>Description:</comment>
  抽象メソッドであるかどうかを調べる
  
  抽象メソッドであるかどうかを調べます。

<comment>Return:</comment>
  <info>bool</info>  抽象メソッドである場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * ReflectionMethod::getDeclaringClass


id: ReflectionMethod::isConstructor
type: function
doc:
<comment>Description:</comment>
  コンストラクタであるかどうかを調べる
  
  コンストラクタであるかどうかを調べます。

<comment>Return:</comment>
  <info>bool</info>  コンストラクタである場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * ReflectionMethod::__construct
   * ReflectionMethod::isAbstract
   * ReflectionMethod::isDestructor


id: ReflectionMethod::isDestructor
type: function
doc:
<comment>Description:</comment>
  デストラクタであるかどうかを調べる
  
  デストラクタであるかどうかを調べます。

<comment>Return:</comment>
  <info>bool</info>  デストラクタである場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * ReflectionMethod::isConstructor


id: ReflectionMethod::isFinal
type: function
doc:
<comment>Description:</comment>
  final メソッドであるかどうかを調べる
  
  final メソッドであるかどうかを調べます。

<comment>Return:</comment>
  <info>bool</info>  final メソッドである場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * ReflectionMethod::isStatic


id: ReflectionMethod::isPrivate
type: function
doc:
<comment>Description:</comment>
  private メソッドであるかどうかを調べる
  
  private メソッドであるかどうかを調べます。

<comment>Return:</comment>
  <info>bool</info>  private メソッドである場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * ReflectionMethod::isPublic


id: ReflectionMethod::isProtected
type: function
doc:
<comment>Description:</comment>
  protected メソッドであるかどうかを調べる
  
  protected メソッドであるかどうかを調べます。

<comment>Return:</comment>
  <info>bool</info>  protected メソッドである場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * ReflectionMethod::isPrivate


id: ReflectionMethod::isPublic
type: function
doc:
<comment>Description:</comment>
  public メソッドであるかどうかを調べる
  
  public メソッドであるかどうかを調べます。

<comment>Return:</comment>
  <info>bool</info>  public メソッドである場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * ReflectionMethod::isPrivate


id: ReflectionMethod::setAccessible
type: function
doc:
<comment>Description:</comment>
  メソッドのアクセス範囲を設定する
  
  ReflectionMethod::invoke メソッド経由で、 protected や private なメソッドを呼び出し可能にします。
  
  PHP 8.1.0 以降は、このメソッドをコールしても何も起こりません。 つまり、全てのメソッドはデフォルト
  で呼び出し可能です。

<comment>Param:</comment>
  <info>bool</info>  <strong>$accessible</strong>  <info>true</info> を指定すると、アクセスできるようになります。

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

<comment>See Also:</comment>
   * ReflectionMethod::isPrivate
   * ReflectionMethod::isProtected


id: ReflectionNamedType::getName
type: function
doc:
<comment>Description:</comment>
  型の名前の文字列を取得する

<comment>Return:</comment>
  <info>string</info>  リフレクションされた型の名前を返します。

<comment>See Also:</comment>
   * ReflectionType::__toString


id: ReflectionNamedType::isBuiltin
type: function
doc:
<comment>Description:</comment>
  組み込みの型であるかを調べる
  
  PHP に元々組み込まれた型であるかを調べます。 元々組み込まれた型とは、クラス、インターフェイス、ト
  レイトのいずれでもない型を指します。

<comment>Return:</comment>
  <info>bool</info>  組み込みの型である場合は <info>true</info> を、そうでない場合は <info>false</info> を返します。

<comment>See Also:</comment>
   * ReflectionType::allowsNull
   * ReflectionType::__toString
   * ReflectionClass::isInternal
   * ReflectionParameter::getType


id: ReflectionObject::__construct
type: function
doc:
<comment>Description:</comment>
  ReflectionObject を作成する
  
  <class>ReflectionObject</class> を作成します。

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  オブジェクトのインスタンス。

<comment>See Also:</comment>
   * ReflectionObject::export
   * コンストラクタ


id: ReflectionObject::export
type: function
doc:
<comment>Description:</comment>
  エクスポートする
  
  リフレクションをエクスポートします。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>string</info>  <strong>$argument</strong>  エクスポートするリフレクション。
  <info>bool</info>    <strong>$return</strong>    <info>true</info> に設定すると、エクスポートを発行するのではなく返します。
                     <info>false</info> (デフォルト) の場合はその逆です。

<comment>Return:</comment>
  <info>string</info>  <strong>$return</strong> パラメータを
          <info>true</info> に設定すると、エクスポートを文字列で返します。それ以外の場合は
          <info>null</info> を返します。

<comment>See Also:</comment>
   * ReflectionObject::__construct


id: ReflectionParameter
type: class
doc:
<comment>Description:</comment>
  <class>ReflectionParameter</class> クラスは、 関数またはメソッドのパラメータに関する情報を取得します。
  
  関数パラメータの内部を調べる際には、まず <class>ReflectionFunction</class> クラスまたは <class>ReflectionMethod</class> クラスの
  インスタンスを作成する必要があります。次に、 ReflectionFunctionAbstract::getParameters メソッドを
  使ってパラメータの配列を取得します。


id: ReflectionParameter::__clone
type: function
doc:
<comment>Description:</comment>
  クローンする
  
  クローンします。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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

<comment>See Also:</comment>
   * ReflectionParameter::toString
   * オブジェクトのクローン作成


id: ReflectionParameter::__construct
type: function
doc:
<comment>Description:</comment>
  コンストラクタ
  
  <class>ReflectionParameter</class> クラスのインスタンスを構築します。

<comment>Param:</comment>
  <info>string|array|object</info>  <strong>$function</strong>  パラメータを調べたい関数。
  <info>int|string</info>           <strong>$param</strong>     パラメータの位置を指定する <info>int</info> (0から始まります)、 もしくはパラ
                                  メータの名前を <info>string</info> で指定します。

<comment>See Also:</comment>
   * ReflectionFunctionAbstract::getParameters
   * ReflectionFunction::__construct
   * ReflectionMethod::__construct
   * コンストラクタ


id: ReflectionParameter::__toString
type: function
doc:
<comment>Description:</comment>
  文字列に変換する
  
  人間が読めるパラメータの説明を取得します。

<comment>Return:</comment>
  <info>string</info>  文字列を返します。

<comment>See Also:</comment>
   * ReflectionParameter::export
   * __toString()


id: ReflectionParameter::allowsNull
type: function
doc:
<comment>Description:</comment>
  null を許可するかどうかを調べる
  
  パラメータが <info>null</info> を許可するかどうかを調べます。

<comment>Return:</comment>
  <info>bool</info>  <info>null</info> を許可する場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * ReflectionParameter::isOptional


id: ReflectionParameter::canBePassedByValue
type: function
doc:
<comment>Description:</comment>
  このパラメータが値渡し可能かどうかを返す

<comment>Return:</comment>
  <info>bool</info>  このパラメータが値渡し可能な場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。 エラー時には
        <info>null</info> を返します。


id: ReflectionParameter::export
type: function
doc:
<comment>Description:</comment>
  エクスポートする
  
  エクスポートします。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>string</info>  <strong>$function</strong>   関数名。
  <info>string</info>  <strong>$parameter</strong>  パラメータ名。
  <info>bool</info>    <strong>$return</strong>     <info>true</info> に設定すると、エクスポートを発行するのではなく返します。
                      <info>false</info> (デフォルト) の場合はその逆です。

<comment>Return:</comment>
  <info>string</info>  エクスポート結果を返します。

<comment>See Also:</comment>
   * ReflectionParameter::__toString


id: ReflectionParameter::getAttributes
type: function
doc:
<comment>Description:</comment>
  アトリビュートを取得する
  
  この引数上で宣言されている全てのアトリビュートを、 <info>ReflectionAttribute</info> の配列として返します。

<comment>Param:</comment>
  <info>string|null</info>  <strong>$name</strong>   指定したクラス名にマッチするアトリビュートの、 <class>ReflectionAttribute</class> のみを含む
                       ようにフィルタします。
  <info>int</info>          <strong>$flags</strong>  <strong>$name</strong> が指定されていた場合に、 結果をどうフィルタするかを決めるフラグ。
                       
                       デフォルトは <return>0</return> です。 この場合、アトリビュートのクラス名が <strong>$name</strong> であるものだ
                       けを返します。
                       
                       他の利用可能なオプションは、 <info>ReflectionAttribute::IS_INSTANCEOF</info> です。 この場
                       合、フィルタリングに <return>instanceof</return> を使います。

<comment>Return:</comment>
  <info>array</info>  アトリビュートの配列を、 <class>ReflectionAttribute</class> オブジェクトの配列として返します。

<comment>See Also:</comment>
   * ReflectionClass::getAttributes
   * ReflectionClassConstant::getAttributes
   * ReflectionFunctionAbstract::getAttributes
   * ReflectionProperty::getAttributes


id: ReflectionParameter::getClass
type: function
doc:
<comment>Description:</comment>
  リフレクションされた ReflectionClass を取得する。
  
  パラメータとしてリフレクションされたクラスを、 <class>ReflectionClass</class> オブジェクトとして取得するか、<info>null</info>
  を返します。
  
  PHP 8.0.0 以降は、この関数を使うことは推奨されなくなりました。 代わりに、引数の型を調べるために
  <class>ReflectionType</class> を取得して下さい。 それを取得するには、ReflectionParameter::getType を使います。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>ReflectionClass|null</info>  <class>ReflectionClass</class> オブジェクトを返します。 型が宣言されていないか、 宣言されて
                        いてもクラスやインターフェイスでない場合は、<info>null</info> を返します。

<comment>See Also:</comment>
   * ReflectionParameter::getDeclaringClass


id: ReflectionParameter::getDeclaringClass
type: function
doc:
<comment>Description:</comment>
  宣言しているクラスを取得する
  
  宣言しているクラスを取得します。

<comment>Return:</comment>
  <info>ReflectionClass|null</info>  <class>ReflectionClass</class> オブジェクトを返します。 関数の中で呼ばれた場合、<info>null</info> を返し
                        ます。

<comment>See Also:</comment>
   * ReflectionParameter::getClass


id: ReflectionParameter::getDeclaringFunction
type: function
doc:
<comment>Description:</comment>
  宣言している関数を取得する
  
  宣言している関数を取得します。

<comment>Return:</comment>
  <info>ReflectionFunctionAbstract</info>  <class>ReflectionFunction</class> オブジェクトを返します。

<comment>See Also:</comment>
   * ReflectionParameter::getDeclaringClass


id: ReflectionParameter::getDefaultValue
type: function
doc:
<comment>Description:</comment>
  パラメータのデフォルト値を取得する
  
  (内部またはユーザー定義の) 関数あるいはメソッドで、パラメータのデフォルト値を取得します。 省略可能
  なパラメータでない場合は <class>ReflectionException</class> がスローされます。

<comment>Return:</comment>
  <info>mixed</info>  パラメータのデフォルト対を返します。

<comment>See Also:</comment>
   * ReflectionParameter::isOptional
   * ReflectionParameter::isDefaultValueAvailable
   * ReflectionParameter::getDefaultValueConstantName
   * ReflectionParameter::isPassedByReference


id: ReflectionParameter::getDefaultValueConstantName
type: function
doc:
<comment>Description:</comment>
  デフォルト値が定数あるいは null の場合に、その定数名を返す
  
  デフォルト値が定数か null の場合に、 (内部またはユーザー定義の) 関数やメソッドのデフォルト値の定数
  名を返します。 パラメータがオプションでない場合は、 <class>ReflectionException</class> がスローされます。

<comment>Return:</comment>
  <info>string|null</info>  成功した場合に文字列、失敗した場合に <info>null</info> を返します。

<comment>See Also:</comment>
   * ReflectionParameter::isOptional
   * ReflectionParameter::isDefaultValueConstant
   * ReflectionParameter::getDefaultValue


id: ReflectionParameter::getName
type: function
doc:
<comment>Description:</comment>
  パラメータ名を取得する
  
  パラメータ名を取得します。

<comment>Return:</comment>
  <info>string</info>  パラメータ名を返します。

<comment>See Also:</comment>
   * ReflectionParameter::getValue


id: ReflectionParameter::getPosition
type: function
doc:
<comment>Description:</comment>
  パラメータの位置を取得する
  
  パラメータの位置を取得します。

<comment>Return:</comment>
  <info>int</info>  パラメータの位置を取得します。左から右へ数え、最初のパラメータが 0 番目となります。

<comment>See Also:</comment>
   * ReflectionParameter::getName


id: ReflectionParameter::getType
type: function
doc:
<comment>Description:</comment>
  引数の型を取得する
  
  引数の型を取得します。

<comment>Return:</comment>
  <info>ReflectionType|null</info>  引数の型が指定されていれば <class>ReflectionType</class> オブジェクトを返します。 そうでなけ
                       れば <info>null</info> を返します。

<comment>See Also:</comment>
   * ReflectionParameter::hasType
   * ReflectionType::__toString


id: ReflectionParameter::hasType
type: function
doc:
<comment>Description:</comment>
  引数が型を持つかを調べる
  
  引数が、関連する型を持つかを調べます。

<comment>Return:</comment>
  <info>bool</info>  型が指定されていれば <info>true</info> を。そうでなければ <info>false</info> を返します。

<comment>See Also:</comment>
   * ReflectionParameter::getType


id: ReflectionParameter::isArray
type: function
doc:
<comment>Description:</comment>
  配列を受け取るパラメータであるかどうかを調べる
  
  配列を受け取るパラメータであるかどうかを調べます。

<comment>Return:</comment>
  <info>bool</info>  配列を受け取るパラメータである場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * ReflectionParameter::isOptional


id: ReflectionParameter::isCallable
type: function
doc:
<comment>Description:</comment>
  パラメータが callable かどうかを返す
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>bool</info>  パラメータが <info>callable</info> の場合に <info>true</info>、そうではない場合に <info>false</info> を返します。 失敗した場合は
        <info>null</info> を返します。


id: ReflectionParameter::isDefaultValueAvailable
type: function
doc:
<comment>Description:</comment>
  デフォルト値が存在するかどうかを調べる
  
  パラメータのデフォルト値が存在するかどうかを調べます。

<comment>Return:</comment>
  <info>bool</info>  デフォルト値が存在する場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * ReflectionParameter::getDefaultValue
   * ReflectionParameter::isDefaultValueConstant
   * ReflectionParameter::getName


id: ReflectionParameter::isDefaultValueConstant
type: function
doc:
<comment>Description:</comment>
  このパラメータのデフォルト値が定数かどうかを返す
  
  このパラメータのデフォルト値が定数かどうかを返します。

<comment>Return:</comment>
  <info>bool</info>  デフォルト値が定数である場合は <info>true</info> を返します。 そうでなければ <info>false</info> を返します。

<comment>See Also:</comment>
   * ReflectionParameter::getDefaultValueConstantName
   * ReflectionParameter::isDefaultValueAvailable


id: ReflectionParameter::isOptional
type: function
doc:
<comment>Description:</comment>
  省略可能であるかどうかを調べる
  
  パラメータが省略可能であるかどうかを調べます。

<comment>Return:</comment>
  <info>bool</info>  省略可能である場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * ReflectionParameter::getName


id: ReflectionParameter::isPassedByReference
type: function
doc:
<comment>Description:</comment>
  参照渡しかどうかを調べる
  
  パラメータが参照渡しであるかどうかを調べます。

<comment>Return:</comment>
  <info>bool</info>  パラメータが参照渡しである場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * ReflectionParameter::getName


id: ReflectionParameter::isVariadic
type: function
doc:
<comment>Description:</comment>
  引数が可変長の個数であるかをチェックする
  
  引数が 可変長引数リスト として宣言されているかを調べます。

<comment>Return:</comment>
  <info>bool</info>  引数が可変長であれば <info>true</info> を、そうでなければ <info>false</info> を返します。


id: ReflectionProperty::IS_PRIVATE
type: constant
doc:
<comment>Description:</comment>
  private プロパティを示します。 PHP 7.4.0 より前のバージョンでは、この値は <return>1024</return> でした。


id: ReflectionProperty::IS_PROTECTED
type: constant
doc:
<comment>Description:</comment>
  protected プロパティを示します。 PHP 7.4.0 より前のバージョンでは、この値は <return>512</return> でした。


id: ReflectionProperty::IS_PUBLIC
type: constant
doc:
<comment>Description:</comment>
  public プロパティを示します。 PHP 7.4.0 より前のバージョンでは、この値は <return>256</return> でした。


id: ReflectionProperty::IS_STATIC
type: constant
doc:
<comment>Description:</comment>
  static プロパティを示します。 PHP 7.4.0 より前のバージョンでは、この値は <return>1</return> でした。


id: ReflectionProperty::__clone
type: function
doc:
<comment>Description:</comment>
  クローンする
  
  クローンします。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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

<comment>See Also:</comment>
   * ReflectionProperty::export
   * オブジェクトのクローン作成


id: ReflectionProperty::__construct
type: function
doc:
<comment>Description:</comment>
  ReflectionProperty オブジェクトを作成する

<comment>Param:</comment>
  <info>object|string</info>  <strong>$class</strong>     リフレクションするクラス、またはオブジェクトの名前を含む文字列。
  <info>string</info>         <strong>$property</strong>  調べたいプロパティの名前。

<comment>See Also:</comment>
   * ReflectionProperty::getName
   * コンストラクタ


id: ReflectionProperty::__toString
type: function
doc:
<comment>Description:</comment>
  文字列に変換する
  
  プロパティを表現した文字列を返します。

<comment>Return:</comment>
  <info>string</info>  文字列を返します。

<comment>See Also:</comment>
   * __toString()


id: ReflectionProperty::export
type: function
doc:
<comment>Description:</comment>
  エクスポートする
  
  エクスポートします。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info></info>        <strong>$argument</strong>  エクスポートするリフレクション。
  <info>string</info>  <strong>$name</strong>      プロパティ名。
  <info>bool</info>    <strong>$return</strong>    <info>true</info> に設定すると、エクスポートを発行するのではなく返します。
                     <info>false</info> (デフォルト) の場合はその逆です。

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

<comment>See Also:</comment>
   * ReflectionProperty::__toString


id: ReflectionProperty::getAttributes
type: function
doc:
<comment>Description:</comment>
  アトリビュートを取得する
  
  このクラスプロパティで宣言されている全てのアトリビュートを、 <info>ReflectionAttribute</info> の配列として返し
  ます。

<comment>Param:</comment>
  <info>string|null</info>  <strong>$name</strong>   指定したクラス名にマッチするアトリビュートの、 <class>ReflectionAttribute</class> のみを含む
                       ようにフィルタします。
  <info>int</info>          <strong>$flags</strong>  <strong>$name</strong> が指定されていた場合に、 結果をどうフィルタするかを決めるフラグ。
                       
                       デフォルトは <return>0</return> です。 この場合、アトリビュートのクラス名が <strong>$name</strong> であるものだ
                       けを返します。
                       
                       他の利用可能なオプションは、 <info>ReflectionAttribute::IS_INSTANCEOF</info> です。 この場
                       合、フィルタリングに <return>instanceof</return> を使います。

<comment>Return:</comment>
  <info>array</info>  アトリビュートの配列を、 <class>ReflectionAttribute</class> オブジェクトの配列として返します。

<comment>See Also:</comment>
   * ReflectionClass::getAttributes
   * ReflectionClassConstant::getAttributes
   * ReflectionFunctionAbstract::getAttributes
   * ReflectionParameter::getAttributes


id: ReflectionProperty::getDeclaringClass
type: function
doc:
<comment>Description:</comment>
  宣言しているクラスを取得する
  
  宣言しているクラスを取得します。

<comment>Return:</comment>
  <info>ReflectionClass</info>  <class>ReflectionClass</class> オブジェクトを返します。

<comment>See Also:</comment>
   * ReflectionProperty::getName


id: ReflectionProperty::getDefaultValue
type: function
doc:
<comment>Description:</comment>
  プロパティで宣言されたデフォルト値を返す
  
  プロパティに明示または黙示的に宣言されているデフォルト値を取得します。

<comment>Return:</comment>
  <info>mixed</info>  プロパティに何かしらデフォルト値が存在する場合(<info>null</info>も含みます)、 それを返します。デフォルト
         値がない場合、<info>null</info> を返します。 デフォルト値が <info>null</info> の場合と、型付きプロパティが初期化され
         てない場合は区別できません。  それらを区別するには、ReflectionProperty::hasDefaultValue を
         使って下さい。

<comment>See Also:</comment>
   * ReflectionProperty::hasDefaultValue


id: ReflectionProperty::getDocComment
type: function
doc:
<comment>Description:</comment>
  プロパティのドキュメントコメントを取得する
  
  プロパティのドキュメントコメントを取得します。

<comment>Return:</comment>
  <info>string|false</info>  プロパティのドキュメントコメントを返します。 ドキュメントコメントが存在しない場合
                は、<info>false</info> を返します。

<comment>See Also:</comment>
   * ReflectionProperty::getModifiers
   * ReflectionProperty::getName
   * ReflectionProperty::getValue


id: ReflectionProperty::getModifiers
type: function
doc:
<comment>Description:</comment>
  プロパティの修飾子を取得する
  
  修飾子を取得します。

<comment>Return:</comment>
  <info>int</info>  修飾子の数値表現を返します。 これらの修飾子の実際の意味は、 定義済みの定数 で説明しています。

<comment>See Also:</comment>
   * ReflectionProperty::isPrivate
   * Reflection::getModifierNames


id: ReflectionProperty::getName
type: function
doc:
<comment>Description:</comment>
  プロパティ名を取得する
  
  プロパティ名を取得します。

<comment>Return:</comment>
  <info>string</info>  調べているプロパティの名前を返します。

<comment>See Also:</comment>
   * ReflectionProperty::getValue


id: ReflectionProperty::getType
type: function
doc:
<comment>Description:</comment>
  プロパティの型を取得する
  
  プロパティに関連付けられた型を取得する

<comment>Return:</comment>
  <info>ReflectionType|null</info>  プロパティが型を持っていれば、<class>ReflectionType</class> を返します。そうでなければ、
                       <info>null</info> を返します。

<comment>See Also:</comment>
   * ReflectionProperty::hasType
   * ReflectionProperty::isInitialized


id: ReflectionProperty::getValue
type: function
doc:
<comment>Description:</comment>
  値を取得する
  
  プロパティの値を取得します。

<comment>Param:</comment>
  <info>object|null</info>  <strong>$object</strong>  static でないプロパティの場合は、プロパティを取得したいオブジェクトを指定し
                        なければなりません。 オブジェクトを指定せずにデフォルトのプロパティを取得し
                        たい場合は、かわりに ReflectionClass::getDefaultProperties を使います。

<comment>Return:</comment>
  <info>mixed</info>  プロパティの現在の値を返します。

<comment>See Also:</comment>
   * ReflectionProperty::setValue
   * ReflectionProperty::setAccessible
   * ReflectionClass::getDefaultProperties
   * ReflectionClass::getStaticPropertyValue


id: ReflectionProperty::hasDefaultValue
type: function
doc:
<comment>Description:</comment>
  デフォルト値が宣言されているかをチェックする
  
  プロパティにデフォルト値が宣言されているかをチェックします。 暗黙の <info>null</info> のデフォルト値も含めて
  チェックが行われます。 デフォルト値が存在しない型付きプロパティ(または動的なプロパティ)の場合は、
  <info>false</info> が返されます。

<comment>Return:</comment>
  <info>bool</info>  プロパティが何かしらデフォルト値を持っている場合(<info>null</info>を含みます)、<info>true</info> を返します。 プロパ
        ティにデフォルト値が宣言されていないか、動的なプロパティの場合は、<info>false</info> を返します。

<comment>See Also:</comment>
   * ReflectionProperty::getDefaultValue


id: ReflectionProperty::hasType
type: function
doc:
<comment>Description:</comment>
  プロパティが型を持つかをチェックする
  
  プロパティが、自身に関連付けられた型を持つかをチェックします。

<comment>Return:</comment>
  <info>bool</info>  型が指定されていれば <info>true</info> そうでなければ <info>false</info>

<comment>See Also:</comment>
   * ReflectionProperty::getType
   * ReflectionProperty::isInitialized


id: ReflectionProperty::isDefault
type: function
doc:
<comment>Description:</comment>
  デフォルトプロパティであるかどうかを調べる
  
  そのプロパティがコンパイル時に宣言されたものなのか、実行時に動的に宣言されたものなのかを調べます。

<comment>Return:</comment>
  <info>bool</info>  プロパティがコンパイル時に宣言された者である場合に <info>true</info>、 実行時に作られたものである場合に
        <info>false</info> を返します。

<comment>See Also:</comment>
   * ReflectionProperty::getValue


id: ReflectionProperty::isInitialized
type: function
doc:
<comment>Description:</comment>
  プロパティが初期化されているかをチェックする
  
  プロパティが初期化されているかをチェックします。

<comment>Param:</comment>
  <info>object|null</info>  <strong>$object</strong>  プロパティが static でない場合、プロパティを取得する対象のオブジェクトを与え
                        なければなりません。

<comment>Return:</comment>
  <info>bool</info>  型付きのプロパティが初期化される前か、明示的に <strong>unset()</strong> されたプロパティの場合は、 <info>false</info> を返
        します。 それ以外の全てのプロパティは、 <info>true</info> が返されます。

<comment>See Also:</comment>
   * ReflectionProperty::hasType


id: ReflectionProperty::isPrivate
type: function
doc:
<comment>Description:</comment>
  private プロパティであるかどうかを調べる
  
  private プロパティであるかどうかを調べます。

<comment>Return:</comment>
  <info>bool</info>  private プロパティである場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * ReflectionProperty::isPublic
   * ReflectionProperty::isProtected
   * ReflectionProperty::isReadOnly
   * ReflectionProperty::isStatic


id: ReflectionProperty::isPromoted
type: function
doc:
<comment>Description:</comment>
  プロパティがコンストラクタの引数から昇格したものかを調べる
  
  プロパティが コンストラクタの引数から昇格 したものかを調べます。

<comment>Return:</comment>
  <info>bool</info>  プロパティがコンストラクタの引数から昇格したものなら <info>true</info> を返します。 そうでない場合は、
        <info>false</info> を返します。

<comment>See Also:</comment>
   * ReflectionProperty::isDefault
   * ReflectionProperty::isInitialized
   * ReflectionProperty::getValue


id: ReflectionProperty::isProtected
type: function
doc:
<comment>Description:</comment>
  protected プロパティであるかどうかを調べる
  
  protected プロパティであるかどうかを調べます。

<comment>Return:</comment>
  <info>bool</info>  protected プロパティである場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * ReflectionProperty::isPublic
   * ReflectionProperty::isPrivate
   * ReflectionProperty::isReadOnly
   * ReflectionProperty::isStatic


id: ReflectionProperty::isPublic
type: function
doc:
<comment>Description:</comment>
  public プロパティであるかどうかを調べる
  
  public プロパティであるかどうかを調べます。

<comment>Return:</comment>
  <info>bool</info>  public プロパティである場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * ReflectionProperty::isProtected
   * ReflectionProperty::isPrivate
   * ReflectionProperty::isReadOnly
   * ReflectionProperty::isStatic


id: ReflectionProperty::isReadOnly
type: function
doc:
<comment>Description:</comment>
  プロパティが readonly かを調べる
  
  プロパティが readonly かどうかを調べます。

<comment>Return:</comment>
  <info>bool</info>  プロパティが readonly の場合は <info>true</info> を返します。 そうでない場合、<info>false</info> を返します。

<comment>See Also:</comment>
   * ReflectionProperty::isPublic
   * ReflectionProperty::isProtected
   * ReflectionProperty::isPrivate
   * ReflectionProperty::isStatic


id: ReflectionProperty::isStatic
type: function
doc:
<comment>Description:</comment>
  staticプロパティであるかどうかを調べる
  
  staticプロパティであるかどうかを調べます。

<comment>Return:</comment>
  <info>bool</info>  staticプロパティである場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * ReflectionProperty::isPublic
   * ReflectionProperty::isProtected
   * ReflectionProperty::isPrivate
   * ReflectionProperty::isReadOnly


id: ReflectionProperty::setAccessible
type: function
doc:
<comment>Description:</comment>
  プロパティのアクセス範囲を設定する
  
  ReflectionProperty::getValue や ReflectionProperty::setValue メソッド経由で、 protected や private
  なプロパティにアクセス可能にします。
  
  PHP 8.1.0 以降は、このメソッドをコールしても何も起こりません。 つまり、全てのプロパティはデフォル
  トでアクセス可能です。

<comment>Param:</comment>
  <info>bool</info>  <strong>$accessible</strong>  <info>true</info> を指定すると、アクセスできるようになります。

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

<comment>See Also:</comment>
   * ReflectionProperty::isPrivate
   * ReflectionProperty::isProtected


id: ReflectionProperty::setValue
type: function
doc:
<comment>Description:</comment>
  プロパティの値を設定する
  
  プロパティの値を設定 (変更) します。
  
  PHP 8.3.0 以降では、このメソッドにひとつだけ引数を渡してコールすることは、推奨されなくなりました。
  ReflectionClass::setStaticPropertyValue を使いましょう。

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  static でないプロパティの場合は、プロパティを変更したいオブジェクトを指定しなけれ
                   ばなりません。 staticプロパティ の場合、<info>null</info> を指定しなければ なりません。
  <info>mixed</info>   <strong>$value</strong>   新しい値。

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

<comment>See Also:</comment>
   * ReflectionProperty::getValue
   * ReflectionProperty::setAccessible
   * ReflectionClass::setStaticPropertyValue


id: ReflectionReference::fromArrayElement
type: function
doc:
<comment>Description:</comment>
  配列の要素から、ReflectionReference を生成する
  
  配列の要素から、<class>ReflectionReference</class> を生成します。

<comment>Param:</comment>
  <info>array</info>       <strong>$array</strong>  リファレンスの情報が含まれる <info>array</info>。
  <info>int|string</info>  <strong>$key</strong>    キー。<info>int</info> または <info>string</info>。

<comment>Return:</comment>
  <info>ReflectionReference|null</info>  <return>$array[$key]</return> がリファレンスの場合、 <class>ReflectionReference</class> のインスタンスを
                            返します。 そうでない場合、<info>null</info> を返します。


id: ReflectionReference::getId
type: function
doc:
<comment>Description:</comment>
  リファレンスのユニークなIDを取得する
  
  リファレンスが生きている間、リファレンス単位でユニークなIDを返します。 このIDは同じリファレンスで
  あるかを比較するのに使えますし、 既知のリファレンスのマッピングを管理するのにも使えます。

<comment>Return:</comment>
  <info>string</info>  文字列を返します。フォーマットは決まっていません。


id: ReflectionType
type: class
doc:
<comment>Description:</comment>
  <class>ReflectionType</class> クラスは、 関数の引数や戻り値の型、 またはクラスのプロパティの型に関する情報を報告
  します。 リフレクション拡張モジュールでは、以下のサブクラスが宣言されています。
  <class>ReflectionNamedType</class> (PHP 7.1.0 以降)<class>ReflectionUnionType</class> (PHP 8.0.0 以降)<class>ReflectionIntersectionType</class>
  (PHP 8.1.0 以降)


id: ReflectionType::__toString
type: function
doc:
<comment>Description:</comment>
  文字列に変換する
  
  引数の型の名前を取得します。

<comment>Return:</comment>
  <info>string</info>  引数の型を返します。

<comment>See Also:</comment>
   * ReflectionNamedType::getName
   * ReflectionNamedType::isBuiltin
   * ReflectionType::allowsNull
   * ReflectionUnionType::getTypes
   * ReflectionParameter::getType


id: ReflectionType::allowsNull
type: function
doc:
<comment>Description:</comment>
  null が許されるかをチェックする
  
  引数が <info>null</info> を許容するかをチェックします。

<comment>Return:</comment>
  <info>bool</info>  <info>null</info> が許容されるなら <info>true</info> を、そうでないなら <info>false</info> を返します。

<comment>See Also:</comment>
   * ReflectionNamedType::isBuiltin
   * ReflectionType::__toString
   * ReflectionParameter::getType


id: ReflectionUnionType::getTypes
type: function
doc:
<comment>Description:</comment>
  union 型に含まれる型を返す。
  
  union 型に含まれるリフレクションの型を返します。

<comment>Return:</comment>
  <info>array</info>  <class>ReflectionType</class> オブジェクトの配列を返します。

<comment>See Also:</comment>
   * ReflectionType::allowsNull
   * ReflectionParameter::getType


id: ReflectionZendExtension::__clone
type: function
doc:
<comment>Description:</comment>
  Clone のハンドラ
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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


id: ReflectionZendExtension::__construct
type: function
doc:
<comment>Description:</comment>
  ReflectionZendExtension オブジェクトを作成する
  
  新しい <info>ReflectionZendExtension</info> オブジェクトを作成します。

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  拡張機能の名前


id: ReflectionZendExtension::__toString
type: function
doc:
<comment>Description:</comment>
  文字列変換のハンドラ
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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


id: ReflectionZendExtension::export
type: function
doc:
<comment>Description:</comment>
  エクスポート
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>    
  <info>bool</info>    <strong>$return</strong>  

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

<comment>See Also:</comment>
   * ReflectionClassConstant::__toString


id: ReflectionZendExtension::getAuthor
type: function
doc:
<comment>Description:</comment>
  作者を取得する
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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


id: ReflectionZendExtension::getCopyright
type: function
doc:
<comment>Description:</comment>
  著作権情報を取得する
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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


id: ReflectionZendExtension::getName
type: function
doc:
<comment>Description:</comment>
  名前を取得する
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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


id: ReflectionZendExtension::getURL
type: function
doc:
<comment>Description:</comment>
  URL を取得する
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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


id: ReflectionZendExtension::getVersion
type: function
doc:
<comment>Description:</comment>
  バージョンを取得する
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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


id: Reflector
type: class
doc:
<comment>Description:</comment>
  <class>Reflector</class> は、 すべてのエクスポート可能なリフレクションクラスが実装しているインターフェイスです。


id: Reflector::export
type: function
doc:
<comment>Description:</comment>
  エクスポートする
  
  エクスポートします。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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

<comment>See Also:</comment>
   * Reflection::__toString


id: RegexIterator::ALL_MATCHES
type: constant
doc:
<comment>Description:</comment>
  現在のエントリにマッチするものをすべて返します (<strong>preg_match_all()</strong> を参照ください)。


id: RegexIterator::MATCH
type: constant
doc:
<comment>Description:</comment>
  現在のエントリに対するマッチ (フィルタ) のみを行います (<strong>preg_match()</strong> を参照ください)。


id: RegexIterator::REPLACE
type: constant
doc:
<comment>Description:</comment>
  現在のエントリを置換します (<strong>preg_replace()</strong> を参照ください。まだ完全には実装されていません)。


id: RegexIterator::__construct
type: function
doc:
<comment>Description:</comment>
  新しい RegexIterator を作成する
  
  新しい <class>RegexIterator</class> を作成します。これは、正規表現を使って Iterator をフィルタリングします。

<comment>Param:</comment>
  <info>Iterator</info>  <strong>$iterator</strong>   この正規表現フィルタを適用するイテレータ。
  <info>string</info>    <strong>$pattern</strong>    マッチさせる正規表現。
  <info>int</info>       <strong>$mode</strong>       操作モード。モードの一覧は RegexIterator::setMode を参照ください。
  <info>int</info>       <strong>$flags</strong>      特殊なフラグ。フラグの一覧は RegexIterator::setFlags を参照ください。
  <info>int</info>       <strong>$pregFlags</strong>  正規表現フラグ。これらのフラグは操作モードに依存します。
                        
                        <class>RegexIterator</class> preg_flags操作モード使用可能なフラグ
                        RegexIterator::ALL_MATCHES<strong>preg_match_all()</strong> を参照ください。
                        RegexIterator::GET_MATCH<strong>preg_match()</strong> を参照ください。
                        RegexIterator::MATCH<strong>preg_match()</strong> を参照ください。 RegexIterator::REPLACE な
                        し。 RegexIterator::SPLIT<strong>preg_split()</strong> を参照ください。

<comment>See Also:</comment>
   * <strong>preg_match()</strong>
   * <strong>preg_match_all()</strong>
   * <strong>preg_replace()</strong>
   * <strong>preg_split()</strong>


id: RegexIterator::accept
type: function
doc:
<comment>Description:</comment>
  受け入れ状況を取得する
  
  <return>(string)</return>RegexIterator::current (RegexIterator::USE_KEY フラグが設定されている場合は
  RegexIterator::key) を正規表現でマッチさせます。

<comment>Return:</comment>
  <info>bool</info>  マッチした場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * RegexIterator 定数
   * RegexIterator::setFlags


id: RegexIterator::getFlags
type: function
doc:
<comment>Description:</comment>
  フラグを取得する
  
  フラグを返します。使用可能なフラグの一覧は RegexIterator::setFlags を参照ください。

<comment>Return:</comment>
  <info>int</info>  設定されているフラグを返します。

<comment>See Also:</comment>
   * RegexIterator::setFlags


id: RegexIterator::getMode
type: function
doc:
<comment>Description:</comment>
  操作モードを返す
  
  操作モードを返します。操作モードの一覧は RegexIterator::setMode を参照ください。

<comment>Return:</comment>
  <info>int</info>  操作モードを返します。

<comment>See Also:</comment>
   * RegexIterator::setMode


id: RegexIterator::getPregFlags
type: function
doc:
<comment>Description:</comment>
  正規表現フラグを返す
  
  正規表現フラグを返します。使用可能なフラグの一覧は RegexIterator::__construct を参照ください。

<comment>Return:</comment>
  <info>int</info>  正規表現フラグのビットマスクを返します。

<comment>See Also:</comment>
   * RegexIterator::setPregFlags


id: RegexIterator::getRegex
type: function
doc:
<comment>Description:</comment>
  現在の正規表現を返す
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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


id: RegexIterator::setFlags
type: function
doc:
<comment>Description:</comment>
  フラグを設定する
  
  フラグを設定します。

<comment>Param:</comment>
  <info>int</info>  <strong>$flags</strong>  設定するフラグ。クラス定数のビットマスクで指定します。
               
               利用できるフラグは次のとおりです。これらのフラグの実際の意味については 定義済みの定数
               で説明します。 <class>RegexIterator</class> のフラグ値定数1RegexIterator::USE_KEY

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

<comment>See Also:</comment>
   * RegexIterator::getFlags


id: RegexIterator::setMode
type: function
doc:
<comment>Description:</comment>
  操作モードを設定する
  
  操作モードを設定します。

<comment>Param:</comment>
  <info>int</info>  <strong>$mode</strong>  操作モード。
              
              操作モードは次のとおりです。これらのモードの実際の意味については 定義済みの定数 で説明
              します。 <class>RegexIterator</class> のモード値定数
              0RegexIterator::MATCH1RegexIterator::GET_MATCH2RegexIterator::ALL_MATCHES3RegexIterator::SPLIT4RegexIterator::REPLACE

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

<comment>See Also:</comment>
   * RegexIterator::getMode


id: RegexIterator::setPregFlags
type: function
doc:
<comment>Description:</comment>
  正規表現フラグを設定する
  
  正規表現フラグを設定します。

<comment>Param:</comment>
  <info>int</info>  <strong>$pregFlags</strong>  正規表現フラグ。利用できるフラグの概要は RegexIterator::__construct を参照くださ
                   い。

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

<comment>See Also:</comment>
   * RegexIterator::getPregFlags


id: ResourceBundle
type: class
doc:
<comment>Description:</comment>
  ローカライズしたソフトウェア製品には、 現在のロケールによって切り替えるデータのセットが必要となる
  ことがよくあります。 たとえばメッセージやラベル、書式パターンなどです。 ICU のリソース機能を使う
  と、リソースセットを定義することができます。 ロケールに基づいてアプリケーションからこれを読み込
  み、 ロケールにかかわらず統一された方法でアクセスすることができます。
  
  このクラスは ICU のリソースデータファイルへのアクセスを実装しています。 このファイルはバイナリデー
  タの配列で、ICU がローカライズしたデータを保存するために使っています。
  
  ICU リソースバンドルには、シンプルなリソースと複雑なリソースを保持することができます。 複雑なリ
  ソースとはコンテナ形式のもので、数値添字あるいは文字列添字 (PHP の配列と同じ) のいずれかの形式にな
  ります。シンプルなリソースは 文字列、整数、バイナリデータフィールド、整数の配列 のいずれかの型とな
  ります。
  
  <class>ResourceBundle</class> からデータにアクセスするには、 配列を使う方法と foreach を使う方法、そしてクラスメ
  ソッドを使う方法があります。 シンプルなリソースの場合は PHP の値、複雑なリソースの場合は
  <class>ResourceBundle</class> オブジェクトとして取得できます。 リソースはすべて読み込み専用となります。


id: ResourceBundle::__construct
type: function
doc:
<comment>Description:</comment>
  リソースバンドルを作成する
  
  オブジェクト指向型 (メソッド)
  
  手続き型
  
  オブジェクト指向型 (コンストラクタ):
  
  リソースバンドルを作成します。

<comment>Param:</comment>
  <info>string|null</info>  <strong>$locale</strong>    リソースバンドルを読み込むロケール (en_CA などのロケール名)。
  <info>string|null</info>  <strong>$bundle</strong>    データが格納されているディレクトリ、あるいは .dat ファイル名。
  <info>bool</info>         <strong>$fallback</strong>  ロケールを完全一致とするか、あるいは代替として親ロケールを使うことを許可す
                          るか。

<comment>Return:</comment>
  <info>ResourceBundle|null</info>  <class>ResourceBundle</class> オブジェクト、あるいはエラー時に <info>null</info> を返します。

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


id: ResourceBundle::count
type: function
doc:
<comment>Description:</comment>
  バンドル内の要素数を取得する
  
  オブジェクト指向型
  
  手続き型
  
  バンドル内の要素数を取得します。

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

<comment>Return:</comment>
  <info>int</info>  バンドル内の要素数を返します。

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


id: ResourceBundle::get
type: function
doc:
<comment>Description:</comment>
  バンドルからデータを取得する
  
  オブジェクト指向型
  
  手続き型
  
  インデックスあるいは文字列キーを指定して、バンドルからデータを取得します。

<comment>Param:</comment>
  <info>ResourceBundle</info>  <strong>$bundle</strong>    <class>ResourceBundle</class> オブジェクト。
  <info>string|int</info>      <strong>$index</strong>     データのインデックス。文字列あるいは整数値となります。
  <info>bool</info>            <strong>$fallback</strong>  ロケールが正確にマッチしなければ、 親のロケールにfallback することを許
                             すかどうか

<comment>Return:</comment>
  <info>mixed</info>  指定したインデックスのデータ、あるいはエラー時に <info>null</info> を返します。 文字列、整数値、バイナリ
         データ文字列は、それぞれに対応する PHP の型として返します。 整数の配列は PHP の配列として返
         します。複雑な型は <class>ResourceBundle</class> オブジェクトとして返します。

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


id: ResourceBundle::getErrorCode
type: function
doc:
<comment>Description:</comment>
  バンドルの直近のエラーコードを取得する
  
  オブジェクト指向型
  
  手続き型
  
  バンドルオブジェクトが最後に実行した関数のエラーコードを取得します。

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

<comment>Return:</comment>
  <info>int</info>  バンドルオブジェクトの最後の関数コールからのエラーコードを返します。

<comment>See Also:</comment>
   * <strong>resourcebundle_get_error_message()</strong>
   * <strong>intl_get_error_code()</strong>
   * <strong>intl_is_failure()</strong>


id: ResourceBundle::getErrorMessage
type: function
doc:
<comment>Description:</comment>
  バンドルの直近のエラーメッセージを取得する
  
  オブジェクト指向型
  
  手続き型
  
  バンドルオブジェクトが最後に実行した関数のエラーメッセージを取得します。

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

<comment>Return:</comment>
  <info>string</info>  バンドルオブジェクトの最後の関数コールからのエラーメッセージを返します。

<comment>See Also:</comment>
   * <strong>resourcebundle_get_error_code()</strong>
   * <strong>intl_get_error_code()</strong>
   * <strong>intl_is_failure()</strong>


id: ResourceBundle::getLocales
type: function
doc:
<comment>Description:</comment>
  サポートするロケールを取得する
  
  オブジェクト指向型
  
  手続き型
  
  ResourceBundle 名を指定して、サポートするロケールを取得します。

<comment>Param:</comment>
  <info>string</info>  <strong>$bundle</strong>  ロケールを取得したい ResourceBundle のパス、あるいは 空文字列を指定するとデフォル
                   トのロケール一覧を取得できます。

<comment>Return:</comment>
  <info>array|false</info>  このバンドルがサポートするロケールの一覧を返します。 失敗した場合は <info>false</info> を返しま
               す。

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


id: Result::__construct
type: function
doc:
<comment>Description:</comment>
  Result のコンストラクタ
  
  生成された ID や AUTO_INCREMENT の値、 警告を 結果セットから取得するためのオブジェクトです。


id: Result::getAffectedItemsCount
type: function
doc:
<comment>Description:</comment>
  影響を受けた行数を得る
  
  直近の操作によって、影響を受けた行数を取得します。

<comment>Return:</comment>
  <info>int</info>  影響を受けた行数(整数)を返します。


id: Result::getAutoIncrementValue
type: function
doc:
<comment>Description:</comment>
  自動インクリメントされた値を取得する
  
  最新の AUTO_INCREMENT の値 (最後に挿入されたid) を取得します

<comment>Return:</comment>
  <info>int</info>  最新の AUTO_INCREMENT の値 を返します。


id: Result::getGeneratedIds
type: function
doc:
<comment>Description:</comment>
  生成された id を取得する
  
  直近の操作から生成された _id の値を取得します。 ユニークな _id フィールドは MySQL サーバーによって
  生成されます。

<comment>Return:</comment>
  <info>array</info>  直近の操作によって生成された _id の配列を返します。 生成された _id がない場合は、空の配列を
         返します。


id: Result::getWarnings
type: function
doc:
<comment>Description:</comment>
  直近の操作から発生した警告を取得する
  
  直近の Result に対するの操作から発生した警告を取得します。

<comment>Return:</comment>
  <info>array</info>  直近の操作から発生した警告オブジェクトの配列。 個々のオブジェクトはエラーの 'message' と
         'level' と 'code' を定義しています。 エラーが発生していない場合は、空の配列が返されます。


id: Result::getWarningsCount
type: function
doc:
<comment>Description:</comment>
  直近の操作から生じた警告の数を取得する
  
  直近の操作から生じた警告の数を取得します。

<comment>Return:</comment>
  <info>int</info>  直近の操作から生じた警告の数を返します。


id: ReturnTypeWillChange
type: class
doc:
<comment>Description:</comment>
  ほとんどの final でない内部メソッドは、 それをオーバライドする際、 互換性がある戻り値の型を宣言す
  ることが必須になっています。 そうしない場合、継承が有効かを検証する際に、 推奨されない警告が発生し
  ます。 PHP のバージョン間の互換性を保ちたいがために、 戻り値の型を宣言できない場合、 アトリビュー
  ト #[\ReturnTypeWillChange] を追加することで警告を抑止できます。


id: ReturnTypeWillChange::__construct
type: function
doc:
<comment>Description:</comment>
  新しい ReturnTypeWillChange のインスタンスを作成する
  
  新しい <class>ReturnTypeWillChange</class> のインスタンスを作成します。


id: RowResult::fetchAll
type: function
doc:
<comment>Description:</comment>
  結果セットから全ての行を取得する
  
  結果セットから全ての行を取得します。

<comment>Return:</comment>
  <info>array</info>  クエリで取得した全ての結果を含む、数値インデックスの配列。 個々の結果は連想配列です。行が存
         在しない場合は、空の配列が返されます。


id: RowResult::fetchOne
type: function
doc:
<comment>Description:</comment>
  結果セットから行を取得する
  
  結果セットから一行取得します。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>array</info>  結果を連想配列として返します。 結果が存在しない場合は <info>null</info> を返します。


id: RowResult::getColumnNames
type: function
doc:
<comment>Description:</comment>
  全てのカラム名を取得する
  
  結果セットに存在するカラム名を全て取得します。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>array</info>  インデックスが数字のカラム名の配列を返します。 結果セットが空の場合は、空の配列を返します。


id: RowResult::getColumns
type: function
doc:
<comment>Description:</comment>
  カラムのメタデータを取得する
  
  結果セットに存在するカラムのメタデータを取得します。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>array</info>  結果のカラムを表現する FieldMetadata オブジェクトの配列を返します。 結果セットが空の場合
         は、空の配列を返します。


id: RowResult::getColumnsCount
type: function
doc:
<comment>Description:</comment>
  カラムの数を取得する
  
  結果セットに存在するカラムの数を取得します。

<comment>Return:</comment>
  <info>int</info>  カラムの数を返します。カラムが存在しない場合は 0 を返します。


id: RowResult::getWarnings
type: function
doc:
<comment>Description:</comment>
  直近の操作から生じた警告を取得する
  
  直近の RowResult の操作から生じた警告を取得します。

<comment>Return:</comment>
  <info>array</info>  直近の操作から発生した警告オブジェクトの配列。 個々のオブジェクトはエラーの 'message' と
         'level' と 'code' を定義しています。 エラーが発生していない場合は、空の配列が返されます。


id: RowResult::getWarningsCount
type: function
doc:
<comment>Description:</comment>
  直近の操作から生じた警告の数を取得する
  
  直近の RowResult への操作から生じた警告の数を取得します。

<comment>Return:</comment>
  <info>int</info>  直近の操作から生じた警告の数を返します。


id: SCM_RIGHTS
type: constant
doc:
<comment>Description:</comment>
  Send or receive a set of  open  file  descriptors  from  another process.


id: SEASLOG_ALERT
type: constant
doc:
<comment>Description:</comment>
  "ALERT" - Action must be taken immediately.Immediate attention should be given to relevant
  personnel for emergency repairs.


id: SEASLOG_CRITICAL
type: constant
doc:
<comment>Description:</comment>
  "CRITICAL" - Critical conditions.Need to be repaired immediately, and the program component is
  unavailable.


id: SEASLOG_DEBUG
type: constant
doc:
<comment>Description:</comment>
  "DEBUG" - Detailed debug information.Fine-grained information events.


id: SEASLOG_ERROR
type: constant
doc:
<comment>Description:</comment>
  "ERROR" - Runtime errors that do not require immediate action but should typically.


id: SEASLOG_INFO
type: constant
doc:
<comment>Description:</comment>
  "INFO" - Interesting events.Emphasizes the running process of the application.


id: SEASLOG_NOTICE
type: constant
doc:
<comment>Description:</comment>
  "NOTICE" - Normal but significant events.Information that is more important than the INFO level
  during execution.


id: SEASLOG_WARNING
type: constant
doc:
<comment>Description:</comment>
  "WARNING" - Exceptional occurrences that are not errors.Potentially aberrant information that
  needs attention and needs to be repaired.


id: SID
type: constant
doc:
<comment>Description:</comment>
  <return>"name=ID"</return> 形式でセッション名とセッション ID を格納している定数。 セッション ID がセッションクッ
  キーに適切にセットされている場合には空文字列が入る。 これは <strong>session_id()</strong> が返す ID と同一になる。


id: SIMDJSON_ERR_CAPACITY
type: constant
doc:
<comment>Description:</comment>
  This parser can't support a document that big. Thrown when parsing a JSON string that is over 4GiB
  long.


id: SIMDJSON_ERR_DEPTH_ERROR
type: constant
doc:
<comment>Description:</comment>
  The JSON document was too deep (too many nested objects and arrays)


id: SIMDJSON_ERR_INVALID_JSON_POINTER
type: constant
doc:
<comment>Description:</comment>
  Invalid JSON pointer syntax in <strong>simdjson_key_value()</strong> and other functions accepting a JSON pointer
  $key.


id: SIMDJSON_ERR_INVALID_PROPERTY
type: constant
doc:
<comment>Description:</comment>
  Invalid property name for an <class>stdClass</class> when decoding a value with <strong>simdjson_decode()</strong> or
  <strong>simdjson_key_value()</strong>


id: SIMDJSON_ERR_NUMBER_OUT_OF_RANGE
type: constant
doc:
<comment>Description:</comment>
  The JSON number is too large or too small to fit within the requested type. Note that the C
  simdjson library is a fork and this error is ignored to match php's handling of JSON numbers that
  are too large or too small.


id: SIMDJSON_ERR_TAPE_ERROR
type: constant
doc:
<comment>Description:</comment>
  The JSON document has an improper structure: missing or superfluous commas, braces, missing keys,
  etc.


id: SIMDJSON_ERR_UNESCAPED_CHARS
type: constant
doc:
<comment>Description:</comment>
  Within strings, some characters must be escaped, we found unescaped characters


id: SIMDJSON_ERR_UNEXPECTED_ERROR
type: constant
doc:
<comment>Description:</comment>
  Unexpected error, consider reporting this problem as you may have found a bug in the simdjson PECL


id: SIMDJSON_ERR_UNSUPPORTED_ARCHITECTURE
type: constant
doc:
<comment>Description:</comment>
  simdjson does not have an implementation supported by this CPU architecture (perhaps it's a
  non-SIMD CPU?).


id: SNMP::ERRNO_MULTIPLE_SET_QUERIES
type: constant
doc:
<comment>Description:</comment>
  要求された SET 操作で複数のクエリを使います。 この操作はトランザクション内の操作ではないので、 二
  番目以降のクエリに型や値の問題があれば失敗するかもしれません。


id: SNMP::ERRNO_OID_NOT_INCREASING
type: constant
doc:
<comment>Description:</comment>
  SNMP エージェントが、(BULK)WALK コマンドの実行中に前の OID から増加していない OID に当たりました。
  リモート SNMP エージェントが偽物である可能性があります。


id: SNMP::__construct
type: function
doc:
<comment>Description:</comment>
  リモート SNMP エージェントへのセッションを表す SNMP インスタンスを作成する
  
  The function description goes here.

<comment>Param:</comment>
  <info>int</info>     <strong>$version</strong>    SNMP プロトコルのバージョン。 <info>SNMP::VERSION_1</info>、 <info>SNMP::VERSION_2C</info> あるいは
                      <info>SNMP::VERSION_3</info>。
  <info>string</info>  <strong>$hostname</strong>   SNMP エージェント。<strong>$hostname</strong> には、オプションでコロンに続けて SNMP エージェン
                      トのポートを指定できます。 IPv6 アドレスでポートを指定する場合は、アドレス部を
                      角括弧で囲まなければなりません。 <strong>$hostname</strong> で FQDN を使うと、その解決に使われ
                      るのは php-snmp ライブラリであり、Net-SNMP エンジンは使いません。 FQDN を指定
                      するときに IPv6 アドレスを使うには、FQDN を角括弧で囲まなければなりません。 い
                      くつか例を示します。 IPv4 (デフォルトのポート)127.0.0.1IPv6 (デフォルトのポー
                      ト)::1 あるいは [::1]IPv4 (ポートを指定)127.0.0.1:1161IPv6 (ポートを指
                      定)[::1]:1161FQDN (デフォルトのポート)host.domainFQDN (ポートを指
                      定)host.domain:1161FQDN (デフォルトのポート)、IPv6 アドレスを強制
                      [host.domain]FQDN (ポートを指定)、IPv6 アドレスを強制[host.domain]:1161
  <info>string</info>  <strong>$community</strong>  <strong>$community</strong> の目的は SNMP のバージョンによって異なります。
  <info>int</info>     <strong>$timeout</strong>    最初のタイムアウトまでのミリ秒数。
  <info>int</info>     <strong>$retries</strong>    タイムアウト発生時の再試行回数。

<comment>See Also:</comment>
   * SNMP::close


id: SNMP::close
type: function
doc:
<comment>Description:</comment>
  SNMP セッションを閉じる
  
  SNMP セッションオブジェクトを閉じます。

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

<comment>See Also:</comment>
   * SNMP::__construct


id: SNMP::get
type: function
doc:
<comment>Description:</comment>
  SNMP オブジェクトを取得する
  
  <strong>$objectId</strong> で指定した SNMP オブジェクトを GET クエリで取得します。

<comment>Param:</comment>
  <info>array|string</info>  <strong>$objectId</strong>      SNMP オブジェクト (OID)。
  <info>bool</info>          <strong>$preserveKeys</strong>  <strong>$objectId</strong> が配列のときに <strong>$preserveKeys</strong> を <info>true</info> にすると、結果のキーは
                               完全に <strong>$objectId</strong> となります。 それ以外の場合は
                               SNMP::oid_output_format プロパティを使ってキーの形式を判断します。

<comment>Return:</comment>
  <info>mixed</info>  <strong>$objectId</strong> で指定した SNMP オブジェクトの値を <strong>$objectId</strong> にあわせて文字列か配列で返します。
         エラー時には <info>false</info> を返します。

<comment>See Also:</comment>
   * SNMP::getErrno
   * SNMP::getError


id: SNMP::getErrno
type: function
doc:
<comment>Description:</comment>
  直近のエラーコードを取得する
  
  直近の SNMP リクエストのエラーコードを返します。

<comment>Return:</comment>
  <info>int</info>  定数のページで説明した SNMP エラーコードのいずれかを返します。

<comment>See Also:</comment>
   * SNMP::getError


id: SNMP::getError
type: function
doc:
<comment>Description:</comment>
  直近のエラーメッセージを取得する
  
  直近の SNMP リクエストのエラー文字列を返します。

<comment>Return:</comment>
  <info>string</info>  直近の SNMP リクエストからのエラーを表す文字列を返します。

<comment>See Also:</comment>
   * SNMP::getErrno


id: SNMP::getnext
type: function
doc:
<comment>Description:</comment>
  指定したオブジェクト ID に続く SNMP オブジェクトを取得する
  
  <strong>$objectId</strong> で指定したオブジェクトに続く SNMP オブジェクトの値を取得します。

<comment>Param:</comment>
  <info>array|string</info>  <strong>$objectId</strong>  SNMP オブジェクト (OID)。

<comment>Return:</comment>
  <info>mixed</info>  SNMP オブジェクトの値を <strong>$objectId</strong> にあわせて文字列か配列で返します。 エラー時には <info>false</info> を
         返します。

<comment>See Also:</comment>
   * SNMP::getErrno
   * SNMP::getError


id: SNMP::set
type: function
doc:
<comment>Description:</comment>
  SNMP オブジェクトの値を設定する
  
  リモート SNMP エージェントに対して、 <strong>$objectId</strong> で指定した SNMP オブジェクトの値を設定させます。

<comment>Param:</comment>
  <info>array|string</info>  <strong>$objectId</strong>  SNMP オブジェクト ID。
                           
                           object_id 配列の OID 数がオブジェクトの max_oids プロパティより多ければ、
                           set メソッドは複数のクエリで値の更新をしなければなりません。 この場合、型
                           や値のチェックはチャンク単位で行われるので、 二番目以降のクエリでリクエス
                           トする ODI に対して型や値の問題があれば失敗するかもしれません。 そのた
                           め、object_id 配列の OID 数が max_oids プロパティより多いときには警告が発
                           生します。
  <info>array|string</info>  <strong>$type</strong>      MIB は、オブジェクトIDごとのタイプを定義します。 これは、以下の一覧から指
                           定される一文字でなければなりません。
                           
                           SNMP ライブラリをコンパイルする際、 <info>OPAQUE_SPECIAL_TYPES</info> が定義されていた
                           場合、 以下も正しい値になります:
                           
                           これらの大半は、対応する ASN.1 の型を使います。's', 'x', 'd' および 'b'
                           はどれも OCTET STRING を異なる方法で表したものであり、'u' も Gauge32 値を
                           扱うためのものです。
                           
                           MIB ファイルが "snmp_read_mib" や libsnmp の設定で MIB ツリーに読み込まれ
                           ている場合は、 <strong>$type</strong> に '=' を使うことができます。 これはすべてのオブジェ
                           クト ID を表し、型は自動的に MIB から読み込みます。
                           
                           "SYNTAX    BITS {telnet(0), ftp(1), http(2), icmp(3), snmp(4), ssh(5),
                           https(6)}" のような BITS 型の値変数を設定する方法は二通りあることに注意し
                           ましょう。
                           
                           型として "b" を使い、ビット番号の一覧を指定する。この方法はおすすめしませ
                           ん。 同じ OID に対して GET クエリを実行しても 0xF8 などを返すからです。
                           
                           Using type "x" and a hex number but without(!) the usual "0x" prefix. 型
                           として "x" を使い、通常のプレフィックス "0x" をつけずに(!) 16 進数を指定
                           する。
                           
                           詳細は、サンプルを参照ください。
  <info>array|string</info>  <strong>$value</strong>     新しい値。

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

<comment>See Also:</comment>
   * SNMP::get


id: SNMP::setSecurity
type: function
doc:
<comment>Description:</comment>
  セキュリティ関連の SNMPv3 セッションパラメータを設定する
  
  setSecurity は、 SNMP プロトコルバージョン 3 で使うセキュリティ関連のセッションパラメータを設定し
  ます。

<comment>Param:</comment>
  <info>string</info>  <strong>$securityLevel</strong>      セキュリティレベル (noAuthNoPriv|authNoPriv|authPriv)。
  <info>string</info>  <strong>$authProtocol</strong>       認証プロトコル (MD5 あるいは SHA)。
  <info>string</info>  <strong>$authPassphrase</strong>     認証パスフレーズ。
  <info>string</info>  <strong>$privacyProtocol</strong>    プライバシープロトコル (DES あるいは AES)。
  <info>string</info>  <strong>$privacyPassphrase</strong>  プライバシーパスフレーズ。
  <info>string</info>  <strong>$contextName</strong>        コンテキスト名。
  <info>string</info>  <strong>$contextEngineId</strong>    コンテキスト EngineID。

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

<comment>See Also:</comment>
   * SNMP::__construct


id: SNMP::walk
type: function
doc:
<comment>Description:</comment>
  SNMP オブジェクトのサブツリーを取得する
  
  SNMP::walk を使い、 指定した <strong>$objectId</strong> を起点とする SNMP サブツリーを読み込みます。

<comment>Param:</comment>
  <info>array|string</info>  <strong>$objectId</strong>        取得するサブツリーのルート。
  <info>bool</info>          <strong>$suffixAsKey</strong>     デフォルトでは、完全な OID 記法を出力配列のキーとして使います。
                                 <info>true</info> にすると、サブツリーのプレフィックスはキーから取り除き、
                                 object_id のサフィックスだけを残します。
  <info>int</info>           <strong>$nonRepeaters</strong>    これは、渡された変数の中で反復処理の対象外とする変数の数を指定しま
                                 す。 デフォルトは、SNMP オブジェクトでの設定を使います。
  <info>int</info>           <strong>$maxRepetitions</strong>  これは、繰り返す変数の反復処理の最大数を指定します。 デフォルトは、
                                 SNMP オブジェクトでの設定を使います。

<comment>Return:</comment>
  <info>array|false</info>  成功した場合は SNMP オブジェクトの ID とその値の連想配列を返します。エラー時には
               <info>false</info> を返します。 SNMP エラーが発生した場合は、SNMP::getErrno および SNMP::getError
               を使えばエラー番号(SNMP 拡張モジュールで設定したもの。クラス定数を参照) とエラーメッ
               セージをそれぞれ取得できます。

<comment>See Also:</comment>
   * SNMP::getErrno
   * SNMP::getError


id: SOAP_1_1
type: constant
doc:
<comment>Description:</comment>
  <return>soap_version</return> オプションを SoapServer::__construct や SoapClient::__construct に渡す際、SOAP 1.1 を
  使うように指定します。


id: SOAP_1_2
type: constant
doc:
<comment>Description:</comment>
  <return>soap_version</return> オプションを SoapServer::__construct や SoapClient::__construct に渡す際、SOAP 1.2 を
  使うように指定します。


id: SOAP_AUTHENTICATION_BASIC
type: constant
doc:
<comment>Description:</comment>
  <return>authentication</return> オプションを SoapClient::__construct に渡す際、Basic 認証を使うことを指定します。


id: SOAP_AUTHENTICATION_DIGEST
type: constant
doc:
<comment>Description:</comment>
  <return>authentication</return> オプションを SoapClient::__construct に渡す際、Digest 認証を使うことを指定します。


id: SOAP_COMPRESSION_ACCEPT
type: constant
doc:
<comment>Description:</comment>
  <strong>$compression</strong> オプション の一部を SoapClient::__construct に渡す際、"Accept-Encoding" を使うことを
  指定します。


id: SOAP_COMPRESSION_DEFLATE
type: constant
doc:
<comment>Description:</comment>
  <strong>$compression</strong> オプション の一部を SoapClient::__construct に渡す際、deflate 圧縮 を使うことを指定し
  ます。


id: SOAP_COMPRESSION_GZIP
type: constant
doc:
<comment>Description:</comment>
  <strong>$compression</strong> オプション の一部を SoapClient::__construct に渡す際、gzip 圧縮 を使うことを指定しま
  す。


id: SOAP_DOCUMENT
type: constant
doc:
<comment>Description:</comment>
  <return>style</return> オプションを SoapClient::__construct に渡す際、ドキュメントのバインディングを使うよに指定し
  ます。


id: SOAP_ENCODED
type: constant
doc:
<comment>Description:</comment>
  <return>use</return> オプションを SoapClient::__construct に渡す際、SOAP エンコーディングを使うように指定します。


id: SOAP_LITERAL
type: constant
doc:
<comment>Description:</comment>
  <return>use</return> オプションを SoapClient::__construct に渡す際、サービス特有のエンコーディングを使うように指定
  します。


id: SOAP_RPC
type: constant
doc:
<comment>Description:</comment>
  <return>style</return> オプションを SoapClient::__construct に渡す際、RPC スタイルのバインディングを使うように指定
  します。


id: SOAP_SINGLE_ELEMENT_ARRAYS
type: constant
doc:
<comment>Description:</comment>
  <strong>$features</strong> オプション と一緒に、 SoapClient::__construct で使います。


id: SOAP_SSL_METHOD_SSLv2
type: constant
doc:
<comment>Description:</comment>
  推奨されていない <strong>$ssl_method</strong>オプション と一緒に、 SoapClient::__construct で使います。


id: SORTFROM
type: constant
doc:
<comment>Description:</comment>
  <strong>imap_sort()</strong> のソート条件。 メールボックスの最初の From アドレスでソートします。


id: SORT_ASC
type: constant
doc:
<comment>Description:</comment>
  <info>SORT_ASC</info>は、 <strong>array_multisort()</strong>でソート順を昇順にするために 使用されます。


id: SORT_DESC
type: constant
doc:
<comment>Description:</comment>
  <info>SORT_DESC</info>は、 <strong>array_multisort()</strong>でソート順を降順にするために 使用されます。


id: SORT_FLAG_CASE
type: constant
doc:
<comment>Description:</comment>
  <info>SORT_FLAG_CASE</info> は <info>SORT_STRING</info> や <info>SORT_NATURAL</info> と (ビット OR で) 組み合わせて使い、 文字列のソート
  で大文字小文字を区別しないようにします。 PHP 8.2.0 以降では、ASCII のケースフォールディングのみが
  行われます。


id: SORT_LOCALE_STRING
type: constant
doc:
<comment>Description:</comment>
  <info>SORT_LOCALE_STRING</info>は現在のロケールに基づいた 文字列として比較を行うために使用されます。


id: SORT_NATURAL
type: constant
doc:
<comment>Description:</comment>
  <info>SORT_NATURAL</info> は、要素の比較を文字列として行い、 <strong>natsort()</strong> と同様の「自然順」で比較します。


id: SO_REUSEPORT
type: constant
doc:
<comment>Description:</comment>
  この定数は、ソケットオプション <info>SO_REUSEPORT</info> に対応したプラットフォーム上でだけ使えます。 Linux,
  macOS や *BSD はこのソケットオプションに対応していますが、 Windows は対応していません。


id: SQLITE3_ASSOC
type: constant
doc:
<comment>Description:</comment>
  SQLite3_result::fetchArray が返す結果セットが、 カラム名をインデックスとする配列であることを指定し
  ます。


id: SQLITE3_BOTH
type: constant
doc:
<comment>Description:</comment>
  SQLite3_result::fetchArray が返す結果セットが、 カラム名とカラム番号の両方をインデックスとする配列
  であることを指定します。 カラム番号は 0 からはじまります。


id: SQLITE3_DETERMINISTIC
type: constant
doc:
<comment>Description:</comment>
  <strong>SQLite3::createFunction()</strong> で作成する関数が決定論的であることを指定します。 つまり、単一のSQL文の範
  囲では、同じ入力に対して常に同じ結果が返されるということです。 (PHP 7.1.4 以降で使用可能)


id: SQLITE3_NUM
type: constant
doc:
<comment>Description:</comment>
  SQLite3_result::fetchArray が返す結果セットが、 カラム番号をインデックスとする配列であることを指定
  します。 カラム番号は 0 からはじまります。


id: SQLSRV_CURSOR_BUFFERED
type: constant
doc:
<comment>Description:</comment>
  Creates a client-side cursor query. Lets you access rows in any order. For usage information, see
  Specifying a Cursor Type and Selecting Rows.


id: SQLSRV_CURSOR_DYNAMIC
type: constant
doc:
<comment>Description:</comment>
  Indicates a dynamic cursor. For usage information, see  Specifying a Cursor Type and Selecting
  Rows.


id: SQLSRV_CURSOR_FORWARD
type: constant
doc:
<comment>Description:</comment>
  Indicates a forward-only cursor. For usage information, see  Specifying a Cursor Type and
  Selecting Rows.


id: SQLSRV_CURSOR_KEYSET
type: constant
doc:
<comment>Description:</comment>
  Indicates a keyset cursor. For usage information, see  Specifying a Cursor Type and Selecting
  Rows.


id: SQLSRV_CURSOR_STATIC
type: constant
doc:
<comment>Description:</comment>
  Indicates a static cursor. For usage information, see  Specifying a Cursor Type and Selecting
  Rows.


id: SQLSRV_ENC_BINARY
type: constant
doc:
<comment>Description:</comment>
  Specifies that data is returned as a raw byte stream from the server without  performing encoding
  or translation. For usage information, see  How to: Specify PHP Types.


id: SQLSRV_ENC_CHAR
type: constant
doc:
<comment>Description:</comment>
  Data is returned in 8-bit characters as specified in the code page of the  Windows locale that is
  set on the system. Any multi-byte characters or characters  that do not map into this code page
  are substituted with a single byte question  mark (?) character. This is the default encoding. For
  usage information,  see How to: Specify PHP Types.


id: SQLSRV_ERR_ALL
type: constant
doc:
<comment>Description:</comment>
  Forces <strong>sqlsrv_errors()</strong> to return both errors and warings  when passed as a parameter (the default
  behavior).


id: SQLSRV_ERR_ERRORS
type: constant
doc:
<comment>Description:</comment>
  Forces <strong>sqlsrv_errors()</strong> to return errors only (no warnings)  when passed as a parameter.


id: SQLSRV_ERR_WARNINGS
type: constant
doc:
<comment>Description:</comment>
  Forces <strong>sqlsrv_errors()</strong> to return warnings only (no errors)  when passed as a parameter.


id: SQLSRV_FETCH_ASSOC
type: constant
doc:
<comment>Description:</comment>
  Forces <strong>sqlsrv_fetch_array()</strong> to return an associative  array when passed as a parameter.


id: SQLSRV_FETCH_BOTH
type: constant
doc:
<comment>Description:</comment>
  Forces <strong>sqlsrv_fetch_array()</strong> to return an array with both  associative and numeric keys when passed
  as a parameter (the default behavior).


id: SQLSRV_FETCH_NUMERIC
type: constant
doc:
<comment>Description:</comment>
  Forces <strong>sqlsrv_fetch_array()</strong> to return an array with  numeric when passed as a parameter.


id: SQLSRV_LOG_SEVERITY_ALL
type: constant
doc:
<comment>Description:</comment>
  Specifies that errors, warnings, and notices will be logged  when passed to <strong>sqlsrv_configure()</strong> as
  a parameter.


id: SQLSRV_LOG_SEVERITY_ERROR
type: constant
doc:
<comment>Description:</comment>
  Specifies that errors will be logged when passed to  <strong>sqlsrv_configure()</strong> as a parameter.


id: SQLSRV_LOG_SEVERITY_NOTICE
type: constant
doc:
<comment>Description:</comment>
  Specifies that notices will be logged when passed to  <strong>sqlsrv_configure()</strong> as a parameter.


id: SQLSRV_LOG_SEVERITY_WARNING
type: constant
doc:
<comment>Description:</comment>
  Specifies that warnings will be logged when passed to  <strong>sqlsrv_configure()</strong> as a parameter.


id: SQLSRV_LOG_SYSTEM_ALL
type: constant
doc:
<comment>Description:</comment>
  Turns on logging of all subsystems when passed to  <strong>sqlsrv_configure()</strong> as a parameter.


id: SQLSRV_LOG_SYSTEM_CONN
type: constant
doc:
<comment>Description:</comment>
  Turns on logging of connection activity when passed to  <strong>sqlsrv_configure()</strong> as a parameter.


id: SQLSRV_LOG_SYSTEM_INIT
type: constant
doc:
<comment>Description:</comment>
  Turns on logging of initialization activity when passed to  <strong>sqlsrv_configure()</strong> as a parameter.


id: SQLSRV_LOG_SYSTEM_OFF
type: constant
doc:
<comment>Description:</comment>
  Turns off logging of all subsystems when passed to  <strong>sqlsrv_configure()</strong> as a parameter.


id: SQLSRV_LOG_SYSTEM_STMT
type: constant
doc:
<comment>Description:</comment>
  Turns on logging of statement activity when passed to  <strong>sqlsrv_configure()</strong> as a parameter.


id: SQLSRV_LOG_SYSTEM_UTIL
type: constant
doc:
<comment>Description:</comment>
  Turns on logging of error function activity when passed to  <strong>sqlsrv_configure()</strong> as a parameter.


id: SQLSRV_PARAM_IN
type: constant
doc:
<comment>Description:</comment>
  Indicates an input parameter when passed to <strong>sqlsrv_query()</strong>  or <strong>sqlsrv_prepare()</strong>.


id: SQLSRV_PARAM_INOUT
type: constant
doc:
<comment>Description:</comment>
  Indicates a bidirectional parameter when passed to <strong>sqlsrv_query()</strong>  or <strong>sqlsrv_prepare()</strong>.


id: SQLSRV_PARAM_OUT
type: constant
doc:
<comment>Description:</comment>
  Indicates an output parameter when passed to <strong>sqlsrv_query()</strong> or  <strong>sqlsrv_prepare()</strong>.


id: SQLSRV_PHPTYPE_DATETIME
type: constant
doc:
<comment>Description:</comment>
  Specifies a datetime PHP data type. For usage information, see  How to: Specify PHP Types.


id: SQLSRV_PHPTYPE_FLOAT
type: constant
doc:
<comment>Description:</comment>
  Specifies a float PHP data type. For usage information, see  How to: Specify PHP Types.


id: SQLSRV_PHPTYPE_INT
type: constant
doc:
<comment>Description:</comment>
  Specifies an integer PHP data type. For usage information, see  How to: Specify PHP Types.


id: SQLSRV_PHPTYPE_STREAM
type: constant
doc:
<comment>Description:</comment>
  Specifies a PHP stream. This constant works like a function and accepts an  encoding constant. See
  the SQLSRV_ENC_* constants. For usage information, see  How to: Specify PHP Types.


id: SQLSRV_PHPTYPE_STRING
type: constant
doc:
<comment>Description:</comment>
  Specifies a string PHP data type. This constant works like a function and  accepts an encoding
  constant. See the SQLSRV_ENC_* constants. For usage information,  see How to: Specify PHP Types.


id: SQLSRV_SCROLL_ABSOLUTE
type: constant
doc:
<comment>Description:</comment>
  Specifies which row to select in a result set. For usage information, see  Specifying a Cursor
  Type and Selecting Rows.


id: SQLSRV_SQLTYPE_BIGINT
type: constant
doc:
<comment>Description:</comment>
  Describes the bigint SQL Server data type. For usage information, see  How to: Specify SQL Types.


id: SQLSRV_SQLTYPE_BINARY
type: constant
doc:
<comment>Description:</comment>
  Describes the binary SQL Server data type. For usage information, see  How to: Specify SQL Types.


id: SQLSRV_SQLTYPE_BIT
type: constant
doc:
<comment>Description:</comment>
  Describes the bit SQL Server data type. For usage information, see  How to: Specify SQL Types.


id: SQLSRV_SQLTYPE_CHAR
type: constant
doc:
<comment>Description:</comment>
  Describes the char SQL Server data type. This constant works like a function  and accepts a
  parameter indicating the number characters. For usage information,  see How to: Specify SQL Types.


id: SQLSRV_SQLTYPE_DATE
type: constant
doc:
<comment>Description:</comment>
  Describes the date SQL Server data type. For usage information, see  How to: Specify SQL Types.


id: SQLSRV_SQLTYPE_DATETIME
type: constant
doc:
<comment>Description:</comment>
  Describes the datetime SQL Server data type. For usage information, see  How to: Specify SQL
  Types.


id: SQLSRV_SQLTYPE_DATETIME2
type: constant
doc:
<comment>Description:</comment>
  Describes the datetime2 SQL Server data type. For usage information, see  How to: Specify SQL
  Types.


id: SQLSRV_SQLTYPE_DATETIMEOFFSET
type: constant
doc:
<comment>Description:</comment>
  Describes the datetimeoffset SQL Server data type. For usage information, see  How to: Specify SQL
  Types.


id: SQLSRV_SQLTYPE_DECIMAL
type: constant
doc:
<comment>Description:</comment>
  Describes the decimal SQL Server data type. This constant works like a function  and accepts two
  parameters indicating (in order) precision and scale. For usage information,  see How to: Specify
  SQL Types.


id: SQLSRV_SQLTYPE_FLOAT
type: constant
doc:
<comment>Description:</comment>
  Describes the float SQL Server data type. For usage information, see  How to: Specify SQL Types.


id: SQLSRV_SQLTYPE_IMAGE
type: constant
doc:
<comment>Description:</comment>
  Describes the image SQL Server data type. For usage information, see  How to: Specify SQL Types.


id: SQLSRV_SQLTYPE_INT
type: constant
doc:
<comment>Description:</comment>
  Describes the int SQL Server data type. For usage information, see  How to: Specify SQL Types.


id: SQLSRV_SQLTYPE_MONEY
type: constant
doc:
<comment>Description:</comment>
  Describes the money SQL Server data type. For usage information, see  How to: Specify SQL Types.


id: SQLSRV_SQLTYPE_NCHAR
type: constant
doc:
<comment>Description:</comment>
  Describes the nchar SQL Server data type. This constant works like a function  and accepts a
  single parameter indicating the character count. For usage information,  see How to: Specify SQL
  Types.


id: SQLSRV_SQLTYPE_NTEXT
type: constant
doc:
<comment>Description:</comment>
  Describes the ntext SQL Server data type. For usage information, see  How to: Specify SQL Types.


id: SQLSRV_SQLTYPE_NUMERIC
type: constant
doc:
<comment>Description:</comment>
  Describes the numeric SQL Server data type. This constant works like a function  and accepts two
  parameter indicating (in order) precision and scale. For usage  information, see How to: Specify
  SQL Types.


id: SQLSRV_SQLTYPE_NVARCHAR
type: constant
doc:
<comment>Description:</comment>
  Describes the nvarchar SQL Server data type. This constant works like a function  and accepts a
  single parameter indicating the character count. For usage  information, see How to: Specify SQL
  Types.


id: SQLSRV_SQLTYPE_REAL
type: constant
doc:
<comment>Description:</comment>
  Describes the real SQL Server data type. For usage information, see  How to: Specify SQL Types.


id: SQLSRV_SQLTYPE_SMALLDATETIME
type: constant
doc:
<comment>Description:</comment>
  Describes the smalldatetime SQL Server data type. For usage information, see  How to: Specify SQL
  Types.


id: SQLSRV_SQLTYPE_SMALLINT
type: constant
doc:
<comment>Description:</comment>
  Describes the smallint SQL Server data type. For usage information, see  How to: Specify SQL
  Types.


id: SQLSRV_SQLTYPE_SMALLMONEY
type: constant
doc:
<comment>Description:</comment>
  Describes the smallmoney SQL Server data type. For usage information, see  How to: Specify SQL
  Types.


id: SQLSRV_SQLTYPE_TEXT
type: constant
doc:
<comment>Description:</comment>
  Describes the text SQL Server data type. For usage information, see  How to: Specify SQL Types.


id: SQLSRV_SQLTYPE_TIME
type: constant
doc:
<comment>Description:</comment>
  Describes the time SQL Server data type. For usage information, see  How to: Specify SQL Types.


id: SQLSRV_SQLTYPE_TIMESTAMP
type: constant
doc:
<comment>Description:</comment>
  Describes the timestamp SQL Server data type. For usage information, see  How to: Specify SQL
  Types.


id: SQLSRV_SQLTYPE_TINYINT
type: constant
doc:
<comment>Description:</comment>
  Describes the tinyint SQL Server data type. For usage information, see  How to: Specify SQL Types.


id: SQLSRV_SQLTYPE_UDT
type: constant
doc:
<comment>Description:</comment>
  Describes the UDT SQL Server data type. For usage information, see  How to: Specify SQL Types.


id: SQLSRV_SQLTYPE_UNIQUEIDENTIFIER
type: constant
doc:
<comment>Description:</comment>
  Describes the uniqueidentifier SQL Server data type. For usage information, see  How to: Specify
  SQL Types.


id: SQLSRV_SQLTYPE_VARBINARY
type: constant
doc:
<comment>Description:</comment>
  Describes the varbinary SQL Server data type. This constant works like a function  and accepts a
  single parameter indicating the byte count. For usage information,  see How to: Specify SQL Types.


id: SQLSRV_SQLTYPE_VARCHAR
type: constant
doc:
<comment>Description:</comment>
  Describes the varchar SQL Server data type. This constant works like a function  and accepts a
  single parameter indicating the character count. For usage information,  see How to: Specify SQL
  Types.


id: SQLSRV_SQLTYPE_XML
type: constant
doc:
<comment>Description:</comment>
  Describes the XML SQL Server data type. For usage information, see  How to: Specify SQL Types.


id: SQLSRV_TXN_READ_COMMITTED
type: constant
doc:
<comment>Description:</comment>
  Indicates a transaction isolation level of READ COMMITTED. This value is  used to set the
  TransactionIsolation level in the $connectionOptions array  passed to <strong>sqlsrv_connect()</strong>.


id: SQLSRV_TXN_READ_SERIALIZABLE
type: constant
doc:
<comment>Description:</comment>
  Indicates a transaction isolation level of SERIALIZABLE. This value is used  to set the
  TransactionIsolation level in the $connectionOptions array passed  to <strong>sqlsrv_connect()</strong>.


id: SQLSRV_TXN_READ_UNCOMMITTED
type: constant
doc:
<comment>Description:</comment>
  Indicates a transaction isolation level of READ UNCOMMITTED. This value is  used to set the
  TransactionIsolation level in the $connectionOptions array  passed to <strong>sqlsrv_connect()</strong>.


id: SQLSRV_TXN_REPEATABLE_READ
type: constant
doc:
<comment>Description:</comment>
  Indicates a transaction isolation level of REPEATABLE READ. This value is  used to set the
  TransactionIsolation level in the $connectionOptions array  passed to <strong>sqlsrv_connect()</strong>.


id: SQLSRV_TXN_SNAPSHOT
type: constant
doc:
<comment>Description:</comment>
  Indicates a transaction isolation level of SNAPSHOT. This value is used to  set the
  TransactionIsolation level in the $connectionOptions array passed  to <strong>sqlsrv_connect()</strong>.


id: SQLT_AFC
type: constant
doc:
<comment>Description:</comment>
  <strong>oci_bind_array_by_name()</strong> で CHAR の配列をバインドする場合に使います。


id: SQLT_AVC
type: constant
doc:
<comment>Description:</comment>
  <strong>oci_bind_array_by_name()</strong> で CHARZ の配列をバインドする場合に使います。


id: SQLT_CHR
type: constant
doc:
<comment>Description:</comment>
  <strong>oci_bind_array_by_name()</strong> で VARCHAR2 の配列をバインドする場合に使います。 <strong>oci_bind_by_name()</strong> でも
  使います。


id: SQLT_FLT
type: constant
doc:
<comment>Description:</comment>
  <strong>oci_bind_array_by_name()</strong> で FLOAT の配列をバインドする場合に使います。


id: SQLT_LVC
type: constant
doc:
<comment>Description:</comment>
  <strong>oci_bind_array_by_name()</strong> で LONG VARCHAR の配列をバインドする場合に使います。


id: SQLT_ODT
type: constant
doc:
<comment>Description:</comment>
  <strong>oci_bind_array_by_name()</strong> で LONG の配列をバインドする場合に使います。


id: SQLT_STR
type: constant
doc:
<comment>Description:</comment>
  <strong>oci_bind_array_by_name()</strong> で STRING の配列をバインドする場合に使います。


id: SQLT_VCS
type: constant
doc:
<comment>Description:</comment>
  <strong>oci_bind_array_by_name()</strong> で VARCHAR の配列をバインドする際に使います。


id: SQLite3::__construct
type: function
doc:
<comment>Description:</comment>
  SQLite3 オブジェクトを作成し、SQLite 3 データベースをオープンする
    
  
  SQLite3 オブジェクトを作成し、SQLite 3 データベースをオープンします。 暗号化込みでビルドされている
  場合は、キーの使用を試みます。

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>       SQLite データベースへのパス。インメモリデータベースを使う場合は <return>:memory:</return>
                          を指定します。 <strong>$filename</strong> に空文字列を指定すると、 プライベート、かつ一時的
                          なデータベースがディスク上に作成されます。 このプライベートなデータベース
                          は、データベース接続が閉じられるとすぐに自動的に削除されます。
  <info>int</info>     <strong>$flags</strong>          SQLite データベースのオープン方法を指定するフラグ。 デフォルトでは
                          <return>SQLITE3_OPEN_READWRITE | SQLITE3_OPEN_CREATE</return> を使用してオープンします。
                          <return>SQLITE3_OPEN_READONLY</return>: データベースを読み込み専用でオープンする
                          <return>SQLITE3_OPEN_READWRITE</return>: データベースを読み書き共用でオープンする
                          <return>SQLITE3_OPEN_CREATE</return>: データベースが存在しない場合は作成する
                          
                          <return>SQLITE3_OPEN_READONLY</return>: データベースを読み込み専用でオープンする
                          
                          <return>SQLITE3_OPEN_READWRITE</return>: データベースを読み書き共用でオープンする
                          
                          <return>SQLITE3_OPEN_CREATE</return>: データベースが存在しない場合は作成する
  <info>string</info>  <strong>$encryptionKey</strong>  オプションの暗号キー。SQLite データベースの暗号化と復号に使用します。 暗号
                          化モジュールがインストールされていない場合は、このパラメータは何の影響も及
                          ぼしません。


id: SQLite3::backup
type: function
doc:
<comment>Description:</comment>
  あるデータベースを、別のデータベースにバックアップする
  
  SQLite3::backup は、あるデータベースの内容を別のデータベースにコピーし、 コピー先のデータベースの
  内容を上書きします。 このメソッドは、データベースのバックアップを作成したり、 インメモリのデータ
  ベースを永続的なファイルにコピーしたり、その逆を行う場合に便利です。
  
  SQLite 3.27.0 (2019-02-07) 以降のバージョンでは、 データベースを新しいファイルにバックアップする
  SQLとして <return>VACUUM INTO 'file.db';</return> も使えます。

<comment>Param:</comment>
  <info>SQLite3</info>  <strong>$destination</strong>          SQLite3::open でオープンされたデータベース接続
  <info>string</info>   <strong>$sourceDatabase</strong>       メインデータベースの場合、データベース名は <return>"main"</return> です。 一時的な
                                 データベースの場合は、<return>"temp"</return> になります。 また、<return>ATTACH</return> 文の <return>AS</return> キー
                                 ワードの後に指定された名前が使えます。
  <info>string</info>   <strong>$destinationDatabase</strong>  <strong>$sourceDatabase</strong> に似ていますが、 <strong>$destination</strong> で接続したコピー先の
                                 データベースを表します。

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


id: SQLite3::busyTimeout
type: function
doc:
<comment>Description:</comment>
  接続がビジー状態のときのハンドラを設定する
  
  ビジーハンドラを設定します。 これは、データベースのロックが解除されるかあるいはタイムアウトに達す
  るまでスリープさせます。

<comment>Param:</comment>
  <info>int</info>  <strong>$milliseconds</strong>  スリープさせる時間 (ミリ秒)。この値をゼロ以下にすると、 すでに設定されているタ
                      イムアウトハンドラを無効にします。

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


id: SQLite3::changes
type: function
doc:
<comment>Description:</comment>
  直近の SQL 文で変更 (あるいは挿入、削除) された行の数を返す
    
  
  直近の SQL 文で変更 (あるいは挿入、削除) された行の数を返します。

<comment>Return:</comment>
  <info>int</info>  直近の SQL 文で変更 (あるいは挿入、削除) された行の数を表す <info>int</info> 値を返します。


id: SQLite3::close
type: function
doc:
<comment>Description:</comment>
  データベースとの接続を閉じる
  
  データベースとの接続を閉じます。

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


id: SQLite3::createAggregate
type: function
doc:
<comment>Description:</comment>
  SQL の集約関数として使用する PHP 関数を登録する
  
  SQL の集約関数として使用する PHP 関数を登録します。 これは SQL 文の中で使用されるものです。

<comment>Param:</comment>
  <info>string</info>    <strong>$name</strong>           作成あるいは再定義したい SQL 集約関数の名前。
  <info>callable</info>  <strong>$stepCallback</strong>   結果セットの各行ごとにコールされるコールバック関数。 この関数で結果を集
                            約し、集約処理のコンテキストに保存すべきです。
                            
                            このコールバック関数は、以下のように定義すべきです:
                            <info>mixed</info>step<info>mixed</info><strong>$context</strong><info>int</info><strong>$rownumber</strong><info>mixed</info><strong>$value</strong><info>mixed</info><strong>$values</strong> <strong>$context</strong> 最初
                            の行では <info>null</info> です。 2行目以降は、step 関数から返された値をとります。 こ
                            れは、集約の状況を管理するのに使います。 <strong>$rownumber</strong> 現在の行番号 <strong>$value</strong>
                            集約に渡されるはじめの引数 <strong>$values</strong> 集約に渡されるふたつめ以降の引数  こ
                            の関数の戻り値は、 次のステップで呼ばれる際、または finalize 関数での
                            <strong>$context</strong> の引数として使われます。
                            
                            最初の行では <info>null</info> です。 2行目以降は、step 関数から返された値をとりま
                            す。 これは、集約の状況を管理するのに使います。
                            
                            現在の行番号
                            
                            集約に渡されるはじめの引数
                            
                            集約に渡されるふたつめ以降の引数
  <info>mixed</info>     <strong>$context</strong>        最初の行では <info>null</info> です。 2行目以降は、step 関数から返された値をとりま
                            す。 これは、集約の状況を管理するのに使います。
  <info>int</info>       <strong>$rownumber</strong>      現在の行番号
  <info>mixed</info>     <strong>$value</strong>          集約に渡されるはじめの引数
  <info>mixed</info>     <strong>$values</strong>         集約に渡されるふたつめ以降の引数
  <info>callable</info>  <strong>$finalCallback</strong>  各行からの "段階的に処理された" データを集約するコールバック関数です。
                            いったん全データが処理されると、この関数が呼ばれます。 集約処理のコンテ
                            キストからデータを取り出し、結果を返すべきです。 このコールバック関数は
                            SQLite が理解する型を返します。 (例: スカラー型)
                            
                            このコールバック関数は、以下のように定義すべきです:
                            <info>mixed</info>fini<info>mixed</info><strong>$context</strong><info>int</info><strong>$rownumber</strong> <strong>$context</strong> 最後に呼ばれた step 関数か
                            ら返された値を保持します。 <strong>$rownumber</strong> 常に <return>0</return>.  この関数の戻り値は、集約
                            の戻り値として使われます。
                            
                            最後に呼ばれた step 関数から返された値を保持します。
                            
                            常に <return>0</return>.
  <info>mixed</info>     <strong>$context</strong>        最後に呼ばれた step 関数から返された値を保持します。
  <info>int</info>       <strong>$rownumber</strong>      常に <return>0</return>.
  <info>int</info>       <strong>$argCount</strong>       SQL 集約関数が受け取るパラメータの数。 負の値を指定すると、SQL 集約関数
                            は任意の数の引数を受け取るようになります。

<comment>Return:</comment>
  <info>bool</info>  集約関数の作成に成功した場合に <info>true</info>、失敗した場合に <info>false</info> を返します


id: SQLite3::createCollation
type: function
doc:
<comment>Description:</comment>
  SQLのcollate関数として使うPHP関数を登録する
  
  SQL文の中でcollate関数として使うPHP関数、またはユーザー定義の関数を登録します。

<comment>Param:</comment>
  <info>string</info>    <strong>$name</strong>      作成、または再定義するSQL collate 関数の名前
  <info>callable</info>  <strong>$callback</strong>  collation の振る舞いを定義する、PHP関数または、 コールバックとして適用する
                       ユーザー定義関数。 2つの値を受けとり、<strong>strcmp()</strong> 関数が返すのと同じ値を返しま
                       す。つまり、 はじめの文字列が前の文字列より前にソートされる場合に-1、 後に
                       ソートされる場合に1、等しい場合に0を返します。
                       
                       この関数は、以下のように定義されるべきです:
                       <info>int</info>collation<info>mixed</info><strong>$value1</strong><info>mixed</info><strong>$value2</strong>

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

<comment>See Also:</comment>
   * SQLite collation ドキュメント: http://sqlite.org/datatype3.html#collation


id: SQLite3::createFunction
type: function
doc:
<comment>Description:</comment>
  SQL のスカラー関数として使用する PHP 関数を登録する
  
  SQL のスカラー関数として使用する PHP 関数を登録します。 これは SQL 文の中で使用されるものです。

<comment>Param:</comment>
  <info>string</info>    <strong>$name</strong>      作成あるいは再定義したい SQL 関数の名前。
  <info>callable</info>  <strong>$callback</strong>  コールバックとして指定する、 PHP の関数あるいはユーザー定義関数の名前。 これ
                       が SQL 関数の振る舞いを定義します。
                       
                       この関数は、以下のように定義されるべきです:
                       <info>mixed</info>callback<info>mixed</info><strong>$value</strong><info>mixed</info><strong>$values</strong> <strong>$value</strong> SQL 関数に渡される最初の引数
                       <strong>$values</strong> SQL 関数に渡されるふたつめ以降の引数
                       
                       SQL 関数に渡される最初の引数
                       
                       SQL 関数に渡されるふたつめ以降の引数
  <info>mixed</info>     <strong>$value</strong>     SQL 関数に渡される最初の引数
  <info>mixed</info>     <strong>$values</strong>    SQL 関数に渡されるふたつめ以降の引数
  <info>int</info>       <strong>$argCount</strong>  SQL 関数が受け取るパラメータの数。 <return>-1</return> を指定すると、SQL 関数は任意の数の引数
                       を受け取るようになります。
  <info>int</info>       <strong>$flags</strong>     フラグのビット単位の組み合わせ。 現状では、 <info>SQLITE3_DETERMINISTIC</info> だけがサ
                       ポートされています。 これは、単一のSQLの範囲の中では、同じ入力を与えると常に
                       同じ結果が返るということを指定します。

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


id: SQLite3::enableExceptions
type: function
doc:
<comment>Description:</comment>
  例外のスローを有効にする
    
  
  <class>SQLite3</class> が、エラー時に警告や例外をスローするかどうかを制御します。

<comment>Param:</comment>
  <info>bool</info>  <strong>$enable</strong>  <info>true</info> の場合、 <class>SQLite3</class> のインスタンスと、 <class>SQLite3Stmt</class> および <class>SQLite3Result</class> から派生
                 したインスタンスは、エラー時に例外をスローします
                 
                 <info>false</info> の場合、 <class>SQLite3</class> のインスタンスと、 <class>SQLite3Stmt</class> および <class>SQLite3Result</class> から派生
                 したインスタンスは、エラー時に警告を発生させます。
                 
                 どちらのモードであっても、エラーコードやメッセージがもしあれば、
                 SQLite3::lastErrorCode と SQLite3::lastErrorMsg で利用できます。

<comment>Return:</comment>
  <info>bool</info>  古い値を返します。つまり、例外が有効であったなら <info>true</info> そうでなければ <info>false</info> を返します。


id: SQLite3::escapeString
type: function
doc:
<comment>Description:</comment>
  適切にエスケープされた文字列を返す
  
  SQL 文の中で使えるよう適切にエスケープされた文字列を返します。
  
  この関数は
  (まだ)バイナリデータ対応ではありません!
  
  BLOB フィールドには NUL 文字が含まれる可能性があります。BLOB フィールドを適切に処理するには、かわ
  りに <strong>SQLite3Stmt::bindParam()</strong> を用いましょう。

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  エスケープしたい文字列。

<comment>Return:</comment>
  <info>string</info>  SQL 文の中で安全に使えるよう適切にエスケープされた文字列を返します。


id: SQLite3::exec
type: function
doc:
<comment>Description:</comment>
  指定したデータベースに、結果を返さないクエリを実行する
  
  指定したデータベースに、結果を返さないクエリを実行します。
  
  SQLite3 は、クエリの実行中に 一時ファイル を作る必要があるかもしれません。 よって、それぞれのディ
  レクトリは書き込み可能でなければならない可能性があります。

<comment>Param:</comment>
  <info>string</info>  <strong>$query</strong>  実行したい SQL クエリ (通常は INSERT、UPDATE あるいは DELETE クエリ)。

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


id: SQLite3::lastErrorCode
type: function
doc:
<comment>Description:</comment>
  直近で失敗した SQLite リクエストの結果コードを数値で返す
    
  
  直近で失敗した SQLite リクエストの結果コードを数値で返します。

<comment>Return:</comment>
  <info>int</info>  直近で失敗した SQLite リクエストの結果コードを数値で返します。


id: SQLite3::lastErrorMsg
type: function
doc:
<comment>Description:</comment>
  直近で失敗した SQLite リクエストについての英文テキストの説明を返す
    
  
  直近で失敗した SQLite リクエストについての英文テキストの説明を返します。

<comment>Return:</comment>
  <info>string</info>  直近で失敗した SQLite リクエストについての英文テキストの説明を返します。


id: SQLite3::lastInsertRowID
type: function
doc:
<comment>Description:</comment>
  直近の INSERT 文でデータベースに追加された行の ID を返す
  
  直近の INSERT 文でデータベースに追加された行の ID を返します。

<comment>Return:</comment>
  <info>int</info>  直近の INSERT 文でデータベースに追加された行の ID を返します。 現在の接続で、rowid テーブルへ
       の INSERT が成功しなかったことがある場合は、 SQLite3::lastInsertRowID は <return>0</return> を返します。


id: SQLite3::loadExtension
type: function
doc:
<comment>Description:</comment>
  SQLite 拡張ライブラリを読み込む
  
  SQLite 拡張ライブラリを読み込みます。

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  読み込みたいライブラリの名前。ライブラリは、設定オプション sqlite3.extension_dir で
                 指定したディレクトリになければなりません。

<comment>Return:</comment>
  <info>bool</info>  拡張ライブラリの読み込みに成功した場合に <info>true</info>、 失敗した場合に <info>false</info> を返します。


id: SQLite3::open
type: function
doc:
<comment>Description:</comment>
  SQLite データベースをオープンする
  
  SQLite 3 データベースをオープンします。 暗号化込みでビルドされている場合は、キーの使用を試みます。

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>       SQLite データベースへのパス。インメモリデータベースを使う場合は <return>:memory:</return>
                          を指定します。
  <info>int</info>     <strong>$flags</strong>          SQLite データベースのオープン方法を指定するフラグ。 デフォルトでは
                          <return>SQLITE3_OPEN_READWRITE | SQLITE3_OPEN_CREATE</return> を使用してオープンします。
                          <return>SQLITE3_OPEN_READONLY</return>: データベースを読み込み専用でオープンする
                          <return>SQLITE3_OPEN_READWRITE</return>: データベースを読み書き共用でオープンする
                          <return>SQLITE3_OPEN_CREATE</return>: データベースが存在しない場合は作成する
                          
                          <return>SQLITE3_OPEN_READONLY</return>: データベースを読み込み専用でオープンする
                          
                          <return>SQLITE3_OPEN_READWRITE</return>: データベースを読み書き共用でオープンする
                          
                          <return>SQLITE3_OPEN_CREATE</return>: データベースが存在しない場合は作成する
  <info>string</info>  <strong>$encryptionKey</strong>  オプションの暗号キー。SQLite データベースの暗号化と復号に使用します。 暗号
                          化モジュールがインストールされていない場合は、このパラメータは何の影響も及
                          ぼしません。

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


id: SQLite3::openBlob
type: function
doc:
<comment>Description:</comment>
  BLOB を読み取るためのストリームリソースを開く
  
  BLOB を読み書きするためのストリームリソースを開きます。 これは、以下によって選択されます:
  
  SELECT <strong>$column</strong> FROM <strong>$database</strong>.<strong>$table</strong> WHERE rowid = <strong>$rowid</strong>
  
  ストリームに書き込むことで、BLOBのサイズを変更することは不可能です。 BLOB のサイズを望んだサイズに
  設定するには、代わりに UPDATE 文を実行するか、 SQLite の zeroblob() 関数を使ってください。

<comment>Param:</comment>
  <info>string</info>  <strong>$table</strong>     テーブル名
  <info>string</info>  <strong>$column</strong>    カラム名
  <info>int</info>     <strong>$rowid</strong>     行ID
  <info>string</info>  <strong>$database</strong>  DB のシンボリック名
  <info>int</info>     <strong>$flags</strong>     <info>SQLITE3_OPEN_READONLY</info> または <info>SQLITE3_OPEN_READWRITE</info> を指定します。 それぞれ、読
                     み取り専用でストリームを開くか、 読み取りと書き込みができるようにストリームを開
                     きます。

<comment>Return:</comment>
  <info>resource|false</info>  ストリームリソースを返します。 失敗した場合に <info>false</info> を返します


id: SQLite3::prepare
type: function
doc:
<comment>Description:</comment>
  実行する SQL 文を準備する
  
  実行する SQL 文を準備し、<class>SQLite3Stmt</class> オブジェクトを返します。

<comment>Param:</comment>
  <info>string</info>  <strong>$query</strong>  準備したい SQL クエリ。

<comment>Return:</comment>
  <info>SQLite3Stmt|false</info>  成功した場合に <class>SQLite3Stmt</class> オブジェクト、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * SQLite3Stmt::paramCount
   * SQLite3Stmt::bindValue
   * SQLite3Stmt::bindParam


id: SQLite3::query
type: function
doc:
<comment>Description:</comment>
  SQL クエリを実行する
  
  SQL クエリを実行し、<class>SQLite3Result</class> オブジェクトを返します。 クエリが(DML文のように)結果を生成しない
  場合は、 返される <class>SQLite3Result</class> オブジェクトは役に立ちません。 そのようなクエリでは、SQLite3::exec
  を代わりに使ってください。

<comment>Param:</comment>
  <info>string</info>  <strong>$query</strong>  実行したい SQL クエリ。

<comment>Return:</comment>
  <info>SQLite3Result|false</info>  <class>SQLite3Result</class> オブジェクトを返します。 失敗した場合に <info>false</info> を返します


id: SQLite3::querySingle
type: function
doc:
<comment>Description:</comment>
  クエリを実行し、単一の結果を返す
  
  クエリを実行し、単一の結果を返します。

<comment>Param:</comment>
  <info>string</info>  <strong>$query</strong>      実行したい SQL クエリ。
  <info>bool</info>    <strong>$entireRow</strong>  デフォルトでは、<strong>querySingle()</strong> はクエリが返す結果の最初のカラムの値を返します。
                      <strong>$entireRow</strong> が <info>true</info> の場合は、最初の行全体を配列で返します。

<comment>Return:</comment>
  <info>mixed</info>  結果の最初のカラムの値あるいは最初の行全体の配列 (<strong>$entireRow</strong> が <info>true</info> の場合) を返します。
         
         クエリ自体は有効であるけれども結果が返されなかった場合の戻り値は、 <strong>$entireRow</strong> が <info>false</info> なら
         <info>null</info>、 そうでなければ空の配列となります。
         
         クエリが無効な場合やクエリの実行に失敗した場合は <info>false</info> を返します。


id: SQLite3::setAuthorizer
type: function
doc:
<comment>Description:</comment>
  SQL文が出来ることを限定するため、authorizer として使われるコールバックを設定する
  
  SQLite に対して毎回アクション(読み取り、削除、更新など) が実行される度に呼び出されるコールバックを
  設定します。 これは信頼できないソースがSQL文を準備する時に、 自分たちが許可していないデータにアク
  セスさせないとか、 データベースに損害を与える不正なSQL文を実行させないといった用途に使います。 た
  とえば、アプリケーションはデータベースの評価の際は 任意のSQL文の実行を許可しています。しかし、
  データベースに対する変更は許可したくありません。 ユーザーが入力したSQL文が準備される間に、
  authorizer が割って入り、SELECT 文以外のSQL文を許可しないようにできます。
  
  authorizer コールバックは、 SQLite が文を準備するたびに複数回呼ばれる可能性があります。 <return>SELECT</return> や
  <return>UPDATE</return> 文は 個別のカラムが読み取られたり、更新されたりするたびに authorizer を呼び出します。
  
  authorizer は引数を5つまで指定して呼び出すことが出来ます。 最初の引数は常に与えられます。 これは
  <return>SQLite3</return> の定数に一致する <info>int</info> の値(アクションコード) です。 それ以外の引数は、アクションによっては
  与えられないことがあります。 以下の表が、アクションに応じた2番目と3番目の引数に関する説明を記して
  います: アクションコードと引数の一覧アクション第2引数第3引数<info>sqlite3::create_index</info>インデックス名
  テーブル名<info>sqlite3::create_table</info>テーブル名<info>null</info><info>sqlite3::create_temp_index</info>インデックス名テーブル名
  <info>sqlite3::create_temp_table</info>テーブル名<info>null</info><info>sqlite3::create_temp_trigger</info>トリガ名テーブル名
  <info>sqlite3::create_temp_view</info>view名<info>null</info><info>sqlite3::create_trigger</info>トリガ名テーブル名
  <info>sqlite3::create_view</info>view名<info>null</info><info>sqlite3::delete</info>テーブル名<info>null</info><info>sqlite3::drop_index</info>インデックス名テーブ
  ル名<info>sqlite3::drop_table</info>テーブル名<info>null</info><info>sqlite3::drop_temp_index</info>インデックス名テーブル名
  <info>sqlite3::drop_temp_table</info>テーブル名<info>null</info><info>sqlite3::drop_temp_trigger</info>トリガ名テーブル名
  <info>sqlite3::drop_temp_view</info>view名<info>null</info><info>sqlite3::drop_trigger</info>トリガ名テーブル名<info>sqlite3::drop_view</info>view名
  <info>null</info><info>sqlite3::insert</info>テーブル名<info>null</info><info>sqlite3::pragma</info>プラグマの名前プラグマに渡す最初の引数。もしくは
  <info>null</info><info>sqlite3::read</info>テーブル名カラム名<info>sqlite3::select</info><info>null</info><info>null</info><info>sqlite3::transaction</info>操作
  <info>null</info><info>sqlite3::update</info>テーブル名カラム名<info>sqlite3::attach</info>ファイル名<info>null</info><info>sqlite3::detach</info>データベース名
  <info>null</info><info>sqlite3::alter_table</info>データベース名テーブル名<info>sqlite3::reindex</info>インデックス名
  <info>null</info><info>sqlite3::analyze</info>テーブル名<info>null</info><info>sqlite3::create_vtable</info>テーブル名モジュール名
  <info>sqlite3::drop_vtable</info>テーブル名モジュール名<info>sqlite3::function</info><info>null</info>ファンクション名
  <info>sqlite3::savepoint</info>操作セーブポイントの名前<info>sqlite3::recursive</info><info>null</info><info>null</info>
  
  4番目の引数は、適切な場合にだけ指定する(<return>"main"</return>, <return>"temp"</return>, などの) データベースの名前です。
  
  authorizer コールバックに与える5番目の引数は、 トップレベルのSQLコードから直接アクセスが行われる場
  合に、 アクセスを試みる責任を持つ一番奥の view やトリガの名前です。
  
  コールバックが <info>SQLite3::OK</info> を返すと、操作のリクエストが承認されたことになります。 コールバックが
  <info>SQLite3::DENY</info> を返すと、authorizer を動かした呼び出しは失敗し、 なぜアクセスが失敗したのかを説明す
  るメッセージが残ります。
  
  アクションが <info>SQLite3::READ</info> で、 さらにコールバックが <info>SQLite3::IGNORE</info> を返す場合、 準備されたSQL文
  は、 <info>SQLite3::OK</info> が返された場合に読まれていたテーブルのカラムを <info>null</info> で置き換えるように文を組み立
  てます。 <info>SQLite3::IGNORE</info> は、 信頼できないユーザーのアクセスが、 テーブルの個別のカラムへのアクセ
  スを拒否する場合に使うことが出来ます。
  
  テーブルを <return>SELECT</return> 文で参照しているが、 そのテーブルからカラムの値を抜き出さない場合 (たとえば、
  <return>"SELECT count(*) FROM table"</return> のようなクエリの場合)、 <info>SQLite3::READ</info> の authorizer コールバックは カ
  ラムの情報が空文字列になった状態で一度だけ呼び出されます。
  
  アクションコードが <info>SQLite3::DELETE</info> で、 さらにコールバックが <info>SQLite3::IGNORE</info> を返した場合、 DELETE
  の操作は継続しますが、truncate による最適化は無効になります。 この場合、全ての行は個別に削除されま
  す。
  
  接続ひとつにつき、authorizer ひとつだけがデータベースに存在できます。 SQLite3::setAuthorizer が呼
  び出されるたびに、 以前の呼び出しは上書きされます。 <info>null</info> をコールバックに指定することで、
  authorizer を無効に出来ます。authorizer はデフォルトで無効になっています。
  
  authorizer コールバックは、コールバックを呼び出すデータベース接続に対していかなる変更もしてはいけ
  ません。
  
  authorizer はSQL文が準備される時にだけ呼び出されることに注意して下さい。 実行時ではありません。
  
  さらなる詳細は SQLite3 のドキュメント を参照ください。

<comment>Param:</comment>
  <info>callable|null</info>  <strong>$callback</strong>  呼び出される <info>callable</info>。
                            
                            <info>null</info> が渡されると、 現在の authorizer のコールバックが無効になります。

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


id: SQLite3::version
type: function
doc:
<comment>Description:</comment>
  SQLite3 ライブラリのバージョンを、文字列定数と数値で返す
    
  
  SQLite3 ライブラリのバージョンを、文字列定数と数値で返します。

<comment>Return:</comment>
  <info>array</info>  キー "versionString" および "versionNumber" を持つ連想配列を返します。


id: SQLite3Result::__construct
type: function
doc:
<comment>Description:</comment>
  SQLite3Result を構築する
  
  <class>SQLite3Result</class> のインスタンスは、 SQLite3::query と SQLite3Stmt::execute によって作られます。


id: SQLite3Result::columnName
type: function
doc:
<comment>Description:</comment>
  n 番目のカラムの名前を返す
  
  <strong>$column</strong> で指定したカラムの名前を返します。 返されるカラムの名前は <return>AS</return> 句が指定された場合、そこで指
  定された値になります。 <return>AS</return> 句の指定がない場合、カラムの名前は不定となり、 libsqlite3 のリリースに
  よって変わる可能性があります。

<comment>Param:</comment>
  <info>int</info>  <strong>$column</strong>  0 から始まるカラムの数値インデックス。

<comment>Return:</comment>
  <info>string|false</info>  <strong>$column</strong> で指定したカラムの名前を文字列で返します。 カラムが存在しない場合は、<info>false</info>
                を返します。


id: SQLite3Result::columnType
type: function
doc:
<comment>Description:</comment>
  n 番目のカラムの型を返す
  
  <strong>$column</strong> で指定したカラムの型を返します。

<comment>Param:</comment>
  <info>int</info>  <strong>$column</strong>  0 から始まるカラムの数値インデックス。

<comment>Return:</comment>
  <info>int|false</info>  <strong>$column</strong> で指定したカラムのデータ型インデックス (<info>SQLITE3_INTEGER</info>、<info>SQLITE3_FLOAT</info>、
             <info>SQLITE3_TEXT</info>、<info>SQLITE3_BLOB</info> あるいは <info>SQLITE3_NULL</info> のいずれか) を返します。 カラムが存在
             しない場合は、<info>false</info> を返します。


id: SQLite3Result::fetchArray
type: function
doc:
<comment>Description:</comment>
  結果の行を、連想配列あるいは数値添字配列あるいはその両方で取得する
    
  
  結果の行を、連想配列あるいは数値添字配列あるいはその両方で取得します。 デフォルトでは両方で取得し
  ます。

<comment>Param:</comment>
  <info>int</info>  <strong>$mode</strong>  次の行をどのように返すかを制御します。値は <return>SQLITE3_ASSOC</return> か <return>SQLITE3_NUM</return>、<return>SQLITE3_BOTH</return>
              のいずれかでなければなりません。 <return>SQLITE3_ASSOC</return>: 返された結果セットのカラム名をインデッ
              クスとする配列を返します。 <return>SQLITE3_NUM</return>: 返された結果セットのカラム番号をインデックスと
              する配列を返します。 カラム番号は 0 から始まります。 <return>SQLITE3_BOTH</return>: 返された結果セット
              のカラム名とカラム番号の両方をインデックスとする配列を返します。 カラム番号は 0 から始
              まります。
              
              <return>SQLITE3_ASSOC</return>: 返された結果セットのカラム名をインデックスとする配列を返します。
              
              <return>SQLITE3_NUM</return>: 返された結果セットのカラム番号をインデックスとする配列を返します。 カラム
              番号は 0 から始まります。
              
              <return>SQLITE3_BOTH</return>: 返された結果セットのカラム名とカラム番号の両方をインデックスとする配列を
              返します。 カラム番号は 0 から始まります。

<comment>Return:</comment>
  <info>array|false</info>  結果の行を、連想配列あるいは数値添字配列あるいはその両方で取得します。 行がない場合は
               <info>false</info> を返します。
               
               返される配列の値の型は、SQLite3 のデータ型と以下のようにマッピングされます: 数値型の
               場合、<info>PHP_INT_MIN</info>..<info>PHP_INT_MAX</info> の範囲に入れば、<info>int</info> にマッピングされます。そうでなけれ
               ば、 <info>string</info> になります。Float 型は <info>float</info> に、 <return>NULL</return> 値は <info>null</info> に、 そして文字列型や
               Blob 型は <info>string</info> にマップされます。


id: SQLite3Result::finalize
type: function
doc:
<comment>Description:</comment>
  結果セットを閉じる
  
  結果セットを閉じます。

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


id: SQLite3Result::numColumns
type: function
doc:
<comment>Description:</comment>
  結果セットのカラム数を返す
  
  結果セットのカラム数を返します。

<comment>Return:</comment>
  <info>int</info>  結果セットのカラム数を返します。


id: SQLite3Result::reset
type: function
doc:
<comment>Description:</comment>
  結果セットを最初の行に戻す
  
  結果セットを最初の行に戻します。

<comment>Return:</comment>
  <info>bool</info>  結果セットを最初の行に戻すことに成功した場合に <info>true</info>、 失敗した場合に <info>false</info> を返します。


id: SQLite3Stmt::__construct
type: function
doc:
<comment>Description:</comment>
  SQLite3Stmt オブジェクトを構築する
  
  <class>SQLite3Stmt</class> のインスタンスは、 SQLite3::prepare によって作られます。

<comment>Param:</comment>
  <info>SQLite3</info>  <strong>$sqlite3</strong>  
  <info>string</info>   <strong>$query</strong>    


id: SQLite3Stmt::bindParam
type: function
doc:
<comment>Description:</comment>
  パラメータを変数にバインドする
  
  パラメータを変数にバインドします。
  
  PHP 7.2.14 と 7.3.0 より前のバージョンでは、 バインドされた値が適切に後の SQLite3Stmt::execute  の
  呼び出しで更新されるべき場合、 SQLite3Stmt::execute をはじめて呼んだ後に SQLite3Stmt::reset を呼び
  出さなければなりませんでした。 SQLite3Stmt::reset が呼び出されなかった場合、
  SQLite3Stmt::bindParam に渡された変数に代入された値が変化したり、 SQLite3Stmt::bindParam を再度呼
  び出したりしても、 バインドされた値は決して変わりませんでした。

<comment>Param:</comment>
  <info>string|int</info>  <strong>$param</strong>  バインドされるべき文中の値を識別する <info>string</info> (名前付きパラメータの場合) または
                      (位置パラメータの場合) <info>int</info>。 名前付きパラメータがコロン (<return>:</return>) や アットマーク
                      (<return>@</return>)  ではじまっていない場合、コロンが自動的に名前の前に付加されます。 位置パラ
                      メータは <return>1</return> から始まります。
  <info>mixed</info>       <strong>$var</strong>    変数にバインドするパラメータ。
  <info>int</info>         <strong>$type</strong>   バインドするパラメータのデータ型。 <info>SQLITE3_INTEGER</info>: 符号付き整数。 値の大きさ
                      に応じて 1, 2, 3, 4, 6, あるいは 8 バイトで格納されます。 <info>SQLITE3_FLOAT</info>: 浮動
                      小数点数値。 8 バイトの IEEE 浮動小数点数値として格納されます。 <info>SQLITE3_TEXT</info>:
                      テキスト文字列。 データベースのエンコーディング (UTF-8, UTF-16BE あるいは
                      UTF-16-LE) を用いて格納されます。 <info>SQLITE3_BLOB</info>: blob データ。 入力がそのままの
                      形式で格納されます。 <info>SQLITE3_NULL</info>: NULL 値。
                      
                      <info>SQLITE3_INTEGER</info>: 符号付き整数。 値の大きさに応じて 1, 2, 3, 4, 6, あるいは 8
                      バイトで格納されます。
                      
                      <info>SQLITE3_FLOAT</info>: 浮動小数点数値。 8 バイトの IEEE 浮動小数点数値として格納されま
                      す。
                      
                      <info>SQLITE3_TEXT</info>: テキスト文字列。 データベースのエンコーディング (UTF-8, UTF-16BE
                      あるいは UTF-16-LE) を用いて格納されます。
                      
                      <info>SQLITE3_BLOB</info>: blob データ。 入力がそのままの形式で格納されます。
                      
                      <info>SQLITE3_NULL</info>: NULL 値。
                      
                      PHP 7.0.7 以降では、 <strong>$type</strong> が省略されると、 自動的に <strong>$var</strong> の型から検出します:
                      <info>bool</info> と <info>int</info> 型は <info>SQLITE3_INTEGER</info> として扱われ、 <info>float</info> は <info>SQLITE3_FLOAT</info>、 <info>null</info>
                      は <info>SQLITE3_NULL</info>、 そして、これら以外は全て <info>SQLITE3_TEXT</info> として扱われます。 こ
                      れより前のバージョンでは、<strong>$type</strong> が省略されると、 デフォルトの型 <info>SQLITE3_TEXT</info>
                      になっていました。
                      
                      <strong>$var</strong> が <info>null</info> の場合、 与えられた <strong>$type</strong> に関わらず、 常に <info>SQLITE3_NULL</info> として扱
                      われます。

<comment>Return:</comment>
  <info>bool</info>  パラメータを変数にバインドした場合に <info>true</info>、 失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * SQLite3Stmt::bindValue
   * SQLite3::prepare


id: SQLite3Stmt::bindValue
type: function
doc:
<comment>Description:</comment>
  パラメータの値を変数にバインドする
  
  パラメータの値を変数にバインドします。
  
  PHP 7.2.14 と 7.3.0 より前のバージョンでは、 ステートメントがいったん実行されると、 バインドされた
  パラメータの値を変えられるようにするために SQLite3Stmt::reset を呼び出す必要がありました。

<comment>Param:</comment>
  <info>string|int</info>  <strong>$param</strong>  バインドされるべき文中の値を識別する <info>string</info> (名前付きパラメータの場合) または
                      (位置パラメータの場合) <info>int</info>。 名前付きパラメータがコロン (<return>:</return>) や アットマーク
                      (<return>@</return>)  ではじまっていない場合、コロンが自動的に名前の前に付加されます。 位置パラ
                      メータは <return>1</return> から始まります。
  <info>mixed</info>       <strong>$value</strong>  変数にバインドする値。
  <info>int</info>         <strong>$type</strong>   バインドする値のデータ型。 <info>SQLITE3_INTEGER</info>: 符号付き整数。 値の大きさに応じて
                      1, 2, 3, 4, 6, あるいは 8 バイトで格納されます。 <info>SQLITE3_FLOAT</info>: 浮動小数点数
                      値。 8 バイトの IEEE 浮動小数点数値として格納されます。 <info>SQLITE3_TEXT</info>: テキスト
                      文字列。 データベースのエンコーディング (UTF-8, UTF-16BE あるいは UTF-16-LE)
                      を用いて格納されます。 <info>SQLITE3_BLOB</info>: blob データ。 入力がそのままの形式で格納
                      されます。 <info>SQLITE3_NULL</info>: NULL 値。
                      
                      <info>SQLITE3_INTEGER</info>: 符号付き整数。 値の大きさに応じて 1, 2, 3, 4, 6, あるいは 8
                      バイトで格納されます。
                      
                      <info>SQLITE3_FLOAT</info>: 浮動小数点数値。 8 バイトの IEEE 浮動小数点数値として格納されま
                      す。
                      
                      <info>SQLITE3_TEXT</info>: テキスト文字列。 データベースのエンコーディング (UTF-8, UTF-16BE
                      あるいは UTF-16-LE) を用いて格納されます。
                      
                      <info>SQLITE3_BLOB</info>: blob データ。 入力がそのままの形式で格納されます。
                      
                      <info>SQLITE3_NULL</info>: NULL 値。
                      
                      PHP 7.0.7 以降では、<strong>$type</strong> が省略されると、 自動的に <strong>$value</strong> の型から検出します:
                      <info>bool</info> と <info>int</info> 型は <info>SQLITE3_INTEGER</info> として扱われ、 <info>float</info> は <info>SQLITE3_FLOAT</info>、 <info>null</info>
                      は <info>SQLITE3_NULL</info>、 そして、これら以外は全て <info>SQLITE3_TEXT</info> として扱われます。 こ
                      れより前のバージョンでは、<strong>$type</strong> が省略されると、 デフォルトの型 <info>SQLITE3_TEXT</info>
                      になっていました。
                      
                      <strong>$value</strong> が <info>null</info> の場合、 与えられた <strong>$type</strong> に関わらず、 常に <info>SQLITE3_NULL</info> として
                      扱われます。

<comment>Return:</comment>
  <info>bool</info>  値を変数にバインドした場合に <info>true</info>、失敗した場合に <info>false</info> を返します

<comment>See Also:</comment>
   * SQLite3Stmt::bindParam
   * SQLite3::prepare


id: SQLite3Stmt::clear
type: function
doc:
<comment>Description:</comment>
  現在バインドされているすべてのパラメータをクリアする
  
  現在バインドされているすべてのパラメータをクリアします。 (それらを <info>null</info> に設定します)
  
  このメソッドは SQLite3Stmt::reset と一緒に使う必要があります。 単独で使うと、
  SQLite3Stmt::bindValue や SQLite3Stmt::bindParam の呼び出しが無意味になり、 全てのバインドされたパ
  ラメータが <info>null</info> になってしまいます。

<comment>Return:</comment>
  <info>bool</info>  バインドされているパラメータのクリアに成功した場合に <info>true</info>、 失敗した場合に <info>false</info> を返しま
        す。


id: SQLite3Stmt::close
type: function
doc:
<comment>Description:</comment>
  プリペアドステートメントを閉じる
  
  プリペアドステートメントを閉じます。
  
  このプリペアドステートメントから取得したすべての <class>SQLite3Result</class> は、プリペアドステートメントを閉じ
  た時点で無効になることに注意しましょう。

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


id: SQLite3Stmt::execute
type: function
doc:
<comment>Description:</comment>
  プリペアドステートメントを実行し、結果セットオブジェクトを返す
  
  プリペアドステートメントを実行し、結果セットオブジェクトを返します。
  
  同じステートメントオブジェクトに対して、 このメソッドを呼び出すことによって得られる結果セットは独
  立したものではありません。 むしろ、同じ基礎的な構造を共有しています。 よって、同じステートメントオ
  ブジェクトに対して SQLite3Stmt::execute を再び呼ぶ前には、 SQLite3Result::finalize を呼び出すこと
  を推奨します。

<comment>Return:</comment>
  <info>SQLite3Result|false</info>  プリペアドステートメントの実行に成功した場合に <class>SQLite3Result</class> オブジェクト、
                       失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * SQLite3::prepare
   * SQLite3Stmt::bindValue
   * SQLite3Stmt::bindParam


id: SQLite3Stmt::getSQL
type: function
doc:
<comment>Description:</comment>
  ステートメントのSQLを取得する
  
  プリペアドステートメントのSQLを取得します。 <strong>$expand</strong> が <info>false</info> の場合、 変更されていないSQLを取得し
  ます。 <strong>$expand</strong> が <info>true</info> の場合、 全てのクエリパラメータがバインド済みの値で、 何もバインドされてい
  ない場合は <return>NULL</return> で置き換えられます。

<comment>Param:</comment>
  <info>bool</info>  <strong>$expand</strong>  展開済みのSQLを取得するかどうか。 <info>true</info> を渡すのは、libsqlite 3.14 以降でのみサポー
                 トされています。

<comment>Return:</comment>
  <info>string|false</info>  プリペアドステートメントのSQLを返します。 失敗した場合に <info>false</info> を返します


id: SQLite3Stmt::paramCount
type: function
doc:
<comment>Description:</comment>
  プリペアドステートメント内のパラメータの数を返す
  
  プリペアドステートメント内のパラメータの数を返します。

<comment>Return:</comment>
  <info>int</info>  プリペアドステートメント内のパラメータの数を返します。

<comment>See Also:</comment>
   * SQLite3::prepare


id: SQLite3Stmt::readOnly
type: function
doc:
<comment>Description:</comment>
  ステートメントが読み取り専用かどうかを返す
  
  ステートメントが読み取り専用かどうかを返します。 ステートメントは、それが 直接 データベースファイ
  ルの内容を変更しなければ、読み取り専用と見なされます。 ユーザー定義のSQL関数は、間接的に 副作用と
  してデータベースを変更する可能性があることに注意してください。

<comment>Return:</comment>
  <info>bool</info>  ステートメントが読み取り専用であれば <info>true</info> を返します。 そうでなければ <info>false</info> を返します。


id: SQLite3Stmt::reset
type: function
doc:
<comment>Description:</comment>
  プリペアドステートメントをリセットする
  
  プリペアドステートメントをリセットし、実行前の状態に戻します。 バインドした内容は、リセットしても
  そのまま残ります。

<comment>Return:</comment>
  <info>bool</info>  ステートメントのリセットに成功した場合に <info>true</info>、失敗した場合に <info>false</info> を返します


id: SSH2_DEFAULT_TERMINAL
type: constant
doc:
<comment>Description:</comment>
  <strong>ssh2_shell()</strong> によって要求される デフォルトのターミナル型 (例えば vt102, ansi, xterm, vanilla)


id: SSH2_FINGERPRINT_HEX
type: constant
doc:
<comment>Description:</comment>
  ホスト鍵のフィンガープリントを 16 進法の文字列として要求する <strong>ssh2_fingerprint()</strong> 用フラグ


id: SSH2_FINGERPRINT_MD5
type: constant
doc:
<comment>Description:</comment>
  ホスト鍵のフィンガープリントを MD5 ハッシュとして要求する <strong>ssh2_fingerprint()</strong> 用フラグ


id: SSH2_FINGERPRINT_RAW
type: constant
doc:
<comment>Description:</comment>
  ホスト鍵のフィンガープリントを 8 ビットキャラクタの文字列として要求する <strong>ssh2_fingerprint()</strong> 用フラ
  グ


id: SSH2_FINGERPRINT_SHA1
type: constant
doc:
<comment>Description:</comment>
  ホスト鍵のフィンガープリントを SHA1 ハッシュとして要求する <strong>ssh2_fingerprint()</strong> 用フラグ


id: SSH2_TERM_UNIT_CHARS
type: constant
doc:
<comment>Description:</comment>
  文字単位で <strong>$幅</strong> と <strong>$高さ</strong> を指定するための <strong>ssh2_shell()</strong> 用フラグ


id: SSH2_TERM_UNIT_PIXELS
type: constant
doc:
<comment>Description:</comment>
  ピクセル単位で <strong>$幅</strong> と <strong>$高さ</strong> を指定するための <strong>ssh2_shell()</strong> 用フラグ


id: STREAM_CAST_FOR_SELECT
type: constant
doc:
<comment>Description:</comment>
  <strong>stream_select()</strong> が <strong>stream_cast()</strong> をコールしている場合のストリームのキャスト。


id: STREAM_CLIENT_ASYNC_CONNECT
type: constant
doc:
<comment>Description:</comment>
  非同期的にソケットを開きます。このオプションは、 <info>STREAM_CLIENT_CONNECT</info> フラグとともに使用する 必要
  があります。 <strong>stream_socket_client()</strong> と共に使われます。


id: STREAM_CLIENT_CONNECT
type: constant
doc:
<comment>Description:</comment>
  クライアントソケット接続を開きます。クライアントソケットは 常にこのフラグを含んでいる必要がありま
  す。 <strong>stream_socket_client()</strong> と共に使われます。


id: STREAM_CLIENT_PERSISTENT
type: constant
doc:
<comment>Description:</comment>
  <strong>stream_socket_client()</strong>を使って 開かれたソケットが、セッションをまたいでも保持されるよう 指示しま
  す。


id: STREAM_FILTER_ALL
type: constant
doc:
<comment>Description:</comment>
  この定数は右の値と等価です: <return>STREAM_FILTER_READ | STREAM_FILTER_WRITE</return>


id: STREAM_FILTER_READ
type: constant
doc:
<comment>Description:</comment>
  <strong>stream_filter_append()</strong> または <strong>stream_filter_prepend()</strong> と共に使われます。 指定されたフィルタが 読み
  込みのときのみ 適用されることを示します。


id: STREAM_FILTER_WRITE
type: constant
doc:
<comment>Description:</comment>
  <strong>stream_filter_append()</strong> または <strong>stream_filter_prepend()</strong> と共に使われます。 指定されたフィルタが 書き
  込みのときのみ 適用されることを示します。


id: STREAM_META_ACCESS
type: constant
doc:
<comment>Description:</comment>
  <strong>stream_metadata()</strong> と組み合わせて使い、<strong>chmod()</strong> のコールを指定します。


id: STREAM_META_GROUP
type: constant
doc:
<comment>Description:</comment>
  <strong>stream_metadata()</strong> と組み合わせて使い、<strong>chgrp()</strong> のコールを指定します。


id: STREAM_META_OWNER
type: constant
doc:
<comment>Description:</comment>
  <strong>stream_metadata()</strong> と組み合わせて使い、<strong>chown()</strong> のコールを指定します。


id: STREAM_META_TOUCH
type: constant
doc:
<comment>Description:</comment>
  <strong>stream_metadata()</strong> と組み合わせて使い、<strong>touch()</strong> のコールを指定します。


id: STREAM_NOTIFY_AUTH_REQUIRED
type: constant
doc:
<comment>Description:</comment>
  指定されたリソースにアクセスするためには、さらに認証情報が必要です。 通常に、
  <info>STREAM_NOTIFY_SEVERITY_ERR</info> の <strong>$severity</strong> (深刻度) と共に通知されます。


id: STREAM_NOTIFY_FAILURE
type: constant
doc:
<comment>Description:</comment>
  ストリームにおいて一般的なエラーが発生したことを示します。 エラーの詳細については、 <strong>$message</strong> と
  <strong>$message_code</strong> を調べてみてください。


id: STREAM_NOTIFY_MIME_TYPE_IS
type: constant
doc:
<comment>Description:</comment>
  リソースの <return>mime タイプ</return> が確認されました。 どのタイプと判定されたかについては、<strong>$message</strong> を見てくだ
  さい。


id: STREAM_NOTIFY_PROGRESS
type: constant
doc:
<comment>Description:</comment>
  ストリームにおける転送の進捗が、 <strong>$bytes_transferred</strong> または、場合によっては <strong>$bytes_max</strong> に現れている
  ことを示します。


id: STREAM_NOTIFY_REDIRECTED
type: constant
doc:
<comment>Description:</comment>
  外部リソースへのアクセスは、別の場所にリダイレクトされました。 詳細を知るには、<strong>$message</strong> を調べてみ
  てください。


id: STREAM_NOTIFY_RESOLVE
type: constant
doc:
<comment>Description:</comment>
  該当するストリームにおいて、リクエストされたリモートのドメイン名の 解決に成功したか、失敗したこと
  を示します。 このとき、何が起こっているかについては、 <strong>$severity</strong> を参照ください。


id: STREAM_REPORT_ERRORS
type: constant
doc:
<comment>Description:</comment>
  <return>フラグ</return>: ストリームを開く際に、 ユーザー空間にある <return>wrapper</return> の側で、 <strong>trigger_error()</strong> を使ってエラー
  を発生させるかどうかを 示します。もし、このフラグがセットされていない場合は、 ユーザーの側でエラー
  をスローしてはいけません。


id: STREAM_SERVER_BIND
type: constant
doc:
<comment>Description:</comment>
  <strong>stream_socket_server()</strong> で開かれたソケットが 特定のターゲットに関連付けられることを示します。 サー
  バーソケットには常にこのフラグが与えられているはずです。


id: STREAM_SERVER_LISTEN
type: constant
doc:
<comment>Description:</comment>
  <strong>stream_socket_server()</strong> で開かれ、 <info>STREAM_SERVER_BIND</info> によってターゲットに 関連付けられたストリーム
  に、ソケットに対して接続待ちを開始するよう 指示します。 接続指向の転送（TCP のような）はこのフラグ
  を使用する必要があります。 それ以外の場合はサーバーソケットが有効になりません。 このフラグを非接続
  指向の転送（UDP のような）に使用するとエラーになります。


id: STREAM_SOCK_RAW
type: constant
doc:
<comment>Description:</comment>
  raw ソケットを提供します。これは内部のネットワークプロトコルや インターフェイスへのアクセス機能を
  提供します。通常、この形式の ソケットは root ユーザーが使用します。


id: STREAM_USE_PATH
type: constant
doc:
<comment>Description:</comment>
  <return>フラグ</return>: <return>stream</return> が include_path を使ったかどうかを示します。


id: SVM::EPSILON_SVR
type: constant
doc:
<comment>Description:</comment>
  A SVM type for regression (predicting a value rather than just a class)


id: SVM::KERNEL_LINEAR
type: constant
doc:
<comment>Description:</comment>
  A very simple kernel, can work well on large document classification problems


id: SVM::KERNEL_RBF
type: constant
doc:
<comment>Description:</comment>
  The common Gaussian RBD kernel. Handles non-linear problems well and is a good default for
  classification


id: SVM::KERNEL_SIGMOID
type: constant
doc:
<comment>Description:</comment>
  A kernel based on the sigmoid function. Using this makes the SVM very similar to a two layer
  sigmoid based neural network


id: SVM::ONE_CLASS
type: constant
doc:
<comment>Description:</comment>
  One class SVM type. Train just on a single class, using outliers as negative examples


id: SVM::OPT_C
type: constant
doc:
<comment>Description:</comment>
  The option for the cost parameter that controls tradeoff between errors and generality -
  effectively the penalty for misclassifying training examples.


id: SVM::OPT_EPS
type: constant
doc:
<comment>Description:</comment>
  The option key for the Epsilon parameter, used in epsilon regression


id: SVM::OPT_NU
type: constant
doc:
<comment>Description:</comment>
  The option key for the nu parameter, only used in the NU_ SVM types


id: SVM::OPT_PROBABILITY
type: constant
doc:
<comment>Description:</comment>
  Training parameter, boolean, for whether to collect and use probability estimates


id: SVM::OPT_SHRINKING
type: constant
doc:
<comment>Description:</comment>
  Training parameter, boolean, for whether to use the shrinking heuristics


id: SVM::crossvalidate
type: function
doc:
<comment>Description:</comment>
  Test training params on subsets of the training data
  
  Crossvalidate can be used to test the effectiveness of the current  parameter set on a subset of
  the training data. Given a problem set  and a n "folds", it separates the problem set into n
  subsets, and the  repeatedly trains on one subset and tests on another. While the accuracy  will
  generally be lower than a SVM trained on the enter data set, the  accuracy score returned should
  be relatively useful, so it can be used to  test different training parameters.

<comment>Param:</comment>
  <info>array</info>  <strong>$problem</strong>          The problem data. This can either be in the form of an array, the URL  of
                           an SVMLight formatted file, or a stream to an opened SVMLight  formatted
                           datasource.
  <info>int</info>    <strong>$number_of_folds</strong>  The number of sets the data should be divided into and cross tested.  A
                           higher number means smaller training sets and less reliability. 5 is  a
                           good number to start with.

<comment>Return:</comment>
  <info>float</info>  The correct percentage, expressed as a floating point number from 0-1.  In the case of
         NU_SVC or EPSILON_SVR kernels the mean squared error will  returned instead.

<comment>See Also:</comment>
   * SVM::train


id: SVM::getOptions
type: function
doc:
<comment>Description:</comment>
  現在の訓練パラメータを返す
  
  訓練パラメータを含む配列を取得します。 パラメータは、所定の SVM 定数がキーになります。

<comment>Return:</comment>
  <info>array</info>  構成の設定配列を返します。


id: SVM::setOptions
type: function
doc:
<comment>Description:</comment>
  訓練パラメータを設定
  
  1 つ以上の訓練パラメータを設定します。

<comment>Param:</comment>
  <info>array</info>  <strong>$params</strong>  訓練パラメータの配列。SVM 定数がキーになります。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に TRUE を返し、エラーの場合に SVMExceptionFALSE をスローします。


id: SVM::train
type: function
doc:
<comment>Description:</comment>
  Create a SVMModel based on training data
  
  Train a support vector machine based on the supplied training data.

<comment>Param:</comment>
  <info>array</info>  <strong>$problem</strong>  The problem can be provided in three different ways.  An array, where the data
                   should start with the class label  (usually 1 or -1) then followed by a sparse
                   data set of  dimension =&gt; data pairs.  A URL to a file containing a SVM Light
                   formatted problem, with the  each line being a new training example, the start of
                   each line  containing the class (1, -1) then a series of tab separated data
                   values shows as key:value.  A opened stream pointing to a data source formatted
                   as in the file above.
  <info>array</info>  <strong>$weights</strong>  Weights are an optional set of weighting parameters for the different  classes,
                   to help account for unbalanced training sets. For example,  if the classes were 1
                   and -1, and -1 had significantly more example  than one, the weight for -1 could
                   be 0.5. Weights should be in the range 0-1.

<comment>Return:</comment>
  <info>SVMModel</info>  Returns an SVMModel that can be used to classify previously unseen data. Throws
            SVMException on error


id: SVMModel::__construct
type: function
doc:
<comment>Description:</comment>
  SVMModel を新規構築
  
  SVMModel を新規構築します。 モデルは、通常は SVM::train 関数から作成されますが、 しかし、保管され
  たモデルが直接復元されるかもしれません。

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  このモデルを読み込むべき、保管されたモデルファイルのファイル名

<comment>See Also:</comment>
   * SVMModel::load


id: SVMModel::checkProbabilityModel
type: function
doc:
<comment>Description:</comment>
  モデルが確率情報を持つ場合 TRUE を返す
  
  モデルが確率情報を含む場合 TRUE を返します。

<comment>Return:</comment>
  <info>bool</info>  ブール値を返します


id: SVMModel::getLabels
type: function
doc:
<comment>Description:</comment>
  モデルが訓練されたラベルを取得
  
  モデルが訓練されたラベルの配列を返します。 回帰および 1 つのクラスのモデルでは、空の配列が返されま
  す。

<comment>Return:</comment>
  <info>array</info>  ラベルの配列を返します

<comment>See Also:</comment>
   * SVMModel::getNrClass


id: SVMModel::getNrClass
type: function
doc:
<comment>Description:</comment>
  モデルが訓練されたクラスの個数を返す
  
  モデルが訓練されたクラスの個数を返します。 １つのクラスおよび複数の回帰モデルにたいしては、2 を返
  します。

<comment>Return:</comment>
  <info>int</info>  整数のクラスの個数を返します


id: SVMModel::getSvmType
type: function
doc:
<comment>Description:</comment>
  モデルが訓練された SVM の種類を取得
  
  使用された SVM モデルの種類を表現する整数値を返します。例) SVM::C_SVC

<comment>Return:</comment>
  <info>int</info>  整数の SVM の種類を返します


id: SVMModel::getSvrProbability
type: function
doc:
<comment>Description:</comment>
  回帰モデルに対するσ（シグマ）値を取得
  
  回帰モデルに対するσ（シグマ）値を返します。 確率情報がないか、またはモデルが SVR ではない場合、0
  が返されます。

<comment>Return:</comment>
  <info>float</info>  σ（シグマ）値を返します


id: SVMModel::load
type: function
doc:
<comment>Description:</comment>
  保管された SVM モデルを読み込み
  
  識別および回帰の準備ができたモデルファイルを読み込みます。

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  モデルのファイル名

<comment>Return:</comment>
  <info>bool</info>  エラー時に SVMException をスローします。 成功時に true を返します。

<comment>See Also:</comment>
   * SVMModel::save


id: SVMModel::predict
type: function
doc:
<comment>Description:</comment>
  Predict a value for previously unseen data
  
  This function accepts an array of data and attempts to predict the class  or regression value
  based on the model extracted from previously trained data.

<comment>Param:</comment>
  <info>array</info>  <strong>$data</strong>  The array to be classified. This should be a series of key =&gt; value  pairs in
                increasing key order, but not necessarily continuous.

<comment>Return:</comment>
  <info>float</info>  Float the predicted value. This will be a class label in the case of  classification, a
         real value in the case of regression. Throws SVMException on error

<comment>See Also:</comment>
   * SVM::train


id: SVMModel::predict_probability
type: function
doc:
<comment>Description:</comment>
  Return class probabilities for previous unseen data
  
  This function accepts an array of data and attempts to predict the class, as with the predict
  function. Additionally, however, this function returns an array of probabilities, one per class in
  the model, which represent the estimated chance of the data supplied being a member of that class.
  Requires that the model to be used has been trained with the probability parameter set to true.

<comment>Param:</comment>
  <info>array</info>  <strong>$data</strong>           The array to be classified. This should be a series of key =&gt; value
                         pairs in increasing key order, but not necessarily continuous.
  <info></info>       <strong>$probabilities</strong>  The supplied value will be filled with the probabilities. This will be
                         either null, in the case  of a model without probability information, or an
                         array where the index is the class name and the value the predicted
                         probability.

<comment>Return:</comment>
  <info>float</info>  Float the predicted value. This will be a class label in the case of  classification, a
         real value in the case of regression. Throws SVMException on error

<comment>See Also:</comment>
   * SVM::predict


id: SVMModel::save
type: function
doc:
<comment>Description:</comment>
  モデルをファイルに保管
  
  後で使用するために、モデルデータをファイルに保管します。

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  モデルを保管するファイル

<comment>Return:</comment>
  <info>bool</info>  エラー時に SVMException をスローします。 成功時に true を返します。

<comment>See Also:</comment>
   * SVMModel::load


id: Schema::createCollection
type: function
doc:
<comment>Description:</comment>
  スキーマにコレクションを追加する
  
  スキーマ内にコレクションを作成します。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>      コレクションの名前。
  <info></info>        <strong>$validate</strong>  バリデーションの定義を JSON オブジェクトとして指定します。

<comment>Return:</comment>
  <info>mysql_xdevapi\Collection</info>  コレクションオブジェクトを返します。


id: Schema::dropCollection
type: function
doc:
<comment>Description:</comment>
  スキーマからコレクションを削除する
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>string</info>  <strong>$collection_name</strong>  

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


id: Schema::existsInDatabase
type: function
doc:
<comment>Description:</comment>
  データベースに存在するかをチェックする
  
  現在のオブジェクト(スキーマ、テーブル、コレクション、またはビュー)が、 スキーマオブジェクト内に存
  在しているかを調べます。

<comment>Return:</comment>
  <info>bool</info>  スキーマ、コレクション、テーブル、またはビューがスキーマに存在していれば <info>true</info> そうでなければ
        <info>false</info> を返します。


id: Schema::getCollection
type: function
doc:
<comment>Description:</comment>
  スキーマからコレクションを取得する
  
  スキーマからコレクションを取得します。

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  取得するコレクションの名前

<comment>Return:</comment>
  <info>mysql_xdevapi\Collection</info>  選択したコレクションを指す Collection オブジェクトを返します。


id: Schema::getCollectionAsTable
type: function
doc:
<comment>Description:</comment>
  コレクションをテーブルオブジェクトとして取得する
  
  コレクションをコレクションオブジェクトではなく、テーブルオブジェクトとして取得します。

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  テーブルオブジェクトとしてインスタンス化するためのコレクション名

<comment>Return:</comment>
  <info>mysql_xdevapi\Table</info>  コレクションに対応する <class>mysql_xdevapi\Table</class> オブジェクトを返します。


id: Schema::getCollections
type: function
doc:
<comment>Description:</comment>
  スキーマに属する全てのコレクションを取得する
  
  このスキーマに属するコレクションのリストを取得します。

<comment>Return:</comment>
  <info>array</info>  このスキーマに属する全てのコレクションを配列にして返します。 個々の要素は、コレクション名を
         キーとし、コレクションオブジェクトが値となります。


id: Schema::getName
type: function
doc:
<comment>Description:</comment>
  スキーマの名前を取得する
  
  スキーマの名前を取得します

<comment>Return:</comment>
  <info>string</info>  スキーマオブジェクトに接続しているスキーマの名前を文字列として返します。


id: Schema::getSession
type: function
doc:
<comment>Description:</comment>
  スキーマのセッションを取得する
  
  スキーマオブジェクトから、新しいセッションオブジェクトを取得します。

<comment>Return:</comment>
  <info>mysql_xdevapi\Session</info>  Session オブジェクトを返します。


id: Schema::getTable
type: function
doc:
<comment>Description:</comment>
  スキーマのテーブルを取得する
  
  スキーマで与えられたテーブルの Table オブジェクトを取得します。

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  テーブルの名前

<comment>Return:</comment>
  <info>mysql_xdevapi\Table</info>  Table オブジェクトを返します


id: Schema::getTables
type: function
doc:
<comment>Description:</comment>
  スキーマのテーブルを取得する
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>array</info>  このスキーマにある全てのテーブル名を配列として返します。 個々の要素は、テーブル名をキーとす
         る Table オブジェクトです。


id: SchemaObject::getSchema
type: function
doc:
<comment>Description:</comment>
  スキーマオブジェクトを得る
  
  スキーマオブジェクトを取得するために、他のオブジェクトから使われます。

<comment>Return:</comment>
  <info>mysql_xdevapi\Schema</info>  現在のスキーマオブジェクトを返します。


id: SeasLog::__construct
type: function
doc:
<comment>Description:</comment>
  Description
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。


id: SeasLog::alert
type: function
doc:
<comment>Description:</comment>
  Record alert log information
  
  Record alert log information.  "ALERT" - Action must be taken immediately. Immediate attention
  should be given to relevant personnel for emergency repairs.
  
  "ALERT" - Action must be taken immediately. Immediate attention should be given to relevant
  personnel for emergency repairs.

<comment>Param:</comment>
  <info>string</info>  <strong>$message</strong>  The log message.
  <info>array</info>   <strong>$content</strong>  The `message` contain placeholders which implementors replace with values from
                    content array. Sush as `message` is `log info  from {NAME}` and `content` is
                    `array('NAME' =&gt; neeke)`, the log information will `log info from neeke`.
  <info>string</info>  <strong>$logger</strong>   The `logger` cased by the third param would be used right this right now,  like
                    a temp logger, when the function SeasLog::setLogger() called in pre content. If
                    `logger` NULL or "", SeasLog will use lastest logger setted by
                    SeasLog::setLogger.

<comment>Return:</comment>
  <info>bool</info>  Return TRUE on record log information success, FALSE on failure.

<comment>See Also:</comment>
   * seaslog.default_template
   * SeasLog::debug
   * SeasLog::info
   * SeasLog::notice
   * SeasLog::warning
   * SeasLog::error
   * SeasLog::critical
   * SeasLog::emergency
   * SeasLog::log


id: SeasLog::analyzerCount
type: function
doc:
<comment>Description:</comment>
  Get log count by level, log_path and key_word
  
  `SeasLog` get count value of `grep -ai '{level}' | grep -aic '{key_word}'`  use system pipe and
  return to PHP (array or int).

<comment>Param:</comment>
  <info>string</info>  <strong>$level</strong>     String. The log information level.
  <info>string</info>  <strong>$log_path</strong>  String. The log information path.
  <info>string</info>  <strong>$key_word</strong>  String. The search key word for log information.

<comment>Return:</comment>
  <info>mixed</info>  If `level` is SEASLOG_ALL or Empty, return all levels count as `array`. If `level` is
         SEASLOG_INFO or the other level, return count as `int`.

<comment>See Also:</comment>
   * SeasLog::analyzerDetail


id: SeasLog::analyzerDetail
type: function
doc:
<comment>Description:</comment>
  Get log detail by level, log_path, key_word, start, limit, order
  
  `SeasLog` get results of  `grep -ai '{level}' | grep -ai '{key_word}' |  sed -n
  '{start},{limit}'p`  use system pipe and return array to PHP.

<comment>Param:</comment>
  <info>string</info>  <strong>$level</strong>     String. The log information level.
  <info>string</info>  <strong>$log_path</strong>  String. The log information path.
  <info>string</info>  <strong>$key_word</strong>  String. The search key word for log information.
  <info>int</info>     <strong>$start</strong>     Int. Default is `1`.
  <info>int</info>     <strong>$limit</strong>     Int. Default is `20`.
  <info>int</info>     <strong>$order</strong>     Int. Default is SEASLOG_DETAIL_ORDER_ASC. See also:
                     SEASLOG_DETAIL_ORDER_ASCSEASLOG_DETAIL_ORDER_DESC

<comment>Return:</comment>
  <info>mixed</info>  Return results as array.  When `start`,`limit` is not NULL and in Windows,  SeasLog will
         threw exception with message 'Param start and limit don't support Windows'.
         
         When `start`,`limit` is not NULL and in Windows,  SeasLog will threw exception with message
         'Param start and limit don't support Windows'.

<comment>See Also:</comment>
   * SeasLog::analyzerCount


id: SeasLog::closeLoggerStream
type: function
doc:
<comment>Description:</comment>
  Manually release stream flow from logger
  
  Manually release stream flow from logger. SeasLog caches the stream handle opened by the log
  logger to save the overhead of creating a stream. The handle will be automatically released at the
  end of the request. If in CLI mode, the process will also automatically release when it exits. Or
  you can use the following functions to manually release(manually release function needs to update
  SeasLog 1.8.6 or updated version).

<comment>Param:</comment>
  <info>int</info>     <strong>$model</strong>   Constant int.
                   SEASLOG_CLOSE_LOGGER_STREAM_MOD_ALLSEASLOG_CLOSE_LOGGER_STREAM_MOD_ASSIGN
  <info>string</info>  <strong>$logger</strong>  The logger name.

<comment>Return:</comment>
  <info>bool</info>  Return TRUE on released stream flow success, FALSE on failure.

<comment>See Also:</comment>
   * SeasLog::setLogger
   * SeasLog::getLastLogger


id: SeasLog::critical
type: function
doc:
<comment>Description:</comment>
  Record critical log information
  
  Record critical log information.  "CRITICAL" - Critical conditions.Need to be repaired
  immediately, and the program component is unavailable.
  
  "CRITICAL" - Critical conditions.Need to be repaired immediately, and the program component is
  unavailable.

<comment>Param:</comment>
  <info>string</info>  <strong>$message</strong>  The log message.
  <info>array</info>   <strong>$content</strong>  The `message` contain placeholders which implementors replace with values from
                    content array. Sush as `message` is `log info  from {NAME}` and `content` is
                    `array('NAME' =&gt; neeke)`, the log information will `log info from neeke`.
  <info>string</info>  <strong>$logger</strong>   The `logger` cased by the third param would be used right this right now,  like
                    a temp logger, when the function SeasLog::setLogger() called in pre content. If
                    `logger` NULL or "", SeasLog will use lastest logger setted by
                    SeasLog::setLogger.

<comment>Return:</comment>
  <info>bool</info>  Return TRUE on record log information success, FALSE on failure.

<comment>See Also:</comment>
   * seaslog.default_template
   * SeasLog::debug
   * SeasLog::info
   * SeasLog::notice
   * SeasLog::warning
   * SeasLog::error
   * SeasLog::alert
   * SeasLog::emergency
   * SeasLog::log


id: SeasLog::debug
type: function
doc:
<comment>Description:</comment>
  Record debug log information
  
  Record debug log information.  "DEBUG" - Detailed debug information.Fine-grained information
  events.
  
  "DEBUG" - Detailed debug information.Fine-grained information events.

<comment>Param:</comment>
  <info>string</info>  <strong>$message</strong>  The log message.
  <info>array</info>   <strong>$content</strong>  The `message` contain placeholders which implementors replace with values from
                    content array. Sush as `message` is `log info  from {NAME}` and `content` is
                    `array('NAME' =&gt; neeke)`, the log information will `log info from neeke`.
  <info>string</info>  <strong>$logger</strong>   The `logger` cased by the third param would be used right this right now,  like
                    a temp logger, when the function SeasLog::setLogger() called in pre content. If
                    `logger` NULL or "", SeasLog will use lastest logger setted by
                    SeasLog::setLogger.

<comment>Return:</comment>
  <info>bool</info>  Return TRUE on record log information success, FALSE on failure.

<comment>See Also:</comment>
   * seaslog.default_template
   * SeasLog::info
   * SeasLog::notice
   * SeasLog::warning
   * SeasLog::error
   * SeasLog::critical
   * SeasLog::alert
   * SeasLog::emergency
   * SeasLog::log


id: SeasLog::emergency
type: function
doc:
<comment>Description:</comment>
  Record emergency log information
  
  Record emergency log information.  "EMERGENCY" - System is unusable. 
  
  "EMERGENCY" - System is unusable.

<comment>Param:</comment>
  <info>string</info>  <strong>$message</strong>  The log message.
  <info>array</info>   <strong>$content</strong>  The `message` contain placeholders which implementors replace with values from
                    content array. Sush as `message` is `log info  from {NAME}` and `content` is
                    `array('NAME' =&gt; neeke)`, the log information will `log info from neeke`.
  <info>string</info>  <strong>$logger</strong>   The `logger` cased by the third param would be used right this right now,  like
                    a temp logger, when the function SeasLog::setLogger() called in pre content. If
                    `logger` NULL or "", SeasLog will use lastest logger setted by
                    SeasLog::setLogger.

<comment>Return:</comment>
  <info>bool</info>  Return TRUE on record log information success, FALSE on failure.

<comment>See Also:</comment>
   * seaslog.default_template
   * SeasLog::debug
   * SeasLog::info
   * SeasLog::notice
   * SeasLog::warning
   * SeasLog::error
   * SeasLog::critical
   * SeasLog::alert
   * SeasLog::log


id: SeasLog::error
type: function
doc:
<comment>Description:</comment>
  Record error log information
  
  Record error log information.  "ERROR" - Runtime errors that do not require immediate action but
  should typically.
  
  "ERROR" - Runtime errors that do not require immediate action but should typically.

<comment>Param:</comment>
  <info>string</info>  <strong>$message</strong>  The log message.
  <info>array</info>   <strong>$content</strong>  The `message` contain placeholders which implementors replace with values from
                    content array. Sush as `message` is `log info  from {NAME}` and `content` is
                    `array('NAME' =&gt; neeke)`, the log information will `log info from neeke`.
  <info>string</info>  <strong>$logger</strong>   The `logger` cased by the third param would be used right this right now,  like
                    a temp logger, when the function SeasLog::setLogger() called in pre content. If
                    `logger` NULL or "", SeasLog will use lastest logger setted by
                    SeasLog::setLogger.

<comment>Return:</comment>
  <info>bool</info>  Return TRUE on record log information success, FALSE on failure.

<comment>See Also:</comment>
   * seaslog.default_template
   * SeasLog::debug
   * SeasLog::info
   * SeasLog::notice
   * SeasLog::warning
   * SeasLog::critical
   * SeasLog::alert
   * SeasLog::emergency
   * SeasLog::log


id: SeasLog::flushBuffer
type: function
doc:
<comment>Description:</comment>
  Flush logs buffer, dump to appender file, or send to remote api with tcp/udp
  
  Flush logs buffer by seaslog.appender:  dump to file, or send to remote api with tcp/udp.  See
  also: seaslog.appender_retry seaslog.remote_host seaslog.remote_port
  
  See also: seaslog.appender_retry seaslog.remote_host seaslog.remote_port

<comment>Return:</comment>
  <info>bool</info>  Return TRUE on flush buffer success, FALSE on failure.

<comment>See Also:</comment>
   * seaslog.use_buffer
   * seaslog.buffer_size
   * seaslog.buffer_disabled_in_cli
   * SeasLog::getBufferEnabled
   * SeasLog::getBuffer


id: SeasLog::getBasePath
type: function
doc:
<comment>Description:</comment>
  Get SeasLog base path.
  
  Use the Function SeasLog::getBasePath will get the value of seaslog.default_basepath what
  configured in php.ini(seaslog.ini).
  
  If you use Seaslog::setBasePath, will change the result.

<comment>Return:</comment>
  <info>string</info>  Return seaslog.default_basepath as string.


id: SeasLog::getBuffer
type: function
doc:
<comment>Description:</comment>
  Get the logs buffer in memory as array

<comment>Return:</comment>
  <info>array</info>  Return an array from logs buffer in memory.

<comment>See Also:</comment>
   * seaslog.use_buffer
   * seaslog.buffer_size
   * seaslog.buffer_disabled_in_cli
   * SeasLog::getBufferEnabled
   * SeasLog::flushBuffer


id: SeasLog::getBufferEnabled
type: function
doc:
<comment>Description:</comment>
  Determin if buffer enabled
  
  Result join seaslog.use_buffer  and seaslog.buffer_disabled_in_cli.

<comment>Return:</comment>
  <info>bool</info>  Return TRUE on seaslog.use_buffer is true. If switch seaslog.buffer_disabled_in_cli on, and
        running in cli,  seaslog.use_buffer setting will be discarded, Seaslog write to the Data
        Store IMMEDIATELY.

<comment>See Also:</comment>
   * seaslog.use_buffer
   * seaslog.buffer_size
   * seaslog.buffer_disabled_in_cli
   * SeasLog::getBuffer
   * SeasLog::flushBuffer


id: SeasLog::getDatetimeFormat
type: function
doc:
<comment>Description:</comment>
  Get SeasLog datetime format style
  
  Get SeasLog datetime format style. Use the Function SeasLog::getDatetimeFormat will  get the value
  of seaslog.default_datetime_format  what configured in php.ini(seaslog.ini).

<comment>Return:</comment>
  <info>string</info>  Get SeasLog datetime format style of  seaslog.default_datetime_format. Use the Function
          SeasLog::setDatetimeFormat  will change this value.

<comment>See Also:</comment>
   * SeasLog::setDatetimeFormat


id: SeasLog::getLastLogger
type: function
doc:
<comment>Description:</comment>
  Get SeasLog last logger path
  
  Use the Function SeasLog::getLastLogger will  get the value of seaslog.default_logger  what
  configured in php.ini(seaslog.ini).

<comment>Return:</comment>
  <info>string</info>  Use the Function SeasLog::setLogger  will change the value of function
          SeasLog::getLastLogger.

<comment>See Also:</comment>
   * SeasLog::setLogger


id: SeasLog::getRequestID
type: function
doc:
<comment>Description:</comment>
  Get SeasLog request_id differentiated requests
  
  To distinguish a single request, such as not invoking the  SeasLog::setRequestId function， the
  unique value generated by the built-in `static char *get_uniqid ()`  function is used when the
  request is initialized.

<comment>Return:</comment>
  <info>string</info>  Return string generated by the built-in `static char *get_uniqid ()` function, or setted
          by SeasLog::setRequestId function.

<comment>See Also:</comment>
   * SeasLog::setRequestID
   * The Variable `%Q` in 
   Seaslog Default Variable Table.


id: SeasLog::getRequestVariable
type: function
doc:
<comment>Description:</comment>
  Get SeasLog request variable
  
  Get SeasLog request variable.

<comment>Param:</comment>
  <info>int</info>  <strong>$key</strong>  Constant int.
             SEASLOG_REQUEST_VARIABLE_DOMAIN_PORTSEASLOG_REQUEST_VARIABLE_REQUEST_URISEASLOG_REQUEST_VARIABLE_REQUEST_METHODSEASLOG_REQUEST_VARIABLE_CLIENT_IP

<comment>Return:</comment>
  <info>bool</info>  Return request variable value on set success.

<comment>See Also:</comment>
   * SeasLog::setRequestVariable


id: SeasLog::info
type: function
doc:
<comment>Description:</comment>
  Record info log information
  
  Record info log information.  "INFO" - Interesting events.Emphasizes the running process of the
  application.
  
  "INFO" - Interesting events.Emphasizes the running process of the application.

<comment>Param:</comment>
  <info>string</info>  <strong>$message</strong>  The log message.
  <info>array</info>   <strong>$content</strong>  The `message` contain placeholders which implementors replace with values from
                    content array. Sush as `message` is `log info  from {NAME}` and `content` is
                    `array('NAME' =&gt; neeke)`, the log information will `log info from neeke`.
  <info>string</info>  <strong>$logger</strong>   The `logger` cased by the third param would be used right this right now,  like
                    a temp logger, when the function SeasLog::setLogger() called in pre content. If
                    `logger` NULL or "", SeasLog will use lastest logger setted by
                    SeasLog::setLogger.

<comment>Return:</comment>
  <info>bool</info>  Return TRUE on record log information success, FALSE on failure.

<comment>See Also:</comment>
   * seaslog.default_template
   * SeasLog::debug
   * SeasLog::notice
   * SeasLog::warning
   * SeasLog::error
   * SeasLog::critical
   * SeasLog::alert
   * SeasLog::emergency
   * SeasLog::log


id: SeasLog::log
type: function
doc:
<comment>Description:</comment>
  The Common Record Log Function
  
  The Common Record Log Function.

<comment>Param:</comment>
  <info>string</info>  <strong>$level</strong>    Can use level in:
                    SEASLOG_DEBUGSEASLOG_INFOSEASLOG_NOTICESEASLOG_WARNINGSEASLOG_ERRORSEASLOG_CRITICALSEASLOG_ALERTSEASLOG_EMERGENCY
                    Or you can create a new level self-help.
  <info>string</info>  <strong>$message</strong>  The log message.
  <info>array</info>   <strong>$content</strong>  The `message` contain placeholders which implementors replace with values from
                    content array. Sush as `message` is `log info  from {NAME}` and `content` is
                    `array('NAME' =&gt; neeke)`, the log information will `log info from neeke`.
  <info>string</info>  <strong>$logger</strong>   The `logger` cased by the third param would be used right this right now,  like
                    a temp logger, when the function SeasLog::setLogger() called in pre content. If
                    `logger` NULL or "", SeasLog will use lastest logger setted by
                    SeasLog::setLogger.

<comment>Return:</comment>
  <info>bool</info>  Return TRUE on record log information success, FALSE on failure.

<comment>See Also:</comment>
   * seaslog.default_template
   * SeasLog::debug
   * SeasLog::info
   * SeasLog::notice
   * SeasLog::warning
   * SeasLog::error
   * SeasLog::critical
   * SeasLog::alert
   * SeasLog::emergency


id: SeasLog::notice
type: function
doc:
<comment>Description:</comment>
  Record notice log information
  
  Record notice log information.  "NOTICE" - Normal but significant events.Information that is more
  important than the INFO level during execution.
  
  "NOTICE" - Normal but significant events.Information that is more important than the INFO level
  during execution.

<comment>Param:</comment>
  <info>string</info>  <strong>$message</strong>  The log message.
  <info>array</info>   <strong>$content</strong>  The `message` contain placeholders which implementors replace with values from
                    content array. Sush as `message` is `log info  from {NAME}` and `content` is
                    `array('NAME' =&gt; neeke)`, the log information will `log info from neeke`.
  <info>string</info>  <strong>$logger</strong>   The `logger` cased by the third param would be used right this right now,  like
                    a temp logger, when the function SeasLog::setLogger() called in pre content. If
                    `logger` NULL or "", SeasLog will use lastest logger setted by
                    SeasLog::setLogger.

<comment>Return:</comment>
  <info>bool</info>  Return TRUE on record log information success, FALSE on failure.

<comment>See Also:</comment>
   * seaslog.default_template
   * SeasLog::debug
   * SeasLog::info
   * SeasLog::warning
   * SeasLog::error
   * SeasLog::critical
   * SeasLog::alert
   * SeasLog::emergency
   * SeasLog::log


id: SeasLog::setBasePath
type: function
doc:
<comment>Description:</comment>
  Set SeasLog base path
  
  Set SeasLog base path.

<comment>Param:</comment>
  <info>string</info>  <strong>$base_path</strong>  String.

<comment>Return:</comment>
  <info>bool</info>  Return TRUE on setted base path success, FALSE on failure.


id: SeasLog::setDatetimeFormat
type: function
doc:
<comment>Description:</comment>
  Set SeasLog datetime format style
  
  Set SeasLog datetime format style.
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>string</info>  <strong>$format</strong>  String. Such as `Y-m-d H:i:s` or `Ymd His`. See also first param `format` at
                   <strong>date()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Return TRUE on setted datetime format success, FALSE on failure.

<comment>See Also:</comment>
   * SeasLog::getDateTimeFormat


id: SeasLog::setLogger
type: function
doc:
<comment>Description:</comment>
  Set SeasLog logger name
  
  Use the Function SeasLog::setLogger will change the value of function SeasLog::getLastLogger.
  Than's mean, SeasLog will record loginfo into the logger directory.

<comment>Param:</comment>
  <info>string</info>  <strong>$logger</strong>  Logger name.

<comment>Return:</comment>
  <info>bool</info>  Return TRUE on created logger disectory success, FALSE on failure.

<comment>See Also:</comment>
   * SeasLog::getLastLogger
   * SeasLog::closeLoggerStream


id: SeasLog::setRequestID
type: function
doc:
<comment>Description:</comment>
  Set SeasLog request_id differentiated requests
  
  To distinguish a single request, such as not invoking the  SeasLog::setRequestId function， the
  unique value generated by the built-in `static char *get_uniqid ()`  function is used when the
  request is initialized.

<comment>Param:</comment>
  <info>string</info>  <strong>$request_id</strong>  String.

<comment>Return:</comment>
  <info>bool</info>  Return TRUE on set request_id success, FALSE on failure.

<comment>See Also:</comment>
   * SeasLog::getRequestID


id: SeasLog::setRequestVariable
type: function
doc:
<comment>Description:</comment>
  Manually set SeasLog request variable
  
  Manually set SeasLog request variable.

<comment>Param:</comment>
  <info>int</info>     <strong>$key</strong>    Constant int.
                  SEASLOG_REQUEST_VARIABLE_DOMAIN_PORTSEASLOG_REQUEST_VARIABLE_REQUEST_URISEASLOG_REQUEST_VARIABLE_REQUEST_METHODSEASLOG_REQUEST_VARIABLE_CLIENT_IP
  <info>string</info>  <strong>$value</strong>  The request variable value.

<comment>Return:</comment>
  <info>bool</info>  Return TRUE on set success, FALSE on failure.

<comment>See Also:</comment>
   * SeasLog::getRequestVariable


id: SeasLog::warning
type: function
doc:
<comment>Description:</comment>
  Record warning log information
  
  Record warning log information.  "WARNING" - Exceptional occurrences that are not errors.
  Potentially aberrant information that needs attention and needs to be repaired.
  
  "WARNING" - Exceptional occurrences that are not errors. Potentially aberrant information that
  needs attention and needs to be repaired.

<comment>Param:</comment>
  <info>string</info>  <strong>$message</strong>  The log message.
  <info>array</info>   <strong>$content</strong>  The `message` contain placeholders which implementors replace with values from
                    content array. Sush as `message` is `log info  from {NAME}` and `content` is
                    `array('NAME' =&gt; neeke)`, the log information will `log info from neeke`.
  <info>string</info>  <strong>$logger</strong>   The `logger` cased by the third param would be used right this right now,  like
                    a temp logger, when the function SeasLog::setLogger() called in pre content. If
                    `logger` NULL or "", SeasLog will use lastest logger setted by
                    SeasLog::setLogger.

<comment>Return:</comment>
  <info>bool</info>  Return TRUE on record log information success, FALSE on failure.

<comment>See Also:</comment>
   * seaslog.default_template
   * SeasLog::debug
   * SeasLog::info
   * SeasLog::notice
   * SeasLog::error
   * SeasLog::critical
   * SeasLog::alert
   * SeasLog::emergency
   * SeasLog::log


id: SeekableIterator::seek
type: function
doc:
<comment>Description:</comment>
  位置を移動する
  
  イテレータ内の指定した位置に移動します。

<comment>Param:</comment>
  <info>int</info>  <strong>$offset</strong>  移動先の位置。

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

<comment>See Also:</comment>
   * <class>SeekableIterator</class>
   * <class>Iterator</class>


id: SensitiveParameter::__construct
type: function
doc:
<comment>Description:</comment>
  新しい SensitiveParameter のインスタンスを作成する
  
  新しい <class>SensitiveParameter</class> のインスタンスを作成します。


id: SensitiveParameterValue
type: class
doc:
<comment>Description:</comment>
  <class>SensitiveParameterValue</class> クラスを使うと、 秘密の値をうっかり公開してしまうことを防ぐために値をラッ
  プすることができます。
  
  <class>SensitiveParameter</class> アトリビュートを持つパラメータに渡される値は、 スタックトレース中では
  <class>SensitiveParameterValue</class> オブジェクトで自動的にラップされます。


id: SensitiveParameterValue::__construct
type: function
doc:
<comment>Description:</comment>
  新しい SensitiveParameterValue オブジェクトを作成する
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  <class>SensitiveParameterValue</class> オブジェクトの内部に保存すべき、任意の値


id: SensitiveParameterValue::__debugInfo
type: function
doc:
<comment>Description:</comment>
  秘密の値をうっかり公開することを防止する
  
  <strong>var_dump()</strong> を使った時にうっかり秘密の値を公開しないように、 空の配列を返します。

<comment>Return:</comment>
  <info>array</info>  空の配列を返します


id: SensitiveParameterValue::getValue
type: function
doc:
<comment>Description:</comment>
  秘密の値を返す
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>mixed</info>  秘密の値を返します。


id: Serializable
type: class
doc:
<comment>Description:</comment>
  独自のシリアライズ用のインターフェイスです。
  
  このインターフェイスを実装したクラスは __sleep() や __wakeup() をサポートしなくなります。 シリアラ
  イズが必要な場合には、自動的に serialize メソッドがコールされます。 このメソッドは __destruct() を
  実行しません。また、 メソッド内で明示的に書かない限りは一切の副作用を及ぼしません。 アンシリアライ
  ズされるときにはそのクラスが自動的に検知し、__construct() メソッドのかわりに適切な unserialize()
  メソッドがコールされます。 標準のコンストラクタを実行させたい場合は、unserialize() メソッドの中で
  それをコールします。
  
  PHP 8.1.0 以降は、 __serialize() と __unserialize() がない状態で Serializable を実装したクラスに対
  しては、推奨されない警告が発生します。


id: Serializable::serialize
type: function
doc:
<comment>Description:</comment>
  オブジェクトの文字列表現
  
  オブジェクトを文字列であらわしたものを返します。

<comment>Return:</comment>
  <info>string|null</info>  オブジェクトの文字列表現、あるいは <info>null</info> を返します。

<comment>See Also:</comment>
   * __sleep()
   * __serialize()


id: Serializable::unserialize
type: function
doc:
<comment>Description:</comment>
  オブジェクトを作成する
  
  オブジェクトのアンシリアライズ時にコールされます。
  
  このメソッドは、オブジェクトの コンストラクタ として働きます。 このメソッドの後に __construct() メ
  ソッドがコールされることは ありません。

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  オブジェクトの文字列表現。

<comment>Return:</comment>
  <info>void</info>  このメソッドの戻り値は無視されます。

<comment>See Also:</comment>
   * __wakeup()
   * __unserialize()


id: Session::__construct
type: function
doc:
<comment>Description:</comment>
  Session のコンストラクタ
  
  セッションオブジェクトです。 getSession() によってインスタンス化されます。


id: Session::close
type: function
doc:
<comment>Description:</comment>
  セッションを閉じる
  
  サーバーとのセッションを閉じます。

<comment>Return:</comment>
  <info>bool</info>  セッションが閉じられたら <info>true</info> を返します。


id: Session::commit
type: function
doc:
<comment>Description:</comment>
  トランザクションをコミットする
  
  トランザクションをコミットします。

<comment>Return:</comment>
  <info>Object</info>  SqlStatementResult オブジェクトを返します。


id: Session::createSchema
type: function
doc:
<comment>Description:</comment>
  新しいスキーマを作成する
  
  　新しいスキーマを作成します。

<comment>Param:</comment>
  <info>string</info>  <strong>$schema_name</strong>  作成するスキーマの名前

<comment>Return:</comment>
  <info>mysql_xdevapi\Schema</info>  成功した場合はスキーマオブジェクトを返します。 失敗した場合は例外がスローさ
                        れます。


id: Session::dropSchema
type: function
doc:
<comment>Description:</comment>
  スキーマを削除します
  
  スキーマ(データベース)を削除します。

<comment>Param:</comment>
  <info>string</info>  <strong>$schema_name</strong>  削除するスキーマ

<comment>Return:</comment>
  <info>bool</info>  スキーマが削除されたら <info>true</info> を返します。 スキーマが存在しないか、削除できない場合は <info>false</info> を
        返します。
        
        An <info>E_WARNING</info> level error is generated if the  schema does not exist.


id: Session::generateUUID
type: function
doc:
<comment>Description:</comment>
  新しいUUIDを取得する
  
  RFC 4122 に従って UUID を生成します。

<comment>Return:</comment>
  <info>string</info>  UUID を返します。長さが32の文字列です。


id: Session::getDefaultSchema
type: function
doc:
<comment>Description:</comment>
  デフォルトのスキーマ名を取得する
  
  通常接続URIに設定される、デフォルトのスキーマ名を取得します。

<comment>Return:</comment>
  <info>string</info>  接続に定義されているデフォルトのスキーマ名を返します。 設定されていない場合は、<info>null</info> を返し
          ます。


id: Session::getSchema
type: function
doc:
<comment>Description:</comment>
  新しいスキーマオブジェクトを取得する
  
  与えられたスキーマ名に対応する新しいスキーマオブジェクトを返します。

<comment>Param:</comment>
  <info>string</info>  <strong>$schema_name</strong>  スキーマオブジェクトを取得するためのスキーマ(データベース) の名前

<comment>Return:</comment>
  <info>mysql_xdevapi\Schema</info>  Schema オブジェクトを返します。


id: Session::getSchemas
type: function
doc:
<comment>Description:</comment>
  スキーマを取得する
  
  セッションで利用可能な全てのスキーマを、スキーマオブジェクトとして取得します。

<comment>Return:</comment>
  <info>array</info>  セッションで利用可能な全てのスキーマを表現するオブジェクトを含んだ配列を返します。


id: Session::getServerVersion
type: function
doc:
<comment>Description:</comment>
  サーバーのバージョンを取得する
  
  このセッションにおける MySQL サーバーのバージョンを取得する

<comment>Return:</comment>
  <info>int</info>  このセッションにおける MySQL サーバーのバージョンを数値として返します。 たとえば "80012" のよ
       うな値になります。


id: Session::listClients
type: function
doc:
<comment>Description:</comment>
  クライアントの一覧を取得する
  
  MySQL サーバーのセッションに紐付いたクライアント接続の一覧を取得します。

<comment>Return:</comment>
  <info>array</info>  現在接続しているクライアントを含んだ配列を返します。 配列の要素には、"client_id", "user",
         "host", および "sql_session" が含まれています。


id: Session::quoteName
type: function
doc:
<comment>Description:</comment>
  クォートを追加する
  
  SQL の名前や識別子をエスケープするためのクォート関数です。 現在の接続の設定に従って、与えられた識
  別子をエスケープします。 このエスケープ関数は、値のエスケープに使うべきではありません。

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  クォートする文字列

<comment>Return:</comment>
  <info>string</info>  クォートされた文字列を返します。


id: Session::releaseSavepoint
type: function
doc:
<comment>Description:</comment>
  設定されたセーブポイントをリリースする
  
  以前設定したセーブポイントをリリースします。

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  リリースするセーブポイントの名前

<comment>Return:</comment>
  <info>void</info>  SqlStatementResult オブジェクトを返します。


id: Session::rollback
type: function
doc:
<comment>Description:</comment>
  トランザクションをロールバックする
  
  トランザクションをロールバックします。

<comment>Return:</comment>
  <info>void</info>  SqlStatementResult オブジェクトを返します。


id: Session::rollbackTo
type: function
doc:
<comment>Description:</comment>
  セーブポイントまでトランザクションをロールバックする
  
  セーブポイントまでトランザクションをロールバックします。

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  ロールバックされる時点を示すセーブポイントの名前。大文字小文字は区別されません。

<comment>Return:</comment>
  <info>void</info>  SqlStatementResult オブジェクトを返します。


id: Session::setSavepoint
type: function
doc:
<comment>Description:</comment>
  セーブポイントを作成する
  
  トランザクションのための新しいセーブポイントを作成します。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  セーブポイントの名前。 オプションの <return>name</return> パラメータが定義されない場合は、 自動的に
                 作成されます。'SAVEPOINT1', 'SAVEPOINT2' のようなものです。

<comment>Return:</comment>
  <info>string</info>  セーブポイントの名前を返します。


id: Session::sql
type: function
doc:
<comment>Description:</comment>
  SQLクエリを作成する
  
  ネイティブなSQLステートメントを作成します。 プレースホルダーはネイティブな "?" を使ってサポートさ
  れます。 SQLステートメントを実行するには、<return>execute</return> メソッドを使ってください。

<comment>Param:</comment>
  <info>string</info>  <strong>$query</strong>  実行するSQLステートメント

<comment>Return:</comment>
  <info>mysql_xdevapi\SqlStatement</info>  SqlStatement オブジェクトを返します。


id: Session::startTransaction
type: function
doc:
<comment>Description:</comment>
  トランザクションを開始する
  
  新しいトランザクションを開始します。

<comment>Return:</comment>
  <info>void</info>  SqlStatementResult オブジェクトを返します。


id: SessionHandler
type: class
doc:
<comment>Description:</comment>
  <class>SessionHandler</class> は特殊なクラスで、 これを継承したクラスを作れば PHP が内部的に使っているセッション
  保存ハンドラを拡張できます。 このクラスには七つのメソッドがあり、それぞれが七つのセッション保存ハ
  ンドラコールバック (<strong>$open</strong>, <strong>$close</strong>, <strong>$read</strong>, <strong>$write</strong>, <strong>$destroy</strong>, <strong>$gc</strong> および <strong>$create_sid</strong>) に対応していま
  す。デフォルトでは、このクラスは session.save_handler で定義された内部セッションハンドラをラップし
  ます。 通常は <strong>$files</strong> がデフォルトになっています。 それ以外には、PHP の拡張モジュールとして提供され
  ている SQLite (<strong>$sqlite</strong>) や Memcache (<strong>$memcache</strong>) そして Memcached (<strong>$memcached</strong>) が使えます。
  
  <class>SessionHandler</class> のインスタンスを <strong>session_set_save_handler()</strong> でハンドラとして指定すると、 そのインス
  タンスが現在の保存ハンドラをラップします。 <class>SessionHandler</class> を継承したクラスを作ると、 親クラスのメ
  ソッド、つまり PHP の内部セッションハンドラのメソッドをラップして オーバーライドしたり処理を割り込
  ませたりフィルタをかけたりできるようになります。
  
  これを利用すると、たとえば <strong>$read</strong> と <strong>$write</strong> メソッドに処理を割り込ませ、セッションデータの暗号化/復
  号の処理を追加することができます。 あるいは、ガベージコレクションコールバック <strong>$gc</strong> を完全に自前の処
  理で置き換えてしまうこともできます。
  
  <class>SessionHandler</class> は現在の内部保存ハンドラのメソッドをラップしているので、 先述の暗号化の例は任意の保
  存ハンドラに適用することができます。その際に、ハンドラの内部的な動きを知っておく必要はありません。
  
  このクラスを使うには、まず最初に公開したいハンドラを session.save_handler で設定してから、
  <class>SessionHandler</class> あるいはそれを継承したクラスのインスタンスを <strong>session_set_save_handler()</strong> に渡しま
  す。
  
  このクラスのコールバックメソッドは PHP が内部的にコールするものであり、 ユーザーのコードから呼ばれ
  ることは想定していないことに注意しましょう。 コールバックの戻り値も、PHP が内部的に利用するだけで
  す。 セッションの処理の流れについての詳しい情報は <strong>session_set_save_handler()</strong> を参照ください。


id: SessionHandler::close
type: function
doc:
<comment>Description:</comment>
  セッションを閉じる
  
  現在のセッションを閉じます。この関数はセッションを閉じるときに自動的に実行されます。 あるいは、明
  示的に <strong>session_write_close()</strong> 経由で実行することもできます (このときは、まず最初に
  <strong>SessionHandler::write()</strong> をコールします)。
  
  このメソッドは、このハンドラが <strong>session_set_save_handler()</strong> で設定される前に ini 設定
  session.save_handler で定義されていた PHP の保存ハンドラをラップします。
  
  このクラスを継承して拡張する場合は、親の <strong>$close</strong> メソッドをコールすればこのメソッドのラッパーを実行
  でき、それに付随する内部コールバックも実行されます。 こうすれば、メソッドをオーバーライドしたり処
  理を横取りしたりできます。
  
  このメソッドに関する詳細は、 <strong>SessionHandlerInterface::close()</strong> のドキュメントを参照ください。

<comment>Return:</comment>
  <info>bool</info>  返り値 (通常は、<info>true</info> が成功そして <info>false</info> が失敗を表します)。この値は PHP で内部的に処理される
        ものであることに注意しましょう。


id: SessionHandler::create_sid
type: function
doc:
<comment>Description:</comment>
  新規セッション ID を返す
  
  新規セッション ID を生成して返します。

<comment>Return:</comment>
  <info>string</info>  デフォルトのセッション・ハンドラに対して有効なセッションです。

<comment>See Also:</comment>
   * <strong>session_id()</strong>
   * <strong>session_create_id()</strong>


id: SessionHandler::destroy
type: function
doc:
<comment>Description:</comment>
  セッションを破棄する
  
  セッションを破棄します。<strong>session_regenerate_id()</strong> (<strong>$destory</strong> を <info>true</info> にしたとき) や <strong>session_destroy()</strong>
  からコールされ、<strong>session_decode()</strong> が失敗したときにもコールされます。
  
  このメソッドは、このハンドラが <strong>session_set_save_handler()</strong> で設定される前に ini 設定
  session.save_handler で定義されていた PHP の保存ハンドラをラップします。
  
  このクラスを継承して拡張する場合は、親の <strong>$destroy</strong> メソッドをコールすればこのメソッドのラッパーを実
  行でき、それに付随する内部コールバックも実行されます。 こうすれば、メソッドをオーバーライドしたり
  処理を横取りしてフィルタを追加したりできます。
  
  このメソッドに関する詳細は、 <strong>SessionHandlerInterface::destroy()</strong> のドキュメントを参照ください。

<comment>Param:</comment>
  <info>string</info>  <strong>$id</strong>  破棄するセッション ID。

<comment>Return:</comment>
  <info>bool</info>  返り値 (通常は、<info>true</info> が成功そして <info>false</info> が失敗を表します)。この値は PHP で内部的に処理される
        ものであることに注意しましょう。


id: SessionHandler::gc
type: function
doc:
<comment>Description:</comment>
  古いセッションを削除する
  
  有効期限を過ぎたセッションを削除します。PHP がセッションを開始したとき、あるいは <strong>session_start()</strong>
  を実行したときにコールされます。 コールされる頻度は、session.gc_divisor および
  session.gc_probability の設定に基づいて決まります。
  
  このメソッドは、このハンドラが <strong>session_set_save_handler()</strong> で設定される前に ini 設定
  session.save_handler で定義されていた PHP の保存ハンドラをラップします。
  
  このクラスを継承して拡張する場合は、親の <strong>$gc</strong> メソッドをコールすればこのメソッドのラッパーを実行で
  き、それに付随する内部コールバックも実行されます。 こうすれば、メソッドをオーバーライドしたり処理
  を横取りしてフィルタを追加したりできます。
  
  このメソッドに関する詳細は、 <strong>SessionHandlerInterface::gc()</strong> のドキュメントを参照ください。

<comment>Param:</comment>
  <info>int</info>  <strong>$max_lifetime</strong>  直近の <strong>$max_lifetime</strong> 秒の間に更新されていないセッションを削除します。

<comment>Return:</comment>
  <info>int|false</info>  成功時には、削除されたセッションの数を返します。 失敗した場合に <info>false</info> を返します。 この
             値は、処理を続けるために PHP の内部にも返される点に注意して下さい。


id: SessionHandler::open
type: function
doc:
<comment>Description:</comment>
  セッションを開始する
  
  新しいセッションを作成するか、あるいは既存のセッションを再度初期化します。 PHP が自動的にセッショ
  ンを開始させたり、あるいは <strong>session_start()</strong> を実行したときにコールされます。
  
  このメソッドは、このハンドラが <strong>session_set_save_handler()</strong> で設定される前に ini 設定
  session.save_handler で定義されていた PHP の保存ハンドラをラップします。
  
  このクラスを継承して拡張する場合は、親の <strong>$open</strong> メソッドをコールすればこのメソッドのラッパーを実行
  でき、それに付随する内部コールバックも実行されます。 こうすれば、メソッドをオーバーライドしたり処
  理を横取りしてフィルタを追加したりできます。
  
  このメソッドに関する詳細は、 <strong>SessionHandlerInterface::open()</strong> のドキュメントを参照ください。

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>  セッションを格納/取得するパス。
  <info>string</info>  <strong>$name</strong>  セッション名。

<comment>Return:</comment>
  <info>bool</info>  返り値 (通常は、<info>true</info> が成功そして <info>false</info> が失敗を表します)。この値は PHP で内部的に処理される
        ものであることに注意しましょう。

<comment>See Also:</comment>
   * session.auto-start


id: SessionHandler::read
type: function
doc:
<comment>Description:</comment>
  セッションのデータを読み込む
  
  セッションのデータをセッションストレージから読み込み、その結果を PHP の内部処理用に返します。 この
  メソッドは PHP がセッションを自動的に開始したとき、あるいは <strong>session_start()</strong> を実行したときにコール
  され、内部的に <strong>SessionHandler::open()</strong> で処理されます。
  
  このメソッドは、このハンドラが <strong>session_set_save_handler()</strong> で設定される前に ini 設定
  session.save_handler で定義されていた PHP の保存ハンドラをラップします。
  
  このクラスを継承して拡張する場合は、親の <strong>$read</strong> メソッドをコールすればこのメソッドのラッパーを実行
  でき、それに付随する内部コールバックも実行されます。 こうすれば、メソッドをオーバーライドしたり処
  理を横取りしてフィルタを追加したり (親の <strong>$read</strong> メソッドが返す <strong>$data</strong> を復号したりなど) できます。
  
  このメソッドに関する詳細は、 <strong>SessionHandlerInterface::read()</strong> のドキュメントを参照ください。

<comment>Param:</comment>
  <info>string</info>  <strong>$id</strong>  データを読み込むセッションの id。

<comment>Return:</comment>
  <info>string|false</info>  読み込んだデータを常に文字列で返します。何も読まなかった場合は <info>false</info> を返さなければ
                なりません。 この値は、PHP の内部で処理されるものであることに注意しましょう。

<comment>See Also:</comment>
   * session.serialize_handler


id: SessionHandler::write
type: function
doc:
<comment>Description:</comment>
  セッションのデータを書き込む
  
  セッションのデータをセッションストレージに書き込みます。 リクエストの終了時や
  <strong>session_write_close()</strong> を実行したとき、そして <strong>session_register_shutdown()</strong> が失敗したときにコールさ
  れます。 PHP は、このメソッドの戻り値を受け取るとすぐに <strong>SessionHandler::close()</strong> をコールします。
  
  このメソッドは、このハンドラが <strong>session_set_save_handler()</strong> で設定される前に ini 設定
  session.save_handler で定義されていた PHP の保存ハンドラをラップします。
  
  このクラスを継承して拡張する場合は、親の <strong>$write</strong> メソッドをコールすればこのメソッドのラッパーを実行
  でき、それに付随する内部コールバックも実行されます。 こうすれば、メソッドをオーバーライドしたり処
  理を横取りしてフィルタを追加したり (親の <strong>$write</strong> メソッドに送る前に <strong>$data</strong> を暗号化したりなど) でき
  ます。
  
  このメソッドに関する詳細は、 <strong>SessionHandlerInterface::write()</strong> のドキュメントを参照ください。

<comment>Param:</comment>
  <info>string</info>  <strong>$id</strong>    セッション id。
  <info>string</info>  <strong>$data</strong>  エンコードされたセッションのデータ。 これは、PHP が内部的にスーパーグローバル
                 $_SESSION をエンコードしてシリアライズし、それを渡したものです。 セッションが使うシ
                 リアライズ方式は、通常のシリアライズとは別のものであることに注意しましょう。

<comment>Return:</comment>
  <info>bool</info>  返り値 (通常は、<info>true</info> が成功そして <info>false</info> が失敗を表します)。この値は PHP で内部的に処理される
        ものであることに注意しましょう。

<comment>See Also:</comment>
   * session.serialize_handler


id: SessionHandlerInterface
type: class
doc:
<comment>Description:</comment>
  <class>SessionHandlerInterface</class> は カスタムセッションハンドラを作成する際の最低限のプロトタイプを定義した
  インターフェイスです。 自作のセッションハンドラを オブジェクト指向型 の起動方法で
  <strong>session_set_save_handler()</strong> に渡すために、このインターフェイスを実装することができます。
  
  このクラスのコールバックメソッドは PHP が内部的にコールするものであり、 ユーザーのコードから呼ばれ
  ることは想定していないことに注意しましょう。


id: SessionHandlerInterface::close
type: function
doc:
<comment>Description:</comment>
  セッションを閉じる
  
  現在のセッションを閉じます。この関数はセッションを閉じるときに自動的に実行されます。 あるいは、明
  示的に <strong>session_write_close()</strong> 経由で実行することもできます。

<comment>Return:</comment>
  <info>bool</info>  返り値 (通常は、<info>true</info> が成功そして <info>false</info> が失敗を表します)。この値は PHP で内部的に処理される
        ものであることに注意しましょう。


id: SessionHandlerInterface::destroy
type: function
doc:
<comment>Description:</comment>
  セッションを破棄する
  
  セッションを破棄します。<strong>session_regenerate_id()</strong> ($destroy = <info>true</info>) や <strong>session_destroy()</strong> からコール
  され、<strong>session_decode()</strong> が失敗したときにもコールされます。

<comment>Param:</comment>
  <info>string</info>  <strong>$id</strong>  破棄するセッション ID。

<comment>Return:</comment>
  <info>bool</info>  返り値 (通常は、<info>true</info> が成功そして <info>false</info> が失敗を表します)。この値は PHP で内部的に処理される
        ものであることに注意しましょう。


id: SessionHandlerInterface::gc
type: function
doc:
<comment>Description:</comment>
  古いセッションを削除する
  
  有効期限を過ぎたセッションを削除します。 session.gc_divisor、 session.gc_probability および
  session.gc_maxlifetime の設定に基づいて、 <strong>session_start()</strong> からコールされます。

<comment>Param:</comment>
  <info>int</info>  <strong>$max_lifetime</strong>  直近の <strong>$max_lifetime</strong> 秒の間に更新されていないセッションを削除します。

<comment>Return:</comment>
  <info>int|false</info>  成功時に、削除したセッションの数を返します。 失敗した場合に <info>false</info> を返します。 この値
             は、処理を続けるために PHP の内部にも返される点に注意して下さい。


id: SessionHandlerInterface::open
type: function
doc:
<comment>Description:</comment>
  セッションを開始する
  
  既存のセッションを再度初期化するか、あるいは新しいセッションを作成します。 セッションが開始したり
  <strong>session_start()</strong> が実行されたりしたときにコールされます。

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>  セッションを格納/取得するパス。
  <info>string</info>  <strong>$name</strong>  セッション名。

<comment>Return:</comment>
  <info>bool</info>  返り値 (通常は、<info>true</info> が成功そして <info>false</info> が失敗を表します)。この値は PHP で内部的に処理される
        ものであることに注意しましょう。

<comment>See Also:</comment>
   * <strong>session_name()</strong>
   * session.auto-start


id: SessionHandlerInterface::read
type: function
doc:
<comment>Description:</comment>
  セッションのデータを読み込む
  
  セッションのデータをセッションストレージから読み込み、その結果を返します。 セッションを開始した直
  後、あるいは <strong>session_start()</strong> を実行したときにコールされます。 このメソッドがコールされる直前に
  <strong>SessionHandlerInterface::open()</strong> が実行されることに注意しましょう。
  
  このメソッドは、セッションが開始するときに PHP 自身がコールします。 このメソッドは、指定したセッ
  ション ID のセッションデータをストレージから取得しなければなりません。 返す文字列の書式は、
  <strong>SessionHandlerInterface::write()</strong> に渡されたものと同様にシリアライズされたものでなければなりませ
  ん。 データが見つからない場合は <info>false</info> を返します。
  
  このメソッドが返すデータは、PHP が内部的にデコードします。デコードに使うメソッドは
  session.serialize_handler で指定します。デコードした結果をスーパーグローバル $_SESSION に格納しま
  す。
  
  シリアライズ方式は <strong>unserialize()</strong> とは異なっており、アクセスするためには <strong>session_decode()</strong> を使うこ
  とに注意しましょう。

<comment>Param:</comment>
  <info>string</info>  <strong>$id</strong>  セッション id。

<comment>Return:</comment>
  <info>string|false</info>  読み込んだデータをエンコードした文字列を返します。 何も読まなかった場合は <info>false</info> を返
                さなければなりません。 この値は、PHP が内部的に使うためだけのものであることに注意し
                ましょう。

<comment>See Also:</comment>
   * session.serialize_handler


id: SessionHandlerInterface::write
type: function
doc:
<comment>Description:</comment>
  セッションのデータを書き込む
  
  セッションのデータをセッションストレージに書き込みます。 <strong>session_write_close()</strong> からコールされ、
  <strong>session_register_shutdown()</strong> が失敗したときや通常のシャットダウン時にもコールされます。
  <strong>SessionHandlerInterface::close()</strong> がこの関数の直後にコールされることに注意しましょう。
  
  PHP は、セッションの保存と終了の準備ができたときにこのメソッドをコールします。 スーパーグローバル
  $_SESSION のセッションデータをエンコードして 文字列にシリアライズし、セッション ID とともにこのメ
  ソッドに渡して格納させます。 シリアライズの方式は session.serialize_handler で設定します。
  
  このメソッドが PHP からコールされるのは、通常は出力バッファが閉じた後であることに注意しましょう。
  ただし、 明示的に <strong>session_write_close()</strong> をコールした場合は別です。

<comment>Param:</comment>
  <info>string</info>  <strong>$id</strong>    セッション id。
  <info>string</info>  <strong>$data</strong>  エンコードされたセッションデータ。 これは、PHP がスーパーグローバル $_SESSION の内
                 容を内部的にシリアライズした結果の文字列で、それがこのパラメータに渡されます。 セッ
                 ションのシリアライズには通常とは別の方式を使っていることに注意しましょう。

<comment>Return:</comment>
  <info>bool</info>  返り値 (通常は、<info>true</info> が成功そして <info>false</info> が失敗を表します)。この値は PHP で内部的に処理される
        ものであることに注意しましょう。

<comment>See Also:</comment>
   * session.serialize_handler


id: SessionIdInterface
type: class
doc:
<comment>Description:</comment>
  <class>SessionIdInterface</class> は カスタムのセッションハンドラを作成するためのオプションのメソッドを定義しま
  す。 オブジェクト指向型 の呼び出しを使い、 カスタムのセッションハンドラを
  <strong>session_set_save_handler()</strong> に渡すために、 このインターフェイスを実装することができます。
  
  このクラスのコールバックメソッドは PHP が内部的にコールするものであり、 ユーザーのコードから呼ばれ
  ることは想定していないことに注意しましょう。


id: SessionIdInterface::create_sid
type: function
doc:
<comment>Description:</comment>
  セッションIDを作成する
  
  新しい セッションID を生成します。 この関数は、新しい セッションID を生成する必要がある場合に自動
  的に実行されます。

<comment>Return:</comment>
  <info>string</info>  新しい セッションID を返します。  この値は、PHP が処理を行うために内部的に返す値であること
          に注意して下さい。

<comment>See Also:</comment>
   * SessionHandler::create_sid


id: SessionUpdateTimestampHandlerInterface
type: class
doc:
<comment>Description:</comment>
  <class>SessionUpdateTimestampHandlerInterface</class> は カスタムセッションハンドラを作成する際の最低限のプロトタ
  イプを定義したインターフェイスです。 自作のセッションハンドラを オブジェクト指向型 の起動方法で
  <strong>session_set_save_handler()</strong> に渡すために、このインターフェイスを実装することができます。
  
  このクラスのコールバックメソッドは PHP が内部的にコールするものであり、 ユーザーのコードから呼ばれ
  ることは想定していないことに注意しましょう。


id: SessionUpdateTimestampHandlerInterface::updateTimestamp
type: function
doc:
<comment>Description:</comment>
  タイムスタンプを更新する
  
  セッションが最後に変更されたタイムスタンプを更新します。 この関数はセッションが更新された場合に自
  動的に実行されます。

<comment>Param:</comment>
  <info>string</info>  <strong>$id</strong>    セッションID
  <info>string</info>  <strong>$data</strong>  セッションデータ

<comment>Return:</comment>
  <info>bool</info>  タイムスタンプが更新されたら <info>true</info> を、 そうでなければ <info>false</info> を返します。 この値は、PHP が処
        理を行うために内部的に返す値であることに注意して下さい。


id: SessionUpdateTimestampHandlerInterface::validateId
type: function
doc:
<comment>Description:</comment>
  セッションIDを検証する
  
  与えられた セッションID を検証します。 そのID を持つセッションが既に存在している場合、セッションID
  は有効です。 この関数はセッションが開始されようとしている時に、 セッションID が与えられ、かつ
  session.use_strict_mode が有効な場合に自動的に実行されます。

<comment>Param:</comment>
  <info>string</info>  <strong>$id</strong>  セッションID

<comment>Return:</comment>
  <info>bool</info>  セッションIDが正しければ <info>true</info> を、そうでなければ <info>false</info> を返します。 この値は、PHP が処理を行
        うために内部的に返す値であることに注意して下さい。


id: SimdJsonException
type: class
doc:
<comment>Description:</comment>
  Exception thrown if <strong>simdjson_decode()</strong>, <strong>simdjson_key_count()</strong>, <strong>simdjson_key_exists()</strong>, or
  <strong>simdjson_key_value()</strong>.
   For possible values see the simdjson error codes constants.


id: SimdJsonValueError
type: class
doc:
<comment>Description:</comment>
  A <class>SimdJsonValueError</class> is thrown when the type of an argument to a function from simdjson is correct
  but the value of it is incorrect. E.g. when the JSON decoding $depth is not positive or the $depth
  is too large.


id: SimpleXMLElement::__construct
type: function
doc:
<comment>Description:</comment>
  新しい SimpleXMLElement オブジェクトを作成する
    
  
  新しい <class>SimpleXMLElement</class> オブジェクトを作成します。

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>               整形式 XML 文字列。 もし <strong>$dataIsURL</strong> が <info>true</info> の場合には、XML ドキュメン
                              トへのパスあるいは URL。
  <info>int</info>     <strong>$options</strong>            オプションで、XML文書を読み込む場合に影響する 追加の Libxml パラメータ
                              を指定するために使います。 XML文書を出力する場合に影響するオプション
                              (例: <info>LIBXML_NOEMPTYTAG</info>) は静かに無視されます。
                              
                              深くネストされた XML や巨大なテキストノードを処理する際には
                              <info>LIBXML_PARSEHUGE</info> を指定することになるでしょう。
  <info>bool</info>    <strong>$dataIsURL</strong>          デフォルトでは <strong>$dataIsURL</strong> は <info>false</info> です。 <strong>$data</strong> が、文字列データではな
                              く XML ドキュメントへのパスあるいは URL である場合に <info>true</info> を使用しま
                              す。
  <info>string</info>  <strong>$namespaceOrPrefix</strong>  名前空間プレフィックスあるいは URI。
  <info>bool</info>    <strong>$isPrefix</strong>           <strong>$namespaceOrPrefix</strong> がプレフィックスの場合は <info>true</info>、 URI の場合は
                              <info>false</info>。デフォルトは <info>false</info>。

<comment>See Also:</comment>
   * 
   * <strong>simplexml_load_string()</strong>
   * <strong>simplexml_load_file()</strong>
   * 
   * <strong>libxml_use_internal_errors()</strong>
   * <strong>libxml_set_streams_context()</strong>


id: SimpleXMLElement::__toString
type: function
doc:
<comment>Description:</comment>
  文字列で要素の内容を返す
  
  この要素に直接入っているテキストの内容を返します。 この要素の子要素の内部にあるテキストの内容を返
  してはいけません。

<comment>Return:</comment>
  <info>string</info>  成功したときは、テキストの内容を文字列で返します。 失敗したときは空文字列を返します。

<comment>See Also:</comment>
   * SimpleXMLElement::asXML


id: SimpleXMLElement::addAttribute
type: function
doc:
<comment>Description:</comment>
  SimpleXML 要素に属性を追加する
    
  
  SimpleXML 要素に属性を追加します。

<comment>Param:</comment>
  <info>string</info>       <strong>$qualifiedName</strong>  追加する属性の名前。
  <info>string</info>       <strong>$value</strong>          属性の値。
  <info>string|null</info>  <strong>$namespace</strong>      指定されている場合は、その属性が所属する名前空間。

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

<comment>See Also:</comment>
   * SimpleXMLElement::addChild
   * 


id: SimpleXMLElement::addChild
type: function
doc:
<comment>Description:</comment>
  XML ノードに子要素を追加する
    
  
  ノードに子要素を追加し、子要素の SimpleXMLElement を返します。

<comment>Param:</comment>
  <info>string</info>       <strong>$qualifiedName</strong>  追加する子要素の名前。
  <info>string|null</info>  <strong>$value</strong>          指定されている場合は、子要素の値。
  <info>string|null</info>  <strong>$namespace</strong>      指定されている場合は、その子要素が所属する名前空間。

<comment>Return:</comment>
  <info>SimpleXMLElement|null</info>  <return>addChild</return> メソッドは、 XML ノードに追加した子要素を表す <info>SimpleXMLElement</info> オ
                         ブジェクトを返します。 失敗時に <info>null</info> を返します。

<comment>See Also:</comment>
   * SimpleXMLElement::addAttribute
   * 


id: SimpleXMLElement::asXML
type: function
doc:
<comment>Description:</comment>
  SimpleXML 要素に基づき整形式の XML 文字列を返す
    
  
  <return>asXML</return> メソッドは、親オブジェクトのデータを XML version 1.0 形式にフォーマットします。

<comment>Param:</comment>
  <info>string|null</info>  <strong>$filename</strong>  文字列を指定した場合、データを返すかわりにファイルにデータを書き込みます。

<comment>Return:</comment>
  <info>string|bool</info>  <strong>$filename</strong> が指定されていない場合、この関数は 成功時に <info>string</info> 、エラー時に <info>false</info> を返
               します。 パラメータが指定されていた場合は、ファイルが正常に書き込めたときに <info>true</info> 、そ
               うでないときに <info>false</info> を返します。

<comment>See Also:</comment>
   * SimpleXMLElement::__toString
   * 


id: SimpleXMLElement::attributes
type: function
doc:
<comment>Description:</comment>
  要素の属性を定義する
  
  この関数は、XMLタグの中で定義された属性とその値を取得します。
  
  SimpleXML では、ほとんどのメソッドに反復処理を追加するための手順が定義されています。
  これらは、<strong>var_dump()</strong> やオブジェクトを評価する他の手段で
  見ることはできません。

<comment>Param:</comment>
  <info>string|null</info>  <strong>$namespaceOrPrefix</strong>  オプションで指定する、取得した属性の名前空間。
  <info>bool</info>         <strong>$isPrefix</strong>           デフォルトは <info>false</info>。

<comment>Return:</comment>
  <info>SimpleXMLElement|null</info>  <class>SimpleXMLElement</class> オブジェクトを返します。 これを反復処理すれば、そのタグの
                         属性を順に処理することができます。
                         
                         タグではなく属性を指している <class>SimpleXMLElement</class> に対してコールした場合は <info>null</info>
                         を返します。

<comment>See Also:</comment>
   * 


id: SimpleXMLElement::children
type: function
doc:
<comment>Description:</comment>
  指定したノードの子ノードを見付ける
  
  このメソッドは、指定した要素の子を見つけます。 結果は、通常の反復子により取得できます。
  
  SimpleXML では、ほとんどのメソッドに反復処理を追加するための手順が定義されています。
  これらは、<strong>var_dump()</strong> やオブジェクトを評価する他の手段で
  見ることはできません。

<comment>Param:</comment>
  <info>string|null</info>  <strong>$namespaceOrPrefix</strong>  XML 名前空間。
  <info>bool</info>         <strong>$isPrefix</strong>           <strong>$isPrefix</strong> が <info>true</info> の場合は <strong>$namespaceOrPrefix</strong> をプレフィックスと
                                   して扱います。<info>false</info> の場合は <strong>$namespaceOrPrefix</strong> を名前空間 URL と
                                   して扱います。

<comment>Return:</comment>
  <info>SimpleXMLElement|null</info>  ノードが子を持つかどうかにかかわらず <class>SimpleXMLElement</class> 要素を返します。 ノー
                         ドが属性である場合は、<info>null</info> を返します。

<comment>See Also:</comment>
   * SimpleXMLElement::count
   * <strong>count()</strong>


id: SimpleXMLElement::count
type: function
doc:
<comment>Description:</comment>
  子要素を数える
  
  このメソッドは、子要素を数えます。

<comment>Return:</comment>
  <info>int</info>  子要素の数を返します。

<comment>See Also:</comment>
   * SimpleXMLElement::children


id: SimpleXMLElement::current
type: function
doc:
<comment>Description:</comment>
  現在の要素を返す
  
  PHP 8.0 より前のバージョンでは、 SimpleXMLElement::current  はサブクラスの <class>SimpleXMLIterator</class> での
  み宣言されていました。
  
  このメソッドは、現在の要素の <class>SimpleXMLElement</class> を返します。

<comment>Return:</comment>
  <info>SimpleXMLElement</info>  このメソッドは、現在の要素の <class>SimpleXMLElement</class> を返します。

<comment>See Also:</comment>
   * SimpleXMLElement::key
   * SimpleXMLElement::next
   * SimpleXMLElement::rewind
   * SimpleXMLElement::valid
   * <class>SimpleXMLElement</class>


id: SimpleXMLElement::getChildren
type: function
doc:
<comment>Description:</comment>
  現在の要素の子要素を返す
  
  PHP 8.0 より前のバージョンでは、 SimpleXMLElement::getChildren は サブクラスの <class>SimpleXMLIterator</class>
  でのみ宣言されていました。
  
  このメソッドは、現在の <class>SimpleXMLElement</class> 要素の子要素を含む <class>SimpleXMLElement</class> オブジェクトを返しま
  す。

<comment>Return:</comment>
  <info>SimpleXMLElement|null</info>  現在の要素の子要素を含む <class>SimpleXMLElement</class> オブジェクトを返します。


id: SimpleXMLElement::getDocNamespaces
type: function
doc:
<comment>Description:</comment>
  ドキュメントで宣言されている名前空間を返す
    
  
  ドキュメントで宣言されている名前空間を返します。

<comment>Param:</comment>
  <info>bool</info>  <strong>$recursive</strong>  指定されている場合は、親ノードおよび子ノードで宣言されている全ての名前空間を返し
                    ます。 されていない場合は、ルートノードで宣言されている名前空間のみを返します。
  <info>bool</info>  <strong>$fromRoot</strong>   XML 文書のルートノードからでなく、子ノードの配下の名前空間を再帰的にチェックでき
                    るようにします。

<comment>Return:</comment>
  <info>array|false</info>  <return>getDocNamespaces</return> メソッドは、 名前空間名および関連付けられた URI を配列で返します。

<comment>See Also:</comment>
   * SimpleXMLElement::getNamespaces
   * SimpleXMLElement::registerXPathNamespace


id: SimpleXMLElement::getName
type: function
doc:
<comment>Description:</comment>
  XML 要素の名前を取得する
  
  XML 要素の名前を取得します。

<comment>Return:</comment>
  <info>string</info>  <return>getName</return> メソッドは、 SimpleXMLElement オブジェクトが参照している XML タグの名前を <info>string</info>
          で返します。


id: SimpleXMLElement::getNamespaces
type: function
doc:
<comment>Description:</comment>
  ドキュメントで使用している名前空間を返す
    
  
  ドキュメントで使用している名前空間を返します。

<comment>Param:</comment>
  <info>bool</info>  <strong>$recursive</strong>  指定されている場合は、親ノードおよび子ノードで使用している全ての名前空間を返しま
                    す。 されていない場合は、ルートノードで使用している名前空間のみを返します。

<comment>Return:</comment>
  <info>array</info>  <return>getNamespaces</return> メソッドは、 名前空間名および関連付けられた URI を配列で返します。

<comment>See Also:</comment>
   * SimpleXMLElement::getDocNamespaces
   * SimpleXMLElement::registerXPathNamespace


id: SimpleXMLElement::hasChildren
type: function
doc:
<comment>Description:</comment>
  現在の要素が子要素を持つかどうかを調べる
  
  PHP 8.0 より前のバージョンでは、 SimpleXMLElement::hasChildren は サブクラスの <class>SimpleXMLIterator</class>
  でのみ宣言されていました。
  
  このメソッドは、現在の <class>SimpleXMLElement</class> 要素が子要素を持つかどうかを調べます。

<comment>Return:</comment>
  <info>bool</info>  現在の要素が子要素を持つ場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。


id: SimpleXMLElement::key
type: function
doc:
<comment>Description:</comment>
  現在のキーを返す
  
  PHP 8.0 より前のバージョンでは、 SimpleXMLElement::key はサブクラスの <class>SimpleXMLIterator</class> でのみ宣言
  されていました。
  
  このメソッドは、現在の要素の XML タグ名を取得します。

<comment>Return:</comment>
  <info>string</info>  現在の <class>SimpleXMLElement</class> オブジェクトが参照する要素の XML タグ名を返します。


id: SimpleXMLElement::next
type: function
doc:
<comment>Description:</comment>
  次の要素に移動する
  
  このメソッドは、<class>SimpleXMLElement</class> を次の要素に移動します。

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


id: SimpleXMLElement::registerXPathNamespace
type: function
doc:
<comment>Description:</comment>
  次の XPath クエリ用の prefix/ns コンテキストを作成する
    
  
  次の XPath クエリ用の prefix/ns コンテキストを作成します。特にこれが有用なのは、 XML ドキュメント
  の提供者が名前空間プレフィックスを変更したような場合です。 <return>registerXPathNamespace</return> はプレフィックス
  を作成して名前空間に関連付け、 そのプレフィックスで名前空間のノードにアクセスできるようにします。
  提供者側がプレフィックスを変更したとしても、コードを書き換える必要はありません。

<comment>Param:</comment>
  <info>string</info>  <strong>$prefix</strong>  <strong>$ns</strong> で指定した名前空間への XPath クエリで使用する、 名前空間プレフィックス。
  <info></info>        <strong>$ns</strong>      XPath クエリで使用する名前空間。 これは XML ドキュメントで使用している名前空間と
                   一致していなければなりません。 一致していない場合、<strong>$prefix</strong> を使用した XPath クエ
                   リは何も結果を返しません。

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

<comment>See Also:</comment>
   * SimpleXMLElement::xpath
   * SimpleXMLElement::getDocNamespaces
   * SimpleXMLElement::getNamespaces


id: SimpleXMLElement::rewind
type: function
doc:
<comment>Description:</comment>
  最初の要素に巻き戻す
  
  このメソッドは、<class>SimpleXMLElement</class> を最初の要素に巻き戻します。

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


id: SimpleXMLElement::saveXML
type: function
doc:
<comment>Description:</comment>
  SimpleXMLElement::asXML のエイリアス
  
  このメソッドは次のメソッドのエイリアスです。 SimpleXMLElement::asXML


id: SimpleXMLElement::valid
type: function
doc:
<comment>Description:</comment>
  現在の要素が有効かどうかを調べる
  
  このメソッドは、現在の要素が SimpleXMLElement::rewind あるいは SimpleXMLElement::next をコールした
  後で有効かどうかを調べます。

<comment>Return:</comment>
  <info>bool</info>  現在の要素が有効な場合に <info>true</info>、そうでない場合に <info>false</info> を返します。


id: SimpleXMLElement::xpath
type: function
doc:
<comment>Description:</comment>
  XML データに Xpath クエリを実行する
  
  <return>xpath</return>メソッドは、 XPath <strong>$expression</strong>にマッチする SimpleXML ノードを検索します。

<comment>Param:</comment>
  <info>string</info>  <strong>$expression</strong>  XPath パス。

<comment>Return:</comment>
  <info>array|null|false</info>  SimpleXMLElement オブジェクトの<info>配列</info>を返します。 エラーが発生した場合は <info>null</info> また
                    は <info>false</info> を返します。

<comment>See Also:</comment>
   * SimpleXMLElement::registerXPathNamespace
   * SimpleXMLElement::getDocNamespaces
   * SimpleXMLElement::getNamespaces
   * 


id: SimpleXMLIterator
type: class
doc:
<comment>Description:</comment>
  SimpleXMLIterator は、<class>SimpleXMLElement</class> オブジェクトのすべてのノードに対する再帰的な反復処理を提供
  します。


id: SoapClient
type: class
doc:
<comment>Description:</comment>
  SoapClient クラスは SOAP 1.1、SOAP 1.2 サーバー用のクライアントとなります。 WSDL モードあるいは
  non-WSDL モードで動作します。


id: SoapClient::__call
type: function
doc:
<comment>Description:</comment>
  SOAP 関数をコールする (非推奨)
  
  このメソッドを直接呼ぶのは推奨しません。 通常、SOAP の関数は <class>SoapClient</class> オブジェクトのメソッドとし
  て呼べるようになっています。 それができない場合、あるいは追加オプションを指定する必要がある場合
  は、 SoapClient::__soapCall を使いましょう。

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  コールするSOAP関数の名前。
  <info>array</info>   <strong>$args</strong>  関数に渡す引数の配列。 連想配列でも、数値添字形式の配列でも構いません。 ほとんどの
                 SOAPサーバーに対しては、 引数の名前を指定することが必須であり、 その場合は、連想配
                 列を指定する必要があることに注意して下さい。

<comment>Return:</comment>
  <info>mixed</info>  SOAP 関数は、一つまたは複数の値を返す可能性があります。 SOAP 関数から値をひとつだけ返す場合
         は、 返り値はスカラーになります。 複数の値を返す場合は、出力パラメータの名前がついた連想配
         列を返します。
         
         エラーが発生した場合、 かつ <class>SoapClient</class> の <return>exceptions</return> を <info>false</info> に設定した場合は、 <class>SoapFault</class>
         オブジェクトを返します。


id: SoapClient::__construct
type: function
doc:
<comment>Description:</comment>
  SoapClient のコンストラクタ
  
  SOAP サービスに接続するための <class>SoapClient</class> オブジェクトを生成します。

<comment>Param:</comment>
  <info>string|null</info>  <strong>$wsdl</strong>                サービスを記述した WSDL ファイルまたは URI。 これは自動的にクラ
                                    イアントを設定します。 指定されない場合、クライアントは 非WSDL
                                    モードで動作します。
                                    
                                    デフォルトでは、 WSDL ファイルはパフォーマンスのためキャッシュさ
                                    れます。 このキャッシュ機能を無効にしたり、設定を変更する場合
                                    は、 SOAP 設定オプション や <return>cache_wsdl</return> オプション を参照くださ
                                    い。
  <info>array</info>        <strong>$options</strong>             SOAP クライアントに指定する追加オプションを連想配列で指定しま
                                    す。 <strong>$wsdl</strong> が指定された場合、 このパラメータはオプションです。
                                    指定されない場合、 <return>location</return> と<return>url</return> オプションを指定する必要があり
                                    ます。 <strong>$location</strong><info>string</info> リクエストを送信する SOAP サーバーのURL
                                    <strong>$wsdl</strong> パラメータが指定されない場合、 必須です。 <strong>$wsdl</strong> と
                                    <return>location</return> が指定された場合、 <return>location</return> オプションは WSDL ファイル
                                    で指定されたあらゆる location を上書きします。 <strong>$uri</strong><info>string</info> SOAP
                                    サービスのターゲット名前空間です。 <strong>$wsdl</strong> が指定されていない場
                                    合、このパラメータは必須です。 そうでない場合、この値は無視され
                                    ます。 <strong>$style</strong><info>int</info><info>SOAP_RPC</info> と <info>SOAP_DOCUMENT</info> を使うと、 このクライ
                                    アントで使うバインディングスタイルを指定します。 <info>SOAP_RPC</info> は
                                    RPCスタイルのバインディングを指定します。 この場合の SOAP リクエ
                                    ストのボディには、 関数コールの標準エンコーディングが含まれま
                                    す。 <info>SOAP_DOCUMENT</info>  は ドキュメントスタイルのバインディングを指
                                    定します。 この場合の SOAP リクエストのボディには、 サービス定義
                                    を記した XML ドキュメントが含まれます。 <strong>$wsdl</strong>  が指定された場
                                    合、 このオプションは無視され、 スタイルは WDSL ファイルから読み
                                    込まれます。  このオプションと <strong>$wsdl</strong> パラメータ を両方指定しな
                                    かった場合、 RPCスタイルを使います。 <strong>$use</strong><info>int</info><info>SOAP_ENCODED</info> や
                                    <info>SOAP_LITERAL</info> を使うと、 このクライアントで使うエンコーディングス
                                    タイルを指定します。 <info>SOAP_ENCODED</info> は、 SOAP 仕様で定義された型を
                                    使い、エンコーディングを指定します。 <info>SOAP_LITERAL</info> は、 サービス
                                    で定義されたスキームを使い、 エンコーディングを指定します。
                                    <strong>$wsdl</strong>  が指定された場合、 このオプションは無視され、 エンコー
                                    ディングは WDSL ファイルから読み込まれます。  このオプションと
                                    <strong>$wsdl</strong> パラメータ を両方指定しなかった場合、 "encoded" スタイルを
                                    使います。 <strong>$soap_version</strong><info>int</info> 使用する SOAP プロトコルのバージョン
                                    を指定します: SOAP 1.1 の場合は <info>SOAP_1_1</info> を指定します。 SOAP 1.2
                                    の場合は <info>SOAP_1_2</info> を指定します。  省略した場合は、SOAP 1.1 を使
                                    います。 <strong>$authentication</strong><info>int</info> HTTP 認証をリクエスト時に使う際の、
                                    認証方法を指定します。 <info>SOAP_AUTHENTICATION_BASIC</info> と
                                    <info>SOAP_AUTHENTICATION_DIGEST</info> が指定できます。  省略された場合、 か
                                    つ <return>login</return> オプションが指定されると Basic 認証を使います。
                                    <strong>$login</strong><info>string</info> Basic 認証と、Digest 認証で使うユーザー名を指定しま
                                    す。 <strong>$password</strong><info>string</info> Basic 認証と、Digest 認証で使うパスワードを
                                    指定します。  HTTPS クライアント認証で使う <return>passphrase</return> と混同しな
                                    いようにして下さい。 <strong>$local_cert</strong><info>string</info> HTTPS 認証で使うクライア
                                    ント証明書のパス。 証明書ファイルは、 証明書と秘密鍵が両方入った
                                    状態で、 PEMエンコードされている必要があります。  このファイルに
                                    は、発行者のチェインも含めることができます。 それらを含める場
                                    合、クライアント証明書の後に置く必要があります。 <strong>$stream_context</strong>
                                    でも設定できます。 この場合、秘密鍵のファイルは別に指定できま
                                    す。 <strong>$passphrase</strong><info>string</info><return>local_cert</return>  オプションで指定したクライアン
                                    ト証明書のための パスフレーズ。  Basic 認証や Digest 認証で使う
                                    <return>password</return> と混同しないようにして下さい。 <strong>$stream_context</strong> でも設定
                                    できます。 <strong>$proxy_host</strong><info>string</info> HTTPリクエスト時に使う、 プロキシ
                                    サーバーとして用いるホスト名を指定します。 <return>proxy_port</return> オプション
                                    も指定する必要があります。 <strong>$proxy_port</strong><info>int</info><return>proxy_host</return> で指定したプ
                                    ロキシサーバーに接続する際に使うポート番号。
                                    <strong>$proxy_login</strong><info>string</info><return>proxy_host</return> で指定したプロキシサーバーに接続す
                                    る際に、 Basic 認証で用いるオプションのユーザー名
                                    <strong>$proxy_password</strong><info>string</info><return>proxy_host</return> で指定したプロキシサーバーに接続
                                    する際に、 Basic 認証で用いるオプションのパスワード
                                    <strong>$compression</strong><info>int</info> SOAP リクエストとレスポンスの圧縮を有効にしま
                                    す。  この値は、3つの値を ビット演算のOR で指定します: オプショ
                                    ンの <info>SOAP_COMPRESSION_ACCEPT</info> は、"Accept-Encoding" ヘッダを指定
                                    します。 <info>SOAP_COMPRESSION_GZIP</info> や <info>SOAP_COMPRESSION_DEFLATE</info> は、
                                    使用する圧縮アルゴリズムと、 リクエストで使う圧縮レベルを 1 から
                                    9 の間の数値で指定します。 たとえば、双方向の gzip 圧縮を最高の
                                    圧縮レベルで行う場合は、 <return>SOAP_COMPRESSION_ACCEPT |
                                    SOAP_COMPRESSION_GZIP | 9</return> を指定します。 <strong>$encoding</strong><info>string</info> 内部的
                                    な文字エンコーディングを指定します。 リクエストはここで指定され
                                    たエンコーディングから、 常に UTF-8 に変換して送られ、 レスポン
                                    スはこのエンコーディングに変換されます。 <strong>$trace</strong><info>bool</info> リクエストや
                                    レスポンスのキャプチャを行います。 キャプチャした情報は
                                    SoapClient::__getLastRequest,
                                    SoapClient::__getLastRequestHeaders,
                                    SoapClient::__getLastResponse,
                                    SoapClient::__getLastResponseHeaders. を使ってアクセスできます。
                                    省略した場合のデフォルト値は <info>false</info> です。 <strong>$classmap</strong><info>array</info> WSDL 型
                                    を PHP クラスにマッピングするために使用可能です。 このオプション
                                    には、キーとしてWSDL 型、 値として PHP クラスの名前を持つ配列を
                                    指定する必要があります。 型の名前は、 要素の(タグ)名前と一致させ
                                    る必要はないことに注意して下さい。  指定するクラス名は、常に 名
                                    前空間 で完全修飾されているべきですし、 <return>\</return> で始まってはいけませ
                                    ん。 正しい名前は、 ::class を使えば生成できます。  クラスのイン
                                    スタンスを生成する場合、 コンストラクタはコールされず、 個別のプ
                                    ロパティに対して マジックメソッド __set() と __get() が コールさ
                                    れる点にも注意して下さい。 <strong>$typemap</strong><info>array</info> ユーザー定義のコール
                                    バック関数を使って、 型マッピングを定義します。 型マッピングは配
                                    列で定義され、 キーは <return>type_name</return> (XML 要素型を指定した文字列)、
                                    <return>type_ns</return> (名前空間URI を指定した文字列)、 <return>from_xml</return> (文字列を受け
                                    取り、 オブジェクトを返す <info>callable</info>)、 <return>to_xml</return> (オブジェクトをひと
                                    つ受け取り、 文字列を返す <info>callable</info>) です。 <strong>$exceptions</strong><info>bool</info> エ
                                    ラーが起きた際に、  <class>SoapFault</class> をスローするかどうかを指定します。
                                    デフォルトは <info>true</info> です。 <strong>$connection_timeout</strong><info>int</info> SOAP サービスに
                                    接続する際のタイムアウト秒数を指定します。 これを使用しても、 レ
                                    スポンスが遅いサービスのタイムアウトを定義することはできません。
                                    サービスのコールが完了するまでの待ち時間を制限するには、
                                    default_socket_timeout が使えます。 <strong>$cache_wsdl</strong><info>int</info><strong>$wsdl</strong> を指定し
                                    た場合、 かつ soap.wsdl_cache_enabled が有効になっている場合に、
                                    このオプションはキャッシュのタイプを指定します。
                                    <info>WSDL_CACHE_NONE</info>, <info>WSDL_CACHE_DISK</info>, <info>WSDL_CACHE_MEMORY</info>,
                                    <info>WSDL_CACHE_BOTH</info> のいずれかが指定できます。  ふたつのタイプの
                                    キャッシュが利用できます。 WSDL を現在のプロセスのメモリにキャッ
                                    シュする インメモリのキャッシュと、 WSDL をディスク上にキャッ
                                    シュし、 全てのプロセスと共有するディスクキャッシュがあります。
                                    ディスクキャッシュで使うディレクトリは soap.wsdl_cache_dir で指
                                    定できます。 どちらのタイプのキャッシュでも、
                                    soap.wsdl_cache_ttl で指定した寿命があります。 インメモリキャッ
                                    シュの場合、 soap.wsdl_cache_limit でキャッシュエントリの数の最
                                    大値も指定できます。  この値を指定しない場合、  soap.wsdl_cache
                                    オプションの値を使います。 <strong>$user_agent</strong><info>string</info> リクエストをする際
                                    に <return>User-Agent</return> で使う値。 <strong>$stream_context</strong> でも指定できます。  こ
                                    の値を指定しない場合、 <return>"PHP-SOAP/"</return> の後に、 <info>PHP_VERSION</info> の値を付
                                    けたものを使います。 <strong>$stream_context</strong><info>resource</info> 追加のオプションを
                                    設定できる stream context。 これは <strong>stream_context_create()</strong> で生
                                    成できます。  このコンテキストには、 socket context options, SSL
                                    context options, HTTP context options が含まれます:
                                    <return>content_type</return>, <return>header</return>, <return>max_redirects</return>, <return>protocol_version</return>,
                                    <return>user_agent</return> が設定できます。 <return>'header'</return> コンテキストオプションで指
                                    定された場合、以下のHTTPヘッダは自動生成され、無視されることに注
                                    意して下さい: <return>host</return>, <return>connection</return>, <return>user-agent</return>, <return>content-length</return>,
                                    <return>content-type</return>, <return>cookie</return>, <return>authorization</return>, <return>proxy-authorization</return>
                                    <strong>$features</strong><info>int</info> 以下の機能を有効にするための、ひとつ以上のビットマ
                                    スク: <info>SOAP_SINGLE_ELEMENT_ARRAYS</info> レスポンスを配列にデコードする
                                    際には、 特定の親要素の中で要素名が一度または複数回現れるかをデ
                                    フォルトで自動検知します。 一度しか現れない要素については、 オブ
                                    ジェクトのプロパティを通じてコンテンツに直接アクセスできます。
                                    複数回現れる要素については、 プロパティには配列が含まれ、 マッチ
                                    する要素の内容の配列が入ります。 <info>SOAP_SINGLE_ELEMENT_ARRAYS</info> が有
                                    効になった場合、 一度しか現れない要素は要素数がひとつの配列にな
                                    ります。 これは全ての要素と一貫性を保つためです。 これは、レスポ
                                    ンスにスキーマを含んでいるWSDLを使っている場合にのみ意味がありま
                                    す。具体的には、以下の例を参照ください。
                                    <info>SOAP_USE_XSI_ARRAY_TYPE</info><return>use</return> オプション を使ったり、 WSDL プロパ
                                    ティを <return>encoded</return> に設定した場合に、 配列の型をスキーマ特有のそれに
                                    するのではなく、 <return>SOAP-ENC:Array</return> にします。
                                    <info>SOAP_WAIT_ONE_WAY_CALLS</info> WDSL が一方向のリクエストを指定していた
                                    場合であっても、 レスポンスを待つ。  <strong>$keep_alive</strong><info>bool</info><return>Connection:
                                    Keep-Alive</return> ヘッダや <return>Connection: close</return> を送信するかどうかを
                                    boolean で指定します。  デフォルトは <info>true</info> です。
                                    <strong>$ssl_method</strong><info>string</info> セキュアな HTTP 接続で用いる、 SSL または TLS
                                    のバージョンを指定します。 <info>SOAP_SSL_METHOD_SSLv2</info> や
                                    <info>SOAP_SSL_METHOD_SSLv3</info> を指定すると、 それぞれ SSL 2、 SSL 3 を強
                                    制的に使います。 <info>SOAP_SSL_METHOD_SSLv23</info> を指定しても意味がありま
                                    せん。 これは後方互換のためだけに存在しています。 PHP 7.2 以降で
                                    は、 <info>SOAP_SSL_METHOD_TLS</info> を指定しても同様に意味がありません。 こ
                                    れより前のバージョンでは、 この定数を指定すると TLS 1.0 を強制的
                                    に使っていました。  SSL バージョン 2 と 3 はセキュアでないとみな
                                    されています。 よってインストール済みの OpenSSL ライブラリではサ
                                    ポートされていない可能性があることに注意しましょう。  このオプ
                                    ションは PHP 8.1.0 以降では 推奨されません。 個別の TLS のバー
                                    ジョンを指定できる、 より柔軟性に富んだ代替があります。
                                    <strong>$stream_context</strong> オプションを 'crypto_method' コンテキストパラ
                                    メータと一緒に使うようにして下さい。 TLS 1.3 だけを指定する [
                                    'crypto_method' => STREAM_CRYPTO_METHOD_TLSv1_3_CLIENT ]
                                    ]);
                                    $client = new SoapClient("some.wsdl", ['context' => $context]);
                                    ]]> 
                                    
                                    リクエストを送信する SOAP サーバーのURL
                                    
                                    <strong>$wsdl</strong> パラメータが指定されない場合、 必須です。 <strong>$wsdl</strong> と
                                    <return>location</return> が指定された場合、 <return>location</return> オプションは WSDL ファイル
                                    で指定されたあらゆる location を上書きします。
                                    
                                    SOAP サービスのターゲット名前空間です。
                                    
                                    <strong>$wsdl</strong> が指定されていない場合、このパラメータは必須です。 そうで
                                    ない場合、この値は無視されます。
                                    
                                    <info>SOAP_RPC</info> と <info>SOAP_DOCUMENT</info> を使うと、 このクライアントで使うバイ
                                    ンディングスタイルを指定します。 <info>SOAP_RPC</info> は RPCスタイルのバイン
                                    ディングを指定します。 この場合の SOAP リクエストのボディには、
                                    関数コールの標準エンコーディングが含まれます。 <info>SOAP_DOCUMENT</info>  は
                                    ドキュメントスタイルのバインディングを指定します。 この場合の
                                    SOAP リクエストのボディには、 サービス定義を記した XML ドキュメ
                                    ントが含まれます。
                                    
                                    <strong>$wsdl</strong>  が指定された場合、 このオプションは無視され、 スタイルは
                                    WDSL ファイルから読み込まれます。
                                    
                                    このオプションと <strong>$wsdl</strong> パラメータ を両方指定しなかった場合、
                                    RPCスタイルを使います。
                                    
                                    <info>SOAP_ENCODED</info> や <info>SOAP_LITERAL</info> を使うと、 このクライアントで使うエ
                                    ンコーディングスタイルを指定します。 <info>SOAP_ENCODED</info> は、 SOAP 仕様
                                    で定義された型を使い、エンコーディングを指定します。
                                    <info>SOAP_LITERAL</info> は、 サービスで定義されたスキームを使い、 エンコー
                                    ディングを指定します。
                                    
                                    <strong>$wsdl</strong>  が指定された場合、 このオプションは無視され、 エンコー
                                    ディングは WDSL ファイルから読み込まれます。
                                    
                                    このオプションと <strong>$wsdl</strong> パラメータ を両方指定しなかった場合、
                                    "encoded" スタイルを使います。
                                    
                                    使用する SOAP プロトコルのバージョンを指定します: SOAP 1.1 の場
                                    合は <info>SOAP_1_1</info> を指定します。 SOAP 1.2 の場合は <info>SOAP_1_2</info> を指定し
                                    ます。
                                    
                                    省略した場合は、SOAP 1.1 を使います。
                                    
                                    HTTP 認証をリクエスト時に使う際の、 認証方法を指定します。
                                    <info>SOAP_AUTHENTICATION_BASIC</info> と <info>SOAP_AUTHENTICATION_DIGEST</info> が指定で
                                    きます。
                                    
                                    省略された場合、 かつ <return>login</return> オプションが指定されると Basic 認証
                                    を使います。
                                    
                                    Basic 認証と、Digest 認証で使うユーザー名を指定します。
                                    
                                    Basic 認証と、Digest 認証で使うパスワードを指定します。
                                    
                                    HTTPS クライアント認証で使う <return>passphrase</return> と混同しないようにして下
                                    さい。
                                    
                                    HTTPS 認証で使うクライアント証明書のパス。 証明書ファイルは、 証
                                    明書と秘密鍵が両方入った状態で、 PEMエンコードされている必要があ
                                    ります。
                                    
                                    このファイルには、発行者のチェインも含めることができます。 それ
                                    らを含める場合、クライアント証明書の後に置く必要があります。
                                    
                                    <strong>$stream_context</strong> でも設定できます。 この場合、秘密鍵のファイルは
                                    別に指定できます。
                                    
                                    <return>local_cert</return>  オプションで指定したクライアント証明書のための パス
                                    フレーズ。
                                    
                                    Basic 認証や Digest 認証で使う <return>password</return> と混同しないようにして下
                                    さい。
                                    
                                    <strong>$stream_context</strong> でも設定できます。
                                    
                                    HTTPリクエスト時に使う、 プロキシサーバーとして用いるホスト名を
                                    指定します。
                                    
                                    <return>proxy_port</return> オプションも指定する必要があります。
                                    
                                    <return>proxy_host</return> で指定したプロキシサーバーに接続する際に使うポート番
                                    号。
                                    
                                    <return>proxy_host</return> で指定したプロキシサーバーに接続する際に、 Basic 認証
                                    で用いるオプションのユーザー名
                                    
                                    <return>proxy_host</return> で指定したプロキシサーバーに接続する際に、 Basic 認証
                                    で用いるオプションのパスワード
                                    
                                    SOAP リクエストとレスポンスの圧縮を有効にします。
                                    
                                    この値は、3つの値を ビット演算のOR で指定します: オプションの
                                    <info>SOAP_COMPRESSION_ACCEPT</info> は、"Accept-Encoding" ヘッダを指定しま
                                    す。 <info>SOAP_COMPRESSION_GZIP</info> や <info>SOAP_COMPRESSION_DEFLATE</info> は、使用
                                    する圧縮アルゴリズムと、 リクエストで使う圧縮レベルを 1 から 9
                                    の間の数値で指定します。 たとえば、双方向の gzip 圧縮を最高の圧
                                    縮レベルで行う場合は、 <return>SOAP_COMPRESSION_ACCEPT |
                                    SOAP_COMPRESSION_GZIP | 9</return> を指定します。
                                    
                                    内部的な文字エンコーディングを指定します。 リクエストはここで指
                                    定されたエンコーディングから、 常に UTF-8 に変換して送られ、 レ
                                    スポンスはこのエンコーディングに変換されます。
                                    
                                    リクエストやレスポンスのキャプチャを行います。 キャプチャした情
                                    報は SoapClient::__getLastRequest,
                                    SoapClient::__getLastRequestHeaders,
                                    SoapClient::__getLastResponse,
                                    SoapClient::__getLastResponseHeaders. を使ってアクセスできます。
                                    
                                    省略した場合のデフォルト値は <info>false</info> です。
                                    
                                    WSDL 型を PHP クラスにマッピングするために使用可能です。 このオ
                                    プションには、キーとしてWSDL 型、 値として PHP クラスの名前を持
                                    つ配列を指定する必要があります。 型の名前は、 要素の(タグ)名前と
                                    一致させる必要はないことに注意して下さい。
                                    
                                    指定するクラス名は、常に 名前空間 で完全修飾されているべきです
                                    し、 <return>\</return> で始まってはいけません。 正しい名前は、 ::class を使えば
                                    生成できます。
                                    
                                    クラスのインスタンスを生成する場合、 コンストラクタはコールされ
                                    ず、 個別のプロパティに対して マジックメソッド __set() と
                                    __get() が コールされる点にも注意して下さい。
                                    
                                    ユーザー定義のコールバック関数を使って、 型マッピングを定義しま
                                    す。 型マッピングは配列で定義され、 キーは <return>type_name</return> (XML 要素型
                                    を指定した文字列)、 <return>type_ns</return> (名前空間URI を指定した文字列)、
                                    <return>from_xml</return> (文字列を受け取り、 オブジェクトを返す <info>callable</info>)、
                                    <return>to_xml</return> (オブジェクトをひとつ受け取り、 文字列を返す <info>callable</info>) で
                                    す。
                                    
                                    エラーが起きた際に、  <class>SoapFault</class> をスローするかどうかを指定しま
                                    す。
                                    
                                    デフォルトは <info>true</info> です。
                                    
                                    SOAP サービスに接続する際のタイムアウト秒数を指定します。 これを
                                    使用しても、 レスポンスが遅いサービスのタイムアウトを定義するこ
                                    とはできません。 サービスのコールが完了するまでの待ち時間を制限
                                    するには、 default_socket_timeout が使えます。
                                    
                                    <strong>$wsdl</strong> を指定した場合、 かつ soap.wsdl_cache_enabled が有効になっ
                                    ている場合に、 このオプションはキャッシュのタイプを指定します。
                                    <info>WSDL_CACHE_NONE</info>, <info>WSDL_CACHE_DISK</info>, <info>WSDL_CACHE_MEMORY</info>,
                                    <info>WSDL_CACHE_BOTH</info> のいずれかが指定できます。
                                    
                                    ふたつのタイプのキャッシュが利用できます。 WSDL を現在のプロセス
                                    のメモリにキャッシュする インメモリのキャッシュと、 WSDL をディ
                                    スク上にキャッシュし、 全てのプロセスと共有するディスクキャッ
                                    シュがあります。 ディスクキャッシュで使うディレクトリは
                                    soap.wsdl_cache_dir で指定できます。 どちらのタイプのキャッシュ
                                    でも、 soap.wsdl_cache_ttl で指定した寿命があります。 インメモリ
                                    キャッシュの場合、 soap.wsdl_cache_limit でキャッシュエントリの
                                    数の最大値も指定できます。
                                    
                                    この値を指定しない場合、  soap.wsdl_cache オプションの値を使いま
                                    す。
                                    
                                    リクエストをする際に <return>User-Agent</return> で使う値。
                                    
                                    <strong>$stream_context</strong> でも指定できます。
                                    
                                    この値を指定しない場合、 <return>"PHP-SOAP/"</return> の後に、 <info>PHP_VERSION</info> の値を
                                    付けたものを使います。
                                    
                                    追加のオプションを設定できる stream context。 これは
                                    <strong>stream_context_create()</strong> で生成できます。
                                    
                                    このコンテキストには、 socket context options, SSL context
                                    options, HTTP context options が含まれます: <return>content_type</return>,
                                    <return>header</return>, <return>max_redirects</return>, <return>protocol_version</return>, <return>user_agent</return> が設定できま
                                    す。
                                    
                                    <return>'header'</return> コンテキストオプションで指定された場合、以下のHTTPヘッ
                                    ダは自動生成され、無視されることに注意して下さい: <return>host</return>,
                                    <return>connection</return>, <return>user-agent</return>, <return>content-length</return>, <return>content-type</return>, <return>cookie</return>,
                                    <return>authorization</return>, <return>proxy-authorization</return>
                                    
                                    以下の機能を有効にするための、ひとつ以上のビットマスク:
                                    <info>SOAP_SINGLE_ELEMENT_ARRAYS</info> レスポンスを配列にデコードする際に
                                    は、 特定の親要素の中で要素名が一度または複数回現れるかをデフォ
                                    ルトで自動検知します。 一度しか現れない要素については、 オブジェ
                                    クトのプロパティを通じてコンテンツに直接アクセスできます。 複数
                                    回現れる要素については、 プロパティには配列が含まれ、 マッチする
                                    要素の内容の配列が入ります。 <info>SOAP_SINGLE_ELEMENT_ARRAYS</info> が有効に
                                    なった場合、 一度しか現れない要素は要素数がひとつの配列になりま
                                    す。 これは全ての要素と一貫性を保つためです。 これは、レスポンス
                                    にスキーマを含んでいるWSDLを使っている場合にのみ意味があります。
                                    具体的には、以下の例を参照ください。 <info>SOAP_USE_XSI_ARRAY_TYPE</info><return>use</return>
                                    オプション を使ったり、 WSDL プロパティを <return>encoded</return> に設定した場合
                                    に、 配列の型をスキーマ特有のそれにするのではなく、
                                    <return>SOAP-ENC:Array</return> にします。 <info>SOAP_WAIT_ONE_WAY_CALLS</info> WDSL が一方向
                                    のリクエストを指定していた場合であっても、 レスポンスを待つ。
                                    
                                    レスポンスを配列にデコードする際には、 特定の親要素の中で要素名
                                    が一度または複数回現れるかをデフォルトで自動検知します。 一度し
                                    か現れない要素については、 オブジェクトのプロパティを通じてコン
                                    テンツに直接アクセスできます。 複数回現れる要素については、 プロ
                                    パティには配列が含まれ、 マッチする要素の内容の配列が入ります。
                                    
                                    <info>SOAP_SINGLE_ELEMENT_ARRAYS</info> が有効になった場合、 一度しか現れない
                                    要素は要素数がひとつの配列になります。 これは全ての要素と一貫性
                                    を保つためです。 これは、レスポンスにスキーマを含んでいるWSDLを
                                    使っている場合にのみ意味があります。具体的には、以下の例を参照く
                                    ださい。
                                    
                                    <return>use</return> オプション を使ったり、 WSDL プロパティを <return>encoded</return> に設定した
                                    場合に、 配列の型をスキーマ特有のそれにするのではなく、
                                    <return>SOAP-ENC:Array</return> にします。
                                    
                                    WDSL が一方向のリクエストを指定していた場合であっても、 レスポン
                                    スを待つ。
                                    
                                    <return>Connection: Keep-Alive</return> ヘッダや <return>Connection: close</return> を送信するかど
                                    うかを boolean で指定します。
                                    
                                    デフォルトは <info>true</info> です。
                                    
                                    セキュアな HTTP 接続で用いる、 SSL または TLS のバージョンを指定
                                    します。 <info>SOAP_SSL_METHOD_SSLv2</info> や <info>SOAP_SSL_METHOD_SSLv3</info> を指定す
                                    ると、 それぞれ SSL 2、 SSL 3 を強制的に使います。
                                    <info>SOAP_SSL_METHOD_SSLv23</info> を指定しても意味がありません。 これは後方
                                    互換のためだけに存在しています。 PHP 7.2 以降では、
                                    <info>SOAP_SSL_METHOD_TLS</info> を指定しても同様に意味がありません。 これよ
                                    り前のバージョンでは、 この定数を指定すると TLS 1.0 を強制的に
                                    使っていました。
                                    
                                    SSL バージョン 2 と 3 はセキュアでないとみなされています。 よっ
                                    てインストール済みの OpenSSL ライブラリではサポートされていない
                                    可能性があることに注意しましょう。
                                    
                                    このオプションは PHP 8.1.0 以降では 推奨されません。 個別の TLS
                                    のバージョンを指定できる、 より柔軟性に富んだ代替があります。
                                    <strong>$stream_context</strong> オプションを 'crypto_method' コンテキストパラ
                                    メータと一緒に使うようにして下さい。 TLS 1.3 だけを指定する [
                                    'crypto_method' => STREAM_CRYPTO_METHOD_TLSv1_3_CLIENT ]
                                    ]);
                                    $client = new SoapClient("some.wsdl", ['context' => $context]);
                                    ]]>
  <info></info>             <strong>$location</strong>            リクエストを送信する SOAP サーバーのURL
                                    
                                    <strong>$wsdl</strong> パラメータが指定されない場合、 必須です。 <strong>$wsdl</strong> と
                                    <return>location</return> が指定された場合、 <return>location</return> オプションは WSDL ファイル
                                    で指定されたあらゆる location を上書きします。
  <info></info>             <strong>$uri</strong>                 SOAP サービスのターゲット名前空間です。
                                    
                                    <strong>$wsdl</strong> が指定されていない場合、このパラメータは必須です。 そうで
                                    ない場合、この値は無視されます。
  <info></info>             <strong>$style</strong>               <info>SOAP_RPC</info> と <info>SOAP_DOCUMENT</info> を使うと、 このクライアントで使うバイ
                                    ンディングスタイルを指定します。 <info>SOAP_RPC</info> は RPCスタイルのバイン
                                    ディングを指定します。 この場合の SOAP リクエストのボディには、
                                    関数コールの標準エンコーディングが含まれます。 <info>SOAP_DOCUMENT</info>  は
                                    ドキュメントスタイルのバインディングを指定します。 この場合の
                                    SOAP リクエストのボディには、 サービス定義を記した XML ドキュメ
                                    ントが含まれます。
                                    
                                    <strong>$wsdl</strong>  が指定された場合、 このオプションは無視され、 スタイルは
                                    WDSL ファイルから読み込まれます。
                                    
                                    このオプションと <strong>$wsdl</strong> パラメータ を両方指定しなかった場合、
                                    RPCスタイルを使います。
  <info></info>             <strong>$use</strong>                 <info>SOAP_ENCODED</info> や <info>SOAP_LITERAL</info> を使うと、 このクライアントで使うエ
                                    ンコーディングスタイルを指定します。 <info>SOAP_ENCODED</info> は、 SOAP 仕様
                                    で定義された型を使い、エンコーディングを指定します。
                                    <info>SOAP_LITERAL</info> は、 サービスで定義されたスキームを使い、 エンコー
                                    ディングを指定します。
                                    
                                    <strong>$wsdl</strong>  が指定された場合、 このオプションは無視され、 エンコー
                                    ディングは WDSL ファイルから読み込まれます。
                                    
                                    このオプションと <strong>$wsdl</strong> パラメータ を両方指定しなかった場合、
                                    "encoded" スタイルを使います。
  <info></info>             <strong>$soap_version</strong>        使用する SOAP プロトコルのバージョンを指定します: SOAP 1.1 の場
                                    合は <info>SOAP_1_1</info> を指定します。 SOAP 1.2 の場合は <info>SOAP_1_2</info> を指定し
                                    ます。
                                    
                                    省略した場合は、SOAP 1.1 を使います。
  <info></info>             <strong>$authentication</strong>      HTTP 認証をリクエスト時に使う際の、 認証方法を指定します。
                                    <info>SOAP_AUTHENTICATION_BASIC</info> と <info>SOAP_AUTHENTICATION_DIGEST</info> が指定で
                                    きます。
                                    
                                    省略された場合、 かつ <return>login</return> オプションが指定されると Basic 認証
                                    を使います。
  <info></info>             <strong>$login</strong>               Basic 認証と、Digest 認証で使うユーザー名を指定します。
  <info></info>             <strong>$password</strong>            Basic 認証と、Digest 認証で使うパスワードを指定します。
                                    
                                    HTTPS クライアント認証で使う <return>passphrase</return> と混同しないようにして下
                                    さい。
  <info></info>             <strong>$local_cert</strong>          HTTPS 認証で使うクライアント証明書のパス。 証明書ファイルは、 証
                                    明書と秘密鍵が両方入った状態で、 PEMエンコードされている必要があ
                                    ります。
                                    
                                    このファイルには、発行者のチェインも含めることができます。 それ
                                    らを含める場合、クライアント証明書の後に置く必要があります。
                                    
                                    <strong>$stream_context</strong> でも設定できます。 この場合、秘密鍵のファイルは
                                    別に指定できます。
  <info></info>             <strong>$passphrase</strong>          <return>local_cert</return>  オプションで指定したクライアント証明書のための パス
                                    フレーズ。
                                    
                                    Basic 認証や Digest 認証で使う <return>password</return> と混同しないようにして下
                                    さい。
                                    
                                    <strong>$stream_context</strong> でも設定できます。
  <info></info>             <strong>$proxy_host</strong>          HTTPリクエスト時に使う、 プロキシサーバーとして用いるホスト名を
                                    指定します。
                                    
                                    <return>proxy_port</return> オプションも指定する必要があります。
  <info></info>             <strong>$proxy_port</strong>          <return>proxy_host</return> で指定したプロキシサーバーに接続する際に使うポート番
                                    号。
  <info></info>             <strong>$proxy_login</strong>         <return>proxy_host</return> で指定したプロキシサーバーに接続する際に、 Basic 認証
                                    で用いるオプションのユーザー名
  <info></info>             <strong>$proxy_password</strong>      <return>proxy_host</return> で指定したプロキシサーバーに接続する際に、 Basic 認証
                                    で用いるオプションのパスワード
  <info></info>             <strong>$compression</strong>         SOAP リクエストとレスポンスの圧縮を有効にします。
                                    
                                    この値は、3つの値を ビット演算のOR で指定します: オプションの
                                    <info>SOAP_COMPRESSION_ACCEPT</info> は、"Accept-Encoding" ヘッダを指定しま
                                    す。 <info>SOAP_COMPRESSION_GZIP</info> や <info>SOAP_COMPRESSION_DEFLATE</info> は、使用
                                    する圧縮アルゴリズムと、 リクエストで使う圧縮レベルを 1 から 9
                                    の間の数値で指定します。 たとえば、双方向の gzip 圧縮を最高の圧
                                    縮レベルで行う場合は、 <return>SOAP_COMPRESSION_ACCEPT |
                                    SOAP_COMPRESSION_GZIP | 9</return> を指定します。
  <info></info>             <strong>$encoding</strong>            内部的な文字エンコーディングを指定します。 リクエストはここで指
                                    定されたエンコーディングから、 常に UTF-8 に変換して送られ、 レ
                                    スポンスはこのエンコーディングに変換されます。
  <info></info>             <strong>$trace</strong>               リクエストやレスポンスのキャプチャを行います。 キャプチャした情
                                    報は SoapClient::__getLastRequest,
                                    SoapClient::__getLastRequestHeaders,
                                    SoapClient::__getLastResponse,
                                    SoapClient::__getLastResponseHeaders. を使ってアクセスできます。
                                    
                                    省略した場合のデフォルト値は <info>false</info> です。
  <info></info>             <strong>$classmap</strong>            WSDL 型を PHP クラスにマッピングするために使用可能です。 このオ
                                    プションには、キーとしてWSDL 型、 値として PHP クラスの名前を持
                                    つ配列を指定する必要があります。 型の名前は、 要素の(タグ)名前と
                                    一致させる必要はないことに注意して下さい。
                                    
                                    指定するクラス名は、常に 名前空間 で完全修飾されているべきです
                                    し、 <return>\</return> で始まってはいけません。 正しい名前は、 ::class を使えば
                                    生成できます。
                                    
                                    クラスのインスタンスを生成する場合、 コンストラクタはコールされ
                                    ず、 個別のプロパティに対して マジックメソッド __set() と
                                    __get() が コールされる点にも注意して下さい。
  <info></info>             <strong>$typemap</strong>             ユーザー定義のコールバック関数を使って、 型マッピングを定義しま
                                    す。 型マッピングは配列で定義され、 キーは <return>type_name</return> (XML 要素型
                                    を指定した文字列)、 <return>type_ns</return> (名前空間URI を指定した文字列)、
                                    <return>from_xml</return> (文字列を受け取り、 オブジェクトを返す <info>callable</info>)、
                                    <return>to_xml</return> (オブジェクトをひとつ受け取り、 文字列を返す <info>callable</info>) で
                                    す。
  <info></info>             <strong>$exceptions</strong>          エラーが起きた際に、  <class>SoapFault</class> をスローするかどうかを指定しま
                                    す。
                                    
                                    デフォルトは <info>true</info> です。
  <info></info>             <strong>$connection_timeout</strong>  SOAP サービスに接続する際のタイムアウト秒数を指定します。 これを
                                    使用しても、 レスポンスが遅いサービスのタイムアウトを定義するこ
                                    とはできません。 サービスのコールが完了するまでの待ち時間を制限
                                    するには、 default_socket_timeout が使えます。
  <info></info>             <strong>$cache_wsdl</strong>          <strong>$wsdl</strong> を指定した場合、 かつ soap.wsdl_cache_enabled が有効になっ
                                    ている場合に、 このオプションはキャッシュのタイプを指定します。
                                    <info>WSDL_CACHE_NONE</info>, <info>WSDL_CACHE_DISK</info>, <info>WSDL_CACHE_MEMORY</info>,
                                    <info>WSDL_CACHE_BOTH</info> のいずれかが指定できます。
                                    
                                    ふたつのタイプのキャッシュが利用できます。 WSDL を現在のプロセス
                                    のメモリにキャッシュする インメモリのキャッシュと、 WSDL をディ
                                    スク上にキャッシュし、 全てのプロセスと共有するディスクキャッ
                                    シュがあります。 ディスクキャッシュで使うディレクトリは
                                    soap.wsdl_cache_dir で指定できます。 どちらのタイプのキャッシュ
                                    でも、 soap.wsdl_cache_ttl で指定した寿命があります。 インメモリ
                                    キャッシュの場合、 soap.wsdl_cache_limit でキャッシュエントリの
                                    数の最大値も指定できます。
                                    
                                    この値を指定しない場合、  soap.wsdl_cache オプションの値を使いま
                                    す。
  <info></info>             <strong>$user_agent</strong>          リクエストをする際に <return>User-Agent</return> で使う値。
                                    
                                    <strong>$stream_context</strong> でも指定できます。
                                    
                                    この値を指定しない場合、 <return>"PHP-SOAP/"</return> の後に、 <info>PHP_VERSION</info> の値を
                                    付けたものを使います。
  <info></info>             <strong>$stream_context</strong>      追加のオプションを設定できる stream context。 これは
                                    <strong>stream_context_create()</strong> で生成できます。
                                    
                                    このコンテキストには、 socket context options, SSL context
                                    options, HTTP context options が含まれます: <return>content_type</return>,
                                    <return>header</return>, <return>max_redirects</return>, <return>protocol_version</return>, <return>user_agent</return> が設定できま
                                    す。
                                    
                                    <return>'header'</return> コンテキストオプションで指定された場合、以下のHTTPヘッ
                                    ダは自動生成され、無視されることに注意して下さい: <return>host</return>,
                                    <return>connection</return>, <return>user-agent</return>, <return>content-length</return>, <return>content-type</return>, <return>cookie</return>,
                                    <return>authorization</return>, <return>proxy-authorization</return>
  <info></info>             <strong>$features</strong>            以下の機能を有効にするための、ひとつ以上のビットマスク:
                                    <info>SOAP_SINGLE_ELEMENT_ARRAYS</info> レスポンスを配列にデコードする際に
                                    は、 特定の親要素の中で要素名が一度または複数回現れるかをデフォ
                                    ルトで自動検知します。 一度しか現れない要素については、 オブジェ
                                    クトのプロパティを通じてコンテンツに直接アクセスできます。 複数
                                    回現れる要素については、 プロパティには配列が含まれ、 マッチする
                                    要素の内容の配列が入ります。 <info>SOAP_SINGLE_ELEMENT_ARRAYS</info> が有効に
                                    なった場合、 一度しか現れない要素は要素数がひとつの配列になりま
                                    す。 これは全ての要素と一貫性を保つためです。 これは、レスポンス
                                    にスキーマを含んでいるWSDLを使っている場合にのみ意味があります。
                                    具体的には、以下の例を参照ください。 <info>SOAP_USE_XSI_ARRAY_TYPE</info><return>use</return>
                                    オプション を使ったり、 WSDL プロパティを <return>encoded</return> に設定した場合
                                    に、 配列の型をスキーマ特有のそれにするのではなく、
                                    <return>SOAP-ENC:Array</return> にします。 <info>SOAP_WAIT_ONE_WAY_CALLS</info> WDSL が一方向
                                    のリクエストを指定していた場合であっても、 レスポンスを待つ。
                                    
                                    レスポンスを配列にデコードする際には、 特定の親要素の中で要素名
                                    が一度または複数回現れるかをデフォルトで自動検知します。 一度し
                                    か現れない要素については、 オブジェクトのプロパティを通じてコン
                                    テンツに直接アクセスできます。 複数回現れる要素については、 プロ
                                    パティには配列が含まれ、 マッチする要素の内容の配列が入ります。
                                    
                                    <info>SOAP_SINGLE_ELEMENT_ARRAYS</info> が有効になった場合、 一度しか現れない
                                    要素は要素数がひとつの配列になります。 これは全ての要素と一貫性
                                    を保つためです。 これは、レスポンスにスキーマを含んでいるWSDLを
                                    使っている場合にのみ意味があります。具体的には、以下の例を参照く
                                    ださい。
                                    
                                    <return>use</return> オプション を使ったり、 WSDL プロパティを <return>encoded</return> に設定した
                                    場合に、 配列の型をスキーマ特有のそれにするのではなく、
                                    <return>SOAP-ENC:Array</return> にします。
                                    
                                    WDSL が一方向のリクエストを指定していた場合であっても、 レスポン
                                    スを待つ。
  <info></info>             <strong>$keep_alive</strong>          <return>Connection: Keep-Alive</return> ヘッダや <return>Connection: close</return> を送信するかど
                                    うかを boolean で指定します。
                                    
                                    デフォルトは <info>true</info> です。
  <info></info>             <strong>$ssl_method</strong>          セキュアな HTTP 接続で用いる、 SSL または TLS のバージョンを指定
                                    します。 <info>SOAP_SSL_METHOD_SSLv2</info> や <info>SOAP_SSL_METHOD_SSLv3</info> を指定す
                                    ると、 それぞれ SSL 2、 SSL 3 を強制的に使います。
                                    <info>SOAP_SSL_METHOD_SSLv23</info> を指定しても意味がありません。 これは後方
                                    互換のためだけに存在しています。 PHP 7.2 以降では、
                                    <info>SOAP_SSL_METHOD_TLS</info> を指定しても同様に意味がありません。 これよ
                                    り前のバージョンでは、 この定数を指定すると TLS 1.0 を強制的に
                                    使っていました。
                                    
                                    SSL バージョン 2 と 3 はセキュアでないとみなされています。 よっ
                                    てインストール済みの OpenSSL ライブラリではサポートされていない
                                    可能性があることに注意しましょう。
                                    
                                    このオプションは PHP 8.1.0 以降では 推奨されません。 個別の TLS
                                    のバージョンを指定できる、 より柔軟性に富んだ代替があります。
                                    <strong>$stream_context</strong> オプションを 'crypto_method' コンテキストパラ
                                    メータと一緒に使うようにして下さい。 TLS 1.3 だけを指定する [
                                    'crypto_method' => STREAM_CRYPTO_METHOD_TLSv1_3_CLIENT ]
                                    ]);
                                    $client = new SoapClient("some.wsdl", ['context' => $context]);
                                    ]]>


id: SoapClient::__doRequest
type: function
doc:
<comment>Description:</comment>
  SOAP リクエストを実行する
  
  HTTP 上で SOAP リクエストを実行します。
  
  異なるトランスポート層や追加の XML を処理する、もしくは他の目的のために サブクラスでこのメソッドを
  オーバーライドする事ができます。

<comment>Param:</comment>
  <info>string</info>  <strong>$request</strong>   XML SOAP リクエスト
  <info>string</info>  <strong>$location</strong>  リクエスト先の URL
  <info>string</info>  <strong>$action</strong>    SOAP アクション
  <info>int</info>     <strong>$version</strong>   SOAP バージョン
  <info>bool</info>    <strong>$oneWay</strong>    <strong>$oneWay</strong> に <info>true</info> を設定すると、このメソッドは何も返しません。 レスポンスが不要な
                     ときにこれを使用します。

<comment>Return:</comment>
  <info>string|null</info>  XML SOAP レスポンス


id: SoapClient::__getCookies
type: function
doc:
<comment>Description:</comment>
  クッキーの一覧を取得する
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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


id: SoapClient::__getFunctions
type: function
doc:
<comment>Description:</comment>
  SOAP 関数の一覧を返す
  
  ウェブサービスの WSDL に記述されている関数の配列を返します。
  
  この関数は WSDL モードでのみ動作します。

<comment>Return:</comment>
  <info>array|null</info>  SOAP 関数のプロトタイプ、戻り値の型、関数名、引数の型情報を含めた配列を返します。

<comment>See Also:</comment>
   * SoapClient::__construct


id: SoapClient::__getLastRequest
type: function
doc:
<comment>Description:</comment>
  直近の SOAP リクエストを返す
  
  直近の SOAP リクエストで送信された XML を返します。
  
  このメソッドは、オプション <return>trace</return> を指定して <class>SoapClient</class> が作成されている場合のみ使用可能です。

<comment>Return:</comment>
  <info>string|null</info>  直近の SOAP リクエストを XML 文字列で返します。

<comment>See Also:</comment>
   * SoapClient::__getLastRequestHeaders
   * SoapClient::__getLastResponse
   * SoapClient::__getLastResponseHeaders


id: SoapClient::__getLastRequestHeaders
type: function
doc:
<comment>Description:</comment>
  直近の SOAP リクエストヘッダを返す
  
  直近の SOAP リクエストヘッダを返します。
  
  このメソッドは、オプション <return>trace</return> を指定して <class>SoapClient</class> が作成されている場合のみ使用可能です。

<comment>Return:</comment>
  <info>string|null</info>  直近の SOAP リクエストヘッダ

<comment>See Also:</comment>
   * SoapClient::__getLastResponseHeaders
   * SoapClient::__getLastRequest
   * SoapClient::__getLastResponse


id: SoapClient::__getLastResponse
type: function
doc:
<comment>Description:</comment>
  直近の SOAP レスポンスを返す
  
  直近の SOAP レスポンスで受信した XML を返します。
  
  このメソッドは、オプション <return>trace</return> を指定して <class>SoapClient</class> が作成されている場合のみ使用可能です。

<comment>Return:</comment>
  <info>string|null</info>  直近の SOAP レスポンスを XML 文字列で返します。

<comment>See Also:</comment>
   * SoapClient::__getLastResponseHeaders
   * SoapClient::__getLastRequest
   * SoapClient::__getLastRequestHeaders


id: SoapClient::__getLastResponseHeaders
type: function
doc:
<comment>Description:</comment>
  直近の SOAP レスポンスヘッダを返す
  
  直近の SOAP レスポンスヘッダを返します。
  
  このメソッドは、オプション <return>trace</return> を指定して <class>SoapClient</class> が作成されている場合のみ使用可能です。

<comment>Return:</comment>
  <info>string|null</info>  直近の SOAP レスポンスヘッダ

<comment>See Also:</comment>
   * SoapClient::__getLastRequestHeaders
   * SoapClient::__getLastRequest
   * SoapClient::__getLastResponse


id: SoapClient::__getTypes
type: function
doc:
<comment>Description:</comment>
  SOAP 型の一覧を返す
  
  ウェブサービスの WSDL で定義されている型の配列を返します。
  
  この関数は WSDL モードでのみ動作します。

<comment>Return:</comment>
  <info>array|null</info>  SOAP 型の配列を返します。すべての構造や型が含まれています。

<comment>See Also:</comment>
   * SoapClient::__construct


id: SoapClient::__setCookie
type: function
doc:
<comment>Description:</comment>
  SOAP リクエストと共に送信されるクッキーを設定する
  
  SOAP リクエストと共に送信されるクッキーを定義します。
  
  このメソッドをコールすることで、その後のすべての <class>SoapClient</class> メソッドコール に影響します。

<comment>Param:</comment>
  <info>string</info>       <strong>$name</strong>   クッキーの名前
  <info>string|null</info>  <strong>$value</strong>  クッキーの値。指定されない場合、クッキーは削除されます。

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


id: SoapClient::__setLocation
type: function
doc:
<comment>Description:</comment>
  使用するウェブサービスの場所を設定する
  
  それ以降の SOAP リクエストで使用するエンドポイント URL を設定します。 これは、SoapClient を作成す
  る際に <return>location</return> オプションを指定するのと同じことです。
  
  このメソッドのコールは必須ではありません。SoapClient は、デフォルトで WSDL ファイルから取得したエ
  ンドポイントを使用します。

<comment>Param:</comment>
  <info>string|null</info>  <strong>$location</strong>  新しいエンドポイント URL。

<comment>Return:</comment>
  <info>string|null</info>  それまでのエンドポイント URL を返します。

<comment>See Also:</comment>
   * SoapClient::__construct


id: SoapClient::__setSoapHeaders
type: function
doc:
<comment>Description:</comment>
  以降のコール用の SOAP ヘッダを設定する
  
  SOAP リクエストで送信するヘッダを定義します。
  
  このメソッドをコールすると、それまでの値はすべて上書きされます。

<comment>Param:</comment>
  <info>SoapHeader|array|null</info>  <strong>$headers</strong>  設定したいヘッダ。<class>SoapHeader</class> オブジェクト、あるいは <class>SoapHeader</class> オ
                                   ブジェクトの配列です。 省略したり <info>null</info> を設定したりした場合はヘッ
                                   ダが削除されます。

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


id: SoapClient::__soapCall
type: function
doc:
<comment>Description:</comment>
  SOAP 関数をコールする
  
  本メソッドは、SOAP コールを行う低レベル API 関数です。 通常、WSDL モードでは、SOAP 関数を
  <class>SoapClient</class> のメソッドとして簡単にコールすることができます。 本メソッドは、<return>soapaction</return> が不明な場合
  や、 <return>uri</return> がデフォルトと異なっていたり、 SOAP ヘッダを送受信したい場合に、非 WSDL モードを使用する
  際に有用です。
  
  エラーの場合に SOAP 関数を呼び出すと、PHP の例外が発生するか、例外が無効な場合には <class>SoapFault</class> オブ
  ジェクトが返されます。 この関数コールが失敗したかどうかを調べるには、 SoapFault 例外をキャッチする
  か、<strong>is_soap_fault()</strong> の結果を調べてください。

<comment>Param:</comment>
  <info>string</info>                 <strong>$name</strong>           コールしたい SOAP 関数の名前。
  <info>array</info>                  <strong>$args</strong>           関数に渡す引数の配列。これは、数値添字配列あるいは連想配列
                                         のどちらの形式でもかまいません。 たいていの SOAP サーバー
                                         は、パラメータ名を指定しないといけないことに注意しましょ
                                         う。 そんな場合は、連想配列でないといけません。
  <info>array|null</info>             <strong>$options</strong>        クライアントに渡すオプションの連想配列。
                                         
                                         <return>location</return> はリモートウェブサービスの URL です。
                                         
                                         <return>uri</return> は SOAP サービスのターゲット名前空間です。
                                         
                                         <return>soapaction</return> はコールしたいアクションです。
  <info>SoapHeader|array|null</info>  <strong>$inputHeaders</strong>   SOAP リクエストで送信するヘッダの配列。
  <info>array</info>                  <strong>$outputHeaders</strong>  指定すると、この配列に SOAP レスポンスのヘッダが書き込まれ
                                         ます。

<comment>Return:</comment>
  <info>mixed</info>  SOAP 関数は、一つまたは複数の値を返す可能性があります。 SOAP 関数から値をひとつだけ返す場合
         は、 返り値はスカラーになります。 複数の値を返す場合は、出力パラメータの名前がついた連想配
         列を返します。
         
         エラーが発生した場合、 かつ <class>SoapClient</class> の <return>exceptions</return> を <info>false</info> に設定した場合は、 <class>SoapFault</class>
         オブジェクトを返します。

<comment>See Also:</comment>
   * SoapClient::__construct
   * SoapParam::__construct
   * SoapVar::__construct
   * SoapHeader::__construct
   * SoapFault::__construct
   * <strong>is_soap_fault()</strong>


id: SoapFault::__construct
type: function
doc:
<comment>Description:</comment>
  SoapFault コンストラクタ
  
  このクラスは、PHP ハンドラから SOAP フォールトレスポンスを送信した場合に有用です。 <strong>$faultcode</strong>,
  <strong>$faultstring</strong>, <strong>$faultactor</strong> および <strong>$detail</strong> は SOAP フォールトの標準的な要素です。

<comment>Param:</comment>
  <info></info>  <strong>$faultcode</strong>    <class>SoapFault</class> のエラーコード
  <info></info>  <strong>$faultstring</strong>  <class>SoapFault</class> のエラーメッセージ
  <info></info>  <strong>$faultactor</strong>   エラーの原因となったアクターを識別する文字列
  <info></info>  <strong>$detail</strong>       エラーの原因についての詳細な情報
  <info></info>  <strong>$faultname</strong>    WSDL からの厳密なフォールトエンコーディングを取得するために利用可能
  <info></info>  <strong>$headerfault</strong>  レスポンスヘッダにおいて SOAP ハンドラがエラーの報告処理を行っている間に利用可能

<comment>See Also:</comment>
   * SoapServer::fault
   * <strong>is_soap_fault()</strong>


id: SoapFault::__toString
type: function
doc:
<comment>Description:</comment>
  SoapFault の文字列表現を取得する
  
  SoapFault の文字列表現を返します。

<comment>Return:</comment>
  <info>string</info>  SoapFault を文字列であらわした内容を返します。


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

<comment>Param:</comment>
  <info>string</info>  <strong>$namespace</strong>       SOAP ヘッダ要素の名前空間
  <info>string</info>  <strong>$name</strong>            SOAP ヘッダ要素の名前
  <info>mixed</info>   <strong>$data</strong>            SOAP ヘッダの内容。PHP の値もしくは <class>SoapVar</class> オブジェクトです。
  <info></info>        <strong>$mustUnderstand</strong>  SOAP ヘッダ要素の <return>mustUnderstand</return> 属性の値
  <info>string</info>  <strong>$actor</strong>           SOAP ヘッダ要素の <return>actor</return> 属性の値

<comment>See Also:</comment>
   * SoapClient::__soapCall
   * SoapVar::__construct
   * SoapParam::__construct
   * SoapServer::addSoapHeader


id: SoapParam::__construct
type: function
doc:
<comment>Description:</comment>
  SoapParam コンストラクタ
  
  新しい <class>SoapParam</class> オブジェクトを生成します。

<comment>Param:</comment>
  <info>mixed</info>   <strong>$data</strong>  渡すもしくは返すデータ。 PHP の値としてこのパラメータを直接渡すことができますが、こ
                 の場合、 <return>paramN</return> という名前が付けられますので SOAP サービスがこれを理解しないかも知
                 れません。
  <info>string</info>  <strong>$name</strong>  パラメータの名前

<comment>See Also:</comment>
   * SoapClient::__soapCall
   * SoapVar::__construct


id: SoapServer
type: class
doc:
<comment>Description:</comment>
  SoapServer クラスは SOAP 1.1 および SOAP 1.2 プロトコル用のサーバーとなります。 WSDL サービス記述
  を使用することもしないこともできます。


id: SoapServer::__construct
type: function
doc:
<comment>Description:</comment>
  SoapServer コンストラクタ
  
  このコンストラクタにより <class>SoapServer</class> オブジェクトを WSDL または非 WSDL モードで作成することが可能で
  す。

<comment>Param:</comment>
  <info>string|null</info>  <strong>$wsdl</strong>     WSDL モードの場合、これに WSDL ファイルの URI を指定する必要があります。
                         WSDL モードでない場合、<info>null</info> を指定し、<return>uri</return> オプションを設定する必要がありま
                         す。
  <info>array</info>        <strong>$options</strong>  デフォルトの SOAP バージョン (<return>soap_version</return>), 内部の文字エンコーディング
                         (<return>encoding</return>), アクターの URI (<return>actor</return>) を指定することができます。
                         
                         <return>classmap</return> オプションにより、WSDL 型を PHP のクラスにマッピングすることが可能
                         です。 このオプションには、キーとしてWSDL 型、値として PHP クラスの名前を持
                         つ配列を指定する必要があります。
                         
                         <return>typemap</return> オプションは、型マッピングの配列です。 この配列のキーは <return>type_name</return>、
                         <return>type_ns</return> (名前空間 URI)、<return>from_xml</return> (引数として文字列をひとつ受け取るコール
                         バック) そして <return>to_xml</return> (引数としてオブジェクトをひとつ受け取るコールバック)
                         です。
                         
                         <return>cache_wsdl</return> オプションは、 <info>WSDL_CACHE_NONE</info>、 <info>WSDL_CACHE_DISK</info>、
                         <info>WSDL_CACHE_MEMORY</info> あるいは <info>WSDL_CACHE_BOTH</info> のいずれかです。
                         
                         その他に <return>features</return> というオプションもあり、 <info>SOAP_WAIT_ONE_WAY_CALLS</info>、
                         <info>SOAP_SINGLE_ELEMENT_ARRAYS</info>、 <info>SOAP_USE_XSI_ARRAY_TYPE</info> を設定することができま
                         す。
                         
                         <return>send_errors</return> オプションを <info>false</info> にすると、 個別のエラーメッセージではなく汎
                         用的なメッセージ ("Internal error") を送信できます。

<comment>See Also:</comment>
   * SoapClient::__construct


id: SoapServer::addFunction
type: function
doc:
<comment>Description:</comment>
  SOAP リクエストによって処理される単一もしくはいくつかの関数を追加する
  
  リモートクライアント用に単一もしくは複数の関数をエクスポートします。

<comment>Param:</comment>
  <info>array|string|int</info>  <strong>$functions</strong>  単一の関数をエクスポートするには、 このパラメータに文字列として関数
                                名を渡してください。
                                
                                いくつかの関数をエクスポートするには、関数名の配列を渡してください。
                                
                                全ての関数をエクスポートする場合、特別な定数 <info>SOAP_FUNCTIONS_ALL</info> を渡
                                してください。
                                
                                <strong>$functions</strong> は、全ての入力引数を WSDL ファイルで定義されている順序と
                                同じ順序で受け取る必要があり (これらの関数は出力パラメータを引数とし
                                て受け取ることはありません) 、一つまたは複数の値を返す必要がありま
                                す。 複数の値を返すには、名前付き出力パラメータの配列を返す必要があ
                                ります。

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

<comment>See Also:</comment>
   * SoapServer::__construct
   * SoapServer::setClass


id: SoapServer::addSoapHeader
type: function
doc:
<comment>Description:</comment>
  SOAP ヘッダをレスポンスに追加する
  
  現在のリクエストから返されるレスポンスに SOAP ヘッダを追加します。

<comment>Param:</comment>
  <info>SoapHeader</info>  <strong>$header</strong>  返すヘッダ。

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


id: SoapServer::fault
type: function
doc:
<comment>Description:</comment>
  エラーを示す SoapServer フォールト を発行する
  
  現在のリクエストに対するレスポンスとして、エラーを表す内容をクライアントに送信します。
  
  これは、リクエストを処理する際にのみコールされます。

<comment>Param:</comment>
  <info>string</info>  <strong>$code</strong>     返したいエラーコード。
  <info>string</info>  <strong>$string</strong>   エラーについての簡単な説明。
  <info>string</info>  <strong>$actor</strong>    フォールトを引き起こしたアクターをあらわす文字列。
  <info>mixed</info>   <strong>$details</strong>  フォールトについての詳細。
  <info>string</info>  <strong>$name</strong>     フォールトの名前。これは WSDL ファイルにある名前を使うことができます。

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

<comment>See Also:</comment>
   * SoapFault::__construct


id: SoapServer::getFunctions
type: function
doc:
<comment>Description:</comment>
  定義されている関数の一覧を返す
  
  SoapServer オブジェクトで定義されている関数の一覧を返します。 このメソッドは、
  SoapServer::addFunction もしくは SoapServer::setClass で追加された全ての関数の一覧を返します。

<comment>Return:</comment>
  <info>array</info>  定義されている関数の配列を返します。

<comment>See Also:</comment>
   * SoapServer::__construct
   * SoapServer::addFunction
   * SoapServer::setClass


id: SoapServer::handle
type: function
doc:
<comment>Description:</comment>
  SOAP リクエストを処理する
  
  SOAP リクエストを処理し、必要な関数をコールし、レスポンスを返送します。

<comment>Param:</comment>
  <info>string|null</info>  <strong>$request</strong>  SOAP リクエスト。もし引数が省略された場合、 HTTP リクエストで POST された
                         データの中にリクエストがあるとみなします。

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

<comment>See Also:</comment>
   * SoapServer::__construct


id: SoapServer::setClass
type: function
doc:
<comment>Description:</comment>
  SOAP リクエストを処理するクラスを設定する
  
  指定されたクラスから全てのメソッドをエクスポートします。
  
  このオブジェクトは SoapServer::setPersistence メソッドにより指定した PHP セッションに関するリクエ
  ストをまたがる 持続性を持たせることができます

<comment>Param:</comment>
  <info>string</info>  <strong>$class</strong>  エクスポートするクラス名
  <info>mixed</info>   <strong>$args</strong>   これらのオプションパラメータは、 オブジェクト作成時にデフォルトのクラスコンストラ
                  クタに渡されます。

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

<comment>See Also:</comment>
   * SoapServer::__construct
   * SoapServer::addFunction
   * SoapServer::setPersistence


id: SoapServer::setObject
type: function
doc:
<comment>Description:</comment>
  SOAP リクエストの処理に使用するオブジェクトを設定する
  
  SOAP リクエストを処理するハンドラとして、SoapServer::setClass のような単なるクラスではなく特定のオ
  ブジェクトを設定します。

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  リクエストを処理するオブジェクト。

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

<comment>See Also:</comment>
   * SoapServer::setClass


id: SoapServer::setPersistence
type: function
doc:
<comment>Description:</comment>
  SoapServer の持続モードを設定する
  
  この関数により、SoapServer オブジェクトの永続状態をリクエスト間で変更できるようになります。 この関
  数は、リクエスト間でのデータの保存に PHP のセッションを使います。 このメソッドが SoapServer に影響
  を及ぼすのは、SoapServer::setClass を使って関数をエクスポートした後となります。
  
  持続モード <info>SOAP_PERSISTENCE_SESSION</info> は、そのクラスのオブジェクトについてのみ持続させます。 クラス
  のスタティックなデータについては対象となりません。 self::$bar ではなく $this-&gt;bar を使用しま
  しょう。
  
  <info>SOAP_PERSISTENCE_SESSION</info> は、クラスのオブジェクト上のデータもリクエスト間でシリアライズします。 リ
  ソース (<class>PDO</class> など) を適切に扱うには、マジックメソッド __wakeup() および __sleep() を使う必要があり
  ます。

<comment>Param:</comment>
  <info>int</info>  <strong>$mode</strong>  <return>SOAP_PERSISTENCE_XXX</return> 定数のうちの一つ
              
              <info>SOAP_PERSISTENCE_REQUEST</info> - SoapServer のデータはリクエスト間で持続しません。 これは、
              SoapServer オブジェクトで setClass をコールした直後のデフォルトの挙動です。
              
              <info>SOAP_PERSISTENCE_SESSION</info> - SoapServer のデータをリクエスト間で持続させます。 これを実
              現するために、SoapServer クラスのデータをシリアライズして
              $_SESSION['_bogus_session_name'] に格納します。 そのため、このモードを設定する前に
              <strong>session_start()</strong> をコールしておく必要があります。

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

<comment>See Also:</comment>
   * SoapServer::setClass


id: SoapVar::__construct
type: function
doc:
<comment>Description:</comment>
  SoapVar コンストラクタ
  
  新しい <class>SoapVar</class> オブジェクトを生成します。

<comment>Param:</comment>
  <info>mixed</info>     <strong>$data</strong>            渡すもしくは返すデータ
  <info>int|null</info>  <strong>$encoding</strong>        エンコーディング ID。<return>XSD_...</return> 定数のうちの一つ。
  <info></info>          <strong>$type_name</strong>       型の名前
  <info></info>          <strong>$type_namespace</strong>  型の名前空間
  <info></info>          <strong>$node_name</strong>       XML ノードの名前
  <info></info>          <strong>$node_namespace</strong>  XML ノードの名前空間

<comment>See Also:</comment>
   * SoapClient::__soapCall
   * SoapParam::__construct


id: SolrClient
type: class
doc:
<comment>Description:</comment>
  Used to send requests to a Solr server. Currently, cloning and serialization of SolrClient
  instances is not supported.


id: SolrClient::DEFAULT_SYSTEM_SERVLET
type: constant
doc:
<comment>Description:</comment>
  This is the initial value for the system servlet used to obtain Solr Server information


id: SolrClient::DEFAULT_TERMS_SERVLET
type: constant
doc:
<comment>Description:</comment>
  This is the initial value for the terms servlet used for the TermsComponent


id: SolrClient::__construct
type: function
doc:
<comment>Description:</comment>
  Constructor for the SolrClient object
  
  Constructor for the SolrClient object

<comment>Param:</comment>
  <info>array</info>  <strong>$clientOptions</strong>  This is an array containing one of the following keys :
                         
                         

<comment>See Also:</comment>
   * SolrClient::getOptions


id: SolrClient::__destruct
type: function
doc:
<comment>Description:</comment>
  SolrClient に対するデストラクタ
  
  デストラクタ

<comment>Return:</comment>
  <info>unknown</info>  SolrClient に対するデストラクタ

<comment>See Also:</comment>
   * SolrClient::__construct


id: SolrClient::addDocument
type: function
doc:
<comment>Description:</comment>
  Adds a document to the index
  
  This method adds a document to the index.

<comment>Param:</comment>
  <info>SolrInputDocument</info>  <strong>$doc</strong>           The SolrInputDocument instance.
  <info>bool</info>               <strong>$overwrite</strong>     Whether to overwrite existing document or not. If <info>false</info> there
                                    will be duplicates (several documents with the same ID).
                                    
                                    PECL Solr
                                    \< 2.0 $allowDups was used instead of $overwrite, which does the same functionality with exact opposite bool flag.
                                    
                                    $allowDups = false is the same as $overwrite = true
  <info>int</info>                <strong>$commitWithin</strong>  Number of milliseconds within which to auto commit this
                                    document. Available since Solr 1.4 . Default (0) means disabled.
                                    
                                    When this value specified, it leaves the control of when to do
                                    the commit to Solr itself, optimizing number of commits to a
                                    minimum while still fulfilling the update latency requirements,
                                    and Solr will automatically do a commit when the oldest add in
                                    the buffer is due.

<comment>Return:</comment>
  <info>SolrUpdateResponse</info>  Returns a <info>SolrUpdateResponse</info> object or throws an Exception on failure.

<comment>See Also:</comment>
   * SolrClient::addDocuments
   * SolrClient::commit


id: SolrClient::addDocuments
type: function
doc:
<comment>Description:</comment>
  Adds a collection of SolrInputDocument instances to the index
  
  Adds a collection of documents to the index.

<comment>Param:</comment>
  <info>array</info>  <strong>$docs</strong>          An array containing the collection of SolrInputDocument instances. This
                        array must be an actual variable.
  <info>bool</info>   <strong>$overwrite</strong>     Whether to overwrite existing documents or not. If <info>false</info> there will be
                        duplicates (several documents with the same ID).
                        
                        PECL Solr
                        \< 2.0 $allowDups was used instead of $overwrite, which does the same functionality with exact opposite bool flag.
                        
                        $allowDups = false is the same as $overwrite = true
  <info>int</info>    <strong>$commitWithin</strong>  Number of milliseconds within which to auto commit this document. Available
                        since Solr 1.4 . Default (0) means disabled.
                        
                        When this value specified, it leaves the control of when to do the commit to
                        Solr itself, optimizing number of commits to a minimum while still
                        fulfilling the update latency requirements, and Solr will automatically do a
                        commit when the oldest add in the buffer is due.

<comment>Return:</comment>
  <info>void</info>  Returns a <info>SolrUpdateResponse</info> object or throws an exception on failure.

<comment>See Also:</comment>
   * SolrClient::addDocument
   * SolrClient::commit


id: SolrClient::commit
type: function
doc:
<comment>Description:</comment>
  Finalizes all add/deletes made to the index
  
  This method finalizes all add/deletes made to the index.

<comment>Param:</comment>
  <info>bool</info>  <strong>$softCommit</strong>      This will refresh the 'view' of the index in a more performant manner, but
                         without "on-disk" guarantees. (Solr4.0+)
                         
                         A soft commit is much faster since it only makes index changes visible and
                         does not fsync index files or write a new index descriptor.  If the JVM
                         crashes or there is a loss of power, changes that occurred after the last
                         hard commit will be lost.  Search collections that have near-real-time
                         requirements (that want index changes to be quickly visible to searches)
                         will want to soft commit often but hard commit less frequently.
  <info>bool</info>  <strong>$waitSearcher</strong>    block until a new searcher is opened and registered as the main query
                         searcher, making the changes visible.
  <info>bool</info>  <strong>$expungeDeletes</strong>  Merge segments with deletes away. (Solr1.4+)

<comment>Return:</comment>
  <info>SolrUpdateResponse</info>  Returns a <class>SolrUpdateResponse</class> object on success or throws an exception on
                      failure.

<comment>See Also:</comment>
   * SolrClient::optimize
   * SolrClient::rollback


id: SolrClient::deleteById
type: function
doc:
<comment>Description:</comment>
  Delete by Id
  
  Deletes the document with the specified ID. Where ID is the value of the uniqueKey field declared
  in the schema

<comment>Param:</comment>
  <info>string</info>  <strong>$id</strong>  The value of the uniqueKey field declared in the schema

<comment>Return:</comment>
  <info>SolrUpdateResponse</info>  Returns a <info>SolrUpdateResponse</info> on success and throws an exception on failure.

<comment>See Also:</comment>
   * SolrClient::deleteByIds
   * SolrClient::deleteByQuery
   * SolrClient::deleteByQueries


id: SolrClient::deleteByIds
type: function
doc:
<comment>Description:</comment>
  Deletes by Ids
  
  Deletes a collection of documents with the specified set of ids.

<comment>Param:</comment>
  <info>array</info>  <strong>$ids</strong>  An array of IDs representing the uniqueKey field declared in the schema for each
               document to be deleted. This must be an actual php variable.

<comment>Return:</comment>
  <info>SolrUpdateResponse</info>  Returns a <info>SolrUpdateResponse</info> on success and throws an exception on failure.

<comment>See Also:</comment>
   * SolrClient::deleteById
   * SolrClient::deleteByQuery
   * SolrClient::deleteByQueries


id: SolrClient::deleteByQueries
type: function
doc:
<comment>Description:</comment>
  Removes all documents matching any of the queries
  
  Removes all documents matching any of the queries

<comment>Param:</comment>
  <info>array</info>  <strong>$queries</strong>  The array of queries. This must be an actual php variable.

<comment>Return:</comment>
  <info>SolrUpdateResponse</info>  Returns a SolrUpdateResponse on success and throws a SolrClientException on
                      failure.

<comment>See Also:</comment>
   * SolrClient::deleteById
   * SolrClient::deleteByIds
   * SolrClient::deleteByQuery


id: SolrClient::deleteByQuery
type: function
doc:
<comment>Description:</comment>
  Deletes all documents matching the given query
  
  Deletes all documents matching the given query.

<comment>Param:</comment>
  <info>string</info>  <strong>$query</strong>  The query

<comment>Return:</comment>
  <info>SolrUpdateResponse</info>  Returns a <info>SolrUpdateResponse</info> on success and throws an exception on failure.

<comment>See Also:</comment>
   * SolrClient::deleteById
   * SolrClient::deleteByIds
   * SolrClient::deleteByQueries


id: SolrClient::getById
type: function
doc:
<comment>Description:</comment>
  Get Document By Id. Utilizes Solr Realtime Get (RTG)
  
  Get Document By Id. Utilizes Solr Realtime Get (RTG).

<comment>Param:</comment>
  <info>string</info>  <strong>$id</strong>  Document ID

<comment>Return:</comment>
  <info>SolrQueryResponse</info>  <info>SolrQueryResponse</info>

<comment>See Also:</comment>
   * SolrClient::getByIds


id: SolrClient::getByIds
type: function
doc:
<comment>Description:</comment>
  Get Documents by their Ids. Utilizes Solr Realtime Get (RTG)
  
  Get Documents by their Ids. Utilizes Solr Realtime Get (RTG).

<comment>Param:</comment>
  <info>array</info>  <strong>$ids</strong>  Document ids

<comment>Return:</comment>
  <info>SolrQueryResponse</info>  <info>SolrQueryResponse</info>

<comment>See Also:</comment>
   * SolrClient::getById


id: SolrClient::getDebug
type: function
doc:
<comment>Description:</comment>
  Returns the debug data for the last connection attempt
  
  Returns the debug data for the last connection attempt

<comment>Return:</comment>
  <info>string</info>  Returns a string on success and null if there is nothing to return.


id: SolrClient::getOptions
type: function
doc:
<comment>Description:</comment>
  Returns the client options set internally
  
  Returns the client options set internally. Very useful for debugging. The values returned are
  readonly and can only be set when the object is instantiated.

<comment>Return:</comment>
  <info>array</info>  Returns an array containing all the options for the SolrClient object set internally.

<comment>See Also:</comment>
   * SolrClient::__construct


id: SolrClient::optimize
type: function
doc:
<comment>Description:</comment>
  Defragments the index
  
  Defragments the index for faster search performance.

<comment>Param:</comment>
  <info>int</info>   <strong>$maxSegments</strong>   Optimizes down to at most this number of segments. Since Solr 1.3
  <info>bool</info>  <strong>$softCommit</strong>    This will refresh the 'view' of the index in a more performant manner, but
                       without "on-disk" guarantees. (Solr4.0+)
  <info>bool</info>  <strong>$waitSearcher</strong>  Block until a new searcher is opened and registered as the main query
                       searcher, making the changes visible.

<comment>Return:</comment>
  <info>SolrUpdateResponse</info>  Returns a SolrUpdateResponse on success or throws an exception on failure.

<comment>See Also:</comment>
   * SolrClient::commit
   * SolrClient::rollback


id: SolrClient::ping
type: function
doc:
<comment>Description:</comment>
  Checks if Solr server is still up
  
  Checks if the Solr server is still alive. Sends a HEAD request to the Apache Solr server.

<comment>Return:</comment>
  <info>SolrPingResponse</info>  Returns a <info>SolrPingResponse</info> object on success and throws an exception on failure.


id: SolrClient::query
type: function
doc:
<comment>Description:</comment>
  Sends a query to the server
  
  Sends a query to the server.

<comment>Param:</comment>
  <info>SolrParams</info>  <strong>$query</strong>  A <info>SolrParams</info> object. It is recommended to use <info>SolrQuery</info> for advanced queries.

<comment>Return:</comment>
  <info>SolrQueryResponse</info>  Returns a <info>SolrQueryResponse</info> object on success and throws an exception on
                     failure.


id: SolrClient::request
type: function
doc:
<comment>Description:</comment>
  Sends a raw update request
  
  Sends a raw XML update request to the server

<comment>Param:</comment>
  <info>string</info>  <strong>$raw_request</strong>  An XML string with the raw request to the server.

<comment>Return:</comment>
  <info>SolrUpdateResponse</info>  Returns a <info>SolrUpdateResponse</info> on success. Throws an exception on failure.


id: SolrClient::rollback
type: function
doc:
<comment>Description:</comment>
  Rollbacks all add/deletes made to the index since the last commit
  
  Rollbacks all add/deletes made to the index since the last commit. It neither calls any event
  listeners nor creates a new searcher.

<comment>Return:</comment>
  <info>SolrUpdateResponse</info>  Returns a SolrUpdateResponse on success or throws a SolrClientException on
                      failure.

<comment>See Also:</comment>
   * SolrClient::commit
   * SolrClient::optimize


id: SolrClient::setResponseWriter
type: function
doc:
<comment>Description:</comment>
  Sets the response writer used to prepare the response from Solr
  
  Sets the response writer used to prepare the response from Solr

<comment>Param:</comment>
  <info>string</info>  <strong>$responseWriter</strong>  One of the following:

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


id: SolrClient::setServlet
type: function
doc:
<comment>Description:</comment>
  Changes the specified servlet type to a new value
  
  Changes the specified servlet type to a new value

<comment>Param:</comment>
  <info>int</info>     <strong>$type</strong>   One of the following :
                  
                  
  <info>string</info>  <strong>$value</strong>  The new value for the servlet

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


id: SolrClient::system
type: function
doc:
<comment>Description:</comment>
  Retrieve Solr Server information
  
  Retrieve Solr Server information

<comment>Return:</comment>
  <info>void</info>  Returns a <info>SolrGenericResponse</info> object on success.


id: SolrClient::threads
type: function
doc:
<comment>Description:</comment>
  スレッドの状態をチェック
  
  スレッドの状態をチェック

<comment>Return:</comment>
  <info>void</info>  SolrGenericResponse オブジェクトを返します。


id: SolrClientException::getInternalInfo
type: function
doc:
<comment>Description:</comment>
  例外がスローされた際の内部情報を返す
  
  例外がスローされた際の内部情報を返します。

<comment>Return:</comment>
  <info>array</info>  エラーがスローされた際の内部情報を含む配列を返します。拡張モジュールの開発者によるデバッグ
         のためだけに使われます。


id: SolrCollapseFunction::__construct
type: function
doc:
<comment>Description:</comment>
  Constructor
  
  Collapse Function constructor

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  The field name to collapse on.
                  
                  In order to collapse a result. The field type must be a single valued String, Int
                  or Float.

<comment>See Also:</comment>
   * SolrQuery::collapse


id: SolrCollapseFunction::__toString
type: function
doc:
<comment>Description:</comment>
  Returns a string representing the constructed collapse function
  
  Returns a string representing the constructed collapse function

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


id: SolrCollapseFunction::getField
type: function
doc:
<comment>Description:</comment>
  Returns the field that is being collapsed on
  
  Returns the field that is being collapsed on.

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

<comment>See Also:</comment>
   * SolrCollapseFunction::setField


id: SolrCollapseFunction::getHint
type: function
doc:
<comment>Description:</comment>
  Returns collapse hint
  
  Returns collapse hint

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

<comment>See Also:</comment>
   * SolrCollapseFunction::setHint


id: SolrCollapseFunction::getMax
type: function
doc:
<comment>Description:</comment>
  Returns max parameter
  
  Returns max parameter

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

<comment>See Also:</comment>
   * SolrCollapseFunction::setMax


id: SolrCollapseFunction::getMin
type: function
doc:
<comment>Description:</comment>
  Returns min parameter
  
  Returns min parameter

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

<comment>See Also:</comment>
   * SolrCollapseFunction::setMin


id: SolrCollapseFunction::getNullPolicy
type: function
doc:
<comment>Description:</comment>
  Returns null policy
  
  Returns null policy used or null

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

<comment>See Also:</comment>
   * SolrCollapseFunction::setNullPolicy


id: SolrCollapseFunction::getSize
type: function
doc:
<comment>Description:</comment>
  Returns size parameter
  
  Gets the initial size of the collapse data structures when collapsing on a numeric field only

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

<comment>See Also:</comment>
   * SolrCollapseFunction::setSize


id: SolrCollapseFunction::setField
type: function
doc:
<comment>Description:</comment>
  Sets the field to collapse on
  
  The field name to collapse on.  In order to collapse a result. The field type must be a single
  valued String, Int or Float.

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>  

<comment>Return:</comment>
  <info>SolrCollapseFunction</info>  <info>SolrCollapseFunction</info>


id: SolrCollapseFunction::setHint
type: function
doc:
<comment>Description:</comment>
  Sets collapse hint
  
  Sets collapse hint

<comment>Param:</comment>
  <info>string</info>  <strong>$hint</strong>  Currently there is only one hint available "top_fc", which stands for top level
                 FieldCache

<comment>Return:</comment>
  <info>SolrCollapseFunction</info>  <info>SolrCollapseFunction</info>


id: SolrCollapseFunction::setMax
type: function
doc:
<comment>Description:</comment>
  Selects the group heads by the max value of a numeric field or function query
  
  Selects the group heads by the max value of a numeric field or function query.

<comment>Param:</comment>
  <info>string</info>  <strong>$max</strong>  

<comment>Return:</comment>
  <info>SolrCollapseFunction</info>  <info>SolrCollapseFunction</info>


id: SolrCollapseFunction::setMin
type: function
doc:
<comment>Description:</comment>
  Sets the initial size of the collapse data structures when collapsing on a numeric field only
  
  Sets the initial size of the collapse data structures when collapsing on a numeric field only

<comment>Param:</comment>
  <info>string</info>  <strong>$min</strong>  

<comment>Return:</comment>
  <info>SolrCollapseFunction</info>  <info>SolrCollapseFunction</info>


id: SolrCollapseFunction::setNullPolicy
type: function
doc:
<comment>Description:</comment>
  Sets the NULL Policy
  
  Sets the NULL Policy. One of the 3 policies defined as class constants shall be passed. Accepts
  ignore, expand, or collapse policies.

<comment>Param:</comment>
  <info>string</info>  <strong>$nullPolicy</strong>  

<comment>Return:</comment>
  <info>SolrCollapseFunction</info>  <info>SolrCollapseFunction</info>


id: SolrCollapseFunction::setSize
type: function
doc:
<comment>Description:</comment>
  Sets the initial size of the collapse data structures when collapsing on a numeric field only
  
  Sets the initial size of the collapse data structures when collapsing on a numeric field only.

<comment>Param:</comment>
  <info>int</info>  <strong>$size</strong>  

<comment>Return:</comment>
  <info>SolrCollapseFunction</info>  <info>SolrCollapseFunction</info>


id: SolrDisMaxQuery::FACET_SORT_COUNT
type: constant
doc:
<comment>Description:</comment>
  Used to specify that the facet should sort by count (Duplicated for easier migration)


id: SolrDisMaxQuery::FACET_SORT_INDEX
type: constant
doc:
<comment>Description:</comment>
  Used to specify that the facet should sort by index (Duplicated for easier migration)


id: SolrDisMaxQuery::ORDER_ASC
type: constant
doc:
<comment>Description:</comment>
  Used to specify that the sorting should be in acending order (Duplicated for easier migration)


id: SolrDisMaxQuery::ORDER_DESC
type: constant
doc:
<comment>Description:</comment>
  Used to specify that the sorting should be in descending order (Duplicated for easier migration)


id: SolrDisMaxQuery::__construct
type: function
doc:
<comment>Description:</comment>
  Class Constructor
  
  Class constructor initializes the object and sets the q parameter if passed

<comment>Param:</comment>
  <info>string</info>  <strong>$q</strong>  Search Query (q parameter)


id: SolrDisMaxQuery::addBigramPhraseField
type: function
doc:
<comment>Description:</comment>
  Adds a Phrase Bigram Field (pf2 parameter)
  
  Adds a Phrase Bigram Field (pf2 parameter) output format: field~slop^boost OR field^boost Slop is
  optional

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  
  <info>string</info>  <strong>$boost</strong>  
  <info>string</info>  <strong>$slop</strong>   

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::removeBigramPhraseField
   * SolrDisMaxQuery::setBigramPhraseFields
   * SolrDisMaxQuery::setBigramPhraseSlop


id: SolrDisMaxQuery::addBoostQuery
type: function
doc:
<comment>Description:</comment>
  Adds a boost query field with value and optional boost (bq parameter)
  
  Adds a Boost Query field with value [and boost] (bq parameter)

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  
  <info>string</info>  <strong>$value</strong>  
  <info>string</info>  <strong>$boost</strong>  

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::removeBoostQuery
   * SolrDisMaxQuery::setBoostQuery


id: SolrDisMaxQuery::addPhraseField
type: function
doc:
<comment>Description:</comment>
  Adds a Phrase Field (pf parameter)
  
  Adds a Phrase Field (pf parameter)

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  field name
  <info>string</info>  <strong>$boost</strong>  
  <info>string</info>  <strong>$slop</strong>   

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::removePhraseField
   * SolrDisMaxQuery::setPhraseFields


id: SolrDisMaxQuery::addQueryField
type: function
doc:
<comment>Description:</comment>
  Add a query field with optional boost (qf parameter)
  
  Add a query field with optional boost (qf parameter)

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  field name
  <info>string</info>  <strong>$boost</strong>  Boost value. Boosts documents with matching terms.

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::removeQueryField


id: SolrDisMaxQuery::addTrigramPhraseField
type: function
doc:
<comment>Description:</comment>
  Adds a Trigram Phrase Field (pf3 parameter)
  
  Adds a Trigram Phrase Field (pf3 parameter)

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Field Name
  <info>string</info>  <strong>$boost</strong>  Field Boost
  <info>string</info>  <strong>$slop</strong>   Field Slop

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::removeTrigramPhraseField
   * SolrDisMaxQuery::setTrigramPhraseFields
   * SolrDisMaxQuery::setTrigramPhraseSlop


id: SolrDisMaxQuery::addUserField
type: function
doc:
<comment>Description:</comment>
  Adds a field to User Fields Parameter (uf)
  
  Adds a field to The User Fields Parameter (uf)

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Field Name

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::removeUserField
   * SolrDisMaxQuery::setUserFields


id: SolrDisMaxQuery::removeBigramPhraseField
type: function
doc:
<comment>Description:</comment>
  Removes phrase bigram field (pf2 parameter)
  
  Removes a Bigram Phrase Field (pf2 parameter) that was previously added using
  SolrDisMaxQuery::addBigramPhraseField

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  The Field Name

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::addBigramPhraseField
   * SolrDisMaxQuery::setBigramPhraseFields
   * SolrDisMaxQuery::setBigramPhraseSlop


id: SolrDisMaxQuery::removeBoostQuery
type: function
doc:
<comment>Description:</comment>
  Removes a boost query partial by field name (bq)
  
  Removes a boost query partial from the existing query, only if SolrDisMaxQuery::addBoostQuery was
  used.

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Field Name

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::addBoostQuery
   * SolrDisMaxQuery::setBoostQuery


id: SolrDisMaxQuery::removePhraseField
type: function
doc:
<comment>Description:</comment>
  Removes a Phrase Field (pf parameter)
  
  Removes a Phrase Field (pf parameter) that was previously added using
  SolrDisMaxQuery::addPhraseField

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Field Name

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::addPhraseField
   * SolrDisMaxQuery::setPhraseFields


