# php_manual

id: APCUIterator
type: class
doc:
<comment>Description:</comment>
  <class>APCUIterator</class> クラスを使うと、巨大な APCu キャッシュの反復処理を容易に行えます。 巨大なキャッシュを
  順を追って処理し、 ロックインスタンス単位で決まった数のエントリを取得することができます。 そのた
  め、キャッシュ全体を抱え込んで 100 件 (デフォルト) のエントリを取り込むのではなく、 キャッシュの
  ロックを解放して他の操作ができる状態にすることが可能です。 また、正規表現によるマッチングは C 言語
  レベルで行われるのでより効率的です。


id: APCUIterator::__construct
type: function
doc:
<comment>Description:</comment>
  APCUIterator イテレータオブジェクトを作成する
  
  <class>APCUIterator</class> オブジェクトを作成します。

<comment>Param:</comment>
  <info>array|string|null</info>  <strong>$search</strong>      単一の文字列を指定する場合、APCu のキーの名前にマッチする PCRE 正
                                  規表現を指定します。 配列を指定した場合は、APCu のキーの名前を指定
                                  します。 <info>null</info> を渡すと、検索をスキップします。
  <info>int</info>                <strong>$format</strong>      希望する書式。 APC_ITER_* 定数の組み合わせで指定します。
  <info>int</info>                <strong>$chunk_size</strong>  チャンクサイズ。0 より大きい値でなければなりません。 デフォルト値
                                  は 100 です。
  <info>int</info>                <strong>$list</strong>        一覧にする形式。<info>APC_LIST_ACTIVE</info> あるいは <info>APC_LIST_DELETED</info> を渡しま
                                  す。

<comment>See Also:</comment>
   * <strong>apcu_exists()</strong>
   * <strong>apcu_cache_info()</strong>


id: APCUIterator::current
type: function
doc:
<comment>Description:</comment>
  現在の項目を取得する
  
  <class>APCUIterator</class> から現在の項目を取得します。

<comment>Return:</comment>
  <info>mixed</info>  成功した場合に現在の項目を返します。 もう項目が存在しない場合や取得に失敗した場合は <info>false</info>
         を返します。

<comment>See Also:</comment>
   * APCUIterator::next
   * Iterator::current


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

<comment>Return:</comment>
  <info>int</info>  総数を返します。

<comment>See Also:</comment>
   * APCUIterator::getTotalHits
   * APCUIterator::getTotalSize
   * <strong>apcu_cache_info()</strong>


id: APCUIterator::getTotalHits
type: function
doc:
<comment>Description:</comment>
  キャッシュヒットの総数を取得する
  
  キャッシュヒットの総数を取得します。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>int</info>  成功した場合にヒット数、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * APCUIterator::getTotalCount
   * APCUIterator::getTotalSize
   * <strong>apcu_cache_info()</strong>


id: APCUIterator::getTotalSize
type: function
doc:
<comment>Description:</comment>
  キャッシュのサイズの合計を取得する
  
  キャッシュのサイズの合計を取得します。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>int</info>  キャッシュのサイズの合計を返します。

<comment>See Also:</comment>
   * APCUIterator::getTotalCount
   * APCUIterator::getTotalHits
   * <strong>apcu_cache_info()</strong>


id: APCUIterator::key
type: function
doc:
<comment>Description:</comment>
  イテレータのキーを取得する
  
  現在のイテレータのキーを取得します。

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

<comment>See Also:</comment>
   * APCUIterator::current
   * Iterator::key


id: APCUIterator::next
type: function
doc:
<comment>Description:</comment>
  ポインタを次の項目に移動させる
  
  イテレータのポインタを次の要素に移動させます。

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

<comment>See Also:</comment>
   * APCUIterator::current
   * APCUIterator::rewind
   * Iterator::next


id: APCUIterator::rewind
type: function
doc:
<comment>Description:</comment>
  イテレータを巻き戻す
  
  イテレータを最初の要素に巻き戻します

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

<comment>See Also:</comment>
   * APCUIterator::next
   * Iterator::next


id: APCUIterator::valid
type: function
doc:
<comment>Description:</comment>
  現在位置が有効かどうかを調べる
  
  イテレータの現在位置が有効かどうかを調べます。

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

<comment>See Also:</comment>
   * APCUIterator::current
   * Iterator::valid


id: ARRAY_FILTER_USE_BOTH
type: constant
doc:
<comment>Description:</comment>
  <info>ARRAY_FILTER_USE_BOTH</info> は <strong>array_filter()</strong> で使うもので、 値とキーの両方をコールバック関数の引数とし
  て渡すよう指示します。


id: ARRAY_FILTER_USE_KEY
type: constant
doc:
<comment>Description:</comment>
  <info>ARRAY_FILTER_USE_KEY</info> は <strong>array_filter()</strong> で使うもので、 各キーをコールバック関数の最初の引数として渡
  すよう指示します。


id: ASSERT_ACTIVE
type: constant
doc:
<comment>Description:</comment>
  assert.active
  
  <strong>assert()</strong> の評価を有効にします。 この機能は PHP 8.3.0 で
  非推奨になります。この機能に頼らないことを強く推奨します。


id: ASSERT_BAIL
type: constant
doc:
<comment>Description:</comment>
  assert.bail
  
  アサーションに失敗した時点に実行を中断します。 この機能は PHP 8.3.0 で
  非推奨になります。この機能に頼らないことを強く推奨します。


id: ASSERT_CALLBACK
type: constant
doc:
<comment>Description:</comment>
  assert.callback
  
  アサーションに失敗した場合に実行するコールバック。 この機能は PHP 8.3.0 で
  非推奨になります。この機能に頼らないことを強く推奨します。


id: ASSERT_EXCEPTION
type: constant
doc:
<comment>Description:</comment>
  assert.exception
  
  アサーションに失敗するたびに PHP の警告を発行します。 この機能は PHP 8.3.0 で
  非推奨になります。この機能に頼らないことを強く推奨します。


id: ASSERT_QUIET_EVAL
type: constant
doc:
<comment>Description:</comment>
  assert.quiet_eval
  
  アサーション式の評価中は <return>error_reporting</return> を無効にします。 この機能は、PHP 8.0.0 で 削除されまし
  た。


id: ASSERT_WARNING
type: constant
doc:
<comment>Description:</comment>
  assert.warning
  
  アサーションに失敗するたびに PHP の警告を発行します。 この機能は PHP 8.3.0 で
  非推奨になります。この機能に頼らないことを強く推奨します。


id: AllowDynamicProperties::__construct
type: function
doc:
<comment>Description:</comment>
  新しい AllowDynamicProperties のインスタンスを作成する
  
  新しい <class>AllowDynamicProperties</class> のインスタンスを作成します。


id: AppendIterator::__construct
type: function
doc:
<comment>Description:</comment>
  AppendIterator を作成する
  
  AppendIterator を作成します。

<comment>See Also:</comment>
   * AppendIterator::append


id: AppendIterator::append
type: function
doc:
<comment>Description:</comment>
  イテレータを追加する
  
  イテレータを追加します。

<comment>Param:</comment>
  <info>Iterator</info>  <strong>$iterator</strong>  追加するイテレータ。

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

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


id: AppendIterator::current
type: function
doc:
<comment>Description:</comment>
  現在の値を取得する
  
  現在の値を取得します。

<comment>Return:</comment>
  <info>mixed</info>  有効な状態の場合は現在の値、それ以外の場合は <info>null</info> を返します。

<comment>See Also:</comment>
   * Iterator::current
   * AppendIterator::key
   * AppendIterator::valid
   * AppendIterator::next
   * AppendIterator::rewind


id: AppendIterator::getArrayIterator
type: function
doc:
<comment>Description:</comment>
  ArrayIterator を取得する
  
  このメソッドは <class>ArrayIterator</class> を取得します。ここに、 AppendIterator::append で追加したイテレータを
  格納します。

<comment>Return:</comment>
  <info>ArrayIterator</info>  追加したイテレータを含む <class>ArrayIterator</class> を返します。

<comment>See Also:</comment>
   * AppendIterator::getInnerIterator


id: AppendIterator::getIteratorIndex
type: function
doc:
<comment>Description:</comment>
  イテレータのインデックスを取得する
  
  現在の内部イテレータのインデックスを取得します。

<comment>Return:</comment>
  <info>int|null</info>  存在していれば、 現在の内部イテレータのインデックス (最初はゼロ) を整数値で返します。 存
            在しない場合、<info>null</info> を返します。

<comment>See Also:</comment>
   * AppendIterator::getInnerIterator
   * AppendIterator::getArrayIterator


id: AppendIterator::key
type: function
doc:
<comment>Description:</comment>
  現在のキーを取得する
  
  現在のキーを取得します。

<comment>Return:</comment>
  <info>scalar</info>  有効な状態の場合は現在のキー、それ以外の場合は <info>null</info> を返します。

<comment>See Also:</comment>
   * AppendIterator::current


id: AppendIterator::next
type: function
doc:
<comment>Description:</comment>
  次の要素に移動する
  
  次の要素に移動します。もし別のイテレータに移動する場合は、そのイテレータを巻き戻します。

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

<comment>See Also:</comment>
   * Iterator::next
   * AppendIterator::current
   * AppendIterator::key
   * AppendIterator::valid
   * AppendIterator::rewind


id: AppendIterator::rewind
type: function
doc:
<comment>Description:</comment>
  イテレータを巻き戻す
  
  最初の内部イテレータの最初の要素まで巻き戻します。

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

<comment>See Also:</comment>
   * Iterator::rewind
   * AppendIterator::current
   * AppendIterator::key
   * AppendIterator::next
   * AppendIterator::valid


id: AppendIterator::valid
type: function
doc:
<comment>Description:</comment>
  現在の要素が有効かどうかを調べる
  
  現在の要素が有効かどうかを調べます。

<comment>Return:</comment>
  <info>bool</info>  現在のイテレーションが有効な場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * AppendIterator::current
   * AppendIterator::key
   * AppendIterator::next
   * AppendIterator::rewind


id: ArrayAccess::offsetExists
type: function
doc:
<comment>Description:</comment>
  オフセットが存在するかどうか
  
  オフセットが存在するかどうかを返します。
  
  このメソッドが実行されるのは、<class>ArrayAccess</class> を実装したオブジェクト上で <strong>isset()</strong> あるいは <strong>empty()</strong> を使
  用した場合です。
  
  <strong>empty()</strong> を使用すると <strong>ArrayAccess::offsetGet()</strong> がコールされ、<strong>ArrayAccess::offsetExists()</strong> が <info>true</info> を
  返すかどうかで空かどうかを判断します。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$offset</strong>  調べたいオフセット。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。
        
        非 boolean 値が返された場合は <info>bool</info> にキャストして返します。


id: ArrayAccess::offsetGet
type: function
doc:
<comment>Description:</comment>
  オフセットを取得する
  
  指定したオフセットの値を返します。
  
  このメソッドは、オフセットが <strong>empty()</strong> かどうかを調べる際に実行されます。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$offset</strong>  取得したいオフセット。

<comment>Return:</comment>
  <info>mixed</info>  すべての型の値を返すことができます。

<comment>See Also:</comment>
   * ArrayAccess::offsetExists


id: ArrayAccess::offsetSet
type: function
doc:
<comment>Description:</comment>
  指定したオフセットに値を設定する
  
  指定したオフセットに値を代入します。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$offset</strong>  値を代入したいオフセット。
  <info>mixed</info>  <strong>$value</strong>   設定したい値。

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


id: ArrayAccess::offsetUnset
type: function
doc:
<comment>Description:</comment>
  オフセットの設定を解除する
  
  オフセットの設定を解除します。
  
  このメソッドは、 (unset) による型キャストの際にはコール されません。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$offset</strong>  設定解除したいオフセット。

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


id: ArrayIterator
type: class
doc:
<comment>Description:</comment>
  このイテレータは、配列やオブジェクトを反復処理する際に 値やキーを修正したり、要素を削除することが
  できます。
  
  同じ配列を何度も反復処理したい場合は、 ArrayObject のインスタンスとそれを参照する ArrayIterator の
  インスタンスを作成し、 foreach を使用するか getIterator() メソッドを手動でコールします。


id: ArrayIterator::STD_PROP_LIST
type: constant
doc:
<comment>Description:</comment>
  オブジェクトのプロパティが、 リストとして(var_dump, foreach などから)アクセスされたときの通常の機
  能を持つ


id: ArrayIterator::__construct
type: function
doc:
<comment>Description:</comment>
  ArrayIterator を作成する
  
  <class>ArrayIterator</class> オブジェクトを作成します。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>array|object</info>  <strong>$array</strong>  反復処理をする配列あるいはオブジェクト。
  <info>int</info>           <strong>$flags</strong>  <class>ArrayIterator</class> オブジェクトの振る舞いを制御するフラグ。
                        ArrayIterator::setFlags を参照ください。

<comment>See Also:</comment>
   * ArrayIterator::getArrayCopy


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

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  追加する値。

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

<comment>See Also:</comment>
   * ArrayIterator::next


id: ArrayIterator::asort
type: function
doc:
<comment>Description:</comment>
  値で配列をソートする
  
  値で配列をソートします。
  
  比較結果が等しくなる二つの要素があった場合、それらの並び順は保持されます。PHP 8.0.0 より前のバー
  ジョンでは、ソートした配列におけるそれらの並び順は不定でした。

<comment>Param:</comment>
  <info>int</info>  <strong>$flags</strong>  オプションの第二引数 <strong>$flags</strong> によりソートの動作を修正可能です。 使える値は下記の通りで
               す:
               
               ソートタイプのフラグ: <info>SORT_REGULAR</info> - 通常通りに項目を比較します。 詳細は 比較演算子
               で説明されています。<info>SORT_NUMERIC</info> - 数値として項目を比較します。<info>SORT_STRING</info> - 文字列と
               して項目を比較します。<info>SORT_LOCALE_STRING</info> - 現在のロケールに基づいて、文字列として項目
               を比較します。 比較に使うロケールは、<strong>setlocale()</strong> 関数で変更できます。 <info>SORT_NATURAL</info> -
               要素の比較を文字列として行い、  <strong>natsort()</strong> と同様の「自然順」で比較します。
               <info>SORT_FLAG_CASE</info> - <info>SORT_STRING</info> や <info>SORT_NATURAL</info> と (ビットORで) 組み合わせて使い、 文字
               列のソートで大文字小文字を区別しないようにします。
               
               <info>SORT_REGULAR</info> - 通常通りに項目を比較します。 詳細は 比較演算子 で説明されています。
               
               <info>SORT_NUMERIC</info> - 数値として項目を比較します。
               
               <info>SORT_STRING</info> - 文字列として項目を比較します。
               
               <info>SORT_LOCALE_STRING</info> - 現在のロケールに基づいて、文字列として項目を比較します。 比較に
               使うロケールは、<strong>setlocale()</strong> 関数で変更できます。
               
               <info>SORT_NATURAL</info> - 要素の比較を文字列として行い、  <strong>natsort()</strong> と同様の「自然順」で比較しま
               す。
               
               <info>SORT_FLAG_CASE</info> - <info>SORT_STRING</info> や <info>SORT_NATURAL</info> と (ビットORで) 組み合わせて使い、 文字
               列のソートで大文字小文字を区別しないようにします。

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

<comment>See Also:</comment>
   * ArrayIterator::ksort
   * ArrayIterator::natcasesort
   * ArrayIterator::natsort
   * ArrayIterator::uasort
   * ArrayIterator::uksort
   * <strong>asort()</strong>


id: ArrayIterator::count
type: function
doc:
<comment>Description:</comment>
  要素を数える
  
  配列の要素の数、あるいはオブジェクトの public プロパティの数を取得します。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>int</info>  連想配列の場合は要素の数、オブジェクトの場合は public プロパティの数を返します。

<comment>See Also:</comment>
   * ArrayIterator::getFlags


id: ArrayIterator::current
type: function
doc:
<comment>Description:</comment>
  現在の配列エントリを返す
  
  現在の配列エントリを取得します。

<comment>Return:</comment>
  <info>mixed</info>  現在の配列エントリを返します。


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

<comment>Return:</comment>
  <info>array</info>  配列のコピーを返します。 ArrayIterator がオブジェクトを参照している場合は public プロパティ
         の配列を返します。

<comment>See Also:</comment>
   * ArrayIterator::valid


id: ArrayIterator::getFlags
type: function
doc:
<comment>Description:</comment>
  振る舞いのフラグを取得する
  
  <class>ArrayIterator</class> の振る舞いを示すフラグを取得します。 利用可能なフラグについては、
  ArrayIterator::setFlags を参照ください。

<comment>Return:</comment>
  <info>int</info>  現在のフラグを返します。

<comment>See Also:</comment>
   * ArrayIterator::setFlags
   * ArrayIterator::valid


id: ArrayIterator::key
type: function
doc:
<comment>Description:</comment>
  現在の配列キーを返す
  
  この関数は、現在の配列キーを返します

<comment>Return:</comment>
  <info>string|int|null</info>  この関数は、現在の配列キーを返します


id: ArrayIterator::ksort
type: function
doc:
<comment>Description:</comment>
  キーで配列をソートする
  
  キーで配列をソートします。
  
  比較結果が等しくなる二つの要素があった場合、それらの並び順は保持されます。PHP 8.0.0 より前のバー
  ジョンでは、ソートした配列におけるそれらの並び順は不定でした。

<comment>Param:</comment>
  <info>int</info>  <strong>$flags</strong>  オプションの第二引数 <strong>$flags</strong> によりソートの動作を修正可能です。 使える値は下記の通りで
               す:
               
               ソートタイプのフラグ: <info>SORT_REGULAR</info> - 通常通りに項目を比較します。 詳細は 比較演算子
               で説明されています。<info>SORT_NUMERIC</info> - 数値として項目を比較します。<info>SORT_STRING</info> - 文字列と
               して項目を比較します。<info>SORT_LOCALE_STRING</info> - 現在のロケールに基づいて、文字列として項目
               を比較します。 比較に使うロケールは、<strong>setlocale()</strong> 関数で変更できます。 <info>SORT_NATURAL</info> -
               要素の比較を文字列として行い、  <strong>natsort()</strong> と同様の「自然順」で比較します。
               <info>SORT_FLAG_CASE</info> - <info>SORT_STRING</info> や <info>SORT_NATURAL</info> と (ビットORで) 組み合わせて使い、 文字
               列のソートで大文字小文字を区別しないようにします。
               
               <info>SORT_REGULAR</info> - 通常通りに項目を比較します。 詳細は 比較演算子 で説明されています。
               
               <info>SORT_NUMERIC</info> - 数値として項目を比較します。
               
               <info>SORT_STRING</info> - 文字列として項目を比較します。
               
               <info>SORT_LOCALE_STRING</info> - 現在のロケールに基づいて、文字列として項目を比較します。 比較に
               使うロケールは、<strong>setlocale()</strong> 関数で変更できます。
               
               <info>SORT_NATURAL</info> - 要素の比較を文字列として行い、  <strong>natsort()</strong> と同様の「自然順」で比較しま
               す。
               
               <info>SORT_FLAG_CASE</info> - <info>SORT_STRING</info> や <info>SORT_NATURAL</info> と (ビットORで) 組み合わせて使い、 文字
               列のソートで大文字小文字を区別しないようにします。

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

<comment>See Also:</comment>
   * ArrayIterator::asort
   * ArrayIterator::natcasesort
   * ArrayIterator::natsort
   * ArrayIterator::uasort
   * ArrayIterator::uksort
   * <strong>ksort()</strong>


id: ArrayIterator::natcasesort
type: function
doc:
<comment>Description:</comment>
  大文字小文字を区別せずに自然順で配列をソートする
  
  大文字小文字を区別しない "自然順" アルゴリズムを使って、値でエントリをソートします。
  
  比較結果が等しくなる二つの要素があった場合、それらの並び順は保持されます。PHP 8.0.0 より前のバー
  ジョンでは、ソートした配列におけるそれらの並び順は不定でした。

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

<comment>See Also:</comment>
   * ArrayIterator::asort
   * ArrayIterator::ksort
   * ArrayIterator::natsort
   * ArrayIterator::uasort
   * ArrayIterator::uksort
   * <strong>natcasesort()</strong>


id: ArrayIterator::natsort
type: function
doc:
<comment>Description:</comment>
  自然順で配列をソートする
  
  "自然順" アルゴリズムを使って、値でエントリをソートします。
  
  比較結果が等しくなる二つの要素があった場合、それらの並び順は保持されます。PHP 8.0.0 より前のバー
  ジョンでは、ソートした配列におけるそれらの並び順は不定でした。

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

<comment>See Also:</comment>
   * ArrayIterator::asort
   * ArrayIterator::ksort
   * ArrayIterator::natsort
   * ArrayIterator::uasort
   * ArrayIterator::uksort
   * <strong>natsort()</strong>


id: ArrayIterator::next
type: function
doc:
<comment>Description:</comment>
  次のエントリに移動する
  
  この関数は次のエントリにイテレータを移動します。

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


id: ArrayIterator::offsetExists
type: function
doc:
<comment>Description:</comment>
  オフセットが存在するかどうかを調べる
  
  オフセットが存在するかどうかを調べます。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$key</strong>  調べたいオフセット。

<comment>Return:</comment>
  <info>bool</info>  オフセットが存在する場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * ArrayIterator::valid


id: ArrayIterator::offsetGet
type: function
doc:
<comment>Description:</comment>
  オフセットの値を取得する
  
  指定したオフセットの値を取得します。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$key</strong>  値を取得したいオフセット。

<comment>Return:</comment>
  <info>mixed</info>  オフセット <strong>$key</strong> の値を返します。

<comment>See Also:</comment>
   * ArrayIterator::offsetSet
   * ArrayIterator::offsetUnset


id: ArrayIterator::offsetSet
type: function
doc:
<comment>Description:</comment>
  オフセットの値を設定する
  
  指定したオフセットの値を設定します。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$key</strong>    設定したいインデックス。
  <info>mixed</info>  <strong>$value</strong>  インデックスに格納する新しい値。

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

<comment>See Also:</comment>
   * ArrayIterator::offsetGet
   * ArrayIterator::offsetUnset


id: ArrayIterator::offsetUnset
type: function
doc:
<comment>Description:</comment>
  オフセットの値を削除する
  
  オフセットの値を削除します。
  
  反復処理を実行中の場合、かつ現在の処理のインデックスを削除するために ArrayIterator::offsetUnset を
  使った場合、 反復処理の位置は次のインデックスに移動します。 反復処理の位置が foreach ループの最後
  であってもインデックスは移動するため、 <return>foreach</return> ループの内部で ArrayIterator::offsetUnset を使う
  と、 複数のインデックスがスキップされるかもしれません。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$key</strong>  削除したいオフセット。

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

<comment>See Also:</comment>
   * ArrayIterator::offsetGet
   * ArrayIterator::offsetSet


id: ArrayIterator::rewind
type: function
doc:
<comment>Description:</comment>
  配列を最初に巻き戻す
  
  イテレータを最初に巻き戻します。

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


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

<comment>Param:</comment>
  <info>int</info>  <strong>$offset</strong>  移動する位置。

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


id: ArrayIterator::serialize
type: function
doc:
<comment>Description:</comment>
  シリアライズする
  
  シリアライズします。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>string</info>  シリアライズした <class>ArrayIterator</class> を返します。

<comment>See Also:</comment>
   * ArrayIterator::unserialize


id: ArrayIterator::setFlags
type: function
doc:
<comment>Description:</comment>
  振る舞いのフラグを設定する
  
  振る舞いのフラグを設定します。

<comment>Param:</comment>
  <info>int</info>  <strong>$flags</strong>  新しい ArrayIterator の振る舞い。 以下のいずれかの値のビットマスクか、名前付き定数を
               設定します。 将来のバージョンとの互換性を保証するため、 名前付き定数を使うことを強く
               推奨します。
               
               利用可能なフラグは以下のとおりです。 これらのフラグの実際の意味は、 定義済みの定数 で
               説明しています。 ArrayIterator の振る舞いを表すフラグ値定数
               1ArrayIterator::STD_PROP_LIST2ArrayIterator::ARRAY_AS_PROPS

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

<comment>See Also:</comment>
   * ArrayIterator::getFlags


id: ArrayIterator::uasort
type: function
doc:
<comment>Description:</comment>
  ユーザー定義の比較関数を使ってソートを行い、インデックスとの関連を管理する
  
  この関数は、ユーザー定義の比較関数を使って 関連している値とインデックスの関係を管理する方法で、要
  素をソートします。
  
  比較結果が等しくなる二つの要素があった場合、それらの並び順は保持されます。PHP 8.0.0 より前のバー
  ジョンでは、ソートした配列におけるそれらの並び順は不定でした。

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

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

<comment>See Also:</comment>
   * ArrayIterator::asort
   * ArrayIterator::ksort
   * ArrayIterator::natcasesort
   * ArrayIterator::natsort
   * ArrayIterator::uksort
   * <strong>uasort()</strong>


id: ArrayIterator::uksort
type: function
doc:
<comment>Description:</comment>
  ユーザー定義の比較関数を使い、キーでソートする
  
  ユーザー定義の比較関数を使って、キーでエントリをソートします。
  
  比較結果が等しくなる二つの要素があった場合、それらの並び順は保持されます。PHP 8.0.0 より前のバー
  ジョンでは、ソートした配列におけるそれらの並び順は不定でした。

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

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

<comment>See Also:</comment>
   * ArrayIterator::asort
   * ArrayIterator::ksort
   * ArrayIterator::natcasesort
   * ArrayIterator::natsort
   * ArrayIterator::uksort
   * <strong>uksort()</strong>


id: ArrayIterator::unserialize
type: function
doc:
<comment>Description:</comment>
  アンシリアライズする
  
  アンシリアライズします。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  シリアライズした ArrayIterator オブジェクト。

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

<comment>See Also:</comment>
   * ArrayIterator::serialize


id: ArrayIterator::valid
type: function
doc:
<comment>Description:</comment>
  配列がまだエントリを持っているかどうかチェックする
  
  配列がまだエントリを持っているかどうかチェックします。

<comment>Return:</comment>
  <info>bool</info>  イテレータが有効な場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。


id: ArrayObject::ARRAY_AS_PROPS
type: constant
doc:
<comment>Description:</comment>
  オブジェクトのエントリはプロパティとしてアクセスできます(読み書き可)。 <class>ArrayObject</class> クラスはオブ
  ジェクトにアクセスするのに独自のロジックを使います。よって、動的なプロパティを読み書きしようとして
  も警告やエラーは発生しません。


id: ArrayObject::STD_PROP_LIST
type: constant
doc:
<comment>Description:</comment>
  オブジェクトのプロパティは (<strong>var_dump()</strong>, foreach などで) 配列としてアクセスしたときと同じ機能を持ち
  ます


id: ArrayObject::__construct
type: function
doc:
<comment>Description:</comment>
  新規配列オブジェクトを生成する
  
  新規配列オブジェクトを生成します。

<comment>Param:</comment>
  <info>array|object</info>  <strong>$array</strong>          <strong>$array</strong> には、 配列あるいはオブジェクトを指定することができます。
  <info>int</info>           <strong>$flags</strong>          <class>ArrayObject</class> オブジェクトの振る舞いを制御するフラグ。
                                ArrayObject::setFlags を参照ください。
  <info>string</info>        <strong>$iteratorClass</strong>  <class>ArrayObject</class> オブジェクトの反復処理に使用するクラスを指定します。 こ
                                こで指定するクラスは、 ArrayIterator を実装していなければなりませ
                                ん。

<comment>See Also:</comment>
   * ArrayObject::setflags


id: ArrayObject::append
type: function
doc:
<comment>Description:</comment>
  値を追加する
  
  新しい値を最後の要素として追加します。
  
  このメソッドは、<class>ArrayObject</class> をオブジェクトから作成した場合にはコールできません。 かわりに
  ArrayObject::offsetSet を使用します。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  追加する値。

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

<comment>See Also:</comment>
   * ArrayObject::offsetSet


id: ArrayObject::asort
type: function
doc:
<comment>Description:</comment>
  値でエントリをソートする
  
  エントリを昇順にソートします。 キーとそれに対応する値の関連は保持されたままとなります。
  
  これは主に、連想配列など実際の要素の並びが重要となる場合のソートで使います。

<comment>Param:</comment>
  <info>int</info>  <strong>$flags</strong>  オプションの第二引数 <strong>$flags</strong> によりソートの動作を修正可能です。 使える値は下記の通りで
               す:
               
               ソートタイプのフラグ: <info>SORT_REGULAR</info> - 通常通りに項目を比較します。 詳細は 比較演算子
               で説明されています。<info>SORT_NUMERIC</info> - 数値として項目を比較します。<info>SORT_STRING</info> - 文字列と
               して項目を比較します。<info>SORT_LOCALE_STRING</info> - 現在のロケールに基づいて、文字列として項目
               を比較します。 比較に使うロケールは、<strong>setlocale()</strong> 関数で変更できます。 <info>SORT_NATURAL</info> -
               要素の比較を文字列として行い、  <strong>natsort()</strong> と同様の「自然順」で比較します。
               <info>SORT_FLAG_CASE</info> - <info>SORT_STRING</info> や <info>SORT_NATURAL</info> と (ビットORで) 組み合わせて使い、 文字
               列のソートで大文字小文字を区別しないようにします。
               
               <info>SORT_REGULAR</info> - 通常通りに項目を比較します。 詳細は 比較演算子 で説明されています。
               
               <info>SORT_NUMERIC</info> - 数値として項目を比較します。
               
               <info>SORT_STRING</info> - 文字列として項目を比較します。
               
               <info>SORT_LOCALE_STRING</info> - 現在のロケールに基づいて、文字列として項目を比較します。 比較に
               使うロケールは、<strong>setlocale()</strong> 関数で変更できます。
               
               <info>SORT_NATURAL</info> - 要素の比較を文字列として行い、  <strong>natsort()</strong> と同様の「自然順」で比較しま
               す。
               
               <info>SORT_FLAG_CASE</info> - <info>SORT_STRING</info> や <info>SORT_NATURAL</info> と (ビットORで) 組み合わせて使い、 文字
               列のソートで大文字小文字を区別しないようにします。

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

<comment>See Also:</comment>
   * ArrayObject::ksort
   * ArrayObject::natsort
   * ArrayObject::natcasesort
   * ArrayObject::uasort
   * ArrayObject::uksort
   * <strong>asort()</strong>


id: ArrayObject::count
type: function
doc:
<comment>Description:</comment>
  ArrayObject の public プロパティの数を取得する
  
  <class>ArrayObject</class> の public プロパティの数を取得します。

<comment>Return:</comment>
  <info>int</info>  <class>ArrayObject</class> の public プロパティの数を返します。
       
       <class>ArrayObject</class> を配列から作成した場合は、すべてのプロパティが public となります。


id: ArrayObject::exchangeArray
type: function
doc:
<comment>Description:</comment>
  配列を別の配列と交換する
  
  現在の配列を、別の配列あるいはオブジェクトと交換します。

<comment>Param:</comment>
  <info>array|object</info>  <strong>$array</strong>  現在の配列と交換する配列あるいはオブジェクト。

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


id: ArrayObject::getArrayCopy
type: function
doc:
<comment>Description:</comment>
  ArrayObject のコピーを作成する
  
  <class>ArrayObject</class> を配列にエクスポートします。

<comment>Return:</comment>
  <info>array</info>  配列のコピーを返します。<class>ArrayObject</class> がオブジェクトを参照している場合は、 オブジェクトのプロ
         パティの配列を返します。


id: ArrayObject::getFlags
type: function
doc:
<comment>Description:</comment>
  振る舞いのフラグを取得する
  
  <class>ArrayObject</class> の振る舞いのフラグを取得します。 利用可能なフラグの一覧は、 ArrayObject::setFlags メ
  ソッドを参照ください。

<comment>Return:</comment>
  <info>int</info>  ArrayObject の振る舞いのフラグを返します。

<comment>See Also:</comment>
   * ArrayObject::setFlags


id: ArrayObject::getIterator
type: function
doc:
<comment>Description:</comment>
  ArrayObject インスタンスから新規イテレータを生成する
  
  新しいイテレータを <class>ArrayObject</class> インスタンスから作成します。

<comment>Return:</comment>
  <info>Iterator</info>  <class>ArrayObject</class> からイテレータを返します。


id: ArrayObject::getIteratorClass
type: function
doc:
<comment>Description:</comment>
  ArrayObject のイテレータクラス名を取得する
  
  配列イテレータのクラス名を取得します。これは ArrayObject::getIterator() で使います。

<comment>Return:</comment>
  <info>string</info>  このオブジェクトの反復処理に使うイテレータのクラス名を返します。

<comment>See Also:</comment>
   * ArrayObject::setIteratorClass メソッド


id: ArrayObject::ksort
type: function
doc:
<comment>Description:</comment>
  キーでエントリをソートする
  
  キーでエントリをソートし、キーと値の関係は保持します。 主に連想配列で有用です。
  
  比較結果が等しくなる二つの要素があった場合、それらの並び順は保持されます。PHP 8.0.0 より前のバー
  ジョンでは、ソートした配列におけるそれらの並び順は不定でした。

<comment>Param:</comment>
  <info>int</info>  <strong>$flags</strong>  オプションの第二引数 <strong>$flags</strong> によりソートの動作を修正可能です。 使える値は下記の通りで
               す:
               
               ソートタイプのフラグ: <info>SORT_REGULAR</info> - 通常通りに項目を比較します。 詳細は 比較演算子
               で説明されています。<info>SORT_NUMERIC</info> - 数値として項目を比較します。<info>SORT_STRING</info> - 文字列と
               して項目を比較します。<info>SORT_LOCALE_STRING</info> - 現在のロケールに基づいて、文字列として項目
               を比較します。 比較に使うロケールは、<strong>setlocale()</strong> 関数で変更できます。 <info>SORT_NATURAL</info> -
               要素の比較を文字列として行い、  <strong>natsort()</strong> と同様の「自然順」で比較します。
               <info>SORT_FLAG_CASE</info> - <info>SORT_STRING</info> や <info>SORT_NATURAL</info> と (ビットORで) 組み合わせて使い、 文字
               列のソートで大文字小文字を区別しないようにします。
               
               <info>SORT_REGULAR</info> - 通常通りに項目を比較します。 詳細は 比較演算子 で説明されています。
               
               <info>SORT_NUMERIC</info> - 数値として項目を比較します。
               
               <info>SORT_STRING</info> - 文字列として項目を比較します。
               
               <info>SORT_LOCALE_STRING</info> - 現在のロケールに基づいて、文字列として項目を比較します。 比較に
               使うロケールは、<strong>setlocale()</strong> 関数で変更できます。
               
               <info>SORT_NATURAL</info> - 要素の比較を文字列として行い、  <strong>natsort()</strong> と同様の「自然順」で比較しま
               す。
               
               <info>SORT_FLAG_CASE</info> - <info>SORT_STRING</info> や <info>SORT_NATURAL</info> と (ビットORで) 組み合わせて使い、 文字
               列のソートで大文字小文字を区別しないようにします。

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

<comment>See Also:</comment>
   * ArrayObject::asort
   * ArrayObject::natsort
   * ArrayObject::natcasesort
   * ArrayObject::uasort
   * ArrayObject::uksort
   * <strong>ksort()</strong>


id: ArrayObject::natcasesort
type: function
doc:
<comment>Description:</comment>
  大文字小文字を区別しない "自然順" アルゴリズムでエントリをソートする
  
  このメソッドは、大文字小文字を区別しない ArrayObject::natsort です。
  
  このメソッドは、英数字からなる文字列を人間が並び替えるのと同じようなアルゴリズムでソートし、 キー
  と値の対応は保持します。このようなソートのことを "自然順" と呼びます。
  
  比較結果が等しくなる二つの要素があった場合、それらの並び順は保持されます。PHP 8.0.0 より前のバー
  ジョンでは、ソートした配列におけるそれらの並び順は不定でした。

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

<comment>See Also:</comment>
   * ArrayObject::asort
   * ArrayObject::ksort
   * ArrayObject::natsort
   * ArrayObject::uasort
   * ArrayObject::uksort
   * <strong>natcasesort()</strong>


id: ArrayObject::natsort
type: function
doc:
<comment>Description:</comment>
  "自然順" アルゴリズムでエントリをソートする
  
  このメソッドは、英数字からなる文字列を人間が並び替えるのと同じようなアルゴリズムでソートし、 キー
  と値の対応は保持します。このようなソートのことを "自然順" と呼びます。 このアルゴリズムと、コン
  ピュータの通常の文字列ソートアルゴリズム (ArrayObject::asort で使われているもの) の違いは、以下の
  サンプルを参照ください。
  
  比較結果が等しくなる二つの要素があった場合、それらの並び順は保持されます。PHP 8.0.0 より前のバー
  ジョンでは、ソートした配列におけるそれらの並び順は不定でした。

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

<comment>See Also:</comment>
   * ArrayObject::asort
   * ArrayObject::ksort
   * ArrayObject::natcasesort
   * ArrayObject::uasort
   * ArrayObject::uksort
   * <strong>natsort()</strong>


id: ArrayObject::offsetExists
type: function
doc:
<comment>Description:</comment>
  要求されたインデックスが存在するかどうかを返す

<comment>Param:</comment>
  <info>mixed</info>  <strong>$key</strong>  調べたいインデックス。

<comment>Return:</comment>
  <info>bool</info>  指定したインデックスが存在する場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。


id: ArrayObject::offsetGet
type: function
doc:
<comment>Description:</comment>
  指定したインデックスの値を返す

<comment>Param:</comment>
  <info>mixed</info>  <strong>$key</strong>  値のインデックス。

<comment>Return:</comment>
  <info>mixed</info>  指定したインデックスの値、あるいは <info>null</info> を返します。


id: ArrayObject::offsetSet
type: function
doc:
<comment>Description:</comment>
  指定したインデックスに新しい値をセットする
  
  指定したインデックスに新しい値を設定します。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$key</strong>    設定したいインデックス。
  <info>mixed</info>  <strong>$value</strong>  <strong>$key</strong> の新しい値。

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

<comment>See Also:</comment>
   * ArrayObject::append


id: ArrayObject::offsetUnset
type: function
doc:
<comment>Description:</comment>
  指定したインデックスの値を解除する
  
  指定したインデックスの値を解除します。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$key</strong>  解除したいインデックス。

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


id: ArrayObject::serialize
type: function
doc:
<comment>Description:</comment>
  ArrayObject をシリアライズする
  
  <class>ArrayObject</class> をシリアライズします。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>string</info>  <class>ArrayObject</class> をシリアライズしたものを返します。

<comment>See Also:</comment>
   * ArrayObject::unserialize
   * <strong>serialize()</strong>
   * オブジェクトのシリアライズ


id: ArrayObject::setFlags
type: function
doc:
<comment>Description:</comment>
  処理フラグを設定する
  
  ArrayObject の振る舞いを変更するフラグを設定します。

<comment>Param:</comment>
  <info>int</info>  <strong>$flags</strong>  新たな ArrayObject の振る舞い。 ビットマスクか、定数名で指定します。 将来のバージョン
               との互換性のため、定数名での指定を強く推奨します。
               
               利用可能なフラグの一覧を以下に示します。 これらのフラグの実際の意味については 定義済
               みの定数 を参照ください。 ArrayObject のフラグ値定数
               1ArrayObject::STD_PROP_LIST2ArrayObject::ARRAY_AS_PROPS

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


id: ArrayObject::setIteratorClass
type: function
doc:
<comment>Description:</comment>
  ArrayObject のイテレータクラス名を設定する
  
  配列イテレータのクラス名を設定します。これは ArrayObject::getIterator() で使います。

<comment>Param:</comment>
  <info>string</info>  <strong>$iteratorClass</strong>  このオブジェクトの反復処理に使う配列イテレータのクラス名。

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


id: ArrayObject::uasort
type: function
doc:
<comment>Description:</comment>
  ユーザー定義の比較関数でエントリをソートし、キーとの対応は保持する
  
  この関数はエントリをソートします。キーとそれに対応する値の関連は保持されたままとなります。 ソート
  にはユーザー定義の比較関数を利用します。
  
  これは主に、連想配列など実際の要素の並びが重要となる場合のソートで使います。
  
  比較結果が等しくなる二つの要素があった場合、それらの並び順は保持されます。PHP 8.0.0 より前のバー
  ジョンでは、ソートした配列におけるそれらの並び順は不定でした。

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

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

<comment>See Also:</comment>
   * ArrayObject::asort
   * ArrayObject::ksort
   * ArrayObject::natsort
   * ArrayObject::natcasesort
   * ArrayObject::uksort
   * <strong>uasort()</strong>


id: ArrayObject::uksort
type: function
doc:
<comment>Description:</comment>
  ユーザー定義の比較関数を使って、キーでエントリをソートする
  
  この関数は、ユーザー定義の比較関数を使ってキーでエントリをソートします。 キーとそれに対応する値の
  関連は保持されたままとなります。
  
  比較結果が等しくなる二つの要素があった場合、それらの並び順は保持されます。PHP 8.0.0 より前のバー
  ジョンでは、ソートした配列におけるそれらの並び順は不定でした。

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

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

<comment>See Also:</comment>
   * ArrayObject::asort
   * ArrayObject::ksort
   * ArrayObject::natsort
   * ArrayObject::natcasesort
   * ArrayObject::uasort
   * <strong>uksort()</strong>


id: ArrayObject::unserialize
type: function
doc:
<comment>Description:</comment>
  ArrayObject をアンシリアライズする
  
  シリアライズした <class>ArrayObject</class> をアンシリアライズします。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  シリアライズした <class>ArrayObject</class>。

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

<comment>See Also:</comment>
   * ArrayIterator::serialize
   * <strong>unserialize()</strong>
   * オブジェクトのシリアライズ


id: Attribute
type: class
doc:
<comment>Description:</comment>
  アトリビュートを使うと、 コンピューターが解析できる構造化されたメタデータの情報を、 コードの宣言時
  に埋め込むことができます。 つまり、クラス、メソッド、関数、パラメータ、プロパティ、クラス定数にア
  トリビュートを指定することができます。 アトリビュートで定義されたメタデータは、 実行時に リフレク
  ションAPI を使って調べることが出来ます。 よって、アトリビュートは、 コードに直接埋め込むことが出来
  る、 設定のための言語とみなすことができます。


id: Attribute::__construct
type: function
doc:
<comment>Description:</comment>
  新しい Attribute のインスタンスを作成する
  
  新しい <class>Attribute</class> のインスタンスを作成します。

<comment>Param:</comment>
  <info>int</info>  <strong>$flags</strong>  


id: BackedEnum
type: class
doc:
<comment>Description:</comment>
  <class>BackedEnum</class> インターフェイスは、 Backed Enum を定義すると、PHP のエンジンが自動的に適用します。
  ユーザー定義のクラスとして実装してはいけません。 列挙型はメソッドのオーバーライドを禁止していま
  す。 デフォルトの実装は PHP のエンジンから提供されるからです。 このインターフェイスは、型チェック
  のためだけに存在しています。


id: BackedEnum::from
type: function
doc:
<comment>Description:</comment>
  スカラー型の値を列挙型にマップする
  
  from メソッドは 文字列型や整数型の値を、存在する場合に 列挙型の case に変換します。 マッチする
  case が定義されていない場合は、 <class>ValueError</class> がスローされます。

<comment>Param:</comment>
  <info>int|string</info>  <strong>$value</strong>  列挙型の case にマップするスカラー値。

<comment>Return:</comment>
  <info>static</info>  この列挙型の case のインスタンスを返します。

<comment>See Also:</comment>
   * UnitEnum::cases
   * BackedEnum::tryFrom


id: BackedEnum::tryFrom
type: function
doc:
<comment>Description:</comment>
  スカラー型の値を列挙型にマップするか、null を返す
  
  tryfrom メソッドは 文字列型や整数型の値を、存在する場合に 列挙型の case に変換します。 マッチする
  case が定義されていない場合は、<info>null</info> を返します。

<comment>Param:</comment>
  <info>int|string</info>  <strong>$value</strong>  列挙型の case にマップするスカラー値。

<comment>Return:</comment>
  <info>static|null</info>  この列挙型の case のインスタンスを返します。 対応する case が見つからない場合は、<info>null</info>
               を返します。

<comment>See Also:</comment>
   * UnitEnum::cases
   * BackedEnum::from


id: BaseResult::getWarnings
type: function
doc:
<comment>Description:</comment>
  直近の操作の警告を取得する
  
  MySQL サーバーに対する直近の操作によって生成された警告を取得します

<comment>Return:</comment>
  <info>array</info>  直近の操作から生成される Warning オブジェクトの配列を返します。 各々のオブジェクトはエラー
         の 'message', 'level', そして 'code' を定義しています。 エラーが発生していなければ、空の配
         列が返されます。


id: BaseResult::getWarningsCount
type: function
doc:
<comment>Description:</comment>
  直近の操作から発生した警告の数を取得する
  
  直近の操作から発生した警告の数を取得します。 特に、これらの警告は MySQL サーバーから発生します。

<comment>Return:</comment>
  <info>int</info>  直近の操作から発生した警告の数を返します。


id: CAL_DOW_DAYNO
type: constant
doc:
<comment>Description:</comment>
  <strong>jddayofweek()</strong> で、曜日を <info>int</info> で返す。 <return>0</return> は日曜を、<return>6</return> は土曜を意味する。


id: CAL_EASTER_DEFAULT
type: constant
doc:
<comment>Description:</comment>
  <strong>easter_days()</strong> で、1753年より前はユリウス暦に従って、 それ以降はグレゴリオ暦に従って復活祭の日付を
  計算する。


id: CAL_EASTER_ROMAN
type: constant
doc:
<comment>Description:</comment>
  <strong>easter_days()</strong> で、1583年より前はユリウス暦に従って、 それ以降はグレゴリオ暦に従って復活祭の日付を
  計算する。


id: CAL_FRENCH
type: constant
doc:
<comment>Description:</comment>
  <strong>cal_days_in_month()</strong>、 <strong>cal_from_jd()</strong>、<strong>cal_info()</strong> および <strong>cal_to_jd()</strong> で、フランス革命暦を使う。


id: CAL_GREGORIAN
type: constant
doc:
<comment>Description:</comment>
  <strong>cal_days_in_month()</strong>、 <strong>cal_from_jd()</strong>、<strong>cal_info()</strong> および <strong>cal_to_jd()</strong> で、先発グレゴリオ暦を使う。


id: CAL_JEWISH
type: constant
doc:
<comment>Description:</comment>
  <strong>cal_days_in_month()</strong>、 <strong>cal_from_jd()</strong>、<strong>cal_info()</strong> および <strong>cal_to_jd()</strong> で、ユダヤ暦を使う。


id: CAL_JEWISH_ADD_ALAFIM_GERESH
type: constant
doc:
<comment>Description:</comment>
  <strong>jdtojewish()</strong> で、年の桁区切りとして、 ゲレシュ記号（シングルクォートに似た記号）を追加する。


id: CAL_JEWISH_ADD_GERESHAYIM
type: constant
doc:
<comment>Description:</comment>
  <strong>jdtojewish()</strong> で、年と日の最後の文字の前に、 ゲルシャイム記号（ダブルクォートに似た記号）を追加す
  る。


id: CAL_JULIAN
type: constant
doc:
<comment>Description:</comment>
  <strong>cal_days_in_month()</strong>、 <strong>cal_from_jd()</strong>、<strong>cal_info()</strong> および <strong>cal_to_jd()</strong> で、ユリウス暦を使う。


id: CASE_LOWER
type: constant
doc:
<comment>Description:</comment>
  <info>CASE_LOWER</info>は、 <strong>array_change_key_case()</strong>で使用され、 配列のキーを小文字に変換するために使用されま
  す。小文字は、 <strong>array_change_key_case()</strong>のデフォルトのケースで もあります。PHP 8.2.0 以降では、ASCII
  文字のみが変換されます。


id: CASE_UPPER
type: constant
doc:
<comment>Description:</comment>
  <info>CASE_UPPER</info>は、 <strong>array_change_key_case()</strong>で使用され、配列のキー を大文字に変換するために使用されま
  す。 PHP 8.2.0 以降では、ASCII 文字のみが変換されます。


id: CLSCTX_ALL
type: constant
doc:
<comment>Description:</comment>
  すべてのクラスコンテキストを表します。 <info>CLSCTX_INPROC_HANDLER</info> と <info>CLSCTX_SERVER</info> を OR で連結したもの
  です。


id: CLSCTX_INPROC_HANDLER
type: constant
doc:
<comment>Description:</comment>
  このクラスのオブジェクトを管理するコードはプロセス内ハンドラです。 これは DLL で、クライアントプロ
  セスで動きます。 クラスのインスタンスがリモートでアクセスされるときに、 このクラスのクライアント側
  の構造を実装します。


id: CLSCTX_INPROC_SERVER
type: constant
doc:
<comment>Description:</comment>
  このクラスのコードを作成および管理するコードは DLL で、 クラスのコンテキストを指定する呼び出し元の
  関数と同じプロセスで動きます。


id: CLSCTX_SERVER
type: constant
doc:
<comment>Description:</comment>
  プロセス内、ローカル、リモートのすべてのサーバーコードを表します。 <info>CLSCTX_INPROC_SERVER</info>、
  <info>CLSCTX_LOCAL_SERVER</info> および <info>CLSCTX_REMOTE_SERVER</info> を OR で連結したものです。


id: COMPersistHelper
type: class
doc:
<comment>Description:</comment>
  <class>COMPersistHelper</class> クラスは、 php.ini の open_basedir ディレクティブと ストリーム リソース を考慮し
  て COM と PHP の相互運用性を高めます。


id: COMPersistHelper::GetCurFileName
type: function
doc:
<comment>Description:</comment>
  現在のファイル名を取得する
  
  オブジェクトに関連付けられた現在のファイル名を取得します。

<comment>Return:</comment>
  <info>string|false</info>  オブジェクトに関連付けられた現在のファイル名を返します。


id: COMPersistHelper::GetMaxStreamSize
type: function
doc:
<comment>Description:</comment>
  ストリームのサイズの最大値を取得する
  
  オブジェクトを保存するのに必要なストリームのサイズを取得します(バイト単位)。

<comment>Return:</comment>
  <info>int</info>  オブジェクトを保存するのに必要なストリームのサイズを返します(バイト単位)。


id: COMPersistHelper::InitNew
type: function
doc:
<comment>Description:</comment>
  オブジェクトをデフォルトの状態に初期化する
  
  オブジェクトをデフォルトの状態に初期化します

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


id: COMPersistHelper::LoadFromFile
type: function
doc:
<comment>Description:</comment>
  オブジェクトをファイルから読み込む
  
  指定されたファイルを開き、そのファイルの内容でオブジェクトを初期化します。

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  読み込むオブジェクトが保存されたファイル名
  <info>int</info>     <strong>$flags</strong>     ファイルをオープンする際のアクセスモード。 有効な値は STGM enumeration を参照く
                     ださい。 メソッドはこの値を参考程度に扱い、必要に応じてより制限的なパーミッショ
                     ンを追加します。 <strong>$flags</strong> に <return>0</return> を指定すると、 ユーザーがファイルを開くときのデ
                     フォルトのパーミッションを使ってファイルを開きます。

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


id: COMPersistHelper::LoadFromStream
type: function
doc:
<comment>Description:</comment>
  ストリームからオブジェクトを読み込む
  
  以前オブジェクトを保存したストリームの内容でオブジェクトを初期化します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  オブジェクトを読み込むストリームリソース

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


id: COMPersistHelper::SaveToFile
type: function
doc:
<comment>Description:</comment>
  オブジェクトをファイルに保存する
  
  オブジェクトのコピーを指定されたファイルに保存します

<comment>Param:</comment>
  <info>string|null</info>  <strong>$filename</strong>  オブジェクトを保存するファイル名
  <info>bool</info>         <strong>$remember</strong>  <strong>$filename</strong> パラメータを現在作業中のファイルに使うかを指定します。 <info>true</info> を指
                          定すると、 <strong>$filename</strong> は現在作業中のファイルに指定され、 保存された後にダー
                          ティーフラグがクリアされます。 <info>false</info> を指定すると、保存する操作は "ファイ
                          ルに名前を付けて保存" する操作になります。 この場合、現在のファイルは変更
                          されず、オブジェクトのダーティーフラグはクリアされません。

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


id: COMPersistHelper::SaveToStream
type: function
doc:
<comment>Description:</comment>
  オブジェクトをストリームに保存する
  
  オブジェクトを指定されたストリームに保存します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  オブジェクトを保存するストリーム リソース

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


id: COMPersistHelper::__construct
type: function
doc:
<comment>Description:</comment>
  COMPersistHelper オブジェクトを構築する
  
  永続化を助けるオブジェクトを構築します。 これは通常、<strong>$variant</strong> に結びつけて使います。

<comment>Param:</comment>
  <info>variant|null</info>  <strong>$variant</strong>  IDispatch を実装した COM オブジェクト。 <class>COMPersistHelper</class> のあらゆるメソッ
                          ドを呼べるようにするためには、 IPersistFile,  IPersistStream かつ/または
                          IPersistStreamInit をオブジェクトが実装していなければなりません。
                          
                          <strong>$variant</strong> に <info>null</info>を渡す意味があるのは、 COMPersistHelper::LoadFromStream を
                          呼び出してオブジェクトを読み込んだ場合に限ります。


id: CP_MOVE
type: constant
doc:
<comment>Description:</comment>
  <strong>imap_mail_copy()</strong> でコピーを行った後に 現在のメールボックスからメッセージを削除します。


id: CREDITS_ALL
type: constant
doc:
<comment>Description:</comment>
  -1
  
  全てのクレジット、<return>CREDITS_DOCS + CREDITS_GENERAL + CREDITS_GROUP + CREDITS_MODULES +
  CREDITS_FULLPAGE</return> を指定した場合と同じ。 この定数は、適当なタグを有する完全にスタンドアローンの
  HTMLページ を生成します。


id: CREDITS_FULLPAGE
type: constant
doc:
<comment>Description:</comment>
  通常、他のフラグと組み合わせて使用されます。 他のフラグで示される情報を含む完全に独立したHTMLペー
  ジを出力する ことを指定します。


id: CRYPT_BLOWFISH
type: constant
doc:
<comment>Description:</comment>
  Blowfishハッシュが <strong>crypt()</strong> 関数でサポートされているかどうかを示します。 値は常に <return>1</return> です。


id: CRYPT_EXT_DES
type: constant
doc:
<comment>Description:</comment>
  拡張DESベースのハッシュが <strong>crypt()</strong> 関数でサポートされているかどうかを示します。 値は常に <return>1</return> です。


id: CRYPT_MD5
type: constant
doc:
<comment>Description:</comment>
  MD5ハッシュが <strong>crypt()</strong> 関数でサポートされているかどうかを示します。 値は常に <return>1</return> です。


id: CRYPT_SHA256
type: constant
doc:
<comment>Description:</comment>
  SHA-256ハッシュが <strong>crypt()</strong> 関数でサポートされているかどうかを示します。 値は常に <return>1</return> です。


id: CRYPT_SHA512
type: constant
doc:
<comment>Description:</comment>
  SHA-512ハッシュが <strong>crypt()</strong> 関数でサポートされているかどうかを示します。 値は常に <return>1</return> です。


id: CRYPT_STD_DES
type: constant
doc:
<comment>Description:</comment>
  標準のDESベースのハッシュが <strong>crypt()</strong> 関数でサポートされているかどうかを示します。 値は常に <return>1</return> です。


id: CURLFile
type: class
doc:
<comment>Description:</comment>
  <info>CURLOPT_POSTFIELDS</info> でファイルのアップロードをするには、このクラスか、<class>CURLStringFile</class> を使わなければ
  いけません。
  
  <class>CURLFile</class> のインスタンスをアンシリアライズすることはできません。 PHP 7.4.0 以降では、そもそもシリア
  ライズ自体も禁止されています。


id: CURLFile::__construct
type: function
doc:
<comment>Description:</comment>
  CURLFile オブジェクトを作る
  
  オブジェクト指向型
  
  手続き型
  
  <class>CURLFile</class> オブジェクトを作ります。これは、<info>CURLOPT_POSTFIELDS</info> でファイルをアップロードするときに使い
  ます。

<comment>Param:</comment>
  <info>string</info>       <strong>$filename</strong>         アップロードするファイルへのパス。
  <info>string|null</info>  <strong>$mime_type</strong>        ファイルの Mimetype。
  <info>string|null</info>  <strong>$posted_filename</strong>  アップロードデータの中で使うファイルの名前。

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

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


id: CURLFile::getFilename
type: function
doc:
<comment>Description:</comment>
  ファイル名を取得する

<comment>Return:</comment>
  <info>string</info>  ファイル名を返します。


id: CURLFile::getMimeType
type: function
doc:
<comment>Description:</comment>
  MIME タイプを取得する

<comment>Return:</comment>
  <info>string</info>  MIME タイプを返します。


id: CURLFile::getPostFilename
type: function
doc:
<comment>Description:</comment>
  POST 用のファイル名を取得する

<comment>Return:</comment>
  <info>string</info>  POST 用のファイル名を返します。


id: CURLFile::setMimeType
type: function
doc:
<comment>Description:</comment>
  MIME タイプを設定する

<comment>Param:</comment>
  <info>string</info>  <strong>$mime_type</strong>  POST データで用いる MIME タイプ。

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


id: CURLFile::setPostFilename
type: function
doc:
<comment>Description:</comment>
  POST 用のファイル名を設定する

<comment>Param:</comment>
  <info>string</info>  <strong>$posted_filename</strong>  POST データで用いるファイル名。

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


id: CURLINFO_HTTP_CODE
type: constant
doc:
<comment>Description:</comment>
  cURL 7.10.8 で利用可能。 これは、 <info>CURLINFO_RESPONSE_CODE</info> の古いエイリアスです。


id: CURLOPT_DOH_SSL_VERIFYHOST
type: constant
doc:
<comment>Description:</comment>
  DNS over HTTPS の、サーバ側のSSL証明書の name フィールドを、 ホスト名と照らし合わせて検証します。
  PHP 8.2.0 以降 および cURL 7.76.0 以降で使用可能です。


id: CURLOPT_DOH_SSL_VERIFYPEER
type: constant
doc:
<comment>Description:</comment>
  DNS over HTTPS の、サーバ側のSSL証明書が信頼できるかを検証します。 PHP 8.2.0 以降 および cURL
  7.76.0 以降で使用可能です。


id: CURLOPT_DOH_SSL_VERIFYSTATUS
type: constant
doc:
<comment>Description:</comment>
  DNS over HTTPS の、サーバ側のSSL証明書の状態を検証するように cURL に使います。 検証には、
  "Certificate Status Request" TLS extension (OCSP stapling) を使います。 PHP 8.2.0 以降 および cURL
  7.76.0 以降で使用可能です。


id: CURLOPT_DOH_URL
type: constant
doc:
<comment>Description:</comment>
  DNS over HTTPS に対応した URL を指定します。 PHP 8.1.0 以降 および cURL 7.62.0 以降で使用可能で
  す。


id: CURLOPT_ISSUERCERT_BLOB
type: constant
doc:
<comment>Description:</comment>
  発行者の情報が含まれる、SSL証明書。 メモリ上の blob 経由で指定します。 PHP 8.1.0 以降 および cURL
  7.71.0 以降で使用可能です。


id: CURLOPT_MUTE
type: constant
doc:
<comment>Description:</comment>
  cURL 7.15.5 で削除されました。 <info>CURLOPT_RETURNTRANSFER</info> を代わりに使ってください。


id: CURLOPT_PROXY_ISSUERCERT
type: constant
doc:
<comment>Description:</comment>
  HTTPS proxy の発行者の情報が含まれる、SSL証明書。 メモリ上の blob 経由で指定します。 PHP 8.1.0 以
  降 および cURL 7.71.0 以降で使用可能です。


id: CURLOPT_PROXY_SSLCERT_BLOB
type: constant
doc:
<comment>Description:</comment>
  SSL proxy に接続するためのクライアント証明書。 メモリ上の blob 経由で指定します。 PHP 8.1.0 以降
  および cURL 7.71.0 以降で使用可能です。


id: CURLOPT_PROXY_SSLKEY_BLOB
type: constant
doc:
<comment>Description:</comment>
  proxy に接続するための、クライアント証明書の秘密鍵。 メモリ上の blob 経由で指定します。 PHP 8.1.0
  以降 および cURL 7.71.0 以降で使用可能です。


id: CURLOPT_SSLCERT_BLOB
type: constant
doc:
<comment>Description:</comment>
  SSL のクライアント証明書。 メモリ上の blob 経由で指定します。 PHP 8.1.0 以降 および cURL 7.71.0 以
  降で使用可能です。


id: CURLOPT_SSLKEY_BLOB
type: constant
doc:
<comment>Description:</comment>
  SSL のクライアント証明書の秘密鍵。 メモリ上の blob 経由で指定します。 PHP 8.1.0 以降 および cURL
  7.71.0 以降で使用可能です。


id: CURLStringFile
type: class
doc:
<comment>Description:</comment>
  <class>CURLStringFile</class> を使うと、 ファイルのアップロードを変数を使って直接行うことができます。 このクラス
  は <class>CURLFile</class> に似ていますが、ファイル名ではなく、 ファイルの中身を使って動作する点が異なります。
  <info>CURLOPT_POSTFIELDS</info> でファイルのアップロードをするには、このクラスか、<class>CURLFile</class> を使わなければいけま
  せん。


id: CURLStringFile::__construct
type: function
doc:
<comment>Description:</comment>
  CURLStringFile オブジェクトを作る
  
  <class>CURLStringFile</class> オブジェクトを作ります。 これは、<info>CURLOPT_POSTFIELDS</info> でファイルをアップロードすると
  きに使います。

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>      アップロードするデータ。
  <info>string</info>  <strong>$postname</strong>  アップロードするデータの中のファイルの名前。
  <info>string</info>  <strong>$mime</strong>      ファイルの MIME タイプ(デフォルトは <return>application/octet-stream</return>)

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


id: CURL_VERSION_GSSNEGOTIATE
type: constant
doc:
<comment>Description:</comment>
  GSS-API 上で動作する、ネゴシエーション認証をサポートします。 PHP 7.3.0 および cURL 7.10.6 以降で使
  用可能です(7.38.0 以降では推奨されていません)。


id: CURL_VERSION_NTLM_WB
type: constant
doc:
<comment>Description:</comment>
  winbind ヘルパーへNTLM認証を委譲する機能をサポートします。 PHP 7.3.0 および cURL 7.22.0 以降で使用
  可能です。


id: CURL_VERSION_PSL
type: constant
doc:
<comment>Description:</comment>
  Mozilla のPublic Suffix List(PSL) のサポートを有効にします。 Cookie のドメイン検証に使います。 PHP
  7.3.6 および cURL 7.47.0 以降で使用可能です。


id: CURL_VERSION_SSPI
type: constant
doc:
<comment>Description:</comment>
  Windows SSPI のサポートを有効にしてビルドします。 PHP 7.3.0 および cURL 7.13.2 以降で使用可能で
  す。


id: CachingIterator::__construct
type: function
doc:
<comment>Description:</comment>
  新しい CachingIterator オブジェクトを作成する
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>Iterator</info>  <strong>$iterator</strong>  キャッシュしたいイテレータ。
  <info>int</info>       <strong>$flags</strong>     フラグのビットマスク。


id: CachingIterator::__toString
type: function
doc:
<comment>Description:</comment>
  現在の要素の文字列表現を返す
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。
  
  現在の要素の文字列表現を返します。

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


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

<comment>Return:</comment>
  <info>int</info>  イテレータ内の要素の数を返します。


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

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

<comment>See Also:</comment>
   * Iterator::current


id: CachingIterator::getCache
type: function
doc:
<comment>Description:</comment>
  キャッシュの内容を取得する
  
  キャッシュの内容を取得します。
  
  <info>CachingIterator::FULL_CACHE</info> フラグを使う必要があります。

<comment>Return:</comment>
  <info>array</info>  キャッシュの内容を含む配列を返します。


id: CachingIterator::getFlags
type: function
doc:
<comment>Description:</comment>
  使用しているフラグを取得する
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。
  
  CachingIterator インスタンスが使用するフラグのビットマスクを取得します。

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


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

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


id: CachingIterator::key
type: function
doc:
<comment>Description:</comment>
  現在の要素のキーを返す
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。
  
  このメソッドは、現在の要素のキーを返します。

<comment>Return:</comment>
  <info>scalar</info>  


id: CachingIterator::next
type: function
doc:
<comment>Description:</comment>
  イテレータを前方に移動する
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。
  
  イテレータを前方に移動します。

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


id: CachingIterator::offsetExists
type: function
doc:
<comment>Description:</comment>
  The offsetExists purpose
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>  調べたいインデックス。

<comment>Return:</comment>
  <info>bool</info>  そのオフセットがさすエントリが存在する場合に <info>true</info>、そうでない場合に <info>false</info> を返します。


id: CachingIterator::offsetGet
type: function
doc:
<comment>Description:</comment>
  The offsetGet purpose
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>  Description...

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


id: CachingIterator::offsetSet
type: function
doc:
<comment>Description:</comment>
  The offsetSet purpose
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>    設定したい要素のインデックス。
  <info>mixed</info>   <strong>$value</strong>  <strong>$key</strong> の新しい値。

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


id: CachingIterator::offsetUnset
type: function
doc:
<comment>Description:</comment>
  The offsetUnset purpose
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>  設定を解除したい要素のインデックス。

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


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

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


id: CachingIterator::setFlags
type: function
doc:
<comment>Description:</comment>
  The setFlags purpose
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。
  
  CachingIterator オブジェクトのフラグを設定します。

<comment>Param:</comment>
  <info>int</info>  <strong>$flags</strong>  設定したいフラグのビットマスク。

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


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

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


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

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

<comment>See Also:</comment>
   * CallbackFilterIterator の例
   * CallbackFilterIterator::accept


id: CallbackFilterIterator::accept
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>
   * CallbackFilterIterator の例
   * CallbackFilterIterator::__construct


id: Client::getClient
type: function
doc:
<comment>Description:</comment>
  クライアントのセッションを取得する
  
  クライアントと関連付けられたセッションを取得します。

<comment>Return:</comment>
  <info>mysql_xdevapi\Session</info>  セッションオブジェクトを返します。


id: Closure
type: class
doc:
<comment>Description:</comment>
  無名関数 を表すために使うクラスです。
  
  無名関数は、Closure 型のオブジェクトを生成します。 このクラスにはメソッドが用意され、 生成した無名
  関数をさらにコントロールできるようになっています。
  
  ここであげたメソッド以外にも、このクラスには <return>__invoke</return> メソッドが存在します。 これは、マジックメ
  ソッド __invoke() を実装した他のクラスとの一貫性を保つためのものであり、 関数をコールするときにこ
  のメソッドは使われません。


id: Closure::__construct
type: function
doc:
<comment>Description:</comment>
  インスタンス作成を無効化したコンストラクタ
  
  このメソッドは、 <class>Closure</class> クラスのインスタンスを作れないようにするために存在します。 このクラスのオ
  ブジェクトを作るには、 無名関数 のページに書かれている手順を使います。

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


id: Closure::bind
type: function
doc:
<comment>Description:</comment>
  バインドされたオブジェクトとクラスのスコープでクロージャを複製する
    
  
  このメソッドは、staticメソッド版の Closure::bindTo です。 詳細な説明は Closure::bindTo のドキュメ
  ントを参照ください。

<comment>Param:</comment>
  <info>Closure</info>             <strong>$closure</strong>   バインドする無名関数。
  <info>object|null</info>         <strong>$newThis</strong>   指定した無名関数をバインドするオブジェクト。クロージャのバインドを
                                 解除するには <info>null</info> を指定します。
  <info>object|string|null</info>  <strong>$newScope</strong>  クロージャを関連づけるクラススコープ、あるいは 'static' で現在のス
                                 コープを維持します。 オブジェクトを渡した場合は、そのオブジェクトの
                                 型をその代わりに使います。 これは、バインドしたオブジェクトの
                                 protected メソッドや private メソッドのアクセス権を決めます。 この
                                 パラメータに、内部クラスのオブジェクトを渡すことはできません。

<comment>Return:</comment>
  <info>Closure|null</info>  新しい <class>Closure</class> オブジェクトを返します。 失敗した場合は <info>null</info> を返します。

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


id: Closure::bindTo
type: function
doc:
<comment>Description:</comment>
  新しくバインドしたオブジェクトとクラスのスコープで、クロージャを複製する
    
  
  自身と同じ本体とバインド変数を持つ新しい 無名関数 を作って返します。しかし、バインドするオブジェク
  トは変わって新しいクラスのスコープとなります。
  
  “バインドするオブジェクト” によって、<return>$this</return> が関数本体で持つ値が決まり、“クラスのスコープ” は、無名
  関数からどのクラスの private メンバーや protected メンバーにアクセスできるのかが決まります。 すな
  わち、無名関数から見えるメンバーは、 その無名関数が <strong>$newScope</strong> クラスのメソッドであった場合と同じも
  のになります。
  
  static なクロージャは何もオブジェクトをバインドできません (<strong>$newThis</strong> の値は <info>null</info> でなければなりませ
  ん) が、 それでもこの関数を使ってクラスのスコープを変えることができます。
  
  この関数が static でないクロージャに関して保証するのは、 バインドされたインスタンスを持っていれば
  スコープ内にあるということです。 また、その逆も成り立ちます。そのため、static でないクロージャにス
  コープとして <info>null</info> インスタンスを渡すとそれはstaticとなり、staticでなくスコープにもないクロージャに
  <info>null</info> でないインスタンスを渡すと、特定されていない何らかのクラスのスコープに入ります。
  
  単に無名関数を複製したいだけの場合は、 cloning を使うこともできます。

<comment>Param:</comment>
  <info>object|null</info>         <strong>$newThis</strong>   指定した無名関数をバインドするオブジェクト。クロージャのバインドを
                                 解除するには <info>null</info> を指定します。
  <info>object|string|null</info>  <strong>$newScope</strong>  クロージャを関連づけるクラススコープ、あるいは 'static' で現在のス
                                 コープを維持します。 オブジェクトを渡した場合は、そのオブジェクトの
                                 型をその代わりに使います。 これは、バインドしたオブジェクトの
                                 protected メソッドや private メソッドのアクセス権を決めます。 内部
                                 クラス (のオブジェクト) を をパラメータとして渡すことはできません。

<comment>Return:</comment>
  <info>Closure|null</info>  新しい <class>Closure</class> オブジェクトを返します。 失敗した場合に <info>null</info> を返します。

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


id: Closure::call
type: function
doc:
<comment>Description:</comment>
  クロージャを束縛して呼び出す
  
  クロージャを一時的に <strong>$newThis</strong> に束縛し、 指定したパラメータでそれを呼び出します。

<comment>Param:</comment>
  <info>object</info>  <strong>$newThis</strong>  この呼び出しの間だけクロージャを束縛するオブジェクト。
  <info>mixed</info>   <strong>$args</strong>     クロージャに渡すパラメータがある場合は、ここで指定します。

<comment>Return:</comment>
  <info>mixed</info>  クロージャの戻り値を返します。


id: Closure::fromCallable
type: function
doc:
<comment>Description:</comment>
  callable をクロージャに変換する
  
  現在のスコープを用いて、指定された <strong>$callback</strong> から新しい 無名関数 を作って返します。 このメソッド
  は、現在のスコープで <strong>$callback</strong> が呼び出し可能かどうかをチェックし、可能でなければ <class>TypeError </class> をス
  ローします。
  
  PHP 8.1.0 以降では、このメソッドと同等の機能を実現するやり方として、第一級callableを生成する記法
  があります。

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  変換する callable。

<comment>Return:</comment>
  <info>Closure</info>  新しく作られた <class>Closure</class> を返します。 <strong>$callback</strong> が現在のスコープで呼び出し可能でなければ、
           <class>TypeError</class> をスローします。

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


id: Collator::ALTERNATE_HANDLING
type: constant
doc:
<comment>Description:</comment>
  Alternate 属性は、UCA における、いわゆる "可変文字 (variable characters)"、 つまり空白や句読点、記
  号の処理方法を制御するものです。 Alternate を NonIgnorable (N) に設定すると、これらの文字の違いを
  通常の文字の違いと同じように扱います。 Alternate を Shifted (S) に設定すると、これらの文字の違いの
  重要度を低くします。 Shifted は、Strength を Quaternary (第四段階) に指定して使用することが多くな
  ります。 この場合、文字列の比較において空白や句読点そして記号の違いを考慮するのは それ以外の要素
  (文字、アクセント、大文字小文字) がすべて一致する場合のみとなります。 Alternate を Shifted 以外に
  した場合は、 Strength が 3 のときと 4 のときの違いがなくなります。 詳細な情報やサンプルは、 UCA の
  Variable_Weighting を参照ください。 Alternate の値を単なる On や Off にしていない理由は、将来的に
  さらに別の値が追加される可能性があるからです。 UCA のオプション Blanked を表すには、Strength を 3
  そして Alternate を Shifted に設定します。 大半のロケールでは、デフォルトは NonIgnorable です。
  Shifted を選択すると、記号類以外が等しい文字列がたくさんあるときに処理速度が低下します。 強度レベ
  ルを上げない限り、ソートキーの長さには影響を与えません。
  
  使用できる値は次のとおりです。 <info>Collator::NON_IGNORABLE</info>(デフォル
  ト)<info>Collator::SHIFTED</info><info>Collator::DEFAULT_VALUE</info>
  
  ALTERNATE_HANDLING のルール S=3, A=N di Silva
  \< Di Silva \< diSilva \< U.S.A. \< USA  S=3, A=S di Silva = diSilva \< Di Silva \< U.S.A. = USA  S=4, A=S di Silva \< diSilva \< Di Silva \< U.S.A. \< USA
  
   S=3, A=N di Silva
  \< Di Silva \< diSilva \< U.S.A. \< USA  S=3, A=S di Silva = diSilva \< Di Silva \< U.S.A. = USA  S=4, A=S di Silva \< diSilva \< Di Silva \< U.S.A. \< USA


id: Collator::CASE_FIRST
type: constant
doc:
<comment>Description:</comment>
  Case_First 属性は、 文字列のその他の部分に違いがないときに 大文字と小文字のどちらが前にくるかを指
  定するものです。 使用できる値は、 Uppercase_First (U) と Lowercase_First (L)、そして標準の Default
  と Off です。 Off と Lowercase_First は、結果に関していえばほとんど違いはありません。 そのため、普
  通は Lowercase_First を使うことはありません。 Off あるいは Uppercase_First を使用することになりま
  す (X と L の違いを知りたい人は、<return>Collation Customization</return> を調べてください)。 L あるいは U のいずれ
  を指定しても、文字列比較の処理速度には影響を与えません。 しかし、ソートキーの長さには影響を与えま
  す。
  
  使用できる値は次のとおりです。 <info>Collator::OFF</info>(デフォル
  ト)<info>Collator::LOWER_FIRST</info><info>Collator::UPPER_FIRST</info><info>Collator:DEFAULT</info>
  
  CASE_FIRST のルールC=X or C=L "china"
  \< "China" \< "denmark" \< "Denmark"C=U "China" \< "china" \< "Denmark" \< "denmark"
  
  C=X or C=L "china"
  \< "China" \< "denmark" \< "Denmark"C=U "China" \< "china" \< "Denmark" \< "denmark"


id: Collator::CASE_LEVEL
type: constant
doc:
<comment>Description:</comment>
  Case_Level 属性は、アクセントは無視するものの大文字小文字は区別したい場合に使用します。 そんな場合
  は、Strength を Primary にして Case_Level を On とします。 大半のロケールでは、この設定はデフォル
  トで Off となっています。 この属性を On にすると、文字列の比較のパフォーマンスやソートキーに多少影
  響を及ぼします。
  
  使用できる値は次のとおりです。 <info>Collator::OFF</info>(デフォルト)<info>Collator::ON</info><info>Collator::DEFAULT_VALUE</info>
  
  CASE_LEVEL のルールS=1, E=X role = Role = rôleS=1, E=O role = rôle \< Role
  
  S=1, E=X role = Role = rôleS=1, E=O role = rôle \< Role


id: Collator::FRENCH_COLLATION
type: constant
doc:
<comment>Description:</comment>
  文字列の後に続くさまざまなアクセントによる並べ替えを行います。 この属性は、フランス語などの一部の
  ロケールでは自動的に On となります。 通常は、この属性を明示的に設定する必要はありません。 これを
  On にすると文字列の比較の効率が落ちますが、 ソートキーの長さは影響を受けません。 使用できる値は次
  のとおりです。 <info>Collator::ON</info><info>Collator::OFF</info>(デフォルト)<info>Collator::DEFAULT_VALUE</info>
  
  FRENCH_COLLATION のルールF=OFF cote \< coté \< côte \< côté F=ON cote \< côte \< coté \< côté
  
  F=OFF cote \< coté \< côte \< côté F=ON cote \< côte \< coté \< côté


id: Collator::HIRAGANA_QUATERNARY_MODE
type: constant
doc:
<comment>Description:</comment>
  JIS x 4061 との互換性を維持するには、さらなるレベルを追加して ひらがなとカタカナを区別する必要があ
  ります。 標準規格との互換性を要する場合は、この属性を On にして強度を Quaternary にしなければなり
  ません。 これは、ソートキーの長さにも文字列比較のパフォーマンスにも影響を及ぼします。
  
  使用できる値は次のとおりです。 <info>Collator::OFF</info>(デフォルト)<info>Collator::ON</info><info>Collator::DEFAULT_VALUE</info>


id: Collator::NORMALIZATION_MODE
type: constant
doc:
<comment>Description:</comment>
  Normalization 設定は、比較時にテキストを正規化するか否かを指定します。 この設定を off (多くのロ
  ケールにおけるデフォルト設定です) にしても、 一般的な使用法ではほぼ正確に利用できます (詳細は UTN
  #5 を参照ください)。 問題となるのは、アクセント記号が正規の位置以外に登場する場合などです。 この設
  定を On にすると、 どんなテキストが与えられたとしても可能な限り結果を保証するようにします。 この属
  性を On にすると、 文字列比較のパフォーマンスに中程度の影響を及ぼします。 影響の程度は、正規化を要
  する並びの登場頻度に依存します。 ソートキーの長さには、目立った影響は及ぼしません。 入力テキストが
  NFD あるいは NFKD 形式で正規化されている場合は、 このオプションを有効にする必要はありません。
  
  使用できる値は次のとおりです。 <info>Collator::OFF</info>(デフォルト)<info>Collator::ON</info><info>Collator::DEFAULT_VALUE</info>


id: Collator::NUMERIC_COLLATION
type: constant
doc:
<comment>Description:</comment>
  on にすると、数値形式の文字列の各桁を数値として使用した照合キーを生成します。 これにより、'100' の
  ほうが '2' より「後」に並ぶようになります。
  
  使用できる値は次のとおりです。 <info>Collator::OFF</info>(デフォルト)<info>Collator::ON</info><info>Collator::DEFAULT_VALUE</info>


id: Collator::STRENGTH
type: constant
doc:
<comment>Description:</comment>
  ICU Collation Service は、多くの比較レベルをサポートしています ("レベル" という名前ですが、"強度"
  と呼ばれることもあります)。 これらのカテゴリを用いることで、ICU は、 各地域の規約にあわせた適切な
  文字列の並べ替えを正確に行えるようになります。 また、各段階を選択して採用することで、 テキスト内の
  文字列検索をさまざまな条件で行うことも可能になります。 詳細な情報は <strong>collator_set_strength()</strong> を参照
  ください。
  
  使用できる値は次のとおりです。 <info>Collator::PRIMARY</info><info>Collator::SECONDARY</info><info>Collator::TERTIARY</info>(デフォル
  ト)<info>Collator::QUATERNARY</info><info>Collator::IDENTICAL</info><info>Collator::DEFAULT_VALUE</info>


id: Collator::__construct
type: function
doc:
<comment>Description:</comment>
  collator を作成する
  
  新しい <class>Collator</class> のインスタンスを作成します。

<comment>Param:</comment>
  <info>string</info>  <strong>$locale</strong>  照合規則を使用するロケール。特殊な場合として、 空文字列を渡した場合はデフォルトの
                   ロケールの照合規則を使用します。 <return>"root"</return> を渡した場合は、 UCA の規則を使用します。
                   
                   <strong>$locale</strong> 属性は、 各国・各地域のユーザーの期待通りに並べ替えやマッチングを行うため
                   に もっとも重要な属性です。デフォルトの UCA の並び順で正しく ("正しく" とは、その
                   言語を使用する人の期待通りにということです) 処理できるのは、オランダ語やポルトガ
                   ル語などの一部の言語だけです。 それ以外の場合は、UCA にロケールを指定して その言
                   語に応じた適切な照合を行えるようにする必要があります。 従って、各ロケールにあわせ
                   て正しく設定した collator を使用する必要があります。 ロケールを選択すると、その他
                   の属性の値も適切な物に自動設定されます。 従って、その他の属性については明示的に設
                   定する必要はほとんどありません。 選択したロケールによっては、文字列比較のパフォー
                   マンスやソートキーの長さに違いが出ることがあります。

<comment>See Also:</comment>
   * <strong>Collator::create()</strong>
   * <strong>collator_create()</strong>


id: Collator::asort
type: function
doc:
<comment>Description:</comment>
  インデックスの情報を保持しつつ配列を並べ替える
  
  オブジェクト指向型
  
  手続き型
  
  この関数は、インデックスと値の関係を保持したうえで配列を並べ替えます。 これを主に使用するのは、実
  際の並び順も重要となる連想配列です。 配列の要素には、現在のロケールの規則にしたがった並び順が適用
  されます。
  
  PHP の標準関数 <strong>asort()</strong> と同等です。

<comment>Param:</comment>
  <info>Collator</info>  <strong>$object</strong>  <class>Collator</class> オブジェクト。
  <info>array</info>     <strong>$array</strong>   並べ替えたい文字列の配列。
  <info>int</info>       <strong>$flags</strong>   オプションの並べ替え方式。以下のいずれか。 <info>Collator::SORT_REGULAR</info> - 通常の比較
                     (型を変更しない) <info>Collator::SORT_NUMERIC</info> - 数値としての比較
                     <info>Collator::SORT_STRING</info> - 文字列としての比較
                     
                     <info>Collator::SORT_REGULAR</info> - 通常の比較 (型を変更しない)
                     
                     <info>Collator::SORT_NUMERIC</info> - 数値としての比較
                     
                     <info>Collator::SORT_STRING</info> - 文字列としての比較
                     
                     デフォルトの <strong>$flags</strong> の値は <info>Collator::SORT_REGULAR</info> です。 <strong>$flags</strong> に無効な値が指
                     定された場合も、このデフォルトを使用します。

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

<comment>See Also:</comment>
   * <class>Collator</class> の定数
   * <strong>collator_sort()</strong>
   * <strong>collator_sort_with_sort_keys()</strong>


id: Collator::compare
type: function
doc:
<comment>Description:</comment>
  ふたつの Unicode 文字列を比較する
  
  オブジェクト指向型
  
  手続き型
  
  ふたつの Unicode 文字列を、比較規則にもとづいて比較します。

<comment>Param:</comment>
  <info>Collator</info>  <strong>$object</strong>   <class>Collator</class> オブジェクト。
  <info>string</info>    <strong>$string1</strong>  最初の文字列。
  <info>string</info>    <strong>$string2</strong>  2 番目の文字列。

<comment>Return:</comment>
  <info>int|false</info>  比較結果を返します。
             
             <strong>$string1</strong> が <strong>$string2</strong> より 大きい ときは 1 <strong>$string1</strong> と <strong>$string2</strong> が 等しい ときは 0
             <strong>$string1</strong> が <strong>$string2</strong> より 小さい ときは -1  エラー時には <info>false</info> を返します。
             
             <strong>$string1</strong> が <strong>$string2</strong> より 大きい ときは 1
             
             <strong>$string1</strong> と <strong>$string2</strong> が 等しい ときは 0
             
             <strong>$string1</strong> が <strong>$string2</strong> より 小さい ときは -1
             
             この関数は論理値
             <info>false</info> を返す可能性がありますが、<info>false</info> として評価される値を返す可能性もあります。
             詳細については 論理値の
             セクションを参照してください。この関数の返り値を調べるには
             ===演算子 を
             使用してください。

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


id: Collator::create
type: function
doc:
<comment>Description:</comment>
  collator を作成する
  
  オブジェクト指向型
  
  手続き型
  
  すでに指定しているオプションを用いて文字列を比較します。

<comment>Param:</comment>
  <info>string</info>  <strong>$locale</strong>  照合規則を使用するロケール。特殊な場合として、 空文字列を渡した場合はデフォルトの
                   ロケールの照合規則を使用します。 <return>"root"</return> を渡した場合は UCA の規則を使用します。

<comment>Return:</comment>
  <info>Collator|null</info>  新しい <class>Collator</class> オブジェクトのインスタンス、 あるいはエラー時に <info>null</info> を返します。

<comment>See Also:</comment>
   * <strong>Collator::__construct()</strong>


id: Collator::getAttribute
type: function
doc:
<comment>Description:</comment>
  照合用の属性の値を取得する
  
  オブジェクト指向型
  
  手続き型
  
  collator の属性の値を取得します。

<comment>Param:</comment>
  <info>Collator</info>  <strong>$object</strong>     <class>Collator</class> オブジェクト。
  <info>int</info>       <strong>$attribute</strong>  値を取得したい属性。

<comment>Return:</comment>
  <info>int|false</info>  属性の値を返します。 失敗した場合に <info>false</info> を返します

<comment>See Also:</comment>
   * <class>Collator</class> の定数
   * <strong>collator_set_attribute()</strong>
   * <strong>collator_get_strength()</strong>


id: Collator::getErrorCode
type: function
doc:
<comment>Description:</comment>
  collator の直近のエラーコードを取得する
  
  オブジェクト指向型
  
  手続き型
  
  

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

<comment>Return:</comment>
  <info>int|false</info>  直近の Collator API 関数コールが返したエラーコードを返します。 失敗した場合に <info>false</info> を
             返します

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


id: Collator::getErrorMessage
type: function
doc:
<comment>Description:</comment>
  collator の直近のエラーコードのテキストを取得する
  
  オブジェクト指向型
  
  手続き型
  
  直近のエラーのメッセージを取得します。

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

<comment>Return:</comment>
  <info>string|false</info>  直近の Collator API 関数コールで発生したエラーの説明を返します。 失敗した場合に
                <info>false</info> を返します

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


id: Collator::getLocale
type: function
doc:
<comment>Description:</comment>
  collator のロケール名を取得する
  
  オブジェクト指向型
  
  手続き型
  
  collector のロケール名を取得します。

<comment>Param:</comment>
  <info>Collator</info>  <strong>$object</strong>  <class>Collator</class> オブジェクト。
  <info>int</info>       <strong>$type</strong>    妥当なロケールか実際のロケール (それぞれ <info>Locale::VALID_LOCALE</info> および
                     <info>Locale::ACTUAL_LOCALE</info>)。

<comment>Return:</comment>
  <info>string|false</info>  照合データの実際のロケール名を返します。ルールベースの collator のインスタンスの場合
                やエラーが発生した場合は <info>false</info> を返します。

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


id: Collator::getSortKey
type: function
doc:
<comment>Description:</comment>
  文字列のソート用のキーを取得する
  
  オブジェクト指向型
  
  手続き型
  
  文字列用の照合キーを返します。 照合キーは文字列のかわりに直接比較することができますが、 これは実装
  依存の動きであり、ICUライブラリのバージョンによって変わる可能性があります。 一般的に、ソート用の
  キーはデータベース内部か、関数呼び出しコストがとても高い状況でのみ役に立ちます。

<comment>Param:</comment>
  <info>Collator</info>  <strong>$object</strong>  <class>Collator</class> オブジェクト。
  <info>string</info>    <strong>$string</strong>  キーの生成元となる文字列。

<comment>Return:</comment>
  <info>string|false</info>  文字列の照合キーを返します。失敗した場合に <info>false</info> を返します
                
                この関数は論理値
                <info>false</info> を返す可能性がありますが、<info>false</info> として評価される値を返す可能性もあります。
                詳細については 論理値の
                セクションを参照してください。この関数の返り値を調べるには
                ===演算子 を
                使用してください。

<comment>See Also:</comment>
   * <strong>collator_sort()</strong>
   * <strong>collator_sort_with_sort_keys()</strong>


id: Collator::getStrength
type: function
doc:
<comment>Description:</comment>
  現在の照合強度を取得する
  
  オブジェクト指向型
  
  手続き型
  
  

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

<comment>Return:</comment>
  <info>int</info>  現在の照合強度を返します。 失敗した場合に <info>false</info> を返します

<comment>See Also:</comment>
   * <class>Collator</class> の定数
   * <strong>collator_set_strength()</strong>
   * <strong>collator_get_attribute()</strong>


id: Collator::setAttribute
type: function
doc:
<comment>Description:</comment>
  照合用の属性を設定する
  
  オブジェクト指向型
  
  手続き型
  
  

<comment>Param:</comment>
  <info>Collator</info>  <strong>$object</strong>     <class>Collator</class> オブジェクト。
  <info>int</info>       <strong>$attribute</strong>  属性。
  <info>int</info>       <strong>$value</strong>      属性の値。

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

<comment>See Also:</comment>
   * <class>Collator</class> の定数
   * <strong>collator_get_attribute()</strong>
   * <strong>collator_set_strength()</strong>


id: Collator::setStrength
type: function
doc:
<comment>Description:</comment>
  照合強度を設定する
  
  オブジェクト指向型
  
  手続き型
  
  ICU Collation Service は、多くの比較レベルをサポートしています ("レベル" という名前ですが、"強度"
  と呼ばれることもあります)。 これらのカテゴリを用いることで、ICU は、 各地域の規約にあわせた適切な
  文字列の並べ替えを正確に行えるようになります。 また、各段階を選択して採用することで、 テキスト内の
  文字列検索をさまざまな条件で行うことも可能になります。
  
  第一段階 (Primary Level): 一般に、これは元となる文字自体の違いを表すものとして使用します (たとえば
  "a"
  \< "b")。これが、いちばん強い違いとなります。 たとえば、辞書などではこれを用いてセクション分けしています。 これは、 <return>level
  1</return> の強度 (level1 strength) ともいいます。 第二段階 (Secondary Level): 文字のアクセント記号を、第二
  段階の違いとします (たとえば "as"
  \< "às" \< "at")。 言語によっては、その他の文字の違いも第二段階の違いとみなすこともあります。 文字列のどこかで第一段階の違いがある場合、第二段階の違いは無視します。 これは、 <return>level
  2</return> の強度 (level2 strength) ともいいます。  注意: 言語によっては (たとえばデンマーク語)、 アクセン
  ト記号は元の文字とは別の文字とみなすものもあります。 しかし、たいていの言語では、 アクセントなしの
  文字とアクセントつきの文字の違いは第二段階とみなします。  第三段階 (Tertiary Level): 大文字と小文
  字の違いを区別するのが第二段階の違いです (たとえば "ao"
  \< "Ao" \< "aò")。 さらに、ある文字とその派生形の違い (たとえば "A" と " ") も第三段階と判断します。さらに、カナの大文字と小文字の違い (訳注: たとえば "や" と "ゃ") もこの段階になります。 文字列のどこかで第一段階や第二段階の違いがある場合、 第三段階の違いは無視します。 これは、<return>level
  3</return> の強度 (level3 strength) ともいいます。 第四段階 (Quaternary Level): レベル 1 から 3 までで句読
  点を無視する場合 ("句読点の無視" を参照)、 追加の段階を使用して句読点つきの単語となしの単語を区別
  します (たとえば "ab"
  \< "a-b" \< "aB")。 どこかに第一段階や第二段階、第三段階の違いがある場合、 第四段階の違いは無視します。 これは、 <return>level
  4</return> の強度 (level4 strength) ともいいます。 第四段階を使用するのは、句読点を無視する必要がある場合や
  日本語のテキスト ("ひらがなの処理" を参照) を処理する場合のみです。 一致段階 (Identical Level): そ
  れ以外のすべてのレベルで等しかった場合に、最後の手段として一致段階を用います。 この段階で比較する
  のは、NFD 形式の文字列の Unicode コードポイントです。 レベル 1 から 4 までで違いがない場合にのみ比
  較します。 たとえば、ヘブライ語の朗誦記号 (cantillation mark) は、 この段階でしか識別できません。
  この段階は慎重に使うようにしましょう。 ふたつの文字列でコードポイントの値のみが違うなどということ
  は、 めったにないことだからです。 この段階を使用すると、(ソートキーの強度が上がるのと同時に) イン
  クリメンタルな比較やソートキーの生成のパフォーマンスが劇的に低下します。 これは、<return>level 5</return> の強度
  (level5 strength) ともいいます。
  
  第一段階 (Primary Level): 一般に、これは元となる文字自体の違いを表すものとして使用します (たとえば
  "a"
  \< "b")。これが、いちばん強い違いとなります。 たとえば、辞書などではこれを用いてセクション分けしています。 これは、 <return>level
  1</return> の強度 (level1 strength) ともいいます。
  
  第二段階 (Secondary Level): 文字のアクセント記号を、第二段階の違いとします (たとえば "as"
  \< "às" \< "at")。 言語によっては、その他の文字の違いも第二段階の違いとみなすこともあります。 文字列のどこかで第一段階の違いがある場合、第二段階の違いは無視します。 これは、 <return>level
  2</return> の強度 (level2 strength) ともいいます。  注意: 言語によっては (たとえばデンマーク語)、 アクセン
  ト記号は元の文字とは別の文字とみなすものもあります。 しかし、たいていの言語では、 アクセントなしの
  文字とアクセントつきの文字の違いは第二段階とみなします。
  
  注意: 言語によっては (たとえばデンマーク語)、 アクセント記号は元の文字とは別の文字とみなすものもあ
  ります。 しかし、たいていの言語では、 アクセントなしの文字とアクセントつきの文字の違いは第二段階と
  みなします。
  
  第三段階 (Tertiary Level): 大文字と小文字の違いを区別するのが第二段階の違いです (たとえば "ao"
  \< "Ao" \< "aò")。 さらに、ある文字とその派生形の違い (たとえば "A" と " ") も第三段階と判断します。さらに、カナの大文字と小文字の違い (訳注: たとえば "や" と "ゃ") もこの段階になります。 文字列のどこかで第一段階や第二段階の違いがある場合、 第三段階の違いは無視します。 これは、<return>level
  3</return> の強度 (level3 strength) ともいいます。
  
  第四段階 (Quaternary Level): レベル 1 から 3 までで句読点を無視する場合 ("句読点の無視" を参照)、
  追加の段階を使用して句読点つきの単語となしの単語を区別します (たとえば "ab"
  \< "a-b" \< "aB")。 どこかに第一段階や第二段階、第三段階の違いがある場合、 第四段階の違いは無視します。 これは、 <return>level
  4</return> の強度 (level4 strength) ともいいます。 第四段階を使用するのは、句読点を無視する必要がある場合や
  日本語のテキスト ("ひらがなの処理" を参照) を処理する場合のみです。
  
  一致段階 (Identical Level): それ以外のすべてのレベルで等しかった場合に、最後の手段として一致段階を
  用います。 この段階で比較するのは、NFD 形式の文字列の Unicode コードポイントです。 レベル 1 から 4
  までで違いがない場合にのみ比較します。 たとえば、ヘブライ語の朗誦記号 (cantillation mark) は、 こ
  の段階でしか識別できません。 この段階は慎重に使うようにしましょう。 ふたつの文字列でコードポイント
  の値のみが違うなどということは、 めったにないことだからです。 この段階を使用すると、(ソートキーの
  強度が上がるのと同時に) インクリメンタルな比較やソートキーの生成のパフォーマンスが劇的に低下しま
  す。 これは、<return>level 5</return> の強度 (level5 strength) ともいいます。
  
  たとえば、「アクセントを無視」したり「アクセントと大文字小文字の区別を無視」 したりしてテキストの
  検索を行いたいこともあります。 ほぼすべての文字は第三段階までで識別できるので、 大半のロケールでは
  デフォルトの指定は第三段階となっています。 しかし、場合によっては第四段階の強度を使用することにな
  ります。 これを用いると、空白や句読点や記号など、 他の強度では無視されるような違いも識別するように
  なります。 文字の識別を非常に厳密に行うには、一致段階の強度を使用します (たとえばこれを使用する
  と、Mathematical Bold Small A と Mathematical Italic Small A が別の文字とみなされます)。 しかし、
  第三段階を超える強度を使用すると、 ソートキーが非常に長くなってしまい、 また同じ文字列に対する比較
  処理も非常に遅くなってしまいます。

<comment>Param:</comment>
  <info>Collator</info>  <strong>$object</strong>    <class>Collator</class> オブジェクト。
  <info>int</info>       <strong>$strength</strong>  設定する強度。
                       
                       以下のいずれかです。
                       <info>Collator::PRIMARY</info><info>Collator::SECONDARY</info><info>Collator::TERTIARY</info><info>Collator::QUATERNARY</info><info>Collator::IDENTICAL</info><info>Collator::DEFAULT_STRENGTH</info>
                       
                       <info>Collator::PRIMARY</info>
                       
                       <info>Collator::SECONDARY</info>
                       
                       <info>Collator::TERTIARY</info>
                       
                       <info>Collator::QUATERNARY</info>
                       
                       <info>Collator::IDENTICAL</info>
                       
                       <info>Collator::DEFAULT_STRENGTH</info>

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

<comment>See Also:</comment>
   * <class>Collator</class> の定数
   * <strong>collator_get_strength()</strong>


id: Collator::sort
type: function
doc:
<comment>Description:</comment>
  指定した collator で配列を並べ替える
  
  オブジェクト指向型
  
  手続き型
  
  この関数は、現在のロケールの規則にもとづいて配列を並べ替えます。
  
  PHP の標準関数 <strong>sort()</strong> と同等です。

<comment>Param:</comment>
  <info>Collator</info>  <strong>$object</strong>  <class>Collator</class> オブジェクト。
  <info>array</info>     <strong>$array</strong>   並べ替えたい文字列の配列。
  <info>int</info>       <strong>$flags</strong>   オプションの並べ替え方式。以下のいずれか。
                     
                     <info>Collator::SORT_REGULAR</info> - 通常の比較 (型を変更しない) <info>Collator::SORT_NUMERIC</info> -
                     数値としての比較 <info>Collator::SORT_STRING</info> - 文字列としての比較  デフォルトの並べ替
                     え方式は <info>Collator::SORT_REGULAR</info> です。<strong>$flags</strong> に無効な値を指定した場合もこの方式
                     を使います。
                     
                     <info>Collator::SORT_REGULAR</info> - 通常の比較 (型を変更しない)
                     
                     <info>Collator::SORT_NUMERIC</info> - 数値としての比較
                     
                     <info>Collator::SORT_STRING</info> - 文字列としての比較

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

<comment>See Also:</comment>
   * <class>Collator</class> の定数
   * <strong>collator_asort()</strong>
   * <strong>collator_sort_with_sort_keys()</strong>


id: Collator::sortWithSortKeys
type: function
doc:
<comment>Description:</comment>
  指定した collator とキーで配列を並べ替える
  
  オブジェクト指向型
  
  手続き型
  
  <strong>collator_sort()</strong> と似ていますが、 ucol_getSortKey() が作成した ICU ソートキーを用いることで 大きな
  配列をより高速に処理できます。

<comment>Param:</comment>
  <info>Collator</info>  <strong>$object</strong>  <class>Collator</class> オブジェクト。
  <info>array</info>     <strong>$array</strong>   並べ替えたい文字列の配列。

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

<comment>See Also:</comment>
   * <class>Collator</class> の定数
   * <strong>collator_sort()</strong>
   * <strong>collator_asort()</strong>


id: Collectable::isGarbage
type: function
doc:
<comment>Description:</comment>
  Determine whether an object has been marked as garbage
  
  Can be called in Pool::collect to determine if this object is garbage.

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

<comment>See Also:</comment>
   * Pool::collect


id: Collection::add
type: function
doc:
<comment>Description:</comment>
  コレクションにドキュメントを追加する
  
  与えられたドキュメントをドキュメントに追加します。 このメソッドでは、複数のバリエーションがサポー
  トされています。 オプションは以下です:
  
  JSON 文字列として単一のドキュメントを追加する
  
  単一のドキュメントを次のようにして配列で追加する: <return>[ 'field' =&gt; 'value', 'field2' =&gt; 'value2'
  ... ]</return>
  
  上記２つの組み合わせ。 そして、複数のドキュメントが同じ操作で追加できます。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$document</strong>  ひとつまたは複数のドキュメント。そして、ドキュメントは JSON または フィールドと
                    それに関連した値を格納した配列 として表現できます。 空の配列は受け入れられませ
                    ん。
                    
                    MySQL サーバーは、ドキュメントごとに(推奨)自動的にユニークな <return>_id</return> 値を生成しま
                    す。 しかし、これは手動でも追加できます。 この値はユニークでなければなりません。
                    ユニークでない場合、操作は失敗します。

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionAdd</info>  CollectionAdd オブジェクトを返します。 影響を受けた行を調べたり、操作
                               によって生成された警告の数を得たり、 挿入されたドキュメントのために生
                               成された _id のリストを得るための Result オブジェクトを得るためには、
                               execute() を使ってください。


id: Collection::addOrReplaceOne
type: function
doc:
<comment>Description:</comment>
  コレクションのドキュメントを追加または置換する
  
  新しいドキュメントを追加するか、既に存在する場合は置換します。
  
  このメソッドには、複数のシナリオがあります:
  
  _id やユニークキーの値がコレクション中のどのドキュメントとも衝突する場合、 ドキュメントは追加され
  ます。
  
  id がどのドキュメントともマッチしないものの、 ひとつ以上のユニークキーの値がコレクション中のドキュ
  メントと衝突する場合、 エラーが発生します。
  
  id が既に存在するドキュメントにマッチし、ユニークキーもコレクションに定義されていない場合、 ドキュ
  メントは置き換えられます。
  
  id が既に存在するドキュメントにマッチする場合、 または 同じドキュメントの全てのユニークキーのうち
  いずれかとマッチし id がコレクション中のドキュメントと衝突しない場合、 そのドキュメントは置き換え
  られます。
  
  id が既に存在するドキュメントとマッチし、 ひとつ以上のユニークキーが異なるドキュメントにマッチする
  場合、 エラーが発生します。

<comment>Param:</comment>
  <info>string</info>  <strong>$id</strong>   フィルタid。この id または、 ユニークインデックスを持つ他のフィールドが既にコレク
                ションに存在している場合は、 それにマッチするドキュメントを更新します。
                
                デフォルトでは、この id はレコードが追加された時に自動的に MySQL サーバーが生成しま
                す。 そして、フィールド名 '_id' で参照されます。
  <info>string</info>  <strong>$doc</strong>  追加または置き換えるドキュメント。JSON文字列です。

<comment>Return:</comment>
  <info>mysql_xdevapi\Result</info>  Result オブジェクト


id: Collection::count
type: function
doc:
<comment>Description:</comment>
  ドキュメントの数を取得する
  
  この機能は、 MySQL サーバーの現在のスキーマとコレクションに対して <return>SELECT COUNT(*)</return> SQL を発行する操
  作に似ています。 言い換えると、コレクションに存在するドキュメントの数を数えます。

<comment>Return:</comment>
  <info>int</info>  コレクションに存在するドキュメントの数


id: Collection::createIndex
type: function
doc:
<comment>Description:</comment>
  コレクションにインデックスを作成
  
  コレクションにインデックスを作成します。
  
  指定された名前と同じインデックスが既に存在していた場合、 もしくはインデックスの定義が正しくなかっ
  た場合は、 例外がスローされます。

<comment>Param:</comment>
  <info>string</info>  <strong>$index_name</strong>       作成するインデックスの名前。 この名前は、 <return>CREATE INDEX</return> SQLクエリが受け入
                            れられる、 正しいものでなければなりません。
  <info>string</info>  <strong>$index_desc_json</strong>  作成するインデックスの定義。 IndexField オブジェクトの配列を含み、
                            個々のオブジェクトはインデックスに含まれる単一のドキュメントを記述しま
                            す。 そして、オプションで、インデックスのタイプを示すオプションの文字列
                            を含めます。 インデックスのタイプは、INDEX(デフォルト) または SPATIAL で
                            す。
                            
                            IndexField の記述は、以下のフィールドを含みます:
                            
                            field: 文字列。インデックスされるドキュメンメンバまたはフィールドの完全
                            なパス
                            
                            type: 文字列。フィールドにマップされる、サポートされたSQLカラムの型のう
                            ちひとつ。 数値型のために、オプションで UNSIGNED を後ろに続けることがで
                            きます。 テキスト型のために、インデックスのために考慮する長さを追加でき
                            ます。
                            
                            required: bool。 (オプション) フィールドがドキュメントで必須である場合、
                            trueを指定します。 デフォルトは <info>false</info> です。 <return>GEOJSON</return> では例外的に、デ
                            フォルトが <info>true</info> です。
                            
                            options: integer, (オプション) <return>GEOJSON</return> データをデコードする時に使う特別
                            なのオプションフラグ
                            
                            srid: integer, (オプション) <return>GEOJSON</return> データをデコードする時に使う srid の
                            値
                            
                            IndexDefinition や IndexField に、上記で説明していないフィールドを含める
                            とエラーになります。

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


id: Collection::dropIndex
type: function
doc:
<comment>Description:</comment>
  コレクションのインデックスを削除
  
  コレクションのインデックスを削除します。
  
  この操作は、インデックスが存在しなくてもエラーは発生しません。 しかし、その場合には <info>false</info> を返しま
  す。

<comment>Param:</comment>
  <info>string</info>  <strong>$index_name</strong>  削除するコレクションのインデックスの名前

<comment>Return:</comment>
  <info>bool</info>  DROP INDEX の操作が成功したら <info>true</info> そうでなければ <info>false</info>


id: Collection::existsInDatabase
type: function
doc:
<comment>Description:</comment>
  コレクションがデータベースに存在するかをチェックする
  
  コレクションオブジェクトが、データベース(スキーマ)内のコレクションを参照しているかを調べます。

<comment>Return:</comment>
  <info>bool</info>  コレクションがデータベースに存在していれば <info>true</info> を返します。 そうでなければ、<info>false</info> を返しま
        す。
        
        2つのカラム (doc と _id) で定義されたテーブルは、 コレクションと見なされます。 MySQL 8.0.21
        以降では、doc, _id, _json_schema の3つのカラムで構成されたテーブルが コレクションと見なされ
        ます。 これに対してカラムを追加すると、 existsInDatabase() はコレクションとは見なさなくなり
        ます。


id: Collection::find
type: function
doc:
<comment>Description:</comment>
  ドキュメントを検索する
  
  ドキュメントが属するデータベースコレクションやドキュメントの集合を検索します。 見つかったドキュメ
  ントは CollectionFind オブジェクトとして返され、 後の変更や結果の取得に使えます。

<comment>Param:</comment>
  <info>string</info>  <strong>$search_condition</strong>  オプションですが、通常はドキュメントのサブセットの結果を限定するために
                             条件を定義します。
                             
                             複数の要素が条件を構成できますし、条件の文法はパラメータのバインドもサ
                             ポートしています。 検索条件として使える式は MySQL で有効なものでなけれ
                             ばなりません。 検索条件が与えられない(フィールドが空)場合、find('true')
                             が与えられたと見做されます。

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionFind</info>  操作を検証したり、見つかったドキュメントを取得するための
                                CollectionFind オブジェクト


id: Collection::getName
type: function
doc:
<comment>Description:</comment>
  コレクションの名前を得る
  
  コレクションの名前を取得します。

<comment>Return:</comment>
  <info>string</info>  コレクションの名前を文字列で返します。


id: Collection::getOne
type: function
doc:
<comment>Description:</comment>
  ドキュメントをひとつ取得
  
  コレクションから、ドキュメントをひとつ取得します。
  
  これは、以下のコードのショートカットです: Collection.find("_id = :id").bind("id",
  id).execute().fetchOne();

<comment>Param:</comment>
  <info>string</info>  <strong>$id</strong>  コレクションのドキュメントの _id

<comment>Return:</comment>
  <info>Document</info>  コレクションオブジェクトを返します。 _id にドキュメントがマッチしなければ、<info>null</info> を返しま
            す。


id: Collection::getSchema
type: function
doc:
<comment>Description:</comment>
  スキーマオブジェクトを得る
  
  コレクションを含むスキーマオブジェクトを取得します。

<comment>Return:</comment>
  <info>Schema Object</info>  成功すれば、スキーマオブジェクト。 与えられたコレクションのスキーマオブジェクトを取
                 得できなければ、<info>null</info> を返します。


id: Collection::getSession
type: function
doc:
<comment>Description:</comment>
  セッションオブジェクトを取得
  
  コレクションオブジェクトから、新しいセッションオブジェクトを取得します。

<comment>Return:</comment>
  <info>Session</info>  セッションオブジェクトを返します。


id: Collection::modify
type: function
doc:
<comment>Description:</comment>
  コレクションのドキュメントを変更する
  
  特定の検索条件にマッチするドキュメントのコレクションを変更します。 複数の操作が可能であり、パラ
  メータのバインドもサポートされています。

<comment>Param:</comment>
  <info>string</info>  <strong>$search_condition</strong>  変更するドキュメントに マッチさせるために使う、有効な MySQL の式でなけ
                             ればなりません。 この式は、<info>true</info> と評価される単純なものであれば可能で
                             す。 <info>true</info> と評価された全てのドキュメントにマッチします。 もしくは、関数
                             と指揮を次のように使うこともできます。 'CAST(_id AS SIGNED) &gt;= 10',
                             'age MOD 2 = 0 OR age MOD 3 = 0', '_id IN ["2","5","7","10"]'.

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionModify</info>  操作が実行されない場合、この関数は追加の変更操作を追加できる
                                  Modify オブジェクトを返します。
                                  
                                  変更操作が実行された場合、返されるオブジェクトには操作結果が含まれ
                                  ます。


id: Collection::remove
type: function
doc:
<comment>Description:</comment>
  コレクションを削除する
  
  特定の検索条件に合致するドキュメントのコレクションを削除します。 複数の操作が可能で、パラメータの
  バインドもサポートしています。

<comment>Param:</comment>
  <info>string</info>  <strong>$search_condition</strong>  削除するドキュメントに マッチさせるために使う、有効な MySQL の式でなけ
                             ればなりません。 この式は、<info>true</info> と評価される単純なものであれば可能で
                             す。 <info>true</info> と評価された全てのドキュメントにマッチします。 もしくは、関数
                             と指揮を次のように使うこともできます。 'CAST(_id AS SIGNED) &gt;= 10',
                             'age MOD 2 = 0 OR age MOD 3 = 0',  '_id IN ["2","5","7","10"]'.

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionRemove</info>  操作が実行されない場合、この関数は追加の削除操作を追加できる
                                  Remove オブジェクトを返します。
                                  
                                  削除操作が実行された場合、返されるオブジェクトには操作結果が含まれ
                                  ます。


id: Collection::removeOne
type: function
doc:
<comment>Description:</comment>
  コレクションからドキュメントをひとつ削除する
  
  指定したIDに対応するドキュメントをコレクションから削除する。 これは、Collection.remove("_id =
  :id").bind("id", id).execute() のショートカットです。

<comment>Param:</comment>
  <info>string</info>  <strong>$id</strong>  削除するコレクションのドキュメントのID。 これは、通常はレコードが追加されたときに
               MySQLサーバー が生成した _id の値です。

<comment>Return:</comment>
  <info>mysql_xdevapi\Result</info>  影響を受けたアイテムの数、 または、操作によって発生した警告の数 を問い合わせ
                        るために使われる Resultオブジェクト。


id: Collection::replaceOne
type: function
doc:
<comment>Description:</comment>
  コレクションのドキュメントをひとつ置き換える
  
  ID で特定されたドキュメントが存在すれば、それを更新(置き換え)します。

<comment>Param:</comment>
  <info>string</info>  <strong>$id</strong>   置き換え、または更新するドキュメントのID。 通常、これは レコードを追加した時に MySQL
                サーバーが生成した _id です。
  <info>string</info>  <strong>$doc</strong>  id パラメータにマッチするドキュメントを更新したり 置換したりするためのコレクションの
                ドキュメント
                
                このドキュメントは、ドキュメントオブジェクトか、 新しいドキュメントを表現する 有効な
                JSON 文字列のどちらかです。

<comment>Return:</comment>
  <info>mysql_xdevapi\Result</info>  影響を受けた行を調べたり、 操作によって生成された警告の数を得ることができる
                        Result オブジェクトを返します。


id: CollectionAdd::__construct
type: function
doc:
<comment>Description:</comment>
  CollectionAdd のコンストラクタ
  
  コレクションにドキュメントを追加するために使います。 ;コレクションオブジェクトから呼び出されます。


id: CollectionAdd::execute
type: function
doc:
<comment>Description:</comment>
  ステートメントを実行する
  
  CRUD操作のリクエストを MySQL サーバーに送信するために execute メソッドは必須です。

<comment>Return:</comment>
  <info>mysql_xdevapi\Result</info>  影響を受けた行数のような、操作の状態を確認するのに使われる Result オブジェク
                        トを返します。


id: CollectionFind::__construct
type: function
doc:
<comment>Description:</comment>
  CollectionFind のコンストラクタ
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。


id: CollectionFind::bind
type: function
doc:
<comment>Description:</comment>
  クエリのプレースホルダーに値をバインドする
  
  ユーザーは、検索条件または検索の操作の中で、 プレースホルダーに対してパラメータをバインドできま
  す。 プレースホルダーは :NAME というフォーマットで、 ':'  は NAME の前に常に存在しなければいけない
  共通のプレフィックスです。NAME はプレースホルダーの実際の名前です。 この関数は、複数のエンティティ
  を検索時に置き換える必要がある場合、 プレースホルダーのリストを受け付けます。

<comment>Param:</comment>
  <info>array</info>  <strong>$placeholder_values</strong>  検索条件の中で置き換える値。 複数の値が許されていますし、配列の中で
                              "PLACEHOLDER_NAME =&gt; PLACEHOLDER_VALUE" のような形で渡すこともでき
                              ます。

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionFind</info>  CollectionFind オブジェクト。 または、Result オブジェクトを取得する
                                ために execute() とチェインさせることもできます。


id: CollectionFind::execute
type: function
doc:
<comment>Description:</comment>
  ステートメントを実行する
  
  find 操作を実行します。 この操作は、メソッドのチェインも許可しています。

<comment>Return:</comment>
  <info>mysql_xdevapi\DocResult</info>  結果を取得したり、操作の状態を問い合わせるための <class>mysql_xdevapi\DocResult</class>
                           オブジェクトを返します。


id: CollectionFind::fields
type: function
doc:
<comment>Description:</comment>
  ドキュメントのフィールドのフィルタを設定する
  
  クエリによって返されるカラムを設定します。 設定されない場合は、全てのカラムが使われます。

<comment>Param:</comment>
  <info>string</info>  <strong>$projection</strong>  単一の文字列か、文字列の配列。 検索条件にマッチするドキュメント単位で返される
                       カラムを識別します。

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionFind</info>  後の処理に使える CollectionFind を返します。


id: CollectionFind::groupBy
type: function
doc:
<comment>Description:</comment>
  グループ化の条件を設定する
  
  この関数は、結果セットをひとつまたはそれ以上のカラムによってグループ化するのに使えます。 <return>COUNT</return>,
  <return>MAX</return>,<return>MIN</return>,<return>SUM</return> のような集約関数とともによく使います。

<comment>Param:</comment>
  <info>string</info>  <strong>$sort_expr</strong>  グループ化の操作のために使われるカラム。 これは文字列か、カラムをあらわす文字
                      列の配列のうちのどちらかです。

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionFind</info>  その後の処理に使える CollectionFind オブジェクトを返します。


id: CollectionFind::having
type: function
doc:
<comment>Description:</comment>
  集約関数の条件を設定する
  
  この関数は、展開するドキュメントを選択するために、 'field' 操作の後で使えます。

<comment>Param:</comment>
  <info>string</info>  <strong>$sort_expr</strong>  有効な SQL の式でなければなりません。  集約関数を使うこともできます。

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionFind</info>  後の操作で使える CollectionFind オブジェクトを返します。


id: CollectionFind::limit
type: function
doc:
<comment>Description:</comment>
  返されるドキュメントの数を限定する
  
  返されるドキュメントの最大数を設定します。

<comment>Param:</comment>
  <info>int</info>  <strong>$rows</strong>  ドキュメントの最大数

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionFind</info>  追加の操作に使える CollectionFind オブジェクトを返します。 DocResult
                                オブジェクトを返す execute() メソッドとチェインできます。


id: CollectionFind::lockExclusive
type: function
doc:
<comment>Description:</comment>
  Execute operation with EXCLUSIVE LOCK
  
  ドキュメントを排他ロックします。 ドキュメントがロックされている間、 他のトランザクションはドキュメ
  ントを更新できませんし、 SELECT ... LOCK IN SHARE MODE を使ったり、 トランザクション分離レベルにあ
  るデータの読み取りができません。 一貫性のある読み取りはあらゆるロックを無視します。
  
  並列処理の問題を避けるために、この機能は mysql_xdevapi\Collection::modify コマンドから直接使うのが
  有用です。 基本的に、このコマンドは行ロックを通してアクセスを直列化します。

<comment>Param:</comment>
  <info>int</info>  <strong>$lock_waiting_option</strong>  オプションで指定できる、ロック待ちのオプション。 デフォルトは
                             <info>MYSQLX_LOCK_DEFAULT</info> です。 有効な値は以下のとおりです:
                             
                             <info>MYSQLX_LOCK_DEFAULT</info>
                             
                             <info>MYSQLX_LOCK_NOWAIT</info>
                             
                             <info>MYSQLX_LOCK_SKIP_LOCKED</info>

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionFind</info>  後の処理に使える CollectionFind オブジェクトを返します。


id: CollectionFind::lockShared
type: function
doc:
<comment>Description:</comment>
  SHARED LOCK 付きで操作を実行する
  
  ロックを共有モードで使う複数のトランザクション間で、ドキュメントを共有することができます。
  
  他のセッションからは行を読めますが、あなたがトランザクションをコミットするまで変更できません。
  
  もしまだコミットしていない別のトランザクションから、これらの行が変更された場合、クエリは、トランザ
  クションが終了し、最新の値を使うまで待たされます。

<comment>Param:</comment>
  <info>int</info>  <strong>$lock_waiting_option</strong>  オプションで指定できる、ロック待ちのオプション。 デフォルトは
                             <info>MYSQLX_LOCK_DEFAULT</info> です。 有効な値は以下のとおりです:
                             
                             <info>MYSQLX_LOCK_DEFAULT</info>
                             
                             <info>MYSQLX_LOCK_NOWAIT</info>
                             
                             <info>MYSQLX_LOCK_SKIP_LOCKED</info>

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionFind</info>  後の処理で使える CollectionFind オブジェクトを返します。


id: CollectionFind::offset
type: function
doc:
<comment>Description:</comment>
  返される要素の数から、与えられた数をスキップする
  
  find 操作によって返されたはずの要素から、指定された数の要素(offset) をスキップします。 limit() メ
  ソッドと一緒に使います。
  
  結果セットのサイズとよりも大きな offset を指定すると、空の結果セットが返されます。

<comment>Param:</comment>
  <info>int</info>  <strong>$position</strong>  limit() 操作のためにスキップする要素の数

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionFind</info>  追加の操作に使える CollectionFind オブジェクトを返します。


id: CollectionFind::sort
type: function
doc:
<comment>Description:</comment>
  ソート条件を設定する
  
  sort_expr 引数で、選択されるフィールドによって結果をソートします。 可能なソート順は ASC(昇順) また
  は DESC (降順) です。 この操作は SQL の 'ORDER BY' と同等で、同じルールに従います。

<comment>Param:</comment>
  <info>string</info>  <strong>$sort_expr</strong>  ひとつ以上のソート式が指定できます。 評価は左から右に行われ、個別の式はコンマ
                      で区切ります。

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionFind</info>  コマンドを実行したり、追加の操作を追加できる CollectionFind オブジェ
                                クトを返します。


id: CollectionModify::__construct
type: function
doc:
<comment>Description:</comment>
  CollectionModify のコンストラクタ
  
  コレクションを変更 (更新) します。 そして、mysql_xdevapi\Collection::modify によってインスタンス化
  されます。


id: CollectionModify::arrayAppend
type: function
doc:
<comment>Description:</comment>
  配列のフィールドに要素を追加する
  
  ドキュメントのフィールドに要素を追加します。 フィールドの複数の要素は配列として表現されます。
  arrayInsert() と異なり、arrayAppend() は常に新しい要素を配列の最後に追加します。 一方で、
  arrayInsert() は挿入する位置を指定できます。

<comment>Param:</comment>
  <info>string</info>  <strong>$collection_field</strong>       新しい要素を挿入するフィールドの識別子
  <info>string</info>  <strong>$expression_or_literal</strong>  ドキュメントフィールドの配列の最後に挿入する新しい要素

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionModify</info>  コマンドを実行したり、追加の操作を追加できる CollectionModify オブ
                                  ジェクトを返します。


id: CollectionModify::arrayInsert
type: function
doc:
<comment>Description:</comment>
  配列のフィールドに要素を挿入する
  
  ドキュメントのフィールドに要素を追加します。 フィールドの複数の要素は配列として表現されます。
  mysql_xdevapi\CollectionModify::arrayAppend と異なり、このメソッドは新しい要素をどこに挿入するかを
  指定できます。常に新しい要素を配列の最後に追加します。 一方で、
  mysql_xdevapi\CollectionModify::arrayAppend は新しい要素を常に配列の最後に追加します。

<comment>Param:</comment>
  <info>string</info>  <strong>$collection_field</strong>       新しい要素が挿入される配列中の要素を識別します。 このパラメータの
                                  フォーマットは <return>FIELD_NAME[ INDEX ]</return> です。 FIELD_NAME は、要素を削
                                  除するドキュメントフィールドの名前で、 INDEX はフィールド内の要素
                                  のインデックスです。
                                  
                                  INDEX フィールドは0から始まります。 よって、配列の最初のインデック
                                  スは0です。
  <info>string</info>  <strong>$expression_or_literal</strong>  FIELD_NAME[ INDEX ] の後に挿入する新しい要素

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionModify</info>  コマンドを実行したり、追加の操作を追加できる CollectionModify オブ
                                  ジェクトを返します。


id: CollectionModify::bind
type: function
doc:
<comment>Description:</comment>
  クエリのプレースホルダーに値をバインドする
  
  変更操作の検索条件のプレースホルダーにパラメータをバインドします。
  
  プレースホルダーは :NAME というフォーマットで、 ':'  は NAME の前に常に存在しなければいけない 共通
  のプレフィックスです。NAME はプレースホルダーの実際の名前です。 この関数は、複数のエンティティを変
  更操作の検索時に置き換える必要がある場合、 プレースホルダーのリストを受け付けます。

<comment>Param:</comment>
  <info>array</info>  <strong>$placeholder_values</strong>  検索条件の中で置き換える値。 複数の値が許されていますし、配列の中で
                              "PLACEHOLDER_NAME =&gt; PLACEHOLDER_VALUE" のような形で渡すこともでき
                              ます。

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionModify</info>  コマンドを実行したり、追加の操作を追加するために使う
                                  CollectionModify オブジェクトを返します。


id: CollectionModify::execute
type: function
doc:
<comment>Description:</comment>
  変更の操作を実行する
  
  MySQLサーバーに CRUD 操作のリクエストを送信するために、 execute メソッドは必須です。

<comment>Return:</comment>
  <info>mysql_xdevapi\Result</info>  影響を受けた行数のような、操作の状態を確認するために使われる Result オブジェ
                        クトを返します。


id: CollectionModify::limit
type: function
doc:
<comment>Description:</comment>
  変更されるドキュメントの数を限定する
  
  この操作によって、変更されるドキュメントの数を限定します。 オプションで、skip() と組み合わせること
  で、オフセット値を定義します。

<comment>Param:</comment>
  <info>int</info>  <strong>$rows</strong>  変更するドキュメントの最大数

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionModify</info>  CollectionModify オブジェクトを返します。


id: CollectionModify::patch
type: function
doc:
<comment>Description:</comment>
  document にパッチを当てる
  
  Patch オブジェクトを取得し、ひとつ以上のドキュメントに適用し、 そして複数のドキュメントのプロパ
  ティを更新します。

<comment>Param:</comment>
  <info>string</info>  <strong>$document</strong>  マッチするドキュメントに適用するプロパティを持ったドキュメント

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionModify</info>  CollectionModify オブジェクトを返します。


id: CollectionModify::replace
type: function
doc:
<comment>Description:</comment>
  ドキュメントのフィールドを置き換える
  
  与えられたフィールドの値を、新しいもので置き換え(更新し)ます。

<comment>Param:</comment>
  <info>string</info>  <strong>$collection_field</strong>       設定するアイテムのドキュメントパス
  <info>string</info>  <strong>$expression_or_literal</strong>  指定された属性に設定する値

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionModify</info>  CollectionModify オブジェクトを返します。


id: CollectionModify::set
type: function
doc:
<comment>Description:</comment>
  ドキュメントの属性を設定する
  
  コレクション中のドキュメントの属性を設定、または更新します。

<comment>Param:</comment>
  <info>string</info>  <strong>$collection_field</strong>       設定するアイテムのドキュメントパス(名前)
  <info>string</info>  <strong>$expression_or_literal</strong>  設定する値

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionModify</info>  CollectionModify オブジェクトを返します。


id: CollectionModify::skip
type: function
doc:
<comment>Description:</comment>
  要素をスキップする
  
  スキップしなければ find によって返される最初の N 要素をスキップします。 スキップされる要素の数が、
  結果セットのサイズより大きかった場合は、 空の結果セットが返されます。

<comment>Param:</comment>
  <info>int</info>  <strong>$position</strong>  スキップする要素数

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionModify</info>  後の操作で使われる CollectionModify オブジェクト。


id: CollectionModify::sort
type: function
doc:
<comment>Description:</comment>
  ソート条件を設定する
  
  sort_expr 引数によって指定されたフィールドによって、結果セットをソートします。 可能なソート順は
  ASC(昇順) または DESC (降順) です。 この操作は SQL の 'ORDER BY' と同等で、同じルールに従います。

<comment>Param:</comment>
  <info>string</info>  <strong>$sort_expr</strong>  ひとつ以上のソート式が指定できます。 評価は左から右に行われ、個別の式はコンマ
                      で区切ります。

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionModify</info>  以後の操作に使える CollectionModify オブジェクトを返します。


id: CollectionModify::unset
type: function
doc:
<comment>Description:</comment>
  ドキュメントのフィールドの値を削除する
  
  コレクションのドキュメントから、属性を削除します。

<comment>Param:</comment>
  <info>array</info>  <strong>$fields</strong>  コレクションのドキュメントから削除する属性

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionModify</info>  その後の処理で使える CollectionModify オブジェクトを返します。


id: CollectionRemove::__construct
type: function
doc:
<comment>Description:</comment>
  CollectionRemove のコンストラクタ
  
  コレクションのドキュメントを削除します。 mysql_xdevapi\Collection::remove によってインスタンス化さ
  れます。


id: CollectionRemove::bind
type: function
doc:
<comment>Description:</comment>
  プレースホルダーに値をバインドする
  
  削除操作の検索条件のプレースホルダーにパラメータをバインドします。
  
  プレースホルダーは :NAME というフォーマットで、 ':'  は NAME の前に常に存在しなければいけない 共通
  のプレフィックスです。NAME はプレースホルダーの実際の名前です。 この関数は、複数のエンティティを削
  除操作の検索時に置き換える必要がある場合、 プレースホルダーのリストを受け付けます。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>array</info>  <strong>$placeholder_values</strong>  検索条件の中で置き換える値。 複数の値が許されていますし、配列の中で
                              "PLACEHOLDER_NAME =&gt; PLACEHOLDER_VALUE" のような形で渡すこともでき
                              ます。

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionRemove</info>  コマンドを実行したり、追加の操作を追加するために使う
                                  CollectionRemove オブジェクトを返します。


id: CollectionRemove::execute
type: function
doc:
<comment>Description:</comment>
  削除操作を実行する
  
  クライアントがサーバーに CRUD 操作のリクエストを送信させるためには、 execute 関数を呼び出す必要が
  あります。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>mysql_xdevapi\Result</info>  Result オブジェクトを返します。


id: CollectionRemove::limit
type: function
doc:
<comment>Description:</comment>
  削除するドキュメントの数を限定する
  
  削除するドキュメントの数の最大値を設定します。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>int</info>  <strong>$rows</strong>  削除するドキュメントの数の最大値

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionRemove</info>  コマンドを実行したり、追加の操作を追加するのに使える
                                  CollectionRemove オブジェクト。


id: CollectionRemove::sort
type: function
doc:
<comment>Description:</comment>
  ソート条件を設定する
  
  sort_expr 引数で、選択されるフィールドによって結果をソートします。 可能なソート順は ASC(昇順) また
  は DESC (降順) です。 この操作は SQL の 'ORDER BY' と同等で、同じルールに従います。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>string</info>  <strong>$sort_expr</strong>  ひとつ以上のソート式が指定できます。 評価は左から右に行われ、個別の式はコンマ
                      で区切ります。

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionRemove</info>  コマンドを実行したり、追加の操作を追加できる CollectionRemove オブ
                                  ジェクトを返します。


id: ColumnResult::__construct
type: function
doc:
<comment>Description:</comment>
  ColumnResult のコンストラクタ
  
  キャラクタセットのような、カラムのメタデータを取得します。 mysql_xdevapi\RowResult::getColumns に
  よってインスタンス化されます。


id: ColumnResult::getCharacterSetName
type: function
doc:
<comment>Description:</comment>
  キャラクタセットを取得する
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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


id: ColumnResult::getCollationName
type: function
doc:
<comment>Description:</comment>
  照合順序名を取得する
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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


id: ColumnResult::getColumnLabel
type: function
doc:
<comment>Description:</comment>
  カラムのラベルを取得する
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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


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

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


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

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


id: ColumnResult::getLength
type: function
doc:
<comment>Description:</comment>
  カラムのフィールドの長さを取得する
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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


id: ColumnResult::getSchemaName
type: function
doc:
<comment>Description:</comment>
  スキーマ名を取得する
  
  カラムが保存されているスキーマの名前を取得します。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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


id: ColumnResult::getTableLabel
type: function
doc:
<comment>Description:</comment>
  テーブルラベルを取得する
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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


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

<comment>Return:</comment>
  <info>string</info>  オブジェクトに対応するテーブル名を返します。


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

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


id: ColumnResult::isNumberSigned
type: function
doc:
<comment>Description:</comment>
  符号付きの型かどうかを調べる
  
  テーブルのカラム情報を取得します。 mysql_xdevapi\RowResult::getColumns によってインスタンス化され
  ます。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>int</info>  与えられたカラムが符号付きの場合、<info>true</info> を返します。


id: ColumnResult::isPadded
type: function
doc:
<comment>Description:</comment>
  パディングされているかを調べる
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>int</info>  与えられたカラムがパディングされていれば <info>true</info> を返します。


id: CommonMark\CQL
type: class
doc:
<comment>Description:</comment>
  CommonMark Query Language is a DSL for describing how to travel through a CommonMark Node tree
  implemented as a parser and compiler for a small set of instructions, and a virtual machine for
  executing those instructions.
  
  In it's most simplistic form, a CQL query combines the following paths and <return>/</return> to describe how to
  travel through a tree: firstChildlastChildpreviousnextparent For example, <return>/firstChild/lastChild</return>
  would travel to the last child node of the first child node.
  
  CQL can be instructed to loop, for example through the children of, or siblings to a particular
  node, by using the path <return>children</return>, or <return>siblings</return>. For example, <return>/firstChild/children</return> will travel to
  all the children of the first child node.
  
  CQL can be instructed how to travel by using a subquery like <return>[/firstChild]</return>. For example,
  <return>/firstChild/children[/firstChild]</return> will travel to the first child node of all the children of the
  first child node.
  
  While looping, CQL can be instructed to constrict the travelled path to nodes of particular type.
  For example <return>/children(BlockQuote)</return> will travel to the children of a node where the type is
  <return>BlockQuote</return>. The following types are recognized (case insensitively):
  BlockQuoteListItemCodeBlockHtmlBlockCustomBlockParagraphHeadingThematicBreakTextSoftBreakLineBreakCodeHtmlInlineCustomInlineEmphasisStrongLinkImage
  Types may be used as a union, for example <return>/children(BlockQuote|List)</return> will travel to the children
  of a node where the type is <return>BlockQuote</return> or <return>List</return>. Types, or unions of types, may be also negated.
  For example <return>/children(~BlockQuote)</return> will travel to the children of a node where the type is not
  <return>BlockQuote</return>, and <return>/children(~BlockQuote|Paragraph)</return> will travel to the children of a node where the
  type is not <return>BlockQuote</return> or <return>Paragraph</return>
  
  CQL can be instructed to create a loop to travel to a node of a particular type, at a particular
  path. For example, <return>/firstChild(BlockQuote)</return> will travel to the first child node where the type is
  <return>BlockQuote</return>. Note that like other loops for <return>children</return> and <return>siblings</return>, this kind of path can only be
  followed by a subquery.
  
  While CQL has been implemented as part of the PHP CommonMark extension, it stands separately from
  PHP and does not use PHP's virtual machine or internal representation of values.


id: CommonMark\CQL::__construct
type: function
doc:
<comment>Description:</comment>
  CQL Construction

<comment>Param:</comment>
  <info>string</info>  <strong>$query</strong>  a CQL string


id: CommonMark\CQL::__invoke
type: function
doc:
<comment>Description:</comment>
  CQL Execution
  
  Shall invoke the current CQL function on the given <strong>$root</strong>, executing the given <strong>$handler</strong> on entry to
  a <info>CommonMark\Node</info>

<comment>Param:</comment>
  <info>CommonMark\Node</info>  <strong>$root</strong>     the root node of a tree
  <info>callable</info>         <strong>$handler</strong>  should have the prototype:
                             <info>bool</info><info>null</info></info>handler<info>CommonMark\Node</info><strong>$root</strong><info>CommonMark\Node</info><strong>$entering</strong> Should
                             <strong>$handler</strong> fail to return (void), or return <info>null</info>, CQL will continue
                             executingShould the handler return a truthy value, CQL will continue
                             executing.Should the handler return a falsy value, CQL will stop
                             executing


id: CommonMark\Interfaces\IVisitable::accept
type: function
doc:
<comment>Description:</comment>
  Visitation

<comment>Param:</comment>
  <info>CommonMark\Interfaces\IVisitor</info>  <strong>$visitor</strong>  An object implementing <class>CommonMark\Interfaces\IVisitor</class>

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

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


id: CommonMark\Interfaces\IVisitor::enter
type: function
doc:
<comment>Description:</comment>
  Visitation

<comment>Param:</comment>
  <info>IVisitable</info>  <strong>$visitable</strong>  The current <class>CommonMark\Interfaces\IVisitable</class> being entered

<comment>Return:</comment>
  <info>int|IVisitable|null</info>  Returning CommonMark\Interfaces\IVisitor::Done will cause the backing
                       iterator to exit.
                       
                       Returning CommonMark\Interfaces\IVisitor::Enter will reset the backing
                       iterator at entering the current <class>IVisitable</class>
                       
                       Returning CommonMark\Interfaces\IVisitor::Leave will reset the backing
                       iterator at exiting the current <class>IVisitable</class>
                       
                       Returning an <class>IVisitable</class> will reset the backing iterator at entering the given
                       <class>IVisitable</class>
                       
                       Returning nothing will allow the backing iterator to continue

<comment>See Also:</comment>
   * 


id: CommonMark\Interfaces\IVisitor::leave
type: function
doc:
<comment>Description:</comment>
  Visitation

<comment>Param:</comment>
  <info>IVisitable</info>  <strong>$visitable</strong>  The current <class>CommonMark\Interfaces\IVisitable</class> being exited

<comment>Return:</comment>
  <info>int|IVisitable|null</info>  Returning CommonMark\Interfaces\IVisitor::Done will cause the backing
                       iterator to exit.
                       
                       Returning CommonMark\Interfaces\IVisitor::Enter will reset the backing
                       iterator at entering the current <class>IVisitable</class>
                       
                       Returning CommonMark\Interfaces\IVisitor::Leave will reset the backing
                       iterator at exiting the current <class>IVisitable</class>
                       
                       Returning an <class>IVisitable</class> will reset the backing iterator at exiting the given
                       <class>IVisitable</class>
                       
                       Returning nothing will allow the backing iterator to continue

<comment>See Also:</comment>
   * 


id: CommonMark\Node
type: class
doc:
<comment>Description:</comment>
  Represents an Abstract Node, this final abstract is not for direct use by the programmer.


id: CommonMark\Node::appendChild
type: function
doc:
<comment>Description:</comment>
  AST Manipulation
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>CommonMark\Node</info>  <strong>$child</strong>  

<comment>Return:</comment>
  <info>CommonMark\Node</info>  


id: CommonMark\Node::insertAfter
type: function
doc:
<comment>Description:</comment>
  AST Manipulation
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>CommonMark\Node</info>  <strong>$sibling</strong>  

<comment>Return:</comment>
  <info>CommonMark\Node</info>  


id: CommonMark\Node::replace
type: function
doc:
<comment>Description:</comment>
  AST Manipulation
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>CommonMark\Node</info>  <strong>$target</strong>  

<comment>Return:</comment>
  <info>CommonMark\Node</info>  


id: CommonMark\Node::unlink
type: function
doc:
<comment>Description:</comment>
  AST Manipulation
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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


id: CommonMark\Node\BulletList::__construct
type: function
doc:
<comment>Description:</comment>
  BulletList Construction
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。


id: CommonMark\Node\CodeBlock::__construct
type: function
doc:
<comment>Description:</comment>
  CodeBlock Construction
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>string</info>  <strong>$fence</strong>    
  <info>string</info>  <strong>$literal</strong>  


id: CommonMark\Node\Heading::__construct
type: function
doc:
<comment>Description:</comment>
  Heading Construction
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。


id: CommonMark\Node\Image::__construct
type: function
doc:
<comment>Description:</comment>
  Image Construction
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>string</info>  <strong>$url</strong>    
  <info>string</info>  <strong>$title</strong>  


id: CommonMark\Node\Link::__construct
type: function
doc:
<comment>Description:</comment>
  Link Construction
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>string</info>  <strong>$url</strong>    
  <info>string</info>  <strong>$title</strong>  


id: CommonMark\Node\OrderedList::__construct
type: function
doc:
<comment>Description:</comment>
  OrderedList Construction
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>int</info>  <strong>$tight</strong>      
  <info>int</info>  <strong>$delimiter</strong>  
  <info>int</info>  <strong>$start</strong>      


id: CommonMark\Node\Text::__construct
type: function
doc:
<comment>Description:</comment>
  Text Construction
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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


id: CommonMark\Parse
type: function
doc:
<comment>Description:</comment>
  Parsing
  
  Shall parse <strong>$content</strong>

<comment>Param:</comment>
  <info>string</info>  <strong>$content</strong>  markdown string
  <info>int</info>     <strong>$options</strong>  A mask of:

<comment>Return:</comment>
  <info>CommonMark\Node</info>  Shall return root CommonMark\Node


id: CommonMark\Parser
type: class
doc:
<comment>Description:</comment>
  Provides an incremental parser as an alternative to the simple Parsing API function


id: CommonMark\Parser::__construct
type: function
doc:
<comment>Description:</comment>
  Parsing
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>int</info>  <strong>$options</strong>  A mask of:


id: CommonMark\Parser::finish
type: function
doc:
<comment>Description:</comment>
  Parsing
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>CommonMark\Node</info>  


id: CommonMark\Parser::parse
type: function
doc:
<comment>Description:</comment>
  Parsing
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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

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


id: CommonMark\Render
type: function
doc:
<comment>Description:</comment>
  Rendering
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>CommonMark\Node</info>  <strong>$node</strong>     
  <info>int</info>              <strong>$options</strong>  A mask of:
  <info>int</info>              <strong>$width</strong>    

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


id: CommonMark\Render\HTML
type: function
doc:
<comment>Description:</comment>
  Rendering
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>CommonMark\Node</info>  <strong>$node</strong>     
  <info>int</info>              <strong>$options</strong>  A mask of:

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


id: Componere\Abstract\Definition
type: class
doc:
<comment>Description:</comment>
  This final abstract represents a class entry, and should not be used by the programmer.


id: Componere\Abstract\Definition::addInterface
type: function
doc:
<comment>Description:</comment>
  Add Interface
  
  Shall implement the given interface on the current definition

<comment>Param:</comment>
  <info>string</info>  <strong>$interface</strong>  The case insensitive name of an interface

<comment>Return:</comment>
  <info>Definition</info>  The current Definition


id: Componere\Abstract\Definition::addMethod
type: function
doc:
<comment>Description:</comment>
  Add Method
  
  Shall create or override a method on the current definition.

<comment>Param:</comment>
  <info>string</info>            <strong>$name</strong>    The case insensitive name for method
  <info>Componere\Method</info>  <strong>$method</strong>  <info>Componere\Method</info> not previously added to another <info>Definition</info>

<comment>Return:</comment>
  <info>Definition</info>  The current Definition


id: Componere\Abstract\Definition::addTrait
type: function
doc:
<comment>Description:</comment>
  Add Trait
  
  Shall use the given trait for the current definition

<comment>Param:</comment>
  <info>string</info>  <strong>$trait</strong>  The case insensitive name of a trait

<comment>Return:</comment>
  <info>Definition</info>  The current Definition


id: Componere\Abstract\Definition::getReflector
type: function
doc:
<comment>Description:</comment>
  Reflection
  
  Shall create or return a ReflectionClass

<comment>Return:</comment>
  <info>ReflectionClass</info>  A ReflectionClass for the current definition (cached)


id: Componere\Definition
type: class
doc:
<comment>Description:</comment>
  The Definition class allows the programmer to build and register a type at runtime.
  
  Should a Definition replace an existing class, the existing class will be restored when the
  Definition is destroyed.


id: Componere\Definition::__construct
type: function
doc:
<comment>Description:</comment>
  Definition Construction

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>        A case insensitive class name
  <info>string</info>  <strong>$parent</strong>      A case insensitive class name
  <info>array</info>   <strong>$interfaces</strong>  An array of case insensitive class names


id: Componere\Definition::addConstant
type: function
doc:
<comment>Description:</comment>
  Add Constant
  
  Shall declare a class constant on the current Definition

<comment>Param:</comment>
  <info>string</info>           <strong>$name</strong>   The case sensitive name for the constant
  <info>Componere\Value</info>  <strong>$value</strong>  The Value for the constant, must not be undefined or static

<comment>Return:</comment>
  <info>Definition</info>  The current Definition


id: Componere\Definition::addProperty
type: function
doc:
<comment>Description:</comment>
  Add Property
  
  Shall declare a class property on the current Definition

<comment>Param:</comment>
  <info>string</info>           <strong>$name</strong>   The case sensitive name for the property
  <info>Componere\Value</info>  <strong>$value</strong>  The default Value for the property

<comment>Return:</comment>
  <info>Definition</info>  The current Definition


id: Componere\Definition::getClosure
type: function
doc:
<comment>Description:</comment>
  Get Closure
  
  Shall return a Closure for the method specified by name

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  The case insensitive name of the method

<comment>Return:</comment>
  <info>Closure</info>  A Closure bound to the correct scope


id: Componere\Definition::getClosures
type: function
doc:
<comment>Description:</comment>
  Get Closures
  
  Shall return an array of Closures

<comment>Return:</comment>
  <info>array</info>  Shall return all methods as an array of Closure objects bound to the correct scope


id: Componere\Definition::isRegistered
type: function
doc:
<comment>Description:</comment>
  State Detection
  
  Shall detect the registration state of this Definition

<comment>Return:</comment>
  <info>bool</info>  Shall return true if this Definition is registered


id: Componere\Definition::register
type: function
doc:
<comment>Description:</comment>
  Registration
  
  Shall register the current Definition

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


id: Componere\Method
type: class
doc:
<comment>Description:</comment>
  A Method represents a function with modifiable accessibility flags


id: Componere\Method::__construct
type: function
doc:
<comment>Description:</comment>
  Method Construction

<comment>Param:</comment>
  <info>Closure</info>  <strong>$closure</strong>  


id: Componere\Method::getReflector
type: function
doc:
<comment>Description:</comment>
  Reflection
  
  Shall create or return a ReflectionMethod

<comment>Return:</comment>
  <info>ReflectionMethod</info>  A ReflectionMethod for the current method (cached)


id: Componere\Method::setPrivate
type: function
doc:
<comment>Description:</comment>
  Accessibility Modification

<comment>Return:</comment>
  <info>Method</info>  The current Method


id: Componere\Patch
type: class
doc:
<comment>Description:</comment>
  The Patch class allows the programmer to change the type of an instance at runtime without
  registering a new Definition
  
  When a Patch is destroyed it is reverted, so that instances that were patched during the lifetime
  of the Patch are restored to their formal type.


id: Componere\Patch::__construct
type: function
doc:
<comment>Description:</comment>
  Patch Construction

<comment>Param:</comment>
  <info>object</info>  <strong>$instance</strong>    The target for this Patch
  <info>array</info>   <strong>$interfaces</strong>  A case insensitive array of class names


id: Componere\Patch::apply
type: function
doc:
<comment>Description:</comment>
  Application
  
  Shall apply the current patch

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


id: Componere\Patch::derive
type: function
doc:
<comment>Description:</comment>
  Patch Derivation
  
  Shall derive a <info>Patch</info> for the given <strong>$instance</strong>

<comment>Param:</comment>
  <info>object</info>  <strong>$instance</strong>  The target for the derived Patch

<comment>Return:</comment>
  <info>Patch</info>  <info>Patch</info> for <strong>$instance</strong> derived from the current <info>Patch</info>


id: Componere\Patch::getClosure
type: function
doc:
<comment>Description:</comment>
  Get Closure
  
  Shall return a Closure for the method specified by name

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  The case insensitive name of the method

<comment>Return:</comment>
  <info>Closure</info>  A Closure bound to the correct scope and object


id: Componere\Patch::getClosures
type: function
doc:
<comment>Description:</comment>
  Get Closures
  
  Shall return an array of Closures

<comment>Return:</comment>
  <info>array</info>  Shall return all methods as an array of Closure objects bound to the correct scope and
         object


id: Componere\Patch::isApplied
type: function
doc:
<comment>Description:</comment>
  State Detection

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


id: Componere\Patch::revert
type: function
doc:
<comment>Description:</comment>
  Reversal
  
  Shall revert the current patch

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


id: Componere\Value
type: class
doc:
<comment>Description:</comment>
  A Value represents a PHP variable of all types, including undefined


id: Componere\Value::__construct
type: function
doc:
<comment>Description:</comment>
  Value Construction

<comment>Param:</comment>
  <info></info>  <strong>$default</strong>  


id: Componere\Value::hasDefault
type: function
doc:
<comment>Description:</comment>
  Value Interaction

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


id: Componere\Value::isPrivate
type: function
doc:
<comment>Description:</comment>
  Accessibility Detection

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


id: Componere\Value::setPrivate
type: function
doc:
<comment>Description:</comment>
  Accessibility Modification

<comment>Return:</comment>
  <info>Value</info>  The current Value


id: Componere\cast
type: function
doc:
<comment>Description:</comment>
  Casting

<comment>Param:</comment>
  <info>Type</info>  <strong>$type</strong>    A user defined type
  <info></info>      <strong>$object</strong>  An object with a user defined type compatible with Type

<comment>Return:</comment>
  <info>Type</info>  An <info>object</info> of type Type, cast from <strong>$object</strong>

<comment>See Also:</comment>
   * 


id: Componere\cast_by_ref
type: function
doc:
<comment>Description:</comment>
  Casting

<comment>Param:</comment>
  <info></info>  <strong>$object</strong>  An object with a user defined type compatible with Type

<comment>Return:</comment>
  <info>Type</info>  An <info>object</info> of type Type, cast from <strong>$object</strong>, where members are references to <strong>$object</strong> members

<comment>See Also:</comment>
   * 


id: Countable
type: class
doc:
<comment>Description:</comment>
  <class>Countable</class> を実装したクラスは、 <strong>count()</strong> 関数で使用することができます。


id: Countable::count
type: function
doc:
<comment>Description:</comment>
  オブジェクトの要素数を数える
  
  このメソッドは、<class>Countable</class> を実装したオブジェクトで <strong>count()</strong> 関数を使用した際に実行されます。

<comment>Return:</comment>
  <info>int</info>  要素数を <info>int</info> 型で返します。
       
       戻り値は <info>int</info> 型にキャストされます。


id: CrudOperationBindable::bind
type: function
doc:
<comment>Description:</comment>
  プレースホルダーに値をバインドする
  
  特定のプレースホルダーに値をバインドします。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>array</info>  <strong>$placeholder_values</strong>  プレースホルダーの名前と、バインドする値

<comment>Return:</comment>
  <info>mysql_xdevapi\CrudOperationBindable</info>  CrudOperationBindable オブジェクトを返します。


id: CrudOperationLimitable::limit
type: function
doc:
<comment>Description:</comment>
  結果を限定する
  
  返されるドキュメントまたはレコードの最大数を設定します。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>int</info>  <strong>$rows</strong>  レコードまたはドキュメントの最大数

<comment>Return:</comment>
  <info>mysql_xdevapi\CrudOperationLimitable</info>  CrudOperationLimitable オブジェクトを返します。


id: CrudOperationSkippable::skip
type: function
doc:
<comment>Description:</comment>
  スキップする操作の数
  
  結果を返す操作で、ここで指定するレコードの数をスキップします。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>int</info>  <strong>$skip</strong>  スキップする要素数

<comment>Return:</comment>
  <info>mysql_xdevapi\CrudOperationSkippable</info>  CrudOperationSkippable オブジェクトを返します。


id: CrudOperationSortable::sort
type: function
doc:
<comment>Description:</comment>
  結果をソートする
  
  結果セットを sort_expr 引数で指定されたフィールドでソートします。 可能なソート順は ASC (昇順) か
  DESC (降順) です。 この操作は、SQL における 'ORDER BY' と同等で、それと同じルールセットに従いま
  す。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>string</info>  <strong>$sort_expr</strong>  ひとつまたはそれ以上のソートを行う指揮を指定できます。 評価は左から右へと行わ
                      れ、それぞれの四季はコンマで区切ります。

<comment>Return:</comment>
  <info>mysql_xdevapi\CrudOperationSortable</info>  CrudOperationSortable オブジェクトを返します。


id: DATE_ISO8601
type: constant
doc:
<comment>Description:</comment>
  ISO-8601 (例: 2005-08-15T15:52:01+0000)
  
  このフォーマットは、ISO-8601 と互換性がありません。 しかし、後方互換性を保つために残されています。
  ISO-8601 と互換性を保つためには、 <info>DateTimeInterface::ISO8601_EXPANDED</info>, <info>DateTimeInterface::ATOM</info> を
  使うようにしてください。 (ISO8601:2004 section 4.3.3 clause d も参照ください)


id: DATE_ISO8601_EXPANDED
type: constant
doc:
<comment>Description:</comment>
  ISO-8601 拡張形式 (例: +10191-07-26T08:59:52+01:00)
  
  年に常に符号を含めることで、ISO-8601 の通常の範囲 <return>0000</return>-<return>9999</return> 以外の値が許されています。 タイムゾー
  ンの部分 (<return>+01:00</return>) については、 ISO-8601 と互換性をとるようにもなっています。


id: DATE_RFC7231
type: constant
doc:
<comment>Description:</comment>
  RFC 7231 (PHP 7.0.19 と 7.1.5以降) (例: Sat, 30 Apr 2016 17:52:13 GMT)


id: DB2_FORWARD_ONLY
type: constant
doc:
<comment>Description:</comment>
  ステートメントのリソースとして、前進のみ可能なカーソルを指定します。 これはデフォルトのカーソル型
  であり、 すべてのデータベースサーバーでサポートされています。


id: DB2_SCROLLABLE
type: constant
doc:
<comment>Description:</comment>
  ステートメントのリソースとして、スクロール可能なカーソルを指定します。 このモードでは結果セット内
  の行へのランダムアクセスが可能となりますが、 現在は IBM DB2 Universal Database でしかサポートされ
  ていません。


id: DBASE_RDONLY
type: constant
doc:
<comment>Description:</comment>
  Open database for reading only. Used with <strong>dbase_open()</strong>. (Available as of dbase 7.0.0)


id: DBASE_RDWR
type: constant
doc:
<comment>Description:</comment>
  Open database for reading and writing. Used with <strong>dbase_open()</strong>. (Available as of dbase 7.0.0)


id: DBASE_TYPE_DBASE
type: constant
doc:
<comment>Description:</comment>
  Create dBASE style database. Used with <strong>dbase_create()</strong>. (Available as of dbase 7.0.0)


id: DBASE_TYPE_FOXPRO
type: constant
doc:
<comment>Description:</comment>
  Create FoxPro style database. Used with <strong>dbase_create()</strong>. (Available as of dbase 7.0.0)


id: DISP_E_BADINDEX
type: constant
doc:
<comment>Description:</comment>
  -2147352565
  
  配列のインデックスが存在しないことを意味するエラー。
  
  PHP 7.0.0 以降、x64 における値は <return>2147614731</return> です。


id: DISP_E_DIVBYZERO
type: constant
doc:
<comment>Description:</comment>
  -2147352558
  
  ゼロ除算エラー。
  
  PHP 7.0.0 以降、x64 における値は <return>2147614738</return> です。


id: DISP_E_OVERFLOW
type: constant
doc:
<comment>Description:</comment>
  -2147352566
  
  期待する形式で値を表すことができないことを意味するエラー。
  
  PHP 7.0.0 以降、x64 における値は <return>2147614730</return> です。


id: DNS_ANY
type: constant
doc:
<comment>Description:</comment>
  全てのリソースレコード。多くのシステムでは、 これは、全てのリソースレコードを返します。 しかし、危
  機的な状況には対応できません。代わりに <info>DNS_ALL</info> を試してください。


id: DNS_CAA
type: constant
doc:
<comment>Description:</comment>
  Certification Authority Authorizationリソース (PHP 7.0.16 および 7.1.2 以降で使用可能)


id: DNS_HINFO
type: constant
doc:
<comment>Description:</comment>
  ホスト情報リソース（これらの値の意味については、IANA の <return>Operating System Names</return> を参照ください）


id: DOMAttr
type: class
doc:
<comment>Description:</comment>
  <class>DOMNode</class> を継承します。<class>DOMAttr</class> は、<class>DOMElement</class> オブジェクトの属性を表します。


id: DOMAttr::__construct
type: function
doc:
<comment>Description:</comment>
  新しい DOMAttr オブジェクトを作成する
  
  新しい DOMAttr オブジェクトを作成します。 このオブジェクトは読み込み専用です。このオブジェクトはド
  キュメントに 追加することができますが、さらに追加のノードを付け加えるためには ノードをドキュメント
  に関連付ける必要があります。書き込み可能な ノードを作成するには、  を使用します。

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>   属性のタグ名。
  <info>string</info>  <strong>$value</strong>  属性の値。

<comment>See Also:</comment>
   * DOMDocument::createAttribute


id: DOMAttr::isId
type: function
doc:
<comment>Description:</comment>
  属性が定義済みの ID かどうかを調べる
    
  
  この関数は、属性が定義済みの ID かどうかを調べます。
  
  DOM 標準規格によると、DTD では ID 型の属性 ID が定義されていなければ なりません。この関数を使用す
  る前には、  あるいは <return>DOMDocument::validateOnParse</return> を使用して ドキュメントを検証する必要がありま
  す。

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


id: DOMCdataSection
type: class
doc:
<comment>Description:</comment>
  <class>DOMCdataSection</class> は <class>DOMText</class> を継承したクラスで、 CData のテキスト表現に使います。


id: DOMCdataSection::__construct
type: function
doc:
<comment>Description:</comment>
  新しい DOMCdataSection オブジェクトを作成する
  
  新しい CDATA ノードを作成します。これは、<class>DOMText</class> クラスと同じように動作します。

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  CDATA ノードの値。省略した場合は、空の CDATA ノードを作成します。

<comment>See Also:</comment>
   * DOMText::__construct
   * DOMDocument::createTextNode


id: DOMCharacterData::after
type: function
doc:
<comment>Description:</comment>
  文字データの後ろにノードを追加する
  
  渡された <strong>$nodes</strong> をノードの後ろに追加します。

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  ノードの後ろに追加されるノード。 文字列は自動的にテキストノードに変換され
                          ます。

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

<comment>See Also:</comment>
   * DOMChildNode::after
   * DOMCharacterData::before


id: DOMCharacterData::appendData
type: function
doc:
<comment>Description:</comment>
  ノードの文字データの最後に文字列を追加する
    
  
  ノードの文字データの最後に文字列 <strong>$data</strong> を追加します。

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  追加する文字列。

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

<comment>See Also:</comment>
   * DOMCharacterData::deleteData
   * DOMCharacterData::insertData
   * DOMCharacterData::replaceData
   * DOMCharacterData::substringData


id: DOMCharacterData::before
type: function
doc:
<comment>Description:</comment>
  ノードの前にノードを追加する
  
  渡された <strong>$nodes</strong> をノードの前に追加します。

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  ノードの前に追加されるノード。 文字列は自動的にテキストノードに変換されま
                          す。

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

<comment>See Also:</comment>
   * DOMChildNode::before
   * DOMCharacterData::after


id: DOMCharacterData::deleteData
type: function
doc:
<comment>Description:</comment>
  指定した範囲の文字列をノードから削除する
    
  
  <strong>$offset</strong> で指定した位置から <strong>$count</strong> 文字ぶんの文字を削除します。

<comment>Param:</comment>
  <info>int</info>  <strong>$offset</strong>  削除開始位置のオフセット。
  <info>int</info>  <strong>$count</strong>   削除する文字の数。 <strong>$offset</strong> と <strong>$count</strong> の和が文字列の長さをこえている場合、データ末尾
                までのすべての データが削除されます。

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

<comment>See Also:</comment>
   * DOMCharacterData::appendData
   * DOMCharacterData::insertData
   * DOMCharacterData::replaceData
   * DOMCharacterData::substringData


id: DOMCharacterData::insertData
type: function
doc:
<comment>Description:</comment>
  指定した 16 ビット単位のオフセットに、文字列を挿入する
    
  
  <strong>$offset</strong> の位置に、文字列 <strong>$data</strong> を挿入します。

<comment>Param:</comment>
  <info>int</info>     <strong>$offset</strong>  挿入する場所の文字オフセット。
  <info>string</info>  <strong>$data</strong>    挿入する文字列。

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

<comment>See Also:</comment>
   * DOMCharacterData::appendData
   * DOMCharacterData::deleteData
   * DOMCharacterData::replaceData
   * DOMCharacterData::substringData


id: DOMCharacterData::remove
type: function
doc:
<comment>Description:</comment>
  文字データを削除する
  
  文字データを削除します。

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

<comment>See Also:</comment>
   * DOMChildNode::remove
   * DOMCharacterData::after
   * DOMCharacterData::before
   * DOMCharacterData::replaceWith
   * DOMNode::removeChild


id: DOMCharacterData::replaceData
type: function
doc:
<comment>Description:</comment>
  DOMCharacterData ノードの文字列の一部を置換する
    
  
  位置 <strong>$offset</strong> から <strong>$count</strong> 文字ぶんのデータを、<strong>$data</strong> に置換します。

<comment>Param:</comment>
  <info>int</info>     <strong>$offset</strong>  置換開始位置のオフセット。
  <info>int</info>     <strong>$count</strong>   置換する文字の数。 <strong>$offset</strong> と <strong>$count</strong> の和が文字列の長さをこえている場合、データ末
                   尾までのすべての データが置換されます。
  <info>string</info>  <strong>$data</strong>    置換する文字列。

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

<comment>See Also:</comment>
   * DOMCharacterData::appendData
   * DOMCharacterData::deleteData
   * DOMCharacterData::insertData
   * DOMCharacterData::substringData


id: DOMCharacterData::replaceWith
type: function
doc:
<comment>Description:</comment>
  文字データを新しいノードで置き換える
  
  文字データを新しい <strong>$nodes</strong> で置き換えます。

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  置き換えるノード。 文字列は自動的にテキストノードに変換されます。

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

<comment>See Also:</comment>
   * DOMChildNode::replaceWith
   * DOMCharacterData::after
   * DOMCharacterData::before
   * DOMCharacterData::remove


id: DOMCharacterData::substringData
type: function
doc:
<comment>Description:</comment>
  ノードから指定した範囲のデータを抽出する
    
  
  指定した部分文字列を返します。

<comment>Param:</comment>
  <info>int</info>  <strong>$offset</strong>  部分文字列の抽出開始位置のオフセット。
  <info>int</info>  <strong>$count</strong>   抽出する文字数。

<comment>Return:</comment>
  <info>string|false</info>  指定された部分文字列を返します。 <strong>$offset</strong> と <strong>$count</strong> の和が文字列の長さをこえている場
                合、データの末尾までのすべての 16 ビット単位が返されます。

<comment>See Also:</comment>
   * DOMCharacterData::appendData
   * DOMCharacterData::deleteData
   * DOMCharacterData::insertData
   * DOMCharacterData::replaceData


id: DOMChildNode::after
type: function
doc:
<comment>Description:</comment>
  ノードの後ろにノードを追加する
  
  渡された <strong>$nodes</strong> をノードの後ろに追加します。

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  ノードの後ろに追加されるノード。 文字列は自動的にテキストノードに変換され
                          ます。

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

<comment>See Also:</comment>
   * DOMChildNode::before
   * DOMChildNode::remove
   * DOMChildNode::replaceWith
   * DOMNode::appendChild


id: DOMChildNode::before
type: function
doc:
<comment>Description:</comment>
  ノードの前にノードを追加する
  
  渡された <strong>$nodes</strong> をノードの前に追加します。

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  ノードの前に追加されるノード。 文字列は自動的にテキストノードに変換されま
                          す。

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

<comment>See Also:</comment>
   * DOMChildNode::after
   * DOMChildNode::remove
   * DOMChildNode::replaceWith


id: DOMChildNode::remove
type: function
doc:
<comment>Description:</comment>
  ノードを削除する
  
  ノードを削除します。

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

<comment>See Also:</comment>
   * DOMChildNode::after
   * DOMChildNode::before
   * DOMChildNode::replaceWith
   * DOMNode::removeChild


id: DOMChildNode::replaceWith
type: function
doc:
<comment>Description:</comment>
  ノードを新しいノードで置き換える
  
  ノードを新しい <strong>$nodes</strong> で置き換えます。

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  置き換えるノード。 文字列は自動的にテキストノードに変換されます。

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

<comment>See Also:</comment>
   * DOMChildNode::after
   * DOMChildNode::before
   * DOMChildNode::remove
   * DOMNode::replaceChild


id: DOMComment::__construct
type: function
doc:
<comment>Description:</comment>
  新しい DOMComment オブジェクトを作成する
    
  
  新しい <class>DOMComment</class> オブジェクトを作成します。 このオブジェクトは読み込み専用です。このオブジェクト
  をドキュメントに 追加することが可能ですが、ノードがドキュメントと関連付けられるまでは ノードを追加
  することはできません。書き込み可能なノードを作成するには、  を使用します。

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  コメントの値。

<comment>See Also:</comment>
   * DOMDocument::createComment


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

<comment>Param:</comment>
  <info>string</info>  <strong>$version</strong>   XML 宣言の一部である、ドキュメントのバージョン番号。
  <info>string</info>  <strong>$encoding</strong>  XML 宣言の一部である、ドキュメントのエンコーディング。

<comment>See Also:</comment>
   * DOMImplementation::createDocument


id: DOMDocument::adoptNode
type: function
doc:
<comment>Description:</comment>
  ノードを別のドキュメントに移す
  
  ノードを別のドキュメントから、現在のドキュメントに移します。

<comment>Param:</comment>
  <info>DOMNode</info>  <strong>$node</strong>  移すノード

<comment>Return:</comment>
  <info>DOMNode|false</info>  移したノードを返します。エラー時に <info>false</info> を返します。

<comment>See Also:</comment>
   * DOMDocument::importNode


id: DOMDocument::append
type: function
doc:
<comment>Description:</comment>
  最後の子ノードの後ろにノードを追加する
  
  ひとつ以上の <strong>$nodes</strong> を子要素のリストに追加します。 追加されるのは、最後の子ノードの後ろになりま
  す。

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  追加するノード。 文字列は自動的にテキストノードに変換されます。

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

<comment>See Also:</comment>
   * DOMParentNode::append
   * DOMDocument::prepend


id: DOMDocument::createAttribute
type: function
doc:
<comment>Description:</comment>
  新しい属性を作成する
  
  この関数は、<class>DOMAttr</class> クラスの新しいインスタンスを作成します。 このノードは、(
  <strong>DOMNode::appendChild()</strong>
  などで) 挿入されない限り、ドキュメント内にあらわれません。

<comment>Param:</comment>
  <info>string</info>  <strong>$localName</strong>  属性の名前。

<comment>Return:</comment>
  <info>DOMAttr|false</info>  新しい <class>DOMAttr</class>、あるいはエラーが発生した場合は <info>false</info> を返します。

<comment>See Also:</comment>
   * DOMNode::appendChild
   * DOMDocument::createAttributeNS
   * DOMDocument::createCDATASection
   * DOMDocument::createComment
   * DOMDocument::createDocumentFragment
   * DOMDocument::createElement
   * DOMDocument::createElementNS
   * DOMDocument::createEntityReference
   * DOMDocument::createProcessingInstruction
   * DOMDocument::createTextNode


id: DOMDocument::createAttributeNS
type: function
doc:
<comment>Description:</comment>
  関連付けられた名前空間に新しい属性を作成する
    
  
  この関数は、<class>DOMAttr</class> クラスの新しいインスタンスを作成します。 このノードは、(
  <strong>DOMNode::appendChild()</strong>
  などで) 挿入されない限り、ドキュメント内にあらわれません。

<comment>Param:</comment>
  <info>string|null</info>  <strong>$namespace</strong>      名前空間の URI。
  <info>string</info>       <strong>$qualifiedName</strong>  属性のタグ名とプレフィックスを、<return>prefix:tagname</return> のような形式で指定す
                               る。

<comment>Return:</comment>
  <info>DOMAttr|false</info>  新しい <class>DOMAttr</class>、あるいはエラーが発生した場合は <info>false</info> を返します。

<comment>See Also:</comment>
   * DOMNode::appendChild
   * DOMDocument::createAttribute
   * DOMDocument::createCDATASection
   * DOMDocument::createComment
   * DOMDocument::createDocumentFragment
   * DOMDocument::createElement
   * DOMDocument::createElementNS
   * DOMDocument::createEntityReference
   * DOMDocument::createProcessingInstruction
   * DOMDocument::createTextNode


id: DOMDocument::createCDATASection
type: function
doc:
<comment>Description:</comment>
  新しい cdata ノードを作成する
  
  この関数は、<class>DOMCDATASection</class> クラスの新しいインスタンスを作成します。このノードは、(
  <strong>DOMNode::appendChild()</strong>
  などで) 挿入されない限り、ドキュメント内にあらわれません。

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  cdata の内容。

<comment>Return:</comment>
  <info>DOMCdataSection|false</info>  新しい <class>DOMCDATASection</class>、あるいはエラーが発生した場合は <info>false</info> を返します。

<comment>See Also:</comment>
   * DOMNode::appendChild
   * DOMDocument::createAttribute
   * DOMDocument::createAttributeNS
   * DOMDocument::createComment
   * DOMDocument::createDocumentFragment
   * DOMDocument::createElement
   * DOMDocument::createElementNS
   * DOMDocument::createEntityReference
   * DOMDocument::createProcessingInstruction
   * DOMDocument::createTextNode


id: DOMDocument::createComment
type: function
doc:
<comment>Description:</comment>
  新しい comment ノードを作成する
  
  この関数は、<class>DOMComment</class> クラスの新しいインスタンスを作成します。このノードは、(
  <strong>DOMNode::appendChild()</strong>
  などで) 挿入されない限り、ドキュメント内にあらわれません。

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  コメントの内容。

<comment>Return:</comment>
  <info>DOMComment</info>  新しい <class>DOMComment</class> を返します。

<comment>See Also:</comment>
   * DOMNode::appendChild
   * DOMDocument::createAttribute
   * DOMDocument::createAttributeNS
   * DOMDocument::createCDATASection
   * DOMDocument::createDocumentFragment
   * DOMDocument::createElement
   * DOMDocument::createElementNS
   * DOMDocument::createEntityReference
   * DOMDocument::createProcessingInstruction
   * DOMDocument::createTextNode


id: DOMDocument::createDocumentFragment
type: function
doc:
<comment>Description:</comment>
  新しい文書片を作成する
  
  この関数は、<class>DOMDocumentFragment</class> クラスの新しいインスタンスを作成します。このノードは、(
  <strong>DOMNode::appendChild()</strong>
  などで) 挿入されない限り、ドキュメント内にあらわれません。

<comment>Return:</comment>
  <info>DOMDocumentFragment</info>  新しい <class>DOMDocumentFragment</class> を返します。

<comment>See Also:</comment>
   * DOMNode::appendChild
   * DOMDocument::createAttribute
   * DOMDocument::createAttributeNS
   * DOMDocument::createCDATASection
   * DOMDocument::createComment
   * DOMDocument::createElement
   * DOMDocument::createElementNS
   * DOMDocument::createEntityReference
   * DOMDocument::createProcessingInstruction
   * DOMDocument::createTextNode


id: DOMDocument::createElement
type: function
doc:
<comment>Description:</comment>
  新しい要素ノードを作成する
  
  この関数は、<class>DOMElement</class> クラスの新しいインスタンスを作成します。 このノードは、(
  <strong>DOMNode::appendChild()</strong>
  などで) 挿入されない限り、ドキュメント内にあらわれません。

<comment>Param:</comment>
  <info>string</info>  <strong>$localName</strong>  要素のタグ名。
  <info>string</info>  <strong>$value</strong>      要素の値。デフォルトでは、空の要素が作成されます。 その後に
                      DOMElement::$nodeValue で値を設定することも可能です。
                      
                      指定した値はすべてそのまま用いますが、エンティティ参照
                      \< と &gt; だけはエスケープします。& は手動でエスケープする必要があることに注意しましょう。 そうしないと、エンティティ参照の開始とみなされてしまいます。また、" はエスケープされません。

<comment>Return:</comment>
  <info>DOMElement|false</info>  新しい <class>DOMElement</class> クラスの新しいインスタンス、 あるいはエラーが発生した場合は
                    <info>false</info> を返します。

<comment>See Also:</comment>
   * DOMNode::appendChild
   * DOMDocument::createAttribute
   * DOMDocument::createAttributeNS
   * DOMDocument::createCDATASection
   * DOMDocument::createComment
   * DOMDocument::createDocumentFragment
   * DOMDocument::createElementNS
   * DOMDocument::createEntityReference
   * DOMDocument::createProcessingInstruction
   * DOMDocument::createTextNode


id: DOMDocument::createElementNS
type: function
doc:
<comment>Description:</comment>
  関連付けられた名前空間に新しい要素を作成する
    
  
  この関数は、関連付けられた名前空間に新しい要素を作成します。 このノードは、(
  <strong>DOMNode::appendChild()</strong>
  などで) 挿入されない限り、ドキュメント内にあらわれません。

<comment>Param:</comment>
  <info>string|null</info>  <strong>$namespace</strong>      名前空間の URI。
  <info>string</info>       <strong>$qualifiedName</strong>  要素名を、<return>prefix:tagname</return> のような形式で指定する。
  <info>string</info>       <strong>$value</strong>          要素の値。デフォルトでは、空の要素が作成されます。 その後に
                               DOMElement::$nodeValue で値を設定することも可能です。

<comment>Return:</comment>
  <info>DOMElement|false</info>  新しい <class>DOMElement</class>、 あるいはエラーが発生した場合には <info>false</info> を返します。

<comment>See Also:</comment>
   * DOMNode::appendChild
   * DOMDocument::createAttribute
   * DOMDocument::createAttributeNS
   * DOMDocument::createCDATASection
   * DOMDocument::createComment
   * DOMDocument::createDocumentFragment
   * DOMDocument::createElement
   * DOMDocument::createEntityReference
   * DOMDocument::createProcessingInstruction
   * DOMDocument::createTextNode


id: DOMDocument::createEntityReference
type: function
doc:
<comment>Description:</comment>
  新しいエンティティ参照ノードを作成する
  
  この関数は、<class>DOMEntityReference</class> クラスの新しいインスタンスを作成します。このノードは、(
  <strong>DOMNode::appendChild()</strong>
  などで) 挿入されない限り、ドキュメント内にあらわれません。

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  エンティティ参照の内容、つまり、エンティティ参照から 先頭の <return>&</return> および末尾の <return>;</return> を取り
                 除いたもの。

<comment>Return:</comment>
  <info>DOMEntityReference|false</info>  新しい <class>DOMEntityReference</class>、 あるいはエラーが発生した場合には <info>false</info> を返
                            します。

<comment>See Also:</comment>
   * DOMNode::appendChild
   * DOMDocument::createAttribute
   * DOMDocument::createAttributeNS
   * DOMDocument::createCDATASection
   * DOMDocument::createComment
   * DOMDocument::createDocumentFragment
   * DOMDocument::createElement
   * DOMDocument::createElementNS
   * DOMDocument::createProcessingInstruction
   * DOMDocument::createTextNode


id: DOMDocument::createProcessingInstruction
type: function
doc:
<comment>Description:</comment>
  新しい PI ノードを作成する
  
  この関数は、<class>DOMProcessingInstruction</class> クラスの新しいインスタンスを作成します。このノードは、(
  <strong>DOMNode::appendChild()</strong>
  などで) 挿入されない限り、ドキュメント内にあらわれません。

<comment>Param:</comment>
  <info>string</info>  <strong>$target</strong>  処理命令の対象。
  <info>string</info>  <strong>$data</strong>    処理命令の内容。

<comment>Return:</comment>
  <info>DOMProcessingInstruction|false</info>  新しい <class>DOMProcessingInstruction</class>、 あるいはエラーが発生した場合には
                                  <info>false</info> を返します。

<comment>See Also:</comment>
   * DOMNode::appendChild
   * DOMDocument::createAttribute
   * DOMDocument::createAttributeNS
   * DOMDocument::createCDATASection
   * DOMDocument::createComment
   * DOMDocument::createDocumentFragment
   * DOMDocument::createElement
   * DOMDocument::createElementNS
   * DOMDocument::createEntityReference
   * DOMDocument::createTextNode


id: DOMDocument::createTextNode
type: function
doc:
<comment>Description:</comment>
  新しいテキストノードを作成する
  
  この関数は、<class>DOMText</class> クラスの新しいインスタンスを作成します。このノードは、(
  <strong>DOMNode::appendChild()</strong>
  などで) 挿入されない限り、ドキュメント内にあらわれません。

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  テキストの内容。

<comment>Return:</comment>
  <info>DOMText</info>  新しい <class>DOMText</class> を返します。

<comment>See Also:</comment>
   * DOMNode::appendChild
   * DOMDocument::createAttribute
   * DOMDocument::createAttributeNS
   * DOMDocument::createCDATASection
   * DOMDocument::createComment
   * DOMDocument::createDocumentFragment
   * DOMDocument::createElement
   * DOMDocument::createElementNS
   * DOMDocument::createEntityReference
   * DOMDocument::createProcessingInstruction


id: DOMDocument::getElementById
type: function
doc:
<comment>Description:</comment>
  id に対応する要素を検索する
  
  この関数は、  と同じですが、指定した ID から要素を検索する点が違います。
  
  この関数を動作させるには、何らかの ID 属性を  で設定するか、あるいは DTD で ID 型の属性を定義する
  必要があります。 後者の場合は、  あるいは DOMDocument::$validateOnParse を使用してドキュメントを検
  証する必要があります。

<comment>Param:</comment>
  <info>string</info>  <strong>$elementId</strong>  要素の ID。

<comment>Return:</comment>
  <info>DOMElement|null</info>  <class>DOMElement</class>、 あるいは要素が見つからなかった場合は <info>null</info> を返します。

<comment>See Also:</comment>
   * DOMDocument::getElementsByTagName


id: DOMDocument::getElementsByTagName
type: function
doc:
<comment>Description:</comment>
  指定したローカルタグ名に対応するすべての要素を検索する
  
  この関数は、指定したローカルタグ名のすべての要素を含む <class>DOMNodeList</class> クラスの新しいインスタンスを返
  します。

<comment>Param:</comment>
  <info>string</info>  <strong>$qualifiedName</strong>  タグのローカル名 (名前空間を除いたもの) に一致する名前。<return>*</return> はすべてのタグに
                          一致します。

<comment>Return:</comment>
  <info>DOMNodeList</info>  一致するすべての要素を含む、新しい <class>DOMNodeList</class> オブジェクトを返します。

<comment>See Also:</comment>
   * DOMDocument::getElementsByTagNameNS


id: DOMDocument::getElementsByTagNameNS
type: function
doc:
<comment>Description:</comment>
  指定した名前空間で、タグ名に対応するすべての要素を検索する
    
  
  指定したローカル名および名前空間 URI に一致するすべての要素の <class>DOMNodeList</class> を返します。

<comment>Param:</comment>
  <info>string|null</info>  <strong>$namespace</strong>  条件に一致する要素の名前空間 URI。 <return>"*"</return> はすべての名前空間に一致します。
                           <info>null</info> を渡すと、空の名前空間に一致します。
  <info>string</info>       <strong>$localName</strong>  条件に一致する要素のローカル名。 <return>"*"</return> はすべてのローカル名に一致します。

<comment>Return:</comment>
  <info>DOMNodeList</info>  一致するすべての要素を含む、新しい <class>DOMNodeList</class> オブジェクトを返します。

<comment>See Also:</comment>
   * DOMDocument::getElementsByTagName


id: DOMDocument::importNode
type: function
doc:
<comment>Description:</comment>
  現在のドキュメントにノードをインポートする
  
  この関数は、インポートするノードのコピーを返し、 それを現在のドキュメントに関連付けます。

<comment>Param:</comment>
  <info>DOMNode</info>  <strong>$node</strong>  インポートするノード。
  <info>bool</info>     <strong>$deep</strong>  <info>true</info> の場合、このメソッドは <strong>$node</strong> 以下のサブツリーも再帰的にインポートします。
                  
                  ノードの属性をコピーするには <strong>$deep</strong> を <info>true</info> に設定しなければなりません。

<comment>Return:</comment>
  <info>DOMNode|false</info>  コピーされたノードを返します。 コピーできなかった場合は <info>false</info> を返します。


id: DOMDocument::load
type: function
doc:
<comment>Description:</comment>
  ファイルから XML を読み込む
    
  
  XML ドキュメントをファイルから読み込みます。
  
  Unix 風のパス (スラッシュを使った方式) を Windows 上で使用すると、 パフォーマンスが著しく低下しま
  す。そんな場合は <strong>realpath()</strong> をコールしましょう。

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  XML ドキュメントへのパス。
  <info>int</info>     <strong>$options</strong>   libxml オプション定数 を ビット <return>OR</return> で連結したもの。

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

<comment>See Also:</comment>
   * DOMDocument::loadXML
   * DOMDocument::save
   * DOMDocument::saveXML


id: DOMDocument::loadHTML
type: function
doc:
<comment>Description:</comment>
  文字列から HTML を読み込む
    
  
  この関数は、文字列 <strong>$source</strong> に含まれる HTML を パースします。XML を読み込む場合とは異なり、妥当な
  HTML でなくても 読み込むことができます。
  
  この関数は、HTML4 のパーサを使って入力をパースします。モダンなWebブラウザが採用している HTML5 の
  パースルールとは異なります。入力によっては、このことが原因で異なるDOM構造になるかもしれません。
  よって、この関数はHTMLを無害化する目的で安全に使えません。
  
  例を挙げましょう。HTML要素によっては、暗黙のうちに親の要素を閉じるものがあります。親要素を自動で閉
  じるルールは、HTML4 と HTML5 で異なります。よって、<class>DOMDocument</class> が表す DOM 構造は Webブラウザ上のそ
  れと異なる可能性があります。このことから、攻撃者がHTMLを壊す攻撃を許す可能性があります。

<comment>Param:</comment>
  <info>string</info>  <strong>$source</strong>   HTML 文字列。
  <info>int</info>     <strong>$options</strong>  追加の Libxml パラメータ を、ビット演算子の <return>OR</return> で指定します。

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

<comment>See Also:</comment>
   * DOMDocument::loadHTMLFile
   * DOMDocument::saveHTML
   * DOMDocument::saveHTMLFile


id: DOMDocument::loadHTMLFile
type: function
doc:
<comment>Description:</comment>
  ファイルから HTML を読み込む
    
  
  この関数は、<strong>$filename</strong> という名前のファイルから 読み込んだ HTML ドキュメントをパースします。 XML を
  読み込む場合とは異なり、妥当な HTML でなくても 読み込むことができます。
  
  この関数は、HTML4 のパーサを使って入力をパースします。モダンなWebブラウザが採用している HTML5 の
  パースルールとは異なります。入力によっては、このことが原因で異なるDOM構造になるかもしれません。
  よって、この関数はHTMLを無害化する目的で安全に使えません。
  
  例を挙げましょう。HTML要素によっては、暗黙のうちに親の要素を閉じるものがあります。親要素を自動で閉
  じるルールは、HTML4 と HTML5 で異なります。よって、<class>DOMDocument</class> が表す DOM 構造は Webブラウザ上のそ
  れと異なる可能性があります。このことから、攻撃者がHTMLを壊す攻撃を許す可能性があります。

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  HTML ファイルへのパス。
  <info>int</info>     <strong>$options</strong>   追加の Libxml パラメータ を、ビット演算子の <return>OR</return> で指定します。

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

<comment>See Also:</comment>
   * DOMDocument::loadHTML
   * DOMDocument::saveHTML
   * DOMDocument::saveHTMLFile


id: DOMDocument::loadXML
type: function
doc:
<comment>Description:</comment>
  文字列から XML を読み込む
    
  
  XML ドキュメントを文字列から読み込みます。

<comment>Param:</comment>
  <info>string</info>  <strong>$source</strong>   XML を含む文字列。
  <info>int</info>     <strong>$options</strong>  libxml オプション定数 を ビット <return>OR</return> で連結したもの。

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

<comment>See Also:</comment>
   * DOMDocument::load
   * DOMDocument::save
   * DOMDocument::saveXML


id: DOMDocument::normalizeDocument
type: function
doc:
<comment>Description:</comment>
  ドキュメントを正規化する
  
  このメソッドは、まるでドキュメントを一度保存してから読み込みなおしたかのように動作し、 ドキュメン
  トを "正規化された" 形式にします。

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

<comment>See Also:</comment>
   * The DOM Specification
   * DOMNode::normalize


id: DOMDocument::prepend
type: function
doc:
<comment>Description:</comment>
  最初の子ノードの前にノードを追加する
  
  ひとつ以上の <strong>$nodes</strong> を、 最初の子ノードの前の、子ノードのリストに追加します。

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  ノードの前に追加するノード。 文字列は自動的にテキストノードに変換されま
                          す。

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

<comment>See Also:</comment>
   * DOMParentNode::prepend
   * DOMDocument::append


id: DOMDocument::registerNodeClass
type: function
doc:
<comment>Description:</comment>
  基底ノード型を作成する際に使用する拡張クラスを登録する
  
  このメソッドにより、独自に拡張した DOM クラスを登録することができます。 これを、後で PHP DOM 拡張
  モジュールで使用します。
  
  このメソッドは、DOM の標準にはないものです。
  
  登録済みのクラスの、インスタンスのコンストラクタはコールされません。

<comment>Param:</comment>
  <info>string</info>       <strong>$baseClass</strong>      拡張したい DOM クラス。クラス名の一覧は、 この章の導入部にあります。
  <info>string|null</info>  <strong>$extendedClass</strong>  拡張したクラスの名前。<info>null</info> を渡した場合は、 それまでに <strong>$baseClass</strong> を
                               拡張して作成したすべてのクラスが削除されます。

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


id: DOMDocument::relaxNGValidate
type: function
doc:
<comment>Description:</comment>
  ドキュメントを relaxNG で検証する
    
  
  指定した RNG スキーマに基づいて、ドキュメントを relaxNG で検証します。

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  RNG ファイル。

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

<comment>See Also:</comment>
   * DOMDocument::relaxNGValidateSource
   * DOMDocument::schemaValidate
   * DOMDocument::schemaValidateSource
   * DOMDocument::validate


id: DOMDocument::relaxNGValidateSource
type: function
doc:
<comment>Description:</comment>
  ドキュメントを relaxNG で検証する
    
  
  指定した RNG ソースに基づいて、ドキュメントを relaxNG で検証します。

<comment>Param:</comment>
  <info>string</info>  <strong>$source</strong>  RNG スキーマを含む文字列。

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

<comment>See Also:</comment>
   * DOMDocument::relaxNGValidate
   * DOMDocument::schemaValidate
   * DOMDocument::schemaValidateSource
   * DOMDocument::validate


id: DOMDocument::replaceChildren
type: function
doc:
<comment>Description:</comment>
  ドキュメントの子を置換する
  
  ドキュメント中の子を、新しい <strong>$nodes</strong> で置換します。

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  子を置き換えるノード 文字列は自動的にテキストノードに変換されます。

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

<comment>See Also:</comment>
   * DOMParentNode::replaceChildren
   * DOMDocument::append
   * DOMDocument::prepend


id: DOMDocument::save
type: function
doc:
<comment>Description:</comment>
  内部の XML ツリーをファイルに出力する
    
  
  DOM 表現から XML ドキュメントを作成します。この関数は、通常は以下の例のように DOM ドキュメントを新
  しく作成した後にコールされます。

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  保存された XML ドキュメントへのパス。
  <info>int</info>     <strong>$options</strong>   追加のオプション。現在は LIBXML_NOEMPTYTAG のみが サポートされています。

<comment>Return:</comment>
  <info>int|false</info>  書き込んだバイト数、あるいはエラーが発生した場合は <info>false</info> を返します。

<comment>See Also:</comment>
   * DOMDocument::saveXML
   * DOMDocument::load
   * DOMDocument::loadXML


id: DOMDocument::saveHTML
type: function
doc:
<comment>Description:</comment>
  内部のドキュメントを HTML 形式の文字列として出力する
    
  
  DOM 表現から HTML ドキュメントを作成します。この関数は、通常は以下の例のように DOM ドキュメントを
  新しく作成した後にコールされます。

<comment>Param:</comment>
  <info>DOMNode|null</info>  <strong>$node</strong>  ドキュメントのサブセットを出力するオプションのパラメータ。

<comment>Return:</comment>
  <info>string|false</info>  HTML、あるいはエラーが発生した場合は <info>false</info> を返します。

<comment>See Also:</comment>
   * DOMDocument::saveHTMLFile
   * DOMDocument::loadHTML
   * DOMDocument::loadHTMLFile


id: DOMDocument::saveHTMLFile
type: function
doc:
<comment>Description:</comment>
  内部のドキュメントを HTML 形式でファイルに出力する
    
  
  DOM 表現から HTML ドキュメントを作成します。この関数は、通常は以下の例のように DOM ドキュメントを
  新しく作成した後にコールされます。

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  保存された HTML ドキュメントへのパス。

<comment>Return:</comment>
  <info>int|false</info>  書き込んだバイト数、あるいはエラーが発生した場合は <info>false</info> を返します。

<comment>See Also:</comment>
   * DOMDocument::saveHTML
   * DOMDocument::loadHTML
   * DOMDocument::loadHTMLFile


id: DOMDocument::saveXML
type: function
doc:
<comment>Description:</comment>
  内部の XML ツリーを文字列として出力する
    
  
  DOM 表現から XML ドキュメントを作成します。この関数は、通常は以下の例のように DOM ドキュメントを新
  しく作成した後にコールされます。

<comment>Param:</comment>
  <info>DOMNode|null</info>  <strong>$node</strong>     ドキュメント全体ではなく、XML 宣言以外の特定のノードだけを 出力したい場合
                          にこのパラメータを使用します。
  <info>int</info>           <strong>$options</strong>  追加のオプション。LIBXML_NOEMPTYTAG と LIBXML_NOXMLDECL がサポートされてい
                          ます。 PHP 8.3.0 より前のバージョンでは、LIBXML_NOEMPTYTAG だけがサポート
                          されていました。

<comment>Return:</comment>
  <info>string|false</info>  XML、あるいはエラーが発生した場合は <info>false</info> を返します。

<comment>See Also:</comment>
   * DOMDocument::save
   * DOMDocument::load
   * DOMDocument::loadXML


id: DOMDocument::schemaValidate
type: function
doc:
<comment>Description:</comment>
  スキーマに基づいてドキュメントを検証する。XML Schema 1.0 のみサポート。
    
  
  指定されたスキーマファイルに基づいてドキュメントを検証します。

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  スキーマへのパス。
  <info>int</info>     <strong>$flags</strong>     Libxml のスキーマ検証フラグのビットマスク。現在サポートしている値は
                     LIBXML_SCHEMA_CREATE だけです。 Libxml 2.6.14 以降で使えます。

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

<comment>See Also:</comment>
   * DOMDocument::schemaValidateSource
   * DOMDocument::relaxNGValidate
   * DOMDocument::relaxNGValidateSource
   * DOMDocument::validate


id: DOMDocument::schemaValidateSource
type: function
doc:
<comment>Description:</comment>
  スキーマに基づいてドキュメントを検証する
    
  
  指定した文字列に定義されているスキーマに基づいてドキュメントを検証します。

<comment>Param:</comment>
  <info>string</info>  <strong>$source</strong>  スキーマを含む文字列。
  <info>int</info>     <strong>$flags</strong>   Libxml のスキーマ検証フラグのビットマスク。現在サポートしている値は
                   LIBXML_SCHEMA_CREATE だけです。 Libxml 2.6.14 以降で使えます。

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

<comment>See Also:</comment>
   * DOMDocument::schemaValidate
   * DOMDocument::relaxNGValidate
   * DOMDocument::relaxNGValidateSource
   * DOMDocument::validate


id: DOMDocument::validate
type: function
doc:
<comment>Description:</comment>
  DTD に基づいてドキュメントを検証する
    
  
  DTD に基づいてドキュメントを検証します。
  
  DTD による検証を行うには、<class>DOMDocument</class> の <return>validateOnParse</return> プロパティを使用することも可能です。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。 ドキュメントに DTD が添付されてい
        ない場合は、このメソッドは <info>false</info> を返します。

<comment>See Also:</comment>
   * DOMDocument::schemaValidate
   * DOMDocument::schemaValidateSource
   * DOMDocument::relaxNGValidate
   * DOMDocument::relaxNGValidateSource


id: DOMDocument::xinclude
type: function
doc:
<comment>Description:</comment>
  DOMDocument オブジェクト内の XIncludes を置換する
    
  
  このメソッドは、DOMDocument オブジェクト内の XIncludes を置換します。
  
  include される XML ファイルに DTD が添付されている場合は libxml2 が自動的にエンティティを解決する
  ため、 このメソッドは予期せぬ結果を引き起こすことがあります。

<comment>Param:</comment>
  <info>int</info>  <strong>$options</strong>  追加の Libxml パラメータ を、ビット演算子の <return>OR</return> で指定します。

<comment>Return:</comment>
  <info>int|false</info>  ドキュメント内の XIncludes の数を返します。 何かの処理に失敗した場合は -1、 置換が発生
             しなかった場合は <info>false</info> を返します。


id: DOMDocumentFragment::append
type: function
doc:
<comment>Description:</comment>
  最後の子ノードの後ろにノードを追加する
  
  ひとつ以上の <strong>$nodes</strong> を、子のリストに追加します。 追加されるのは、最後の子ノードの後ろになります。

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  追加するノード。 文字列は自動的にテキストノードに変換されます。

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

<comment>See Also:</comment>
   * DOMParentNode::append
   * DOMDocumentFragment::prepend


id: DOMDocumentFragment::appendXML
type: function
doc:
<comment>Description:</comment>
  生の XML データを追加する
  
  生の XML データを DOMDocumentFragment に追加します。
  
  このメソッドは、DOM の標準にはないものです。 これは、XML DocumentFragment を DOMDocument に簡単に
  追加できるように作成されました。
  
  標準に従いたい場合は、まずテンポラリの DOMDocument をダミーのルートで作成し、 追加したい XML デー
  タのルートの子ノードを順にループする必要があります。

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  追加する XML。

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


id: DOMDocumentFragment::prepend
type: function
doc:
<comment>Description:</comment>
  最初の子ノードの前にノードを追加する
  
  ひとつ以上の <strong>$nodes</strong> を、子ノードのリストに追加します。 追加されるのは、最初の子ノードの前になりま
  す。

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  ノードの前に追加するノード。 文字列は自動的にテキストノードに変換されま
                          す。

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

<comment>See Also:</comment>
   * DOMParentNode::prepend
   * DOMDocumentFragment::append


id: DOMDocumentFragment::replaceChildren
type: function
doc:
<comment>Description:</comment>
  文書片の子を置換する
  
  文書片に含まれる子を、新しい <strong>$nodes</strong> で置換します。

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  子を置き換えるノード 文字列は自動的にテキストノードに変換されます。

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

<comment>See Also:</comment>
   * DOMParentNode::replaceChildren
   * DOMDocumentFragment::append
   * DOMDocumentFragment::prepend


id: DOMDocumentType
type: class
doc:
<comment>Description:</comment>
  各 <class>DOMDocument</class> は <return>doctype</return> 属性を保持しており、その値は <info>null</info> あるいは <class>DOMDocumentType</class> オブジェクト
  です。


id: DOMElement::__construct
type: function
doc:
<comment>Description:</comment>
  新しい DOMElement オブジェクトを作成する
    
  
  新しい <class>DOMElement</class> オブジェクトを作成します。 このオブジェクトは読み込み専用です。このオブジェクト
  をドキュメントに 追加することが可能ですが、ノードがドキュメントに関連付けられるまでは ノードを追加
  することはできません。書き込み可能なノードを作成するには、  あるいは  を使用します。

<comment>Param:</comment>
  <info>string</info>       <strong>$qualifiedName</strong>  要素のタグ名。namespaceURI をともに指定した場合、 この URI に関連付け
                               られたプレフィックスが与えられます。
  <info>string|null</info>  <strong>$value</strong>          要素の値。
  <info>string</info>       <strong>$namespace</strong>      指定した名前空間の中で要素を作成するための 名前空間 URI。

<comment>See Also:</comment>
   * DOMDocument::createElement
   * DOMDocument::createElementNS


id: DOMElement::after
type: function
doc:
<comment>Description:</comment>
  要素の後ろにノードを追加する
  
  渡された <strong>$nodes</strong> を要素の後ろに追加します。

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  ノードの後ろに追加されるノード。 文字列は自動的にテキストノードに変換され
                          ます。

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

<comment>See Also:</comment>
   * DOMChildNode::after
   * DOMElement::before


id: DOMElement::append
type: function
doc:
<comment>Description:</comment>
  最後のノードの後ろにノードを追加する
  
  ひとつ以上の <strong>$nodes</strong> を子のリストに追加します。 追加されるのは、最後の子要素の後ろになります。

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  追加するノード。 文字列は自動的にテキストノードに変換されます。

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

<comment>See Also:</comment>
   * DOMParentNode::append
   * DOMElement::prepend


id: DOMElement::before
type: function
doc:
<comment>Description:</comment>
  要素の前にノードを追加する
  
  渡された <strong>$nodes</strong> を要素の前に追加します。

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  ノードの前に追加されるノード。 文字列は自動的にテキストノードに変換されま
                          す。

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

<comment>See Also:</comment>
   * DOMChildNode::before
   * DOMElement::after


id: DOMElement::getAttribute
type: function
doc:
<comment>Description:</comment>
  属性の値を返す
  
  現在のノードから、名前が <strong>$qualifiedName</strong> である属性の値を取得します。

<comment>Param:</comment>
  <info>string</info>  <strong>$qualifiedName</strong>  属性の名前。

<comment>Return:</comment>
  <info>string</info>  属性の値、あるいは <strong>$qualifiedName</strong> に対応する属性が 見つからなかった場合には空の文字列を返
          します。

<comment>See Also:</comment>
   * DOMElement::hasAttribute
   * DOMElement::setAttribute
   * DOMElement::removeAttribute


id: DOMElement::getAttributeNS
type: function
doc:
<comment>Description:</comment>
  属性の値を返す
  
  現在のノードから、名前空間 <strong>$namespace</strong> における <strong>$localName</strong> というローカル名の属性の値を取得します。

<comment>Param:</comment>
  <info>string|null</info>  <strong>$namespace</strong>  名前空間 URI。
  <info>string</info>       <strong>$localName</strong>  ローカル名。

<comment>Return:</comment>
  <info>string</info>  属性の値、あるいは <strong>$localName</strong> および <strong>$namespace</strong> に対応する属性が 見つからなかった場合には
          空の文字列を返します。

<comment>See Also:</comment>
   * DOMElement::hasAttributeNS
   * DOMElement::setAttributeNS
   * DOMElement::removeAttributeNS


id: DOMElement::getAttributeNames
type: function
doc:
<comment>Description:</comment>
  属性の名前を取得する
  
  属性の名前を取得します。

<comment>Return:</comment>
  <info>array</info>  属性の名前を返します。


id: DOMElement::getAttributeNode
type: function
doc:
<comment>Description:</comment>
  属性ノードを返す
  
  現在の要素の、<strong>$qualifiedName</strong> という名前の属性ノードを返します。

<comment>Param:</comment>
  <info>string</info>  <strong>$qualifiedName</strong>  属性の名前。

<comment>Return:</comment>
  <info>DOMAttr|DOMNameSpaceNode|false</info>  属性ノードを返します。 XML の名前空間宣言 (<return>xmlns</return> や <return>xmlns:*</return> 属性)
                                  については、 <class>DOMAttr</class> オブジェクトではなく、 <class>DOMNameSpaceNode</class> が返
                                  されることに注意してください。

<comment>See Also:</comment>
   * DOMElement::hasAttribute
   * DOMElement::setAttributeNode
   * DOMElement::removeAttributeNode


id: DOMElement::getAttributeNodeNS
type: function
doc:
<comment>Description:</comment>
  属性ノードを返す
    
  
  現在のノードの、名前空間 <strong>$namespace</strong>における <strong>$localName</strong> というローカル名の属性ノードを返します。

<comment>Param:</comment>
  <info>string|null</info>  <strong>$namespace</strong>  名前空間 URI。
  <info>string</info>       <strong>$localName</strong>  ローカル名。

<comment>Return:</comment>
  <info>DOMAttr|DOMNameSpaceNode|null</info>  属性ノードを返します。 XML の名前空間宣言 (<return>xmlns</return> や <return>xmlns:*</return> 属性)
                                 については、 <class>DOMAttr</class> オブジェクトではなく、 <class>DOMNameSpaceNode</class> が返さ
                                 れることに注意してください。

<comment>See Also:</comment>
   * DOMElement::hasAttributeNS
   * DOMElement::setAttributeNodeNS
   * DOMElement::removeAttributeNode


id: DOMElement::getElementsByTagName
type: function
doc:
<comment>Description:</comment>
  タグ名から要素を取得する
  
  この関数は、指定した名前 <strong>$qualifiedName</strong> のタグを持つ すべての子孫要素からなるクラス <class>DOMNodeList</class> の
  新しいインスタンスを返します。要素は、ツリーをたどっていく際に 見つかった順に並べられます。

<comment>Param:</comment>
  <info>string</info>  <strong>$qualifiedName</strong>  タグ名。ツリー内のすべての要素を返すには <return>*</return> を使用します。

<comment>Return:</comment>
  <info>DOMNodeList</info>  この関数は、一致したすべての要素からなる <class>DOMNodeList</class> クラスのインスタンスを返します。

<comment>See Also:</comment>
   * DOMElement::getElementsByTagNameNS


id: DOMElement::getElementsByTagNameNS
type: function
doc:
<comment>Description:</comment>
  名前空間 URI とローカル名から要素を取得する
  
  この関数は、指定した名前 <strong>$localName</strong> および <strong>$namespace</strong> のタグを持つ すべての子孫要素を取得します。

<comment>Param:</comment>
  <info>string|null</info>  <strong>$namespace</strong>  条件に一致する要素の名前空間 URI。 <return>"*"</return> はすべての名前空間に一致します。
                           <info>null</info> を渡すと、空の名前空間に一致します。
  <info>string</info>       <strong>$localName</strong>  条件に一致する要素のローカル名。 <return>"*"</return> はすべてのローカル名に一致します。

<comment>Return:</comment>
  <info>DOMNodeList</info>  この関数は、一致したすべての要素からなる <class>DOMNodeList</class> クラスのインスタンスを返します。
               各要素は、ツリー内の探索時に見つかった順で並べられます。

<comment>See Also:</comment>
   * DOMElement::getElementsByTagName


id: DOMElement::hasAttribute
type: function
doc:
<comment>Description:</comment>
  属性が存在するかどうかを調べる
  
  要素のメンバとして <strong>$qualifiedName</strong> という名前の属性が 存在するかどうかを示します。

<comment>Param:</comment>
  <info>string</info>  <strong>$qualifiedName</strong>  要素名。

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

<comment>See Also:</comment>
   * DOMElement::hasAttributeNS
   * DOMElement::getAttribute
   * DOMElement::setAttribute
   * DOMElement::removeAttribute


id: DOMElement::hasAttributeNS
type: function
doc:
<comment>Description:</comment>
  属性が存在するかどうかを調べる
    
  
  要素のメンバとして <strong>$localName</strong> という名前の属性が 名前空間 <strong>$namespace</strong> に存在するかどうかを示しま
  す。

<comment>Param:</comment>
  <info>string|null</info>  <strong>$namespace</strong>  名前空間 URI。
  <info>string</info>       <strong>$localName</strong>  ローカル名。

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

<comment>See Also:</comment>
   * DOMElement::hasAttribute
   * DOMElement::getAttributeNS
   * DOMElement::setAttributeNS
   * DOMElement::removeAttributeNS


id: DOMElement::insertAdjacentElement
type: function
doc:
<comment>Description:</comment>
  隣接する要素を挿入する
  
  <strong>$where</strong> で指定された相対的な位置に、 要素を挿入します。

<comment>Param:</comment>
  <info>string</info>      <strong>$where</strong>    <return>beforebegin</return> - 目的の要素の直前に挿入します<return>afterbegin</return> - 目的の要素の最初の子
                        要素として挿入します<return>beforeend</return> - 目的の要素の最後の子要素として挿入します
                        <return>afterend</return> - 目的の要素の直後に挿入します
  <info>DOMElement</info>  <strong>$element</strong>  挿入する要素

<comment>Return:</comment>
  <info>DOMElement|null</info>  <class>DOMElement</class> を返します。 失敗した場合は <info>null</info> を返します。

<comment>See Also:</comment>
   * DOMElement::insertAdjacentText


id: DOMElement::insertAdjacentText
type: function
doc:
<comment>Description:</comment>
  隣接するテキストを挿入する
  
  <strong>$where</strong> で指定された相対的な位置に、 テキストを挿入します。

<comment>Param:</comment>
  <info>string</info>  <strong>$where</strong>  <return>beforebegin</return> - 目的の要素の直前に挿入します<return>afterbegin</return> - 目的の要素の最初の子要素と
                  して挿入します<return>beforeend</return> - 目的の要素の最後の子要素として挿入します<return>afterend</return> - 目的
                  の要素の直後に挿入します
  <info>string</info>  <strong>$data</strong>   挿入する文字列

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

<comment>See Also:</comment>
   * DOMElement::insertAdjacentElement


id: DOMElement::prepend
type: function
doc:
<comment>Description:</comment>
  最初の子ノードの前にノードを追加する
  
  ひとつ以上の <strong>$nodes</strong> を、子のリストに追加します。 追加されるのは、最初の子ノードの前になります。

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  ノードの前に追加するノード。 文字列は自動的にテキストノードに変換されま
                          す。

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

<comment>See Also:</comment>
   * DOMParentNode::prepend
   * DOMElement::append


id: DOMElement::remove
type: function
doc:
<comment>Description:</comment>
  要素を削除する
  
  要素を削除します。

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

<comment>See Also:</comment>
   * DOMElement::after
   * DOMElement::before
   * DOMElement::replaceWith
   * DOMNode::removeChild


id: DOMElement::removeAttribute
type: function
doc:
<comment>Description:</comment>
  属性を削除する
  
  <strong>$qualifiedName</strong> という名前の属性を要素から削除します。

<comment>Param:</comment>
  <info>string</info>  <strong>$qualifiedName</strong>  属性の名前。

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

<comment>See Also:</comment>
   * DOMElement::hasAttribute
   * DOMElement::getAttribute
   * DOMElement::setAttribute


id: DOMElement::removeAttributeNS
type: function
doc:
<comment>Description:</comment>
  属性を削除する
  
  名前空間 <strong>$namespace</strong> にある <strong>$localName</strong> という名前の属性を 要素から削除します。

<comment>Param:</comment>
  <info>string|null</info>  <strong>$namespace</strong>  名前空間 URI。
  <info>string</info>       <strong>$localName</strong>  ローカル名。

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

<comment>See Also:</comment>
   * DOMElement::hasAttributeNS
   * DOMElement::getAttributeNS
   * DOMElement::setAttributeNS


id: DOMElement::removeAttributeNode
type: function
doc:
<comment>Description:</comment>
  属性を削除する
  
  属性 <strong>$attr</strong> を要素から削除します。

<comment>Param:</comment>
  <info>DOMAttr</info>  <strong>$attr</strong>  属性ノード。

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

<comment>See Also:</comment>
   * DOMElement::hasAttribute
   * DOMElement::getAttributeNode
   * DOMElement::setAttributeNode


id: DOMElement::replaceChildren
type: function
doc:
<comment>Description:</comment>
  要素中の子を置換する
  
  要素中の子を、新しい <strong>$nodes</strong> で置換します。

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  子を置き換えるノード 文字列は自動的にテキストノードに変換されます。

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

<comment>See Also:</comment>
   * DOMParentNode::replaceChildren
   * DOMElement::replaceWith
   * DOMElement::after
   * DOMElement::before
   * DOMElement::remove


id: DOMElement::replaceWith
type: function
doc:
<comment>Description:</comment>
  要素を新しいノードで置換する
  
  要素を新しい <strong>$nodes</strong> で置換します。

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  置き換えるノード。 文字列は自動的にテキストノードに変換されます。

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

<comment>See Also:</comment>
   * DOMChildNode::replaceWith
   * DOMElement::replaceChildren
   * DOMElement::after
   * DOMElement::before
   * DOMElement::remove


id: DOMElement::setAttribute
type: function
doc:
<comment>Description:</comment>
  属性を新しく追加する、または変更する
  
  <strong>$qualifiedName</strong> という名前の属性を、指定した値に設定します。 属性が存在しない場合は、作成されます。

<comment>Param:</comment>
  <info>string</info>  <strong>$qualifiedName</strong>  属性の名前。
  <info>string</info>  <strong>$value</strong>          属性の値。

<comment>Return:</comment>
  <info>DOMAttr|bool</info>  新しく作られた、または変更された <class>DOMAttr</class> を返します。 エラーが発生した場合は <info>false</info>
                を返します。

<comment>See Also:</comment>
   * DOMElement::hasAttribute
   * DOMElement::getAttribute
   * DOMElement::removeAttribute


id: DOMElement::setAttributeNS
type: function
doc:
<comment>Description:</comment>
  新しい属性を追加する
  
  名前空間 <strong>$namespace</strong> にある <strong>$localName</strong> という名前の属性を、指定した値に設定します。 属性が存在しな
  い場合は、作成されます。

<comment>Param:</comment>
  <info>string|null</info>  <strong>$namespace</strong>      名前空間 URI。
  <info>string</info>       <strong>$qualifiedName</strong>  <return>prefix:tagname</return> 形式で表した属性名。
  <info>string</info>       <strong>$value</strong>          属性の値。

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

<comment>See Also:</comment>
   * DOMElement::hasAttributeNS
   * DOMElement::getAttributeNS
   * DOMElement::removeAttributeNS


id: DOMElement::setAttributeNode
type: function
doc:
<comment>Description:</comment>
  新しい属性ノードを要素に追加する
  
  新しい属性ノード <strong>$attr</strong> を要素に追加します。 要素に同じ名前の属性が既に存在している場合、 その属性
  は <strong>$attr</strong> で置き換えられます。

<comment>Param:</comment>
  <info>DOMAttr</info>  <strong>$attr</strong>  属性ノード。

<comment>Return:</comment>
  <info>DOMAttr|null|false</info>  属性が置換された場合は置換前のノード、そうでない場合は <info>null</info> を返します。
                      <info>DOM_WRONG_DOCUMENT_ERR</info> エラーが発生した場合、 かつ strictErrorChecking が
                      <info>false</info> の場合には、<info>false</info> を返します。

<comment>See Also:</comment>
   * DOMElement::hasAttribute
   * DOMElement::getAttributeNode
   * DOMElement::removeAttributeNode


id: DOMElement::setAttributeNodeNS
type: function
doc:
<comment>Description:</comment>
  新しい属性ノードを要素に追加する
  
  新しい属性ノード <strong>$attr</strong> を要素に追加しますが、名前空間を考慮します。 要素に同じ名前の属性が既に存在
  している場合、 その属性は <strong>$attr</strong> で置き換えられます。

<comment>Param:</comment>
  <info>DOMAttr</info>  <strong>$attr</strong>  属性ノード。

<comment>Return:</comment>
  <info>DOMAttr|null|false</info>  属性が置換された場合は置換前のノード、古い属性がない場合は <info>null</info> を返します。
                      <info>DOM_WRONG_DOCUMENT_ERR</info> エラーが発生した場合、 かつ strictErrorChecking が
                      <info>false</info> の場合には、<info>false</info> を返します。

<comment>See Also:</comment>
   * DOMElement::hasAttributeNS
   * DOMElement::getAttributeNodeNS
   * DOMElement::removeAttributeNode


id: DOMElement::setIdAttribute
type: function
doc:
<comment>Description:</comment>
  ID 型の属性を名前で宣言する
  
  ID 型となる属性を <strong>$qualifiedName</strong> で宣言します。

<comment>Param:</comment>
  <info>string</info>  <strong>$qualifiedName</strong>  属性の名前。
  <info>bool</info>    <strong>$isId</strong>           <strong>$qualifiedName</strong> を ID 型にしたい場合に <info>true</info>、 それ以外の場合に <info>false</info> を設定
                          します。

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

<comment>See Also:</comment>
   * DOMDocument::getElementById
   * DOMElement::setIdAttributeNode
   * DOMElement::setIdAttributeNS


id: DOMElement::setIdAttributeNS
type: function
doc:
<comment>Description:</comment>
  ID 型の属性をローカル名および名前空間 URI で宣言する
  
  ID 型となる属性を <strong>$qualifiedName</strong> および <strong>$namespace</strong> で宣言します。

<comment>Param:</comment>
  <info>string</info>  <strong>$namespace</strong>      属性の名前空間 URI。
  <info>string</info>  <strong>$qualifiedName</strong>  属性のローカル名。<return>prefix:tagname</return> 形式。
  <info>bool</info>    <strong>$isId</strong>           <strong>$name</strong> を ID 型にしたい場合に <info>true</info>、 それ以外の場合に <info>false</info> を設定します。

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

<comment>See Also:</comment>
   * DOMDocument::getElementById
   * DOMElement::setIdAttribute
   * DOMElement::setIdAttributeNode


id: DOMElement::setIdAttributeNode
type: function
doc:
<comment>Description:</comment>
  ID 型の属性をノードで宣言する
  
  ID 型となる属性 <strong>$attr</strong> を宣言します。

<comment>Param:</comment>
  <info>DOMAttr</info>  <strong>$attr</strong>  属性ノード。
  <info>bool</info>     <strong>$isId</strong>  <strong>$name</strong> を ID 型にしたい場合に <info>true</info>、 それ以外の場合に <info>false</info> を設定します。

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

<comment>See Also:</comment>
   * DOMDocument::getElementById
   * DOMElement::setIdAttribute
   * DOMElement::setIdAttributeNS


id: DOMElement::toggleAttribute
type: function
doc:
<comment>Description:</comment>
  属性の値を切り替える
  
  属性の値を切り替えます。

<comment>Param:</comment>
  <info>string</info>     <strong>$qualifiedName</strong>  属性の修飾名
  <info>bool|null</info>  <strong>$force</strong>          <info>null</info> を指定すると、この関数は属性の値を切り替えます<info>true</info> を指定すると、
                             この関数は属性の値を追加します<info>false</info> を指定すると、この関数は属性を削除
                             します

<comment>Return:</comment>
  <info>bool</info>  この関数をコールした後、属性が存在していれば <info>true</info> を返します。 そうでない場合、<info>false</info> を返し
        ます。


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

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  エンティティ参照の名前。

<comment>See Also:</comment>
   * DOMDocument::createEntityReference


id: DOMImplementation
type: class
doc:
<comment>Description:</comment>
  <class>DOMImplementation</class> クラスは、 個々のドキュメントオブジェクトモデルのインスタンス独自の操作を行うた
  めのメソッド群を提供します。


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


id: DOMImplementation::createDocument
type: function
doc:
<comment>Description:</comment>
  指定した型とドキュメント要素の DOMDocument オブジェクトを作成する
    
  
  指定した型とドキュメント要素の <class>DOMDocument</class> オブジェクトを作成します。

<comment>Param:</comment>
  <info>string|null</info>           <strong>$namespace</strong>      作成するドキュメント要素の名前空間 URI。
  <info>string</info>                <strong>$qualifiedName</strong>  作成するドキュメント要素の修飾名。
  <info>DOMDocumentType|null</info>  <strong>$doctype</strong>        作成するドキュメントの型、あるいは <info>null</info>。

<comment>Return:</comment>
  <info>DOMDocument|false</info>  新しい <class>DOMDocument</class> オブジェクトを返します。 エラーの場合は <info>false</info> を返します。
                     <strong>$namespace</strong>、<strong>$qualifiedName</strong> および <strong>$doctype</strong> が null の場合は、 ドキュメント要素
                     を含まない空の <class>DOMDocument</class> を返します。

<comment>See Also:</comment>
   * DOMDocument::__construct
   * DOMImplementation::createDocumentType


id: DOMImplementation::createDocumentType
type: function
doc:
<comment>Description:</comment>
  空の DOMDocumentType オブジェクトを作成する
    
  
  空の <class>DOMDocumentType</class> オブジェクトを作成します。 エンティティ宣言および記法は使用可能にはなりませ
  ん。エンティティ参照の 展開やデフォルト属性の追加は発生しません。

<comment>Param:</comment>
  <info>string</info>  <strong>$qualifiedName</strong>  作成されるドキュメント型の修飾名。
  <info>string</info>  <strong>$publicId</strong>       外部サブセットの公開 ID。
  <info>string</info>  <strong>$systemId</strong>       外部サブセットのシステム ID。

<comment>Return:</comment>
  <info>DOMDocumentType|false</info>  <return>ownerDocument</return> を <info>null</info> に設定した 新しい <class>DOMDocumentType</class> ノードを返します。
                         エラーの場合は <info>false</info> を返します。

<comment>See Also:</comment>
   * DOMImplementation::createDocument


id: DOMImplementation::hasFeature
type: function
doc:
<comment>Description:</comment>
  DOM 実装が、指定した機能を実装しているかどうかを調べる
    
  
  DOM 実装が、指定した機能 <strong>$feature</strong> を実装しているかどうかを調べます。
  
  DOM 仕様の Conformance の節に、すべての機能の一覧があります。

<comment>Param:</comment>
  <info>string</info>  <strong>$feature</strong>  調べる機能。
  <info>string</info>  <strong>$version</strong>  調べる <strong>$feature</strong> のバージョン番号。 DOM level 2 においては、これは <return>2.0</return> あるいは
                    <return>1.0</return> のいずれかです。

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

<comment>See Also:</comment>
   * DOMNode::isSupported


id: DOMNamedNodeMap::count
type: function
doc:
<comment>Description:</comment>
  マップにあるノードの数を取得する
  
  マップにあるノードの数を取得します。

<comment>Return:</comment>
  <info>int</info>  マップにあるノードの数を返します。これは length プロパティと等しくなります。


id: DOMNamedNodeMap::getIterator
type: function
doc:
<comment>Description:</comment>
  外部のイテレータを取得する
  
  名前付きノードのマップ向けに、外部のイテレータを返します。

<comment>Return:</comment>
  <info>Iterator</info>  <class>Iterator</class> あるいは <class>Traversable</class> を実装したオブジェクトのインスタンスを返します。

<comment>See Also:</comment>
   * IteratorAggregate::getIterator


id: DOMNamedNodeMap::getNamedItem
type: function
doc:
<comment>Description:</comment>
  名前で指定されたノードを取得する
    
  
  <return>nodeName</return> で指定されたノードを取得します。

<comment>Param:</comment>
  <info>string</info>  <strong>$qualifiedName</strong>  取得するノードの名前。

<comment>Return:</comment>
  <info>DOMNode|null</info>  指定した (任意の型の) <return>nodeName</return> のノード、 あるいはノードが見つからなかった場合には
                <info>null</info> を返します。

<comment>See Also:</comment>
   * DOMNamedNodeMap::getNamedItemNS


id: DOMNamedNodeMap::getNamedItemNS
type: function
doc:
<comment>Description:</comment>
  ローカル名および名前空間 URI で指定したノードを取得する
    
  
  <strong>$localName</strong> および <strong>$namespace</strong> で指定したノードを取得します。

<comment>Param:</comment>
  <info>string|null</info>  <strong>$namespace</strong>  取得するノードの名前空間 URI。
  <info>string</info>       <strong>$localName</strong>  取得するノードのローカル名。

<comment>Return:</comment>
  <info>DOMNode|null</info>  指定した (任意の型の) ローカル名および名前空間 URI のノード、 あるいはノードが見つか
                らなかった場合には <info>null</info> を返します。

<comment>See Also:</comment>
   * DOMNamedNodeMap::getNamedItem


id: DOMNamedNodeMap::item
type: function
doc:
<comment>Description:</comment>
  インデックスで指定したノードを取得する
  
  <class>DOMNamedNodeMap</class> オブジェクトから、 <strong>$index</strong> で指定したノードを取得します。

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  マップ内のインデックス。

<comment>Return:</comment>
  <info>DOMNode|null</info>  マップ内の <strong>$index</strong> 番目の位置にあるノード、 あるいはインデックスが不正な形式 (マップ
                内の要素数以上) の場合は <info>null</info> を返します。


id: DOMNode::C14N
type: function
doc:
<comment>Description:</comment>
  ノードを文字列に正規化する
  
  ノードを文字列に正規化します。

<comment>Param:</comment>
  <info>bool</info>        <strong>$exclusive</strong>     指定した xpath あるいは名前空間プレフィックスにマッチするノードだけを対
                             象としたパースを有効にする。
  <info>bool</info>        <strong>$withComments</strong>  コメントを残して出力する。
  <info>array|null</info>  <strong>$xpath</strong>         ノードを絞り込むための <return>xpath</return> の配列。
  <info>array|null</info>  <strong>$nsPrefixes</strong>    ノードを絞り込むための名前空間プレフィックスの配列。

<comment>Return:</comment>
  <info>string|false</info>  正規化したノードを文字列で返します。 失敗した場合に <info>false</info> を返します

<comment>See Also:</comment>
   * DOMNode::C14NFile


id: DOMNode::C14NFile
type: function
doc:
<comment>Description:</comment>
  ノードをファイルに正規化する
  
  ノードをファイルに正規化します。

<comment>Param:</comment>
  <info>string</info>      <strong>$uri</strong>           出力を書き出すパス。
  <info>bool</info>        <strong>$exclusive</strong>     指定した xpath あるいは名前空間プレフィックスにマッチするノードだけを対
                             象としたパースを有効にする。
  <info>bool</info>        <strong>$withComments</strong>  コメントを残して出力する。
  <info>array|null</info>  <strong>$xpath</strong>         ノードを絞り込むための <return>xpath</return> の配列。
  <info>array|null</info>  <strong>$nsPrefixes</strong>    ノードを絞り込むための名前空間プレフィックスの配列。

<comment>Return:</comment>
  <info>int|false</info>  書き込んだバイト数を返します。 失敗した場合に <info>false</info> を返します

<comment>See Also:</comment>
   * DOMNode::C14N


id: DOMNode::appendChild
type: function
doc:
<comment>Description:</comment>
  子要素群の最後に新しい子要素を追加する
    
  
  この関数は、既存の子要素のリストに新しい子要素を追加するか、 あるいは新しい子要素リストを作成しま
  す。子要素の作成には DOMDocument::createElement、 DOMDocument::createTextNode などを使用するか、単
  に別のノードを使用します。
  
  既存のノードを使う場合、そのノードは移動します。

<comment>Param:</comment>
  <info>DOMNode</info>  <strong>$node</strong>  追加する子要素。

<comment>Return:</comment>
  <info>DOMNode|false</info>  追加したノードを返します。 エラーの場合は <info>false</info> を返します。

<comment>See Also:</comment>
   * DOMChildNode::after
   * DOMNode::insertBefore
   * DOMNode::removeChild
   * DOMNode::replaceChild


id: DOMNode::cloneNode
type: function
doc:
<comment>Description:</comment>
  ノードを複製する
    
  
  ノードのコピーを作成します。

<comment>Param:</comment>
  <info>bool</info>  <strong>$deep</strong>  子孫要素を含めてコピーするかどうかを指定します。 このパラメータのデフォルト値は <info>false</info>
               です。

<comment>Return:</comment>
  <info>DOMNode|false</info>  複製されたノードを返します。


id: DOMNode::contains
type: function
doc:
<comment>Description:</comment>
  ノードが別のノードを含んでいるかを調べる
  
  ノードが <strong>$other</strong> ノードを含んでいるかを調べます。

<comment>Param:</comment>
  <info>DOMNode|DOMNameSpaceNode|null</info>  <strong>$other</strong>  調べるノード

<comment>Return:</comment>
  <info>bool</info>  ノードが <strong>$other</strong> ノードを含んでいる場合 <info>true</info> を返します。そうでない場合に <info>false</info> を返します。


id: DOMNode::getLineNo
type: function
doc:
<comment>Description:</comment>
  ノードが存在する行の番号を取得します。
  
  ノードが定義された行の番号を取得します。

<comment>Return:</comment>
  <info>int</info>  常にノードが定義された行の番号を返します。


id: DOMNode::getNodePath
type: function
doc:
<comment>Description:</comment>
  ノードの XPath を取得する
  
  ノードの XPath ロケーションパスを取得します。

<comment>Return:</comment>
  <info>string|null</info>  XPath を含む文字列、あるいはエラー時に <info>null</info> を返します。

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


id: DOMNode::getRootNode
type: function
doc:
<comment>Description:</comment>
  ルート(根)ノードを取得する
  
  ルート(根)ノードを取得します。

<comment>Param:</comment>
  <info>array</info>  <strong>$options</strong>  このパラメータにはまだ意味がありません

<comment>Return:</comment>
  <info>DOMNode</info>  ルート(根)ノードを返します。


id: DOMNode::hasAttributes
type: function
doc:
<comment>Description:</comment>
  ノードが属性を保持しているかどうかを調べる
    
  
  このメソッドは、ノードが属性を保持しているかどうかを調べます。 調べるノードは <info>XML_ELEMENT_NODE</info> で
  ある必要があります。

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

<comment>See Also:</comment>
   * DOMNode::hasChildNodes


id: DOMNode::hasChildNodes
type: function
doc:
<comment>Description:</comment>
  ノードが子を保持しているかどうかを調べる
    
  
  この関数は、ノードが子を保持しているかどうかを調べます。

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

<comment>See Also:</comment>
   * DOMNode::hasAttributes


id: DOMNode::insertBefore
type: function
doc:
<comment>Description:</comment>
  参照しているノードの前に新しい子を追加する
    
  
  この関数は、参照しているノードの直前に新しいノードを挿入します。 追加するノードに対して変更を加え
  たい場合は、この関数から返される ノードを使用します。
  
  既存のノードを使う場合、そのノードは移動します。

<comment>Param:</comment>
  <info>DOMNode</info>       <strong>$node</strong>   新しいノード。
  <info>DOMNode|null</info>  <strong>$child</strong>  参照ノード。指定されなかった場合は、<strong>$node</strong> が子要素として追加されます。

<comment>Return:</comment>
  <info>DOMNode|false</info>  挿入されたノードを返します。 エラーの場合は <info>false</info> を返します。

<comment>See Also:</comment>
   * DOMNode::appendChild


id: DOMNode::isDefaultNamespace
type: function
doc:
<comment>Description:</comment>
  指定した namespaceURI がデフォルトの名前空間かどうかを調べる
  
  <strong>$namespace</strong> がデフォルトの名前空間であるかどうかを調べます。

<comment>Param:</comment>
  <info>string</info>  <strong>$namespace</strong>  調べる名前空間 URI。

<comment>Return:</comment>
  <info>bool</info>  <strong>$namespace</strong> がデフォルトの名前空間である場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。


id: DOMNode::isEqualNode
type: function
doc:
<comment>Description:</comment>
  ノードが等しいかを調べる
  
  ノードが等しいかを調べます。

<comment>Param:</comment>
  <info>DOMNode|null</info>  <strong>$otherNode</strong>  ノード

<comment>Return:</comment>
  <info>bool</info>  双方のノードが等しい場合 <info>true</info> を返します。 そうでない場合、<info>false</info> を返します。


id: DOMNode::isSameNode
type: function
doc:
<comment>Description:</comment>
  2 つのノードが等しいかどうかを調べる
    
  
  この関数は、2 つのノードが等しいかどうかを調べます。この比較は、 その内容に基づくものではありませ
  ん。

<comment>Param:</comment>
  <info>DOMNode</info>  <strong>$otherNode</strong>  比較対象となるノード。

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


id: DOMNode::isSupported
type: function
doc:
<comment>Description:</comment>
  指定したバージョンで機能がサポートされているかどうかを調べる
    
  
  指定したバージョン <strong>$version</strong> で、機能 <strong>$feature</strong> がサポートされているかどうかを調べます。

<comment>Param:</comment>
  <info>string</info>  <strong>$feature</strong>  調べる機能。機能の一覧については DOMImplementation::hasFeature の例を参照くださ
                    い。
  <info>string</info>  <strong>$version</strong>  調べる機能 <strong>$feature</strong> のバージョン番号。

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

<comment>See Also:</comment>
   * DOMImplementation::hasFeature


id: DOMNode::lookupNamespaceURI
type: function
doc:
<comment>Description:</comment>
  プレフィックスに基づいて、ノードの名前空間 URI を取得する
    
  
  <strong>$prefix</strong> に基づいて、 ノードの名前空間 URI を取得します。

<comment>Param:</comment>
  <info>string|null</info>  <strong>$prefix</strong>  探す名前空間のプレフィックス。 <info>null</info> を指定した場合、デフォルトの名前空間
                        URIを返します。 但し、存在する場合に限ります。

<comment>Return:</comment>
  <info>string|null</info>  関連する名前空間 URI を返します。 見つからなかった場合は <info>null</info> を返します。

<comment>See Also:</comment>
   * DOMNode::lookupPrefix


id: DOMNode::lookupPrefix
type: function
doc:
<comment>Description:</comment>
  名前空間 URI に基づいて、ノードの名前空間プレフィックスを取得する
    
  
  名前空間 URI に基づいて、ノードの名前空間プレフィックスを取得します。

<comment>Param:</comment>
  <info>string</info>  <strong>$namespace</strong>  名前空間 URI。

<comment>Return:</comment>
  <info>string|null</info>  名前空間のプレフィックスを返します。 エラーの場合は <info>null</info> を返します。

<comment>See Also:</comment>
   * DOMNode::lookupNamespaceUri


id: DOMNode::normalize
type: function
doc:
<comment>Description:</comment>
  ノードを正規化する
    
  
  空のテキストノードを削除し、このノードに隣接するテキストノードとそのすべての子をマージします。

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

<comment>See Also:</comment>
   * The DOM Specification
   * DOMDocument::normalizeDocument


id: DOMNode::removeChild
type: function
doc:
<comment>Description:</comment>
  子要素群から子要素を削除する
    
  
  この関数は、子要素群から子要素を削除します。

<comment>Param:</comment>
  <info>DOMNode</info>  <strong>$child</strong>  削除する子要素。

<comment>Return:</comment>
  <info>DOMNode|false</info>  子要素の削除に成功した場合に、削除した要素を返します。 エラーの場合は <info>false</info> を返し
                 ます。

<comment>See Also:</comment>
   * DOMChildNode::remove
   * DOMNode::appendChild
   * DOMNode::replaceChild


id: DOMNode::replaceChild
type: function
doc:
<comment>Description:</comment>
  子を置き換える
    
  
  この関数は、子要素 <strong>$child</strong> を新しいノードに 置き換えます。もし <strong>$node</strong> がすでに子要素であった場合は、
  それがふたたび追加されることはありません。置き換えに成功すると、 置き換え前のノードが返されます。

<comment>Param:</comment>
  <info>DOMNode</info>  <strong>$node</strong>   新しいノード。対象ドキュメントのメンバ、 すなわち、DOMDocument-&gt;createXXX() メ
                   ソッドのひとつで作成されたものか  で ドキュメントにインポートされたものである必要
                   があります。
  <info>DOMNode</info>  <strong>$child</strong>  古いノード。

<comment>Return:</comment>
  <info>DOMNode|false</info>  古いノード、あるいはエラーが発生した場合は <info>false</info> を返します。

<comment>See Also:</comment>
   * DOMChildNode::replaceWith
   * DOMNode::appendChild
   * DOMNode::removeChild


id: DOMNodeList::count
type: function
doc:
<comment>Description:</comment>
  リストにあるノードの数を取得する
  
  リストにあるノードの数を取得します。

<comment>Return:</comment>
  <info>int</info>  リストにあるノードの数を返します。 これは length プロパティに等しくなります。


id: DOMNodeList::getIterator
type: function
doc:
<comment>Description:</comment>
  外部のイテレータを取得する
  
  ノードリスト向けの、外部イテレータを返します。

<comment>Return:</comment>
  <info>Iterator</info>  <class>Iterator</class> あるいは <class>Traversable</class> を実装したオブジェクトのインスタンスを返します。

<comment>See Also:</comment>
   * IteratorAggregate::getIterator


id: DOMNodelist::item
type: function
doc:
<comment>Description:</comment>
  インデックスで指定したノードを取得する
    
  
  <class>DOMNodeList</class> オブジェクトから、 <strong>$index</strong> で指定したノードを取得します。
  
  コレクション内のノードの数を知るには、 <class>DOMNodeList</class> オブジェクトの <return>length</return> プロパティを使用します。

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  コレクション内のノードのインデックス。

<comment>Return:</comment>
  <info>DOMElement|DOMNode|DOMNameSpaceNode|null</info>  <class>DOMNodeList</class> 内の <strong>$index</strong> 番目の位置にあるノード、あるいは
                                            インデックスが不正な形式の場合は <info>null</info> を返します。


id: DOMParentNode::append
type: function
doc:
<comment>Description:</comment>
  最後の子ノードの後ろにノードを追加する
  
  ひとつ以上の <strong>$nodes</strong> を、 最後の子ノードの後ろの、子ノードのリストに追加します。

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  追加するノード。 文字列は自動的にテキストノードに変換されます。

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

<comment>See Also:</comment>
   * DOMParentNode::prepend


id: DOMParentNode::prepend
type: function
doc:
<comment>Description:</comment>
  最初の子ノードの前にノードを追加する
  
  ひとつ以上の <strong>$nodes</strong> を、 最初の子ノードの前の、 子ノードのリストに追加します。

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  ノードの前に追加するノード。 文字列は自動的にテキストノードに変換されま
                          す。

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

<comment>See Also:</comment>
   * DOMParentNode::append


id: DOMParentNode::replaceChildren
type: function
doc:
<comment>Description:</comment>
  ノード中の子を置換する
  
  ノード中の子を置換します。

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  子を置き換えるノード 文字列は自動的にテキストノードに変換されます。

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


id: DOMProcessingInstruction::__construct
type: function
doc:
<comment>Description:</comment>
  新しい DOMProcessingInstruction オブジェクトを作成する
    
  
  新しい <class>DOMProcessingInstruction</class> オブジェクトを 作成します。このオブジェクトは読み込み専用です。こ
  のオブジェクトを ドキュメントに追加することは可能ですが、ノードをドキュメントに 関連付けるまではこ
  のノードに別のノードを追加することはできません。 書き込み可能なノードを作成するには、  を使用して
  ください。

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>   処理命令のタグ名。
  <info>string</info>  <strong>$value</strong>  処理命令の値。

<comment>See Also:</comment>
   * DOMDocument::createProcessingInstruction


id: DOMText
type: class
doc:
<comment>Description:</comment>
  <class>DOMText</class> クラスは <class>DOMCharacterData</class> を継承しており、 <class>DOMElement</class> あるいは <class>DOMAttr</class> の中身のテキストを
  表します。


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

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  text ノードの値。指定しなかった場合は空の text ノードが作成されます。

<comment>See Also:</comment>
   * DOMDocument::createTextNode


id: DOMText::isElementContentWhitespace
type: function
doc:
<comment>Description:</comment>
  このテキストノードが、要素の内容にホワイトスペースが含まれているかを返す

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


id: DOMText::isWhitespaceInElementContent
type: function
doc:
<comment>Description:</comment>
  このテキストノードが空白を含むかどうかを示す
    
  
  このテキストノードが空白のみを含む（あるいは空である）かどうかを示します。 このテキストノードが要
  素の内容に空白を含むかどうかは、 ドキュメントの読み込み時に決定されます。

<comment>Return:</comment>
  <info>bool</info>  ノードにゼロ個以上の空白文字だけが含まれる場合に <info>true</info>、 それ以外の場合に <info>false</info> を返します。


id: DOMText::splitText
type: function
doc:
<comment>Description:</comment>
  指定したオフセットでノードを 2 つに分割する
    
  
  指定したオフセット <strong>$offset</strong> でノードを 2 つに分割します。分割したノードのツリー内での位置関係は、兄
  弟となります。
  
  分割した後は、このノードは <strong>$offset</strong> 位置までの 内容を保持するようになります。元のノードが親ノードを
  保持している場合、 新しいノードは元のノードの兄弟として元のノードの次の位置に挿入されます。
  <strong>$offset</strong> がこのノードの長さに等しい場合は、 新しいノードにはデータが含まれません。

<comment>Param:</comment>
  <info>int</info>  <strong>$offset</strong>  分割する位置を示すオフセット。0 から始まります。

<comment>Return:</comment>
  <info>DOMText|false</info>  同じ型の新しいノードを返します。<strong>$offset</strong> 以降の内容をデータとして保持します。


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

<comment>Param:</comment>
  <info>DOMDocument</info>  <strong>$document</strong>  <class>DOMXPath</class> に関連付けられた <class>DOMDocument</class>。


id: DOMXPath::evaluate
type: function
doc:
<comment>Description:</comment>
  与えられた XPath 式を評価し、可能であれば結果を返す
    
  
  与えられた XPath 式 <strong>$expression</strong> を実行し、 可能であれば型付けされた結果を返します。

<comment>Param:</comment>
  <info>string</info>        <strong>$expression</strong>      実行する XPath 式。
  <info>DOMNode|null</info>  <strong>$contextNode</strong>     相対 XPath クエリを実行する場合に、オプションで基準ノードを指定する
                                 ことが可能です。 デフォルトでは、クエリは root 要素に対する相対パス
                                 となります。
  <info>bool</info>          <strong>$registerNodeNS</strong>  オプションの <strong>$registerNodeNS</strong> で、 コンテキストノードの自動登録を無
                                 効にすることができます。

<comment>Return:</comment>
  <info>mixed</info>  可能であれば型付けされた結果、あるいは指定された XPath 式 <strong>$expression</strong> にマッチするすべての
         ノードを含む <class>DOMNodeList</class> を返します。
         
         <strong>$expression</strong> が不正な形式な場合や <strong>$contextNode</strong> が無効な場合は、 DOMXPath::evaluate は <info>false</info>
         を返します。

<comment>See Also:</comment>
   * DOMXPath::query


id: DOMXPath::query
type: function
doc:
<comment>Description:</comment>
  与えられた XPath 式を評価する
    
  
  与えられた XPath 式 <strong>$expression</strong> を評価します。

<comment>Param:</comment>
  <info>string</info>        <strong>$expression</strong>      実行する XPath 式。
  <info>DOMNode|null</info>  <strong>$contextNode</strong>     相対 XPath クエリを実行する場合に、オプションで基準ノードを指定する
                                 ことが可能です。 デフォルトでは、クエリは root 要素に対する相対パス
                                 となります。
  <info>bool</info>          <strong>$registerNodeNS</strong>  オプションの <strong>$registerNodeNS</strong> で、 コンテキストノードの自動登録を無
                                 効にすることができます。

<comment>Return:</comment>
  <info>mixed</info>  与えられた XPath 式 <strong>$expression</strong> にマッチする すべてのノードを含む <class>DOMNodeList</class> を返します。
         ノードを返さない式の場合は、空の <class>DOMNodeList</class> を返します。
         
         <strong>$expression</strong> が不正な形式な場合や <strong>$contextNode</strong> が無効な場合は、 DOMXPath::query は <info>false</info> を
         返します。

<comment>See Also:</comment>
   * DOMXPath::evaluate


id: DOMXPath::registerNamespace
type: function
doc:
<comment>Description:</comment>
  DOMXPath オブジェクトの名前空間を登録する
    
  
  DOMXPath オブジェクトに、 <strong>$namespace</strong> および <strong>$prefix</strong> を登録します。

<comment>Param:</comment>
  <info>string</info>  <strong>$prefix</strong>     プレフィックス。
  <info>string</info>  <strong>$namespace</strong>  名前空間の URI。

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


id: DOMXPath::registerPhpFunctions
type: function
doc:
<comment>Description:</comment>
  PHP の関数を XPath 関数として登録する
  
  このメソッドは、PHP の関数を XPath 式の中で使えるようにします。

<comment>Param:</comment>
  <info>string|array|null</info>  <strong>$restrict</strong>  このパラメータを使って、特定の関数のみを XPath からコールできるよう
                                に制限することができます。
                                
                                このパラメータには、文字列 (関数名) あるいは関数名の配列を指定しま
                                す。

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

<comment>See Also:</comment>
   * DOMXPath::registerNamespace
   * DOMXPath::query
   * DOMXPath::evaluate


id: DOM_VALIDATION_ERR
type: constant
doc:
<comment>Description:</comment>
  insertBefore や removeChild のようなメソッドのコールによってノードの 「部分的な妥当性」が満たされ
  なくなった際にこの例外が発生し、操作は 行われません。


id: DatabaseObject::existsInDatabase
type: function
doc:
<comment>Description:</comment>
  オブジェクトがデータベースに存在するかをチェックする
  
  データベースオブジェクトが、データベース内に存在するオブジェクトを参照しているかを調べます。

<comment>Return:</comment>
  <info>bool</info>  オブジェクトがデータベースに存在していれば <info>true</info> を返します。 そうでなければ、<info>false</info> を返しま
        す。


id: DatabaseObject::getName
type: function
doc:
<comment>Description:</comment>
  オブジェクトの名前を取得する
  
  このデータベースオブジェクトの名前を取得します。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>string</info>  データベースオブジェクトの名前を返します。


id: DatabaseObject::getSession
type: function
doc:
<comment>Description:</comment>
  セッションの名前を取得する
  
  データベースオブジェクトに紐付いたセッションを取得します。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>mysql_xdevapi\Session</info>  Session オブジェクトを返します。


id: DateInterval
type: class
doc:
<comment>Description:</comment>
  日付の間隔をあらわします。
  
  格納方式は、固定値 (年、月、日、時など) あるいは相対時刻 (<class>DateTimeImmutable</class> と <class>DateTime</class> のコンスト
  ラクタがサポートしている書式) となります。
  
  さらに厳密に言うと、 <class>DateInterval</class> オブジェクトが保持している情報は、 ある date/time オブジェクトか
  ら別の date/time オブジェクトに情報を移す手順です。 この過程は必ずしも可逆ではありません。
  
  <class>DateInterval</class> オブジェクトを生成する一般的なやり方は、 2つの date/time オブジェクトの差分を
  DateTimeInterface::diff 経由で計算することです。
  
  日付の間隔を比較する良い方法は定義されていません。 よって、<class>DateInterval</class> のインスタンスは 比較でき
  ません。


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

<comment>Param:</comment>
  <info>string</info>  <strong>$duration</strong>  間隔。
                     
                     最初は <return>P</return> から始まります。これは period を表します。 間隔の単位は、整数値の後に
                     間隔指示子をつけて表します。 時間の要素を含む場合は、時間部分の前に文字 <return>T</return> を入
                     れます。
                     
                     <strong>$duration</strong> の間隔指示子 間隔指示子説明<return>Y</return>年<return>M</return>月<return>D</return>日<return>W</return> 週。日付に変換されます。 PHP
                     8.0.0 より前のバージョンでは、 <return>D</return> と組み合わせて使えませんでした。 <return>H</return>時間<return>M</return>分<return>S</return>秒
                     
                     いくつか簡単な例を示しましょう。 <return>P2D</return> は 2 日、 <return>PT2S</return> は 2 秒、そして <return>P6YT5M</return> は 6
                     年と 5 分を表します。
                     
                     複数の単位を指定するときは、 大きな単位を左、小さな単位を右の順に書かなければな
                     りません。 つまり年は月より先、月は日より先、日は分より先などとなります。 1 年
                     と 4 日を表すのは <return>P1Y4D</return> であり、<return>P4D1Y</return> ではありません。
                     
                     日付と時刻で間隔を指定することもできます。 1 年と 4 日をこの方式で表すと
                     <return>P0001-00-04T00:00:00</return> のようになります。 しかし、この方式では繰り返し単位以上の
                     値を指定することはできません (たとえば <return>25</return> 時間などとは指定できません)。
                     
                     これらのフォーマットは ISO 8601 duration specification に基づくものです。

<comment>See Also:</comment>
   * <strong>DateInterval::format()</strong>
   * <strong>DateTime::add()</strong>
   * <strong>DateTime::sub()</strong>
   * <strong>DateTime::diff()</strong>


id: DateInterval::createFromDateString
type: function
doc:
<comment>Description:</comment>
  相対指定文字列から DateInterval を作成する
  
  オブジェクト指向型
  
  手続き型
  
  <class>DateTimeImmutable</class> のコンストラクタで使われている日付パーサを用いて、パースされた相対指定文字列から
  <class>DateInterval</class> を作成します。

<comment>Param:</comment>
  <info>string</info>  <strong>$datetime</strong>  相対部分を含む日付。 特に、<strong>strtotime()</strong> や <class>DateTimeImmutable</class>、 <class>DateTime</class> が使う
                     パーサーがサポートする 相対書式 を使って DateInterval を作ることができます。
                     
                     <return>P7D</return> のような ISO-8601 フォーマットの文字列を使うには、 DateInterval のコンスト
                     ラクタを使わなければいけません。

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


id: DateInterval::format
type: function
doc:
<comment>Description:</comment>
  間隔をフォーマットする
  
  間隔をフォーマットします。

<comment>Param:</comment>
  <info>string</info>  <strong>$format</strong>   次の文字を、 <strong>$format</strong> パラメータ文字列に使用することができます。 フォーマット文字
                   は、パーセント記号 (<return>%</return>) で始めなければなりません。 <strong>$format</strong> 文字説明値の例<return>%</return>リテラル
                   としての <return>%</return><return>%</return><return>Y</return>年、数値、先頭に 0 を含む 2 桁<return>01</return>, <return>03</return><return>y</return>年、数値<return>1</return>, <return>3</return><return>M</return>月、数値、先頭に 0
                   を含む 2 桁<return>01</return>, <return>03</return>, <return>12</return><return>m</return>月、数値<return>1</return>, <return>3</return>, <return>12</return><return>D</return>日、数値、先頭に 0 を含む 2 桁<return>01</return>, <return>03</return>,
                   <return>31</return><return>d</return>日、数値<return>1</return>, <return>3</return>, <return>31</return><return>a</return>DateTime::diff の結果に使った場合は総日数、それ以外の場合は
                   <return>(unknown)</return><return>4</return>, <return>18</return>, <return>8123</return><return>H</return>時間、数値、先頭に 0 を含む 2 桁<return>01</return>, <return>03</return>, <return>23</return><return>h</return>時間、数値<return>1</return>, <return>3</return>,
                   <return>23</return><return>I</return>分、数値、先頭に 0 を含む 2 桁<return>01</return>, <return>03</return>, <return>59</return><return>i</return>分、数値<return>1</return>, <return>3</return>, <return>59</return><return>S</return>秒、数値、先頭に 0
                   を含む 2 桁<return>01</return>, <return>03</return>, <return>57</return><return>s</return>秒、数値<return>1</return>, <return>3</return>, <return>57</return><return>F</return>マイクロ秒、少なくとも6桁。足りない分は先
                   頭が0埋めされます。 <return>007701</return>, <return>052738</return>, <return>428291</return><return>f</return>マイクロ秒、数値<return>7701</return>, <return>52738</return>, <return>428291</return><return>R</return>負
                   の値の場合は "<return>-</return>"、正の値の場合は "<return>+</return>"<return>-</return>, <return>+</return><return>r</return>負の値の場合は "<return>-</return>"、正の値の場合は空文字
                   <return>-</return>,

<comment>Return:</comment>
  <info>string</info>  フォーマットされた間隔を返します。

<comment>See Also:</comment>
   * DateTime::diff


id: DatePeriod::__construct
type: function
doc:
<comment>Description:</comment>
  新しい DatePeriod オブジェクトを作成する
  
  このコンストラクタのバリエーションは、推奨されなくなりました。 代わりに、
  DatePeriod::createFromISO8601String を使いましょう。
  
  新しい DatePeriod オブジェクトを作成します。
  
  <class>DatePeriod</class> オブジェクトは、 たくさんの <class>DateTimeImmutable</class> や <class>DateTime</class> を生成するイテレータとして使
  えます。 パラメータ <strong>$start</strong>, <strong>$interval</strong>, <strong>$end</strong>, および <strong>$recurrences</strong> の数を指定できます。
  
  返されるオブジェクトのクラスは、 <strong>$start</strong> の祖先になるオブジェクトで、 <class>DateTimeImmutable</class> や <class>DateTime</class>
  に等しくなります。

<comment>Param:</comment>
  <info>DateTimeInterface</info>  <strong>$start</strong>        期間の開始日。デフォルトでは、 結果セットに含まれています。
  <info>DateInterval</info>       <strong>$interval</strong>     期間内での発生間隔。
  <info>int</info>                <strong>$recurrences</strong>  反復回数。 返される結果の数は、この値よりひとつ大きくなります。
                                   なぜなら、デフォルトでは結果セットに開始日が含まれているからで
                                   す。 <return>0</return> より大きな値でなければいけません。
  <info>DateTimeInterface</info>  <strong>$end</strong>          期間の終了日。 デフォルトでは、結果セットから除外されています。
  <info>string</info>             <strong>$isostr</strong>       ISO 8601 repeating interval specification のサブセットを指定しま
                                   す。
                                   
                                   PHP がサポートしていない、サブセットの機能の例を以下に示します:
                                   
                                   0回の繰り返し (<return>R0/</return>)
                                   
                                   UTC 以外の時間のオフセット(<return>Z</return>)。 たとえば <return>+02:00</return> のようなもので
                                   す。
  <info>int</info>                <strong>$options</strong>      開始日と終了日に関する振る舞いを制御するビットフィールド
                                   
                                   <info>DatePeriod::EXCLUDE_START_DATE</info> を指定すると、開始日を期間の結果
                                   セットから除外できます。
                                   
                                   <info>DatePeriod::INCLUDE_END_DATE</info> を指定すると、終了日を期間の結果セッ
                                   トに含めることができます。


id: DatePeriod::createFromISO8601String
type: function
doc:
<comment>Description:</comment>
  ISO8601 形式の文字列から、新しい DatePeriod オブジェクトを作成する
  
  ISO8601 形式の文字列から、<strong>$specification</strong> の指定に従い、新しい DatePeriod オブジェクトを作成しま
  す。

<comment>Param:</comment>
  <info>string</info>  <strong>$specification</strong>  ISO 8601 repeating interval specification のサブセットを指定します。
                          
                          有効な ISO8601 形式の期間指定のサンプルとして、 　
                          <return>R5/2008-03-01T13:00:00Z/P1Y2M10DT2H30M</return> のようなものがあります。これは、以
                          下を指定しています:
                          
                          5 回繰り返す (<return>R5/</return>)
                          
                          <return>2008-03-01T13:00:00Z</return> から開始
                          
                          それぞれの繰り返しは、 1 year, 2 months, 10 days, 2 hours, 30 minute の間
                          隔を持つ。 (<return>/P1Y2M10DT2H30M</return>).
                          
                          ISO8601 形式の期間指定によっては、PHP がサポートしていないものがあります。
                          たとえば以下のようなものがあります:
                          
                          繰り返しが0回 (<return>R0/</return>)
                          
                          UTC (<return>Z</return>) 以外のタイムオフセット。 たとえば <return>+02:00</return> のようなものです。
  <info>int</info>     <strong>$options</strong>        開始日と、終了日についての振る舞いを制御するのに使うビットフィールドです。
                          
                          <info>DatePeriod::EXCLUDE_START_DATE</info> を指定すると、期間内に繰り返される集合から
                          開始日を除外できます。
                          
                          <info>DatePeriod::INCLUDE_END_DATE</info> を指定すると、期間内に繰り返される集合に終了
                          日を含めることができます。

<comment>Return:</comment>
  <info>static</info>  新しい DatePeriod オブジェクトを作成します。
          
          このメソッドを使って作成された <class>DatePeriod</class> オブジェクトは、多くの <class>DateTimeImmutable</class> オブ
          ジェクトを生成するイテレータとして使えます。


id: DatePeriod::getDateInterval
type: function
doc:
<comment>Description:</comment>
  間隔を取得する
    
  
  オブジェクト指向型
  
  期間に適用される間隔を表す <class>DateInterval</class> <info>object</info> を取得する。

<comment>Return:</comment>
  <info>DateInterval</info>  <class>DateInterval</class><info>object</info> を返す。

<comment>See Also:</comment>
   * DatePeriod::getStartDate
   * DatePeriod::getEndDate


id: DatePeriod::getEndDate
type: function
doc:
<comment>Description:</comment>
  終了日を取得する
    
  
  オブジェクト指向型
  
  期間の終了日を取得します。

<comment>Return:</comment>
  <info>DateTimeInterface|null</info>  <class>DatePeriod</class> が終了日を持たない場合は <info>null</info> を返します。 たとえば、
                          <strong>$recurrences</strong> パラメータや、終了日のない <strong>$isostr</strong> パラメータを用いて初期化さ
                          れている場合です。
                          
                          <class>DatePeriod</class> が <class>DateTimeImmutable</class> オブジェクトを <strong>$end</strong> に指定して初期化されて
                          いる場合は <class>DateTimeImmutable</class> オブジェクト を返します。
                          
                          それ以外の場合は、 終了日を表す、コピーされた <class>DateTime</class> オブジェクトを返し
                          ます。

<comment>See Also:</comment>
   * DatePeriod::getStartDate
   * DatePeriod::getDateInterval


id: DatePeriod::getRecurrences
type: function
doc:
<comment>Description:</comment>
  繰り返しの数を取得する
  
  オブジェクト指向型
  
  繰り返しの数を取得します。

<comment>Return:</comment>
  <info>int|null</info>  <class>DatePeriod</class> のコンストラクタの <return>$recurrences</return> に明示的に渡すことで設定した 繰り返しの数を返
            します。設定されていない場合、<info>null</info> を返します。

<comment>See Also:</comment>
   * DatePeriod::$recurrences


id: DatePeriod::getStartDate
type: function
doc:
<comment>Description:</comment>
  開始日を取得する
    
  
  オブジェクト指向型
  
  期間の開始日を取得する。

<comment>Return:</comment>
  <info>DateTimeInterface</info>  <class>DatePeriod</class> が <class>DateTimeImmutable</class> <info>object</info> を <strong>$start</strong> パラメータに用いて初期化されて
                     いる場合は <class>DateTimeImmutable</class> <info>object</info> を返す。
                     
                     それ例外の場合は <class>DateTime</class> <info>object</info> を返す。

<comment>See Also:</comment>
   * DatePeriod::getEndDate
   * DatePeriod::getDateInterval


id: DateTime
type: class
doc:
<comment>Description:</comment>
  日付と時刻を表現するクラスです。
  
  このクラスは、 <class>DateTimeImmutable</class> と同じ振る舞いをします。 但し、<strong>DateTime::modify()</strong> のような、 オブ
  ジェクトそのものを変更するメソッドが呼び出された時を除きます。
  
  <class>DateTime</class> クラスのメソッドをコールすると、 そのインスタンスにカプセル化された情報が変更されます。
  そうした変更を防ぎたい場合には、新しいオブジェクトを作るために <return>clone</return> 演算子を使わなければいけませ
  ん。 オブジェクトの変更を防ぐ、望ましい挙動をデフォルトで実現するには、 <class>DateTime</class> ではなく、
  <class>DateTimeImmutable</class> を使います。


id: DateTime::__construct
type: function
doc:
<comment>Description:</comment>
  新しい DateTime オブジェクトを返す
  
  DateTimeImmutable::__construct と似ていますが、 <class>DateTime</class> を用いて動作します。 <class>DateTimeImmutable</class> を
  代わりに使うことを検討して下さい。
  
  新しい DateTime オブジェクトを返します。

<comment>Param:</comment>
  <info>string</info>             <strong>$datetime</strong>  日付/時刻 文字列。有効な書式については 日付と時刻の書式 で説明してい
                                ます。
                                
                                ここに <return>"now"</return> を指定して <strong>$timezone</strong> パラメータを使うと、現在時刻を取得
                                できます。
  <info>DateTimeZone|null</info>  <strong>$timezone</strong>  <strong>$datetime</strong> のタイムゾーンを表す <class>DateTimeZone</class> オブジェクト。
                                
                                <strong>$timezone</strong> を省略した場合、または <info>null</info> の場合、 現在のタイムゾーンを
                                使います。
                                
                                <strong>$datetime</strong> パラメータが UNIX タイムスタンプ (<return>@946684800</return> など) であっ
                                たりタイムゾーンつきで指定した場合 (<return>2010-01-28T15:00:00+02:00</return> など)
                                は、 <strong>$timezone</strong> パラメータや現在のタイムゾーンは無視されます。

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

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


id: DateTime::__set_state
type: function
doc:
<comment>Description:</comment>
  __set_state ハンドラ
  
  __set_state() ハンドラを処理します。
  
  DateTimeImmutable::__set_state に似ていますが、 <class>DateTime</class> を使って動作します。

<comment>Param:</comment>
  <info>array</info>  <strong>$array</strong>  初期化配列。

<comment>Return:</comment>
  <info>DateTime</info>  新しい DateTime オブジェクトのインスタンスを返します。


id: DateTime::__wakeup
type: function
doc:
<comment>Description:</comment>
  __wakeup ハンドラ
  
  __wakeup() を処理します。

<comment>Return:</comment>
  <info>void</info>  DateTime オブジェクトを初期化します。


id: DateTime::add
type: function
doc:
<comment>Description:</comment>
  年月日時分秒の値を加えることで、DateTime オブジェクトを変更する
    
  
  オブジェクト指向型
  
  手続き型
  
  指定した <class>DateInterval</class> オブジェクトを、 指定した <class>DateTime</class> オブジェクトに加えます。
  
  DateTimeImmutable::add と似ていますが、 <class>DateTime</class> オブジェクトを使って動作します。
  
  手続き型のバージョンは、 <class>DateTime</class> を最初の引数に取ります。

<comment>Param:</comment>
  <info>DateTime</info>      <strong>$object</strong>    手続き型のみ: 
                           <strong>date_create()</strong> が返す <class>DateTime</class> オブジェクト。
                           この関数は、このオブジェクトを変更します。
  <info>DateInterval</info>  <strong>$interval</strong>  <class>DateInterval</class> オブジェクト

<comment>Return:</comment>
  <info>DateTime</info>  メソッドチェインに使う、変更された <class>DateTime</class> オブジェクトを返します。

<comment>See Also:</comment>
   * <strong>DateTimeImmutable::add()</strong>


id: DateTime::createFromFormat
type: function
doc:
<comment>Description:</comment>
  指定した書式で時刻文字列をパースする
  
  オブジェクト指向型
  
  手続き型
  
  新しい DateTime オブジェクトを返します。 このオブジェクトは、<strong>$datetime</strong> で指定した文字列を <strong>$format</strong>
  で指定した書式に沿って解釈した時刻を表します。
  
  DateTimeImmutable::createFromFormat や <strong>date_create_immutable_from_format()</strong> と似ていますが、
  <class>DateTime</class> オブジェクトを生成します。
  
  このメソッドドキュメントは、パラメータや使用例、注意点も含めて DateTimeImmutable::createFromFormat
  のページにあります。

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

<comment>See Also:</comment>
   * <strong>DateTimeImmutable::createFromFormat()</strong>


id: DateTime::createFromImmutable
type: function
doc:
<comment>Description:</comment>
  与えられた DateTimeImmutable オブジェクトをカプセル化した、新しい DateTime のインスタンスを返す

<comment>Param:</comment>
  <info>DateTimeImmutable</info>  <strong>$object</strong>  変更可能なバージョンに変換が必要な、 <class>DateTimeImmutable</class> オブジェクト。
                              このオブジェクトは変更されませんが、 代わりに同じ日付、時刻、タイム
                              ゾーンの情報を含んだ 新しい <class>DateTime</class> のインスタンスが作られます。

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


id: DateTime::createFromInterface
type: function
doc:
<comment>Description:</comment>
  指定された DateTimeInterface オブジェクトをカプセル化した、新しい DateTime オブジェクトを返す

<comment>Param:</comment>
  <info>DateTimeInterface</info>  <strong>$object</strong>  変更可能なバージョンに変換する <class>DateTimeInterface</class> オブジェクト。 このオ
                              ブジェクトは変更されませんが、 同じ日付、時刻、タイムゾーンの情報が
                              入った新しい <class>DateTime</class> オブジェクトが作成されます。

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


id: DateTime::diff
type: function
doc:
<comment>Description:</comment>
  ふたつの DateTime オブジェクトの差を返す
  
  オブジェクト指向型
  
  手続き型
  
  ふたつの DateTime オブジェクトの差を返します。

<comment>Param:</comment>
  <info></info>      <strong>$datetime</strong>  比較する日付。
  <info>bool</info>  <strong>$absolute</strong>  間隔が正の数になるようにするか否か。

<comment>Return:</comment>
  <info>DateInterval</info>  ふたつの日付の差をあらわす <class>DateInterval</class> オブジェクトを返します。
                
                さらに厳密に言うと、戻り値はもともとのオブジェクト (<strong>$this</strong> または  <strong>$originObject</strong>) を
                <strong>$targetObject</strong> にするために適用すべき経過時間の差分を示しています。 このプロセスは可
                逆とは限りません。
                
                このメソッドは夏時間の切り替えを認識するため、 <return>24 hours and 30 minutes</return> という時間差
                を返す可能性があります。 以下で例示するサンプルコードでそれを示します。 完全な時間差
                を計算したい場合、 <strong>$this</strong>/<strong>$baseObject</strong> と <strong>$targetObject</strong> をUTC に変換する必要がありま
                す。

<comment>See Also:</comment>
   * <strong>DateInterval::format()</strong>
   * <strong>DateTime::add()</strong>
   * <strong>DateTime::sub()</strong>


id: DateTime::format
type: function
doc:
<comment>Description:</comment>
  指定した書式でフォーマットした日付を返す
  
  オブジェクト指向型
  
  手続き型
  
  指定した書式でフォーマットした日付を返します。

<comment>Param:</comment>
  <info></info>        <strong>$object</strong>  手続き型のみ: <strong>date_create()</strong>
                   が返す <class>DateTime</class> オブジェクト
  <info>string</info>  <strong>$format</strong>  出力される日付文字列の書式。以下のオプションを参照ください。 定義済みの定数 も用
                   意されており、たとえば <info>DATE_RSS</info> はフォーマット文字列 <return>'D, d M Y H:i:s'</return> と同じ意味
                   になります。
                   
                   以下の文字が <strong>$format</strong> パラメータ文字列として認識されます<strong>$format</strong> 文字説明戻り値の例
                   日------<return>d</return>日。二桁の数字（先頭にゼロがつく場合も）<return>01</return> から <return>31</return><return>D</return>曜日。3文字のテキスト
                   形式。<return>Mon</return> から <return>Sun</return><return>j</return>日。先頭にゼロをつけない。<return>1</return> から <return>31</return><return>l</return> (小文字の 'L')曜日。フル
                   スペル形式。<return>Sunday</return> から <return>Saturday</return><return>N</return>ISO 8601 形式の、曜日の数値表現<return>1</return>（月曜日）から
                   <return>7</return>（日曜日）<return>S</return>英語形式の序数を表すサフィックス。2 文字。<return>st</return>, <return>nd</return>, <return>rd</return> または   <return>th</return>。
                   <return>j</return>と一緒に使用する ことができる。 <return>w</return>曜日。数値。<return>0</return> (日曜)から <return>6</return> (土曜)<return>z</return>年間の通算
                   日。数字。(ゼロから開始)<return>0</return> から <return>365</return>週------<return>W</return>ISO 8601 月曜日に始まる年単位の週番号
                   例: <return>42</return> (年の第 42 週目)月------<return>F</return>月。フルスペルの文字。<return>January</return> から <return>December</return><return>m</return>月。
                   数字。先頭にゼロをつける。<return>01</return> から <return>12</return><return>M</return>月。3 文字形式。<return>Jan</return> から <return>Dec</return><return>n</return>月。数字。先頭
                   にゼロをつけない。<return>1</return> から <return>12</return><return>t</return>指定した月の日数。<return>28</return> から <return>31</return>年------<return>L</return>閏年であるかどう
                   か。<return>1</return>なら閏年。<return>0</return>なら閏年ではない。<return>o</return>ISO 8601 形式の週番号による年。これは <return>Y</return> ほぼ同
                   じだが、ISO 週番号 （<return>W</return>）が前年あるいは翌年に属する場合はそちらの年を使うという点
                   が異なる。例: <return>1999</return> あるいは <return>2003</return><return>X</return>拡張された年の数値表現。少なくとも4桁からなる数
                   値。紀元前の場合は、<return>-</return> が付きます。西暦の場合は <return>+</return> が付きます。例: <return>-0055</return>, <return>+0787</return>,
                   <return>+1999</return>, <return>+10191</return><return>x</return>必要に応じて拡張された年の数値表現。 拡張する必要がない場合は、通常
                   の年の数値 (<return>Y</return> と同じ)。 少なくとも4桁からなる数値。紀元前の場合は、<return>-</return> が付きます。
                   <return>10000</return> (10000を含みます) を超える場合は、<return>+</return> が付きます。例: <return>-0055</return>, <return>0787</return>, <return>1999</return>,
                   <return>+10191</return><return>Y</return>年。少なくとも4桁からなる数値。紀元前の場合は、<return>-</return> が付きます。例: <return>-0055</return>,
                   <return>0787</return>, <return>1999</return>, <return>2003</return>, <return>10191</return><return>y</return>年。2 桁の数字。例: <return>99</return> または <return>03</return>時------<return>a</return>午前または午後
                   （小文字）<return>am</return> または <return>pm</return><return>A</return>午前または午後（大文字）<return>AM</return> または <return>PM</return><return>B</return>Swatch インターネット
                   時間<return>000</return> から <return>999</return><return>g</return>時。12時間単位。先頭にゼロを付けない。<return>1</return> から <return>12</return><return>G</return>時。24時間単位。
                   先頭にゼロを付けない。<return>0</return> から <return>23</return><return>h</return>時。数字。12 時間単位。<return>01</return> から <return>12</return><return>H</return>時。数字。24 時
                   間単位。<return>00</return> から <return>23</return><return>i</return>分。先頭にゼロをつける。<return>00</return> から <return>59</return><return>s</return>秒。先頭にゼロをつける。<return>00</return>
                   から <return>59</return><return>u</return> マイクロ秒。 <strong>date()</strong> の場合、これは常に <return>000000</return> となることに注意しましょ
                   う。というのも、 この関数が受け取るパラメータは <info>int</info> 型だからです。 一方 <class>DateTime</class>
                   をマイクロ秒つきで作成した場合は、 DateTime::format はマイクロ秒にも対応していま
                   す。 例: <return>654321</return><return>v</return> ミリ秒。 <return>u</return>と同じ注釈が当てはまります。 例: <return>654</return>タイムゾーン
                   ------<return>e</return>タイムゾーン識別子例: <return>UTC</return>, <return>GMT</return>, <return>Atlantic/Azores</return><return>I</return> (大文字の i)サマータイム
                   中か否か<return>1</return>ならサマータイム中。 <return>0</return>ならそうではない。<return>O</return>グリニッジ標準時 (GMT) との時
                   差。時間と分の間にコロンは入りません。例: <return>+0200</return><return>P</return>グリニッジ標準時 (GMT) との時差。
                   時間と分をコロンで区切った形式例: <return>+02:00</return><return>p</return><return>P</return> と同じですが、<return>+00:00</return> ではなく <return>Z</return> を返し
                   ます。 (PHP 8.0.0 以降で利用可能) 例: <return>Z</return> または <return>+02:00</return><return>T</return>既知のものについては、タイ
                   ムゾーンの略称。そうでないものについては、GMT からのオフセット例: <return>EST</return>, <return>MDT</return>,
                   <return>+05</return><return>Z</return>タイムゾーンのオフセット秒数。 UTC の西側のタイムゾーン用のオフセットは常に負
                   です。そして、 UTC の東側のオフセットは常に正です。<return>-43200</return> から <return>50400</return>全ての日付/時
                   刻------<return>c</return>ISO 8601 日付2004-02-12T15:19:21+00:00<return>r</return>RFC 2822/RFC 5322 形式でフォー
                   マットされた日付例: <return>Thu, 21 Dec 2000 16:01:07 +0200</return><return>U</return>Unix Epoch (1970 年 1 月 1 日
                   0 時 0 分 0 秒) からの秒数<strong>time()</strong> も参照
                   
                   フォーマット文字列中の認識されない文字は、そのまま表示されます。 <return>Z</return> 形式は、
                   <strong>gmdate()</strong> で使用した場合、常に <return>0</return> を返します。
                   
                   この関数が受け付けるのは <info>int</info> のタイムスタンプだけです。したがって、書式指定文字 <return>u</return>
                   が有用となるのは <strong>date_create()</strong> で作成したタイムスタンプを用いて <strong>date_format()</strong> を
                   使用した場合のみです。

<comment>Return:</comment>
  <info>string</info>  成功した場合にフォーマット済みの日付文字列を返します。

<comment>See Also:</comment>
   * IntlDateFormatter::format


id: DateTime::getLastErrors
type: function
doc:
<comment>Description:</comment>
  DateTimeImmutable::getLastErrors のエイリアス
  
  この関数は次の関数のエイリアスです。 DateTimeImmutable::getLastErrors


id: DateTime::getOffset
type: function
doc:
<comment>Description:</comment>
  タイムゾーンのオフセットを返す
  
  オブジェクト指向型
  
  手続き型
  
  タイムゾーンのオフセットを返します。

<comment>Param:</comment>
  <info></info>  <strong>$object</strong>  手続き型のみ: <strong>date_create()</strong>
             が返す <class>DateTime</class> オブジェクト

<comment>Return:</comment>
  <info>int</info>  成功した場合には UTC からのタイムゾーンオフセット秒数、


id: DateTime::getTimestamp
type: function
doc:
<comment>Description:</comment>
  Unix タイムスタンプを取得する
  
  オブジェクト指向型
  
  手続き型
  
  Unix タイムスタンプを取得します。

<comment>Return:</comment>
  <info>int</info>  その日付をあらわす Unix タイムスタンプを返します。

<comment>See Also:</comment>
   * <strong>DateTime::setTimestamp()</strong>
   * <strong>DateTimeImmutable::setTimestamp()</strong>
   * <strong>DateTimeInterface::format()</strong>


id: DateTime::getTimezone
type: function
doc:
<comment>Description:</comment>
  指定した DateTime に関連するタイムゾーンを返す
  
  オブジェクト指向型
  
  手続き型
  
  指定した DateTime に関連するタイムゾーンを返します。

<comment>Param:</comment>
  <info></info>  <strong>$object</strong>  手続き型のみ: <strong>date_create()</strong>
             が返す <class>DateTime</class> オブジェクト

<comment>Return:</comment>
  <info>DateTimeZone|false</info>  成功した場合に <class>DateTimeZone</class> オブジェクト、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>DateTime::setTimezone()</strong>


id: DateTime::modify
type: function
doc:
<comment>Description:</comment>
  タイムスタンプを変更する
  
  オブジェクト指向型
  
  手続き型
  
  <strong>DateTimeImmutable::__construct()</strong> 形式で加算あるいは減算することによって DateTime オブジェクトのタ
  イムスタンプを変更します。

<comment>Param:</comment>
  <info>DateTime</info>  <strong>$object</strong>    手続き型のみ: 
                       <strong>date_create()</strong> が返す <class>DateTime</class> オブジェクト。
                       この関数は、このオブジェクトを変更します。
  <info>string</info>    <strong>$modifier</strong>  日付/時刻 文字列。有効な書式については 日付と時刻の書式 で説明しています。

<comment>Return:</comment>
  <info>DateTime|false</info>  メソッドチェインに使う、変更された <class>DateTime</class> オブジェクトを返します。失敗した場合に
                  <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>strtotime()</strong>
   * <strong>DateTimeImmutable::modify()</strong>
   * <strong>DateTime::add()</strong>
   * <strong>DateTime::sub()</strong>
   * <strong>DateTime::setDate()</strong>
   * <strong>DateTime::setISODate()</strong>
   * <strong>DateTime::setTime()</strong>
   * <strong>DateTime::setTimestamp()</strong>


id: DateTime::setDate
type: function
doc:
<comment>Description:</comment>
  日付を設定する
  
  オブジェクト指向型
  
  手続き型
  
  DateTime オブジェクトの現在の日付をリセットし、別の日付にします。
  
  DateTimeImmutable::setDate に似ていますが、 <class>DateTime</class> を用いて動作し、 既存のオブジェクトを変更しま
  す。
  
  手続き型のバージョンは、 <class>DateTime</class> オブジェクトを最初の引数として取ります。

<comment>Param:</comment>
  <info>DateTime</info>  <strong>$object</strong>  手続き型のみ: 
                     <strong>date_create()</strong> が返す <class>DateTime</class> オブジェクト。
                     この関数は、このオブジェクトを変更します。
  <info>int</info>       <strong>$year</strong>    その日付の年。
  <info>int</info>       <strong>$month</strong>   その日付の月。
  <info>int</info>       <strong>$day</strong>     その日付の日。

<comment>Return:</comment>
  <info>DateTime</info>  メソッドチェインに使う、変更された <class>DateTime</class> オブジェクトを返します。

<comment>See Also:</comment>
   * <strong>DateTimeImmutable::setDate()</strong>


id: DateTime::setISODate
type: function
doc:
<comment>Description:</comment>
  ISO 形式の日付を設定する
  
  オブジェクト指向型
  
  手続き型
  
  ISO 8601 標準形式、つまり特定の日付ではなく、週と日のオフセットで日付を設定します。
  
  DateTimeImmutable::setISODate に似ていますが、 <class>DateTime</class> を使って動作します。
  
  手続き型のバージョンは、 <class>DateTime</class> オブジェクトを最初の引数に取ります。

<comment>Param:</comment>
  <info>DateTime</info>  <strong>$object</strong>     手続き型のみ: 
                        <strong>date_create()</strong> が返す <class>DateTime</class> オブジェクト。
                        この関数は、このオブジェクトを変更します。
  <info>int</info>       <strong>$year</strong>       その日付の年。
  <info>int</info>       <strong>$week</strong>       その日付の週。
  <info>int</info>       <strong>$dayOfWeek</strong>  週の最初の日からのオフセット。

<comment>Return:</comment>
  <info>DateTime</info>  メソッドチェインに使う、変更された <class>DateTime</class> オブジェクトを返します。

<comment>See Also:</comment>
   * <strong>DateTimeImmutable::setISODate()</strong>


id: DateTime::setTime
type: function
doc:
<comment>Description:</comment>
  時刻を設定する
  
  オブジェクト指向型
  
  手続き型
  
  DateTime オブジェクトの現在時刻を別の時刻にリセットします。
  
  DateTimeImmutable::setTime に似ていますが、 <class>DateTime</class> を使って動作します。
  
  手続き型のバージョンは、 <class>DateTime</class> オブジェクトを最初の引数として取ります。

<comment>Param:</comment>
  <info>DateTime</info>  <strong>$object</strong>       手続き型のみ: 
                          <strong>date_create()</strong> が返す <class>DateTime</class> オブジェクト。
                          この関数は、このオブジェクトを変更します。
  <info>int</info>       <strong>$hour</strong>         その時刻の時。
  <info>int</info>       <strong>$minute</strong>       その時刻の分。
  <info>int</info>       <strong>$second</strong>       その時刻の秒。
  <info>int</info>       <strong>$microsecond</strong>  その時刻のマイクロ秒。

<comment>Return:</comment>
  <info>DateTime</info>  メソッドチェインに使う、変更された <class>DateTime</class> オブジェクトを返します。

<comment>See Also:</comment>
   * <strong>DateTimeImmutable::setTime()</strong>


id: DateTime::setTimestamp
type: function
doc:
<comment>Description:</comment>
  Unix タイムスタンプを用いて日付と時刻を設定する
  
  オブジェクト指向型
  
  手続き型
  
  Unix タイムスタンプを用いて日付と時刻を設定します。
  
  DateTimeImmutable::setTimestamp に似ていますが、 <class>DateTime</class> を使って動作します。
  
  手続き型のバージョンは、 <class>DateTime</class> オブジェクトを最初の引数に取ります。

<comment>Param:</comment>
  <info>DateTime</info>  <strong>$object</strong>     手続き型のみ: 
                        <strong>date_create()</strong> が返す <class>DateTime</class> オブジェクト。
                        この関数は、このオブジェクトを変更します。
  <info>int</info>       <strong>$timestamp</strong>  日付を表す Unix タイムスタンプ。 DateTimeImmutable::modify を <return>@</return> フォーマット
                        と共に使うと、 数値型の範囲外のタイムスタンプを設定できます。

<comment>Return:</comment>
  <info>DateTime</info>  メソッドチェインに使う、変更された <class>DateTime</class> オブジェクトを返します。

<comment>See Also:</comment>
   * <strong>DateTimeImmutable::setTimestamp()</strong>


id: DateTime::setTimezone
type: function
doc:
<comment>Description:</comment>
  DateTime オブジェクトのタイムゾーンを設定する
  
  オブジェクト指向型
  
  手続き型
  
  新しいタイムゾーンを <class>DateTime</class> オブジェクトに設定します。
  
  DateTimeImmutable::setTimezone に似ていますが、 <class>DateTime</class> を使って動作します。
  
  手続き型のバージョンは、 <class>DateTime</class> オブジェクトを最初の引数に取ります。

<comment>Param:</comment>
  <info>DateTime</info>      <strong>$object</strong>    手続き型のみ: 
                           <strong>date_create()</strong> が返す <class>DateTime</class> オブジェクト。
                           この関数は、このオブジェクトを変更します。
  <info>DateTimeZone</info>  <strong>$timezone</strong>  指定したいタイムゾーンを表す <class>DateTimeZone</class> オブジェクト。

<comment>Return:</comment>
  <info>DateTime</info>  メソッドをチェインできるようにするため、 <class>DateTime</class> オブジェクトを返します。 このメソッド
            をコールした際に指していた時刻は変わりません。

<comment>See Also:</comment>
   * <strong>DateTimeImmutable::setTimezone()</strong>
   * <strong>DateTime::getTimezone()</strong>
   * <strong>DateTimeZone::__construct()</strong>


id: DateTime::sub
type: function
doc:
<comment>Description:</comment>
  年月日時分秒の値を DateTime オブジェクトから引く
    
  
  オブジェクト指向型
  
  手続き型
  
  指定した <class>DateInterval</class> オブジェクトを引くことで、 指定した DateTime オブジェクトを変更します。
  
  DateTimeImmutable::sub に似ていますが、 <class>DateTime</class> を使って動作します。
  
  手続き型のバージョンは、 <class>DateTime</class> オブジェクトを最初の引数に取ります。

<comment>Param:</comment>
  <info>DateTime</info>      <strong>$object</strong>    手続き型のみ: 
                           <strong>date_create()</strong> が返す <class>DateTime</class> オブジェクト。
                           この関数は、このオブジェクトを変更します。
  <info>DateInterval</info>  <strong>$interval</strong>  <class>DateInterval</class> オブジェクト。

<comment>Return:</comment>
  <info>DateTime</info>  メソッドチェインに使う、変更された <class>DateTime</class> オブジェクトを返します。

<comment>See Also:</comment>
   * <strong>DateTimeImmutable::sub()</strong>


id: DateTimeImmutable
type: class
doc:
<comment>Description:</comment>
  日付と時刻を表現します。
  
  このクラスは <class>DateTime</class> と同じ振る舞いをします。 但し、<strong>DateTime::modify()</strong> のような、 状態を変更して
  新しいオブジェクトを返すメソッドが呼び出された時を除きます。


id: DateTimeImmutable::__construct
type: function
doc:
<comment>Description:</comment>
  新しい DateTimeImmutable オブジェクトを返す
  
  オブジェクト指向型
  
  手続き型
  
  新しい DateTimeImmutable オブジェクトを返します。

<comment>Param:</comment>
  <info>string</info>             <strong>$datetime</strong>  日付/時刻 文字列。有効な書式については 日付と時刻の書式 で説明してい
                                ます。
                                
                                ここに <return>"now"</return> を指定して <strong>$timezone</strong> パラメータを使うと、現在時刻を取得
                                できます。
  <info>DateTimeZone|null</info>  <strong>$timezone</strong>  <strong>$datetime</strong> のタイムゾーンを表す <class>DateTimeZone</class> オブジェクト。
                                
                                <strong>$timezone</strong> を省略した場合、 または <info>null</info> の場合、 現在のタイムゾーンを
                                使います。
                                
                                <strong>$datetime</strong> パラメータが UNIX タイムスタンプ (<return>@946684800</return> など) であっ
                                たりタイムゾーン付きで指定した場合 (<return>2010-01-28T15:00:00+02:00</return> や
                                <return>2010-07-05T06:00:00Z</return> など) は、 <strong>$timezone</strong> パラメータや現在のタイム
                                ゾーンは無視されます。

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


id: DateTimeImmutable::__set_state
type: function
doc:
<comment>Description:</comment>
  __set_state ハンドラ
  
  __set_state() ハンドラを処理します。

<comment>Param:</comment>
  <info>array</info>  <strong>$array</strong>  初期化配列。

<comment>Return:</comment>
  <info>DateTimeImmutable</info>  新しい DateTimeImmutable オブジェクトのインスタンスを返します。


id: DateTimeImmutable::add
type: function
doc:
<comment>Description:</comment>
  年月日時分秒の値を加え、新しいオブジェクトを返す
    
  
  新しい <class>DateTimeImmutable</class> オブジェクトを作成し、 指定された <class>DateInterval</class> をこれに加え、 新しい値を
  返します。

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

<comment>Return:</comment>
  <info>DateTimeImmutable</info>  変更されたデータを持つ、新しい <class>DateTimeImmutable</class> オブジェクトを返します。

<comment>See Also:</comment>
   * <strong>DateTimeImmutable::sub()</strong>
   * <strong>DateTimeImmutable::diff()</strong>
   * <strong>DateTimeImmutable::modify()</strong>


id: DateTimeImmutable::createFromFormat
type: function
doc:
<comment>Description:</comment>
  時刻の文字列を指定されたフォーマットに従ってパースする
  
  オブジェクト指向型
  
  手続き型
  
  新しい DateTimeImmutable オブジェクトを返します。 このオブジェクトは、<strong>$datetime</strong> で指定した文字列を
  <strong>$format</strong> で指定した書式に沿って解釈した時刻を表します。

<comment>Param:</comment>
  <info>string</info>             <strong>$format</strong>    書式を文字列で渡します。以下の書式オプションを参照ください。 大半
                                は、<strong>date()</strong> で使える文字と同じです。
                                
                                全てのフィールドは現在の日付/時刻で初期化されます。 ほとんどの場合、
                                これらの値を "ゼロ" (Unix タイムのエポック <return>1970-01-01 00:00:00 UTC</return>)
                                でリセットしたいはずです。 これは、<strong>$format</strong> の最初の文字に <return>!</return> を入れる
                                か、 最後の文字に <return>|</return> を入れることで実現できます。 詳細な情報は、以下
                                で示すそれぞれの文字に関するドキュメントを参照ください。
                                
                                フォーマットの解釈は左から右に行われます。 これは、フォーマット文字
                                が現れる順番が結果に影響する場合があるということです。 たとえば
                                <return>z</return>(1年における何番目の日か)　の場合、 <return>Y</return> や <return>y</return> を使って年が既にパースさ
                                れた後に使わなければなりません。
                                
                                数値の解釈に使われる文字については、広範な値が許されています。 これ
                                には、論理的に許される範囲以上のものも含みます。 たとえば、<return>d</return> (ある月
                                における何番目の日か) の場合、 <return>00</return> から <return>99</return> までの値が許されています。
                                これに対する唯一の制約は、桁数のみです。 範囲外の値が指定された場
                                合、 日付/時刻のパーサーのオーバーフローの仕組みが使われます。 オー
                                バーフローのふるまいについては、 後にいくつかのサンプルを示します。
                                
                                データは、フォーマット文字に従って貪欲にパースされます。 つまり、そ
                                のフォーマットが許している最大の長さまで読みこまれます。 これによっ
                                て、次のフォーマット文字に十分な文字数が <strong>$datetime</strong> にもう残っていな
                                いことがありえます。 このことが引き起こす問題については、このページ
                                のサンプルでも触れます。
                                
                                <strong>$format</strong> パラメータに渡せる文字<strong>$format</strong> 文字説明取りうる値の例日
                                ------<return>d</return> および <return>j</return>2桁の日付。先頭のゼロを含むものと含まないもの<return>01</return> から
                                <return>31</return> あるいは <return>1</return> から <return>31</return> (その月の日数分以上の2桁の数値も指定可能です
                                が、 その月はオーバーフローします。 たとえば January において 33 を
                                指定した場合、 February 2nd という意味になります) <return>D</return> および <return>l</return>曜日を表
                                す文字列<return>Mon</return> から <return>Sun</return> あるいは <return>Sunday</return> から <return>Saturday</return>。 指定された曜日
                                が、パースされた(またはデフォルトの)日付と異なっていた場合、 指定さ
                                れた曜日の 次の 日にオーバーフローします。詳細は後に示すサンプルを参
                                照ください。 <return>S</return>日付の後につける英語の接尾辞。二文字。処理中には無視さ
                                れます。<return>st</return>、<return>nd</return>、<return>rd</return> あるいは <return>th</return> <return>z</return> 年始からの通算日数 (最初は 0)。 <return>Y</return>
                                または <return>y</return> の後に続けて置かなければいけません。 <return>0</return> から <return>365</return> (1年の日数
                                分以上の3桁の数値も指定可能ですが、 その年はオーバーフローします。
                                たとえば 2022年において <return>366</return> を指定した場合は、 January 2nd, 2023 と
                                いう意味になります) 月------<return>F</return> および <return>M</return>月を表す文字列。January あるい
                                は Sept など<return>January</return> から <return>December</return> あるいは <return>Jan</return> から <return>Dec</return> <return>m</return> および <return>n</return>月
                                を表す数値。先頭のゼロを含むものと含まないもの<return>01</return> から <return>12</return> あるいは <return>1</return>
                                から <return>12</return> (12 以上の2桁の数値も指定可能ですが、 その年についてはオー
                                バーフローします。 たとえば <return>13</return> の場合は、 翌年の1月という意味になり
                                ます) 年------<return>X</return> および <return>x</return>年の数値表現。19桁まで指定可能。オプションで
                                <return>+</return> や <return>-</return> を先頭に指定可能です。例: <return>0055</return>, <return>787</return>, <return>1999</return>, <return>-2003</return>, <return>+10191</return><return>Y</return>4 桁
                                以下の数値で表した年例: <return>0055</return>, <return>787</return>, <return>1999</return>, <return>2003</return><return>y</return> 2 桁の数値で表した年
                                (1970年から2069年の間だとみなされます)  例: <return>99</return> あるいは <return>03</return> (それぞ
                                れ、 <return>1999</return> および <return>2003</return> と見なされます) 時刻------<return>a</return> および <return>A</return>午前および
                                午後<return>am</return> あるいは <return>pm</return><return>g</return> および <return>h</return>12 時間制での時間。先頭のゼロを含むもの
                                と含まないもの<return>1</return> から <return>12</return> あるいは <return>01</return> から <return>12</return> (12 以上の2桁の数値も指
                                定可能ですが、 日の指定がオーバーフローします。 たとえば <return>14</return> の場合
                                は、 次の午前/午後の <return>02</return> 時という意味になります) <return>G</return> および <return>H</return>24 時間制
                                での時間。先頭のゼロを含むものと含まないもの<return>0</return> から <return>23</return>、あるいは <return>00</return>
                                から <return>23</return> (24 より大きな、2桁の値も指定可能ですが、 この場合、日の指定
                                がオーバーフローします。 たとえば、<return>26</return> は翌日の <return>02:00</return> という意味にな
                                ります) <return>i</return>分。先頭のゼロを含む<return>00</return> から <return>59</return> (59 以上の2桁の数値も指定可
                                能ですが、 次の1時間にオーバーフローします。 たとえば <return>66</return> の場合は、
                                次の1時間の <return>:06</return> という意味になります) <return>s</return>秒。先頭のゼロを含む<return>00</return> から
                                <return>59</return> (59 以上の2桁の数値も指定可能ですが、 次の分にオーバーフローしま
                                す。 たとえば <return>90</return> の場合は、 次の分の <return>:30</return> という意味になります) <return>v</return>ミリ
                                秒 (最大 3桁)例: <return>12</return> (<return>0.12</return> 秒という意味), <return>345</return> (<return>0.345</return> 秒という意味)<return>u</return>マ
                                イクロ秒 (最大 6 桁)例: <return>45</return> (<return>0.45</return> 秒という意味), <return>654321</return> (<return>0.654321</return> 秒
                                という意味)タイムゾーン------<return>e</return>、<return>O</return>、 <return>P</return> および <return>T</return> タイムゾーン識別子、
                                UTC からの時差 (時間単位)、 UTC からの時差 (コロン区切りでの時間と
                                分)、そしてタイムゾーンの短縮形例: <return>UTC</return>、<return>GMT</return>、 <return>Atlantic/Azores</return>、
                                <return>+0200</return>、<return>+02:00</return>、 <return>EST</return>、<return>MDT</return> 完全な日付/時刻------<return>U</return>Unix エポック
                                (January 1 1970 00:00:00 GMT) からの経過秒数例: <return>1292177455</return>空白および
                                区切り------<return> </return> (空白)ゼロ文字以上のスペース、タブ、NBSP(U+A0)、
                                NNBSP(U+202F)例: <return>"\t"</return>, <return>"  "</return><return>#</return> 次の区切り文字のいずれか: <return>;</return>, <return>:</return>, <return>/</return>, <return>.</return>,
                                <return>,</return>, <return>-</return>, <return>(</return>, <return>)</return> 例: <return>/</return><return>;</return>, <return>:</return>, <return>/</return>, <return>.</return>, <return>,</return>, <return>-</return>, <return>(</return>, <return>)</return>指定した文字例: <return>-</return><return>?</return>ランダムなバ
                                イト例: <return>^</return> (UTF-8 文字の場合は複数の <return>?</return> が必要になるでしょう。この場
                                合、おそらく <return>*</return> を使うと要望が満たせるはずです)<return>*</return>次の区切り文字あるい
                                は数字までのランダムなバイト列例: <return>Y-*-d</return> の中の <return>*</return> は、文字列
                                <return>2009-aWord-08</return> の中の <return>aWord</return> にマッチします<return>!</return> すべてのフィールド (年、
                                月、日、時、分、秒、マイクロ秒およびタイムゾーン情報) を ゼロ相当の
                                値 (時、分、秒、マイクロ秒については <return>0</return>。 月、日については <return>1</return>。 年につ
                                いては <return>1970</return>。 タイムゾーンについては <return>UTC</return>) にリセットします。 <return>!</return> がな
                                ければ、すべてのフィールドは現在の日時に設定されます。<return>|</return>まだパースさ
                                れていないすべてのフィールド (年、月、日、時、分、秒、マイクロ秒およ
                                びタイムゾーン情報) を ゼロ相当の値にリセットします。<return>Y-m-d|</return> は、文字
                                列をパースした結果から年月日を設定し 時分秒には 0 を設定します。<return>+</return>こ
                                の文字があると、文字列のそれ以降のデータではエラーが発生せず、 かわ
                                りに警告を発生させるそれ以降のデータが存在したかどうかを調べるには
                                DateTime::getLastErrors を使います。
                                
                                書式文字列の中に解釈不能な文字が含まれていると処理は失敗し、 戻り値
                                にはエラーメッセージが付加されます。エラーメッセージを調べるには
                                DateTime::getLastErrors を使います。
                                
                                <strong>$format</strong> にリテラル文字を含めるには、 バックスラッシュ (<return>\</return>) でエスケー
                                プする必要があります。
                                
                                <strong>$format</strong> に文字 <return>!</return> が含まれない場合は、作成した時刻値のうち <strong>$format</strong> で
                                指定されていない部分を 現在のシステム時刻で初期化します。
                                
                                <strong>$format</strong> に文字 <return>!</return> が含まれる場合は、作成した時刻値のうち <strong>$format</strong> で指
                                定されていない部分と <return>!</return> の左側の部分を Unix エポックの対応する箇所の
                                値で初期化します。
                                
                                Unix エポックは 1970-01-01 00:00:00 です。
  <info>string</info>             <strong>$datetime</strong>  時刻を表す文字列。
  <info>DateTimeZone|null</info>  <strong>$timezone</strong>  指定したいタイムゾーンを表す <class>DateTimeZone</class> オブジェクト。
                                
                                <strong>$timezone</strong> を省略されるか、または <info>null</info> の場合、 かつ <strong>$datetime</strong> にタイ
                                ムゾーンが含まれない場合は、 現在のタイムゾーンを使います。
                                
                                <strong>$datetime</strong> パラメータが UNIX タイムスタンプ (例: <return>946684800</return>) だった
                                り、タイムゾーンを含んでいたり (例: <return>2010-01-28T15:00:00+02:00</return>) する
                                場合は、 <strong>$timezone</strong> パラメータや現在のタイムゾーンは無視します。

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

<comment>See Also:</comment>
   * <strong>DateTimeImmutable::__construct()</strong>
   * <strong>DateTimeImmutable::getLastErrors()</strong>
   * <strong>checkdate()</strong>
   * <strong>strptime()</strong>


id: DateTimeImmutable::createFromInterface
type: function
doc:
<comment>Description:</comment>
  指定された DateTimeInterface オブジェクトをカプセル化した、新しい DateTimeImmutable オブジェクトを
  返
  す

<comment>Param:</comment>
  <info>DateTimeInterface</info>  <strong>$object</strong>  変更できないバージョンに変換する <class>DateTimeInterface</class> オブジェクト。 この
                              オブジェクトは変更されませんが、 同じ日付、時刻、タイムゾーンの情報が
                              入った新しい <class>DateTimeImmutable</class> オブジェクトが作成されます。

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


id: DateTimeImmutable::createFromMutable
type: function
doc:
<comment>Description:</comment>
  与えられた DateTime オブジェクトをカプセル化した、新しいDateTimeImmutable のインスタンスを返す

<comment>Param:</comment>
  <info>DateTime</info>  <strong>$object</strong>  変更不能なバージョンに変換が必要な、 <class>DateTime</class> オブジェクト。 このオブジェクトは
                     変更されませんが、 代わりに同じ日付、時刻、タイムゾーンの情報を含んだ 新しい
                     <class>DateTimeImmutable</class> のインスタンスが作られます。

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


id: DateTimeImmutable::getLastErrors
type: function
doc:
<comment>Description:</comment>
  警告およびエラーを返す
  
  日付/時刻文字列のパース時に見つかった警告やエラーの配列を返します。

<comment>Return:</comment>
  <info>array|false</info>  警告やエラーに関する情報を含む配列を返します。 警告やエラーがない場合は <info>false</info> を返し
               ます。


id: DateTimeImmutable::modify
type: function
doc:
<comment>Description:</comment>
  タイムスタンプを変更した新しいオブジェクトを作る
  
  タイムスタンプを変更した新しい <info>DateTimeImmutable</info> オブジェクトを作ります。 元のオブジェクトは変更さ
  れません。

<comment>Param:</comment>
  <info>string</info>  <strong>$modifier</strong>  日付/時刻 文字列。有効な書式については 日付と時刻の書式 で説明しています。

<comment>Return:</comment>
  <info>DateTimeImmutable|false</info>  新しく作った DateTimeImmutable オブジェクトを返します。 失敗した場合に
                           <info>false</info> を返します

<comment>See Also:</comment>
   * <strong>DateTimeImmutable::add()</strong>
   * <strong>DateTimeImmutable::sub()</strong>
   * <strong>DateTimeImmutable::setDate()</strong>
   * <strong>DateTimeImmutable::setISODate()</strong>
   * <strong>DateTimeImmutable::setTime()</strong>
   * <strong>DateTimeImmutable::setTimestamp()</strong>


id: DateTimeImmutable::setDate
type: function
doc:
<comment>Description:</comment>
  日付を設定する
  
  DateTimeImmutable オブジェクトの現在の日付を、指定された日付にします。 指定した日付を設定した、新
  しい DateTimeImmutable オブジェクトを返します。

<comment>Param:</comment>
  <info></info>     <strong>$object</strong>  手続き型のみ: 
                <strong>date_create()</strong> が返す <class>DateTime</class> オブジェクト。
                この関数は、このオブジェクトを変更します。
  <info>int</info>  <strong>$year</strong>    その日付の年。
  <info>int</info>  <strong>$month</strong>   その日付の月。
  <info>int</info>  <strong>$day</strong>     その日付の日。

<comment>Return:</comment>
  <info>DateTimeImmutable</info>  変更されたデータを持つ、新しい <class>DateTimeImmutable</class> オブジェクトを返します。

<comment>See Also:</comment>
   * <strong>DateTimeImmutable::setISODate()</strong>
   * <strong>DateTimeImmutable::setTime()</strong>


id: DateTimeImmutable::setISODate
type: function
doc:
<comment>Description:</comment>
  ISO 日付を設定する
  
  ISO 8601 標準形式、 つまり週と日オフセットで日付を設定する形式に従って日付を設定した、 新しい
  DateTimeImmutable オブジェクトを返します。

<comment>Param:</comment>
  <info>int</info>  <strong>$year</strong>       その日付の年。
  <info>int</info>  <strong>$week</strong>       その日付の週。
  <info>int</info>  <strong>$dayOfWeek</strong>  週の最初の日からのオフセット。

<comment>Return:</comment>
  <info>DateTimeImmutable</info>  変更されたデータを持つ、新しい <class>DateTimeImmutable</class> オブジェクトを返します。

<comment>See Also:</comment>
   * <strong>DateTimeImmutable::setDate()</strong>
   * <strong>DateTimeImmutable::setTime()</strong>


id: DateTimeImmutable::setTime
type: function
doc:
<comment>Description:</comment>
  時刻を設定する
  
  指定された時刻を設定した、 新しい DateTimeImmutable オブジェクト を返します。

<comment>Param:</comment>
  <info>int</info>  <strong>$hour</strong>         その時刻の時。
  <info>int</info>  <strong>$minute</strong>       その時刻の分。
  <info>int</info>  <strong>$second</strong>       その時刻の秒。
  <info>int</info>  <strong>$microsecond</strong>  その時刻のマイクロ秒。

<comment>Return:</comment>
  <info>DateTimeImmutable</info>  変更されたデータを持つ、新しい <class>DateTimeImmutable</class> オブジェクトを返します。

<comment>See Also:</comment>
   * <strong>DateTimeImmutable::setDate()</strong>
   * <strong>DateTimeImmutable::setISODate()</strong>


id: DateTimeImmutable::setTimestamp
type: function
doc:
<comment>Description:</comment>
  Unix タイムスタンプを用いて日付と時刻を設定する
  
  Unix タイムスタンプを用いて日付と時刻を設定し、 古いものから新しい DateTimeImmutable オブジェクト
  を作成して返します。

<comment>Param:</comment>
  <info>int</info>  <strong>$timestamp</strong>  Unix タイムスタンプ。 DateTimeImmutable::modify を <return>@</return> フォーマットと共に使うと、
                   数値型の範囲外のタイムスタンプを設定できます。

<comment>Return:</comment>
  <info>DateTimeImmutable</info>  変更されたデータを持つ、新しい <class>DateTimeImmutable</class> オブジェクトを返します。

<comment>See Also:</comment>
   * <strong>DateTimeImmutable::getTimestamp()</strong>


id: DateTimeImmutable::setTimezone
type: function
doc:
<comment>Description:</comment>
  タイムゾーンを設定する
  
  新しいタイムゾーンを設定した、 新しい DateTimeImmutable オブジェクトを返します。

<comment>Param:</comment>
  <info>DateTimeZone</info>  <strong>$timezone</strong>  指定したいタイムゾーンを表す <class>DateTimeZone</class> オブジェクト。

<comment>Return:</comment>
  <info>DateTimeImmutable</info>  メソッドをチェインできるようにするため、 変更された新しい <class>DateTimeImmutable</class> オ
                     ブジェクトを返します。 このメソッドをコールした際に指していた時刻は変わりませ
                     ん。

<comment>See Also:</comment>
   * <strong>DateTimeImmutable::getTimezone()</strong>
   * <strong>DateTimeZone::__construct()</strong>


id: DateTimeImmutable::sub
type: function
doc:
<comment>Description:</comment>
  年月日時分秒の値を引く
    
  
  指定した <class>DateInterval</class> オブジェクトを、 指定した DateTimeImmutable オブジェクトから引き、 新しい
  <class>DateTimeImmutable</class> オブジェクトを返します。

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

<comment>Return:</comment>
  <info>DateTimeImmutable</info>  変更されたデータを持つ、新しい <class>DateTimeImmutable</class> オブジェクトを返します。

<comment>See Also:</comment>
   * <strong>DateTimeImmutable::add()</strong>
   * <strong>DateTimeImmutable::diff()</strong>
   * <strong>DateTimeImmutable::modify()</strong>


id: DateTimeInterface
type: class
doc:
<comment>Description:</comment>
  DateTimeInterface は、 <class>DateTimeImmutable</class> や <class>DateTime</class> を引数や戻り値、プロパティの型宣言で使えるよ
  うにするために作られたものです。 このインターフェイスを実装したクラスをユーザー側で作ることはでき
  ません。
  
  DateTimeImmutable::format や DateTime::format を通じて、 <class>DateTimeImmutable</class> や <class>DateTime</class> をフォー
  マットするための共通の定数も、 このインターフェイスに定義されています。


id: DateTimeZone::__construct
type: function
doc:
<comment>Description:</comment>
  新しい DateTimeZone オブジェクトを作成する
  
  オブジェクト指向型
  
  手続き型
  
  新しい DateTimeZone オブジェクトを作成します。
  
  DateTimeZone オブジェクトは、 3つの異なるタイムゾーンルールへのアクセスを提供します。 ひとつは UTC
  からのオフセット (type <return>1</return>), もうひとつはタイムゾーンの省略形 (type <return>2</return>), そして IANA タイムゾーンデー
  タベースで公開されている タイムゾーン名 (type <return>3</return>) です。
  
  DateTimeZone オブジェクトは、 <class>DateTime</class> や <class>DateTimeImmutable</class> に設定できます。 こうすることで、 ロー
  カルのタイムゾーンとしてカプセル化された、 タイムゾーンを表示させることができます。

<comment>Param:</comment>
  <info>string</info>  <strong>$timezone</strong>  サポートするタイムゾーン名 のいずれかや、 オフセット値 (+0200)、 またはタイム
                     ゾーンの省略名(BST)。

<comment>Return:</comment>
  <info>DateTimeZone|false</info>  成功した場合に <class>DateTimeZone</class> を返します。 手続き型 の場合は、失敗したときに
                      <info>false</info> を返します。


id: DateTimeZone::getLocation
type: function
doc:
<comment>Description:</comment>
  タイムゾーンの位置情報を返す
  
  オブジェクト指向型
  
  手続き型
  
  タイムゾーンの位置情報 (国コード、緯度/経度、コメント) を返します。

<comment>Param:</comment>
  <info>DateTimeZone</info>  <strong>$object</strong>  手続き型のみ: <strong>timezone_open()</strong> が返す <class>DateTimeZone</class> オブジェクト

<comment>Return:</comment>
  <info>array|false</info>  タイムゾーンについての位置情報を含む配列を返します。失敗した場合に <info>false</info> を返します

<comment>See Also:</comment>
   * タイムゾーンの識別子を全て、または一部を取得する <strong>DateTimeZone::listIdentifiers()</strong>


id: DateTimeZone::getName
type: function
doc:
<comment>Description:</comment>
  タイムゾーンの名前を返す
  
  オブジェクト指向型
  
  手続き型
  
  タイムゾーンの名前を返します。

<comment>Param:</comment>
  <info>DateTimeZone</info>  <strong>$object</strong>  名前を取得したい <class>DateTimeZone</class>。

<comment>Return:</comment>
  <info>string</info>  タイムゾーンのタイプによって、異なる値を返します。 UTC オフセット(type 1 の場合)、 タイム
          ゾーンの省略形(type 2 の場合)、 および IANA タイムゾーンデータベースに登録されているタイム
          ゾーン識別子(type 3 の場合) です。これらは、同じオフセット かつ/または ルールで
          <class>DateTimeZone</class> オブジェクトを作るための文字列です。 たとえば <return>02:00</return>、 <return>CEST</return>、 タイムゾーン一覧
          のタイムゾーン名のひとつを返します。


id: DateTimeZone::getOffset
type: function
doc:
<comment>Description:</comment>
  GMT からのタイムゾーンのオフセットを返す
  
  オブジェクト指向型
  
  手続き型
  
  この関数は、<strong>$datetime</strong> パラメータで指定した 日付/時刻 についての GMT へのオフセットを返します。GMT
  オフセットの計算の際には、 使用する DateTimeZone オブジェクトに含まれるタイムゾーン情報を使用しま
  す。

<comment>Param:</comment>
  <info>DateTimeZone</info>       <strong>$object</strong>    手続き型のみ: <strong>timezone_open()</strong> が返す <class>DateTimeZone</class> オブジェクト
  <info>DateTimeInterface</info>  <strong>$datetime</strong>  オフセットを計算する 日付/時刻 を含む DateTime。

<comment>Return:</comment>
  <info>int</info>  成功した場合にタイムゾーンのオフセット秒数を返します。


id: DateTimeZone::getTransitions
type: function
doc:
<comment>Description:</comment>
  タイムゾーンの変遷を返す
  
  オブジェクト指向型
  
  手続き型

<comment>Param:</comment>
  <info>DateTimeZone</info>  <strong>$object</strong>          手続き型のみ: <strong>timezone_open()</strong> が返す <class>DateTimeZone</class> オブジェクト
  <info>int</info>           <strong>$timestampBegin</strong>  開始時のタイムスタンプ。
  <info>int</info>           <strong>$timestampEnd</strong>    終了時のタイムスタンプ。

<comment>Return:</comment>
  <info>array|false</info>  成功した場合にタイムゾーンの遷移を表す、数値インデックスの配列を返します。 失敗した場
               合に <info>false</info> を返します。 DateTimeZone オブジェクト の type 1 (UTC オフセット) と、type
               2 (タイムゾーンの省略形) の場合は、 タイムゾーンの遷移情報は含まれません。 その場合に
               このメソッドをコールしても <info>false</info> を返します。
               
               <strong>$timestampBegin</strong> を指定すると、 返される配列の最初のエントリに <strong>$timestampBegin</strong> の時点
               における遷移の情報が含まれるようになります。
               
               タイムゾーンの遷移を表す配列の構造キー型説明<return>ts</return><info>int</info>Unixタイムスタンプ
               <return>time</return><info>string</info><info>DateTimeInterface::ISO8601_EXPANDED</info> (PHP 8.2 以降) または、
               <info>DateTimeInterface::ISO8601</info> (PHP 8.1 以前) 形式の文字列<return>offset</return><info>int</info>UTC からのオフセット
               (秒単位)<return>isdst</return><info>bool</info>夏時間が有効かどうか<return>abbr</return><info>string</info>タイムゾーンの省略形


id: DateTimeZone::listAbbreviations
type: function
doc:
<comment>Description:</comment>
  夏時間、オフセットおよびタイムゾーン名を含む連想配列を返す
  
  オブジェクト指向型
  
  手続き型
  
  この関数が返す省略形のリストは、 歴史的に使われてきた値を全て含んでいます。 これは正しい値ではある
  ものの、混乱を招くものがあります。 値が衝突しているものもあります。たとえば <return>PST</return> はアメリカ合衆国
  (US)とフィリピンの双方で使われています。
  
  よって、この関数が返すリストは、ユーザーにタイムゾーンを選択させる表示オプションを構築する目的には
  適していません。
  
  この関数で使われるデータは、パフォーマンス上の理由でプリコンパイルされています。 よって、より新し
  い timezonedb を使っていても更新されません。

<comment>Return:</comment>
  <info>array</info>  成功した場合に、タイムゾーンの情報を含んだ配列を返します。

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


id: DateTimeZone::listIdentifiers
type: function
doc:
<comment>Description:</comment>
  すべてのタイムゾーン識別子を含む配列を返す
  
  オブジェクト指向型
  
  手続き型

<comment>Param:</comment>
  <info>int</info>          <strong>$timezoneGroup</strong>  <class>DateTimeZone</class> のクラス定数のいずれか (または定数の組み合わせ)。
  <info>string|null</info>  <strong>$countryCode</strong>    2 文字の (大文字の) ISO 3166-1 互換の国コード。
                               
                               このオプションを使用するのは、<strong>$timezoneGroup</strong> に
                               <info>DateTimeZone::PER_COUNTRY</info> を設定した場合のみです。

<comment>Return:</comment>
  <info>array</info>  成功した場合に、タイムゾーンの識別子を含んだ配列を返します。 期限切れになっていない識別子の
         みを返します。 期限切れになったものも含めて、全ての識別子を取得するには、 <strong>$timezoneGroup</strong> の
         値に <return>DateTimeZone::ALL_WITH_BC</return> を指定します。

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


id: DeflateContext
type: class
doc:
<comment>Description:</comment>
  PHP 8.0.0 以降、 <return>zlib.deflate</return> リソースを置き換える完全不透明クラスです。


id: Directory
type: class
doc:
<comment>Description:</comment>
  <class>Directory</class> クラスのインスタンスを作るには <strong>dir()</strong> 関数を使います。new 演算子は使いません。


id: Directory::close
type: function
doc:
<comment>Description:</comment>
  ディレクトリハンドルをクローズする

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


id: Directory::read
type: function
doc:
<comment>Description:</comment>
  ディレクトリハンドルからエントリを読み込む

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


id: Directory::rewind
type: function
doc:
<comment>Description:</comment>
  ディレクトリハンドルを元に戻す

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


id: DirectoryIterator
type: class
doc:
<comment>Description:</comment>
  DirectoryIterator クラスは、 ファイルシステムのディレクトリを閲覧するためのシンプルなインターフェ
  イスです。


id: DirectoryIterator::__construct
type: function
doc:
<comment>Description:</comment>
  パスから新規ディレクトリイテレータを生成する
  
  パスから新規ディレクトリイテレータを生成します。

<comment>Param:</comment>
  <info>string</info>  <strong>$directory</strong>  処理したいディレクトリのパス。

<comment>See Also:</comment>
   * <class>SplFileInfo</class>
   * <class>Iterator</class>


id: DirectoryIterator::__toString
type: function
doc:
<comment>Description:</comment>
  ファイル名を文字列として取得する
  
  現在の <class>DirectoryIterator</class> のアイテムのファイル名を取得します。

<comment>Return:</comment>
  <info>string</info>  現在の <class>DirectoryIterator</class> のアイテムのファイル名を返します。

<comment>See Also:</comment>
   * DirectoryIterator::getFilename
   * __toString() マジックメソッド


id: DirectoryIterator::current
type: function
doc:
<comment>Description:</comment>
  現在の DirectoryIterator アイテムを返す
  
  現在の <class>DirectoryIterator</class> アイテムを取得します。

<comment>Return:</comment>
  <info>mixed</info>  現在の <class>DirectoryIterator</class> アイテムを返します。

<comment>See Also:</comment>
   * DirectoryIterator::key
   * DirectoryIterator::next
   * DirectoryIterator::rewind
   * DirectoryIterator::valid
   * Iterator::current


id: DirectoryIterator::getBasename
type: function
doc:
<comment>Description:</comment>
  現在の DirectoryIterator のアイテムのベース名を取得する
  
  現在の <class>DirectoryIterator</class> のアイテムのベース名を取得します。

<comment>Param:</comment>
  <info>string</info>  <strong>$suffix</strong>  ベース名が <strong>$suffix</strong> で終わる場合は、これがカットされます。

<comment>Return:</comment>
  <info>string</info>  現在の <class>DirectoryIterator</class> のアイテムのベース名を返します。

<comment>See Also:</comment>
   * DirectoryIterator::getFilename
   * DirectoryIterator::getPath
   * DirectoryIterator::getPathname
   * <strong>basename()</strong>
   * <strong>pathinfo()</strong>


id: DirectoryIterator::getExtension
type: function
doc:
<comment>Description:</comment>
  ファイルの拡張子を取得する
  
  ファイルの拡張子を取得します。

<comment>Return:</comment>
  <info>string</info>  ファイルの拡張子を文字列で返します。もし拡張しがない場合は空文字列を返します。

<comment>See Also:</comment>
   * DirectoryIterator::getFilename
   * DirectoryIterator::getBasename
   * <strong>pathinfo()</strong>


id: DirectoryIterator::getFilename
type: function
doc:
<comment>Description:</comment>
  現在の DirectoryIterator アイテムのファイル名を返す
  
  現在の <class>DirectoryIterator</class> アイテムのファイル名を取得します。

<comment>Return:</comment>
  <info>string</info>  現在の <class>DirectoryIterator</class> アイテムのファイル名を返します。

<comment>See Also:</comment>
   * DirectoryIterator::getBasename
   * DirectoryIterator::getPath
   * DirectoryIterator::getPathname
   * <strong>pathinfo()</strong>


id: DirectoryIterator::isDot
type: function
doc:
<comment>Description:</comment>
  現在の DirectoryIterator アイテムが '.' もしくは '..' であるかどうかを調べる
  
  現在の <class>DirectoryIterator</class> アイテムがディレクトリであり、かつ <return>.</return> あるいは <return>..</return> のどちらかであるかどうか
  を調べます。

<comment>Return:</comment>
  <info>bool</info>  エントリが <return>.</return> あるいは <return>..</return> である場合に <info>true</info>、そうでない場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * DirectoryIterator::getType
   * DirectoryIterator::isDir
   * DirectoryIterator::isFile
   * DirectoryIterator::isLink


id: DirectoryIterator::key
type: function
doc:
<comment>Description:</comment>
  現在の DirectoryIterator アイテムのキーを返す
  
  現在の <class>DirectoryIterator</class> アイテムのキーを取得します。

<comment>Return:</comment>
  <info>mixed</info>  現在の <class>DirectoryIterator</class> アイテムのキーを数値で返します。

<comment>See Also:</comment>
   * DirectoryIterator::current
   * DirectoryIterator::next
   * DirectoryIterator::rewind
   * DirectoryIterator::valid
   * Iterator::key


id: DirectoryIterator::next
type: function
doc:
<comment>Description:</comment>
  次の DirectoryIterator アイテムに移動する
  
  次の <class>DirectoryIterator</class> アイテムに移動します。

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

<comment>See Also:</comment>
   * DirectoryIterator::current
   * DirectoryIterator::key
   * DirectoryIterator::rewind
   * DirectoryIterator::valid
   * Iterator::next


id: DirectoryIterator::rewind
type: function
doc:
<comment>Description:</comment>
  DirectoryIterator を最初に巻き戻す
  
  <class>DirectoryIterator</class> を最初に巻き戻します。

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

<comment>See Also:</comment>
   * DirectoryIterator::current
   * DirectoryIterator::key
   * DirectoryIterator::next
   * DirectoryIterator::valid
   * Iterator::rewind


id: DirectoryIterator::seek
type: function
doc:
<comment>Description:</comment>
  DirectoryIterator のアイテムを移動する
  
  <class>DirectoryIterator</class> の指定した位置に移動します。

<comment>Param:</comment>
  <info>int</info>  <strong>$offset</strong>  異動先を表す、ゼロから始まる位置。

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

<comment>See Also:</comment>
   * DirectoryIterator::rewind
   * DirectoryIterator::next
   * SeekableIterator::seek


id: DirectoryIterator::valid
type: function
doc:
<comment>Description:</comment>
  現在の DirectoryIterator の位置が有効なファイルであるかどうかチェックする
  
  現在の <class>DirectoryIterator</class> の位置が有効なファイルであるかどうかチェックします。

<comment>Return:</comment>
  <info>bool</info>  有効な位置である場合は <info>true</info>、それ以外の場合は <info>false</info> を返します。

<comment>See Also:</comment>
   * DirectoryIterator::current
   * DirectoryIterator::key
   * DirectoryIterator::next
   * DirectoryIterator::rewind
   * Iterator::valid


id: DocResult::__construct
type: function
doc:
<comment>Description:</comment>
  DocResult のコンストラクタ
  
  ドキュメントの結果と警告を取得します。 CollectionFind クラスによってインスタンス化されます。


id: DocResult::fetchAll
type: function
doc:
<comment>Description:</comment>
  全ての行を取得する
  
  結果セットから全ての行を取得する

<comment>Return:</comment>
  <info>array</info>  クエリからの結果全てを含む、数値をキーとする配列。 それぞれの結果は連想配列です。 行が存在
         しない場合は、空の配列が返されます。


id: DocResult::fetchOne
type: function
doc:
<comment>Description:</comment>
  一行取得する
  
  結果セットから一行だけ取得します。

<comment>Return:</comment>
  <info>array</info>  一行を表一行を表す連想配列。 結果がなければ <info>null</info> となります。


id: DocResult::getWarnings
type: function
doc:
<comment>Description:</comment>
  直近の操作から発生した警告を取得する
  
  MySQL サーバーに対する直近の操作から発生した警告を取得します。

<comment>Return:</comment>
  <info>Array</info>  直近の操作から発生した警告オブジェクトの配列。 個々のオブジェクトはエラーの 'message' と
         'level' と 'code' を定義しています。 エラーが発生していない場合は、空の配列が返されます。


id: DocResult::getWarningsCount
type: function
doc:
<comment>Description:</comment>
  直近の操作で発生した警告の数を取得する
  
  直近の操作によって発生した警告の数を返します。 具体的には、これらの警告は MySQL サーバーが発生させ
  たものです。

<comment>Return:</comment>
  <info>int</info>  直近の操作によって発生した警告の数を返します。


id: Ds\Collection
type: class
doc:
<comment>Description:</comment>
  <class>Collection</class> is the base interface which covers functionality common to all the data structures in
  this library. It guarantees that all structures are traversable, countable, and can be converted
  to json using <strong>json_encode()</strong>.


id: Ds\Collection::clear
type: function
doc:
<comment>Description:</comment>
  Removes all values
  
  Removes all values from the collection.

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


id: Ds\Collection::copy
type: function
doc:
<comment>Description:</comment>
  Returns a shallow copy of the collection
  
  Returns a shallow copy of the collection.

<comment>Return:</comment>
  <info>Ds\Collection</info>  Returns a shallow copy of the collection.


id: Ds\Collection::isEmpty
type: function
doc:
<comment>Description:</comment>
  Returns whether the collection is empty
  
  Returns whether the collection is empty.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the collection is empty, <info>false</info> otherwise.


id: Ds\Collection::toArray
type: function
doc:
<comment>Description:</comment>
  Converts the collection to an array
    
  
  Converts the collection to an <info>array</info>.
  
  Casting to an <info>array</info> is not supported yet.

<comment>Return:</comment>
  <info>array</info>  An <info>array</info> containing all the values in the same order as the collection.


id: Ds\Deque
type: class
doc:
<comment>Description:</comment>
  A Deque (pronounced “deck”) is a sequence of values in a contiguous buffer that grows and shrinks
  automatically. The name is a common abbreviation of “double-ended queue” and is used internally by
  <class>Ds\Queue</class>.
  
  Two pointers are used to keep track of a head and a tail. The pointers can “wrap around” the end
  of the buffer, which avoids the need to move other values around to make room. This makes shift
  and unshift very fast —  something a <class>Ds\Vector</class> can’t compete with.
  
  Accessing a value by index requires a translation between the index and its corresponding position
  in the buffer: ((head + position) % capacity).


id: Ds\Deque::__construct
type: function
doc:
<comment>Description:</comment>
  Creates a new instance
  
  Creates a new instance, using either a <class>traversable</class> object or an <info>array</info> for the initial <strong>$values</strong>.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$values</strong>  A traversable object or an <info>array</info> to use for the initial values.


id: Ds\Deque::allocate
type: function
doc:
<comment>Description:</comment>
  Allocates enough memory for a required capacity
  
  Ensures that enough memory is allocated for a required capacity. This removes the need to
  reallocate the internal as values are added.

<comment>Param:</comment>
  <info>int</info>  <strong>$capacity</strong>  The number of values for which capacity should be allocated.
                  
                  Capacity will stay the same if this value is less than or equal to the current
                  capacity.
                  
                  Capacity will always be rounded up to the nearest power of 2.

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


id: Ds\Deque::apply
type: function
doc:
<comment>Description:</comment>
  Updates all values by applying a callback function to each value
  
  Updates all values by applying a <strong>$callback</strong> function to each value in the deque.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  <info>mixed</info>callback<info>mixed</info><strong>$value</strong>
                       
                       A <info>callable</info> to apply to each value in the deque.
                       
                       The callback should return what the value should be replaced by.

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


id: Ds\Deque::capacity
type: function
doc:
<comment>Description:</comment>
  Returns the current capacity
  
  Returns the current capacity.

<comment>Return:</comment>
  <info>int</info>  The current capacity.


id: Ds\Deque::clear
type: function
doc:
<comment>Description:</comment>
  Removes all values from the deque
  
  Removes all values from the deque.

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


id: Ds\Deque::contains
type: function
doc:
<comment>Description:</comment>
  Determines if the deque contains given values
  
  Determines if the deque contains all values.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$values</strong>  Values to check.

<comment>Return:</comment>
  <info>bool</info>  <info>false</info> if any of the provided <strong>$values</strong> are not in the deque, <info>true</info> otherwise.


id: Ds\Deque::copy
type: function
doc:
<comment>Description:</comment>
  Returns a shallow copy of the deque
  
  Returns a shallow copy of the deque.

<comment>Return:</comment>
  <info>Ds\Deque</info>  A shallow copy of the deque.


id: Ds\Deque::count
type: function
doc:
<comment>Description:</comment>
  Returns the number of values in the collection
  
  See <strong>Countable::count()</strong>


id: Ds\Deque::filter
type: function
doc:
<comment>Description:</comment>
  Creates a new deque using a callable to
      determine which values to include
   
  
  Creates a new deque using a <info>callable</info> to determine which values to include.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  <info>bool</info>callback<info>mixed</info><strong>$value</strong>
                       
                       Optional <info>callable</info> which returns <info>true</info> if the value should be included, <info>false</info>
                       otherwise.
                       
                       If a callback is not provided, only values which are <info>true</info> (see converting to
                       boolean) will be included.

<comment>Return:</comment>
  <info>Ds\Deque</info>  A new deque containing all the values for which either the <strong>$callback</strong> returned <info>true</info>, or
            all values that convert to <info>true</info> if a <strong>$callback</strong> was not provided.


id: Ds\Deque::find
type: function
doc:
<comment>Description:</comment>
  Attempts to find a value's index
    
  
  Returns the index of the <strong>$value</strong>, or <info>false</info> if not found.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  The value to find.

<comment>Return:</comment>
  <info>mixed</info>  The index of the value, or <info>false</info> if not found.
         
         Values will be compared by value and by type.


id: Ds\Deque::first
type: function
doc:
<comment>Description:</comment>
  Returns the first value in the deque
  
  Returns the first value in the deque.

<comment>Return:</comment>
  <info>mixed</info>  The first value in the deque.


id: Ds\Deque::get
type: function
doc:
<comment>Description:</comment>
  Returns the value at a given index
  
  Returns the value at a given index.

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  The index to access, starting at 0.

<comment>Return:</comment>
  <info>mixed</info>  The value at the requested index.


id: Ds\Deque::insert
type: function
doc:
<comment>Description:</comment>
  Inserts values at a given index
  
  Inserts values into the deque at a given index.

<comment>Param:</comment>
  <info>int</info>    <strong>$index</strong>   The index at which to insert. 0 \<= index \<= count
                  
                  You can insert at the index equal to the number of values.
  <info>mixed</info>  <strong>$values</strong>  The value or values to insert.

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


id: Ds\Deque::isEmpty
type: function
doc:
<comment>Description:</comment>
  Returns whether the deque is empty
  
  Returns whether the deque is empty.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the deque is empty, <info>false</info> otherwise.


id: Ds\Deque::join
type: function
doc:
<comment>Description:</comment>
  Joins all values together as a string
  
  Joins all values together as a string using an optional separator between each value.

<comment>Param:</comment>
  <info>string</info>  <strong>$glue</strong>  An optional string to separate each value.

<comment>Return:</comment>
  <info>string</info>  All values of the deque joined together as a string.


id: Ds\Deque::jsonSerialize
type: function
doc:
<comment>Description:</comment>
  Returns a representation that can be converted to JSON
  
  See <strong>JsonSerializable::jsonSerialize()</strong>
  
  You should never need to call this directly.


id: Ds\Deque::last
type: function
doc:
<comment>Description:</comment>
  Returns the last value
  
  Returns the last value in the deque.

<comment>Return:</comment>
  <info>mixed</info>  The last value in the deque.


id: Ds\Deque::map
type: function
doc:
<comment>Description:</comment>
  Returns the result of applying a callback to each value
  
  Returns the result of applying a <strong>$callback</strong> function to each value in the deque.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  <info>mixed</info>callback<info>mixed</info><strong>$value</strong>
                       
                       A <info>callable</info> to apply to each value in the deque.
                       
                       The callable should return what the new value will be in the new deque.

<comment>Return:</comment>
  <info>Ds\Deque</info>  The result of applying a <strong>$callback</strong> to each value in the deque.
            
            The values of the current instance won't be affected.


id: Ds\Deque::merge
type: function
doc:
<comment>Description:</comment>
  Returns the result of adding all given values to the deque
  
  Returns the result of adding all given values to the deque.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$values</strong>  A <class>traversable</class> object or an <info>array</info>.

<comment>Return:</comment>
  <info>Ds\Deque</info>  The result of adding all given values to the deque, effectively the same as adding the
            values to a copy, then returning that copy.
            
            The current instance won't be affected.


id: Ds\Deque::pop
type: function
doc:
<comment>Description:</comment>
  Removes and returns the last value
  
  Removes and returns the last value.

<comment>Return:</comment>
  <info>mixed</info>  The removed last value.


id: Ds\Deque::push
type: function
doc:
<comment>Description:</comment>
  Adds values to the end of the deque
  
  Adds values to the end of the deque.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$values</strong>  The values to add.

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


id: Ds\Deque::reduce
type: function
doc:
<comment>Description:</comment>
  Reduces the deque to a single value using a callback function
  
  Reduces the deque to a single value using a callback function.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  The return value of the previous callback, or <strong>$initial</strong> if it's the first
                       iteration.
                       
                       The value of the current iteration.
  <info>mixed</info>     <strong>$carry</strong>     The return value of the previous callback, or <strong>$initial</strong> if it's the first
                       iteration.
  <info>mixed</info>     <strong>$value</strong>     The value of the current iteration.
  <info>mixed</info>     <strong>$initial</strong>   The initial value of the carry value. Can be <info>null</info>.

<comment>Return:</comment>
  <info>mixed</info>  The return value of the final callback.


id: Ds\Deque::remove
type: function
doc:
<comment>Description:</comment>
  Removes and returns a value by index
  
  Removes and returns a value by index.

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  The index of the value to remove.

<comment>Return:</comment>
  <info>mixed</info>  The value that was removed.


id: Ds\Deque::reverse
type: function
doc:
<comment>Description:</comment>
  Reverses the deque in-place
    
  
  Reverses the deque in-place.

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


id: Ds\Deque::reversed
type: function
doc:
<comment>Description:</comment>
  Returns a reversed copy
  
  Returns a reversed copy of the deque.

<comment>Return:</comment>
  <info>Ds\Deque</info>  A reversed copy of the deque.
              The current instance is not affected. 
            
            The current instance is not affected.


id: Ds\Deque::rotate
type: function
doc:
<comment>Description:</comment>
  Rotates the deque by a given number of rotations
  
  Rotates the deque by a given number of rotations, which is equivalent to successively calling
  $deque-&gt;push($deque-&gt;shift()) if the number of rotations is positive, or
  $deque-&gt;unshift($deque-&gt;pop()) if negative.

<comment>Param:</comment>
  <info>int</info>  <strong>$rotations</strong>  The number of times the deque should be rotated.

<comment>Return:</comment>
  <info>void</info>  値を返しません。. The deque of the current instance will be rotated.


id: Ds\Deque::set
type: function
doc:
<comment>Description:</comment>
  Updates a value at a given index
  
  Updates a value at a given index.

<comment>Param:</comment>
  <info>int</info>    <strong>$index</strong>  The index of the value to update.
  <info>mixed</info>  <strong>$value</strong>  The new value.

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


id: Ds\Deque::shift
type: function
doc:
<comment>Description:</comment>
  Removes and returns the first value
  
  Removes and returns the first value.

<comment>Return:</comment>
  <info>mixed</info>  The first value, which was removed.


id: Ds\Deque::slice
type: function
doc:
<comment>Description:</comment>
  Returns a sub-deque of a given range
    
  
  Creates a sub-deque of a given range.

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>   The index at which the sub-deque starts.
                
                If positive, the deque will start at that index in the deque. If negative, the deque
                will start that far from the end.
  <info>int</info>  <strong>$length</strong>  If a length is given and is positive, the resulting deque will have up to that many
                values in it.
                 If the length results in an overflow, only values up to the end of the deque will
                be included.
                 If a length is given and is negative, the deque will stop that many values from the
                end.
                 If a length is not provided, the resulting deque will contain all values between
                the index and the end of the deque.

<comment>Return:</comment>
  <info>Ds\Deque</info>  A sub-deque of the given range.


id: Ds\Deque::sort
type: function
doc:
<comment>Description:</comment>
  Sorts the deque in-place
   
  
  Sorts the deque in-place, using an optional <strong>$comparator</strong> function.

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

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


id: Ds\Deque::sorted
type: function
doc:
<comment>Description:</comment>
  Returns a sorted copy
  
  Returns a sorted copy, using an optional <strong>$comparator</strong> function.

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

<comment>Return:</comment>
  <info>Ds\Deque</info>  Returns a sorted copy of the deque.


id: Ds\Deque::sum
type: function
doc:
<comment>Description:</comment>
  Returns the sum of all values in the deque
  
  Returns the sum of all values in the deque.
  
  Arrays and objects are considered equal to zero when calculating the sum.

<comment>Return:</comment>
  <info>int|float</info>  The sum of all the values in the deque as either a <info>float</info> or <info>int</info> depending on the values
             in the deque.


id: Ds\Deque::toArray
type: function
doc:
<comment>Description:</comment>
  Converts the deque to an array
    
  
  Converts the deque to an <info>array</info>.
  
  Casting to an <info>array</info> is not supported yet.

<comment>Return:</comment>
  <info>array</info>  An <info>array</info> containing all the values in the same order as the deque.


id: Ds\Deque::unshift
type: function
doc:
<comment>Description:</comment>
  Adds values to the front of the deque
  
  Adds values to the front of the deque, moving all the current values forward to make room for the
  new values.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$values</strong>  The values to add to the front of the deque.  Multiple values will be added in the
                  same order that they are passed.
                  
                  Multiple values will be added in the same order that they are passed.

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


id: Ds\Hashable
type: class
doc:
<comment>Description:</comment>
  Hashable is an interface which allows objects to be used as keys. It’s an alternative to
  <strong>spl_object_hash()</strong>, which determines an object’s hash based on its handle: this means that two
  objects that are considered equal by an implicit definition would not treated as equal because
  they are not the same instance.
  
  <strong>hash()</strong> is used to return a scalar value to be used as the object's hash value, which determines
  where it goes in the hash table. While this value does not have to be unique, objects which are
  equal must have the same hash value.
  
  <strong>equals()</strong> is used to determine if two objects are equal. It's guaranteed that the comparing object
  will be an instance of the same class as the subject.


id: Ds\Hashable::equals
type: function
doc:
<comment>Description:</comment>
  Determines whether an object is equal to the current instance
  
  Determines whether another object is equal to the current instance.
  
  This method allows objects to be used as keys in structures such as <class>Ds\Map</class> and <class>Ds\Set</class>, or any
  other lookup structure that honors this interface.
  
  It's guaranteed that <strong>$obj</strong> is an instance of the same class.
  
  It's important that objects which are equal also have the same hash value. See
  <strong>Ds\Hashable::hash()</strong>.

<comment>Param:</comment>
  <info>object</info>  <strong>$obj</strong>  The object to compare the current instance to, which is always an instance of the
                same class.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if equal, <info>false</info> otherwise.


id: Ds\Hashable::hash
type: function
doc:
<comment>Description:</comment>
  Returns a scalar value to be used as a hash value
  
  Returns a scalar value to be used as the hash value of the objects.
  
  While the hash value does not define equality, all objects that are equal according to
  <strong>Ds\Hashable::equals()</strong> must have the same hash value. Hash values of equal objects don't have to be
  unique, for example you could just return <info>true</info> for all objects and nothing would break - the only
  implication would be that hash tables then turn into linked lists because all your objects will be
  hashed to the same bucket. It's therefore very important that you pick a good hash value, such as
  an ID or email address.
  
  This method allows objects to be used as keys in structures such as <class>Ds\Map</class> and <class>Ds\Set</class>, or any
  other lookup structure that honors this interface.
  
  Do not pick a value that might change within the object, such as a public property. Hash table
  lookups would fail because the hash has changed.
  
  All objects that are equal must have the same hash value.

<comment>Return:</comment>
  <info>mixed</info>  A scalar value to be used as this object's hash value.


id: Ds\Map
type: class
doc:
<comment>Description:</comment>
  A Map is a sequential collection of key-value pairs, almost identical to an <info>array</info> used in a
  similar context. Keys can be any type, but must be unique. Values are replaced if added to the map
  using the same key.


id: Ds\Map::allocate
type: function
doc:
<comment>Description:</comment>
  Allocates enough memory for a required capacity
  
  Allocates enough memory for a required capacity.

<comment>Param:</comment>
  <info>int</info>  <strong>$capacity</strong>  The number of values for which capacity should be allocated.
                  
                  Capacity will stay the same if this value is less than or equal to the current
                  capacity.
                  
                  Capacity will always be rounded up to the nearest power of 2.

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


id: Ds\Map::apply
type: function
doc:
<comment>Description:</comment>
  Updates all values by applying a callback function to each value
  
  Updates all values by applying a <strong>$callback</strong> function to each value in the map.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  <info>mixed</info>callback<info>mixed</info><strong>$key</strong><info>mixed</info><strong>$value</strong>
                       
                       A <info>callable</info> to apply to each value in the map.
                       
                       The callback should return what the value should be replaced by.

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


id: Ds\Map::clear
type: function
doc:
<comment>Description:</comment>
  Removes all values
  
  Removes all values from the map.

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


id: Ds\Map::copy
type: function
doc:
<comment>Description:</comment>
  Returns a shallow copy of the map
  
  Returns a shallow copy of the map.

<comment>Return:</comment>
  <info>Ds\Map</info>  Returns a shallow copy of the map.


id: Ds\Map::count
type: function
doc:
<comment>Description:</comment>
  Returns the number of values in the map
  
  See <strong>Countable::count()</strong>


id: Ds\Map::diff
type: function
doc:
<comment>Description:</comment>
  Creates a new map using keys that aren't in another map
  
  Returns the result of removing all keys from the current instance that are present in a given
  <strong>$map</strong>.
  
  A \ B = {x ∈ A | x ∉ B}

<comment>Param:</comment>
  <info>Ds\Map</info>  <strong>$map</strong>  The map containing the keys to exclude in the resulting map.

<comment>Return:</comment>
  <info>Ds\Map</info>  The result of removing all keys from the current instance that are present in a given
          <strong>$map</strong>.

<comment>See Also:</comment>
   * Complement on Wikipedia


id: Ds\Map::filter
type: function
doc:
<comment>Description:</comment>
  Creates a new map using a callable to determine which pairs to include
    
  
  Creates a new map using a <info>callable</info> to determine which pairs to include.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  <info>bool</info>callback<info>mixed</info><strong>$key</strong><info>mixed</info><strong>$value</strong>
                       
                       Optional <info>callable</info> which returns <info>true</info> if the pair should be included, <info>false</info>
                       otherwise.
                       
                       If a callback is not provided, only values which are <info>true</info> (see converting to
                       boolean) will be included.

<comment>Return:</comment>
  <info>Ds\Map</info>  A new map containing all the pairs for which either the <strong>$callback</strong> returned <info>true</info>, or all
          values that convert to <info>true</info> if a <strong>$callback</strong> was not provided.


id: Ds\Map::first
type: function
doc:
<comment>Description:</comment>
  Returns the first pair in the map
  
  Returns the first pair in the map.

<comment>Return:</comment>
  <info>Ds\Pair</info>  The first pair in the map.


id: Ds\Map::get
type: function
doc:
<comment>Description:</comment>
  Returns the value for a given key
  
  Returns the value for a given key, or an optional default value if the key could not be found.
  
  Keys of type <info>object</info> are supported.
   If an object implements <class>Ds\Hashable</class>, equality will be determined by the object's equals function.
   If an object does not implement <class>Ds\Hashable</class>, objects must be references to the same instance to
  be considered equal.
  
  You can also use array syntax to access values by key, eg. $map["key"].
  
  Be careful when using array syntax. Scalar keys will be coerced to integers by the engine. For
  example, $map["1"] will attempt to access int(1), while $map-&gt;get("1") will correctly look up
  the string key.
  
  See Arrays.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$key</strong>      The key to look up.
  <info>mixed</info>  <strong>$default</strong>  The optional default value, returned if the key could not be found.

<comment>Return:</comment>
  <info>mixed</info>  The value mapped to the given <strong>$key</strong>, or the <strong>$default</strong> value if provided and the key could not
         be found in the map.


id: Ds\Map::hasKey
type: function
doc:
<comment>Description:</comment>
  Determines whether the map contains a given key
  
  Determines whether the map contains a given key.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$key</strong>  The key to look for.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the key could found, <info>false</info> otherwise.


id: Ds\Map::hasValue
type: function
doc:
<comment>Description:</comment>
  Determines whether the map contains a given value
  
  Determines whether the map contains a given value.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  The value to look for.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the value could found, <info>false</info> otherwise.


id: Ds\Map::intersect
type: function
doc:
<comment>Description:</comment>
  Creates a new map by intersecting keys with another map
  
  Creates a new map containing the pairs of the current instance whose keys are also present in the
  given <strong>$map</strong>.
   In other words, returns a copy of the current instance with all keys removed that are not also in
  the other <strong>$map</strong>.
  
  A ∩ B = {x : x ∈ A ∧ x ∈ B}
  
  Values from the current instance will be kept.

<comment>Param:</comment>
  <info>Ds\Map</info>  <strong>$map</strong>  The other map, containing the keys to intersect with.

<comment>Return:</comment>
  <info>Ds\Map</info>  The key intersection of the current instance and another <strong>$map</strong>.

<comment>See Also:</comment>
   * Intersection on Wikipedia


id: Ds\Map::isEmpty
type: function
doc:
<comment>Description:</comment>
  Returns whether the map is empty
  
  Returns whether the map is empty.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the map is empty, <info>false</info> otherwise.


id: Ds\Map::keys
type: function
doc:
<comment>Description:</comment>
  Returns a set of the map's keys
  
  Returns a set containing all the keys of the map, in the same order.

<comment>Return:</comment>
  <info>Ds\Set</info>  A <class>Ds\Set</class> containing all the keys of the map.


id: Ds\Map::ksort
type: function
doc:
<comment>Description:</comment>
  Sorts the map in-place by key
   
  
  Sorts the map in-place by key, using an optional <strong>$comparator</strong> function.

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

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


id: Ds\Map::ksorted
type: function
doc:
<comment>Description:</comment>
  Returns a copy, sorted by key
  
  Returns a copy sorted by key, using an optional <strong>$comparator</strong> function.

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

<comment>Return:</comment>
  <info>Ds\Map</info>  Returns a copy of the map, sorted by key.


id: Ds\Map::last
type: function
doc:
<comment>Description:</comment>
  Returns the last pair of the map
  
  Returns the last pair of the map.

<comment>Return:</comment>
  <info>Ds\Pair</info>  The last pair of the map.


id: Ds\Map::map
type: function
doc:
<comment>Description:</comment>
  Returns the result of applying a callback to each value
  
  Returns the result of applying a <strong>$callback</strong> function to each value of the map.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  <info>mixed</info>callback<info>mixed</info><strong>$key</strong><info>mixed</info><strong>$value</strong>
                       
                       A <info>callable</info> to apply to each value in the map.
                       
                       The callable should return what the key will be mapped to in the resulting
                       map.

<comment>Return:</comment>
  <info>Ds\Map</info>  The result of applying a <strong>$callback</strong> to each value in the map.
          
          The keys and values of the current instance won't be affected.


id: Ds\Map::merge
type: function
doc:
<comment>Description:</comment>
  Returns the result of adding all given associations
  
  Returns the result of associating all keys of a given <class>traversable</class> object or <info>array</info> with their
  corresponding values, combined with the current instance.
  
  Values of the current instance will be overwritten by those provided where keys are equal.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$values</strong>  A <class>traversable</class> object or an <info>array</info>.

<comment>Return:</comment>
  <info>Ds\Map</info>  The result of associating all keys of a given <class>traversable</class> object or <info>array</info> with their
          corresponding values, combined with the current instance.
          
          The current instance won't be affected.


id: Ds\Map::pairs
type: function
doc:
<comment>Description:</comment>
  Returns a sequence containing all the pairs of the map
  
  Returns a <class>Ds\Sequence</class> containing all the pairs of the map.

<comment>Return:</comment>
  <info>Ds\Sequence</info>  <class>Ds\Sequence</class> containing all the pairs of the map.


id: Ds\Map::put
type: function
doc:
<comment>Description:</comment>
  Associates a key with a value
  
  Associates a <strong>$key</strong> with a <strong>$value</strong>, overwriting a previous association if one exists.
  
  Keys of type <info>object</info> are supported.
   If an object implements <class>Ds\Hashable</class>, equality will be determined by the object's equals function.
   If an object does not implement <class>Ds\Hashable</class>, objects must be references to the same instance to
  be considered equal.
  
  You can also use array syntax to associate values by key, eg. $map["key"] = $value.
  
  Be careful when using array syntax. Scalar keys will be coerced to integers by the engine. For
  example, $map["1"] will attempt to access int(1), while $map-&gt;get("1") will correctly look up
  the string key.
  
  See Arrays.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$key</strong>    The key to associate the value with.
  <info>mixed</info>  <strong>$value</strong>  The value to be associated with the key.

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


id: Ds\Map::putAll
type: function
doc:
<comment>Description:</comment>
  Associates all key-value pairs of a traversable object or array
  
  Associates all key-value <strong>$pairs</strong> of a <class>traversable</class> object or <info>array</info>.
  
  Keys of type <info>object</info> are supported.
   If an object implements <class>Ds\Hashable</class>, equality will be determined by the object's equals function.
   If an object does not implement <class>Ds\Hashable</class>, objects must be references to the same instance to
  be considered equal.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$pairs</strong>  <class>traversable</class> object or <info>array</info>.

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


id: Ds\Map::reduce
type: function
doc:
<comment>Description:</comment>
  Reduces the map to a single value using a callback function
  
  Reduces the map to a single value using a callback function.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  The return value of the previous callback, or <strong>$initial</strong> if it's the first
                       iteration.
                       
                       The key of the current iteration.
                       
                       The value of the current iteration.
  <info>mixed</info>     <strong>$carry</strong>     The return value of the previous callback, or <strong>$initial</strong> if it's the first
                       iteration.
  <info>mixed</info>     <strong>$key</strong>       The key of the current iteration.
  <info>mixed</info>     <strong>$value</strong>     The value of the current iteration.
  <info>mixed</info>     <strong>$initial</strong>   The initial value of the carry value. Can be <info>null</info>.

<comment>Return:</comment>
  <info>mixed</info>  The return value of the final callback.


id: Ds\Map::remove
type: function
doc:
<comment>Description:</comment>
  Removes and returns a value by key
  
  Removes and returns a value by key, or return an optional default value if the key could not be
  found.
  
  Keys of type <info>object</info> are supported.
   If an object implements <class>Ds\Hashable</class>, equality will be determined by the object's equals function.
   If an object does not implement <class>Ds\Hashable</class>, objects must be references to the same instance to
  be considered equal.
  
  You can also use array syntax to access values by key, eg. $map["key"].
  
  Be careful when using array syntax. Scalar keys will be coerced to integers by the engine. For
  example, $map["1"] will attempt to access int(1), while $map-&gt;get("1") will correctly look up
  the string key.
  
  See Arrays.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$key</strong>      The key to remove.
  <info>mixed</info>  <strong>$default</strong>  The optional default value, returned if the key could not be found.

<comment>Return:</comment>
  <info>mixed</info>  The value that was removed, or the <strong>$default</strong> value if provided and the <strong>$key</strong> could not be
         found in the map.


id: Ds\Map::reverse
type: function
doc:
<comment>Description:</comment>
  Reverses the map in-place
    
  
  Reverses the map in-place.

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


id: Ds\Map::reversed
type: function
doc:
<comment>Description:</comment>
  Returns a reversed copy
  
  Returns a reversed copy of the map.

<comment>Return:</comment>
  <info>Ds\Map</info>  A reversed copy of the map.
            The current instance is not affected. 
          
          The current instance is not affected.


id: Ds\Map::skip
type: function
doc:
<comment>Description:</comment>
  Returns the pair at a given positional index
  
  Returns the pair at a given zero-based <strong>$position</strong>.

<comment>Param:</comment>
  <info>int</info>  <strong>$position</strong>  The zero-based positional index to return.

<comment>Return:</comment>
  <info>Ds\Pair</info>  Returns the <class>Ds\Pair</class> at the given <strong>$position</strong>.


id: Ds\Map::slice
type: function
doc:
<comment>Description:</comment>
  Returns a subset of the map defined by a starting index and length
    
  
  Returns a subset of the map defined by a starting <strong>$index</strong> and <strong>$length</strong>.

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>   The index at which the range starts.
                
                If positive, the range will start at that index in the map. If negative, the range
                will start that far from the end.
  <info>int</info>  <strong>$length</strong>  If a length is given and is positive, the resulting map will have up to that many
                pairs in it.
                 If a length is given and is negative, the range will stop that many pairs from the
                end.
                 If the length results in an overflow, only pairs up to the end of the map will be
                included.
                 If a length is not provided, the resulting map will contain all pairs between the
                index and the end of the map.

<comment>Return:</comment>
  <info>Ds\Map</info>  A subset of the map defined by a starting index and length.


id: Ds\Map::sort
type: function
doc:
<comment>Description:</comment>
  Sorts the map in-place by value
   
  
  Sorts the map in-place by value, using an optional <strong>$comparator</strong> function.

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

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


id: Ds\Map::sorted
type: function
doc:
<comment>Description:</comment>
  Returns a copy, sorted by value
  
  Returns a copy, sorted by value using an optional <strong>$comparator</strong> function.

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

<comment>Return:</comment>
  <info>Ds\Map</info>  Returns a copy of the map, sorted by value.


id: Ds\Map::sum
type: function
doc:
<comment>Description:</comment>
  Returns the sum of all values in the map
  
  Returns the sum of all values in the map.
  
  Arrays and objects are considered equal to zero when calculating the sum.

<comment>Return:</comment>
  <info>int|float</info>  The sum of all the values in the map as either a <info>float</info> or <info>int</info> depending on the values
             in the map.


id: Ds\Map::toArray
type: function
doc:
<comment>Description:</comment>
  Converts the map to an array
    
  
  Converts the map to an <info>array</info>.
  
  Maps where non-scalar keys are can't be converted to an <info>array</info>.
  
  An <info>array</info> will treat all numeric keys as integers, eg. "1" and 1 as keys in the map will only
  result in 1 being included in the array.
  
  Casting to an <info>array</info> is not supported yet.

<comment>Return:</comment>
  <info>array</info>  An <info>array</info> containing all the values in the same order as the map.


id: Ds\Map::union
type: function
doc:
<comment>Description:</comment>
  Creates a new map using values from the current instance and another map
  
  Creates a new map that contains the pairs of the current instance as well as the pairs of another
  <strong>$map</strong>.
  
  A ∪ B = {x: x ∈ A ∨ x ∈ B}
  
  Values of the current instance will be overwritten by those provided where keys are equal.

<comment>Param:</comment>
  <info>Ds\Map</info>  <strong>$map</strong>  The other map, to combine with the current instance.

<comment>Return:</comment>
  <info>Ds\Map</info>  A new map containing all the pairs of the current instance as well as another <strong>$map</strong>.

<comment>See Also:</comment>
   * Union on Wikipedia


id: Ds\Map::values
type: function
doc:
<comment>Description:</comment>
  Returns a sequence of the map's values
  
  Returns a sequence containing all the values of the map, in the same order.

<comment>Return:</comment>
  <info>Ds\Sequence</info>  A <class>Ds\Sequence</class> containing all the values of the map.


id: Ds\Map::xor
type: function
doc:
<comment>Description:</comment>
  Creates a new map using keys of either the current instance or of another map, but not of both
  
  Creates a new map containing keys of the current instance as well as another <strong>$map</strong>, but not of
  both.
  
  A ⊖ B = {x : x ∈ (A \ B) ∪ (B \ A)}

<comment>Param:</comment>
  <info>Ds\Map</info>  <strong>$map</strong>  The other map.

<comment>Return:</comment>
  <info>Ds\Map</info>  A new map containing keys in the current instance as well as another <strong>$map</strong>, but not in
          both.

<comment>See Also:</comment>
   * Symmetric Difference on Wikipedia


id: Ds\Pair
type: class
doc:
<comment>Description:</comment>
  A pair is used by <class>Ds\Map</class> to pair keys with values.


id: Ds\Pair::__construct
type: function
doc:
<comment>Description:</comment>
  Creates a new instance
  
  Creates a new instance using a given <strong>$key</strong> and <strong>$value</strong>.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$key</strong>    The key.
  <info>mixed</info>  <strong>$value</strong>  The value.


id: Ds\Pair::clear
type: function
doc:
<comment>Description:</comment>
  Removes all values
  
  Removes all values from the pair.

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


id: Ds\Pair::copy
type: function
doc:
<comment>Description:</comment>
  Returns a shallow copy of the pair
  
  Returns a shallow copy of the pair.

<comment>Return:</comment>
  <info>Ds\Pair</info>  Returns a shallow copy of the pair.


id: Ds\Pair::isEmpty
type: function
doc:
<comment>Description:</comment>
  Returns whether the pair is empty
  
  Returns whether the pair is empty.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the pair is empty, <info>false</info> otherwise.


id: Ds\Pair::toArray
type: function
doc:
<comment>Description:</comment>
  Converts the pair to an array
    
  
  Converts the pair to an <info>array</info>.
  
  Casting to an <info>array</info> is not supported yet.

<comment>Return:</comment>
  <info>array</info>  An <info>array</info> containing all the values in the same order as the pair.


id: Ds\PriorityQueue
type: class
doc:
<comment>Description:</comment>
  A PriorityQueue is very similar to a Queue. Values are pushed into the queue with an assigned
  priority, and the value with the highest priority will always be at the front of the queue.
  
  Implemented using a max heap.
  
  "First in, first out" ordering is preserved for values with the same priority.
  
  Iterating over a PriorityQueue is destructive, equivalent to successive pop operations until the
  queue is empty.


id: Ds\PriorityQueue::clear
type: function
doc:
<comment>Description:</comment>
  Removes all values
  
  Removes all values from the queue.

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


id: Ds\PriorityQueue::copy
type: function
doc:
<comment>Description:</comment>
  Returns a shallow copy of the queue
  
  Returns a shallow copy of the queue.

<comment>Return:</comment>
  <info>Ds\PriorityQueue</info>  Returns a shallow copy of the queue.


id: Ds\PriorityQueue::count
type: function
doc:
<comment>Description:</comment>
  Returns the number of values in the queue
  
  See <strong>Countable::count()</strong>


id: Ds\PriorityQueue::isEmpty
type: function
doc:
<comment>Description:</comment>
  Returns whether the queue is empty
  
  Returns whether the queue is empty.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the queue is empty, <info>false</info> otherwise.


id: Ds\PriorityQueue::peek
type: function
doc:
<comment>Description:</comment>
  Returns the value at the front of the queue
  
  Returns the value at the front of the queue, but does not remove it.

<comment>Return:</comment>
  <info>mixed</info>  The value at the front of the queue.


id: Ds\PriorityQueue::pop
type: function
doc:
<comment>Description:</comment>
  Removes and returns the value with the highest priority
  
  Removes and returns the value at the front of the queue, ie. the value with the highest priority.
  
  Values with equal priority fall back to FIFO (first in first out).

<comment>Return:</comment>
  <info>mixed</info>  The removed value which was at the front of the queue.


id: Ds\PriorityQueue::push
type: function
doc:
<comment>Description:</comment>
  Pushes values into the queue
  
  Pushes a <strong>$value</strong> with a given <strong>$priority</strong> into the queue.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>     The value to push into the queue.
  <info>int</info>    <strong>$priority</strong>  The priority associated with the value.

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


id: Ds\PriorityQueue::toArray
type: function
doc:
<comment>Description:</comment>
  Converts the queue to an array
    
  
  Converts the queue to an <info>array</info>.
  
  This method is not destructive.
  
  Casting to an <info>array</info> is not supported yet.

<comment>Return:</comment>
  <info>array</info>  An <info>array</info> containing all the values in the same order as the queue.


id: Ds\Queue
type: class
doc:
<comment>Description:</comment>
  A Queue is a “first in, first out” or “FIFO” collection that only allows access to the value at
  the front of the queue and iterates in that order, destructively.


id: Ds\Queue::allocate
type: function
doc:
<comment>Description:</comment>
  Allocates enough memory for a required capacity
  
  Ensures that enough memory is allocated for a required capacity. This removes the need to
  reallocate the internal as values are added.
  
  Capacity will always be rounded up to the nearest power of 2.

<comment>Param:</comment>
  <info>int</info>  <strong>$capacity</strong>  The number of values for which capacity should be allocated.
                  
                  Capacity will stay the same if this value is less than or equal to the current
                  capacity.
                  
                  Capacity will always be rounded up to the nearest power of 2.

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


id: Ds\Queue::copy
type: function
doc:
<comment>Description:</comment>
  Returns a shallow copy of the queue
  
  Returns a shallow copy of the queue.

<comment>Return:</comment>
  <info>Ds\Queue</info>  Returns a shallow copy of the queue.


id: Ds\Queue::pop
type: function
doc:
<comment>Description:</comment>
  Removes and returns the value at the front of the queue
  
  Removes and returns the value at the front of the queue.

<comment>Return:</comment>
  <info>mixed</info>  The removed value which was at the front of the queue.


id: Ds\Queue::push
type: function
doc:
<comment>Description:</comment>
  Pushes values into the queue
  
  Pushes <strong>$values</strong> into the queue.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$values</strong>  The values to push into the queue.

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


id: Ds\Queue::toArray
type: function
doc:
<comment>Description:</comment>
  Converts the queue to an array
    
  
  Converts the queue to an <info>array</info>.
  
  Casting to an <info>array</info> is not supported yet.
  
  This method is not destructive.

<comment>Return:</comment>
  <info>array</info>  An <info>array</info> containing all the values in the same order as the queue.


id: Ds\Sequence
type: class
doc:
<comment>Description:</comment>
  A Sequence describes the behaviour of values arranged in a single, linear dimension. Some
  languages refer to this as a "List". It’s similar to an array that uses incremental integer keys,
  with the exception of a few characteristics: Values will always be indexed as [0, 1, 2, …, size -
  1].Only allowed to access values by index in the range [0, size - 1].
  
  Use cases: Wherever you would use an array as a list (not concerned with keys).A more efficient
  alternative to <class>SplDoublyLinkedList</class> and <class>SplFixedArray</class>.


id: Ds\Sequence::allocate
type: function
doc:
<comment>Description:</comment>
  Allocates enough memory for a required capacity
  
  Ensures that enough memory is allocated for a required capacity. This removes the need to
  reallocate the internal as values are added.

<comment>Param:</comment>
  <info>int</info>  <strong>$capacity</strong>  The number of values for which capacity should be allocated.
                  
                  Capacity will stay the same if this value is less than or equal to the current
                  capacity.

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


id: Ds\Sequence::apply
type: function
doc:
<comment>Description:</comment>
  Updates all values by applying a callback function to each value
  
  Updates all values by applying a <strong>$callback</strong> function to each value in the sequence.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  <info>mixed</info>callback<info>mixed</info><strong>$value</strong>
                       
                       A <info>callable</info> to apply to each value in the sequence.
                       
                       The callback should return what the value should be replaced by.

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


id: Ds\Sequence::contains
type: function
doc:
<comment>Description:</comment>
  Determines if the sequence contains given values
  
  Determines if the sequence contains all values.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$values</strong>  Values to check.

<comment>Return:</comment>
  <info>bool</info>  <info>false</info> if any of the provided <strong>$values</strong> are not in the sequence, <info>true</info> otherwise.


id: Ds\Sequence::filter
type: function
doc:
<comment>Description:</comment>
  Creates a new sequence using a callable to
      determine which values to include
   
  
  Creates a new sequence using a <info>callable</info> to determine which values to include.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  <info>bool</info>callback<info>mixed</info><strong>$value</strong>
                       
                       Optional <info>callable</info> which returns <info>true</info> if the value should be included, <info>false</info>
                       otherwise.
                       
                       If a callback is not provided, only values which are <info>true</info> (see converting to
                       boolean) will be included.

<comment>Return:</comment>
  <info>Ds\Sequence</info>  A new sequence containing all the values for which either the <strong>$callback</strong> returned
               <info>true</info>, or all values that convert to <info>true</info> if a <strong>$callback</strong> was not provided.


id: Ds\Sequence::first
type: function
doc:
<comment>Description:</comment>
  Returns the first value in the sequence
  
  Returns the first value in the sequence.

<comment>Return:</comment>
  <info>mixed</info>  The first value in the sequence.


id: Ds\Sequence::insert
type: function
doc:
<comment>Description:</comment>
  Inserts values at a given index
  
  Inserts values into the sequence at a given index.

<comment>Param:</comment>
  <info>int</info>    <strong>$index</strong>   The index at which to insert. 0 \<= index \<= count
                  
                  You can insert at the index equal to the number of values.
  <info>mixed</info>  <strong>$values</strong>  The value or values to insert.

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


id: Ds\Sequence::join
type: function
doc:
<comment>Description:</comment>
  Joins all values together as a string
  
  Joins all values together as a string using an optional separator between each value.

<comment>Param:</comment>
  <info>string</info>  <strong>$glue</strong>  An optional string to separate each value.

<comment>Return:</comment>
  <info>string</info>  All values of the sequence joined together as a string.


id: Ds\Sequence::last
type: function
doc:
<comment>Description:</comment>
  Returns the last value
  
  Returns the last value in the sequence.

<comment>Return:</comment>
  <info>mixed</info>  The last value in the sequence.


id: Ds\Sequence::map
type: function
doc:
<comment>Description:</comment>
  Returns the result of applying a callback to each value
  
  Returns the result of applying a <strong>$callback</strong> function to each value in the sequence.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  <info>mixed</info>callback<info>mixed</info><strong>$value</strong>
                       
                       A <info>callable</info> to apply to each value in the sequence.
                       
                       The callable should return what the new value will be in the new sequence.

<comment>Return:</comment>
  <info>Ds\Sequence</info>  The result of applying a <strong>$callback</strong> to each value in the sequence.
               
               The values of the current instance won't be affected.


id: Ds\Sequence::merge
type: function
doc:
<comment>Description:</comment>
  Returns the result of adding all given values to the sequence
  
  Returns the result of adding all given values to the sequence.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$values</strong>  A <class>traversable</class> object or an <info>array</info>.

<comment>Return:</comment>
  <info>Ds\Sequence</info>  The result of adding all given values to the sequence, effectively the same as adding
               the values to a copy, then returning that copy.
               
               The current instance won't be affected.


id: Ds\Sequence::push
type: function
doc:
<comment>Description:</comment>
  Adds values to the end of the sequence
  
  Adds values to the end of the sequence.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$values</strong>  The values to add.

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


id: Ds\Sequence::reduce
type: function
doc:
<comment>Description:</comment>
  Reduces the sequence to a single value using a callback function
  
  Reduces the sequence to a single value using a callback function.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  The return value of the previous callback, or <strong>$initial</strong> if it's the first
                       iteration.
                       
                       The value of the current iteration.
  <info>mixed</info>     <strong>$carry</strong>     The return value of the previous callback, or <strong>$initial</strong> if it's the first
                       iteration.
  <info>mixed</info>     <strong>$value</strong>     The value of the current iteration.
  <info>mixed</info>     <strong>$initial</strong>   The initial value of the carry value. Can be <info>null</info>.

<comment>Return:</comment>
  <info>mixed</info>  The return value of the final callback.


id: Ds\Sequence::reverse
type: function
doc:
<comment>Description:</comment>
  Reverses the sequence in-place
    
  
  Reverses the sequence in-place.

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


id: Ds\Sequence::reversed
type: function
doc:
<comment>Description:</comment>
  Returns a reversed copy
  
  Returns a reversed copy of the sequence.

<comment>Return:</comment>
  <info>Ds\Sequence</info>  A reversed copy of the sequence.
                 The current instance is not affected. 
               
               The current instance is not affected.


id: Ds\Sequence::rotate
type: function
doc:
<comment>Description:</comment>
  Rotates the sequence by a given number of rotations
  
  Rotates the sequence by a given number of rotations, which is equivalent to successively calling
  $sequence-&gt;push($sequence-&gt;shift()) if the number of rotations is positive, or
  $sequence-&gt;unshift($sequence-&gt;pop()) if negative.

<comment>Param:</comment>
  <info>int</info>  <strong>$rotations</strong>  The number of times the sequence should be rotated.

<comment>Return:</comment>
  <info>void</info>  値を返しません。. The sequence of the current instance will be rotated.


id: Ds\Sequence::slice
type: function
doc:
<comment>Description:</comment>
  Returns a sub-sequence of a given range
    
  
  Creates a sub-sequence of a given range.

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>   The index at which the sub-sequence starts.
                
                If positive, the sequence will start at that index in the sequence. If negative, the
                sequence will start that far from the end.
  <info>int</info>  <strong>$length</strong>  If a length is given and is positive, the resulting sequence will have up to that
                many values in it.
                 If the length results in an overflow, only values up to the end of the sequence
                will be included.
                 If a length is given and is negative, the sequence will stop that many values from
                the end.
                 If a length is not provided, the resulting sequence will contain all values between
                the index and the end of the sequence.

<comment>Return:</comment>
  <info>Ds\Sequence</info>  A sub-sequence of the given range.


id: Ds\Sequence::sort
type: function
doc:
<comment>Description:</comment>
  Sorts the sequence in-place
   
  
  Sorts the sequence in-place, using an optional <strong>$comparator</strong> function.

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

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


id: Ds\Sequence::sorted
type: function
doc:
<comment>Description:</comment>
  Returns a sorted copy
  
  Returns a sorted copy, using an optional <strong>$comparator</strong> function.

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

<comment>Return:</comment>
  <info>Ds\Sequence</info>  Returns a sorted copy of the sequence.


id: Ds\Sequence::sum
type: function
doc:
<comment>Description:</comment>
  Returns the sum of all values in the sequence
  
  Returns the sum of all values in the sequence.
  
  Arrays and objects are considered equal to zero when calculating the sum.

<comment>Return:</comment>
  <info>int|float</info>  The sum of all the values in the sequence as either a <info>float</info> or <info>int</info> depending on the
             values in the sequence.


id: Ds\Sequence::unshift
type: function
doc:
<comment>Description:</comment>
  Adds values to the front of the sequence
  
  Adds values to the front of the sequence, moving all the current values forward to make room for
  the new values.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$values</strong>  The values to add to the front of the sequence.  Multiple values will be added in
                  the same order that they are passed.
                  
                  Multiple values will be added in the same order that they are passed.

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


id: Ds\Set
type: class
doc:
<comment>Description:</comment>
  A Set is a sequence of unique values. This implementation uses the same hash table as <class>Ds\Map</class>,
  where values are used as keys and the mapped value is ignored.


id: Ds\Set::add
type: function
doc:
<comment>Description:</comment>
  Adds values to the set
  
  Adds all given values to the set that haven't already been added.
  
  Values of type <info>object</info> are supported.
   If an object implements <class>Ds\Hashable</class>, equality will be determined by the object's equals function.
   If an object does not implement <class>Ds\Hashable</class>, objects must be references to the same instance to
  be considered equal.
  
  All comparisons are strict (type and value).

<comment>Param:</comment>
  <info>mixed</info>  <strong>$values</strong>  Values to add to the set.

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


id: Ds\Set::clear
type: function
doc:
<comment>Description:</comment>
  Removes all values
  
  Removes all values from the set.

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


id: Ds\Set::contains
type: function
doc:
<comment>Description:</comment>
  Determines if the set contains all values
  
  Determines if the set contains all values.
  
  Values of type <info>object</info> are supported.
   If an object implements <class>Ds\Hashable</class>, equality will be determined by the object's equals function.
   If an object does not implement <class>Ds\Hashable</class>, objects must be references to the same instance to
  be considered equal.
  
  All comparisons are strict (type and value).

<comment>Param:</comment>
  <info>mixed</info>  <strong>$values</strong>  Values to check.

<comment>Return:</comment>
  <info>bool</info>  <info>false</info> if any of the provided <strong>$values</strong> are not in the set, <info>true</info> otherwise.


id: Ds\Set::copy
type: function
doc:
<comment>Description:</comment>
  Returns a shallow copy of the set
  
  Returns a shallow copy of the set.

<comment>Return:</comment>
  <info>Ds\Set</info>  Returns a shallow copy of the set.


id: Ds\Set::count
type: function
doc:
<comment>Description:</comment>
  Returns the number of values in the set
  
  See <strong>Countable::count()</strong>


id: Ds\Set::diff
type: function
doc:
<comment>Description:</comment>
  Creates a new set using values that aren't in another set
  
  Creates a new set using values that aren't in another set.
  
  A \ B = {x ∈ A | x ∉ B}

<comment>Param:</comment>
  <info>Ds\Set</info>  <strong>$set</strong>  Set containing the values to exclude.

<comment>Return:</comment>
  <info>Ds\Set</info>  A new set containing all values that were not in the other <strong>$set</strong>.

<comment>See Also:</comment>
   * Complement on Wikipedia


id: Ds\Set::filter
type: function
doc:
<comment>Description:</comment>
  Creates a new set using a callable to
      determine which values to include
    
  
  Creates a new set using a <info>callable</info> to determine which values to include.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  <info>bool</info>callback<info>mixed</info><strong>$value</strong>
                       
                       Optional <info>callable</info> which returns <info>true</info> if the value should be included, <info>false</info>
                       otherwise.
                       
                       If a callback is not provided, only values which are <info>true</info> (see converting to
                       boolean) will be included.

<comment>Return:</comment>
  <info>Ds\Set</info>  A new set containing all the values for which either the <strong>$callback</strong> returned <info>true</info>, or all
          values that convert to <info>true</info> if a <strong>$callback</strong> was not provided.


id: Ds\Set::first
type: function
doc:
<comment>Description:</comment>
  Returns the first value in the set
  
  Returns the first value in the set.

<comment>Return:</comment>
  <info>mixed</info>  The first value in the set.


id: Ds\Set::intersect
type: function
doc:
<comment>Description:</comment>
  Creates a new set by intersecting values with another set
  
  Creates a new set using values common to both the current instance and another <strong>$set</strong>.
   In other words, returns a copy of the current instance with all values removed that are not in
  the other <strong>$set</strong>.
  
  A ∩ B = {x : x ∈ A ∧ x ∈ B}

<comment>Param:</comment>
  <info>Ds\Set</info>  <strong>$set</strong>  The other set.

<comment>Return:</comment>
  <info>Ds\Set</info>  The intersection of the current instance and another <strong>$set</strong>.

<comment>See Also:</comment>
   * Intersection on Wikipedia


id: Ds\Set::isEmpty
type: function
doc:
<comment>Description:</comment>
  Returns whether the set is empty
  
  Returns whether the set is empty.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the set is empty, <info>false</info> otherwise.


id: Ds\Set::join
type: function
doc:
<comment>Description:</comment>
  Joins all values together as a string
  
  Joins all values together as a string using an optional separator between each value.

<comment>Param:</comment>
  <info>string</info>  <strong>$glue</strong>  An optional string to separate each value.

<comment>Return:</comment>
  <info>string</info>  All values of the set joined together as a string.


id: Ds\Set::last
type: function
doc:
<comment>Description:</comment>
  Returns the last value in the set
  
  Returns the last value in the set.

<comment>Return:</comment>
  <info>mixed</info>  The last value in the set.


id: Ds\Set::merge
type: function
doc:
<comment>Description:</comment>
  Returns the result of adding all given values to the set
  
  Returns the result of adding all given values to the set.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$values</strong>  A <class>traversable</class> object or an <info>array</info>.

<comment>Return:</comment>
  <info>Ds\Set</info>  The result of adding all given values to the set, effectively the same as adding the
          values to a copy, then returning that copy.
          
          The current instance won't be affected.


id: Ds\Set::reduce
type: function
doc:
<comment>Description:</comment>
  Reduces the set to a single value using a callback function
  
  Reduces the set to a single value using a callback function.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  The return value of the previous callback, or <strong>$initial</strong> if it's the first
                       iteration.
                       
                       The value of the current iteration.
  <info>mixed</info>     <strong>$carry</strong>     The return value of the previous callback, or <strong>$initial</strong> if it's the first
                       iteration.
  <info>mixed</info>     <strong>$value</strong>     The value of the current iteration.
  <info>mixed</info>     <strong>$initial</strong>   The initial value of the carry value. Can be <info>null</info>.

<comment>Return:</comment>
  <info>mixed</info>  The return value of the final callback.


id: Ds\Set::remove
type: function
doc:
<comment>Description:</comment>
  Removes all given values from the set
  
  Removes all given <strong>$values</strong> from the set, ignoring any that are not in the set.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$values</strong>  The values to remove.

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


id: Ds\Set::reverse
type: function
doc:
<comment>Description:</comment>
  Reverses the set in-place
    
  
  Reverses the set in-place.

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


id: Ds\Set::reversed
type: function
doc:
<comment>Description:</comment>
  Returns a reversed copy
  
  Returns a reversed copy of the set.

<comment>Return:</comment>
  <info>Ds\Set</info>  A reversed copy of the set.
            The current instance is not affected. 
          
          The current instance is not affected.


id: Ds\Set::slice
type: function
doc:
<comment>Description:</comment>
  Returns a sub-set of a given range
    
  
  Creates a sub-set of a given range.

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>   The index at which the sub-set starts.
                
                If positive, the set will start at that index in the set. If negative, the set will
                start that far from the end.
  <info>int</info>  <strong>$length</strong>  If a length is given and is positive, the resulting set will have up to that many
                values in it.
                 If the length results in an overflow, only values up to the end of the set will be
                included.
                 If a length is given and is negative, the set will stop that many values from the
                end.
                 If a length is not provided, the resulting set will contain all values between the
                index and the end of the set.

<comment>Return:</comment>
  <info>Ds\Set</info>  A sub-set of the given range.


id: Ds\Set::sort
type: function
doc:
<comment>Description:</comment>
  Sorts the set in-place
   
  
  Sorts the set in-place, using an optional <strong>$comparator</strong> function.

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

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


id: Ds\Set::sorted
type: function
doc:
<comment>Description:</comment>
  Returns a sorted copy
  
  Returns a sorted copy, using an optional <strong>$comparator</strong> function.

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

<comment>Return:</comment>
  <info>Ds\Set</info>  Returns a sorted copy of the set.


id: Ds\Set::sum
type: function
doc:
<comment>Description:</comment>
  Returns the sum of all values in the set
  
  Returns the sum of all values in the set.
  
  Arrays and objects are considered equal to zero when calculating the sum.

<comment>Return:</comment>
  <info>int|float</info>  The sum of all the values in the set as either a <info>float</info> or <info>int</info> depending on the values
             in the set.


id: Ds\Set::toArray
type: function
doc:
<comment>Description:</comment>
  Converts the set to an array
    
  
  Converts the set to an <info>array</info>.
  
  Casting to an <info>array</info> is not supported yet.

<comment>Return:</comment>
  <info>array</info>  An <info>array</info> containing all the values in the same order as the set.


id: Ds\Set::union
type: function
doc:
<comment>Description:</comment>
  Creates a new set using values from the current instance and another set
  
  Creates a new set that contains the values of the current instance as well as the values of
  another <strong>$set</strong>.
  
  A ∪ B = {x: x ∈ A ∨ x ∈ B}

<comment>Param:</comment>
  <info>Ds\Set</info>  <strong>$set</strong>  The other set, to combine with the current instance.

<comment>Return:</comment>
  <info>Ds\Set</info>  A new set containing all the values of the current instance as well as another <strong>$set</strong>.

<comment>See Also:</comment>
   * Union on Wikipedia


id: Ds\Set::xor
type: function
doc:
<comment>Description:</comment>
  Creates a new set using values in either the current instance or in another set, but not in both
  
  Creates a new set containing values in the current instance as well as another <strong>$set</strong>, but not in
  both.
  
  A ⊖ B = {x : x ∈ (A \ B) ∪ (B \ A)}

<comment>Param:</comment>
  <info>Ds\Set</info>  <strong>$set</strong>  The other set.

<comment>Return:</comment>
  <info>Ds\Set</info>  A new set containing values in the current instance as well as another <strong>$set</strong>, but not in
          both.

<comment>See Also:</comment>
   * Symmetric Difference on Wikipedia


id: Ds\Stack
type: class
doc:
<comment>Description:</comment>
  A Stack is a “last in, first out” or “LIFO” collection that only allows access to the value at the
  top of the structure and iterates in that order, destructively.
  
  Uses a <class>Ds\Vector</class> internally.


id: Ds\Stack::clear
type: function
doc:
<comment>Description:</comment>
  Removes all values
  
  Removes all values from the stack.

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


id: Ds\Stack::copy
type: function
doc:
<comment>Description:</comment>
  Returns a shallow copy of the stack
  
  Returns a shallow copy of the stack.

<comment>Return:</comment>
  <info>Ds\Stack</info>  Returns a shallow copy of the stack.


id: Ds\Stack::count
type: function
doc:
<comment>Description:</comment>
  Returns the number of values in the stack
  
  See <strong>Countable::count()</strong>


id: Ds\Stack::isEmpty
type: function
doc:
<comment>Description:</comment>
  Returns whether the stack is empty
  
  Returns whether the stack is empty.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the stack is empty, <info>false</info> otherwise.


id: Ds\Stack::peek
type: function
doc:
<comment>Description:</comment>
  Returns the value at the top of the stack
  
  Returns the value at the top of the stack, but does not remove it.

<comment>Return:</comment>
  <info>mixed</info>  The value at the top of the stack.


id: Ds\Stack::pop
type: function
doc:
<comment>Description:</comment>
  Removes and returns the value at the top of the stack
  
  Removes and returns the value at the top of the stack.

<comment>Return:</comment>
  <info>mixed</info>  The removed value which was at the top of the stack.


id: Ds\Stack::push
type: function
doc:
<comment>Description:</comment>
  Pushes values onto the stack
  
  Pushes <strong>$values</strong> onto the stack.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$values</strong>  The values to push onto the stack.

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


id: Ds\Stack::toArray
type: function
doc:
<comment>Description:</comment>
  Converts the stack to an array
    
  
  Converts the stack to an <info>array</info>.
  
  Casting to an <info>array</info> is not supported yet.

<comment>Return:</comment>
  <info>array</info>  An <info>array</info> containing all the values in the same order as the stack.


id: Ds\Vector
type: class
doc:
<comment>Description:</comment>
  A Vector is a sequence of values in a contiguous buffer that grows and shrinks automatically. It’s
  the most efficient sequential structure because a value’s index is a direct mapping to its index
  in the buffer, and the growth factor isn't bound to a specific multiple or exponent.


id: Ds\Vector::apply
type: function
doc:
<comment>Description:</comment>
  Updates all values by applying a callback function to each value
  
  Updates all values by applying a <strong>$callback</strong> function to each value in the vector.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  <info>mixed</info>callback<info>mixed</info><strong>$value</strong>
                       
                       A <info>callable</info> to apply to each value in the vector.
                       
                       The callback should return what the value should be replaced by.

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


id: Ds\Vector::clear
type: function
doc:
<comment>Description:</comment>
  Removes all values
  
  Removes all values from the vector.

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


id: Ds\Vector::contains
type: function
doc:
<comment>Description:</comment>
  Determines if the vector contains given values
  
  Determines if the vector contains all values.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$values</strong>  Values to check.

<comment>Return:</comment>
  <info>bool</info>  <info>false</info> if any of the provided <strong>$values</strong> are not in the vector, <info>true</info> otherwise.


id: Ds\Vector::copy
type: function
doc:
<comment>Description:</comment>
  Returns a shallow copy of the vector
  
  Returns a shallow copy of the vector.

<comment>Return:</comment>
  <info>Ds\Vector</info>  Returns a shallow copy of the vector.


id: Ds\Vector::filter
type: function
doc:
<comment>Description:</comment>
  Creates a new vector using a callable to
      determine which values to include
   
  
  Creates a new vector using a <info>callable</info> to determine which values to include.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  <info>bool</info>callback<info>mixed</info><strong>$value</strong>
                       
                       Optional <info>callable</info> which returns <info>true</info> if the value should be included, <info>false</info>
                       otherwise.
                       
                       If a callback is not provided, only values which are <info>true</info> (see converting to
                       boolean) will be included.

<comment>Return:</comment>
  <info>Ds\Vector</info>  A new vector containing all the values for which either the <strong>$callback</strong> returned <info>true</info>, or
             all values that convert to <info>true</info> if a <strong>$callback</strong> was not provided.


id: Ds\Vector::first
type: function
doc:
<comment>Description:</comment>
  Returns the first value in the vector
  
  Returns the first value in the vector.

<comment>Return:</comment>
  <info>mixed</info>  The first value in the vector.


id: Ds\Vector::insert
type: function
doc:
<comment>Description:</comment>
  Inserts values at a given index
  
  Inserts values into the vector at a given index.

<comment>Param:</comment>
  <info>int</info>    <strong>$index</strong>   The index at which to insert. 0 \<= index \<= count
                  
                  You can insert at the index equal to the number of values.
  <info>mixed</info>  <strong>$values</strong>  The value or values to insert.

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


id: Ds\Vector::isEmpty
type: function
doc:
<comment>Description:</comment>
  Returns whether the vector is empty
  
  Returns whether the vector is empty.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the vector is empty, <info>false</info> otherwise.


id: Ds\Vector::join
type: function
doc:
<comment>Description:</comment>
  Joins all values together as a string
  
  Joins all values together as a string using an optional separator between each value.

<comment>Param:</comment>
  <info>string</info>  <strong>$glue</strong>  An optional string to separate each value.

<comment>Return:</comment>
  <info>string</info>  All values of the vector joined together as a string.


id: Ds\Vector::last
type: function
doc:
<comment>Description:</comment>
  Returns the last value
  
  Returns the last value in the vector.

<comment>Return:</comment>
  <info>mixed</info>  The last value in the vector.


id: Ds\Vector::map
type: function
doc:
<comment>Description:</comment>
  Returns the result of applying a callback to each value
  
  Returns the result of applying a <strong>$callback</strong> function to each value in the vector.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  <info>mixed</info>callback<info>mixed</info><strong>$value</strong>
                       
                       A <info>callable</info> to apply to each value in the vector.
                       
                       The callable should return what the new value will be in the new vector.

<comment>Return:</comment>
  <info>Ds\Vector</info>  The result of applying a <strong>$callback</strong> to each value in the vector.
             
             The values of the current instance won't be affected.


id: Ds\Vector::merge
type: function
doc:
<comment>Description:</comment>
  Returns the result of adding all given values to the vector
  
  Returns the result of adding all given values to the vector.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$values</strong>  A <class>traversable</class> object or an <info>array</info>.

<comment>Return:</comment>
  <info>Ds\Vector</info>  The result of adding all given values to the vector, effectively the same as adding the
             values to a copy, then returning that copy.
             
             The current instance won't be affected.


id: Ds\Vector::push
type: function
doc:
<comment>Description:</comment>
  Adds values to the end of the vector
  
  Adds values to the end of the vector.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$values</strong>  The values to add.

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


id: Ds\Vector::reduce
type: function
doc:
<comment>Description:</comment>
  Reduces the vector to a single value using a callback function
  
  Reduces the vector to a single value using a callback function.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  The return value of the previous callback, or <strong>$initial</strong> if it's the first
                       iteration.
                       
                       The value of the current iteration.
  <info>mixed</info>     <strong>$carry</strong>     The return value of the previous callback, or <strong>$initial</strong> if it's the first
                       iteration.
  <info>mixed</info>     <strong>$value</strong>     The value of the current iteration.
  <info>mixed</info>     <strong>$initial</strong>   The initial value of the carry value. Can be <info>null</info>.

<comment>Return:</comment>
  <info>mixed</info>  The return value of the final callback.


id: Ds\Vector::reverse
type: function
doc:
<comment>Description:</comment>
  Reverses the vector in-place
    
  
  Reverses the vector in-place.

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


id: Ds\Vector::reversed
type: function
doc:
<comment>Description:</comment>
  Returns a reversed copy
  
  Returns a reversed copy of the vector.

<comment>Return:</comment>
  <info>Ds\Vector</info>  A reversed copy of the vector.
               The current instance is not affected. 
             
             The current instance is not affected.


id: Ds\Vector::rotate
type: function
doc:
<comment>Description:</comment>
  Rotates the vector by a given number of rotations
  
  Rotates the vector by a given number of rotations, which is equivalent to successively calling
  $vector-&gt;push($vector-&gt;shift()) if the number of rotations is positive, or
  $vector-&gt;unshift($vector-&gt;pop()) if negative.

<comment>Param:</comment>
  <info>int</info>  <strong>$rotations</strong>  The number of times the vector should be rotated.

<comment>Return:</comment>
  <info>void</info>  値を返しません。. The vector of the current instance will be rotated.


id: Ds\Vector::slice
type: function
doc:
<comment>Description:</comment>
  Returns a sub-vector of a given range
    
  
  Creates a sub-vector of a given range.

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>   The index at which the sub-vector starts.
                
                If positive, the vector will start at that index in the vector. If negative, the
                vector will start that far from the end.
  <info>int</info>  <strong>$length</strong>  If a length is given and is positive, the resulting vector will have up to that many
                values in it.
                 If the length results in an overflow, only values up to the end of the vector will
                be included.
                 If a length is given and is negative, the vector will stop that many values from
                the end.
                 If a length is not provided, the resulting vector will contain all values between
                the index and the end of the vector.

<comment>Return:</comment>
  <info>Ds\Vector</info>  A sub-vector of the given range.


id: Ds\Vector::sort
type: function
doc:
<comment>Description:</comment>
  Sorts the vector in-place
   
  
  Sorts the vector in-place, using an optional <strong>$comparator</strong> function.

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

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


id: Ds\Vector::sorted
type: function
doc:
<comment>Description:</comment>
  Returns a sorted copy
  
  Returns a sorted copy, using an optional <strong>$comparator</strong> function.

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

<comment>Return:</comment>
  <info>Ds\Vector</info>  Returns a sorted copy of the vector.


id: Ds\Vector::sum
type: function
doc:
<comment>Description:</comment>
  Returns the sum of all values in the vector
  
  Returns the sum of all values in the vector.
  
  Arrays and objects are considered equal to zero when calculating the sum.

<comment>Return:</comment>
  <info>int|float</info>  The sum of all the values in the vector as either a <info>float</info> or <info>int</info> depending on the
             values in the vector.


id: Ds\Vector::toArray
type: function
doc:
<comment>Description:</comment>
  Converts the vector to an array
    
  
  Converts the vector to an <info>array</info>.
  
  Casting to an <info>array</info> is not supported yet.

<comment>Return:</comment>
  <info>array</info>  An <info>array</info> containing all the values in the same order as the vector.


id: Ds\Vector::unshift
type: function
doc:
<comment>Description:</comment>
  Adds values to the front of the vector
  
  Adds values to the front of the vector, moving all the current values forward to make room for the
  new values.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$values</strong>  The values to add to the front of the vector.  Multiple values will be added in
                  the same order that they are passed.
                  
                  Multiple values will be added in the same order that they are passed.

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


id: EIO_READDIR_DENTS
type: constant
doc:
<comment>Description:</comment>
  <strong>eio_readdir()</strong> のフラグ。指定すると、コールバックの result 引数が次のキーを持つ配列になります。
  <return>'names'</return> - ディレクトリ名の配列／ <return>'dents'</return> - <return>struct eio_dirent</return> 風の配列で、 それぞれがさらに以下の
  キーを持ちます ( <return>'name'</return> - ディレクトリ名／ <return>'type'</return> - EIO_DT_* 定数のいずれか／ <return>'inode'</return> - inode 番
  号。存在しない場合は不定 )


id: EIO_READDIR_STAT_ORDER
type: constant
doc:
<comment>Description:</comment>
  このフラグを指定すると、名前を返すときの順序が 各ファイルを <return>stat</return> するのに適した順となります。 指定
  したディレクトリにあるすべてのファイルを <strong>stat()</strong> するつもりなら、この順にしておけば最速になります。


id: ENCHANT_ISPELL
type: constant
doc:
<comment>Description:</comment>
  Ispell 用の辞書の型。 <strong>enchant_broker_get_dict_path()</strong> や <strong>enchant_broker_set_dict_path()</strong> で利用しま
  す。 PHP 8.0.0 以降では推奨されません。


id: ENCHANT_MYSPELL
type: constant
doc:
<comment>Description:</comment>
  MySpell 用の辞書の型。 <strong>enchant_broker_get_dict_path()</strong> や <strong>enchant_broker_set_dict_path()</strong> で利用しま
  す。 PHP 8.0.0 以降では推奨されません。


id: EXIF_USE_MBSTRING
type: constant
doc:
<comment>Description:</comment>
  mbstring が有効な場合、 この定数は <return>1</return> という値です。 それ以外の場合、値は <return>0</return> です。


id: EXP_TIMEOUT
type: constant
doc:
<comment>Description:</comment>
  expect.timeout で指定した秒数を こえた際に <strong>expect_expectl()</strong> が返す値です。


id: E_USER_NOTICE
type: constant
doc:
<comment>Description:</comment>
  ユーザーによって発行される注意メッセージ。<info>E_NOTICE</info>に に似ているがPHPコード上で<strong>trigger_error()</strong>関数
  を 使用した場合に発行される点が違う。


id: EmptyIterator::current
type: function
doc:
<comment>Description:</comment>
  current() メソッド
  
  このメソッドをコールしてはいけません。アクセスされると例外をスローします。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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


id: EmptyIterator::key
type: function
doc:
<comment>Description:</comment>
  key() メソッド
  
  このメソッドをコールしてはいけません。アクセスされると例外をスローします。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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


id: EmptyIterator::next
type: function
doc:
<comment>Description:</comment>
  next() メソッド
  
  何もしません。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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


id: EmptyIterator::rewind
type: function
doc:
<comment>Description:</comment>
  rewind() メソッド
  
  何もしません。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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


id: EmptyIterator::valid
type: function
doc:
<comment>Description:</comment>
  valid() メソッド
  
  EmptyIterator の valid() メソッドです。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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


id: EnchantBroker
type: class
doc:
<comment>Description:</comment>
  PHP 8.0.0 以降、 <return>enchant_broker</return> リソースを置き換える完全不透明クラスです。


id: EnchantDictionary
type: class
doc:
<comment>Description:</comment>
  PHP 8.0.0 以降、 <return>enchant_dict</return> リソースを置き換える完全不透明クラスです。


id: Error::__clone
type: function
doc:
<comment>Description:</comment>
  エラーをクローンする
  
  エラーはクローンできないので、このメソッドは fatal エラーとなります。

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


id: Error::__construct
type: function
doc:
<comment>Description:</comment>
  エラーオブジェクトを生成する
  
  エラーを生成する。

<comment>Param:</comment>
  <info>string</info>          <strong>$message</strong>   エラーメッセージ。
  <info>int</info>             <strong>$code</strong>      エラーコード。
  <info>Throwable|null</info>  <strong>$previous</strong>  例外チェーンに使われる、直前のスロー可能オブジェクト。


id: Error::__toString
type: function
doc:
<comment>Description:</comment>
  エラーの文字列表現
  
  エラーの <info>string</info> 型の表現を返します

<comment>Return:</comment>
  <info>string</info>  エラーの <info>string</info> 型の表現を返します

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


id: Error::getCode
type: function
doc:
<comment>Description:</comment>
  エラーコードを取得する
  
  エラーコードを返します

<comment>Return:</comment>
  <info>int</info>  エラーコードを <info>int</info> 型として返します

<comment>See Also:</comment>
   * Throwable::getCode


id: Error::getFile
type: function
doc:
<comment>Description:</comment>
  エラーが起きたファイルを取得する
  
  エラーが起きたファイル名を取得します

<comment>Return:</comment>
  <info>string</info>  エラーが起きたファイル名を返します

<comment>See Also:</comment>
   * Throwable::getFile


id: Error::getLine
type: function
doc:
<comment>Description:</comment>
  エラーが起きた行番号を取得する
  
  エラーが起きた行番号を取得します

<comment>Return:</comment>
  <info>int</info>  エラーが起きた行番号を返します

<comment>See Also:</comment>
   * Throwable::getLine


id: Error::getMessage
type: function
doc:
<comment>Description:</comment>
  エラーメッセージを取得する
  
  エラーメッセージを返す。

<comment>Return:</comment>
  <info>string</info>  エラーメッセージを文字列で返す。

<comment>See Also:</comment>
   * Throwable::getMessage


id: Error::getPrevious
type: function
doc:
<comment>Description:</comment>
  直前の Throwable を返す
  
  直前の Throwable（Error::__construct の3番目の引数）を返す。

<comment>Return:</comment>
  <info>Throwable|null</info>  直前の <class>Throwable</class> が利用可能であればそれを返し、 そうでなければ <info>null</info> を返す。

<comment>See Also:</comment>
   * Throwable::getPrevious


id: Error::getTrace
type: function
doc:
<comment>Description:</comment>
  スタックトレースを取得する
  
  スタックトレースを返します

<comment>Return:</comment>
  <info>array</info>  スタックトレースを <info>array</info> として返します

<comment>See Also:</comment>
   * Throwable::getTrace


id: Error::getTraceAsString
type: function
doc:
<comment>Description:</comment>
  スタックトレースを文字列として取得する
  
  スタックトレースを文字列として返します

<comment>Return:</comment>
  <info>string</info>  スタックトレースを文字列として返します

<comment>See Also:</comment>
   * Throwable::getTraceAsString


id: ErrorException::__construct
type: function
doc:
<comment>Description:</comment>
  例外を作成する
  
  例外を作成します。

<comment>Param:</comment>
  <info>string</info>          <strong>$message</strong>   スローする例外メッセージ。
  <info>int</info>             <strong>$code</strong>      例外コード。
  <info>int</info>             <strong>$severity</strong>  例外の深刻度。
                             
                             任意の <info>int</info> を設定できますが、ここでは エラー定数 を用いることを想定して
                             います。
  <info>string|null</info>     <strong>$filename</strong>  例外がスローされたファイル名。
  <info>int|null</info>        <strong>$line</strong>      例外がスローされた行番号。
  <info>Throwable|null</info>  <strong>$previous</strong>  ひとつ前の例外。例外の連結に使います。


id: ErrorException::getSeverity
type: function
doc:
<comment>Description:</comment>
  例外の深刻度を取得する
  
  例外の深刻度を返します。

<comment>Return:</comment>
  <info>int</info>  例外の深刻度レベルを返します。


id: Ev::BACKEND_ALL
type: constant
doc:
<comment>Description:</comment>
  壊れているものも含めて、すべてのバックエンドを試します。 これを明示的に使うことは推奨しません。
  ビット演算子を使って、 <info>Ev::BACKEND_ALL</info> & ~ <info>Ev::BACKEND_KQUEUE</info> のようにするか、
  Ev::recommendedBackends を使うか、あるいは何もバックエンドを指定しないようにしましょう。


id: Ev::BACKEND_EPOLL
type: constant
doc:
<comment>Description:</comment>
  Linux 限定の <return>epoll(7)</return> バックエンド。2.6.9 以前のカーネルでもそれ以降のカーネルでも使えます。


id: Ev::BACKEND_KQUEUE
type: constant
doc:
<comment>Description:</comment>
  <return>kqueue</return> バックエンド。大半の BSD システムで利用します。 <class>EvEmbed</class> ウォッチャーを使って、 kqueue バッ
  クエンドのループを別のループに埋め込むことができます。 たとえば、 <return>kqueue</return> バックエンドのループを
  作って、 それをソケットに対してだけ使うこともできます。


id: Ev::BACKEND_MASK
type: constant
doc:
<comment>Description:</comment>
  これはバックエンドではなく、 <strong>$flags</strong> の中のすべてのバックエンドビットをマスクするものです。 たとえ
  ば、環境変数 LIBEV_FLAGS を変更するときに使います。


id: Ev::CHECK
type: constant
doc:
<comment>Description:</comment>
  すべての <class>EvCheck</class> ウォッチャーが、 Ev::run が新しいイベントをとりまとめた直後 (ただし受信したイベン
  トのコールバックをキューに入れる前) にキューに入ります。つまり、 イベントループ内で優先度が同じ
  (あるいはより低い) ウォッチャーより前に <class>EvCheck</class> ウォッチャーが起動するということになります。


id: Ev::CHILD
type: constant
doc:
<comment>Description:</comment>
  EvChild::__construct のコンストラクタで指定した <strong>$pid</strong> が、状態の変更を受信しました。


id: Ev::CUSTOM
type: constant
doc:
<comment>Description:</comment>
  まだ <return>libev</return> で送信したりそれ以外の使いかたをしたりはしていませんが、 <return>libev</return> ユーザーが
  (EvWatcher::feed などで) ウォッチャーに通知するために使えます。


id: Ev::ERROR
type: constant
doc:
<comment>Description:</comment>
  指定されていないエラーが発生し、ウォッチャーが停止しました。 これが発生する原因として考えられるの
  は、 <return>libev</return> がメモリ不足でウォッチャーをきちんと開始できなかった場合や ファイルディスクリプタが閉じ
  てしまった場合などがあります。 <return>libev</return> は、これらに関してはアプリケーションのバグとみなします。 詳細
  は ANATOMY OF A WATCHER を参照ください。


id: Ev::FLAG_FORKCHECK
type: constant
doc:
<comment>Description:</comment>
  libev が繰り返しのたびにフォークをチェックするようにします。毎回手動で EvLoop::fork を呼ぶことがな
  くなります。 これを実現するために、ループ内での繰り返しの旅に <return>getpid()</return> を呼んでいます。 そのため、
  繰り返しの回数が増えるとイベントループがスローダウンするかもしれませんが、 通常は気になるほどでは
  ありません。このフラグの設定を上書きしたり、 環境変数 LIBEV_FLAGS で指定したりすることはできませ
  ん。


id: Ev::FLAG_NOENV
type: constant
doc:
<comment>Description:</comment>
  このフラグを使う (あるいは setuid や setgid でプログラムを実行する) と、 <return>libev</return> は環境変数
  LIBEV_FLAGS を見ません。 それ以外の場合 (デフォルト) は、 LIBEV_FLAGS が見つかった場合は その内容
  でフラグを上書きします。パフォーマンステストやバグの調査のときに有用です。


id: Ev::FLAG_NOINOTIFY
type: constant
doc:
<comment>Description:</comment>
  このフラグを指定すると、 <return>libev</return> は ev_stat ウォッチャーに <return>inotify</return> API を使わなくなります。 このフラ
  グは inotify ファイルディスクリプタを節約するのに便利です。 これを使わなければ、<return>ev_stat</return> ウォッ
  チャーを使ったループのたびに <return>inotify</return> ハンドルをひとつずつ消費することになります。


id: Ev::FLAG_NOSIGMASK
type: constant
doc:
<comment>Description:</comment>
  このフラグを指定すると、 <return>libev</return> はシグナルのマスクを変更しないようにします。 具体的には、シグナルが
  受信されるまではブロックしないようになるということです。
  
  これは、自前のシグナル処理をするときに便利です。 また、特定のスレッドでだけシグナルを処理するとい
  う場合にも有用です。


id: Ev::FLAG_SIGNALFD
type: constant
doc:
<comment>Description:</comment>
  このフラグを指定すると、 <return>libev</return> は ev_signal (および ev_child ) ウォッチャーに <return>signalfd</return> API を使お
  うとします。 この API はシグナルを同期的に配送し、高速に処理したり キューに入ったシグナルデータを
  取得できるようにしたりします。 また、スレッドを使ったときのシグナル処理も、 スレッド内でシグナルが
  適切にブロックされている限りはシンプルになります。 デフォルトでは <return>signalfd</return> を使いません。


id: Ev::PREPARE
type: constant
doc:
<comment>Description:</comment>
  すべての <class>EvPrepare</class> ウォッチャーが、 Ev::run の開始前に起動しました。つまり、 イベントループがス
  リープしたり新しいイベントのポーリングをしたりする直前に <class>EvPrepare</class> ウォッチャーが起動するというこ
  とになります。


id: Ev::RUN_NOWAIT
type: constant
doc:
<comment>Description:</comment>
  イベントループが新しいイベントを探し、 新しいイベントや未処理のイベントを処理するけれども、 もしイ
  ベントが見つからない場合は、最初のループですぐに呼び出し元に制御を戻します。 イベントを待つために
  プロセスをブロックしたりはしません。 これは、時間のかかる計算をしているときのポーリングなどに便利
  です。 プログラムの動きを止めることなく新しいイベントを処理できます。


id: Ev::RUN_ONCE
type: constant
doc:
<comment>Description:</comment>
  イベントループが (必要なら待ち続けてでも) 新しいイベントを探し、 その新しいイベントや未処理のイベ
  ントを処理します。 少なくとも一つのイベントがやってくるまで (libev 自身のイベント間隔になるでしょ
  う。 そのため、ユーザー低位のコールバックが呼ばれる保証はありません) プロセスをブロックし ループ処
  理の終了後に呼び出し元に制御を戻します。


id: Ev::backend
type: function
doc:
<comment>Description:</comment>
  libev が使うバックエンドを表す整数値を返す
  
  libev が使うバックエンドを表す整数値を返します。 バックエンドのフラグ も参照ください。

<comment>Return:</comment>
  <info>int</info>  libev が使うバックエンドを表す整数値 (ビットマスク) を返します。

<comment>See Also:</comment>
   * <class>EvEmbed</class>
   * Ev::embeddableBackends
   * Ev::recommendedBackends
   * Ev::supportedBackends
   * バックエンドのフラグ


id: Ev::depth
type: function
doc:
<comment>Description:</comment>
  再帰の深さを返す
  
  Ev::run に入った回数から Ev::run を正常終了した回数を引いた結果、 つまり、再帰の深さを返します。
  Ev::run の外部では、この数は <info>0</info> になります。 コールバックの中では、この数は <info>1</info> になります。ただし、
  Ev::run が再帰的に呼び出されている (あるいは別スレッドから呼び出されている) 場合は、もっと大きな数
  になります。

<comment>Return:</comment>
  <info>int</info>  <strong>ev_depth()</strong> は、デフォルトのループの再帰の深さを返します。

<comment>See Also:</comment>
   * Ev::iteration


id: Ev::embeddableBackends
type: function
doc:
<comment>Description:</comment>
  他のイベントループに埋め込めるバックエンド群を返す
  
  他のイベントループに埋め込めるバックエンド群を返します。

<comment>Return:</comment>
  <info>int</info>  ビットマスクを返します。 バックエンドのフラグ を、ビット OR 演算子で組み合わせたものになりま
       す。

<comment>See Also:</comment>
   * <class>EvEmbed</class>
   * Ev::recommendedBackends
   * Ev::supportedBackends
   * バックエンドのフラグ
   * 例


id: Ev::feedSignal
type: function
doc:
<comment>Description:</comment>
  シグナルイベントを Ev に送る
  
  シグナルの受信をシミュレートします。 この関数は、いつでもどんなコンテキストでも安全に呼べます。 シ
  グナルハンドラやランダムスレッドからでもだいじょうぶです。 主に、プロセス内で自前のシグナル処理を
  行う場合に使います。
  
  Ev::feedSignalEvent とは違い、どのループがシグナルを登録したのかにかかわらず動作します。

<comment>Param:</comment>
  <info>int</info>  <strong>$signum</strong>  シグナル番号。詳細は <return>signal(7)</return> の man ページを参照ください。 <return>pcntl</return> 拡張モジュールが
                公開する定数も使えます。

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

<comment>See Also:</comment>
   * Ev::feedSignalEvent


id: Ev::feedSignalEvent
type: function
doc:
<comment>Description:</comment>
  シグナルイベントの情報をデフォルトループに送る
  
  シグナルイベントをデフォルトループに送ります。 Ev は、<strong>$signal</strong> で指定したシグナルを受け取ったかのよ
  うに反応します。

<comment>Param:</comment>
  <info>int</info>  <strong>$signum</strong>  シグナル番号。詳細は <return>signal(7)</return> の man ページを参照ください。 <return>pcntl</return> 拡張モジュールが
                公開する定数も使えます。

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

<comment>See Also:</comment>
   * Ev::feedSignal


id: Ev::iteration
type: function
doc:
<comment>Description:</comment>
  デフォルトのイベントループが新しいイベントをポーリングした回数を返す
  
  デフォルトのイベントループが新しいイベントをポーリングした回数を返します。 生成カウンターとして有
  用です。

<comment>Return:</comment>
  <info>int</info>  デフォルトのイベントループのポーリング回数を返します。

<comment>See Also:</comment>
   * Ev::depth


id: Ev::now
type: function
doc:
<comment>Description:</comment>
  デフォルトのイベントループで直近の処理が始まった時刻を返す
  
  デフォルトのイベントループで直近の処理が始まった時刻を返します。 これはタイマー (<class>EvTimer</class> および
  <class>EvPeriodic</class>) が基準にしているもので、 通常は Ev::time を呼ぶよりも高速になります。

<comment>Return:</comment>
  <info>float</info>  デフォルトのイベントループで直近の処理が始まった時刻を表す秒数を返します。

<comment>See Also:</comment>
   * Ev::nowUpdate


id: Ev::nowUpdate
type: function
doc:
<comment>Description:</comment>
  カーネルに問い合わせて現在時刻を確認し、処理中の Ev::now が返す時刻を更新する
  
  カーネルに問い合わせて現在時刻を確認し、処理中の Ev::now が返す時刻を更新します。これはコストが高
  い操作で、通常は自動的に Ev::run の中で実行します。
  
  このメソッドが役立つ場面はほとんどありませんが、 たとえば何かのイベントコールバックがイベントルー
  プに入らず長時間処理を続けているときに、 libev が把握する現在時刻を更新するというのがその一つにな
  ります。

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

<comment>See Also:</comment>
   * Ev::now


id: Ev::recommendedBackends
type: function
doc:
<comment>Description:</comment>
  現在のプラットフォーム上でおすすめのバックエンドのビットマスクを返す
  
  この <return>libev</return> のバイナリに組み込まれたすべてのバックエンドと、 中でもこのプラットフォーム上でおすすめ
  のバックエンドを返します。 おすすめとは、多くのファイルディスクリプタ形式に対応しているということ
  です。 このバックエンド群は、<strong>ev_supported_backends()</strong> が返すものより少なくなることがよくあります。
  たとえば <return>kqueue</return> は大半の <return>BSD</return> システムでうまく動かず、 明示的にリクエストしない限り自動検出できない
  からです。 このメソッドが返すバックエンドはどれも、明示的に指定しなくても <return>libev</return> で使えます。

<comment>Return:</comment>
  <info>int</info>  ビットマスクを返します。 バックエンドのフラグ を、ビット OR 演算子で組み合わせたものになりま
       す。

<comment>See Also:</comment>
   * <class>EvEmbed</class>
   * Ev::embeddableBackends
   * Ev::supportedBackends
   * バックエンドのフラグ
   * 例


id: Ev::resume
type: function
doc:
<comment>Description:</comment>
  一時停止していたデフォルトのイベントループを再開させる
  
  Ev::suspend と Ev::resume が、それぞれループの一時停止と再開に対応します。
  
  すべてのタイマーウォッチャーは、 suspend から resume までの時間だけ遅延します。また、すべての定期
  ウォッチャーは再スケジュールされます (つまり、一時停止中に発生したイベントは失うことになります)。
  
  Ev::suspend を呼んだ後は、 そのループ上では Ev::resume 以外の関数を呼べません。 また、先に
  Ev::suspend を呼んでいない状態で Ev::resume は呼べません。
  
  suspend や resume を呼ぶと、 イベントループの時刻を更新するという副作用があります (Ev::nowUpdate
  を参照ください)。

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

<comment>See Also:</comment>
   * Ev::suspend


id: Ev::run
type: function
doc:
<comment>Description:</comment>
  イベントのチェックとデフォルトループのコールバックの呼び出しを開始する
  
  イベントのチェックとデフォルトループのコールバックの呼び出しを開始します。 コールバックが Ev::stop
  メソッドを読んだとき、 あるいは flags がゼロ以外のとき (この場合の戻り値は true) に結果を返しま
  す。あるいは、ループを参照するアクティブなウォッチャーがないとき (EvWatcher::keepalive が <info>true</info>) の
  ときにも結果を返し、このときに返す値は <info>false</info> になります。 戻り値の解釈は、一般的に、 もし <info>true</info> な
  らまだ作業が残っている となります。

<comment>Param:</comment>
  <info>int</info>  <strong>$flags</strong>  オプションのパラメータで、以下のいずれかになります。 <strong>$flags</strong> に指定できる値の一覧
               <strong>$flags</strong>説明<info>0</info>上で述べたデフォルトの挙動。<info>Ev::RUN_ONCE</info>最大 1 件ブロックします (待つけれ
               ども繰り返しません)。<info>Ev::RUN_NOWAIT</info>まったくブロックしません (イベントを取得して処理し
               ますが、待ちません)。
               
               実行フラグ定数 も参照ください。

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

<comment>See Also:</comment>
   * Ev::stop
   * EvLoop::run


id: Ev::sleep
type: function
doc:
<comment>Description:</comment>
  指定した秒数だけプロセスをブロックする
  
  指定した秒数だけプロセスをブロックします。

<comment>Param:</comment>
  <info>float</info>  <strong>$seconds</strong>  秒数。

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


id: Ev::stop
type: function
doc:
<comment>Description:</comment>
  デフォルトのイベントループを止める
  
  デフォルトのイベントループを止めます。

<comment>Param:</comment>
  <info>int</info>  <strong>$how</strong>  Ev::BREAK_*定数 のいずれか。

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

<comment>See Also:</comment>
   * Ev::run


id: Ev::supportedBackends
type: function
doc:
<comment>Description:</comment>
  現在の libev の構成でサポートするバックエンド群を返す
  
  現在の libev の構成でサポートするバックエンド群を返します。

<comment>Return:</comment>
  <info>int</info>  ビットマスクを返します。 バックエンドのフラグ を、ビット OR 演算子で組み合わせたものになりま
       す。

<comment>See Also:</comment>
   * <class>EvEmbed</class>
   * Ev::recommendedBackends
   * Ev::embeddableBackends
   * バックエンドのフラグ
   * 例


id: Ev::suspend
type: function
doc:
<comment>Description:</comment>
  デフォルトのイベントループを一時停止する
  
  Ev::suspend と Ev::resume が、それぞれループの一時停止と再開に対応します。
  
  すべてのタイマーウォッチャーは、 suspend から resume までの時間だけ遅延します。また、すべての定期
  ウォッチャーは再スケジュールされます (つまり、一時停止中に発生したイベントは失うことになります)。
  
  Ev::suspend を呼んだ後は、 そのループ上では Ev::resume 以外の関数を呼べません。 また、先に
  Ev::suspend を呼んでいない状態で Ev::resume は呼べません。

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

<comment>See Also:</comment>
   * Ev::resume


id: Ev::time
type: function
doc:
<comment>Description:</comment>
  epoch から現在時刻までの秒数を返す
  
  epoch から現在時刻までの秒数を返します。 Ev::now を使うことを検討しましょう。

<comment>Return:</comment>
  <info>float</info>  epoch から現在時刻までの秒数を返します。

<comment>See Also:</comment>
   * Ev::now


id: Ev::verify
type: function
doc:
<comment>Description:</comment>
  内部の整合性をチェックする (デバッグ用)
  
  内部の整合性をチェック (libev のデバッグ用) し、もしデータ構造が壊れている場合はプログラムを終了さ
  せます。

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


id: EvCheck
type: class
doc:
<comment>Description:</comment>
  <class>EvPrepare</class> ウォッチャーと <class>EvCheck</class> ウォッチャーは、 通常はペアで使います。 <class>EvPrepare</class> ウォッチャーは
  プロセスをブロックする前に起動し、 <class>EvCheck</class> はブロックした後に起動します。
  
  EvLoop::run あるいはそれに類するメソッドや関数 (現在のイベントループに入るもの) は、<class>EvPrepare</class>
  ウォッチャーや <class>EvCheck</class> ウォッチャーからは呼べません。 現在のループ以外のループは問題ありません。
  その理由は、これらのウォッチャーの中では再帰をチェックする必要がないからです。 つまり、処理の流れ
  は常に <class>EvPrepare</class> -&gt; ブロック -&gt; <class>EvCheck</class> となるので、これらのウォッチャーは常にペアで呼ばれ、
  ブロッキング呼び出しの前後を囲むことになります。
  
  主な利用目的は他のイベント機構を libev に統合することで、 少し高度な使いかたになります。変数の変更
  を追跡したり 自前のウォッチャーを実装したり、net-snmp やコルーチンライブラリを統合したりといった、
  さまざまな用途で使えます。 また、何らかのデータをキャッシュしてブロッキングの前にフラッシュするな
  どの用途で使えることもあります。
  
  <class>EvCheck</class> には最高の優先度 (<info>Ev::MAXPRI</info>) を与えることを推奨します。 これで、ポーリングの後は他のあら
  ゆるウォッチャーよりも先に実行されることが保証されます (<class>EvPrepare</class> ウォッチャーの場合は無鐘鋳で
  す)。
  
  また、<class>EvCheck</class> ウォッチャーはイベントをアクティブにしたり送信したりしてはいけません。 libev では対
  応してはいますが、 他の <class>EvCheck</class> ウォッチャーが仕事をする前に実行される可能性があります。


id: EvCheck::__construct
type: function
doc:
<comment>Description:</comment>
  EvCheck ウォッチャーオブジェクトを作る
  
  <class>EvCheck</class> ウォッチャーオブジェクトを作ります。

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  ウォッチャーのコールバック を参照ください。
  <info>mixed</info>     <strong>$data</strong>      このウォッチャーに関連づけるカスタムデータ。
  <info>int</info>       <strong>$priority</strong>  ウォッチャーの優先度。

<comment>See Also:</comment>
   * <class>EvPrepare</class>
   * EvLoop::check


id: EvCheck::createStopped
type: function
doc:
<comment>Description:</comment>
  停止した EvCheck ウォッチャーのインスタンスを作る
  
  停止した EvCheck ウォッチャーのインスタンスを作ります。

<comment>Param:</comment>
  <info>string</info>  <strong>$callback</strong>  ウォッチャーのコールバック を参照ください。
  <info>string</info>  <strong>$data</strong>      このウォッチャーに関連づけるカスタムデータ。
  <info>string</info>  <strong>$priority</strong>  ウォッチャーの優先度。

<comment>Return:</comment>
  <info>object</info>  成功した場合に EvCheck オブジェクトを返します。

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


id: EvChild
type: class
doc:
<comment>Description:</comment>
  <class>EvChild</class> ウォッチャーは、子プロセスの状態の変更 (たいていは、停止したり終了したりといったもの) に反
  応してこのプロセスが <info>SIGCHLD</info> を受け取ったときに起動します。 <info>EvChild</info> ウォッチャーは、子をフォークし
  た後 (おそらくはすでに終了した後) でインストールしてもかまいません。 ただし、まだイベントループに
  入っていないとき (あるいはウォッチャーから引き続いているとき) に限ります。 つまり、フォークした直
  後に子プロセス用のウォッチャーを登録するのはかまいませんが、 フォークした後でイベントループを何回
  か処理した後で登録したり、次のコールバックの実行時に登録したりすることはできません。
  
  <class>EvChild</class> ウォッチャーは、 デフォルトループ の中でだけ登録できます。


id: EvChild::__construct
type: function
doc:
<comment>Description:</comment>
  EvChild ウォッチャーオブジェクトを作る
  
  <class>EvChild</class> ウォッチャーオブジェクトを作ります。
  
  プロセス ID <strong>$pid</strong> (<strong>$pid</strong> is <info>0</info> の場合は任意の PID) の状態の変更を受信したときに、コールバックを呼びま
  す (状態が変わるのは、プロセスが停止したり強制終了させられたり、 <strong>$trace</strong> が <info>true</info> になったり、さらに
  プロセスを一時停止したり再開したりしたときです)。 言い換えると、あるプロセスが <info>SIGCHLD</info> を受信した
  ときに、 Ev はすべての変更された子プロセスやゾンビ子プロセスの exit/wait 状態を取得してコールバッ
  クを呼びます。
  
  <class>EvChild</class> が終了してから child ウォッチャーをインストールしてもかまいませんが、 イベントループが次の
  イテレーションを始める前でないといけません。 たとえば、最初のプロセスが <return>fork</return> した後で新しい子プロ
  セスが終了するかもしれません。 そのときは、新しい PID の親にだけ <class>EvChild</class> ウォッチャーをインストー
  ルできます。
  
  exit/tracing ステータスや <strong>$pid</strong> にアクセスするには、 ウォッチャーオブジェクトのプロパティ rstatus
  および rpid を使います。
  
  一つの PID に対する PID ウォッチャーの数は無制限で、すべてが呼び出されます。
  
  EvChild::createStopped メソッドは、新しく作ったウォッチャーを開始させません。

<comment>Param:</comment>
  <info>int</info>       <strong>$pid</strong>       状態の変更を待つプロセスの PID (<info>0</info> にすると、すべてのプロセスを対象にします)。
  <info>bool</info>      <strong>$trace</strong>     <info>false</info> にすると、プロセスが終了したときにだけウォッチャーをアクティブにしま
                       す。 <info>true</info> の場合は、プロセスが一時停止したり再開したりしたときにもウォッ
                       チャーをアクティブにします。
  <info>callable</info>  <strong>$callback</strong>  ウォッチャーのコールバック を参照ください。
  <info>mixed</info>     <strong>$data</strong>      このウォッチャーに関連づけるカスタムデータ。
  <info>int</info>       <strong>$priority</strong>  ウォッチャーの優先度。

<comment>See Also:</comment>
   * EvLoop::child


id: EvChild::createStopped
type: function
doc:
<comment>Description:</comment>
  停止した EvChild ウォッチャーのインスタンスを作る
  
  EvChild::__construct と同じですが、ウォッチャーを自動的には開始しません。

<comment>Param:</comment>
  <info>int</info>       <strong>$pid</strong>       EvChild::__construct と同じ。
  <info>bool</info>      <strong>$trace</strong>     EvChild::__construct と同じ。
  <info>callable</info>  <strong>$callback</strong>  ウォッチャーのコールバック を参照ください。
  <info>mixed</info>     <strong>$data</strong>      このウォッチャーに関連づけるカスタムデータ。
  <info>int</info>       <strong>$priority</strong>  ウォッチャーの優先度。

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

<comment>See Also:</comment>
   * EvChild::__construct
   * EvLoop::child


id: EvChild::set
type: function
doc:
<comment>Description:</comment>
  ウォッチャーを設定する

<comment>Param:</comment>
  <info>int</info>   <strong>$pid</strong>    EvChild::__construct と同じ。
  <info>bool</info>  <strong>$trace</strong>  EvChild::__construct と同じ。

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

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


id: EvEmbed::__construct
type: function
doc:
<comment>Description:</comment>
  EvEmbed オブジェクトを作る
  
  これは高度なウォッチャー型で、あるイベントループを別のイベントループに埋め込むことができます。 現
  在は、埋め込みループに対応しているのは IO イベントだけです。 他の型のウォッチャーを使うと、処理が
  遅延したり不正確な動きになったりする可能性があるので、 使ってはいけません。
  
  詳細は、  libev のドキュメント を参照ください。
  
  このウォッチャーは、BSD システムで <return>kqueue</return> が使えないときにも大量のソケットを処理できるようにするの
  に便利です。 以下の例を参照ください。

<comment>Param:</comment>
  <info>object</info>    <strong>$other</strong>     <class>EvLoop</class> のインスタンス。 埋め込むループです。これは埋め込み可能なものでなけれ
                       ばいけません (Ev::embeddableBackends を参照ください)。
  <info>callable</info>  <strong>$callback</strong>  ウォッチャーのコールバック を参照ください。
  <info>mixed</info>     <strong>$data</strong>      このウォッチャーに関連づけるカスタムデータ。
  <info>int</info>       <strong>$priority</strong>  ウォッチャーの優先度。

<comment>See Also:</comment>
   * Ev::embeddableBackends


id: EvEmbed::createStopped
type: function
doc:
<comment>Description:</comment>
  停止した EvEmbed ウォッチャーのインスタンスを作る
  
  EvEmbed::__construct と同じですが、ウォッチャーを自動的には開始しません。

<comment>Param:</comment>
  <info>object</info>    <strong>$other</strong>     EvEmbed::__construct と同じ。
  <info>callable</info>  <strong>$callback</strong>  ウォッチャーのコールバック を参照ください。
  <info>mixed</info>     <strong>$data</strong>      このウォッチャーに関連づけるカスタムデータ。
  <info>int</info>       <strong>$priority</strong>  ウォッチャーの優先度。

<comment>Return:</comment>
  <info>void</info>  成功した場合に、停止した EvEmbed オブジェクトを返します。

<comment>See Also:</comment>
   * EvEmbed::__construct
   * Ev::embeddableBackends


id: EvEmbed::set
type: function
doc:
<comment>Description:</comment>
  ウォッチャーを設定する
  
  ウォッチャーを設定して、 <strong>$他の</strong> イベントループオブジェクトで使えるようにします。

<comment>Param:</comment>
  <info>object</info>  <strong>$other</strong>  EvEmbed::__construct と同じ。

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


id: EvEmbed::sweep
type: function
doc:
<comment>Description:</comment>
  埋め込んだループに対して単一の非ブロックスイープを行う
  
  埋め込んだループに対して単一の非ブロックスイープを行います。 次のコードとほぼ同じ動きですが、埋め
  込んだループ用に最適な方法をとります。 start(Ev::RUN_NOWAIT);
  ?>
  ]]>

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

<comment>See Also:</comment>
   * EvWatcher::start


id: EvFork
type: class
doc:
<comment>Description:</comment>
  Fork ウォッチャーが呼ばれるのは、<return>fork()</return> を検出したときです (通常は、誰かが EvLoop::fork を呼んで
  libev に通知します)。 起動するのは、イベントループが次の処理をブロックする前、 そして <class>EvCheck</class>
  ウォッチャーが呼ばれる前になります。 また、フォークした後の子プロセス内でだけ起動します。 誰かが間
  違ったプロセスで EvLoop::fork を呼んだとしても、fork ハンドラが起動してしまうことに注意しましょ
  う。


id: EvFork::__construct
type: function
doc:
<comment>Description:</comment>
  EvFork ウォッチャーオブジェクトを作る
  
  EvFork ウォッチャーオブジェクトを作り、自動的に開始させます。

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  ウォッチャーのコールバック を参照ください。
  <info>mixed</info>     <strong>$data</strong>      このウォッチャーに関連づけるカスタムデータ。
  <info>int</info>       <strong>$priority</strong>  ウォッチャーの優先度。

<comment>See Also:</comment>
   * EvLoop::fork
   * <class>EvCheck</class>


id: EvFork::createStopped
type: function
doc:
<comment>Description:</comment>
  停止した EvFork ウォッチャーのインスタンスを作る
  
  EvFork::__construct と同じですが、ウォッチャーを自動的には開始しません。

<comment>Param:</comment>
  <info>string</info>  <strong>$callback</strong>  ウォッチャーのコールバック を参照ください。
  <info>string</info>  <strong>$data</strong>      このウォッチャーに関連づけるカスタムデータ。
  <info>string</info>  <strong>$priority</strong>  ウォッチャーの優先度。

<comment>Return:</comment>
  <info>object</info>  成功した場合に、停止した EvFork オブジェクトを返します。

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


id: EvIdle
type: class
doc:
<comment>Description:</comment>
  <class>EvIdle</class> watchers trigger events when no other events of the same or higher priority are pending (
  <class>EvPrepare</class> , <class>EvCheck</class> and other <class>EvIdle</class> watchers do not count as receiving events ).
  
  Thus, as long as the process is busy handling sockets or timeouts(or even signals) of the same or
  higher priority it will not be triggered. But when the process is in idle(or only lower-priority
  watchers are pending), the <class>EvIdle</class> watchers are being called once per event loop iteration - until
  stopped, that is, or the process receives more events and becomes busy again with higher priority
  stuff.
  
  Apart from keeping the process non-blocking(which is a useful on its own sometimes), <class>EvIdle</class>
  watchers are a good place to do "pseudo-background processing" , or delay processing stuff to
  after the event loop has handled all outstanding events.
  
  The most noticeable effect is that as long as any idle watchers are active, the process will not
  block when waiting for new events.


id: EvIdle::__construct
type: function
doc:
<comment>Description:</comment>
  Constructs the EvIdle watcher object
  
  Constructs the EvIdle watcher object and starts the watcher automatically.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  See Watcher callbacks .
  <info>mixed</info>     <strong>$data</strong>      Custom data associated with the watcher.
  <info>int</info>       <strong>$priority</strong>  Watcher priority

<comment>See Also:</comment>
   * EvIdle::createStopped
   * EvLoop::idle


