# php_manual

id: imagegrabscreen
type: function
doc:
<comment>Description:</comment>
  画面全体をキャプチャする
  
  画面全体のスクリーンショットを取得します。
  
  この関数は Windows 上でのみ使用できます。

<comment>Return:</comment>
  <info>GdImage|false</info>  成功した場合に画像オブジェクト、失敗した場合に <info>false</info> を返します。

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


id: imagegrabwindow
type: function
doc:
<comment>Description:</comment>
  ウィンドウをキャプチャする
  
  ウィンドウあるいはそのクライアント領域のキャプチャを、 ウィンドウハンドル (COM インスタンスの HWND
  プロパティ) を指定して取得します。
  
  この関数は Windows 上でのみ使用できます。

<comment>Param:</comment>
  <info>int</info>   <strong>$handle</strong>       HWND ウィンドウ ID。
  <info>bool</info>  <strong>$client_area</strong>  アプリケーションのクライアント領域を含めるかどうか。

<comment>Return:</comment>
  <info>GdImage|false</info>  成功した場合に画像オブジェクト、失敗した場合に <info>false</info> を返します。

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


id: imageinterlace
type: function
doc:
<comment>Description:</comment>
  インターレースを有効もしくは無効にする
  
  <strong>imageinterlace()</strong> は、インターレースビットをon またはoffに切り替えます。
  
  インターレースビットがonでかつその画像が JPEG の場合、 その画像はプログレッシブ JPEG として生成さ
  れています。

<comment>Param:</comment>
  <info>GdImage</info>  <strong>$image</strong>      <strong>imagecreatetruecolor()</strong>のような画像作成関数が返す <class>GdImage</class> オブジェクト。
  <info></info>         <strong>$interlace</strong>  <info>true</info> の場合はインターレース画像となり、 <info>false</info> の場合はインターレースビットを
                       off にします。 <info>null</info> を渡すと、インターレースに関する振る舞いは変更されませ
                       ん。

<comment>Return:</comment>
  <info>bool</info>  画像のインターレースビットが設定されている場合に <info>true</info> 、 それ以外の場合に <info>false</info> を返します。


id: imageistruecolor
type: function
doc:
<comment>Description:</comment>
  画像が truecolor かどうか調べる
  
  <strong>imageistruecolor()</strong> は、 <strong>$image</strong> が truecolor 画像かどうか調べます。

<comment>Param:</comment>
  <info>GdImage</info>  <strong>$image</strong>  <strong>imagecreatetruecolor()</strong>のような画像作成関数が返す <class>GdImage</class> オブジェクト。

<comment>Return:</comment>
  <info>bool</info>  <strong>$image</strong> が truecolor の場合に <info>true</info>、 それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>imagecreatetruecolor()</strong>
   * <strong>imagepalettetotruecolor()</strong>


id: imagejpeg
type: function
doc:
<comment>Description:</comment>
  画像をブラウザあるいはファイルに出力する
  
  <strong>imagejpeg()</strong> は、画像 <strong>$image</strong> から JPEG ファイルを作成します。

<comment>Param:</comment>
  <info>GdImage</info>               <strong>$image</strong>    <strong>imagecreatetruecolor()</strong>のような画像作成関数が返す <class>GdImage</class> オブジェ
                                  クト。
  <info>resource|string|null</info>  <strong>$file</strong>     ファイル保存先のパスあるいはオープン中のリソース (この関数が値を戻
                                  した後で自動的にクローズされます)。省略したり <info>null</info> を設定したりし
                                  た場合は、画像ストリームを直接出力します。
  <info>int</info>                   <strong>$quality</strong>  <strong>$quality</strong> はオプションであり、0(品質は最低 ですが、ファイルはより小
                                  さい)から100(品質は最高ですが、ファイルは 最大)の範囲で指定しま
                                  す。 デフォルト (<return>-1</return>) は、IJG 品質値(75) を使います。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。
        
        しかしながら、libgd がイメージの出力に失敗した場合、この関数は <info>true</info> を返します。

<comment>See Also:</comment>
   * <strong>imagepng()</strong>
   * <strong>imagegif()</strong>
   * <strong>imagewbmp()</strong>
   * <strong>imageinterlace()</strong>
   * <strong>imagetypes()</strong>


id: imagelayereffect
type: function
doc:
<comment>Description:</comment>
  アルファブレンディングフラグを設定し、レイヤ効果を使用する
    
  
  アルファブレンディングフラグを設定し、レイヤ効果を使用します。

<comment>Param:</comment>
  <info>GdImage</info>  <strong>$image</strong>   <strong>imagecreatetruecolor()</strong>のような画像作成関数が返す <class>GdImage</class> オブジェクト。
  <info>int</info>      <strong>$effect</strong>  以下の定数のいずれか。 <info>IMG_EFFECT_REPLACE</info> ピクセルの置換を使用します
                    (<strong>imagealphablending()</strong> に <info>true</info> を渡すのと同じです)。 <info>IMG_EFFECT_ALPHABLEND</info> 通常の
                    ピクセルブレンディングを使用します (<strong>imagealphablending()</strong> に <info>false</info> を渡すのと同じ
                    です)。 <info>IMG_EFFECT_NORMAL</info><info>IMG_EFFECT_ALPHABLEND</info> と同じです。 <info>IMG_EFFECT_OVERLAY</info>
                    オーバーレイを使用すると、背景の黒い部分は黒のまま。 一方背景の白い部分は白のま
                    まとなります。 背景のグレーな部分は、前景のピクセルの色となります。
                    <info>IMG_EFFECT_MULTIPLY</info> 多重効果を使ったオーバーレイを使用します。
                    
                    ピクセルの置換を使用します (<strong>imagealphablending()</strong> に <info>true</info> を渡すのと同じです)。
                    
                    通常のピクセルブレンディングを使用します (<strong>imagealphablending()</strong> に <info>false</info> を渡すの
                    と同じです)。
                    
                    <info>IMG_EFFECT_ALPHABLEND</info> と同じです。
                    
                    オーバーレイを使用すると、背景の黒い部分は黒のまま。 一方背景の白い部分は白のま
                    まとなります。 背景のグレーな部分は、前景のピクセルの色となります。
                    
                    多重効果を使ったオーバーレイを使用します。

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


id: imageline
type: function
doc:
<comment>Description:</comment>
  直線を描画する
  
  指定したふたつの点を結ぶ直線を描画します。

<comment>Param:</comment>
  <info>GdImage</info>  <strong>$image</strong>  <strong>imagecreatetruecolor()</strong>のような画像作成関数が返す <class>GdImage</class> オブジェクト。
  <info>int</info>      <strong>$x1</strong>     最初の点の x 座標。
  <info>int</info>      <strong>$y1</strong>     最初の点の y 座標。
  <info>int</info>      <strong>$x2</strong>     二番目の点の x 座標。
  <info>int</info>      <strong>$y2</strong>     二番目の点の y 座標。
  <info>int</info>      <strong>$color</strong>  直線の色。<strong>imagecolorallocate()</strong> で作成された色識別子。

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

<comment>See Also:</comment>
   * <strong>imagecreatetruecolor()</strong>
   * <strong>imagecolorallocate()</strong>


id: imageloadfont
type: function
doc:
<comment>Description:</comment>
  新しいフォントを読み込む
  
  <strong>imageloadfont()</strong> はユーザーが定義したビットマップを読み込み、 その ID を返します。

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  フォントファイル形式は現在はバイナリで、アーキクチャに依存します。 このため、
                     PHP を実行するマシーンと同一の型の CPU 上でフォントファイルを 生成する必要があ
                     ります。
                     
                     フォントファイルのフォーマットバイト位置C 言語のデータ型説明0-3 バイト目intフォ
                     ント中の文字の数4-7 バイト目int フォント中の最初の文字の値(しばしば 空白を表す
                     32 となります) 8-11 バイト目int各文字のピクセル幅12-15 バイト目int各文字のピク
                     セル高さ16 バイト目からchar 文字データの配列、各文字のピクセルにつき1バイトで、
                     総数は(文字数*幅*高さ)バイトです。

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

<comment>See Also:</comment>
   * <strong>imagefontwidth()</strong>
   * <strong>imagefontheight()</strong>


id: imageopenpolygon
type: function
doc:
<comment>Description:</comment>
  オープンポリゴンを描画する
  
  PHP 8.0.0 以降のシグネチャ (名前付き引数をサポートしていません)
  
  代替のシグネチャ (PHP 8.1.0 以降は非推奨)
  
  <strong>imageopenpolygon()</strong> 関数は、 与えられた <strong>$image</strong> のオープンポリゴンを描画します。 <strong>imagepolygon()</strong> とは
  異なり、 始点と終点の間の線は描かれません。

<comment>Param:</comment>
  <info>GdImage</info>  <strong>$image</strong>       <strong>imagecreatetruecolor()</strong>のような画像作成関数が返す <class>GdImage</class> オブジェクト。
  <info>array</info>    <strong>$points</strong>      ポリゴンの点を含む配列: points[0]= x0points[1]= y0points[2]= x1points[3]= y1
  <info>int</info>      <strong>$num_points</strong>  全ての点の数。少なくとも3以上である必要があります。
                        
                        代替のシグネチャ(PHP 8.0.0 以降) でこの引数が省略された場合、 <strong>$points</strong> は偶数
                        でなければいけません。また、 <strong>$num_points</strong> は count($points)/2 であると仮定さ
                        れます。
  <info>int</info>      <strong>$color</strong>       <strong>imagecolorallocate()</strong> で作成された色識別子。

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

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


id: imagepalettecopy
type: function
doc:
<comment>Description:</comment>
  あるイメージから他のイメージにパレットをコピーする
  
  <strong>imagepalettecopy()</strong> は、パレットを <strong>$src</strong> から <strong>$dst</strong> にコピーします。

<comment>Param:</comment>
  <info>GdImage</info>  <strong>$dst</strong>  コピー先の画像オブジェクト
  <info>GdImage</info>  <strong>$src</strong>  コピー元の画像オブジェクト

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


id: imagepalettetotruecolor
type: function
doc:
<comment>Description:</comment>
  パレット形式の画像を true color に変換する
  
  <strong>imagecreate()</strong> のような関数で作ったパレット形式の画像を、 <strong>imagecreatetruecolor()</strong> で作るような true
  color 形式に変換します。

<comment>Param:</comment>
  <info>GdImage</info>  <strong>$image</strong>  <strong>imagecreatetruecolor()</strong>のような画像作成関数が返す <class>GdImage</class> オブジェクト。

<comment>Return:</comment>
  <info>bool</info>  変換に成功した場合や、元画像が既に true color だった場合に <info>true</info> を返します。 それ以外の場合
        に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>imagecreatetruecolor()</strong>
   * <strong>imageistruecolor()</strong>


id: imagepng
type: function
doc:
<comment>Description:</comment>
  PNG イメージをブラウザまたはファイルに出力する
  
  指定した <strong>$image</strong> から、PNG 画像を出力あるいは保存します。

<comment>Param:</comment>
  <info>GdImage</info>               <strong>$image</strong>    <strong>imagecreatetruecolor()</strong>のような画像作成関数が返す <class>GdImage</class> オブジェ
                                  クト。
  <info>resource|string|null</info>  <strong>$file</strong>     ファイル保存先のパスあるいはオープン中のリソース (この関数が値を戻
                                  した後で自動的にクローズされます)。省略したり <info>null</info> を設定したりし
                                  た場合は、画像ストリームを直接出力します。
                                  
                                  <strong>$quality</strong> および <strong>$filters</strong> を使用しない場合は、 <info>null</info> を指定すること
                                  はできません。
  <info>int</info>                   <strong>$quality</strong>  圧縮レベル。0 (圧縮しない) から 9 までの値です。 デフォルト (<return>-1</return>)
                                  は、zlib の圧縮レベルのデフォルトを使います。 詳細は、zlib マニュ
                                  アル をご覧ください。
  <info>int</info>                   <strong>$filters</strong>  PNG ファイルの大きさを小さくします。 これはビットマスクフィールド
                                  で、定数 <return>PNG_FILTER_XXX</return> の組み合わせを指定します。 <info>PNG_NO_FILTER</info>
                                  や <info>PNG_ALL_FILTERS</info> を使用すると、 全フィルタを一括で無効にしたり有
                                  効にしたりできます。 デフォルト値 (<return>-1</return>) は、フィルタリングを無効に
                                  します。
                                  
                                  システムにインストールされた libgd は、<strong>$filters</strong> パラメータを無視し
                                  ます。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。
        
        しかしながら、libgd がイメージの出力に失敗した場合、この関数は <info>true</info> を返します。

<comment>See Also:</comment>
   * <strong>imagegif()</strong>
   * <strong>imagewbmp()</strong>
   * <strong>imagejpeg()</strong>
   * <strong>imagetypes()</strong>
   * <strong>imagesavealpha()</strong>


id: imagepolygon
type: function
doc:
<comment>Description:</comment>
  多角形を描画する
  
  PHP 8.0.0 以降のシグネチャ(名前付き引数をサポートしていません)
  
  代替のシグネチャ (PHP 8.1.0 以降は非推奨)
  
  <strong>imagepolygon()</strong> は、指定した <strong>$image</strong> に多角形を作成します。

<comment>Param:</comment>
  <info>GdImage</info>  <strong>$image</strong>       <strong>imagecreatetruecolor()</strong>のような画像作成関数が返す <class>GdImage</class> オブジェクト。
  <info>array</info>    <strong>$points</strong>      多角形の頂点からなる PHP の配列で、 次のようになります。 points[0]=
                        x0points[1]= y0points[2]= x1points[3]= y1
  <info>int</info>      <strong>$num_points</strong>  頂点の総数。最小でも3でなければなりません。
                        
                        代替のシグネチャ(PHP 8.0.0 以降) でこの引数が省略された場合、 <strong>$points</strong> は偶数
                        でなければいけません。また、 <strong>$num_points</strong> は count($points)/2 であると仮定さ
                        れます。
  <info>int</info>      <strong>$color</strong>       <strong>imagecolorallocate()</strong> で作成された色識別子。

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

<comment>See Also:</comment>
   * <strong>imagefilledpolygon()</strong>
   * <strong>imageopenpolygon()</strong>
   * <strong>imagecreate()</strong>
   * <strong>imagecreatetruecolor()</strong>


id: imagerectangle
type: function
doc:
<comment>Description:</comment>
  矩形を描画する
  
  <strong>imagerectangle()</strong> は、指定した座標から始まる矩形を作成します。

<comment>Param:</comment>
  <info>GdImage</info>  <strong>$image</strong>  <strong>imagecreatetruecolor()</strong>のような画像作成関数が返す <class>GdImage</class> オブジェクト。
  <info>int</info>      <strong>$x1</strong>     左上の x 座標。
  <info>int</info>      <strong>$y1</strong>     左上の y 座標。 0, 0 が画像の左上隅を表します。
  <info>int</info>      <strong>$x2</strong>     右下の x 座標。
  <info>int</info>      <strong>$y2</strong>     右下の y 座標。
  <info>int</info>      <strong>$color</strong>  <strong>imagecolorallocate()</strong> で作成された色識別子。

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


id: imageresolution
type: function
doc:
<comment>Description:</comment>
  画像の解像度を取得/設定する
  
  <strong>imageresolution()</strong> 関数は、 画像の解像度を DPI(dots per inch) 単位で取得/設定します。 オプションの
  パラメータが <info>null</info> だった場合は、 現在の解像度を配列で返します。 <strong>$resolution_x</strong> だけが <info>null</info> でない場
  合、 垂直/水平方向の解像度がこの値に設定されます。 オプションのパラメータが両方指定されると、 垂直
  /水平方向の解像度がそれぞれ指定された値に設定されます。
  
  この手の情報をサポートしている画像フォーマットを読み書きする場合(現状、PNG と JPEG)に、 解像度情報
  はメタ情報としてのみ使われます。画像を描画する操作には一切影響しません。 新しい画像の解像度は
  96DPI です。

<comment>Param:</comment>
  <info>GdImage</info>   <strong>$image</strong>         <strong>imagecreatetruecolor()</strong>のような画像作成関数が返す <class>GdImage</class> オブジェクト。
  <info>int|null</info>  <strong>$resolution_x</strong>  水平方向の解像度をDPI単位で指定します。
  <info>int|null</info>  <strong>$resolution_y</strong>  垂直方向の解像度をDPI単位で指定します。

<comment>Return:</comment>
  <info>array|bool</info>  getter として使う場合、 水平方向と垂直方向の解像度を成功時には返します。 失敗した場合
              に <info>false</info> を返します。 setter として使う場合、 成功時には <info>true</info> を返し、失敗した場合に
              <info>false</info> を返します。


id: imagerotate
type: function
doc:
<comment>Description:</comment>
  指定された角度で画像を回転する
  
  画像 <strong>$image</strong> を、 <strong>$angle</strong> で指定された角度だけ回転します。
  
  回転の中心は画像の中心です。 回転後の画像の大きさは、もとの大きさと異なる可能性があります。

<comment>Param:</comment>
  <info>GdImage</info>  <strong>$image</strong>             <strong>imagecreatetruecolor()</strong>のような画像作成関数が返す <class>GdImage</class> オブジェク
                              ト。
  <info>float</info>    <strong>$angle</strong>             回転角度。これは、画像を反時計回りに回転させるときの度数を表します。
  <info>int</info>      <strong>$background_color</strong>  回転後、カバーされない部分の色。

<comment>Return:</comment>
  <info>GdImage|false</info>  回転させた画像オブジェクトを返します。失敗した場合に <info>false</info> を返します。

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


id: imagesavealpha
type: function
doc:
<comment>Description:</comment>
  画像を保存する際に、完全なアルファチャネル情報を保存するかどうかを指定する
    
  
  <strong>imagesavealpha()</strong> は 画像を保存する際に（単一色の透過設定ではない）完全な アルファチャネル情報を保
  存するフラグを設定します。 この関数は、完全なアルファチャンネル情報をサポートしている画像フォー
  マット、 つまり、<return>PNG</return>, <return>WebP</return>, <return>AVIF</return> をサポートしています。 <strong>imagesavealpha()</strong> は、<return>PNG</return> でのみ意味があり
  ます。 なぜなら、完全なアルファチャンネル情報を <return>WebP</return>, <return>AVIF</return> は常に保存するからです。 この振る舞いは
  将来変更される可能性があるので、依存すべきではありません。 よって、<return>WebP</return> や <return>AVIF</return> 画像であっても
  <strong>imagesavealpha()</strong> を意図的にコールすべきです。
  
  <strong>imagesavealpha()</strong> は、<return>PNG</return> でのみ意味があります。 なぜなら、完全なアルファチャンネル情報を <return>WebP</return>,
  <return>AVIF</return> は常に保存するからです。 この振る舞いは将来変更される可能性があるので、依存すべきではありませ
  ん。 よって、<return>WebP</return> や <return>AVIF</return> 画像であっても <strong>imagesavealpha()</strong> を意図的にコールすべきです。
  
  アルファチャネルを保存するためには、まずアルファブレンディングを解除する必要があります
  (<return>imagealphablending($im, false)</return>)。

<comment>Param:</comment>
  <info>GdImage</info>  <strong>$image</strong>   <strong>imagecreatetruecolor()</strong>のような画像作成関数が返す <class>GdImage</class> オブジェクト。
  <info>bool</info>     <strong>$enable</strong>  アルファチャネルを保存するか否か。デフォルトは <info>false</info> です。

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

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


id: imagescale
type: function
doc:
<comment>Description:</comment>
  幅と高さを指定して、画像の縮尺を変更する
  
  <strong>imagescale()</strong> は、指定した補間アルゴリズムを使って画像の縮尺を変更します。
  
  他の画像処理関数と異なり、 <strong>imagescale()</strong> 関数は渡された <strong>$image</strong> を変更しません。 代わりに 新しい 画
  像が返されます。

<comment>Param:</comment>
  <info>GdImage</info>  <strong>$image</strong>   <strong>imagecreatetruecolor()</strong>のような画像作成関数が返す <class>GdImage</class> オブジェクト。
  <info>int</info>      <strong>$width</strong>   変更後の画像の幅。
  <info>int</info>      <strong>$height</strong>  変更後の画像の高さ。省略したり負の数を指定したりした場合は、元の画像のアスペクト
                    比を維持します。
  <info>int</info>      <strong>$mode</strong>    <info>IMG_NEAREST_NEIGHBOUR</info>、 <info>IMG_BILINEAR_FIXED</info>、 <info>IMG_BICUBIC</info>、 <info>IMG_BICUBIC_FIXED</info> あ
                    るいはそれ以外 (2 パスで使います) のいずれか。 <info>IMG_WEIGHTED4</info> にはまだ対応してい
                    ません。
                    
                    <info>IMG_WEIGHTED4</info> にはまだ対応していません。

<comment>Return:</comment>
  <info>GdImage|false</info>  成功した場合に、縮尺を変更した画像オブジェクトを返します。失敗した場合に <info>false</info> を返
                 します。

<comment>See Also:</comment>
   * <strong>imagecopyresized()</strong>
   * <strong>imagecopyresampled()</strong>


id: imagesetbrush
type: function
doc:
<comment>Description:</comment>
  線の描画用にブラシイメージを設定する
  
  <strong>imagesetbrush()</strong> は、特別な色 <info>IMG_COLOR_BRUSHED</info> または <info>IMG_COLOR_STYLEDBRUSHED</info> で描画される際に
  (<strong>imageline()</strong> や <strong>imagepolygon()</strong> のような) 全ての線描画関数で使用されるブラシイメージを設定します。
  
  ブラシの使用が終った際には特別な処理は不要ですが、 ブラシイメージを破棄する(もしくは、PHPに破棄さ
  せる)場合には、新たにブラシイメージを設定するまでは、 色 <info>IMG_COLOR_BRUSHED</info> または
  <info>IMG_COLOR_STYLEDBRUSHED</info> を使用するべきではありません。

<comment>Param:</comment>
  <info>GdImage</info>  <strong>$image</strong>  <strong>imagecreatetruecolor()</strong>のような画像作成関数が返す <class>GdImage</class> オブジェクト。
  <info>GdImage</info>  <strong>$brush</strong>  画像オブジェクト。

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


id: imagesetclip
type: function
doc:
<comment>Description:</comment>
  切り取る長方形を設定する
  
  <strong>imagesetclip()</strong> は、切り取る長方形を設定します。 つまり、ピクセルが存在しない状態でなければ描画され
  ます。

<comment>Param:</comment>
  <info>GdImage</info>  <strong>$image</strong>  <strong>imagecreatetruecolor()</strong>のような画像作成関数が返す <class>GdImage</class> オブジェクト。
  <info>int</info>      <strong>$x1</strong>     左上のx座標
  <info>int</info>      <strong>$y1</strong>     左上のy座標
  <info>int</info>      <strong>$x2</strong>     右下のx座標
  <info>int</info>      <strong>$y2</strong>     右下のy座標

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

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


id: imagesetinterpolation
type: function
doc:
<comment>Description:</comment>
  補間方法を設定する
  
  補間方法を設定します。これは、<strong>imagerotate()</strong> など GD のさまざまな関数のレンダリングに影響を及ぼしま
  す。

<comment>Param:</comment>
  <info>GdImage</info>  <strong>$image</strong>   <strong>imagecreatetruecolor()</strong>のような画像作成関数が返す <class>GdImage</class> オブジェクト。
  <info>int</info>      <strong>$method</strong>  補間方法。次のいずれかで指定します。 <info>IMG_BELL</info>: Bell フィルター。 <info>IMG_BESSEL</info>:
                    Bessel フィルター。 <info>IMG_BICUBIC</info>: 双三次補間。 <info>IMG_BICUBIC_FIXED</info>: 双三次補間の固
                    定小数点実装。 <info>IMG_BILINEAR_FIXED</info>: 双直線補間の固定小数点実装 (<return>デフォルト (画像
                    作成時も含む)</return>)。 <info>IMG_BLACKMAN</info>: Blackman ウィンドウ関数。 <info>IMG_BOX</info>: Box blur フィ
                    ルター。 <info>IMG_BSPLINE</info>: スプライン補間。 <info>IMG_CATMULLROM</info>: 三次元エルミートスプライ
                    ン補間。 <info>IMG_GAUSSIAN</info>: ガウス関数。 <info>IMG_GENERALIZED_CUBIC</info>: 汎用三次元スプライン
                    フラクタル補間。 <info>IMG_HERMITE</info>: エルミート補間。 <info>IMG_HAMMING</info>: ハミングフィルター。
                    <info>IMG_HANNING</info>: ハニングフィルター。 <info>IMG_MITCHELL</info>: Mitchell フィルター。 <info>IMG_POWER</info>:
                    Power 補間。 <info>IMG_QUADRATIC</info>: 逆二次補間。 <info>IMG_SINC</info>: Sinc 関数。
                    <info>IMG_NEAREST_NEIGHBOUR</info>: 最近接補間。 <info>IMG_WEIGHTED4</info>: 重み付きフィルター。
                    <info>IMG_TRIANGLE</info>: 三角補間。
                    
                    <info>IMG_BELL</info>: Bell フィルター。
                    
                    <info>IMG_BESSEL</info>: Bessel フィルター。
                    
                    <info>IMG_BICUBIC</info>: 双三次補間。
                    
                    <info>IMG_BICUBIC_FIXED</info>: 双三次補間の固定小数点実装。
                    
                    <info>IMG_BILINEAR_FIXED</info>: 双直線補間の固定小数点実装 (<return>デフォルト (画像作成時も含む)</return>)。
                    
                    <info>IMG_BLACKMAN</info>: Blackman ウィンドウ関数。
                    
                    <info>IMG_BOX</info>: Box blur フィルター。
                    
                    <info>IMG_BSPLINE</info>: スプライン補間。
                    
                    <info>IMG_CATMULLROM</info>: 三次元エルミートスプライン補間。
                    
                    <info>IMG_GAUSSIAN</info>: ガウス関数。
                    
                    <info>IMG_GENERALIZED_CUBIC</info>: 汎用三次元スプラインフラクタル補間。
                    
                    <info>IMG_HERMITE</info>: エルミート補間。
                    
                    <info>IMG_HAMMING</info>: ハミングフィルター。
                    
                    <info>IMG_HANNING</info>: ハニングフィルター。
                    
                    <info>IMG_MITCHELL</info>: Mitchell フィルター。
                    
                    <info>IMG_POWER</info>: Power 補間。
                    
                    <info>IMG_QUADRATIC</info>: 逆二次補間。
                    
                    <info>IMG_SINC</info>: Sinc 関数。
                    
                    <info>IMG_NEAREST_NEIGHBOUR</info>: 最近接補間。
                    
                    <info>IMG_WEIGHTED4</info>: 重み付きフィルター。
                    
                    <info>IMG_TRIANGLE</info>: 三角補間。

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

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


id: imagesetpixel
type: function
doc:
<comment>Description:</comment>
  点を生成する
  
  <strong>imagesetpixel()</strong> は、指定した座標にピクセルを描画します。

<comment>Param:</comment>
  <info>GdImage</info>  <strong>$image</strong>  <strong>imagecreatetruecolor()</strong>のような画像作成関数が返す <class>GdImage</class> オブジェクト。
  <info>int</info>      <strong>$x</strong>      x 座標。
  <info>int</info>      <strong>$y</strong>      y 座標。
  <info>int</info>      <strong>$color</strong>  <strong>imagecolorallocate()</strong> で作成された色識別子。

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

<comment>See Also:</comment>
   * <strong>imagecreatetruecolor()</strong>
   * <strong>imagecolorallocate()</strong>
   * <strong>imagecolorat()</strong>


id: imagesetstyle
type: function
doc:
<comment>Description:</comment>
  線描画用のスタイルを設定する
  
  <strong>imagesetstyle()</strong> は、特別な <return>IMG_COLOR_STYLED</return> または色を有するイメージの線 <return>IMG_COLOR_STYLEDBRUSHED</return>
  を描画する際に (<strong>imageline()</strong> と <strong>imagepolygon()</strong> のような) 全ての線描画関数で使用されるスタイルを設定
  します。

<comment>Param:</comment>
  <info>GdImage</info>  <strong>$image</strong>  <strong>imagecreatetruecolor()</strong>のような画像作成関数が返す <class>GdImage</class> オブジェクト。
  <info>array</info>    <strong>$style</strong>  はピクセルの配列です。定数 <info>IMG_COLOR_TRANSPARENT</info> を使用すると、透明なピクセルを追
                   加できます。 <strong>$style</strong> は空の配列にしてはいけません。

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

<comment>See Also:</comment>
   * <strong>imagesetbrush()</strong>
   * <strong>imageline()</strong>


id: imagesetthickness
type: function
doc:
<comment>Description:</comment>
  線描画用の線幅を設定する
  
  <strong>imagesetthickness()</strong> は、長方形、多角形、弧などを描画する際の線幅を <strong>$thickness</strong> ピクセルに設定しま
  す。

<comment>Param:</comment>
  <info>GdImage</info>  <strong>$image</strong>      <strong>imagecreatetruecolor()</strong>のような画像作成関数が返す <class>GdImage</class> オブジェクト。
  <info>int</info>      <strong>$thickness</strong>  ピクセル単位の線幅。

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


id: imagesettile
type: function
doc:
<comment>Description:</comment>
  塗りつぶし用のイメージを設定する
  
  <strong>imagesettile()</strong> は、特別な色 <info>IMG_COLOR_TILED</info> を指定して塗りつぶされた場合に、 (<strong>imagefill()</strong> や
  <strong>imagefilledpolygon()</strong> のような) 領域塗りつぶし関数で使用されるタイルイメージを設定します。
  
  タイルは、領域を塗りつぶすために繰り返し使用されるイメージです。 全ての GD イメージをタイルとして
  使用可能で、 <strong>imagecolortransparent()</strong> でタイルの透過色 ID を設定することにより、 その一部から下の部
  分が透けて見えるようなタイルを作成することが可能です。
  
  タイルの使用が終った際には、特別な処理は不要ですが、 タイルイメージを破棄する(もしくは、PHPに破棄
  させる)場合には、 新たにタイルイメージを設定するまでは、色 <info>IMG_COLOR_TILED</info> を使用してはいけませ
  ん。

<comment>Param:</comment>
  <info>GdImage</info>  <strong>$image</strong>  <strong>imagecreatetruecolor()</strong>のような画像作成関数が返す <class>GdImage</class> オブジェクト。
  <info>GdImage</info>  <strong>$tile</strong>   タイルとして使用する画像オブジェクト。

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


id: imagestring
type: function
doc:
<comment>Description:</comment>
  文字列を水平に描画する
  
  指定した座標に文字列 <strong>$string</strong> を描画します。

<comment>Param:</comment>
  <info>GdImage</info>     <strong>$image</strong>   <strong>imagecreatetruecolor()</strong>のような画像作成関数が返す <class>GdImage</class> オブジェクト。
  <info>GdFont|int</info>  <strong>$font</strong>    latin2 エンコーディングの組み込みのフォントの場合は 1, 2, 3, 4, 5 のいずれか
                       (数字が大きなほうが、より大きいフォントに対応します)、あるいは
                       <strong>imageloadfont()</strong> が返した、<class>GdFont</class> クラスのインスタンスのいずれか。
  <info>int</info>         <strong>$x</strong>       左上隅の x 座標。
  <info>int</info>         <strong>$y</strong>       左上隅の y 座標。
  <info>string</info>      <strong>$string</strong>  書き出す文字列。
  <info>int</info>         <strong>$color</strong>   <strong>imagecolorallocate()</strong> で作成された色識別子。

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

<comment>See Also:</comment>
   * <strong>imagestringup()</strong>
   * <strong>imageloadfont()</strong>
   * <strong>imagettftext()</strong>


id: imagestringup
type: function
doc:
<comment>Description:</comment>
  文字列を垂直に描画する
  
  文字列 <strong>$string</strong> を、指定した座標で垂直に描画します。

<comment>Param:</comment>
  <info>GdImage</info>     <strong>$image</strong>   <strong>imagecreatetruecolor()</strong>のような画像作成関数が返す <class>GdImage</class> オブジェクト。
  <info>GdFont|int</info>  <strong>$font</strong>    latin2 エンコーディングの組み込みのフォントの場合は 1, 2, 3, 4, 5 のいずれか
                       (数字が大きなほうが、より大きいフォントに対応します)、あるいは
                       <strong>imageloadfont()</strong> が返した、<class>GdFont</class> クラスのインスタンスのいずれか。
  <info>int</info>         <strong>$x</strong>       左下隅の x 座標。
  <info>int</info>         <strong>$y</strong>       左下隅の y 座標。
  <info>string</info>      <strong>$string</strong>  書き出す文字列。
  <info>int</info>         <strong>$color</strong>   <strong>imagecolorallocate()</strong> で作成された色識別子。

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

<comment>See Also:</comment>
   * <strong>imagestring()</strong>
   * <strong>imageloadfont()</strong>


id: imagesx
type: function
doc:
<comment>Description:</comment>
  画像の幅を取得する
  
  指定した画像オブジェクト <strong>$image</strong> の幅を返します。

<comment>Param:</comment>
  <info>GdImage</info>  <strong>$image</strong>  <strong>imagecreatetruecolor()</strong>のような画像作成関数が返す <class>GdImage</class> オブジェクト。

<comment>Return:</comment>
  <info>int</info>  <strong>$image</strong> の幅を返します。

<comment>See Also:</comment>
   * <strong>imagecreatetruecolor()</strong>
   * <strong>getimagesize()</strong>
   * <strong>imagesy()</strong>


id: imagesy
type: function
doc:
<comment>Description:</comment>
  画像の高さを取得する
  
  指定した画像オブジェクト <strong>$image</strong> の高さを返します。

<comment>Param:</comment>
  <info>GdImage</info>  <strong>$image</strong>  <strong>imagecreatetruecolor()</strong>のような画像作成関数が返す <class>GdImage</class> オブジェクト。

<comment>Return:</comment>
  <info>int</info>  <strong>$image</strong> の高さを返します。

<comment>See Also:</comment>
   * <strong>imagecreatetruecolor()</strong>
   * <strong>getimagesize()</strong>
   * <strong>imagesx()</strong>


id: imagetruecolortopalette
type: function
doc:
<comment>Description:</comment>
  TrueColor イメージをパレットイメージに変換する
  
  <strong>imagetruecolortopalette()</strong> は、TrueColorイメー ジをパレットイメージに変換します。この関数のコード
  は、元々 Independent JPEG Groupライブラリ用に書かれたもので、素晴らしいも のです。このコードは、色
  をできる限り維持することに加えて、アルファ チャネルに関する情報を出力されるパレットにおいてできる
  だけ維持す るように修正されています。これは、期待通りにうまくいきません。通 常は、最高の出力品質が
  保障されるTrueColor出力イメージを単に出力す るのが最良の方法です。

<comment>Param:</comment>
  <info>GdImage</info>  <strong>$image</strong>       <strong>imagecreatetruecolor()</strong>のような画像作成関数が返す <class>GdImage</class> オブジェクト。
  <info>bool</info>     <strong>$dither</strong>      イメージにディザーをかけることを指定します。 <info>true</info> の場合はディザーが行われま
                        す。 出力はぼやけますが、色の近似はより良くなります。
  <info>int</info>      <strong>$num_colors</strong>  パレットに保持される最大の色数を設定します。

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


id: imagettfbbox
type: function
doc:
<comment>Description:</comment>
  TypeType フォントを使用したテキストの bounding box を生成する
  
  この関数は TrueType テキストの bounding box をピクセル単位で計算して 返します。
  
  PHP 8.0.0 より前のバージョンでは、 <strong>imageftbbox()</strong> は、 <strong>imagettfbbox()</strong> を拡張したものでした。
  <strong>$extrainfo</strong> を追加でサポートしています。 PHP 8.0.0 以降では、 <strong>imagettfbbox()</strong> は、 <strong>imageftbbox()</strong> の
  エイリアスになっています。

<comment>Param:</comment>
  <info>float</info>   <strong>$size</strong>      ポイント数単位のフォントサイズ。
  <info>float</info>   <strong>$angle</strong>     測定する <strong>$string</strong> の角度(度単位)。
  <info></info>        <strong>$fontfile</strong>  使用したい TrueType フォントへのパス。
                     
                     どの GDライブラリをPHPが使っているかによって、 いつ <strong>$fontfile</strong> パラメータの先頭
                     が <return>/</return> で始まらず、 <return>.ttf</return> がファイル名に付加されるかが違います。 そして、ライブラ
                     リは自らが定義したフォントパスに従ってそのファイル名を探そうとします。
                     
                     GD ライブラリ 2.0.18 より前のバージョンを使っている場合、 セミコロンではなく、
                     <return>space</return> 文字が 異なるフォントファイルの 'pathのセパレータ' として使われていまし
                     た。 この機能を意図せず使ってしまうと、次のような警告が発生します: <return>Warning:
                     Could not find/open font</return>. この事象の影響を受けてしまうバージョンでは、 唯一の解
                     決策はフォントをスペースを含まないパスに移動させることだけです。
                     
                     多くの場合、スクリプトが使っているフォントと同じディレクトリにある場合、 次のよ
                     うなテクニックで問題を軽減できるでしょう。
                     ]]>
                     
                     open_basedir は <strong>$fontfile</strong> には適用され ない ことに注意してください。
  <info>string</info>  <strong>$string</strong>    測定する文字列。

<comment>Return:</comment>
  <info>array|false</info>  <strong>imagettfbbox()</strong> は、テキストの bounding box を 作成するための 4 点を表現する 8 個の要
               素からなる配列を返します。 エラー時には <info>false</info> を返します。 キー内容0左下角の X 座標
               1左下角の Y 座標2右下角の X 座標3右下角の Y 座標4右上角の X 座標5右上角の Y 座標6左上
               角の X 座標7左上角の Y 座標
               
               各点の位置は、 <strong>$angle</strong> にかかわらず text からの相対位置で表されます。 つまり、"左上"は
               テキストを水平に見た場合の左上の角を意味します。

<comment>See Also:</comment>
   * <strong>imagettftext()</strong>
   * <strong>imageftbbox()</strong>


id: imagettftext
type: function
doc:
<comment>Description:</comment>
  TrueType フォントを使用してテキストを画像に書き込む
  
  指定した <strong>$text</strong> を、 TrueType フォントを使用して画像に書き込みます。
  
  PHP 8.0.0 より前のバージョンでは、 <strong>imagefttext()</strong> は、 <strong>imagettftext()</strong> を拡張したものでした。
  <strong>$extrainfo</strong> を追加でサポートしています。 PHP 8.0.0 以降では、 <strong>imagettftext()</strong> は、 <strong>imagefttext()</strong> の
  エイリアスになっています。

<comment>Param:</comment>
  <info>GdImage</info>  <strong>$image</strong>     <strong>imagecreatetruecolor()</strong>のような画像作成関数が返す <class>GdImage</class> オブジェクト。
  <info>float</info>    <strong>$size</strong>      ポイント数単位のフォントサイズ。
  <info>float</info>    <strong>$angle</strong>     度で表される角度。0 度は左から右にテキストを読む方向になります。 0 より大きな
                      値は、反時計回りの回転を表現します。例えば、 90 という値は下から上にテキストを
                      読む方向になります。
  <info>int</info>      <strong>$x</strong>         <strong>$x</strong> と <strong>$y</strong> で与えられた座標は、最初の文字のベースポイント (ほぼ文字の左下角) を
                      定義します。 この仕様は、<strong>$x</strong> と <strong>$y</strong> で最初の文字の右上角を定義する <strong>imagestring()</strong>
                      と異なっています。 例えば、左上は 0, 0 となります。
  <info>int</info>      <strong>$y</strong>         y 座標。これは文字の最下位置ではなく、 フォントペースラインの位置を指定しま
                      す。
  <info>int</info>      <strong>$color</strong>     カラーインデックス。負の数を使用した場合、 アンチエイリアス機能がオフになりま
                      す。 <strong>imagecolorallocate()</strong> を参照ください。
  <info></info>         <strong>$fontfile</strong>  使用したい TrueType フォントへのパス。
                      
                      どの GDライブラリをPHPが使っているかによって、 いつ <strong>$fontfile</strong> パラメータの先頭
                      が <return>/</return> で始まらず、 <return>.ttf</return> がファイル名に付加されるかが違います。 そして、ライブラ
                      リは自らが定義したフォントパスに従ってそのファイル名を探そうとします。
                      
                      GD ライブラリ 2.0.18 より前のバージョンを使っている場合、 セミコロンではなく、
                      <return>space</return> 文字が 異なるフォントファイルの 'pathのセパレータ' として使われていまし
                      た。 この機能を意図せず使ってしまうと、次のような警告が発生します: <return>Warning:
                      Could not find/open font</return>. この事象の影響を受けてしまうバージョンでは、 唯一の
                      解決策はフォントをスペースを含まないパスに移動させることだけです。
                      
                      多くの場合、スクリプトが使っているフォントと同じディレクトリにある場合、 次の
                      ようなテクニックで問題を軽減できるでしょう。
                      ]]>
                      
                      open_basedir は <strong>$fontfile</strong> には適用され ない ことに注意してください。
  <info>string</info>   <strong>$text</strong>      テキスト文字列を UTF-8 エンコーディングで表したもの。
                      
                      フォント内で 127 文字目以降の文字にアクセスするために、 (&#8364; のような) 十
                      進数文字参照を含めることができます。 (&#xA9; のような) 十六進形式もサポートし
                      ています。 UTF-8 エンコーディングされた文字列を直接渡すことができます。
                      
                      &copy; のような文字エンティティはサポートされません。 <strong>html_entity_decode()</strong> を
                      使用して、 文字エンティティを UTF-8 文字列にすることを検討してください。
                      
                      フォントでサポートされていない文字が文字列で使用されている場合、 その文字は白
                      抜きの矩形に置き換えられます。

<comment>Return:</comment>
  <info>array|false</info>  テキストの境界を 構成する 4 点を表す 8 個の要素を有する配列を返します。 返される点は
               左下、右下、右上、左上の順番となります。 点の座標は、角度によらず text に関する相対座
               標として表されます。 つまり、"左上"は、text を水平に見た場合の左上の隅を表します。 エ
               ラー時には <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>imagettfbbox()</strong>
   * <strong>imagefttext()</strong>


id: imagetypes
type: function
doc:
<comment>Description:</comment>
  この PHP がサポートしている画像形式を返す
  
  現在使用している PHP がサポートする画像形式を返します。

<comment>Return:</comment>
  <info>int</info>  画像形式に対応するビットフィールドで、 PHP に組み込まれている GD がサポートする画像形式を返し
       ます。 返されるビットは次のとおりです。 <info>IMG_AVIF</info> | <info>IMG_BMP</info> | <info>IMG_GIF</info> | <info>IMG_JPG</info> | <info>IMG_PNG</info> |
       <info>IMG_WBMP</info> |  <info>IMG_XPM</info> | <info>IMG_WEBP</info>。

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


id: imagewbmp
type: function
doc:
<comment>Description:</comment>
  画像をブラウザあるいはファイルに出力する
  
  <strong>imagewbmp()</strong> は、指定した <strong>$image</strong> を WBMP にして出力あるいは保存します。

<comment>Param:</comment>
  <info>GdImage</info>               <strong>$image</strong>             <strong>imagecreatetruecolor()</strong>のような画像作成関数が返す <class>GdImage</class>
                                           オブジェクト。
  <info>resource|string|null</info>  <strong>$file</strong>              ファイル保存先のパスあるいはオープン中のリソース (この関
                                           数が値を戻した後で自動的にクローズされます)。省略したり
                                           <info>null</info> を設定したりした場合は、画像ストリームを直接出力しま
                                           す。
  <info>int|null</info>              <strong>$foreground_color</strong>  このパラメータで、 前景の色を指定できます。
                                           <strong>imagecolorallocate()</strong> で 取得した ID を使用してください。
                                           デフォルトの前景色は黒です。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。
        
        しかしながら、libgd がイメージの出力に失敗した場合、この関数は <info>true</info> を返します。

<comment>See Also:</comment>
   * <strong>image2wbmp()</strong>
   * <strong>imagepng()</strong>
   * <strong>imagegif()</strong>
   * <strong>imagejpeg()</strong>
   * <strong>imagetypes()</strong>


id: imagewebp
type: function
doc:
<comment>Description:</comment>
  WebP 画像をブラウザあるいはファイルに出力する
  
  指定した <strong>$image</strong> を、WebP 形式で出力あるいは保存します。

<comment>Param:</comment>
  <info>GdImage</info>               <strong>$image</strong>    <strong>imagecreatetruecolor()</strong>のような画像作成関数が返す <class>GdImage</class> オブジェ
                                  クト。
  <info>resource|string|null</info>  <strong>$file</strong>     ファイル保存先のパスあるいはオープン中のリソース (この関数が値を戻
                                  した後で自動的にクローズされます)。省略したり <info>null</info> を設定したりし
                                  た場合は、画像ストリームを直接出力します。
  <info>int</info>                   <strong>$quality</strong>  <strong>$quality</strong> には、0 (品質は最低で、 ファイルサイズが小さくなる) から
                                  100 (品質が最高で、ファイルサイズは大きくなる) までの値を指定しま
                                  す。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。
        
        しかしながら、libgd がイメージの出力に失敗した場合、この関数は <info>true</info> を返します。


id: imagexbm
type: function
doc:
<comment>Description:</comment>
  XBM 画像をブラウザあるいはファイルに出力する
  
  <strong>imagewbmp()</strong> は、指定した <strong>$image</strong> を XBM にして出力あるいは保存します。
  
  <strong>imagexbm()</strong> はパディングを一切行わないので、 画像の幅は 8 の倍数でなければいけません。 PHP 7.0.9 以
  降では、この制約がなくなりました。

<comment>Param:</comment>
  <info>GdImage</info>      <strong>$image</strong>             <strong>imagecreatetruecolor()</strong>のような画像作成関数が返す <class>GdImage</class> オブジェ
                                  クト。
  <info>string|null</info>  <strong>$filename</strong>          画像の保存先のパスを文字列で指定します。<info>null</info> を設定した場合は、画
                                  像ストリームを直接出力します。
                                  
                                  <strong>$filename</strong> (拡張子 .xbm を除いた部分) は、XBM の C 識別子としても用
                                  いられます。 そのため、現在のロケールで扱える英数字以外の文字は、
                                  アンダースコアに置き換えられます。 <strong>$filename</strong> を <info>null</info> にすると、
                                  <return>image</return> を使って C 識別子を作ります。
  <info>int|null</info>     <strong>$foreground_color</strong>  このパラメータで、 前景の色を指定できます。<strong>imagecolorallocate()</strong> で
                                  取得した ID を使用してください。デフォルトの前景色は黒です。 その
                                  他の色はすべて、背景色として扱われます。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。
        
        しかしながら、libgd がイメージの出力に失敗した場合、この関数は <info>true</info> を返します。


id: imagick::ALPHACHANNEL_ACTIVATE
type: constant
doc:
<comment>Description:</comment>
  この定数は、Imagick のコンパイルを次のバージョンの ImageMagick で 
  行った場合に使用可能です。 6.3.8 以降。


id: imagick::ALPHACHANNEL_ASSOCIATE
type: constant
doc:
<comment>Description:</comment>
  この定数は、Imagick のコンパイルを次のバージョンの ImageMagick で 
  行った場合に使用可能です。 6.9.0 以降。


id: imagick::ALPHACHANNEL_BACKGROUND
type: constant
doc:
<comment>Description:</comment>
  この定数は、Imagick のコンパイルを次のバージョンの ImageMagick で 
  行った場合に使用可能です。 6.5.3 以降。


id: imagick::ALPHACHANNEL_COPY
type: constant
doc:
<comment>Description:</comment>
  この定数は、Imagick のコンパイルを次のバージョンの ImageMagick で 
  行った場合に使用可能です。 6.4.6 以降。


id: imagick::ALPHACHANNEL_DISCRETE
type: constant
doc:
<comment>Description:</comment>
  この定数は、Imagick のコンパイルを次のバージョンの ImageMagick で 
  行った場合に使用可能です。 7.0.0 以降。


id: imagick::ALPHACHANNEL_REMOVE
type: constant
doc:
<comment>Description:</comment>
  この定数は、Imagick のコンパイルを次のバージョンの ImageMagick で 
  行った場合に使用可能です。 6.7.8 以降。


id: imagick::COLORSPACE_CMY
type: constant
doc:
<comment>Description:</comment>
  この定数は、Imagick のコンパイルを次のバージョンの ImageMagick で 
  行った場合に使用可能です。 6.4.2 以降。


id: imagick::COMPRESSION_DXT1
type: constant
doc:
<comment>Description:</comment>
  この定数は、Imagick のコンパイルを次のバージョンの ImageMagick で 
  行った場合に使用可能です。 6.4.0 以降。


id: imagick::DISTORTION_AFFINE
type: constant
doc:
<comment>Description:</comment>
  この定数は、Imagick のコンパイルを次のバージョンの ImageMagick で 
  行った場合に使用可能です。 6.3.6 以降。


id: imagick::EVALUATE_ADDMODULUS
type: constant
doc:
<comment>Description:</comment>
  この定数は、Imagick のコンパイルを次のバージョンの ImageMagick で 
  行った場合に使用可能です。 6.4.4 以降。


id: imagick::FUNCTION_POLYNOMIAL
type: constant
doc:
<comment>Description:</comment>
  この定数は、Imagick のコンパイルを次のバージョンの ImageMagick で 
  行った場合に使用可能です。 6.4.9 以降。


id: imagick::INTERLACE_GIF
type: constant
doc:
<comment>Description:</comment>
  この定数は、Imagick のコンパイルを次のバージョンの ImageMagick で 
  行った場合に使用可能です。 6.3.4 以降。


id: imagick::INTERPOLATE_AVERAGE
type: constant
doc:
<comment>Description:</comment>
  この定数は、Imagick のコンパイルを次のバージョンの ImageMagick で 
  行った場合に使用可能です。 6.3.2 以降。


id: imagick::LAYERMETHOD_COALESCE
type: constant
doc:
<comment>Description:</comment>
  この定数は、Imagick のコンパイルを次のバージョンの ImageMagick で 
  行った場合に使用可能です。 6.2.9 以降。


id: imagick::LAYERMETHOD_COMPOSITE
type: constant
doc:
<comment>Description:</comment>
  この定数は、Imagick のコンパイルを次のバージョンの ImageMagick で 
  行った場合に使用可能です。 6.3.0 以降。


id: imagick::LAYERMETHOD_FLATTEN
type: constant
doc:
<comment>Description:</comment>
  この定数は、Imagick のコンパイルを次のバージョンの ImageMagick で 
  行った場合に使用可能です。 6.3.7 以降。


id: imagick::RESOURCETYPE_THREAD
type: constant
doc:
<comment>Description:</comment>
  並行スレッドの最大数を設定する。 この定数は、Imagick のコンパイルを次のバージョンの ImageMagick で 
  行った場合に使用可能です。 6.7.8 以降で利用可能。


id: imagick::VIRTUALPIXELMETHOD_HORIZONTALTILE
type: constant
doc:
<comment>Description:</comment>
  この定数は、Imagick のコンパイルを次のバージョンの ImageMagick で 
  行った場合に使用可能です。 6.4.3 以降。


id: imap_8bit
type: function
doc:
<comment>Description:</comment>
  8 ビット文字列を quoted-printable 文字列に変換する
  
  (RFC2045, section 6.7 に基づき) 8 ビット文字列を quoted-printable 文字列に変換します。

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  変換する 8 ビット文字列。

<comment>Return:</comment>
  <info>string|false</info>  quoted-printable 文字列を返します。 失敗した場合に <info>false</info> を返します

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


id: imap_alerts
type: function
doc:
<comment>Description:</comment>
  発生した IMAP 警告メッセージを返す
  
  直近に <strong>imap_alerts()</strong> をコールして以来、 またはページ処理を開始して以来生成された 全 IMAP 警告メッ
  セージの配列を返します。
  
  <strong>imap_alerts()</strong> がコールされた場合、 その処理後に警告のスタックはクリアされます。IMAP の仕様では、
  これらのメッセージをユーザーに渡すことが規定されています。

<comment>Return:</comment>
  <info>array|false</info>  全ての IMAP 警告メッセージの配列、あるいは警告メッセージが発生していない場合は <info>false</info>
               を返します。

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


id: imap_append
type: function
doc:
<comment>Description:</comment>
  指定されたメールボックスに文字列メッセージを追加する
  
  指定したメールボックス <strong>$folder</strong> に文字列メッセージ <strong>$message</strong> を追加します。

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>           <class>IMAP\Connection</class> クラスのインスタンス。
  <info>string</info>           <strong>$folder</strong>         メールボックスの名前。詳細は <strong>imap_open()</strong> を参照ください。
                                   
                                   信頼できないデータをこのパラメータに渡すのであれば、
                                   imap.enable_insecure_rsh
                                   を無効にしておかなければ危険です。
  <info>string</info>           <strong>$message</strong>        追加したいメッセージを表す文字列。
                                   
                                   Cyrus IMAP サーバーと通信する際には、改行コードとして "\n" のかわ
                                   りに "\r\n" を使用する必要があります。さもなくば、操作は失敗しま
                                   す。
  <info>string|null</info>      <strong>$options</strong>        指定した場合は、 <strong>$options</strong> もその <strong>$folder</strong> に書きこまれます。
  <info>string|null</info>      <strong>$internal_date</strong>  このパラメータが設定されていると、追加したメッセージに
                                   INTERNALDATE を設定します。 このパラメータは、rfc2060 の日付時刻
                                   値の仕様を満たす文字列でなければなりません。

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


id: imap_base64
type: function
doc:
<comment>Description:</comment>
  BASE64 でエンコードされたテキストをデコードする
  
  BASE64 でエンコードされたテキスト <strong>$string</strong> をデコードします。

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  エンコードされたテキスト。

<comment>Return:</comment>
  <info>string|false</info>  デコードしたメッセージを文字列で返します。 失敗した場合に <info>false</info> を返します

<comment>See Also:</comment>
   * <strong>imap_binary()</strong>
   * <strong>base64_encode()</strong>
   * <strong>base64_decode()</strong>
   * RFC2045, Section 6.8


id: imap_binary
type: function
doc:
<comment>Description:</comment>
  8 ビット文字列を base64 文字列に変換する
  
  （RFC2045, Section 6.8 に基づき）8 ビット文字列を base64 文字列に変換します。

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  8 ビット文字列。

<comment>Return:</comment>
  <info>string|false</info>  base64 エンコードされた文字列を返します。 失敗した場合に <info>false</info> を返します

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


id: imap_body
type: function
doc:
<comment>Description:</comment>
  メッセージ本文を読む
  
  <strong>imap_body()</strong> は、現在のメールボックスにある  <strong>$message_num</strong> 番目のメッセージの本文を返します。
  
  <strong>imap_body()</strong> は、メッセージの本文と全く同じ コピーのみを返します。マルチパート MIME エンコードされ
  たメッセージの 一部を展開するには、その構造を解析するために <strong>imap_fetch_structure()</strong> を使用し、単一
  の部分要素の コピーを展開する際には、 <strong>imap_fetchbody()</strong> を使用する必要があります。

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>         <class>IMAP\Connection</class> クラスのインスタンス。
  <info>int</info>              <strong>$message_num</strong>  メッセージ番号。
  <info>int</info>              <strong>$flags</strong>        オプションの <strong>$flags</strong> はビットマスクであり、 以下の要素の組み合わせと
                                 なります。 <info>FT_UID</info> - <strong>$message_num</strong> は UID です <info>FT_PEEK</info> - 既に設定され
                                 ていない場合、\Seen フラグを設定しない <info>FT_INTERNAL</info> - 内部フォーマッ
                                 トで文字列を返す。 CRLF に正規化しない。
                                 
                                 <info>FT_UID</info> - <strong>$message_num</strong> は UID です
                                 
                                 <info>FT_PEEK</info> - 既に設定されていない場合、\Seen フラグを設定しない
                                 
                                 <info>FT_INTERNAL</info> - 内部フォーマットで文字列を返す。 CRLF に正規化しな
                                 い。

<comment>Return:</comment>
  <info>string|false</info>  指定したメッセージの本文を文字列で返します。 失敗した場合に <info>false</info> を返します


id: imap_bodystruct
type: function
doc:
<comment>Description:</comment>
  指定したメッセージの指定した body セクションの構造を読み込む
  
  指定したメッセージの指定した body セクションの構造を読み込みます。

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>         <class>IMAP\Connection</class> クラスのインスタンス。
  <info>int</info>              <strong>$message_num</strong>  メッセージ番号。
  <info>string</info>           <strong>$section</strong>      読み込む body セクション。

<comment>Return:</comment>
  <info>stdClass|false</info>  オブジェクトの情報を返します。 失敗した場合に <info>false</info> を返します。 オブジェクトの構
                  造やプロパティについての詳細は <strong>imap_fetchstructure()</strong> を参照ください。

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


id: imap_check
type: function
doc:
<comment>Description:</comment>
  現在のメールボックスをチェックする
  
  現在のメールボックスに関する情報を調べます。

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>  <class>IMAP\Connection</class> クラスのインスタンス。

<comment>Return:</comment>
  <info>stdClass|false</info>  以下のプロパティをもつオブジェクトの情報を返します。 <info>Date</info> - 現在のシステム時刻を
                  RFC2822 にしたがってフォーマットしたもの。 <info>Driver</info> - メールボックスにアクセスする際
                  に使用するプロトコル: POP3、IMAP、NNTP <info>Mailbox</info> - メールボックスの名前。 <info>Nmsgs</info> -
                  メールボックス内のメッセージの数。 <info>Recent</info> - メールボックス内の新規メッセージの数。
                  
                  <info>Date</info> - 現在のシステム時刻を RFC2822 にしたがってフォーマットしたもの。
                  
                  <info>Driver</info> - メールボックスにアクセスする際に使用するプロトコル: POP3、IMAP、NNTP
                  
                  <info>Mailbox</info> - メールボックスの名前。
                  
                  <info>Nmsgs</info> - メールボックス内のメッセージの数。
                  
                  <info>Recent</info> - メールボックス内の新規メッセージの数。
                  
                  失敗した場合には <info>false</info> を返します。


id: imap_clearflag_full
type: function
doc:
<comment>Description:</comment>
  メッセージのフラグをクリアする
  
  この関数は、指定したシーケンス <strong>$sequence</strong> のメッセージのフラグから、指定したフラグ <strong>$flag</strong> を削除しま
  す。

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>      <class>IMAP\Connection</class> クラスのインスタンス。
  <info>string</info>           <strong>$sequence</strong>  メッセージ番号のシーケンス。 <return>X,Y</return> のようにメッセージを列挙したり、 <return>X:Y</return>
                              のようにしてその間のすべてのメッセージを指定したりできます。
  <info>string</info>           <strong>$flag</strong>      設定可能なフラグは "\\Seen"、 "\\Answered"、"\\Flagged"、"\\Deleted"
                              および "\\Draft" です (RFC2060 で定義されています)。
  <info>int</info>              <strong>$options</strong>   オプション <strong>$options</strong> はビットマスクであり、 以下の組み合わせとなりま
                              す。 <info>ST_UID</info> - シーケンス引数はシーケンス番号の代わりに UID を含みま
                              す。
                              
                              <info>ST_UID</info> - シーケンス引数はシーケンス番号の代わりに UID を含みます。

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

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


id: imap_close
type: function
doc:
<comment>Description:</comment>
  IMAP ストリームをクローズする
  
  IMAP ストリームをクローズします。

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>   <class>IMAP\Connection</class> クラスのインスタンス。
  <info>int</info>              <strong>$flags</strong>  <info>CL_EXPUNGE</info> を指定した場合、メールボックスを閉じる前に暗黙のうちに 削除
                           マークがついた全てのメッセージを削除します。 <strong>imap_expunge()</strong> を使用して、
                           同じことを行うこともできます。

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

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


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


id: imap_createmailbox
type: function
doc:
<comment>Description:</comment>
  新しいメールボックスを作る
  
  <strong>imap_createmailbox()</strong> は <strong>$mailbox</strong> で指定された新しいメールボックスを作成します。

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>     <class>IMAP\Connection</class> クラスのインスタンス。
  <info>string</info>           <strong>$mailbox</strong>  メールボックス名。詳細は <strong>imap_open()</strong> を参照ください。 この名前に国際化
                             文字を含む場合には、 <strong>imap_utf7_encode()</strong> でエンコードする必要がありま
                             す。
                             
                             信頼できないデータをこのパラメータに渡すのであれば、
                             imap.enable_insecure_rsh
                             を無効にしておかなければ危険です。

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

<comment>See Also:</comment>
   * <strong>imap_renamemailbox()</strong>
   * <strong>imap_deletemailbox()</strong>


id: imap_delete
type: function
doc:
<comment>Description:</comment>
  現在のメールボックスから削除するメッセージに印を付ける
  
  <strong>$message_nums</strong> が指すメッセージに 削除予定のマークをします。削除マークを付けられたメッセージは、
  <strong>imap_expunge()</strong> がコールされるか <strong>imap_close()</strong> に <info>CL_EXPUNGE</info> を付けてコールされるかのどちらかが行わ
  れるまでメールボックスに残ったままになります。

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>          <class>IMAP\Connection</class> クラスのインスタンス。
  <info>string</info>           <strong>$message_nums</strong>  IMAP4 形式のシーケンスフォーマット (<return>"n"</return>, <return>"n:m"</return>, またはそれらをカン
                                  マで区切ったもの) で表現された、ひとつ以上のメッセージを表す文字
                                  列。
  <info>int</info>              <strong>$flags</strong>         <strong>$FT_UID</strong> を指定すると、 引数 <strong>$message_nums</strong> を <strong>$UID</strong> として処理するこ
                                  とを関数に指示できます。

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

<comment>See Also:</comment>
   * <strong>imap_undelete()</strong>
   * <strong>imap_expunge()</strong>
   * <strong>imap_close()</strong>


id: imap_deletemailbox
type: function
doc:
<comment>Description:</comment>
  メールボックスを削除する
  
  指定したメールボックス <strong>$mailbox</strong> を削除します。

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>     <class>IMAP\Connection</class> クラスのインスタンス。
  <info>string</info>           <strong>$mailbox</strong>  メールボックス名。詳細は <strong>imap_open()</strong> を参照ください。
                             
                             信頼できないデータをこのパラメータに渡すのであれば、
                             imap.enable_insecure_rsh
                             を無効にしておかなければ危険です。

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

<comment>See Also:</comment>
   * <strong>imap_createmailbox()</strong>
   * <strong>imap_renamemailbox()</strong>
   * <strong>$mbox</strong> の書式については
     <strong>imap_open()</strong>
    


id: imap_errors
type: function
doc:
<comment>Description:</comment>
  発生したすべての IMAP エラーを返す
  
  ページのリクエストの間かエラースタックがリセットされて以来 生じた全ての IMAP エラー (存在すれば)
  を返します。
  
  <strong>imap_errors()</strong> がコールされると、 処理の終了後にエラースタックがクリアされます。

<comment>Return:</comment>
  <info>array|false</info>  この関数は、最後に <strong>imap_errors()</strong> コールを行ってから、またはそのページの処理を開始して
               から 発生した全ての IMAP エラーメッセージの配列を返します。 エラーメッセージが存在し
               ない場合には <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>imap_last_error()</strong>
   * <strong>imap_alerts()</strong>


id: imap_expunge
type: function
doc:
<comment>Description:</comment>
  削除用にマークされたすべてのメッセージを削除する
  
  <strong>imap_delete()</strong>、<strong>imap_mail_move()</strong>、 あるいは <strong>imap_setflag_full()</strong> で削除用マークを設定されたすべての
  メッセージを削除します。

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>  <class>IMAP\Connection</class> クラスのインスタンス。

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


id: imap_fetch_overview
type: function
doc:
<comment>Description:</comment>
  指定したメッセージのヘッダ情報の概要を読む
  
  この関数は、指定された <strong>$sequence</strong> のメールヘッダを取得してその内容の概要を返します。

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>      <class>IMAP\Connection</class> クラスのインスタンス。
  <info>string</info>           <strong>$sequence</strong>  メッセージのシーケンスを指定します。 <return>X,Y</return> 形式で列挙したり、 <return>X:Y</return> 形式で
                              その範囲内のすべてのメッセージを取得したりできます。
  <info>int</info>              <strong>$flags</strong>     <strong>$sequence</strong> には、メッセージのインデックスか、もし <strong>$flags</strong> に FT_UID が含
                              まれている場合は UID が含まれます。

<comment>Return:</comment>
  <info>array|false</info>  オブジェクトの配列を返します。各要素が、 それぞれひとつのメッセージのヘッダを表しま
               す。 オブジェクトで定義されるのは、存在するプロパティのみです。 以下のプロパティがあ
               ります。 <return>subject</return> - メッセージの題名(subject) <return>from</return> - 送信者 <return>to</return> - 受信者 <return>date</return> - 送信日
               <return>message_id</return> - Message-ID  <return>references</return> - このメッセージ ID への参照です <return>in_reply_to</return> - こ
               のメッセージ ID への返信です <return>size</return> - サイズ（バイト数） <return>uid</return> - メールボックスにおけるこ
               のメッセージの UID <return>msgno</return> - メールボックスにおけるこのメッセージのシーケンス番号
               <return>recent</return> - このメッセージには recent フラグが立てられています <return>flagged</return> -  フラグが立てら
               れています <return>answered</return> -  返信済みフラグが立てられています <return>deleted</return> -  削除フラグが立てら
               れています <return>seen</return> -  既読フラグが立てられています <return>draft</return> -  草稿フラグが立てられています
               <return>udate</return> - 受信日時の UNIX タイムスタンプ  この関数は、失敗した時に <info>false</info> を返します。
               
               <return>subject</return> - メッセージの題名(subject)
               
               <return>from</return> - 送信者
               
               <return>to</return> - 受信者
               
               <return>date</return> - 送信日
               
               <return>message_id</return> - Message-ID
               
               <return>references</return> - このメッセージ ID への参照です
               
               <return>in_reply_to</return> - このメッセージ ID への返信です
               
               <return>size</return> - サイズ（バイト数）
               
               <return>uid</return> - メールボックスにおけるこのメッセージの UID
               
               <return>msgno</return> - メールボックスにおけるこのメッセージのシーケンス番号
               
               <return>recent</return> - このメッセージには recent フラグが立てられています
               
               <return>flagged</return> -  フラグが立てられています
               
               <return>answered</return> -  返信済みフラグが立てられています
               
               <return>deleted</return> -  削除フラグが立てられています
               
               <return>seen</return> -  既読フラグが立てられています
               
               <return>draft</return> -  草稿フラグが立てられています
               
               <return>udate</return> - 受信日時の UNIX タイムスタンプ

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


id: imap_fetchbody
type: function
doc:
<comment>Description:</comment>
  メッセージ本文中の特定のセクションを取り出す
  
  指定されたメッセージ本文中の特定のセクションを取得します。 本文パートは、この関数ではデコードされ
  ません。

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>         <class>IMAP\Connection</class> クラスのインスタンス。
  <info>int</info>              <strong>$message_num</strong>  メッセージ番号。
  <info>string</info>           <strong>$section</strong>      パート番号。ピリオドで区切られた整数文字列を指定します。 これは、
                                 IMAP4 仕様における本文パートのリストへのインデックスとなります。
  <info>int</info>              <strong>$flags</strong>        ビットマスクであり、以下の組合わせとなります。 <info>FT_UID</info> -
                                 <strong>$message_num</strong>は UID である <info>FT_PEEK</info> - 既に設定されていない場合、
                                 \Seen フラグを設定しない <info>FT_INTERNAL</info> - 内部フォーマットで文字列を返
                                 す。CRLF に正規化しない。
                                 
                                 <info>FT_UID</info> - <strong>$message_num</strong>は UID である
                                 
                                 <info>FT_PEEK</info> - 既に設定されていない場合、 \Seen フラグを設定しない
                                 
                                 <info>FT_INTERNAL</info> - 内部フォーマットで文字列を返す。CRLF に正規化しない。

<comment>Return:</comment>
  <info>string|false</info>  指定されたメッセージ本文中の特定のセクションをテキスト文字列で返します。 失敗した場
                合に <info>false</info> を返します

<comment>See Also:</comment>
   * <strong>imap_savebody()</strong>
   * <strong>imap_fetchstructure()</strong>


id: imap_fetchheader
type: function
doc:
<comment>Description:</comment>
  メッセージのヘッダを返す
  
  指定したメッセージについて、フィルタリング されていない完全な RFC2822 フォーマットのヘッダをテキス
  ト文字列として取得します。

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>         <class>IMAP\Connection</class> クラスのインスタンス。
  <info>int</info>              <strong>$message_num</strong>  メッセージ番号。
  <info>int</info>              <strong>$flags</strong>        オプション <strong>$flags</strong> は次のようになります。 <info>FT_UID</info> - 引数 <strong>$message_num</strong>
                                 は UID です。 <info>FT_INTERNAL</info> - 返される文字列は "internal" フォーマッ
                                 トです。CRLF に正規化しません。 <info>FT_PREFETCHTEXT</info> - RFC822.TEXT を、
                                 同時に事前に取得しておく必要があります。これは、メッセージテキスト
                                 全体を取得したい場合（例:「ローカルファイルに保存する」操作）に
                                 IMAP 接続で余分な RTT を回避します。
                                 
                                 <info>FT_UID</info> - 引数 <strong>$message_num</strong> は UID です。
                                 
                                 <info>FT_INTERNAL</info> - 返される文字列は "internal" フォーマットです。CRLF に
                                 正規化しません。
                                 
                                 <info>FT_PREFETCHTEXT</info> - RFC822.TEXT を、 同時に事前に取得しておく必要があ
                                 ります。これは、メッセージテキスト 全体を取得したい場合（例:「ロー
                                 カルファイルに保存する」操作）に IMAP 接続で余分な RTT を回避しま
                                 す。

<comment>Return:</comment>
  <info>string|false</info>  指定したメッセージのヘッダをテキスト文字列で返します。 失敗した場合に <info>false</info> を返しま
                す

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


id: imap_fetchmime
type: function
doc:
<comment>Description:</comment>
  メッセージの特定のセクションに対する MIME ヘッダを取り出します
  
  指定したメッセージの本文の特定のセクションの MIME ヘッダを取り出します。

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>         <class>IMAP\Connection</class> クラスのインスタンス。
  <info>int</info>              <strong>$message_num</strong>  メッセージ番号
  <info>string</info>           <strong>$section</strong>      パート番号。ピリオドで区切られた整数文字列を指定します。 これは、
                                 IMAP4 の仕様に従って本文パートのリストにインデックスを付けます。
  <info>int</info>              <strong>$flags</strong>        ビットマスク。以下の組合わせとなります。 <info>FT_UID</info> - <strong>$message_num</strong> は
                                 UID です <info>FT_PEEK</info> - 既に設定されていない場合、\Seen フラグを設定しま
                                 せん <info>FT_INTERNAL</info> - 返される文字列は内部フォーマットです。 CRLF に正
                                 規化しません。
                                 
                                 <info>FT_UID</info> - <strong>$message_num</strong> は UID です
                                 
                                 <info>FT_PEEK</info> - 既に設定されていない場合、\Seen フラグを設定しません
                                 
                                 <info>FT_INTERNAL</info> - 返される文字列は内部フォーマットです。 CRLF に正規化
                                 しません。

<comment>Return:</comment>
  <info>string|false</info>  指定したメッセージの本文の特定のセクションの MIME ヘッダを文字列として返します。 失
                敗した場合に <info>false</info> を返します

<comment>See Also:</comment>
   * <strong>imap_fetchbody()</strong>
   * <strong>imap_fetchstructure()</strong>
   * <strong>imap_fetchheader()</strong>


id: imap_fetchstructure
type: function
doc:
<comment>Description:</comment>
  特定のメッセージの構造を読み込む
  
  この関数は、指定したメッセージに関するすべての構造化された情報を取り出します。

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>         <class>IMAP\Connection</class> クラスのインスタンス。
  <info>int</info>              <strong>$message_num</strong>  メッセージ番号。
  <info>int</info>              <strong>$flags</strong>        オプションのパラメータで、<strong>$FT_UID</strong> のみが指定可能です。 これは、
                                 <strong>$message_num</strong> を <strong>$UID</strong> として処理することを関数に指定するためのもので
                                 す。

<comment>Return:</comment>
  <info>stdClass|false</info>  以下の表に示すプロパティを持つオブジェクトを返します。 失敗した場合に <info>false</info> を返し
                  ます
                  
                  <strong>imap_fetchstructure()</strong> が返すオブジェクト type最初の body 部の型encodingbody 部を転
                  送する際のエンコード法ifsubtypesubtype 文字列がある場合に <info>true</info>subtypeMIME の
                  subtypeifdescriptiondescription 文字列がある場合に <info>true</info>description内容を記述する文
                  字列ifididentification 文字列がある場合に <info>true</info>idIdentification 文字列lines行数
                  bytesバイト数ifdispositiondisposition 文字列がある場合に
                  <info>true</info>dispositionDisposition 文字列ifdparametersdparameters 配列が存在する場合に
                  <info>true</info>dparametersオブジェクトの配列。各オブジェクトは <return>"attribute"</return> および <return>"value"</return> と
                  いうプロパティを保持し、それぞれ <return>Content-disposition</return> MIME ヘッダの 対応するパラ
                  メータを表す。ifparameters配列 parameters が存在する場合に <info>true</info>parametersオブジェ
                  クトの配列。各オブジェクトは <return>"attribute"</return> および <return>"value"</return> というプロパティを保持す
                  る。partsオブジェクトの配列であり、その構造はトップレベルオブジェクトと 同じです。
                  それぞれが MIME body 部に対応しています。
                  
                  最初の body 部の型 (使用するライブラリによって異なるため、定数を使うことを推奨しま
                  す)値型定数
                  0textTYPETEXT1multipartTYPEMULTIPART2messageTYPEMESSAGE3applicationTYPEAPPLICATION4audioTYPEAUDIO5imageTYPEIMAGE6videoTYPEVIDEO7modelTYPEMODEL8otherTYPEOTHER
                  
                  転送時のエンコーディング (使用するライブラリによって異なるため、定数を使うことを推
                  奨します)値型定数
                  07bitENC7BIT18bitENC8BIT2BinaryENCBINARY3Base64ENCBASE644Quoted-PrintableENCQUOTEDPRINTABLE5otherENCOTHER

<comment>See Also:</comment>
   * <strong>imap_fetchbody()</strong>
   * <strong>imap_bodystruct()</strong>


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


id: imap_gc
type: function
doc:
<comment>Description:</comment>
  IMAP キャッシュをクリアする
  
  指定した型のエントリのキャッシュを破棄します。

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>   <class>IMAP\Connection</class> クラスのインスタンス。
  <info>int</info>              <strong>$flags</strong>  破棄したいキャッシュを指定します。以下の定数 <info>IMAP_GC_ELT</info> (メッセージ
                           キャッシュ要素)、 <info>IMAP_GC_ENV</info> (エンベロープおよびボディ)、 <info>IMAP_GC_TEXTS</info>
                           (テキスト) の組み合わせとなります。

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


id: imap_get_quota
type: function
doc:
<comment>Description:</comment>
  クオータレベルの設定、メールボックス毎の使用状況を取得する
  
  クオータレベルの設定、メールボックス毎の使用状況を取得します。
  
  この関数の非管理者向けバージョンは、 PHP の <strong>imap_get_quotaroot()</strong> 関数を参照ください。

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>        <class>IMAP\Connection</class> クラスのインスタンス。
  <info>string</info>           <strong>$quota_root</strong>  <strong>$quota_root</strong> は、通常 <return>user.name</return> という形式にする必要があります。 name
                                は、情報を取得したいメールボックスの名前です。

<comment>Return:</comment>
  <info>array|false</info>  指定したメールボックスの limit と usage をキーとした整数値を配列として返します。
               limit の値は、このメールボックスで最大使用可能な大きさを表します。 usage の値は、この
               メールボックスの現在の使用状況を示します。 失敗した場合に <info>false</info> を返します。
               
               PHP 4.3 では、この関数は RFC2087 で述べられている機能をより適切に反映するようになって
               います。 戻り値の配列からは、サポートするリソース （例:メッセージ、あるいはサブフォル
               ダ）数の制限をなくし、 名前つきリソースを独立した配列のキーとして受信するようにしまし
               た。 各キーの値は配列となっており、その中に usage と values の値が格納されています。
               
               過去との互換性を保つため、旧来のアクセス方法も使用可能です。 しかし新しい方法に変更す
               ることを推奨します。

<comment>See Also:</comment>
   * <strong>imap_open()</strong>
   * <strong>imap_set_quota()</strong>
   * <strong>imap_get_quotaroot()</strong>


id: imap_get_quotaroot
type: function
doc:
<comment>Description:</comment>
  ユーザー単位のクォータ設定を取得する
  
  ユーザー単位のクォータ設定を取得します。 limit の値は、このユーザーがメールボックスで使用可能な総
  容量を表します。 usage の値は、ユーザーが現在メールボックスで使用している容量を表します。

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>     <class>IMAP\Connection</class> クラスのインスタンス。
  <info>string</info>           <strong>$mailbox</strong>  <strong>$mailbox</strong> はどのメールボックスを調べるかを 指定します（例: INBOX）。

<comment>Return:</comment>
  <info>array|false</info>  指定したユーザーのメールボックスに関連する整数値を配列で返します。 すべての値にはリ
               ソース名に基づいたキーがつけられており、 usage および limit 値を保持する配列が関連付
               けられています。
               
               コールが失敗した場合、およびサーバーからの応答内容をパースできなかった場合には この関
               数は <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>imap_open()</strong>
   * <strong>imap_set_quota()</strong>
   * <strong>imap_get_quota()</strong>


id: imap_getacl
type: function
doc:
<comment>Description:</comment>
  与えられたメールボックスの ACL を取得する
  
  指定したメールボックスの ACL を取得します。

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>     <class>IMAP\Connection</class> クラスのインスタンス。
  <info>string</info>           <strong>$mailbox</strong>  メールボックス名。詳細は <strong>imap_open()</strong> を参照ください。
                             
                             信頼できないデータをこのパラメータに渡すのであれば、
                             imap.enable_insecure_rsh
                             を無効にしておかなければ危険です。

<comment>Return:</comment>
  <info>array|false</info>  "folder" =&gt; "acl" 形式の連想配列を返します。 失敗した場合に <info>false</info> を返します

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


id: imap_getmailboxes
type: function
doc:
<comment>Description:</comment>
  メールボックスのリストを読み込み、各ボックスに関する詳細な情報を返す
  
  メールボックスの情報を取得します。

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>       <class>IMAP\Connection</class> クラスのインスタンス。
  <info>string</info>           <strong>$reference</strong>  通常、<strong>$reference</strong> は <strong>imap_open()</strong> で述べられているサーバー定義です。
                               
                               信頼できないデータをこのパラメータに渡すのであれば、
                               imap.enable_insecure_rsh
                               を無効にしておかなければ危険です。
  <info>string</info>           <strong>$pattern</strong>    検索を開始するメールボックスの階層を指定します。
                               
                               <strong>$pattern</strong> の中で使用できる特別な文字として
                               '<return>*</return>' および '<return>%</return>' があります。
                               '<return>*</return>' は、すべてのメールボックスを意味します。
                               <strong>$pattern</strong> に '<return>*</return>' を指定すると、
                               メールボックス階層全体のリストが得られます。
                               '<return>%</return>' は現在のレベルのみを意味します。
                               '<return>%</return>' を <strong>$pattern</strong> に指定すると、
                               トップレベルのメールボックスのみを返します。<return>UW_IMAPD</return> の場合、
                               '<return>~/mail/%</return>' は
                               ~/mail ディレクトリ内のすべてのメールボックスを返しますが、
                               そのディレクトリのサブフォルダにあるメールボックスは返しません。

<comment>Return:</comment>
  <info>array|false</info>  メールボックス情報を有するオブジェクトの配列を返します。各オブジェクトには、 メール
               ボックスの完全な名前である <strong>$name</strong>、 このメールボックスの階層の区切りを示す属性
               <strong>$delimiter</strong>、 そして <strong>$attributes</strong> が存在します。 <strong>$attributes</strong> はビットマスクであり、 次
               のものについて調べることができます。 <info>LATT_NOINFERIORS</info> - このメールボックスには 「子
               供」がいないか、またはいないかもしれません（このボックスの中にメールボックスはありま
               せん）。 このメールボックスに対して <strong>imap_createmailbox()</strong> をコールしても動作しません。
               <info>LATT_NOSELECT</info> - 単なるコンテナであり、 メールボックスではありません - これをオープン
               することはできません。 <info>LATT_MARKED</info> - このメールボックスにはマークがつけられています。
               これは、最後に確認したとき以降に新たなメッセージが到着しているかもしれないということ
               を意味します。 すべての IMAP サーバーがこの機能を提供しているとは限りません。
               <info>LATT_UNMARKED</info> - このメールボックスにはマークがつけられておらず、 新たなメッセージを含
               んでいません。 <info>MARKED</info> あるいは <info>UNMARKED</info> が提供されている場合は、 その IMAP サーバーが
               このメールボックスに対してマーク機能を提供しているとみなせます。 <info>LATT_REFERRAL</info> - この
               コンテナはリモートメールボックスと関連を持ちます。 <info>LATT_HASCHILDREN</info> - このメールボッ
               クスは選択可能な子を持ちます。 <info>LATT_HASNOCHILDREN</info> - このメールボックスは選択可能な子
               を持ちません。  この関数は、失敗した時に <info>false</info> を返します。
               
               <info>LATT_NOINFERIORS</info> - このメールボックスには 「子供」がいないか、またはいないかもしれま
               せん（このボックスの中にメールボックスはありません）。 このメールボックスに対して
               <strong>imap_createmailbox()</strong> をコールしても動作しません。
               
               <info>LATT_NOSELECT</info> - 単なるコンテナであり、 メールボックスではありません - これをオープン
               することはできません。
               
               <info>LATT_MARKED</info> - このメールボックスにはマークがつけられています。 これは、最後に確認した
               とき以降に新たなメッセージが到着しているかもしれないということを意味します。 すべての
               IMAP サーバーがこの機能を提供しているとは限りません。
               
               <info>LATT_UNMARKED</info> - このメールボックスにはマークがつけられておらず、 新たなメッセージを含
               んでいません。 <info>MARKED</info> あるいは <info>UNMARKED</info> が提供されている場合は、 その IMAP サーバーが
               このメールボックスに対してマーク機能を提供しているとみなせます。
               
               <info>LATT_REFERRAL</info> - このコンテナはリモートメールボックスと関連を持ちます。
               
               <info>LATT_HASCHILDREN</info> - このメールボックスは選択可能な子を持ちます。
               
               <info>LATT_HASNOCHILDREN</info> - このメールボックスは選択可能な子を持ちません。

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


id: imap_getsubscribed
type: function
doc:
<comment>Description:</comment>
  購読中の全メールボックスの一覧を取得する
  
  購読中のメールボックスの情報を取得します。
  
  <strong>imap_getmailboxes()</strong> と同じ動作をしますが、 ユーザーが購読しているメールボックスのみを返すという点
  が異なります。

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>       <class>IMAP\Connection</class> クラスのインスタンス。
  <info>string</info>           <strong>$reference</strong>  <strong>$reference</strong> は、通常は <strong>imap_open()</strong> で指定したサーバー情報です。
                               
                               信頼できないデータをこのパラメータに渡すのであれば、
                               imap.enable_insecure_rsh
                               を無効にしておかなければ危険です。
  <info>string</info>           <strong>$pattern</strong>    検索を開始するメールボックスの階層を指定します。
                               
                               <strong>$pattern</strong> の中で使用できる特別な文字として
                               '<return>*</return>' および '<return>%</return>' があります。
                               '<return>*</return>' は、すべてのメールボックスを意味します。
                               <strong>$pattern</strong> に '<return>*</return>' を指定すると、
                               メールボックス階層全体のリストが得られます。
                               '<return>%</return>' は現在のレベルのみを意味します。
                               '<return>%</return>' を <strong>$pattern</strong> に指定すると、
                               トップレベルのメールボックスのみを返します。<return>UW_IMAPD</return> の場合、
                               '<return>~/mail/%</return>' は
                               ~/mail ディレクトリ内のすべてのメールボックスを返しますが、
                               そのディレクトリのサブフォルダにあるメールボックスは返しません。

<comment>Return:</comment>
  <info>array|false</info>  メールボックス情報を有するオブジェクトの配列を返します。各オブジェクトには、 メール
               ボックスの完全な名前である <strong>$name</strong>、 このメールボックスの階層の区切りを示す属性
               <strong>$delimiter</strong>、 そして <strong>$attributes</strong> が存在します。 <strong>$attributes</strong> はビットマスクであり、 次
               のものについて調べることができます。 <info>LATT_NOINFERIORS</info> - このメールボックスには 「子
               供」はいません（このボックスの中にメールボックスはありません）。 <info>LATT_NOSELECT</info> - 単な
               るコンテナであり、 メールボックスではありません - これをオープンすることはできませ
               ん。 <info>LATT_MARKED</info> - このメールボックスにはマークが つけられています。UW-IMAPD でのみ使
               用されます。 <info>LATT_UNMARKED</info> - このメールボックスにはマークが つけられていません。
               UW-IMAPD でのみ使用されます。 <info>LATT_REFERRAL</info> - このコンテナはリモートメールボックスと
               関連を持ちます。 <info>LATT_HASCHILDREN</info> - このメールボックスは選択可能な子を持ちます。
               <info>LATT_HASNOCHILDREN</info> - このメールボックスは選択可能な子を持ちません。  この関数は、失敗
               した時に <info>false</info> を返します。
               
               <info>LATT_NOINFERIORS</info> - このメールボックスには 「子供」はいません（このボックスの中にメー
               ルボックスはありません）。
               
               <info>LATT_NOSELECT</info> - 単なるコンテナであり、 メールボックスではありません - これをオープン
               することはできません。
               
               <info>LATT_MARKED</info> - このメールボックスにはマークが つけられています。UW-IMAPD でのみ使用さ
               れます。
               
               <info>LATT_UNMARKED</info> - このメールボックスにはマークが つけられていません。UW-IMAPD でのみ使
               用されます。
               
               <info>LATT_REFERRAL</info> - このコンテナはリモートメールボックスと関連を持ちます。
               
               <info>LATT_HASCHILDREN</info> - このメールボックスは選択可能な子を持ちます。
               
               <info>LATT_HASNOCHILDREN</info> - このメールボックスは選択可能な子を持ちません。


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


id: imap_headerinfo
type: function
doc:
<comment>Description:</comment>
  メッセージヘッダを読み込む
  
  指定したメッセージ番号についての情報を、そのヘッダを読み込んで取得します。

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>            <class>IMAP\Connection</class> クラスのインスタンス。
  <info>int</info>              <strong>$message_num</strong>     メッセージ番号。
  <info>int</info>              <strong>$from_length</strong>     <return>fetchfrom</return> プロパティの文字数。 ゼロ以上でなければなりません。
  <info>int</info>              <strong>$subject_length</strong>  <return>fetchsubject</return> プロパティの文字数。 ゼロ以上でなければなりません。
  <info></info>                 <strong>$defaulthost</strong>     

<comment>Return:</comment>
  <info>stdClass|false</info>  エラー時には <info>false</info>、成功時には 以下のプロパティをもつオブジェクトを返します。
                  toaddress - 完全な to: 行。最大 1024 文字。  to - To: 行から、次のプロパティを含む
                  オブジェクトの配列を返します。 <return>personal</return>、<return>adl</return>、 <return>mailbox</return> および <return>host</return>  fromaddress -
                  完全な from: 行。最大 1024 文字。  from - From: 行から、次のプロパティを含むオブ
                  ジェクトの配列を返します。 <return>personal</return>、<return>adl</return>、 <return>mailbox</return> および <return>host</return>  ccaddress - 完全な
                  cc: 行。最大 1024 文字。  cc - Cc: 行から、次のプロパティを含むオブジェクトの配列
                  を返します。 <return>personal</return>、<return>adl</return>、 <return>mailbox</return> および <return>host</return>  bccaddress - 完全な bcc: 行。最
                  大 1024 文字。  bcc - Bcc: 行から、次のプロパティを含むオブジェクトの配列を返しま
                  す。 <return>personal</return>、<return>adl</return>、 <return>mailbox</return> および <return>host</return>  reply_toaddress - 完全な Reply-To: 行。
                  最大 1024 文字。  reply_to - Reply-To: 行から、次のプロパティを含むオブジェクトの
                  配列を返します。 <return>personal</return>、<return>adl</return>、 <return>mailbox</return> および <return>host</return>  senderaddress - 完全な
                  sender: 行。最大 1024 文字。  sender - Sender: 行から、次のプロパティを含むオブ
                  ジェクトの配列を返します。 <return>personal</return>、<return>adl</return>、 <return>mailbox</return> および <return>host</return>  return_pathaddress
                  - 完全な Return-Path: 行。最大 1024 文字。  return_path - Return-Path: 行から、次
                  のプロパティを含むオブジェクトの配列を返します。 <return>personal</return>、 <return>adl</return>、<return>mailbox</return> および
                  <return>host</return>  remail -   date - ヘッダにあるメッセージの日付。  Date - date と同じ。
                  subject - メッセージの件名。  Subject - subject と同じ。  in_reply_to -
                  message_id -   newsgroups -   followup_to -   references -   Recent - 最近の既読
                  メッセージは <return>R</return>、 最新の未読メッセージは <return>N</return>、 最新でないメッセージは ' '。  Unseen -
                  最新でない未読メッセージは <return>U</return>、 既読、あるいは最新の未読メッセージは ' '。  Flagged
                  - フラグがたっている場合は <return>F</return>、 そうでない場合は ' '。  Answered - 返信した場合は
                  <return>A</return>、 していない場合は ' '。  Deleted - 削除された場合は <return>D</return>、 されていない場合は '
                  '。  Draft - 草稿である場合は <return>X</return>、 そうでない場合は ' '。  Msgno - メッセージ番号。
                  MailDate -   Size - メッセージのサイズ。  udate - メールメッセージの日付を Unix
                  time で表したもの。  fetchfrom - from 行を <strong>$from_length</strong> 文字に適合させたもの。
                  fetchsubject - subject 行を <strong>$subject_length</strong> 文字に適合させたもの。
                  
                  toaddress - 完全な to: 行。最大 1024 文字。
                  
                  to - To: 行から、次のプロパティを含むオブジェクトの配列を返します。 <return>personal</return>、
                  <return>adl</return>、 <return>mailbox</return> および <return>host</return>
                  
                  fromaddress - 完全な from: 行。最大 1024 文字。
                  
                  from - From: 行から、次のプロパティを含むオブジェクトの配列を返します。 <return>personal</return>、
                  <return>adl</return>、 <return>mailbox</return> および <return>host</return>
                  
                  ccaddress - 完全な cc: 行。最大 1024 文字。
                  
                  cc - Cc: 行から、次のプロパティを含むオブジェクトの配列を返します。 <return>personal</return>、
                  <return>adl</return>、 <return>mailbox</return> および <return>host</return>
                  
                  bccaddress - 完全な bcc: 行。最大 1024 文字。
                  
                  bcc - Bcc: 行から、次のプロパティを含むオブジェクトの配列を返します。 <return>personal</return>、
                  <return>adl</return>、 <return>mailbox</return> および <return>host</return>
                  
                  reply_toaddress - 完全な Reply-To: 行。最大 1024 文字。
                  
                  reply_to - Reply-To: 行から、次のプロパティを含むオブジェクトの配列を返します。
                  <return>personal</return>、<return>adl</return>、 <return>mailbox</return> および <return>host</return>
                  
                  senderaddress - 完全な sender: 行。最大 1024 文字。
                  
                  sender - Sender: 行から、次のプロパティを含むオブジェクトの配列を返します。
                  <return>personal</return>、<return>adl</return>、 <return>mailbox</return> および <return>host</return>
                  
                  return_pathaddress - 完全な Return-Path: 行。最大 1024 文字。
                  
                  return_path - Return-Path: 行から、次のプロパティを含むオブジェクトの配列を返しま
                  す。 <return>personal</return>、 <return>adl</return>、<return>mailbox</return> および <return>host</return>
                  
                  remail -
                  
                  date - ヘッダにあるメッセージの日付。
                  
                  Date - date と同じ。
                  
                  subject - メッセージの件名。
                  
                  Subject - subject と同じ。
                  
                  in_reply_to -
                  
                  message_id -
                  
                  newsgroups -
                  
                  followup_to -
                  
                  references -
                  
                  Recent - 最近の既読メッセージは <return>R</return>、 最新の未読メッセージは <return>N</return>、 最新でないメッセー
                  ジは ' '。
                  
                  Unseen - 最新でない未読メッセージは <return>U</return>、 既読、あるいは最新の未読メッセージは ' '。
                  
                  Flagged - フラグがたっている場合は <return>F</return>、 そうでない場合は ' '。
                  
                  Answered - 返信した場合は <return>A</return>、 していない場合は ' '。
                  
                  Deleted - 削除された場合は <return>D</return>、 されていない場合は ' '。
                  
                  Draft - 草稿である場合は <return>X</return>、 そうでない場合は ' '。
                  
                  Msgno - メッセージ番号。
                  
                  MailDate -
                  
                  Size - メッセージのサイズ。
                  
                  udate - メールメッセージの日付を Unix time で表したもの。
                  
                  fetchfrom - from 行を <strong>$from_length</strong> 文字に適合させたもの。
                  
                  fetchsubject - subject 行を <strong>$subject_length</strong> 文字に適合させたもの。

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


id: imap_headers
type: function
doc:
<comment>Description:</comment>
  メールボックス内のすべてのメッセージのヘッダを返す
  
  メールボックス内のすべてのメッセージのヘッダを返します。

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>  <class>IMAP\Connection</class> クラスのインスタンス。

<comment>Return:</comment>
  <info>array|false</info>  ヘッダ情報でフォーマットされた文字列の配列を返します。1 つの メールメッセージ毎に 1
               つの要素が格納されます。 失敗した場合に <info>false</info> を返します。


id: imap_is_open
type: function
doc:
<comment>Description:</comment>
  IMAP ストリームがまだ有効かを調べる
  
  IMAP ストリームがまだ有効かを調べます。

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>  <class>IMAP\Connection</class> クラスのインスタンス。

<comment>Return:</comment>
  <info>bool</info>  ストリームがまだ有効な場合は、<info>true</info> を返します。 そうでない場合は、<info>false</info> を返します。


id: imap_last_error
type: function
doc:
<comment>Description:</comment>
  ページリクエスト時に生じた直近の IMAP エラーを返す
  
  現在のページに生じた直近の IMAP エラーメッセージの全文を返します。 エラースタックは変更されませ
  ん。 <strong>imap_last_error()</strong> を続けてコールした際、 コール間に新規エラーが生じていない場合は同じエラーが
  返されます。

<comment>Return:</comment>
  <info>string|false</info>  現在のページに生じた直近の IMAP エラーメッセージの全文を返します。 エラーメッセージ
                が存在しない場合は <info>false</info> を返します。

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


id: imap_list
type: function
doc:
<comment>Description:</comment>
  メールボックスのリストを読み込む
  
  メールボックスのリストを読み込みます。

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>       <class>IMAP\Connection</class> クラスのインスタンス。
  <info>string</info>           <strong>$reference</strong>  通常、<strong>$reference</strong> は <strong>imap_open()</strong> で述べられているサーバー定義です。
                               
                               信頼できないデータをこのパラメータに渡すのであれば、
                               imap.enable_insecure_rsh
                               を無効にしておかなければ危険です。
  <info>string</info>           <strong>$pattern</strong>    検索を開始するメールボックスの階層を指定します。
                               
                               <strong>$pattern</strong> の中で使用できる特別な文字として
                               '<return>*</return>' および '<return>%</return>' があります。
                               '<return>*</return>' は、すべてのメールボックスを意味します。
                               <strong>$pattern</strong> に '<return>*</return>' を指定すると、
                               メールボックス階層全体のリストが得られます。
                               '<return>%</return>' は現在のレベルのみを意味します。
                               '<return>%</return>' を <strong>$pattern</strong> に指定すると、
                               トップレベルのメールボックスのみを返します。<return>UW_IMAPD</return> の場合、
                               '<return>~/mail/%</return>' は
                               ~/mail ディレクトリ内のすべてのメールボックスを返しますが、
                               そのディレクトリのサブフォルダにあるメールボックスは返しません。

<comment>Return:</comment>
  <info>array|false</info>  メールボックスの名前を含む配列を返します。 または失敗時に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>imap_getmailboxes()</strong>
   * <strong>imap_lsub()</strong>


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


id: imap_listscan
type: function
doc:
<comment>Description:</comment>
  指定したテキストにマッチするメールボックスの一覧を返す
  
  <strong>$content</strong> をテキストに持つメールボックスの名前を 配列で返します。
  
  この関数は <strong>imap_listmailbox()</strong> に似ていますが、 メールボックス内に文字列 <strong>$content</strong> が存在するか どう
  かを調べる点が違います。

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>       <class>IMAP\Connection</class> クラスのインスタンス。
  <info>string</info>           <strong>$reference</strong>  通常、<strong>$reference</strong> は <strong>imap_open()</strong> で述べられているサーバー定義です。
                               
                               信頼できないデータをこのパラメータに渡すのであれば、
                               imap.enable_insecure_rsh
                               を無効にしておかなければ危険です。
  <info>string</info>           <strong>$pattern</strong>    検索を開始するメールボックスの階層を指定します。
                               
                               <strong>$pattern</strong> の中で使用できる特別な文字として
                               '<return>*</return>' および '<return>%</return>' があります。
                               '<return>*</return>' は、すべてのメールボックスを意味します。
                               <strong>$pattern</strong> に '<return>*</return>' を指定すると、
                               メールボックス階層全体のリストが得られます。
                               '<return>%</return>' は現在のレベルのみを意味します。
                               '<return>%</return>' を <strong>$pattern</strong> に指定すると、
                               トップレベルのメールボックスのみを返します。<return>UW_IMAPD</return> の場合、
                               '<return>~/mail/%</return>' は
                               ~/mail ディレクトリ内のすべてのメールボックスを返しますが、
                               そのディレクトリのサブフォルダにあるメールボックスは返しません。
  <info>string</info>           <strong>$content</strong>    検索する文字列。

<comment>Return:</comment>
  <info>array|false</info>  <strong>$content</strong> をテキストに持つメールボックスの名前を配列で返します。 失敗した場合に <info>false</info>
               を返します

<comment>See Also:</comment>
   * <strong>imap_listmailbox()</strong>
   * <strong>imap_search()</strong>


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


id: imap_lsub
type: function
doc:
<comment>Description:</comment>
  購読しているすべてのメールボックスの一覧を得る
  
  購読しているすべてのメールボックスの配列を取得します。

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>       <class>IMAP\Connection</class> クラスのインスタンス。
  <info>string</info>           <strong>$reference</strong>  通常、<strong>$reference</strong> は <strong>imap_open()</strong> で述べられているサーバー定義です。
                               
                               信頼できないデータをこのパラメータに渡すのであれば、
                               imap.enable_insecure_rsh
                               を無効にしておかなければ危険です。
  <info>string</info>           <strong>$pattern</strong>    検索を開始するメールボックスの階層を指定します。
                               
                               <strong>$pattern</strong> の中で使用できる特別な文字として
                               '<return>*</return>' および '<return>%</return>' があります。
                               '<return>*</return>' は、すべてのメールボックスを意味します。
                               <strong>$pattern</strong> に '<return>*</return>' を指定すると、
                               メールボックス階層全体のリストが得られます。
                               '<return>%</return>' は現在のレベルのみを意味します。
                               '<return>%</return>' を <strong>$pattern</strong> に指定すると、
                               トップレベルのメールボックスのみを返します。<return>UW_IMAPD</return> の場合、
                               '<return>~/mail/%</return>' は
                               ~/mail ディレクトリ内のすべてのメールボックスを返しますが、
                               そのディレクトリのサブフォルダにあるメールボックスは返しません。

<comment>Return:</comment>
  <info>array|false</info>  購読しているすべてのメールボックスの配列を返します。 失敗した場合に <info>false</info> を返します

<comment>See Also:</comment>
   * <strong>imap_list()</strong>
   * <strong>imap_getmailboxes()</strong>


id: imap_mail
type: function
doc:
<comment>Description:</comment>
  e-mail メッセージを送信する
  
  この関数は、Cc および Bcc 受信者の正確な処理を行って email を送信することが可能です。
  
  パラメータ <strong>$to</strong>、<strong>$cc</strong> および <strong>$bcc</strong> は全て文字列で、 RFC822 アドレスリストとしてパースされます。

<comment>Param:</comment>
  <info>string</info>       <strong>$to</strong>                  受信者。
  <info>string</info>       <strong>$subject</strong>             メールの件名。
  <info>string</info>       <strong>$message</strong>             メールの本文。 <strong>imap_mail_compose()</strong> を参照ください。
  <info>string|null</info>  <strong>$additional_headers</strong>  メールに設定する追加ヘッダ文字列。
  <info>string|null</info>  <strong>$cc</strong>                  
  <info>string|null</info>  <strong>$bcc</strong>                 <strong>$bcc</strong> で指定した受信者は mail を受信しますが、 ヘッダからは除外さ
                                    れます。
  <info>string|null</info>  <strong>$return_path</strong>         リターンパスを指定するために <strong>$rpath</strong> パラメータを使用してくださ
                                    い。この関数は、 複数のユーザー用のメールクライアントとして PHP
                                    を使用する際に有用です。

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

<comment>See Also:</comment>
   * <strong>mail()</strong>
   * <strong>imap_mail_compose()</strong>


id: imap_mail_compose
type: function
doc:
<comment>Description:</comment>
  指定したエンベロープおよびボディセクションに基づいて
     MIME メッセージを作成する
    
  
  指定したエンベロープ <strong>$envelope</strong> およびボディセクション <strong>$bodies</strong> に基づいて MIME メッセージを作成しま
  す。

<comment>Param:</comment>
  <info>array</info>  <strong>$envelope</strong>  ヘッダフィールドの連想配列。使えるキーは <return>"remail"</return>, <return>"return_path"</return>, <return>"date"</return>,
                    <return>"from"</return>, <return>"reply_to"</return>, <return>"in_reply_to"</return>, <return>"subject"</return>, <return>"to"</return>, <return>"cc"</return>, <return>"bcc"</return>。 <return>"message_id"</return>。
                    これらの値は、連想配列の値に与えられた文字列でそれぞれのヘッダを設定します。 さ
                    らに追加のヘッダを設定する用途として、 <return>"custom_headers"</return> がサポートされています。
                    ここには、その他のヘッダの連想配列を指定します。例: ["User-Agent: My Mail
                    Client"]
  <info>array</info>  <strong>$bodies</strong>    本文の配列。 配列の最初の要素が、メッセージの中心部分です。 <info>TYPEMULTIPART</info> の場合
                    にだけ、ふたつめ以降の要素が処理されます。 処理された要素は、本文の一部を構成し
                    ます。
                    
                    body に指定する配列の構造キー型説明<return>type</return><info>int</info> MIMEタイプ。 <info>TYPETEXT</info> (デフォルト),
                    <info>TYPEMULTIPART</info>, <info>TYPEMESSAGE</info>, <info>TYPEAPPLICATION</info>, <info>TYPEAUDIO</info>, <info>TYPEIMAGE</info>, <info>TYPEMODEL</info>,
                    <info>TYPEOTHER</info> が指定できます。 <return>encoding</return><info>int</info><return>Content-Transfer-Encoding</return> の値を指定しま
                    す。 <info>ENC7BIT</info> (デフォルト), <info>ENC8BIT</info>, <info>ENCBINARY</info>, <info>ENCBASE64</info>, <info>ENCQUOTEDPRINTABLE</info>,
                    <info>ENCOTHER</info> が指定できます。 <return>charset</return><info>string</info>MIMEタイプの charset パラメータの値
                    <return>type.parameters</return><info>array</info><return>Content-Type</return> の名前と値を連想配列で指定します。
                    <return>subtype</return><info>string</info>MIMEサブタイプ。例: <info>TYPEIMAGE</info> の場合は <return>'jpeg'</return><return>id</return><info>string</info><return>Content-ID</return> の
                    値<return>description</return><info>string</info><return>Content-Description</return> の値
                    <return>disposition.type</return><info>string</info><return>Content-Disposition</return> の値。例:
                    <return>'attachment'</return><return>disposition</return><info>array</info><return>Content-Disposition</return> の名前と値を連想配列で指定しま
                    す。<return>contents.data</return><info>string</info>ペイロード<return>lines</return><info>int</info>The size of the payload in
                    lines.<return>bytes</return><info>int</info>ペイロードのサイズをバイト単位で指定します。<return>md5</return><info>string</info>ペイロードの
                    MD5チェックサム

<comment>Return:</comment>
  <info>string|false</info>  MIME メッセージを文字列として返します。 失敗した場合に <info>false</info> を返します


id: imap_mail_copy
type: function
doc:
<comment>Description:</comment>
  指定されたメッセージをメールボックスにコピーする
  
  <strong>$message_nums</strong> で指定されたメッセージを、 指定したメールボックスにコピーします。

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>          <class>IMAP\Connection</class> クラスのインスタンス。
  <info>string</info>           <strong>$message_nums</strong>  <strong>$message_nums</strong> は、 (RFC2060 に記述されたように) ただのメッセージ番
                                  号ではなく、範囲を示します。
  <info>string</info>           <strong>$mailbox</strong>       メールボックス名。詳細は <strong>imap_open()</strong> を参照ください。
                                  
                                  信頼できないデータをこのパラメータに渡すのであれば、
                                  imap.enable_insecure_rsh
                                  を無効にしておかなければ危険です。
  <info>int</info>              <strong>$flags</strong>         <strong>$flags</strong> はビットマスクであり、以下の組み合わせです。 <info>CP_UID</info> - UIDS
                                  を含む処理の数 <info>CP_MOVE</info> - コピー後にメールボックスからメッセージを
                                  削除する。 このフラグが設定されていると、この関数は
                                  <strong>imap_mail_move()</strong> と同じ振る舞いをします。
                                  
                                  <info>CP_UID</info> - UIDS を含む処理の数
                                  
                                  <info>CP_MOVE</info> - コピー後にメールボックスからメッセージを削除する。 この
                                  フラグが設定されていると、この関数は <strong>imap_mail_move()</strong> と同じ振る舞
                                  いをします。

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

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


id: imap_mail_move
type: function
doc:
<comment>Description:</comment>
  指定されたメッセージをメールボックスに移動する
  
  <strong>$message_nums</strong> で指定されたメッセージを、 指定されたメールボックス <strong>$mbox</strong> に移動します。 実際には
  <strong>$mailbox</strong> にメッセージが コピー され、 オリジナルのメッセージには削除済みのフラグが付く点に注意して
  下さい。 これは、<strong>$mailbox</strong> にあるメッセージには、 新しい UID が割り当てられるということです。

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>          <class>IMAP\Connection</class> クラスのインスタンス。
  <info>string</info>           <strong>$message_nums</strong>  <strong>$message_nums</strong> は、 (RFC2060 に記述されたように) ただのメッセージ番
                                  号ではなく、範囲を示します。
  <info>string</info>           <strong>$mailbox</strong>       メールボックス名。詳細は <strong>imap_open()</strong> を参照ください。
                                  
                                  信頼できないデータをこのパラメータに渡すのであれば、
                                  imap.enable_insecure_rsh
                                  を無効にしておかなければ危険です。
  <info>int</info>              <strong>$flags</strong>         <strong>$flags</strong> はビットマスクであり、ひとつのオプションをとります。 <info>CP_UID</info>
                                  - UIDS を含む処理の数
                                  
                                  <info>CP_UID</info> - UIDS を含む処理の数

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

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


id: imap_mailboxmsginfo
type: function
doc:
<comment>Description:</comment>
  現在のメールボックスに関する情報を得る
  
  サーバーにおける現在のメールボックスのステータスを調べます。この関数は <strong>imap_status()</strong> に似ています
  が、 メールボックス内の全メッセージのサイズを合計します。このため、 実行時間が幾分余計にかかりま
  す。

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>  <class>IMAP\Connection</class> クラスのインスタンス。

<comment>Return:</comment>
  <info>stdClass</info>  以下のプロパティを有するオブジェクトを返します。 Mailbox のプロパティDate最終変更日 (現
            在の日付時刻)DriverドライバMailboxメールボックスの名前Nmsgsメッセージ数Recent最近のメッ
            セージの数Unread未読のメッセージの数Deleted削除されたメッセージの数Sizeメールボックスの
            サイズ


id: imap_mime_header_decode
type: function
doc:
<comment>Description:</comment>
  MIME ヘッダ要素をデコードする
  
  非 ASCII テキストの MIME メッセージヘッダエクステンションをデコードします (RFC2047 を参照くださ
  い)。

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  MIME テキスト。

<comment>Return:</comment>
  <info>array|false</info>  デコードされた要素は、オブジェクトの配列で返されます。 各オブジェクトは、二つのプロパ
               ティ <return>charset</return> と <return>text</return> を有しています。
               
               要素がエンコードされていない場合、言い替えるとプレーンな US-ASCII の場合は この要素の
               <return>charset</return> プロパティは <return>default</return> に設定されます。
               
               この関数は、失敗した時に <info>false</info> を返します。

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


id: imap_msgno
type: function
doc:
<comment>Description:</comment>
  指定した UID のメッセージ番号を返す
  
  指定した <strong>$message_uid</strong> のメッセージ番号を返します。
  
  この関数は、<strong>imap_uid()</strong> の逆の動作となります。

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>         <class>IMAP\Connection</class> クラスのインスタンス。
  <info>int</info>              <strong>$message_uid</strong>  メッセージの UID。

<comment>Return:</comment>
  <info>int</info>  指定した <strong>$message_uid</strong> のメッセージ番号を返します。

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


id: imap_mutf7_to_utf8
type: function
doc:
<comment>Description:</comment>
  修正UTF-7文字列をUTF-8にデコードする
  
  修正UTF-7(RFC 2060, section 5.1.3)文字列を UTF-8 にデコードします。
  
  この関数は libcclient が utf8_to_mutf7() をエクスポートした場合にのみ利用できます。

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  修正UTF-7 でエンコードされた文字列

<comment>Return:</comment>
  <info>string|false</info>  <strong>$string</strong> を UTF-8 に変換したものを返します。 失敗した場合に <info>false</info> を返します.

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


id: imap_num_msg
type: function
doc:
<comment>Description:</comment>
  現在のメールボックスのメッセージ数を取得する
  
  現在のメールボックスにあるメッセージ数を返します。

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>  <class>IMAP\Connection</class> クラスのインスタンス。

<comment>Return:</comment>
  <info>int|false</info>  現在のメールボックスのメッセージ数を整数として返します。 またはエラー時に <info>false</info> を返し
             ます。

<comment>See Also:</comment>
   * <strong>imap_num_recent()</strong>
   * <strong>imap_status()</strong>


id: imap_num_recent
type: function
doc:
<comment>Description:</comment>
  現在のメールボックスにある新規メッセージ数を取得する
  
  現在のメールボックスにある新しいメッセージの数を返します。

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>  <class>IMAP\Connection</class> クラスのインスタンス。

<comment>Return:</comment>
  <info>int</info>  現在のメールボックスにある新しいメッセージの数を返します。

<comment>See Also:</comment>
   * <strong>imap_num_msg()</strong>
   * <strong>imap_status()</strong>


id: imap_open
type: function
doc:
<comment>Description:</comment>
  メールボックスへの IMAP ストリームをオープンする
  
  <strong>$mailbox</strong> への IMAP ストリームをオープンします。
  
  この関数は、POP3 や NNTP サーバーへのストリームをオープンする際にも使用可能です。 しかし、いくつか
  の関数および機能は IMAP サーバーでしか利用できません。

<comment>Param:</comment>
  <info>string</info>  <strong>$mailbox</strong>   メールボックス名(mailbox)は、サーバー名の部分と使用するサーバーにおける メール
                     ボックスへのパスから構成されます。特別な名前 <return>INBOX</return> は、 カレントユーザーの個人
                     メールボックスを意味します。 ASCII 空間で出力可能な文字以外の外国文字を含むメー
                     ルボックス名は <strong>imap_utf7_encode()</strong> でエンコードする必要があります。
                     
                     信頼できないデータをこのパラメータに渡すのであれば、
                     imap.enable_insecure_rsh
                     を無効にしておかなければ危険です。
                     
                     サーバー部は '{' および '}' で括られ、サーバー名または IP アドレス、オプション
                     の ':' から始まるポート指定子、('/' で始まる)オプションのプロトコル指定子 から
                     構成されます。
                     
                     サーバー部は、全ての mailbox パラメータで必須です。
                     
                     <return>{</return> で始まる名前はすべてリモート名で、 <return>"{" remote_system_name [":" port] [flags]
                     "}" [mailbox_name]</return> のような形式となります。 <return>remote_system_name</return> - Internet ドメ
                     イン名 あるいは括弧でかこまれたサーバーの IP アドレス。 <return>port</return> - オプションの TCP
                     ポート番号。デフォルトは そのサービスのデフォルトポート。 <return>flags</return> - オプションの
                     フラグ。以下の表を参照ください。 <return>mailbox_name</return> - リモートメールボックス名。デ
                     フォルトは INBOX 。
                     
                     <return>remote_system_name</return> - Internet ドメイン名 あるいは括弧でかこまれたサーバーの IP
                     アドレス。
                     
                     <return>port</return> - オプションの TCP ポート番号。デフォルトは そのサービスのデフォルトポー
                     ト。
                     
                     <return>flags</return> - オプションのフラグ。以下の表を参照ください。
                     
                     <return>mailbox_name</return> - リモートメールボックス名。デフォルトは INBOX 。
                     
                     オプションのフラグ名フラグ説明<return>/service=</return>serviceメールボックスにアクセスするサー
                     ビス。デフォルトは "imap" 。<return>/user=</return>userサーバーへのログイン時のユーザー名。
                     <return>/authuser=</return>userリモートの認証ユーザー。指定されていた場合は、このユーザーのパス
                     ワードが 認証に使用されます（例: administrator）。<return>/anonymous</return>匿名ユーザーとして
                     アクセスします。<return>/debug</return>プロトコルの通信内容をアプリケーションのデバッグログに記
                     録します。<return>/secure</return>ネットワーク越しにプレーンテキストのパスワードを送信しません。
                     <return>/imap</return>, <return>/imap2</return>, <return>/imap2bis</return>, <return>/imap4</return>, <return>/imap4rev1</return><return>/service=imap</return> と同じです。
                     <return>/pop3</return><return>/service=pop3</return> と同じです。<return>/nntp</return><return>/service=nntp</return> と同じです。<return>/norsh</return>事前に認証
                     済みの IMAP セッションを確立する際に、rsh や ssh を使用しません。<return>/ssl</return>セッション
                     の暗号化に <return>Secure Socket Layer</return> を使用します。<return>/validate-cert</return>TLS/SSL サーバーの証
                     明書を検証します（デフォルトの挙動です）。<return>/novalidate-cert</return>TLS/SSL サーバーの証
                     明書を検証しません。サーバーが自己証明の 証明書を使用している際に必要となりま
                     す。<return>/tls</return>セッションの暗号化に <return>start-TLS</return> の使用を強制し、それを サポートしていな
                     いサーバーとの接続を拒否します。<return>/notls</return>たとえサーバーがそれをサポートしていたと
                     しても、 セッションで <return>start-TLS</return> による暗号化を使用しません。<return>/readonly</return>読み込み専
                     用でのメールボックスのオープンを要求します（IMAP のみ。 NNTP では無視され、SMTP
                     および POP3 ではエラーとなります）。
  <info>string</info>  <strong>$user</strong>      ユーザー名。
  <info>string</info>  <strong>$password</strong>  <strong>$user</strong> のパスワード。
  <info>int</info>     <strong>$flags</strong>     <strong>$flags</strong> はビットマスクであり、以下の組み合わせとなります。 <info>OP_READONLY</info> - メール
                     ボックスを読み込み専用でオープンします。 <info>OP_ANONYMOUS</info> - news に関して .newsrc
                     を使用せず、更新もしません（NNTP のみ）。 <info>OP_HALFOPEN</info> - IMAP 及び NNTP 名につい
                     て、 接続をオープンしますがメールボックスはオープンしません。 <info>CL_EXPUNGE</info> - メー
                     ルボックスを閉じる際に、 自動的にメールボックスを削除します（<strong>imap_delete()</strong> およ
                     び <strong>imap_expunge()</strong> も参照ください）。 <info>OP_DEBUG</info> - プロトコルネゴシエーションをデ
                     バッグします。 <info>OP_SHORTCACHE</info> - 短い（<return>elt</return>-only）キャッシングを行います。
                     <info>OP_SILENT</info> - イベントを受信しません（内部で使用します）。 <info>OP_PROTOTYPE</info> - ドライ
                     バのプロトタイプを返します。 <info>OP_SECURE</info> - セキュアでない認証を行いません。
                     
                     <info>OP_READONLY</info> - メールボックスを読み込み専用でオープンします。
                     
                     <info>OP_ANONYMOUS</info> - news に関して .newsrc を使用せず、更新もしません（NNTP のみ）。
                     
                     <info>OP_HALFOPEN</info> - IMAP 及び NNTP 名について、 接続をオープンしますがメールボックス
                     はオープンしません。
                     
                     <info>CL_EXPUNGE</info> - メールボックスを閉じる際に、 自動的にメールボックスを削除します
                     （<strong>imap_delete()</strong> および <strong>imap_expunge()</strong> も参照ください）。
                     
                     <info>OP_DEBUG</info> - プロトコルネゴシエーションをデバッグします。
                     
                     <info>OP_SHORTCACHE</info> - 短い（<return>elt</return>-only）キャッシングを行います。
                     
                     <info>OP_SILENT</info> - イベントを受信しません（内部で使用します）。
                     
                     <info>OP_PROTOTYPE</info> - ドライバのプロトタイプを返します。
                     
                     <info>OP_SECURE</info> - セキュアでない認証を行いません。
  <info>int</info>     <strong>$retries</strong>   接続試行の最大数。
  <info>array</info>   <strong>$options</strong>   接続パラメータ。次の (文字列の) キーを使って接続パラメータを設定することができ
                     ます。 <return>DISABLE_AUTHENTICATOR</return> - 認証プロパティを無効にする
                     
                     <return>DISABLE_AUTHENTICATOR</return> - 認証プロパティを無効にする

<comment>Return:</comment>
  <info>IMAP\Connection|false</info>  成功した場合は、 <class>IMAP\Connection</class> クラスのインスタンスを返します。 失敗した
                         場合に <info>false</info> を返します.

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


id: imap_ping
type: function
doc:
<comment>Description:</comment>
  IMAP ストリームがアクティブかどうかを調べる
  
  <strong>imap_ping()</strong> はストリームに ping を行い、 まだアクティブであるかどうかを調べます。これにより新しい
  メールの到着を知ることもあります。 これは、定期的に「メールのチェック」を行い、サーバーとの 「接続
  を保持し続ける」ためのお勧めの方法です。

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>  <class>IMAP\Connection</class> クラスのインスタンス。

<comment>Return:</comment>
  <info>bool</info>  ストリームがまだ有効であれば <info>true</info> を、そうでなければ <info>false</info> を返します。


id: imap_qprint
type: function
doc:
<comment>Description:</comment>
  quoted-printable 文字列を 8 ビット文字列に変換する
  
  （RFC2045, section 6.7 に基づき）quoted-printable 文字列を 8 ビット文字列に変換します。

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  quoted-printable 文字列。

<comment>Return:</comment>
  <info>string|false</info>  8 ビット文字列を返します。 失敗した場合に <info>false</info> を返します

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


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


id: imap_renamemailbox
type: function
doc:
<comment>Description:</comment>
  メールボックスの名前を変更する
  
  この関数は、古いメールボックスを新しいメールボックスにリネーム します（<strong>$mbox</strong> 名のフォーマットにつ
  いては <strong>imap_open()</strong> を参照ください）。

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>  <class>IMAP\Connection</class> クラスのインスタンス。
  <info>string</info>           <strong>$from</strong>  古いメールボックス名。詳細は <strong>imap_open()</strong> を参照ください。
                          
                          信頼できないデータをこのパラメータに渡すのであれば、
                          imap.enable_insecure_rsh
                          を無効にしておかなければ危険です。
  <info>string</info>           <strong>$to</strong>    新しいメールボックス名。詳細は <strong>imap_open()</strong> を参照ください。
                          
                          信頼できないデータをこのパラメータに渡すのであれば、
                          imap.enable_insecure_rsh
                          を無効にしておかなければ危険です。

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

<comment>See Also:</comment>
   * <strong>imap_createmailbox()</strong>
   * <strong>imap_deletemailbox()</strong>


id: imap_reopen
type: function
doc:
<comment>Description:</comment>
  新規メールボックスへの IMAP ストリームを再度オープンする
  
  IMAP または NNTP サーバー上の新しい <strong>$mailbox</strong> に対して指定されたストリームを再オープンします。

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>     <class>IMAP\Connection</class> クラスのインスタンス。
  <info>string</info>           <strong>$mailbox</strong>  メールボックス名。詳細は <strong>imap_open()</strong> を参照ください。
                             
                             信頼できないデータをこのパラメータに渡すのであれば、
                             imap.enable_insecure_rsh
                             を無効にしておかなければ危険です。
  <info>int</info>              <strong>$flags</strong>    <strong>$flags</strong> はビットマスクであり、以下の組み合わせとなります。 <info>OP_READONLY</info> -
                             メールボックスを読み込み専用でオープンします。 <info>OP_ANONYMOUS</info> - ニュース
                             に関して .newsrc を使用せず、更新もしません（NNTP のみ）。 <info>OP_HALFOPEN</info>
                             - IMAP および NNTP 名について、接続をオープンするがメールボックスをオー
                             プンしません。 <info>OP_EXPUNGE</info> - 何も警告せずにリサイクルストリームを削除し
                             ます。 <info>CL_EXPUNGE</info> - メールボックスを閉じた際に、自動的に メールボックス
                             を削除する（<strong>imap_delete()</strong> および <strong>imap_expunge()</strong> も参照ください）。
                             
                             <info>OP_READONLY</info> - メールボックスを読み込み専用でオープンします。
                             
                             <info>OP_ANONYMOUS</info> - ニュースに関して .newsrc を使用せず、更新もしません
                             （NNTP のみ）。
                             
                             <info>OP_HALFOPEN</info> - IMAP および NNTP 名について、接続をオープンするがメール
                             ボックスをオープンしません。
                             
                             <info>OP_EXPUNGE</info> - 何も警告せずにリサイクルストリームを削除します。
                             
                             <info>CL_EXPUNGE</info> - メールボックスを閉じた際に、自動的に メールボックスを削除
                             する（<strong>imap_delete()</strong> および <strong>imap_expunge()</strong> も参照ください）。
  <info>int</info>              <strong>$retries</strong>  接続試行の最大数。

<comment>Return:</comment>
  <info>bool</info>  ストリームを再度オープンした場合に <info>true</info>、 それ以外の場合に <info>false</info> を返します。


id: imap_rfc822_parse_adrlist
type: function
doc:
<comment>Description:</comment>
  アドレス文字列を解釈します
  
  RFC2822 の定義に基づき、アドレス文字列をパースします。

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>            アドレスを含む文字列。
  <info>string</info>  <strong>$default_hostname</strong>  デフォルトのホスト名。

<comment>Return:</comment>
  <info>array</info>  オブジェクトの配列を返します。オブジェクトのプロパティは以下のとおりです。
         
          mailbox  - メールボックス名（ユーザー名）。  host - ホスト名。  personal - 個人名。  adl -
         ドメインソースルート。
         
         mailbox  - メールボックス名（ユーザー名）。
         
         host - ホスト名。
         
         personal - 個人名。
         
         adl - ドメインソースルート。

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


id: imap_rfc822_parse_headers
type: function
doc:
<comment>Description:</comment>
  文字列からメールヘッダを解釈する
  
  複数のヘッダ要素を含むオブジェクトを取得します。 <strong>imap_header()</strong> と同じようなものです。

<comment>Param:</comment>
  <info>string</info>  <strong>$headers</strong>           パースされたヘッダデータ。
  <info>string</info>  <strong>$default_hostname</strong>  デフォルトのホスト名。

<comment>Return:</comment>
  <info>stdClass</info>  <strong>imap_header()</strong> が返すオブジェクトと似たものを返します。 フラグおよび他の要素は IMAP サー
            バーから取得するいう点が異なります。

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


id: imap_rfc822_write_address
type: function
doc:
<comment>Description:</comment>
  指定したメールボックス、ホスト、個人情報を、
     電子メールアドレスとして適当な形式にして返す
    
  
  指定された情報を RFC822 の定義に基づき 適切にフォーマットされた電子メールアドレスにして返します。

<comment>Param:</comment>
  <info>string</info>  <strong>$mailbox</strong>   メールボックス名。詳細は <strong>imap_open()</strong> を参照ください。
                     
                     信頼できないデータをこのパラメータに渡すのであれば、
                     imap.enable_insecure_rsh
                     を無効にしておかなければ危険です。
  <info>string</info>  <strong>$hostname</strong>  email のホスト部分。
  <info>string</info>  <strong>$personal</strong>  アカウント所有者の名前。

<comment>Return:</comment>
  <info>string|false</info>  RFC822 の定義に基づき 適切にフォーマットされた電子メールアドレスを返します。 失敗し
                た場合に <info>false</info> を返します


id: imap_savebody
type: function
doc:
<comment>Description:</comment>
  指定した本文部をファイルに保存する
  
  指定したメッセージの本文全体、あるいはその一部を保存します。

<comment>Param:</comment>
  <info>IMAP\Connection</info>      <strong>$imap</strong>         <class>IMAP\Connection</class> クラスのインスタンス。
  <info>resource|string|int</info>  <strong>$file</strong>         保存先ファイルへのパスを表す文字列、あるいは <strong>fopen()</strong> が返すファ
                                     イル記述子。
  <info>int</info>                  <strong>$message_num</strong>  メッセージ番号。
  <info>string</info>               <strong>$section</strong>      パート番号。ピリオドで区切られた整数文字列を指定します。 これ
                                     は、IMAP4 仕様における本文パートのリストへのインデックスとなり
                                     ます。
  <info>int</info>                  <strong>$flags</strong>        ビットマスクであり、以下の組合わせとなります。 <info>FT_UID</info> -
                                     <strong>$message_num</strong>は UID である <info>FT_PEEK</info> - 既に設定されていない場合、
                                     \Seen フラグを設定しない <info>FT_INTERNAL</info> - 内部フォーマットで文字列
                                     を返す。CRLF に正規化しない。
                                     
                                     <info>FT_UID</info> - <strong>$message_num</strong>は UID である
                                     
                                     <info>FT_PEEK</info> - 既に設定されていない場合、 \Seen フラグを設定しない
                                     
                                     <info>FT_INTERNAL</info> - 内部フォーマットで文字列を返す。CRLF に正規化しな
                                     い。

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

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


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


id: imap_search
type: function
doc:
<comment>Description:</comment>
  指定した検索条件にマッチするメッセージを配列として返す
  
  この関数は、指定した IMAP ストリームの現在オープンしているメールボックス において検索を行います。
  
  例えば、Mom から送られた全ての未回答のメッセージにマッチさせるには、 "UNANSWERED FROM mom" を使用
  します。 検索は、大文字小文字が区別されずに行われます。 検索条件のリストは、UW c-client のソース
  コードからのものであり、 不完全または不正確である可能性があります (RFC1176 の "tag SEARCH
  search_criteria" も参照ください)。

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>      <class>IMAP\Connection</class> クラスのインスタンス。
  <info>string</info>           <strong>$criteria</strong>  空白で区切られた文字列で、以下のキーワードが使用可能です。 複数の単語
                              からなるキーワード（例 <return>FROM "joey smith"</return>） は全て引用符で括る必要があ
                              ります。 結果は、すべての <strong>$criteria</strong> エントリにマッチすることになりま
                              す。  ALL - 他の検索条件にマッチする全メッセージを返す  ANSWERED -
                              \\ANSWERED フラグが設定されているメッセージにマッチ  BCC "string" -
                              Bcc: フィールドに "string" を有するメッセージにマッチ  BEFORE "date" -
                              "date" より前の Date: を有するメッセージにマッチ  BODY "string" - メッ
                              セージ本体に "string" を有するメッセージにマッチ  CC "string" - Cc:
                              フィールドに "string" を有するメッセージにマッチ  DELETED - 削除された
                              メッセージにマッチ  FLAGGED - \\FLAGGED フラグ（重要または緊急を表すも
                              のとして 使用されることがあります）が設定されているメッセージにマッチ
                              FROM "string" - From: フィールドに "string" を有するメッセージにマッチ
                              KEYWORD "string" - キーワードとして "string" を有するメッセージにマッ
                              チ  NEW - 新規メッセージにマッチ  OLD - 古いメッセージにマッチ  ON
                              "date" - Date: が "date" であるメッセージにマッチ  RECENT - \\RECENT
                              フラグが設定されているメッセージにマッチ  SEEN - 既読の（\\SEEN フラグ
                              が設定されている）メッセージにマッチ  SINCE "date" - Date: が "date"
                              以降であるメッセージにマッチ  SUBJECT "string" - Subject: に "string"
                              を有するメッセージにマッチ  TEXT "string" - テキスト "string" を有する
                              メッセージにマッチ  TO "string" - To: に "string" を有するメッセージに
                              マッチ  UNANSWERED - 未回答のメッセージにマッチ  UNDELETED - 削除され
                              ていないメッセージにマッチ  UNFLAGGED - フラグが設定されていないメッ
                              セージにマッチ  UNKEYWORD "string" - キーワード "string" を有さない
                              メッセージにマッチ  UNSEEN - 未読のメッセージにマッチ
                              
                              ALL - 他の検索条件にマッチする全メッセージを返す
                              
                              ANSWERED - \\ANSWERED フラグが設定されているメッセージにマッチ
                              
                              BCC "string" - Bcc: フィールドに "string" を有するメッセージにマッチ
                              
                              BEFORE "date" - "date" より前の Date: を有するメッセージにマッチ
                              
                              BODY "string" - メッセージ本体に "string" を有するメッセージにマッチ
                              
                              CC "string" - Cc: フィールドに "string" を有するメッセージにマッチ
                              
                              DELETED - 削除されたメッセージにマッチ
                              
                              FLAGGED - \\FLAGGED フラグ（重要または緊急を表すものとして 使用される
                              ことがあります）が設定されているメッセージにマッチ
                              
                              FROM "string" - From: フィールドに "string" を有するメッセージにマッチ
                              
                              KEYWORD "string" - キーワードとして "string" を有するメッセージにマッ
                              チ
                              
                              NEW - 新規メッセージにマッチ
                              
                              OLD - 古いメッセージにマッチ
                              
                              ON "date" - Date: が "date" であるメッセージにマッチ
                              
                              RECENT - \\RECENT フラグが設定されているメッセージにマッチ
                              
                              SEEN - 既読の（\\SEEN フラグが設定されている）メッセージにマッチ
                              
                              SINCE "date" - Date: が "date" 以降であるメッセージにマッチ
                              
                              SUBJECT "string" - Subject: に "string" を有するメッセージにマッチ
                              
                              TEXT "string" - テキスト "string" を有するメッセージにマッチ
                              
                              TO "string" - To: に "string" を有するメッセージにマッチ
                              
                              UNANSWERED - 未回答のメッセージにマッチ
                              
                              UNDELETED - 削除されていないメッセージにマッチ
                              
                              UNFLAGGED - フラグが設定されていないメッセージにマッチ
                              
                              UNKEYWORD "string" - キーワード "string" を有さないメッセージにマッチ
                              
                              UNSEEN - 未読のメッセージにマッチ
  <info>int</info>              <strong>$flags</strong>     <strong>$flags</strong> に指定できる値は <info>SE_UID</info> です。これを指定すると、 メッセージ番号
                              ではなく UID を含む配列を返します。
  <info>string</info>           <strong>$charset</strong>   文字列の検索の際に使う MIME 文字セット。

<comment>Return:</comment>
  <info>array|false</info>  メッセージ番号あるいは UID の配列を返します。
               
               検索条件 <strong>$criteria</strong> を処理できなかった場合や 結果が見つからなかった場合は、<info>false</info> を返
               します。

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


id: imap_set_quota
type: function
doc:
<comment>Description:</comment>
  指定したメールボックスにクォータを設定する
  
  メールボックス単位でクォータ上限(最大容量)を設定します。

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>          <class>IMAP\Connection</class> クラスのインスタンス。
  <info>string</info>           <strong>$quota_root</strong>    クォータを設定するメールボックス。 これは、メールボックスの IMAP
                                  標準フォーマット 'user.name' に基づき指定する必要があります。
  <info>int</info>              <strong>$mailbox_size</strong>  <strong>$quota_root</strong> の最大サイズ (KB 単位)。

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

<comment>See Also:</comment>
   * <strong>imap_open()</strong>
   * <strong>imap_get_quota()</strong>


id: imap_setacl
type: function
doc:
<comment>Description:</comment>
  指定したメールボックスの ACL を設定する
  
  指定したメールボックスの ACL を設定します。

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>     <class>IMAP\Connection</class> クラスのインスタンス。
  <info>string</info>           <strong>$mailbox</strong>  メールボックス名。詳細は <strong>imap_open()</strong> を参照ください。
                             
                             信頼できないデータをこのパラメータに渡すのであれば、
                             imap.enable_insecure_rsh
                             を無効にしておかなければ危険です。
  <info>string</info>           <strong>$user_id</strong>  権限を付与するユーザー。
  <info>string</info>           <strong>$rights</strong>   そのユーザーに付与する権限。空文字列を渡すと、acl を削除します。

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

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


id: imap_setflag_full
type: function
doc:
<comment>Description:</comment>
  メッセージにフラグをセットする
  
  この関数は、指定した <strong>$sequence</strong> のメッセージの フラグに指定した <strong>$flag</strong> を設定し、保存します。

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>      <class>IMAP\Connection</class> クラスのインスタンス。
  <info>string</info>           <strong>$sequence</strong>  メッセージ番号のシーケンス。 <return>X,Y</return> 形式でメッセージを列挙したり、 <return>X:Y</return> 形
                              式で範囲内のすべてのメッセージを指定したりすることができます。
  <info>string</info>           <strong>$flag</strong>      設定可能なフラグは、(RFC2060 で定義された) <return>\Seen</return>、 <return>\Answered</return>、
                              <return>\Flagged</return>、 <return>\Deleted</return> および <return>\Draft</return> です。
  <info>int</info>              <strong>$options</strong>   <strong>$options</strong> はビットマスクであり、以下の組み合わせとなります。 <info>ST_UID</info> -
                              シーケンス引数はシーケンス番号の代わりに UID を含みます。
                              
                              <info>ST_UID</info> - シーケンス引数はシーケンス番号の代わりに UID を含みます。

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

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


id: imap_sort
type: function
doc:
<comment>Description:</comment>
  メッセージヘッダの配列をソートする
  
  指定したパラメータにより取得したメッセージ番号をソートします。

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>             <class>IMAP\Connection</class> クラスのインスタンス。
  <info>int</info>              <strong>$criteria</strong>         criteria は、次のどれかとします (ひとつのみ)。 <info>SORTDATE</info> - メッ
                                     セージの日付 <info>SORTARRIVAL</info> - 到着日付 <info>SORTFROM</info> - 最初の From アド
                                     レスのメールボックス <info>SORTSUBJECT</info> - メッセージ Subject <info>SORTTO</info> -
                                     最初の To アドレスのメールボックス <info>SORTCC</info> - 最初の cc アドレス
                                     のメールボックス <info>SORTSIZE</info> - メッセージのサイズ（バイト単位）
                                     
                                     <info>SORTDATE</info> - メッセージの日付
                                     
                                     <info>SORTARRIVAL</info> - 到着日付
                                     
                                     <info>SORTFROM</info> - 最初の From アドレスのメールボックス
                                     
                                     <info>SORTSUBJECT</info> - メッセージ Subject
                                     
                                     <info>SORTTO</info> - 最初の To アドレスのメールボックス
                                     
                                     <info>SORTCC</info> - 最初の cc アドレスのメールボックス
                                     
                                     <info>SORTSIZE</info> - メッセージのサイズ（バイト単位）
  <info>bool</info>             <strong>$reverse</strong>          逆順にソートするかどうかを指定します。
  <info>int</info>              <strong>$flags</strong>            <strong>$flags</strong> はビットマスクで、以下の組み合わせとなります。 <info>SE_UID</info> -
                                     シーケンス番号の代わりに UID を返す <info>SE_NOPREFETCH</info> - 検索した
                                     メッセージを事前取得しない
                                     
                                     <info>SE_UID</info> - シーケンス番号の代わりに UID を返す
                                     
                                     <info>SE_NOPREFETCH</info> - 検索したメッセージを事前取得しない
  <info>string|null</info>      <strong>$search_criteria</strong>  IMAP2 フォーマットの検索条件文字列。詳細は <strong>imap_search()</strong> を参照
                                     ください。
  <info>string|null</info>      <strong>$charset</strong>          文字列の検索の際に使う MIME 文字セット。

<comment>Return:</comment>
  <info>array|false</info>  指定したパラメータでソートしたメッセージ番号の配列を返します。 失敗した場合に <info>false</info>
               を返します


id: imap_status
type: function
doc:
<comment>Description:</comment>
  現在のメールボックス以外のメールボックスのステータス情報を返す
  
  指定したメールボックス <strong>$mailbox</strong> についてのステータス情報を取得します。

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>     <class>IMAP\Connection</class> クラスのインスタンス。
  <info>string</info>           <strong>$mailbox</strong>  メールボックス名。詳細は <strong>imap_open()</strong> を参照ください。
                             
                             信頼できないデータをこのパラメータに渡すのであれば、
                             imap.enable_insecure_rsh
                             を無効にしておかなければ危険です。
  <info>int</info>              <strong>$flags</strong>    以下のフラグが使用できます。 <info>SA_MESSAGES</info> - $status-&gt;messages にメー
                             ルボックスのメッセージ数を設定する <info>SA_RECENT</info> - $status-&gt;recent に
                             メールボックスの最近のメッセージ数を設定する <info>SA_UNSEEN</info> -
                             $status-&gt;unseen にメールボックスの未読の(新規)メッセージ数を設定する
                             <info>SA_UIDNEXT</info> - $status-&gt;uidnext にメールボックスの次の UID を設定する
                             <info>SA_UIDVALIDITY</info> - メールボックスの UID がもはや有効ではない場合に変化す
                             る定数を $status-&gt;uidvalidity に設定する <info>SA_ALL</info> - 上記のものをすべて
                             設定する
                             
                             <info>SA_MESSAGES</info> - $status-&gt;messages にメールボックスのメッセージ数を設定
                             する
                             
                             <info>SA_RECENT</info> - $status-&gt;recent にメールボックスの最近のメッセージ数を設
                             定する
                             
                             <info>SA_UNSEEN</info> - $status-&gt;unseen にメールボックスの未読の(新規)メッセージ
                             数を設定する
                             
                             <info>SA_UIDNEXT</info> - $status-&gt;uidnext にメールボックスの次の UID を設定する
                             
                             <info>SA_UIDVALIDITY</info> - メールボックスの UID がもはや有効ではない場合に変化す
                             る定数を $status-&gt;uidvalidity に設定する
                             
                             <info>SA_ALL</info> - 上記のものをすべて設定する

<comment>Return:</comment>
  <info>stdClass|false</info>  この関数は、ステータス情報を含むオブジェクトを返します。 失敗した場合に <info>false</info> を返
                  します。 このオブジェクトには <return>messages</return>、 <return>recent</return>、<return>unseen</return>、 <return>uidnext</return> および
                  <return>uidvalidity</return> というプロパティが含まれます。
                  
                  <return>flags</return> にも、 上の各定数に対応するビットマスクを設定することができます。


id: imap_subscribe
type: function
doc:
<comment>Description:</comment>
  メールボックスを購読する
  
  新規メールボックスを購読します。

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>     <class>IMAP\Connection</class> クラスのインスタンス。
  <info>string</info>           <strong>$mailbox</strong>  メールボックス名。詳細は <strong>imap_open()</strong> を参照ください。
                             
                             信頼できないデータをこのパラメータに渡すのであれば、
                             imap.enable_insecure_rsh
                             を無効にしておかなければ危険です。

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

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


id: imap_thread
type: function
doc:
<comment>Description:</comment>
  スレッド化したメッセージのツリーを返す
  
  スレッド化されたメッセージのツリーを取得します。

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>   <class>IMAP\Connection</class> クラスのインスタンス。
  <info>int</info>              <strong>$flags</strong>  

<comment>Return:</comment>
  <info>array|false</info>  <strong>imap_thread()</strong> は、<return>REFERENCES</return> でスレッド化したメッセージのツリーを含む連想配列を返しま
               す。 エラー時には <info>false</info> を返します。
               
               現在のメールボックス内のすべてのメッセージが、結果の配列の 3 つの エントリで表されま
               す。 $thread["XX.num"] - 現在のメッセージ番号。
               $thread["XX.next"]$thread["XX.branch"]
               
               $thread["XX.num"] - 現在のメッセージ番号。
               
               $thread["XX.next"]
               
               $thread["XX.branch"]


id: imap_timeout
type: function
doc:
<comment>Description:</comment>
  imap タイムアウトを設定あるいは取得する
  
  imap タイムアウトを設定あるいは取得します。

<comment>Param:</comment>
  <info>int</info>  <strong>$timeout_type</strong>  <info>IMAP_OPENTIMEOUT</info>、 <info>IMAP_READTIMEOUT</info>、 <info>IMAP_WRITETIMEOUT</info> あるいは
                      <info>IMAP_CLOSETIMEOUT</info> のいずれか。
  <info>int</info>  <strong>$timeout</strong>       タイムアウト秒数。

<comment>Return:</comment>
  <info>int|bool</info>  <strong>$timeout</strong> が設定されている場合は、 この関数は成功した場合に <info>true</info>、失敗した場合に <info>false</info> を
            返します。
            
            <strong>$timeout</strong> が省略されていたり、-1 と評価される値が設定されている場合は、 現在のタイムアウ
            ト値 <strong>$timeout_type</strong> を整数で返します。


id: imap_uid
type: function
doc:
<comment>Description:</comment>
  指定したメッセージシーケンス番号の UID を返す
  
  この関数は、指定したメッセージシーケンス番号の UID を返します。 メッセージ番号はメールボックスの内
  容を変更する度に変わる可能性が ありますが、UID はユニークな ID であり時間が経過しても変わりませ
  ん。
  
  この関数は、<strong>imap_msgno()</strong> の逆関数です。

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>         <class>IMAP\Connection</class> クラスのインスタンス。
  <info>int</info>              <strong>$message_num</strong>  メッセージ番号。

<comment>Return:</comment>
  <info>int|false</info>  指定したメッセージの UID を返します。

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


id: imap_undelete
type: function
doc:
<comment>Description:</comment>
  削除マークがついているメッセージのマークをはずす
  
  指定したメッセージについて、 <strong>imap_delete()</strong> または <strong>imap_mail_move()</strong> で設定された削除フラグをはずし
  ます。

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>          <class>IMAP\Connection</class> クラスのインスタンス。
  <info>string</info>           <strong>$message_nums</strong>  IMAP4 形式のシーケンスフォーマット (<return>"n"</return>, <return>"n:m"</return>, またはそれらをカン
                                  マで区切ったもの) で表現された、ひとつ以上のメッセージを表す文字
                                  列。
  <info>int</info>              <strong>$flags</strong>         

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

<comment>See Also:</comment>
   * <strong>imap_delete()</strong>
   * <strong>imap_mail_move()</strong>


id: imap_unsubscribe
type: function
doc:
<comment>Description:</comment>
  メールボックスの購読をやめる
  
  指定されたメールボックス <strong>$mailbox</strong> の購読を中止します。

<comment>Param:</comment>
  <info>IMAP\Connection</info>  <strong>$imap</strong>     <class>IMAP\Connection</class> クラスのインスタンス。
  <info>string</info>           <strong>$mailbox</strong>  メールボックス名。詳細は <strong>imap_open()</strong> を参照ください。
                             
                             信頼できないデータをこのパラメータに渡すのであれば、
                             imap.enable_insecure_rsh
                             を無効にしておかなければ危険です。

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

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


id: imap_utf7_decode
type: function
doc:
<comment>Description:</comment>
  修正版 UTF-7 エンコードされた文字列をデコードする
  
  修正版 UTF-7 の <strong>$string</strong> を ISO-8859-1 文字列に デコードします。
  
  この関数は、ある種の非 ASCII 文字を含むメールボックス名をデコードする際に 必要となります。

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  修正版 UTF-7 エンコーディングの文字列。このエンコーディングについては RFC 2060,
                   section 5.1.3 で定義されています。

<comment>Return:</comment>
  <info>string|false</info>  <strong>$string</strong> と同じ内容の文字を ISO-8859-1 でエンコード した文字列を返します。<strong>$string</strong> に
                修正版 UTF-7 として 不正な文字が含まれていた場合、あるいは <strong>$string</strong> に ISO-8859-1 文
                字セットの範囲外の文字が含まれていた場合には <info>false</info> を返します。

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


id: imap_utf7_encode
type: function
doc:
<comment>Description:</comment>
  ISO-8859-1 文字列を修正版 UTF-7 テキストに変換する
  
  <strong>$string</strong> を修正版 UTF-7 テキストに変換します。
  
  この関数は、ある種の非 ASCII 文字を含むメールボックス名をエンコード する際に必要となります。

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

<comment>Return:</comment>
  <info>string</info>  <strong>$string</strong> を修正版 UTF-7 でエンコードした文字列を返します。 このエンコーディングについては
          RFC 2060, section 5.1.3 で定義されています。

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


id: imap_utf8
type: function
doc:
<comment>Description:</comment>
  MIME エンコードされたテキストを UTF-8 に変換する
  
  宣言されている文字セットを libc-client が知っている場合は、 指定した <strong>$mime_encoded_text</strong> を UTF-8
  に変換します。 知らない場合は、指定されたテキストはデコードされますが、UTF-8 には変換されません。

<comment>Param:</comment>
  <info>string</info>  <strong>$mime_encoded_text</strong>  MIME エンコードされた文字列。 MIME エンコーディング方法および UTF-8 の
                              仕様については、それぞれ RFC2047 および RFC2044 を参照ください。

<comment>Return:</comment>
  <info>string</info>  デコードされた文字列。可能な場合は UTF-8 に変換されます。

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


id: imap_utf8_to_mutf7
type: function
doc:
<comment>Description:</comment>
  UTF-8 文字列を修正UTF-7にエンコードする
  
  UTF-8 文字列を、修正UTF-7(RFC 2060, section 5.1.3)にエンコードします。
  
  この関数は libcclient が utf8_to_mutf7() をエクスポートした場合にのみ利用できます。

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

<comment>Return:</comment>
  <info>string|false</info>  <strong>$string</strong> を修正UTF-7に変換したものを返します。 失敗した場合に <info>false</info> を返します.

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


id: implode
type: function
doc:
<comment>Description:</comment>
  配列要素を文字列により連結する
  
  代替のシグネチャ(名前付き引数をサポートしていません):
  
  古いシグネチャ(PHP 7.4.0 で非推奨となり、PHP 8.0.0 以降は削除されています):
  
  配列の要素を <strong>$separator</strong> 文字列で連結します。

<comment>Param:</comment>
  <info>string</info>  <strong>$separator</strong>  オプションです。 デフォルトは空文字列です。
  <info>array</info>   <strong>$array</strong>      連結したい文字列の配列。

<comment>Return:</comment>
  <info>string</info>  すべての配列要素の順序を変えずに、各要素間に <strong>$separator</strong> 文字列をはさんで 1 つの文字列にし
          て返します。

<comment>See Also:</comment>
   * <strong>explode()</strong>
   * <strong>preg_split()</strong>
   * <strong>http_build_query()</strong>


id: in_array
type: function
doc:
<comment>Description:</comment>
  配列に値があるかチェックする
  
  <strong>$haystack</strong> 内の <strong>$needle</strong> を検索します。 <strong>$strict</strong> が設定されていない限りは型の比較は行いません。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$needle</strong>    探す値。
                    
                    <strong>$needle</strong> が文字列の場合、 比較の際に大文字小文字は区別されます。
  <info>array</info>  <strong>$haystack</strong>  配列。
  <info>bool</info>   <strong>$strict</strong>    三番目のパラメータ <strong>$strict</strong> が <info>true</info> に設定された場合、 <strong>in_array()</strong> は、<strong>$haystack</strong>
                    の中の <strong>$needle</strong> の 型も確認します。
                    
                    PHP 8.0.0 より前のバージョンでは、 strict フラグが指定されていない場合に、 配列
                    の値が <return>0</return> の場合でも文字列にマッチしてしまっていました。逆も同じです。 これによ
                    り、望ましくない結果が生じる可能性があります。 似たようなエッジケースは他の型で
                    も存在します。 値の型が完全にわからない場合には、 予期せぬ振る舞いを避けるために
                    常に <strong>$strict</strong> フラグを使うようにして下さい。

<comment>Return:</comment>
  <info>bool</info>  配列で <strong>$needle</strong> が見つかった場合に <info>true</info>、それ以外の場合は、<info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>array_search()</strong>
   * <strong>isset()</strong>
   * <strong>array_key_exists()</strong>


id: inet_ntop
type: function
doc:
<comment>Description:</comment>
  パックされたインターネットアドレスを、人間が読める形式に変換する
  
  この関数は 32 ビット IPv4 形式あるいは 128 ビット IPv6 形式 (PHP が IPv6 サポートを有効にしてビル
  ドされている場合) のアドレスを文字列表現のアドレスに変換します。

<comment>Param:</comment>
  <info>string</info>  <strong>$ip</strong>  32 ビット IPv4、あるいは 128b ビット IPv6 形式のアドレス。

<comment>Return:</comment>
  <info>string|false</info>  アドレスを文字列で表したものを返します。失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>long2ip()</strong>
   * <strong>ip2long()</strong>
   * <strong>inet_pton()</strong>


id: inet_pton
type: function
doc:
<comment>Description:</comment>
  人間が読める形式の IP アドレスを、パックされた in_addr 形式に変換する
  
  この関数は、人間が読める形式の IPv4 あるいは IPv6 (PHP が IPv6 サポートを有効にしてビルドされてい
  る場合) のアドレスを 32 ビットあるいは 128 ビットのバイナリ形式に変換します。

<comment>Param:</comment>
  <info>string</info>  <strong>$ip</strong>  可読形式の IPv4 アドレスあるいは IPv6 アドレス。

<comment>Return:</comment>
  <info>string|false</info>  指定した <strong>$ip</strong> を <return>in_addr</return> 形式で表したものを返します。 構文的に無効な <strong>$ip</strong> (ドットのな
                い IPv4 アドレスやコロンのない IPv6 アドレスなど) を指定した場合は <info>false</info> を返しま
                す。

<comment>See Also:</comment>
   * <strong>ip2long()</strong>
   * <strong>long2ip()</strong>
   * <strong>inet_ntop()</strong>


id: inflate_add
type: function
doc:
<comment>Description:</comment>
  インクリメンタルにエンコードされたデータを解凍する
  
  指定された <strong>$context</strong> でエンコードされたデータをインクリメンタルに解凍します。
  
  制限: GZIP 圧縮されたデータからは、ヘッダ情報は利用できません。

<comment>Param:</comment>
  <info>InflateContext</info>  <strong>$context</strong>     <strong>inflate_init()</strong> で作られたコンテクスト
  <info>string</info>          <strong>$data</strong>        圧縮されたデータのチャンク
  <info>int</info>             <strong>$flush_mode</strong>  <info>ZLIB_BLOCK</info>, <info>ZLIB_NO_FLUSH</info>, <info>ZLIB_PARTIAL_FLUSH</info>, <info>ZLIB_SYNC_FLUSH</info> (デ
                               フォルト), <info>ZLIB_FULL_FLUSH</info>, <info>ZLIB_FINISH</info> のいずれか。 通常は、圧縮率を
                               最大にするために、 <info>ZLIB_NO_FLUSH</info> を指定するでしょうし、 データの最後
                               のチャンクで終了させるために <info>ZLIB_FINISH</info> を指定するでしょう。 これら
                               の定数の詳細な説明は zlib manual を参照ください。

<comment>Return:</comment>
  <info>string|false</info>  解凍されたデータのチャンクを返します。 失敗した場合に <info>false</info> を返します

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


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

<comment>Param:</comment>
  <info>InflateContext</info>  <strong>$context</strong>  

<comment>Return:</comment>
  <info>int</info>  これまでに読み取ったバイト数を返します。 失敗した場合に <info>false</info> を返します


id: inflate_get_status
type: function
doc:
<comment>Description:</comment>
  解凍の状態を取得する
  
  通常 <info>ZLIB_OK</info> か <info>ZLIB_STREAM_END</info> を返します。

<comment>Param:</comment>
  <info>InflateContext</info>  <strong>$context</strong>  

<comment>Return:</comment>
  <info>int</info>  解凍の状態を返します。


id: inflate_init
type: function
doc:
<comment>Description:</comment>
  インクリメンタルな解凍コンテキストを初期化する
  
  指定された <strong>$encoding</strong> でインクリメンタルな解凍コンテキストを初期化します

<comment>Param:</comment>
  <info>int</info>    <strong>$encoding</strong>  定数 <info>ZLIB_ENCODING_*</info> のうちのひとつ
  <info>array</info>  <strong>$options</strong>   次の要素を含む連想配列: level -1 .. 9 までの圧縮レベル。デフォルトは -1 です。
                    memory 1 .. 9 までの圧縮メモリレベル。デフォルトは8です。 window 8 .. 15 までの
                    zlib の window サイズ(対数)。 デフォルトは 15 です。 strategy<info>ZLIB_FILTERED</info>,
                    <info>ZLIB_HUFFMAN_ONLY</info>, <info>ZLIB_RLE</info>, <info>ZLIB_FIXED</info>, <info>ZLIB_DEFAULT_STRATEGY</info> (デフォルト) のう
                    ちのひとつです。 dictionary あらかじめ設定されたディクショナリの <info>string</info> または
                    <info>strings</info> の <info>array</info>。 (デフォルト: 辞書なし)
                    
                    -1 .. 9 までの圧縮レベル。デフォルトは -1 です。
                    
                    1 .. 9 までの圧縮メモリレベル。デフォルトは8です。
                    
                    8 .. 15 までの zlib の window サイズ(対数)。 デフォルトは 15 です。
                    
                    <info>ZLIB_FILTERED</info>, <info>ZLIB_HUFFMAN_ONLY</info>, <info>ZLIB_RLE</info>, <info>ZLIB_FIXED</info>, <info>ZLIB_DEFAULT_STRATEGY</info>
                    (デフォルト) のうちのひとつです。
                    
                    あらかじめ設定されたディクショナリの <info>string</info> または <info>strings</info> の <info>array</info>。 (デフォル
                    ト: 辞書なし)

<comment>Return:</comment>
  <info>InflateContext|false</info>  成功した場合、解凍コンテキストリソース(<return>zlib.inflate</return>) を返します。 失敗した場
                        合に <info>false</info> を返します

<comment>See Also:</comment>
   * <strong>inflate_add()</strong>
   * <strong>deflate_init()</strong>


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


id: ini_get
type: function
doc:
<comment>Description:</comment>
  設定オプションの値を得る
  
  成功時に、設定オプションの値を返します。

<comment>Param:</comment>
  <info>string</info>  <strong>$option</strong>  設定オプションの名前。

<comment>Return:</comment>
  <info>string|false</info>  成功した場合に設定オプションの値、 <return>null</return> 値の場合は空の文字列を返します。 その設定オ
                プションが存在しない場合は <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>get_cfg_var()</strong>
   * <strong>ini_get_all()</strong>
   * <strong>ini_restore()</strong>
   * <strong>ini_set()</strong>


id: ini_get_all
type: function
doc:
<comment>Description:</comment>
  すべての設定オプションを得る
  
  すべての登録済み設定オプションを返します。

<comment>Param:</comment>
  <info>string|null</info>  <strong>$extension</strong>  オプションで指定する拡張モジュール名。 この値が <info>null</info> でない場合、 または
                           文字列 <return>core</return> を指定した場合、 その拡張モジュールに関するオプションのみを返
                           します。
  <info>bool</info>         <strong>$details</strong>    詳細な設定を取得するか、あるいは各設定の現在の値のみを取得するか。 デフォ
                           ルトは <info>true</info> (詳細情報を取得する) です。

<comment>Return:</comment>
  <info>array|false</info>  ディレクティブ名をキーとする連想配列を返します。 <strong>$extension</strong> が存在しない場合は、
               <info>false</info> を返し、<info>E_WARNING</info> レベルの警告を発生させます。
               
               <strong>$details</strong> が <info>true</info> (デフォルト) の場合、 配列の値は、 <return>global_value</return> (php.iniで設定されて
               いる)、 <return>local_value</return> (おそらく<strong>ini_set()</strong>または .htaccessでセットされている)、<return>access</return> (ア
               クセスレベル) を含む配列となります。
               
               <strong>$details</strong> が <info>false</info> の場合、 配列の値はそのオプションの現在の値となります。
               
               アクセスレベルの意味についてはマニュアルを参照ください。
               
               ひとつのディレクティブに複数のアクセスレベルを設定することができます。 <return>access</return> がビッ
               トマスク値となっているのはそのためです。

<comment>See Also:</comment>
   * 
   * <strong>ini_get()</strong>
   * <strong>ini_restore()</strong>
   * <strong>ini_set()</strong>
   * <strong>get_loaded_extensions()</strong>
   * <strong>phpinfo()</strong>
   * ReflectionExtension::getINIEntries


id: ini_parse_quantity
type: function
doc:
<comment>Description:</comment>
  ini ディレクティブの省略形を解釈し、サイズを取得する
  
  成功した場合に、 ini ディレクティブの省略形 を解釈したサイズをバイト単位で返します。

<comment>Param:</comment>
  <info>string</info>  <strong>$shorthand</strong>  パースする ini ディレクティブの省略形。 数値を指定しなければなりません。そのあ
                      とに、オプションの倍率を続けます。 サポートされている倍率は以下のとおりです:
                      <return>k</return>/<return>K</return> (<return>1024</return>), <return>m</return>/<return>M</return> (<return>1048576</return>), <return>g</return>/<return>G</return> (<return>1073741824</return>)。 数値は10進数、16進数(数値の前に
                      <return>0x</return>,<return>0X</return> を付けた場合)、 8進数(数値の前に <return>0o</return>, <return>0O</return>, <return>0</return> を付けた場合)、 2進数(数値の
                      前に <return>0b</return>, <return>0B</return> を付けた場合) を指定できます。

<comment>Return:</comment>
  <info>int</info>  解釈済みのサイズをバイト単位で、整数として返します。

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


id: ini_restore
type: function
doc:
<comment>Description:</comment>
  設定オプションの値を元に戻す
  
  指定した設定オプションを元の値に戻します。

<comment>Param:</comment>
  <info>string</info>  <strong>$option</strong>  設定オプションの名前。

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

<comment>See Also:</comment>
   * <strong>ini_get()</strong>
   * <strong>ini_get_all()</strong>
   * <strong>ini_set()</strong>


id: ini_set
type: function
doc:
<comment>Description:</comment>
  設定オプションの値を設定する
  
  指定した設定オプションの値を設定します。 設定オプションは、スクリプトの実行中は新しい値を保持し、
  スクリプト終了時に元の値へ戻されます。

<comment>Param:</comment>
  <info>string</info>                      <strong>$option</strong>  全てのオプションが <strong>ini_set()</strong> を使用して変更することが 可能な
                                       わけではありません。有効なオプションの完全な一覧は 付録 を参
                                       照ください。
  <info>string|int|float|bool|null</info>  <strong>$value</strong>   オプションの新しい値。

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

<comment>See Also:</comment>
   * <strong>get_cfg_var()</strong>
   * <strong>ini_get()</strong>
   * <strong>ini_get_all()</strong>
   * <strong>ini_restore()</strong>
   * 設定を変更するには


id: inotify_add_watch
type: function
doc:
<comment>Description:</comment>
  初期化済みの inotify インスタンスに監視対象を追加する
  
  <strong>inotify_add_watch()</strong> は、<strong>$pathname</strong> で指定したファイルあるいはディレクトリへの監視を追加あるいは変更
  します。
  
  既存の監視対象に対して <strong>inotify_add_watch()</strong> を使用すると、 監視内容を上書きします。定数 <info>IN_MASK_ADD</info>
  を使用すると、 既存の監視対象を上書きせずにイベントを追加します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$inotify_instance</strong>  <strong>inotify_init()</strong> が返すリソース
  <info>string</info>    <strong>$pathname</strong>          監視対象のファイルあるいはディレクトリ。
  <info>int</info>       <strong>$mask</strong>              監視するイベント。定義済みの定数 を参照ください。

<comment>Return:</comment>
  <info>int</info>  戻り値は、(inotify インスタンス内で) 一意な監視記述子です。

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


id: inotify_init
type: function
doc:
<comment>Description:</comment>
  inotify インスタンスを初期化する
  
  <strong>inotify_add_watch()</strong> で使用するための inotify インスタンスを初期化します。

<comment>Return:</comment>
  <info>resource</info>  ストリームリソース、あるいはエラー時に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>inotify_add_watch()</strong>
   * <strong>inotify_rm_watch()</strong>
   * <strong>inotify_queue_len()</strong>
   * <strong>inotify_read()</strong>
   * <strong>fclose()</strong>


id: inotify_queue_len
type: function
doc:
<comment>Description:</comment>
  待機中のイベントがある場合に正の数を返す
  
  この関数で、<strong>inotify_read()</strong> がブロックされるかどうかを知ることができます。 ゼロより大きい数が返され
  た場合は待機中のイベントがあることを意味し、 この場合 <strong>inotify_read()</strong> はブロックされません。

<comment>Param:</comment>
  <info>resource</info>  <strong>$inotify_instance</strong>  <strong>inotify_init()</strong> が返すリソース

<comment>Return:</comment>
  <info>int</info>  待機中のイベントがある場合に正の数を返します。

<comment>See Also:</comment>
   * <strong>inotify_init()</strong>
   * <strong>stream_select()</strong>
   * <strong>stream_set_blocking()</strong>


id: inotify_read
type: function
doc:
<comment>Description:</comment>
  inotify インスタンスからイベントを読み込む
  
  inotify イベントを inotify インスタンスから読み込みます。

<comment>Param:</comment>
  <info>resource</info>  <strong>$inotify_instance</strong>  <strong>inotify_init()</strong> が返すリソース

<comment>Return:</comment>
  <info>array</info>  inotify イベントの配列、を返します。待機中のイベントがなく、かつ <strong>$inotify_instance</strong> が非ブ
         ロックモードである場合は <info>false</info> を返します。各イベントは次のキーを持つ配列となります。 wd
         は、<strong>inotify_add_watch()</strong> が返す監視記述子ですmask は、events のビットマスクですcookie は、接
         続関連のイベント (たとえば <info>IN_MOVE_FROM</info> や <info>IN_MOVE_TO</info>) の一意な ID ですname は、ファイル名
         (たとえば 監視対象のディレクトリ内でファイルが変更された場合) です

<comment>See Also:</comment>
   * <strong>inotify_init()</strong>
   * <strong>stream_select()</strong>
   * <strong>stream_set_blocking()</strong>
   * <strong>inotify_queue_len()</strong>


id: inotify_rm_watch
type: function
doc:
<comment>Description:</comment>
  既存の監視を inotify インスタンスから削除する
  
  <strong>inotify_rm_watch()</strong> は、 <strong>$watch_descriptor</strong> がさす監視を inotify インスタンス <strong>$inotify_instance</strong> から
  削除します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$inotify_instance</strong>  <strong>inotify_init()</strong> が返すリソース
  <info>int</info>       <strong>$watch_descriptor</strong>  インスタンスから削除したい監視。

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

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


id: intdiv
type: function
doc:
<comment>Description:</comment>
  整数値の除算
  
  <strong>$num1</strong> を <strong>$num2</strong> で割った整数商を返します。

<comment>Param:</comment>
  <info>int</info>  <strong>$num1</strong>  割られる数。
  <info>int</info>  <strong>$num2</strong>  <strong>$num1</strong> を割る数。

<comment>Return:</comment>
  <info>int</info>  <strong>$num1</strong> を <strong>$num2</strong> で割った整数商。

<comment>See Also:</comment>
   * <return>/</return> - 浮動小数点数値の除算
   * <return>%</return> - 整数値の剰余
   * <strong>fmod()</strong> - 浮動小数点数値の剰余


id: interface_exists
type: function
doc:
<comment>Description:</comment>
  インターフェイスが宣言されているかどうかを確認する
  
  指定したインターフェイスが定義されているかどうかを調べます。

<comment>Param:</comment>
  <info>string</info>  <strong>$interface</strong>  インターフェイス名。
  <info>bool</info>    <strong>$autoload</strong>   まだロードされていない場合に オートロード するかどうか。

<comment>Return:</comment>
  <info>bool</info>  <strong>$interface</strong> で与えられたインターフェイスが宣言されていれば <info>true</info> を返します。 そうでなければ
        <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>get_declared_interfaces()</strong>
   * <strong>class_implements()</strong>
   * <strong>class_exists()</strong>
   * <strong>enum_exists()</strong>


id: intl_error_name
type: function
doc:
<comment>Description:</comment>
  指定したエラーコードに対応する名前を取得する
  
  ICU のエラーコード名を返します。

<comment>Param:</comment>
  <info>int</info>  <strong>$errorCode</strong>  ICU のエラーコード。

<comment>Return:</comment>
  <info>string</info>  エラーコード定数と同じ名前の文字列を返します。

<comment>See Also:</comment>
   * <strong>intl_is_failure()</strong>
   * <strong>intl_get_error_code()</strong>
   * <strong>intl_get_error_message()</strong>


id: intl_get_error_code
type: function
doc:
<comment>Description:</comment>
  直近のエラーコードを取得する
  
  staticメソッドを実行した場合など、 エラーコードを取得するオブジェクトが存在しない場合のエラー処理
  に便利です。

<comment>Return:</comment>
  <info>int</info>  直近の API 関数のコールが返すエラーコードを返します。

<comment>See Also:</comment>
   * <strong>intl_is_failure()</strong>
   * <strong>intl_error_name()</strong>
   * <strong>intl_get_error_message()</strong>
   * <strong>collator_get_error_code()</strong>
   * <strong>numfmt_get_error_code()</strong>


id: intl_get_error_message
type: function
doc:
<comment>Description:</comment>
  直近のエラーの説明を取得する
  
  直近の国際化関数のコールによるエラーメッセージを取得します。

<comment>Return:</comment>
  <info>string</info>  直近の API 関数のコールで発生したエラーの説明を返します。

<comment>See Also:</comment>
   * <strong>intl_error_name()</strong>
   * <strong>intl_get_error_code()</strong>
   * <strong>intl_is_failure()</strong>
   * <strong>collator_get_error_message()</strong>
   * <strong>numfmt_get_error_message()</strong>


id: intl_is_failure
type: function
doc:
<comment>Description:</comment>
  指定したエラーコードが失敗を表すかどうかを調べる
  
  

<comment>Param:</comment>
  <info>int</info>  <strong>$errorCode</strong>  <strong>intl_get_error_code()</strong> や <strong>collator_get_error_code()</strong> が返す値。

<comment>Return:</comment>
  <info>bool</info>  そのコードが何らかの失敗を意味する場合に <info>true</info>、 成功あるいは警告を意味する場合に <info>false</info> を返
        します。

<comment>See Also:</comment>
   * <strong>intl_get_error_code()</strong>
   * <strong>collator_get_error_code()</strong>
   * <strong>Collator-getErrorCode()</strong>


id: intval
type: function
doc:
<comment>Description:</comment>
  変数の整数としての値を取得する
  
  指定された値 <strong>$base</strong> を基数（デフォルトは 10）とする、 <strong>$value</strong> の <info>int</info> としての値を返します。 オブジェ
  クトに <strong>intval()</strong> を使用することはできません。 その場合は <info>E_WARNING</info> レベルのエラーを発して 1 を返し
  ます。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  整数に変換するスカラー値
  <info>int</info>    <strong>$base</strong>   変換のための基数
                 
                 <strong>$base</strong> が 0 の場合は、 <strong>$value</strong> のフォーマットに基づいて利用する基数を決めます。  文字
                 列の先頭が "0x" (あるいは "0X") の場合は、基数を 16 (十六進数) とします。  文字列の
                 先頭が "0b" (あるいは "0B") の場合は、基数を 2 (二進数) とします。  そうではなく、
                 文字列の先頭が "0" の場合は、基数を 8 (八進数) とします。 otherwise,  それ以外の場
                 合は、基数を 10 (十進数) とします。
                 
                 文字列の先頭が "0x" (あるいは "0X") の場合は、基数を 16 (十六進数) とします。
                 
                 文字列の先頭が "0b" (あるいは "0B") の場合は、基数を 2 (二進数) とします。
                 
                 そうではなく、文字列の先頭が "0" の場合は、基数を 8 (八進数) とします。 otherwise,
                 
                 それ以外の場合は、基数を 10 (十進数) とします。

<comment>Return:</comment>
  <info>int</info>  成功時は <strong>$value</strong> の整数値、失敗時は 0。 空の配列の場合は 0、空でない配列の場合は 1 を返しま
       す。
       
       最大値はシステムに依存します。32 ビットシステムでは、 最大の符号付き整数の範囲 -2147483648 ～
       2147483647 となります。 このため、そのようなシステムでは <return>intval('1000000000000')</return> は
       2147483647 を返します。 64 ビットシステムにおける最大の符号付き整数は 9223372036854775807 と
       なります。
       
       文字列の場合、文字列の最左の文字に依存しますが、ほとんどの場合で 0 を返します。 整数への変換
       の一般的なルールが適用されます。

<comment>See Also:</comment>
   * <strong>boolval()</strong>
   * <strong>floatval()</strong>
   * <strong>strval()</strong>
   * <strong>settype()</strong>
   * <strong>is_numeric()</strong>
   * 型の相互変換
   * BCMath任意精度数学関数


id: ip2long
type: function
doc:
<comment>Description:</comment>
  ドット表記の (IPv4) IP アドレスを、長整数表現に変換する
  
  関数 <strong>ip2long()</strong> は、インターネット標準形式 (ドット表記の文字列) 表現から、長整数表現の IPv4 イン
  ターネットネットアドレスを生成します。
  
  <strong>ip2long()</strong> は不完全な形式の IP アドレスに対しても動作します。詳しい情報は
  http://ps-2.kev009.com/wisclibrary/aix52/usr/share/man/info/en_US/a_doc_lib/libs/commtrf2/inet_addr.htm
  を参照ください。

<comment>Param:</comment>
  <info>string</info>  <strong>$ip</strong>  標準形式のアドレス。

<comment>Return:</comment>
  <info>int|false</info>  長整数値、あるいは <strong>$ip</strong> が不正な形式の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>long2ip()</strong>
   * <strong>sprintf()</strong>


id: iptcembed
type: function
doc:
<comment>Description:</comment>
  バイナリ IPTC データを JPEG イメージに埋めこむ
  
  バイナリ IPTC データを JPEG イメージに埋めこみます。

<comment>Param:</comment>
  <info>string</info>  <strong>$iptc_data</strong>  書き込むデータ。
  <info>string</info>  <strong>$filename</strong>   JPEG 画像へのパス。
  <info>int</info>     <strong>$spool</strong>      Spool フラグ。このフラグが 2 より小さい場合は、JPEG が文字列として返されます。
                      そうでない場合は、JPEG を STDOUT に出力します。

<comment>Return:</comment>
  <info>string|bool</info>  成功し、かつ <strong>$spool</strong> が 2 より小さい場合は、JPEG を返します。 失敗した場合に <info>false</info> を
               返します。<strong>$spool</strong> が 2 以上の場合は、成功した場合に <info>true</info> を返します。 失敗した場合に
               <info>false</info> を返します。


id: iptcparse
type: function
doc:
<comment>Description:</comment>
  バイナリの IPTC ブロックのタグをパースする
  
  IPTC ブロックをパースします。

<comment>Param:</comment>
  <info>string</info>  <strong>$iptc_block</strong>  バイナリ IPTC ブロック。

<comment>Return:</comment>
  <info>array|false</info>  タグマーカーをインデックスとし、その値を保持する配列を返します。 エラー時や IPTC デー
               タが見つからなかったときは <info>false</info> を返します。


id: is_a
type: function
doc:
<comment>Description:</comment>
  オブジェクトが指定された型のものか、部分型であるかを調べる
  
  指定した <strong>$object_or_class</strong> がこのオブジェクトの型であるか、 あるいはこのオブジェクトの型が、その上
  位型のひとつであるかを調べます。

<comment>Param:</comment>
  <info>mixed</info>   <strong>$object_or_class</strong>  調べたいクラス名、またはオブジェクトのインスタンス
  <info>string</info>  <strong>$class</strong>            クラスまたはインターフェイスの名前。
  <info>bool</info>    <strong>$allow_string</strong>     このパラメータを <info>false</info> にすると、 クラス名を表す文字列を
                            <strong>$object_or_class</strong> に指定できなくなります。 そして、クラスが存在しない場合
                            のオートローダーの呼び出しもしなくなります。

<comment>Return:</comment>
  <info>bool</info>  指定した値がこのオブジェクトの型であるか、 あるいはこのオブジェクトの型が、その上位型のひと
        つである場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>get_class()</strong>
   * <strong>get_parent_class()</strong>
   * <strong>is_subclass_of()</strong>


id: is_array
type: function
doc:
<comment>Description:</comment>
  変数が配列かどうかを検査する
  
  与えられた変数が配列かどうかを検査します。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  評価する変数

<comment>Return:</comment>
  <info>bool</info>  <strong>$value</strong> が <info>配列型</info> の場合 <info>true</info>、 そうでない場合 <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>array_is_list()</strong>
   * <strong>is_float()</strong>
   * <strong>is_int()</strong>
   * <strong>is_string()</strong>
   * <strong>is_object()</strong>


id: is_bool
type: function
doc:
<comment>Description:</comment>
  変数が boolean であるかを調べる
    
  
  指定した変数が boolean であるかどうかを調べます。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  評価する変数。

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

<comment>See Also:</comment>
   * <strong>is_float()</strong>
   * <strong>is_int()</strong>
   * <strong>is_string()</strong>
   * <strong>is_object()</strong>
   * <strong>is_array()</strong>


id: is_callable
type: function
doc:
<comment>Description:</comment>
  引数が、現在のスコープから関数としてコール可能な値かどうかを調べる
    
  
  引数の内容が、<info>callable</info> かどうかを調べます。

<comment>Param:</comment>
  <info>mixed</info>   <strong>$value</strong>          チェックする値。
  <info>bool</info>    <strong>$syntax_only</strong>    <info>true</info> の場合、この関数は単に <strong>$value</strong> が関数またはメソッドであるかどうかだけ
                          を調べます。 文字列以外の型の変数や不正な形式の配列は、 引数として受け付け
                          られません。有効な配列の形式は、 最初のエントリがオブジェクトあるいは文字
                          列で、2 番目のエントリが文字列である 2 つのエントリからなるものです。
  <info>string</info>  <strong>$callable_name</strong>  "呼び出し名" を受け取ります。下の例では "someClass::someMethod" です。これ
                          は someClass::SomeMethod() が static メソッドであるかのようにみえますが、
                          そうではないことに注意しましょう。

<comment>Return:</comment>
  <info>bool</info>  <strong>$value</strong> がコール可能な場合に <info>true</info>、 それ以外の場合に <info>false</info> を返します。

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


id: is_countable
type: function
doc:
<comment>Description:</comment>
  引数が、数えられる値かどうかを調べる
    
  
  引数の内容が、<info>array</info> または <class>Countable</class> を実装したオブジェクトかどうかを調べます。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  チェックする値

<comment>Return:</comment>
  <info>bool</info>  <strong>$value</strong> が数えられる場合に <info>true</info>、 それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>is_array()</strong>
   * <strong>is_object()</strong>
   * <strong>is_iterable()</strong>
   * <strong>is_bool()</strong>


id: is_dir
type: function
doc:
<comment>Description:</comment>
  ファイルがディレクトリかどうかを調べる
  
  指定したファイルがディレクトリかどうかを調べます。

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  ファイルへのパス。<strong>$filename</strong> が相対パスの場合は、現在の作業ディレクトリからの相
                     対パスとして処理します。 <strong>$filename</strong> がシンボリックリンクあるいはハードリンクの場
                     合は、 リンク先を解決して処理します。 open_basedir を有効にすると、 さらに制限
                     がかかるでしょう。

<comment>Return:</comment>
  <info>bool</info>  ファイルが存在して、かつそれがディレクトリであれば <info>true</info>、それ以外の場合は <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>chdir()</strong>
   * <strong>dir()</strong>
   * <strong>opendir()</strong>
   * <strong>is_file()</strong>
   * <strong>is_link()</strong>


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


id: is_executable
type: function
doc:
<comment>Description:</comment>
  ファイルが実行可能かどうかを調べる
  
  ファイルが実行可能かどうかを調べます。

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  ファイルへのパス。

<comment>Return:</comment>
  <info>bool</info>  ファイルが存在し、かつそれが実行可能な場合に <info>true</info>、 エラー時に <info>false</info> を返します。 POSIX 準拠
        のシステムでは、 ファイルパーミッションの実行ビットが立っているものが実行可能です。 Windows
        については、下記を参照ください。

<comment>See Also:</comment>
   * <strong>is_file()</strong>
   * <strong>is_link()</strong>


id: is_file
type: function
doc:
<comment>Description:</comment>
  通常ファイルかどうかを調べる
  
  指定したファイルが通常のファイルかどうかを調べます。

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  ファイルへのパス。

<comment>Return:</comment>
  <info>bool</info>  ファイルが存在し、かつそれが通常のファイルである場合に <info>true</info>、 それ以外の場合に <info>false</info> を返し
        ます。
        
        PHP の数値型は符号付整数であり、 多くのプラットフォームでは 32 ビットの整数を取るため、 ファ
        イルシステム関数の中には 2GB より大きなファイルについては期待とは違う値を返すものがありま
        す。

<comment>See Also:</comment>
   * <strong>is_dir()</strong>
   * <strong>is_link()</strong>
   * <class>SplFileInfo</class>


id: is_finite
type: function
doc:
<comment>Description:</comment>
  浮動小数点数の値が、有限の数値であるかどうかを調べる
  
  指定した <strong>$num</strong> が有限の浮動小数点数かどうかを返します。
  
  有限の浮動小数点数とは、<return>NAN</return> (<strong>is_nan()</strong>) でもなく、かつ 無限 (<strong>is_infinite()</strong>) でもない値です。

<comment>Param:</comment>
  <info>float</info>  <strong>$num</strong>  調べる <info>float</info> の値。

<comment>Return:</comment>
  <info>bool</info>  <strong>$num</strong> が <return>NAN</return>, <return>INF</return>, <return>-INF</return> のいずれでもない場合、<info>true</info> を返します。そうでない場合、<info>false</info> を返しま
        す。

<comment>See Also:</comment>
   * <strong>is_infinite()</strong>
   * <strong>is_nan()</strong>


id: is_float
type: function
doc:
<comment>Description:</comment>
  変数の型が float かどうか調べる
  
  与えられた変数の型が float かどうかを調べます。
  
  変数が数値もしくは数値形式の文字列の場合 (フォームからの入力の場合は 常に文字列となります) 、
  <strong>is_numeric()</strong> を使用する必要があります。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  評価する変数

<comment>Return:</comment>
  <info>bool</info>  もし <strong>$value</strong> が <info>float 型</info> の場合 <info>true</info>、 そうでない場合は <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>is_bool()</strong>
   * <strong>is_int()</strong>
   * <strong>is_numeric()</strong>
   * <strong>is_string()</strong>
   * <strong>is_array()</strong>
   * <strong>is_object()</strong>


id: is_infinite
type: function
doc:
<comment>Description:</comment>
  浮動小数点数の値が、無限大であるかどうかを調べる
  
  指定した <strong>$num</strong> が、<return>INF</return> か <return>-INF</return> のいずれであるかを返します。

<comment>Param:</comment>
  <info>float</info>  <strong>$num</strong>  調べる <info>float</info> の値。

<comment>Return:</comment>
  <info>bool</info>  <strong>$num</strong> が <return>INF</return>, <return>-INF</return> のいずれかである場合、<info>true</info> を返します。そうでない場合、<info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>is_finite()</strong>
   * <strong>is_nan()</strong>


id: is_int
type: function
doc:
<comment>Description:</comment>
  変数が整数型かどうかを検査する
  
  与えられた変数の型が整数型かどうかを検査します。
  
  変数が数値か数値形式の文字列かを判断したい場合 (フォームからの入力の場合は 常に文字列となります)
  、<strong>is_numeric()</strong> を使用する必要があります。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  評価する変数

<comment>Return:</comment>
  <info>bool</info>  もし <strong>$value</strong> が 整数型(<info>int</info>)の場合 <info>true</info>、 そうでない場合は <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>is_bool()</strong>
   * <strong>is_float()</strong>
   * <strong>is_numeric()</strong>
   * <strong>is_string()</strong>
   * <strong>is_array()</strong>
   * <strong>is_object()</strong>


id: is_iterable
type: function
doc:
<comment>Description:</comment>
  変数の内容が反復可能な値であることを確認する
    
  
  変数の内容が <info>iterable</info> 疑似型で許容されること、すなわち <info>array</info>、あるいは <class>Traversable</class> のどちらかを実
  装したオブジェクトであることを確認する。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  チェックする値

<comment>Return:</comment>
  <info>bool</info>  <strong>$value</strong> が反復可能であれば <info>true</info> を、そうでなければ <info>false</info> を返す。

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


id: is_link
type: function
doc:
<comment>Description:</comment>
  ファイルがシンボリックリンクかどうかを調べる
  
  指定したファイルがシンボリックリンクかどうかを調べます。

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  ファイルへのパス。

<comment>Return:</comment>
  <info>bool</info>  filename が存在し、かつシンボリックリンクであれば <info>true</info>、 それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>is_dir()</strong>
   * <strong>is_file()</strong>
   * <strong>readlink()</strong>


id: is_nan
type: function
doc:
<comment>Description:</comment>
  浮動小数点数の値が、非数かどうかを調べる
  
  指定された <strong>$num</strong> が、<return>NAN</return> (Not A Number) であるかどうかを返します。
  
  数学的に未定義な演算が行われると、<return>NAN</return> が返されます。 たとえば関数に渡されるパラメータに、範囲外の
  値が渡されたときが該当します。 平方根(<strong>sqrt()</strong>) は、正の数値の場合にのみ定義されるので、負の数を渡す
  と結果は <return>NAN</return> になります。 <return>NAN</return> が返される他の例としては、<return>INF</return> の値を <return>INF</return> で割った場合や、 既に <return>NAN</return>
  とわかっている値と演算をした場合が挙げられます。
  
  Not A Number という名前が付いていますが、<return>NAN</return> は <info>float</info> 型の値として正しい値です。
  
  <return>NAN</return> は、<return>NAN</return> と等しい値として比較できません。 浮動小数点数の値が <return>NAN</return> かを判定するには <strong>is_nan()</strong> を使
  わなければいけません。 コード $float === NAN は動作しません。

<comment>Param:</comment>
  <info>float</info>  <strong>$num</strong>  調べる <info>float</info> の値。

<comment>Return:</comment>
  <info>bool</info>  <strong>$num</strong> が <return>NAN</return> の場合、<info>true</info> を返します。そうでない場合、<info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>is_finite()</strong>
   * <strong>is_infinite()</strong>


id: is_null
type: function
doc:
<comment>Description:</comment>
  変数が null かどうか調べる
    
  
  指定した変数が <info>null</info> かどうかを調べます。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  評価する変数。

<comment>Return:</comment>
  <info>bool</info>  <strong>$value</strong> が <info>null</info> の場合に <info>true</info>、 それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <info>null</info> 型
   * <strong>isset()</strong>
   * <strong>is_bool()</strong>
   * <strong>is_numeric()</strong>
   * <strong>is_float()</strong>
   * <strong>is_int()</strong>
   * <strong>is_string()</strong>
   * <strong>is_object()</strong>
   * <strong>is_array()</strong>


id: is_numeric
type: function
doc:
<comment>Description:</comment>
  変数が数字または数値形式の文字列であるかを調べる
    
  
  指定した変数が数値または 数値形式の文字列であるかどうかを調べます。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  評価する変数。

<comment>Return:</comment>
  <info>bool</info>  <strong>$value</strong> が数値または 数値形式の文字列 である場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * 数値形式の文字列
   * <strong>ctype_digit()</strong>
   * <strong>is_bool()</strong>
   * <strong>is_null()</strong>
   * <strong>is_float()</strong>
   * <strong>is_int()</strong>
   * <strong>is_string()</strong>
   * <strong>is_object()</strong>
   * <strong>is_array()</strong>
   * <strong>filter_var()</strong>


id: is_object
type: function
doc:
<comment>Description:</comment>
  変数がオブジェクトかどうかを検査する
  
  与えられた変数がオブジェクトかどうかを調べます。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  評価する変数。

<comment>Return:</comment>
  <info>bool</info>  もし <strong>$value</strong> が <info>object</info>型 の場合 <info>true</info>、 そうでない場合は <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>is_bool()</strong>
   * <strong>is_int()</strong>
   * <strong>is_float()</strong>
   * <strong>is_string()</strong>
   * <strong>is_array()</strong>


id: is_readable
type: function
doc:
<comment>Description:</comment>
  ファイルが存在し、読み込み可能であるかどうかを知る
  
  ファイルが存在し、読み込み可能であるかどうかを調べます。

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  ファイルへのパス。

<comment>Return:</comment>
  <info>bool</info>  <strong>$filename</strong> で指定したファイルあるいはディレクトリが存在し、 それが読み込み可能であれば <info>true</info>、
        それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>is_writable()</strong>
   * <strong>file_exists()</strong>
   * <strong>fgets()</strong>


id: is_real
type: function
doc:
<comment>Description:</comment>
  is_float のエイリアス
  
  この関数は次の関数のエイリアスです。 <strong>is_float()</strong>.
  
  このエイリアスは PHP 7.4.0 で 非推奨 となり、PHP 8.0.0 で 削除 されました。


id: is_resource
type: function
doc:
<comment>Description:</comment>
  変数がリソースかどうかを調べる
    
  
  指定した変数が <info>resource</info> かどうかを調べます。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  評価する変数。

<comment>Return:</comment>
  <info>bool</info>  <strong>$value</strong> が <info>resource</info> の場合に <info>true</info>、 それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * リソース型のドキュメント
   * <strong>get_resource_type()</strong>


id: is_scalar
type: function
doc:
<comment>Description:</comment>
  変数がスカラかどうかを調べる
    
  
  指定した変数がスカラかどうかを調べます。
  
  スカラ変数には <info>int</info>、<info>float</info>、<info>string</info> あるいは <info>bool</info> が含まれます。 <info>array</info>、<info>object</info>、 <info>resource</info>、<info>null</info> はス
  カラではありません。
  
  リソース型は現在整数に基づく抽象型であるため、 <strong>is_scalar()</strong> は <info>resource</info> 型の値を スカラ値と判定しま
  せん。この実装の詳細は変更される可能性があるため、 前堤にするべきではありません。
  
  <strong>is_scalar()</strong> は、NULL をスカラとは見なしません。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  評価する変数。

<comment>Return:</comment>
  <info>bool</info>  <strong>$value</strong> がスカラの場合に <info>true</info>、 それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>is_float()</strong>
   * <strong>is_int()</strong>
   * <strong>is_numeric()</strong>
   * <strong>is_real()</strong>
   * <strong>is_string()</strong>
   * <strong>is_bool()</strong>
   * <strong>is_object()</strong>
   * <strong>is_array()</strong>


id: is_soap_fault
type: function
doc:
<comment>Description:</comment>
  SOAP コールが失敗したかどうかを調べる
  
  この関数は、SOAP コールが失敗したかどうかを調べたいが、例外を使用したくない 場合に有用です。 この
  関数を使用するには、オプション <return>exceptions</return> に ゼロまたは <info>false</info> を指定して <class>SoapClient</class> オブジェクトを
  作成する必要があります。 この場合、SOAP メソッドは、特別な <class>SoapFault</class> オブジェクトを返します。 この
  オブジェクトには、フォルトの詳細 (faultcode, faultstring, faultactor および faultdetails) が含まれ
  ています。
  
  <return>exceptions</return> が設定されていない場合、 SOAPコールは、エラー時に例外をスローします。 <strong>is_soap_fault()</strong>
  は指定したパラメータ <class>SoapFault</class> オブジェクトであるかどうかを調べます。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$object</strong>  検査するオブジェクト

<comment>Return:</comment>
  <info>bool</info>  エラー時に <info>true</info>、それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * SoapClient::__construct
   * SoapFault::__construct


id: is_string
type: function
doc:
<comment>Description:</comment>
  変数の型が文字列かどうかを調べる
  
  指定した変数の型が文字列かどうかを調べます。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  評価する変数。

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

<comment>See Also:</comment>
   * <strong>is_float()</strong>
   * <strong>is_int()</strong>
   * <strong>is_bool()</strong>
   * <strong>is_object()</strong>
   * <strong>is_array()</strong>


id: is_subclass_of
type: function
doc:
<comment>Description:</comment>
  あるオブジェクトが指定したクラスのサブクラスに属するか (あるいは指定したインターフェイスを実装して
  い
  るか) どうかを調べる
  
  指定した <strong>$object_or_class</strong> が、その親のひとつに <strong>$class</strong> を持つか (あるいは <strong>$class</strong> を実装しているか)
  どうかを調べます。

<comment>Param:</comment>
  <info>mixed</info>   <strong>$object_or_class</strong>  クラス名あるいはオブジェクトのインスタンス。 そのクラスが存在しなくて
                            も、エラーにはなりません。
  <info>string</info>  <strong>$class</strong>            クラス名。
  <info>bool</info>    <strong>$allow_string</strong>     このパラメータを false にすると、 クラス名を表す文字列を
                            <strong>$object_or_class</strong> に指定できなくなります。 そして、クラスが存在しない場合
                            のオートローダーの呼び出しもしなくなります。

<comment>Return:</comment>
  <info>bool</info>  この関数は、オブジェクト <strong>$object_or_class</strong> が <strong>$class</strong> のサブクラスであるクラスに属する場合に
        <info>true</info>、その他の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>get_class()</strong>
   * <strong>get_parent_class()</strong>
   * <strong>is_a()</strong>
   * <strong>class_parents()</strong>


id: is_tainted
type: function
doc:
<comment>Description:</comment>
  文字列が汚染されているかどうかを調べる
  
  文字列が汚染されているかどうかを調べます。

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

<comment>Return:</comment>
  <info>bool</info>  文字列が汚染されている場合に TRUE、それ以外の場合に FALSE を返します。


id: is_uploaded_file
type: function
doc:
<comment>Description:</comment>
  HTTP POST でアップロードされたファイルかどうかを調べる
  
  filename という名前のファイルが HTTP POST によりアップロードされたものである場合に <info>true</info> を返しま
  す。 悪意のあるユーザーがスクリプトをだまして、 本来見られてはいけないはずのファイル (/etc/passwd
  など) にアクセスすることを防止したい場合に、この関数は有用です。
  
  この種の確認は、アップロードされたファイルに関して何でもできる場合には、 その内容をユーザー、また
  は同じシステム上の他のユーザーにさえ 暴かれる可能性があるため、特に重要です。
  
  適切に動作させるために、関数 <strong>is_uploaded_file()</strong> には $_FILES['userfile']['tmp_name'] のような引数
  が必要です。 アップロードされたファイルのクライアントマシン上での名前 $_FILES['userfile']['name']
  では動作しません。

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  調べたいファイル名。

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

<comment>See Also:</comment>
   * <strong>move_uploaded_file()</strong>
   * $_FILES
   * 簡単な使用例については ファイルアップロードの処理


id: is_writable
type: function
doc:
<comment>Description:</comment>
  ファイルが書き込み可能かどうかを調べる
  
  <strong>$filename</strong>が存在して、かつそれが書き込み可能であれば <info>true</info>を返します。引数filenameはディレクトリ名と
  することができ、 ディレクトリが書き込み可能であることを調べることが可能です。
  
  PHP は、Web サーバーが実行されているユーザー ID('nobody' が多い) でファイルにアクセスすることを覚
  えておいてください。

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  調べたいファイル名。

<comment>Return:</comment>
  <info>bool</info>  <strong>$filename</strong> が存在して書き込み可能な場合に <info>true</info> を返します。

<comment>See Also:</comment>
   * <strong>is_readable()</strong>
   * <strong>file_exists()</strong>
   * <strong>fwrite()</strong>


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


id: isset
type: function
doc:
<comment>Description:</comment>
  変数が宣言されていること、そして null とは異なることを検査する
  
  変数がセットされているかを調べます。 これは変数が宣言されており、 <info>null</info> とは異なる値だということで
  す。
  
  変数が、<strong>unset()</strong> により割当を解除された場合、 もはやセットされているとは見做されません。
  
  <info>null</info> が代入されている変数をチェックしたときは、 <strong>isset()</strong> は <info>false</info> を返します。 null文字 (<return>"\0"</return>) は
  PHP の <info>null</info> 定数とは異なることにも注意してください。
  
  複数のパラメータが渡された場合は、 <strong>isset()</strong> は全てのパラメータがセットされている場合にだけ <info>true</info> を
  返します。 評価は左から右へと行われ、セットされていない値に出会うとすぐに評価が止まります。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$var</strong>   調べたい変数。
  <info>mixed</info>  <strong>$vars</strong>  別の変数。

<comment>Return:</comment>
  <info>bool</info>  <strong>$var</strong> が存在して <info>null</info> 以外の値をとれば <info>true</info>、 そうでなければ <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>empty()</strong>
   * __isset()
   * <strong>unset()</strong>
   * <strong>defined()</strong>
   * PHP 型の比較表
   * <strong>array_key_exists()</strong>
   * <strong>is_null()</strong>
   * エラー制御演算子 @


id: iterator_apply
type: function
doc:
<comment>Description:</comment>
  ユーザー関数をイテレータのすべての要素でコールする
  
  イテレータ内のすべての要素に対して関数をコールします。

<comment>Param:</comment>
  <info>Traversable</info>  <strong>$iterator</strong>  順次処理したいイテレータオブジェクト
  <info>callable</info>     <strong>$callback</strong>  すべての要素に対してコールしたいコールバック関数。 この関数は <strong>$args</strong> のみを
                          受け取ります。 デフォルトでは引数を渡されません。 たとえば <return>count($args)
                          === 3</return> の場合、 コールバック関数は3変数関数です。 <strong>$iterator</strong> での処理を続け
                          るために、 この関数は <info>true</info> を返さなければなりません。
                          
                          <strong>$iterator</strong> での処理を続けるために、 この関数は <info>true</info> を返さなければなりませ
                          ん。
  <info>array|null</info>   <strong>$args</strong>      コールバック関数に渡す引数。 引数の <info>array</info>。 <strong>$args</strong> の個々の要素が コール
                          バック <strong>$callback</strong> に別々の引数として渡されます。

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

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


id: iterator_count
type: function
doc:
<comment>Description:</comment>
  イテレータにある要素をカウントする
  
  イテレータにある要素をカウントします。 <strong>iterator_count()</strong> は、 <strong>$iterator</strong> の現在位置がそのまま保たれ
  ることを保障しません。

<comment>Param:</comment>
  <info>Traversable|array</info>  <strong>$iterator</strong>  カウントしたいイテレータ。

<comment>Return:</comment>
  <info>int</info>  <strong>$iterator</strong> の要素数を返します。


id: iterator_to_array
type: function
doc:
<comment>Description:</comment>
  イテレータを配列にコピーする
  
  イテレータの要素を配列にコピーします。

<comment>Param:</comment>
  <info>Traversable|array</info>  <strong>$iterator</strong>       コピーしたいイテレータ。
  <info>bool</info>               <strong>$preserve_keys</strong>  イテレータの要素のキーをインデックスとして使用するかどうか。
                                     
                                     キーが <info>array</info> あるいは <info>object</info> の場合は、警告が発生します。 キー
                                     が <info>null</info> の場合は空文字列に変換し、キーが <info>float</info> の場合は <info>int</info> 型
                                     になるよう切り詰めます。 キーが <info>resource</info> の場合は警告を発し、リ
                                     ソース ID に変換します。 また、キーが <info>bool</info> の場合は整数値に変換
                                     します。
                                     
                                     このパラメータを省略したり <info>true</info> を指定したりした場合は、 重複す
                                     るキーは上書きされます。そのキーに対して最後にあらわれた値が
                                     <info>array</info> で返されることになります。 このパラメータを <info>false</info> にする
                                     と、重複があってもすべての値を返します。

<comment>Return:</comment>
  <info>array</info>  <strong>$iterator</strong> の要素を含む配列を返します。


id: jddayofweek
type: function
doc:
<comment>Description:</comment>
  曜日を返す
  
  曜日を返します。 モードに依存した文字あるいは整数を返す事が出来ます。

<comment>Param:</comment>
  <info>int</info>  <strong>$julian_day</strong>  ユリウス積算日を表す整数値。
  <info>int</info>  <strong>$mode</strong>        

<comment>Return:</comment>
  <info>int|string</info>  グレゴリウス暦の曜日を表す数値あるいは文字列を返します。


id: jdmonthname
type: function
doc:
<comment>Description:</comment>
  月の名前を返す
  
  月の名前を含んだ文字列を返します。 <strong>$mode</strong>はユリウス積算日をどの暦に変換するか、 どんなタイプの月名
  を返すかを関数に伝えます。 暦モードモード意味値<info>CAL_MONTH_GREGORIAN_SHORT</info>グレゴリウス暦 - 省略形
  Jan, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct, Nov, Dec<info>CAL_MONTH_GREGORIAN_LONG</info>グレゴリウス暦
  January, February, March, April, May, June, July, August, September, October, November,
  December<info>CAL_MONTH_JULIAN_SHORT</info>ユリウス暦 - 省略形Jan, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct,
  Nov, Dec<info>CAL_MONTH_JULIAN_LONG</info>ユリウス暦January, February, March, April, May, June, July, August,
  September, October, November, December<info>CAL_MONTH_JEWISH</info>ユダヤ暦Tishri, Heshvan, Kislev, Tevet,
  Shevat, Adar, Adar I, Adar II, Nisan, Iyyar, Sivan, Tammuz, Av, Elul<info>CAL_MONTH_FRENCH</info>フランス革命暦
  Vendemiaire, Brumaire, Frimaire, Nivose, Pluviose, Ventose, Germinal, Floreal, Prairial, Messidor,
  Thermidor, Fructidor, Extra

<comment>Param:</comment>
  <info></info>     <strong>$jday</strong>  変換したいユリウス積算日。
  <info>int</info>  <strong>$mode</strong>  カレンダーのモード(上の表を参照)

<comment>Return:</comment>
  <info>string</info>  指定したユリウス積算日と <strong>$mode</strong> にもとづく月名を返します。


id: jdtofrench
type: function
doc:
<comment>Description:</comment>
  ユリウス積算日をフランス革命暦(共和暦)に変換する
  
  ユリウス積算日をフランス革命暦に変換します。

<comment>Param:</comment>
  <info>int</info>  <strong>$julian_day</strong>  ユリウス積算日を表す整数値。

<comment>Return:</comment>
  <info>string</info>  フランス革命暦の日付を "月/日/年" 形式の文字列で返します。

<comment>See Also:</comment>
   * <strong>frenchtojd()</strong>
   * <strong>cal_from_jd()</strong>


id: jdtogregorian
type: function
doc:
<comment>Description:</comment>
  ユリウス積算日をグレゴリウス日に変換する
  
  ユリウス積算日を "月/日/年" の形式でグレゴリウス日を含む文字列に変換します。

<comment>Param:</comment>
  <info>int</info>  <strong>$julian_day</strong>  ユリウス積算日を表す整数値。

<comment>Return:</comment>
  <info>string</info>  グレゴリウス暦の日付を "月/日/年" 形式の文字列で返します。

<comment>See Also:</comment>
   * <strong>gregoriantojd()</strong>
   * <strong>cal_from_jd()</strong>


id: jdtojewish
type: function
doc:
<comment>Description:</comment>
  ユリウス積算日をユダヤ暦に変換する
  
  ユリウス積算日をユダヤ暦に変換します。

<comment>Param:</comment>
  <info>int</info>   <strong>$julian_day</strong>  ユリウス積算日を表す整数値。
  <info>bool</info>  <strong>$hebrew</strong>      パラメータ <strong>$hebrew</strong> が <info>true</info> に設定されている場合、 ヘブライ語の ISO-8859-8 ベー
                     スの文字列形式での出力のために <strong>$flags</strong> が使用されます。
  <info>int</info>   <strong>$flags</strong>       組み合わせ可能なビットマスクは <info>CAL_JEWISH_ADD_ALAFIM_GERESH</info>、
                     <info>CAL_JEWISH_ADD_ALAFIM</info> および <info>CAL_JEWISH_ADD_GERESHAYIM</info> です。

<comment>Return:</comment>
  <info>string</info>  ユダヤ暦の日付を "月/日/年" 形式の文字列で返します。 または、<strong>$hebrew</strong> に応じて ISO-8859-8
          でエンコードされたヘブライ語の文字列を返します。

<comment>See Also:</comment>
   * <strong>jewishtojd()</strong>
   * <strong>cal_from_jd()</strong>


id: jdtojulian
type: function
doc:
<comment>Description:</comment>
  ユリウス積算日をユリウス暦に変換する
  
  ユリウス積算日を "月/日/年" の形式でユリウス暦を含む文字列に変換します。

<comment>Param:</comment>
  <info>int</info>  <strong>$julian_day</strong>  ユリウス積算日を表す整数値。

<comment>Return:</comment>
  <info>string</info>  ユリウス暦の日付を "月/日/年" 形式の文字列で返します。

<comment>See Also:</comment>
   * <strong>juliantojd()</strong>
   * <strong>cal_from_jd()</strong>


id: jdtounix
type: function
doc:
<comment>Description:</comment>
  ユリウス歴を Unix タイムスタンプに変換する
  
  この関数は、<strong>$julian_day</strong> で指定したユリウス歴に 対応する Unix タイムスタンプを返します。 返される時
  刻はUTCです。

<comment>Param:</comment>
  <info>int</info>  <strong>$julian_day</strong>  64bit のシステムでは、<return>2440588</return> から <return>106751993607888</return> までのユリウス積算日。 32bit
                    のシステムでは、<return>2440588</return> から <return>2465443</return> までの値です。

<comment>Return:</comment>
  <info>int</info>  指定したユリウス積算日の開始(昼ではなく夜中)時の Unix タイムスタンプを返します。

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


id: jewishtojd
type: function
doc:
<comment>Description:</comment>
  ユダヤ暦の日付けをユリウス積算日に変換する
  
  この関数では1年(紀元前3761年)に遡って全ての日々を扱うこと が出来ますが、この様な使い方は特に意味が
  あるわけではありません。 ユダヤ暦は数千年に渡って使われていますが、当初は月の 始まりが決められてい
  ませんでいた。新しい月は新月が最初に観測 された日に始まりました。

<comment>Param:</comment>
  <info>int</info>  <strong>$month</strong>  月を表す、<return>1</return> から <return>13</return> までの数値。 <return>1</return> は <return>Tishri</return> を、 <return>13</return> s <return>Elul</return> という意味です。 そして <return>6</return>
               と <return>7</return> は 通常の年では <return>Adar</return> を意味していますが、 うるう年では <return>Adar I</return> と <return>Adar II</return> をそれ
               ぞれ意味しています。
  <info>int</info>  <strong>$day</strong>    日を表す、<return>1</return> から <return>30</return> までの数値。 月が29日しかない場合、次の月のはじめの日と見なされま
               す。
  <info>int</info>  <strong>$year</strong>   年を表す、1 から 9999 までの数値。

<comment>Return:</comment>
  <info>int</info>  指定したユダヤ暦の日付に対応するユリウス積算日を返します。

<comment>See Also:</comment>
   * <strong>jdtojewish()</strong>
   * <strong>cal_to_jd()</strong>


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


id: jpeg2wbmp
type: function
doc:
<comment>Description:</comment>
  JPEG画像をWBMP画像に変換する
  
  JPEG画像をWBMP画像に変換します。

<comment>Param:</comment>
  <info>string</info>  <strong>$jpegname</strong>     JPEG画像ファイルのパス
  <info>string</info>  <strong>$wbmpname</strong>     出力先のWBMPファイルのパス
  <info>int</info>     <strong>$dest_height</strong>  出力画像の高さ
  <info>int</info>     <strong>$dest_width</strong>   出力画像の幅
  <info>int</info>     <strong>$threshold</strong>    しきい値の値。0から8までの値を指定します。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。
        
        しかしながら、libgd がイメージの出力に失敗した場合、この関数は <info>true</info> を返します。

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


id: json_decode
type: function
doc:
<comment>Description:</comment>
  JSON 文字列をデコードする
  
  JSON エンコードされた文字列を受け取り、それを PHP の値に変換します。

<comment>Param:</comment>
  <info>string</info>     <strong>$json</strong>         デコード対象となる <strong>$json</strong> 文字列。
                           
                           この関数は UTF-8 でエンコードされた文字列でのみ動作します。
                           
                           PHP の実装は、 RFC 7159 の JSON のスーパーセットです。
  <info>bool|null</info>  <strong>$associative</strong>  <info>true</info> の場合、返されるオブジェクトは連想配列形式になります。 <info>false</info> の場
                           合、返されるオブジェクトは <info>object</info> になります。 <info>null</info> の場合、返されるオブ
                           ジェクトは <strong>$flags</strong> に <info>JSON_OBJECT_AS_ARRAY</info> が設定されているかどうかによっ
                           て、 連想配列形式か <info>object</info> かが変化します。
  <info>int</info>        <strong>$depth</strong>        デコードするデータのネストの深さの最大値。 この値は <return>0</return> より大きく、
                           <return>2147483647</return> 以下でなければいけません。
  <info>int</info>        <strong>$flags</strong>        <info>JSON_BIGINT_AS_STRING</info>, <info>JSON_INVALID_UTF8_IGNORE</info>,
                           <info>JSON_INVALID_UTF8_SUBSTITUTE</info>, <info>JSON_OBJECT_AS_ARRAY</info>, <info>JSON_THROW_ON_ERROR</info>.
                           からなるビットマスク。 各定数の意味については JSON 定数のページ に説明が
                           あります。

<comment>Return:</comment>
  <info>mixed</info>  <strong>$json</strong> でエンコードされたデータを、適切な PHP の型として返します。 クォートされていない
         <return>true</return>、<return>false</return> および <return>null</return> はそれぞれ <info>true</info>、<info>false</info> そして <info>null</info> として返されます。 <strong>$json</strong> のデ
         コードに失敗したり エンコードされたデータがネストの最大値を超えているなどの場合、<info>null</info> を返
         します。

<comment>See Also:</comment>
   * <strong>json_encode()</strong>
   * <strong>json_last_error()</strong>


id: json_encode
type: function
doc:
<comment>Description:</comment>
  値を JSON 形式にして返す
  
  与えられた <strong>$value</strong> を JSON 形式にした文字列を返します。 引数が配列やオブジェクトの場合は、JSON 形式
  に再帰的に変換されます。
  
  変換される値がオブジェクトの場合、 デフォルトでは public としてアクセス可能なプロパティのみが含ま
  れます。 それ以外のやり方で、値を JSON 形式に変換する方法は、 JsonSerializable を実装することで制
  御できます。
  
  エンコーディングは、<strong>$flags</strong> の指定によって影響を受けます。 さらに、浮動小数点のエンコーディングは、
  serialize_precision の値によっても影響を受けます。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  エンコードする値。 リソース 型以外の任意の型を指定できます。
                 
                 すべての文字列データは、UTF-8 エンコードされていなければいけません。
                 
                 PHP の実装は、 RFC 7159 の JSON のスーパーセットです。
  <info>int</info>    <strong>$flags</strong>  <info>JSON_FORCE_OBJECT</info>, <info>JSON_HEX_QUOT</info>, <info>JSON_HEX_TAG</info>, <info>JSON_HEX_AMP</info>, <info>JSON_HEX_APOS</info>,
                 <info>JSON_INVALID_UTF8_IGNORE</info>, <info>JSON_INVALID_UTF8_SUBSTITUTE</info>, <info>JSON_NUMERIC_CHECK</info>,
                 <info>JSON_PARTIAL_OUTPUT_ON_ERROR</info>, <info>JSON_PRESERVE_ZERO_FRACTION</info>, <info>JSON_PRETTY_PRINT</info>,
                 <info>JSON_UNESCAPED_LINE_TERMINATORS</info>, <info>JSON_UNESCAPED_SLASHES</info>, <info>JSON_UNESCAPED_UNICODE</info>,
                 <info>JSON_THROW_ON_ERROR</info> からなるビットマスク。 各定数の意味については JSON 定数のページ
                 に説明があります。
  <info>int</info>    <strong>$depth</strong>  最大の深さを設定します。正の数でなければいけません。

<comment>Return:</comment>
  <info>string|false</info>  成功した場合に、JSON エンコードされた文字列を返します。 失敗した場合に <info>false</info> を返し
                ます。

<comment>See Also:</comment>
   * JsonSerializable
   * <strong>json_decode()</strong>
   * <strong>json_last_error()</strong>
   * <strong>serialize()</strong>


id: json_last_error
type: function
doc:
<comment>Description:</comment>
  直近に発生したエラーを返す
  
  <info>JSON_THROW_ON_ERROR</info> を指定していなかった場合に、 直近の JSON エンコード/デコード処理中に発生したエ
  ラー (もし存在すれば) を返します。

<comment>Return:</comment>
  <info>int</info>  整数値を返します。これは、次の定数のいずれかとなります。

<comment>See Also:</comment>
   * <strong>json_last_error_msg()</strong>
   * <strong>json_decode()</strong>
   * <strong>json_encode()</strong>


id: json_last_error_msg
type: function
doc:
<comment>Description:</comment>
  直近の json_encode() や json_decode() の呼び出しのエラー文字列を返す
  
  呼び出しで <info>JSON_THROW_ON_ERROR</info> を指定しなかった場合、 直近の <strong>json_encode()</strong> または <strong>json_decode()</strong> 呼
  び出しの エラー文字列を返します。

<comment>Return:</comment>
  <info>string</info>  成功した場合にエラーメッセージ、エラーが発生しなかった場合は <return>"No error"</return>

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


id: json_validate
type: function
doc:
<comment>Description:</comment>
  文字列が有効なJSONかどうかを調べる
  
  指定された文字列が、文法的に有効なJSONかどうかを返します。 <strong>json_validate()</strong> が <info>true</info> を返す場合、 同
  じ <strong>$depth</strong> と <strong>$flags</strong> を指定して <strong>json_decode()</strong> を実行してもデコードは成功します。
  
  <strong>json_validate()</strong> が <info>false</info> を返す場合、 原因は <strong>json_last_error()</strong> と <strong>json_last_error_msg()</strong> を使って取
  得できます。
  
  デコードされたJSONペイロードを使わない場合、 <strong>json_validate()</strong> は <strong>json_decode()</strong> よりもメモリ使用量が
  少なくなります。 なぜなら、ペイロードを含む配列やオブジェクト構造を組み立てる必要がないからです。
  
  　<strong>json_decode()</strong> の直前に <strong>json_validate()</strong> をコールすると、 文字列を不必要に2回パースすることになり
  ます。 なぜなら、<strong>json_decode()</strong> はデコードしている間に暗黙のうちに文字列を検証するからです。
  
  よって <strong>json_validate()</strong> は、JSON のペイロードをすぐに使わない場合、かつ有効なJSON文字列かどうかを知
  る必要がある場合にのみ使うべきです。

<comment>Param:</comment>
  <info>string</info>  <strong>$json</strong>   検証する文字列
                  
                  この関数は、UTF-8 でエンコードされた文字列でのみ動作します。
                  
                  PHP の実装は、 RFC 7159 の JSON のスーパーセットです。
  <info>int</info>     <strong>$depth</strong>  デコードされるネスト構造の深さの最大値。 この値は <return>0</return> より大きく、 <return>2147483647</return> 以下で
                  なければいけません。
  <info>int</info>     <strong>$flags</strong>  現状は、<info>JSON_INVALID_UTF8_IGNORE</info> のみを受け入れます。

<comment>Return:</comment>
  <info>bool</info>  指定された文字列が文法的に有効なJSONの場合、<info>true</info> を返します。 そうでない場合、<info>false</info> を返しま
        す。

<comment>See Also:</comment>
   * <strong>json_decode()</strong>
   * <strong>json_last_error()</strong>
   * <strong>json_last_error_msg()</strong>


id: juliantojd
type: function
doc:
<comment>Description:</comment>
  ユリウス暦をユリウス積算日に変換する
  
  ユリウス暦は紀元前 4713 年から紀元 9999 年の範囲で使えます。
  
  この関数は日付けを全て紀元前 4713 年にさかのぼって扱うことが 出来ますが,この様な使い方はあまり意味
  があるわけではありません。 このカレンダーは紀元前 46 年に作られました、しかし細部は紀元 8 年になる
  まで、おそらくは 4 世紀になるまで安定しませんでした。 また、年の始まりを一つの文化のものから別の文
  化のものに変更すること、 つまり、January を最初の月とすることは全く受け入れられませんでした。
  
  覚えておいてほしいのは、現在世界中で使用されているカレンダーは グレゴリウス暦であるということで
  す。この日付をユリウス日に 変換するには、<strong>gregoriantojd()</strong> が使用可能です。

<comment>Param:</comment>
  <info>int</info>  <strong>$month</strong>  月を表す、1 (for January) から 12 (for December) までの数値。
  <info>int</info>  <strong>$day</strong>    日を表す、1 から 31 までの数値。
  <info>int</info>  <strong>$year</strong>   年を表す、-4713 から 9999 までの数値。

<comment>Return:</comment>
  <info>int</info>  指定したユリウス暦の日付に対応するユリウス積算日を返します。

<comment>See Also:</comment>
   * <strong>jdtojulian()</strong>
   * <strong>cal_to_jd()</strong>


id: key
type: function
doc:
<comment>Description:</comment>
  配列からキーを取り出す
  
  <strong>key()</strong> は、 現在の配列位置における連想配列要素のキーを返します。

<comment>Param:</comment>
  <info>array|object</info>  <strong>$array</strong>  配列。

<comment>Return:</comment>
  <info>int|string|null</info>  <strong>key()</strong> 関数は、内部ポインタが現在指している配列要素のキーを返します。 ポインタを移
                   動することはありません。内部ポインタが要素リストの末尾にいる場合や配列が空の場合
                   は <strong>key()</strong> は <info>null</info> を返します。

<comment>See Also:</comment>
   * <strong>current()</strong>
   * <strong>next()</strong>
   * <strong>array_key_first()</strong>
   * foreach


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


id: krsort
type: function
doc:
<comment>Description:</comment>
  配列をキーで降順にソートする
  
  <strong>$array</strong> をキーで降順にソートします。
  
  比較結果が等しくなる二つの要素があった場合、それらの並び順は保持されます。PHP 8.0.0 より前のバー
  ジョンでは、ソートした配列におけるそれらの並び順は不定でした。
  
  この関数をコールすると、配列の内部ポインタは最初の要素にリセットされます。

<comment>Param:</comment>
  <info>array</info>  <strong>$array</strong>  入力の配列。
  <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>
   * <strong>sort()</strong>
   * <strong>ksort()</strong>
   * 配列ソート関数の比較


id: ksort
type: function
doc:
<comment>Description:</comment>
  配列をキーで昇順にソートする
  
  <strong>$array</strong> をキーで昇順にソートします。
  
  比較結果が等しくなる二つの要素があった場合、それらの並び順は保持されます。PHP 8.0.0 より前のバー
  ジョンでは、ソートした配列におけるそれらの並び順は不定でした。
  
  この関数をコールすると、配列の内部ポインタは最初の要素にリセットされます。

<comment>Param:</comment>
  <info>array</info>  <strong>$array</strong>  入力の配列。
  <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>
   * <strong>sort()</strong>
   * <strong>krsort()</strong>
   * 配列ソート関数の比較


id: lcfirst
type: function
doc:
<comment>Description:</comment>
  文字列の最初の文字を小文字にする
  
  <strong>$string</strong> の最初の文字が ASCII の <return>"A"</return> (0x41) から <return>"Z"</return> (0x5a) までの範囲にあれば、 それを小文字にしま
  す。

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  入力文字列。

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

<comment>See Also:</comment>
   * <strong>ucfirst()</strong>
   * <strong>strtolower()</strong>
   * <strong>strtoupper()</strong>
   * <strong>ucwords()</strong>


id: lcg_value
type: function
doc:
<comment>Description:</comment>
  複合線形合同法
  
  <strong>lcg_value()</strong> は、(0, 1)の範囲の疑似乱数を返します。 この関数は、周期が 2^31 - 85 および 2^31 - 249
  の 2 つの CG を組み合わせます。 この関数の周期はこれら 2 つの素数の積と等価です。
  
  この関数が生成する値は、暗号学的にセキュアではありません。そのため、これを暗号や、戻り値を推測でき
  ないことが必須の値として使っては いけません。
  
  暗号学的にセキュアな乱数が必要な場合は、<class>Random\Randomizer</class> を <class>Random\Engine\Secure</class> と一緒に使いま
  しょう。簡単なユースケースの場合、<strong>random_int()</strong> と <strong>random_bytes()</strong> 関数が、オペレーティングシステム
  の CSPRNG を使った、 便利で安全な API を提供します。
  
  乗算や加算(いわゆるアフィン変換)を使って、この関数の戻り値を異なる区間に拡大/縮小すると、結果の値
  に偏りが出るかもしれません。なぜなら、浮動小数点数は数直線上で均一に分布するわけではないからです。
  全ての値が浮動小数点数によって正確に表現できるとは限らないので、アフィン変換の結果が求める区間から
  外れた値になってしまう可能性もあります。
  
  任意の区間内で、ランダムな浮動小数点数の値を生成する場合、 Random\Randomizer::getFloat を使いま
  しょう。 任意の区間内で、ランダムな整数の値を生成する場合、 Random\Randomizer::getInt を使いましょ
  う。

<comment>Return:</comment>
  <info>float</info>  0.0 と 1.0 の範囲の疑似乱数(0.0 と 1.0 を含みます)を、 浮動小数点数で返します。

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


id: lchgrp
type: function
doc:
<comment>Description:</comment>
  シンボリックリンクのグループ所有権を変更する
  
  シンボリックリンク <strong>$filename</strong> のグループを <strong>$group</strong> に変更しようと試みます。
  
  スーバーユーザーは、 シンボリックリンクのグループを任意のものに変更できます。 その他のユーザーは、
  自分自身がメンバーの一員となっているグループにのみ変更できます。

<comment>Param:</comment>
  <info>string</info>      <strong>$filename</strong>  シンボリックリンクへのパス。
  <info>string|int</info>  <strong>$group</strong>     グループ名あるいはグループ番号。

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

<comment>See Also:</comment>
   * <strong>chgrp()</strong>
   * <strong>lchown()</strong>
   * <strong>chown()</strong>
   * <strong>chmod()</strong>


id: lchown
type: function
doc:
<comment>Description:</comment>
  シンボリックリンクの所有者を変更する
  
  シンボリックリンク <strong>$filename</strong> の所有者を <strong>$user</strong> に変更しようと試みます。
  
  シンボリックリンクの所有者を変更できるのは、スーパーユーザーのみです。

<comment>Param:</comment>
  <info>string</info>      <strong>$filename</strong>  ファイルへのパス。
  <info>string|int</info>  <strong>$user</strong>      ユーザー名あるいはユーザー番号。

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

<comment>See Also:</comment>
   * <strong>chown()</strong>
   * <strong>lchgrp()</strong>
   * <strong>chgrp()</strong>
   * <strong>chmod()</strong>


id: ldap_8859_to_t61
type: function
doc:
<comment>Description:</comment>
  8859 文字を t61 文字に変換する
  
  <return>ISO-8859</return> 文字を <return>t61</return> 文字に変換します。
  
  この関数は、 <return>LDAPv2</return> サーバーとやり取りしなければならない場合に有用です。

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>  変換するテキスト。

<comment>Return:</comment>
  <info>string|false</info>  <strong>$value</strong> を <return>t61</return> に変換したものを返します。 失敗した場合に <info>false</info> を返します

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


id: ldap_add
type: function
doc:
<comment>Description:</comment>
  LDAP ディレクトリにエントリを付加する
  
  エントリを LDAP ディレクトリに追加します。

<comment>Param:</comment>
  <info>LDAP\Connection</info>  <strong>$ldap</strong>      <strong>ldap_connect()</strong> が返す <class>LDAP\Connection</class> クラスのインスタンス。
  <info>string</info>           <strong>$dn</strong>        LDAP エンティティの識別名。
  <info>array</info>            <strong>$entry</strong>     そのエントリに関する情報を表す配列。 エントリの値は、個々の属性により
                              インデックスが作成されています。 ある属性に関して複数の値がある場合
                              は、0 から始まる整数で 添字が作成されます。  ]]>
  <info>array|null</info>       <strong>$controls</strong>  リクエストと一緒に送信する LDAP コントロール の配列

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

<comment>See Also:</comment>
   * <strong>ldap_add_ext()</strong>
   * <strong>ldap_delete()</strong>


id: ldap_add_ext
type: function
doc:
<comment>Description:</comment>
  LDAP ディレクトリにエントリを付加する
  
  <strong>ldap_add()</strong> と同じですが、 <strong>ldap_parse_result()</strong> を使ってパースされた結果を表す <class>LDAP\Result</class> クラスの
  インスタンスを返します。

<comment>Return:</comment>
  <info>LDAP\Result|false</info>  <class>LDAP\Result</class> クラスのインスタンスを返します。失敗した場合に <info>false</info> を返します

<comment>See Also:</comment>
   * <strong>ldap_add()</strong>
   * <strong>ldap_parse_result()</strong>


id: ldap_bind
type: function
doc:
<comment>Description:</comment>
  LDAP ディレクトリにバインドする
  
  指定した RDN およびパスワードを用いて LDAP ディレクトリにバインドします。

<comment>Param:</comment>
  <info>LDAP\Connection</info>  <strong>$ldap</strong>      <strong>ldap_connect()</strong> が返す <class>LDAP\Connection</class> クラスのインスタンス。
  <info>string|null</info>      <strong>$dn</strong>        
  <info>string|null</info>      <strong>$password</strong>  

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

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


id: ldap_bind_ext
type: function
doc:
<comment>Description:</comment>
  LDAP ディレクトリにバインドする
  
  <strong>ldap_bind()</strong> と同じですが、 <strong>ldap_parse_result()</strong> を使ってパースされた結果を表す <class>LDAP\Result</class> クラスの
  インスタンスを返します。

<comment>Return:</comment>
  <info>LDAP\Result|false</info>  <class>LDAP\Result</class> クラスのインスタンスを返します。失敗した場合に <info>false</info> を返します

<comment>See Also:</comment>
   * <strong>ldap_bind()</strong>
   * <strong>ldap_parse_result()</strong>


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


id: ldap_compare
type: function
doc:
<comment>Description:</comment>
  指定した DN のエントリで見付かった属性の値を比較する
  
  属性 <strong>$attribute</strong> の値 <strong>$value</strong> を、指定した LDAP ディレクトリエントリの同じ属性の値と比較します。

<comment>Param:</comment>
  <info>LDAP\Connection</info>  <strong>$ldap</strong>       <strong>ldap_connect()</strong> が返す <class>LDAP\Connection</class> クラスのインスタンス。
  <info>string</info>           <strong>$dn</strong>         LDAP エンティティの識別名。
  <info>string</info>           <strong>$attribute</strong>  属性の名前。
  <info>string</info>           <strong>$value</strong>      比較する値。
  <info>array|null</info>       <strong>$controls</strong>   リクエストと一緒に送信する LDAP コントロール の配列

<comment>Return:</comment>
  <info>bool|int</info>  <strong>$value</strong> がマッチする場合に <info>true</info>、その他の場合に <info>false</info>、エラーの場合に -1 を返します。


id: ldap_connect
type: function
doc:
<comment>Description:</comment>
  LDAP サーバーへ接続する
  
  PHP 8.3.0 以降では、次の シグネチャは推奨されなくなりました。
  
  <class>LDAP\Connection</class> クラスのインスタンスを作成し、指定した <strong>$uri</strong> が妥当であるかどうかを調べます。
  
  注意: この関数は、接続を確立するするわけでは ありません。 指定したパラメータが妥当であり、必要に応
  じて接続をオープンできるかどうかを調べるだけです。

<comment>Param:</comment>
  <info>string|null</info>  <strong>$uri</strong>   完全な LDAP URI を指定します。<return>ldap://hostname:port</return> 形式、あるいは SSL を用いる
                      場合は <return>ldaps://hostname:port</return> 形式が使えます。
                      
                      複数の LDAP URI を指定する場合は、間にスペースをはさんだひとつの文字列としま
                      す。
                      
                      <return>hostname:port</return> 形式は LDAP URI としてサポートされないことに注意しましょう。 ス
                      キーマが抜けているからです。
  <info>string|null</info>  <strong>$host</strong>  接続するホスト名
  <info>int</info>          <strong>$port</strong>  接続するポート。

<comment>Return:</comment>
  <info>LDAP\Connection|false</info>  LDAP URI が妥当であると思われる場合には <class>LDAP\Connection</class> クラスのインスタン
                         スを返します。 これは単なる構文チェックであり、実際にサーバーに接続するわけ
                         ではありません。 構文チェックに失敗した場合は <info>false</info> を返します。 失敗してい
                         ない場合は、<strong>ldap_connect()</strong> は常に <class>LDAP\Connection</class> クラスのインスタンスを返
                         しますが、 実際には接続せずにパラメータの初期化だけを行います。 実際に接続
                         するのは次に ldap_* 関数がコールされた際で、これは 通常は <strong>ldap_bind()</strong> で
                         す。
                         
                         引数が指定されない場合、既に開かれている接続を示す <class>LDAP\Connection</class> クラスの
                         インスタンスを返します。

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


id: ldap_connect_wallet
type: function
doc:
<comment>Description:</comment>
  LDAP サーバに接続する
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>string|null</info>  <strong>$uri</strong>        
  <info>string</info>       <strong>$wallet</strong>     
  <info>string</info>       <strong>$password</strong>   
  <info>int</info>          <strong>$auth_mode</strong>  

<comment>Return:</comment>
  <info>LDAP\Connection|false</info>  

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


id: ldap_control_paged_result
type: function
doc:
<comment>Description:</comment>
  LDAP ページネーション制御情報を送信する
  
  LDAP ページネーションを有効にするため、ページネーション制御情報 (ページサイズやクッキーなど) を送
  信します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>        <strong>ldap_connect()</strong> が返す LDAP リソース。
  <info>int</info>       <strong>$pagesize</strong>    ページあたりのエントリ数。
  <info>bool</info>      <strong>$iscritical</strong>  ページネーションを必須にするかどうか。 true にすると、もしサーバーがページ
                         ネーションに対応していなければ 検索結果を返しません。
  <info>string</info>    <strong>$cookie</strong>      サーバーから送られる opaque structure
                         (<strong>ldap_control_paged_result_response()</strong>)。

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

<comment>See Also:</comment>
   * <strong>ldap_control_paged_result_response()</strong>
   * RFC2696 : LDAP Control Extension for Simple
    Paged Results Manipulation


id: ldap_control_paged_result_response
type: function
doc:
<comment>Description:</comment>
  LDAP ページネーションクッキーを取得する
  
  サーバーから送られるページネーション情報を取得します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>       <strong>ldap_connect()</strong> が返す LDAP リソース。
  <info>resource</info>  <strong>$result</strong>     
  <info>string</info>    <strong>$cookie</strong>     サーバーから送られる opaque structure。
  <info>int</info>       <strong>$estimated</strong>  取得するエントリ数の予測。

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

<comment>See Also:</comment>
   * <strong>ldap_control_paged_result()</strong>
   * RFC2696 : LDAP Control Extension for Simple
    Paged Results Manipulation


id: ldap_count_entries
type: function
doc:
<comment>Description:</comment>
  検索結果のエントリ数を数える
  
  直前の検索結果として保存されたエントリの数を返します。

<comment>Param:</comment>
  <info>LDAP\Connection</info>  <strong>$ldap</strong>    <strong>ldap_connect()</strong> が返す <class>LDAP\Connection</class> クラスのインスタンス。
  <info>LDAP\Result</info>      <strong>$result</strong>  <strong>ldap_list()</strong> や <strong>ldap_search()</strong> が返す、<class>LDAP\Result</class> クラスのインスタンス。.

<comment>Return:</comment>
  <info>int</info>  結果のエントリ数を返します。 失敗した場合に <info>false</info> を返します


id: ldap_count_references
type: function
doc:
<comment>Description:</comment>
  検索結果に含まれる参照数を数える
  
  検索結果に含まれる参照数を数えます。

<comment>Param:</comment>
  <info>LDAP\Connection</info>  <strong>$ldap</strong>    <strong>ldap_connect()</strong> が返す <class>LDAP\Connection</class> クラスのインスタンス。
  <info>LDAP\Result</info>      <strong>$result</strong>  <strong>ldap_list()</strong> や <strong>ldap_search()</strong> が返す、<class>LDAP\Result</class> クラスのインスタンス。.

<comment>Return:</comment>
  <info>int</info>  検索結果に含まれる参照数を返します。

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


id: ldap_delete
type: function
doc:
<comment>Description:</comment>
  ディレクトリからエントリを削除する
  
  指定したエントリを LDAP ディレクトリから削除します。

<comment>Param:</comment>
  <info>LDAP\Connection</info>  <strong>$ldap</strong>      <strong>ldap_connect()</strong> が返す <class>LDAP\Connection</class> クラスのインスタンス。
  <info>string</info>           <strong>$dn</strong>        LDAP エンティティの識別名。
  <info>array|null</info>       <strong>$controls</strong>  リクエストと一緒に送信する LDAP コントロール の配列

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

<comment>See Also:</comment>
   * <strong>ldap_delete_ext()</strong>
   * <strong>ldap_add()</strong>


id: ldap_delete_ext
type: function
doc:
<comment>Description:</comment>
  ディレクトリからエントリを削除する
  
  <strong>ldap_delete()</strong> と同じですが、 <strong>ldap_parse_result()</strong> を使ってパースされた結果を表す <class>LDAP\Result</class> クラス
  のインスタンスを返します。

<comment>Return:</comment>
  <info>LDAP\Result|false</info>  <class>LDAP\Result</class> クラスのインスタンスを返します。失敗した場合に <info>false</info> を返します

<comment>See Also:</comment>
   * <strong>ldap_delete()</strong>
   * <strong>ldap_parse_result()</strong>


id: ldap_dn2ufn
type: function
doc:
<comment>Description:</comment>
  DN をユーザーに分かりやすい名前のフォーマットに変換する
  
  指定した <strong>$dn</strong> をよりユーザーにわかりやすい形式にするため、 型名を取り除きます。

<comment>Param:</comment>
  <info>string</info>  <strong>$dn</strong>  LDAP エンティティの識別名。

<comment>Return:</comment>
  <info>string|false</info>  ユーザーにわかりやすい形式の名前を返します。 失敗した場合に <info>false</info> を返します


id: ldap_err2str
type: function
doc:
<comment>Description:</comment>
  LDAP のエラー番号をエラーメッセージ文字列に変換する
  
  この関数は、エラー番号 <strong>$errno</strong> が意味する エラーメッセージ文字列を返します。LDAP errno 番号は標準化
  されていますが、 異なったライブラリでは、異なる（あるいはローカライズされた）エラーメッセージ が返
  されます。エラーメッセージの内容をチェックするのではなく、 必ずエラー番号をチェックするようにして
  ください。

<comment>Param:</comment>
  <info>int</info>  <strong>$errno</strong>  エラー番号。

<comment>Return:</comment>
  <info>string</info>  エラーメッセージを表す文字列を返します。

<comment>See Also:</comment>
   * <strong>ldap_errno()</strong>
   * <strong>ldap_error()</strong>


id: ldap_errno
type: function
doc:
<comment>Description:</comment>
  直近の LDAP コマンドの LDAP エラー番号を返す
  
  直近の LDAP コマンドにより返された、標準化されたエラー番号を返します。 この番号は、<strong>ldap_err2str()</strong>
  を用いてエラーメッセージ 文字列に変換することができます。

<comment>Param:</comment>
  <info>LDAP\Connection</info>  <strong>$ldap</strong>  <strong>ldap_connect()</strong> が返す <class>LDAP\Connection</class> クラスのインスタンス。

<comment>Return:</comment>
  <info>int</info>  このリンクに関する直近の LDAP コマンドの LDAP エラー番号を返します。

<comment>See Also:</comment>
   * <strong>ldap_err2str()</strong>
   * <strong>ldap_error()</strong>


id: ldap_error
type: function
doc:
<comment>Description:</comment>
  直近の LDAP コマンドの LDAP エラーメッセージを返す
  
  指定した <strong>$ldap</strong> に関して、 直近の LDAP コマンドにより生成されたエラーを表すエラーメッセージ文字列を
  返します。 LDAP errno 番号は標準化されていますが、ライブラリによって異なる （あるいはローカライズ
  された）エラーメッセージを返します。 エラーメッセージの内容をチェックするのではなく、 必ずエラー番
  号をチェックするようにしてください。
  
  php.ini で警告レベルを十分に下げるか、 警告出力を抑制するために LDAP コマンドの前に <return>@</return> 文字をつけな
  い限り、発生したエラーは HTML 出力にも表示されます。

<comment>Param:</comment>
  <info>LDAP\Connection</info>  <strong>$ldap</strong>  <strong>ldap_connect()</strong> が返す <class>LDAP\Connection</class> クラスのインスタンス。

<comment>Return:</comment>
  <info>string</info>  エラーメッセージ文字列を返します。

<comment>See Also:</comment>
   * <strong>ldap_err2str()</strong>
   * <strong>ldap_errno()</strong>


id: ldap_escape
type: function
doc:
<comment>Description:</comment>
  LDAP フィルタまたは DN で使われる文字列をエスケープする
  
  <strong>$flags</strong> で指示されたコンテキストで使う <strong>$value</strong> をエスケープします。

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>   エスケープする値
  <info>string</info>  <strong>$ignore</strong>  エスケープする際に無視する文字
  <info>int</info>     <strong>$flags</strong>   エスケープされた文字列が使われるコンテクスト: <info>LDAP_ESCAPE_FILTER</info> は、
                   <strong>ldap_search()</strong>, で使われるフィルタ。 <info>LDAP_ESCAPE_DN</info> は DN の場合に使います。 フラ
                   グが渡されなかった場合、全ての文字がエスケープされます。

<comment>Return:</comment>
  <info>string</info>  エスケープされた値を返します。


id: ldap_exop
type: function
doc:
<comment>Description:</comment>
  拡張されたオペレーションを実行する
  
  指定された <strong>$ldap</strong> で オペレーションの OID を <strong>$request_oid</strong> で指定し、 データを <strong>$request_data</strong> で指定
  して拡張されたオペレーションを実行します。

<comment>Param:</comment>
  <info>LDAP\Connection</info>  <strong>$ldap</strong>           <strong>ldap_connect()</strong> が返す <class>LDAP\Connection</class> クラスのインスタンス。
  <info>string</info>           <strong>$request_oid</strong>    拡張オペレーションリクエストのOID。 <info>LDAP_EXOP_START_TLS</info>,
                                   <info>LDAP_EXOP_MODIFY_PASSWD</info>, <info>LDAP_EXOP_REFRESH</info>, <info>LDAP_EXOP_WHO_AM_I</info>,
                                   <info>LDAP_EXOP_TURN</info> のいずれか、 または送信したい操作のOIDを示す文字
                                   列。
  <info>string</info>           <strong>$request_data</strong>   拡張オペレーションリクエストのデータ。 <info>LDAP_EXOP_WHO_AM_I</info> のよう
                                   に、 操作によってはNULLで問題ない場合もありますし、 BERエンコード
                                   が必要な場合もあります。
  <info>array</info>            <strong>$controls</strong>       リクエストと一緒に送信する LDAP コントロール の配列
  <info>string</info>           <strong>$response_data</strong>  この値を指定すると、拡張オペレーションレスポンスの値で埋められま
                                   す。 指定しなかった場合に後でこのデータを取得するには、 結果オブ
                                   ジェクトに対して ldap_parse_exop を使います。
  <info>string</info>           <strong>$response_oid</strong>   この値を指定すると、レスポンスのOIDで埋められます。 これは通常、
                                   リクエストのOIDと等しい値です。

<comment>Return:</comment>
  <info>mixed</info>  <strong>$response_data</strong> を指定した場合、成功時に <info>true</info> を返し、エラー時に <info>false</info> を返します。
         <strong>$response_data</strong> を指定しなかった場合、結果識別子を返し、 エラー時に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>ldap_parse_result()</strong>
   * <strong>ldap_parse_exop()</strong>
   * <strong>ldap_exop_whoami()</strong>
   * <strong>ldap_exop_refresh()</strong>
   * <strong>ldap_exop_passwd()</strong>


id: ldap_exop_passwd
type: function
doc:
<comment>Description:</comment>
  PASSWD 拡張オペレーションのヘルパ
  
  PASSWD 拡張オペレーションを実行します。

<comment>Param:</comment>
  <info>LDAP\Connection</info>  <strong>$ldap</strong>          <strong>ldap_connect()</strong> が返す <class>LDAP\Connection</class> クラスのインスタンス。
  <info>string</info>           <strong>$user</strong>          パスワードを変更するユーザーの dn
  <info>string</info>           <strong>$old_password</strong>  このユーザーの古いパスワード。 サーバーの設定によっては省略可能で
                                  す。
  <info>string</info>           <strong>$new_password</strong>  このユーザーの新しいパスワード。 生成されたパスワードがある場合
                                  は、空にするか省略できます。
  <info>array</info>            <strong>$controls</strong>      指定された場合は、パスワードポリシーをリクエストするコントロールが
                                  リクエストと一緒に送信されます。 その場合、この値は リクエストと一
                                  緒に送信する LDAP コントロール の配列 で埋められます。

<comment>Return:</comment>
  <info>string|bool</info>  <strong>$new_password</strong> が空だったり省略されたりした場合は、 生成されたパスワードが返されます。
               そうでなければ、成功時に <info>true</info> 、失敗時に <info>false</info> が返ります。

<comment>See Also:</comment>
   * <strong>ldap_exop()</strong>
   * <strong>ldap_parse_exop()</strong>


id: ldap_exop_refresh
type: function
doc:
<comment>Description:</comment>
  Refresh 拡張操作のヘルパ
  
  Refresh 拡張オペレーションを実行し、結果を返します。

<comment>Param:</comment>
  <info>LDAP\Connection</info>  <strong>$ldap</strong>  <strong>ldap_connect()</strong> が返す <class>LDAP\Connection</class> クラスのインスタンス。
  <info>string</info>           <strong>$dn</strong>    リフレッシュするエンティティの識別名。
  <info>int</info>              <strong>$ttl</strong>   自動的に削除される前にエントリがディレクトリに存在する時間を秒単位 (1 から
                          31557600 の間)で指定します。

<comment>Return:</comment>
  <info>int|false</info>  RFC から: responseTtl フィールドは、そのエントリのttlとしてサーバーが選んだ時間です。
             この値は、クライアントがリクエストした値よりも小さい値であってはいけませんが、 大きいの
             は構いません。 しかし、サーバーが比較的正確にディレクトリを維持できるようにするために、
             かつクライアントが動的な拡張を悪用できないようにするために、 サーバーはクライアントがリ
             クエストした ttl の値を 86400秒 (1日) まで短くすることを許可されています。 エラー時には
             <info>false</info> が返されます。

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


id: ldap_exop_sync
type: function
doc:
<comment>Description:</comment>
  拡張されたオペレーションを実行する
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>LDAP\Connection</info>  <strong>$ldap</strong>           <strong>ldap_connect()</strong> が返す <class>LDAP\Connection</class> クラスのインスタンス。
  <info>string</info>           <strong>$request_oid</strong>    
  <info>string</info>           <strong>$request_data</strong>   
  <info>array</info>            <strong>$controls</strong>       
  <info>string</info>           <strong>$response_data</strong>  
  <info>string</info>           <strong>$response_oid</strong>   

<comment>Return:</comment>
  <info>LDAP\Result|bool</info>  

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


id: ldap_exop_whoami
type: function
doc:
<comment>Description:</comment>
  WHOAMI 拡張オペレーションのヘルパ
  
  WHOAMI 拡張オペレーションを実行し、データを返します。

<comment>Param:</comment>
  <info>LDAP\Connection</info>  <strong>$ldap</strong>  <strong>ldap_connect()</strong> が返す <class>LDAP\Connection</class> クラスのインスタンス。

<comment>Return:</comment>
  <info>string|false</info>  サーバーが返したデータを返します。エラー時には <info>false</info> を返します。

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


id: ldap_explode_dn
type: function
doc:
<comment>Description:</comment>
  DN を構成要素ごとに分割する
  
  <strong>ldap_get_dn()</strong> により返された DN を分割し、 複数の要素に分けます。各部分は、相対区分名 (Relative
  Distinguished Name または RDN) と呼ばれます。

<comment>Param:</comment>
  <info>string</info>  <strong>$dn</strong>           LDAP エンティティの識別名。
  <info>int</info>     <strong>$with_attrib</strong>  RDN が値のみを返すのか、 あるいは、属性を同時に返すのかを指定するために使用
                        します。 属性を有する RDN (属性=値 フォーマットで) を得るためには
                        <strong>$with_attrib</strong> を 0 とし、 値のみを得るためには 1 に設定します。

<comment>Return:</comment>
  <info>array|false</info>  すべての DN 要素を配列で返します。失敗した場合に <info>false</info> を返します。 この配列の最初の
               要素のキーは <return>count</return> で、 これは返される値の数を表します。次の要素は、DN の数値添字配列
               となります。


id: ldap_first_attribute
type: function
doc:
<comment>Description:</comment>
  最初の属性を返す
  
  指定したエントリの最初の属性を取得します。残りの属性は、 <strong>ldap_next_attribute()</strong> を逐次コールして取
  得します。
  
  エントリの読み込みと同様、 エントリからの属性の読み込みもひとつづつ行われます。

<comment>Param:</comment>
  <info>LDAP\Connection</info>   <strong>$ldap</strong>   <strong>ldap_connect()</strong> が返す <class>LDAP\Connection</class> クラスのインスタンス。
  <info>LDAP\ResultEntry</info>  <strong>$entry</strong>  <class>LDAP\ResultEntry</class> クラスのインスタンス。

<comment>Return:</comment>
  <info>string|false</info>  成功した場合にエントリの最初の属性、エラーの場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>ldap_next_attribute()</strong>
   * <strong>ldap_get_attributes()</strong>


id: ldap_first_entry
type: function
doc:
<comment>Description:</comment>
  最初の結果 ID を返す
  
  結果内の最初のエントリのエントリ ID を返します。このエントリ ID を <strong>ldap_next_entry()</strong> に渡し、 結果
  からそれ以降のエントリを取得します。
  
  LDAP 結果におけるエントリは、<strong>ldap_first_entry()</strong> および <strong>ldap_next_entry()</strong> 関数を用いて連続的に 読み
  込まれます。

<comment>Param:</comment>
  <info>LDAP\Connection</info>  <strong>$ldap</strong>    <strong>ldap_connect()</strong> が返す <class>LDAP\Connection</class> クラスのインスタンス。
  <info>LDAP\Result</info>      <strong>$result</strong>  <strong>ldap_list()</strong> や <strong>ldap_search()</strong> が返す、<class>LDAP\Result</class> クラスのインスタンス。.

<comment>Return:</comment>
  <info>LDAP\ResultEntry|false</info>  成功時に、最初のエントリに関する結果エントリを表す、 <class>LDAP\ResultEntry</class> クラ
                          スのインスタンスを返します。 失敗した場合に <info>false</info> を返します

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


id: ldap_first_reference
type: function
doc:
<comment>Description:</comment>
  最初のリファレンスを返す
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>LDAP\ResultEntry|false</info>  


id: ldap_free_result
type: function
doc:
<comment>Description:</comment>
  結果メモリを開放する
  
  内部での結果保持用に割り当てられていたメモリを開放します。 結果メモリは、スクリプトの終了時に自動
  的に開放されます。
  
  通常、LDAP の結果用に確保された全てのメモリはスクリプトの実行終了時 に開放されます。連続的な検索を
  行うスクリプトのように大きな 結果セットを返す場合、スクリプトにより使用される実行用メモリを 小さく
  保つために <strong>ldap_free_result()</strong>  をコールすることが可能です。

<comment>Param:</comment>
  <info>LDAP\Result</info>  <strong>$result</strong>  <strong>ldap_list()</strong> や <strong>ldap_search()</strong> が返す、<class>LDAP\Result</class> クラスのインスタンス。.

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


id: ldap_get_attributes
type: function
doc:
<comment>Description:</comment>
  検索結果エントリから属性を得る
  
  検索結果エントリから属性と値を読み込みます。
  
  ディレクトリに特定のエントリを置いている場合、この関数をコールする ことにより、そのエントリに関し
  て保持されている情報得ることができます。 ディレクトリエントリを "ブラウズ" するか、ディレクトリエ
  ントリの 構造が未知であるアプリケーションにおいてこの関数を使用します。 多くのアプリケーションにお
  いては、電子メールアドレスや姓のような 特定の属性を検索するため、保持されている他のデータにどんな
  ものがあるか ということは問題にならないと思われます。

<comment>Param:</comment>
  <info>LDAP\Connection</info>   <strong>$ldap</strong>   <strong>ldap_connect()</strong> が返す <class>LDAP\Connection</class> クラスのインスタンス。
  <info>LDAP\ResultEntry</info>  <strong>$entry</strong>  <class>LDAP\ResultEntry</class> クラスのインスタンス。

<comment>Return:</comment>
  <info>array</info>  完全なエントリ情報を多次元配列で返します。

<comment>See Also:</comment>
   * <strong>ldap_first_attribute()</strong>
   * <strong>ldap_next_attribute()</strong>


id: ldap_get_dn
type: function
doc:
<comment>Description:</comment>
  結果エントリから DN を得る
  
  結果における、あるエントリの DN を見つけます。

<comment>Param:</comment>
  <info>LDAP\Connection</info>   <strong>$ldap</strong>   <strong>ldap_connect()</strong> が返す <class>LDAP\Connection</class> クラスのインスタンス。
  <info>LDAP\ResultEntry</info>  <strong>$entry</strong>  <class>LDAP\ResultEntry</class> クラスのインスタンス。

<comment>Return:</comment>
  <info>string|false</info>  結果エントリの DN を返します。エラーの場合、<info>false</info>を返します。


id: ldap_get_entries
type: function
doc:
<comment>Description:</comment>
  全ての結果エントリを得る
  
  指定した結果から複数のエントリを読み込み、 その属性および複数の値を読み込みます。

<comment>Param:</comment>
  <info>LDAP\Connection</info>  <strong>$ldap</strong>    <strong>ldap_connect()</strong> が返す <class>LDAP\Connection</class> クラスのインスタンス。
  <info>LDAP\Result</info>      <strong>$result</strong>  <strong>ldap_list()</strong> や <strong>ldap_search()</strong> が返す、<class>LDAP\Result</class> クラスのインスタンス。.

<comment>Return:</comment>
  <info>array|false</info>  成功時に完全な結果情報を多次元配列で返します。 失敗した場合に <info>false</info> を返します
               
               配列の構造は次のようになります。 属性インデックスは、小文字に変換されます (属性は大文
               字小文字を区別しませんが、配列インデックスとして使用する時は別です)。

<comment>See Also:</comment>
   * <strong>ldap_first_entry()</strong>
   * <strong>ldap_next_entry()</strong>


id: ldap_get_option
type: function
doc:
<comment>Description:</comment>
  指定したオプションの現在の値を得る
  
  <strong>$value</strong> を、指定したオプションの値として設定します。

<comment>Param:</comment>
  <info>LDAP\Connection</info>   <strong>$ldap</strong>    <strong>ldap_connect()</strong> が返す <class>LDAP\Connection</class> クラスのインスタンス。
  <info>int</info>               <strong>$option</strong>  パラメータ <strong>$option</strong> は以下のいずれかとなります。 オプション型利用可能に
                             なったバージョン
                             <info>LDAP_OPT_DEREF</info><info>int</info><info>LDAP_OPT_SIZELIMIT</info><info>int</info><info>LDAP_OPT_TIMELIMIT</info><info>int</info><info>LDAP_OPT_NETWORK_TIMEOUT</info><info>int</info><info>LDAP_OPT_PROTOCOL_VERSION</info><info>int</info><info>LDAP_OPT_ERROR_NUMBER</info><info>int</info><info>LDAP_OPT_DIAGNOSTIC_MESSAGE</info><info>string</info><info>LDAP_OPT_REFERRALS</info><info>int</info><info>LDAP_OPT_RESTART</info><info>int</info><info>LDAP_OPT_HOST_NAME</info><info>string</info><info>LDAP_OPT_ERROR_STRING</info><info>string</info><info>LDAP_OPT_MATCHED_DN</info><info>string</info><info>LDAP_OPT_SERVER_CONTROLS</info><info>array</info><info>LDAP_OPT_CLIENT_CONTROLS</info><info>array</info><info>LDAP_OPT_X_KEEPALIVE_IDLE</info><info>int</info>7.1<info>LDAP_OPT_X_KEEPALIVE_PROBES</info><info>int</info>7.1<info>LDAP_OPT_X_KEEPALIVE_INTERVAL</info><info>int</info>7.1<info>LDAP_OPT_X_TLS_CACERTDIR</info><info>string</info>7.1<info>LDAP_OPT_X_TLS_CACERTFILE</info><info>string</info>7.1<info>LDAP_OPT_X_TLS_CERTFILE</info><info>string</info>7.1<info>LDAP_OPT_X_TLS_CIPHER_SUITE</info><info>string</info>7.1<info>LDAP_OPT_X_TLS_CRLCHECK</info><info>int</info>7.1<info>LDAP_OPT_X_TLS_CRL_NONE</info><info>int</info>7.1<info>LDAP_OPT_X_TLS_CRL_PEER</info><info>int</info>7.1<info>LDAP_OPT_X_TLS_CRL_ALL</info><info>int</info>7.1<info>LDAP_OPT_X_TLS_CRLFILE</info><info>string</info>7.1<info>LDAP_OPT_X_TLS_DHFILE</info><info>string</info>7.1<info>LDAP_OPT_X_TLS_KEYFILE</info><info>string</info>7.1<info>LDAP_OPT_X_TLS_PACKAGE</info><info>string</info>7.1<info>LDAP_OPT_X_TLS_PROTOCOL_MIN</info><info>int</info>7.1<info>LDAP_OPT_X_TLS_RANDOM_FILE</info><info>string</info>7.1<info>LDAP_OPT_X_TLS_REQUIRE_CERT</info><info>int</info>
  <info>array|string|int</info>  <strong>$value</strong>   これが、オプションの値として設定されます。

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

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


id: ldap_get_values
type: function
doc:
<comment>Description:</comment>
  結果エントリから全ての値を得る
  
  結果内のエントリ属性の、すべての値を読み込みます。
  
  この関数をコールするには、<strong>$entry</strong> が必要です。このため、事前に LDAP の検索用関数のコールと個々の エ
  ントリ取得用関数のコールを行っておく必要があります。
  
  アプリケーションでは、("surname" または "mail" のような)特定の属性 を探すためにその属性をコードに
  埋め込んで置くか、さもなくば、指定した エントリに関して存在する属性を調べるために
  <strong>ldap_get_attributes()</strong> をコールする必要があります。

<comment>Param:</comment>
  <info>LDAP\Connection</info>   <strong>$ldap</strong>       <strong>ldap_connect()</strong> が返す <class>LDAP\Connection</class> クラスのインスタンス。
  <info>LDAP\ResultEntry</info>  <strong>$entry</strong>      <class>LDAP\ResultEntry</class> クラスのインスタンス。
  <info>string</info>            <strong>$attribute</strong>  

<comment>Return:</comment>
  <info>array|false</info>  成功した場合、指定した属性に関する値を配列を返します。エラーの場合は <info>false</info> を返しま
               す。値の数を調べるには、結果の配列の "count" という要素を確認します。個々の値にアクセ
               スするには、 整数値のインデックスを指定して配列にアクセスします。 最初のインデックス
               は 0 となります。
               
               LDAP では、ある属性に関して複数のエントリを持つことが可能です。 このため、たとえば一
               人の人間のディレクトリエントリに多数の 電子メールアドレスがあったとしても、それらをす
               べて "mail" という属性で管理することができます。  return_value["count"] = 属性の値の
               数 return_value[0] = 属性の最初の値 return_value[i] = 属性の i 番目の値

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


id: ldap_get_values_len
type: function
doc:
<comment>Description:</comment>
  結果エントリから全てのバイナリ値を得る
  
  結果のエントリから、属性のすべての値を読み込みます。
  
  この関数は、文字列データではなくバイナリデータを処理すること以外は、 <strong>ldap_get_values()</strong> と全く同じ
  です。

<comment>Param:</comment>
  <info>LDAP\Connection</info>   <strong>$ldap</strong>       <strong>ldap_connect()</strong> が返す <class>LDAP\Connection</class> クラスのインスタンス。
  <info>LDAP\ResultEntry</info>  <strong>$entry</strong>      <class>LDAP\ResultEntry</class> クラスのインスタンス。
  <info>string</info>            <strong>$attribute</strong>  

<comment>Return:</comment>
  <info>array|false</info>  成功時に属性の値を配列で返し、エラー時に <info>false</info> を返します。 個々の値は、配列インデッ
               クスによりアクセスします。最初のインデックスは、0 です。 値の数は、結果の配列の
               "count" という要素で知ることができます。

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


id: ldap_list
type: function
doc:
<comment>Description:</comment>
  単一階層の検索を行う
  
  指定したフィルタ <strong>$filter</strong> を使用し、スコープ <info>LDAP_SCOPE_ONELEVEL</info> でディレクトリを検索します。
  
  <info>LDAP_SCOPE_ONELEVEL</info> は、コール時に指定した <strong>$base</strong> の直下の階層から検索した結果のみを返すことを表し
  ます ("ls" と入力して、現在の作業ディレクトリのファイル/フォルダ 一覧を取得するのと同じようなもの
  です)。
  
  並列検索も可能です。並列検索を行うには、単一の <class>LDAP\Connection</class> のインスタンスではなく、それの配列
  を使用します。同じベース DN を使用したくない場合や全ての検索について同じフィルタを使用したくない場
  合、ベース DN の配列またはフィルタの配列を使用することが可能です。これらの配列は、<class>LDAP\Connection</class>
  の配列と同じ大きさである必要があります。これは、その配列の最初が一回の検索で使用され、2 番目のエン
  トリが他の検索で使用されるといったようになるからです。並列検索を実行する際、エラーの場合を除き、
  <class>LDAP\Result</class> の配列が返されます。エラーの場合は、返される値は <info>false</info> になります。

<comment>Param:</comment>
  <info>LDAP\Connection|array</info>  <strong>$ldap</strong>             <strong>ldap_connect()</strong> が返す <class>LDAP\Connection</class> クラスのインスタン
                                           ス。
  <info>array|string</info>           <strong>$base</strong>             ディレクトリのベース DN。
  <info>array|string</info>           <strong>$filter</strong>           
  <info>array</info>                  <strong>$attributes</strong>       必要な属性を、 array("mail", "sn", "cn") のような通常の
                                           PHP 文字列配列で保持します。 "dn" は要求された属性の型に
                                           よらず常に返されることに注意してください。
                                           
                                           このパラメータを使用すると、デフォルトの動作よりもかなり
                                           効率的になります (デフォルトでは、すべての属性とその値を
                                           返します)。 したがって、これを使用することを推奨します。
  <info>int</info>                    <strong>$attributes_only</strong>  属性の型のみを取得したい場合は 1 を設定します。 属性の型
                                           および値の両方を取得したい場合は 0 を設定します (これがデ
                                           フォルトの挙動です)。
  <info>int</info>                    <strong>$sizelimit</strong>        取得するエントリ数の制限を設定します。 0 は無制限であるこ
                                           とを表します。
                                           
                                           このパラメータは、サーバー側で事前に設定されている
                                           sizelimit を上書きすることはできません。それ以下の値を指
                                           定することはできます。
                                           
                                           ディレクトリサーバーのホストによっては、 事前に設定された
                                           数以上のエントリを返さないようになっているものもありま
                                           す。 この場合、サーバーでは、それが結果セットのすべてでは
                                           ないことを通知します。 このパラメータでエントリ数を制限し
                                           た場合にも、同じことが起こります。
  <info>int</info>                    <strong>$timelimit</strong>        検索に要する最大秒数を設定します。 これを 0 にすると無制
                                           限であることを表します。
                                           
                                           このパラメータは、サーバー側で事前に設定されている
                                           timelimit を上書きすることはできません。それ以下の値を指
                                           定することはできます。
  <info>int</info>                    <strong>$deref</strong>            検索時のエイリアスの扱いについて指定します。 以下のいずれ
                                           かとなります。 <info>LDAP_DEREF_NEVER</info> - (デフォルト) エイリアス
                                           は参照されません。 <info>LDAP_DEREF_SEARCHING</info> - エイリアスを参
                                           照しますが、検索のベースオブジェクト上にいるときは参照し
                                           ません。 <info>LDAP_DEREF_FINDING</info> - エイリアスの参照は、ベース
                                           オブジェクト上にいて検索中でない場合に行われます。
                                           <info>LDAP_DEREF_ALWAYS</info> - エイリアスを常に参照します。
                                           
                                           <info>LDAP_DEREF_NEVER</info> - (デフォルト) エイリアスは参照されませ
                                           ん。
                                           
                                           <info>LDAP_DEREF_SEARCHING</info> - エイリアスを参照しますが、検索の
                                           ベースオブジェクト上にいるときは参照しません。
                                           
                                           <info>LDAP_DEREF_FINDING</info> - エイリアスの参照は、ベースオブジェク
                                           ト上にいて検索中でない場合に行われます。
                                           
                                           <info>LDAP_DEREF_ALWAYS</info> - エイリアスを常に参照します。
  <info>array|null</info>             <strong>$controls</strong>         リクエストと一緒に送信する LDAP コントロール の配列

<comment>Return:</comment>
  <info>LDAP\Result|array|false</info>  <class>LDAP\Result</class> のインスタンスか、<class>LDAP\Result</class> のインスタンスの配列を返しま
                           す。失敗した場合に <info>false</info> を返します

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


id: ldap_mod_add
type: function
doc:
<comment>Description:</comment>
  現在の属性に属性を追加する
  
  指定した <strong>$dn</strong> に属性を追加します。 新しいオブジェクト全体を追加する用途については、 <strong>ldap_add()</strong> 関数
  を参照ください。

<comment>Param:</comment>
  <info>LDAP\Connection</info>  <strong>$ldap</strong>      <strong>ldap_connect()</strong> が返す <class>LDAP\Connection</class> クラスのインスタンス。
  <info>string</info>           <strong>$dn</strong>        LDAP エンティティの識別名。
  <info>array</info>            <strong>$entry</strong>     追加する属性値を一覧にした連想配列。 属性が存在しない場合は追加されま
                              す。 属性が存在する場合は、その属性が複数の値をサポートしている場合の
                              み追加できます。
  <info>array|null</info>       <strong>$controls</strong>  リクエストと一緒に送信する LDAP コントロール の配列

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

<comment>See Also:</comment>
   * <strong>ldap_mod_add_ext()</strong>
   * <strong>ldap_mod_del()</strong>
   * <strong>ldap_mod_replace()</strong>
   * <strong>ldap_modify_batch()</strong>


id: ldap_mod_add_ext
type: function
doc:
<comment>Description:</comment>
  現在の属性に属性を追加する
  
  <strong>ldap_mod_add()</strong> と同じですが、 <strong>ldap_parse_result()</strong> を使ってパースされた LDAP 結果を表す <class>LDAP\Result</class>
  クラスのインスタンスを返します。

<comment>Return:</comment>
  <info>LDAP\Result|false</info>  <class>LDAP\Result</class> クラスのインスタンスを返します。失敗した場合に <info>false</info> を返します

<comment>See Also:</comment>
   * <strong>ldap_mod_add()</strong>
   * <strong>ldap_parse_result()</strong>


id: ldap_mod_del
type: function
doc:
<comment>Description:</comment>
  現在の属性から属性を削除する
  
  ひとつあるいは複数の属性を、指定した <strong>$dn</strong> から削除します。 オブジェクトレベルの削除は、
  <strong>ldap_delete()</strong> 関数により行います。

<comment>Param:</comment>
  <info>LDAP\Connection</info>  <strong>$ldap</strong>      <strong>ldap_connect()</strong> が返す <class>LDAP\Connection</class> クラスのインスタンス。
  <info>string</info>           <strong>$dn</strong>        LDAP エンティティの識別名。
  <info>array</info>            <strong>$entry</strong>     
  <info>array|null</info>       <strong>$controls</strong>  リクエストと一緒に送信する LDAP コントロール の配列

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

<comment>See Also:</comment>
   * <strong>ldap_mod_del_ext()</strong>
   * <strong>ldap_mod_add()</strong>
   * <strong>ldap_mod_replace()</strong>
   * <strong>ldap_modify_batch()</strong>


id: ldap_mod_del_ext
type: function
doc:
<comment>Description:</comment>
  現在の属性から属性を削除する
  
  <strong>ldap_mod_del()</strong> と同じですが、 <strong>ldap_parse_result()</strong> を使ってパースされた LDAP 結果を表す <class>LDAP\Result</class>
  クラスのインスタンスを返します。

<comment>Return:</comment>
  <info>LDAP\Result|false</info>  <class>LDAP\Result</class> クラスのインスタンスを返します。失敗した場合に <info>false</info> を返します

<comment>See Also:</comment>
   * <strong>ldap_mod_del()</strong>
   * <strong>ldap_parse_result()</strong>


id: ldap_mod_replace
type: function
doc:
<comment>Description:</comment>
  属性を新規の値に置換する
  
  指定した <strong>$dn</strong> でひとつあるいは複数の属性の置換を行います。 この関数は、属性の追加や削除も行えます。

<comment>Param:</comment>
  <info>LDAP\Connection</info>  <strong>$ldap</strong>      <strong>ldap_connect()</strong> が返す <class>LDAP\Connection</class> クラスのインスタンス。
  <info>string</info>           <strong>$dn</strong>        LDAP エンティティの識別名。
  <info>array</info>            <strong>$entry</strong>     置き換える属性を一覧にした連想配列。 空の配列を送ると、属性そのものが
                              削除されます。 一方で、属性が存在していない値を送ると追加されます。
  <info>array|null</info>       <strong>$controls</strong>  リクエストと一緒に送信する LDAP コントロール の配列

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

<comment>See Also:</comment>
   * <strong>ldap_mod_replace_ext()</strong>
   * <strong>ldap_mod_del()</strong>
   * <strong>ldap_mod_add()</strong>
   * <strong>ldap_modify_batch()</strong>


id: ldap_mod_replace_ext
type: function
doc:
<comment>Description:</comment>
  属性を新規の値に置換する
  
  <strong>ldap_mod_replace()</strong> と同じですが、 <strong>ldap_parse_result()</strong> を使ってパースされた LDAP 結果を表す
  <class>LDAP\Result</class> クラスのインスタンスを返します。

<comment>Return:</comment>
  <info>LDAP\Result|false</info>  <class>LDAP\Result</class> クラスのインスタンスを返します。失敗した場合に <info>false</info> を返します

<comment>See Also:</comment>
   * <strong>ldap_mod_replace()</strong>
   * <strong>ldap_parse_result()</strong>


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

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


id: ldap_modify_batch
type: function
doc:
<comment>Description:</comment>
  LDAP エントリの変更をまとめて実行する
  
  LDAP ディレクトリに存在する既存のエントリを変更します。 実行する変更の詳細な仕様を指定できます。

<comment>Param:</comment>
  <info>LDAP\Connection</info>  <strong>$ldap</strong>                <strong>ldap_connect()</strong> で返された、LDAP リソース。
  <info>string</info>           <strong>$dn</strong>                  LDAP エンティティの識別名。
  <info>array</info>            <strong>$modifications_info</strong>  行う変更を指定する配列。 この配列の個々のエントリは、2つまた
                                        は3つのキーからなる連想配列です: <return>attrib</return> は、変更する属性の名
                                        前に対応します。 <return>modtype</return> は、行う変更のタイプに対応し、 (変
                                        更のタイプによっては) <return>values</return> が変更に関連した属性値の配列に
                                        対応します。
                                        
                                        <return>modtype</return> で有効な値は以下のとおりです:
                                        <info>LDAP_MODIFY_BATCH_ADD</info><return>values</return> で指定された値が、 (追加の値とし
                                        て) <return>attrib</return> で指定された属性に追加されます。
                                        <info>LDAP_MODIFY_BATCH_REMOVE</info><return>values</return> で指定された値が、 <return>attrib</return> で
                                        指定された属性から削除されます。 <return>values</return> に含まれていない属性
                                        の値は、そのまま残されます。
                                        <info>LDAP_MODIFY_BATCH_REMOVE_ALL</info><return>attrib</return> で指定された属性名から、
                                        全ての値を削除します。 <return>values</return> エントリを指定してはいけませ
                                        ん。 <info>LDAP_MODIFY_BATCH_REPLACE</info><return>attrib</return> の属性名の現在の全ての
                                        値が、 <return>values</return> で指定された値で置き換えられます。
                                        
                                        <return>values</return> で指定された値が、 (追加の値として) <return>attrib</return> で指定され
                                        た属性に追加されます。
                                        
                                        <return>values</return> で指定された値が、 <return>attrib</return> で指定された属性から削除さ
                                        れます。 <return>values</return> に含まれていない属性の値は、そのまま残されま
                                        す。
                                        
                                        <return>attrib</return> で指定された属性名から、全ての値を削除します。 <return>values</return>
                                        エントリを指定してはいけません。
                                        
                                        <return>attrib</return> の属性名の現在の全ての値が、 <return>values</return> で指定された値で
                                        置き換えられます。
                                        
                                        以下の点に注意してください: <return>attrib</return> の値は文字列でなければい
                                        けません。 <return>values</return> の値は、文字列の配列でなければいけません。
                                        そして、 <return>modtype</return> の値は、上で示した LDAP_MODIFY_BATCH_* 定数
                                        のうちのひとつでなければいけません。
  <info>array|null</info>       <strong>$controls</strong>            リクエストと一緒に送信する LDAP コントロール の配列

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


id: ldap_next_attribute
type: function
doc:
<comment>Description:</comment>
  結果における次の属性を得る
  
  エントリ内の属性を取得します。 最初に <strong>ldap_next_attribute()</strong> をコールした際には
  <strong>ldap_first_attribute()</strong> から返される <strong>$entry</strong> を使用します。

<comment>Param:</comment>
  <info>LDAP\Connection</info>   <strong>$ldap</strong>   <strong>ldap_connect()</strong> が返す <class>LDAP\Connection</class> クラスのインスタンス。
  <info>LDAP\ResultEntry</info>  <strong>$entry</strong>  <class>LDAP\ResultEntry</class> クラスのインスタンス。

<comment>Return:</comment>
  <info>string|false</info>  成功した場合、エントリにおける次の属性を返します。エラー時に <info>false</info> を返します。

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


id: ldap_next_entry
type: function
doc:
<comment>Description:</comment>
  次の結果エントリを得る
  
  結果に保持されたエントリを取得します。 連続的に <strong>ldap_next_entry()</strong> をコールした場合、 エントリがな
  くなるまでエントリを一つずつ返します。 <strong>ldap_next_entry()</strong> への最初のコールは、 <strong>ldap_first_entry()</strong>
  から返された <strong>$entry</strong> を指定してコールした後に、その結果を用いて行います。

<comment>Param:</comment>
  <info>LDAP\Connection</info>   <strong>$ldap</strong>   <strong>ldap_connect()</strong> が返す <class>LDAP\Connection</class> クラスのインスタンス。
  <info>LDAP\ResultEntry</info>  <strong>$entry</strong>  <class>LDAP\ResultEntry</class> クラスのインスタンス。

<comment>Return:</comment>
  <info>LDAP\ResultEntry|false</info>  <strong>ldap_first_entry()</strong> によりエントリが読み始められた 結果において、次のエント
                          リを表す <class>LDAP\ResultEntry</class> クラスのインスタンスを返します。 これ以上結果の
                          エントリがない場合は、<info>false</info> を返します。

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


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

<comment>Return:</comment>
  <info>LDAP\ResultEntry|false</info>  


id: ldap_parse_exop
type: function
doc:
<comment>Description:</comment>
  LDAP拡張オペレーションの結果オブジェクトをパースする
  
  LDAP拡張オペレーションの結果オブジェクト <strong>$result</strong> データをパースします。

<comment>Param:</comment>
  <info>LDAP\Connection</info>  <strong>$ldap</strong>           <strong>ldap_connect()</strong> が返す <class>LDAP\Connection</class> クラスのインスタンス。
  <info>LDAP\Result</info>      <strong>$result</strong>         <strong>ldap_list()</strong> や <strong>ldap_search()</strong> が返す、<class>LDAP\Result</class> クラスのインスタ
                                   ンス。.
  <info>string</info>           <strong>$response_data</strong>  レスポンスデータで埋められます。
  <info>string</info>           <strong>$response_oid</strong>   レスポンスのOIDで埋められます。

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

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


id: ldap_parse_reference
type: function
doc:
<comment>Description:</comment>
  参照エントリから情報を展開する
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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


id: ldap_parse_result
type: function
doc:
<comment>Description:</comment>
  結果から情報を展開する
  
  LDAP の検索結果をパースします。

<comment>Param:</comment>
  <info>LDAP\Connection</info>  <strong>$ldap</strong>           <strong>ldap_connect()</strong> が返す <class>LDAP\Connection</class> クラスのインスタンス。
  <info>LDAP\Result</info>      <strong>$result</strong>         <strong>ldap_list()</strong> や <strong>ldap_search()</strong> が返す、<class>LDAP\Result</class> クラスのインスタ
                                   ンス。.
  <info>int</info>              <strong>$error_code</strong>     結果に含まれる LDAP エラーコードを格納する変数への参照。 エラーが
                                   発生しなかった場合は、この変数に <return>0</return> を格納します。
  <info>string</info>           <strong>$matched_dn</strong>     リクエスト内にマッチする DN があった場合に、それを格納する変数へ
                                   の参照。 なかった場合は、この変数に <info>null</info> を格納します。
  <info>string</info>           <strong>$error_message</strong>  結果に含まれる LDAP エラーメッセージを格納する変数への参照。 エ
                                   ラーが発生しなかった場合は、この変数に空文字列を格納します。
  <info>array</info>            <strong>$referrals</strong>      結果に含まれるすべての照会文字列の配列を格納する変数への参照。 存
                                   在しない場合は、この変数に空の配列を格納します。
  <info>array</info>            <strong>$controls</strong>       レスポンスを送信した LDAP コントロール の <info>array</info>。

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


id: ldap_read
type: function
doc:
<comment>Description:</comment>
  エントリを読み込む
  
  指定したフィルタ <strong>$filter</strong> を使用し、スコープ <info>LDAP_SCOPE_BASE</info> でディレクトリを検索します。これは、
  ディレクトリからエントリを読み込むことと同じ意味です。
  
  並列検索も可能です。並列検索を行うには、単一の <class>LDAP\Connection</class> のインスタンスではなく、それの配列
  を使用します。同じベース DN を使用したくない場合や全ての検索について同じフィルタを使用したくない場
  合、ベース DN の配列またはフィルタの配列を使用することが可能です。これらの配列は、<class>LDAP\Connection</class>
  の配列と同じ大きさである必要があります。これは、その配列の最初が一回の検索で使用され、2 番目のエン
  トリが他の検索で使用されるといったようになるからです。並列検索を実行する際、エラーの場合を除き、
  <class>LDAP\Result</class> の配列が返されます。エラーの場合は、返される値は <info>false</info> になります。

<comment>Param:</comment>
  <info>LDAP\Connection|array</info>  <strong>$ldap</strong>             <strong>ldap_connect()</strong> が返す <class>LDAP\Connection</class> クラスのインスタン
                                           ス。
  <info>array|string</info>           <strong>$base</strong>             ディレクトリのベース DN。
  <info>array|string</info>           <strong>$filter</strong>           空のフィルタは指定できません。 このエントリに関する全ての
                                           情報を完全に取得したい場合は、 <return>objectClass=*</return> というフィル
                                           タを使用してください。 ディレクトリサーバーで使用されるエ
                                           ントリの型が分かっている場合、 <return>objectClass=inetOrgPerson</return>
                                           のように適切なフィルタを使用することができます。
  <info>array</info>                  <strong>$attributes</strong>       必要な属性を、 array("mail", "sn", "cn") のような通常の
                                           PHP 文字列配列で保持します。 "dn" は要求された属性の型に
                                           よらず常に返されることに注意してください。
                                           
                                           このパラメータを使用すると、デフォルトの動作よりもかなり
                                           効率的になります (デフォルトでは、すべての属性とその値を
                                           返します)。 したがって、これを使用することを推奨します。
  <info>int</info>                    <strong>$attributes_only</strong>  属性の型のみを取得したい場合は 1 を設定します。 属性の型
                                           および値の両方を取得したい場合は 0 を設定します (これがデ
                                           フォルトの挙動です)。
  <info>int</info>                    <strong>$sizelimit</strong>        取得するエントリ数の制限を設定します。 0 は無制限であるこ
                                           とを表します。
                                           
                                           このパラメータは、サーバー側で事前に設定されている
                                           sizelimit を上書きすることはできません。それ以下の値を指
                                           定することはできます。
                                           
                                           ディレクトリサーバーのホストによっては、 事前に設定された
                                           数以上のエントリを返さないようになっているものもありま
                                           す。 この場合、サーバーでは、それが結果セットのすべてでは
                                           ないことを通知します。 このパラメータでエントリ数を制限し
                                           た場合にも、同じことが起こります。
  <info>int</info>                    <strong>$timelimit</strong>        検索に要する最大秒数を設定します。 これを 0 にすると無制
                                           限であることを表します。
                                           
                                           このパラメータは、サーバー側で事前に設定されている
                                           timelimit を上書きすることはできません。それ以下の値を指
                                           定することはできます。
  <info>int</info>                    <strong>$deref</strong>            検索時のエイリアスの扱いについて指定します。 以下のいずれ
                                           かとなります。 <info>LDAP_DEREF_NEVER</info> - (デフォルト) エイリアス
                                           は参照されません。 <info>LDAP_DEREF_SEARCHING</info> - エイリアスを参
                                           照しますが、検索のベースオブジェクト上にいるときは参照し
                                           ません。 <info>LDAP_DEREF_FINDING</info> - エイリアスの参照は、ベース
                                           オブジェクト上にいて検索中でない場合に行われます。
                                           <info>LDAP_DEREF_ALWAYS</info> - エイリアスを常に参照します。 always.
                                           
                                           <info>LDAP_DEREF_NEVER</info> - (デフォルト) エイリアスは参照されませ
                                           ん。
                                           
                                           <info>LDAP_DEREF_SEARCHING</info> - エイリアスを参照しますが、検索の
                                           ベースオブジェクト上にいるときは参照しません。
                                           
                                           <info>LDAP_DEREF_FINDING</info> - エイリアスの参照は、ベースオブジェク
                                           ト上にいて検索中でない場合に行われます。
                                           
                                           <info>LDAP_DEREF_ALWAYS</info> - エイリアスを常に参照します。 always.
  <info>array|null</info>             <strong>$controls</strong>         リクエストと一緒に送信する LDAP コントロール の配列

<comment>Return:</comment>
  <info>LDAP\Result|array|false</info>  <class>LDAP\Result</class> のインスタンスか、<class>LDAP\Result</class> のインスタンスの配列を返しま
                           す。失敗した場合に <info>false</info> を返します


id: ldap_rename
type: function
doc:
<comment>Description:</comment>
  エントリ名を修正する
  
  <strong>$dn</strong> で指定したエントリについて、 名前の変更または移動を行います。

<comment>Param:</comment>
  <info>LDAP\Connection</info>  <strong>$ldap</strong>            <strong>ldap_connect()</strong> が返す <class>LDAP\Connection</class> クラスのインスタンス。
  <info>string</info>           <strong>$dn</strong>              LDAP エンティティの識別名。
  <info>string</info>           <strong>$new_rdn</strong>         新しい RDN。
  <info>string</info>           <strong>$new_parent</strong>      新しい親エントリ。
  <info>bool</info>             <strong>$delete_old_rdn</strong>  <info>true</info> の場合は古い RDN 値を削除します。それ以外の場合は古い RDN
                                    値がそのエントリの non-distinguished 値として残されます。
  <info>array|null</info>       <strong>$controls</strong>        リクエストと一緒に送信する LDAP コントロール の配列

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

<comment>See Also:</comment>
   * <strong>ldap_rename_ext()</strong>
   * <strong>ldap_modify()</strong>


id: ldap_rename_ext
type: function
doc:
<comment>Description:</comment>
  エントリ名を修正する
  
  <strong>ldap_rename()</strong> と同じですが、 <strong>ldap_parse_result()</strong> を使ってパースされた LDAP 結果 を表す <class>LDAP\Result</class>
  クラスのインスタンスを返します。

<comment>Return:</comment>
  <info>LDAP\Result|false</info>  <class>LDAP\Result</class> クラスのインスタンスを返します。失敗した場合に <info>false</info> を返します

<comment>See Also:</comment>
   * <strong>ldap_rename()</strong>
   * <strong>ldap_parse_result()</strong>


id: ldap_sasl_bind
type: function
doc:
<comment>Description:</comment>
  SASL を使用して LDAP ディレクトリにバインドする
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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


id: ldap_search
type: function
doc:
<comment>Description:</comment>
  LDAP ツリーを探索する
  
  指定したフィルタを使用し、 スコープ <info>LDAP_SCOPE_SUBTREE</info> でディレクトリを検索します。これは、ディレ
  クトリ全体を検索するのと同じ意味です。
  
  並列検索も可能です。並列検索を行うには、単一の <class>LDAP\Connection</class> のインスタンスではなく、それの配列
  を使用します。同じベース DN を使用したくない場合や全ての検索について同じフィルタを使用したくない場
  合、ベース DN の配列またはフィルタの配列を使用することが可能です。これらの配列は、<class>LDAP\Connection</class>
  の配列と同じ大きさである必要があります。これは、その配列の最初が一回の検索で使用され、2 番目のエン
  トリが他の検索で使用されるといったようになるからです。並列検索を実行する際、エラーの場合を除き、
  <class>LDAP\Result</class> の配列が返されます。エラーの場合は、返される値は <info>false</info> になります。

<comment>Param:</comment>
  <info>LDAP\Connection|array</info>  <strong>$ldap</strong>             <strong>ldap_connect()</strong> が返す <class>LDAP\Connection</class> クラスのインスタン
                                           ス。
  <info>array|string</info>           <strong>$base</strong>             ディレクトリのベース DN。
  <info>array|string</info>           <strong>$filter</strong>           検索フィルタは、LDAP ドキュメントに記述されたフォーマット
                                           の論理 演算子を用いて、簡単なものまたは高度なものとするこ
                                           とができます (フィルタに関する詳細な情報については、
                                           Netscape Directory SDK あるいは RFC4515 を参照ください)。
  <info>array</info>                  <strong>$attributes</strong>       必要な属性を、 <return>array("mail", "sn", "cn")</return> のような通常の
                                           PHP 文字列配列で保持します。 "dn" は要求された属性の型に
                                           よらず常に返されることに注意してください。
                                           
                                           このパラメータを使用すると、デフォルトの動作よりもかなり
                                           効率的になります (デフォルトでは、すべての属性とその値を
                                           返します)。 したがって、これを使用することを推奨します。
  <info>int</info>                    <strong>$attributes_only</strong>  属性の型のみを取得したい場合は 1 を設定します。 属性の型
                                           および値の両方を取得したい場合は 0 を設定します (これがデ
                                           フォルトの挙動です)。
  <info>int</info>                    <strong>$sizelimit</strong>        取得するエントリ数の制限を設定します。 0 は無制限であるこ
                                           とを表します。
                                           
                                           このパラメータは、サーバー側で事前に設定されている
                                           sizelimit を上書きすることはできません。それ以下の値を指
                                           定することはできます。
                                           
                                           ディレクトリサーバーのホストによっては、 事前に設定された
                                           数以上のエントリを返さないようになっているものもありま
                                           す。 この場合、サーバーでは、それが結果セットのすべてでは
                                           ないことを通知します。 このパラメータでエントリ数を制限し
                                           た場合にも、同じことが起こります。
  <info>int</info>                    <strong>$timelimit</strong>        検索に要する最大秒数を設定します。 これを 0 にすると無制
                                           限であることを表します。
                                           
                                           このパラメータは、サーバー側で事前に設定されている
                                           timelimit を上書きすることはできません。それ以下の値を指
                                           定することはできます。
  <info>int</info>                    <strong>$deref</strong>            検索時のエイリアスの扱いについて指定します。 以下のいずれ
                                           かとなります。 <info>LDAP_DEREF_NEVER</info> - (デフォルト) エイリアス
                                           は参照されません。 <info>LDAP_DEREF_SEARCHING</info> - エイリアスを参
                                           照しますが、検索のベースオブジェクト上にいるときは参照し
                                           ません。 <info>LDAP_DEREF_FINDING</info> - エイリアスの参照は、ベース
                                           オブジェクト上にいて検索中でない場合に行われます。
                                           <info>LDAP_DEREF_ALWAYS</info> - エイリアスを常に参照します。
                                           
                                           <info>LDAP_DEREF_NEVER</info> - (デフォルト) エイリアスは参照されませ
                                           ん。
                                           
                                           <info>LDAP_DEREF_SEARCHING</info> - エイリアスを参照しますが、検索の
                                           ベースオブジェクト上にいるときは参照しません。
                                           
                                           <info>LDAP_DEREF_FINDING</info> - エイリアスの参照は、ベースオブジェク
                                           ト上にいて検索中でない場合に行われます。
                                           
                                           <info>LDAP_DEREF_ALWAYS</info> - エイリアスを常に参照します。
  <info>array|null</info>             <strong>$controls</strong>         リクエストと一緒に送信する LDAP コントロール の配列

<comment>Return:</comment>
  <info>LDAP\Result|array|false</info>  <class>LDAP\Result</class> のインスタンスか、<class>LDAP\Result</class> のインスタンスの配列を返しま
                           す。失敗した場合に <info>false</info> を返します


id: ldap_set_option
type: function
doc:
<comment>Description:</comment>
  指定したオプションの値を設定する
  
  指定したオプションの値を <strong>$value</strong> に設定します。

<comment>Param:</comment>
  <info>LDAP\Connection|null</info>   <strong>$ldap</strong>    特定の接続に対してオプションを設定する場合は、 <strong>ldap_connect()</strong> が返
                                  す、 <class>LDAP\Connection</class> クラスのインスタンス。 オプションをグローバル
                                  に設定する場合は、 <info>null</info> を設定します。
  <info>int</info>                    <strong>$option</strong>  パラメータ <strong>$option</strong> は以下のいずれかとなります。 オプション型～以降
                                  で使用可能
                                  <info>LDAP_OPT_DEREF</info><info>int</info><info>LDAP_OPT_SIZELIMIT</info><info>int</info><info>LDAP_OPT_TIMELIMIT</info><info>int</info><info>LDAP_OPT_NETWORK_TIMEOUT</info><info>int</info><info>LDAP_OPT_PROTOCOL_VERSION</info><info>int</info><info>LDAP_OPT_ERROR_NUMBER</info><info>int</info><info>LDAP_OPT_REFERRALS</info><info>bool</info><info>LDAP_OPT_RESTART</info><info>bool</info><info>LDAP_OPT_HOST_NAME</info><info>string</info><info>LDAP_OPT_ERROR_STRING</info><info>string</info><info>LDAP_OPT_DIAGNOSTIC_MESSAGE</info><info>string</info><info>LDAP_OPT_MATCHED_DN</info><info>string</info><info>LDAP_OPT_SERVER_CONTROLS</info><info>array</info><info>LDAP_OPT_CLIENT_CONTROLS</info><info>array</info><info>LDAP_OPT_X_KEEPALIVE_IDLE</info><info>int</info>PHP
                                  7.1.0<info>LDAP_OPT_X_KEEPALIVE_PROBES</info><info>int</info>PHP
                                  7.1.0<info>LDAP_OPT_X_KEEPALIVE_INTERVAL</info><info>int</info>PHP
                                  7.1.0<info>LDAP_OPT_X_TLS_CACERTDIR</info><info>string</info>PHP
                                  7.1.0<info>LDAP_OPT_X_TLS_CACERTFILE</info><info>string</info>PHP
                                  7.1.0<info>LDAP_OPT_X_TLS_CERTFILE</info><info>string</info>PHP
                                  7.1.0<info>LDAP_OPT_X_TLS_CIPHER_SUITE</info><info>string</info>PHP
                                  7.1.0<info>LDAP_OPT_X_TLS_CRLCHECK</info><info>int</info>PHP
                                  7.1.0<info>LDAP_OPT_X_TLS_CRLFILE</info><info>string</info>PHP
                                  7.1.0<info>LDAP_OPT_X_TLS_DHFILE</info><info>string</info>PHP
                                  7.1.0<info>LDAP_OPT_X_TLS_KEYFILE</info><info>string</info>PHP
                                  7.1.0<info>LDAP_OPT_X_TLS_PROTOCOL_MIN</info><info>int</info>PHP
                                  7.1.0<info>LDAP_OPT_X_TLS_RANDOM_FILE</info><info>string</info>PHP
                                  7.1.0<info>LDAP_OPT_X_TLS_REQUIRE_CERT</info><info>int</info>PHP 7.0.5
                                  
                                  <info>LDAP_OPT_SERVER_CONTROLS</info> および <info>LDAP_OPT_CLIENT_CONTROLS</info>  はコント
                                  ロールのリストが必要です。 つまり、値がコントロールの配列である必
                                  要があるということです。 コントロールは、そのコントロールの ID で
                                  ある oid、オプションの value、オプションのフラグ criticality から
                                  なります。PHP において、 コントロールはキーが oid で値が文字列、
                                  二つのオプションの要素からなる配列で指定されます。オプションの要素
                                  は、 キーが value で値が文字列、そしてキーが iscritical で値が論理
                                  値となります。 iscritical を省略した場合のデフォルトは <info>false</info> で
                                  す。詳細は draft-ietf-ldapext-ldap-c-api-xx.txt を参照ください。ま
                                  た以下の二番目の例も参照ください。
  <info>array|string|int|bool</info>  <strong>$value</strong>   指定したオプション <strong>$option</strong> の新しい値。

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

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


id: ldap_set_rebind_proc
type: function
doc:
<comment>Description:</comment>
  参照先を再バインドするためのコールバック関数を設定する
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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


id: ldap_sort
type: function
doc:
<comment>Description:</comment>
  LDAP 結果エントリをクライアント側でソートする
  
  <strong>ldap_search()</strong> が返す LDAP 検索結果をソートします。
  
  この関数は、返された結果をクライアント側でソートします。そのため、 サーバー側の <strong>$sizelimit</strong> や
  <strong>ldap_search()</strong> で定義した <strong>$sizelimit</strong> に達した場合は期待どおりの結果を得られない可能性があります。

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>        <strong>ldap_connect()</strong> が返す LDAP リソース。
  <info>resource</info>  <strong>$result</strong>      <strong>ldap_search()</strong> が返す検索結果 ID。
  <info>string</info>    <strong>$sortfilter</strong>  ソートのキーとして使う属性。

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


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

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


id: ldap_t61_to_8859
type: function
doc:
<comment>Description:</comment>
  t61 文字を 8859 文字に変換する
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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


id: ldap_unbind
type: function
doc:
<comment>Description:</comment>
  LDAP ディレクトリへのバインドを解除する
  
  LDAP ディレクトリへのバインドを解除します。

<comment>Param:</comment>
  <info>LDAP\Connection</info>  <strong>$ldap</strong>  <strong>ldap_connect()</strong> が返す <class>LDAP\Connection</class> クラスのインスタンス。

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

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


id: levenshtein
type: function
doc:
<comment>Description:</comment>
  二つの文字列のレーベンシュタイン距離を計算する
  
  レーベンシュタイン距離は、<strong>$string1</strong> を <strong>$string2</strong> に変換するために置換、挿入、削除 しなければならない
  最小の文字数として定義されます。アルゴリズムの計算量は、 <return>O(m*n)</return> です。 ここで、<return>n</return> および <return>m</return> はそれぞ
  れ <strong>$string1</strong> および <strong>$string2</strong> の長さです。 <return>O(max(n,m)**3)</return> となる <strong>similar_text()</strong> よりは良いですが、
  まだかなりの計算量です)。
  
  <strong>$insertion_cost</strong>, <strong>$replacement_cost</strong> かつ/または <strong>$deletion_cost</strong> が <return>1</return> 以外の場合、 変換コストが最も小
  さいアルゴリズムを採用します。 たとえば、$insertion_cost + $deletion_cost
  \< $replacement_cost の場合、 置換をせず、挿入と削除が行われます。

<comment>Param:</comment>
  <info>string</info>  <strong>$string1</strong>           レーベンシュタイン距離を計算する文字列のひとつ。
  <info>string</info>  <strong>$string2</strong>           レーベンシュタイン距離を計算する文字列のひとつ。
  <info>int</info>     <strong>$insertion_cost</strong>    挿入のコストを定義します。
  <info>int</info>     <strong>$replacement_cost</strong>  置換のコストを定義します。
  <info>int</info>     <strong>$deletion_cost</strong>     削除のコストを定義します。

<comment>Return:</comment>
  <info>int</info>  この関数は、引数で指定した二つの文字列のレーベンシュタイン距離を返します。

<comment>See Also:</comment>
   * <strong>soundex()</strong>
   * <strong>similar_text()</strong>
   * <strong>metaphone()</strong>


id: libXMLError
type: class
doc:
<comment>Description:</comment>
  libxml がスローするエラーについてのさまざまな情報を含みます。エラーコードについての説明は、公式の
  xmlError API ドキュメント をごらんください。


id: libxml_clear_errors
type: function
doc:
<comment>Description:</comment>
  libxmlエラーハンドラをクリアする
    
  
  <strong>libxml_clear_errors()</strong>は、libxmlエラーバッファをクリアします。

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

<comment>See Also:</comment>
   * <strong>libxml_get_errors()</strong>
   * <strong>libxml_get_last_error()</strong>


id: libxml_disable_entity_loader
type: function
doc:
<comment>Description:</comment>
  外部エンティティの読み込み機能を無効にする
  
  外部エンティティ読み込み機能の有効/無効を切り替えます。 外部エンティティの読み込みを無効にすると、
  XML文書を読み込む際に問題が起こる可能性があることに注意して下さい。 しかし、libxml 2.9.0 以降で
  は、エンティティの置換はデフォルトで無効になっているため、 <info>LIBXML_NOENT</info> を使って内部エンティティの
  参照を解決する必要がない限り、 外部エンティティの読み込みを無効にする必要はありません。 一般的に
  は、外部エンティティの読み込みを抑制するのであれば、 <strong>libxml_set_external_entity_loader()</strong> を使うこ
  とが望ましいです。

<comment>Param:</comment>
  <info>bool</info>  <strong>$disable</strong>  libxml を使用する拡張モジュール (、 および ) で、外部エンティティの読み込み機能を
                  無効 (<info>true</info>) あるいは有効 (<info>false</info>) にします。

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

<comment>See Also:</comment>
   * <strong>libxml_use_internal_errors()</strong>
   * <strong>libxml_set_external_entity_loader()</strong>
   * <info>LIBXML_NOENT</info> 定数


id: libxml_get_errors
type: function
doc:
<comment>Description:</comment>
  エラー配列を取得する
    
  
  エラー配列を取得します。

<comment>Return:</comment>
  <info>array</info>  エラーがバッファにある場合に <info>LibXMLError</info> オブジェクトの配列、 それ以外の場合に空の配列を返
         します。

<comment>See Also:</comment>
   * <strong>libxml_get_last_error()</strong>
   * <strong>libxml_clear_errors()</strong>


id: libxml_get_external_entity_loader
type: function
doc:
<comment>Description:</comment>
  現在の外部エンティティローダーを取得する
  
  直前に <strong>libxml_set_external_entity_loader()</strong> を使って設定した、外部エンティティローダーを取得しま
  す。

<comment>Return:</comment>
  <info>callable|null</info>  直前に <strong>libxml_set_external_entity_loader()</strong> を使って設定した、外部エンティティロー
                 ダーを返します。 <strong>libxml_set_external_entity_loader()</strong> をコールしたことがないか、<info>null</info>
                 を渡して呼び出した場合は <info>null</info> を返します。

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


id: libxml_get_last_error
type: function
doc:
<comment>Description:</comment>
  libxmlから直近のエラーを取得する
    
  
  libxmlから直近のエラーを取得します。

<comment>Return:</comment>
  <info>LibXMLError|false</info>  エラーがバッファにある場合に<info>LibXMLError</info>オブジェクト、 それ以外の場合に <info>false</info> を
                     返します。

<comment>See Also:</comment>
   * <strong>libxml_get_errors()</strong>
   * <strong>libxml_clear_errors()</strong>


id: libxml_set_external_entity_loader
type: function
doc:
<comment>Description:</comment>
  デフォルトの外部エンティティローダーを変更する
  
  デフォルトの外部エンティティローダーを変更します。 たとえ <info>LIBXML_NOENT</info> が個別のXMLの操作に設定され
  ている場合でも、 XXE攻撃を避けるために、任意の外部エンティティの展開を抑制するために使うことができ
  ます。 また、 <strong>libxml_disable_entity_loader()</strong> を呼び出すことよりも、この関数を呼び出すほうが通常は
  好ましいです。

<comment>Param:</comment>
  <info>callable|null</info>  <strong>$resolver_function</strong>  次のシグネチャを持つ <info>callable</info> を指定します。:
                                     <info>resource</info><info>string</info><info>null</info></info>resolver<info>string</info><info>null</info></info><strong>$public_id</strong><info>string</info><strong>$system_id</strong><info>array</info><strong>$context</strong>
                                     <strong>$public_id</strong> パブリック ID <strong>$system_id</strong> システムID <strong>$context</strong> 4つの
                                     キーを持つ配列。 キーは <return>"directory"</return>, <return>"intSubName"</return>, <return>"extSubURI"</return>,
                                     <return>"extSubSystem"</return> です。  この <info>callable</info> は、 リソースまたはリソー
                                     スをオープンできる文字列あるいは <info>null</info> でなければなりません。
                                     <info>null</info> を返す場合、エンティティ参照の解決は失敗します。
                                     
                                     パブリック ID
                                     
                                     システムID
                                     
                                     4つのキーを持つ配列。 キーは <return>"directory"</return>, <return>"intSubName"</return>,
                                     <return>"extSubURI"</return>, <return>"extSubSystem"</return> です。
  <info>string|null</info>    <strong>$public_id</strong>          パブリック ID
  <info>string</info>         <strong>$system_id</strong>          システムID
  <info>array</info>          <strong>$context</strong>            4つのキーを持つ配列。 キーは <return>"directory"</return>, <return>"intSubName"</return>,
                                     <return>"extSubURI"</return>, <return>"extSubSystem"</return> です。

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

<comment>See Also:</comment>
   * <strong>libxml_disable_entity_loader()</strong>
   * <strong>libxml_get_external_entity_loader()</strong>


id: libxml_set_streams_context
type: function
doc:
<comment>Description:</comment>
  次のlibxmlドキュメントの読込／書きこみのためにストリームコンテキストを設定する
    
  
  次のlibxmlドキュメントの読込／書きこみのためにストリームコンテキストを設定します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$context</strong>  ストリームコンテキストリソース( <strong>stream_context_create()</strong>で作成)

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

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


id: libxml_use_internal_errors
type: function
doc:
<comment>Description:</comment>
  libxmlエラーを無効にし、ユーザーが必要に応じてエラー情報を取得できるようにする
    
  
  <strong>libxml_use_internal_errors()</strong> により、 標準のlibxmlエラーを無効にし、ユーザーによるエラー処理を有効
  にすることができます。

<comment>Param:</comment>
  <info>bool|null</info>  <strong>$use_errors</strong>  ユーザーによるエラー処理を有効 (<info>true</info>) または無効 (<info>false</info>) にする。 無効にす
                          ると、既に存在する libxml のエラーもすべてクリアします。

<comment>Return:</comment>
  <info>bool</info>  この関数は、 <strong>$use_errors</strong>の前の値を返します。

<comment>See Also:</comment>
   * <strong>libxml_clear_errors()</strong>
   * <strong>libxml_get_errors()</strong>


id: link
type: function
doc:
<comment>Description:</comment>
  ハードリンクを作成する
  
  <strong>link()</strong> はハードリンクを作成します。

<comment>Param:</comment>
  <info>string</info>  <strong>$target</strong>  リンクの対象。
  <info>string</info>  <strong>$link</strong>    リンクの名前。

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

<comment>See Also:</comment>
   * <strong>symlink()</strong>
   * <strong>readlink()</strong>
   * <strong>linkinfo()</strong>
   * <strong>unlink()</strong>


id: linkinfo
type: function
doc:
<comment>Description:</comment>
  リンクに関する情報を取得する
  
  リンクに関する情報を取得します。
  
  この関数を使用して (<strong>$path</strong>が指している) リンクが実際に存在するかどうかを、 (stat.h で定義されている
  S_ISLNK マクロと同じ方法で) チェックします。

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>  リンクへのパス。

<comment>Return:</comment>
  <info>int|false</info>  <strong>linkinfo()</strong>は、<return>lstat</return> システムコールで返された Unix C 言語の stat 構造体の <return>st_dev</return> フィー
             ルドを返します。 成功した場合は負でない数値を返します。 リンクが存在しない場合は -1 を
             返し、open.base_dir の違反が起きた場合は <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>symlink()</strong>
   * <strong>link()</strong>
   * <strong>readlink()</strong>


id: list
type: function
doc:
<comment>Description:</comment>
  配列と同様の形式で、複数の変数への代入を行う
  
  <strong>array()</strong> と同様に、 この関数は実際には関数ではなく言語構造です。 <strong>list()</strong> は、 単一の操作で一連の変数
  に値を代入するために使われます。 この関数は、文字列を扱うことは出来ませんし、 <strong>list()</strong> には、空の式
  を指定できません。
  
  PHP 7.1.0 より前のバージョンでは、<strong>list()</strong> は数値添字の配列でのみ動作し、 また、添字は 0 から始まる
  ことを想定していました。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$var</strong>   変数。
  <info>mixed</info>  <strong>$vars</strong>  残りの変数。

<comment>Return:</comment>
  <info>array</info>  代入した配列を返します。

<comment>See Also:</comment>
   * <strong>each()</strong>
   * <strong>array()</strong>
   * <strong>extract()</strong>


id: localeconv
type: function
doc:
<comment>Description:</comment>
  数値に関するフォーマット情報を得る
  
  ローカルな数値および通貨フォーマット情報を有する連想配列を返します。

<comment>Return:</comment>
  <info>array</info>  <strong>localeconv()</strong> は、 <strong>setlocale()</strong> で設定された現在のロケールに基づきデータを返します。 返される
         連想配列は、次のフィールドを有します。 配列要素説明decimal_point小数点文字thousands_sep千毎
         の区切り文字grouping数値集合を有する配列int_curr_symbol国際通貨記号 (すなわち、
         USD)currency_symbolローカルな通貨記号 (すなわち、$)mon_decimal_point通貨用の小数点文字
         mon_thousands_sep通貨用の千毎の区切り文字mon_grouping通貨集合を有する配列positive_sign正の
         値を表す記号negative_sign負の値を表す記号int_frac_digits国際分割桁frac_digitsローカルな分割
         桁p_cs_precedes currency_symbol が正の値を前に置く場合に<info>true</info>、後に置く場合に <info>false</info>
         p_sep_by_space 正の値から currency_symbol を1文字の空白で区切る場合に<info>true</info>、 そうでない場合
         に<info>false</info> n_cs_precedes currency_symbol が負の値を前に置く場合に<info>true</info>、後に置く場合に <info>false</info>
         n_sep_by_space 負の値から currency_symbol を1文字の空白で区切る場合に<info>true</info>、 そうでない場合
         に<info>false</info> p_sign_posn0 - 量および通貨記号を括る括弧1 - 量および通貨記号の前に置く符号文字列2
         - 量および通貨記号の後に置く符号文字列3 - 通貨記号の直前に置く符号文字列4 - 通貨記号の直後
         に置く符号文字列n_sign_posn0 - 量および通貨記号を括る括弧1 - 量および通貨記号の前に置く符号
         文字列2 - 量および通貨記号の後に置く符号文字列3 - 通貨記号の直前に置く符号文字列4 - 通貨記
         号の直後に置く符号文字列
         
         <return>n_sign_posn</return> や <return>n_sign_posn</return> は、フォーマッタオプションの文字列を含みます。それぞれの数字は
         上に一覧されている条件の 1 つを表します。
         
         groupingフィールドには、グループ化する方法を表す数字を定義する配 列が含まれます。例えば、
         nl_NL ロケール用の通貨 groupingフィールド (UTF-8 モードでのユーロ記号) には、 3、3を値とす
         る要素数2の配列が含まれます。この配列のより高い添字に は、より左側のグループに関するものが
         含まれます。 ある配列要素が、<info>CHAR_MAX</info> に等しい場合、 さらにグループは行われません。配列要素
         が0に等しい場合、 前の要素が使用されています。

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


id: localtime
type: function
doc:
<comment>Description:</comment>
  ローカルタイムを得る
  
  <strong>localtime()</strong> 関数は、C 言語の 同名の関数コールにより返される構造体と同じ内容の配列を返します。

<comment>Param:</comment>
  <info>int|null</info>  <strong>$timestamp</strong>    オプションのパラメータ <strong>$timestamp</strong> は、
                          <info>int</info> 型の Unix タイムスタンプです。
                          <strong>$timestamp</strong> が指定されなかったり、<info>null</info> だった場合のデフォルト値は、
                          現在の時刻です。言い換えると、デフォルトは
                          <strong>time()</strong> の返り値となります。
  <info>bool</info>      <strong>$associative</strong>  この関数が数値のインデックスによる通常の配列を返すか、 連想配列を返すかを
                          指定します。

<comment>Return:</comment>
  <info>array</info>  <strong>$associative</strong> が <info>false</info> に設定されるか省略された場合は、 数値のインデックスにょる通常の配列を
         返します。 <strong>$associative</strong> が <info>true</info> に設定された場合は、 <strong>localtime()</strong> は C 言語の関数 localtime
         のコールにより返される構造体の全ての要素を有する連想配列を返します。 この連想配列の各キーの
         名前は次のようになります。
         
          "tm_sec" - 秒 (<return>0</return> から <return>59</return>)  "tm_min" - 分 (<return>0</return> から <return>59</return>)  "tm_hour" - 時 (<return>0</return> から <return>23</return>)
         "tm_mday" - 月の日付 (<return>1</return> から <return>31</return>)  "tm_mon" - 月 (<return>0</return> (1月) から <return>11</return> (12月))  "tm_year" - 1900
         年からの年数  "tm_wday" - 曜日 (<return>0</return> (日曜日) から <return>6</return> (土曜日))  "tm_yday" - 年単位の日付 (<return>0</return> か
         ら <return>365</return>)  "tm_isdst" - 夏時間の適用中かどうか  適用中なら正の数、そうでなければ <return>0</return>、不明なら
         負の数。
         
         "tm_sec" - 秒 (<return>0</return> から <return>59</return>)
         
         "tm_min" - 分 (<return>0</return> から <return>59</return>)
         
         "tm_hour" - 時 (<return>0</return> から <return>23</return>)
         
         "tm_mday" - 月の日付 (<return>1</return> から <return>31</return>)
         
         "tm_mon" - 月 (<return>0</return> (1月) から <return>11</return> (12月))
         
         "tm_year" - 1900 年からの年数
         
         "tm_wday" - 曜日 (<return>0</return> (日曜日) から <return>6</return> (土曜日))
         
         "tm_yday" - 年単位の日付 (<return>0</return> から <return>365</return>)
         
         "tm_isdst" - 夏時間の適用中かどうか
         
         適用中なら正の数、そうでなければ <return>0</return>、不明なら負の数。

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


id: log
type: function
doc:
<comment>Description:</comment>
  自然対数
  
  オプションの <strong>$base</strong> パラメータを指定した場合は <strong>log()</strong> は logbase <strong>$num</strong> を返します。それ以外の場合は
  <strong>log()</strong> は <strong>$num</strong> の自然対数を返します。

<comment>Param:</comment>
  <info>float</info>  <strong>$num</strong>   対数を計算する値。
  <info>float</info>  <strong>$base</strong>  オプションで指定する、底 (デフォルトは 'e' で、これは自然対数となります)。

<comment>Return:</comment>
  <info>float</info>  <strong>$base</strong> を指定した場合はそれを底とする <strong>$num</strong> の対数、指定しない場合は自然対数を返します。

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


id: log10
type: function
doc:
<comment>Description:</comment>
  底が 10 の対数
  
  底を 10 とする <strong>$num</strong> の対数を返します。

<comment>Param:</comment>
  <info>float</info>  <strong>$num</strong>  処理する引数。

<comment>Return:</comment>
  <info>float</info>  底を 10 とする <strong>$num</strong> の対数を返します。

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


id: log1p
type: function
doc:
<comment>Description:</comment>
  値がゼロに近い時にでも精度を保つ方法で計算した log(1 + number) を返す
    
  
  <strong>log1p()</strong> は、 log(1 + <strong>$num</strong>) の値を返します。 <strong>$num</strong> がゼロに近い場合でも正確な値が 計算できる方法を使
  用します。 <strong>log()</strong> は、このような場合には 精度の問題で log(1) の値を返してしまいます。

<comment>Param:</comment>
  <info>float</info>  <strong>$num</strong>  処理する引数。

<comment>Return:</comment>
  <info>float</info>  log(1 + <strong>$num</strong>) を返します。

<comment>See Also:</comment>
   * <strong>expm1()</strong>
   * <strong>log()</strong>
   * <strong>log10()</strong>


id: long2ip
type: function
doc:
<comment>Description:</comment>
  長整数表現のインターネットアドレスを (IPv4) インターネット標準ドット表記に変換する
  
  関数<strong>long2ip()</strong> は、長整数表現のアドレスからドット表記 (例:aaa.bbb.ccc.ddd)のインターネットアドレス
  を生成します。

<comment>Param:</comment>
  <info>int</info>  <strong>$ip</strong>  長整数で表した、正しい形式のアドレス。

<comment>Return:</comment>
  <info>string|false</info>  インターネットの IP アドレスを表す文字列を返します。 失敗した場合に <info>false</info> を返します

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


id: lstat
type: function
doc:
<comment>Description:</comment>
  ファイルあるいはシンボリックリンクの情報を取得する
  
  <strong>$filename</strong> という名前のファイル、 またはシンボリックリンクの情報を得ます。

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  ファイルあるいはシンボリックリンクへのパス。

<comment>Return:</comment>
  <info>array|false</info>  <strong>lstat()</strong> が返す配列の内容については <strong>stat()</strong> のマニュアルをご覧ください。 この関数の動作
               は <strong>stat()</strong> 関数と同じですが、 パラメータ <strong>$filename</strong> がシンボリックリンクであった場合
               に、 シンボリック先のファイルのステータスではなく、 シンボリックリンクのステータスが
               返されるところが異なります。
               
               失敗時に <info>false</info> を返します。

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


id: ltrim
type: function
doc:
<comment>Description:</comment>
  文字列の最初から空白 (もしくはその他の文字) を取り除く
  
  文字列の最初から空白 (もしくはその他の文字) を取り除きます。

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>      入力文字列。
  <info>string</info>  <strong>$characters</strong>  <strong>$characters</strong>パラメータにより、削除する 文字を指定することも可能です。削除した
                       い全ての文字をリストに してください。<return>..</return>を文字の範囲を指定する際に 使用可能で
                       す。

<comment>Return:</comment>
  <info>string</info>  この関数は <strong>$string</strong> の最初から空白文字を取り除き、 取り除かれた文字列を返します。2番目のパ
          ラメータを指定しない場合、 <strong>ltrim()</strong>は以下の文字を削除します。   " " (ASCII <return>32</return> (<return>0x20</return>)), 通常
          の空白。  "\t" (ASCII <return>9</return> (<return>0x09</return>)), タブ。  "\n" (ASCII <return>10</return> (<return>0x0A</return>)), 改行。  "\r" (ASCII <return>13</return>
          (<return>0x0D</return>)), 復帰。  "\0" (ASCII <return>0</return> (<return>0x00</return>)), <return>NUL</return> バイト。  "\v" (ASCII <return>11</return> (<return>0x0B</return>)), 垂直タブ。
          
          " " (ASCII <return>32</return> (<return>0x20</return>)), 通常の空白。
          
          "\t" (ASCII <return>9</return> (<return>0x09</return>)), タブ。
          
          "\n" (ASCII <return>10</return> (<return>0x0A</return>)), 改行。
          
          "\r" (ASCII <return>13</return> (<return>0x0D</return>)), 復帰。
          
          "\0" (ASCII <return>0</return> (<return>0x00</return>)), <return>NUL</return> バイト。
          
          "\v" (ASCII <return>11</return> (<return>0x0B</return>)), 垂直タブ。

<comment>See Also:</comment>
   * <strong>trim()</strong>
   * <strong>rtrim()</strong>


id: lzf_compress
type: function
doc:
<comment>Description:</comment>
  LZF 圧縮を行う
    
  
  <strong>lzf_compress()</strong> は、指定された <strong>$arg</strong> を LZF 符号化方式で圧縮します。

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  圧縮するデータ。

<comment>Return:</comment>
  <info>string</info>  圧縮されたデータを返します。エラー時には <info>false</info> を返します。

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


id: lzf_decompress
type: function
doc:
<comment>Description:</comment>
  LZF 圧縮を伸長する
    
  
  <strong>lzf_decompress()</strong> は、lzf で符号化された文字列を含む <strong>$data</strong> を伸長します。

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  圧縮されたデータ。

<comment>Return:</comment>
  <info>string</info>  伸長したデータを返します。エラー時には <info>false</info> を返します。

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


id: lzf_optimized_for
type: function
doc:
<comment>Description:</comment>
  LZF 拡張モジュールの最適化指定を取得する
    
  
  LZF 拡張モジュールが圧縮時に使用した最適化指定を取得します。

<comment>Return:</comment>
  <info>int</info>  LZF が速度に最適化されている場合に 1、圧縮率に最適化されている場合に 0 を返します。


id: mail
type: function
doc:
<comment>Description:</comment>
  メールを送信する
  
  メールを送信します。

<comment>Param:</comment>
  <info>string</info>        <strong>$to</strong>                  メールの受信者。
                                     
                                     RFC 2822 を満たす書式でなければ なりません。例えば以下のような
                                     ものです。 user@example.comuser@example.com,
                                     anotheruser@example.comUser \<user@example.com&gt;User \<user@example.com&gt;, Another User \<anotheruser@example.com&gt;
  <info>string</info>        <strong>$subject</strong>             送信するメールの表題。
                                     
                                     表題は RFC 2047 を満たすものでなければなりません。
  <info>string</info>        <strong>$message</strong>             送信するメッセージ。
                                     
                                     改行コードは CRLF (\r\n) となります。各行の長さは 70 文字を超え
                                     ては いけません。
                                     
                                     （Windows のみ）PHP が SMTP サーバーと直接通信をする際、ピリオ
                                     ドから 始まる行は無視されます。これを防ぐには、行頭のピリオドを
                                     ピリオド 2 つに置き換えてください。
                                     ]]>
  <info>array|string</info>  <strong>$additional_headers</strong>  メールヘッダの最後に挿入される <info>String</info> または <info>array</info>。
                                     
                                     通常、これは追加のヘッダ（From、Cc、Bcc）のために用いられます。
                                     複数のヘッダを追加する場合は CRLF（\r\n）で区切ります。 外部か
                                     らのデータを用いてヘッダを組み立てる際には、想定外のヘッダが注
                                     入されることを防ぐための処理が必要です。
                                     
                                     <info>array</info> が渡されると、キーがヘッダの名前となり、 値がそれぞれの
                                     ヘッダの値になります。
                                     
                                     PHP 5.4.42 および 5.5.27 より前のバージョンでは、
                                     <strong>$additional_headers</strong> は、 メールヘッダインジェクション対策を行っ
                                     ていませんでした。 したがって、指定したヘッダが安全なものであ
                                     り、ヘッダ以外のものを含まないようにするのはユーザー側の役目と
                                     なります。 複数の改行文字を置くことでメール本文を始めたりしては
                                     いけません。
                                     
                                     メールを送信する際には、必ず  <return>From</return> ヘッダが含まれていなければな
                                     りません。 <strong>$additional_headers</strong> パラメータで指定するか、 あるい
                                     は php.ini にデフォルト値を指定します。
                                     
                                     指定しなかった場合は、以下のようなエラーメッセージが返ります
                                     <return>Warning: mail(): "sendmail_from" not set in php.ini or custom
                                     "From:" header missing</return> 。 Windows では、SMTP経由で直接メールを
                                     送信する際は、 <return>From</return> ヘッダを設定すると <return>Return-Path</return> も設定されま
                                     す。
                                     
                                     メッセージが受信されなかった場合には、LF（\n）のみを使ってみて
                                     ください。 Unix の MTA の中には、自動的に LF を CRLF に変換して
                                     しまう もの (有名なところでは、qmail など) があります（もし
                                     CRLF を利用していた場合、CR が重複してしまいます）。 ただし、こ
                                     れは最後の手段です。というのも、これは RFC 2822 に違反している
                                     からです。
  <info>string</info>        <strong>$additional_params</strong>   パラメータ <strong>$additional_params</strong> は、 追加のフラグをコマンドライン
                                     オプションとしてメール送信プログラムに渡す際に使用可能です。
                                     メール送信プログラムは、設定オプション <return>sendmail_path</return> により設定
                                     されます。例えば、 sendmail を使用する際に <return>-f</return> オプションを使っ
                                     て エンベロープの sender アドレスを設定する際に使用できます。
                                     
                                     このパラメータはコマンドの実行を防止するために内部的に
                                     <strong>escapeshellcmd()</strong> によってエスケープされます。 <strong>escapeshellcmd()</strong>
                                     はコマンドの実行を防止しますが、 別のパラメータを追加することは
                                     許してしまいます。セキュリティ上の理由から、 シェルコマンドへの
                                     望ましくないパラメータの追加を避けるために、 ユーザーはこのパラ
                                     メータを適切に処理することが推奨されます。
                                     
                                     <strong>escapeshellcmd()</strong> が自動的に適用されるため、 インターネット RFC
                                     でメールアドレスとして許可さているいくつかの文字を使用すること
                                     ができません。 <strong>mail()</strong> はそうした文字を許可しないため、プログラ
                                     ム中でそうした文字の使用が必須である場合、 メール送信の代替手段
                                     （フレームワークやライブラリの使用など）が推奨されます。
                                     
                                     この方法でエンベロープの sender ヘッダ（-f）を設定する際は、
                                     'X-Warning' ヘッダが付加されないように Web サーバーの実行ユー
                                     ザーを sendmail 設定に追加しておく必要があるかもしれません。
                                     sendmail を利用している場合、これは /etc/mail/trusted-users で
                                     設定します。

<comment>Return:</comment>
  <info>bool</info>  メール送信が受け入れられた場合に <info>true</info> 、それ以外の場合に <info>false</info> を返します。
        
        メールの配送が受け入れられたかどうかが基準であることに注意しましょう。 メールが実際にあて先
        に届いたかどうかでは「ありません」。

<comment>See Also:</comment>
   * <strong>mb_send_mail()</strong>
   * <strong>imap_mail()</strong>
   * PEAR::Mail
   * PEAR::Mail_Mime


id: mailparse_determine_best_xfer_encoding
type: function
doc:
<comment>Description:</comment>
  最も適したエンコーディングを取得する
  
  ファイルポインタから内容を読み込む際に最も適したエンコーディングを調べます。

<comment>Param:</comment>
  <info>resource</info>  <strong>$fp</strong>  有効なファイルポインタ。これはシーク可能である必要があります。

<comment>Return:</comment>
  <info>string</info>  mbstring モジュールがサポートする文字エンコーディングのいずれかを返します。


id: mailparse_msg_create
type: function
doc:
<comment>Description:</comment>
  mime メールリソースを作成する
  
  <return>MIME</return> メールリソースを作成します。

<comment>Return:</comment>
  <info>resource</info>  メッセージのパースに使用するハンドルを返します。

<comment>See Also:</comment>
   * <strong>mailparse_msg_free()</strong>
   * <strong>mailparse_msg_parse_file()</strong>


id: mailparse_msg_extract_part
type: function
doc:
<comment>Description:</comment>
  メッセージセクションを展開/デコードする
    
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>resource</info>  <strong>$mimemail</strong>      有効な <return>MIME</return> リソース。
  <info>string</info>    <strong>$msgbody</strong>       
  <info>callable</info>  <strong>$callbackfunc</strong>  

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

<comment>See Also:</comment>
   * <strong>mailparse_msg_extract_part_file()</strong>
   * <strong>mailparse_msg_extract_whole_part_file()</strong>


id: mailparse_msg_extract_part_file
type: function
doc:
<comment>Description:</comment>
  メッセージセクションを展開/デコードする
  
  指定したファイル名のメッセージセクションを展開/デコードします。
  
  セクションの内容は、transfer encoding に応じて適切にデコードされます。 base64、quoted-printable お
  よび uuencode 形式をサポートしています。

<comment>Param:</comment>
  <info>resource</info>  <strong>$mimemail</strong>      <strong>mailparse_msg_create()</strong> で作成した <return>MIME</return> リソース。
  <info>mixed</info>     <strong>$filename</strong>      ファイル名あるいは有効なストリームリソース。
  <info>callable</info>  <strong>$callbackfunc</strong>  展開されたセクションに渡されるコールバック関数、あるいは <info>null</info> を指定する
                           と、この関数は展開したセクションを返します。
                           
                           省略した場合は標準出力に出力されます。

<comment>Return:</comment>
  <info>string</info>  <strong>$callbackfunc</strong> が <info>null</info> でない場合は、 成功時に <info>true</info> を返します。
          
          <strong>$callbackfunc</strong> が <info>null</info> の場合は、 展開したセクションを文字列で返します。
          
          エラー時には <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>mailparse_msg_extract_part()</strong>
   * <strong>mailparse_msg_extract_whole_part_file()</strong>


id: mailparse_msg_extract_whole_part_file
type: function
doc:
<comment>Description:</comment>
  ヘッダを含むメッセージセクションを、transfer encoding をデコードせずに展開する
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>resource</info>  <strong>$mimemail</strong>      有効な <return>MIME</return> リソース。
  <info>string</info>    <strong>$filename</strong>      
  <info>callable</info>  <strong>$callbackfunc</strong>  

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

<comment>See Also:</comment>
   * <strong>mailparse_msg_extract_part()</strong>
   * <strong>mailparse_msg_extract_part_file()</strong>


id: mailparse_msg_free
type: function
doc:
<comment>Description:</comment>
  MIME リソースを解放する
  
  <return>MIME</return> リソースを解放します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$mimemail</strong>  <strong>mailparse_msg_create()</strong> あるいは <strong>mailparse_msg_parse_file()</strong> が割り当てた 有効
                       な <return>MIME</return> リソース。

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

<comment>See Also:</comment>
   * <strong>mailparse_msg_create()</strong>
   * <strong>mailparse_msg_parse_file()</strong>


id: mailparse_msg_get_part
type: function
doc:
<comment>Description:</comment>
  MIME メッセージの指定したセクションに関するハンドルを返す
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>resource</info>  <strong>$mimemail</strong>     有効な <return>MIME</return> リソース。
  <info>string</info>    <strong>$mimesection</strong>  

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


id: mailparse_msg_get_part_data
type: function
doc:
<comment>Description:</comment>
  メッセージに関する情報の連想配列を返す
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>resource</info>  <strong>$mimemail</strong>  有効な <return>MIME</return> リソース。

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


id: mailparse_msg_get_structure
type: function
doc:
<comment>Description:</comment>
  指定したメッセージ内の MIME セクション名の配列を返す
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>resource</info>  <strong>$mimemail</strong>  有効な <return>MIME</return> リソース。

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


id: mailparse_msg_parse
type: function
doc:
<comment>Description:</comment>
  データをパースし、バッファに追加する
  
  データを順にパースし、指定した mime メールリソースに格納します。
  
  この関数により、ファイル全体を読み込んでからパースするのではなく 読み込んだ部分から順に処理してい
  くことができます。

<comment>Param:</comment>
  <info>resource</info>  <strong>$mimemail</strong>  有効な <return>MIME</return> リソース。
  <info>string</info>    <strong>$data</strong>      <strong>$data</strong> の最後のチャンクは、 改行コード(<return>CRLF</return>) で終わることが想定されています。
                       そうでない場合、最後の行がパースされません。

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


id: mailparse_msg_parse_file
type: function
doc:
<comment>Description:</comment>
  ファイルをパースする
  
  ファイルをパースします。 ディスク上にあるメールファイルをパースするための最良の方法です。

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  メッセージを保持するファイルへのパス。 このファイルがオープンされ、ストリームと
                     してパーサに流し込まれます。
                     
                     <strong>$filename</strong> が保持するメッセージは、 改行コード(<return>CRLF</return>) で終わることが想定されてい
                     ます。 そうでない場合、最後の行がパースされません。

<comment>Return:</comment>
  <info>resource</info>  構造を表す <return>MIME</return> リソース、あるいはエラー時に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>mailparse_msg_free()</strong>
   * <strong>mailparse_msg_create()</strong>


id: mailparse_rfc822_parse_addresses
type: function
doc:
<comment>Description:</comment>
  RFC 822 準拠のアドレスをパースする
  
  RFC 822 準拠の受信者リスト、 たとえば <return>To:</return> ヘッダの内容などをパースします。

<comment>Param:</comment>
  <info>string</info>  <strong>$addresses</strong>  アドレスを含む文字列。たとえば <return>Wez Furlong \<wez@example.com&gt;, doe@example.com</return> のようになります。
                      
                      この文字列にはヘッダ名を含めてはいけません。

<comment>Return:</comment>
  <info>array</info>  各受信者について以下のキーをもつ連想配列の配列を返します。 <return>display</return> 表示用の受信者名。この部
         分が設定されていない場合は、 <return>address</return> と同じ値となります。 <return>address</return>メールアドレス。<return>is_group</return>受
         信者がニュースグループである場合に <info>true</info>、そうでない場合に <info>false</info>。


id: mailparse_stream_encode
type: function
doc:
<comment>Description:</comment>
  ソースファイルポインタからストリームデータを取得し、
     エンコーディングを適用し、出力ファイルポインタに書き込む
    
  
  ソースファイルポインタからストリームデータを取得し、 <strong>$encoding</strong> を適用して それを出力ファイルポイン
  タに書き込みます。

<comment>Param:</comment>
  <info>resource</info>  <strong>$sourcefp</strong>  有効なファイルハンドル。このファイルからのストリームがパーサに流し込まれま
                       す。
  <info>resource</info>  <strong>$destfp</strong>    エンコードしたデータを書き込むファイルハンドル。
  <info>string</info>    <strong>$encoding</strong>  mbstring モジュールがサポートする文字エンコーディングのいずれか。

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


id: mailparse_uudecode_all
type: function
doc:
<comment>Description:</comment>
  ファイルポインタからデータをスキャンし、uuencode されたファイルを展開する
    
  
  指定したファイルポインタからのデータを読み込み、 uuencode されたファイルを一時ファイルに展開しま
  す。

<comment>Param:</comment>
  <info>resource</info>  <strong>$fp</strong>  有効なファイルポインタ。

<comment>Return:</comment>
  <info>array</info>  ファイル名の情報を含む連想配列の配列を返します。 <return>filename</return>作成された一時ファイルへのパス。
         <return>origfilename</return>もとのファイル名。uuencode されたパートにのみ存在します。 最初の filename エン
         トリがメッセージ本文、次のエントリがデコードされた uuencode ファイルとなります。


id: max
type: function
doc:
<comment>Description:</comment>
  最大値を返す
  
  代替のシグネチャ (名前付き引数をサポートしていません):
  
  パラメータとして配列をひとつだけ渡した場合は、<strong>max()</strong> は配列の中で最も大きい数値を返します。 ふたつ
  以上のパラメータを指定した場合は、<strong>max()</strong> はそれらの中で最も大きいものを返します。
  
  異なる型の値を比較する際には、 標準の比較ルールに従います。 たとえば、数値形式でない <info>string</info> を <info>int</info>
  と比較するときには、数値 <return>0</return> と評価します。 しかし、数値形式でない <info>string</info> どうしを比較するときには、
  アルファベット順で評価します。 返される値は、何も変換をしていない、元の型の値となります。
  
  異なる型の値を引数として渡す際には注意しましょう。 <strong>max()</strong> が予期せぬ結果を返す可能性があるからで
  す。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>        任意の 比較可能な 値。
  <info>mixed</info>  <strong>$values</strong>       任意の 比較可能な 複数の値。
  <info>array</info>  <strong>$value_array</strong>  値を含んだ配列。

<comment>Return:</comment>
  <info>mixed</info>  <strong>max()</strong> は、パラメータとして渡した値の中で、標準の比較ルールに従って最大になるものを返しま
         す。 異なる型で同じ値と評価される複数の値 (<return>0</return> と <return>'abc'</return> など) があった場合は、関数に最初に渡
         されたほうを返します。

<comment>See Also:</comment>
   * <strong>min()</strong>
   * <strong>count()</strong>


id: mb_check_encoding
type: function
doc:
<comment>Description:</comment>
  文字列が、指定したエンコーディングで有効なものかどうかを調べる
  
  そのバイトストリームが指定したエンコーディングで有効なものかどうかを調べます。 <strong>$value</strong> が配列の場
  合、全てのキーと値が再帰的に調べられます。 これは、いわゆる「不正なエンコーディングによる攻撃」を
  防ぐのに役立ちます。

<comment>Param:</comment>
  <info>array|string|null</info>  <strong>$value</strong>     調べるバイトストリーム または <info>array</info>。省略した場合は、 リクエスト開始
                                時からのすべての入力が対象となります。
                                
                                PHP 8.1.0 以降では、このパラメータを省略したり <info>null</info> を渡したりするこ
                                とは推奨されなくなっています。
  <info>string|null</info>        <strong>$encoding</strong>  期待するエンコーディング。

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


id: mb_chr
type: function
doc:
<comment>Description:</comment>
  Unicode のコードポイントに対応する文字を返す
  
  Unicode のコードポイントで指定された文字を含む文字列を返します この値は、指定されたエンコーディン
  グでエンコードされます。
  
  この関数は、<strong>mb_ord()</strong> を補完するものです。

<comment>Param:</comment>
  <info>int</info>          <strong>$codepoint</strong>  Unicode のコードポイント値。 たとえば、 U+1F418 ELEPHANT に対応する
                           <return>128024</return>。
  <info>string|null</info>  <strong>$encoding</strong>   <strong>$encoding</strong> 
                           パラメータには文字エンコーディングを指定します。省略した場合、もしくは
                           <info>null</info> の場合は、
                           内部文字エンコーディングを使用します。

<comment>Return:</comment>
  <info>string|false</info>  これは、指定されたエンコーディングで表現できる場合、 指定された文字を含む文字列を返
                します。 失敗した場合に <info>false</info> を返します

<comment>See Also:</comment>
   * <strong>mb_internal_encoding()</strong>
   * <strong>mb_ord()</strong>
   * <strong>IntlChar::ord()</strong>
   * <strong>chr()</strong>


id: mb_convert_case
type: function
doc:
<comment>Description:</comment>
  文字列に対してケースフォールディングを行う
  
  <strong>$mode</strong> で指定された方法で <strong>$string</strong> に対してケースフォールディングを行います。

<comment>Param:</comment>
  <info>string</info>       <strong>$string</strong>    変換される文字列。
  <info>int</info>          <strong>$mode</strong>      変換モード。以下のうちいずれかひとつです。 <info>MB_CASE_UPPER</info>,  <info>MB_CASE_LOWER</info>,
                          <info>MB_CASE_TITLE</info>, <info>MB_CASE_FOLD</info>, <info>MB_CASE_UPPER_SIMPLE</info>, <info>MB_CASE_LOWER_SIMPLE</info>,
                          <info>MB_CASE_TITLE_SIMPLE</info>, <info>MB_CASE_FOLD_SIMPLE</info>
  <info>string|null</info>  <strong>$encoding</strong>  <strong>$encoding</strong> 
                          パラメータには文字エンコーディングを指定します。省略した場合、もしくは
                          <info>null</info> の場合は、
                          内部文字エンコーディングを使用します。

<comment>Return:</comment>
  <info>string</info>  <strong>$mode</strong> で指定された方法で <strong>$string</strong> に対してケースフォールディングを行った結果を返します。

<comment>See Also:</comment>
   * <strong>mb_strtolower()</strong>
   * <strong>mb_strtoupper()</strong>
   * <strong>strtolower()</strong>
   * <strong>strtoupper()</strong>
   * <strong>ucfirst()</strong>
   * <strong>ucwords()</strong>


id: mb_convert_encoding
type: function
doc:
<comment>Description:</comment>
  ある文字エンコーディングの文字列を、別の文字エンコーディングに変換する
  
  文字列 <strong>$string</strong> の文字エンコーディングを、 <strong>$from_encoding</strong> または現在の内部エンコーディングから
  <strong>$to_encoding</strong> に変換します。 <strong>$string</strong> が配列の場合、それに含まれる全ての文字列型の値が再帰的に変換さ
  れます。

<comment>Param:</comment>
  <info>array|string</info>       <strong>$string</strong>         変換する <info>string</info> または <info>array</info>
  <info>string</info>             <strong>$to_encoding</strong>    変換したい文字エンコーディング。
  <info>array|string|null</info>  <strong>$from_encoding</strong>  <strong>$string</strong> を解釈するのに使われている 現在の文字エンコーディング。
                                     配列またはカンマ区切りの文字列とすることで、 複数のエンコーディ
                                     ングを指定できます。 この場合、正しいエンコーディングを
                                     <strong>mb_detect_encoding()</strong> と同じアルゴリズムで推測します。
                                     
                                     <strong>$from_encoding</strong> が省略されたり、 <info>null</info> だった場合は、
                                     mbstring.internal_encoding setting が設定されていた場合、それを
                                     使います。 設定されていない場合は、 default_charset setting を
                                     使います。
                                     
                                     <strong>$to_encoding</strong> や <strong>$from_encoding</strong> に指定できる値は、  サポートされ
                                     る文字エンコーディングを参照ください。

<comment>Return:</comment>
  <info>array|string|false</info>  成功時に、変換後の文字列または配列を返します。 失敗した場合に <info>false</info> を返します

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


id: mb_convert_kana
type: function
doc:
<comment>Description:</comment>
  カナを("全角かな"、"半角かな"等に)変換する
  
  文字列 <strong>$string</strong> に関して「半角」-「全角」変換を行います。 この関数は、日本語のみで使用可能です。

<comment>Param:</comment>
  <info>string</info>       <strong>$string</strong>    変換される文字列。
  <info>string</info>       <strong>$mode</strong>      変換オプション。
                          
                          以下のオプションを組み合わせて指定します。 使用可能な変換オプションオプ
                          ション意味<return>r</return> 「全角」英字を「半角」に変換します。 <return>R</return> 「半角」英字を「全角」
                          に変換します。 <return>n</return> 「全角」数字を「半角」に変換します。 <return>N</return> 「半角」数字を「全
                          角」に変換します。 <return>a</return> 「全角」英数字を「半角」に変換します。 <return>A</return> 「半角」英数
                          字を「全角」に変換します （"a", "A" オプションに含まれる文字は、U+0022,
                          U+0027, U+005C, U+007Eを除く U+0021 - U+007E の範囲です）。 <return>s</return> 「全角」ス
                          ペースを「半角」に変換します（U+3000 -&gt; U+0020）。 <return>S</return> 「半角」スペースを
                          「全角」に変換します（U+0020 -&gt; U+3000）。 <return>k</return> 「全角カタカナ」を「半角カ
                          タカナ」に変換します。 <return>K</return> 「半角カタカナ」を「全角カタカナ」に変換します。
                          <return>h</return> 「全角ひらがな」を「半角カタカナ」に変換します。 <return>H</return> 「半角カタカナ」を
                          「全角ひらがな」に変換します。 <return>c</return> 「全角カタカナ」を「全角ひらがな」に変換
                          します。 <return>C</return> 「全角ひらがな」を「全角カタカナ」に変換します。 <return>V</return> 濁点付きの文
                          字を一文字に変換します。"K", "H" と共に使用します。
  <info>string|null</info>  <strong>$encoding</strong>  <strong>$encoding</strong> 
                          パラメータには文字エンコーディングを指定します。省略した場合、もしくは
                          <info>null</info> の場合は、
                          内部文字エンコーディングを使用します。

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


id: mb_convert_variables
type: function
doc:
<comment>Description:</comment>
  変数の文字コードを変換する
  
  エンコーディング <strong>$from_encoding</strong> の変数 <strong>$var</strong> と <strong>$vars</strong> をエンコーディング <strong>$to_encoding</strong> に変換しま
  す。
  
  <strong>mb_convert_variables()</strong> は、エンコーディング検出のために Array または Object の文字列を結合します。
  これは、 エンコーディング検出は短い文字列では失敗する傾向があるためです。このため、 1 つの配列また
  はオブジェクトで異なるエンコーディングを混ぜることはできません。

<comment>Param:</comment>
  <info>string</info>        <strong>$to_encoding</strong>    文字列の変換後のエンコーディング。
  <info>array|string</info>  <strong>$from_encoding</strong>  <strong>$from_encoding</strong> には配列またはカンマ区切りの文字列を指定し、
                                <strong>$from-coding</strong> からエンコーディングの検出を試みます。 <strong>$from_encoding</strong>
                                が省略された場合、<return>detect_order</return> を使用します。
  <info>mixed</info>         <strong>$var</strong>            <strong>$var</strong>(3番目以降の引数)は、変換する変数への リファレンスです。文字列、
                                配列、オブジェクトを指定することが可能です。 <strong>mb_convert_variables()</strong>
                                は全てのパラメータが 同じエンコーディングを有することを仮定します。
  <info>mixed</info>         <strong>$vars</strong>           追加の変数。

<comment>Return:</comment>
  <info>string|false</info>  成功時に変換前の文字エンコーディングを返し、失敗した場合に <info>false</info> を返します。


id: mb_decode_mimeheader
type: function
doc:
<comment>Description:</comment>
  MIME ヘッダフィールドの文字列をデコードする
  
  エンコードされた MIME ヘッダの文字列 <strong>$string</strong> をデコードします。

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

<comment>Return:</comment>
  <info>string</info>  内部文字エンコーディングでデコードされた文字列を返します。

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


id: mb_decode_numericentity
type: function
doc:
<comment>Description:</comment>
  HTML 数値エンティティを文字にデコードする
  
  文字列 <strong>$string</strong> において指定した文字領域にある数値エンティティを変換し、 変換後の文字列を返します。

<comment>Param:</comment>
  <info>string</info>       <strong>$string</strong>    デコードする文字列。
  <info>array</info>        <strong>$map</strong>       <strong>$map</strong> は変換するコード領域を指定する配列です。
  <info>string|null</info>  <strong>$encoding</strong>  <strong>$encoding</strong> 
                          パラメータには文字エンコーディングを指定します。省略した場合、もしくは
                          <info>null</info> の場合は、
                          内部文字エンコーディングを使用します。
  <info></info>             <strong>$is_hex</strong>    このパラメータは使われていません。

<comment>Return:</comment>
  <info>string</info>  変換された文字列を返します。

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


id: mb_detect_encoding
type: function
doc:
<comment>Description:</comment>
  文字エンコーディングを検出する
  
  エンコーディングの候補の一覧から、 文字列 <strong>$string</strong> のもっとも可能性が高い文字エンコーディングを検出
  します。
  
  追加の情報なしに、 意図した文字エンコーディングを自動で検出する行為は、 全く役に立ちません。 これ
  は、暗号化された文字列を鍵なしにデコードする行為に似ています。 "Content-Type" HTTP ヘッダのよう
  な、 データを転送された際に付いてくる情報や、 保存された文字エンコーディングに関する指示を指定する
  ことが常に望ましいです。
  
  この関数は、全ての文字列が正しいバイト配列とは限らない マルチバイト文字列を指定するともっとも役に
  立ちます。 入力となる文字列に誤ったバイトが含まれていた場合、 そのエンコーディングは採用されず、次
  のものを試します。

<comment>Param:</comment>
  <info>string</info>             <strong>$string</strong>     調べる対象の文字列。
  <info>array|string|null</info>  <strong>$encodings</strong>  文字エンコーディングの一覧を試す順番に指定します。 このリストは、文
                                 字列の配列または、 カンマ区切りのリストで指定できます。
                                 
                                 <strong>$encodings</strong> が省略された場合、 または <info>null</info> の場合、 現在の
                                 detect_order  ( mbstring.detect_order 設定オプション または
                                 <strong>mb_detect_order()</strong> で設定したもの) を使います。
  <info>bool</info>               <strong>$strict</strong>     <strong>$encodings</strong> で指定された 文字エンコーディングのリストの全てに対し
                                 て、 不正と判定された場合の振る舞いを指定します。 <strong>$strict</strong> が <info>false</info>
                                 の場合、 もっとも近いと判定された文字エンコーディングが返されます。
                                 <strong>$strict</strong> を <info>true</info> にした場合、 <info>false</info> が返されます。
                                 
                                 <strong>$strict</strong> のデフォルト値は  mbstring.strict_detection 設定オプション
                                 で指定できます。

<comment>Return:</comment>
  <info>string|false</info>  検出した文字エンコーディングを返します。 指定したエンコーディングの全てに対して、不
                正と判定された場合は <info>false</info> を返します。

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


id: mb_detect_order
type: function
doc:
<comment>Description:</comment>
  文字エンコーディング検出順序を設定あるいは取得する
  
  自動文字エンコーディング検出の順番を <strong>$encoding</strong> に設定します。

<comment>Param:</comment>
  <info>array|string|null</info>  <strong>$encoding</strong>  <strong>$encoding</strong> は、 配列またはカンマ区切りの文字エンコーディングのリスト
                                です。サポートされる文字エンコーディングを参照ください。
                                
                                <strong>$encoding</strong> が省略された場合、または <info>null</info> の場合は、 現在の文字エン
                                コーディング検出順を配列で返します。
                                
                                この設定は、<strong>mb_detect_encoding()</strong> および <strong>mb_send_mail()</strong> に影響しま
                                す。
                                
                                <return>mbstring</return> が現在実装しているのは、 以下のエンコーディングを検出する
                                フィルタです。 以下のエンコーディングにおいて無効なバイトシーケンス
                                があった場合、 エンコーディング検出は失敗します。
                                
                                <return>UTF-8</return>, <return>UTF-7</return>, <return>ASCII</return>, <return>EUC-JP</return>,<return>SJIS</return>, <return>eucJP-win</return>, <return>SJIS-win</return>, <return>JIS</return>,
                                <return>ISO-2022-JP</return>
                                
                                <return>ISO-8859-*</return>の場合、<return>mbstring</return> は常に <return>ISO-8859-*</return> として検出します。
                                
                                <return>UTF-16</return>, <return>UTF-32</return>, <return>UCS2</return>, <return>UCS4</return> の場合、 エンコーディング検出は常に失敗し
                                ます。

<comment>Return:</comment>
  <info>array|bool</info>  検出順序を設定する場合は、成功した場合に <info>true</info> を返し、失敗したときに <info>false</info> を返しま
              す。
              
              検出順序を取得する場合は、エンコーディングの配列を返します。

<comment>See Also:</comment>
   * <strong>mb_internal_encoding()</strong>
   * <strong>mb_http_input()</strong>
   * <strong>mb_http_output()</strong>
   * <strong>mb_send_mail()</strong>


id: mb_encode_mimeheader
type: function
doc:
<comment>Description:</comment>
  MIMEヘッダの文字列をエンコードする
  
  MIME ヘッダエンコーディング方式によって文字列 <strong>$string</strong> をエンコードします。

<comment>Param:</comment>
  <info>string</info>       <strong>$string</strong>             エンコードする文字列。 <strong>mb_internal_encoding()</strong> と同じエンコーディ
                                   ングにしなければいけません。
  <info>string|null</info>  <strong>$charset</strong>            <strong>$charset</strong> は、<strong>$string</strong> の変換後の文字セット名です。デフォルトは、現
                                   在の NLS 設定 (<return>mbstring.language</return>) によって決まります。
  <info>string|null</info>  <strong>$transfer_encoding</strong>  <strong>$transfer_encoding</strong> は MIME エンコーディングの 方式を指定します。
                                   <return>"B"</return> (Base64) または <return>"Q"</return> (Quoted-Printable) のどちらかでなければな
                                   りません。 デフォルトは <return>"B"</return> です。
  <info>string</info>       <strong>$newline</strong>            <strong>$newline</strong> は EOL (行末) のマーカで、 <strong>mb_encode_mimeheader()</strong> が行を
                                   折りたたむ (RFC 用語で、 ある一定より長い行を複数行に分割すること
                                   を言います。 分割する長さは、現在 74 文字に固定されています) 際に
                                   利用します。 デフォルトは <return>"\r\n"</return> (CRLF) です。
  <info>int</info>          <strong>$indent</strong>             最初の行の字下げ (ヘッダで <strong>$string</strong> の前におく文字数)。

<comment>Return:</comment>
  <info>string</info>  文字列を ASCII 表現に変換したものを返します。

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


id: mb_encode_numericentity
type: function
doc:
<comment>Description:</comment>
  文字を HTML 数値エンティティにエンコードする
  
  <strong>$string</strong>の中で指定した文字コードを 文字コードから HTML 数値エンティティに変換します。

<comment>Param:</comment>
  <info>string</info>       <strong>$string</strong>    エンコードする文字列。
  <info>array</info>        <strong>$map</strong>       <strong>$map</strong> は、変換するコード領域を指定する配列です。
  <info>string|null</info>  <strong>$encoding</strong>  <strong>$encoding</strong> 
                          パラメータには文字エンコーディングを指定します。省略した場合、もしくは
                          <info>null</info> の場合は、
                          内部文字エンコーディングを使用します。
  <info>bool</info>         <strong>$hex</strong>       返されたエンティティのリファレンスが16進記法であるべきかどうか (<info>false</info> の場
                          合、10進記法です)

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

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


id: mb_encoding_aliases
type: function
doc:
<comment>Description:</comment>
  既知のエンコーディング・タイプのエイリアスを取得
  
  既知の <strong>$encoding</strong> タイプに関するエイリアスの配列を返します。

<comment>Param:</comment>
  <info>string</info>  <strong>$encoding</strong>  エイリアスに関してチェックするエンコーディングタイプ。

<comment>Return:</comment>
  <info>array</info>  数値インデックス付きの、エンコーディング・エイリアスの配列を返します。

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


id: mb_ereg
type: function
doc:
<comment>Description:</comment>
  マルチバイト対応の正規表現マッチ
  
  マルチバイト対応の正規表現マッチを行います。

<comment>Param:</comment>
  <info>string</info>  <strong>$pattern</strong>  検索パターン。
  <info>string</info>  <strong>$string</strong>   検索<info>文字列</info>。
  <info>array</info>   <strong>$matches</strong>  <strong>$pattern</strong> 内のカッコで囲まれた部分文字列にマッチするものが あった場合、第3引数
                    <strong>$matches</strong> が指定されていると、 配列 <strong>$matches</strong> の要素としてマッチ結果が格納されま
                    す。 マッチするものがなかった場合、<strong>$matches</strong> は空の配列となります。
                    
                    $matches[1] には最初の左括弧で指定された部分文字列が入ります。 $matches[2] には
                    2番目の左括弧で指定された部分文字列が入ります。 以下同様です。 $matches[0] には
                    マッチした文字列全体のコピーが入ります。

<comment>Return:</comment>
  <info>bool</info>  <strong>$string</strong> 内に <strong>$pattern</strong> にマッチする文字列があるかを返します。

<comment>See Also:</comment>
   * <strong>mb_regex_encoding()</strong>
   * <strong>mb_eregi()</strong>


id: mb_ereg_match
type: function
doc:
<comment>Description:</comment>
  マルチバイト文字列が正規表現に一致するか調べる
  
  マルチバイト文字列に対する正規表現マッチングを行います。  この関数は、<strong>$pattern</strong> が <strong>$string</strong> の先頭か
  らマッチするかどうかを調べます。
  
  この関数は、<strong>$pattern</strong> が <strong>$string</strong> の先頭からマッチするかどうかを調べます。

<comment>Param:</comment>
  <info>string</info>       <strong>$pattern</strong>  正規表現パターン。
  <info>string</info>       <strong>$string</strong>   評価する文字列。
  <info>string|null</info>  <strong>$options</strong>  検索オプション。説明は、<strong>mb_regex_set_options()</strong> を参照ください。

<comment>Return:</comment>
  <info>bool</info>  <strong>$string</strong> が正規表現 <strong>$pattern</strong> に一致する場合に<info>true</info> 、 そうでない場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>mb_regex_encoding()</strong>
   * <strong>mb_ereg()</strong>


id: mb_ereg_replace
type: function
doc:
<comment>Description:</comment>
  マルチバイト文字列に正規表現による置換を行う
  
  <strong>$string</strong> から <strong>$pattern</strong> にマッチする文字列を探し、 見つかった文字列を <strong>$replacement</strong> で置換します。

<comment>Param:</comment>
  <info>string</info>       <strong>$pattern</strong>      正規表現パターン。
                             
                             マルチバイト文字を <strong>$pattern</strong> で使用することができます。
  <info>string</info>       <strong>$replacement</strong>  置換文字列。
  <info>string</info>       <strong>$string</strong>       調べたい文字列。
  <info>string|null</info>  <strong>$options</strong>      検索オプション。説明は、<strong>mb_regex_set_options()</strong> を参照ください。

<comment>Return:</comment>
  <info>string|false|null</info>  成功した場合に結果の文字列、エラー時に <info>false</info> を返します。 <strong>$string</strong> が現在のエン
                     コーディングに照らして不正な場合は、<info>null</info> を返します。

<comment>See Also:</comment>
   * <strong>mb_regex_encoding()</strong>
   * <strong>mb_eregi_replace()</strong>


id: mb_ereg_replace_callback
type: function
doc:
<comment>Description:</comment>
  マルチバイト文字列にコールバック関数を用いた正規表現による置換を行う
    
  
  <strong>$string</strong>から <strong>$pattern</strong>にマッチする文字列を検索し、 一致した文字列を<strong>$callback</strong>関数の出力で置換します。
  
  この関数の動作は<strong>mb_ereg_replace()</strong>とほぼ同じですが、 <strong>$replacement</strong>パラメータの代わりに <strong>$callback</strong>を指
  定するところが異なります。

<comment>Param:</comment>
  <info>string</info>       <strong>$pattern</strong>   正規表現パターン。
                          
                          <strong>$pattern</strong>ではマルチバイト文字列を使用可能です。
  <info>callable</info>     <strong>$callback</strong>  コールバック関数で、 <strong>$subject</strong>文字列で一致した要素を配列で 指定してコールさ
                          れます。 このコールバック関数は、置換した文字列を返す必要があります。
                          
                          しばしば、 <strong>mb_ereg_replace_callback()</strong>の <strong>$callback</strong>関数が必要となるのは一度
                          だけである 場合があります。 この場合、 <strong>mb_ereg_replace_callback()</strong>をコール
                          する際の コールバックに 匿名関数 を使用することができます。 このようにする
                          ことで、 コールに関する全ての情報を一つの場所に集約し、 他のどこでも使用さ
                          れないコールバック関数の名前を 関数の名前空間にばらまかないですみます。
  <info>string</info>       <strong>$string</strong>    チェックされる<info>string</info>。
  <info>string|null</info>  <strong>$options</strong>   検索オプション。説明は、<strong>mb_regex_set_options()</strong> を参照ください。

<comment>Return:</comment>
  <info>string|false|null</info>  成功した際に置換後の文字列、 そうでない場合はエラー時に <info>false</info> を返します。
                     <strong>$string</strong> が現在のエンコーディングに照らして不正な場合は、<info>null</info> を返します。

<comment>See Also:</comment>
   * <strong>mb_regex_encoding()</strong>
   * <strong>mb_ereg_replace()</strong>
   * 匿名関数


id: mb_ereg_search
type: function
doc:
<comment>Description:</comment>
  指定したマルチバイト文字列が正規表現に一致するか調べる
  
  指定したマルチバイト文字列に対するマルチバイト正規表現マッチングを行います。

<comment>Param:</comment>
  <info>string|null</info>  <strong>$pattern</strong>  検索パターン。
  <info>string|null</info>  <strong>$options</strong>  検索オプション。説明は、<strong>mb_regex_set_options()</strong> を参照ください。

<comment>Return:</comment>
  <info>bool</info>  <strong>mb_ereg_search()</strong>は、マルチバイト文字列が正規表現に 一致するかどうか調べ、一致する場合に
        <info>true</info>、それ以外の場合に <info>false</info> を返します。検索対象の文字列は、 <strong>mb_ereg_search_init()</strong> により設
        定します。 正規表現 <strong>$pattern</strong> を省略した場合は、 前回のものを再利用します。

<comment>See Also:</comment>
   * <strong>mb_regex_encoding()</strong>
   * <strong>mb_ereg_search_init()</strong>


id: mb_ereg_search_getpos
type: function
doc:
<comment>Description:</comment>
  次の正規表現検索を開始する位置を取得する
  
  次の正規表現マッチングを開始する位置を返します。

<comment>Return:</comment>
  <info>int</info>  <strong>mb_ereg_search_getpos()</strong> は、 <strong>mb_ereg_search()</strong>, <strong>mb_ereg_search_pos()</strong>, <strong>mb_ereg_search_regs()</strong> で
       検索を開始する位置を返します。 位置は、文字列の先頭からのバイト数で表した値です。

<comment>See Also:</comment>
   * <strong>mb_regex_encoding()</strong>
   * <strong>mb_ereg_search_setpos()</strong>


id: mb_ereg_search_getregs
type: function
doc:
<comment>Description:</comment>
  マルチバイト文字列が正規表現に一致する部分があるか調べる
  
  直近のマルチバイト正規表現マッチングの結果を取得します。

<comment>Return:</comment>
  <info>array|false</info>  直前の <strong>mb_ereg_search()</strong>, <strong>mb_ereg_search_pos()</strong>, <strong>mb_ereg_search_regs()</strong> で一致した部分文
               字列を含む 配列を返します。一致する部分があった場合には、一致した部分文字列全体が 最
               初の要素に、最初の括弧でグループ化された部分が 2 番目の要素に、そして 2 番目の括弧で
               グループ化された部分が 3 番目の要素にといったようになります。 エラー時には <info>false</info> を返
               します。

<comment>See Also:</comment>
   * <strong>mb_regex_encoding()</strong>
   * <strong>mb_ereg_search_init()</strong>


id: mb_ereg_search_init
type: function
doc:
<comment>Description:</comment>
  マルチバイト正規表現検索用の文字列と正規表現を設定する
  
  <strong>mb_ereg_search_init()</strong> は、マルチバイト対応の正規 表現検索において検索対象の文字列 <strong>$string</strong> および正
  規表現 <strong>$pattern</strong> を設定します。 この設定は、<strong>mb_ereg_search()</strong>, <strong>mb_ereg_search_pos()</strong>,
  <strong>mb_ereg_search_regs()</strong> で使用されます。

<comment>Param:</comment>
  <info>string</info>       <strong>$string</strong>   検索文字列。
  <info>string|null</info>  <strong>$pattern</strong>  検索パターン。
  <info>string|null</info>  <strong>$options</strong>  検索オプション。説明は、<strong>mb_regex_set_options()</strong> を参照ください。

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

<comment>See Also:</comment>
   * <strong>mb_regex_encoding()</strong>
   * <strong>mb_ereg_search_regs()</strong>


id: mb_ereg_search_pos
type: function
doc:
<comment>Description:</comment>
  指定したマルチバイト文字列が正規表現に一致する部分の位置と長さを返す
  
  マルチバイト文字列の中で正規表現に一致した部分の位置と長さを配列で返します。
  
  検索対象の文字列は、<strong>mb_ereg_search_init()</strong> により設定します。省略した場合は、前回のものが利用されま
  す。

<comment>Param:</comment>
  <info>string|null</info>  <strong>$pattern</strong>  検索パターン。
  <info>string|null</info>  <strong>$options</strong>  検索オプション。説明は、<strong>mb_regex_set_options()</strong> を参照ください。

<comment>Return:</comment>
  <info>array|false</info>  ふたつの要素からなる配列を返します。最初の要素はオフセットをバイト単位で表したもの
               で、 マッチしたのが検索文字列の先頭から何バイト目かを示します。 二番目の要素はマッチ
               した部分の長さをバイト単位で表したものです。
               
               エラーが発生した場合は <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>mb_regex_encoding()</strong>
   * <strong>mb_ereg_search_init()</strong>


id: mb_ereg_search_regs
type: function
doc:
<comment>Description:</comment>
  指定したマルチバイト文字列が正規表現に一致する部分を取得する
  
  マルチバイト正規表現にマッチした部分を返します。

<comment>Param:</comment>
  <info>string|null</info>  <strong>$pattern</strong>  検索パターン。
  <info>string|null</info>  <strong>$options</strong>  検索オプション。説明は、<strong>mb_regex_set_options()</strong> を参照ください。

<comment>Return:</comment>
  <info>array|false</info>  <strong>mb_ereg_search_regs()</strong> は、マルチバイト文字列の 中に正規表現に一致する部分があるかどう
               か調べ、一致した場合にはそれを 配列で返します。配列の最初の要素には一致した部分文字列
               全体、2 番目の 要素は最初の括弧でグループ化された部分、3 番目の要素は2番目の括弧で グ
               ループ化された部分といったようになります。 エラー時には <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>mb_regex_encoding()</strong>
   * <strong>mb_ereg_search_init()</strong>


id: mb_ereg_search_setpos
type: function
doc:
<comment>Description:</comment>
  次の正規表現検索を開始する位置を設定する
  
  <strong>mb_ereg_search_setpos()</strong> は、 <strong>mb_ereg_search()</strong> で検索を開始する位置を設定します。

<comment>Param:</comment>
  <info>int</info>  <strong>$offset</strong>  設定する位置。負の値を指定すると、文字列の末尾から数えます。

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

<comment>See Also:</comment>
   * <strong>mb_regex_encoding()</strong>
   * <strong>mb_ereg_search_init()</strong>


id: mb_eregi
type: function
doc:
<comment>Description:</comment>
  マルチバイトをサポートし、大文字小文字を無視した正規表現マッチ
  
  マルチバイトをサポートし、かつ大文字小文字を無視した正規表現マッチを実行します。

<comment>Param:</comment>
  <info>string</info>  <strong>$pattern</strong>  正規表現のパターン
  <info>string</info>  <strong>$string</strong>   検索対象の <info>string</info>
  <info>array</info>   <strong>$matches</strong>  <strong>$pattern</strong> の 括弧で囲まれた部分文字列にマッチする部分が見つかり、 かつ3番目の引数
                    <strong>$matches</strong> が渡された場合、 マッチした部分が <strong>$matches</strong> 配列に格納されます。 何も
                    マッチしなかった場合、 <strong>$matches</strong> には空の配列が設定されます。
                    
                    $matches[1] には、最初の左括弧から始まる部分文字列が含まれます。 $matches[2] に
                    は、二番目の左括弧から始まる部分文字列が含まれます。 以後同様です。 $matches[0]
                    には、マッチした文字列全体のコピーが含まれます。

<comment>Return:</comment>
  <info>bool</info>  <strong>$string</strong> 内に <strong>$pattern</strong> にマッチする文字列があるかを返します。

<comment>See Also:</comment>
   * <strong>mb_regex_encoding()</strong>
   * <strong>mb_ereg()</strong>


id: mb_eregi_replace
type: function
doc:
<comment>Description:</comment>
  マルチバイト文字列に大文字小文字を区別せずに正規表現による置換を行う
  
  <strong>$string</strong> において、 正規表現 <strong>$pattern</strong> にマッチする文字列を <strong>$replacement</strong> に置換します。

<comment>Param:</comment>
  <info>string</info>       <strong>$pattern</strong>      正規表現パターン。マルチバイト文字を使用できます。 大文字小文字は区別し
                             ません。
  <info>string</info>       <strong>$replacement</strong>  置換する文字列。
  <info>string</info>       <strong>$string</strong>       検索対象となる文字列。
  <info>string|null</info>  <strong>$options</strong>      検索オプション。説明は、<strong>mb_regex_set_options()</strong> を参照ください。

<comment>Return:</comment>
  <info>string|false|null</info>  結果の文字列、あるいはエラー時に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>mb_regex_encoding()</strong>
   * <strong>mb_ereg_replace()</strong>


id: mb_get_info
type: function
doc:
<comment>Description:</comment>
  mbstring の内部設定値を取得する
  
  <strong>mb_get_info()</strong> は、mbstring の内部設定パラメータを返します。

<comment>Param:</comment>
  <info>string</info>  <strong>$type</strong>  <strong>$type</strong> が指定されない場合、または、<return>"all"</return> の場合、 <return>"internal_encoding"</return>, <return>"http_input"</return>,
                 <return>"http_output"</return>, <return>"http_output_conv_mimetypes"</return>, <return>"mail_charset"</return>,
                 <return>"mail_header_encoding"</return>, <return>"mail_body_encoding"</return>, <return>"illegal_chars"</return>,
                 <return>"encoding_translation"</return>, <return>"language"</return>, <return>"detect_order"</return>, <return>"substitute_character"</return>,
                 <return>"strict_detection"</return> の設定値を有する連想配列が返されます。
                 
                 <strong>$type</strong> に <return>"internal_encoding"</return>, <return>"http_input"</return>, <return>"http_output"</return>,
                 <return>"http_output_conv_mimetypes"</return>, <return>"mail_charset"</return>, <return>"mail_header_encoding"</return>,
                 <return>"mail_body_encoding"</return>, <return>"illegal_chars"</return>, <return>"encoding_translation"</return>, <return>"language"</return>,
                 <return>"detect_order"</return>, <return>"substitute_character"</return>, <return>"strict_detection"</return> が指定された場合、 指定
                 された設定パラメータが返されます。

<comment>Return:</comment>
  <info>array|string|int|false</info>  <strong>$type</strong> が指定されていない場合は型情報を含む配列、 それ以外の場合は指定した
                          <strong>$type</strong> の値を返します。 失敗した場合に <info>false</info> を返します

<comment>See Also:</comment>
   * <strong>mb_regex_encoding()</strong>
   * <strong>mb_http_output()</strong>


id: mb_http_input
type: function
doc:
<comment>Description:</comment>
  HTTP 入力文字エンコーディングを検出する
  
  HTTP 入力文字エンコーディングを検出します。

<comment>Param:</comment>
  <info>string|null</info>  <strong>$type</strong>  HTTP 入力の型を表す文字列を入力してください。 GET の場合は <return>"G"</return>、POST の場合は
                      <return>"P"</return>、 COOKIE の場合は <return>"C"</return>、文字列の場合は <return>"S"</return>、 リストの場合は <return>"L"</return>、リスト全体
                      （配列を返す） の場合は <return>"I"</return> です。 <strong>$type</strong> が省略された場合、 直近に処理された入
                      力型が返されます。

<comment>Return:</comment>
  <info>array|string|false</info>  <strong>$type</strong> の文字エンコーディング名を返します。 <strong>$type</strong> が <return>"I"</return> の場合は、 文字エン
                      コーディング名の配列を返します。 <strong>mb_http_input()</strong> が指定した HTTP 入力の処理を
                      行っていない場合、<info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>mb_internal_encoding()</strong>
   * <strong>mb_http_output()</strong>
   * <strong>mb_detect_order()</strong>


id: mb_http_output
type: function
doc:
<comment>Description:</comment>
  HTTP 出力文字エンコーディングを設定あるいは取得する
  
  HTTP 出力文字エンコーディングを設定あるいは取得します。 この関数を実行した後、 出力は内部エンコー
  ディングから <strong>$encoding</strong> に変換されます。

<comment>Param:</comment>
  <info>string|null</info>  <strong>$encoding</strong>  <strong>$encoding</strong> が設定された場合、 <strong>mb_http_output()</strong> は HTTP 出力文字エンコーディ
                          ングを <strong>$encoding</strong>に設定します。
                          
                          <strong>$encoding</strong> が省略された場合、 <strong>mb_http_output()</strong> は現在の HTTP 出力文字エン
                          コーディングを返します。

<comment>Return:</comment>
  <info>string|bool</info>  <strong>$encoding</strong> が省略された場合、 <strong>mb_http_output()</strong> は現在の HTTP 出力文字エンコーディング
               を返します。それ以外の場合、 成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返しま
               す。

<comment>See Also:</comment>
   * <strong>mb_internal_encoding()</strong>
   * <strong>mb_http_input()</strong>
   * <strong>mb_detect_order()</strong>


id: mb_internal_encoding
type: function
doc:
<comment>Description:</comment>
  内部文字エンコーディングを設定あるいは取得する
  
  内部文字エンコーディングを設定あるいは取得します。

<comment>Param:</comment>
  <info>string|null</info>  <strong>$encoding</strong>  <strong>$encoding</strong> は、HTTP 入力文字エンコーディング変換、 HTTP 出力文字エンコー
                          ディング変換および mbstring モジュールの文字列関数においてデフォルトの文字
                          エンコーディングとして使用されます。 マルチバイト正規表現用のエンコーディ
                          ングは、ここで扱う内部文字エンコーディングとは別であることに注意してくださ
                          い。

<comment>Return:</comment>
  <info>string|bool</info>  <strong>$encoding</strong> が設定された場合、 成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返しま
               す。 このとき、マルチバイト正規表現用のエンコーディングは変更されません。 <strong>$encoding</strong>
               が省略された場合、 現在の内部文字エンコーディング名を返します。

<comment>See Also:</comment>
   * <strong>mb_http_input()</strong>
   * <strong>mb_http_output()</strong>
   * <strong>mb_detect_order()</strong>
   * <strong>mb_regex_encoding()</strong>


id: mb_language
type: function
doc:
<comment>Description:</comment>
  現在の言語を設定あるいは取得する
  
  現在の言語を設定あるいは取得します。

<comment>Param:</comment>
  <info>string|null</info>  <strong>$language</strong>  e-mail メッセージのエンコーディングとして使用します。 有効な言語の一覧は、
                          以下のテーブルで示します。 <strong>mb_send_mail()</strong> は、e-mail をエンコードする際に
                          この設定を使用します。

<comment>Return:</comment>
  <info>string|bool</info>  <strong>$language</strong> が設定され、 <strong>$language</strong> が有効な場合、<info>true</info>が返されます。 そうでない場合、
               <info>false</info>が返されます。 <strong>$language</strong> が省略された場合、または <info>null</info> の場合、 言語の名前が文字
               列として返されます。

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


id: mb_list_encodings
type: function
doc:
<comment>Description:</comment>
  サポートするすべてのエンコーディングの配列を返す
  
  サポートするすべてのエンコーディングの配列を返します。

<comment>Return:</comment>
  <info>array</info>  数値添字の配列を返します。

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


id: mb_ord
type: function
doc:
<comment>Description:</comment>
  文字の Unicode コードポイントを取得する
  
  指定された文字の Unicode コードポイントを返します。
  
  この関数は <strong>mb_chr()</strong> を補完するものです。

<comment>Param:</comment>
  <info>string</info>       <strong>$string</strong>    文字列
  <info>string|null</info>  <strong>$encoding</strong>  <strong>$encoding</strong> 
                          パラメータには文字エンコーディングを指定します。省略した場合、もしくは
                          <info>null</info> の場合は、
                          内部文字エンコーディングを使用します。

<comment>Return:</comment>
  <info>int|false</info>  <return>string</return> のはじめの文字に対応する Unicode コードポイントを返します。 失敗した場合に <info>false</info>
             を返します.

<comment>See Also:</comment>
   * <strong>mb_internal_encoding()</strong>
   * <strong>mb_chr()</strong>
   * <strong>IntlChar::ord()</strong>
   * <strong>ord()</strong>


id: mb_output_handler
type: function
doc:
<comment>Description:</comment>
  出力バッファ内で文字エンコーディングを変換するコールバック関数
  
  <strong>mb_output_handler()</strong> は、 <strong>ob_start()</strong> のコールバック関数です。 <strong>mb_output_handler()</strong> は、出力バッファ
  の文字を 内部文字エンコーディングから HTTP 出力文字エンコーディングに変換します。

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  出力バッファの中身。
  <info>int</info>     <strong>$status</strong>  出力バッファの状態。

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

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


id: mb_parse_str
type: function
doc:
<comment>Description:</comment>
  GET/POST/COOKIE データをパースし、グローバル変数を設定する
  
  GET/POST/COOKIE データをパースし、 グローバル変数を設定します。PHPは、生の POST/COOKIE を提供しな
  いため、 現状では GET データでのみ使用可能です。この関数は、URL エンコードされたデータをパース、エ
  ンコーディングを検出、 内部エンコーディングへ変換し、配列<strong>$result</strong> またはグローバル配列に設定しま
  す。

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  URL エンコードされたデータ。
  <info>array</info>   <strong>$result</strong>  デコードされ、文字エンコーディング変換された文字列が含まれます。

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

<comment>See Also:</comment>
   * <strong>mb_detect_order()</strong>
   * <strong>mb_internal_encoding()</strong>


id: mb_preferred_mime_name
type: function
doc:
<comment>Description:</comment>
  MIME 文字設定を文字列で得る
  
  指定したエンコーディングの MIME <return>charset</return> 文字列を取得します。

<comment>Param:</comment>
  <info>string</info>  <strong>$encoding</strong>  調べるエンコーディング。

<comment>Return:</comment>
  <info>string|false</info>  文字エンコーディング <strong>$encoding</strong> 用の MIME <return>charset</return> 文字列を返します。 指定された
                <strong>$encoding</strong> に対して、 好ましい charset がない場合は <info>false</info> を返します。


id: mb_regex_encoding
type: function
doc:
<comment>Description:</comment>
  現在のマルチバイト正規表現用のエンコーディングを取得または設定する
  
  現在のマルチバイト正規表現用のエンコーディングを取得または設定する

<comment>Param:</comment>
  <info>string|null</info>  <strong>$encoding</strong>  <strong>$encoding</strong> 
                          パラメータには文字エンコーディングを指定します。省略した場合、もしくは
                          <info>null</info> の場合は、
                          内部文字エンコーディングを使用します。

<comment>Return:</comment>
  <info>string|bool</info>  encoding が設定された場合、成功した場合に TRUE を、失敗した場合に FALSE を返します。
               このとき、内部文字エンコーディングは変更されません。 encoding が省略された場合、現在
               のマルチバイト用の正規表現関数で用いる文字エンコーディング名を返します。

<comment>See Also:</comment>
   * <strong>mb_internal_encoding()</strong>
   * <strong>mb_ereg()</strong>


id: mb_regex_set_options
type: function
doc:
<comment>Description:</comment>
  マルチバイト正規表現関数のデフォルトオプションを取得または設定する
  
  <strong>$options</strong> で表されるオプションを、 マルチバイト対応の正規表現関数のデフォルトに設定します。

<comment>Param:</comment>
  <info>string|null</info>  <strong>$options</strong>  設定するオプション。文字列で設定し、各文字がオプションを表します。 モードを
                         設定する際には、モード文字は最後に指定しなければなりません。 オプションは複
                         数指定できますが、モードはひとつしか指定できません。
                         
                         <strong>mb_regex_set_options()</strong> に <return>"e"</return> オプションを設定しても、何も起きません。
                         <strong>mb_ereg_replace()</strong> や <strong>mb_eregi_replace()</strong> で指定するようにしてください。

<comment>Return:</comment>
  <info>string</info>  以前設定されていたオプションを返します。 <strong>$options</strong> が省略された場合、または <info>null</info> の場合、
          現在設定されているオプションを文字列で返します。

<comment>See Also:</comment>
   * <strong>mb_split()</strong>
   * <strong>mb_ereg()</strong>
   * <strong>mb_eregi()</strong>


id: mb_scrub
type: function
doc:
<comment>Description:</comment>
  文字列に含まれる不正なバイト列を代替文字に置き換える
  
  指定されたエンコーディングに基づいて、文字の変換を行います。 エンコーディングが指定されない場合
  は、 デフォルトのエンコーディングが使われます。 この関数は、不正なバイトシーケンスを代替文字に置換
  する効果があります。

<comment>Param:</comment>
  <info>string</info>       <strong>$string</strong>    入力文字列
  <info>string|null</info>  <strong>$encoding</strong>  <strong>$string</strong> を解釈するエンコーディング。 省略されるか、<info>null</info> でない場合は、
                          mbstring.internal_encoding setting が設定されている場合、それを使います。
                          設定されていない場合は、default_charset の設定を使います。

<comment>Return:</comment>
  <info>string</info>  不正なバイトシーケンスを置換した文字列を返します。


id: mb_send_mail
type: function
doc:
<comment>Description:</comment>
  エンコード変換を行ってメールを送信する
  
  email を送信します。ヘッダと本文は <strong>mb_language()</strong> の設定に基づき変換、エンコードされます。 これは
  <strong>mail()</strong> のラッパー関数です。詳細は、 <strong>mail()</strong> を参照ください。

<comment>Param:</comment>
  <info>string</info>        <strong>$to</strong>                  送信先のメールアドレス。 各アドレスをカンマで区切ると、複数の宛
                                     先を <strong>$to</strong> に指定できます。 このパラメータは、自動的にはエンコー
                                     ドされません。
  <info>string</info>        <strong>$subject</strong>             メールの件名。
  <info>string</info>        <strong>$message</strong>             メールの本文。
  <info>array|string</info>  <strong>$additional_headers</strong>  メールヘッダの最後に挿入される <info>String</info> または <info>array</info>
                                     
                                     通常、これは追加のヘッダ（From、Cc、Bcc）のために用いられます。
                                     複数のヘッダを追加する場合は CRLF（\r\n）で区切ります。 攻撃者
                                     が不要なヘッダーを注入しないようにパラメータを検証してくださ
                                     い。
                                     
                                     <info>array</info> が渡された場合、キーと値はそれぞれ ヘッダーの名前および値
                                     です。
                                     
                                     メールを送信する際には、必ず  <return>From</return> ヘッダが含まれていなければな
                                     りません。 <strong>$additional_headers</strong> パラメータで指定するか、 あるい
                                     は php.ini にデフォルト値を指定します。
                                     
                                     指定しなかった場合は、以下のようなエラーメッセージが返ります
                                     <return>Warning: mail(): "sendmail_from" not set in php.ini or custom
                                     "From:" header missing</return> 。 Windows では、<return>From</return> ヘッダを設定すると
                                     <return>Return-Path</return> も設定されます。
                                     
                                     メッセージが受信されなかった場合には、LF（\n）のみを使ってみて
                                     ください。 Unix の MTA の中には、自動的に LF を CRLF に変換して
                                     しまう もの (有名なところでは、qmail など) があります（もし
                                     CRLF を利用していた場合、CR が重複してしまいます）。 ただし、こ
                                     れは最後の手段です。というのも、これは RFC 2822 に違反している
                                     からです。
  <info>string|null</info>   <strong>$additional_params</strong>   <strong>$additional_params</strong> は、MTA へ渡す コマンドライン引数です。
                                     sendmail を利用する際に正しい Return-Path を設定するためなどに
                                     利用すると便利です。
                                     
                                     このパラメータはコマンドの実行を防止するために内部的に
                                     <strong>escapeshellcmd()</strong> によってエスケープされます。 <strong>escapeshellcmd()</strong>
                                     はコマンドの実行を防止しますが、 別のパラメータを追加することは
                                     許してしまいます。セキュリティ上の理由から、 このパラメータは検
                                     証されるべきです。
                                     
                                     <strong>escapeshellcmd()</strong> が自動的に適用されるため、 インターネット RFC
                                     でメールアドレスとして許可さているいくつかの文字を使用すること
                                     ができません。 これらの文字を使用することが必須であるプログラム
                                     では <strong>mail()</strong> を使うことはできません。
                                     
                                     この方法でエンベロープの sender ヘッダ（-f）を設定する際は、
                                     'X-Warning' ヘッダが付加されないように Web サーバーの実行ユー
                                     ザーを sendmail 設定に追加しておく必要があるかもしれません。
                                     sendmail を利用している場合、これは /etc/mail/trusted-users で
                                     設定します。

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

<comment>See Also:</comment>
   * <strong>mail()</strong>
   * <strong>mb_encode_mimeheader()</strong>
   * <strong>mb_language()</strong>


id: mb_split
type: function
doc:
<comment>Description:</comment>
  マルチバイト文字列を正規表現により分割する
  
  マルチバイト文字列 <strong>$string</strong> において、正規表現 <strong>$pattern</strong> により文字列を分割し、 結果を配列として返し
  ます。

<comment>Param:</comment>
  <info>string</info>  <strong>$pattern</strong>  正規表現パターン。
  <info>string</info>  <strong>$string</strong>   分割する文字列。
  <info>int</info>     <strong>$limit</strong>    オプションの引数 <strong>$limit</strong> を指定した場合は、 最大 <strong>$limit</strong> 個の要素に分割されます。

<comment>Return:</comment>
  <info>array|false</info>  結果を配列で返します。 失敗した場合に <info>false</info> を返します

<comment>See Also:</comment>
   * <strong>mb_regex_encoding()</strong>
   * <strong>mb_ereg()</strong>


id: mb_str_pad
type: function
doc:
<comment>Description:</comment>
  マルチバイト文字列を、特定の長さまで別のマルチバイト文字列で埋める
  
  この関数は文字列 <strong>$string</strong> の左、右または両側を指定した長さで埋めます。 長さは Unicode のコードポイ
  ント単位で決まります。 <strong>$pad_string</strong> が指定されていない場合は、 <strong>$string</strong> は空白で埋められ、それ以外の
  場合は、 <strong>$pad_string</strong> からの文字で制限まで埋められます。

<comment>Param:</comment>
  <info>string</info>       <strong>$string</strong>      入力文字列。
  <info>int</info>          <strong>$length</strong>      <strong>$length</strong> の値が負、 または入力文字列の長さ以下である場合、埋める操作は行
                            われません。 <strong>$string</strong> をそのまま返します。
  <info>string</info>       <strong>$pad_string</strong>  必要とされる埋める文字数が <strong>$pad_string</strong> の長さで均等に分割できない場合、
                            <strong>$pad_string</strong> は切り捨てられます。
  <info>int</info>          <strong>$pad_type</strong>    オプションの引数 <strong>$pad_type</strong> には、 <info>STR_PAD_RIGHT</info>, <info>STR_PAD_LEFT</info>,
                            <info>STR_PAD_BOTH</info> を指定可能です。 <strong>$pad_type</strong>が指定されない場合、
                            <info>STR_PAD_RIGHT</info> を仮定します。
  <info>string|null</info>  <strong>$encoding</strong>    <strong>$encoding</strong> 
                            パラメータには文字エンコーディングを指定します。省略した場合、もしくは
                            <info>null</info> の場合は、
                            内部文字エンコーディングを使用します。

<comment>Return:</comment>
  <info>string</info>  埋めた後の文字列を返します。


id: mb_str_split
type: function
doc:
<comment>Description:</comment>
  マルチバイト文字列を受取り、文字の配列を返す
  
  この関数は文字列の配列を返します。 これは <strong>str_split()</strong> に 1, 2 または 4バイトの固定長のエンコーディ
  ングだけでなく、 可変長のエンコーディングのサポートも追加したものです。 <strong>$length</strong> を指定すると、 文
  字列は指定された数の(バイトではなく)文字のチャンクに分割されます。 <strong>$encoding</strong> もオプションで指定で
  きますが、 指定するほうが良いでしょう。

<comment>Param:</comment>
  <info>string</info>       <strong>$string</strong>    文字またはチャンクに分割する <info>string</info>
  <info>int</info>          <strong>$length</strong>    これを指定すると、返される配列の個々の要素は一文字ではなく複数の文字になり
                          ます。
  <info>string|null</info>  <strong>$encoding</strong>  <strong>$encoding</strong> 
                          パラメータには文字エンコーディングを指定します。省略した場合、もしくは
                          <info>null</info> の場合は、
                          内部文字エンコーディングを使用します。
                          
                          サポートされているエンコーディングのうち、ひとつを指定した文字列

<comment>Return:</comment>
  <info>array</info>  <strong>mb_str_split()</strong> は、<info>string</info> の配列を返します。

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


id: mb_strcut
type: function
doc:
<comment>Description:</comment>
  文字列の一部を得る
  
  <strong>mb_strcut()</strong> は、ある文字列からの部分文字列の抽出を <strong>mb_substr()</strong> と同じ方法で行います。ただし、 処理
  は文字単位ではなくバイト単位で行います。 切り出し位置がたまたまマルチバイト文字の 2 バイト目以降
  だった場合、 切り出しはその文字の最初のバイトから行われます。この挙動もまた <strong>substr()</strong> 関数と異なる
  ところです。 <strong>substr()</strong> の場合は、 マルチバイト文字の 2 バイト目以降であってもその位置から切り出しを
  行い、 結果的に壊れたバイト列を返すことになります。

<comment>Param:</comment>
  <info>string</info>       <strong>$string</strong>    取り出しの対象となる文字列。
  <info>int</info>          <strong>$start</strong>     <strong>$start</strong> が非負である場合に返される文字列は、 <strong>$string</strong> の <strong>$start</strong> バイト目以降
                          の文字列となります (ゼロから数えます)。 たとえば、文字列 '<return>abcdef</return>' の <return>0</return> バ
                          イト目は '<return>a</return>' で、 <return>2</return> バイト目は '<return>c</return>' のようになります。
                          
                          <strong>$start</strong> が負の場合に返される文字列は、 <strong>$string</strong> の後ろから数えて <strong>$start</strong> バイ
                          ト目以降となります。  負の <strong>$start</strong> の絶対値が文字列の長さよりも大きい場合、
                          返される文字列は、<strong>$string</strong> の先頭から始まります。
  <info>int|null</info>     <strong>$length</strong>    バイト単位での長さ。 省略したり <return>NULL</return> を指定したりした場合は、 文字列の最後
                          までの全バイトを取り出します。
                          
                          <strong>$length</strong> が負の場合、返される文字列は <strong>$string</strong> の後ろから数えて <strong>$length</strong> バイ
                          ト目で終了します。 しかし、負の <strong>$length</strong> の絶対値が <strong>$start</strong> の位置を超える場
                          合、空の文字列が返されます。
  <info>string|null</info>  <strong>$encoding</strong>  <strong>$encoding</strong> 
                          パラメータには文字エンコーディングを指定します。省略した場合、もしくは
                          <info>null</info> の場合は、
                          内部文字エンコーディングを使用します。

<comment>Return:</comment>
  <info>string</info>  <strong>mb_strcut()</strong> は、 <strong>$start</strong> および <strong>$length</strong> パラメータで指定した <strong>$string</strong> の一部を返します。

<comment>See Also:</comment>
   * <strong>mb_substr()</strong>
   * <strong>mb_internal_encoding()</strong>


id: mb_strimwidth
type: function
doc:
<comment>Description:</comment>
  指定した幅で文字列を丸める
  
  文字列 <strong>$string</strong> を指定した幅 <strong>$width</strong> で丸めます。 半角文字は <return>1</return> として、 全角文字は <return>2</return> として数えま
  す。 東アジアの文字の長さに関する詳細は http://www.unicode.org/reports/tr11/ を参照ください。

<comment>Param:</comment>
  <info>string</info>       <strong>$string</strong>       丸めたい文字列。
  <info>int</info>          <strong>$start</strong>        開始位置のオフセット。文字列の始めからの文字数 (最初の文字は 0) です。
                             負のオフセットは、文字列の末尾からのオフセットと解釈されます。
  <info>int</info>          <strong>$width</strong>        丸める幅。 負の値を指定すると、文字列の末尾からの幅を数えます。  負の値
                             を指定することは、PHP 8.3.0 以降では推奨されなくなっています。
                             
                             負の値を指定することは、PHP 8.3.0 以降では推奨されなくなっています。
  <info>string</info>       <strong>$trim_marker</strong>  丸めた後にその文字列の最後に追加される文字列。
  <info>string|null</info>  <strong>$encoding</strong>     <strong>$encoding</strong> 
                             パラメータには文字エンコーディングを指定します。省略した場合、もしくは
                             <info>null</info> の場合は、
                             内部文字エンコーディングを使用します。

<comment>Return:</comment>
  <info>string</info>  丸められた文字列を返します。 <strong>$trim_marker</strong> が設定された場合、 <strong>$width</strong> にマッチする最後の文字
          を <strong>$trim_marker</strong> で置き換えます。

<comment>See Also:</comment>
   * <strong>mb_strwidth()</strong>
   * <strong>mb_internal_encoding()</strong>


id: mb_stripos
type: function
doc:
<comment>Description:</comment>
  大文字小文字を区別せず、
     文字列の中で指定した文字列が最初に現れる位置を探す
    
  
  <strong>mb_stripos()</strong> は、 <strong>$needle</strong> が <strong>$haystack</strong> の中で最初に現れる位置を返します。 <strong>mb_strpos()</strong> とは異なり、
  <strong>mb_stripos()</strong> は大文字小文字を区別しません。 <strong>$needle</strong> が見つからなかった場合は <info>false</info> を返します。

<comment>Param:</comment>
  <info>string</info>       <strong>$haystack</strong>  <strong>$needle</strong> が最初に現れる位置を見つける文字列。
  <info>string</info>       <strong>$needle</strong>    <strong>$haystack</strong> の中で探す文字列。
  <info>int</info>          <strong>$offset</strong>    <strong>$haystack</strong> の中で、検索を開始する位置。 負のオフセットは、文字列の末尾から
                          のオフセットと解釈されます。
  <info>string|null</info>  <strong>$encoding</strong>  使用する文字エンコーディング名。 省略した場合は内部文字エンコーディングが
                          用いられます。

<comment>Return:</comment>
  <info>int|false</info>  <strong>$needle</strong> が <strong>$haystack</strong> の中で最初に現れる位置を返します。<strong>$needle</strong> が見つからない場合は
             <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>stripos()</strong>
   * <strong>strpos()</strong>
   * <strong>mb_strpos()</strong>


id: mb_stristr
type: function
doc:
<comment>Description:</comment>
  大文字小文字を区別せず、
     文字列の中で指定した文字列が最初に現れる位置を探す
    
  
  <strong>mb_stristr()</strong> は、 <strong>$haystack</strong> の中で最初に <strong>$needle</strong> が現れる場所を探し、 <strong>$haystack</strong> の部分文字列を返し
  ます。 <strong>mb_strstr()</strong> とは異なり、 <strong>mb_stristr()</strong> は大文字小文字を区別しません。 <strong>$needle</strong> が見つからな
  かった場合は <info>false</info> を返します。

<comment>Param:</comment>
  <info>string</info>       <strong>$haystack</strong>       <strong>$needle</strong> が最初に現れる位置を見つける文字列。
  <info>string</info>       <strong>$needle</strong>         <strong>$haystack</strong> の中で探す文字列。
  <info>bool</info>         <strong>$before_needle</strong>  この関数が <strong>$haystack</strong> のどの部分を返すのかを指定します。 <info>true</info> の場合
                               は、<strong>$haystack</strong> の先頭から <strong>$needle</strong> が最初に現れる位置までを返します
                               (needle を含めません)。 <info>false</info> の場合は、<strong>$needle</strong> が最初に現れる位置か
                               ら <strong>$haystack</strong> の最後までを返します (needle を含めます)。
  <info>string|null</info>  <strong>$encoding</strong>       使用する文字エンコーディング名。 省略した場合は内部文字エンコーディン
                               グが用いられます。

<comment>Return:</comment>
  <info>string|false</info>  <strong>$haystack</strong> の部分文字列を返します。 <strong>$needle</strong> が見つからない場合は <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>stristr()</strong>
   * <strong>strstr()</strong>
   * <strong>mb_strstr()</strong>


id: mb_strlen
type: function
doc:
<comment>Description:</comment>
  文字列の長さを得る
  
  文字列の長さを取得します。

<comment>Param:</comment>
  <info>string</info>       <strong>$string</strong>    長さを調べたい文字列。
  <info>string|null</info>  <strong>$encoding</strong>  <strong>$encoding</strong> 
                          パラメータには文字エンコーディングを指定します。省略した場合、もしくは
                          <info>null</info> の場合は、
                          内部文字エンコーディングを使用します。

<comment>Return:</comment>
  <info>int</info>  文字エンコーディング <strong>$encoding</strong> の文字列 <strong>$string</strong> の文字数を返します。 マルチバイト文字の一文字
       は1個として数えられます。

<comment>See Also:</comment>
   * <strong>mb_internal_encoding()</strong>
   * <strong>grapheme_strlen()</strong>
   * <strong>iconv_strlen()</strong>
   * <strong>strlen()</strong>


id: mb_strpos
type: function
doc:
<comment>Description:</comment>
  文字列の中に指定した文字列が最初に現れる位置を見つける
  
  ある文字列の中で別の文字列が最初に現れる位置を見つけます。
  
  マルチバイト文字列に正しくマッチするように <strong>strpos()</strong> を拡張したもので、 最初の 1 文字目の位置が 0
  、2 文字目の文字が 1 というようになります。

<comment>Param:</comment>
  <info>string</info>       <strong>$haystack</strong>  調べたい文字列。
  <info>string</info>       <strong>$needle</strong>    <strong>$haystack</strong> の中から探す文字列。 <strong>strpos()</strong> とは違い、 数値を指定しても文字
                          コードの値と見なされることはありません。
  <info>int</info>          <strong>$offset</strong>    検索オフセット。 指定されない場合は、0 が使用されます。 負のオフセットは、
                          文字列の末尾からのオフセットと解釈されます。
  <info>string|null</info>  <strong>$encoding</strong>  <strong>$encoding</strong> 
                          パラメータには文字エンコーディングを指定します。省略した場合、もしくは
                          <info>null</info> の場合は、
                          内部文字エンコーディングを使用します。

<comment>Return:</comment>
  <info>int|false</info>  文字列 <strong>$haystack</strong> の中で <strong>$needle</strong> が最初に現れる位置を数字で返します。 <strong>$needle</strong> が見付から
             なかった場合、<info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>mb_internal_encoding()</strong>
   * <strong>strpos()</strong>


id: mb_strrchr
type: function
doc:
<comment>Description:</comment>
  別の文字列の中で、ある文字が最後に現れる場所を見つける
  
  <strong>mb_strrchr()</strong> は、 <strong>$haystack</strong> の中で最後に <strong>$needle</strong> が現れる場所を探し、 <strong>$haystack</strong> の部分文字列を返し
  ます。 <strong>$needle</strong> が見つからなかった場合は <info>false</info> を返します。

<comment>Param:</comment>
  <info>string</info>       <strong>$haystack</strong>       <strong>$needle</strong> が最後に現れる位置を探す文字列。
  <info>string</info>       <strong>$needle</strong>         <strong>$haystack</strong> の中で探す文字列。
  <info>bool</info>         <strong>$before_needle</strong>  この関数が <strong>$haystack</strong> のどの部分を返すのかを指定します。 <info>true</info> の場合
                               は、<strong>$haystack</strong> の先頭から <strong>$needle</strong> が最後に現れる位置までを返します。
                               <info>false</info> の場合は、<strong>$needle</strong> が最後に現れる位置から <strong>$haystack</strong> の最後までを
                               返します。
  <info>string|null</info>  <strong>$encoding</strong>       使用する文字エンコーディングの名前。 省略した場合は内部文字エンコー
                               ディングを使用します。

<comment>Return:</comment>
  <info>string|false</info>  <strong>$haystack</strong> の部分文字列を返します。 <strong>$needle</strong> が見つからない場合は <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>strrchr()</strong>
   * <strong>mb_strstr()</strong>
   * <strong>mb_strrichr()</strong>


id: mb_strrichr
type: function
doc:
<comment>Description:</comment>
  大文字小文字を区別せず、
     別の文字列の中である文字が最後に現れる場所を探す
    
  
  <strong>mb_strrichr()</strong> は、 <strong>$haystack</strong> の中で最後に <strong>$needle</strong> が現れる場所を探し、 <strong>$haystack</strong> の部分文字列を返
  します。 <strong>mb_strrchr()</strong> とは異なり、 <strong>mb_strrichr()</strong> は大文字小文字を区別しません。 <strong>$needle</strong> が見つから
  なかった場合は <info>false</info> を返します。

<comment>Param:</comment>
  <info>string</info>       <strong>$haystack</strong>       <strong>$needle</strong> が最後に現れる位置を探す文字列。
  <info>string</info>       <strong>$needle</strong>         <strong>$haystack</strong> の中で探す文字列。
  <info>bool</info>         <strong>$before_needle</strong>  この関数が <strong>$haystack</strong> のどの部分を返すのかを指定します。 <info>true</info> の場合
                               は、<strong>$haystack</strong> の先頭から <strong>$needle</strong> が最後に現れる位置までを返します。
                               <info>false</info> の場合は、<strong>$needle</strong> が最後に現れる位置から <strong>$haystack</strong> の最後までを
                               返します。
  <info>string|null</info>  <strong>$encoding</strong>       使用する文字エンコーディングの名前。 省略した場合は内部文字エンコー
                               ディングを使用します。

<comment>Return:</comment>
  <info>string|false</info>  <strong>$haystack</strong> の部分文字列を返します。 <strong>$needle</strong> が見つからない場合は <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>mb_stristr()</strong>
   * <strong>mb_strrchr()</strong>


id: mb_strripos
type: function
doc:
<comment>Description:</comment>
  大文字小文字を区別せず、
     文字列の中で指定した文字列が最後に現れる位置を探す
    
  
  <strong>mb_strripos()</strong> は、マルチバイト対応の <strong>strripos()</strong> 操作を、文字数に基づいて行います。 <strong>$needle</strong> の位置
  を <strong>$haystack</strong> の先頭から順に数えていきます。 最初の文字の位置は 0、二番目の文字の位置は 1 という具
  合です。 <strong>mb_strrpos()</strong> とは異なり、 <strong>mb_strripos()</strong> は大文字小文字を区別しません。

<comment>Param:</comment>
  <info>string</info>       <strong>$haystack</strong>  <strong>$needle</strong> が最後に現れる位置を見つける文字列。
  <info>string</info>       <strong>$needle</strong>    <strong>$haystack</strong> の中で探す文字列。
  <info>int</info>          <strong>$offset</strong>    <strong>$haystack</strong> の中で、検索を開始する位置。
  <info>string|null</info>  <strong>$encoding</strong>  使用する文字エンコーディング名。 省略した場合は内部文字エンコーディングが
                          用いられます。

<comment>Return:</comment>
  <info>int|false</info>  <strong>$needle</strong> が <strong>$haystack</strong> の中で最後に現れる位置を返します。<strong>$needle</strong> が見つからない場合は
             <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>strripos()</strong>
   * <strong>strrpos()</strong>
   * <strong>mb_strrpos()</strong>


id: mb_strrpos
type: function
doc:
<comment>Description:</comment>
  文字列の中に指定した文字列が最後に現れる位置を見つける
  
  <strong>mb_strrpos()</strong> は、マルチバイト対応の <strong>strrpos()</strong> 操作を、文字数に基づいて行います。 <strong>$needle</strong> の位置を
  <strong>$haystack</strong> の先頭から順に数えていきます。 最初の文字の位置は 0、二番目の文字の位置は 1 という具合で
  す。

<comment>Param:</comment>
  <info>string</info>       <strong>$haystack</strong>  <strong>$needle</strong> が最後に登場する場所を調べたい文字列。
  <info>string</info>       <strong>$needle</strong>    <strong>$haystack</strong> の中で見つけたい文字列。
  <info>int</info>          <strong>$offset</strong>    指定すると、文字列中の任意の文字位置から検索を開始することができます。 負
                          の値を指定すると、文字の終端より前の任意の位置で検索を終了します。
  <info>string|null</info>  <strong>$encoding</strong>  <strong>$encoding</strong> 
                          パラメータには文字エンコーディングを指定します。省略した場合、もしくは
                          <info>null</info> の場合は、
                          内部文字エンコーディングを使用します。

<comment>Return:</comment>
  <info>int|false</info>  文字列 <strong>$haystack</strong> の中で <strong>$needle</strong> が最後に現れる位置を数字で返します。 <strong>$needle</strong> が見付から
             なかった場合、<info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>mb_strpos()</strong>
   * <strong>mb_internal_encoding()</strong>
   * <strong>strrpos()</strong>


id: mb_strstr
type: function
doc:
<comment>Description:</comment>
  文字列の中で、指定した文字列が最初に現れる位置を見つける
  
  <strong>mb_strstr()</strong> は、 <strong>$haystack</strong> の中で最初に <strong>$needle</strong> が現れる場所を探し、 <strong>$haystack</strong> の部分文字列を返し
  ます。 <strong>$needle</strong> が見つからなかった場合は <info>false</info> を返します。

<comment>Param:</comment>
  <info>string</info>       <strong>$haystack</strong>       <strong>$needle</strong> が最初に現れる位置を見つける文字列。
  <info>string</info>       <strong>$needle</strong>         <strong>$haystack</strong> の中で探す文字列。
  <info>bool</info>         <strong>$before_needle</strong>  この関数が <strong>$haystack</strong> のどの部分を返すのかを指定します。 <info>true</info> の場合
                               は、<strong>$haystack</strong> の先頭から <strong>$needle</strong> が最初に現れる位置までを返します
                               (needle を含めません)。 <info>false</info> の場合は、<strong>$needle</strong> が最初に現れる位置か
                               ら <strong>$haystack</strong> の最後までを返します (needle を含めます)。
  <info>string|null</info>  <strong>$encoding</strong>       使用する文字エンコーディング名。 省略した場合は内部文字エンコーディン
                               グが用いられます。

<comment>Return:</comment>
  <info>string|false</info>  <strong>$haystack</strong> の部分文字列を返します。 <strong>$needle</strong> が見つからない場合は <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>stristr()</strong>
   * <strong>strstr()</strong>
   * <strong>mb_stristr()</strong>


id: mb_strtolower
type: function
doc:
<comment>Description:</comment>
  文字列を小文字にする
  
  <strong>$string</strong> のすべてのアルファベットを小文字にして返します。

<comment>Param:</comment>
  <info>string</info>       <strong>$string</strong>    小文字にしたい文字列。
  <info>string|null</info>  <strong>$encoding</strong>  <strong>$encoding</strong> 
                          パラメータには文字エンコーディングを指定します。省略した場合、もしくは
                          <info>null</info> の場合は、
                          内部文字エンコーディングを使用します。

<comment>Return:</comment>
  <info>string</info>  <strong>$string</strong> のすべてのアルファベットを小文字にしたものを返します。

<comment>See Also:</comment>
   * <strong>mb_strtoupper()</strong>
   * <strong>mb_convert_case()</strong>
   * <strong>strtolower()</strong>


id: mb_strtoupper
type: function
doc:
<comment>Description:</comment>
  文字列を大文字にする
  
  <strong>$string</strong> のすべてのアルファベットを大文字にして返します。

<comment>Param:</comment>
  <info>string</info>       <strong>$string</strong>    大文字に変換したい文字列。
  <info>string|null</info>  <strong>$encoding</strong>  <strong>$encoding</strong> 
                          パラメータには文字エンコーディングを指定します。省略した場合、もしくは
                          <info>null</info> の場合は、
                          内部文字エンコーディングを使用します。

<comment>Return:</comment>
  <info>string</info>  <strong>$string</strong> のすべてのアルファベットを大文字にしたものを返します。

<comment>See Also:</comment>
   * <strong>mb_strtolower()</strong>
   * <strong>mb_convert_case()</strong>
   * <strong>strtoupper()</strong>


id: mb_strwidth
type: function
doc:
<comment>Description:</comment>
  文字列の幅を返す
  
  文字列 <strong>$string</strong> の幅を返します。 半角文字は <return>1</return> として、 全角文字は <return>2</return> として数えます。 東アジアの文字
  の長さに関する詳細は http://www.unicode.org/reports/tr11/ を参照ください。
  
  全角文字は次のとおりです。 <return>U+1100</return>-<return>U+115F</return>、 <return>U+11A3</return>-<return>U+11A7</return>、 <return>U+11FA</return>-<return>U+11FF</return>、 <return>U+2329</return>-<return>U+232A</return>、
  <return>U+2E80</return>-<return>U+2E99</return>、 <return>U+2E9B</return>-<return>U+2EF3</return>、 <return>U+2F00</return>-<return>U+2FD5</return>、 <return>U+2FF0</return>-<return>U+2FFB</return>、 <return>U+3000</return>-<return>U+303E</return>、 <return>U+3041</return>-<return>U+3096</return>、
  <return>U+3099</return>-<return>U+30FF</return>、 <return>U+3105</return>-<return>U+312D</return>、 <return>U+3131</return>-<return>U+318E</return>、 <return>U+3190</return>-<return>U+31BA</return>、 <return>U+31C0</return>-<return>U+31E3</return>、 <return>U+31F0</return>-<return>U+321E</return>、
  <return>U+3220</return>-<return>U+3247</return>、 <return>U+3250</return>-<return>U+32FE</return>、 <return>U+3300</return>-<return>U+4DBF</return>、 <return>U+4E00</return>-<return>U+A48C</return>、 <return>U+A490</return>-<return>U+A4C6</return>、 <return>U+A960</return>-<return>U+A97C</return>、
  <return>U+AC00</return>-<return>U+D7A3</return>、 <return>U+D7B0</return>-<return>U+D7C6</return>、 <return>U+D7CB</return>-<return>U+D7FB</return>、 <return>U+F900</return>-<return>U+FAFF</return>、 <return>U+FE10</return>-<return>U+FE19</return>、 <return>U+FE30</return>-<return>U+FE52</return>、
  <return>U+FE54</return>-<return>U+FE66</return>、 <return>U+FE68</return>-<return>U+FE6B</return>、 <return>U+FF01</return>-<return>U+FF60</return>、 <return>U+FFE0</return>-<return>U+FFE6</return>、 <return>U+1B000</return>-<return>U+1B001</return>、
  <return>U+1F200</return>-<return>U+1F202</return>、 <return>U+1F210</return>-<return>U+1F23A</return>、 <return>U+1F240</return>-<return>U+1F248</return>、 <return>U+1F250</return>-<return>U+1F251</return>、 <return>U+20000</return>-<return>U+2FFFD</return>、
  <return>U+30000</return>-<return>U+3FFFD</return>。 他のすべての文字は半角の文字です。

<comment>Param:</comment>
  <info>string</info>       <strong>$string</strong>    幅を取得したい文字列。
  <info>string|null</info>  <strong>$encoding</strong>  <strong>$encoding</strong> 
                          パラメータには文字エンコーディングを指定します。省略した場合、もしくは
                          <info>null</info> の場合は、
                          内部文字エンコーディングを使用します。

<comment>Return:</comment>
  <info>int</info>  文字列 <strong>$string</strong> の幅を返します。

<comment>See Also:</comment>
   * <strong>mb_strimwidth()</strong>
   * <strong>mb_internal_encoding()</strong>


id: mb_substitute_character
type: function
doc:
<comment>Description:</comment>
  置換文字を設定あるいは取得する
  
  入力文字エンコーディングが無効、 または出力文字エンコーディングに文字コードが存在しない場合の代替
  文字を指定します。 無効な文字は、<return>"none"</return> (出力しない)、文字列または整数値 (Unicode 文字コード値) に
  置換することが可能です。
  
  この設定は、<strong>mb_convert_encoding()</strong>、 <strong>mb_convert_variables()</strong>、 <strong>mb_output_handler()</strong>、 および
  <strong>mb_send_mail()</strong> に影響します。

<comment>Param:</comment>
  <info>string|int|null</info>  <strong>$substitute_character</strong>  Unicode 値の整数または文字列を以下のように指定します。
                                          <return>"none"</return>: 出力しない <return>"long"</return>: 文字コードの値を出力する (例:
                                          <return>U+3000</return>、<return>JIS+7E7E</return>) <return>"entity"</return>: 文字エンティティを出力する
                                          (例: <return>&#x200;</return>)
                                          
                                          <return>"none"</return>: 出力しない
                                          
                                          <return>"long"</return>: 文字コードの値を出力する (例: <return>U+3000</return>、<return>JIS+7E7E</return>)
                                          
                                          <return>"entity"</return>: 文字エンティティを出力する (例: <return>&#x200;</return>)

<comment>Return:</comment>
  <info>string|int|bool</info>  <strong>$substitute_character</strong> が設定された場合、成功時に <info>true</info>、そうでない場合に <info>false</info> を
                   返します。 <strong>$substitute_character</strong> が設定されない場合は、現在の設定を返します。


id: mb_substr
type: function
doc:
<comment>Description:</comment>
  文字列の一部を得る
  
  文字数に基づきマルチバイト対応の <strong>substr()</strong> 処理を行います。位置は、 <strong>$string</strong> の始めから数えられま
  す。 最初の文字の位置は 0、2 番目の文字の位置は 1、といったようになります。

<comment>Param:</comment>
  <info>string</info>       <strong>$string</strong>    部分文字列を取り出したい文字列。
  <info>int</info>          <strong>$start</strong>     <strong>$start</strong> が非負である場合に返される文字列は、 <strong>$string</strong> の <strong>$start</strong> バイト目以降
                          の文字列となります (ゼロから数えます)。 たとえば、文字列 '<return>abcdef</return>' の <return>0</return> バ
                          イト目は '<return>a</return>' で、 <return>2</return> バイト目は '<return>c</return>' のようになります。
                          
                          <strong>$start</strong> が負の数の場合に返される文字列は、 <strong>$string</strong> の後ろから数えて <strong>$start</strong>
                          バイト目以降となります。
  <info>int|null</info>     <strong>$length</strong>    <strong>$string</strong> の中から取り出す最大文字数。 省略したり <return>NULL</return> を渡したりした場合
                          は、 文字列の最後までの全バイトを取り出します。
  <info>string|null</info>  <strong>$encoding</strong>  <strong>$encoding</strong> 
                          パラメータには文字エンコーディングを指定します。省略した場合、もしくは
                          <info>null</info> の場合は、
                          内部文字エンコーディングを使用します。

<comment>Return:</comment>
  <info>string</info>  <strong>mb_substr()</strong> は、<strong>$start</strong> および <strong>$length</strong> パラメータで指定した <strong>$string</strong> の一部を返します。

<comment>See Also:</comment>
   * <strong>mb_strcut()</strong>
   * <strong>mb_internal_encoding()</strong>


id: mb_substr_count
type: function
doc:
<comment>Description:</comment>
  部分文字列の出現回数を数える
  
  文字列 <strong>$haystack</strong> の中での部分文字列 <strong>$needle</strong> の出現回数を数えます。

<comment>Param:</comment>
  <info>string</info>       <strong>$haystack</strong>  調べたい文字列。
  <info>string</info>       <strong>$needle</strong>    見つける文字列。
  <info>string|null</info>  <strong>$encoding</strong>  <strong>$encoding</strong> 
                          パラメータには文字エンコーディングを指定します。省略した場合、もしくは
                          <info>null</info> の場合は、
                          内部文字エンコーディングを使用します。

<comment>Return:</comment>
  <info>int</info>  文字列 <strong>$haystack</strong> の中での部分文字列 <strong>$needle</strong> の出現回数を返します。

<comment>See Also:</comment>
   * <strong>mb_strpos()</strong>
   * <strong>mb_substr()</strong>
   * <strong>substr_count()</strong>


id: mcrypt_create_iv
type: function
doc:
<comment>Description:</comment>
  Creates an initialization vector (IV) from a random source
  
  Creates an initialization vector (IV) from a random source.
  
  The IV is only meant to give an alternative seed to the encryption routines. This IV does not need
  to be secret at all, though it can be desirable. You even can send it along with your ciphertext
  without losing security.

<comment>Param:</comment>
  <info>int</info>  <strong>$size</strong>    The size of the IV.
  <info>int</info>  <strong>$source</strong>  The source of the IV. The source can be <info>MCRYPT_RAND</info> (system random number
                generator), <info>MCRYPT_DEV_RANDOM</info> (read data from /dev/random) and <info>MCRYPT_DEV_URANDOM</info>
                (read data from /dev/urandom). Prior to 5.3.0, <info>MCRYPT_RAND</info> was the only one
                supported on Windows.
                
                Note that the default value of this parameter was <info>MCRYPT_DEV_RANDOM</info> prior to PHP
                5.6.0.
                
                Note that <info>MCRYPT_DEV_RANDOM</info> may block until more entropy is available.

<comment>Return:</comment>
  <info>string</info>  Returns the initialization vector, or <info>false</info> on error.

<comment>See Also:</comment>
   * http://www.ciphersbyritter.com/GLOSSARY.HTM#IV
   * http://www.quadibloc.com/crypto/co0409.htm
   * Chapter 9.3 of Applied Cryptography by Schneier (ISBN 0-471-11709-9)
   * <strong>random_bytes()</strong>


id: mcrypt_decrypt
type: function
doc:
<comment>Description:</comment>
  Decrypts crypttext with given parameters
  
  Decrypts the <strong>$data</strong> and returns the unencrypted data.

<comment>Param:</comment>
  <info>string</info>  <strong>$cipher</strong>  <info>MCRYPT_暗号名</info> 定数のいずれか、
                   あるいはアルゴリズム名をあらわす文字列。
  <info>string</info>  <strong>$key</strong>     The key with which the data was encrypted. If the provided key size is not
                   supported by the cipher, the function will emit a warning and return <info>false</info>
  <info>string</info>  <strong>$data</strong>    The data that will be decrypted with the given <strong>$cipher</strong> and <strong>$mode</strong>. If the size of
                   the data is not n * blocksize, the data will be padded with '<return>\0</return>'.
  <info>string</info>  <strong>$mode</strong>    定数 <info>MCRYPT_MODE_モード名</info>、あるいは文字列
                   "ecb", "cbc", "cfb", "ofb", "nofb" ,"stream" のいずれか。
  <info>string</info>  <strong>$iv</strong>      CBC, CFB, OFB モードおよび
                   STREAM モードのいくつかのアルゴリズムの初期化の際に使用されます。
                   指定した IV のサイズがそのモードでサポートされていない場合、
                   あるいは IV を必要とするモードで IV が指定されなかった場合は、
                   この関数は警告を発して <info>false</info> を返します。

<comment>Return:</comment>
  <info>string|false</info>  Returns the decrypted data as a string 失敗した場合に <info>false</info> を返します.

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


id: mcrypt_enc_get_algorithms_name
type: function
doc:
<comment>Description:</comment>
  Returns the name of the opened algorithm
  
  This function returns the name of the algorithm.

<comment>Param:</comment>
  <info>resource</info>  <strong>$td</strong>  The encryption descriptor.

<comment>Return:</comment>
  <info>string</info>  Returns the name of the opened algorithm as a string.


id: mcrypt_enc_get_block_size
type: function
doc:
<comment>Description:</comment>
  Returns the blocksize of the opened algorithm
  
  Gets the blocksize of the opened algorithm.

<comment>Param:</comment>
  <info>resource</info>  <strong>$td</strong>  The encryption descriptor.

<comment>Return:</comment>
  <info>int</info>  Returns the block size of the specified algorithm in bytes.


id: mcrypt_enc_get_iv_size
type: function
doc:
<comment>Description:</comment>
  オープンされたアルゴリズムの IV の大きさを返す
  
  この関数は、暗号化記述子で指定したアルゴリズムの iv の大きさを バイト単位で返します。IV は、cbc、
  cfb、ofbモード およびストリームモードのいくつかのアルゴリズムで使用されます。

<comment>Param:</comment>
  <info>resource</info>  <strong>$td</strong>  暗号化記述子。

<comment>Return:</comment>
  <info>int</info>  この関数は、暗号化記述子で指定したアルゴリズムの iv の大きさを バイト単位で返します。 この関
       数が '0' を返す場合、IV は そのアルゴリズムでは無視されます。


id: mcrypt_enc_get_key_size
type: function
doc:
<comment>Description:</comment>
  オープンされたモードでサポートされる最大キー長を返す
  
  そのアルゴリズムでサポートされる最大キー長をバイト単位で返します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$td</strong>  暗号化記述子。

<comment>Return:</comment>
  <info>int</info>  そのアルゴリズムでサポートされる最大キー長をバイト単位で返します。


id: mcrypt_enc_get_modes_name
type: function
doc:
<comment>Description:</comment>
  オープンされたモードの名前を返す
  
  この関数はモード名を返します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$td</strong>  暗号化記述子。

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


id: mcrypt_enc_get_supported_key_sizes
type: function
doc:
<comment>Description:</comment>
  オープンされたアルゴリズムでサポートされるキー長を配列にして返す
  
  オープンしたアルゴリズムでサポートするキーの長さを取得します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$td</strong>  暗号化記述子。

<comment>Return:</comment>
  <info>array</info>  暗号化記述子で指定したアルゴリズムでサポートされるキー長を配列と して返します。返された配列
         が空の場合、1 と <strong>mcrypt_enc_get_key_size()</strong> の値の間のすべての キー長がアルゴリズムでサポー
         トされます。


id: mcrypt_enc_is_block_algorithm
type: function
doc:
<comment>Description:</comment>
  オープンされたモードの暗号がブロックアルゴリズムであるかどうかを調べる
  
  オープンされたモードの暗号がブロックアルゴリズムであるかどうかを調べます。

<comment>Param:</comment>
  <info>resource</info>  <strong>$td</strong>  暗号化記述子。

<comment>Return:</comment>
  <info>bool</info>  アルゴリズムがブロックアルゴリズムである場合に <info>true</info>、 ストリームアルゴリズムである場合に
        <info>false</info> を返します。


id: mcrypt_enc_is_block_algorithm_mode
type: function
doc:
<comment>Description:</comment>
  オープンされたモードの暗号がブロックモードで動作するかどうかを調べる
  
  オープンされているモードがブロックモードで動作するかどうかを調べます (たとえばストリームでは
  <info>false</info>、cbc や cfb、ofb では <info>true</info>)。

<comment>Param:</comment>
  <info>resource</info>  <strong>$td</strong>  暗号化記述子。

<comment>Return:</comment>
  <info>bool</info>  モードがブロックアルゴリズムを使用している場合に <info>true</info>、 その他の場合に <info>false</info> を返します。


id: mcrypt_enc_is_block_mode
type: function
doc:
<comment>Description:</comment>
  オープンされたモードがブロック出力を行うかどうかを調べる
  
  オープンされたモードがブロック出力を行うかどうかを調べます (例: cbc と ecb の場合に <info>true</info>、cfb と
  stream の場合に <info>false</info>)。

<comment>Param:</comment>
  <info>resource</info>  <strong>$td</strong>  暗号化記述子。

<comment>Return:</comment>
  <info>bool</info>  バイトブロックを出力するモードの場合に <info>true</info>、 バイト出力を行うモードの場合に <info>false</info> を返しま
        す。


id: mcrypt_enc_self_test
type: function
doc:
<comment>Description:</comment>
  オープンしたモジュールのセルフテストを実行する
  
  この関数は、記述子 <strong>$td</strong> で指定したアルゴリズムの セルフテストを実行します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$td</strong>  暗号化記述子。

<comment>Return:</comment>
  <info>int</info>  成功したときは <return>0</return> を返し、 失敗したときは負の <info>int</info> を返します。


id: mcrypt_encrypt
type: function
doc:
<comment>Description:</comment>
  指定したパラメータでプレーンテキストを暗号化する
  
  データを暗号化して、それを返します。

<comment>Param:</comment>
  <info>string</info>  <strong>$cipher</strong>  <info>MCRYPT_暗号名</info> 定数のいずれか、
                   あるいはアルゴリズム名をあらわす文字列。
  <info>string</info>  <strong>$key</strong>     データを暗号化する際のキー。 指定した暗号化方式に対応していないサイズのキーを渡さ
                   れた場合は、 警告を発して <info>false</info> を返します。
  <info>string</info>  <strong>$data</strong>    指定した <strong>$cipher</strong> および <strong>$mode</strong> で暗号化するデータ。 データの大きさが n * blocksize
                   でない場合、データは、 '<return>\0</return>'で埋められます。
                   
                   返される暗号化されたテキストは、<strong>$data</strong> で指定したデータの大きさよりも大きくなる可
                   能性があります。
  <info>string</info>  <strong>$mode</strong>    定数 <info>MCRYPT_MODE_モード名</info>、あるいは文字列
                   "ecb", "cbc", "cfb", "ofb", "nofb" ,"stream" のいずれか。
  <info>string</info>  <strong>$iv</strong>      CBC, CFB, OFB モードおよび
                   STREAM モードのいくつかのアルゴリズムの初期化の際に使用されます。
                   指定した IV のサイズがそのモードでサポートされていない場合、
                   あるいは IV を必要とするモードで IV が指定されなかった場合は、
                   この関数は警告を発して <info>false</info> を返します。

<comment>Return:</comment>
  <info>string|false</info>  暗号化されたデータを文字列で返します。失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>mcrypt_decrypt()</strong>
   * <strong>mcrypt_module_open()</strong>


id: mcrypt_generic
type: function
doc:
<comment>Description:</comment>
  データを暗号化する
  
  この関数は、データを暗号化します。データ長を n * blocksize とする ために、データは "<return>\0</return>" で埋められ
  ます。 この関数は、暗号化されたデータを返します。 データのパディングが行われるため、返される文字列
  の長さは 入力よりも長いことがあることに注意してください。
  
  暗号化したデータをデータベースに格納する場合は、mcrypt_generic が返す文字列全てを格納することを忘
  れないでください。さもないと、 文字列を適切に復号できなくなります。もとの文字列が 10 文字で ブロッ
  クサイズが 8 (ブロックサイズを調べるには <strong>mcrypt_enc_get_block_size()</strong> を使用します) だった場合、
  データベースのフィールドには少なくとも 16 文字が 必要です。<strong>mdecrypt_generic()</strong> が返す文字列も 16 文
  字となることに注意しましょう。埋められた文字を取り除くには... rtrim($str, "\0") を使用します。
  
  もし MySQL データベースにデータを格納する場合は、 varchar フィールドに値を挿入する際に末尾のスペー
  スが取り除かれることを 覚えておきましょう。暗号化されたデータの最後にスペース(ASCII 32)が 含まれて
  いた場合、この処理によってデータが破壊されてしまいます。 かわりに tinyblob/tinytext (あるいはより
  大きな) フィールドを 使用してください。

<comment>Param:</comment>
  <info>resource</info>  <strong>$td</strong>    暗号化記述子。
                   
                   この関数をコールする前には、常にキーと IV を用いて <strong>mcrypt_generic_init()</strong> で暗号化
                   ハンドルを 初期化しておくべきです。暗号化が終了したら、 <strong>mcrypt_generic_deinit()</strong>
                   をコールして 暗号化バッファを開放すべきです。使用例は <strong>mcrypt_module_open()</strong> を参照
                   ください。
  <info>string</info>    <strong>$data</strong>  暗号化するデータ。

<comment>Return:</comment>
  <info>string</info>  暗号化したデータを返します。

<comment>See Also:</comment>
   * <strong>mdecrypt_generic()</strong>
   * <strong>mcrypt_generic_init()</strong>
   * <strong>mcrypt_generic_deinit()</strong>


id: mcrypt_generic_deinit
type: function
doc:
<comment>Description:</comment>
  暗号化モジュールを終了する
  
  この関数は、暗号化記述子(<strong>$td</strong>)で指定した 暗号化を終了します。すべてのバッファを消去しますが、モ
  ジュールは 閉じません。<strong>mcrypt_module_close()</strong> をコールする 必要があります(しかし、スクリプトの終了
  時に PHP が自動でこれを 行います)。

<comment>Param:</comment>
  <info>resource</info>  <strong>$td</strong>  暗号化記述子。

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

<comment>See Also:</comment>
   * <strong>mcrypt_module_open()</strong>
   * <strong>mcrypt_generic_init()</strong>


id: mcrypt_generic_init
type: function
doc:
<comment>Description:</comment>
  暗号化に必要な全てのバッファを初期化する
  
  <strong>mcrypt_generic()</strong> または <strong>mdecrypt_generic()</strong> をコールする前に、 常にこの関数をコールする必要がありま
  す。

<comment>Param:</comment>
  <info>resource</info>  <strong>$td</strong>   暗号化記述子。
  <info>string</info>    <strong>$key</strong>  キーの最大長は、<strong>mcrypt_enc_get_key_size()</strong> を コールした際に得られるキー長であり、
                  この値より小さな値は全て有効です。
  <info>string</info>    <strong>$iv</strong>   IV は通常そのアルゴリズムのブロック長と同じ大きさですが、 <strong>mcrypt_enc_get_iv_size()</strong>
                  をコールする ことにより、その大きさを得る必要があります。IV は ECB では 無視されま
                  す。IV は CFB、CBC、STREAM、nOFB では必須です。 IV はランダムで一意である必要があ
                  ります(しかし、秘密ではある必要は ありません)。暗号化と復号で同じ IV を使用する必
                  要があります。 IV を使用したくない場合にはゼロに設定しますが、これは推奨されませ
                  ん。

<comment>Return:</comment>
  <info>int</info>  この関数は、エラー時に負の値を返します。キー長が不正な場合に -3、メモリの確保に問題があった場
       合に -4、そしてそれ以外の戻り値は その他のエラーとなります。エラーが警告を発生させた場合、そ
       れが 表示されます。間違ったパラメータが渡された場合には <info>false</info> が返されます。

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


id: mcrypt_get_block_size
type: function
doc:
<comment>Description:</comment>
  指定した暗号のブロックサイズを得る
  
  最初のプロトタイプは libmcrypt 2.2.x とリンクした場合であり、2 番目 のものは libmcrypt 2.4.x ある
  いは 2.5.x とリンクした場合です。
  
  <strong>mcrypt_get_block_size()</strong>は、指定した <strong>$cipher</strong> のブロック長を返します (暗号化モードと組み合わせま
  す)。
  
  <strong>mcrypt_enc_get_block_size()</strong> 関数のほうがより有用です。というのもこちらの関数は
  <strong>mcrypt_module_open()</strong> が返すリソースを使用するからです。

<comment>Param:</comment>
  <info>int</info>     <strong>$cipher</strong>  <info>MCRYPT_暗号名</info> 定数のいずれか、
                   あるいはアルゴリズム名をあらわす文字列。
  <info>string</info>  <strong>$mode</strong>    定数 <info>MCRYPT_MODE_モード名</info>、あるいは文字列
                   "ecb", "cbc", "cfb", "ofb", "nofb" ,"stream" のいずれか。

<comment>Return:</comment>
  <info>int|false</info>  アルゴリズムのブロックサイズをバイト数で返します。失敗した場合に <info>false</info> を返します.

<comment>See Also:</comment>
   * <strong>mcrypt_get_key_size()</strong>
   * <strong>mcrypt_enc_get_block_size()</strong>
   * <strong>mcrypt_encrypt()</strong>


id: mcrypt_get_cipher_name
type: function
doc:
<comment>Description:</comment>
  指定した暗号の名前を得る
  
  <strong>mcrypt_get_cipher_name()</strong> は、指定した暗号(cipher) の名前を得るために使用されます。
  
  <strong>mcrypt_get_cipher_name()</strong> は、暗号の番号 (libmcrypt 2.2.x)または暗号名(libmcrypt 2.4.x 以降)を引数
  とし、 暗号名を返します。指定した暗号が存在しない場合は <info>false</info> を返します。

<comment>Param:</comment>
  <info>int</info>  <strong>$cipher</strong>  <info>MCRYPT_暗号名</info> 定数のいずれか、
                あるいはアルゴリズム名をあらわす文字列。

<comment>Return:</comment>
  <info>string</info>  暗号の名前、あるいは暗号が存在しない場合に <info>false</info> を返します。


id: mcrypt_get_iv_size
type: function
doc:
<comment>Description:</comment>
  指定した暗号/モードの組み合わせに属する IV の大きさを返す
  
  指定した <strong>$cipher</strong>/<strong>$mode</strong> の組み合わせにおける IV の大きさを取得します。
  
  <strong>mcrypt_enc_get_iv_size()</strong> 関数を使用するほうが より有用です。これは <strong>mcrypt_module_open()</strong> が返すリ
  ソースを使用します。

<comment>Param:</comment>
  <info>string</info>  <strong>$cipher</strong>  <info>MCRYPT_暗号名</info> 定数のいずれか、
                   あるいはアルゴリズム名をあらわす文字列。
  <info>string</info>  <strong>$mode</strong>    定数 <info>MCRYPT_MODE_モード名</info>、あるいは文字列
                   "ecb", "cbc", "cfb", "ofb", "nofb" ,"stream" のいずれか。
                   
                   ECB モードでは IV は要求されないため、IV は無視されます。 暗号化と復号の際には、
                   同じ IV(開始位置)が必要です。さもないと 暗号化処理は失敗します。

<comment>Return:</comment>
  <info>int</info>  初期化ベクトル(IV)の大きさをバイト数で返します。 エラーの際には <info>false</info> を返します。IV が指定し
       た暗号/モードで無視される場合には、ゼロを返します。

<comment>See Also:</comment>
   * <strong>mcrypt_get_block_size()</strong>
   * <strong>mcrypt_enc_get_iv_size()</strong>
   * <strong>mcrypt_create_iv()</strong>


id: mcrypt_get_key_size
type: function
doc:
<comment>Description:</comment>
  指定した暗号のキーの長さを得る
  
  最初のプロトタイプは libmcrypt 2.2.x とリンクした場合であり、2 番目の ものは libmcrypt 2.4.x ある
  いは 2.5.x とリンクした場合です。
  
  <strong>mcrypt_get_key_size()</strong> は、 <strong>$cipher</strong> で(暗号化モードとあわせて)指定した キーの長さを得るために使用さ
  れます。
  
  <strong>mcrypt_enc_get_key_size()</strong> 関数を使用するほうが より有用です。これは <strong>mcrypt_module_open()</strong> が返すリ
  ソースを使用します。

<comment>Param:</comment>
  <info>int</info>     <strong>$cipher</strong>  <info>MCRYPT_暗号名</info> 定数のいずれか、
                   あるいはアルゴリズム名をあらわす文字列。
  <info>string</info>  <strong>$mode</strong>    定数 <info>MCRYPT_MODE_モード名</info>、あるいは文字列
                   "ecb", "cbc", "cfb", "ofb", "nofb" ,"stream" のいずれか。

<comment>Return:</comment>
  <info>int|false</info>  そのアルゴリズムでサポートする最長のキーサイズをバイト数で返します。 失敗した場合に
             <info>false</info> を返します.

<comment>See Also:</comment>
   * <strong>mcrypt_get_block_size()</strong>
   * <strong>mcrypt_enc_get_key_size()</strong>
   * <strong>mcrypt_encrypt()</strong>


id: mcrypt_list_algorithms
type: function
doc:
<comment>Description:</comment>
  サポートされる全ての暗号を配列として取得する
  
  <strong>$lib_dir</strong> パラメータにあるサポートするすべてのアルゴリズムの一覧を取得します。

<comment>Param:</comment>
  <info>string</info>  <strong>$lib_dir</strong>  すべてのアルゴリズムが存在するディレクトリを指定します。 指定しない場合は、
                    php.ini の <return>mcrypt.algorithms_dir</return> ディレクティブを使用します。

<comment>Return:</comment>
  <info>array</info>  サポートするすべてのアルゴリズムを配列で返します。


id: mcrypt_list_modes
type: function
doc:
<comment>Description:</comment>
  サポートされる全てのモードの配列を取得する
  
  <strong>$lib_dir</strong> にあるすべてのサポートするモードの一覧を取得します。

<comment>Param:</comment>
  <info>string</info>  <strong>$lib_dir</strong>  すべてのモードが存在するディレクトリを指定します。 指定しない場合は、 php.ini
                    ディレクティブ <return>mcrypt.modes_dir</return> を使用します。

<comment>Return:</comment>
  <info>array</info>  サポートするすべてのモードを配列で返します。


id: mcrypt_module_close
type: function
doc:
<comment>Description:</comment>
  mcrypt モジュールを閉じる
  
  指定した暗号化ハンドルを閉じます。

<comment>Param:</comment>
  <info>resource</info>  <strong>$td</strong>  暗号化記述子。

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

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


id: mcrypt_module_get_algo_block_size
type: function
doc:
<comment>Description:</comment>
  指定したアルゴリズムのブロック長を返す
  
  指定したアルゴリズムのブロック長を取得します。

<comment>Param:</comment>
  <info>string</info>  <strong>$algorithm</strong>  アルゴリズム名。
  <info>string</info>  <strong>$lib_dir</strong>    オプションのパラメータで、 システム上でのモードモジュールの位置を指定すること
                      が可能です。

<comment>Return:</comment>
  <info>int</info>  指定したアルゴリズムでサポートされるブロック長をバイト単位で返します。


id: mcrypt_module_get_algo_key_size
type: function
doc:
<comment>Description:</comment>
  オープンされたモードでサポートされる最大キー長を返す
  
  オープンされたモードでサポートされる最大キー長を取得します。

<comment>Param:</comment>
  <info>string</info>  <strong>$algorithm</strong>  アルゴリズム名。
  <info>string</info>  <strong>$lib_dir</strong>    オプションのパラメータで、 システム上でのモードモジュールの位置を指定すること
                      が可能です。

<comment>Return:</comment>
  <info>int</info>  この関数は、指定したアルゴリズムでサポートされる最大キー長をバイト単位で返します。


id: mcrypt_module_get_supported_key_sizes
type: function
doc:
<comment>Description:</comment>
  オープンされたアルゴリズムでサポートされるキーのサイズを配列として返す
  
  指定したアルゴリズムでサポートされるキーのサイズを配列で返します。 この関数が空の配列を返した場
  合、1 から <strong>mcrypt_module_get_algo_key_size()</strong> の戻り値の間のすべてのサイズのキーがアルゴリズムでサ
  ポートされます。

<comment>Param:</comment>
  <info>string</info>  <strong>$algorithm</strong>  使用するアルゴリズム。
  <info>string</info>  <strong>$lib_dir</strong>    オプションのパラメータ <strong>$lib_dir</strong> により、 システムでアルゴリズムモジュールがあ
                      る場所を指定することが可能です。

<comment>Return:</comment>
  <info>array</info>  指定したアルゴリズムでサポートするキーサイズの配列を返します。 空の配列を返した場合は、その
         アルゴリズムでは 1 から <strong>mcrypt_module_get_algo_key_size()</strong> までのすべてのキーサイズをサポー
         トすることになります。

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


id: mcrypt_module_is_block_algorithm
type: function
doc:
<comment>Description:</comment>
  指定したアルゴリズムがブロックアルゴリズムであるかを調べる
  
  この関数は、指定したアルゴリズムがブロックアルゴリズムの場合に <info>true</info>、ストリームアルゴリズムの場合
  に <info>false</info> を返します。

<comment>Param:</comment>
  <info>string</info>  <strong>$algorithm</strong>  調べたいアルゴリズム。
  <info>string</info>  <strong>$lib_dir</strong>    オプションのパラメータ <strong>$lib_dir</strong> により、 システム上での algorithm モジュールの
                      位置を指定することが可能です。

<comment>Return:</comment>
  <info>bool</info>  この関数は、指定したアルゴリズムがブロックアルゴリズムの場合に <info>true</info>、ストリームアルゴリズム
        の場合に <info>false</info> を返します。


id: mcrypt_module_is_block_algorithm_mode
type: function
doc:
<comment>Description:</comment>
  指定したモジュールがブロックアルゴリズムであるかどうかを返す
  
  この関数は、mode がブロックアルゴリズムを使用する場合に <info>true</info>、 その他の場合に <info>false</info> を返します。
  (例: stream の場合に <info>false</info>、 cbc、cfb、ofb の場合に <info>true</info>)

<comment>Param:</comment>
  <info>string</info>  <strong>$mode</strong>     調べたいモード。
  <info>string</info>  <strong>$lib_dir</strong>  オプションのパラメータ <strong>$lib_dir</strong> により、 システム上での mode モジュールの位置を
                    指定することが可能です。

<comment>Return:</comment>
  <info>bool</info>  この関数は、mode がブロックアルゴリズムを使用する場合に <info>true</info>、 その他の場合に <info>false</info> を返しま
        す。(例: stream の場合に <info>false</info>、 cbc、cfb、ofb の場合に <info>true</info>)


id: mcrypt_module_is_block_mode
type: function
doc:
<comment>Description:</comment>
  指定したモードがブロック出力を行うかどうかを返す
  
  この関数は、ブロック出力を行うモードの場合に <info>true</info>、バイトのみを 出力する場合に <info>false</info> を返します
  (例: cbc と ecb の場合に <info>true</info>、 cfb と streamの場合に <info>false</info>)。

<comment>Param:</comment>
  <info>string</info>  <strong>$mode</strong>     定数 <info>MCRYPT_MODE_モード名</info>、あるいは文字列
                    "ecb", "cbc", "cfb", "ofb", "nofb" ,"stream" のいずれか。
  <info>string</info>  <strong>$lib_dir</strong>  オプションのパラメータ <strong>$lib_dir</strong> により、システム上での mode モジュールの 位置を
                    指定することが可能です。

<comment>Return:</comment>
  <info>bool</info>  この関数は、ブロック出力を行うモードの場合に <info>true</info>、バイトのみを 出力する場合に <info>false</info> を返し
        ます(例: cbc と ecb の場合に <info>true</info>、 cfb と streamの場合に <info>false</info>)。


id: mcrypt_module_open
type: function
doc:
<comment>Description:</comment>
  使用するアルゴリズムおよびモードのモジュールをオープンする
  
  この関数は、使用するアルゴリズムおよびモードのモジュールをオープン します。アルゴリズム名は、たと
  えば "<return>twofish</return>" のように名前で指定するか定数 <info>MCRYPT_暗号名</info> のいずれかを使用して指定します。 ライブ
  ラリは <strong>mcrypt_module_close()</strong> をコールする ことによりクローズされます。

<comment>Param:</comment>
  <info>string</info>  <strong>$algorithm</strong>            <info>MCRYPT_暗号名</info> 定数のいずれか、
                                あるいはアルゴリズム名をあらわす文字列。
  <info>string</info>  <strong>$algorithm_directory</strong>  暗号化モジュールの位置を指定する際には <strong>$algorithm_directory</strong> を使いま
                                す。 ディレクトリ名を指定した場合には、これが使用されます。 これらの
                                一つに空の文字列(<return>""</return>)を指定した場合、php.ini ディレクティブ
                                <strong>$mcrypt.algorithms_dir</strong> に設定された値を使います。 これらが設定されて
                                いない場合、libmcrypt をコンパイルした際の デフォルトのディレクトリ
                                (通常は/usr/local/lib/libmcrypt) を使います。
  <info>string</info>  <strong>$mode</strong>                 定数 <info>MCRYPT_MODE_モード名</info>、あるいは文字列
                                "ecb", "cbc", "cfb", "ofb", "nofb" ,"stream" のいずれか。
  <info>string</info>  <strong>$mode_directory</strong>       暗号化モジュールの位置を指定する際には <strong>$mode_directory</strong> を使います。
                                ディレクトリ名を指定した場合には、これが使用されます。 これらの一つ
                                に空の文字列(<return>""</return>)を指定した場合、php.ini ディレクティブ
                                <return>mcrypt.modes_dir</return> に設定された値を使います。 これらが設定されていない
                                場合、libmcrypt をコンパイルした際の デフォルトのディレクトリ (通常
                                は/usr/local/lib/libmcrypt) を使います。

<comment>Return:</comment>
  <info>resource</info>  通常は暗号化記述子を返します。エラー時は <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>mcrypt_module_close()</strong>
   * <strong>mcrypt_generic()</strong>
   * <strong>mdecrypt_generic()</strong>
   * <strong>mcrypt_generic_init()</strong>
   * <strong>mcrypt_generic_deinit()</strong>


id: mcrypt_module_self_test
type: function
doc:
<comment>Description:</comment>
  指定したモジュールのセルフテストを実行する
  
  この関数は、指定したアルゴリズムのセルフテストを実行します。

<comment>Param:</comment>
  <info>string</info>  <strong>$algorithm</strong>  <info>MCRYPT_暗号名</info> 定数のいずれか、
                      あるいはアルゴリズム名をあらわす文字列。
  <info>string</info>  <strong>$lib_dir</strong>    オプションのパラメータ <strong>$lib_dir</strong> により、 システム上での algorithm モジュールの
                      位置を指定することが可能です。

<comment>Return:</comment>
  <info>bool</info>  成功した場合 <return>0</return>、失敗した場合に負の <info>int</info> を返します。


id: md5
type: function
doc:
<comment>Description:</comment>
  文字列のmd5ハッシュ値を計算する
  
  RSA Data Security, Inc. の MD5メッセージダイジェストアルゴリズム を用いて <strong>$string</strong> の MD5 ハッシュ
  値を計算し、 そのハッシュを返します。

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  文字列。
  <info>bool</info>    <strong>$binary</strong>  オプションの<strong>$binary</strong> に <info>true</info> が指定された場合、 md5 ダイジェストが 16 バイト長のバ
                   イナリ形式で返されます。

<comment>Return:</comment>
  <info>string</info>  32 文字の 16 進数からなるハッシュを返します。

<comment>See Also:</comment>
   * <strong>md5_file()</strong>
   * <strong>sha1_file()</strong>
   * <strong>crc32()</strong>
   * <strong>sha1()</strong>
   * <strong>hash()</strong>
   * <strong>crypt()</strong>
   * <strong>password_hash()</strong>


id: md5_file
type: function
doc:
<comment>Description:</comment>
  指定したファイルのMD5ハッシュ値を計算する
  
  RSA Data Security, Inc. MD5 メッセージダイジェストアルゴリズムを用いて <strong>$filename</strong>パラメータで指定し
  たファイルの MD5ハッシュを計算し、そのハッシュを返します。 ハッシュは、32 文字の 16 進数です。

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  ファイル名
  <info>bool</info>    <strong>$binary</strong>    <info>true</info> の場合、長さ 16 の生のバイナリフォーマットで ダイジェストを返します。

<comment>Return:</comment>
  <info>string|false</info>  成功時は文字列、そうでなければ <info>false</info>

<comment>See Also:</comment>
   * <strong>md5()</strong>
   * <strong>sha1_file()</strong>
   * <strong>crc32()</strong>


id: mdecrypt_generic
type: function
doc:
<comment>Description:</comment>
  データを復号する
  
  この関数は、データを復号します。データのパディングが行われるため、 返される文字列の長さは暗号化前
  の文字列よりも長くなる可能性があることに 注意してください。

<comment>Param:</comment>
  <info>resource</info>  <strong>$td</strong>    <strong>mcrypt_module_open()</strong> が返す暗号化記述子。
  <info>string</info>    <strong>$data</strong>  暗号化されたデータ。

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

<comment>See Also:</comment>
   * <strong>mcrypt_generic()</strong>
   * <strong>mcrypt_generic_init()</strong>
   * <strong>mcrypt_generic_deinit()</strong>


id: memcache_debug
type: function
doc:
<comment>Description:</comment>
  デバッグ出力のオン/オフを切り替える
  
  <strong>memcache_debug()</strong> は、パラメータ <strong>$on_off</strong> が <info>true</info> の場合にデバッグ出力を有効にし、 <info>false</info> の場合には
  無効にします。 <strong>memcache_debug()</strong> は、PHP が --enable-debug オプションをつけてビルドされている場合に
  のみ使用可能で、 この場合は常に <info>true</info> を返します。そうでない場合は、この関数は 何も行わずに常に
  <info>false</info> を返します。
  
  <strong>memcache_debug()</strong> は、PHP が --enable-debug オプションをつけてビルドされている場合にのみ使用可能
  で、 この場合は常に <info>true</info> を返します。そうでない場合は、この関数は 何も行わずに常に <info>false</info> を返しま
  す。

<comment>Param:</comment>
  <info>bool</info>  <strong>$on_off</strong>  <info>true</info> にすると、デバッグ出力をオンにします。 <info>false</info> にすると、デバッグ出力をオフにし
                 ます。

<comment>Return:</comment>
  <info>bool</info>  PHP が --enable-debug オプションをつけてビルドされている場合に <info>true</info>、それ以外の場合に <info>false</info>
        を返します。


id: memory_get_peak_usage
type: function
doc:
<comment>Description:</comment>
  PHP によって割り当てられたメモリの最大値を返す
  
  PHP スクリプトに割り当てられたメモリの最大値を、バイト単位で返します。

<comment>Param:</comment>
  <info>bool</info>  <strong>$real_usage</strong>  これを <info>true</info> に設定すると、システムが割り当てた実際のメモリの大きさを取得しま
                     す。 省略したり <info>false</info> を設定したりすると、 <return>emalloc()</return> が使用するメモリのみを報告
                     します。

<comment>Return:</comment>
  <info>int</info>  メモリの最大値をバイト数で返します。

<comment>See Also:</comment>
   * <strong>memory_get_usage()</strong>
   * <strong>memory_reset_peak_usage()</strong>
   * memory_limit


id: memory_get_usage
type: function
doc:
<comment>Description:</comment>
  PHP に割り当てられたメモリの量を返す 
  
  現在の PHP スクリプトに割り当てられたメモリの量をバイト単位で返します。

<comment>Param:</comment>
  <info>bool</info>  <strong>$real_usage</strong>  これを <info>true</info> に設定すると、システムが割り当てた実際のメモリの大きさ (未使用の
                     ページも含むもの) を取得します。 省略したり <info>false</info> を設定したりすると、使用した
                     メモリのみを報告します。

<comment>Return:</comment>
  <info>int</info>  メモリの量をバイト単位で返します。

<comment>See Also:</comment>
   * <strong>memory_get_peak_usage()</strong>
   * memory_limit


id: memory_reset_peak_usage
type: function
doc:
<comment>Description:</comment>
  メモリの最大値をリセットする
  
  <strong>memory_get_peak_usage()</strong> が返したメモリの最大値をリセットします。

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

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


id: metaphone
type: function
doc:
<comment>Description:</comment>
  文字列の metaphone キーを計算する
  
  <strong>$string</strong> の metaphone キーを計算します。
  
  <strong>soundex()</strong> と同様に metaphone は、 発音が似た単語について同じキーを作成します。metaphone は、 英語
  の発音の基本的ルールを知っているので、 <strong>soundex()</strong> よりも正確です。 metaphone が生成するキーは可変長
  です。
  
  metaphone は、Lawrence Philips \<lphilips at verity dot com&gt; により 開発されました。["Practical Algorithms for Programmers", Binstock & Rex, Addison Wesley, 1995] で解説されています。

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>        入力文字列。
  <info>int</info>     <strong>$max_phonemes</strong>  このパラメータは、返される metaphone キーの長さを最大 <strong>$max_phonemes</strong> 文字 ま
                         でに制限します。 しかし、phonemes は完全に書き換えられるので、 結果の文字列
                         の長さは、<strong>$max_phonemes</strong> よりも少し長くなります。 デフォルト値の <return>0</return> は、無制
                         限であることを意味します。

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


id: method_exists
type: function
doc:
<comment>Description:</comment>
  クラスメソッドが存在するかどうかを確認する
  
  指定した <strong>$object_or_class</strong> にクラスメソッドが存在するかどうかを調べます。

<comment>Param:</comment>
  <info>object|string</info>  <strong>$object_or_class</strong>  オブジェクトのインスタンス、あるいはクラス名。
  <info>string</info>         <strong>$method</strong>           メソッドの名前。

<comment>Return:</comment>
  <info>bool</info>  <strong>$method</strong> で指定したメソッドが 指定した <strong>$object_or_class</strong> において定義されている場合に <info>true</info>、そ
        うでない場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>function_exists()</strong>
   * <strong>is_callable()</strong>
   * <strong>class_exists()</strong>


id: mhash
type: function
doc:
<comment>Description:</comment>
  ハッシュ値を計算する
  
  <strong>mhash()</strong> は、 <strong>$hash</strong> で指定したハッシュ関数を <strong>$data</strong> に適用します。

<comment>Param:</comment>
  <info></info>        <strong>$algo</strong>  ハッシュ ID。<info>MHASH_ハッシュ名</info> 定数のいずれかを指定します。
  <info>string</info>  <strong>$data</strong>  ユーザーが入力した文字列。
  <info>string</info>  <strong>$key</strong>   指定した場合は、この関数は結果の HMAC を返します。 HMAC は、メッセージ認証時のキー
                 に基づくハッシュ、 あるいは指定したキーに基づく単なるメッセージダイジェストです。
                 mhash でサポートしている全てのアルゴリズムが HMAC モードで使用できるわけではありま
                 せん。

<comment>Return:</comment>
  <info>string</info>  結果のハッシュ (あるいはダイジェストとも言います) あるいは HMAC を表す文字列を返します。
          エラー時は <info>false</info> を返します。


id: mhash_count
type: function
doc:
<comment>Description:</comment>
  利用可能なハッシュ ID の最大値を得る
  
  利用可能なハッシュ ID の最大値を取得します。

<comment>Return:</comment>
  <info>int</info>  利用可能なハッシュ ID の最大値を返します。 ハッシュは、0 からこのハッシュ ID までの数字となり
       ます。


id: mhash_get_block_size
type: function
doc:
<comment>Description:</comment>
  指定したハッシュのブロックサイズを得る
  
  指定した <strong>$algo</strong> のブロックサイズを取得します。

<comment>Param:</comment>
  <info>int</info>  <strong>$algo</strong>  ハッシュ ID。<info>MHASH_ハッシュ名</info> 定数のいずれかを指定します。

<comment>Return:</comment>
  <info>int|false</info>  サイズをバイト数で返します。<strong>$algo</strong> が存在しない場合は <info>false</info> を返します。


id: mhash_get_hash_name
type: function
doc:
<comment>Description:</comment>
  指定したハッシュの名前を得る
  
  指定した <strong>$algo</strong> の名前を取得します。

<comment>Param:</comment>
  <info>int</info>  <strong>$algo</strong>  ハッシュ ID。<info>MHASH_ハッシュ名</info> 定数のいずれかを指定します。

<comment>Return:</comment>
  <info>string|false</info>  ハッシュの名前を返します。そのハッシュが存在しない場合は、<info>false</info> を返します。


id: mhash_keygen_s2k
type: function
doc:
<comment>Description:</comment>
  キーを生成する
  
  <strong>$algo</strong> にユーザーが指定した <strong>$password</strong> を用いてキーを生成します。
  
  OpenPGP のドキュメント (RFC 2440) で規定されている、Salted S2k アルゴリズムを使用します。
  
  ユーザーが指定したパスワードは、暗号化アルゴリズムのキーとしては 適切ではないということを覚えてお
  きましょう。ユーザーが選択するのは、 通常はキーボードから入力可能なキーだからです。 これらのパス
  ワードは、文字当たり 6 から 7 ビットのみ(もしくはそれ以下) しか使用していません。ユーザーの指定し
  たキーに対して、 (この関数のような) ある種の変換を行うことを強く推奨します。

<comment>Param:</comment>
  <info>int</info>     <strong>$algo</strong>      キーの作成に使用するハッシュ ID。<info>MHASH_ハッシュ名</info> 定数のいずれかを指定します。
  <info>string</info>  <strong>$password</strong>  ユーザーが指定したパスワード。
  <info>string</info>  <strong>$salt</strong>      異なったキーを生成するため、キーを生成するたびに、 十分にランダムな異なる値とな
                     る必要があります。キーを調べる際に <strong>$salt</strong> を知っている必要があるため、キーを
                     salt に付加するというのは 良い発想です。salt は 8 バイト固定長で、これより少な
                     い場合はゼロで 埋められます。
  <info>int</info>     <strong>$length</strong>    キーの長さをバイト数で指定します。

<comment>Return:</comment>
  <info>string|false</info>  生成されたキーを表す文字列、あるいはエラー時に <info>false</info> を返します。


