# php_manual

id: WSDL_CACHE_NONE
type: constant
doc:
<comment>Description:</comment>
  SoapClient::__construct や SoapServer::__construct に渡す soap.wsdl_cache や <return>wsdl_cache</return> オプション
  で使う WDSL キャッシュを無効にします。


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


id: WeakMap
type: class
doc:
<comment>Description:</comment>
  <class>WeakMap</class> は、 オブジェクトをキーとして受け入れるマップ(辞書)です。 <class>SplObjectStorage</class> と似ています
  が、 <class>WeakMap</class> のキーとなるオブジェクトは、 オブジェクトのリファレンスカウントが更新されません。 つ
  まり、<class>WeakMap</class> のキーとなっているオブジェクトだけが唯一の残された参照だった場合、 オブジェクトはガ
  ベージコレクションの対象となり <class>WeakMap</class> から削除されます。 <class>WeakMap</class> の用途は、 長く生き残る必要がな
  いオブジェクトから派生した、 データのキャッシュを作ることです。
  
  <class>WeakMap</class> は ArrayAccess, Iterator, Countable を実装しています。 よって、ほとんどのケースで、 連想配
  列と同じやり方で操作できます。


id: WeakMap::count
type: function
doc:
<comment>Description:</comment>
  マップ内に存在する有効なエントリの数を数える
  
  マップ内の有効なエントリの数を数えます。

<comment>Return:</comment>
  <info>int</info>  マップ内の有効なエントリの数を返します。


id: WeakMap::getIterator
type: function
doc:
<comment>Description:</comment>
  イテレータを取得する
  
  イテレータを返します。

<comment>Return:</comment>
  <info>Iterator</info>  <class>Iterator</class> または <class>Traversable</class> を実装したオブジェクトのインスタンスを返します。


id: WeakMap::offsetExists
type: function
doc:
<comment>Description:</comment>
  あるオブジェクトがマップ内に存在するかを調べる
  
  指定されたオブジェクトが、マップ内で参照されているかを調べます。

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  チェックするオブジェクト

<comment>Return:</comment>
  <info>bool</info>  オブジェクトがマップ内に含まれている場合、<info>true</info> を返します。 そうでない場合、<info>false</info> を返しま
        す。


id: WeakMap::offsetGet
type: function
doc:
<comment>Description:</comment>
  オブジェクトが指す値を返す
  
  指定されたオブジェクトが指す値を返します。

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  マップにキーとして含まれるオブジェクト

<comment>Return:</comment>
  <info>mixed</info>  引数で渡されたオブジェクトに関連付けられた値を返します。 オブジェクトがマップに存在しない場
         合、<info>null</info> を返します。


id: WeakMap::offsetSet
type: function
doc:
<comment>Description:</comment>
  新しいキーと値でマップを更新する
  
  新しいキーと値でマップを更新します。 既にキーがマップに存在した場合、古い値は新しい値で置き換えら
  れます。

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  キーと値のペアを構成する、キーとなるオブジェクト
  <info>mixed</info>   <strong>$value</strong>   キーと値のペアのうち、値となる任意のデータ

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


id: WeakMap::offsetUnset
type: function
doc:
<comment>Description:</comment>
  マップからエントリを削除する
  
  マップからエントリを削除します。

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  マップから削除するオブジェクト

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


id: WeakReference
type: class
doc:
<comment>Description:</comment>
  弱い参照により、オブジェクトが破棄されるのを妨げないオブジェクトへの参照を保持することが可能です。
  この機能は、キャッシュのようなデータ構造を実装するのに役立ちます。
  
  <class>WeakReference</class> クラスはシリアライズできません。


id: WeakReference::__construct
type: function
doc:
<comment>Description:</comment>
  コンストラクタを使ってインスタンス化はできません
  
  このメソッドは、<class>WeakReference</class> クラスの インスタンス化を禁止するためだけに存在しています。
  <class>WeakReference</class> は、 ファクトリメソッド WeakReference::create  を使ってインスタンス化されることに
  なっています。

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


id: WeakReference::create
type: function
doc:
<comment>Description:</comment>
  弱い参照を生成する
  
  新しい <class>WeakReference</class> を生成します

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  このオブジェクトは、弱く参照されます。

<comment>Return:</comment>
  <info>WeakReference</info>  インスタンス化されたばかりのオブジェクトを返します


id: WeakReference::get
type: function
doc:
<comment>Description:</comment>
  弱く参照されたオブジェクトを取得する
  
  弱く参照されたオブジェクトを取得します。 既にオブジェクトが破棄されていた場合、<info>null</info> が返されます。

<comment>Return:</comment>
  <info>object|null</info>  参照されている <info>object</info> を返します。 オブジェクトが破棄されている場合は、<info>null</info> を返しま
               す。


id: Worker
type: class
doc:
<comment>Description:</comment>
  ワーカースレッドには永続コンテキストがあり、たいていの場合はスレッドに対して使えます。
  
  ワーカーを開始させると run メソッドを実行しますが、以下のいずれかの条件を満たすまでスレッドは終了
  しません。
  
  Worker がスコープから外れる (どこからも参照されなくなる)
  
  プログラマーが shutdown を呼ぶ
  
  スクリプトが終了する
  
  つまり、プログラマーは実行中のコンテキストを再利用できるということです。 オブジェクトを Worker の
  スタックに置くと、そのオブジェクトの run メソッドを Worker が実行します。


id: Worker::collect
type: function
doc:
<comment>Description:</comment>
  Collect references to completed tasks
  
  Allows the worker to collect references determined to be garbage by the optionally given
  collector.

<comment>Param:</comment>
  <info>Callable</info>  <strong>$collector</strong>  A Callable collector that returns a boolean on whether the task can be
                        collected or not. Only in rare cases should a custom collector need to be
                        used.

<comment>Return:</comment>
  <info>int</info>  The number of remaining tasks on the worker's stack to be collected.


id: Worker::getStacked
type: function
doc:
<comment>Description:</comment>
  Gets the remaining stack size
  
  Returns the number of tasks left on the stack

<comment>Return:</comment>
  <info>int</info>  Returns the number of tasks currently waiting to be executed by the worker


id: Worker::isShutdown
type: function
doc:
<comment>Description:</comment>
  State Detection
  
  Whether the worker has been shutdown or not.

<comment>Return:</comment>
  <info>bool</info>  Returns whether the worker has been shutdown or not.


id: Worker::shutdown
type: function
doc:
<comment>Description:</comment>
  Shutdown the worker
  
  Shuts down the worker after executing all of the stacked tasks.

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


id: Worker::stack
type: function
doc:
<comment>Description:</comment>
  Stacking work
  
  Appends the new work to the stack of the referenced worker.

<comment>Param:</comment>
  <info>Threaded</info>  <strong>$work</strong>  A <class>Threaded</class> object to be executed by the worker.

<comment>Return:</comment>
  <info>int</info>  The new size of the stack.


id: Worker::unstack
type: function
doc:
<comment>Description:</comment>
  Unstacking work
  
  Removes the first task (the oldest one) in the stack.

<comment>Return:</comment>
  <info>int</info>  The new size of the stack.


id: XDIFF_PATCH_NORMAL
type: constant
doc:
<comment>Description:</comment>
  このフラグは、<strong>xdiff_string_patch()</strong> 関数および <strong>xdiff_file_patch()</strong> 関数が元のファイルにパッチを適用
  して新しいバージョンのファイルを作成することを意味します。 デフォルトの操作モードです。


id: XDIFF_PATCH_REVERSE
type: constant
doc:
<comment>Description:</comment>
  このフラグは、<strong>xdiff_string_patch()</strong> 関数および <strong>xdiff_file_patch()</strong> 関数がパッチを逆に適用し、新しい
  バージョンから元のバージョンを作成することを意味します。


id: XMLDiff\Base
type: class
doc:
<comment>Description:</comment>
  Base abstract class for all the comparsion classes in the extension.


id: XMLDiff\Base::__construct
type: function
doc:
<comment>Description:</comment>
  Constructor
  
  Base constructor for all the worker classes in the xmldiff extension.

<comment>Param:</comment>
  <info>string</info>  <strong>$nsname</strong>  Custom namespace name for the diff document. The default namespace is
                   http://www.locus.cz/diffmark and that's enough to avoid namespace conflicts. Use
                   this parameter if you want to change it for some reason.


id: XMLDiff\Base::diff
type: function
doc:
<comment>Description:</comment>
  Produce diff of two XML documents
  
  Abstract diff method to be implemented by inheriting classes.
  
  The basic purpose of this method is to produce diff of the two documents. The param order matters
  and will produce different output.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$from</strong>  Source XML document.
  <info>mixed</info>  <strong>$to</strong>    Target XML document.

<comment>Return:</comment>
  <info>mixed</info>  Implementation dependent.


id: XMLDiff\Base::merge
type: function
doc:
<comment>Description:</comment>
  Produce new XML document based on diff
  
  Abstract merge method to be implemented by inheriting classes.
  
  Basically the method purpose is to produce a new XML document based on the diff information.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$src</strong>   Source XML document.
  <info>mixed</info>  <strong>$diff</strong>  Document produced by the diff method.

<comment>Return:</comment>
  <info>mixed</info>  Implementation dependent.


id: XMLDiff\DOM::diff
type: function
doc:
<comment>Description:</comment>
  Diff two DOMDocument objects
  
  Diff two DOMDocument instances and produce the new one containing the diff information.

<comment>Param:</comment>
  <info>DOMDocument</info>  <strong>$from</strong>  Source DOMDocument object.
  <info>DOMDocument</info>  <strong>$to</strong>    Target DOMDocument object.

<comment>Return:</comment>
  <info>DOMDocument</info>  DOMDocument with the diff information or NULL.


id: XMLDiff\DOM::merge
type: function
doc:
<comment>Description:</comment>
  Produce merged DOMDocument
  
  Create new DOMDocument based on the diff.

<comment>Param:</comment>
  <info>DOMDocument</info>  <strong>$src</strong>   Source DOMDocument object.
  <info>DOMDocument</info>  <strong>$diff</strong>  DOMDocument object containing the diff information.

<comment>Return:</comment>
  <info>DOMDocument</info>  Merged DOMDocument or NULL.


id: XMLDiff\File::diff
type: function
doc:
<comment>Description:</comment>
  Diff two XML files
  
  Diff two local XML files and produce string with the diff information.

<comment>Param:</comment>
  <info>string</info>  <strong>$from</strong>  Path to the source document.
  <info>string</info>  <strong>$to</strong>    Path to the target document.

<comment>Return:</comment>
  <info>string</info>  String with the XML document containing the diff information or NULL.


id: XMLDiff\File::merge
type: function
doc:
<comment>Description:</comment>
  Produce merged XML document
  
  Create new XML document based on diffs and source document.

<comment>Param:</comment>
  <info>string</info>  <strong>$src</strong>   Path to the source XML document.
  <info>string</info>  <strong>$diff</strong>  Path to the XML document with the diff information.

<comment>Return:</comment>
  <info>string</info>  String with the new XML document or NULL.


id: XMLDiff\Memory::diff
type: function
doc:
<comment>Description:</comment>
  Diff two XML documents
  
  Diff two strings containing XML documents and produce the diff information.

<comment>Param:</comment>
  <info>string</info>  <strong>$from</strong>  Source XML document.
  <info>string</info>  <strong>$to</strong>    Target XML document.

<comment>Return:</comment>
  <info>string</info>  String with the XML document containing the diff information or NULL.


id: XMLDiff\Memory::merge
type: function
doc:
<comment>Description:</comment>
  Produce merged XML document
  
  Create new XML document based on diffs and source document.

<comment>Param:</comment>
  <info>string</info>  <strong>$src</strong>   Source XML document.
  <info>string</info>  <strong>$diff</strong>  XML document containing diff information.

<comment>Return:</comment>
  <info>string</info>  String with the new XML document or NULL.


id: XMLReader
type: class
doc:
<comment>Description:</comment>
  XMLReader 拡張モジュールは、プル型の XML パーサです。ドキュメント ストリーム内をカーソル風に進んで
  いき、その途中の各ノードで立ち止まります。


id: XMLReader::XML
type: function
doc:
<comment>Description:</comment>
  パースする XML を含むデータを設定する
  
  パースする XML を含むデータを設定します。

<comment>Param:</comment>
  <info>string</info>       <strong>$source</strong>    パースされる XML を含む文字列。
  <info>string|null</info>  <strong>$encoding</strong>  ドキュメントのエンコーディングあるいは <info>null</info>。
  <info>int</info>          <strong>$flags</strong>     LIBXML_* 定数のビットマスク。

<comment>Return:</comment>
  <info>bool|XMLReader</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。 staticメソッドとしてコー
                  ルされた場合には <class>XMLReader</class> を返します。 失敗した場合に <info>false</info> を返します

<comment>See Also:</comment>
   * XMLReader::open
   * XMLReader::close


id: XMLReader::close
type: function
doc:
<comment>Description:</comment>
  XMLReader の入力を閉じる
  
  XMLReader オブジェクトが現在パースしている入力を閉じます。

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

<comment>See Also:</comment>
   * XMLReader::open
   * XMLReader::xml


id: XMLReader::expand
type: function
doc:
<comment>Description:</comment>
  現在のノードのコピーを DOM オブジェクトとして返す
  
  このメソッドは、現在のノードをコピーして適切な DOM オブジェクトを返します。

<comment>Param:</comment>
  <info>DOMNode|null</info>  <strong>$baseNode</strong>  DOM オブジェクトを作る対象の <class>DOMDocument</class> を示す <class>DOMNode</class>。

<comment>Return:</comment>
  <info>DOMNode|false</info>  <class>DOMNode</class> か、エラー時には <info>false</info> を返します。


id: XMLReader::getAttribute
type: function
doc:
<comment>Description:</comment>
  名前をもとに、属性の値を取得する
  
  指定した名前の属性の値を返します。属性が存在しなかったり 現在位置が要素ノードでなかったりした場合
  には <info>null</info> を返します。

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  属性の名前。

<comment>Return:</comment>
  <info>string|null</info>  属性の値を返します。指定した名前 <strong>$name</strong> の 属性が見つからなかったり、現在位置が要素
               ノードではなかったりした場合には <info>null</info> を返します。

<comment>See Also:</comment>
   * XMLReader::getAttributeNo
   * XMLReader::getAttributeNs


id: XMLReader::getAttributeNo
type: function
doc:
<comment>Description:</comment>
  インデックスをもとに、属性の値を取得する
  
  その位置をもとにして属性の値を返します。属性が存在しなかったり 現在位置が要素ノードでなかったりし
  た場合には空の文字列を返します。

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  属性の位置。

<comment>Return:</comment>
  <info>string|null</info>  属性の値を返します。指定した位置 <strong>$index</strong> に 属性が見つからなかったり、現在位置が要素で
               はなかったりした場合には <info>null</info> を返します。

<comment>See Also:</comment>
   * XMLReader::getAttribute
   * XMLReader::getAttributeNs


id: XMLReader::getAttributeNs
type: function
doc:
<comment>Description:</comment>
  名前および URI をもとに、属性の値を取得する
  
  名前および名前空間 URI をもとにして属性の値を返します。 属性が存在しなかったり、現在位置が要素ノー
  ドでなかったりした場合には 空の文字列を返します。

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>       ローカルの名前。
  <info>string</info>  <strong>$namespace</strong>  名前空間の URI。

<comment>Return:</comment>
  <info>string|null</info>  属性の値を返します。指定した <strong>$name</strong> および <strong>$namespace</strong> に属性が見つからなかったり、 現
               在位置が要素ではなかったりした場合には <info>null</info> を返します。

<comment>See Also:</comment>
   * XMLReader::getAttribute
   * XMLReader::getAttributeNo


id: XMLReader::getParserProperty
type: function
doc:
<comment>Description:</comment>
  指定したプロパティが設定されているかどうかを示す
    
  
  指定したプロパティが設定されているかどうかを示します。

<comment>Param:</comment>
  <info>int</info>  <strong>$property</strong>  パーサオプション定数 のうちのひとつ。

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

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


id: XMLReader::isValid
type: function
doc:
<comment>Description:</comment>
  パースしているドキュメントの妥当性を示す
  
  パースしているドキュメントが妥当なものであるかどうかを論理型で返します。

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

<comment>See Also:</comment>
   * XMLReader::setParserProperty
   * XMLReader::setRelaxNGSchema
   * XMLReader::setRelaxNGSchemaSource
   * XMLReader::setSchema


id: XMLReader::lookupNamespace
type: function
doc:
<comment>Description:</comment>
  プレフィックスから、名前空間を検索する
  
  指定したプレフィックスをもとに、スコープの名前空間を検索します。

<comment>Param:</comment>
  <info>string</info>  <strong>$prefix</strong>  プレフィックスを含む文字列。

<comment>Return:</comment>
  <info>string|null</info>  名前空間の値を返します。 見つからなかった場合は、<info>null</info> を返します。


id: XMLReader::moveToAttribute
type: function
doc:
<comment>Description:</comment>
  指定した名前の属性にカーソルを移動する
  
  指定した名前の属性にカーソルを移動します。

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  属性の名前。

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

<comment>See Also:</comment>
   * XMLReader::moveToElement
   * XMLReader::moveToAttributeNo
   * XMLReader::moveToAttributeNs
   * XMLReader::moveToFirstAttribute


id: XMLReader::moveToAttributeNo
type: function
doc:
<comment>Description:</comment>
  指定したインデックスの属性にカーソルを移動する
  
  指定した位置の属性にカーソルを移動します。

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  属性の位置。

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

<comment>See Also:</comment>
   * XMLReader::moveToElement
   * XMLReader::moveToAttribute
   * XMLReader::moveToAttributeNs
   * XMLReader::moveToFirstAttribute


id: XMLReader::moveToAttributeNs
type: function
doc:
<comment>Description:</comment>
  指定した名前の属性にカーソルを移動する
  
  指定した名前空間内で、指定した名前の属性にカーソルを移動します。

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>       ローカル名。
  <info>string</info>  <strong>$namespace</strong>  名前空間の URI。

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

<comment>See Also:</comment>
   * XMLReader::moveToElement
   * XMLReader::moveToAttribute
   * XMLReader::moveToAttributeNo
   * XMLReader::moveToFirstAttribute


id: XMLReader::moveToElement
type: function
doc:
<comment>Description:</comment>
  現在の属性の親要素にカーソルを移動する
  
  現在の属性の親要素にカーソルを移動します。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info>、失敗した場合、 あるいはメソッドがコールされた際の位置が属性ノードではな
        かった場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * XMLReader::moveToAttribute
   * XMLReader::moveToAttributeNo
   * XMLReader::moveToAttributeNs
   * XMLReader::moveToFirstAttribute


id: XMLReader::moveToFirstAttribute
type: function
doc:
<comment>Description:</comment>
  最初の属性にカーソルを移動する
  
  最初の属性にカーソルを移動します。

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

<comment>See Also:</comment>
   * XMLReader::moveToElement
   * XMLReader::moveToAttribute
   * XMLReader::moveToAttributeNo
   * XMLReader::moveToAttributeNs
   * XMLReader::moveToNextAttribute


id: XMLReader::moveToNextAttribute
type: function
doc:
<comment>Description:</comment>
  次の属性にカーソルを移動する
  
  現在位置が属性ノードの場合は次の属性にカーソルを移動します。 現在位置が要素ノードの場合は最初の属
  性にカーソルを移動します。

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

<comment>See Also:</comment>
   * XMLReader::moveToElement
   * XMLReader::moveToAttribute
   * XMLReader::moveToAttributeNo
   * XMLReader::moveToAttributeNs
   * XMLReader::moveToFirstAttribute


id: XMLReader::next
type: function
doc:
<comment>Description:</comment>
  すべてのサブツリーを飛ばして、次のノードにカーソルを移動する
  
  すべてのサブツリーを飛ばして、カーソルを次のノードに移動します。 次のノードが存在しない場合、カー
  ソルは文書の一番最後に移動します。

<comment>Param:</comment>
  <info>string|null</info>  <strong>$name</strong>  移動先のノードの名前。

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

<comment>See Also:</comment>
   * XMLReader::moveToNextAttribute
   * XMLReader::moveToElement
   * XMLReader::moveToAttribute


id: XMLReader::open
type: function
doc:
<comment>Description:</comment>
  パースする XML を含む URI を設定する
  
  パースされる XML ドキュメントを含む URI を設定します。

<comment>Param:</comment>
  <info>string</info>       <strong>$uri</strong>       ドキュメントを指す URI。
  <info>string|null</info>  <strong>$encoding</strong>  ドキュメントのエンコーディングあるいは <info>null</info>。
  <info>int</info>          <strong>$flags</strong>     LIBXML_* 定数のビットマスク。

<comment>Return:</comment>
  <info>bool|XMLReader</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。 static メソッドとして
                  コールされた場合には <class>XMLReader</class> を返します。 失敗した場合に <info>false</info> を返します

<comment>See Also:</comment>
   * XMLReader::xml
   * XMLReader::close


id: XMLReader::read
type: function
doc:
<comment>Description:</comment>
  ドキュメント内の次のノードに移動する
  
  ドキュメント内の次のノードにカーソルを移動します。

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

<comment>See Also:</comment>
   * XMLReader::moveToElement
   * XMLReader::moveToAttribute
   * XMLReader::next


id: XMLReader::readInnerXml
type: function
doc:
<comment>Description:</comment>
  現在のノードから XML を取得する
  
  現在のノードの中身を、子ノードやマークアップも含めて読み込みます。

<comment>Return:</comment>
  <info>string</info>  現在のノードの中身を文字列で返します。失敗した場合は空文字列を返します。

<comment>See Also:</comment>
   * <strong>XMLReader::readString()</strong>
   * <strong>XMLReader::readOuterXml()</strong>
   * <strong>XMLReader::expand()</strong>


id: XMLReader::readOuterXml
type: function
doc:
<comment>Description:</comment>
  現在のノードから自分自身も含めた XML を取得する
  
  現在のノードの中身を、ノード自身も含めて読み込みます。

<comment>Return:</comment>
  <info>string</info>  現在のノードの中身を、自分自身も含めて文字列で返します。失敗した場合は空文字列を返します。

<comment>See Also:</comment>
   * <strong>XMLReader::readString()</strong>
   * <strong>XMLReader::readInnerXml()</strong>
   * <strong>XMLReader::expand()</strong>


id: XMLReader::readString
type: function
doc:
<comment>Description:</comment>
  現在のノードの内容を文字列で読み込む
  
  現在のノードの内容を文字列で読み込みます。

<comment>Return:</comment>
  <info>string</info>  現在のノードの内容を文字列で返します。失敗した場合は空文字列を返します。

<comment>See Also:</comment>
   * <strong>XMLReader::readOuterXml()</strong>
   * <strong>XMLReader::readInnerXml()</strong>
   * <strong>XMLReader::expand()</strong>


id: XMLReader::setParserProperty
type: function
doc:
<comment>Description:</comment>
  パーサのオプションを設定する
  
  パーサのオプションを設定します。オプションは、 XMLReader::open あるいは XMLReader::xml がコールさ
  れた後で、かつ XMLReader::read が最初にコールされる前に 設定する必要があります。

<comment>Param:</comment>
  <info>int</info>   <strong>$property</strong>  パーサオプション定数 のひとつ。
  <info>bool</info>  <strong>$value</strong>     <info>true</info> を設定するとオプションが有効になり、それ以外を設定すると 無効になります。

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


id: XMLReader::setRelaxNGSchema
type: function
doc:
<comment>Description:</comment>
  RelaxNG スキーマのファイル名あるいは URI を設定する
  
  検証の際に使用する RelaxNG スキーマのファイル名あるいは URI を 設定します。

<comment>Param:</comment>
  <info>string|null</info>  <strong>$filename</strong>  RelaxNG スキーマを指すファイル名あるいは URI。

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

<comment>See Also:</comment>
   * XMLReader::setRelaxNGSchemaSource
   * XMLReader::setSchema
   * XMLReader::isValid


id: XMLReader::setRelaxNGSchemaSource
type: function
doc:
<comment>Description:</comment>
  RelaxNG スキーマを含むデータを設定する
  
  検証の際に使用する RelaxNG スキーマを含むデータを設定します。

<comment>Param:</comment>
  <info>string|null</info>  <strong>$source</strong>  RelaxNG スキーマを含む文字列。

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

<comment>See Also:</comment>
   * XMLReader::setRelaxNGSchema
   * XMLReader::setSchema
   * XMLReader::isValid


id: XMLReader::setSchema
type: function
doc:
<comment>Description:</comment>
  ドキュメントを XSD で検証する
  
  W3C XSD スキーマを用いて、処理中のドキュメントを検証します。 最初の Read() の前にのみ実行可能で
  す。

<comment>Param:</comment>
  <info>string|null</info>  <strong>$filename</strong>  XSD スキーマファイル名。

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

<comment>See Also:</comment>
   * XMLReader::setRelaxNGSchema
   * XMLReader::setRelaxNGSchemaSource
   * XMLReader::isValid


id: XMLWriter::endAttribute
type: function
doc:
<comment>Description:</comment>
  属性を終了する
  
  オブジェクト指向型
  
  手続き型
  
  現在の属性を終了します。

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  手続き型のコールでのみ使用します。 変更される <class>XMLWriter</class> のインスタンスです。
                      このインスタンスは、<strong>xmlwriter_open_uri()</strong> あるいは <strong>xmlwriter_open_memory()</strong> を呼
                      び出すことで取得したものです。

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

<comment>See Also:</comment>
   * XMLWriter::startAttribute
   * XMLWriter::startAttributeNs
   * XMLWriter::writeAttribute
   * XMLWriter::writeAttributeNs


id: XMLWriter::endCdata
type: function
doc:
<comment>Description:</comment>
  現在の CDATA を終了する
  
  オブジェクト指向型
  
  手続き型
  
  現在の CDATA セクションを終了します。

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  手続き型のコールでのみ使用します。 変更される <class>XMLWriter</class> のインスタンスです。
                      このインスタンスは、<strong>xmlwriter_open_uri()</strong> あるいは <strong>xmlwriter_open_memory()</strong> を呼
                      び出すことで取得したものです。

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

<comment>See Also:</comment>
   * XMLWriter::startCdata
   * XMLWriter::writeCdata


id: XMLWriter::endComment
type: function
doc:
<comment>Description:</comment>
  コメントの終了部を作成する
  
  オブジェクト指向型
  
  手続き型
  
  現在のコメントを終了します。

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  手続き型のコールでのみ使用します。 変更される <class>XMLWriter</class> のインスタンスです。
                      このインスタンスは、<strong>xmlwriter_open_uri()</strong> あるいは <strong>xmlwriter_open_memory()</strong> を呼
                      び出すことで取得したものです。

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

<comment>See Also:</comment>
   * XMLWriter::startComment
   * XMLWriter::writeComment


id: XMLWriter::endDocument
type: function
doc:
<comment>Description:</comment>
  現在のドキュメントを終了する
  
  オブジェクト指向型
  
  手続き型
  
  現在のドキュメントを終了します。

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  手続き型のコールでのみ使用します。 変更される <class>XMLWriter</class> のインスタンスです。
                      このインスタンスは、<strong>xmlwriter_open_uri()</strong> あるいは <strong>xmlwriter_open_memory()</strong> を呼
                      び出すことで取得したものです。

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

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


id: XMLWriter::endDtd
type: function
doc:
<comment>Description:</comment>
  現在の DTD を終了する
  
  オブジェクト指向型
  
  手続き型
  
  ドキュメントの DTD を終了します。

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  手続き型のコールでのみ使用します。 変更される <class>XMLWriter</class> のインスタンスです。
                      このインスタンスは、<strong>xmlwriter_open_uri()</strong> あるいは <strong>xmlwriter_open_memory()</strong> を呼
                      び出すことで取得したものです。

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

<comment>See Also:</comment>
   * XMLWriter::startDtd
   * XMLWriter::writeDtd


id: XMLWriter::endDtdAttlist
type: function
doc:
<comment>Description:</comment>
  現在の DTD 属性リストを終了する
  
  オブジェクト指向型
  
  手続き型
  
  現在の DTD 属性リストを終了します。

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  手続き型のコールでのみ使用します。 変更される <class>XMLWriter</class> のインスタンスです。
                      このインスタンスは、<strong>xmlwriter_open_uri()</strong> あるいは <strong>xmlwriter_open_memory()</strong> を呼
                      び出すことで取得したものです。

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

<comment>See Also:</comment>
   * XMLWriter::startDtdAttlist
   * XMLWriter::writeDtdAttlist


id: XMLWriter::endDtdElement
type: function
doc:
<comment>Description:</comment>
  現在の DTD 要素を終了する
  
  オブジェクト指向型
  
  手続き型
  
  現在の DTD 要素を終了します。

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  手続き型のコールでのみ使用します。 変更される <class>XMLWriter</class> のインスタンスです。
                      このインスタンスは、<strong>xmlwriter_open_uri()</strong> あるいは <strong>xmlwriter_open_memory()</strong> を呼
                      び出すことで取得したものです。

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

<comment>See Also:</comment>
   * XMLWriter::startDtdElement
   * XMLWriter::writeDtdElement


id: XMLWriter::endDtdEntity
type: function
doc:
<comment>Description:</comment>
  現在の DTD エンティティを終了する
  
  オブジェクト指向型
  
  手続き型
  
  現在の DTD エンティティを終了します。

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  手続き型のコールでのみ使用します。 変更される <class>XMLWriter</class> のインスタンスです。
                      このインスタンスは、<strong>xmlwriter_open_uri()</strong> あるいは <strong>xmlwriter_open_memory()</strong> を呼
                      び出すことで取得したものです。

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

<comment>See Also:</comment>
   * XMLWriter::startDtdEntity
   * XMLWriter::writeDtdEntity


id: XMLWriter::endElement
type: function
doc:
<comment>Description:</comment>
  現在の要素を終了する
  
  オブジェクト指向型
  
  手続き型
  
  現在の要素を終了します。

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  手続き型のコールでのみ使用します。 変更される <class>XMLWriter</class> のインスタンスです。
                      このインスタンスは、<strong>xmlwriter_open_uri()</strong> あるいは <strong>xmlwriter_open_memory()</strong> を呼
                      び出すことで取得したものです。

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

<comment>See Also:</comment>
   * XMLWriter::startElement
   * XMLWriter::writeElement


id: XMLWriter::endPi
type: function
doc:
<comment>Description:</comment>
  現在の PI (処理命令) を終了する
  
  オブジェクト指向型
  
  手続き型
  
  現在の処理命令を終了します。

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  手続き型のコールでのみ使用します。 変更される <class>XMLWriter</class> のインスタンスです。
                      このインスタンスは、<strong>xmlwriter_open_uri()</strong> あるいは <strong>xmlwriter_open_memory()</strong> を呼
                      び出すことで取得したものです。

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

<comment>See Also:</comment>
   * XMLWriter::startPi
   * XMLWriter::writePi


id: XMLWriter::flush
type: function
doc:
<comment>Description:</comment>
  現在のバッファをフラッシュする
  
  オブジェクト指向型
  
  手続き型
  
  現在のバッファをフラッシュします。

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  手続き型のコールでのみ使用します。 変更される <class>XMLWriter</class> のインスタンスです。
                      このインスタンスは、<strong>xmlwriter_open_uri()</strong> あるいは <strong>xmlwriter_open_memory()</strong> を呼
                      び出すことで取得したものです。
  <info>bool</info>       <strong>$empty</strong>   バッファを空にするかどうか。デフォルトは <info>true</info> です。

<comment>Return:</comment>
  <info>string|int</info>  ライターをメモリにオープンした場合は、この関数は出来上がった XML バッファを返します。
              そうではなく URI を使用している場合は、この関数はバッファを書き込み、 書き込んだバイト
              数を返します。


id: XMLWriter::fullEndElement
type: function
doc:
<comment>Description:</comment>
  現在の要素を終了する
  
  オブジェクト指向型
  
  手続き型
  
  現在の xml 要素を終了します。要素が空であっても終了タグを書き込みます。

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  手続き型のコールでのみ使用します。 変更される <class>XMLWriter</class> のインスタンスです。
                      このインスタンスは、<strong>xmlwriter_open_uri()</strong> あるいは <strong>xmlwriter_open_memory()</strong> を呼
                      び出すことで取得したものです。

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

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


id: XMLWriter::openMemory
type: function
doc:
<comment>Description:</comment>
  文字列の出力にメモリを使用する新しい xmlwriter を作成する
  
  オブジェクト指向型
  
  手続き型
  
  文字列の出力にメモリを使用する新しい <class>XMLWriter</class> を作成します。

<comment>Return:</comment>
  <info>bool</info>  オブジェクト指向型: 成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。
        
        手続き型: 成功した場合に、その後の xmlwriter 関数で使用するための新しい <class>XMLWriter</class> のインスタ
        ンスを返します。 失敗した場合に <info>false</info> を返します

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


id: XMLWriter::openUri
type: function
doc:
<comment>Description:</comment>
  ソース URI を指定して新しい xmlwriter を作成する
  
  オブジェクト指向型
  
  手続き型
  
  <strong>$uri</strong> を指定した新しい <class>XMLWriter</class> を作成します。

<comment>Param:</comment>
  <info>string</info>  <strong>$uri</strong>  出力するリソースの URI。

<comment>Return:</comment>
  <info>bool</info>  オブジェクト指向型: 成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。
        
        手続き型: 成功した場合に、その後の xmlwriter 関数で使用するための新しい <class>XMLWriter</class> のインスタ
        ンスを返します。 失敗した場合に <info>false</info> を返します

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


id: XMLWriter::outputMemory
type: function
doc:
<comment>Description:</comment>
  現在のバッファを返す
  
  オブジェクト指向型
  
  手続き型
  
  現在のバッファを返します。

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  手続き型のコールでのみ使用します。 変更される <class>XMLWriter</class> のインスタンスです。
                      このインスタンスは、<strong>xmlwriter_open_uri()</strong> あるいは <strong>xmlwriter_open_memory()</strong> を呼
                      び出すことで取得したものです。
  <info>bool</info>       <strong>$flush</strong>   出力バッファをフラッシュするかどうか。デフォルトは <info>true</info>。

<comment>Return:</comment>
  <info>string</info>  現在のバッファを文字列で返します。

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


id: XMLWriter::setIndent
type: function
doc:
<comment>Description:</comment>
  字下げの on/off を切り替える
  
  オブジェクト指向型
  
  手続き型
  
  字下げの on/off を切り替えます。

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  手続き型のコールでのみ使用します。 変更される <class>XMLWriter</class> のインスタンスです。
                      このインスタンスは、<strong>xmlwriter_open_uri()</strong> あるいは <strong>xmlwriter_open_memory()</strong> を呼
                      び出すことで取得したものです。
  <info>bool</info>       <strong>$enable</strong>  字下げを有効にするかどうか。

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

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


id: XMLWriter::setIndentString
type: function
doc:
<comment>Description:</comment>
  字下げに使用する文字列を設定する
  
  オブジェクト指向型
  
  手続き型
  
  文字列を設定します。この文字を使用して、結果の xml の要素/属性 を字下げします。

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>       手続き型のコールでのみ使用します。 変更される <class>XMLWriter</class> のインスタンスで
                           す。 このインスタンスは、<strong>xmlwriter_open_uri()</strong> あるいは
                           <strong>xmlwriter_open_memory()</strong> を呼び出すことで取得したものです。
  <info>string</info>     <strong>$indentation</strong>  字下げ用の文字列。

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

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


id: XMLWriter::startAttribute
type: function
doc:
<comment>Description:</comment>
  属性を開始する
  
  オブジェクト指向型
  
  手続き型
  
  属性を開始します。

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  手続き型のコールでのみ使用します。 変更される <class>XMLWriter</class> のインスタンスです。
                      このインスタンスは、<strong>xmlwriter_open_uri()</strong> あるいは <strong>xmlwriter_open_memory()</strong> を呼
                      び出すことで取得したものです。
  <info>string</info>     <strong>$name</strong>    属性の名前。

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

<comment>See Also:</comment>
   * XMLWriter::startAttributeNs
   * XMLWriter::endAttribute
   * XMLWriter::writeAttribute
   * XMLWriter::writeAttributeNs


id: XMLWriter::startAttributeNs
type: function
doc:
<comment>Description:</comment>
  名前空間つきの属性を開始する
  
  オブジェクト指向型
  
  手続き型
  
  名前空間つきの属性を開始します。

<comment>Param:</comment>
  <info>XMLWriter</info>    <strong>$writer</strong>     手続き型のコールでのみ使用します。 変更される <class>XMLWriter</class> のインスタンスで
                           す。 このインスタンスは、<strong>xmlwriter_open_uri()</strong> あるいは
                           <strong>xmlwriter_open_memory()</strong> を呼び出すことで取得したものです。
  <info>string|null</info>  <strong>$prefix</strong>     名前空間プレフィックス。
  <info>string</info>       <strong>$name</strong>       属性の名前。
  <info>string|null</info>  <strong>$namespace</strong>  名前空間 URI。 <strong>$namespace</strong> が <info>null</info> の場合、名前空間の宣言は省略されます。

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

<comment>See Also:</comment>
   * XMLWriter::startAttribute
   * XMLWriter::endAttribute
   * XMLWriter::writeAttribute
   * XMLWriter::writeAttributeNs


id: XMLWriter::startCdata
type: function
doc:
<comment>Description:</comment>
  CDATA の開始タグを作成する
  
  オブジェクト指向型
  
  手続き型
  
  CDATA を開始します。

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  手続き型のコールでのみ使用します。 変更される <class>XMLWriter</class> のインスタンスです。
                      このインスタンスは、<strong>xmlwriter_open_uri()</strong> あるいは <strong>xmlwriter_open_memory()</strong> を呼
                      び出すことで取得したものです。

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

<comment>See Also:</comment>
   * XMLWriter::endCdata
   * XMLWriter::writeCdata


id: XMLWriter::startComment
type: function
doc:
<comment>Description:</comment>
  コメントを開始する
  
  オブジェクト指向型
  
  手続き型
  
  コメントを開始します。

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  手続き型のコールでのみ使用します。 変更される <class>XMLWriter</class> のインスタンスです。
                      このインスタンスは、<strong>xmlwriter_open_uri()</strong> あるいは <strong>xmlwriter_open_memory()</strong> を呼
                      び出すことで取得したものです。

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

<comment>See Also:</comment>
   * XMLWriter::endComment
   * XMLWriter::writeComment


id: XMLWriter::startDocument
type: function
doc:
<comment>Description:</comment>
  ドキュメントタグを作成する
  
  オブジェクト指向型
  
  手続き型
  
  ドキュメントを開始します。

<comment>Param:</comment>
  <info>XMLWriter</info>    <strong>$writer</strong>      手続き型のコールでのみ使用します。 変更される <class>XMLWriter</class> のインスタンスで
                            す。 このインスタンスは、<strong>xmlwriter_open_uri()</strong> あるいは
                            <strong>xmlwriter_open_memory()</strong> を呼び出すことで取得したものです。
  <info>string|null</info>  <strong>$version</strong>     XML 宣言で使用するドキュメントのバージョン番号。
  <info>string|null</info>  <strong>$encoding</strong>    XML 宣言で使用するドキュメントのエンコーディング。
  <info>string|null</info>  <strong>$standalone</strong>  <return>yes</return> あるいは <return>no</return>。

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

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


id: XMLWriter::startDtd
type: function
doc:
<comment>Description:</comment>
  DTD の開始タグを作成する
  
  オブジェクト指向型
  
  手続き型
  
  DTD を開始します。

<comment>Param:</comment>
  <info>XMLWriter</info>    <strong>$writer</strong>         手続き型のコールでのみ使用します。 変更される <class>XMLWriter</class> のインスタン
                               スです。 このインスタンスは、<strong>xmlwriter_open_uri()</strong> あるいは
                               <strong>xmlwriter_open_memory()</strong> を呼び出すことで取得したものです。
  <info>string</info>       <strong>$qualifiedName</strong>  作成するドキュメント型の修飾名。
  <info>string|null</info>  <strong>$publicId</strong>       外部サブセットの公開識別子。
  <info>string|null</info>  <strong>$systemId</strong>       外部サブセットのシステム識別子。

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

<comment>See Also:</comment>
   * XMLWriter::endDtd
   * XMLWriter::writeDtd


id: XMLWriter::startDtdAttlist
type: function
doc:
<comment>Description:</comment>
  DTD 属性リストを開始する
  
  オブジェクト指向型
  
  手続き型
  
  DTD 属性リストを開始します。

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  手続き型のコールでのみ使用します。 変更される <class>XMLWriter</class> のインスタンスです。
                      このインスタンスは、<strong>xmlwriter_open_uri()</strong> あるいは <strong>xmlwriter_open_memory()</strong> を呼
                      び出すことで取得したものです。
  <info>string</info>     <strong>$name</strong>    属性リストの名前。

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

<comment>See Also:</comment>
   * XMLWriter::endDtdAttlist
   * XMLWriter::writeDtdAttlist


id: XMLWriter::startDtdElement
type: function
doc:
<comment>Description:</comment>
  DTD 要素を開始する
  
  オブジェクト指向型
  
  手続き型
  
  DTD 要素を開始します。

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>         手続き型のコールでのみ使用します。 変更される <class>XMLWriter</class> のインスタンス
                             です。 このインスタンスは、<strong>xmlwriter_open_uri()</strong> あるいは
                             <strong>xmlwriter_open_memory()</strong> を呼び出すことで取得したものです。
  <info>string</info>     <strong>$qualifiedName</strong>  作成するドキュメント型の修飾名。

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

<comment>See Also:</comment>
   * XMLWriter::endDtdElement
   * XMLWriter::writeDtdElement


id: XMLWriter::startDtdEntity
type: function
doc:
<comment>Description:</comment>
  DTD エンティティを開始する
  
  オブジェクト指向型
  
  手続き型
  
  DTD エンティティを開始します。

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>   手続き型のコールでのみ使用します。 変更される <class>XMLWriter</class> のインスタンスです。
                       このインスタンスは、<strong>xmlwriter_open_uri()</strong> あるいは <strong>xmlwriter_open_memory()</strong> を
                       呼び出すことで取得したものです。
  <info>string</info>     <strong>$name</strong>     エンティティの名前。
  <info>bool</info>       <strong>$isParam</strong>  

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

<comment>See Also:</comment>
   * XMLWriter::endDtdEntity
   * XMLWriter::writeDtdEntity


id: XMLWriter::startElement
type: function
doc:
<comment>Description:</comment>
  要素の開始タグを作成する
  
  オブジェクト指向型
  
  手続き型
  
  要素を開始します。

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  手続き型のコールでのみ使用します。 変更される <class>XMLWriter</class> のインスタンスです。
                      このインスタンスは、<strong>xmlwriter_open_uri()</strong> あるいは <strong>xmlwriter_open_memory()</strong> を呼
                      び出すことで取得したものです。
  <info>string</info>     <strong>$name</strong>    要素名。

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

<comment>See Also:</comment>
   * XMLWriter::endElement
   * XMLWriter::writeElement


id: XMLWriter::startElementNs
type: function
doc:
<comment>Description:</comment>
  名前空間つき要素の開始タグを作成する
  
  オブジェクト指向型
  
  手続き型
  
  名前空間つき要素を開始します。

<comment>Param:</comment>
  <info>XMLWriter</info>    <strong>$writer</strong>     手続き型のコールでのみ使用します。 変更される <class>XMLWriter</class> のインスタンスで
                           す。 このインスタンスは、<strong>xmlwriter_open_uri()</strong> あるいは
                           <strong>xmlwriter_open_memory()</strong> を呼び出すことで取得したものです。
  <info>string|null</info>  <strong>$prefix</strong>     名前空間プレフィックス。 <strong>$prefix</strong> が <info>null</info> の場合、名前空間は省略されます。
  <info>string</info>       <strong>$name</strong>       要素名。
  <info>string|null</info>  <strong>$namespace</strong>  名前空間 URI。 <strong>$namespace</strong> が <info>null</info> の場合、名前空間の宣言は省略されます。

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

<comment>See Also:</comment>
   * XMLWriter::endElement
   * XMLWriter::writeElementNs


id: XMLWriter::startPi
type: function
doc:
<comment>Description:</comment>
  PI (処理命令) の開始タグを作成する
  
  オブジェクト指向型
  
  手続き型
  
  処理命令の開始タグを作成します。

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  手続き型のコールでのみ使用します。 変更される <class>XMLWriter</class> のインスタンスです。
                      このインスタンスは、<strong>xmlwriter_open_uri()</strong> あるいは <strong>xmlwriter_open_memory()</strong> を呼
                      び出すことで取得したものです。
  <info>string</info>     <strong>$target</strong>  処理命令の対象。

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

<comment>See Also:</comment>
   * XMLWriter::endPi
   * XMLWriter::writePi


id: XMLWriter::text
type: function
doc:
<comment>Description:</comment>
  テキストを書き込む
  
  オブジェクト指向型
  
  手続き型
  
  テキストを書き込みます。

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>   手続き型のコールでのみ使用します。 変更される <class>XMLWriter</class> のインスタンスです。
                       このインスタンスは、<strong>xmlwriter_open_uri()</strong> あるいは <strong>xmlwriter_open_memory()</strong> を
                       呼び出すことで取得したものです。
  <info>string</info>     <strong>$content</strong>  テキストの内容。 <return>\<</return>, <return>&gt;</return>, <return>&</return>, <return>"</return> は、実体参照として書き込みます。 (つまり、 , , , , をそれぞれ書き込みます)。 それ以外の文字は、<return>'</return> を含めてそのまま書き込みます。 XML で特別な文字や、実体参照をそのまま書き込むには、 <strong>xmlwriter_write_raw()</strong> を使わなければなりません。

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


id: XMLWriter::writeAttribute
type: function
doc:
<comment>Description:</comment>
  属性全体を書き込む
  
  オブジェクト指向型
  
  手続き型
  
  属性全体を書き込みます。

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  手続き型のコールでのみ使用します。 変更される <class>XMLWriter</class> のインスタンスです。
                      このインスタンスは、<strong>xmlwriter_open_uri()</strong> あるいは <strong>xmlwriter_open_memory()</strong> を呼
                      び出すことで取得したものです。
  <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>
   * XMLWriter::writeAttributeNs
   * XMLWriter::startAttribute
   * XMLWriter::startAttributeNs
   * XMLWriter::endAttribute


id: XMLWriter::writeAttributeNs
type: function
doc:
<comment>Description:</comment>
  名前空間つき属性全体を書き込む
  
  オブジェクト指向型
  
  手続き型
  
  名前空間つき属性全体を書き込みます。

<comment>Param:</comment>
  <info>XMLWriter</info>    <strong>$writer</strong>     手続き型のコールでのみ使用します。 変更される <class>XMLWriter</class> のインスタンスで
                           す。 このインスタンスは、<strong>xmlwriter_open_uri()</strong> あるいは
                           <strong>xmlwriter_open_memory()</strong> を呼び出すことで取得したものです。
  <info>string|null</info>  <strong>$prefix</strong>     名前空間プレフィックス。 <strong>$prefix</strong> が <info>null</info> の場合、名前空間は省略されます。
  <info>string</info>       <strong>$name</strong>       属性名。
  <info>string|null</info>  <strong>$namespace</strong>  名前空間 URI。 <strong>$namespace</strong> が <info>null</info> の場合、名前空間の宣言は省略されます。
  <info>string</info>       <strong>$value</strong>      属性の値。

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

<comment>See Also:</comment>
   * XMLWriter::writeAttribute
   * XMLWriter::startAttribute
   * XMLWriter::startAttributeNs
   * XMLWriter::endAttribute


id: XMLWriter::writeCdata
type: function
doc:
<comment>Description:</comment>
  CDATA タグ全体を書き込む
  
  オブジェクト指向型
  
  手続き型
  
  CDATA 全体を書き込みます。

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>   手続き型のコールでのみ使用します。 変更される <class>XMLWriter</class> のインスタンスです。
                       このインスタンスは、<strong>xmlwriter_open_uri()</strong> あるいは <strong>xmlwriter_open_memory()</strong> を
                       呼び出すことで取得したものです。
  <info>string</info>     <strong>$content</strong>  CDATA の内容。

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

<comment>See Also:</comment>
   * XMLWriter::startCdata
   * XMLWriter::endCdata


id: XMLWriter::writeComment
type: function
doc:
<comment>Description:</comment>
  コメントタグ全体を書き込む
  
  オブジェクト指向型
  
  手続き型
  
  コメント全体を書き込みます。

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>   手続き型のコールでのみ使用します。 変更される <class>XMLWriter</class> のインスタンスです。
                       このインスタンスは、<strong>xmlwriter_open_uri()</strong> あるいは <strong>xmlwriter_open_memory()</strong> を
                       呼び出すことで取得したものです。
  <info>string</info>     <strong>$content</strong>  コメントの内容。

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

<comment>See Also:</comment>
   * XMLWriter::startComment
   * XMLWriter::endComment


id: XMLWriter::writeDtd
type: function
doc:
<comment>Description:</comment>
  DTD タグ全体を書き込む
  
  オブジェクト指向型
  
  手続き型
  
  DTD 全体を書き込みます。

<comment>Param:</comment>
  <info>XMLWriter</info>    <strong>$writer</strong>    手続き型のコールでのみ使用します。 変更される <class>XMLWriter</class> のインスタンスで
                          す。 このインスタンスは、<strong>xmlwriter_open_uri()</strong> あるいは
                          <strong>xmlwriter_open_memory()</strong> を呼び出すことで取得したものです。
  <info>string</info>       <strong>$name</strong>      DTD 名。
  <info>string|null</info>  <strong>$publicId</strong>  外部サブセットの公開識別子。
  <info>string|null</info>  <strong>$systemId</strong>  外部サブセットのシステム識別子。
  <info>string|null</info>  <strong>$content</strong>   DTD の内容。

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

<comment>See Also:</comment>
   * XMLWriter::startDtd
   * XMLWriter::endDtd


id: XMLWriter::writeDtdAttlist
type: function
doc:
<comment>Description:</comment>
  DTD 属性リストタグ全体を書き込む
  
  オブジェクト指向型
  
  手続き型
  
  DTD 属性リストを書き込みます。

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>   手続き型のコールでのみ使用します。 変更される <class>XMLWriter</class> のインスタンスです。
                       このインスタンスは、<strong>xmlwriter_open_uri()</strong> あるいは <strong>xmlwriter_open_memory()</strong> を
                       呼び出すことで取得したものです。
  <info>string</info>     <strong>$name</strong>     DTD 属性リストの名前。
  <info>string</info>     <strong>$content</strong>  DTD 属性リストの内容。

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

<comment>See Also:</comment>
   * XMLWriter::startDtdAttlist
   * XMLWriter::endDtdAttlist


id: XMLWriter::writeDtdElement
type: function
doc:
<comment>Description:</comment>
  DTD 要素タグ全体を書き込む
  
  オブジェクト指向型
  
  手続き型
  
  DTD 要素全体を書き込みます。

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>   手続き型のコールでのみ使用します。 変更される <class>XMLWriter</class> のインスタンスです。
                       このインスタンスは、<strong>xmlwriter_open_uri()</strong> あるいは <strong>xmlwriter_open_memory()</strong> を
                       呼び出すことで取得したものです。
  <info>string</info>     <strong>$name</strong>     DTD 要素の名前。
  <info>string</info>     <strong>$content</strong>  要素の内容。

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

<comment>See Also:</comment>
   * XMLWriter::startDtdElement
   * XMLWriter::endDtdElement


id: XMLWriter::writeDtdEntity
type: function
doc:
<comment>Description:</comment>
  DTD エンティティタグ全体を書き込む
  
  オブジェクト指向型
  
  手続き型
  
  DTD エンティティ全体を書き込みます。

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>   手続き型のコールでのみ使用します。 変更される <class>XMLWriter</class> のインスタンスです。
                       このインスタンスは、<strong>xmlwriter_open_uri()</strong> あるいは <strong>xmlwriter_open_memory()</strong> を
                       呼び出すことで取得したものです。
  <info>string</info>     <strong>$name</strong>     エンティティの名前。
  <info>string</info>     <strong>$content</strong>  エンティティの内容。

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

<comment>See Also:</comment>
   * XMLWriter::startDtdEntity
   * XMLWriter::endDtdEntity


id: XMLWriter::writeElement
type: function
doc:
<comment>Description:</comment>
  要素タグ全体を書き込む
  
  オブジェクト指向型
  
  手続き型
  
  要素タグ全体を書き込みます。

<comment>Param:</comment>
  <info>XMLWriter</info>    <strong>$writer</strong>   手続き型のコールでのみ使用します。 変更される <class>XMLWriter</class> のインスタンスで
                         す。 このインスタンスは、<strong>xmlwriter_open_uri()</strong> あるいは
                         <strong>xmlwriter_open_memory()</strong> を呼び出すことで取得したものです。
  <info>string</info>       <strong>$name</strong>     要素名。
  <info>string|null</info>  <strong>$content</strong>  要素の内容。

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

<comment>See Also:</comment>
   * XMLWriter::startElement
   * XMLWriter::endElement
   * XMLWriter::writeElementNs


id: XMLWriter::writeElementNs
type: function
doc:
<comment>Description:</comment>
  名前空間つき要素タグ全体を書き込む
  
  オブジェクト指向型
  
  手続き型
  
  名前空間つき要素タグ全体を書き込みます。

<comment>Param:</comment>
  <info>XMLWriter</info>    <strong>$writer</strong>     手続き型のコールでのみ使用します。 変更される <class>XMLWriter</class> のインスタンスで
                           す。 このインスタンスは、<strong>xmlwriter_open_uri()</strong> あるいは
                           <strong>xmlwriter_open_memory()</strong> を呼び出すことで取得したものです。
  <info>string|null</info>  <strong>$prefix</strong>     名前空間プレフィックス。 <strong>$prefix</strong> が <info>null</info> の場合、名前空間は省略されます。
  <info>string</info>       <strong>$name</strong>       要素名。
  <info>string|null</info>  <strong>$namespace</strong>  名前空間 URI。 <strong>$namespace</strong> が <info>null</info> の場合、名前空間の宣言は省略されます。
  <info>string|null</info>  <strong>$content</strong>    要素の内容。

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

<comment>See Also:</comment>
   * XMLWriter::startElementNs
   * XMLWriter::endElement
   * XMLWriter::writeElement


id: XMLWriter::writePi
type: function
doc:
<comment>Description:</comment>
  PI (処理命令) 書き込む
  
  オブジェクト指向型
  
  手続き型
  
  処理命令を書き込みます。

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>   手続き型のコールでのみ使用します。 変更される <class>XMLWriter</class> のインスタンスです。
                       このインスタンスは、<strong>xmlwriter_open_uri()</strong> あるいは <strong>xmlwriter_open_memory()</strong> を
                       呼び出すことで取得したものです。
  <info>string</info>     <strong>$target</strong>   処理命令の対象。
  <info>string</info>     <strong>$content</strong>  処理命令の内容。

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

<comment>See Also:</comment>
   * XMLWriter::startPi
   * XMLWriter::endPi


id: XMLWriter::writeRaw
type: function
doc:
<comment>Description:</comment>
  生の XML テキストを書き込む
  
  オブジェクト指向型
  
  手続き型
  
  生の xml テキストを書き込みます。

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>   手続き型のコールでのみ使用します。 変更される <class>XMLWriter</class> のインスタンスです。
                       このインスタンスは、<strong>xmlwriter_open_uri()</strong> あるいは <strong>xmlwriter_open_memory()</strong> を
                       呼び出すことで取得したものです。
  <info>string</info>     <strong>$content</strong>  書き込むテキスト文字列。

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

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


id: XML_SAX_IMPL
type: constant
doc:
<comment>Description:</comment>
  SAX の実装方式を保持します。 <return>libxml</return> あるいは <return>expat</return> となります。


id: XSLTProcessor::__construct
type: function
doc:
<comment>Description:</comment>
  新しい XSLTProcessor オブジェクトを作成する
  
  新しい <class>XSLTProcessor</class> オブジェクトを作成します。


id: XSLTProcessor::getParameter
type: function
doc:
<comment>Description:</comment>
  パラメータの値を取得する
  
  パラメータがあらかじめ <strong>XSLTProcessor::setParameter()</strong> で設定されている場合、 それを取得します。

<comment>Param:</comment>
  <info>string</info>  <strong>$namespace</strong>  XSLT パラメータの名前空間 URI を指定します。
  <info>string</info>  <strong>$name</strong>       XSLT パラメータのローカル名を指定します。

<comment>Return:</comment>
  <info>string|false</info>  パラメータの値 (文字列)、あるいは設定されていない場合は <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>XSLTProcessor::setParameter()</strong>
   * <strong>XSLTProcessor::removeParameter()</strong>


id: XSLTProcessor::getSecurityPrefs
type: function
doc:
<comment>Description:</comment>
  セキュリティ設定を取得する
  
  セキュリティ設定を取得します。

<comment>Return:</comment>
  <info>int</info>  <info>XSL_SECPREF_READ_FILE</info>、 <info>XSL_SECPREF_WRITE_FILE</info>、 <info>XSL_SECPREF_CREATE_DIRECTORY</info>、
       <info>XSL_SECPREF_READ_NETWORK</info>、 <info>XSL_SECPREF_WRITE_NETWORK</info> を含むビットマスクを返します。


id: XSLTProcessor::hasExsltSupport
type: function
doc:
<comment>Description:</comment>
  PHP が EXSLT をサポートしているかどうかを判定する
  
  このメソッドは PHP が EXSLT library と共にビルドされたかどうかを判定します。

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


id: XSLTProcessor::importStylesheet
type: function
doc:
<comment>Description:</comment>
  スタイルシートを取り込む
  
  このメソッドは <class>XSLTProcessor</class> に変換のためのスタイルシートを取り込みます。

<comment>Param:</comment>
  <info>object</info>  <strong>$stylesheet</strong>  取り込まれるスタイルシートを <class>DOMDocument</class> オブジェクトあるいは
                       <class>SimpleXMLElement</class> オブジェクトとして指定します。

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


id: XSLTProcessor::registerPHPFunctions
type: function
doc:
<comment>Description:</comment>
  PHP 関数を XSLT 関数として利用できるようにする
  
  このメソッドは、PHP 関数を XSL スタイルシートでの XSLT 関数として利用できるようにします。

<comment>Param:</comment>
  <info>array|string|null</info>  <strong>$functions</strong>  このパラメータは、XSLT からコールされる信頼できる関数のみを許可しま
                                 す。
                                 
                                 このパラメータには文字列 (関数名) あるいは関数の配列のいずれかを指
                                 定します。

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


id: XSLTProcessor::removeParameter
type: function
doc:
<comment>Description:</comment>
  パラメータを削除する
  
  もしパラメータが設定されていれば削除します。これにより、 プロセッサはスタイルシートで指定されるよ
  うなパラメータに デフォルト値を使用します。

<comment>Param:</comment>
  <info>string</info>  <strong>$namespace</strong>  XSLT パラメータの名前空間 URI を指定します。
  <info>string</info>  <strong>$name</strong>       XSLT パラメータのローカル名を指定します。

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

<comment>See Also:</comment>
   * <strong>XSLTProcessor::setParameter()</strong>
   * <strong>XSLTProcessor::getParameter()</strong>


id: XSLTProcessor::setParameter
type: function
doc:
<comment>Description:</comment>
  パラメータの値を設定する
  
  <class>XSLTProcessor</class> を使った変換のための 1 つあるいは多くのパラメータの値を設定します。 もしパラメータが
  スタイルシートに存在しない場合、無視されます。

<comment>Param:</comment>
  <info>string</info>  <strong>$namespace</strong>  XSLT パラメータの名前空間 URI を指定します。
  <info>string</info>  <strong>$name</strong>       XSLT パラメータのローカル名を指定します。
  <info>string</info>  <strong>$value</strong>      XSLT パラメータの新しい値を指定します。
  <info>array</info>   <strong>$options</strong>    <return>名前 =&gt; 値</return> の組の配列を指定します。

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

<comment>See Also:</comment>
   * <strong>XSLTProcessor::getParameter()</strong>
   * <strong>XSLTProcessor::removeParameter()</strong>


id: XSLTProcessor::setProfiling
type: function
doc:
<comment>Description:</comment>
  プロファイル情報の出力ファイルを設定する
  
  スタイルシート処理時のプロファイル情報を出力するファイルを設定します。

<comment>Param:</comment>
  <info>string|null</info>  <strong>$filename</strong>  プロファイル情報を出力するファイルへのパス。

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


id: XSLTProcessor::setSecurityPrefs
type: function
doc:
<comment>Description:</comment>
  セキュリティ設定を指定する
  
  セキュリティ設定を指定します。

<comment>Param:</comment>
  <info>int</info>  <strong>$preferences</strong>  新しいセキュリティ設定。以下の定数を OR で指定できます。
                     <info>XSL_SECPREF_READ_FILE</info>、 <info>XSL_SECPREF_WRITE_FILE</info>、 <info>XSL_SECPREF_CREATE_DIRECTORY</info>、
                     <info>XSL_SECPREF_READ_NETWORK</info>、 <info>XSL_SECPREF_WRITE_NETWORK</info>。あるいは <info>XSL_SECPREF_NONE</info>
                     や <info>XSL_SECPREF_DEFAULT</info> を渡すこともできます。

<comment>Return:</comment>
  <info>int</info>  元のセキュリティ設定を返します。


id: XSLTProcessor::transformToDoc
type: function
doc:
<comment>Description:</comment>
  ドキュメント に変換する
  
  <strong>XSLTProcessor::importStylesheet()</strong> メソッドで与えられたスタイルシートを適用し、 ソースノードをド
  キュメント (例: <class>DOMDocument</class>) に変換します。

<comment>Param:</comment>
  <info>object</info>       <strong>$document</strong>     変換される <class>DOMDocument</class>、<class>SimpleXMLElement</class>、または libxml と互換性がある
                             オブジェクトを指定します。
  <info>string|null</info>  <strong>$returnClass</strong>  XSLTProcessor::transformToDoc が返すオブジェクトのクラス名を指定する、
                             オプションのパラメータです。ここで指定するクラスは、<strong>$document</strong> と同じも
                             のか、それを継承したクラスであるべきです。

<comment>Return:</comment>
  <info>DOMDocument|false</info>  結果の ドキュメント を返します。 エラーが発生した場合は <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>XSLTProcessor::transformToUri()</strong>
   * <strong>XSLTProcessor::transformToXml()</strong>


id: XSLTProcessor::transformToUri
type: function
doc:
<comment>Description:</comment>
  URI に変換する
  
  <strong>XSLTProcessor::importStylesheet()</strong> メソッドで与えられたスタイルシートを適用し、 ソースノードを URI
  に変換します。

<comment>Param:</comment>
  <info>object</info>  <strong>$document</strong>  変換される <class>DOMDocument</class> または <class>SimpleXMLElement</class> オブジェクトを指定します。
  <info>string</info>  <strong>$uri</strong>       変換先の URI。

<comment>Return:</comment>
  <info>int</info>  書き込まれたバイト数。エラーが発生した場合は <info>false</info> 。

<comment>See Also:</comment>
   * <strong>XSLTProcessor::transformToDoc()</strong>
   * <strong>XSLTProcessor::transformToXml()</strong>


id: XSLTProcessor::transformToXml
type: function
doc:
<comment>Description:</comment>
  XML に変換する
  
  <strong>xsltprocessor::importStylesheet()</strong> メソッドで与えられたスタイルシートを適用し、 ソースノードを文字
  列に変換します。

<comment>Param:</comment>
  <info>object</info>  <strong>$document</strong>  変換される <class>DOMDocument</class> または <class>SimpleXMLElement</class> オブジェクトを指定します。

<comment>Return:</comment>
  <info>string|null|false</info>  変換結果の文字列。エラーが発生した場合は <info>false</info> 。

<comment>See Also:</comment>
   * <strong>XSLTProcessor::transformToDoc()</strong>
   * <strong>XSLTProcessor::transformToUri()</strong>


id: XSL_SECPREF_DEFAULT
type: constant
doc:
<comment>Description:</comment>
  すべての書き込みアクセスを拒否します。つまり、 <info>XSL_SECPREF_WRITE_NETWORK</info> |
  <info>XSL_SECPREF_CREATE_DIRECTORY</info> | <info>XSL_SECPREF_WRITE_FILE</info> と同等です。


id: Yac::__construct
type: function
doc:
<comment>Description:</comment>
  Constructor
  
  prefix is used to prepended to keys, this could be used to avoiding conflicts between apps.

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


id: Yac::__get
type: function
doc:
<comment>Description:</comment>
  Getter
  
  Retrieve values from cache

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

<comment>Return:</comment>
  <info>mixed</info>  mixed on success, <info>null</info> on failure


id: Yac::__set
type: function
doc:
<comment>Description:</comment>
  Setter
  
  store a item into cache

<comment>Param:</comment>
  <info>string</info>  <strong>$keys</strong>   <info>string</info> key
  <info>mixed</info>   <strong>$value</strong>  mixed value, All php value type could be stored except リソース

<comment>Return:</comment>
  <info>mixed</info>  Always return the value self


id: Yac::add
type: function
doc:
<comment>Description:</comment>
  Store into cache
  
  Added a item into cache.

<comment>Param:</comment>
  <info>string</info>  <strong>$keys</strong>   <info>string</info> key
  <info>mixed</info>   <strong>$value</strong>  mixed value, All php value type could be stored except リソース
  <info>int</info>     <strong>$ttl</strong>    expire time

<comment>Return:</comment>
  <info>bool</info>  <info>bool</info>, <info>true</info> on success, <info>false</info> on failure  Yac::add may fail if cas lock could not obtain, so,
        if you need the value to be stored properly, you may write codes like: Make sure the item is
        storedset("key", "vale)); ]]>
        
        Yac::add may fail if cas lock could not obtain, so, if you need the value to be stored
        properly, you may write codes like: Make sure the item is storedset("key", "vale)); ]]>


id: Yac::delete
type: function
doc:
<comment>Description:</comment>
  Remove items from cache
  
  remove items from cache

<comment>Param:</comment>
  <info>string|array</info>  <strong>$keys</strong>  string key, or array of multiple keys to be removed
  <info>int</info>           <strong>$ttl</strong>   if delay is set, delete will mark the items to be invalid in ttl second.

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


id: Yac::dump
type: function
doc:
<comment>Description:</comment>
  Dump cache
  
  Dump values stored in cache

<comment>Param:</comment>
  <info></info>  <strong>$num</strong>  Maximum number of items should be returned

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


id: Yac::flush
type: function
doc:
<comment>Description:</comment>
  Flush the cache
  
  Remove all cached values

<comment>Return:</comment>
  <info>bool</info>  bool, always true


id: Yac::get
type: function
doc:
<comment>Description:</comment>
  Retrieve values from cache
  
  Retrieve values from cache

<comment>Param:</comment>
  <info>string|array</info>  <strong>$key</strong>  <info>string</info> keys, or <info>array</info> of multiple keys.
  <info>int</info>           <strong>$cas</strong>  if not <info>null</info>, it will be set to the retrieved item's cas.

<comment>Return:</comment>
  <info>mixed</info>  mixed on success, false on failure


id: Yac::info
type: function
doc:
<comment>Description:</comment>
  Status of cache
  
  Get status of cache system

<comment>Return:</comment>
  <info>array</info>  Return an array, consistent with: "memory_size", "slots_memory_size", "values_memory_size",
         "segment_size", "segment_num", "miss", "hits", "fails", "kicks", "recycles", "slots_size",
         "slots_used"


id: Yac::set
type: function
doc:
<comment>Description:</comment>
  Store into cache
  
  Add a item into cache, it the key is already exists, override it.

<comment>Param:</comment>
  <info>string</info>  <strong>$keys</strong>   <info>string</info> key
  <info>mixed</info>   <strong>$value</strong>  mixed value, All php value type could be stored except リソース
  <info>int</info>     <strong>$ttl</strong>    expire time

<comment>Return:</comment>
  <info>bool</info>  the value self


id: Yaconf
type: class
doc:
<comment>Description:</comment>
  Yaconf is a configurations container, it parses INIT files, stores the result in PHP when PHP is
  started, the result lives  with the whole PHP lifecycle.


id: Yaconf::get
type: function
doc:
<comment>Description:</comment>
  Retrieve a item

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>           Configuration key, the key looks like "filename.key", or
                          "filename.sectionName,key".
  <info>mixed</info>   <strong>$default_value</strong>  if the key doesn't exists, Yaconf::get will return this as result.

<comment>Return:</comment>
  <info>mixed</info>  Returns configuration result(string or array) if the key exists, return default_value if
         not.


id: Yaconf::has
type: function
doc:
<comment>Description:</comment>
  Determine if a item exists

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

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


id: Yaf_Action_Abstract
type: class
doc:
<comment>Description:</comment>
  アクションは、Yaf の個別のファイルで定義します (<class>Yaf_Controller_Abstract</class> を参照ください)。 アクショ
  ンメソッドには <class>Yaf_Action_Abstract</class> クラスも使えます。
  
  Yaf から呼び出すためのエントリポイントが必要なので、 抽象メソッド Yaf_Action_Abstract::execute を
  アクションクラスで実装する必要があります。


id: Yaf_Action_Abstract::execute
type: function
doc:
<comment>Description:</comment>
  アクションのエントリポイント
  
  このメソッドは、アクションで常に定義しないといけません。これがアクションのエントリポイントになりま
  す。 Yaf_Action_Abstract::execute は引数をとることもあります。  リクエストから取得した値は安全では
  ありません。 使う前にフィルタリングが必要です。
  
  リクエストから取得した値は安全ではありません。 使う前にフィルタリングが必要です。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$args</strong>  

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

<comment>See Also:</comment>
   * 


id: Yaf_Action_Abstract::getController
type: function
doc:
<comment>Description:</comment>
  コントローラオブジェクトを取得する
  
  現在のコントローラオブジェクトを取得します。

<comment>Return:</comment>
  <info>Yaf_Controller_Abstract</info>  <class>Yaf_Controller_Abstract</class> のインスタンスを返します。


id: Yaf_Action_Abstract::getControllerName
type: function
doc:
<comment>Description:</comment>
  Get controller name
  
  get the controller's name

<comment>Return:</comment>
  <info>string</info>  <info>string</info>, controller name


id: Yaf_Application
type: class
doc:
<comment>Description:</comment>
  <class>Yaf_Application</class> はアプリケーションのブートストラップ機能を提供します。 再利用可能なリソース、共有
  できるモジュールベースのブートストラップクラス、 そして依存関係のチェックなどです。
  
  <class>Yaf_Application</class> はシングルトンパターンを実装しており、 シリアライズやアンシリアライズはできませ
  ん。これは、 PHPUnit を使って Yaf 用のテストケースを書こうとしたときに問題の原因となります。
  PHPUnit の @backupGlobals アノテーションを使えば グローバル変数のバックアップやりストア操作を制御
  できるので、 この問題に対応できます。
  
  <class>Yaf_Application</class> はシングルトンパターンを実装しており、 シリアライズやアンシリアライズはできませ
  ん。これは、 PHPUnit を使って Yaf 用のテストケースを書こうとしたときに問題の原因となります。
  
  PHPUnit の @backupGlobals アノテーションを使えば グローバル変数のバックアップやりストア操作を制御
  できるので、 この問題に対応できます。


id: Yaf_Application::__construct
type: function
doc:
<comment>Description:</comment>
  Yaf_Application のコンストラクタ
  
  <class>Yaf_Application</class> のインスタンスを作成します。

<comment>Param:</comment>
  <info>mixed</info>   <strong>$config</strong>   ini ファイルへのパス、あるいは設定の配列。
                    
                    ini ファイルを指定する場合は、 yaf.environ で定義した名前のセクションが必要で
                    す。 デフォルトは "product" です。  ini ファイルをアプリケーションの設定コンテナ
                    として使うのなら、 yaf.cache_config でパフォーマンスを改善できます。
                    performance.
                    
                    ini ファイルをアプリケーションの設定コンテナとして使うのなら、 yaf.cache_config
                    でパフォーマンスを改善できます。 performance.
                    
                    設定項目とそのデフォルト値の一覧を示します。 ini ファイルの例
  <info>string</info>  <strong>$envrion</strong>  最終的な設定として、どのセクションを読み込むか。

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


id: Yaf_Application::app
type: function
doc:
<comment>Description:</comment>
  アプリケーションのインスタンスを取得する
  
  <class>Yaf_Application</class> のインスタンスを取得します。 別の方法として、 Yaf_Dispatcher::getApplication も使
  えます。

<comment>Return:</comment>
  <info>mixed</info>  Yaf_Application のインスタンスを返します。まだ Yaf_Application を初期化していない場合は
         <info>null</info> を返します。

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


id: Yaf_Application::bootstrap
type: function
doc:
<comment>Description:</comment>
  ブートストラップをコールする
  
  ブートストラップを実行します。"_init" で始まる名前のすべてのメソッドを その定義順に実行します。
  bootstrap パラメータを省略した場合は、 application.directory からブートストラップを探します。

<comment>Param:</comment>
  <info>Yaf_Bootstrap_Abstract</info>  <strong>$bootstrap</strong>  <class>Yaf_Bootstrap_Abstract</class> のインスタンス。

<comment>Return:</comment>
  <info>void</info>  <class>Yaf_Application</class> のインスタンスを返します。

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


id: Yaf_Application::clearLastError
type: function
doc:
<comment>Description:</comment>
  直近のエラー情報を消す

<comment>Return:</comment>
  <info>Yaf_Application</info>  


id: Yaf_Application::environ
type: function
doc:
<comment>Description:</comment>
  環境を取得する
  
  環境を取得します。これは yaf.environ で定義されており、デフォルト値は "product" です。

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


id: Yaf_Application::execute
type: function
doc:
<comment>Description:</comment>
  コールバックを実行する
  
  このメソッドは一般的に、Yaf_Application を crontab で実行させるときに使います。 crontab では、オー
  トローダーやブートストラップの仕組みも使えます。

<comment>Param:</comment>
  <info>callable</info>  <strong>$entry</strong>  有効なコールバック。
  <info>string</info>    <strong>$args</strong>   コールバックに渡すパラメータ。

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


id: Yaf_Application::getAppDirectory
type: function
doc:
<comment>Description:</comment>
  アプリケーションディレクトリを取得する

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

<comment>Return:</comment>
  <info>Yaf_Application</info>  


id: Yaf_Application::getConfig
type: function
doc:
<comment>Description:</comment>
  設定情報を取得する

<comment>Return:</comment>
  <info>Yaf_Config_Abstract</info>  <class>Yaf_Config_Abstract</class> のインスタンスを返します。


id: Yaf_Application::getDispatcher
type: function
doc:
<comment>Description:</comment>
  Yaf_Dispatcher のインスタンスを取得する

<comment>Return:</comment>
  <info>Yaf_Dispatcher</info>  


id: Yaf_Application::getLastErrorMsg
type: function
doc:
<comment>Description:</comment>
  直近で発生したエラーのメッセージを取得する

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


id: Yaf_Application::getLastErrorNo
type: function
doc:
<comment>Description:</comment>
  直近で発生したエラーのコードを取得する

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


id: Yaf_Application::getModules
type: function
doc:
<comment>Description:</comment>
  定義済みのモジュール名を取得する
  
  設定で定義したモジュールのリストを取得します。 何も定義していない場合は "Index" だけになります。

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


id: Yaf_Application::run
type: function
doc:
<comment>Description:</comment>
  Yaf_Application を開始する
  
  Yaf_Application を実行します。つまり、Yaf_Application がリクエストを受け取ってルーティングし、コン
  トローラのアクションにディスパッチして レスポンスをレンダリングできるようにします。最終的に、レス
  ポンスをクライアントに返します。

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


id: Yaf_Application::setAppDirectory
type: function
doc:
<comment>Description:</comment>
  アプリケーションディレクトリを変更する

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

<comment>Return:</comment>
  <info>Yaf_Application</info>  


id: Yaf_Bootstrap_Abstract
type: class
doc:
<comment>Description:</comment>
  ブートストラップとは、アプリケーションを実行する前の初期設定に使う仕組みのことです。
  
  ユーザーが自前のブートストラップクラスを定義するには、 <class>Yaf_Bootstrap_Abstract</class> を継承します。
  
  ブートストラップクラスで定義したメソッドの中で "_init" で始まるものがすべて、定義した順に
  Yaf_Application::bootstrap から呼ばれます。


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

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


id: Yaf_Config_Abstract::readonly
type: function
doc:
<comment>Description:</comment>
  設定項目が読み込み専用かどうかを調べる
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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


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

<comment>Return:</comment>
  <info>Yaf_Config_Abstract</info>  


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

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


id: Yaf_Config_Ini
type: class
doc:
<comment>Description:</comment>
  Yaf_Config_Ini を使うと、設定データをおなじみの INI 形式で保存でき、アプリケーションからもオブジェ
  クトのプロパティとして読めるようになります。 INI フォーマットを拡張して、設定データを階層構造で扱
  えるようにしたり 設定セクション間での継承を設定できるようにしたりしています。 設定データの階層は、
  キーをピリオド(".")で区切って表します。 セクションの継承を表すには、セクション名の後にコロン(":")
  を続け、その後に継承元のセクション名を指定します。  Yaf_Config_Ini は、PHP の関数 parse_ini_file()
  を利用します。 この関数のドキュメントも読んで、その振る舞いを知っておきましょう。 特殊な値、たとえ
  ば "<info>true</info>"、"<info>false</info>"、"yes"、"no"、そして "<info>null</info>" の扱いも、parse_ini_file() に従います。
  
  Yaf_Config_Ini は、PHP の関数 parse_ini_file() を利用します。 この関数のドキュメントも読んで、その
  振る舞いを知っておきましょう。 特殊な値、たとえば "<info>true</info>"、"<info>false</info>"、"yes"、"no"、そして "<info>null</info>" の扱
  いも、parse_ini_file() に従います。


id: Yaf_Config_Ini::__construct
type: function
doc:
<comment>Description:</comment>
  Yaf_Config_Ini のコンストラクタ
  
  <class>Yaf_Config_Ini</class> のコンストラクタです。

<comment>Param:</comment>
  <info>string</info>  <strong>$config_file</strong>  INI ファイルへのパス。
  <info>string</info>  <strong>$section</strong>      INI ファイルの中でパースしたいセクション。


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

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

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


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

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

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


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

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>   
  <info>mixed</info>   <strong>$value</strong>  

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


id: Yaf_Config_Ini::count
type: function
doc:
<comment>Description:</comment>
  Yaf_Config.ini の全ての要素を数える
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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


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

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


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

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


id: Yaf_Config_Ini::next
type: function
doc:
<comment>Description:</comment>
  内部ポインタを進める
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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


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

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

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


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

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

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


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

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

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


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

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

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


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

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


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

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


id: Yaf_Config_Ini::toArray
type: function
doc:
<comment>Description:</comment>
  PHP の配列として構成を返す
  
  <class>Yaf_Config_Ini</class> から PHP の配列を返します。

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


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

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


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

<comment>Param:</comment>
  <info>array</info>  <strong>$configs</strong>   
  <info>bool</info>   <strong>$readonly</strong>  


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

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

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


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

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

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


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

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

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


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

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


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

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


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

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


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

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


id: Yaf_Config_Simple::toArray
type: function
doc:
<comment>Description:</comment>
  PHP の配列を返す
  
  <class>Yaf_Config_Simple</class> から PHP の配列を返します。

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


id: Yaf_Controller_Abstract
type: class
doc:
<comment>Description:</comment>
  <class>Yaf_Controller_Abstract</class> は Yaf システムの中心となるクラスです。 MVC は Model-View-Controller の略
  で、 アプリケーションのロジックと表示のロジックを切り離すためのデザインパターンです。
  
  すべてのカスタムコントローラは <class>Yaf_Controller_Abstract</class> を継承する必要があります。
  
  カスタムコントローラでは __construct を定義できません。そのため、 <class>Yaf_Controller_Abstract</class> ではマ
  ジックメソッド Yaf_Controller_Abstract::init を用意しています。
  
  カスタムコントローラで init() メソッドを定義すると、 コントローラのインスタンスを作成するときにそ
  れが呼ばれます。
  
  アクションには引数を持たせることができます。 リクエストが来たときに、もしリクエストのパラメータ
  (Yaf_Request_Abstract::getParam を参照ください) に同名の変数があれば、Yaf はアクションのメソッド
  (Yaf_Action_Abstract::execute を参照ください) にそれを渡します。  これらの引数は何もフィルタリング
  せずそのまま取り込まれるので、 実際に使う前には注意しないといけません。
  
  これらの引数は何もフィルタリングせずそのまま取り込まれるので、 実際に使う前には注意しないといけま
  せん。


id: Yaf_Controller_Abstract::__construct
type: function
doc:
<comment>Description:</comment>
  Yaf_Controller_Abstract のコンストラクタ
  
  Yaf_Controller_Abstract::__construct は final メソッドなので、 オーバーライドできません。
  Yaf_Controller_Abstract::init を参照ください。

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


id: Yaf_Controller_Abstract::display
type: function
doc:
<comment>Description:</comment>
  The display purpose

<comment>Param:</comment>
  <info>string</info>  <strong>$tpl</strong>         
  <info>array</info>   <strong>$parameters</strong>  

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


id: Yaf_Controller_Abstract::forward
type: function
doc:
<comment>Description:</comment>
  別のアクションに転送する
  
  現在の実行プロセスを別のアクションに転送します。  このメソッドは、その場ですぐに次のアクションに切
  り替えるわけではなく、 現在の実行フローが終わってから次のアクションに転送します。
  
  このメソッドは、その場ですぐに次のアクションに切り替えるわけではなく、 現在の実行フローが終わって
  から次のアクションに転送します。

<comment>Param:</comment>
  <info>string</info>  <strong>$module</strong>      移動先のモジュール名。NULL を渡した場合はデフォルトのモジュール名と見なしま
                       す。
  <info>string</info>  <strong>$controller</strong>  移動先のコントローラ名。
  <info>string</info>  <strong>$action</strong>      移動先のアクション名。
  <info>array</info>   <strong>$paramters</strong>   呼び出しの引数。

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

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


id: Yaf_Controller_Abstract::getInvokeArg
type: function
doc:
<comment>Description:</comment>
  The getInvokeArg purpose

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

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


id: Yaf_Controller_Abstract::getInvokeArgs
type: function
doc:
<comment>Description:</comment>
  The getInvokeArgs purpose

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


id: Yaf_Controller_Abstract::getModuleName
type: function
doc:
<comment>Description:</comment>
  モジュール名を取得する
  
  コントローラのモジュール名を取得します。

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


id: Yaf_Controller_Abstract::getName
type: function
doc:
<comment>Description:</comment>
  Get self name
  
  get the controller's name

<comment>Return:</comment>
  <info>string</info>  <info>string</info>, controller name


id: Yaf_Controller_Abstract::getRequest
type: function
doc:
<comment>Description:</comment>
  現在のリクエストオブジェクトを取得する
  
  現在のリクエストオブジェクトを取得します。

<comment>Return:</comment>
  <info>Yaf_Request_Abstract</info>  <class>Yaf_Request_Abstract</class> instance


id: Yaf_Controller_Abstract::getResponse
type: function
doc:
<comment>Description:</comment>
  現在のレスポンスオブジェクトを取得する
  
  現在のレスポンスオブジェクトを取得します。

<comment>Return:</comment>
  <info>Yaf_Response_Abstract</info>  <class>Yaf_Response_Abstract</class> instance


id: Yaf_Controller_Abstract::getView
type: function
doc:
<comment>Description:</comment>
  ビューエンジンを取得する
  
  ビューエンジンを取得します。

<comment>Return:</comment>
  <info>Yaf_View_Interface</info>  


id: Yaf_Controller_Abstract::getViewpath
type: function
doc:
<comment>Description:</comment>
  getViewpath の目的を書く

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


id: Yaf_Controller_Abstract::init
type: function
doc:
<comment>Description:</comment>
  コントローラを初期化する
  
  Yaf_Controller_Abstract::__construct は final メソッドなので、 オーバーライドできません。しかし、
  かわりに Yaf_Controller_Abstract::init を定義できます。 これは、コントローラオブジェクトのインスタ
  ンスができた直後に呼ばれます。

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

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


id: Yaf_Controller_Abstract::initView
type: function
doc:
<comment>Description:</comment>
  The initView purpose

<comment>Param:</comment>
  <info>array</info>  <strong>$options</strong>  

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


id: Yaf_Controller_Abstract::redirect
type: function
doc:
<comment>Description:</comment>
  URL にリダイレクトする
  
  302 ヘッダを送出して、URL にリダイレクトします。

<comment>Param:</comment>
  <info>string</info>  <strong>$url</strong>  場所を表す URL。

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


id: Yaf_Controller_Abstract::render
type: function
doc:
<comment>Description:</comment>
  ビューテンプレートをレンダリングする

<comment>Param:</comment>
  <info>string</info>  <strong>$tpl</strong>         
  <info>array</info>   <strong>$parameters</strong>  

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


id: Yaf_Controller_Abstract::setViewpath
type: function
doc:
<comment>Description:</comment>
  The setViewpath purpose

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

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


id: Yaf_Dispatcher
type: class
doc:
<comment>Description:</comment>
  <class>Yaf_Dispatcher</class> の役割は、 リクエスト環境の初期化、やってきたリクエストのルーティング、 そして見つ
  かったアクションへのディスパッチです。 あらゆるレスポンスを取りまとめ、処理が完了した後でそれを返
  します。
  
  <class>Yaf_Dispatcher</class> はシングルトンパターンを実装しています。 つまり、同時に複数のインスタンスは作れない
  ということです。 そのため、このクラスをレジストリとして使い、 ディスパッチ中に他のオブジェクトから
  参照させることもできます。


id: Yaf_Dispatcher::autoRender
type: function
doc:
<comment>Description:</comment>
  自動レンダリングのオン/オフを切り替える
  
  <class>Yaf_Dispatcher</class> は リクエストをディスパッチした後で自動的にレンダリングします。 これを無効にするに
  は、 <strong>$flag</strong> を <info>true</info> としてこのメソッドを実行します。  アクションで <info>false</info> を返せば、そのアクションで
  の自動レンダリングを回避できます。
  
  アクションで <info>false</info> を返せば、そのアクションでの自動レンダリングを回避できます。

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  bool  2.2.0 以降は、このパラメータを省略した場合に現在の状態を返すようになりました。 
               
               2.2.0 以降は、このパラメータを省略した場合に現在の状態を返すようになりました。

<comment>Return:</comment>
  <info>Yaf_Dispatcher</info>  


id: Yaf_Dispatcher::catchException
type: function
doc:
<comment>Description:</comment>
  例外のキャッチのオン/オフを切り替える
  
  application.dispatcher.throwException が On (あるいは Yaf_Dispatcher::throwException(TRUE) で有効
  にした) 場合、Yaf でエラーが発生したときに例外をスローします。
  
  そのとき、Yaf_Dispatcher::catchException を有効にする (あるいは
  application.dispatcher.catchException で有効にする) と、 もし ErrorController::error を定義してい
  れば キャッチしなかった例外はすべて ErrorController::error に送られます。

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  bool

<comment>Return:</comment>
  <info>Yaf_Dispatcher</info>  

<comment>See Also:</comment>
   * Yaf_Dispatcher::throwException
   * Yaf_Dispatcher::setErrorHandler


id: Yaf_Dispatcher::disableView
type: function
doc:
<comment>Description:</comment>
  ビューのレンダリングを無効にする
  
  ビューエンジンを無効にします。ユーザーが自分自身で出力しているようなアプリケーションで利用します。
  アクションで <info>false</info> を返せば、そのアクションでの自動レンダリングを回避できます。
  
  アクションで <info>false</info> を返せば、そのアクションでの自動レンダリングを回避できます。

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


id: Yaf_Dispatcher::dispatch
type: function
doc:
<comment>Description:</comment>
  リクエストをディスパッチする
  
  このメソッドが、 <class>Yaf_Dispatcher</class> の主要な作業をします。 リクエストオブジェクトを受け取ります。
  
  ディスパッチ処理には、次の三段階があります。 ルーティングディスパッチレスポンス ローディングが発生
  するのは一度だけで、 <strong>Yaf_Dispatcher::dispatch()</strong> が呼ばれたときの リクエストオブジェクトの値を使っ
  て行います。 ディスパッチはループ内で発生します。ひとつのリクエストで 複数のアクションをディスパッ
  チすることもあれば、 コントローラやプラグイン (<class>Yaf_Plugin_Abstract</class> を参照ください) がリクエストオ
  ブジェクトをリセットしてアクションを追加することもあります。 すべてが終わると <class>Yaf_Dispatcher</class> がレ
  スポンスを返します。

<comment>Param:</comment>
  <info>Yaf_Request_Abstract</info>  <strong>$request</strong>  

<comment>Return:</comment>
  <info>Yaf_Response_Abstract</info>  


id: Yaf_Dispatcher::enableView
type: function
doc:
<comment>Description:</comment>
  ビューのレンダリングを有効にする

<comment>Return:</comment>
  <info>Yaf_Dispatcher</info>  


id: Yaf_Dispatcher::flushInstantly
type: function
doc:
<comment>Description:</comment>
  その場でのフラッシュのオン/オフを切り替える

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  bool  2.2.0 以降は、このパラメータを省略した場合に現在の状態を返すようになりました。 
               
               2.2.0 以降は、このパラメータを省略した場合に現在の状態を返すようになりました。

<comment>Return:</comment>
  <info>Yaf_Dispatcher</info>  


id: Yaf_Dispatcher::getApplication
type: function
doc:
<comment>Description:</comment>
  アプリケーションを取得する
  
  <class>Yaf_Application</class> のインスタンスを取得します。 Yaf_Application::app と同じです。

<comment>Return:</comment>
  <info>Yaf_Application</info>  

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


id: Yaf_Dispatcher::getDefaultAction
type: function
doc:
<comment>Description:</comment>
  Retrive the default action name
  
  get the default action name

<comment>Return:</comment>
  <info>string</info>  <info>string</info>, default action name, default is "index"


id: Yaf_Dispatcher::getDefaultController
type: function
doc:
<comment>Description:</comment>
  Retrive the default controller name
  
  get the default controller name

<comment>Return:</comment>
  <info>string</info>  <info>string</info>, default controller name, default is "Index"


id: Yaf_Dispatcher::getDefaultModule
type: function
doc:
<comment>Description:</comment>
  Retrive the default module name
  
  get the default module name

<comment>Return:</comment>
  <info>string</info>  <info>string</info>, module name, default is "Index"


id: Yaf_Dispatcher::getInstance
type: function
doc:
<comment>Description:</comment>
  ディスパッチャのインスタンスを取得する

<comment>Return:</comment>
  <info>Yaf_Dispatcher</info>  


id: Yaf_Dispatcher::getRequest
type: function
doc:
<comment>Description:</comment>
  リクエストのインスタンスを取得する

<comment>Return:</comment>
  <info>Yaf_Request_Abstract</info>  


id: Yaf_Dispatcher::getRouter
type: function
doc:
<comment>Description:</comment>
  ルーターのインスタンスを取得する

<comment>Return:</comment>
  <info>Yaf_Router</info>  


id: Yaf_Dispatcher::initView
type: function
doc:
<comment>Description:</comment>
  ビューを初期化して返す

<comment>Param:</comment>
  <info>string</info>  <strong>$templates_dir</strong>  
  <info>array</info>   <strong>$options</strong>        

<comment>Return:</comment>
  <info>Yaf_View_Interface</info>  


id: Yaf_Dispatcher::registerPlugin
type: function
doc:
<comment>Description:</comment>
  プラグインを登録する
  
  プラグイン (<class>Yaf_Plugin_Abstract</class> を参照) を登録します。ふつうは、プラグインの登録はブートストラップ
  (<class>Yaf_Bootstrap_Abstract</class> を参照) で行います。

<comment>Param:</comment>
  <info>Yaf_Plugin_Abstract</info>  <strong>$plugin</strong>  

<comment>Return:</comment>
  <info>Yaf_Dispatcher</info>  

<comment>See Also:</comment>
   * <class>Yaf_Plugin_Abstract</class>
   * <class>Yaf_Bootstrap_Abstract</class>


id: Yaf_Dispatcher::returnResponse
type: function
doc:
<comment>Description:</comment>
  The returnResponse purpose

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  

<comment>Return:</comment>
  <info>Yaf_Dispatcher</info>  


id: Yaf_Dispatcher::setDefaultAction
type: function
doc:
<comment>Description:</comment>
  デフォルトのアクション名を変更する

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

<comment>Return:</comment>
  <info>Yaf_Dispatcher</info>  


id: Yaf_Dispatcher::setDefaultController
type: function
doc:
<comment>Description:</comment>
  デフォルトのコントローラ名を変更する

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

<comment>Return:</comment>
  <info>Yaf_Dispatcher</info>  


id: Yaf_Dispatcher::setDefaultModule
type: function
doc:
<comment>Description:</comment>
  デフォルトのモジュール名を変更する

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

<comment>Return:</comment>
  <info>Yaf_Dispatcher</info>  


id: Yaf_Dispatcher::setErrorHandler
type: function
doc:
<comment>Description:</comment>
  エラーハンドラを設定する
  
  Yaf のエラーハンドラを設定します。application.dispatcher.throwException がオフの場合は、予期せぬエ
  ラーが発生した場合に Yaf はキャッチ可能なエラーを発生させます。
  
  従って、このエラーハンドラが呼ばれる一方でエラーも発生します。

<comment>Param:</comment>
  <info>call</info>  <strong>$callback</strong>     コールバック。
  <info>int</info>   <strong>$error_types</strong>  

<comment>Return:</comment>
  <info>Yaf_Dispatcher</info>  

<comment>See Also:</comment>
   * Yaf_Dispatcher::throwException
   * Yaf_Application::getLastErrorNo
   * Yaf_Application::getLastErrorMsg


id: Yaf_Dispatcher::setRequest
type: function
doc:
<comment>Description:</comment>
  The setRequest purpose

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

<comment>Return:</comment>
  <info>Yaf_Dispatcher</info>  


id: Yaf_Dispatcher::setView
type: function
doc:
<comment>Description:</comment>
  カスタムビューエンジンを設定する
  
  このメソッドは、<class>Yaf_View_Simple</class> ではなくカスタムビューエンジンを使いたいときに利用します。

<comment>Param:</comment>
  <info>Yaf_View_Interface</info>  <strong>$view</strong>  <class>Yaf_View_Interface</class> のインスタンス。

<comment>Return:</comment>
  <info>Yaf_Dispatcher</info>  

<comment>See Also:</comment>
   * <class>Yaf_View_Interface</class>
   * <class>Yaf_View_Simple</class>


id: Yaf_Dispatcher::throwException
type: function
doc:
<comment>Description:</comment>
  例外のスローのオン/オフを切り替える
  
  予期せぬエラーが発生した場合に例外をスローするかどうかを切り替えます。 オンにすると、Yaf はキャッ
  チ可能なエラーを発生させるのではなく例外をスローするようになります。
  
   application.dispatcher.throwException を使って同じ設定をすることもできます。

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  bool

<comment>Return:</comment>
  <info>Yaf_Dispatcher</info>  

<comment>See Also:</comment>
   * Yaf_Dispatcher::catchException
   * <class>Yaf_Exception</class>


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

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


id: Yaf_Loader
type: class
doc:
<comment>Description:</comment>
  <class>Yaf_Loader</class> は、 Yaf 用に包括的なオートローディング機能を導入します。
  
  最初に <class>Yaf_Application</class> のインスタンスを取得するときに、 <class>Yaf_Loader</class> はシングルトンのインスタンスを
  作って それを spl_autoload に登録します。このインスタンスを取得するには Yaf_Loader::getInstance を
  使います。
  
  <class>Yaf_Loader</class> は、クラスのロードを一度だけ試みます。 失敗した場合の挙動は yaf.use_spl_auload によって
  変わります。もしこの設定が On なら Yaf_Loader::autoload は <info>false</info> を返し、 他のオートロード関数でや
  り直せるようになります。この設定が Off (デフォルト) の場合は Yaf_Loader::autoload が <info>true</info> を返しま
  す。 そして、より重要なのは、このときに警告メッセージが出ることです (このメッセージを見れば、なぜ
  ロードできなかったのかがわかります)。  yaf.use_spl_autoload はできるだけ Off のままにしておきま
  しょう。 ただし、何かのライブラリが自前のオートロード機構を持っていて、 それを置き換えるのが不可能
  だという場合は別です。
  
  yaf.use_spl_autoload はできるだけ Off のままにしておきましょう。 ただし、何かのライブラリが自前の
  オートロード機構を持っていて、 それを置き換えるのが不可能だという場合は別です。
  
  デフォルトでは、<class>Yaf_Loader</class> はすべてのライブラリ (クラスを定義したスクリプト) が グローバル ライブ
  ラリディレクトリ に格納されているものとみなします。このディレクトリは、 php.ini (yaf.library) で指
  定します。
  
  <class>Yaf_Loader</class> がクラス (ライブラリ) を探すときに ローカルクラスディレクトリ (application.ini で定義す
  るもので、デフォルトは application.directory . "/library") も検索対象とさせたい場合は、クラスのプ
  レフィックスを Yaf_Loader::registerLocalNameSpace で登録する必要があります。
  
  いくつか例を示します (APPLICATION_PATH は application.directory であるものとします)。 設定の例
   また、次のローカル名前空間を登録しているものとします。 localnamespace の登録
  registerLocalNameSpace(array("Foo", "Bar")); }
  ?>
  ]]>
   オートロードの例です。 クラスのロード // APPLICATION_PATH/library/Foo/Bar/Test.php 
  class GLO_Name  => // /global_dir/Glo/Name.php 
  class BarNon_Test // /global_dir/Barnon/Test.php
  ]]>
   名前空間つきのクラスのロード // APPLICATION_PATH/library/Foo/Bar/Dummy.php
  
  class \FooBar\Bar\Dummy => // /global_dir/FooBar/Bar/Dummy.php
  ]]>
  
  すべてのフォルダの先頭が大文字になっているのが気になる場合は、php.ini で yaf.lowcase_path = On と
  すれば小文字にすることもできます。
  
  <class>Yaf_Loader</class> は MVC クラスを読み込むようにも作られています。 次のような規約に従います。 MVC クラスの
  ロード
  // APPLICATION_PATH/controllers/
  
  Model Classes =>
  // APPLICATION_PATH/models/
  
  Plugin Classes =>
  // APPLICATION_PATH/plugins/
  ]]>
   クラスのサフィックス (デフォルト設定の場合。プレフィックスを使うには yaf.name_suffix の値を変更し
  ます) で、MVC クラスであるかそうでないかを判断します。 MVC クラスかどうかの区別 // ***Controller
  
  Model Classes => // ***Model
  
  Plugin Classes => // ***Plugin
  ]]>
   例を示します。 MVC のロード // APPLICATION_PATH/models/Data.php
  
  class DummyPlugin => // APPLICATION_PATH/plugins/Dummy.php
  
  class A_B_TestModel => // APPLICATION_PATH/models/A/B/Test.php
  ]]>
    2.1.18 からは、Yaf はユーザースクリプト側からのコントローラのオートロードに対応しました (つま
  り、ユーザーが書いた PHP スクリプトからオートロードを実行できるということです。 ブートストラップや
  プラグインから、コントローラのstaticプロパティにアクセスできます)。 しかし、オートローダーがコント
  ローラクラスを探す場所は、デフォルトのモジュールフォルダつまり "APPLICATION_PATH/controllers/" だ
  けになります。  また、ディレクトリは yaf.lowcase_path の影響を受けます。
  
  2.1.18 からは、Yaf はユーザースクリプト側からのコントローラのオートロードに対応しました (つまり、
  ユーザーが書いた PHP スクリプトからオートロードを実行できるということです。 ブートストラップやプラ
  グインから、コントローラのstaticプロパティにアクセスできます)。 しかし、オートローダーがコントロー
  ラクラスを探す場所は、デフォルトのモジュールフォルダつまり "APPLICATION_PATH/controllers/" だけに
  なります。


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


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

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


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

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


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

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


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

<comment>Return:</comment>
  <info>Yaf_Loader</info>  


id: Yaf_Loader::getLocalNamespace
type: function
doc:
<comment>Description:</comment>
  Retrive all register namespaces info
  
  get registered namespaces info

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


id: Yaf_Loader::getNamespacePath
type: function
doc:
<comment>Description:</comment>
  Retieve path of a registered namespace
  
  retrieve path of a registered namespace

<comment>Param:</comment>
  <info></info>  <strong>$namespace</strong>  a string of namespace.

<comment>Return:</comment>
  <info>string</info>  <info>string</info> path, if the namespace is not registered, then <info>null</info> default library will be
          returned


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

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


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

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


id: Yaf_Loader::registerLocalNamespace
type: function
doc:
<comment>Description:</comment>
  ローカルクラスプレフィックスを登録する
  
  ローカルクラスプレフィックスを登録します。 <class>Yaf_Loader</class> がクラスを探すときには、二つのライブラリディ
  レクトリを探します。 一方は application.ini の application.library.directory(in で設定したもので、
  これをローカルライブラリディレクトリと呼びます。 もう一方は php.ini の yaf.library で設定したもの
  で、これをグローバルライブラリディレクトリと呼びます。 同一サーバー内のいろんなアプリケーションで
  共有できるからです。
  
  オートロード時に、<class>Yaf_Loader</class> がどちらのライブラリディレクトリを探すのかを判断します。 その際には、
  存在しないクラス名のプレフィックスを判断材料にします。
   プレフィックスの名前が localnamespace として登録されていれば ローカルライブラリディレクトリから探
  し、そうでなければグローバルライブラリディレクトリから探します。  yaf.library が設定されていない場
  合、グローバルライブラリディレクトリは ローカルライブラリディレクトリと同じ場所であるとみなしま
  す。 その場合、オートロード時にはすべてローカルライブラリディレクトリを探します。
   Yaf アプリケーションを強くするには、 自分のクラスはローカルクラスとして登録するようにしましょう。 
  
  yaf.library が設定されていない場合、グローバルライブラリディレクトリは ローカルライブラリディレク
  トリと同じ場所であるとみなします。 その場合、オートロード時にはすべてローカルライブラリディレクト
  リを探します。
   Yaf アプリケーションを強くするには、 自分のクラスはローカルクラスとして登録するようにしましょう。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$prefix</strong>  クラス名のプレフィックスを表す文字列あるいは配列。 ローカルライブラリパスにある、
                  このプレフィックスを含むすべてのクラスが読み込まれます。

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


id: Yaf_Loader::registerNamespace
type: function
doc:
<comment>Description:</comment>
  Register namespace with searching path
  
  Register a namespace with searching path, <class>Yaf_Loader</class> searchs classes under this namespace in path,
  the one is also could be  configureded via  application.library.directory.namespace(in
  application.ini);
  
   Yaf still think underline as folder separator. 
  
  Yaf still think underline as folder separator.

<comment>Param:</comment>
  <info></info>        <strong>$namespace</strong>  a string of namespace, or a array of namespaces with paths.
  <info>string</info>  <strong>$path</strong>       a string of path, it is better to use abosolute path here for performance

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


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

<comment>Return:</comment>
  <info>Yaf_Loader</info>  


id: Yaf_Plugin_Abstract
type: class
doc:
<comment>Description:</comment>
  プラグインを使えば、フレームワークの拡張やカスタマイズを簡単に行えます。
  
  プラグインは、クラスとして定義します。 実際のクラスの定義はコンポーネントによって異なります。 この
  インターフェイスを実装する必要があるかもしれませんが、 プラグイン自体がクラスであるという事実は変
  わりません。
  
  プラグインを Yaf にロードするには Yaf_Dispatcher::registerPlugin を使います。登録を済ませれば、こ
  のインターフェイスに従って実装した すべてのメソッドが適切な場面で呼ばれます。


id: Yaf_Plugin_Abstract::dispatchLoopShutdown
type: function
doc:
<comment>Description:</comment>
  The dispatchLoopShutdown purpose
  
  これは、Yaf プラグインのフックシステム内での最後のフックです。 このメソッドを実装したカスタムプラ
  グインは、 ディスパッチループが終了したときに呼ばれます。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>Yaf_Request_Abstract</info>   <strong>$request</strong>   
  <info>Yaf_Response_Abstract</info>  <strong>$response</strong>  

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

<comment>See Also:</comment>
   * Yaf_Plugin_Abstract::routerStartup
   * Yaf_Plugin_Abstract::routerShutdown
   * Yaf_Plugin_Abstract::dispatchLoopStartup
   * Yaf_Plugin_Abstract::preDispatch
   * Yaf_Plugin_Abstract::postDispatch


id: Yaf_Plugin_Abstract::dispatchLoopStartup
type: function
doc:
<comment>Description:</comment>
  ディスパッチループの前にフックする

<comment>Param:</comment>
  <info>Yaf_Request_Abstract</info>   <strong>$request</strong>   
  <info>Yaf_Response_Abstract</info>  <strong>$response</strong>  

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


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

<comment>Param:</comment>
  <info>Yaf_Request_Abstract</info>   <strong>$request</strong>   
  <info>Yaf_Response_Abstract</info>  <strong>$response</strong>  

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


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

<comment>Param:</comment>
  <info>Yaf_Request_Abstract</info>   <strong>$request</strong>   
  <info>Yaf_Response_Abstract</info>  <strong>$response</strong>  

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


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

<comment>Param:</comment>
  <info>Yaf_Request_Abstract</info>   <strong>$request</strong>   
  <info>Yaf_Response_Abstract</info>  <strong>$response</strong>  

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


id: Yaf_Plugin_Abstract::routerShutdown
type: function
doc:
<comment>Description:</comment>
  The routerShutdown purpose
  
  このフックが動くのは、ルーティングが終了したときです。 このフックは、ログインのチェックなどでよく
  使います。

<comment>Param:</comment>
  <info>Yaf_Request_Abstract</info>   <strong>$request</strong>   
  <info>Yaf_Response_Abstract</info>  <strong>$response</strong>  

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

<comment>See Also:</comment>
   * Yaf_Plugin_Abstract::routerStartup
   * Yaf_Plugin_Abstract::dispatchLoopStartup
   * Yaf_Plugin_Abstract::preDispatch
   * Yaf_Plugin_Abstract::postDispatch
   * Yaf_Plugin_Abstract::dispatchLoopShutdown


id: Yaf_Plugin_Abstract::routerStartup
type: function
doc:
<comment>Description:</comment>
  RouterStartup フック
  
  これは、Yaf プラグインのフックシステム内での最初のフックです。 このメソッドを実装したカスタムプラ
  グインは、 ルーティングを始める前に呼ばれます。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>Yaf_Request_Abstract</info>   <strong>$request</strong>   
  <info>Yaf_Response_Abstract</info>  <strong>$response</strong>  

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

<comment>See Also:</comment>
   * Yaf_Plugin_Abstract::routerShutdown
   * Yaf_Plugin_Abstract::dispatchLoopStartup
   * Yaf_Plugin_Abstract::preDispatch
   * Yaf_Plugin_Abstract::postDispatch
   * Yaf_Plugin_Abstract::dispatchLoopShutdown


id: Yaf_Registry
type: class
doc:
<comment>Description:</comment>
  <class>Yaf_Registry</class> のすべてのメソッドはstaticメソッドとして宣言されており、 どこからでもアクセスできま
  す。これを使えば、コードのどこからでも必要に応じて 任意のデータを保存したり取得したりすることがで
  きます。


id: Yaf_Registry::del
type: function
doc:
<comment>Description:</comment>
  アイテムをレジストリから削除する
  
  アイテムをレジストリから削除します。

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

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


id: Yaf_Registry::get
type: function
doc:
<comment>Description:</comment>
  アイテムをレジストリから取得する
  
  アイテムをレジストリから取得します。

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

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


id: Yaf_Registry::has
type: function
doc:
<comment>Description:</comment>
  アイテムが存在するかどうかを調べる
  
  アイテムが存在するかどうかを調べます。

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

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


id: Yaf_Registry::set
type: function
doc:
<comment>Description:</comment>
  アイテムをレジストリに追加する
  
  アイテムをレジストリに追加します。

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

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


id: Yaf_Request_Abstract::clearParams
type: function
doc:
<comment>Description:</comment>
  Remove all params
  
  Remove all params set by router, or Yaf_Request_Abstract::setParam

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

<comment>See Also:</comment>
   * Yaf_Request_Abstract::isHead
   * Yaf_Request_Abstract::isGet
   * Yaf_Request_Abstract::isPost
   * Yaf_Request_Abstract::isPut
   * Yaf_Request_Abstract::isOptions
   * Yaf_Request_Abstract::isXmlHTTPRequest


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

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


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

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


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

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


id: Yaf_Request_Abstract::getEnv
type: function
doc:
<comment>Description:</comment>
  ENV 変数を取得する
  
  ENV 変数を取得します。

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>     変数名。
  <info>string</info>  <strong>$default</strong>  このパラメータを指定すると、変数が見つからない場合にこの値を返すようになります。

<comment>Return:</comment>
  <info>void</info>  ストリングを返します

<comment>See Also:</comment>
   * <class>Yaf_Request_Abstract::getServer</class>
   * <class>Yaf_Request_Abstract::getParam</class>


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

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


id: Yaf_Request_Abstract::getLanguage
type: function
doc:
<comment>Description:</comment>
  クライアントの好きな言語を取得する

<comment>Return:</comment>
  <info>void</info>  文字列を返します。


id: Yaf_Request_Abstract::getMethod
type: function
doc:
<comment>Description:</comment>
  リクエストメソッドを取得する

<comment>Return:</comment>
  <info>string</info>  "POST", "GET" などのような文字列を返します。

<comment>See Also:</comment>
   * Yaf_Request_Abstract::isHead
   * Yaf_Request_Abstract::isCli
   * Yaf_Request_Abstract::isPost
   * Yaf_Request_Abstract::isPut
   * Yaf_Request_Abstract::isOptions
   * Yaf_Request_Abstract::isXmlHTTPRequest


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

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


id: Yaf_Request_Abstract::getParam
type: function
doc:
<comment>Description:</comment>
  呼び出しパラメータを取得する

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

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

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


id: Yaf_Request_Abstract::getParams
type: function
doc:
<comment>Description:</comment>
  全ての呼び出しパラメータを取得する

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

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


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

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


id: Yaf_Request_Abstract::getServer
type: function
doc:
<comment>Description:</comment>
  SERVER 変数を取得する
  
  SERVER 変数を取得します。

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>     変数名。
  <info>string</info>  <strong>$default</strong>  このパラメータを指定すると、変数が見つからない場合にこの値を返すようになります。

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

<comment>See Also:</comment>
   * Yaf_Request_Abstract::getParam
   * Yaf_Request_Abstract::getEnv


id: Yaf_Request_Abstract::isCli
type: function
doc:
<comment>Description:</comment>
  CLIリクエストかを判定する

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

<comment>See Also:</comment>
   * Yaf_Request_Abstract::isHead
   * Yaf_Request_Abstract::isGet
   * Yaf_Request_Abstract::isPost
   * Yaf_Request_Abstract::isPut
   * Yaf_Request_Abstract::isOptions
   * Yaf_Request_Abstract::isXmlHTTPRequest


id: Yaf_Request_Abstract::isDispatched
type: function
doc:
<comment>Description:</comment>
  リクエストがディスパッチ済みかを判定する

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

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


id: Yaf_Request_Abstract::isGet
type: function
doc:
<comment>Description:</comment>
  GETリクエストかどうかを判定する

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

<comment>See Also:</comment>
   * Yaf_Request_Abstract::isHead
   * Yaf_Request_Abstract::isCli
   * Yaf_Request_Abstract::isPost
   * Yaf_Request_Abstract::isPut
   * Yaf_Request_Abstract::isOptions
   * Yaf_Request_Abstract::isXmlHTTPRequest


id: Yaf_Request_Abstract::isHead
type: function
doc:
<comment>Description:</comment>
  HEADリクエストかどうかを判定する

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

<comment>See Also:</comment>
   * Yaf_Request_Abstract::isGet
   * Yaf_Request_Abstract::isCli
   * Yaf_Request_Abstract::isPost
   * Yaf_Request_Abstract::isPut
   * Yaf_Request_Abstract::isOptions
   * Yaf_Request_Abstract::isXmlHTTPRequest


id: Yaf_Request_Abstract::isOptions
type: function
doc:
<comment>Description:</comment>
  OPTIONS リクエストかどうかを判定する

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


id: Yaf_Request_Abstract::isPost
type: function
doc:
<comment>Description:</comment>
  POST リクエストかどうかを判定する

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

<comment>See Also:</comment>
   * Yaf_Request_Abstract::isGet
   * Yaf_Request_Abstract::isCli
   * Yaf_Request_Abstract::isHead
   * Yaf_Request_Abstract::isPut
   * Yaf_Request_Abstract::isOptions
   * Yaf_Request_Abstract::isXmlHTTPRequest


id: Yaf_Request_Abstract::isPut
type: function
doc:
<comment>Description:</comment>
  PUTリクエストかどうかを判定する

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

<comment>See Also:</comment>
   * Yaf_Request_Abstract::isHead
   * Yaf_Request_Abstract::isCli
   * Yaf_Request_Abstract::isPost
   * Yaf_Request_Abstract::isGet
   * Yaf_Request_Abstract::isOptions
   * Yaf_Request_Abstract::isXmlHTTPRequest


id: Yaf_Request_Abstract::isRouted
type: function
doc:
<comment>Description:</comment>
  リクエストがルーティング済みかを判定する

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


id: Yaf_Request_Abstract::isXmlHttpRequest
type: function
doc:
<comment>Description:</comment>
  AJAXリクエストかどうかを判定する

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

<comment>See Also:</comment>
   * Yaf_Request_Abstract::isHead
   * Yaf_Request_Abstract::isCli
   * Yaf_Request_Abstract::isPost
   * Yaf_Request_Abstract::isPut
   * Yaf_Request_Abstract::isOptions
   * Yaf_Request_Abstract::isGet


id: Yaf_Request_Abstract::setActionName
type: function
doc:
<comment>Description:</comment>
  アクション名を設定する
  
  アクション名をリクエストに設定します。 このメソッドは通常、ルーティング結果のコントローラー名を設
  定するカスタムルータで使います。

<comment>Param:</comment>
  <info>string</info>  <strong>$action</strong>       アクション名を表す<info>string</info>。 "index" や "foo_Bar" のように、小文字で表記すべき
                        です。
  <info>bool</info>    <strong>$format_name</strong>  Yaf 3.2.0 で追加されました。 デフォルトでは、Yaf は名前を小文字に変換します
                        が、 このパラメータを <info>false</info> に設定すると、指定された値そのままをリクエストに
                        使います。

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


id: Yaf_Request_Abstract::setBaseUri
type: function
doc:
<comment>Description:</comment>
  ベース URI を設定する
  
  ベース URI を設定します。ベース URI はルーティング時に使います。 ルーティングの際にはリクエスト
  URI を使ってリクエストを振り分けますが、 そのときに、ベース URI を使ってリクエスト URI の先頭部分
  を読み飛ばします。
   たとえば、リクエスト URI が a/b/c でベース URI が "a/b" の場合、"/c" の部分だけを使ってルーティン
  グします。  普通はこれを設定する必要はありません。Yaf が自動的に判断します。
  
  普通はこれを設定する必要はありません。Yaf が自動的に判断します。

<comment>Param:</comment>
  <info>string</info>  <strong>$uir</strong>  ベース URI。

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


id: Yaf_Request_Abstract::setControllerName
type: function
doc:
<comment>Description:</comment>
  コントローラー名を設定する
  
  コントローラー名をリクエストに設定します。 このメソッドは通常、ルーティング結果のコントローラー名
  を設定するカスタムルータで使います。

<comment>Param:</comment>
  <info>string</info>  <strong>$controller</strong>   コントローラー名を表す <info>string</info>。 "Index" や "Foo_Bar" のように、キャメルケー
                        スで表記すべきです。
  <info>bool</info>    <strong>$format_name</strong>  Yaf 3.2.0 で追加されました。 デフォルトでは、Yaf は名前をキャメルケースで
                        フォーマットしますが、 このパラメータを <info>false</info> に設定すると、指定された値その
                        ままをリクエストに使います。

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


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

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


id: Yaf_Request_Abstract::setModuleName
type: function
doc:
<comment>Description:</comment>
  モジュール名を設定する
  
  リクエストするモジュール名を設定します。 このメソッドは通常、ルーティング結果のモジュール名を設定
  するカスタムルータで使います。

<comment>Param:</comment>
  <info>string</info>  <strong>$module</strong>       モジュール名を表す<info>string</info>。 "Index" や "Foo_Bar" のように、キャメルケースで表
                        記すべきです。
  <info>bool</info>    <strong>$format_name</strong>  Yaf 3.2.0 で追加されました。 デフォルトでは、Yaf は名前をキャメルケースで
                        フォーマットしますが、 このパラメータを <info>false</info> に設定すると、指定された値その
                        ままをリクエストに使います。

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


id: Yaf_Request_Abstract::setParam
type: function
doc:
<comment>Description:</comment>
  呼び出しパラメータをリクエストに設定する
  
  パラメータをリクエストに設定します。 設定した値は、Yaf_Request_Abstract::getParam で取得できます

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

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

<comment>See Also:</comment>
   * Yaf_Request_Abstract::getParam
   * Yaf_Request_Abstract::getParams


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

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

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


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

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

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


id: Yaf_Request_Http
type: class
doc:
<comment>Description:</comment>
  クライアントからのあらゆるリクエストは、 <class>Yaf_Request_Http</class> として初期化されます。 URI のクエリ文字
  列や POST パラメータなどの情報は、このクラスのメソッド経由で取得できます。  セキュリティの観点か
  ら、Yaf では $_GET/$_POST が読み込み専用となっています。つまり、 これらのグローバル変数の値を書き
  換えたとしても、 Yaf_Request_Http::getQuery や Yaf_Request_Http::getPost からはそれを取得できない
  ということです。  しかし、ユニットテストの際などに、どうしても書き換えが必要になることもあります。
  Yaf のビルド時に --enable-yaf-debug を指定すると、ユーザーがスクリプトで設定した値も Yaf で読み込
  めるようになります。  その際に、Yaf は E_STRICT レベルの警告 「Strict Standards: you are running
  yaf in debug mode」を発します。
  
  セキュリティの観点から、Yaf では $_GET/$_POST が読み込み専用となっています。つまり、 これらのグ
  ローバル変数の値を書き換えたとしても、 Yaf_Request_Http::getQuery や Yaf_Request_Http::getPost か
  らはそれを取得できないということです。
  
  しかし、ユニットテストの際などに、どうしても書き換えが必要になることもあります。 Yaf のビルド時に
  --enable-yaf-debug を指定すると、ユーザーがスクリプトで設定した値も Yaf で読み込めるようになりま
  す。
  
  その際に、Yaf は E_STRICT レベルの警告 「Strict Standards: you are running yaf in debug mode」を発
  します。


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


id: Yaf_Request_Http::get
type: function
doc:
<comment>Description:</comment>
  クライアントからの変数を取得する
  
  クライアントからの変数を取得します。このメソッドは、まずリクエストのパラメータから <strong>$name</strong> を探し、
  見つからない場合は POST、GET、Cookie、Server を調べます。

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>     変数名。
  <info>string</info>  <strong>$default</strong>  このパラメータを指定すると、変数が見つからない場合にこの値を返すようになります。

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

<comment>See Also:</comment>
   * Yaf_Request_Http::getQuery
   * Yaf_Request_Http::getPost
   * Yaf_Request_Http::getCookie
   * Yaf_Request_Http::getRaw
   * Yaf_Request_Abstract::getServer
   * Yaf_Request_Abstract::getParam


id: Yaf_Request_Http::getCookie
type: function
doc:
<comment>Description:</comment>
  Cookie 変数を取得する
  
  Cookie 変数を取得します。

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>     クッキー名。
  <info>string</info>  <strong>$default</strong>  このパラメータを指定すると、クッキーが見つからない場合にこの値を返すようになりま
                    す。

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

<comment>See Also:</comment>
   * Yaf_Request_Http::get
   * Yaf_Request_Http::getQuery
   * Yaf_Request_Http::getPost
   * Yaf_Request_Http::getRaw
   * Yaf_Request_Abstract::getServer
   * Yaf_Request_Abstract::getParam


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

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


id: Yaf_Request_Http::getPost
type: function
doc:
<comment>Description:</comment>
  POST 変数を取得する
  
  POST 変数を取得します。

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>     変数名。
  <info>string</info>  <strong>$default</strong>  このパラメータを指定すると、変数が見つからない場合にこの値を返すようになります。

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

<comment>See Also:</comment>
   * Yaf_Request_Http::get
   * Yaf_Request_Http::getQuery
   * Yaf_Request_Http::getCookie
   * Yaf_Request_Http::getRaw
   * Yaf_Request_Abstract::getServer
   * Yaf_Request_Abstract::getParam


id: Yaf_Request_Http::getQuery
type: function
doc:
<comment>Description:</comment>
  クエリパラメータを取得する
  
  GET 変数を取得します。

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>     変数名。
  <info>string</info>  <strong>$default</strong>  このパラメータを指定すると、変数が見つからない場合にこの値を返すようになります。

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

<comment>See Also:</comment>
   * Yaf_Request_Http::get
   * Yaf_Request_Http::getPost
   * Yaf_Request_Http::getCookie
   * Yaf_Request_Http::getRaw
   * Yaf_Request_Abstract::getServer
   * Yaf_Request_Abstract::getParam


id: Yaf_Request_Http::getRaw
type: function
doc:
<comment>Description:</comment>
  生のリクエストボディを取得する
  
  生のリクエストボディを取得します。

<comment>Return:</comment>
  <info>mixed</info>  成功した場合に文字列を、失敗した場合に FALSE を返します。

<comment>See Also:</comment>
   * Yaf_Request_Http::get
   * Yaf_Request_Http::getPost
   * Yaf_Request_Http::getCookie
   * Yaf_Request_Http::getQuery
   * Yaf_Request_Abstract::getServer
   * Yaf_Request_Abstract::getParam


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

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


id: Yaf_Request_Http::isXmlHttpRequest
type: function
doc:
<comment>Description:</comment>
  リクエストが Ajax リクエストかどうかを判断する
  
  そのリクエストが Ajax リクエストであるかどうかを調べます。  このメソッドはリクエストヘッダーの
  HTTP_X_REQUESTED_WITH を見て判断しますが、 JavaScript ライブラリの中には、Ajax リクエストの際にこ
  のヘッダーをセットしないものがあります。
  
  このメソッドはリクエストヘッダーの HTTP_X_REQUESTED_WITH を見て判断しますが、 JavaScript ライブラ
  リの中には、Ajax リクエストの際にこのヘッダーをセットしないものがあります。

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


id: Yaf_Request_Simple
type: class
doc:
<comment>Description:</comment>
  <class>Yaf_Request_Simple</class> は、 テスト用に使うためのクラスです。 つまり、特定のリクエストを CLI モードでシ
  ミュレートしたりするときに使います。


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


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

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


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

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


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

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


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

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


id: Yaf_Request_Simple::isXmlHttpRequest
type: function
doc:
<comment>Description:</comment>
  リクエストが AJAX 経由のリクエストかどうかを判定する

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

<comment>See Also:</comment>
   * Yaf_Request_Abstract::isXmlHTTPRequest
   * Yaf_Request_Http::isXmlHTTPRequest


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


id: Yaf_Response_Abstract::__toString
type: function
doc:
<comment>Description:</comment>
  すべてのレスポンスボディを文字列として取得する

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


id: Yaf_Response_Abstract::appendBody
type: function
doc:
<comment>Description:</comment>
  レスポンス本文に追記する
  
  既存のコンテンツブロックの後にコンテンツを追加します。

<comment>Param:</comment>
  <info></info>        <strong>$body</strong>  コンテンツ文字列。
  <info>string</info>  <strong>$key</strong>   コンテンツのキー。キーを指定しない場合は、 Yaf_Response_Abstract::DEFAULT_BODY を使
                 います。  このパラメータは 2.2.0 で導入されました。
                 
                 このパラメータは 2.2.0 で導入されました。

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

<comment>See Also:</comment>
   * <class>Yaf_Config_Ini</class>
   * Yaf_Response_Abstract::getBody
   * Yaf_Response_Abstract::setBody
   * Yaf_Response_Abstract::prependBody
   * Yaf_Response_Abstract::clearBody


id: Yaf_Response_Abstract::clearBody
type: function
doc:
<comment>Description:</comment>
  既存のすべてのレスポンス本文を破棄します
  
  既存のコンテンツを消去します。

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>  コンテンツのキー。キーを指定しない場合は、すべてのコンテンツを消去します。  このパラ
                メータは 2.2.0 で導入されました。
                
                このパラメータは 2.2.0 で導入されました。

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

<comment>See Also:</comment>
   * Yaf_Response_Abstract::setBody
   * Yaf_Response_Abstract::appendBody
   * Yaf_Response_Abstract::prependBody
   * Yaf_Response_Abstract::getBody


id: Yaf_Response_Abstract::clearHeaders
type: function
doc:
<comment>Description:</comment>
  すべてのヘッダをクリアする

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

<comment>See Also:</comment>
   * Yaf_Response_Abstract::getHeader
   * Yaf_Response_Abstract::setHeader


id: Yaf_Response_Abstract::getBody
type: function
doc:
<comment>Description:</comment>
  コンテンツを取得する
  
  コンテンツを取得します。

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>  コンテンツのキー。キーを指定しない場合は、Yaf_Response_Abstract::DEFAULT_BODY を使い
                ます。<info>null</info> を渡すと、すべてのコンテンツを配列で返します。 as a array  このパラメータ
                は 2.2.0 で導入されました。
                
                このパラメータは 2.2.0 で導入されました。

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

<comment>See Also:</comment>
   * Yaf_Response_Abstract::setBody
   * Yaf_Response_Abstract::appendBody
   * Yaf_Response_Abstract::prependBody
   * Yaf_Response_Abstract::clearBody


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

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

<comment>See Also:</comment>
   * Yaf_Response_Abstract::setHeader
   * Yaf_Response_Abstract::cleanHeaders


id: Yaf_Response_Abstract::prependBody
type: function
doc:
<comment>Description:</comment>
  The prependBody purpose
  
  既存のコンテンツブロックの前にコンテンツを追加します。

<comment>Param:</comment>
  <info></info>        <strong>$body</strong>  コンテンツ文字列。
  <info>string</info>  <strong>$key</strong>   コンテンツのキー。キーを指定しない場合は、 Yaf_Response_Abstract::DEFAULT_BODY を使
                 います。  このパラメータは 2.2.0 で導入されました。
                 
                 このパラメータは 2.2.0 で導入されました。

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

<comment>See Also:</comment>
   * Yaf_Response_Abstract::getBody
   * Yaf_Response_Abstract::setBody
   * Yaf_Response_Abstract::appendBody
   * Yaf_Response_Abstract::clearBody


id: Yaf_Response_Abstract::response
type: function
doc:
<comment>Description:</comment>
  レスポンスを送信する
  
  レスポンスを送信します。

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

<comment>See Also:</comment>
   * Yaf_Response_Abstract::setBody
   * Yaf_Response_Abstract::clearBody


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

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


id: Yaf_Response_Abstract::setBody
type: function
doc:
<comment>Description:</comment>
  コンテンツをレスポンスに設定する
  
  コンテンツをレスポンスに設定します。

<comment>Param:</comment>
  <info></info>        <strong>$body</strong>  コンテンツ文字列。
  <info>string</info>  <strong>$key</strong>   コンテンツのキー。キーを指定しない場合は、 Yaf_Response_Abstract::DEFAULT_BODY を使
                 います。  このパラメータは 2.2.0 で導入されました。
                 
                 このパラメータは 2.2.0 で導入されました。

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

<comment>See Also:</comment>
   * Yaf_Response_Abstract::getBody
   * Yaf_Response_Abstract::appendBody
   * Yaf_Response_Abstract::prependBody
   * Yaf_Response_Abstract::clearBody


id: Yaf_Response_Abstract::setHeader
type: function
doc:
<comment>Description:</comment>
  レスポンスヘッダを設定する
  
  HTTPヘッダを送信するのに使います。

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

<comment>See Also:</comment>
   * Yaf_Response_Abstract::getHeader
   * Yaf_Response_Abstract::cleanHeaders


id: Yaf_Response_Abstract::setRedirect
type: function
doc:
<comment>Description:</comment>
  The setRedirect purpose

<comment>Param:</comment>
  <info>string</info>  <strong>$url</strong>  リダイレクト先のアドレス。

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


id: Yaf_Route_Interface
type: class
doc:
<comment>Description:</comment>
  <class>Yaf_Route_Interface</class> を使うと、開発者がカスタムルートを定義できるようになります。


id: Yaf_Route_Interface::assemble
type: function
doc:
<comment>Description:</comment>
  リクエストを組み立てる
  
  このメソッドは引数 info に対応するURLを返します。 そして、引数 query によってURLにクエリストリング
  を追加します。
  
  Route は自分のルーティングのルールに基づいてこのメソッドを実装すべきですし、 逆の処理も行うべきで
  す。

<comment>Param:</comment>
  <info>array</info>  <strong>$info</strong>   
  <info>array</info>  <strong>$query</strong>  

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


id: Yaf_Route_Interface::route
type: function
doc:
<comment>Description:</comment>
  リクエストをルーティングする
  
  Yaf_Route_Interface::route は、ルーターを自作するときに唯一実装する必要のあるメソッドです。  2.3.0
  以降では、実装すべきメソッドがひとつ増えました。 Yaf_Route_Interface::assemble を参照ください。
  
  2.3.0 以降では、実装すべきメソッドがひとつ増えました。 Yaf_Route_Interface::assemble を参照くださ
  い。
  
  このメソッドが <info>true</info> を返せば、そこでルーティングが終わります。それ以外の場合は <class>Yaf_Router</class> はルート
  スタックの次のルーターにリクエストを転送します。
  
  このメソッドは、 Yaf_Request_Abstract::setControllerName、 Yaf_Request_Abstract::setActionName お
  よび Yaf_Request_Abstract::setModuleName を使って ルーティング結果を request に設定します。
  
  リクエストをルーティングしたことを示すため、このメソッドは最後に Yaf_Request_Abstract::setRouted
  を呼ぶ必要があります。

<comment>Param:</comment>
  <info>Yaf_Request_Abstract</info>  <strong>$request</strong>  <class>Yaf_Request_Abstract</class> のインスタンスを返します。

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


id: Yaf_Route_Map
type: class
doc:
<comment>Description:</comment>
  <class>Yaf_Route_Map</class> は標準で組み込まれているルートです。 単純に URI エンドポイント (URI の中で、ベース
  URL の後に続く部分。 Yaf_Request_Abstract::setBaseUri を参照ください) をコントローラ名やアクション
  名に変換します (どちらになるかは Yaf_Route_Map::__construct に渡すパラメータで決まります)。 その規
  則は次のとおりです。 A =&gt; controller A. A/B/C =&gt; controller A_B_C. A/B/C/D/E =&gt;
  controller A_B_C_D_E.
  
  Yaf_Route_Map::__construct の二番目のパラメータを指定すると、 URI の中でデリミタより前の部分だけを
  使ってルーティングを行います。 デリミタ以降の部分は、ルーティングリクエストのパラメータとして使い
  ます (Yaf_Route_Map::__construct のサンプルを参照ください)。


id: Yaf_Route_Map::__construct
type: function
doc:
<comment>Description:</comment>
  The __construct purpose

<comment>Param:</comment>
  <info>string</info>  <strong>$controller_prefer</strong>  結果をコントローラとみなすかアクションとみなすか。
  <info>string</info>  <strong>$delimiter</strong>          

<comment>See Also:</comment>
   * Yaf_Router::addRoute
   * <class>Yaf_Route_Static</class>
   * <class>Yaf_Route_Supervar</class>
   * <class>Yaf_Route_Simple</class>
   * <class>Yaf_Route_Regex</class>
   * <class>Yaf_Route_Rewrite</class>


id: Yaf_Route_Map::assemble
type: function
doc:
<comment>Description:</comment>
  URLを組み立てる
  
  URLを組み立てます。

<comment>Param:</comment>
  <info>array</info>  <strong>$info</strong>   
  <info>array</info>  <strong>$query</strong>  

<comment>Return:</comment>
  <info>string</info>  成功時に文字列を、 失敗時に <info>null</info> を返します。


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

<comment>Param:</comment>
  <info>Yaf_Request_Abstract</info>  <strong>$request</strong>  

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


id: Yaf_Route_Regex
type: class
doc:
<comment>Description:</comment>
  <class>Yaf_Route_Regex</class> は、 Yaf の組み込みのルートのなかでも一番柔軟性の高いものです。


id: Yaf_Route_Regex::__construct
type: function
doc:
<comment>Description:</comment>
  Yaf_Route_Regex のコンストラクタ

<comment>Param:</comment>
  <info>string</info>  <strong>$match</strong>    正規表現のパターン。リクエストの URI とマッチさせます。 もしマッチしなければ
                    <class>Yaf_Route_Regex</class> は <info>false</info> を返します。
  <info>array</info>   <strong>$route</strong>    リクエスト URI がパターンにマッチしたときに、 <class>Yaf_Route_Regex</class> はこれを使ってルー
                    ティング先を判断します。
                    
                    この配列で指定するモジュール、コントローラ、アクションはすべて任意指定で、 値を
                    省略したときにはデフォルト設定を利用します。
  <info>array</info>   <strong>$map</strong>      マッチした結果に代入する名前の配列。
  <info>array</info>   <strong>$verify</strong>   
  <info>string</info>  <strong>$reverse</strong>  URL を組み立てるときに使う文字列。 Yaf_Route_Regex::assemble を参照ください。
                    このパラメータは 2.3.0 で導入されました。
                    
                    このパラメータは 2.3.0 で導入されました。

<comment>See Also:</comment>
   * Yaf_Router::addRoute
   * Yaf_Router::addConfig
   * <class>Yaf_Route_Static</class>
   * <class>Yaf_Route_Supervar</class>
   * <class>Yaf_Route_Simple</class>
   * <class>Yaf_Route_Rewrite</class>
   * <class>Yaf_Route_Map</class>


id: Yaf_Route_Regex::assemble
type: function
doc:
<comment>Description:</comment>
  URL を組み立てる
  
  URL を組み立てます。

<comment>Param:</comment>
  <info>array</info>  <strong>$info</strong>   
  <info>array</info>  <strong>$query</strong>  

<comment>Return:</comment>
  <info>string|null</info>  成功時に文字列を返します。 失敗時に <info>null</info> を返します。


id: Yaf_Route_Regex::route
type: function
doc:
<comment>Description:</comment>
  The route purpose
  
  リクエストをルーティングします。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>Yaf_Request_Abstract</info>  <strong>$request</strong>  

<comment>Return:</comment>
  <info>bool</info>  Yaf_Route_Regex::_construct の引数で指定したパターンにリクエスト URI がマッチした場合に
        <info>true</info>、 それ以外の場合に <info>false</info> を返します。


id: Yaf_Route_Rewrite::__construct
type: function
doc:
<comment>Description:</comment>
  Yaf_Route_Rewrite のコンストラクタ

<comment>Param:</comment>
  <info>string</info>  <strong>$match</strong>   リクエストの URI とマッチさせるパターン。 もしマッチしなければ <class>Yaf_Route_Rewrite</class>
                   は <info>false</info> を返します。
                   
                   :name 形式を使って、マッチしたセグメントに名前を付けることができます。 また、* で
                   残りの URL セグメントにマッチさせられます。
  <info>array</info>   <strong>$route</strong>   リクエスト URI がパターンにマッチしたときに、 <class>Yaf_Route_Rewrite</class> はこれを使って
                   ルーティング先のモジュール、コントローラ、アクションを判断します。
                   
                   この配列で指定するモジュール、コントローラ、アクションはすべて任意指定で、 値を省
                   略したときにはデフォルト設定を利用します。
  <info>array</info>   <strong>$verify</strong>  

<comment>See Also:</comment>
   * Yaf_Router::addRoute
   * Yaf_Router::addConfig
   * <class>Yaf_Route_Static</class>
   * <class>Yaf_Route_Supervar</class>
   * <class>Yaf_Route_Simple</class>
   * <class>Yaf_Route_Regex</class>
   * <class>Yaf_Route_Map</class>


id: Yaf_Route_Rewrite::assemble
type: function
doc:
<comment>Description:</comment>
  URLを組み立てる
  
  URLを組み立てます。

<comment>Param:</comment>
  <info>array</info>  <strong>$info</strong>   
  <info>array</info>  <strong>$query</strong>  

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


id: Yaf_Route_Rewrite::route
type: function
doc:
<comment>Description:</comment>
  The route purpose

<comment>Param:</comment>
  <info>Yaf_Request_Abstract</info>  <strong>$request</strong>  

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


id: Yaf_Route_Simple
type: class
doc:
<comment>Description:</comment>
  <class>Yaf_Route_Simple</class> は、クエリ文字列を見てルート情報を取得します。
  
  <class>Yaf_Route_Simple</class> に対して必要な設定は、 $_GET のどのキーがモジュールでどのキーがコントローラ、 そ
  してどのキーがアクションなのかを指定することです。
  
  Yaf_Route_Simple::route は常に <info>true</info> を返します。 そこで、<class>Yaf_Route_Simple</class> はルートスタックの先頭に
  置く必要があります。 そうしないと、他のルートは決して呼ばれなくなります。


id: Yaf_Route_Simple::__construct
type: function
doc:
<comment>Description:</comment>
  Yaf_Route_Simple のコンストラクタ
  
  <class>Yaf_Route_Simple</class> は、クエリストリングからルーティング情報を取得します。 そして、このコンストラクタ
  のパラメータは $_GET の中にあるルーティング情報を検索するキーとして使われます。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>string</info>  <strong>$module_name</strong>      モジュール情報のキー名
  <info>string</info>  <strong>$controller_name</strong>  コントローラー情報のキー名
  <info>string</info>  <strong>$action_name</strong>      アクション情報のキー名

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

<comment>See Also:</comment>
   * Yaf_Route_Supervar::route
   * Yaf_Route_Static::route
   * Yaf_Route_Regex::route
   * Yaf_Route_Rewrite::route
   * Yaf_Route_Map::route


id: Yaf_Route_Simple::route
type: function
doc:
<comment>Description:</comment>
  リクエストをルーティングする
  
  see Yaf_Route_Simple::__construct
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>Yaf_Request_Abstract</info>  <strong>$request</strong>  

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

<comment>See Also:</comment>
   * Yaf_Route_Supervar::route
   * Yaf_Route_Static::route
   * Yaf_Route_Regex::route
   * Yaf_Route_Rewrite::route
   * Yaf_Route_Map::route


id: Yaf_Route_Static
type: class
doc:
<comment>Description:</comment>
  デフォルトでは、<class>Yaf_Router</class> が持っているルートは <class>Yaf_Route_Static</class> だけです。
  
  <class>Yaf_Route_Static</class> は、 要件の 80% を満たせるように作られています。
  
  <class>Yaf_Route_Static</class> のインスタンスを作る必要はありません。 また、<class>Yaf_Router</class> のルートスタックに追加す
  る必要もありません。 というのもこのクラスは常に <class>Yaf_Router</class> のルートスタックに含まれており、最後に
  呼ばれるようになっているからです。


id: Yaf_Route_Static::assemble
type: function
doc:
<comment>Description:</comment>
  URL を組み立てる
  
  URL を組み立てます。

<comment>Param:</comment>
  <info>array</info>  <strong>$info</strong>   
  <info>array</info>  <strong>$query</strong>  

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


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

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

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


id: Yaf_Route_Static::route
type: function
doc:
<comment>Description:</comment>
  リクエストをルーティングする
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>Yaf_Request_Abstract</info>  <strong>$request</strong>  

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

<comment>See Also:</comment>
   * Yaf_Route_Supervar::route
   * Yaf_Route_Simple::route
   * Yaf_Route_Regex::route
   * Yaf_Route_Rewrite::route
   * Yaf_Route_Map::route


id: Yaf_Route_Supervar::__construct
type: function
doc:
<comment>Description:</comment>
  The __construct purpose
  
  <class>Yaf_Route_Supervar</class> は <class>Yaf_Route_Static</class> と似ています。違うところは、 <class>Yaf_Route_Supervar</class> がクエリ文
  字列からパス情報を探すところです。 パラメータ supervar_name がキーとなります。

<comment>Param:</comment>
  <info>string</info>  <strong>$supervar_name</strong>  キーの名前。

<comment>See Also:</comment>
   * Yaf_Router::addRoute
   * Yaf_Router::addConfig
   * <class>Yaf_Route_Static</class>
   * <class>Yaf_Route_Regex</class>
   * <class>Yaf_Route_Simple</class>
   * <class>Yaf_Route_Rewrite</class>
   * <class>Yaf_Route_Map</class>


id: Yaf_Route_Supervar::assemble
type: function
doc:
<comment>Description:</comment>
  URL を組み立てる
  
  URL を組み立てます

<comment>Param:</comment>
  <info>array</info>  <strong>$info</strong>   
  <info>array</info>  <strong>$query</strong>  

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


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

<comment>Param:</comment>
  <info>Yaf_Request_Abstract</info>  <strong>$request</strong>  

<comment>Return:</comment>
  <info>bool</info>  Yaf_Route_Supervar::__construct で指定したキーが $_GET に存在すれば <info>true</info>、存在しなければ
        <info>false</info> を返します。


id: Yaf_Router
type: class
doc:
<comment>Description:</comment>
  <class>Yaf_Router</class> は、フレームワークの標準のルーターです。 ルーティングとは、URI エンドポイント (URI の中
  で、ベース URL の後に続く部分。 Yaf_Request_Abstract::setBaseUri を参照ください) を受け取ってそこ
  からパラメータを抽出し、 リクエストを受け取るモジュールやコントローラそしてアクションを判断する処
  理のことです。 モジュール、コントローラ、アクション、そしてその他のパラメータは
  <class>Yaf_Request_Abstract</class> オブジェクトにまとめられ、 そして <class>Yaf_Dispatcher</class> で処理します。 ルーティング
  が行われるのは一度だけで、リクエストを最初に受け取ってから 最初のコントローラにディスパッチする前
  に行われます。
   <class>Yaf_Router</class> は、mod_rewrite 風の機能を PHP を使って実現できるような設計になっています。 Ruby on
  Rails のルーティング方式を参考にしており、 ウェブサーバーの URL リライト機能に関する事前知識は不要
  です。 Apache の場合は、次のような mod_rewrite ルールを書けば使えます。 Apache 用のリライトルール
  あるいは、次のようにもできます (こちらのほうを推奨します)。 Apache 用のリライトルール Lighttpd の
  場合は、次のようなリライトルールを指定します。 Lighttpd 用のリライトルール "/index.php?$1",
  ".*\.(js|ico|gif|jpg|png|css|html)$" => "$0", "" => "/index.php"
  )
  ]]> Nginx の場合は、次のようなリライトルールを指定します。 Nginx 用のリライトルール


id: Yaf_Router::addConfig
type: function
doc:
<comment>Description:</comment>
  設定で定義したルートをルーターに追加する
  
  設定で定義したルートを <class>Yaf_Router</class> のスタックに追加します。

<comment>Return:</comment>
  <info>bool</info>  <class>Yaf_Config_Abstract</class> のインスタンスを返します。 ここには有効なルート設定が含まれています。

<comment>See Also:</comment>
   * Yaf_Router::addRoute
   * <class>Yaf_Route_Static</class>
   * <class>Yaf_Route_Supervar</class>
   * <class>Yaf_Route_Simple</class>
   * <class>Yaf_Route_Regex</class>
   * <class>Yaf_Route_Rewrite</class>
   * <class>Yaf_Route_Map</class>


id: Yaf_Router::addRoute
type: function
doc:
<comment>Description:</comment>
  新しいルートをルーターに追加する
  
  Yaf_Router はデフォルトのルートとして <class>Yaf_Route_Static</class> を使います。ルーターのルートスタックにそれ
  以外のルートを追加するときに、このメソッドを使います。
  
  ルートスタックに後から追加したルートのほうが先に呼ばれます。 どれかひとつのルーターが <info>true</info> を返せ
  ば、そこでルーティングが終わります。それ以外の場合は 次のルーターを呼びます。

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

<comment>See Also:</comment>
   * Yaf_Router::addConfig
   * <class>Yaf_Route_Static</class>
   * <class>Yaf_Route_Supervar</class>
   * <class>Yaf_Route_Simple</class>
   * <class>Yaf_Route_Regex</class>
   * <class>Yaf_Route_Rewrite</class>
   * <class>Yaf_Route_Map</class>


id: Yaf_Router::getCurrentRoute
type: function
doc:
<comment>Description:</comment>
  使われているルート名を取得する
  
  ルーティングプロセスで使われているルート名を取得します。  このメソッドはルーティングが終わってから
  呼ぶ必要があります。 終わる前に呼ぶと、常に <info>null</info> を返します。
  
  このメソッドはルーティングが終わってから呼ぶ必要があります。 終わる前に呼ぶと、常に <info>null</info> を返しま
  す。

<comment>Return:</comment>
  <info>string</info>  ルート名を文字列で返します。

<comment>See Also:</comment>
   * <class>Yaf_Bootstrap_Abstract</class>
   * <class>Yaf_Plugin_Abstract</class>
   * Yaf_Router::addRoute


id: Yaf_Router::getRoute
type: function
doc:
<comment>Description:</comment>
  名前を指定してルートを取得する
  
  名前を指定してルートを取得します。 Yaf_Router::getCurrentRoute も参照ください。

<comment>Return:</comment>
  <info>Yaf_Route_Interface</info>  

<comment>See Also:</comment>
   * <class>Yaf_Bootstrap_Abstract</class>
   * <class>Yaf_Plugin_Abstract</class>
   * Yaf_Router::addRoute
   * Yaf_Router::getCurrentRoute


id: Yaf_Router::getRoutes
type: function
doc:
<comment>Description:</comment>
  登録済みのルートを取得する
  
  登録済みのルートを取得します。

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


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

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


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


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

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

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


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

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

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


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

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

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


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

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


id: Yaf_View_Interface
type: class
doc:
<comment>Description:</comment>
  Yaf では、組み込みのビューエンジン <class>Yaf_View_Simple</class> のかわりにカスタムビューを自作できるようになっ
  ています。 その実例は、 Yaf_Dispatcher::setView を参照ください。


id: Yaf_View_Interface::assign
type: function
doc:
<comment>Description:</comment>
  値をビューエンジンに代入する
  
  値をビューエンジンに代入します。これで、テンプレートから名前を指定してその値にアクセスできるように
  なります。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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

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


id: Yaf_View_Interface::display
type: function
doc:
<comment>Description:</comment>
  テンプレートをレンダリングして出力する
  
  テンプレートをレンダリングし、結果をすぐに出力します。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>string</info>  <strong>$tpl</strong>       
  <info>array</info>   <strong>$tpl_vars</strong>  

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


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

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


id: Yaf_View_Interface::render
type: function
doc:
<comment>Description:</comment>
  テンプレートをレンダリングする
  
  テンプレートをレンダリングし、結果を返します。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>string</info>  <strong>$tpl</strong>       
  <info>array</info>   <strong>$tpl_vars</strong>  

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


id: Yaf_View_Interface::setScriptPath
type: function
doc:
<comment>Description:</comment>
  The setScriptPath purpose
  
  テンプレートのベースディレクトリを設定します。これは通常、 <class>Yaf_Dispatcher</class> から呼ばれます。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>string</info>  <strong>$template_dir</strong>  テンプレートディレクトリへの絶対パス。デフォルトは application.directory .
                         "/views" です。

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


id: Yaf_View_Simple
type: class
doc:
<comment>Description:</comment>
  <class>Yaf_View_Simple</class> は Yaf の組み込みテンプレートエンジンです。 シンプルながらも高速なテンプレートエン
  ジンで、PHP スクリプトテンプレートだけに対応しています。


id: Yaf_View_Simple::__construct
type: function
doc:
<comment>Description:</comment>
  Yaf_View_Simple のコンストラクタ

<comment>Param:</comment>
  <info>string</info>  <strong>$template_dir</strong>  テンプレートのベースディレクトリ。デフォルトは APPLICATOIN . "/views" で
                         す。
  <info>array</info>   <strong>$options</strong>       


id: Yaf_View_Simple::__get
type: function
doc:
<comment>Description:</comment>
  Retrieve assigned variable
  
  代入した変数を取得します。  2.1.11 からは、パラメータを空にできます。 
  
  2.1.11 からは、パラメータを空にできます。

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  代入した変数名。
                 
                 空にすると、すべての変数を返します。

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


id: Yaf_View_Simple::__isset
type: function
doc:
<comment>Description:</comment>
  The __isset purpose

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

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


id: Yaf_View_Simple::__set
type: function
doc:
<comment>Description:</comment>
  値をエンジンに設定する
  
  Yaf_View_Simple::assign をもっと簡単にするもうひとつの方法です。

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

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

<comment>See Also:</comment>
   * Yaf_View_Simple::assignRef
   * Yaf_View_Interface::assign


id: Yaf_View_Simple::assign
type: function
doc:
<comment>Description:</comment>
  値を代入する
  
  変数をビューエンジンに代入します。

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>   文字列あるいは配列。
                  
                  文字列の場合は、次の引数 $value が必須となります。
  <info>mixed</info>   <strong>$value</strong>  代入する値。

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

<comment>See Also:</comment>
   * Yaf_View_Simple::assignRef
   * Yaf_View_Interface::clear
   * Yaf_View_Simple::__set


id: Yaf_View_Simple::assignRef
type: function
doc:
<comment>Description:</comment>
  The assignRef purpose
  
  Yaf_View_Simple::assign とは異なり、 このメソッドは参照で値をエンジンに代入します。

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>   テンプレート内でのアクセスに使う名前。
  <info>mixed</info>   <strong>$value</strong>  代入する値。

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

<comment>See Also:</comment>
   * Yaf_View_Simple::assign
   * Yaf_View_Simple::__set


id: Yaf_View_Simple::clear
type: function
doc:
<comment>Description:</comment>
  代入した値をクリアする
  
  代入した値をクリアします。

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  代入した変数名。
                 
                 空の場合は、すべての変数をクリアします。

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

<comment>See Also:</comment>
   * Yaf_View_Simple::assignRef
   * Yaf_View_Interface::assign
   * Yaf_View_Simple::__set


id: Yaf_View_Simple::display
type: function
doc:
<comment>Description:</comment>
  レンダリングして表示する
  
  テンプレートをレンダリングして、結果をすぐに返します。

<comment>Param:</comment>
  <info>string</info>  <strong>$tpl</strong>       
  <info>array</info>   <strong>$tpl_vars</strong>  

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


id: Yaf_View_Simple::eval
type: function
doc:
<comment>Description:</comment>
  テンプレートをレンダリングする
  
  文字列のテンプレートをレンダリングして結果を返します。

<comment>Param:</comment>
  <info>string</info>  <strong>$tpl_content</strong>  文字列のテンプレート。
  <info>array</info>   <strong>$tpl_vars</strong>     

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


id: Yaf_View_Simple::getScriptPath
type: function
doc:
<comment>Description:</comment>
  テンプレートのディレクトリを取得する

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


id: Yaf_View_Simple::render
type: function
doc:
<comment>Description:</comment>
  テンプレートをレンダリングする
  
  テンプレートをレンダリングして、結果を返します。

<comment>Param:</comment>
  <info>string</info>  <strong>$tpl</strong>       
  <info>array</info>   <strong>$tpl_vars</strong>  

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


id: Yaf_View_Simple::setScriptPath
type: function
doc:
<comment>Description:</comment>
  テンプレートのディレクトリを設定する

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

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


id: Yar_Client::__call
type: function
doc:
<comment>Description:</comment>
  Call service
  
  Issue a call to remote RPC method.

<comment>Param:</comment>
  <info>string</info>  <strong>$method</strong>      Remote RPC method name.
  <info>array</info>   <strong>$parameters</strong>  Parameters.

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

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


id: Yar_Client::__construct
type: function
doc:
<comment>Description:</comment>
  Create a client
  
  Create a <class>Yar_Client</class> to a <class>Yar_Server</class>.

<comment>Param:</comment>
  <info>string</info>  <strong>$url</strong>  Yar Server URL.

<comment>Return:</comment>
  <info>unknown</info>  <class>Yar_Client</class> instance.

<comment>See Also:</comment>
   * Yar_Client::__call
   * Yar_Client::setOpt


id: Yar_Client::setOpt
type: function
doc:
<comment>Description:</comment>
  Set calling contexts

<comment>Param:</comment>
  <info>int</info>    <strong>$name</strong>   it can be: <info>YAR_OPT_PACKAGER</info>, <info>YAR_OPT_PERSISTENT</info> (Need server support),
                 <info>YAR_OPT_TIMEOUT</info>, <info>YAR_OPT_CONNECT_TIMEOUT</info>, <info>YAR_OPT_HEADER</info> (as of 2.0.4),
                 <info>YAR_OPT_PROXY</info> (as of 2.2.0)
  <info>mixed</info>  <strong>$value</strong>  

<comment>Return:</comment>
  <info>Yar_Client|false</info>  Returns $this on success失敗した場合に <info>false</info> を返します.

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


id: Yar_Client_Exception::getType
type: function
doc:
<comment>Description:</comment>
  Retrieve exception's type

<comment>Return:</comment>
  <info>string</info>  Returns <return>"Yar_Exception_Client"</return>.

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


id: Yar_Concurrent_Client::call
type: function
doc:
<comment>Description:</comment>
  Register a concurrent call
  
  Register a RPC call, but won't sent it immediately, it will be send while further call to
  Yar_Concurrent_Client::loop

<comment>Param:</comment>
  <info>string</info>    <strong>$uri</strong>         The RPC server URI(http, tcp)
  <info>string</info>    <strong>$method</strong>      Service name(aka the method name)
  <info>array</info>     <strong>$parameters</strong>  Parameters
  <info>callable</info>  <strong>$callback</strong>    A function callback, which will be called while the response return.

<comment>Return:</comment>
  <info>int</info>  An unique id, can be used to identified which call it is.

<comment>See Also:</comment>
   * Yar_Concurrent_Client::loop
   * Yar_Concurrent_Client::reset
   * Yar_Server::__construct
   * Yar_Server::handle


id: Yar_Concurrent_Client::loop
type: function
doc:
<comment>Description:</comment>
  Send all calls
  
  Send all registed remote RPC calls.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>        If this callback is set, then Yar will call this callback after all
                             calls are sent and before any response return, with a $callinfo NULL.
                             
                             Then, if user didn't specify callback when registering concurrent call,
                             this callback will be used to handle response, otherwise, the callback
                             specified while registering will be used.
  <info>callable</info>  <strong>$error_callback</strong>  If this callback is set, then Yar will call this callback while error
                             occurred.

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

<comment>See Also:</comment>
   * Yar_Concurrent_Client::call
   * Yar_Concurrent_Client::reset
   * Yar_Server::__construct
   * Yar_Server::handle


id: Yar_Concurrent_Client::reset
type: function
doc:
<comment>Description:</comment>
  Clean all registered calls
  
  Clean all registered calls

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

<comment>See Also:</comment>
   * Yar_Concurrent_Client::call
   * Yar_Concurrent_Client::loop
   * Yar_Server::__construct
   * Yar_Server::handle


id: Yar_Server::__construct
type: function
doc:
<comment>Description:</comment>
  Register a server
  
  Set up a Yar HTTP RPC Server, All the public methods of $obj will be register as a RPC service.

<comment>Param:</comment>
  <info>Object</info>  <strong>$obj</strong>  An Object, all public methods of its will be registered as RPC services.

<comment>Return:</comment>
  <info>unknown</info>  An instance of <class>Yar_Server</class>.

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


id: Yar_Server::handle
type: function
doc:
<comment>Description:</comment>
  Start RPC Server
  
  Start a RPC HTTP server, and ready for accpet RPC requests.  Usual RPC calls will be issued as
  HTTP POST requests. If a HTTP GET request is issued to the uri, the service information (commented
  section above) will be printed on the page
  
  Usual RPC calls will be issued as HTTP POST requests. If a HTTP GET request is issued to the uri,
  the service information (commented section above) will be printed on the page

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

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


id: Yar_Server_Exception
type: class
doc:
<comment>Description:</comment>
  If service threw exceptions, A Yar_Server_Exception will be threw in client side.


id: Yar_Server_Exception::getType
type: function
doc:
<comment>Description:</comment>
  Retrieve exception's type
  
  Get the exception original type threw by server

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

<comment>See Also:</comment>
   * 


id: ZEND_ACC_CLASS
type: constant
doc:
<comment>Description:</comment>
  Dummy registered for consistency, the default kind of class entry. Removed as of uopz 5.0.0.


id: ZEND_ADD_INTERFACE
type: constant
doc:
<comment>Description:</comment>
  Invoked upon composure, receives the class the interface is being added to as the first argument,
  and the name of the interface as the second argument


id: ZEND_ADD_TRAIT
type: constant
doc:
<comment>Description:</comment>
  Invoked upon composure, receives the class the trait is being added to as the first argument, and
  the name of the trait as the second argument


id: ZEND_EXIT
type: constant
doc:
<comment>Description:</comment>
  Invoked by exit() and die(), receives no arguments. Return boolean <info>true</info> to exit, <info>false</info> to continue


id: ZEND_FETCH_CLASS
type: constant
doc:
<comment>Description:</comment>
  Invoked upon composure, receives the class the name of the class being fetched as the only
  argument


id: ZEND_INSTANCEOF
type: constant
doc:
<comment>Description:</comment>
  Invoked by instanceof operator, receives the object being verified as the first argument, and the
  name of the class which that object should be as the second argument


id: ZEND_NEW
type: constant
doc:
<comment>Description:</comment>
  Invoked by object construction, receives the class of object being created as the only argument


id: ZEND_THROW
type: constant
doc:
<comment>Description:</comment>
  Invoked by the throw construct, receives the class of exception being thrown as the only argument


id: ZMQ::CTXOPT_MAX_SOCKETS
type: constant
doc:
<comment>Description:</comment>
  The socket limit for this context. Available if compiled against ZeroMQ 3.x or higher (Value: <info>int</info>)


id: ZMQ::ERR_EAGAIN
type: constant
doc:
<comment>Description:</comment>
  Implies that the operation would block when ZMQ::MODE_DONTWAIT is used


id: ZMQ::ERR_EFSM
type: constant
doc:
<comment>Description:</comment>
  The operation can not be executed because the socket is not in correct state


id: ZMQ::MODE_NOBLOCK
type: constant
doc:
<comment>Description:</comment>
  Non-blocking operation. Deprecated, use ZMQ::MODE_DONTWAIT instead


id: ZMQ::SOCKET_STREAM
type: constant
doc:
<comment>Description:</comment>
  Used to send and receive TCP data from a non-ØMQ peer. Available if compiled against ZeroMQ 4.x or
  higher (Value: <info>int</info>).


id: ZMQ::SOCKET_XPUB
type: constant
doc:
<comment>Description:</comment>
  Similar to SOCKET_PUB, except you can receive subscriptions as messages. The subscription message
  is 0 (unsubscribe) or 1 (subscribe) followed by the topic.


id: ZMQ::SOCKET_XSUB
type: constant
doc:
<comment>Description:</comment>
  Similar to SOCKET_SUB, except you can send subscriptions as messages. See SOCKET_XPUB for format.


id: ZMQ::SOCKOPT_BACKLOG
type: constant
doc:
<comment>Description:</comment>
  The SOCKOPT_BACKLOG option shall set the maximum length of the queue of outstanding peer
  connections for the specified socket; this only applies to connection-oriented transports. (Value:
  <info>int</info>)


id: ZMQ::SOCKOPT_DELAY_ATTACH_ON_CONNECT
type: constant
doc:
<comment>Description:</comment>
  Set a CIDR string to match against incoming TCP connections. Available if compiled against ZeroMQ
  3.x or higher (Value: <info>string</info>)


id: ZMQ::SOCKOPT_HWM
type: constant
doc:
<comment>Description:</comment>
  The high water mark for inbound and outbound messages is a hard limit on the maximum number of
  outstanding messages ØMQ shall queue in memory for any single peer that the specified socket is
  communicating with. Setting this option on a socket will only affect connections made after the
  option has been set. On ZeroMQ 3.x this is a wrapper for setting both SNDHWM and RCVHWM. (Value:
  <info>int</info>).


id: ZMQ::SOCKOPT_IPV4ONLY
type: constant
doc:
<comment>Description:</comment>
  Disable IPV6 support if 1. Available if compiled against ZeroMQ 3.x (Value: <info>int</info>)


id: ZMQ::SOCKOPT_IPV6
type: constant
doc:
<comment>Description:</comment>
  Enable IPV6. Available if compiled against ZeroMQ 4.0 or higher (Value: <info>string</info>)


id: ZMQ::SOCKOPT_LAST_ENDPOINT
type: constant
doc:
<comment>Description:</comment>
  Retrieve the last connected endpoint - for use with * wildcard ports. Available if compiled
  against ZeroMQ 3.x or higher (Value: <info>string</info>)


id: ZMQ::SOCKOPT_LINGER
type: constant
doc:
<comment>Description:</comment>
  The linger value of the socket. Specifies how long the socket blocks trying flush messages after
  it has been closed (Value: <info>int</info>)


id: ZMQ::SOCKOPT_MAXMSGSIZE
type: constant
doc:
<comment>Description:</comment>
  Limits the maximum size of the inbound message. Value -1 means no limit. Available if compiled
  against ZeroMQ 3.x or higher (Value: <info>int</info>)


id: ZMQ::SOCKOPT_RATE
type: constant
doc:
<comment>Description:</comment>
  Set rate for multicast sockets (pgm) (Value: <info>int</info> &gt;= 0)


id: ZMQ::SOCKOPT_RCVHWM
type: constant
doc:
<comment>Description:</comment>
  The SOCKOPT_RCVHWM option shall set the high water mark for inbound messages on the specified
  socket. Available if compiled against ZeroMQ 3.x or higher (Value: <info>int</info>).


id: ZMQ::SOCKOPT_RCVTIMEO
type: constant
doc:
<comment>Description:</comment>
  Sets the timeout for receive operation on the socket. Value -1 means no limit. Available if
  compiled against ZeroMQ 3.x or higher (Value: <info>int</info>)


id: ZMQ::SOCKOPT_RECONNECT_IVL
type: constant
doc:
<comment>Description:</comment>
  Set the initial reconnection interval (Value: <info>int</info> &gt;= 0)


id: ZMQ::SOCKOPT_RECONNECT_IVL_MAX
type: constant
doc:
<comment>Description:</comment>
  Set the max reconnection interval (Value: <info>int</info> &gt;= 0)


id: ZMQ::SOCKOPT_RECOVERY_IVL
type: constant
doc:
<comment>Description:</comment>
  Set multicast recovery interval (Value: <info>int</info> &gt;= 0)


id: ZMQ::SOCKOPT_ROUTER_RAW
type: constant
doc:
<comment>Description:</comment>
  Sets the raw mode on the ROUTER, when set to 1. In raw mode when using tcp:// transport the socket
  will read and write without ZeroMQ framing. Available if compiled against ZeroMQ 4.0 or higher
  (Value: <info>string</info>)


id: ZMQ::SOCKOPT_SNDBUF
type: constant
doc:
<comment>Description:</comment>
  Set kernel transmit buffer size (Value: <info>int</info> &gt;= 0)


id: ZMQ::SOCKOPT_SNDHWM
type: constant
doc:
<comment>Description:</comment>
  The ZMQ_SNDHWM option shall set the high water mark for outbound messages on the specified socket.
  Available if compiled against ZeroMQ 3.x or higher (Value: <info>int</info>).


id: ZMQ::SOCKOPT_SNDTIMEO
type: constant
doc:
<comment>Description:</comment>
  Sets the timeout for send operation on the socket. Value -1 means no limit. Available if compiled
  against ZeroMQ 3.x or higher (Value: <info>int</info>)


id: ZMQ::SOCKOPT_SUBSCRIBE
type: constant
doc:
<comment>Description:</comment>
  Establish message filter. Valid for subscriber socket (Value: <info>string</info>)


id: ZMQ::SOCKOPT_TCP_KEEPALIVE_CNT
type: constant
doc:
<comment>Description:</comment>
  Count time for TCP keepalive. Available if compiled against ZeroMQ 3.x or higher (Value: <info>int</info>)


id: ZMQ::SOCKOPT_TCP_KEEPALIVE_IDLE
type: constant
doc:
<comment>Description:</comment>
  Idle time for TCP keepalive. Available if compiled against ZeroMQ 3.x or higher (Value: <info>int</info>)


id: ZMQ::SOCKOPT_TCP_KEEPALIVE_INTVL
type: constant
doc:
<comment>Description:</comment>
  Interval for TCP keepalive. Available if compiled against ZeroMQ 3.x or higher (Value: <info>int</info>)


id: ZMQ::SOCKOPT_TYPE
type: constant
doc:
<comment>Description:</comment>
  Get the socket type. Valid for getSockOpt (Value: <info>int</info>)


id: ZMQ::SOCKOPT_UNSUBSCRIBE
type: constant
doc:
<comment>Description:</comment>
  Remove message filter. Valid for subscriber socket (Value: <info>string</info>)


id: ZMQ::SOCKOPT_XPUB_VERBOSE
type: constant
doc:
<comment>Description:</comment>
  Set the XPUB to receive an application message on each instance of a subscription. Available if
  compiled against ZeroMQ 3.x or higher (Value: <info>string</info>)


id: ZMQ::__construct
type: function
doc:
<comment>Description:</comment>
  ZMQ constructor
  
  Private constructor to prevent direct initialization. This class holds the constants for ZMQ
  extension.


id: ZMQContext::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new ZMQContext object
  
  Constructs a new ZMQ context. The context is used to initialize sockets. A persistent context is
  required  to initialize persistent sockets.

<comment>Param:</comment>
  <info>int</info>   <strong>$io_threads</strong>     Number of io-threads in the context.
  <info>bool</info>  <strong>$is_persistent</strong>  Whether the context is persistent. Persistent context is stored over
                        multiple requests and is a requirement for persistent sockets.


id: ZMQContext::getOpt
type: function
doc:
<comment>Description:</comment>
  Get context option
  
  Returns the value of a context option.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>  An integer representing the option. See the <info>ZMQ::CTXOPT_*</info> constants.

<comment>Return:</comment>
  <info>mixed</info>  Returns either a <info>string</info> or an <info>int</info> depending on <strong>$key</strong>. Throws ZMQContextException on error.


id: ZMQContext::getSocket
type: function
doc:
<comment>Description:</comment>
  Create a new socket
  
  Shortcut for creating new sockets from the context. If the context is not persistent the
  <strong>$persistent_id</strong>  parameter is ignored and the socket falls back to being non-persistent. The
  <strong>$on_new_socket</strong> is called only when a new underlying socket structure is created.

<comment>Param:</comment>
  <info>int</info>       <strong>$type</strong>           <info>ZMQ::SOCKET_*</info> constant to specify socket type.
  <info>string</info>    <strong>$persistent_id</strong>  If <strong>$persistent_id</strong> is specified the socket will be persisted over
                            multiple requests.
  <info>callable</info>  <strong>$on_new_socket</strong>  Callback function, which is executed when a new socket structure is
                            created. This function does not get invoked if the underlying persistent
                            connection is re-used. The callback takes ZMQSocket and persistent_id as
                            two arguments.

<comment>Return:</comment>
  <info>ZMQSocket</info>  Returns a <class>ZMQSocket</class> object.


id: ZMQContext::isPersistent
type: function
doc:
<comment>Description:</comment>
  Whether the context is persistent
  
  Whether the context is persistent. Persistent context is needed for persistent connections as each
  socket is allocated from a context.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the context is persistent and <info>false</info> if the context is non-persistent.


id: ZMQContext::setOpt
type: function
doc:
<comment>Description:</comment>
  Set a socket option
  
  Sets a ZMQ context option. The type of the <strong>$value</strong> depends on the <strong>$key</strong>. See ZMQ Constant Types for
  more information.

<comment>Param:</comment>
  <info>int</info>    <strong>$key</strong>    One of the <info>ZMQ::CTXOPT_*</info> constants.
  <info>mixed</info>  <strong>$value</strong>  The value of the parameter.

<comment>Return:</comment>
  <info>ZMQContext</info>  Returns the current object. Throws ZMQContextException on error.


id: ZMQDevice::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new device
  
  "ØMQ devices can do intermediation of addresses, services, queues, or any other abstraction you
  care to define above the message and socket layers." -- zguide

<comment>Param:</comment>
  <info>ZMQSocket</info>  <strong>$frontend</strong>  Frontend parameter for the devices. Usually where there messages are coming.
  <info>ZMQSocket</info>  <strong>$backend</strong>   Backend parameter for the devices. Usually where there messages going to.
  <info>ZMQSocket</info>  <strong>$listener</strong>  Listener socket, which receives a copy of all messages going both
                        directions. The type of this socket should be SUB, PULL or DEALER.

<comment>Return:</comment>
  <info>unknown</info>  Call to this method will prepare the device. Usually devices are very long running
           processes so running this method from interactive script is not recommended. This method
           throw ZMQDeviceException if the device cannot be started.


id: ZMQDevice::getIdleTimeout
type: function
doc:
<comment>Description:</comment>
  Get the idle timeout
  
  Gets the idle callback timeout value. Added in ZMQ extension version 1.1.0.

<comment>Return:</comment>
  <info>ZMQDevice</info>  This method returns the idle callback timeout value.


id: ZMQDevice::getTimerTimeout
type: function
doc:
<comment>Description:</comment>
  Get the timer timeout
  
  Gets the timer callback timeout value. Added in ZMQ extension version 1.1.0.

<comment>Return:</comment>
  <info>ZMQDevice</info>  This method returns the timer timeout value.


id: ZMQDevice::run
type: function
doc:
<comment>Description:</comment>
  Run the new device
  
  Runs the device.

<comment>Return:</comment>
  <info>void</info>  Call to this method will block until the device is running. It is not recommended that
        devices are used from interactive scripts. On failure this method will throw
        ZMQDeviceException.


id: ZMQDevice::setIdleCallback
type: function
doc:
<comment>Description:</comment>
  Set the idle callback function
  
  Sets the idle callback function. If idle timeout is defined the idle callback function shall be
  called if the internal poll loop times out without events. If the callback function returns false
  or a value that evaluates to false the device is stopped.
   The callback function signature is callback (mixed $user_data).

<comment>Param:</comment>
  <info>callable</info>  <strong>$cb_func</strong>    Callback function to invoke when the device is idle. Returning false or a
                        value that evaluates to false from this function will cause the  device to
                        stop.
  <info>int</info>       <strong>$timeout</strong>    How often to invoke the idle callback in milliseconds. The idle callback is
                        invoked periodically when there is no activity on the device. The timeout
                        value guarantees that there is at least this amount of milliseconds between
                        invocations of the callback function.
  <info>mixed</info>     <strong>$user_data</strong>  Additional data to pass to the callback function.

<comment>Return:</comment>
  <info>ZMQDevice</info>  On success this method returns the current object.


id: ZMQDevice::setIdleTimeout
type: function
doc:
<comment>Description:</comment>
  Set the idle timeout
  
  Sets the idle callback timeout value. The idle callback is invoked periodically when the device is
  idle.

<comment>Param:</comment>
  <info>int</info>  <strong>$timeout</strong>  The idle callback timeout value.

<comment>Return:</comment>
  <info>ZMQDevice</info>  On success this method returns the current object.


id: ZMQDevice::setTimerCallback
type: function
doc:
<comment>Description:</comment>
  Set the timer callback function
  
  Sets the timer callback function. The timer callback will be invoked after timeout has passed. The
  difference between idle and timer callbacks are that idle callback is invoked only when the device
  is idle.
   The callback function signature is callback (mixed $user_data). Added in ZMQ extension version
  1.1.0.

<comment>Param:</comment>
  <info>callable</info>  <strong>$cb_func</strong>    Callback function to invoke when the device is idle. Returning false or a
                        value that evaluates to false from this function will cause the  device to
                        stop.
  <info>int</info>       <strong>$timeout</strong>    How often to invoke the idle callback in milliseconds. The idle callback is
                        invoked periodically when there is no activity on the device. The timeout
                        value guarantees that there is at least this amount of milliseconds between
                        invocations of the callback function.
  <info>mixed</info>     <strong>$user_data</strong>  Additional data to pass to the callback function.

<comment>Return:</comment>
  <info>ZMQDevice</info>  On success this method returns the current object.


id: ZMQDevice::setTimerTimeout
type: function
doc:
<comment>Description:</comment>
  Set the timer timeout
  
  Sets the timer callback timeout value. The timer callback is invoked periodically if it's set.
  Added in ZMQ extension version 1.1.0.

<comment>Param:</comment>
  <info>int</info>  <strong>$timeout</strong>  The timer callback timeout value.

<comment>Return:</comment>
  <info>ZMQDevice</info>  On success this method returns the current object.


id: ZMQPoll::add
type: function
doc:
<comment>Description:</comment>
  Add item to the poll set
  
  Adds a new item to the poll set and returns the internal id of the added item. The item can be
  removed from the poll set using the returned string id.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$entry</strong>  ZMQSocket object or a PHP stream resource
  <info>int</info>    <strong>$type</strong>   Defines what activity the socket is polled for.  See <info>ZMQ::POLL_IN</info> and <info>ZMQ::POLL_OUT</info>
                 constants.

<comment>Return:</comment>
  <info>string</info>  Returns a string id of the added item which can be later used to remove the item.  Throws
          ZMQPollException on error.


id: ZMQPoll::clear
type: function
doc:
<comment>Description:</comment>
  Clear the poll set
  
  Clears all elements from the poll set.

<comment>Return:</comment>
  <info>ZMQPoll</info>  Returns the current object.


id: ZMQPoll::count
type: function
doc:
<comment>Description:</comment>
  Count items in the poll set
  
  Count the items in the poll set.

<comment>Return:</comment>
  <info>int</info>  Returns an <info>int</info> representing the amount of items in the poll set.


id: ZMQPoll::getLastErrors
type: function
doc:
<comment>Description:</comment>
  Get poll errors
  
  Returns the ids of the objects that had errors in the last poll.

<comment>Return:</comment>
  <info>array</info>  Returns an array containing ids for the items that had errors in the last poll. Empty array
         is  returned if there were no errors.


id: ZMQPoll::poll
type: function
doc:
<comment>Description:</comment>
  Poll the items
  
  Polls the items in the current poll set. The readable and writable items are returned in the
  <strong>$readable</strong> and <strong>$writable</strong> parameters.  <strong>ZMQPoll::getLastErrors()</strong> can be used to check if there were
  errors.

<comment>Param:</comment>
  <info>array</info>  <strong>$readable</strong>  Array where readable ZMQSockets/PHP streams are returned. The array will be
                    cleared at the beginning of the operation.
  <info>array</info>  <strong>$writable</strong>  Array where writable ZMQSockets/PHP streams are returned. The array will be
                    cleared at the beginning of the operation.
  <info>int</info>    <strong>$timeout</strong>   Timeout for the operation. -1 means that poll waits until at least one item has
                    activity. Please note that starting from  version 1.0.0 the poll timeout is
                    defined in milliseconds, rather than microseconds.

<comment>Return:</comment>
  <info>int</info>  Returns an integer representing the amount of items with activity.


id: ZMQPoll::remove
type: function
doc:
<comment>Description:</comment>
  Remove item from poll set
  
  Remove item from the poll set. The <strong>$item</strong> parameter can be ZMQSocket object, a stream resource or
  the id returned from <strong>ZMQPoll::add()</strong> method.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$item</strong>  The ZMQSocket object, PHP stream or <info>string</info> id of the item.

<comment>Return:</comment>
  <info>bool</info>  Returns true if the item was removed and false if the object  with given id does not exist
        in the poll set.


id: ZMQSocket::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new ZMQSocket
  
  Constructs a ZMQSocket object. <strong>$persistent_id</strong> parameter can be used to allocated a persistent
  socket. A persistent socket has to be allocated from a persistent context and it stays connected
  over multiple requests. The <strong>$persistent_id</strong> parameter can be used to recall the same socket over
  multiple requests. The      <strong>$on_new_socket</strong> is called only when a new underlying socket structure
  is created.

<comment>Param:</comment>
  <info>ZMQContext</info>  <strong>$context</strong>        ZMQContext object.
  <info>int</info>         <strong>$type</strong>           The socket type. See <info>ZMQ::SOCKET_*</info> constants.
  <info>string</info>      <strong>$persistent_id</strong>  If <strong>$persistent_id</strong> is specified the socket will be persisted over
                              multiple requests. If <strong>$context</strong> is not persistent the socket falls back
                              to non-persistent mode.
  <info>callable</info>    <strong>$on_new_socket</strong>  Callback function, which is executed when a new socket structure is
                              created. This function does not get invoked if the underlying
                              persistent connection is re-used.


id: ZMQSocket::bind
type: function
doc:
<comment>Description:</comment>
  Bind the socket
  
  Bind the socket to an endpoint. The endpoint is defined in format <return>transport://address</return> where
  transport is one of the following: inproc, ipc, tcp, pgm or epgm.

<comment>Param:</comment>
  <info>string</info>  <strong>$dsn</strong>    The bind dsn, for example <return>transport://address</return>.
  <info>bool</info>    <strong>$force</strong>  Tries to bind even if the socket has already been bound to the given endpoint.

<comment>Return:</comment>
  <info>ZMQSocket</info>  Returns the current object. Throws ZMQSocketException on error.


id: ZMQSocket::connect
type: function
doc:
<comment>Description:</comment>
  Connect the socket
  
  Connect the socket to a remote endpoint. The endpoint is defined in format <return>transport://address</return>
  where  transport is one of the following: inproc, ipc, tcp, pgm or epgm.

<comment>Param:</comment>
  <info>string</info>  <strong>$dsn</strong>    The connect dsn, for example <return>transport://address</return>.
  <info>bool</info>    <strong>$force</strong>  Tries to connect even if the socket has already been connected to given endpoint.

<comment>Return:</comment>
  <info>ZMQSocket</info>  Returns the current object.


id: ZMQSocket::disconnect
type: function
doc:
<comment>Description:</comment>
  Disconnect a socket
  
  Disconnect the socket from a previously connected remote endpoint. The endpoint is defined in
  format <return>transport://address</return> where transport is one of the following: inproc, ipc, tcp, pgm or epgm.

<comment>Param:</comment>
  <info>string</info>  <strong>$dsn</strong>  The connect dsn, for example <return>transport://address</return>.

<comment>Return:</comment>
  <info>ZMQSocket</info>  Returns the current object. Throws ZMQSocketException on error.


id: ZMQSocket::getEndpoints
type: function
doc:
<comment>Description:</comment>
  Get list of endpoints
  
  Returns a list of endpoints where the socket is connected or bound to.

<comment>Return:</comment>
  <info>array</info>  Returns an array containing elements 'bind' and 'connect'.


id: ZMQSocket::getPersistentId
type: function
doc:
<comment>Description:</comment>
  Get the persistent id
  
  Returns the persistent id of the socket.

<comment>Return:</comment>
  <info>string</info>  Returns the persistent id string assigned of the object and <info>null</info> if socket is not
          persistent.


id: ZMQSocket::getSockOpt
type: function
doc:
<comment>Description:</comment>
  Get socket option
  
  Returns the value of a socket option.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>  An integer representing the option. See the <info>ZMQ::SOCKOPT_*</info> constants.

<comment>Return:</comment>
  <info>mixed</info>  Returns either a <info>string</info> or an <info>int</info> depending on <strong>$key</strong>. Throws ZMQSocketException on error.


id: ZMQSocket::getSocketType
type: function
doc:
<comment>Description:</comment>
  Get the socket type
  
  Gets the socket type.

<comment>Return:</comment>
  <info>int</info>  Returns an integer representing the socket type. The integer can be compared against
       <info>ZMQ::SOCKET_*</info> constants.


id: ZMQSocket::isPersistent
type: function
doc:
<comment>Description:</comment>
  Whether the socket is persistent
  
  Check whether the socket is persistent.

<comment>Return:</comment>
  <info>bool</info>  Returns a <info>bool</info> based on whether the socket is persistent or not.


id: ZMQSocket::recv
type: function
doc:
<comment>Description:</comment>
  Receives a message
  
  Receive a message from a socket. By default receiving will block until a message is available
  unless <info>ZMQ::MODE_DONTWAIT</info> flag is used. <info>ZMQ::SOCKOPT_RCVMORE</info> socket option can be used for
  receiving multi-part messages. See <strong>ZMQSocket::setSockOpt()</strong>  for more information.

<comment>Param:</comment>
  <info>int</info>  <strong>$mode</strong>  Pass mode flags to receive multipart messages or non-blocking operation.  See
              <info>ZMQ::MODE_*</info> constants.

<comment>Return:</comment>
  <info>string</info>  Returns the message. If <info>ZMQ::MODE_DONTWAIT</info>  is used and the operation would block <info>false</info>
          shall be returned.


id: ZMQSocket::recvMulti
type: function
doc:
<comment>Description:</comment>
  Receives a multipart message
  
  Receive an array multipart message from a socket. By default receiving will block until a message
  is available unless <info>ZMQ::MODE_NOBLOCK</info> flag is used.

<comment>Param:</comment>
  <info>int</info>  <strong>$mode</strong>  Pass mode flags to receive multipart messages or non-blocking operation.  See
              <info>ZMQ::MODE_*</info> constants.

<comment>Return:</comment>
  <info>array</info>  Returns the array of message parts. Throws ZMQSocketException in error.  If
         <info>ZMQ::MODE_NOBLOCK</info> is used and the operation would  block <info>bool</info> false shall be returned.


id: ZMQSocket::send
type: function
doc:
<comment>Description:</comment>
  Sends a message
  
  Send a message using the socket. The operation can block unless <info>ZMQ::MODE_NOBLOCK</info> is used.

<comment>Param:</comment>
  <info>string</info>  <strong>$message</strong>  The message to send.
  <info>int</info>     <strong>$mode</strong>     Pass mode flags to receive multipart messages or non-blocking operation.  See
                    <info>ZMQ::MODE_*</info> constants.

<comment>Return:</comment>
  <info>ZMQSocket</info>  Returns the current object. Throws ZMQSocketException on error.  If <info>ZMQ::MODE_NOBLOCK</info>
             is used and the operation would  block <info>bool</info> false shall be returned.


id: ZMQSocket::sendmulti
type: function
doc:
<comment>Description:</comment>
  マルチパートメッセージを送る
  
  ソケットを使ってマルチパートメッセージを送ります。 この操作は <info>ZMQ::MODE_NOBLOCK</info> を使わないとブロッ
  クされる可能性があります。

<comment>Param:</comment>
  <info>array</info>  <strong>$message</strong>  送信するメッセージ - 文字列の配列
  <info>int</info>    <strong>$mode</strong>     マルチパートメッセージを受け取るか、 ノンブロッキング操作を行うかのモードフラグ。
                   <info>ZMQ::MODE_*</info> 定数を参照ください。

<comment>Return:</comment>
  <info>ZMQSocket</info>  現在のオブジェクトを返します。 エラーの場合は ZMQSocketException をスローします。
             <info>ZMQ::MODE_NOBLOCK</info> が使われていた場合、 操作はブロックされ、<info>false</info> が返されます。


id: ZMQSocket::setSockOpt
type: function
doc:
<comment>Description:</comment>
  Set a socket option
  
  Sets a ZMQ socket option. The type of the <strong>$value</strong> depends on the <strong>$key</strong>. See ZMQ Constant Types for
  more information.

<comment>Param:</comment>
  <info>int</info>    <strong>$key</strong>    One of the <info>ZMQ::SOCKOPT_*</info> constants.
  <info>mixed</info>  <strong>$value</strong>  The value of the parameter.

<comment>Return:</comment>
  <info>ZMQSocket</info>  Returns the current object. Throws ZMQSocketException on error.


id: ZMQSocket::unbind
type: function
doc:
<comment>Description:</comment>
  Unbind the socket
  
  Unbind the socket from an endpoint. The endpoint is defined in format <return>transport://address</return> where
  transport is one of the following: inproc, ipc, tcp, pgm or epgm.

<comment>Param:</comment>
  <info>string</info>  <strong>$dsn</strong>  The previously bound dsn, for example <return>transport://address</return>.

<comment>Return:</comment>
  <info>ZMQSocket</info>  Returns the current object. Throws ZMQSocketException on error.


id: ZipArchive::AFL_CREATE_OR_KEEP_FILE_FOR_EMPTY_ARCHIVE
type: constant
doc:
<comment>Description:</comment>
  アーカイブが空の場合に、ファイルを削除しません。 PHP 8.3.0 以降、PECL zip 1.22.0 以降で利用可能で
  す。 それぞれ、libzip ≥ 1.10.0 以降でビルドした場合に利用できます。


id: ZipArchive::AFL_IS_TORRENTZIP
type: constant
doc:
<comment>Description:</comment>
  アーカイブが torrentzip フォーマットであることを示します。 PHP 8.3.0 以降、PECL zip 1.22.0 以降で
  利用可能です。 それぞれ、libzip ≥ 1.10.0 以降でビルドした場合に利用できます。


id: ZipArchive::AFL_RDONLY
type: constant
doc:
<comment>Description:</comment>
  アーカイブが読み取り専用であることを示します。 クリアできません。 PHP 8.3.0 以降、PECL zip 1.22.0
  以降で利用可能です。 それぞれ、libzip ≥ 1.10.0 以降でビルドした場合に利用できます。


id: ZipArchive::AFL_WANT_TORRENTZIP
type: constant
doc:
<comment>Description:</comment>
  書き込みアーカイブが torrentzip フォーマットであることを示します。 PHP 8.3.0 以降、PECL zip 1.22.0
  以降で利用可能です。 それぞれ、libzip ≥ 1.10.0 以降でビルドした場合に利用できます。


id: ZipArchive::CM_LZMA2
type: constant
doc:
<comment>Description:</comment>
  LZMA2 アルゴリズム。 libzip ≥ 1.6.0 でビルドした場合、 PHP 7.4.3 以降、PECL zip 1.16.0 以降で利用
  可能です。


id: ZipArchive::CM_XZ
type: constant
doc:
<comment>Description:</comment>
  XZ アルゴリズム。 libzip ≥ 1.6.0 でビルドした場合、 PHP 7.4.3 以降、PECL zip 1.16.1 以降で利用可能
  です。


id: ZipArchive::CM_ZSTD
type: constant
doc:
<comment>Description:</comment>
  Zstandard アルゴリズム。 libzip ≥ 1.8.0 でビルドした場合、 PHP 8.0.0 以降、PECL zip 1.19.0 以降で
  利用可能です。


id: ZipArchive::EM_AES_128
type: constant
doc:
<comment>Description:</comment>
  AES 128 ビットで暗号化します。 libzip ≥ 1.2.0 でビルドした場合、 PHP 7.2.0 以降、PECL zip 1.14.0
  以降で利用可能です。


id: ZipArchive::EM_AES_192
type: constant
doc:
<comment>Description:</comment>
  AES 192 ビットで暗号化します。 libzip ≥ 1.2.0 でビルドした場合、 PHP 7.2.0 以降、PECL zip 1.14.0
  以降で利用可能です。


id: ZipArchive::EM_AES_256
type: constant
doc:
<comment>Description:</comment>
  AES 256 ビットで暗号化します。 libzip ≥ 1.2.0 でビルドした場合、 PHP 7.2.0 以降、PECL zip 1.14.0
  以降で利用可能です。


id: ZipArchive::EM_NONE
type: constant
doc:
<comment>Description:</comment>
  暗号化しません。libzip ≥ 1.2.0 でビルドした場合、 PHP 7.2.0 以降、PECL zip 1.14.0 以降で利用可能で
  す。


id: ZipArchive::ER_CANCELLED
type: constant
doc:
<comment>Description:</comment>
  操作がキャンセルされました。 libzip ≥ 1.6.0 でビルドした場合、 PHP 7.4.3 以降、PECL zip 1.16.1 以
  降で利用可能です。


id: ZipArchive::ER_COMPRESSED_DATA
type: constant
doc:
<comment>Description:</comment>
  圧縮データが不正です。 libzip ≥ 1.6.0 でビルドした場合、 PHP 7.4.3 以降、PECL zip 1.16.1 以降で利
  用可能です。


id: ZipArchive::ER_DATA_LENGTH
type: constant
doc:
<comment>Description:</comment>
  データの長さが想定外です。 PHP 8.3.0 以降、PECL zip 1.22.0 以降で利用可能です。 それぞれ、libzip ≥
  1.10.0 以降でビルドした場合に利用できます。


id: ZipArchive::ER_INUSE
type: constant
doc:
<comment>Description:</comment>
  リソースがまだ使用中です。 libzip ≥ 1.0.0 でビルドした場合、 PHP 7.4.3 以降、PECL zip 1.16.1 以降
  で利用可能です。


id: ZipArchive::ER_NOT_ALLOWED
type: constant
doc:
<comment>Description:</comment>
  torrentzip では許可されません。 PHP 8.3.0 以降、PECL zip 1.22.0 以降で利用可能です。 それぞれ、
  libzip ≥ 1.10.0 以降でビルドした場合に利用できます。


id: ZipArchive::ER_OPNOTSUPP
type: constant
doc:
<comment>Description:</comment>
  操作はサポートされていません。 libzip ≥ 1.0.0 でビルドした場合、 PHP 7.4.3 以降、PECL zip 1.16.1
  以降で利用可能です。


id: ZipArchive::ER_TELL
type: constant
doc:
<comment>Description:</comment>
  ストリームの位置変更エラー。 libzip ≥ 1.0.0 でビルドした場合、 PHP 7.4.3 以降、PECL zip 1.16.1 以
  降で利用可能です。


id: ZipArchive::FL_ENCRYPTED
type: constant
doc:
<comment>Description:</comment>
  暗号化されたデータを読み込みます(FL_COMPRESSED が有効な場合)。 PHP 8.0.0 以降、PECL zip 1.18.0 以
  降で利用可能です。


id: ZipArchive::FL_OPEN_FILE_NOW
type: constant
doc:
<comment>Description:</comment>
  ファイルが追加された際に、アーカイブがクローズされるのを待つ代わりに、 ファイルをオープンします。
  ファイルディスクリプタが消費されることに注意してください。 PHP 8.3.0 以降、PECL zip 1.22.0 以降で
  利用可能です。


id: ZipArchive::FL_OVERWRITE
type: constant
doc:
<comment>Description:</comment>
  ファイル名が存在する場合、上書き(置き換え)します。 PHP 8.0.0 以降、PECL zip 1.18.0 以降で利用可能
  です。


id: ZipArchive::FL_RECOMPRESS
type: constant
doc:
<comment>Description:</comment>
  データを強制的に再び圧縮します。 PHP 8.0.0 以降、PECL zip 1.18.0 以降で利用可能です。 PHP 8.3.0 以
  降、PECL zip 1.22.1 以降では推奨されなくなりました。 libzip の将来のバージョンで削除予定です。


id: ZipArchive::LENGTH_TO_END
type: constant
doc:
<comment>Description:</comment>
  ファイルサイズを使います。 ファイルサイズが増えた場合、追加のデータは無視されます。 ファイルサイズ
  が小さくなった場合、エラー (<info>ZipArchive::ER_DATA_LENGTH</info>) が発生します。 PHP 8.3.0 以降、PECL zip
  1.22.2 以降で利用可能です。


id: ZipArchive::LENGTH_UNCHECKED
type: constant
doc:
<comment>Description:</comment>
  利用可能なデータを全て使います。 libzip ≥ 1.10.1 でビルドした場合、 PHP 8.3.0 以降、PECL zip
  1.22.2 以降で利用可能です。


id: ZipArchive::RDONLY
type: constant
doc:
<comment>Description:</comment>
  アーカイブを読み取り専用で開きます。 libzip ≥ 1.0.0 でビルドした場合、 PHP 7.4.3 以降、PECL zip
  1.17.1 以降で利用可能です。


id: ZipArchive::addEmptyDir
type: function
doc:
<comment>Description:</comment>
  新しいディレクトリを追加する
  
  空のディレクトリをアーカイブに追加します。

<comment>Param:</comment>
  <info>string</info>  <strong>$dirname</strong>  追加するディレクトリ。
  <info>int</info>     <strong>$flags</strong>    以下のビットマスクの組み合わせ:  <info>ZipArchive::FL_ENC_GUESS</info>,
                    <info>ZipArchive::FL_ENC_UTF_8</info>, <info>ZipArchive::FL_ENC_CP437</info>。 これらの定数の振る舞いは、
                    定義済みの定数 で説明しています。

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


id: ZipArchive::addFile
type: function
doc:
<comment>Description:</comment>
  指定したパスからファイルを ZIP アーカイブに追加する
  
  指定したパスから、ファイルを ZIP アーカイブに追加します。
  
  ポータビリティを考慮して、ZIP ファイル名のディレクトリ区切り文字には常にスラッシュ (<return>/</return>) を使うこと
  を推奨します。

<comment>Param:</comment>
  <info>string</info>  <strong>$filepath</strong>   追加するファイルへのパス。
  <info>string</info>  <strong>$entryname</strong>  空でない値を指定した場合は ZIP アーカイブ内部での名前となり、<strong>$filepath</strong> を上書
                      きします。
  <info>int</info>     <strong>$start</strong>      ファイルを一部コピーする場合の開始位置。
  <info>int</info>     <strong>$length</strong>     ファイルを一部コピーする場合の、コピーする長さ。 <info>ZipArchive::LENGTH_TO_END</info> (0)
                      を指定すると、 ファイルサイズのぶんだけコピーします。
                      <info>ZipArchive::LENGTH_UNCHECKED</info> を指定すると、 <strong>$start</strong> の位置から)ファイル全体をコ
                      ピーします。
  <info>int</info>     <strong>$flags</strong>      以下のビットマスクの組み合わせ:  <info>ZipArchive::FL_OVERWRITE</info>,
                      <info>ZipArchive::FL_ENC_GUESS</info>, <info>ZipArchive::FL_ENC_UTF_8</info>, <info>ZipArchive::FL_ENC_CP437</info>,
                      <info>ZipArchive::FL_OPEN_FILE_NOW</info>。 これらの定数の振る舞いは、定義済みの定数 で説明
                      しています。

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

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


id: ZipArchive::addFromString
type: function
doc:
<comment>Description:</comment>
  内容を指定して、ファイルを ZIP アーカイブに追加する
  
  内容を指定して、ファイルを ZIP アーカイブに追加します。
  
  ポータビリティを考慮して、ZIP ファイル名のディレクトリ区切り文字には常にスラッシュ (<return>/</return>) を使うこと
  を推奨します。

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>     作成するエントリの名前。
  <info>string</info>  <strong>$content</strong>  エントリを作成するために使用するデータの内容。 バイナリセーフな形式で使用しま
                    す。
  <info>int</info>     <strong>$flags</strong>    以下のビットマスクの組み合わせ:  <info>ZipArchive::FL_OVERWRITE</info>,
                    <info>ZipArchive::FL_ENC_GUESS</info>, <info>ZipArchive::FL_ENC_UTF_8</info>, <info>ZipArchive::FL_ENC_CP437</info>。
                    これらの定数の振る舞いは、定義済みの定数 で説明しています。

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


id: ZipArchive::addGlob
type: function
doc:
<comment>Description:</comment>
  ディレクトリから、glob パターンを使ってファイルを追加する
  
  ディレクトリから、glob <strong>$pattern</strong> にマッチするファイルを追加します。
  
  ポータビリティを考慮して、ZIP ファイル名のディレクトリ区切り文字には常にスラッシュ (<return>/</return>) を使うこと
  を推奨します。

<comment>Param:</comment>
  <info>string</info>  <strong>$pattern</strong>  <strong>glob()</strong> パターン。どのファイルを対象にするのかを指定します。
  <info>int</info>     <strong>$flags</strong>    <return>glob()</return> のフラグのビットマスク。
  <info>array</info>   <strong>$options</strong>  オプションの連想配列。次のオプションが使えます。 <return>"add_path"</return> アーカイブ内のファイ
                    ルのローカルパスに変換するときにつけるプレフィックス。 これが適用されるのは、
                    <return>"remove_path"</return> や <return>"remove_all_path"</return> で定義された削除処理がすべて終わった後です。
                    <return>"remove_path"</return> マッチしたファイルをアーカイブに追加する前に削除するプレフィック
                    ス。 <return>"remove_all_path"</return><info>true</info> にすると、ファイル名だけを使ってアーカイブのルートに
                    追加します。 <return>"flags"</return> 以下のビットマスクの組み合わせ:  <info>ZipArchive::FL_OVERWRITE</info>,
                    <info>ZipArchive::FL_ENC_GUESS</info>, <info>ZipArchive::FL_ENC_UTF_8</info>, <info>ZipArchive::FL_ENC_CP437</info>,
                    <info>ZipArchive::FL_OPEN_FILE_NOW</info>。 これらの定数の振る舞いは、定義済みの定数 で説明し
                    ています。 <return>"comp_method"</return> 圧縮メソッド。 <info>ZipArchive::CM_*</info> のうちのいずれかです。
                    定義済みの定数 も参照ください。 <return>"comp_flags"</return> 圧縮レベル <return>"enc_method"</return> 暗号化メ
                    ソッド。 <info>ZipArchive::EM_*</info> のうちのいずれかです。 定義済みの定数 も参照ください。
                    <return>"enc_password"</return> 暗号化に使うパスワード
                    
                    <return>"add_path"</return>
                    
                    アーカイブ内のファイルのローカルパスに変換するときにつけるプレフィックス。 これ
                    が適用されるのは、 <return>"remove_path"</return> や <return>"remove_all_path"</return> で定義された削除処理がすべ
                    て終わった後です。
                    
                    <return>"remove_path"</return>
                    
                    マッチしたファイルをアーカイブに追加する前に削除するプレフィックス。
                    
                    <return>"remove_all_path"</return>
                    
                    <info>true</info> にすると、ファイル名だけを使ってアーカイブのルートに追加します。
                    
                    <return>"flags"</return>
                    
                    以下のビットマスクの組み合わせ:  <info>ZipArchive::FL_OVERWRITE</info>,
                    <info>ZipArchive::FL_ENC_GUESS</info>, <info>ZipArchive::FL_ENC_UTF_8</info>, <info>ZipArchive::FL_ENC_CP437</info>,
                    <info>ZipArchive::FL_OPEN_FILE_NOW</info>。 これらの定数の振る舞いは、定義済みの定数 で説明し
                    ています。
                    
                    <return>"comp_method"</return>
                    
                    圧縮メソッド。 <info>ZipArchive::CM_*</info> のうちのいずれかです。 定義済みの定数 も参照くだ
                    さい。
                    
                    <return>"comp_flags"</return>
                    
                    圧縮レベル
                    
                    <return>"enc_method"</return>
                    
                    暗号化メソッド。 <info>ZipArchive::EM_*</info> のうちのいずれかです。 定義済みの定数 も参照く
                    ださい。
                    
                    <return>"enc_password"</return>
                    
                    暗号化に使うパスワード

<comment>Return:</comment>
  <info>array|false</info>  成功した場合、追加されたファイルの <info>array</info> を返します。 失敗した場合に <info>false</info> を返します

<comment>See Also:</comment>
   * ZipArchive::addFile
   * ZipArchive::addPattern


id: ZipArchive::addPattern
type: function
doc:
<comment>Description:</comment>
  ディレクトリから、PCRE パターンを使ってファイルを追加する
  
  ディレクトリから、正規表現の <strong>$pattern</strong> にマッチするファイルを追加します。 この操作は再帰処理ではあ
  りません。パターンマッチは、ファイル名に対してだけ行います。

<comment>Param:</comment>
  <info>string</info>  <strong>$pattern</strong>  PCRE のパターン。どのファイルを対象にするのかを指定します。
  <info>string</info>  <strong>$path</strong>     スキャンするディレクトリ。デフォルトは、現在の作業ディレクトリです。
  <info>array</info>   <strong>$options</strong>  オプションの連想配列。ZipArchive::addGlob と同じオプションが使えます。

<comment>Return:</comment>
  <info>array|false</info>  成功した場合、追加されたファイルの <info>array</info> を返します。 失敗した場合に <info>false</info> を返します

<comment>See Also:</comment>
   * ZipArchive::addFile
   * ZipArchive::addGlob


id: ZipArchive::clearError
type: function
doc:
<comment>Description:</comment>
  ステータスエラーメッセージか、システムエラー/ zip メッセージをクリアする
  
  アーカイブのステータスエラーメッセージか、 システムエラー かつ/または zip メッセージをクリアしま
  す。

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

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


id: ZipArchive::close
type: function
doc:
<comment>Description:</comment>
  アクティブな (オープンされた、あるいは新しく作成された) アーカイブを閉じる
  
  オープンされた、あるいは作成されたアーカイブを閉じ、 変更内容を保存します。このメソッドは、 スクリ
  プトの最後で自動的にコールされます。
  
  アーカイブにファイルが含まれていない場合、 グローバルフラグ
  <info>ZipArchive::AFL_CREATE_OR_KEEP_FILE_FOR_EMPTY_ARCHIVE</info> に従って、 デフォルトではファイルは完全に削
  除されます。 (空のアーカイブが作られることはありません)

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

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


id: ZipArchive::count
type: function
doc:
<comment>Description:</comment>
  アーカイブにあるファイルの数を数える

<comment>Return:</comment>
  <info>int</info>  アーカイブにあるファイルの数を返します。


id: ZipArchive::deleteIndex
type: function
doc:
<comment>Description:</comment>
  インデックスを使用して、アーカイブ内のエントリを削除する
  
  インデックスをもとにして、アーカイブ内のエントリを削除します。

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  削除するエントリのインデックス。

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


id: ZipArchive::deleteName
type: function
doc:
<comment>Description:</comment>
  名前を使用して、アーカイブからエントリを削除する
  
  名前をもとにして、アーカイブ内のエントリを削除します。

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  削除するエントリの名前。

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


id: ZipArchive::extractTo
type: function
doc:
<comment>Description:</comment>
  アーカイブの内容を展開する
  
  アーカイブの全体あるいは指定したファイルを、 指定した場所に展開します。
  
  展開されたファイルとディレクトリのデフォルトのパーミッションは、 可能な限りもっとも広いアクセス権
  限になります。 これは <strong>umask()</strong> 関数で変更できる umask で制限できます。
  
  セキュリティ上の理由で、パーミッションは復元されません。 パーミッションを復元するコードのサンプル
  は、 ZipArchive::getExternalAttributesIndex の コードサンプル を参照ください。

<comment>Param:</comment>
  <info>string</info>             <strong>$pathto</strong>  ファイルを展開する場所。
  <info>array|string|null</info>  <strong>$files</strong>   展開するエントリ。単一のエントリ名、 あるいはエントリ名の配列を指定し
                              ます。

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


id: ZipArchive::getArchiveComment
type: function
doc:
<comment>Description:</comment>
  ZIP アーカイブのコメントを返す
  
  Zip アーカイブのコメントを返します。

<comment>Param:</comment>
  <info>int</info>  <strong>$flags</strong>  <info>ZipArchive::FL_UNCHANGED</info> を設定すると、 元の変更されていないコメントを返します。

<comment>Return:</comment>
  <info>string|false</info>  Zip アーカイブのコメントを返します。失敗した場合に <info>false</info> を返します。


id: ZipArchive::getArchiveFlag
type: function
doc:
<comment>Description:</comment>
  Zip アーカイブのグローバルフラグの値を返す
  
  Zip アーカイブのグローバルフラグの値を返します。

<comment>Param:</comment>
  <info>int</info>  <strong>$flag</strong>   取得するグローバルフラグ。 以下の定数 <return>AFL_*</return> から選びます:
               <info>ZipArchive::AFL_RDONLY</info><info>ZipArchive::AFL_IS_TORRENTZIP</info><info>ZipArchive::AFL_WANT_TORRENTZIP</info><info>ZipArchive::AFL_CREATE_OR_KEEP_FILE_FOR_EMPTY_ARCHIVE</info>
               
               <info>ZipArchive::AFL_RDONLY</info>
               
               <info>ZipArchive::AFL_IS_TORRENTZIP</info>
               
               <info>ZipArchive::AFL_WANT_TORRENTZIP</info>
               
               <info>ZipArchive::AFL_CREATE_OR_KEEP_FILE_FOR_EMPTY_ARCHIVE</info>
  <info>int</info>  <strong>$flags</strong>  <info>ZipArchive::FL_UNCHANGED</info> が設定された場合、 もともと設定されていた値が返されます。

<comment>Return:</comment>
  <info>int</info>  アーカイブにフラグが設定されている場合は、1 を返します。 設定されていない場合は 0 を返しま
       す。 エラーが発生した場合は -1 を返します。

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


id: ZipArchive::getCommentIndex
type: function
doc:
<comment>Description:</comment>
  エントリのインデックスを使用して、エントリのコメントを返す
  
  エントリのインデックスを使用して、エントリのコメントを返します。

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  エントリのインデックス。
  <info>int</info>  <strong>$flags</strong>  <info>ZipArchive::FL_UNCHANGED</info> を指定すると、 元の変化していないコメントを返します。

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


id: ZipArchive::getCommentName
type: function
doc:
<comment>Description:</comment>
  エントリ名を使用して、エントリのコメントを返す
  
  エントリ名を使用して、エントリのコメントを返します。

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>   エントリの名前。
  <info>int</info>     <strong>$flags</strong>  <info>ZipArchive::FL_UNCHANGED</info> を指定すると、 元の変化していないコメントが返されます。

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


id: ZipArchive::getExternalAttributesIndex
type: function
doc:
<comment>Description:</comment>
  インデックスで定義されたエントリの外部属性を取得する
  
  インデックスで定義されたエントリの外部属性を取得します。

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  エントリのインデックス
  <info>int</info>  <strong>$opsys</strong>  成功した場合に、 ZipArchive::OPSYS_ 定数のうちのひとつで定義された、 オペレーティング
               システムコードを取得します。
  <info>int</info>  <strong>$attr</strong>   成功した場合に、外部属性を取得します。 値はオペレーティングシステム依存です。
  <info>int</info>  <strong>$flags</strong>  <info>ZipArchive::FL_UNCHANGED</info> に設定された場合、 オリジナルの変更されなかった属性が返され
               ます。

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


id: ZipArchive::getExternalAttributesName
type: function
doc:
<comment>Description:</comment>
  名前で定義されたエントリの外部属性を取得する
  
  名前で定義されたエントリの外部属性を取得します。

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>   エントリの名前
  <info>int</info>     <strong>$opsys</strong>  成功した場合に、 ZipArchive::OPSYS_ 定数のうちのひとつで定義された、 オペレーティ
                  ングシステムコードを取得します。
  <info>int</info>     <strong>$attr</strong>   成功した場合に、外部属性を取得します。 値はオペレーティングシステム依存です。
  <info>int</info>     <strong>$flags</strong>  <info>ZipArchive::FL_UNCHANGED</info> に設定された場合、 オリジナルの変更されなかった属性が返さ
                  れます。

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


id: ZipArchive::getFromIndex
type: function
doc:
<comment>Description:</comment>
  インデックスを使用して、エントリの内容を返す
  
  インデックスを使用して、エントリの内容を返します。

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  エントリのインデックス。
  <info>int</info>  <strong>$len</strong>    エントリから読み込む長さ。<return>0</return> の場合はエントリ全体を読み込みます。
  <info>int</info>  <strong>$flags</strong>  アーカイブのオープン時に使用するフラグ。以下の値を OR で連結して使用します。
               <info>ZipArchive::FL_UNCHANGED</info><info>ZipArchive::FL_COMPRESSED</info>
               
               <info>ZipArchive::FL_UNCHANGED</info>
               
               <info>ZipArchive::FL_COMPRESSED</info>

<comment>Return:</comment>
  <info>string|false</info>  成功した場合にエントリの内容、失敗した場合に <info>false</info> を返します。

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


id: ZipArchive::getFromName
type: function
doc:
<comment>Description:</comment>
  名前を使用して、エントリの内容を返す
  
  名前を使用して、エントリの内容を返します。

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>   エントリの名前。
  <info>int</info>     <strong>$len</strong>    エントリから読み込む長さ。<return>0</return> の場合はエントリ全体を読み込みます。
  <info>int</info>     <strong>$flags</strong>  エントリを探す際に使用するフラグ。以下の値を OR で連結して使用します。
                  <info>ZipArchive::FL_UNCHANGED</info><info>ZipArchive::FL_COMPRESSED</info><info>ZipArchive::FL_NOCASE</info>
                  
                  <info>ZipArchive::FL_UNCHANGED</info>
                  
                  <info>ZipArchive::FL_COMPRESSED</info>
                  
                  <info>ZipArchive::FL_NOCASE</info>

<comment>Return:</comment>
  <info>string|false</info>  成功した場合にエントリの内容、失敗した場合に <info>false</info> を返します。

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


id: ZipArchive::getNameIndex
type: function
doc:
<comment>Description:</comment>
  インデックスを使用して、エントリの名前を返す
  
  インデックスを使用して、エントリの名前を返します。

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  エントリのインデックス。
  <info>int</info>  <strong>$flags</strong>  <info>ZipArchive::FL_UNCHANGED</info> を指定すると、 元の変化していないコメントを返します。

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


id: ZipArchive::getStatusString
type: function
doc:
<comment>Description:</comment>
  システムエラー、または ZIP メッセージに関するエラー情報を返す
  
  システムエラー、または ZIP メッセージに関するエラー情報を返す

<comment>Return:</comment>
  <info>string</info>  成功時にはステータスメッセージを文字列で返します。


id: ZipArchive::getStream
type: function
doc:
<comment>Description:</comment>
  名前を使用して、エントリのファイルハンドラ (読み込み専用) を取得する
  
  名前を使用して、エントリのファイルハンドラを取得します。 現時点では読み込み操作のみに対応していま
  す。

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  使用するエントリの名前。

<comment>Return:</comment>
  <info>resource|false</info>  成功した場合にファイルポインタ (リソース)、 失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * ZipArchive::getStreamIndex
   * ZipArchive::getStreamName
   * 圧縮ストリーム


id: ZipArchive::getStreamIndex
type: function
doc:
<comment>Description:</comment>
  インデックスで指定されたエントリへの、ファイルハンドラを取得する(読み取り専用)
  
  インデックスで指定されたエントリへの、 ファイルハンドラを取得します。 現状では、読み取りのみをサ
  ポートしています。

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  エントリのインデックス。
  <info>int</info>  <strong>$flags</strong>  <info>ZipArchive::FL_UNCHANGED</info> に設定すると、オリジナルの未変更のストリームを返します。

<comment>Return:</comment>
  <info>resource|false</info>  成功時に、ファイルポインタ(リソース) を返します。 失敗した場合に <info>false</info> を返します.

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


id: ZipArchive::getStreamName
type: function
doc:
<comment>Description:</comment>
  名前で指定されたエントリへの、ファイルハンドラを取得する(読み取り専用)
  
  インデックスで指定されたエントリへの、 ファイルハンドラを取得します。 現状では、読み取り操作のみを
  サポートしています。

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>   エントリの名前。
  <info>int</info>     <strong>$flags</strong>  <info>ZipArchive::FL_UNCHANGED</info> に設定すると、オリジナルの未変更のストリームを返します。

<comment>Return:</comment>
  <info>resource|false</info>  成功時に、ファイルポインタ(リソース) を返します。 失敗した場合に <info>false</info> を返します.

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


id: ZipArchive::isCompressionMethodSupported
type: function
doc:
<comment>Description:</comment>
  圧縮方式を libzip がサポートしているかをチェックする
  
  圧縮方式を libzip がサポートしているかをチェックします。

<comment>Param:</comment>
  <info>int</info>   <strong>$method</strong>  圧縮方式。 定数 <info>ZipArchive::CM_*</info> のうちのいずれかです。
  <info>bool</info>  <strong>$enc</strong>     <info>true</info> を設定すると圧縮方式をチェックします。 <info>false</info> を設定すると伸長方式をチェックし
                 ます。

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

<comment>See Also:</comment>
   * ZipArchive::setCompressionIndex
   * ZipArchive::setCompressionName


id: ZipArchive::isEncryptionMethodSupported
type: function
doc:
<comment>Description:</comment>
  暗号化方式を libzip がサポートしているかどうかをチェックする
  
  暗号化方式を libzip がサポートしているかどうかをチェックします

<comment>Param:</comment>
  <info>int</info>   <strong>$method</strong>  暗号化方式。 定数 <info>ZipArchive::EM_*</info> のうちのいずれかです。
  <info>bool</info>  <strong>$enc</strong>     <info>true</info> を設定すると、暗号化方式をチェックし、 <info>false</info> を設定すると、復号化方式をチェッ
                 クします。

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

<comment>See Also:</comment>
   * ZipArchive::setEncryptionIndex
   * ZipArchive::setEncryptionName


id: ZipArchive::locateName
type: function
doc:
<comment>Description:</comment>
  アーカイブ内のエントリのインデックスを返す
  
  名前を使用して、エントリの場所を取得します。

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>   探したいエントリの名前。
  <info>int</info>     <strong>$flags</strong>  この関数は、アーカイブ内の指定した名前のファイルのインデックスを返します。 フラグ
                  には、次の値を OR で連結して指定します。 あるいは何もしていしない場合は 0 としま
                  す。 <info>ZipArchive::FL_NOCASE</info><info>ZipArchive::FL_NODIR</info>
                  
                  <info>ZipArchive::FL_NOCASE</info>
                  
                  <info>ZipArchive::FL_NODIR</info>

<comment>Return:</comment>
  <info>int|false</info>  成功した場合にエントリのインデックス、失敗した場合に <info>false</info> を返します。


id: ZipArchive::open
type: function
doc:
<comment>Description:</comment>
  ZIP ファイルアーカイブをオープンする
  
  新しい、または既に存在する zip アーカイブを 読み込み/書き込み/変更用にオープンします。
  
  libzip 1.6.0 以降では、空のファイルは有効なアーカイブではなくなりました。

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  オープンする ZIP アーカイブのファイル名。
  <info>int</info>     <strong>$flags</strong>     アーカイブのオープンに使用するモード。
                     <info>ZipArchive::OVERWRITE</info><info>ZipArchive::CREATE</info><info>ZipArchive::RDONLY</info><info>ZipArchive::EXCL</info><info>ZipArchive::CHECKCONS</info>
                     
                     <info>ZipArchive::OVERWRITE</info>
                     
                     <info>ZipArchive::CREATE</info>
                     
                     <info>ZipArchive::RDONLY</info>
                     
                     <info>ZipArchive::EXCL</info>
                     
                     <info>ZipArchive::CHECKCONS</info>

<comment>Return:</comment>
  <info>bool|int</info>  成功した場合に <info>true</info>、失敗した場合は <info>false</info> を返し、 エラー時には以下のエラーコードを返し
            ます。 <info>ZipArchive::ER_EXISTS</info>ファイルが既に存在します。<info>ZipArchive::ER_INCONS</info>Zipアーカイブ
            に不整合があります。<info>ZipArchive::ER_INVAL</info>不正な引数です。<info>ZipArchive::ER_MEMORY</info>メモリ確保
            に失敗しました。<info>ZipArchive::ER_NOENT</info>ファイルが存在しません。<info>ZipArchive::ER_NOZIP</info>zip アー
            カイブではありません。<info>ZipArchive::ER_OPEN</info>ファイルを開けません。<info>ZipArchive::ER_READ</info>読み取
            りエラーです。<info>ZipArchive::ER_SEEK</info>シークエラーです。
            
            ファイルが既に存在します。
            
            Zipアーカイブに不整合があります。
            
            不正な引数です。
            
            メモリ確保に失敗しました。
            
            ファイルが存在しません。
            
            zip アーカイブではありません。
            
            ファイルを開けません。
            
            読み取りエラーです。
            
            シークエラーです。


id: ZipArchive::registerCancelCallback
type: function
doc:
<comment>Description:</comment>
  アーカイブを閉じている間にキャンセルできるようにコールバックを登録する
  
  アーカイブを閉じている間にキャンセルできるように <strong>$callback</strong> 関数を登録します。

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  この関数が0を返すと、操作は続行されます。 それ以外の値を返すと、操作はキャン
                       セルされます。

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

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


id: ZipArchive::registerProgressCallback
type: function
doc:
<comment>Description:</comment>
  アーカイブを閉じている間に更新できるようにコールバックを登録する
  
  アーカイブを閉じている間に更新できるように <strong>$callback</strong> 関数を登録します。

<comment>Param:</comment>
  <info>float</info>     <strong>$rate</strong>      コールバックを呼び出す間の変更の割合(0.0 から 1.0 の間の値を設定します)
  <info>callable</info>  <strong>$callback</strong>  この関数は現在の <strong>$state</strong> (状態) を (0.0 から 1.0 の間の) <info>float</info> で受け取りま
                       す。

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

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


id: ZipArchive::renameIndex
type: function
doc:
<comment>Description:</comment>
  インデックスを使用してエントリ名を変更する
  
  インデックスを使用して、エントリ名を変更します。

<comment>Param:</comment>
  <info>int</info>     <strong>$index</strong>     名前を変更するエントリのインデックス。
  <info>string</info>  <strong>$new_name</strong>  新しい名前。

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


id: ZipArchive::renameName
type: function
doc:
<comment>Description:</comment>
  名前を使用してエントリ名を変更する
  
  名前を使用して、エントリ名を変更します。

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>      名前を変更するエントリの名前。
  <info>string</info>  <strong>$new_name</strong>  新しい名前。

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


id: ZipArchive::replaceFile
type: function
doc:
<comment>Description:</comment>
  指定されたパスのファイルにアーカイブの一部を置き換える
  
  指定されたパスのファイルにアーカイブの一部を置き換えます。
  
  ポータビリティを考慮して、ZIP ファイル名のディレクトリ区切り文字には常にスラッシュ (<return>/</return>) を使うこと
  を推奨します。

<comment>Param:</comment>
  <info>string</info>  <strong>$filepath</strong>  追加するファイルのパス。
  <info>int</info>     <strong>$index</strong>     置き換えるファイルのインデックス。名前は変更されません。
  <info>int</info>     <strong>$start</strong>     ファイルを一部コピーする場合の開始位置。
  <info>int</info>     <strong>$length</strong>    ファイルを一部コピーする場合の、コピーする長さ。 <info>ZipArchive::LENGTH_TO_END</info> (0)
                     を指定すると、 ファイルサイズのぶんだけコピーします。
                     <info>ZipArchive::LENGTH_UNCHECKED</info> を指定すると、 <strong>$start</strong> の位置から)ファイル全体をコ
                     ピーします。
  <info>int</info>     <strong>$flags</strong>     以下のビットマスクの組み合わせ:  <info>ZipArchive::FL_ENC_GUESS</info>,
                     <info>ZipArchive::FL_ENC_UTF_8</info>, <info>ZipArchive::FL_ENC_CP437</info>,
                     <info>ZipArchive::FL_OPEN_FILE_NOW</info>。 これらの定数の振る舞いは、定義済みの定数 で説明
                     しています。

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

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


id: ZipArchive::setArchiveComment
type: function
doc:
<comment>Description:</comment>
  ZIP アーカイブのコメントを設定する
  
  ZIP アーカイブのコメントを設定します。

<comment>Param:</comment>
  <info>string</info>  <strong>$comment</strong>  コメントの内容。

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


id: ZipArchive::setArchiveFlag
type: function
doc:
<comment>Description:</comment>
  Zip アーカイブのグローバルフラグを設定する
  
  ZIP アーカイブのグローバルフラグを設定します。

<comment>Param:</comment>
  <info>int</info>  <strong>$flag</strong>   変更するグローバルフラグ。 定数 <return>AFL_*</return> から選びます。
               <info>ZipArchive::AFL_WANT_TORRENTZIP</info><info>ZipArchive::AFL_CREATE_OR_KEEP_FILE_FOR_EMPTY_ARCHIVE</info>
               
               <info>ZipArchive::AFL_WANT_TORRENTZIP</info>
               
               <info>ZipArchive::AFL_CREATE_OR_KEEP_FILE_FOR_EMPTY_ARCHIVE</info>
  <info>int</info>  <strong>$value</strong>  フラグの新しい値。

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

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


id: ZipArchive::setCommentIndex
type: function
doc:
<comment>Description:</comment>
  インデックスを使用してエントリのコメントを設定する
  
  インデックスを使用して、エントリのコメントを設定します。

<comment>Param:</comment>
  <info>int</info>     <strong>$index</strong>    エントリのインデックス。
  <info>string</info>  <strong>$comment</strong>  コメントの内容。

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


id: ZipArchive::setCommentName
type: function
doc:
<comment>Description:</comment>
  名前を使用してエントリのコメントを設定する
  
  名前を使用して、エントリのコメントを設定します。

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>     エントリの名前。
  <info>string</info>  <strong>$comment</strong>  コメントの内容。

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


id: ZipArchive::setCompressionIndex
type: function
doc:
<comment>Description:</comment>
  インデックスで定義されたエントリの圧縮方法を設定する
  
  インデックスで定義されたエントリの圧縮方法を設定します。

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>      エントリのインデックス
  <info>int</info>  <strong>$method</strong>     圧縮メソッド。 <info>ZipArchive::CM_*</info> のいずれかです。
  <info>int</info>  <strong>$compflags</strong>  圧縮レベル。

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


id: ZipArchive::setCompressionName
type: function
doc:
<comment>Description:</comment>
  名前で定義されたエントリの圧縮メソッドを設定する
  
  名前で定義されたエントリの圧縮メソッドを設定します。

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>       エントリの名前
  <info>int</info>     <strong>$method</strong>     圧縮メソッド。 <info>ZipArchive::CM_*</info> のいずれかです。
  <info>int</info>     <strong>$compflags</strong>  圧縮レベル

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


id: ZipArchive::setEncryptionIndex
type: function
doc:
<comment>Description:</comment>
  index で定義されたエントリの暗号化方法を指定する
  
  index で定義されたエントリの暗号化方法を設定します。

<comment>Param:</comment>
  <info>int</info>          <strong>$index</strong>     エントリのインデックスです
  <info>int</info>          <strong>$method</strong>    ZipArchive::EM_ 定数のうちのひとつによって定義された暗号化方式
  <info>string|null</info>  <strong>$password</strong>  オプションで指定するパスワード。 指定されない場合はデフォルトの値が使われ
                          ます。

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

<comment>See Also:</comment>
   * ZipArchive::setPassword
   * ZipArchive::setEncryptionName


id: ZipArchive::setEncryptionName
type: function
doc:
<comment>Description:</comment>
  名前で定義されたエントリの暗号化方式を設定する
  
  名前で定義されたエントリの暗号化方式を設定する

<comment>Param:</comment>
  <info>string</info>       <strong>$name</strong>      エントリの名前です
  <info>int</info>          <strong>$method</strong>    ZipArchive::EM_ 定数のうちのひとつによって定義された暗号化方式
  <info>string|null</info>  <strong>$password</strong>  オプションで指定するパスワード。 指定されない場合はデフォルトの値が使われ
                          ます。

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

<comment>See Also:</comment>
   * ZipArchive::setPassword
   * ZipArchive::setEncryptionIndex


id: ZipArchive::setExternalAttributesIndex
type: function
doc:
<comment>Description:</comment>
  インデックスで定義されたエントリの外部属性を設定する
  
  インデックスで定義されたエントリの外部属性を設定します。

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  エントリのインデックス
  <info>int</info>  <strong>$opsys</strong>  ZipArchive::OPSYS_ 定数のうちのひとつで定義された、 オペレーティングシステムコード
  <info>int</info>  <strong>$attr</strong>   外部属性。 値はオペレーティングシステム依存です。
  <info>int</info>  <strong>$flags</strong>  オプションのフラグ。現在は使われていません。

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


id: ZipArchive::setExternalAttributesName
type: function
doc:
<comment>Description:</comment>
  名前で定義されたエントリの外部属性を設定する
  
  名前で定義されたエントリの外部属性を設定します。

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>   エントリの名前
  <info>int</info>     <strong>$opsys</strong>  ZipArchive::OPSYS_ 定数のうちのひとつで定義された、 オペレーティングシステムコード
  <info>int</info>     <strong>$attr</strong>   外部属性。 値はオペレーティングシステム依存です。
  <info>int</info>     <strong>$flags</strong>  オプションのフラグ。現在は使われていません。

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


id: ZipArchive::setMtimeIndex
type: function
doc:
<comment>Description:</comment>
  インデックスを使用してエントリの変更時間を設定する
  
  インデックスを使用してエントリの変更時間を設定します。

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>      エントリのインデックス
  <info>int</info>  <strong>$timestamp</strong>  ファイルの変更時間(Unixタイムスタンプ)
  <info>int</info>  <strong>$flags</strong>      オプションで指定するフラグ。現在未使用です。

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

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


id: ZipArchive::setMtimeName
type: function
doc:
<comment>Description:</comment>
  名前を使ってエントリの変更時間を設定する
  
  名前を使ってエントリの変更時間を設定します。

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>       エントリの名前
  <info>int</info>     <strong>$timestamp</strong>  ファイルの変更時間(Unixタイムスタンプ)
  <info>int</info>     <strong>$flags</strong>      オプションで指定するフラグ。現在未使用です。

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

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


id: ZipArchive::setPassword
type: function
doc:
<comment>Description:</comment>
  アクティブなアーカイブにパスワードを設定する
  
  アクティブなアーカイブにパスワードを設定します。

<comment>Param:</comment>
  <info>string</info>  <strong>$password</strong>  アーカイブに使用されるパスワード。

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

<comment>See Also:</comment>
   * ZipArchive::setEncryptionIndex
   * ZipArchive::setEncryptionName


id: ZipArchive::statIndex
type: function
doc:
<comment>Description:</comment>
  インデックスを使用してエントリの詳細を取得する
  
  この関数は、インデックスを使用してエントリの詳細情報を取得します。

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  エントリのインデックス。
  <info>int</info>  <strong>$flags</strong>  <info>ZipArchive::FL_UNCHANGED</info> を OR で連結すると、 アーカイブ内に最初に記録された際の情報
               を取得します。 変更内容は無視されます。

<comment>Return:</comment>
  <info>array|false</info>  エントリの詳細を含む配列を返します。失敗した場合に <info>false</info> を返します。


id: ZipArchive::statName
type: function
doc:
<comment>Description:</comment>
  名前を使用してエントリの詳細を取得する
  
  この関数は、名前を使用してエントリの詳細情報を取得します。

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>   エントリの名前。
  <info>int</info>     <strong>$flags</strong>  名前をどのように探すのかを設定します。 また <info>ZipArchive::FL_UNCHANGED</info> を OR で連結
                  すると、 アーカイブ内に最初に記録された際の情報を取得します。 変更内容は無視されま
                  す。 <info>ZipArchive::FL_NOCASE</info><info>ZipArchive::FL_NODIR</info><info>ZipArchive::FL_UNCHANGED</info>
                  
                  <info>ZipArchive::FL_NOCASE</info>
                  
                  <info>ZipArchive::FL_NODIR</info>
                  
                  <info>ZipArchive::FL_UNCHANGED</info>

<comment>Return:</comment>
  <info>array|false</info>  エントリの詳細を含む配列を返します。失敗した場合に <info>false</info> を返します。


id: ZipArchive::unchangeAll
type: function
doc:
<comment>Description:</comment>
  アーカイブに対するすべての変更を取り消す
  
  アーカイブに対するすべての変更を取り消します。

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


id: ZipArchive::unchangeArchive
type: function
doc:
<comment>Description:</comment>
  アーカイブ全体に対して行われたすべての変更を取り消す
  
  アーカイブ全体に対して行われたすべての変更を取り消します。 現在は、これはアーカイブのコメントに対
  する変更のみを取り消します。

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


id: ZipArchive::unchangeIndex
type: function
doc:
<comment>Description:</comment>
  指定したインデックスのエントリに対するすべての変更を取り消す
  
  指定したインデックスのエントリに対するすべての変更を取り消します。

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  エントリのインデックス。

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


id: ZipArchive::unchangeName
type: function
doc:
<comment>Description:</comment>
  指定した名前のエントリに対するすべての変更を取り消す
  
  エントリに対するすべての変更を取り消します。

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  エントリの名前。

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


id: Zookeeper::APIERROR
type: constant
doc:
<comment>Description:</comment>
  This is never thrown by the server, it shouldn't be used other than to indicate a range.
  Specifically error codes greater than this value are API errors (while values less than this
  indicate a Zookeeper::SYSTEMERROR).


id: Zookeeper::CHANGED_EVENT
type: constant
doc:
<comment>Description:</comment>
  A node has changed
  
  This is only generated by watches on nodes. These watches are set using Zookeeper::exists and
  Zookeeper::get.


id: Zookeeper::CHILD_EVENT
type: constant
doc:
<comment>Description:</comment>
  A change as occurred in the list of children
  
  This is only generated by watches on the child list of a node. These watches are set using
  Zookeeper::getChildren.


id: Zookeeper::CREATED_EVENT
type: constant
doc:
<comment>Description:</comment>
  A node has been created
  
  This is only generated by watches on non-existent nodes. These watches are set using
  Zookeeper::exists.


id: Zookeeper::DELETED_EVENT
type: constant
doc:
<comment>Description:</comment>
  A node has been deleted
  
  This is only generated by watches on nodes. These watches are set using Zookeeper::exists and
  Zookeeper::get.


id: Zookeeper::EPHEMERAL
type: constant
doc:
<comment>Description:</comment>
  If Zookeeper::EPHEMERAL flag is set, the node will automatically get removed if the client session
  goes away.


id: Zookeeper::NEWCONFIGNOQUORUM
type: constant
doc:
<comment>Description:</comment>
  No quorum of new config is connected and up-to-date with the leader of last committed config - try
  invoking reconfiguration after new servers are connected and synced.
  
  Available as of ZooKeeper 3.5.0


id: Zookeeper::NOTWATCHING_EVENT
type: constant
doc:
<comment>Description:</comment>
  A watch has been removed
  
  This is generated when the server for some reason, probably a resource constraint, will no longer
  watch a node for a client.


id: Zookeeper::RECONFIGDISABLED
type: constant
doc:
<comment>Description:</comment>
  Attempts to perform a reconfiguration operation when reconfiguration feature is disabled.


id: Zookeeper::RECONFIGINPROGRESS
type: constant
doc:
<comment>Description:</comment>
  Reconfiguration requested while another reconfiguration is currently in progress. This is
  currently not supported. Please retry.
  
  Available as of ZooKeeper 3.5.0


id: Zookeeper::SEQUENCE
type: constant
doc:
<comment>Description:</comment>
  If the Zookeeper::SEQUENCE flag is set, a unique monotonically increasing sequence number is
  appended to the path name. The sequence number is always fixed length of 10 digits, 0 padded.


id: Zookeeper::SESSION_EVENT
type: constant
doc:
<comment>Description:</comment>
  A session has been lost
  
  This is generated when a client loses contact or reconnects with a server.


id: Zookeeper::SYSTEMERROR
type: constant
doc:
<comment>Description:</comment>
  This is never thrown by the server, it shouldn't be used other than to indicate a range.
  Specifically error codes greater than this value, but lesser than Zookeeper::APIERROR, are system
  errors.


id: Zookeeper::__construct
type: function
doc:
<comment>Description:</comment>
  Create a handle to used communicate with zookeeper
  
  This method creates a new handle and a zookeeper session that corresponds to that handle. Session
  establishment is asynchronous, meaning that the session should not be considered established until
  (and unless) an event of state ZOO_CONNECTED_STATE is received.

<comment>Param:</comment>
  <info>string</info>    <strong>$host</strong>          comma separated host:port pairs, each corresponding to a zk server. e.g.
                           "127.0.0.1:3000,127.0.0.1:3001,127.0.0.1:3002"
  <info>callable</info>  <strong>$watcher_cb</strong>    the global watcher callback function. When notifications are triggered
                           this function will be invoked.
  <info>int</info>       <strong>$recv_timeout</strong>  the timeout for this session, only valid if the connections is currently
                           connected (ie. last watcher state is ZOO_CONNECTED_STATE).

<comment>See Also:</comment>
   * Zookeeper::connect
   * <class>ZookeeperException</class>


id: Zookeeper::addAuth
type: function
doc:
<comment>Description:</comment>
  Specify application credentials
  
  The application calls this function to specify its credentials for purposes of authentication. The
  server will use the security provider specified by the scheme parameter to authenticate the client
  connection. If the authentication request has failed: - the server connection is dropped. - the
  watcher is called with the ZOO_AUTH_FAILED_STATE value as the state parameter.

<comment>Param:</comment>
  <info>string</info>    <strong>$scheme</strong>         The id of authentication scheme. Natively supported: "digest"
                            password-based authentication
  <info>string</info>    <strong>$cert</strong>           Application credentials. The actual value depends on the scheme.
  <info>callable</info>  <strong>$completion_cb</strong>  The routine to invoke when the request completes. One of the following
                            result codes may be passed into the completion callback: - ZOK operation
                            completed successfully - ZAUTHFAILED authentication failed

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

<comment>See Also:</comment>
   * Zookeeper::create
   * Zookeeper::setAcl
   * Zookeeper::getAcl
   * ZooKeeper States
   * <class>ZookeeperException</class>


id: Zookeeper::close
type: function
doc:
<comment>Description:</comment>
  Close the zookeeper handle and free up any resources

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

<comment>See Also:</comment>
   * Zookeeper::__construct
   * Zookeeper::connect
   * <class>ZookeeperException</class>


id: Zookeeper::connect
type: function
doc:
<comment>Description:</comment>
  Create a handle to used communicate with zookeeper
  
  This method creates a new handle and a zookeeper session that corresponds to that handle. Session
  establishment is asynchronous, meaning that the session should not be considered established until
  (and unless) an event of state ZOO_CONNECTED_STATE is received.

<comment>Param:</comment>
  <info>string</info>    <strong>$host</strong>          Comma separated host:port pairs, each corresponding to a zk server. e.g.
                           "127.0.0.1:3000,127.0.0.1:3001,127.0.0.1:3002"
  <info>callable</info>  <strong>$watcher_cb</strong>    The global watcher callback function. When notifications are triggered
                           this function will be invoked.
  <info>int</info>       <strong>$recv_timeout</strong>  The timeout for this session, only valid if the connections is currently
                           connected (ie. last watcher state is ZOO_CONNECTED_STATE).

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

<comment>See Also:</comment>
   * Zookeeper::__construct
   * <class>ZookeeperException</class>


id: Zookeeper::create
type: function
doc:
<comment>Description:</comment>
  Create a node synchronously
  
  This method will create a node in ZooKeeper. A node can only be created if it does not already
  exists. The Create Flags affect the creation of nodes. If ZOO_EPHEMERAL flag is set, the node will
  automatically get removed if the client session goes away. If the ZOO_SEQUENCE flag is set, a
  unique monotonically increasing sequence number is appended to the path name.

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>   The name of the node. Expressed as a file name with slashes separating ancestors
                  of the node.
  <info>string</info>  <strong>$value</strong>  The data to be stored in the node.
  <info>array</info>   <strong>$acls</strong>   The initial ACL of the node. The ACL must not be null or empty.
  <info>int</info>     <strong>$flags</strong>  this parameter can be set to 0 for normal create or an OR of the Create Flags

<comment>Return:</comment>
  <info>string</info>  Returns the path of the new node (this might be different than the supplied path because
          of the ZOO_SEQUENCE flag) on success, and false on failure.

<comment>See Also:</comment>
   * Zookeeper::delete
   * Zookeeper::getChildren
   * ZooKeeper Permissions
   * <class>ZookeeperException</class>


id: Zookeeper::delete
type: function
doc:
<comment>Description:</comment>
  Delete a node in zookeeper synchronously

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>     The name of the node. Expressed as a file name with slashes separating ancestors
                    of the node.
  <info>int</info>     <strong>$version</strong>  The expected version of the node. The function will fail if the actual version
                    of the node does not match the expected version. If -1 is used the version check
                    will not take place.

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

<comment>See Also:</comment>
   * Zookeeper::create
   * Zookeeper::getChildren
   * <class>ZookeeperException</class>


id: Zookeeper::exists
type: function
doc:
<comment>Description:</comment>
  Checks the existence of a node in zookeeper synchronously

<comment>Param:</comment>
  <info>string</info>    <strong>$path</strong>        The name of the node. Expressed as a file name with slashes separating
                         ancestors of the node.
  <info>callable</info>  <strong>$watcher_cb</strong>  if nonzero, a watch will be set at the server to notify the client if the
                         node changes. The watch will be set even if the node does not

<comment>Return:</comment>
  <info>array</info>  Returns the value of stat for the path if the given node exists, otherwise false.

<comment>See Also:</comment>
   * Zookeeper::get
   * <class>ZookeeperException</class>


id: Zookeeper::get
type: function
doc:
<comment>Description:</comment>
  Gets the data associated with a node synchronously

<comment>Param:</comment>
  <info>string</info>    <strong>$path</strong>        The name of the node. Expressed as a file name with slashes separating
                         ancestors of the node.
  <info>callable</info>  <strong>$watcher_cb</strong>  If nonzero, a watch will be set at the server to notify the client if the
                         node changes.
  <info>array</info>     <strong>$stat</strong>        If not NULL, will hold the value of stat for the path on return.
  <info>int</info>       <strong>$max_size</strong>    Max size of the data. If 0 is used, this method will return the whole data.

<comment>Return:</comment>
  <info>string</info>  Returns the data on success, and false on failure.

<comment>See Also:</comment>
   * Zookeeper::set
   * <class>ZookeeperException</class>


id: Zookeeper::getAcl
type: function
doc:
<comment>Description:</comment>
  Gets the acl associated with a node synchronously

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>  The name of the node. Expressed as a file name with slashes separating ancestors of
                 the node.

<comment>Return:</comment>
  <info>array</info>  Return acl array on success and false on failure.

<comment>See Also:</comment>
   * Zookeeper::create
   * Zookeeper::setAcl
   * ZooKeeper Permissions
   * <class>ZookeeperException</class>


id: Zookeeper::getChildren
type: function
doc:
<comment>Description:</comment>
  Lists the children of a node synchronously

<comment>Param:</comment>
  <info>string</info>    <strong>$path</strong>        The name of the node. Expressed as a file name with slashes separating
                         ancestors of the node.
  <info>callable</info>  <strong>$watcher_cb</strong>  If nonzero, a watch will be set at the server to notify the client if the
                         node changes.

<comment>Return:</comment>
  <info>array</info>  Returns an array with children paths on success, and false on failure.

<comment>See Also:</comment>
   * Zookeeper::create
   * Zookeeper::delete
   * <class>ZookeeperException</class>


id: Zookeeper::getClientId
type: function
doc:
<comment>Description:</comment>
  Return the client session id, only valid if the connections is currently connected (ie. last
  watcher
  state is ZOO_CONNECTED_STATE)

<comment>Return:</comment>
  <info>int</info>  Returns the client session id on success, and false on failure.

<comment>See Also:</comment>
   * Zookeeper::__construct
   * Zookeeper::connect
   * Zookeeper::getState
   * ZooKeeper States
   * <class>ZookeeperException</class>


id: Zookeeper::getConfig
type: function
doc:
<comment>Description:</comment>
  Get instance of ZookeeperConfig

<comment>Return:</comment>
  <info>ZookeeperConfig</info>  Returns instance of <class>ZookeeperConfig</class>.

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


id: Zookeeper::getRecvTimeout
type: function
doc:
<comment>Description:</comment>
  Return the timeout for this session, only valid if the connections is currently connected (ie.
  last
  watcher state is ZOO_CONNECTED_STATE). This value may change after a server re-connect

<comment>Return:</comment>
  <info>int</info>  Returns the timeout for this session on success, and false on failure.

<comment>See Also:</comment>
   * Zookeeper::__construct
   * Zookeeper::connect
   * <class>ZookeeperException</class>


id: Zookeeper::getState
type: function
doc:
<comment>Description:</comment>
  Get the state of the zookeeper connection

<comment>Return:</comment>
  <info>int</info>  Returns the state of zookeeper connection on success, and false on failure.

<comment>See Also:</comment>
   * Zookeeper::__construct
   * Zookeeper::connect
   * Zookeeper::getClientId
   * ZooKeeper States
   * <class>ZookeeperException</class>


id: Zookeeper::isRecoverable
type: function
doc:
<comment>Description:</comment>
  Checks if the current zookeeper connection state can be recovered
  
  The application must close the handle and try to reconnect.

<comment>Return:</comment>
  <info>bool</info>  Returns true/false on success, and false on failure.

<comment>See Also:</comment>
   * Zookeeper::__construct
   * Zookeeper::connect
   * Zookeeper::getClientId
   * ZooKeeper States
   * <class>ZookeeperException</class>


id: Zookeeper::set
type: function
doc:
<comment>Description:</comment>
  Sets the data associated with a node

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>     The name of the node. Expressed as a file name with slashes separating ancestors
                    of the node.
  <info>string</info>  <strong>$value</strong>    The data to be stored in the node.
  <info>int</info>     <strong>$version</strong>  The expected version of the node. The function will fail if the actual version
                    of the node does not match the expected version. If -1 is used the version check
                    will not take place.
  <info>array</info>   <strong>$stat</strong>     If not NULL, will hold the value of stat for the path on return.

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

<comment>See Also:</comment>
   * Zookeeper::create
   * Zookeeper::get
   * <class>ZookeeperException</class>


id: Zookeeper::setAcl
type: function
doc:
<comment>Description:</comment>
  Sets the acl associated with a node synchronously

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>     The name of the node. Expressed as a file name with slashes separating ancestors
                    of the node.
  <info>int</info>     <strong>$version</strong>  The expected version of the path.
  <info>array</info>   <strong>$acl</strong>      The acl to be set on the path.

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

<comment>See Also:</comment>
   * Zookeeper::create
   * Zookeeper::getAcl
   * ZooKeeper Permissions
   * <class>ZookeeperException</class>


id: Zookeeper::setDebugLevel
type: function
doc:
<comment>Description:</comment>
  Sets the debugging level for the library

<comment>Param:</comment>
  <info>int</info>  <strong>$logLevel</strong>  ZooKeeper log level constants.

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

<comment>See Also:</comment>
   * ZooKeeper Log Levels
   * <class>ZookeeperException</class>


id: Zookeeper::setDeterministicConnOrder
type: function
doc:
<comment>Description:</comment>
  Enable/disable quorum endpoint order randomization
  
  If passed a true value, will make the client connect to quorum peers in the order as specified in
  the zookeeper_init() call. A false value causes zookeeper_init() to permute the peer endpoints
  which is good for more even client connection distribution among the quorum peers. ZooKeeper C
  Client uses false by default.

<comment>Param:</comment>
  <info>bool</info>  <strong>$yesOrNo</strong>  Disable/enable quorum endpoint order randomization.

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

<comment>See Also:</comment>
   * Zookeeper::__construct
   * Zookeeper::connect
   * <class>ZookeeperException</class>


id: Zookeeper::setLogStream
type: function
doc:
<comment>Description:</comment>
  Sets the stream to be used by the library for logging
  
  The zookeeper library uses stderr as its default log stream. Application must make sure the stream
  is writable. Passing in NULL resets the stream to its default value (stderr).

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  The stream to be used by the library for logging.

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

<comment>See Also:</comment>
   * Zookeeper::setDebugLevel
   * <class>ZookeeperException</class>


id: Zookeeper::setWatcher
type: function
doc:
<comment>Description:</comment>
  Set a watcher function

<comment>Param:</comment>
  <info>callable</info>  <strong>$watcher_cb</strong>  A watch will be set at the server to notify the client if the node changes.

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

<comment>See Also:</comment>
   * Zookeeper::exists
   * Zookeeper::get
   * <class>ZookeeperException</class>


id: ZookeeperConfig::add
type: function
doc:
<comment>Description:</comment>
  Add servers to the ensemble

<comment>Param:</comment>
  <info>string</info>  <strong>$members</strong>  Comma separated list of servers to be added to the ensemble. Each has a
                    configuration line for a server to be added (as would appear in a configuration
                    file), only for maj. quorums.
  <info>int</info>     <strong>$version</strong>  The expected version of the node. The function will fail if the actual version
                    of the node does not match the expected version. If -1 is used the version check
                    will not take place.
  <info>array</info>   <strong>$stat</strong>     If not NULL, will hold the value of stat for the path on return.

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

<comment>See Also:</comment>
   * ZookeeperConfig::get
   * ZookeeperConfig::set
   * ZookeeperConfig::remove
   * <class>ZookeeperException</class>


id: ZookeeperConfig::get
type: function
doc:
<comment>Description:</comment>
  Gets the last committed configuration of the ZooKeeper cluster as it is known to the server to
  which
  the client is connected, synchronously

<comment>Param:</comment>
  <info>callable</info>  <strong>$watcher_cb</strong>  If nonzero, a watch will be set at the server to notify the client if the
                         node changes.
  <info>array</info>     <strong>$stat</strong>        If not NULL, will hold the value of stat for the path on return.

<comment>Return:</comment>
  <info>string</info>  Returns the configuration string on success, and false on failure.

<comment>See Also:</comment>
   * ZookeeperConfig::set
   * ZookeeperConfig::add
   * ZookeeperConfig::remove
   * <class>ZookeeperException</class>


id: ZookeeperConfig::remove
type: function
doc:
<comment>Description:</comment>
  Remove servers from the ensemble

<comment>Param:</comment>
  <info>string</info>  <strong>$id_list</strong>  Comma separated list of server IDs to be removed from the ensemble. Each has an
                    id of a server to be removed, only for maj. quorums.
  <info>int</info>     <strong>$version</strong>  The expected version of the node. The function will fail if the actual version
                    of the node does not match the expected version. If -1 is used the version check
                    will not take place.
  <info>array</info>   <strong>$stat</strong>     If not NULL, will hold the value of stat for the path on return.

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

<comment>See Also:</comment>
   * ZookeeperConfig::get
   * ZookeeperConfig::add
   * ZookeeperConfig::set
   * <class>ZookeeperException</class>


id: ZookeeperConfig::set
type: function
doc:
<comment>Description:</comment>
  Change ZK cluster ensemble membership and roles of ensemble peers

<comment>Param:</comment>
  <info>string</info>  <strong>$members</strong>  Comma separated list of new membership (e.g., contents of a membership
                    configuration file) - for use only with a non-incremental reconfiguration.
  <info>int</info>     <strong>$version</strong>  The expected version of the node. The function will fail if the actual version
                    of the node does not match the expected version. If -1 is used the version check
                    will not take place.
  <info>array</info>   <strong>$stat</strong>     If not NULL, will hold the value of stat for the path on return.

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

<comment>See Also:</comment>
   * ZookeeperConfig::get
   * ZookeeperConfig::add
   * ZookeeperConfig::remove
   * <class>ZookeeperException</class>


id: ZookeeperMarshallingException
type: class
doc:
<comment>Description:</comment>
  The ZooKeeper exception (while marshalling or unmarshalling data) handling class.


id: ZookeeperNoNodeException
type: class
doc:
<comment>Description:</comment>
  The ZooKeeper exception (when node does not exist) handling class.


id: __CLASS__
type: constant
doc:
<comment>Description:</comment>
  クラス名。 クラス名には、そのクラスが宣言されている名前空間も含みます (例 <return>Foo\Bar</return>)。 トレイトのメ
  ソッド内で __CLASS__ を使うと、 そのトレイトを use しているクラスの名前を返します。


id: __DIR__
type: constant
doc:
<comment>Description:</comment>
  そのファイルの存在するディレクトリ。include の中で使用すると、 インクルードされるファイルの存在す
  るディレクトリを返します。 つまり、これは <return>dirname(__FILE__)</return> と同じ意味です。 ルートディレクトリで
  ある場合を除き、ディレクトリ名の末尾にスラッシュはつきません。


id: __FILE__
type: constant
doc:
<comment>Description:</comment>
  ファイルのフルパスとファイル名 (シンボリックリンクを解決した後のもの)。 インクルードされるファイル
  の中で使用された場合、インクルードされるファイルの名前が返されます。


id: __autoload
type: function
doc:
<comment>Description:</comment>
  未定義のクラスのロードを試みる
  
  この関数を定義すれば、クラスのオートローディング を有効にできます。

<comment>Param:</comment>
  <info>string</info>  <strong>$class</strong>  ロードするクラスの名前。

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

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


id: __halt_compiler
type: function
doc:
<comment>Description:</comment>
  コンパイラの実行を中止する
    
  
  コンパイラの実行を中止します。 これは、インストール用ファイルのようなデータを PHP スクリプトに埋め
  込んでいる場合に便利です。
  
  データの開始位置（バイト値）は、定数 <info>__COMPILER_HALT_OFFSET__</info> で定義されています。 これはファイル
  内で <strong>__halt_compiler()</strong> が使用されている場合にのみ存在します。

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


id: abs
type: function
doc:
<comment>Description:</comment>
  絶対値
  
  <strong>$num</strong> の絶対値を返します。

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

<comment>Return:</comment>
  <info>int|float</info>  <strong>$num</strong> の絶対値を返します。もし <strong>$num</strong> の型が <info>float</info> であった場合、 戻り値の型も <info>float</info> とな
             ります。それ以外の場合は 戻り値の型は <info>int</info> となります（<info>float</info> は、 <info>int</info> の最大値より大きい
             値をとることがありえるからです）。

<comment>See Also:</comment>
   * <strong>gmp_abs()</strong>
   * <strong>gmp_sign()</strong>


id: acos
type: function
doc:
<comment>Description:</comment>
  逆余弦（アークコサイン）
  
  <strong>$num</strong> のアークコサインをラジアンで返します。 <strong>acos()</strong> は <strong>cos()</strong> の逆関数です。 つまり、<strong>acos()</strong> の定義域
  にある <strong>$num</strong> の全ての値に対して、$num == cos(acos($num)) が成立します。

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

<comment>Return:</comment>
  <info>float</info>  <strong>$num</strong> のアークコサインをラジアンで返します。

<comment>See Also:</comment>
   * <strong>cos()</strong>
   * <strong>acosh()</strong>
   * <strong>asin()</strong>
   * <strong>atan()</strong>


id: acosh
type: function
doc:
<comment>Description:</comment>
  逆双曲線余弦（アークハイパボリックコサイン）
  
  <strong>$num</strong> のアークハイパボリックコサインを返します。 つまり、ハイパボリックコサインが <strong>$num</strong> となる値で
  す。

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

<comment>Return:</comment>
  <info>float</info>  <strong>$num</strong> のアークハイパボリックコサインを返します。

<comment>See Also:</comment>
   * <strong>cosh()</strong>
   * <strong>acos()</strong>
   * <strong>asinh()</strong>
   * <strong>atanh()</strong>


id: addcslashes
type: function
doc:
<comment>Description:</comment>
  C 言語と同様にスラッシュで文字列をクォートする
  
  <strong>$characters</strong> パラメータに羅列された文字の前にバックスラッシュを付けた文字列を返します。

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>      エスケープしたい文字列。
  <info>string</info>  <strong>$characters</strong>  エスケープの対象となる文字を並べたもの。 <strong>$characters</strong> が <return>\n</return>, <return>\r</return> 等の文字を含ん
                       でいる場合、 C言語と同様の手法によりエスケープされます。 アスキーコードが32未
                       満または126より大きい文字は、8進表現に変換されます。
                       
                       <strong>$characters</strong> 引数の文字の列びを定義する際には、 範囲の最初と最後で指定する文字
                       集合に含まれる文字の種類を把握するようにしてください。
                       ]]> また、ある範囲を指定する最初の文字がその範囲の2番目の文字よりも大きな
                       ASCII 値を有している場合、範囲は定義されません。 最初と最後の文字とピリオド文
                       字のみがエスケープされます。 ある文字の ASCII 値を見つけるには、 <strong>ord()</strong> 関数を
                       使用してください。
                       ]]>
                       
                       0, a, b, f, n, r, t そして v といった文字をエスケープするときには注意しましょ
                       う。 変換結果はそれぞれ \0, \a, \b, \f, \n, \r, \t そして \v となりますが、
                       これらはすべて、C 言語では定義済みのエスケープシーケンスです。 その多くは C
                       言語に由来する他の言語でもエスケープシーケンスとして定義されており、 PHP も例
                       外ではありません。つまり、<strong>$characters</strong> にこれらの文字を定義した状態で
                       <strong>addcslashes()</strong> を使って他の言語のコードを生成したときに、 期待通りの結果が得ら
                       れない可能性があるということです。

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

<comment>See Also:</comment>
   * <strong>stripcslashes()</strong>
   * <strong>stripslashes()</strong>
   * <strong>addslashes()</strong>
   * <strong>htmlspecialchars()</strong>
   * <strong>quotemeta()</strong>


id: addslashes
type: function
doc:
<comment>Description:</comment>
  文字列をスラッシュでクォートする
  
  エスケープすべき文字の前にバックスラッシュを付けて返します。 エスケープすべき文字とは、以下のとお
  りです。 シングルクォート (<return>'</return>)ダブルクォート (<return>"</return>)バックスラッシュ (<return>\</return>)NUL (<info>null</info> バイト)
  
  <strong>addslashes()</strong> 関数 を使うケースとして、 PHPが評価する文字列データに含まれる、既に述べた文字をエス
  ケープする場合があります。
  ]]>
  
  <strong>addslashes()</strong> 関数は、 SQLインジェクション を防止しようとして誤った使い方がされることがあります。
  この関数を使うのではなく、データベース特有のエスケープ関数 および/もしくは プリペアドステートメン
  トを使うようにしてください。

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  エスケープしたい文字列。

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

<comment>See Also:</comment>
   * <strong>stripcslashes()</strong>
   * <strong>stripslashes()</strong>
   * <strong>addcslashes()</strong>
   * <strong>htmlspecialchars()</strong>
   * <strong>quotemeta()</strong>
   * <strong>get_magic_quotes_gpc()</strong>


id: apache_child_terminate
type: function
doc:
<comment>Description:</comment>
  このリクエストの後にApacheプロセスを終了する
  
  <strong>apache_child_terminate()</strong> は、カレントのPHPリク エストを実行しているApacheプロセスをリクエスト終了
  時点で終了しま す。この関数は、メモリ消費量が大きなスクリプトを実行した後プロセ スを使用するために
  使用することが可能です。これは、メモリは通常内 部的にのみ解放され、オペレーティングシステムに戻さ
  れないためです。
  
  この関数は、Apache, FastCGI ウェブサーバーで動作します。

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

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


id: apache_get_modules
type: function
doc:
<comment>Description:</comment>
  ロードされた Apache モジュールのリストを取得する
  
  ロードされた Apache モジュールのリストを取得します。

<comment>Return:</comment>
  <info>array</info>  ロードされた Apache モジュールの配列 <info>array</info> を返します。


id: apache_get_version
type: function
doc:
<comment>Description:</comment>
  Apache のバージョンを取得する
  
  Apache のバージョンを取得します。

<comment>Return:</comment>
  <info>string|false</info>  成功時は Apache のバージョン、失敗した場合に <info>false</info> を返します。

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


id: apache_getenv
type: function
doc:
<comment>Description:</comment>
  Apache の subprocess_env 変数を取得する
  
  <strong>$variable</strong> で指定された Apache 環境変数を取得します。

<comment>Param:</comment>
  <info>string</info>  <strong>$variable</strong>     Apache の環境変数を指定します。
  <info>bool</info>    <strong>$walk_to_top</strong>  全ての Apache レイヤについてのトップレベル変数を取得するかどうか を指定しま
                        す。

<comment>Return:</comment>
  <info>string|false</info>  成功時は Apache 環境変数の値、失敗時は <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>apache_setenv()</strong>
   * <strong>getenv()</strong>
   * スーパーグローバル


id: apache_lookup_uri
type: function
doc:
<comment>Description:</comment>
  リクエストの一部を指定したURIに対して行い、全ての情報を返す
    
  
  この関数は、URIにリクエストの一部を行います。このリクエストは指定した リソースに関する全ての重要な
  情報を得るのに十分なものです。
  
  この関数は、
  PHP が apache モジュールとしてインストールされた場合のみサポートされます。

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  リクエストされているファイル名 (URI)。

<comment>Return:</comment>
  <info>object|false</info>  URI に関する情報のオブジェクトです。返される <info>object</info> のプロパティは次のようなもので
                す。
                
                
                statusthe_requeststatus_linemethodcontent_typehandlerurifilenamepath_infoargsboundaryno_cacheno_local_copyallowedsend_bodyctbytes_sentbyterangeclengthunparsed_urimtimerequest_time
                
                失敗時に <info>false</info> を返します。


id: apache_note
type: function
doc:
<comment>Description:</comment>
  Apacheリクエスト記号(note)を取得/設定する
  
  この関数は、Apache の <return>table_get</return> および <return>table_set</return> のラッパーです。 リクエスト中に存在する note の
  テーブルを編集します。 このテーブルは、Apache モジュール間の通信に用いるものです。
  
  <strong>apache_note()</strong> の主な使用法は、 同一リクエスト内でのモジュール間の情報のやりとりです。

<comment>Param:</comment>
  <info>string</info>       <strong>$note_name</strong>   記号の名前
  <info>string|null</info>  <strong>$note_value</strong>  記号の値

<comment>Return:</comment>
  <info>string|false</info>  <strong>$note_value</strong> が省略されるか、<info>null</info> の場合、 <return>note_name</return> の現在の値が返されます。 そうで
                ない場合、記号<return>note_name</return> の値を<return>note_value</return>にセットし、前の記号 <return>note_name</return>の値を返しま
                す。 もし記号が処理できない場合、<info>false</info> が返されます。

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


id: apache_request_headers
type: function
doc:
<comment>Description:</comment>
  すべての HTTP リクエストヘッダを取得する
  
  現在のリクエストにおけるすべての HTTP リクエストヘッダを取得します。 Apache, FastCGI, CLI, FPM
  ウェブサーバーで動作します。

<comment>Return:</comment>
  <info>array</info>  現在のリクエストにおけるすべての HTTP ヘッダの連想配列、 あるいは失敗時は <info>false</info> を返しま
         す。

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


id: apache_response_headers
type: function
doc:
<comment>Description:</comment>
  HTTPレスポンスヘッダを全て取得する
    
  
  全てのApacheレスポンスヘッダを配列として取得します。 Apache, FastCGI, CLI, FPM ウェブサーバーで動
  作します。

<comment>Return:</comment>
  <info>array|false</info>  全てのApacheレスポンスヘッダの配列、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>apache_request_headers()</strong>
   * <strong>headers_sent()</strong>
   * <strong>headers_list()</strong>


id: apache_setenv
type: function
doc:
<comment>Description:</comment>
  Apacheサブプロセスの環境変数を設定する
  
  <strong>apache_setenv()</strong> は <strong>$variable</strong> で指定された Apache 環境変数の値を設定します。
  
  Apache 環境変数を設定しても、対応する $_SERVER の値は変更されません。

<comment>Param:</comment>
  <info>string</info>  <strong>$variable</strong>     設定する環境変数
  <info>string</info>  <strong>$value</strong>        <strong>$variable</strong> の新しい値
  <info>bool</info>    <strong>$walk_to_top</strong>  全ての Apache レイヤに対して有効なトップレベルの変数を設定するかどうか

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

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


id: apcu_add
type: function
doc:
<comment>Description:</comment>
  新規の変数をデータ領域にキャッシュする
    
  
  まだ保存されていない場合にのみ、変数をデータ領域にキャッシュします。
  
  PHP の他の多くの仕組みと異なり、<strong>apcu_add()</strong>  を用いて格納された変数はリクエストを超えて （その値が
  キャッシュから取り除かれるまで）持続します。

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>     この名前を用いて変数を格納します。<strong>$key</strong> は キャッシュ内で一意です。そのため、
                   <strong>apcu_add()</strong> を使用して同一の <strong>$key</strong>  で新しい値を格納しようとしても、それは保存され
                   ません。 かわりに <info>false</info> が返されます (これが、<strong>apcu_add()</strong> と <strong>apcu_store()</strong> の唯一の
                   相違点です)。
  <info>mixed</info>   <strong>$var</strong>     格納する変数。
  <info>int</info>     <strong>$ttl</strong>     有効期間。<strong>$var</strong> は、キャッシュに <strong>$ttl</strong> 秒間だけ格納されます。 <strong>$ttl</strong> が経過すると、格
                   納されている変数は （次のリクエスト時に）キャッシュから削除されます。 <strong>$ttl</strong> が指定
                   されていない（あるいは <strong>$ttl</strong> が <return>0</return> の場合）は、 キャッシュから手動で削除される・あ
                   るいはキャッシュに存在できなくなる （clear, restart など）まで値が持続します。
  <info>array</info>   <strong>$values</strong>  名前をキー、変数を値に指定します。

<comment>Return:</comment>
  <info>bool</info>  何かがキャッシュに正しく追加されたときに TRUE、それ以外の場合に FALSE を返します。 二番目の
        構文は、エラーになったキーを含む配列を返します。

<comment>See Also:</comment>
   * <strong>apcu_store()</strong>
   * <strong>apcu_fetch()</strong>
   * <strong>apcu_delete()</strong>


id: apcu_cache_info
type: function
doc:
<comment>Description:</comment>
  APCu のデータから、キャッシュされた情報を取得する
    
  
  APC のデータから、キャッシュされた情報およびメタデータを取得します。

<comment>Param:</comment>
  <info>bool</info>  <strong>$limited</strong>  <strong>$limited</strong> が <info>true</info> の場合は、 戻り値にキャッシュエントリの個々の一覧が含まれません。
                  これは、統計情報の収集時に呼び出しを最適化したい場合などに有用です。

<comment>Return:</comment>
  <info>array|false</info>  キャッシュされたデータ（およびメタデータ）の配列を返します。 失敗した場合に <info>false</info> を
               返します
               
               もし APC キャッシュのデータを取得できなかった場合、 <strong>apcu_cache_info()</strong> は警告を発生し
               ます。これが起こるのは、 一般的には APC が有効になっていない場合などです。

<comment>See Also:</comment>
   * APCu 設定ディレクティブ
   * APCUIterator::getTotalSize
   * APCUIterator::getTotalHits
   * APCUIterator::getTotalCount


id: apcu_cas
type: function
doc:
<comment>Description:</comment>
  古い値を新しい値に更新する
  
  <strong>apcu_cas()</strong> は、既に保存されている整数値が <strong>$old</strong> パラメータにマッチする値のときに、それを <strong>$new</strong> パラ
  メータの値に更新します。

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>  更新する値のキー。
  <info>int</info>     <strong>$old</strong>  古い値 (現在保存されている値)。
  <info>int</info>     <strong>$new</strong>  新しく更新したい値。

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

<comment>See Also:</comment>
   * <strong>apcu_dec()</strong>
   * <strong>apcu_store()</strong>


id: apcu_clear_cache
type: function
doc:
<comment>Description:</comment>
  APCu キャッシュをクリアする
    
  
  キャッシュをクリアします。

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

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


id: apcu_dec
type: function
doc:
<comment>Description:</comment>
  保存した数値を減らす
  
  保存した整数値を減らします。

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>      減らしたい値のキー。
  <info>int</info>     <strong>$step</strong>     減らしたい数。
  <info>bool</info>    <strong>$success</strong>  この参照渡しの変数に、成功したか失敗したかの結果が格納されます。
  <info>int</info>     <strong>$ttl</strong>      (既存の値を減らすのではなく) 新しい値を挿入する操作に使うTTL

<comment>Return:</comment>
  <info>int|false</info>  成功した場合に <strong>$key</strong> の現在値を返します。 失敗した場合に <info>false</info> を返します

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


id: apcu_delete
type: function
doc:
<comment>Description:</comment>
  格納されている変数をキャッシュから取り除く
    
  
  格納されている変数をキャッシュから取り除きます。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$key</strong>  単一のキーの文字列、複数のキーの文字列の配列、 または <class>APCUIterator</class> オブジェクトとして
               値を格納するために使用されるキー。

<comment>Return:</comment>
  <info>mixed</info>  <strong>$key</strong> が <info>array</info> の場合、 インデックスが振られた <info>array</info> のキーが返されます。 そうでない場合、成
         功したら <info>true</info> 失敗したら <info>false</info> が返されます。

<comment>See Also:</comment>
   * <strong>apcu_store()</strong>
   * <strong>apcu_fetch()</strong>
   * <strong>apcu_clear_cache()</strong>
   * <class>APCUIterator</class>


id: apcu_enabled
type: function
doc:
<comment>Description:</comment>
  現在の環境で apcu が使えるかを確認する
  
  現在の環境で apcu が使えるかどうかを返します。

<comment>Return:</comment>
  <info>bool</info>  現在の環境で apcu が使えるなら <info>true</info> を、そうでなければ <info>false</info> を返します。


id: apcu_entry
type: function
doc:
<comment>Description:</comment>
  アトミックに値を取得するか、キャッシュエントリを生成する
    
  
  キャッシュに <strong>$key</strong> が存在するかをアトミックに検索します。 存在しなければ <strong>$generator</strong> が呼び出され、
  <strong>$key</strong> が唯一の引数として渡されます。 <strong>$generator</strong> ではオプションで指定する <strong>$ttl</strong> の間だけ値をキャッ
  シュし、 キャッシュした値が返されます。
  
  <strong>apcu_entry()</strong> 関数に制御が移ると、 キャッシュのロックを排他的に取得します。 このロックは
  <strong>apcu_entry()</strong> の実行が終わったときに開放されます: この結果、<strong>$generator</strong> はクリティカルセクションに入
  るため、 ふたつのプロセスが同時に同じコードパスを実行することができなくなります。 さらに、他の
  APCuのあらゆる関数も同時に並列に実行できなくなります。 なぜなら、同じロックを共有しているからで
  す。
  
  <strong>$generator</strong> から安全に呼び出せるAPCuの関数は <strong>apcu_entry()</strong> だけです。

<comment>Param:</comment>
  <info>string</info>    <strong>$key</strong>        キャッシュエントリのキー。
  <info>callable</info>  <strong>$generator</strong>  <strong>$key</strong> を唯一の引数として取り、 キャッシュする値を返す関数
  <info>int</info>       <strong>$ttl</strong>        有効期間。<strong>$var</strong> は、キャッシュに <strong>$ttl</strong> 秒間だけ格納されます。 <strong>$ttl</strong> が経過する
                        と、格納されている変数は （次のリクエスト時に）キャッシュから削除されます。
                        <strong>$ttl</strong> が指定されていない（あるいは <strong>$ttl</strong> が <return>0</return> の場合）は、 キャッシュから手動
                        で削除される・あるいはキャッシュに存在できなくなる （clear, restart など）ま
                        で値が持続します。

<comment>Return:</comment>
  <info>mixed</info>  キャッシュされた値を返します。

<comment>See Also:</comment>
   * <strong>apcu_store()</strong>
   * <strong>apcu_fetch()</strong>
   * <strong>apcu_delete()</strong>


id: apcu_exists
type: function
doc:
<comment>Description:</comment>
  エントリが存在するかどうかを調べる
  
  指定した APCu エントリが存在するかどうかを調べます。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$keys</strong>  キーを含む文字列、あるいは文字列の配列。

<comment>Return:</comment>
  <info>mixed</info>  キーが存在する場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。 <strong>$keys</strong> に配列を渡したときは、
         存在するキーをすべて含む配列を返します。 どれも存在しない場合は空の配列を返します。

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


id: apcu_fetch
type: function
doc:
<comment>Description:</comment>
  格納されている変数をキャッシュから取得する
    
  
  エントリをキャッシュから取得します。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$key</strong>      (<strong>apcu_store()</strong> を用いて) 値を格納する際に使用された <strong>$key</strong>。 配列を渡した場合は、各
                   要素について取得した値を返します。
  <info>bool</info>   <strong>$success</strong>  成功した場合に <info>true</info>、失敗した際に <info>false</info> が設定されます。

<comment>Return:</comment>
  <info>mixed</info>  成功した場合に格納されていた変数 (あるいは配列)、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>apcu_store()</strong>
   * <strong>apcu_delete()</strong>
   * <class>APCUIterator</class>


id: apcu_inc
type: function
doc:
<comment>Description:</comment>
  保存した数値を増やす
  
  保存した整数値を増やします。

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>      増やしたい値のキー。
  <info>int</info>     <strong>$step</strong>     増やしたい数。
  <info>bool</info>    <strong>$success</strong>  この参照渡しの変数に、成功したか失敗したかの結果が格納されます。
  <info>int</info>     <strong>$ttl</strong>      (既存の値を増やすのではなく) 新しい値を挿入する操作に使うTTL

<comment>Return:</comment>
  <info>int|false</info>  成功した場合に <strong>$key</strong> の現在値を返します。 失敗した場合に <info>false</info> を返します

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


id: apcu_key_info
type: function
doc:
<comment>Description:</comment>
  キャッシュのキーに関する詳細な情報を取得する
    
  
  キャッシュのキーに関する詳細な情報を取得します。

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>  キャッシュのキー

<comment>Return:</comment>
  <info>array|null</info>  キャッシュのキーに関する、詳細な情報を含む配列を返します。 キーが存在しない場合、<info>null</info>
              を返します。

<comment>See Also:</comment>
   * <strong>apcu_store()</strong>
   * <strong>apcu_fetch()</strong>
   * <strong>apcu_delete()</strong>


id: apcu_sma_info
type: function
doc:
<comment>Description:</comment>
  APCu の共有メモリ割り当てに関する情報を取得する
    
  
  APCu の共有メモリ割り当てに関する情報を取得します。

<comment>Param:</comment>
  <info>bool</info>  <strong>$limited</strong>  <info>false</info> (デフォルト) を設定すると、<strong>apcu_sma_info()</strong> は各セグメントの詳細な情報を返し
                  ます。

<comment>Return:</comment>
  <info>array|false</info>  共有メモリ割り当てデータの配列を返します。失敗した場合は <info>false</info> を返します。

<comment>See Also:</comment>
   * APCu 設定ディレクティブ


id: apcu_store
type: function
doc:
<comment>Description:</comment>
  変数をデータ領域にキャッシュする
    
  
  変数をデータ領域にキャッシュします。
  
  PHP の他の多くの仕組みと異なり、<strong>apcu_store()</strong>  を用いて格納された変数はリクエストを超えて （その値
  がキャッシュから取り除かれるまで）持続します。

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>     この名前を用いて変数を格納します。<strong>$key</strong> は キャッシュ内で一意です。そのため、同一
                   の <strong>$key</strong>  で新しい値を格納すると、元の値は上書きされます。
  <info>mixed</info>   <strong>$var</strong>     格納する変数。
  <info>int</info>     <strong>$ttl</strong>     有効期間。<strong>$var</strong> は、キャッシュに <strong>$ttl</strong> 秒間だけ格納されます。 <strong>$ttl</strong> が経過すると、格
                   納されている変数は （次のリクエスト時に）キャッシュから削除されます。 <strong>$ttl</strong> が指定
                   されていない（あるいは <strong>$ttl</strong> が <return>0</return> の場合）は、 キャッシュから手動で削除される・あ
                   るいはキャッシュに存在できなくなる （clear, restart など）まで値が持続します。
  <info>array</info>   <strong>$values</strong>  名前をキー、変数を値に指定します。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。 二番目の構文は、エラーになったキー
        を含む配列を返します。

<comment>See Also:</comment>
   * <strong>apcu_add()</strong>
   * <strong>apcu_fetch()</strong>
   * <strong>apcu_delete()</strong>


id: array
type: function
doc:
<comment>Description:</comment>
  配列を生成する
  
  配列を作成します。 配列に関するより詳しい情報は配列型 のセクションをご覧ください。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$values</strong>  カンマで区切った構文 "index =&gt; values" で、インデックスと値を定義します。 イン
                  デックスは文字列または数値とすることが可能です。 インデックスが省略された場合、0か
                  ら始まる整数インデックスが自動的に生成されます。 インデックスが整数の場合、次に生
                  成されるインデックスは、 整数インデックスの最大値 + 1 となります。同じインデックス
                  を二度定義した場合、 後の定義により最初の定義が上書きされることに注意してくださ
                  い。
                  
                  一般的ではありませんが、 最後に定義された配列エントリの後に続くカンマがある場合、
                  これは有効な構文です。

<comment>Return:</comment>
  <info>array</info>  パラメータの配列を返します。パラメータには、 <return>=&gt;</return>演算子によりインデックスを指定することも
         できます。 配列に関するより詳しい情報は配列型 のセクションをご覧ください。

<comment>See Also:</comment>
   * <strong>array_pad()</strong>
   * <strong>list()</strong>
   * <strong>count()</strong>
   * <strong>range()</strong>
   * foreach
   * array 型


id: array_change_key_case
type: function
doc:
<comment>Description:</comment>
  配列のすべてのキーの大文字小文字を変更する
  
  <strong>$array</strong> のすべてのキーを小文字あるいは大文字にした配列を返します。 数値添字はそのままとなります。

<comment>Param:</comment>
  <info>array</info>  <strong>$array</strong>  処理を行う配列。
  <info>int</info>    <strong>$case</strong>   <info>CASE_UPPER</info> あるいは <info>CASE_LOWER</info> (デフォルト)。

<comment>Return:</comment>
  <info>array</info>  すべてのキーを小文字あるいは大文字にした配列を返します。


id: array_chunk
type: function
doc:
<comment>Description:</comment>
  配列を分割する
  
  配列を、要素数が <strong>$length</strong> の配列に分割します。 最後の部分の要素数は <strong>$length</strong> より小さくなることもあ
  ります。

<comment>Param:</comment>
  <info>array</info>  <strong>$array</strong>          処理を行う配列。
  <info>int</info>    <strong>$length</strong>         各部分のサイズ。
  <info>bool</info>   <strong>$preserve_keys</strong>  <info>true</info> の場合はキーをそのまま保持します。 デフォルトは <info>false</info> で、各部分のキー
                         をあらためて数字で振りなおします。

<comment>Return:</comment>
  <info>array</info>  数値添字の多次元配列を返します。添え字はゼロから始まり、 各次元の要素数が <strong>$length</strong> となりま
         す。

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


id: array_column
type: function
doc:
<comment>Description:</comment>
  入力配列から単一のカラムの値を返す
  
  <strong>array_column()</strong> は、 配列 <strong>$array</strong> の中から <strong>$column_key</strong> で指定した単一のカラムの値を返します。 オプ
  ションで <strong>$index_key</strong> も指定できます。 これを指定すると、 入力配列内のカラム <strong>$index_key</strong> の値をキーと
  し、 カラム <strong>$column_key</strong> を値とした配列が返されます。

<comment>Param:</comment>
  <info>array</info>            <strong>$array</strong>       値を取り出したい多次元配列 (あるいはオブジェクトの配列)。 オブジェク
                                トの配列を指定した場合は、public プロパティはそのまま取得できます。
                                protected や private なプロパティを取得したい場合は、そのクラスがマ
                                ジックメソッド <strong>__get()</strong> および <strong>__isset()</strong> を実装している必要がありま
                                す。
  <info>int|string|null</info>  <strong>$column_key</strong>  値を返したいカラム。 取得したいカラムの番号を整数値で指定することも
                                できるし、 連想配列のキーやプロパティの名前を指定することもできま
                                す。 <info>null</info> を指定すると、配列やオブジェクト全体を返します (<strong>$index_key</strong>
                                との組み合わせで、配列の並べ替えをするときに便利です)。
  <info>int|string|null</info>  <strong>$index_key</strong>   返す配列のインデックス/キーとして使うカラム。 カラム番号を表す整数
                                値、あるいはキーの名前を表す文字列になります。 この値は、いつものよ
                                うに配列のキーとして キャストされます。 (PHP 8.0.0 より前のバージョ
                                ンでは、 文字列への変換をサポートしているオブジェクトも許可されてい
                                ました)

<comment>Return:</comment>
  <info>array</info>  入力配列の単一のカラムを表す値の配列を返します。


id: array_combine
type: function
doc:
<comment>Description:</comment>
  一方の配列をキーとして、もう一方の配列を値として、ひとつの配列を生成する
    
  
  <strong>$keys</strong> 配列の値をキーとして、また <strong>$values</strong> 配列の値を対応する値として生成した <info>配列</info> を作成します。

<comment>Param:</comment>
  <info>array</info>  <strong>$keys</strong>    キーとして使用する配列。無効な値を渡すと文字列に変換されます。
  <info>array</info>  <strong>$values</strong>  値として使用する配列。

<comment>Return:</comment>
  <info>array</info>  作成した配列を返します。

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


id: array_count_values
type: function
doc:
<comment>Description:</comment>
  配列内に存在する、異なる値の出現回数を数える
  
  <strong>array_count_values()</strong> は、 配列 <strong>$array</strong> の値 (数値または文字列でなければいけません) をキーとし、
  <strong>$array</strong> におけるその値の出現回数を値とした配列を返します。

<comment>Param:</comment>
  <info>array</info>  <strong>$array</strong>  値を数える配列。

<comment>Return:</comment>
  <info>array</info>  <strong>$array</strong> のキーとその登場回数を組み合わせた連想配列を返します。

<comment>See Also:</comment>
   * <strong>count()</strong>
   * <strong>array_unique()</strong>
   * <strong>array_values()</strong>
   * <strong>count_chars()</strong>


id: array_diff
type: function
doc:
<comment>Description:</comment>
  配列の差を計算する
  
  <strong>$array</strong> を他の配列と比較し、 <strong>$array</strong> の要素の中で他の配列には存在しないものだけを返します。

<comment>Param:</comment>
  <info>array</info>  <strong>$array</strong>   比較元の配列。
  <info>array</info>  <strong>$arrays</strong>  比較対象の配列。

<comment>Return:</comment>
  <info>array</info>  <strong>$array</strong> のエントリのうち、他のどの配列にも含まれない要素のみを含む配列を返します。 <strong>$array</strong> の
         配列のキーは維持されます。

<comment>See Also:</comment>
   * <strong>array_diff_assoc()</strong>
   * <strong>array_udiff()</strong>
   * <strong>array_intersect()</strong>
   * <strong>array_intersect_assoc()</strong>


id: array_diff_assoc
type: function
doc:
<comment>Description:</comment>
  追加された添字の確認を含めて配列の差を計算する
  
  <strong>$array</strong> を <strong>$arrays</strong> と比較し、 その差を返します。<strong>array_diff()</strong> とは異なり、 配列のキーも用いて比較を
  行います。

<comment>Param:</comment>
  <info>array</info>  <strong>$array</strong>   比較元の配列。
  <info>array</info>  <strong>$arrays</strong>  比較する対象となる配列。

<comment>Return:</comment>
  <info>array</info>  <strong>$array</strong> の要素のうち、 その他の配列のいずれにも含まれないものだけを残した配列を返します。

<comment>See Also:</comment>
   * <strong>array_diff()</strong>
   * <strong>array_diff_uassoc()</strong>
   * <strong>array_udiff_assoc()</strong>
   * <strong>array_udiff_uassoc()</strong>
   * <strong>array_intersect()</strong>
   * <strong>array_intersect_assoc()</strong>


id: array_diff_key
type: function
doc:
<comment>Description:</comment>
  キーを基準にして配列の差を計算する
  
  <strong>$array</strong> のキーを <strong>$arrays</strong> のキーと比較し、その差を返します。 この関数は <strong>array_diff()</strong> に似ています
  が、 値ではなくキーを用いて比較するという点が異なります。

<comment>Param:</comment>
  <info>array</info>  <strong>$array</strong>   比較元の配列。
  <info>array</info>  <strong>$arrays</strong>  比較する対象となる配列。

<comment>Return:</comment>
  <info>array</info>  <strong>$array</strong> の要素のうち、 その他の配列のいずれにも含まれないキーのものだけを残した配列を返しま
         す。

<comment>See Also:</comment>
   * <strong>array_diff()</strong>
   * <strong>array_udiff()</strong>
   * <strong>array_diff_assoc()</strong>
   * <strong>array_diff_uassoc()</strong>
   * <strong>array_udiff_assoc()</strong>
   * <strong>array_udiff_uassoc()</strong>
   * <strong>array_diff_ukey()</strong>
   * <strong>array_intersect()</strong>
   * <strong>array_intersect_assoc()</strong>
   * <strong>array_intersect_uassoc()</strong>
   * <strong>array_intersect_key()</strong>
   * <strong>array_intersect_ukey()</strong>


id: array_diff_uassoc
type: function
doc:
<comment>Description:</comment>
  ユーザーが指定したコールバック関数を利用し、
     追加された添字の確認を含めて配列の差を計算する
    
  
  <strong>$array</strong> のキーを <strong>$arrays</strong> のキーと比較し、その差を返します。 この関数は <strong>array_diff()</strong> に似ています
  が、 配列のキーを用いて比較するという点が異なります。
  
  <strong>array_diff_assoc()</strong> とは異なり、 内部関数ではなくユーザーが指定したコールバック関数を用いて添字を比
  較します。

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

<comment>Return:</comment>
  <info>array</info>  <strong>$array</strong> の要素のうち、 その他の配列のいずれにも含まれないものだけを残した配列を返します。

<comment>See Also:</comment>
   * <strong>array_diff()</strong>
   * <strong>array_diff_assoc()</strong>
   * <strong>array_udiff()</strong>
   * <strong>array_udiff_assoc()</strong>
   * <strong>array_udiff_uassoc()</strong>
   * <strong>array_intersect()</strong>
   * <strong>array_intersect_assoc()</strong>
   * <strong>array_uintersect()</strong>
   * <strong>array_uintersect_assoc()</strong>
   * <strong>array_uintersect_uassoc()</strong>


id: array_diff_ukey
type: function
doc:
<comment>Description:</comment>
  キーを基準にし、コールバック関数を用いて配列の差を計算する
    
  
  <strong>$array</strong> のキーを <strong>$arrays</strong> のキーと比較し、その差を返します。 この関数は <strong>array_diff()</strong> に似ています
  が、 値ではなくキーを用いて比較するという点が異なります。
  
  <strong>array_diff_key()</strong> とは異なり、 内部関数ではなくユーザーが指定したコールバック関数を用いて添字を比較
  します。

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

<comment>Return:</comment>
  <info>array</info>  <strong>$array</strong> の要素のうち、 その他の配列のいずれにも含まれないものだけを残した配列を返します。

<comment>See Also:</comment>
   * <strong>array_diff()</strong>
   * <strong>array_udiff()</strong>
   * <strong>array_diff_assoc()</strong>
   * <strong>array_diff_uassoc()</strong>
   * <strong>array_udiff_assoc()</strong>
   * <strong>array_udiff_uassoc()</strong>
   * <strong>array_diff_key()</strong>
   * <strong>array_intersect()</strong>
   * <strong>array_intersect_assoc()</strong>
   * <strong>array_intersect_uassoc()</strong>
   * <strong>array_intersect_key()</strong>
   * <strong>array_intersect_ukey()</strong>


id: array_fill
type: function
doc:
<comment>Description:</comment>
  配列を指定した値で埋める
  
  パラメータ <strong>$value</strong> を値とする <strong>$count</strong> 個のエントリからなる配列を埋めます。 この際、キーは、
  <strong>$start_index</strong> パラメータから開始します。

<comment>Param:</comment>
  <info>int</info>    <strong>$start_index</strong>  返される配列の最初のインデックス。
                       
                       PHP 8.0.0 より前のバージョンでは、 <strong>$start_index</strong> が負の場合、 返される配列の最
                       初のインデックスが <strong>$start_index</strong> となり、それ以降のインデックスはゼロから始
                       まっていました。 PHP 8.0.0 以降のバージョンでは、 <strong>$start_index</strong> が負の場合で
                       も、 インデックスの値が通常通りインクリメントされるようになっています。 (例を
                       参照ください)。
  <info>int</info>    <strong>$count</strong>        挿入する要素数。 ゼロ以上の数でなければなりません。 かつ、<return>2147483647</return> 以下であ
                       る必要があります。
  <info>mixed</info>  <strong>$value</strong>        要素に使用する値。

<comment>Return:</comment>
  <info>array</info>  値を埋めた配列を返します。

<comment>See Also:</comment>
   * <strong>array_fill_keys()</strong>
   * <strong>str_repeat()</strong>
   * <strong>range()</strong>


id: array_fill_keys
type: function
doc:
<comment>Description:</comment>
  キーを指定して、配列を値で埋める
  
  パラメータ <strong>$value</strong> で指定した値で配列を埋めます。 キーとして、配列 <strong>$keys</strong> で指定した値を使用します。

<comment>Param:</comment>
  <info>array</info>  <strong>$keys</strong>   キーとして使用する値の配列。キーとして無効な値は <info>string</info> に変換されます。
  <info>mixed</info>  <strong>$value</strong>  埋めたい値。

<comment>Return:</comment>
  <info>array</info>  値を埋めた配列を返します。

<comment>See Also:</comment>
   * <strong>array_fill()</strong>
   * <strong>array_combine()</strong>


id: array_filter
type: function
doc:
<comment>Description:</comment>
  コールバック関数を使用して、配列の要素をフィルタリングする
    
  
  <strong>$callback</strong> 関数によりフィルタ処理が行われた <strong>$array</strong> の全ての要素を含む配列を返します。 <strong>$callback</strong> 関
  数が <info>true</info> を返した場合、 <strong>$array</strong> の現在の値が結果の配列に入ります。
  
  配列のキーは保存されます。 <strong>$array</strong> にインデックスが振られていた場合、結果が異なる場合があります。
  結果の <info>array</info> のインデックスは、 <strong>array_values()</strong> 関数を使って振り直すことができます。

<comment>Param:</comment>
  <info>array</info>          <strong>$array</strong>     処理する配列。
  <info>callable|null</info>  <strong>$callback</strong>  使用するコールバック関数。
                            
                            コールバック関数が与えられなかった場合、 <strong>$array</strong> のエントリの中で空のもの
                            はすべて削除されます。 この場合の「空」の定義については、<strong>empty()</strong> 関数を
                            参照ください。
  <info>int</info>            <strong>$mode</strong>      引数として、何を <strong>$callback</strong> に送るのかを決めるフラグ。
                            <info>ARRAY_FILTER_USE_KEY</info> - 値ではなく、キーだけを <strong>$callback</strong> の引数として渡す
                            <info>ARRAY_FILTER_USE_BOTH</info> - 値だけではなく、値とキーの両方を <strong>$callback</strong> の引
                            数として渡す デフォルトは <return>0</return> で値のみを<strong>$callback</strong>の引数として渡します。
                            
                            <info>ARRAY_FILTER_USE_KEY</info> - 値ではなく、キーだけを <strong>$callback</strong> の引数として渡す
                            
                            <info>ARRAY_FILTER_USE_BOTH</info> - 値だけではなく、値とキーの両方を <strong>$callback</strong> の引
                            数として渡す

<comment>Return:</comment>
  <info>array</info>  フィルタリングされた結果の配列を返します。

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


id: array_flip
type: function
doc:
<comment>Description:</comment>
  配列のキーと値を反転する
  
  <strong>array_flip()</strong> は、配列を反転して返します。 すなわち、<strong>$array</strong> のキーが値となり、 <strong>$array</strong> の値がキーと
  なります。
  
  <strong>$array</strong> の値は有効なキーを必要とすることに注意してください。 すなわち、キーは、<info>int</info> または <info>string</info> で
  ある必要があります。ある値が間違った型である場合、 警告が出力され、問題のこのキー/値の組は結果には
  含まれません。
  
  ある値が複数回出現した場合、最後のキーがその値として使用され、 その他の値は失われます。

<comment>Param:</comment>
  <info>array</info>  <strong>$array</strong>  反転を行うキー/値の組。

<comment>Return:</comment>
  <info>array</info>  反転した配列を返します。

<comment>See Also:</comment>
   * <strong>array_values()</strong>
   * <strong>array_keys()</strong>
   * <strong>array_reverse()</strong>


id: array_intersect
type: function
doc:
<comment>Description:</comment>
  配列の共通項を計算する
  
  <strong>array_intersect()</strong> は、他の全ての引数に存在する <strong>$array</strong> の値を全て有する配列を返します。 キーと値の
  関係は維持されることに注意してください。

<comment>Param:</comment>
  <info>array</info>  <strong>$array</strong>   値を調べるもととなる配列。
  <info>array</info>  <strong>$arrays</strong>  値を比較する対象となる配列。

<comment>Return:</comment>
  <info>array</info>  <strong>$array</strong> の値のうち、 すべての引数に存在する値のものを含む連想配列を返します。

<comment>See Also:</comment>
   * <strong>array_intersect_assoc()</strong>
   * <strong>array_diff()</strong>
   * <strong>array_diff_assoc()</strong>


id: array_intersect_assoc
type: function
doc:
<comment>Description:</comment>
  追加された添字の確認も含めて配列の共通項を確認する
  
  <strong>array_intersect_assoc()</strong> は、全ての引数に現れる <strong>$array</strong> の全ての値を含む配列を返します。
  <strong>array_intersect()</strong> と異なり、 キーも比較に使用されることに注意してください。

<comment>Param:</comment>
  <info>array</info>  <strong>$array</strong>   値を調べるもととなる配列。
  <info>array</info>  <strong>$arrays</strong>  値を比較する対象となる配列。

<comment>Return:</comment>
  <info>array</info>  <strong>$array</strong> の値のうち、すべての引数に存在するものを含む連想配列を返します。

<comment>See Also:</comment>
   * <strong>array_intersect()</strong>
   * <strong>array_uintersect_assoc()</strong>
   * <strong>array_intersect_uassoc()</strong>
   * <strong>array_uintersect_uassoc()</strong>
   * <strong>array_diff()</strong>
   * <strong>array_diff_assoc()</strong>


id: array_intersect_key
type: function
doc:
<comment>Description:</comment>
  キーを基準にして配列の共通項を計算する
  
  <strong>array_intersect_key()</strong> は、 <strong>$array</strong> のエントリのうち、 その他のすべての引数の中に共通して存在する
  キーと一致するキーの値からなる配列を返します。

<comment>Param:</comment>
  <info>array</info>  <strong>$array</strong>   値を調べるもととなる配列。
  <info>array</info>  <strong>$arrays</strong>  キーを比較する対象となる配列。

<comment>Return:</comment>
  <info>array</info>  <strong>$array</strong> のエントリのうち、 すべての引数に存在するキーのものを含む連想配列を返します。

<comment>See Also:</comment>
   * <strong>array_diff()</strong>
   * <strong>array_udiff()</strong>
   * <strong>array_diff_assoc()</strong>
   * <strong>array_diff_uassoc()</strong>
   * <strong>array_udiff_assoc()</strong>
   * <strong>array_udiff_uassoc()</strong>
   * <strong>array_diff_key()</strong>
   * <strong>array_diff_ukey()</strong>
   * <strong>array_intersect()</strong>
   * <strong>array_intersect_assoc()</strong>
   * <strong>array_intersect_uassoc()</strong>
   * <strong>array_intersect_ukey()</strong>


id: array_intersect_uassoc
type: function
doc:
<comment>Description:</comment>
  追加された添字の確認も含め、コールバック関数を用いて
    配列の共通項を確認する
  
  <strong>array_intersect_uassoc()</strong> は、全ての引数に現れる <strong>$array</strong> の全ての値を含む配列を返します。
  <strong>array_intersect()</strong> と異なり、 キーが比較に使用されることに注意してください。

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

<comment>Return:</comment>
  <info>array</info>  <strong>$array</strong> の値のうち、 すべての引数に存在するもののみを返します。

<comment>See Also:</comment>
   * <strong>array_intersect()</strong>
   * <strong>array_intersect_assoc()</strong>
   * <strong>array_uintersect_assoc()</strong>
   * <strong>array_uintersect_uassoc()</strong>
   * <strong>array_intersect_key()</strong>
   * <strong>array_intersect_ukey()</strong>


id: array_intersect_ukey
type: function
doc:
<comment>Description:</comment>
  キーを基準にし、コールバック関数を用いて
    配列の共通項を計算する
  
  <strong>array_intersect_ukey()</strong> は、他の全ての引数に存在する <strong>$array</strong> の値を全て有する配列を返します。

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

<comment>Return:</comment>
  <info>array</info>  <strong>$array</strong> の値のうち、 すべての引数に存在するキーのものを含む連想配列を返します。

<comment>See Also:</comment>
   * <strong>array_diff()</strong>
   * <strong>array_udiff()</strong>
   * <strong>array_diff_assoc()</strong>
   * <strong>array_diff_uassoc()</strong>
   * <strong>array_udiff_assoc()</strong>
   * <strong>array_udiff_uassoc()</strong>
   * <strong>array_diff_key()</strong>
   * <strong>array_diff_ukey()</strong>
   * <strong>array_intersect()</strong>
   * <strong>array_intersect_assoc()</strong>
   * <strong>array_intersect_uassoc()</strong>
   * <strong>array_intersect_key()</strong>


id: array_is_list
type: function
doc:
<comment>Description:</comment>
  指定された配列がリストかどうかをチェックする
  
  指定された <strong>$array</strong> がリストかどうかを判定します。 配列のキーが連続した数値 (<return>0</return> から <return>count($array)-1</return>)
  である場合、 リストと判定されます。

<comment>Param:</comment>
  <info>array</info>  <strong>$array</strong>  評価する配列。

<comment>Return:</comment>
  <info>bool</info>  配列がリストと判定された場合は <info>true</info> を返します。 そうでない場合は <info>false</info> を返します。

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


id: array_key_exists
type: function
doc:
<comment>Description:</comment>
  指定したキーまたは添字が配列にあるかどうかを調べる
  
  指定した <strong>$key</strong> が配列に設定されている場合、 <strong>array_key_exists()</strong> は <info>true</info> を返します。 <strong>$key</strong> は配列添字
  として使用できる全ての値を使用可能です。

<comment>Param:</comment>
  <info>string|int</info>  <strong>$key</strong>    調べる値。
  <info>array</info>       <strong>$array</strong>  キーが存在するかどうかを調べたい配列。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。
        
        <strong>array_key_exists()</strong> は、最初のレベルのキーだけを捜します。 多次元配列のネストされたキーは、こ
        の関数では見つけられません。

<comment>See Also:</comment>
   * <strong>isset()</strong>
   * <strong>array_keys()</strong>
   * <strong>in_array()</strong>
   * <strong>property_exists()</strong>


id: array_key_first
type: function
doc:
<comment>Description:</comment>
  配列の最初のキーを得る
  
  与えられた <strong>$array</strong> の最初のキーを返します。 これは内部的な配列のポインタに影響を与えません。

<comment>Param:</comment>
  <info>array</info>  <strong>$array</strong>  入力となる配列

<comment>Return:</comment>
  <info>int|string|null</info>  配列が空でなければ、 <strong>$array</strong> の最初のキーを返します。 そうでなければ、<info>null</info> を返し
                   ます。

<comment>See Also:</comment>
   * <strong>array_key_last()</strong>
   * <strong>reset()</strong>


id: array_key_last
type: function
doc:
<comment>Description:</comment>
  配列の最後のキーを得る
  
  与えられた <strong>$array</strong> の最後のキーを返します。 これは内部的な配列のポインタに影響を与えません。

<comment>Param:</comment>
  <info>array</info>  <strong>$array</strong>  入力となる配列

<comment>Return:</comment>
  <info>int|string|null</info>  配列が空でなければ、 <strong>$array</strong> の最後のキーを返します。 そうでなければ、<info>null</info> を返し
                   ます。

<comment>See Also:</comment>
   * <strong>array_key_first()</strong>
   * <strong>end()</strong>


id: array_keys
type: function
doc:
<comment>Description:</comment>
  配列のキーすべて、あるいはその一部を返す
  
  <strong>array_keys()</strong> は、配列 <strong>$array</strong> から全てのキー (数値および文字列) を返します。
  
  <strong>$filter_value</strong> が指定された場合、 指定した値に関するキーのみが返されます。指定されない場合は、
  <strong>$array</strong> から全てのキーが返されます。

<comment>Param:</comment>
  <info>array</info>  <strong>$array</strong>         返すキーを含む配列。
  <info>mixed</info>  <strong>$filter_value</strong>  指定した場合は、この値を含むキーのみを返します。
  <info>bool</info>   <strong>$strict</strong>        検索時に厳密な比較 (===) を行うかどうか。

<comment>Return:</comment>
  <info>array</info>  <strong>$array</strong> のすべてのキーを配列で返します。

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


id: array_map
type: function
doc:
<comment>Description:</comment>
  指定した配列の要素にコールバック関数を適用する
  
  <strong>array_map()</strong> は、<strong>$array</strong> (および、 それ以上の配列が与えられた場合は <strong>$arrays</strong>) の各要素に <strong>$callback</strong> を
  適用した後、 適用後の要素を含む <info>array</info> を返します。 <strong>$callback</strong> 関数が受け付けるパラメータの数は、
  <strong>array_map()</strong> に渡される配列の数に一致している必要があります。 それより配列の数が多かった場合、溢れ
  た分は無視されます。 少なかった場合、<class>ArgumentCountError</class> がスローされます。

<comment>Param:</comment>
  <info>callable|null</info>  <strong>$callback</strong>  配列の各要素に適用する <info>callable</info>。
                            
                            複数の配列に zip 操作を行うために、 <strong>$callback</strong> に <info>null</info> を渡すことができま
                            す。 <strong>$array</strong> のみが与えられた場合、 array_map は、入力された配列を返しま
                            す。
  <info>array</info>          <strong>$array</strong>     コールバック関数を適用する配列。
  <info>array</info>          <strong>$arrays</strong>    <strong>$callback</strong> に渡す引数を指定する配列の可変リスト。

<comment>Return:</comment>
  <info>array</info>  <strong>$array</strong> (および、 それ以上の配列が与えられた場合は <strong>$arrays</strong>) の各要素に <strong>$callback</strong> 関数を適用
         した後、 適用後の要素を含む <info>array</info> を返します。
         
         引数で渡した配列のキーがそのまま維持されるのは、渡した配列がひとつだけである場合のみです。
         複数の配列を渡した場合は、戻り値の配列のキーは整数値が振り直されます。

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


id: array_merge
type: function
doc:
<comment>Description:</comment>
  ひとつまたは複数の配列をマージする
  
  前の配列の後ろに配列を追加することにより、 ひとつまたは複数の配列の要素をマージし、得られた配列を
  返します。
  
  入力配列が同じキー文字列を有していた場合、そのキーに関する後に指定された値が、 前の値を上書きしま
  す。しかし、配列が同じ添字番号を有していても 値は追記されるため、このようなことは起きません。
  
  入力配列の中にある数値添字要素の添字の数値は、 結果の配列ではゼロから始まる連続した数値に置き換え
  られます。

<comment>Param:</comment>
  <info>array</info>  <strong>$arrays</strong>  マージしていく任意の数の配列のリスト。

<comment>Return:</comment>
  <info>array</info>  結果の配列を返します。 引数なしで呼ばれた場合、空の <info>array</info> を返します。

<comment>See Also:</comment>
   * <strong>array_merge_recursive()</strong>
   * <strong>array_replace()</strong>
   * <strong>array_combine()</strong>
   * 配列演算子


id: array_merge_recursive
type: function
doc:
<comment>Description:</comment>
  一つ以上の配列を再帰的にマージする
  
  <strong>array_merge_recursive()</strong> は、 一つ以上の配列の要素をマージし、 前の配列の最後にもう一つの配列の値を
  追加します。 マージした後の配列を返します。
  
  入力配列が同じ文字列のキーを有している場合、 マージした後の配列ではこれらのキーの値がひとつにまと
  められます。 この処理は再帰的に行われます。 このため、値の一つが配列自体を指している場合、 この関
  数は別の配列の対応するエントリもマージします。 しかし、配列が同じ数値キーを有している場合、 後の値
  は元の値を上書せず、追加されます。

<comment>Param:</comment>
  <info>array</info>  <strong>$arrays</strong>  再帰的にマージしていく配列の可変リスト。

<comment>Return:</comment>
  <info>array</info>  すべての引数の配列をマージした結果の配列を返します。 引数なしで呼び出された場合、空の配列を
         返します。

<comment>See Also:</comment>
   * <strong>array_merge()</strong>
   * <strong>array_replace_recursive()</strong>


id: array_multisort
type: function
doc:
<comment>Description:</comment>
  複数または多次元の配列をソートする
  
  <strong>array_multisort()</strong> は、複数の配列を一度に、 または、多次元の配列をその次元の一つでソートする際に使
  用可能です。
  
  連想配列のキー (<info>string</info>) は不変ですが、 数値添字は再度振り直されます。
  
  比較結果が等しくなる二つの要素があった場合、それらの並び順は保持されます。PHP 8.0.0 より前のバー
  ジョンでは、ソートした配列におけるそれらの並び順は不定でした。
  
  この関数をコールすると、配列の内部ポインタは最初の要素にリセットされます。

<comment>Param:</comment>
  <info>array</info>  <strong>$array1</strong>             ソートしたい配列。
  <info>mixed</info>  <strong>$array1_sort_order</strong>  先ほどの引数 <info>array</info> のソート順。 <info>SORT_ASC</info> はアイテムを昇順にソートし、
                             <info>SORT_DESC</info> はアイテムを降順にソートします。
                             
                             この引数は、<strong>$array1_sort_flags</strong> と入れ替えることもできるし、完全に省略す
                             ることもできます。 省略した場合は <info>SORT_ASC</info> とみなします。
  <info>mixed</info>  <strong>$array1_sort_flags</strong>  先ほどの引数 <info>array</info> のソート方法。
                             
                             これらのフラグが使えます。 <info>SORT_REGULAR</info> - アイテムを通常通り比較します
                             (型を変更しません)。<info>SORT_NUMERIC</info> - アイテムを数値として比較します。
                             <info>SORT_STRING</info> - アイテムを文字列として比較します。<info>SORT_LOCALE_STRING</info> - 現
                             在のロケールを考慮して、アイテムを文字列として比較します。利用するロ
                             ケールは <strong>setlocale()</strong> で変更できます。 <info>SORT_NATURAL</info> - <strong>natsort()</strong> と同様の
                             「自然順」で、アイテムを文字列として比較します。 <info>SORT_FLAG_CASE</info> -
                             <info>SORT_STRING</info> や <info>SORT_NATURAL</info> と (ビット OR で) 組み合わせて、 大文字小文
                             字を区別しない文字列のソートを指定します。
                             
                             <info>SORT_REGULAR</info> - アイテムを通常通り比較します (型を変更しません)。
                             
                             <info>SORT_NUMERIC</info> - アイテムを数値として比較します。
                             
                             <info>SORT_STRING</info> - アイテムを文字列として比較します。
                             
                             <info>SORT_LOCALE_STRING</info> - 現在のロケールを考慮して、アイテムを文字列として比
                             較します。利用するロケールは <strong>setlocale()</strong> で変更できます。
                             
                             <info>SORT_NATURAL</info> - <strong>natsort()</strong> と同様の「自然順」で、アイテムを文字列として比
                             較します。
                             
                             <info>SORT_FLAG_CASE</info> - <info>SORT_STRING</info> や <info>SORT_NATURAL</info> と (ビット OR で) 組み合わ
                             せて、 大文字小文字を区別しない文字列のソートを指定します。
                             
                             この引数は、<strong>$array1_sort_order</strong> と入れ替えることもできるし、完全に省略す
                             ることもできます。 省略した場合は <info>SORT_REGULAR</info> とみなします。
  <info>mixed</info>  <strong>$rest</strong>               追加の配列。オプションで並び順やフラグが続きます。 前の配列の比較結果が
                             等しい要素に対応する要素群だけを比較します。 要するに、辞書的
                             (lexicographical) なソートを行うということです。

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

<comment>See Also:</comment>
   * <strong>usort()</strong>
   * 配列ソート関数の比較


id: array_pad
type: function
doc:
<comment>Description:</comment>
  指定長、指定した値で配列を埋める
  
  <strong>array_pad()</strong> は、<strong>$length</strong> で指定した長さになるように値 <strong>$value</strong> で埋めて <strong>$array</strong> のコピーを返します。
  <strong>$length</strong> が正の場合、配列の右側が埋められます。 負の場合、配列の左側が埋められます。 <strong>$length</strong> の絶対
  値が <strong>$array</strong> の長さ以下の場合、埋める処理は行われません。 一度に追加できる要素の最大数は 1048576 で
  す。

<comment>Param:</comment>
  <info>array</info>  <strong>$array</strong>   値を埋めるもととなる配列。
  <info>int</info>    <strong>$length</strong>  新しい配列のサイズ。
  <info>mixed</info>  <strong>$value</strong>   <strong>$array</strong> が <strong>$length</strong> より小さいときに、 埋めるために使用する値。

<comment>Return:</comment>
  <info>array</info>  <strong>$length</strong> で指定した長さになるように値 <strong>$value</strong> で埋めて <strong>$array</strong> のコピーを返します。 <strong>$length</strong> が
         正の場合、配列の右側が埋められます。 負の場合、配列の左側が埋められます。 <strong>$length</strong> の絶対値
         が <strong>$array</strong> の長さ以下の場合、埋める処理は行われません。

<comment>See Also:</comment>
   * <strong>array_fill()</strong>
   * <strong>range()</strong>


id: array_pop
type: function
doc:
<comment>Description:</comment>
  配列の末尾から要素を取り除く
  
  <strong>array_pop()</strong> は配列 <strong>$array</strong> の最後の要素の値を取り出して返します。 配列 <strong>$array</strong> は、要素一つ分短くな
  ります。
  
  この関数は、
  入力配列のポインタを、使用した後にリセット
  (<strong>reset()</strong>) します。

<comment>Param:</comment>
  <info>array</info>  <strong>$array</strong>  値を取り出す配列。

<comment>Return:</comment>
  <info>mixed</info>  配列 <strong>$array</strong> の最後の要素の値を取り出して返します。 <strong>$array</strong> が空の場合、 <info>null</info> が返されます。

<comment>See Also:</comment>
   * <strong>array_push()</strong>
   * <strong>array_shift()</strong>
   * <strong>array_unshift()</strong>


id: array_product
type: function
doc:
<comment>Description:</comment>
  配列の値の積を計算する
  
  <strong>array_product()</strong> は、配列の値の積を計算します。

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

<comment>Return:</comment>
  <info>int|float</info>  積を、integer あるいは float で返します。


id: array_push
type: function
doc:
<comment>Description:</comment>
  一つ以上の要素を配列の最後に追加する
  
  <strong>array_push()</strong>は、<strong>$array</strong> をスタックとして処理し、渡された変数を <strong>$array</strong> の最後に加えます。配列 <strong>$array</strong>
  の長さは渡された変数の数だけ増加します。 各 <strong>$value1</strong> 毎に以下を繰り返すことと同じ効果があります。
  ]]> 各 <strong>$value1</strong> で繰り返されます。
  
  もし配列にひとつの要素を加えるために <strong>array_push()</strong> を使用するなら、 関数を呼ぶオーバーヘッドがない
  ので、<return>$array[] = </return> を使用するほうがいいです。
  
  最初の引数が配列でない場合、<strong>array_push()</strong> は警告を発生させます。これは、PHP 7.1.0 より前のバージョ
  ンの、 新規配列を生成する場合における <return>$var[]</return> の動作と異なっていました。

<comment>Param:</comment>
  <info>array</info>  <strong>$array</strong>   入力の配列。
  <info>mixed</info>  <strong>$values</strong>  <strong>$array</strong> の最後に追加する値。

<comment>Return:</comment>
  <info>int</info>  処理後の配列の中の要素の数を返します。

<comment>See Also:</comment>
   * <strong>array_pop()</strong>
   * <strong>array_shift()</strong>
   * <strong>array_unshift()</strong>


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

<comment>Param:</comment>
  <info>array</info>  <strong>$array</strong>  入力の配列。
  <info>int</info>    <strong>$num</strong>    取得するエントリの数を指定します。

<comment>Return:</comment>
  <info>int|string|array</info>  エントリを一つだけ取得する場合、 <strong>array_rand()</strong> はランダムなエントリのキーを返しま
                    す。 その他の場合は、ランダムなエントリのキーの配列を返します。 これにより、ラン
                    ダムな値だけではなくランダムなキーも配列から取得できるようになります。 複数の
                    キーが返される場合、配列に格納された順番と同じ順で返されます。 配列の中にある要
                    素数より多くの要素を取り出そうとすると <info>E_WARNING</info> レベルのエラーが発生し、NULL を
                    返します。

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


id: array_reduce
type: function
doc:
<comment>Description:</comment>
  コールバック関数を繰り返し配列に適用し、配列をひとつの値にまとめる
  
  <strong>array_reduce()</strong> は、配列 <strong>$array</strong> の各要素に <strong>$callback</strong> 関数を繰り返し適用し、 配列をひとつの値にまと
  めます。

<comment>Param:</comment>
  <info>array</info>     <strong>$array</strong>     入力の配列。
  <info>callable</info>  <strong>$callback</strong>  前回の反復処理の結果を保持します。最初の反復処理のときには、 <strong>$initial</strong> の値を
                       保持しています。
                       
                       現在の反復処理の値を保持します。
  <info>mixed</info>     <strong>$carry</strong>     前回の反復処理の結果を保持します。最初の反復処理のときには、 <strong>$initial</strong> の値を
                       保持しています。
  <info>mixed</info>     <strong>$item</strong>      現在の反復処理の値を保持します。
  <info>mixed</info>     <strong>$initial</strong>   オプションの <strong>$intial</strong> が利用可能な場合、処理の最初で使用されたり、 配列が空の
                       場合の最終結果として使用されます。

<comment>Return:</comment>
  <info>mixed</info>  結果の値を返します。
         
         配列が空で <strong>$initial</strong> が渡されなかった場合は、 <strong>array_reduce()</strong> は <info>null</info> を返します。

<comment>See Also:</comment>
   * <strong>array_filter()</strong>
   * <strong>array_map()</strong>
   * <strong>array_unique()</strong>
   * <strong>array_count_values()</strong>


id: array_replace
type: function
doc:
<comment>Description:</comment>
  渡された配列の要素を置き換える
  
  <strong>array_replace()</strong> は、 <strong>$array</strong> の値をそれ以降の配列の同じ要素の値で置き換えます。 最初の配列のキーと
  同じキーが 2 番目の配列にあれば、 2 番目の配列の値が最初の配列の値を上書きします。 2 番目の配列に
  存在するキーが最初の配列に存在しなければ、 そのキーが新たに最初の配列内に作られます。 最初の配列に
  しか存在しないキーについては何も変わりません。 置き換え用の配列が複数渡された場合は渡した順に処理
  を行い、 後から渡した配列の値のほうが優先されます。
  
  <strong>array_replace()</strong> は再起的な処理を行いません。 2 番目の配列の値がどんな型であっても、最初の配列の値
  を置き換えます。

<comment>Param:</comment>
  <info>array</info>  <strong>$array</strong>         要素を置き換えたい配列。
  <info>array</info>  <strong>$replacements</strong>  置き換えたい要素を含む配列。 後から渡した配列の値のほうが優先されます。

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

<comment>See Also:</comment>
   * <strong>array_replace_recursive()</strong>
   * <strong>array_merge()</strong>


id: array_replace_recursive
type: function
doc:
<comment>Description:</comment>
  渡された配列の要素を再帰的に置き換える
  
  <strong>array_replace_recursive()</strong> は、 <strong>$array</strong> の値をそれ以降の配列の同じ要素の値で置き換えます。 最初の配
  列のキーと同じキーが 2 番目の配列にあれば、 2 番目の配列の値が最初の配列の値を上書きします。 2 番
  目の配列に存在するキーが最初の配列に存在しなければ、 そのキーが新たに最初の配列内に作られます。 最
  初の配列にしか存在しないキーについては何も変わりません。 置き換え用の配列が複数渡された場合は渡し
  た順に処理を行い、 後から渡した配列の値のほうが優先されます。
  
  <strong>array_replace_recursive()</strong> は再帰的な処理を行います。 配列を再帰的にたどり、内部の値に対しても同じ
  手順で処理します。
  
  最初の配列の値がスカラーの場合は、 2 番目の配列の値がスカラーであるか配列であるかにかかわらずそれ
  で置き換えられます。 最初の配列の値と 2番目の配列 の値が両方配列である場合は、
  <strong>array_replace_recursive()</strong> が対応する値を再帰的に処理します。

<comment>Param:</comment>
  <info>array</info>  <strong>$array</strong>         要素を置き換えたい配列。
  <info>array</info>  <strong>$replacements</strong>  置き換えたい要素を含む配列。

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

<comment>See Also:</comment>
   * <strong>array_replace()</strong>
   * <strong>array_merge_recursive()</strong>


id: array_reverse
type: function
doc:
<comment>Description:</comment>
  要素を逆順にした配列を返す
  
  配列を受け取って、要素の順番を逆にした新しい配列を返します。

<comment>Param:</comment>
  <info>array</info>  <strong>$array</strong>          入力の配列。
  <info>bool</info>   <strong>$preserve_keys</strong>  <info>true</info> の場合は数値のキーを保持します。 非数値のキーは、この設定にかかわらず
                         常に保持されます。

<comment>Return:</comment>
  <info>array</info>  逆転させた配列を返します。

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


id: array_search
type: function
doc:
<comment>Description:</comment>
  指定した値を配列で検索し、見つかった場合に対応する最初のキーを返す
  
  <strong>$haystack</strong> 内の <strong>$needle</strong> を検索します。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$needle</strong>    検索したい値。
                    
                    <strong>$needle</strong> が文字列の場合、 大文字小文字を区別して比較が行われます。
  <info>array</info>  <strong>$haystack</strong>  配列。
  <info>bool</info>   <strong>$strict</strong>    オプションの3番目のパラメータ <strong>$strict</strong> に <info>true</info> が指定された場合、 <strong>array_search()</strong>
                    は identical 要素を <strong>$haystack</strong> から探します。 つまり、<strong>$haystack</strong> の中で <strong>$needle</strong> の
                    厳密な型比較を実行します。 およびオブジェクトが同一のインスタンスであるかどうか
                    も確認します。

<comment>Return:</comment>
  <info>int|string|false</info>  <strong>$needle</strong> が見つかった場合に配列のキー、 それ以外の場合に <info>false</info> を返します。
                    
                    もし <strong>$haystack</strong> に 1 つ以上の <strong>$needle</strong> に見つかった場合、 最初にマッチしたキーが返
                    されます。全てのマッチした値に対するキーを返すためには、代わりに <strong>array_keys()</strong> に
                    パラメータ <strong>$search_value</strong> を付けて使用してください。
                    
                    この関数は論理値
                    <info>false</info> を返す可能性がありますが、<info>false</info> として評価される値を返す可能性もあります。
                    詳細については 論理値の
                    セクションを参照してください。この関数の返り値を調べるには
                    ===演算子 を
                    使用してください。

<comment>See Also:</comment>
   * <strong>array_keys()</strong>
   * <strong>array_values()</strong>
   * <strong>array_key_exists()</strong>
   * <strong>in_array()</strong>


id: array_shift
type: function
doc:
<comment>Description:</comment>
  配列の先頭から要素を一つ取り出す
  
  <strong>array_shift()</strong> は、<strong>$array</strong> の最初の値を取り出して返します。配列 <strong>$array</strong> は、要素一つ分だけ短くなり、
  全ての要素は前にずれます。 数値添字の配列のキーはゼロから順に新たに振りなおされますが、 リテラルの
  キーには影響しません。
  
  この関数は、
  入力配列のポインタを、使用した後にリセット
  (<strong>reset()</strong>) します。

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

<comment>Return:</comment>
  <info>mixed</info>  取り出した値を返します。<strong>$array</strong> が空の場合や配列でない場合は <info>null</info> を返します。

<comment>See Also:</comment>
   * <strong>array_unshift()</strong>
   * <strong>array_push()</strong>
   * <strong>array_pop()</strong>


id: array_slice
type: function
doc:
<comment>Description:</comment>
  配列の一部を展開する
  
  <strong>array_slice()</strong>は、<strong>$array</strong> から引数 <strong>$offset</strong> および <strong>$length</strong> で指定された連続する要素を返します。

<comment>Param:</comment>
  <info>array</info>     <strong>$array</strong>          入力の配列。
  <info>int</info>       <strong>$offset</strong>         <strong>$offset</strong> が負の値ではない場合、要素位置の計算は、 配列 <strong>$array</strong> の offset
                            から始められます。
                            
                            <strong>$offset</strong> が負の場合、要素位置の計算は <strong>$array</strong> の最後から行われます。
                            
                            <strong>$offset</strong> は、配列の位置を表します。配列のキーではありません。
  <info>int|null</info>  <strong>$length</strong>         <strong>$length</strong>が指定され、正の場合、 配列の要素の中から最大でその数までの要素を
                            返します。
                            
                            配列の要素数が <strong>$length</strong> より少ない場合は、 配列から取得できる要素だけを返
                            します。
                            
                            <strong>$length</strong> が指定され、負の場合、配列の末尾から連続する複数の要素が返されま
                            す。
                            
                            省略された場合、<strong>$offset</strong> から配列の最後までの全ての要素が返されます。
  <info>bool</info>      <strong>$preserve_keys</strong>  <strong>array_slice()</strong> はデフォルトで配列の数値キーを並べなおし、 リセットしま
                            す。 <strong>$preserve_keys</strong> を <info>true</info> にする事でこの動作を変更することができます。
                            文字列のキーは、このパラメータの値にかかわらず常に保存されます。

<comment>Return:</comment>
  <info>array</info>  切り取った部分を返します。オフセットが配列のサイズより大きい場合は、空の配列を返します。

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


id: array_splice
type: function
doc:
<comment>Description:</comment>
  配列の一部を削除し、他の要素で置換する
  
  配列 <strong>$array</strong> から <strong>$offset</strong> および <strong>$length</strong> で指定された要素を削除し、配列 <strong>$replacement</strong> でそれを置換し
  ます。
  
  <strong>$array</strong> の配列の数値添字は保存されないことに注意しましょう。
  
  <strong>$replacement</strong> が配列でない場合は、 型変換 を行います (つまり (array) $replacement とします)。 たと
  えば <strong>$replacement</strong> にオブジェクトや <info>null</info> などを指定した場合に、 予期せぬ動きをする可能性がありま
  す。

<comment>Param:</comment>
  <info>array</info>     <strong>$array</strong>        入力の配列。
  <info>int</info>       <strong>$offset</strong>       <strong>$offset</strong> が正の場合、削除される部分は 配列 <strong>$array</strong> の最初から指定オフセット
                          の ぶんだけ進んだ位置からとなります。
                          
                          <strong>$offset</strong> が負の場合、削除される部分は、 <strong>$array</strong> の末尾から数えた位置からとな
                          ります。
  <info>int|null</info>  <strong>$length</strong>       <strong>$length</strong> が省略された場合、 <strong>$offset</strong> から配列の最後までが全て削除されます。
                          
                          <strong>$length</strong> が指定され、正の場合、複数の要素が削除されます。
                          
                          負の <strong>$length</strong> が指定された場合、削除される部分の末尾の位置は配列の末尾を基
                          準にして計算されます。
                          
                          <strong>$length</strong> にゼロを指定した場合は、どの要素も削除しません。
                          
                          <strong>$replacement</strong> も指定した場合に <strong>$offset</strong> から配列の最後まで全てを削除するに
                          は、 <strong>$length</strong> を求めるために <return>count($input) </return> を使用してください。
  <info>mixed</info>     <strong>$replacement</strong>  配列 <strong>$replacement</strong> が指定された場合、 削除された要素は、この配列の要素で置
                          換されます。
                          
                          <strong>$offset</strong> および <strong>$length</strong> で何も削除しないと指定した場合、配列 <strong>$replacement</strong>
                          の要素は <strong>$offset</strong> で指定された位置に挿入されます。
                          
                          置換される配列のキーは保存されないことに注意してください。
                          
                          もし <strong>$replacement</strong> に一つしか要素がない場合、 要素そのものが配列やオブジェ
                          クトあるいは <info>null</info> でない限り、<return>array()</return> や 角括弧 で括る必要はありません。

<comment>Return:</comment>
  <info>array</info>  抽出された要素を含む配列を返します。

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


id: array_sum
type: function
doc:
<comment>Description:</comment>
  配列の中の値の合計を計算する
  
  <strong>array_sum()</strong> は、配列の中の値の合計を整数または float として返します。

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

<comment>Return:</comment>
  <info>int|float</info>  値の合計を整数または float として返します。 <strong>$array</strong> が空の場合は <return>0</return> を返します。


id: array_udiff
type: function
doc:
<comment>Description:</comment>
  データの比較にコールバック関数を用い、配列の差を計算する
  
  データの比較にコールバック関数を用い、配列の差を計算します。 この関数は <strong>array_diff()</strong> と異なり、
  データの比較に内部関数を利用します。

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

<comment>Return:</comment>
  <info>array</info>  他の引数のいずれにも存在しない <strong>$array</strong> の値の全てを有する配列を返します。

<comment>See Also:</comment>
   * <strong>array_diff()</strong>
   * <strong>array_diff_assoc()</strong>
   * <strong>array_diff_uassoc()</strong>
   * <strong>array_udiff_assoc()</strong>
   * <strong>array_udiff_uassoc()</strong>
   * <strong>array_intersect()</strong>
   * <strong>array_intersect_assoc()</strong>
   * <strong>array_uintersect()</strong>
   * <strong>array_uintersect_assoc()</strong>
   * <strong>array_uintersect_uassoc()</strong>


id: array_udiff_assoc
type: function
doc:
<comment>Description:</comment>
  データの比較にコールバック関数を用い、
    追加された添字の確認を含めて配列の差を計算する
  
  データの比較にコールバック関数を用い、 追加された添字の確認を含めて配列の差を計算します。
  
  この関数は n 次元配列の一つの次元しかチェックしないことに注意してください。 もちろん、
  <return>array_udiff_assoc($array1[0], $array2[0], "some_comparison_func");</return> のようにすることでより深い次元
  でのチェックもできます。

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

<comment>Return:</comment>
  <info>array</info>  <strong>array_udiff_assoc()</strong> は、 <strong>$array</strong> から他の引数の配列の中に現れない全ての値を含む <info>array</info> を返し
         ます。 <strong>array_diff()</strong> や <strong>array_udiff()</strong> と異なり、キーが比較に使用されることに注意してくださ
         い。 配列のデータの比較は、ユーザーが指定したコールバックを用いて行われます。 この点で、
         <strong>array_diff_assoc()</strong> は反対の動作、つまり 内部関数を利用した比較を行います。

<comment>See Also:</comment>
   * <strong>array_diff()</strong>
   * <strong>array_diff_assoc()</strong>
   * <strong>array_diff_uassoc()</strong>
   * <strong>array_udiff()</strong>
   * <strong>array_udiff_uassoc()</strong>
   * <strong>array_intersect()</strong>
   * <strong>array_intersect_assoc()</strong>
   * <strong>array_uintersect()</strong>
   * <strong>array_uintersect_assoc()</strong>
   * <strong>array_uintersect_uassoc()</strong>


id: array_udiff_uassoc
type: function
doc:
<comment>Description:</comment>
  データと添字の比較にコールバック関数を用い、
    追加された添字の確認を含めて配列の差を計算する
  
  データと添字の比較にコールバック関数を用い、 追加された添字の確認を含めて配列の差を計算します。
  
  <strong>array_diff()</strong> や <strong>array_udiff()</strong> と異なり、キーが比較に使用されることに注意してください。

<comment>Param:</comment>
  <info>array</info>     <strong>$array</strong>               最初の配列。
  <info>array</info>     <strong>$arrays</strong>              比較対象の配列。
  <info>callable</info>  <strong>$value_compare_func</strong>  比較関数は、最初の引数と二番目の引数の比較結果を返します。最初の引
                                 数のほうが二番目の引数より大きい場合は正の整数を、二番目の引数と等
                                 しい場合はゼロを、そして二番目の引数より小さい場合は負の整数を返す
                                 必要があります。
                                 
                                 <info>float</info> のような 非整数 を比較関数が返すと、その返り値を内部的に <info>int</info>
                                 にキャストして使います。 つまり、<return>0.99</return> や <return>0.1</return> といった値は整数値 <return>0</return>
                                 にキャストされ、 値が等しいとみなされます。
  <info>callable</info>  <strong>$key_compare_func</strong>    キー（添字）の比較は、コールバック関数 <strong>$key_compare_func</strong> で行われま
                                 す。 <strong>array_udiff_assoc()</strong> では後者の比較が内部関数で 行われるという
                                 点で、この関数とは異なります。

<comment>Return:</comment>
  <info>array</info>  <strong>$array</strong> から他の引数の配列の中に現れない全ての 値を含む<info>array</info> を返します。

<comment>See Also:</comment>
   * <strong>array_diff()</strong>
   * <strong>array_diff_assoc()</strong>
   * <strong>array_udiff()</strong>
   * <strong>array_udiff_assoc()</strong>
   * <strong>array_intersect()</strong>
   * <strong>array_intersect_assoc()</strong>
   * <strong>array_uintersect()</strong>
   * <strong>array_uintersect_assoc()</strong>
   * <strong>array_uintersect_uassoc()</strong>


id: array_uintersect
type: function
doc:
<comment>Description:</comment>
  データの比較にコールバック関数を用い、配列の共通項を計算する
  
  データの比較にコールバック関数を用い、配列の共通項を計算します。

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

<comment>Return:</comment>
  <info>array</info>  他の全ての引数に存在する <strong>$array</strong> の値を全て有する配列を返します。

<comment>See Also:</comment>
   * <strong>array_intersect()</strong>
   * <strong>array_intersect_assoc()</strong>
   * <strong>array_uintersect_assoc()</strong>
   * <strong>array_uintersect_uassoc()</strong>


id: array_uintersect_assoc
type: function
doc:
<comment>Description:</comment>
  データの比較にコールバック関数を用い、
    追加された添字の確認も含めて配列の共通項を計算する
  
  データの比較にコールバック関数を用い、 追加された添字の確認も含めて配列の共通項を計算します。
  
  <strong>array_uintersect()</strong>と異なり、キーが比較に使用される ことに注意してください。データはコールバック関
  数を用いて比較されます。

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

<comment>Return:</comment>
  <info>array</info>  全ての引数に現れる <strong>$array</strong> の全ての値を含む配列を返します。

<comment>See Also:</comment>
   * <strong>array_uintersect()</strong>
   * <strong>array_intersect_assoc()</strong>
   * <strong>array_intersect_uassoc()</strong>
   * <strong>array_uintersect_uassoc()</strong>


id: array_uintersect_uassoc
type: function
doc:
<comment>Description:</comment>
  データと添字の比較に個別のコールバック関数を用い、
    追加された添字の確認も含めて配列の共通項を計算する
  
  データと添字の比較にそれぞれ別のコールバック関数を用い、 追加された添字の確認も含めて配列の共通項
  を計算します。

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

<comment>Return:</comment>
  <info>array</info>  全ての引数に現れる <strong>$array1</strong> の全ての値を含む配列を返します。

<comment>See Also:</comment>
   * <strong>array_uintersect()</strong>
   * <strong>array_intersect_assoc()</strong>
   * <strong>array_intersect_uassoc()</strong>
   * <strong>array_uintersect_assoc()</strong>


id: array_unique
type: function
doc:
<comment>Description:</comment>
  配列から重複した値を削除する
  
  <strong>$array</strong> を入力とし、値に重複のない新規配列を返します。
  
  キーは保持されることに注意してください。 指定された <strong>$flags</strong> において、 複数の要素が等しかった場合、
  はじめの要素のキーと値が保持されます。
  
  <return>(string) $elem1 === (string) $elem2</return> の場合のみ二つの要素は等しいとみなされます。 つまり、文字列表
  現が同じである場合は、最初の要素を使用します。

<comment>Param:</comment>
  <info>array</info>  <strong>$array</strong>  入力の配列。
  <info>int</info>    <strong>$flags</strong>  オプションの 2 番目のパラメータ <strong>$flags</strong> にこれらの値を使用して、比較の挙動を変更しま
                 す。
                 
                 比較形式のフラグは次のとおりです。 <info>SORT_REGULAR</info> - 通常の比較 (型変換をしない) を行
                 います<info>SORT_NUMERIC</info> - 数値として比較します<info>SORT_STRING</info> - 文字列として比較します
                 <info>SORT_LOCALE_STRING</info> - 現在のロケールにもとづいて文字列として比較します。
                 
                 <info>SORT_REGULAR</info> - 通常の比較 (型変換をしない) を行います
                 
                 <info>SORT_NUMERIC</info> - 数値として比較します
                 
                 <info>SORT_STRING</info> - 文字列として比較します
                 
                 <info>SORT_LOCALE_STRING</info> - 現在のロケールにもとづいて文字列として比較します。

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

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


id: array_unshift
type: function
doc:
<comment>Description:</comment>
  一つ以上の要素を配列の最初に加える
  
  <strong>array_unshift()</strong> は、<strong>$array</strong> の先頭に指定された要素を加えます。リストの要素は全体として加えられるた
  め、 加えられた要素の順番は変わらないことに注意してください。 配列の数値添字はすべて新たにゼロから
  振りなおされます。 リテラルのキーについては変更されません。
  
  この関数をコールすると、配列の内部ポインタは最初の要素にリセットされます。

<comment>Param:</comment>
  <info>array</info>  <strong>$array</strong>   入力の配列。
  <info>mixed</info>  <strong>$values</strong>  加える値。

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

<comment>See Also:</comment>
   * <strong>array_merge()</strong>
   * <strong>array_shift()</strong>
   * <strong>array_push()</strong>
   * <strong>array_pop()</strong>


id: array_values
type: function
doc:
<comment>Description:</comment>
  配列の全ての値を返す
  
  <strong>array_values()</strong> は、配列 <strong>$array</strong> から全ての値を取り出し、数値添字をつけた配列を返します。

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

<comment>Return:</comment>
  <info>array</info>  数値添字の値の配列を返します。

<comment>See Also:</comment>
   * <strong>array_keys()</strong>
   * <strong>array_combine()</strong>


id: array_walk
type: function
doc:
<comment>Description:</comment>
  配列の全ての要素にユーザー定義の関数を適用する
  
  <strong>$array</strong> 配列の各要素にユーザー定義関数 <strong>$callback</strong> を適用します。
  
  <strong>array_walk()</strong> は <strong>$array</strong> の内部配列ポインタに影響されません。<strong>array_walk()</strong> はポインタの位置に関わらず
  配列の全てに渡って適用されます。

<comment>Param:</comment>
  <info>array|object</info>  <strong>$array</strong>     入力の配列。
  <info>callable</info>      <strong>$callback</strong>  通常、 <strong>$callback</strong> は引数を二つとります。 <strong>$array</strong> パラメータの値が最初の引
                           数、 キー/添字は二番目の引数となります。
                           
                           <strong>$callback</strong> により配列の値そのものを変更する必要がある場合、 <strong>$callback</strong> の最
                           初の引数は リファレンス として渡す必要があります。この場合、配列の要素に
                           加えた変更は、 配列自体に対して行われます。
                           
                           内部関数の多く (たとえば <strong>strtolower()</strong>) は、 期待しているよりも多い引数を
                           受け取ると警告が発生します。 そのため、<strong>$callback</strong> に直接指定することはでき
                           ません。
                           
                           変更される可能性があるのは配列の値だけであり、 その構造を変更することはで
                           きません。つまり、 プログラマは要素の追加や削除そして並べ替えなどができな
                           いということです。 コールバック関数がこの条件を満たさない場合は、 この関
                           数の動作は未定義で予期せぬ結果を得ることになります。
  <info>mixed</info>         <strong>$arg</strong>       オプションの <strong>$arg</strong> パラメータが指定された場合、 コールバック関数 <strong>$callback</strong>
                           への三番目の引数として渡されます。

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

<comment>See Also:</comment>
   * <strong>array_walk_recursive()</strong>
   * <strong>iterator_apply()</strong>
   * <strong>list()</strong>
   * <strong>each()</strong>
   * <strong>call_user_func_array()</strong>
   * <strong>array_map()</strong>
   * foreach


id: array_walk_recursive
type: function
doc:
<comment>Description:</comment>
  配列の全ての要素に、ユーザー関数を再帰的に適用する
  
  <strong>$array</strong> 配列の各要素にユーザー定義関数 <strong>$callback</strong>を適用します。 この関数は配列の要素内を再帰的にた
  どっていきます。

<comment>Param:</comment>
  <info>array|object</info>  <strong>$array</strong>     入力の配列。
  <info>callable</info>      <strong>$callback</strong>  通常、 <strong>$callback</strong> は引数を二つとります。 <strong>$array</strong> パラメータの値が最初の引
                           数、 キー/添字は二番目の引数となります。
                           
                           <strong>$callback</strong> により配列の値そのものを変更する必要がある場合、 <strong>$callback</strong> の最
                           初の引数は リファレンス として渡す必要があります。この場合、配列の要素に
                           加えた変更は、 配列自体に対して行われます。
  <info>mixed</info>         <strong>$arg</strong>       オプションの <strong>$arg</strong> パラメータが指定された場合、 コールバック関数 <strong>$callback</strong>
                           への三番目の引数として渡されます。

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

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


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

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

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

<comment>See Also:</comment>
   * <strong>sort()</strong>
   * <strong>asort()</strong>
   * 配列ソート関数の比較


id: asin
type: function
doc:
<comment>Description:</comment>
  逆正弦（アークサイン）
  
  <strong>$num</strong> のアークサインをラジアンで返します。 <strong>asin()</strong> は <strong>sin()</strong> の逆関数です。 つまり、<strong>asin()</strong> の定義域に
  ある <strong>$num</strong> の全ての値に対して、$num == sin(asin($num)) が成立します。

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

<comment>Return:</comment>
  <info>float</info>  <strong>$num</strong> のアークサインをラジアンで返します。

<comment>See Also:</comment>
   * <strong>sin()</strong>
   * <strong>asinh()</strong>
   * <strong>acos()</strong>
   * <strong>atan()</strong>


id: asinh
type: function
doc:
<comment>Description:</comment>
  逆双曲線正弦（アークハイパボリックサイン）
  
  <strong>$num</strong> のアークハイパボリックサインを返します。 つまり、ハイパボリックサインが <strong>$num</strong> となる値です。

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

<comment>Return:</comment>
  <info>float</info>  <strong>$num</strong> のアークハイパボリックサインを返します。

<comment>See Also:</comment>
   * <strong>sinh()</strong>
   * <strong>asin()</strong>
   * <strong>acosh()</strong>
   * <strong>atanh()</strong>


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

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

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

<comment>See Also:</comment>
   * <strong>sort()</strong>
   * <strong>arsort()</strong>
   * 配列ソート関数の比較


id: assert
type: function
doc:
<comment>Description:</comment>
  アサーションの値を調べる
  
  <strong>assert()</strong> は expectation の定義を満たします。すなわち、 開発環境やテスト環境では有効であるが、 運用
  環境では除去されて、まったくコストのかからないアサーションということです。
  
  アサーションは、デバッグ目的にのみ使用するべきです。 アサーションを常に <info>true</info> となる条件を調べる不
  具合診断に使用し、 true でない場合に何らかのプログラミングエラーを示したり、 extension 関数または
  特定のシステム制限や機能といった、 特定の機能の存在をチェックするために使用することが可能です。
  
  アサーションは削除するように設定できるため、 入力パラメータのチェックのような通常の実行動作に使用
  するべきでは ありません。 一般的には、アサーションのチェックを無効にしてもそのコードが正常に動作し
  なければなりません。
  
  <strong>assert()</strong> は <strong>$assertion</strong> で指定された expectation をチェックします。 それを満たさない場合、この関数
  の結果は <info>false</info> になり、 <strong>assert()</strong> の設定に応じて適切な動作をします。
  
  <strong>assert()</strong> の振る舞いは、以下のINI設定によって制御できます: Assert 設定オプション名前デフォルト説明
  変更履歴zend.assertions<return>1</return><return>1</return>: コードを生成して実行する (開発モード) <return>0</return>: コードを生成するが、実行時には
  読み飛ばす <return>-1</return>: コードを生成しない (運用モード) assert.active<info>true</info><info>false</info> を指定すると、 <strong>assert()</strong> は
  expectation をチェックせず、 無条件に <info>true</info> を返します。  PHP 8.3.0 以降は非推奨
  assert.callback<info>null</info> アサーションが失敗した時にコールされるユーザー定義の関数。 シグネチャは以下の
  形であるべきです: <info>void</info>assert_callback<info>string</info><strong>$file</strong><info>int</info><strong>$line</strong><info>null</info><strong>$assertion</strong><info>string</info><strong>$description</strong>  PHP
  8.0.0 より前のバージョンでは、 コールバックのシグネチャは以下の形であるべきでした:
  <info>void</info>assert_callback<info>string</info><strong>$file</strong><info>int</info><strong>$line</strong><info>string</info><strong>$assertion</strong><info>string</info><strong>$description</strong> PHP 8.3.0 以降は非推奨
  assert.exception<info>true</info><info>true</info> を指定すると、expectation を満たさない場合に <class>AssertionError</class> がスローされ
  ます。  PHP 8.3.0 以降は非推奨 assert.bail<info>false</info><info>true</info> を指定すると、expectation を満たさない場合に
  PHP スクリプトの実行を停止します。  PHP 8.3.0 以降は非推奨 assert.warning<info>true</info><info>true</info> を指定すると、
  expectation を満たさない場合に <info>E_WARNING</info> が発生します。 このINI設定は assert.exception が有効な場
  合は意味がありません。  PHP 8.3.0 以降は非推奨

<comment>Param:</comment>
  <info>mixed</info>                  <strong>$assertion</strong>    値を返すあらゆる式を指定できます。 この式を実行した結果を用い
                                       て、アサーションに成功したか否かを判断します。
                                       
                                       PHP 8.0.0 より前のバージョンでは、 <strong>$assertion</strong> に文字列を指定
                                       すると、 PHP コードとして解釈され、 <strong>eval()</strong> 経由で実行されてい
                                       ました。 この文字列はコールバックの3番目の引数として渡されて
                                       いました。 この振る舞いは PHP 7.2.0 以降では 非推奨 になり、
                                       PHP 8.0.0 で 削除されました。
  <info>Throwable|string|null</info>  <strong>$description</strong>  <strong>$description</strong> が <class>Throwable</class> のインスタンスの場合、 <strong>$assertion</strong>
                                       が実行され、 かつ失敗した場合にスローされます。  PHP 8.0.0 以
                                       降では、 定義済みのアサーションのコールバックがコールされる
                                       前 に上の処理は行われます。   PHP 8.0.0 以降では、
                                       assert.exception の設定に関わらず、<info>object</info> がスローされます。
                                       例外がスローされる場合、 PHP 8.0.0 以降では、 assert.bail は
                                       意味がありません。
                                       
                                       PHP 8.0.0 以降では、 定義済みのアサーションのコールバックが
                                       コールされる 前 に上の処理は行われます。
                                       
                                       PHP 8.0.0 以降では、 assert.exception の設定に関わらず、
                                       <info>object</info> がスローされます。
                                       
                                       例外がスローされる場合、 PHP 8.0.0 以降では、 assert.bail は
                                       意味がありません。
                                       
                                       <strong>$description</strong> が文字列の場合、 例外や警告が発生した場合にここ
                                       で指定したメッセージを使います。 <strong>$assertion</strong> が失敗したときの
                                       オプションのメッセージを指定します。
                                       
                                       <strong>$description</strong> は省略できます。  デフォルトの値は、<strong>assert()</strong> を
                                       呼び出したソースコードと同じです。この値はコンパイル時に生成
                                       されます。

<comment>Return:</comment>
  <info>bool</info>  <strong>assert()</strong> は、以下のうちのひとつが当てはまる場合、常に <info>true</info> を返します:
        
        上記の条件がすべて当てはまらない場合でも、 <strong>$assertion</strong> が真と評価できる値であれば <info>true</info> を返し
        ます。 そうでない場合、<info>false</info> を返します。

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


id: assert_options
type: function
doc:
<comment>Description:</comment>
  様々な assert フラグを設定/取得する
  
  種々の <strong>assert()</strong> 制御オプションを設定したり、 単に現在の設定を調べたりします。
  
  <strong>assert_options()</strong> を使うことはお勧めできません。 php.ini のディレクティブ zend.assertions と
  assert.exception を <strong>ini_set()</strong> や <strong>ini_get()</strong> で取得したり設定したりする方が望ましいです。

<comment>Param:</comment>
  <info>int</info>          <strong>$option</strong>       assert オプションオプションINI 設定デフォルト値説明
                             ASSERT_ACTIVEassert.active1<strong>assert()</strong> による評価を有効にする
                             ASSERT_EXCEPTIONassert.exception1assertion に失敗するたびに
                             <class>AssertionError</class>をスローするASSERT_WARNINGassert.warning1assertion に失敗
                             するたびに PHP の警告を発生させるASSERT_BAILassert.bail0assersion に失
                             敗した場合に実行を終了するASSERT_QUIET_EVALassert.quiet_eval0 assersion
                             式については error_reporting を無効にする。 PHP 8.0.0 以降では削除され
                             ています。 ASSERT_CALLBACKassert.callback(<info>null</info>)assertion に失敗した場合
                             にコールされるコールバック
  <info>mixed</info>        <strong>$value</strong>        オプションに指定する新しい値。
                             
                             <info>ASSERT_CALLBACK</info> 定数または assert.callback に設定するコールバック関数
                             は、次のようなシグネチャを持つべきです:
                             <info>void</info>assert_callback<info>string</info><strong>$file</strong><info>int</info><strong>$line</strong><info>string</info><info>null</info></info><strong>$assertion</strong><info>string</info><strong>$description</strong>
                             <strong>$file</strong><strong>assert()</strong> 関数がコールされたファイル名 <strong>$line</strong><strong>assert()</strong> 関数がコールさ
                             れた行番号 <strong>$assertion</strong> PHP 8.0.0 より前のバージョンでは、 この値は
                             <strong>assert()</strong> に渡された assertion でした。 但し、これは assertion が文字列
                             として渡された場合に限られていました。 (assertion が 論理型の条件だった
                             場合は、このパラメータは空文字列でした)。 PHP 8.0.0 以降では、このパラ
                             メータは常に <info>null</info> になります。 <strong>$description</strong><strong>assert()</strong> 関数に渡された説明
                             
                             <strong>assert()</strong> 関数がコールされたファイル名
                             
                             <strong>assert()</strong> 関数がコールされた行番号
                             
                             PHP 8.0.0 より前のバージョンでは、 この値は <strong>assert()</strong> に渡された
                             assertion でした。 但し、これは assertion が文字列として渡された場合に
                             限られていました。 (assertion が 論理型の条件だった場合は、このパラメー
                             タは空文字列でした)。 PHP 8.0.0 以降では、このパラメータは常に <info>null</info> に
                             なります。
                             
                             <strong>assert()</strong> 関数に渡された説明
  <info>string</info>       <strong>$file</strong>         <strong>assert()</strong> 関数がコールされたファイル名
  <info>int</info>          <strong>$line</strong>         <strong>assert()</strong> 関数がコールされた行番号
  <info>string|null</info>  <strong>$assertion</strong>    PHP 8.0.0 より前のバージョンでは、 この値は <strong>assert()</strong> に渡された
                             assertion でした。 但し、これは assertion が文字列として渡された場合に
                             限られていました。 (assertion が 論理型の条件だった場合は、このパラメー
                             タは空文字列でした)。 PHP 8.0.0 以降では、このパラメータは常に <info>null</info> に
                             なります。
  <info>string</info>       <strong>$description</strong>  <strong>assert()</strong> 関数に渡された説明

<comment>Return:</comment>
  <info>mixed</info>  そのオプションの元の値を返します。

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


id: atan
type: function
doc:
<comment>Description:</comment>
  逆正接（アークタンジェント）
  
  <strong>$num</strong> のアークタンジェントをラジアンで返します。 <strong>atan()</strong> は <strong>tan()</strong> の逆関数です。 つまり、<strong>atan()</strong> の定
  義域にある <strong>$num</strong> の全ての値に対して、$num == tan(atan($num)) が成立します。

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

<comment>Return:</comment>
  <info>float</info>  <strong>$num</strong> のアークタンジェントをラジアンで返します。

<comment>See Also:</comment>
   * <strong>tan()</strong>
   * <strong>atanh()</strong>
   * <strong>asin()</strong>
   * <strong>acos()</strong>


id: atan2
type: function
doc:
<comment>Description:</comment>
  2 変数のアークタンジェント
  
  この関数は、2 つの変数 <strong>$x</strong> および <strong>$y</strong> のアークタンジェントを計算します。 <strong>$y</strong> / <strong>$x</strong> のアークタンジェン
  トを計算するのに似ていますが、 2 つの引数の符号を用いて結果の象限を定義することが異なっています。
  
  この関数は、結果を -PI から PI の間(両端を含む)のラジアンで返します。

<comment>Param:</comment>
  <info>float</info>  <strong>$y</strong>  被除数。
  <info>float</info>  <strong>$x</strong>  除数。

<comment>Return:</comment>
  <info>float</info>  <strong>$y</strong>/<strong>$x</strong>  のアークタンジェントをラジアンで返します。

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


id: atanh
type: function
doc:
<comment>Description:</comment>
  逆双曲線正接（アークハイパボリックタンジェント）
  
  <strong>$num</strong> のアークハイパボリックタンジェントを返します。 つまり、ハイパボリックタンジェントが <strong>$num</strong> とな
  る値です。

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

<comment>Return:</comment>
  <info>float</info>  <strong>$num</strong> のアークハイパボリックタンジェントを返します。

<comment>See Also:</comment>
   * <strong>tanh()</strong>
   * <strong>atan()</strong>
   * <strong>asinh()</strong>
   * <strong>acosh()</strong>


id: base64_decode
type: function
doc:
<comment>Description:</comment>
  MIME base64 方式によりエンコードされたデータをデコードする
  
  base64 でエンコードされた <strong>$string</strong> をデコードします。

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  デコードされるデータ。
  <info>bool</info>    <strong>$strict</strong>  <strong>$strict</strong> パラメータを <info>true</info> に指定すると、 <strong>base64_decode()</strong> 関数は、 入力に base64
                   アルファベットの範囲外の文字が含まれる場合に <info>false</info> を返します。 それ以外の場合
                   は、base64 アルファベットの範囲外の文字を破棄したうえでデコードされます。

<comment>Return:</comment>
  <info>string|false</info>  デコードされたデータを返します。失敗した場合に <info>false</info> を返します。 戻り値はバイナリに
                なることもあります。

<comment>See Also:</comment>
   * <strong>base64_encode()</strong>
   * RFC 2045 6.8 節


id: base64_encode
type: function
doc:
<comment>Description:</comment>
  MIME base64 方式でデータをエンコードする
  
  指定した <strong>$string</strong> を base64 でエンコードします。
  
  このエンコードは、メールの本体のように 8 ビットクリーンではないトランスポート層を通じても、 バイナ
  リデータが生き残れるように設計されています。
  
  Base64 でエンコードされたデータは、エンコード前のデータにくらべて 33% 余計に容量が必要です。

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  エンコードするデータ。

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

<comment>See Also:</comment>
   * <strong>base64_decode()</strong>
   * <strong>chunk_split()</strong>
   * <strong>convert_uuencode()</strong>
   * RFC 2045 6.8 節


id: base_convert
type: function
doc:
<comment>Description:</comment>
  数値の基数を任意に変換する
  
  <strong>$num</strong> を基数 <strong>$to_base</strong>  で表した文字列を返します。 <strong>$num</strong> の基数は、 <strong>$from_base</strong> で指定します。
  <strong>$from_base</strong> および <strong>$to_base</strong> は、ともに 2 から 36 までである必要があります。 10 より大きな基数を有す
  る数の各桁は、文字 a-z で表されます。 この場合、a は 10、b は 11、z は 35 を意味します。 <strong>$num</strong> は、
  大文字小文字を区別せずに扱います。
  
  大きな数値で <strong>base_convert()</strong> を使用すると、 精度が失われてしまうことがあります。これは、内部で使用
  している <info>float</info> の性質によるものです。詳細な情報や制限については マニュアルの浮動小数点数 のセク
  ションを参照ください。

<comment>Param:</comment>
  <info>string</info>  <strong>$num</strong>        変換する数値。 <strong>$num</strong> に無効な文字が含まれている場合は、 何もエラーを出さずにた
                      だ無視します。 PHP 7.4.0 以降は、無効な文字を与えることは推奨されません。
  <info>int</info>     <strong>$from_base</strong>  変換前の <strong>$num</strong> の基数。
  <info>int</info>     <strong>$to_base</strong>    変換後の <strong>$num</strong> の基数。

<comment>Return:</comment>
  <info>string</info>  <strong>$num</strong> を基数 <strong>$to_base</strong>  で表した値を返します。

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


id: basename
type: function
doc:
<comment>Description:</comment>
  パスの最後にある名前の部分を返す
  
  ファイルあるいはディレクトリへのパスを含む文字列を受け取って、 最後にある名前の部分を返します。
  
  <strong>basename()</strong> は、入力文字列を単純にそのまま処理します。 実際のファイルシステムを確認したり "<return>..</return>" のよ
  うなパスを気にしたりすることはありません。
  
  <strong>basename()</strong> はロケールに依存します。 マルチバイト文字を含むパスで正しい結果を得るには、それと一致す
  るロケールを <strong>setlocale()</strong> で設定しておかなければなりません。 現在のロケールから見て不正な文字が
  <strong>$path</strong> に含まれていた場合、 <strong>basename()</strong> の動作は未定義です。

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>    パス。
                   
                   Windows では、スラッシュ(<return>/</return>) とバックスラッシュ (<return>\</return>) の両方がディレクトリ区切り文字
                   として使われます。 その他の環境ではスラッシュ(<return>/</return>)になります。
  <info>string</info>  <strong>$suffix</strong>  名前の部分が <strong>$suffix</strong> で終了する場合、 この部分もカットされます。

<comment>Return:</comment>
  <info>string</info>  指定した <strong>$path</strong> のベース名を返します。

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


id: bcadd
type: function
doc:
<comment>Description:</comment>
  2つの任意精度の数値を加算する
  
  <strong>$num1</strong> を <strong>$num2</strong> に加算します。

<comment>Param:</comment>
  <info>string</info>    <strong>$num1</strong>   左オペランドを表す文字列。
  <info>string</info>    <strong>$num2</strong>   右オペランドを表す文字列。
  <info>int|null</info>  <strong>$scale</strong>  このオプションパラメータを使用して、結果の小数点以下の桁数を指定します。省略した
                    場合は、<strong>bcscale()</strong> 関数でグローバルに設定した桁数をデフォルトとして使用します。そ
                    れも設定されていない場合は <return>0</return> を使用します。

<comment>Return:</comment>
  <info>string</info>  二つの数の和を文字列で返します。

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


id: bccomp
type: function
doc:
<comment>Description:</comment>
  2 つの任意精度数値を比較する
  
  <strong>$num1</strong> と <strong>$num2</strong> を比較し、 結果を整数値で返します。

<comment>Param:</comment>
  <info>string</info>    <strong>$num1</strong>   左オペランドを表す文字列。
  <info>string</info>    <strong>$num2</strong>   右オペランドを表す文字列。
  <info>int|null</info>  <strong>$scale</strong>  オプションの <strong>$scale</strong> パラメータで、 小数点以下の桁数を指定します。ここまでを使用
                    して比較を行います。

<comment>Return:</comment>
  <info>int</info>  ふたつのオペランドが等しければ 0、 <strong>$num1</strong> が <strong>$num2</strong> より大きければ戻り値は 1、小さければ -1 を
       返します。


id: bcdiv
type: function
doc:
<comment>Description:</comment>
  2つの任意精度数値で除算を行う
  
  <strong>$num1</strong> を <strong>$num2</strong> で除算します。

<comment>Param:</comment>
  <info>string</info>    <strong>$num1</strong>   被除数を表す文字列。
  <info>string</info>    <strong>$num2</strong>   割る数を表す文字列。
  <info>int|null</info>  <strong>$scale</strong>  このオプションパラメータを使用して、結果の小数点以下の桁数を指定します。省略した
                    場合は、<strong>bcscale()</strong> 関数でグローバルに設定した桁数をデフォルトとして使用します。そ
                    れも設定されていない場合は <return>0</return> を使用します。

<comment>Return:</comment>
  <info>string</info>  除算結果を文字列で返します。 <strong>$num2</strong> が 0 の場合は <info>null</info> を返します。

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


id: bcmod
type: function
doc:
<comment>Description:</comment>
  2 つの任意精度数値の剰余を取得する
  
  <strong>$num1</strong> の、 <strong>$num2</strong> を法とする剰余を取得します。 <strong>$num2</strong> が 0でなければ、 結果は <strong>$num1</strong> と同じ符号を持ち
  ます。

<comment>Param:</comment>
  <info>string</info>  <strong>$num1</strong>  被除数を表す文字列。
  <info>string</info>  <strong>$num2</strong>  割る数を表す文字列。

<comment>Return:</comment>
  <info>string</info>  剰余を文字列で返します。 <strong>$num2</strong> が 0 の場合は <info>null</info> を返します。

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


id: bcmul
type: function
doc:
<comment>Description:</comment>
  2つの任意精度数値の乗算を行う
  
  <strong>$num1</strong> に <strong>$num2</strong> を掛けます。

<comment>Param:</comment>
  <info>string</info>    <strong>$num1</strong>   左オペランドを表す文字列。
  <info>string</info>    <strong>$num2</strong>   右オペランドを表す文字列。
  <info>int|null</info>  <strong>$scale</strong>  このオプションパラメータを使用して、結果の小数点以下の桁数を指定します。省略した
                    場合は、<strong>bcscale()</strong> 関数でグローバルに設定した桁数をデフォルトとして使用します。そ
                    れも設定されていない場合は <return>0</return> を使用します。

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

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


id: bcpow
type: function
doc:
<comment>Description:</comment>
  任意精度数値をべき乗する
  
  <strong>$num</strong> の <strong>$exponent</strong> 乗を求めます。

<comment>Param:</comment>
  <info>string</info>    <strong>$num</strong>       基数を表す文字列。
  <info>string</info>    <strong>$exponent</strong>  指数を表す文字列。 指数が整数でない場合、値は切り捨てられます。 正しい指数の
                       範囲はプラットフォーム依存ですが、 少なくとも <return>-2147483648</return> から <return>2147483647</return> ま
                       での範囲を持ちます。
  <info>int|null</info>  <strong>$scale</strong>     このオプションパラメータを使用して、結果の小数点以下の桁数を指定します。省略
                       した場合は、<strong>bcscale()</strong> 関数でグローバルに設定した桁数をデフォルトとして使用し
                       ます。それも設定されていない場合は <return>0</return> を使用します。

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

<comment>See Also:</comment>
   * <strong>bcpowmod()</strong>
   * <strong>bcsqrt()</strong>


id: bcpowmod
type: function
doc:
<comment>Description:</comment>
  任意精度数値のべき乗の、指定した数値による剰余
  
  <strong>$modulus</strong> で割った余りを求めることを考慮して、 <strong>$num</strong> の <strong>$exponent</strong> 乗を高速に計算します。

<comment>Param:</comment>
  <info>string</info>    <strong>$num</strong>       基数を表す整数の文字列。 (つまり、scale は 0 でなければいけません)
  <info>string</info>    <strong>$exponent</strong>  指数を表す、負でない、整数の文字列。 (つまり、scale は 0 でなければいけませ
                       ん)
  <info>string</info>    <strong>$modulus</strong>   法を表す、整数の文字列。 (つまり、scale は 0 でなければいけません)
  <info>int|null</info>  <strong>$scale</strong>     このオプションパラメータを使用して、結果の小数点以下の桁数を指定します。省略
                       した場合は、<strong>bcscale()</strong> 関数でグローバルに設定した桁数をデフォルトとして使用し
                       ます。それも設定されていない場合は <return>0</return> を使用します。

<comment>Return:</comment>
  <info>string</info>  結果を文字列で返します。<strong>$modulus</strong> が <return>0</return> の場合、 または  <strong>$exponent</strong> が負の場合、<info>false</info> を返し
          ます。

<comment>See Also:</comment>
   * <strong>bcpow()</strong>
   * <strong>bcmod()</strong>


id: bcscale
type: function
doc:
<comment>Description:</comment>
  すべての BC 演算関数におけるデフォルトのスケールを設定/取得する
  
  デフォルトのスケールを設定します。これ以降、 BC 演算関数で明示的にスケールを指定しなかった場合にこ
  の値を使用します。
  
  現在のスケールを取得します。

<comment>Param:</comment>
  <info>int</info>  <strong>$scale</strong>  スケール。

<comment>Return:</comment>
  <info>int</info>  スケールを設定する場合は、古いスケールを返します。 そうでない場合、現在のスケールを返します。


id: bcsqrt
type: function
doc:
<comment>Description:</comment>
  任意精度数値の平方根を取得する
  
  <strong>$num</strong> の平方根を返します。

<comment>Param:</comment>
  <info>string</info>    <strong>$num</strong>    オペランドを表す、BCMath で有効な数値形式の文字列。
  <info>int|null</info>  <strong>$scale</strong>  このオプションパラメータを使用して、結果の小数点以下の桁数を指定します。省略した
                    場合は、<strong>bcscale()</strong> 関数でグローバルに設定した桁数をデフォルトとして使用します。そ
                    れも設定されていない場合は <return>0</return> を使用します。

<comment>Return:</comment>
  <info>string</info>  平方根を、BCMath で有効な数値形式の文字列で返します。

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


id: bcsub
type: function
doc:
<comment>Description:</comment>
  任意精度数値の減算を行う
  
  <strong>$left_operand</strong> から <strong>$right_operand</strong> を引きます。

<comment>Param:</comment>
  <info></info>     <strong>$num1</strong>   左オペランドを表す文字列。
  <info></info>     <strong>$num2</strong>   右オペランドを表す文字列。
  <info>int</info>  <strong>$scale</strong>  このオプションパラメータを使用して、結果の小数点以下の桁数を指定します。省略した場合
               は、<strong>bcscale()</strong> 関数でグローバルに設定した桁数をデフォルトとして使用します。それも設定
               されていない場合は <return>0</return> を使用します。

<comment>Return:</comment>
  <info>string</info>  減算の結果を文字列で返します。

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


id: bin2hex
type: function
doc:
<comment>Description:</comment>
  バイナリのデータを16進表現に変換する
  
  <strong>$string</strong> を16進表現に変換したASCII文字列を返します。変換は、上位ニブルからバイト毎に行われます。

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

<comment>Return:</comment>
  <info>string</info>  指定した文字列を16進表現に変換したものを返します。

<comment>See Also:</comment>
   * <strong>hex2bin()</strong>
   * <strong>pack()</strong>


id: bind_textdomain_codeset
type: function
doc:
<comment>Description:</comment>
  DOMAIN メッセージカタログから返されるメッセージの文字エンコーディングを設定/取得する
  
  <strong>bind_textdomain_codeset()</strong> を使用することで、 <strong>gettext()</strong> やその類似の関数において返される、 <strong>$domain</strong>
  からのメッセージの文字エンコーディングを 設定したり、取得することが可能です。

<comment>Param:</comment>
  <info>string</info>       <strong>$domain</strong>   ドメイン。
  <info>string|null</info>  <strong>$codeset</strong>  コードセット。 <info>null</info> を指定すると、現在設定されているエンコーディングが返さ
                         れます。

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


id: bindec
type: function
doc:
<comment>Description:</comment>
  2 進数 を 10 進数に変換する
  
  引数 <strong>$binary_string</strong> により指定された 2 進数と等価な 10 進数を返します。
  
  <strong>bindec()</strong> は、2 進数を <info>int</info> に変換します。 サイズの問題により、必要に応じて <info>float</info> となることもありま
  す。
  
  <strong>bindec()</strong> は、すべての <strong>$binary_string</strong> 値を符号なし整数として扱います。 これは、<strong>bindec()</strong> が最上位
  ビットを 符号ビットではなく別の桁とみなすからです。

<comment>Param:</comment>
  <info>string</info>  <strong>$binary_string</strong>  変換したい 2 進数文字列。 <strong>$binary_string</strong> に無効な文字を与えても、静かに無
                          視されます。 PHP 7.4.0 以降では、無効な文字を与えることは推奨されません。

<comment>Return:</comment>
  <info>int|float</info>  <strong>$binary_string</strong> を 10 進に変換した値を返します。

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


id: bindtextdomain
type: function
doc:
<comment>Description:</comment>
  ドメインのパスを取得/設定する
  
  <strong>bindtextdomain()</strong> 関数は、ドメインへのパスを取得/設定します。

<comment>Param:</comment>
  <info>string</info>       <strong>$domain</strong>     ドメイン。
  <info>string|null</info>  <strong>$directory</strong>  ディレクトリのパス。 空文字列を指定すると、現在のディレクトリを指定したこ
                           とになります。 <info>null</info> を指定すると、現在設定されているディレクトリが返され
                           ます。

<comment>Return:</comment>
  <info>string|false</info>  現在設定されているドメインへのフルパスを返します。 失敗した場合に <info>false</info> を返します


id: boolval
type: function
doc:
<comment>Description:</comment>
  変数の boolean としての値を取得する
  
  <strong>$value</strong> の <info>bool</info> としての値を返します。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  <info>bool</info> に変換したいスカラー値。

<comment>Return:</comment>
  <info>bool</info>  <strong>$value</strong> の <info>bool</info> としての値を返します。

<comment>See Also:</comment>
   * <strong>floatval()</strong>
   * <strong>intval()</strong>
   * <strong>strval()</strong>
   * <strong>settype()</strong>
   * <strong>is_bool()</strong>
   * 型の相互変換


id: bzclose
type: function
doc:
<comment>Description:</comment>
  bzip2 ファイルを閉じる
  
  与えられた bzip2 ファイルポインタを閉じます。

<comment>Param:</comment>
  <info>resource</info>  <strong>$bz</strong>  ファイルポインタ。これは有効である必要があり、 <strong>bzopen()</strong> によりオープンされたファイ
                 ルを指している必要があります。

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

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


id: bzcompress
type: function
doc:
<comment>Description:</comment>
  文字列をbzip2形式のデータに圧縮する
  
  <strong>bzcompress()</strong> は、与えられた文字列を圧縮し、 bzip2 形式のデータとして返します。

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>         圧縮する文字列
  <info>int</info>     <strong>$block_size</strong>   圧縮時のブロック長を指定します。 1 から 9 の数とする必要があります。この場
                        合、9 の圧縮度が最大ですが、リソースの消費量も最大となります。
  <info>int</info>     <strong>$work_factor</strong>  繰り返しが多い、最悪の入力データの場合の圧縮処理の動作を制御します。 この値
                        は、0 から 250 までとなり、0 は特別な場合です。
                        
                        <strong>$work_factor</strong> によらず、 生成される出力は同じになります。

<comment>Return:</comment>
  <info>string|int</info>  圧縮された文字列、もしくはエラー時はエラー数

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


id: bzdecompress
type: function
doc:
<comment>Description:</comment>
  bzip2 形式のデータを解凍する
  
  <strong>bzdecompress()</strong> は、bzip2 形式のデータを含む文字列を解凍します。

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>             解凍する文字列
  <info>bool</info>    <strong>$use_less_memory</strong>  <info>true</info> の場合、よりメモリの消 費量が少ない (所要メモリは最大2300K程度まで
                            少なくなります) 別の圧縮アルゴリズムが使用されますが、速度は約半分になっ
                            てしまいます。
                            
                            この機能に関する詳細については、bzip2 ドキュメント を参照ください。

<comment>Return:</comment>
  <info>string|int|false</info>  解凍された文字列、もしくは or <info>false</info>。 エラー時はエラー数を返します。

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


id: bzerrno
type: function
doc:
<comment>Description:</comment>
  bzip2 エラー番号を返す
  
  与えられたファイルポインタから返された bzip2 エラーのエラー番号を返します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$bz</strong>  ファイルポインタ。これは有効である必要があり、 <strong>bzopen()</strong> によりオープンされたファイ
                 ルを指してい る必要があります。

<comment>Return:</comment>
  <info>int</info>  整数としてのエラー番号を返します。

<comment>See Also:</comment>
   * <strong>bzerror()</strong>
   * <strong>bzerrstr()</strong>


id: bzerror
type: function
doc:
<comment>Description:</comment>
  bzip2 エラー番号とエラー文字列を配列で返す
  
  与えられたファイルポインタから返された bzip2 エラーのエラー番号とエラー文字列を返します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$bz</strong>  ファイルポインタ。これは有効である必要があり、 <strong>bzopen()</strong> によりオープンされたファイ
                 ルを指してい る必要があります。

<comment>Return:</comment>
  <info>array</info>  <return>errno</return> エントリにエラーコード、<return>errstr</return> エントリにエラーメッセージを持つ連想配列を返します。

<comment>See Also:</comment>
   * <strong>bzerrno()</strong>
   * <strong>bzerrstr()</strong>


id: bzerrstr
type: function
doc:
<comment>Description:</comment>
  bzip2 エラー文字列を返す
  
  与えられたファイルポインタから返された bzip2 エラーのエラーの文字列を返します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$bz</strong>  ファイルポインタ。これは有効である必要があり、 <strong>bzopen()</strong> によりオープンされたファイ
                 ルを指してい る必要があります。

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

<comment>See Also:</comment>
   * <strong>bzerrno()</strong>
   * <strong>bzerror()</strong>


id: bzflush
type: function
doc:
<comment>Description:</comment>
  何もしない
    
  
  バッファリングされた全ての bzip2 データをファイルポインタ <strong>$bz</strong> に書き込むことが想定された関数です。
  しかし、libbz2 では null な関数として実装されており、何もしません。

<comment>Param:</comment>
  <info>resource</info>  <strong>$bz</strong>  ファイルポインタ。これは有効である必要があり、 <strong>bzopen()</strong> によりオープンされたファイ
                 ルを指してい る必要があります。

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

<comment>See Also:</comment>
   * <strong>bzread()</strong>
   * <strong>bzwrite()</strong>


id: bzopen
type: function
doc:
<comment>Description:</comment>
  bzip2 圧縮されたファイルをオープンする
  
  <strong>bzopen()</strong> は、 bzip2 (.bz2) ファイルを読み書き用にオープンします。

<comment>Param:</comment>
  <info>string|resource</info>  <strong>$file</strong>  オープンするファイル名、あるいは既存のストリームリソース
  <info>string</info>           <strong>$mode</strong>  <return>'r'</return> (読み込み) と <return>'w'</return> (書き込み) だけをサポートしています。 それ以外を指定
                          すると <strong>bzopen()</strong> は <info>false</info> を返します。

<comment>Return:</comment>
  <info>resource|false</info>  オープンできなかった場合、<strong>bzopen()</strong> は <info>false</info> を返します。それ以外の場合は、 新規に
                  オープンされたファイルへのポインタが返されます。

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


id: bzread
type: function
doc:
<comment>Description:</comment>
  バイナリ対応の bzip2 ファイル読み込み
  
  <strong>bzread()</strong> は、与えられた bzip2 ファイルポインタから読み込みます。
  
  読み込みは、(圧縮前の状態で) <strong>$length</strong> バイトが読み込まれたか、EOF に達したかのどちらか最初に来た方
  で終了します。

<comment>Param:</comment>
  <info>resource</info>  <strong>$bz</strong>      ファイルポインタ。これは有効である必要があり、 <strong>bzopen()</strong> によりオープンされた
                     ファイルを指してい る必要があります。
  <info>int</info>       <strong>$length</strong>  指定されない場合、<strong>bzread()</strong> は一度に (圧縮前の状態で) 1024バイト読み込みます。
                     最大で 8192 バイト (圧縮前) までを一度に読み込みます。

<comment>Return:</comment>
  <info>string|false</info>  非圧縮データ、もしくはエラー時に <info>false</info> を返します。

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


id: bzwrite
type: function
doc:
<comment>Description:</comment>
  バイナリ対応の bzip2 ファイルへの書き込み
  
  <strong>bzwrite()</strong> は、文字列を与えられた bzip2 ファイルストリームに書き込みます。

<comment>Param:</comment>
  <info>resource</info>  <strong>$bz</strong>      ファイルポインタ。これは有効である必要があり、 <strong>bzopen()</strong> によりオープンされた
                     ファイルを指してい る必要があります。
  <info>string</info>    <strong>$data</strong>    書き込むデータ
  <info>int|null</info>  <strong>$length</strong>  指定した場合、 (圧縮前の) <strong>$length</strong> バイト分の書き込みが終ったか、 <strong>$data</strong> の終端に
                     達したかで書き込みは終了します。

<comment>Return:</comment>
  <info>int|false</info>  書き込んだバイト数、もしくはエラー時に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>bzread()</strong>
   * <strong>bzopen()</strong>


id: cal_days_in_month
type: function
doc:
<comment>Description:</comment>
  指定した年とカレンダーについて、月の日数を返す
  
  この関数は、指定した <strong>$calendar</strong> について <strong>$year</strong> 年 <strong>$month</strong> 月の日数を返します。

<comment>Param:</comment>
  <info>int</info>  <strong>$calendar</strong>  計算に使用するカレンダー。
  <info>int</info>  <strong>$month</strong>     選択したカレンダーにおける月。
  <info>int</info>  <strong>$year</strong>      選択したカレンダーにおける年。

<comment>Return:</comment>
  <info>int</info>  指定したカレンダーの、その月の日数を返します。


id: cal_from_jd
type: function
doc:
<comment>Description:</comment>
  ユリウス積算日からサポートされるカレンダーに変換する
  
  <strong>cal_from_jd()</strong> は、 <strong>$julian_day</strong> で指定したユリウス日を 指定した <strong>$calendar</strong> に変換します。 サポートさ
  れる <strong>$calendar</strong> の値は、 <info>CAL_GREGORIAN</info>、 <info>CAL_JULIAN</info>、 <info>CAL_JEWISH</info> および <info>CAL_FRENCH</info> です。

<comment>Param:</comment>
  <info>int</info>  <strong>$julian_day</strong>  ユリウス日を表す整数値。
  <info>int</info>  <strong>$calendar</strong>    変換するカレンダー。

<comment>Return:</comment>
  <info>array</info>  カレンダーの情報を含む配列を返します。この配列には、 年、月、日、週(<return>dow</return>)、曜日名、月名、"月
         /日/年" 形式の文字列 などが含まれます。 曜日は <return>0</return> (日曜日) から <return>6</return> (土曜日) までの値を取りま
         す。

<comment>See Also:</comment>
   * <strong>cal_to_jd()</strong>
   * <strong>jdtofrench()</strong>
   * <strong>jdtogregorian()</strong>
   * <strong>jdtojewish()</strong>
   * <strong>jdtojulian()</strong>
   * <strong>jdtounix()</strong>


id: cal_info
type: function
doc:
<comment>Description:</comment>
  特定のカレンダーに関する情報を返す
  
  <strong>cal_info()</strong> は、指定した <strong>$calendar</strong> についての情報を返します。
  
  カレンダーの情報は配列として返され、その要素は <return>calname</return>、<return>calsymbol</return>、 <return>month</return>、<return>abbrevmonth</return> および
  <return>maxdaysinmonth</return> となります。 <strong>$calendar</strong> として指定可能なカレンダー名は以下のとおりです。  0 あるいは
  <info>CAL_GREGORIAN</info> - グレゴリウス暦  1 あるいは <info>CAL_JULIAN</info> - ユリウス暦  2 あるいは <info>CAL_JEWISH</info> - ユダヤ
  暦  3 あるいは <info>CAL_FRENCH</info> - フランス革命暦
  
  0 あるいは <info>CAL_GREGORIAN</info> - グレゴリウス暦
  
  1 あるいは <info>CAL_JULIAN</info> - ユリウス暦
  
  2 あるいは <info>CAL_JEWISH</info> - ユダヤ暦
  
  3 あるいは <info>CAL_FRENCH</info> - フランス革命暦
  
  <strong>$calendar</strong> が指定されなかった場合は、 サポートするすべてのカレンダーの情報を配列で返します。

<comment>Param:</comment>
  <info>int</info>  <strong>$calendar</strong>  情報を返したいカレンダー。指定しなかった場合は、 すべてのカレンダーに関する情報を
                  返します。

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


id: cal_to_jd
type: function
doc:
<comment>Description:</comment>
  サポートされるカレンダーからユリウス積算日に変換する
  
  <strong>cal_to_jd()</strong> は、指定した <strong>$calendar</strong> の日付からユリウス積算日を計算します。 サポートされる <strong>$calendar</strong>
  は <info>CAL_GREGORIAN</info>、 <info>CAL_JULIAN</info>、 <info>CAL_JEWISH</info> および <info>CAL_FRENCH</info> です。

<comment>Param:</comment>
  <info>int</info>  <strong>$calendar</strong>  変換元のカレンダー。 <info>CAL_GREGORIAN</info>、 <info>CAL_JULIAN</info>、 <info>CAL_JEWISH</info> あるいは <info>CAL_FRENCH</info>
                  のいずれか。
  <info>int</info>  <strong>$month</strong>     月を表す数値。有効な範囲は <strong>$calendar</strong> に依存します。
  <info>int</info>  <strong>$day</strong>       日を表す数値。有効な範囲は <strong>$calendar</strong> に依存します。
  <info>int</info>  <strong>$year</strong>      年を表す数値。有効な範囲は <strong>$calendar</strong> に依存します。

<comment>Return:</comment>
  <info>int</info>  ユリウス積算日を返します。

<comment>See Also:</comment>
   * <strong>cal_from_jd()</strong>
   * <strong>frenchtojd()</strong>
   * <strong>gregoriantojd()</strong>
   * <strong>jewishtojd()</strong>
   * <strong>juliantojd()</strong>
   * <strong>unixtojd()</strong>


id: call_user_func
type: function
doc:
<comment>Description:</comment>
  最初の引数で指定したコールバック関数をコールする
  
  パラメータ <strong>$callback</strong> で指定したユーザー定義のコールバック関数をコールします。

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  コールする <info>callable</info>。
  <info>mixed</info>     <strong>$args</strong>      コールバック関数に渡す、ゼロ個以上のパラメータ。
                       
                       <strong>call_user_func()</strong> のパラメータは 参照渡しではないことに注意しましょう。
                       <strong>call_user_func()</strong> の例と参照
                       ]]>上の例の出力は以下となります。
                       
                       上の例の出力は以下となります。

<comment>Return:</comment>
  <info>mixed</info>  コールバック関数の結果を返します。

<comment>See Also:</comment>
   * <strong>call_user_func_array()</strong>
   * <strong>is_callable()</strong>
   * Variable functions
   * ReflectionFunction::invoke
   * ReflectionMethod::invoke


id: call_user_func_array
type: function
doc:
<comment>Description:</comment>
  パラメータの配列を指定してコールバック関数をコールする
  
  <strong>$args</strong> にパラメータを指定して、 <strong>$callback</strong> で指定したユーザー定義関数をコールします。

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  コールする<info>callable</info>。
  <info>array</info>     <strong>$args</strong>      コールバック関数に渡すパラメータを指定する配列。
                       
                       <strong>$args</strong> のキーがすべて数値の場合、 キーは無視され、それぞれの要素が <strong>$callback</strong>
                       の位置を指定した引数として順番に渡されます。
                       
                       <strong>$args</strong> のキーのいずれかが文字列の場合、 それらの要素は <strong>$callback</strong> の名前付き引
                       数として渡されます。 その場合、名前は配列のキーが使われます。
                       
                       <strong>$args</strong> の数値のキーが文字列のキーの後に現れたり、 文字列のキーが <strong>$callback</strong> の
                       パラメータの名前にマッチしない場合、致命的なエラーが発生します。

<comment>Return:</comment>
  <info>mixed</info>  コールバック関数の結果、あるいはエラー時に <info>false</info> を返します。

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


id: ceil
type: function
doc:
<comment>Description:</comment>
  端数の切り上げ
  
  必要に応じて <strong>$num</strong> を切り上げ、 <strong>$num</strong> の次に大きい整数値を返します。

<comment>Param:</comment>
  <info>int|float</info>  <strong>$num</strong>  丸める値。

<comment>Return:</comment>
  <info>float</info>  <strong>$num</strong> の次に大きい整数値を返します。 <strong>ceil()</strong> の戻り値は <info>float</info> 型と なります。これは、<info>float</info> 値
         の範囲は通常 <info>int</info> よりも広いためです。

<comment>See Also:</comment>
   * <strong>floor()</strong>
   * <strong>round()</strong>


id: chdir
type: function
doc:
<comment>Description:</comment>
  ディレクトリを変更する
  
  PHP のカレントディレクトリを <strong>$directory</strong> に変更します。

<comment>Param:</comment>
  <info>string</info>  <strong>$directory</strong>  新しいカレントディレクトリ

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

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


id: checkdate
type: function
doc:
<comment>Description:</comment>
  グレゴリオ暦の日付/時刻の妥当性を確認します
  
  引数で指定された日付の妥当性をチェックします。 各パラメータが適切に指定されている場合に、妥当であ
  ると判断されます。

<comment>Param:</comment>
  <info>int</info>  <strong>$month</strong>  月は 1 から 12 の間となります。
  <info>int</info>  <strong>$day</strong>    日は、指定された <strong>$month</strong> の日数の範囲内になります。<strong>$year</strong> がうるう年の場合は、それも考
               慮されます。
  <info>int</info>  <strong>$year</strong>   年は 1 から 32767 の間となります。

<comment>Return:</comment>
  <info>bool</info>  指定した日付が有効な場合に <info>true</info>、そうでない場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>mktime()</strong>
   * <strong>strtotime()</strong>


id: checkdnsrr
type: function
doc:
<comment>Description:</comment>
  指定したインターネットホスト名もしくは IP アドレスに対応する DNS レコードを検索する
  
  <strong>$hostname</strong> に対応する <strong>$type</strong> 型のレコードを DNS から探します。

<comment>Param:</comment>
  <info>string</info>  <strong>$hostname</strong>  <strong>$hostname</strong> は、ドットで 4 つに分けられた形式の IP アドレスか、あるいはホスト名で
                     す。
  <info>string</info>  <strong>$type</strong>      <strong>$type</strong>は、A, MX, NS, SOA, PTR, CNAME, AAAA, A6, SRV, NAPTR, ANY のどれか一つで
                     す。

<comment>Return:</comment>
  <info>bool</info>  レコードが見つかった場合に <info>true</info>、 何も見つからないかエラーが発生した場合に <info>false</info> を返しま
        す。

<comment>See Also:</comment>
   * <strong>dns_get_record()</strong>
   * <strong>getmxrr()</strong>
   * <strong>gethostbyaddr()</strong>
   * <strong>gethostbyname()</strong>
   * <strong>gethostbynamel()</strong>
   * the named(8) manual page


id: chgrp
type: function
doc:
<comment>Description:</comment>
  ファイルのグループを変更する
  
  (名前または番号で指定した)ファイル <strong>$filename</strong> のグループを <strong>$group</strong> に変更しようと試みます。
  
  スーパーユーザーのみがファイルのグループを任意に変更できます。 その他のユーザーは、ファイルのグ
  ループをそのユーザーがメンバーとして 属しているグループに変更できます。

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

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

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


id: chmod
type: function
doc:
<comment>Description:</comment>
  ファイルのモードを変更する
  
  指定されたファイルのモードを <strong>$permissions</strong> で指定したものに変更しようと試みます。

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>     ファイルへのパス。
  <info>int</info>     <strong>$permissions</strong>  <strong>$permissions</strong> は自動的には 8 進数と見なされないので注意してください。 意図し
                        た操作を行うには、<strong>$permissions</strong> の前にゼロ(0)を付ける必要があります。 "g+w"
                        のような文字列は正常に動作しません。
                        
                        
                        ]]>
                        
                        <strong>$permissions</strong> 引数は 3 つの 8 進法による数値で構成され、 所有者自身、所有者が
                        属するグループ、その他のユーザーの順で アクセス制限を設定します。一つ一つの
                        数字はそのターゲットに対し 許可を与えます。1 は実行権限、2 はファイルに対す
                        る書き込み権限、 4 はファイルに対する読み込み権限を与えます。 必要な権限にあ
                        わせ数値を加算してください。 許可モードに関する詳細は Unix システムの 「man
                        1 chmod」や「man 2 chmod」をご覧ください。
                        
                        
                        ]]>

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

<comment>See Also:</comment>
   * <strong>chown()</strong>
   * <strong>chgrp()</strong>
   * <strong>fileperms()</strong>
   * <strong>stat()</strong>


id: chown
type: function
doc:
<comment>Description:</comment>
  ファイルの所有者を変更する
  
  ファイル<strong>$filename</strong>の所有者を(名前または番号で指定した) ユーザー<strong>$user</strong>に変更しようと試みます。 スー
  パーユーザーのみがファイルの所有者を変更できます。

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

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

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


id: chr
type: function
doc:
<comment>Description:</comment>
  数値から、1バイトの文字列を生成する
  
  <strong>$codepoint</strong> を符号なし数値と解釈することによって指定された文字を含む、 1文字からなる文字列を返しま
  す。
  
  この関数は、ASCII, ISO-8859, Windows 1252 のような シングルバイトエンコーディング  においては、文
  字セットのマッピングテーブルにある望みの文字の位置を   渡すことで、一文字の文字列を作り出すのに使
  えます。 しかし、この関数は <strong>$string</strong> のエンコーディングについて知りませんし、 特に UTF-8 や UTF-16
  のようなマルチバイトエンコーディングについては、 この関数に Unicode のコードポイントは渡せないこと
  に注意してください。
  
  この関数は<strong>ord()</strong>の逆の動作をします。

<comment>Param:</comment>
  <info>int</info>  <strong>$codepoint</strong>  0 から 255 までの数値
                   
                   妥当な範囲 (0..255) 外の値を渡した場合は、255 とのビット AND を行います。 この処
                   理は、以下のコードと同様のアルゴリズムです。

<comment>Return:</comment>
  <info>string</info>  指定されたバイトを含む、一文字からなる文字列を返します。

<comment>See Also:</comment>
   * <strong>sprintf()</strong> のフォーマット文字列 <return>%c</return>
   * <strong>ord()</strong>
   * ASCII テーブル
   * <strong>mb_chr()</strong>
   * <strong>IntlChar::chr()</strong>


id: chroot
type: function
doc:
<comment>Description:</comment>
  ルートディレクトリを変更する

<comment>Param:</comment>
  <info>string</info>  <strong>$directory</strong>  ルートディレクトリの変更先のパス。

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


id: chunk_split
type: function
doc:
<comment>Description:</comment>
  文字列をより小さな部分に分割する
  
  文字列をより小さな部分に分割する際に使用され、 <strong>base64_encode()</strong> の出力を RFC 2045の規約に基づいた出
  力に変換するといった用途に適しています。 この関数は、<strong>$length</strong> 文字毎に文字列 <strong>$separator</strong> を挿入しま
  す。

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>     分割したい文字列。
  <info>int</info>     <strong>$length</strong>     各部分の長さ。
  <info>string</info>  <strong>$separator</strong>  行末の区切り。

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

<comment>See Also:</comment>
   * <strong>str_split()</strong>
   * <strong>explode()</strong>
   * <strong>wordwrap()</strong>
   * RFC 2045


id: class_alias
type: function
doc:
<comment>Description:</comment>
  クラスのエイリアスを作成する
  
  <strong>$alias</strong> という名前のエイリアスを、 ユーザー定義のクラス <strong>$class</strong> に対して作成します。 エイリアスは、
  元のクラスとまったく同一のものとなります。

<comment>Param:</comment>
  <info>string</info>  <strong>$class</strong>     元となるクラス。
  <info>string</info>  <strong>$alias</strong>     クラスのエイリアス名。
  <info>bool</info>    <strong>$autoload</strong>  元のクラスが見つからない場合に オートロード するかどうか。

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

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


id: class_exists
type: function
doc:
<comment>Description:</comment>
  クラスが定義済みかどうかを確認する
  
  この関数は指定したクラスが定義されているかどうかを調べます。

<comment>Param:</comment>
  <info>string</info>  <strong>$class</strong>     クラス名。大文字小文字は区別しません。
  <info>bool</info>    <strong>$autoload</strong>  まだロードされていない場合に オートロード するかどうか。

<comment>Return:</comment>
  <info>bool</info>  クラス <strong>$class</strong> が定義されている場合に <info>true</info>、 それ以外の場合に <info>false</info> を返します。

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


id: class_implements
type: function
doc:
<comment>Description:</comment>
  与えられたクラスあるいはインターフェイスが実装しているインターフェイスを返す
    
  
  この関数は、与えられたクラス <strong>$object_or_class</strong> とその親が実装しているインターフェイスを配列で返しま
  す。

<comment>Param:</comment>
  <info>object|string</info>  <strong>$object_or_class</strong>  オブジェクト (クラスのインスタンス) もしくは文字列 (クラス名ある
                                   いはインターフェイス名) を指定します。
  <info>bool</info>           <strong>$autoload</strong>         まだロードされていない場合に オートロード するかどうか。

<comment>Return:</comment>
  <info>array|false</info>  成功した場合に配列、 指定されたクラスが存在しない場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>class_parents()</strong>
   * <strong>get_declared_interfaces()</strong>
   * <strong>is_a()</strong>
   * <return>instanceof</return>


id: class_parents
type: function
doc:
<comment>Description:</comment>
  与えられたクラスの親クラスを返す
    
  
  この関数は、与えられたクラス <strong>$object_or_class</strong> の親クラス名を 配列で返します。

<comment>Param:</comment>
  <info>object|string</info>  <strong>$object_or_class</strong>  オブジェクトもしくはクラスの文字列を指定します。
  <info>bool</info>           <strong>$autoload</strong>         まだロードされていない場合に オートロード するかどうか。

<comment>Return:</comment>
  <info>array|false</info>  成功した場合に配列、 指定されたクラスが存在しない場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>class_implements()</strong>
   * <strong>is_a()</strong>
   * <return>instanceof</return>


id: class_uses
type: function
doc:
<comment>Description:</comment>
  指定したクラスが使っているトレイトを返す
    
  
  この関数は、指定した <strong>$object_or_class</strong> が使っているトレイトの名前を配列で返します。 しかし、親クラ
  スで使っているトレイトは含まれません。

<comment>Param:</comment>
  <info>object|string</info>  <strong>$object_or_class</strong>  オブジェクト (クラスのインスタンス) あるいは文字列 (クラス名)。
  <info>bool</info>           <strong>$autoload</strong>         まだロードされていない場合に オートロード するかどうか。

<comment>Return:</comment>
  <info>array|false</info>  成功した場合に配列、 指定されたクラスが存在しない場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>class_parents()</strong>
   * <strong>get_declared_traits()</strong>


id: clearstatcache
type: function
doc:
<comment>Description:</comment>
  ファイルのステータスのキャッシュをクリアする
  
  statやlstat、 またはその他の関数（後述）を使用すると、PHPはパフォーマンス向上のために それらの関数
  の戻り値をキャッシュします。しかし、ケースによっては、 キャッシュされた情報を消去したい場合もある
  でしょう。 例えば、一つのスクリプト上で同じファイルが何度もチェックされ、 そのファイルが変更された
  り削除されたりする可能性がある場合、 ステータスキャッシュを消去しなければならないと感じるでしょ
  う。 このようなケースでは、<strong>clearstatcache()</strong>を使用することで ファイルの情報に関してPHPが持っている
  キャッシュをクリアすることができます。
  
  PHP は存在しないファイルについての情報はキャッシュしないことにも 注意してください。もし存在しない
  ファイルに対して <strong>file_exists()</strong> をコールする場合、ファイルを作成するまで この関数は <info>false</info> を返しま
  す。もしファイルを作成した場合、 たとえファイルを削除したとしても <info>true</info> を返します。 しかし、
  <strong>unlink()</strong> はキャッシュを自動的にクリアします。
  
  この関数は特定のファイルに関する情報をキャッシュします。したがって、 同じファイルについて複数回の
  操作を行いそのファイルに関する情報を キャッシュされないようにするためには、 <strong>clearstatcache()</strong>をコー
  ルするだけです。
  
  影響を受ける関数を以下に示します。 <strong>stat()</strong>, <strong>lstat()</strong>, <strong>file_exists()</strong>, <strong>is_writable()</strong>, <strong>is_readable()</strong>,
  <strong>is_executable()</strong>, <strong>is_file()</strong>, <strong>is_dir()</strong>, <strong>is_link()</strong>, <strong>filectime()</strong>, <strong>fileatime()</strong>, <strong>filemtime()</strong>,
  <strong>fileinode()</strong>, <strong>filegroup()</strong>, <strong>fileowner()</strong>, <strong>filesize()</strong>, <strong>filetype()</strong>, および <strong>fileperms()</strong>.

<comment>Param:</comment>
  <info>bool</info>    <strong>$clear_realpath_cache</strong>  realpath キャッシュもクリアするかどうか。
  <info>string</info>  <strong>$filename</strong>              realpath キャッシュを特定のファイル名だけに対してクリアする。
                                 <strong>$clear_realpath_cache</strong> が <info>true</info> の場合にのみ使用。

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


id: cli_get_process_title
type: function
doc:
<comment>Description:</comment>
  現在のプロセスのタイトルを返す
  
  現在のプロセスのタイトルを返します。これは <strong>cli_set_process_title()</strong> で設定したものです。 これは、ps
  や top で表示されるタイトルと必ずしも一致するとは限りません。OS に依存します。
  
  この関数は、 CLI モードでしか使えません。

<comment>Return:</comment>
  <info>string|null</info>  現在のプロセスのタイトルを文字列で返します。エラー時には <info>null</info> を返します。

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


id: cli_set_process_title
type: function
doc:
<comment>Description:</comment>
  プロセスのタイトルを設定する
  
  プロセスのタイトルを設定します。これは top や ps といったツールで表示されます。 この関数は、 CLI
  モードでしか使えません。

<comment>Param:</comment>
  <info>string</info>  <strong>$title</strong>  新しいタイトル。

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

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


id: closedir
type: function
doc:
<comment>Description:</comment>
  ディレクトリハンドルをクローズする
  
  <strong>$dir_handle</strong> で指定したディレクトリのストリームをクローズします。このストリームは、 <strong>opendir()</strong>により
  事前にオープンされていなければ なりません。

<comment>Param:</comment>
  <info>resource|null</info>  <strong>$dir_handle</strong>  <strong>opendir()</strong> が事前にオープンした ディレクトリハンドル<info>リソース</info>。 ディレク
                              トリハンドルを指定しなかった場合は、 <strong>opendir()</strong> が最後にオープンしたも
                              のを使用します。

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


id: closelog
type: function
doc:
<comment>Description:</comment>
  システムログへの接続を閉じる
  
  <strong>closelog()</strong> はシステムログへの書きこみに使用されているデスクプリタを閉じます。 <strong>closelog()</strong> の使用は
  オプションです。

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

<comment>See Also:</comment>
   * <strong>syslog()</strong>
   * <strong>openlog()</strong>


id: com
type: class
doc:
<comment>Description:</comment>
  com クラスにより、OLE 互換の COM オブジェクトのインスタンスを作成し、 そのメソッドをコールしたりそ
  のプロパティにアクセスしたりすることが 可能となります。


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

<comment>Param:</comment>
  <info>string</info>             <strong>$module_name</strong>  ロードするコンポーネントの名前を表す ProgID, ClassID または
                                   Moniker。
                                   
                                   ProgID は通常、アプリケーションまたは DLL の名前で、その後にピリ
                                   オドが続き、 オブジェクト名が続きます。e.g: <return>Word.Application</return>
                                   
                                   ClassID は、与えられたクラスを一意に識別するUUIDです。
                                   
                                   Moniker は、URL スキームの概念に似た特別な名前付けのやり方で、 リ
                                   ソースを識別し、どのようにロードするかを指定します。 たとえば、
                                   Microsoft Word をロードし、 Word ドキュメントを表現するオブジェク
                                   トを取得するために、 フルパスをモジュール名として指定できます。
                                   また、LDAP への ADSI インターフェイスを使う moniker として <return>LDAP:</return>
                                   が使えます。
  <info>array|string|null</info>  <strong>$server_name</strong>  コンポーネントをロードし、実行する DCOM サーバー名。 <info>null</info> の場
                                   合、そのアプリケーションのデフォルトが使われ、実行されます。 デ
                                   フォルトは通常はローカルマシン上で実行することですが、 管理者が異
                                   なるマシン上で起動するアプリケーションを設定するかもしれません。
                                   
                                   server に <info>null</info> でない値を指定すると、PHP は com.allow_dcom
                                   php.ini 設定オプションが <info>true</info> でない限りオブジェクトのロードを拒
                                   否します。
                                   
                                   <strong>$server_name</strong> が配列の場合、 次の要素が含まれるべきです(大文字小文
                                   字を区別します！)。 但し、これらは全てオプション(ユーザー名とパス
                                   ワードは一緒に指定する必要があります) であることに注意してくださ
                                   い。つまり、サーバーの設定を省略すると、 (既に述べたとおり)デフォ
                                   ルトのサーバーが使われ、オブジェクトのインスタンス化は
                                   com.allow_dcom php.ini ディレクティブによって影響を受けません。
                                   DCOM サーバー名キータイプ説明Serverstringサーバー名
                                   Usernamestring接続するユーザ名Passwordstring<return>Username</return> のパスワード
                                   Domainstring<return>server</return> のドメインFlagsinteger以下の定数をひとつ以上、
                                   論理ORで指定します: <info>CLSCTX_INPROC_SERVER</info>, <info>CLSCTX_INPROC_HANDLER</info>,
                                   <info>CLSCTX_LOCAL_SERVER</info>, <info>CLSCTX_REMOTE_SERVER</info>, <info>CLSCTX_SERVER</info> および
                                   <info>CLSCTX_ALL</info>。 指定されなかった場合のデフォルト値は <return>Server</return> も省略し
                                   た場合は、 <info>CLSCTX_SERVER</info> ですが、 server を指定した場合は
                                   <info>CLSCTX_REMOTE_SERVER</info> です。 これらの定数の意味の詳細情報は、
                                   Microsoft の CoCreateInstance のドキュメントも参照ください。 通
                                   常、それらを使わないことはないはずです。
  <info>int</info>                <strong>$codepage</strong>     文字列をUnicode文字列その他に変換するために使うコードページを指定
                                   します。 PHP の文字列が この COM オブジェクトのメソッドとパラメー
                                   タをやりとりする時に 常にこの変換は適用されます。このコードページ
                                   は sticky です。 つまり、コードページはオブジェクトから返されるオ
                                   ブジェクトやバリアントに伝播するということです。
                                   
                                   有効な値は  <info>CP_ACP</info> (システムデフォルトの ANSI コードページを使う
                                   - このパラメータが省略された場合のデフォルト値), <info>CP_MACCP</info>,
                                   <info>CP_OEMCP</info>, <info>CP_SYMBOL</info>, <info>CP_THREAD_ACP</info> (現在実行中のスレッドのコード
                                   ページ/ロケールを使う), <info>CP_UTF7</info> および <info>CP_UTF8</info> です。 コードペー
                                   ジの数値も使えます。 コードページとその数値に関する詳細な情報は、
                                   Microsoft のドキュメントを参照ください。


id: com_create_guid
type: function
doc:
<comment>Description:</comment>
  グローバルユニーク ID (GUID) を生成する
  
  グローバルユニーク ID (GUID) を生成します。
  
  GUID は DCE UUID と同様の方法で生成されますが、Microsoft の 規約により、GUID が中括弧で囲まれると
  いう点が異なります。

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

<comment>See Also:</comment>
   * PECL uuid 拡張モジュールの <strong>uuid_create()</strong>


id: com_event_sink
type: function
doc:
<comment>Description:</comment>
  COM オブジェクトのイベントを PHP オブジェクトに接続する
  
  <strong>$variant</strong> が生成したイベントを PHP オブジェクト <strong>$sink_object</strong> に通知するよう、COM に指示します。
  
  この機能を利用する際には注意しましょう。もし以下の例のようなことを 行いたいのであれば、Web サー
  バー上でそれを行うことには まったく意味がありません。

<comment>Param:</comment>
  <info>variant</info>            <strong>$variant</strong>         
  <info>object</info>             <strong>$sink_object</strong>     <strong>$sink_object</strong> には、要求されるディスパッチ インターフェイスと同
                                      じ名前のメソッドを持つクラスのインスタンスを 指定する必要があ
                                      ります。この要求を満たすクラスを作成するために、
                                      <strong>com_print_typeinfo()</strong> を使用することができます。
  <info>array|string|null</info>  <strong>$sink_interface</strong>  PHP は <strong>$variant</strong> に関連するタイプライブラリで 指定されたデフォ
                                      ルトのディスパッチインターフェイスを使用しようと しますが、使
                                      用させたいインターフェイス名を <strong>$sink_interface</strong> に指定すること
                                      で、それを 上書きすることが可能です。

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

<comment>See Also:</comment>
   * <strong>com_print_typeinfo()</strong>
   * <strong>com_message_pump()</strong>


id: com_get_active_object
type: function
doc:
<comment>Description:</comment>
  すでに実行中の COM オブジェクトのインスタンスへのハンドルを返す
  
  <strong>com_get_active_object()</strong> は、新しい  オブジェクトのインスタンスを作成することに 似ています。しか
  し、オブジェクトがすでに実行中の場合には そのオブジェクトが返されるという点が違います。 OLE アプリ
  ケーションは、既知のアプリケーションを一度だけ起動させる ことを許可するために、"<return>Running Object
  Table</return>" というものを使用します。 この関数は、実行中のインスタンスのハンドルを取得するために COM ラ
  イブラリ関数 GetActiveObject() を公開します。

<comment>Param:</comment>
  <info>string</info>    <strong>$prog_id</strong>   <strong>$prog_id</strong> は、アクセスしたいオブジェクトの ProgID あるいは CLSID (たとえば
                       <return>Word.Application</return>) である必要があります。
  <info>int|null</info>  <strong>$codepage</strong>   クラスの場合と同様の働きをします。

<comment>Return:</comment>
  <info>variant</info>  要求されたオブジェクトが実行中の場合は、他の COM オブジェクトと 同様にスクリプトへ返され
           ます。


id: com_load_typelib
type: function
doc:
<comment>Description:</comment>
  タイプライブラリを読み込む
  
  タイプライブラリを読み込んで定数をエンジン内に登録し、それらが <strong>define()</strong> を使用して定義されているか
  のように 扱えるようにします。
  
  あまり融通の利く方法ではありませんが、 com.typelib-file php.ini 設定を利用して定数の 事前読み込み
  と登録をすませるほうがずっと効率的であることに 注意しましょう。
  
  com.autoregister-typelib を有効にすると、 PHP がインスタンス化した COM オブジェクトに関連付けられ
  ている定数を 自動的に登録しようと試みます。これは COM オブジェクト自身の提供する インターフェイス
  に依存し、常に可能であるとは限りません。

<comment>Param:</comment>
  <info>string</info>  <strong>$typelib</strong>           <strong>$typelib</strong> は、以下のいずれかの形式となります。 <return>.tlb</return> ファイル、あるいはタ
                             イプライブラリを含む 実行モジュールのファイル名。  タイプライブラリの
                             GUID の後にバージョン番号を続ける。たとえば
                             <return>{00000200-0000-0010-8000-00AA006D2EA4},2,0</return> のような形式。  タイプライブ
                             ラリ名。たとえば <return>Microsoft OLE DB ActiveX Data Objects 1.0 Library</return> のよ
                             うな形式。  PHP は、この順序でタイプライブラリ名の解決を試みます。リス
                             トの下の ほうにいくほど検索処理のコストが高くなります。タイプライブラリ
                             名に よる検索は、一致するものが見つかるまでレジストリを物理的に列挙して
                             いく という方法をとっています。
                             
                             <return>.tlb</return> ファイル、あるいはタイプライブラリを含む 実行モジュールのファイル
                             名。
                             
                             タイプライブラリの GUID の後にバージョン番号を続ける。たとえば
                             <return>{00000200-0000-0010-8000-00AA006D2EA4},2,0</return> のような形式。
                             
                             タイプライブラリ名。たとえば <return>Microsoft OLE DB ActiveX Data Objects 1.0
                             Library</return> のような形式。
  <info>bool</info>    <strong>$case_insensitive</strong>  <strong>$case_insensitive</strong> は、 <strong>define()</strong> 関数の <return>$case_insensitive</return> とは逆の動きを
                             します。

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


id: com_message_pump
type: function
doc:
<comment>Description:</comment>
  COM メッセージを処理し、timeoutms ミリ秒の間待つ
  
  この関数は、<strong>$timeout_milliseconds</strong> ミリ秒が経過するか キューにメッセージが到着するまで待機します。
  
  この関数の目的は、別々の場所にある COM のコールを振り分け、同期の 問題をうまく処理することです。こ
  れにより、発生するイベントを 効率的にスクリプトで待ち受けられるようになり、バックグラウンドで 動作
  している他のコードやイベントも処理できるようになります。 COM オブジェクトのイベントを使用している
  間は、 <strong>com_event_sink()</strong> 関数の例で示したように この関数をループ内で使用すべきです。

<comment>Param:</comment>
  <info>int</info>  <strong>$timeout_milliseconds</strong>  タイムアウト。ミリ秒単位で指定します。
                              
                              <strong>$timeout_milliseconds</strong> の値を指定しなかった場合は 0 であるとみなされま
                              す。0 という値は、一切待機しないことを 意味します。処理待ち状態のメッ
                              セージがあればそれを処理し、 なければこの関数はすぐに <info>false</info> を返しま
                              す。

<comment>Return:</comment>
  <info>bool</info>  タイムアウトの前に メッセージが到着した場合は、そのメッセージが処理されて 関数は <info>true</info> を返し
        ます。メッセージを処理することなく タイムアウトが発生した場合は、この関数は <info>false</info> を返しま
        す。


id: com_print_typeinfo
type: function
doc:
<comment>Description:</comment>
  ディスパッチインターフェイスのために、PHP のクラス定義を出力する
  
  この関数の目的は、イベントシンクに使用するスケルトンクラスの作成を支援することです。 もし 対象の
  COM オブジェクトが イントロスペクションのインターフェイスを十分サポートしており、 表示したいイン
  ターフェイスの名前をあなたが知っている場合、 その COM オブジェクトのダンプを生成するのにも使えま
  す。

<comment>Param:</comment>
  <info>variant|string</info>  <strong>$variant</strong>             <strong>$variant</strong> は、COM オブジェクトのインスタンスか あるいはタイプ
                                       ライブラリの名前 (<strong>com_load_typelib()</strong> の規則にしたがって名前解
                                       決されます) のいずれかです。
  <info>string|null</info>     <strong>$dispatch_interface</strong>  結果を表示したいインターフェイスで、 このインターフェイスは
                                       <return>IDispatch</return> を継承したものです。
  <info>bool</info>            <strong>$display_sink</strong>        <info>true</info> の場合、対応するシンクインターフェイスが代わりに表示され
                                       ます。

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

<comment>See Also:</comment>
   * <strong>com_event_sink()</strong>
   * <strong>com_load_typelib()</strong>


id: compact
type: function
doc:
<comment>Description:</comment>
  変数名とその値から配列を作成する
  
  変数名とその値から配列を作成します。
  
  各引数について、<strong>compact()</strong> は現在のシンボルテーブルにおいてその名前を有する変数を探し、 変数名が
  キー、変数の値がそのキーに関する値となるように追加します。 端的に言うと、<strong>extract()</strong> の逆の動作をし
  ます。
  
  PHP 7.3 より前のバージョンでは、設定されていない全ての文字列は、単にスキップされます。

<comment>Param:</comment>
  <info>array|string</info>  <strong>$var_name</strong>  <strong>compact()</strong> がとるパラメータの数は可変です。 各パラメータは、変数名を値とす
                           る文字列か、 変数名の配列のどちらかとすることができます。 配列は、変数名
                           を値とする別の配列を持つことができます。 <strong>compact()</strong>はこれを再帰的に処理し
                           ます。

<comment>Return:</comment>
  <info>array</info>  追加された全ての変数を値とする出力配列を返します。

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


id: connection_aborted
type: function
doc:
<comment>Description:</comment>
  クライアントとの接続が切断されているかどうかを調べる
  
  クライアントとの接続が切断されているかどうかを調べます。

<comment>Return:</comment>
  <info>int</info>  クライアントとの接続が切断されている場合に 1、それ以外の場合に 0 を返します。

<comment>See Also:</comment>
   * <strong>connection_status()</strong>
   * <strong>ignore_user_abort()</strong>
   * 
     PHP における接続処理についての説明は
     接続処理
    


id: connection_status
type: function
doc:
<comment>Description:</comment>
  接続ステータスのビットフィールドを返す
  
  接続ステータスのビットフィールドを取得します。

<comment>Return:</comment>
  <info>int</info>  接続ステータスのビットフィールドを返します。これを定数 <return>CONNECTION_XXX</return> と比較することで、接続
       の状態を判断できます。

<comment>See Also:</comment>
   * <strong>connection_aborted()</strong>
   * <strong>ignore_user_abort()</strong>
   * 
     PHP における接続処理についての説明は
     接続処理
    


id: constant
type: function
doc:
<comment>Description:</comment>
  定数の値を返す
  
  <strong>$name</strong> で指定した定数の値を返します。
  
  <strong>constant()</strong> はある定数の値を取得する必要があるが、 その名前が不明な場合に有用です。つまり、定数名が
  変数に保存されているか、 関数から返される場合に有用です。
  
  この関数は クラス定数 や 列挙型のcase に対しても動作します。

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

<comment>Return:</comment>
  <info>mixed</info>  定数の値を返します。

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


id: convert_cyr_string
type: function
doc:
<comment>Description:</comment>
  キリル文字セットを他のものに変換する
  
  キリル文字セットを、別の文字セットに変換します。

<comment>Param:</comment>
  <info>string</info>  <strong>$str</strong>   変換したい文字列。
  <info>string</info>  <strong>$from</strong>  変換元のキリル文字セットを一文字で表したもの。
  <info>string</info>  <strong>$to</strong>    変換先のキリル文字セットを一文字で表したもの。

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

<comment>See Also:</comment>
   * <strong>mb_convert_encoding()</strong>
   * <strong>iconv()</strong>


id: convert_uudecode
type: function
doc:
<comment>Description:</comment>
  uuencode された文字列をデコードする
  
  <strong>convert_uudecode()</strong> は、uuencode された文字列をデコードします。
  
  <strong>convert_uudecode()</strong> は、 uuencode された ファイル に含まれる <return>begin</return>, <return>end</return> を両方受け入れません。

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  uuencode されたデータ。

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

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


id: convert_uuencode
type: function
doc:
<comment>Description:</comment>
  文字列を uuencode する
  
  <strong>convert_uuencode()</strong> は、uuencode アルゴリズムを使用して文字列をエンコードします。
  
  uuencode はすべての文字(バイナリを含む)を表示可能な文字に変換し、 ネットワーク上での転送を可能にし
  ます。uuencode されたデータは、 元のデータより約 35% 大きくなります。
  
  <strong>convert_uuencode()</strong> 関数は、 uuencode された ファイル に含まれる <return>begin</return> や <return>end</return> を両方生成しません。

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  エンコードしたいデータ。

<comment>Return:</comment>
  <info>string</info>  uuencode されたデータを返します。

<comment>See Also:</comment>
   * <strong>convert_uudecode()</strong>
   * <strong>base64_encode()</strong>


id: copy
type: function
doc:
<comment>Description:</comment>
  ファイルをコピーする
  
  ファイル <strong>$from</strong> を <strong>$to</strong> にコピーします。
  
  ファイルを移動したいならば、<strong>rename()</strong> 関数を使用してください。

<comment>Param:</comment>
  <info>string</info>         <strong>$from</strong>     コピー元ファイルへのパス。
  <info>string</info>         <strong>$to</strong>       コピー先のパス。<strong>$to</strong> が URL の場合、 既存ファイルへの上書きをラッパーがサ
                           ポートしていない場合にはコピーが失敗します。
                           
                           コピー先のファイルが既に存在する場合、上書きされます。
  <info>resource|null</info>  <strong>$context</strong>  <strong>stream_context_create()</strong> で作成した有効なコンテキストリソース。

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

<comment>See Also:</comment>
   * <strong>move_uploaded_file()</strong>
   * <strong>rename()</strong>
   * マニュアルの ファイルアップロード処理


