# php_manual

id: openssl_csr_get_public_key
type: function
doc:
<comment>Description:</comment>
  CSR の公開鍵を返す
  
  <strong>openssl_csr_get_public_key()</strong> 関数は、 <strong>$csr</strong> から公開鍵を展開し、他の関数で利用できるよう準備しま
  す。

<comment>Param:</comment>
  <info>OpenSSLCertificateSigningRequest|string</info>  <strong>$csr</strong>          使用できる値の一覧は CSR パラメータ を参照
                                                         ください。
  <info>bool</info>                                     <strong>$short_names</strong>  このパラメータは無視されます。

<comment>Return:</comment>
  <info>OpenSSLAsymmetricKey|false</info>  成功した場合、<class>OpenSSLAsymmetricKey</class> クラスのインスタンスを返します。 エ
                              ラーの場合は <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>openssl_csr_get_subject()</strong>
   * <strong>openssl_csr_new()</strong>
   * <strong>openssl_pkey_get_details()</strong>
   * <strong>openssl_pkey_export_to_file()</strong>
   * <strong>openssl_pkey_export()</strong>


id: openssl_csr_get_subject
type: function
doc:
<comment>Description:</comment>
  CSR の subject を返す
  
  <strong>openssl_csr_get_subject()</strong> 関数は、 <strong>$csr</strong> にエンコードされた subject の識別名の情報を返します。
  commonName (CN), organizationName (O), countryName (C) などが含まれます。

<comment>Param:</comment>
  <info>OpenSSLCertificateSigningRequest|string</info>  <strong>$csr</strong>          使用できる値の一覧は CSR パラメータ を参照
                                                         ください。
  <info>bool</info>                                     <strong>$short_names</strong>  <strong>$shortnames</strong> は、配列でデータがどのように イ
                                                         ンデックスされるかを制御します -
                                                         <strong>$shortnames</strong> が <info>true</info> の場合(デフォルト)、
                                                         フィールドは短縮名を使ってインデックスされ
                                                         ます。 <info>false</info> の場合、長い名前を使ってイン
                                                         デックされます - たとえば、 CN は
                                                         commonName の短縮名です。

<comment>Return:</comment>
  <info>array|false</info>  subject の説明を記した連想配列を返します。失敗した場合に <info>false</info> を返します

<comment>See Also:</comment>
   * <strong>openssl_csr_new()</strong>
   * <strong>openssl_csr_get_public_key()</strong>
   * <strong>openssl_x509_parse()</strong>


id: openssl_csr_new
type: function
doc:
<comment>Description:</comment>
  CSR を作成する
  
  <strong>openssl_csr_new()</strong> は、新しい CSR を <strong>$distinguished_names</strong> の情報に基づいて作成します。
  
  この関数を正しく動作させるには、正しい形式の openssl.cnf をインストールしておく必要があります。 詳
  細な情報は、インストールについてのセクション を参照ください。

<comment>Param:</comment>
  <info>array</info>                 <strong>$distinguished_names</strong>  証明書で使用される識別名、またはsubjectフィールド。
  <info>OpenSSLAsymmetricKey</info>  <strong>$private_key</strong>          <strong>$private_key</strong> には、事前に <strong>openssl_pkey_new()</strong> （あるい
                                              はその他の openssl_pkey 系の関数）で作成した秘密鍵を設
                                              定します。 これに対応する公開鍵が、CSR への署名に使用
                                              されます。
  <info>array|null</info>            <strong>$options</strong>              デフォルトでは、システムの <return>openssl.conf</return> の設定に した
                                              がってリクエストが初期化されます。<strong>$options</strong> のキー
                                              <return>config_section_section</return> を設定することで、この デフォル
                                              ト項目を変更することが可能です。また、キー <return>config</return> に別
                                              の openssl 設定ファイルを指定することで別の設定を使用
                                              することも可能です。 もし <strong>$options</strong> に以下の表のキーが
                                              存在すれば、それらは <return>openssl.conf</return> の対応する項目と同じ
                                              働きをします。 設定の上書き<strong>$options</strong> のキー型
                                              <return>openssl.conf</return> で同等の意味を持つ項目説明
                                              digest_alg<info>string</info>default_md ダイジェストメソッド、また
                                              は署名のハッシュ。  通常は <strong>openssl_get_md_methods()</strong> 関
                                              数のリストのうちのひとつです。
                                              x509_extensions<info>string</info>x509_extensionsx509 証明書を作成
                                              する際に使用する拡張モジュールを選択します
                                              req_extensions<info>string</info>req_extensionsCSR を作成する際に使
                                              用する拡張モジュールを選択します
                                              private_key_bits<info>int</info>default_bits秘密鍵を作成する際に使
                                              用するビット数を指定しますprivate_key_type<info>int</info>none作成
                                              する秘密鍵の型を指定します。以下の定数
                                              <info>OPENSSL_KEYTYPE_DSA</info>, <info>OPENSSL_KEYTYPE_DH</info>
                                              <info>OPENSSL_KEYTYPE_RSA</info> あるいは <info>OPENSSL_KEYTYPE_EC</info> からひ
                                              とつ選択します。 デフォルト値は <info>OPENSSL_KEYTYPE_RSA</info> で
                                              す。 encrypt_key<info>bool</info>encrypt_key（パスフレーズととも
                                              に）エクスポートされるキーを暗号化する
                                              か?encrypt_key_cipher<info>int</info>none暗号定数のうちの一つ。
                                              curve_name<info>string</info>none<strong>openssl_get_curve_names()</strong> のうちの
                                              一つ。 config<info>string</info>N/A 代替の openssl.conf ファイルの
                                              パス
  <info>array|null</info>            <strong>$extra_attributes</strong>     <strong>$extra_attributes</strong> は、CSR に関する追加の設定情報を 設
                                              定するために使用します。<strong>$distinguished_names</strong> および
                                              <strong>$extra_attributes</strong> はどちらも連想配列で、それらの キー
                                              が OID に変換されたうえでリクエストの関連する部分に適
                                              用されます。

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

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


id: openssl_csr_sign
type: function
doc:
<comment>Description:</comment>
  CSR に他の証明書（あるいは自分自身）で署名して証明書を作成する
  
  <strong>openssl_csr_sign()</strong> は、 指定した CSR を用いて x509 証明書を作成します。
  
  この関数を正しく動作させるには、正しい形式の openssl.cnf をインストールしておく必要があります。 詳
  細な情報は、インストールについてのセクション を参照ください。

<comment>Param:</comment>
  <info>OpenSSLCertificateSigningRequest|string</info>               <strong>$csr</strong>             事前に <strong>openssl_csr_new()</strong> で
                                                                         作成した CSR。
                                                                         file://path/to/csr のように
                                                                         指定された PEM エンコードさ
                                                                         れた CSR へのパス、 あるい
                                                                         は <strong>openssl_csr_export()</strong> で
                                                                         生成した文字列も使用可能で
                                                                         す。
  <info>OpenSSLCertificate|string|null</info>                        <strong>$ca_certificate</strong>  作成された証明書は
                                                                         <strong>$ca_certificate</strong> で署名され
                                                                         ます。 <strong>$ca_certificate</strong> が
                                                                         <info>null</info> の場合は、自己署名の証
                                                                         明書となります。
  <info>OpenSSLAsymmetricKey|OpenSSLCertificate|array|string</info>  <strong>$private_key</strong>     <strong>$private_key</strong> は
                                                                         <strong>$ca_certificate</strong> に対応する
                                                                         秘密鍵です。
  <info>int</info>                                                   <strong>$days</strong>            <strong>$days</strong> は、作成された証明書
                                                                         の有効期限を日数で指定しま
                                                                         す。
  <info>array|null</info>                                            <strong>$options</strong>         <strong>$options</strong> で CSR の詳細設定
                                                                         が可能です。 <strong>$options</strong> につ
                                                                         いての詳細な情報は
                                                                         <strong>openssl_csr_new()</strong> を参照く
                                                                         ださい。
  <info>int</info>                                                   <strong>$serial</strong>          発行される証明書のシリアル
                                                                         番号を、オプションで指定し
                                                                         ます。 省略した場合のデフォ
                                                                         ルトは 0 です。

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


id: openssl_decrypt
type: function
doc:
<comment>Description:</comment>
  データを復号する
  
  未加工の、または base64 エンコードされた文字列を受け取り、 与えられた暗号化方式とキーを使って文字
  列を復号します。

<comment>Param:</comment>
  <info>string</info>       <strong>$data</strong>         復号化する、暗号化されたメッセージ。
  <info>string</info>       <strong>$cipher_algo</strong>  暗号化方式。利用可能な暗号化方式のリストについては、
                             <strong>openssl_get_cipher_methods()</strong> を使用してください。
  <info>string</info>       <strong>$passphrase</strong>   キー
  <info>int</info>          <strong>$options</strong>      <info>OPENSSL_RAW_DATA</info> あるいは <info>OPENSSL_ZERO_PADDING</info> のいずれか。
  <info>string</info>       <strong>$iv</strong>           NULL ではない初期化ベクトル
  <info>string|null</info>  <strong>$tag</strong>          AEAD 暗号モードの認証タグ。 正しくない場合、認証は失敗し、関数は <info>false</info>
                             を返します。
                             
                             <strong>$tag</strong> の長さをこの関数はチェックしません。 この値の長さは
                             <strong>openssl_encrypt()</strong> を呼び出した時に取得できるものと一致させなければなら
                             ず、それは呼び出し側の責任です。 一致しない場合でも、与えられた値が適切
                             な tag の先頭部分と一致した場合に復号が成功するかもしれません。
  <info>string</info>       <strong>$aad</strong>          追加の認証済みデータ。

<comment>Return:</comment>
  <info>string|false</info>  成功した場合復号化された文字列、失敗した場合に <info>false</info> を返します。

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


id: openssl_dh_compute_key
type: function
doc:
<comment>Description:</comment>
  ローカルのDH秘密鍵とリモート側のDH公開鍵を使い、共有シークレットを計算する
  
  <strong>openssl_dh_compute_key()</strong> 関数が返す共有シークレットは、 リモート側と秘密の通信をするための暗号鍵と
  してよく使われます。 これはディフィー・ヘルマン鍵共有として知られています。
  
  ECDH は、PHP 8.1.0 以降、かつ OpenSSL 3.0.0 以降でのみサポートされています。

<comment>Param:</comment>
  <info>string</info>                <strong>$public_key</strong>   リモート側の DH 公開鍵
  <info>OpenSSLAsymmetricKey</info>  <strong>$private_key</strong>  ローカル側の DH 秘密鍵。 これは、リモート側と共有している公開
                                      鍵に対応します。

<comment>Return:</comment>
  <info>string|false</info>  成功した場合、共有シークレットを返します。 失敗した場合に <info>false</info> を返します.

<comment>See Also:</comment>
   * <strong>openssl_pkey_new()</strong>
   * <strong>openssl_pkey_get_details()</strong>
   * <strong>openssl_pkey_get_private()</strong>
   * <strong>openssl_pkey_get_public()</strong>


id: openssl_digest
type: function
doc:
<comment>Description:</comment>
  ダイジェストを計算する
  
  与えられたメソッドを使って、与えられたデータに対するダイジェスト・ハッシュ値を計算し、 未加工の、
  または binhex エンコードされた文字列を返します。

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>         データ
  <info>string</info>  <strong>$digest_algo</strong>  ダイジェスト・メソッド。例: "sha256"。 利用可能なダイジェストメソットの一覧
                        は、 <strong>openssl_get_md_methods()</strong> を参照ください。
  <info>bool</info>    <strong>$binary</strong>       <info>true</info> に設定すると未加工の出力データとして返します。 そうでなければ binhex エ
                        ンコードされた値を返します。

<comment>Return:</comment>
  <info>string|false</info>  成功した場合ダイジェスト・ハッシュ値、失敗した場合に <info>false</info> を返します。

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


id: openssl_encrypt
type: function
doc:
<comment>Description:</comment>
  データを暗号化する
  
  与えられた文字列を与えられたメソッドとキーで暗号化して、 未加工の、または base64 エンコードされた
  文字列を返します。

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>         暗号化するプレーンテキストメッセージ
  <info>string</info>  <strong>$cipher_algo</strong>  暗号メソッド。 使用可能なメソッドの一覧を取得するには、
                        <strong>openssl_get_cipher_methods()</strong> を用います。
  <info>string</info>  <strong>$passphrase</strong>   パスフレーズ。 期待された長さより短かった場合は、 黙って<return>NUL</return> 文字で埋められま
                        す。 期待された長さより長かった場合は、 黙って切り詰められます。
  <info>int</info>     <strong>$options</strong>      <info>OPENSSL_RAW_DATA</info> と <info>OPENSSL_ZERO_PADDING</info> のビット OR。
  <info>string</info>  <strong>$iv</strong>           NULL ではない初期化ベクトル。
  <info>string</info>  <strong>$tag</strong>          AEAD 暗号モード (GCM または CCM) を使う場合の 認証タグをリファレンスで渡しま
                        す。
  <info>string</info>  <strong>$aad</strong>          追加の認証済みデータ
  <info>int</info>     <strong>$tag_length</strong>   認証 <strong>$tag</strong> の長さ。 GCMモードでは、この値は 4 から 16 の間です。

<comment>Return:</comment>
  <info>string|false</info>  成功した場合暗号化された文字列、失敗した場合に <info>false</info> を返します。

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


id: openssl_error_string
type: function
doc:
<comment>Description:</comment>
  OpenSSL エラーメッセージを返す
  
  <strong>openssl_error_string()</strong> は、 OpenSSL ライブラリから直近のエラーを返します。 エラーメッセージは
  キューに格納されるので、 すべての情報を集めるにはこの関数を複数回コールする必要があります。 最後の
  エラーが、いちばん最近に発生したエラーとなります。

<comment>Return:</comment>
  <info>string|false</info>  エラーメッセージ文字列を返します。 エラーメッセージがもうない場合は、<info>false</info> を返しま
                す。


id: openssl_free_key
type: function
doc:
<comment>Description:</comment>
  キーリソースを開放する
  
  <strong>openssl_free_key()</strong> は、指定した <strong>$key</strong> が指すキーをメモリから開放します。

<comment>Param:</comment>
  <info>OpenSSLAsymmetricKey</info>  <strong>$key</strong>  

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


id: openssl_get_cert_locations
type: function
doc:
<comment>Description:</comment>
  有効な証明書の格納場所を検索する
  
  <strong>openssl_get_cert_locations()</strong> は SSL 証明書の検出された有効な証明書の格納場所についての 情報の配列
  を返します。

<comment>Return:</comment>
  <info>array</info>  有効な証明書の格納場所の配列を返します。


id: openssl_get_cipher_methods
type: function
doc:
<comment>Description:</comment>
  利用可能な暗号メソッドを取得
  
  利用可能な暗号メソッドの一覧を取得します。

<comment>Param:</comment>
  <info>bool</info>  <strong>$aliases</strong>  返される <info>array</info> に暗号のエイリアスを含めるべき場合、 <info>true</info> に設定します

<comment>Return:</comment>
  <info>array</info>  利用可能な暗号メソッドの <info>array</info> OpenSSL 1.1.1 より前のバージョンでは、 暗号メソッドは大文
         字、小文字両方で記されたものを返していました。 OpenSSL 1.1.1 以降では、小文字のみで記された
         ものが返されることに注意して下さい。

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


id: openssl_get_curve_names
type: function
doc:
<comment>Description:</comment>
  ECC で利用可能な楕円曲線の名前を取得する
  
  楕円曲線暗号(ECC) の公開鍵/秘密鍵の操作に使う、 利用可能な楕円曲線の名前の一覧を取得します。 もっ
  とも広く使われている標準的な/サポートされている曲線名は prime256v1  (NIST P-256) と secp384r1
  (NIST P-384) です。 AES, RSA, DSA のキーサイズとおおよそ等しい ECC のキーサイズAES Symmetric
  Keysize (Bits)RSA and DSA Keysize (Bits)ECC Keysize
  (Bits)80102416011220482241283072256192768038425615360512 NIST  は ECC の楕円曲線を少なくとも
  256ビットで使うことを推奨しています

<comment>Return:</comment>
  <info>array|false</info>  利用可能な曲線名の <info>array</info> を返します。 失敗した場合に <info>false</info> を返します


id: openssl_get_md_methods
type: function
doc:
<comment>Description:</comment>
  利用可能なダイジェスト・メソッドを取得
  
  利用可能なダイジェスト・メソッドの一覧を取得します。

<comment>Param:</comment>
  <info>bool</info>  <strong>$aliases</strong>  返される <info>array</info> にダイジェストのエイリアスを含めるべき場合、 <info>true</info> に設定します

<comment>Return:</comment>
  <info>array</info>  利用可能なダイジェスト・メソッドの <info>array</info>

<comment>See Also:</comment>
   * <strong>openssl_digest()</strong>
   * <strong>openssl_get_cipher_methods()</strong>


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


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


id: openssl_open
type: function
doc:
<comment>Description:</comment>
  シール(暗号化)されたデータをオープン(復号)する
  
  <strong>openssl_open()</strong> は、キー ID <strong>$private_key</strong> およびエンベロープキー <strong>$encrypted_key</strong> に関連する公開鍵を使
  用して、 <strong>$data</strong> をオープン(復号)します。 その上で、<strong>$output</strong> を復号化したデータで埋めます。 エンベ
  ロープキーは、データがシール(暗号化)された際に生成され、特定の 一つの公開鍵でのみ使用することが可
  能です。詳細な情報については、 <strong>openssl_seal()</strong> を参照ください。

<comment>Param:</comment>
  <info>string</info>                                                <strong>$data</strong>           
  <info>string</info>                                                <strong>$output</strong>         成功した場合、オープンした
                                                                        データをここに返します。
  <info>string</info>                                                <strong>$encrypted_key</strong>  
  <info>OpenSSLAsymmetricKey|OpenSSLCertificate|array|string</info>  <strong>$private_key</strong>    
  <info>string</info>                                                <strong>$cipher_algo</strong>    暗号化方式  デフォルト値
                                                                        (<return>'RC4'</return>) はセキュアでない値で
                                                                        す。 明示的にセキュアな暗号
                                                                        化方式を指定することを強く推
                                                                        奨します。
                                                                        
                                                                        デフォルト値 (<return>'RC4'</return>) はセ
                                                                        キュアでない値です。 明示的
                                                                        にセキュアな暗号化方式を指定
                                                                        することを強く推奨します。
  <info>string|null</info>                                           <strong>$iv</strong>             初期化ベクトル。

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

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


id: openssl_pbkdf2
type: function
doc:
<comment>Description:</comment>
  PKCS5 v2 の PBKDF2 文字列を生成する
  
  <strong>openssl_pbkdf2()</strong> 関数は、PBKDF2 (Password-Based Key Derivation Function 2 の略。PKCS5 v2 で定義さ
  れている鍵導出関数) 文字列を計算します

<comment>Param:</comment>
  <info>string</info>  <strong>$password</strong>     導出されるキーを生成するパスワード
  <info>string</info>  <strong>$salt</strong>         PBKDF2 は、暗号化のソルトとして、少なくとも64ビット(8バイト)を推奨していま
                        す。
  <info>int</info>     <strong>$key_length</strong>   出力されるキーの長さ
  <info>int</info>     <strong>$iterations</strong>   イテレーションの回数。  NIST  は少なくとも10000を推奨しています.
  <info>string</info>  <strong>$digest_algo</strong>  オプションのハッシュまたはダイジェストアルゴリズム。 アルゴリズムの一覧は、
                        <strong>openssl_get_md_methods()</strong> で得られます。 デフォルトは SHA-1 です。

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

<comment>See Also:</comment>
   * <strong>hash_pbkdf2()</strong>
   * <strong>openssl_get_md_methods()</strong>


id: openssl_pkcs12_export
type: function
doc:
<comment>Description:</comment>
  PKCS#12 互換の証明書保存ファイルを変数にエクスポートする
  
  <strong>openssl_pkcs12_export()</strong> は、 <strong>$certificate</strong> を PKCS#12 ファイルフォーマットにしたものを <strong>$output</strong> で指
  定した文字列に格納します。

<comment>Param:</comment>
  <info></info>                                                      <strong>$x509</strong>         使用できる値の一覧は キー/証明
                                                                      書パラメータ を参照ください。
  <info>string</info>                                                <strong>$output</strong>       成功した場合に、ここに PKCS#12
                                                                      が保存されます。
  <info>OpenSSLAsymmetricKey|OpenSSLCertificate|array|string</info>  <strong>$private_key</strong>  PKCS#12 ファイルのプライベート
                                                                      キーコンポーネント。 正しい値
                                                                      の一覧については、
                                                                      Public/Private Key parameters
                                                                      を参照ください。
  <info>string</info>                                                <strong>$passphrase</strong>   PKCS#12 ファイルのロックを解除
                                                                      するためのパスワード。
  <info>array</info>                                                 <strong>$options</strong>      オプションの配列。以下に示す
                                                                      キー以外は無視されます。 キー
                                                                      説明<return>"extracerts"</return>PKCS#12 ファイ
                                                                      ルに含まれる単一の証明書、また
                                                                      は 外部の証明書の配列
                                                                      <return>"friendly_name"</return>与えられた証明
                                                                      書とキーで使われる文字列

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


id: openssl_pkcs12_export_to_file
type: function
doc:
<comment>Description:</comment>
  PKCS#12 互換の証明書保存ファイルをエクスポートする
  
  <strong>openssl_pkcs12_export_to_file()</strong> は、 <strong>$certificate</strong> をファイル <strong>$output_filename</strong> に PKCS#12 フォー
  マットで保存します。

<comment>Param:</comment>
  <info></info>                                                      <strong>$x509</strong>             使用できる値の一覧は キー
                                                                          /証明書パラメータ を参照く
                                                                          ださい。
  <info>string</info>                                                <strong>$output_filename</strong>  出力ファイルへのパス。
  <info>OpenSSLAsymmetricKey|OpenSSLCertificate|array|string</info>  <strong>$private_key</strong>      PKCS#12 ファイルのプライ
                                                                          ベートキーコンポーネント。
                                                                          正しい値の一覧については、
                                                                          Public/Private Key
                                                                          parameters を参照くださ
                                                                          い。
  <info>string</info>                                                <strong>$passphrase</strong>       PKCS#12 ファイルのロックを
                                                                          解除するためのパスワード。
  <info>array</info>                                                 <strong>$options</strong>          オプションの配列。以下に示
                                                                          すキー以外は無視されます。
                                                                          キー説明
                                                                          <return>"extracerts"</return>PKCS#12 ファイ
                                                                          ルに含まれる単一の証明書、
                                                                          または 外部の証明書の配列
                                                                          <return>"friendly_name"</return>与えられた
                                                                          証明書とキーで使われる文字
                                                                          列

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


id: openssl_pkcs12_read
type: function
doc:
<comment>Description:</comment>
  PKCS#12 認証ストアをパースして配列形式にする
  
  <strong>openssl_pkcs12_read()</strong> は、 <strong>$pkcs12</strong> で指定した PKCS#12 認証ストアをパースして <strong>$certificates</strong> で指定
  した配列に格納します。

<comment>Param:</comment>
  <info>string</info>  <strong>$pkcs12</strong>        認証ストアの内容。ファイル名ではありません。
  <info>array</info>   <strong>$certificates</strong>  成功した場合に、ここに認証ストアデータが格納されます。
  <info>string</info>  <strong>$passphrase</strong>    PKCS#12 ファイルのロックを解除するためのパスワード。

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


id: openssl_pkcs7_decrypt
type: function
doc:
<comment>Description:</comment>
  S/MIME 暗号化されたメッセージを復号する
  
  <strong>$input_filename</strong> で指定したファイル中の S/MIME 暗号化されたメッセージを、 <strong>$certificate</strong> と
  <strong>$private_key</strong> で 指定した証明書とそれに関連付けられた秘密鍵を用いて復号します。

<comment>Param:</comment>
  <info>string</info>                                                     <strong>$input_filename</strong>   
  <info>string</info>                                                     <strong>$output_filename</strong>  復号したメッセージ
                                                                               は、<strong>$output_filename</strong>
                                                                               で指定したファイルに
                                                                               出力されます。
  <info>OpenSSLCertificate|string</info>                                  <strong>$certificate</strong>      
  <info>OpenSSLAsymmetricKey|OpenSSLCertificate|array|string|null</info>  <strong>$private_key</strong>      

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


id: openssl_pkcs7_encrypt
type: function
doc:
<comment>Description:</comment>
  S/MIME メッセージを暗号化する
  
  <strong>openssl_pkcs7_encrypt()</strong> は、 <strong>$input_filename</strong> という名前のファイルの内容を RC2 40 ビット暗号により
  暗号化します。この内容は、 <strong>$certificate</strong> で指定した意図する受信者によってのみ読むことが可能です。

<comment>Param:</comment>
  <info>string</info>                           <strong>$input_filename</strong>   
  <info>string</info>                           <strong>$output_filename</strong>  
  <info>OpenSSLCertificate|array|string</info>  <strong>$certificate</strong>      X.509 証明書または X.509 証明書の配列。
  <info>array|null</info>                       <strong>$headers</strong>          <strong>$headers</strong> は、 暗号化された後にデータの前に付加
                                                     されるヘッダの配列です。
                                                     
                                                     <strong>$headers</strong> はヘッダ名をキーとする連想配列または添
                                                     字配列であり、 各要素には、各ヘッダ行が一行ずつ
                                                     含まれています。
  <info>int</info>                              <strong>$flags</strong>            <strong>$flags</strong> は オプションとして使用可能であり、エン
                                                     コード処理を変更するために指定します。 PKCS7 定
                                                     数 を参照ください。
  <info>int</info>                              <strong>$cipher_algo</strong>      暗号定数のうちの一つ。

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


id: openssl_pkcs7_read
type: function
doc:
<comment>Description:</comment>
  PKCS7 ファイルを PEM証明書 の配列にエクスポートする
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>          パースしたい文字列データ(p7b フォーマット)
  <info>array</info>   <strong>$certificates</strong>  p7b フォーマットの入力データからエクスポートされる、 PEM証明書の配列。

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

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


id: openssl_pkcs7_sign
type: function
doc:
<comment>Description:</comment>
  S/MIME メッセージに署名する
  
  <strong>openssl_pkcs7_sign()</strong> は <strong>$input_filename</strong> という名前のファイルの内容を取得し、 パラメータ
  <strong>$certificate</strong> と <strong>$private_key</strong>で 指定した証明書とそれに対応する秘密鍵を用いて署名します。

<comment>Param:</comment>
  <info>string</info>                                                <strong>$input_filename</strong>                   デジタル署
                                                                                          名したい入
                                                                                          力ファイル
  <info>string</info>                                                <strong>$output_filename</strong>                  デジタル署
                                                                                          名が書き出
                                                                                          されるファ
                                                                                          イル
  <info>OpenSSLCertificate|string</info>                             <strong>$certificate</strong>                      
                                                                                          <strong>$input_filename</strong>
                                                                                          に電子署名
                                                                                          するために
                                                                                          使う X.509
                                                                                          証明書。
                                                                                          有効な値の
                                                                                          リストは、
                                                                                          キー/証明
                                                                                          書パラメー
                                                                                          タ を参照
                                                                                          ください。
  <info>OpenSSLAsymmetricKey|OpenSSLCertificate|array|string</info>  <strong>$private_key</strong>                      
                                                                                          <strong>$private_key</strong>
                                                                                          は、
                                                                                          <strong>$certificate</strong>
                                                                                          に対応する
                                                                                          秘密鍵で
                                                                                          す。 有効
                                                                                          な値のリス
                                                                                          トは、 公
                                                                                          開鍵/秘密
                                                                                          鍵 のパラ
                                                                                          メータ を
                                                                                          参照くださ
                                                                                          い。
  <info>array|null</info>                                            <strong>$headers</strong>                          <strong>$headers</strong>
                                                                                          は、ヘッダ
                                                                                          の配列で
                                                                                          す。この
                                                                                          ヘッダは、
                                                                                          署名された
                                                                                          後でデータ
                                                                                          の前に付加
                                                                                          されます
                                                                                          (このパラ
                                                                                          メータの形
                                                                                          式の詳細に
                                                                                          ついては
                                                                                          <strong>openssl_pkcs7_encrypt()</strong>
                                                                                          を参照くだ
                                                                                          さい)。
  <info>int</info>                                                   <strong>$flags</strong>                            <strong>$flags</strong> を
                                                                                          出力を変更
                                                                                          するために
                                                                                          使用するこ
                                                                                          とが可能で
                                                                                          す。 PKCS7
                                                                                          定数 を参
                                                                                          照くださ
                                                                                          い。
  <info>string|null</info>                                           <strong>$untrusted_certificates_filename</strong>  
                                                                                          <strong>$untrusted_certificates_filename</strong>
                                                                                          には、 署
                                                                                          名に含める
                                                                                          ための他の
                                                                                          一連の証明
                                                                                          書を記述し
                                                                                          たファイル
                                                                                          名を指定し
                                                                                          ます。 こ
                                                                                          れは、例え
                                                                                          ば送信者が
                                                                                          使用した証
                                                                                          明書を受信
                                                                                          者が検証し
                                                                                          やすくする
                                                                                          ために使用
                                                                                          することが
                                                                                          可能です。

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


id: openssl_pkcs7_verify
type: function
doc:
<comment>Description:</comment>
  S/MIME で署名されたメッセージの署名を検証する
  
  <strong>openssl_pkcs7_verify()</strong> は、 指定したファイルの S/MIME メッセージを読み込み、デジタル署名を検証しま
  す。

<comment>Param:</comment>
  <info>string</info>       <strong>$input_filename</strong>                   メッセージへのパス。
  <info>int</info>          <strong>$flags</strong>                            <strong>$flags</strong> により署名の検証方法を指定することが可能で
                                                 す。 詳細については、PKCS7 定数 を参照ください。
  <info>string|null</info>  <strong>$signers_certificates_filename</strong>    <strong>$signers_certificates_filename</strong> が指定された場合、
                                                 メッセージに署名した人の証明書が PEM 形式で保存され
                                                 た ファイルの名前を含む文字列でなければなりません。
  <info>array</info>        <strong>$ca_info</strong>                          <strong>$ca_info</strong> が指定された場合、 検証に使用する信頼され
                                                 た CA 証明書に関する情報を適用する必要があります。
                                                 このパラメータに関するより詳細な情報については、 証
                                                 明書の検証 を参照ください。
  <info>string|null</info>  <strong>$untrusted_certificates_filename</strong>  <strong>$untrusted_certificates_filename</strong> が指定された場合、
                                                 これは信頼されていない CA と見なす一連の証明書を含
                                                 んだ ファイルの名前となります。
  <info>string|null</info>  <strong>$content</strong>                          ファイル名とともに <strong>$content</strong> を指定すると、検証した
                                                 データがここに格納されます。 格納する際に、署名情報
                                                 は除去されます。
  <info>string|null</info>  <strong>$output_filename</strong>                  

<comment>Return:</comment>
  <info>bool|int</info>  署名が検証された場合は <info>true</info>、正しくない場合 (メッセージが改暫されたか署名に用いられた証
            明書が無効) は <info>false</info>、 エラーの場合に -1 を返します。


id: openssl_pkey_derive
type: function
doc:
<comment>Description:</comment>
  リモートとローカルの DH/ECDH鍵 の公開値のための、共有シークレットを計算する
  
  <strong>openssl_pkey_derive()</strong> 関数は、 <strong>$public_key</strong> と <strong>$private_key</strong> を受け取り、 DH または EC鍵のための共有
  シークレットを生成します。

<comment>Param:</comment>
  <info>OpenSSLAsymmetricKey|OpenSSLCertificate|array|string</info>  <strong>$public_key</strong>   <strong>$public_key</strong> は、共有シークレッ
                                                                      トを生成するための公開鍵です。
                                                                      有効な値については、 キー/証明
                                                                      書パラメータ を参照ください。
  <info>OpenSSLAsymmetricKey|OpenSSLCertificate|array|string</info>  <strong>$private_key</strong>  <strong>$private_key</strong> は、共有シーク
                                                                      レットを生成するための秘密鍵で
                                                                      す。 有効な値については、 キー
                                                                      /証明書パラメータ を参照くださ
                                                                      い。
  <info>int</info>                                                   <strong>$key_length</strong>   0でない場合、生成するシーク
                                                                      レットの長さを指定します。

<comment>Return:</comment>
  <info>string|false</info>  成功時には、生成されたシークレットを返します。 失敗した場合に <info>false</info> を返します.


id: openssl_pkey_export
type: function
doc:
<comment>Description:</comment>
  エクスポート可能な形式で、キーを文字列に取得する
  
  <strong>openssl_pkey_export()</strong> は、 <strong>$key</strong> を PEM エンコードした文字列として取得し、 <strong>$output</strong>（リファレンス渡
  し）に格納します。
  
  この関数を正しく動作させるには、正しい形式の openssl.cnf をインストールしておく必要があります。 詳
  細な情報は、インストールについてのセクション を参照ください。

<comment>Param:</comment>
  <info>OpenSSLAsymmetricKey|OpenSSLCertificate|array|string</info>  <strong>$key</strong>         
  <info>string</info>                                                <strong>$output</strong>      
  <info>string|null</info>                                           <strong>$passphrase</strong>  オプションで <strong>$passphrase</strong> を使用
                                                                     してキーを保護することが可能で
                                                                     す。
  <info>array|null</info>                                            <strong>$options</strong>     <strong>$options</strong> により openssl 設定
                                                                     ファイルの設定を 追加したり上書
                                                                     きしたりすることで、エクスポー
                                                                     ト処理の詳細設定が可能です。
                                                                     <strong>$options</strong> についての詳細な情報は
                                                                     <strong>openssl_csr_new()</strong> を参照くださ
                                                                     い。

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


id: openssl_pkey_export_to_file
type: function
doc:
<comment>Description:</comment>
  エクスポート可能な形式で、キーをファイルに取得する
  
  <strong>openssl_pkey_export_to_file()</strong> は、ASCII 変換された (PEM エンコードされた) <strong>$key</strong> を <strong>$output_filename</strong>
  のファイルに保存します。
  
  この関数を正しく動作させるには、正しい形式の openssl.cnf をインストールしておく必要があります。 詳
  細な情報は、インストールについてのセクション を参照ください。

<comment>Param:</comment>
  <info>OpenSSLAsymmetricKey|OpenSSLCertificate|array|string</info>  <strong>$key</strong>              
  <info>string</info>                                                <strong>$output_filename</strong>  出力ファイルへのパス。
  <info>string|null</info>                                           <strong>$passphrase</strong>       オプションで <strong>$passphrase</strong>
                                                                          を使用してキーを保護するこ
                                                                          とが可能です。
  <info>array|null</info>                                            <strong>$options</strong>          <strong>$options</strong> により openssl 設
                                                                          定ファイルの設定を 追加し
                                                                          たり上書きしたりすること
                                                                          で、エクスポート処理の詳細
                                                                          設定が可能です。 <strong>$options</strong>
                                                                          についての詳細な情報は
                                                                          <strong>openssl_csr_new()</strong> を参照く
                                                                          ださい。

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


id: openssl_pkey_free
type: function
doc:
<comment>Description:</comment>
  秘密鍵を開放する
  
  この関数を実行しても何も起こりません。PHP 8.0.0 より前のバージョンでは、この関数はリソースを閉じる
  のに使われていました。
  
  この関数は、<strong>openssl_pkey_new()</strong> で作成した秘密鍵を開放します。

<comment>Param:</comment>
  <info>OpenSSLAsymmetricKey</info>  <strong>$key</strong>  キーを保持するリソース。

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


id: openssl_pkey_get_details
type: function
doc:
<comment>Description:</comment>
  キーの詳細の配列を返す
  
  この関数は、キーの詳細 (bits, key, type) を返します。

<comment>Param:</comment>
  <info>OpenSSLAsymmetricKey</info>  <strong>$key</strong>  キーを保持する配列。

<comment>Return:</comment>
  <info>array|false</info>  成功した場合にキーの詳細を含む配列、失敗した場合に <info>false</info> を返します。 返される配列の
               キーは <return>bits</return> (ビット数)、 <return>key</return> (公開鍵を表す文字列) および <return>type</return> (キーの種類。
               <info>OPENSSL_KEYTYPE_RSA</info>、 <info>OPENSSL_KEYTYPE_DSA</info>、 <info>OPENSSL_KEYTYPE_DH</info>、 <info>OPENSSL_KEYTYPE_EC</info>
               のいずれか。あるいは不明な場合は -1) となります。
               
               使っているキーの型によって、さらに詳細が返されます。 常に存在するわけではない要素もあ
               ることに注意しましょう。
               
               <info>OPENSSL_KEYTYPE_RSA</info> の場合は <return>"rsa"</return> というキーがあり、キーのデータが返されます。
               
               <info>OPENSSL_KEYTYPE_DSA</info> の場合は <return>"dsa"</return> というキーがあり、キーのデータが返されます。
               
               <info>OPENSSL_KEYTYPE_DH</info> の場合は <return>"dh"</return> というキーがあり、キーのデータが返されます。
               
               <info>OPENSSL_KEYTYPE_EC</info> の場合は <return>"ec"</return> というキーがあり、キーのデータが返されます。


id: openssl_pkey_get_private
type: function
doc:
<comment>Description:</comment>
  秘密鍵を取得する
  
  <strong>openssl_pkey_get_private()</strong> は <strong>$private_key</strong> をパースし、他の関数で使用できるよう準備します。

<comment>Param:</comment>
  <info>OpenSSLAsymmetricKey|OpenSSLCertificate|array|string</info>  <strong>$private_key</strong>  <strong>$private_key</strong> は以下のいずれか
                                                                      です。 file://path/to/file.pem
                                                                      形式の文字列。 このファイル
                                                                      は、PEM エンコードされた証明書
                                                                      /秘密鍵である必要が あります
                                                                      （両方を含むことも可能です）。
                                                                      PEM フォーマットの秘密鍵。
                                                                      
                                                                      file://path/to/file.pem 形式の
                                                                      文字列。 このファイルは、PEM
                                                                      エンコードされた証明書/秘密鍵
                                                                      である必要が あります（両方を
                                                                      含むことも可能です）。
                                                                      
                                                                      PEM フォーマットの秘密鍵。
  <info>string|null</info>                                           <strong>$passphrase</strong>   指定されたキーが（パスフレーズ
                                                                      を用いて）暗号化されている場合
                                                                      は、 オプションのパラメータ
                                                                      <strong>$passphrase</strong> を使用する必要があ
                                                                      ります。

<comment>Return:</comment>
  <info>OpenSSLAsymmetricKey|false</info>  成功した場合に、 <class>OpenSSLAsymmetricKey</class> クラスのインスタンスを返します。
                              エラー時に <info>false</info> を返します。


id: openssl_pkey_get_public
type: function
doc:
<comment>Description:</comment>
  証明書から公開鍵を抽出し、使用できるようにする
  
  <strong>openssl_pkey_get_public()</strong> は公開鍵を <strong>$public_key</strong> から抽出し、 他の関数で使用できるよう準備します。

<comment>Param:</comment>
  <info>OpenSSLAsymmetricKey|OpenSSLCertificate|array|string</info>  <strong>$public_key</strong>  <strong>$public_key</strong> は以下のいずれかで
                                                                     す。 <class>OpenSSLAsymmetricKey</class> クラ
                                                                     スのインスタンス
                                                                     file://path/to/file.pem 形式の
                                                                     文字列。 このファイルは、PEM エ
                                                                     ンコードされた証明書/公開鍵であ
                                                                     る必要が あります（両方を含むこ
                                                                     とも可能です）。 PEM フォーマッ
                                                                     トの公開鍵。
                                                                     
                                                                     <class>OpenSSLAsymmetricKey</class> クラスのイ
                                                                     ンスタンス
                                                                     
                                                                     file://path/to/file.pem 形式の
                                                                     文字列。 このファイルは、PEM エ
                                                                     ンコードされた証明書/公開鍵であ
                                                                     る必要が あります（両方を含むこ
                                                                     とも可能です）。
                                                                     
                                                                     PEM フォーマットの公開鍵。

<comment>Return:</comment>
  <info>OpenSSLAsymmetricKey|false</info>  成功した場合に <class>OpenSSLAsymmetricKey</class> クラスのインスタンスを返します。
                              エラー時に <info>false</info> を返します。


id: openssl_pkey_new
type: function
doc:
<comment>Description:</comment>
  新規に秘密鍵を生成する
  
  <strong>openssl_pkey_new()</strong> は、 新しい秘密鍵を生成します。 鍵の公開部を取得する方法は、以下の例に示しま
  す。
  
  この関数を正しく動作させるには、正しい形式の openssl.cnf をインストールしておく必要があります。 詳
  細な情報は、インストールについてのセクション を参照ください。

<comment>Param:</comment>
  <info>array|null</info>  <strong>$options</strong>  鍵の作成方法の詳細（ビット数など）を指定するには、 <strong>$options</strong> を使用します。
                        <strong>$options</strong> の詳細な情報については <strong>openssl_csr_new()</strong> を参照ください。

<comment>Return:</comment>
  <info>OpenSSLAsymmetricKey|false</info>  成功した場合に、<class>OpenSSLAsymmetricKey</class> クラスのインスタンスを返します。
                              エラー時に <info>false</info> を返します。


id: openssl_private_decrypt
type: function
doc:
<comment>Description:</comment>
  秘密鍵でデータを復号する
  
  <strong>openssl_private_decrypt()</strong> は、事前に <strong>openssl_public_encrypt()</strong> で暗号化された <strong>$data</strong> を復号し、それ
  を <strong>$decrypted_data</strong> に格納します。
  
  これを使用するのは、例えばあなたにのみ送られてきたデータを復号する場合です。

<comment>Param:</comment>
  <info>string</info>                                                <strong>$data</strong>            
  <info>string</info>                                                <strong>$decrypted_data</strong>  
  <info>OpenSSLAsymmetricKey|OpenSSLCertificate|array|string</info>  <strong>$private_key</strong>     <strong>$private_key</strong> は、 データの
                                                                         暗号化に使用したものに対応
                                                                         する秘密鍵である必要があり
                                                                         ます。
  <info>int</info>                                                   <strong>$padding</strong>         <strong>$padding</strong> には、
                                                                         <info>OPENSSL_PKCS1_PADDING</info>、
                                                                         <info>OPENSSL_SSLV23_PADDING</info>、
                                                                         <info>OPENSSL_PKCS1_OAEP_PADDING</info>、
                                                                          <info>OPENSSL_NO_PADDING</info> が指定
                                                                         可能です。

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

<comment>See Also:</comment>
   * <strong>openssl_public_encrypt()</strong>
   * <strong>openssl_public_decrypt()</strong>


id: openssl_private_encrypt
type: function
doc:
<comment>Description:</comment>
  秘密鍵でデータを暗号化する
  
  <strong>openssl_private_encrypt()</strong> は、<strong>$data</strong> を秘密鍵 <strong>$private_key</strong> で暗号化し、それを <strong>$encrypted_data</strong> に格
  納します。暗号化されたデータは、 <strong>openssl_public_decrypt()</strong> を用いて復号可能です。
  
  この関数を使用するのは、例えばデータ（あるいはその一部）に署名をし、 それが他人によって書かれたも
  のでないことを証明する場合です。

<comment>Param:</comment>
  <info>string</info>                                                <strong>$data</strong>            
  <info>string</info>                                                <strong>$encrypted_data</strong>  
  <info>OpenSSLAsymmetricKey|OpenSSLCertificate|array|string</info>  <strong>$private_key</strong>     
  <info>int</info>                                                   <strong>$padding</strong>         <strong>$padding</strong> には
                                                                         <info>OPENSSL_PKCS1_PADDING</info> ある
                                                                         いは <info>OPENSSL_NO_PADDING</info> が
                                                                         指定可能です。

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

<comment>See Also:</comment>
   * <strong>openssl_public_encrypt()</strong>
   * <strong>openssl_public_decrypt()</strong>


id: openssl_public_decrypt
type: function
doc:
<comment>Description:</comment>
  公開鍵でデータを復号する
  
  <strong>openssl_public_decrypt()</strong> は、事前に <strong>openssl_private_encrypt()</strong> で暗号化された <strong>$data</strong> を復号し、それ
  を <strong>$decrypted_data</strong> に格納します。
  
  これを使用するのは、例えばメッセージの作者が秘密鍵の所有者であるかどうかを調べる場合です。

<comment>Param:</comment>
  <info>string</info>                                                <strong>$data</strong>            
  <info>string</info>                                                <strong>$decrypted_data</strong>  
  <info>OpenSSLAsymmetricKey|OpenSSLCertificate|array|string</info>  <strong>$public_key</strong>      <strong>$public_key</strong> は、 データの暗
                                                                         号化に使用したものに対応す
                                                                         る公開鍵である必要がありま
                                                                         す。
  <info>int</info>                                                   <strong>$padding</strong>         <strong>$padding</strong> には
                                                                         <info>OPENSSL_PKCS1_PADDING</info> ある
                                                                         いは <info>OPENSSL_NO_PADDING</info> が
                                                                         指定可能です。

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

<comment>See Also:</comment>
   * <strong>openssl_private_encrypt()</strong>
   * <strong>openssl_private_decrypt()</strong>


id: openssl_public_encrypt
type: function
doc:
<comment>Description:</comment>
  公開鍵でデータを暗号化する
  
  <strong>openssl_public_encrypt()</strong> は、<strong>$data</strong> を公開鍵 <strong>$public_key</strong> で暗号化し、それを <strong>$encrypted_data</strong> に格納
  します。暗号化されたデータは <strong>openssl_private_decrypt()</strong> を用いて復号可能です。
  
  この関数を使用するのは、例えば秘密鍵の所有者にのみ読めるようにメッセージを暗号化する場合です。 ま
  た、データベースに格納するデータを安全な形式にするためにも使用されます。

<comment>Param:</comment>
  <info>string</info>                                                <strong>$data</strong>            
  <info>string</info>                                                <strong>$encrypted_data</strong>  暗号化した結果がここに格納
                                                                         されます。
  <info>OpenSSLAsymmetricKey|OpenSSLCertificate|array|string</info>  <strong>$public_key</strong>      公開鍵。
  <info>int</info>                                                   <strong>$padding</strong>         <strong>$padding</strong> には
                                                                         <info>OPENSSL_PKCS1_PADDING</info>、
                                                                         <info>OPENSSL_SSLV23_PADDING</info>、
                                                                         <info>OPENSSL_PKCS1_OAEP_PADDING</info>、
                                                                          <info>OPENSSL_NO_PADDING</info> が指定
                                                                         可能です。

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

<comment>See Also:</comment>
   * <strong>openssl_private_encrypt()</strong>
   * <strong>openssl_private_decrypt()</strong>


id: openssl_random_pseudo_bytes
type: function
doc:
<comment>Description:</comment>
  疑似ランダムなバイト文字列を生成する
  
  疑似ランダムなバイト文字列を生成します。長さは <strong>$length</strong> パラメータで指定します。
  
  暗号学的に強いアルゴリズムを使って疑似乱数を生成したかどうかを知ることもできます。 オプションのパ
  ラメータ <strong>$strong_result</strong> を使います。 これが <info>false</info> になることはまずないでしょうが、 古いシステムな
  どではそうなることもあります。

<comment>Param:</comment>
  <info>int</info>   <strong>$length</strong>         希望するバイト長。 <return>2147483647</return> 以下の正の整数でなければなりません。 PHP は、
                        このパラメータを非 null の整数値にキャストして利用します。
  <info>bool</info>  <strong>$strong_result</strong>  これを渡しておくと、使ったアルゴリズムが暗号学的に強いものであるかどうかを表
                        す <info>bool</info> 値が格納されます。「強い」とは、 GPG やパスワードなどに使っても安全
                        であるという意味です。強い場合は <info>true</info>、そうでない場合は <info>false</info> となります。

<comment>Return:</comment>
  <info>string</info>  成功した場合は指定したバイト長の <info>string</info> を返します。

<comment>See Also:</comment>
   * <strong>random_bytes()</strong>
   * <strong>bin2hex()</strong>
   * <strong>crypt()</strong>
   * <strong>random_int()</strong>


id: openssl_seal
type: function
doc:
<comment>Description:</comment>
  データをシール(暗号化)する
  
  <strong>openssl_seal()</strong> は、ランダムに生成された秘密鍵 および指定した <strong>$cipher_algo</strong> を使用して <strong>$data</strong> をシー
  ル(暗号化) します。このキーは、<strong>$public_key</strong> を ID とする 公開鍵で暗号化されます。 それぞれの暗号化
  されたキーは <strong>$encrypted_keys</strong> で返されます。 これは、暗号化されたデータを複数の受信者に 送信できる
  ことを意味します（この際、各受信者は送信側に公開鍵を 提供します）。各受信者は、暗号化されたデータ
  とその受信者の 公開鍵で暗号化されたエンベロープキーを受け取る必要があります。

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>            シールするデータ。
  <info>string</info>  <strong>$sealed_data</strong>     シール済みのデータ。
  <info>array</info>   <strong>$encrypted_keys</strong>  暗号化したキーの配列。
  <info>array</info>   <strong>$public_key</strong>      公開鍵を含んだ <class>OpenSSLAsymmetricKey</class>  クラスのインスタンスの配列。
  <info>string</info>  <strong>$cipher_algo</strong>     暗号化方式  デフォルト値 (<return>'RC4'</return>) はセキュアでない値です。 明示的にセキュ
                           アな暗号化方式を指定することを強く推奨します。
                           
                           デフォルト値 (<return>'RC4'</return>) はセキュアでない値です。 明示的にセキュアな暗号化方
                           式を指定することを強く推奨します。
  <info>string</info>  <strong>$iv</strong>              初期化ベクトル。

<comment>Return:</comment>
  <info>int|false</info>  成功時にシール(暗号化)されたデータの長さ、エラー時に <info>false</info> を返します。成功時には、暗号
             化されたデータが <strong>$sealed_data</strong> に、エンベロープキーが <strong>$encrypted_keys</strong> に返されます。

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


id: openssl_sign
type: function
doc:
<comment>Description:</comment>
  署名を生成する
  
  <strong>openssl_sign()</strong> は、指定した <strong>$data</strong> の署名を作ります。 <strong>$private_key</strong> で指定した秘密鍵を使用して、暗号
  のデジタル署名を生成します。 data 自体は暗号化されないことに注意してください。

<comment>Param:</comment>
  <info>string</info>                                                <strong>$data</strong>         署名したいデータの文字列。
  <info>string</info>                                                <strong>$signature</strong>    成功した場合、署名が
                                                                      <strong>$signature</strong> に格納されます。
  <info>OpenSSLAsymmetricKey|OpenSSLCertificate|array|string</info>  <strong>$private_key</strong>  <class>OpenSSLAsymmetricKey</class> -
                                                                      <strong>openssl_get_privatekey()</strong> が返
                                                                      す鍵。
                                                                      
                                                                      <info>string</info> - PEM フォーマットの
                                                                      鍵。
  <info>string|int</info>                                            <strong>$algorithm</strong>    <info>int</info> - いずれかの 署名アルゴリ
                                                                      ズム。
                                                                      
                                                                      <info>string</info> -
                                                                      <strong>openssl_get_md_methods()</strong> が返
                                                                      す文字列
                                                                      ("sha256WithRSAEncryption" や
                                                                      "sha384" など)。

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

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


id: openssl_spki_export
type: function
doc:
<comment>Description:</comment>
  署名済みの公開鍵とチャレンジから、有効なPEMフォーマットの公開鍵をエクスポートする
  
  署名済みの公開鍵とチャレンジから、有効なPEMフォーマットの公開鍵をエクスポートします。

<comment>Param:</comment>
  <info>string</info>  <strong>$spki</strong>  有効な署名済みの公開鍵とチャレンジ

<comment>Return:</comment>
  <info>string|false</info>  関連するPEMフォーマットの公開鍵を返します。 失敗した場合は <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>openssl_spki_new()</strong>
   * <strong>openssl_spki_verify()</strong>
   * <strong>openssl_spki_export_challenge()</strong>
   * <strong>openssl_get_md_methods()</strong>
   * <strong>openssl_csr_new()</strong>
   * <strong>openssl_csr_sign()</strong>


id: openssl_spki_export_challenge
type: function
doc:
<comment>Description:</comment>
  署名済みの公開鍵とチャレンジに関連するチャレンジをエクスポートする
  
  エンコードされた署名済みの公開鍵とチャレンジから、チャレンジをエクスポートします。

<comment>Param:</comment>
  <info>string</info>  <strong>$spki</strong>  有効な署名済みの公開鍵とチャレンジ

<comment>Return:</comment>
  <info>string|false</info>  関連するチャレンジを文字列で返します。失敗した場合は <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>openssl_spki_new()</strong>
   * <strong>openssl_spki_verify()</strong>
   * <strong>openssl_spki_export()</strong>
   * <strong>openssl_get_md_methods()</strong>
   * <strong>openssl_csr_new()</strong>
   * <strong>openssl_csr_sign()</strong>


id: openssl_spki_new
type: function
doc:
<comment>Description:</comment>
  署名された公開鍵とチャレンジを新規に作成する
  
  指定されたハッシュアルゴリズムを用いて、署名された公開鍵とチャレンジを新規に作成します。

<comment>Param:</comment>
  <info>OpenSSLAsymmetricKey</info>  <strong>$private_key</strong>  <strong>$private_key</strong> には、事前に  <strong>openssl_pkey_new()</strong> で作成した （も
                                      しくは他の openssl_pkey 関数で得た）秘密鍵を 設定しなければな
                                      りません。鍵の対応する公開部分は、 CSR に署名するために使用さ
                                      れます。
  <info>string</info>                <strong>$challenge</strong>    チャレンジは SPKAC と関連付けられます。
  <info>int</info>                   <strong>$digest_algo</strong>  ダイジェストアルゴリズム。<strong>openssl_get_md_method()</strong> を参照くださ
                                      い。

<comment>Return:</comment>
  <info>string|false</info>  署名された公開鍵とチャレンジ文字列を返し、失敗したときは <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>openssl_spki_verify()</strong>
   * <strong>openssl_spki_export_challenge()</strong>
   * <strong>openssl_spki_export()</strong>
   * <strong>openssl_get_md_methods()</strong>
   * <strong>openssl_csr_new()</strong>
   * <strong>openssl_csr_sign()</strong>


id: openssl_spki_verify
type: function
doc:
<comment>Description:</comment>
  署名済みの公開鍵とチャレンジを検証する
  
  与えられた公開鍵とチャレンジを検証します。

<comment>Param:</comment>
  <info>string</info>  <strong>$spki</strong>  有効な署名済みの公開鍵とチャレンジ

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

<comment>See Also:</comment>
   * <strong>openssl_spki_new()</strong>
   * <strong>openssl_spki_export_challenge()</strong>
   * <strong>openssl_spki_export()</strong>
   * <strong>openssl_get_md_methods()</strong>
   * <strong>openssl_csr_new()</strong>
   * <strong>openssl_csr_sign()</strong>


id: openssl_verify
type: function
doc:
<comment>Description:</comment>
  署名を検証する
  
  <strong>openssl_verify()</strong> は、 <strong>$public_key</strong> が指す公開鍵を使用し、 指定した <strong>$data</strong> に関して <strong>$signature</strong> が正し
  いことを確認します。 署名が正しいと判定されるためには、 その公開鍵が署名の際に使用した秘密鍵に対応
  している必要があります。

<comment>Param:</comment>
  <info>string</info>                                                <strong>$data</strong>        署名を作成するときに使ったデー
                                                                     タの文字列。
  <info>string</info>                                                <strong>$signature</strong>   生のバイナリ文字列。
                                                                     <strong>openssl_sign()</strong> もしくはそれと同
                                                                     等の手段を使って生成したもの。
  <info>OpenSSLAsymmetricKey|OpenSSLCertificate|array|string</info>  <strong>$public_key</strong>  <class>OpenSSLAsymmetricKey</class> -
                                                                     <strong>openssl_get_publickey()</strong> が返す
                                                                     鍵。
                                                                     
                                                                     <info>string</info> - PEM フォーマットの鍵
                                                                     (例: <return>-----BEGIN PUBLIC KEY-----
                                                                     MIIBCgK...</return> など)。
  <info>string|int</info>                                            <strong>$algorithm</strong>   <info>int</info> - いずれかの 署名アルゴリズ
                                                                     ム。
                                                                     
                                                                     <info>string</info> -
                                                                     <strong>openssl_get_md_methods()</strong> が返す
                                                                     文字列 ("sha1WithRSAEncryption"
                                                                     や "sha512" など)。

<comment>Return:</comment>
  <info>int|false</info>  署名 (signature) が正しい場合に 1、正しくない場合に 0、 エラーの場合に -1 または <info>false</info>
             を返します。

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


id: openssl_x509_check_private_key
type: function
doc:
<comment>Description:</comment>
  秘密鍵が証明書に対応するかを確認する
  
  <strong>$private_key</strong> が <strong>$certificate</strong> に対応する秘密鍵かどうかを調べます。
  
  この関数は <strong>$private_key</strong> が秘密鍵かどうかをチェックしません。 単に、公開されている材料 (例: RSA 鍵
  の exponent や modulus) かつ/または キーペアのキーのパラメータ (例: ECキー の EC params) を比較し
  ているだけです。
  
  これはたとえば、公開鍵を <strong>$private_key</strong> に与えても、 関数が <info>true</info> を返す可能性があるということです。

<comment>Param:</comment>
  <info>OpenSSLCertificate|string</info>                             <strong>$certificate</strong>  証明書。
  <info>OpenSSLAsymmetricKey|OpenSSLCertificate|array|string</info>  <strong>$private_key</strong>  秘密鍵。

<comment>Return:</comment>
  <info>bool</info>  <strong>$private_key</strong> が <strong>$certificate</strong> に対応する秘密鍵の場合に <info>true</info>、それ以外の場合に <info>false</info> を返しま
        す。


id: openssl_x509_checkpurpose
type: function
doc:
<comment>Description:</comment>
  証明書が特定の目的に使用可能かどうか確認する
  
  <strong>openssl_x509_checkpurpose()</strong> は証明書を調べ、 <strong>$purpose</strong> で指定した目的に使用可能であるかどうかを確認
  します。

<comment>Param:</comment>
  <info>OpenSSLCertificate|string</info>  <strong>$certificate</strong>                  調べたい証明書。
  <info>int</info>                        <strong>$purpose</strong>                      <strong>openssl_x509_checkpurpose()</strong> の目的定数説
                                                           明X509_PURPOSE_SSL_CLIENT この証明書を
                                                           SSL 接続のクライアント側で使用できるか?
                                                           X509_PURPOSE_SSL_SERVER この証明書を SSL
                                                           接続のサーバー側で使用できるか?
                                                           X509_PURPOSE_NS_SSL_SERVERこの証明書を
                                                           Netscape SSL サーバーで使用できる
                                                           か?X509_PURPOSE_SMIME_SIGNこの証明書を
                                                           S/MIME email で使用できる
                                                           か?X509_PURPOSE_SMIME_ENCRYPTこの証明書を
                                                           S/MIME email の暗号化で使用できる
                                                           か?X509_PURPOSE_CRL_SIGN この証明書を証明
                                                           書取消リスト(CRL)にサインをする際に使用で
                                                           きるか? X509_PURPOSE_ANYこの証明書をあら
                                                           ゆる用途に使用できるか? これらのオプショ
                                                           ンはビットフィールドではありません。 指定
                                                           できるのは一つだけです!
  <info>array</info>                      <strong>$ca_info</strong>                      <strong>$ca_info</strong> は、証明書の認証 で説明したよう
                                                           な信頼できる CA ファイル/ディレクトリの配
                                                           列です。
  <info>string|null</info>                <strong>$untrusted_certificates_file</strong>  指定した場合は、これが証明書を含むPEMエン
                                                           コードされたファイルの名前になります。 こ
                                                           の証明書は、検証と証明を簡単化するために
                                                           使用されます。 そのファイル内にある証明書
                                                           は、信頼されない(untrusted)証明書とみなさ
                                                           れます。

<comment>Return:</comment>
  <info>bool|int</info>  証明書が意図した目的に使用可能である場合に <info>true</info>、使用できない場合に <info>false</info> 、エラーの場合
            に -1 を返します。


id: openssl_x509_export
type: function
doc:
<comment>Description:</comment>
  証明書を文字列としてエクスポートする
  
  <strong>openssl_x509_export()</strong> は、 PEMエンコード形式の <strong>$certificate</strong> を文字列 <strong>$output</strong> に保存します。

<comment>Param:</comment>
  <info></info>        <strong>$x509</strong>     使用できる値の一覧は キー/証明書パラメータ を参照ください。
  <info>string</info>  <strong>$output</strong>   成功した場合に、ここに PEM が格納されます。
  <info>bool</info>    <strong>$no_text</strong>  オプションのパラメータ <strong>$notext</strong> を設定すると、出力内容の冗長性が変化します。<info>false</info>
                    を指定すると、 人間が読むための追加情報が出力に含まれるようになります。 <strong>$notext</strong>
                    のデフォルト値は <info>true</info> です。

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


id: openssl_x509_export_to_file
type: function
doc:
<comment>Description:</comment>
  証明書をファイルにエクスポートする
  
  <strong>openssl_x509_export_to_file()</strong> は、 PEMエンコード形式の <strong>$certificate</strong> をファイル <strong>$output_filename</strong> に
  保存します。

<comment>Param:</comment>
  <info></info>        <strong>$x509</strong>             使用できる値の一覧は キー/証明書パラメータ を参照ください。
  <info>string</info>  <strong>$output_filename</strong>  出力ファイルへのパス。
  <info>bool</info>    <strong>$no_text</strong>          オプションのパラメータ <strong>$notext</strong> を設定すると、出力内容の冗長性が変化しま
                            す。<info>false</info> を指定すると、 人間が読むための追加情報が出力に含まれるように
                            なります。 <strong>$notext</strong> のデフォルト値は <info>true</info> です。

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


id: openssl_x509_fingerprint
type: function
doc:
<comment>Description:</comment>
  与えられた X.509 証明書のフィンガープリントあるいはダイジェストを計算する
  
  <strong>openssl_x509_fingerprint()</strong> は <strong>$certificate</strong> のダイジェストを文字列で返します。

<comment>Param:</comment>
  <info></info>        <strong>$x509</strong>         使用できる値の一覧は キー/証明書パラメータ を参照ください。
  <info>string</info>  <strong>$digest_algo</strong>  "sha256" といったダイジェストメソッド、またはハッシュアルゴリズム。 有効な値
                        の一覧は、<strong>openssl_get_md_methods()</strong> で得られます。
  <info>bool</info>    <strong>$binary</strong>       <info>true</info> が設定された場合、生のバイナリデータを出力します。<info>false</info> では小文字の8進
                        数を出力します。

<comment>Return:</comment>
  <info>string|false</info>  <strong>$binary</strong> が <info>true</info> に設定されていない場合、小文字の8進数として計算された証明書のフィン
                ガープリントを含む文字列を返します。 <strong>$binary</strong> が <info>true</info> に設定されている場合、メッセー
                ジダイジェストの生のバイナリ表現が返されます。
                
                失敗したときは <info>false</info> を返します。


id: openssl_x509_free
type: function
doc:
<comment>Description:</comment>
  証明書リソースを開放する
  
  この関数を実行しても何も起こりません。PHP 8.0.0 より前のバージョンでは、この関数はリソースを閉じる
  のに使われていました。
  
  <strong>openssl_x509_free()</strong> は、メモリから指定した <strong>$certificate</strong> リソースに関連した証明書を開放します。

<comment>Param:</comment>
  <info>OpenSSLCertificate</info>  <strong>$certificate</strong>  

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


id: openssl_x509_parse
type: function
doc:
<comment>Description:</comment>
  X509 証明書をパースし、配列として情報を返す
  
  <strong>openssl_x509_parse()</strong>  は、指定した <strong>$certificate</strong> に関する情報を返します。この情報には 題名、発行者
  名、目的、発効日および有効期限等が含まれます。

<comment>Param:</comment>
  <info>OpenSSLCertificate|string</info>  <strong>$certificate</strong>  X509証明書。正しい値の一覧は キー/証明書パラメータ を参照
                                           ください。
  <info>bool</info>                       <strong>$short_names</strong>  <strong>$short_names</strong> は、配列中でのデータの添字付けの 方法を設定
                                           します。<strong>$short_names</strong> が <info>true</info> の場合 (デフォルト)、フィー
                                           ルドは短縮型で添字が付けられます。そうでない場合、 長い名
                                           前が使用されます。例えば、CN は commonName の短縮型です。

<comment>Return:</comment>
  <info>array|false</info>  返されるデータの構造については（わざと）まだ文書化していません。 これは、今後もデータ
               の構造が変更される可能性があるためです。


id: openssl_x509_read
type: function
doc:
<comment>Description:</comment>
  X.509 証明書をパースし、オブジェクトを返す
  
  <strong>openssl_x509_read()</strong> は、 <strong>$certificate</strong> で指定した証明書をパースし、 その証明書用の
  <class>OpenSSLCertificate</class> オブジェクトを返します。

<comment>Param:</comment>
  <info>OpenSSLCertificate|string</info>  <strong>$certificate</strong>  X509 証明書。有効な値の一覧は、 Key/Certificate
                                           parameters を参照ください。

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


id: openssl_x509_verify
type: function
doc:
<comment>Description:</comment>
  x509証明書のデジタル署名を公開鍵で検証する
  
  <strong>openssl_x509_verify()</strong> 関数は、 <strong>$certificate</strong> 証明書が  公開鍵 <strong>$public_key</strong> に対応する秘密鍵で署名さ
  れたかどうかを検証します。

<comment>Param:</comment>
  <info></info>                                                      <strong>$x509</strong>        使用できる値の一覧は キー/証明
                                                                     書パラメータ を参照ください。
  <info>OpenSSLAsymmetricKey|OpenSSLCertificate|array|string</info>  <strong>$public_key</strong>  <class>OpenSSLAsymmetricKey</class> -
                                                                     <strong>openssl_get_publickey()</strong> で返さ
                                                                     れた公開鍵
                                                                     
                                                                     <info>string</info> - PEMエンコードされた
                                                                     鍵。<return>-----BEGIN PUBLIC KEY-----
                                                                     MIIBCgK...</return> のようなものです。

<comment>Return:</comment>
  <info>int</info>  署名が正しければ 1 を。そうでなければ 0 を返し、 エラーが発生した場合は -1 を返します。

<comment>See Also:</comment>
   * <strong>openssl_verify()</strong>
   * <strong>openssl_get_publickey()</strong>


id: ord
type: function
doc:
<comment>Description:</comment>
  文字列の先頭バイトを、0 から 255 までの値に変換する
  
  <strong>$character</strong> の先頭バイトのバイナリ値を、 0 から 255 までの符号なしの整数値として解釈します。
  
  <strong>$string</strong> が ASCII, ISO-8859, Windows 1252 のような シングルバイトエンコーディング だった場合、 これ
  は文字セットのマッピングテーブルにある文字の位置を返すことと同義です。 しかし、この関数は <strong>$string</strong>
  のエンコーディングについて知りませんし、 特に UTF-8 や UTF-16 のようなマルチバイトエンコーディング
  については、 この関数からは Unicode のコードポイントは絶対にわからないことに注意してください。
  
  この関数は <strong>chr()</strong> と逆の動作をします。

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

<comment>Return:</comment>
  <info>int</info>  0 から 255 までの整数値を返します。

<comment>See Also:</comment>
   * <strong>chr()</strong>
   * ASCII 値の表
   * <strong>IntlChar::ord()</strong>


id: output_add_rewrite_var
type: function
doc:
<comment>Description:</comment>
  URL リライタの値を追加する
  
  この関数は、URL リライト機構に新しい名前/値の組を追加します。 名前および値は、URL (GET パラメータ
  として) およびフォーム (hidden フィールドとして) で追加されます。これは、session.use_trans_sid で
  透過的 URL リライティングが有効になっている場合に セッション ID が渡される方法と同じです。
  
  この関数の挙動は、php.ini パラメータ url_rewriter.tags および url_rewriter.hosts によって制御され
  ます。
  
  この関数の呼び出しが成功するのは、それぞれのリクエストで一度だけです。
  
  もし出力バッファリングが有効になっていない場合、この関数を コールすると出力バッファリングが暗黙的
  に開始されます。

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>   変数名。
  <info>string</info>  <strong>$value</strong>  変数の値。

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

<comment>See Also:</comment>
   * <strong>output_reset_rewrite_vars()</strong>
   * <strong>ob_flush()</strong>
   * <strong>ob_list_handlers()</strong>
   * url_rewriter.tags
   * url_rewriter.hosts
   * session.trans_sid_tags
   * session.trans_sid_hosts


id: output_reset_rewrite_vars
type: function
doc:
<comment>Description:</comment>
  URL リライタの値をリセットする
  
  この関数は URL リライタをリセットし、 <strong>output_add_rewrite_var()</strong> 関数によって事前に設定されたリライ
  ト変数を削除します。

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

<comment>See Also:</comment>
   * <strong>output_add_rewrite_var()</strong>
   * <strong>ob_flush()</strong>
   * <strong>ob_list_handlers()</strong>
   * url_rewriter.tags
   * url_rewriter.hosts
   * session.trans_sid_tags
   * session.trans_sid_hosts


id: pack
type: function
doc:
<comment>Description:</comment>
  データをバイナリ文字列にパックする
  
  指定された引数を <strong>$format</strong> に基づいて バイナリ文字列にパックします。
  
  この関数のアイデアは Perl からのものであり、フォーマット指定用の コードは Perl と同様に動作しま
  す。しかし、中には存在しない書式コードもあります。 たとえば Perl の "u" は存在しません。
  
  符号付及び符号無しの区別は関数 <strong>unpack()</strong> にのみ 影響を与えます。関数 <strong>pack()</strong> は符号付及び符号無しの
  フォーマットコードのどちらでも同じ結果となることに注意しましょう。

<comment>Param:</comment>
  <info>string</info>  <strong>$format</strong>  フォーマット文字列は、 フォーマットコードの後にオプションの反復指定用引数が続く形
                   式と なっています。反復指定用引数として整数値、または入力データの最後まで 反復を
                   意味する <return>*</return> のどちらかを指定することができます。 a, A, h, H の場合、 反復数はその
                   データ引数が取得する文字の数を指定します。反復数が @ の場合、 次のデータを置く場
                   所の絶対位置を表します。その他の場合、反復数は データ引数が使われる数を指定し、結
                   果のバイナリ文字列にパックされます。
                   
                   現在、実装されているものを以下に示します。 <strong>pack()</strong> の書式文字コード説明aNUL で埋め
                   た文字列A空白で埋めた文字列h十六進文字列、下位ニブルが先H十六進文字列、上位ニブル
                   が先csigned charCunsigned charssigned short (常に 16 ビット、マシンのバイトオー
                   ダー)Sunsigned short (常に 16 ビット、マシンのバイトオーダー)nunsigned short (常
                   に 16 ビット、ビッグエンディアンバイトオーダー)vunsigned short (常に 16 ビット、
                   リトルエンディアンバイトオーダー)isigned integer (サイズおよびバイトオーダーはマ
                   シン依存)Iunsigned integer (サイズおよびバイトオーダーはマシン依存)lsigned long
                   (常に 32 ビット、マシンのバイトオーダー)Lunsigned long (常に 32 ビット、マシンの
                   バイトオーダー)Nunsigned long (常に 32 ビット、ビッグエンディアンバイトオー
                   ダー)Vunsigned long (常に 32 ビット、リトルエンディアンバイトオーダー)qsigned
                   long long (常に 64 ビット、マシンのバイトオーダー)Qunsigned long long (常に 64
                   ビット、マシンのバイトオーダー)Junsigned long long (常に 64 ビット、ビッグエン
                   ディアンバイトオーダー)Punsigned long long (常に 64 ビット、リトルエンディアンバ
                   イトオーダー)ffloat (サイズおよび表現はマシン依存)gfloat (サイズはマシン依存。 リ
                   トルエンディアンバイトオーダー)Gfloat (サイズはマシン依存。 ビッグエンディアンバ
                   イトオーダー)ddouble (サイズおよび表現はマシン依存)edouble (サイズはマシン依存。
                   リトルエンディアンバイトオーダー)Edouble (サイズはマシン依存。 ビッグエンディアン
                   バイトオーダー)xNUL バイトX1 バイト戻るZNUL 埋め文字列@絶対位置まで NUL で埋める
  <info>mixed</info>   <strong>$values</strong>  

<comment>Return:</comment>
  <info>string</info>  バイナリ文字列を含むデータを返します。

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


id: parallel\Channel::__construct
type: function
doc:
<comment>Description:</comment>
  Channel Construction
  
  Shall make an anonymous unbuffered channel
  
  Shall make an anonymous buffered channel with the given capacity

<comment>Param:</comment>
  <info>int</info>  <strong>$capacity</strong>  May be <info>Channel::Infinite</info> or a positive integer


id: parallel\Channel::close
type: function
doc:
<comment>Description:</comment>
  Closing
  
  Shall close this channel

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


id: parallel\Channel::make
type: function
doc:
<comment>Description:</comment>
  Access
  
  Shall make an unbuffered channel with the given name
  
  Shall make a buffered channel with the given name and capacity

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>      The name of the channel.
  <info>int</info>     <strong>$capacity</strong>  May be <info>Channel::Infinite</info> or a positive integer

<comment>Return:</comment>
  <info>Channel</info>  


id: parallel\Channel::open
type: function
doc:
<comment>Description:</comment>
  Access
  
  Shall open the channel with the given name

<comment>Return:</comment>
  <info>Channel</info>  


id: parallel\Channel::recv
type: function
doc:
<comment>Description:</comment>
  Sharing
  
  Shall recv a value from this channel

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


id: parallel\Channel::send
type: function
doc:
<comment>Description:</comment>
  Sharing
  
  Shall send the given value on this channel

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


id: parallel\Events::addChannel
type: function
doc:
<comment>Description:</comment>
  Targets
  
  Shall watch for events on the given <strong>$channel</strong>

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


id: parallel\Events::addFuture
type: function
doc:
<comment>Description:</comment>
  Targets
  
  Shall watch for events on the given <strong>$future</strong>

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


id: parallel\Events::poll
type: function
doc:
<comment>Description:</comment>
  Polling
  
  Shall poll for the next event

<comment>Return:</comment>
  <info>parallel\Events\Event|null</info>  Should there be no targets remaining, <info>null</info> shall be returned
                              
                              Should this be a non-blocking loop, and blocking would occur, <info>null</info>
                              shall be returned
                              
                              Otherwise, the <class>parallel\Events\Event</class> returned describes the event.


id: parallel\Events::remove
type: function
doc:
<comment>Description:</comment>
  Targets
  
  Shall remove the given <strong>$target</strong>

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


id: parallel\Events::setBlocking
type: function
doc:
<comment>Description:</comment>
  Behaviour
  
  By default when events are polled for, blocking will occur (at the PHP level) until the first
  event can be returned: Setting blocking mode to <info>false</info> will cause poll to return control if the
  first target polled is not ready.
  
  This differs from setting a timeout of 0 with parallel\Events::setTimeout, since a timeout of 0,
  while allowed, will cause an exception  to be raised, which may be extremely slow or wasteful if
  what is really desired is non-blocking behaviour.
  
  A non-blocking loop effects the return value of parallel\Events::poll, such that it may be <info>null</info>
  before all events have been processed.
  
  Shall set blocking mode

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


id: parallel\Events::setInput
type: function
doc:
<comment>Description:</comment>
  Input
  
  Shall set <strong>$input</strong> for this event loop

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


id: parallel\Events::setTimeout
type: function
doc:
<comment>Description:</comment>
  Behaviour
  
  By default when events are polled for, blocking will occur (at the PHP level) until the first
  event can be returned: Setting the timeout causes an exception to be thrown when the timeout is
  reached.
  
  This differs from setting blocking mode to <info>false</info> with parallel\Events::setBlocking, which will not
  cause an exception to be thrown.
  
  Shall set the timeout in microseconds

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


id: parallel\Events\Input::add
type: function
doc:
<comment>Description:</comment>
  Inputs
  
  Shall set input for the given target

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


id: parallel\Events\Input::clear
type: function
doc:
<comment>Description:</comment>
  Inputs
  
  Shall remove input for all targets

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


id: parallel\Events\Input::remove
type: function
doc:
<comment>Description:</comment>
  Inputs
  
  Shall remove input for the given target

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


id: parallel\Future::cancel
type: function
doc:
<comment>Description:</comment>
  Cancellation
  
  Shall try to cancel the task
  
  If task is running, it will be interrupted.
  
  Internal function calls in progress cannot be interrupted.

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


id: parallel\Future::cancelled
type: function
doc:
<comment>Description:</comment>
  State Detection
  
  Shall indicate if the task was cancelled

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


id: parallel\Future::done
type: function
doc:
<comment>Description:</comment>
  State Detection
  
  Shall indicate if the task is completed

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


id: parallel\Future::value
type: function
doc:
<comment>Description:</comment>
  Resolution
  
  Shall return (and if necessary wait for) return from task

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


id: parallel\Runtime::__construct
type: function
doc:
<comment>Description:</comment>
  Runtime Construction
  
  Shall construct a new runtime without bootstrapping.
  
  Shall construct a bootstrapped runtime.

<comment>Param:</comment>
  <info>string</info>  <strong>$bootstrap</strong>  The location of a bootstrap file, generally an autoloader.


id: parallel\Runtime::close
type: function
doc:
<comment>Description:</comment>
  Runtime Graceful Join
  
  Shall request that the runtime shutsdown.
  
  Tasks scheduled for execution will be executed before the shutdown occurs.

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


id: parallel\Runtime::kill
type: function
doc:
<comment>Description:</comment>
  Runtime Join
  
  Shall attempt to force the runtime to shutdown.
  
  Tasks scheduled for execution will not be executed, the currently running task shall be
  interrupted.
  
  Internal function calls in progress cannot be interrupted.

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


id: parallel\Runtime::run
type: function
doc:
<comment>Description:</comment>
  Execution
  
  Shall schedule <strong>$task</strong> for execution in parallel.
  
  Shall schedule <strong>$task</strong> for execution in parallel, passing <strong>$argv</strong> at execution time.

<comment>Param:</comment>
  <info>Closure</info>  <strong>$task</strong>  A <class>Closure</class> with specific characteristics.
  <info>array</info>    <strong>$argv</strong>  An <info>array</info> of arguments with specific characteristics to be passed to <strong>$task</strong> at
                  execution time.

<comment>Return:</comment>
  <info>Future|null</info>  The return <info>parallel\Future</info> must not be ignored when the task contains a return or
               throw statement.


id: parallel\Sync::__construct
type: function
doc:
<comment>Description:</comment>
  Construction
  
  Shall construct a new synchronization object with no value
  
  Shall construct a new synchronization object containing the given scalar value


id: parallel\Sync::__invoke
type: function
doc:
<comment>Description:</comment>
  Synchronization
  
  Shall exclusively enter into the critical code


id: parallel\Sync::get
type: function
doc:
<comment>Description:</comment>
  Access
  
  Shall atomically return the synchronization objects value

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


id: parallel\Sync::notify
type: function
doc:
<comment>Description:</comment>
  Synchronization
  
  Shall notify one (by default) or all threads waiting on the synchronization object


id: parallel\Sync::set
type: function
doc:
<comment>Description:</comment>
  Access
  
  Shall atomically set the value of the synchronization object


id: parallel\Sync::wait
type: function
doc:
<comment>Description:</comment>
  Synchronization
  
  Shall wait for notification on this synchronization object


id: parallel\bootstrap
type: function
doc:
<comment>Description:</comment>
  Bootstrapping
  
  Shall use the provided <strong>$file</strong> to bootstrap all runtimes created for automatic scheduling via
  <strong>parallel\run()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$file</strong>  Path to the file to bootstrap all runtimes.

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

<comment>See Also:</comment>
   * 


id: parallel\run
type: function
doc:
<comment>Description:</comment>
  Execution
  
  Shall schedule <strong>$task</strong> for execution in parallel.
  
  Shall schedule <strong>$task</strong> for execution in parallel, passing <strong>$argv</strong> at execution time.

<comment>Param:</comment>
  <info>Closure</info>  <strong>$task</strong>  A <class>Closure</class> with specific characteristics.
  <info>array</info>    <strong>$argv</strong>  An <info>array</info> of arguments with specific characteristics to be passed to <strong>$task</strong> at
                  execution time.

<comment>Return:</comment>
  <info>Future|null</info>  The return <info>parallel\Future</info> must not be ignored when the task contains a return or
               throw statement.

<comment>See Also:</comment>
   * 


id: parse_ini_file
type: function
doc:
<comment>Description:</comment>
  設定ファイルをパースする
  
  <strong>parse_ini_file()</strong> は、 <strong>$filename</strong> で指定した ini ファイルをロードし、 連想配列としてその設定値を返し
  ます。
  
  ini ファイルの構造は、php.ini の構造と同じです。

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>          パースしたい ini ファイルのファイル名。 相対パスが指定された場合、 現在
                             のディレクトリから相対的な位置として評価され、 さらに include_path から
                             ファイルを探します。
  <info>bool</info>    <strong>$process_sections</strong>  <strong>$process_sections</strong> パラメータに <info>true</info> を設定すると、セクション名と設定が
                             含まれた多次元の配列を得ることができます。 デフォルトでは、
                             <strong>$process_sections</strong> は <info>false</info> です。
  <info>int</info>     <strong>$scanner_mode</strong>      <info>INI_SCANNER_NORMAL</info> (デフォルト) あるいは <info>INI_SCANNER_RAW</info>。
                             <info>INI_SCANNER_RAW</info> を指定すると、オプションの値はパースされません。
                             
                             PHP 5.6.1 以降では <info>INI_SCANNER_TYPED</info> も指定できるようになりました。 こ
                             のモードでは、boolean や null そして integer の型を、可能な限り維持しま
                             す。 文字列 <return>"true"</return>、<return>"on"</return> そして <return>"yes"</return> は <info>true</info> に変換されます。<return>"false"</return>、
                             <return>"off"</return>、<return>"no"</return> そして <return>"none"</return> は <info>false</info> だとみなされます。このモードでは、
                             <return>"null"</return> は <info>null</info> に変換されます。また数値形式の文字列も、可能な限り
                             integer 型に変換されます。

<comment>Return:</comment>
  <info>array|false</info>  成功した場合に設定を連想配列形式で返します。 失敗した場合に <info>false</info> を返します。

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


id: parse_ini_string
type: function
doc:
<comment>Description:</comment>
  設定文字列をパースする
  
  <strong>parse_ini_string()</strong> は、文字列 <strong>$ini_string</strong> の設定を連想配列で返します。
  
  文字列の構造は、php.ini の構造と同じです。

<comment>Param:</comment>
  <info>string</info>  <strong>$ini_string</strong>        パースしたい ini ファイルの内容。
  <info>bool</info>    <strong>$process_sections</strong>  <strong>$process_sections</strong> を <info>true</info> に設定すると、セクション名と設定を含む多次元
                             配列を返します。 <strong>$process_sections</strong> のデフォルトは <info>false</info> です。
  <info>int</info>     <strong>$scanner_mode</strong>      <info>INI_SCANNER_NORMAL</info> (デフォルト) あるいは <info>INI_SCANNER_RAW</info>。
                             <info>INI_SCANNER_RAW</info> を指定すると、オプションの値はパースされません。
                             
                             PHP 5.6.1 以降では <info>INI_SCANNER_TYPED</info> も指定できるようになりました。 こ
                             のモードでは、boolean や null そして integer の型を、可能な限り維持しま
                             す。 文字列 <return>"true"</return>、<return>"on"</return> そして <return>"yes"</return> は <info>true</info> に変換されます。<return>"false"</return>、
                             <return>"off"</return>、<return>"no"</return> そして <return>"none"</return> は <info>false</info> だとみなされます。このモードでは、
                             <return>"null"</return> は <info>null</info> に変換されます。また数値形式の文字列も、可能な限り
                             integer 型に変換されます。

<comment>Return:</comment>
  <info>array|false</info>  成功した場合に設定を連想配列形式で返します。 失敗した場合に <info>false</info> を返します。

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


id: parse_str
type: function
doc:
<comment>Description:</comment>
  文字列を処理し、変数に代入する
  
  URL 経由で渡されるクエリ文字列と同様に <strong>$string</strong> を処理し、現在のスコープに変数をセットします。
  (<strong>$result</strong> が指定された場合は、配列 <strong>$result</strong> にセットします)

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  入力文字列。
  <info>array</info>   <strong>$result</strong>  2 番目の引数 <strong>$result</strong> が指定された場合、 変数は、代わりに配列の要素としてこの変数
                   に保存されます。
                   
                   この関数を <strong>$result</strong> パラメータを指定せずに使うことは 絶対に おすすめしません し、
                   PHP 7.2 以降では 推奨されません。 PHP 8.0.0 以降では、<strong>$result</strong> パラメータの指定が
                   必須 になっています。

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

<comment>See Also:</comment>
   * <strong>parse_url()</strong>
   * <strong>pathinfo()</strong>
   * <strong>http_build_query()</strong>
   * <strong>urldecode()</strong>


id: parse_url
type: function
doc:
<comment>Description:</comment>
  URL を解釈し、その構成要素を返す
  
  この関数は、URL の様々な構成要素のうち特定できるものに関して 連想配列にして返します。 連想配列に含
  まれる要素の値は、URLデコード されません。
  
  この関数は、指定された URL が有効かどうかを調べるためのもの ではなく、単に URL を以下で示す 要素に
  分解するだけのものです。不完全、かつ不正な URL であっても受け入れますし、 そのような場合でも
  <strong>parse_url()</strong> は可能な限り 正しく解析しようとします。

<comment>Param:</comment>
  <info>string</info>  <strong>$url</strong>        パースする URL。
  <info>int</info>     <strong>$component</strong>  <info>PHP_URL_SCHEME</info>、 <info>PHP_URL_HOST</info>、<info>PHP_URL_PORT</info>、 <info>PHP_URL_USER</info>、<info>PHP_URL_PASS</info>、
                      <info>PHP_URL_PATH</info>、<info>PHP_URL_QUERY</info> あるいは <info>PHP_URL_FRAGMENT</info> のうちのいずれかを指定
                      し、 特定の URL コンポーネントのみを文字列 (<info>PHP_URL_PORT</info> を指定した場合だけは
                      整数値) で取得するようにします。

<comment>Return:</comment>
  <info>int|string|array|null|false</info>  完全におかしな形式の URL については、<strong>parse_url()</strong> は <info>false</info> を返しま
                               す。
                               
                               <strong>$component</strong> を省略した場合は、連想配列を返します。 連想配列の中には少
                               なくともひとつの要素が含まれます。 この配列に含まれる可能性のある要素
                               は次のとおりです。 scheme - 例: http hostportuserpasspathquery - クエ
                               スチョンマーク <return>?</return> 以降 fragment - ハッシュマーク <return>#</return> 以降
                               
                               scheme - 例: http
                               
                               host
                               
                               port
                               
                               user
                               
                               pass
                               
                               path
                               
                               query - クエスチョンマーク <return>?</return> 以降
                               
                               fragment - ハッシュマーク <return>#</return> 以降
                               
                               <strong>$component</strong> が指定されている場合、 <strong>parse_url()</strong> は配列ではなく文字列
                               (<info>PHP_URL_PORT</info> の場合は整数値) を返します。 要求したコンポーネントが指
                               定した URL の中にない場合は <info>null</info> を返します。 PHP 8.0.0 以降では、
                               <strong>parse_url()</strong> は、query と fragment について、 存在しないことと値が空で
                               あることを以下のように区別します:
                               
                               
                               
                               8.0.0 より前のバージョンでは、上記の場合は query も fragment も共に
                               <info>null</info> になっていました。
                               
                               URL の各要素(コンポーネント) に含まれる制御文字 (<strong>ctype_cntrl()</strong> も参照
                               ください) は、 アンダースコア (<return>_</return>) に置き換えられる点に注意して下さ
                               い。

<comment>See Also:</comment>
   * <strong>pathinfo()</strong>
   * <strong>parse_str()</strong>
   * <strong>http_build_query()</strong>
   * <strong>dirname()</strong>
   * <strong>basename()</strong>
   * RFC 3986


id: passthru
type: function
doc:
<comment>Description:</comment>
  外部プログラムを実行し、未整形の出力を表示する
  
  <strong>passthru()</strong>関数は<strong>exec()</strong>関数と同様、 <strong>$command</strong>を実行します。 引数 <strong>$return_code</strong> を指定した場合、 Unix
  コマンドのステータスで置換されます。 この関数は Unix コマンドからの出力がバイナリデータであり、 ブ
  ラウザーへ直接返す必要がある場合、<strong>exec()</strong> もしくは<strong>system()</strong>の代わりに使用する必要があります。 よく使
  うのは、直接画像ストリームを出力することができる pbmplus ユーティリティの様なものを実行する場合で
  す。content-type を <return>image/gif</return> に設定して、gifを出力するpbmplus プログラムを呼び出すことにより、直
  接画像を出力する PHP スクリプトを作成 することができます。

<comment>Param:</comment>
  <info>string</info>  <strong>$command</strong>      実行するコマンド
  <info>int</info>     <strong>$result_code</strong>  引数<strong>$result_code</strong>が存在する場合、 Unix コマンドのステータスがこの変数に書かれ
                        ます。

<comment>Return:</comment>
  <info>false|null</info>  成功した場合に <info>null</info> を、失敗した場合に <info>false</info> を返します.

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


id: password_algos
type: function
doc:
<comment>Description:</comment>
  利用可能なパスワードハッシュアルゴリズムのIDを取得する
  
  登録済みのパスワードハッシュアルゴリズムのIDの完全な一覧を、 文字列の配列として返します。

<comment>Return:</comment>
  <info>array</info>  利用可能なパスワードハッシュアルゴリズムのIDを返します。


id: password_get_info
type: function
doc:
<comment>Description:</comment>
  指定したハッシュに関する情報を返す
  
  <strong>password_hash()</strong> がサポートするアルゴリズムで生成した有効なハッシュを渡すと、 そのハッシュに関する
  情報の配列を返します。

<comment>Param:</comment>
  <info>string</info>  <strong>$hash</strong>  <strong>password_hash()</strong> が作ったハッシュ。

<comment>Return:</comment>
  <info>array</info>  三つの要素を持つ連想配列を返します。 <return>algo</return> には、そのハッシュの パスワードアルゴリズム定数
         が含まれます。 <return>algoName</return> には、そのアルゴリズムの名前が含まれます。 <return>options</return> には、
         <strong>password_hash()</strong> を呼んだときのオプションが含まれます。
         
         <return>algo</return> には、そのハッシュの パスワードアルゴリズム定数 が含まれます。
         
         <return>algoName</return> には、そのアルゴリズムの名前が含まれます。
         
         <return>options</return> には、 <strong>password_hash()</strong> を呼んだときのオプションが含まれます。


id: password_hash
type: function
doc:
<comment>Description:</comment>
  パスワードハッシュを作る
  
  <strong>password_hash()</strong> は、 強力な一方向ハッシュアルゴリズムを使って、 新しいパスワードハッシュを作りま
  す。
  
  現在、以下のアルゴリズムに対応しています。
  
  <info>PASSWORD_DEFAULT</info> - bcrypt アルゴリズムを使います (PHP 5.5.0 の時点でのデフォルトです)。 新しくてよ
  り強力なアルゴリズムが PHP に追加されれば、 この定数もそれにあわせて変わっていきます。 そのため、
  これを指定したときの結果の長さは、変わる可能性があります。 したがって、結果をデータベースに格納す
  るときにはカラム幅を 60 文字以上にできるようなカラムを使うことをお勧めします (255 文字くらいが適切
  でしょう)。 <info>PASSWORD_BCRYPT</info> - <info>CRYPT_BLOWFISH</info> アルゴリズムを使ってハッシュを作ります。これは標準の
  <strong>crypt()</strong> 互換のハッシュで、識別子 "$2y$" を使った場合の結果を作ります。 その結果は、常に 60 文字の
  文字列になります。失敗した場合に <info>false</info> を返します。 <info>PASSWORD_ARGON2I</info> - Argon2i ハッシュアルゴリズ
  ムを使って ハッシュを作ります。このアルゴリズムは、 PHP が Argon2 のサポートを有効にしてコンパイル
  した場合のみ利用できます。 <info>PASSWORD_ARGON2ID</info> - Argon2id ハッシュアルゴリズムを使って ハッシュを作
  ります。このアルゴリズムは、 PHP が Argon2 のサポートを有効にしてコンパイルした場合のみ利用できま
  す。
  
  <info>PASSWORD_DEFAULT</info> - bcrypt アルゴリズムを使います (PHP 5.5.0 の時点でのデフォルトです)。 新しくてよ
  り強力なアルゴリズムが PHP に追加されれば、 この定数もそれにあわせて変わっていきます。 そのため、
  これを指定したときの結果の長さは、変わる可能性があります。 したがって、結果をデータベースに格納す
  るときにはカラム幅を 60 文字以上にできるようなカラムを使うことをお勧めします (255 文字くらいが適切
  でしょう)。
  
  <info>PASSWORD_BCRYPT</info> - <info>CRYPT_BLOWFISH</info> アルゴリズムを使ってハッシュを作ります。これは標準の <strong>crypt()</strong> 互換
  のハッシュで、識別子 "$2y$" を使った場合の結果を作ります。 その結果は、常に 60 文字の文字列になり
  ます。失敗した場合に <info>false</info> を返します。
  
  <info>PASSWORD_ARGON2I</info> - Argon2i ハッシュアルゴリズムを使って ハッシュを作ります。このアルゴリズムは、
  PHP が Argon2 のサポートを有効にしてコンパイルした場合のみ利用できます。
  
  <info>PASSWORD_ARGON2ID</info> - Argon2id ハッシュアルゴリズムを使って ハッシュを作ります。このアルゴリズムは、
  PHP が Argon2 のサポートを有効にしてコンパイルした場合のみ利用できます。
  
  <info>PASSWORD_BCRYPT</info> がサポートするオプション:
  
  <return>salt</return> (<info>string</info>) - パスワードのハッシュに使うソルトを手動で設定します。 これは、自動生成されたソルト
  を上書きすることに注意しましょう。  省略した場合は、パスワードをハッシュするたびに <strong>password_hash()</strong>
  がランダムなソルトを自動生成します。これは意図したとおりの操作モードです。  このソルト・オプション
  は 非推奨になっています。 このオプションは指定せずに、デフォルトで生成されるソルトを使うことを推奨
  します。 PHP 8.0.0 以降は、この値を明示的に指定しても無視されます。 <return>cost</return> (<info>int</info>) - 利用するアルゴリ
  ズムのコストを表します。 値の例については <strong>crypt()</strong> のページを参照ください。  省略した場合のデフォル
  トは <return>10</return> です。この値でもかまいませんが、 ハードウェアの性能が許すならもう少し高くすることもできま
  す。
  
  <return>salt</return> (<info>string</info>) - パスワードのハッシュに使うソルトを手動で設定します。 これは、自動生成されたソルト
  を上書きすることに注意しましょう。
  
  省略した場合は、パスワードをハッシュするたびに <strong>password_hash()</strong> がランダムなソルトを自動生成しま
  す。これは意図したとおりの操作モードです。
  
  このソルト・オプションは 非推奨になっています。 このオプションは指定せずに、デフォルトで生成される
  ソルトを使うことを推奨します。 PHP 8.0.0 以降は、この値を明示的に指定しても無視されます。
  
  <return>cost</return> (<info>int</info>) - 利用するアルゴリズムのコストを表します。 値の例については <strong>crypt()</strong> のページを参照くだ
  さい。
  
  省略した場合のデフォルトは <return>10</return> です。この値でもかまいませんが、 ハードウェアの性能が許すならもう少
  し高くすることもできます。
  
  <info>PASSWORD_ARGON2I</info> と <info>PASSWORD_ARGON2ID</info> が サポートするオプション
  
  <return>memory_cost</return> (<info>int</info>) - Argon2 ハッシュを計算するのに 使われるメモリの最大値(キロバイト単位)。 デフォ
  ルトは <info>PASSWORD_ARGON2_DEFAULT_MEMORY_COST</info> です。 <return>time_cost</return> (<info>int</info>) - Argon2 ハッシュを計算するのに
  使って良い時間の最大値。 デフォルトは <info>PASSWORD_ARGON2_DEFAULT_TIME_COST</info> です。 <return>threads</return> (<info>int</info>) -
  Argon2 ハッシュを計算するのに使う スレッド数。 デフォルトは <info>PASSWORD_ARGON2_DEFAULT_THREADS</info> です。
  PHP が libargon2 を使う場合にのみ利用可能です。 libsodium の実装では利用できません。
  
  <return>memory_cost</return> (<info>int</info>) - Argon2 ハッシュを計算するのに 使われるメモリの最大値(キロバイト単位)。 デフォ
  ルトは <info>PASSWORD_ARGON2_DEFAULT_MEMORY_COST</info> です。
  
  <return>time_cost</return> (<info>int</info>) - Argon2 ハッシュを計算するのに 使って良い時間の最大値。 デフォルトは
  <info>PASSWORD_ARGON2_DEFAULT_TIME_COST</info> です。
  
  <return>threads</return> (<info>int</info>) - Argon2 ハッシュを計算するのに使う スレッド数。 デフォルトは
  <info>PASSWORD_ARGON2_DEFAULT_THREADS</info> です。
  
  PHP が libargon2 を使う場合にのみ利用可能です。 libsodium の実装では利用できません。

<comment>Param:</comment>
  <info>string</info>           <strong>$password</strong>  ユーザーのパスワード。
                              
                              <info>PASSWORD_BCRYPT</info> をアルゴリズムに指定すると、 <strong>$password</strong> が最大 72 バイ
                              トまでに切り詰められます。
  <info>string|int|null</info>  <strong>$algo</strong>      パスワードのハッシュに使うアルゴリズムを表す
                              パスワードアルゴリズム定数。
  <info>array</info>            <strong>$options</strong>   オプションを含む連想配列。各アルゴリズムがサポートするオプションについ
                              ては、
                              パスワードアルゴリズム定数
                              のページを参照ください。
                              
                              省略した場合は、ランダムな salt を生成してデフォルトのコストを使いま
                              す。

<comment>Return:</comment>
  <info>string</info>  ハッシュしたパスワードを返します。
          
          使ったアルゴリズムやコスト、そしてソルトもハッシュの一部として返されます。 つまり、ハッ
          シュを検証するために必要な情報は、すべてそこに含まれているということです。 そのため、
          <strong>password_verify()</strong> でハッシュを検証するときに、 ソルトやアルゴリズムの情報を別に保存する必
          要はありません。

<comment>See Also:</comment>
   * <strong>password_verify()</strong>
   * <strong>password_needs_rehash()</strong>
   * <strong>crypt()</strong>
   * <strong>sodium_crypto_pwhash_str()</strong>


id: password_needs_rehash
type: function
doc:
<comment>Description:</comment>
  指定したハッシュがオプションにマッチするかどうかを調べる
  
  指定したハッシュが、特定のアルゴリズムとオプションを満たしているかどうかを調べます。 満たしていな
  い場合は、ハッシュを再計算する必要があるとみなします。

<comment>Param:</comment>
  <info>string</info>           <strong>$hash</strong>     <strong>password_hash()</strong> が作ったハッシュ。
  <info>string|int|null</info>  <strong>$algo</strong>     パスワードのハッシュに使うアルゴリズムを表す
                             パスワードアルゴリズム定数。
  <info>array</info>            <strong>$options</strong>  オプションを含む連想配列。各アルゴリズムがサポートするオプションについ
                             ては、
                             パスワードアルゴリズム定数
                             のページを参照ください。

<comment>Return:</comment>
  <info>bool</info>  指定した <strong>$algo</strong> と <strong>$options</strong> にマッチするためにハッシュの再計算が必要な場合は <info>true</info>、 それ以外
        の場合は <info>false</info> を返します。


id: password_verify
type: function
doc:
<comment>Description:</comment>
  パスワードがハッシュにマッチするかどうかを調べる
  
  指定したハッシュがパスワードにマッチするかどうかを調べます。 <strong>password_verify()</strong> は <strong>crypt()</strong> と互換性
  があるので、 <strong>crypt()</strong> が作ったパスワードハッシュは <strong>password_verify()</strong> でも使えます。
  
  <strong>password_hash()</strong> は、 アルゴリズムやコスト、ソルトといった情報もハッシュに含めて返すことに注意しま
  しょう。 したがって、ハッシュの検証に必要な情報はすべてそこに含まれていることになります。 これで、
  検証関数がハッシュの検証をするときに、ソルトやアルゴリズム情報を別の場所から取得する必要がなくなり
  ます。
  
  この関数は、タイミング攻撃に対して安全です。

<comment>Param:</comment>
  <info>string</info>  <strong>$password</strong>  ユーザーのパスワード。
  <info>string</info>  <strong>$hash</strong>      <strong>password_hash()</strong> が作ったハッシュ。

<comment>Return:</comment>
  <info>bool</info>  パスワードとハッシュがマッチする場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>password_needs_rehash()</strong>
   * <strong>password_hash()</strong>
   * ユーザーランドでの実装
   * <strong>sodium_crypto_pwhash_str_verify()</strong>


id: pathinfo
type: function
doc:
<comment>Description:</comment>
  ファイルパスに関する情報を返す
  
  <strong>pathinfo()</strong> は、<strong>$path</strong> に関する情報を返します。<strong>$flags</strong> によって連想配列あるいは文字列のどちらかとなり
  ます。
  
  カレントのパスに関する情報を取得するには、 定義済みの変数 のセクションをご覧ください。
  
  <strong>pathinfo()</strong> は入力された文字列をそのまま扱います。 よって、実際のファイルシステムや "<return>..</return>" のようなパ
  スコンポーネントも認識しません。
  
  Windows システムでのみ、<return>\</return> 文字はディレクトリのセパレータとして解釈されます。 それ以外のシステムで
  は、他の文字と同じように扱われます。
  
  <strong>pathinfo()</strong> はロケールを考慮して処理を行います。 マルチバイト文字を含むパスを正しく処理するには、正
  しいロケールを <strong>setlocale()</strong> 関数で設定しておかなければなりません。

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>   調べたいパス。
  <info>int</info>     <strong>$flags</strong>  指定する場合は、どの要素を返すのかを <info>PATHINFO_DIRNAME</info>、 <info>PATHINFO_BASENAME</info>、
                  <info>PATHINFO_EXTENSION</info> あるいは <info>PATHINFO_FILENAME</info> のいずれかで指定します。
                  
                  <strong>$flags</strong> を省略した場合はすべての要素を返します。

<comment>Return:</comment>
  <info>array|string</info>  <strong>$flags</strong> パラメータを渡さなかった場合は、次の要素を含む連想配列を返します。 <return>dirname</return>、
                <return>basename</return>、 <return>extension</return> (存在すれば)、そして <return>filename</return>。
                
                <strong>$path</strong> に複数の拡張子が含まれる場合は、 <info>PATHINFO_EXTENSION</info> は最後の拡張子だけを返しま
                す。また、 <info>PATHINFO_FILENAME</info> は最後の拡張子だけを取り除きます (最初のサンプルを参照
                ください)。
                
                <strong>$path</strong> に拡張子がない場合は、 <return>extension</return> 要素は返されません (以下の二番目の例を参照く
                ださい)。
                
                <strong>$path</strong> の <return>basename</return> がドットで始まる場合は、それに続く文字は <return>extension</return> とみなされま
                す。そして <return>filename</return> は空文字列となります (以下の三番目の例を参照ください)。
                
                <strong>$flags</strong> を指定すると、 要求した要素を文字列で返します。

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


id: pclose
type: function
doc:
<comment>Description:</comment>
  プロセスのファイルポインタをクローズする
  
  <strong>popen()</strong> でオープンしたパイプへの ファイルポインタをクローズします。

<comment>Param:</comment>
  <info>resource</info>  <strong>$handle</strong>  ファイルポインタは有効なものでなければならず、また <strong>popen()</strong> で正常にオープンされ
                     たものである必要があります。

<comment>Return:</comment>
  <info>int</info>  実行していたプロセスの終了ステータスを返します。 エラーが発生した場合は <return>-1</return> を返します。
       
       PHP のコンパイル時に --enable-sigchild を指定した場合は、この関数の返り値は未定義となります。

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


id: pcntl_alarm
type: function
doc:
<comment>Description:</comment>
  シグナルを送信するアラームを設定する
  
  プロセスに対して、 指定した秒数後に <return>SIGALRM</return> シグナルを送信するタイマーを作成します。 <strong>pcntl_alarm()</strong>
  をコールすると、 それまでに設定されていたアラームはすべて取り消されます。

<comment>Param:</comment>
  <info>int</info>  <strong>$seconds</strong>  待機する秒数。<strong>$seconds</strong> がゼロの場合は、 新しいアラームは作成されません。

<comment>Return:</comment>
  <info>int</info>  それまでに予定されていたアラームの予定時刻までの秒数を返します。 事前に予定されていたアラーム
       がなかった場合には <return>0</return> を返します。


id: pcntl_async_signals
type: function
doc:
<comment>Description:</comment>
  非同期のシグナルハンドリングを有効/無効にするか、古い設定を返す
  
  <strong>$enable</strong> パラメータが省略された場合、 <strong>pcntl_async_signals()</strong> は非同期のシグナルハンドリングが有効か
  どうかを返します。 省略されなかった場合、非同期のシグナルハンドリングを 有効/無効 にします。

<comment>Param:</comment>
  <info>bool|null</info>  <strong>$enable</strong>  非同期のシグナルハンドリングが有効にされるべきかどうか

<comment>Return:</comment>
  <info>bool</info>  getter として使われた場合(オプションのパラメータが <info>null</info> だった場合)、 この関数は非同期シグナ
        ルハンドリングが有効かどうかを返します。 setter として使われた場合(つまり、オプションのパラ
        メータが <info>null</info> でない場合)、 この関数はこの関数を呼び出す 前に 非同期シグナルハンドリングが有
        効だったかを返します。

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


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


id: pcntl_exec
type: function
doc:
<comment>Description:</comment>
  現在のプロセス空間で指定したプログラムを実行する
  
  指定した引数でプログラムを実行します。

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>      <strong>$path</strong> は、バイナリ実行ファイルへのパスか、 あるいは有効な実行ファイルを指す
                     shebang (例: #!/usr/local/bin/perl) が一行目に存在するスクリプトへのパスである
                     必要があります。 詳細な情報については、システムの man ページで execve(2) を参照
                     ください。
  <info>array</info>   <strong>$args</strong>      <strong>$args</strong> は、プログラムに渡す引数文字列の配列です。
  <info>array</info>   <strong>$env_vars</strong>  <strong>$env_vars</strong> は、プログラムに渡す環境変数の配列です。 この配列は name =&gt; value
                     のような形式で、key が環境変数名・value が その値となります。

<comment>Return:</comment>
  <info>bool</info>  Returns <info>false</info>.


id: pcntl_fork
type: function
doc:
<comment>Description:</comment>
  現在実行中のプロセスをフォークする
  
  <strong>pcntl_fork()</strong> 関数は、親プロセスとその PID および PPID のみが異なる子プロセスを生成します。システム
  上でのフォークの 動作の具体的な詳細については、実行するシステムの fork(2) の マニュアルを参照くだ
  さい。

<comment>Return:</comment>
  <info>int</info>  成功時に、子プロセスの PID が親プロセスの実行スレッドに返され、 子プロセスの実行スレッドには
       0 が返されます。失敗した場合、親プロセスの コンテキストに -1 が返され、子プロセスは生成されず
       に、PHP のエラーが 出力されます。

<comment>See Also:</comment>
   * <strong>pcntl_rfork()</strong>
   * <strong>pcntl_waitpid()</strong>
   * <strong>pcntl_signal()</strong>
   * <strong>cli_set_process_title()</strong>


id: pcntl_get_last_error
type: function
doc:
<comment>Description:</comment>
  直近の pcntl 関数が失敗したときのエラー番号を取得する
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>int</info>  エラーコードを返します。

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


id: pcntl_getpriority
type: function
doc:
<comment>Description:</comment>
  プロセスの優先度を取得する
  
  <strong>pcntl_getpriority()</strong> は、 <strong>$process_id</strong> の優先度を設定します。システムの型やカーネルの バージョンに
  よって優先度の扱いは違うので、詳細についてはシステムの getpriority(2) の man ページを参照くださ
  い。

<comment>Param:</comment>
  <info>int|null</info>  <strong>$process_id</strong>  <info>null</info> だった場合は、現在のプロセスの プロセスID を使用します。
  <info>int</info>       <strong>$mode</strong>        <info>PRIO_PGRP</info>、<info>PRIO_USER</info>、 <info>PRIO_PROCESS</info>、<info>PRIO_DARWIN_BG</info>、 <info>PRIO_DARWIN_THREAD</info> の
                         いずれか。

<comment>Return:</comment>
  <info>int|false</info>  <strong>pcntl_getpriority()</strong> はプロセスの優先度を返します。 エラー時には <info>false</info> を返します。数字
             が小さいほど、優先順位は上となります。
             
             この関数は論理値
             <info>false</info> を返す可能性がありますが、<info>false</info> として評価される値を返す可能性もあります。
             詳細については 論理値の
             セクションを参照してください。この関数の返り値を調べるには
             ===演算子 を
             使用してください。

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


id: pcntl_rfork
type: function
doc:
<comment>Description:</comment>
  プロセスのリソースを管理する
  
  プロセスのリソースを管理します。

<comment>Param:</comment>
  <info>int</info>  <strong>$flags</strong>   <strong>$flags</strong> は、 呼び出しているプロセス(親) のリソースを新しいプロセス(子)と共有するか、
                デフォルト値で初期化するかを指定します。
                
                <strong>$flags</strong> は、 以下のうちのいくつかを論理ORで指定します: <info>RFPROC</info>: 設定すると、新しいプロ
                セスが作られます。 設定しない場合、変更は現在のプロセスに適用されます。 <info>RFNOWAIT</info>: 設
                定すると、子プロセスは親プロセスから切り離されます。 子プロセスが終了するときには、
                親プロセスが収集するステータスが残りません。 <info>RFFDG</info>: 設定すると、 呼び出し側のファイ
                ルディスクリプタテーブルがコピーされます。 設定しない場合、 ふたつのプロセスが単一の
                テーブルを共有します。 <info>RFCFDG</info>: 設定すると、新しいファイルディスクリプタテーブルを
                使って 新しいプロセスが開始されます。 <return>RFFDG</return> とは同時に指定できません。 <info>RFLINUXTHPN</info>:
                設定すると、 子のスレッドが終了時に kernel は SIGCHILD ではなく、 SIGUSR1 を返しま
                す。 これは、Linux のcloneが終了時に、 親に状態を知らせる動作を模倣する意図がありま
                す。
  <info>int</info>  <strong>$signal</strong>  シグナル番号

<comment>Return:</comment>
  <info>int</info>  成功時には、親スレッドの実行時に子プロセスのPIDを返し、 子のスレッド実行時に <return>0</return> を返します。
       失敗時には、親のコンテキストには <return>-1</return> を返し、 子プロセスは作られません。そして、PHP のエラーが
       発生します。

<comment>See Also:</comment>
   * <strong>pcntl_fork()</strong>
   * <strong>pcntl_waitpid()</strong>
   * <strong>pcntl_signal()</strong>
   * <strong>cli_set_process_title()</strong>


id: pcntl_setpriority
type: function
doc:
<comment>Description:</comment>
  プロセスの優先度を変更する
  
  <strong>pcntl_setpriority()</strong> は、 <strong>$process_id</strong> の優先度を設定します。

<comment>Param:</comment>
  <info>int</info>       <strong>$priority</strong>    <strong>$priority</strong> は一般的には <return>-20</return> から <return>20</return> までの値です。 デフォルトの優先度は <return>0</return>
                         で、数字が小さいほど 優先順位が上となります。システムの型やカーネルの バー
                         ジョンによって優先度の扱いは違うので、詳細についてはシステムの
                         setpriority(2) の man ページを参照ください。
  <info>int|null</info>  <strong>$process_id</strong>  <info>null</info> だった場合は、現在のプロセスの プロセスID を使用します。
  <info>int</info>       <strong>$mode</strong>        <info>PRIO_PGRP</info>、<info>PRIO_USER</info>、 <info>PRIO_PROCESS</info>、<info>PRIO_DARWIN_BG</info>、 <info>PRIO_DARWIN_THREAD</info> の
                         いずれか。

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

<comment>See Also:</comment>
   * <strong>pcntl_getpriority()</strong>
   * <strong>pcntl_setpriority()</strong>


id: pcntl_signal
type: function
doc:
<comment>Description:</comment>
  シグナルハンドラを設定する
  
  <strong>pcntl_signal()</strong> 関数は、<strong>$signal</strong> が指すシグナルに関するハンドラを新たに設定するか、既存のハンドラを
  置き換えます。

<comment>Param:</comment>
  <info>int</info>           <strong>$signal</strong>            シグナル番号。
  <info>callable|int</info>  <strong>$handler</strong>           シグナルハンドラ。<info>callable</info> を渡すと、それを実行してシグナルを処理
                                   します。 あるいは、グローバル定数 <info>SIG_IGN</info> または <info>SIG_DFL</info> を渡すこ
                                   ともできます。それぞれ、シグナルを無視することとデフォルトのシグ
                                   ナルハンドラを復活させることを表します。
                                   
                                   <info>callable</info> を渡す場合は、次のシグネチャを実装したものでなければいけ
                                   ません。
                                   
                                   <info>void</info>handler<info>int</info><strong>$signo</strong><info>mixed</info><strong>$siginfo</strong><strong>$signal</strong> 処理するシグナル。
                                   <strong>$siginfo</strong> OS が siginfo_t 構造体をサポートしている場合、 これはシ
                                   グナルに依存するシグナル情報の配列になります。
                                   
                                   処理するシグナル。
                                   
                                   OS が siginfo_t 構造体をサポートしている場合、 これはシグナルに依
                                   存するシグナル情報の配列になります。
                                   
                                   オブジェクトのメソッドをハンドラとして指定した場合には、 そのハン
                                   ドラを別のものに変えたりスクリプトが終了したりするまでは オブジェ
                                   クトのリファレンスカウントが増加したままであることに注意しましょ
                                   う。
  <info>int</info>           <strong>$signal</strong>            処理するシグナル。
  <info>mixed</info>         <strong>$siginfo</strong>           OS が siginfo_t 構造体をサポートしている場合、 これはシグナルに依
                                   存するシグナル情報の配列になります。
  <info>bool</info>          <strong>$restart_syscalls</strong>  再起動のシステムコールに対応するかどうかを設定します。

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

<comment>See Also:</comment>
   * <strong>pcntl_fork()</strong>
   * <strong>pcntl_waitpid()</strong>


id: pcntl_signal_dispatch
type: function
doc:
<comment>Description:</comment>
  ペンディングシグナル用のハンドラをコールする
  
  <strong>pcntl_signal_dispatch()</strong> 関数は、 <strong>pcntl_signal()</strong> がインストールしたシグナルハンドラを 各ペンディン
  グシグナルに対してコールします。

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

<comment>See Also:</comment>
   * <strong>pcntl_signal()</strong>
   * <strong>pcntl_sigprocmask()</strong>
   * <strong>pcntl_sigwaitinfo()</strong>
   * <strong>pcntl_sigtimedwait()</strong>


id: pcntl_signal_get_handler
type: function
doc:
<comment>Description:</comment>
  指定されたシグナルの現在のハンドラを取得する
  
  <strong>pcntl_signal_get_handler()</strong> 関数は、 指定された <strong>$signal</strong> の現在のハンドラを取得します。

<comment>Param:</comment>
  <info>int</info>  <strong>$signal</strong>  シグナル番号

<comment>Return:</comment>
  <info>callable|int</info>  この関数は、 <info>SIG_DFL</info> または <info>SIG_IGN</info> が参照する数値を返す可能性があります。 カスタム
                ハンドラを設定している場合は、<info>callable</info> を返します。

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


id: pcntl_sigprocmask
type: function
doc:
<comment>Description:</comment>
  ブロックされたシグナルを設定あるいは取得する
  
  <strong>pcntl_sigprocmask()</strong> 関数は、 ブロックされたシグナルを <strong>$mode</strong> パラメータに応じて 追加、削除あるいは
  設定します。

<comment>Param:</comment>
  <info>int</info>    <strong>$mode</strong>         <strong>pcntl_sigprocmask()</strong> の挙動を設定します。以下の値が設定できます。 <info>SIG_BLOCK</info>:
                       現在ブロックされているシグナルにシグナルを追加する<info>SIG_UNBLOCK</info>: 現在ブロックさ
                       れているシグナルからシグナルを削除する<info>SIG_SETMASK</info>: 現在ブロックされているシグ
                       ナルを、指定したもので置き換える
  <info>array</info>  <strong>$signals</strong>      シグナルのリスト。
  <info>array</info>  <strong>$old_signals</strong>  <strong>$old_signals</strong> パラメータには、 それまでにブロックされていたシグナルのリストが
                       設定されます。

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

<comment>See Also:</comment>
   * <strong>pcntl_sigwaitinfo()</strong>
   * <strong>pcntl_sigtimedwait()</strong>


id: pcntl_sigtimedwait
type: function
doc:
<comment>Description:</comment>
  タイムアウトつきでシグナルを待つ
  
  <strong>pcntl_sigtimedwait()</strong> 関数の挙動は <strong>pcntl_sigwaitinfo()</strong> とほぼ同じですが、さらに 2 つのパラメータが
  あります。 <strong>$seconds</strong> および <strong>$nanoseconds</strong> がそれで、 スクリプトが待ち続ける時間の上限をここで設定す
  ることができます。

<comment>Param:</comment>
  <info>array</info>  <strong>$signals</strong>      待つシグナルの配列。
  <info>array</info>  <strong>$info</strong>         シグナルについての情報を含む配列が <strong>$info</strong> に設定されます。 <strong>pcntl_sigwaitinfo()</strong>
                       を参照ください。
  <info>int</info>    <strong>$seconds</strong>      タイムアウトの秒数。
  <info>int</info>    <strong>$nanoseconds</strong>  タイムアウトのナノ秒数。

<comment>Return:</comment>
  <info>int|false</info>  成功した場合に <strong>pcntl_sigtimedwait()</strong> はシグナル番号を返します。 失敗した場合に <info>false</info> を
             返します

<comment>See Also:</comment>
   * <strong>pcntl_sigprocmask()</strong>
   * <strong>pcntl_sigwaitinfo()</strong>


id: pcntl_sigwaitinfo
type: function
doc:
<comment>Description:</comment>
  シグナルを待つ
  
  <strong>pcntl_sigwaitinfo()</strong> は、 呼び出し元のスクリプトの実行をいったん停止させ、<strong>$signals</strong> で指定したシグナ
  ルを受け取るまで待ちます。もしそのシグナルのいずれかがすでにペンディング状態 (<strong>pcntl_sigprocmask()</strong>
  でブロックされているなど) の場合、 <strong>pcntl_sigwaitinfo()</strong> は即時に結果を返します。

<comment>Param:</comment>
  <info>array</info>  <strong>$signals</strong>  待つシグナルの配列。
  <info>array</info>  <strong>$info</strong>     シグナルについての情報を含む配列が <strong>$info</strong> に設定されます。
                   
                   次の要素は、すべてのシグナルについて設定されます。 signo: シグナル番号errno: エ
                   ラー番号code: シグナルコード
                   
                   次の要素は、<info>SIGCHLD</info> シグナルの場合に設定されます。 status: 終了値あるいはシグナル
                   utime: 使用したユーザー時間stime: 使用したシステム時間pid: 送信したプロセスの
                   IDuid: 送信したプロセスの実ユーザー ID
                   
                   次の要素は、<info>SIGILL</info>、 <info>SIGFPE</info>、<info>SIGSEGV</info> および <info>SIGBUS</info> シグナルの場合に設定されます。
                   addr: 問題が発生したメモリ上の場所
                   
                   次の要素は、<info>SIGPOLL</info> シグナルの場合に設定されます。 band: バンドイベントfd: ファイ
                   ル記述子番号

<comment>Return:</comment>
  <info>int|false</info>  成功した場合にシグナル番号を返します。 失敗した場合に <info>false</info> を返します

<comment>See Also:</comment>
   * <strong>pcntl_sigprocmask()</strong>
   * <strong>pcntl_sigtimedwait()</strong>


id: pcntl_strerror
type: function
doc:
<comment>Description:</comment>
  指定した errno に対応するシステムのエラーメッセージを取得する
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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

<comment>Return:</comment>
  <info>string</info>  エラーの説明を返します。

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


id: pcntl_unshare
type: function
doc:
<comment>Description:</comment>
  プロセスの実行コンテキストの一部を切り離す
  
  <strong>pcntl_unshare()</strong> は、 プロセスが他のプロセスと現時点で共有している、 実行コンテキストの一部を切り離
  せるようにします。 <strong>pcntl_unshare()</strong> の主な用途は、 プロセスを作らずに、 プロセスが共有している実行
  コンテキストを制御できるようにすることです。

<comment>Param:</comment>
  <info>int</info>  <strong>$flags</strong>  <strong>$flags</strong> は、 切り離すべき実行コンテキストの一部を指定するためのビットマスクです。 この
               引数は、以下に示す0個以上の <return>CLONE_*</return> 定数を OR 条件として指定します:
               <info>CLONE_NEWNS</info><info>CLONE_NEWIPC</info><info>CLONE_NEWUTS</info><info>CLONE_NEWNET</info><info>CLONE_NEWPID</info><info>CLONE_NEWUSER</info><info>CLONE_NEWCGROUP</info>

<comment>Return:</comment>
  <info>bool</info>  成功した場合、<return>0</return> を返します。 失敗した場合、<return>-1</return> を返し、 エラーコードを設定します。 エラーコー
        ドは、<strong>pcntl_get_last_error()</strong> で取得できます。

<comment>See Also:</comment>
   * PCNTL 定数
   * <strong>pcntl_get_last_error()</strong>


id: pcntl_wait
type: function
doc:
<comment>Description:</comment>
  待つかフォークした子プロセスのステータスを返す
  
  この関数は、子プロセスが終了する・ カレントのプロセスを終了させるシグナルが送信される・シグナル処
  理関数を コールするシグナルが送信される のいずれかが発生するまでカレントのプロセスの実行を中断しま
  す。 子プロセスが、 コール時に 既に終了している場合("ゾンビ"プロセスと呼ばれます)、この関数は 直ち
  に処理を返します。子プロセスにより使用される全てのシステム リソースは、解放されます。waitpid のシ
  ステムでの動作に関する詳細は、 システムの wait(2) についての man ページを参照ください。
  
  この関数は、<strong>$process_id</strong> に <return>-1</return> を指定し、<strong>$flags</strong> を何も設定せずに <strong>pcntl_waitpid()</strong> をコールするのと等
  価です。

<comment>Param:</comment>
  <info>int</info>  <strong>$status</strong>  <strong>pcntl_wait()</strong> は、パラメータ <strong>$status</strong> の中にステータス情報を保存します。 このステータ
                スは、次の関数を用いて評価可能です。 <strong>pcntl_wifexited()</strong>、 <strong>pcntl_wifstopped()</strong>、
                <strong>pcntl_wifsignaled()</strong>、 <strong>pcntl_wexitstatus()</strong>、 <strong>pcntl_wtermsig()</strong> および <strong>pcntl_wstopsig()</strong>
                。
  <info>int</info>  <strong>$flags</strong>   システム上で wait3 が使用可能な場合 (ほとんどの BSD 系システムが 該当します)、オプ
                ションのパラメータ <strong>$flags</strong> を使用可能です。このパラメータが指定されない場合、wait は
                システムコールに 対して使用されます。wait3 が使用できない場合、<strong>$flags </strong> に値を設定し
                ても何の影響も及ぼしません。 <strong>$flags</strong> の値は、次の 2 つのグローバル定数の ゼロまたはそ
                れ以上の論理和です。 <strong>$flags</strong> のとりうる値<return>WNOHANG</return> 子プロセスが終了していない場合に直ち
                に処理を返します。 <return>WUNTRACED</return> 停止した子プロセスの場合に処理を返します。 そして、ス
                テータスは報告されません。

<comment>Return:</comment>
  <info>int</info>  <strong>pcntl_wait()</strong> は、終了した子プロセスの プロセス ID を返します。エラーの場合は -1、(wait3 が使
       用可能なシステムで) WNOHANG が使用され、子プロセスが利用できない場合に 0 を返します。

<comment>See Also:</comment>
   * <strong>pcntl_fork()</strong>
   * <strong>pcntl_signal()</strong>
   * <strong>pcntl_wifexited()</strong>
   * <strong>pcntl_wifstopped()</strong>
   * <strong>pcntl_wifsignaled()</strong>
   * <strong>pcntl_wexitstatus()</strong>
   * <strong>pcntl_wtermsig()</strong>
   * <strong>pcntl_wstopsig()</strong>
   * <strong>pcntl_waitpid()</strong>


id: pcntl_waitpid
type: function
doc:
<comment>Description:</comment>
  待つかフォークした子プロセスのステータスを返す
  
  引数 <strong>$process_id</strong> で指定した子プロセスが終了する・ 現在のプロセスを終了させるシグナルが送信される・
  シグナル処理関数を コールするシグナルが送信される のいずれかが発生するまで、現在のプロセスの実行を
  中断します。
  
  <strong>$process_id</strong> でリクエストされた子プロセスが、 コール時に既に終了している場合("ゾンビ"プロセスと呼ば
  れます)、 この関数は直ちに処理を返します。 子プロセスにより使用される全てのシステム リソースは、解
  放されます。waitpid のシステムでの動作に関する詳細は、 システムの waitpid(2) についての man ページ
  を参照ください。

<comment>Param:</comment>
  <info>int</info>  <strong>$process_id</strong>  <strong>$process_id</strong> の値は、次のどれかとなります。 <strong>$process_id</strong> のとりうる値<return>\< -1</return> プロセ
                    スグループ ID が <strong>$process_id</strong> の絶対値に等しい 子プロセスを待ちます。 <return>-1</return> 全ての子
                    プロセスを待ちます。これは、wait 関数の動作と同じです。 <return>0</return> プロセスグループ ID が
                    コール側のプロセスと等しい子プロセスを 待ちます。 <return>&gt; 0</return> プロセス ID が
                    <strong>$process_id</strong> の値に等しい 子プロセスを待ちます。
                    
                    <return>-1</return> を <strong>$process_id</strong> に指定した際の動きは、 <strong>pcntl_wait()</strong> の機能と (<strong>$flags</strong> を除いて)
                    同じです。
  <info>int</info>  <strong>$status</strong>      <strong>pcntl_waitpid()</strong> は、パラメータ <strong>$status</strong> の中にステータス情報を保存します。 このス
                    テータスは、次の関数を用いて評価可能です。 <strong>pcntl_wifexited()</strong>、
                    <strong>pcntl_wifstopped()</strong>、 <strong>pcntl_wifsignaled()</strong>、 <strong>pcntl_wexitstatus()</strong>、
                    <strong>pcntl_wtermsig()</strong> および <strong>pcntl_wstopsig()</strong> 。
  <info>int</info>  <strong>$flags</strong>       <strong>$flags</strong> の値は、次の 2 つのグローバル定数の ゼロまたはそれ以上の論理和です。
                    <strong>$flags</strong> のとりうる値<return>WNOHANG</return> 子プロセスが終了していない場合に直ちに処理を返しま
                    す。 <return>WUNTRACED</return> 停止した子プロセスの場合に処理を返します。そして、ステータス は報
                    告されません。

<comment>Return:</comment>
  <info>int</info>  <strong>pcntl_waitpid()</strong> は、終了した子プロセスの プロセス ID を返します。エラーの場合は -1、<info>WNOHANG</info>
       が使用され、 子プロセスが利用できない場合に 0 を返します。

<comment>See Also:</comment>
   * <strong>pcntl_fork()</strong>
   * <strong>pcntl_signal()</strong>
   * <strong>pcntl_wifexited()</strong>
   * <strong>pcntl_wifstopped()</strong>
   * <strong>pcntl_wifsignaled()</strong>
   * <strong>pcntl_wexitstatus()</strong>
   * <strong>pcntl_wtermsig()</strong>
   * <strong>pcntl_wstopsig()</strong>


id: pcntl_wexitstatus
type: function
doc:
<comment>Description:</comment>
  終了した子プロセスのリターンコードを返す
  
  終了した子プロセスのリターンコードを返します。この関数は、 <strong>pcntl_wifexited()</strong> が <info>true</info> を返す場合の
  み 有用です。

<comment>Param:</comment>
  <info>int</info>  <strong>$status</strong>  パラメータ <strong>$status</strong> は、
                <strong>pcntl_waitpid()</strong> が正常にコールされた際に得られます。

<comment>Return:</comment>
  <info>int|false</info>  リターンコードを返します。 この機能を OS がサポートしていない場合、<info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>pcntl_waitpid()</strong>
   * <strong>pcntl_wifexited()</strong>


id: pcntl_wifexited
type: function
doc:
<comment>Description:</comment>
  ステータスコードが正常終了を表しているかどうかを調べる
  
  ステータスコードが正常終了を表しているかどうかを調べます。

<comment>Param:</comment>
  <info>int</info>  <strong>$status</strong>  パラメータ <strong>$status</strong> は、
                <strong>pcntl_waitpid()</strong> が正常にコールされた際に得られます。

<comment>Return:</comment>
  <info>bool</info>  子プロセスのステータスコードが終了に成功した場合に <info>true</info>、 それ以外の場合に <info>false</info> を返しま
        す。

<comment>See Also:</comment>
   * <strong>pcntl_waitpid()</strong>
   * <strong>pcntl_wexitstatus()</strong>


id: pcntl_wifsignaled
type: function
doc:
<comment>Description:</comment>
  ステータスコードがシグナルによる終了を表しているかどうかを調べる
  
  子プロセスが終了した原因が、 シグナルが捕捉されなかったことであるかどうかを調べます。 caught.

<comment>Param:</comment>
  <info>int</info>  <strong>$status</strong>  パラメータ <strong>$status</strong> は、
                <strong>pcntl_waitpid()</strong> が正常にコールされた際に得られます。

<comment>Return:</comment>
  <info>bool</info>  捕捉されなかったシグナルのせいで子プロセスが終了した場合に <info>true</info>、 それ以外の場合に <info>false</info> を
        返します。

<comment>See Also:</comment>
   * <strong>pcntl_waitpid()</strong>
   * <strong>pcntl_signal()</strong>


id: pcntl_wifstopped
type: function
doc:
<comment>Description:</comment>
  子プロセスが現在停止しているかどうかを調べる
  
  リターンを生じた子プロセスが現在停止しているかどうかを調べます。 この関数は、<strong>pcntl_waitpid()</strong> の
  コールが オプション <return>WUNTRACED</return> を用いている場合のみ使用可能です。

<comment>Param:</comment>
  <info>int</info>  <strong>$status</strong>  パラメータ <strong>$status</strong> は、
                <strong>pcntl_waitpid()</strong> が正常にコールされた際に得られます。

<comment>Return:</comment>
  <info>bool</info>  リターンを生じた子プロセスが現在停止している場合に <info>true</info>、 それ以外の場合に <info>false</info> を返しま
        す。

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


id: pcntl_wstopsig
type: function
doc:
<comment>Description:</comment>
  子プロセスを停止させたシグナルを返す
  
  子プロセスを停止させたシグナル番号を返します。この関数は、 <strong>pcntl_wifstopped()</strong> が <info>true</info> を返す場合の
  み有用です。

<comment>Param:</comment>
  <info>int</info>  <strong>$status</strong>  パラメータ <strong>$status</strong> は、
                <strong>pcntl_waitpid()</strong> が正常にコールされた際に得られます。

<comment>Return:</comment>
  <info>int|false</info>  シグナル番号を返します。 この機能を OS がサポートしていない場合、<info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>pcntl_waitpid()</strong>
   * <strong>pcntl_wifstopped()</strong>


id: pcntl_wtermsig
type: function
doc:
<comment>Description:</comment>
  子プロセスを終了させたシグナルを返す
  
  子プロセスを終了させたシグナル番号を返します。この関数は、 <strong>pcntl_wifsignaled()</strong> が <info>true</info> を返す場合
  のみ有用です。

<comment>Param:</comment>
  <info>int</info>  <strong>$status</strong>  パラメータ <strong>$status</strong> は、
                <strong>pcntl_waitpid()</strong> が正常にコールされた際に得られます。

<comment>Return:</comment>
  <info>int|false</info>  シグナル番号を返します。 この機能を OS がサポートしていない場合、<info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>pcntl_waitpid()</strong>
   * <strong>pcntl_signal()</strong>
   * <strong>pcntl_wifsignaled()</strong>


id: pfsockopen
type: function
doc:
<comment>Description:</comment>
  持続的な Internet または Unix ドメインソケット接続をオープンする
  
  この関数は、<strong>fsockopen()</strong> と全く同様に動作します。 ただし、この関数による接続はリクエストが終了した
  後でも閉じられないという違いがあります。 この関数は、<strong>fsockopen()</strong> の持続的接続版です。

<comment>Return:</comment>
  <info>resource|false</info>  <strong>pfsockopen()</strong> は、 他のファイル関数 (<strong>fgets()</strong>, <strong>fgetss()</strong>, <strong>fwrite()</strong>, <strong>fclose()</strong>, <strong>feof()</strong>)
                  で使うファイルポインタを返します。 失敗した場合に <info>false</info> を返します

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


id: pg_affected_rows
type: function
doc:
<comment>Description:</comment>
  変更されたレコード(タプル)の数を返す
  
  <strong>pg_affected_rows()</strong> は、INSERT, UPDATE, DELETE クエリにより変更されたタプル(インスタンス/レコード
  /行)の数を 返します。
  
  PostgreSQL 9.0 以降は、SELECT を実行したときには選択された行の数を返すようになりました。 それ以前
  のバージョンでは、SELECT が返す結果は 0 でした。
  
  この関数は、以前は <strong>pg_cmdtuples()</strong> と呼ばれていました。

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>  <strong>pg_query()</strong>、<strong>pg_query_params()</strong> や (様々な関数がありますが、特に)
                         <strong>pg_execute()</strong> が返した <class>PgSql\Result</class> クラスのインスタンス。

<comment>Return:</comment>
  <info>int</info>  クエリによって変更された行の数を返します。もし変更されたタプルがない場合は <return>0</return> を返します。

<comment>See Also:</comment>
   * <strong>pg_query()</strong>
   * <strong>pg_query_params()</strong>
   * <strong>pg_execute()</strong>
   * <strong>pg_num_rows()</strong>


id: pg_cancel_query
type: function
doc:
<comment>Description:</comment>
  非同期クエリを取り消す
    
  
  <strong>pg_cancel_query()</strong> は、 <strong>pg_send_query()</strong>・<strong>pg_send_query_params()</strong> あるいは <strong>pg_send_execute()</strong> により送
  信された非同期クエリを キャンセルします。<strong>pg_query()</strong> により実行されたクエリを キャンセルすることは
  できません。

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

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

<comment>See Also:</comment>
   * <strong>pg_send_query()</strong>
   * <strong>pg_connection_busy()</strong>


id: pg_client_encoding
type: function
doc:
<comment>Description:</comment>
  クライアントのエンコーディングを取得する
    
  
  PostgreSQL は、ある種の文字セットについてはサーバーとクライアントの間の 自動文字コード変換をサポー
  トしています。 <strong>pg_client_encoding()</strong> は、クライアントの エンコーディングを文字列として返します。返
  される値は、標準の PostgreSQL エンコーディング識別子のなかのひとつとなります。
  
  この関数を使用するには、PostgreSQL 7.0 以降が必要です。 libpq がマルチバイトエンコーディングのサ
  ポートを有効にせずに コンパイルされている場合、<strong>pg_client_encoding()</strong> は常に <return>SQL_ASCII</return> を返します。
  サポートされる エンコーディングは PostgreSQL のバージョンに依存します。サポートされる エンコーディ
  ングの詳細については PostgreSQL のドキュメントを参照ください。
  
  この関数は、以前は <strong>pg_clientencoding()</strong> と呼ばれていました。

<comment>Param:</comment>
  <info>PgSql\Connection|null</info>  <strong>$connection</strong>  <class>PgSql\Connection</class> クラスのインスタンス。
                                      <strong>$connection</strong> が <info>null</info>, の場合、デフォルトの接続を使います。
                                      デフォルトの接続とは、<strong>pg_connect()</strong> または <strong>pg_pconnect()</strong> によっ
                                      て確立された直近の接続です。
                                      PHP 8.1.0 以降では、デフォルトの接続を使うことは推奨されなくな
                                      りました。
                                      
                                      PHP 8.1.0 以降では、デフォルトの接続を使うことは推奨されなくな
                                      りました。

<comment>Return:</comment>
  <info>string</info>  クライアントのエンコーディングを返します。

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


id: pg_close
type: function
doc:
<comment>Description:</comment>
  PostgreSQL 接続をクローズする
  
  <strong>pg_close()</strong> は、 <strong>$connection</strong> インスタンスで指定した PostgreSQL データベースへの持続的でない接続を閉
  じます。
  
  持続的でない接続はスクリプトの実行終了時に自動的にクローズされるため、 <strong>pg_close()</strong> は通常は必要あり
  ません。
  
  接続の中でオープンされている <class>PgSql\Lob</class> のインスタンスが存在する場合、すべての <class>PgSql\Lob</class> のインスタ
  ンスを クローズするまで接続を閉じないでください。

<comment>Param:</comment>
  <info>PgSql\Connection|null</info>  <strong>$connection</strong>  <class>PgSql\Connection</class> クラスのインスタンス。
                                      <strong>$connection</strong> が <info>null</info>, の場合、デフォルトの接続を使います。
                                      デフォルトの接続とは、<strong>pg_connect()</strong> または <strong>pg_pconnect()</strong> によっ
                                      て確立された直近の接続です。
                                      PHP 8.1.0 以降では、デフォルトの接続を使うことは推奨されなくな
                                      りました。
                                      
                                      PHP 8.1.0 以降では、デフォルトの接続を使うことは推奨されなくな
                                      りました。

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

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


id: pg_connect
type: function
doc:
<comment>Description:</comment>
  PostgreSQL 接続をオープンする
  
  <strong>pg_connect()</strong> は、<strong>$connection_string</strong> で指定された情報を用いてデータベースとの接続をオープンします。
  
  同じ <strong>$connection_string</strong> 引数で 2 回 <strong>pg_connect()</strong> 関数がコールされた場合は、 <strong>$flags</strong> に
  <info>PGSQL_CONNECT_FORCE_NEW</info> を指定していない限り 既存の接続が返されます。
  
  複数のパラメータをサポートする古い構文 $conn = pg_connect("host", "port", "options", "tty",
  "dbname")  は推奨されません。

<comment>Param:</comment>
  <info>string</info>  <strong>$connection_string</strong>  すべてデフォルトのパラメータを使用する場合には <strong>$connection_string</strong> を空
                              にすることが可能です。 または 1 つ以上のパラメータを空白で区切って指定
                              することも可能です。 個々のパラメータは <return>keyword = value</return> の形式で 設定
                              します。等号の前後の空白はあってもなくてもかまいません。 空の値や空白
                              を含む値を指定する場合は、その値をシングルクォートで 囲みます（例:
                              <return>keyword = 'a value'</return>）。値の中に シングルクォートやバックスラッシュが含
                              まれる場合は、それらを バックスラッシュでエスケープする必要があります
                              （例: \' および \\）。
                              
                              現在利用できるパラメータは以下のとおりです。 <strong>$host</strong>, <strong>$hostaddr</strong>, <strong>$port</strong>,
                              <strong>$dbname</strong> (デフォルトは <strong>$user</strong> の値), <strong>$user</strong>, <strong>$password</strong>, <strong>$connect_timeout</strong>,
                              <strong>$options</strong>, <strong>$tty</strong>（無視されます）, <strong>$sslmode</strong>, <strong>$requiressl</strong>（非推奨。代わり
                              に <strong>$sslmode</strong> を推奨します） および <strong>$service</strong> 。これらのうち実際にどの パ
                              ラメータが使えるかは、PostgreSQL のバージョンに依存します。
                              
                              <strong>$options</strong> パラメータを使うと、 サーバー側で実行されるコマンドラインパラ
                              メータを指定することができます。
  <info>int</info>     <strong>$flags</strong>              <info>PGSQL_CONNECT_FORCE_NEW</info> が渡された場合は、 たとえ <strong>$connection_string</strong>
                              が既存の接続と まったく同一であっても新しい接続をオープンします。
                              
                              <info>PGSQL_CONNECT_ASYNC</info> を指定すると、 非同期接続を確立します。この接続の
                              状態は、 <strong>pg_connect_poll()</strong> あるいは <strong>pg_connection_status()</strong> で確認でき
                              ます。

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

<comment>See Also:</comment>
   * <strong>pg_pconnect()</strong>
   * <strong>pg_close()</strong>
   * <strong>pg_host()</strong>
   * <strong>pg_port()</strong>
   * <strong>pg_tty()</strong>
   * <strong>pg_options()</strong>
   * <strong>pg_dbname()</strong>


id: pg_connect_poll
type: function
doc:
<comment>Description:</comment>
  進行中の非同期接続のステータスをポーリングする
    
  
  <strong>pg_connect_poll()</strong> は、 <info>PGSQL_CONNECT_ASYNC</info> オプションを使用して コールされた <strong>pg_connect()</strong> で作成さ
  れた PostgreSQL 接続のステータスをポーリングします。

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

<comment>Return:</comment>
  <info>int</info>  <info>PGSQL_POLLING_FAILED</info>、 <info>PGSQL_POLLING_READING</info>、 <info>PGSQL_POLLING_WRITING</info>、 <info>PGSQL_POLLING_OK</info>、 ま
       たは <info>PGSQL_POLLING_ACTIVE</info> を返します。


id: pg_connection_busy
type: function
doc:
<comment>Description:</comment>
  接続がビジーかどうか調べる
    
  
  <strong>pg_connection_busy()</strong> は、接続がビジーかどうかを調べます。 接続がビジーである場合、以前のクエリがま
  だ実行中です。 もしこの接続に <strong>pg_get_result()</strong> がコールされた場合、 それはブロックされます。

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

<comment>Return:</comment>
  <info>bool</info>  接続がビジーの場合に <info>true</info> 、そうでない場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>pg_connection_status()</strong>
   * <strong>pg_get_result()</strong>


id: pg_connection_reset
type: function
doc:
<comment>Description:</comment>
  接続をリセット(再接続)する
    
  
  <strong>pg_connection_reset()</strong> は接続をリセットします。 エラーからの復旧の際に有用です。

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

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

<comment>See Also:</comment>
   * <strong>pg_connect()</strong>
   * <strong>pg_pconnect()</strong>
   * <strong>pg_connection_status()</strong>


id: pg_connection_status
type: function
doc:
<comment>Description:</comment>
  接続ステータスを取得する
    
  
  <strong>pg_connection_status()</strong> は、 <strong>$connection</strong> で指定した接続のステータスを返します。

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

<comment>Return:</comment>
  <info>int</info>  <info>PGSQL_CONNECTION_OK</info> あるいは <info>PGSQL_CONNECTION_BAD</info> 。

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


id: pg_consume_input
type: function
doc:
<comment>Description:</comment>
  接続の入力を読み取る
  
  <strong>pg_consume_input()</strong> は、データベースサーバーからの 読み取りを待っているすべての入力を消費します。

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

<comment>Return:</comment>
  <info>bool</info>  エラーが発生しなかった場合 <info>true</info>、 エラーがあった場合 <info>false</info>。 <info>true</info> が返されたからといって、入
        力が読み取り待機中であるとは限らないことに注意してください。


id: pg_convert
type: function
doc:
<comment>Description:</comment>
  連想配列の値を、SQL 文として実行可能な形式に変換する
    
  
  <strong>pg_convert()</strong> は、<strong>$values</strong> の中の値をチェックし、SQL 文の中で使用可能な形式に変換します。 少なくとも
  <strong>$values</strong> の要素数以上のカラムを持つ テーブル <strong>$table_name</strong> が存在することが前提条件と なります。
  <strong>$values</strong> の要素名が <strong>$table_name</strong> のフィールド名と一致し、また 要素に対応する値はフィールドのデータ型
  と互換性がなければなりません。 成功した場合に変換後の値の配列、それ以外の場合に <info>false</info> を返します。
  
  この関数は、boolean 値も受付けることができ、 PostgreSQL の boolean 型に変換します。 boolean 値の文
  字列表現にも対応しています。 <info>null</info> は、PostgreSQL の NULL に変換します。
  
  この関数は、
  実験的 なものです。この関数の動作・
  名前・その他ドキュメントに書かれている事項は、予告なく、将来的な PHP
  のリリースにおいて変更される可能性があります。
  この関数は自己責任で使用してください。

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  <class>PgSql\Connection</class> クラスのインスタンス。
  <info>string</info>            <strong>$table_name</strong>  変換対象となるテーブルの名前。
  <info>array</info>             <strong>$values</strong>      変換されるデータ。
  <info>int</info>               <strong>$flags</strong>       <info>PGSQL_CONV_IGNORE_DEFAULT</info>, <info>PGSQL_CONV_FORCE_NULL</info> あるいは
                                 <info>PGSQL_CONV_IGNORE_NOT_NULL</info> の組み合わせ。

<comment>Return:</comment>
  <info>array|false</info>  変換された値の配列を返します。 失敗した場合に <info>false</info> を返します

<comment>See Also:</comment>
   * <strong>pg_meta_data()</strong>
   * <strong>pg_insert()</strong>
   * <strong>pg_select()</strong>
   * <strong>pg_update()</strong>
   * <strong>pg_delete()</strong>


id: pg_copy_from
type: function
doc:
<comment>Description:</comment>
  配列からテーブルに挿入する
    
  
  <strong>pg_copy_from()</strong> は、<strong>$rows</strong> の内容をテーブルに挿入します。レコードを挿入するために、内部では <return>COPY
  FROM</return> SQL コマンドを発行します。

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  <class>PgSql\Connection</class> クラスのインスタンス。
  <info>string</info>            <strong>$table_name</strong>  <strong>$rows</strong> をコピーするテーブルの名前。
  <info>array</info>             <strong>$rows</strong>        <strong>$table_name</strong> にコピーするデータの配列。 <strong>$rows</strong> の個々の値が
                                 <strong>$table_name</strong> のひとつの行となります。<strong>$rows</strong> の個々の値は、 それぞれの
                                 フィールドに対応する値が区切り文字で区切られており、最後は 改行で終
                                 了していなければなりません。
  <info>string</info>            <strong>$separator</strong>   <strong>$rows</strong> の要素内で、各フィールドに対応する値を 区切る文字。デフォルト
                                 は <return>\t</return> です。
  <info>string</info>            <strong>$null_as</strong>     <strong>$rows</strong> の中で、SQL の <return>NULL</return>  をどのように表現するか。デフォルトは <return>\\N</return>
                                 (<return>"\\\\N"</return>) です。

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

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


id: pg_copy_to
type: function
doc:
<comment>Description:</comment>
  配列にテーブルをコピーする
    
  
  <strong>pg_copy_to()</strong> は、テーブルを配列にコピーします。 レコードを取得するために、内部では <return>COPY TO</return> SQL コ
  マンドを発行します。

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  <class>PgSql\Connection</class> クラスのインスタンス。
  <info>string</info>            <strong>$table_name</strong>  データを <strong>$rows</strong> にコピーするテーブルの名前。
  <info>string</info>            <strong>$separator</strong>   <strong>$rows</strong> の要素内で、各フィールドに対応する値を 区切る文字。デフォルト
                                 は <return>\t</return> です。
  <info>string</info>            <strong>$null_as</strong>     <strong>$rows</strong> の中で、SQL の <return>NULL</return>  をどのように表現するか。デフォルトは <return>\\N</return>
                                 (<return>"\\\\N"</return>) です。

<comment>Return:</comment>
  <info>array|false</info>  <return>COPY</return> されたデータが 1 行ごとにひとつの要素と なっている配列を返します。 失敗した場合
               に <info>false</info> を返します

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


id: pg_dbname
type: function
doc:
<comment>Description:</comment>
  データベース名を取得する
  
  <strong>pg_dbname()</strong> は、 PostgreSQL の <strong>$connection</strong> インスタンスで指定した データベースの名前を返します。

<comment>Param:</comment>
  <info>PgSql\Connection|null</info>  <strong>$connection</strong>  <class>PgSql\Connection</class> クラスのインスタンス。
                                      <strong>$connection</strong> が <info>null</info>, の場合、デフォルトの接続を使います。
                                      デフォルトの接続とは、<strong>pg_connect()</strong> または <strong>pg_pconnect()</strong> によっ
                                      て確立された直近の接続です。
                                      PHP 8.1.0 以降では、デフォルトの接続を使うことは推奨されなくな
                                      りました。
                                      
                                      PHP 8.1.0 以降では、デフォルトの接続を使うことは推奨されなくな
                                      りました。

<comment>Return:</comment>
  <info>string</info>  <strong>$connection</strong> が指すデータベースの名前を表す 文字列を返します。


id: pg_delete
type: function
doc:
<comment>Description:</comment>
  レコードを削除する
    
  
  <strong>pg_delete()</strong> は、<strong>$conditions</strong> で指定したキーと値を用いてテーブルからレコードを削除します。
  
  <strong>$flags</strong> が指定された場合、指定したオプションを つけて <strong>pg_convert()</strong> が <strong>$conditions</strong> に適用されます。
  
  デフォルトでは、 <strong>pg_delete()</strong> は生の値を渡します。 値はエスケープするか、 <info>PGSQL_DML_ESCAPE</info> オプショ
  ンを指定しなければいけません。 <info>PGSQL_DML_ESCAPE</info> はパラメータや識別子をクォートし、 エスケープしま
  す。 よって、テーブル/カラム名は大文字小文字を区別します。
  
  エスケープやプリペアドクエリであっても、 LIKE, JSON, Array, Regex などのクエリを守れない可能性があ
  ることに注意してください。 これらのパラメータはコンテクストに応じて処理されるべきです。 たとえば、
  値をエスケープ/検証する処理を行うことなどです。

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  <class>PgSql\Connection</class> クラスのインスタンス。
  <info>string</info>            <strong>$table_name</strong>  行を削除するテーブルの名前。
  <info>array</info>             <strong>$conditions</strong>  そのキーが <strong>$table_name</strong> テーブルのフィールド名、 値が削除したい
                                 フィールドの値となっている配列。
  <info>int</info>               <strong>$flags</strong>       <info>PGSQL_CONV_FORCE_NULL</info>、 <info>PGSQL_DML_NO_CONV</info>、 <info>PGSQL_DML_ESCAPE</info>、
                                 <info>PGSQL_DML_EXEC</info>、 <info>PGSQL_DML_ASYNC</info> あるいは <info>PGSQL_DML_STRING</info> を組み合
                                 わせた数。 <strong>$flags</strong> に <info>PGSQL_DML_STRING</info> が含まれている場合、クエリ文
                                 字列が返されます。 <info>PGSQL_DML_NO_CONV</info> あるいは <info>PGSQL_DML_ESCAPE</info> が設
                                 定されている場合は、内部的に <strong>pg_convert()</strong> を呼びません。

<comment>Return:</comment>
  <info>string|bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。  <strong>$flags</strong> で <info>PGSQL_DML_STRING</info>
               が渡された場合は文字列を返します。

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


id: pg_end_copy
type: function
doc:
<comment>Description:</comment>
  PostgreSQL バックエンドと同期する
  
  <strong>pg_end_copy()</strong> は、<strong>pg_put_line()</strong> によるコピー操作の後で PostgreSQL フロントエンド（通常は Web サー
  バー プロセス）と PostgreSQL サーバーを同期させます。 <strong>pg_end_copy()</strong> を実行しなければ、PostgreSQL
  サーバーが フロントエンドとの同期を失ってしまい、エラーが発生します。

<comment>Param:</comment>
  <info>PgSql\Connection|null</info>  <strong>$connection</strong>  <class>PgSql\Connection</class> クラスのインスタンス。
                                      <strong>$connection</strong> が <info>null</info>, の場合、デフォルトの接続を使います。
                                      デフォルトの接続とは、<strong>pg_connect()</strong> または <strong>pg_pconnect()</strong> によっ
                                      て確立された直近の接続です。
                                      PHP 8.1.0 以降では、デフォルトの接続を使うことは推奨されなくな
                                      りました。
                                      
                                      PHP 8.1.0 以降では、デフォルトの接続を使うことは推奨されなくな
                                      りました。

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

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


id: pg_escape_bytea
type: function
doc:
<comment>Description:</comment>
  bytea フィールドに挿入するために文字列をエスケープする
    
  
  <strong>pg_escape_bytea()</strong> は、bytea 型のために文字列を エスケープし、エスケープした文字列を返します。
  
  bytea 型を <return>SELECT</return> した場合、PostgreSQL は '\' で 始まる 8 進数のバイト値（例: \032）を返します。こ
  れをユーザーが手動で コンバートすることを期待されています。
  
  この関数は PostgreSQL 7.2 以降のバージョンが必要です。PostgreSQL 7.2.0 および 7.2.1 では、マルチバ
  イトのサポートを有効にした場合は bytea の値をキャストする必要があります。例: <return>INSERT INTO
  test_table (image) VALUES ('$image_escaped'::bytea); </return> PostgreSQL 7.2.2 以降ではキャストする必要は
  ありません。 クライアントとバックエンドの文字エンコーディングが一致しない場合は 例外で、この場合は
  マルチバイトストリームエラーが発生します。この エラーを避けるためには bytea 型へのキャストが必要に
  なります。

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  <class>PgSql\Connection</class> クラスのインスタンス。
                                 <strong>$connection</strong> が指定されない場合は、デフォルトの接続を使います。
                                 デフォルトの接続とは、<strong>pg_connect()</strong> または <strong>pg_pconnect()</strong> によって確
                                 立された直近の接続です。
                                 PHP 8.1.0 以降では、デフォルトの接続を使うことは推奨されなくなりま
                                 した。
                                 
                                 PHP 8.1.0 以降では、デフォルトの接続を使うことは推奨されなくなりま
                                 した。
  <info>string</info>            <strong>$data</strong>        bytea 型のカラムに挿入するテキストまたはバイナリデータを含む 文字
                                 列。

<comment>Return:</comment>
  <info>string</info>  エスケープされたデータを文字列で返します。

<comment>See Also:</comment>
   * <strong>pg_unescape_bytea()</strong>
   * <strong>pg_escape_string()</strong>


id: pg_escape_identifier
type: function
doc:
<comment>Description:</comment>
  テキスト型フィールドに挿入するために、識別子をエスケープする
    
  
  <strong>pg_escape_identifier()</strong> は、データベースへの問い合わせに使う識別子 (テーブル名やフィールド名など)
  をエスケープします。 PostgreSQL サーバー用にエスケープされた識別子を返します。
  <strong>pg_escape_identifier()</strong> は、データの前後にダブルクォートを追加します。 ユーザーが自分で追加してはい
  けません。 この関数は、クエリ内で使う識別子のパラメータに有用です。SQL リテラル (bytea 以外のパラ
  メータ) には、<strong>pg_escape_literal()</strong> あるいは <strong>pg_escape_string()</strong> を使わなければなりません。 bytea 型
  のフィールドには、<strong>pg_escape_bytea()</strong> を使わなければなりません。
  
  この関数は内部的なエスケープコードを使い、PostgreSQL 8.4 より前のバージョンでも使えます。

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  <class>PgSql\Connection</class> クラスのインスタンス。
                                 <strong>$connection</strong> が指定されない場合は、デフォルトの接続を使います。
                                 デフォルトの接続とは、<strong>pg_connect()</strong> または <strong>pg_pconnect()</strong> によって確
                                 立された直近の接続です。
                                 PHP 8.1.0 以降では、デフォルトの接続を使うことは推奨されなくなりま
                                 した。
                                 
                                 PHP 8.1.0 以降では、デフォルトの接続を使うことは推奨されなくなりま
                                 した。
  <info>string</info>            <strong>$data</strong>        エスケープするテキスト文字列。

<comment>Return:</comment>
  <info>string</info>  エスケープされたデータを文字列で返します。

<comment>See Also:</comment>
   * <strong>pg_escape_literal()</strong>
   * <strong>pg_escape_bytea()</strong>
   * <strong>pg_escape_string()</strong>


id: pg_escape_literal
type: function
doc:
<comment>Description:</comment>
  テキスト型フィールドに挿入するために、リテラルをエスケープする
    
  
  <strong>pg_escape_literal()</strong> は、 PostgreSQL データベースへの問い合わせに使うリテラルをエスケープします。
  PostgreSQL フォーマットでエスケープされたリテラルを返します。 <strong>pg_escape_literal()</strong> は、データの前後
  にクォートを追加します。 ユーザーが自分で追加してはいけません。 <strong>pg_escape_string()</strong> ではなくこの関
  数を使うことを推奨します。 カラム型が bytea の場合は、代わりに <strong>pg_escape_bytea()</strong> を使わなければな
  りません。 識別子 (テーブル名やフィールド名など) のエスケープには <strong>pg_escape_identifier()</strong> を使わな
  ければなりません。
  
  この関数は内部的なエスケープコードを使い、PostgreSQL 8.4 より前のバージョンでも使えます。

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  <class>PgSql\Connection</class> クラスのインスタンス。
                                 <strong>$connection</strong> が指定されない場合は、デフォルトの接続を使います。
                                 デフォルトの接続とは、<strong>pg_connect()</strong> または <strong>pg_pconnect()</strong> によって確
                                 立された直近の接続です。
                                 PHP 8.1.0 以降では、デフォルトの接続を使うことは推奨されなくなりま
                                 した。
                                 
                                 PHP 8.1.0 以降では、デフォルトの接続を使うことは推奨されなくなりま
                                 した。
  <info>string</info>            <strong>$data</strong>        エスケープするテキスト文字列。

<comment>Return:</comment>
  <info>string</info>  エスケープされたデータを文字列で返します。

<comment>See Also:</comment>
   * <strong>pg_escape_identifier()</strong>
   * <strong>pg_escape_bytea()</strong>
   * <strong>pg_escape_string()</strong>


id: pg_escape_string
type: function
doc:
<comment>Description:</comment>
  クエリに使う文字列をエスケープする
    
  
  <strong>pg_escape_string()</strong> は、データベースへの問い合わせに使う文字列をエスケープします。 PostgreSQL
  フォーマットにエスケープされた文字列を、クォートなしの形式で返します。 PostgreSQL に使う SQL パラ
  メータをエスケープするときには <strong>pg_escape_literal()</strong> を使うほうがよいでしょう。 <strong>addslashes()</strong> を
  PostgreSQL で使ってはいけません。 カラム型が bytea の場合は、代わりに <strong>pg_escape_bytea()</strong> を使わなけ
  ればなりません。 識別子 (テーブル名やフィールド名など) のエスケープには <strong>pg_escape_identifier()</strong> を
  使わなければなりません。
  
  この関数は、PostgreSQL 7.2 以降が必要です。

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  <class>PgSql\Connection</class> クラスのインスタンス。
                                 <strong>$connection</strong> が指定されない場合は、デフォルトの接続を使います。
                                 デフォルトの接続とは、<strong>pg_connect()</strong> または <strong>pg_pconnect()</strong> によって確
                                 立された直近の接続です。
                                 PHP 8.1.0 以降では、デフォルトの接続を使うことは推奨されなくなりま
                                 した。
                                 
                                 PHP 8.1.0 以降では、デフォルトの接続を使うことは推奨されなくなりま
                                 した。
  <info>string</info>            <strong>$data</strong>        エスケープするテキスト文字列。

<comment>Return:</comment>
  <info>string</info>  エスケープされたデータを文字列で返します。

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


id: pg_execute
type: function
doc:
<comment>Description:</comment>
  指定したパラメータを用いてプリペアドステートメントを実行するリクエストを
     送信し、その結果を待つ
    
  
  指定したパラメータを用いてプリペアドステートメントを実行するリクエストを 送信し、その結果を待ちま
  す。
  
  <strong>pg_execute()</strong> は <strong>pg_query_params()</strong> と似ています。しかし、実行するコマンドはクエリを指定することで
  決まるのではなく、事前に準備されたステートメントに値を指定する ことによって決まります。この機能の
  おかげで、繰り返し使用される コマンドに構文解析や実行計画作成が最初の一度だけで済みます。 実行する
  ステートメントは、カレントのセッションで事前に準備しておく 必要があります。<strong>pg_execute()</strong> は、
  PostgreSQL 7.4 以降のバージョンの接続にのみ対応しています。それ以前のバージョンでは 失敗します。
  
  パラメータは <strong>pg_query_params()</strong> と同じですが、 クエリ文字列のかわりにプリペアドステートメントの名前
  を指定する という点だけが違います。

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  <class>PgSql\Connection</class> クラスのインスタンス。
                                 <strong>$connection</strong> が指定されない場合は、デフォルトの接続を使います。
                                 デフォルトの接続とは、<strong>pg_connect()</strong> または <strong>pg_pconnect()</strong> によって確
                                 立された直近の接続です。
                                 PHP 8.1.0 以降では、デフォルトの接続を使うことは推奨されなくなりま
                                 した。
                                 
                                 PHP 8.1.0 以降では、デフォルトの接続を使うことは推奨されなくなりま
                                 した。
  <info>string</info>            <strong>$stmtname</strong>    実行するプリペアドステートメントの名前。"" が指定された場合は 無名
                                 ステートメントが実行されます。名前は、事前に <strong>pg_prepare()</strong>・
                                 <strong>pg_send_prepare()</strong> あるいは <return>PREPARE</return> SQL コマンドで準備されたものであ
                                 る 必要があります。
  <info>array</info>             <strong>$params</strong>      プリペアドステートメント中の $1、$2 などのプレースホルダを 置き換え
                                 るパラメータの配列。配列の要素数はプレースホルダの 数と一致する必要
                                 があります。
                                 
                                 この関数をコールする際に、要素の内容は文字列に変換されます。

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

<comment>See Also:</comment>
   * <strong>pg_prepare()</strong>
   * <strong>pg_send_prepare()</strong>
   * <strong>pg_query_params()</strong>


id: pg_fetch_all
type: function
doc:
<comment>Description:</comment>
  取得されたすべての行を配列として取得する
  
  <strong>pg_fetch_all()</strong>は、 <class>PgSql\Result</class> インスタンスのすべての行 （レコード）を保持する配列を返します。
  
  この関数は、
  NULL フィールドに PHPの <info>null</info> 値を設定します。

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>  <strong>pg_query()</strong>、<strong>pg_query_params()</strong> や (様々な関数がありますが、特に)
                         <strong>pg_execute()</strong> が返した <class>PgSql\Result</class> クラスのインスタンス。
  <info>int</info>           <strong>$mode</strong>    返される配列のインデックスを制御するオプションの引数です。
                         <strong>$mode</strong> は定数で、以下の値を取ることができます。:
                         <info>PGSQL_ASSOC</info>, <info>PGSQL_NUM</info>, <info>PGSQL_BOTH</info>。
                         <info>PGSQL_NUM</info> を使うと、配列のインデックスを数値にした配列を返します。
                         <info>PGSQL_ASSOC</info> を使うと、連想配列のインデックスを返します。<info>PGSQL_BOTH</info> を指定す
                         ると、数値と連想配列のインデックスを両方含めた形で配列を返します。

<comment>Return:</comment>
  <info>array</info>  結果のすべての行を含む配列を返します。それぞれの行は、フィールド名を 添字とするフィールド値
         の配列です。

<comment>See Also:</comment>
   * <strong>pg_fetch_row()</strong>
   * <strong>pg_fetch_array()</strong>
   * <strong>pg_fetch_object()</strong>
   * <strong>pg_fetch_result()</strong>


id: pg_fetch_all_columns
type: function
doc:
<comment>Description:</comment>
  指定したカラムの全ての行を配列として取得する
  
  <strong>pg_fetch_all_columns()</strong> は、 <class>PgSql\Result</class> クラスのインスタンスで 指定したカラムについて、 全ての行
  （レコード）を含む配列を返します。
  
  この関数は、
  NULL フィールドに PHPの <info>null</info> 値を設定します。

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>  <strong>pg_query()</strong>、<strong>pg_query_params()</strong> や (様々な関数がありますが、特に)
                         <strong>pg_execute()</strong> が返した <class>PgSql\Result</class> クラスのインスタンス。
  <info>int</info>           <strong>$field</strong>   カラムの番号。 指定しない場合のデフォルトは最初のカラムです。

<comment>Return:</comment>
  <info>array</info>  結果カラムの全ての値を配列で返します。

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


id: pg_fetch_array
type: function
doc:
<comment>Description:</comment>
  行を配列として取得する
  
  <strong>pg_fetch_array()</strong> は、取得した行（レコード）を 配列で返します。
  
  <strong>pg_fetch_array()</strong> は拡張版の <strong>pg_fetch_row()</strong> です。結果配列のフィールド番号に 対応する要素にデータを
  格納し、それに加えてフィールド名をキーとした 連想配列にも格納します。デフォルトで、両方ともが有効
  になっています。
  
  この関数は、
  NULL フィールドに PHPの <info>null</info> 値を設定します。
  
  <strong>pg_fetch_array()</strong> は、 <strong>pg_fetch_row()</strong> に比べてきわめて遅いというわけでは 「ありません」。そして、き
  わめて簡単に使用できます。

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>  <strong>pg_query()</strong>、<strong>pg_query_params()</strong> や (様々な関数がありますが、特に)
                         <strong>pg_execute()</strong> が返した <class>PgSql\Result</class> クラスのインスタンス。
  <info>int|null</info>      <strong>$row</strong>     取得する行番号。最初の行は 0 です。省略したり <info>null</info> を指定したりした場合は、
                         次の行を取得します。
  <info>int</info>           <strong>$mode</strong>    返される配列のインデックスを制御するオプションの引数です。
                         <strong>$mode</strong> は定数で、以下の値を取ることができます。:
                         <info>PGSQL_ASSOC</info>, <info>PGSQL_NUM</info>, <info>PGSQL_BOTH</info>。
                         <info>PGSQL_NUM</info> を使うと、配列のインデックスを数値にした配列を返します。
                         <info>PGSQL_ASSOC</info> を使うと、連想配列のインデックスを返します。<info>PGSQL_BOTH</info> を指定す
                         ると、数値と連想配列のインデックスを両方含めた形で配列を返します。

<comment>Return:</comment>
  <info>array|false</info>  0 から始まる数値添字の配列か連想配列（フィールド名をキーとする）、 あるいはその両方を
               返します。配列の各要素の値は文字列です。 データベースの <return>NULL</return> 値は、<info>null</info> として返しま
               す。
               
               <strong>$row</strong> が結果の行数より大きい場合や、行が存在しない場合、 そしてそれ以外のエラーが発生
               した場合は <info>false</info> を返します。 SELECT 以外のクエリから結果を取得しようとした場合も、
               <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>pg_fetch_row()</strong>
   * <strong>pg_fetch_object()</strong>
   * <strong>pg_fetch_result()</strong>


id: pg_fetch_assoc
type: function
doc:
<comment>Description:</comment>
  行を連想配列として取得する
  
  <strong>pg_fetch_assoc()</strong> は、取得した行（レコード）を 保持する連想配列を返します。
  
  <strong>pg_fetch_assoc()</strong> は、オプションの第 3 パラメータに <info>PGSQL_ASSOC</info> を指定して <strong>pg_fetch_array()</strong> をコー
  ルするのと同じです。連想配列のみを返します。もし数値添字の配列が 必要な場合は <strong>pg_fetch_row()</strong> を使
  用してください。
  
  この関数は、
  NULL フィールドに PHPの <info>null</info> 値を設定します。
  
  <strong>pg_fetch_assoc()</strong> は、 <strong>pg_fetch_row()</strong> に比べてきわめて遅いというわけでは 「ありません」。そして、き
  わめて簡単に使用できます。

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>  <strong>pg_query()</strong>、<strong>pg_query_params()</strong> や (様々な関数がありますが、特に)
                         <strong>pg_execute()</strong> が返した <class>PgSql\Result</class> クラスのインスタンス。
  <info>int|null</info>      <strong>$row</strong>     取得する行番号。最初の行は 0 です。省略したり <info>null</info> を指定したりした場合は、
                         次の行を取得します。

<comment>Return:</comment>
  <info>array|false</info>  連想配列（フィールド名をキーとする）を返します。 配列の各要素の値は文字列です。 デー
               タベースの <return>NULL</return> 値は、<info>null</info> として返します。
               
               <strong>$row</strong> が結果の行数より大きい場合、行が存在しない場合、 そしてそれ以外のエラーが発生し
               た場合は <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>pg_fetch_row()</strong>
   * <strong>pg_fetch_array()</strong>
   * <strong>pg_fetch_object()</strong>
   * <strong>pg_fetch_result()</strong>


id: pg_fetch_object
type: function
doc:
<comment>Description:</comment>
  行をオブジェクトとして得る
  
  <strong>pg_fetch_object()</strong> は、取得した行のフィールド名に 対応するプロパティを有するオブジェクトを返しま
  す。オプションとして、 指定したクラスのコンストラクタにパラメータを渡してインスタンス化する ことも
  可能です。
  
  この関数は、
  NULL フィールドに PHPの <info>null</info> 値を設定します。
  
  速度面では、この関数は <strong>pg_fetch_array()</strong> と同じであり、 <strong>pg_fetch_row()</strong> とほとんど同じ程度です （違
  いはわずかです）。

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>            <strong>pg_query()</strong>、<strong>pg_query_params()</strong> や (様々な関数がありますが、特に)
                                   <strong>pg_execute()</strong> が返した <class>PgSql\Result</class> クラスのインスタンス。
  <info>int|null</info>      <strong>$row</strong>               取得する行番号。最初の行は 0 です。省略したり <info>null</info> を指定したりし
                                   た場合は、 次の行を取得します。
  <info>string</info>        <strong>$class</strong>             インスタンス化し、プロパティを設定して戻り値とするクラスの名前。
                                   指定しない場合は <class>stdClass</class> オブジェクトが返されます。
  <info>array</info>         <strong>$constructor_args</strong>  <strong>$class</strong> オブジェクトのコンストラクタに 渡すオプションの配列。

<comment>Return:</comment>
  <info>object|false</info>  結果の各フィールドに対応する属性を持つ <info>object</info> を返します。 データベースの <return>NULL</return> 値は
                <info>null</info> として返します。
                
                <strong>$row</strong> が結果の行数より大きい場合・行が存在しない場合 、そしてそれ以外のエラーが発生し
                た場合は <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>pg_query()</strong>
   * <strong>pg_fetch_array()</strong>
   * <strong>pg_fetch_assoc()</strong>
   * <strong>pg_fetch_row()</strong>
   * <strong>pg_fetch_result()</strong>


id: pg_fetch_result
type: function
doc:
<comment>Description:</comment>
  結果インスタンスから値を返す
  
  <strong>pg_fetch_result()</strong> は、 <class>PgSql\Result</class> クラスのインスタンスから 特定の行とフィールド（カラム）の値を
  返します。
  
  この関数は、以前は <strong>pg_result()</strong> という名前でした。

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>  <strong>pg_query()</strong>、<strong>pg_query_params()</strong> や (様々な関数がありますが、特に)
                         <strong>pg_execute()</strong> が返した <class>PgSql\Result</class> クラスのインスタンス。
  <info>int</info>           <strong>$row</strong>     結果から取得する行の番号。行番号は 0 から始まります。指定しなかった 場合
                         は、次の行が読み込まれます。
  <info>mixed</info>         <strong>$field</strong>   取得するフィールド（カラム）の名前を表す文字列、あるいは取得する フィールド
                         の番号。フィールド番号は 0 から始まります。

<comment>Return:</comment>
  <info>string|false|null</info>  論理型の値は "t" あるいは "f" の形式で返します。 配列を含むそれ以外の型は、
                     PostgreSQL のやりかたにしたがって文字列として フォーマットされた形式で返しま
                     す。これは psql プログラムの出力と同じ形式です。データベースの <return>NULL</return> 値は、<info>null</info>
                     として返します。
                     
                     <strong>$row</strong> が結果の行数より大きい場合、 あるいはそれ以外のエラーが発生した場合は
                     <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>pg_query()</strong>
   * <strong>pg_fetch_array()</strong>


id: pg_fetch_row
type: function
doc:
<comment>Description:</comment>
  数値添字の配列として行を得る
  
  <strong>pg_fetch_row()</strong> は、 指定した <strong>$result</strong> インスタンスが指す結果から 1 行分のデータを取得します。
  
  この関数は、
  NULL フィールドに PHPの <info>null</info> 値を設定します。

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>  <strong>pg_query()</strong>、<strong>pg_query_params()</strong> や (様々な関数がありますが、特に)
                         <strong>pg_execute()</strong> が返した <class>PgSql\Result</class> クラスのインスタンス。
  <info>int|null</info>      <strong>$row</strong>     取得する行番号。最初の行は 0 です。省略したり <info>null</info> を指定したりした場合は、
                         次の行を取得します。
  <info>int</info>           <strong>$mode</strong>    返される配列のインデックスを制御するオプションの引数です。
                         <strong>$mode</strong> は定数で、以下の値を取ることができます。:
                         <info>PGSQL_ASSOC</info>, <info>PGSQL_NUM</info>, <info>PGSQL_BOTH</info>。
                         <info>PGSQL_NUM</info> を使うと、配列のインデックスを数値にした配列を返します。
                         <info>PGSQL_ASSOC</info> を使うと、連想配列のインデックスを返します。<info>PGSQL_BOTH</info> を指定す
                         ると、数値と連想配列のインデックスを両方含めた形で配列を返します。

<comment>Return:</comment>
  <info>array|false</info>  個々の値を文字列として格納した配列を返します。配列の添字は 0 から 始まります。データ
               ベースの <return>NULL</return> 値は <info>null</info> として返します。
               
               <strong>$row</strong> が結果の行数より大きい場合・行が存在しない場合 、そしてそれ以外のエラーが発生し
               た場合は <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>pg_query()</strong>
   * <strong>pg_fetch_array()</strong>
   * <strong>pg_fetch_object()</strong>
   * <strong>pg_fetch_result()</strong>


id: pg_field_is_null
type: function
doc:
<comment>Description:</comment>
  フィールドが SQL の NULL かどうか調べる
  
  <strong>pg_field_is_null()</strong> は、 <class>PgSql\Result</class> クラスのインスタンスの フィールドが SQL の <return>NULL</return> であるかどう
  かを調べます。
  
  この関数は、以前は <strong>pg_fieldisnull()</strong> と呼ばれていました。

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>  <strong>pg_query()</strong>、<strong>pg_query_params()</strong> や (様々な関数がありますが、特に)
                         <strong>pg_execute()</strong> が返した <class>PgSql\Result</class> クラスのインスタンス。
  <info>int</info>           <strong>$row</strong>     取得する結果の行番号。行番号は 0 から始まります。指定しなかった場合は カレ
                         ントの行を取得します。
  <info>mixed</info>         <strong>$field</strong>   （0 から始まる）フィールド番号を表す数値、 あるいはフィールド名を表す文字
                         列。

<comment>Return:</comment>
  <info>int</info>  指定した行のフィールドが SQL の <return>NULL</return> だった場合に <return>1</return>、そうでない場合に <return>0</return> を返します。 もし範囲
       外の行を指定したりその他のエラーが発生したりした場合には <info>false</info> を返します。


id: pg_field_name
type: function
doc:
<comment>Description:</comment>
  フィールドの名前を返す
  
  <strong>pg_field_name()</strong> は、 指定した <strong>$result</strong> インスタンスの指定した <strong>$field</strong> にあるフィールドの名前を 返し
  ます。フィールド番号は 0 から始まります。
  
  この関数は、以前は <strong>pg_fieldname()</strong> と呼ばれていました。

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>  <strong>pg_query()</strong>、<strong>pg_query_params()</strong> や (様々な関数がありますが、特に)
                         <strong>pg_execute()</strong> が返した <class>PgSql\Result</class> クラスのインスタンス。
  <info>int</info>           <strong>$field</strong>   フィールド番号。0 から始まります。

<comment>Return:</comment>
  <info>string</info>  フィールド名を返します。

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


id: pg_field_num
type: function
doc:
<comment>Description:</comment>
  指定されたフィールドのフィールド番号を返す
  
  <strong>pg_field_num()</strong> は、 指定した結果 (<strong>$result</strong>) インスタンスにおいて <strong>$field</strong> に相当するカラム(フィール
  ド) のフィールド番号を返します。
  
  この関数は、以前は <strong>pg_fieldnum()</strong> と呼ばれていました。

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>  <strong>pg_query()</strong>、<strong>pg_query_params()</strong> や (様々な関数がありますが、特に)
                         <strong>pg_execute()</strong> が返した <class>PgSql\Result</class> クラスのインスタンス。
  <info>string</info>        <strong>$field</strong>   フィールドの名前。 ここで指定された名前は、SQL コマンド内の識別子として扱わ
                         れます。 つまり、ダブルクォートで囲まれない限り小文字に変換されます。

<comment>Return:</comment>
  <info>int</info>  フィールド番号（0 から始まります）を返します。エラー時には -1 を返します。

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


id: pg_field_prtlen
type: function
doc:
<comment>Description:</comment>
  表示される長さを返す
  
  <strong>pg_field_prtlen()</strong> は、 <strong>$result</strong> で指定した値に関して、実際に 表示した場合の長さ(文字の数)を返しま
  す。行番号(row_number)は 0 から始まります。この関数は、エラーの場合に <info>false</info> を返します。
  
  <strong>$field_name_or_number</strong> は、<info>int</info> または <info>string</info> のどちらかで渡すことが可能です。 <info>int</info> で渡された場合、
  PHP はそれをフィールド番号と判断 します。それ以外の場合はフィールド名と判断します。
  
  <strong>pg_field_name()</strong> ページの例を参照ください。
  
  この関数は、以前は <strong>pg_fieldprtlen()</strong> と呼ばれていました。

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>  <strong>pg_query()</strong>、<strong>pg_query_params()</strong> や (様々な関数がありますが、特に)
                         <strong>pg_execute()</strong> が返した <class>PgSql\Result</class> クラスのインスタンス。
  <info></info>              <strong>$row</strong>     結果の行番号。行番号は 0 から始まります。指定しなかった場合は カレントの行
                         を取得します。

<comment>Return:</comment>
  <info>int</info>  フィールドの表示される長さを返します。

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


id: pg_field_size
type: function
doc:
<comment>Description:</comment>
  指定したフィールドの内部記憶領域におけるサイズを返す
    
  
  <strong>pg_field_size()</strong> は、指定した PostgreSQL の 結果において、指定したフィールド番号の内部記憶領域のサ
  イズを (バイト数で)返します。
  
  この関数は、以前は <strong>pg_fieldsize()</strong> と呼ばれていました。

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>  <strong>pg_query()</strong>、<strong>pg_query_params()</strong> や (様々な関数がありますが、特に)
                         <strong>pg_execute()</strong> が返した <class>PgSql\Result</class> クラスのインスタンス。
  <info>int</info>           <strong>$field</strong>   フィールド番号。0 から始まります。

<comment>Return:</comment>
  <info>int</info>  内部記憶領域のサイズ（バイト数）を返します。-1 は可変長フィールドを 示します。

<comment>See Also:</comment>
   * <strong>pg_field_prtlen()</strong>
   * <strong>pg_field_type()</strong>


id: pg_field_table
type: function
doc:
<comment>Description:</comment>
  tables フィールドの名前あるいは oid を返す
  
  <strong>pg_field_table()</strong> は、フィールドが属するテーブルの名前か あるいは <strong>$oid_only</strong> が <info>true</info> の場合にテーブ
  ルの oid を返します。

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>    <strong>pg_query()</strong>、<strong>pg_query_params()</strong> や (様々な関数がありますが、特に)
                           <strong>pg_execute()</strong> が返した <class>PgSql\Result</class> クラスのインスタンス。
  <info>int</info>           <strong>$field</strong>     0 から始まるフィールド番号。
  <info>bool</info>          <strong>$oid_only</strong>  デフォルトでは、フィールドが属するテーブルの名前が返されます。 しかし
                           <strong>$oid_only</strong> を<info>true</info> に設定すると、 その代わりに oid が返されます。

<comment>Return:</comment>
  <info>string|int|false</info>  成功した場合にフィールドのテーブル名あるいは oid を返します。 失敗した場合に
                    <info>false</info> を返します

<comment>See Also:</comment>
   * <strong>pg_field_name()</strong>
   * <strong>pg_field_type()</strong>


id: pg_field_type
type: function
doc:
<comment>Description:</comment>
  フィールド番号に対応する型名を返す
    
  
  <strong>pg_field_type()</strong> は、指定した <strong>$result</strong> インスタンスにおいて、指定した <strong>$field</strong> の型名を保持する文字列
  を 返します。
  
  フィールドが（基本型ではなく）PostgreSQL ドメインを使用している場合は、 ドメインそのものの名前では
  なくドメインの元となっている型の名前を返します。
  
  この関数は、以前は <strong>pg_fieldtype()</strong> と呼ばれていました。

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>  <strong>pg_query()</strong>、<strong>pg_query_params()</strong> や (様々な関数がありますが、特に)
                         <strong>pg_execute()</strong> が返した <class>PgSql\Result</class> クラスのインスタンス。
  <info>int</info>           <strong>$field</strong>   フィールド番号。0 から始まります。

<comment>Return:</comment>
  <info>string</info>  フィールド型の名前を文字列で返します。

<comment>See Also:</comment>
   * <strong>pg_field_prtlen()</strong>
   * <strong>pg_field_name()</strong>
   * <strong>pg_field_type_oid()</strong>


id: pg_field_type_oid
type: function
doc:
<comment>Description:</comment>
  フィールド番号に対応する型 ID（OID）を返す
    
  
  <strong>pg_field_type_oid()</strong> は、指定した <strong>$result</strong> インスタンスにおける指定した <strong>$field</strong> の型の OID を返しま
  す。
  
  フィールド型についての詳細な情報を得るには、PostgreSQL のシステムテーブル <return>pg_type</return> に対して、この関
  数で取得した OID を用いて 問い合わせます。PostgreSQL の <strong>format_type()</strong> 関数は、 型の OID を SQL の
  型名に変換します。
  
  フィールドが（基本型ではなく）PostgreSQL ドメインを使用している場合は、 ドメインそのものの OID で
  はなくドメインの元となっている型の OID を返します。

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>  <strong>pg_query()</strong>、<strong>pg_query_params()</strong> や (様々な関数がありますが、特に)
                         <strong>pg_execute()</strong> が返した <class>PgSql\Result</class> クラスのインスタンス。
  <info>int</info>           <strong>$field</strong>   フィールド番号。0 から始まります。

<comment>Return:</comment>
  <info>string|int</info>  フィールドの型に対応する OID を返します。

<comment>See Also:</comment>
   * <strong>pg_field_type()</strong>
   * <strong>pg_field_prtlen()</strong>
   * <strong>pg_field_name()</strong>


id: pg_flush
type: function
doc:
<comment>Description:</comment>
  送信を待っているクエリデータをフラッシュする
  
  <strong>pg_flush()</strong> は、送信を待機中のすべての クエリデータを接続へフラッシュします。

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

<comment>Return:</comment>
  <info>int|bool</info>  フラッシュが成功したか、またはフラッシュを待機中のデータがなかった場合 <info>true</info>、 保留中の
            データの一部がフラッシュされたが、まだ残りがある場合、<return>0</return>。 失敗した場合に <info>false</info> を返しま
            す


id: pg_free_result
type: function
doc:
<comment>Description:</comment>
  クエリ結果のメモリを開放する
  
  <strong>pg_free_result()</strong> は、指定された クエリ結果 <class>PgSql\Result</class> インスタンスに関するメモリとデータを開放し
  ます。
  
  この関数は、スクリプト実行中のメモリ使用量を抑制したい場合にのみ コールする必要があります。それ以
  外の場合は、すべての結果保持用 メモリは、スクリプトが終了する際に自動的に開放されます。
  
  この関数は、以前は <strong>pg_freeresult()</strong> と呼ばれていました。

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>  <strong>pg_query()</strong>、<strong>pg_query_params()</strong> や (様々な関数がありますが、特に)
                         <strong>pg_execute()</strong> が返した <class>PgSql\Result</class> クラスのインスタンス。

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

<comment>See Also:</comment>
   * <strong>pg_query()</strong>
   * <strong>pg_query_params()</strong>
   * <strong>pg_execute()</strong>


id: pg_get_notify
type: function
doc:
<comment>Description:</comment>
  SQL NOTIFY メッセージを取得する
  
  <strong>pg_get_notify()</strong>は、<return>NOTIFY</return> SQL コマンドにより送信された通知メッセージを取得します。 通知メッセージ
  を取得するには、<return>LISTEN</return> SQL コマンドを発行する必要があります。

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  <class>PgSql\Connection</class> クラスのインスタンス。
  <info>int</info>               <strong>$mode</strong>        返される配列のインデックスを制御するオプションの引数です。
                                 <strong>$mode</strong> は定数で、以下の値を取ることができます。:
                                 <info>PGSQL_ASSOC</info>, <info>PGSQL_NUM</info>, <info>PGSQL_BOTH</info>。
                                 <info>PGSQL_NUM</info> を使うと、配列のインデックスを数値にした配列を返します。
                                 <info>PGSQL_ASSOC</info> を使うと、連想配列のインデックスを返します。<info>PGSQL_BOTH</info>
                                 を指定すると、数値と連想配列のインデックスを両方含めた形で配列を返
                                 します。

<comment>Return:</comment>
  <info>array|false</info>  <return>NOTIFY</return> メッセージ名とバックエンドの PID を含む 配列を返します。 サーバーでサポートさ
               れている場合は、 配列にはサーバーのバージョンおよびペイロードも含まれます。 もし待ち
               受ける <return>NOTIFY</return> が存在しない場合は、 <info>false</info> を返します。

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


id: pg_get_pid
type: function
doc:
<comment>Description:</comment>
  バックエンドのプロセス ID を得る
  
  <strong>pg_get_pid()</strong> は、バックエンド(データベースサーバ のプロセス)のプロセス ID を取得します。プロセス
  ID は、 <return>NOTIFY</return> メッセージが他のプロセスから送信されている かどうかを調べるために有用です。

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

<comment>Return:</comment>
  <info>int</info>  バックエンドのデータベースのプロセス ID 。

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


id: pg_get_result
type: function
doc:
<comment>Description:</comment>
  非同期クエリの結果を取得する
    
  
  <strong>pg_get_result()</strong> は、 <strong>pg_send_query()</strong>, <strong>pg_send_query_params()</strong> あるいは <strong>pg_send_execute()</strong> で実行した
  非同期クエリから <class>PgSql\Result</class> クラスのインスタンスを取得します。
  
  <strong>pg_send_query()</strong> およびその他の非同期クエリ関数は、 複数のクエリを PostgreSQL サーバーに送信するこ
  とが可能です。クエリの結果を ひとつずつ取得するには、<strong>pg_get_result()</strong> を使用します。

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

<comment>Return:</comment>
  <info>PgSql\Result|false</info>  <class>PgSql\Result</class> クラスのインスタンスを返します。 結果がもうない場合に <info>false</info> を返
                      します。

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


id: pg_host
type: function
doc:
<comment>Description:</comment>
  接続に関連するホスト名を返す
    
  
  <strong>pg_host()</strong> は、指定した <strong>$connection</strong> インスタンスが接続しているホストの 名前を返します。

<comment>Param:</comment>
  <info>PgSql\Connection|null</info>  <strong>$connection</strong>  <class>PgSql\Connection</class> クラスのインスタンス。
                                      <strong>$connection</strong> が <info>null</info>, の場合、デフォルトの接続を使います。
                                      デフォルトの接続とは、<strong>pg_connect()</strong> または <strong>pg_pconnect()</strong> によっ
                                      て確立された直近の接続です。
                                      PHP 8.1.0 以降では、デフォルトの接続を使うことは推奨されなくな
                                      りました。
                                      
                                      PHP 8.1.0 以降では、デフォルトの接続を使うことは推奨されなくな
                                      りました。

<comment>Return:</comment>
  <info>string</info>  <strong>$connection</strong> が接続しているホストの名前を 文字列で返します。エラー時には空の文字列を返しま
          す。

<comment>See Also:</comment>
   * <strong>pg_connect()</strong>
   * <strong>pg_pconnect()</strong>


id: pg_insert
type: function
doc:
<comment>Description:</comment>
  テーブルに配列を挿入する
    
  
  <strong>pg_insert()</strong> は、 <strong>$table_name</strong> で指定したテーブルに <strong>$values</strong> の値をを挿入します。
  
  <strong>$flags</strong> が指定されている場合、そのオプションと ともに <strong>pg_convert()</strong> が <strong>$values</strong> に適用されます。
  
  デフォルトでは、 <strong>pg_insert()</strong> は生の値を渡します。 値はエスケープするか、 <strong>$flags</strong> に
  <info>PGSQL_DML_ESCAPE</info> オプションを指定しなければいけません。 <info>PGSQL_DML_ESCAPE</info> はパラメータや識別子を
  クォートし、 エスケープします。 よって、テーブル/カラム名は大文字小文字を区別します。
  
  エスケープやプリペアドクエリであっても、 LIKE, JSON, Array, Regex などのクエリを守れない可能性があ
  ることに注意してください。 これらのパラメータはコンテクストに応じて処理されるべきです。 たとえば、
  値をエスケープ/検証する処理を行うことなどです。

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  <class>PgSql\Connection</class> クラスのインスタンス。
  <info>string</info>            <strong>$table_name</strong>  行を挿入するテーブルの名前。テーブル <strong>$table_name</strong> は、少なくとも
                                 <strong>$values</strong> の要素数ぶんのカラムを 保持している必要があります。
  <info>array</info>             <strong>$values</strong>      テーブル <strong>$table_name</strong> のフィールド名をキーに、 挿入する内容を値にも
                                 つ配列。
  <info>int</info>               <strong>$flags</strong>       <info>PGSQL_CONV_OPTS</info>、 <info>PGSQL_DML_NO_CONV</info>、 <info>PGSQL_DML_ESCAPE</info>、
                                 <info>PGSQL_DML_EXEC</info>、 <info>PGSQL_DML_ASYNC</info> あるいは <info>PGSQL_DML_STRING</info> を組み合
                                 わせた数。 <info>PGSQL_DML_STRING</info> が <strong>$flags</strong> に含まれていた場合、 クエリ文
                                 字列が返されます。 <info>PGSQL_DML_NO_CONV</info> あるいは <info>PGSQL_DML_ESCAPE</info> が設
                                 定されている場合は、内部的に <strong>pg_convert()</strong> を呼びません。

<comment>Return:</comment>
  <info>PgSql\Result|string|bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。 <strong>$flags</strong> で
                            <info>PGSQL_DML_STRING</info> が渡された場合は、成功時に文字列を返します。

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


id: pg_last_error
type: function
doc:
<comment>Description:</comment>
  特定の接続から直近のエラーメッセージ文字列を取得する
  
  <strong>pg_last_error()</strong> は、指定した <strong>$connection</strong> から直近のエラーメッセージを返します。
  
  エラーメッセージは、内部的な PostgreSQL(libpq) 関数コールにより 上書きされる可能性があります。
  PostgreSQL モジュール関数の中で複数の エラーが発生した場合には、この関数は適切なエラーメッセージを
  返さない 可能性があります。
  
  エラー処理を改善するために <strong>pg_result_error()</strong>、<strong>pg_result_error_field()</strong>、 <strong>pg_result_status()</strong> および
  <strong>pg_connection_status()</strong> を使用ください。
  
  この関数は、以前は <strong>pg_errormessage()</strong> と呼ばれていました。

<comment>Param:</comment>
  <info>PgSql\Connection|null</info>  <strong>$connection</strong>  <class>PgSql\Connection</class> クラスのインスタンス。
                                      <strong>$connection</strong> が <info>null</info>, の場合、デフォルトの接続を使います。
                                      デフォルトの接続とは、<strong>pg_connect()</strong> または <strong>pg_pconnect()</strong> によっ
                                      て確立された直近の接続です。
                                      PHP 8.1.0 以降では、デフォルトの接続を使うことは推奨されなくな
                                      りました。
                                      
                                      PHP 8.1.0 以降では、デフォルトの接続を使うことは推奨されなくな
                                      りました。

<comment>Return:</comment>
  <info>string</info>  指定した <strong>$connection</strong> の直近のエラーメッセージを 含む文字列を返します。

<comment>See Also:</comment>
   * <strong>pg_result_error()</strong>
   * <strong>pg_result_error_field()</strong>


id: pg_last_notice
type: function
doc:
<comment>Description:</comment>
  PostgreSQL サーバーからの直近の通知メッセージを返す
    
  
  <strong>pg_last_notice()</strong> は、<strong>$connection</strong> で指定した PostgreSQL サーバーからの直近の通知メッセージを返しま
  す。 たとえば、テーブルに <return>SERIAL</return> カラムを作成する場合などに PostgreSQL サーバーは通知メッセージを
  送信します。
  
  <strong>pg_last_notice()</strong> でトランザクションに関連する通知 メッセージがあるかないかをチェックすることで、無
  意味なクエリの発行を 避けることが可能です。
  
  php.ini で <return>pgsql.ignore_notice</return> に 1 を指定することで、通知メッセージの追跡をしないようにすることが
  可能です。
  
  php.ini で <return>pgsql.log_notice</return> に 0 を指定することで、通知メッセージをログに記録しないようにすること
  が可能です。 <return>pgsql.ignore_notice</return> が 0 に設定されていない限り、 通知メッセージをログに記録すること
  はできません。

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  <class>PgSql\Connection</class> クラスのインスタンス。
  <info>int</info>               <strong>$mode</strong>        直近の通知を返す <info>PGSQL_NOTICE_LAST</info>、 すべての通知を返す
                                 <info>PGSQL_NOTICE_ALL</info>、 または通知をクリアする <info>PGSQL_NOTICE_CLEAR</info> のいず
                                 れか

<comment>Return:</comment>
  <info>array|string|bool</info>  <info>PGSQL_NOTICE_LAST</info> 使用時は、 指定された <strong>$connection</strong> の直近の通知を含む <info>string</info>、
                     <info>PGSQL_NOTICE_ALL</info> 使用時は <info>array</info>、 <info>PGSQL_NOTICE_CLEAR</info> 使用時は <info>bool</info> を返します。

<comment>See Also:</comment>
   * <strong>pg_query()</strong>
   * <strong>pg_last_error()</strong>


id: pg_last_oid
type: function
doc:
<comment>Description:</comment>
  直近の行のオブジェクト ID を返す
  
  <strong>pg_last_oid()</strong> は、挿入された行に割り当てられた OID を取得します。
  
  OID フィールドは PostgreSQL 7.2 からはオプションとなり、 PostgreSQL 8.1 ではデフォルトで存在しませ
  ん。OID フィールドが テーブルに存在しない場合、プログラマは <strong>pg_result_status()</strong> を使用して挿入が成
  功したことを 確かめる必要があります。
  
  挿入された行の <return>SERIAL</return> フィールドの値を取得するには、 PostgreSQL の <return>CURRVAL</return> 関数を使用してシーケン
  ス内で 直近に要求された値を取得する必要があります。シーケンス名がわからない 場合は、PostgreSQL 8.0
  の関数 <return>pg_get_serial_sequence</return> が必要になります。
  
  PostgreSQL 8.1 には <return>LASTVAL</return> 関数が存在し、セッション内で 直近に使用されたシーケンスの値を返しま
  す。これを用いれば、シーケンスや テーブルやカラムの名前を指定する必要がなくなります。
  
  この関数は、以前は <strong>pg_getlastoid()</strong> と呼ばれていました。

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>  <strong>pg_query()</strong>、<strong>pg_query_params()</strong> や (様々な関数がありますが、特に)
                         <strong>pg_execute()</strong> が返した <class>PgSql\Result</class> クラスのインスタンス。

<comment>Return:</comment>
  <info>string|int|false</info>  指定された <strong>$connection</strong> で、直近に挿入された行に 割り当てられた OID を数値または
                    文字列で返します。エラー時や有効な OID のない場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>pg_query()</strong>
   * <strong>pg_result_status()</strong>


id: pg_lo_close
type: function
doc:
<comment>Description:</comment>
  ラージオブジェクトをクローズする
  
  <strong>pg_lo_close()</strong> はラージオブジェクトをクローズします。
  
  ラージオブジェクトインターフェイスは、トランザクションブロックの中で 使用する必要があります。
  
  この関数は、かつて <strong>pg_loclose()</strong> という名前でした。

<comment>Param:</comment>
  <info>PgSql\Lob</info>  <strong>$lob</strong>  <strong>pg_lo_open()</strong> が返した <class>PgSql\Lob</class> クラスのインスタンス。

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

<comment>See Also:</comment>
   * <strong>pg_lo_open()</strong>
   * <strong>pg_lo_create()</strong>
   * <strong>pg_lo_import()</strong>


id: pg_lo_create
type: function
doc:
<comment>Description:</comment>
  ラージオブジェクトを生成する
  
  <strong>pg_lo_create()</strong> はラージオブジェクトを 生成し、そのラージオブジェクトの OID を返します。 PostgreSQL
  アクセスモード <info>INV_READ</info>、<info>INV_WRITE</info> および <info>INV_ARCHIVE</info> はサポートされません。オブジェクトは 常に読
  み書き可のアクセス権で生成されます。 <info>INV_ARCHIVE</info> は PostgreSQL 自身からも削除されました （バージョ
  ン 6.3 以降）。
  
  ラージオブジェクトインターフェイスは、トランザクションブロックの中で 使用する必要があります。
  
  ラージオブジェクトインターフェイス（アクセス制御もできないし使用が面倒） を使用するかわりに、
  PostgreSQL の bytea カラム型と <strong>pg_escape_bytea()</strong> を試してください。
  
  この関数は、以前は <strong>pg_locreate()</strong> と呼ばれていました。

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  <class>PgSql\Connection</class> クラスのインスタンス。
                                 <strong>$connection</strong> が指定されない場合は、デフォルトの接続を使います。
                                 デフォルトの接続とは、<strong>pg_connect()</strong> または <strong>pg_pconnect()</strong> によって確
                                 立された直近の接続です。
                                 PHP 8.1.0 以降では、デフォルトの接続を使うことは推奨されなくなりま
                                 した。
                                 
                                 PHP 8.1.0 以降では、デフォルトの接続を使うことは推奨されなくなりま
                                 した。
  <info>mixed</info>             <strong>$object_id</strong>   <strong>$object_id</strong> が指定されると、 この関数は指定された ID のラージオブ
                                 ジェクトを作成しようとします。 それ以外の場合は、サーバーから割り当
                                 てられたオブジェクト ID を使用します。 このパラメータは PostgreSQL
                                 8.1 以降の新機能に依存しています。

<comment>Return:</comment>
  <info>int</info>  ラージオブジェクトの OID を返します。 失敗した場合に <info>false</info> を返します


id: pg_lo_export
type: function
doc:
<comment>Description:</comment>
  ラージオブジェクトをファイルにエクスポートする
  
  <strong>pg_lo_export()</strong> は PostgreSQL データベースから ラージオブジェクトを取得し、その内容をローカルファイ
  ルシステム上の ファイルに保存します。
  
  ラージオブジェクトインターフェイスは、トランザクションブロックの中で 使用する必要があります。
  
  この関数は、以前は <strong>pg_loexport()</strong> と呼ばれていました。

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  <class>PgSql\Connection</class> クラスのインスタンス。
                                 <strong>$connection</strong> が指定されない場合は、デフォルトの接続を使います。
                                 デフォルトの接続とは、<strong>pg_connect()</strong> または <strong>pg_pconnect()</strong> によって確
                                 立された直近の接続です。
                                 PHP 8.1.0 以降では、デフォルトの接続を使うことは推奨されなくなりま
                                 した。
                                 
                                 PHP 8.1.0 以降では、デフォルトの接続を使うことは推奨されなくなりま
                                 した。
  <info>int</info>               <strong>$oid</strong>         データベース内のラージオブジェクトの OID 。
  <info>string</info>            <strong>$pathname</strong>    ラージオブジェクトをクライアントのファイルシステムに書き込む際の フ
                                 ルパスとファイル名。

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

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


id: pg_lo_import
type: function
doc:
<comment>Description:</comment>
  ファイルからラージオブジェクトをインポートする
  
  <strong>pg_lo_import()</strong> は、ファイルシステム上のファイルの データをもとにして新しいラージオブジェクトをデー
  タベース内に作成します。
  
  ラージオブジェクトインターフェイスは、トランザクションブロックの中で 使用する必要があります。
  
  この関数は、以前は <strong>pg_loimport()</strong> と呼ばれていました。

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  <class>PgSql\Connection</class> クラスのインスタンス。
                                 <strong>$connection</strong> が指定されない場合は、デフォルトの接続を使います。
                                 デフォルトの接続とは、<strong>pg_connect()</strong> または <strong>pg_pconnect()</strong> によって確
                                 立された直近の接続です。
                                 PHP 8.1.0 以降では、デフォルトの接続を使うことは推奨されなくなりま
                                 した。
                                 
                                 PHP 8.1.0 以降では、デフォルトの接続を使うことは推奨されなくなりま
                                 した。
  <info>string</info>            <strong>$pathname</strong>    クライアントのファイルシステムからラージオブジェクト用データを 読み
                                 込む際のフルパスとファイル名。
  <info>mixed</info>             <strong>$object_id</strong>   <strong>$object_id</strong> が指定されると、 この関数は指定された ID のラージオブ
                                 ジェクトを作成しようとします。 それ以外の場合は、サーバーから割り当
                                 てられたオブジェクト ID を使用します。 このパラメータは PostgreSQL
                                 8.1 以降の新機能に依存しています。

<comment>Return:</comment>
  <info>int</info>  作成されたラージオブジェクトの OID を返します。 失敗した場合に <info>false</info> を返します

<comment>See Also:</comment>
   * <strong>pg_lo_export()</strong>
   * <strong>pg_lo_open()</strong>


id: pg_lo_open
type: function
doc:
<comment>Description:</comment>
  ラージオブジェクトをオープンする
  
  <strong>pg_lo_open()</strong> はデータベース内にラージオブジェクトを オープンし、それを操作するための <class>PgSql\Lob</class> ク
  ラスのインスタンスを返します。
  
  <class>PgSql\Lob</class> のインスタンスを閉じる前にデータベースへの接続を 閉じないでください。
  
  ラージオブジェクトインターフェイスは、トランザクションブロックの中で 使用する必要があります。
  
  この関数は、以前は <strong>pg_loopen()</strong> と呼ばれていました。

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  <class>PgSql\Connection</class> クラスのインスタンス。
                                 <strong>$connection</strong> が指定されない場合は、デフォルトの接続を使います。
                                 デフォルトの接続とは、<strong>pg_connect()</strong> または <strong>pg_pconnect()</strong> によって確
                                 立された直近の接続です。
                                 PHP 8.1.0 以降では、デフォルトの接続を使うことは推奨されなくなりま
                                 した。
                                 
                                 PHP 8.1.0 以降では、デフォルトの接続を使うことは推奨されなくなりま
                                 した。
  <info>int</info>               <strong>$oid</strong>         データベース内のラージオブジェクトの OID 。
  <info>string</info>            <strong>$mode</strong>        読み込み専用の "r"、書き込み専用の "w"、読み書き可能な "rw" のいず
                                 れか。

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

<comment>See Also:</comment>
   * <strong>pg_lo_close()</strong>
   * <strong>pg_lo_create()</strong>


id: pg_lo_read
type: function
doc:
<comment>Description:</comment>
  ラージオブジェクトを読み込む
  
  <strong>pg_lo_read()</strong>は、ラージオブジェクトから最大 <strong>$length</strong> バイト分読み込み、文字列として返します。
  
  ラージオブジェクトインターフェイスは、トランザクションブロックの中で 使用する必要があります。
  
  この関数は、以前は <strong>pg_loread()</strong> と呼ばれていました。

<comment>Param:</comment>
  <info>PgSql\Lob</info>  <strong>$lob</strong>     <strong>pg_lo_open()</strong> が返した <class>PgSql\Lob</class> クラスのインスタンス。
  <info>int</info>        <strong>$length</strong>  返すデータの最大バイト数（オプション）。

<comment>Return:</comment>
  <info>string|false</info>  ラージオブジェクトから <strong>$length</strong> バイトのデータを 文字列で返します。エラー時には <info>false</info>
                を返します。

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


id: pg_lo_read_all
type: function
doc:
<comment>Description:</comment>
  ラージオブジェクト全体を読み込みブラウザに直接送信する
    
  
  <strong>pg_lo_read_all()</strong> は、ラージオブジェクトを読み込み 未送信のヘッダを全て送信した後、ブラウザに直接
  ラージオブジェクトを 送信します。これは主に、イメージや音などのバイナリデータを送信するために 使用
  します。
  
  ラージオブジェクトインターフェイスは、トランザクションブロックの中で 使用する必要があります。
  
  この関数は、以前は <strong>pg_loreadall()</strong> と呼ばれていました。

<comment>Param:</comment>
  <info>PgSql\Lob</info>  <strong>$lob</strong>  <strong>pg_lo_open()</strong> が返した <class>PgSql\Lob</class> クラスのインスタンス。

<comment>Return:</comment>
  <info>int</info>  読み込んだバイト数を返します。

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


id: pg_lo_seek
type: function
doc:
<comment>Description:</comment>
  ラージオブジェクトの位置をシークする
    
  
  <strong>pg_lo_seek()</strong> は <class>PgSql\Lob</class> インスタンスの位置をシークします。
  
  ラージオブジェクトインターフェイスは、トランザクションブロックの中で 使用する必要があります。

<comment>Param:</comment>
  <info>PgSql\Lob</info>  <strong>$lob</strong>     <strong>pg_lo_open()</strong> が返した <class>PgSql\Lob</class> クラスのインスタンス。
  <info>int</info>        <strong>$offset</strong>  シークするバイト数。
  <info>int</info>        <strong>$whence</strong>  定数 <info>PGSQL_SEEK_SET</info>（オブジェクトの先頭からシークする）、 <info>PGSQL_SEEK_CUR</info>（カレ
                      ントの位置からシークする）、 あるいは <info>PGSQL_SEEK_END</info>（オブジェクトの最後から
                      シークする） の中のひとつ。

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

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


id: pg_lo_tell
type: function
doc:
<comment>Description:</comment>
  ラージオブジェクトのカレントのシーク位置を返す
    
  
  <strong>pg_lo_tell()</strong> は、ラージオブジェクトのカレントの位置 （先頭からのオフセット）を返します。
  
  ラージオブジェクトインターフェイスは、トランザクションブロックの中で 使用する必要があります。

<comment>Param:</comment>
  <info>PgSql\Lob</info>  <strong>$lob</strong>  <strong>pg_lo_open()</strong> が返した <class>PgSql\Lob</class> クラスのインスタンス。

<comment>Return:</comment>
  <info>int</info>  ラージオブジェクトの先頭からのカレントのシーク位置（バイト数）を返します。 エラーが発生した場
       合は、負の数を返します。

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


id: pg_lo_truncate
type: function
doc:
<comment>Description:</comment>
  ラージオブジェクトを切り詰める
    
  
  <strong>pg_lo_truncate()</strong> は、<class>PgSql\Lob</class> クラスのインスタンスを切り詰めます。
  
  ラージオブジェクトのインターフェイスを使うには、トランザクションブロックで囲む必要があります。

<comment>Param:</comment>
  <info>PgSql\Lob</info>  <strong>$lob</strong>   <strong>pg_lo_open()</strong> が返した <class>PgSql\Lob</class> クラスのインスタンス。
  <info>int</info>        <strong>$size</strong>  切り詰めるバイトサイズ

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

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


id: pg_lo_unlink
type: function
doc:
<comment>Description:</comment>
  ラージオブジェクトを削除する
  
  <strong>pg_lo_unlink()</strong>は、<strong>$oid</strong>で 関連付けられたラージオブジェクトを削除します。成功した場合に <info>true</info> を、失
  敗した場合に <info>false</info> を返します。
  
  ラージオブジェクトインターフェイスは、トランザクションブロックの中で 使用する必要があります。
  
  この関数は、以前は <strong>pg_lounlink()</strong> と呼ばれていました。

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  <class>PgSql\Connection</class> クラスのインスタンス。
                                 <strong>$connection</strong> が指定されない場合は、デフォルトの接続を使います。
                                 デフォルトの接続とは、<strong>pg_connect()</strong> または <strong>pg_pconnect()</strong> によって確
                                 立された直近の接続です。
                                 PHP 8.1.0 以降では、デフォルトの接続を使うことは推奨されなくなりま
                                 した。
                                 
                                 PHP 8.1.0 以降では、デフォルトの接続を使うことは推奨されなくなりま
                                 した。
  <info>int</info>               <strong>$oid</strong>         データベース内のラージオブジェクトの OID 。

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

<comment>See Also:</comment>
   * <strong>pg_lo_create()</strong>
   * <strong>pg_lo_import()</strong>


id: pg_lo_write
type: function
doc:
<comment>Description:</comment>
  ラージオブジェクトに書き込む
  
  <strong>pg_lo_write()</strong> は、ラージオブジェクトの カレントのシーク位置にデータを書き込みます。
  
  ラージオブジェクトインターフェイスは、トランザクションブロックの中で 使用する必要があります。
  
  この関数は、以前は <strong>pg_lowrite()</strong> と呼ばれていました。

<comment>Param:</comment>
  <info>PgSql\Lob</info>  <strong>$lob</strong>     <strong>pg_lo_open()</strong> が返した <class>PgSql\Lob</class> クラスのインスタンス。
  <info>string</info>     <strong>$data</strong>    ラージオブジェクトに書き込むデータ。<strong>$length</strong> が 数値で、かつ <strong>$data</strong> の長さより小
                      さく指定されている場合、 <strong>$length</strong> バイトのみが書き込まれます。
  <info>int|null</info>   <strong>$length</strong>  書き込むデータの最大バイト数（オプション）。0 より大きく、かつ <strong>$data</strong> のサイズ
                      以下でなければなりません。 デフォルトは <strong>$data</strong> の長さです。

<comment>Return:</comment>
  <info>int|false</info>  ラージオブジェクトに書き込んだバイト数を返します。 エラー時には <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>pg_lo_create()</strong>
   * <strong>pg_lo_open()</strong>


id: pg_meta_data
type: function
doc:
<comment>Description:</comment>
  テーブルからメタデータを取得する
    
  
  <strong>pg_meta_data()</strong> は、<return>table_name</return> のテーブル定義を配列として返します。

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  <class>PgSql\Connection</class> クラスのインスタンス。
  <info>string</info>            <strong>$table_name</strong>  テーブルの名前。
  <info>bool</info>              <strong>$extended</strong>    拡張メタデータを返すかどうかを表すフラグ。デフォルトは <info>false</info>。

<comment>Return:</comment>
  <info>array|false</info>  テーブル定義の配列を返します。 失敗した場合に <info>false</info> を返します

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


id: pg_num_fields
type: function
doc:
<comment>Description:</comment>
  フィールド数を返す
  
  <strong>pg_num_fields()</strong> は、 <class>PgSql\Result</class> クラスのインスタンスから フィールド（カラム）の数を返します。
  
  この関数は、以前は <strong>pg_numfields()</strong> と呼ばれていました。

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>  <strong>pg_query()</strong>、<strong>pg_query_params()</strong> や (様々な関数がありますが、特に)
                         <strong>pg_execute()</strong> が返した <class>PgSql\Result</class> クラスのインスタンス。

<comment>Return:</comment>
  <info>int</info>  結果のフィールド（カラム）数を返します。エラー時には -1 を返します。

<comment>See Also:</comment>
   * <strong>pg_num_rows()</strong>
   * <strong>pg_affected_rows()</strong>


id: pg_num_rows
type: function
doc:
<comment>Description:</comment>
  行数を返す
  
  <strong>pg_num_rows()</strong> は、 <class>PgSql\Result</class> クラスのインスタンスに含まれる行数を返します。
  
  この関数は、以前は <strong>pg_numrows()</strong> と呼ばれていました。

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>  <strong>pg_query()</strong>、<strong>pg_query_params()</strong> や (様々な関数がありますが、特に)
                         <strong>pg_execute()</strong> が返した <class>PgSql\Result</class> クラスのインスタンス。

<comment>Return:</comment>
  <info>int</info>  結果の行数を返します。エラー時には <return>-1</return> を返します。

<comment>See Also:</comment>
   * <strong>pg_num_fields()</strong>
   * <strong>pg_affected_rows()</strong>


id: pg_options
type: function
doc:
<comment>Description:</comment>
  接続に関連するオプションを取得する
  
  <strong>pg_options()</strong> は、指定した <strong>$connection</strong> インスタンスの オプションを保持する文字列を返します。

<comment>Param:</comment>
  <info>PgSql\Connection|null</info>  <strong>$connection</strong>  <class>PgSql\Connection</class> クラスのインスタンス。
                                      <strong>$connection</strong> が <info>null</info>, の場合、デフォルトの接続を使います。
                                      デフォルトの接続とは、<strong>pg_connect()</strong> または <strong>pg_pconnect()</strong> によっ
                                      て確立された直近の接続です。
                                      PHP 8.1.0 以降では、デフォルトの接続を使うことは推奨されなくな
                                      りました。
                                      
                                      PHP 8.1.0 以降では、デフォルトの接続を使うことは推奨されなくな
                                      りました。

<comment>Return:</comment>
  <info>string</info>  <strong>$connection</strong> のオプションを文字列で返します。

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


id: pg_parameter_status
type: function
doc:
<comment>Description:</comment>
  サーバーのパラメータ設定を検索する
  
  サーバーのパラメータ設定を検索します。
  
  いくつかのパラメータについては、接続の確立時や値の変更時にサーバーから 自動的に通知されます。
  <strong>pg_parameter_status()</strong> は これらの設定問い合わせるために使用可能です。指定したパラメータが存在する
  場合にその値を、存在しない場合に <info>false</info> を返します。
  
  PostgreSQL 8.0 で指定できるパラメータには以下が含まれます。 <return>server_version</return>、 <return>server_encoding</return>、
  <return>client_encoding</return>、 <return>is_superuser</return>、<return>session_authorization</return>、 <return>DateStyle</return>、<return>TimeZone</return> および
  <return>integer_datetimes</return> （<return>server_encoding</return>、<return>TimeZone</return> および <return>integer_datetimes</return> は 8.0 より前のバージョンで
  は指定できません）。 <return>server_version</return>、<return>server_encoding</return> および <return>integer_datetimes</return> は、PostgreSQL の稼
  動中には変更できないことに注意しましょう。
  
  PostgreSQL 7.3 以前のサーバーはパラメータ設定を通知する機能を持っていません。 しかし、
  <strong>pg_parameter_status()</strong> には <return>server_version</return> および <return>client_encoding</return> を取得する機能を組み込んでいま
  す。これらの値を取得するためにアプリケーションで アドホックなコードを書くのではなく、
  <strong>pg_parameter_status()</strong> を使用することを推奨します。
  
  7.4 より前の PostgreSQL サーバーでは、接続の確立後に <return>SET</return> を用いて <return>client_encoding</return> を変更しても
  <strong>pg_parameter_status()</strong> には反映されません。

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  <class>PgSql\Connection</class> クラスのインスタンス。
                                 <strong>$connection</strong> が指定されない場合は、デフォルトの接続を使います。
                                 デフォルトの接続とは、<strong>pg_connect()</strong> または <strong>pg_pconnect()</strong> によって確
                                 立された直近の接続です。
                                 PHP 8.1.0 以降では、デフォルトの接続を使うことは推奨されなくなりま
                                 した。
                                 
                                 PHP 8.1.0 以降では、デフォルトの接続を使うことは推奨されなくなりま
                                 した。
  <info>string</info>            <strong>$param_name</strong>  指定可能な <strong>$param_name</strong> には以下が含まれます。 <return>server_version</return>、
                                 <return>server_encoding</return>、<return>client_encoding</return>、 <return>is_superuser</return>、
                                 <return>session_authorization</return>、 <return>DateStyle</return>、<return>TimeZone</return> および
                                 <return>integer_datetimes</return>。 この値は、大文字小文字を区別するので注意して下
                                 さい。

<comment>Return:</comment>
  <info>string</info>  パラメータの値を文字列で返します。失敗した場合や <strong>$param_name</strong> が間違っている場合には <info>false</info>
          を返します。


id: pg_pconnect
type: function
doc:
<comment>Description:</comment>
  持続的な PostgreSQL 接続をオープンする
  
  <strong>pg_pconnect()</strong> は PostgreSQL への接続を オープンします。この関数は、他の PostgreSQL関数 が必要とす
  る <class>PgSql\Connection</class> クラスのインスタンスを返します。
  
  既存の接続と同じ <strong>$connection_string</strong> を用いて <strong>pg_pconnect()</strong> が 2 回目にコールされた場合は、 既存の
  接続を返します。ただし、<strong>$flags</strong> に <info>PGSQL_CONNECT_FORCE_NEW</info> を指定している場合は 除きます。
  
  持続的接続を有効にするには、php.ini のディレクティブ pgsql.allow_persistent を "On" に設定する必要
  があります（デフォルトは On です）。 持続的接続の最大数は php.ini ディレクティブ
  pgsql.max_persistent で設定可能です（デフォルトは制限無しを意味する -1 です）。 接続全体の数は
  php.ini ディレクティブ pgsql.max_links で設定可能です。
  
  <strong>pg_close()</strong> は、 <strong>pg_pconnect()</strong> によりオープンされた持続的接続は 閉じません。

<comment>Param:</comment>
  <info>string</info>  <strong>$connection_string</strong>  すべてデフォルトのパラメータを使用する場合には <strong>$connection_string</strong> を空
                              にすることが可能です。 または 1 つ以上のパラメータを空白で区切って指定
                              することも可能です。 個々のパラメータは <return>keyword = value</return> の形式で 設定
                              します。等号の前後の空白はあってもなくてもかまいません。 空の値や空白
                              を含む値を指定する場合は、その値をシングルクォートで 囲みます（例:
                              <return>keyword = 'a value'</return>）。値の中に シングルクォートやバックスラッシュが含
                              まれる場合は、それらを バックスラッシュでエスケープする必要があります
                              （例: \' および \\）。
                              
                              現在利用できるパラメータは以下のとおりです。 <strong>$host</strong>, <strong>$hostaddr</strong>, <strong>$port</strong>,
                              <strong>$dbname</strong>, <strong>$user</strong>, <strong>$password</strong>, <strong>$connect_timeout</strong>, <strong>$options</strong>, <strong>$tty</strong>（無視され
                              ます）, <strong>$sslmode</strong>, <strong>$requiressl</strong>（非推奨。代わりに <strong>$sslmode</strong> を推奨しま
                              す） および <strong>$service</strong> 。これらのうち実際にどの パラメータが使えるかは、
                              PostgreSQL のバージョンに依存します。
  <info>int</info>     <strong>$flags</strong>              <info>PGSQL_CONNECT_FORCE_NEW</info> が渡された場合は、 たとえ <strong>$connection_string</strong>
                              が既存の接続と まったく同一であっても新しい接続をオープンします。

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

<comment>See Also:</comment>
   * <strong>pg_connect()</strong>
   * 
     持続的データベース接続


id: pg_ping
type: function
doc:
<comment>Description:</comment>
  データベース接続を調べる
  
  <strong>pg_ping()</strong> はデータベース接続を調べ、その接続が 壊れている場合には再度接続を試みます。

<comment>Param:</comment>
  <info>PgSql\Connection|null</info>  <strong>$connection</strong>  <class>PgSql\Connection</class> クラスのインスタンス。
                                      <strong>$connection</strong> が <info>null</info>, の場合、デフォルトの接続を使います。
                                      デフォルトの接続とは、<strong>pg_connect()</strong> または <strong>pg_pconnect()</strong> によっ
                                      て確立された直近の接続です。
                                      PHP 8.1.0 以降では、デフォルトの接続を使うことは推奨されなくな
                                      りました。
                                      
                                      PHP 8.1.0 以降では、デフォルトの接続を使うことは推奨されなくな
                                      りました。

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

<comment>See Also:</comment>
   * <strong>pg_connection_status()</strong>
   * <strong>pg_connection_reset()</strong>


id: pg_port
type: function
doc:
<comment>Description:</comment>
  接続に関連するポート番号を返す
    
  
  <strong>pg_port()</strong> は、指定した <strong>$connection</strong> インスタンスが接続している ポートの番号を返します。

<comment>Param:</comment>
  <info>PgSql\Connection|null</info>  <strong>$connection</strong>  <class>PgSql\Connection</class> クラスのインスタンス。
                                      <strong>$connection</strong> が <info>null</info>, の場合、デフォルトの接続を使います。
                                      デフォルトの接続とは、<strong>pg_connect()</strong> または <strong>pg_pconnect()</strong> によっ
                                      て確立された直近の接続です。
                                      PHP 8.1.0 以降では、デフォルトの接続を使うことは推奨されなくな
                                      りました。
                                      
                                      PHP 8.1.0 以降では、デフォルトの接続を使うことは推奨されなくな
                                      りました。

<comment>Return:</comment>
  <info>string</info>  <strong>$connection</strong> が指しているデータベースのポート番号を文字列で返します。 エラー時には空文字列
          を返します。


id: pg_prepare
type: function
doc:
<comment>Description:</comment>
  指定したパラメータでプリペアドステートメントを作成するリクエストを
     送信し、その完了を待つ
    
  
  <strong>pg_prepare()</strong> は、 <strong>pg_execute()</strong> あるいは <strong>pg_send_execute()</strong> で後に実行するためのプリペアドステートメ
  ントを作成します。これにより、 繰り返し使用されるコマンドについての構文解析や実行計画作成が最初の
  一度だけですみます。<strong>pg_prepare()</strong> は PostgreSQL 7.4 以降の接続でのみ使用可能です。それ以前のバー
  ジョンでは失敗します。
  
  この関数は <strong>$stmtname</strong> という名前の プリペアドステートメントを <strong>$query</strong> 文字列から作成します。 この文
  字列には 1 つの SQL コマンドが含まれている必要があります。 <strong>$stmtname</strong> を "" にすることで無名ステー
  トメントを 作成することが可能で、既存の無名ステートメントは自動的に上書きされます。 それ以外の場
  合、もしカレントのセッションで既に定義済みのステートメント名を 使用した場合にはエラーとなります。
  パラメータを使用する際は、 <strong>$query</strong> 内で $1、$2 のような形式で参照されます。
  
  <strong>pg_prepare()</strong> で使用するプリペアドステートメントは、 SQLの <return>PREPARE</return> 文を実行することでも作成可能です
  （しかし、パラメータの型を事前に指定する必要がないという点で <strong>pg_prepare()</strong> のほうがより柔軟です）。
  また、PHP にはプリペアドステートメントを削除する関数がありませんが、 この目的のためには SQLの
  <return>DEALLOCATE</return> 文が使用可能です。

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  <class>PgSql\Connection</class> クラスのインスタンス。
                                 <strong>$connection</strong> が指定されない場合は、デフォルトの接続を使います。
                                 デフォルトの接続とは、<strong>pg_connect()</strong> または <strong>pg_pconnect()</strong> によって確
                                 立された直近の接続です。
                                 PHP 8.1.0 以降では、デフォルトの接続を使うことは推奨されなくなりま
                                 した。
                                 
                                 PHP 8.1.0 以降では、デフォルトの接続を使うことは推奨されなくなりま
                                 した。
  <info>string</info>            <strong>$stmtname</strong>    プリペアドステートメントにつける名前。接続内で一意である必要があり
                                 ます。 "" が指定された場合は無名ステートメントが作成され、以前に定
                                 義された 無名ステートメントを上書きします。
  <info>string</info>            <strong>$query</strong>       パラメータ化した SQL 文。ひとつの文のみである必要があります （複数
                                 の文をセミコロンで区切る形式は使用できません）。パラメータを 使用す
                                 る際は $1、$2 などの形式で参照されます。

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

<comment>See Also:</comment>
   * <strong>pg_execute()</strong>
   * <strong>pg_send_execute()</strong>


id: pg_put_line
type: function
doc:
<comment>Description:</comment>
  NULL で終わる文字列を PostgreSQL バックエンドに送信する
  
  <strong>pg_put_line()</strong> は、NULL で終わる文字列を PostgreSQL バックエンドサーバーに送信します。これは、
  PostgreSQL の <return>COPY FROM</return> コマンドとともに使用する場合に必要となります。
  
  <return>COPY</return> は、PostgreSQL によってサポートされている 高速なデータ読み込みインターフェイスです。データの
  内容はパースされず、 一度のトランザクションで実行されます。
  
  低レベルな <strong>pg_put_line()</strong> コマンドを用いない別の方法は、 <strong>pg_copy_from()</strong> を使用することです。これ
  は、はるかに シンプルなインターフェイスです。
  
  <strong>pg_end_copy()</strong> を実行する際には、送信データの最後に 明示的に "\." の 2 文字を送信する必要がありま
  す。これによって、 バックエンドに対してデータ送信の終了を通知します。
  
  <strong>pg_put_line()</strong> の使用は、<strong>pg_lo_read()</strong> や <strong>pg_lo_tell()</strong> などを含むラージオブジェクトの操作を 発生さ
  せ、これが失敗することもあります。そのような場合、かわりに <strong>pg_copy_from()</strong> および <strong>pg_copy_to()</strong> が使
  用可能です。

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  <class>PgSql\Connection</class> クラスのインスタンス。
                                 <strong>$connection</strong> が指定されない場合は、デフォルトの接続を使います。
                                 デフォルトの接続とは、<strong>pg_connect()</strong> または <strong>pg_pconnect()</strong> によって確
                                 立された直近の接続です。
                                 PHP 8.1.0 以降では、デフォルトの接続を使うことは推奨されなくなりま
                                 した。
                                 
                                 PHP 8.1.0 以降では、デフォルトの接続を使うことは推奨されなくなりま
                                 した。
  <info>string</info>            <strong>$data</strong>        PostgreSQL バックエンドに直接送信されるテキストデータ。 最後に <return>NULL</return>
                                 が自動的に付加されます。

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

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


id: pg_query
type: function
doc:
<comment>Description:</comment>
  クエリを実行する
  
  <strong>pg_query()</strong> は、指定したデータベース <strong>$connection</strong> 上で <strong>$query</strong> を実行します。 特別な理由がない限り、
  この関数よりも <strong>pg_query_params()</strong> を使うほうがいいでしょう。
  
  エラーが発生して <info>false</info> が返された場合、もし接続が正常なら <strong>pg_last_error()</strong> 関数を使用してエラーの詳
  細情報が 取得可能です。
  
  <strong>$connection</strong>は省略可能ですが、それは推奨されません。 なぜならスクリプトのバグが発見しにくくなるため
  です。
  
  <strong>$connection</strong>は省略可能ですが、それは推奨されません。 なぜならスクリプトのバグが発見しにくくなるため
  です。
  
  この関数は、以前は <strong>pg_exec()</strong> と呼ばれていました。 <strong>pg_exec()</strong> は互換性確保のためにまだ使用可能です
  が、 新しい名前を使用することが推奨されています。

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  <class>PgSql\Connection</class> クラスのインスタンス。
                                 <strong>$connection</strong> が指定されない場合は、デフォルトの接続を使います。
                                 デフォルトの接続とは、<strong>pg_connect()</strong> または <strong>pg_pconnect()</strong> によって確
                                 立された直近の接続です。
                                 PHP 8.1.0 以降では、デフォルトの接続を使うことは推奨されなくなりま
                                 した。
                                 
                                 PHP 8.1.0 以降では、デフォルトの接続を使うことは推奨されなくなりま
                                 した。
  <info>string</info>            <strong>$query</strong>       実行する 1 つまたは複数の SQL 文。複数の文が関数に渡された場合は、
                                 明示的に BEGIN/COMMIT コマンドを指定していない限りはそれらの文は ひ
                                 とつのトランザクションとして実行されます。しかし、1 回のコールで 複
                                 数のトランザクションを実行することは推奨されません。
                                 
                                 ユーザーから受け取ったデータを文字列に直接組み込むのは危険で、SQL
                                 インジェクション の脆弱性を引き起こしがちです。クエリ文字列に直接埋
                                 め込むのではなく、 <strong>pg_query_params()</strong> を使ってパラメータとして指定す
                                 ることを推奨します。
                                 
                                 ユーザーから受け取ったデータをクエリ文字列に直接埋め込む場合は、 適
                                 切にエスケープ する必要があります。

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

<comment>See Also:</comment>
   * <strong>pg_connect()</strong>
   * <strong>pg_pconnect()</strong>
   * <strong>pg_fetch_array()</strong>
   * <strong>pg_fetch_object()</strong>
   * <strong>pg_num_rows()</strong>
   * <strong>pg_affected_rows()</strong>


id: pg_query_params
type: function
doc:
<comment>Description:</comment>
  SQL コマンドとパラメータを分割してサーバーへ送信し、その結果を待つ
    
  
  コマンドをサーバーに送信し、その結果を待ちます。パラメータを SQL コマンド とは別に渡すことが可能で
  す。
  
  <strong>pg_query_params()</strong> は <strong>pg_query()</strong> と似ていますが、追加の機能を有しています。それはパラメータ値が コ
  マンド文字列と分離しているということです。 <strong>pg_query_params()</strong> は PostgreSQL 7.4 以降の接続でのみ サ
  ポートされます。それ以前のバージョンでは失敗します。
  
  パラメータを使用する際は、<strong>$query</strong> 文字列内で $1、$2 のように参照されます。 <strong>$query</strong> の中で同じパラ
  メータを何度も使えます。 その場合は、それぞれに同じ値が渡されます。 <strong>$params</strong> で 実際の値を指定しま
  す。<info>null</info> を指定すると、SQL の <return>NULL</return> とみなされます。
  
  <strong>pg_query()</strong> に対する <strong>pg_query_params()</strong> の最大の利点は、パラメータの値を <strong>$query</strong> 文字列から 分離でき
  ることです。そのため、退屈でエラーの元となりやすいクォート・ エスケープなどをしなくてもよくなりま
  す。<strong>pg_query()</strong> と異なり、<strong>pg_query_params()</strong> ではひとつの SQL コマンドしか実行できません（クエリ文字
  列にセミコロンを含めることは 可能です。しかしそれ以降にコマンドを続けることはできません）。

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  <class>PgSql\Connection</class> クラスのインスタンス。
                                 <strong>$connection</strong> が指定されない場合は、デフォルトの接続を使います。
                                 デフォルトの接続とは、<strong>pg_connect()</strong> または <strong>pg_pconnect()</strong> によって確
                                 立された直近の接続です。
                                 PHP 8.1.0 以降では、デフォルトの接続を使うことは推奨されなくなりま
                                 した。
                                 
                                 PHP 8.1.0 以降では、デフォルトの接続を使うことは推奨されなくなりま
                                 した。
  <info>string</info>            <strong>$query</strong>       パラメータ化した SQL 文。ひとつの文のみである必要があります （複数
                                 の文をセミコロンで区切る形式は使用できません）。パラメータを 使用す
                                 る際は $1、$2 などの形式で参照されます。
                                 
                                 ユーザーから受け取った値は常にパラメータとして渡すべきです。 直接ク
                                 エリ文字列に組み込んではいけません。そうしてしまうと、 SQL インジェ
                                 クション 攻撃を受けてしまう可能性があります。また、クォート文字を含
                                 むデータの処理でバグの原因になります。 何らかの理由でパラメータが使
                                 えない場合は、値を 適切にエスケープするようにしましょう。
  <info>array</info>             <strong>$params</strong>      プリペアドステートメント中の $1、$2 などのプレースホルダを 置き換え
                                 るパラメータの配列。配列の要素数はプレースホルダの 数と一致する必要
                                 があります。
                                 
                                 <return>bytea</return> フィールド用の値は、パラメータとして指定できません。
                                 <strong>pg_escape_bytea()</strong> を使うか、ラージオブジェクト関数を使うようにしま
                                 しょう。

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

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


id: pg_result_error
type: function
doc:
<comment>Description:</comment>
  結果に関連するエラーメッセージを取得する
    
  
  <strong>pg_result_error()</strong> は、結果インスタンス (<strong>$result</strong>)に関連したエラーメッセージを返します。 このため、
  ユーザーが <strong>pg_last_error()</strong> よりも適切な エラーメッセージを得る可能性があります。
  
  <strong>pg_result_error_field()</strong> は、 <strong>pg_result_error()</strong> よりもさらに詳細なエラー情報を 返します。
  
  <strong>pg_query()</strong> はクエリが失敗した場合に <info>false</info> を返すので、 結果ハンドルを取得するには <strong>pg_send_query()</strong>
  および <strong>pg_get_result()</strong> を使用する必要があります。

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>  <strong>pg_query()</strong>、<strong>pg_query_params()</strong> や (様々な関数がありますが、特に)
                         <strong>pg_execute()</strong> が返した <class>PgSql\Result</class> クラスのインスタンス。

<comment>Return:</comment>
  <info>string|false</info>  文字列を返します。エラーがない場合は空文字列を返します。 <strong>$result</strong> パラメータに関連付
                けられたエラーがある場合は それを文字列で返します。それ以外の場合は <info>false</info> を返しま
                す。

<comment>See Also:</comment>
   * <strong>pg_result_error_field()</strong>
   * <strong>pg_query()</strong>
   * <strong>pg_send_query()</strong>
   * <strong>pg_get_result()</strong>
   * <strong>pg_last_error()</strong>
   * <strong>pg_last_notice()</strong>


id: pg_result_error_field
type: function
doc:
<comment>Description:</comment>
  エラー報告の各フィールドを返す
  
  <strong>pg_result_error_field()</strong> は、 <strong>$result</strong> インスタンスに関するエラーメッセージの特定のフィールドを返し
  ます。 PostgreSQL 7.4 以降のサーバーでのみ有効です。エラーフィールドは <strong>$field_code</strong> で定義します。
  
  <strong>pg_query()</strong> や <strong>pg_query_params()</strong> はクエリが失敗した場合に <info>false</info> を返すので、結果のハンドルを得るに
  は <strong>pg_send_query()</strong> および <strong>pg_get_result()</strong> を使用する必要があります。
  
  失敗した <strong>pg_query()</strong> クエリから詳細なエラー情報を 取得する必要がある場合は、
  <strong>pg_set_error_verbosity()</strong> および <strong>pg_last_error()</strong> を使用してその結果をパース します。

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>      <strong>pg_query()</strong>、<strong>pg_query_params()</strong> や (様々な関数がありますが、特に)
                             <strong>pg_execute()</strong> が返した <class>PgSql\Result</class> クラスのインスタンス。
  <info>int</info>           <strong>$field_code</strong>  以下の <strong>$field_code</strong> が使用可能です。 <info>PGSQL_DIAG_SEVERITY</info>、
                             <info>PGSQL_DIAG_SQLSTATE</info>、<info>PGSQL_DIAG_MESSAGE_PRIMARY</info>、
                             <info>PGSQL_DIAG_MESSAGE_DETAIL</info>、 <info>PGSQL_DIAG_MESSAGE_HINT</info>、
                             <info>PGSQL_DIAG_STATEMENT_POSITION</info>、
                             <info>PGSQL_DIAG_INTERNAL_POSITION</info>（PostgreSQL 8.0+ のみ）、
                             <info>PGSQL_DIAG_INTERNAL_QUERY</info>（PostgreSQL 8.0+ のみ）、
                             <info>PGSQL_DIAG_CONTEXT</info>、<info>PGSQL_DIAG_SOURCE_FILE</info>、 <info>PGSQL_DIAG_SOURCE_LINE</info> あ
                             るいは <info>PGSQL_DIAG_SOURCE_FUNCTION</info> 。

<comment>Return:</comment>
  <info>string|false|null</info>  エラーフィールドの内容を文字列で返します。 フィールドが存在しない場合に <info>null</info> 、
                     失敗した場合に <info>false</info> を返します。

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


id: pg_result_seek
type: function
doc:
<comment>Description:</comment>
  結果インスタンスの内部行オフセットを設定する
  
  <strong>pg_result_seek()</strong>は、結果インスタンスの行の位置を 指定された offset にセットします。

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>  <strong>pg_query()</strong>、<strong>pg_query_params()</strong> や (様々な関数がありますが、特に)
                         <strong>pg_execute()</strong> が返した <class>PgSql\Result</class> クラスのインスタンス。
  <info>int</info>           <strong>$row</strong>     <class>PgSql\Result</class> クラスのインスタンス内で、内部オフセットを移動させる行。 行番
                         号はゼロから始まります。

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

<comment>See Also:</comment>
   * <strong>pg_fetch_row()</strong>
   * <strong>pg_fetch_assoc()</strong>
   * <strong>pg_fetch_array()</strong>
   * <strong>pg_fetch_object()</strong>
   * <strong>pg_fetch_result()</strong>


id: pg_result_status
type: function
doc:
<comment>Description:</comment>
  クエリ結果のステータスを取得する
    
  
  <strong>pg_result_status()</strong> は、 <class>PgSql\Result</class> インスタンスのステータス あるいは結果に関するコマンド補完タグ
  を返します。

<comment>Param:</comment>
  <info>PgSql\Result</info>  <strong>$result</strong>  <strong>pg_query()</strong>、<strong>pg_query_params()</strong> や (様々な関数がありますが、特に)
                         <strong>pg_execute()</strong> が返した <class>PgSql\Result</class> クラスのインスタンス。
  <info>int</info>           <strong>$mode</strong>    <strong>$result</strong> の数値ステータスを返す <info>PGSQL_STATUS_LONG</info>、あるいは <strong>$result</strong> のコマン
                         ドタグを返す <info>PGSQL_STATUS_STRING</info> のいずれかです。 指定しない場合は
                         <info>PGSQL_STATUS_LONG</info> がデフォルトです。

<comment>Return:</comment>
  <info>string|int</info>  <info>PGSQL_STATUS_LONG</info> が指定された場合の戻り値は 以下のいずれかです。 <info>PGSQL_EMPTY_QUERY</info>、
              <info>PGSQL_COMMAND_OK</info>、<info>PGSQL_TUPLES_OK</info>、<info>PGSQL_COPY_OUT</info>、 <info>PGSQL_COPY_IN</info>、
              <info>PGSQL_BAD_RESPONSE</info>、<info>PGSQL_NONFATAL_ERROR</info> および <info>PGSQL_FATAL_ERROR</info> 。 それ以外の場合
              は、PostgreSQL コマンドタグを含む文字列を返します。

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


id: pg_select
type: function
doc:
<comment>Description:</comment>
  レコードを選択する
    
  
  <strong>pg_select()</strong> は、<return>field=&gt;value</return> 形式の <return>conditions</return> で指定したレコードを選択します。 クエリに成功し
  た場合、<return>conditions</return> で指定した条件に マッチする全てのレコードとフィールドを含む配列が返されます。
  
  <return>flags</return> が指定された場合、 指定したフラグとともに <strong>pg_convert()</strong> が <return>conditions</return> に適用されます。
  
  <strong>$mode</strong> が指定された場合、 戻り値は <info>PGSQL_NUM</info> の場合配列、 <info>PGSQL_ASSOC</info> の場合連想配列(これがデフォル
  トです)、 <info>PGSQL_BOTH</info> の場合数値と連想配列のインデックスが両方含まれた配列になります。
  
  <strong>pg_update()</strong> は生の値を渡します。 値はエスケープするか、PGSQL_DML_ESCAPE オプションを指定しなければ
  いけません。 PGSQL_DML_ESCAPE はパラメータや識別子をクォートし、エスケープします。 よって、テーブ
  ル/カラム名は大文字小文字を区別します。
  
  エスケープやプリペアドクエリであっても、 LIKE, JSON, Array, Regex などのクエリを守れない可能性があ
  ることに注意してください。 これらのパラメータはコンテクストに応じて処理されるべきです。 たとえば、
  値をエスケープ/検証する処理を行うことなどです。

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  <class>PgSql\Connection</class> クラスのインスタンス。
  <info>string</info>            <strong>$table_name</strong>  行を選択するテーブルの名前。
  <info>array</info>             <strong>$conditions</strong>  テーブル <strong>$table_name</strong> のフィールド名をキーに、 取得対象となる行に
                                 マッチするデータを値にもつ配列。
  <info>int</info>               <strong>$flags</strong>       <info>PGSQL_CONV_FORCE_NULL</info>, <info>PGSQL_DML_NO_CONV</info>, <info>PGSQL_DML_ESCAPE</info>,
                                 <info>PGSQL_DML_EXEC</info>, <info>PGSQL_DML_ASYNC</info>, <info>PGSQL_DML_STRING</info> の組み合わせ。
                                 <strong>$flags</strong> の一部に <info>PGSQL_DML_STRING</info> が含まれていた場合、クエリ文字列が
                                 返されます。 <info>PGSQL_DML_NO_CONV</info> あるいは <info>PGSQL_DML_ESCAPE</info> が設定され
                                 ている場合は、 内部的に <strong>pg_convert()</strong> を呼び出しません。
  <info>int</info>               <strong>$mode</strong>        <info>PGSQL_ASSOC</info>, <info>PGSQL_NUM</info>, <info>PGSQL_BOTH</info> の組み合わせ。 <info>PGSQL_ASSOC</info> が設
                                 定されている場合、 戻り値は連想配列になります。 <info>PGSQL_NUM</info> が設定さ
                                 れている場合、 戻り値は配列になります。 <info>PGSQL_BOTH</info> が設定されている
                                 場合、 戻り値は数値と連想配列のインデックスが両方含まれた配列になり
                                 ます。

<comment>Return:</comment>
  <info>array|string|false</info>  <strong>$flags</strong> に <info>PGSQL_DML_STRING</info> が渡された場合は文字列を返します。 それ以外の場合
                      は、成功時に配列を返します。 失敗した場合に <info>false</info> を返します

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


id: pg_send_execute
type: function
doc:
<comment>Description:</comment>
  指定したパラメータでプリペアドステートメントを実行するリクエストを
     送信し、その結果を待たない
    
  
  指定したパラメータでプリペアドステートメントを実行するリクエストを 送信し、その結果を待ちません。
  
  これは <strong>pg_send_query_params()</strong> と似ています。 しかし、実行するコマンドは指定したクエリ文字列で決ま
  るのではなく 事前に準備されたステートメントの名前で決まります。関数のパラメータは <strong>pg_execute()</strong> と
  同じように処理されます。 <strong>pg_execute()</strong> と同様に、7.4 より前のバージョンの PostgreSQL では動作しませ
  ん。

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>      <class>PgSql\Connection</class> クラスのインスタンス。
  <info>string</info>            <strong>$statement_name</strong>  実行するプリペアドステートメントの名前。"" が指定された場合は
                                     無名ステートメントが実行されます。名前は、事前に <strong>pg_prepare()</strong>・
                                     <strong>pg_send_prepare()</strong> あるいは <return>PREPARE</return> SQL コマンドで準備されたもの
                                     である 必要があります。
  <info>array</info>             <strong>$params</strong>          プリペアドステートメント中の $1、$2 などのプレースホルダを 置き
                                     換えるパラメータの配列。配列の要素数はプレースホルダの 数と一致
                                     する必要があります。

<comment>Return:</comment>
  <info>int|bool</info>  成功した場合に <info>true</info> 、失敗した場合に <return>0</return> を返します。 クエリの結果を確認するには
            <strong>pg_get_result()</strong> を使用します。

<comment>See Also:</comment>
   * <strong>pg_prepare()</strong>
   * <strong>pg_send_prepare()</strong>
   * <strong>pg_execute()</strong>


id: pg_send_prepare
type: function
doc:
<comment>Description:</comment>
  指定したパラメータでプリペアドステートメントを作成するリクエストを
     送信し、その結果を待たない
    
  
  指定したパラメータでプリペアドステートメントを作成するリクエストを 送信し、その結果を待ちません。
  
  これは <strong>pg_prepare()</strong> の非同期バージョンです。 リクエストが受け付けられた場合に <info>true</info> 、そうでない場
  合に <info>false</info> を返します。コールが成功した後、実際にプリペアドステートメントが 作成されたかどうかを調
  べるには <strong>pg_get_result()</strong> を使用します。関数のパラメータは <strong>pg_prepare()</strong> と同じように処理されます。
  <strong>pg_prepare()</strong> と同様、 7.4 より前の PostgreSQL のバージョンでは正しく動作しません。

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>      <class>PgSql\Connection</class> クラスのインスタンス。
  <info>string</info>            <strong>$statement_name</strong>  プリペアドステートメントにつける名前。接続内で一意である必要が
                                     あります。 "" が指定された場合は無名ステートメントが作成され、
                                     以前に定義された 無名ステートメントを上書きします。
  <info>string</info>            <strong>$query</strong>           パラメータ化した SQL 文。ひとつの文のみである必要があります
                                     （複数の文をセミコロンで区切る形式は使用できません）。パラメー
                                     タを 使用する際は $1、$2 などの形式で参照されます。

<comment>Return:</comment>
  <info>int|bool</info>  成功した場合に <info>true</info> 、失敗した場合に <return>0</return> を返します。 クエリの結果を確かめるには
            <strong>pg_get_result()</strong> を使用します。

<comment>See Also:</comment>
   * <strong>pg_connect()</strong>
   * <strong>pg_pconnect()</strong>
   * <strong>pg_execute()</strong>
   * <strong>pg_send_execute()</strong>
   * <strong>pg_send_query_params()</strong>


id: pg_send_query
type: function
doc:
<comment>Description:</comment>
  非同期クエリを送信する
    
  
  <strong>pg_send_query()</strong> は、<strong>$connection</strong> に非同期クエリを送信します。<strong>pg_query()</strong> とは異なり、 PostgreSQL へ
  一度に複数のクエリを送信することができ、 <strong>pg_get_result()</strong> を用いて結果を一つずつ取得することが可能
  です。
  
  スクリプトの実行は、クエリを実行中もブロックされません。 接続がビジーである(すなわち、クエリが実行
  中である)ことを調べるには、 <strong>pg_connection_busy()</strong> を使用してください。 クエリは、<strong>pg_cancel_query()</strong>
  をコールすることによりキャンセルすることが可能です。
  
  ユーザーは複数のクエリを一度に送信することができますが、 複数のクエリをビジー状態の接続に送信する
  ことはできません。 クエリがビジー状態の接続に送信された場合、 最後のクエリが終了するまで待ち、全て
  の結果は破棄されます。

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  <class>PgSql\Connection</class> クラスのインスタンス。
  <info>string</info>            <strong>$query</strong>       実行するひとつまたは複数の SQL 文。
                                 
                                 クエリ内のデータは 適切にエスケープ する必要があります。

<comment>Return:</comment>
  <info>int|bool</info>  成功した場合に <info>true</info> 、失敗した場合に <return>0</return> を返します。 クエリの結果を確かめるには
            <strong>pg_get_result()</strong> を使用します。

<comment>See Also:</comment>
   * <strong>pg_query()</strong>
   * <strong>pg_cancel_query()</strong>
   * <strong>pg_get_result()</strong>
   * <strong>pg_connection_busy()</strong>


id: pg_send_query_params
type: function
doc:
<comment>Description:</comment>
  コマンドとパラメータを分割してサーバーに送信し、その結果を待たない
  
  コマンドとパラメータを分割してサーバーに送信します。その結果を待つことは しません。
  
  これは <strong>pg_send_query()</strong> とほぼ同じですが、パラメータが <strong>$query</strong> とは別に分かれている点が違います。 関
  数のパラメータは、<strong>pg_query_params()</strong> によって 完全に制御されます。<strong>pg_query_params()</strong> と同様、 7.4 よ
  り前の PostgreSQL では動作しません。またクエリ文字列には ひとつのコマンドのみを含めることができま
  す。

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  <class>PgSql\Connection</class> クラスのインスタンス。
  <info>string</info>            <strong>$query</strong>       パラメータ化した SQL 文。ひとつの文のみである必要があります （複数
                                 の文をセミコロンで区切る形式は使用できません）。パラメータを 使用す
                                 る際は $1、$2 などの形式で参照されます。
  <info>array</info>             <strong>$params</strong>      プリペアドステートメント中の $1、$2 などのプレースホルダを 置き換え
                                 るパラメータの配列。配列の要素数はプレースホルダの 数と一致する必要
                                 があります。

<comment>Return:</comment>
  <info>int|bool</info>  成功した場合に <info>true</info> 、失敗した場合に <return>0</return> を返します。 クエリの結果を確かめるには
            <strong>pg_get_result()</strong> を使用します。

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


id: pg_set_client_encoding
type: function
doc:
<comment>Description:</comment>
  クライアントのエンコーディングを設定する
    
  
  <strong>pg_set_client_encoding()</strong> はクライアントの エンコーディングを設定し、成功した場合に 0、エラー時に
  -1 を 返します。
  
  PostgreSQL は、バックエンドのデータベースエンコーディングを自動的に フロントエンドのエンコーディン
  グに変換します。
  
  この関数は、以前は <strong>pg_setclientencoding()</strong> と呼ばれていました。

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  <class>PgSql\Connection</class> クラスのインスタンス。
                                 <strong>$connection</strong> が指定されない場合は、デフォルトの接続を使います。
                                 デフォルトの接続とは、<strong>pg_connect()</strong> または <strong>pg_pconnect()</strong> によって確
                                 立された直近の接続です。
                                 PHP 8.1.0 以降では、デフォルトの接続を使うことは推奨されなくなりま
                                 した。
                                 
                                 PHP 8.1.0 以降では、デフォルトの接続を使うことは推奨されなくなりま
                                 した。
  <info>string</info>            <strong>$encoding</strong>    クライアントエンコーディング。以下のうちのひとつです。<return>SQL_ASCII</return>、
                                 <return>EUC_JP</return>、 <return>EUC_CN</return>、<return>EUC_KR</return>、<return>EUC_TW</return>、 <return>UNICODE</return>、<return>MULE_INTERNAL</return>、<return>LATINX</return>
                                 (X=1...9)、 <return>KOI8</return>、<return>WIN</return>、<return>ALT</return>、<return>SJIS</return>、 <return>BIG5</return> あるいは <return>WIN1250</return> 。
                                 
                                 利用可能なエンコーディングの完全なリストは、使用している PostgreSQL
                                 のバージョンに依存します。詳細な情報については PostgreSQL のマニュ
                                 アルを 参照ください。

<comment>Return:</comment>
  <info>int</info>  成功した場合に <return>0</return>、 エラー時に <return>-1</return> を返します。

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


id: pg_set_error_context_visibility
type: function
doc:
<comment>Description:</comment>
  pg_last_error が返すコンテクストのエラーメッセージのアクセス権を設定する
    
  
  <strong>pg_last_error()</strong> と <strong>pg_result_error()</strong> が返す、コンテクストのエラーメッセージのアクセス権を設定しま
  す

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  <class>PgSql\Connection</class> クラスのインスタンス。
  <info>int</info>               <strong>$visibility</strong>  必要なアクセス権を指定します: <info>PGSQL_SHOW_CONTEXT_NEVER</info>,
                                 <info>PGSQL_SHOW_CONTEXT_ERRORS</info>, <info>PGSQL_SHOW_CONTEXT_ALWAYS</info>

<comment>Return:</comment>
  <info>int</info>  直前のアクセス権レベルを返します: <info>PGSQL_SHOW_CONTEXT_NEVER</info>, <info>PGSQL_SHOW_CONTEXT_ERRORS</info>,
       <info>PGSQL_SHOW_CONTEXT_ALWAYS</info>

<comment>See Also:</comment>
   * <strong>pg_last_error()</strong>
   * <strong>pg_result_error()</strong>


id: pg_set_error_verbosity
type: function
doc:
<comment>Description:</comment>
  pg_last_error および pg_result_error
     が返すメッセージの詳細度を指定する
    
  
  <strong>pg_last_error()</strong> および <strong>pg_result_error()</strong> が返すメッセージの詳細度を指定します。
  
  <strong>pg_set_error_verbosity()</strong> は詳細度を設定し、その接続の これまでの設定を返します。<info>PGSQL_ERRORS_TERSE</info>
  モードでは、返されるメッセージは深刻度・概要 および 発生位置のみです。 これはたいていの場合 1 行に
  収まります。デフォルトのモード （<info>PGSQL_ERRORS_DEFAULT</info>）では、それに加えて何らかの 詳細情報・ヒント
  あるいは状況フィールドを含みます（これらは複数行に またがる可能性があります）。
  <info>PGSQL_ERRORS_VERBOSE</info> モードは、有効なフィールドをすべて含みます。詳細度の設定変更内容は それ以降に
  新しく作成した結果オブジェクトにのみ反映され、既存の 結果オブジェクトには影響を与えません。

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  <class>PgSql\Connection</class> クラスのインスタンス。
                                 <strong>$connection</strong> が指定されない場合は、デフォルトの接続を使います。
                                 デフォルトの接続とは、<strong>pg_connect()</strong> または <strong>pg_pconnect()</strong> によって確
                                 立された直近の接続です。
                                 PHP 8.1.0 以降では、デフォルトの接続を使うことは推奨されなくなりま
                                 した。
                                 
                                 PHP 8.1.0 以降では、デフォルトの接続を使うことは推奨されなくなりま
                                 した。
  <info>int</info>               <strong>$verbosity</strong>   指定する詳細度。<info>PGSQL_ERRORS_TERSE</info>、 <info>PGSQL_ERRORS_DEFAULT</info> あるいは
                                 <info>PGSQL_ERRORS_VERBOSE</info> 。

<comment>Return:</comment>
  <info>int</info>  変更前の詳細度レベル。<info>PGSQL_ERRORS_TERSE</info>、 <info>PGSQL_ERRORS_DEFAULT</info> あるいは <info>PGSQL_ERRORS_VERBOSE</info>
       のいずれかを 返します。

<comment>See Also:</comment>
   * <strong>pg_last_error()</strong>
   * <strong>pg_result_error()</strong>


id: pg_socket
type: function
doc:
<comment>Description:</comment>
  PostgreSQL 接続の下層にある、読み取り専用のソケットのハンドルを取得する
    
  
  <strong>pg_socket()</strong> は、 与えられた PostgreSQL 接続の下層にあるソケットに対応した、 読み取り専用の
  <info>resource</info> を返します。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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

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


id: pg_trace
type: function
doc:
<comment>Description:</comment>
  PostgreSQL 接続のトレースを有効にする
  
  <strong>pg_trace()</strong> は、PostgreSQL フロントエンド/ バックエンド間の通信をデバック用のファイルにトレースする
  ことを有効にします。 このトレース結果を完全に理解するためには、PostgreSQL 通信プロトコルの詳細に
  精通している必要があります。
  
  そうでない人にとっても、サーバーに送られたクエリのエラーを トレースすることは有用です。試しに grep
  '^To backend' trace.log を実行し、実際に PostgreSQL サーバーに送信される クエリを見てみるとよいで
  しょう。詳細な情報は PostgreSQL Documentation を 参照ください。

<comment>Param:</comment>
  <info>string</info>                 <strong>$filename</strong>    トレースログを書き込むファイルの名前（フルパスを含む）。
                                      <strong>fopen()</strong> と同じ。
  <info>string</info>                 <strong>$mode</strong>        オプションのファイルアクセスモード。<strong>fopen()</strong> と同じです。
  <info>PgSql\Connection|null</info>  <strong>$connection</strong>  <class>PgSql\Connection</class> クラスのインスタンス。
                                      <strong>$connection</strong> が <info>null</info>, の場合、デフォルトの接続を使います。
                                      デフォルトの接続とは、<strong>pg_connect()</strong> または <strong>pg_pconnect()</strong> によっ
                                      て確立された直近の接続です。
                                      PHP 8.1.0 以降では、デフォルトの接続を使うことは推奨されなくな
                                      りました。
                                      
                                      PHP 8.1.0 以降では、デフォルトの接続を使うことは推奨されなくな
                                      りました。
  <info>int</info>                    <strong>$trace_mode</strong>  オプションのトレースモード。 定数
                                      <info>PGSQL_TRACE_SUPPRESS_TIMESTAMPS</info> と <info>PGSQL_TRACE_REGRESS_MODE</info> を
                                      指定します。

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

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


id: pg_transaction_status
type: function
doc:
<comment>Description:</comment>
  サーバー上で実行中のトランザクションの状態を返す
  
  サーバー上で実行中のトランザクションの状態を返します。
  
  PostgreSQL 7.3 サーバーで <return>autocommit</return> を off に 設定している場合、<strong>pg_transaction_status()</strong> は 不正確
  な値を返します。サーバー側での自動コミット機能は非推奨と されており、最近のバージョンのサーバーで
  は存在しません。

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

<comment>Return:</comment>
  <info>int</info>  <info>PGSQL_TRANSACTION_IDLE</info>（アイドル状態）、 <info>PGSQL_TRANSACTION_ACTIVE</info>（コマンドの実行中）、
       <info>PGSQL_TRANSACTION_INTRANS</info>（正常なトランザクション内でアイドル状態）、 あるいは
       <info>PGSQL_TRANSACTION_INERROR</info>（失敗したトランザクション内でアイドル状態） のいずれかを返します。
       接続が異常な場合は <info>PGSQL_TRANSACTION_UNKNOWN</info> を返します。 <info>PGSQL_TRANSACTION_ACTIVE</info> が返される
       のは、クエリを サーバーに送信した後まだそれが完了していない場合のみです。


id: pg_tty
type: function
doc:
<comment>Description:</comment>
  接続に関する TTY 名を返す
    
  
  <strong>pg_tty()</strong> は、指定した PostgreSQL <strong>$connection</strong> インスタンスで、 サーバー側のデバッグ出力が送られる
  tty 名を返します。
  
  <strong>pg_tty()</strong> は現在は使用されません。今はサーバーが TTY 設定を気にする必要がないからです。しかし、過去
  との互換性を 保持するためにこの関数は残されています。

<comment>Param:</comment>
  <info>PgSql\Connection|null</info>  <strong>$connection</strong>  <class>PgSql\Connection</class> クラスのインスタンス。
                                      <strong>$connection</strong> が <info>null</info>, の場合、デフォルトの接続を使います。
                                      デフォルトの接続とは、<strong>pg_connect()</strong> または <strong>pg_pconnect()</strong> によっ
                                      て確立された直近の接続です。
                                      PHP 8.1.0 以降では、デフォルトの接続を使うことは推奨されなくな
                                      りました。
                                      
                                      PHP 8.1.0 以降では、デフォルトの接続を使うことは推奨されなくな
                                      りました。

<comment>Return:</comment>
  <info>string</info>  <strong>$connection</strong> のデバッグ TTY を文字列で返します。


id: pg_unescape_bytea
type: function
doc:
<comment>Description:</comment>
  bytea 型のバイナリをアンエスケープする
    
  
  <strong>pg_unescape_bytea()</strong> は、bytea 型のデータ文字列を アンエスケープし、エスケープしていない文字列、 場
  合によってはバイナリデータを返します。
  
  bytea 型を <return>SELECT</return> した場合、PostgreSQL は '\' で 始まる 8 進数のバイト値（例: \032）を返します。こ
  れをユーザーが手動で コンバートすることを期待されています。
  
  この関数は PostgreSQL 7.2 以降のバージョンが必要です。PostgreSQL 7.2.0 および 7.2.1 では、マルチバ
  イトのサポートを有効にした場合は bytea の値をキャストする必要があります。例: <return>INSERT INTO
  test_table (image) VALUES ('$image_escaped'::bytea); </return> PostgreSQL 7.2.2 以降ではキャストする必要は
  ありません。 クライアントとバックエンドの文字エンコーディングが一致しない場合は 例外で、この場合は
  マルチバイトストリームエラーが発生します。この エラーを避けるためには bytea 型へのキャストが必要に
  なります。

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  PHP のバイナリ文字列に変換される PostgreSQL の bytea データを含む <info>文字列</info>。

<comment>Return:</comment>
  <info>string</info>  アンエスケープされたデータを文字列で返します。

<comment>See Also:</comment>
   * <strong>pg_escape_bytea()</strong>
   * <strong>pg_escape_string()</strong>


id: pg_untrace
type: function
doc:
<comment>Description:</comment>
  PostgreSQL 接続のトレースを無効にする
  
  <strong>pg_trace()</strong> で開始したトレースを停止します。

<comment>Param:</comment>
  <info>PgSql\Connection|null</info>  <strong>$connection</strong>  <class>PgSql\Connection</class> クラスのインスタンス。
                                      <strong>$connection</strong> が <info>null</info>, の場合、デフォルトの接続を使います。
                                      デフォルトの接続とは、<strong>pg_connect()</strong> または <strong>pg_pconnect()</strong> によっ
                                      て確立された直近の接続です。
                                      PHP 8.1.0 以降では、デフォルトの接続を使うことは推奨されなくな
                                      りました。
                                      
                                      PHP 8.1.0 以降では、デフォルトの接続を使うことは推奨されなくな
                                      りました。

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

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


id: pg_update
type: function
doc:
<comment>Description:</comment>
  テーブルを更新する
    
  
  <strong>pg_update()</strong> は、 <strong>$conditions</strong> にマッチするレコードを <strong>$values</strong> に更新します。
  
  <strong>$flags</strong> が指定された場合、指定したオプションとともに <strong>pg_convert()</strong> が <strong>$data</strong> に適用されます。
  
  デフォルトでは、 <strong>pg_update()</strong> は生の値を渡します。 値はエスケープするか、 <strong>$flags</strong> に
  <info>PGSQL_DML_ESCAPE</info> オプションを指定しなければいけません。 <info>PGSQL_DML_ESCAPE</info> はパラメータや識別子を
  クォートし、 エスケープします。 よって、テーブル/カラム名は大文字小文字を区別します。
  
  エスケープやプリペアドクエリであっても、 LIKE, JSON, Array, Regex などのクエリを守れない可能性があ
  ることに注意してください。 これらのパラメータはコンテクストに応じて処理されるべきです。 たとえば、
  値をエスケープ/検証する処理を行うことなどです。

<comment>Param:</comment>
  <info>PgSql\Connection</info>  <strong>$connection</strong>  <class>PgSql\Connection</class> クラスのインスタンス。
  <info>string</info>            <strong>$table_name</strong>  行を更新するテーブルの名前。
  <info>array</info>             <strong>$values</strong>      テーブル <strong>$table_name</strong> のフィールド名をキーに、 そしてマッチした対象
                                 を更新するデータを値にもつ配列。
  <info>array</info>             <strong>$conditions</strong>  テーブル <strong>$table_name</strong> のフィールド名をキーに、 そして取得対象となる
                                 行にマッチするデータを値にもつ配列。
  <info>int</info>               <strong>$flags</strong>       <info>PGSQL_CONV_FORCE_NULL</info>、 <info>PGSQL_DML_NO_CONV</info>、 <info>PGSQL_DML_ESCAPE</info>、
                                 <info>PGSQL_DML_EXEC</info>、 <info>PGSQL_DML_ASYNC</info> あるいは <info>PGSQL_DML_STRING</info> の組み合
                                 わせ。 <strong>$flags</strong> の一部に <info>PGSQL_DML_STRING</info> が含まれていた場合、 クエリ
                                 文字列が返されます。 <info>PGSQL_DML_NO_CONV</info> あるいは <info>PGSQL_DML_ESCAPE</info> が
                                 設定されている場合は、内部的に <strong>pg_convert()</strong> を呼びません。

<comment>Return:</comment>
  <info>string|bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。 <strong>$flags</strong> に <info>PGSQL_DML_STRING</info>
               が渡された場合は文字列を返します。

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


id: pg_version
type: function
doc:
<comment>Description:</comment>
  クライアント・プロトコル・サーバーのバージョンを配列で返す
    
  
  <strong>pg_version()</strong> はクライアント・プロトコル およびサーバーのバージョンを配列で返します。プロトコルおよ
  びサーバーの バージョンは、PHP が PostgreSQL 7.4 以降とともにコンパイルされている 場合のみ有効で
  す。
  
  詳細なサーバー情報を取得するには <strong>pg_parameter_status()</strong> を参照ください。

<comment>Param:</comment>
  <info>PgSql\Connection|null</info>  <strong>$connection</strong>  <class>PgSql\Connection</class> クラスのインスタンス。
                                      <strong>$connection</strong> が <info>null</info>, の場合、デフォルトの接続を使います。
                                      デフォルトの接続とは、<strong>pg_connect()</strong> または <strong>pg_pconnect()</strong> によっ
                                      て確立された直近の接続です。
                                      PHP 8.1.0 以降では、デフォルトの接続を使うことは推奨されなくな
                                      りました。
                                      
                                      PHP 8.1.0 以降では、デフォルトの接続を使うことは推奨されなくな
                                      りました。

<comment>Return:</comment>
  <info>array</info>  <return>client</return>, <return>protocol</return>  および <return>server</return> のキーとその値を持つ配列を 返します（有効な場合）。

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


id: php_ini_loaded_file
type: function
doc:
<comment>Description:</comment>
  読み込まれた php.ini ファイルのパスを取得する
  
  php.ini ファイルが読み込まれているかどうかを調べ、 そのパスを取得します。

<comment>Return:</comment>
  <info>string|false</info>  読み込まれている php.ini のパス、 あるいは読み込まれていない場合に <info>false</info> を返しま
                す。

<comment>See Also:</comment>
   * <strong>php_ini_scanned_files()</strong>
   * <strong>phpinfo()</strong>
   * 設定ファイル


id: php_ini_scanned_files
type: function
doc:
<comment>Description:</comment>
  追加の ini ディレクトリにある .ini ファイルのリストを取得する
  
  <strong>php_ini_scanned_files()</strong>は、php.iniをパースした 後で、設定ファイルのリストをカンマ区切りで返しま
  す。 ファイルを探すディレクトリは、コンパイル時のオプションで指定します。 また、実行時に環境変数で
  指定することもできます。詳細は インストールガイド を参照ください。
  
  戻り値のファイル名は、フルパス形式となります。

<comment>Return:</comment>
  <info>string|false</info>  成功すると、.iniファイルをカンマ区切りにした文字列が返されます。
                --with-config-file-scan-dir がセットされておらず、かつ環境変数 PHP_INI_SCAN_DIR も設
                定されていない場合は <info>false</info>を返します。指定されたディレクトリが空であれば、 空文字列
                が返されます。ファイルが認識できないものであれば、 そのファイルは文字列には含まれま
                すが同時にPHPがエラーを起こします。 このエラーはコンパイルの時と、
                <strong>php_ini_scanned_files()</strong> 関数を使用したときの両方で発生します。

<comment>See Also:</comment>
   * <strong>ini_set()</strong>
   * <strong>phpinfo()</strong>
   * <strong>php_ini_loaded_file()</strong>


id: php_sapi_name
type: function
doc:
<comment>Description:</comment>
  ウェブサーバーと PHP の間のインターフェイスの型を返す
  
  PHP が使用しているインターフェイス (サーバー API、SAPI) の型を小文字の文字列で返します。たとえば、
  CLI 版の PHP ではこの文字列は "cli" となります。Apache と組み合わせて使用している場合は、 実際に使
  用している SAPI によってさまざまな結果となります。 返されうる値の一覧を以下にあげます。

<comment>Return:</comment>
  <info>string|false</info>  インターフェイスの型を小文字の文字列で返します。 失敗した場合に <info>false</info> を返します
                
                これがすべてではありませんが、以下のような値が返されます。 <return>apache</return>,  <return>apache2handler</return>,
                <return>cgi</return> (PHP 5.3 まで),  <return>cgi-fcgi</return>, <return>cli</return>, <return>cli-server</return>, <return>embed</return>, <return>fpm-fcgi</return>, <return>litespeed</return>,  <return>phpdbg</return>

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


id: php_strip_whitespace
type: function
doc:
<comment>Description:</comment>
  コメントと空白文字を取り除いたソースを返す
  
  PHP のソースコード <strong>$filename</strong> からコメントと 空白文字を取り除いたものを返します。これは、スクリプト
  の中で 実際のコードの量がどれくらいなのかを知るのに役立つでしょう。 これは コマンドライン から php
  -w を実行するのと同じです。

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

<comment>Return:</comment>
  <info>string</info>  成功した場合に処理済みのソースコード、失敗した場合に空の文字列を返します。
          
          この関数は、 short_open_tag ini ディレクティブの値を考慮します。


id: php_uname
type: function
doc:
<comment>Description:</comment>
  PHP が稼動しているオペレーティングシステムに関する情報を返す
  
  <strong>php_uname()</strong> は、PHP が稼動しているオペレーティング システムに関する説明を返します。これは、
  <strong>phpinfo()</strong> の出力の先頭に出てくるものと同じです。 単に OS の名前を取得したい場合には <info>PHP_OS</info> 定数の
  利用を考えてください。ただし、 この定数が返すのは PHP が構築された OS の 情報であることに注意しま
  しょう。
  
  古い UNIX プラットフォームの中には現在の OS 情報を取得できないものもあります。 そんな場合は、PHP
  をビルドした OS の情報を表示します。 これがおこるのは、 uname() ライブラリコールが存在しないか機能
  していない場合のみです。

<comment>Param:</comment>
  <info>string</info>  <strong>$mode</strong>  <strong>$mode</strong> は、どのような情報を返すのかを一文字で指定します: <return>'a'</return>: デフォルトです。すべて
                 のモードを <return>"s n r v m"</return> の順で返します。 <return>'s'</return>: オペレーティングシステム名。 例:
                 <return>FreeBSD</return> <return>'n'</return>: ホスト名。 例: <return>localhost.example.com</return> <return>'r'</return>: リリース名。 例:
                 <return>5.1.2-RELEASE</return> <return>'v'</return>: バージョン情報。 オペレーティングシステムによって大きく変わりま
                 す。 <return>'m'</return>: マシン型。例: <return>i386</return>
                 
                 <return>'a'</return>: デフォルトです。すべてのモードを <return>"s n r v m"</return> の順で返します。
                 
                 <return>'s'</return>: オペレーティングシステム名。 例: <return>FreeBSD</return>
                 
                 <return>'n'</return>: ホスト名。 例: <return>localhost.example.com</return>
                 
                 <return>'r'</return>: リリース名。 例: <return>5.1.2-RELEASE</return>
                 
                 <return>'v'</return>: バージョン情報。 オペレーティングシステムによって大きく変わります。
                 
                 <return>'m'</return>: マシン型。例: <return>i386</return>

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

<comment>See Also:</comment>
   * <strong>phpversion()</strong>
   * <strong>php_sapi_name()</strong>
   * <strong>phpinfo()</strong>


id: php_user_filter
type: class
doc:
<comment>Description:</comment>
  このクラスの子クラスを <strong>stream_filter_register()</strong> に渡します。 子クラスの __construct メソッドは呼び
  出されないので注意して下さい: 初期化については、php_user_filter::onCreate を変わりに使うべきです。


id: php_user_filter::filter
type: function
doc:
<comment>Description:</comment>
  フィルタを適用するときにコールされる
  
  このメソッドがコールされるのは、アタッチしたストリームとの間で (<strong>fread()</strong> や <strong>fwrite()</strong> による) データ
  の読み書きを行ったときです。

<comment>Param:</comment>
  <info>resource</info>  <strong>$in</strong>        <strong>$in</strong> は <return>バケット群</return> を指すリソースで、 この中には一つあるいは複数の <return>バケット</return> オ
                       ブジェクトが含まれています。 このオブジェクトに、フィルタ対象のデータが含まれ
                       ます。
  <info>resource</info>  <strong>$out</strong>       <strong>$out</strong> はもう一つの <return>バケット群</return> を指すリソースで、 変更した内容をここに保存しま
                       す。
  <info>int</info>       <strong>$consumed</strong>  <strong>$consumed</strong> は常に参照渡しとする必要があります。 フィルタで読み込んだり変更した
                       りしたデータの長さをここで加算します。 大半の場合、各 <return>$bucket</return> 上で
                       <return>$bucket-&gt;datalen</return> をコールするたびに <strong>$consumed</strong> を増やすことになります。
  <info>bool</info>      <strong>$closing</strong>   ストリームが終了処理の最中である場合 (つまり、フィルタチェインの最後の処理を
                       行っている場合) に、<strong>$closing</strong> パラメータが <info>true</info> となります。

<comment>Return:</comment>
  <info>int</info>  filter メソッドは、処理を終えたときに次のいずれかの値を返す必要があります。 戻り値意味
       <info>PSFS_PASS_ON</info> フィルタの処理が成功し、データが <strong>$out</strong> <return>バケット群</return> に保存されました。 <info>PSFS_FEED_ME</info>
       フィルタの処理は成功しましたが、返すデータはありません。 ストリームあるいは一つ前のフィルタか
       ら、さらにデータが必要です。 <info>PSFS_ERR_FATAL</info> (デフォルト) フィルタで対処不能なエラーが発生し、
       処理を続行できません。


id: php_user_filter::onClose
type: function
doc:
<comment>Description:</comment>
  フィルタを閉じるときにコールされる
  
  このメソッドがコールされるのはフィルタを終了する (通常は、同時にストリームも終了する) ときで、
  <return>flush</return> メソッドよりも 後で 実行されます。 <return>onCreate()</return> で何らかのリソースを確保したり初期化したりして
  いた場合は、ここで破棄することになります。

<comment>Return:</comment>
  <info>void</info>  戻り値は無視されます。


id: php_user_filter::onCreate
type: function
doc:
<comment>Description:</comment>
  フィルタを作成するときにコールされる
  
  このメソッドがコールされるのは、フィルタクラスのオブジェクトのインスタンスを生成するときです。 他
  のリソース (バッファなど) を確保したり初期化したりする場合は、このメソッドで行います。
  
  フィルタのインスタンスを作成して <return>yourfilter-&gt;onCreate()</return> をコールすると、 以下の表に示すさまざま
  なプロパティが使えるようになります。
  
  プロパティ内容<return>FilterClass-&gt;filtername</return> フィルタのインスタンスを作成するときの名前を表す文字列。
  フィルタを登録するときには、複数の名前を使ったりワイルドカードを使ったりできます。 このプロパティ
  を使って、どの名前が用いられたのかを判断します。 <return>FilterClass-&gt;params</return><strong>stream_filter_append()</strong> ある
  いは <strong>stream_filter_prepend()</strong> に渡された <strong>$params</strong> パラメータの内容。 <return>FilterClass-&gt;stream</return> フィルタ
  の対象となるストリームリソース。 <return>closing</return> パラメータが <info>false</info> の状態で filter がコールされている間だ
  け存在します。

<comment>Return:</comment>
  <info>bool</info>  このメソッドを実装は、成功した場合に <info>true</info> そして失敗した場合に <info>false</info> を返す必要があります。


id: phpcredits
type: function
doc:
<comment>Description:</comment>
  PHP に関するクレジットを出力する
  
  この関数は、PHP 開発者、モジュール等のリストを有するクレジットを出力します。 ページに情報を挿入す
  るために、適切な HTML コードが生成されます。

<comment>Param:</comment>
  <info>int</info>  <strong>$flags</strong>  独自のクレジットページを出力したい場合に <strong>$flags</strong> を利用するとよいでしょう。
               
               定義済みの <strong>phpcredits()</strong> フラグ名前説明CREDITS_ALL すべてのクレジットを含めます。
               <info>CREDITS_DOCS</info> + <info>CREDITS_GENERAL</info> + <info>CREDITS_GROUP</info> + <info>CREDITS_MODULES</info> + <info>CREDITS_FULLPAGE</info>
               と同等です。これは、適切なタグを含んだ それ単体で成立する HTML ページを生成します。
               CREDITS_DOCSドキュメントチームのクレジットCREDITS_FULLPAGE 通常、他のフラグと組み合わ
               せて使用します。 他のフラグで指定した情報を含む、それ単体で完全に独立した HTML ページ
               を出力することを指定します。 CREDITS_GENERAL 一般的なクレジット: 言語の設計およびコン
               セプト、PHP 作者、SAPIモジュール CREDITS_GROUPコア開発者のリストCREDITS_MODULESPHPの
               拡張モジュール、およびその作者のリストCREDITS_SAPIPHP のサーバー API モジュールとその
               作者のリスト

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

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


id: phpdbg_break_file
type: function
doc:
<comment>Description:</comment>
  ファイルの行にブレークポイントを挿入する
  
  指定された <strong>$file</strong> の 指定された <strong>$line</strong> にブレークポイントを挿入します。

<comment>Param:</comment>
  <info>string</info>  <strong>$file</strong>  ファイル名
  <info>int</info>     <strong>$line</strong>  行番号

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

<comment>See Also:</comment>
   * <strong>phpdbg_break_function()</strong>
   * <strong>phpdbg_break_method()</strong>
   * <strong>phpdbg_break_next()</strong>
   * <strong>phpdbg_clear()</strong>


id: phpdbg_break_function
type: function
doc:
<comment>Description:</comment>
  関数のエントリにブレークポイントを挿入する
  
  指定された <strong>$function</strong> のエントリにブレークポイントを挿入します。

<comment>Param:</comment>
  <info>string</info>  <strong>$function</strong>  関数の名前

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

<comment>See Also:</comment>
   * <strong>phpdbg_break_file()</strong>
   * <strong>phpdbg_break_method()</strong>
   * <strong>phpdbg_break_next()</strong>
   * <strong>phpdbg_clear()</strong>


id: phpdbg_break_method
type: function
doc:
<comment>Description:</comment>
  メソッドのエントリにブレークポイントを挿入する
  
  指定された <strong>$class</strong> の 指定された <strong>$method</strong> にブレークポイントを挿入します。

<comment>Param:</comment>
  <info>string</info>  <strong>$class</strong>   クラスの名前
  <info>string</info>  <strong>$method</strong>  メソッドの名前

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

<comment>See Also:</comment>
   * <strong>phpdbg_break_file()</strong>
   * <strong>phpdbg_break_function()</strong>
   * <strong>phpdbg_break_next()</strong>
   * <strong>phpdbg_clear()</strong>


id: phpdbg_break_next
type: function
doc:
<comment>Description:</comment>
  次のオペコードにブレークポイントを挿入します
  
  次のオペコードにブレークポイントを挿入します。

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

<comment>See Also:</comment>
   * <strong>phpdbg_break_file()</strong>
   * <strong>phpdbg_break_function()</strong>
   * <strong>phpdbg_break_method()</strong>
   * <strong>phpdbg_clear()</strong>


id: phpdbg_clear
type: function
doc:
<comment>Description:</comment>
  全てのブレークポイントをクリアする
  
  これまでに設定されたブレークポイントをすべてクリアします。 <strong>phpdbg_break_*()</strong> 関数や、 コンソールで
  対話的に設定したブレークポイントが全て含まれます。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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

<comment>See Also:</comment>
   * <strong>phpdbg_break_file()</strong>
   * <strong>phpdbg_break_function()</strong>
   * <strong>phpdbg_break_method()</strong>
   * <strong>phpdbg_break_next()</strong>


id: phpdbg_color
type: function
doc:
<comment>Description:</comment>
  特定の要素に色を設定する
  
  指定された <strong>$element</strong> に <strong>$color</strong> を設定します。

<comment>Param:</comment>
  <info>int</info>     <strong>$element</strong>  定数 <info>PHPDBG_COLOR_*</info> のうちのひとつを指定します。
  <info>string</info>  <strong>$color</strong>    色の名前。 <return>white</return>, <return>red</return>, <return>green</return>, <return>yellow</return>, <return>blue</return>, <return>purple</return>, <return>cyan</return>, <return>black</return> のうちのいずれか
                    を指定します。 オプションで、これらの色の後に <return>-bold</return> や <return>-underline</return> を付加できま
                    す。 たとえば、 <return>white-bold</return> とか <return>green-underline</return> のようなものです。

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

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


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

<comment>Param:</comment>
  <info>array</info>  <strong>$options</strong>  

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


id: phpdbg_exec
type: function
doc:
<comment>Description:</comment>
  実行コンテクストの設定を試みる
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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

<comment>Return:</comment>
  <info>string|bool</info>  実行コンテクストが既に設定されていた場合、それを返します。 実行コンテクストが以前設定
               されたことがない場合、<info>true</info> を返します。 実行コンテクストを設定出来なかった場合、<info>false</info>
               を返し、 <info>E_WARNING</info> が発生します。


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

<comment>Param:</comment>
  <info>array</info>  <strong>$options</strong>  

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


id: phpdbg_prompt
type: function
doc:
<comment>Description:</comment>
  コマンドのプロンプトを設定する
  
  コマンドのプロンプトを、指定された <strong>$string</strong> に設定します。

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  コマンドのプロンプトとして使う文字列。

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

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


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

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


id: phpinfo
type: function
doc:
<comment>Description:</comment>
  PHP の設定情報を出力する
  
  現在の PHP の状態に関する、多くの情報を出力します。出力される情報には、 PHP コンパイルオプションと
  拡張モジュール、PHP のバージョン、 サーバー情報と環境（モジュールとしてコンパイルされた場合）、
  PHP の環境、OS バージョン情報、パス、構成オプションのマスター およびローカルの値、HTTP ヘッダ、PHP
  License などがあります。
  
  システムの設定はそれぞれ違うため、実行時設定 や 利用できる 定義済みの変数 を調べるために <strong>phpinfo()</strong>
  がよく使われます。
  
  また、<strong>phpinfo()</strong> には EGPCS (Environment, GET, POST, Cookie, Server) の情報が含まれているため、デ
  バッグツールとしても便利です。

<comment>Param:</comment>
  <info>int</info>  <strong>$flags</strong>  以下にあるconstantsビット値をひとつまたは 複数個を加算して、オプションの<strong>$flags</strong>引数に
               渡すことによって出力をカスタマイズできます。 それぞれの定数やビット値を ビット和演算
               子 で結んで渡すこともできます。
               
               <strong>phpinfo()</strong> のオプション名前(定数)値説明INFO_GENERAL1 configure オプション、php.ini の
               場所、ビルド日時、 Web サーバー、オペレーティングシステム等。 INFO_CREDITS2 PHP クレ
               ジット。<strong>phpcredits()</strong> も参照ください。 INFO_CONFIGURATION4 ローカルおよびマスタの、現
               在の PHP ディレクティブの値。 <strong>ini_get()</strong> も参照ください。 INFO_MODULES8 ロードされてい
               るモジュールと、それぞれの設定。 <strong>get_loaded_extensions()</strong> も参照ください。
               INFO_ENVIRONMENT16$_ENV で取得できる環境変数の情報。 INFO_VARIABLES32 EGPCS（環境変
               数・GET・POST・クッキー・サーバー変数）から すべての  定義済みの変数を表示します。
               INFO_LICENSE64 PHP ライセンス情報。ライセンス FAQ も参照ください。 INFO_ALL-1 上記の
               すべてを表示します。

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

<comment>See Also:</comment>
   * <strong>phpversion()</strong>
   * <strong>phpcredits()</strong>
   * <strong>ini_get()</strong>
   * <strong>ini_set()</strong>
   * <strong>get_loaded_extensions()</strong>
   * 定義済みの変数


id: phpversion
type: function
doc:
<comment>Description:</comment>
  現在の PHP バージョンを取得する
  
  現在動作中の PHP パーサあるいは拡張モジュールのバージョンを表す文字列を返します。

<comment>Param:</comment>
  <info>string|null</info>  <strong>$extension</strong>  オプションで指定する拡張モジュール名。

<comment>Return:</comment>
  <info>string|false</info>  現在の PHP のバージョンを文字列で返します。 オプションの <strong>$extension</strong> パラメータが文字
                列で指定されている場合、<strong>phpversion()</strong> はその拡張モジュールのバージョンを返します。 関
                連するバージョン情報が存在しない場合、 あるいは拡張モジュールが有効でない場合は
                <info>false</info> を返します。

<comment>See Also:</comment>
   * PHP_VERSION 定数
   * <strong>version_compare()</strong>
   * <strong>phpinfo()</strong>
   * <strong>phpcredits()</strong>
   * <strong>zend_version()</strong>


id: pi
type: function
doc:
<comment>Description:</comment>
  円周率の値を得る
  
  円周率の近似値を返します。 また、定数 <info>M_PI</info> を使用することで <strong>pi()</strong> とまったく同じ結果を取得すること
  も可能です。

<comment>Return:</comment>
  <info>float</info>  円周率の値を不動小数点数で返します。


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

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

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

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


id: popen
type: function
doc:
<comment>Description:</comment>
  プロセスへのファイルポインタをオープンする
  
  <strong>$command</strong> で指定したコマンドのフォークによってできたプロセスへのパイプをオープンします。

<comment>Param:</comment>
  <info>string</info>  <strong>$command</strong>  コマンド。
  <info>string</info>  <strong>$mode</strong>     モード。読み取りを行う場合は <return>'r'</return> を。 書き込みを行う場合は <return>'w'</return> を指定します。
                    
                    Windows では、<strong>popen()</strong> はデフォルトでテキストモードになります。 つまり、パイプか
                    ら <return>\n</return> 文字を読み込んだり、書き込んだりすると、 <return>\r\n</return> に変換されるということです。
                    この振る舞いを望まない場合は、 <strong>$mode</strong> にバイナリモードを指定し、強制することが出
                    来ます。 読み取りのバイナリモードは <return>'rb'</return> を。 書き込みのバイナリモードは<return>'wb'</return> を
                    それぞれ指定します。

<comment>Return:</comment>
  <info>resource|false</info>  <strong>fopen()</strong> により返されたファイルポインタと同様のものを返しますが、 それは(読み書きの
                  いずれか一方でのみ使われる)片方向ストリームであり、 <strong>pclose()</strong> によりクローズされな
                  ければならないところが異なります。 このポインタは、<strong>fgets()</strong>、<strong>fgetss()</strong> および
                  <strong>fwrite()</strong> のいずれかで使うことができます。 モードが 'r' のときは、返されるファイル
                  ポインタは そのコマンドの STDOUT と等しくなります。また、モードが 'w' のときは、返
                  されるファイルポインタは そのコマンドの STDIN と等しくなります。
                  
                  エラーが発生した場合は <info>false</info> を返します。

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


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


id: posix_access
type: function
doc:
<comment>Description:</comment>
  ファイルのアクセス権限を判断する
    
  
  <strong>posix_access()</strong> は、ファイルに対するユーザーの アクセス権限を調べます。

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  調べるファイルの名前。
  <info>int</info>     <strong>$flags</strong>     <info>POSIX_F_OK</info>、<info>POSIX_R_OK</info>、 <info>POSIX_W_OK</info> および <info>POSIX_X_OK</info> のうちのひとつあるいは複
                     数からなるマスク。
                     
                     <info>POSIX_R_OK</info>、<info>POSIX_W_OK</info> および <info>POSIX_X_OK</info> は、ファイルが存在して読み込み/書き込
                     み/ 実行の権限があるかどうかを調べます。 <info>POSIX_F_OK</info> は単にファイルが存在するか
                     どうか だけを調べます。

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

<comment>See Also:</comment>
   * <strong>posix_get_last_error()</strong>
   * <strong>posix_strerror()</strong>


id: posix_ctermid
type: function
doc:
<comment>Description:</comment>
  制御する端末のパス名を得る
  
  そのプロセスで現在制御している端末のパス名を表す文字列を作成します。 エラーが発生した場合は errno
  を設定します。この値を調べるには <strong>posix_get_last_error()</strong> を使用します。

<comment>Return:</comment>
  <info>string|false</info>  処理に成功した場合は、現在制御している端末のパス名を表す文字列を返します。 それ以外
                の場合は <info>false</info> を返し、errno を設定します。 この値を調べるには
                <strong>posix_get_last_error()</strong> を使用します。

<comment>See Also:</comment>
   * <strong>posix_ttyname()</strong>
   * <strong>posix_get_last_error()</strong>


id: posix_eaccess
type: function
doc:
<comment>Description:</comment>
  ファイルがアクセスできるかを調べる
    
  
  <strong>posix_eaccess()</strong> は、ファイルの実効ユーザーのパーミッションを調べます。

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  調べるファイル名
  <info>int</info>     <strong>$flags</strong>     <info>POSIX_F_OK</info>, <info>POSIX_R_OK</info>, <info>POSIX_W_OK</info>, <info>POSIX_X_OK</info> のうち、ひとつ以上のビットマスク
                     の組み合わせです。
                     
                     <info>POSIX_R_OK</info>, <info>POSIX_W_OK</info>, <info>POSIX_X_OK</info> についてはそれぞれ、 ファイルが存在し読み取
                     り可能、ファイルが存在し書き込み可能、 ファイルが存在し実行可能という意味になり
                     ます。 <info>POSIX_F_OK</info> は、 ファイルが存在するかどうかだけを調べます。

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

<comment>See Also:</comment>
   * <strong>posix_get_last_error()</strong>
   * <strong>posix_strerror()</strong>
   * <strong>posix_access()</strong>


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


id: posix_fpathconf
type: function
doc:
<comment>Description:</comment>
  設定可能なリミットの値を返す
  
  ファイルディスクリプタ <strong>$resource</strong> の <strong>$name</strong> から、 設定可能なリミットの値を返します。

<comment>Param:</comment>
  <info>resource|int</info>  <strong>$file_descriptor</strong>  ファイル記述子。ファイルリソースか、あるいは <info>int</info> で指定します。
                                  <info>int</info> を指定した場合は、システムコールにそのまま渡せるファイル記述子
                                  だとみなします。
  <info>int</info>           <strong>$name</strong>             設定可能なリミットの名前。 以下のうちのひとつを指定します。
                                  <info>POSIX_PC_LINK_MAX</info>, <info>POSIX_PC_MAX_CANON</info> <info>POSIX_PC_MAX_INPUT</info>,
                                  <info>POSIX_PC_NAME_MAX</info> <info>POSIX_PC_PATH_MAX</info>, <info>POSIX_PC_PIPE_BUF</info>
                                  <info>POSIX_PC_CHOWN_RESTRICTED</info>, <info>POSIX_PC_NO_TRUNC</info>
                                  <info>POSIX_PC_ALLOC_SIZE_MIN</info>, <info>POSIX_PC_SYMLINK_MAX</info>

<comment>Return:</comment>
  <info>int|false</info>  設定可能なリミットの値、または <info>false</info> を返します。

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


id: posix_get_last_error
type: function
doc:
<comment>Description:</comment>
  直近で失敗した posix 関数が設定したエラー番号を取得する
  
  直近で失敗した posix 関数が設定したエラー番号を取得します。 エラー番号に対応するエラーメッセージを
  取得するには <strong>posix_strerror()</strong> を使用します。

<comment>Return:</comment>
  <info>int</info>  直近で失敗した posix 関数が設定した errno (エラー番号) を返します。 エラーが発生していない場
       合は 0 が返されます。

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


id: posix_getcwd
type: function
doc:
<comment>Description:</comment>
  現在のディレクトリのパス名
  
  スクリプトの現在の実行ディレクトリのパスを、絶対パスで取得します。 エラー時には errno を設定しま
  す。この値は <strong>posix_get_last_error()</strong> で取得することができます。

<comment>Return:</comment>
  <info>string|false</info>  絶対パスを表す文字列を返します。 エラー時には <info>false</info> を返し、errno を設定します。この
                値は <strong>posix_get_last_error()</strong> で取得することができます。


id: posix_getegid
type: function
doc:
<comment>Description:</comment>
  現在のプロセスの有効なグループ ID を返す
  
  現在のプロセスの有効なグループ ID を返します。

<comment>Return:</comment>
  <info>int</info>  実効グループ ID を表す整数値を返します。

<comment>See Also:</comment>
   * <strong>posix_getgrgid()</strong>
   * <strong>posix_getgid()</strong>
   * <strong>posix_setgid()</strong>


id: posix_geteuid
type: function
doc:
<comment>Description:</comment>
  現在のプロセスの有効なユーザー ID を返す
  
  現在のプロセスの有効なユーザー ID を返します。 使用可能なユーザー名に変換する方法に関する情報につ
  いては、 <strong>posix_getpwuid()</strong> も参照ください。

<comment>Return:</comment>
  <info>int</info>  ユーザー ID を表す整数値を返します。

<comment>See Also:</comment>
   * <strong>posix_getpwuid()</strong>
   * <strong>posix_getuid()</strong>
   * <strong>posix_setuid()</strong>
   * POSIX man ページ GETEUID(2)


id: posix_getgid
type: function
doc:
<comment>Description:</comment>
  現在のプロセスの実際のグループ ID を返す
  
  現在のプロセスの実際のグループ ID を返します。

<comment>Return:</comment>
  <info>int</info>  実際のグループ ID を表す整数値を返します。

<comment>See Also:</comment>
   * <strong>posix_getgrgid()</strong>
   * <strong>posix_getegid()</strong>
   * <strong>posix_setgid()</strong>
   * POSIX man ページ GETGID(2)


id: posix_getgrgid
type: function
doc:
<comment>Description:</comment>
  指定したグループ ID を有するグループに関する情報を返す
  
  指定した ID のグループに関する情報を取得します。

<comment>Param:</comment>
  <info>int</info>  <strong>$group_id</strong>  グループ ID。

<comment>Return:</comment>
  <info>array|false</info>  以下の要素を持つ配列を返します。 グループ情報の配列要素説明name グループ名。これは、
               16 文字以下の短い文字列からなる 「ハンドル」であり、実際の完全な名前とは異なります。
               passwd グループのパスワードを暗号化したもの。 システムが「シャドー」パスワードを使用
               している場合は、 ここではアスタリスクが返されます。 gid グループ ID。この関数をコール
               する際に指定した <strong>$group_id</strong> と同じものになるので、冗長なデータです。 members このグ
               ループに属する全メンバーを表す文字列の配列。  この関数は、失敗時に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>posix_getegid()</strong>
   * <strong>posix_getgrnam()</strong>
   * <strong>filegroup()</strong>
   * <strong>stat()</strong>
   * POSIX man ページ GETGRNAM(3)


id: posix_getgrnam
type: function
doc:
<comment>Description:</comment>
  指定した名前のグループに関する情報を返す
  
  指定した名前のグループに関する情報を取得します。

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  グループの名前。

<comment>Return:</comment>
  <info>array|false</info>  成功したときは <info>array</info> を返します。失敗した場合に <info>false</info> を返します。 配列で返される要素
               は下記のとおりです。 グループ情報の配列要素説明name グループ名。これは、16 文字以下の
               短い文字列からなる 「ハンドル」であり、実際の完全な名前とは異なります。 グループ ID。
               この関数をコールする際に指定した <strong>$name</strong> と同じものになるので、冗長なデータです。
               passwd グループのパスワードを暗号化したもの。 システムが「シャドー」パスワードを使用
               している場合は、 ここではアスタリスクが返されます。 gid グループ ID を表す数値。
               members このグループに属する全メンバーを表す文字列の配列。

<comment>See Also:</comment>
   * <strong>posix_getegid()</strong>
   * <strong>posix_getgrgid()</strong>
   * <strong>filegroup()</strong>
   * <strong>stat()</strong>
   * POSIX man ページ GETGRNAM(3)


id: posix_getgroups
type: function
doc:
<comment>Description:</comment>
  現在のプロセスのグループセットを返す
  
  現在のプロセスのグループセットを取得します。

<comment>Return:</comment>
  <info>array|false</info>  現在のプロセスのグループセットについて、 グループ ID を表す整数値を含む配列を返しま
               す。 失敗した場合に <info>false</info> を返します

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


id: posix_getlogin
type: function
doc:
<comment>Description:</comment>
  ログイン名を返す
  
  現在のプロセスを所有するユーザーのログイン名を返します。

<comment>Return:</comment>
  <info>string|false</info>  ユーザーのログイン名を文字列で返します。 失敗した場合に <info>false</info> を返します

<comment>See Also:</comment>
   * <strong>posix_getpwnam()</strong>
   * POSIX man ページ GETLOGIN(3)


id: posix_getpgid
type: function
doc:
<comment>Description:</comment>
  ジョブ制御のプロセスグループ ID を得る
  
  プロセス <strong>$process_id</strong> のプロセスグループ ID を返します。失敗した場合に <info>false</info> を返します。

<comment>Param:</comment>
  <info>int</info>  <strong>$process_id</strong>  プロセス ID。

<comment>Return:</comment>
  <info>int|false</info>  ID を表す整数値を返します。

<comment>See Also:</comment>
   * <strong>posix_getppid()</strong>
   * man ページ SETPGID(2)


id: posix_getpgrp
type: function
doc:
<comment>Description:</comment>
  現在のプロセスのグループ ID を返す
  
  現在のプロセスのグループ ID を返します。

<comment>Return:</comment>
  <info>int</info>  ID を表す整数値を返します。

<comment>See Also:</comment>
   * 
     プロセスグループの詳細な情報に関しては、POSIX.1 および
     POSIX システムのマニュアルページ getpgrp(2) を参照ください。
    


id: posix_getpid
type: function
doc:
<comment>Description:</comment>
  現在のプロセス ID を返す
  
  現在のプロセスのプロセス ID を返します。

<comment>Return:</comment>
  <info>int</info>  ID を表す整数値を返します。

<comment>See Also:</comment>
   * <strong>posix_kill()</strong>
   * POSIX man ページ GETPID(2)


id: posix_getppid
type: function
doc:
<comment>Description:</comment>
  親プロセスの ID を返す
  
  現在のプロセスの親プロセスの ID を返します。

<comment>Return:</comment>
  <info>int</info>  ID を表す整数値を返します。


id: posix_getpwnam
type: function
doc:
<comment>Description:</comment>
  指定した名前のユーザーに関する情報を返す
  
  指定したユーザーに関する情報を配列で返します。

<comment>Param:</comment>
  <info>string</info>  <strong>$username</strong>  英数字で表したユーザー名。

<comment>Return:</comment>
  <info>array|false</info>  成功した場合は次の要素を持つ配列、それ以外の場合は <info>false</info> を返します。 ユーザー情報配
               列要素説明name 要素 name はユーザー名を有しています。これは、通常、 実際の完全な名前
               ではなく16文字未満のユーザーの"ハンドル名"となります。 この値はこの関数をコールした際
               に使用したパラメータ <strong>$username</strong>と同じとする必要があり、 このため冗長な定義となります。
               passwd 要素passwd には暗号化されたユーザーのパスワードが含まれます。 シャドウパスワー
               ドを使用しているシステムでは、アスタリスクが代わりに 返されます。 uid 数値形式で表し
               たユーザー ID。 gid ユーザーのグループ ID。 実際のグループ名を調べたりそのグループの
               メンバーの一覧を 得るには関数 <strong>posix_getgrgid()</strong> を使用してください。 gecos GECOS は旧
               式の項であり、Honeywell バッチ処理プログラムの finger 情報フィールドを参照します。 し
               かし、このフィールドはまだ生きており、その内容はPOSIXで 規定されています。 このフィー
               ルドには、カンマで区切られた ユーザーのフルネーム、オフィスの電話番号、家の電話番号に
               関する リストが含まれています。多くのシステムでは、ユーザーのフルネーム のみが利用可
               能です。 dir この要素には、ユーザーのホームディレクトリへの絶対パスが含まれています。
               shell shell 要素には、ユーザーのデフォルトシェルの実行ファイルへの絶対パスが 含まれて
               います。

<comment>See Also:</comment>
   * <strong>posix_getpwuid()</strong>
   * POSIX man ページ GETPWNAM(3)


id: posix_getpwuid
type: function
doc:
<comment>Description:</comment>
  指定 ID のユーザーに関する情報を返す
  
  指定したユーザー ID のユーザーについての情報を配列で返します。

<comment>Param:</comment>
  <info>int</info>  <strong>$user_id</strong>  ユーザー ID。

<comment>Return:</comment>
  <info>array|false</info>  返される連想配列の要素は次のようになります。 ユーザー情報配列要素説明name 要素 name
               はユーザー名を有しています。これは、通常、 実際の完全な名前ではなく16文字未満のユー
               ザーの"ハンドル名"となります。 passwd 要素passwd には暗号化されたユーザーのパスワード
               が含まれます。 シャドウパスワードを使用しているシステムでは、アスタリスクが代わりに
               返されます。 uid ユーザーID。これは、この関数をコールする際に使用するパラメータ
               <strong>$user_id</strong>と同じとなり、このため冗長になります。 gid ユーザーのグループID。 実際のグ
               ループ名を調べたりそのグループのメンバーの一覧を 得るには関数<strong>posix_getgrgid()</strong>を使用し
               てください。 gecos GECOS は旧式の項であり、Honeywell バッチ処理プログラムの finger 情
               報フィールドを参照します。 しかし、このフィールドはまだ生きており、その内容はPOSIXで
               規定されています。 このフィールドには、カンマで区切られた ユーザーのフルネーム、オ
               フィスの電話番号、家の電話番号に関する リストが含まれています。多くのシステムでは、
               ユーザーのフルネーム のみが利用可能です。 dir この要素には、ユーザーのホームディレク
               トリへの絶対パスが含まれています。 shell shell 要素には、ユーザーのデフォルトシェルの
               実行ファイルへの絶対パスが 含まれています。  この関数は、失敗時に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>posix_getpwnam()</strong>
   * POSIX man ページ GETPWNAM(3)


id: posix_getrlimit
type: function
doc:
<comment>Description:</comment>
  システムリソース制限に関する情報を返す
  
  <strong>posix_getrlimit()</strong> は、 現在のリソースにおけるソフトリミットおよびハードリミットを配列で返します。
  
  各リソースには、それぞれソフトリミットとハードリミットがあります。 ソフトリミットとは、そのリソー
  スに対してカーネルが課す制限値のことです。 ハードリミットとは、ソフトリミットの上限値のことです。
  特権を持たないプロセスは、ソフトリミットの値を 0 からハードリミット値の間で設定することが可能で
  す。 また、ハードリミットの値を下げることもできます。

<comment>Param:</comment>
  <info>int|null</info>  <strong>$resource</strong>  <info>null</info> の場合、全てのリソースリミットを取得します。 <info>null</info> でない場合、指定された
                       リソースタイプのリミットのみを返します。

<comment>Return:</comment>
  <info>array|false</info>  各リソースに関する制限値を含む連想配列を返します。 個々のリミット値には、ソフトリミッ
               トとハードリミットがあります。 返される制限の一覧制限の名前制限についての説明core コ
               アファイルの最大サイズ。0 の場合はコアファイルを作成しません。 コアファイルのサイズが
               この値を超えると、 このサイズまで切り詰められます。 totalmem プロセスのメモリの最大サ
               イズを表すバイト数。 virtualmem プロセスの仮想メモリの最大サイズを表すバイト数。 data
               プロセスのデータセグメントの最大サイズを表すバイト数。 stack プロセスのスタックの最大
               サイズを表すバイト数。 rss RAM 上の仮想ページの最大数。 maxproc 呼び出し元のプロセス
               の実ユーザー ID で作成できるプロセスの最大数。 memlock RAM 内にロックできるメモリの最
               大バイト数。 cpu そのプロセスが使用できる CPU 時間。 filesize そのプロセスが使用でき
               るデータセグメントの最大サイズを表すバイト数。 openfiles オープンできるファイル記述子
               の最大値よりひとつ大きい値。  この関数は、失敗時に <info>false</info> を返します。

<comment>See Also:</comment>
   * man ページ GETRLIMIT(2)
   * <strong>posix_setrlimit()</strong>


id: posix_getsid
type: function
doc:
<comment>Description:</comment>
  プロセスの現在の sid を得る
  
  プロセス <strong>$process_id</strong> のセッション ID を返します。 プロセスのセッション ID とは、セッションリーダー
  のプロセスグループ ID のことです。

<comment>Param:</comment>
  <info>int</info>  <strong>$process_id</strong>  プロセス ID。0 を指定すると、現在のプロセスとみなされます。 不正な <strong>$process_id</strong>
                    を指定すると、 <info>false</info> が返され、 <strong>posix_get_last_error()</strong> でチェックできるエラー情
                    報が設定されます。

<comment>Return:</comment>
  <info>int|false</info>  ID を表す整数値を返します。 失敗した場合に <info>false</info> を返します

<comment>See Also:</comment>
   * <strong>posix_getpgid()</strong>
   * <strong>posix_setsid()</strong>
   * POSIX man ページ GETSID(2)


id: posix_getuid
type: function
doc:
<comment>Description:</comment>
  現在のプロセスの実際のユーザー ID を返す
  
  現在のプロセスの実際のユーザー ID を返します。

<comment>Return:</comment>
  <info>int</info>  ID を表す整数値を返します。

<comment>See Also:</comment>
   * <strong>posix_getpwuid()</strong>
   * POSIX man ページ GETUID(2)


id: posix_initgroups
type: function
doc:
<comment>Description:</comment>
  グループアクセスリストを求める
  
  指定した名前のユーザーについてのグループアクセスリストを求めます。

<comment>Param:</comment>
  <info>string</info>  <strong>$username</strong>  リストを取得したいユーザー。
  <info>int</info>     <strong>$group_id</strong>  パスワードファイルから取得したグループ番号。

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

<comment>See Also:</comment>
   * Unix の initgroups(3) のマニュアル


id: posix_isatty
type: function
doc:
<comment>Description:</comment>
  ファイル記述子が対話型端末であるかどうかを定義する
  
  ファイル記述子 <strong>$file_descriptor</strong> が、 有効な端末デバイスを指しているかどうかを調べます。

<comment>Param:</comment>
  <info>resource|int</info>  <strong>$file_descriptor</strong>  ファイル記述子。ファイルリソースか、あるいは <info>int</info> で指定します。
                                  <info>int</info> を指定した場合は、システムコールにそのまま渡せるファイル記述子
                                  だとみなします。

<comment>Return:</comment>
  <info>bool</info>  <strong>$file_descriptor</strong> がオープンされており、 かつ端末に接続されている場合に <info>true</info>、 それ以外の場合
        に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>posix_ttyname()</strong>
   * <strong>stream_isatty()</strong>


id: posix_kill
type: function
doc:
<comment>Description:</comment>
  プロセスにシグナルを送信する
  
  シグナル <strong>$signal</strong> をプロセス ID <strong>$process_id</strong> のプロセスに送信します。

<comment>Param:</comment>
  <info>int</info>  <strong>$process_id</strong>  プロセス ID。
  <info>int</info>  <strong>$signal</strong>      PCNTL シグナル定数 のいずれか。

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

<comment>See Also:</comment>
   * 
     POSIX システムの kill(2) マニュアルページも参照ください。
     そこには、負のプロセスID、特別プロセスID 0、特別プロセスID -1、
     シグナル番号 0 に関する追加情報があります。
    


id: posix_mkfifo
type: function
doc:
<comment>Description:</comment>
  fifo スペシャルファイル(名前付きパイプ)を作成する
  
  <strong>posix_mkfifo()</strong> は、 <return>FIFO</return> スペシャルファイルを作成します。 これはファイルシステム内に存在し、プロセ
  ス間の双方向通信の末端として 動作します。

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>     <return>FIFO</return> ファイルへのパス。
  <info>int</info>     <strong>$permissions</strong>  2 番目のパラメータ <strong>$permissions</strong> は、8 進表記 (例: 0644)で指定する必要があり
                        ます。新しく作成される <return>FIFO</return> のパーミッションは、現在の <strong>umask()</strong> の設定にも依
                        存します。 作成されるファイルのパーミッションは (mode & ~umask) となります。

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


id: posix_mknod
type: function
doc:
<comment>Description:</comment>
  スペシャルファイルあるいは通常のファイルを作成する (POSIX.1)
  
  スペシャルファイルあるいは通常のファイルを作成します。

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  作成するファイル。
  <info>int</info>     <strong>$flags</strong>     このパラメータは、ファイル型(以下の定数 <info>POSIX_S_IFREG</info>、 <info>POSIX_S_IFCHR</info>、
                     <info>POSIX_S_IFBLK</info>、 <info>POSIX_S_IFIFO</info> あるいは <info>POSIX_S_IFSOCK</info> のうちのひとつ) および
                     パーミッションの論理和で構成されます。
  <info>int</info>     <strong>$major</strong>     メジャーデバイスカーネル ID (<info>S_IFCHR</info> あるいは <info>S_IFBLK</info> を使用している場合に渡す
                     必要があります)。
  <info>int</info>     <strong>$minor</strong>     マイナーデバイスカーネル ID。

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

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


id: posix_pathconf
type: function
doc:
<comment>Description:</comment>
  設定可能なリミットの値を返す
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。
  
  <strong>$file</strong> の <strong>$name</strong> から、設定可能なリミットの値を返します。

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>  リミットを取得したいファイル名
  <info>int</info>     <strong>$name</strong>  設定可能なリミットの名前。 以下のうちの一つを指定します。 <info>POSIX_PC_LINK_MAX</info>,
                 <info>POSIX_PC_MAX_CANON</info> <info>POSIX_PC_MAX_INPUT</info>, <info>POSIX_PC_NAME_MAX</info> <info>POSIX_PC_PATH_MAX</info>,
                 <info>POSIX_PC_PIPE_BUF</info> <info>POSIX_PC_CHOWN_RESTRICTED</info>, <info>POSIX_PC_NO_TRUNC</info>
                 <info>POSIX_PC_ALLOC_SIZE_MIN</info>, <info>POSIX_PC_SYMLINK_MAX</info>

<comment>Return:</comment>
  <info>int|false</info>  設定可能なリミットの値、または <info>false</info> を返します。

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


id: posix_setegid
type: function
doc:
<comment>Description:</comment>
  現在のプロセスの実効 GID を設定する
  
  現在のプロセスの実効グループ ID を設定します。 この関数は特権関数であり、実行するにはシステム上に
  おいて適当な権限 (通常は root) が必要です。

<comment>Param:</comment>
  <info>int</info>  <strong>$group_id</strong>  グループ ID。

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

<comment>See Also:</comment>
   * <strong>posix_getgrgid()</strong>
   * <strong>posix_getgid()</strong>
   * <strong>posix_setgid()</strong>


id: posix_seteuid
type: function
doc:
<comment>Description:</comment>
  現在のプロセスの実効 UID を設定する
  
  現在のプロセスの実効ユーザー ID を設定します。 この関数は特権関数であり、実行するにはシステム上に
  おいて適当な権限 (通常は root) が必要です。

<comment>Param:</comment>
  <info>int</info>  <strong>$user_id</strong>  ユーザー ID。

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

<comment>See Also:</comment>
   * <strong>posix_geteuid()</strong>
   * <strong>posix_setgid()</strong>
   * <strong>posix_getuid()</strong>


id: posix_setgid
type: function
doc:
<comment>Description:</comment>
  現在のプロセスの GID を設定する
  
  現在のプロセスのグループ ID を設定します。 この関数は特権関数であり、実行するにはシステム上におい
  て適当な権限 (通常は root) が必要です。 <strong>posix_setgid()</strong> を最初に、 <strong>posix_setuid()</strong> を最後にコールす
  るのが、 関数コールの正しい順序となります。
  
  コール元がスーバーユーザーの場合は、実効グループ ID も設定します。

<comment>Param:</comment>
  <info>int</info>  <strong>$group_id</strong>  グループ ID。

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

<comment>See Also:</comment>
   * <strong>posix_getgrgid()</strong>
   * <strong>posix_getgid()</strong>


id: posix_setpgid
type: function
doc:
<comment>Description:</comment>
  ジョブ制御のプロセスグループ ID を設定する
  
  プロセス <strong>$process_id</strong> をプロセスグループ <strong>$process_group_id</strong> に加えます。

<comment>Param:</comment>
  <info>int</info>  <strong>$process_id</strong>        プロセス ID。
  <info>int</info>  <strong>$process_group_id</strong>  プロセスグループ ID。

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

<comment>See Also:</comment>
   * 
     プロセスグループおよびジョブ制御に関する詳細は、
     POSIX.1 および POSIX システムのマニュアルページ setsid(2)
     を参照ください。
    


id: posix_setrlimit
type: function
doc:
<comment>Description:</comment>
  システムリソース制限を設定
  
  <strong>posix_setrlimit()</strong> は、 指定されたシステムリソースに対してソフトリミットおよびハードリミットを設定
  します。
  
  各リソースには、それぞれソフトリミットとハードリミットがあります。 ソフトリミットとは、そのリソー
  スに対してカーネルが課す制限値のことです。 ハードリミットとは、ソフトリミットの上限値のことです。
  特権を持たないプロセスは、ソフトリミットの値を 0 からハードリミット値の間で設定することが可能で
  す。 また、ハードリミットの値を下げることもできます。

<comment>Param:</comment>
  <info>int</info>  <strong>$resource</strong>    設定されるリミットに対応するリソースリミット定数です。
  <info>int</info>  <strong>$soft_limit</strong>  ソフトリミット、単位は、リソース制限が必要とする任意の単位です。または、
                    <info>POSIX_RLIMIT_INFINITY</info> です。
  <info>int</info>  <strong>$hard_limit</strong>  ハードリミット、単位は、リソース制限が必要とする任意の単位です。または、
                    <info>POSIX_RLIMIT_INFINITY</info> です。

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

<comment>See Also:</comment>
   * man ページ SETRLIMIT(2)
   * <strong>posix_getrlimit()</strong>


id: posix_setsid
type: function
doc:
<comment>Description:</comment>
  現在のプロセスをセッションリーダーにする
  
  現在のプロセスをセッションリーダーにします。

<comment>Return:</comment>
  <info>int</info>  セッション ID、あるいはエラー時に -1 を返します。

<comment>See Also:</comment>
   * 
     プロセスグループおよびジョブ制御に関する詳細は、
     POSIX.1 および POSIX システムのマニュアルページ setsid(2)
     を参照ください。
    


id: posix_setuid
type: function
doc:
<comment>Description:</comment>
  現在のプロセスの UID を設定する
  
  現在のプロセスの実際のユーザー ID を設定します。 この関数は特権関数であり、実行するにはシステム上
  において適当な権限 (通常は root) が必要です。

<comment>Param:</comment>
  <info>int</info>  <strong>$user_id</strong>  ユーザー ID。

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

<comment>See Also:</comment>
   * <strong>posix_setgid()</strong>
   * <strong>posix_seteuid()</strong>
   * <strong>posix_getuid()</strong>
   * <strong>posix_geteuid()</strong>


id: posix_strerror
type: function
doc:
<comment>Description:</comment>
  指定したエラー番号に対応するシステムのエラーメッセージを取得する
  
  指定したエラー番号 <strong>$error_code</strong> に対応する POSIX システムエラーメッセージを返します。 <strong>$error_code</strong>
  を取得するには、 <strong>posix_get_last_error()</strong> をコールします。

<comment>Param:</comment>
  <info>int</info>  <strong>$error_code</strong>  <strong>posix_get_last_error()</strong> が返す POSIX エラー番号。0 に設定すると、文字列 "Success"
                    が返されます。

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

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


id: posix_sysconf
type: function
doc:
<comment>Description:</comment>
  システムの実行時情報を返す
  
  システムの実行時情報を返します。

<comment>Param:</comment>
  <info>int</info>  <strong>$conf_id</strong>  値の識別子を、以下の定数で指定します。 <info>POSIX_SC_ARG_MAX</info>, <info>POSIX_SC_PAGESIZE</info>
                 <info>POSIX_SC_NPROCESSORS_CONF</info>, <info>POSIX_SC_NPROCESSORS_ONLN</info>

<comment>Return:</comment>
  <info>int</info>  <strong>$conf_id</strong> に関連する数値の値を返します。


id: posix_times
type: function
doc:
<comment>Description:</comment>
  プロセス時間を得る
  
  現在の CPU 使用状況についての情報を取得します。

<comment>Return:</comment>
  <info>array|false</info>  現在のプロセスの CPU 使用状況に関する情報を表す文字列を連想配列 として返します。連想
               配列のキーは次のようになります。  ticks - リブートからの経過クロック数。  utime - 現
               在のプロセスにより使用されているユーザー時間。  stime - 現在のプロセスにより使用され
               ているシステム時間。  cutime - 現在のプロセスおよび子プロセスにより使用されているユー
               ザー時間。  cstime - 現在のプロセスおよび子プロセスにより使用されているシステム時間。
               この関数は、失敗時に <info>false</info> を返します。
               
               ticks - リブートからの経過クロック数。
               
               utime - 現在のプロセスにより使用されているユーザー時間。
               
               stime - 現在のプロセスにより使用されているシステム時間。
               
               cutime - 現在のプロセスおよび子プロセスにより使用されているユーザー時間。
               
               cstime - 現在のプロセスおよび子プロセスにより使用されているシステム時間。


id: posix_ttyname
type: function
doc:
<comment>Description:</comment>
  端末のデバイス名を調べる
  
  ファイル記述子 <strong>$file_descriptor</strong> 上でオープンしている現在の端末デバイスへの絶対パスを文字列で返しま
  す。

<comment>Param:</comment>
  <info>resource|int</info>  <strong>$file_descriptor</strong>  ファイル記述子。ファイルリソースか、あるいは <info>int</info> で指定します。
                                  <info>int</info> を指定した場合は、システムコールにそのまま渡せるファイル記述子
                                  だとみなします。

<comment>Return:</comment>
  <info>string|false</info>  成功した場合に <strong>$file_descriptor</strong> の絶対パスを表す文字列、 失敗した場合に <info>false</info> を返し
                ます。

<comment>See Also:</comment>
   * <strong>posix_isatty()</strong>
   * <strong>stream_isatty()</strong>


id: posix_uname
type: function
doc:
<comment>Description:</comment>
  システム名を得る
  
  システムについての情報を取得します。
  
  POSIX では、値のフォーマットに関して何の仮定も設けないことを規定しています。 例えば、バージョン番
  号が 3 桁の数字であることや、 この関数により返されるその他のものに依存してはいけません。

<comment>Return:</comment>
  <info>array|false</info>  システムに関する情報を文字列の連想配列として返します。 連想配列のキーは、次のようにな
               ります。  sysname - オペレーティングシステムの名前 (例 Linux)  nodename - システムの
               名前 (例 valiant)  release - オペレーティングシステムのリリース (例 2.2.10)  version
               - オペレーティングシステムのバージョン (例 #4 Tue Jul 20 17:01:36 MEST 1999)  machine
               - システムアーキテクチャ (例 i586)  domainname - DNS ドメイン名 (例 example.com)
               
               sysname - オペレーティングシステムの名前 (例 Linux)
               
               nodename - システムの名前 (例 valiant)
               
               release - オペレーティングシステムのリリース (例 2.2.10)
               
               version - オペレーティングシステムのバージョン (例 #4 Tue Jul 20 17:01:36 MEST 1999)
               
               machine - システムアーキテクチャ (例 i586)
               
               domainname - DNS ドメイン名 (例 example.com)
               
               domainname は、GNU の拡張機能で POSIX.1 には含まれていません。 このため、このフィール
               ドは GNU システム上または GNU libc を使用している場合にのみ使用可能です。
               
               この関数は、失敗時に <info>false</info> を返します。


id: pow
type: function
doc:
<comment>Description:</comment>
  指数表現
  
  <strong>$num</strong> の <strong>$exponent</strong> 乗を返します。
  
  ** 演算子も使えます。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$num</strong>       使用する基数。
  <info>mixed</info>  <strong>$exponent</strong>  指数。

<comment>Return:</comment>
  <info>int|float|object</info>  <strong>$num</strong> の <strong>$exponent</strong> 乗を返します。 両方の引数が非負の整数で、かつ結果が <info>int</info> 型の範
                    囲に収まる場合は、結果を <info>int</info> 型で返します。 それ以外の場合は結果を <info>float</info> 型で返
                    します。

<comment>See Also:</comment>
   * <strong>exp()</strong>
   * <strong>sqrt()</strong>
   * <strong>bcpow()</strong>
   * <strong>gmp_pow()</strong>


id: preg_filter
type: function
doc:
<comment>Description:</comment>
  正規表現による検索と置換を行う
  
  <strong>preg_filter()</strong> は <strong>preg_replace()</strong> と似ていますが、マッチした結果 (を変換したもの) のみを返します。
  この関数の挙動の詳細については <strong>preg_replace()</strong> のドキュメントを参照ください。

<comment>Return:</comment>
  <info>string|array|null</info>  <strong>$subject</strong> が配列の場合は配列を、それ以外の場合は文字列を返します。
                     
                     マッチする結果が見つからなかったりエラーが発生したりした場合は、 <strong>$subject</strong> が
                     <info>array</info> なら空の配列を返し、そうでなければ <info>null</info> を返します。

<comment>See Also:</comment>
   * PCRE のパターン
   * <strong>preg_quote()</strong>
   * <strong>preg_replace()</strong>
   * <strong>preg_replace_callback()</strong>
   * <strong>preg_grep()</strong>
   * <strong>preg_last_error()</strong>


id: preg_grep
type: function
doc:
<comment>Description:</comment>
  パターンにマッチする配列の要素を返す
  
  <strong>$array</strong> 配列の要素のうち、 指定した <strong>$pattern</strong> にマッチするものを要素とする配列を返します。

<comment>Param:</comment>
  <info>string</info>  <strong>$pattern</strong>  検索するパターンを表す文字列。
  <info>array</info>   <strong>$array</strong>    入力の配列。
  <info>int</info>     <strong>$flags</strong>    <info>PREG_GREP_INVERT</info> を設定すると、この関数は 与えた <strong>$pattern</strong> にマッチ しない 要素を
                    返します。

<comment>Return:</comment>
  <info>array|false</info>  <strong>$array</strong> 配列のキーを使用した配列を返します。 失敗した場合に <info>false</info> を返します

<comment>See Also:</comment>
   * PCRE のパターン
   * <strong>preg_quote()</strong>
   * <strong>preg_match_all()</strong>
   * <strong>preg_filter()</strong>
   * <strong>preg_last_error()</strong>


id: preg_last_error
type: function
doc:
<comment>Description:</comment>
  直近の PCRE 正規表現処理のエラーコードを返す
  
  直近の PCRE 正規表現処理のエラーコードを返します。
  
  <strong>preg_last_error()</strong> の例
  ]]>上の例の出力は以下となります。
  
  上の例の出力は以下となります。

<comment>Return:</comment>
  <info>int</info>  以下の定数のいずれかを返します (別のページで説明します)。
       <info>PREG_NO_ERROR</info><info>PREG_INTERNAL_ERROR</info><info>PREG_BACKTRACK_LIMIT_ERROR</info> (pcre.backtrack_limit も参照くださ
       い)<info>PREG_RECURSION_LIMIT_ERROR</info> (pcre.recursion_limit も参照くださ
       い)<info>PREG_BAD_UTF8_ERROR</info><info>PREG_BAD_UTF8_OFFSET_ERROR</info><info>PREG_JIT_STACKLIMIT_ERROR</info>

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


id: preg_last_error_msg
type: function
doc:
<comment>Description:</comment>
  最後に実行した PCRE 正規表現に関するエラーメッセージを返す
  
  最後に実行した PCRE 正規表現に関するエラーメッセージを返します。

<comment>Return:</comment>
  <info>string</info>  成功した場合はエラーメッセージを返します。 エラーが起きていない場合は、<return>"No error"</return> を返しま
          す。

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


id: preg_match
type: function
doc:
<comment>Description:</comment>
  正規表現によるマッチングを行う
  
  <strong>$pattern</strong> で指定した正規表現により <strong>$subject</strong> を検索します。

<comment>Param:</comment>
  <info>string</info>  <strong>$pattern</strong>  検索するパターンを表す文字列。
  <info>string</info>  <strong>$subject</strong>  入力文字列。
  <info>array</info>   <strong>$matches</strong>  <strong>$matches</strong> を指定した場合、検索結果が代入されます。 $matches[0] にはパターン全体に
                    マッチしたテキストが代入され、 $matches[1] には 1 番目のキャプチャ用サブパターン
                    にマッチした 文字列が代入され、といったようになります。
  <info>int</info>     <strong>$flags</strong>    <strong>$flags</strong> には以下のフラグの組み合わせを指定できます。 <info>PREG_OFFSET_CAPTURE</info> このフラ
                    グを設定した場合、各マッチに対応する文字列のオフセットも(バイト単位で)返されま
                    す。 これは、<strong>$matches</strong> の値を配列に変更することに注意してください。 その配列のす
                    べての要素は、 オフセット <return>0</return> で一致した文字列、 およびその文字列のオフセット <return>1</return> で
                    の <strong>$subject</strong> へのオフセットからなります。
                    ]]>上の例の出力は以下となります。 Array ( [0] => foobarbaz [1] => 0 )
                     [1] => Array ( [0] => foo [1] => 0 )
                     [2] => Array ( [0] => bar [1] => 3 )
                     [3] => Array ( [0] => baz [1] => 6 )
                    
                    )
                    ]]> <info>PREG_UNMATCHED_AS_NULL</info> このフラグが渡されると、マッチしなかったサブパターン
                    は <info>null</info> として通知されます。 渡されなかった場合、空の <info>string</info> として通知されま
                    す。
                    ]]>上の例の出力は以下となります。 string(2) "ac" [1]=> string(1) "a" [2]=>
                    string(0) "" [3]=> string(1) "c"
                    }
                    array(4) { [0]=> string(2) "ac" [1]=> string(1) "a" [2]=> NULL [3]=> string(1)
                    "c"
                    }
                    ]]> 
                    
                    このフラグを設定した場合、各マッチに対応する文字列のオフセットも(バイト単位で)返
                    されます。 これは、<strong>$matches</strong> の値を配列に変更することに注意してください。 その配
                    列のすべての要素は、 オフセット <return>0</return> で一致した文字列、 およびその文字列のオフセッ
                    ト <return>1</return> での <strong>$subject</strong> へのオフセットからなります。
                    ]]>上の例の出力は以下となります。 Array ( [0] => foobarbaz [1] => 0 )
                     [1] => Array ( [0] => foo [1] => 0 )
                     [2] => Array ( [0] => bar [1] => 3 )
                     [3] => Array ( [0] => baz [1] => 6 )
                    
                    )
                    ]]>
                    
                    上の例の出力は以下となります。
                    
                    このフラグが渡されると、マッチしなかったサブパターンは <info>null</info> として通知されます。
                    渡されなかった場合、空の <info>string</info> として通知されます。
                    ]]>上の例の出力は以下となります。 string(2) "ac" [1]=> string(1) "a" [2]=>
                    string(0) "" [3]=> string(1) "c"
                    }
                    array(4) { [0]=> string(2) "ac" [1]=> string(1) "a" [2]=> NULL [3]=> string(1)
                    "c"
                    }
                    ]]>
                    
                    上の例の出力は以下となります。
  <info>array</info>   <strong>$matches</strong>  このフラグを設定した場合、各マッチに対応する文字列のオフセットも(バイト単位で)返
                    されます。 これは、<strong>$matches</strong> の値を配列に変更することに注意してください。 その配
                    列のすべての要素は、 オフセット <return>0</return> で一致した文字列、 およびその文字列のオフセッ
                    ト <return>1</return> での <strong>$subject</strong> へのオフセットからなります。
                    ]]>上の例の出力は以下となります。 Array ( [0] => foobarbaz [1] => 0 )
                     [1] => Array ( [0] => foo [1] => 0 )
                     [2] => Array ( [0] => bar [1] => 3 )
                     [3] => Array ( [0] => baz [1] => 6 )
                    
                    )
                    ]]>
                    
                    上の例の出力は以下となります。
  <info>int</info>     <strong>$offset</strong>   通常、検索は対象文字列の先頭から開始されます。 オプションのパラメータ <strong>$offset</strong> を
                    使用して 検索の開始位置を (バイト単位で) 指定することも可能です。
                    
                    <strong>$offset</strong> を用いるのと、 substr($subject, $offset) を <strong>preg_match()</strong>の対象文字列とし
                    て指定するのとは 等価ではありません。 これは、<strong>$pattern</strong> には、 ^, $ や (?\<=x) のような言明を含めることができるためです。 以下を比べてみてください。
                    ]]>上の例の出力は以下となります。 一方、この例を見てください。 
                    ]]> 出力は以下のようになります。  Array ( [0] => def [1] => 0 )
                    
                    )
                    ]]><strong>substr()</strong> 関数を利用しない別の方法として、 <return>^</return> アンカーではなく、 言明 <return>\G</return> または
                    <return>A</return> 修正子を使う方法があります。 これらは両方とも <strong>$offset</strong> パラメータとともに動作し
                    ます。
                    
                    上の例の出力は以下となります。
                    
                    一方、この例を見てください。
                    
                    出力は以下のようになります。
                    
                    <strong>substr()</strong> 関数を利用しない別の方法として、 <return>^</return> アンカーではなく、 言明 <return>\G</return> または <return>A</return>
                    修正子を使う方法があります。 これらは両方とも <strong>$offset</strong> パラメータとともに動作しま
                    す。

<comment>Return:</comment>
  <info>int|false</info>  <strong>preg_match()</strong> は、<strong>$pattern</strong> が指定した <strong>$subject</strong> にマッチした場合に 1 を返します。 マッチ
             しなかった場合は 0 を返します。 失敗した場合に <info>false</info> を返します
             
             この関数は論理値
             <info>false</info> を返す可能性がありますが、<info>false</info> として評価される値を返す可能性もあります。
             詳細については 論理値の
             セクションを参照してください。この関数の返り値を調べるには
             ===演算子 を
             使用してください。

<comment>See Also:</comment>
   * PCRE のパターン
   * <strong>preg_quote()</strong>
   * <strong>preg_match_all()</strong>
   * <strong>preg_replace()</strong>
   * <strong>preg_split()</strong>
   * <strong>preg_last_error()</strong>
   * <strong>preg_last_error_msg()</strong>


id: preg_match_all
type: function
doc:
<comment>Description:</comment>
  繰り返し正規表現検索を行う
  
  <strong>$subject</strong> を検索し、 <strong>$pattern</strong> に指定した正規表現にマッチした すべての文字列を、<strong>$flags</strong> で指定した 順
  番で、<strong>$matches</strong> に代入します。
  
  正規表現にマッチすると、そのマッチした文字列の後から 検索が続行されます。

<comment>Param:</comment>
  <info>string</info>  <strong>$pattern</strong>  検索するパターンを表す文字列。
  <info>string</info>  <strong>$subject</strong>  入力文字列。
  <info>array</info>   <strong>$matches</strong>  マッチしたすべての内容を含む、 <strong>$flags</strong> で指定した形式の多次元配列。
  <info>int</info>     <strong>$flags</strong>    以下のフラグの組み合わせ (<info>PREG_PATTERN_ORDER</info> を <info>PREG_SET_ORDER</info> と組み合わせて使
                    用することは 無意味ですので注意してください)。 <info>PREG_PATTERN_ORDER</info>$matches[0] は
                    パターン全体にマッチした文字列の配列、 $matches[1] は第 1 のキャプチャ用サブパ
                    ターンにマッチした文字列の配列、 といった順番となります。
                    ]]>上の例の出力は以下となります。example: , this is a test
                    example: , this is a test
                    ]]>$out[0] はパターン全体にマッチした文字列の配列を有しており、 $out[1] はタグで
                    囲まれた文字列の配列を有しています。  パターンに名前付きサブパターンが含まれる場
                    合は、$matches にはサブパターン名のキーも含まれるようになります。  サブパターン
                    の名前が重複している場合は、いちばん右側のサブパターンだけが $matches[NAME] に格
                    納されます。
                    ]]>上の例の出力は以下となります。  [1] => bar
                    )
                    ]]> <info>PREG_SET_ORDER</info>$matches[0] は 1 回目のマッチングでキャプチャした値の配列、
                    $matches[1] は 2 回目のマッチングでキャプチャした値の配列、 といった順序となりま
                    す。
                    ]]>上の例の出力は以下となります。example: , example:
                    this is a test, this is a test
                    ]]> <info>PREG_OFFSET_CAPTURE</info> このフラグを設定した場合、各マッチに対応する文字列のオフ
                    セットも(バイト単位で)返されます。 これは、<strong>$matches</strong> の値を配列の配列に変更するこ
                    とに注意してください。 その配列のすべての要素は、 オフセット <return>0</return> で一致した文字列
                    およびその文字列のオフセット <return>1</return> での <strong>$subject</strong> へのオフセットからなります。
                    ]]>上の例の出力は以下となります。 Array ( [0] => Array ( [0] => foobarbaz [1] =>
                    0 )
                     )
                     [1] => Array ( [0] => Array ( [0] => foo [1] => 0 )
                     )
                     [2] => Array ( [0] => Array ( [0] => bar [1] => 3 )
                     )
                     [3] => Array ( [0] => Array ( [0] => baz [1] => 6 )
                     )
                    
                    )
                    ]]> <info>PREG_UNMATCHED_AS_NULL</info> このフラグが渡されると、 マッチしなかったサブパターン
                    があった場合 <info>null</info> として通知されます。 このフラグが渡されない場合、 空の <info>string</info>
                    として通知されます。
                    
                    $matches[0] はパターン全体にマッチした文字列の配列、 $matches[1] は第 1 のキャプ
                    チャ用サブパターンにマッチした文字列の配列、 といった順番となります。
                    
                    
                    ]]>上の例の出力は以下となります。example: , this is a test
                    example: , this is a test
                    ]]>$out[0] はパターン全体にマッチした文字列の配列を有しており、 $out[1] はタグで
                    囲まれた文字列の配列を有しています。
                    
                    上の例の出力は以下となります。
                    
                    $out[0] はパターン全体にマッチした文字列の配列を有しており、 $out[1] はタグで囲
                    まれた文字列の配列を有しています。
                    
                    パターンに名前付きサブパターンが含まれる場合は、$matches にはサブパターン名の
                    キーも含まれるようになります。
                    
                    サブパターンの名前が重複している場合は、いちばん右側のサブパターンだけが
                    $matches[NAME] に格納されます。
                    ]]>上の例の出力は以下となります。  [1] => bar
                    )
                    ]]>
                    
                    上の例の出力は以下となります。
                    
                    $matches[0] は 1 回目のマッチングでキャプチャした値の配列、 $matches[1] は 2 回
                    目のマッチングでキャプチャした値の配列、 といった順序となります。
                    ]]>上の例の出力は以下となります。example: , example:
                    this is a test, this is a test
                    ]]>
                    
                    上の例の出力は以下となります。
                    
                    このフラグを設定した場合、各マッチに対応する文字列のオフセットも(バイト単位で)返
                    されます。 これは、<strong>$matches</strong> の値を配列の配列に変更することに注意してください。
                    その配列のすべての要素は、 オフセット <return>0</return> で一致した文字列 およびその文字列のオフ
                    セット <return>1</return> での <strong>$subject</strong> へのオフセットからなります。
                    ]]>上の例の出力は以下となります。 Array ( [0] => Array ( [0] => foobarbaz [1] =>
                    0 )
                     )
                     [1] => Array ( [0] => Array ( [0] => foo [1] => 0 )
                     )
                     [2] => Array ( [0] => Array ( [0] => bar [1] => 3 )
                     )
                     [3] => Array ( [0] => Array ( [0] => baz [1] => 6 )
                     )
                    
                    )
                    ]]>
                    
                    上の例の出力は以下となります。
                    
                    このフラグが渡されると、 マッチしなかったサブパターンがあった場合 <info>null</info> として通
                    知されます。 このフラグが渡されない場合、 空の <info>string</info> として通知されます。
                    
                    <strong>$flags</strong> を指定しない場合は、 <info>PREG_PATTERN_ORDER</info> が指定されたことになります。
  <info>array</info>   <strong>$matches</strong>  このフラグを設定した場合、各マッチに対応する文字列のオフセットも(バイト単位で)返
                    されます。 これは、<strong>$matches</strong> の値を配列の配列に変更することに注意してください。
                    その配列のすべての要素は、 オフセット <return>0</return> で一致した文字列 およびその文字列のオフ
                    セット <return>1</return> での <strong>$subject</strong> へのオフセットからなります。
                    ]]>上の例の出力は以下となります。 Array ( [0] => Array ( [0] => foobarbaz [1] =>
                    0 )
                     )
                     [1] => Array ( [0] => Array ( [0] => foo [1] => 0 )
                     )
                     [2] => Array ( [0] => Array ( [0] => bar [1] => 3 )
                     )
                     [3] => Array ( [0] => Array ( [0] => baz [1] => 6 )
                     )
                    
                    )
                    ]]>
                    
                    上の例の出力は以下となります。
  <info>int</info>     <strong>$offset</strong>   通常、検索は対象文字列の先頭から開始されます。 オプションのパラメータ <strong>$offset</strong> を
                    使用して 検索の開始位置を (バイト単位で) 指定することも可能です。
                    
                    <strong>$offset</strong> を用いるのと、 substr($subject, $offset) を <strong>preg_match_all()</strong>の対象文字列
                    として指定するのとは 等価ではありません。 これは、<strong>$pattern</strong> には、 ^, $ や (?\<=x) のような言明を含めることができるためです。 これに関する例については、 <strong>preg_match()</strong> を参照ください。

<comment>Return:</comment>
  <info>int|false</info>  パターンがマッチした総数を返します（ゼロとなる可能性もあります）。 失敗した場合に <info>false</info>
             を返します

<comment>See Also:</comment>
   * PCRE のパターン
   * <strong>preg_quote()</strong>
   * <strong>preg_match()</strong>
   * <strong>preg_replace()</strong>
   * <strong>preg_split()</strong>
   * <strong>preg_last_error()</strong>


id: preg_quote
type: function
doc:
<comment>Description:</comment>
  正規表現文字をクオートする
  
  <strong>preg_quote()</strong> は、<strong>$str</strong>  を引数とし、正規表現構文の特殊文字の前にバックスラッシュを挿入します。 この
  関数は、実行時に生成される文字列をパターンとしてマッチングを行う必要があり、 その文字列には正規表
  現の特殊文字が含まれているかも知れない場合に有用です。
  
  正規表現の特殊文字は、次のものです。 <return>. \ + * ? [ ^ ] $ ( ) { } = ! \< &gt; | : - #</return>
  
  <return>/</return> は正規表現の特殊文字ではないことに注意しましょう。
  
  <strong>preg_quote()</strong> は、 <strong>preg_replace()</strong> などにおける $replacement 文字列に使うことを想定したものではあり
  ません。

<comment>Param:</comment>
  <info>string</info>       <strong>$str</strong>        入力文字列。
  <info>string|null</info>  <strong>$delimiter</strong>  オプションの <strong>$delimiter</strong> を指定すると、 ここで指定した文字もエスケープされ
                           ます。これは、PCRE 関数が使用する デリミタをエスケープする場合に便利で
                           す。<return>/</return> がデリミタとしては 最も一般的に使用されています。

<comment>Return:</comment>
  <info>string</info>  クォートされた (エスケープした) 文字列を返します。

<comment>See Also:</comment>
   * PCRE パターン
   * <strong>escapeshellcmd()</strong>


id: preg_replace
type: function
doc:
<comment>Description:</comment>
  正規表現検索および置換を行う
  
  <strong>$subject</strong> に関して <strong>$pattern</strong> を用いて検索を行い、 <strong>$replacement</strong> に置換します。
  
  パターンではなく、文字列と正確にマッチさせたい場合、 この関数の代わりに <strong>str_replace()</strong> や
  <strong>str_ireplace()</strong> を使うことを検討してください。

<comment>Param:</comment>
  <info>string|array</info>  <strong>$pattern</strong>      検索を行うパターン。文字列もしくは配列とすることができます。
                              
                              PCRE 修飾子 も使えます。
  <info>string|array</info>  <strong>$replacement</strong>  置換を行う文字列もしくは文字列の配列。 この引数が文字列で、<strong>$pattern</strong> 引
                              数が配列の場合、 すべてのパターンがこの文字列に置換されます。 <strong>$pattern</strong>
                              および <strong>$replacement</strong> のいずれもが配列の場合、各 <strong>$pattern</strong> は 対応する
                              <strong>$replacement</strong> に置換されます。 もし、<strong>$replacement</strong> 配列の要素の数が
                              <strong>$pattern</strong> 配列よりも少ない場合は、余った <strong>$pattern</strong> は 空文字に置換されま
                              す。
                              
                              <strong>$replacement</strong> では、 <return>\n</return> 形式または <return>$n</return> 形式で参照を指定することができま
                              す。 後者の形式の方が好ましい形式です。各参照は、n 番目のキャプチャ用
                              サブパターンにマッチしたテキストにより置換されます。 n は 0 から 99 ま
                              でとすることができ、 <return>\0</return> または <return>$0</return> は パターン全体にマッチするテキスト
                              を参照します。キャプチャ用サブパターンの番号 については、その左括弧が
                              左から右に（1から）カウントされます。 <info>string</info> に含まれるバックスラッ
                              シュリテラルは、エスケープが必須であることに注意して下さい。
                              
                              後方参照の直後に他の数字が続くような置換 (replacement) パターンを 使用
                              する場合（すなわち、マッチしたパターンの直後に数字リテラルを置く 場
                              合）、後方参照を行うために通常の <return>\1</return> 表記を 使用することができません。
                              例えば、<return>\11</return>　は、 後方参照 <return>\1</return> の後にリテラル <return>1</return> が続くのか、後方参照
                              <return>\11</return> で その後には何も続かないのかが不明のため、 <strong>preg_replace()</strong> を混乱
                              させる可能性があります。 この場合、解決策は、<return>${1}1</return> を使用することで
                              す。 こうすることで、<return>1</return> はリテラルとなり、後方参照 <return>$1</return> を明確に作成でき
                              ます。
                              
                              非推奨の <return>e</return> 修飾子を使用する際に、 この関数は後方参照を置換する文字列の
                              うちの特定の文字 (具体的には <return>'</return>、<return>"</return>、 <return>\</return> および NULL) をエスケープしま
                              す。 これは、後方参照をシングルクォートやダブルクォートを共用した場合
                              (たとえば <return>'strlen(\'$1\')+strlen("$2")'</return>) に構文エラーが発生しないよう
                              にするためのものです。 PHP の 文字列構文 を意識し、 文字列がどのように
                              解釈されるのかを正確に知っておくようにしましょう。
  <info>string|array</info>  <strong>$subject</strong>      検索・置換対象となる文字列もしくは文字列の配列
                              
                              <strong>$subject</strong> が配列の場合、検索と置換は <strong>$subject</strong> の各要素に対して行われ、
                              戻り値も配列となります。
                              
                              <strong>$subject</strong> が連想配列の場合、 キーは戻り値でも保持されます。
  <info>int</info>           <strong>$limit</strong>        <strong>$subject</strong> 文字列において、各パターンによる 置換を行う最大回数。デフォル
                              トは <return>-1</return> (制限無し)。
  <info>int</info>           <strong>$count</strong>        この引数が指定されると、置換回数が渡されます。

<comment>Return:</comment>
  <info>string|array|null</info>  <strong>preg_replace()</strong> は、 <strong>$subject</strong> 引数が配列の場合は配列を、 その他の場合は文字列を
                     返します。
                     
                     パターンがマッチした場合、〔置換が行われた〕新しい <strong>$subject</strong> を返します。マッチ
                     しなかった場合、<strong>$subject</strong> をそのまま返します。エラーが発生した場合、<info>null</info> を返し
                     ます。

<comment>See Also:</comment>
   * PCRE のパターン
   * <strong>preg_quote()</strong>
   * <strong>preg_filter()</strong>
   * <strong>preg_match()</strong>
   * <strong>preg_replace_callback()</strong>
   * <strong>preg_split()</strong>
   * <strong>preg_last_error()</strong>
   * <strong>str_replace()</strong>


id: preg_replace_callback
type: function
doc:
<comment>Description:</comment>
  正規表現検索を行い、コールバック関数を使用して置換を行う
  
  この関数の動作は、ほぼ <strong>preg_replace()</strong> と同じですが、 <strong>$replacement</strong> の代わりに <strong>$callback</strong> を指定する
  ところが異なります。

<comment>Param:</comment>
  <info>string|array</info>  <strong>$pattern</strong>   検索するパターン。 文字列あるいは文字列の配列のいずれかとなります。
  <info>callable</info>      <strong>$callback</strong>  このコールバック関数は、検索対象文字列でマッチした要素の配列が指定されて
                           コールされます。このコールバック関数は、置換後の文字列を返す必要がありま
                           す。 コールバックのシグネチャは、次のとおりです。
                           
                           <info>string</info>handler<info>array</info><strong>$matches</strong>
                           
                           <strong>preg_replace_callback()</strong> 用の <strong>$callback</strong> 関数が、 ひとつの場所だけで必要と
                           なることがあります。 そんな場合は、 無名関数 を使って宣言した無名関数を
                           <strong>preg_replace_callback()</strong> のコール時に使用します。 このようにすることによ
                           り、コールに関するすべての情報を 1 ヶ所に集め、 他の場所で使用されない
                           コールバック関数名で関数の名前空間を 汚染しないようにすることができます。
                           
                           <strong>preg_replace_callback()</strong> と無名関数 
                           ]]>
  <info>string|array</info>  <strong>$subject</strong>   文字列あるいは文字列の配列で、 検索および置換の対象となる文字列を指定しま
                           す。
  <info>int</info>           <strong>$limit</strong>     <strong>$subject</strong> 文字列における 各パターンの最大置換回数。デフォルトは <return>-1</return> (無制
                           限) です。
  <info>int</info>           <strong>$count</strong>     指定した場合は、置換を行った回数がここに格納されます。
  <info>int</info>           <strong>$flags</strong>     <strong>$flags</strong> には、 <info>PREG_OFFSET_CAPTURE</info> と <info>PREG_UNMATCHED_AS_NULL</info> の組み合わせ
                           が指定できます。 これは matches 配列のフォーマットに影響します。 詳細は
                           <strong>preg_match()</strong> 関数の説明を参照ください。

<comment>Return:</comment>
  <info>string|array|null</info>  <strong>preg_replace_callback()</strong> は、 <strong>$subject</strong> が配列の場合には配列を、 それ以外の場合は
                     文字列を返します。 エラー時の戻り値は <info>null</info> となります。
                     
                     マッチするものが見つかった場合は新しい subject を返し、それ以外の場合はもとの
                     <strong>$subject</strong> をそのまま返します。

<comment>See Also:</comment>
   * PCRE のパターン
   * <strong>preg_replace_callback_array()</strong>
   * <strong>preg_quote()</strong>
   * <strong>preg_replace()</strong>
   * <strong>preg_last_error()</strong>
   * 無名関数


id: preg_replace_callback_array
type: function
doc:
<comment>Description:</comment>
  正規表現検索を行い、コールバック関数を使用して置換を行う
  
  この関数の動作は、<strong>preg_replace_callback()</strong> に似ていますが、 コールバック関数が、パターン単位ペース
  で実行されるところが異なります。

<comment>Param:</comment>
  <info>array</info>         <strong>$pattern</strong>  パターンをキーとし、<info>callable</info> を値とする連想配列です。
  <info>string|array</info>  <strong>$subject</strong>  文字列あるいは文字列の配列で、 検索および置換の対象となる文字列を指定しま
                          す。
  <info>int</info>           <strong>$limit</strong>    <strong>$subject</strong> 文字列における 各パターンの最大置換回数。デフォルトは <return>-1</return> (無制限)
                          です。
  <info>int</info>           <strong>$count</strong>    指定した場合は、置換を行った回数がここに格納されます。
  <info>int</info>           <strong>$flags</strong>    <strong>$flags</strong> には、 <info>PREG_OFFSET_CAPTURE</info> と <info>PREG_UNMATCHED_AS_NULL</info> の組み合わせが
                          指定できます。 これは matches 配列のフォーマットに影響します。 詳細は
                          <strong>preg_match()</strong> 関数の説明を参照ください。

<comment>Return:</comment>
  <info>string|array|null</info>  <strong>preg_replace_callback_array()</strong> は、 <strong>$subject</strong> が配列の場合には配列を、 それ以外の
                     場合は文字列を返します。 エラー時の戻り値は <info>null</info> となります。
                     
                     マッチするものが見つかった場合は新しい subject を返し、それ以外の場合はもとの
                     <strong>$subject</strong> をそのまま返します。

<comment>See Also:</comment>
   * PCRE のパターン
   * <strong>preg_replace_callback()</strong>
   * <strong>preg_quote()</strong>
   * <strong>preg_replace()</strong>
   * <strong>preg_last_error()</strong>
   * 無名関数


id: preg_split
type: function
doc:
<comment>Description:</comment>
  正規表現で文字列を分割する
  
  指定した文字列を、正規表現で分割します。

<comment>Param:</comment>
  <info>string</info>  <strong>$pattern</strong>  検索するパターンを表す文字列。
  <info>string</info>  <strong>$subject</strong>  入力文字列。
  <info>int</info>     <strong>$limit</strong>    これを指定した場合、最大 <strong>$limit</strong> 個の部分文字列を返します。 残りの文字列は、最後
                    の部分文字列に含めて返されます。 <strong>$limit</strong> が -1 あるいは 0 の場合は「制限が無い」
                    ことを意味します。
  <info>int</info>     <strong>$flags</strong>    <strong>$flags</strong> は、次のフラグを組み合わせたものとする （ビット和演算子 <return>|</return> で組み合わせ
                    る）ことが可能です。 <info>PREG_SPLIT_NO_EMPTY</info> このフラグを設定すると、空文字列でない
                    ものだけが <strong>preg_split()</strong> により返されます。 <info>PREG_SPLIT_DELIM_CAPTURE</info> このフラグを
                    設定すると、文字列分割用のパターン中の カッコによるサブパターンでキャプチャされ
                    た値も同時に返されます。 <info>PREG_SPLIT_OFFSET_CAPTURE</info> このフラグを設定した場合、各
                    マッチに対応する文字列のオフセットも返されます。 これにより、戻り値は配列とな
                    り、配列の要素 <return>0</return> はマッチした文字列、 要素 <return>1</return> は <strong>$subject</strong> におけるマッチした文字
                    列のオフセット値となることに 注意してください。
                    
                    このフラグを設定すると、空文字列でないものだけが <strong>preg_split()</strong> により返されます。
                    
                    このフラグを設定すると、文字列分割用のパターン中の カッコによるサブパターンで
                    キャプチャされた値も同時に返されます。
                    
                    このフラグを設定した場合、各マッチに対応する文字列のオフセットも返されます。 こ
                    れにより、戻り値は配列となり、配列の要素 <return>0</return> はマッチした文字列、 要素 <return>1</return> は
                    <strong>$subject</strong> におけるマッチした文字列のオフセット値となることに 注意してください。
  <info>string</info>  <strong>$subject</strong>  このフラグを設定した場合、各マッチに対応する文字列のオフセットも返されます。 こ
                    れにより、戻り値は配列となり、配列の要素 <return>0</return> はマッチした文字列、 要素 <return>1</return> は
                    <strong>$subject</strong> におけるマッチした文字列のオフセット値となることに 注意してください。

<comment>Return:</comment>
  <info>array|false</info>  <strong>$pattern</strong> にマッチした境界で分割した <strong>$subject</strong> の部分文字列の配列を返します。失敗した場
               合に <info>false</info> を返します。

<comment>See Also:</comment>
   * PCRE のパターン
   * <strong>preg_quote()</strong>
   * <strong>implode()</strong>
   * <strong>preg_match()</strong>
   * <strong>preg_match_all()</strong>
   * <strong>preg_replace()</strong>
   * <strong>preg_last_error()</strong>


id: prev
type: function
doc:
<comment>Description:</comment>
  内部の配列ポインタをひとつ前に戻す
  
  内部の配列ポインタをひとつ前に戻します。
  
  <strong>prev()</strong> は、 内部の配列ポインタを進めるのではなく戻すということを除けば <strong>next()</strong> と同じです。

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

<comment>Return:</comment>
  <info>mixed</info>  内部の配列ポインタが指している前の場所の配列値を返します。 もう要素がない場合は <info>false</info> を返
         します。
         
         この関数は論理値
         <info>false</info> を返す可能性がありますが、<info>false</info> として評価される値を返す可能性もあります。
         詳細については 論理値の
         セクションを参照してください。この関数の返り値を調べるには
         ===演算子 を
         使用してください。

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


id: print
type: function
doc:
<comment>Description:</comment>
  文字列を出力する
  
  <strong>$expression</strong> を出力します。
  
  <return>print</return>は実際には関数ではなく、 言語構造です。 引数は、<return>print</return> の後に文字列として評価される式を指定
  し、括弧で括る必要はありません。
  
  <return>echo</return> との主な違いは、 <return>print</return> が単一の引数のみ受け付け、常に <return>1</return> を返すことです。

<comment>Param:</comment>
  <info>string</info>  <strong>$expression</strong>  出力する文字列として評価される式。 文字列として評価できない値は、 強制的に文
                       字列に変換されます。 これは、 <return>strict_types</return> ディレクティブ が有効になっていて
                       も同じです。

<comment>Return:</comment>
  <info>int</info>  常に <return>1</return> を返します。

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


id: print_r
type: function
doc:
<comment>Description:</comment>
  指定した変数に関する情報を解りやすく出力する
    
  
  <strong>print_r()</strong> は、 変数の値に関する情報を解り易い形式で表示します。
  
  <strong>print_r()</strong>、<strong>var_dump()</strong> および <strong>var_export()</strong> は、オブジェクトの protected および private のプロパティ
  も表示します。 static が付いたクラスメンバーは表示されません。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>   表示したい式。
  <info>bool</info>   <strong>$return</strong>  <strong>print_r()</strong> の結果を取得したい場合には <strong>$return</strong> 引数を使います。 この引数が <info>true</info> の場
                  合には、 <strong>print_r()</strong> は情報を表示するかわりに情報を返します。

<comment>Return:</comment>
  <info>string|bool</info>  <info>string</info>、<info>int</info>, <info>float</info> を指定した場合はその値が出力されます。 <info>array</info> を指定した場合、キー
               と要素を表す形式で値が 表示されます。<info>object</info> に関しても同様の表示形式となります。
               
               <strong>$return</strong> パラメータが <info>true</info> の場合は、 この関数は <info>string</info> を返します。それ以外の場合の戻
               り値は <info>true</info> です。

<comment>See Also:</comment>
   * <strong>ob_start()</strong>
   * <strong>var_dump()</strong>
   * <strong>var_export()</strong>


id: printf
type: function
doc:
<comment>Description:</comment>
  フォーマット済みの文字列を出力する
  
  <strong>$format</strong> にしたがって、出力を生成します。

<comment>Param:</comment>
  <info>string</info>  <strong>$format</strong>  0個以上のディレクティブで構成されるフォーマット文字列:
                    変換結果に直接コピーされる通常文字列 (<return>%</return> は除きます) と、変換仕様。 これらのいず
                   れも、自分が持つパラメータを取得します。
                   
                   変換の仕様は、以下のプロトタイプに従います:
                   <return>%[argnum$][flags][width][.precision]specifier</return>.
                   
                   何番目の引数を変換の対象にするかを指定するために、 数値の後にドル記号 <return>$</return> を続けま
                   す。
                   
                   フラグ一覧フラグ説明<return>-</return> 与えられたフィールドの幅を左寄せにします。 右寄せがデフォル
                   トです。 <return>+</return> 正の数値の前に付ける <return>+</return> 符号です; デフォルトは、負の数にだけマイナスの
                   符号が数値の前に付きます。 <return> </return>(space) スペースに変換される詰め物です。 これがデフォ
                   ルトです。 <return>0</return> 数値の左側を0埋めします。 <return>s</return> 指定子を使うと、 右側にも0埋めできます。
                   <return>'</return>(char) 指定された (char) で埋めます。
                   
                   (最小で)何文字がこの変換結果に含まれるかを数値で指定するか、 <return>*</return> を指定します。 <return>*</return>
                   を指定した場合、 指定子によってフォーマットされる値の前に、 幅を追加の数値として
                   指定します。
                   
                   ピリオド <return>.</return> の後に数値を続けるか、 <return>*</return> を続けますが、 その意味は指定子に依存します:
                   <return>e</return>, <return>E</return>, <return>f</return> と <return>F</return> 指定子の場合: 小数点の後に表示する桁数 (デフォルトでは、この値は6で
                   す) <return>g</return>, <return>G</return>, <return>h</return>, <return>H</return> 指定子の場合: 表示する最大の有効桁数 <return>s</return> 指定子の場合: 文字列を切り
                   捨てる時点、つまり、文字列の最大の長さを設定します。   明示的に精度を指定せず、ピ
                   リオドを指定した場合、精度は0として扱われます。 <return>*</return> を使った場合、 精度は指定子に
                   よってフォーマットされる値の前に、 追加の数値として指定します。
                   
                   <return>e</return>, <return>E</return>, <return>f</return> と <return>F</return> 指定子の場合: 小数点の後に表示する桁数 (デフォルトでは、この値は6で
                   す)
                   
                   <return>g</return>, <return>G</return>, <return>h</return>, <return>H</return> 指定子の場合: 表示する最大の有効桁数
                   
                   <return>s</return> 指定子の場合: 文字列を切り捨てる時点、つまり、文字列の最大の長さを設定します。
                   
                   明示的に精度を指定せず、ピリオドを指定した場合、精度は0として扱われます。 <return>*</return> を
                   使った場合、 精度は指定子によってフォーマットされる値の前に、 追加の数値として指
                   定します。
                   
                   指定子の一覧指定子説明<return>%</return> 文字通り、パーセント文字です。 引数は不要です。 <return>b</return> 引数は
                   整数として扱われ、バイナリ値として表現されます。 <return>c</return> 引数は整数として扱われ、
                   ASCII文字として表現されます。 <return>d</return> 引数は整数として扱われ、(符号付き)10進数値として
                   表現されます。 <return>e</return> 引数は科学的記法で表現された値(e.g. 1.2e+2)として扱われます。 <return>E</return><return>e</return>
                   指定子に似ていますが、 大文字を使います(e.g. 1.2E+2) <return>f</return> 引数は小数として扱われ、浮
                   動小数点数値として表現されます(ロケールを考慮します)。 <return>F</return> 引数は小数として扱われ、
                   浮動小数点数値として表現されます(ロケールを考慮しません)。 <return>g</return> 汎用フォーマット  P
                   を精度を表す、ゼロでない値とします。 精度が省略された場合、Pの値は6です。 精度に
                   0を指定した場合、Pの値は1になります。 この場合、 <return>E</return> 指定子の変換結果は、 X乗になり
                   ます。  P &gt; X ≥ −4 の場合、<return>E</return> 指定子の変換結果となり、精度は、P − (X + 1) にな
                   ります。 そうでない場合、<return>e</return> 指定子の変換結果となり、 精度は、P - 1 になります。 <return>G</return><return>g</return>
                   指定子に似ていますが、 <return>E</return> と <return>f</return> を使います。 <return>h</return><return>g</return> 指定子に似ていますが、 <return>F</return> を使いま
                   す。 PHP 8.0.0 以降で利用可能です。 <return>H</return><return>g</return> 指定子に似ていますが、 <return>E</return> と <return>F</return> を使います。
                   PHP 8.0.0 以降で利用可能です。 <return>o</return> 引数は整数として扱われ、8進数値として表現されま
                   す。 <return>s</return> 引数は文字列として扱われ、文字列として表現されます。 <return>u</return> 引数は整数として扱
                   われ、符号なし10進数値として表現されます。 <return>x</return> 引数は整数として扱われ、16進数値(小
                   文字)として表現されます。 <return>X</return> 引数は整数として扱われ、16進数値(大文字)として表現さ
                   れます。
                   
                   汎用フォーマット
                   
                   P を精度を表す、ゼロでない値とします。 精度が省略された場合、Pの値は6です。 精度
                   に0を指定した場合、Pの値は1になります。 この場合、 <return>E</return> 指定子の変換結果は、 X乗にな
                   ります。
                   
                   P &gt; X ≥ −4 の場合、<return>E</return> 指定子の変換結果となり、精度は、P − (X + 1) になります。
                   そうでない場合、<return>e</return> 指定子の変換結果となり、 精度は、P - 1 になります。
                   
                   <return>c</return> 指定子はパディングと幅を無視します
                   
                   文字列と width 指定子を、1文字の表現に1バイト以上必要な文字セットと一緒に使おうと
                   すると、 期待しない結果になるかもしれません。
                   
                   値は、指定子の型に合うように強制されます: 型のハンドリング型指定子<info>string</info><return>s</return><info>int</info><return>d</return>, <return>u</return>,
                   <return>c</return>, <return>o</return>, <return>x</return>, <return>X</return>, <return>b</return><info>float</info><return>e</return>, <return>E</return>, <return>f</return>, <return>F</return>, <return>g</return>, <return>G</return>, <return>h</return>, <return>H</return>
  <info>mixed</info>   <strong>$values</strong>  

<comment>Return:</comment>
  <info>int</info>  出力した文字列の長さを返します。

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


id: proc_close
type: function
doc:
<comment>Description:</comment>
  proc_open で開かれたプロセスを閉じ、
    そのプロセスの終了コードを返す
  
  <strong>proc_close()</strong> は <strong>pclose()</strong> と似ていますが、<strong>proc_open()</strong> で開かれたプロセスに対してのみ機能するという
  点で異なります。 <strong>proc_close()</strong> は、プロセスが終了するまで待った後で、 終了コードを返します。もし、
  そのプロセスに対してパイプが開かれていた場合は、 デッドロックを避けるため、この関数が呼び出された
  時点でそのパイプは閉じられます - パイプが開いている間、子プロセスは終了できないからです。

<comment>Param:</comment>
  <info>resource</info>  <strong>$process</strong>  閉じられる <strong>proc_open()</strong> <info>リソース</info>

<comment>Return:</comment>
  <info>int</info>  実行していたプロセスの終了状態を返します。 エラーが発生した場合は <return>-1</return> を返します。
       
       PHP のコンパイル時に --enable-sigchild を指定した場合は、この関数の返り値は未定義となります。


id: proc_get_status
type: function
doc:
<comment>Description:</comment>
  proc_open
    で開かれたプロセスに関する情報を取得する
  
  <strong>proc_get_status()</strong> は、<strong>proc_open()</strong> で開かれたプロセスに関する情報を取得します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$process</strong>  評価される <strong>proc_open()</strong> <info>リソース</info>

<comment>Return:</comment>
  <info>array</info>  集められた情報の <info>配列</info> を返します。 返される配列は次のような要素を持ちます:
         
         要素型説明command<info>string</info><strong>proc_open()</strong> に指定されたコマンド文字列。 pid<info>int</info>プロセス
         IDrunning<info>bool</info> もしプロセスがまだ動いている場合は、<info>true</info> 、すでに終了している場合は <info>false</info>。
         signaled<info>bool</info> 子プロセスが、キャッチされていないシグナルにより終了した場合に <info>true</info> となりま
         す。Windows では常に <info>false</info> にセットされます。 stopped<info>bool</info> 子プロセスが、シグナルにより停止
         した時に <info>true</info> となります。 Windows では常に <info>false</info> にセットされます。 exitcode<info>int</info> プロセスが
         返した終了コード (<return>running</return> が <info>false</info> の時のみ意味を持ちます)。 正しい値を返すのは関数を最初に
         コールした時のみで、次に コールした際には <return>-1</return> を返します。 termsig<info>int</info> プロセスを終了させたシ
         グナルの番号です (<return>signaled</return> が <info>true</info> の時のみ意味を持ちます)。 stopsig<info>int</info> プロセスを停止させ
         たシグナルの番号です (<return>stopped</return> が <info>true</info> の時のみ意味を持ちます)。

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


id: proc_nice
type: function
doc:
<comment>Description:</comment>
  現在のプロセスの優先度を変更する
  
  <strong>proc_nice()</strong> は、現在のプロセスの優先度を <strong>$priority</strong> で指定された値に変更します。 <strong>$priority</strong> が正数の
  場合、 現在のプロセスの優先度をより低くし、<strong>$priority</strong> が負数の場合は優先度が上がります。
  
  <strong>proc_nice()</strong> は、<strong>proc_open()</strong> やそれに関連する関数とは関係ありません。

<comment>Param:</comment>
  <info>int</info>  <strong>$priority</strong>  新しい優先度の値。この値はプラットフォームによっては異なるかもしれません。
                  
                  Unix 上では、<return>-20</return> のように低い値が高い優先度である一方で、 正の値は低い優先度として
                  扱われます。
                  
                  Windows では、 <strong>$priority</strong> パラメータは次のような意味があります:

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。 ユーザーが優先度を変更する権限を
        持っていないなど、 エラーが発生した場合は <info>E_WARNING</info> レベルのエラーも発行されます。

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


id: proc_open
type: function
doc:
<comment>Description:</comment>
  コマンドを実行し、入出力用にファイルポインタを開く
      
  
  <strong>proc_open()</strong> は <strong>popen()</strong> と よく似ていますが、プログラムの実行をさらに細かく制御できる点で違います。

<comment>Param:</comment>
  <info>array|string</info>  <strong>$command</strong>          実行するコマンドラインを <info>string</info> として渡します。 特殊な文字は適切
                                  にエスケープされ、適切にクォートされます。
                                  
                                  Windows では、 <strong>$options</strong> の <return>bypass_shell</return> を <info>true</info> に設定しないと、
                                  cmd.exe (実際は<return>%ComSpec%</return>) に  <strong>$command</strong> の値を クォートしないまま
                                  (つまり、<strong>proc_open()</strong> に渡されたそのままの値を) <return>/c</return> と一緒に渡してし
                                  まいます。 この振る舞いによって、cmd.exe が  <strong>$command</strong> からクォート
                                  を削除してしまうため、 (詳細は cmd.exe のドキュメントを参照くださ
                                  い) 予期しない、潜在的に危険とさえ言える結果になります。なぜなら、
                                  cmd.exe のエラーメッセージには、 渡された <strong>$command</strong> (の一部) が含ま
                                  れる可能性があるからです(下の例を見てください)。
                                  
                                  PHP 7.4.0 以降、<strong>$command</strong> にはコマンドの引数も含めた <info>array</info> を渡せる
                                  ようになりました。 この場合、プロセスは直接(シェルを介さずに)オー
                                  プンされ、PHP が必要な引数のエスケープを全て行います。
                                  
                                  Windows では、<info>array</info> で渡されるコマンドライン引数のエスケープは、
                                  コマンドライン引数の解釈が VCランタイムによって行われるものと互換
                                  性があることを前提にして行われます。
  <info>array</info>         <strong>$descriptor_spec</strong>  数値添字の配列で、ディスクリプタ番号をキーとし、PHP がその ディス
                                  クリプタをどのように子プロセスに渡すかを表すのが 対応する値となり
                                  ます。 0 が標準入力 (stdin)、1 が標準出力 (stdout) で、 2 が標準エ
                                  ラー出力 (stderr) となります。
                                  
                                  各要素は、次のようになります。  プロセスに渡すパイプをあらわす配
                                  列。 最初の要素はディスクリプタの型で、2 番目の要素がその型に対応
                                  するオプションとなります。 使用できる型は <return>pipe</return> (2 番目の要素は、
                                  プロセスにパイプの読み込み側を渡すのなら <return>r</return>、 書き込み側を渡すのな
                                  ら <return>w</return>) および <return>file</return> (2 番目の要素はファイル名) です。 <return>w</return> 以外に何を指
                                  定しても、 <return>r</return> のように扱われるので注意して下さい。  実際のファイル
                                  ディスクリプタ (オープンしたファイルやソケット、 <info>STDIN</info> など) をあ
                                  らわすストリームリソース。
                                  
                                  ファイルディスクリプタの番号は、特に 0, 1, 2 に限られているわけで
                                  は ありません。有効であるどのようなファイルディスクリプタの番号も
                                  指定でき、 それは子プロセスに渡されます。これにより、あるスクリプ
                                  トと、 子プロセスとして起動している別のスクリプトとの間で通信がで
                                  きます。 特に、これは PGP や GPG、openssl といったプログラムにパス
                                  フレーズを より安全な方法で渡したいとき威力を発揮します。 補助的な
                                  ファイルディスクリプタを介して、そのようなプログラムの 状態を取得
                                  するのにも便利です。
  <info>array</info>         <strong>$pipes</strong>            PHP 側で生成されたパイプの終端にあたる ファイルポインタの配列。
  <info>string|null</info>   <strong>$cwd</strong>              コマンドの初期作業ディレクトリ。 完全パスである必要があります。 デ
                                  フォルト値 (現在の PHP プロセスの作業ディレクトリ) を使用したい場
                                  合は <info>null</info> を指定します。
  <info>array|null</info>    <strong>$env_vars</strong>         実行するコマンドのための環境変数の配列。 現在の PHP プロセスと同じ
                                  環境変数を使用する場合は <info>null</info> を指定します。
  <info>array|null</info>    <strong>$options</strong>          その他の追加オプションを指定することが可能です。 現在サポートされ
                                  ているオプションは次の通りです。 <return>suppress_errors</return> (windows のみ):
                                  <info>true</info> にすると、この関数が出力するエラーを抑制します。 <return>bypass_shell</return>
                                  (windows のみ): <info>true</info> にすると、<return>cmd.exe</return> シェルをバイパスします。
                                  <return>blocking_pipes</return> (windows のみ): <info>true</info> に設定すると、パイプを強制的に
                                  切断します。 <return>create_process_group</return> (Windows のみ): <info>true</info> に設定する
                                  と、 子プロセスが <return>CTRL</return> イベントを ハンドルすることを許可します。
                                  <return>create_new_console</return> (windows のみ): 新しいプロセスは親の console を
                                  継承せず、新しい console を持ちます。

<comment>Return:</comment>
  <info>resource|false</info>  プロセスを表すリソースを返します。このリソースは、使用し終えた際に <strong>proc_close()</strong> を
                  使用して開放する必要があります。 失敗した場合は <info>false</info> を返します。

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


id: proc_terminate
type: function
doc:
<comment>Description:</comment>
  proc_open でオープンされたプロセスを強制終了する
  
  終了させる (<strong>proc_open()</strong> を用いて生成された) <strong>$process</strong> にシグナルを送信します。 <strong>proc_terminate()</strong> は
  即座に返され、 プロセスの終了を待ちません。
  
  <strong>proc_terminate()</strong> により、プロセスを終了させ、 他のタスクを継続することができます。
  <strong>proc_get_status()</strong> 関数を使用して (停止したかどうかを確認するために) プロセスをポーリングすることが
  できます。

<comment>Param:</comment>
  <info>resource</info>  <strong>$process</strong>  終了させる <strong>proc_open()</strong> リソース。
  <info>int</info>       <strong>$signal</strong>   このオプションパラメータは POSIX オペレーティングシステムでのみ有用です。
                      <return>kill(2)</return> システムコールを使用して、 プロセスに送信するシグナルを指定することが
                      できます。 デフォルトは <return>SIGTERM</return> です。

<comment>Return:</comment>
  <info>bool</info>  実行していたプロセスの終了状態を返します。

<comment>See Also:</comment>
   * <strong>proc_open()</strong>
   * <strong>proc_close()</strong>
   * <strong>proc_get_status()</strong>


id: property_exists
type: function
doc:
<comment>Description:</comment>
  オブジェクトもしくはクラスにプロパティが存在するかどうかを調べる
    
  
  この関数は、与えられたプロパティ <strong>$property</strong> が 指定されたクラスに存在するかどうかを確認します。
  
  <strong>isset()</strong> とは対照的に、 プロパティの値が <info>null</info> の場合でも <strong>property_exists()</strong> は <info>true</info> を返します。

<comment>Param:</comment>
  <info>object|string</info>  <strong>$object_or_class</strong>  確認するクラス名、もしくはクラスのオブジェクトを指定します。
  <info>string</info>         <strong>$property</strong>         プロパティ名を指定します。

<comment>Return:</comment>
  <info>bool</info>  プロパティが存在している場合は <info>true</info>、存在していない場合に <info>false</info>、 エラー時には <info>null</info> を返しま
        す。

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


id: ps_add_bookmark
type: function
doc:
<comment>Description:</comment>
  現在のページにブックマークを追加する
  
  現在のページにブックマークを追加します。たいてい、ブックマークは PDFビューア上でページの左側にツ
  リー形式で表示されます。 ブックマークをクリックすると、該当ページにジャンプします。
  
  注釈は、
  ドキュメントを印刷したり表示したりするときには表示されません。
  しかし、Acrobat Distiller? あるいは Ghostview
  でドキュメントを pdf に変換すると表示されます。

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>   <strong>ps_new()</strong> が返す、postscript ファイルのリソース ID。
  <info>string</info>    <strong>$text</strong>    ブックマークの表示に使用するテキスト。
  <info>int</info>       <strong>$parent</strong>  新しいブックマークの親となる、 事前にこの関数で作成されたブックマーク。
  <info>int</info>       <strong>$open</strong>    <strong>$open</strong> がゼロでない場合、ブックマークは PDF ビューア上で開いた形で表示されます。

<comment>Return:</comment>
  <info>int</info>  戻り値はブックマークへの参照です。この値は、作成したブックマークを 他のブックマークの親として
       使用する場合にのみ使われます。 成功した場合には、この値はゼロより大きくなります。 エラーが発
       生した場合にはゼロを返します。

<comment>See Also:</comment>
   * <strong>ps_add_launchlink()</strong>
   * <strong>ps_add_pdflink()</strong>
   * <strong>ps_add_weblink()</strong>


id: ps_add_launchlink
type: function
doc:
<comment>Description:</comment>
  ファイルを実行するためのリンクを追加する
  
  クリックした際にファイルが実行されるハイパーリンクを、 指定した場所に設定します。ハイパーリンクの
  リンク元は矩形で表され、 その左下の座標は (llx, lly)、そして右上の座標が (urx, ury) となります。
  この矩形はデフォルトでは細い青線で表されます。
  
  注釈は、
  ドキュメントを印刷したり表示したりするときには表示されません。
  しかし、Acrobat Distiller? あるいは Ghostview
  でドキュメントを pdf に変換すると表示されます。

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>     <strong>ps_new()</strong> が返す、postscript ファイルのリソース ID。
  <info>float</info>     <strong>$llx</strong>       左下角の x 座標。
  <info>float</info>     <strong>$lly</strong>       左下角の y 座標。
  <info>float</info>     <strong>$urx</strong>       右上角の x 座標。
  <info>float</info>     <strong>$ury</strong>       右上角の y 座標。
  <info>string</info>    <strong>$filename</strong>  リンクがクリックされた際に開始するプログラムのパス。

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

<comment>See Also:</comment>
   * <strong>ps_add_locallink()</strong>
   * <strong>ps_add_pdflink()</strong>
   * <strong>ps_add_weblink()</strong>


id: ps_add_locallink
type: function
doc:
<comment>Description:</comment>
  同一ドキュメント内のページへのリンクを追加する
  
  指定した位置に、同一ドキュメント内のページへのハイパーリンクを設定します。 リンクをクリックする
  と、そのページに移動します。ドキュメントの最初の ページのページ番号は 1 です。
  
  ハイパーリンクのリンク元は矩形で表され、その左下の座標は (<strong>$llx</strong>, <strong>$lly</strong>)、 そして右上の座標が (<strong>$urx</strong>,
  <strong>$ury</strong>) となります。この矩形はデフォルトでは細い青線で表されます。
  
  注釈は、
  ドキュメントを印刷したり表示したりするときには表示されません。
  しかし、Acrobat Distiller? あるいは Ghostview
  でドキュメントを pdf に変換すると表示されます。

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  <strong>ps_new()</strong> が返す、postscript ファイルのリソース ID。
  <info>float</info>     <strong>$llx</strong>    左下角の x 座標。
  <info>float</info>     <strong>$lly</strong>    左下角の y 座標。
  <info>float</info>     <strong>$urx</strong>    右上角の x 座標。
  <info>float</info>     <strong>$ury</strong>    右上角の y 座標。
  <info>int</info>       <strong>$page</strong>   リンクがクリックされた際に開始するページ。
  <info>string</info>    <strong>$dest</strong>   <strong>$dest</strong> は、ドキュメントがどのように 表示されるかを指定します。とりうる値は
                    <return>fitpage</return> または <return>fitwidth</return>、 <return>fitheight</return>、<return>fitbbox</return> のいずれかです。

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

<comment>See Also:</comment>
   * <strong>ps_add_launchlink()</strong>
   * <strong>ps_add_pdflink()</strong>
   * <strong>ps_add_weblink()</strong>


id: ps_add_note
type: function
doc:
<comment>Description:</comment>
  現在のページに注釈を追加する
  
  ページの特定の位置に注釈を追加します。注釈は、 テキストが記入された小さな矩形で、ページ上のどこに
  でも配置できます。 折りたたんで保持することもでき、折りたたまれている場合は、 指定したアイコンをプ
  レースホルダとして使います。
  
  注釈は、
  ドキュメントを印刷したり表示したりするときには表示されません。
  しかし、Acrobat Distiller? あるいは Ghostview
  でドキュメントを pdf に変換すると表示されます。

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>     <strong>ps_new()</strong> が返す、postscript ファイルのリソース ID。
  <info>float</info>     <strong>$llx</strong>       左下角の x 座標。
  <info>float</info>     <strong>$lly</strong>       左下角の y 座標。
  <info>float</info>     <strong>$urx</strong>       右上角の x 座標。
  <info>float</info>     <strong>$ury</strong>       右上角の y 座標。
  <info>string</info>    <strong>$contents</strong>  注釈のテキスト。
  <info>string</info>    <strong>$title</strong>     注釈のヘッダに表示される、タイトル。
  <info>string</info>    <strong>$icon</strong>      注釈が折りたたまれた際に表示されるアイコン。 <return>comment</return>、<return>insert</return>、 <return>note</return>、
                       <return>paragraph</return>、 <return>newparagraph</return>、<return>key</return> あるいは <return>help</return> のいずれかが設定できます。
  <info>int</info>       <strong>$open</strong>      <strong>$open</strong> がゼロでない場合、 PDF ビューア上でドキュメントをオープンすると、 注釈
                       は折りたたまれずに表示されます。

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

<comment>See Also:</comment>
   * <strong>ps_add_pdflink()</strong>
   * <strong>ps_add_launchlink()</strong>
   * <strong>ps_add_locallink()</strong>
   * <strong>ps_add_weblink()</strong>


id: ps_add_pdflink
type: function
doc:
<comment>Description:</comment>
  別の PDF ドキュメントのページへのリンクを追加する
  
  指定した位置に、別の PDF ドキュメントへのハイパーリンクを設定します。 リンクをクリックすると、その
  ドキュメントの指定されたページに移動します。 ドキュメントの最初のページのページ番号は 1 です。
  
  ハイパーリンクのリンク元は矩形で表され、その左下の座標は (<strong>$llx</strong>, <strong>$lly</strong>)、 そして右上の座標が (<strong>$urx</strong>,
  <strong>$ury</strong>) となります。この矩形はデフォルトでは細い青線で表されます。
  
  注釈は、
  ドキュメントを印刷したり表示したりするときには表示されません。
  しかし、Acrobat Distiller? あるいは Ghostview
  でドキュメントを pdf に変換すると表示されます。

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>     <strong>ps_new()</strong> が返す、postscript ファイルのリソース ID。
  <info>float</info>     <strong>$llx</strong>       左下角の x 座標。
  <info>float</info>     <strong>$lly</strong>       左下角の y 座標。
  <info>float</info>     <strong>$urx</strong>       右上角の x 座標。
  <info>float</info>     <strong>$ury</strong>       右上角の y 座標。
  <info>string</info>    <strong>$filename</strong>  リンクがクリックされた際に開かれる PDF ドキュメントの名前。
  <info>int</info>       <strong>$page</strong>      対象 PDF ドキュメントのページ番号。
  <info>string</info>    <strong>$dest</strong>      <strong>$dest</strong> は、ドキュメントがどのように 表示されるかを指定します。とりうる値は
                       <return>fitpage</return> または <return>fitwidth</return>、 <return>fitheight</return>、<return>fitbbox</return> のいずれかです。

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

<comment>See Also:</comment>
   * <strong>ps_add_launchlink()</strong>
   * <strong>ps_add_locallink()</strong>
   * <strong>ps_add_weblink()</strong>


id: ps_add_weblink
type: function
doc:
<comment>Description:</comment>
  Web 上の場所へのリンクを追加する
  
  指定した位置に、Web ページを指すハイパーリンクを設定します。 ハイパーリンクのリンク元は矩形で表さ
  れ、その左下の座標は (<strong>$llx</strong>, <strong>$lly</strong>)、 そして右上の座標が (<strong>$urx</strong>, <strong>$ury</strong>) となります。 この矩形はデフォ
  ルトでは細い青線で表されます。
  
  注釈は、
  ドキュメントを印刷したり表示したりするときには表示されません。
  しかし、Acrobat Distiller? あるいは Ghostview
  でドキュメントを pdf に変換すると表示されます。

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  <strong>ps_new()</strong> が返す、postscript ファイルのリソース ID。
  <info>float</info>     <strong>$llx</strong>    左下角の x 座標。
  <info>float</info>     <strong>$lly</strong>    左下角の y 座標。
  <info>float</info>     <strong>$urx</strong>    右上角の x 座標。
  <info>float</info>     <strong>$ury</strong>    右上角の y 座標。
  <info>string</info>    <strong>$url</strong>    リンクがクリックされた際に開かれるハイパーリンクの URL。 例えば
                    <return>http://www.php.net</return>

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

<comment>See Also:</comment>
   * <strong>ps_add_launchlink()</strong>
   * <strong>ps_add_locallink()</strong>
   * <strong>ps_add_pdflink()</strong>


id: ps_arc
type: function
doc:
<comment>Description:</comment>
  反時計回りに円弧を描く
  
  (<strong>$x</strong>, <strong>$y</strong>) を中心とした円の一部を描きます。円弧は <strong>$alpha</strong> で指定された角度からはじまり <strong>$beta</strong> で指定さ
  れた角度で終わります。反時計回りに描かれます (時計回りに描くには <strong>ps_arcn()</strong> を使用します)。 また、
  <strong>$alpha</strong> で指定された角度からはじまって <strong>$beta</strong> で指定された角度で終わるサブパスが、 現在のパスに追加
  されます。

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>   <strong>ps_new()</strong> が返す、postscript ファイルのリソース ID。
  <info>float</info>     <strong>$x</strong>       円の中心の x 座標。
  <info>float</info>     <strong>$y</strong>       円の中心の y 座標。
  <info>float</info>     <strong>$radius</strong>  円の半径。
  <info>float</info>     <strong>$alpha</strong>   開始位置の角度を度単位で指定。
  <info>float</info>     <strong>$beta</strong>    終了位置の角度を度単位で指定。

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

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


id: ps_arcn
type: function
doc:
<comment>Description:</comment>
  時計回りに円弧を描く
  
  (<strong>$x</strong>, <strong>$y</strong>) を中心とした円の一部を描きます。円弧は <strong>$alpha</strong> で指定された角度からはじまり <strong>$beta</strong> で指定さ
  れた角度で終わります。 時計回りに描かれます (反時計回りに描くには <strong>ps_arc()</strong> を使用します)。 また、
  <strong>$beta</strong>  で指定された角度からはじまって <strong>$alpha</strong> で指定された角度で終わるサブパスが、カレントパスに追
  加されます。

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>   <strong>ps_new()</strong> が返す、postscript ファイルのリソース ID。
  <info>float</info>     <strong>$x</strong>       円の中心の x 座標。
  <info>float</info>     <strong>$y</strong>       円の中心の y 座標。
  <info>float</info>     <strong>$radius</strong>  円の半径。
  <info>float</info>     <strong>$alpha</strong>   開始位置の角度を度単位で指定。
  <info>float</info>     <strong>$beta</strong>    終了位置の角度を度単位で指定。

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

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


id: ps_begin_page
type: function
doc:
<comment>Description:</comment>
  新しいページを開始する
  
  新しいページを開始します。<strong>$width</strong> や <strong>$height</strong> というパラメータを見ると いかにもページ単位でサイズを
  変えられるように思えますが、PostScript ではこれは不可能です。最初に <strong>ps_begin_page()</strong> を呼んだ際に指
  定されたサイズが、ドキュメント全体に適用されます。 2 回目以降に呼ばれた場合はこのパラメータは意味
  を持たず、 単に新しいページが作られるだけです。しかし、もしあなたが PostScript ドキュメントを PDF
  に変換しようと考えているのなら話は別です。 この関数はドキュメントの各ページごとに pdfmark を設定す
  るので、 PDF に変換した後はページごとにサイズを変えることができます。
  
  PostScript はさまざまなページサイズを知らないので、pslib ではドキュメントの各ページに対してバウン
  ディングボックスを設定します。 このサイズは PostScript ビューアによって評価され、 ドキュメントヘッ
  ダの BoundingBox より優先されます。 左下角が (0, 0) ではない BoundingBox を設定すると、 予期せぬ結
  果を引き起こすことがあります。なぜなら、 ページ単位のバウンディングボックスは常に左下角が (0, 0)
  であり、 これが全体の設定より優先されるからです。
  
  個々のページの情報はカプセル化して保存されています。どういうことかというと、 あるページで設定した
  情報のほとんどは次のページに引き継がれないということです。
  
  最初の <strong>ps_begin_page()</strong> 呼び出しまでに一度も <strong>ps_findfont()</strong> が呼び出されていなかった場合は、
  PostScript ドキュメントのヘッダが出力され、 バウンディングボックスが最初のページのサイズに設定され
  ます。 バウンディングボックスの左下角は (0, 0) に設定されます。もしすでに <strong>ps_findfont()</strong> が呼ばれて
  いた場合は既にヘッダが出力されてしまっており、 ドキュメントに適切なバウンディングボックスが設定さ
  れていないことになります。 このようなことを避けるために、<strong>ps_findfont()</strong> や <strong>ps_begin_page()</strong> を実行す
  る前にはいつも <strong>ps_set_info()</strong> を実行し、 <return>BoundingBox</return> や <return>Orientation</return> の値を設定しておくべきです。
  
  pslib のバージョン 0.2.6 まででは、 <strong>ps_set_info()</strong> によって事前に設定されていたり <strong>ps_findfont()</strong> が
  事前にコールされていない限り、 この関数は常に BoundingBox および Orientation を上書きします。

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>   <strong>ps_new()</strong> が返す、postscript ファイルのリソース ID。
  <info>float</info>     <strong>$width</strong>   ピクセル単位のページの幅 (例: A4 の場合は 596)。
  <info>float</info>     <strong>$height</strong>  ピクセル単位のページの高さ (例: A4 の場合は 842)。

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

<comment>See Also:</comment>
   * <strong>ps_end_page()</strong>
   * <strong>ps_findfont()</strong>
   * <strong>ps_set_info()</strong>


id: ps_begin_pattern
type: function
doc:
<comment>Description:</comment>
  新しいパターンを開始する
  
  新しいパターンを開始します。パターンとは、 領域を塗りつぶすための描画データを含むページのようなも
  のです。 <strong>ps_setcolor()</strong> をコールする際に <return>pattern</return> に色空間を指定すると、 これは色のように使用されま
  す。

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>      <strong>ps_new()</strong> が返す、postscript ファイルのリソース ID。
  <info>float</info>     <strong>$width</strong>      ピクセル単位のパターンの幅。
  <info>float</info>     <strong>$height</strong>     ピクセル単位のパターンの高さ。
  <info></info>          <strong>$x-step</strong>     パターンを水平方向に並べる際のピクセル単位の間隔。
  <info></info>          <strong>$y-step</strong>     パターンを垂直方向に並べる際のピクセル単位の間隔。
  <info>int</info>       <strong>$painttype</strong>  1 あるいは 2 でなければなりません。

<comment>Return:</comment>
  <info>int|false</info>  パターンの ID を返します。失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>ps_end_pattern()</strong>
   * <strong>ps_setcolor()</strong>
   * <strong>ps_shading_pattern()</strong>


id: ps_begin_template
type: function
doc:
<comment>Description:</comment>
  新しいテンプレートを開始する
  
  新しいテンプレートを開始します。テンプレートは、postscript 言語からコールされます。パターンと似て
  いますが、画像のように使用されます。 テンプレートは、ドキュメント内で何回も使用される描画内容、 例
  えば会社のロゴなどに対して使用されることが多いでしょう。 テンプレート内では、すべての描画関数が使
  用されます。 テンプレートは、<strong>ps_place_image()</strong> によって配置されるまでは描画されません。

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>   <strong>ps_new()</strong> が返す、postscript ファイルのリソース ID。
  <info>float</info>     <strong>$width</strong>   ピクセル単位のテンプレートの幅。
  <info>float</info>     <strong>$height</strong>  ピクセル単位のテンプレートの高さ。

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

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


id: ps_circle
type: function
doc:
<comment>Description:</comment>
  円を描く
  
  (<strong>$x</strong>, <strong>$y</strong>) を中心とする円を描きます。描画開始位置は (<strong>$x</strong>+<strong>$radius</strong>, <strong>$y</strong>) です。もしパスの外部でこの関数
  が呼び出された場合、 新しいパスを開始します。パスの内部で呼び出された場合は、 円をサブパスとして追
  加します。ひとつ前の描画処理の終点が (<strong>$x</strong>+<strong>$radius</strong>, <strong>$y</strong>) でなかった場合、パスに隙間ができることになり
  ます。

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>   <strong>ps_new()</strong> が返す、postscript ファイルのリソース ID。
  <info>float</info>     <strong>$x</strong>       円の中心の x 座標。
  <info>float</info>     <strong>$y</strong>       円の中心の y 座標。
  <info>float</info>     <strong>$radius</strong>  円の半径。

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

<comment>See Also:</comment>
   * <strong>ps_arc()</strong>
   * <strong>ps_arcn()</strong>


id: ps_clip
type: function
doc:
<comment>Description:</comment>
  現在のパスを描画範囲として指定する
  
  現在のパスを、描画範囲の境界として定義します。 この領域の外に描画された内容は、見えなくなります。

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  <strong>ps_new()</strong> が返す、postscript ファイルのリソース ID。

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

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


id: ps_close
type: function
doc:
<comment>Description:</comment>
  PostScript ドキュメントを閉じる
  
  PostScript ドキュメントを閉じます。
  
  この関数は、PostScript ドキュメントのトレーラーを書き込みます。 また、ブックマークツリーも書き込み
  ます。<strong>ps_close()</strong> は、リソースの開放は行いません。これは <strong>ps_delete()</strong> が行います。
  
  もし事前にコールされていない場合、この関数は <strong>ps_delete()</strong> からもコールされます。

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  <strong>ps_new()</strong> が返す、postscript ファイルのリソース ID。

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

<comment>See Also:</comment>
   * <strong>ps_open_file()</strong>
   * <strong>ps_delete()</strong>


id: ps_close_image
type: function
doc:
<comment>Description:</comment>
  画像を閉じ、メモリを開放する
  
  画像を閉じ、そのリソースを開放します。 いったん閉じられた後は、画像を使用することはできません。

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>    <strong>ps_new()</strong> が返す、postscript ファイルのリソース ID。
  <info>int</info>       <strong>$imageid</strong>  <strong>ps_open_image()</strong> あるいは <strong>ps_open_image_file()</strong> が返す、 画像のリソース ID。

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

<comment>See Also:</comment>
   * <strong>ps_open_image()</strong>
   * <strong>ps_open_image_file()</strong>


id: ps_closepath
type: function
doc:
<comment>Description:</comment>
  パスを閉じる
  
  パスの終了点と開始点をつなげます。出来上がったパスは、 描画、塗りつぶし、切り取りなどに使用されま
  す。

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  <strong>ps_new()</strong> が返す、postscript ファイルのリソース ID。

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

<comment>See Also:</comment>
   * <strong>ps_clip()</strong>
   * <strong>ps_closepath_stroke()</strong>


id: ps_closepath_stroke
type: function
doc:
<comment>Description:</comment>
  パスを閉じ、描画する
  
  パスの終了点を開始点とつなげ、出来上がった線を描画します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  <strong>ps_new()</strong> が返す、postscript ファイルのリソース ID。

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

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


id: ps_continue_text
type: function
doc:
<comment>Description:</comment>
  次の行にテキストを続ける
  
  最終行の次の行からテキストを出力します。行間隔は "leading" の値が用いられます。この値は
  <strong>ps_set_value()</strong> を用いて指定する必要があります。 実際のテキストの出力位置は、"textx" と "texty" の
  値によって決まります。 この値は <strong>ps_get_value()</strong> を用いて取得することができます。

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  <strong>ps_new()</strong> が返す、postscript ファイルのリソース ID。
  <info>string</info>    <strong>$text</strong>   出力するテキスト。

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

<comment>See Also:</comment>
   * <strong>ps_show()</strong>
   * <strong>ps_show_xy()</strong>
   * <strong>ps_show_boxed()</strong>


id: ps_curveto
type: function
doc:
<comment>Description:</comment>
  曲線を描く
  
  現在のパスに対して、3 つの制御点を指定して 3 次ベジエ曲線を追加します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  <strong>ps_new()</strong> が返す、postscript ファイルのリソース ID。
  <info>float</info>     <strong>$x1</strong>     最初の制御点の x 座標。
  <info>float</info>     <strong>$y1</strong>     最初の制御点の y 座標。
  <info>float</info>     <strong>$x2</strong>     2 番目の制御点の x 座標。
  <info>float</info>     <strong>$y2</strong>     2 番目の制御点の y 座標。
  <info>float</info>     <strong>$x3</strong>     3 番目の制御点の x 座標。
  <info>float</info>     <strong>$y3</strong>     3 番目の制御点の y 座標。

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

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


id: ps_delete
type: function
doc:
<comment>Description:</comment>
  PostScript ドキュメントの全リソースを削除する
  
  ドキュメントが使用していたメモリを開放します。また、 もし事前に <strong>ps_close()</strong> でファイルが閉じられて
  いない場合はファイルを閉じます。 どんな場合でも、事前に <strong>ps_close()</strong> でファイルを閉じておくべきで
  す。なぜなら <strong>ps_close()</strong> はファイルをただ閉じるだけではなく、トレーラーを出力するからです。 ここに
  は、ドキュメントのページ数やブックマーク階層といった情報が含まれます。

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  <strong>ps_new()</strong> が返す、postscript ファイルのリソース ID。

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

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


id: ps_end_page
type: function
doc:
<comment>Description:</comment>
  ページを終了する
  
  <strong>ps_begin_page()</strong> によって開始したページを終了します。 ページを終了しても、現在の描画コンテキストは
  そのままになります。つまり、 もしページ内部でフォントが読み込まれたのなら、 それを再読み込みしてし
  なければなりません。 また、行の幅や色などのその他の描画パラメータも再設定する必要があります。

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  <strong>ps_new()</strong> が返す、postscript ファイルのリソース ID。

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

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


id: ps_end_pattern
type: function
doc:
<comment>Description:</comment>
  パターンを終了する
  
  <strong>ps_begin_pattern()</strong> によって開始したパターンを終了します。 パターンが終了すると、領域の塗りつぶし時
  にそれを使用できるようになります。

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  <strong>ps_new()</strong> が返す、postscript ファイルのリソース ID。

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

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


id: ps_end_template
type: function
doc:
<comment>Description:</comment>
  テンプレートを終了する
  
  <strong>ps_begin_template()</strong> によって開始したテンプレートを終了します。 テンプレートが終了すると、それを画
  像のように使用できるようになります。

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  <strong>ps_new()</strong> が返す、postscript ファイルのリソース ID。

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

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


id: ps_fill
type: function
doc:
<comment>Description:</comment>
  現在のパスを塗りつぶす
  
  <strong>ps_lineto()</strong> のような描画関数によって事前に作成されたパスを塗りつぶします。

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  <strong>ps_new()</strong> が返す、postscript ファイルのリソース ID。

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

<comment>See Also:</comment>
   * <strong>ps_fill_stroke()</strong>
   * <strong>ps_stroke()</strong>


id: ps_fill_stroke
type: function
doc:
<comment>Description:</comment>
  現在のパスを塗りつぶし、線を引く
  
  <strong>ps_lineto()</strong> のような描画関数によって事前に作成されたパスを塗りつぶし、描画します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  <strong>ps_new()</strong> が返す、postscript ファイルのリソース ID。

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

<comment>See Also:</comment>
   * <strong>ps_fill()</strong>
   * <strong>ps_stroke()</strong>


id: ps_findfont
type: function
doc:
<comment>Description:</comment>
  フォントを読み込む
  
  あとで使用するために、フォントを読み込みます。読み込んだフォントを実際に利用するためには、
  <strong>ps_setfont()</strong> で設定しなければなりません。 文字の間隔を計算するため、この関数には adobe フォントメ
  トリックファイルが必要です。 ページの内部で読み込まれたフォントは、 そのページ内でのみ有効となりま
  す。ドキュメント全体で使われるフォントは、 最初の <strong>ps_begin_page()</strong> の実行より前に読み込まれなければ
  なりません。 ページとページの間で <strong>ps_findfont()</strong> が呼ばれた場合は、それ以降のページでフォントが有効
  になります。
  
  afm ファイルの名前は、 <strong>$fontname</strong><return>.afm</return> でなければなりません。 フォントを埋め込む場合は、フォントのア
  ウトラインを含む <strong>$fontname</strong><return>.pfb</return> が存在しなければなりません。
  
  最初のページを処理する前に <strong>ps_findfont()</strong> をコール際、 postscript ヘッダが出力されます。ここには、
  ドキュメント全体に適用される BoundingBox が含まれます。 通常は、BoundingBox を設定するのは最初に
  <strong>ps_begin_page()</strong> がコールされたときで、これは <strong>ps_findfont()</strong> をコールした後になります。 したがって、
  <strong>ps_findfont()</strong> のコール時にはまだ BoundingBox が設定されておらず、警告が発生してしまいます。 こうな
  ることを避けるため、<strong>ps_findfont()</strong> をコールする前に <strong>ps_set_parameter()</strong> をコールし、BoundingBox を設
  定しておくべきです。

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>     <strong>ps_new()</strong> が返す、postscript ファイルのリソース ID。
  <info>string</info>    <strong>$fontname</strong>  フォントの名前。
  <info>string</info>    <strong>$encoding</strong>  <strong>ps_findfont()</strong> は、<strong>$encoding</strong> で渡されたファイルを読み込もうと試みます。 エン
                       コーディングファイルは、 dvips(1) で使われるものと同形式です。 そこにはフォン
                       トエンコーディングベクタ（現在は利用されていませんが、 存在する必要がありま
                       す）が含まれており、また afm ファイルから 生成されたリゲチャのリストを拡張す
                       るための拡張リゲチャが含まれています。
                       
                       <strong>$encoding</strong> は <info>null</info> または空文字列とすることも可能で、 その場合はデフォルトエン
                       コーディング（TeXBase1）が用いられます。
                       
                       encoding が <return>builtin</return> と指定された場合は、 エンコード処理は行われずにフォント固
                       有のエンコーディングがそのまま用いられます。 これは、記号フォントを扱う場合に
                       便利です。
  <info>bool</info>      <strong>$embed</strong>     0 より大きい値を設定すると、フォントがドキュメントに埋め込まれます。 これを使
                       用するには、フォントのアウトライン (.pfb ファイル) が必要です。

<comment>Return:</comment>
  <info>int</info>  成功した場合にフォントの ID を、失敗した場合にゼロを返します。 ID は正の数値です。

<comment>See Also:</comment>
   * <strong>ps_begin_page()</strong>
   * <strong>ps_setfont()</strong>


id: ps_get_buffer
type: function
doc:
<comment>Description:</comment>
  生成された PS データを含むバッファの内容を取得する
  
  この関数は、まだ実装されていません。常に空の文字列を返します。 メモリ内でのデータ作成が求められる
  場合に、postscript ファイルを内部バッファに読み込み、バッファの内容をこの関数で取得する、 という実
  装を計画中です。 現在は、メモリ内で作成されたデータはバッファリングされず直接ブラウザに送られま
  す。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  <strong>ps_new()</strong> が返す、postscript ファイルのリソース ID。

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

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


id: ps_get_parameter
type: function
doc:
<comment>Description:</comment>
  パラメータを取得する
  
  <strong>ps_set_parameter()</strong> で直接設定されたか、 あるいは他の関数で間接的に設定されたパラメータの値を取得し
  ます。 パラメータは文字列値として定義されます。この関数は、 同じく <strong>ps_set_parameter()</strong> で設定された
  リソースを取得するためには利用できません。
  
  パラメータ <strong>$name</strong> は、以下の値をとります。
  
  <return>fontname</return> 現在アクティブなフォント、 あるいはパラメータ <strong>$modifier</strong> で指定された ID を持つフォントの
  名前。 <return>fontencoding</return> 現在アクティブなフォントのエンコーディング。 <return>dottedversion</return> 元になる pslib ライ
  ブラリのバージョン。書式は \<major&gt;.\<minor&gt;.\<subminor&gt; <return>scope</return> 現在の描画スコープ。object, document, null, page, pattern, path, template, prolog, font, glyph。 <return>ligaturedisolvechar</return> リゲチャを溶かす文字。たとえば、リゲチャ `ff' を含むフォントで `|' がこの文字に指定されていた場合は、 `f|f' はリゲチャ `ff' ではなく 2 つの独立した `f' となります。 <return>imageencoding</return> 画像の符号化に使用するエンコーディング。 <return>hex</return> あるいは <return>85</return>。 hex エンコーディングは、画像の各バイトを postscript ファイルの 2 バイトであらわします。85 は Ascii85 エンコーディングを表します。 <return>linenumbermode</return> 行番号を段落単位でつける場合は <return>paragraph</return>、 ボックス内でつける場合は <return>box</return> を設定します。 <return>linebreak</return> テキストを <strong>ps_show_boxed()</strong> で出力する場合にのみ使用します。 <info>true</info> を設定すると、 改行時にキャリッジリターンが付加されます。 <return>parbreak</return> テキストを <strong>ps_show_boxed()</strong> で出力する場合にのみ使用します。 <info>true</info> を設定すると、 キャリッジリターンで新しい段落を開始します。 <return>hyphenation</return> テキストを <strong>ps_show_boxed()</strong> で出力する場合にのみ使用します。 <info>true</info> を設定すると、 ハイフネーション辞書が設定されており存在する場合に、 段落のハイフネーション処理が行われます。 <return>hyphendict</return> ハイフネーションパターンの辞書のファイル名。
  
  現在アクティブなフォント、 あるいはパラメータ <strong>$modifier</strong> で指定された ID を持つフォントの名前。
  
  現在アクティブなフォントのエンコーディング。
  
  元になる pslib ライブラリのバージョン。書式は \<major&gt;.\<minor&gt;.\<subminor&gt;
  
  現在の描画スコープ。object, document, null, page, pattern, path, template, prolog, font, glyph。
  
  リゲチャを溶かす文字。たとえば、リゲチャ `ff' を含むフォントで `|' がこの文字に指定されていた場合
  は、 `f|f' はリゲチャ `ff' ではなく 2 つの独立した `f' となります。
  
  画像の符号化に使用するエンコーディング。 <return>hex</return> あるいは <return>85</return>。 hex エンコーディングは、画像の各バイト
  を postscript ファイルの 2 バイトであらわします。85 は Ascii85 エンコーディングを表します。
  
  行番号を段落単位でつける場合は <return>paragraph</return>、 ボックス内でつける場合は <return>box</return> を設定します。
  
  テキストを <strong>ps_show_boxed()</strong> で出力する場合にのみ使用します。 <info>true</info> を設定すると、 改行時にキャリッジ
  リターンが付加されます。
  
  テキストを <strong>ps_show_boxed()</strong> で出力する場合にのみ使用します。 <info>true</info> を設定すると、 キャリッジリターン
  で新しい段落を開始します。
  
  テキストを <strong>ps_show_boxed()</strong> で出力する場合にのみ使用します。 <info>true</info> を設定すると、 ハイフネーション辞
  書が設定されており存在する場合に、 段落のハイフネーション処理が行われます。
  
  ハイフネーションパターンの辞書のファイル名。

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

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


id: ps_get_value
type: function
doc:
<comment>Description:</comment>
  値を取得する
  
  <strong>ps_set_value()</strong> で設定された値を取得します。 値は浮動小数点数値として定義されます。
  
  パラメータ <strong>$name</strong> には以下の値を設定できます。
  
  <return>fontsize</return> 現在アクティブなフォント、 あるいはパラメータ <strong>$modifier</strong> で指定された ID を持つフォントの
  名前。 <return>font</return> 現在アクティブなフォント自身。 <return>imagewidth</return> パラメータ <strong>$modifier</strong> で渡された ID の画像の
  幅。 <return>imageheight</return> パラメータ <strong>$modifier</strong> で渡された ID の画像の高さ。 <return>capheight</return> 現在アクティブなフォ
  ント、 あるいはパラメータ <strong>$modifier</strong> で指定された ID を持つフォントにおける、 大文字の M の高さ。
  <return>ascender</return> 現在アクティブなフォント、 あるいはパラメータ <strong>$modifier</strong> で指定された ID を持つフォントの
  ascender (上に突き出している部分の長さ)。 <return>descender</return> 現在アクティブなフォント、 あるいはパラメータ
  <strong>$modifier</strong> で指定された ID を持つフォントの descender (下に突き出している部分の長さ)。 <return>italicangle</return>
  現在アクティブなフォント、 あるいはパラメータ <strong>$modifier</strong> で指定された ID を持つフォントの斜体の角
  度。 <return>underlineposition</return> 現在アクティブなフォント、 あるいはパラメータ <strong>$modifier</strong> で指定された ID を
  持つフォントの下線の位置。 <return>underlinethickness</return> 現在アクティブなフォント、 あるいはパラメータ
  <strong>$modifier</strong> で指定された ID を持つフォントの下線の太さ。 <return>textx</return> 現在のテキスト出力位置の x 座標。
  <return>texty</return> 現在のテキスト出力位置の y 座標。 <return>textrendering</return> 現在のテキストのレンダリングモード。
  <return>textrise</return> ベースライン上部の空間。 <return>leading</return> テキストの行間隔をポイント数で指定。 <return>wordspacing</return> 単語と
  単語の間の空白の幅を、空白文字の幅を基準として指定。 <return>charspacing</return> 文字と文字の間の空白。0.0 でない
  場合は、リゲチャは常に分解されます。 <return>hyphenminchars</return> 単語の末尾で、ハイフネーションの対象となる最小
  文字数。 <return>parindent</return> 各段落の最初の n 行を字下げします。 <return>numindentlines</return> parindent が 0.0 でない場合
  に、段落内で字下げする行数。 <return>parskip</return> 段落と段落の間隔。 <return>linenumberspace</return> 行番号を表示するために、各
  行の先頭に置く空白。 <return>linenumbersep</return> 行番号と行の内容の間隔。 <return>major</return> pslib のメジャーバージョン番号。
  <return>minor</return> pslib のマイナーバージョン番号。 <return>subminor</return>, <return>revision</return> pslib の詳細バージョン番号。
  
  現在アクティブなフォント、 あるいはパラメータ <strong>$modifier</strong> で指定された ID を持つフォントの名前。
  
  現在アクティブなフォント自身。
  
  パラメータ <strong>$modifier</strong> で渡された ID の画像の幅。
  
  パラメータ <strong>$modifier</strong> で渡された ID の画像の高さ。
  
  現在アクティブなフォント、 あるいはパラメータ <strong>$modifier</strong> で指定された ID を持つフォントにおける、
  大文字の M の高さ。
  
  現在アクティブなフォント、 あるいはパラメータ <strong>$modifier</strong> で指定された ID を持つフォントの ascender
  (上に突き出している部分の長さ)。
  
  現在アクティブなフォント、 あるいはパラメータ <strong>$modifier</strong> で指定された ID を持つフォントの descender
  (下に突き出している部分の長さ)。
  
  現在アクティブなフォント、 あるいはパラメータ <strong>$modifier</strong> で指定された ID を持つフォントの斜体の角
  度。
  
  現在アクティブなフォント、 あるいはパラメータ <strong>$modifier</strong> で指定された ID を持つフォントの下線の位
  置。
  
  現在アクティブなフォント、 あるいはパラメータ <strong>$modifier</strong> で指定された ID を持つフォントの下線の太
  さ。
  
  現在のテキスト出力位置の x 座標。
  
  現在のテキスト出力位置の y 座標。
  
  現在のテキストのレンダリングモード。
  
  ベースライン上部の空間。
  
  テキストの行間隔をポイント数で指定。
  
  単語と単語の間の空白の幅を、空白文字の幅を基準として指定。
  
  文字と文字の間の空白。0.0 でない場合は、リゲチャは常に分解されます。
  
  単語の末尾で、ハイフネーションの対象となる最小文字数。
  
  各段落の最初の n 行を字下げします。
  
  parindent が 0.0 でない場合に、段落内で字下げする行数。
  
  段落と段落の間隔。
  
  行番号を表示するために、各行の先頭に置く空白。
  
  行番号と行の内容の間隔。
  
  pslib のメジャーバージョン番号。
  
  pslib のマイナーバージョン番号。
  
  pslib の詳細バージョン番号。

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>     <strong>ps_new()</strong> が返す、postscript ファイルのリソース ID。
  <info>string</info>    <strong>$name</strong>      値の名前。
  <info>float</info>     <strong>$modifier</strong>  <strong>$modifier</strong> は、値を取得しようとしている リソースを指定します。たとえばフォント
                       や画像の ID が考えられます。

<comment>Return:</comment>
  <info>float</info>  成功した場合にパラメータの値を、失敗した場合に <info>false</info> を返します。

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


id: ps_hyphenate
type: function
doc:
<comment>Description:</comment>
  単語をハイフネーションする
  
  渡された単語をハイフネーションします。<strong>ps_hyphenate()</strong> は、(<strong>ps_set_value()</strong> で設定した)
  hyphenminchars の値と (<strong>ps_set_parameter()</strong> で設定した) hyphendict パラメータの内容を評価します。
  hyphendict は、この関数を呼ぶ前に必ず設定しておかなければなりません。
  
  この関数を利用するためには、LC_CTYPE が適切に設定されている必要があります。 PostScript 拡張が初期
  化される際、環境変数の値が利用されます。 Unix 環境を利用している方は、詳細な情報は locale の man
  ページを見てください。

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  <strong>ps_new()</strong> が返す、postscript ファイルのリソース ID。
  <info>string</info>    <strong>$text</strong>   <strong>$text</strong> にはアルファベット以外の文字を 含むべきではありません。ハイフンで分割でき
                    る位置が、 整数値の配列として返されます。配列の個々の要素の内容は、 <strong>$text</strong> 内でハ
                    イフンを入れられる場所の 次の文字の位置を表します。

<comment>Return:</comment>
  <info>array|false</info>  テキスト内で改行を入れられる位置を表す整数値の配列、 失敗した場合に <info>false</info> を返しま
               す。

<comment>See Also:</comment>
   * <strong>ps_show_boxed()</strong>
   * locale(1)


id: ps_include_file
type: function
doc:
<comment>Description:</comment>
  外部ファイルを生の PostScript コードとして読み込む
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  <strong>ps_new()</strong> が返す postscript ファイルの ID リソース。
  <info>string</info>    <strong>$file</strong>   

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


id: ps_lineto
type: function
doc:
<comment>Description:</comment>
  直線を描く
  
  現在の位置から指定された座標までの直線を現在のパスに追加します。 直線の開始位置を指定するには
  <strong>ps_moveto()</strong> を利用します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  <strong>ps_new()</strong> が返す、postscript ファイルのリソース ID。
  <info>float</info>     <strong>$x</strong>      直線の終了地点の x 座標。
  <info>float</info>     <strong>$y</strong>      直線の終了地点の y 座標。

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

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


id: ps_makespotcolor
type: function
doc:
<comment>Description:</comment>
  スポット色を作成する
  
  現在の塗りつぶし色からスポット色を作成します。塗りつぶし色の色空間は rgb, cmyk または グレースケー
  ルのいずれかでなければなりません。 スポット色には任意の名前をつけることができます。 スポット色に
  は、<strong>ps_setcolor()</strong> を用いてどんな色でも設定できます。 ドキュメントが印刷されずに postscript ビュー
  アで表示される場合にも、 指定した色空間の色が使用されます。

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  <strong>ps_new()</strong> が返す、postscript ファイルのリソース ID。
  <info>string</info>    <strong>$name</strong>   スポット色の名前、例えば Pantone 5565。

<comment>Return:</comment>
  <info>int</info>  成功した場合にスポット色の ID を、失敗した場合にゼロを返します。

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


id: ps_moveto
type: function
doc:
<comment>Description:</comment>
  現在位置を設定する
  
  現在位置を新しい座標に指定します。前回のパスが終了してからはじめて <strong>ps_moveto()</strong> が呼ばれた場合、新
  しいパスを開始します。 もしすでにパスが開始されているときに呼ばれた場合は、 単に現在位置を設定し、
  サブパスを開始します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  <strong>ps_new()</strong> が返す、postscript ファイルのリソース ID。
  <info>float</info>     <strong>$x</strong>      移動する位置の x 座標。
  <info>float</info>     <strong>$y</strong>      移動する位置の y 座標。

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

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


id: ps_new
type: function
doc:
<comment>Description:</comment>
  新しい PostScript ドキュメントオブジェクトを作成する
  
  新しいドキュメントのインスタンスを生成します。 ディスク上やメモリ内にファイルを作ることはありませ
  ん。 ドキュメントのインスタンスがすべてを設定します。 <strong>ps_new()</strong> の後には、通常は <strong>ps_open_file()</strong> が
  コールされます。これにより、 実際に postscript ドキュメントが作成されます。

<comment>Return:</comment>
  <info>resource|false</info>  成功した場合に PostScript ドキュメントのリソースを、 失敗した場合に <info>false</info> を返しま
                  す。 この戻り値は、その他のすべての関数の最初の引数として渡されます。

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


id: ps_open_file
type: function
doc:
<comment>Description:</comment>
  出力用のファイルを開く
  
  ディスク上に新しいファイルを作成し、PostScript ドキュメントをその中に書き込みます。<strong>ps_close()</strong> が呼
  ばれると、ファイルは閉じられます。

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>     <strong>ps_new()</strong> が返す、postscript ファイルのリソース ID。
  <info>string</info>    <strong>$filename</strong>  postscript ファイルの名前。 <strong>$filename</strong> が渡されなかった場合、 ドキュメントはメ
                       モリ内に作成され、内容は直接ブラウザに出力されます。

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

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


id: ps_open_image
type: function
doc:
<comment>Description:</comment>
  後で配置するために画像を読み込む
  
  すでにメモリ上にある画像を読み込みます。現在は <strong>$source</strong> は評価されず、常に <return>memory</return> と仮定されます。
  画像データは、左上から右下に向かってピクセルデータを順に並べたものです。 各ピクセルは、色コンポー
  ネント <strong>$components</strong> で構成されており、このコンポーネントの大きさは <strong>$bpc</strong> ビットです。

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>       <strong>ps_new()</strong> が返す、postscript ファイルのリソース ID。
  <info>string</info>    <strong>$type</strong>        画像の形式。<return>png</return>、 <return>jpeg</return> あるいは <return>eps</return>。
  <info>string</info>    <strong>$source</strong>      使用されません。
  <info>string</info>    <strong>$data</strong>        画像データ。
  <info></info>          <strong>$length</strong>      画像データの長さ。
  <info>int</info>       <strong>$width</strong>       画像の幅。
  <info>int</info>       <strong>$height</strong>      画像の高さ。
  <info>int</info>       <strong>$components</strong>  各ピクセルのコンポーネントの数。 1 (グレースケール画像)、 3 (rgb 画像) ある
                         いは 4 (cmyk, rgba 画像)。
  <info>int</info>       <strong>$bpc</strong>         コンポーネント単位のビット数 (ほとんどの場合は 8)
  <info>string</info>    <strong>$params</strong>      

<comment>Return:</comment>
  <info>int</info>  成功した場合に画像の ID を、失敗した場合にゼロを返します。 ID は、0 より大きい正の数値です。

<comment>See Also:</comment>
   * <strong>ps_open_image_file()</strong>
   * <strong>ps_place_image()</strong>
   * <strong>ps_close_image()</strong>


id: ps_open_image_file
type: function
doc:
<comment>Description:</comment>
  ファイルから画像を開く
  
  後で使用するために、画像を読み込みます。

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>        <strong>ps_new()</strong> が返す、postscript ファイルのリソース ID。
  <info>string</info>    <strong>$type</strong>         画像の形式。<return>png</return>、 <return>jpeg</return> あるいは <return>eps</return>。
  <info>string</info>    <strong>$filename</strong>     画像データを含むファイルの名前。
  <info>string</info>    <strong>$stringparam</strong>  使用されません。
  <info>int</info>       <strong>$intparam</strong>     使用されません。

<comment>Return:</comment>
  <info>int</info>  成功した場合に画像の ID を、失敗した場合にゼロを返します。 ID は、0 より大きい正の数値です。

<comment>See Also:</comment>
   * <strong>ps_open_image()</strong>
   * <strong>ps_place_image()</strong>
   * <strong>ps_close_image()</strong>


id: ps_open_memory_image
type: function
doc:
<comment>Description:</comment>
  GD 画像を受け取り、PS ドキュメントにはめ込む画像を返す
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  <strong>ps_new()</strong> が返す postscript ファイルの ID リソース。
  <info>int</info>       <strong>$gd</strong>     

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


id: ps_place_image
type: function
doc:
<comment>Description:</comment>
  画像をページに配置する
  
  以前に読み込まれている画像をページに配置します。画像の縮尺は変更できます。 画像を回転させる場合
  は、事前に <strong>ps_rotate()</strong> で座標系を回転させておきます。

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>    <strong>ps_new()</strong> が返す、postscript ファイルのリソース ID。
  <info>int</info>       <strong>$imageid</strong>  <strong>ps_open_image()</strong> あるいは <strong>ps_open_image_file()</strong> が返す、 画像のリソース ID。
  <info>float</info>     <strong>$x</strong>        画像の左下角の x 座標。
  <info>float</info>     <strong>$y</strong>        画像の左下角の y 座標。
  <info>float</info>     <strong>$scale</strong>    画像の拡大率。1.0 を指定すると、解像度は 72 dpi となります。 これにより、各ピ
                      クセルが 1 ポイントと等しくなるからです。

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

<comment>See Also:</comment>
   * <strong>ps_open_image()</strong>
   * <strong>ps_open_image_file()</strong>


id: ps_rect
type: function
doc:
<comment>Description:</comment>
  矩形を描く
  
  （<strong>$x</strong>, <strong>$y</strong>）を左下の角とする 矩形を描きます。描画は左下の角から始まって同じ位置で終わります。 もしパ
  スの外部でこの関数が呼び出された場合、新しいパスを開始します。 パスの内部で呼び出された場合は、矩
  形をサブパスとして追加します。一つ前の描画処理が 左下角の位置で終わっていなかった場合は、パスに隙
  間ができることになります。

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>   <strong>ps_new()</strong> が返す、postscript ファイルのリソース ID。
  <info>float</info>     <strong>$x</strong>       矩形の左下角の x 座標。
  <info>float</info>     <strong>$y</strong>       矩形の左下角の y 座標。
  <info>float</info>     <strong>$width</strong>   画像の幅。
  <info>float</info>     <strong>$height</strong>  画像の高さ。

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

<comment>See Also:</comment>
   * <strong>ps_arc()</strong>
   * <strong>ps_cirle()</strong>
   * <strong>ps_lineto()</strong>


id: ps_restore
type: function
doc:
<comment>Description:</comment>
  以前に保存されたコンテキストを復元する
  
  以前に保存されている描画コンテキストを復元します。 すべての <strong>ps_save()</strong> 呼び出しには、対応する
  <strong>ps_restore()</strong> の呼び出しが必要です。 座標系変換、線の設定、色の設定などは、すべて <strong>ps_save()</strong> のコー
  ル前の状態に戻ります。

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  <strong>ps_new()</strong> が返す、postscript ファイルのリソース ID。

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

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


id: ps_rotate
type: function
doc:
<comment>Description:</comment>
  回転の程度を設定する
  
  座標系の回転を設定します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  <strong>ps_new()</strong> が返す、postscript ファイルのリソース ID。
  <info>float</info>     <strong>$rot</strong>    回転角度を度単位で指定します。

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

<comment>See Also:</comment>
   * <strong>ps_scale()</strong>
   * <strong>ps_translate()</strong>


id: ps_save
type: function
doc:
<comment>Description:</comment>
  現在のコンテキストを保存する
  
  現在の描画コンテキストを保存します。 そこには色や変換・回転その他の情報が含まれています。保存され
  たコンテキストは <strong>ps_restore()</strong> で復元できます。

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  <strong>ps_new()</strong> が返す、postscript ファイルのリソース ID。

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

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


id: ps_scale
type: function
doc:
<comment>Description:</comment>
  縮尺を設定する
  
  座標系の、水平方向・垂直方向の縮尺をそれぞれ設定します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  <strong>ps_new()</strong> が返す、postscript ファイルのリソース ID。
  <info>float</info>     <strong>$x</strong>      水平方向の倍率。
  <info>float</info>     <strong>$y</strong>      垂直方向の倍率。

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

<comment>See Also:</comment>
   * <strong>ps_rotate()</strong>
   * <strong>ps_translate()</strong>


id: ps_set_border_color
type: function
doc:
<comment>Description:</comment>
  注記の枠線の色を設定する
  
  <strong>ps_add_weblink()</strong> や <strong>ps_add_pdflink()</strong> などの関数で追加されたリンクは、 pdf に変換して pdf ビューア
  で見た際には矩形で囲まれて表示されます。 この矩形は、postscript ドキュメントでは表示されません。
  この関数は、矩形の枠線の色を設定します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  <strong>ps_new()</strong> が返す、postscript ファイルのリソース ID。
  <info>float</info>     <strong>$red</strong>    枠線の色の red 要素。
  <info>float</info>     <strong>$green</strong>  枠線の色の green 要素。
  <info>float</info>     <strong>$blue</strong>   枠線の色の blue 要素。

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

<comment>See Also:</comment>
   * <strong>ps_set_border_dash()</strong>
   * <strong>ps_set_border_style()</strong>


id: ps_set_border_dash
type: function
doc:
<comment>Description:</comment>
  注記の枠線の、破線の状態を設定する
  
  <strong>ps_add_weblink()</strong> や <strong>ps_add_pdflink()</strong> などの関数で追加されたリンクは、 pdf に変換して pdf ビューア
  で見た際には矩形で囲まれて表示されます。 この矩形は、postscript ドキュメントでは表示されません。
  この関数は、破線の「線」の部分と「空白」の部分の長さを設定します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  <strong>ps_new()</strong> が返す、postscript ファイルのリソース ID。
  <info>float</info>     <strong>$black</strong>  破線の長さ。
  <info>float</info>     <strong>$white</strong>  破線と破線の間隔。

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

<comment>See Also:</comment>
   * <strong>ps_set_border_color()</strong>
   * <strong>ps_set_border_style()</strong>


id: ps_set_border_style
type: function
doc:
<comment>Description:</comment>
  注記の枠線の形式を設定する
  
  <strong>ps_add_weblink()</strong> や <strong>ps_add_pdflink()</strong> などの関数で追加されたリンクは、 pdf に変換して pdf ビューア
  で見た際には矩形で囲まれて表示されます。 この矩形は、postscript ドキュメントでは表示されません。
  この関数は、その線の形式と幅を設定します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  <strong>ps_new()</strong> が返す、postscript ファイルのリソース ID。
  <info>string</info>    <strong>$style</strong>  <strong>$style</strong> は、 <return>solid</return>（実線） または <return>dashed</return>（破線）のいずれかを設定できます。
  <info>float</info>     <strong>$width</strong>  枠線の幅。

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

<comment>See Also:</comment>
   * <strong>ps_set_border_color()</strong>
   * <strong>ps_set_border_dash()</strong>


id: ps_set_info
type: function
doc:
<comment>Description:</comment>
  ドキュメントの情報を設定する
  
  ドキュメントの情報フィールドを設定します。この情報は、PostScript ファイルのヘッダにコメントとして
  表示されます。 ドキュメントが pdf に変換された場合にも、 このフィールドはドキュメントの情報として
  使用されます。
  
  通常 <return>BoundingBox</return> は最初のページの設定と同じ値を 設定しておきます。 <strong>ps_findfont()</strong> が事前に呼ばれて
  いなかった場合のみ、この設定が利用されます。そのような場合、 もしこの関数で明示的に設定していなけ
  れば BoundingBox は空白のままとなります。
  
  postscript ファイルのヘッダが既に書き込まれている場合には、 この関数は何の意味も持ちません。この関
  数は、最初のページの前、 あるいは <strong>ps_findfont()</strong> が最初にコールされる前にコールされる必要がありま
  す。

<comment>Param:</comment>
  <info></info>        <strong>$psdoc</strong>  <strong>ps_new()</strong> が返す、postscript ファイルのリソース ID。
  <info>string</info>  <strong>$key</strong>    設定する情報フィールドの名前。設定できる値は <return>Keywords</return>、<return>Subject</return>、 <return>Title</return>、<return>Creator</return>、
                  <return>Author</return>、<return>BoundingBox</return> および <return>Orientation</return> です。 このうちのいくつかは、PostScript
                  ビューアに対して意味を持つものであることに注意しましょう。
  <info></info>        <strong>$value</strong>  情報フィールドの値。 <return>Orientation</return> フィールドには <return>Portrait</return> あるいは <return>Landscape</return> が設定
                  できます。<return>BoundingBox</return> は 4 つの数値からなる文字列で、最初の 2 つがページの左下角の
                  座標を表します。 残りの 2 つが右上角の座標です。
                  
                  pslib のバージョン 0.2.6 まででは、 <strong>ps_findfont()</strong> が事前にコールされていない限り、
                  この関数は常に BoundingBox および Orientation を上書きします。

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

<comment>See Also:</comment>
   * <strong>ps_findfont()</strong>
   * <strong>ps_begin_page()</strong>


id: ps_set_parameter
type: function
doc:
<comment>Description:</comment>
  パラメータを設定する
  
  多くの関数で利用されるパラメータを設定します。 パラメータは文字列値として定義されます。

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  <strong>ps_new()</strong> が返す、postscript ファイルのリソース ID。
  <info>string</info>    <strong>$name</strong>   使用できる名称については <strong>ps_get_parameter()</strong> を参照ください。
  <info>string</info>    <strong>$value</strong>  パラメータの値。

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

<comment>See Also:</comment>
   * <strong>ps_get_parameter()</strong>
   * <strong>ps_set_value()</strong>


id: ps_set_text_pos
type: function
doc:
<comment>Description:</comment>
  テキストの出力位置を設定する
  
  テキストを出力する位置を設定します。別の方法として、x と y の値を別々に <strong>ps_set_value()</strong> で設定する
  こともできます。 この場合の設定項目は、それぞれ <return>textx</return> と <return>texty</return> となります。
  
  テキストを所定の位置に出力したいのなら、テキストの位置を指定してから <strong>ps_show()</strong> をコールするより
  も、 <strong>ps_show_xy()</strong> を使用するほうが便利です。

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  <strong>ps_new()</strong> が返す、postscript ファイルのリソース ID。
  <info>float</info>     <strong>$x</strong>      新しいテキスト位置の x 座標。
  <info>float</info>     <strong>$y</strong>      新しいテキスト位置の y 座標。

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

<comment>See Also:</comment>
   * <strong>ps_set_value()</strong>
   * <strong>ps_show()</strong>


id: ps_set_value
type: function
doc:
<comment>Description:</comment>
  値を設定する
  
  多くの関数で利用される値を設定します。 パラメータは浮動小数点数値として定義されます。

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  <strong>ps_new()</strong> が返す、postscript ファイルのリソース ID。
  <info>string</info>    <strong>$name</strong>   <strong>$name</strong> は以下のうちのひとつです。 textrendering テキストをどのように見せるか。
                    textx 出力テキストの x 座標。 texty 出力テキストの y 座標。 wordspacing 単語の間
                    隔を空白文字に対する比率で設定する。 leading 行間をピクセルで指定する。
                    
                    テキストをどのように見せるか。
                    
                    出力テキストの x 座標。
                    
                    出力テキストの y 座標。
                    
                    単語の間隔を空白文字に対する比率で設定する。
                    
                    行間をピクセルで指定する。
  <info>float</info>     <strong>$value</strong>  パラメータの値。

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

<comment>See Also:</comment>
   * <strong>ps_get_value()</strong>
   * <strong>ps_set_parameter()</strong>


id: ps_setcolor
type: function
doc:
<comment>Description:</comment>
  色を設定する
  
  描画色、塗りつぶし色、あるいはその両方を設定します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>       <strong>ps_new()</strong> が返す、postscript ファイルのリソース ID。
  <info>string</info>    <strong>$type</strong>        <strong>$type</strong> は <return>both</return>、<return>fill</return>、 あるいは <return>fillstroke</return> のいずれかです。
  <info>string</info>    <strong>$colorspace</strong>  colorspace は <return>gray</return>、 <return>rgb</return>、<return>cmyk</return>、 <return>spot</return>、<return>pattern</return> のいずれかです。 colorspace
                         の値によって、以下のパラメータのうち最初のひとつ・最初の３つ あるいはすべて
                         が利用されます。
  <info>float</info>     <strong>$c1</strong>          colorspace の値によって、red 成分 (rgb の場合)、 cyan 成分 (cmyk の場合)、
                         グレースケール (gray の場合)、 スポット色の ID あるいはパターンの ID のいず
                         れかとなります。
  <info>float</info>     <strong>$c2</strong>          colorspace の値によって、green 成分 (rgb の場合)、 magenta 成分 (cmyk の場
                         合) のいずれかとなります。
  <info>float</info>     <strong>$c3</strong>          colorspace の値によって、blue 成分 (rgb の場合)、 yellow 成分 (cmyk の場合)
                         のいずれかとなります。
  <info>float</info>     <strong>$c4</strong>          colorspace が cmyk の場合にのみ設定され、black 成分の値を指定します。

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


id: ps_setdash
type: function
doc:
<comment>Description:</comment>
  破線の形状を設定する
  
  破線の「線」の部分と「空白」の部分の長さを設定します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  <strong>ps_new()</strong> が返す、postscript ファイルのリソース ID。
  <info>float</info>     <strong>$on</strong>     破線の長さ。
  <info>float</info>     <strong>$off</strong>    破線と破線の間隔の長さ。

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

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


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

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  <strong>ps_new()</strong> が返す、postscript ファイルのリソース ID。
  <info>float</info>     <strong>$value</strong>  <strong>$value</strong> は 0.2 から 1 までの間でなければなりません。

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


id: ps_setfont
type: function
doc:
<comment>Description:</comment>
  以降の出力で用いるフォントを設定する
  
  フォントを設定します。このフォントは、事前に <strong>ps_findfont()</strong> で読み込まれている必要があります。 フォ
  ントを設定せずにテキストを出力するとエラーとなります。

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>   <strong>ps_new()</strong> が返す、postscript ファイルのリソース ID。
  <info>int</info>       <strong>$fontid</strong>  <strong>ps_findfont()</strong> が返す、フォント ID。
  <info>float</info>     <strong>$size</strong>    フォントのサイズ。

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

<comment>See Also:</comment>
   * <strong>ps_findfont()</strong>
   * <strong>ps_set_text_pos()</strong> for an example.


id: ps_setgray
type: function
doc:
<comment>Description:</comment>
  グレー値を設定する
  
  以降の描画処理で使われるグレー値を設定します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  <strong>ps_new()</strong> が返す、postscript ファイルのリソース ID。
  <info>float</info>     <strong>$gray</strong>   値は 0（白）から 1（黒）までの間でなければなりません。

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

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


id: ps_setlinecap
type: function
doc:
<comment>Description:</comment>
  線端の形状を設定する
  
  線端をどのように表示するかを設定します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  <strong>ps_new()</strong> が返す、postscript ファイルのリソース ID。
  <info>int</info>       <strong>$type</strong>   線端の形式。 <return>PS_LINECAP_BUTT</return>、 <return>PS_LINECAP_ROUND</return> あるいは <return>PS_LINECAP_SQUARED</return> のい
                    ずれか。

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

<comment>See Also:</comment>
   * <strong>ps_setlinejoin()</strong>
   * <strong>ps_setlinewidth()</strong>
   * <strong>ps_setmiterlimit()</strong>


id: ps_setlinejoin
type: function
doc:
<comment>Description:</comment>
  線の連結方法を設定する
  
  線がどのように連結されるかを設定します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  <strong>ps_new()</strong> が返す、postscript ファイルのリソース ID。
  <info>int</info>       <strong>$type</strong>   線の連結方式。 <return>PS_LINEJOIN_MITER</return>、 <return>PS_LINEJOIN_ROUND</return> あるいは <return>PS_LINEJOIN_BEVEL</return>
                    のいずれか。

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

<comment>See Also:</comment>
   * <strong>ps_setlinecap()</strong>
   * <strong>ps_setlinewidth()</strong>
   * <strong>ps_setmiterlimit()</strong>


id: ps_setlinewidth
type: function
doc:
<comment>Description:</comment>
  線幅を設定する
  
  以降の描画処理での線幅を設定します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  <strong>ps_new()</strong> が返す、postscript ファイルのリソース ID。
  <info>float</info>     <strong>$width</strong>  線の幅 (ポイント数)。

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

<comment>See Also:</comment>
   * <strong>ps_setlinecap()</strong>
   * <strong>ps_setlinejoin()</strong>
   * <strong>ps_setmiterlimit()</strong>


id: ps_setmiterlimit
type: function
doc:
<comment>Description:</comment>
  miter limit 値を設定する
  
  2 本の直線が小さい角度で連結され、かつ連結方法が <return>PS_LINEJOIN_MITER</return> に設定されている場合、 出来上が
  る線の角の部分が非常に長くなります。miter limit は、miter length (角の長さ) と線幅の比率の最大値で
  す。

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  <strong>ps_new()</strong> が返す、postscript ファイルのリソース ID。
  <info>float</info>     <strong>$value</strong>  miter length と線幅の比率の最大値。大きな値 (&gt; 10) を設定すると、2 本の直線が
                    狭い角度で交わる際に、 角の部分が非常に長くなってしまいます。 よくわからない場合
                    はデフォルトのままにしておきましょう。

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

<comment>See Also:</comment>
   * <strong>ps_setlinecap()</strong>
   * <strong>ps_setlinejoin()</strong>
   * <strong>ps_setlinewidth()</strong>


id: ps_setoverprintmode
type: function
doc:
<comment>Description:</comment>
  overprint モードを設定する
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  <strong>ps_new()</strong> が返す postscript ファイルの ID リソース。
  <info>int</info>       <strong>$mode</strong>   

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


