# php_manual

id: db2_special_columns
type: function
doc:
<comment>Description:</comment>
  テーブルのユニーク行 ID カラムを含む結果セットを返す
    
  
  テーブルのユニーク行 ID カラムを含む結果セットを返します。

<comment>Param:</comment>
  <info>resource</info>     <strong>$connection</strong>  IBM DB2、Cloudscape あるいは Apache Derby データベースへの有効な接続。
  <info>string|null</info>  <strong>$qualifier</strong>   OS/390 あるいは z/OS サーバー上で稼動している DB2 データベースの修飾子。
                            その他のデータベースの場合には <info>null</info> あるいは空の文字列を渡します。
  <info>string</info>       <strong>$schema</strong>      テーブルを含むスキーマ。
  <info>string</info>       <strong>$table_name</strong>  テーブルの名前。
  <info>int</info>          <strong>$scope</strong>       ユニーク行 ID の有効期間の最小値を表す整数値。 以下の値のいずれかとなり
                            ます。 整数値SQL 定数説明0SQL_SCOPE_CURROW行 ID は、カーソルがその行にあ
                            る場合にのみ有効です。1SQL_SCOPE_TRANSACTION行 ID は、そのトランザクショ
                            ンの間のみ有効です。2SQL_SCOPE_SESSION行 ID は、その接続の間のみ有効で
                            す。

<comment>Return:</comment>
  <info>resource</info>  テーブルのユニーク行 ID 情報を含む結果セットの ステートメントリソースを返します。 行の内
            容は、以下のカラムで構成されています。 カラム名説明SCOPE整数値SQL 定数説明
            0SQL_SCOPE_CURROW行 ID は、カーソルがその行にある場合にのみ有効です。
            1SQL_SCOPE_TRANSACTION行 ID は、そのトランザクションの間のみ有効です。
            2SQL_SCOPE_SESSION行 ID は、その接続の間のみ有効です。COLUMN_NAMEユニークカラムの名前。
            DATA_TYPEカラムの SQL データ型。TYPE_NAMEカラムの SQL データ型を文字列で表したもの。
            COLUMN_SIZEカラムのサイズを表す整数値。BUFFER_LENGTH このカラムのデータを保存するために
            必要な最大のバイト数。 DECIMAL_DIGITS カラムの位取り。位取りが適用できない場合は <info>null</info>。
            NUM_PREC_RADIX<return>10</return> (正確な数値データ型を表す)、 <return>2</return> (概数データ型を表す)、 あるいは <info>null</info> (基
            数が適用できないデータ型を表す) のいずれか。 PSEUDO_COLUMN常に 1 を返します。
            
            整数値SQL 定数説明0SQL_SCOPE_CURROW行 ID は、カーソルがその行にある場合にのみ有効です。
            1SQL_SCOPE_TRANSACTION行 ID は、そのトランザクションの間のみ有効です。
            2SQL_SCOPE_SESSION行 ID は、その接続の間のみ有効です。

<comment>See Also:</comment>
   * <strong>db2_column_privileges()</strong>
   * <strong>db2_columns()</strong>
   * <strong>db2_foreign_keys()</strong>
   * <strong>db2_primary_keys()</strong>
   * <strong>db2_procedure_columns()</strong>
   * <strong>db2_procedures()</strong>
   * <strong>db2_statistics()</strong>
   * <strong>db2_table_privileges()</strong>
   * <strong>db2_tables()</strong>


id: db2_statistics
type: function
doc:
<comment>Description:</comment>
  インデックスの情報およびテーブルの統計情報を含む結果セットを返す
    
  
  インデックスの情報およびテーブルの統計情報を含む結果セットを返します。

<comment>Param:</comment>
  <info>resource</info>     <strong>$connection</strong>  IBM DB2、Cloudscape あるいは Apache Derby データベースへの有効な接続。
  <info>string|null</info>  <strong>$qualifier</strong>   OS/390 あるいは z/OS サーバー上で稼動している DB2 データベースの修飾子。
                            その他のデータベースの場合には <info>null</info> あるいは空の文字列を渡します。
  <info>string|null</info>  <strong>$schema</strong>      対象となるテーブルを含むスキーマ。 このパラメータを <info>null</info> にすると、現在
                            のユーザーのスキーマについての 統計およびインデックスが返されます。
  <info>string</info>       <strong>$table_name</strong>  テーブルの名前。
  <info>bool</info>         <strong>$unique</strong>      <strong>$unique</strong> が <info>true</info> の場合、 テーブルのすべてのインデックス情報を返します。
                            そうでない場合、 テーブルのユニークインデックスに関する情報だけを返しま
                            す。

<comment>Return:</comment>
  <info>resource</info>  指定したパラメータに一致するテーブルの統計およびインデックスを含む ステートメントリソー
            スを返します。 行の内容は、以下のカラムで構成されています。 カラム名説明TABLE_CAT テーブ
            ルを含むカタログの名前。テーブルがカタログを保持していない場合は <info>null</info>。 TABLE_SCHEMテー
            ブルを含むスキーマの名前。TABLE_NAMEテーブルの名前。NON_UNIQUE インデックスが一意でなけ
            ればならないかどうか、 あるいはその行がテーブルの統計情報であるかどうかを表す整数値。 戻
            り値パラメータの型0 (SQL_FALSE)インデックスは、重複した値をとることができます。1
            (SQL_TRUE)インデックスは、一意でなければなりません。<info>null</info>この行は、テーブル自身についての
            統計情報です。 INDEX_QUALIFIER インデックスの資格を満たすため、INDEX_NAME の先頭に付加し
            なければならない修飾子を表す文字列。 INDEX_NAMEインデックスの名前を表す文字列。TYPE 結果
            セットのこの行に含まれる情報の型を表す整数値。 戻り値パラメータの型0 (SQL_TABLE_STAT)こ
            の行は、テーブル自身の統計情報を含みます。1 (SQL_INDEX_CLUSTERED)この行は、クラスタ化イ
            ンデックスについての情報を含みます。2 (SQL_INDEX_HASH)この行は、ハッシュインデックスにつ
            いての情報を含みます。3 (SQL_INDEX_OTHER) この行は、クラスタ化もハッシュも行われていない
            インデックスについての情報を含みます。  ORDINAL_POSITION インデックス内の、1 から始まる
            カラムの位置。 その行がテーブル自身についての統計情報を含んでいる場合は <info>null</info>。
            COLUMN_NAME インデックス内のカラムの名前。 その行がテーブル自身についての統計情報を含ん
            でいる場合は <info>null</info>。 ASC_OR_DESC カラムの並び順が昇順の場合は <return>A</return>、 降順の場合は <return>D</return>、 その行
            がテーブル自身についての統計情報を含んでいる場合は <info>null</info>。 CARDINALITY その行がインデック
            スの情報を含んでいる場合、このカラムには インデックス内の一意な値の数を表す整数値が含ま
            れます。  その行がテーブル自身についての情報を含んでいる場合、 このカラムにはテーブルの
            行数を表す整数値が含まれます。 PAGES その行がインデックスの情報を含んでいる場合、このカ
            ラムには インデックスを保存するために使用しているページ数を表す整数値が含まれます。  そ
            の行がテーブル自身についての情報を含んでいる場合、このカラムには テーブルを保存するため
            に使用しているページ数を表す整数値が含まれます。 FILTER_CONDITION常に <info>null</info>。
            
            インデックスが一意でなければならないかどうか、 あるいはその行がテーブルの統計情報である
            かどうかを表す整数値。 戻り値パラメータの型0 (SQL_FALSE)インデックスは、重複した値をとる
            ことができます。1 (SQL_TRUE)インデックスは、一意でなければなりません。<info>null</info>この行は、テー
            ブル自身についての統計情報です。
            
            結果セットのこの行に含まれる情報の型を表す整数値。 戻り値パラメータの型0
            (SQL_TABLE_STAT)この行は、テーブル自身の統計情報を含みます。1 (SQL_INDEX_CLUSTERED)この
            行は、クラスタ化インデックスについての情報を含みます。2 (SQL_INDEX_HASH)この行は、ハッ
            シュインデックスについての情報を含みます。3 (SQL_INDEX_OTHER) この行は、クラスタ化もハッ
            シュも行われていない インデックスについての情報を含みます。
            
            その行がインデックスの情報を含んでいる場合、このカラムには インデックス内の一意な値の数
            を表す整数値が含まれます。
            
            その行がテーブル自身についての情報を含んでいる場合、 このカラムにはテーブルの行数を表す
            整数値が含まれます。
            
            その行がインデックスの情報を含んでいる場合、このカラムには インデックスを保存するために
            使用しているページ数を表す整数値が含まれます。
            
            その行がテーブル自身についての情報を含んでいる場合、このカラムには テーブルを保存するた
            めに使用しているページ数を表す整数値が含まれます。

<comment>See Also:</comment>
   * <strong>db2_column_privileges()</strong>
   * <strong>db2_columns()</strong>
   * <strong>db2_foreign_keys()</strong>
   * <strong>db2_primary_keys()</strong>
   * <strong>db2_procedure_columns()</strong>
   * <strong>db2_procedures()</strong>
   * <strong>db2_special_columns()</strong>
   * <strong>db2_table_privileges()</strong>
   * <strong>db2_tables()</strong>


id: db2_stmt_error
type: function
doc:
<comment>Description:</comment>
  SQL 文が返す SQLSTATE を含む文字列を返す
    
  
  SQL 文が返す SQLSTATE を含む文字列を返します。
  
  <strong>db2_stmt_error()</strong> の引数にステートメントリソースを 渡さなかった場合は、直近で (例えば <strong>db2_prepare()</strong>
  あるいは <strong>db2_exec()</strong> を使用して) 返そうとしたステートメントリソースに関連する SQLSTATE を返します。
  
  SQLSTATE の値の意味を調べるには、DB2 コマンドラインプロセッサのプロンプトで 次のコマンドを発行しま
  す。 db2 '? <strong>$sqlstate-value</strong>' また、<strong>db2_stmt_errormsg()</strong> をコールして、 明示的なエラーメッセージと、
  それに関連する SQLCODE の値を取得することも可能です。

<comment>Param:</comment>
  <info>resource|null</info>  <strong>$stmt</strong>  有効なステートメントリソース。

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

<comment>See Also:</comment>
   * <strong>db2_conn_error()</strong>
   * <strong>db2_conn_errormsg()</strong>
   * <strong>db2_stmt_errormsg()</strong>


id: db2_stmt_errormsg
type: function
doc:
<comment>Description:</comment>
  直近の SQL 文のエラーメッセージを含む文字列を返す
    
  
  直近の SQL 文のエラーメッセージを含む文字列を返します。
  
  <strong>db2_stmt_errormsg()</strong> の引数にステートメントリソースを 渡さなかった場合は、直近で (例えば
  <strong>db2_prepare()</strong> あるいは <strong>db2_exec()</strong> を使用して) 返そうとしたステートメントリソースに関連するエラー
  メッセージを返します。

<comment>Param:</comment>
  <info>resource|null</info>  <strong>$stmt</strong>  有効なステートメントリソース。

<comment>Return:</comment>
  <info>string</info>  SQL 文の発行により直近に発生したエラーを表す エラーメッセージおよび SQLSTATE を返します。

<comment>See Also:</comment>
   * <strong>db2_conn_error()</strong>
   * <strong>db2_conn_errormsg()</strong>
   * <strong>db2_stmt_error()</strong>


id: db2_table_privileges
type: function
doc:
<comment>Description:</comment>
  データベース内のテーブルおよび関連する権限情報を含む結果セットを返す
    
  
  データベース内のテーブルおよび関連する権限情報を含む結果セットを返します。

<comment>Param:</comment>
  <info>resource</info>     <strong>$connection</strong>  IBM DB2、Cloudscape あるいは Apache Derby データベースへの有効な接続。
  <info>string|null</info>  <strong>$qualifier</strong>   OS/390 あるいは z/OS サーバー上で稼動している DB2 データベースの修飾子。
                            その他のデータベースの場合には <info>null</info> あるいは空の文字列を渡します。
  <info>string|null</info>  <strong>$schema</strong>      テーブルを含むスキーマ。このパラメータには、ワイルドカードとして <return>_</return> およ
                            び <return>%</return> を含む検索パターンを指定することができます。
  <info>string|null</info>  <strong>$table_name</strong>  テーブルの名前。このパラメータには、ワイルドカードとして <return>_</return> および <return>%</return> を含
                            む検索パターンを指定することができます。

<comment>Return:</comment>
  <info>resource</info>  指定したパラメータに一致するテーブルの権限情報を含むステートメントリソースを返します。
            行の内容は、以下のカラムで構成されています。 カラム名説明TABLE_CAT テーブルを含むカタロ
            グの名前。テーブルがカタログを保持していない場合は <info>null</info>。 TABLE_SCHEMテーブルを含むス
            キーマの名前。TABLE_NAMEテーブルの名前。GRANTORその権限を与えたユーザーの認証 ID。
            GRANTEEその権限を与えられたユーザーの認証 ID。PRIVILEGE 与えられた権限。ALTER、
            CONTROL、DELETE、INDEX、INSERT、REFERENCES、SELECT あるいは UPDATE のいずれかです。
            IS_GRANTABLE grantee が、この権限を他のユーザーに与えることができるかどうかを、 文字列
            "YES" あるいは "NO" で表す。

<comment>See Also:</comment>
   * <strong>db2_column_privileges()</strong>
   * <strong>db2_columns()</strong>
   * <strong>db2_foreign_keys()</strong>
   * <strong>db2_primary_keys()</strong>
   * <strong>db2_procedure_columns()</strong>
   * <strong>db2_procedures()</strong>
   * <strong>db2_special_columns()</strong>
   * <strong>db2_statistics()</strong>
   * <strong>db2_tables()</strong>


id: db2_tables
type: function
doc:
<comment>Description:</comment>
  データベース内のテーブルおよび関連するメタデータを含む結果セットを返す
    
  
  データベース内のテーブルおよび関連するメタデータを含む結果セットを返します。

<comment>Param:</comment>
  <info>resource</info>     <strong>$connection</strong>  IBM DB2、Cloudscape あるいは Apache Derby データベースへの有効な接続。
  <info>string|null</info>  <strong>$qualifier</strong>   OS/390 あるいは z/OS サーバー上で稼動している DB2 データベースの修飾子。
                            その他のデータベースの場合には <info>null</info> あるいは空の文字列を渡します。
  <info>string|null</info>  <strong>$schema</strong>      テーブルを含むスキーマ。このパラメータでは、ワイルドカードとして <return>_</return> およ
                            び <return>%</return> を含む検索パターンを使用可能です。
  <info>string|null</info>  <strong>$table_name</strong>  テーブルの名前。このパラメータでは、ワイルドカードとして <return>_</return> および <return>%</return> を含
                            む検索パターンを使用可能です。
  <info>string|null</info>  <strong>$table_type</strong>  テーブル型の識別子をカンマで区切ったリスト。 すべてのテーブル型を指定す
                            るには、<info>null</info> あるいは空の文字列を指定します。 有効なテーブル型識別子は
                            ALIAS、HIERARCHY TABLE、INOPERATIVE VIEW、NICKNAME、 MATERIALIZED QUERY
                            TABLE、SYSTEM TABLE、TABLE、TYPED TABLE、TYPED VIEW および VIEW です。

<comment>Return:</comment>
  <info>resource</info>  指定したパラメータに一致するテーブルの情報を含む結果セットのリソースを返します。 行の内
            容は、以下のカラムで構成されています。 カラム名説明TABLE_CAT テーブルを含むカタログ。
            テーブルがカタログを保持していない場合は <info>null</info>。 TABLE_SCHEMテーブルを含むスキーマの名
            前。TABLE_NAMEテーブルの名前。TABLE_TYPEテーブルの型識別子。REMARKSテーブルの説明。

<comment>See Also:</comment>
   * <strong>db2_column_privileges()</strong>
   * <strong>db2_columns()</strong>
   * <strong>db2_foreign_keys()</strong>
   * <strong>db2_primary_keys()</strong>
   * <strong>db2_procedure_columns()</strong>
   * <strong>db2_procedures()</strong>
   * <strong>db2_special_columns()</strong>
   * <strong>db2_statistics()</strong>
   * <strong>db2_table_privileges()</strong>


id: dba_close
type: function
doc:
<comment>Description:</comment>
  DBA データベースを閉じる
  
  <strong>dba_close()</strong> は確立されたデータベースを閉じ、 により指定したデータベースハンドルの全てのリソースを
  開放します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$dba</strong>  <strong>dba_open()</strong> あるいは <strong>dba_popen()</strong> によって返されたデータベースハンドル。

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

<comment>See Also:</comment>
   * <strong>dba_open()</strong>
   * <strong>dba_popen()</strong>


id: dba_delete
type: function
doc:
<comment>Description:</comment>
  キーが指す DBA エントリを削除する
  
  <strong>dba_delete()</strong> は、指定されたエントリを データベースから削除します。

<comment>Param:</comment>
  <info>string|array</info>  <strong>$key</strong>  削除するエントリのキー。
  <info>resource</info>      <strong>$dba</strong>  <strong>dba_open()</strong> あるいは <strong>dba_popen()</strong> によって返されたデータベースハンドル。

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

<comment>See Also:</comment>
   * <strong>dba_exists()</strong>
   * <strong>dba_fetch()</strong>
   * <strong>dba_insert()</strong>
   * <strong>dba_replace()</strong>


id: dba_exists
type: function
doc:
<comment>Description:</comment>
  キーが存在するかどうかを確認する
  
  <strong>dba_exists()</strong> は、指定した <strong>$key</strong> がデータベースに存在するかどうかを確認します。

<comment>Param:</comment>
  <info>string|array</info>  <strong>$key</strong>  確認を行うキー。
  <info>resource</info>      <strong>$dba</strong>  <strong>dba_open()</strong> あるいは <strong>dba_popen()</strong> によって返されたデータベースハンドル。

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

<comment>See Also:</comment>
   * <strong>dba_delete()</strong>
   * <strong>dba_fetch()</strong>
   * <strong>dba_insert()</strong>
   * <strong>dba_replace()</strong>


id: dba_fetch
type: function
doc:
<comment>Description:</comment>
  キーが指すデータを取得する
  
  以下はオーバーロードされているが、PHP 8.3.0 以降では推奨されないシグネチャです:
  
  <strong>dba_fetch()</strong> は、<strong>$dba</strong> が指すデータベースから <strong>$key</strong> が指すデータを 取得します。

<comment>Param:</comment>
  <info>string|array</info>  <strong>$key</strong>   データを取得するキー。
                       
                       inifile を利用する際には、この関数は配列を受け入れることが可能です。 インデッ
                       クス 0 にはグループ名、インデックス 1 には値の名前を格納します。
                       <strong>dba_key_split()</strong> も参照ください。
  <info>resource</info>      <strong>$dba</strong>   <strong>dba_open()</strong> あるいは <strong>dba_popen()</strong> によって返されたデータベースハンドル。
  <info>int</info>           <strong>$skip</strong>  cdb データベースを使用する際に無視する キー / 値 の組み合わせ数。 複数のキー
                       に同じ名前をつけることがサポートされていないデータベースです、 この値は無視さ
                       れます。

<comment>Return:</comment>
  <info>string|false</info>  キー / データの組が見つかった場合にそれに関連する文字列、 それ以外の場合に <info>false</info> を
                返します。

<comment>See Also:</comment>
   * <strong>dba_exists()</strong>
   * <strong>dba_delete()</strong>
   * <strong>dba_insert()</strong>
   * <strong>dba_replace()</strong>
   * <strong>dba_key_split()</strong>


id: dba_firstkey
type: function
doc:
<comment>Description:</comment>
  最初のキーを取得する
  
  <strong>dba_firstkey()</strong> はデータベースの最初のキーを返し、 内部キーポインタをリセットします。 この関数によ
  りデータベース全体を連続的にサーチすることが可能になります。

<comment>Param:</comment>
  <info>resource</info>  <strong>$dba</strong>  <strong>dba_open()</strong> あるいは <strong>dba_popen()</strong> によって返されたデータベースハンドル。

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

<comment>See Also:</comment>
   * <strong>dba_nextkey()</strong>
   * <strong>dba_key_split()</strong>
   * DBA の例の例 2


id: dba_handlers
type: function
doc:
<comment>Description:</comment>
  利用可能なハンドラの一覧を得る
  
  <strong>dba_handlers()</strong> は、この拡張モジュールにより サポートされる全てのハンドラの一覧を返します。

<comment>Param:</comment>
  <info>bool</info>  <strong>$full_info</strong>  結果の全ての情報を表示するかどうかを切り替えます。

<comment>Return:</comment>
  <info>array</info>  データベースハンドラの配列を返します。<strong>$full_info</strong> が <info>true</info> の場合、この配列はハンドラ名を
         キー、そのバージョンを値とする 連想配列となります。それ以外の場合はハンドラ名を値に持つ数値
         添字の配列と なります。
         
         cdb ライブラリが用いられている場合、 <return>cdb</return> および <return>cdb_make</return> が表示されます。


id: dba_insert
type: function
doc:
<comment>Description:</comment>
  エントリを挿入する
  
  <strong>dba_insert()</strong> は、 データベースに <strong>$key</strong> および <strong>$value</strong> で記述されるエントリを挿入します。

<comment>Param:</comment>
  <info>string|array</info>  <strong>$key</strong>    挿入するエントリのキー。もしこのキーが既にデータベースに存在する場合、 この
                        関数は失敗します。既存のキーを置き換える場合は、 <strong>dba_replace()</strong> を使用してく
                        ださい。
  <info>string</info>        <strong>$value</strong>  挿入する値。
  <info>resource</info>      <strong>$dba</strong>    <strong>dba_open()</strong> あるいは <strong>dba_popen()</strong> によって返されたデータベースハンドル。

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

<comment>See Also:</comment>
   * <strong>dba_exists()</strong>
   * <strong>dba_delete()</strong>
   * <strong>dba_fetch()</strong>
   * <strong>dba_replace()</strong>


id: dba_key_split
type: function
doc:
<comment>Description:</comment>
  文字列形式のキーを配列形式に分割する
    
  
  <strong>dba_key_split()</strong> は、キー（文字列形式） を配列に分割します。

<comment>Param:</comment>
  <info>string|false|null</info>  <strong>$key</strong>  文字列形式のキー。

<comment>Return:</comment>
  <info>array|false</info>  <return>array(0 =&gt; group, 1 =&gt;  value_name)</return> 形式の配列を返します。 <strong>$key</strong> が <info>null</info> あるい
               は <info>false</info> の場合には この関数は <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>dba_firstkey()</strong>
   * <strong>dba_nextkey()</strong>
   * <strong>dba_fetch()</strong>


id: dba_list
type: function
doc:
<comment>Description:</comment>
  オープンされている全データベースファイルのリストを得る
  
  <strong>dba_list()</strong> は、オープンされている全ての データベースファイルの一覧を返します。

<comment>Return:</comment>
  <info>array</info>  <return>resourceid =&gt; filename</return> 形式の連想配列を返します。


id: dba_nextkey
type: function
doc:
<comment>Description:</comment>
  次のキーを取得する
  
  <strong>dba_nextkey()</strong> は、 が指すデータベースの次のキーを返し、内部キーポインタを進めます。

<comment>Param:</comment>
  <info>resource</info>  <strong>$dba</strong>  <strong>dba_open()</strong> あるいは <strong>dba_popen()</strong> によって返されたデータベースハンドル。

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

<comment>See Also:</comment>
   * <strong>dba_firstkey()</strong>
   * <strong>dba_key_split()</strong>
   * DBA の例の例 2


id: dba_open
type: function
doc:
<comment>Description:</comment>
  データベースをオープンする
  
  <strong>dba_open()</strong> は、<strong>$handler</strong> を用いて <strong>$mode</strong> を指定し、<strong>$path</strong> にデータベースインスタンスを生成します。

<comment>Param:</comment>
  <info>string</info>       <strong>$path</strong>        通常のファイルシステムのパス。
  <info>string</info>       <strong>$mode</strong>        既存のデータベースへの読み込みアクセスには "r"、読込み/書き込み アクセス
                            には "w" を指定します。 読み込み/書き込みアクセスおよび存在しない場合に
                            データベースの作成を するには "c" を、そして作成、削除、読込み/書き込み
                            アクセス用には "n" を指定します。データベースは BTree モードで作られま
                            す。 その他のモード (Hash や Queue) には対応していません。
                            
                            さらに、次の文字でデータベースのロック方法を指定することができます。
                            .lck でデータベースをロックする場合には "l"、 データベースファイル自体を
                            ロックする場合は "d" を使用してください。 アプリケーション全体で統一した
                            方法を用いることが重要です。
                            
                            アクセスのテストを行う際にロックのために待ちたくない場合、"t" を 3 番目
                            の文字に追加することができます。明らかにデータベースのロックが 不要な場
                            合には、"l" や "d" の代わりに "-" を使用してロックを 行わないことができ
                            ます。"d"、"l" または "-" のどれも指定されない場合、 "d"が指定されたもの
                            としてデータベースファイルをロックします。
                            
                            ひとつのデータベースファイルに同時に書き込めるのは、ひとつだけです。 dba
                            を Web サーバーで使用している際に複数のリクエストが書き込み処理を 行う必
                            要がある場合、他の書き込みが終わってからでないと次の書き込みを 行うこと
                            ができません。また、書き込み中に読み込むことはできません。 dba 拡張モ
                            ジュールは、このようなことを防止するためにロックを使用します。 以下の表
                            を参照ください: DBA のロック処理既にオープンしているデータベース<strong>$mode</strong> =
                            "rl"<strong>$mode</strong> = "rlt"<strong>$mode</strong> = "wl"<strong>$mode</strong> = "wlt"<strong>$mode</strong> = "rd"<strong>$mode</strong> = "rdt"<strong>$mode</strong>
                            = "wd"<strong>$mode</strong> = "wdt"not openokokokokokokokok<strong>$mode</strong> =
                            "rl"okokwaitfalseillegalillegalillegalillegal<strong>$mode</strong> =
                            "wl"waitfalsewaitfalseillegalillegalillegalillegal<strong>$mode</strong> =
                            "rd"illegalillegalillegalillegalokokwaitfalse<strong>$mode</strong> =
                            "wd"illegalillegalillegalillegalwaitfalsewaitfalse ok: 2 番目のコールは
                            成功します。wait: 2 番目のコールは、最初のデータベースで <strong>dba_close()</strong> が
                            コールされるまで待ちます。false: 2 番目のコールは、false を返します。
                            illegal: <strong>$mode</strong> パラメータで <return>"l"</return> および <return>"d"</return> を同時に使用することはできま
                            せん。
  <info>string|null</info>  <strong>$handler</strong>     <strong>$path</strong> にアクセスする際に使用する ハンドラの名前。 <strong>dba_open()</strong> に指定した
                            すべてのオプションが渡され、 その機能を用いることができます。 <strong>$handler</strong>
                            が <info>null</info> の場合、 デフォルトのハンドラが使われます。
  <info>int</info>          <strong>$permission</strong>  ドライバに渡されるオプションの整数パラメータ。 <strong>chmod()</strong> の <strong>$permissions</strong>
                            を同じ意味です。 デフォルトは <return>0644</return> です。
                            
                            <return>db1</return>, <return>db2</return>, <return>db3</return>, <return>db4</return>, <return>dbm</return>, <return>gdbm</return>, <return>ndbm</return>, <return>lmdb</return> ドライバが <strong>$permission</strong> パラ
                            メータをサポートしています。
  <info>int</info>          <strong>$map_size</strong>    ドライバに渡されるオプションの整数パラメータ。 OS のページサイズの倍数を
                            指定すべきです。 ゼロを指定すると、デフォルトのマップサイズが使われま
                            す。
                            
                            <return>lmdb</return> ドライバだけが <strong>$map_size</strong> パラメータを受け入れます。
  <info>int|null</info>     <strong>$flags</strong>       データベースドライバに渡すフラグ。 <info>null</info> の場合、 デフォルトのフラグが渡
                            されます。 現状、LMDB ドライバだけが <info>DBA_LMDB_USE_SUB_DIR</info> と
                            <info>DBA_LMDB_NO_SUB_DIR</info> をサポートしています。

<comment>Return:</comment>
  <info>resource|false</info>  成功した場合に正のハンドルを返します。 失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>dba_popen()</strong>
   * <strong>dba_close()</strong>


id: dba_optimize
type: function
doc:
<comment>Description:</comment>
  データベースを最適化する
  
  <strong>dba_optimize()</strong> は、指定されたデータベースを最適化します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$dba</strong>  <strong>dba_open()</strong> あるいは <strong>dba_popen()</strong> によって返されたデータベースハンドル。

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

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


id: dba_popen
type: function
doc:
<comment>Description:</comment>
  データベースを持続的にオープンする
  
  <strong>dba_popen()</strong> は、<strong>$handler</strong> を用いて <strong>$mode</strong> で <strong>$path</strong> に持続的なデータベースインスタンスを確立します。

<comment>Param:</comment>
  <info>string</info>       <strong>$path</strong>        通常のファイルシステムのパス。
  <info>string</info>       <strong>$mode</strong>        既存のデータベースへの読み込みアクセスには "r"、読込み/書き込み アクセス
                            には "w" を指定します。 読み込み/書き込みアクセスおよび存在しない場合に
                            データベースの作成を するには "c" を、そして作成、削除、読込み/書き込み
                            アクセス用には "n" を指定します。
  <info>string|null</info>  <strong>$handler</strong>     <strong>$path</strong> にアクセスする際に使用する ハンドラの名前。 <strong>dba_popen()</strong> に指定した
                            すべてのオプションが 渡され、その機能を用いることができます。 <strong>$handler</strong>
                            が <info>null</info> の場合、 デフォルトのハンドラが使われます。
  <info>int</info>          <strong>$permission</strong>  ドライバに渡されるオプションの整数パラメータ。 <strong>chmod()</strong> の <strong>$permissions</strong>
                            を同じ意味です。 デフォルトは <return>0644</return> です。
                            
                            <return>db1</return>, <return>db2</return>, <return>db3</return>, <return>db4</return>, <return>dbm</return>, <return>gdbm</return>, <return>ndbm</return>, <return>lmdb</return>ドライバが <strong>$permission</strong> パラメー
                            タをサポートしています。
  <info>int</info>          <strong>$map_size</strong>    ドライバに渡されるオプションの整数パラメータ。 OS のページサイズの倍数を
                            指定すべきです。 ゼロを指定すると、デフォルトのマップサイズが使われま
                            す。
                            
                            <return>lmdb</return> ドライバだけが <strong>$map_size</strong> パラメータを受け入れます。
  <info>int|null</info>     <strong>$flags</strong>       データベースドライバに渡すフラグ。 現状、LMDB ドライバだけが
                            <info>DBA_LMDB_USE_SUB_DIR</info> と <info>DBA_LMDB_NO_SUB_DIR</info> をサポートしています。

<comment>Return:</comment>
  <info>resource|false</info>  成功した場合に正のハンドルを返します。 失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>dba_open()</strong>
   * <strong>dba_close()</strong>


id: dba_replace
type: function
doc:
<comment>Description:</comment>
  エントリを置換または挿入する
  
  <strong>dba_replace()</strong> は、<strong>$dba</strong> で 指定したデータベースに <strong>$key</strong> および <strong>$value</strong> で記述されるエントリを 置換ま
  たは挿入します。

<comment>Param:</comment>
  <info>string|array</info>  <strong>$key</strong>    置換するエントリのキー。
  <info>string</info>        <strong>$value</strong>  置換される値。
  <info>resource</info>      <strong>$dba</strong>    <strong>dba_open()</strong> あるいは <strong>dba_popen()</strong> によって返されたデータベースハンドル。

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

<comment>See Also:</comment>
   * <strong>dba_exists()</strong>
   * <strong>dba_delete()</strong>
   * <strong>dba_fetch()</strong>
   * <strong>dba_insert()</strong>


id: dba_sync
type: function
doc:
<comment>Description:</comment>
  データベースを同期する
  
  <strong>dba_sync()</strong> は データベースを同期します。サポートされる場合には、 おそらくディスクへの物理的アクセ
  スへのきっかけとなることでしょう。

<comment>Param:</comment>
  <info>resource</info>  <strong>$dba</strong>  <strong>dba_open()</strong> あるいは <strong>dba_popen()</strong> によって返されたデータベースハンドル。

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

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


id: dbase_add_record
type: function
doc:
<comment>Description:</comment>
  Adds a record to a database
  
  Adds the given data to the database.

<comment>Param:</comment>
  <info>resource</info>  <strong>$database</strong>  The database resource, returned by <strong>dbase_open()</strong> or <strong>dbase_create()</strong>.
  <info>array</info>     <strong>$data</strong>      An indexed array of data. The number of items must be equal to the number of
                       fields in the database, otherwise <strong>dbase_add_record()</strong> will fail.
                       
                       If you're using <strong>dbase_get_record()</strong> return value for this parameter, remember
                       to reset the key named <return>deleted</return>.

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

<comment>See Also:</comment>
   * <strong>dbase_delete_record()</strong>
   * <strong>dbase_replace_record()</strong>


id: dbase_close
type: function
doc:
<comment>Description:</comment>
  Closes a database
  
  Closes the given database resource.

<comment>Param:</comment>
  <info>resource</info>  <strong>$database</strong>  The database resource, returned by <strong>dbase_open()</strong> or <strong>dbase_create()</strong>.

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

<comment>See Also:</comment>
   * <strong>dbase_open()</strong>
   * <strong>dbase_create()</strong>


id: dbase_create
type: function
doc:
<comment>Description:</comment>
  Creates a database
  
  <strong>dbase_create()</strong> creates a dBase database with the given definition. If the file already exists, it
  is not truncated. <strong>dbase_pack()</strong> can be called to force truncation.
  
  この関数の動作は、open_basedir の設定に依存します。

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>    The path of the database. It can be a relative or absolute path to the file where
                   dBase will store your data.
  <info>array</info>   <strong>$fields</strong>  An array of arrays, each array describing the format of one field of the
                   database. Each field consists of a name, a character indicating the field type,
                   and optionally, a length, a precision and a nullable flag. The supported field
                   types are listed in the introduction section.
                   
                   The fieldnames are limited in length and must not exceed 10 chars.
  <info>int</info>     <strong>$type</strong>    The type of database to be created. Either <info>DBASE_TYPE_DBASE</info> or <info>DBASE_TYPE_FOXPRO</info>.

<comment>Return:</comment>
  <info>resource</info>  Returns a database resource if the database is successfully created, or <info>false</info> if an
            error occurred.

<comment>See Also:</comment>
   * <strong>dbase_open()</strong>
   * <strong>dbase_close()</strong>


id: dbase_delete_record
type: function
doc:
<comment>Description:</comment>
  Deletes a record from a database
  
  Marks the given record to be deleted from the database.
  
  To actually remove the record from the database, you must also call <strong>dbase_pack()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$database</strong>  The database resource, returned by <strong>dbase_open()</strong> or <strong>dbase_create()</strong>.
  <info>int</info>       <strong>$number</strong>    An integer which spans from 1 to the number of records in the database (as
                       returned by <strong>dbase_numrecords()</strong>).

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

<comment>See Also:</comment>
   * <strong>dbase_add_record()</strong>
   * <strong>dbase_replace_record()</strong>


id: dbase_get_header_info
type: function
doc:
<comment>Description:</comment>
  Gets the header info of a database
  
  Returns information on the column structure of the given database resource.

<comment>Param:</comment>
  <info>resource</info>  <strong>$database</strong>  The database resource, returned by <strong>dbase_open()</strong> or <strong>dbase_create()</strong>.

<comment>Return:</comment>
  <info>array</info>  An indexed array with an entry for each column in the database. The array index starts at
         0.
         
         Each array element contains an associative array of column information, as described here:
         name The name of the column type The human-readable name for the dbase type of the column
         (i.e. date, boolean, etc.) The supported field types are listed in the introduction
         section. length The number of bytes this column can hold precision The number of digits of
         decimal precision for the column format A suggested <strong>printf()</strong> format specifier for the
         column offset The byte offset of the column from the start of the row
         
         The name of the column
         
         The human-readable name for the dbase type of the column (i.e. date, boolean, etc.) The
         supported field types are listed in the introduction section.
         
         The number of bytes this column can hold
         
         The number of digits of decimal precision for the column
         
         A suggested <strong>printf()</strong> format specifier for the column
         
         The byte offset of the column from the start of the row
         
         If the database header information cannot be read, <info>false</info> is returned.


id: dbase_get_record
type: function
doc:
<comment>Description:</comment>
  Gets a record from a database as an indexed array
    
  
  Gets a record from a database as an indexed array.

<comment>Param:</comment>
  <info>resource</info>  <strong>$database</strong>  The database resource, returned by <strong>dbase_open()</strong> or <strong>dbase_create()</strong>.
  <info>int</info>       <strong>$number</strong>    The index of the record between <return>1</return> and <return>dbase_numrecords($dbase_identifier)</return>.

<comment>Return:</comment>
  <info>array</info>  An indexed array with the record. This array will also include an associative key named
         <return>deleted</return> which is set to 1 if the record has been  marked for deletion (see
         <strong>dbase_delete_record()</strong>).
         
         各フィールドは適切な PHP の型に変換されますが、以下に挙げる例外があります。  Date は文字列
         のままになります。  DateTime は文字列に変換されます。 <info>PHP_INT_MIN</info>..<info>PHP_INT_MAX</info> の範囲外の
         Integer は文字列になります。  dbase 7.0.0 より前のバージョンでは、boolean (<return>L</return>) が <return>1</return> あるいは
         <return>0</return> に変換されていました。
         
         Date は文字列のままになります。
         
         DateTime は文字列に変換されます。
         
         <info>PHP_INT_MIN</info>..<info>PHP_INT_MAX</info> の範囲外の Integer は文字列になります。
         
         dbase 7.0.0 より前のバージョンでは、boolean (<return>L</return>) が <return>1</return> あるいは <return>0</return> に変換されていました。
         
         On error, <strong>dbase_get_record()</strong> will return <info>false</info>.

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


id: dbase_get_record_with_names
type: function
doc:
<comment>Description:</comment>
  Gets a record from a database as an associative array
    
  
  Gets a record from a dBase database as an associative array.

<comment>Param:</comment>
  <info>resource</info>  <strong>$database</strong>  The database resource, returned by <strong>dbase_open()</strong> or <strong>dbase_create()</strong>.
  <info>int</info>       <strong>$number</strong>    The index of the record between <return>1</return> and <return>dbase_numrecords($dbase_identifier)</return>.

<comment>Return:</comment>
  <info>array</info>  An associative array with the record. This will also include a key named <return>deleted</return> which is
         set to 1 if the record has been marked for deletion (see <strong>dbase_delete_record()</strong>). Therefore
         it is not possible to retrieve the value of a field named <return>deleted</return> with this function.
         
         各フィールドは適切な PHP の型に変換されますが、以下に挙げる例外があります。  Date は文字列
         のままになります。  DateTime は文字列に変換されます。 <info>PHP_INT_MIN</info>..<info>PHP_INT_MAX</info> の範囲外の
         Integer は文字列になります。  dbase 7.0.0 より前のバージョンでは、boolean (<return>L</return>) が <return>1</return> あるいは
         <return>0</return> に変換されていました。
         
         Date は文字列のままになります。
         
         DateTime は文字列に変換されます。
         
         <info>PHP_INT_MIN</info>..<info>PHP_INT_MAX</info> の範囲外の Integer は文字列になります。
         
         dbase 7.0.0 より前のバージョンでは、boolean (<return>L</return>) が <return>1</return> あるいは <return>0</return> に変換されていました。
         
         On error, <strong>dbase_get_record_with_names()</strong> will return <info>false</info>.

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


id: dbase_numfields
type: function
doc:
<comment>Description:</comment>
  Gets the number of fields of a database
  
  Gets the number of fields (columns) in the specified database.
  
  Field numbers are between 0 and <return>dbase_numfields($db)-1</return>, while record numbers are between 1 and
  <return>dbase_numrecords($db)</return>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$database</strong>  The database resource, returned by <strong>dbase_open()</strong> or <strong>dbase_create()</strong>.

<comment>Return:</comment>
  <info>int</info>  The number of fields in the database, or <info>false</info> if an error occurs.

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


id: dbase_numrecords
type: function
doc:
<comment>Description:</comment>
  Gets the number of records in a database
  
  Gets the number of records (rows) in the specified database.
  
  Records which are marked as deleted are counted as well.
  
  Record numbers are between 1 and <return>dbase_numrecords($db)</return>, while field numbers are between 0 and
  <return>dbase_numfields($db)-1</return>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$database</strong>  The database resource, returned by <strong>dbase_open()</strong> or <strong>dbase_create()</strong>.

<comment>Return:</comment>
  <info>int</info>  The number of records in the database, or <info>false</info> if an error occurs.

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


id: dbase_open
type: function
doc:
<comment>Description:</comment>
  Opens a database
  
  <strong>dbase_open()</strong> opens a dBase database with the given access mode.
  
  この関数の動作は、open_basedir の設定に依存します。

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>  The path of the database. It can be a relative or absolute path to the file where
                 dBase will store your data.
  <info>int</info>     <strong>$mode</strong>  An integer which correspond to those for the open()  system call (Typically 0 means
                 read-only, 1 means write-only, and 2  means read and write).
                 
                 You can't open a dBase file in write-only mode as the function will fail to read
                 the headers information and thus you can't use 1 as <strong>$mode</strong>.
                 
                 As of dbase 7.0.0 you can use <info>DBASE_RDONLY</info> and <info>DBASE_RDWR</info>, respectively, to specify
                 the <strong>$mode</strong>.

<comment>Return:</comment>
  <info>resource|false</info>  Returns a database resource on success, 失敗した場合に <info>false</info> を返します.

<comment>See Also:</comment>
   * <strong>dbase_create()</strong>
   * <strong>dbase_close()</strong>


id: dbase_pack
type: function
doc:
<comment>Description:</comment>
  Packs a database
  
  Packs the specified database by permanently deleting all records marked for deletion using
  <strong>dbase_delete_record()</strong>. Note that the file will be truncated after successful packing (contrary to
  dBASE III's PACK command).

<comment>Param:</comment>
  <info>resource</info>  <strong>$database</strong>  The database resource, returned by <strong>dbase_open()</strong> or <strong>dbase_create()</strong>.

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

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


id: dbase_replace_record
type: function
doc:
<comment>Description:</comment>
  Replaces a record in a database
  
  Replaces the given record in the database with the given data.

<comment>Param:</comment>
  <info>resource</info>  <strong>$database</strong>  The database resource, returned by <strong>dbase_open()</strong> or <strong>dbase_create()</strong>.
  <info>array</info>     <strong>$data</strong>      An indexed array of data. The number of items must be equal to the number of
                       fields in the database, otherwise <strong>dbase_replace_record()</strong> will fail.
                       
                       If you're using <strong>dbase_get_record()</strong> return value for this parameter, remember
                       to reset the key named <return>deleted</return>.
  <info>int</info>       <strong>$number</strong>    An integer which spans from 1 to the number of records in the database (as
                       returned by <strong>dbase_numrecords()</strong>).

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

<comment>See Also:</comment>
   * <strong>dbase_add_record()</strong>
   * <strong>dbase_delete_record()</strong>


id: dcgettext
type: function
doc:
<comment>Description:</comment>
  単一の参照に関するドメインを上書きする
  
  この関数により単一の参照についてカレントのドメインを上書きすることができます。

<comment>Param:</comment>
  <info>string</info>  <strong>$domain</strong>    ドメイン。
  <info>string</info>  <strong>$message</strong>   メッセージ。
  <info>int</info>     <strong>$category</strong>  カテゴリ。

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

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


id: dcngettext
type: function
doc:
<comment>Description:</comment>
  dcgettext の複数形版
  
  この関数により単一の複数形メッセージの参照について カレントのドメインを上書きすることができます。

<comment>Param:</comment>
  <info>string</info>  <strong>$domain</strong>    ドメイン。
  <info>string</info>  <strong>$singular</strong>  
  <info>string</info>  <strong>$plural</strong>    
  <info>int</info>     <strong>$count</strong>     
  <info>int</info>     <strong>$category</strong>  

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

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


id: debug_backtrace
type: function
doc:
<comment>Description:</comment>
  バックトレースを生成する
  
  <strong>debug_backtrace()</strong> は PHP バックトレースを生成します。

<comment>Param:</comment>
  <info>int</info>  <strong>$options</strong>  このパラメータは次のオプションのビットマスクとなります。 <strong>debug_backtrace()</strong> のオプ
                 ションDEBUG_BACKTRACE_PROVIDE_OBJECT "object" インデックスを埋めるかどうか。
                 DEBUG_BACKTRACE_IGNORE_ARGS "args" インデックス、 すなわちすべての関数/メソッドの引
                 数を省略してメモリを節約するかどうか。   可能な組み合わせは以下の4つです:
                 <strong>debug_backtrace()</strong> のオプションdebug_backtrace() インデックスを両方収集します。
                 debug_backtrace(DEBUG_BACKTRACE_PROVIDE_OBJECT)debug_backtrace(1)debug_backtrace(0)
                 インデックス <return>"object"</return> を省略し、<return>"args"</return> を収集します。
                 debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS) Omits index <return>"object"</return> and index <return>"args"</return>.
                 インデックス <return>"object"</return> と <return>"args"</return> を 両方省略します。
                 debug_backtrace(2)debug_backtrace(DEBUG_BACKTRACE_PROVIDE_OBJECT|DEBUG_BACKTRACE_IGNORE_ARGS)
                 インデックス <return>"object"</return> と <return>"args"</return> を 両方収集します。 debug_backtrace(3)
                 
                 可能な組み合わせは以下の4つです: <strong>debug_backtrace()</strong> のオプションdebug_backtrace() イ
                 ンデックスを両方収集します。
                 debug_backtrace(DEBUG_BACKTRACE_PROVIDE_OBJECT)debug_backtrace(1)debug_backtrace(0)
                 インデックス <return>"object"</return> を省略し、<return>"args"</return> を収集します。
                 debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS) Omits index <return>"object"</return> and index <return>"args"</return>.
                 インデックス <return>"object"</return> と <return>"args"</return> を 両方省略します。
                 debug_backtrace(2)debug_backtrace(DEBUG_BACKTRACE_PROVIDE_OBJECT|DEBUG_BACKTRACE_IGNORE_ARGS)
                 インデックス <return>"object"</return> と <return>"args"</return> を 両方収集します。 debug_backtrace(3)
  <info>int</info>  <strong>$limit</strong>    このパラメータを使ってスタックフレームの数を制限できます。 デフォルト (<strong>$limit</strong>=<return>0</return>)
                 は、すべてのスタックフレームを返します。

<comment>Return:</comment>
  <info>array</info>  連想配列の配列を返します。連想配列の要素として返される可能性があるものは以下のとおりです。
         
         <strong>debug_backtrace()</strong> から返される可能性がある要素 名前型説明function<info>string</info> カレントの関数名。
         __FUNCTION__ も参照ください。 line<info>int</info> カレントの行番号。 __LINE__ も参照ください。
         file<info>string</info> カレントのファイル名。 __FILE__ も参照ください。 class<info>string</info> カレントのクラス
         名。 __CLASS__ も参照ください。 object<info>object</info> カレントのオブジェクト。 type<info>string</info> カレントの
         コール方式。メソッドを呼び出している場合は "-&gt;"、 staticメソッドを呼び出している場合は
         "::" が返されます。 関数呼び出しの場合は何も返されません。 args<info>array</info> 関数の内部の場合、関数
         の引数のリストとなります。 インクルードされたファイル内では、 読み込まれたファイルの名前と
         なります。

<comment>See Also:</comment>
   * <strong>trigger_error()</strong>
   * <strong>debug_print_backtrace()</strong>


id: debug_print_backtrace
type: function
doc:
<comment>Description:</comment>
  バックトレースを表示する
      
  
  <strong>debug_print_backtrace()</strong> は PHP バックトレースを 表示します。関数のコール、include / require されて
  いるファイル、 そして <strong>eval()</strong> された内容などが表示されます。

<comment>Param:</comment>
  <info>int</info>  <strong>$options</strong>  このパラメータは次のオプションのビットマスクとなります。 <strong>debug_print_backtrace()</strong> の
                 オプションDEBUG_BACKTRACE_IGNORE_ARGS "args" インデックスを無視してすべての関数/メ
                 ソッドの引数をメモリに格納するかどうか。
  <info>int</info>  <strong>$limit</strong>    このパラメータを使ってスタックフレームの数を制限できます。 デフォルト (<strong>$limit</strong>=<return>0</return>)
                 は、すべてのスタックフレームを表示します。

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

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


id: debug_zval_dump
type: function
doc:
<comment>Description:</comment>
  内部的な zval を表す文字列をダンプする
  
  内部的な zval (Zend の値) を表す文字列表現をダンプします。 これは Zend Engine や PHP 拡張モジュー
  ルの実装の詳細をデバッグしたり、理解したりするのに役立ちます。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>   ダンプする変数または値。
  <info>mixed</info>  <strong>$values</strong>  ダンプする追加の変数または値。

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

<comment>See Also:</comment>
   * <strong>var_dump()</strong>
   * <strong>debug_backtrace()</strong>
   * リファレンスの説明
   * References Explained (by Derick Rethans)


id: decbin
type: function
doc:
<comment>Description:</comment>
  10 進数を 2 進数に変換する
  
  引数 <strong>$num</strong> を 2 進数表現した文字列を返します。

<comment>Param:</comment>
  <info>int</info>  <strong>$num</strong>  変換したい 10 進数値。

<comment>Return:</comment>
  <info>string</info>  <strong>$num</strong> を 2 進文字列で表した値を返します。

<comment>See Also:</comment>
   * <strong>bindec()</strong>
   * <strong>decoct()</strong>
   * <strong>dechex()</strong>
   * <strong>base_convert()</strong>
   * <strong>printf()</strong> でのフォーマット <return>%b</return>、
     <return>%032b</return> あるいは <return>%064b</return>
    
   * <strong>sprintf()</strong> でのフォーマット <return>%b</return>、
     <return>%032b</return> あるいは <return>%064b</return>
    


id: dechex
type: function
doc:
<comment>Description:</comment>
  10 進数を 16 進数に変換する
  
  <strong>$num</strong> で指定した符号なし整数値を 16 進数表現した文字列を返します。
  
  変換できる最大の数字は、32 ビットプラットフォームの場合は <info>PHP_INT_MAX</info><return> * 2 + 1</return> (<return>-1</return>) です。これは 10
  進数で表すと <return>4294967295</return> であり、 <strong>dechex()</strong> が返す結果は <return>ffffffff</return> になります。

<comment>Param:</comment>
  <info>int</info>  <strong>$num</strong>  変換したい 10 進数値。
             
             PHP の <info>int</info> は符号付き整数ですが、 <strong>dechex()</strong> ではこれを符号なし整数として扱います。 つま
             り、負の整数を渡しても、それを符号なし整数として処理します。

<comment>Return:</comment>
  <info>string</info>  <strong>$num</strong> を 16 進文字列で表した値を返します。

<comment>See Also:</comment>
   * <strong>hexdec()</strong>
   * <strong>decbin()</strong>
   * <strong>decoct()</strong>
   * <strong>base_convert()</strong>


id: decoct
type: function
doc:
<comment>Description:</comment>
  10 進数を 8 進数に変換する
  
  引数 <strong>$num</strong> を 8 進数表現した文字列を返します。 変換出来る最大の数字はプラットフォームによって異なり
  ます。 32 ビットプラットフォームでは、通常は十進数の <return>4294967295</return> であり、 これは <return>37777777777</return> を返し
  ます。 64 ビットプラットフォームでは、通常は十進数の <return>9223372036854775807</return> であり、これは
  <return>777777777777777777777</return> を返します。

<comment>Param:</comment>
  <info>int</info>  <strong>$num</strong>  変換したい 10 進数値。

<comment>Return:</comment>
  <info>string</info>  <strong>$num</strong> を 8 進文字列で表した値を返します。

<comment>See Also:</comment>
   * <strong>octdec()</strong>
   * <strong>decbin()</strong>
   * <strong>dechex()</strong>
   * <strong>base_convert()</strong>


id: define
type: function
doc:
<comment>Description:</comment>
  名前を指定して定数を定義する
  
  実行時に、名前を指定して定数を定義します。

<comment>Param:</comment>
  <info>string</info>  <strong>$constant_name</strong>     定数の名前。
                             
                             予約語や無効な名前を使っていても、定数を <strong>define()</strong>  できてしまいます。こ
                             れらの値はを取得するには、 <strong>constant()</strong> 関数を使うこと(だけ)しかできませ
                             ん。 しかしながら、こういったことをするのは推奨されません。
  <info>mixed</info>   <strong>$value</strong>             定数の値。PHP 5 では、<strong>$value</strong> は スカラー値 (<info>int</info>、 <info>float</info>、<info>string</info>、<info>bool</info>
                             あるいは <info>null</info>) でなければいけません。PHP 7 では配列を使うこともできま
                             す。
                             
                             リソース型の定数を定義することもできますが、 推奨できません。予期せぬ振
                             る舞いをする可能性があります。
  <info>bool</info>    <strong>$case_insensitive</strong>  <info>true</info> を指定すると、定数は大文字小文字を区別しないようになります。 デ
                             フォルトでは大文字小文字を区別します。つまり <return>CONSTANT</return> と <return>Constant</return> は別
                             の値を表すわけです。
                             
                             大文字小文字を区別しない定数を定義するのは、 PHP 7.3.0 以降では推奨され
                             なくなりました。 PHP 8.0.0 以降では、<info>false</info> のみを受け入れます。 <info>true</info> を
                             渡すと、警告が発生します。
                             
                             大文字小文字を区別しないときは、定数は小文字で格納されます。

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

<comment>See Also:</comment>
   * <strong>defined()</strong>
   * <strong>constant()</strong>
   * 定数の節


id: defined
type: function
doc:
<comment>Description:</comment>
  指定した名前の定数が存在するかどうかを調べる
  
  指定した定数が存在し、定義されているかどうかを調べます。
  
  この関数は クラス定数 や 列挙型の case に対しても動作します。
  
  変数が存在するかどうかを知りたければ、<strong>isset()</strong> を利用してください。<strong>defined()</strong> は 定数にしか適用でき
  ません。 関数が存在するかどうかを知りたければ、 <strong>function_exists()</strong> を利用してください。

<comment>Param:</comment>
  <info>string</info>  <strong>$constant_name</strong>  定数名。

<comment>Return:</comment>
  <info>bool</info>  <strong>$constant_name</strong> で指定した名前の定数が定義されている 場合に <info>true</info>、その他の場合に<info>false</info>を返しま
        す。

<comment>See Also:</comment>
   * <strong>define()</strong>
   * <strong>constant()</strong>
   * <strong>get_defined_constants()</strong>
   * <strong>function_exists()</strong>
   * 定数の節


id: deflate_add
type: function
doc:
<comment>Description:</comment>
  インクリメンタルにデータを圧縮する
  
  指定されたコンテクストで、インクリメンタルにデータを圧縮します。

<comment>Param:</comment>
  <info>DeflateContext</info>  <strong>$context</strong>     <strong>deflate_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>deflate_init()</strong>


id: deflate_init
type: function
doc:
<comment>Description:</comment>
  インクリメンタルな圧縮コンテキストを初期化する
  
  指定された <strong>$encoding</strong> を使って インクリメンタルな圧縮コンテキストを初期化します。
  
  <return>window</return> オプションは、 アルゴリズムのウィンドウサイズだけを設定することに注意してください。 これ
  は、同じパラメータが利用するエンコーディングも設定する zlib filter と異なります。 この関数では、エ
  ンコーディングは <strong>$encoding</strong> で指定しなければなりません。
  
  制限: GZIP 圧縮されたストリームにヘッダ情報を設定する方法が現状は存在しません。 これは、次のように
  して設定されます: GZIP シグネチャ (<return>\x1f\x8B</return>); 圧縮メソッド (<return>\x08</return> == DEFLATE); 6 個のゼロバイト; 現
  在のオペレーティングシステム (<return>\x00</return> = Windows, <return>\x03</return> = Unix, など)

<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<return>8</return> .. <return>15</return> までの
                    zlib の window サイズ(対数)。 デフォルトは 15 です。 zlib 1.2.8 以降では、
                    window サイズ <return>8</return> が <info>ZLIB_ENCODING_RAW</info> や <info>ZLIB_ENCODING_GZIP</info> と一緒に指定された場
                    合、この関数は失敗し、警告が発生します。 同時に、zlib は window サイズを <return>8</return> から
                    <return>9</return> に変更します。 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です。
                    
                    <return>8</return> .. <return>15</return> までの zlib の window サイズ(対数)。 デフォルトは 15 です。 zlib 1.2.8
                    以降では、 window サイズ <return>8</return> が <info>ZLIB_ENCODING_RAW</info> や <info>ZLIB_ENCODING_GZIP</info> と一緒に指
                    定された場合、この関数は失敗し、警告が発生します。 同時に、zlib は window サイズ
                    を <return>8</return> から <return>9</return> に変更します。
                    
                    <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>DeflateContext|false</info>  成功した場合、圧縮コンテキストリソース(<return>zlib.deflate</return>) を返します。 失敗した場
                        合に <info>false</info> を返します

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


id: deg2rad
type: function
doc:
<comment>Description:</comment>
  度単位の数値をラジアン単位に変換する
    
  
  この関数は、<strong>$num</strong> の単位を度からラジアンに変換します。

<comment>Param:</comment>
  <info>float</info>  <strong>$num</strong>  度で表した角度。

<comment>Return:</comment>
  <info>float</info>  <strong>$num</strong> と同等な値をラジアンで表したものを返します。

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


id: delete
type: function
doc:
<comment>Description:</comment>
  unlink か unset を参照ください
  
  PHP には、delete というキーワードや関数は存在しません。 もしあなたがファイルを削除する方法を探して
  このページにたどり着いたのなら、 <strong>unlink()</strong> を試してください。 ローカルスコープから変数を削除する場
  合は、 <strong>unset()</strong> を参照ください。

<comment>See Also:</comment>
   * <strong>unlink()</strong>
   * <strong>unset()</strong>


id: dgettext
type: function
doc:
<comment>Description:</comment>
  現在のドメインを上書きする
  
  <strong>dgettext()</strong> 関数により、単一のメッセージ参照について 現在のドメインを上書きすることができます。

<comment>Param:</comment>
  <info>string</info>  <strong>$domain</strong>   ドメイン。
  <info>string</info>  <strong>$message</strong>  メッセージ。

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

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


id: dio_close
type: function
doc:
<comment>Description:</comment>
  fd で指定したファイル記述子を閉じる
  
  関数 <strong>dio_close()</strong> は、ファイル記述子 <strong>$fd</strong> を閉じます。

<comment>Param:</comment>
  <info>resource</info>  <strong>$fd</strong>  <strong>dio_open()</strong> が返すファイル記述子。

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

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


id: dio_fcntl
type: function
doc:
<comment>Description:</comment>
  fd について C ライブラリの fcntl を実行する
  
  関数 <strong>dio_fcntl()</strong> は、ファイル記述子 <strong>$fd</strong> において <strong>$cmd</strong> で指定された処理を行います。いくつかのコマン
  ドでは、オプションの引数 <strong>$args</strong> の指定が必要となります。

<comment>Param:</comment>
  <info>resource</info>  <strong>$fd</strong>    <strong>dio_open()</strong> が返すファイル記述子。
  <info>int</info>       <strong>$cmd</strong>   以下の処理のいずれか。 <info>F_SETLK</info> - ロックが設定あるいはクリアされます。 ロックが他
                   の誰かに設定されている場合、<strong>dio_fcntl()</strong> は -1 を返します。 <info>F_SETLKW</info> - <info>F_SETLK</info> と
                   似ていますが、ロックが他の誰かに設定されている場合は <strong>dio_fcntl()</strong> はそのロックが開
                   放されるまで待ちます。 <info>F_GETLK</info> - <strong>dio_fcntl()</strong>  は、他の誰かがロックを妨げる場合、
                   （後述の）連想配列を返します。 妨げるものがない場合、キー "type" は <info>F_UNLCK</info> に設
                   定されます。 <info>F_DUPFD</info> - <strong>$args</strong> 以上で最小のファイル記述子を探し、それを返します。
                   <info>F_SETFL</info> - ファイル記述子のフラグを <strong>$args</strong> で指定した値に設定します。指定できる値は
                   <info>O_APPEND</info>、<info>O_NONBLOCK</info> あるいは <info>O_ASYNC</info> のいずれかです。 <info>O_ASYNC</info> を使用するには、
                   PCNTL 拡張モジュールが必要です。
                   
                   <info>F_SETLK</info> - ロックが設定あるいはクリアされます。 ロックが他の誰かに設定されている場
                   合、<strong>dio_fcntl()</strong> は -1 を返します。
                   
                   <info>F_SETLKW</info> - <info>F_SETLK</info> と似ていますが、ロックが他の誰かに設定されている場合は
                   <strong>dio_fcntl()</strong> はそのロックが開放されるまで待ちます。
                   
                   <info>F_GETLK</info> - <strong>dio_fcntl()</strong>  は、他の誰かがロックを妨げる場合、（後述の）連想配列を返し
                   ます。 妨げるものがない場合、キー "type" は <info>F_UNLCK</info> に設定されます。
                   
                   <info>F_DUPFD</info> - <strong>$args</strong> 以上で最小のファイル記述子を探し、それを返します。
                   
                   <info>F_SETFL</info> - ファイル記述子のフラグを <strong>$args</strong> で指定した値に設定します。指定できる値は
                   <info>O_APPEND</info>、<info>O_NONBLOCK</info> あるいは <info>O_ASYNC</info> のいずれかです。 <info>O_ASYNC</info> を使用するには、
                   PCNTL 拡張モジュールが必要です。
  <info>mixed</info>     <strong>$args</strong>  <strong>$args</strong> は連想配列で、 <strong>$cmd</strong> が <info>F_SETLK</info> あるいは <info>F_SETLLW</info> の際に以下のキーを保持しま
                   す。 <return>start</return> - ロックを開始するオフセット。 <return>length</return> - ロックする領域の大きさ。ゼロは
                   ファイルの終端までを意味します。 <return>wenth</return> - l_start の相対位置指定。 <info>SEEK_SET</info>、
                   <info>SEEK_END</info> および <info>SEEK_CUR</info> のいずれか。 <return>type</return> - ロックの種類。<info>F_RDLCK</info>（読み込み ロッ
                   ク）、<info>F_WRLCK</info>（書き込みロック）あるいは <info>F_UNLCK</info>（ロック解除）のいずれか。
                   
                   <return>start</return> - ロックを開始するオフセット。
                   
                   <return>length</return> - ロックする領域の大きさ。ゼロはファイルの終端までを意味します。
                   
                   <return>wenth</return> - l_start の相対位置指定。 <info>SEEK_SET</info>、 <info>SEEK_END</info> および <info>SEEK_CUR</info> のいずれか。
                   
                   <return>type</return> - ロックの種類。<info>F_RDLCK</info>（読み込み ロック）、<info>F_WRLCK</info>（書き込みロック）あるい
                   は <info>F_UNLCK</info>（ロック解除）のいずれか。

<comment>Return:</comment>
  <info>mixed</info>  C ライブラリをコールした結果を返します。


id: dio_open
type: function
doc:
<comment>Description:</comment>
  C ライブラリの入出力ストリーム関数が許すよりも低レベルでファイルをオープンする
     (必要ならファイルを作成する)
    
  
  <strong>dio_open()</strong> は、ファイルをオープンして そのファイル記述子を返します。

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  オープンするファイルのパス。
  <info>int</info>     <strong>$flags</strong>     <strong>$flags</strong> パラメータには、 以下のフラグの組み合わせを指定します。 この値は、
                     <info>O_RDONLY</info>、<info>O_WRONLY</info>、 あるいは <info>O_RDWR</info> のいずれかでなければなりません。 さらに、
                     このリストからその他の値を組み合わせることもできます。 <info>O_RDONLY</info> - 読み込み専用
                     でファイルをオープンします。 <info>O_WRONLY</info> - 書き込み専用でファイルをオープンしま
                     す。 <info>O_RDWR</info> - 読み書き両用でファイルをオープンします。 <info>O_CREAT</info> - ファイルが存在
                     しなければ 新しいファイルを作成します。 <info>O_EXCL</info> - <info>O_CREAT</info> および <info>O_EXCL</info> をともに
                     指定すると、 すでにファイルが存在する場合に <strong>dio_open()</strong> が失敗します。 <info>O_TRUNC</info> -
                     すでにファイルが存在し、書き込み アクセス用にオープンされている場合、ファイルの
                     長さをゼロに切り詰めます。 <info>O_APPEND</info> - 書き込み時は、ファイルの終端に 追記しま
                     す。 <info>O_NONBLOCK</info> - 非ブロッキングモードを指定します。 <info>O_NOCTTY</info> - TTY デバイス
                     ファイルをオープンするときに、 オープンしたファイルをプロセスが自動的に制御端末
                     としないようにします。
                     
                     <info>O_RDONLY</info> - 読み込み専用でファイルをオープンします。
                     
                     <info>O_WRONLY</info> - 書き込み専用でファイルをオープンします。
                     
                     <info>O_RDWR</info> - 読み書き両用でファイルをオープンします。
                     
                     <info>O_CREAT</info> - ファイルが存在しなければ 新しいファイルを作成します。
                     
                     <info>O_EXCL</info> - <info>O_CREAT</info> および <info>O_EXCL</info> をともに指定すると、 すでにファイルが存在する場
                     合に <strong>dio_open()</strong> が失敗します。
                     
                     <info>O_TRUNC</info> - すでにファイルが存在し、書き込み アクセス用にオープンされている場合、
                     ファイルの長さをゼロに切り詰めます。
                     
                     <info>O_APPEND</info> - 書き込み時は、ファイルの終端に 追記します。
                     
                     <info>O_NONBLOCK</info> - 非ブロッキングモードを指定します。
                     
                     <info>O_NOCTTY</info> - TTY デバイスファイルをオープンするときに、 オープンしたファイルをプ
                     ロセスが自動的に制御端末としないようにします。
  <info>int</info>     <strong>$mode</strong>      <strong>$flags</strong> が <info>O_CREAT</info> を含む場合に、<strong>$mode</strong> でファイルのモード (作成許可) を指定しま
                     す。<info>O_CREAT</info> が <strong>$flags</strong> に指定されている場合には <strong>$mode</strong> が必須となり、それ以外の場
                     合は無視されます。
                     
                     ファイルを作成したときに実際に設定されるモードは、プロセスの umask 設定によって
                     変わります。

<comment>Return:</comment>
  <info>resource</info>  ファイル記述子を返します。エラー時には <info>false</info> を返します。

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


id: dio_read
type: function
doc:
<comment>Description:</comment>
  ファイル記述子からバイトデータを読み込む
  
  関数 <strong>dio_read()</strong> は 記述子 <strong>$fd</strong> で示されるファイルから <strong>$len</strong> バイトを読み込み、それを返します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$fd</strong>   <strong>dio_open()</strong> が返すファイル記述子。
  <info>int</info>       <strong>$len</strong>  読み込むバイト数。指定されなかった場合は <strong>dio_read()</strong> は 1K サイズのブロックを読み込
                  みます。

<comment>Return:</comment>
  <info>string</info>  <strong>$fd</strong> から読み込んだバイトデータを返します。

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


id: dio_seek
type: function
doc:
<comment>Description:</comment>
  fd 上で whence から pos に移動する
  
  関数 <strong>dio_seek()</strong> は、指定されたファイル記述子の ファイル内の位置を変更する際に使用されます。

<comment>Param:</comment>
  <info>resource</info>  <strong>$fd</strong>      <strong>dio_open()</strong> が返すファイル記述子。
  <info>int</info>       <strong>$pos</strong>     新しい位置。
  <info>int</info>       <strong>$whence</strong>  位置 <strong>$pos</strong> をどのように解釈するかを指示します。 <info>SEEK_SET</info>（デフォルト）- <strong>$pos</strong> が
                     ファイル先頭からの位置であることを 指定します。 <info>SEEK_CUR</info> - <strong>$pos</strong> が現在のファイ
                     ル位置からの文字数である ことを指定します。このカウントは正にも負にもなりえま
                     す。 <info>SEEK_END</info> - <strong>$pos</strong> がファイル終端からの文字数であることを 指定します。負の値
                     は、現在のファイルの範囲内の位置を指定します。 正の値は、現在のファイル終端を越
                     えた位置を指定します。ファイル終端を 超える位置を指定して実際にデータを書き込ん
                     だ場合、ファイルは その位置までゼロバイトで埋めて拡張されます。
                     
                     <info>SEEK_SET</info>（デフォルト）- <strong>$pos</strong> がファイル先頭からの位置であることを 指定します。
                     
                     <info>SEEK_CUR</info> - <strong>$pos</strong> が現在のファイル位置からの文字数である ことを指定します。このカ
                     ウントは正にも負にもなりえます。
                     
                     <info>SEEK_END</info> - <strong>$pos</strong> がファイル終端からの文字数であることを 指定します。負の値は、現
                     在のファイルの範囲内の位置を指定します。 正の値は、現在のファイル終端を越えた位
                     置を指定します。ファイル終端を 超える位置を指定して実際にデータを書き込んだ場
                     合、ファイルは その位置までゼロバイトで埋めて拡張されます。

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


id: dio_stat
type: function
doc:
<comment>Description:</comment>
  ファイル記述子 fd に関する stat 情報を取得する
    
  
  <strong>dio_stat()</strong> は、与えられたファイル記述子に関する 情報を返します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$fd</strong>  <strong>dio_open()</strong> が返すファイル記述子。

<comment>Return:</comment>
  <info>array</info>  以下のキーを含む連想配列を返します。  "device" - デバイス  "inode" - i ノード  "mode" -
         モード  "nlink" - ハードリンク数  "uid" - ユーザー ID  "gid" - グループ ID  "device_type" -
         デバイス型（inode デバイスの場合）  "size" - サイズ（バイト数）  "blocksize" - ブロック長
         "blocks" - 割り当てられたブロック数  "atime" - 最終アクセス時刻  "mtime" - 最終更新時刻
         "ctime" - 最終変更時刻  エラー時には <strong>dio_stat()</strong> は <info>null</info> を返します。
         
         "device" - デバイス
         
         "inode" - i ノード
         
         "mode" - モード
         
         "nlink" - ハードリンク数
         
         "uid" - ユーザー ID
         
         "gid" - グループ ID
         
         "device_type" - デバイス型（inode デバイスの場合）
         
         "size" - サイズ（バイト数）
         
         "blocksize" - ブロック長
         
         "blocks" - 割り当てられたブロック数
         
         "atime" - 最終アクセス時刻
         
         "mtime" - 最終更新時刻
         
         "ctime" - 最終変更時刻


id: dio_tcsetattr
type: function
doc:
<comment>Description:</comment>
  シリアルポートの端末属性とボーレートを設定する
    
  
  <strong>dio_tcsetattr()</strong> は、オープンした <strong>$fd</strong> の端末属性とボーレートを指定します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$fd</strong>       <strong>dio_open()</strong> が返すファイル記述子。
  <info>array</info>     <strong>$options</strong>  現在使用可能なオプションは以下のとおりです。  'baud' - ポートのボーレート - と
                      りうる値は 38400,19200,9600,4800,2400,1800, 1200,600,300,200,150,134,110,75 あ
                      るいは 50 で、デフォルト値は 9600 。  'bits' - データビット - とりうる値は
                      8,7,6 あるいは 5 で、デフォルト値は 8 。  'stop' - ストップビット - とりうる値
                      は 1 あるいは 2 で、デフォルト値は 1 。  'parity' - とりうる値は 0,1 あるいは
                      2 で、デフォルト値は 0 。
                      
                      'baud' - ポートのボーレート - とりうる値は 38400,19200,9600,4800,2400,1800,
                      1200,600,300,200,150,134,110,75 あるいは 50 で、デフォルト値は 9600 。
                      
                      'bits' - データビット - とりうる値は 8,7,6 あるいは 5 で、デフォルト値は 8 。
                      
                      'stop' - ストップビット - とりうる値は 1 あるいは 2 で、デフォルト値は 1 。
                      
                      'parity' - とりうる値は 0,1 あるいは 2 で、デフォルト値は 0 。

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


id: dio_truncate
type: function
doc:
<comment>Description:</comment>
  ファイル記述子 fd をオフセットバイトへ丸める
    
  
  <strong>dio_truncate()</strong> は、ファイルの大きさを 最大 <strong>$offset</strong> バイトまでに丸めます。
  
  ファイルがこのサイズより大きかった場合は、残りのデータは失われます。 ファイルがこのサイズより小さ
  かった場合は、ファイルがそのままになるか 拡張されるかは未定義です。後者の場合、拡張された部分の
  データはゼロと なります。

<comment>Param:</comment>
  <info>resource</info>  <strong>$fd</strong>      <strong>dio_open()</strong> が返すファイル記述子。
  <info>int</info>       <strong>$offset</strong>  オフセットのバイト数。

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


id: dio_write
type: function
doc:
<comment>Description:</comment>
  オプションで丸め長さを指定してデータを書き込む
    
  
  <strong>dio_write()</strong> は、<strong>$data</strong> から最大 <strong>$len</strong> バイトを ファイル <strong>$fd</strong> に書き込みます。

<comment>Param:</comment>
  <info>resource</info>  <strong>$fd</strong>    <strong>dio_open()</strong> が返すファイル記述子。
  <info>string</info>    <strong>$data</strong>  書き込むデータ。
  <info>int</info>       <strong>$len</strong>   書き込むデータのバイト長。指定しなかった場合は、データ全体を 指定したファイルに書
                   き込みます。

<comment>Return:</comment>
  <info>int</info>  <strong>$fd</strong> に書き込んだバイト数を返します。

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


id: dir
type: function
doc:
<comment>Description:</comment>
  ディレクトリクラスのインスタンスを返す
  
  ディレクトリを読むための疑似オブジェクト指向の機構です。 指定した <strong>$directory</strong> がオープンされます。

<comment>Param:</comment>
  <info>string</info>         <strong>$directory</strong>  オープンするディレクトリ。
  <info>resource|null</info>  <strong>$context</strong>    ストリームコンテキストリソース

<comment>Return:</comment>
  <info>Directory|false</info>  <class>Directory</class> のインスタンスを返します。 エラーの場合は <info>false</info> を返します。


id: dirname
type: function
doc:
<comment>Description:</comment>
  親ディレクトリのパスを返す
  
  ファイルあるいはディレクトリへのパスを含む文字列を受け取って、 カレントディレクトリから <strong>$levels</strong> レ
  ベルさかのぼった親ディレクトリのパスを返します。
  
  <strong>dirname()</strong> は、入力文字列を単純にそのまま処理します。 実際のファイルシステムを確認したり "<return>..</return>" のよ
  うなパスを気にしたりすることはありません。
  
  Windows では、<strong>dirname()</strong> は現在設定されているコードページに依存します。 よって、マルチバイト文字が
  含まれたパスを正しく表示するには、 それと一致するコードページが設定されていなければいけません。 現
  在のコードページから見て不正な文字が <strong>$path</strong>  に含まれていた場合、 <strong>basename()</strong> の動作は未定義です。
  
  Windows 以外のシステムでは、 <strong>$path</strong> はASCII と互換性があるエンコーディングでエンコードされていると
  想定されています。 そうでない場合、この関数の動作は未定義です。

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>    パス。
                   
                   Windows では、スラッシュ(<return>/</return>)とバックスラッシュ (<return>\</return>)の両方がディレクトリ区切り文字と
                   して使われます。 その他の環境ではスラッシュ(<return>/</return>)になります。
  <info>int</info>     <strong>$levels</strong>  親ディレクトリをどこまでさかのぼるか。
                   
                   正の整数でなければいけません。

<comment>Return:</comment>
  <info>string</info>  親ディレクトリのパスを返します。 <strong>$path</strong> にスラッシュが無い場合は、 カレントディレクトリを示
          すドット ('<return>.</return>') を返します。それ以外の場合は、スラッシュ以降の <return>/component</return> 部分を取り除いた
          <strong>$path</strong> を返します。
          
          この関数をトップレベルディレクトリまで走査するループで使う場合は、 注意が必要です。なぜな
          ら、無限ループに陥る可能性があるからです。

<comment>See Also:</comment>
   * <strong>basename()</strong>
   * <strong>pathinfo()</strong>
   * <strong>realpath()</strong>


id: disk_free_space
type: function
doc:
<comment>Description:</comment>
  ファイルシステムあるいはディスクパーティション上で利用可能な領域を返す
  
  ディレクトリを指定することにより、 この関数は対応するファイルシステムまたはディスクパーティション
  で 利用可能なバイト数を返します。

<comment>Param:</comment>
  <info>string</info>  <strong>$directory</strong>  ファイルシステムのディレクトリあるいはディスクパーティション。
                      
                      ディレクトリのかわりにファイル名を指定したときの挙動は未定義です。 OS や PHP
                      のバージョンによって結果は異なります。

<comment>Return:</comment>
  <info>float|false</info>  利用可能なバイト数を float 型で返します。 失敗した場合に <info>false</info> を返します。

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


id: disk_total_space
type: function
doc:
<comment>Description:</comment>
  ファイルシステムあるいはディスクパーティションの全体サイズを返す
  
  ディレクトリを含む文字列を指定してください。この関数は、 ファイルシステムまたはディスクパーティ
  ションに対応する全体バイト数を返します。

<comment>Param:</comment>
  <info>string</info>  <strong>$directory</strong>  ファイルシステムのディレクトリあるいはディスクパーティション。

<comment>Return:</comment>
  <info>float|false</info>  総バイト数を float 型で返します。 失敗した場合に <info>false</info> を返します。

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


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


id: dl
type: function
doc:
<comment>Description:</comment>
  実行時に PHP 拡張モジュールをロードする
  
  <strong>$extension_filename</strong> で指定された PHP 拡張モジュールを読み込みます。
  
  その拡張モジュールが既に使用可能かどうかを調べるには、 <strong>extension_loaded()</strong> を使用します。 これは、
  組み込みのモジュールと (php.ini か、あるいは <strong>dl()</strong> を使用して) 動的に読み込むモジュールの両方に対応
  しています。
  
  この関数は、CLI と、組み込済みの SAPI に対してのみ使えます。 また、コマンドラインから実行している
  場合にのみ CGI SAPI に対しても使えます。

<comment>Param:</comment>
  <info>string</info>  <strong>$extension_filename</strong>  このパラメータに指定できるのは拡張モジュールの ファイル名だけであり、
                               それはプラットフォームに依存します。 例えば、Unix プラットフォームで
                               は sockets 拡張モジュール (共有モジュールとしてコンパイルされていれ
                               ば。デフォルトでは有りません!) は sockets.so と呼ばれていますし、一方
                               Windows プラットフォームでは php_sockets.dll と呼ばれます。
                               
                               拡張モジュールを読み込むディレクトリは、プラットフォームによって異な
                               ります。
                               
                               Windows - php.ini に明記されていない場合、デフォルトでは 拡張モジュー
                               ルは、C:\php5\ からロードされます。
                               
                               Unix - php.ini に明記されていない場合、デフォルトでは 以下に依存しま
                               す。  PHP をビルドする際に <return>--enable-debug</return> を指定しているか否か  PHP
                               をビルドする際に ZTS (Zend Thread Safety) サポートを有効にしているか
                               否か  現在の <return>ZEND_MODULE_API_NO</return>(Zend 内部モジュール API 番号。基本的
                               にはメジャーモジュール API の変更が発生した日時。 例:<return>20010901</return>)  上記
                               を考慮して、ディレクトリのデフォルトは <return>\<install-dir&gt;/lib/php/extensions/ \<debug-or-not&gt;-\<zts-or-not&gt;-ZEND_MODULE_API_NO</return> となる。 例: /usr/local/php/lib/php/extensions/debug-non-zts-20010901 または /usr/local/php/lib/php/extensions/no-debug-zts-20010901.
                               
                               PHP をビルドする際に <return>--enable-debug</return> を指定しているか否か
                               
                               PHP をビルドする際に ZTS (Zend Thread Safety) サポートを有効にしてい
                               るか否か
                               
                               現在の <return>ZEND_MODULE_API_NO</return>(Zend 内部モジュール API 番号。基本的にはメ
                               ジャーモジュール API の変更が発生した日時。 例:<return>20010901</return>)

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。  拡張モジュールのロード機能が無効
        だったり、あるいは 無効化されている(enable_dl でオフにされている)場合は、 <info>E_ERROR</info> を発行して
        実行は停止されます。 指定されたライブラリをロードできず <strong>dl()</strong> が 失敗した場合、<info>false</info> に加えて
        <info>E_WARNING</info> メッセージが 発行されます。

<comment>See Also:</comment>
   * 拡張モジュール読み込み用のディレクティブ
   * <strong>extension_loaded()</strong>


id: dngettext
type: function
doc:
<comment>Description:</comment>
  dgettext の複数形版
  
  <strong>dngettext()</strong> 関数により、単一の複数形メッセージ参照について 現在のドメインを上書きすることができま
  す。

<comment>Param:</comment>
  <info>string</info>  <strong>$domain</strong>    ドメイン。
  <info>string</info>  <strong>$singular</strong>  
  <info>string</info>  <strong>$plural</strong>    
  <info>int</info>     <strong>$count</strong>     

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

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


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


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


id: dns_get_record
type: function
doc:
<comment>Description:</comment>
  ホスト名に関連する DNS リソースレコードを取得する
  
  指定した <strong>$hostname</strong> に関連づけられた DNS リソースレコードを取得します。

<comment>Param:</comment>
  <info>string</info>  <strong>$hostname</strong>                    <strong>$hostname</strong> は、正しい DNS ホスト名、すなわち "<return>www.example.com</return>"
                                       のようなものでなければなりません。 <return>in-addr.arpa</return> 形式の表記を
                                       用いた逆引き検索は可能ですが、 たいていは <strong>gethostbyaddr()</strong> を
                                       用いるほうが適当です。
                                       
                                       DNS の標準規格により、メールアドレスは <return>user.host</return> 形式で渡され
                                       ます （たとえば、<return>hostmaster.example.com</return> が
                                       <return>hostmaster@example.com</return> の代わりとなります）。 この値をしっか
                                       り確認し、<strong>mail()</strong> のような関数で 利用する前には必要なら変更を
                                       加えることを忘れないようにしてください。
  <info>int</info>     <strong>$type</strong>                        デフォルトでは、<strong>dns_get_record()</strong> は <strong>$hostname</strong> に関連するすべ
                                       てのリソースレコードを検索します。 これを制限するには、オプ
                                       ションの <strong>$type</strong> パラメータを指定してください。 <strong>$type</strong> は以下の
                                       うちのいずれかです。 <info>DNS_A</info>, <info>DNS_CNAME</info>, <info>DNS_HINFO</info>, <info>DNS_CAA</info>,
                                       <info>DNS_MX</info>, <info>DNS_NS</info>, <info>DNS_PTR</info>, <info>DNS_SOA</info>, <info>DNS_TXT</info>, <info>DNS_AAAA</info>, <info>DNS_SRV</info>,
                                       <info>DNS_NAPTR</info>, <info>DNS_A6</info>, <info>DNS_ALL</info> または <info>DNS_ANY</info>。
                                       
                                       プラットフォーム依存の libresolv のおかしな挙動のせいで、
                                       <info>DNS_ANY</info> が常にすべてのレコードを返すとは 限りません。速度は遅
                                       くなりますが、<info>DNS_ALL</info> のほうがより確実にすべてのレコードを取
                                       得できます。
                                       
                                       Windows では、<info>DNS_CAA</info> はサポートされていませんし、 <info>DNS_A6</info> は
                                       実装されていません。
  <info>array</info>   <strong>$authoritative_name_servers</strong>  参照で渡し、 Authoritative Name Servers のリソースレコードが
                                       格納されます。
  <info>array</info>   <strong>$additional_records</strong>          参照で渡し、 Additional Records が格納されます。
  <info>bool</info>    <strong>$raw</strong>                         <strong>$type</strong> は生のDNSのタイプIDとして解釈されます。 (<return>DNS_*</return> 定数は使
                                       えません) 戻り値には手動でパースが必要な <return>data</return> キーが含まれま
                                       す。

<comment>Return:</comment>
  <info>array|false</info>  この関数は、連想配列を要素にもつ配列を返します。 失敗した場合に <info>false</info> を返します。 そ
               れぞれの連想配列には 少なくとも 以下のキーが含まれています: 基本 DNS 属性属性意味host
               これ以降の関連するデータが参照する DNS 名。 class<strong>dns_get_record()</strong> は Internet クラス
               のレコードのみを返すので、このパラメータは常に <return>IN</return> を返します。 type レコード型を表す
               文字列。type の値に応じて、 結果の配列には追加の属性が含まれます。以下の表を参照くだ
               さい。 ttl このレコードの<return>"有効期限 (Time To Live)"</return>。レコードの本来の ttl と一致すると
               は 限りません。むしろ、 ネームサーバーへのクエリにかかった時間をそこから引いたものに
               一致します。
               
               'type' に応じて連想配列に追加される項目レコード型追加項目<return>A</return><return>ip</return>: ドット区切り 10 進数形
               式の IPv4 アドレス。 <return>MX</return><return>pri</return>: メールエクスチェンジャの優先度。 数字が小さいほど優先度が
               高い。 <return>target</return>: メールエクスチェンジャの FQDN 。 <strong>dns_get_mx()</strong> も参照ください。
               <return>CNAME</return><return>target</return>: レコードのエイリアスの対象となっている場所の FQDN 。 <return>NS</return><return>target</return>: このホス
               ト名に対する権威をもっているネームサーバーの FQDN 。 <return>PTR</return><return>target</return>: レコードが指してい
               る、DNS 名前空間内の場所 <return>TXT</return><return>txt</return>: このレコードに関連付けられている任意の文字列。
               <return>HINFO</return><return>cpu</return>: このレコードが参照しているマシンの CPU を識別する IANA 番号。 <return>os</return>: このレ
               コードが参照しているマシン上の OS を識別する IANA 番号。 これらの値の意味については、
               IANA の  <return>Operating System Names</return> を参照ください。 <return>CAA</return><return>flags</return>: 1バイトのビットフィールド;
               現在はビット0だけが定義されており、'critical' を意味します。 他のビットは予約されてお
               り、無視されるべきです。 <return>tag</return>: CAA タグの名前 (alphanumeric な ASCII 文字列). <return>value</return>:
               CAA タグの値 (バイナリ文字列, サブフォーマットの使用可) 詳細は、RFC 6844 を参照くださ
               い。 <return>SOA</return><return>mname</return>: リソースレコードの元となるマシンの FQDN 。 <return>rname</return>: このドメインの管理責
               任者の Email アドレス。 <return>serial</return>: ドメインのシリアル番号。 <return>refresh</return>: セカンダリネーム
               サーバーがこのドメインのコピーを更新する際に参照するリフレッシュ間隔（秒単位）。
               <return>retry</return>: リフレッシュが失敗した際に 2 度目のリフレッシュを試みるまでの間隔（秒単位）
               <return>expire</return>: セカンダリネームサーバーが、ゾーンデータの リフレッシュに失敗した場合にコピー
               のデータを破棄せず持ち続ける期間 （秒単位）。 <return>minimum-ttl</return>: クライアントが、 一度取得
               したデータを再リクエストすることなしに利用できる最小期間（秒単位）。 個々のリソースレ
               コードによって上書きが可能。 <return>AAAA</return><return>ipv6</return>: IPv6 アドレス。 <return>A6</return><return>masklen</return>: <strong>$chain</strong> で指定された
               対象から引き継ぐビット長。 <return>ipv6</return>: <strong>$chain</strong> とマージするためのこのレコードのアドレス。
               <return>chain</return>: <strong>$ipv6</strong> データとマージするための親レコード。 <return>SRV</return><return>pri</return>: (Priority) 値が小さいものが
               優先されます。 <return>weight</return>: 同じ優先順位の <strong>$targets</strong> からランダムに選択する際の重み。
               <return>target</return> および <return>port</return>: リクエストされたサービスが存在するホスト名とポート。 詳細は RFC
               2782 を参照ください。 <return>NAPTR</return><return>order</return> および <return>pref</return>: 上の <strong>$pri</strong> および <strong>$weight</strong> と同じ。
               <return>flags</return>, <return>services</return>, <return>regex</return>, および <return>replacement</return>: RFC 2915 で定義されるパラメータ。

<comment>See Also:</comment>
   * <strong>dns_get_mx()</strong>
   * <strong>dns_check_record()</strong>


id: dom_import_simplexml
type: function
doc:
<comment>Description:</comment>
  SimpleXMLElement オブジェクトから DOMElement オブジェクトを取得する
    
  
  この関数は、SimpleXML クラスの ノード <strong>$node</strong> を受け取り、それを <class>DOMElement</class> ノードに変換します。新し
  いオブジェクトは、 <class>DOMElement</class> ノードとして使用可能です。

<comment>Param:</comment>
  <info>object</info>  <strong>$node</strong>  <class>SimpleXMLElement</class> ノード。

<comment>Return:</comment>
  <info>DOMElement</info>  追加された <class>DOMElement</class> ノードを返します。

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


id: dotnet
type: class
doc:
<comment>Description:</comment>
  dotnet クラスにより、 クラスやメソッドが COM に見えている場合、 .Net アセンブリからクラスを生成し
  て そのメソッドをコールしたりプロパティにアクセスしたりできるようになります。
  
  staticクラス をインスタンス化したり、staticメソッド を呼び出すことはサポートされていません。
  <return>System.Collections.Generic.List</return> のようなジェネリッククラスをインスタンス化することもサポートしてい
  ません。
  
  .Net クラスによっては、IDispatch を実装していないものがあります。 それらはインスタンス化はできるも
  のの、メソッドをコールしたり プロパティへアクセスすることをサポートしていません。
  
  この機能を利用するには、Webサーバーに .Netランタイムをインストールする必要があります。
  
  PHP 8.0.0 より前のバージョンでは、 <class>dotnet</class> クラスは.Net framework 4.0 以降をサポートしていませんで
  した。 アセンブリが regasm.exe によって登録されている場合は、 それらのクラスは <class>com</class> オブジェクトを
  通じてインスタンス化できます。 PHP 8.0.0 以降では、php.ini の com.dotnet_version を指定することで
  .Net framework 4.0 以降をサポートします。


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

<comment>Param:</comment>
  <info>string</info>  <strong>$assembly_name</strong>  ロードすべきアセンブリ名を指定します。
  <info>string</info>  <strong>$datatype_name</strong>  アセンブリ中のどのクラスをインスタンス化するかを指定します。
  <info>int</info>     <strong>$codepage</strong>       Unicode文字列の変換に使うコードページ。 詳細な情報は  クラスの同じ名前のパ
                          ラメータを参照ください。


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


id: each
type: function
doc:
<comment>Description:</comment>
  配列から現在のキーと値のペアを返して、カーソルを進める
  
  配列から現在のキーと値のペアを返して、カーソルを進めます。
  
  <strong>each()</strong> を実行した後、配列カーソルは、 配列の次の要素に移動します。配列の最終要素にカーソルがある場
  合は、 最終要素にとどまります。再度 each を使用して配列を走査するには、 <strong>reset()</strong> を使用する必要があ
  ります。

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

<comment>Return:</comment>
  <info>array</info>  配列 <strong>$array</strong> から現在のキーと値のペアを返します。 このペアは 4 つの要素を持つ配列で、 それぞ
         れの要素は <return>0</return>, <return>1</return>, <return>key</return>, <return>value</return> というキーを有しています。 要素 <return>0</return>と<return>key</return> の各々は配列要素のキー名
         称を保持しており、<return>1</return> と <return>value</return> の各々はそのデータを保持しています。
         
         配列の内部ポインタが配列の最終要素以降を指す場合、 <strong>each()</strong> は <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>key()</strong>
   * <strong>list()</strong>
   * <strong>current()</strong>
   * <strong>reset()</strong>
   * <strong>next()</strong>
   * <strong>prev()</strong>
   * foreach
   * オブジェクトのイタレーション


id: easter_date
type: function
doc:
<comment>Description:</comment>
  指定した年における復活祭の真夜中のUnix時を得る
  
  指定した年yearにおける復活祭の真夜中のUnix時を返します。
  
  復活祭の日付は、西暦325年の Nicaea 会議で春分の日の後の 最初の満月の後の日曜日として定められまし
  た。 満月とその次の日曜日の日付の計算を簡単にするために 春分の日は常に3月21日になるとして計算され
  ます。 ここで用いるアルゴリズムは、532年頃、Dionysius Exiguus により 導出されたものです。(1753年よ
  り前の年に関して)ユリウス暦の元では 月の周期を追うために簡単な19年周期が用いられます。グレゴリウス
  暦 (1753年以降。この暦は、ClaviusとLiliusにより考案され、 教皇グレゴリウス13世により1582年10月に導
  入、イギリス及びその植民地に 1752年9月に導入された。) のもとで、二つの補正係数が周期をより正確に作
  成するために追加されました。

<comment>Param:</comment>
  <info>int|null</info>  <strong>$year</strong>  年の値。32ビットのシステムでは、 1970 から 2037 までである必要があります。 64ビッ
                   トのシステムでは、 1970 から 2,000,000,000 までである必要があります。 省略した場
                   合、もしくは <info>null</info> の場合は、 デフォルトとしてローカルタイムにおける現在の年を使い
                   ます。
  <info>int</info>       <strong>$mode</strong>  <info>CAL_EASTER_ALWAYS_JULIAN</info> を設定すると、 ユリウス暦のカレンダをベースにして復活祭
                   の日付が計算できます。 calendar の定数 を参照ください。

<comment>Return:</comment>
  <info>int</info>  復活祭の日を Unix タイムスタンプで返します。

<comment>See Also:</comment>
   * 
     1970年以前または2037年以降の復活祭の計算に関しては、
     <strong>easter_days()</strong> を参照ください。
    


id: easter_days
type: function
doc:
<comment>Description:</comment>
  指定した年において、3 月 21 日から復活祭までの日数を得る
  
  指定した年 year において、3 月 21 日から復活祭までの日数を返します。 year が指定されない場合、現在
  の年が仮定されます。
  
  この関数は、Unix 時の範囲外(すなわち 1970 年以前または 2037 年以降)の復活祭を 計算するために
  <strong>easter_date()</strong> の代わりに使用することが できます。
  
  復活祭の日付は、西暦 325 年の Nicaea の会議で春分の日以降の 最初の満月の後の日曜日として定義されま
  した。 満月とその次の日曜日の日付の計算を簡単にするために 春分の日は常に 3 月 21 日になるとして計
  算されます。 ここで用いるアルゴリズムは、532 年頃に Dionysius Exiguus により 導出されたものです。
  (1753 年より前の年に関して)ユリウス暦のもとでは 月の周期を追うために簡単な 19 年周期が用いられま
  す。グレゴリオ暦 (1753 年以降。この暦は Clavius と Lilius により考案され、 教皇グレゴリウス 13 世
  により 1582 年 10 月に導入、イギリス及びその植民地に 1752 年 9 月に導入された) のもとで、二つの補
  正係数が周期をより正確に作成するために追加されました。

<comment>Param:</comment>
  <info>int|null</info>  <strong>$year</strong>  正の数値で表した年。省略した場合、もしくは <info>null</info> の場合は、 ローカルタイムにおける
                   現在の年を使います。
  <info>int</info>       <strong>$mode</strong>  <info>CAL_EASTER_ROMAN</info> に設定すると 1582 年から 1752 年までの復活祭の日付をグレゴリオ暦
                   にもとづいて 計算します。それ以外に使用可能な定数については カレンダー定数を参照
                   ください。

<comment>Return:</comment>
  <info>int</info>  指定した年 <strong>$year</strong> において、3 月 21 日から復活祭までの日数を返します。

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


id: echo
type: function
doc:
<comment>Description:</comment>
  1 つ以上の文字列を出力する
  
  ひとつ以上の(文字列として評価される)式を出力します。末尾に改行やスペースを付加することはありませ
  ん。
  
  <return>echo</return> は実際には関数ではなく、言語構造です。 <return>echo</return> キーワードの後に続く引数は、 コンマで区切られた
  (文字列として評価される)式のリストであり、括弧で括る必要はありません。 他の言語構造と異なり <return>echo</return>
  には戻り値がありません。そのため、 式のコンテクストでは使うことができません。
  
  <return>echo</return> には、開始タグの直後に等号を付ける短縮構文もあります。 この短縮構文は、設定オプション
  short_open_tag が無効な場合でも使えます。  foo.
  ]]>
  
  <return>print</return> との主な違いは、 <return>echo</return> がリスト形式の引数を受け付け、戻り値を持たないことです。

<comment>Param:</comment>
  <info>string</info>  <strong>$expressions</strong>  出力したいひとつ以上の文字列として評価される式。 コンマで区切ります。 文字列
                        として評価されない値を渡した場合、文字列に強制的に変換されます。 これは、
                        <return>strict_types</return> ディレクティブ が有効になっていても同じです。

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

<comment>See Also:</comment>
   * <strong>print()</strong>
   * <strong>printf()</strong>
   * <strong>flush()</strong>
   * 文字列リテラルを指定する方法


id: eio_busy
type: function
doc:
<comment>Description:</comment>
  人為的に負荷を高くする。テストやベンチマークなどで有用
  
  <strong>eio_busy()</strong> は人為的に負荷を高め、実行前に <strong>$delay</strong> 秒待ちます。デバッグやベンチマークに使えるでしょ
  う。

<comment>Param:</comment>
  <info>int</info>       <strong>$delay</strong>     待つ秒数。
  <info>int</info>       <strong>$pri</strong>       リクエストの優先順位。<info>EIO_PRI_DEFAULT</info>、<info>EIO_PRI_MIN</info>、<info>EIO_PRI_MAX</info> あるいは <info>null</info>
                       を指定します。
                       <info>null</info> を渡した場合、<strong>$pri</strong> は内部的に
                       <info>EIO_PRI_DEFAULT</info> となります。
  <info>callable</info>  <strong>$callback</strong>  すべてのグループリクエストが終わったときに呼ばれるコールバック。
  <info>mixed</info>     <strong>$data</strong>      <strong>$callback</strong> に渡す任意の引数。

<comment>Return:</comment>
  <info>resource</info>  <strong>eio_busy()</strong> は成功した場合にリクエストリソースを返します。 失敗した場合に <info>false</info> を返しま
            す

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


id: eio_cancel
type: function
doc:
<comment>Description:</comment>
  リクエストを取り消す
  
  <strong>eio_cancel()</strong> は、 <strong>$req</strong> で指定したリクエストを取り消します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$req</strong>       リクエストリソース。
  <info></info>          <strong>$pri</strong>       リクエストの優先順位。<info>EIO_PRI_DEFAULT</info>、<info>EIO_PRI_MIN</info>、<info>EIO_PRI_MAX</info> あるいは <info>null</info>
                       を指定します。
                       <info>null</info> を渡した場合、<strong>$pri</strong> は内部的に
                       <info>EIO_PRI_DEFAULT</info> となります。
  <info></info>          <strong>$callback</strong>  <strong>$callback</strong> 関数が、リクエスト終了時にコールされます。
                       この関数のプロトタイプは、
                       に一致しなければなりません。
                       <strong>$data</strong>は、リクエストに渡すカスタムデータです。<strong>$result</strong>にはリクエスト固有の結果
                       が格納されます。基本的には、対応するシステムコールが返すそのままの値となりま
                       す。<strong>$req</strong>はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
                       
                       は、リクエストに渡すカスタムデータです。
                       
                       にはリクエスト固有の結果が格納されます。基本的には、対応するシステムコールが
                       返すそのままの値となります。
                       
                       はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
  <info></info>          <strong>$data</strong>      は、リクエストに渡すカスタムデータです。
  <info></info>          <strong>$result</strong>    にはリクエスト固有の結果が格納されます。基本的には、対応するシステムコールが
                       返すそのままの値となります。
  <info>resource</info>  <strong>$req</strong>       はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
  <info></info>          <strong>$data</strong>      <strong>$callback</strong> に渡す任意の引数。

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

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


id: eio_chmod
type: function
doc:
<comment>Description:</comment>
  ファイルやディレクトリのパーミッションを変更する
  
  <strong>eio_chmod()</strong> は、ファイルやディレクトリのパーミッションを変更します。 新しいパーミッションを <strong>$mode</strong>
  で指定します。

<comment>Param:</comment>
  <info>string</info>    <strong>$path</strong>      対象となるファイルやディレクトリのパス。 相対パスを避けましょう
                       
                       
                       相対パスを避けましょう
  <info>int</info>       <strong>$mode</strong>      新しいパーミッション。<info>0644</info> など。
  <info>int</info>       <strong>$pri</strong>       リクエストの優先順位。<info>EIO_PRI_DEFAULT</info>、<info>EIO_PRI_MIN</info>、<info>EIO_PRI_MAX</info> あるいは <info>null</info>
                       を指定します。
                       <info>null</info> を渡した場合、<strong>$pri</strong> は内部的に
                       <info>EIO_PRI_DEFAULT</info> となります。
  <info>callable</info>  <strong>$callback</strong>  <strong>$callback</strong> 関数が、リクエスト終了時にコールされます。
                       この関数のプロトタイプは、
                       に一致しなければなりません。
                       <strong>$data</strong>は、リクエストに渡すカスタムデータです。<strong>$result</strong>にはリクエスト固有の結果
                       が格納されます。基本的には、対応するシステムコールが返すそのままの値となりま
                       す。<strong>$req</strong>はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
                       
                       は、リクエストに渡すカスタムデータです。
                       
                       にはリクエスト固有の結果が格納されます。基本的には、対応するシステムコールが
                       返すそのままの値となります。
                       
                       はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
  <info>mixed</info>     <strong>$data</strong>      は、リクエストに渡すカスタムデータです。
  <info></info>          <strong>$result</strong>    にはリクエスト固有の結果が格納されます。基本的には、対応するシステムコールが
                       返すそのままの値となります。
  <info></info>          <strong>$req</strong>       はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
  <info>mixed</info>     <strong>$data</strong>      <strong>$callback</strong> に渡す任意の引数。

<comment>Return:</comment>
  <info>resource</info>  <strong>eio_chmod()</strong> は、成功した場合にリクエストリソースを返します。失敗した場合に <info>false</info> を返し
            ます

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


id: eio_chown
type: function
doc:
<comment>Description:</comment>
  ファイルやディレクトリのオーナーを変更する
  
  ファイルやディレクトリのオーナーを変更します。

<comment>Param:</comment>
  <info>string</info>    <strong>$path</strong>      ファイルやディレクトリへのパス。 相対パスを避けましょう
                       
                       
                       相対パスを避けましょう
  <info>int</info>       <strong>$uid</strong>       ユーザー ID。-1 にすると無視されます。
  <info>int</info>       <strong>$gid</strong>       グループ ID。-1 にすると無視されます。
  <info>int</info>       <strong>$pri</strong>       リクエストの優先順位。<info>EIO_PRI_DEFAULT</info>、<info>EIO_PRI_MIN</info>、<info>EIO_PRI_MAX</info> あるいは <info>null</info>
                       を指定します。
                       <info>null</info> を渡した場合、<strong>$pri</strong> は内部的に
                       <info>EIO_PRI_DEFAULT</info> となります。
  <info>callable</info>  <strong>$callback</strong>  <strong>$callback</strong> 関数が、リクエスト終了時にコールされます。
                       この関数のプロトタイプは、
                       に一致しなければなりません。
                       <strong>$data</strong>は、リクエストに渡すカスタムデータです。<strong>$result</strong>にはリクエスト固有の結果
                       が格納されます。基本的には、対応するシステムコールが返すそのままの値となりま
                       す。<strong>$req</strong>はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
                       
                       は、リクエストに渡すカスタムデータです。
                       
                       にはリクエスト固有の結果が格納されます。基本的には、対応するシステムコールが
                       返すそのままの値となります。
                       
                       はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
  <info>mixed</info>     <strong>$data</strong>      は、リクエストに渡すカスタムデータです。
  <info></info>          <strong>$result</strong>    にはリクエスト固有の結果が格納されます。基本的には、対応するシステムコールが
                       返すそのままの値となります。
  <info></info>          <strong>$req</strong>       はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
  <info>mixed</info>     <strong>$data</strong>      <strong>$callback</strong> に渡す任意の引数。

<comment>Return:</comment>
  <info>resource</info>  <strong>eio_chown()</strong> は、成功した場合にリクエストリソースを返します。失敗した場合に <info>false</info> を返し
            ます

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


id: eio_close
type: function
doc:
<comment>Description:</comment>
  ファイルを閉じる
  
  <strong>eio_close()</strong> は、 <strong>$fd</strong> で指定したファイルを閉じます。

<comment>Param:</comment>
  <info>mixed</info>     <strong>$fd</strong>        ストリーム、ソケットリソース、あるいは数値で表したファイルディスクリプタ。
  <info>int</info>       <strong>$pri</strong>       リクエストの優先順位。<info>EIO_PRI_DEFAULT</info>、<info>EIO_PRI_MIN</info>、<info>EIO_PRI_MAX</info> あるいは <info>null</info>
                       を指定します。
                       <info>null</info> を渡した場合、<strong>$pri</strong> は内部的に
                       <info>EIO_PRI_DEFAULT</info> となります。
  <info>callable</info>  <strong>$callback</strong>  <strong>$callback</strong> 関数が、リクエスト終了時にコールされます。
                       この関数のプロトタイプは、
                       に一致しなければなりません。
                       <strong>$data</strong>は、リクエストに渡すカスタムデータです。<strong>$result</strong>にはリクエスト固有の結果
                       が格納されます。基本的には、対応するシステムコールが返すそのままの値となりま
                       す。<strong>$req</strong>はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
                       
                       は、リクエストに渡すカスタムデータです。
                       
                       にはリクエスト固有の結果が格納されます。基本的には、対応するシステムコールが
                       返すそのままの値となります。
                       
                       はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
  <info>mixed</info>     <strong>$data</strong>      は、リクエストに渡すカスタムデータです。
  <info></info>          <strong>$result</strong>    にはリクエスト固有の結果が格納されます。基本的には、対応するシステムコールが
                       返すそのままの値となります。
  <info></info>          <strong>$req</strong>       はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
  <info>mixed</info>     <strong>$data</strong>      <strong>$callback</strong> に渡す任意の引数。

<comment>Return:</comment>
  <info>resource</info>  <strong>eio_close()</strong> は、成功した場合にリクエストリソースを返します。失敗した場合に <info>false</info> を返し
            ます

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


id: eio_custom
type: function
doc:
<comment>Description:</comment>
  eio_* のようなカスタムリクエストを実行する
  
  <strong>eio_custom()</strong> は、 <strong>$execute</strong> で指定したカスタム関数を実行し、 その他の eio_* と同じように処理しま
  す。

<comment>Param:</comment>
  <info>callable</info>  <strong>$execute</strong>   次のプロトタイプに沿ったリクエスト関数を指定します。
                         <strong>$callback</strong> はイベント完了後のコールバックで、次のプロトタイプに従う必要があ
                       ります。
                        <strong>$data</strong> は、 <strong>$execute</strong> に <strong>$data</strong> 引数経由で渡すデータです。 <strong>$execute</strong> が返す
                       <strong>$result</strong> の値に手を加えません。
  <info>int</info>       <strong>$pri</strong>       リクエストの優先順位。<info>EIO_PRI_DEFAULT</info>、<info>EIO_PRI_MIN</info>、<info>EIO_PRI_MAX</info> あるいは <info>null</info>
                       を指定します。
                       <info>null</info> を渡した場合、<strong>$pri</strong> は内部的に
                       <info>EIO_PRI_DEFAULT</info> となります。
  <info>callable</info>  <strong>$callback</strong>  <strong>$callback</strong> 関数が、リクエスト終了時にコールされます。
                       この関数のプロトタイプは、
                       に一致しなければなりません。
                       <strong>$data</strong>は、リクエストに渡すカスタムデータです。<strong>$result</strong>にはリクエスト固有の結果
                       が格納されます。基本的には、対応するシステムコールが返すそのままの値となりま
                       す。<strong>$req</strong>はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
                       
                       は、リクエストに渡すカスタムデータです。
                       
                       にはリクエスト固有の結果が格納されます。基本的には、対応するシステムコールが
                       返すそのままの値となります。
                       
                       はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
  <info>mixed</info>     <strong>$data</strong>      は、リクエストに渡すカスタムデータです。
  <info></info>          <strong>$result</strong>    にはリクエスト固有の結果が格納されます。基本的には、対応するシステムコールが
                       返すそのままの値となります。
  <info></info>          <strong>$req</strong>       はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
  <info>mixed</info>     <strong>$data</strong>      <strong>$callback</strong> に渡す任意の引数。

<comment>Return:</comment>
  <info>resource</info>  <strong>eio_custom()</strong> は、成功した場合にリクエストリソースを返します。失敗した場合に <info>false</info> を返し
            ます


id: eio_dup2
type: function
doc:
<comment>Description:</comment>
  ファイルディスクリプタを複製する
  
  <strong>eio_dup2()</strong> は、ファイルディスクリプタを複製します。

<comment>Param:</comment>
  <info>mixed</info>     <strong>$fd</strong>        複製元のストリーム、ソケットリソース、あるいはファイルディスクリプタ。
  <info>mixed</info>     <strong>$fd2</strong>       複製先のストリーム、ソケットリソース、あるいはファイルディスクリプタ。
  <info>int</info>       <strong>$pri</strong>       リクエストの優先順位。<info>EIO_PRI_DEFAULT</info>、<info>EIO_PRI_MIN</info>、<info>EIO_PRI_MAX</info> あるいは <info>null</info>
                       を指定します。
                       <info>null</info> を渡した場合、<strong>$pri</strong> は内部的に
                       <info>EIO_PRI_DEFAULT</info> となります。
  <info>callable</info>  <strong>$callback</strong>  <strong>$callback</strong> 関数が、リクエスト終了時にコールされます。
                       この関数のプロトタイプは、
                       に一致しなければなりません。
                       <strong>$data</strong>は、リクエストに渡すカスタムデータです。<strong>$result</strong>にはリクエスト固有の結果
                       が格納されます。基本的には、対応するシステムコールが返すそのままの値となりま
                       す。<strong>$req</strong>はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
                       
                       は、リクエストに渡すカスタムデータです。
                       
                       にはリクエスト固有の結果が格納されます。基本的には、対応するシステムコールが
                       返すそのままの値となります。
                       
                       はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
  <info>mixed</info>     <strong>$data</strong>      は、リクエストに渡すカスタムデータです。
  <info></info>          <strong>$result</strong>    にはリクエスト固有の結果が格納されます。基本的には、対応するシステムコールが
                       返すそのままの値となります。
  <info></info>          <strong>$req</strong>       はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
  <info>mixed</info>     <strong>$data</strong>      <strong>$callback</strong> に渡す任意の引数。

<comment>Return:</comment>
  <info>resource</info>  <strong>eio_dup2()</strong> は、成功した場合にリクエストリソースを返します。失敗した場合に <info>false</info> を返しま
            す


id: eio_event_loop
type: function
doc:
<comment>Description:</comment>
  すべてのリクエストを処理し終えるまで libeio をポールする
  
  <strong>eio_event_loop()</strong> は、すべてのリクエストを処理し終えるまで libeio をポールします。

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

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


id: eio_fallocate
type: function
doc:
<comment>Description:</comment>
  呼び出し元が、ファイルに割り当てられたディスク空間を直接操作できるようにする
  
  <strong>eio_fallocate()</strong> 呼び出し元が、ファイルに割り当てられたディスク空間を直接操作できるようにします。
  ファイルの指定はファイルディスクリプタ <strong>$fd</strong> で行い、 バイト幅の指定は開始位置 <strong>$offset</strong> とそこからの
  長さ <strong>$length</strong> で行います。
  
  <info>EIO_O_CREAT</info> を <info>EIO_O_WRONLY</info> あるいは <info>EIO_O_RDWR</info> と論理 OR しなければいけません。

<comment>Param:</comment>
  <info>mixed</info>     <strong>$fd</strong>        ストリーム、ソケットリソース、あるいは数値で表したファイルディスクリプタ (た
                       とえば <strong>eio_open()</strong> が返すもの)。
  <info>int</info>       <strong>$mode</strong>      現在サポートするフラグは <info>EIO_FALLOC_FL_KEEP_SIZE</info> (POSIX の定数
                       <info>FALLOC_FL_KEEP_SIZE</info> と同じ意味) だけです。
  <info>int</info>       <strong>$offset</strong>    バイト幅の開始位置。
  <info>int</info>       <strong>$length</strong>    バイト幅の長さ。
  <info>int</info>       <strong>$pri</strong>       リクエストの優先順位。<info>EIO_PRI_DEFAULT</info>、<info>EIO_PRI_MIN</info>、<info>EIO_PRI_MAX</info> あるいは <info>null</info>
                       を指定します。
                       <info>null</info> を渡した場合、<strong>$pri</strong> は内部的に
                       <info>EIO_PRI_DEFAULT</info> となります。
  <info>callable</info>  <strong>$callback</strong>  <strong>$callback</strong> 関数が、リクエスト終了時にコールされます。
                       この関数のプロトタイプは、
                       に一致しなければなりません。
                       <strong>$data</strong>は、リクエストに渡すカスタムデータです。<strong>$result</strong>にはリクエスト固有の結果
                       が格納されます。基本的には、対応するシステムコールが返すそのままの値となりま
                       す。<strong>$req</strong>はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
                       
                       は、リクエストに渡すカスタムデータです。
                       
                       にはリクエスト固有の結果が格納されます。基本的には、対応するシステムコールが
                       返すそのままの値となります。
                       
                       はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
  <info>mixed</info>     <strong>$data</strong>      は、リクエストに渡すカスタムデータです。
  <info></info>          <strong>$result</strong>    にはリクエスト固有の結果が格納されます。基本的には、対応するシステムコールが
                       返すそのままの値となります。
  <info></info>          <strong>$req</strong>       はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
  <info>mixed</info>     <strong>$data</strong>      <strong>$callback</strong> に渡す任意の引数。

<comment>Return:</comment>
  <info>resource</info>  <strong>eio_fallocate()</strong> は、成功した場合にリクエストリソースを返します。失敗した場合に <info>false</info> を
            返します


id: eio_fchmod
type: function
doc:
<comment>Description:</comment>
  ファイルのパーミッションを変更する
  
  <strong>eio_fchmod()</strong> は、 ファイルディスクリプタ <strong>$fd</strong> で指定したファイルやディレクトリのパーミッションを変
  更します。

<comment>Param:</comment>
  <info>mixed</info>     <strong>$fd</strong>        ストリーム、ソケットリソース、あるいは数値で表したファイルディスクリプタ
                       (<strong>eio_open()</strong> が返すものなど)。
  <info>int</info>       <strong>$mode</strong>      新しいパーミッション。例: 0644
  <info>int</info>       <strong>$pri</strong>       リクエストの優先順位。<info>EIO_PRI_DEFAULT</info>、<info>EIO_PRI_MIN</info>、<info>EIO_PRI_MAX</info> あるいは <info>null</info>
                       を指定します。
                       <info>null</info> を渡した場合、<strong>$pri</strong> は内部的に
                       <info>EIO_PRI_DEFAULT</info> となります。
  <info>callable</info>  <strong>$callback</strong>  <strong>$callback</strong> 関数が、リクエスト終了時にコールされます。
                       この関数のプロトタイプは、
                       に一致しなければなりません。
                       <strong>$data</strong>は、リクエストに渡すカスタムデータです。<strong>$result</strong>にはリクエスト固有の結果
                       が格納されます。基本的には、対応するシステムコールが返すそのままの値となりま
                       す。<strong>$req</strong>はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
                       
                       は、リクエストに渡すカスタムデータです。
                       
                       にはリクエスト固有の結果が格納されます。基本的には、対応するシステムコールが
                       返すそのままの値となります。
                       
                       はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
  <info>mixed</info>     <strong>$data</strong>      は、リクエストに渡すカスタムデータです。
  <info></info>          <strong>$result</strong>    にはリクエスト固有の結果が格納されます。基本的には、対応するシステムコールが
                       返すそのままの値となります。
  <info></info>          <strong>$req</strong>       はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
  <info>mixed</info>     <strong>$data</strong>      <strong>$callback</strong> に渡す任意の引数。

<comment>Return:</comment>
  <info>resource</info>  <strong>eio_fchmod()</strong> は、成功した場合にリクエストリソースを返します。失敗した場合に <info>false</info> を返し
            ます

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


id: eio_fchown
type: function
doc:
<comment>Description:</comment>
  ファイルのオーナーを変更する
  
  <strong>eio_fchown()</strong> は、 ファイルディスクリプタ <strong>$fd</strong> で指定したファイルやディレクトリのオーナーを変更しま
  す。

<comment>Param:</comment>
  <info>mixed</info>     <strong>$fd</strong>        ストリーム、ソケットリソース、あるいは数値で表したファイルディスクリプタ。
  <info>int</info>       <strong>$uid</strong>       ユーザー ID。-1 にすると無視されます。
  <info>int</info>       <strong>$gid</strong>       グループ ID。-1 にすると無視されます。
  <info>int</info>       <strong>$pri</strong>       リクエストの優先順位。<info>EIO_PRI_DEFAULT</info>、<info>EIO_PRI_MIN</info>、<info>EIO_PRI_MAX</info> あるいは <info>null</info>
                       を指定します。
                       <info>null</info> を渡した場合、<strong>$pri</strong> は内部的に
                       <info>EIO_PRI_DEFAULT</info> となります。
  <info>callable</info>  <strong>$callback</strong>  <strong>$callback</strong> 関数が、リクエスト終了時にコールされます。
                       この関数のプロトタイプは、
                       に一致しなければなりません。
                       <strong>$data</strong>は、リクエストに渡すカスタムデータです。<strong>$result</strong>にはリクエスト固有の結果
                       が格納されます。基本的には、対応するシステムコールが返すそのままの値となりま
                       す。<strong>$req</strong>はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
                       
                       は、リクエストに渡すカスタムデータです。
                       
                       にはリクエスト固有の結果が格納されます。基本的には、対応するシステムコールが
                       返すそのままの値となります。
                       
                       はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
  <info>mixed</info>     <strong>$data</strong>      は、リクエストに渡すカスタムデータです。
  <info></info>          <strong>$result</strong>    にはリクエスト固有の結果が格納されます。基本的には、対応するシステムコールが
                       返すそのままの値となります。
  <info></info>          <strong>$req</strong>       はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
  <info>mixed</info>     <strong>$data</strong>      <strong>$callback</strong> に渡す任意の引数。

<comment>Return:</comment>
  <info>resource</info>  <strong>eio_chmod()</strong> は、成功時にリクエストリソースを返します。 失敗した場合に <info>false</info> を返します

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


id: eio_fdatasync
type: function
doc:
<comment>Description:</comment>
  ファイルのコア内の情報をストレージデバイスに同期させる
  
  <strong>eio_fdatasync()</strong> は、ファイルのコア内の情報をストレージデバイスに同期させます。

<comment>Param:</comment>
  <info>mixed</info>     <strong>$fd</strong>        ストリーム、ソケットリソース、あるいは数値で表したファイルディスクリプタ
                       (<strong>eio_open()</strong> が返すものなど)。
  <info>int</info>       <strong>$pri</strong>       リクエストの優先順位。<info>EIO_PRI_DEFAULT</info>、<info>EIO_PRI_MIN</info>、<info>EIO_PRI_MAX</info> あるいは <info>null</info>
                       を指定します。
                       <info>null</info> を渡した場合、<strong>$pri</strong> は内部的に
                       <info>EIO_PRI_DEFAULT</info> となります。
  <info>callable</info>  <strong>$callback</strong>  <strong>$callback</strong> 関数が、リクエスト終了時にコールされます。
                       この関数のプロトタイプは、
                       に一致しなければなりません。
                       <strong>$data</strong>は、リクエストに渡すカスタムデータです。<strong>$result</strong>にはリクエスト固有の結果
                       が格納されます。基本的には、対応するシステムコールが返すそのままの値となりま
                       す。<strong>$req</strong>はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
                       
                       は、リクエストに渡すカスタムデータです。
                       
                       にはリクエスト固有の結果が格納されます。基本的には、対応するシステムコールが
                       返すそのままの値となります。
                       
                       はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
  <info>mixed</info>     <strong>$data</strong>      は、リクエストに渡すカスタムデータです。
  <info></info>          <strong>$result</strong>    にはリクエスト固有の結果が格納されます。基本的には、対応するシステムコールが
                       返すそのままの値となります。
  <info></info>          <strong>$req</strong>       はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
  <info>mixed</info>     <strong>$data</strong>      <strong>$callback</strong> に渡す任意の引数。

<comment>Return:</comment>
  <info>resource</info>  <strong>eio_fdatasync()</strong> は、成功した場合にリクエストリソースを返します。失敗した場合に <info>false</info> を
            返します


id: eio_fstat
type: function
doc:
<comment>Description:</comment>
  ファイルの状態を取得する
  
  <strong>eio_fstat()</strong> は、 <strong>$callback</strong> の <strong>$result</strong> 引数でファイルの状態を返します。

<comment>Param:</comment>
  <info>mixed</info>     <strong>$fd</strong>        ストリーム、ソケットリソース、あるいは数値で表したファイルディスクリプタ。
  <info>int</info>       <strong>$pri</strong>       リクエストの優先順位。<info>EIO_PRI_DEFAULT</info>、<info>EIO_PRI_MIN</info>、<info>EIO_PRI_MAX</info> あるいは <info>null</info>
                       を指定します。
                       <info>null</info> を渡した場合、<strong>$pri</strong> は内部的に
                       <info>EIO_PRI_DEFAULT</info> となります。
  <info>callable</info>  <strong>$callback</strong>  <strong>$callback</strong> 関数が、リクエスト終了時にコールされます。
                       この関数のプロトタイプは、
                       に一致しなければなりません。
                       <strong>$data</strong>は、リクエストに渡すカスタムデータです。<strong>$result</strong>にはリクエスト固有の結果
                       が格納されます。基本的には、対応するシステムコールが返すそのままの値となりま
                       す。<strong>$req</strong>はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
                       
                       は、リクエストに渡すカスタムデータです。
                       
                       にはリクエスト固有の結果が格納されます。基本的には、対応するシステムコールが
                       返すそのままの値となります。
                       
                       はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
  <info>mixed</info>     <strong>$data</strong>      は、リクエストに渡すカスタムデータです。
  <info></info>          <strong>$result</strong>    にはリクエスト固有の結果が格納されます。基本的には、対応するシステムコールが
                       返すそのままの値となります。
  <info></info>          <strong>$req</strong>       はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
  <info>mixed</info>     <strong>$data</strong>      <strong>$callback</strong> に渡す任意の引数。

<comment>Return:</comment>
  <info>resource</info>  <strong>eio_busy()</strong> は、成功した場合にリクエストリソースを返します。失敗した場合に <info>false</info> を返しま
            す

<comment>See Also:</comment>
   * <strong>eio_lstat()</strong>
   * <strong>eio_stat()</strong>


id: eio_fstatvfs
type: function
doc:
<comment>Description:</comment>
  ファイルシステムの状態を取得する
  
  <strong>eio_fstatvfs()</strong> は、ファイルシステムの状態を <strong>$callback</strong> の <strong>$result</strong> で返します。

<comment>Param:</comment>
  <info>mixed</info>     <strong>$fd</strong>        マウントされたファイルシステム内のファイルのディスクリプタ。
  <info>int</info>       <strong>$pri</strong>       リクエストの優先順位。<info>EIO_PRI_DEFAULT</info>、<info>EIO_PRI_MIN</info>、<info>EIO_PRI_MAX</info> あるいは <info>null</info>
                       を指定します。
                       <info>null</info> を渡した場合、<strong>$pri</strong> は内部的に
                       <info>EIO_PRI_DEFAULT</info> となります。
  <info>callable</info>  <strong>$callback</strong>  <strong>$callback</strong> 関数が、リクエスト終了時にコールされます。
                       この関数のプロトタイプは、
                       に一致しなければなりません。
                       <strong>$data</strong>は、リクエストに渡すカスタムデータです。<strong>$result</strong>にはリクエスト固有の結果
                       が格納されます。基本的には、対応するシステムコールが返すそのままの値となりま
                       す。<strong>$req</strong>はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
                       
                       は、リクエストに渡すカスタムデータです。
                       
                       にはリクエスト固有の結果が格納されます。基本的には、対応するシステムコールが
                       返すそのままの値となります。
                       
                       はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
  <info>mixed</info>     <strong>$data</strong>      は、リクエストに渡すカスタムデータです。
  <info></info>          <strong>$result</strong>    にはリクエスト固有の結果が格納されます。基本的には、対応するシステムコールが
                       返すそのままの値となります。
  <info></info>          <strong>$req</strong>       はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
  <info>mixed</info>     <strong>$data</strong>      <strong>$callback</strong> に渡す任意の引数。

<comment>Return:</comment>
  <info>resource</info>  <strong>eio_fstatvfs()</strong> は、成功した場合にリクエストリソースを返します。失敗した場合に <info>false</info> を返
            します

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


id: eio_fsync
type: function
doc:
<comment>Description:</comment>
  メモリ内でのファイルの状態をストレージデバイスに同期させる
  
  メモリ内でのファイルの状態をストレージデバイスに同期させます。

<comment>Param:</comment>
  <info>mixed</info>     <strong>$fd</strong>        ストリーム、ソケットリソース、あるいは数値で表したファイルディスクリプタ。
  <info>int</info>       <strong>$pri</strong>       リクエストの優先順位。<info>EIO_PRI_DEFAULT</info>、<info>EIO_PRI_MIN</info>、<info>EIO_PRI_MAX</info> あるいは <info>null</info>
                       を指定します。
                       <info>null</info> を渡した場合、<strong>$pri</strong> は内部的に
                       <info>EIO_PRI_DEFAULT</info> となります。
  <info>callable</info>  <strong>$callback</strong>  <strong>$callback</strong> 関数が、リクエスト終了時にコールされます。
                       この関数のプロトタイプは、
                       に一致しなければなりません。
                       <strong>$data</strong>は、リクエストに渡すカスタムデータです。<strong>$result</strong>にはリクエスト固有の結果
                       が格納されます。基本的には、対応するシステムコールが返すそのままの値となりま
                       す。<strong>$req</strong>はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
                       
                       は、リクエストに渡すカスタムデータです。
                       
                       にはリクエスト固有の結果が格納されます。基本的には、対応するシステムコールが
                       返すそのままの値となります。
                       
                       はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
  <info>mixed</info>     <strong>$data</strong>      は、リクエストに渡すカスタムデータです。
  <info></info>          <strong>$result</strong>    にはリクエスト固有の結果が格納されます。基本的には、対応するシステムコールが
                       返すそのままの値となります。
  <info></info>          <strong>$req</strong>       はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
  <info>mixed</info>     <strong>$data</strong>      <strong>$callback</strong> に渡す任意の引数。

<comment>Return:</comment>
  <info>resource</info>  <strong>eio_fsync()</strong> は、成功した場合にリクエストリソースを返します。失敗した場合に <info>false</info> を返し
            ます

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


id: eio_ftruncate
type: function
doc:
<comment>Description:</comment>
  ファイルを切り詰める
  
  <strong>eio_ftruncate()</strong> は、ファイルディスクリプタ <strong>$fd</strong> で指定したファイルを切り詰めて、ちょうど <strong>$length</strong> バ
  イトにします。

<comment>Param:</comment>
  <info>mixed</info>     <strong>$fd</strong>        ストリーム、ソケットリソース、あるいは数値で表したファイルディスクリプタ。
  <info>int</info>       <strong>$offset</strong>    ファイルの先頭からのオフセット。
  <info>int</info>       <strong>$pri</strong>       リクエストの優先順位。<info>EIO_PRI_DEFAULT</info>、<info>EIO_PRI_MIN</info>、<info>EIO_PRI_MAX</info> あるいは <info>null</info>
                       を指定します。
                       <info>null</info> を渡した場合、<strong>$pri</strong> は内部的に
                       <info>EIO_PRI_DEFAULT</info> となります。
  <info>callable</info>  <strong>$callback</strong>  <strong>$callback</strong> 関数が、リクエスト終了時にコールされます。
                       この関数のプロトタイプは、
                       に一致しなければなりません。
                       <strong>$data</strong>は、リクエストに渡すカスタムデータです。<strong>$result</strong>にはリクエスト固有の結果
                       が格納されます。基本的には、対応するシステムコールが返すそのままの値となりま
                       す。<strong>$req</strong>はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
                       
                       は、リクエストに渡すカスタムデータです。
                       
                       にはリクエスト固有の結果が格納されます。基本的には、対応するシステムコールが
                       返すそのままの値となります。
                       
                       はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
  <info>mixed</info>     <strong>$data</strong>      は、リクエストに渡すカスタムデータです。
  <info></info>          <strong>$result</strong>    にはリクエスト固有の結果が格納されます。基本的には、対応するシステムコールが
                       返すそのままの値となります。
  <info></info>          <strong>$req</strong>       はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
  <info>mixed</info>     <strong>$data</strong>      <strong>$callback</strong> に渡す任意の引数。

<comment>Return:</comment>
  <info>resource</info>  <strong>eio_ftruncate()</strong> は、成功した場合にリクエストリソースを返します。失敗した場合に <info>false</info> を
            返します

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


id: eio_futime
type: function
doc:
<comment>Description:</comment>
  ファイルの最終アクセス時刻と変更時刻を変更する
  
  <strong>eio_futime()</strong> は、ファイルの最終アクセス時刻と変更時刻を変更します。

<comment>Param:</comment>
  <info>mixed</info>     <strong>$fd</strong>        ストリーム、ソケットリソース、あるいは数値で表したファイルディスクリプタ
                       (<strong>eio_open()</strong> が返すものなど)。
  <info>float</info>     <strong>$atime</strong>     アクセス時刻。
  <info>float</info>     <strong>$mtime</strong>     変更時刻。
  <info>int</info>       <strong>$pri</strong>       リクエストの優先順位。<info>EIO_PRI_DEFAULT</info>、<info>EIO_PRI_MIN</info>、<info>EIO_PRI_MAX</info> あるいは <info>null</info>
                       を指定します。
                       <info>null</info> を渡した場合、<strong>$pri</strong> は内部的に
                       <info>EIO_PRI_DEFAULT</info> となります。
  <info>callable</info>  <strong>$callback</strong>  <strong>$callback</strong> 関数が、リクエスト終了時にコールされます。
                       この関数のプロトタイプは、
                       に一致しなければなりません。
                       <strong>$data</strong>は、リクエストに渡すカスタムデータです。<strong>$result</strong>にはリクエスト固有の結果
                       が格納されます。基本的には、対応するシステムコールが返すそのままの値となりま
                       す。<strong>$req</strong>はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
                       
                       は、リクエストに渡すカスタムデータです。
                       
                       にはリクエスト固有の結果が格納されます。基本的には、対応するシステムコールが
                       返すそのままの値となります。
                       
                       はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
  <info>mixed</info>     <strong>$data</strong>      は、リクエストに渡すカスタムデータです。
  <info></info>          <strong>$result</strong>    にはリクエスト固有の結果が格納されます。基本的には、対応するシステムコールが
                       返すそのままの値となります。
  <info></info>          <strong>$req</strong>       はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
  <info>mixed</info>     <strong>$data</strong>      <strong>$callback</strong> に渡す任意の引数。

<comment>Return:</comment>
  <info>resource</info>  <strong>eio_futime()</strong> は、成功した場合にリクエストリソースを返します。失敗した場合に <info>false</info> を返し
            ます

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


id: eio_get_event_stream
type: function
doc:
<comment>Description:</comment>
  内部での libeio との通信に使う変数を表すストリームを取得する
  
  <strong>eio_get_event_stream()</strong> は、内部での libeio との通信に使う変数を表すストリームを取得します。 他の
  PECL 拡張モジュール、たとえば libevent にバインドさせたりして使うことができます。

<comment>Return:</comment>
  <info>mixed</info>  <strong>eio_get_event_stream()</strong> は、成功した場合にストリームを返します。それ以外の場合に <info>null</info> を返し
         ます。


id: eio_get_last_error
type: function
doc:
<comment>Description:</comment>
  リクエストリソースに関連づけられた直近のエラーの説明を文字列で返す
  
  <strong>eio_get_last_error()</strong> は、 <strong>$req</strong> に関連づけられた直近のエラーの説明を文字列で返します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$req</strong>  リクエストリソース。

<comment>Return:</comment>
  <info>string</info>  <strong>eio_get_last_error()</strong> は、<strong>$req</strong> に関連づけられた直近のエラーの説明を文字列で返します。
          
          この関数は、
          実験的 なものです。この関数の動作・
          名前・その他ドキュメントに書かれている事項は、予告なく、将来的な PHP
          のリリースにおいて変更される可能性があります。
          この関数は自己責任で使用してください。


id: eio_grp
type: function
doc:
<comment>Description:</comment>
  リクエストグループを作る
  
  <strong>eio_grp()</strong> は、リクエストグループを作ります。

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  <strong>$callback</strong> 関数が、リクエスト終了時にコールされます。
                       この関数のプロトタイプは、
                       に一致しなければなりません。
                       <strong>$data</strong>は、リクエストに渡すカスタムデータです。<strong>$result</strong>にはリクエスト固有の結果
                       が格納されます。基本的には、対応するシステムコールが返すそのままの値となりま
                       す。<strong>$req</strong>はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
                       
                       は、リクエストに渡すカスタムデータです。
                       
                       にはリクエスト固有の結果が格納されます。基本的には、対応するシステムコールが
                       返すそのままの値となります。
                       
                       はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
  <info>string</info>    <strong>$data</strong>      は、リクエストに渡すカスタムデータです。
  <info></info>          <strong>$result</strong>    にはリクエスト固有の結果が格納されます。基本的には、対応するシステムコールが
                       返すそのままの値となります。
  <info></info>          <strong>$req</strong>       はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
  <info>string</info>    <strong>$data</strong>      <strong>$callback</strong> に渡す任意の引数。

<comment>Return:</comment>
  <info>resource</info>  <strong>eio_grp()</strong> は、成功した場合にリクエストグループリソースを返します。失敗した場合に <info>false</info>
            を返します

<comment>See Also:</comment>
   * <strong>eio_grp_cancel()</strong>
   * <strong>eio_grp_add()</strong>


id: eio_grp_add
type: function
doc:
<comment>Description:</comment>
  リクエストをリクエストグループに追加する
  
  <strong>eio_grp_add()</strong> は、リクエストをリクエストグループに追加します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$grp</strong>  <strong>eio_grp()</strong> が返すリクエストグループリソース。
  <info>resource</info>  <strong>$req</strong>  リクエストリソース。

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

<comment>See Also:</comment>
   * <strong>eio_grp()</strong>
   * <strong>eio_grp_cancel()</strong>
   * <strong>eio_grp_limit()</strong>


id: eio_grp_cancel
type: function
doc:
<comment>Description:</comment>
  リクエストグループをキャンセルする
  
  <strong>eio_grp_cancel()</strong> は、 <strong>$grp</strong> で指定したグループリクエストをキャンセルします。

<comment>Param:</comment>
  <info>resource</info>  <strong>$grp</strong>  <strong>eio_grp()</strong> が返すリクエストグループリソース。

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

<comment>See Also:</comment>
   * <strong>eio_grp()</strong>
   * <strong>eio_grp_add()</strong>


id: eio_grp_limit
type: function
doc:
<comment>Description:</comment>
  グループリミットを設定する
  
  リクエストグループ内のリクエスト数を制限します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$grp</strong>    リクエストグループリソース。
  <info>int</info>       <strong>$limit</strong>  グループ内のリクエスト数。

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

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


id: eio_init
type: function
doc:
<comment>Description:</comment>
  Eio を初期化する
  
  <strong>eio_init()</strong> は、Eio を初期化します。 libeio と Eio 自身が使う内部構造用にメモリを確保します。 Eio
  関数を使う前に <strong>eio_init()</strong> をコールしましょう。 もしコールしなくても、Eio 関数を最初にコールすると
  きに、 内部で自動的にコールされます。
  
  この関数は、PHP 8 以降に対応した eio 拡張モジュール 3.0.0RC1 で削除されました。

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


id: eio_link
type: function
doc:
<comment>Description:</comment>
  ファイルのハードリンクを作る
  
  <strong>eio_link()</strong> は、<strong>$path</strong> へのハードリンク <strong>$new_path</strong> を作ります。

<comment>Param:</comment>
  <info>string</info>    <strong>$path</strong>      リンク元のパス。
  <info>string</info>    <strong>$new_path</strong>  リンク先のパス。
  <info>int</info>       <strong>$pri</strong>       リクエストの優先順位。<info>EIO_PRI_DEFAULT</info>、<info>EIO_PRI_MIN</info>、<info>EIO_PRI_MAX</info> あるいは <info>null</info>
                       を指定します。
                       <info>null</info> を渡した場合、<strong>$pri</strong> は内部的に
                       <info>EIO_PRI_DEFAULT</info> となります。
  <info>callable</info>  <strong>$callback</strong>  <strong>$callback</strong> 関数が、リクエスト終了時にコールされます。
                       この関数のプロトタイプは、
                       に一致しなければなりません。
                       <strong>$data</strong>は、リクエストに渡すカスタムデータです。<strong>$result</strong>にはリクエスト固有の結果
                       が格納されます。基本的には、対応するシステムコールが返すそのままの値となりま
                       す。<strong>$req</strong>はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
                       
                       は、リクエストに渡すカスタムデータです。
                       
                       にはリクエスト固有の結果が格納されます。基本的には、対応するシステムコールが
                       返すそのままの値となります。
                       
                       はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
  <info>mixed</info>     <strong>$data</strong>      は、リクエストに渡すカスタムデータです。
  <info></info>          <strong>$result</strong>    にはリクエスト固有の結果が格納されます。基本的には、対応するシステムコールが
                       返すそのままの値となります。
  <info></info>          <strong>$req</strong>       はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
  <info>mixed</info>     <strong>$data</strong>      <strong>$callback</strong> に渡す任意の引数。

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

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


id: eio_lstat
type: function
doc:
<comment>Description:</comment>
  ファイルの状態を取得する
  
  <strong>eio_lstat()</strong> は、 <strong>$callback</strong> の <strong>$result</strong> 引数でファイルの状態を返します。

<comment>Param:</comment>
  <info>string</info>    <strong>$path</strong>      ファイルへのパス。
  <info>int</info>       <strong>$pri</strong>       リクエストの優先順位。<info>EIO_PRI_DEFAULT</info>、<info>EIO_PRI_MIN</info>、<info>EIO_PRI_MAX</info> あるいは <info>null</info>
                       を指定します。
                       <info>null</info> を渡した場合、<strong>$pri</strong> は内部的に
                       <info>EIO_PRI_DEFAULT</info> となります。
  <info>callable</info>  <strong>$callback</strong>  <strong>$callback</strong> 関数が、リクエスト終了時にコールされます。
                       この関数のプロトタイプは、
                       に一致しなければなりません。
                       <strong>$data</strong>は、リクエストに渡すカスタムデータです。<strong>$result</strong>にはリクエスト固有の結果
                       が格納されます。基本的には、対応するシステムコールが返すそのままの値となりま
                       す。<strong>$req</strong>はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
                       
                       は、リクエストに渡すカスタムデータです。
                       
                       にはリクエスト固有の結果が格納されます。基本的には、対応するシステムコールが
                       返すそのままの値となります。
                       
                       はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
  <info>mixed</info>     <strong>$data</strong>      は、リクエストに渡すカスタムデータです。
  <info></info>          <strong>$result</strong>    にはリクエスト固有の結果が格納されます。基本的には、対応するシステムコールが
                       返すそのままの値となります。
  <info></info>          <strong>$req</strong>       はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
  <info>mixed</info>     <strong>$data</strong>      <strong>$callback</strong> に渡す任意の引数。

<comment>Return:</comment>
  <info>resource</info>  <strong>eio_lstat()</strong> は、成功した場合にリクエストリソースを返します。失敗した場合に <info>false</info> を返し
            ます

<comment>See Also:</comment>
   * <strong>eio_stat()</strong>
   * <strong>eio_fstat()</strong>


id: eio_mkdir
type: function
doc:
<comment>Description:</comment>
  ディレクトリを作る
  
  <strong>eio_mkdir()</strong> は、 <strong>$mode</strong> で指定したアクセスモードでディレクトリを作ります。

<comment>Param:</comment>
  <info>string</info>    <strong>$path</strong>      新しいディレクトリへのパス。
  <info>int</info>       <strong>$mode</strong>      アクセスモード。例: 0755
  <info>int</info>       <strong>$pri</strong>       リクエストの優先順位。<info>EIO_PRI_DEFAULT</info>、<info>EIO_PRI_MIN</info>、<info>EIO_PRI_MAX</info> あるいは <info>null</info>
                       を指定します。
                       <info>null</info> を渡した場合、<strong>$pri</strong> は内部的に
                       <info>EIO_PRI_DEFAULT</info> となります。
  <info>callable</info>  <strong>$callback</strong>  <strong>$callback</strong> 関数が、リクエスト終了時にコールされます。
                       この関数のプロトタイプは、
                       に一致しなければなりません。
                       <strong>$data</strong>は、リクエストに渡すカスタムデータです。<strong>$result</strong>にはリクエスト固有の結果
                       が格納されます。基本的には、対応するシステムコールが返すそのままの値となりま
                       す。<strong>$req</strong>はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
                       
                       は、リクエストに渡すカスタムデータです。
                       
                       にはリクエスト固有の結果が格納されます。基本的には、対応するシステムコールが
                       返すそのままの値となります。
                       
                       はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
  <info>mixed</info>     <strong>$data</strong>      は、リクエストに渡すカスタムデータです。
  <info></info>          <strong>$result</strong>    にはリクエスト固有の結果が格納されます。基本的には、対応するシステムコールが
                       返すそのままの値となります。
  <info></info>          <strong>$req</strong>       はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
  <info>mixed</info>     <strong>$data</strong>      <strong>$callback</strong> に渡す任意の引数。

<comment>Return:</comment>
  <info>resource</info>  <strong>eio_mkdir()</strong> は、成功した場合にリクエストリソースを返します。失敗した場合に <info>false</info> を返し
            ます

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


id: eio_mknod
type: function
doc:
<comment>Description:</comment>
  特殊ファイルあるいは一般ファイルを作る
  
  <strong>eio_mknod()</strong> は、一般ファイルや特殊ファイル (こちらのほうが頻繁にあります) を作ります。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>string</info>    <strong>$path</strong>      新しいノード (ファイル) へのパス。
  <info>int</info>       <strong>$mode</strong>      利用するパーミッションと作成するノードの型を指定します。 以下のファイルタイプ
                       定数のひとつと、新しいノードのパーミッション (0640 など) をビット OR で組み合
                       わせたものとなります。
                        ファイルタイプ定数: <info>EIO_S_IFREG</info>(通常ファイル)、 <info>EIO_S_IFCHR</info>(キャラクタファイ
                       ル)、 <info>EIO_S_IFBLK</info>(ブロック特殊ファイル)、 <info>EIO_S_IFIFO</info>(FIFO - 名前付きパイプ)
                       および <info>EIO_S_IFSOCK</info>(UNIX ドメインソケット)。
                        パーミッションの指定には EIO_S_I* 定数も使えます。
  <info>int</info>       <strong>$dev</strong>       ファイルタイプが <info>EIO_S_IFCHR</info> あるいは <info>EIO_S_IFBLK</info> の場合に、 新しく作るデバイ
                       スファイルのメジャー番号とマイナー番号を指定します。 それ以外の場合は無視され
                       ます。詳細は mknod(2) の man ページを参照ください。
  <info>int</info>       <strong>$pri</strong>       リクエストの優先順位。<info>EIO_PRI_DEFAULT</info>、<info>EIO_PRI_MIN</info>、<info>EIO_PRI_MAX</info> あるいは <info>null</info>
                       を指定します。
                       <info>null</info> を渡した場合、<strong>$pri</strong> は内部的に
                       <info>EIO_PRI_DEFAULT</info> となります。
  <info>callable</info>  <strong>$callback</strong>  <strong>$callback</strong> 関数が、リクエスト終了時にコールされます。
                       この関数のプロトタイプは、
                       に一致しなければなりません。
                       <strong>$data</strong>は、リクエストに渡すカスタムデータです。<strong>$result</strong>にはリクエスト固有の結果
                       が格納されます。基本的には、対応するシステムコールが返すそのままの値となりま
                       す。<strong>$req</strong>はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
                       
                       は、リクエストに渡すカスタムデータです。
                       
                       にはリクエスト固有の結果が格納されます。基本的には、対応するシステムコールが
                       返すそのままの値となります。
                       
                       はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
  <info>mixed</info>     <strong>$data</strong>      は、リクエストに渡すカスタムデータです。
  <info></info>          <strong>$result</strong>    にはリクエスト固有の結果が格納されます。基本的には、対応するシステムコールが
                       返すそのままの値となります。
  <info></info>          <strong>$req</strong>       はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
  <info>mixed</info>     <strong>$data</strong>      <strong>$callback</strong> に渡す任意の引数。

<comment>Return:</comment>
  <info>resource</info>  <strong>eio_mknod()</strong> は、成功した場合にリクエストリソースを返します。失敗した場合に <info>false</info> を返し
            ます

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


id: eio_nop
type: function
doc:
<comment>Description:</comment>
  何もせず、ただリクエストのサイクルを回す
  
  <strong>eio_nop()</strong> は、何もせずただリクエストのサイクルを回します。 デバッグ時に有用です。

<comment>Param:</comment>
  <info>int</info>       <strong>$pri</strong>       リクエストの優先順位。<info>EIO_PRI_DEFAULT</info>、<info>EIO_PRI_MIN</info>、<info>EIO_PRI_MAX</info> あるいは <info>null</info>
                       を指定します。
                       <info>null</info> を渡した場合、<strong>$pri</strong> は内部的に
                       <info>EIO_PRI_DEFAULT</info> となります。
  <info>callable</info>  <strong>$callback</strong>  <strong>$callback</strong> 関数が、リクエスト終了時にコールされます。
                       この関数のプロトタイプは、
                       に一致しなければなりません。
                       <strong>$data</strong>は、リクエストに渡すカスタムデータです。<strong>$result</strong>にはリクエスト固有の結果
                       が格納されます。基本的には、対応するシステムコールが返すそのままの値となりま
                       す。<strong>$req</strong>はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
                       
                       は、リクエストに渡すカスタムデータです。
                       
                       にはリクエスト固有の結果が格納されます。基本的には、対応するシステムコールが
                       返すそのままの値となります。
                       
                       はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
  <info>mixed</info>     <strong>$data</strong>      は、リクエストに渡すカスタムデータです。
  <info></info>          <strong>$result</strong>    にはリクエスト固有の結果が格納されます。基本的には、対応するシステムコールが
                       返すそのままの値となります。
  <info></info>          <strong>$req</strong>       はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
  <info>mixed</info>     <strong>$data</strong>      <strong>$callback</strong> に渡す任意の引数。

<comment>Return:</comment>
  <info>resource</info>  <strong>eio_nop()</strong> は、成功した場合にリクエストリソースを返します。失敗した場合に <info>false</info> を返しま
            す

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


id: eio_npending
type: function
doc:
<comment>Description:</comment>
  終了したけれども処理されなかったリクエストの数を返す
  
  <strong>eio_npending()</strong> は、終了したけれども処理されなかったリクエストの数を返します。

<comment>Return:</comment>
  <info>int</info>  <strong>eio_npending()</strong> は、終了したけれども処理されなかったリクエストの数を返します。

<comment>See Also:</comment>
   * <strong>eio_nreqs()</strong>
   * <strong>eio_nready()</strong>
   * <strong>eio_nthreads()</strong>


id: eio_nready
type: function
doc:
<comment>Description:</comment>
  未処理のリクエスト数を返す

<comment>Return:</comment>
  <info>int</info>  <strong>eio_nready()</strong> は、未処理のリクエスト数を返します。

<comment>See Also:</comment>
   * <strong>eio_nreqs()</strong>
   * <strong>eio_nready()</strong>
   * <strong>eio_nthreads()</strong>


id: eio_nreqs
type: function
doc:
<comment>Description:</comment>
  処理対象のリクエスト数を返す
  
  <strong>eio_nreqs()</strong> は、 <strong>eio_poll()</strong> を呼ぶカスタムループの中からコールされます。

<comment>Return:</comment>
  <info>int</info>  <strong>eio_nreqs()</strong> は、処理対象のリクエスト数を返します。

<comment>See Also:</comment>
   * <strong>eio_poll()</strong>
   * <strong>eio_nready()</strong>


id: eio_nthreads
type: function
doc:
<comment>Description:</comment>
  現在利用中のスレッド数を返す

<comment>Return:</comment>
  <info>int</info>  <strong>eio_nthreads()</strong> は、現在利用中のスレッド数を返します。

<comment>See Also:</comment>
   * <strong>eio_npending()</strong>
   * <strong>eio_nready()</strong>
   * <strong>eio_nreqs()</strong>
   * <strong>eio_set_max_idle()</strong>
   * <strong>eio_set_max_parallel()</strong>
   * <strong>eio_set_min_parallel()</strong>


id: eio_open
type: function
doc:
<comment>Description:</comment>
  ファイルを開く
  
  <strong>eio_open()</strong> は、 <strong>$path</strong> で指定したファイルをアクセスモード <strong>$mode</strong> で開きます。

<comment>Param:</comment>
  <info>string</info>    <strong>$path</strong>      開きたいファイルへのパス。  SAPI の種類によっては (PHP-FPM など)、 フルパスで
                       指定しないと失敗します。
                       
                       SAPI の種類によっては (PHP-FPM など)、 フルパスで指定しないと失敗します。
  <info>int</info>       <strong>$flags</strong>     EIO_O_* 定数のいずれか、あるいは複数の組み合わせ。 EIO_O_* 定数の意味は、C の
                       ヘッダファイル <return>fnctl.h</return> で定義されている O_* と同じです。デフォルトは
                       <info>EIO_O_RDWR</info> です。
  <info>int</info>       <strong>$mode</strong>      EIO_S_I* 定数のいずれか、あるいは複数の (ビット OR による) 組み合わせ。 この
                       定数の意味は、C のヘッダファイル sys/stat.h で定義されている S_I* と同じで
                       す。 新しくファイルを作るときは必須で、それ以外の場合は無視されます。
  <info>int</info>       <strong>$pri</strong>       リクエストの優先順位。<info>EIO_PRI_DEFAULT</info>、<info>EIO_PRI_MIN</info>、<info>EIO_PRI_MAX</info> あるいは <info>null</info>
                       を指定します。
                       <info>null</info> を渡した場合、<strong>$pri</strong> は内部的に
                       <info>EIO_PRI_DEFAULT</info> となります。
  <info>callable</info>  <strong>$callback</strong>  <strong>$callback</strong> 関数が、リクエスト終了時にコールされます。
                       この関数のプロトタイプは、
                       に一致しなければなりません。
                       <strong>$data</strong>は、リクエストに渡すカスタムデータです。<strong>$result</strong>にはリクエスト固有の結果
                       が格納されます。基本的には、対応するシステムコールが返すそのままの値となりま
                       す。<strong>$req</strong>はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
                       
                       は、リクエストに渡すカスタムデータです。
                       
                       にはリクエスト固有の結果が格納されます。基本的には、対応するシステムコールが
                       返すそのままの値となります。
                       
                       はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
  <info>mixed</info>     <strong>$data</strong>      は、リクエストに渡すカスタムデータです。
  <info></info>          <strong>$result</strong>    にはリクエスト固有の結果が格納されます。基本的には、対応するシステムコールが
                       返すそのままの値となります。
  <info></info>          <strong>$req</strong>       はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
  <info>mixed</info>     <strong>$data</strong>      <strong>$callback</strong> に渡す任意の引数。

<comment>Return:</comment>
  <info>resource</info>  <strong>eio_open()</strong> は、成功した場合に <strong>$callback</strong> の <strong>$result</strong> 引数でファイルディスクリプタを返しま
            す。 それ以外の場合は、<strong>$result</strong> は <info>-1</info> になります。

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


id: eio_poll
type: function
doc:
<comment>Description:</comment>
  未処理のリクエストがあるかどうかを調べる
  
  <strong>eio_poll()</strong> を使うと、特別なイベントループを実装できます。 この中で <strong>eio_nreqs()</strong> を使って、未処理の
  リクエストの有無を調べます。 unprocessed requests.
  
  ユーザー空間でのイベントループを実装するときにしか使えません。

<comment>Return:</comment>
  <info>int</info>  何かのリクエストを実行してそれが非ゼロを返した場合は、その値を返します。 それ以外の場合は <info>0</info>
       を返します。

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


id: eio_read
type: function
doc:
<comment>Description:</comment>
  ファイルを、指定したオフセットから読み込む
  
  <strong>eio_read()</strong> は、<strong>$fd</strong> が指すファイルの <strong>$offset</strong> から最大 <strong>$length</strong> バイトまでを読み込みます。 読み込んだ
  データは <strong>$callback</strong> の <strong>$result</strong> 引数に格納されます。

<comment>Param:</comment>
  <info>mixed</info>     <strong>$fd</strong>        ストリーム、ソケットリソース、あるいは数値で表したファイルディスクリプタ。
  <info>int</info>       <strong>$length</strong>    読み込むバイト数の最大値。
  <info>int</info>       <strong>$offset</strong>    ファイル内でのオフセット。
  <info>int</info>       <strong>$pri</strong>       リクエストの優先順位。<info>EIO_PRI_DEFAULT</info>、<info>EIO_PRI_MIN</info>、<info>EIO_PRI_MAX</info> あるいは <info>null</info>
                       を指定します。
                       <info>null</info> を渡した場合、<strong>$pri</strong> は内部的に
                       <info>EIO_PRI_DEFAULT</info> となります。
  <info>callable</info>  <strong>$callback</strong>  <strong>$callback</strong> 関数が、リクエスト終了時にコールされます。
                       この関数のプロトタイプは、
                       に一致しなければなりません。
                       <strong>$data</strong>は、リクエストに渡すカスタムデータです。<strong>$result</strong>にはリクエスト固有の結果
                       が格納されます。基本的には、対応するシステムコールが返すそのままの値となりま
                       す。<strong>$req</strong>はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
                       
                       は、リクエストに渡すカスタムデータです。
                       
                       にはリクエスト固有の結果が格納されます。基本的には、対応するシステムコールが
                       返すそのままの値となります。
                       
                       はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
  <info>mixed</info>     <strong>$data</strong>      は、リクエストに渡すカスタムデータです。
  <info></info>          <strong>$result</strong>    にはリクエスト固有の結果が格納されます。基本的には、対応するシステムコールが
                       返すそのままの値となります。
  <info></info>          <strong>$req</strong>       はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
  <info>mixed</info>     <strong>$data</strong>      <strong>$callback</strong> に渡す任意の引数。

<comment>Return:</comment>
  <info>resource</info>  <strong>eio_read()</strong> は、読み込んだデータを <strong>$callback</strong> 関数の <strong>$result</strong> 引数に格納します。

<comment>See Also:</comment>
   * <strong>eio_open()</strong>
   * <strong>eio_write()</strong>
   * <strong>eio_close()</strong>
   * <strong>eio_event_loop()</strong>


id: eio_readahead
type: function
doc:
<comment>Description:</comment>
  ファイルを先読みしてページキャッシュに格納する
  
  <strong>eio_readahead()</strong> は、ファイルを先読みしてページキャッシュに格納します。 それ以降の読み込みは、ディ
  スク I/O をブロックしなくなります。詳細は <return>READAHEAD(2)</return> の man ページを参照ください。

<comment>Param:</comment>
  <info>mixed</info>     <strong>$fd</strong>        ストリーム、ソケットリソース、あるいは数値で表したファイルディスクリプタ。
  <info>int</info>       <strong>$offset</strong>    読み込みの開始位置。
  <info>int</info>       <strong>$length</strong>    読み込むバイト数。
  <info>int</info>       <strong>$pri</strong>       リクエストの優先順位。<info>EIO_PRI_DEFAULT</info>、<info>EIO_PRI_MIN</info>、<info>EIO_PRI_MAX</info> あるいは <info>null</info>
                       を指定します。
                       <info>null</info> を渡した場合、<strong>$pri</strong> は内部的に
                       <info>EIO_PRI_DEFAULT</info> となります。
  <info>callable</info>  <strong>$callback</strong>  <strong>$callback</strong> 関数が、リクエスト終了時にコールされます。
                       この関数のプロトタイプは、
                       に一致しなければなりません。
                       <strong>$data</strong>は、リクエストに渡すカスタムデータです。<strong>$result</strong>にはリクエスト固有の結果
                       が格納されます。基本的には、対応するシステムコールが返すそのままの値となりま
                       す。<strong>$req</strong>はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
                       
                       は、リクエストに渡すカスタムデータです。
                       
                       にはリクエスト固有の結果が格納されます。基本的には、対応するシステムコールが
                       返すそのままの値となります。
                       
                       はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
  <info>mixed</info>     <strong>$data</strong>      は、リクエストに渡すカスタムデータです。
  <info></info>          <strong>$result</strong>    にはリクエスト固有の結果が格納されます。基本的には、対応するシステムコールが
                       返すそのままの値となります。
  <info></info>          <strong>$req</strong>       はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
  <info>mixed</info>     <strong>$data</strong>      <strong>$callback</strong> に渡す任意の引数。

<comment>Return:</comment>
  <info>resource</info>  <strong>eio_readahead()</strong> は、成功した場合にリクエストリソースを返します。失敗した場合に <info>false</info> を
            返します


id: eio_readdir
type: function
doc:
<comment>Description:</comment>
  ディレクトリ全体を読み込む
  
  ディレクトリ全体を (<return>opendir</return> や <return>readdir</return>、 <return>closedir</return> といったシステムコールを使って) 読み込み、 ファ
  イル名あるいは配列 (<strong>$flags</strong> で指定する) を <strong>$callback</strong> 関数の <strong>$result</strong> 引数で返します。

<comment>Param:</comment>
  <info>string</info>    <strong>$path</strong>      ディレクトリのパス。
  <info>int</info>       <strong>$flags</strong>     EIO_READDIR_* 定数の組み合わせ。
  <info>int</info>       <strong>$pri</strong>       リクエストの優先順位。<info>EIO_PRI_DEFAULT</info>、<info>EIO_PRI_MIN</info>、<info>EIO_PRI_MAX</info> あるいは <info>null</info>
                       を指定します。
                       <info>null</info> を渡した場合、<strong>$pri</strong> は内部的に
                       <info>EIO_PRI_DEFAULT</info> となります。
  <info>callable</info>  <strong>$callback</strong>  <strong>$callback</strong> 関数が、リクエスト終了時にコールされます。
                       この関数のプロトタイプは、
                       に一致しなければなりません。
                       <strong>$data</strong>は、リクエストに渡すカスタムデータです。<strong>$result</strong>にはリクエスト固有の結果
                       が格納されます。基本的には、対応するシステムコールが返すそのままの値となりま
                       す。<strong>$req</strong>はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
                       
                       は、リクエストに渡すカスタムデータです。
                       
                       にはリクエスト固有の結果が格納されます。基本的には、対応するシステムコールが
                       返すそのままの値となります。
                       
                       はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
  <info>string</info>    <strong>$data</strong>      は、リクエストに渡すカスタムデータです。
  <info></info>          <strong>$result</strong>    にはリクエスト固有の結果が格納されます。基本的には、対応するシステムコールが
                       返すそのままの値となります。
  <info></info>          <strong>$req</strong>       はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
  <info>string</info>    <strong>$data</strong>      <strong>$callback</strong> に渡す任意の引数。

<comment>Return:</comment>
  <info>resource</info>  <strong>eio_readdir()</strong> は、成功した場合にリクエストリソースを返します。失敗した場合に <info>false</info> を返
            します。 <strong>$callback</strong> 関数の <strong>$result</strong> に設定される内容は <strong>$flags</strong> によって変わります。
            
            <info>EIO_READDIR_DENTS</info> (<info>int</info>) <strong>eio_readdir()</strong> のフラグ。指定すると、コールバックの result 引数が
            次のキーを持つ配列になります。 <return>'names'</return> - ディレクトリ名の配列／ <return>'dents'</return> - <return>struct
            eio_dirent</return> 風の配列で、 それぞれがさらに以下のキーを持ちます ( <return>'name'</return> - ディレクトリ名／
            <return>'type'</return> - EIO_DT_* 定数のいずれか／ <return>'inode'</return> - inode 番号。存在しない場合は不定 )
            <info>EIO_READDIR_DIRS_FIRST</info> (<info>int</info>)  このフラグを指定すると、ディレクトリをまず最初に返して
            stat に最適化した順に返します。 <info>EIO_READDIR_STAT_ORDER</info> (<info>int</info>)  このフラグを指定すると、名
            前を返すときの順序が 各ファイルを <return>stat</return> するのに適した順となります。 指定したディレクトリ
            にあるすべてのファイルを <strong>stat()</strong> するつもりなら、この順にしておけば最速になります。
            <info>EIO_READDIR_FOUND_UNKNOWN</info> (<info>int</info>)
             
            
            <strong>eio_readdir()</strong> のフラグ。指定すると、コールバックの result 引数が次のキーを持つ配列になり
            ます。 <return>'names'</return> - ディレクトリ名の配列／ <return>'dents'</return> - <return>struct eio_dirent</return> 風の配列で、 それぞ
            れがさらに以下のキーを持ちます ( <return>'name'</return> - ディレクトリ名／ <return>'type'</return> - EIO_DT_* 定数のいず
            れか／ <return>'inode'</return> - inode 番号。存在しない場合は不定 )
            
            このフラグを指定すると、ディレクトリをまず最初に返して stat に最適化した順に返します。
            
            このフラグを指定すると、名前を返すときの順序が 各ファイルを <return>stat</return> するのに適した順となり
            ます。 指定したディレクトリにあるすべてのファイルを <strong>stat()</strong> するつもりなら、この順にして
            おけば最速になります。
            
            ノード型 <info>EIO_DT_UNKNOWN</info> (<info>int</info>)  不明なノード型 (ありがち)。さらに <strong>stat()</strong> が必要です。
            <info>EIO_DT_FIFO</info> (<info>int</info>)  FIFO ノード型 <info>EIO_DT_CHR</info> (<info>int</info>)  ノード型 <info>EIO_DT_MPC</info> (<info>int</info>)  多重化キャ
            ラクタデバイス (v7+coherent) ノード型 <info>EIO_DT_DIR</info> (<info>int</info>)  ディレクトリノード型 <info>EIO_DT_NAM</info>
            (<info>int</info>)  Xenix 名前付きファイルノード型 <info>EIO_DT_BLK</info> (<info>int</info>)  ノード型 <info>EIO_DT_MPB</info> (<info>int</info>)  多重
            化ブロックデバイス (v7+coherent) <info>EIO_DT_REG</info> (<info>int</info>)  ノード型 <info>EIO_DT_NWK</info> (<info>int</info>)  <info>EIO_DT_CMP</info>
            (<info>int</info>)  HP-UX ネットワークノード型 <info>EIO_DT_LNK</info> (<info>int</info>)  リンクノード型 <info>EIO_DT_SOCK</info> (<info>int</info>)  ソ
            ケットノード型 <info>EIO_DT_DOOR</info> (<info>int</info>)  Solaris door ノード型 <info>EIO_DT_WHT</info> (<info>int</info>)  ノード型
            <info>EIO_DT_MAX</info> (<info>int</info>)  ノード型の最大値
            
            不明なノード型 (ありがち)。さらに <strong>stat()</strong> が必要です。
            
            FIFO ノード型
            
            ノード型
            
            多重化キャラクタデバイス (v7+coherent) ノード型
            
            ディレクトリノード型
            
            Xenix 名前付きファイルノード型
            
            ノード型
            
            多重化ブロックデバイス (v7+coherent)
            
            ノード型
            
            HP-UX ネットワークノード型
            
            リンクノード型
            
            ソケットノード型
            
            Solaris door ノード型
            
            ノード型
            
            ノード型の最大値


id: eio_readlink
type: function
doc:
<comment>Description:</comment>
  シンボリックリンクの値を読む

<comment>Param:</comment>
  <info>string</info>    <strong>$path</strong>      シンボリックリンクへのパス。
  <info>int</info>       <strong>$pri</strong>       リクエストの優先順位。<info>EIO_PRI_DEFAULT</info>、<info>EIO_PRI_MIN</info>、<info>EIO_PRI_MAX</info> あるいは <info>null</info>
                       を指定します。
                       <info>null</info> を渡した場合、<strong>$pri</strong> は内部的に
                       <info>EIO_PRI_DEFAULT</info> となります。
  <info>callable</info>  <strong>$callback</strong>  <strong>$callback</strong> 関数が、リクエスト終了時にコールされます。
                       この関数のプロトタイプは、
                       に一致しなければなりません。
                       <strong>$data</strong>は、リクエストに渡すカスタムデータです。<strong>$result</strong>にはリクエスト固有の結果
                       が格納されます。基本的には、対応するシステムコールが返すそのままの値となりま
                       す。<strong>$req</strong>はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
                       
                       は、リクエストに渡すカスタムデータです。
                       
                       にはリクエスト固有の結果が格納されます。基本的には、対応するシステムコールが
                       返すそのままの値となります。
                       
                       はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
  <info>mixed</info>     <strong>$data</strong>      は、リクエストに渡すカスタムデータです。
  <info></info>          <strong>$result</strong>    にはリクエスト固有の結果が格納されます。基本的には、対応するシステムコールが
                       返すそのままの値となります。
  <info></info>          <strong>$req</strong>       はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
  <info>mixed</info>     <strong>$data</strong>      <strong>$callback</strong> に渡す任意の引数。

<comment>Return:</comment>
  <info>resource</info>  <strong>eio_readlink()</strong> は、成功した場合にリクエストリソースを返します。失敗した場合に <info>false</info> を返
            します

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


id: eio_realpath
type: function
doc:
<comment>Description:</comment>
  正規化された絶対パスを取得する
  
  <strong>eio_realpath()</strong> は、正規化された絶対パスを <strong>$callback</strong> 関数の <strong>$result</strong> 引数で返します。

<comment>Param:</comment>
  <info>string</info>    <strong>$path</strong>      短い形式のパス。
  <info>int</info>       <strong>$pri</strong>       
  <info>callable</info>  <strong>$callback</strong>  
  <info>string</info>    <strong>$data</strong>      

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


id: eio_rename
type: function
doc:
<comment>Description:</comment>
  ファイル名や場所を変更する
  
  <strong>eio_rename()</strong> は、ファイル名を変更したり別の場所に移動したりします。

<comment>Param:</comment>
  <info>string</info>    <strong>$path</strong>      元のパス。
  <info>string</info>    <strong>$new_path</strong>  変更後のパス。
  <info>int</info>       <strong>$pri</strong>       リクエストの優先順位。<info>EIO_PRI_DEFAULT</info>、<info>EIO_PRI_MIN</info>、<info>EIO_PRI_MAX</info> あるいは <info>null</info>
                       を指定します。
                       <info>null</info> を渡した場合、<strong>$pri</strong> は内部的に
                       <info>EIO_PRI_DEFAULT</info> となります。
  <info>callable</info>  <strong>$callback</strong>  <strong>$callback</strong> 関数が、リクエスト終了時にコールされます。
                       この関数のプロトタイプは、
                       に一致しなければなりません。
                       <strong>$data</strong>は、リクエストに渡すカスタムデータです。<strong>$result</strong>にはリクエスト固有の結果
                       が格納されます。基本的には、対応するシステムコールが返すそのままの値となりま
                       す。<strong>$req</strong>はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
                       
                       は、リクエストに渡すカスタムデータです。
                       
                       にはリクエスト固有の結果が格納されます。基本的には、対応するシステムコールが
                       返すそのままの値となります。
                       
                       はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
  <info>mixed</info>     <strong>$data</strong>      は、リクエストに渡すカスタムデータです。
  <info></info>          <strong>$result</strong>    にはリクエスト固有の結果が格納されます。基本的には、対応するシステムコールが
                       返すそのままの値となります。
  <info></info>          <strong>$req</strong>       はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
  <info>mixed</info>     <strong>$data</strong>      <strong>$callback</strong> に渡す任意の引数。

<comment>Return:</comment>
  <info>resource</info>  <strong>eio_rename()</strong> は、成功した場合にリクエストリソースを返します。失敗した場合に <info>false</info> を返し
            ます


id: eio_rmdir
type: function
doc:
<comment>Description:</comment>
  ディレクトリを削除する
  
  <strong>eio_rmdir()</strong> は、ディレクトリを削除します。

<comment>Param:</comment>
  <info>string</info>    <strong>$path</strong>      ディレクトリへのパス。
  <info>int</info>       <strong>$pri</strong>       リクエストの優先順位。<info>EIO_PRI_DEFAULT</info>、<info>EIO_PRI_MIN</info>、<info>EIO_PRI_MAX</info> あるいは <info>null</info>
                       を指定します。
                       <info>null</info> を渡した場合、<strong>$pri</strong> は内部的に
                       <info>EIO_PRI_DEFAULT</info> となります。
  <info>callable</info>  <strong>$callback</strong>  <strong>$callback</strong> 関数が、リクエスト終了時にコールされます。
                       この関数のプロトタイプは、
                       に一致しなければなりません。
                       <strong>$data</strong>は、リクエストに渡すカスタムデータです。<strong>$result</strong>にはリクエスト固有の結果
                       が格納されます。基本的には、対応するシステムコールが返すそのままの値となりま
                       す。<strong>$req</strong>はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
                       
                       は、リクエストに渡すカスタムデータです。
                       
                       にはリクエスト固有の結果が格納されます。基本的には、対応するシステムコールが
                       返すそのままの値となります。
                       
                       はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
  <info>mixed</info>     <strong>$data</strong>      は、リクエストに渡すカスタムデータです。
  <info></info>          <strong>$result</strong>    にはリクエスト固有の結果が格納されます。基本的には、対応するシステムコールが
                       返すそのままの値となります。
  <info></info>          <strong>$req</strong>       はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
  <info>mixed</info>     <strong>$data</strong>      <strong>$callback</strong> に渡す任意の引数。

<comment>Return:</comment>
  <info>resource</info>  <strong>eio_rmdir()</strong> は、成功した場合にリクエストリソースを返します。失敗した場合に <info>false</info> を返し
            ます

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


id: eio_seek
type: function
doc:
<comment>Description:</comment>
  fd で指定したファイル内でのオフセットを、offset と whence に従って移動する
  
  <strong>eio_seek()</strong> は、<strong>$fd</strong> で指定したファイル内でのオフセットを、<strong>$offset</strong> と <strong>$whence</strong> で指定した位置に移動し
  ます。<strong>$whence</strong> の意味は次のとおりです。 <info>EIO_SEEK_SET</info> - 戦闘から <strong>$offset</strong> バイトの位置に移動する。
  <info>EIO_SEEK_CUR</info> - 現在の位置から <strong>$offset</strong> バイト進める。<info>EIO_SEEK_END</info> - ファイルの末尾から <strong>$offset</strong> バイ
  ト進める。

<comment>Param:</comment>
  <info>mixed</info>     <strong>$fd</strong>        ストリーム、ソケットリソース、あるいは数値で表したファイルディスクリプタ。
  <info>int</info>       <strong>$offset</strong>    読み込みの開始位置。
  <info></info>          <strong>$length</strong>    読み込むバイト数。
  <info>int</info>       <strong>$pri</strong>       リクエストの優先順位。<info>EIO_PRI_DEFAULT</info>、<info>EIO_PRI_MIN</info>、<info>EIO_PRI_MAX</info> あるいは <info>null</info>
                       を指定します。
                       <info>null</info> を渡した場合、<strong>$pri</strong> は内部的に
                       <info>EIO_PRI_DEFAULT</info> となります。
  <info>callable</info>  <strong>$callback</strong>  <strong>$callback</strong> 関数が、リクエスト終了時にコールされます。
                       この関数のプロトタイプは、
                       に一致しなければなりません。
                       <strong>$data</strong>は、リクエストに渡すカスタムデータです。<strong>$result</strong>にはリクエスト固有の結果
                       が格納されます。基本的には、対応するシステムコールが返すそのままの値となりま
                       す。<strong>$req</strong>はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
                       
                       は、リクエストに渡すカスタムデータです。
                       
                       にはリクエスト固有の結果が格納されます。基本的には、対応するシステムコールが
                       返すそのままの値となります。
                       
                       はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
  <info>mixed</info>     <strong>$data</strong>      は、リクエストに渡すカスタムデータです。
  <info></info>          <strong>$result</strong>    にはリクエスト固有の結果が格納されます。基本的には、対応するシステムコールが
                       返すそのままの値となります。
  <info></info>          <strong>$req</strong>       はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
  <info>mixed</info>     <strong>$data</strong>      <strong>$callback</strong> に渡す任意の引数。

<comment>Return:</comment>
  <info>resource</info>  <strong>eio_seek()</strong> は、成功した場合にリクエストリソースを返します。失敗した場合に <info>false</info> を返しま
            す


id: eio_sendfile
type: function
doc:
<comment>Description:</comment>
  ファイルディスクリプタ間でデータを転送する
  
  <strong>eio_sendfile()</strong> は、一方のファイルディスクリプタから もう一方のファイルディスクリプタにデータをコ
  ピーします。 詳細は <return>SENDFILE(2)</return> の man ページを参照ください。

<comment>Param:</comment>
  <info>mixed</info>     <strong>$out_fd</strong>    出力先のストリーム、ソケットリソース、あるいはファイルディスクリプタ。 書き込
                       みモードでのオープンが必須です。
  <info>mixed</info>     <strong>$in_fd</strong>     入力元のストリーム、ソケットリソース、あるいはファイルディスクリプタ。 読み込
                       みモードでのオープンが必須です。
  <info>int</info>       <strong>$offset</strong>    元ファイル内でのオフセット。
  <info>int</info>       <strong>$length</strong>    コピーするバイト数。
  <info>int</info>       <strong>$pri</strong>       リクエストの優先順位。<info>EIO_PRI_DEFAULT</info>、<info>EIO_PRI_MIN</info>、<info>EIO_PRI_MAX</info> あるいは <info>null</info>
                       を指定します。
                       <info>null</info> を渡した場合、<strong>$pri</strong> は内部的に
                       <info>EIO_PRI_DEFAULT</info> となります。
  <info>callable</info>  <strong>$callback</strong>  <strong>$callback</strong> 関数が、リクエスト終了時にコールされます。
                       この関数のプロトタイプは、
                       に一致しなければなりません。
                       <strong>$data</strong>は、リクエストに渡すカスタムデータです。<strong>$result</strong>にはリクエスト固有の結果
                       が格納されます。基本的には、対応するシステムコールが返すそのままの値となりま
                       す。<strong>$req</strong>はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
                       
                       は、リクエストに渡すカスタムデータです。
                       
                       にはリクエスト固有の結果が格納されます。基本的には、対応するシステムコールが
                       返すそのままの値となります。
                       
                       はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
  <info>string</info>    <strong>$data</strong>      は、リクエストに渡すカスタムデータです。
  <info></info>          <strong>$result</strong>    にはリクエスト固有の結果が格納されます。基本的には、対応するシステムコールが
                       返すそのままの値となります。
  <info></info>          <strong>$req</strong>       はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
  <info>string</info>    <strong>$data</strong>      <strong>$callback</strong> に渡す任意の引数。

<comment>Return:</comment>
  <info>resource</info>  <strong>eio_sendfile()</strong> は、成功した場合にリクエストリソースを返します。失敗した場合に <info>false</info> を返
            します


id: eio_set_max_idle
type: function
doc:
<comment>Description:</comment>
  アイドルスレッドの最大数を設定する

<comment>Param:</comment>
  <info>int</info>  <strong>$nthreads</strong>  アイドルスレッドの数。

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

<comment>See Also:</comment>
   * <strong>eio_nthreads()</strong>
   * <strong>eio_set_min_parallel()</strong>
   * <strong>eio_set_max_parallel()</strong>


id: eio_set_max_parallel
type: function
doc:
<comment>Description:</comment>
  最大の並列スレッド数を設定する

<comment>Param:</comment>
  <info>int</info>  <strong>$nthreads</strong>  並列スレッドの数。

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

<comment>See Also:</comment>
   * <strong>eio_nthreads()</strong>
   * <strong>eio_set_max_idle()</strong>
   * <strong>eio_set_min_parallel()</strong>


id: eio_set_max_poll_reqs
type: function
doc:
<comment>Description:</comment>
  一度のポールで行う最大のリクエスト回数を設定する

<comment>Param:</comment>
  <info>int</info>  <strong>$nreqs</strong>  リクエスト回数。

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


id: eio_set_max_poll_time
type: function
doc:
<comment>Description:</comment>
  最大のポール時間を設定する
  
  ポールの所要時間が <strong>$nseconds</strong> 秒を超えると、処理を止めます。

<comment>Param:</comment>
  <info>float</info>  <strong>$nseconds</strong>  秒数。

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


id: eio_set_min_parallel
type: function
doc:
<comment>Description:</comment>
  最小の並列スレッド数を設定する

<comment>Param:</comment>
  <info>string</info>  <strong>$nthreads</strong>  並列スレッドの数。

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

<comment>See Also:</comment>
   * <strong>eio_nthreads()</strong>
   * <strong>eio_set_max_idle()</strong>
   * <strong>eio_set_max_parallel()</strong>


id: eio_stat
type: function
doc:
<comment>Description:</comment>
  ファイルの状態を取得する
  
  <strong>eio_stat()</strong> は、 <strong>$callback</strong> の <strong>$result</strong> 引数でファイルの状態を返します。

<comment>Param:</comment>
  <info>string</info>    <strong>$path</strong>      ファイルへのパス。
  <info>int</info>       <strong>$pri</strong>       リクエストの優先順位。<info>EIO_PRI_DEFAULT</info>、<info>EIO_PRI_MIN</info>、<info>EIO_PRI_MAX</info> あるいは <info>null</info>
                       を指定します。
                       <info>null</info> を渡した場合、<strong>$pri</strong> は内部的に
                       <info>EIO_PRI_DEFAULT</info> となります。
  <info>callable</info>  <strong>$callback</strong>  <strong>$callback</strong> 関数が、リクエスト終了時にコールされます。
                       この関数のプロトタイプは、
                       に一致しなければなりません。
                       <strong>$data</strong>は、リクエストに渡すカスタムデータです。<strong>$result</strong>にはリクエスト固有の結果
                       が格納されます。基本的には、対応するシステムコールが返すそのままの値となりま
                       す。<strong>$req</strong>はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
                       
                       は、リクエストに渡すカスタムデータです。
                       
                       にはリクエスト固有の結果が格納されます。基本的には、対応するシステムコールが
                       返すそのままの値となります。
                       
                       はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
  <info>mixed</info>     <strong>$data</strong>      は、リクエストに渡すカスタムデータです。
  <info></info>          <strong>$result</strong>    にはリクエスト固有の結果が格納されます。基本的には、対応するシステムコールが
                       返すそのままの値となります。
  <info></info>          <strong>$req</strong>       はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
  <info>mixed</info>     <strong>$data</strong>      <strong>$callback</strong> に渡す任意の引数。

<comment>Return:</comment>
  <info>resource</info>  <strong>eio_stat()</strong> は、成功した場合にリクエストリソースを返します。失敗した場合に <info>false</info> を返しま
            す。 成功した場合は、<strong>$callback</strong> の <strong>$result</strong> 引数に配列が格納されます。

<comment>See Also:</comment>
   * <strong>eio_lstat()</strong>
   * <strong>eio_fstat()</strong>


id: eio_statvfs
type: function
doc:
<comment>Description:</comment>
  ファイルシステムの状態を取得する
  
  <strong>eio_statvfs()</strong> は、ファイルシステムの状態を <strong>$callback</strong> の <strong>$result</strong> で返します。

<comment>Param:</comment>
  <info>string</info>    <strong>$path</strong>      マウントされたファイルシステム内のファイルのパス。
  <info>int</info>       <strong>$pri</strong>       リクエストの優先順位。<info>EIO_PRI_DEFAULT</info>、<info>EIO_PRI_MIN</info>、<info>EIO_PRI_MAX</info> あるいは <info>null</info>
                       を指定します。
                       <info>null</info> を渡した場合、<strong>$pri</strong> は内部的に
                       <info>EIO_PRI_DEFAULT</info> となります。
  <info>callable</info>  <strong>$callback</strong>  <strong>$callback</strong> 関数が、リクエスト終了時にコールされます。
                       この関数のプロトタイプは、
                       に一致しなければなりません。
                       <strong>$data</strong>は、リクエストに渡すカスタムデータです。<strong>$result</strong>にはリクエスト固有の結果
                       が格納されます。基本的には、対応するシステムコールが返すそのままの値となりま
                       す。<strong>$req</strong>はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
                       
                       は、リクエストに渡すカスタムデータです。
                       
                       にはリクエスト固有の結果が格納されます。基本的には、対応するシステムコールが
                       返すそのままの値となります。
                       
                       はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
  <info>mixed</info>     <strong>$data</strong>      は、リクエストに渡すカスタムデータです。
  <info></info>          <strong>$result</strong>    にはリクエスト固有の結果が格納されます。基本的には、対応するシステムコールが
                       返すそのままの値となります。
  <info></info>          <strong>$req</strong>       はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
  <info>mixed</info>     <strong>$data</strong>      <strong>$callback</strong> に渡す任意の引数。

<comment>Return:</comment>
  <info>resource</info>  <strong>eio_statvfs()</strong> は、成功した場合にリクエストリソースを返します。失敗した場合に <info>false</info> を返
            します。 成功した場合は、<strong>$callback</strong> の <strong>$result</strong> 引数に配列が格納されます。


id: eio_symlink
type: function
doc:
<comment>Description:</comment>
  シンボリックリンクを作る
  
  <strong>eio_symlink()</strong> は、<strong>$path</strong> へのシンボリックリンク <strong>$new_path</strong> を作ります。

<comment>Param:</comment>
  <info>string</info>    <strong>$path</strong>      リンク元のパス。
  <info>string</info>    <strong>$new_path</strong>  リンク先のパス。
  <info>int</info>       <strong>$pri</strong>       リクエストの優先順位。<info>EIO_PRI_DEFAULT</info>、<info>EIO_PRI_MIN</info>、<info>EIO_PRI_MAX</info> あるいは <info>null</info>
                       を指定します。
                       <info>null</info> を渡した場合、<strong>$pri</strong> は内部的に
                       <info>EIO_PRI_DEFAULT</info> となります。
  <info>callable</info>  <strong>$callback</strong>  <strong>$callback</strong> 関数が、リクエスト終了時にコールされます。
                       この関数のプロトタイプは、
                       に一致しなければなりません。
                       <strong>$data</strong>は、リクエストに渡すカスタムデータです。<strong>$result</strong>にはリクエスト固有の結果
                       が格納されます。基本的には、対応するシステムコールが返すそのままの値となりま
                       す。<strong>$req</strong>はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
                       
                       は、リクエストに渡すカスタムデータです。
                       
                       にはリクエスト固有の結果が格納されます。基本的には、対応するシステムコールが
                       返すそのままの値となります。
                       
                       はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
  <info>mixed</info>     <strong>$data</strong>      は、リクエストに渡すカスタムデータです。
  <info></info>          <strong>$result</strong>    にはリクエスト固有の結果が格納されます。基本的には、対応するシステムコールが
                       返すそのままの値となります。
  <info></info>          <strong>$req</strong>       はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
  <info>mixed</info>     <strong>$data</strong>      <strong>$callback</strong> に渡す任意の引数。

<comment>Return:</comment>
  <info>resource</info>  <strong>eio_symlink()</strong> は、成功した場合にリクエストリソースを返します。失敗した場合に <info>false</info> を返
            します

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


id: eio_sync
type: function
doc:
<comment>Description:</comment>
  バッファのキャッシュをディスクに書き込む

<comment>Return:</comment>
  <info>resource</info>  <strong>eio_sync()</strong> は、成功した場合にリクエストリソースを返します。失敗した場合に <info>false</info> を返しま
            す


id: eio_sync_file_range
type: function
doc:
<comment>Description:</comment>
  ファイルセグメントをディスクに同期する
  
  <strong>eio_sync_file_range()</strong> は、ファイルディスクリプタ <strong>$fd</strong> が指すオープン中のファイルをディスクに同期し
  ます。

<comment>Param:</comment>
  <info>mixed</info>     <strong>$fd</strong>        ファイルディスクリプタ。
  <info>int</info>       <strong>$offset</strong>    同期を開始する位置をバイト単位で指定する。
  <info>int</info>       <strong>$nbytes</strong>    同期させる範囲の長さをバイト単位で指定する。 <strong>$nbytes</strong> がゼロの場合は、<strong>$offset</strong>
                       からファイルの末尾までのすべての範囲を同期します。
  <info>int</info>       <strong>$flags</strong>     ビットマスク。以下のいずれかの値を含めます。 <info>EIO_SYNC_FILE_RANGE_WAIT_BEFORE</info>,
                       <info>EIO_SYNC_FILE_RANGE_WRITE</info>, <info>EIO_SYNC_FILE_RANGE_WAIT_AFTER</info>. これらのフラグは、
                       それぞれ対応する SYNC_FILE_RANGE_* と同じ意味です (<return>SYNC_FILE_RANGE(2)</return> の man
                       ページを参照ください)。
  <info>int</info>       <strong>$pri</strong>       リクエストの優先順位。<info>EIO_PRI_DEFAULT</info>、<info>EIO_PRI_MIN</info>、<info>EIO_PRI_MAX</info> あるいは <info>null</info>
                       を指定します。
                       <info>null</info> を渡した場合、<strong>$pri</strong> は内部的に
                       <info>EIO_PRI_DEFAULT</info> となります。
  <info>callable</info>  <strong>$callback</strong>  <strong>$callback</strong> 関数が、リクエスト終了時にコールされます。
                       この関数のプロトタイプは、
                       に一致しなければなりません。
                       <strong>$data</strong>は、リクエストに渡すカスタムデータです。<strong>$result</strong>にはリクエスト固有の結果
                       が格納されます。基本的には、対応するシステムコールが返すそのままの値となりま
                       す。<strong>$req</strong>はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
                       
                       は、リクエストに渡すカスタムデータです。
                       
                       にはリクエスト固有の結果が格納されます。基本的には、対応するシステムコールが
                       返すそのままの値となります。
                       
                       はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
  <info>mixed</info>     <strong>$data</strong>      は、リクエストに渡すカスタムデータです。
  <info></info>          <strong>$result</strong>    にはリクエスト固有の結果が格納されます。基本的には、対応するシステムコールが
                       返すそのままの値となります。
  <info></info>          <strong>$req</strong>       はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
  <info>mixed</info>     <strong>$data</strong>      <strong>$callback</strong> に渡す任意の引数。

<comment>Return:</comment>
  <info>resource</info>  <strong>eio_sync_file_range()</strong> は、成功した場合にリクエストリソースを返します。失敗した場合に
            <info>false</info> を返します


id: eio_syncfs
type: function
doc:
<comment>Description:</comment>
  Linux の syncfs システムコールが使えれば、それを呼ぶ

<comment>Param:</comment>
  <info>mixed</info>     <strong>$fd</strong>        ファイルディスクリプタ。
  <info>int</info>       <strong>$pri</strong>       リクエストの優先順位。<info>EIO_PRI_DEFAULT</info>、<info>EIO_PRI_MIN</info>、<info>EIO_PRI_MAX</info> あるいは <info>null</info>
                       を指定します。
                       <info>null</info> を渡した場合、<strong>$pri</strong> は内部的に
                       <info>EIO_PRI_DEFAULT</info> となります。
  <info>callable</info>  <strong>$callback</strong>  <strong>$callback</strong> 関数が、リクエスト終了時にコールされます。
                       この関数のプロトタイプは、
                       に一致しなければなりません。
                       <strong>$data</strong>は、リクエストに渡すカスタムデータです。<strong>$result</strong>にはリクエスト固有の結果
                       が格納されます。基本的には、対応するシステムコールが返すそのままの値となりま
                       す。<strong>$req</strong>はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
                       
                       は、リクエストに渡すカスタムデータです。
                       
                       にはリクエスト固有の結果が格納されます。基本的には、対応するシステムコールが
                       返すそのままの値となります。
                       
                       はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
  <info>mixed</info>     <strong>$data</strong>      は、リクエストに渡すカスタムデータです。
  <info></info>          <strong>$result</strong>    にはリクエスト固有の結果が格納されます。基本的には、対応するシステムコールが
                       返すそのままの値となります。
  <info></info>          <strong>$req</strong>       はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
  <info>mixed</info>     <strong>$data</strong>      <strong>$callback</strong> に渡す任意の引数。

<comment>Return:</comment>
  <info>resource</info>  <strong>eio_syncfs()</strong> は、成功した場合にリクエストリソースを返します。失敗した場合に <info>false</info> を返し
            ます


id: eio_truncate
type: function
doc:
<comment>Description:</comment>
  ファイルを切り詰める
  
  <strong>eio_truncate()</strong> は、<strong>$path</strong> で指定したファイルを切り詰めて、ちょうど <strong>$length</strong> バイトにします。

<comment>Param:</comment>
  <info>string</info>    <strong>$path</strong>      ファイルへのパス。
  <info>int</info>       <strong>$offset</strong>    ファイルの先頭からのオフセット。
  <info>int</info>       <strong>$pri</strong>       リクエストの優先順位。<info>EIO_PRI_DEFAULT</info>、<info>EIO_PRI_MIN</info>、<info>EIO_PRI_MAX</info> あるいは <info>null</info>
                       を指定します。
                       <info>null</info> を渡した場合、<strong>$pri</strong> は内部的に
                       <info>EIO_PRI_DEFAULT</info> となります。
  <info>callable</info>  <strong>$callback</strong>  <strong>$callback</strong> 関数が、リクエスト終了時にコールされます。
                       この関数のプロトタイプは、
                       に一致しなければなりません。
                       <strong>$data</strong>は、リクエストに渡すカスタムデータです。<strong>$result</strong>にはリクエスト固有の結果
                       が格納されます。基本的には、対応するシステムコールが返すそのままの値となりま
                       す。<strong>$req</strong>はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
                       
                       は、リクエストに渡すカスタムデータです。
                       
                       にはリクエスト固有の結果が格納されます。基本的には、対応するシステムコールが
                       返すそのままの値となります。
                       
                       はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
  <info>mixed</info>     <strong>$data</strong>      は、リクエストに渡すカスタムデータです。
  <info></info>          <strong>$result</strong>    にはリクエスト固有の結果が格納されます。基本的には、対応するシステムコールが
                       返すそのままの値となります。
  <info></info>          <strong>$req</strong>       はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
  <info>mixed</info>     <strong>$data</strong>      <strong>$callback</strong> に渡す任意の引数。

<comment>Return:</comment>
  <info>resource</info>  <strong>eio_busy()</strong> は、成功した場合にリクエストリソースを返します。失敗した場合に <info>false</info> を返しま
            す

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


id: eio_unlink
type: function
doc:
<comment>Description:</comment>
  名前を削除し、その名前で参照しているファイルも削除する
  
  <strong>eio_unlink()</strong> は、その名前をファイルシステムから削除します。

<comment>Param:</comment>
  <info>string</info>    <strong>$path</strong>      ファイルへのパス。
  <info>int</info>       <strong>$pri</strong>       リクエストの優先順位。<info>EIO_PRI_DEFAULT</info>、<info>EIO_PRI_MIN</info>、<info>EIO_PRI_MAX</info> あるいは <info>null</info>
                       を指定します。
                       <info>null</info> を渡した場合、<strong>$pri</strong> は内部的に
                       <info>EIO_PRI_DEFAULT</info> となります。
  <info>callable</info>  <strong>$callback</strong>  <strong>$callback</strong> 関数が、リクエスト終了時にコールされます。
                       この関数のプロトタイプは、
                       に一致しなければなりません。
                       <strong>$data</strong>は、リクエストに渡すカスタムデータです。<strong>$result</strong>にはリクエスト固有の結果
                       が格納されます。基本的には、対応するシステムコールが返すそのままの値となりま
                       す。<strong>$req</strong>はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
                       
                       は、リクエストに渡すカスタムデータです。
                       
                       にはリクエスト固有の結果が格納されます。基本的には、対応するシステムコールが
                       返すそのままの値となります。
                       
                       はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
  <info>mixed</info>     <strong>$data</strong>      は、リクエストに渡すカスタムデータです。
  <info></info>          <strong>$result</strong>    にはリクエスト固有の結果が格納されます。基本的には、対応するシステムコールが
                       返すそのままの値となります。
  <info></info>          <strong>$req</strong>       はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
  <info>mixed</info>     <strong>$data</strong>      <strong>$callback</strong> に渡す任意の引数。

<comment>Return:</comment>
  <info>resource</info>  <strong>eio_unlink()</strong> は、成功した場合にリクエストリソースを返します。失敗した場合に <info>false</info> を返し
            ます


id: eio_utime
type: function
doc:
<comment>Description:</comment>
  ファイルの最終アクセス時刻と変更時刻を変更する

<comment>Param:</comment>
  <info>string</info>    <strong>$path</strong>      ファイルへのパス。
  <info>float</info>     <strong>$atime</strong>     アクセス時刻。
  <info>float</info>     <strong>$mtime</strong>     変更時刻。
  <info>int</info>       <strong>$pri</strong>       リクエストの優先順位。<info>EIO_PRI_DEFAULT</info>、<info>EIO_PRI_MIN</info>、<info>EIO_PRI_MAX</info> あるいは <info>null</info>
                       を指定します。
                       <info>null</info> を渡した場合、<strong>$pri</strong> は内部的に
                       <info>EIO_PRI_DEFAULT</info> となります。
  <info>callable</info>  <strong>$callback</strong>  <strong>$callback</strong> 関数が、リクエスト終了時にコールされます。
                       この関数のプロトタイプは、
                       に一致しなければなりません。
                       <strong>$data</strong>は、リクエストに渡すカスタムデータです。<strong>$result</strong>にはリクエスト固有の結果
                       が格納されます。基本的には、対応するシステムコールが返すそのままの値となりま
                       す。<strong>$req</strong>はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
                       
                       は、リクエストに渡すカスタムデータです。
                       
                       にはリクエスト固有の結果が格納されます。基本的には、対応するシステムコールが
                       返すそのままの値となります。
                       
                       はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
  <info>mixed</info>     <strong>$data</strong>      は、リクエストに渡すカスタムデータです。
  <info></info>          <strong>$result</strong>    にはリクエスト固有の結果が格納されます。基本的には、対応するシステムコールが
                       返すそのままの値となります。
  <info></info>          <strong>$req</strong>       はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
  <info>mixed</info>     <strong>$data</strong>      <strong>$callback</strong> に渡す任意の引数。

<comment>Return:</comment>
  <info>resource</info>  <strong>eio_utime()</strong> は、成功した場合にリクエストリソースを返します。失敗した場合に <info>false</info> を返し
            ます

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


id: eio_write
type: function
doc:
<comment>Description:</comment>
  ファイルに書き込む
  
  <strong>eio_write()</strong> は、<strong>$str</strong> の先頭から <strong>$offset</strong> バイトの位置から、最大で <strong>$length</strong> バイトまで書き込みます。

<comment>Param:</comment>
  <info>mixed</info>     <strong>$fd</strong>        ストリーム、ソケットリソース、あるいは数値で表したファイルディスクリプタ
                       (<strong>eio_open()</strong> が返すものなど)。
  <info>string</info>    <strong>$str</strong>       ソース文字列。
  <info>int</info>       <strong>$length</strong>    書き込む最大バイト数。
  <info>int</info>       <strong>$offset</strong>    ファイルの先頭からのオフセット。
  <info>int</info>       <strong>$pri</strong>       リクエストの優先順位。<info>EIO_PRI_DEFAULT</info>、<info>EIO_PRI_MIN</info>、<info>EIO_PRI_MAX</info> あるいは <info>null</info>
                       を指定します。
                       <info>null</info> を渡した場合、<strong>$pri</strong> は内部的に
                       <info>EIO_PRI_DEFAULT</info> となります。
  <info>callable</info>  <strong>$callback</strong>  <strong>$callback</strong> 関数が、リクエスト終了時にコールされます。
                       この関数のプロトタイプは、
                       に一致しなければなりません。
                       <strong>$data</strong>は、リクエストに渡すカスタムデータです。<strong>$result</strong>にはリクエスト固有の結果
                       が格納されます。基本的には、対応するシステムコールが返すそのままの値となりま
                       す。<strong>$req</strong>はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
                       
                       は、リクエストに渡すカスタムデータです。
                       
                       にはリクエスト固有の結果が格納されます。基本的には、対応するシステムコールが
                       返すそのままの値となります。
                       
                       はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
  <info>mixed</info>     <strong>$data</strong>      は、リクエストに渡すカスタムデータです。
  <info></info>          <strong>$result</strong>    にはリクエスト固有の結果が格納されます。基本的には、対応するシステムコールが
                       返すそのままの値となります。
  <info></info>          <strong>$req</strong>       はオプションで指定するリクエストリソースです。
                       <strong>eio_get_last_error()</strong> のような関数で使えます。
  <info>mixed</info>     <strong>$data</strong>      <strong>$callback</strong> に渡す任意の引数。

<comment>Return:</comment>
  <info>resource</info>  <strong>eio_write()</strong> は、成功した場合にリクエストリソースを返します。失敗した場合に <info>false</info> を返し
            ます

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


id: empty
type: function
doc:
<comment>Description:</comment>
  変数が空であるかどうかを検査する
  
  変数が空であるかどうかを検査します。 変数が空であるとみなされるのは、変数が存在しない場合や 変数の
  値が <info>false</info> に等しい場合です。 <strong>empty()</strong> は、変数が存在しない場合でも警告を発しません。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$var</strong>  チェックする変数
               
               変数が存在しなくても警告は発生しません。 つまり、<strong>empty()</strong> は本質的に !isset($var) ||
               $var == false と同じことを簡潔に記述しているだけです。

<comment>Return:</comment>
  <info>bool</info>  <strong>$var</strong> が存在しない、 または空や0の値が設定されている場合、 つまり boolean のコンテキストで
        <info>false</info> と見なされる場合、 <info>true</info> を返します。 詳細は boolean への変換 を参照ください。 それ以外
        の場合は <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>isset()</strong>
   * __isset()
   * <strong>unset()</strong>
   * <strong>array_key_exists()</strong>
   * <strong>count()</strong>
   * <strong>strlen()</strong>
   * PHP 型の比較表


id: enchant_broker_describe
type: function
doc:
<comment>Description:</comment>
  Enchant プロバイダを列挙する
  
  Enchant プロバイダを列挙し、その基本情報を通知します。 同じ情報が phpinfo() からでも取得できます。

<comment>Param:</comment>
  <info>EnchantBroker</info>  <strong>$broker</strong>  <strong>enchant_broker_init()</strong> によって返される Enchant ブローカー。

<comment>Return:</comment>
  <info>array</info>  利用可能な Enchant プロバイダの一覧と、その詳細を <info>array</info> として返します。


id: enchant_broker_dict_exists
type: function
doc:
<comment>Description:</comment>
  辞書が存在するかどうかを調べる。空でないタグを使用する
  
  辞書が存在するかどうかを調べます。空でないタグを使用します。

<comment>Param:</comment>
  <info>EnchantBroker</info>  <strong>$broker</strong>  <strong>enchant_broker_init()</strong> によって返される Enchant ブローカー。
  <info>string</info>         <strong>$tag</strong>     空でない、LOCALE 形式のタグ。例: us_US、ch_DE など。

<comment>Return:</comment>
  <info>bool</info>  タグが存在する場合に <info>true</info>、存在しない場合に <info>false</info> を返します。

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


id: enchant_broker_free
type: function
doc:
<comment>Description:</comment>
  ブローカーリソースおよびその辞書を開放する
  
  ブローカーをその辞書とともに開放します。 PHP 8.0.0 以降では、この関数を呼び出さず、オブジェクト自
  体を unset することを推奨します。

<comment>Param:</comment>
  <info>EnchantBroker</info>  <strong>$broker</strong>  <strong>enchant_broker_init()</strong> によって返される Enchant ブローカー。

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

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


id: enchant_broker_free_dict
type: function
doc:
<comment>Description:</comment>
  辞書リソースを開放する
  
  辞書を開放します。 PHP 8.0.0 以降では、この関数を呼び出す代わりに、オブジェクト自体を unset するこ
  とを推奨します。

<comment>Param:</comment>
  <info>EnchantDictionary</info>  <strong>$dictionary</strong>  <strong>enchant_broker_request_dict()</strong> または
                                  <strong>enchant_broker_request_pwl_dict()</strong> によって返される Enchant 辞書。

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

<comment>See Also:</comment>
   * <strong>enchant_broker_request_dict()</strong>
   * <strong>enchant_broker_request_pwl_dict()</strong>


id: enchant_broker_get_dict_path
type: function
doc:
<comment>Description:</comment>
  指定されたバックエンドの辞書のパスを取得する
  
  指定されたバックエンドの辞書のパスを取得します。

<comment>Param:</comment>
  <info>EnchantBroker</info>  <strong>$broker</strong>  <strong>enchant_broker_init()</strong> によって返される Enchant ブローカー。
  <info>int</info>            <strong>$type</strong>    辞書のタイプ。たとえば、<info>ENCHANT_MYSPELL</info> または <info>ENCHANT_ISPELL</info>。

<comment>Return:</comment>
  <info>string|false</info>  成功した場合、辞書のディレクトリパスを返します。 失敗した場合に <info>false</info> を返します

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


id: enchant_broker_get_error
type: function
doc:
<comment>Description:</comment>
  ブローカーの直近のエラーを返す
  
  このブローカーで発生した直近のエラーを返します。

<comment>Param:</comment>
  <info>EnchantBroker</info>  <strong>$broker</strong>  <strong>enchant_broker_init()</strong> によって返される Enchant ブローカー。

<comment>Return:</comment>
  <info>string|false</info>  エラーが見つかった場合にメッセージ文字列、それ以外の場合に <info>false</info> を返します。


id: enchant_broker_init
type: function
doc:
<comment>Description:</comment>
  要求を満たすブローカーオブジェクトを作成する

<comment>Return:</comment>
  <info>EnchantBroker|false</info>  成功した場合にブローカーリソース、それ以外の場合に <info>false</info> を返します。

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


id: enchant_broker_list_dicts
type: function
doc:
<comment>Description:</comment>
  使用可能な辞書の一覧を返す
  
  使用可能な辞書の一覧と、その詳細を返します。

<comment>Param:</comment>
  <info>EnchantBroker</info>  <strong>$broker</strong>  <strong>enchant_broker_init()</strong> によって返される Enchant ブローカー。

<comment>Return:</comment>
  <info>array</info>  使用可能な辞書の一覧と、その詳細を <info>array</info> として返します。

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


id: enchant_broker_request_dict
type: function
doc:
<comment>Description:</comment>
  タグを使用して新しい辞書を作成する
  
  タグを使用して新しい辞書を作成します。空でない言語タグで、 使用したい辞書を指定します ("en_US"、
  "de_DE"、...)。

<comment>Param:</comment>
  <info>EnchantBroker</info>  <strong>$broker</strong>  <strong>enchant_broker_init()</strong> によって返される Enchant ブローカー。
  <info>string</info>         <strong>$tag</strong>     ロケールを表すタグ。例えば en_US、de_DE など。

<comment>Return:</comment>
  <info>EnchantDictionary|false</info>  成功した場合に辞書リソース、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>enchant_dict_describe()</strong>
   * <strong>enchant_broker_dict_exists()</strong>
   * <strong>enchant_broker_free_dict()</strong>


id: enchant_broker_request_pwl_dict
type: function
doc:
<comment>Description:</comment>
  PWL ファイルを使用して辞書を作成する
  
  PWL ファイルを使用して辞書を作成します。 PWL ファイルは、一行にひとつの単語を記述したパーソナル単
  語ファイルです。

<comment>Param:</comment>
  <info>EnchantBroker</info>  <strong>$broker</strong>    <strong>enchant_broker_init()</strong> によって返される Enchant ブローカー。
  <info>string</info>         <strong>$filename</strong>  PWL ファイルへのパス。 ファイルが存在しない場合は、可能であれば新しい
                            ファイルを作ります。

<comment>Return:</comment>
  <info>EnchantDictionary|false</info>  成功した場合に辞書リソース、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>enchant_dict_describe()</strong>
   * <strong>enchant_broker_dict_exists()</strong>
   * <strong>enchant_broker_free_dict()</strong>


id: enchant_broker_set_dict_path
type: function
doc:
<comment>Description:</comment>
  指定されたバックエンドの辞書のパスを設定する
  
  指定されたバックエンドの辞書のパスを設定します。

<comment>Param:</comment>
  <info>EnchantBroker</info>  <strong>$broker</strong>  <strong>enchant_broker_init()</strong> によって返される Enchant ブローカー。
  <info>int</info>            <strong>$type</strong>    辞書のタイプ。たとえば、<info>ENCHANT_MYSPELL</info> または <info>ENCHANT_ISPELL</info>。
  <info>string</info>         <strong>$path</strong>    辞書のディレクトリパス。

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

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


id: enchant_broker_set_ordering
type: function
doc:
<comment>Description:</comment>
  その言語で使用する辞書の優先順位を宣言する
  
  'タグ' で表される言語で使用する辞書の優先順位を宣言します。 順位は、プロバイダ名をカンマ区切りでつ
  ないだリストで表します。 例外として、言語タグに "*" を使用すると、あらゆる言語についての デフォル
  トの順位を宣言します。 明示的に順位を指定しなかった言語についてはこれが使用されます。

<comment>Param:</comment>
  <info>EnchantBroker</info>  <strong>$broker</strong>    <strong>enchant_broker_init()</strong> によって返される Enchant ブローカー。
  <info>string</info>         <strong>$tag</strong>       言語タグ。"*" を使用すると、あらゆる言語についての デフォルトの順位を宣
                            言します。 明示的に順位を指定しなかった言語についてはこれが使用されま
                            す。
  <info>string</info>         <strong>$ordering</strong>  プロバイダ名をカンマ区切りでつないだリスト。

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


id: enchant_dict_add
type: function
doc:
<comment>Description:</comment>
  単語リストに単語を追加する
  
  指定した辞書の単語リストに単語を追加します。

<comment>Param:</comment>
  <info>EnchantDictionary</info>  <strong>$dictionary</strong>  <strong>enchant_broker_request_dict()</strong> または
                                  <strong>enchant_broker_request_pwl_dict()</strong> によって返される Enchant 辞書。
  <info>string</info>             <strong>$word</strong>        追加する単語。

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

<comment>See Also:</comment>
   * <strong>enchant_broker_request_pwl_dict()</strong>
   * <strong>enchant_broker_request_dict()</strong>


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


id: enchant_dict_add_to_session
type: function
doc:
<comment>Description:</comment>
  '単語' を、このスペルチェックセッションに追加する
  
  指定した辞書に単語を追加します。 追加されるのは、アクティブなスペルチェックセッションについてのみ
  です。

<comment>Param:</comment>
  <info>EnchantDictionary</info>  <strong>$dictionary</strong>  <strong>enchant_broker_request_dict()</strong> または
                                  <strong>enchant_broker_request_pwl_dict()</strong> によって返される Enchant 辞書。
  <info>string</info>             <strong>$word</strong>        追加する単語。

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

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


id: enchant_dict_check
type: function
doc:
<comment>Description:</comment>
  単語のスペルが正しいかどうかを調べる
  
  単語のスペルが正しい場合に <info>true</info>、 そうでない場合に <info>false</info> を返します。

<comment>Param:</comment>
  <info>EnchantDictionary</info>  <strong>$dictionary</strong>  <strong>enchant_broker_request_dict()</strong> または
                                  <strong>enchant_broker_request_pwl_dict()</strong> によって返される Enchant 辞書。
  <info>string</info>             <strong>$word</strong>        調べる単語。

<comment>Return:</comment>
  <info>bool</info>  単語のスペルが正しい場合に <info>true</info>、 そうでない場合に <info>false</info> を返します。


id: enchant_dict_describe
type: function
doc:
<comment>Description:</comment>
  個々の辞書について説明する
  
  辞書の詳細を返します。

<comment>Param:</comment>
  <info>EnchantDictionary</info>  <strong>$dictionary</strong>  <strong>enchant_broker_request_dict()</strong> または
                                  <strong>enchant_broker_request_pwl_dict()</strong> によって返される Enchant 辞書。

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


id: enchant_dict_get_error
type: function
doc:
<comment>Description:</comment>
  現在のスペリングセッションの直近のエラーを返す
  
  現在のスペリングセッションの、直近のエラーを返します。

<comment>Param:</comment>
  <info>EnchantDictionary</info>  <strong>$dictionary</strong>  <strong>enchant_broker_request_dict()</strong> または
                                  <strong>enchant_broker_request_pwl_dict()</strong> によって返される Enchant 辞書。

<comment>Return:</comment>
  <info>string|false</info>  エラーメッセージを表す文字列、あるいはエラーが発生していない場合に <info>false</info> を返しま
                す。


id: enchant_dict_is_added
type: function
doc:
<comment>Description:</comment>
  現在のセッションに、単語が存在するかどうかを調べる
  
  現在のセッションに、指定された単語が存在するかを調べる。

<comment>Param:</comment>
  <info>EnchantDictionary</info>  <strong>$dictionary</strong>  <strong>enchant_broker_request_dict()</strong> または
                                  <strong>enchant_broker_request_pwl_dict()</strong> によって返される Enchant 辞書。
  <info>string</info>             <strong>$word</strong>        調べる単語。

<comment>Return:</comment>
  <info>bool</info>  単語が存在した場合、<info>true</info> を返します。 存在しない場合、<info>false</info> を返します。

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


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


id: enchant_dict_quick_check
type: function
doc:
<comment>Description:</comment>
  単語のスペルが正しいかどうかを調べ、修正候補を提供する
  
  単語のスペルが正しい場合は <info>true</info>、そうでない場合は <info>false</info> を返します。変数 suggestions を指定してい
  る場合は、 そこに修正候補が格納されます。

<comment>Param:</comment>
  <info>EnchantDictionary</info>  <strong>$dictionary</strong>   <strong>enchant_broker_request_dict()</strong> または
                                   <strong>enchant_broker_request_pwl_dict()</strong> によって返される Enchant 辞書。
  <info>string</info>             <strong>$word</strong>         調べる単語。
  <info>array</info>              <strong>$suggestions</strong>  単語のスペルが間違っている場合に、 この変数の中に修正候補の配列が
                                   格納されます。

<comment>Return:</comment>
  <info>bool</info>  単語のスペルが正しい場合に <info>true</info>、 そうでない場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>enchant_dict_check()</strong>
   * <strong>enchant_dict_suggest()</strong>


id: enchant_dict_store_replacement
type: function
doc:
<comment>Description:</comment>
  単語の修正候補を追加する
  
  'mis' の修正候補として 'cor' を使用します。 @mis が @cor に置き換えられることに注意しましょう。 今
  後 @mis が登場すると、それは @cor で置き換えられます。 そのため、@cor が修正候補の中で衝突するかも
  しれません。

<comment>Param:</comment>
  <info>EnchantDictionary</info>  <strong>$dictionary</strong>  <strong>enchant_broker_request_dict()</strong> または
                                  <strong>enchant_broker_request_pwl_dict()</strong> によって返される Enchant 辞書。
  <info>string</info>             <strong>$misspelled</strong>  修正する単語。
  <info>string</info>             <strong>$correct</strong>     正しい単語。

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


id: enchant_dict_suggest
type: function
doc:
<comment>Description:</comment>
  修正候補となる値の一覧を返す

<comment>Param:</comment>
  <info>EnchantDictionary</info>  <strong>$dictionary</strong>  <strong>enchant_broker_request_dict()</strong> または
                                  <strong>enchant_broker_request_pwl_dict()</strong> によって返される Enchant 辞書。
  <info>string</info>             <strong>$word</strong>        修正候補を調べる単語。

<comment>Return:</comment>
  <info>array</info>  単語のスペルが間違っている場合に、修正候補の配列を返します。

<comment>See Also:</comment>
   * <strong>enchant_dict_check()</strong>
   * <strong>enchant_dict_quick_check()</strong>


id: end
type: function
doc:
<comment>Description:</comment>
  配列の内部ポインタを最終要素にセットする
  
  <strong>end()</strong> は <strong>$array</strong> の内部ポインタを最後の要素まで進め、その値を返します。

<comment>Param:</comment>
  <info>array|object</info>  <strong>$array</strong>  配列。この配列は参照渡しとなります。関数内で配列の中身を変更するからです。
                        つまり、ここには配列そのものを渡さなければならず、 配列を返す関数を指定する
                        ことはできません。 参照渡しできるのは、実際の変数だけだからです。

<comment>Return:</comment>
  <info>mixed</info>  最後の要素の値、あるいは空の配列の場合は <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>current()</strong>
   * <strong>each()</strong>
   * <strong>prev()</strong>
   * <strong>reset()</strong>
   * <strong>next()</strong>
   * <strong>array_key_last()</strong>


id: enum_exists
type: function
doc:
<comment>Description:</comment>
  列挙型が定義されているかを調べる
  
  この関数は、指定された 列挙型 が定義されているかを調べます。

<comment>Param:</comment>
  <info>string</info>  <strong>$enum</strong>      列挙型の名前。この名前は、大文字小文字を区別せずに比較されます。
  <info>bool</info>    <strong>$autoload</strong>  まだロードされていない場合に オートロード するかどうか。

<comment>Return:</comment>
  <info>bool</info>  <strong>$enum</strong> が定義済みの列挙型である場合、 <info>true</info> を返します。そうでない場合、<info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>function_exists()</strong>
   * <strong>class_exists()</strong>
   * <strong>interface_exists()</strong>
   * <strong>get_declared_classes()</strong>


id: error_clear_last
type: function
doc:
<comment>Description:</comment>
  最も最近のエラーをクリア

<comment>Return:</comment>
  <info>void</info>  最も最近のエラーをクリアーし、 <strong>error_get_last()</strong> で取得できないようにします。

<comment>See Also:</comment>
   * エラー定数


id: error_get_last
type: function
doc:
<comment>Description:</comment>
  最後に発生したエラーを取得する
  
  最後に発生したエラーについての情報を取得します。

<comment>Return:</comment>
  <info>array|null</info>  最後に発生したエラーについての情報を連想配列で返します。連想配列のキーは "type"、
              "message"、"file" および "line" となります。 PHP の内部関数で発生したエラーの場合は、
              "message" の先頭に関数名が含まれています。 エラーが発生していない場合は <info>null</info> を返しま
              す。

<comment>See Also:</comment>
   * エラー定数
   * 変数 $php_errormsg
   * <strong>error_clear_last()</strong>
   * ディレクティブ <strong>$display_errors</strong>
   * ディレクティブ <strong>$html_errors</strong>
   * ディレクティブ <strong>$xmlrpc_errors</strong>


id: error_log
type: function
doc:
<comment>Description:</comment>
  定義されたエラー処理ルーチンにエラーメッセージを送信する
  
  エラーメッセージを Web サーバーのエラーログあるいはファイルに送ります。

<comment>Param:</comment>
  <info>string</info>       <strong>$message</strong>             ログに記録されるエラーメッセージ。
  <info>int</info>          <strong>$message_type</strong>        メッセージをどこに送るのかを指定します。以下の中から指定できま
                                    す。
                                    
                                    <strong>error_log()</strong> ログタイプ0<strong>$message</strong> は PHP のシステムロガーに送ら
                                    れ、 設定ディレクティブ error_log  の値に応じて、 オペレーティン
                                    グシステムのシステムログ機構を使って保存されるか、 ファイルに保
                                    存されるかが決まります。 これがデフォルトのオプションです。
                                    1<strong>$message</strong> は、<strong>$destination </strong> パラメータで指定されたアドレスに、電
                                    子メール により送られます。このメッセージタイプの場合にのみ、 4
                                    番目のパラメータである <strong>$additional_headers</strong> が使われます。 2 この
                                    オプションは存在しません。 3<strong>$message</strong> は <strong>$destination </strong> で指定され
                                    たファイルに追加されます。 明示的に指定しない限り、<strong>$message</strong> の
                                    最後には改行文字は追加されません。 4<strong>$message</strong> は、直接 SAPI のロ
                                    グ出力ハンドラに送信されます。
  <info>string|null</info>  <strong>$destination</strong>         メッセージの送信先。その設定は、上で説明している <strong>$message_type</strong>
                                    パラメータの値によります。
  <info>string|null</info>  <strong>$additional_headers</strong>  追加のヘッダ。<strong>$message_type</strong> パラメータが <return>1</return> に設定される場合に利
                                    用されます。 このメッセージタイプは、<strong>mail()</strong> と同様に 内部関数を
                                    利用します。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。 <strong>$message_type</strong> が0の場合、 エラーが
        ロギング出来たかそうでないかに関わらず、この関数は常に <info>true</info> を返します。


id: error_reporting
type: function
doc:
<comment>Description:</comment>
  出力する PHP エラーの種類を設定する
  
  <strong>error_reporting()</strong> 関数は、 error_reporting ディレクティブを 実行時に設定します。PHP には多くのエ
  ラーレベルがあり、 この関数によりスクリプトの持続時間(実行時間)のレベルが設定されます。 オプション
  の <strong>$error_level</strong> を指定しなかった場合は、 <strong>error_reporting()</strong> は単に現在のエラーレベルを返します。

<comment>Param:</comment>
  <info>int|null</info>  <strong>$error_level</strong>  新しい error_reporting レベル。ビットマスクまたは名前つき定数のどちらかで
                          す。将来の バージョンとの互換性を保証するために、名前つき定数の使用が 強く
                          推奨されています。エラーレベルが追加されると、整数の幅は増加します。 その
                          ため、以前の整数を使用するエラーレベルは常に期待通りに動作するとは 限りま
                          せん。
                          
                          利用可能なエラーレベル定数とその実際の意味は、 定義済みの定数に 記述されて
                          います。

<comment>Return:</comment>
  <info>int</info>  <strong>$error_level</strong> に変更される 前 の、 error_reporting レベルを返します。
       
       エラー制御演算子<return>@</return> は、エラーハンドリングの間に <strong>$error_level</strong> を変更します。

<comment>See Also:</comment>
   * display_errors ディレクティブ
   * html_errors ディレクティブ
   * xmlrpc_errors ディレクティブ
   * エラー制御演算子
   * <strong>ini_set()</strong>


id: escapeshellarg
type: function
doc:
<comment>Description:</comment>
  シェル引数として使用される文字列をエスケープする
  
  <strong>escapeshellarg()</strong> は、文字列をシングルクオート で括り、既存のシングルクオートを全てクオート/エス
  ケープします。こ れにより、文字列を直接シェル関数に渡し、単一の安全な引数として処 理することを可能
  にします。この関数は、ユーザー入力からの入力を シェル関数への引数として渡す際にエスケープするため
  に使用する必要 があります。シェル関数には、<strong>exec()</strong>, <strong>system()</strong>そして バッククォート演算子 を含むシェ
  ル関数が含まれます。
  
  Windows では、<strong>escapeshellarg()</strong> は、パーセント記号と感嘆符 (遅延環境変数の展開) とダブルクォートを
  スペースに置き換えます。 そして、文字列をダブルクォートで囲みます。 さらに、連続するバックスラッ
  シュ(<return>\</return>) は、もうひとつバックスラッシュを追加すればエスケープできます。

<comment>Param:</comment>
  <info>string</info>  <strong>$arg</strong>  エスケープされる引数

<comment>Return:</comment>
  <info>string</info>  エスケープされた文字列

<comment>See Also:</comment>
   * <strong>escapeshellcmd()</strong>
   * <strong>exec()</strong>
   * <strong>popen()</strong>
   * <strong>system()</strong>
   * バッククォート演算子


id: escapeshellcmd
type: function
doc:
<comment>Description:</comment>
  シェルのメタ文字をエスケープする
  
  <strong>escapeshellcmd()</strong> は、文字列中においてシェルコマンドを だまして勝手なコマンドを実行する可能性がある
  文字をエスケープします。 この関数は、ユーザーに入力されたデータを関数 <strong>exec()</strong> または <strong>system()</strong> また
  は、 バッククォート演算子 に渡す前に全てエスケープを行う場合に使用するべきです。
  
  <return>&#;`|*?~\<&gt;^()[]{}$\</return>、<return>\x0A</return> および <return>\xFF</return> については、その文字の前にバックスラッシュが 追加されます。<return>'</return> および <return>"</return> は、対になっていない場合にのみエスケープされます。 Windows では、 これらの文字に加えて <return>%</return> と <return>!</return> の前にキャレット (<return>^</return>) が付加されます。

<comment>Param:</comment>
  <info>string</info>  <strong>$command</strong>  エスケープされるコマンド

<comment>Return:</comment>
  <info>string</info>  エスケープされた文字列

<comment>See Also:</comment>
   * <strong>escapeshellarg()</strong>
   * <strong>exec()</strong>
   * <strong>popen()</strong>
   * <strong>system()</strong>
   * バッククォート演算子


id: eval
type: function
doc:
<comment>Description:</comment>
  文字列を PHP コードとして評価する
  
  指定した <strong>$code</strong> を PHP コードとして評価します。
  
  評価されるコードは、<strong>eval()</strong> がコールされた行における 変数のスコープ を継承します。コールされた時点
  で利用可能なあらゆる変数が、 評価されるコード中で読み取ることができますし、変更することもできま
  す。 しかし、定義されている全ての関数やクラスは、グローバル名前空間で定義されます。 言い換えると、
  コンパイラは評価されるコードを include された別のファイルのようにみなすということです。
  
  <strong>eval()</strong> は非常に危険な言語構造です。 というのも、任意の PHP コードを実行できてしまうからです。 これ
  を使うことはおすすめしません。 いろいろ検討した結果どうしても使わざるを得なくなった場合は、細心の
  注意を払って使いましょう。 ユーザーから受け取ったデータをそのまま渡してはいけません。 渡す前に、適
  切な検証が必要です。

<comment>Param:</comment>
  <info>string</info>  <strong>$code</strong>  有効な PHP コード。これを評価します。
                 
                 PHP 開始タグを含めてはいけません。つまり、 <return>'\<?php echo "Hi!"; ?&gt;'</return> ではなく <return>'echo "Hi!";'</return> を渡さなければならないということです。 適切に PHP タグを使えば、PHP モードからいったん抜けてもう一度 PHP モードに戻るということも可能です。 たとえば、このようになります。 <return>'echo "PHP モード!"; ?&gt;HTML モード!\<?php echo "ふたたび PHP モード!";'</return>
                 
                 それはさておき、渡すコードは PHP として有効な形式でなければなりません。 つまり、す
                 べての文はセミコロンで終了する必要があるということです。 たとえば <return>'echo "やあ!"'</return> は
                 パースエラーになりますが、 <return>'echo "やあ!";'</return> は動作します。
                 
                 <return>return</return> 文は、コードの評価をただちに終了します。
                 
                 コードの実行は、<strong>eval()</strong> を呼び出したスコープ内で行われます。 したがって、<strong>eval()</strong> の中
                 で定義したり変更したりした変数は <strong>eval()</strong> を抜けた後でも参照可能です。

<comment>Return:</comment>
  <info>mixed</info>  評価されるコードの中で <return>return</return> が コールされない限り、<strong>eval()</strong> は <info>null</info> を返します。 <return>return</return> が
         コールされた場合は、その値を返します。 PHP 7 以降、評価されるコードの中でパースエラーが発生
         した場合は、 <strong>eval()</strong> は ParseError 例外をスローします。 PHP 7 より前のバージョンでは、この場
         合に <strong>eval()</strong> は <info>false</info> を返していました。 それ以降のコードは通常通り実行されます。 <strong>eval()</strong> の
         中でのパースエラーを <strong>set_error_handler()</strong> で捕捉することはできません。

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


id: exec
type: function
doc:
<comment>Description:</comment>
  外部プログラムを実行する
  
  <strong>exec()</strong> は指定されたコマンド <strong>$command</strong> を実行します。

<comment>Param:</comment>
  <info>string</info>  <strong>$command</strong>      実行するコマンド
  <info>array</info>   <strong>$output</strong>       引数 <strong>$output</strong> が存在する場合、指定した配列は、 コマンドからの出力の各行で埋め
                        られます。 <return>\n</return> のような後に続く空白は、この配列には含まれません。 配列に既に
                        何らかの要素が 含まれる場合は、<strong>exec()</strong> は配列の最後に追加される ことに注意し
                        てください。関数が要素を追加することを望まないのなら、 それが <strong>exec()</strong> に渡さ
                        れる前に、配列の <strong>unset()</strong> を呼び出してください。
  <info>int</info>     <strong>$result_code</strong>  引数<strong>$result_code</strong>が、引数 <strong>$output</strong> と共に存在する場合、実行したコマンドの ス
                        テータスがこの変数に書かれます。

<comment>Return:</comment>
  <info>string|false</info>  コマンド結果の最後の行を返します。コマンドを実行し、 一切干渉を受けずに直接コマンド
                から全てのデータを受けとる必要が あるならば、<strong>passthru()</strong> 関数を使ってください。
                
                失敗時に <info>false</info> を返します。
                
                実行されたコマンドの出力を取得するには、必ず <strong>$output</strong> パラメータを設定・使用してくだ
                さい。

<comment>See Also:</comment>
   * <strong>system()</strong>
   * <strong>passthru()</strong>
   * <strong>escapeshellcmd()</strong>
   * <strong>pcntl_exec()</strong>
   * バッククォート演算子


id: exif_imagetype
type: function
doc:
<comment>Description:</comment>
  イメージの型を定義する
  
  <strong>exif_imagetype()</strong> を画像の先頭バイトを読み そのサインを調べます。
  
  <strong>exif_imagetype()</strong> は、他の exif 関数がサポートしていないファイル形式で コールされるの防いだり、
  $_SERVER['HTTP_ACCEPT']  と組み合わせて閲覧者が画像を見る権限を持っているかどうかを調べたりするた
  めに 使用可能です。

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  調べる画像。

<comment>Return:</comment>
  <info>int|false</info>  正しいサインが見つかった場合は適切な定数、それ以外の場合は <info>false</info> を返します。戻り値は
             <strong>getimagesize()</strong> がインデックス 2 に対して返す値と同じですが、<strong>exif_imagetype()</strong> のほうが
             ずっと早く動作します。
             
             以下の定数が定義されており、<strong>exif_imagetype()</strong> の戻り値を表しています。 Imagetype 定数値
             定数
             1<info>IMAGETYPE_GIF</info>2<info>IMAGETYPE_JPEG</info>3<info>IMAGETYPE_PNG</info>4<info>IMAGETYPE_SWF</info>5<info>IMAGETYPE_PSD</info>6<info>IMAGETYPE_BMP</info>7<info>IMAGETYPE_TIFF_II</info>
             (intel byte order)8<info>IMAGETYPE_TIFF_MM</info> (motorola byte order)
             9<info>IMAGETYPE_JPC</info>10<info>IMAGETYPE_JP2</info>11<info>IMAGETYPE_JPX</info>12<info>IMAGETYPE_JB2</info>13<info>IMAGETYPE_SWC</info>14<info>IMAGETYPE_IFF</info>15<info>IMAGETYPE_WBMP</info>16<info>IMAGETYPE_XBM</info>17<info>IMAGETYPE_ICO</info>18<info>IMAGETYPE_WEBP</info>19<info>IMAGETYPE_AVIF</info>
             
             画像の形式を判別するために必要なだけのバイト数を読み込めない場合、 <strong>exif_imagetype()</strong> は
             <info>E_NOTICE</info> を発行して <info>false</info> を返します。

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


id: exif_read_data
type: function
doc:
<comment>Description:</comment>
  画像ファイルから EXIF ヘッダを読み込む
    
  
  <strong>exif_read_data()</strong> は、 画像ファイルから EXIF ヘッダを読み込みます。この方法で、デジタルカメラが生成
  したメタデータを 読み込むことが可能です。
  
  EXIF ヘッダは、デジタルカメラが作成した JPEG/TIFF 画像によく含まれています。しかし残念なことに、
  そのタグ付けの方法はメーカーによって異なります。 したがって、特定の Exif ヘッダが常に存在すると仮
  定することはできません。
  
  <return>Height</return> および <return>Width</return> は、<strong>getimagesize()</strong> と同じ方法で計算されます。 よって、これらの値は決してヘッダ
  の一部として返してはいけません。 また、<return>html</return> は高さ/幅を表すテキスト文字列で、 通常の HTML の中で用
  いられます。
  
  Exif ヘッダに著作権表示が含まれている場合、それ自身には 2 つの値を 含めることが可能です。Exif 2.10
  のこの矛盾した規格に対応するため、 <return>COMPUTED</return> セクションは <return>Copyright.Photographer</return> および
  <return>Copyright.Editor</return> の両方を返します。 また <return>IFD0</return> セクションには 2 つのエントリを NULL 文字で区切った
  バイト配列を含めます。データ型が間違っている場合は最初のエントリのみを かえします（Exif の通常の挙
  動）。<return>COMPUTED</return> には、元の著作権文字列あるいは カンマで区切られた写真と編集者の著作権表示のどちらか
  を <return>Copyright</return> エントリに含めることが可能です。
  
  <return>UserComment</return> タグにも Copyright タグと同様の問題があります。ここにも 2 つの値を格納することが可能で
  す。それは使用しているエンコーディングと 値自身の 2 つです。そうなると、<return>IFD</return> セクションにはエンコー
  ディングのみを 含めるか、あるいはバイト配列を格納することになります。<return>COMPUTED</return> セクションは
  <return>UserCommentEncoding</return> および <return>UserComment</return> を両方格納することができます。<return>UserComment</return> はどちらの 場合で
  も有効なので、<return>IFD0</return> セクションではこちらを優先すべきです。
  
  <strong>exif_read_data()</strong> は、EXIF 仕様（http://exif.org/Exif2-2.PDF, 20 ページ）に基づいて EXIF データタグ
  の検証も行います。

<comment>Param:</comment>
  <info>resource|string</info>  <strong>$file</strong>               画像ファイルの位置。 ファイルのパス (ストリームラッパーもいつ
                                       もどおりサポートされています) またはストリーム<info>resource</info>。
  <info>string|null</info>      <strong>$required_sections</strong>  結果の配列を作成するために存在する必要のあるセクションのカン
                                       マ区切り リスト。要求されたセクションがひとつも見つからなかっ
                                       た場合の戻り値は <info>false</info> となります。 FILEFileName, FileSize,
                                       FileDateTime, SectionsFoundCOMPUTED html, Width, Height,
                                       IsColor, および他の取得可能なもの。Height および Width は
                                       <strong>getimagesize()</strong> と同じ方法で取得した もので、その値はヘッダの
                                       一部ではありません。また、<return>html</return> は 通常の HTML 内で使用される
                                       height/width の 文字列です。 ANY_TAGタグを有するすべての情
                                       報。例えば <return>IFD0</return>, <return>EXIF</return>, ...IFD0 IFD0 のすべてのタグつきデー
                                       タ。通常の画像ファイルでは、 ここに画像のサイズが含まれます。
                                       THUMBNAIL 2 番目の <return>IFD</return> がある場合、ファイルにサムネイルが含ま
                                       れている 可能性があります。埋め込まれたサムネイルに関するすべ
                                       ての タグつき情報はこのセクションに格納されます。 COMMENTJPEG
                                       画像のコメントヘッダ。EXIF EXIF セクションは <return>IFD0</return> のサブセク
                                       ションです。ここには 画像に関する詳細な情報が含まれています。
                                       これらのエントリの ほとんどはデジタルカメラに関連するもので
                                       す。
  <info>bool</info>             <strong>$as_arrays</strong>          各セクションを配列とするかどうかを指定します。
                                       <strong>$required_sections</strong> の <return>COMPUTED</return>、 <return>THUMBNAIL</return> および <return>COMMENT</return>  は
                                       常に配列となります。これは、これらのセクションに 含まれる値の
                                       名前が他のセクションと衝突する可能性があるからです。
  <info>bool</info>             <strong>$read_thumbnail</strong>     <info>true</info> を指定すると、サムネイル本体を読み込みます。それ以外の場
                                       合は タグつきデータのみを読み込みます。

<comment>Return:</comment>
  <info>array|false</info>  ヘッダ名がキー・ヘッダの内容が値となる連想配列を返します。 返されるデータがない場合は
               <strong>exif_read_data()</strong> は <info>false</info> を返します。

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


id: exif_tagname
type: function
doc:
<comment>Description:</comment>
  インデックスに対応するヘッダ名を取得する

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  名前を調べたいタグの ID。

<comment>Return:</comment>
  <info>string|false</info>  ヘッダ名を返します。もし <strong>$index</strong> が EXIF タグ ID として未定義の場合は <info>false</info> を返しま
                す。

<comment>See Also:</comment>
   * <strong>exif_imagetype()</strong>
   * EXIF 仕様
   * EXIF タグ


id: exif_thumbnail
type: function
doc:
<comment>Description:</comment>
  画像に埋め込まれたサムネイルを取得する
  
  <strong>exif_thumbnail()</strong> は、 画像に埋め込まれたサムネイルを読み込みます。
  
  この関数を使用してサムネイルを出力したい場合は、 <strong>header()</strong> 関数を使用して mimetype 情報を送信する
  必要があります。
  
  <strong>exif_thumbnail()</strong> が画像を作成することはできないが、 そのサイズだけはわかるという可能性があります。
  そのような場合、戻り値は <info>false</info> となりますが <strong>$width</strong> および <strong>$height</strong> を設定されています。

<comment>Param:</comment>
  <info>resource|string</info>  <strong>$file</strong>        読み込む画像ファイルの名前。サムネイルが埋め込まれています。 画像
                                ファイルの位置。これはファイルのパスか、ストリーム <info>resource</info> です。
  <info>int</info>              <strong>$width</strong>       返されるサムネイルの幅が格納されます。
  <info>int</info>              <strong>$height</strong>      返されるサムネイルの高さが格納されます。
  <info>int</info>              <strong>$image_type</strong>  返されるサムネイルの画像タイプが格納されます。 TIFF あるいは JPEG の
                                どちらかです。

<comment>Return:</comment>
  <info>string|false</info>  埋め込まれたサムネイルを返します。画像がサムネイルを含まない場合は <info>false</info> を返しま
                す。

<comment>See Also:</comment>
   * <strong>exif_read_data()</strong>
   * <strong>image_type_to_mime_type()</strong>


id: exit
type: function
doc:
<comment>Description:</comment>
  メッセージを出力し、現在のスクリプトを終了する
  
  スクリプトの実行を終了します。 シャットダウン関数 や オブジェクトのデストラクタ は、<return>exit</return> がコール
  された場合にも実行されます。
  
  <return>exit</return> は言語構造です。 <strong>$status</strong> を指定しない場合は括弧なしでコールできます。

<comment>Param:</comment>
  <info>string</info>  <strong>$status</strong>  <strong>$status</strong> が文字列の場合は、この関数は終了直前に <strong>$status</strong> を表示します。
                   
                   <strong>$status</strong> が <info>int</info> の場合は その値が終了ステータスとして使われ、表示はされません。終
                   了ステータスは 0 から 254 までの値でなければなりません。終了ステータス 255 は PHP
                   に予約されており、使用してはいけません。ステータス 0 は、 プログラムを正常終了さ
                   せる際に使用します。

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

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


id: exp
type: function
doc:
<comment>Description:</comment>
  e の累乗を計算する
  
  <info>e</info> を <strong>$num</strong> 乗した値を返します。
  
  '<info>e</info>' は自然対数の底で、およそ 2.718282 です。

<comment>Param:</comment>
  <info>float</info>  <strong>$num</strong>  処理する引数。

<comment>Return:</comment>
  <info>float</info>  'e' の <strong>$num</strong> 乗を返します。

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


id: expect_expectl
type: function
doc:
<comment>Description:</comment>
  プロセスの出力がパターンに一致する・指定した時間が経過する・
    あるいは EOF に達するのいずれかにあてはまるまで待ち続ける
    
  
  プロセスの出力がパターンに一致する・指定した時間が経過する・ あるいは EOF に達するのいずれかにあて
  はまるまで待ち続けます。
  
  <strong>$match</strong> を指定すると、検索結果がそこに保存されます。 一致した文字列が <strong>$match[0]</strong> に保存され、 元のパ
  ターンの中の (括弧で囲まれた) 部分に一致する文字列が <strong>$match[1]</strong>、<strong>$match[2]</strong>、 と順に、最大 <strong>$match[9]</strong>
  まで (libexpect の制限です) 保存されます。

<comment>Param:</comment>
  <info>resource</info>  <strong>$expect</strong>  事前に <strong>expect_popen()</strong> でオープンした Expect ストリーム。
  <info>array</info>     <strong>$cases</strong>   expect case の配列。個々の expect case は数値添字の配列で、 以下のような形式と
                     なります。 Expect Case の配列添字値の型説明必須かどうかデフォルト値0stringスト
                     リームからの出力との比較対象となるパターン。yes1mixedパターンに一致した場合にこ
                     の関数が返す値。yes2integer パターンの形式。 <info>EXP_GLOB</info>、 <info>EXP_EXACT</info> あるいは
                     <info>EXP_REGEXP</info> のいずれかひとつです。 no<info>EXP_GLOB</info>

<comment>Return:</comment>
  <info>int</info>  一致したパターンに関連付けられた値を返します。
       
       この関数の実行に失敗した場合は、 <info>EXP_EOF</info>、 <info>EXP_TIMEOUT</info> あるいは <info>EXP_FULLBUFFER</info> を返します。

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


id: expect_popen
type: function
doc:
<comment>Description:</comment>
  Bourne シェル経由でコマンドを実行し、プロセスへの PTY
    ストリームをオープンする
  
  Bourne シェル経由でコマンドを実行し、プロセスへの PTY ストリームを オープンします。

<comment>Param:</comment>
  <info>string</info>  <strong>$command</strong>  実行するコマンド。

<comment>Return:</comment>
  <info>resource</info>  プロセスの標準入力・標準出力・標準エラー出力への PTY ストリームを返します。
            
            失敗した場合は、この関数は <info>false</info> を返します。

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


id: explode
type: function
doc:
<comment>Description:</comment>
  文字列を文字列により分割する
  
  文字列の配列を返します。この配列の各要素は、 <strong>$string</strong> を文字列 <strong>$separator</strong> で区切った部分文字列とな
  ります。

<comment>Param:</comment>
  <info>string</info>  <strong>$separator</strong>  区切り文字列。
  <info>string</info>  <strong>$string</strong>     入力文字列。
  <info>int</info>     <strong>$limit</strong>      <strong>$limit</strong> に正の値が指定された場合、返される配列には 最大 <strong>$limit</strong> の要素が含まれ、
                      その最後の要素には <strong>$string</strong> の残りの部分が全て含まれます。
                      
                      もし <strong>$limit</strong> パラメータが負の場合、 最後の -<strong>$limit</strong> 個の要素を除く全ての構成要素
                      が返されます。
                      
                      <strong>$limit</strong> パラメータがゼロの場合は、1 を指定したものとみなされます。

<comment>Return:</comment>
  <info>array</info>  <strong>$string</strong> の内容を <strong>$separator</strong> で分割した文字列の配列を返します。
         
         空の文字列 ("") が <strong>$separator</strong> として使用された場合、 <strong>explode()</strong> は <class>ValueError</class> をスローしま
         す。 <strong>$separator</strong> に引数 <strong>$string</strong> に含まれていない値が含まれている場合は、 <strong>$limit</strong> が負の値なら
         空の配列、そうでなければ 引数 <strong>$string</strong> を含む配列を返します。 <strong>$separator</strong> の値が <strong>$string</strong> の最
         初か最後に現れた場合、その位置に応じて、 返される配列の最初か最後に空の配列が追加されます。

<comment>See Also:</comment>
   * <strong>preg_split()</strong>
   * <strong>str_split()</strong>
   * <strong>mb_split()</strong>
   * <strong>str_word_count()</strong>
   * <strong>strtok()</strong>
   * <strong>implode()</strong>


id: expm1
type: function
doc:
<comment>Description:</comment>
  値がゼロに近い時にでも精度を保つために exp(number) - 1 を返す
    
  
  <strong>expm1()</strong> は、 exp($num) - 1 の値を返します。 <strong>$num</strong> がゼロに近く、 exp($num) - 1 が引き算時の桁落ちの
  ために 不正確となるような場合でも正確な値が計算できる方法を使用します。

<comment>Param:</comment>
  <info>float</info>  <strong>$num</strong>  処理する引数。

<comment>Return:</comment>
  <info>float</info>  'e' の <strong>$num</strong> 乗から 1 を引いた値を返します。

<comment>See Also:</comment>
   * <strong>log1p()</strong>
   * <strong>exp()</strong>


id: expression
type: function
doc:
<comment>Description:</comment>
  プリペアドステートメントの変数をパラメータとしてバインドする
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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

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


id: extension_loaded
type: function
doc:
<comment>Description:</comment>
  ある拡張モジュールがロードされているかどうかを調べる
  
  拡張モジュールがロードされているかどうかを調べます。

<comment>Param:</comment>
  <info>string</info>  <strong>$extension</strong>  拡張モジュールの名前。大文字小文字を区別します。
                      
                      <strong>phpinfo()</strong>を使って種々の拡張モジュールの 名前を見ることができます。PHP の <return>CGI</return>ま
                      たは<return>CLI</return>バージョン を使っている場合には -m スイッチで、 使用できる全ての拡張モ
                      ジュールのリストを得ることができます:

<comment>Return:</comment>
  <info>bool</info>  <strong>$extension</strong> で指定する拡張モジュールがロードされている場合に <info>true</info> を返します。さもなければ
        <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>get_loaded_extensions()</strong>
   * <strong>get_extension_funcs()</strong>
   * <strong>phpinfo()</strong>
   * <strong>dl()</strong>
   * <strong>function_exists()</strong>


id: extract
type: function
doc:
<comment>Description:</comment>
  配列からシンボルテーブルに変数をインポートする
  
  配列からシンボルテーブルに変数をインポートします。
  
  各キーについて変数名として有効であるかどうか、 そして、シンボルテーブルの既存の変数と衝突しないか
  どうかを確認します。
  
  ユーザーの入力、例えば $_GET や $_FILES のような、 信頼できないデータに <strong>extract()</strong> を使用しないでく
  ださい。

<comment>Param:</comment>
  <info>array</info>   <strong>$array</strong>   この関数は連想配列 <strong>$var_array</strong> を引数とし、そのキーを変数名、値を変数の値として処
                   理します。 各キー/値の組に関して、<strong>$flags</strong> および <strong>$prefix</strong> パラメータに基づき、 現在
                   のシンボルテーブルに変数を一つ作成します。
                   
                   連想配列を使用する必要があります。<info>EXTR_PREFIX_ALL</info> または <info>EXTR_PREFIX_INVALID</info> を使
                   用しない限り、 数値添字の配列には結果は出力されません。
  <info>int</info>     <strong>$flags</strong>   無効または数値キーおよび衝突に関する対処法は、 <strong>$flags</strong> で定義されます。 これは以下
                   の値のどれかとなります。 <info>EXTR_OVERWRITE</info> 衝突があった場合、存在する変数が上書きさ
                   れます。 <info>EXTR_SKIP</info> 衝突があった場合、存在する変数は上書きされません。
                   <info>EXTR_PREFIX_SAME</info> 衝突があった場合、<strong>$prefix</strong> を前につけた新しい変数となります。
                   <info>EXTR_PREFIX_ALL</info> 全ての変数の前に <strong>$prefix</strong> を付けます。 <info>EXTR_PREFIX_INVALID</info> 無効ま
                   たは数値の変数名のみに接頭辞 <strong>$prefix</strong> を付けます。 <info>EXTR_IF_EXISTS</info> 現在のシンボル
                   テーブルに既に存在する場合にのみ上書きします。 例えば $_REQUEST 以外にあなたが定
                   義した変数のみを展開し 有効な変数としたいような場合に有用です。
                   <info>EXTR_PREFIX_IF_EXISTS</info> 同じ変数だが接頭辞をつけていないバージョンの変数が 現在のシ
                   ンボルテーブルに存在する場合にのみ 変数を生成します。 <info>EXTR_REFS</info> 変数を参照として
                   展開します。 これはインポート済みの変数が、 <strong>$array</strong> パラメータの値に常に参照付けら
                   れることを意味します。 このフラグを単独で使用するか、 あるいは<strong>$flags</strong>と和算するこ
                   とにより、 他のフラグとそれを組み合わせることができます。
                   
                   衝突があった場合、存在する変数が上書きされます。
                   
                   衝突があった場合、存在する変数は上書きされません。
                   
                   衝突があった場合、<strong>$prefix</strong> を前につけた新しい変数となります。
                   
                   全ての変数の前に <strong>$prefix</strong> を付けます。
                   
                   無効または数値の変数名のみに接頭辞 <strong>$prefix</strong> を付けます。
                   
                   現在のシンボルテーブルに既に存在する場合にのみ上書きします。 例えば $_REQUEST 以
                   外にあなたが定義した変数のみを展開し 有効な変数としたいような場合に有用です。
                   
                   同じ変数だが接頭辞をつけていないバージョンの変数が 現在のシンボルテーブルに存在す
                   る場合にのみ 変数を生成します。
                   
                   変数を参照として展開します。 これはインポート済みの変数が、 <strong>$array</strong> パラメータの値
                   に常に参照付けられることを意味します。 このフラグを単独で使用するか、 あるいは
                   <strong>$flags</strong>と和算することにより、 他のフラグとそれを組み合わせることができます。
                   
                   <strong>$flags</strong> が指定されない場合、 <info>EXTR_OVERWRITE</info> とみなされます。
  <info>string</info>  <strong>$prefix</strong>  衝突があった場合、<strong>$prefix</strong> を前につけた新しい変数となります。
  <info>string</info>  <strong>$prefix</strong>  全ての変数の前に <strong>$prefix</strong> を付けます。
  <info>string</info>  <strong>$prefix</strong>  無効または数値の変数名のみに接頭辞 <strong>$prefix</strong> を付けます。
  <info>array</info>   <strong>$array</strong>   変数を参照として展開します。 これはインポート済みの変数が、 <strong>$array</strong> パラメータの値
                   に常に参照付けられることを意味します。 このフラグを単独で使用するか、 あるいは
                   <strong>$flags</strong>と和算することにより、 他のフラグとそれを組み合わせることができます。
  <info>string</info>  <strong>$prefix</strong>  <strong>$prefix</strong> は、 <strong>$flags</strong> が <info>EXTR_PREFIX_SAME</info>、<info>EXTR_PREFIX_ALL</info>、 <info>EXTR_PREFIX_INVALID</info> あ
                   るいは <info>EXTR_PREFIX_IF_EXISTS</info> の場合にのみ必要であることに注意してください。 接頭
                   辞を付けた変数名が有効な変数名でない場合、 この変数はシンボルテーブルにインポート
                   されません。接頭辞は、 アンダースコア文字で配列のキーから自動的に分割されます。

<comment>Return:</comment>
  <info>int</info>  シンボルテーブルにインポートした変数の数を返します。

<comment>See Also:</comment>
   * <strong>compact()</strong>
   * <strong>list()</strong>


id: ezmlm_hash
type: function
doc:
<comment>Description:</comment>
  EZMLM で必要なハッシュ値を計算する
  
  <strong>ezmlm_hash()</strong> は、EZMLM メイリングリストを MySQL データベースで管理する際に必要なハッシュ値を計算し
  ます。

<comment>Param:</comment>
  <info>string</info>  <strong>$addr</strong>  ハッシュ値を計算する email アドレス。

<comment>Return:</comment>
  <info>int</info>  <strong>$addr</strong> のハッシュ値を返します。


id: fann_cascadetrain_on_data
type: function
doc:
<comment>Description:</comment>
  Trains on an entire dataset, for a period of time using the Cascade2 training algorithm
  
  The cascade output change fraction is a number between 0 and 1 determining how large a fraction
  the <strong>fann_get_MSE()</strong> value should change within <strong>fann_get_cascade_output_stagnation_epochs()</strong> during
  training of the output connections, in order for the training not to stagnate.  If the training
  stagnates, the training of the output connections will be ended and new candidates will be
  prepared.
  
  This training uses the parameters set using the fann_set_cascade_..., but it also uses another
  training algorithm as it’s internal training algorithm. This algorithm can be set to either
  <info>FANN_TRAIN_RPROP</info> or <info>FANN_TRAIN_QUICKPROP</info> by <strong>fann_set_training_algorithm()</strong>, and the parameters set
  for these training algorithms will also affect the cascade training.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                      ニューラルネットワークリソース。
  <info>resource</info>  <strong>$data</strong>                     ニューラルネットワークトレーニングリソース。
  <info>int</info>       <strong>$max_neurons</strong>              The maximum number of neurons to be added to neural network.
  <info>int</info>       <strong>$neurons_between_reports</strong>  The number of neurons between printing a status report. A
                                      value of zero means no reports should be printed.
  <info>float</info>     <strong>$desired_error</strong>            The desired <strong>fann_get_MSE()</strong> or <strong>fann_get_bit_fail()</strong>, depending
                                      on which stop function is chosen by
                                      <strong>fann_set_train_stop_function()</strong>

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>fann_train_on_data()</strong>
   * <strong>fann_cascadetrain_on_file()</strong>


id: fann_cascadetrain_on_file
type: function
doc:
<comment>Description:</comment>
  Trains on an entire dataset read from file, for a period of time using the Cascade2 training
  algorithm
  
  Does the same as <strong>fann_cascadetrain_on_data()</strong>, but reads the training data directly from a file.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                      ニューラルネットワークリソース。
  <info>string</info>    <strong>$filename</strong>                 A file containing the data for training.
  <info>int</info>       <strong>$max_neurons</strong>              The maximum number of neurons to be added to neural network
  <info>int</info>       <strong>$neurons_between_reports</strong>  The number of neurons between printing a status report. A
                                      value of zero means no reports should be printed.
  <info>float</info>     <strong>$desired_error</strong>            The desired <strong>fann_get_MSE()</strong> or <strong>fann_get_bit_fail()</strong>, depending
                                      on which stop function is chosen by
                                      <strong>fann_set_train_stop_function()</strong>.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>fann_train_on_data()</strong>
   * <strong>fann_cascadetrain_on_data()</strong>


id: fann_clear_scaling_params
type: function
doc:
<comment>Description:</comment>
  Clears scaling parameters
  
  Clears scaling parameters.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  ニューラルネットワークリソース。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。


id: fann_copy
type: function
doc:
<comment>Description:</comment>
  Creates a copy of a fann structure
  
  Creates a copy of a fann structure.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  ニューラルネットワークリソース。

<comment>Return:</comment>
  <info>resource</info>  Returns a copy of neural network resource on success, or <info>false</info> on error

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


id: fann_create_from_file
type: function
doc:
<comment>Description:</comment>
  Constructs a backpropagation neural network from a configuration file
  
  Constructs a backpropagation neural network from a configuration file, which have been saved by
  <strong>fann_save()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$configuration_file</strong>  The configuration file path.

<comment>Return:</comment>
  <info>resource</info>  成功した場合にニューラルネットワークリソース、エラー時に <info>false</info> を返します。

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


id: fann_create_shortcut
type: function
doc:
<comment>Description:</comment>
  Creates a standard backpropagation neural network which is not fully connectected and has shortcut
  connections
  
  Creates a standard backpropagation neural network, which is not fully connected and which also has
  shortcut connections.
  
  Shortcut connections are connections that skip layers. A fully connected network with shortcut
  connections, is a network where all neurons are connected to all neurons in later layers.
  Including direct connections from the input layer to the output layer.

<comment>Param:</comment>
  <info>int</info>  <strong>$num_layers</strong>    The total number of layers including the input and the output layer.
  <info>int</info>  <strong>$num_neurons1</strong>  Number of neurons in the first layer.
  <info>int</info>  <strong>$num_neurons2</strong>  Number of neurons in the second layer.
  <info>int</info>  <strong>$num_neuronsN</strong>  Number of neurons in other layers.

<comment>Return:</comment>
  <info>resource</info>  Returns a neural network resource on success, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_create_shortcut_array()</strong>
   * <strong>fann_create_sparse()</strong>
   * <strong>fann_create_standard()</strong>


id: fann_create_shortcut_array
type: function
doc:
<comment>Description:</comment>
  Creates a standard backpropagation neural network which is not fully connectected and has shortcut
  connections
  
  Creates a standard backpropagation neural network which is not fully connectected and has shortcut
  connections using an array of layers sizes.

<comment>Param:</comment>
  <info>int</info>    <strong>$num_layers</strong>  The total number of layers including the input and the output layer.
  <info>array</info>  <strong>$layers</strong>      An array of layers sizes.

<comment>Return:</comment>
  <info>resource</info>  Returns a neural network resource on success, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_create_shortcut()</strong>
   * <strong>fann_create_sparse()</strong>
   * <strong>fann_create_standard()</strong>


id: fann_create_sparse
type: function
doc:
<comment>Description:</comment>
  Creates a standard backpropagation neural network, which is not fully connected
  
  Creates a standard backpropagation neural network, which is not fully connected.

<comment>Param:</comment>
  <info>float</info>  <strong>$connection_rate</strong>  The connection rate controls how many connections there will be in the
                           network. If the connection rate is set to 1, the network will be fully
                           connected, but if it is set to 0.5 only half of the connections will be
                           set. A connection rate of 1 will yield the same result as
                           <strong>fann_create_standard()</strong>.
  <info>int</info>    <strong>$num_layers</strong>       The total number of layers including the input and the output layer.
  <info>int</info>    <strong>$num_neurons1</strong>     Number of neurons in the first layer.
  <info>int</info>    <strong>$num_neurons2</strong>     Number of neurons in the second layer.
  <info>int</info>    <strong>$num_neuronsN</strong>     Number of neurons in other layers.

<comment>Return:</comment>
  <info>resource</info>  Returns a neural network resource on success, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_create_sparse_array()</strong>
   * <strong>fann_create_standard()</strong>
   * <strong>fann_create_shortcut()</strong>


id: fann_create_sparse_array
type: function
doc:
<comment>Description:</comment>
  Creates a standard backpropagation neural network, which is not fully connected using an array of
  layer sizes
  
  Creates a standard backpropagation neural network, which is not fully connected using an array of
  layer sizes.

<comment>Param:</comment>
  <info>float</info>  <strong>$connection_rate</strong>  The connection rate controls how many connections there will be in the
                           network. If the connection rate is set to 1, the network will be fully
                           connected, but if it is set to 0.5 only half of the connections will be
                           set. A connection rate of 1 will yield the same result as
                           <strong>fann_create_standard()</strong>.
  <info>int</info>    <strong>$num_layers</strong>       The total number of layers including the input and the output layer.
  <info>array</info>  <strong>$layers</strong>           An array of layer sizes.

<comment>Return:</comment>
  <info>resource</info>  Returns a neural network resource on success, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_create_sparse()</strong>
   * <strong>fann_create_standard()</strong>
   * <strong>fann_create_shortcut()</strong>


id: fann_create_standard
type: function
doc:
<comment>Description:</comment>
  Creates a standard fully connected backpropagation neural network
  
  Creates a standard fully connected backpropagation neural network.
  
  There will be a bias neuron in each layer (except the output layer), and this bias neuron will be
  connected to all neurons in the next layer. When running the network, the bias nodes always emits
  1.
  
  To destroy a neural network use the <strong>fann_destroy()</strong> function.

<comment>Param:</comment>
  <info>int</info>  <strong>$num_layers</strong>    The total number of layers including the input and the output layer.
  <info>int</info>  <strong>$num_neurons1</strong>  Number of neurons in the first layer.
  <info>int</info>  <strong>$num_neurons2</strong>  Number of neurons in the second layer.
  <info>int</info>  <strong>$num_neuronsN</strong>  Number of neurons in other layers.

<comment>Return:</comment>
  <info>resource</info>  Returns a neural network resource on success, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_create_standard_array()</strong>
   * <strong>fann_create_sparse()</strong>
   * <strong>fann_create_shortcut()</strong>


id: fann_create_standard_array
type: function
doc:
<comment>Description:</comment>
  Creates a standard fully connected backpropagation neural network using an array of layer sizes
  
  Creates a standard fully connected backpropagation neural network.
  
  There will be a bias neuron in each layer (except the output layer), and this bias neuron will be
  connected to all neurons in the next layer. When running the network, the bias nodes always emits
  1.
  
  To destroy a neural network use the <strong>fann_destroy()</strong> function.

<comment>Param:</comment>
  <info>int</info>    <strong>$num_layers</strong>  The total number of layers including the input and the output layer.
  <info>array</info>  <strong>$layers</strong>      An array of layer sizes.

<comment>Return:</comment>
  <info>resource</info>  Returns a neural network resource on success, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_create_standard()</strong>
   * <strong>fann_create_sparse()</strong>
   * <strong>fann_create_shortcut()</strong>


id: fann_create_train
type: function
doc:
<comment>Description:</comment>
  Creates an empty training data struct
  
  Creates an empty training data struct.

<comment>Param:</comment>
  <info>int</info>  <strong>$num_data</strong>    The number of training data
  <info>int</info>  <strong>$num_input</strong>   The number of inputs per training data
  <info>int</info>  <strong>$num_output</strong>  The number of ouputs per training data

<comment>Return:</comment>
  <info>resource</info>  成功した場合にニューラルネットワークトレーニングリソース、エラー時に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>fann_read_train_from_file()</strong>
   * <strong>fann_train_on_data()</strong>
   * <strong>fann_destroy_train()</strong>
   * <strong>fann_save_train()</strong>


id: fann_create_train_from_callback
type: function
doc:
<comment>Description:</comment>
  Creates the training data struct from a user supplied function
  
  Creates the training data struct from a user supplied function. As the training data are numerable
  (data 1, data 2...), the user must write a function that receives the number of the training data
  set (input, output) and returns the set.

<comment>Param:</comment>
  <info>int</info>       <strong>$num_data</strong>       The number of training data
  <info>int</info>       <strong>$num_input</strong>      The number of inputs per training data
  <info>int</info>       <strong>$num_output</strong>     The number of ouputs per training data
  <info>callable</info>  <strong>$user_function</strong>  The user supplied function with following parameters: <return>num</return> - The number
                            of the training data set<return>num_input</return> - The number of inputs per training
                            data<return>num_output</return> - The number of ouputs per training data
                            
                            The function should return an associative array with keys <return>input</return> and
                            <return>output</return> and two array values of input and output.

<comment>Return:</comment>
  <info>resource</info>  成功した場合にニューラルネットワークトレーニングリソース、エラー時に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>fann_read_train_from_file()</strong>
   * <strong>fann_train_on_data()</strong>
   * <strong>fann_destroy_train()</strong>
   * <strong>fann_save_train()</strong>


id: fann_descale_input
type: function
doc:
<comment>Description:</comment>
  Scale data in input vector after get it from ann based on previously calculated parameters
  
  Scale data in input vector after get it from ann based on previously calculated parameters.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>           ニューラルネットワークリソース。
  <info>array</info>     <strong>$input_vector</strong>  Input vector that will be descaled

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>fann_scale_input()</strong>
   * <strong>fann_descale_output()</strong>


id: fann_descale_output
type: function
doc:
<comment>Description:</comment>
  Scale data in output vector after get it from ann based on previously calculated parameters
  
  Scale data in output vector after get it from ann based on previously calculated parameters.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>            ニューラルネットワークリソース。
  <info>array</info>     <strong>$output_vector</strong>  Output vector that will be descaled

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>fann_scale_output()</strong>
   * <strong>fann_descale_input()</strong>


id: fann_descale_train
type: function
doc:
<comment>Description:</comment>
  Descale input and output data based on previously calculated parameters
  
  Descale input and output data based on previously calculated parameters.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>         ニューラルネットワークリソース。
  <info>resource</info>  <strong>$train_data</strong>  ニューラルネットワークトレーニングリソース。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>fann_scale_train()</strong>
   * <strong>fann_set_scaling_params()</strong>


id: fann_destroy
type: function
doc:
<comment>Description:</comment>
  Destroys the entire network and properly freeing all the associated memory
  
  Destroys the entire network and properly freeing all the associated memory.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  ニューラルネットワークリソース。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。


id: fann_destroy_train
type: function
doc:
<comment>Description:</comment>
  Destructs the training data
  
  Destructs the training data

<comment>Param:</comment>
  <info>resource</info>  <strong>$train_data</strong>  ニューラルネットワークトレーニングリソース。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。


id: fann_duplicate_train_data
type: function
doc:
<comment>Description:</comment>
  Returns an exact copy of a fann train data
  
  Returns an exact copy of a fann train data <info>resource</info>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$data</strong>  ニューラルネットワークトレーニングリソース。

<comment>Return:</comment>
  <info>resource</info>  成功した場合にニューラルネットワークトレーニングリソース、エラー時に <info>false</info> を返します。


id: fann_get_MSE
type: function
doc:
<comment>Description:</comment>
  Reads the mean square error from the network
  
  Reads the mean square error from the network.
  
  Reads the mean square error from the network. This value is calculated during training or testing
  and can therefore sometimes be a bit off if the weights have been changed since the last
  calculation of the value.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  ニューラルネットワークリソース。

<comment>Return:</comment>
  <info>float</info>  The mean square error, or <info>false</info> on error.

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


id: fann_get_activation_function
type: function
doc:
<comment>Description:</comment>
  Returns the activation function
  
  Get the activation function for neuron number <return>neuron</return> in layer number <return>layer</return>, counting the input
  layer as layer 0.
  
  It is not possible to get activation functions for the neurons in the input layer.
  
  The return value is one of the activation functions constants.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>     ニューラルネットワークリソース。
  <info>int</info>       <strong>$layer</strong>   Layer number.
  <info>int</info>       <strong>$neuron</strong>  Neuron number.

<comment>Return:</comment>
  <info>int</info>  Learning functions constant or -1 if the neuron is not defined in the neural network, or
       <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_set_activation_function_layer()</strong>
   * <strong>fann_set_activation_function_hidden()</strong>
   * <strong>fann_set_activation_function_output()</strong>
   * <strong>fann_set_activation_steepness()</strong>
   * <strong>fann_set_activation_function()</strong>


id: fann_get_activation_steepness
type: function
doc:
<comment>Description:</comment>
  Returns the activation steepness for supplied neuron and layer number
  
  Get the activation steepness for neuron number <return>neuron</return> in layer number <return>layer</return>, counting the input
  layer as layer 0.
  
  It is not possible to get activation steepness for the neurons in the input layer.
  
  The steepness of an activation function says something about how fast the activation function goes
  from the minimum to the maximum.  A high value for the activation function will also give a more
  aggressive training.
  
  When training neural networks where the output values should be at the extremes (usually 0 and 1,
  depending on the activation function), a steep activation function can be used (e.g.  1.0).
  
  The default activation steepness is 0.5.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>     ニューラルネットワークリソース。
  <info>int</info>       <strong>$layer</strong>   Layer number
  <info>int</info>       <strong>$neuron</strong>  Neuron number

<comment>Return:</comment>
  <info>float</info>  The activation steepness for the neuron or -1 if the neuron is not defined in the neural
         network, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_set_activation_function()</strong>
   * <strong>fann_set_activation_steepness_layer()</strong>
   * <strong>fann_set_activation_steepness_hidden()</strong>
   * <strong>fann_set_activation_steepness_output()</strong>
   * <strong>fann_set_activation_steepness()</strong>


id: fann_get_bias_array
type: function
doc:
<comment>Description:</comment>
  Get the number of bias in each layer in the network
  
  Get the number of bias in each layer in the network.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  ニューラルネットワークリソース。

<comment>Return:</comment>
  <info>array</info>  An array of numbers of bias in each layer


id: fann_get_bit_fail
type: function
doc:
<comment>Description:</comment>
  The number of fail bits
  
  The number of fail bits; means the number of output neurons which differ more than the bit fail
  limit (see <strong>fann_get_bit_fail_limit()</strong>, <strong>fann_set_bit_fail_limit()</strong>). The bits are counted in all of
  the training data, so this number can be higher than the number of training data.
  
  This value is reset by <strong>fann_reset_MSE()</strong> and updated by all the same functions which also updates
  the MSE value (e.g. <strong>fann_test_data()</strong>, <strong>fann_train_epoch()</strong>)

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  ニューラルネットワークリソース。

<comment>Return:</comment>
  <info>int</info>  The number of bits fail, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_get_MSE()</strong>
   * <strong>fann_reset_MSE()</strong>
   * <strong>fann_test_data()</strong>
   * <strong>fann_train_epoch()</strong>
   * <strong>fann_get_bit_fail_limit()</strong>
   * <strong>fann_set_bit_fail_limit()</strong>


id: fann_get_bit_fail_limit
type: function
doc:
<comment>Description:</comment>
  Returns the bit fail limit used during training
  
  Returns the bit fail limit used during training.
  
  The bit fail limit is used during training where the stop function is set to <info>FANN_STOPFUNC_BIT</info>.
  
  The limit is the maximum accepted difference between the desired output and the actual output
  during training. Each output that diverges more than this limit is counted as an error bit. This
  difference is divided by two when dealing with symmetric activation functions, so that symmetric
  and not symmetric activation functions can use the same limit.
  
  The default bit fail limit is 0.35.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  ニューラルネットワークリソース。

<comment>Return:</comment>
  <info>float</info>  The bit fail limit, or <info>false</info> on error.

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


id: fann_get_cascade_activation_functions
type: function
doc:
<comment>Description:</comment>
  Returns the cascade activation functions
  
  The cascade activation functions array is an array of the different activation functions used by
  the candidates
  
  See <strong>fann_get_cascade_num_candidates()</strong> for a description of which candidate neurons will be
  generated by this array.
  
  The default activation functions are <info>FANN_SIGMOID</info>, <info>FANN_SIGMOID_SYMMETRIC</info>, <info>FANN_GAUSSIAN</info>,
  <info>FANN_GAUSSIAN_SYMMETRIC</info>, <info>FANN_ELLIOT</info>, <info>FANN_ELLIOT_SYMMETRIC</info>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  ニューラルネットワークリソース。

<comment>Return:</comment>
  <info>array</info>  The cascade activation functions, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_get_cascade_activation_functions_count()</strong>
   * <strong>fann_set_cascade_activation_functions()</strong>


id: fann_get_cascade_activation_functions_count
type: function
doc:
<comment>Description:</comment>
  Returns the number of cascade activation functions
  
  The number of activation functions in the <strong>fann_get_cascade_activation_functions()</strong> array.
  
  The default number of activation functions is 6.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  ニューラルネットワークリソース。

<comment>Return:</comment>
  <info>int</info>  The number of cascade activation functions, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_get_cascade_activation_functions()</strong>
   * <strong>fann_set_cascade_activation_functions()</strong>


id: fann_get_cascade_activation_steepnesses
type: function
doc:
<comment>Description:</comment>
  Returns the cascade activation steepnesses
  
  The cascade activation steepnesses array is an array of the different activation functions used by
  the candidates.
  
  See <strong>fann_get_cascade_num_candidates()</strong> for a description of which candidate neurons will be
  generated by this array.
  
  The default activation steepnesses are {0.25, 0.50, 0.75, 1.00}.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  ニューラルネットワークリソース。

<comment>Return:</comment>
  <info>array</info>  The cascade activation steepnesses, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_get_cascade_activation_steepnesses_count()</strong>
   * <strong>fann_set_cascade_activation_steepnesses()</strong>


id: fann_get_cascade_activation_steepnesses_count
type: function
doc:
<comment>Description:</comment>
  The number of activation steepnesses
  
  The number of activation steepnesses in the <strong>fann_get_cascade_activation_functions()</strong> array.
  
  The default number of activation steepnesses is 4.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  ニューラルネットワークリソース。

<comment>Return:</comment>
  <info>int</info>  The number of activation steepnesses, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_get_cascade_activation_steepnesses()</strong>
   * <strong>fann_set_cascade_activation_functions()</strong>


id: fann_get_cascade_candidate_change_fraction
type: function
doc:
<comment>Description:</comment>
  Returns the cascade candidate change fraction
  
  The cascade candidate change fraction is a number between 0 and 1 determining how large a fraction
  the <strong>fann_get_MSE()</strong> value should change within <strong>fann_get_cascade_candidate_stagnation_epochs()</strong>
  during training of the candidate neurons, in order for the training not to stagnate. If the
  training stagnates, the training of the candidate neurons will be ended and the best candidate
  will be selected.
  
  It means that if the MSE does not change by a fraction of
  <strong>fann_get_cascade_candidate_change_fraction()</strong> during a period of
  <strong>fann_get_cascade_candidate_stagnation_epochs()</strong>, the training of the candidate neurons is stopped
  because the training has stagnated.
  
  If the cascade candidate change fraction is low, the candidate neurons will be trained more and if
  the fraction is high they will be trained less.
  
  The default cascade candidate change fraction is 0.01, which is equalent to a 1% change in MSE.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  ニューラルネットワークリソース。

<comment>Return:</comment>
  <info>float</info>  The cascade candidate change fraction, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_set_cascade_candidate_change_fraction()</strong>
   * <strong>fann_get_MSE()</strong>
   * <strong>fann_get_cascade_candidate_stagnation_epochs()</strong>


id: fann_get_cascade_candidate_limit
type: function
doc:
<comment>Description:</comment>
  Return the candidate limit
  
  The candidate limit is a limit for how much the candidate neuron may be trained. The limit is a
  limit on the proportion between the MSE and candidate score.
  
  Set this to a lower value to avoid overfitting and to a higher if overfitting is not a problem.
  
  The default candidate limit is 1000.0.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  ニューラルネットワークリソース。

<comment>Return:</comment>
  <info>float</info>  The candidate limit, or <info>false</info> on error.

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


id: fann_get_cascade_candidate_stagnation_epochs
type: function
doc:
<comment>Description:</comment>
  Returns the number of cascade candidate stagnation epochs
  
  The number of cascade candidate stagnation epochs determines the number of epochs training is
  allowed to continue without changing the MSE by a fraction of
  <strong>fann_get_cascade_candidate_change_fraction()</strong>.
  
  See more info about this parameter in <strong>fann_get_cascade_candidate_change_fraction()</strong>.
  
  The default number of cascade candidate stagnation epochs is 12.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  ニューラルネットワークリソース。

<comment>Return:</comment>
  <info>int</info>  The number of cascade candidate stagnation epochs, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_set_cascade_candidate_stagnation_epochs()</strong>
   * <strong>fann_get_cascade_candidate_change_fraction()</strong>


id: fann_get_cascade_max_cand_epochs
type: function
doc:
<comment>Description:</comment>
  Returns the maximum candidate epochs
  
  The maximum candidate epochs determines the maximum number of epochs the input connections to the
  candidates may be trained before adding a new candidate neuron.
  
  The default max candidate epochs is 150.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  ニューラルネットワークリソース。

<comment>Return:</comment>
  <info>int</info>  The maximum candidate epochs, or <info>false</info> on error.

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


id: fann_get_cascade_max_out_epochs
type: function
doc:
<comment>Description:</comment>
  Returns the maximum out epochs
  
  The maximum out epochs determines the maximum number of epochs the output connections may be
  trained after adding a new candidate neuron.
  
  The default max out epochs is 150.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  ニューラルネットワークリソース。

<comment>Return:</comment>
  <info>int</info>  The maximum out epochs, or <info>false</info> on error.

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


id: fann_get_cascade_min_cand_epochs
type: function
doc:
<comment>Description:</comment>
  Returns the minimum candidate epochs
  
  The minimum candidate epochs determines the minimum number of epochs the input connections to the
  candidates may be trained before adding a new candidate neuron.
  
  The default min candidate epochs is 50.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  ニューラルネットワークリソース。

<comment>Return:</comment>
  <info>int</info>  The minimum candidate epochs, or <info>false</info> on error.

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


id: fann_get_cascade_min_out_epochs
type: function
doc:
<comment>Description:</comment>
  Returns the minimum out epochs
  
  The minimum out epochs determines the minimum number of epochs the output connections must be
  trained after adding a new candidate neuron.
  
  The default min out epochs is 50.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  ニューラルネットワークリソース。

<comment>Return:</comment>
  <info>int</info>  The minimum out epochs, or <info>false</info> on error.

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


id: fann_get_cascade_num_candidate_groups
type: function
doc:
<comment>Description:</comment>
  Returns the number of candidate groups
  
  The number of candidate groups is the number of groups of identical candidates which will be used
  during training.
  
  This number can be used to have more candidates without having to define new parameters for the
  candidates.
  
  See <strong>fann_get_cascade_num_candidates()</strong> for a description of which candidate neurons will be
  generated by this parameter.
  
  The default number of candidate groups is 2.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  ニューラルネットワークリソース。

<comment>Return:</comment>
  <info>int</info>  The number of candidate groups, or <info>false</info> on error.

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


id: fann_get_cascade_num_candidates
type: function
doc:
<comment>Description:</comment>
  Returns the number of candidates used during training
  
  The number of candidates used during training (calculated by multiplying
  <strong>fann_get_cascade_activation_functions_count()</strong>, <strong>fann_get_cascade_activation_steepnesses_count()</strong> and
  <strong>fann_get_cascade_num_candidate_groups()</strong>).
  
  The actual candidates is defined by the <strong>fann_get_cascade_activation_functions()</strong> and
  <strong>fann_get_cascade_activation_steepnesses()</strong> arrays. These arrays define the activation functions and
  activation steepnesses used for the candidate neurons. If there are 2 activation functions in the
  activation function array and 3 steepnesses in the steepness array, then there will be 2x3=6
  different candidates which will be trained. These 6 different candidates can be copied into
  several candidate groups, where the only difference between these groups is the initial weights.
  If the number of groups is set to 2, then the number of candidate neurons will be 2x3x2=12. The
  number of candidate groups is defined by <strong>fann_set_cascade_num_candidate_groups()</strong>.
  
  The default number of candidates is 6x4x2 = 48

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  ニューラルネットワークリソース。

<comment>Return:</comment>
  <info>int</info>  The number of candidates used during training, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_get_cascade_activation_functions()</strong>
   * <strong>fann_get_cascade_activation_functions_count()</strong>
   * <strong>fann_get_cascade_activation_steepnesses()</strong>
   * <strong>fann_get_cascade_activation_steepnesses_count()</strong>
   * <strong>fann_get_cascade_num_candidate_groups()</strong>


id: fann_get_cascade_output_change_fraction
type: function
doc:
<comment>Description:</comment>
  Returns the cascade output change fraction
  
  The cascade output change fraction is a number between 0 and 1 determining how large a fraction of
  the <strong>fann_get_MSE()</strong> value should change within <strong>fann_get_cascade_output_stagnation_epochs()</strong> during
  training of the output connections, in order for the training not to stagnate. If the training
  stagnates, the training of the output connections will be ended and new candidates will be
  prepared.
  
  It means that if the MSE does not change by a fraction of
  <strong>fann_get_cascade_output_change_fraction()</strong> during a period of
  <strong>fann_get_cascade_output_stagnation_epochs()</strong>, the training of the output connections is stopped
  because the training has stagnated.
  
  If the cascade output change fraction is low, the output connections will be trained more and if
  the fraction is high, they will be trained less.
  
  The default cascade output change fraction is 0.01, which is equalent to a 1% change in MSE.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  ニューラルネットワークリソース。

<comment>Return:</comment>
  <info>float</info>  The cascade output change fraction, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_set_cascade_output_change_fraction()</strong>
   * <strong>fann_get_MSE()</strong>
   * <strong>fann_get_cascade_output_stagnation_epochs()</strong>


id: fann_get_cascade_output_stagnation_epochs
type: function
doc:
<comment>Description:</comment>
  Returns the number of cascade output stagnation epochs
  
  The number of cascade output stagnation epochs determines the number of epochs training is allowed
  to continue without changing the MSE by a fraction of <strong>fann_get_cascade_output_change_fraction()</strong>.
  
  See more info about this parameter in <strong>fann_get_cascade_output_change_fraction()</strong>.
  
  The default number of cascade output stagnation epochs is 12.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  ニューラルネットワークリソース。

<comment>Return:</comment>
  <info>int</info>  The number of cascade output stagnation epochs, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_set_cascade_output_stagnation_epochs()</strong>
   * <strong>fann_get_cascade_output_change_fraction()</strong>


id: fann_get_cascade_weight_multiplier
type: function
doc:
<comment>Description:</comment>
  Returns the weight multiplier
  
  The weight multiplier is a parameter which is used to multiply the weights from the candidate
  neuron before adding the neuron to the neural network. This parameter is usually between 0 and 1,
  and is used to make the training a bit less aggressive.
  
  The default weight multiplier is 0.4.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  ニューラルネットワークリソース。

<comment>Return:</comment>
  <info>float</info>  The weight multiplier, or <info>false</info> on error.

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


id: fann_get_connection_array
type: function
doc:
<comment>Description:</comment>
  Get connections in the network
  
  Get connections in the network.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  ニューラルネットワークリソース。

<comment>Return:</comment>
  <info>array</info>  An array of connections in the network


id: fann_get_connection_rate
type: function
doc:
<comment>Description:</comment>
  Get the connection rate used when the network was created
  
  Get the connection rate used when the network was created.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  ニューラルネットワークリソース。

<comment>Return:</comment>
  <info>float</info>  The connection rate used when the network was created, or <info>false</info> on error.


id: fann_get_errno
type: function
doc:
<comment>Description:</comment>
  Returns the last error number
  
  Returns the last error number.

<comment>Param:</comment>
  <info>resource</info>  <strong>$errdat</strong>  ニューラルネットワークリソースあるいはニューラルネットワークトレーニングリソー
                     ス。

<comment>Return:</comment>
  <info>int</info>  The error number, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_reset_errno()</strong>
   * <strong>fann_get_errstr()</strong>


id: fann_get_errstr
type: function
doc:
<comment>Description:</comment>
  Returns the last errstr
  
  Returns the last errstr.

<comment>Param:</comment>
  <info>resource</info>  <strong>$errdat</strong>  ニューラルネットワークリソースあるいはニューラルネットワークトレーニングリソー
                     ス。

<comment>Return:</comment>
  <info>string</info>  The last error string, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_reset_errstr()</strong>
   * <strong>fann_get_errno()</strong>


id: fann_get_layer_array
type: function
doc:
<comment>Description:</comment>
  Get the number of neurons in each layer in the network
  
  Get the number of neurons in each layer in the neural network.
  
  Bias is not included so the layers match the fann_create functions.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  ニューラルネットワークリソース。

<comment>Return:</comment>
  <info>array</info>  An array of numbers of neurons in each leayer


id: fann_get_learning_momentum
type: function
doc:
<comment>Description:</comment>
  Returns the learning momentum
  
  The learning momentum can be used to speed up <info>FANN_TRAIN_INCREMENTAL</info> training. A too high momentum
  will however not benefit training. Setting momentum to 0 will be the same as not using the
  momentum parameter. The recommended value of this parameter is between 0.0 and 1.0.
  
  The default momentum is 0.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  ニューラルネットワークリソース。

<comment>Return:</comment>
  <info>float</info>  成功した場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。
         
         The learning momentum, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_set_learning_momentum()</strong>
   * <strong>fann_set_training_algorithm()</strong>


id: fann_get_learning_rate
type: function
doc:
<comment>Description:</comment>
  Returns the learning rate
  
  The learning rate is used to determine how aggressive training should be for some of the training
  algorithms (<info>FANN_TRAIN_INCREMENTAL</info>, <info>FANN_TRAIN_BATCH</info>, <info>FANN_TRAIN_QUICKPROP</info>). Do however note that
  it is not used in <info>FANN_TRAIN_RPROP</info>.
  
  The default learning rate is 0.7.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  ニューラルネットワークリソース。

<comment>Return:</comment>
  <info>float</info>  The learning rate, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_set_learning_rate()</strong>
   * <strong>fann_set_training_algorithm()</strong>


id: fann_get_network_type
type: function
doc:
<comment>Description:</comment>
  Get the type of neural network it was created as
  
  Get the type of neural network it was created as.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  ニューラルネットワークリソース。

<comment>Return:</comment>
  <info>int</info>  Network type constant, or <info>false</info> on error.


id: fann_get_num_input
type: function
doc:
<comment>Description:</comment>
  Get the number of input neurons
  
  Get the number of input neurons.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  ニューラルネットワークリソース。

<comment>Return:</comment>
  <info>int</info>  Number of input neurons, or <info>false</info> on error


id: fann_get_num_layers
type: function
doc:
<comment>Description:</comment>
  Get the number of layers in the neural network
  
  Get the number of layers in the neural network.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  ニューラルネットワークリソース。

<comment>Return:</comment>
  <info>int</info>  The number of leayers in the neural network, or <info>false</info> on error.


id: fann_get_num_output
type: function
doc:
<comment>Description:</comment>
  Get the number of output neurons
  
  Get the number of output neurons.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  ニューラルネットワークリソース。

<comment>Return:</comment>
  <info>int</info>  Number of output neurons, or <info>false</info> on error


id: fann_get_quickprop_decay
type: function
doc:
<comment>Description:</comment>
  Returns the decay which is a factor that weights should decrease in each iteration during
  quickprop
  training
  
  The decay is a small negative valued number which is a factor that the weights should decrease in
  each iteration during quickprop training. This is used to make sure that the weights do not become
  too high during training.
  
  The default decay is -0.0001.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  ニューラルネットワークリソース。

<comment>Return:</comment>
  <info>float</info>  The decay, or <info>false</info> on error.

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


id: fann_get_quickprop_mu
type: function
doc:
<comment>Description:</comment>
  Returns the mu factor
  
  The mu factor is used to increase and decrease the step-size during quickprop training. The mu
  factor should always be above 1, since it would otherwise decrease the step-size when it was
  suppose to increase it.
  
  The default mu factor is 1.75.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  ニューラルネットワークリソース。

<comment>Return:</comment>
  <info>float</info>  The mu factor, or <info>false</info> on error.

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


id: fann_get_rprop_decrease_factor
type: function
doc:
<comment>Description:</comment>
  Returns the increase factor used during RPROP training
  
  The decrease factor is a value smaller than 1, which is used to decrease the step-size during
  RPROP training.
  
  The default decrease factor is 0.5.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  ニューラルネットワークリソース。

<comment>Return:</comment>
  <info>float</info>  The decrease factor, or <info>false</info> on error.

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


id: fann_get_rprop_delta_max
type: function
doc:
<comment>Description:</comment>
  Returns the maximum step-size
  
  The maximum step-size is a positive number determining how large the maximum step-size may be.
  
  The default delta max is 50.0.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  ニューラルネットワークリソース。

<comment>Return:</comment>
  <info>float</info>  The maximum step-size, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_set_rprop_delta_max()</strong>
   * <strong>fann_get_rprop_delta_min()</strong>


id: fann_get_rprop_delta_min
type: function
doc:
<comment>Description:</comment>
  Returns the minimum step-size
  
  The minimum step-size is a small positive number determining how small the minimum step-size may
  be.
  
  The default value delta min is 0.0.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  ニューラルネットワークリソース。

<comment>Return:</comment>
  <info>float</info>  The minimum step-size, or <info>false</info> on error.

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


id: fann_get_rprop_delta_zero
type: function
doc:
<comment>Description:</comment>
  Returns the initial step-size
  
  The initial step-size is a positive number determining the initial step size.
  
  The default delta zero is 0.1.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  ニューラルネットワークリソース。

<comment>Return:</comment>
  <info>int</info>  The initial step-size, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_set_rprop_delta_zero()</strong>
   * <strong>fann_get_rprop_delta_min()</strong>
   * <strong>fann_get_rprop_delta_max()</strong>


id: fann_get_rprop_increase_factor
type: function
doc:
<comment>Description:</comment>
  Returns the increase factor used during RPROP training
  
  The increase factor is a value larger than 1, which is used to increase the step-size during RPROP
  training.
  
  The default increase factor is 1.2.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  ニューラルネットワークリソース。

<comment>Return:</comment>
  <info>float</info>  The increase factor, or <info>false</info> on error.

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


id: fann_get_sarprop_step_error_shift
type: function
doc:
<comment>Description:</comment>
  Returns the sarprop step error shift
  
  Returns the sarprop step error shift.
  
  The default step error shift is 1.385.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  ニューラルネットワークリソース。

<comment>Return:</comment>
  <info>float</info>  The sarprop step error shift , or <info>false</info> on error.

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


id: fann_get_sarprop_step_error_threshold_factor
type: function
doc:
<comment>Description:</comment>
  Returns the sarprop step error threshold factor
  
  The sarprop step error threshold factor.
  
  The default factor is 0.1.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  ニューラルネットワークリソース。

<comment>Return:</comment>
  <info>float</info>  The sarprop step error threshold factor, or <info>false</info> on error.

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


id: fann_get_sarprop_temperature
type: function
doc:
<comment>Description:</comment>
  Returns the sarprop temperature
  
  Returns the sarprop temperature.
  
  The default temperature is 0.015.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  ニューラルネットワークリソース。

<comment>Return:</comment>
  <info>float</info>  The sarprop temperature, or <info>false</info> on error.

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


id: fann_get_sarprop_weight_decay_shift
type: function
doc:
<comment>Description:</comment>
  Returns the sarprop weight decay shift
  
  The sarprop weight decay shift.
  
  The default delta max is -6.644.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  ニューラルネットワークリソース。

<comment>Return:</comment>
  <info>float</info>  The sarprop weight decay shift, or <info>false</info> on error.

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


id: fann_get_total_connections
type: function
doc:
<comment>Description:</comment>
  Get the total number of connections in the entire network
  
  Get the total number of connections in the entire network.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  ニューラルネットワークリソース。

<comment>Return:</comment>
  <info>int</info>  Total number of connections in the entire network, or <info>false</info> on error


id: fann_get_total_neurons
type: function
doc:
<comment>Description:</comment>
  Get the total number of neurons in the entire network
  
  Get the total number of neurons in the entire network. This number does also include the bias
  neurons, so a 2-4-2 network has 2+4+2 +2(bias) = 10 neurons.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  ニューラルネットワークリソース。

<comment>Return:</comment>
  <info>int</info>  Total number of neurons in the entire network, or <info>false</info> on error.


id: fann_get_train_error_function
type: function
doc:
<comment>Description:</comment>
  Returns the error function used during training
  
  Returns the error function used during training.
  
  The error functions are described further in error functions constants.
  
  The default error function is <info>FANN_ERRORFUNC_TANH</info>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  ニューラルネットワークリソース。

<comment>Return:</comment>
  <info>int</info>  The error function constant, or <info>false</info> on error.

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


id: fann_get_train_stop_function
type: function
doc:
<comment>Description:</comment>
  Returns the stop function used during training
  
  Returns the stop function used during training.
  
  The stop functions are described further in stop functions constants.
  
  The default stop function is <info>FANN_STOPFUNC_MSE</info>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  ニューラルネットワークリソース。

<comment>Return:</comment>
  <info>int</info>  The stop function constant, or <info>false</info> on error.

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


id: fann_get_training_algorithm
type: function
doc:
<comment>Description:</comment>
  Returns the training algorithm
  
  Returns the training algorithm. This training algorithm is used by <strong>fann_train_on_data()</strong> and
  associated functions.
  
  Note that this algorithm is also used during <strong>fann_cascadetrain_on_data()</strong>, although only
  <info>FANN_TRAIN_RPROP</info> and <info>FANN_TRAIN_QUICKPROP</info> is allowed during cascade training.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  ニューラルネットワークリソース。

<comment>Return:</comment>
  <info>int</info>  Training algorithm constant, or <info>false</info> on error.

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


id: fann_init_weights
type: function
doc:
<comment>Description:</comment>
  Initialize the weights using Widrow + Nguyen’s algorithm
  
  Initialize the weights using Widrow + Nguyen’s algorithm.
  
  This function behaves similarly to <strong>fann_randomize_weights()</strong>. It will use the algorithm developed
  by Derrick Nguyen and Bernard Widrow to set the weights in such a way as to speed up training.
  This technique is not always successful, and in some cases can be less efficient than a purely
  random initialization.
  
  The algorithm requires access to the range of the input data (for example largest and smallest
  input), and therefore accepts a second argument, data, which is the training data that will be
  used to train the network.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>         ニューラルネットワークリソース。
  <info>resource</info>  <strong>$train_data</strong>  ニューラルネットワークトレーニングリソース。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>fann_randomize_weights()</strong>
   * <strong>fann_read_train_from_file()</strong>


id: fann_length_train_data
type: function
doc:
<comment>Description:</comment>
  Returns the number of training patterns in the train data
  
  Returns the number of training patterns in the train data <info>resource</info>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$data</strong>  ニューラルネットワークトレーニングリソース。

<comment>Return:</comment>
  <info>int</info>  Number of elements in the train data <info>resource</info>, or <info>false</info> on error.


id: fann_merge_train_data
type: function
doc:
<comment>Description:</comment>
  Merges the train data
  
  Merges the data from data1 and data2 into a new train data <info>resource</info>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$data1</strong>  ニューラルネットワークトレーニングリソース。
  <info>resource</info>  <strong>$data2</strong>  ニューラルネットワークトレーニングリソース。

<comment>Return:</comment>
  <info>resource</info>  New merged train data <info>resource</info>, or <info>false</info> on error.


id: fann_num_input_train_data
type: function
doc:
<comment>Description:</comment>
  Returns the number of inputs in each of the training patterns in the train data
  
  Returns the number of inputs in each of the training patterns in the train data <info>resource</info>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$data</strong>  ニューラルネットワークトレーニングリソース。

<comment>Return:</comment>
  <info>int</info>  The number of inputs, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_length_train_data()</strong>
   * <strong>fann_num_output_train_data()</strong>


id: fann_num_output_train_data
type: function
doc:
<comment>Description:</comment>
  Returns the number of outputs in each of the training patterns in the train data
  
  Returns the number of outputs in each of the training patterns in the train data <info>resource</info>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$data</strong>  ニューラルネットワークトレーニングリソース。

<comment>Return:</comment>
  <info>int</info>  The number of outputs, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_length_train_data()</strong>
   * <strong>fann_num_input_train_data()</strong>


id: fann_print_error
type: function
doc:
<comment>Description:</comment>
  Prints the error string
  
  Prints the error string.

<comment>Param:</comment>
  <info>resource</info>  <strong>$errdat</strong>  ニューラルネットワークリソースあるいはニューラルネットワークトレーニングリソー
                     ス。

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

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


id: fann_randomize_weights
type: function
doc:
<comment>Description:</comment>
  Give each connection a random weight between min_weight and max_weight
  
  Give each connection a random weight between <strong>$min_weight</strong> and <strong>$max_weight</strong>
  
  From the beginning the weights are random between -0.1 and 0.1.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>         ニューラルネットワークリソース。
  <info>float</info>     <strong>$min_weight</strong>  Minimum weight value
  <info>float</info>     <strong>$max_weight</strong>  Maximum weight value

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

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


id: fann_read_train_from_file
type: function
doc:
<comment>Description:</comment>
  Reads a file that stores training data
  
  Reads a file that stores training data.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  The input file in the following format:

<comment>Return:</comment>
  <info>resource</info>  成功した場合にニューラルネットワークトレーニングリソース、エラー時に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>fann_train_on_data()</strong>
   * <strong>fann_destroy_train()</strong>
   * <strong>fann_save_train()</strong>


id: fann_reset_MSE
type: function
doc:
<comment>Description:</comment>
  Resets the mean square error from the network
  
  Resets the mean square error from the network.
  
  This function also resets the number of bits that fail.

<comment>Param:</comment>
  <info>string</info>  <strong>$ann</strong>  ニューラルネットワークリソース。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>fann_get_MSE()</strong>
   * <strong>fann_get_bit_fail()</strong>
   * <strong>fann_get_bit_fail_limit()</strong>


id: fann_reset_errno
type: function
doc:
<comment>Description:</comment>
  Resets the last error number
  
  Resets the last error number.

<comment>Param:</comment>
  <info>resource</info>  <strong>$errdat</strong>  ニューラルネットワークリソースあるいはニューラルネットワークトレーニングリソー
                     ス。

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

<comment>See Also:</comment>
   * <strong>fann_get_errno()</strong>
   * <strong>fann_reset_errstr()</strong>


id: fann_reset_errstr
type: function
doc:
<comment>Description:</comment>
  Resets the last error string
  
  Resets the last error string.

<comment>Param:</comment>
  <info>resource</info>  <strong>$errdat</strong>  ニューラルネットワークリソースあるいはニューラルネットワークトレーニングリソー
                     ス。

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

<comment>See Also:</comment>
   * <strong>fann_get_errstr()</strong>
   * <strong>fann_reset_errno()</strong>


id: fann_run
type: function
doc:
<comment>Description:</comment>
  Will run input through the neural network
  
  Will run input through the neural network, returning an array of outputs, the number of which
  being equal to the number of neurons in the output layer.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>    ニューラルネットワークリソース。
  <info>array</info>     <strong>$input</strong>  Array of input values

<comment>Return:</comment>
  <info>array</info>  Array of output values, or <info>false</info> on error


id: fann_save
type: function
doc:
<comment>Description:</comment>
  Saves the entire network to a configuration file
  
  Saves the entire network to a configuration file.
  
  The configuration file contains all information about the neural network and enables
  <strong>fann_create_from_file()</strong> to create an exact copy of the neural network and all of the parameters
  associated with the neural network.
  
  These three parameters (<strong>fann_set_callback()</strong>, <strong>fann_set_error_log()</strong>, <strong>fann_set_user_data()</strong>) are NOT
  saved to the file because they cannot safely be ported to a different location. Also temporary
  parameters generated during training like <strong>fann_get_MSE()</strong> is not saved.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                 ニューラルネットワークリソース。
  <info>string</info>    <strong>$configuration_file</strong>  The configuration file path.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

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


id: fann_save_train
type: function
doc:
<comment>Description:</comment>
  Save the training structure to a file
  
  Save the training data to a file, with the format as specified in <strong>fann_read_train_from_file()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$data</strong>       ニューラルネットワークトレーニングリソース。
  <info>string</info>    <strong>$file_name</strong>  The file name of the file where training data is saved to.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

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


id: fann_scale_input
type: function
doc:
<comment>Description:</comment>
  Scale data in input vector before feed it to ann based on previously calculated parameters
  
  Scale data in input vector before feed it to ann based on previously calculated parameters.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>           ニューラルネットワークリソース。
  <info>array</info>     <strong>$input_vector</strong>  Input vector that will be scaled

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>fann_descale_input()</strong>
   * <strong>fann_scale_output()</strong>


id: fann_scale_input_train_data
type: function
doc:
<comment>Description:</comment>
  Scales the inputs in the training data to the specified range
  
  Scales the inputs in the training data to the specified range.

<comment>Param:</comment>
  <info>resource</info>  <strong>$train_data</strong>  ニューラルネットワークトレーニングリソース。
  <info>float</info>     <strong>$new_min</strong>     New minimum after scaling inputs in training data.
  <info>float</info>     <strong>$new_max</strong>     New maximum after scaling inputs in training data.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>fann_scale_output_train_data()</strong>
   * <strong>fann_scale_train_data()</strong>


id: fann_scale_output
type: function
doc:
<comment>Description:</comment>
  Scale data in output vector before feed it to ann based on previously calculated parameters
  
  Scale data in output vector before feed it to ann based on previously calculated parameters.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>            ニューラルネットワークリソース。
  <info>array</info>     <strong>$output_vector</strong>  Output vector that will be scaled

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>fann_descale_output()</strong>
   * <strong>fann_scale_input()</strong>


id: fann_scale_output_train_data
type: function
doc:
<comment>Description:</comment>
  Scales the outputs in the training data to the specified range
  
  Scales the outputs in the training data to the specified range.

<comment>Param:</comment>
  <info>resource</info>  <strong>$train_data</strong>  ニューラルネットワークトレーニングリソース。
  <info>float</info>     <strong>$new_min</strong>     New minimum after scaling outputs in training data.
  <info>float</info>     <strong>$new_max</strong>     New maximum after scaling outputs in training data.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>fann_scale_input_train_data()</strong>
   * <strong>fann_scale_train_data()</strong>


id: fann_scale_train
type: function
doc:
<comment>Description:</comment>
  Scale input and output data based on previously calculated parameters
  
  Scale input and output data based on previously calculated parameters.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>         ニューラルネットワークリソース。
  <info>resource</info>  <strong>$train_data</strong>  ニューラルネットワークトレーニングリソース。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>fann_descale_train()</strong>
   * <strong>fann_set_scaling_params()</strong>


id: fann_scale_train_data
type: function
doc:
<comment>Description:</comment>
  Scales the inputs and outputs in the training data to the specified range
  
  Scales the inputs and outputs in the training data to the specified range.

<comment>Param:</comment>
  <info>resource</info>  <strong>$train_data</strong>  ニューラルネットワークトレーニングリソース。
  <info>float</info>     <strong>$new_min</strong>     New minimum after scaling inputs and outputs in training data.
  <info>float</info>     <strong>$new_max</strong>     New maximum after scaling inputs and outputs in training data.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>fann_scale_output_train_data()</strong>
   * <strong>fann_scale_input_train_data()</strong>


id: fann_set_activation_function
type: function
doc:
<comment>Description:</comment>
  Sets the activation function for supplied neuron and layer
  
  Set the activation function for neuron number <return>neuron</return> in layer number <return>layer</return>, counting the input
  layer as layer 0.
  
  It is not possible to set activation functions for the neurons in the input layer.
  
  When choosing an activation function it is important to note that the activation functions have
  different range. <info>FANN_SIGMOID</info> is e.g. in the 0 - 1 range while <info>FANN_SIGMOID_SYMMETRIC</info> is in the -1
  - 1 range and <info>FANN_LINEAR</info> is unbound.
  
  The supplied activation_function value must be one of the activation functions constants.
  
  The return value is one of the activation functions constants.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                  ニューラルネットワークリソース。
  <info>int</info>       <strong>$activation_function</strong>  The activation functions constant.
  <info>int</info>       <strong>$layer</strong>                Layer number.
  <info>int</info>       <strong>$neuron</strong>               Neuron number.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>fann_set_activation_function_layer()</strong>
   * <strong>fann_set_activation_function_hidden()</strong>
   * <strong>fann_set_activation_function_output()</strong>
   * <strong>fann_set_activation_steepness()</strong>
   * <strong>fann_get_activation_function()</strong>


id: fann_set_activation_function_hidden
type: function
doc:
<comment>Description:</comment>
  Sets the activation function for all of the hidden layers
  
  Sets the activation function for all of the hidden layers.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                  ニューラルネットワークリソース。
  <info>int</info>       <strong>$activation_function</strong>  The activation functions constant.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>fann_set_activation_function()</strong>
   * <strong>fann_set_activation_function_layer()</strong>
   * <strong>fann_set_activation_function_output()</strong>
   * <strong>fann_set_activation_steepness()</strong>


id: fann_set_activation_function_layer
type: function
doc:
<comment>Description:</comment>
  Sets the activation function for all the neurons in the supplied layer
  
  Set the activation function for all the neurons in the layer number <return>layer</return>, counting the input
  layer as layer 0.
  
  It is not possible to set activation functions for the neurons in the input layer.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                  ニューラルネットワークリソース。
  <info>int</info>       <strong>$activation_function</strong>  The activation functions constant.
  <info>int</info>       <strong>$layer</strong>                Layer number.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>fann_set_activation_function()</strong>
   * <strong>fann_set_activation_function_hidden()</strong>
   * <strong>fann_set_activation_function_output()</strong>
   * <strong>fann_set_activation_steepness()</strong>


id: fann_set_activation_function_output
type: function
doc:
<comment>Description:</comment>
  Sets the activation function for the output layer
  
  Sets the activation function for the output layer.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                  ニューラルネットワークリソース。
  <info>int</info>       <strong>$activation_function</strong>  The activation functions constant.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>fann_set_activation_function()</strong>
   * <strong>fann_set_activation_function_layer()</strong>
   * <strong>fann_set_activation_function_hidden()</strong>
   * <strong>fann_set_activation_steepness()</strong>


id: fann_set_activation_steepness
type: function
doc:
<comment>Description:</comment>
  Sets the activation steepness for supplied neuron and layer number
  
  Set the activation steepness for neuron number <return>neuron</return> in layer number <return>layer</return>, counting the input
  layer as layer 0.
  
  It is not possible to set activation steepness for the neurons in the input layer.
  
  The steepness of an activation function says something about how fast the activation function goes
  from the minimum to the maximum. A high value for the activation function will also give a more
  aggressive training.
  
  When training neural networks where the output values should be at the extremes (usually 0 and 1,
  depending on the activation function), a steep activation function can be used (e.g.  1.0).
  
  The default activation steepness is 0.5.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                   ニューラルネットワークリソース。
  <info>float</info>     <strong>$activation_steepness</strong>  The activation steepness.
  <info>int</info>       <strong>$layer</strong>                 Layer number.
  <info>int</info>       <strong>$neuron</strong>                Neuron number.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>fann_set_activation_steepness_layer()</strong>
   * <strong>fann_set_activation_steepness_hidden()</strong>
   * <strong>fann_set_activation_steepness_output()</strong>
   * <strong>fann_get_activation_steepness()</strong>
   * <strong>fann_set_activation_function()</strong>


id: fann_set_activation_steepness_hidden
type: function
doc:
<comment>Description:</comment>
  Sets the steepness of the activation steepness for all neurons in the all hidden layers
  
  Sets the steepness of the activation steepness for all neurons in the all hidden layers.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                   ニューラルネットワークリソース。
  <info>float</info>     <strong>$activation_steepness</strong>  The activation steepness.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>fann_set_activation_steepness()</strong>
   * <strong>fann_set_activation_steepness_layer()</strong>
   * <strong>fann_set_activation_steepness_output()</strong>
   * <strong>fann_get_activation_steepness()</strong>
   * <strong>fann_set_activation_function()</strong>


id: fann_set_activation_steepness_layer
type: function
doc:
<comment>Description:</comment>
  Sets the activation steepness for all of the neurons in the supplied layer number
  
  Set the activation steepness for all of the neurons in layer number <return>layer</return>, counting the input
  layer as layer 0.
  
  It is not possible to set activation steepness for the neurons in the input layer.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                   ニューラルネットワークリソース。
  <info>float</info>     <strong>$activation_steepness</strong>  The activation steepness.
  <info>int</info>       <strong>$layer</strong>                 Layer number.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>fann_set_activation_steepness()</strong>
   * <strong>fann_set_activation_steepness_hidden()</strong>
   * <strong>fann_set_activation_steepness_output()</strong>
   * <strong>fann_get_activation_steepness()</strong>
   * <strong>fann_set_activation_function()</strong>


id: fann_set_activation_steepness_output
type: function
doc:
<comment>Description:</comment>
  Sets the steepness of the activation steepness in the output layer
  
  Sets the steepness of the activation steepness in the output layer.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                   ニューラルネットワークリソース。
  <info>float</info>     <strong>$activation_steepness</strong>  The activation steepness.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>fann_set_activation_steepness()</strong>
   * <strong>fann_set_activation_steepness_layer()</strong>
   * <strong>fann_set_activation_steepness_hidden()</strong>
   * <strong>fann_get_activation_steepness()</strong>
   * <strong>fann_set_activation_function()</strong>


id: fann_set_bit_fail_limit
type: function
doc:
<comment>Description:</comment>
  Set the bit fail limit used during training
  
  Set the bit fail limit used during training.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>             ニューラルネットワークリソース。
  <info>float</info>     <strong>$bit_fail_limit</strong>  The bit fail limit.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

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


id: fann_set_callback
type: function
doc:
<comment>Description:</comment>
  Sets the callback function for use during training
  
  Sets the callback function for use during training. It means that it is called from
  <strong>fann_train_on_data()</strong> or <strong>fann_train_on_file()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>       ニューラルネットワークリソース。
  <info>callable</info>  <strong>$callback</strong>  The supplied callback function takes following parameters: <return>ann</return> - The neural
                       network <info>resource</info><return>train</return> - The train data <info>resource</info> or <info>null</info> if called from
                       <strong>fann_train_on_file()</strong><return>max_epochs</return> - The maximum number of epochs the training
                       should continue<return>epochs_between_reports</return> - The number of epochs between calling
                       this function<return>desired_error</return> - The desired <strong>fann_get_MSE()</strong> or
                       <strong>fann_get_bit_fail()</strong>, depending on the stop function chosen by
                       <strong>fann_set_train_stop_function()</strong><return>epochs</return> - The current epoch
                       
                       The callback should return <info>true</info>. If it returns <info>false</info>, the training will
                       terminate.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>fann_train_on_data()</strong>
   * <strong>fann_train_on_file()</strong>


id: fann_set_cascade_activation_functions
type: function
doc:
<comment>Description:</comment>
  Sets the array of cascade candidate activation functions
  
  Sets the array of cascade candidate activation functions.
  
  See <strong>fann_get_cascade_num_candidates()</strong> for a description of which candidate neurons will be
  generated by this array.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                           ニューラルネットワークリソース。
  <info>array</info>     <strong>$cascade_activation_functions</strong>  The array of cascade candidate activation functions.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>fann_get_cascade_activation_functions_count()</strong>
   * <strong>fann_set_cascade_activation_functions()</strong>


id: fann_set_cascade_activation_steepnesses
type: function
doc:
<comment>Description:</comment>
  Sets the array of cascade candidate activation steepnesses
  
  Sets the array of cascade candidate activation steepnesses.
  
  See <strong>fann_get_cascade_num_candidates()</strong> for a description of which candidate neurons will be
  generated by this array.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                                   ニューラルネットワークリソース。
  <info>array</info>     <strong>$cascade_activation_steepnesses_count</strong>  The array of cascade candidate activation
                                                   steepnesses.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>fann_get_cascade_activation_steepnesses()</strong>
   * <strong>fann_get_cascade_activation_steepnesses_count()</strong>


id: fann_set_cascade_candidate_change_fraction
type: function
doc:
<comment>Description:</comment>
  Sets the cascade candidate change fraction
  
  Sets the cascade candidate change fraction.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                                ニューラルネットワークリソース。
  <info>float</info>     <strong>$cascade_candidate_change_fraction</strong>  The cascade candidate change fraction.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

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


id: fann_set_cascade_candidate_limit
type: function
doc:
<comment>Description:</comment>
  Sets the candidate limit
  
  Sets the candidate limit.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                      ニューラルネットワークリソース。
  <info>float</info>     <strong>$cascade_candidate_limit</strong>  The candidate limit.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

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


id: fann_set_cascade_candidate_stagnation_epochs
type: function
doc:
<comment>Description:</comment>
  Sets the number of cascade candidate stagnation epochs
  
  Sets the number of cascade candidate stagnation epochs.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                                  ニューラルネットワークリソース。
  <info>int</info>       <strong>$cascade_candidate_stagnation_epochs</strong>  The number of cascade candidate stagnation epochs.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

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


id: fann_set_cascade_max_cand_epochs
type: function
doc:
<comment>Description:</comment>
  Sets the max candidate epochs
  
  Sets the max candidate epochs.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                      ニューラルネットワークリソース。
  <info>int</info>       <strong>$cascade_max_cand_epochs</strong>  The max candidate epochs.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

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


id: fann_set_cascade_max_out_epochs
type: function
doc:
<comment>Description:</comment>
  Sets the maximum out epochs
  
  Sets the maximum out epochs.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                     ニューラルネットワークリソース。
  <info>int</info>       <strong>$cascade_max_out_epochs</strong>  The maximum out epochs.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

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


id: fann_set_cascade_min_cand_epochs
type: function
doc:
<comment>Description:</comment>
  Sets the min candidate epochs
  
  Sets the min candidate epochs.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                      ニューラルネットワークリソース。
  <info>int</info>       <strong>$cascade_min_cand_epochs</strong>  The minimum candidate epochs.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

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


id: fann_set_cascade_min_out_epochs
type: function
doc:
<comment>Description:</comment>
  Sets the minimum out epochs
  
  Sets the minimum out epochs.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                     ニューラルネットワークリソース。
  <info>int</info>       <strong>$cascade_min_out_epochs</strong>  The minimum out epochs.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

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


id: fann_set_cascade_num_candidate_groups
type: function
doc:
<comment>Description:</comment>
  Sets the number of candidate groups
  
  Sets the number of candidate groups.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                           ニューラルネットワークリソース。
  <info>int</info>       <strong>$cascade_num_candidate_groups</strong>  The number of candidate groups.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

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


id: fann_set_cascade_output_change_fraction
type: function
doc:
<comment>Description:</comment>
  Sets the cascade output change fraction
  
  Sets the cascade output change fraction.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                             ニューラルネットワークリソース。
  <info>float</info>     <strong>$cascade_output_change_fraction</strong>  The cascade output change fraction.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

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


id: fann_set_cascade_output_stagnation_epochs
type: function
doc:
<comment>Description:</comment>
  Sets the number of cascade output stagnation epochs
  
  Sets the number of cascade output stagnation epochs.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                               ニューラルネットワークリソース。
  <info>int</info>       <strong>$cascade_output_stagnation_epochs</strong>  The number of cascade output stagnation epochs.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

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


id: fann_set_cascade_weight_multiplier
type: function
doc:
<comment>Description:</comment>
  Sets the weight multiplier
  
  Sets the weight multiplier.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                        ニューラルネットワークリソース。
  <info>float</info>     <strong>$cascade_weight_multiplier</strong>  The weight multiplier.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

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


id: fann_set_error_log
type: function
doc:
<comment>Description:</comment>
  Sets where the errors are logged to
  
  Sets where the errors are logged to.

<comment>Param:</comment>
  <info>resource</info>  <strong>$errdat</strong>    ニューラルネットワークリソースあるいはニューラルネットワークトレーニングリ
                       ソース。
  <info>string</info>    <strong>$log_file</strong>  The log file path.

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


id: fann_set_input_scaling_params
type: function
doc:
<comment>Description:</comment>
  Calculate input scaling parameters for future use based on training data
  
  Calculate input scaling parameters for future use based on training data.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>            ニューラルネットワークリソース。
  <info>resource</info>  <strong>$train_data</strong>     ニューラルネットワークトレーニングリソース。
  <info>float</info>     <strong>$new_input_min</strong>  The desired lower bound in input data after scaling (not strictly
                            followed)
  <info>float</info>     <strong>$new_input_max</strong>  The desired upper bound in input data after scaling (not strictly
                            followed)

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

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


id: fann_set_learning_momentum
type: function
doc:
<comment>Description:</comment>
  Sets the learning momentum
  
  Sets the learning momentum.
  
  More info available in <strong>fann_get_learning_momentum()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                ニューラルネットワークリソース。
  <info>float</info>     <strong>$learning_momentum</strong>  The learning momentum.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>fann_get_learning_momentum()</strong>
   * <strong>fann_set_training_algorithm()</strong>


id: fann_set_learning_rate
type: function
doc:
<comment>Description:</comment>
  Sets the learning rate
  
  Sets the learning rate.
  
  More info available in <strong>fann_get_learning_rate()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>            ニューラルネットワークリソース。
  <info>float</info>     <strong>$learning_rate</strong>  The learning rate.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>fann_get_learning_rate()</strong>
   * <strong>fann_set_training_algorithm()</strong>


id: fann_set_output_scaling_params
type: function
doc:
<comment>Description:</comment>
  Calculate output scaling parameters for future use based on training data
  
  Calculate output scaling parameters for future use based on training data.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>             ニューラルネットワークリソース。
  <info>resource</info>  <strong>$train_data</strong>      ニューラルネットワークトレーニングリソース。
  <info>float</info>     <strong>$new_output_min</strong>  The desired lower bound in output data after scaling (not strictly
                             followed)
  <info>float</info>     <strong>$new_output_max</strong>  The desired upper bound in output data after scaling (not strictly
                             followed)

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

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


id: fann_set_quickprop_decay
type: function
doc:
<comment>Description:</comment>
  Sets the quickprop decay factor
  
  Sets the quickprop decay factor.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>              ニューラルネットワークリソース。
  <info>float</info>     <strong>$quickprop_decay</strong>  The quickprop decay factor.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

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


id: fann_set_quickprop_mu
type: function
doc:
<comment>Description:</comment>
  Sets the quickprop mu factor
  
  Sets the quickprop mu factor.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>           ニューラルネットワークリソース。
  <info>float</info>     <strong>$quickprop_mu</strong>  The mu factor.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

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


id: fann_set_rprop_decrease_factor
type: function
doc:
<comment>Description:</comment>
  Sets the decrease factor used during RPROP training
  
  Sets the decrease factor used during RPROP training.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                    ニューラルネットワークリソース。
  <info>float</info>     <strong>$rprop_decrease_factor</strong>  The decrease factor.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

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


id: fann_set_rprop_delta_max
type: function
doc:
<comment>Description:</comment>
  Sets the maximum step-size
  
  The maximum step-size is a positive number determining how large the maximum step-size may be.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>              ニューラルネットワークリソース。
  <info>float</info>     <strong>$rprop_delta_max</strong>  The maximum step-size.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>fann_get_rprop_delta_max()</strong>
   * <strong>fann_get_rprop_delta_min()</strong>


id: fann_set_rprop_delta_min
type: function
doc:
<comment>Description:</comment>
  Sets the minimum step-size
  
  The minimum step-size is a small positive number determining how small the minimum step-size may
  be.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>              ニューラルネットワークリソース。
  <info>float</info>     <strong>$rprop_delta_min</strong>  The minimum step-size.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

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


id: fann_set_rprop_delta_zero
type: function
doc:
<comment>Description:</comment>
  Sets the initial step-size
  
  The initial step-size is a positive number determining the initial step size.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>               ニューラルネットワークリソース。
  <info>float</info>     <strong>$rprop_delta_zero</strong>  The initial step-size.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>fann_get_rprop_delta_zero()</strong>
   * <strong>fann_get_rprop_delta_min()</strong>
   * <strong>fann_get_rprop_delta_max()</strong>


id: fann_set_rprop_increase_factor
type: function
doc:
<comment>Description:</comment>
  Sets the increase factor used during RPROP training
  
  Sets the increase factor used during RPROP training.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                    ニューラルネットワークリソース。
  <info>float</info>     <strong>$rprop_increase_factor</strong>  The increase factor.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

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


id: fann_set_sarprop_step_error_shift
type: function
doc:
<comment>Description:</comment>
  Sets the sarprop step error shift
  
  Sets the sarprop step error shift.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                       ニューラルネットワークリソース。
  <info>float</info>     <strong>$sarprop_step_error_shift</strong>  The sarprop step error shift.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

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


id: fann_set_sarprop_step_error_threshold_factor
type: function
doc:
<comment>Description:</comment>
  Sets the sarprop step error threshold factor
  
  Sets the sarprop step error threshold factor.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                                  ニューラルネットワークリソース。
  <info>float</info>     <strong>$sarprop_step_error_threshold_factor</strong>  The sarprop step error threshold factor.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

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


id: fann_set_sarprop_temperature
type: function
doc:
<comment>Description:</comment>
  Sets the sarprop temperature
  
  Sets the sarprop temperature.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                  ニューラルネットワークリソース。
  <info>float</info>     <strong>$sarprop_temperature</strong>  The sarprop temperature.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

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


id: fann_set_sarprop_weight_decay_shift
type: function
doc:
<comment>Description:</comment>
  Sets the sarprop weight decay shift
  
  Sets the sarprop weight decay shift.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                         ニューラルネットワークリソース。
  <info>float</info>     <strong>$sarprop_weight_decay_shift</strong>  The sarprop weight decay shift.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

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


id: fann_set_scaling_params
type: function
doc:
<comment>Description:</comment>
  Calculate input and output scaling parameters for future use based on training data
  
  Calculate input and output scaling parameters for future use based on training data.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>             ニューラルネットワークリソース。
  <info>resource</info>  <strong>$train_data</strong>      ニューラルネットワークトレーニングリソース。
  <info>float</info>     <strong>$new_input_min</strong>   The desired lower bound in input data after scaling (not strictly
                             followed)
  <info>float</info>     <strong>$new_input_max</strong>   The desired upper bound in input data after scaling (not strictly
                             followed)
  <info>float</info>     <strong>$new_output_min</strong>  The desired lower bound in output data after scaling (not strictly
                             followed)
  <info>float</info>     <strong>$new_output_max</strong>  The desired upper bound in output data after scaling (not strictly
                             followed)

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>fann_set_input_scaling_params()</strong>
   * <strong>fann_set_output_scaling_params()</strong>


id: fann_set_train_error_function
type: function
doc:
<comment>Description:</comment>
  Sets the error function used during training
  
  Sets the error function used during training.
  
  The error functions are described further in error functions constants.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>             ニューラルネットワークリソース。
  <info>int</info>       <strong>$error_function</strong>  The error function constant

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

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


id: fann_set_train_stop_function
type: function
doc:
<comment>Description:</comment>
  Sets the stop function used during training
  
  Sets the stop function used during training.
  
  The stop functions are described further in stop functions constants.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>            ニューラルネットワークリソース。
  <info>int</info>       <strong>$stop_function</strong>  The stop function constant.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

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


id: fann_set_training_algorithm
type: function
doc:
<comment>Description:</comment>
  Sets the training algorithm
  
  Sets the training algorithm.
  
  More info available in <strong>fann_get_training_algorithm()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                 ニューラルネットワークリソース。
  <info>int</info>       <strong>$training_algorithm</strong>  Training algorithm constant

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

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


id: fann_set_weight
type: function
doc:
<comment>Description:</comment>
  Set a connection in the network
  
  Set a connections in the network.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>          ニューラルネットワークリソース。
  <info>int</info>       <strong>$from_neuron</strong>  The neuron where the connection starts
  <info>int</info>       <strong>$to_neuron</strong>    The neuron where the connection ends
  <info>float</info>     <strong>$weight</strong>       Connection weight

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。


id: fann_set_weight_array
type: function
doc:
<comment>Description:</comment>
  Set connections in the network
  
  Set connections in the network.
  
  Only the weights can be changed, connections and weights are ignored if they do not already exist
  in the network.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>          ニューラルネットワークリソース。
  <info>array</info>     <strong>$connections</strong>  An array of <class>FANNConnection</class> objects

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。


id: fann_shuffle_train_data
type: function
doc:
<comment>Description:</comment>
  Shuffles training data, randomizing the order
  
  Shuffles training data, randomizing the order. This is recommended for incremental training, while
  it have no influence during batch training.

<comment>Param:</comment>
  <info>resource</info>  <strong>$train_data</strong>  ニューラルネットワークトレーニングリソース。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。


id: fann_subset_train_data
type: function
doc:
<comment>Description:</comment>
  Returns an copy of a subset of the train data
  
  Returns an copy of a subset of the train data <info>resource</info>, starting at position <return>pos</return> and <return>length</return>
  elements forward.
  
  The <return>fann_subset_train_data(train_data, 0, fann_length_train_data(train_data))</return> do the same as
  <strong>fann_duplicate_train_data()</strong>

<comment>Param:</comment>
  <info>resource</info>  <strong>$data</strong>    ニューラルネットワークトレーニングリソース。
  <info>int</info>       <strong>$pos</strong>     Starting position.
  <info>int</info>       <strong>$length</strong>  The number of copied elements.

<comment>Return:</comment>
  <info>resource</info>  成功した場合にニューラルネットワークトレーニングリソース、エラー時に <info>false</info> を返します。

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


id: fann_test
type: function
doc:
<comment>Description:</comment>
  Test with a set of inputs, and a set of desired outputs
  
  Test with a set of inputs, and a set of desired outputs. This operation updates the mean square
  error, but does not change the network in any way.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>             ニューラルネットワークリソース。
  <info>array</info>     <strong>$input</strong>           An array of inputs. This array must be exactly <strong>fann_get_num_input()</strong>
                             long.
  <info>array</info>     <strong>$desired_output</strong>  An array of desired outputs. This array must be exactly
                             <strong>fann_get_num_output()</strong> long.

<comment>Return:</comment>
  <info>array</info>  Returns test outputs on success, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_test_data()</strong>
   * <strong>fann_train()</strong>
   * <strong>fann_get_num_input()</strong>
   * <strong>fann_get_num_output()</strong>


id: fann_test_data
type: function
doc:
<comment>Description:</comment>
  Test a set of training data and calculates the MSE for the training data
  
  Test a set of training data and calculates the MSE for the training data.
  
  This function updates the MSE and the bit fail values.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>   ニューラルネットワークリソース。
  <info>resource</info>  <strong>$data</strong>  ニューラルネットワークトレーニングリソース。

<comment>Return:</comment>
  <info>float</info>  The updated MSE, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_train_on_data()</strong>
   * <strong>fann_train_epoch()</strong>
   * <strong>fann_get_bit_fail()</strong>
   * <strong>fann_get_MSE()</strong>
   * <strong>fann_set_training_algorithm()</strong>


id: fann_train
type: function
doc:
<comment>Description:</comment>
  Train one iteration with a set of inputs, and a set of desired outputs
  
  Train one iteration with a set of inputs, and a set of desired outputs. This training is always
  incremental training, since only one pattern is presented.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>             ニューラルネットワークリソース。
  <info>array</info>     <strong>$input</strong>           An array of inputs. This array must be exactly <strong>fann_get_num_input()</strong>
                             long.
  <info>array</info>     <strong>$desired_output</strong>  An array of desired outputs. This array must be exactly
                             <strong>fann_get_num_output()</strong> long.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>fann_train_on_data()</strong>
   * <strong>fann_train_epoch()</strong>
   * <strong>fann_get_num_input()</strong>
   * <strong>fann_get_num_output()</strong>


id: fann_train_epoch
type: function
doc:
<comment>Description:</comment>
  Train one epoch with a set of training data
  
  Train one epoch with the training data stored in data. One epoch is where all of the training data
  is considered exactly once.
  
  This function returns the MSE error as it is calculated either before or during the actual
  training. This is not the actual MSE after the training epoch, but since calculating this will
  require to go through the entire training set once more. It is more than adequate to use this
  value during training.
  
  The training algorithm used by this function is chosen by <strong>fann_set_training_algorithm()</strong> function.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>   ニューラルネットワークリソース。
  <info>resource</info>  <strong>$data</strong>  ニューラルネットワークトレーニングリソース。

<comment>Return:</comment>
  <info>float</info>  The MSE, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_train_on_data()</strong>
   * <strong>fann_test_data()</strong>
   * <strong>fann_get_MSE()</strong>
   * <strong>fann_set_training_algorithm()</strong>


id: fann_train_on_data
type: function
doc:
<comment>Description:</comment>
  Trains on an entire dataset for a period of time
  
  Trains on an entire dataset for a period of time.
  
  This training uses the training algorithm chosen by <strong>fann_set_training_algorithm()</strong> and the
  parameters set for these training algorithms.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                     ニューラルネットワークリソース。
  <info>resource</info>  <strong>$data</strong>                    ニューラルネットワークトレーニングリソース。
  <info>int</info>       <strong>$max_epochs</strong>              The maximum number of epochs the training should continue
  <info>int</info>       <strong>$epochs_between_reports</strong>  The number of epochs between calling a callback function. A
                                     value of zero means that user function is not called.
  <info>float</info>     <strong>$desired_error</strong>           The desired <strong>fann_get_MSE()</strong> or <strong>fann_get_bit_fail()</strong>, depending on
                                     the stop function chosen by <strong>fann_set_train_stop_function()</strong>

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>fann_train_on_file()</strong>
   * <strong>fann_train_epoch()</strong>
   * <strong>fann_get_bit_fail()</strong>
   * <strong>fann_get_MSE()</strong>
   * <strong>fann_set_train_stop_function()</strong>
   * <strong>fann_set_training_algorithm()</strong>
   * <strong>fann_set_callback()</strong>


id: fann_train_on_file
type: function
doc:
<comment>Description:</comment>
  Trains on an entire dataset, which is read from file, for a period of time
  
  Trains on an entire dataset, which is read from file, for a period of time.
  
  This training uses the training algorithm chosen by <strong>fann_set_training_algorithm()</strong> and the
  parameters set for these training algorithms.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                     ニューラルネットワークリソース。
  <info>string</info>    <strong>$filename</strong>                The file containing train data
  <info>int</info>       <strong>$max_epochs</strong>              The maximum number of epochs the training should continue
  <info>int</info>       <strong>$epochs_between_reports</strong>  The number of epochs between calling a user function. A value
                                     of zero means that user function is not called.
  <info>float</info>     <strong>$desired_error</strong>           The desired <strong>fann_get_MSE()</strong> or <strong>fann_get_bit_fail()</strong>, depending on
                                     the stop function chosen by <strong>fann_set_train_stop_function()</strong>

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>fann_train_on_data()</strong>
   * <strong>fann_train_epoch()</strong>
   * <strong>fann_get_bit_fail()</strong>
   * <strong>fann_get_MSE()</strong>
   * <strong>fann_set_train_stop_function()</strong>
   * <strong>fann_set_training_algorithm()</strong>
   * <strong>fann_set_callback()</strong>


id: fastcgi_finish_request
type: function
doc:
<comment>Description:</comment>
  すべてのレスポンスデータをクライアントにフラッシュする
  
  この関数は、すべてのレスポンスデータをクライアントにフラッシュし、 リクエストを終わらせます。 これ
  により、クライアントへの接続を開いたままにすることなく、 時間のかかる処理を実行することができま
  す。

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


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

<comment>See Also:</comment>
   * <strong>fbird_modify_user()</strong>
   * <strong>fbird_delete_user()</strong>


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

<comment>See Also:</comment>
   * <strong>fbird_query()</strong>
   * <strong>fbird_execute()</strong>


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


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

<comment>See Also:</comment>
   * <strong>fbird_blob_cancel()</strong>
   * <strong>fbird_blob_close()</strong>
   * <strong>fbird_blob_create()</strong>
   * <strong>fbird_blob_import()</strong>


id: fbird_blob_cancel
type: function
doc:
<comment>Description:</comment>
  Cancel creating blob
  
  This function will discard a BLOB if it has not yet been closed by <strong>fbird_blob_close()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$blob_handle</strong>  A BLOB handle opened with <strong>fbird_blob_create()</strong>.

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

<comment>See Also:</comment>
   * <strong>fbird_blob_close()</strong>
   * <strong>fbird_blob_create()</strong>
   * <strong>fbird_blob_import()</strong>


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

<comment>See Also:</comment>
   * <strong>fbird_blob_create()</strong>
   * <strong>fbird_blob_cancel()</strong>
   * <strong>fbird_blob_open()</strong>
   * <strong>fbird_blob_import()</strong>


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

<comment>See Also:</comment>
   * <strong>fbird_blob_add()</strong>
   * <strong>fbird_blob_cancel()</strong>
   * <strong>fbird_blob_close()</strong>
   * <strong>fbird_blob_import()</strong>


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

<comment>See Also:</comment>
   * <strong>fbird_blob_open()</strong>
   * <strong>fbird_blob_close()</strong>
   * <strong>fbird_blob_get()</strong>


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

<comment>See Also:</comment>
   * <strong>fbird_blob_open()</strong>
   * <strong>fbird_blob_close()</strong>
   * <strong>fbird_blob_echo()</strong>


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

<comment>See Also:</comment>
   * <strong>fbird_blob_add()</strong>
   * <strong>fbird_blob_cancel()</strong>
   * <strong>fbird_blob_close()</strong>
   * <strong>fbird_blob_create()</strong>


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


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

<comment>See Also:</comment>
   * <strong>fbird_blob_close()</strong>
   * <strong>fbird_blob_echo()</strong>
   * <strong>fbird_blob_get()</strong>


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

<comment>See Also:</comment>
   * <strong>fbird_connect()</strong>
   * <strong>fbird_pconnect()</strong>


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


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


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

<comment>See Also:</comment>
   * <strong>fbird_pconnect()</strong>
   * <strong>fbird_close()</strong>


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


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

<comment>See Also:</comment>
   * <strong>fbird_add_user()</strong>
   * <strong>fbird_modify_user()</strong>


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

<comment>See Also:</comment>
   * <strong>fbird_connect()</strong>
   * <strong>fbird_pconnect()</strong>


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

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


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

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


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

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


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

<comment>See Also:</comment>
   * <strong>fbird_fetch_row()</strong>
   * <strong>fbird_fetch_object()</strong>


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

<comment>See Also:</comment>
   * <strong>fbird_fetch_row()</strong>
   * <strong>fbird_fetch_assoc()</strong>


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

<comment>See Also:</comment>
   * <strong>fbird_fetch_assoc()</strong>
   * <strong>fbird_fetch_object()</strong>


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

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


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

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


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


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


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


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


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

<comment>See Also:</comment>
   * <strong>fbird_add_user()</strong>
   * <strong>fbird_delete_user()</strong>


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

<comment>See Also:</comment>
   * <strong>fbird_prepare()</strong>
   * <strong>fbird_execute()</strong>


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

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


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

<comment>See Also:</comment>
   * <strong>fbird_prepare()</strong>
   * <strong>fbird_param_info()</strong>


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

<comment>See Also:</comment>
   * <strong>fbird_field_info()</strong>
   * <strong>fbird_num_params()</strong>


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

<comment>See Also:</comment>
   * <strong>fbird_close()</strong>
   * <strong>fbird_connect()</strong>


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


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

<comment>See Also:</comment>
   * <strong>fbird_errmsg()</strong>
   * <strong>fbird_fetch_row()</strong>
   * <strong>fbird_fetch_object()</strong>
   * <strong>fbird_free_result()</strong>


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


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


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


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


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


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


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

<comment>See Also:</comment>
   * <strong>fbird_free_event_handler()</strong>
   * <strong>fbird_wait_event()</strong>


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


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

<comment>See Also:</comment>
   * <strong>fbird_set_event_handler()</strong>
   * <strong>fbird_free_event_handler()</strong>


id: fclose
type: function
doc:
<comment>Description:</comment>
  オープンされたファイルポインタをクローズする
  
  <strong>$stream</strong>が指しているファイルをクローズします。

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  ファイルポインタは有効なものでなければならず、また <strong>fopen()</strong>または<strong>fsockopen()</strong> で
                     正常にオープンされたファイルを指している必要があります。

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

<comment>See Also:</comment>
   * <strong>fopen()</strong>
   * <strong>fsockopen()</strong>


id: fdatasync
type: function
doc:
<comment>Description:</comment>
  データをファイルに同期する(但しメタデータは除く)
  
  この関数は、 <strong>$stream</strong> の内容をストレージに同期します。 <strong>fsync()</strong> に似ていますが、ファイルのメタデータ
  は同期しません。 この点だけが、POSIX システムで唯一異なることに注意して下さい。 Windows では、この
  関数は <strong>fsync()</strong> のエイリアスになっています。

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  ファイルポインタは、有効なファイルポインタである必要があり、
                     <strong>fopen()</strong> または <strong>fsockopen()</strong> で正常にオープンされた
                     （そしてまだ <strong>fclose()</strong> でクローズされていない）
                     ファイルを指している必要があります。

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

<comment>See Also:</comment>
   * <strong>fflush()</strong>
   * <strong>fsync()</strong>


id: fdf_add_doc_javascript
type: function
doc:
<comment>Description:</comment>
  FDF ドキュメントに javascript コードを追加する
  
  スクリプトを FDF に追加します。Acrobat は、FDF が読み込まれた際に それをドキュメントレベルのスクリ
  プトとして追加します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  <strong>fdf_create()</strong>、 <strong>fdf_open()</strong> あるいは <strong>fdf_open_string()</strong> が返す FDF ドキュメ
                           ントハンドル。
  <info>string</info>    <strong>$script_name</strong>   スクリプト名。
  <info>string</info>    <strong>$script_code</strong>   スクリプトのコード。コード内での改行は、できるだけ '\r' を使用するように
                           してください。

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


id: fdf_add_template
type: function
doc:
<comment>Description:</comment>
  テンプレートを FDF ドキュメントに追加する
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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


id: fdf_close
type: function
doc:
<comment>Description:</comment>
  FDF ドキュメントを閉じる
  
  FDF ドキュメントを閉じます。

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  <strong>fdf_create()</strong>、 <strong>fdf_open()</strong> あるいは <strong>fdf_open_string()</strong> が返す FDF ドキュメ
                           ントハンドル。

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

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


id: fdf_create
type: function
doc:
<comment>Description:</comment>
  新規 FDF ドキュメントを作成する
  
  新規 FDF ドキュメントを作成します。
  
  この関数は、PDF ドキュメントの入力フィールドにデータを書きこみたい場合に必要です。

<comment>Return:</comment>
  <info>resource</info>  FDF ドキュメントハンドル、あるいはエラー時に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>fdf_close()</strong>
   * <strong>fdf_save()</strong>
   * <strong>fdf_open()</strong>


id: fdf_enum_values
type: function
doc:
<comment>Description:</comment>
  各ドキュメントの値に対してユーザー定義関数をコールする
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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


id: fdf_errno
type: function
doc:
<comment>Description:</comment>
  直近の fdf 操作に関するエラーコードを返す
  
  直近の FDF 関数コールによって設定されたエラーコードを取得します。
  
  エラーの内容についてのテキストを取得するには <strong>fdf_error()</strong> を使用します。

<comment>Return:</comment>
  <info>int</info>  エラーコードを表す整数値、あるいはエラーがない場合にゼロを返します。

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


id: fdf_error
type: function
doc:
<comment>Description:</comment>
  直近の fdf エラーコードについての説明を返す
  
  <strong>$error_code</strong> で指定したエラーコードについての説明テキストを取得します。

<comment>Param:</comment>
  <info>int</info>  <strong>$error_code</strong>  <strong>fdf_errno()</strong> で取得したエラーコード。 省略した場合は、直近の操作で設定された内部
                    エラーコードを使用します。

<comment>Return:</comment>
  <info>string</info>  エラーメッセージを表す文字列、あるいは何も問題がない場合は <return>no error</return> を返します。

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


id: fdf_get_ap
type: function
doc:
<comment>Description:</comment>
  フィールドの外観を取得する
  
  <strong>$field</strong> の外観 (つまり /AP キーの値) を取得し、ファイルに保存します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  <strong>fdf_create()</strong>、 <strong>fdf_open()</strong> あるいは <strong>fdf_open_string()</strong> が返す FDF ドキュメ
                           ントハンドル。
  <info>string</info>    <strong>$field</strong>         
  <info>int</info>       <strong>$face</strong>          <info>FDFNormalAP</info>、<info>FDFRolloverAP</info> および <info>FDFDownAP</info> のいずれか。
  <info>string</info>    <strong>$filename</strong>      ここに外観を保存します。

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


id: fdf_get_attachment
type: function
doc:
<comment>Description:</comment>
  FDF に埋め込まれている、アップロードされたファイルを展開する
  
  「ファイル選択」フィールド <strong>$fieldname</strong> によって アップロードされたファイルを展開し、それを
  <strong>$savepath</strong> に保存します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  <strong>fdf_create()</strong>、 <strong>fdf_open()</strong> あるいは <strong>fdf_open_string()</strong> が返す FDF ドキュメ
                           ントハンドル。
  <info>string</info>    <strong>$fieldname</strong>     
  <info>string</info>    <strong>$savepath</strong>      ファイル名または既存のディレクトリ名を指定し、ディレクトリ名を 指定した場
                           合はその下に元のファイル名で保存されます。 同名のファイルが存在した場合は
                           上書きします。
                           
                           <strong>$savepath</strong> にディレクトリを使用してファイルを 保存してその名前を調べる以外
                           には、元のファイル名を知る方法はないと 思われます。

<comment>Return:</comment>
  <info>array</info>  返される配列は以下のようなフィールドを保持します。 <strong>$path</strong> - ファイルが保存された場所<strong>$size</strong> -
         保存されたファイルのバイト数<strong>$type</strong> - (もし FDF 指定されていた場合) FDF の mimetype
         
         <strong>$path</strong> - ファイルが保存された場所
         
         <strong>$size</strong> - 保存されたファイルのバイト数
         
         <strong>$type</strong> - (もし FDF 指定されていた場合) FDF の mimetype


id: fdf_get_encoding
type: function
doc:
<comment>Description:</comment>
  /Encoding キーの値を取得する
  
  <return>/Encoding</return> キーの値を取得します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  <strong>fdf_create()</strong>、 <strong>fdf_open()</strong> あるいは <strong>fdf_open_string()</strong> が返す FDF ドキュメ
                           ントハンドル。

<comment>Return:</comment>
  <info>string</info>  エンコーディングを文字列で返します。 デフォルトの <return>PDFDocEncoding/Unicode</return> スキームを使用し
          ている場合は空の文字列を返します。

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


id: fdf_get_file
type: function
doc:
<comment>Description:</comment>
  /F キーの値を得る
  
  <return>/F</return> キーの値を取得します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  <strong>fdf_create()</strong>、 <strong>fdf_open()</strong> あるいは <strong>fdf_open_string()</strong> が返す FDF ドキュメ
                           ントハンドル。

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

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


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

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


id: fdf_get_opt
type: function
doc:
<comment>Description:</comment>
  フィールドのオプション配列から値を取得する
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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


id: fdf_get_status
type: function
doc:
<comment>Description:</comment>
  /STATUS キーの値を得る
  
  <return>/STATUS</return> キーの値を取得します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  <strong>fdf_create()</strong>、 <strong>fdf_open()</strong> あるいは <strong>fdf_open_string()</strong> が返す FDF ドキュメ
                           ントハンドル。

<comment>Return:</comment>
  <info>string</info>  キーの値を文字列で返します。

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


id: fdf_get_value
type: function
doc:
<comment>Description:</comment>
  フィールドの値を得る
  
  指定したフィールドの値を取得します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  <strong>fdf_create()</strong>、 <strong>fdf_open()</strong> あるいは <strong>fdf_open_string()</strong> が返す FDF ドキュメ
                           ントハンドル。
  <info>string</info>    <strong>$fieldname</strong>     FDF フィールドの名前を表す文字列。
  <info>int</info>       <strong>$which</strong>         このオプションパラメータを渡すことで、配列フィールドの 要素が取得可能で
                           す。番号はゼロから始まります。配列以外のフィールドでは、 このオプションは
                           無視されます。

<comment>Return:</comment>
  <info>mixed</info>  フィールドの値を返します。

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


id: fdf_get_version
type: function
doc:
<comment>Description:</comment>
  FDF API あるいはファイルのバージョンを取得する
  
  指定したドキュメントの FDF バージョン、 あるいはパラメータを指定しなかった場合はツールキット API
  のバージョンを返します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  <strong>fdf_create()</strong>、 <strong>fdf_open()</strong> あるいは <strong>fdf_open_string()</strong> が返す FDF ドキュメ
                           ントハンドル。

<comment>Return:</comment>
  <info>string</info>  バージョンを表す文字列を返します。 現在の FDF ツールキット 5.0 では API のバージョン番号は
          <return>5.0</return> で、 ドキュメントのバージョン番号は <return>1.2</return> <return>1.3</return> あるいは <return>1.4</return> です。

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


id: fdf_header
type: function
doc:
<comment>Description:</comment>
  FDF 固有の出力ヘッダをセットする
  
  この関数は、簡便に FDF の出力に適当な HTTP ヘッダを付加できるよう 用意されており、<return>Content-type:</return> を
  <return>application/vnd.fdf</return> に設定します。

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


id: fdf_next_field_name
type: function
doc:
<comment>Description:</comment>
  次のフィールド名を得る
  
  指定したフィールドの後のフィールドの名前を返します。 この名前をその他の関数で使用します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  <strong>fdf_create()</strong>、 <strong>fdf_open()</strong> あるいは <strong>fdf_open_string()</strong> が返す FDF ドキュメ
                           ントハンドル。
  <info>string</info>    <strong>$fieldname</strong>     FDF フィールド名を表す文字列。 省略した場合は最初のフィールドとみなされま
                           す。

<comment>Return:</comment>
  <info>string</info>  フィールド名を文字列で返します。

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


id: fdf_open
type: function
doc:
<comment>Description:</comment>
  FDF ドキュメントをオープンする
  
  フォームデータを含むファイルをオープンします。
  
  <strong>fdf_open_string()</strong> を用いて、 PDF フォームの POST リクエストを処理することもできます。

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  FDF ファイルへのパス。このファイルは、PDF フォームから返されたものか、
                     <strong>fdf_create()</strong> および <strong>fdf_save()</strong> で作成したものである必要があります。

<comment>Return:</comment>
  <info>resource</info>  FDF ドキュメントのハンドル、あるいはエラー時に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>fdf_open_string()</strong>
   * <strong>fdf_close()</strong>
   * <strong>fdf_create()</strong>
   * <strong>fdf_save()</strong>


id: fdf_open_string
type: function
doc:
<comment>Description:</comment>
  文字列から FDF ドキュメントを読み込む
  
  文字列からデータを読み込みます。
  
  <strong>fdf_open_string()</strong> を $HTTP_FDF_DATA とあわせて使用することで、リモート クライアントからの FDF
  フォーム入力を処理することが可能です。

<comment>Param:</comment>
  <info>string</info>  <strong>$fdf_data</strong>  <strong>fdf_create()</strong>、 <strong>fdf_open()</strong> あるいは <strong>fdf_open_string()</strong> が返す FDF ドキュメントハ
                     ンドル。

<comment>Return:</comment>
  <info>resource</info>  FDF ドキュメントハンドル、あるいはエラー時に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>fdf_open()</strong>
   * <strong>fdf_close()</strong>
   * <strong>fdf_create()</strong>
   * <strong>fdf_save_string()</strong>


id: fdf_remove_item
type: function
doc:
<comment>Description:</comment>
  フォームのターゲットフレームを設定する
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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


id: fdf_save
type: function
doc:
<comment>Description:</comment>
  FDF ドキュメントを保存する
  
  FDF ドキュメントを保存します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  <strong>fdf_create()</strong>、 <strong>fdf_open()</strong> あるいは <strong>fdf_open_string()</strong> が返す FDF ドキュメ
                           ントハンドル。
  <info>string</info>    <strong>$filename</strong>      指定した場合は、結果の FDF がここに書き込まれます。 それ以外の場合は、こ
                           の関数は FDF をデフォルトの PHP 出力ストリームに書き込みます。

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

<comment>See Also:</comment>
   * <strong>fdf_close()</strong>
   * <strong>fdf_create()</strong>
   * <strong>fdf_save_string()</strong>


id: fdf_save_string
type: function
doc:
<comment>Description:</comment>
  FDF ドキュメントを文字列として返す
  
  FDF ドキュメントを文字列として返します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  <strong>fdf_create()</strong>、 <strong>fdf_open()</strong> あるいは <strong>fdf_open_string()</strong> が返す FDF ドキュメ
                           ントハンドル。

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

<comment>See Also:</comment>
   * <strong>fdf_open_string()</strong>
   * <strong>fdf_close()</strong>
   * <strong>fdf_create()</strong>
   * <strong>fdf_save()</strong>


id: fdf_set_ap
type: function
doc:
<comment>Description:</comment>
  フィールドの外観を設定する
  
  フィールドの外観 (すなわち、<return>/AP</return> キーの値) を設定します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  <strong>fdf_create()</strong>、 <strong>fdf_open()</strong> あるいは <strong>fdf_open_string()</strong> が返す FDF ドキュメ
                           ントハンドル。
  <info>string</info>    <strong>$field_name</strong>    
  <info>int</info>       <strong>$face</strong>          <info>FDFNormalAP</info>、<info>FDFRolloverAP</info> および <info>FDFDownAP</info> のいずれかが使用可能です。
  <info>string</info>    <strong>$filename</strong>      
  <info>int</info>       <strong>$page_number</strong>   

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


id: fdf_set_encoding
type: function
doc:
<comment>Description:</comment>
  FDF 文字エンコーディングを設定する
  
  FDF ドキュメントの文字エンコーディングを設定します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  <strong>fdf_create()</strong>、 <strong>fdf_open()</strong> あるいは <strong>fdf_open_string()</strong> が返す FDF ドキュメ
                           ントハンドル。
  <info>string</info>    <strong>$encoding</strong>      エンコーディング名。現在サポートしているのは "<return>Shift-JIS</return>"、"<return>UHC</return>"、 "<return>GBK</return>"、
                           "<return>BigFive</return>" です。
                           
                           空の文字列を指定すると、エンコーディングをデフォルトの
                           <return>PDFDocEncoding/Unicode</return> スキームに設定します。

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


id: fdf_set_file
type: function
doc:
<comment>Description:</comment>
  FDF データを表示する PDF ドキュメントを設定する
  
  フォームの結果を表示する PDF ドキュメントとして、もとのフォームとは別のものを指定します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  <strong>fdf_create()</strong>、 <strong>fdf_open()</strong> あるいは <strong>fdf_open_string()</strong> が返す FDF ドキュメ
                           ントハンドル。
  <info>string</info>    <strong>$url</strong>           絶対 URL で指定する必要があります。
  <info>string</info>    <strong>$target_frame</strong>  このパラメータを使用して、ドキュメントを表示するフレームを指定します。 こ
                           のパラメータのデフォルト値を <strong>fdf_set_target_frame()</strong> で指定することもでき
                           ます。

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

<comment>See Also:</comment>
   * <strong>fdf_get_file()</strong>
   * <strong>fdf_set_target_frame()</strong>


id: fdf_set_flags
type: function
doc:
<comment>Description:</comment>
  フィールドのフラグを設定する
  
  指定したフィールドのフラグを設定します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  <strong>fdf_create()</strong>、 <strong>fdf_open()</strong> あるいは <strong>fdf_open_string()</strong> が返す FDF ドキュメ
                           ントハンドル。
  <info>string</info>    <strong>$fieldname</strong>     FDF フィールド名を表す文字列。
  <info>int</info>       <strong>$whichFlags</strong>    
  <info>int</info>       <strong>$newFlags</strong>      

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

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


id: fdf_set_javascript_action
type: function
doc:
<comment>Description:</comment>
  フィールドの javascript アクションを設定する
  
  指定したフィールドの javascript アクションを設定します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  <strong>fdf_create()</strong>、 <strong>fdf_open()</strong> あるいは <strong>fdf_open_string()</strong> が返す FDF ドキュメ
                           ントハンドル。
  <info>string</info>    <strong>$fieldname</strong>     FDF フィールド名を表す文字列。
  <info>int</info>       <strong>$trigger</strong>       
  <info>string</info>    <strong>$script</strong>        

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

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


id: fdf_set_on_import_javascript
type: function
doc:
<comment>Description:</comment>
  Acrobat が FDF をオープンした際に実行される javascript のコードを追加する
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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

<comment>See Also:</comment>
   * <strong>fdf_add_doc_javascript()</strong>
   * <strong>fdf_set_javascript_action()</strong>


id: fdf_set_opt
type: function
doc:
<comment>Description:</comment>
  フィールドのオプションを設定する
  
  指定したフィールドのオプションを設定します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  <strong>fdf_create()</strong>、 <strong>fdf_open()</strong> あるいは <strong>fdf_open_string()</strong> が返す FDF ドキュメ
                           ントハンドル。
  <info>string</info>    <strong>$fieldname</strong>     FDF フィールド名を表す文字列。
  <info>int</info>       <strong>$element</strong>       
  <info>string</info>    <strong>$str1</strong>          
  <info>string</info>    <strong>$str2</strong>          

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

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


id: fdf_set_status
type: function
doc:
<comment>Description:</comment>
  /STATUS キーの値を設定する
  
  <return>/STATUS</return> キーの値を設定します。 クライアントが FDF とともにステータスセットを受信すると、その内容を
  アラートボックスに表示します

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  <strong>fdf_create()</strong>、 <strong>fdf_open()</strong> あるいは <strong>fdf_open_string()</strong> が返す FDF ドキュメ
                           ントハンドル。
  <info>string</info>    <strong>$status</strong>        

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

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


id: fdf_set_submit_form_action
type: function
doc:
<comment>Description:</comment>
  フィールドの投稿フォームアクションを設定する
  
  指定したフィールドの投稿フォームアクションを設定します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  <strong>fdf_create()</strong>、 <strong>fdf_open()</strong> あるいは <strong>fdf_open_string()</strong> が返す FDF ドキュメ
                           ントハンドル。
  <info>string</info>    <strong>$fieldname</strong>     FDF フィールド名を表す文字列。
  <info>int</info>       <strong>$trigger</strong>       
  <info>string</info>    <strong>$script</strong>        
  <info>int</info>       <strong>$flags</strong>         

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

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


id: fdf_set_target_frame
type: function
doc:
<comment>Description:</comment>
  フォームの表示対象となるフレームを設定する
  
  <strong>fdf_save_file()</strong> で定義した PDF の結果を出力する 対象のフレームを設定します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  <strong>fdf_create()</strong>、 <strong>fdf_open()</strong> あるいは <strong>fdf_open_string()</strong> が返す FDF ドキュメ
                           ントハンドル。
  <info>string</info>    <strong>$frame_name</strong>    フレーム名を表す文字列。

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

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


id: fdf_set_value
type: function
doc:
<comment>Description:</comment>
  フィールドの値を設定する
  
  指定したフィールドに値 <strong>$value</strong> を設定します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  <strong>fdf_create()</strong>、 <strong>fdf_open()</strong> あるいは <strong>fdf_open_string()</strong> が返す FDF ドキュメ
                           ントハンドル。
  <info>string</info>    <strong>$fieldname</strong>     FDF フィールド名を表す文字列。
  <info>mixed</info>     <strong>$value</strong>         このパラメータは、配列形式でない限り文字列で保存されます。 配列の場合は、
                           配列のすべての要素が配列として保存されます。
  <info>int</info>       <strong>$isName</strong>        FDF ツールキットの古いバージョンでは、最後のパラメータは フィールドの値を
                           PDF Name に変換する (= 1) か、PDF String に設定する (= 0) かを定義しま
                           す。
                           
                           ツールキットの現在のバージョン 5.0 では、もはやこのパラメータは 使用され
                           ません。互換性を確保するためにこのパラメータが オプションとして残されてい
                           ますが、内部ではこのパラメータは無視されます。

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

<comment>See Also:</comment>
   * <strong>fdf_get_value()</strong>
   * <strong>fdf_remove_item()</strong>


id: fdf_set_version
type: function
doc:
<comment>Description:</comment>
  FDF ファイルのバージョン番号を設定する
  
  指定したドキュメントの FDF バージョンを <strong>$version</strong> に設定します。
  
  この拡張モジュールが提供する機能のうちのいくつかは、新しいバージョンの FDF でのみ動作します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  <strong>fdf_create()</strong>、 <strong>fdf_open()</strong> あるいは <strong>fdf_open_string()</strong> が返す FDF ドキュメ
                           ントハンドル。
  <info>string</info>    <strong>$version</strong>       バージョンを表す文字列。 現在の FDF ツールキット 5.0 では、これは <return>1.2</return>、
                           <return>1.3</return> あるいは <return>1.4</return> となります。

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

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


id: fdiv
type: function
doc:
<comment>Description:</comment>
  IEEE 754 に従い、数値の除算を行う
  
  <strong>$num1</strong> を <strong>$num2</strong> で割った結果を浮動小数点数の結果として返します。 <strong>$num2</strong> が 0 の場合、 <return>INF</return>, <return>-INF</return>, <return>NAN</return>
  のうちのいずれかを返します。
  
  <return>NAN</return> は == や === のいずれを使っても、いかなる値とも比較できないことに注意して下さい。 <return>NAN</return> は、<return>NAN</return>
  のみと比較できます。

<comment>Param:</comment>
  <info>float</info>  <strong>$num1</strong>  被除数(分子)
  <info>float</info>  <strong>$num2</strong>  除数

<comment>Return:</comment>
  <info>float</info>  <strong>$num1</strong>/<strong>$num2</strong> の結果を浮動小数点数として返します。

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


id: feof
type: function
doc:
<comment>Description:</comment>
  ファイルポインタがファイル終端に達しているかどうか調べる
  
  ファイルポインタがファイル終端に達しているかどうかを調べます。

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  ファイルポインタは、有効なファイルポインタである必要があり、
                     <strong>fopen()</strong> または <strong>fsockopen()</strong> で正常にオープンされた
                     （そしてまだ <strong>fclose()</strong> でクローズされていない）
                     ファイルを指している必要があります。

<comment>Return:</comment>
  <info>bool</info>  ファイルポインタが EOF に達しているかまたはエラー (ソケットタイムアウトを含みます) の場合に
        <info>true</info> 、 その他の場合に <info>false</info> を返します。


id: fflush
type: function
doc:
<comment>Description:</comment>
  出力をファイルにフラッシュする
  
  この関数は、バッファリングされた全ての出力をファイルハンドル <strong>$stream</strong> が指すリソースに強制的に書き
  込みます。

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  ファイルポインタは、有効なファイルポインタである必要があり、
                     <strong>fopen()</strong> または <strong>fsockopen()</strong> で正常にオープンされた
                     （そしてまだ <strong>fclose()</strong> でクローズされていない）
                     ファイルを指している必要があります。

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

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


id: fgetc
type: function
doc:
<comment>Description:</comment>
  ファイルポインタから1文字取り出す
  
  指定したファイルポインタから 1 文字読み出します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  ファイルポインタは、有効なファイルポインタである必要があり、
                     <strong>fopen()</strong> または <strong>fsockopen()</strong> で正常にオープンされた
                     （そしてまだ <strong>fclose()</strong> でクローズされていない）
                     ファイルを指している必要があります。

<comment>Return:</comment>
  <info>string|false</info>  <strong>$stream</strong>が指すファイルポインタから 1 文字読み出し、 その文字からなる文字列を返しま
                す。EOF の場合に <info>false</info> を返します。
                
                この関数は論理値
                <info>false</info> を返す可能性がありますが、<info>false</info> として評価される値を返す可能性もあります。
                詳細については 論理値の
                セクションを参照してください。この関数の返り値を調べるには
                ===演算子 を
                使用してください。

<comment>See Also:</comment>
   * <strong>fread()</strong>
   * <strong>fopen()</strong>
   * <strong>popen()</strong>
   * <strong>fsockopen()</strong>
   * <strong>fgets()</strong>


id: fgetcsv
type: function
doc:
<comment>Description:</comment>
  ファイルポインタから行を取得し、CSVフィールドを処理する
  
  <strong>fgets()</strong> に動作は似ていますが、 <strong>fgetcsv()</strong> は行を CSV フォーマットのフィールドとして読込み処理を行
  い、 読み込んだフィールドを含む配列を返すという違いがあります。
  
  この関数はロケール設定を考慮します。もし LC_CTYPE が例えば <return>en_US.UTF-8</return> の場合、 1 バイトエンコー
  ディングのファイルは間違って読み込まれるかもしれません。

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>     ファイルポインタは有効なものでなければならず、また <strong>fopen()</strong>, <strong>popen()</strong>, もしく
                        は <strong>fsockopen()</strong> で正常にオープンされたファイルを指している必要があります。
  <info>int|null</info>  <strong>$length</strong>     (行末文字を考慮して) CSV ファイルにある最も長い行よりも大きい必要がありま
                        す。 そうでない場合は、ひとつの行が <strong>$length</strong> 文字ずつのチャンクに分割されてし
                        まいます。 ただし、フィールド囲いこみ文字の内部では、この分割は発生しませ
                        ん。
                        
                        このパラメータを省略 (もしくは 0 を設定、 PHP 8.0.0 以降では <info>null</info> を設定) す
                        ると、 最大行長は制限されません。この場合、若干動作が遅くなります。
  <info>string</info>    <strong>$separator</strong>  オプションの <strong>$separator</strong> パラメータで、フィールドのデリミタ (シングルバイト文
                        字 1 文字のみ) を設定します。
  <info>string</info>    <strong>$enclosure</strong>  オプションの <strong>$enclosure</strong> パラメータで、フィールド囲いこみ文字 (シングルバイト
                        文字 1 文字のみ) を設定します。
  <info>string</info>    <strong>$escape</strong>     オプションの <strong>$escape</strong> パラメータで、エスケープ文字 (シングルバイト文字 最大で
                        1文字) を設定します。 空文字列(<return>""</return>) を指定すると、(RFC 4180 に準拠していない)
                        独自仕様のエスケープ機構が無効になります。
                        
                        <strong>$enclosure</strong> の文字は、フィールド内で2回出力される ことでエスケープされます。
                        しかし、 <strong>$escape</strong> 文字はその代替として使えます。 デフォルトのパラメータの値
                        <return>""</return> と <return>\"</return> は同じ意味を持ちます。 <strong>$enclosure</strong> の文字を <strong>$escape</strong> 文字でエスケープ
                        することには、 特別な意味はありません。それ自身をエスケープする意味ですらあ
                        りません。

<comment>Return:</comment>
  <info>array|false</info>  読み込んだフィールドの内容を含む数値添字配列を返します。 失敗した場合に <info>false</info> を返し
               ます
               
               CSV ファイルの空行は <info>null</info> フィールドを一つだけ含む配列として返され、 エラーにはなりま
               せん。
               
               マッキントッシュコンピュータ上で作成されたファイルを読み込む際に、
               <return>PHP</return> が行末を認識できないという問題が発生した場合、
               実行時の設定オプションauto_detect_line_endings を有効にする必要が生じるかもしれませ
               ん。

<comment>See Also:</comment>
   * <strong>str_getcsv()</strong>
   * <strong>explode()</strong>
   * <strong>file()</strong>
   * <strong>pack()</strong>
   * <strong>fputcsv()</strong>


id: fgets
type: function
doc:
<comment>Description:</comment>
  ファイルポインタから 1 行取得する
  
  ファイルポインタから 1 行取得します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  ファイルポインタは、有効なファイルポインタである必要があり、
                     <strong>fopen()</strong> または <strong>fsockopen()</strong> で正常にオープンされた
                     （そしてまだ <strong>fclose()</strong> でクローズされていない）
                     ファイルを指している必要があります。
  <info>int|null</info>  <strong>$length</strong>  読み出しは、<strong>$length</strong> - 1 バイト読み出したか、(戻り値に含まれる) 改行文字を検出し
                     たか、EOF に達したかのいずれかが起こった時点で終了します。 length が指定されな
                     い場合は、行末に達するまで読み続けます。

<comment>Return:</comment>
  <info>string|false</info>  <strong>$stream</strong> で指定したファイルポインタから最大 <strong>$length</strong> - 1 バイト読み出し、 その文字列を
                返します。ファイルポインタから読み込むデータがもうない場合は <info>false</info> を返します。
                
                エラーが起こった場合、<info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>fgetss()</strong>
   * <strong>fread()</strong>
   * <strong>fgetc()</strong>
   * <strong>stream_get_line()</strong>
   * <strong>fopen()</strong>
   * <strong>popen()</strong>
   * <strong>fsockopen()</strong>
   * <strong>stream_set_timeout()</strong>


id: fgetss
type: function
doc:
<comment>Description:</comment>
  ファイルポインタから 1 行取り出し、HTML タグを取り除く
  
  <strong>fgets()</strong> と同じですが、 <strong>fgetss()</strong> は読み込んだテキストから NUL バイト や HTML および PHP のタグを取
  り除こうとすることが異なります。 この関数は、ある呼び出しから別の呼び出しの間のパースの状態を保持
  します。 したがって、これは <strong>fgets()</strong> の戻り値に対して <strong>strip_tags()</strong> 関数を呼び出すのと同じではありま
  せん。

<comment>Param:</comment>
  <info>resource</info>  <strong>$handle</strong>          ファイルポインタは、有効なファイルポインタである必要があり、
                             <strong>fopen()</strong> または <strong>fsockopen()</strong> で正常にオープンされた
                             （そしてまだ <strong>fclose()</strong> でクローズされていない）
                             ファイルを指している必要があります。
  <info>int</info>       <strong>$length</strong>          取得したいデータの長さ。
  <info>string</info>    <strong>$allowable_tags</strong>  オプションの 3 番目の引数を使用して、 取り除く必要がないタグを指定する
                             ことができます。 <strong>$allowable_tags</strong> について詳しくは <strong>strip_tags()</strong> を参照く
                             ださい。

<comment>Return:</comment>
  <info>string</info>  <strong>$handle</strong> で指定したファイルポインタから最大 <strong>$length</strong> - 1 バイト読み出し、 HTML や PHP コード
          を取り除いた文字列を返します。
          
          エラーが発生した場合は <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>fgets()</strong>
   * <strong>fopen()</strong>
   * <strong>popen()</strong>
   * <strong>fsockopen()</strong>
   * <strong>strip_tags()</strong>
   * SplFileObject::fgetss
   * The string.strip_tags filter


id: file
type: function
doc:
<comment>Description:</comment>
  ファイル全体を読み込んで配列に格納する
  
  ファイル全体を配列に読み込みます。
  
  ファイルの内容を文字列として返すには <strong>file_get_contents()</strong> を使用します。

<comment>Param:</comment>
  <info>string</info>         <strong>$filename</strong>  ファイルへのパス。
                            
                            fopen wrappers が有効の場合、この関数のファイル名として
                            URL を使用することができます。ファイル名の指定方法に関する詳細は
                            <strong>fopen()</strong> を参照ください。
                             には、さまざまなラッパーの機能やその使用法、
                            提供される定義済み変数などの情報がまとめられています。
  <info>int</info>            <strong>$flags</strong>     オプションのパラメータ <strong>$flags</strong> は、以下の定数のうちのひとつ、あるいは複数
                            の組み合わせとなります。 <info>FILE_USE_INCLUDE_PATH</info>include_path のファイルを
                            探します。 <info>FILE_IGNORE_NEW_LINES</info> 配列の各要素の最後の改行を省略します。
                            <info>FILE_SKIP_EMPTY_LINES</info> 空行を読み飛ばします。 <info>FILE_NO_DEFAULT_CONTEXT</info> デ
                            フォルトのストリームコンテキストを使いません。
                            
                            include_path のファイルを探します。
                            
                            配列の各要素の最後の改行を省略します。
                            
                            空行を読み飛ばします。
                            
                            デフォルトのストリームコンテキストを使いません。
  <info>resource|null</info>  <strong>$context</strong>   ストリームコンテキストリソース

<comment>Return:</comment>
  <info>array|false</info>  ファイルを配列に入れて返します。 配列の各要素はファイルの各行に対応します。改行記号は
               ついたままとなります。 失敗すると <strong>file()</strong> は <info>false</info> を返します。
               
               <info>FILE_IGNORE_NEW_LINES</info> を指定しない限り、 配列に取り込まれた各行は行末文字も含みます。
               
               マッキントッシュコンピュータ上で作成されたファイルを読み込む際に、
               <return>PHP</return> が行末を認識できないという問題が発生した場合、
               実行時の設定オプションauto_detect_line_endings を有効にする必要が生じるかもしれませ
               ん。

<comment>See Also:</comment>
   * <strong>file_get_contents()</strong>
   * <strong>readfile()</strong>
   * <strong>fopen()</strong>
   * <strong>fsockopen()</strong>
   * <strong>popen()</strong>
   * <strong>include()</strong>
   * <strong>stream_context_create()</strong>


id: file_exists
type: function
doc:
<comment>Description:</comment>
  ファイルまたはディレクトリが存在するかどうか調べる
  
  ファイルあるいはディレクトリが存在するかどうかを調べます。

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  ファイルあるいはディレクトリへのパス。
                     
                     Windows 上でネットワーク共有上のファイルを調べるには、
                     //computername/share/filename または \\computername\share\filename のように指定
                     してください。

<comment>Return:</comment>
  <info>bool</info>  <strong>$filename</strong> で指定したファイルまたはディレクトリが存在すれば <info>true</info> を返し、そうでなければ <info>false</info>
        を返します。
        
        この関数は、シンボリックリンクの指す先のファイルが存在しない場合は <info>false</info> を返します。
        
        チェックは、実効ユーザーではなく実ユーザーの UID/GID で行います。
        
        PHP の数値型は符号付整数であり、 多くのプラットフォームでは 32 ビットの整数を取るため、 ファ
        イルシステム関数の中には 2GB より大きなファイルについては期待とは違う値を返すものがありま
        す。

<comment>See Also:</comment>
   * <strong>is_readable()</strong>
   * <strong>is_writable()</strong>
   * <strong>is_file()</strong>
   * <strong>file()</strong>
   * <class>SplFileInfo</class>


id: file_get_contents
type: function
doc:
<comment>Description:</comment>
  ファイルの内容を全て文字列に読み込む
  
  この関数は <strong>file()</strong> と似ていますが、 <strong>$offset</strong> で指定した場所から開始し <strong>$length</strong> バイト分だけ ファイル
  の内容を文字列に読み込むという点が異なります。 失敗した場合、<strong>file_get_contents()</strong> は <info>false</info> を返しま
  す。
  
  <strong>file_get_contents()</strong>はファイルの内容を文字列に読み込む 方法として好ましいものです。もしOSがサポート
  していれば パフォーマンス向上のためにメモリマッピング技術が使用されます。
  
  空白のような特殊な文字を有する URI をオープンする場合には、 <strong>urlencode()</strong> でその URI をエンコードす
  る必要があります。

<comment>Param:</comment>
  <info>string</info>         <strong>$filename</strong>          データを読み込みたいファイルの名前。
  <info>bool</info>           <strong>$use_include_path</strong>  定数 <info>FILE_USE_INCLUDE_PATH</info> を使用して インクルードパス から探す
                                    ことができます。 この定数を使うことは、強い型付け が有効になって
                                    いる場合は不可能です。なぜなら、 <info>FILE_USE_INCLUDE_PATH</info> が <info>int</info> だ
                                    からです。 <info>true</info> を代わりに使いましょう。
  <info>resource|null</info>  <strong>$context</strong>           <strong>stream_context_create()</strong> で作成したコンテキストリソース。 独自の
                                    コンテキストを使用する必要がない場合は、このパラメータに <info>null</info> を
                                    指定します。
  <info>int</info>            <strong>$offset</strong>            元のストリーム上で、読み込みを開始するオフセット位置。 負のオフ
                                    セットは、ストリームの末尾からのオフセットと解釈されます。
                                    
                                    リモートファイルに対するシーク (<strong>$offset</strong> 指定) はサポートしていま
                                    せん。 オフセットが小さい場合はリモートファイルでのシークがうま
                                    くいくこともありますが、 これはバッファリングされたストリーム上
                                    で動作しているだけのことです。
  <info>int|null</info>       <strong>$length</strong>            読み込むデータの最大バイト数。 デフォルトは、ファイル終端に達す
                                    るまで読み込みます。 このパラメータは、フィルタが処理した後のス
                                    トリームに適用されることに注意しましょう。

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

<comment>See Also:</comment>
   * <strong>file()</strong>
   * <strong>fgets()</strong>
   * <strong>fread()</strong>
   * <strong>readfile()</strong>
   * <strong>file_put_contents()</strong>
   * <strong>stream_get_contents()</strong>
   * <strong>stream_context_create()</strong>
   * $http_response_header


id: file_put_contents
type: function
doc:
<comment>Description:</comment>
  データをファイルに書き込む
  
  この関数は、<strong>fopen()</strong>、<strong>fwrite()</strong>、 <strong>fclose()</strong> を続けてコールしてデータをファイルに書き込むのと等価で
  す。
  
  <strong>$filename</strong> が存在しない場合はファイルを作成します。 存在する場合はそのファイルを上書きします。ただ
  し <info>FILE_APPEND</info> フラグが設定されている場合は別です。

<comment>Param:</comment>
  <info>string</info>         <strong>$filename</strong>  データを書き込むファイルへのパス。
  <info>mixed</info>          <strong>$data</strong>      書き込むデータ。<info>文字列</info>, <info>配列</info> もしくは <info>ストリーム</info> リソースのいずれかを指
                            定可能です。
                            
                            <strong>$data</strong> が <info>ストリーム</info> リソースの場合は、 ストリームのバッファに残っている
                            内容が指定したファイルにコピーされます。 これは、<strong>stream_copy_to_stream()</strong>
                            の挙動と似ています。
                            
                            <strong>$data</strong> に一次元の配列を指定することもできます。この場合は
                            <return>file_put_contents($filename, implode('', $array))</return> と同じ意味になります。
  <info>int</info>            <strong>$flags</strong>     <strong>$flags</strong> の値は、以下のフラグを組み合わせたものとなります 組み合わせる際に
                            は、論理 OR (<return>|</return>) 演算子で連結します。
                            
                            使用できるフラグフラグ説明<info>FILE_USE_INCLUDE_PATH</info><strong>$filename</strong> をインクルード
                            ディレクトリから探します。 詳細な情報は include_path を参照ください。
                            <info>FILE_APPEND</info><strong>$filename</strong> がすでに存在する場合に、 データをファイルに上書きす
                            るするのではなく追記します。 <info>LOCK_EX</info> 書き込み処理中に、ファイルに対する
                            排他ロックを確保します。 つまり、<strong>fopen()</strong> の呼び出しから <strong>fwrite()</strong> の呼び
                            出しまでの間に <strong>flock()</strong> の呼び出しが発生するということです。 これは、モー
                            ド "x" で <strong>fopen()</strong> を呼び出すことと同等ではありません。
  <info>resource|null</info>  <strong>$context</strong>   <strong>stream_context_create()</strong> で作成したコンテキストリソース。

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

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


id: fileatime
type: function
doc:
<comment>Description:</comment>
  ファイルの最終アクセス時刻を取得する
  
  指定したファイルの最終アクセス時刻を取得します。

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

<comment>Return:</comment>
  <info>int|false</info>  ファイルの最終アクセス時刻を返し、失敗した場合に <info>false</info> を返します。 時間は Unix タイム
             スタンプとして返されます。

<comment>See Also:</comment>
   * <strong>filemtime()</strong>
   * <strong>fileinode()</strong>
   * <strong>date()</strong>


id: filectime
type: function
doc:
<comment>Description:</comment>
  ファイルの inode 変更時刻を取得する
  
  ファイルの inode 変更時刻を取得します。

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

<comment>Return:</comment>
  <info>int|false</info>  ファイルの最終更新時刻を返し、失敗した場合に <info>false</info> を返します。 時間は Unix タイムスタ
             ンプとして返されます。

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


id: filegroup
type: function
doc:
<comment>Description:</comment>
  ファイルのグループを取得する
  
  ファイルのグループを取得します。戻り値は、数値形式のグループ ID です。 グループ名を取得するには
  <strong>posix_getgrgid()</strong> を使用します。

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

<comment>Return:</comment>
  <info>int|false</info>  ファイルの所有者のグループ ID を返し、エラーの場合は <info>false</info> を返します。 グループ ID は
             数値で返されます。グループ名に変換するには <strong>posix_getgrgid()</strong> を使用してください。 失敗す
             ると <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>fileowner()</strong>
   * <strong>posix_getgrgid()</strong>


id: fileinode
type: function
doc:
<comment>Description:</comment>
  ファイルの inode を取得する
  
  ファイルの inode を取得します。

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

<comment>Return:</comment>
  <info>int|false</info>  ファイルの inode 番号を返し、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>getmyinode()</strong>
   * <strong>stat()</strong>


id: filemtime
type: function
doc:
<comment>Description:</comment>
  ファイルの更新時刻を取得する
  
  この関数は、ファイルのブロックデータが書き込まれた時間を返します。 これは、ファイルの内容が変更さ
  れた際の時間です。

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

<comment>Return:</comment>
  <info>int|false</info>  ファイルの最終更新時刻を返し、失敗した場合に <info>false</info> を返します。 時間は Unix タイムスタ
             ンプとして返されます。 この関数の結果は <strong>date()</strong> 等で使用できます。

<comment>See Also:</comment>
   * <strong>filectime()</strong>
   * <strong>stat()</strong>
   * <strong>touch()</strong>
   * <strong>getlastmod()</strong>


id: fileowner
type: function
doc:
<comment>Description:</comment>
  ファイルの所有者を取得する
  
  ファイルの所有者を取得します。

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

<comment>Return:</comment>
  <info>int|false</info>  ファイルの所有者のユーザー ID を返し、失敗した場合に <info>false</info> を返します。 ユーザー ID は
             数値で返されます。ユーザー名に変換するには <strong>posix_getpwuid()</strong> を使用してください。

<comment>See Also:</comment>
   * <strong>filegroup()</strong>
   * <strong>stat()</strong>
   * <strong>posix_getpwuid()</strong>


id: fileperms
type: function
doc:
<comment>Description:</comment>
  ファイルのパーミッションを取得する
  
  指定したファイルのパーミッションを取得します。

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

<comment>Return:</comment>
  <info>int|false</info>  ファイルのパーミッションを数値モードで返します。このモードの下位ビットは <strong>chmod()</strong> に渡す
             のと同じ形式です。 しかし、大半のプラットフォームでは、それだけではなく <strong>$filename</strong> の
             ファイル形式に関する情報も含まれます。 以下の例で示すのは、ファイルのパーミッションや
             ファイル形式を POSIX システム (Linux や macOS など) で調べる方法です。
             
             ローカルファイルの場合、その戻り値は C ライブラリ関数 <strong>stat()</strong> が返す構造体の <return>st_mode</return> メ
             ンバーの値となります。 どのビットがセットされるかはプラットフォームによって異なるので、
             パーミッション部分以外のビットをパースしたい場合は各プラットフォームのドキュメントを参
             照することをおすすめします。
             
             失敗時に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>chmod()</strong>
   * <strong>is_readable()</strong>
   * <strong>stat()</strong>


id: filesize
type: function
doc:
<comment>Description:</comment>
  ファイルのサイズを取得する
  
  指定したファイルのサイズを取得します。

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

<comment>Return:</comment>
  <info>int|false</info>  ファイルのサイズを返し、エラーの場合は <info>false</info> を返します (また <info>E_WARNING</info> レベルのエラー
             を発生させます) 。
             
             PHP の数値型は符号付整数であり、 多くのプラットフォームでは 32 ビットの整数を取るため、
             ファイルシステム関数の中には 2GB より大きなファイルについては期待とは違う値を返すものが
             あります。

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


id: filetype
type: function
doc:
<comment>Description:</comment>
  ファイルタイプを取得する
  
  指定したファイルのタイプを返します。

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

<comment>Return:</comment>
  <info>string|false</info>  ファイルのタイプを返します。返される値は fifo、char、dir、 block、link、file、socket
                および unknown のいずれかです。
                
                エラーが発生すると <info>false</info> を返します。 また <strong>filetype()</strong> は stat コールに失敗したり、
                未知のファイルタイプであったりした場合に <info>E_NOTICE</info> メッセージを発行します。

<comment>See Also:</comment>
   * <strong>is_dir()</strong>
   * <strong>is_file()</strong>
   * <strong>is_link()</strong>
   * <strong>file_exists()</strong>
   * <strong>mime_content_type()</strong>
   * <strong>pathinfo()</strong>
   * <strong>stat()</strong>


id: filter_has_var
type: function
doc:
<comment>Description:</comment>
  指定した型の変数が存在するかどうかを調べる

<comment>Param:</comment>
  <info>int</info>     <strong>$input_type</strong>  <info>INPUT_GET</info>、<info>INPUT_POST</info>、 <info>INPUT_COOKIE</info>、<info>INPUT_SERVER</info>、 <info>INPUT_ENV</info> のいずれか。
  <info>string</info>  <strong>$var_name</strong>    調べたい変数の名前。

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


id: filter_id
type: function
doc:
<comment>Description:</comment>
  フィルタの名前からフィルタ ID を返す

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  取得したいフィルタの名前。

<comment>Return:</comment>
  <info>int|false</info>  フィルタの ID を返します。フィルタが存在しない場合は <info>false</info> を返します。

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


id: filter_input
type: function
doc:
<comment>Description:</comment>
  指定した名前の変数を外部から受け取り、オプションでそれをフィルタリングする

<comment>Param:</comment>
  <info>int</info>        <strong>$type</strong>      <info>INPUT_GET</info>、<info>INPUT_POST</info>、 <info>INPUT_COOKIE</info>、<info>INPUT_SERVER</info> あるいは <info>INPUT_ENV</info> のいず
                        れか。
  <info>string</info>     <strong>$var_name</strong>  取得する変数の名前。
  <info>int</info>        <strong>$filter</strong>    適用するフィルタの ID。 に、利用できるフィルタの一覧があります。
                        
                        省略した場合は <info>FILTER_DEFAULT</info> を使います。これは <info>FILTER_UNSAFE_RAW</info> と同等で
                        す。 結果的に、デフォルトでは何もフィルタリングをしません。
  <info>array|int</info>  <strong>$options</strong>   オプションあるいはフラグの論理和の連想配列。 オプションを指定可能なフィルタ
                        の場合、この配列の "flags" フィールドにフラグを指定します。

<comment>Return:</comment>
  <info>mixed</info>  成功した場合は要求された変数の値、フィルタリングに失敗した場合に <info>false</info>、 あるいは変数
         <strong>$var_name</strong> が設定されていない場合に <info>null</info> を返します。フラグ <info>FILTER_NULL_ON_FAILURE</info> が指定さ
         れている場合は、変数が設定されていなければ <info>false</info>、 フィルタリングに失敗したら <info>null</info> を返しま
         す。

<comment>See Also:</comment>
   * <strong>filter_var()</strong>
   * <strong>filter_input_array()</strong>
   * <strong>filter_var_array()</strong>
   * 


id: filter_input_array
type: function
doc:
<comment>Description:</comment>
  外部から変数を受け取り、オプションでそれらをフィルタリングする
  
  この関数を使用すると、大量のデータを取得する際に <strong>filter_input()</strong> を繰り返しコールする必要がなくなる
  ので便利です。

<comment>Param:</comment>
  <info>int</info>        <strong>$type</strong>       <info>INPUT_GET</info>、<info>INPUT_POST</info>、 <info>INPUT_COOKIE</info>、<info>INPUT_SERVER</info> あるいは <info>INPUT_ENV</info> のい
                         ずれか。
  <info>array|int</info>  <strong>$options</strong>    引数を定義する配列。配列のキーとして使用できるのは 変数名を <info>string</info> で表した
                         ものです。 対応する値に使用できるのは、フィルタの型か配列 (フィルタ・フラ
                         グ・オプションを指定したもの) です。 配列の値として配列を使用する場合に使用
                         できるキーは、 <return>filter</return> (フィルタの型)、 <return>flags</return> (フィルタに適用するフラグ) お
                         よび <return>options</return> (フィルタに適用するオプション) です。理解を深めるために、以下
                         の例を参照ください。
                         
                         このパラメータには、フィルタ定数 を表す整数値を指定することもできます。 こ
                         うすると、入力配列のすべての値がそのフィルタで処理されます。
  <info>bool</info>       <strong>$add_empty</strong>  存在しないキーは <info>null</info> として戻り値に追加します。

<comment>Return:</comment>
  <info>array|false|null</info>  成功した場合は要求された変数の値を含む配列。
                     <info>FILTER_NULL_ON_FAILURE</info> フラグが指定されない場合、 かつ <strong>$type</strong> で指定された入力値
                    の配列が得られなかった場合は、 この関数は <info>null</info> を返します。 <strong>$type</strong> で指定された入
                    力値の配列が得られなかった場合、 かつ <info>FILTER_NULL_ON_FAILURE</info> フラグが指定されて
                    いた場合は、 この関数は <info>false</info> を返します。その他の理由で失敗した場合でも <info>false</info>
                    を返します。
                    
                    フィルタが失敗した場合、配列の値は <info>false</info> になります。 変数が設定されていない場合
                    は、<info>null</info> になります。 フラグ <info>FILTER_NULL_ON_FAILURE</info> が指定されている場合は、変数
                    が設定されていないときに <info>false</info>、 フィルタリングに失敗した場合に <info>null</info> となりま
                    す。 <strong>$add_empty</strong> パラメータが <info>false</info> の場合、 配列の要素は追加されません。

<comment>See Also:</comment>
   * <strong>filter_input()</strong>
   * <strong>filter_var_array()</strong>
   * 


id: filter_list
type: function
doc:
<comment>Description:</comment>
  サポートされるフィルタの一覧を返す

<comment>Return:</comment>
  <info>array</info>  サポートされる全フィルタの名前の配列を返します。 フィルタが存在しない場合は空の配列を返しま
         す。 この配列のインデックスはフィルタの ID ではありません。 ID を取得するには <strong>filter_id()</strong>
         にフィルタ名を渡します。


