# php_manual

id: sqlsrv_prepare
type: function
doc:
<comment>Description:</comment>
  Prepares a query for execution
  
  Prepares a query for execution. This function is ideal for preparing a query  that will be
  executed multiple times with different parameter values.

<comment>Param:</comment>
  <info>resource</info>  <strong>$conn</strong>     A connection resource returned by <strong>sqlsrv_connect()</strong>.
  <info>string</info>    <strong>$sql</strong>      The string that defines the query to be prepared and executed.
  <info>array</info>     <strong>$params</strong>   An array specifying parameter information when executing a parameterized
                      query. Array elements can be any of the following: A literal valueA PHP
                      variableAn array with this structure:  array($value [, $direction [, $phpType
                      [, $sqlType]]]) The following table describes the elements in the array
                      structure above:
  <info>array</info>     <strong>$options</strong>  An array specifying query property options. The supported keys are described
                      in the following table:

<comment>Return:</comment>
  <info>mixed</info>  Returns a statement resource on success and <info>false</info> if an error occurred.

<comment>See Also:</comment>
   * <strong>sqlsrv_execute()</strong>
   * <strong>sqlsrv_query()</strong>


id: sqlsrv_query
type: function
doc:
<comment>Description:</comment>
  Prepares and executes a query
  
  Prepares and executes a query.

<comment>Param:</comment>
  <info>resource</info>  <strong>$conn</strong>     A connection resource returned by <strong>sqlsrv_connect()</strong>.
  <info>string</info>    <strong>$sql</strong>      The string that defines the query to be prepared and executed.
  <info>array</info>     <strong>$params</strong>   An array specifying parameter information when executing a parameterized
                      query.  Array elements can be any of the following: A literal valueA PHP
                      variableAn array with this structure:  array($value [, $direction [, $phpType
                      [, $sqlType]]]) The following table describes the elements in the array
                      structure above:
  <info>array</info>     <strong>$options</strong>  An array specifying query property options. The supported keys are described
                      in the following table:

<comment>Return:</comment>
  <info>mixed</info>  Returns a statement resource on success and <info>false</info> if an error occurred.

<comment>See Also:</comment>
   * <strong>sqlsrv_prepare()</strong>
   * <strong>sqlsrv_execute()</strong>


id: sqlsrv_rollback
type: function
doc:
<comment>Description:</comment>
  Rolls back a transaction that was begun with 
    sqlsrv_begin_transaction
  
  Rolls back a transaction that was begun with <strong>sqlsrv_begin_transaction()</strong>  and returns the
  connection to auto-commit mode.

<comment>Param:</comment>
  <info>resource</info>  <strong>$conn</strong>  The connection resource returned by a call to <strong>sqlsrv_connect()</strong>.

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

<comment>See Also:</comment>
   * <strong>sqlsrv_begin_transaction()</strong>
   * <strong>sqlsrv_commit()</strong>


id: sqlsrv_rows_affected
type: function
doc:
<comment>Description:</comment>
  Returns the number of rows modified by the last INSERT, UPDATE, or 
    DELETE query executed
  
  Returns the number of rows modified by the last INSERT, UPDATE, or DELETE  query executed. For
  information about the number of rows returned by a SELECT  query, see <strong>sqlsrv_num_rows()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stmt</strong>  The executed statement resource for which the number of affected rows is
                   returned.

<comment>Return:</comment>
  <info>int|false</info>  Returns the number of rows affected by the last INSERT, UPDATE, or DELETE query.  If no
             rows were affected, 0 is returned. If the number of affected rows cannot  be
             determined, -1 is returned. If an error occurred, <info>false</info> is returned.

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


id: sqlsrv_send_stream_data
type: function
doc:
<comment>Description:</comment>
  Sends data from parameter streams to the server
  
  Send data from parameter streams to the server. Up to 8 KB of data is sent  with each call.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stmt</strong>  A statement resource returned by <strong>sqlsrv_query()</strong> or  <strong>sqlsrv_execute()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if there is more data to send and <info>false</info> if there is not.

<comment>See Also:</comment>
   * <strong>sqlsrv_prepare()</strong>
   * <strong>sqlsrv_query()</strong>


id: sqlsrv_server_info
type: function
doc:
<comment>Description:</comment>
  Returns information about the server
  
  Returns information about the server.

<comment>Param:</comment>
  <info>resource</info>  <strong>$conn</strong>  The connection resource that connects the client and the server.

<comment>Return:</comment>
  <info>array</info>  Returns an array as described in the following table: Returned ArrayCurrentDatabaseThe
         connected-to database.SQLServerVersionThe SQL Server version.SQLServerNameThe name of the
         server.

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


id: sqrt
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> の平方根を返します。 負の数を指定した場合は、特別な値 <return>NAN</return> を返します。

<comment>See Also:</comment>
   * <strong>pow()</strong>
   * <info>M_SQRTPI</info> - sqrt(pi)
   * <info>M_2_SQRTPI</info> - 2/sqrt(pi)
   * <info>M_SQRT2</info> - sqrt(2)
   * <info>M_SQRT3</info> - sqrt(3)
   * <info>M_SQRT1_2</info> - 1/sqrt(2)


id: srand
type: function
doc:
<comment>Description:</comment>
  乱数生成器を初期化する
  
  シード <strong>$seed</strong> で乱数生成器を初期化します。 <strong>$seed</strong> に <return>0</return> を指定した場合はランダムな値が設定されます。
  
  <strong>srand()</strong> または
  <strong>mt_srand()</strong>
  によりランダム数生成器にシードを与える必要はありません。
  これは、この処理が自動的に行われるためです。
  
  Mt19937 (メルセンヌ・ツイスター) エンジンは、シードとして32ビットの整数だけを受け入れます。よっ
  て、219937-1 もの周期を持つにも関わらず、あり得るランダムなシーケンスの数はたかだか 232 (つまり
  4,294,967,296) しかありません。
  
  暗黙、または明示的にランダムなシードに依存する場合、 重複がそれ(4,294,967,296 個)よりも早く発生し
  ます。 誕生日のパラドックスによると、80,000 個以下のランダムな値を生成した場合でも、 シードの重複
  が 50% の確率で発生します。 重複したシードの 10% が、ざっと 30,000 個のランダムな値を生成したあと
  に発生します。
  
  このため、無視できる確率以上に重複したシーケンスが発生してはいけないアプリケーションでは、Mt19937
  は適していません。 再現可能なシードが必須の場合、 <class>Random\Engine\Xoshiro256StarStar</class> と
  <class>Random\Engine\PcgOneseq128XslRr64</class> が、ランダムな値が衝突しにくく、より大きなシードをサポートしてい
  ます。 再現可能なシードが必須でない場合、 <class>Random\Engine\Secure</class> が、暗号学的にセキュアなランダム性
  を提供します。
  
  PHP 7.1.0 以降、<strong>srand()</strong> は、<strong>mt_srand()</strong> のエイリアスになりました。

<comment>Param:</comment>
  <info>int</info>  <strong>$seed</strong>  任意の整数値で指定するシード値。

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

<comment>See Also:</comment>
   * <strong>rand()</strong>
   * <strong>getrandmax()</strong>
   * <strong>mt_srand()</strong>


id: sscanf
type: function
doc:
<comment>Description:</comment>
  フォーマット文字列に基づき入力を処理する
  
  関数 <strong>sscanf()</strong> は、<strong>printf()</strong> の入力版です。<strong>sscanf()</strong> は、文字列 <strong>$string</strong> を読み込み、これを指定した
  フォーマット <strong>$format</strong> に基づき解釈します。
  
  フォーマット文字列の中のあらゆる空白文字は、入力文字列の中の 空白文字列にマッチします。つまり、
  フォーマット文字列の中にタブ文字 (<return>\t</return>) が含まれていても、 それは入力中の半角スペースにマッチしてし
  まうということです。

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  入力文字列。
  <info>string</info>  <strong>$format</strong>  <strong>$string</strong> を解釈するフォーマット。 <strong>sprintf()</strong> のドキュメントにある説明と比べて、以下
                   の違いがあります。  ロケールに対応していません。 <return>F</return>、<return>g</return>、<return>G</return> および <return>b</return> はサポートして
                   いません。 <return>D</return> は十進数値を表します。 <return>i</return> は基数検出つきの整数値を表します。 <return>n</return> は処理
                   する文字数を表します。 <return>s</return> は、空白文字を読み取ると停止することを示します。 <return>argnum$</return>
                   の代わりに <return>*</return> を指定すると、 この変換仕様に従った値の代入を抑制します。
  <info>mixed</info>   <strong>$vars</strong>    オプションで指定する参照渡しの変数に、 パースされた値が格納されます。

<comment>Return:</comment>
  <info>array|int|null</info>  この関数のパラメータが二つだけの場合、処理された値は配列として返されます。 それ以
                  外の場合は、もしオプションのパラメータが渡されればこの関数は 割り当てられた値の数
                  を返します。オプションのパラメータは 参照渡しにする必要があります。
                  
                  <strong>$format</strong> で期待する部分文字列のほうが 実際に <strong>$string</strong> に存在するものより多い場合は
                  <info>null</info> を返します。

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


id: ssdeep_fuzzy_compare
type: function
doc:
<comment>Description:</comment>
  Calculates the match score between two fuzzy hash signatures
  
  Calculates the match score between <strong>$signature1</strong> and <strong>$signature2</strong> using  context-triggered piecewise
  hashing, and returns the match score.

<comment>Param:</comment>
  <info>string</info>  <strong>$signature1</strong>  The first fuzzy hash signature string.
  <info>string</info>  <strong>$signature2</strong>  The second fuzzy hash signature string.

<comment>Return:</comment>
  <info>int</info>  Returns an integer from 0 to 100 on success, <info>false</info> otherwise.


id: ssdeep_fuzzy_hash
type: function
doc:
<comment>Description:</comment>
  Create a fuzzy hash from a string
  
  <strong>ssdeep_fuzzy_hash()</strong> calculates the hash of  <strong>$to_hash</strong> using  context-triggered piecewise hashing,
  and returns that hash.

<comment>Param:</comment>
  <info>string</info>  <strong>$to_hash</strong>  The input string.

<comment>Return:</comment>
  <info>string</info>  Returns a string on success, <info>false</info> otherwise.


id: ssdeep_fuzzy_hash_filename
type: function
doc:
<comment>Description:</comment>
  Create a fuzzy hash from a file
  
  <strong>ssdeep_fuzzy_hash_filename()</strong> calculates the hash  of the file specified by <strong>$file_name</strong> using
  context-triggered piecewise  hashing, and returns that hash.

<comment>Param:</comment>
  <info>string</info>  <strong>$file_name</strong>  The filename of the file to hash.

<comment>Return:</comment>
  <info>string</info>  Returns a string on success, <info>false</info> otherwise.


id: ssh2_auth_agent
type: function
doc:
<comment>Description:</comment>
  SSH の認証を、ssh agent を使って行う
  
  SSH の認証を、ssh agent を使って行います。
  
  <strong>ssh2_auth_agent()</strong> 関数が使えるのは、 ssh2 拡張モジュールのコンパイルに libssh &gt;= 1.2.3 を使った
  場合だけです。

<comment>Param:</comment>
  <info>resource</info>  <strong>$session</strong>   SSH 接続リンク ID。 <strong>ssh2_connect()</strong> を呼んで取得したもの。
  <info>string</info>    <strong>$username</strong>  リモートのユーザー名。

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


id: ssh2_auth_hostbased_file
type: function
doc:
<comment>Description:</comment>
  ホスト公開鍵を使用して認証を行う
  
  ファイルから読み込まれたホスト公開鍵を使用して認証を行います。

<comment>Param:</comment>
  <info>resource</info>  <strong>$session</strong>         <strong>ssh2_connect()</strong> のコールによって取得した SSH 接続リンク ID。
  <info>string</info>    <strong>$username</strong>        
  <info>string</info>    <strong>$hostname</strong>        
  <info>string</info>    <strong>$pubkeyfile</strong>      
  <info>string</info>    <strong>$privkeyfile</strong>     
  <info>string</info>    <strong>$passphrase</strong>      もし <strong>$privkeyfile</strong> が暗号化されている (そのはずです) 場合、パスフレーズ
                             を渡す必要があります。
  <info>string</info>    <strong>$local_username</strong>  もし <strong>$local_username</strong> を省略した場合、 <strong>$username</strong> の値を使用します。

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


id: ssh2_auth_none
type: function
doc:
<comment>Description:</comment>
  "none" として認証する
  
  通常失敗する（そしてそうあるべき）"none" 認証を試みます。 失敗の一環として、サーバーは可能な認証メ
  ソッドの一覧を返します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$session</strong>   <strong>ssh2_connect()</strong> のコールによって取得した SSH 接続リンク ID。
  <info>string</info>    <strong>$username</strong>  リモートのユーザー名。

<comment>Return:</comment>
  <info>mixed</info>  もしサーバーが <strong>$username</strong> に対する認証メソッドとして "none" を受け入れる場合、この関数は単純
         に <info>true</info> を返します。


id: ssh2_auth_password
type: function
doc:
<comment>Description:</comment>
  SSH 上でプレーンなパスワードを使用した認証を行う
  
  SSH 上でプレーンなパスワードを使用した認証を行います。 バージョン 0.12 以降、この関数は
  keyboard_interactive 方式にも対応するようになりました。

<comment>Param:</comment>
  <info>resource</info>  <strong>$session</strong>   <strong>ssh2_connect()</strong> のコールによって取得した SSH 接続リンク ID。
  <info>string</info>    <strong>$username</strong>  リモートのユーザー名。
  <info>string</info>    <strong>$password</strong>  <strong>$username</strong> のパスワード。

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


id: ssh2_auth_pubkey_file
type: function
doc:
<comment>Description:</comment>
  公開鍵を使用した認証を行う
  
  ファイルから読み込んだ公開鍵を使用した認証を行います。

<comment>Param:</comment>
  <info>resource</info>  <strong>$session</strong>      <strong>ssh2_connect()</strong> のコールによって取得した SSH 接続リンク ID。
  <info>string</info>    <strong>$username</strong>     
  <info>string</info>    <strong>$pubkeyfile</strong>   公開鍵ファイル。OpenSSH 形式で表す必要があり、たとえば次のようになります。
                          
                          ssh-rsa AAAAB3NzaC1yc2EAAA....NX6sqSnHA8= rsa-key-20121110
  <info>string</info>    <strong>$privkeyfile</strong>  
  <info>string</info>    <strong>$passphrase</strong>   もし、<strong>$privkeyfile</strong> が暗号化されている (そうあるべきです) 場合、パスフレー
                          ズも引数に渡す必要があります。

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


id: ssh2_connect
type: function
doc:
<comment>Description:</comment>
  SSH サーバーに接続する
  
  リモートの SSH サーバーとの接続を確立します。
  
  一度接続すると、クライアントは <strong>ssh2_fingerprint()</strong> を使用してサーバーのホスト鍵を検証し、 パスワー
  ドもしくは公開鍵を使用して認証します。

<comment>Param:</comment>
  <info>string</info>  <strong>$host</strong>       
  <info>int</info>     <strong>$port</strong>       
  <info>array</info>   <strong>$methods</strong>    <strong>$methods</strong> は以下に示された4つのパラメータを持つ連想配列です。
                      
                      <strong>$methods</strong> は以下のパラメータのいくつかあるいは全てを含む連想配列インデックス意
                      味サポートする値*kex 通知する鍵交換メソッドのリスト。優先する順にカンマ区切り
                      にする。 <return>diffie-hellman-group1-sha1</return>、 <return>diffie-hellman-group14-sha1</return> および
                      <return>diffie-hellman-group-exchange-sha1</return> hostkey 通知するホスト鍵メソッドのリスト。
                      優先する順にカンマ区切りにする。 <return>ssh-rsa</return> および <return>ssh-dss</return> client_to_server クラ
                      イアントからサーバーに送信されるメッセージのために優先する暗号化、 圧縮、メッ
                      セージ認証コード (MAC) メソッドを含む連想配列。 server_to_client サーバーから
                      クライアントに送信されるメッセージのために優先する暗号化、 圧縮、メッセージ認
                      証コード (MAC) メソッドを含む連想配列。
                      
                      * - サポートする値は、 構成するライブラリがサポートしているメソッドに依存しま
                      す。 追加情報については libssh2 ドキュメントを参照ください。
                      
                      <strong>$client_to_server</strong> と <strong>$server_to_client</strong> は以下のパラメータのいくつかあるいは全
                      てを含む連想配列 インデックス意味サポートする値*crypt通知する暗号化メソッドの
                      リスト。 優先する順にカンマ区切りにする。<return>rijndael-cbc@lysator.liu.se</return>、
                      <return>aes256-cbc</return>、 <return>aes192-cbc</return>、 <return>aes128-cbc</return>、 <return>3des-cbc</return>、 <return>blowfish-cbc</return>、 <return>cast128-cbc</return>、
                      <return>arcfour</return> および <return>none**</return> comp通知する圧縮メソッドのリスト。 優先する順にカンマ区
                      切りにする。<return>zlib</return> および <return>none</return> mac通知する MAC メソッドのリスト。 優先する順にカ
                      ンマ区切りにする。<return>hmac-sha1</return>、 <return>hmac-sha1-96</return>、 <return>hmac-ripemd160</return>、
                      <return>hmac-ripemd160@openssh.com</return> および <return>none**</return>
                      
                      暗号化、MAC メソッドの "<return>none</return>" セキュリティ上の問題で、<return>none</return> は ビルド時に適切な
                      ./configure オプションを使用して明示的に有効にしない限り、構成している libssh2
                      によって無効にされます。 詳細は構成するライブラリのドキュメントを参照くださ
                      い。
                      
                      セキュリティ上の問題で、<return>none</return> は ビルド時に適切な ./configure オプションを使用
                      して明示的に有効にしない限り、構成している libssh2 によって無効にされます。 詳
                      細は構成するライブラリのドキュメントを参照ください。
  <info>array</info>   <strong>$callbacks</strong>  <strong>$callbacks</strong> は以下のパラメータのいくつかあるいは全てを含む連想配列  コールバッ
                      クパラメータ インデックス意味プロトタイプignore<info>SSH2_MSG_IGNORE</info> パケットを受信
                      したときにコールする関数名 void ignore_cb($message)debug<info>SSH2_MSG_DEBUG</info> パケッ
                      トを受信したときにコールする関数名 void debug_cb($message, $language,
                      $always_display)macerror パケットを受信したがメッセージ認証コードに失敗した場
                      合にコールされる関数名。 もしコールバックが <info>true</info> を返す場合、不整合は無視され
                      ます。 そうでない場合、接続は終了します。 bool
                      macerror_cb($packet)disconnect<info>SSH2_MSG_DISCONNECT</info> パケットを受信したときにコー
                      ルする関数名 void disconnect_cb($reason, $message, $language)

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

<comment>See Also:</comment>
   * <strong>ssh2_fingerprint()</strong>
   * <strong>ssh2_auth_none()</strong>
   * <strong>ssh2_auth_password()</strong>
   * <strong>ssh2_auth_pubkey_file()</strong>
   * <strong>ssh2_disconnect()</strong>


id: ssh2_disconnect
type: function
doc:
<comment>Description:</comment>
  Close a connection to a remote SSH server
  
  Close a connection to a remote SSH server.

<comment>Param:</comment>
  <info>resource</info>  <strong>$session</strong>  An SSH connection link identifier, obtained from a call to <strong>ssh2_connect()</strong>.

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

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


id: ssh2_exec
type: function
doc:
<comment>Description:</comment>
  リモートサーバー上でコマンドを実行する
  
  コマンドをリモートエンドで実行し、チャネルを割り当てます。

<comment>Param:</comment>
  <info>resource</info>  <strong>$session</strong>            <strong>ssh2_connect()</strong> のコールによって取得した SSH 接続リンク ID。
  <info>string</info>    <strong>$command</strong>            
  <info>string</info>    <strong>$pty</strong>                
  <info>array</info>     <strong>$env</strong>                <strong>$env</strong> には、 対象となる環境で設定する名前/値のペアを連想配列で渡しま
                                す。
  <info>int</info>       <strong>$width</strong>              仮想端末の幅。
  <info>int</info>       <strong>$height</strong>             仮想端末の高さ。
  <info>int</info>       <strong>$width_height_type</strong>  <strong>$width_height_type</strong> は、 <info>SSH2_TERM_UNIT_CHARS</info> あるいは
                                <info>SSH2_TERM_UNIT_PIXELS</info> のいずれかです。

<comment>Return:</comment>
  <info>resource|false</info>  成功時にストリームを返し、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>ssh2_connect()</strong>
   * <strong>ssh2_shell()</strong>
   * <strong>ssh2_tunnel()</strong>


id: ssh2_fetch_stream
type: function
doc:
<comment>Description:</comment>
  拡張データストリームを取得する
  
  SSH2 チャネルストリームと関連付けられたサブストリームを取得します。 SSH2 プロトコルは現在ただ 1 つ
  のサブストリーム STDERR を定義しています。これはサブストリーム ID として <info>SSH2_STREAM_STDERR</info> (1 と
  して定義) を持ちます。

<comment>Param:</comment>
  <info>resource</info>  <strong>$channel</strong>   
  <info>int</info>       <strong>$streamid</strong>  SSH2 チャネルストリーム。

<comment>Return:</comment>
  <info>resource</info>  ストリームリソースを返します。

<comment>See Also:</comment>
   * <strong>ssh2_shell()</strong>
   * <strong>ssh2_exec()</strong>
   * <strong>ssh2_connect()</strong>


id: ssh2_fingerprint
type: function
doc:
<comment>Description:</comment>
  リモートサーバーのフィンガープリントを処理する
  
  アクティブなセッションからサーバーホスト鍵のハッシュを返します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$session</strong>  <strong>ssh2_connect()</strong> のコールによって取得した SSH 接続リンク ID。
  <info>int</info>       <strong>$flags</strong>    <strong>$flags</strong> は <info>SSH2_FINGERPRINT_MD5</info>、 <info>SSH2_FINGERPRINT_HEX</info> で論理和された
                      <info>SSH2_FINGERPRINT_SHA1</info>、 <info>SSH2_FINGERPRINT_RAW</info> のいずれかです。

<comment>Return:</comment>
  <info>string</info>  ホストキーのハッシュを文字列で返します。


id: ssh2_forward_accept
type: function
doc:
<comment>Description:</comment>
  リスナーによって作られた接続を受け付ける
  
  リスナーによって作られた接続を受け付けます。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info></info>  <strong>$desc</strong>  SSH2 リスナーのリソースを指定します。 これは、<strong>ssh2_forward_listen()</strong> を呼び出すことで得ら
           れます。

<comment>Return:</comment>
  <info>resource|false</info>  ストリームリソースを返します。 失敗した場合に <info>false</info> を返します.


id: ssh2_forward_listen
type: function
doc:
<comment>Description:</comment>
  リモートサーバー上のポートにバインドし、接続を待つ
  
  リモートサーバー上のポートにバインドし、接続を待ちます。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>resource</info>  <strong>$session</strong>          SSH セッションのリソースを指定します。 この値は、<strong>ssh2_connect()</strong> を呼び
                              出すことで得られます。
  <info>int</info>       <strong>$port</strong>             リモートサーバー上のポート番号を指定します。
  <info>string</info>    <strong>$host</strong>             
  <info>int</info>       <strong>$max_connections</strong>  

<comment>Return:</comment>
  <info>resource|false</info>  SSH2 リスナーを返します。 失敗した場合に <info>false</info> を返します.

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


id: ssh2_methods_negotiated
type: function
doc:
<comment>Description:</comment>
  ネゴシエートされたメソッドのリストを返す
  
  ネゴシエートされたメソッドのリストを返します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$session</strong>  <strong>ssh2_connect()</strong> のコールによって取得した SSH 接続リンク ID。

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

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


id: ssh2_poll
type: function
doc:
<comment>Description:</comment>
  チャンネル/リスナー/ストリーム のイベントをポーリングする
  
  チャンネル/リスナー/ストリーム のイベントをポーリングし、 1個以上のイベントを返したディスクリプタ
  の数を返します。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>array</info>  <strong>$desc</strong>     <return>'resource'</return> と <return>'events'</return> をキーとした配列の、インデックス付きの配列。 リソースの値
                   は、(チャンネルの)ストリーム、 または SSH2 リスナーのリソースです。 イベントの値
                   は、SSH2_POLL* フラグを bitwise OR でまとめて指定します。 それぞれの配列は、返さ
                   れる際に <return>'revents'</return> 要素にまとめられ、 発生したイベントの SSH2_POLL* フラグが
                   bitwize OR でまとまったものがその値になります。
  <info>int</info>    <strong>$timeout</strong>  タイムアウトさせる時間を秒単位で指定します。

<comment>Return:</comment>
  <info>int</info>  1個以上のイベントを返したディスクリプタの数を返します。


id: ssh2_publickey_add
type: function
doc:
<comment>Description:</comment>
  認証済み公開鍵を追加する
    
  
  この公開鍵サブシステムは、クライアントが認証 済 の
  公開鍵をサーバー上で管理するために使用されます。
  公開鍵認証によりリモートシステムで認証を行うには、かわりに
  <strong>ssh2_auth_pubkey_file()</strong> 関数を使用してください。

<comment>Param:</comment>
  <info>resource</info>  <strong>$pkey</strong>        <strong>ssh2_publickey_init()</strong> が作成した、 公開鍵サブシステムのリソース。
  <info>string</info>    <strong>$algoname</strong>    公開鍵のアルゴリズム。例: ssh-dss、ssh-rsa
  <info>string</info>    <strong>$blob</strong>        生のバイナリデータとしての blob 形式の公開鍵。
  <info>bool</info>      <strong>$overwrite</strong>   指定したキーがすでに存在する場合に、それを上書きしますか?
  <info>array</info>     <strong>$attributes</strong>  この公開鍵に代入する属性の連想配列。サポートされる属性の一覧は、
                         ietf-secsh-publickey-subsystem を参照ください。 必須属性を設定するには、属
                         性名の先頭にアスタリスクをつけてください。 サーバーが必須属性をサポートして
                         いない場合、追加処理は異常終了します。

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

<comment>See Also:</comment>
   * <strong>ssh2_publickey_init()</strong>
   * <strong>ssh2_publickey_remove()</strong>
   * <strong>ssh2_publickey_list()</strong>


id: ssh2_publickey_init
type: function
doc:
<comment>Description:</comment>
  公開鍵サブシステムを初期化する
    
  
  すでに接続している SSH2 サーバーから、公開鍵サブシステムを要求します。
  
  公開鍵サブシステムを使用すると、 すでに接続・認証済みのクライアントが、 対象のサーバーに保存されて
  いる認証済み公開鍵の一覧を管理できるようになります。 管理方法は、サーバーの実装に依存しません。 リ
  モートサーバーが公開鍵サブシステムをサポートしていない場合、 <strong>ssh2_publickey_init()</strong> 関数は <info>false</info> を
  返します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$session</strong>  

<comment>Return:</comment>
  <info>resource|false</info>  他のすべての ssh2_publickey_*() メソッドで使用する、 <return>SSH2 公開鍵サブシステム</return>リソー
                  スを返します。 失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>ssh2_publickey_add()</strong>
   * <strong>ssh2_publickey_remove()</strong>
   * <strong>ssh2_publickey_list()</strong>


id: ssh2_publickey_list
type: function
doc:
<comment>Description:</comment>
  現在認証済みの公開鍵の一覧を表示する
    
  
  現在認証済みの公開鍵の一覧を表示します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$pkey</strong>  公開鍵サブシステムのリソース。

<comment>Return:</comment>
  <info>array</info>  鍵を、数値添字の配列で返します。 個々の要素は連想配列となっており、その内容は name、blob、
         および attrs です。
         
         公開鍵の要素配列のキー意味name この公開鍵で使用しているアルゴリズムの名前。例: <return>ssh-dss</return> ある
         いは <return>ssh-rsa</return>。 blob生のバイナリデータとしての blob 形式の公開鍵。attrs この公開鍵に割り当て
         る属性。 もっとも一般的な属性であり、バージョン 1 の公開鍵サーバーが唯一サポートしている属
         性は <return>comment</return> です。これは任意の書式の文字列です。

<comment>See Also:</comment>
   * <strong>ssh2_publickey_init()</strong>
   * <strong>ssh2_publickey_add()</strong>
   * <strong>ssh2_publickey_remove()</strong>


id: ssh2_publickey_remove
type: function
doc:
<comment>Description:</comment>
  認証済み公開鍵を取り除く
    
  
  認証済み公開鍵を取り除きます。

<comment>Param:</comment>
  <info>resource</info>  <strong>$pkey</strong>      公開鍵サブシステムのリソース。
  <info>string</info>    <strong>$algoname</strong>  公開鍵のアルゴリズム。例: ssh-dss、ssh-rsa
  <info>string</info>    <strong>$blob</strong>      生のバイナリデータとしての blob 形式の公開鍵。

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

<comment>See Also:</comment>
   * <strong>ssh2_publickey_init()</strong>
   * <strong>ssh2_publickey_add()</strong>
   * <strong>ssh2_publickey_list()</strong>


id: ssh2_scp_recv
type: function
doc:
<comment>Description:</comment>
  SCP 経由でファイルを要求する
  
  リモートサーバーからローカルファイルシステムに SCP プロトコルを使用してコピーします。

<comment>Param:</comment>
  <info>resource</info>  <strong>$session</strong>      <strong>ssh2_connect()</strong> のコールによって取得した SSH 接続リンク ID。
  <info>string</info>    <strong>$remote_file</strong>  リモートファイルへのパス。
  <info>string</info>    <strong>$local_file</strong>   ローカルファイルへのパス。

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

<comment>See Also:</comment>
   * <strong>ssh2_scp_send()</strong>
   * <strong>copy()</strong>


id: ssh2_scp_send
type: function
doc:
<comment>Description:</comment>
  SCP 経由でファイルを送信する
  
  ローカルファイルシステムからリモートサーバーに SCP プロトコルを使用してコピーします。

<comment>Param:</comment>
  <info>resource</info>  <strong>$session</strong>      <strong>ssh2_connect()</strong> のコールによって取得した SSH 接続リンク ID。
  <info>string</info>    <strong>$local_file</strong>   ローカルファイルへのパス。
  <info>string</info>    <strong>$remote_file</strong>  リモートファイルへのパス。
  <info>int</info>       <strong>$create_mode</strong>  ファイルは <strong>$create_mode</strong> で指定されたモードで作成されます。

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

<comment>See Also:</comment>
   * <strong>ssh2_scp_recv()</strong>
   * <strong>copy()</strong>


id: ssh2_send_eof
type: function
doc:
<comment>Description:</comment>
  ストリームに EOF を送信する
  
  ストリームに EOF を送信します。 この関数は通常、標準入力をクローズしつつ、 標準出力と標準エラー出
  力は活かしておく用途に使います。 たとえば、リモートのプロセスに標準入力経由でデータを送信し、 処理
  する際にはそれをクローズします。 そうすれば、追加のファイルを作ることなく、 処理結果を読み取ること
  が出来ます。

<comment>Param:</comment>
  <info>resource</info>  <strong>$channel</strong>  SSH のストリーム。 <strong>ssh2_fetch_stream()</strong> や <strong>ssh2_connect()</strong> のような関数から取得
                      できます。

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

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


id: ssh2_sftp
type: function
doc:
<comment>Description:</comment>
  SFTP サブシステムを初期化する
  
  すでに接続された SSH2 サーバーから SFTP サブシステムを要求します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$session</strong>  <strong>ssh2_connect()</strong> のコールによって取得した SSH 接続リンク ID。

<comment>Return:</comment>
  <info>resource|false</info>  このメソッドは全ての他の ssh2_sftp_*() や ssh2.sftp:// fopen ラッパーで使用する
                  <return>SSH2 SFTP</return> リソースを返します。 失敗した場合に <info>false</info> を返します

<comment>See Also:</comment>
   * <strong>ssh2_scp_recv()</strong>
   * <strong>ssh2_scp_send()</strong>


id: ssh2_sftp_chmod
type: function
doc:
<comment>Description:</comment>
  ファイルのモードを変更する
  
  指定したファイルのモードの <strong>$mode</strong> への変更を試みます。

<comment>Param:</comment>
  <info>resource</info>  <strong>$sftp</strong>      SSH2 SFTP リソース。<strong>ssh2_sftp()</strong> で開いたもの。
  <info>string</info>    <strong>$filename</strong>  ファイルへのパス。
  <info>int</info>       <strong>$mode</strong>      ファイルのパーミッション。このパラメータの詳細は <strong>chmod()</strong> を参照ください。

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

<comment>See Also:</comment>
   * <strong>chmod()</strong>
   * <strong>ssh2_sftp()</strong>
   * <strong>ssh2_connect()</strong>


id: ssh2_sftp_lstat
type: function
doc:
<comment>Description:</comment>
  シンボリックリンクの情報を取得する
  
  リンクを辿らないで リモートファイルシステムのシンボリックリンクの情報を取得します。
  
  この関数は ssh2.sftp:// ラッパーを使用した場合の <strong>lstat()</strong> 関数と同様です。 戻り値も同じです。

<comment>Param:</comment>
  <info>resource</info>  <strong>$sftp</strong>  <strong>ssh2_sftp()</strong> でオープンした SSH2 SFTP リソース。
  <info>string</info>    <strong>$path</strong>  リモートのシンボリックリンクへのパス。

<comment>Return:</comment>
  <info>array</info>  戻り値の詳細については <strong>stat()</strong> のドキュメントを参照ください。

<comment>See Also:</comment>
   * <strong>ssh2_sftp_stat()</strong>
   * <strong>lstat()</strong>
   * <strong>stat()</strong>


id: ssh2_sftp_mkdir
type: function
doc:
<comment>Description:</comment>
  ディレクトリを作成する
  
  リモートファイルサーバーに <strong>$mode</strong> で指定された権限でディレクトリを作成します。
  
  この関数は ssh2.sftp:// ラッパーを使用した場合の <strong>mkdir()</strong> と同様です。

<comment>Param:</comment>
  <info>resource</info>  <strong>$sftp</strong>       <strong>ssh2_sftp()</strong> でオープンした SSH2 SFTP リソース。
  <info>string</info>    <strong>$dirname</strong>    新しいディレクトリへのパス。
  <info>int</info>       <strong>$mode</strong>       新しいディレクトリのパーミッション。 実際のパーミッションの値は、現在の
                        umask の影響を受けます。
  <info>bool</info>      <strong>$recursive</strong>  もし <strong>$recursive</strong> が <info>true</info> の場合、 <strong>$dirname</strong> に必要とされる全ての親ディレクトリ
                        は自動的に作成されます。

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

<comment>See Also:</comment>
   * <strong>mkdir()</strong>
   * <strong>ssh2_sftp_rmdir()</strong>


id: ssh2_sftp_readlink
type: function
doc:
<comment>Description:</comment>
  シンボリックリンクのターゲットを返す
  
  シンボリックリンクのターゲットを返します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$sftp</strong>  <strong>ssh2_sftp()</strong> でオープンした SSH2 SFTP リソース。
  <info>string</info>    <strong>$link</strong>  シンボリックリンクへのパス。

<comment>Return:</comment>
  <info>string</info>  シンボリックリンク <strong>$link</strong> のターゲットを返します。

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


id: ssh2_sftp_realpath
type: function
doc:
<comment>Description:</comment>
  指定されたパス文字列の実パスを解決する
  
  <strong>$filename</strong> をリモートファイルシステム上の有効な実パスに変換します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$sftp</strong>      <strong>ssh2_sftp()</strong> でオープンした SSH2 SFTP リソース。
  <info>string</info>    <strong>$filename</strong>  

<comment>Return:</comment>
  <info>string</info>  実際のパスを表す文字列を返します。

<comment>See Also:</comment>
   * <strong>realpath()</strong>
   * <strong>ssh2_sftp_symlink()</strong>
   * <strong>ssh2_sftp_readlink()</strong>


id: ssh2_sftp_rename
type: function
doc:
<comment>Description:</comment>
  リモートファイルを改名する
  
  リモートファイルシステム上のファイルを改名します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$sftp</strong>  <strong>ssh2_sftp()</strong> でオープンした SSH2 SFTP リソース。
  <info>string</info>    <strong>$from</strong>  名前を変更したいファイル。
  <info>string</info>    <strong>$to</strong>    <strong>$from</strong> のかわりに新しく使用したいファイル名。

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

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


id: ssh2_sftp_rmdir
type: function
doc:
<comment>Description:</comment>
  ディレクトリを削除する
  
  リモートのファイルサーバーからディレクトリを削除します。
  
  この関数は ssh2.sftp:// ラッパーを使用した場合の <strong>rmdir()</strong> と同様です。

<comment>Param:</comment>
  <info>resource</info>  <strong>$sftp</strong>     <strong>ssh2_sftp()</strong> でオープンした SSH2 SFTP リソース。
  <info>string</info>    <strong>$dirname</strong>  

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

<comment>See Also:</comment>
   * <strong>rmdir()</strong>
   * <strong>ssh2_sftp_mkdir()</strong>


id: ssh2_sftp_stat
type: function
doc:
<comment>Description:</comment>
  リモートファイルシステム上のファイルの情報を取得する
  
  シンボリックリンクを辿って リモートファイルシステム上のファイルの情報を取得します。
  
  この関数は ssh2.sftp:// ラッパーを使用した場合の <strong>stat()</strong> 関数と同様です。 返される値も同じです。

<comment>Param:</comment>
  <info>resource</info>  <strong>$sftp</strong>  <strong>ssh2_sftp()</strong> でオープンした SSH2 SFTP リソース。
  <info>string</info>    <strong>$path</strong>  

<comment>Return:</comment>
  <info>array</info>  どのような値が返されるのかについての詳細は、 <strong>stat()</strong> を参照ください。

<comment>See Also:</comment>
   * <strong>ssh2_sftp_lstat()</strong>
   * <strong>lstat()</strong>
   * <strong>stat()</strong>


id: ssh2_sftp_symlink
type: function
doc:
<comment>Description:</comment>
  シンボリックリンクを作成する
  
  リモートファイルシステム上に <strong>$target</strong> を指す <strong>$link</strong> という名称のシンボリックリンクを作成します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$sftp</strong>    <strong>ssh2_sftp()</strong> でオープンした SSH2 SFTP リソース。
  <info>string</info>    <strong>$target</strong>  シンボリックリンクのリンク対象。
  <info>string</info>    <strong>$link</strong>    

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

<comment>See Also:</comment>
   * <strong>ssh2_sftp_readlink()</strong>
   * <strong>symlink()</strong>


id: ssh2_sftp_unlink
type: function
doc:
<comment>Description:</comment>
  ファイルを削除する
  
  リモートファイルシステム上のファイルを削除します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$sftp</strong>      <strong>ssh2_sftp()</strong> でオープンした SSH2 SFTP リソース。
  <info>string</info>    <strong>$filename</strong>  

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

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


id: ssh2_shell
type: function
doc:
<comment>Description:</comment>
  対話式のシェルを要求する
  
  リモートエンド上のシェルをオープンし、そのためのストリームを割り当てます。

<comment>Param:</comment>
  <info>resource</info>    <strong>$session</strong>            <strong>ssh2_connect()</strong> のコールによって取得した SSH 接続リンク ID。
  <info>string</info>      <strong>$termtype</strong>           <strong>$termtype</strong> は対象システムの <return>/etc/termcap</return> に記載されたエントリの一つ
                                  に相当します。
  <info>array|null</info>  <strong>$env</strong>                <strong>$env</strong> には、 対象の環境に設定する名前/値の組の連想配列を渡すことが
                                  できます。
  <info>int</info>         <strong>$width</strong>              仮想端末の幅。
  <info>int</info>         <strong>$height</strong>             仮想端末の高さ。
  <info>int</info>         <strong>$width_height_type</strong>  <strong>$width_height_type</strong> は <info>SSH2_TERM_UNIT_CHARS</info> あるいは
                                  <info>SSH2_TERM_UNIT_PIXELS</info> のいずれかです。

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

<comment>See Also:</comment>
   * <strong>ssh2_exec()</strong>
   * <strong>ssh2_tunnel()</strong>
   * <strong>ssh2_fetch_stream()</strong>


id: ssh2_tunnel
type: function
doc:
<comment>Description:</comment>
  リモートサーバーを経由するトンネルをオープンする
  
  現在接続している SSH サーバーを経由して、 任意のホスト/ポートへのソケットストリームをオープンしま
  す。

<comment>Param:</comment>
  <info>resource</info>  <strong>$session</strong>  <strong>ssh2_connect()</strong> のコールによって取得した SSH 接続リンク ID。
  <info>string</info>    <strong>$host</strong>     
  <info>int</info>       <strong>$port</strong>     

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

<comment>See Also:</comment>
   * <strong>ssh2_connect()</strong>
   * <strong>fsockopen()</strong>


id: stat
type: function
doc:
<comment>Description:</comment>
  ファイルに関する情報を取得する
  
  <strong>$filename</strong>で指定されたファイルに ついての統計情報を取得します。 <strong>$filename</strong> がシンボリックリンクの場
  合、 シンボリックリンクではなくファイルの実体の統計情報が返されます。 Windows 環境、かつ PHP 7.4.0
  より前の NTS ビルドでは、 <return>size</return>, <return>atime</return>, <return>mtime</return>, <return>ctime</return> の統計情報は、シンボリックリンクの値が返されて
  いました。
  
  <strong>lstat()</strong> はシンボリックリンクの統計情報を返すという違いを除いて <strong>stat()</strong> と等価です。

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

<comment>Return:</comment>
  <info>array|false</info>  <strong>stat()</strong> と <strong>fstat()</strong> の結果のフォーマット数値連想配列説明0devデバイス番号 (***)1inoinode
               番号(****)2modeinode プロテクトモード(*****)3nlinkリンク数4uid所有者のユーザー
               ID(*)5gid所有者のグループ ID(*)6rdevinode デバイス の場合、デバイスの種類7sizeバイト
               単位のサイズ8atime最終アクセス時間 (Unix タイムスタンプ)9mtime最終修正時間 (Unix タイ
               ムスタンプ)10ctime最終 inode 変更時間 (Unix タイムスタンプ)11blksizeファイル IO のブ
               ロックサイズ(**)12blocks512 バイトのブロックの確保数(**)
               
               * Windows では常に <return>0</return> となります。
               
               ** st_blksize タイプをサポートするシステムでのみ有効です。 その他のシステム(例えば
               Windows)では <return>-1</return> を返します。
               
               *** PHP 7.4.0 以降、Windows では、この値はファイルが含まれるボリュームのシリアル番号
               です。 これは64ビットの 符号なし 整数です。 よって、オーバーフローする可能性がありま
               す。 これより前のバージョンでは、<strong>stat()</strong> 関数ではドライブレターを数値で表現した値 (た
               とえば、<return>C:</return> では <return>2</return>) でした。 <strong>lstat()</strong> 関数では <return>0</return> でした。
               
               **** PHP 7.4.0 以降、Windows では、この値はファイルに関連付けられた識別子です。 これ
               は64ビットの 符号なし 整数です。 よって、オーバーフローする可能性があります。 これよ
               り前のバージョンでは、この値は常に <return>0</return> でした。
               
               ***** Windows では、 読み取り専用のファイル属性に従って、 書き込み可能のパーミッショ
               ンビットが設定されます。 そして、この値は全てのユーザ、グループ、 オーナーについて、
               同じ値が報告されます。 <strong>is_writable()</strong> とは異なり、ACL は考慮されません。
               
               <return>mode</return> の値は、複数の関数によって読まれる情報が含まれています。 8進数の場合、一番右の桁
               から評価され、はじめの3桁が <strong>chmod()</strong> によって返されます。 次の桁は PHP によって無視さ
               れます。その次の2桁は以下のファイルタイプを示します: <return>mode</return> のファイルタイプ<return>mode</return> が8進
               数だった場合意味<info>0140000</info>ソケット<info>0120000</info>リンク<info>0100000</info>通常のファイル<info>0060000</info>ブロックデバ
               イス<info>0040000</info>ディレクトリ<info>0020000</info>キャラクタデバイス<info>0010000</info>fifo よって、たとえば 通常の
               ファイルは <info>0100644</info> のような値になりますし、 ディレクトリは <info>0040755</info> のような値になりま
               す。
               
               <strong>stat()</strong> はエラーの場合 <info>false</info> を返します。
               
               PHP の数値型は符号付整数であり、 多くのプラットフォームでは 32 ビットの整数を取るた
               め、 ファイルシステム関数の中には 2GB より大きなファイルについては期待とは違う値を返
               すものがあります。

<comment>See Also:</comment>
   * <strong>lstat()</strong>
   * <strong>fstat()</strong>
   * <strong>filemtime()</strong>
   * <strong>filegroup()</strong>
   * <class>SplFileInfo</class>


id: stats_absolute_deviation
type: function
doc:
<comment>Description:</comment>
  Returns the absolute deviation of an array of values
  
  Returns the absolute deviation of the values in <strong>$a</strong>.

<comment>Param:</comment>
  <info>array</info>  <strong>$a</strong>  The input array

<comment>Return:</comment>
  <info>float</info>  Returns the absolute deviation of the values in <strong>$a</strong>, or <info>false</info> if <strong>$a</strong> is empty or is not an
         array.


id: stats_cdf_beta
type: function
doc:
<comment>Description:</comment>
  Calculates any one parameter of the beta distribution given values for the others
  
  Returns the cumulative distribution function, its inverse, or one of its parameters, of the beta
  distribution. The kind of the return value and parameters (<strong>$par1</strong>, <strong>$par2</strong>, and <strong>$par3</strong>) are determined
  by <strong>$which</strong>.
  
  The following table lists the return value and parameters by <strong>$which</strong>. CDF, x, alpha, and beta
  denotes cumulative distribution function, the value of the random variable, and shape parameters
  of the beta distribution, respectively. Return value and parameters<strong>$which</strong>Return
  value<strong>$par1</strong><strong>$par2</strong><strong>$par3</strong>1CDFxalphabeta2xCDFalphabeta3alphaxCDFbeta4betaxCDFalpha

<comment>Param:</comment>
  <info>float</info>  <strong>$par1</strong>   The first parameter
  <info>float</info>  <strong>$par2</strong>   The second parameter
  <info>float</info>  <strong>$par3</strong>   The third parameter
  <info>int</info>    <strong>$which</strong>  The flag to determine what to be calculated

<comment>Return:</comment>
  <info>float</info>  Returns CDF, x, alpha, or beta, determined by <strong>$which</strong>.


id: stats_cdf_binomial
type: function
doc:
<comment>Description:</comment>
  Calculates any one parameter of the binomial distribution given values for the others
  
  Returns the cumulative distribution function, its inverse, or one of its parameters, of the
  binomial distribution. The kind of the return value and parameters (<strong>$par1</strong>, <strong>$par2</strong>, and <strong>$par3</strong>) are
  determined by <strong>$which</strong>.
  
  The following table lists the return value and parameters by <strong>$which</strong>. CDF, x, n, and p denotes
  cumulative distribution function, the number of successes, the number of trials, and the success
  rate for each trial, respectively. Return value and parameters<strong>$which</strong>Return
  value<strong>$par1</strong><strong>$par2</strong><strong>$par3</strong>1CDFxnp2xCDFnp3nxCDFp4pxCDFn

<comment>Param:</comment>
  <info>float</info>  <strong>$par1</strong>   The first parameter
  <info>float</info>  <strong>$par2</strong>   The second parameter
  <info>float</info>  <strong>$par3</strong>   The third parameter
  <info>int</info>    <strong>$which</strong>  The flag to determine what to be calculated

<comment>Return:</comment>
  <info>float</info>  Returns CDF, x, n, or p, determined by <strong>$which</strong>.


id: stats_cdf_cauchy
type: function
doc:
<comment>Description:</comment>
  Calculates any one parameter of the Cauchy distribution given values for the others
  
  Returns the cumulative distribution function, its inverse, or one of its parameters, of the Cauchy
  distribution. The kind of the return value and parameters (<strong>$par1</strong>, <strong>$par2</strong>, and <strong>$par3</strong>) are determined
  by <strong>$which</strong>.
  
  The following table lists the return value and parameters by <strong>$which</strong>. CDF, x, x0, and gamma denotes
  cumulative distribution function, the value of the random variable, the location and the scale
  parameter of the Cauchy distribution, respectively. Return value and parameters<strong>$which</strong>Return
  value<strong>$par1</strong><strong>$par2</strong><strong>$par3</strong>1CDFxx0gamma2xCDFx0gamma3x0xCDFgamma4gammaxCDFx0

<comment>Param:</comment>
  <info>float</info>  <strong>$par1</strong>   The first parameter
  <info>float</info>  <strong>$par2</strong>   The second parameter
  <info>float</info>  <strong>$par3</strong>   The third parameter
  <info>int</info>    <strong>$which</strong>  The flag to determine what to be calculated

<comment>Return:</comment>
  <info>float</info>  Returns CDF, x, x0, or gamma, determined by <strong>$which</strong>.


id: stats_cdf_chisquare
type: function
doc:
<comment>Description:</comment>
  Calculates any one parameter of the chi-square distribution given values for the others
  
  Returns the cumulative distribution function, its inverse, or one of its parameters, of the
  chi-square distribution. The kind of the return value and parameters (<strong>$par1</strong> and <strong>$par2</strong>) are
  determined by <strong>$which</strong>.
  
  The following table lists the return value and parameters by <strong>$which</strong>. CDF, x, and k denotes
  cumulative distribution function, the value of the random variable, and the degree of freedom of
  the chi-square distribution, respectively. Return value and parameters<strong>$which</strong>Return
  value<strong>$par1</strong><strong>$par2</strong>1CDFxk2xCDFk3kxCDF

<comment>Param:</comment>
  <info>float</info>  <strong>$par1</strong>   The first parameter
  <info>float</info>  <strong>$par2</strong>   The second parameter
  <info>int</info>    <strong>$which</strong>  The flag to determine what to be calculated

<comment>Return:</comment>
  <info>float</info>  Returns CDF, x, or k, determined by <strong>$which</strong>.


id: stats_cdf_exponential
type: function
doc:
<comment>Description:</comment>
  Calculates any one parameter of the exponential distribution given values for the others
  
  Returns the cumulative distribution function, its inverse, or one of its parameters, of the
  exponential distribution. The kind of the return value and parameters (<strong>$par1</strong> and <strong>$par2</strong>) are
  determined by <strong>$which</strong>.
  
  The following table lists the return value and parameters by <strong>$which</strong>. CDF, x, and lambda denotes
  cumulative distribution function, the value of the random variable, and the rate parameter of the
  exponential distribution, respectively. Return value and parameters<strong>$which</strong>Return
  value<strong>$par1</strong><strong>$par2</strong>1CDFxlambda2xCDFlambda3lambdaxCDF

<comment>Param:</comment>
  <info>float</info>  <strong>$par1</strong>   The first parameter
  <info>float</info>  <strong>$par2</strong>   The second parameter
  <info>int</info>    <strong>$which</strong>  The flag to determine what to be calculated

<comment>Return:</comment>
  <info>float</info>  Returns CDF, x, or lambda, determined by <strong>$which</strong>.


id: stats_cdf_f
type: function
doc:
<comment>Description:</comment>
  Calculates any one parameter of the F distribution given values for the others
  
  Returns the cumulative distribution function, its inverse, or one of its parameters, of the F
  distribution. The kind of the return value and parameters (<strong>$par1</strong>, <strong>$par2</strong>, and <strong>$par3</strong>) are determined
  by <strong>$which</strong>.
  
  The following table lists the return value and parameters by <strong>$which</strong>. CDF, x, d1, and d2 denotes
  cumulative distribution function, the value of the random variable, and the degree of freedoms of
  the F distribution, respectively. Return value and parameters<strong>$which</strong>Return
  value<strong>$par1</strong><strong>$par2</strong><strong>$par3</strong>1CDFxd1d22xCDFd1d23d1xCDFd24d2xCDFd1

<comment>Param:</comment>
  <info>float</info>  <strong>$par1</strong>   The first parameter
  <info>float</info>  <strong>$par2</strong>   The second parameter
  <info>float</info>  <strong>$par3</strong>   The third parameter
  <info>int</info>    <strong>$which</strong>  The flag to determine what to be calculated

<comment>Return:</comment>
  <info>float</info>  Returns CDF, x, d1, or d2, determined by <strong>$which</strong>.


id: stats_cdf_gamma
type: function
doc:
<comment>Description:</comment>
  Calculates any one parameter of the gamma distribution given values for the others
  
  Returns the cumulative distribution function, its inverse, or one of its parameters, of the gamma
  distribution. The kind of the return value and parameters (<strong>$par1</strong>, <strong>$par2</strong>, and <strong>$par3</strong>) are determined
  by <strong>$which</strong>.
  
  The following table lists the return value and parameters by <strong>$which</strong>. CDF, x, k, and theta denotes
  cumulative distribution function, the value of the random variable, and the shape and the scale
  parameter of the gamma distribution, respectively. Return value and parameters<strong>$which</strong>Return
  value<strong>$par1</strong><strong>$par2</strong><strong>$par3</strong>1CDFxktheta2xCDFktheta3kxCDFtheta4thetaxCDFk

<comment>Param:</comment>
  <info>float</info>  <strong>$par1</strong>   The first parameter
  <info>float</info>  <strong>$par2</strong>   The second parameter
  <info>float</info>  <strong>$par3</strong>   The third parameter
  <info>int</info>    <strong>$which</strong>  The flag to determine what to be calculated

<comment>Return:</comment>
  <info>float</info>  Returns CDF, x, k, or theta, determined by <strong>$which</strong>.


id: stats_cdf_laplace
type: function
doc:
<comment>Description:</comment>
  Calculates any one parameter of the Laplace distribution given values for the others
  
  Returns the cumulative distribution function, its inverse, or one of its parameters, of the
  Laplace distribution. The kind of the return value and parameters (<strong>$par1</strong>, <strong>$par2</strong>, and <strong>$par3</strong>) are
  determined by <strong>$which</strong>.
  
  The following table lists the return value and parameters by <strong>$which</strong>. CDF, x, mu, and b denotes
  cumulative distribution function, the value of the random variable, and the location and the scale
  parameter of the Laplace distribution, respectively. Return value and parameters<strong>$which</strong>Return
  value<strong>$par1</strong><strong>$par2</strong><strong>$par3</strong>1CDFxmub2xCDFmub3muxCDFb4bxCDFmu

<comment>Param:</comment>
  <info>float</info>  <strong>$par1</strong>   The first parameter
  <info>float</info>  <strong>$par2</strong>   The second parameter
  <info>float</info>  <strong>$par3</strong>   The third parameter
  <info>int</info>    <strong>$which</strong>  The flag to determine what to be calculated

<comment>Return:</comment>
  <info>float</info>  Returns CDF, x, mu, or b, determined by <strong>$which</strong>.


id: stats_cdf_logistic
type: function
doc:
<comment>Description:</comment>
  Calculates any one parameter of the logistic distribution given values for the others
  
  Returns the cumulative distribution function, its inverse, or one of its parameters, of the
  logistic distribution. The kind of the return value and parameters (<strong>$par1</strong>, <strong>$par2</strong>, and <strong>$par3</strong>) are
  determined by <strong>$which</strong>.
  
  The following table lists the return value and parameters by <strong>$which</strong>. CDF, x, mu, and s denotes
  cumulative distribution function, the value of the random variable, and the location and the scale
  parameter of the logistic distribution, respectively. Return value and parameters<strong>$which</strong>Return
  value<strong>$par1</strong><strong>$par2</strong><strong>$par3</strong>1CDFxmus2xCDFmus3muxCDFs4sxCDFmu

<comment>Param:</comment>
  <info>float</info>  <strong>$par1</strong>   The first parameter
  <info>float</info>  <strong>$par2</strong>   The second parameter
  <info>float</info>  <strong>$par3</strong>   The third parameter
  <info>int</info>    <strong>$which</strong>  The flag to determine what to be calculated

<comment>Return:</comment>
  <info>float</info>  Returns CDF, x, mu, or s, determined by <strong>$which</strong>.


id: stats_cdf_negative_binomial
type: function
doc:
<comment>Description:</comment>
  Calculates any one parameter of the negative binomial distribution given values for the others
  
  Returns the cumulative distribution function, its inverse, or one of its parameters, of the
  negative binomial distribution. The kind of the return value and parameters (<strong>$par1</strong>, <strong>$par2</strong>, and
  <strong>$par3</strong>) are determined by <strong>$which</strong>.
  
  The following table lists the return value and parameters by <strong>$which</strong>. CDF, x, r, and p denotes
  cumulative distribution function, the number of failure, the number of success, and the success
  rate for each trial, respectively. Return value and parameters<strong>$which</strong>Return
  value<strong>$par1</strong><strong>$par2</strong><strong>$par3</strong>1CDFxrp2xCDFrp3rxCDFp4pxCDFr

<comment>Param:</comment>
  <info>float</info>  <strong>$par1</strong>   The first parameter
  <info>float</info>  <strong>$par2</strong>   The second parameter
  <info>float</info>  <strong>$par3</strong>   The third parameter
  <info>int</info>    <strong>$which</strong>  The flag to determine what to be calculated

<comment>Return:</comment>
  <info>float</info>  Returns CDF, x, r, or p, determined by <strong>$which</strong>.


id: stats_cdf_noncentral_chisquare
type: function
doc:
<comment>Description:</comment>
  Calculates any one parameter of the non-central chi-square distribution given values for the
  others
  
  Returns the cumulative distribution function, its inverse, or one of its parameters, of the
  non-central chi-square distribution. The kind of the return value and parameters (<strong>$par1</strong>, <strong>$par2</strong>,
  and <strong>$par3</strong>) are determined by <strong>$which</strong>.
  
  The following table lists the return value and parameters by <strong>$which</strong>. CDF, x, k, and lambda denotes
  cumulative distribution function, the value of the random variable, the degree of freedom and the
  non-centrality parameter of the distribution, respectively. Return value and
  parameters<strong>$which</strong>Return value<strong>$par1</strong><strong>$par2</strong><strong>$par3</strong>1CDFxklambda2xCDFklambda3kxCDFlambda4lambdaxCDFk

<comment>Param:</comment>
  <info>float</info>  <strong>$par1</strong>   The first parameter
  <info>float</info>  <strong>$par2</strong>   The second parameter
  <info>float</info>  <strong>$par3</strong>   The third parameter
  <info>int</info>    <strong>$which</strong>  The flag to determine what to be calculated

<comment>Return:</comment>
  <info>float</info>  Returns CDF, x, k, or lambda, determined by <strong>$which</strong>.


id: stats_cdf_noncentral_f
type: function
doc:
<comment>Description:</comment>
  Calculates any one parameter of the non-central F distribution given values for the others
  
  Returns the cumulative distribution function, its inverse, or one of its parameters, of the
  non-central F distribution. The kind of the return value and parameters (<strong>$par1</strong>, <strong>$par2</strong>, <strong>$par3</strong>, and
  <strong>$par4</strong>) are determined by <strong>$which</strong>.
  
  The following table lists the return value and parameters by <strong>$which</strong>. CDF, x, nu1, nu2, and lambda
  denotes cumulative distribution function, the value of the random variable, the degree of freedoms
  and the non-centrality parameter of the distribution, respectively. Return value and
  parameters<strong>$which</strong>Return
  value<strong>$par1</strong><strong>$par2</strong><strong>$par3</strong><strong>$par4</strong>1CDFxnu1nu2lambda2xCDFnu1nu2lambda3nu1xCDFnu2lambda4nu2xCDFnu1lambda5lambdaxCDFnu1nu2

<comment>Param:</comment>
  <info>float</info>  <strong>$par1</strong>   The first parameter
  <info>float</info>  <strong>$par2</strong>   The second parameter
  <info>float</info>  <strong>$par3</strong>   The third parameter
  <info>float</info>  <strong>$par4</strong>   The fourth parameter
  <info>int</info>    <strong>$which</strong>  The flag to determine what to be calculated

<comment>Return:</comment>
  <info>float</info>  Returns CDF, x, nu1, nu2, or lambda, determined by <strong>$which</strong>.


id: stats_cdf_noncentral_t
type: function
doc:
<comment>Description:</comment>
  Calculates any one parameter of the non-central t-distribution give values for the others
  
  Returns the cumulative distribution function, its inverse, or one of its parameters, of the
  non-central t-distribution. The kind of the return value and parameters (<strong>$par1</strong>, <strong>$par2</strong>, and <strong>$par3</strong>)
  are determined by <strong>$which</strong>.
  
  The following table lists the return value and parameters by <strong>$which</strong>. CDF, x, nu, and mu denotes
  cumulative distribution function, the value of the random variable, the degrees of freedom and the
  non-centrality parameter of the distribution, respectively. Return value and
  parameters<strong>$which</strong>Return value<strong>$par1</strong><strong>$par2</strong><strong>$par3</strong>1CDFxnumu2xCDFnumu3nuxCDFmu4muxCDFnu

<comment>Param:</comment>
  <info>float</info>  <strong>$par1</strong>   The first parameter
  <info>float</info>  <strong>$par2</strong>   The second parameter
  <info>float</info>  <strong>$par3</strong>   The third parameter
  <info>int</info>    <strong>$which</strong>  The flag to determine what to be calculated

<comment>Return:</comment>
  <info>float</info>  Returns CDF, x, nu, or mu, determined by <strong>$which</strong>.


id: stats_cdf_normal
type: function
doc:
<comment>Description:</comment>
  Calculates any one parameter of the normal distribution given values for the others
  
  Returns the cumulative distribution function, its inverse, or one of its parameters, of the normal
  distribution. The kind of the return value and parameters (<strong>$par1</strong>, <strong>$par2</strong>, and <strong>$par3</strong>) are determined
  by <strong>$which</strong>.
  
  The following table lists the return value and parameters by <strong>$which</strong>. CDF, x, mu, and sigma denotes
  cumulative distribution function, the value of the random variable, the mean and the standard
  deviation of the normal distribution, respectively. Return value and parameters<strong>$which</strong>Return
  value<strong>$par1</strong><strong>$par2</strong><strong>$par3</strong>1CDFxmusigma2xCDFmusigma3muxCDFsigma4sigmaxCDFmu

<comment>Param:</comment>
  <info>float</info>  <strong>$par1</strong>   The first parameter
  <info>float</info>  <strong>$par2</strong>   The second parameter
  <info>float</info>  <strong>$par3</strong>   The third parameter
  <info>int</info>    <strong>$which</strong>  The flag to determine what to be calculated

<comment>Return:</comment>
  <info>float</info>  Returns CDF, x, mu, or sigma, determined by <strong>$which</strong>.


id: stats_cdf_poisson
type: function
doc:
<comment>Description:</comment>
  Calculates any one parameter of the Poisson distribution given values for the others
  
  Returns the cumulative distribution function, its inverse, or one of its parameters, of the
  Poisson distribution. The kind of the return value and parameters (<strong>$par1</strong> and <strong>$par2</strong>) are determined
  by <strong>$which</strong>.
  
  The following table lists the return value and parameters by <strong>$which</strong>. CDF, x, and lambda denotes
  cumulative distribution function, the value of the random variable, and the parameter of the
  Poisson distribution, respectively. Return value and parameters<strong>$which</strong>Return
  value<strong>$par1</strong><strong>$par2</strong>1CDFxlambda2xCDFlambda3lambdaxCDF

<comment>Param:</comment>
  <info>float</info>  <strong>$par1</strong>   The first parameter
  <info>float</info>  <strong>$par2</strong>   The second parameter
  <info>int</info>    <strong>$which</strong>  The flag to determine what to be calculated

<comment>Return:</comment>
  <info>float</info>  Returns CDF, x, or lambda, determined by <strong>$which</strong>.


id: stats_cdf_t
type: function
doc:
<comment>Description:</comment>
  Calculates any one parameter of the t-distribution given values for the others
  
  Returns the cumulative distribution function, its inverse, or one of its parameters, of the
  t-distribution. The kind of the return value and parameters (<strong>$par1</strong> and <strong>$par2</strong>) are determined by
  <strong>$which</strong>.
  
  The following table lists the return value and parameters by <strong>$which</strong>. CDF, x, and nu denotes
  cumulative distribution function, the value of the random variable, and the degrees of freedom of
  the t-distribution, respectively. Return value and parameters<strong>$which</strong>Return
  value<strong>$par1</strong><strong>$par2</strong>1CDFxnu2xCDFnu3nuxCDF

<comment>Param:</comment>
  <info>float</info>  <strong>$par1</strong>   The first parameter
  <info>float</info>  <strong>$par2</strong>   The second parameter
  <info>int</info>    <strong>$which</strong>  The flag to determine what to be calculated

<comment>Return:</comment>
  <info>float</info>  Returns CDF, x, or nu, determined by <strong>$which</strong>.


id: stats_cdf_uniform
type: function
doc:
<comment>Description:</comment>
  Calculates any one parameter of the uniform distribution given values for the others
  
  Returns the cumulative distribution function, its inverse, or one of its parameters, of the
  uniform distribution. The kind of the return value and parameters (<strong>$par1</strong>, <strong>$par2</strong>, and <strong>$par3</strong>) are
  determined by <strong>$which</strong>.
  
  The following table lists the return value and parameters by <strong>$which</strong>. CDF, x, a, and b denotes
  cumulative distribution function, the value of the random variable, the lower bound and the higher
  bound of the uniform distribution, respectively. Return value and parameters<strong>$which</strong>Return
  value<strong>$par1</strong><strong>$par2</strong><strong>$par3</strong>1CDFxab2xCDFab3axCDFb4bxCDFa

<comment>Param:</comment>
  <info>float</info>  <strong>$par1</strong>   The first parameter
  <info>float</info>  <strong>$par2</strong>   The second parameter
  <info>float</info>  <strong>$par3</strong>   The third parameter
  <info>int</info>    <strong>$which</strong>  The flag to determine what to be calculated

<comment>Return:</comment>
  <info>float</info>  Returns CDF, x, a, or b, determined by <strong>$which</strong>.


id: stats_cdf_weibull
type: function
doc:
<comment>Description:</comment>
  Calculates any one parameter of the Weibull distribution given values for the others
  
  Returns the cumulative distribution function, its inverse, or one of its parameters, of the
  Weibull distribution. The kind of the return value and parameters (<strong>$par1</strong>, <strong>$par2</strong>, and <strong>$par3</strong>) are
  determined by <strong>$which</strong>.
  
  The following table lists the return value and parameters by <strong>$which</strong>. CDF, x, k, and lambda denotes
  cumulative distribution function, the value of the random variable, the shape and the scale
  parameter of the Weibull distribution, respectively. Return value and parameters<strong>$which</strong>Return
  value<strong>$par1</strong><strong>$par2</strong><strong>$par3</strong>1CDFxklambda2xCDFklambda3kxCDFlambda4lambdaxCDFk

<comment>Param:</comment>
  <info>float</info>  <strong>$par1</strong>   The first parameter
  <info>float</info>  <strong>$par2</strong>   The second parameter
  <info>float</info>  <strong>$par3</strong>   The third parameter
  <info>int</info>    <strong>$which</strong>  The flag to determine what to be calculated

<comment>Return:</comment>
  <info>float</info>  Returns CDF, x, k, or lambda, determined by <strong>$which</strong>.


id: stats_covariance
type: function
doc:
<comment>Description:</comment>
  Computes the covariance of two data sets
  
  Returns the covariance of <strong>$a</strong> and <strong>$b</strong>.

<comment>Param:</comment>
  <info>array</info>  <strong>$a</strong>  The first array
  <info>array</info>  <strong>$b</strong>  The second array

<comment>Return:</comment>
  <info>float</info>  Returns the covariance of <strong>$a</strong> and <strong>$b</strong>, or <info>false</info> on failure.


id: stats_dens_beta
type: function
doc:
<comment>Description:</comment>
  Probability density function of the beta distribution
  
  Returns the probability density at <strong>$x</strong>, where the random variable follows the beta distribution of
  which the shape parameters are <strong>$a</strong> and <strong>$b</strong>.

<comment>Param:</comment>
  <info>float</info>  <strong>$x</strong>  The value at which the probability density is calculated
  <info>float</info>  <strong>$a</strong>  The shape parameter of the distribution
  <info>float</info>  <strong>$b</strong>  The shape parameter of the distribution

<comment>Return:</comment>
  <info>float</info>  The probability density at <strong>$x</strong> or <info>false</info> for failure.


id: stats_dens_cauchy
type: function
doc:
<comment>Description:</comment>
  Probability density function of the Cauchy distribution
  
  Returns the probability density at <strong>$x</strong>, where the random variable follows the Cauchy distribution
  whose location and scale are <strong>$ave</strong> and <strong>$stdev</strong>, respectively.

<comment>Param:</comment>
  <info>float</info>  <strong>$x</strong>      The value at which the probability density is calculated
  <info>float</info>  <strong>$ave</strong>    The location parameter of the distribution
  <info>float</info>  <strong>$stdev</strong>  The scale parameter of the distribution

<comment>Return:</comment>
  <info>float</info>  The probability density at <strong>$x</strong> or <info>false</info> for failure.


id: stats_dens_chisquare
type: function
doc:
<comment>Description:</comment>
  Probability density function of the chi-square distribution
  
  Returns the probability density at <strong>$x</strong>, where the random variable follows the chi-square
  distribution of which the degree of freedom is <strong>$dfr</strong>.

<comment>Param:</comment>
  <info>float</info>  <strong>$x</strong>    The value at which the probability density is calculated
  <info>float</info>  <strong>$dfr</strong>  The degree of freedom of the distribution

<comment>Return:</comment>
  <info>float</info>  The probability density at <strong>$x</strong> or <info>false</info> for failure.


id: stats_dens_exponential
type: function
doc:
<comment>Description:</comment>
  Probability density function of the exponential distribution
  
  Returns the probability density at <strong>$x</strong>, where the random variable follows the exponential
  distribution of which the scale is <strong>$scale</strong>.

<comment>Param:</comment>
  <info>float</info>  <strong>$x</strong>      The value at which the probability density is calculated
  <info>float</info>  <strong>$scale</strong>  The scale of the distribution

<comment>Return:</comment>
  <info>float</info>  The probability density at <strong>$x</strong> or <info>false</info> for failure.


id: stats_dens_f
type: function
doc:
<comment>Description:</comment>
  Probability density function of the F distribution
  
  Returns the probability density at <strong>$x</strong>, where the random variable follows the F distribution of
  which the degree of freedoms are <strong>$dfr1</strong> and <strong>$dfr2</strong>.

<comment>Param:</comment>
  <info>float</info>  <strong>$x</strong>     The value at which the probability density is calculated
  <info>float</info>  <strong>$dfr1</strong>  The degree of freedom of the distribution
  <info>float</info>  <strong>$dfr2</strong>  The degree of freedom of the distribution

<comment>Return:</comment>
  <info>float</info>  The probability density at <strong>$x</strong> or <info>false</info> for failure.


id: stats_dens_gamma
type: function
doc:
<comment>Description:</comment>
  Probability density function of the gamma distribution
  
  Returns the probability density at <strong>$x</strong>, where the random variable follows the gamma distribution of
  which the shape parameter is <strong>$shape</strong> and the scale parameter is <strong>$scale</strong>.

<comment>Param:</comment>
  <info>float</info>  <strong>$x</strong>      The value at which the probability density is calculated
  <info>float</info>  <strong>$shape</strong>  The shape parameter of the distribution
  <info>float</info>  <strong>$scale</strong>  The scale parameter of the distribution

<comment>Return:</comment>
  <info>float</info>  The probability density at <strong>$x</strong> or <info>false</info> for failure.


id: stats_dens_laplace
type: function
doc:
<comment>Description:</comment>
  Probability density function of the Laplace distribution
  
  Returns the probability density at <strong>$x</strong>, where the random variable follows the Laplace distribution
  of which the location parameter is <strong>$ave</strong> and the scale parameter is <strong>$stdev</strong>.

<comment>Param:</comment>
  <info>float</info>  <strong>$x</strong>      The value at which the probability density is calculated
  <info>float</info>  <strong>$ave</strong>    The location parameter of the distribution
  <info>float</info>  <strong>$stdev</strong>  The shape parameter of the distribution

<comment>Return:</comment>
  <info>float</info>  The probability density at <strong>$x</strong> or <info>false</info> for failure.


id: stats_dens_logistic
type: function
doc:
<comment>Description:</comment>
  Probability density function of the logistic distribution
  
  Returns the probability density at <strong>$x</strong>, where the random variable follows the logistic distribution
  of which the location parameter is <strong>$ave</strong> and the scale parameter is <strong>$stdev</strong>.

<comment>Param:</comment>
  <info>float</info>  <strong>$x</strong>      The value at which the probability density is calculated
  <info>float</info>  <strong>$ave</strong>    The location parameter of the distribution
  <info>float</info>  <strong>$stdev</strong>  The shape parameter of the distribution

<comment>Return:</comment>
  <info>float</info>  The probability density at <strong>$x</strong> or <info>false</info> for failure.


id: stats_dens_normal
type: function
doc:
<comment>Description:</comment>
  Probability density function of the normal distribution
  
  Returns the probability density at <strong>$x</strong>, where the random variable follows the normal distribution
  of which the mean is <strong>$ave</strong> and the standard deviation is <strong>$stdev</strong>.

<comment>Param:</comment>
  <info>float</info>  <strong>$x</strong>      The value at which the probability density is calculated
  <info>float</info>  <strong>$ave</strong>    The mean of the distribution
  <info>float</info>  <strong>$stdev</strong>  The standard deviation of the distribution

<comment>Return:</comment>
  <info>float</info>  The probability density at <strong>$x</strong> or <info>false</info> for failure.


id: stats_dens_pmf_binomial
type: function
doc:
<comment>Description:</comment>
  Probability mass function of the binomial distribution
  
  Returns the probability mass at <strong>$x</strong>, where the random variable follows the binomial distribution of
  which the number of trials is <strong>$n</strong> and the success rate is <strong>$pi</strong>.

<comment>Param:</comment>
  <info>float</info>  <strong>$x</strong>   The value at which the probability mass is calculated
  <info>float</info>  <strong>$n</strong>   The number of trials of the distribution
  <info>float</info>  <strong>$pi</strong>  The success rate of the distribution

<comment>Return:</comment>
  <info>float</info>  The probability mass at <strong>$x</strong> or <info>false</info> for failure.


id: stats_dens_pmf_hypergeometric
type: function
doc:
<comment>Description:</comment>
  Probability mass function of the hypergeometric distribution
  
  Returns the probability mass at <strong>$n1</strong>, where the random variable follows the hypergeometric
  distribution of which the number of failure is <strong>$n2</strong>, the number of success samples is <strong>$N1</strong>, and the
  number of failure samples is <strong>$N2</strong>.

<comment>Param:</comment>
  <info>float</info>  <strong>$n1</strong>  The number of success, at which the probability mass is calculated
  <info>float</info>  <strong>$n2</strong>  The number of failure of the distribution
  <info>float</info>  <strong>$N1</strong>  The number of success samples of the distribution
  <info>float</info>  <strong>$N2</strong>  The number of failure samples of the distribution

<comment>Return:</comment>
  <info>float</info>  The probability mass at <strong>$n1</strong> or <info>false</info> for failure.


id: stats_dens_pmf_negative_binomial
type: function
doc:
<comment>Description:</comment>
  Probability mass function of the negative binomial distribution
  
  Returns the probability mass at <strong>$x</strong>, where the random variable follows the negative binomial
  distribution of which the number of the success is <strong>$n</strong> and the success rate is <strong>$pi</strong>.

<comment>Param:</comment>
  <info>float</info>  <strong>$x</strong>   The value at which the probability mass is calculated
  <info>float</info>  <strong>$n</strong>   The number of the success of the distribution
  <info>float</info>  <strong>$pi</strong>  The success rate of the distribution

<comment>Return:</comment>
  <info>float</info>  The probability mass at <strong>$x</strong> or <info>false</info> for failure.


id: stats_dens_pmf_poisson
type: function
doc:
<comment>Description:</comment>
  Probability mass function of the Poisson distribution
  
  Returns the probability mass at <strong>$x</strong>, where the random variable follows the Poisson distribution
  whose parameter is <strong>$lb</strong>.

<comment>Param:</comment>
  <info>float</info>  <strong>$x</strong>   The value at which the probability mass is calculated
  <info>float</info>  <strong>$lb</strong>  The parameter of the Poisson distribution

<comment>Return:</comment>
  <info>float</info>  The probability mass at <strong>$x</strong> or <info>false</info> for failure.


id: stats_dens_t
type: function
doc:
<comment>Description:</comment>
  Probability density function of the t-distribution
  
  Returns the probability density at <strong>$x</strong>, where the random variable follows the t-distribution of
  which the degree of freedom is <strong>$dfr</strong>.

<comment>Param:</comment>
  <info>float</info>  <strong>$x</strong>    The value at which the probability density is calculated
  <info>float</info>  <strong>$dfr</strong>  The degree of freedom of the distribution

<comment>Return:</comment>
  <info>float</info>  The probability density at <strong>$x</strong> or <info>false</info> for failure.


id: stats_dens_uniform
type: function
doc:
<comment>Description:</comment>
  Probability density function of the uniform distribution
  
  Returns the probability density at <strong>$x</strong>, where the random variable follows the uniform distribution
  of which the lower bound is <strong>$a</strong> and the upper bound is <strong>$b</strong>.

<comment>Param:</comment>
  <info>float</info>  <strong>$x</strong>  The value at which the probability density is calculated
  <info>float</info>  <strong>$a</strong>  The lower bound of the distribution
  <info>float</info>  <strong>$b</strong>  The upper bound of the distribution

<comment>Return:</comment>
  <info>float</info>  The probability density at <strong>$x</strong> or <info>false</info> for failure.


id: stats_dens_weibull
type: function
doc:
<comment>Description:</comment>
  Probability density function of the Weibull distribution
  
  Returns the probability density at <strong>$x</strong>, where the random variable follows the Weibull distribution
  of which the shape parameter is <strong>$a</strong> and the scale parameter is <strong>$b</strong>.

<comment>Param:</comment>
  <info>float</info>  <strong>$x</strong>  The value at which the probability density is calculated
  <info>float</info>  <strong>$a</strong>  The shape parameter of the distribution
  <info>float</info>  <strong>$b</strong>  The scale parameter of the distribution

<comment>Return:</comment>
  <info>float</info>  The probability density at <strong>$x</strong> or <info>false</info> for failure.


id: stats_harmonic_mean
type: function
doc:
<comment>Description:</comment>
  Returns the harmonic mean of an array of values
  
  Returns the harmonic mean of the values in <strong>$a</strong>.

<comment>Param:</comment>
  <info>array</info>  <strong>$a</strong>  The input array

<comment>Return:</comment>
  <info>number</info>  Returns the harmonic mean of the values in <strong>$a</strong>, or <info>false</info> if <strong>$a</strong> is empty or is not an array.


id: stats_kurtosis
type: function
doc:
<comment>Description:</comment>
  Computes the kurtosis of the data in the array
  
  Returns the kurtosis of the values in <strong>$a</strong>.

<comment>Param:</comment>
  <info>array</info>  <strong>$a</strong>  The input array

<comment>Return:</comment>
  <info>float</info>  Returns the kurtosis of the values in <strong>$a</strong>, or <info>false</info> if <strong>$a</strong> is empty or is not an array.


id: stats_rand_gen_beta
type: function
doc:
<comment>Description:</comment>
  Generates a random deviate from the beta distribution
  
  Returns a random deviate from the beta distribution with parameters A and B. The density of the
  beta is x^(a-1) * (1-x)^(b-1) / B(a,b) for 0 \< x \<. Method R. C. H. Cheng.

<comment>Param:</comment>
  <info>float</info>  <strong>$a</strong>  The shape parameter of the beta distribution
  <info>float</info>  <strong>$b</strong>  The shape parameter of the beta distribution

<comment>Return:</comment>
  <info>float</info>  A random deviate


id: stats_rand_gen_chisquare
type: function
doc:
<comment>Description:</comment>
  Generates a random deviate from the chi-square distribution
  
  Returns a random deviate from the chi-square distribution where the degrees of freedom is  <strong>$df</strong>.

<comment>Param:</comment>
  <info>float</info>  <strong>$df</strong>  The degrees of freedom

<comment>Return:</comment>
  <info>float</info>  A random deviate


id: stats_rand_gen_exponential
type: function
doc:
<comment>Description:</comment>
  Generates a random deviate from the exponential distribution
  
  Returns a random deviate from the exponential distribution of which the scale is <strong>$av</strong>.

<comment>Param:</comment>
  <info>float</info>  <strong>$av</strong>  The scale parameter

<comment>Return:</comment>
  <info>float</info>  A random deviate


id: stats_rand_gen_f
type: function
doc:
<comment>Description:</comment>
  Generates a random deviate from the F distribution
  
  Generates a random deviate from the F (variance ratio) distribution with  "dfn" degrees of freedom
  in the numerator and "dfd" degrees of freedom in  the denominator. Method : directly generates
  ratio of chisquare variates.

<comment>Param:</comment>
  <info>float</info>  <strong>$dfn</strong>  The degrees of freedom in the numerator
  <info>float</info>  <strong>$dfd</strong>  The degrees of freedom in the denominator

<comment>Return:</comment>
  <info>float</info>  A random deviate


id: stats_rand_gen_funiform
type: function
doc:
<comment>Description:</comment>
  Generates uniform float between low (exclusive) and high (exclusive)
  
  Returns a random deviate from the uniform distribution from <strong>$low</strong> to <strong>$high</strong>.

<comment>Param:</comment>
  <info>float</info>  <strong>$low</strong>   The lower bound (inclusive)
  <info>float</info>  <strong>$high</strong>  The upper bound (exclusive)

<comment>Return:</comment>
  <info>float</info>  A random deviate


id: stats_rand_gen_gamma
type: function
doc:
<comment>Description:</comment>
  Generates a random deviate from the gamma distribution
  
  Generates a random deviate from the gamma distribution whose density is (A**R)/Gamma(R) * X**(R-1)
  * Exp(-A*X).

<comment>Param:</comment>
  <info>float</info>  <strong>$a</strong>  location parameter of Gamma distribution (<strong>$a</strong> &gt; 0).
  <info>float</info>  <strong>$r</strong>  shape parameter of Gamma distribution (<strong>$r</strong> &gt; 0).

<comment>Return:</comment>
  <info>float</info>  A random deviate


id: stats_rand_gen_ibinomial
type: function
doc:
<comment>Description:</comment>
  Generates a random deviate from the binomial distribution
  
  Returns a random deviate from the binomial distribution whose number of trials is <strong>$n</strong> and whose
  probability of an event in each trial is <strong>$pp</strong>.

<comment>Param:</comment>
  <info>int</info>    <strong>$n</strong>   The number of trials
  <info>float</info>  <strong>$pp</strong>  The probability of an event in each trial

<comment>Return:</comment>
  <info>int</info>  A random deviate


id: stats_rand_gen_ibinomial_negative
type: function
doc:
<comment>Description:</comment>
  Generates a random deviate from the negative binomial distribution
  
  Returns a random deviate from a negative binomial distribution where the number of success is <strong>$n</strong>
  and the success rate is <strong>$p</strong>.

<comment>Param:</comment>
  <info>int</info>    <strong>$n</strong>  The number of success
  <info>float</info>  <strong>$p</strong>  The success rate

<comment>Return:</comment>
  <info>int</info>  A random deviate, which is the number of failure.


id: stats_rand_gen_int
type: function
doc:
<comment>Description:</comment>
  Generates random integer between 1 and 2147483562
  
  Returns a random integer between 1 and 2147483562

<comment>Return:</comment>
  <info>int</info>  A random integer


id: stats_rand_gen_ipoisson
type: function
doc:
<comment>Description:</comment>
  Generates a single random deviate from a Poisson distribution
  
  Returns a random deviate from the Poisson distribution with parameter <strong>$mu</strong>.

<comment>Param:</comment>
  <info>float</info>  <strong>$mu</strong>  The parameter of the Poisson distribution

<comment>Return:</comment>
  <info>int</info>  A random deviate


id: stats_rand_gen_iuniform
type: function
doc:
<comment>Description:</comment>
  Generates integer uniformly distributed between LOW (inclusive) and HIGH (inclusive)
  
  Returns a random integer from the discrete uniform distribution between <strong>$low</strong> (inclusive) and <strong>$high</strong>
  (inclusive).

<comment>Param:</comment>
  <info>int</info>  <strong>$low</strong>   The lower bound
  <info>int</info>  <strong>$high</strong>  The upper bound

<comment>Return:</comment>
  <info>int</info>  A random integer


id: stats_rand_gen_noncentral_chisquare
type: function
doc:
<comment>Description:</comment>
  Generates a random deviate from the non-central chi-square distribution
  
  Returns a random deviate from the non-central chi-square distribution with degrees of freedom,
  <strong>$df</strong>, and non-centrality parameter, <strong>$xnonc</strong>.

<comment>Param:</comment>
  <info>float</info>  <strong>$df</strong>     The degrees of freedom
  <info>float</info>  <strong>$xnonc</strong>  The non-centrality parameter

<comment>Return:</comment>
  <info>float</info>  A random deviate


id: stats_rand_gen_noncentral_f
type: function
doc:
<comment>Description:</comment>
  Generates a random deviate from the noncentral F distribution
  
  Returns a random deviate from the non-central F distribution where the degrees of freedoms are
  <strong>$dfn</strong> (numerator) and <strong>$dfd</strong> (denominator), and the non-centrality parameter is <strong>$xnonc</strong>.

<comment>Param:</comment>
  <info>float</info>  <strong>$dfn</strong>    The degrees of freedom of the numerator
  <info>float</info>  <strong>$dfd</strong>    The degrees of freedom of the denominator
  <info>float</info>  <strong>$xnonc</strong>  The non-centrality parameter

<comment>Return:</comment>
  <info>float</info>  A random deviate


id: stats_rand_gen_noncentral_t
type: function
doc:
<comment>Description:</comment>
  Generates a single random deviate from a non-central t-distribution
  
  Returns a random deviate from the non-central t-distribution with the degrees of freedom, <strong>$df</strong>, and
  the non-centrality parameter, <strong>$xnonc</strong>.

<comment>Param:</comment>
  <info>float</info>  <strong>$df</strong>     The degrees of freedom
  <info>float</info>  <strong>$xnonc</strong>  The non-centrality parameter

<comment>Return:</comment>
  <info>float</info>  A random deviate


id: stats_rand_gen_normal
type: function
doc:
<comment>Description:</comment>
  Generates a single random deviate from a normal distribution
  
  Returns a random deviate from the normal distribution with mean, <strong>$av</strong>, and standard deviation, <strong>$sd</strong>.

<comment>Param:</comment>
  <info>float</info>  <strong>$av</strong>  The mean of the normal distribution
  <info>float</info>  <strong>$sd</strong>  The standard deviation of the normal distribution

<comment>Return:</comment>
  <info>float</info>  A random deviate


id: stats_rand_gen_t
type: function
doc:
<comment>Description:</comment>
  Generates a single random deviate from a t-distribution
  
  Returns a random deviate from the t-distribution with the degrees of freedom, <strong>$df</strong>.

<comment>Param:</comment>
  <info>float</info>  <strong>$df</strong>  The degrees of freedom

<comment>Return:</comment>
  <info>float</info>  A random deviate


id: stats_rand_get_seeds
type: function
doc:
<comment>Description:</comment>
  Get the seed values of the random number generator
  
  Returns the current seed values of the random number generator

<comment>Return:</comment>
  <info>array</info>  Returns an array of two integers.


id: stats_rand_phrase_to_seeds
type: function
doc:
<comment>Description:</comment>
  Generate two seeds for the RGN random number generator
  
  Generate two seeds for the random number generator from a <strong>$phrase</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$phrase</strong>  The input phrase

<comment>Return:</comment>
  <info>array</info>  Returns an array of two integers.


id: stats_rand_ranf
type: function
doc:
<comment>Description:</comment>
  Generates a random floating point number between 0 and 1
  
  Returns a random floating point number from a uniform distribution between 0 (exclusive) and  1
  (exclusive).

<comment>Return:</comment>
  <info>float</info>  A random floating point number


id: stats_rand_setall
type: function
doc:
<comment>Description:</comment>
  Set seed values to the random generator
  
  Set <strong>$iseed1</strong> and <strong>$iseed2</strong> as seed values to the random generator used in statistic functions.

<comment>Param:</comment>
  <info>int</info>  <strong>$iseed1</strong>  The value which is used as the random seed
  <info>int</info>  <strong>$iseed2</strong>  The value which is used as the random seed

<comment>Return:</comment>
  <info>void</info>  No values are returned.


id: stats_skew
type: function
doc:
<comment>Description:</comment>
  Computes the skewness of the data in the array
  
  Returns the skewness of the values in <strong>$a</strong>.

<comment>Param:</comment>
  <info>array</info>  <strong>$a</strong>  The input array

<comment>Return:</comment>
  <info>float</info>  Returns the skewness of the values in <strong>$a</strong>, or <info>false</info> if <strong>$a</strong> is empty or is not an array.


id: stats_standard_deviation
type: function
doc:
<comment>Description:</comment>
  Returns the standard deviation
  
  Returns the standard deviation of the values in <strong>$a</strong>.

<comment>Param:</comment>
  <info>array</info>  <strong>$a</strong>       The array of data to find the standard deviation for. Note that all  values of the
                  array will be cast to <info>float</info>.
  <info>bool</info>   <strong>$sample</strong>  Indicates if <strong>$a</strong> represents a sample of the  population; defaults to <info>false</info>.

<comment>Return:</comment>
  <info>float</info>  Returns the standard deviation on success; <info>false</info> on failure.


id: stats_stat_binomial_coef
type: function
doc:
<comment>Description:</comment>
  Returns a binomial coefficient
  
  Returns the binomial coefficient of <strong>$n</strong> choose <strong>$x</strong>.

<comment>Param:</comment>
  <info>int</info>  <strong>$x</strong>  The number of chooses from the set
  <info>int</info>  <strong>$n</strong>  The number of elements in the set

<comment>Return:</comment>
  <info>float</info>  Returns the binomial coefficient


id: stats_stat_correlation
type: function
doc:
<comment>Description:</comment>
  Returns the Pearson correlation coefficient of two data sets
  
  Returns the Pearson correlation coefficient between <strong>$arr1</strong> and <strong>$arr2</strong>.

<comment>Param:</comment>
  <info>array</info>  <strong>$arr1</strong>  The first array
  <info>array</info>  <strong>$arr2</strong>  The second array

<comment>Return:</comment>
  <info>float</info>  Returns the Pearson correlation coefficient between <strong>$arr1</strong> and <strong>$arr2</strong>, or <info>false</info> on failure.


id: stats_stat_factorial
type: function
doc:
<comment>Description:</comment>
  Returns the factorial of an integer
  
  Returns the factorial of an integer, <strong>$n</strong>.

<comment>Param:</comment>
  <info>int</info>  <strong>$n</strong>  An integer

<comment>Return:</comment>
  <info>float</info>  The factorial of <strong>$n</strong>.


id: stats_stat_independent_t
type: function
doc:
<comment>Description:</comment>
  Returns the t-value from the independent two-sample t-test
  
  Returns the t-value of the independent two-sample t-test between <strong>$arr1</strong> and <strong>$arr2</strong>.
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>array</info>  <strong>$arr1</strong>  The first set of values
  <info>array</info>  <strong>$arr2</strong>  The second set of values

<comment>Return:</comment>
  <info>float</info>  Returns the t-value, or <info>false</info> if failure.


id: stats_stat_innerproduct
type: function
doc:
<comment>Description:</comment>
  Returns the inner product of two vectors
  
  Returns the inner product of <strong>$arr1</strong> and <strong>$arr2</strong>.

<comment>Param:</comment>
  <info>array</info>  <strong>$arr1</strong>  The first array
  <info>array</info>  <strong>$arr2</strong>  The second array

<comment>Return:</comment>
  <info>float</info>  Returns the inner product of <strong>$arr1</strong> and <strong>$arr2</strong>, or <info>false</info> on failure.


id: stats_stat_paired_t
type: function
doc:
<comment>Description:</comment>
  Returns the t-value of the dependent t-test for paired samples
  
  Returns the t-value of the dependent t-test for paired samples <strong>$arr1</strong> and <strong>$arr2</strong>.

<comment>Param:</comment>
  <info>array</info>  <strong>$arr1</strong>  The first samples
  <info>array</info>  <strong>$arr2</strong>  The second samples

<comment>Return:</comment>
  <info>float</info>  Returns the t-value, or <info>false</info> if failure.


id: stats_stat_percentile
type: function
doc:
<comment>Description:</comment>
  Returns the percentile value
  
  Returns the <strong>$perc</strong>-th percentile value of the array <strong>$arr</strong>.

<comment>Param:</comment>
  <info>array</info>  <strong>$arr</strong>   The input array
  <info>float</info>  <strong>$perc</strong>  The percentile

<comment>Return:</comment>
  <info>float</info>  Returns the percentile values of the input array.


id: stats_stat_powersum
type: function
doc:
<comment>Description:</comment>
  Returns the power sum of a vector
  
  Returns the sum of the <strong>$power</strong>-th power of a vector represented as an array <strong>$arr</strong>.

<comment>Param:</comment>
  <info>array</info>  <strong>$arr</strong>    The input array
  <info>float</info>  <strong>$power</strong>  The power

<comment>Return:</comment>
  <info>float</info>  Returns the power sum of the input array.


id: stats_variance
type: function
doc:
<comment>Description:</comment>
  Returns the variance
  
  Returns the variance of the values in <strong>$a</strong>.

<comment>Param:</comment>
  <info>array</info>  <strong>$a</strong>       The array of data to find the standard deviation for. Note that all  values of the
                  array will be cast to <info>float</info>.
  <info>bool</info>   <strong>$sample</strong>  Indicates if <strong>$a</strong> represents a sample of the  population; defaults to <info>false</info>.

<comment>Return:</comment>
  <info>float</info>  Returns the variance on success; <info>false</info> on failure.


id: stdClass
type: class
doc:
<comment>Description:</comment>
  動的なプロパティが使える、汎用的な空のクラスです。
  
  このクラスのインスタンスは、 new 演算子や、 オブジェクトへの型変換 によって作成できます。 PHP の関
  数によっては、このクラスのインスタンスを返すものがあります。 たとえば <strong>json_decode()</strong>,
  <strong>mysqli_fetch_object()</strong>, PDOStatement::fetchObject が挙げられます。
  
  マジックメソッド __get()/__set() を実装しているかどうかに関わらず、 このクラスでは動的なプロパティ
  が許可されています。 よって、#[\AllowDynamicProperties] アトリビュートは必要ありません。
  
  PHP には全てのクラスの親となる基底クラスの概念がないため、 このクラスは基底クラスではありません。
  ただ、<class>stdClass</class> を継承させることで、 動的なプロパティの機能を持ったカスタムクラスを結果的に作ること
  はできます。


id: stomp_connect_error
type: function
doc:
<comment>Description:</comment>
  Returns a string description of the last connect error
  
  Returns a string description of the last connect error.

<comment>Return:</comment>
  <info>string</info>  A string that describes the error, or <info>null</info> if no error occurred.


id: stomp_version
type: function
doc:
<comment>Description:</comment>
  Gets the current stomp extension version
  
  Returns a string containing the version of the current stomp extension.

<comment>Return:</comment>
  <info>string</info>  It returns the current stomp extension version


id: str_contains
type: function
doc:
<comment>Description:</comment>
  指定された部分文字列が、文字列に含まれるかを調べる
  
  <strong>$needle</strong> が <strong>$haystack</strong> に含まれるかを調べます。 大文字小文字は区別されます。

<comment>Param:</comment>
  <info>string</info>  <strong>$haystack</strong>  検索対象の文字列
  <info>string</info>  <strong>$needle</strong>    <strong>$haystack</strong> で調べる部分文字列

<comment>Return:</comment>
  <info>bool</info>  <strong>$haystack</strong> に <strong>$needle</strong> が含まれていた場合 <info>true</info> そうでない場合、<info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>str_ends_with()</strong>
   * <strong>str_starts_with()</strong>
   * <strong>stripos()</strong>
   * <strong>strrpos()</strong>
   * <strong>strripos()</strong>
   * <strong>strstr()</strong>
   * <strong>strpbrk()</strong>
   * <strong>substr()</strong>
   * <strong>preg_match()</strong>


id: str_decrement
type: function
doc:
<comment>Description:</comment>
  英数字からなる文字列をデクリメントする
  
  英数字からなる ASCII 文字列 <strong>$string</strong> をデクリメントし、結果の文字列を返します。

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

<comment>Return:</comment>
  <info>string</info>  デクリメント済みの、英数字からなる ASCII 文字列を返します。

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


id: str_ends_with
type: function
doc:
<comment>Description:</comment>
  文字列が、指定された文字列で終わるかを調べる。
  
  <strong>$haystack</strong> が <strong>$needle</strong> で終わるかを調べます。 大文字小文字は区別されます。

<comment>Param:</comment>
  <info>string</info>  <strong>$haystack</strong>  検索対象の文字列。
  <info>string</info>  <strong>$needle</strong>    <strong>$haystack</strong> で調べる部分文字列

<comment>Return:</comment>
  <info>bool</info>  <strong>$haystack</strong> が <strong>$needle</strong> で終わる場合、<info>true</info> を返します。 そうでない場合、<info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>str_contains()</strong>
   * <strong>str_starts_with()</strong>
   * <strong>stripos()</strong>
   * <strong>strrpos()</strong>
   * <strong>strripos()</strong>
   * <strong>strstr()</strong>
   * <strong>strpbrk()</strong>
   * <strong>substr()</strong>
   * <strong>preg_match()</strong>


id: str_getcsv
type: function
doc:
<comment>Description:</comment>
  CSV 文字列をパースして配列に格納する
    
  
  CSV 形式の文字列入力のフィールドをパースして、 読み込んだフィールドの内容を配列で返します。
  
  この関数はロケール設定を考慮します。もし LC_CTYPE が例えば <return>en_US.UTF-8</return> の場合、 1 バイトエンコー
  ディングの文字列は間違って読み込まれるかもしれません。

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>     パースする文字列。
  <info>string</info>  <strong>$separator</strong>  フィールド区切り文字 (シングルバイト文字 1 文字のみ)。
  <info>string</info>  <strong>$enclosure</strong>  フィールド囲み文字 (シングルバイト文字 1 文字のみ)。
  <info>string</info>  <strong>$escape</strong>     エスケープ文字 (シングルバイト文字 最大1文字)。デフォルトはバックスラッシュ
                      (<return>\</return>)。 空文字列 (<return>""</return>) を指定すると、 (RFC 4180 に準拠していない) 独自仕様のエス
                      ケープ機構を無効にします。
                      
                      通常、 <strong>$enclosure</strong> の文字は、 フィールドの中では二回出力されることでエスケープ
                      されます。 しかし、<strong>$escape</strong> の文字を代わりに使うこともできます。 よって、デフォ
                      ルト値 <return>""</return>  および <return>\"</return> は同じ意味になります。 <strong>$enclosure</strong> 文字をエスケープするこ
                      とを許可する以外に、 <strong>$escape</strong> 文字は特別な意味を何ら持ちません; つまり、自分自
                      身をエスケープすることすら意味しません。

<comment>Return:</comment>
  <info>array</info>  読み込んだフィールドの内容を配列で返します。

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


id: str_increment
type: function
doc:
<comment>Description:</comment>
  英数字からなる文字列をインクリメントする
  
  英数字からなる ASCII 文字列 <strong>$string</strong> をインクリメントし、結果の文字列を返します。

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

<comment>Return:</comment>
  <info>string</info>  インクリメント済みの、英数字からなる ASCII 文字列を返します。

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


id: str_ireplace
type: function
doc:
<comment>Description:</comment>
  大文字小文字を区別しない str_replace
  
  この関数は、<strong>$subject</strong> の中に現れるすべての <strong>$search</strong>(大文字小文字を区別しない)を <strong>$replace</strong> に置き換え
  た文字列あるいは配列を返します。
  
  固定の文字列ではなく、パターンベースでテキストを置換したい場合、 <strong>preg_replace()</strong> 関数を パターン修
  飾子 <return>i</return> と一緒に使ってください。

<comment>Param:</comment>
  <info>array|string</info>  <strong>$search</strong>   探したい値。needle (針) と呼ばれることもあります。 配列を使えば、複数の値
                          を指定することもできます。
  <info>array|string</info>  <strong>$replace</strong>  見つかった <strong>$search</strong> を置き換える値。 配列を使えば、複数の値を指定することも
                          できます。
  <info>string|array</info>  <strong>$subject</strong>  検索・置換の対象となる文字列あるいは配列。 haystack (干し草の山) と呼ばれ
                          ることもあります。
                          
                          <strong>$subject</strong> が配列の場合は、そのすべての要素に 対して検索と置換が行われ、返さ
                          れる結果も配列となります。
  <info>int</info>           <strong>$count</strong>    指定した場合は、マッチして置換が行われた箇所の個数がここに格納されます。

<comment>Return:</comment>
  <info>string|array</info>  置換した文字列あるいは配列を返します。

<comment>See Also:</comment>
   * <strong>str_replace()</strong>
   * <strong>preg_replace()</strong>
   * <strong>strtr()</strong>


id: str_pad
type: function
doc:
<comment>Description:</comment>
  文字列を固定長の他の文字列で埋める
  
  この関数は文字列 <strong>$string</strong> の左、右または両側を指定した長さで埋めます。オプションの引数 <strong>$pad_string</strong>
  が指定されていない場合は、 <strong>$string</strong> は空白で埋められ、それ以外の場合は、 <strong>$pad_string</strong> からの文字で制
  限まで埋められます。

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>      入力文字列。
  <info>int</info>     <strong>$length</strong>      埋めた結果としての、最終的な文字列の長さ。 <strong>$length</strong> の値が負、 または入力文字
                       列の長さ以下である場合、埋める操作は行われません。 <strong>$string</strong> をそのまま返しま
                       す。
  <info>string</info>  <strong>$pad_string</strong>  必要とされる埋める文字数が <strong>$pad_string</strong> の長さで均等に分割できない場合、
                       <strong>$pad_string</strong> は切り捨てられます。
  <info>int</info>     <strong>$pad_type</strong>    オプションの引数 <strong>$pad_type</strong> には、 <info>STR_PAD_RIGHT</info>, <info>STR_PAD_LEFT</info>, <info>STR_PAD_BOTH</info>
                       を指定可能です。 <strong>$pad_type</strong>が指定されない場合、 <info>STR_PAD_RIGHT</info> を仮定します。

<comment>Return:</comment>
  <info>string</info>  埋めた後の文字列を返します。

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


id: str_repeat
type: function
doc:
<comment>Description:</comment>
  文字列を反復する
  
  <strong>$string</strong> を <strong>$times</strong> 回を繰り返した文字列を返します。

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  繰り返す文字列。
  <info>int</info>     <strong>$times</strong>   <strong>$string</strong> を繰り返す回数。
                   
                   <strong>$times</strong> は 0 以上でなければなりません。 <strong>$times</strong> が 0 に設定された場合、この関数は空
                   文字を返します。

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

<comment>See Also:</comment>
   * for
   * <strong>str_pad()</strong>
   * <strong>substr_count()</strong>


id: str_replace
type: function
doc:
<comment>Description:</comment>
  検索文字列に一致したすべての文字列を置換する
  
  この関数は、<strong>$subject</strong> の中の <strong>$search</strong> を全て <strong>$replace</strong> に置換します。
  
  固定の文字列ではなく、パターンベースでテキストを置換したい場合、 <strong>preg_replace()</strong> を使ってください。

<comment>Param:</comment>
  <info>array|string</info>  <strong>$search</strong>   探したい値。needle (針) と呼ばれることもあります。 配列を使えば、複数の値
                          を指定することもできます。
  <info>array|string</info>  <strong>$replace</strong>  見つかった <strong>$search</strong> を置き換える値。 配列を使えば、複数の値を指定することも
                          できます。
  <info>string|array</info>  <strong>$subject</strong>  検索・置換の対象となる文字列あるいは配列。 haystack (干し草の山) と呼ばれ
                          ることもあります。
                          
                          <strong>$subject</strong> が配列の場合、 <strong>$subject</strong> の各エントリについて検索と置換が行われ、
                          戻り値は同様に配列となります。
  <info>int</info>           <strong>$count</strong>    指定した場合は、マッチして置換が行われた箇所の個数がここに格納されます。

<comment>Return:</comment>
  <info>string|array</info>  この関数は、置換後の文字列あるいは配列を返します。

<comment>See Also:</comment>
   * <strong>str_ireplace()</strong>
   * <strong>substr_replace()</strong>
   * <strong>preg_replace()</strong>
   * <strong>strtr()</strong>


id: str_rot13
type: function
doc:
<comment>Description:</comment>
  文字列に rot13 変換を行う
  
  引数 <strong>$string</strong> に対して ROT13 変換を施し、 その結果の文字列を返します。
  
  ROT13 は、各文字をアルファベット順に 13 文字シフトさせ、 アルファベット以外の文字はそのままとする
  エンコードを行います。 エンコードとデコードは同じ関数で行われます。 引数にエンコードされた文字列を
  指定した場合には、元の文字列が返されます。

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

<comment>Return:</comment>
  <info>string</info>  指定した文字列を ROT13 変換した結果を返します。


id: str_shuffle
type: function
doc:
<comment>Description:</comment>
  文字列をランダムにシャッフルする
  
  <strong>str_shuffle()</strong> は文字列をシャッフルします。 考えられるすべての順列のうちのひとつを作成します。
  
  この関数が生成する値は、暗号学的にセキュアではありません。そのため、これを暗号や、戻り値を推測でき
  ないことが必須の値として使っては いけません。
  
  暗号学的にセキュアな乱数が必要な場合は、<class>Random\Randomizer</class> を <class>Random\Engine\Secure</class> と一緒に使いま
  しょう。簡単なユースケースの場合、<strong>random_int()</strong> と <strong>random_bytes()</strong> 関数が、オペレーティングシステム
  の CSPRNG を使った、 便利で安全な API を提供します。

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

<comment>Return:</comment>
  <info>string</info>  シャッフルされた文字列を返します。

<comment>See Also:</comment>
   * <strong>Random\Randomizer::shuffleBytes()</strong>
   * <strong>Random\Randomizer::shuffleArray()</strong>


id: str_split
type: function
doc:
<comment>Description:</comment>
  文字列を配列に変換する
  
  文字列を配列に変換します。

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  入力文字列。
  <info>int</info>     <strong>$length</strong>  分割した部分の最大長。

<comment>Return:</comment>
  <info>array</info>  オプションのパラメータ <strong>$length</strong> が指定されている場合、 返される配列の各要素は、<strong>$length</strong> の長
         さとなります。但し、平等に分割できない場合、 最後の要素だけはその長さより短くなります。 デ
         フォルトでは、 <strong>$length</strong> の値は <return>1</return> です。 つまり、 1バイトずつ分割された配列となります。

<comment>See Also:</comment>
   * <strong>mb_str_split()</strong>
   * <strong>chunk_split()</strong>
   * <strong>preg_split()</strong>
   * <strong>explode()</strong>
   * <strong>count_chars()</strong>
   * <strong>str_word_count()</strong>
   * for


id: str_starts_with
type: function
doc:
<comment>Description:</comment>
  文字列が指定された部分文字列で始まるかを調べる
  
  <strong>$haystack</strong>  が <strong>$needle</strong> で始まるかを調べます。 大文字小文字は区別されます。

<comment>Param:</comment>
  <info>string</info>  <strong>$haystack</strong>  検索対象の文字列
  <info>string</info>  <strong>$needle</strong>    <strong>$haystack</strong> で調べる部分文字列

<comment>Return:</comment>
  <info>bool</info>  <strong>$haystack</strong> が <strong>$needle</strong> で始まる場合、 <info>true</info> を返します。そうでない場合、<info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>str_contains()</strong>
   * <strong>str_ends_with()</strong>
   * <strong>stripos()</strong>
   * <strong>strrpos()</strong>
   * <strong>strripos()</strong>
   * <strong>strstr()</strong>
   * <strong>strpbrk()</strong>
   * <strong>substr()</strong>
   * <strong>preg_match()</strong>


id: str_word_count
type: function
doc:
<comment>Description:</comment>
  文字列に使用されている単語についての情報を返す
    
  
  <strong>$string</strong> に含まれる単語数を数えます。 オプションの <strong>$format</strong> が指定されていない場合、 見つかった単語
  の数を整数値で返します。 <strong>$format</strong> が指定されている場合は結果が配列で返され、 配列の内容は <strong>$format</strong>
  に依存します。 <strong>$format</strong> に設定できる値と対応する出力については 以下で示します。
  
  この関数を使用するうえで、'単語' は「ロケールに依存したアルファベットから なる文字列で、その先頭以
  外の部分に "'" および "-" を含 めることができる」ものと定義されています。 マルチバイト文字列を使う
  ロケールはサポートされていないので、注意が必要です。

<comment>Param:</comment>
  <info>string</info>       <strong>$string</strong>      文字列。
  <info>int</info>          <strong>$format</strong>      この関数の戻り値を設定します。現在サポートされている値は 以下のとおりで
                            す。  0 - 見つかった単語の数を返します。  1 - <strong>$string</strong> の中に見つかった単
                            語を含む 配列を返します。  2 - 連想配列を返します。<strong>$string</strong> の中での 単語
                            の開始位置がキー、単語自体を対応する値となります。
                            
                            0 - 見つかった単語の数を返します。
                            
                            1 - <strong>$string</strong> の中に見つかった単語を含む 配列を返します。
                            
                            2 - 連想配列を返します。<strong>$string</strong> の中での 単語の開始位置がキー、単語自体
                            を対応する値となります。
  <info>string|null</info>  <strong>$characters</strong>  '単語' とみなされる文字に追加する文字のリスト。

<comment>Return:</comment>
  <info>array|int</info>  選択した <strong>$format</strong> に応じて、配列あるいは整数を返します。

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


id: strcasecmp
type: function
doc:
<comment>Description:</comment>
  大文字小文字を区別しないバイナリセーフな文字列比較を行う
  
  大文字小文字を区別しないバイナリセーフな文字列比較を行います。 ここで行う比較は、ロケールを考慮し
  ません。 つまり、ASCII文字だけが、大文字小文字を区別せず比較されます。

<comment>Param:</comment>
  <info>string</info>  <strong>$string1</strong>  最初の文字列。
  <info>string</info>  <strong>$string2</strong>  次の文字列。

<comment>Return:</comment>
  <info>int</info>  <strong>$string1</strong> が <strong>$string2</strong> より小さい場合は <return>-1</return>、<strong>$string1</strong> が <strong>$string2</strong> より大きい場合は <return>1</return>、等しい場合
       は <return>0</return> を返します。

<comment>See Also:</comment>
   * <strong>strcmp()</strong>
   * <strong>preg_match()</strong>
   * <strong>substr_compare()</strong>
   * <strong>strncasecmp()</strong>
   * <strong>stristr()</strong>
   * <strong>substr()</strong>


id: strcmp
type: function
doc:
<comment>Description:</comment>
  バイナリセーフな文字列比較
  
  この比較は大文字小文字を区別することに注意してください。

<comment>Param:</comment>
  <info>string</info>  <strong>$string1</strong>  最初の文字列。
  <info>string</info>  <strong>$string2</strong>  次の文字列。

<comment>Return:</comment>
  <info>int</info>  <strong>$string1</strong> が <strong>$string2</strong> よりも小さければ <return>-1</return> を、<strong>$string1</strong>が <strong>$string2</strong>よりも大きければ <return>1</return> を、 等し
       ければ <return>0</return> を返します。

<comment>See Also:</comment>
   * <strong>strcasecmp()</strong>
   * <strong>preg_match()</strong>
   * <strong>substr_compare()</strong>
   * <strong>strncmp()</strong>
   * <strong>strstr()</strong>
   * <strong>substr()</strong>


id: strcoll
type: function
doc:
<comment>Description:</comment>
  ロケールに基づく文字列比較
  
  この比較は大文字小文字を区別すること、そして、 <strong>strcmp()</strong> とは異なり、 バイナリセーフではないことに
  注意してください。
  
  <strong>strcoll()</strong> は比較を行う際に現在のロケールを使用します。 ロケールが C または POSIX の場合、この関数
  は <strong>strcmp()</strong> と等価です。

<comment>Param:</comment>
  <info>string</info>  <strong>$string1</strong>  最初の文字列。
  <info>string</info>  <strong>$string2</strong>  次の文字列。

<comment>Return:</comment>
  <info>int</info>  <strong>$string1</strong> が <strong>$string2</strong> より小さい場合に 0 未満の値、<strong>$string1</strong> が <strong>$string2</strong> より大きい場合に 0 よ
       り大きな値、 両者が等しい場合に 0 を返します。

<comment>See Also:</comment>
   * <strong>preg_match()</strong>
   * <strong>strcmp()</strong>
   * <strong>strcasecmp()</strong>
   * <strong>substr()</strong>
   * <strong>stristr()</strong>
   * <strong>strncasecmp()</strong>
   * <strong>strncmp()</strong>
   * <strong>strstr()</strong>
   * <strong>setlocale()</strong>


id: strcspn
type: function
doc:
<comment>Description:</comment>
  マスクにマッチしない最初のセグメントの長さを返す
  
  <strong>$string</strong> において <strong>$characters</strong> の文字がどれも含まれていない最初のセグメントの長さを返します。
  
  <strong>$offset</strong> と <strong>$length</strong> を省略した場合は、<strong>$string</strong> の全体を調べます。 これらのパラメータを指定した場合
  は、 <return>strcspn(substr($string, $offset, $length), $characters)</return> をコールするのと同じ動きになります。
  (詳細は  を参照ください)。

<comment>Param:</comment>
  <info>string</info>    <strong>$string</strong>      調べたい文字列。
  <info>string</info>    <strong>$characters</strong>  許可しない文字をすべて含む文字列。
  <info>int</info>       <strong>$offset</strong>      <strong>$string</strong> の中で調べ始める位置。
                         
                         <strong>$offset</strong> に非負の値を指定した場合は、 <strong>strcspn()</strong> は、 <strong>$string</strong> の <strong>$offset</strong> 番目
                         の文字から調べ始めます。 たとえば '<return>abcdef</return>' という文字列があったとすると、 <return>0</return>
                         番目の文字が '<return>a</return>' で <return>2</return> 番目の文字は '<return>c</return>' のようになります。
                         
                         <strong>$offset</strong> に負の値を指定した場合は、 <strong>strcspn()</strong> は、 <strong>$string</strong> の後ろから
                         <strong>$offset</strong> 番目の文字から調べ始めます。
  <info>int|null</info>  <strong>$length</strong>      <strong>$string</strong> の中での調べるセグメントの長さ。
                         
                         <strong>$length</strong> に非負の値を指定した場合は、 <strong>$string</strong> の開始位置から <strong>$length</strong> 文字ぶ
                         んだけ調べます。
                         
                         <strong>$length</strong> に負の値を指定した場合は、 <strong>$string</strong> の開始位置から調べ始めて、
                         <strong>$string</strong> の末尾から <strong>$length</strong> 文字目のところまで調べます。

<comment>Return:</comment>
  <info>int</info>  <strong>$string</strong> の中で、 <strong>$characters</strong> の文字をまったく含まない 最初のセグメントの長さを返します。
       
       <strong>$offset</strong> を指定した場合は、その位置から長さを数え始めます。 <strong>$string</strong> の先頭から数えるわけではあ
       りません。

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


id: streamWrapper
type: class
doc:
<comment>Description:</comment>
  独自のプロトコルハンドラやストリームを実装し、 (<strong>fopen()</strong> や <strong>fread()</strong> などの) 他のファイルシステム関
  数で使用できるようにします。
  
  これは、実際のクラスではありません。 クラスがどのようにプロトコルを定義すべきかを示す、単なるプロ
  トタイプです。
  
  ここに示す方法以外でメソッドを実装した場合の挙動は未定義となります。
  
  このクラスのインスタンスは、 関連付けられているプロトコルへのストリーム関数からのアクセスがあった
  時点で初期化されます。


id: streamWrapper::__construct
type: function
doc:
<comment>Description:</comment>
  新しいストリームラッパーを作成する
  
  ストリームラッパーをオープンしたときに、 streamWrapper::stream_open の直前にコールされます。


id: streamWrapper::__destruct
type: function
doc:
<comment>Description:</comment>
  既存のストリームラッパーを破棄する
  
  ストリームラッパーを閉じるときに、 streamWrapper::stream_flush の直前に呼び出されます。


id: streamWrapper::dir_closedir
type: function
doc:
<comment>Description:</comment>
  ディレクトリハンドルを閉じる
  
  このメソッドは <strong>closedir()</strong> に対応してコールされます。
  
  ディレクトリストリームをオープンして使用している際にロックしたり割り当てたりしたリソースは、 すべ
  て開放しなければなりません。

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

<comment>See Also:</comment>
   * <strong>closedir()</strong>
   * streamWrapper::dir_opendir


id: streamWrapper::dir_opendir
type: function
doc:
<comment>Description:</comment>
  ディレクトリハンドルをオープンする
  
  このメソッドは、<strong>opendir()</strong> に対応してコールされます。

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>     <strong>opendir()</strong> に渡す URL を指定します。
                    
                    <strong>parse_url()</strong> でこの URL が壊れることがあります。
  <info>int</info>     <strong>$options</strong>  

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

<comment>See Also:</comment>
   * <strong>opendir()</strong>
   * streamWrapper::dir_closedir
   * <strong>parse_url()</strong>


id: streamWrapper::dir_readdir
type: function
doc:
<comment>Description:</comment>
  ディレクトリハンドルからエントリを読み込む
  
  このメソッドは、<strong>readdir()</strong> に対応してコールされます。

<comment>Return:</comment>
  <info>string</info>  次のファイル名をあらわす文字列、あるいは次のファイルがない場合に <info>false</info> を返します。
          
          戻り値は文字列にキャストされます。

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


id: streamWrapper::dir_rewinddir
type: function
doc:
<comment>Description:</comment>
  ディレクトリハンドルを巻き戻す
  
  このメソッドは、<strong>rewinddir()</strong> に対応してコールされます。
  
  streamWrapper::dir_readdir が生成する出力をリセットしなければなりません。 つまり、次に
  streamWrapper::dir_readdir をコールすると、streamWrapper::dir_opendir が返す場所にある最初のエント
  リを返すようにしなければいけないということです。

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

<comment>See Also:</comment>
   * <strong>rewinddir()</strong>
   * streamWrapper::dir_readdir


id: streamWrapper::mkdir
type: function
doc:
<comment>Description:</comment>
  ディレクトリを作成する
  
  このメソッドは、<strong>mkdir()</strong> に対応してコールされます。
  
  適切なエラーメッセージを返すためには、 ラッパーがディレクトリの作成に対応していない場合にはこのメ
  ソッドを定義しては いけません。

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>     作成したいディレクトリ。
  <info>int</info>     <strong>$mode</strong>     <strong>mkdir()</strong> に渡す値。
  <info>int</info>     <strong>$options</strong>  <info>STREAM_MKDIR_RECURSIVE</info> などの値のビットマスク。

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

<comment>See Also:</comment>
   * <strong>mkdir()</strong>
   * streamwrapper::rmdir


id: streamWrapper::rename
type: function
doc:
<comment>Description:</comment>
  ファイルあるいはディレクトリの名前を変える
  
  このメソッドは、<strong>rename()</strong> に対応してコールされます。
  
  <strong>$path_from</strong> を <strong>$path_to</strong> に変更します。
  
  適切なエラーメッセージを返すためには、 ラッパーがファイル名の変更に対応していない場合にはこのメ
  ソッドを定義しては いけません。

<comment>Param:</comment>
  <info>string</info>  <strong>$path_from</strong>  現在のファイルの URL。
  <info>string</info>  <strong>$path_to</strong>    <strong>$path_from</strong> の変更後の URL。

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

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


id: streamWrapper::rmdir
type: function
doc:
<comment>Description:</comment>
  ディレクトリを削除する
  
  このメソッドは、<strong>rmdir()</strong> に対応してコールされます。
  
  適切なエラーメッセージを返すためには、 ラッパーがディレクトリの削除に対応していない場合にはこのメ
  ソッドを定義しては いけません。

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>     削除したいディレクトリの URL。
  <info>int</info>     <strong>$options</strong>  <info>STREAM_MKDIR_RECURSIVE</info> などの値のビットマスク。

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

<comment>See Also:</comment>
   * <strong>rmdir()</strong>
   * streamwrapper::mkdir
   * streamwrapper::unlink


id: streamWrapper::stream_cast
type: function
doc:
<comment>Description:</comment>
  元となるリソースを取得する
  
  このメソッドは、<strong>stream_select()</strong> に対応してコールされます。

<comment>Param:</comment>
  <info>int</info>  <strong>$cast_as</strong>  <strong>stream_select()</strong> が <strong>stream_cast()</strong> をコールした場合は <info>STREAM_CAST_FOR_SELECT</info>、
                 <strong>stream_cast()</strong> がそれ以外の用途でコールされた場合は <info>STREAM_CAST_AS_STREAM</info>。

<comment>Return:</comment>
  <info>resource</info>  ラッパーが使用しているストリームリソース、あるいは <info>false</info> を返します。

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


id: streamWrapper::stream_close
type: function
doc:
<comment>Description:</comment>
  リソースを閉じる
  
  このメソッドは、<strong>fclose()</strong> に対応してコールされます。
  
  ラッパーがロックしたり割り当てたりしたリソースは、すべて開放しなければなりません。

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

<comment>See Also:</comment>
   * <strong>fclose()</strong>
   * streamWrapper::dir_closedir


id: streamWrapper::stream_eof
type: function
doc:
<comment>Description:</comment>
  ファイルポインタが終端にあるかどうかを調べる
  
  このメソッドは、<strong>feof()</strong> に対応してコールされます。

<comment>Return:</comment>
  <info>bool</info>  読み込み/書き込み位置がストリームの末尾にあってもうそれ以上読み込むデータがない場合に <info>true</info>、
        それ以外の場合に <info>false</info> を返します。

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


id: streamWrapper::stream_flush
type: function
doc:
<comment>Description:</comment>
  出力をフラッシュする
  
  このメソッドがコールされるのは、<strong>fflush()</strong> への対応をする場合やストリームを閉じる場合です。 フラッ
  シュしていないデータが残っていれば、それを書き出します。
  
  データをストリームにキャッシュした状態でまだストレージに格納していないのなら、 ここで格納しなけれ
  ばなりません。

<comment>Return:</comment>
  <info>bool</info>  キャッシュデータが正常に格納できた (あるいは格納するデータがなかった) 場合に <info>true</info>、データを
        格納できなかった場合に <info>false</info> を返します。

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


id: streamWrapper::stream_lock
type: function
doc:
<comment>Description:</comment>
  ファイルのアドバイザリ・ロック
  
  このメソッドは、<strong>flock()</strong> に対応してコールされます。また <strong>file_put_contents()</strong> (<strong>$flags</strong> が <info>LOCK_EX</info> を含
  む場合)、 <strong>stream_set_blocking()</strong> がコールされたときやストリームを閉じるとき (<info>LOCK_UN</info>) にもコールさ
  れます。

<comment>Param:</comment>
  <info>int</info>  <strong>$operation</strong>  <strong>$operation</strong> は以下のいずれかとなります。 <info>LOCK_SH</info> 共有ロック (読み込み) を確保しま
                   す。 <info>LOCK_EX</info> 排他ロック (書き込み) を確保します。 <info>LOCK_UN</info> ロック (共有あるいは排
                   他) を開放します。 <info>LOCK_NB</info><strong>flock()</strong> によるロック中にブロックしない (Windows ではサ
                   ポートしていません)。
                   
                   <info>LOCK_SH</info> 共有ロック (読み込み) を確保します。
                   
                   <info>LOCK_EX</info> 排他ロック (書き込み) を確保します。
                   
                   <info>LOCK_UN</info> ロック (共有あるいは排他) を開放します。
                   
                   <info>LOCK_NB</info><strong>flock()</strong> によるロック中にブロックしない (Windows ではサポートしていませ
                   ん)。

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

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


id: streamWrapper::stream_metadata
type: function
doc:
<comment>Description:</comment>
  ストリームメタデータを変更する
  
  ストリームのメタデータを設定します。ストリーム URL 上で次のいずれかの関数がコールされたときに呼び
  出されます。 <strong>touch()</strong><strong>chmod()</strong><strong>chown()</strong><strong>chgrp()</strong> システムによっては、これらの動作の中に利用できないものが
  ある可能性もあります。

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>    メタデータを設定するファイルパスあるいは URL。URL の場合は、:// 区切りの形式でな
                   ければならないことに注意しましょう。 それ以外の形式の URL には対応していません。
  <info>int</info>     <strong>$option</strong>  次のいずれかです。 <info>STREAM_META_TOUCH</info> (<strong>touch()</strong> に反応してコールされ
                   る)<info>STREAM_META_OWNER_NAME</info> (<strong>chown()</strong> に反応して文字列引数つきでコールされ
                   る)<info>STREAM_META_OWNER</info> (<strong>chown()</strong> に反応してコールされる)<info>STREAM_META_GROUP_NAME</info>
                   (<strong>chgrp()</strong> に反応してコールされる)<info>STREAM_META_GROUP</info> (<strong>chgrp()</strong> に反応してコールされ
                   る)<info>STREAM_META_ACCESS</info> (<strong>chmod()</strong> に反応してコールされる)
  <info>mixed</info>   <strong>$value</strong>   <strong>$option</strong> の値が <info>STREAM_META_TOUCH</info> の場合は、<strong>touch()</strong> 関数の二つの引数を含む配列。
                   <info>STREAM_META_OWNER_NAME</info> あるいは <info>PHP_STREAM_META_GROUP_NAME</info> の場合は、オーナーの名
                   前を表す文字列。<info>STREAM_META_OWNER</info> あるいは <info>PHP_STREAM_META_GROUP</info> の場合は、オー
                   ナーを表す整数値。<info>STREAM_META_ACCESS</info> の場合は、<strong>chmod()</strong> への引数となる整数値。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。 <strong>$option</strong> が実装されていない場合は
        <info>false</info> を返さなければなりません。

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


id: streamWrapper::stream_open
type: function
doc:
<comment>Description:</comment>
  ファイルあるいは URL をオープンする
  
  このメソッドは、ラッパーが初期化された (たとえば <strong>fopen()</strong> や <strong>file_get_contents()</strong>) 直後にコールされ
  ます。

<comment>Param:</comment>
  <info>string</info>       <strong>$path</strong>         元の関数に渡す URL を指定します。
                             
                             <strong>parse_url()</strong> でこの URL が壊れることがあります。 :// で区切った URL のみ
                             をサポートしていることに注意しましょう。 : や :/ も技術的な面では妥当な
                             URL ですが、サポートしていません。
  <info>string</info>       <strong>$mode</strong>         ファイルをオープンする際のモード。詳細は <strong>fopen()</strong> を参照ください。
                             
                             指定した <strong>$path</strong> に対して <strong>$mode</strong> が有効かどうかの確認を忘れないようにしま
                             しょう。
  <info>int</info>          <strong>$options</strong>      ストリーム API が設定する追加のフラグ。次の値を OR で連結して指定しま
                             す。 フラグ説明<info>STREAM_USE_PATH</info><strong>$path</strong> が相対パスの場合は、 include_path
                             を用いてリソースを探します。 <info>STREAM_REPORT_ERRORS</info>このフラグが設定されて
                             いる場合、 ストリームのオープン時のエラーを <strong>trigger_error()</strong> で報告しな
                             ければなりません。フラグが設定されていない場合は、 エラーを一切報告して
                             はいけません。
  <info>string|null</info>  <strong>$opened_path</strong>  <strong>$path</strong> のオープンに成功し、 <info>STREAM_USE_PATH</info> が <strong>$options</strong> に設定されていた
                             場合、 <strong>$opened_path</strong> には実際にオープンしたファイル/リソース のフルパス
                             を設定しなければなりません。

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

<comment>See Also:</comment>
   * <strong>fopen()</strong>
   * <strong>parse_url()</strong>


id: streamWrapper::stream_read
type: function
doc:
<comment>Description:</comment>
  ストリームから読み込む
  
  このメソッドは、<strong>fread()</strong> および <strong>fgets()</strong> に対応してコールされます。
  
  ストリームの読み込み/書き込み位置 (読み込みに成功したバイト数ぶん) の更新を忘れないようにしましょ
  う。

<comment>Param:</comment>
  <info>int</info>  <strong>$count</strong>  現在位置から何バイトぶんのデータを返すか。

<comment>Return:</comment>
  <info>string|false</info>  <strong>$count</strong> バイト未満のデータしか存在しない場合は、 返せる限りのデータを返します。もう
                データがない場合は、空文字列を返します。 読み込みが失敗した場合は、<info>false</info> を返しま
                す。

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


id: streamWrapper::stream_seek
type: function
doc:
<comment>Description:</comment>
  ストリーム内の特定の場所に移動する
  
  このメソッドは、<strong>fseek()</strong> に対応してコールされます。
  
  ストリームの読み込み/書き込み位置を、 <strong>$offset</strong> と <strong>$whence</strong> に応じて更新しなければなりません。

<comment>Param:</comment>
  <info>int</info>  <strong>$offset</strong>  移動するストリームオフセット。
  <info>int</info>  <strong>$whence</strong>  使用可能な値 <info>SEEK_SET</info> - <strong>$offset</strong> バイト目の位置に移動する。<info>SEEK_CUR</info> - 現在位置から
                <strong>$offset</strong> バイトぶん進める。<info>SEEK_END</info> - ファイルの終端から <strong>$offset</strong> バイトぶん進める。
                
                現在の実装は、 <strong>$whence</strong> の値を <info>SEEK_CUR</info> に設定することはありません。 そのようなシーク
                は、 内部的に <info>SEEK_SET</info> と同じ動きに変換されます。

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

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


id: streamWrapper::stream_set_option
type: function
doc:
<comment>Description:</comment>
  ストリームのオプションを変更する
  
  このメソッドは、ストリームのオプションを設定する際にコールされます。

<comment>Param:</comment>
  <info>int</info>  <strong>$option</strong>  以下のいずれか。 <info>STREAM_OPTION_BLOCKING</info> (このメソッドは、<strong>stream_set_blocking()</strong> に対
                応してコールされます)<info>STREAM_OPTION_READ_TIMEOUT</info> (このメソッドは、
                <strong>stream_set_timeout()</strong> に対応してコールされます)<info>STREAM_OPTION_WRITE_BUFFER</info> (このメソッ
                ドは、<strong>stream_set_write_buffer()</strong> に対応してコールされます)
  <info>int</info>  <strong>$arg1</strong>    <strong>$option</strong> の値に応じて、以下の内容となります。 <info>STREAM_OPTION_BLOCKING</info>: 要求されたブ
                ロックモード (1 はブロックモード、0 は非ブロックモード)。<info>STREAM_OPTION_READ_TIMEOUT</info>:
                タイムアウト秒数。<info>STREAM_OPTION_WRITE_BUFFER</info>: バッファモード (<info>STREAM_BUFFER_NONE</info> あ
                るいは <info>STREAM_BUFFER_FULL</info>)。
  <info>int</info>  <strong>$arg2</strong>    <strong>$option</strong> の値に応じて、以下の内容となります。 <info>STREAM_OPTION_BLOCKING</info>: このオプション
                は設定されません。<info>STREAM_OPTION_READ_TIMEOUT</info>: タイムアウトマイクロ秒数。
                <info>STREAM_OPTION_WRITE_BUFFER</info>: 要求されたバッファサイズ。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。 <strong>$option</strong> が実装されていない場合は
        <info>false</info> を返さなければなりません。

<comment>See Also:</comment>
   * <strong>stream_set_blocking()</strong>
   * <strong>stream_set_timeout()</strong>
   * <strong>stream_set_write_buffer()</strong>


id: streamWrapper::stream_stat
type: function
doc:
<comment>Description:</comment>
  ファイルリソースについての情報を取得する
  
  このメソッドは、<strong>fstat()</strong> に対応してコールされます。

<comment>Return:</comment>
  <info>array|false</info>  <strong>stat()</strong> を参照ください。

<comment>See Also:</comment>
   * <strong>stat()</strong>
   * streamwrapper::url_stat


id: streamWrapper::stream_tell
type: function
doc:
<comment>Description:</comment>
  ストリームの現在位置を取得する
  
  このメソッドは、<strong>fseek()</strong> に対応してコールされ、現在の位置を決定します。

<comment>Return:</comment>
  <info>int</info>  ストリームの現在位置を返します。

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


id: streamWrapper::stream_truncate
type: function
doc:
<comment>Description:</comment>
  ストリームを丸める
  
  <strong>ftruncate()</strong> などによる丸めの際にコールされます。

<comment>Param:</comment>
  <info>int</info>  <strong>$new_size</strong>  新しいサイズ。

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

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


id: streamWrapper::stream_write
type: function
doc:
<comment>Description:</comment>
  ストリームに書き込む
  
  このメソッドは、<strong>fwrite()</strong> に対応してコールされます。
  
  正常にストリームに書き込めたバイト数ぶんだけ、 ストリームの現在位置を更新することを忘れないように
  しましょう。

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  元となるシステムに書き込まれるデータ。
                 
                 元となるシステム上にすべてを書き込むだけの余地がない場合は、 可能な限りのデータを格
                 納します。

<comment>Return:</comment>
  <info>int</info>  正常に格納できたバイト数、あるいは何も格納できなかった場合は 0 を返します。

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


id: streamWrapper::unlink
type: function
doc:
<comment>Description:</comment>
  ファイルを削除する
  
  このメソッドは、<strong>unlink()</strong> に対応してコールされます。
  
  適切なエラーメッセージを返すためには、 ラッパーがファイルの削除に対応していない場合にはこのメソッ
  ドを定義しては いけません。

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>  削除したいファイルの URL。

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

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


id: streamWrapper::url_stat
type: function
doc:
<comment>Description:</comment>
  ファイルについての情報を取得する
  
  このメソッドは、すべての <strong>stat()</strong> 関連の関数に対応してコールされます。
  <strong>copy()</strong><strong>fileperms()</strong><strong>fileinode()</strong><strong>filesize()</strong><strong>fileowner()</strong><strong>filegroup()</strong><strong>fileatime()</strong><strong>filemtime()</strong><strong>filectime()</strong><strong>filetype()</strong><strong>is_writable()</strong><strong>is_readable()</strong><strong>is_executable()</strong><strong>is_file()</strong><strong>is_dir()</strong><strong>is_link()</strong><strong>file_exists()</strong><strong>lstat()</strong><strong>stat()</strong>SplFileInfo::getPermsSplFileInfo::getInodeSplFileInfo::getSizeSplFileInfo::getOwnerSplFileInfo::getGroupSplFileInfo::getATimeSplFileInfo::getMTimeSplFileInfo::getCTimeSplFileInfo::getTypeSplFileInfo::isWritableSplFileInfo::isReadableSplFileInfo::isExecutableSplFileInfo::isFileSplFileInfo::isDirSplFileInfo::isLinkRecursiveDirectoryIterator::hasChildren

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>   情報を取得したいファイルの URL。 URL の区切り文字は :// でなければならないことに注
                  意しましょう。 それ以外の形式の URL はサポートしていません。
  <info>int</info>     <strong>$flags</strong>  ストリーム API が設定する追加のフラグ。以下の値の OR で組み合わせて使用します。
                  FlagDescriptionSTREAM_URL_STAT_LINK 他のリソースへのリンクを行うことができるリソー
                  ス (たとえば HTTP Location: による転送やファイルシステムのシンボリックリンク)。 こ
                  のフラグを指定すると、リンク先のリソースの情報ではなくリンクそのものの情報のみを返
                  します。 このフラグは、<strong>lstat()</strong>、 <strong>is_link()</strong> あるいは <strong>filetype()</strong> に対応して設定され
                  ます。 STREAM_URL_STAT_QUIET このフラグが設定されると、ラッパーが一切エラーを発生
                  しなくなります。 フラグが設定されていない場合、 パス情報の取得中に発生したエラーは
                  <strong>trigger_error()</strong> を用いて通知します。

<comment>Return:</comment>
  <info>array|false</info>  <strong>stat()</strong> が返すのと同じ要素をを持つ配列を返さなければなりません。 未知の値、あるいは取
               得できない値については適切な値 (通常は <info>0</info>) を設定します。 <strong>stat()</strong> 関数で説明されている
               <return>mode</return> には特別な注意を払ってください。 失敗した場合は、<info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>stat()</strong>
   * streamwrapper::stream_stat


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

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


id: stream_bucket_make_writeable
type: function
doc:
<comment>Description:</comment>
  操作する brigade から bucket オブジェクトを返す
    
  
  brigade に含まれる内容にアクセスしたり、 操作したりする場合には、常にこの関数がコールされます。 通
  常は、php_user_filter::filter からコールされます。

<comment>Param:</comment>
  <info>resource</info>  <strong>$brigade</strong>  bucket オブジェクトを返す brigade。

<comment>Return:</comment>
  <info>object|null</info>  以下に示すプロパティを持つ bucket オブジェクトを返すか、 <info>null</info> を返します。 data
               (<info>string</info>) <strong>$data</strong><return>bucket</return> bucket に含まれる現在の文字列。 datalen (<info>integer</info>) <strong>$datalen</strong><return>bucket</return>
               bucket に含まれる文字列の長さ。
               
               <strong>$data</strong><return>bucket</return> bucket に含まれる現在の文字列。
               
               <strong>$datalen</strong><return>bucket</return> bucket に含まれる文字列の長さ。

<comment>See Also:</comment>
   * <strong>stream_bucket_append()</strong>
   * <strong>stream_bucket_prepend()</strong>


id: stream_bucket_new
type: function
doc:
<comment>Description:</comment>
  現在のストリームで使用する新しい bucket を作成する
    
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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


id: stream_bucket_prepend
type: function
doc:
<comment>Description:</comment>
  bucket を brigade の先頭に追加する
    
  
  この関数を呼ぶと、bucket brigade の先頭に bucket を追加できます。一般に、 php_user_filter::filter
  から呼ばれます。

<comment>Param:</comment>
  <info>resource</info>  <strong>$brigade</strong>  <strong>$brigade</strong> は <return>bucket brigade</return> を指すリソースで、ここにはひとつあるいは複数の
                      <return>bucket</return> オブジェクトが含まれます。
  <info>object</info>    <strong>$bucket</strong>   bucket オブジェクト。

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


id: stream_context_create
type: function
doc:
<comment>Description:</comment>
  ストリームコンテキストを作成する
  
  <strong>$options</strong> に、 指定されたオプションが予め設定されたストリームコンテキストを作成し、 それを返しま
  す。

<comment>Param:</comment>
  <info>array|null</info>  <strong>$options</strong>  次のような形式の連想配列からなる連想配列 <return>$arr['wrapper']['option'] = $value</return>
                        または <info>null</info> でなくてはなりません。 使用可能はラッパーやオプションの一覧は コ
                        ンテキストオプション を参照ください。
                        
                        デフォルトは <info>null</info> です。
  <info>array|null</info>  <strong>$params</strong>   <return>$arr['parameter'] = $value</return> 形式の連想配列、または <info>null</info> でなくてはなりませ
                        ん。 標準のストリームパラメータについては コンテキストパラメータ を参照くだ
                        さい。

<comment>Return:</comment>
  <info>resource</info>  ストリームコンテキストリソースを返します。

<comment>See Also:</comment>
   * <strong>stream_context_set_option()</strong>
   * サポートするラッパーのリスト ()
   * コンテキストオプション ()


id: stream_context_get_default
type: function
doc:
<comment>Description:</comment>
  デフォルトのストリームコンテキストを取得する
  
  （<strong>fopen()</strong>、<strong>file_get_contents()</strong> のような） ファイル操作関数がコンテキストパラメータなしでコールされ
  た場合に使用される デフォルトのストリームコンテキストを返します。デフォルトコンテキストに 関するオ
  プションは、<strong>stream_context_create()</strong> と同じ 構文で任意に指定することが可能です。

<comment>Param:</comment>
  <info>array|null</info>  <strong>$options</strong>  <strong>$options</strong> は、 <return>$arr['wrapper']['option'] = $value</return> のような形式の、連想配列の
                        連想配列、 または <info>null</info> である必要があります。

<comment>Return:</comment>
  <info>resource</info>  ストリームコンテキストリソースを返します。

<comment>See Also:</comment>
   * <strong>stream_context_create()</strong>
   * <strong>stream_context_set_default()</strong>
   * サポートするラッパーとコンテキストオプションの一覧 ().


id: stream_context_get_options
type: function
doc:
<comment>Description:</comment>
  ストリーム / ラッパー / コンテキストに設定されているオプションを取得する
  
  指定されたストリームまたはコンテキストに設定されたオプションを配列として返します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream_or_context</strong>  オプションを取得したいストリームあるいはコンテキスト。

<comment>Return:</comment>
  <info>array</info>  オプションを連想配列で返します。


id: stream_context_get_params
type: function
doc:
<comment>Description:</comment>
  コンテキストのパラメータを取得する
  
  パラメータおよびオプションの情報を、ストリームあるいはコンテキストから取得します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$context</strong>  ストリームリソースあるいは コンテキストリソース。

<comment>Return:</comment>
  <info>array</info>  すべてのコンテキストオプションおよびパラメータを含む連想配列を返します。

<comment>See Also:</comment>
   * <strong>stream_context_set_option()</strong>
   * <strong>stream_context_set_params()</strong>


id: stream_context_set_default
type: function
doc:
<comment>Description:</comment>
  デフォルトのストリームコンテキストを設定する
  
  (<strong>fopen()</strong>、<strong>file_get_contents()</strong> のような) ファイル操作関数がコンテキストパラメータなしでコールされた
  場合に使用される デフォルトのストリームコンテキストを設定します。 <strong>stream_context_create()</strong> と同じ構
  文が使用できます。

<comment>Param:</comment>
  <info>array</info>  <strong>$options</strong>  デフォルトコンテキストに設定するオプション。
                   
                   <strong>$options</strong> は、 <return>$arr['wrapper']['option'] = $value</return> のような形式の、連想配列の連想配
                   列である必要があります。

<comment>Return:</comment>
  <info>resource</info>  デフォルトのストリームコンテキストを返します。

<comment>See Also:</comment>
   * <strong>stream_context_create()</strong>
   * <strong>stream_context_get_default()</strong>
   * サポートするラッパーとコンテキストオプションの一覧 ().


id: stream_context_set_option
type: function
doc:
<comment>Description:</comment>
  ストリーム / ラッパー / コンテキストのオプションを設定する
  
  指定されたストリームまたはコンテキストのオプションを設定します。 <strong>$value</strong> の内容が <strong>$wrapper</strong> に対する
  <strong>$option</strong> として設定されます。

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream_or_context</strong>  オプションを適用したいストリームあるいはコンテキストリソース。
  <info>string</info>    <strong>$wrapper</strong>            ラッパーの名前(プロトコルによって異なります)。 ストリームオプション
                                の一覧は コンテキストオプションおよびパラメータを参照ください。
  <info>string</info>    <strong>$option</strong>             オプションの名前
  <info>mixed</info>     <strong>$value</strong>              オプションの値
  <info>array</info>     <strong>$options</strong>            <strong>$stream_or_context</strong> に設定するオプション。
                                
                                <strong>$options</strong> は、 <return>$arr['wrapper']['option'] = $value</return> のような形式の、連
                                想配列の連想配列である必要があります。
                                
                                ストリームオプションの一覧は コンテキストオプションおよびパラメータ
                                を参照ください。

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


id: stream_context_set_options
type: function
doc:
<comment>Description:</comment>
  指定されたコンテキストのオプションを設定する
  
  指定されたコンテキストのオプションを設定します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$context</strong>  オプションを適用するストリーム、またはコンテキストリソース。
  <info>array</info>     <strong>$options</strong>  <strong>$context</strong> に設定するオプション。
                      
                      <strong>$options</strong> は、 $array['wrapper']['option'] = $value のフォーマットからなる連想
                      配列でなければいけません。
                      
                      ストリームオプションの一覧は コンテキストオプションとパラメータ を参照くださ
                      い。

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

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


id: stream_context_set_params
type: function
doc:
<comment>Description:</comment>
  ストリーム / ラッパー / コンテキストのパラメータを設定する
  
  指定したコンテキストのパラメータを設定します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$context</strong>  パラメータを適用したいストリームあるいはコンテキスト。
  <info>array</info>     <strong>$params</strong>   <return>$params['paramname'] = "paramvalue";</return> という形式で設定される、連想配列のパラ
                      メータ。

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

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


id: stream_copy_to_stream
type: function
doc:
<comment>Description:</comment>
  データをあるストリームから別のストリームにコピーする
  
  現在の位置（あるいはもし指定されていれば <strong>$offset</strong> の位置）から最大 <strong>$length</strong> バイトのデータを <strong>$from</strong>
  から <strong>$to</strong> にコピーします。もし <strong>$length</strong> が <info>null</info> の 場合は、<strong>$from</strong> にある残りすべてのデータが コピーさ
  れます。

<comment>Param:</comment>
  <info>resource</info>  <strong>$from</strong>    コピー元のストリーム。
  <info>resource</info>  <strong>$to</strong>      コピー先のストリーム。
  <info>int|null</info>  <strong>$length</strong>  コピーする最大バイト数。 デフォルトでは、残りの全てのデータがコピーされます。
  <info>int</info>       <strong>$offset</strong>  コピーを開始する位置。

<comment>Return:</comment>
  <info>int|false</info>  コピーされたバイト数を返します。失敗した場合に <info>false</info> を返します。

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


id: stream_filter_append
type: function
doc:
<comment>Description:</comment>
  ストリームにフィルタを付加する
  
  <strong>$filtername</strong> で指定されたフィルタを、 <strong>$stream</strong> に付加されているフィルタのリストに加えます。

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>      対象となるストリーム。
  <info>string</info>    <strong>$filtername</strong>  フィルタ名。
  <info>int</info>       <strong>$read_write</strong>  デフォルトでは、 <strong>stream_filter_append()</strong> は ストリームが読み込み用に開かれて
                         いる場合は (つまり、オープンモードが <return>r</return> あるいは <return>+</return> を伴う場合は)、 フィルタ
                         を <return>リードフィルタチェイン</return> に追加し、 ストリームが書き出し用に開かれている場
                         合は(つまり、オープンモードが <return>w</return> か <return>a</return>か、あるいは<return>+</return> を伴う場合は)、 <return>ライト
                         フィルターチェィン</return>にも追加します。 <info>STREAM_FILTER_READ</info>・
                         <info>STREAM_FILTER_WRITE</info>・ <info>STREAM_FILTER_ALL</info> を <strong>$read_write</strong>パラメータに渡すこと
                         で、この挙動を変えることができます。
  <info>mixed</info>     <strong>$params</strong>      このフィルタは、指定された <strong>$params</strong> と共に、 リストの末尾に追加され、スト
                         リームに対する操作の中で最後に呼び出されます。 フィルタをリストの先頭に加え
                         たいときは、<strong>stream_filter_prepend()</strong> を使ってください。

<comment>Return:</comment>
  <info>resource</info>  成功した場合にリソース、失敗した場合に <info>false</info> を返します。 このリソースは、
            <strong>stream_filter_remove()</strong> をコールする際にこのフィルタインスタンスを参照するために使用可能
            です。
            
            <info>false</info> が返されるのは、<strong>$stream</strong> がリソースではない場合や <strong>$filtername</strong> が見つからない場合で
            す。

<comment>See Also:</comment>
   * <strong>stream_filter_register()</strong>
   * <strong>stream_filter_prepend()</strong>
   * <strong>stream_get_filters()</strong>


id: stream_filter_prepend
type: function
doc:
<comment>Description:</comment>
  フィルタをストリームに付加する
  
  <strong>$filtername</strong> で指定されたフィルタを、 <strong>$stream</strong> に付加されているフィルタのリストに加えます。

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>      対象となるストリーム。
  <info>string</info>    <strong>$filtername</strong>  フィルタ名。
  <info>int</info>       <strong>$read_write</strong>  デフォルトでは、 <strong>stream_filter_prepend()</strong> は ストリームが読み込み用に開かれ
                         ている場合は (つまり、オープンモードが <return>r</return> あるいは <return>+</return> を伴う場合は)、 フィル
                         タを <return>リードフィルタチェイン</return> に追加し、 ストリームが書き出し用に開かれている
                         場合は(つまり、オープンモードが <return>w</return> か <return>a</return>か、あるいは<return>+</return> を伴う場合は)、 <return>ライト
                         フィルターチェィン</return>にも追加します。 <info>STREAM_FILTER_READ</info>・
                         <info>STREAM_FILTER_WRITE</info>・ <info>STREAM_FILTER_ALL</info> を <strong>$read_write</strong>パラメータに渡すこと
                         で、この挙動を変えることができます。 このパラメータを使った例については、
                         <strong>stream_filter_append()</strong> を参照ください。
  <info>mixed</info>     <strong>$params</strong>      このフィルタは、指定された <strong>$params</strong> と共に、 リストの先頭に追加され、スト
                         リームに対する操作の中で最初に呼び出されます。 フィルタをリストの末尾に加え
                         たいときは、<strong>stream_filter_append()</strong> を使ってください。

<comment>Return:</comment>
  <info>resource</info>  成功した場合にリソース、失敗した場合に <info>false</info> を返します。 このリソースは、
            <strong>stream_filter_remove()</strong> をコールする際にこのフィルタインスタンスを参照するために使用可能
            です。
            
            <info>false</info> が返されるのは、<strong>$stream</strong> がリソースではない場合や <strong>$filtername</strong> が見つからない場合で
            す。

<comment>See Also:</comment>
   * <strong>stream_filter_register()</strong>
   * <strong>stream_filter_append()</strong>


id: stream_filter_register
type: function
doc:
<comment>Description:</comment>
  ユーザー定義のストリームフィルタを登録する
  
  <strong>stream_filter_register()</strong> は、<strong>fopen()</strong> や <strong>fread()</strong> などのファイルシステムの関数で利用可能な 登録され
  ているどの種類のストリームとも一緒に使うことのできる カスタムフィルタを登録します。

<comment>Param:</comment>
  <info>string</info>  <strong>$filter_name</strong>  登録するフィルタ名。
  <info>string</info>  <strong>$class</strong>        フィルタを実装するには、まず、<class>php_user_filter</class> を継承したクラスのメンバ関数を
                        実装しなくてはなりません。 <return>PHP</return> は、書き込みまたは読み出し操作を カスタムフィ
                        ルタの付加されたストリームに対して行う際に、まず データをそのフィルタに(そし
                        て、付加されている他のすべてのフィルタにも) 渡し、指示どおりストリームのデー
                        タが変更されるようにします。 メソッドの実装は、<class>php_user_filter</class> の説明の通り
                        にしなければなりません。 さもないと、定義されていない動作をします。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。
        
        <strong>stream_filter_register()</strong> は、 指定された <strong>$filter_name</strong> がすでに定義されている場合、 <info>false</info> を
        返します。

<comment>See Also:</comment>
   * <strong>stream_wrapper_register()</strong>
   * <strong>stream_filter_append()</strong>
   * <strong>stream_filter_prepend()</strong>


id: stream_filter_remove
type: function
doc:
<comment>Description:</comment>
  ストリームからフィルタを取り除く
  
  事前に <strong>stream_filter_prepend()</strong> あるいは <strong>stream_filter_append()</strong> でストリームに追加した フィルタを削
  除します。フィルタの内部バッファに残っているデータは 削除前にフラッシュされ、次のフィルタに渡され
  ます。

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream_filter</strong>  削除するストリームフィルタ。

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

<comment>See Also:</comment>
   * <strong>stream_filter_register()</strong>
   * <strong>stream_filter_append()</strong>
   * <strong>stream_filter_prepend()</strong>


id: stream_get_contents
type: function
doc:
<comment>Description:</comment>
  残りのストリームを文字列に読み込む
  
  <strong>file_get_contents()</strong> と似ていますが、 <strong>stream_get_contents()</strong> は既にオープンしている ストリームリソー
  スに対して操作を行います。そして、指定した <strong>$offset</strong> から始まる最大 <strong>$length</strong> バイトのデータを取得して
  文字列に 保存します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  ストリームリソース（例: <strong>fopen()</strong> の返す値）。
  <info>int|null</info>  <strong>$length</strong>  読み込む最大バイト数。デフォルトは <info>null</info> （バッファの残りのデータをすべて読み込
                     む）。
  <info>int</info>       <strong>$offset</strong>  読み込みを開始する前に移動する位置。負の数を指定した場合は移動が発生せず、 現在
                     位置から読み込みを開始します。

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

<comment>See Also:</comment>
   * <strong>fgets()</strong>
   * <strong>fread()</strong>
   * <strong>fpassthru()</strong>


id: stream_get_filters
type: function
doc:
<comment>Description:</comment>
  登録されているフィルタのリストを取得する
  
  実行中のシステムに登録されているフィルタの一覧を取得します。

<comment>Return:</comment>
  <info>array</info>  使用可能なすべてのストリームフィルタの名前を含む配列を返します。

<comment>See Also:</comment>
   * <strong>stream_filter_register()</strong>
   * <strong>stream_get_wrappers()</strong>


id: stream_get_line
type: function
doc:
<comment>Description:</comment>
  指定されたデリミタの位置までのデータを一行分としてストリームから読み込む
  
  指定したハンドルから一行取得します。
  
  読み込みは、<strong>$length</strong> バイト読まれたか、 <strong>$ending</strong> で指定された空でない文字列がストリームに見つかった
  か (この文字列は返値に 含まれません)、あるいは EOF に達したとき、のうち一番最初に遭遇したところで
  停止します。
  
  この関数は <strong>fgets()</strong> とほとんど同一ですが、 \n や \r 、\r\n といった一般的な文字列以外を行末を示すデ
  リミタ として指定できる点で、またデリミタ自体を返値に 含まない 点で異なります。

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  有効なファイルハンドル。
  <info>int</info>       <strong>$length</strong>  ハンドルから読み込む最大バイト数。 負の値はサポートされていません。 ゼロ(<return>0</return>) を
                     指定すると、 ソケットのデフォルトのチャンクサイズ つまり、<return>8192</return> を使います。
  <info>string</info>    <strong>$ending</strong>  オプションのデリミタ文字列。

<comment>Return:</comment>
  <info>string|false</info>  最大 <strong>$length</strong> バイトの、 <strong>$stream</strong> で指定されたファイルから読み込んだデータを返します。
                失敗した場合に <info>false</info> を返します

<comment>See Also:</comment>
   * <strong>fread()</strong>
   * <strong>fgets()</strong>
   * <strong>fgetc()</strong>


id: stream_get_meta_data
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>pfsockopen()</strong>、<strong>stream_socket_client()</strong> で作成
                     されたいずれのものも指定できます。

<comment>Return:</comment>
  <info>array</info>  結果の配列は次のような項目を含みます。
         
         <return>timed_out</return> (bool) - 最後に <strong>fread()</strong> または <strong>fgets()</strong> でデータを待っている時にタイムアウトした場
         合 <info>true</info> を返します。
         
         <return>blocked</return> (bool) - ストリームがブロック I/O モードの場合に <info>true</info> となります。
         <strong>stream_set_blocking()</strong> を参照ください。
         
         <return>eof</return> (bool) - ストリームが EOF に 達した時 <info>true</info> となります。 ストリームがソケットベースの場
         合、このメンバーは、 たとえ <return>unread_bytes</return> が 0 でなくても <info>true</info> になる場合があることに注意し
         てください。 まだデータがあるかどうかを調べるには、このパラメータではなく、 <strong>feof()</strong> を使って
         ください。
         
         <return>unread_bytes</return> (int) - PHP の 内部バッファにあるデータのバイト数。
         
         スクリプト中でこの値を使用してはいけません。
         
         <return>stream_type</return> (string) - ストリームの下層にある実装を表すラベル
         
         <return>wrapper_type</return> (string) - ストリームを覆うプロトコルラッパーを表すラベル。 ラッパーについては
         を参照ください。
         
         <return>wrapper_data</return> (mixed) - ストリームに付随しているラッパーの固有のデータ。 ラッパーとその固有
         の情報については、 を参照ください。
         
         <return>mode</return> (string) - このストリームに要求される アクセスモード（fopen() リファレンスの表 1 を参
         照ください）。
         
         <return>seekable</return> (bool) - 現在のストリーム内で 移動が可能かどうか。
         
         <return>uri</return> (string) - このストリームに関連付けられた URI / ファイル名。
         
         <return>crypto</return> (array) - このストリームに関連付けられた TLS 接続のメタデータ (注意: リソースのスト
         リームが TLS を使っている場合にのみ含まれます)

<comment>See Also:</comment>
   * <strong>get_headers()</strong>
   * $http_response_header


id: stream_get_transports
type: function
doc:
<comment>Description:</comment>
  登録されたソケットのトランスポートの一覧を取得する
  
  スクリプトを走らせているシステムにおいて利用可能なソケットのトランスポートのリストを配列として返し
  ます。

<comment>Return:</comment>
  <info>array</info>  ソケットのトランスポート名の配列を返します。

<comment>See Also:</comment>
   * <strong>stream_get_filters()</strong>
   * <strong>stream_get_wrappers()</strong>


id: stream_get_wrappers
type: function
doc:
<comment>Description:</comment>
  登録されているストリームのラッパーのリストを取得する
  
  実行中のシステムで使用可能な、登録済みのストリームの一覧を取得します。

<comment>Return:</comment>
  <info>array</info>  スクリプトを走らせているシステム上で使うことのできるすべてのストリーム ラッパーの名前を配列
         の形で返します。

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


id: stream_is_local
type: function
doc:
<comment>Description:</comment>
  ローカルストリームかどうかを調べる
  
  ストリームあるいは URL が、ローカルのものであるかどうかを調べます。

<comment>Param:</comment>
  <info>resource|string</info>  <strong>$stream</strong>  調べたいストリームリソースあるいは URL。

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


id: stream_isatty
type: function
doc:
<comment>Description:</comment>
  ストリームがターミナル型のデバイスかを調べる
  
  <strong>$stream</strong> が、有効なターミナル型のデバイスを参照しているかを調べます。 この関数は、<strong>posix_isatty()</strong> よ
  りも移植性に優れたバージョンです。 なぜなら、この関数は Windows でも動作するからです。

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  

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


id: stream_notification_callback
type: function
doc:
<comment>Description:</comment>
  notification コンテキストパラメータ用のコールバック関数
  
  イベント発生時にコールされる <info>callable</info> 関数です。 notification context parameter が使用します。
  
  これは実際の関数では ありません。 コールバック関数がどうあるべきかというプロトタイプだけを示すもの
  です。

<comment>Param:</comment>
  <info>int</info>          <strong>$notification_code</strong>  <info>STREAM_NOTIFY_*</info> 通知定数のひとつ。
  <info>int</info>          <strong>$severity</strong>           <info>STREAM_NOTIFY_SEVERITY_*</info> 通知定数のひとつ。
  <info>string|null</info>  <strong>$message</strong>            イベントについて説明するメッセージが存在する場合に渡されます。
  <info>int</info>          <strong>$message_code</strong>       イベントについて説明するコードが存在する場合に渡されます。
                                   
                                   この値の意味は、使用するラッパーによって異なります。
  <info>int</info>          <strong>$bytes_transferred</strong>  利用可能な場合は <strong>$bytes_transferred</strong> の値が格納されます。
  <info>int</info>          <strong>$bytes_max</strong>          利用可能な場合は <strong>$bytes_max</strong> の値が格納されます。

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

<comment>See Also:</comment>
   * 


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


id: stream_resolve_include_path
type: function
doc:
<comment>Description:</comment>
  インクルードパスに対してファイル名を解決する
    
  
  インクルードパスに対して <strong>$filename</strong> を解決します。 <strong>fopen()</strong>/<strong>include()</strong> と同じルールに従います。

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  解決するファイル名。

<comment>Return:</comment>
  <info>string|false</info>  解決したファイル名を含む文字列を返します。失敗した場合に <info>false</info> を返します。


id: stream_select
type: function
doc:
<comment>Description:</comment>
  select() システムコールと同等の操作を、
     ストリームの配列に対して seconds と microseconds で指定されたタイムアウト時間をもって行う
  
  <strong>stream_select()</strong> はストリームの配列を受け取ると、 それらの状態が変化するまで待ちます。機能として
  は、ストリームに対して 働くという点以外では <strong>socket_select()</strong> と同一です。

<comment>Param:</comment>
  <info>array|null</info>  <strong>$read</strong>          <strong>$read</strong> 配列に列挙されたストリームに対しては、 何らかのデータがそのスト
                             リーム内で読み出せる状態にあるかどうか 監視が行われます (より正確にいえ
                             ば、ブロックしないで読み出せる状態かどうか - 特にストリームが EOF に達
                             したかどうか、です。このとき、 <strong>fread()</strong> は長さ 0 の文字列を返します)。
  <info>array|null</info>  <strong>$write</strong>         <strong>$write</strong> 配列に列挙されたストリームに対しては、 ブロックしないで書き込み
                             ができるかどうかの監視が行われます。
  <info>array|null</info>  <strong>$except</strong>        <strong>$except</strong> 配列に列挙されたストリームに対しては、 重大な例外（"帯域外の"）
                             データが発生したかどうかの監視が行われます。
                             
                             <strong>stream_select()</strong> の終了時には、 どのストリームの状態が実際に変化したのか
                             が分かるよう、 配列 <strong>$read</strong>、<strong>$write</strong> および <strong>$except</strong> に変更が加えられます。
                             但し、配列のキーは保存されます。
  <info>int|null</info>    <strong>$seconds</strong>       <strong>$seconds</strong> と <strong>$microseconds</strong> は、一体となって、timeout パラメータを表現し
                             ます。 <strong>$seconds</strong> は秒数を指定し、一方 <strong>$microseconds</strong> はマイクロ秒数を指定
                             します。 timeout は、<strong>stream_select()</strong> の実行から戻るまでの時間の上限で
                             す。 <strong>$seconds</strong> および <strong>$microseconds</strong> の両方に <return>0</return> を指定すると
                             <strong>stream_select()</strong> はデータを待たずに一瞬で戻ります。 これは現在のストリー
                             ムの状態を示します。
                             
                             <strong>$seconds</strong> が <info>null</info> (タイムアウトなし) の場合、 <strong>stream_select()</strong> はブロック
                             しつづけ、調べている ストリームのひとつでイベントが発生する（あるいはシ
                             グナルがシステム コールを中断する）まで終了しません。
                             
                             タイムアウト値に <return>0</return> を指定すると、ストリームの 状態を即時に取得すること
                             が可能です。しかし、ループ内でタイムアウト <return>0</return> を指定するのは良い考えでは
                             ありません。 そうすると大量の CPU 時間を消費してしまいます。
                             
                             タイムアウト値を数秒にするとかなりましになります。しかし、どうしても 他
                             のコードを同時に実行させながらチェックをする必要がある場合には、 少なく
                             とも <return>200000</return> マイクロ秒以上のタイムアウトを 設定するようにしましょう。こ
                             れであなたのスクリプトの CPU 使用量を 抑えることができます。
                             
                             タイムアウト値は、あくまでも経過時間の最大値であることを覚えておきま
                             しょう。 <strong>stream_select()</strong> は、指定したストリームが使用可能に なるとすぐ
                             に結果を返します。
  <info>int|null</info>    <strong>$microseconds</strong>  <strong>$seconds</strong> の説明を参照ください。

<comment>Return:</comment>
  <info>int|false</info>  成功した場合 <strong>stream_select()</strong> は、変更された 配列に何個のストリームリソースが格納された
             かを示す数を返します。 もしタイムアウトの時間内に何も規定された事象が起こらなかった場合
             は 0 になることもあります。エラーの際は <info>false</info> を返し、警告を発生させます （システムコー
             ルが別のシグナルによって中断された場合などに起こりえます）。

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


id: stream_set_blocking
type: function
doc:
<comment>Description:</comment>
  ストリームのブロックモードを有効にする / 解除する
  
  <strong>$stream</strong> のモードをブロックあるいは非ブロックに設定します。
  
  この関数は、非ブロックモードをサポートするすべてのストリーム (現在は、通常のファイルストリームとソ
  ケットストリームのみ) において利用可能です。

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  ストリーム。
  <info>bool</info>      <strong>$enable</strong>  <strong>$enable</strong> が <info>false</info> の時、ストリームは 非ブロックモードに切り替えられ、<info>true</info> の場合
                     は、 ブロックモードに切り替えられます。このモードの違いは、 <strong>fgets()</strong> や <strong>fread()</strong>
                     といった、ストリームからデータを読む関数に影響します。 非ブロックモードにおいて
                     は <strong>fgets()</strong> を呼び出すと どんな場合でもただちに呼び出し元に戻りますが、ブロック
                     モードの場合では、 ストリームがデータを読み出せる状態になるまで待ちつづけます。

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

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


id: stream_set_chunk_size
type: function
doc:
<comment>Description:</comment>
  ストリームのチャンクサイズを設定する
  
  ストリームのチャンクサイズを設定します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  対象のストリーム。
  <info>int</info>       <strong>$size</strong>    設定したいチャンクサイズ。

<comment>Return:</comment>
  <info>int</info>  成功した場合に、変更前の設定値を返します。


id: stream_set_read_buffer
type: function
doc:
<comment>Description:</comment>
  指定したストリームのファイル読み込みバッファリングを有効にする
  
  読み込みバッファを設定します。<strong>stream_set_write_buffer()</strong> と似ていますが、読み込み操作を対象としてい
  ます。

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  ファイルポインタ。
  <info>int</info>       <strong>$size</strong>    バッファのバイト数。 <strong>$size</strong> が 0 であれば、読み込み操作はバッファされなくなりま
                     す。 これにより、<strong>fread()</strong> による読み込み操作が完了するまでは 他のプロセスが同じ
                     入力ストリームから読み込み操作をできないことが保証されます。

<comment>Return:</comment>
  <info>int</info>  成功時に 0 を、要求通りに設定できなかった場合はそれ以外の値を返します。

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


id: stream_set_timeout
type: function
doc:
<comment>Description:</comment>
  ストリームにタイムアウトを設定する
  
  <strong>$stream</strong> にタイムアウトの値を設定します。 この値は、<strong>$seconds</strong> と <strong>$microseconds</strong> の和で表されます。
  
  ストリームがタイムアウトとなった場合は、 <strong>stream_get_meta_data()</strong> が返す配列のキー 'timed_out' の値
  が <info>true</info> に設定されます。エラーや警告が発生していなくても同様になります。

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>        対象となるストリーム。
  <info>int</info>       <strong>$seconds</strong>       設定したいタイムアウトの秒数部分。
  <info>int</info>       <strong>$microseconds</strong>  設定したいタイムアウトのマイクロ秒数部分。

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

<comment>See Also:</comment>
   * <strong>fsockopen()</strong>
   * <strong>fopen()</strong>


id: stream_set_write_buffer
type: function
doc:
<comment>Description:</comment>
  指定されたストリームのファイル書き込みバッファリングを有効にする
  
  <strong>$stream</strong> で指定されたファイルポインタに <strong>$size</strong> で表されたバイト数分だけ出力バッファを設定します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  ファイルポインタ。
  <info>int</info>       <strong>$size</strong>    バッファのバイト数。 <strong>$size</strong> が 0 であれば、書き込み操作はバッファされなくなりま
                     す。 これにより、<strong>fwrite()</strong> による書き込み操作が、他の プロセスが同じ出力ストリー
                     ムに対して何らかの書き込み操作を行う前に 完了することが保証されます。

<comment>Return:</comment>
  <info>int</info>  成功時に 0 を、要求通りに設定できなかった場合はそれ以外の値を返します。

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


id: stream_socket_accept
type: function
doc:
<comment>Description:</comment>
  stream_socket_server で作られたソケットの接続を受け入れる
  
  以前に <strong>stream_socket_server()</strong> によって作られたソケットの接続を受け入れます。

<comment>Param:</comment>
  <info>resource</info>    <strong>$socket</strong>     接続元からの接続を受け付けるサーバーソケット。
  <info>float|null</info>  <strong>$timeout</strong>    デフォルトのソケット接続待ちタイムアウトを上書きします。 時間は秒単位で指
                          定します。 デフォルトでは、 default_socket_timeout の値が使われます。
  <info>string</info>      <strong>$peer_name</strong>  接続元のクライアントの名前 (アドレス) が含まれていて、 選択したトランス
                          ポートで有効であった場合に、それを設定します。
                          
                          後で <strong>stream_socket_get_name()</strong> を使用して指定することもできます。

<comment>Return:</comment>
  <info>resource|false</info>  受け付けたソケット接続へのストリームを返します。失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>stream_socket_server()</strong>
   * <strong>stream_socket_get_name()</strong>
   * <strong>stream_set_blocking()</strong>
   * <strong>stream_set_timeout()</strong>
   * <strong>fgets()</strong>
   * <strong>fgetss()</strong>
   * <strong>fwrite()</strong>
   * <strong>fclose()</strong>
   * <strong>feof()</strong>
   * 


id: stream_socket_client
type: function
doc:
<comment>Description:</comment>
  インターネットドメインまたは Unix ドメインのソケット接続を開く
  
  <strong>$address</strong> で指定された接続先との、 ストリームまたはデータグラム接続を確立します。 作成されるソケッ
  トのタイプは、<return>[トランスポート]://[ターゲット]</return> という形式の URL フォーマットによって指定された トラ
  ンスポートによって決定されます。 TCP や UDP といったインターネットドメインのソケット (AF_INET) に
  は、<strong>$address</strong> パラメータの <return>ターゲット</return> の部分は、ホスト名または IP アドレスと、 それに続くコロンで区
  切られたポート番号から構成されていなければなりません。 Unix ドメインのソケットの場合は、<return>ターゲット</return>
  の部分は、ファイルシステムにおけるソケットのファイルを指定しなくては いけません。
  
  ストリームはデフォルトではブロックモードで開かれますが、 <strong>stream_set_blocking()</strong> を使うことで非ブ
  ロックモードに 変更することができます。

<comment>Param:</comment>
  <info>string</info>         <strong>$address</strong>        接続するソケットのアドレス。
  <info>int</info>            <strong>$error_code</strong>     接続に失敗した場合にシステムレベルのエラー番号が設定されます。
  <info>string</info>         <strong>$error_message</strong>  接続に失敗した場合にシステムレベルのエラーメッセージが設定されま
                                 す。
  <info>float|null</info>     <strong>$timeout</strong>        <return>connect()</return> システムコールがタイムアウトとなるまでの秒数。 デフォルト
                                 では、 default_socket_timeout の値を使います。  このパラメータが適
                                 用されるのは、非同期通信を試みていない場合のみです。   ソケット上の
                                 データの読み書きに関してタイムアウトを設定する必要がある場合は、
                                 <strong>stream_set_timeout()</strong> を使ってください。 <strong>stream_socket_client()</strong> に渡
                                 される <strong>$timeout</strong> は、ソケットの接続時にのみ適用されます。
                                 
                                 このパラメータが適用されるのは、非同期通信を試みていない場合のみで
                                 す。
                                 
                                 ソケット上のデータの読み書きに関してタイムアウトを設定する必要があ
                                 る場合は、 <strong>stream_set_timeout()</strong> を使ってください。
                                 <strong>stream_socket_client()</strong> に渡される <strong>$timeout</strong> は、ソケットの接続時にの
                                 み適用されます。
  <info>int</info>            <strong>$flags</strong>          接続設定フラグの任意の組み合わせを指定できるビットフィールドです。
                                 現在、接続設定フラグとして選択できる値は、
                                 <info>STREAM_CLIENT_CONNECT</info>（デフォルト）、 <info>STREAM_CLIENT_ASYNC_CONNECT</info>
                                 と  <info>STREAM_CLIENT_PERSISTENT</info> のみです。
  <info>resource|null</info>  <strong>$context</strong>        <strong>stream_context_create()</strong> で作成した有効なコンテキストリソース。

<comment>Return:</comment>
  <info>resource|false</info>  成功した場合に、 <strong>fgets()</strong>, <strong>fgetss()</strong>, <strong>fwrite()</strong>, <strong>fclose()</strong>, <strong>feof()</strong> といった、ファイル
                  関数と共に使うことのできるストリームリソースを返します。

<comment>See Also:</comment>
   * <strong>stream_socket_server()</strong>
   * <strong>stream_set_blocking()</strong>
   * <strong>stream_set_timeout()</strong>
   * <strong>stream_select()</strong>
   * <strong>fgets()</strong>
   * <strong>fgetss()</strong>
   * <strong>fwrite()</strong>
   * <strong>fclose()</strong>
   * <strong>feof()</strong>
   * 


id: stream_socket_enable_crypto
type: function
doc:
<comment>Description:</comment>
  接続済みのソケットについて暗号化の on/off を切り替える
  
  ストリームの暗号化を有効あるいは無効にします。
  
  暗号化設定が確立されると、それ以降は <strong>$enable</strong> パラメータに <info>true</info> あるいは <info>false</info> を指定することで暗号
  化の on/off を動的に切り替えられます。

<comment>Param:</comment>
  <info>resource</info>       <strong>$stream</strong>          ストリームリソース。
  <info>bool</info>           <strong>$enable</strong>          ストリームの暗号化を有効にするか無効にするか。
  <info>int|null</info>       <strong>$crypto_method</strong>   ストリームの暗号化の設定。以下の方法が使用できます。
                                  <info>STREAM_CRYPTO_METHOD_SSLv2_CLIENT</info><info>STREAM_CRYPTO_METHOD_SSLv3_CLIENT</info><info>STREAM_CRYPTO_METHOD_SSLv23_CLIENT</info><info>STREAM_CRYPTO_METHOD_ANY_CLIENT</info><info>STREAM_CRYPTO_METHOD_TLS_CLIENT</info><info>STREAM_CRYPTO_METHOD_TLSv1_0_CLIENT</info><info>STREAM_CRYPTO_METHOD_TLSv1_1_CLIENT</info><info>STREAM_CRYPTO_METHOD_TLSv1_2_CLIENT</info><info>STREAM_CRYPTO_METHOD_TLSv1_3_CLIENT</info>
                                  (PHP 7.4.0 以
                                  降)<info>STREAM_CRYPTO_METHOD_SSLv2_SERVER</info><info>STREAM_CRYPTO_METHOD_SSLv3_SERVER</info><info>STREAM_CRYPTO_METHOD_SSLv23_SERVER</info><info>STREAM_CRYPTO_METHOD_ANY_SERVER</info><info>STREAM_CRYPTO_METHOD_TLS_SERVER</info><info>STREAM_CRYPTO_METHOD_TLSv1_0_SERVER</info><info>STREAM_CRYPTO_METHOD_TLSv1_1_SERVER</info><info>STREAM_CRYPTO_METHOD_TLSv1_2_SERVER</info><info>STREAM_CRYPTO_METHOD_TLSv1_3_SERVER</info>
                                  (PHP 7.4.0 以降)
                                  
                                  <info>STREAM_CRYPTO_METHOD_SSLv2_CLIENT</info>
                                  
                                  <info>STREAM_CRYPTO_METHOD_SSLv3_CLIENT</info>
                                  
                                  <info>STREAM_CRYPTO_METHOD_SSLv23_CLIENT</info>
                                  
                                  <info>STREAM_CRYPTO_METHOD_ANY_CLIENT</info>
                                  
                                  <info>STREAM_CRYPTO_METHOD_TLS_CLIENT</info>
                                  
                                  <info>STREAM_CRYPTO_METHOD_TLSv1_0_CLIENT</info>
                                  
                                  <info>STREAM_CRYPTO_METHOD_TLSv1_1_CLIENT</info>
                                  
                                  <info>STREAM_CRYPTO_METHOD_TLSv1_2_CLIENT</info>
                                  
                                  <info>STREAM_CRYPTO_METHOD_TLSv1_3_CLIENT</info> (PHP 7.4.0 以降)
                                  
                                  <info>STREAM_CRYPTO_METHOD_SSLv2_SERVER</info>
                                  
                                  <info>STREAM_CRYPTO_METHOD_SSLv3_SERVER</info>
                                  
                                  <info>STREAM_CRYPTO_METHOD_SSLv23_SERVER</info>
                                  
                                  <info>STREAM_CRYPTO_METHOD_ANY_SERVER</info>
                                  
                                  <info>STREAM_CRYPTO_METHOD_TLS_SERVER</info>
                                  
                                  <info>STREAM_CRYPTO_METHOD_TLSv1_0_SERVER</info>
                                  
                                  <info>STREAM_CRYPTO_METHOD_TLSv1_1_SERVER</info>
                                  
                                  <info>STREAM_CRYPTO_METHOD_TLSv1_2_SERVER</info>
                                  
                                  <info>STREAM_CRYPTO_METHOD_TLSv1_3_SERVER</info> (PHP 7.4.0 以降)
                                  
                                  省略した場合は、ストリームの SSL コンテキストのオプション
                                  <return>crypto_method</return> を利用します。
  <info>resource|null</info>  <strong>$session_stream</strong>  ストリームで <strong>$session_stream</strong> からの設定を送信します。

<comment>Return:</comment>
  <info>int|bool</info>  成功した場合に <info>true</info>、ネゴシエーションに失敗した場合に <info>false</info>、 十分なデータがないために再
            試行が必要な場合（非ブロックモード時のみ） に <return>0</return> を返します。

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


id: stream_socket_get_name
type: function
doc:
<comment>Description:</comment>
  ローカルまたはリモートのソケットの名前を取得する
  
  指定したソケット接続のローカルまたはリモートでの名前を返します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$socket</strong>  名前を取得したいソケット。
  <info>bool</info>      <strong>$remote</strong>  <info>true</info> に設定するとリモートでのソケットの名前を返し、 <info>false</info> に設定するとローカル
                     でのソケットの名前を返します。

<comment>Return:</comment>
  <info>string|false</info>  ソケットの名前を返します。 失敗した場合に <info>false</info> を返します

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


id: stream_socket_pair
type: function
doc:
<comment>Description:</comment>
  接続された、区別できないソケットストリームの組を作成する
    
  
  <strong>stream_socket_pair()</strong> は、互いに接続されており区別できない ソケットストリームの組を作成します。この
  関数は、一般に IPC （Inter-Process Communication: プロセス間通信）で使用します。

<comment>Param:</comment>
  <info>int</info>  <strong>$domain</strong>    使用するプロトコルファミリー。<info>STREAM_PF_INET</info>、 <info>STREAM_PF_INET6</info> あるいは
                  <info>STREAM_PF_UNIX</info>
  <info>int</info>  <strong>$type</strong>      使用する接続の型。 <info>STREAM_SOCK_DGRAM</info>、 <info>STREAM_SOCK_RAW</info>、 <info>STREAM_SOCK_RDM</info>、
                  <info>STREAM_SOCK_SEQPACKET</info> あるいは <info>STREAM_SOCK_STREAM</info>
  <info>int</info>  <strong>$protocol</strong>  使用するプロトコル。<info>STREAM_IPPROTO_ICMP</info>、 <info>STREAM_IPPROTO_IP</info>、 <info>STREAM_IPPROTO_RAW</info>、
                  <info>STREAM_IPPROTO_TCP</info> あるいは <info>STREAM_IPPROTO_UDP</info>

<comment>Return:</comment>
  <info>array|false</info>  成功した場合に 2 つのソケットリソースの配列、失敗した場合に <info>false</info> を返します。


id: stream_socket_recvfrom
type: function
doc:
<comment>Description:</comment>
  接続されているかどうかにかかわらず、ソケットからのデータを受信する
  
  <strong>stream_socket_recvfrom()</strong> は、 リモートソケットから最大 <strong>$length</strong> バイトのデータを 受け取ります。

<comment>Param:</comment>
  <info>resource</info>     <strong>$socket</strong>   リモートソケット。
  <info>int</info>          <strong>$length</strong>   <strong>$socket</strong> から受信するバイト数。
  <info>int</info>          <strong>$flags</strong>    <strong>$flags</strong> は以下の値の組み合わせです。 <strong>$flags</strong> でとりうる値<info>STREAM_OOB</info> OOB
                         (<return>out-of-band</return>) データを処理します。 <info>STREAM_PEEK</info> ソケットからデータを取得しま
                         すが、バッファを消費しません。 <strong>fread()</strong> あるいは <strong>stream_socket_recvfrom()</strong> を
                         続けてコールした 際には、同じデータが読み込まれます。
  <info>string|null</info>  <strong>$address</strong>  <strong>$address</strong> が指定された場合、 そこにはリモートソケットのアドレスが保存されま
                         す。

<comment>Return:</comment>
  <info>string|false</info>  読み込んだデータを文字列で返します。 失敗した場合に <info>false</info> を返します

<comment>See Also:</comment>
   * <strong>stream_socket_sendto()</strong>
   * <strong>stream_socket_client()</strong>
   * <strong>stream_socket_server()</strong>


id: stream_socket_sendto
type: function
doc:
<comment>Description:</comment>
  接続されているかどうかにかかわらず、ソケットにデータを送信する
  
  <strong>$data</strong> で指定したデータを <strong>$socket</strong> で指定したソケットに送信します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$socket</strong>   <strong>$data</strong> を送信するソケット。
  <info>string</info>    <strong>$data</strong>     送りたいデータ。
  <info>int</info>       <strong>$flags</strong>    <strong>$flags</strong> は以下の値の組み合わせです。 <strong>$flags</strong> でとりうる値<info>STREAM_OOB</info> OOB
                      (out-of-band) データを処理します。
  <info>string</info>    <strong>$address</strong>  <strong>$address</strong> で別のアドレスが指定されていない限り、 ソケットストリームが作成された
                      際のアドレスを使用します。
                      
                      指定する場合は、ドットで 4 つに区切った形式 (あるいは IPv6 形式) でなければな
                      りません。

<comment>Return:</comment>
  <info>int|false</info>  結果コードを整数値で返します。 失敗した場合に <info>false</info> を返します

<comment>See Also:</comment>
   * <strong>stream_socket_recvfrom()</strong>
   * <strong>stream_socket_client()</strong>
   * <strong>stream_socket_server()</strong>


id: stream_socket_server
type: function
doc:
<comment>Description:</comment>
  インターネットドメインまたは Unix ドメインのサーバーソケットを作成する
  
  <strong>$address</strong> で指定された接続ポイントに、 ストリームまたはデータグラムソケットによる接続を作成します。
  
  この関数は、ソケットのみを作成します。接続待ちの状態に入るには、 <strong>stream_socket_accept()</strong> 関数を使い
  ます。

<comment>Param:</comment>
  <info>string</info>         <strong>$address</strong>        作成されるソケットのタイプは、<return>[トランスポート]://[ターゲット]</return> とい
                                 う形式の URL フォーマットによって指定された トランスポートによって
                                 決定されます:
                                 
                                 TCP や UDP といったインターネットドメインのソケット (<info>AF_INET</info>) に
                                 は、<strong>$remote_socket</strong> パラメータの <return>ターゲット</return> の部分は、ホスト名または
                                 IP アドレスと、 それに続くコロンで区切られたポート番号から構成され
                                 ていなければなりません。 Unix ドメインのソケットの場合は、<strong>$ターゲッ
                                 ト</strong> の部分は、ファイルシステムにおけるソケットのファイルを指定しなく
                                 ては いけません。
                                 
                                 システムの種類によって、Unix ドメインのソケットが利用できない場合が
                                 あります。 利用できるトランスポートの種類は、
                                 <strong>stream_get_transports()</strong> によって知ることができます。 組み込みのトラ
                                 ンスポートのリストは、 を参照ください。
  <info>int</info>            <strong>$error_code</strong>     オプションの <strong>$error_code</strong> と <strong>$error_message</strong> パラメータが存在するとき
                                 は、そこにシステムレベルの <return>socket()</return>、<return>bind()</return> および <return>listen()</return> のコー
                                 ルにおいて発生した 実際のシステムレベルのエラーを返します。 もし、
                                 <strong>$error_code</strong> に返された値が <return>0</return> で、かつ <info>false</info> が返された場合、<return>bind()</return>
                                 コールを行う前にエラーが発生したことを示しており、これは多くの場合
                                 ソケットの初期化に失敗したことを示しています。 <strong>$error_code</strong> と
                                 <strong>$error_message</strong> パラメータは常に参照渡しとなることに留意してくださ
                                 い。
  <info>string</info>         <strong>$error_message</strong>  <strong>$error_code</strong> の説明を参照ください。
  <info>int</info>            <strong>$flags</strong>          ソケット作成フラグの任意の組み合わせを指定できるビットフィールドで
                                 す。
                                 
                                 UDP ソケットに対しては、<info>STREAM_SERVER_BIND</info> を <strong>$flags</strong> パラメータとし
                                 て使用する必要があります。
  <info>resource|null</info>  <strong>$context</strong>        

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

<comment>See Also:</comment>
   * <strong>stream_socket_client()</strong>
   * <strong>stream_set_blocking()</strong>
   * <strong>stream_set_timeout()</strong>
   * <strong>fgets()</strong>
   * <strong>fgetss()</strong>
   * <strong>fwrite()</strong>
   * <strong>fclose()</strong>
   * <strong>feof()</strong>
   * Curl 拡張モジュール


id: stream_socket_shutdown
type: function
doc:
<comment>Description:</comment>
  全二重接続を終了する
  
  全二重接続を (一時的あるいはそうでなく) 終了します。
  
  関連するバッファの内容は、空になるかもしれないしならないかもしれません。

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  オープンしているストリーム (たとえば <strong>stream_socket_client()</strong> でオープンしたもの
                     など)。
  <info>int</info>       <strong>$mode</strong>    以下の定数のいずれか。<info>STREAM_SHUT_RD</info> (それ以降の受信を無効にする)、
                     <info>STREAM_SHUT_WR</info> (それ以降の送信を無効にする) あるいは <info>STREAM_SHUT_RDWR</info> (それ以降
                     の送受信を無効にする)。

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

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


id: stream_supports_lock
type: function
doc:
<comment>Description:</comment>
  ストリームがロックをサポートしているかどうかを調べる
  
  <strong>flock()</strong> によるロックをそのストリームがサポートしているかどうかを調べます。

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  調べたいストリーム。

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

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


id: stream_wrapper_register
type: function
doc:
<comment>Description:</comment>
  PHP のクラスとして実装された URL ラッパーを登録する
  
  自分で作ったプロトコルハンドラとストリームを実装し、それを <strong>fopen()</strong> や <strong>fread()</strong> といったファイルシス
  テムの関数と利用することを可能にします。

<comment>Param:</comment>
  <info>string</info>  <strong>$protocol</strong>  登録したいラッパー名。 有効なプロトコル名には、 アルファベットと数値、ドット
                     (.)、 プラス文字(+)、 ハイフン(-) のみが含まれています。
  <info>string</info>  <strong>$class</strong>     <strong>$protocol</strong> を実装したクラス名。
  <info>int</info>     <strong>$flags</strong>     <strong>$protocol</strong> が URL プロトコルである場合は <info>STREAM_IS_URL</info> を設定しなければなりませ
                     ん。 デフォルトは 0 で、ローカルストリームを意味します。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。
        
        <strong>stream_wrapper_register()</strong> は、 <strong>$protocol</strong> というハンドラが既にある場合、 <info>false</info> を返します。

<comment>See Also:</comment>
   *  プロトタイプクラス
   * 
   * <strong>stream_wrapper_unregister()</strong>
   * <strong>stream_wrapper_restore()</strong>
   * <strong>stream_get_wrappers()</strong>


id: stream_wrapper_restore
type: function
doc:
<comment>Description:</comment>
  事前に登録を解除された組み込みラッパーを復元する
  
  <strong>stream_wrapper_unregister()</strong> で事前に登録を解除した 組み込みラッパーを復元します。

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

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


id: stream_wrapper_unregister
type: function
doc:
<comment>Description:</comment>
  URL ラッパーの登録を解除する
  
  すでに定義されているストリームラッパーを無効にします。ラッパーが無効になった後は、
  <strong>stream_wrapper_register()</strong> を使用してユーザー定義の ラッパーで上書きしたり <strong>stream_wrapper_restore()</strong>
  で再度使用可能にしたりすることが可能となります。

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

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


id: strftime
type: function
doc:
<comment>Description:</comment>
  ロケールの設定に基づいてローカルな日付・時間をフォーマットする
    
  
  ローカルの時刻・日付を、ロケール設定にもとづいてフォーマットします。 月および曜日の名前、およびそ
  の他の言語依存の文字列は、 <strong>setlocale()</strong> で設定された現在のロケールを尊重して表示されます。
  
  使用する C ライブラリで、すべての変換指定子がサポートされているとは限りません。 そのような場合、該
  当する変換指定子は PHP の <strong>strftime()</strong> ではサポートされません。 また、全てのプラットフォームが負のタ
  イムスタンプをサポートしているわけではないため、 Unix Epoch (1970 年 1 月 1 日）以前の日付を扱えな
  いかもしれません。 つまり、Windows や一部の Linux ディストリビューション、そしてその他のごく一部の
  オペレーティングシステム上では %e、%T、%R および %D (あるいはこれ以外も) が <return>Jan 1, 1970</return> より前の日
  付について動作しないということです。 Windwos システム上でサポートされる変換指定子の概要について
  は、 MSDN に掲載されています。 Instead use the IntlDateFormatter::format method.

<comment>Param:</comment>
  <info>string</info>    <strong>$format</strong>     次の変換指定子が <strong>$format</strong> パラメータ用の文字列として認識されます<strong>$format</strong>説明戻
                        り値の例日------<return>%a</return>短縮された曜日の名前<return>Sun</return> から <return>Sat</return><return>%A</return>完全な曜日の名前<return>Sunday</return>
                        から <return>Saturday</return><return>%d</return>10 進数で 2 桁の日付 (先頭のゼロつき)<return>01</return> から <return>31</return><return>%e</return> 1 桁の場合
                        は先頭にスペースをいれた日付。 Windows ではそのようには実装されていません。
                        詳細は以下を参照ください。 <return> 1</return> から <return>31</return><return>%j</return>3 桁で先頭にゼロを含む年間での日付<return>001</return>
                        から <return>366</return><return>%u</return>ISO-8601 数値表現であらわした曜日<return>1</return> (月曜日) から <return>7</return> (日曜日)<return>%w</return>数値
                        表現であらわした曜日<return>0</return> (日曜日) から <return>6</return> (土曜日)週------<return>%U</return>指定した年の週番号。
                        最初の日曜日を第一週の開始日とする<return>13</return> (年間の第 13 週の場合)<return>%V</return>ISO-8601:1988
                        で規定された、指定した年の週番号。 週の開始日は月曜日で、第 1 週は少なくとも
                        4 日はあることになる<return>01</return> から <return>53</return> (53 は年をまたがる週になります)<return>%W</return>その年の週番
                        号の数値表現。最初の月曜日を最初の週の初日とする<return>46</return> (46 番目の週の場合。開始
                        日は月曜日)月------<return>%b</return>現在のロケールに基づく短縮された月の名前<return>Jan</return> から
                        <return>Dec</return><return>%B</return>現在のロケールに基づく完全な月の名前<return>January</return> から <return>December</return><return>%h</return>現在のロケー
                        ルに基づく短縮された月の名前 (%b のエイリアス)<return>Jan</return> から <return>Dec</return><return>%m</return>2 桁であらわした
                        月<return>01</return> (1 月) から <return>12</return> (12 月)年------<return>%C</return>2 桁であらわした世紀 (年を 100 で割り、
                        整数に丸めたもの)20 正規の場合は <return>19</return><return>%g</return>2 桁であらわした年。ISO-8601:1988 標準
                        形式 (%V を参照)2009 年 1 月 6 日の場合は <return>09</return><return>%G</return>%g の 4 桁完全版2009 年 1 月 3
                        日の場合は <return>2009</return><return>%y</return>2 桁であらわした年2009 年の場合は <return>09</return>、1979 年の場合は <return>79</return><return>%Y</return>4
                        桁であらわした年<return>2038</return>時------<return>%H</return>2 桁であらわした 24 時間制の時間<return>00</return> から <return>23</return><return>%k</return>24
                        時間制の時間で、1 桁の場合は先頭にスペースをつけたもの<return> 0</return> から <return>23</return><return>%I</return>2 桁であら
                        わした 12 時間制の時間<return>01</return> から <return>12</return><return>%l (小文字の 'L')</return>12 時間制の時間で、1 桁の場
                        合は先頭にスペースをつけたもの<return> 1</return> から <return>12</return><return>%M</return>2 桁であらわした分<return>00</return> から <return>59</return><return>%p</return>指定
                        した時刻に応じた大文字の 'AM' あるいは 'PM' 00:31 なら <return>AM</return>、22:23 なら <return>PM</return>。
                        正確な結果はオペレーティングシステムに依存します。 (<return>a.m.</return> のような) 小文字や
                        ドット付きの結果を返すこともあります。 <return>%P</return>指定した時刻に応じた小文字の 'am'
                        あるいは 'pm' 00:31 なら <return>am</return>、22:23 なら <return>pm</return>。 全てのオペレーティングシステム
                        でサポートされているとは限りません。 <return>%r</return>"%I:%M:%S %p" と同じ21:34:17 なら
                        <return>09:34:17 PM</return><return>%R</return>"%H:%M" と同じ12:35 AM なら <return>00:35</return>、4:44 PM なら <return>16:44</return><return>%S</return>2 桁であ
                        らわした秒<return>00</return> から <return>59</return><return>%T</return>"%H:%M:%S" と同じ09:34:17 PM なら <return>21:34:17</return><return>%X</return>ロケールに
                        基づいた時刻の表現。日付は含まない<return>03:59:16</return> あるいは <return>15:59:16</return><return>%z</return>タイムゾーンオ
                        フセット。Windows では違う実装になっています。詳細は後述します。東海岸時刻な
                        ら <return>-0500</return><return>%Z</return>タイムゾーンの略称。Windows では違う実装になっています。詳細は後述
                        します。東海岸時刻なら <return>EST</return>タイムスタンプ------<return>%c</return>現在のロケールにもとづく日付
                        と時間の表現2009 年 2 月 5 日 午前 12:45:10 なら <return>Tue Feb  5 00:45:10
                        2009</return><return>%D</return>"%m/%d/%y" と同じ2009 年 2 月 5 日なら <return>02/05/09</return><return>%F</return>"%Y-%m-%d" と同じ
                        (データベースのタイムスタンプとして一般的)2009 年 2 月 5 日なら
                        <return>2009-02-05</return><return>%s</return>Unix エポックからのタイムスタンプ (<strong>time()</strong> 関数と同じ)1979 年 9
                        月 10 日午前 08:40:00 なら <return>305815200</return><return>%x</return>現在のロケールにもとづく日付の表現 (時
                        間は除く)2009 年 2 月 5 日なら <return>02/05/09</return>その他------<return>%n</return>改行文字 ("\n")---<return>%t</return>タ
                        ブ文字 ("\t")---<return>%%</return>パーセント文字 ("%")---
                        
                        ISO-9889:1999 に反して、Sun Solaris は日曜日を 1 としています。 そのため、<return>%u</return>
                        はこのマニュアルの説明どおりに機能しないかもしれません。
                        
                        Windows 限定:
                        
                        Windows 上では <return>%e</return> に対応していません。 この値が欲しければ、代わりに <return>%#d</return> を使
                        いましょう。 クロスプラットフォーム対応の関数を書く方法をこの後の例で示しま
                        す。
                        
                        <return>%z</return> と <return>%Z</return> は、どちらもタイムゾーン名を返します。オフセットや略称は返しませ
                        ん。
                        
                        macOS と musl 限定:<return>%P</return> 修飾子は macOS 版の実装ではサポートされていません。
  <info>int|null</info>  <strong>$timestamp</strong>  オプションのパラメータ <strong>$timestamp</strong> は、
                        <info>int</info> 型の Unix タイムスタンプです。
                        <strong>$timestamp</strong> が指定されなかったり、<info>null</info> だった場合のデフォルト値は、
                        現在の時刻です。言い換えると、デフォルトは
                        <strong>time()</strong> の返り値となります。

<comment>Return:</comment>
  <info>string|false</info>  指定した <strong>$timestamp</strong> または timestamp が指定されていない場合に現在のローカル時間を用
                いて、 指定したフォーマット文字列に基づき文字列をフォーマットして返します。 月および
                曜日の名前、およびその他の言語依存の文字列は、 <strong>setlocale()</strong> で設定された現在のロケー
                ルを尊重して表示されます。
                 この関数は、<strong>$format</strong> が空だったり、 サポートされていない変換指定子が含まれていたり、
                返される文字列の長さが <return>4095</return> より大きい場合は、<info>false</info> を返します。

<comment>See Also:</comment>
   * IntlDateFormatter::format
   * DateTimeInterface::format
   * オンラインの strftime() 書式デザインツール
   * <strong>setlocale()</strong>
   * <strong>mktime()</strong>
   * <strong>strptime()</strong>
   * <strong>gmstrftime()</strong>
   * Open Group による <strong>strftime()</strong> の定義


id: strip_tags
type: function
doc:
<comment>Description:</comment>
  文字列から HTML および PHP タグを取り除く
  
  この関数は、指定した文字列 (<strong>$string</strong>) から全ての NULL バイトと HTML および PHP タグを取り除きます。
  この関数は、<strong>fgetss()</strong> 関数と同じタグ除去アルゴリズムを使用します。

<comment>Param:</comment>
  <info>string</info>             <strong>$string</strong>        入力文字列。
  <info>array|string|null</info>  <strong>$allowed_tags</strong>  オプションの2番目の引数により、取り除かないタグを指定できます。
                                    これは <info>string</info> で指定できますが、PHP 7.4.0 以降では <info>array</info> でも指
                                    定可能です。 この引数のフォーマットについては、以下の例を参照く
                                    ださい。
                                    
                                    HTML コメントや PHP タグも削除されるようになりました。この機能は
                                    ハードコードされており、 <strong>$allowed_tags</strong> で変更することはできませ
                                    ん。
                                    
                                    <strong>$allowed_tags</strong> で使えるのは自己終了型でない XHTML タグだけです。
                                    自己終了型の XHTML タグは無視されます。たとえば、 <return>\<br&gt;</return> と <return>\<br/&gt;</return> の両方を許可したい場合は、以下のようにしなければいけません。

<comment>Return:</comment>
  <info>string</info>  タグを除去した文字列を返します。

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


id: stripcslashes
type: function
doc:
<comment>Description:</comment>
  addcslashes でクォートされた文字列をアンクォートする
  
  バックスラッシュを取り除いた文字列を返します。C言語と同様に <return>\n</return>, <return>\r</return> ..., 8進表現, 16進表現を認識し
  ます。

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  元に戻したい文字列。

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

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


id: stripos
type: function
doc:
<comment>Description:</comment>
  大文字小文字を区別せずに文字列が最初に現れる位置を探す
  
  文字列 <strong>$haystack</strong> の中で <strong>$needle</strong> が最初に現れる位置を探します。
  
  <strong>strpos()</strong> と異なり、<strong>stripos()</strong> は大文字小文字を区別しません。

<comment>Param:</comment>
  <info>string</info>  <strong>$haystack</strong>  検索対象の文字列。
  <info>string</info>  <strong>$needle</strong>    検索する文字列。
                     
                     PHP 8.0.0 より前のバージョンでは、<strong>$needle</strong> が文字列でない場合、 数値に変換され、
                     文字の通常の値として扱われていました。 この振る舞いは PHP 7.3.0 以降では推奨さ
                     れないので、 この機能を使用しないことを強く推奨します。 意図した動作に依存する
                     場合、 <strong>$needle</strong> を string に明示的にキャストするか、 明示的に <strong>chr()</strong> 関数を呼び出
                     すべきでしょう。
  <info>int</info>     <strong>$offset</strong>    指定すると、文字列内での検索開始位置がその位置になります。 負の数を指定すると、
                     文字列の末尾からこの数だけ戻った場所から検索を開始します。

<comment>Return:</comment>
  <info>int|false</info>  needle が見つかった位置を、 <strong>$haystack</strong> 文字列の先頭 (offset の値とは無関係) からの相対位
             置で返します。 文字列の開始位置は 0 であり、1 ではないことに注意しましょう。
             
             needle が見つからない場合は <info>false</info> を返します。
             
             この関数は論理値
             <info>false</info> を返す可能性がありますが、<info>false</info> として評価される値を返す可能性もあります。
             詳細については 論理値の
             セクションを参照してください。この関数の返り値を調べるには
             ===演算子 を
             使用してください。

<comment>See Also:</comment>
   * <strong>mb_stripos()</strong>
   * <strong>str_contains()</strong>
   * <strong>str_ends_with()</strong>
   * <strong>str_starts_with()</strong>
   * <strong>strpos()</strong>
   * <strong>strrpos()</strong>
   * <strong>strripos()</strong>
   * <strong>stristr()</strong>
   * <strong>substr()</strong>
   * <strong>str_ireplace()</strong>


id: stripslashes
type: function
doc:
<comment>Description:</comment>
  クォートされた文字列のクォート部分を取り除く
  
  クォートされた文字列を元に戻します。
  
  <strong>stripslashes()</strong> は、 (データベースのような)エスケープする必要がある 場所にデータをまだ挿入していな
  い場合に使うことができます。 例えば、単純に HTML フォームからのデータを直接出力するような場合で
  す。

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

<comment>Return:</comment>
  <info>string</info>  バックスラッシュが取り除かれた文字列を返します(<return>\' </return> が <return>'</return> になるなど)。 2 つ並んだバックス
          ラッシュ (<return>\\</return>) は 1 つのバックスラッシュ (<return>\</return>) になります。

<comment>See Also:</comment>
   * <strong>addslashes()</strong>
   * <strong>get_magic_quotes_gpc()</strong>


id: stristr
type: function
doc:
<comment>Description:</comment>
  大文字小文字を区別しない strstr
  
  <strong>$haystack</strong> において <strong>$needle</strong> が最初に見つかった位置を含めてそこから最後までを返します。

<comment>Param:</comment>
  <info>string</info>  <strong>$haystack</strong>       検索対象の文字列。
  <info>string</info>  <strong>$needle</strong>         検索する文字列。
                          
                          PHP 8.0.0 より前のバージョンでは、<strong>$needle</strong> が文字列でない場合、 数値に変換
                          され、文字の通常の値として扱われていました。 この振る舞いは PHP 7.3.0 以降
                          では推奨されないので、 この機能を使用しないことを強く推奨します。 意図した
                          動作に依存する場合、 <strong>$needle</strong> を string に明示的にキャストするか、 明示的に
                          <strong>chr()</strong> 関数を呼び出すべきでしょう。
  <info>bool</info>    <strong>$before_needle</strong>  <info>true</info> にすると、<strong>stristr()</strong> の戻り値は、<strong>$haystack</strong> の中で最初に <strong>$needle</strong> があら
                          われる箇所より前の部分となります (needle は含めません)。

<comment>Return:</comment>
  <info>string|false</info>  マッチした部分文字列を返します。<strong>$needle</strong> が見つからない場合は <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>strstr()</strong>
   * <strong>strrchr()</strong>
   * <strong>stripos()</strong>
   * <strong>strpbrk()</strong>
   * <strong>preg_match()</strong>


id: strlen
type: function
doc:
<comment>Description:</comment>
  文字列の長さを得る
  
  与えられた <strong>$string</strong> の長さを返します。

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  長さを調べる文字列。

<comment>Return:</comment>
  <info>int</info>  <strong>$string</strong> の長さをバイト単位で返します。

<comment>See Also:</comment>
   * <strong>count()</strong>
   * <strong>grapheme_strlen()</strong>
   * <strong>iconv_strlen()</strong>
   * <strong>mb_strlen()</strong>


id: strnatcasecmp
type: function
doc:
<comment>Description:</comment>
  "自然順"アルゴリズムにより大文字小文字を区別しない文字列比較を行う
  
  この関数は、人間が行うような手法でアルファベットまたは数字の 文字列の順序を比較するアルゴリズムを
  実装します。この関数の動作は、 <strong>strnatcmp()</strong> に似ていますが、 比較が大文字小文字を区別しない違いがあ
  ります。 詳細な情報については、Martin Pool の 自然順文字列比較 のページを参照ください。

<comment>Param:</comment>
  <info>string</info>  <strong>$string1</strong>  最初の文字列。
  <info>string</info>  <strong>$string2</strong>  次の文字列。

<comment>Return:</comment>
  <info>int</info>  他の文字列比較関数と同様に、この関数は、 <strong>$string1</strong>が<strong>$string2</strong> より小さい場合に <return>-1</return>、<strong>$string1</strong>が
       <strong>$string2</strong>より大きい場合に <return>1</return>、等しい場合に <return>0</return> を返します。

<comment>See Also:</comment>
   * <strong>preg_match()</strong>
   * <strong>strcmp()</strong>
   * <strong>strcasecmp()</strong>
   * <strong>substr()</strong>
   * <strong>stristr()</strong>
   * <strong>strncasecmp()</strong>
   * <strong>strncmp()</strong>
   * <strong>strstr()</strong>
   * <strong>setlocale()</strong>


id: strnatcmp
type: function
doc:
<comment>Description:</comment>
  "自然順"アルゴリズムにより文字列比較を行う
  
  この関数は、人間が行うような手法でアルファベットまたは数字の 文字列の順序を比較するアルゴリズムを
  実装します。この手法は、"自然順" と言われます。 この比較は、大文字小文字を区別することに注意してく
  ださい。

<comment>Param:</comment>
  <info>string</info>  <strong>$string1</strong>  最初の文字列。
  <info>string</info>  <strong>$string2</strong>  次の文字列。

<comment>Return:</comment>
  <info>int</info>  他の文字列比較関数と同様に、この関数は、 <strong>$string1</strong> が <strong>$string2</strong> より小さいに場合に <return>-1</return>、<strong>$string1</strong>
       が <strong>$string2</strong> より大きい場合に <return>1</return>、等しい場合に <return>0</return> を返します。

<comment>See Also:</comment>
   * <strong>preg_match()</strong>
   * <strong>strcasecmp()</strong>
   * <strong>substr()</strong>
   * <strong>stristr()</strong>
   * <strong>strcmp()</strong>
   * <strong>strncmp()</strong>
   * <strong>strncasecmp()</strong>
   * <strong>strnatcasecmp()</strong>
   * <strong>strstr()</strong>
   * <strong>natsort()</strong>
   * <strong>natcasesort()</strong>


id: strncasecmp
type: function
doc:
<comment>Description:</comment>
  バイナリセーフで大文字小文字を区別しない文字列比較を、最初の n 文字について行う
  
  この関数は、<strong>strcasecmp()</strong> に似ていますが、 各文字列から比較する文字数(の上限)(<strong>$len</strong>) を指定できると
  いう違いがあります。どちらかの文字列が <strong>$len</strong>より短い場合、その文字列の長さが比較時に使用されます。

<comment>Param:</comment>
  <info>string</info>  <strong>$string1</strong>  最初の文字列。
  <info>string</info>  <strong>$string2</strong>  次の文字列。
  <info>int</info>     <strong>$length</strong>   比較する文字列の長さ。

<comment>Return:</comment>
  <info>int</info>  <strong>$string1</strong> が <strong>$string2</strong> より短い場合に <return>-1</return> を返し、<strong>$string1</strong> が <strong>$string2</strong> より大きい場合に <return>1</return>、等し
       い場合に <return>0</return> を返します。

<comment>See Also:</comment>
   * <strong>strncmp()</strong>
   * <strong>preg_match()</strong>
   * <strong>substr_compare()</strong>
   * <strong>strcasecmp()</strong>
   * <strong>stristr()</strong>
   * <strong>substr()</strong>


id: strncmp
type: function
doc:
<comment>Description:</comment>
  最初の n 文字についてバイナリセーフな文字列比較を行う
  
  この関数は <strong>strcmp()</strong> に似ていますが、 各文字列から(最大)文字数(<strong>$len</strong>) を比較に使用するところが異なり
  ます。
  
  比較は大文字小文字を区別することに注意してください。

<comment>Param:</comment>
  <info>string</info>  <strong>$string1</strong>  最初の文字列。
  <info>string</info>  <strong>$string2</strong>  次の文字列。
  <info>int</info>     <strong>$length</strong>   比較する文字数。

<comment>Return:</comment>
  <info>int</info>  <strong>$string1</strong> が <strong>$string2</strong> より小さい場合に <return>-1</return>、<strong>$string1</strong> が <strong>$string2</strong> より大きい場合に <return>1</return>、等しい場合
       に <return>0</return> を返します。

<comment>See Also:</comment>
   * <strong>strncasecmp()</strong>
   * <strong>preg_match()</strong>
   * <strong>substr_compare()</strong>
   * <strong>strcmp()</strong>
   * <strong>strstr()</strong>
   * <strong>substr()</strong>


id: strpbrk
type: function
doc:
<comment>Description:</comment>
  文字列の中から任意の文字を探す
  
  <strong>strpbrk()</strong> は、文字列 <strong>$string</strong> から <strong>$characters</strong> を探します。

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>      <strong>$characters</strong> を探す文字列。
  <info>string</info>  <strong>$characters</strong>  このパラメータは大文字小文字を区別します。

<comment>Return:</comment>
  <info>string|false</info>  見つかった文字から始まる文字列、あるいは見つからなかった場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>strpos()</strong>
   * <strong>strstr()</strong>
   * <strong>preg_match()</strong>


id: strpos
type: function
doc:
<comment>Description:</comment>
  文字列内の部分文字列が最初に現れる場所を見つける
  
  文字列 <strong>$haystack</strong> の中で、 <strong>$needle</strong> が最初に現れる位置を探します。

<comment>Param:</comment>
  <info>string</info>  <strong>$haystack</strong>  検索対象の文字列。
  <info>string</info>  <strong>$needle</strong>    検索する文字列。
                     
                     PHP 8.0.0 より前のバージョンでは、<strong>$needle</strong> が文字列でない場合、 数値に変換され、
                     文字の通常の値として扱われていました。 この振る舞いは PHP 7.3.0 以降では推奨さ
                     れないので、 この機能を使用しないことを強く推奨します。 意図した動作に依存する
                     場合、 <strong>$needle</strong> を string に明示的にキャストするか、 明示的に <strong>chr()</strong> 関数を呼び出
                     すべきでしょう。
  <info>int</info>     <strong>$offset</strong>    指定すると、文字列内での検索開始位置がその位置になります。 負の数を指定すると、
                     文字列の末尾からこの数だけ戻った場所から検索を開始します。

<comment>Return:</comment>
  <info>int|false</info>  needle が見つかった位置を、 <strong>$haystack</strong> 文字列の先頭 (offset の値とは無関係) からの相対位
             置で返します。 文字列の開始位置は 0 であり、1 ではないことに注意しましょう。
             
             needle が見つからない場合は <info>false</info> を返します。
             
             この関数は論理値
             <info>false</info> を返す可能性がありますが、<info>false</info> として評価される値を返す可能性もあります。
             詳細については 論理値の
             セクションを参照してください。この関数の返り値を調べるには
             ===演算子 を
             使用してください。

<comment>See Also:</comment>
   * <strong>stripos()</strong>
   * <strong>str_contains()</strong>
   * <strong>str_ends_with()</strong>
   * <strong>str_starts_with()</strong>
   * <strong>strrpos()</strong>
   * <strong>strripos()</strong>
   * <strong>strstr()</strong>
   * <strong>strpbrk()</strong>
   * <strong>substr()</strong>
   * <strong>preg_match()</strong>


id: strptime
type: function
doc:
<comment>Description:</comment>
  strftime が生成した日付/時刻をパースする
      
  
  <strong>strptime()</strong> は <strong>$timestamp</strong> をパースした結果を配列で返します。エラー時には <info>false</info> を返します。
  
  月名や曜日、そしてその他の言語依存な文字列は <strong>setlocale()</strong> (<info>LC_TIME</info>) で設定された現在の ロケールを考
  慮して返します。

<comment>Param:</comment>
  <info>string</info>  <strong>$timestamp</strong>  パースする文字列（例: <strong>strftime()</strong> の戻り値）。
  <info>string</info>  <strong>$format</strong>     <strong>$timestamp</strong> で使用されているフォーマット （例: <strong>strftime()</strong> で使用されていたもの
                      と同じ）。 <strong>strftime()</strong> で使えるオプションの中には、 <strong>strptime()</strong> では何の影響を及
                      ぼさないものがあることに注意しましょう。 実際にサポートする範囲がどのようにな
                      るのかは、 使っている OS と C ライブラリに依存します。
                      
                      フォーマットオプションについての詳細は <strong>strftime()</strong> のページを参照ください。

<comment>Return:</comment>
  <info>array|false</info>  成功した場合は配列、失敗した場合に <info>false</info> を返します。
               
               配列で返されるパラメータパラメータ説明<return>"tm_sec"</return>分未満の秒数 (0-61)<return>"tm_min"</return>時間未満の分
               数 (0-59)<return>"tm_hour"</return>0 時以降の時間数 (0-23)<return>"tm_mday"</return>月内の日数 (1-31)<return>"tm_mon"</return>1 月から数
               えた月数 (0-11)<return>"tm_year"</return>1900 年以降の年<return>"tm_wday"</return>日曜日からの日数 (0-6)<return>"tm_yday"</return>1 月 1
               日からの日数 (0-365)<return>"unparsed"</return><strong>$timestamp</strong> の中で、指定された <strong>$format</strong> で判断できなかっ
               た部分

<comment>See Also:</comment>
   * IntlDateFormatter::parse
   * DateTime::createFromFormat
   * <strong>checkdate()</strong>
   * <strong>strftime()</strong>
   * <strong>date_parse_from_format()</strong>


id: strrchr
type: function
doc:
<comment>Description:</comment>
  文字列中に文字が最後に現れる場所を取得する
  
  この関数は、文字列 <strong>$haystack</strong> の中で <strong>$needle</strong> が最後に現れた位置から、 <strong>$haystack</strong> の終わりまでを返し
  ます。

<comment>Param:</comment>
  <info>string</info>  <strong>$haystack</strong>       検索対象の文字列。
  <info>string</info>  <strong>$needle</strong>         <strong>$needle</strong> がひとつ以上の文字を含んでいる場合は、 最初のもののみが使われま
                          す。この動作は、 <strong>strstr()</strong> とは異なります。
                          
                          PHP 8.0.0 より前のバージョンでは、<strong>$needle</strong> が文字列でない場合、 数値に変換
                          され、文字の通常の値として扱われていました。 この振る舞いは PHP 7.3.0 以降
                          では推奨されないので、 この機能を使用しないことを強く推奨します。 意図した
                          動作に依存する場合、 <strong>$needle</strong> を string に明示的にキャストするか、 明示的に
                          <strong>chr()</strong> 関数を呼び出すべきでしょう。
  <info>bool</info>    <strong>$before_needle</strong>  <info>true</info> にすると、 <strong>$haystack</strong> の中で 最後に <strong>$needle</strong> が現れる箇所より前の部分を
                          返します (needle は含めません)。

<comment>Return:</comment>
  <info>string|false</info>  この関数は、部分文字列を返します。 <strong>$needle</strong> が見つからない場合は <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>strstr()</strong>
   * <strong>strrpos()</strong>


id: strrev
type: function
doc:
<comment>Description:</comment>
  文字列を逆順にする
  
  <strong>$string</strong> を逆順にして返します。

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  逆順にしたい文字列。

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


id: strripos
type: function
doc:
<comment>Description:</comment>
  文字列中で、特定の(大文字小文字を区別しない)文字列が最後に現れた位置を探す
  
  文字列 <strong>$haystack</strong> の中で、 <strong>$needle</strong> が最後に現れる位置を探します。
  
  <strong>strrpos()</strong> と異なり、<strong>strripos()</strong> は大文字小文字を区別しません。

<comment>Param:</comment>
  <info>string</info>  <strong>$haystack</strong>  検索対象の文字列。
  <info>string</info>  <strong>$needle</strong>    検索する文字列。
                     
                     PHP 8.0.0 より前のバージョンでは、<strong>$needle</strong> が文字列でない場合、 数値に変換され、
                     文字の通常の値として扱われていました。 この振る舞いは PHP 7.3.0 以降では推奨さ
                     れないので、 この機能を使用しないことを強く推奨します。 意図した動作に依存する
                     場合、 <strong>$needle</strong> を string に明示的にキャストするか、 明示的に <strong>chr()</strong> 関数を呼び出
                     すべきでしょう。
  <info>int</info>     <strong>$offset</strong>    ゼロまたは正の値の場合、 <strong>$haystack</strong> の  最初の <strong>$offset</strong> バイトをスキップし、 左か
                     ら右に検索が行われます。
                     
                     負の値の場合、 <strong>$haystack</strong> の  最後の <strong>$offset</strong> バイトをスキップし、 右から左に検索
                     が行われ、 <strong>$needle</strong> が最初に現れる場所を探します。  この方が、最後の <strong>$offset</strong> バ
                     イトより前にある、 最後の <strong>$needle</strong>  を効率的に探せます。
                     
                     この方が、最後の <strong>$offset</strong> バイトより前にある、 最後の <strong>$needle</strong>  を効率的に探せま
                     す。

<comment>Return:</comment>
  <info>int|false</info>  needle が見つかった位置を、 <strong>$haystack</strong> 文字列の先頭 (offset の値とは無関係) からの相対位
             置で返します。  文字列の開始位置は 0 であり、1 ではありません。
             
             文字列の開始位置は 0 であり、1 ではありません。
             
             needle が見つからない場合は <info>false</info> を返します。
             
             この関数は論理値
             <info>false</info> を返す可能性がありますが、<info>false</info> として評価される値を返す可能性もあります。
             詳細については 論理値の
             セクションを参照してください。この関数の返り値を調べるには
             ===演算子 を
             使用してください。

<comment>See Also:</comment>
   * <strong>strpos()</strong>
   * <strong>stripos()</strong>
   * <strong>strrpos()</strong>
   * <strong>strrchr()</strong>
   * <strong>stristr()</strong>
   * <strong>substr()</strong>


id: strrpos
type: function
doc:
<comment>Description:</comment>
  文字列中に、ある部分文字列が最後に現れる場所を探す
  
  文字列 <strong>$haystack</strong> の中で、 <strong>$needle</strong> が最後に現れる位置を探します。

<comment>Param:</comment>
  <info>string</info>  <strong>$haystack</strong>  検索対象の文字列。
  <info>string</info>  <strong>$needle</strong>    検索する文字列。
                     
                     PHP 8.0.0 より前のバージョンでは、<strong>$needle</strong> が文字列でない場合、 数値に変換され、
                     文字の通常の値として扱われていました。 この振る舞いは PHP 7.3.0 以降では推奨さ
                     れないので、 この機能を使用しないことを強く推奨します。 意図した動作に依存する
                     場合、 <strong>$needle</strong> を string に明示的にキャストするか、 明示的に <strong>chr()</strong> 関数を呼び出
                     すべきでしょう。
  <info>int</info>     <strong>$offset</strong>    ゼロまたは正の値の場合、 <strong>$haystack</strong> の  最初の <strong>$offset</strong> バイトをスキップし、 左か
                     ら右に検索が行われます。
                     
                     負の値の場合、 <strong>$haystack</strong> の  最初ではなく、最後から <strong>$offset</strong> バイトの箇所より検
                     索を開始します。 検索は右から左に行われ、 検索を開始した箇所から <strong>$needle</strong> が最初
                     に現れる場所を探します。  この方が、最後の <strong>$offset</strong> バイト、またはそれより前にあ
                     る 最後の <strong>$needle</strong>  を効率的に探せます。
                     
                     この方が、最後の <strong>$offset</strong> バイト、またはそれより前にある 最後の <strong>$needle</strong>  を効率
                     的に探せます。

<comment>Return:</comment>
  <info>int|false</info>  needle が見つかった位置を、 <strong>$haystack</strong> 文字列の先頭 (offset の値とは無関係) からの相対位
             置で返します。  文字列の開始位置は 0 であり、1 ではありません。
             
             文字列の開始位置は 0 であり、1 ではありません。
             
             needle が見つからない場合は <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>strpos()</strong>
   * <strong>stripos()</strong>
   * <strong>strripos()</strong>
   * <strong>strrchr()</strong>
   * <strong>substr()</strong>


id: strspn
type: function
doc:
<comment>Description:</comment>
  指定したマスク内に含まれる文字からなる文字列の最初のセグメントの長さを探す
    
  
  <strong>$string</strong> の中で、 <strong>$characters</strong> 内の文字だけを含む最初の部分の長さを返します。
  
  <strong>$offset</strong> と <strong>$length</strong> を省略した場合は、<strong>$string</strong> 全体を調べます。 指定した場合は、
  <return>strspn(substr($string, $offset, $length), $characters)</return> をコールするのと同じ動きになります。 (詳細
  は  を参照ください)
  
  たとえば、 
  ]]> このコードは、$var に <return>2</return> を代入します。これは、 <strong>$string</strong> の中で "1234567890" 内の文字だけで構成
  される 最初の部分が "42" であるためです。

<comment>Param:</comment>
  <info>string</info>    <strong>$string</strong>      調べたい文字列。
  <info>string</info>    <strong>$characters</strong>  許可する文字の一覧。
  <info>int</info>       <strong>$offset</strong>      <strong>$string</strong> の中で調べ始める位置。
                         
                         <strong>$offset</strong> に非負の値を指定すると、 <strong>strspn()</strong> は <strong>$string</strong> の <strong>$offset</strong> 番目の位置
                         から調査を始めます。 たとえば、文字列 '<return>abcdef</return>' において <return>0</return> 番目の位置にある
                         文字は '<return>a</return>' で <return>2</return> 番目の位置にある文字は '<return>c</return>' のようになります。
                         
                         <strong>$offset</strong> に負の値を指定すると、 <strong>strspn()</strong> は <strong>$string</strong> の最後から <strong>$offset</strong> 番目
                         の位置から調査を始めます。
  <info>int|null</info>  <strong>$length</strong>      <strong>$string</strong> 内で調べる部分の長さ。
                         
                         <strong>$length</strong> に非負の値を指定すると、 <strong>$string</strong> の開始位置から <strong>$length</strong> 文字分の範
                         囲を調査します。
                         
                         <strong>$length</strong> に負の値を指定すると、 <strong>$string</strong> の調査範囲は 開始位置から始まって
                         <strong>$string</strong> の最後から <strong>$length</strong> だけさかのぼったところまでとなります。

<comment>Return:</comment>
  <info>int</info>  <strong>$string</strong> の中で、全て <strong>$characters</strong> の中の文字からなる最初のセグメントの長さを返します。
       
       <strong>$offset</strong> パラメータを設定した場合は、返される長さはその位置からのものとなります。 <strong>$string</strong> の先
       頭からの長さではありません。

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


id: strstr
type: function
doc:
<comment>Description:</comment>
  文字列が最初に現れる位置を見つける
  
  <strong>$haystack</strong> の中で <strong>$needle</strong> が最初に現れる場所を含めてそこから文字列の終わりまでを返します。
  
  この関数は大文字小文字を区別することに注意してください。 大文字小文字を区別しない検索を行う場合
  は、<strong>stristr()</strong> を使用してください。
  
  もし特定の <strong>$haystack</strong> に <strong>$needle</strong> があるかどうかを調べるだけの場合、 より高速でメモリ消費も少ない
  <strong>strpos()</strong> を代わりに使用してください。

<comment>Param:</comment>
  <info>string</info>  <strong>$haystack</strong>       入力文字列。
  <info>string</info>  <strong>$needle</strong>         検索する文字列。
                          
                          PHP 8.0.0 より前のバージョンでは、<strong>$needle</strong> が文字列でない場合、 数値に変換
                          され、文字の通常の値として扱われていました。 この振る舞いは PHP 7.3.0 以降
                          では推奨されないので、 この機能を使用しないことを強く推奨します。 意図した
                          動作に依存する場合、 <strong>$needle</strong> を string に明示的にキャストするか、 明示的に
                          <strong>chr()</strong> 関数を呼び出すべきでしょう。
  <info>bool</info>    <strong>$before_needle</strong>  <info>true</info> にすると、<strong>strstr()</strong> の戻り値は、<strong>$haystack</strong> の中で最初に <strong>$needle</strong> があら
                          われる箇所より前の部分となります (needle は含めません)。

<comment>Return:</comment>
  <info>string|false</info>  部分文字列を返します。 <strong>$needle</strong> が見つからない場合は <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>stristr()</strong>
   * <strong>strrchr()</strong>
   * <strong>strpos()</strong>
   * <strong>strpbrk()</strong>
   * <strong>preg_match()</strong>


id: strtok
type: function
doc:
<comment>Description:</comment>
  文字列をトークンに分割する
  
  代替のシグネチャ (名前付き引数をサポートしていません):
  
  <strong>strtok()</strong> は文字列 (<strong>$string</strong>) を 何らかの文字 <strong>$token</strong> によって区切られている小さな文字列 (トークン)
  に分割します。 "This is an example string" のような文字列がある場合、 空白文字を <strong>$token</strong> に指定する
  ことでこの文字列を個々の単語に分割することができます。
  
  strtok は最初のコールの時のみ <strong>$string</strong> 引数を使用することに注意してください。 strtok は、文字列のど
  こにいるのかの情報を保持しているため、 2回目以降のコールでは <strong>$token</strong> のみが必要です。 最初からやり
  なおす場合や新しい文字列をトークンに分割する場合、 初期化するために再度 <strong>$string</strong> 引数を指定して
  strtok をコールします。 文字列は、<strong>$token</strong> の文字のどれかが見つかった場合はトークンに分割されます。
  
  この関数は、<strong>explode()</strong> 関数に慣れている人が期待する動きとは、 ちょっと異なる振る舞いをします。 ま
  ず、<strong>$token</strong> の ふたつ以上の連続する文字が文字列に含まれていた場合、 その連続する文字は、単一の区切
  り文字として扱われます。 また、文字列の最初と最後に存在する <strong>$token</strong> は無視されてしまいます。 たとえ
  ば、文字列が <return>";aaa;;bbb;"</return> の場合、 <strong>$token</strong> に <return>";"</return> を指定して <strong>strtok()</strong> を 連続してコールすると、
  "aaa" と "bbb" を返し、最後に <info>false</info> を返します。 結果として、文字列はふたつにしか分割されません。
  一方で <return>explode(";", $string)</return> は 5つの要素からなる配列を返します。

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  より小さい文字列 (トークン) に分割する文字列。
  <info>string</info>  <strong>$token</strong>   <strong>$string</strong> を分割する際に使用する区切り文字。

<comment>Return:</comment>
  <info>string|false</info>  トークンを文字列で返します。 トークンがない場合は、<info>false</info> を返します。

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


id: strtolower
type: function
doc:
<comment>Description:</comment>
  文字列を小文字にする
  
  <strong>$string</strong> の、ASCII のアルファベット部分をすべて小文字にして返します｡
  
  <return>"A"</return> (0x41) から <return>"Z"</return> (0x5a) までの範囲のバイト列は、それぞれのバイト値に 32 を加えることによって 対
  応する小文字に変換されます。
  
  マルチバイトの UTF-8 文字は無視されるので、 UTF-8 でエンコードされた文字列中にある ASCII 文字を変
  換する際も、 このやり方が使えます。 マルチバイトの ASCII でない文字を変換するには、
  <strong>mb_strtolower()</strong> を使います。

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

<comment>Return:</comment>
  <info>string</info>  小文字に変換した文字列を返します。

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


id: strtotime
type: function
doc:
<comment>Description:</comment>
  英文形式の日付を Unix タイムスタンプに変換する
    
  
  この関数は英語の書式での日付を含む文字列が指定されることを期待しており、 その書式を Unix タイムス
  タンプ (1970 年 1 月 1 日 00:00:00 UTC からの経過秒数) に変換しようとします。 <strong>$baseTimestamp</strong> が指
  定された場合は、そのタイムスタンプを基準とした相対時刻のタイムスタンプに変換します。
  <strong>$baseTimestamp</strong> が指定されていない場合は、現在時刻を基準とした相対時刻のタイムスタンプに変換しま
  す。 パースされる日付を含む文字列の書式は、 サポートする日付と時刻の書式 で定義されており、考慮す
  べき微妙な点がいくつかあります。 サポートする日付と時刻の書式について、読んでおくことを強く推奨し
  ます。
  
  この関数が返す Unixタイムスタンプ は、タイムゾーンの情報を含んでいません。 日付/時刻の情報を含めて
  計算するには、 より多くの機能がある <class>DateTimeImmutable</class> を使うべきです。
  
  この関数の各パラメータでは、パラメータ内でタイムゾーンを指定しない限りはデフォルトのタイムゾーンを
  使います。 意図的にそうする場合は別として、パラメータごとにタイムゾーンを変えてしまったりしないよ
  うに気をつけましょう。 デフォルトのタイムゾーンを定義する方法については
  <strong>date_default_timezone_get()</strong> を参照ください。

<comment>Param:</comment>
  <info>string</info>    <strong>$datetime</strong>       日付/時刻 文字列。有効な書式については 日付と時刻の書式 で説明していま
                            す。
  <info>int|null</info>  <strong>$baseTimestamp</strong>  返される値を計算するために使用されるタイムスタンプ。

<comment>Return:</comment>
  <info>int|false</info>  成功時はタイムスタンプ、そうでなければ <info>false</info> を返します。

<comment>See Also:</comment>
   * <class>DateTimeImmutable</class>
   * DateTimeImmutable::createFromFormat
   * 日付と時刻の書式
   * <strong>checkdate()</strong>
   * <strong>strptime()</strong>


id: strtoupper
type: function
doc:
<comment>Description:</comment>
  文字列を大文字にする
  
  <strong>$string</strong> の、ASCII のアルファベット部分をすべて大文字にして返します｡
  
  <return>"a"</return> (0x61) から <return>"z"</return> (0x7a) までの範囲のバイト列は、それぞれのバイト値から 32 を引くことによって 対
  応する大文字に変換されます。
  
  マルチバイトの UTF-8 文字は無視されるので、 UTF-8 でエンコードされた文字列中にある ASCII 文字を変
  換する際も、 このやり方が使えます。 マルチバイトの ASCII でない文字を変換するには、
  <strong>mb_strtoupper()</strong> を使います。

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

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

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


id: strtr
type: function
doc:
<comment>Description:</comment>
  文字の変換あるいは部分文字列の置換を行う
  
  代替のシグネチャ (名前付き引数をサポートしていません):
  
  引数を三つ渡した場合、この関数は <strong>$string</strong> のコピーを返します。その際に、文字列中に <strong>$from</strong> の各文字
  (シングルバイト) があれば <strong>$to</strong> の対応する文字に変換します。つまり、すべての <return>$from[$n]</return> が <return>$to[$n]</return> に
  置換されることになります。ここで <return>$n</return> は、どちらの引数でも共通に有効なオフセットです。
  
  <strong>$from</strong> と <strong>$to</strong> の長さが異なる場合、長い方の余分な文字は無視されます。 返される文字列の長さは、もとの
  <strong>$string</strong> と同じになります。
  
  引数を二つだけ渡す場合は、二番目の引数を <return>array('from' =&gt; 'to', ...)</return> 形式の配列にしなければなり
  ません。 返される値は文字列で、もとの文字列中にある配列のキーと同じ部分を対応する値で置換したもの
  となります。 一番長いキーから順に調べます。一度部分文字列の置換を行うと、 置換後の文字列がさらに置
  換の対象となることはありません。
  
  この場合は、配列のキーと値は任意の長さにすることができますが、キーを空にすることだけはできません。
  さらに、返される文字列の長さはもとの <strong>$string</strong> とは異なる可能性があります。 しかし、この関数が最も効
  率的に働くのは、すべてのキーが同じ長さである場合です。

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>         変換する文字列。
  <info>string</info>  <strong>$from</strong>           <strong>$to</strong> に変換される文字列。
  <info>string</info>  <strong>$to</strong>             <strong>$from</strong> を置換する文字列。
  <info>array</info>   <strong>$replace_pairs</strong>  <strong>$replace_pairs</strong> パラメータを <strong>$to</strong> や <strong>$from</strong> のかわりに使用することができま
                          す。この場合は <return>array('from' =&gt; 'to', ...)</return> 形式の配列となります。
                          
                          <strong>$replace_pairs</strong> の中に空文字列 (<return>""</return>) のキーがある場合は、その要素は無視され
                          ます。 PHP 8.0.0 以降では、この場合 <info>E_WARNING</info> が発生します。

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

<comment>See Also:</comment>
   * <strong>str_replace()</strong>
   * <strong>preg_replace()</strong>


id: strval
type: function
doc:
<comment>Description:</comment>
  変数の文字列としての値を取得する
  
  <strong>$value</strong> の <info>string</info> としての値を 返します。文字列への変換の詳細については、<info>string</info> の ドキュメントを参
  照ください。
  
  この関数は、戻り値の書式設定は行いません。数値を文字列形式で書式設定したい場合は <strong>sprintf()</strong> あるい
  は <strong>number_format()</strong> を参照ください。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  文字列に変換したい変数。
                 
                 <strong>$value</strong> には、任意のスカラー型、<info>null</info> および __toString() メソッドを実装した <info>object</info>
                 を使うこともできます。 <strong>strval()</strong> は配列に対して使うことはできず、 __toString() メ
                 ソッドを実装していないオブジェクトに対しても使うことはできません。

<comment>Return:</comment>
  <info>string</info>  <strong>$value</strong> の文字列値を返します。

<comment>See Also:</comment>
   * <strong>boolval()</strong>
   * <strong>floatval()</strong>
   * <strong>intval()</strong>
   * <strong>settype()</strong>
   * <strong>sprintf()</strong>
   * <strong>number_format()</strong>
   * 型の相互変換
   * __toString()


id: substr
type: function
doc:
<comment>Description:</comment>
  文字列の一部分を返す
  
  文字列 <strong>$string</strong> の、<strong>$offset</strong> で指定された位置から <strong>$length</strong> バイト分の文字列を返します。

<comment>Param:</comment>
  <info>string</info>    <strong>$string</strong>  入力文字列。
  <info>int</info>       <strong>$offset</strong>  <strong>$offset</strong> が正の場合、返される文字列は、 <strong>$string</strong> の 0 から数えて <strong>$offset</strong>番目から
                     始まる文字列となります。 例えば、文字列'<return>abcdef</return>'において位置 <return>0</return>にある文字は、
                     '<return>a</return>'であり、 位置<return>2</return>には'<return>c</return>'があります。
                     
                     <strong>$offset</strong> が負の場合、返される文字列は、 <strong>$string</strong>の後ろから数えて <strong>$offset</strong>番目から
                     始まる文字列となります。
                     
                     <strong>$string</strong> の長さが <strong>$offset</strong> 文字より短い場合は、 空の文字列が返されます。
                     
                     負の <strong>$offset</strong> の使用
                     ]]>
  <info>int|null</info>  <strong>$length</strong>  <strong>$length</strong> が指定され、かつ正である場合、 返される文字列は <strong>$offset</strong> (<strong>$string</strong> の長さ
                     に依存します) から数えて<strong>$length</strong>文字数分となります。
                     
                     <strong>$length</strong> が指定され、かつ負である場合、 <strong>$string</strong> の終端からその文字数分の文字が省
                     略されます (<strong>$offset</strong> が負の場合は、 開始位置を算出したあとで)。 もし <strong>$offset</strong> が
                     切り出し位置を超える場合、 空の文字列が返されます。
                     
                     <strong>$length</strong> が指定され、かつ <return>0</return> であれば、空の文字が返されます。
                     
                     <strong>$length</strong> を省略した場合、または <info>null</info> の場合は、 <strong>$offset</strong> の位置から文字列の最後ま
                     での部分文字列を返します。

<comment>Return:</comment>
  <info>string</info>  <strong>$string</strong> の一部を返すか、空文字列を返します。

<comment>See Also:</comment>
   * <strong>strrchr()</strong>
   * <strong>substr_replace()</strong>
   * <strong>preg_match()</strong>
   * <strong>trim()</strong>
   * <strong>mb_substr()</strong>
   * <strong>wordwrap()</strong>
   * 文字列への文字単位のアクセスと修正


id: substr_compare
type: function
doc:
<comment>Description:</comment>
  指定した位置から指定した長さの 2 つの文字列について、バイナリ対応で比較する
  
  <strong>substr_compare()</strong> は、<strong>$haystack</strong> の <strong>$offset</strong> 文字目以降の最大 <strong>$length</strong> 文字を、<strong>$needle</strong> と比較します。

<comment>Param:</comment>
  <info>string</info>    <strong>$haystack</strong>          比較したい最初の文字列。
  <info>string</info>    <strong>$needle</strong>            比較したい二番目の文字列。
  <info>int</info>       <strong>$offset</strong>            比較を開始する位置。 負の値を指定した場合は、文字列の最後から数えま
                               す。
  <info>int|null</info>  <strong>$length</strong>            比較する長さ。デフォルト値は、 <strong>$haystack</strong> の長さから <strong>$offset</strong> を引いた
                               ものと <strong>$needle</strong> の長さのうち、長いほうです。
  <info>bool</info>      <strong>$case_insensitive</strong>  <strong>$case_insensitive</strong> が <info>true</info> の場合、 大文字小文字を区別せずに比較しま
                               す。

<comment>Return:</comment>
  <info>int</info>  <strong>$haystack</strong> の <strong>$offset</strong> 以降が <strong>$needle</strong> より小さい場合に <return>-1</return>、 <strong>$needle</strong> より大きい場合に <return>1</return>、 等しい
       場合に <return>0</return> を返します。 <strong>$offset</strong> が <strong>$haystack</strong> と等しい (PHP 7.2.18, 7.3.5 より前のバージョン)
       か、 <strong>$haystack</strong> より長い場合、 もしくは <strong>$length</strong>  が設定されていて0未満である場合、
       <strong>substr_compare()</strong> は警告を表示して <info>false</info> を返します。

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


id: substr_count
type: function
doc:
<comment>Description:</comment>
  副文字列の出現回数を数える
  
  <strong>substr_count()</strong> は、文字列 <strong>$haystack</strong> の中での副文字列 <strong>$needle</strong> の出現回数を返します。 <strong>$needle</strong> は英大
  小文字を区別することに注意してください。
  
  この関数は重なり合う副文字列をカウントしません。以下の例を見てください !

<comment>Param:</comment>
  <info>string</info>    <strong>$haystack</strong>  検索対象の文字列
  <info>string</info>    <strong>$needle</strong>    検索する副文字列
  <info>int</info>       <strong>$offset</strong>    開始位置のオフセット。 負の数を指定すると、文字列の末尾から数えます。
  <info>int|null</info>  <strong>$length</strong>    指定したオフセット以降に副文字列で検索する最大長。 オフセットと長さの総和が
                       <strong>$haystack</strong> の長さよりも長い場合、警告が発生します。 負の数を指定すると、
                       <strong>$haystack</strong> の末尾から数えます。

<comment>Return:</comment>
  <info>int</info>  この関数は 整数を返します。

<comment>See Also:</comment>
   * <strong>count_chars()</strong>
   * <strong>strpos()</strong>
   * <strong>substr()</strong>
   * <strong>strstr()</strong>


id: substr_replace
type: function
doc:
<comment>Description:</comment>
  文字列の一部を置換する
  
  <strong>substr_replace()</strong>は、文字列 <strong>$string</strong>の <strong>$offset</strong> および (オプションの) <strong>$length</strong> パラメータで区切られた
  部分を <strong>$replace</strong> で指定した文字列に置換します。

<comment>Param:</comment>
  <info>array|string</info>    <strong>$string</strong>   入力文字列。
                            
                            文字列の配列を指定することもでき、各文字列について順に置換を行います。
                            この場合、他のパラメータ <strong>$replace</strong>、<strong>$offset</strong> および <strong>$length</strong> がスカラ値なら
                            それを各入力文字列に順次適用し、配列なら各入力文字列に対応する要素の値を
                            適用します。
  <info>array|string</info>    <strong>$replace</strong>  置換する文字列。
  <info>array|int</info>       <strong>$offset</strong>   <strong>$offset</strong> が負ではない場合、置換は <strong>$string</strong> で <strong>$offset</strong> 番目の文字から始まり
                            ます。
                            
                            <strong>$offset</strong> が負の場合、置換は <strong>$string</strong> の終端から <strong>$offset</strong> 番目の文字から始ま
                            ります。
  <info>array|int|null</info>  <strong>$length</strong>   正の値を指定した場合、 <strong>$string</strong> の置換される部分の長さを表します。 負の場
                            合、置換を停止する位置が <strong>$string</strong> の終端から何文字目であるかを表します。
                            このパラメータが省略された場合、 デフォルト値は strlen(<strong>$string</strong>)、すなわ
                            ち、 <strong>$string</strong> の終端まで置換することになります。 当然、もし <strong>$length</strong> がゼ
                            ロだったら、 この関数は <strong>$string</strong> の最初から <strong>$offset</strong> の位置に <strong>$replace</strong> を
                            挿入するということになります。

<comment>Return:</comment>
  <info>string|array</info>  結果の文字列を返します。もし、<strong>$string</strong> が配列の場合、配列が返されます。

<comment>See Also:</comment>
   * <strong>str_replace()</strong>
   * <strong>substr()</strong>
   * 文字列への文字単位のアクセスと修正


id: svn_add
type: function
doc:
<comment>Description:</comment>
  Schedules the addition of an item in a working directory
  
  Adds the file, directory or symbolic link at <strong>$path</strong> to the working directory. The item will be
  added to the repository the next time you call <strong>svn_commit()</strong> on the working copy.

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>       Path of item to add.
                      
                      相対パスは、PHP バイナリが存在するディレクトリを基準として解決されます。呼び出
                      しもとのスクリプトの作業ディレクトリを基準とするには、<strong>realpath()</strong> あるいは
                      dirname(__FILE__) を使用してください。
  <info>bool</info>    <strong>$recursive</strong>  If item is directory, whether or not to recursively add all of its contents.
                      Default is <info>true</info>
  <info>bool</info>    <strong>$force</strong>      If true, Subversion will recurse into already versioned directories in order
                      to add unversioned files that may be hiding in those directories. Default is
                      <info>false</info>

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

<comment>See Also:</comment>
   * SVN documentation on svn add


id: svn_auth_get_parameter
type: function
doc:
<comment>Description:</comment>
  認証パラメータを取得する
  
  認証パラメータ <strong>$key</strong> を取得します。 使用できるキーとその意味については 認証定数の一覧 を参照くださ
  い。

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>  キーの名前。認証に関する定数 のいずれかを指定します。

<comment>Return:</comment>
  <info>string</info>  <strong>$key</strong> の値を文字列で返します。 パラメータが存在しない場合は <info>null</info> を返します。

<comment>See Also:</comment>
   * <strong>svn_auth_set_parameter()</strong>
   * 認証定数


id: svn_auth_set_parameter
type: function
doc:
<comment>Description:</comment>
  認証パラメータを設定する
  
  認証パラメータ <strong>$key</strong> の値を <strong>$value</strong> に設定します。 使用できるキーとその意味については 認証定数の一覧
  を参照ください。

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>    キーの名前。認証に関する定数 のいずれかを指定します。
  <info>string</info>  <strong>$value</strong>  そのパラメータに指定する値。 値の書式は、パラメータによって異なります。

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

<comment>See Also:</comment>
   * <strong>svn_auth_get_parameter()</strong>
   * 認証定数


id: svn_blame
type: function
doc:
<comment>Description:</comment>
  ファイルの SVN blame を取得する
  
  リポジトリの URL を指定して、ファイルの SVN blame を取得します。

<comment>Param:</comment>
  <info>string</info>  <strong>$repository_url</strong>  リポジトリの URL。
  <info>int</info>     <strong>$revision_no</strong>     リビジョン番号。

<comment>Return:</comment>
  <info>array</info>  SVN blame 情報を配列で返します。行ごとに区切られ、 リビジョン番号と行番号、コードの行、作
         者、日付が含まれます。

<comment>See Also:</comment>
   * <strong>svn_diff()</strong>
   * <strong>svn_logs()</strong>
   * <strong>svn_status()</strong>


id: svn_cat
type: function
doc:
<comment>Description:</comment>
  リポジトリ内のファイルの内容を返す
  
  リポジトリ内のファイルを指す URL <strong>$repos_url</strong> の中身を返します。オプションでリビジョン番号
  <strong>$revision_no</strong> を指定します。

<comment>Param:</comment>
  <info>string</info>  <strong>$repos_url</strong>    リポジトリ内のアイテムへのパスを表す URL 文字列。
  <info>int</info>     <strong>$revision_no</strong>  取得したいリビジョン番号を表す整数値。デフォルトは HEAD リビジョン。

<comment>Return:</comment>
  <info>string</info>  成功した場合にアイテムの内容を表す文字列、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>svn_list()</strong>
   * SVN ドキュメントの svn cat


id: svn_checkout
type: function
doc:
<comment>Description:</comment>
  リポジトリから作業コピーをチェックアウトする
  
  <strong>$repos</strong> にあるリポジトリの リビジョン <strong>$revision</strong> を、 <strong>$targetpath</strong> の作業コピーにチェックアウトしま
  す。

<comment>Param:</comment>
  <info>string</info>  <strong>$repos</strong>       チェックアウトしたいリポジトリ内のディレクトリを表す URL 文字列。
  <info>string</info>  <strong>$targetpath</strong>  チェックアウト先ディレクトリのローカルパス。
                       
                       相対パスは、PHP バイナリが存在するディレクトリを基準として解決されます。呼び
                       出しもとのスクリプトの作業ディレクトリを基準とするには、<strong>realpath()</strong> あるいは
                       dirname(__FILE__) を使用してください。
  <info>int</info>     <strong>$revision</strong>    チェックアウトしたいリビジョン番号を表す整数値。デフォルトは HEAD リビジョン
                       で、これは最新のリビジョンを表します。
  <info>int</info>     <strong>$flags</strong>       <info>SVN_NON_RECURSIVE</info> および <info>SVN_IGNORE_EXTERNALS</info> の任意の組み合わせ。

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

<comment>See Also:</comment>
   * <strong>svn_add()</strong>
   * <strong>svn_commit()</strong>
   * <strong>svn_status()</strong>
   * <strong>svn_update()</strong>
   * SVN ドキュメントの svn checkout


id: svn_cleanup
type: function
doc:
<comment>Description:</comment>
  作業コピーディレクトリを再帰的にクリーンアップし、中途半端な操作を解消してロックを削除する
  
  作業コピーディレクトリ <strong>$workingdir</strong> を再帰的にクリーンアップし、中途半端になっている操作を完了して
  ロックを削除します。 作業コピーが中途半端な状態になってしまったときに、 再度使用可能にするために用
  います。

<comment>Param:</comment>
  <info>string</info>  <strong>$workingdir</strong>  クリーンアップしたい作業ディレクトリへのパス。
                       
                       相対パスは、PHP バイナリが存在するディレクトリを基準として解決されます。呼び
                       出しもとのスクリプトの作業ディレクトリを基準とするには、<strong>realpath()</strong> あるいは
                       dirname(__FILE__) を使用してください。

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

<comment>See Also:</comment>
   * <strong>update()</strong>
   * SVN ドキュメントの svn cleanup


id: svn_client_version
type: function
doc:
<comment>Description:</comment>
  SVN クライアントライブラリのバージョンを返す
  
  SVN クライアントライブラリのバージョンを返します。

<comment>Return:</comment>
  <info>string</info>  バージョン番号を表す文字列を返します。通常は x.y.z 形式となります。


id: svn_commit
type: function
doc:
<comment>Description:</comment>
  Sends changes from the local working copy to the repository
  
  Commits changes made in the local working copy files enumerated in the <strong>$targets</strong> array to the
  repository, with the log message <strong>$log</strong>. Directories in the <strong>$targets</strong> array will be recursively
  committed unless <strong>$recursive</strong> is set to <info>false</info>.
  
  This function does not have any parameters for specifying authentication, so a username and
  password must be set using <strong>svn_auth_set_parameter()</strong>

<comment>Param:</comment>
  <info>string</info>  <strong>$log</strong>        String log text to commit
  <info>array</info>   <strong>$targets</strong>    Array of local paths of files to be committed
                      
                      This parameter must be an array, a string for a single target is not
                      acceptable.
                      
                      相対パスは、PHP バイナリが存在するディレクトリを基準として解決されます。呼び出
                      しもとのスクリプトの作業ディレクトリを基準とするには、<strong>realpath()</strong> あるいは
                      dirname(__FILE__) を使用してください。
  <info>bool</info>    <strong>$recursive</strong>  Boolean flag to disable recursive committing of directories in the <strong>$targets</strong>
                      array. Default is <info>true</info>.

<comment>Return:</comment>
  <info>array</info>  Returns array in form of:
         
         Returns <info>false</info> on failure.

<comment>See Also:</comment>
   * <strong>svn_auth_set_parameter()</strong>
   * SVN documentation on svn commit


id: svn_delete
type: function
doc:
<comment>Description:</comment>
  Delete items from a working copy or repository
  
  Deletes the file, directory or symbolic link at <strong>$path</strong> from the working directory. The item will be
  deleted from the repository the next time you call <strong>svn_commit()</strong> on the working copy.

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>   Path of item to delete.
                  
                  相対パスは、PHP バイナリが存在するディレクトリを基準として解決されます。呼び出しも
                  とのスクリプトの作業ディレクトリを基準とするには、<strong>realpath()</strong> あるいは
                  dirname(__FILE__) を使用してください。
  <info>bool</info>    <strong>$force</strong>  If <info>true</info>, the file will be deleted even if it has local modifications. Otherwise,
                  local modifications will result in a failure. Default is <info>false</info>

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

<comment>See Also:</comment>
   * SVN documentation on svn
    delete


id: svn_diff
type: function
doc:
<comment>Description:</comment>
  ふたつのパスの差分を再帰的に取得する
  
  ふたつのパス <strong>$path1</strong> および <strong>$path2</strong> の差分を再帰的に取得します。
  
  汎用的な diff ツールとは異なり、 バージョン管理の対象になっているローカルファイルしか差分取得の対
  象となりません。 その他のファイルの差分は取得できません。

<comment>Param:</comment>
  <info>string</info>  <strong>$path1</strong>  最初のパス。SVN リポジトリのファイル/ディレクトリを指す URL、 あるいはローカルの
                  ファイル/ディレクトリのパスのいずれかとなります。
                  
                  相対パスは、PHP バイナリが存在するディレクトリを基準として解決されます。呼び出しも
                  とのスクリプトの作業ディレクトリを基準とするには、<strong>realpath()</strong> あるいは
                  dirname(__FILE__) を使用してください。
                  
                  ローカルファイルのパスを指定する際に、 バックスラッシュのみを使用して通常のスラッ
                  シュが存在しない場合は、 パスの検出に失敗してしまいます。この関数を使う際には、
                  バックスラッシュをすべてスラッシュに置き換えるようにしましょう。
  <info>int</info>     <strong>$rev1</strong>   最初のパスのリビジョン番号。最新のリビジョンを指定したい場合は <info>SVN_REVISION_HEAD</info>
                  を使用します。
  <info>string</info>  <strong>$path2</strong>  もうひとつのパス。詳細は <strong>$path1</strong> の説明を参照ください。
  <info>int</info>     <strong>$rev2</strong>   もうひとつのパスのリビジョン番号。詳細は <strong>$rev1</strong> の説明を参照ください。

<comment>Return:</comment>
  <info>array</info>  ふたつのストリームの内容を含む配列のリストを返します。 最初のストリームが diff の出力で、も
         うひとつはエラー出力です。 このストリームを読み込むには <strong>fread()</strong> を使用します。エラーが発生
         した場合は <info>false</info> あるいは <info>null</info> を返します。
         
         デフォルトでは、diff の出力は Subversion 版の unified diff 形式となります。しかし、
         Subversion の設定によっては 外部の diff エンジン を使うこともできます。

<comment>See Also:</comment>
   * SVN ドキュメントの svn diff


id: svn_export
type: function
doc:
<comment>Description:</comment>
  Export the contents of a SVN directory
  
  Export the contents of either a working copy or repository into a 'clean' directory.

<comment>Param:</comment>
  <info>string</info>  <strong>$frompath</strong>      The path to the current repository.
  <info>string</info>  <strong>$topath</strong>        The path to the new repository.
  <info>bool</info>    <strong>$working_copy</strong>  If <info>true</info>, it will export uncommitted files from the working copy.

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

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


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

<comment>Param:</comment>
  <info>resource</info>  <strong>$txn</strong>  

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


id: svn_fs_apply_text
type: function
doc:
<comment>Description:</comment>
  置換に使用するストリームを作成して返す
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。
  
  置換に使用するストリームを作成して返します。

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


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

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


id: svn_fs_change_node_prop
type: function
doc:
<comment>Description:</comment>
  成功したら true、失敗したら false を返す
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。
  
  成功したら true、失敗したら false を返します。

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


id: svn_fs_check_path
type: function
doc:
<comment>Description:</comment>
  指定したリポジトリの fsroot パスにどんなアイテムが存在するかを調べる
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。
  
  指定したリポジトリの fsroot パスにどんなアイテムが存在するかを調べます。

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


id: svn_fs_contents_changed
type: function
doc:
<comment>Description:</comment>
  コンテンツが変更されている場合に true、されていない場合に false を返す
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。
  
  コンテンツが変更されている場合に true、されていない場合に false を返します。

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


id: svn_fs_copy
type: function
doc:
<comment>Description:</comment>
  ファイルまたはディレクトリをコピーする
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。
  
  ファイルまたはディレクトリをコピーします。

<comment>Param:</comment>
  <info>resource</info>  <strong>$from_root</strong>  
  <info>string</info>    <strong>$from_path</strong>  
  <info>resource</info>  <strong>$to_root</strong>    
  <info>string</info>    <strong>$to_path</strong>    

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


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

<comment>Param:</comment>
  <info>resource</info>  <strong>$root</strong>  
  <info>string</info>    <strong>$path</strong>  

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


id: svn_fs_dir_entries
type: function
doc:
<comment>Description:</comment>
  指定したパスのディレクトリを列挙し、ディレクトリ名とファイルタイプのハッシュを返す
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。
  
  指定したパスのディレクトリを列挙し、ディレクトリ名とファイルタイプのハッシュを返します。

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


id: svn_fs_file_contents
type: function
doc:
<comment>Description:</comment>
  指定したバージョンの fs から、ファイルの中身を読み込むためのストリームを返す
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。
  
  指定したバージョンの fs から、ファイルの中身を読み込むためのストリームを返します。

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


id: svn_fs_file_length
type: function
doc:
<comment>Description:</comment>
  指定したバージョンの fs から、ファイルの長さを返す
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。
  
  指定したバージョンの fs から、ファイルの長さを返します。

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


id: svn_fs_is_dir
type: function
doc:
<comment>Description:</comment>
  指定されたパスがディレクトリかを判定する
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。
  
  指定されたパスがディレクトリかを判定します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$root</strong>  
  <info>string</info>    <strong>$path</strong>  

<comment>Return:</comment>
  <info>bool</info>  指定されたパスがディレクトリであれば <info>true</info> を返します。 そうでない場合、<info>false</info> を返します。


id: svn_fs_is_file
type: function
doc:
<comment>Description:</comment>
  指定されたパスがファイルかを判定する
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。
  
  指定されたパスがファイルかを判定します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$root</strong>  
  <info>string</info>    <strong>$path</strong>  

<comment>Return:</comment>
  <info>bool</info>  指定されたパスがファイルであれば <info>true</info> を返します。 そうでない場合、<info>false</info> を返します。


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

<comment>Param:</comment>
  <info>resource</info>  <strong>$root</strong>  
  <info>string</info>    <strong>$path</strong>  

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


id: svn_fs_make_file
type: function
doc:
<comment>Description:</comment>
  新しい空のファイルを作成する
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。
  
  新しい空のファイルを作成します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$root</strong>  
  <info>string</info>    <strong>$path</strong>  

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


id: svn_fs_node_created_rev
type: function
doc:
<comment>Description:</comment>
  fsroot 配下のパスが作成されたリビジョンを返す
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。
  
  fsroot 配下のパスが作成されたリビジョンを返します。

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


id: svn_fs_node_prop
type: function
doc:
<comment>Description:</comment>
  ノードのプロパティの値を返す
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。
  
  ノードのプロパティの値を返します。

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


id: svn_fs_props_changed
type: function
doc:
<comment>Description:</comment>
  プロパティが変更されている場合に true、それ以外の場合に false を返す
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。
  
  プロパティが変更されている場合に true、それ以外の場合に false を返します。

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


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

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


id: svn_fs_revision_root
type: function
doc:
<comment>Description:</comment>
  リポジトリのルートの指定したバージョンのハンドルを取得する
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。
  
  リポジトリのルートの指定したバージョンのハンドルを取得します。

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


id: svn_fs_txn_root
type: function
doc:
<comment>Description:</comment>
  トランザクションのルートを作成して返す
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。
  
  トランザクションのルートを作成して返します。

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


id: svn_fs_youngest_rev
type: function
doc:
<comment>Description:</comment>
  ファイルシステム内で一番若いリビジョン番号を返す
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。
  
  ファイルシステム内で一番若いリビジョン番号を返します。

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


id: svn_import
type: function
doc:
<comment>Description:</comment>
  バージョン管理されていないパスをリポジトリにインポートする
  
  バージョン管理されていないパス <strong>$path</strong> を、 <strong>$url</strong> で指定したリポジトリにコミットします。 <strong>$path</strong> がディ
  レクトリで <strong>$nonrecursive</strong> が <info>false</info> の場合は、 再帰的にインポートします。

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>          インポートするファイルあるいはディレクトリのパス。
                         
                         相対パスは、PHP バイナリが存在するディレクトリを基準として解決されます。呼
                         び出しもとのスクリプトの作業ディレクトリを基準とするには、<strong>realpath()</strong> あるい
                         は dirname(__FILE__) を使用してください。
  <info>string</info>  <strong>$url</strong>           インポート先のリポジトリの URL。
  <info>bool</info>    <strong>$nonrecursive</strong>  ディレクトリを再帰処理するかどうか。

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

<comment>See Also:</comment>
   * <strong>svn_add()</strong>
   * SVN ドキュメントの svn import


id: svn_log
type: function
doc:
<comment>Description:</comment>
  指定したリポジトリ URL のコミットログメッセージを返す
  
  <strong>svn_log()</strong> は、指定したリビジョン URL <strong>$repos_url</strong> の中身の完全な履歴を返します。 <strong>$start_revision</strong> を
  指定した場合は、そのリビジョンの履歴を返します。 この関数は、svn log --verbose -r $start_revision
  $repos_url と同等です。

<comment>Param:</comment>
  <info>string</info>  <strong>$repos_url</strong>       履歴を取得したいアイテムのリポジトリ URL。
  <info>int</info>     <strong>$start_revision</strong>  ログを取得したい最初のリビジョン番号。直近のリビジョンからのログを取得す
                           る場合は <info>SVN_REVISION_HEAD</info> を使用します。
  <info>int</info>     <strong>$end_revision</strong>    ログを取得したい最後のリビジョン番号。デフォルトは、 <strong>$start_revision</strong> を指
                           定した場合はそれと同じで 指定しなかった場合は <info>SVN_REVISION_INITIAL</info> となり
                           ます。
  <info>int</info>     <strong>$limit</strong>           取得したいログの数。
  <info>int</info>     <strong>$flags</strong>           <info>SVN_OMIT_MESSAGES</info>、 <info>SVN_DISCOVER_CHANGED_PATHS</info> および <info>SVN_STOP_ON_COPY</info> の
                           任意の組み合わせ。

<comment>Return:</comment>
  <info>array</info>  成功した場合は、この関数は次のような構造の配列を返します。  Array (最新のリポジトリから順に
         並びます)
         ( [rev] => リビジョン番号 [author] => コミットした人の名前 [msg] => ログメッセージ [date]
         => ISO 8601 形式、つまり date('c') と同じ形式の日付文字列 [paths] => Array (変更したファイ
         ルについての説明) ( [0] => Array ( [action] => 変更の種類を表す文字 [path] =>  変更された
         ファイルの絶対パス ) [1] => ... )
         )
         [1] => ...
         ]]>
         
         出力は、常に数値添字の二次元配列となります。 ログメッセージがなかったり、ひとつだけだったり
         する場合でも同じです。
         
         action の値は、 status の出力の最初の列の内容 のサブセットで、以下のいずれかとなります。
         
         何も変更されていない場合は、空の配列を返します。

<comment>See Also:</comment>
   * 
      SVN ドキュメントの svn log
     


id: svn_ls
type: function
doc:
<comment>Description:</comment>
  Returns list of directory contents in repository URL, optionally at revision number
  
  This function queries the repository URL and returns a list of files and directories, optionally
  from a specific revision. This is equivalent to svn list $repos_url[@$revision_no]
  
  This function does not work with working copies. <strong>$repos_url</strong> must be a repository URL.

<comment>Param:</comment>
  <info></info>      <strong>$url</strong>       URL of the repository, eg. http://www.example.com/svnroot. To access a local
                   Subversion repository via filesystem, use the file URI scheme, eg.
                   file:///home/user/svn-repos
  <info></info>      <strong>$revision</strong>  Integer revision number to retrieve listing of. When omitted, the HEAD revision
                   is used.
  <info>bool</info>  <strong>$recurse</strong>   Enables recursion.

<comment>Return:</comment>
  <info>array</info>  On success, this function returns an array file listing in the format of:  Array (
         [created_rev] => integer revision number of last edit [last_author] => string author name
         of last edit [size] => integer byte file size of file [time] => string date of last edit in
         form 'M d H:i' or 'M d Y', depending on how old the file is [time_t] => integer unix
         timestamp of last edit [name] => name of file/directory [type] => type, can be 'file' or
         'dir' )
         [1] => ...
         ]]>

<comment>See Also:</comment>
   * SVN documentation on svn list


id: svn_mkdir
type: function
doc:
<comment>Description:</comment>
  作業コピーあるいはリポジトリ内にディレクトリを作成する
  
  作業コピーあるいはリポジトリ内にディレクトリを作成します。

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>  作業コピーあるいはリポジトリへのパス。

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

<comment>See Also:</comment>
   * <strong>svn_add()</strong>
   * <strong>svn_copy()</strong>


id: svn_repos_create
type: function
doc:
<comment>Description:</comment>
  新しい subversion リポジトリを指定したパスに作成する
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。
  
  新しい subversion リポジトリを指定したパスに作成します。

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


id: svn_repos_fs
type: function
doc:
<comment>Description:</comment>
  リポジトリ用に、ファイルシステム上のハンドルを取得する
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。
  
  リポジトリ用に、ファイルシステム上のハンドルを取得します。

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


id: svn_repos_fs_commit_txn
type: function
doc:
<comment>Description:</comment>
  トランザクションをコミットし、新しいリビジョンを返す
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。
  
  トランザクションをコミットし、新しいリビジョンを返します。

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


id: svn_repos_hotcopy
type: function
doc:
<comment>Description:</comment>
  repospath にあるリポジトリのホットコピーを作成し、destpath にコピーする
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。
  
  repospath にあるリポジトリのホットコピーを作成し、destpath にコピーします。

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


id: svn_repos_open
type: function
doc:
<comment>Description:</comment>
  Open a shared lock on a repository
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。
  
  Open a shared lock on a repository.

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


id: svn_repos_recover
type: function
doc:
<comment>Description:</comment>
  Run recovery procedures on the repository located at path
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。
  
  Run recovery procedures on the repository located at path.

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


id: svn_revert
type: function
doc:
<comment>Description:</comment>
  Revert changes to the working copy
  
  Revert any local changes to the path in a working copy.

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>       The path to the working repository.
  <info>bool</info>    <strong>$recursive</strong>  Optionally make recursive changes.

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

<comment>See Also:</comment>
   * <strong>svn_delete()</strong>
   * <strong>svn_export()</strong>


id: svn_status
type: function
doc:
<comment>Description:</comment>
  Returns the status of working copy files and directories
  
  Returns the status of working copy files and directories, giving modifications, additions,
  deletions and other changes to items in the working copy.

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>   Local path to file or directory to retrieve status of.
                  
                  相対パスは、PHP バイナリが存在するディレクトリを基準として解決されます。呼び出しも
                  とのスクリプトの作業ディレクトリを基準とするには、<strong>realpath()</strong> あるいは
                  dirname(__FILE__) を使用してください。
  <info>int</info>     <strong>$flags</strong>  Any combination of <info>Svn::NON_RECURSIVE</info>, <info>Svn::ALL</info> (regardless of modification
                  status), <info>Svn::SHOW_UPDATES</info> (entries will be added for items that are out-of-date),
                  <info>Svn::NO_IGNORE</info> (disregard <return>svn:ignore</return> properties when scanning for new files) and
                  <info>Svn::IGNORE_EXTERNALS</info>.

<comment>Return:</comment>
  <info>array</info>  Returns a numerically indexed array of associative arrays detailing the status of items in
         the repository:
         
         The information on the item is an associative array that can contain the following keys:
         
         String path to file/directory of this entry on local filesystem.
         
         Status of item's text. とりうる値については 状態に関する定数 を参照ください。
         
         Status of item's text in repository. Only accurate if <strong>$update</strong> was set to <info>true</info>. とりうる値に
         ついては 状態に関する定数 を参照ください。
         
         Status of item's properties. とりうる値については 状態に関する定数 を参照ください。
         
         Status of item's property in repository. Only accurate if <strong>$update</strong> was set to <info>true</info>. とりうる
         値については 状態に関する定数 を参照ください。
         
         Whether or not the item is locked. (Only set if <info>true</info>.)
         
         Whether or not the item was copied (scheduled for addition with history). (Only set if
         <info>true</info>.)
         
         Whether or not the item was switched using the switch command. (Only set if <info>true</info>)
         
         These keys are only set if the item is versioned:
         
         Base name of item in repository.
         
         URL of item in repository.
         
         Base URL of repository.
         
         Integer revision of item in working copy.
         
         Type of item, i.e. file or directory. とりうる値については 型に関する定数 を参照ください。
         
         Scheduled action for item, i.e. addition or deletion. Constants for these magic numbers are
         not available, they can be emulated by using:
         
         Whether or not the item was deleted, but parent revision lags behind. (Only set if <info>true</info>.)
         
         Whether or not the item is absent, that is, Subversion knows that there should be something
         there but there isn't. (Only set if <info>true</info>.)
         
         Whether or not the entries file for a directory is incomplete. (Only set if <info>true</info>.)
         
         Integer Unix timestamp of last commit date. (Unaffected by <strong>$update</strong>.)
         
         Integer revision of last commit. (Unaffected by <strong>$update</strong>.)
         
         String author of last commit. (Unaffected by <strong>$update</strong>.)
         
         Integer Unix timestamp of last up-to-date time for properties
         
         Integer Unix timestamp of last up-to-date time for text

<comment>See Also:</comment>
   * <strong>svn_update()</strong>
   * <strong>svn_log()</strong>
   * SVN documentation for svn status


id: svn_update
type: function
doc:
<comment>Description:</comment>
  Update working copy
  
  Update working copy at <strong>$path</strong> to revision <strong>$revno</strong>. If <strong>$recurse</strong> is true, directories will be
  recursively updated.

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>     Path to local working copy.
                    
                    相対パスは、PHP バイナリが存在するディレクトリを基準として解決されます。呼び出し
                    もとのスクリプトの作業ディレクトリを基準とするには、<strong>realpath()</strong> あるいは
                    dirname(__FILE__) を使用してください。
  <info>int</info>     <strong>$revno</strong>    Revision number to update to, default is <info>SVN_REVISION_HEAD</info>.
  <info>bool</info>    <strong>$recurse</strong>  Whether or not to recursively update directories.

<comment>Return:</comment>
  <info>int</info>  Returns new revision number on success, returns <info>false</info> on failure.

<comment>See Also:</comment>
   * <strong>svn_checkout()</strong>
   * <strong>svn_commit()</strong>
   * SVN documentation for svn update


id: swoole_async_dns_lookup
type: function
doc:
<comment>Description:</comment>
  Async and non-blocking hostname to IP lookup

<comment>Param:</comment>
  <info>string</info>    <strong>$hostname</strong>  The host name.
  <info>callable</info>  <strong>$callback</strong>  The host name.
                       
                       The IP address.
  <info>string</info>    <strong>$hostname</strong>  The host name.
  <info></info>          <strong>$IP</strong>        The IP address.

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


id: swoole_async_read
type: function
doc:
<comment>Description:</comment>
  Read file stream asynchronously

<comment>Param:</comment>
  <info>string</info>    <strong>$filename</strong>    The filename of the file being read.
  <info>callable</info>  <strong>$callback</strong>    The name of the file.
                         
                         The content readed from the file stream.
  <info>string</info>    <strong>$filename</strong>    The name of the file.
  <info>string</info>    <strong>$content</strong>     The content readed from the file stream.
  <info>int</info>       <strong>$chunk_size</strong>  The chunk length.
  <info>int</info>       <strong>$offset</strong>      The offset.

<comment>Return:</comment>
  <info>bool</info>  Whether the read is succeed.


id: swoole_async_readfile
type: function
doc:
<comment>Description:</comment>
  Read a file asynchronously

<comment>Param:</comment>
  <info>string</info>    <strong>$filename</strong>  The filename of the file being read.
  <info>callable</info>  <strong>$callback</strong>  The name of the file.
                       
                       The content read from the file.
  <info>string</info>    <strong>$filename</strong>  The name of the file.
  <info>string</info>    <strong>$content</strong>   The content read from the file.

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


id: swoole_async_set
type: function
doc:
<comment>Description:</comment>
  Update the async I/O options

<comment>Param:</comment>
  <info>array</info>  <strong>$settings</strong>  

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


id: swoole_async_write
type: function
doc:
<comment>Description:</comment>
  Write data to a file stream asynchronously

<comment>Param:</comment>
  <info>string</info>    <strong>$filename</strong>  The filename being written.
  <info>string</info>    <strong>$content</strong>   The content writing to the file.
  <info>int</info>       <strong>$offset</strong>    The offset.
  <info>callable</info>  <strong>$callback</strong>  

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


id: swoole_async_writefile
type: function
doc:
<comment>Description:</comment>
  Write data to a file asynchronously

<comment>Param:</comment>
  <info>string</info>    <strong>$filename</strong>  The filename being written.
  <info>string</info>    <strong>$content</strong>   The content writing to the file.
  <info>callable</info>  <strong>$callback</strong>  
  <info>int</info>       <strong>$flags</strong>     

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


id: swoole_clear_error
type: function
doc:
<comment>Description:</comment>
  Clear errors in the socket or on the last error code
  
  Clear errors in the socket or on the last error code.

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


id: swoole_client_select
type: function
doc:
<comment>Description:</comment>
  Get the file description which are ready to read/write or error

<comment>Param:</comment>
  <info>array</info>  <strong>$read_array</strong>   
  <info>array</info>  <strong>$write_array</strong>  
  <info>array</info>  <strong>$error_array</strong>  
  <info>float</info>  <strong>$timeout</strong>      

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


id: swoole_cpu_num
type: function
doc:
<comment>Description:</comment>
  Get the number of CPU

<comment>Return:</comment>
  <info>int</info>  The number of CPU.


id: swoole_errno
type: function
doc:
<comment>Description:</comment>
  Get the error code of the latest system call

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


id: swoole_error_log
type: function
doc:
<comment>Description:</comment>
  Output error messages to the log
  
  Output error messages to the log.

<comment>Param:</comment>
  <info>int</info>     <strong>$level</strong>  Log Level, constants can be used: <info>SWOOLE_LOG_DEBUG</info>, <info>SWOOLE_LOG_TRACE</info>,
                  <info>SWOOLE_LOG_INFO</info>, <info>SWOOLE_LOG_NOTICE</info>, <info>SWOOLE_LOG_WARNING</info>, <info>SWOOLE_LOG_ERROR</info>,
                  <info>SWOOLE_LOG_NONE</info>
  <info>string</info>  <strong>$msg</strong>    Message content to be written to the log.

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


id: swoole_event_add
type: function
doc:
<comment>Description:</comment>
  Add new callback functions of a socket into the EventLoop

<comment>Param:</comment>
  <info>int</info>       <strong>$fd</strong>              
  <info>callable</info>  <strong>$read_callback</strong>   
  <info>callable</info>  <strong>$write_callback</strong>  
  <info>int</info>       <strong>$events</strong>          

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


id: swoole_event_defer
type: function
doc:
<comment>Description:</comment>
  Add callback function to the next event loop

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  

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


id: swoole_event_del
type: function
doc:
<comment>Description:</comment>
  Remove all event callback functions of a socket

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

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


id: swoole_event_exit
type: function
doc:
<comment>Description:</comment>
  Exit the eventloop, only available at the client side

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


id: swoole_event_set
type: function
doc:
<comment>Description:</comment>
  Update the event callback functions of a socket

<comment>Param:</comment>
  <info>int</info>       <strong>$fd</strong>              
  <info>callable</info>  <strong>$read_callback</strong>   
  <info>callable</info>  <strong>$write_callback</strong>  
  <info>int</info>       <strong>$events</strong>          

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


id: swoole_event_wait
type: function
doc:
<comment>Description:</comment>
  Start the event loop

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


id: swoole_event_write
type: function
doc:
<comment>Description:</comment>
  Write data to a socket

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

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


id: swoole_get_local_ip
type: function
doc:
<comment>Description:</comment>
  Get the IPv4 IP addresses of each NIC on the machine

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


id: swoole_last_error
type: function
doc:
<comment>Description:</comment>
  Get the lastest error message

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


id: swoole_load_module
type: function
doc:
<comment>Description:</comment>
  Load a swoole extension

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


id: swoole_select
type: function
doc:
<comment>Description:</comment>
  Select the file descriptions which are ready to read/write or error in the eventloop

<comment>Param:</comment>
  <info>array</info>  <strong>$read_array</strong>   
  <info>array</info>  <strong>$write_array</strong>  
  <info>array</info>  <strong>$error_array</strong>  
  <info>float</info>  <strong>$timeout</strong>      

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


id: swoole_set_process_name
type: function
doc:
<comment>Description:</comment>
  Set the process name

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

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


id: swoole_strerror
type: function
doc:
<comment>Description:</comment>
  Convert the Errno into error messages

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

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


id: swoole_timer_after
type: function
doc:
<comment>Description:</comment>
  Trigger a one time callback function in the future

<comment>Param:</comment>
  <info>int</info>       <strong>$ms</strong>        
  <info>callable</info>  <strong>$callback</strong>  
  <info>mixed</info>     <strong>$param</strong>     

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


id: swoole_timer_exists
type: function
doc:
<comment>Description:</comment>
  Check if a timer callback function is existed

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

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


id: swoole_timer_tick
type: function
doc:
<comment>Description:</comment>
  Trigger a timer tick callback function by time interval

<comment>Param:</comment>
  <info>int</info>       <strong>$ms</strong>        
  <info>callable</info>  <strong>$callback</strong>  

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


id: swoole_version
type: function
doc:
<comment>Description:</comment>
  Get the version of Swoole

<comment>Return:</comment>
  <info>string</info>  The version of Swoole.


id: symlink
type: function
doc:
<comment>Description:</comment>
  シンボリックリンクを作成する
  
  <strong>symlink()</strong>は、指定されたリンク名 <strong>$link</strong> で既存のファイル <strong>$target</strong> へのシンボリックリンクを作成しま
  す。

<comment>Param:</comment>
  <info>string</info>  <strong>$target</strong>  リンクの対象。
  <info>string</info>  <strong>$link</strong>    リンクの名前。

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

<comment>See Also:</comment>
   * <strong>link()</strong>
   * <strong>readlink()</strong>
   * <strong>linkinfo()</strong>
   * <strong>unlink()</strong>


id: sys_get_temp_dir
type: function
doc:
<comment>Description:</comment>
  一時ファイル用に使用されるディレクトリのパスを返す
  
  PHP が一時ファイルを保存するデフォルトのディレクトリのパスを返します。

<comment>Return:</comment>
  <info>string</info>  一時ディレクトリのパスを返します。

<comment>See Also:</comment>
   * <strong>tmpfile()</strong>
   * <strong>tempnam()</strong>


id: sys_getloadavg
type: function
doc:
<comment>Description:</comment>
  システムの平均負荷を取得する
  
  過去 1、5、15 分間のシステムの平均負荷 (システムの実行キューの中のプロセス数) を表す三つの値を返し
  ます。

<comment>Return:</comment>
  <info>array|false</info>  (過去 1、5、15 分間の) 三つの値を <info>array</info> で返します。 失敗した場合は <info>false</info> を返しま
               す。


id: syslog
type: function
doc:
<comment>Description:</comment>
  システムログのメッセージを生成する
  
  <strong>syslog()</strong> はシステムログが出力するログメッセージを生成します。
  
  ユーザー定義のログハンドラの設定に関する情報については、Unix マニュアルの syslog.conf5 を参照くだ
  さい。  syslog の facility と option に関するより詳細な情報は、 Unix マシンの syslog3 にあります。

<comment>Param:</comment>
  <info>int</info>     <strong>$priority</strong>  <strong>$priority</strong> は、容易さ (facility) とレベル (level) の組み合わせです。以下の値が使
                     用できます。 <strong>syslog()</strong> の優先順位 (降順)定数説明<info>LOG_EMERG</info>システムは使用不可
                     <info>LOG_ALERT</info>アクションを直ちにおこす必要がある<info>LOG_CRIT</info>致命的な条件<info>LOG_ERR</info>エラーを
                     発生する条件<info>LOG_WARNING</info>警告を発生する条件<info>LOG_NOTICE</info>通常の動作だが、特徴的な条件
                     <info>LOG_INFO</info>情報を与えるメッセージ<info>LOG_DEBUG</info>デバッグ用のメッセージ
  <info>string</info>  <strong>$message</strong>   送信するメッセージ

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

<comment>See Also:</comment>
   * <strong>openlog()</strong>
   * <strong>closelog()</strong>
   * syslog.filter INI ディレクティブ(PHP 7.3 以降)


id: system
type: function
doc:
<comment>Description:</comment>
  外部プログラムを実行し、出力を表示する
  
  <strong>system()</strong> は、指定した <strong>$command</strong> を実行し、結果を出力する C 言語の system 関数に似ています。
  
  PHP をサーバーモジュールとして実行している場合、 <strong>system()</strong> のコールにより、各行を出力した後、 Web
  サーバーの出力バッファが自動的にクリアされます。
  
  コマンドを実行し、何の加工もせずに全てのデータをコマンドから直接 返す必要がある場合、<strong>passthru()</strong> 関
  数を使用してください。

<comment>Param:</comment>
  <info>string</info>  <strong>$command</strong>      実行するコマンド。
  <info>int</info>     <strong>$result_code</strong>  引数 <strong>$result_code</strong> が存在する場合、 実行したコマンドの返すステータスがこの変
                        数に書かれます。

<comment>Return:</comment>
  <info>string|false</info>  成功時はコマンド出力の最後の行を返し、失敗時は <info>false</info> を返します。

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


id: taint
type: function
doc:
<comment>Description:</comment>
  文字列を汚染させる
  
  文字列を汚染させます。この関数は、テスト用としてのみ使うものです。

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

<comment>Return:</comment>
  <info>bool</info>  変換に成功したときに TURE を返します。 taint 拡張モジュールが有効になっていない場合は常に
        TRUE を返します。


id: tan
type: function
doc:
<comment>Description:</comment>
  正接（タンジェント）
  
  <strong>tan()</strong> は、<strong>$num</strong> のタンジェントを 返します。<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>atan()</strong>
   * <strong>atan2()</strong>
   * <strong>sin()</strong>
   * <strong>cos()</strong>
   * <strong>tanh()</strong>
   * <strong>deg2rad()</strong>


id: tanh
type: function
doc:
<comment>Description:</comment>
  双曲線正接（ハイパボリックタンジェント）
  
  <strong>$num</strong> のハイパボリックタンジェントを返します。 これは <return>sinh($num)/cosh($num)</return> で定義されます。

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

<comment>Return:</comment>
  <info>float</info>  <strong>$num</strong> のハイパボリックタンジェントを返します。

<comment>See Also:</comment>
   * <strong>tan()</strong>
   * <strong>atanh()</strong>
   * <strong>sinh()</strong>
   * <strong>cosh()</strong>


id: tcpwrap_check
type: function
doc:
<comment>Description:</comment>
  tcpwrap のチェックを実行する
  
  この関数は /etc/hosts.allow および /etc/hosts.deny の内容をもとに、あるクライアントが <strong>$daemon</strong> サー
  ビスへのアクセスを許可されているか 否かを調べます。

<comment>Param:</comment>
  <info>string</info>  <strong>$daemon</strong>   サービスの名前。
  <info>string</info>  <strong>$address</strong>  クライアントのリモートアドレス。IP アドレスあるいはドメイン名の どちらでも指定可
                    能。
  <info>string</info>  <strong>$user</strong>     ユーザー名（オプション）。
  <info>bool</info>    <strong>$nodns</strong>    <strong>$address</strong> がドメイン名の場合、それを IP アドレスに名前解決するために DNS が使用さ
                    れます。 <strong>$nodns</strong> を <info>true</info> に指定すると、この処理を 禁止します。

<comment>Return:</comment>
  <info>bool</info>  アクセスが許可されている場合に <info>true</info> 、それ以外の場合に <info>false</info> を返します。


id: tempnam
type: function
doc:
<comment>Description:</comment>
  一意なファイル名を生成する
  
  一意なテンポラリファイル名を、パーミッションを 0600 に設定し、 指定したディレクトリに作成します。
  指定したディレクトリが存在しない場合やディレクトリに書き込めない場合は、<strong>tempnam()</strong> はシステムのテン
  ポラリディレクトリにあるファイル名を生成し、 そのファイルへのフルパスを (名前を含めて) 返します。

<comment>Param:</comment>
  <info>string</info>  <strong>$directory</strong>  テンポラリファイルを作成したいディレクトリ。
  <info>string</info>  <strong>$prefix</strong>     作成されるテンポラリファイルのプレフィックス。
                      
                      プレフィックスの最初の63文字のみを使用し、残りは無視されます。 Windows では、
                      プレフィックスの最初の 3 文字のみを使用します。

<comment>Return:</comment>
  <info>string|false</info>  新しいテンポラリファイル名 (パスを含む) を返し、失敗した場合には <info>false</info> を返します。

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


id: textdomain
type: function
doc:
<comment>Description:</comment>
  デフォルトドメインを設定する
  
  この関数は、<strong>gettext()</strong> がコールされた際に検索を 行うドメインを設定します。このドメインは、通常はア
  プリケーション名から 付けられます。

<comment>Param:</comment>
  <info></info>  <strong>$domain</strong>  新しいメッセージドメイン。<info>null</info> を指定すると、現在の設定をそのまま 取得し、変更しませ
             ん。

<comment>Return:</comment>
  <info>string</info>  成功すると、この関数はドメインを変更した後に現在のメッセージドメインを 返します。


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

<comment>Param:</comment>
  <info>string|null</info>        <strong>$filename</strong>        もし <strong>$filename</strong> パラメータが与えられた場合、 この関数はファイル
                                      を読み込み、<strong>tidy_parse_file()</strong> のように実行してファイルに基づい
                                      たオブジェクトを初期化します。
  <info>array|string|null</info>  <strong>$config</strong>          <strong>$config</strong> には配列あるいは文字列を渡します。 文字列を渡した場合
                                      は設定ファイルの名前、 それ以外の場合は設定そのものとして解釈
                                      されます。
                                      
                                      オプションについての説明は
                                      http://api.html-tidy.org/#quick-reference を参照ください。
  <info>string|null</info>        <strong>$encoding</strong>        <strong>$encoding</strong> は入出力ドキュメントのエンコーディングを設定します。
                                      指定できるエンコーディング名は <return>ascii</return>、<return>latin0</return>、<return>latin1</return>、 <return>raw</return>、
                                      <return>utf8</return>、<return>iso2022</return>、 <return>mac</return>、<return>win1252</return>、<return>ibm858</return>、 <return>utf16</return>、<return>utf16le</return>、
                                      <return>utf16be</return>、 <return>big5</return> および <return>shiftjis</return> です。
  <info>bool</info>               <strong>$useIncludePath</strong>  include_path からファイルを探します。

<comment>See Also:</comment>
   * <strong>tidy::parseFile()</strong>
   * <strong>tidy::parseString()</strong>


id: tidy::body
type: function
doc:
<comment>Description:</comment>
  Tidy パースツリーの  タグから始まる tidyNode オブジェクトを返す
  
  オブジェクト指向型
  
  手続き型
  
  Tidy パースツリーの \<body&gt; タグから始まる <class>tidyNode</class> オブジェクトを返します。

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

<comment>Return:</comment>
  <info>tidyNode|null</info>  tidy パースツリーの \<body&gt; タグから始まる <class>tidyNode</class> オブジェクトを返します。

<comment>See Also:</comment>
   * <strong>tidy::head()</strong>
   * <strong>tidy::html()</strong>


id: tidy::cleanRepair
type: function
doc:
<comment>Description:</comment>
  パースされたマークアップに設定に基く誤りの修正を行う
  
  オブジェクト指向型
  
  手続き型
  
  この関数は、与えられた Tidy オブジェクト <strong>$tidy</strong> を修正します。

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

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

<comment>See Also:</comment>
   * <strong>tidy::repairFile()</strong>
   * <strong>tidy::repairString()</strong>


id: tidy::diagnose
type: function
doc:
<comment>Description:</comment>
  パース、修正されたマークアップの診断を行う
  
  オブジェクト指向型
  
  手続き型
  
  与えられた Tidy オブジェクト <strong>$tidy</strong> に対して診断テストを実行し、 エラーバッファにドキュメントについ
  ての情報を追加します。

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

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

<comment>See Also:</comment>
   * <strong>tidy::errorBuffer()</strong>


id: tidy::getConfig
type: function
doc:
<comment>Description:</comment>
  現在の Tidy の設定を取得する
  
  オブジェクト指向型
  
  手続き型
  
  与えられた Tidy オブジェクト <strong>$tidy</strong> で使用されている設定オプションを配列で返します。

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

<comment>Return:</comment>
  <info>array</info>  設定オプションの配列を返します。
         
         それぞれのオプションの説明については、http://api.html-tidy.org/#quick-reference を参照くだ
         さい。

<comment>See Also:</comment>
   * <strong>tidy_reset_config()</strong>
   * <strong>tidy_save_config()</strong>


id: tidy::getHtmlVer
type: function
doc:
<comment>Description:</comment>
  指定したドキュメントで検出された HTML バージョンを取得する
  
  オブジェクト指向型
  
  手続き型
  
  指定した Tidy オブジェクト <strong>$tidy</strong> で検出された HTML バージョンを返します。

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

<comment>Return:</comment>
  <info>int</info>  出された HTML バージョンを返します。
       
       この関数は Tidylib 自体でまだ実装されていません。そのため常に <return>0</return> を返します。


id: tidy::getOpt
type: function
doc:
<comment>Description:</comment>
  Tidy ドキュメントについて指定した設定オプションの値を返す
  
  オブジェクト指向型
  
  手続き型
  
  Tidy オブジェクト <strong>$tidy</strong> について指定した設定オプション <strong>$option</strong> の値を返します。

<comment>Param:</comment>
  <info>tidy</info>    <strong>$tidy</strong>    <class>Tidy</class> オブジェクト。
  <info>string</info>  <strong>$option</strong>  それぞれの設定オプションと型の一覧は、http://api.html-tidy.org/#quick-reference
                   にあります。

<comment>Return:</comment>
  <info>string|int|bool</info>  指定した設定オプション <strong>$option</strong> の値を返します。 返される型は、設定オプションの型
                   に依存します。


id: tidy::getOptDoc
type: function
doc:
<comment>Description:</comment>
  与えられたオプション名に対するドキュメントを返す
    
  
  オブジェクト指向型
  
  手続き型
  
  <strong>tidy_get_opt_doc()</strong> は、 与えられたオプション名に対するドキュメントを返します。
  
  この関数を有効にするには、少なくとも2005年4月25日以降の libtidy が必要です。

<comment>Param:</comment>
  <info>tidy</info>    <strong>$tidy</strong>    <class>Tidy</class> オブジェクト。
  <info>string</info>  <strong>$option</strong>  オプション名。

<comment>Return:</comment>
  <info>string|false</info>  オプションが存在し、かつドキュメントが利用可能であれば、文字列を返します。 その他の
                場合は <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>tidy::getconfig()</strong>
   * <strong>tidy::getopt()</strong>


id: tidy::getRelease
type: function
doc:
<comment>Description:</comment>
  Tidy ライブラリのリリース日 (バージョン) を取得する
  
  オブジェクト指向型
  
  手続き型
  
  Tidy ライブラリのリリース日を取得します。

<comment>Return:</comment>
  <info>string</info>  Tidy ライブラリのリリース日を文字列で返します。 'unknown' が返される可能性もあります。


id: tidy::getStatus
type: function
doc:
<comment>Description:</comment>
  指定したドキュメントのステータスを取得する
  
  オブジェクト指向型
  
  手続き型
  
  指定した Tidy オブジェクト <strong>$tidy</strong> のステータスを返します。

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

<comment>Return:</comment>
  <info>int</info>  エラー/警告が発生しなかった場合は 0、 警告やアクセイシビリティエラーの場合は 1、 エラーの場合
       は 2 を返します。


id: tidy::head
type: function
doc:
<comment>Description:</comment>
  Tidy パースツリーの  タグから始まる tidyNode オブジェクトを返す
  
  オブジェクト指向型
  
  手続き型
  
  Tidy パースツリーの \<head&gt; タグから始まる <class>tidyNode</class> オブジェクトを返します。

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

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

<comment>See Also:</comment>
   * <strong>tidy::body()</strong>
   * <strong>tidy::html()</strong>


id: tidy::html
type: function
doc:
<comment>Description:</comment>
  Tidy パースツリーの  タグから始まる tidyNode オブジェクトを返す
  
  オブジェクト指向型
  
  手続き型
  
  この関数は Tidy パースツリーの \<html&gt; タグから始まる <class>tidyNode</class> オブジェクトを返します。

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

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

<comment>See Also:</comment>
   * <strong>tidy::body()</strong>
   * <strong>tidy::head()</strong>


id: tidy::isXhtml
type: function
doc:
<comment>Description:</comment>
  ドキュメントが XHTML ドキュメントかどうかを示す
  
  オブジェクト指向型
  
  手続き型
  
  ドキュメントが XHTML ドキュメントであるかどうかを調べます。

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

<comment>Return:</comment>
  <info>bool</info>  指定した Tidy オブジェクト <strong>$tidy</strong> が XHTML ドキュメントの場合、この関数は <info>true</info> を返します。
        その他の場合は <info>false</info> を返します。
        
        この関数はまだ Tidylib 自身に実装されていません。 なので、常に <info>false</info> を返します。


id: tidy::isXml
type: function
doc:
<comment>Description:</comment>
  ドキュメントが一般的な XML ドキュメント (非 HTML/XHTML) かどうかを示す
  
  オブジェクト指向型
  
  手続き型
  
  ドキュメントが一般的な XML ドキュメント (非 HTML/XHTML) かどうかを調べます。

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

<comment>Return:</comment>
  <info>bool</info>  指定した Tidy オブジェクト <strong>$tidy</strong> が一般的な XML ドキュメント (非 HTML/XHTML) の場合、 この関
        数は <info>true</info> を返します。 その他の場合は <info>false</info> を返します。
        
        この関数はまだ Tidylib 自身に実装されていません。 なので、常に <info>false</info> を返します。


id: tidy::parseFile
type: function
doc:
<comment>Description:</comment>
  ファイルまたは URI にあるマークアップをパースする
  
  オブジェクト指向型
  
  手続き型
  
  与えられたファイルをパースします。

<comment>Param:</comment>
  <info>string</info>             <strong>$filename</strong>        もし <strong>$filename</strong> パラメータが与えられた場合、 この関数はファイル
                                      を読み込み、<strong>tidy_parse_file()</strong> のように実行してファイルに基づい
                                      たオブジェクトを初期化します。
  <info>array|string|null</info>  <strong>$config</strong>          <strong>$config</strong> には配列あるいは文字列を渡します。 文字列を渡した場合
                                      は設定ファイルの名前、 それ以外の場合は設定そのものとして解釈
                                      されます。
                                      
                                      オプションについての説明は
                                      http://api.html-tidy.org/#quick-reference を参照ください。
  <info>string|null</info>        <strong>$encoding</strong>        <strong>$encoding</strong> は入出力ドキュメントのエンコーディングを設定します。
                                      指定できるエンコーディング名は <return>ascii</return>、<return>latin0</return>、<return>latin1</return>、 <return>raw</return>、
                                      <return>utf8</return>、<return>iso2022</return>、 <return>mac</return>、<return>win1252</return>、<return>ibm858</return>、 <return>utf16</return>、<return>utf16le</return>、
                                      <return>utf16be</return>、 <return>big5</return> および <return>shiftjis</return> です。
  <info>bool</info>               <strong>$useIncludePath</strong>  include_path からファイルを探します。

<comment>Return:</comment>
  <info>bool</info>  tidy::parseFile は成功時に <info>true</info> を返します。 <strong>tidy_parse_file()</strong> は、成功時に新しい <class>tidy</class> イン
        スタンスを返します。 これらのメソッド、関数は、ともに失敗時に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>tidy::parsestring()</strong>
   * <strong>tidy::repairfile()</strong>
   * <strong>tidy::repairstring()</strong>


id: tidy::parseString
type: function
doc:
<comment>Description:</comment>
  文字列にストアされたドキュメントをパースする
  
  オブジェクト指向型
  
  手続き型
  
  文字列にストアされたドキュメントをパースします。

<comment>Param:</comment>
  <info>string</info>             <strong>$string</strong>    パースするデータ。
  <info>array|string|null</info>  <strong>$config</strong>    <strong>$config</strong> には配列あるいは文字列を渡します。 文字列を渡した場合は設定
                                ファイルの名前、 それ以外の場合は設定そのものとして解釈されます。
                                
                                オプションについての説明は http://api.html-tidy.org/#quick-reference
                                を参照ください。
  <info>string|null</info>        <strong>$encoding</strong>  <strong>$encoding</strong> は入出力ドキュメントのエンコーディングを設定します。 指定
                                できるエンコーディング名は <return>ascii</return>、<return>latin0</return>、<return>latin1</return>、 <return>raw</return>、<return>utf8</return>、
                                <return>iso2022</return>、 <return>mac</return>、<return>win1252</return>、<return>ibm858</return>、 <return>utf16</return>、<return>utf16le</return>、<return>utf16be</return>、 <return>big5</return> およ
                                び <return>shiftjis</return> です。

<comment>Return:</comment>
  <info>bool</info>  新しい <class>tidy</class> インスタンスを返します。 <strong>tidy_parse_string()</strong> は、成功時に新しい <class>tidy</class> インスタン
        スを返します。 これらのメソッド、関数は、失敗時に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>tidy::parseFile()</strong>
   * <strong>tidy::repairFile()</strong>
   * <strong>tidy::repairString()</strong>


id: tidy::repairFile
type: function
doc:
<comment>Description:</comment>
  ファイルを修正し、それを文字列として返す
  
  オブジェクト指向型
  
  手続き型
  
  与えられたファイルを修正し、それを文字列として返します。

<comment>Param:</comment>
  <info>string</info>             <strong>$filename</strong>        修正するファイル。
  <info>array|string|null</info>  <strong>$config</strong>          <strong>$config</strong> には配列あるいは文字列を渡します。 文字列を渡した場合
                                      は設定ファイルの名前、 それ以外の場合は設定そのものとして解釈
                                      されます。
                                      
                                      オプションについての説明は
                                      http://tidy.sourceforge.net/docs/quickref.html を参照くださ
                                      い。
  <info>string|null</info>        <strong>$encoding</strong>        <strong>$encoding</strong> は入出力ドキュメントのエンコーディングを設定します。
                                      指定できるエンコーディング名は <return>ascii</return>、<return>latin0</return>、<return>latin1</return>、 <return>raw</return>、
                                      <return>utf8</return>、<return>iso2022</return>、 <return>mac</return>、<return>win1252</return>、<return>ibm858</return>、 <return>utf16</return>、<return>utf16le</return>、
                                      <return>utf16be</return>、 <return>big5</return> および <return>shiftjis</return> です。
  <info>bool</info>               <strong>$useIncludePath</strong>  include_path からファイルを探します。

<comment>Return:</comment>
  <info>string|false</info>  修正した内容を文字列で返します。

<comment>See Also:</comment>
   * <strong>tidy::parseFile()</strong>
   * <strong>tidy::parseString()</strong>
   * <strong>tidy::repairString()</strong>


id: tidy::repairString
type: function
doc:
<comment>Description:</comment>
  別途提供される設定ファイルを使用して文字列を修正する
  
  オブジェクト指向型
  
  手続き型
  
  与えられた文字列を修正します。

<comment>Param:</comment>
  <info>string</info>             <strong>$string</strong>    修正するデータ。
  <info>array|string|null</info>  <strong>$config</strong>    <strong>$config</strong> には配列あるいは文字列を渡します。 文字列を渡した場合は設定
                                ファイルの名前、 それ以外の場合は設定そのものとして解釈されます。
                                
                                オプションについての説明は http://api.html-tidy.org/#quick-reference
                                を参照ください。
  <info>string|null</info>        <strong>$encoding</strong>  <strong>$encoding</strong> は入出力ドキュメントのエンコーディングを設定します。 指定
                                できるエンコーディング名は <return>ascii</return>、<return>latin0</return>、<return>latin1</return>、 <return>raw</return>、<return>utf8</return>、
                                <return>iso2022</return>、 <return>mac</return>、<return>win1252</return>、<return>ibm858</return>、 <return>utf16</return>、<return>utf16le</return>、<return>utf16be</return>、 <return>big5</return> およ
                                び <return>shiftjis</return> です。

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

<comment>See Also:</comment>
   * <strong>tidy::parseFile()</strong>
   * <strong>tidy::parseString()</strong>
   * <strong>tidy::repairFile()</strong>


id: tidy::root
type: function
doc:
<comment>Description:</comment>
  Tidy パースツリーのルートを表す tidyNode を返す
  
  オブジェクト指向型
  
  手続き型
  
  Tidy パースツリーのルートを表す <class>tidyNode</class> を返します。

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

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


id: tidyNode::getParent
type: function
doc:
<comment>Description:</comment>
  カレントノードの親ノードを返す
  
  カレントノードの親ノードを返します。

<comment>Return:</comment>
  <info>tidyNode|null</info>  そのノードが親を持っている場合に <info>tidyNode</info>、 それ以外の場合に <info>null</info> を返します。


id: tidyNode::hasChildren
type: function
doc:
<comment>Description:</comment>
  ノードが子を持つかどうかを調べる
  
  ノードが子を持つかどうかを調べます。

<comment>Return:</comment>
  <info>bool</info>  ノードが子を持つ場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。


id: tidyNode::hasSiblings
type: function
doc:
<comment>Description:</comment>
  このノードが兄弟ノードを持つかどうかを調べる
  
  ノードが兄弟ノードを持つかどうかを調べます。

<comment>Return:</comment>
  <info>bool</info>  兄弟ノードを持つ場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。


id: tidyNode::isAsp
type: function
doc:
<comment>Description:</comment>
  このノードが ASP かどうかを調べる
  
  現在のノードが ASP かどうかを調べます。

<comment>Return:</comment>
  <info>bool</info>  ノードが ASP の場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。


id: tidyNode::isComment
type: function
doc:
<comment>Description:</comment>
  このノードがコメントを表すものかどうかを調べる
  
  このノードがコメントであるかどうかを調べます。

<comment>Return:</comment>
  <info>bool</info>  このノードがコメントである場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。


id: tidyNode::isHtml
type: function
doc:
<comment>Description:</comment>
  このノードが HTML要素 であるかどうかを調べる
  
  このノードが ルート要素 以外の HTML要素 であるかを調べます。

<comment>Return:</comment>
  <info>bool</info>  ノードが ルート要素 以外の HTML要素 である場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。


id: tidyNode::isJste
type: function
doc:
<comment>Description:</comment>
  このノードが JSTE であるかどうかを調べる
  
  このノードが JSTE であるかどうかを調べます。

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


id: tidyNode::isPhp
type: function
doc:
<comment>Description:</comment>
  このノードが PHP であるかどうかを調べる
  
  このノードが PHP であるかどうかを調べます。

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


id: tidyNode::isText
type: function
doc:
<comment>Description:</comment>
  このノードが (マークアップでない) テキストであるかどうかを調べる
  
  このノードが (マークアップされていない) テキストであるかどうかを調べます。

<comment>Return:</comment>
  <info>bool</info>  ノードがテキストを著す場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。


id: tidy_access_count
type: function
doc:
<comment>Description:</comment>
  指定したドキュメントについて発生したTidyアクセシビリティ警告の数を返す
  
  <strong>tidy_access_count()</strong> は、 指定したドキュメントについて発生した Tidy アクセシビリティ警告の数を返し
  ます。

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

<comment>Return:</comment>
  <info>int</info>  警告の数を返します。

<comment>See Also:</comment>
   * <strong>tidy_error_count()</strong>
   * <strong>tidy_warning_count()</strong>


id: tidy_config_count
type: function
doc:
<comment>Description:</comment>
  指定したドキュメントについて発生した Tidy 設定エラーの数を返す
  
  指定した Tidy オブジェクト <strong>$tidy</strong> の設定時に発生した Tidy エラーの数を返します。

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

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


id: tidy_error_count
type: function
doc:
<comment>Description:</comment>
  指定したドキュメントについて発生した Tidy エラーの数を返す
  
  指定したドキュメントについて発生した Tidy エラーの数を返します。

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

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

<comment>See Also:</comment>
   * <strong>tidy_access_count()</strong>
   * <strong>tidy_warning_count()</strong>


id: tidy_get_error_buffer
type: function
doc:
<comment>Description:</comment>
  指定したドキュメントのパースで発生した警告とエラーを返す
  
  オブジェクト指向型 (プロパティ):
  
  手続き型:
  
  指定したドキュメントのパースで発生した警告とエラーを返します。

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

<comment>Return:</comment>
  <info>string|false</info>  エラーバッファを文字列で返します。 バッファが空の場合は <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>tidy_access_count()</strong>
   * <strong>tidy_error_count()</strong>
   * <strong>tidy_warning_count()</strong>


id: tidy_get_output
type: function
doc:
<comment>Description:</comment>
  パースされた Tidy マークアップを表す文字列を返す
  
  修正された HTML を文字列で返します。

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

<comment>Return:</comment>
  <info>string</info>  修正された HTML を文字列で返します。


id: tidy_warning_count
type: function
doc:
<comment>Description:</comment>
  指定したドキュメントについて発生した Tidy 警告の数を返す
  
  指定したドキュメントについて発生した Tidy 警告の数を返します。

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

<comment>Return:</comment>
  <info>int</info>  警告の数を返します。

<comment>See Also:</comment>
   * <strong>tidy_error_count()</strong>
   * <strong>tidy_access_count()</strong>


id: time
type: function
doc:
<comment>Description:</comment>
  現在の Unix タイムスタンプを返す
  
  現在時刻を Unix エポック (1970 年 1 月 1 日 00:00:00 GMT) からの通算秒として返します。
  
  Unixタイムスタンプは、ローカルタイムゾーンに関する情報を含んでいません。 Unixタイムスタンプに付随
  する落とし穴を避けつつ、 日付/時刻に関する情報を扱うために <class>DateTimeImmutable</class> を使うことを推奨しま
  す。

<comment>Return:</comment>
  <info>int</info>  現在のタイムスタンプを返します。

<comment>See Also:</comment>
   * <class>DateTimeImmutable</class>
   * <strong>date()</strong>
   * <strong>microtime()</strong>


id: time_nanosleep
type: function
doc:
<comment>Description:</comment>
  秒およびナノ秒単位で実行を遅延する
  
  指定した <strong>$seconds</strong> および <strong>$nanoseconds</strong> の時間だけプログラムの実行を遅延させます。

<comment>Param:</comment>
  <info>int</info>  <strong>$seconds</strong>      非負の整数である必要があります。
  <info>int</info>  <strong>$nanoseconds</strong>  十億よりも小さい非負の整数である必要があります。
                     
                     Windows では、与えられたナノ秒以上に長くスリープする可能性があります。 動作は
                     ハードウェア依存です。

<comment>Return:</comment>
  <info>array|bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。
              
              シグナルによって遅延処理が中断された場合、以下の要素からなる連想配列を返します。
              <return>seconds</return> - 残りの秒数 <return>nanoseconds</return> - 残りのナノ秒数
              
              <return>seconds</return> - 残りの秒数
              
              <return>nanoseconds</return> - 残りのナノ秒数

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


id: time_sleep_until
type: function
doc:
<comment>Description:</comment>
  指定した時刻まで実行を遅延する
    
  
  指定した <strong>$timestamp</strong> までスクリプトの実行を遅延させます。

<comment>Param:</comment>
  <info>float</info>  <strong>$timestamp</strong>  スクリプトが再開する時刻。

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

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


id: timezone_abbreviations_list
type: function
doc:
<comment>Description:</comment>
  DateTimeZone::listAbbreviations のエイリアス
  
  この関数は次の関数のエイリアスです。 DateTimeZone::listAbbreviations


id: timezone_identifiers_list
type: function
doc:
<comment>Description:</comment>
  DateTimeZone::listIdentifiers のエイリアス
  
  この関数は次の関数のエイリアスです。 DateTimeZone::listIdentifiers


id: timezone_location_get
type: function
doc:
<comment>Description:</comment>
  DateTimeZone::getLocation のエイリアス
  
  この関数は次の関数のエイリアスです。 DateTimeZone::getLocation


id: timezone_name_from_abbr
type: function
doc:
<comment>Description:</comment>
  略称とUTCオフセットから、タイムゾーン名を推測して返す

<comment>Param:</comment>
  <info>string</info>  <strong>$abbr</strong>       タイムゾーンの略称。
  <info>int</info>     <strong>$utcOffset</strong>  GMT からのオフセット秒数。デフォルトは -1 で、 この場合は <strong>$abbr</strong> に対応するタイ
                      ムゾーンのうち最初に見つかったものを返します。 それ以外の場合は指定したオフ
                      セットを探し、 そこで見つからなかった場合には 他のオフセットも含めて最初に見つ
                      かったものを返します。
  <info>int</info>     <strong>$isDST</strong>      夏時間のインジケータ。デフォルトは -1 で、 タイムゾーンが夏時間を持っているか
                      どうかは考慮せずに検索します。 この値を 1 にすると、<strong>$utcOffset</strong> は夏時間を考慮
                      したオフセットと見なします。 0 の場合は、<strong>$utcOffset</strong> は夏時間を考慮しないオフ
                      セットと見なします。 <strong>$abbr</strong> が存在しない場合、 タイムゾーンの検索は <strong>$utcOffset</strong>
                      と <strong>$isDST</strong> だけで行います。

<comment>Return:</comment>
  <info>string|false</info>  成功した場合にタイムゾーン名、失敗した場合に <info>false</info> を返します。

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


id: timezone_name_get
type: function
doc:
<comment>Description:</comment>
  DateTimeZone::getName のエイリアス
  
  この関数は次の関数のエイリアスです。 DateTimeZone::getName


id: timezone_offset_get
type: function
doc:
<comment>Description:</comment>
  DateTimeZone::getOffset のエイリアス
  
  この関数は次の関数のエイリアスです。 DateTimeZone::getOffset


id: timezone_open
type: function
doc:
<comment>Description:</comment>
  DateTimeZone::__construct のエイリアス
  
  この関数は次の関数のエイリアスです。 DateTimeZone::__construct


id: timezone_transitions_get
type: function
doc:
<comment>Description:</comment>
  DateTimeZone::getTransitions のエイリアス
  
  この関数は次の関数のエイリアスです。 DateTimeZone::getTransitions


id: timezone_version_get
type: function
doc:
<comment>Description:</comment>
  timezonedb のバージョンを取得する
    
  
  timezonedb の現在のバージョンを返します。

<comment>Return:</comment>
  <info>string</info>  <return>2022.2</return> のような、 <return>YYYY.increment</return> のフォーマットを文字列で返します。
          
          古いバージョンのタイムゾーンデータベースを持っている場合 (たとえば、今年のバージョンが表示
          されない場合)、 タイムゾーンの情報は PHP のバージョンを上げるか、 PECL パッケージの
          timezonedb をインストールすることで更新することができます。
          
          Linux ディストリビューションによっては、 他のタイムゾーンの情報ソースを使うように PHP の
          date/time サポートにパッチをあてているものがあります。その場合、この関数は <return>0.system</return>  とい
          う値を返します。 この場合も、PECL パッケージの timezonedb をインストールすることをお勧めし
          ます。

<comment>See Also:</comment>
   * サポートするタイムゾーンの一覧


id: tmpfile
type: function
doc:
<comment>Description:</comment>
  テンポラリファイルを作成する
  
  読み書き可、かつバイナリモード (w+b) でユニークな名前を有するテンポラリファイルを作成し、 ファイル
  ハンドルを返します。
  
  (<strong>fclose()</strong>を呼んだり、<strong>tmpfile()</strong> が返すファイルハンドルへの参照がなくなったりして) ファイルをクロー
  ズした場合や、スクリプトが終了したりしたときに、このファイルは自動的に削除されます。
  
  スクリプトが予期せず終了した場合、テンポラリファイルが削除されないかもしれません。

<comment>Return:</comment>
  <info>resource|false</info>  ファイルのハンドルを返します。 これは、 <strong>fopen()</strong> により返されるハンドルと同じもので
                  す。 失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>tempnam()</strong>
   * <strong>sys_get_temp_dir()</strong>


id: token_get_all
type: function
doc:
<comment>Description:</comment>
  指定したソースを PHP トークンに分割する
  
  <strong>token_get_all()</strong> は指定した文字列 <strong>$code</strong> をパースし、Zend engine の 字句解析スキャナにより PHP 言語
  のトークンに分割します。
  
  パーサトークンの一覧を得るには、 を参照するか、 あるいは <strong>token_name()</strong> でトークン値を文字列表現に
  変換します。

<comment>Param:</comment>
  <info>string</info>  <strong>$code</strong>   パースする PHP ソース。
  <info>int</info>     <strong>$flags</strong>  以下のフラグが使えます。 <info>TOKEN_PARSE</info> - 特定のコンテキストで予約語を使った場合に、
                  それを認識する。
                  
                  <info>TOKEN_PARSE</info> - 特定のコンテキストで予約語を使った場合に、それを認識する。

<comment>Return:</comment>
  <info>array</info>  トークン ID の配列を返します。配列の各要素には、一文字単位の文字列 (例: <return>;</return>、<return>.</return>、 <return>&gt;</return>、<return>!</return> な
         ど...)、 またはトークンのインデックスを 0 番目の要素、トークンの文字列表現を 1 番目の要素、
         行番号を 2 番目の要素とする配列が含まれます。

<comment>See Also:</comment>
   * <strong>PhpToken::tokenize()</strong>
   * <strong>token_name()</strong>


id: token_name
type: function
doc:
<comment>Description:</comment>
  指定した PHP トークンのシンボル名を取得する
  
  <strong>token_name()</strong>は、PHP <strong>$id</strong> 値のシンボル名を返します。

<comment>Param:</comment>
  <info>int</info>  <strong>$id</strong>  トークンの値。

<comment>Return:</comment>
  <info>string</info>  <strong>$id</strong> に対応するシンボル名を返します。

<comment>See Also:</comment>
   * パーサトークンの一覧
   * <strong>PhpToken::getTokenName()</strong>


id: touch
type: function
doc:
<comment>Description:</comment>
  ファイルの最終アクセス時刻および最終更新日をセットする
  
  <strong>$filename</strong> で指定されたファイルの最終更新日を、 <strong>$mtime</strong> で指定された値に セットしようと試みます。 パ
  ラメータの数にかかわらず、アクセス時刻は 常に変更されることに注意しましょう。
  
  ファイルが存在しない場合、ファイルが生成されます。

<comment>Param:</comment>
  <info>string</info>    <strong>$filename</strong>  処理したいファイルの名前。
  <info>int|null</info>  <strong>$mtime</strong>     設定する時刻。 <strong>$mtime</strong> が <info>null</info> の場合は、 現在時刻 (<strong>time()</strong>) を使用します。
  <info>int|null</info>  <strong>$atime</strong>     この値が <info>null</info> でない場合、 指定されたファイルの最終アクセス時刻が <strong>$atime</strong> に
                       セットされます。 存在しない場合は <strong>$mtime</strong> に渡した値となります。 どちらも <info>null</info>
                       の場合は、現在のシステム時刻を使います。

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


id: trader_acos
type: function
doc:
<comment>Description:</comment>
  Vector Trigonometric ACos
  
  Calculates the arc cosine for each value in <strong>$real</strong> and returns the resulting array.

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>  実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_ad
type: function
doc:
<comment>Description:</comment>
  Chaikin A/D Line

<comment>Param:</comment>
  <info>array</info>  <strong>$high</strong>    高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>     安値。実数値の配列。
  <info>array</info>  <strong>$close</strong>   終値。実数値の配列。
  <info>array</info>  <strong>$volume</strong>  取引高。実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_add
type: function
doc:
<comment>Description:</comment>
  Vector Arithmetic Add
  
  Calculates the vector addition of <strong>$real0</strong> to <strong>$real1</strong> and returns the resulting vector.

<comment>Param:</comment>
  <info>array</info>  <strong>$real0</strong>  実数値の配列。
  <info>array</info>  <strong>$real1</strong>  実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_adosc
type: function
doc:
<comment>Description:</comment>
  Chaikin A/D Oscillator

<comment>Param:</comment>
  <info>array</info>  <strong>$high</strong>        高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>         安値。実数値の配列。
  <info>array</info>  <strong>$close</strong>       終値。実数値の配列。
  <info>array</info>  <strong>$volume</strong>      取引高。実数値の配列。
  <info>int</info>    <strong>$fastPeriod</strong>  Number of period for the fast MA. Valid range from 2 to 100000.
  <info>int</info>    <strong>$slowPeriod</strong>  Number of period for the slow MA. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_adx
type: function
doc:
<comment>Description:</comment>
  Average Directional Movement Index

<comment>Param:</comment>
  <info>array</info>  <strong>$high</strong>        高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>         安値。実数値の配列。
  <info>array</info>  <strong>$close</strong>       終値。実数値の配列。
  <info>int</info>    <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_adxr
type: function
doc:
<comment>Description:</comment>
  Average Directional Movement Index Rating

<comment>Param:</comment>
  <info>array</info>  <strong>$high</strong>        高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>         安値。実数値の配列。
  <info>array</info>  <strong>$close</strong>       終値。実数値の配列。
  <info>int</info>    <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_apo
type: function
doc:
<comment>Description:</comment>
  Absolute Price Oscillator

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>        実数値の配列。
  <info>int</info>    <strong>$fastPeriod</strong>  Number of period for the fast MA. Valid range from 2 to 100000.
  <info>int</info>    <strong>$slowPeriod</strong>  Number of period for the slow MA. Valid range from 2 to 100000.
  <info>int</info>    <strong>$mAType</strong>      Type of Moving Average. TRADER_MA_TYPE_* series of constants should be used.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_aroon
type: function
doc:
<comment>Description:</comment>
  Aroon

<comment>Param:</comment>
  <info>array</info>  <strong>$high</strong>        高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>         安値。実数値の配列。
  <info>int</info>    <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_aroonosc
type: function
doc:
<comment>Description:</comment>
  Aroon Oscillator

<comment>Param:</comment>
  <info>array</info>  <strong>$high</strong>        高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>         安値。実数値の配列。
  <info>int</info>    <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_asin
type: function
doc:
<comment>Description:</comment>
  Vector Trigonometric ASin
  
  Calculates the arc sine for each value in <strong>$real</strong> and returns the resulting array.

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>  実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_atan
type: function
doc:
<comment>Description:</comment>
  Vector Trigonometric ATan
  
  Calculates the arc tangent for each value in <strong>$real</strong> and returns the resulting array.

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>  実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_atr
type: function
doc:
<comment>Description:</comment>
  Average True Range

<comment>Param:</comment>
  <info>array</info>  <strong>$high</strong>        高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>         安値。実数値の配列。
  <info>array</info>  <strong>$close</strong>       終値。実数値の配列。
  <info>int</info>    <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_avgprice
type: function
doc:
<comment>Description:</comment>
  Average Price

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   始値。実数値の配列。
  <info>array</info>  <strong>$high</strong>   高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>    安値。実数値の配列。
  <info>array</info>  <strong>$close</strong>  終値。実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_bbands
type: function
doc:
<comment>Description:</comment>
  Bollinger Bands

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>        実数値の配列。
  <info>int</info>    <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.
  <info>float</info>  <strong>$nbDevUp</strong>     Deviation multiplier for upper band. Valid range from TRADER_REAL_MIN to
                      TRADER_REAL_MAX.
  <info>float</info>  <strong>$nbDevDn</strong>     Deviation multiplier for lower band. Valid range from TRADER_REAL_MIN to
                      TRADER_REAL_MAX.
  <info>int</info>    <strong>$mAType</strong>      Type of Moving Average. TRADER_MA_TYPE_* series of constants should be used.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_beta
type: function
doc:
<comment>Description:</comment>
  Beta

<comment>Param:</comment>
  <info>array</info>  <strong>$real0</strong>       実数値の配列。
  <info>array</info>  <strong>$real1</strong>       実数値の配列。
  <info>int</info>    <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_bop
type: function
doc:
<comment>Description:</comment>
  Balance Of Power

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   始値。実数値の配列。
  <info>array</info>  <strong>$high</strong>   高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>    安値。実数値の配列。
  <info>array</info>  <strong>$close</strong>  終値。実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cci
type: function
doc:
<comment>Description:</comment>
  Commodity Channel Index

<comment>Param:</comment>
  <info>array</info>  <strong>$high</strong>        高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>         安値。実数値の配列。
  <info>array</info>  <strong>$close</strong>       終値。実数値の配列。
  <info>int</info>    <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdl2crows
type: function
doc:
<comment>Description:</comment>
  Two Crows

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   始値。実数値の配列。
  <info>array</info>  <strong>$high</strong>   高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>    安値。実数値の配列。
  <info>array</info>  <strong>$close</strong>  終値。実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdl3blackcrows
type: function
doc:
<comment>Description:</comment>
  Three Black Crows

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   始値。実数値の配列。
  <info>array</info>  <strong>$high</strong>   高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>    安値。実数値の配列。
  <info>array</info>  <strong>$close</strong>  終値。実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdl3inside
type: function
doc:
<comment>Description:</comment>
  Three Inside Up/Down

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   始値。実数値の配列。
  <info>array</info>  <strong>$high</strong>   高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>    安値。実数値の配列。
  <info>array</info>  <strong>$close</strong>  終値。実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdl3linestrike
type: function
doc:
<comment>Description:</comment>
  Three-Line Strike

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   始値。実数値の配列。
  <info>array</info>  <strong>$high</strong>   高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>    安値。実数値の配列。
  <info>array</info>  <strong>$close</strong>  終値。実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdl3outside
type: function
doc:
<comment>Description:</comment>
  Three Outside Up/Down

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   始値。実数値の配列。
  <info>array</info>  <strong>$high</strong>   高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>    安値。実数値の配列。
  <info>array</info>  <strong>$close</strong>  終値。実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdl3starsinsouth
type: function
doc:
<comment>Description:</comment>
  Three Stars In The South

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   始値。実数値の配列。
  <info>array</info>  <strong>$high</strong>   高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>    安値。実数値の配列。
  <info>array</info>  <strong>$close</strong>  終値。実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdl3whitesoldiers
type: function
doc:
<comment>Description:</comment>
  Three Advancing White Soldiers

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   始値。実数値の配列。
  <info>array</info>  <strong>$high</strong>   高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>    安値。実数値の配列。
  <info>array</info>  <strong>$close</strong>  終値。実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlabandonedbaby
type: function
doc:
<comment>Description:</comment>
  Abandoned Baby

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>         始値。実数値の配列。
  <info>array</info>  <strong>$high</strong>         高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>          安値。実数値の配列。
  <info>array</info>  <strong>$close</strong>        終値。実数値の配列。
  <info>float</info>  <strong>$penetration</strong>  Percentage of penetration of a candle within another candle.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdladvanceblock
type: function
doc:
<comment>Description:</comment>
  Advance Block

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   始値。実数値の配列。
  <info>array</info>  <strong>$high</strong>   高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>    安値。実数値の配列。
  <info>array</info>  <strong>$close</strong>  終値。実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlbelthold
type: function
doc:
<comment>Description:</comment>
  Belt-hold

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   始値。実数値の配列。
  <info>array</info>  <strong>$high</strong>   高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>    安値。実数値の配列。
  <info>array</info>  <strong>$close</strong>  終値。実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlbreakaway
type: function
doc:
<comment>Description:</comment>
  Breakaway

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   始値。実数値の配列。
  <info>array</info>  <strong>$high</strong>   高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>    安値。実数値の配列。
  <info>array</info>  <strong>$close</strong>  終値。実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlclosingmarubozu
type: function
doc:
<comment>Description:</comment>
  Closing Marubozu

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   始値。実数値の配列。
  <info>array</info>  <strong>$high</strong>   高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>    安値。実数値の配列。
  <info>array</info>  <strong>$close</strong>  終値。実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlconcealbabyswall
type: function
doc:
<comment>Description:</comment>
  Concealing Baby Swallow

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   始値。実数値の配列。
  <info>array</info>  <strong>$high</strong>   高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>    安値。実数値の配列。
  <info>array</info>  <strong>$close</strong>  終値。実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlcounterattack
type: function
doc:
<comment>Description:</comment>
  Counterattack

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   始値。実数値の配列。
  <info>array</info>  <strong>$high</strong>   高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>    安値。実数値の配列。
  <info>array</info>  <strong>$close</strong>  終値。実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdldarkcloudcover
type: function
doc:
<comment>Description:</comment>
  Dark Cloud Cover

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>         始値。実数値の配列。
  <info>array</info>  <strong>$high</strong>         高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>          安値。実数値の配列。
  <info>array</info>  <strong>$close</strong>        終値。実数値の配列。
  <info>float</info>  <strong>$penetration</strong>  Percentage of penetration of a candle within another candle.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdldoji
type: function
doc:
<comment>Description:</comment>
  Doji

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   始値。実数値の配列。
  <info>array</info>  <strong>$high</strong>   高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>    安値。実数値の配列。
  <info>array</info>  <strong>$close</strong>  終値。実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdldojistar
type: function
doc:
<comment>Description:</comment>
  Doji Star

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   始値。実数値の配列。
  <info>array</info>  <strong>$high</strong>   高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>    安値。実数値の配列。
  <info>array</info>  <strong>$close</strong>  終値。実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdldragonflydoji
type: function
doc:
<comment>Description:</comment>
  Dragonfly Doji

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   始値。実数値の配列。
  <info>array</info>  <strong>$high</strong>   高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>    安値。実数値の配列。
  <info>array</info>  <strong>$close</strong>  終値。実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlengulfing
type: function
doc:
<comment>Description:</comment>
  Engulfing Pattern

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   始値。実数値の配列。
  <info>array</info>  <strong>$high</strong>   高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>    安値。実数値の配列。
  <info>array</info>  <strong>$close</strong>  終値。実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdleveningdojistar
type: function
doc:
<comment>Description:</comment>
  Evening Doji Star

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>         始値。実数値の配列。
  <info>array</info>  <strong>$high</strong>         高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>          安値。実数値の配列。
  <info>array</info>  <strong>$close</strong>        終値。実数値の配列。
  <info>float</info>  <strong>$penetration</strong>  Percentage of penetration of a candle within another candle.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdleveningstar
type: function
doc:
<comment>Description:</comment>
  Evening Star

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>         始値。実数値の配列。
  <info>array</info>  <strong>$high</strong>         高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>          安値。実数値の配列。
  <info>array</info>  <strong>$close</strong>        終値。実数値の配列。
  <info>float</info>  <strong>$penetration</strong>  Percentage of penetration of a candle within another candle.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlgapsidesidewhite
type: function
doc:
<comment>Description:</comment>
  Up/Down-gap side-by-side white lines

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   始値。実数値の配列。
  <info>array</info>  <strong>$high</strong>   高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>    安値。実数値の配列。
  <info>array</info>  <strong>$close</strong>  終値。実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlgravestonedoji
type: function
doc:
<comment>Description:</comment>
  Gravestone Doji

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   始値。実数値の配列。
  <info>array</info>  <strong>$high</strong>   高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>    安値。実数値の配列。
  <info>array</info>  <strong>$close</strong>  終値。実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlhammer
type: function
doc:
<comment>Description:</comment>
  Hammer

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   始値。実数値の配列。
  <info>array</info>  <strong>$high</strong>   高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>    安値。実数値の配列。
  <info>array</info>  <strong>$close</strong>  終値。実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlhangingman
type: function
doc:
<comment>Description:</comment>
  Hanging Man

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   始値。実数値の配列。
  <info>array</info>  <strong>$high</strong>   高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>    安値。実数値の配列。
  <info>array</info>  <strong>$close</strong>  終値。実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlharami
type: function
doc:
<comment>Description:</comment>
  Harami Pattern

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   始値。実数値の配列。
  <info>array</info>  <strong>$high</strong>   高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>    安値。実数値の配列。
  <info>array</info>  <strong>$close</strong>  終値。実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlharamicross
type: function
doc:
<comment>Description:</comment>
  Harami Cross Pattern

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   始値。実数値の配列。
  <info>array</info>  <strong>$high</strong>   高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>    安値。実数値の配列。
  <info>array</info>  <strong>$close</strong>  終値。実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlhighwave
type: function
doc:
<comment>Description:</comment>
  High-Wave Candle

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   始値。実数値の配列。
  <info>array</info>  <strong>$high</strong>   高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>    安値。実数値の配列。
  <info>array</info>  <strong>$close</strong>  終値。実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlhikkake
type: function
doc:
<comment>Description:</comment>
  Hikkake Pattern

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   始値。実数値の配列。
  <info>array</info>  <strong>$high</strong>   高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>    安値。実数値の配列。
  <info>array</info>  <strong>$close</strong>  終値。実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlhikkakemod
type: function
doc:
<comment>Description:</comment>
  Modified Hikkake Pattern

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   始値。実数値の配列。
  <info>array</info>  <strong>$high</strong>   高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>    安値。実数値の配列。
  <info>array</info>  <strong>$close</strong>  終値。実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlhomingpigeon
type: function
doc:
<comment>Description:</comment>
  Homing Pigeon

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   始値。実数値の配列。
  <info>array</info>  <strong>$high</strong>   高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>    安値。実数値の配列。
  <info>array</info>  <strong>$close</strong>  終値。実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlidentical3crows
type: function
doc:
<comment>Description:</comment>
  Identical Three Crows

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   始値。実数値の配列。
  <info>array</info>  <strong>$high</strong>   高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>    安値。実数値の配列。
  <info>array</info>  <strong>$close</strong>  終値。実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlinneck
type: function
doc:
<comment>Description:</comment>
  In-Neck Pattern

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   始値。実数値の配列。
  <info>array</info>  <strong>$high</strong>   高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>    安値。実数値の配列。
  <info>array</info>  <strong>$close</strong>  終値。実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlinvertedhammer
type: function
doc:
<comment>Description:</comment>
  Inverted Hammer

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   始値。実数値の配列。
  <info>array</info>  <strong>$high</strong>   高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>    安値。実数値の配列。
  <info>array</info>  <strong>$close</strong>  終値。実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlkicking
type: function
doc:
<comment>Description:</comment>
  Kicking

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   始値。実数値の配列。
  <info>array</info>  <strong>$high</strong>   高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>    安値。実数値の配列。
  <info>array</info>  <strong>$close</strong>  終値。実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlkickingbylength
type: function
doc:
<comment>Description:</comment>
  Kicking - bull/bear determined by the longer marubozu

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   始値。実数値の配列。
  <info>array</info>  <strong>$high</strong>   高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>    安値。実数値の配列。
  <info>array</info>  <strong>$close</strong>  終値。実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlladderbottom
type: function
doc:
<comment>Description:</comment>
  Ladder Bottom

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   始値。実数値の配列。
  <info>array</info>  <strong>$high</strong>   高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>    安値。実数値の配列。
  <info>array</info>  <strong>$close</strong>  終値。実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdllongleggeddoji
type: function
doc:
<comment>Description:</comment>
  Long Legged Doji

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   始値。実数値の配列。
  <info>array</info>  <strong>$high</strong>   高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>    安値。実数値の配列。
  <info>array</info>  <strong>$close</strong>  終値。実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdllongline
type: function
doc:
<comment>Description:</comment>
  Long Line Candle

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   始値。実数値の配列。
  <info>array</info>  <strong>$high</strong>   高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>    安値。実数値の配列。
  <info>array</info>  <strong>$close</strong>  終値。実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlmarubozu
type: function
doc:
<comment>Description:</comment>
  Marubozu

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   始値。実数値の配列。
  <info>array</info>  <strong>$high</strong>   高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>    安値。実数値の配列。
  <info>array</info>  <strong>$close</strong>  終値。実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlmatchinglow
type: function
doc:
<comment>Description:</comment>
  Matching Low

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   始値。実数値の配列。
  <info>array</info>  <strong>$high</strong>   高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>    安値。実数値の配列。
  <info>array</info>  <strong>$close</strong>  終値。実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlmathold
type: function
doc:
<comment>Description:</comment>
  Mat Hold

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>         始値。実数値の配列。
  <info>array</info>  <strong>$high</strong>         高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>          安値。実数値の配列。
  <info>array</info>  <strong>$close</strong>        終値。実数値の配列。
  <info>float</info>  <strong>$penetration</strong>  Percentage of penetration of a candle within another candle.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlmorningdojistar
type: function
doc:
<comment>Description:</comment>
  Morning Doji Star

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>         始値。実数値の配列。
  <info>array</info>  <strong>$high</strong>         高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>          安値。実数値の配列。
  <info>array</info>  <strong>$close</strong>        終値。実数値の配列。
  <info>float</info>  <strong>$penetration</strong>  Percentage of penetration of a candle within another candle.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlmorningstar
type: function
doc:
<comment>Description:</comment>
  Morning Star

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>         始値。実数値の配列。
  <info>array</info>  <strong>$high</strong>         高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>          安値。実数値の配列。
  <info>array</info>  <strong>$close</strong>        終値。実数値の配列。
  <info>float</info>  <strong>$penetration</strong>  Percentage of penetration of a candle within another candle.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlonneck
type: function
doc:
<comment>Description:</comment>
  On-Neck Pattern

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   始値。実数値の配列。
  <info>array</info>  <strong>$high</strong>   高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>    安値。実数値の配列。
  <info>array</info>  <strong>$close</strong>  終値。実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlpiercing
type: function
doc:
<comment>Description:</comment>
  Piercing Pattern

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   始値。実数値の配列。
  <info>array</info>  <strong>$high</strong>   高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>    安値。実数値の配列。
  <info>array</info>  <strong>$close</strong>  終値。実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlrickshawman
type: function
doc:
<comment>Description:</comment>
  Rickshaw Man

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   始値。実数値の配列。
  <info>array</info>  <strong>$high</strong>   高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>    安値。実数値の配列。
  <info>array</info>  <strong>$close</strong>  終値。実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlrisefall3methods
type: function
doc:
<comment>Description:</comment>
  Rising/Falling Three Methods

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   始値。実数値の配列。
  <info>array</info>  <strong>$high</strong>   高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>    安値。実数値の配列。
  <info>array</info>  <strong>$close</strong>  終値。実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlseparatinglines
type: function
doc:
<comment>Description:</comment>
  Separating Lines

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   始値。実数値の配列。
  <info>array</info>  <strong>$high</strong>   高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>    安値。実数値の配列。
  <info>array</info>  <strong>$close</strong>  終値。実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlshootingstar
type: function
doc:
<comment>Description:</comment>
  Shooting Star

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   始値。実数値の配列。
  <info>array</info>  <strong>$high</strong>   高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>    安値。実数値の配列。
  <info>array</info>  <strong>$close</strong>  終値。実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlshortline
type: function
doc:
<comment>Description:</comment>
  Short Line Candle

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   始値。実数値の配列。
  <info>array</info>  <strong>$high</strong>   高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>    安値。実数値の配列。
  <info>array</info>  <strong>$close</strong>  終値。実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlspinningtop
type: function
doc:
<comment>Description:</comment>
  Spinning Top

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   始値。実数値の配列。
  <info>array</info>  <strong>$high</strong>   高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>    安値。実数値の配列。
  <info>array</info>  <strong>$close</strong>  終値。実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlstalledpattern
type: function
doc:
<comment>Description:</comment>
  Stalled Pattern

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   始値。実数値の配列。
  <info>array</info>  <strong>$high</strong>   高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>    安値。実数値の配列。
  <info>array</info>  <strong>$close</strong>  終値。実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlsticksandwich
type: function
doc:
<comment>Description:</comment>
  Stick Sandwich

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   始値。実数値の配列。
  <info>array</info>  <strong>$high</strong>   高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>    安値。実数値の配列。
  <info>array</info>  <strong>$close</strong>  終値。実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdltakuri
type: function
doc:
<comment>Description:</comment>
  Takuri (Dragonfly Doji with very long lower shadow)

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   始値。実数値の配列。
  <info>array</info>  <strong>$high</strong>   高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>    安値。実数値の配列。
  <info>array</info>  <strong>$close</strong>  終値。実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdltasukigap
type: function
doc:
<comment>Description:</comment>
  Tasuki Gap

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   始値。実数値の配列。
  <info>array</info>  <strong>$high</strong>   高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>    安値。実数値の配列。
  <info>array</info>  <strong>$close</strong>  終値。実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlthrusting
type: function
doc:
<comment>Description:</comment>
  Thrusting Pattern

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   始値。実数値の配列。
  <info>array</info>  <strong>$high</strong>   高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>    安値。実数値の配列。
  <info>array</info>  <strong>$close</strong>  終値。実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdltristar
type: function
doc:
<comment>Description:</comment>
  Tristar Pattern

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   始値。実数値の配列。
  <info>array</info>  <strong>$high</strong>   高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>    安値。実数値の配列。
  <info>array</info>  <strong>$close</strong>  終値。実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlunique3river
type: function
doc:
<comment>Description:</comment>
  Unique 3 River

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   始値。実数値の配列。
  <info>array</info>  <strong>$high</strong>   高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>    安値。実数値の配列。
  <info>array</info>  <strong>$close</strong>  終値。実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlupsidegap2crows
type: function
doc:
<comment>Description:</comment>
  Upside Gap Two Crows

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   始値。実数値の配列。
  <info>array</info>  <strong>$high</strong>   高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>    安値。実数値の配列。
  <info>array</info>  <strong>$close</strong>  終値。実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlxsidegap3methods
type: function
doc:
<comment>Description:</comment>
  Upside/Downside Gap Three Methods

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   始値。実数値の配列。
  <info>array</info>  <strong>$high</strong>   高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>    安値。実数値の配列。
  <info>array</info>  <strong>$close</strong>  終値。実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_ceil
type: function
doc:
<comment>Description:</comment>
  Vector Ceil
  
  Calculates the next highest integer for each value in <strong>$real</strong> and returns the resulting array.

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>  実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cmo
type: function
doc:
<comment>Description:</comment>
  Chande Momentum Oscillator

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>        実数値の配列。
  <info>int</info>    <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_correl
type: function
doc:
<comment>Description:</comment>
  Pearson's Correlation Coefficient (r)

<comment>Param:</comment>
  <info>array</info>  <strong>$real0</strong>       実数値の配列。
  <info>array</info>  <strong>$real1</strong>       実数値の配列。
  <info>int</info>    <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cos
type: function
doc:
<comment>Description:</comment>
  Vector Trigonometric Cos
  
  Calculates the cosine for each value in <strong>$real</strong> and returns the resulting array.

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>  実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cosh
type: function
doc:
<comment>Description:</comment>
  Vector Trigonometric Cosh
  
  Calculates the hyperbolic cosine for each value in <strong>$real</strong> and returns the resulting array.

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>  実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_dema
type: function
doc:
<comment>Description:</comment>
  Double Exponential Moving Average

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>        実数値の配列。
  <info>int</info>    <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_div
type: function
doc:
<comment>Description:</comment>
  Vector Arithmetic Div
  
  Divides each value from <strong>$real0</strong> by the corresponding value from <strong>$real1</strong> and returns the resulting
  array.

<comment>Param:</comment>
  <info>array</info>  <strong>$real0</strong>  実数値の配列。
  <info>array</info>  <strong>$real1</strong>  実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_dx
type: function
doc:
<comment>Description:</comment>
  Directional Movement Index

<comment>Param:</comment>
  <info>array</info>  <strong>$high</strong>        高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>         安値。実数値の配列。
  <info>array</info>  <strong>$close</strong>       終値。実数値の配列。
  <info>int</info>    <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_ema
type: function
doc:
<comment>Description:</comment>
  Exponential Moving Average

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>        実数値の配列。
  <info>int</info>    <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_errno
type: function
doc:
<comment>Description:</comment>
  Get error code
  
  Get error code of the last operation.

<comment>Return:</comment>
  <info>int</info>  Returns the error code identified by one of the TRADER_ERR_* constants.


id: trader_exp
type: function
doc:
<comment>Description:</comment>
  Vector Arithmetic Exp
  
  Calculates <info>e</info> raised to the power of each value in <strong>$real</strong>. Returns an array with the calculated
  data.

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>  実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_floor
type: function
doc:
<comment>Description:</comment>
  Vector Floor
  
  Calculates the next lowest integer for each value in <strong>$real</strong> and returns the resulting array.

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>  実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_get_compat
type: function
doc:
<comment>Description:</comment>
  Get compatibility mode
  
  Get compatibility mode which affects the way calculations are done by all the extension functions.

<comment>Return:</comment>
  <info>int</info>  Returns the compatibility mode id which can be identified by TRADER_COMPATIBILITY_* series of
       constants.


id: trader_get_unstable_period
type: function
doc:
<comment>Description:</comment>
  Get unstable period
  
  Get unstable period factor for a particular function.

<comment>Param:</comment>
  <info>int</info>  <strong>$functionId</strong>  Function ID the factor to be read for. TRADER_FUNC_UNST_* series of constants
                    should be used.

<comment>Return:</comment>
  <info>int</info>  Returns the unstable period factor for the corresponding function.


id: trader_ht_dcperiod
type: function
doc:
<comment>Description:</comment>
  Hilbert Transform - Dominant Cycle Period

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>  実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_ht_dcphase
type: function
doc:
<comment>Description:</comment>
  Hilbert Transform - Dominant Cycle Phase

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>  実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_ht_phasor
type: function
doc:
<comment>Description:</comment>
  Hilbert Transform - Phasor Components

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>  実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_ht_sine
type: function
doc:
<comment>Description:</comment>
  Hilbert Transform - SineWave

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>  実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_ht_trendline
type: function
doc:
<comment>Description:</comment>
  Hilbert Transform - Instantaneous Trendline

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>  実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_ht_trendmode
type: function
doc:
<comment>Description:</comment>
  Hilbert Transform - Trend vs Cycle Mode

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>  実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_kama
type: function
doc:
<comment>Description:</comment>
  Kaufman Adaptive Moving Average

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>        実数値の配列。
  <info>int</info>    <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_linearreg
type: function
doc:
<comment>Description:</comment>
  Linear Regression

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>        実数値の配列。
  <info>int</info>    <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_linearreg_angle
type: function
doc:
<comment>Description:</comment>
  Linear Regression Angle

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>        実数値の配列。
  <info>int</info>    <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_linearreg_intercept
type: function
doc:
<comment>Description:</comment>
  Linear Regression Intercept

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>        実数値の配列。
  <info>int</info>    <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_linearreg_slope
type: function
doc:
<comment>Description:</comment>
  Linear Regression Slope

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>        実数値の配列。
  <info>int</info>    <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_ln
type: function
doc:
<comment>Description:</comment>
  Vector Log Natural
  
  Calculates the natural logarithm for each value in <strong>$real</strong> and returns the resulting array.

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>  実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_log10
type: function
doc:
<comment>Description:</comment>
  Vector Log10
  
  Calculates the base-10 logarithm for each value in <strong>$real</strong> and returns the resulting array.

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>  実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_ma
type: function
doc:
<comment>Description:</comment>
  Moving average

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>        実数値の配列。
  <info>int</info>    <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.
  <info>int</info>    <strong>$mAType</strong>      Type of Moving Average. TRADER_MA_TYPE_* series of constants should be used.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_macd
type: function
doc:
<comment>Description:</comment>
  Moving Average Convergence/Divergence

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>          実数値の配列。
  <info>int</info>    <strong>$fastPeriod</strong>    Number of period for the fast MA. Valid range from 2 to 100000.
  <info>int</info>    <strong>$slowPeriod</strong>    Number of period for the slow MA. Valid range from 2 to 100000.
  <info>int</info>    <strong>$signalPeriod</strong>  Smoothing for the signal line (nb of period). Valid range from 1 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_macdext
type: function
doc:
<comment>Description:</comment>
  MACD with controllable MA type

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>          実数値の配列。
  <info>int</info>    <strong>$fastPeriod</strong>    Number of period for the fast MA. Valid range from 2 to 100000.
  <info>int</info>    <strong>$fastMAType</strong>    Type of Moving Average for fast MA. TRADER_MA_TYPE_* series of constants
                        should be used.
  <info>int</info>    <strong>$slowPeriod</strong>    Number of period for the slow MA. Valid range from 2 to 100000.
  <info>int</info>    <strong>$slowMAType</strong>    Type of Moving Average for slow MA. TRADER_MA_TYPE_* series of constants
                        should be used.
  <info>int</info>    <strong>$signalPeriod</strong>  Smoothing for the signal line (nb of period). Valid range from 1 to 100000.
  <info>int</info>    <strong>$signalMAType</strong>  Type of Moving Average for signal line. TRADER_MA_TYPE_* series of constants
                        should be used.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_macdfix
type: function
doc:
<comment>Description:</comment>
  Moving Average Convergence/Divergence Fix 12/26

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>          実数値の配列。
  <info>int</info>    <strong>$signalPeriod</strong>  Smoothing for the signal line (nb of period). Valid range from 1 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_mama
type: function
doc:
<comment>Description:</comment>
  MESA Adaptive Moving Average

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>       実数値の配列。
  <info>float</info>  <strong>$fastLimit</strong>  Upper limit use in the adaptive algorithm. Valid range from 0.01 to 0.99.
  <info>float</info>  <strong>$slowLimit</strong>  Lower limit use in the adaptive algorithm. Valid range from 0.01 to 0.99.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_mavp
type: function
doc:
<comment>Description:</comment>
  Moving average with variable period

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>       実数値の配列。
  <info>array</info>  <strong>$periods</strong>    実数値の配列。
  <info>int</info>    <strong>$minPeriod</strong>  Value less than minimum will be changed to Minimum period. Valid range from 2
                     to 100000
  <info>int</info>    <strong>$maxPeriod</strong>  Value higher than minimum will be changed to Maximum period. Valid range from 2
                     to 100000
  <info>int</info>    <strong>$mAType</strong>     Type of Moving Average. TRADER_MA_TYPE_* series of constants should be used.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_max
type: function
doc:
<comment>Description:</comment>
  Highest value over a specified period

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>        実数値の配列。
  <info>int</info>    <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_maxindex
type: function
doc:
<comment>Description:</comment>
  Index of highest value over a specified period

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>        実数値の配列。
  <info>int</info>    <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_medprice
type: function
doc:
<comment>Description:</comment>
  Median Price

<comment>Param:</comment>
  <info>array</info>  <strong>$high</strong>  高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>   安値。実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_mfi
type: function
doc:
<comment>Description:</comment>
  Money Flow Index

<comment>Param:</comment>
  <info>array</info>  <strong>$high</strong>        高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>         安値。実数値の配列。
  <info>array</info>  <strong>$close</strong>       終値。実数値の配列。
  <info>array</info>  <strong>$volume</strong>      取引高。実数値の配列。
  <info>int</info>    <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_midpoint
type: function
doc:
<comment>Description:</comment>
  MidPoint over period

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>        実数値の配列。
  <info>int</info>    <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_midprice
type: function
doc:
<comment>Description:</comment>
  Midpoint Price over period

<comment>Param:</comment>
  <info>array</info>  <strong>$high</strong>        高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>         安値。実数値の配列。
  <info>int</info>    <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_min
type: function
doc:
<comment>Description:</comment>
  Lowest value over a specified period

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>        実数値の配列。
  <info>int</info>    <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_minindex
type: function
doc:
<comment>Description:</comment>
  Index of lowest value over a specified period

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>        実数値の配列。
  <info>int</info>    <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_minmax
type: function
doc:
<comment>Description:</comment>
  Lowest and highest values over a specified period

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>        実数値の配列。
  <info>int</info>    <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_minmaxindex
type: function
doc:
<comment>Description:</comment>
  Indexes of lowest and highest values over a specified period

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>        実数値の配列。
  <info>int</info>    <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_minus_di
type: function
doc:
<comment>Description:</comment>
  Minus Directional Indicator

<comment>Param:</comment>
  <info>array</info>  <strong>$high</strong>        高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>         安値。実数値の配列。
  <info>array</info>  <strong>$close</strong>       終値。実数値の配列。
  <info>int</info>    <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_minus_dm
type: function
doc:
<comment>Description:</comment>
  Minus Directional Movement

<comment>Param:</comment>
  <info>array</info>  <strong>$high</strong>        高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>         安値。実数値の配列。
  <info>int</info>    <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_mom
type: function
doc:
<comment>Description:</comment>
  Momentum

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>        実数値の配列。
  <info>int</info>    <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_mult
type: function
doc:
<comment>Description:</comment>
  Vector Arithmetic Mult
  
  Calculates the vector dot product of <strong>$real0</strong> with <strong>$real1</strong> and returns the resulting vector.

<comment>Param:</comment>
  <info>array</info>  <strong>$real0</strong>  実数値の配列。
  <info>array</info>  <strong>$real1</strong>  実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_natr
type: function
doc:
<comment>Description:</comment>
  Normalized Average True Range

<comment>Param:</comment>
  <info>array</info>  <strong>$high</strong>        高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>         安値。実数値の配列。
  <info>array</info>  <strong>$close</strong>       終値。実数値の配列。
  <info>int</info>    <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_obv
type: function
doc:
<comment>Description:</comment>
  On Balance Volume

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>    実数値の配列。
  <info>array</info>  <strong>$volume</strong>  取引高。実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_plus_di
type: function
doc:
<comment>Description:</comment>
  Plus Directional Indicator

<comment>Param:</comment>
  <info>array</info>  <strong>$high</strong>        高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>         安値。実数値の配列。
  <info>array</info>  <strong>$close</strong>       終値。実数値の配列。
  <info>int</info>    <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_plus_dm
type: function
doc:
<comment>Description:</comment>
  Plus Directional Movement

<comment>Param:</comment>
  <info>array</info>  <strong>$high</strong>        高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>         安値。実数値の配列。
  <info>int</info>    <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_ppo
type: function
doc:
<comment>Description:</comment>
  Percentage Price Oscillator

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>        実数値の配列。
  <info>int</info>    <strong>$fastPeriod</strong>  Number of period for the fast MA. Valid range from 2 to 100000.
  <info>int</info>    <strong>$slowPeriod</strong>  Number of period for the slow MA. Valid range from 2 to 100000.
  <info>int</info>    <strong>$mAType</strong>      Type of Moving Average. TRADER_MA_TYPE_* series of constants should be used.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_roc
type: function
doc:
<comment>Description:</comment>
  Rate of change : ((price/prevPrice)-1)*100

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>        実数値の配列。
  <info>int</info>    <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_rocp
type: function
doc:
<comment>Description:</comment>
  Rate of change Percentage: (price-prevPrice)/prevPrice

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>        実数値の配列。
  <info>int</info>    <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_rocr
type: function
doc:
<comment>Description:</comment>
  Rate of change ratio: (price/prevPrice)

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>        実数値の配列。
  <info>int</info>    <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_rocr100
type: function
doc:
<comment>Description:</comment>
  Rate of change ratio 100 scale: (price/prevPrice)*100

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>        実数値の配列。
  <info>int</info>    <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_rsi
type: function
doc:
<comment>Description:</comment>
  Relative Strength Index

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>        実数値の配列。
  <info>int</info>    <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_sar
type: function
doc:
<comment>Description:</comment>
  Parabolic SAR

<comment>Param:</comment>
  <info>array</info>  <strong>$high</strong>          高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>           安値。実数値の配列。
  <info>float</info>  <strong>$acceleration</strong>  Acceleration Factor used up to the Maximum value. Valid range from 0 to
                        TRADER_REAL_MAX.
  <info>float</info>  <strong>$maximum</strong>       Acceleration Factor Maximum value. Valid range from 0 to TRADER_REAL_MAX.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_sarext
type: function
doc:
<comment>Description:</comment>
  Parabolic SAR - Extended

<comment>Param:</comment>
  <info>array</info>  <strong>$high</strong>                   高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>                    安値。実数値の配列。
  <info>float</info>  <strong>$startValue</strong>             Start value and direction. 0 for Auto, &gt;0 for Long, \<0 for Short. Valid range from TRADER_REAL_MIN to TRADER_REAL_MAX.
  <info>float</info>  <strong>$offsetOnReverse</strong>        Percent offset added/removed to initial stop on short/long
                                 reversal. Valid range from 0 to TRADER_REAL_MAX.
  <info>float</info>  <strong>$accelerationInitLong</strong>   Acceleration Factor initial value for the Long direction. Valid
                                 range from 0 to TRADER_REAL_MAX.
  <info>float</info>  <strong>$accelerationLong</strong>       Acceleration Factor for the Long direction. Valid range from 0 to
                                 TRADER_REAL_MAX.
  <info>float</info>  <strong>$accelerationMaxLong</strong>    Acceleration Factor maximum value for the Long direction. Valid
                                 range from 0 to TRADER_REAL_MAX.
  <info>float</info>  <strong>$accelerationInitShort</strong>  Acceleration Factor initial value for the Short direction. Valid
                                 range from 0 to TRADER_REAL_MAX.
  <info>float</info>  <strong>$accelerationShort</strong>      Acceleration Factor for the Short direction. Valid range from 0 to
                                 TRADER_REAL_MAX.
  <info>float</info>  <strong>$accelerationMaxShort</strong>   Acceleration Factor maximum value for the Short direction. Valid
                                 range from 0 to TRADER_REAL_MAX.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_set_compat
type: function
doc:
<comment>Description:</comment>
  Set compatibility mode
  
  Set compatibility mode which will affect the way calculations are done by all the extension
  functions.

<comment>Param:</comment>
  <info>int</info>  <strong>$compatId</strong>  Compatibility Id. TRADER_COMPATIBILITY_* series of constants should be used.

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


id: trader_set_unstable_period
type: function
doc:
<comment>Description:</comment>
  Set unstable period
  
  Influences unstable period factor for functions, which are sensible to it. More information about
  unstable periods can be found on the TA-Lib API documentation page.

<comment>Param:</comment>
  <info>int</info>  <strong>$functionId</strong>  Function ID the factor should be set for. TRADER_FUNC_UNST_* constant series can
                    be used to affect the corresponding function.
  <info>int</info>  <strong>$timePeriod</strong>  Unstable period value.

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


id: trader_sin
type: function
doc:
<comment>Description:</comment>
  Vector Trigonometric Sin
  
  Calculates the sine for each value in <strong>$real</strong> and returns the resulting array.

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>  実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_sinh
type: function
doc:
<comment>Description:</comment>
  Vector Trigonometric Sinh
  
  Calculates the hyperbolic sine for each value in <strong>$real</strong> and returns the resulting array.

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>  実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_sma
type: function
doc:
<comment>Description:</comment>
  Simple Moving Average

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>        実数値の配列。
  <info>int</info>    <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_sqrt
type: function
doc:
<comment>Description:</comment>
  Vector Square Root
  
  Calculates the square root of each value in <strong>$real</strong> and returns the resulting array.

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>  実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_stddev
type: function
doc:
<comment>Description:</comment>
  Standard Deviation

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>        実数値の配列。
  <info>int</info>    <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.
  <info>float</info>  <strong>$nbDev</strong>       

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_stoch
type: function
doc:
<comment>Description:</comment>
  Stochastic

<comment>Param:</comment>
  <info>array</info>  <strong>$high</strong>          高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>           安値。実数値の配列。
  <info>array</info>  <strong>$close</strong>         終値。実数値の配列。
  <info>int</info>    <strong>$fastK_Period</strong>  Time period for building the Fast-K line. Valid range from 1 to 100000.
  <info>int</info>    <strong>$slowK_Period</strong>  Smoothing for making the Slow-K line. Valid range from 1 to 100000, usually
                        set to 3.
  <info>int</info>    <strong>$slowK_MAType</strong>  Type of Moving Average for Slow-K. TRADER_MA_TYPE_* series of constants
                        should be used.
  <info>int</info>    <strong>$slowD_Period</strong>  Smoothing for making the Slow-D line. Valid range from 1 to 100000.
  <info>int</info>    <strong>$slowD_MAType</strong>  Type of Moving Average for Slow-D. TRADER_MA_TYPE_* series of constants
                        should be used.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_stochf
type: function
doc:
<comment>Description:</comment>
  Stochastic Fast

<comment>Param:</comment>
  <info>array</info>  <strong>$high</strong>          高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>           安値。実数値の配列。
  <info>array</info>  <strong>$close</strong>         終値。実数値の配列。
  <info>int</info>    <strong>$fastK_Period</strong>  Time period for building the Fast-K line. Valid range from 1 to 100000.
  <info>int</info>    <strong>$fastD_Period</strong>  Smoothing for making the Fast-D line. Valid range from 1 to 100000, usually
                        set to 3.
  <info>int</info>    <strong>$fastD_MAType</strong>  Type of Moving Average for Fast-D. TRADER_MA_TYPE_* series of constants
                        should be used.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_stochrsi
type: function
doc:
<comment>Description:</comment>
  Stochastic Relative Strength Index

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>          実数値の配列。
  <info>int</info>    <strong>$timePeriod</strong>    Number of period. Valid range from 2 to 100000.
  <info>int</info>    <strong>$fastK_Period</strong>  Time period for building the Fast-K line. Valid range from 1 to 100000.
  <info>int</info>    <strong>$fastD_Period</strong>  Smoothing for making the Fast-D line. Valid range from 1 to 100000, usually
                        set to 3.
  <info>int</info>    <strong>$fastD_MAType</strong>  Type of Moving Average for Fast-D. TRADER_MA_TYPE_* series of constants
                        should be used.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_sub
type: function
doc:
<comment>Description:</comment>
  Vector Arithmetic Subtraction
  
  Calculates the vector subtraction of <strong>$real1</strong> from <strong>$real0</strong> and returns the resulting vector.

<comment>Param:</comment>
  <info>array</info>  <strong>$real0</strong>  実数値の配列。
  <info>array</info>  <strong>$real1</strong>  実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_sum
type: function
doc:
<comment>Description:</comment>
  Summation

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>        実数値の配列。
  <info>int</info>    <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_t3
type: function
doc:
<comment>Description:</comment>
  Triple Exponential Moving Average (T3)

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>        実数値の配列。
  <info>int</info>    <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.
  <info>float</info>  <strong>$vFactor</strong>     Volume Factor. Valid range from 1 to 0.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_tan
type: function
doc:
<comment>Description:</comment>
  Vector Trigonometric Tan
  
  Calculates the tangent for each value in <strong>$real</strong> and returns the resulting array.

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>  実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_tanh
type: function
doc:
<comment>Description:</comment>
  Vector Trigonometric Tanh
  
  Calculates the hyperbolic tangent for each value in <strong>$real</strong> and returns the resulting array.

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>  実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_tema
type: function
doc:
<comment>Description:</comment>
  Triple Exponential Moving Average

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>        実数値の配列。
  <info>int</info>    <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_trange
type: function
doc:
<comment>Description:</comment>
  True Range

<comment>Param:</comment>
  <info>array</info>  <strong>$high</strong>   高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>    安値。実数値の配列。
  <info>array</info>  <strong>$close</strong>  終値。実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_trima
type: function
doc:
<comment>Description:</comment>
  Triangular Moving Average

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>        実数値の配列。
  <info>int</info>    <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_trix
type: function
doc:
<comment>Description:</comment>
  1-day Rate-Of-Change (ROC) of a Triple Smooth EMA

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>        実数値の配列。
  <info>int</info>    <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_tsf
type: function
doc:
<comment>Description:</comment>
  Time Series Forecast

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>        実数値の配列。
  <info>int</info>    <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_typprice
type: function
doc:
<comment>Description:</comment>
  Typical Price

<comment>Param:</comment>
  <info>array</info>  <strong>$high</strong>   高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>    安値。実数値の配列。
  <info>array</info>  <strong>$close</strong>  終値。実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_ultosc
type: function
doc:
<comment>Description:</comment>
  Ultimate Oscillator

<comment>Param:</comment>
  <info>array</info>  <strong>$high</strong>         高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>          安値。実数値の配列。
  <info>array</info>  <strong>$close</strong>        終値。実数値の配列。
  <info>int</info>    <strong>$timePeriod1</strong>  Number of bars for 1st period. Valid range from 1 to 100000.
  <info>int</info>    <strong>$timePeriod2</strong>  Number of bars for 2nd period. Valid range from 1 to 100000.
  <info>int</info>    <strong>$timePeriod3</strong>  Number of bars for 3rd period. Valid range from 1 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_var
type: function
doc:
<comment>Description:</comment>
  Variance

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>        実数値の配列。
  <info>int</info>    <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.
  <info>float</info>  <strong>$nbDev</strong>       

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_wclprice
type: function
doc:
<comment>Description:</comment>
  Weighted Close Price

<comment>Param:</comment>
  <info>array</info>  <strong>$high</strong>   高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>    安値。実数値の配列。
  <info>array</info>  <strong>$close</strong>  終値。実数値の配列。

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_willr
type: function
doc:
<comment>Description:</comment>
  Williams' %R

<comment>Param:</comment>
  <info>array</info>  <strong>$high</strong>        高値。実数値の配列。
  <info>array</info>  <strong>$low</strong>         安値。実数値の配列。
  <info>array</info>  <strong>$close</strong>       終値。実数値の配列。
  <info>int</info>    <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_wma
type: function
doc:
<comment>Description:</comment>
  Weighted Moving Average

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>        実数値の配列。
  <info>int</info>    <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trait_exists
type: function
doc:
<comment>Description:</comment>
  トレイトが存在するかどうかを調べる

<comment>Param:</comment>
  <info>string</info>  <strong>$trait</strong>     調べたいトレイトの名前。
  <info>bool</info>    <strong>$autoload</strong>  まだロードされていない場合に オートロード するかどうか。

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


id: trigger_error
type: function
doc:
<comment>Description:</comment>
  ユーザーレベルのエラー/警告/通知メッセージを生成する
  
  ユーザーエラーを発生させるために使います。組み込みのエラーハンドラまたは新しいエラーハンドラ
  (<strong>set_error_handler()</strong>) として設定済みのユーザー定義関数と組み合わせて使うこともできます。
  
  この関数は、実行時の例外に特定の応答を生成する必要がある場合に便利です。

<comment>Param:</comment>
  <info>string</info>  <strong>$message</strong>      このエラーに割り当てられたメッセージ。長さは最大 1024 バイトまでです。1024
                        バイトを超える部分は切り捨てられます。
  <info>int</info>     <strong>$error_level</strong>  このエラーに割り当てられたエラー型です。E_USER 関連の定数のみが指定可能で、
                        デフォルトは <info>E_USER_NOTICE</info> です。

<comment>Return:</comment>
  <info>bool</info>  この関数は、間違った <strong>$error_level</strong> が指定された場合に <info>false</info> を、 それ以外の場合に <info>true</info> を返し
        ます。

<comment>See Also:</comment>
   * <strong>error_reporting()</strong>
   * <strong>set_error_handler()</strong>
   * <strong>restore_error_handler()</strong>
   * エラーレベル定数


id: trim
type: function
doc:
<comment>Description:</comment>
  文字列の先頭および末尾にあるホワイトスペースを取り除く
    
  
  この関数は <strong>$string</strong> の最初および最後から空白文字を取り除き、 取り除かれた文字列を返します。2番目の
  パラメータを指定しない場合、 <strong>trim()</strong>は以下の文字を削除します。   " " (ASCII <return>32</return> (<return>0x20</return>)), 通常の空
  白。  "\t" (ASCII <return>9</return> (<return>0x09</return>)), タブ。  "\n" (ASCII <return>10</return> (<return>0x0A</return>)), リターン。  "\r" (ASCII <return>13</return> (<return>0x0D</return>)),
  改行。  "\0" (ASCII <return>0</return> (<return>0x00</return>)), <return>NUL</return>バイト  "\v" (ASCII <return>11</return>  (<return>0x0B</return>)), 垂直タブ
  
  " " (ASCII <return>32</return> (<return>0x20</return>)), 通常の空白。
  
  "\t" (ASCII <return>9</return> (<return>0x09</return>)), タブ。
  
  "\n" (ASCII <return>10</return> (<return>0x0A</return>)), リターン。
  
  "\r" (ASCII <return>13</return> (<return>0x0D</return>)), 改行。
  
  "\0" (ASCII <return>0</return> (<return>0x00</return>)), <return>NUL</return>バイト
  
  "\v" (ASCII <return>11</return>  (<return>0x0B</return>)), 垂直タブ

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>      ホワイトスペースを取り除く <info>string</info>
  <info>string</info>  <strong>$characters</strong>  <strong>$characters</strong>パラメータにより、削除する 文字を指定することも可能です。削除した
                       い全ての文字をリストに してください。<return>..</return>を文字の範囲を指定する際に 使用可能で
                       す。

<comment>Return:</comment>
  <info>string</info>  ホワイトスペースを取り除いた文字列

<comment>See Also:</comment>
   * <strong>ltrim()</strong>
   * <strong>rtrim()</strong>
   * <strong>str_replace()</strong>


id: uasort
type: function
doc:
<comment>Description:</comment>
  ユーザー定義の比較関数で配列をソートし、連想インデックスを保持する
  
  インデックスとそれに対応する要素を関連づけて <strong>$array</strong> をソートします。 ソートには、ユーザー定義の比
  較関数を使います。
  
  主に実際の配列の順序に意味がある連想配列をソートするためにこの関数は使用されます。
  
  比較結果が等しくなる二つの要素があった場合、それらの並び順は保持されます。PHP 8.0.0 より前のバー
  ジョンでは、ソートした配列におけるそれらの並び順は不定でした。
  
  この関数をコールすると、配列の内部ポインタは最初の要素にリセットされます。

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

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

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


id: ucfirst
type: function
doc:
<comment>Description:</comment>
  文字列の最初の文字を大文字にする
  
  <strong>$string</strong> の最初の文字が <return>"a"</return> (0x61) から <return>"z"</return> (0x7a) までの ASCII 文字の場合、 それを大文字にします。

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

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

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


id: ucwords
type: function
doc:
<comment>Description:</comment>
  文字列の各単語の最初の文字を大文字にする
  
  文字が <return>"a"</return> (0x61) から <return>"z"</return> (0x7a) までのアルファベットの場合、 <strong>$string</strong> の各単語の最初の文字を大文
  字にしたものを返します。
  
  この関数における "単語" とは、 <strong>$separators</strong> に含まれていない文字からなる文字列です。 <strong>$separators</strong> の
  デフォルトはスペース、 フォームフィード、改行、キャリッジリターン、 水平タブ、垂直タブ です。
  
  マルチバイト文字列に対して類似の変換を行うには、 <strong>mb_convert_case()</strong> を <info>MB_CASE_TITLE</info> モードで使いま
  す。

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>      入力文字列。
  <info>string</info>  <strong>$separators</strong>  オプションの <strong>$separators</strong> で、単語の区切り文字を指定します。

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

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


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

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

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

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


id: umask
type: function
doc:
<comment>Description:</comment>
  現在の umask を変更する
  
  <strong>umask()</strong> は PHP の umask を <strong>$mask</strong> & 0777 にセットし、 元の umask 値を返します。 PHP がサーバー・モ
  ジュールとして動作中の場合、 各リクエストが終了するたびに umask は元の値に戻されます。

<comment>Param:</comment>
  <info>int|null</info>  <strong>$mask</strong>  新しい umask。

<comment>Return:</comment>
  <info>int</info>  <strong>$mask</strong> が <info>null</info> の場合、 <strong>umask()</strong>は単に現在の umask 値を返します。 そうでない場合、元の umask 値
       を返します。


id: uniqid
type: function
doc:
<comment>Description:</comment>
  一意な ID を生成する
  
  マイクロ秒単位の現在時刻にもとづいた、接頭辞つきの一意な ID を取得します。
  
  この関数が生成する値は、暗号学的にセキュアではありません。そのため、これを暗号や、戻り値を推測でき
  ないことが必須の値として使っては いけません。
  
  暗号学的にセキュアな乱数が必要な場合は、<class>Random\Randomizer</class> を <class>Random\Engine\Secure</class> と一緒に使いま
  しょう。簡単なユースケースの場合、<strong>random_int()</strong> と <strong>random_bytes()</strong> 関数が、オペレーティングシステム
  の CSPRNG を使った、 便利で安全な API を提供します。
  
  この関数は、戻り値の一意性を保証するものではありません。 ほとんどのシステムは、NTP などでシステム
  クロックを調整するので、 システム時刻は絶えず変更されます。 したがって、この関数がプロセス/スレッ
  ドの一意の ID を返さない可能性があります。 一意性を高めるには、<strong>$more_entropy</strong> を使用してください。

<comment>Param:</comment>
  <info>string</info>  <strong>$prefix</strong>        これが有用なのは、たとえば複数ホストで同時に ID を生成するような場合です。
                         このような場合、同じマイクロ秒で同じ ID が生成されてしまう可能性がありま
                         す。
                         
                         空の <strong>$prefix</strong> を指定すると、 返される文字列は 13 文字となります。
                         <strong>$more_entropy</strong> が <info>true</info> の場合は 23 文字となります。
  <info>bool</info>    <strong>$more_entropy</strong>  <info>true</info> にすると、<strong>uniqid()</strong> は 戻り値の最後にさらに別のエントロピーを (線形合同
                         法を使用して) 追加します。これにより、結果が一意になる可能性を高めます。

<comment>Return:</comment>
  <info>string</info>  タイムスタンプにもとづいた一意な識別子を文字列で返します。
          
          この関数は一意な識別子を作成しようとしますが、 戻り値の一意性を完全に保証するものではあり
          ません。

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


id: unixtojd
type: function
doc:
<comment>Description:</comment>
  Unix タイムスタンプをユリウス歴に変換する
  
  Unix タイムスタンプ(1970/1/1 からの秒数)<strong>$timestamp</strong> をユリウス歴に変換して返します。<strong>$timestamp</strong> が
  指定されない場合は現在の日付が使用されます。 どちらの場合でも、時刻は地方時間と見なされます(UTCで
  はありません)。

<comment>Param:</comment>
  <info>int|null</info>  <strong>$timestamp</strong>  変換したい Unix タイムスタンプ。

<comment>Return:</comment>
  <info>int|false</info>  ユリウス積算日を表す整数値を返します。 失敗した場合に <info>false</info> を返します

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


id: unlink
type: function
doc:
<comment>Description:</comment>
  ファイルを削除する
  
  <strong>$filename</strong> を削除します。 Unix C 言語の関数 unlink() と動作は同じです。 失敗した場合は <info>E_WARNING</info> レ
  ベルのエラーが発生します。

<comment>Param:</comment>
  <info>string</info>         <strong>$filename</strong>  ファイルへのパス。
                            
                            ファイルがシンボリックリンクの場合、シンボリックリンクが削除されます。
                            Windows では、ディレクトリへのシンボリックリンクを削除するには <strong>rmdir()</strong>
                            を使う必要があります。
  <info>resource|null</info>  <strong>$context</strong>   ストリームコンテキストリソース

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

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


id: unpack
type: function
doc:
<comment>Description:</comment>
  バイナリ文字列からデータを切り出す
  
  <strong>$format</strong> に基づき、バイナリ文字列から配列に分解します。
  
  分解した結果は連想配列に格納されます。 このようにするには、別のフォーマットコードを使用してそれら
  を スラッシュ / で区切る必要があります。 引数にリピータが含まれる場合の配列の要素名は、 指定した名
  前の後に順番に番号がついたものとなります。
  
  Perl の関数に動きを近づけるために、以下の変更が行われています:  "a" は最後の NULL バイトを維持しま
  す。  "A" は最後の ASCII 空白文字 (スペース、タブ、改行、キャリッジリターン、 NULL バイト) をすべ
  て取り除きます。  NULL 埋め文字列用に "Z" が追加されました。 これは最後の NULL バイトを取り除きま
  す。

<comment>Param:</comment>
  <info>string</info>  <strong>$format</strong>  書式コードの説明は <strong>pack()</strong> を参照ください。
  <info>string</info>  <strong>$string</strong>  パックされたデータ。
  <info>int</info>     <strong>$offset</strong>  データ切り出しを開始するオフセット。

<comment>Return:</comment>
  <info>array|false</info>  バイナリ文字列を切り出した要素を含む連想配列を返します。失敗した場合に <info>false</info> を返しま
               す

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


id: unregister_tick_function
type: function
doc:
<comment>Description:</comment>
  各 tick の実行用の関数の登録を解除する
  
  <strong>$callback</strong> という名前の関数の登録を解除します。 これにより、tick がコールされた 場合でもこの関数は
  実行されなくなります。

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  登録を解除する関数

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

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


id: unserialize
type: function
doc:
<comment>Description:</comment>
  保存用表現から PHP の値を生成する
    
  
  <strong>unserialize()</strong> は、シリアル化された変数を PHP の値に戻す変換(アンシリアライズ)を行います。
  
  <return>allowed_classes</return> の <strong>$options</strong> の値にかかわらず、 ユーザーからの入力をそのまま <strong>unserialize()</strong> に渡して
  はいけません。 アンシリアライズの時には、オブジェクトのインスタンス生成やオートローディングなどで
  コードが実行されることがあり、悪意のあるユーザーがこれを悪用するかもしれないからです。 シリアル化
  したデータをユーザーに渡す必要がある場合は、安全で標準的なデータ交換フォーマットである JSON などを
  使うようにしましょう。 <strong>json_decode()</strong> および <strong>json_encode()</strong> を利用します。
  
  外部に保存されているシリアル化されたデータをアンシリアライズする必要がある場合は、 <strong>hash_hmac()</strong> を
  使ったデータの検証を検討しましょう。 他者によるデータの改ざんがないことを確かめるためです。

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>     シリアル化された文字列。
                    
                    もしアンシリアライズする変数がオブジェクトの場合、 オブジェクトが無事再作成され
                    た後、PHP は自動的にメンバ関数 __unserialize() または __wakeup() (存在していれ
                    ば) をコールしようとします。
                    
                    unserialize_callback_func ディレクティブ コールバック関数を設定することが可能で
                    す。(不完全な <info>object</info> "__PHP_Incomplete_Class"を得ることを防ぐため) コールバック
                    関数は、非シリアル化する際に未定義のクラスをインスタ ンス化する必要がある場合に
                    コールされます。 '<return>unserialize_callback_func</return>'を定義するためには、 php.ini,
                    <strong>ini_set()</strong>, .htaccess を使用し てください。未定義のクラスをインスタンス化する度
                    に、コールバック関 数がコールされます。この機能を無効とするには、 単純にこの設定
                    を空にしてください。
                    
                    コールバック関数を設定することが可能です。(不完全な <info>object</info>
                    "__PHP_Incomplete_Class"を得ることを防ぐため) コールバック関数は、非シリアル化す
                    る際に未定義のクラスをインスタ ンス化する必要がある場合にコールされます。
                    '<return>unserialize_callback_func</return>'を定義するためには、 php.ini, <strong>ini_set()</strong>, .htaccess を
                    使用し てください。未定義のクラスをインスタンス化する度に、コールバック関 数が
                    コールされます。この機能を無効とするには、 単純にこの設定を空にしてください。
  <info>array</info>   <strong>$options</strong>  <strong>unserialize()</strong> に連想配列で渡すオプション。
                    
                    受け付けるクラス名の配列を指定します。あらゆるクラスを拒否する場合は <info>false</info>、あら
                    ゆるクラスを受け付ける場合は <info>true</info> を指定します。 このオプションを指定していると
                    きに、もし <strong>unserialize()</strong> が受け付け対象外のクラスのオブジェクトに遭遇すると、 そ
                    のオブジェクトを <class>__PHP_Incomplete_Class</class> のインスタンスに変換します。
                    
                    このオプションを省略すると、<info>true</info> を指定したのと同じ意味になります。 つまり、PHP
                    はあらゆるクラスのオブジェクトをインスタンス化しようとします。
                    
                    アンシリアライズ処理の間に許される、 データ構造の再帰の深さの最大値を設定しま
                    す。 これは、スタックオーバーフローを防ぐためのものです。 デフォルトの深さの最大
                    値は <return>4096</return> であり、 <return>0</return> に設定すると、 この制限を無効にすることができます。

<comment>Return:</comment>
  <info>mixed</info>  変換された値が返されます。その値は、 <info>bool</info>, <info>int</info>, <info>float</info>, <info>string</info>, <info>array</info>, <info>object</info> のいずれかとな
         ります。
         
         渡された文字列が復元できなかった場合、<info>false</info> を返して <info>E_NOTICE</info> を発生します。

<comment>See Also:</comment>
   * <strong>json_encode()</strong>
   * <strong>json_decode()</strong>
   * <strong>hash_hmac()</strong>
   * <strong>serialize()</strong>
   * クラスのオートローディング
   * unserialize_callback_func
   * unserialize_max_depth
   * __wakeup()
   * __serialize()
   * __unserialize()


id: unset
type: function
doc:
<comment>Description:</comment>
  指定した変数の割当を解除する
  
  <strong>unset()</strong> は指定した変数を破棄します。
  
  関数 <strong>unset()</strong> の内部動作は、 破棄しようとする変数の型に依存します。
  
  あるグローバル変数が関数の中で <strong>unset()</strong> された場合、ローカル変数のみが破棄されます。呼出側の環境に
  ある変数は、 <strong>unset()</strong> がコールされる前と同じ値を保持します。
  ]]>
  
  上の例の出力は以下となります。
  
  
  
  グローバル変数を関数の内部で <strong>unset()</strong> するには、 $GLOBALS 配列を使います。 
  ]]>
  
  参照渡しされた変数が関数内で <strong>unset()</strong> された場合に、 ローカル変数のみが破棄されます。呼出側の環境で
  その変数は、 <strong>unset()</strong> がコールされる前と同じ値を保持します。
  ]]>
  
  上の例の出力は以下となります。
  
  
  
  static変数が関数の内部で <strong>unset()</strong> された場合、 <strong>unset()</strong> は、その関数の残りのコンテキスト内においての
  み 変数を破棄します。関数を再度コールすると、破棄する前の値が復元されます。
  ]]>
  
  上の例の出力は以下となります。
  
  

<comment>Param:</comment>
  <info>mixed</info>  <strong>$var</strong>   破棄する変数。
  <info>mixed</info>  <strong>$vars</strong>  別の変数。

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

<comment>See Also:</comment>
   * <strong>isset()</strong>
   * <strong>empty()</strong>
   * __unset()
   * <strong>array_splice()</strong>
   * (unset) casting


id: untaint
type: function
doc:
<comment>Description:</comment>
  文字列の汚染を除去する
  
  文字列の汚染を除去します。

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

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


id: uopz_add_function
type: function
doc:
<comment>Description:</comment>
  Adds non-existent function or method
  
  Adds a non-existent function or method.

<comment>Param:</comment>
  <info>string</info>   <strong>$class</strong>     The name of the class.
  <info>string</info>   <strong>$function</strong>  The name of the function or method.
  <info>Closure</info>  <strong>$handler</strong>   The <class>Closure</class> that defines the new function or method.
  <info>int</info>      <strong>$flags</strong>     Flags to set for the new function or method.
  <info>int</info>      <strong>$all</strong>       Whether all classes that descend from <strong>$class</strong> will also be affected.

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

<comment>See Also:</comment>
   * <strong>uopz_del_function()</strong>
   * <strong>uopz_set_return()</strong>


id: uopz_allow_exit
type: function
doc:
<comment>Description:</comment>
  Allows control over disabled exit opcode
  
  By default uopz disables the exit opcode, so <strong>exit()</strong> calls are practically ignored.
  <strong>uopz_allow_exit()</strong> allows to control this behavior.

<comment>Param:</comment>
  <info>bool</info>  <strong>$allow</strong>  Whether to allow the execution of exit opcodes or not.

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

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


id: uopz_backup
type: function
doc:
<comment>Description:</comment>
  Backup a function
  
  Backup a function at runtime, to be restored on shutdown

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

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


id: uopz_compose
type: function
doc:
<comment>Description:</comment>
  Compose a class
  
  Creates a new class of the given name that implements, extends, or uses all of the provided
  classes

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>        A legal class name
  <info>array</info>   <strong>$classes</strong>     An array of class, interface and trait names
  <info>array</info>   <strong>$methods</strong>     An associative array of methods, values are either closures or [modifiers
                       =&gt; closure]
  <info>array</info>   <strong>$properties</strong>  An associative array of properties, keys are names, values are modifiers
  <info>int</info>     <strong>$flags</strong>       Entry type, by default ZEND_ACC_CLASS

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


id: uopz_copy
type: function
doc:
<comment>Description:</comment>
  Copy a function
  
  Copy a function by name

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

<comment>Return:</comment>
  <info>Closure</info>  A Closure for the specified function


id: uopz_del_function
type: function
doc:
<comment>Description:</comment>
  Deletes previously added function or method
  
  Deletes a previously added function or method.

<comment>Param:</comment>
  <info>string</info>  <strong>$class</strong>     The name of the class.
  <info>string</info>  <strong>$function</strong>  The name of the function or method.
  <info>int</info>     <strong>$all</strong>       Whether all classes that descend from <strong>$class</strong> will also be affected.

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

<comment>See Also:</comment>
   * <strong>uopz_add_function()</strong>
   * <strong>uopz_unset_return()</strong>


id: uopz_delete
type: function
doc:
<comment>Description:</comment>
  Delete a function
  
  Deletes a function or method

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

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


id: uopz_extend
type: function
doc:
<comment>Description:</comment>
  実行時にクラスを継承させる
  
  <strong>$class</strong> に <strong>$parent</strong> を継承させます。

<comment>Param:</comment>
  <info>string</info>  <strong>$class</strong>   拡張するクラスの名前
  <info>string</info>  <strong>$parent</strong>  継承するクラスの名前

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


id: uopz_flags
type: function
doc:
<comment>Description:</comment>
  関数またはクラスのフラグを 取得/設定 する
  
  実行時にクラスまたは関数エントリのフラグを 取得/設定 します。

<comment>Param:</comment>
  <info>string</info>  <strong>$class</strong>     クラス名を指定します。
  <info>string</info>  <strong>$function</strong>  関数名を指定します。 <strong>$class</strong> が指定され、 かつ <strong>$function</strong> の値にから文字列が指定
                     されると、 <strong>uopz_flags()</strong> はクラスエントリのフラグを取得または設定します。
  <info>int</info>     <strong>$flags</strong>     ZEND_ACC_ フラグの有効なセット。 省略された場合、<strong>uopz_flags()</strong> 関数が getter と
                     して振る舞います。

<comment>Return:</comment>
  <info>int</info>  フラグを設定する場合、古いフラグを返します。それ以外の場合、現在のフラグを返します。


id: uopz_function
type: function
doc:
<comment>Description:</comment>
  Creates a function at runtime
  
  Creates a function at runtime

<comment>Param:</comment>
  <info>string</info>   <strong>$class</strong>      The name of the class to receive the new function
  <info>string</info>   <strong>$function</strong>   The name of the function
  <info>Closure</info>  <strong>$handler</strong>    The Closure for the function
  <info>int</info>      <strong>$modifiers</strong>  The modifiers for the function, by default copied or ZEND_ACC_PUBLIC

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


id: uopz_get_exit_status
type: function
doc:
<comment>Description:</comment>
  Retrieve the last set exit status
  
  Retrieves the last set exit status, i.e. the value passed to <strong>exit()</strong>.

<comment>Return:</comment>
  <info>mixed</info>  This function returns the last exit status, or <info>null</info> if <strong>exit()</strong> has not been called.

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


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

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

<comment>Return:</comment>
  <info>Closure</info>  Returns the previously set hook on a function or method, or <info>null</info> if no hook has been set.

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


