# php_manual

id: SolrDisMaxQuery::removeQueryField
type: function
doc:
<comment>Description:</comment>
  Removes a Query Field (qf parameter)
  
  Removes a Query Field (qf parameter) from the field list added by SolrDisMaxQuery::addQueryField
  
  qf: When building DisjunctionMaxQueries from the user's query it specifies the fields to search
  in, and boosts for those fields.

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Field Name

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

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


id: SolrDisMaxQuery::removeTrigramPhraseField
type: function
doc:
<comment>Description:</comment>
  Removes a Trigram Phrase Field (pf3 parameter)
  
  Removes a Trigram Phrase Field (pf3 parameter)

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Field Name

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::addTrigramPhraseField
   * SolrDisMaxQuery::setTrigramPhraseFields
   * SolrDisMaxQuery::setTrigramPhraseSlop


id: SolrDisMaxQuery::removeUserField
type: function
doc:
<comment>Description:</comment>
  Removes a field from The User Fields Parameter (uf)
  
  Removes a field from The User Fields Parameter (uf)
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Field Name

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::addUserField
   * SolrDisMaxQuery::setUserFields


id: SolrDisMaxQuery::setBigramPhraseFields
type: function
doc:
<comment>Description:</comment>
  Sets Bigram Phrase Fields and their boosts (and slops) using pf2 parameter
  
  Sets Bigram Phrase Fields (pf2) and their boosts (and slops)

<comment>Param:</comment>
  <info>string</info>  <strong>$fields</strong>  Fields boosts (slops)

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::setBigramPhraseSlop
   * SolrDisMaxQuery::addBigramPhraseFields
   * SolrDisMaxQuery::removeBigramPhraseField
   * SolrDisMaxQuery::setTrigramPhraseFields


id: SolrDisMaxQuery::setBigramPhraseSlop
type: function
doc:
<comment>Description:</comment>
  Sets Bigram Phrase Slop (ps2 parameter)
  
  Sets Bigram Phrase Slop (ps2 parameter). A default slop for Bigram phrase fields.

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

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>


id: SolrDisMaxQuery::setBoostFunction
type: function
doc:
<comment>Description:</comment>
  Sets a Boost Function (bf parameter)
  
  Sets Boost Function (bf parameter).
  
  Functions (with optional boosts) that will be included in the user's query to influence the score.
  Any function supported natively by Solr can be used, along with a boost value. e.g.:
  
  recip(rord(myfield),1,2,3)^1.5

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

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>


id: SolrDisMaxQuery::setBoostQuery
type: function
doc:
<comment>Description:</comment>
  Directly Sets Boost Query Parameter (bq)
  
  Sets Boost Query Parameter (bq)

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

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::addBoostQuery
   * SolrDisMaxQuery::removeBoostQuery


id: SolrDisMaxQuery::setMinimumMatch
type: function
doc:
<comment>Description:</comment>
  Set Minimum "Should" Match (mm)
  
  Set Minimum "Should" Match parameter (mm). If the default query operator is AND then mm=100%, if
  the default query operator (q.op) is OR, then mm=0%.

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>  Minimum match value/expression

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>


id: SolrDisMaxQuery::setPhraseFields
type: function
doc:
<comment>Description:</comment>
  Sets  Phrase Fields and their boosts (and slops) using pf2 parameter
  
  Sets  Phrase Fields (pf) and their boosts (and slops)

<comment>Param:</comment>
  <info>string</info>  <strong>$fields</strong>  Fields, boosts [, slops]

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::addPhraseFields
   * SolrDisMaxQuery::removePhraseField


id: SolrDisMaxQuery::setPhraseSlop
type: function
doc:
<comment>Description:</comment>
  Sets the default slop on phrase queries (ps parameter)
  
  Sets the default amount of slop on phrase queries built with "pf", "pf2" and/or "pf3" fields
  (affects boosting). "ps" parameter

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

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>


id: SolrDisMaxQuery::setQueryAlt
type: function
doc:
<comment>Description:</comment>
  Set Query Alternate (q.alt parameter)
  
  Set Query Alternate (q.alt parameter)
  
  When the main q parameter is not specified or is blank. The q.alt parameter is used

<comment>Param:</comment>
  <info>string</info>  <strong>$q</strong>  Query String

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>


id: SolrDisMaxQuery::setQueryPhraseSlop
type: function
doc:
<comment>Description:</comment>
  Specifies the amount of slop permitted on phrase queries explicitly included in the user's query
  string (qf parameter)
  
  The Query Phrase Slop is the amount of slop permitted on phrase queries explicitly included in the
  user's query string with the qf parameter.
  
  slop refers to the number of positions one token needs to be moved in relation to another token in
  order to match a phrase specified in a query.

<comment>Param:</comment>
  <info>string</info>  <strong>$slop</strong>  Amount of slop

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>


id: SolrDisMaxQuery::setTieBreaker
type: function
doc:
<comment>Description:</comment>
  Sets Tie Breaker parameter (tie parameter)
  
  Sets Tie Breaker parameter (tie parameter)

<comment>Param:</comment>
  <info>string</info>  <strong>$tieBreaker</strong>  The tie parameter specifies a float value (which should be something much
                       less than 1) to use as tiebreaker in DisMax queries.

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>


id: SolrDisMaxQuery::setTrigramPhraseFields
type: function
doc:
<comment>Description:</comment>
  Directly Sets Trigram Phrase Fields (pf3 parameter)
  
  Directly Sets Trigram Phrase Fields (pf3 parameter)

<comment>Param:</comment>
  <info>string</info>  <strong>$fields</strong>  Trigram Phrase Fields

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::addTrigramPhraseField
   * SolrDisMaxQuery::removeTrigramPhraseField
   * SolrDisMaxQuery::setTrigramPhraseSlop


id: SolrDisMaxQuery::setTrigramPhraseSlop
type: function
doc:
<comment>Description:</comment>
  Sets Trigram Phrase Slop (ps3 parameter)
  
  Sets Trigram Phrase Slop (ps3 parameter)

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

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::addTrigramPhraseField
   * SolrDisMaxQuery::removeTrigramPhraseField
   * SolrDisMaxQuery::setTrigramPhraseFields


id: SolrDisMaxQuery::setUserFields
type: function
doc:
<comment>Description:</comment>
  Sets User Fields parameter (uf)
  
  Sets User Fields parameter (uf)
  
  User Fields: Specifies which schema fields the end user shall be allowed to query.

<comment>Param:</comment>
  <info>string</info>  <strong>$fields</strong>  Fields names separated by space
                   
                   This parameter supports wildcards.

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::addUserField
   * SolrDisMaxQuery::removeUserField


id: SolrDisMaxQuery::useDisMaxQueryParser
type: function
doc:
<comment>Description:</comment>
  Switch QueryParser to be DisMax Query Parser
  
  Switch QueryParser to be DisMax Query Parser

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

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


id: SolrDisMaxQuery::useEDisMaxQueryParser
type: function
doc:
<comment>Description:</comment>
  Switch QueryParser to be EDisMax
  
  Switch QueryParser to be EDisMax. By default the query builder uses edismax, if it was switched
  using SolrDisMaxQuery::useDisMaxQueryParser, it can be switched back using this method.

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>


id: SolrDocument::__clone
type: function
doc:
<comment>Description:</comment>
  SolrDocument オブジェクトのコピーを作成
  
  SolrDocument オブジェクトのコピーを作成します。直接呼出しされません。

<comment>Return:</comment>
  <info>void</info>  ありません


id: SolrDocument::__get
type: function
doc:
<comment>Description:</comment>
  プロパティとしてフィールドにアクセス
  
  プロパティとしてフィールドにアクセスするためのマジックメソッド

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>  フィールド名

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


id: SolrDocument::__isset
type: function
doc:
<comment>Description:</comment>
  フィールドが存在するかチェック
  
  フィールドが存在するかチェックします。

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>  フィールド名

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


id: SolrDocument::__set
type: function
doc:
<comment>Description:</comment>
  Adds another field to the document
  
  Adds another field to the document. Used to set the fields as new properties.

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>   Name of the field.
  <info>string</info>  <strong>$fieldValue</strong>  Field value.

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


id: SolrDocument::__unset
type: function
doc:
<comment>Description:</comment>
  文書からフィールドを除去
  
  フィールドがオブジェクトのプロパティとしてアクセスされる場合、文書からフィールドを除去します。

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>  フィールド名

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


id: SolrDocument::addField
type: function
doc:
<comment>Description:</comment>
  文書にフィールドを追加
  
  このメソッドは、SolrDocument インスタンスにフィールドを追加します。

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>   フィールド名
  <info>string</info>  <strong>$fieldValue</strong>  フィールドの値

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


id: SolrDocument::clear
type: function
doc:
<comment>Description:</comment>
  Drops all the fields in the document
  
  Resets the current object. Discards all the fields and resets the document boost to zero.

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


id: SolrDocument::current
type: function
doc:
<comment>Description:</comment>
  現行のフィールドを取得
  
  現行のフィールドを取得します。

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


id: SolrDocument::deleteField
type: function
doc:
<comment>Description:</comment>
  文書からフィールドを除去
  
  文書からフィールドを除去します。

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>  フィールド名

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


id: SolrDocument::fieldExists
type: function
doc:
<comment>Description:</comment>
  Checks if a field exists in the document
  
  Checks if the requested field as a valid fieldname in the document.

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>  The name of the field.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the field is present and <info>false</info> if it does not.


id: SolrDocument::getChildDocuments
type: function
doc:
<comment>Description:</comment>
  Returns an array of child documents (SolrDocument)
  
  Returns an array of child documents (SolrDocument)

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

<comment>See Also:</comment>
   * SolrDocument::hasChildDocuments
   * SolrDocument::getChildDocumentsCount


id: SolrDocument::getChildDocumentsCount
type: function
doc:
<comment>Description:</comment>
  Returns the number of child documents
  
  Returns the number of child documents

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

<comment>See Also:</comment>
   * SolrDocument::hasChildDocuments
   * SolrDocument::getChildDocuments


id: SolrDocument::getField
type: function
doc:
<comment>Description:</comment>
  名前でフィールドを取得
  
  名前でフィールドを取得します。

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>  フィールド名

<comment>Return:</comment>
  <info>SolrDocumentField</info>  成功時には SolrDocumentField、失敗時には <info>false</info> を返します。


id: SolrDocument::getFieldCount
type: function
doc:
<comment>Description:</comment>
  この文書内のフィールド数を返す
  
  この文書内のフィールド数を返します。 複数値のフィールドは１回だけ数えられます。

<comment>Return:</comment>
  <info>int</info>  成功時には整数、失敗時には <info>false</info> を返します。


id: SolrDocument::getFieldNames
type: function
doc:
<comment>Description:</comment>
  文書内のフィールド名の配列を返す
  
  文書内のフィールド名の配列を返します。

<comment>Return:</comment>
  <info>array</info>  この文書内のフィールド名を含む配列を返します。


id: SolrDocument::getInputDocument
type: function
doc:
<comment>Description:</comment>
  Returns a SolrInputDocument equivalent of the object
  
  Returns a SolrInputDocument equivalent of the object. This is useful if one wishes to
  resubmit/update a document retrieved from a query.

<comment>Return:</comment>
  <info>SolrInputDocument</info>  Returns a SolrInputDocument on success and <info>null</info> on failure.


id: SolrDocument::hasChildDocuments
type: function
doc:
<comment>Description:</comment>
  Checks whether the document has any child documents
  
  Checks whether the document has any child documents

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

<comment>See Also:</comment>
   * SolrDocument::getChildDocuments
   * SolrDocument::getChildDocumentsCount


id: SolrDocument::key
type: function
doc:
<comment>Description:</comment>
  現行のキーを返す
  
  現行のキーを返します。

<comment>Return:</comment>
  <info>string</info>  現行のキーを返します。


id: SolrDocument::merge
type: function
doc:
<comment>Description:</comment>
  Merges source to the current SolrDocument
  
  Merges source to the current SolrDocument.

<comment>Param:</comment>
  <info>SolrDocument</info>  <strong>$sourceDoc</strong>  The source document.
  <info>bool</info>          <strong>$overwrite</strong>  If this is <info>true</info> then fields with the same name in the destination
                            document will be overwritten.

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


id: SolrDocument::next
type: function
doc:
<comment>Description:</comment>
  内部ポインタを次のフィールドに移動
  
  内部ポインタを次のフィールドに移動します。

<comment>Return:</comment>
  <info>void</info>  この関数に戻り値はありません。


id: SolrDocument::offsetExists
type: function
doc:
<comment>Description:</comment>
  特定のフィールドが存在するかどうかチェック
  
  特定のフィールドが存在するかどうかチェックします。これは、オブジェクトが配列として扱われる際に使用
  されます。

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>  フィールド名

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


id: SolrDocument::offsetGet
type: function
doc:
<comment>Description:</comment>
  フィールドを取得
  
  これは、オブジェクトが配列として扱われる際に、フィールドを取得するために使用されます。

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>  フィールド名

<comment>Return:</comment>
  <info>SolrDocumentField</info>  SolrDocumentField オブジェクトを返します。


id: SolrDocument::offsetSet
type: function
doc:
<comment>Description:</comment>
  文書にフィールドを追加
  
  オブジェクトが配列として扱われる際に、文書にフィールドを追加するために使用されます。

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>   フィールド名
  <info>string</info>  <strong>$fieldValue</strong>  このフィールドに対する値

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


id: SolrDocument::offsetUnset
type: function
doc:
<comment>Description:</comment>
  フィールドを除去
  
  文書からフィールドを除去します。

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>  フィールド名

<comment>Return:</comment>
  <info>void</info>  戻り値はありません。


id: SolrDocument::reset
type: function
doc:
<comment>Description:</comment>
  SolrDocument::clear のエイリアス
  
  これは、SolrDocument::clear()へのエイリアスです。

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


id: SolrDocument::rewind
type: function
doc:
<comment>Description:</comment>
  内部ポインタを先頭にリセット
  
  内部ポインタを先頭にリセットします。

<comment>Return:</comment>
  <info>void</info>  この関数に戻り値はありません。


id: SolrDocument::serialize
type: function
doc:
<comment>Description:</comment>
  カスタムのシリアライズで使われます
  
  カスタムのシリアライズで使われます.

<comment>Return:</comment>
  <info>string</info>  シリアライズされた Solr 文書を表現する文字列を返します。


id: SolrDocument::sort
type: function
doc:
<comment>Description:</comment>
  Sorts the fields in the document
  
  

<comment>Param:</comment>
  <info>int</info>  <strong>$sortOrderBy</strong>    The sort criteria.
  <info>int</info>  <strong>$sortDirection</strong>  The sort direction.

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


id: SolrDocument::toArray
type: function
doc:
<comment>Description:</comment>
  文書の配列表現を返す
  
  文書の配列表現を返します。

<comment>Return:</comment>
  <info>array</info>  文書の配列表現を返します。


id: SolrDocument::unserialize
type: function
doc:
<comment>Description:</comment>
  Custom serialization of SolrDocument objects
  
  Custom serialization of SolrDocument objects

<comment>Param:</comment>
  <info>string</info>  <strong>$serialized</strong>  An XML representation of the document.

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


id: SolrDocument::valid
type: function
doc:
<comment>Description:</comment>
  Checks if the current position internally is still valid
  
  Checks if the current position internally is still valid. It is used during foreach operations.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> on success and <info>false</info> if the current position is no longer valid.


id: SolrDocumentField::__construct
type: function
doc:
<comment>Description:</comment>
  コンストラクタ
  
  コンストラクタ

<comment>Return:</comment>
  <info>unknown</info>  ありません


id: SolrDocumentField::__destruct
type: function
doc:
<comment>Description:</comment>
  デストラクタ
  
  デストラクタ

<comment>Return:</comment>
  <info>unknown</info>  ありません


id: SolrIllegalArgumentException::getInternalInfo
type: function
doc:
<comment>Description:</comment>
  例外がスローされた際の内部情報を返す
  
  例外がスローされた際の内部情報を返します。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>array</info>  エラーがスローされた際の内部情報を含む配列を返します。拡張モジュールの開発者によるデバッグ
         のためだけに使われます。


id: SolrInputDocument::__clone
type: function
doc:
<comment>Description:</comment>
  SolrDocument のコピーを作成
  
  直接呼出しされてはいけません。SolrInputDocument のディープコピー作成に使用されます。

<comment>Return:</comment>
  <info>void</info>  SolrInputDocument インスタンスを新規作成。


id: SolrInputDocument::addChildDocument
type: function
doc:
<comment>Description:</comment>
  Adds a child document for block indexing
  
  Adds a child document to construct a document block with nested documents.

<comment>Param:</comment>
  <info>SolrInputDocument</info>  <strong>$child</strong>  A <info>SolrInputDocument</info> object.

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

<comment>See Also:</comment>
   * SolrInputDocument::addChildDocuments
   * SolrInputDocument::hasChildDocuments
   * SolrInputDocument::getChildDocuments
   * SolrInputDocument::getChildDocumentsCount


id: SolrInputDocument::addChildDocuments
type: function
doc:
<comment>Description:</comment>
  Adds an array of child documents
  
  Adds an array of child documents to the current input document.

<comment>Param:</comment>
  <info>array</info>  <strong>$docs</strong>  An <info>array</info> of <info>SolrInputDocument</info> objects.

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

<comment>See Also:</comment>
   * SolrInputDocument::addChildDocument
   * SolrInputDocument::hasChildDocuments
   * SolrInputDocument::getChildDocuments
   * SolrInputDocument::getChildDocumentsCount


id: SolrInputDocument::addField
type: function
doc:
<comment>Description:</comment>
  文書にフィールドを追加
  
  複数値の項目に対しては、もし有効な boost 値が指定されると、 指定された値とこのフィールドに対する現
  行の boost 値 とが掛け算されます。

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>        フィールド名
  <info>string</info>  <strong>$fieldValue</strong>       このフィールドに対する値
  <info>float</info>   <strong>$fieldBoostValue</strong>  フィールドに対するインデキシング時間の boost。 負の値にはできませんが、
                            それでも 1.0 未満の価格を渡せます。しかし、それらはゼロより大きくなけれ
                            ばなりません。

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


id: SolrInputDocument::clear
type: function
doc:
<comment>Description:</comment>
  入力した文書をリセット
  
  全フィールドをドロップして文書をリセットし、文書の boost をゼロにリセットします。

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


id: SolrInputDocument::fieldExists
type: function
doc:
<comment>Description:</comment>
  フィールドが存在するかチェック
  
  フィールドが存在するかチェックします。

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>  フィールド名

<comment>Return:</comment>
  <info>bool</info>  フィールドが見つかった場合 <info>true</info> 、見つからなかった場合 <info>false</info> を返します。


id: SolrInputDocument::getBoost
type: function
doc:
<comment>Description:</comment>
  文書に対する現行の boost 値を取得
  
  文書に対する現行の boost 値を取得します。

<comment>Return:</comment>
  <info>float</info>  成功した場合は boost 値、失敗した場合は <info>false</info> を返します。


id: SolrInputDocument::getChildDocuments
type: function
doc:
<comment>Description:</comment>
  Returns an array of child documents (SolrInputDocument)
  
  Returns an array of child documents (SolrInputDocument)

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

<comment>See Also:</comment>
   * SolrInputDocument::addChildDocument
   * SolrInputDocument::addChildDocuments
   * SolrInputDocument::hasChildDocuments
   * SolrInputDocument::getChildDocumentsCount


id: SolrInputDocument::getChildDocumentsCount
type: function
doc:
<comment>Description:</comment>
  Returns the number of child documents
  
  Returns the number of child documents

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

<comment>See Also:</comment>
   * SolrInputDocument::addChildDocument
   * SolrInputDocument::addChildDocuments
   * SolrInputDocument::hasChildDocuments
   * SolrInputDocument::getChildDocuments


id: SolrInputDocument::getField
type: function
doc:
<comment>Description:</comment>
  名前でフィールドを取得
  
  文書内のフィールドを取得します。

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>  フィールド名

<comment>Return:</comment>
  <info>SolrDocumentField</info>  成功時には SolrDocumentField オブジェクト、失敗時には <info>false</info> を返します。


id: SolrInputDocument::getFieldBoost
type: function
doc:
<comment>Description:</comment>
  特定のフィールドに対する boost 値を取得
  
  特定のフィールドに対する boost 値を取得します。

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>  フィールド名

<comment>Return:</comment>
  <info>float</info>  フィールドの boost 値、またはエラーがあった場合には <info>false</info> を返します。


id: SolrInputDocument::getFieldCount
type: function
doc:
<comment>Description:</comment>
  文書内のフィールド数を返す
  
  文書内のフィールド数を返します。

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


id: SolrInputDocument::getFieldNames
type: function
doc:
<comment>Description:</comment>
  文書内のフィールドを全て含む配列を返す
  
  文書内のフィールドを全て含む配列を返します。

<comment>Return:</comment>
  <info>array</info>  成功時には配列、失敗時には <info>false</info> を返します。


id: SolrInputDocument::hasChildDocuments
type: function
doc:
<comment>Description:</comment>
  Returns true if the document has any child documents
  
  Checks whether the document has any child documents

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

<comment>See Also:</comment>
   * SolrInputDocument::addChildDocument
   * SolrInputDocument::addChildDocuments
   * SolrInputDocument::getChildDocuments
   * SolrInputDocument::getChildDocumentsCount


id: SolrInputDocument::merge
type: function
doc:
<comment>Description:</comment>
  Merges one input document into another
  
  Merges one input document into another.

<comment>Param:</comment>
  <info>SolrInputDocument</info>  <strong>$sourceDoc</strong>  The source document.
  <info>bool</info>               <strong>$overwrite</strong>  If this is <info>true</info> it will replace matching fields in the destination
                                 document.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。 In the future, this will be
        modified to return the number of fields in the new document.


id: SolrInputDocument::reset
type: function
doc:
<comment>Description:</comment>
  SolrInputDocument::clear のエイリアス
  
  これは、SolrInputDocument::clear のエイリアスです

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


id: SolrInputDocument::setBoost
type: function
doc:
<comment>Description:</comment>
  この文書に対する boost 値を設定
  
  この文書に対する boost 値を設定します。

<comment>Param:</comment>
  <info>float</info>  <strong>$documentBoostValue</strong>  この文書に対するインデキシング時間の boost 値

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


id: SolrInputDocument::setFieldBoost
type: function
doc:
<comment>Description:</comment>
  フィールドに対するインデキシング時間の boost 値を設定
  
  フィールドに対するインデキシング時間の boost 値を設定します。 これは、このフィールドに対する現行の
  boost 値を置換します。

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>        フィールド名
  <info>float</info>   <strong>$fieldBoostValue</strong>  インデキシング時間の boost 値

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


id: SolrInputDocument::sort
type: function
doc:
<comment>Description:</comment>
  Sorts the fields within the document
  
  

<comment>Param:</comment>
  <info>int</info>  <strong>$sortOrderBy</strong>    The sort criteria
  <info>int</info>  <strong>$sortDirection</strong>  The sort direction

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


id: SolrInputDocument::toArray
type: function
doc:
<comment>Description:</comment>
  入力した文書の配列表現を返す
  
  入力した文書の配列表現を返します。

<comment>Return:</comment>
  <info>array</info>  フィールドを含む配列を返します。失敗時には <info>false</info> を返します。


id: SolrObject
type: class
doc:
<comment>Description:</comment>
  これはオブジェクトで、そのプロパティは、配列の文法を使用してアクセスされることもできます。 その全
  てのプロパティは読み取り専用です。


id: SolrObject::__construct
type: function
doc:
<comment>Description:</comment>
  Solr オブジェクトを生成
  
  Solr オブジェクトを生成します。

<comment>Return:</comment>
  <info>unknown</info>  ありません


id: SolrObject::getPropertyNames
type: function
doc:
<comment>Description:</comment>
  全てのプロパティ名の配列を返す
  
  全てのプロパティ名の配列を返します。

<comment>Return:</comment>
  <info>array</info>  配列を返します。


id: SolrObject::offsetExists
type: function
doc:
<comment>Description:</comment>
  プロパティが存在するかチェック
  
  プロパティが存在するかチェックします。これは、オブジェクトが配列として扱われる際に使用されます。

<comment>Param:</comment>
  <info>string</info>  <strong>$property_name</strong>  プロパティ名

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


id: SolrObject::offsetGet
type: function
doc:
<comment>Description:</comment>
  プロパティを取得するために使用される
  
  プロパティの値を取得するために使用されます。これは、オブジェクトが配列として扱われる際に使用されま
  す。

<comment>Param:</comment>
  <info>string</info>  <strong>$property_name</strong>  プロパティ名

<comment>Return:</comment>
  <info>mixed</info>  プロパティの値を返します。


id: SolrObject::offsetSet
type: function
doc:
<comment>Description:</comment>
  プロパティに対して値を設定
  
  プロパティに対して値を設定します。 これは、オブジェクトが配列として扱われる際に使用されます。 この
  オブジェクトは読み込み専用です。これは、決して試みられてはいけません。

<comment>Param:</comment>
  <info>string</info>  <strong>$property_name</strong>   プロパティ名
  <info>string</info>  <strong>$property_value</strong>  新しい値

<comment>Return:</comment>
  <info>void</info>  ありません


id: SolrObject::offsetUnset
type: function
doc:
<comment>Description:</comment>
  プロパティに対して値の設定を解除
  
  プロパティに対して値の設定を解除します。これは、オブジェクトが配列として扱われる際に使用されます。
  このオブジェクトは読み込み専用です。これは、決して試みられてはいけません。

<comment>Param:</comment>
  <info>string</info>  <strong>$property_name</strong>  プロパティ名

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


id: SolrParams::add
type: function
doc:
<comment>Description:</comment>
  SolrParams::addParam のエイリアス
  
  これは、SolrParams::addParam に対するエイリアスです。

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>   パラメータ名
  <info>string</info>  <strong>$value</strong>  パラメータ値

<comment>Return:</comment>
  <info>SolrParams</info>  成功時に SolrParams インスタンスを返します


id: SolrParams::addParam
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>SolrParams</info>  成功時に SolrParam オブジェクト、失敗時に <info>false</info> を返します。


id: SolrParams::get
type: function
doc:
<comment>Description:</comment>
  SolrParams::getParam のエイリアス
  
  これは、SolrParams::getParam に対するエイリアスです。

<comment>Param:</comment>
  <info>string</info>  <strong>$param_name</strong>  パラメータ名

<comment>Return:</comment>
  <info>mixed</info>  パラメータの種類により、配列または文字列を返します


id: SolrParams::getParam
type: function
doc:
<comment>Description:</comment>
  パラメータ値を返す
  
  param_name という名前のパラメータを返します。

<comment>Param:</comment>
  <info>string</info>  <strong>$param_name</strong>  パラメータ名

<comment>Return:</comment>
  <info>mixed</info>  パラメータの種類により、文字列または配列を返します


id: SolrParams::getParams
type: function
doc:
<comment>Description:</comment>
  URL エンコードされていないパラメータの配列を返す
  
  URL エンコードされていないパラメータの配列を返します

<comment>Return:</comment>
  <info>array</info>  URL エンコードされていないパラメータの配列を返します


id: SolrParams::getPreparedParams
type: function
doc:
<comment>Description:</comment>
  URL エンコードされたパラメータの配列を返す
  
  URL エンコードされたパラメータに対する配列を返します

<comment>Return:</comment>
  <info>array</info>  URL エンコードされたパラメータに対する配列を返します


id: SolrParams::serialize
type: function
doc:
<comment>Description:</comment>
  カスタムのシリアライズで使われます
  
  カスタムのシリアライズで使われます

<comment>Return:</comment>
  <info>string</info>  カスタムのシリアライズで使われます


id: SolrParams::set
type: function
doc:
<comment>Description:</comment>
  SolrParams::setParam のエイリアス
  
  SolrParams::setParam のエイリアス

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>   パラメータ名
  <info>string</info>  <strong>$value</strong>  パラメータ値

<comment>Return:</comment>
  <info>void</info>  成功時に、SolrParams オブジェクトのインスタンスを返します


id: SolrParams::setParam
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>SolrParams</info>  成功時に SolrParam オブジェクト、値の場合に <info>false</info> を返します。


id: SolrParams::toString
type: function
doc:
<comment>Description:</comment>
  オブジェクト内の名前と値のペアのパラメータを全て返します
  
  オブジェクト内の名前と値のペアのパラメータを全て返します

<comment>Param:</comment>
  <info>bool</info>  <strong>$url_encode</strong>  URL エンコードされた値が返されるかどうか

<comment>Return:</comment>
  <info>string</info>  成功時に文字列、失敗時に <info>false</info> を返します。


id: SolrParams::unserialize
type: function
doc:
<comment>Description:</comment>
  カスタムのシリアライズで使われます
  
  カスタムのシリアライズで使われます

<comment>Param:</comment>
  <info>string</info>  <strong>$serialized</strong>  オブジェクトのシリアライズされた表現

<comment>Return:</comment>
  <info>void</info>  ありません


id: SolrPingResponse::getResponse
type: function
doc:
<comment>Description:</comment>
  サーバーからのレスポンスを返す
  
  サーバーからのレスポンスを返します。 HEAD リクエストとしてのリクエストなので、これは空になるはずで
  す。

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


id: SolrQuery
type: class
doc:
<comment>Description:</comment>
  Represents a collection of name-value pairs sent to the Solr server during a request.


id: SolrQuery::__construct
type: function
doc:
<comment>Description:</comment>
  コンストラクタ
  
  コンストラクタ

<comment>Param:</comment>
  <info>string</info>  <strong>$q</strong>  任意の検索クエリ

<comment>Return:</comment>
  <info>unknown</info>  ありません


id: SolrQuery::addExpandFilterQuery
type: function
doc:
<comment>Description:</comment>
  Overrides main filter query, determines which documents to include in the main group
  
  Overrides main filter query, determines which documents to include in the main group.

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

<comment>Return:</comment>
  <info>SolrQuery</info>  <info>SolrQuery</info>

<comment>See Also:</comment>
   * SolrQuery::setExpand
   * SolrQuery::addExpandSortField
   * SolrQuery::removeExpandSortField
   * SolrQuery::setExpandRows
   * SolrQuery::setExpandQuery
   * SolrQuery::removeExpandFilterQuery


id: SolrQuery::addExpandSortField
type: function
doc:
<comment>Description:</comment>
  Orders the documents within the expanded groups (expand.sort parameter)
  
  Orders the documents within the expanded groups (expand.sort parameter).

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  field name
  <info>string</info>  <strong>$order</strong>  Order ASC/DESC, utilizes SolrQuery::ORDER_* constants.
                  
                  Default: <info>SolrQuery::ORDER_DESC</info>

<comment>Return:</comment>
  <info>SolrQuery</info>  <info>SolrQuery</info>

<comment>See Also:</comment>
   * SolrQuery::setExpand
   * SolrQuery::removeExpandSortField
   * SolrQuery::setExpandRows
   * SolrQuery::setExpandQuery
   * SolrQuery::addExpandFilterQuery
   * SolrQuery::removeExpandFilterQuery


id: SolrQuery::addFacetDateField
type: function
doc:
<comment>Description:</comment>
  Maps to facet.date
  
  This method allows you to specify a field which should be treated as a facet.
  
  It can be used multiple times with different field names to indicate multiple facet fields

<comment>Param:</comment>
  <info>string</info>  <strong>$dateField</strong>  The name of the date field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns a SolrQuery object.


id: SolrQuery::addFacetDateOther
type: function
doc:
<comment>Description:</comment>
  Adds another facet.date.other parameter
  
  Sets the facet.date.other parameter. Accepts an optional field override

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>           The value to use.
  <info>string</info>  <strong>$field_override</strong>  The field name for the override.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::addFacetField
type: function
doc:
<comment>Description:</comment>
  Adds another field to the facet
  
  Adds another field to the facet

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  The name of the field

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::addFacetQuery
type: function
doc:
<comment>Description:</comment>
  Adds a facet query
  
  Adds a facet query

<comment>Param:</comment>
  <info>string</info>  <strong>$facetQuery</strong>  The facet query

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::addField
type: function
doc:
<comment>Description:</comment>
  Specifies which fields to return in the result
  
  This method is used to used to specify a set of fields to return, thereby restricting the amount
  of data returned in the response.
  
  It should be called multiple time, once for each field name.

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  The name of the field

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object


id: SolrQuery::addFilterQuery
type: function
doc:
<comment>Description:</comment>
  Specifies a filter query
  
  Specifies a filter query

<comment>Param:</comment>
  <info>string</info>  <strong>$fq</strong>  The filter query

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object.


id: SolrQuery::addGroupField
type: function
doc:
<comment>Description:</comment>
  Add a field to be used to group results
  
  The name of the field by which to group results. The field must be single-valued, and either be
  indexed or a field type that has a value source and works in a function query, such as
  ExternalFileField. It must also be a string-based field, such as StrField or TextField Uses
  group.field parameter

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns an instance of <class>SolrQuery</class>.

<comment>See Also:</comment>
   * SolrQuery::setGroup
   * SolrQuery::addGroupFunction
   * SolrQuery::addGroupQuery
   * SolrQuery::addGroupSortField
   * SolrQuery::setGroupFacet
   * SolrQuery::setGroupOffset
   * SolrQuery::setGroupLimit
   * SolrQuery::setGroupMain
   * SolrQuery::setGroupNGroups
   * SolrQuery::setGroupTruncate
   * SolrQuery::setGroupFormat
   * SolrQuery::setGroupCachePercent


id: SolrQuery::addGroupFunction
type: function
doc:
<comment>Description:</comment>
  Allows grouping results based on the unique values of a function query (group.func parameter)
  
  Adds a group function (group.func parameter) Allows grouping results based on the unique values of
  a function query.

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

<comment>Return:</comment>
  <info>SolrQuery</info>  <info>SolrQuery</info>

<comment>See Also:</comment>
   * SolrQuery::setGroup
   * SolrQuery::addGroupField
   * SolrQuery::addGroupQuery
   * SolrQuery::addGroupSortField
   * SolrQuery::setGroupFacet
   * SolrQuery::setGroupOffset
   * SolrQuery::setGroupLimit
   * SolrQuery::setGroupMain
   * SolrQuery::setGroupNGroups
   * SolrQuery::setGroupTruncate
   * SolrQuery::setGroupFormat
   * SolrQuery::setGroupCachePercent


id: SolrQuery::addGroupQuery
type: function
doc:
<comment>Description:</comment>
  Allows grouping of documents that match the given query
  
  Allows grouping of documents that match the given query. Adds query to the group.query parameter

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

<comment>Return:</comment>
  <info>SolrQuery</info>  <info>SolrQuery</info>

<comment>See Also:</comment>
   * SolrQuery::setGroup
   * SolrQuery::addGroupField
   * SolrQuery::addGroupFunction
   * SolrQuery::addGroupSortField
   * SolrQuery::setGroupFacet
   * SolrQuery::setGroupOffset
   * SolrQuery::setGroupLimit
   * SolrQuery::setGroupMain
   * SolrQuery::setGroupNGroups
   * SolrQuery::setGroupTruncate
   * SolrQuery::setGroupFormat
   * SolrQuery::setGroupCachePercent


id: SolrQuery::addGroupSortField
type: function
doc:
<comment>Description:</comment>
  Add a group sort field (group.sort parameter)
  
  Allow sorting group documents, using group sort field (group.sort parameter).

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Field name
  <info>int</info>     <strong>$order</strong>  Order ASC/DESC, utilizes SolrQuery::ORDER_* constants

<comment>Return:</comment>
  <info>SolrQuery</info>  

<comment>See Also:</comment>
   * SolrQuery::setGroup
   * SolrQuery::addGroupField
   * SolrQuery::addGroupFunction
   * SolrQuery::addGroupQuery
   * SolrQuery::setGroupFacet
   * SolrQuery::setGroupOffset
   * SolrQuery::setGroupLimit
   * SolrQuery::setGroupMain
   * SolrQuery::setGroupNGroups
   * SolrQuery::setGroupTruncate
   * SolrQuery::setGroupFormat
   * SolrQuery::setGroupCachePercent


id: SolrQuery::addHighlightField
type: function
doc:
<comment>Description:</comment>
  Maps to hl.fl
  
  Maps to hl.fl. This is used to specify that highlighted snippets should be generated for a
  particular field

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Name of the field

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::addMltField
type: function
doc:
<comment>Description:</comment>
  Sets a field to use for similarity
  
  Maps to mlt.fl. It specifies that a field should be used for similarity.

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  The name of the field

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::addMltQueryField
type: function
doc:
<comment>Description:</comment>
  Maps to mlt.qf
  
  Maps to mlt.qf. It is used to specify query fields and their boosts

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  The name of the field
  <info>float</info>   <strong>$boost</strong>  Its boost value

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::addSortField
type: function
doc:
<comment>Description:</comment>
  Used to control how the results should be sorted
  
  Used to control how the results should be sorted.

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  The name of the field
  <info>int</info>     <strong>$order</strong>  The sort direction. This should be either SolrQuery::ORDER_ASC or
                  SolrQuery::ORDER_DESC.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object.


id: SolrQuery::addStatsFacet
type: function
doc:
<comment>Description:</comment>
  Requests a return of sub results for values within the given facet 
  
  Requests a return of sub results for values within the given facet. Maps to the stats.facet field

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  The name of the field

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::addStatsField
type: function
doc:
<comment>Description:</comment>
  Maps to stats.field parameter
  
  Maps to stats.field parameter This methods adds another stats.field parameter.

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  The name of the field

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::collapse
type: function
doc:
<comment>Description:</comment>
  Collapses the result set to a single document per group
  
  Collapses the result set to a single document per group before it forwards the result set to the
  rest of the search components.
  
  So all downstream components (faceting, highlighting, etc...) will work with the collapsed result
  set.

<comment>Param:</comment>
  <info>SolrCollapseFunction</info>  <strong>$collapseFunction</strong>  

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current <info>SolrQuery</info> object


id: SolrQuery::getExpand
type: function
doc:
<comment>Description:</comment>
  Returns true if group expanding is enabled
  
  Returns <info>true</info> if group expanding is enabled

<comment>Return:</comment>
  <info>bool</info>  Returns whether group expanding is enabled.


id: SolrQuery::getExpandFilterQueries
type: function
doc:
<comment>Description:</comment>
  Returns the expand filter queries
  
  Returns the expand filter queries

<comment>Return:</comment>
  <info>array</info>  Returns the expand filter queries.


id: SolrQuery::getExpandQuery
type: function
doc:
<comment>Description:</comment>
  Returns the expand query expand.q parameter
  
  Returns the expand query expand.q parameter

<comment>Return:</comment>
  <info>array</info>  Returns the expand query.


id: SolrQuery::getExpandRows
type: function
doc:
<comment>Description:</comment>
  Returns The number of rows to display in each group (expand.rows)
  
  Returns The number of rows to display in each group (expand.rows)

<comment>Return:</comment>
  <info>int</info>  Returns the number of rows.


id: SolrQuery::getExpandSortFields
type: function
doc:
<comment>Description:</comment>
  Returns an array of fields
  
  Returns an array of fields

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


id: SolrQuery::getFacet
type: function
doc:
<comment>Description:</comment>
  Returns the value of the facet parameter
  
  Returns the value of the facet parameter.

<comment>Return:</comment>
  <info>bool</info>  Returns a boolean on success and <info>null</info> if not set


id: SolrQuery::getFacetDateEnd
type: function
doc:
<comment>Description:</comment>
  Returns the value for the facet.date.end parameter
  
  Returns the value for the facet.date.end parameter. This method accepts an optional field override

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>string</info>  Returns a string on success and <info>null</info> if not set


id: SolrQuery::getFacetDateFields
type: function
doc:
<comment>Description:</comment>
  Returns all the facet.date fields
  
  Returns all the facet.date fields

<comment>Return:</comment>
  <info>array</info>  Returns all the facet.date fields as an array or <info>null</info> if none was set


id: SolrQuery::getFacetDateGap
type: function
doc:
<comment>Description:</comment>
  Returns the value of the facet.date.gap parameter
  
  Returns the value of the facet.date.gap parameter. It accepts an optional field override

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>string</info>  Returns a string on success and <info>null</info> if not set


id: SolrQuery::getFacetDateHardEnd
type: function
doc:
<comment>Description:</comment>
  Returns the value of the facet.date.hardend parameter
  
  Returns the value of the facet.date.hardend parameter. Accepts an optional field override

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>string</info>  Returns a string on success and <info>null</info> if not set


id: SolrQuery::getFacetDateOther
type: function
doc:
<comment>Description:</comment>
  Returns the value for the facet.date.other parameter
  
  Returns the value for the facet.date.other parameter. This method accepts an optional field
  override.

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>array</info>  Returns an <info>array</info> on success and <info>null</info> if not set.


id: SolrQuery::getFacetDateStart
type: function
doc:
<comment>Description:</comment>
  Returns the  lower bound for the first date range for all date faceting on this field
  
  Returns the  lower bound for the first date range for all date faceting on this field. Accepts an
  optional field override

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>string</info>  Returns a string on success and <info>null</info> if not set


id: SolrQuery::getFacetFields
type: function
doc:
<comment>Description:</comment>
  Returns all the facet fields
  
  Returns all the facet fields

<comment>Return:</comment>
  <info>array</info>  Returns an array of all the fields and <info>null</info> if none was set


id: SolrQuery::getFacetLimit
type: function
doc:
<comment>Description:</comment>
  Returns the maximum number of constraint counts that should be returned for the facet fields
  
  Returns the maximum number of constraint counts that should be returned for the facet fields. This
  method accepts an optional field override

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field to override for

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>null</info> if not set


id: SolrQuery::getFacetMethod
type: function
doc:
<comment>Description:</comment>
  Returns the value of the facet.method parameter
  
  Returns the value of the facet.method parameter. This accepts an optional field override.

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>string</info>  Returns a string on success and <info>null</info> if not set


id: SolrQuery::getFacetMinCount
type: function
doc:
<comment>Description:</comment>
  Returns the minimum counts for facet fields should be included in the response
  
  Returns the minimum counts for facet fields should be included in the response. It accepts an
  optional field override

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>null</info> if not set


id: SolrQuery::getFacetMissing
type: function
doc:
<comment>Description:</comment>
  Returns the current state of the facet.missing parameter
  
  Returns the current state of the facet.missing parameter. This accepts an optional field override

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>bool</info>  Returns a boolean on success and <info>null</info> if not set


id: SolrQuery::getFacetOffset
type: function
doc:
<comment>Description:</comment>
  Returns an offset into the list of constraints to be used for pagination
  
  Returns an offset into the list of constraints to be used for pagination. Accepts an optional
  field override

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field to override for.

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>null</info> if not set


id: SolrQuery::getFacetPrefix
type: function
doc:
<comment>Description:</comment>
  Returns the facet prefix
  
  Returns the facet prefix

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>string</info>  Returns a string on success and <info>null</info> if not set.


id: SolrQuery::getFacetQueries
type: function
doc:
<comment>Description:</comment>
  Returns all the facet queries
  
  Returns all the facet queries

<comment>Return:</comment>
  <info>array</info>  Returns an array on success and <info>null</info> if not set.


id: SolrQuery::getFacetSort
type: function
doc:
<comment>Description:</comment>
  Returns the facet sort type
  
  Returns an integer (SolrQuery::FACET_SORT_INDEX or SolrQuery::FACET_SORT_COUNT)

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>int</info>  Returns an integer (SolrQuery::FACET_SORT_INDEX or SolrQuery::FACET_SORT_COUNT) on success or
       <info>null</info> if not set.


id: SolrQuery::getFields
type: function
doc:
<comment>Description:</comment>
  Returns the list of fields that will be returned in the response
  
  Returns the list of fields that will be returned in the response

<comment>Return:</comment>
  <info>array</info>  Returns an array on success and <info>null</info> if not set.


id: SolrQuery::getFilterQueries
type: function
doc:
<comment>Description:</comment>
  Returns an array of filter queries
  
  Returns an array of filter queries. These are queries that can be used to restrict the super set
  of documents that can be returned, without influencing score

<comment>Return:</comment>
  <info>array</info>  Returns an array on success and <info>null</info> if not set.


id: SolrQuery::getGroup
type: function
doc:
<comment>Description:</comment>
  Returns true if grouping is enabled
  
  Returns true if grouping is enabled

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

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


id: SolrQuery::getGroupCachePercent
type: function
doc:
<comment>Description:</comment>
  Returns group cache percent value
  
  Returns group cache percent value

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

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


id: SolrQuery::getGroupFacet
type: function
doc:
<comment>Description:</comment>
  Returns the group.facet parameter value
  
  Returns the group.facet parameter value

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

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


id: SolrQuery::getGroupFields
type: function
doc:
<comment>Description:</comment>
  Returns group fields (group.field parameter values)
  
  Returns group fields (group.field parameter values)

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

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


id: SolrQuery::getGroupFormat
type: function
doc:
<comment>Description:</comment>
  Returns the group.format value
  
  Returns the group.format value

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

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


id: SolrQuery::getGroupFunctions
type: function
doc:
<comment>Description:</comment>
  Returns group functions (group.func parameter values)
  
  Returns group functions (group.func parameter values)

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

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


id: SolrQuery::getGroupLimit
type: function
doc:
<comment>Description:</comment>
  Returns the group.limit value
  
  Returns the group.limit value

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

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


id: SolrQuery::getGroupMain
type: function
doc:
<comment>Description:</comment>
  Returns the group.main value
  
  Returns the group.main value

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

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


id: SolrQuery::getGroupNGroups
type: function
doc:
<comment>Description:</comment>
  Returns the group.ngroups value
  
  Returns the group.ngroups value

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

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


id: SolrQuery::getGroupOffset
type: function
doc:
<comment>Description:</comment>
  Returns the group.offset value
  
  Returns the group.offset value

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

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


id: SolrQuery::getGroupQueries
type: function
doc:
<comment>Description:</comment>
  Returns all the group.query parameter values
  
  Returns all the group.query parameter values

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

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


id: SolrQuery::getGroupSortFields
type: function
doc:
<comment>Description:</comment>
  Returns the group.sort value
  
  Returns the group.sort value

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

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


id: SolrQuery::getGroupTruncate
type: function
doc:
<comment>Description:</comment>
  Returns the group.truncate value
  
  Returns the group.truncate value

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

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


id: SolrQuery::getHighlight
type: function
doc:
<comment>Description:</comment>
  Returns the state of the hl parameter
  
  Returns a boolean indicating whether or not to enable highlighted snippets to be generated in the
  query response.

<comment>Return:</comment>
  <info>bool</info>  Returns a boolean on success and <info>null</info> if not set.


id: SolrQuery::getHighlightAlternateField
type: function
doc:
<comment>Description:</comment>
  Returns the highlight field to use as backup or default
  
  Returns the highlight field to use as backup or default. It accepts an optional override.

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>string</info>  Returns a string on success and <info>null</info> if not set.


id: SolrQuery::getHighlightFields
type: function
doc:
<comment>Description:</comment>
  Returns all the fields that Solr should generate highlighted snippets for
  
  Returns all the fields that Solr should generate highlighted snippets for

<comment>Return:</comment>
  <info>array</info>  Returns an array on success and <info>null</info> if not set.


id: SolrQuery::getHighlightFormatter
type: function
doc:
<comment>Description:</comment>
  Returns the formatter for the highlighted output
  
  Returns the formatter for the highlighted output

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>string</info>  Returns a string on success and <info>null</info> if not set.


id: SolrQuery::getHighlightFragmenter
type: function
doc:
<comment>Description:</comment>
  Returns the text snippet generator for highlighted text
  
  Returns the text snippet generator for highlighted text. Accepts an optional field override.

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>string</info>  Returns a string on success and <info>null</info> if not set.


id: SolrQuery::getHighlightFragsize
type: function
doc:
<comment>Description:</comment>
  Returns the number of characters of fragments to consider for highlighting
  
  Returns the number of characters of fragments to consider for highlighting. Zero implies no
  fragmenting. The entire field should be used.

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success or <info>null</info> if not set.


id: SolrQuery::getHighlightHighlightMultiTerm
type: function
doc:
<comment>Description:</comment>
  Returns whether or not to enable highlighting for range/wildcard/fuzzy/prefix queries
  
  Returns whether or not to enable highlighting for range/wildcard/fuzzy/prefix queries

<comment>Return:</comment>
  <info>bool</info>  Returns a boolean on success and <info>null</info> if not set.


id: SolrQuery::getHighlightMaxAlternateFieldLength
type: function
doc:
<comment>Description:</comment>
  Returns the maximum number of characters of the field to return
  
  Returns the maximum number of characters of the field to return

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>null</info> if not set.


id: SolrQuery::getHighlightMaxAnalyzedChars
type: function
doc:
<comment>Description:</comment>
  Returns the maximum number of characters into a document to look for suitable snippets
  
  Returns the maximum number of characters into a document to look for suitable snippets

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>null</info> if not set.


id: SolrQuery::getHighlightMergeContiguous
type: function
doc:
<comment>Description:</comment>
  Returns whether or not the collapse contiguous fragments into a single fragment
  
  Returns whether or not the collapse contiguous fragments into a single fragment. Accepts an
  optional field override.

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>bool</info>  Returns a boolean on success and <info>null</info> if not set.


id: SolrQuery::getHighlightRegexMaxAnalyzedChars
type: function
doc:
<comment>Description:</comment>
  Returns the maximum number of characters from a field when using the regex fragmenter
  
  Returns the maximum number of characters from a field when using the regex fragmenter

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>null</info> if not set.


id: SolrQuery::getHighlightRegexPattern
type: function
doc:
<comment>Description:</comment>
  Returns the regular expression for fragmenting
  
  Returns the regular expression used for fragmenting

<comment>Return:</comment>
  <info>string</info>  Returns a string on success and <info>null</info> if not set.


id: SolrQuery::getHighlightRegexSlop
type: function
doc:
<comment>Description:</comment>
  Returns the deviation factor from the ideal fragment size
  
  Returns the factor by which the regex fragmenter can deviate from the ideal fragment size to
  accommodate the regular expression

<comment>Return:</comment>
  <info>float</info>  Returns a <info>float</info> on success and <info>null</info> if not set.


id: SolrQuery::getHighlightRequireFieldMatch
type: function
doc:
<comment>Description:</comment>
  Returns if a field will only be highlighted if the query matched in this particular field
  
  Returns if a field will only be highlighted if the query matched in this particular field.

<comment>Return:</comment>
  <info>bool</info>  Returns a boolean on success and <info>null</info> if not set.


id: SolrQuery::getHighlightSimplePost
type: function
doc:
<comment>Description:</comment>
  Returns the text which appears after a highlighted term
  
  Returns the text which appears after a highlighted term. Accepts an optional field override

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>string</info>  Returns a string on success and <info>null</info> if not set.


id: SolrQuery::getHighlightSimplePre
type: function
doc:
<comment>Description:</comment>
  Returns the text which appears before a highlighted term
  
  Returns the text which appears before a highlighted term. Accepts an optional field override

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>string</info>  Returns a string on success and <info>null</info> if not set.


id: SolrQuery::getHighlightSnippets
type: function
doc:
<comment>Description:</comment>
  Returns the maximum number of highlighted snippets to generate per field
  
  Returns the maximum number of highlighted snippets to generate per field. Accepts an optional
  field override

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>null</info> if not set.


id: SolrQuery::getHighlightUsePhraseHighlighter
type: function
doc:
<comment>Description:</comment>
  Returns the state of the hl.usePhraseHighlighter parameter
  
  Returns whether or not to use SpanScorer to highlight phrase terms only when they appear within
  the query phrase in the document.

<comment>Return:</comment>
  <info>bool</info>  Returns a boolean on success and <info>null</info> if not set.


id: SolrQuery::getMlt
type: function
doc:
<comment>Description:</comment>
  Returns whether or not MoreLikeThis results should be enabled
  
  Returns whether or not MoreLikeThis results should be enabled

<comment>Return:</comment>
  <info>bool</info>  Returns a boolean on success and <info>null</info> if not set.


id: SolrQuery::getMltBoost
type: function
doc:
<comment>Description:</comment>
  Returns whether or not the query will be boosted by the interesting term relevance
  
  Returns whether or not the query will be boosted by the interesting term relevance

<comment>Return:</comment>
  <info>bool</info>  Returns a boolean on success and <info>null</info> if not set.


id: SolrQuery::getMltCount
type: function
doc:
<comment>Description:</comment>
  Returns the number of similar documents to return for each result
  
  Returns the number of similar documents to return for each result

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>null</info> if not set.


id: SolrQuery::getMltFields
type: function
doc:
<comment>Description:</comment>
  Returns all the fields to use for similarity
  
  Returns all the fields to use for similarity

<comment>Return:</comment>
  <info>array</info>  Returns an array on success and <info>null</info> if not set.


id: SolrQuery::getMltMaxNumQueryTerms
type: function
doc:
<comment>Description:</comment>
  Returns the maximum number of query terms that will be included in any generated query
  
  Returns the maximum number of query terms that will be included in any generated query

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>null</info> if not set.


id: SolrQuery::getMltMaxNumTokens
type: function
doc:
<comment>Description:</comment>
  Returns the maximum number of tokens to parse in each document field that is not stored with
  TermVector support
  
  Returns the maximum number of tokens to parse in each document field that is not stored with
  TermVector support

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>null</info> if not set.


id: SolrQuery::getMltMaxWordLength
type: function
doc:
<comment>Description:</comment>
  Returns the maximum word length above which words will be ignored
  
  Returns the maximum word length above which words will be ignored

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>null</info> if not set.


id: SolrQuery::getMltMinDocFrequency
type: function
doc:
<comment>Description:</comment>
  Returns the treshold frequency at which words will be ignored which do not occur in at least this
  many docs
  
  Returns the treshold frequency at which words will be ignored which do not occur in at least this
  many docs

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>null</info> if not set.


id: SolrQuery::getMltMinTermFrequency
type: function
doc:
<comment>Description:</comment>
  Returns the frequency below which terms will be ignored in the source document
  
  Returns the frequency below which terms will be ignored in the source document

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>null</info> if not set.


id: SolrQuery::getMltMinWordLength
type: function
doc:
<comment>Description:</comment>
  Returns the minimum word length below which words will be ignored
  
  Returns the minimum word length below which words will be ignored

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>null</info> if not set.


id: SolrQuery::getMltQueryFields
type: function
doc:
<comment>Description:</comment>
  Returns the query fields and their boosts
  
  Returns the query fields and their boosts

<comment>Return:</comment>
  <info>array</info>  Returns an array on success and <info>null</info> if not set.


id: SolrQuery::getQuery
type: function
doc:
<comment>Description:</comment>
  主なクエリーを返す
  
  主な検索クエリーを返します。

<comment>Return:</comment>
  <info>string</info>  成功した場合は文字列、設定されなかった場合には <info>null</info> を返します。


id: SolrQuery::getRows
type: function
doc:
<comment>Description:</comment>
  Returns the maximum number of documents
  
  Returns the maximum number of documents from the complete result set to return to the client for
  every request

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>null</info> if not set.


id: SolrQuery::getSortFields
type: function
doc:
<comment>Description:</comment>
  Returns all the sort fields
  
  Returns all the sort fields

<comment>Return:</comment>
  <info>array</info>  Returns an array on success and <info>null</info> if none of the parameters was set.


id: SolrQuery::getStart
type: function
doc:
<comment>Description:</comment>
  Returns the offset in the complete result set 
  
  Returns the offset in the complete result set for the queries where the set of returned documents
  should begin.

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>null</info> if not set.


id: SolrQuery::getStats
type: function
doc:
<comment>Description:</comment>
  Returns whether or not stats is enabled
  
  Returns whether or not stats is enabled

<comment>Return:</comment>
  <info>bool</info>  Returns a boolean on success and <info>null</info> if not set.


id: SolrQuery::getStatsFacets
type: function
doc:
<comment>Description:</comment>
  Returns all the stats facets that were set
  
  Returns all the stats facets that were set

<comment>Return:</comment>
  <info>array</info>  Returns an array on success and <info>null</info> if not set.


id: SolrQuery::getStatsFields
type: function
doc:
<comment>Description:</comment>
  Returns all the statistics fields
  
  Returns all the statistics fields

<comment>Return:</comment>
  <info>array</info>  Returns an array on success and <info>null</info> if not set.


id: SolrQuery::getTerms
type: function
doc:
<comment>Description:</comment>
  Returns whether or not the TermsComponent is enabled
  
  Returns whether or not the TermsComponent is enabled

<comment>Return:</comment>
  <info>bool</info>  Returns a boolean on success and <info>null</info> if not set.


id: SolrQuery::getTermsField
type: function
doc:
<comment>Description:</comment>
  Returns the field from which the terms are retrieved
  
  Returns the field from which the terms are retrieved

<comment>Return:</comment>
  <info>string</info>  Returns a string on success and <info>null</info> if not set.


id: SolrQuery::getTermsIncludeLowerBound
type: function
doc:
<comment>Description:</comment>
  Returns whether or not to include the lower bound in the result set
  
  Returns whether or not to include the lower bound in the result set

<comment>Return:</comment>
  <info>bool</info>  Returns a boolean on success and <info>null</info> if not set.


id: SolrQuery::getTermsIncludeUpperBound
type: function
doc:
<comment>Description:</comment>
  Returns whether or not to include the upper bound term in the result set
  
  Returns whether or not to include the upper bound term in the result set

<comment>Return:</comment>
  <info>bool</info>  Returns a boolean on success and <info>null</info> if not set.


id: SolrQuery::getTermsLimit
type: function
doc:
<comment>Description:</comment>
  Returns the maximum number of terms Solr should return
  
  Returns the maximum number of terms Solr should return

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>null</info> if not set.


id: SolrQuery::getTermsLowerBound
type: function
doc:
<comment>Description:</comment>
  Returns the term to start at
  
  Returns the term to start at

<comment>Return:</comment>
  <info>string</info>  Returns a string on success and <info>null</info> if not set.


id: SolrQuery::getTermsMaxCount
type: function
doc:
<comment>Description:</comment>
  Returns the maximum document frequency
  
  Returns the maximum document frequency

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>null</info> if not set.


id: SolrQuery::getTermsMinCount
type: function
doc:
<comment>Description:</comment>
  Returns the minimum document frequency to return in order to be included
  
  Returns the minimum document frequency to return in order to be included

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>null</info> if not set.


id: SolrQuery::getTermsPrefix
type: function
doc:
<comment>Description:</comment>
  Returns the term prefix
  
  Returns the prefix to which matching terms must be restricted. This will restrict matches to only
  terms that start with the prefix

<comment>Return:</comment>
  <info>string</info>  Returns a string on success and <info>null</info> if not set.


id: SolrQuery::getTermsReturnRaw
type: function
doc:
<comment>Description:</comment>
  Whether or not to return raw characters
  
  Returns a boolean indicating whether or not to return the raw characters of the indexed term,
  regardless of if it is human readable

<comment>Return:</comment>
  <info>bool</info>  Returns a boolean on success and <info>null</info> if not set.


id: SolrQuery::getTermsSort
type: function
doc:
<comment>Description:</comment>
  Returns an integer indicating how terms are sorted
  
  SolrQuery::TERMS_SORT_INDEX indicates that the terms are returned by index order.
  SolrQuery::TERMS_SORT_COUNT implies that the terms are sorted by term frequency (highest count
  first)

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>null</info> if not set.


id: SolrQuery::getTermsUpperBound
type: function
doc:
<comment>Description:</comment>
  Returns the term to stop at
  
  Returns the term to stop at

<comment>Return:</comment>
  <info>string</info>  Returns a string on success and <info>null</info> if not set.


id: SolrQuery::getTimeAllowed
type: function
doc:
<comment>Description:</comment>
  Returns the time in milliseconds allowed for the query to finish
  
  Returns the time in milliseconds allowed for the query to finish.

<comment>Return:</comment>
  <info>int</info>  Returns and integer on success and <info>null</info> if it is not set.


id: SolrQuery::removeExpandFilterQuery
type: function
doc:
<comment>Description:</comment>
  Removes an expand filter query
  
  Removes an expand filter query.

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

<comment>Return:</comment>
  <info>SolrQuery</info>  <info>SolrQuery</info>

<comment>See Also:</comment>
   * SolrQuery::setExpand
   * SolrQuery::addExpandSortField
   * SolrQuery::removeExpandSortField
   * SolrQuery::setExpandRows
   * SolrQuery::setExpandQuery
   * SolrQuery::addExpandFilterQuery


id: SolrQuery::removeExpandSortField
type: function
doc:
<comment>Description:</comment>
  Removes an expand sort field from the expand.sort parameter
  
  Removes an expand sort field from the expand.sort parameter.

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

<comment>Return:</comment>
  <info>SolrQuery</info>  <info>SolrQuery</info>

<comment>See Also:</comment>
   * SolrQuery::setExpand
   * SolrQuery::addExpandSortField
   * SolrQuery::setExpandRows
   * SolrQuery::setExpandQuery
   * SolrQuery::addExpandFilterQuery
   * SolrQuery::removeExpandFilterQuery


id: SolrQuery::removeFacetDateField
type: function
doc:
<comment>Description:</comment>
  Removes one of the facet date fields
  
  The name of the field

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  The name of the date field to remove

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::removeFacetDateOther
type: function
doc:
<comment>Description:</comment>
  Removes one of the facet.date.other parameters
  
  Removes one of the facet.date.other parameters

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>           The value
  <info>string</info>  <strong>$field_override</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::removeFacetField
type: function
doc:
<comment>Description:</comment>
  Removes one of the facet.date parameters
  
  Removes one of the facet.date parameters

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  The name of the field

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::removeFacetQuery
type: function
doc:
<comment>Description:</comment>
  Removes one of the facet.query parameters
  
  Removes one of the facet.query parameters.

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

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::removeField
type: function
doc:
<comment>Description:</comment>
  Removes a field from the list of fields
  
  Removes a field from the list of fields

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Name of the field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::removeFilterQuery
type: function
doc:
<comment>Description:</comment>
  Removes a filter query
  
  Removes a filter query.

<comment>Param:</comment>
  <info>string</info>  <strong>$fq</strong>  The filter query to remove

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::removeHighlightField
type: function
doc:
<comment>Description:</comment>
  Removes one of the fields used for highlighting
  
  Removes one of the fields used for highlighting.

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  The name of the field

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::removeMltField
type: function
doc:
<comment>Description:</comment>
  Removes one of the moreLikeThis fields
  
  Removes one of the moreLikeThis fields.

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Name of the field

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::removeMltQueryField
type: function
doc:
<comment>Description:</comment>
  Removes one of the moreLikeThis query fields
  
  Removes one of the moreLikeThis query fields.

<comment>Param:</comment>
  <info>string</info>  <strong>$queryField</strong>  The query field

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::removeSortField
type: function
doc:
<comment>Description:</comment>
  Removes one of the sort fields
  
  Removes one of the sort fields

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  The name of the field

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::removeStatsFacet
type: function
doc:
<comment>Description:</comment>
  Removes one of the stats.facet parameters
  
  Removes one of the stats.facet parameters

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

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::removeStatsField
type: function
doc:
<comment>Description:</comment>
  Removes one of the stats.field parameters
  
  Removes one of the stats.field parameters

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setEchoHandler
type: function
doc:
<comment>Description:</comment>
  Toggles the echoHandler parameter
  
  If set to true, Solr places the name of the handle used in the response to the client for
  debugging purposes.

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  <info>true</info> or <info>false</info>

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setEchoParams
type: function
doc:
<comment>Description:</comment>
  Determines what kind of parameters to include in the response
  
  Instructs Solr what kinds of Request parameters should be included in the response for debugging
  purposes, legal values include:
  
  

<comment>Param:</comment>
  <info>string</info>  <strong>$type</strong>  The type of parameters to include

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setExpand
type: function
doc:
<comment>Description:</comment>
  Enables/Disables the Expand Component
  
  Enables/Disables the Expand Component.

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

<comment>Return:</comment>
  <info>SolrQuery</info>  <info>SolrQuery</info>

<comment>See Also:</comment>
   * SolrQuery::addExpandSortField
   * SolrQuery::removeExpandSortField
   * SolrQuery::setExpandRows
   * SolrQuery::setExpandQuery
   * SolrQuery::addExpandFilterQuery
   * SolrQuery::removeExpandFilterQuery


id: SolrQuery::setExpandQuery
type: function
doc:
<comment>Description:</comment>
  Sets the expand.q parameter
  
  Sets the expand.q parameter.
  
  Overrides the main q parameter,  determines which documents to include in the main group.

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

<comment>Return:</comment>
  <info>SolrQuery</info>  <info>SolrQuery</info>

<comment>See Also:</comment>
   * SolrQuery::setExpand
   * SolrQuery::addExpandSortField
   * SolrQuery::removeExpandSortField
   * SolrQuery::setExpandRows
   * SolrQuery::addExpandFilterQuery
   * SolrQuery::removeExpandFilterQuery


id: SolrQuery::setExpandRows
type: function
doc:
<comment>Description:</comment>
  Sets the number of rows to display in each group (expand.rows). Server Default 5
  
  Sets the number of rows to display in each group (expand.rows). Server Default 5

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

<comment>Return:</comment>
  <info>SolrQuery</info>  <info>SolrQuery</info>

<comment>See Also:</comment>
   * SolrQuery::setExpand
   * SolrQuery::addExpandSortField
   * SolrQuery::removeExpandSortField
   * SolrQuery::setExpandQuery
   * SolrQuery::addExpandFilterQuery
   * SolrQuery::removeExpandFilterQuery


id: SolrQuery::setExplainOther
type: function
doc:
<comment>Description:</comment>
  Sets the explainOther common query parameter
  
  Sets the explainOther common query parameter

<comment>Param:</comment>
  <info>string</info>  <strong>$query</strong>  The Lucene query to identify a set of documents

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setFacet
type: function
doc:
<comment>Description:</comment>
  Maps to the facet parameter. Enables or disables facetting
  
  Enables or disables faceting.

<comment>Param:</comment>
  <info></info>  <strong>$value</strong>  <info>true</info> enables faceting and <info>false</info> disables it.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setFacetDateEnd
type: function
doc:
<comment>Description:</comment>
  Maps to facet.date.end
  
  Maps to facet.date.end

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>           See facet.date.end
  <info>string</info>  <strong>$field_override</strong>  Name of the field

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setFacetDateGap
type: function
doc:
<comment>Description:</comment>
  Maps to facet.date.gap
  
  Maps to facet.date.gap

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>           See facet.date.gap
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setFacetDateHardEnd
type: function
doc:
<comment>Description:</comment>
  Maps to facet.date.hardend
  
  Maps to facet.date.hardend

<comment>Param:</comment>
  <info>bool</info>    <strong>$value</strong>           See facet.date.hardend
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setFacetDateStart
type: function
doc:
<comment>Description:</comment>
  Maps to facet.date.start
  
  Maps to facet.date.start

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>           See facet.date.start
  <info>string</info>  <strong>$field_override</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setFacetEnumCacheMinDefaultFrequency
type: function
doc:
<comment>Description:</comment>
  Sets the minimum document frequency used for determining term count
  
  Sets the minimum document frequency used for determining term count

<comment>Param:</comment>
  <info></info>        <strong>$value</strong>           The minimum frequency
  <info>string</info>  <strong>$field_override</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setFacetLimit
type: function
doc:
<comment>Description:</comment>
  Maps to facet.limit
  
  Maps to facet.limit. Sets the maximum number of constraint counts that should be returned for the
  facet fields.

<comment>Param:</comment>
  <info>int</info>     <strong>$limit</strong>           The maximum number of constraint counts
  <info>string</info>  <strong>$field_override</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setFacetMethod
type: function
doc:
<comment>Description:</comment>
  Specifies the type of algorithm to use when faceting a field
  
  Specifies the type of algorithm to use when faceting a field. This method accepts optional field
  override.

<comment>Param:</comment>
  <info>string</info>  <strong>$method</strong>          The method to use.
  <info>string</info>  <strong>$field_override</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setFacetMinCount
type: function
doc:
<comment>Description:</comment>
  Maps to facet.mincount
  
  Sets the minimum counts for facet fields that should be included in the response

<comment>Param:</comment>
  <info>int</info>     <strong>$mincount</strong>        The minimum count
  <info>string</info>  <strong>$field_override</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setFacetMissing
type: function
doc:
<comment>Description:</comment>
  Maps to facet.missing
  
  Used to indicate that in addition to the Term-based constraints of a facet field, a count of all
  matching results which have no value for the field should be computed

<comment>Param:</comment>
  <info>bool</info>    <strong>$flag</strong>            <info>true</info> turns this feature on. <info>false</info> disables it.
  <info>string</info>  <strong>$field_override</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setFacetOffset
type: function
doc:
<comment>Description:</comment>
  Sets the offset into the list of constraints to allow for pagination
  
  Sets the offset into the list of constraints to allow for pagination.

<comment>Param:</comment>
  <info>int</info>     <strong>$offset</strong>          The offset
  <info>string</info>  <strong>$field_override</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setFacetPrefix
type: function
doc:
<comment>Description:</comment>
  Specifies a string prefix with which to limits the terms on which to facet
  
  Specifies a string prefix with which to limits the terms on which to facet.

<comment>Param:</comment>
  <info>string</info>  <strong>$prefix</strong>          The prefix string
  <info>string</info>  <strong>$field_override</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setFacetSort
type: function
doc:
<comment>Description:</comment>
  Determines the ordering of the facet field constraints
  
  Determines the ordering of the facet field constraints

<comment>Param:</comment>
  <info>int</info>     <strong>$facetSort</strong>       Use SolrQuery::FACET_SORT_INDEX for sorting by index order or
                           SolrQuery::FACET_SORT_COUNT for sorting by count.
  <info>string</info>  <strong>$field_override</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setGroup
type: function
doc:
<comment>Description:</comment>
  Enable/Disable result grouping (group parameter)
  
  Enable/Disable result grouping (group parameter)

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

<comment>Return:</comment>
  <info>SolrQuery</info>  

<comment>See Also:</comment>
   * SolrQuery::getGroup
   * SolrQuery::addGroupField
   * SolrQuery::addGroupFunction
   * SolrQuery::addGroupQuery
   * SolrQuery::addGroupSortField
   * SolrQuery::setGroupFacet
   * SolrQuery::setGroupOffset
   * SolrQuery::setGroupLimit
   * SolrQuery::setGroupMain
   * SolrQuery::setGroupNGroups
   * SolrQuery::setGroupTruncate
   * SolrQuery::setGroupFormat
   * SolrQuery::setGroupCachePercent


id: SolrQuery::setGroupCachePercent
type: function
doc:
<comment>Description:</comment>
  Enables caching for result grouping
  
  Setting this parameter to a number greater than 0 enables caching for result grouping. Result
  Grouping executes two searches; this option caches the second search. The server default value is
  0.  Testing has shown that group caching only improves search time with Boolean, wildcard, and
  fuzzy queries. For simple queries like term or "match all" queries, group caching degrades
  performance. group.cache.percent parameter

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

<comment>Return:</comment>
  <info>SolrQuery</info>  

<comment>See Also:</comment>
   * SolrQuery::setGroup
   * SolrQuery::addGroupField
   * SolrQuery::addGroupFunction
   * SolrQuery::addGroupQuery
   * SolrQuery::addGroupSortField
   * SolrQuery::setGroupFacet
   * SolrQuery::setGroupOffset
   * SolrQuery::setGroupLimit
   * SolrQuery::setGroupMain
   * SolrQuery::setGroupNGroups
   * SolrQuery::setGroupTruncate
   * SolrQuery::setGroupFormat


id: SolrQuery::setGroupFacet
type: function
doc:
<comment>Description:</comment>
  Sets group.facet parameter
  
  Determines whether to compute grouped facets for the field facets specified in facet.field
  parameters. Grouped facets are computed based on the first specified group.

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

<comment>Return:</comment>
  <info>SolrQuery</info>  

<comment>See Also:</comment>
   * SolrQuery::setGroup
   * SolrQuery::addGroupField
   * SolrQuery::addGroupFunction
   * SolrQuery::addGroupQuery
   * SolrQuery::addGroupSortField
   * SolrQuery::setGroupOffset
   * SolrQuery::setGroupLimit
   * SolrQuery::setGroupMain
   * SolrQuery::setGroupNGroups
   * SolrQuery::setGroupTruncate
   * SolrQuery::setGroupFormat
   * SolrQuery::setGroupCachePercent


id: SolrQuery::setGroupFormat
type: function
doc:
<comment>Description:</comment>
  Sets the group format, result structure (group.format parameter)
  
  Sets the group.format parameter. If this parameter is set to simple, the grouped documents are
  presented in a single flat list, and the start and rows parameters affect the numbers of documents
  instead of groups. Accepts: grouped/simple

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

<comment>Return:</comment>
  <info>SolrQuery</info>  

<comment>See Also:</comment>
   * SolrQuery::setGroup
   * SolrQuery::addGroupField
   * SolrQuery::addGroupFunction
   * SolrQuery::addGroupQuery
   * SolrQuery::addGroupSortField
   * SolrQuery::setGroupFacet
   * SolrQuery::setGroupOffset
   * SolrQuery::setGroupLimit
   * SolrQuery::setGroupMain
   * SolrQuery::setGroupNGroups
   * SolrQuery::setGroupTruncate
   * SolrQuery::setGroupCachePercent


id: SolrQuery::setGroupLimit
type: function
doc:
<comment>Description:</comment>
  Specifies the number of results to return for each group. The server default value is 1
  
  Specifies the number of results to return for each group. The server default value is 1.

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

<comment>Return:</comment>
  <info>SolrQuery</info>  

<comment>See Also:</comment>
   * SolrQuery::setGroup
   * SolrQuery::addGroupField
   * SolrQuery::addGroupFunction
   * SolrQuery::addGroupQuery
   * SolrQuery::addGroupSortField
   * SolrQuery::setGroupFacet
   * SolrQuery::setGroupOffset
   * SolrQuery::setGroupMain
   * SolrQuery::setGroupNGroups
   * SolrQuery::setGroupTruncate
   * SolrQuery::setGroupFormat
   * SolrQuery::setGroupCachePercent


id: SolrQuery::setGroupMain
type: function
doc:
<comment>Description:</comment>
  If true, the result of the first field grouping command is used as the main result list in the
  response, using group.format=simple
  
  If <info>true</info>, the result of the first field grouping command is used as the main result list in the
  response, using <return>group.format=simple</return>.

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>  If <info>true</info>, the result of the first field grouping command is used as the main result
                  list in the response.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns an instance of <class>SolrQuery</class>.

<comment>See Also:</comment>
   * SolrQuery::setGroup
   * SolrQuery::addGroupField
   * SolrQuery::addGroupFunction
   * SolrQuery::addGroupQuery
   * SolrQuery::addGroupSortField
   * SolrQuery::setGroupFacet
   * SolrQuery::setGroupOffset
   * SolrQuery::setGroupMain
   * SolrQuery::setGroupNGroups
   * SolrQuery::setGroupTruncate
   * SolrQuery::setGroupFormat
   * SolrQuery::setGroupCachePercent


id: SolrQuery::setGroupNGroups
type: function
doc:
<comment>Description:</comment>
  If true, Solr includes the number of groups that have matched the query in the results
  
  If true, Solr includes the number of groups that have matched the query in the results.

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

<comment>Return:</comment>
  <info>SolrQuery</info>  

<comment>See Also:</comment>
   * SolrQuery::setGroup
   * SolrQuery::addGroupField
   * SolrQuery::addGroupFunction
   * SolrQuery::addGroupQuery
   * SolrQuery::addGroupSortField
   * SolrQuery::setGroupFacet
   * SolrQuery::setGroupOffset
   * SolrQuery::setGroupLimit
   * SolrQuery::setGroupMain
   * SolrQuery::setGroupTruncate
   * SolrQuery::setGroupFormat
   * SolrQuery::setGroupCachePercent


id: SolrQuery::setGroupOffset
type: function
doc:
<comment>Description:</comment>
  Sets the group.offset parameter
  
  Sets the group.offset parameter.

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

<comment>Return:</comment>
  <info>SolrQuery</info>  

<comment>See Also:</comment>
   * SolrQuery::setGroup
   * SolrQuery::addGroupField
   * SolrQuery::addGroupFunction
   * SolrQuery::addGroupQuery
   * SolrQuery::addGroupSortField
   * SolrQuery::setGroupFacet
   * SolrQuery::setGroupLimit
   * SolrQuery::setGroupMain
   * SolrQuery::setGroupNGroups
   * SolrQuery::setGroupTruncate
   * SolrQuery::setGroupFormat
   * SolrQuery::setGroupCachePercent


id: SolrQuery::setGroupTruncate
type: function
doc:
<comment>Description:</comment>
  If true, facet counts are based on the most relevant document of each group matching the query
  
  If true, facet counts are based on the most relevant document of each group matching the query.
  The server default value is false. group.truncate parameter

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

<comment>Return:</comment>
  <info>SolrQuery</info>  

<comment>See Also:</comment>
   * SolrQuery::setGroup
   * SolrQuery::addGroupField
   * SolrQuery::addGroupFunction
   * SolrQuery::addGroupQuery
   * SolrQuery::addGroupSortField
   * SolrQuery::setGroupFacet
   * SolrQuery::setGroupOffset
   * SolrQuery::setGroupLimit
   * SolrQuery::setGroupMain
   * SolrQuery::setGroupNGroups
   * SolrQuery::setGroupFormat
   * SolrQuery::setGroupCachePercent


id: SolrQuery::setHighlight
type: function
doc:
<comment>Description:</comment>
  Enables or disables highlighting
  
  Setting it to <info>true</info> enables highlighted snippets to be generated in the query response.
  
  Setting it to <info>false</info> disables highlighting

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  Enable or disable highlighting

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setHighlightAlternateField
type: function
doc:
<comment>Description:</comment>
  Specifies the backup field to use
  
  If a snippet cannot be generated because there were no matching terms, one can specify a field to
  use as the backup or default summary

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>           The name of the backup field
  <info>string</info>  <strong>$field_override</strong>  The name of the field we are overriding this setting for.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setHighlightFormatter
type: function
doc:
<comment>Description:</comment>
  Specify a formatter for the highlight output
  
  Specify a formatter for the highlight output.

<comment>Param:</comment>
  <info>string</info>  <strong>$formatter</strong>       Currently the only legal value is "simple"
  <info>string</info>  <strong>$field_override</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns an instance of <class>SolrQuery</class>.


id: SolrQuery::setHighlightFragmenter
type: function
doc:
<comment>Description:</comment>
  Sets a text snippet generator for highlighted text
  
  Specify a text snippet generator for highlighted text.

<comment>Param:</comment>
  <info>string</info>  <strong>$fragmenter</strong>      The standard fragmenter is gap. Another option is regex, which tries to
                           create fragments that resembles a certain regular expression
  <info>string</info>  <strong>$field_override</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setHighlightFragsize
type: function
doc:
<comment>Description:</comment>
  The size of fragments to consider for highlighting
  
  Sets the size, in characters, of fragments to consider for highlighting. "0" indicates that the
  whole field value should be used (no fragmenting).

<comment>Param:</comment>
  <info>int</info>     <strong>$size</strong>            The size, in characters, of fragments to consider for highlighting
  <info>string</info>  <strong>$field_override</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setHighlightHighlightMultiTerm
type: function
doc:
<comment>Description:</comment>
  Use SpanScorer to highlight phrase terms
  
  Use SpanScorer to highlight phrase terms only when they appear within the query phrase in the
  document.

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  Whether or not to use SpanScorer to highlight phrase terms only when they appear
               within the query phrase in the document.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setHighlightMaxAlternateFieldLength
type: function
doc:
<comment>Description:</comment>
  Sets the maximum number of characters of the field to return
  
  If SolrQuery::setHighlightAlternateField() was passed the value <info>true</info>, this parameter specifies the
  maximum number of characters of the field to return
  
  Any value less than or equal to 0 means unlimited.

<comment>Param:</comment>
  <info>int</info>     <strong>$fieldLength</strong>     The length of the field
  <info>string</info>  <strong>$field_override</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setHighlightMaxAnalyzedChars
type: function
doc:
<comment>Description:</comment>
  Specifies the number of characters into a document to look for suitable snippets
  
  Specifies the number of characters into a document to look for suitable snippets

<comment>Param:</comment>
  <info>int</info>  <strong>$value</strong>  The number of characters into a document to look for suitable snippets

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setHighlightMergeContiguous
type: function
doc:
<comment>Description:</comment>
  Whether or not to collapse contiguous fragments into a single fragment
  
  Whether or not to collapse contiguous fragments into a single fragment

<comment>Param:</comment>
  <info></info>        <strong>$value</strong>           Whether or not to collapse contiguous fragments into a single fragment
  <info>string</info>  <strong>$field_override</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setHighlightRegexMaxAnalyzedChars
type: function
doc:
<comment>Description:</comment>
  Specify the maximum number of characters to analyze
  
  Specify the maximum number of characters to analyze from a field when using the regex fragmenter

<comment>Param:</comment>
  <info>int</info>  <strong>$maxAnalyzedChars</strong>  The maximum number of characters to analyze from a field when using the
                          regex fragmenter

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setHighlightRegexPattern
type: function
doc:
<comment>Description:</comment>
  Specify the regular expression for fragmenting
  
  Specifies the regular expression for fragmenting. This could be used to extract sentences

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>  The regular expression for fragmenting. This could be used to extract sentences

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setHighlightRegexSlop
type: function
doc:
<comment>Description:</comment>
  Sets the factor by which the regex fragmenter can stray from the ideal fragment size
  
  The factor by which the regex fragmenter can stray from the ideal fragment size ( specfied by
  SolrQuery::setHighlightFragsize )to accommodate the regular expression

<comment>Param:</comment>
  <info>float</info>  <strong>$factor</strong>  The factor by which the regex fragmenter can stray from the ideal fragment size

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setHighlightRequireFieldMatch
type: function
doc:
<comment>Description:</comment>
  Require field matching during highlighting
  
  If <info>true</info>, then a field will only be highlighted if the query matched in this particular field.
  
  This will only work if SolrQuery::setHighlightUsePhraseHighlighter() was set to <info>true</info>

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  <info>true</info> or <info>false</info>

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setHighlightSimplePost
type: function
doc:
<comment>Description:</comment>
  Sets the text which appears after a highlighted term
  
  Sets the text which appears before a highlighted term

<comment>Param:</comment>
  <info>string</info>  <strong>$simplePost</strong>      Sets the text which appears after a highlighted term
                           
                            ]]>
  <info>string</info>  <strong>$field_override</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns an instance of <class>SolrQuery</class>.


id: SolrQuery::setHighlightSimplePre
type: function
doc:
<comment>Description:</comment>
  Sets the text which appears before a highlighted term
  
  Sets the text which appears before a highlighted term
  
   ]]>

<comment>Param:</comment>
  <info>string</info>  <strong>$simplePre</strong>       The text which appears before a highlighted term
  <info>string</info>  <strong>$field_override</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setHighlightSnippets
type: function
doc:
<comment>Description:</comment>
  Sets the maximum number of highlighted snippets to generate per field
  
  Sets the maximum number of highlighted snippets to generate per field

<comment>Param:</comment>
  <info>int</info>     <strong>$value</strong>           The maximum number of highlighted snippets to generate per field
  <info>string</info>  <strong>$field_override</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setHighlightUsePhraseHighlighter
type: function
doc:
<comment>Description:</comment>
  Whether to highlight phrase terms only when they appear within the query phrase
  
  Sets whether or not to use SpanScorer to highlight phrase terms only when they appear within the
  query phrase in the document

<comment>Param:</comment>
  <info></info>  <strong>$value</strong>  Whether or not to use SpanScorer to highlight phrase terms only when they appear within
            the query phrase in the document

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setMlt
type: function
doc:
<comment>Description:</comment>
  Enables or disables moreLikeThis
  
  Enables or disables moreLikeThis

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  <info>true</info> enables it and <info>false</info> turns it off.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setMltBoost
type: function
doc:
<comment>Description:</comment>
  Set if the query will be boosted by the interesting term relevance
  
  Set if the query will be boosted by the interesting term relevance

<comment>Param:</comment>
  <info></info>  <strong>$value</strong>  Sets to <info>true</info> or <info>false</info>

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setMltCount
type: function
doc:
<comment>Description:</comment>
  Set the number of similar documents to return for each result
  
  Set the number of similar documents to return for each result

<comment>Param:</comment>
  <info>int</info>  <strong>$count</strong>  The number of similar documents to return for each result

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setMltMaxNumQueryTerms
type: function
doc:
<comment>Description:</comment>
  Sets the maximum number of query terms included
  
  Sets the maximum number of query terms that will be included in any generated query.

<comment>Param:</comment>
  <info>int</info>  <strong>$value</strong>  The maximum number of query terms that will be included in any generated query

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setMltMaxNumTokens
type: function
doc:
<comment>Description:</comment>
  Specifies the maximum number of tokens to parse
  
  Specifies the maximum number of tokens to parse in each example doc field that is not stored with
  TermVector support.

<comment>Param:</comment>
  <info>int</info>  <strong>$value</strong>  The maximum number of tokens to parse

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setMltMaxWordLength
type: function
doc:
<comment>Description:</comment>
  Sets the maximum word length
  
  Sets the maximum word length above which words will be ignored.

<comment>Param:</comment>
  <info>int</info>  <strong>$maxWordLength</strong>  The maximum word length above which words will be ignored

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setMltMinDocFrequency
type: function
doc:
<comment>Description:</comment>
  Sets the mltMinDoc frequency
  
  The frequency at which words will be ignored which do not occur in at least this many docs.

<comment>Param:</comment>
  <info>int</info>  <strong>$minDocFrequency</strong>  Sets the frequency at which words will be ignored which do not occur in at
                         least this many docs.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setMltMinTermFrequency
type: function
doc:
<comment>Description:</comment>
  Sets the frequency below which terms will be ignored in the source docs
  
  Sets the frequency below which terms will be ignored in the source docs

<comment>Param:</comment>
  <info>int</info>  <strong>$minTermFrequency</strong>  The frequency below which terms will be ignored in the source docs

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setMltMinWordLength
type: function
doc:
<comment>Description:</comment>
  Sets the minimum word length
  
  Sets the minimum word length below which words will be ignored.

<comment>Param:</comment>
  <info>int</info>  <strong>$minWordLength</strong>  The minimum word length below which words will be ignored

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setOmitHeader
type: function
doc:
<comment>Description:</comment>
  Exclude the header from the returned results
  
  Exclude the header from the returned results.

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  <info>true</info> excludes the header from the result.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setQuery
type: function
doc:
<comment>Description:</comment>
  検索クエリーを設定
  
  検索クエリーを設定します。

<comment>Param:</comment>
  <info>string</info>  <strong>$query</strong>  検索クエリー

<comment>Return:</comment>
  <info>SolrQuery</info>  現行の SolrQuery オブジェクトを返します。


id: SolrQuery::setRows
type: function
doc:
<comment>Description:</comment>
  Specifies the maximum number of rows to return in the result
  
  Specifies the maximum number of rows to return in the result

<comment>Param:</comment>
  <info>int</info>  <strong>$rows</strong>  The maximum number of rows to return

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object.


id: SolrQuery::setShowDebugInfo
type: function
doc:
<comment>Description:</comment>
  Flag to show debug information
  
  Whether to show debug info

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  Whether to show debug info. <info>true</info> or <info>false</info>

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setStart
type: function
doc:
<comment>Description:</comment>
  Specifies the number of rows to skip
  
  Specifies the number of rows to skip. Useful in pagination of results.

<comment>Param:</comment>
  <info>int</info>  <strong>$start</strong>  The number of rows to skip.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object.


id: SolrQuery::setStats
type: function
doc:
<comment>Description:</comment>
  Enables or disables the Stats component
  
  Enables or disables the Stats component.

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  <info>true</info> turns on the stats component and <info>false</info> disables it.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setTerms
type: function
doc:
<comment>Description:</comment>
  Enables or disables the TermsComponent
  
  Enables or disables the TermsComponent

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  <info>true</info> enables it. <info>false</info> turns it off

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setTermsField
type: function
doc:
<comment>Description:</comment>
  Sets the name of the field to get the Terms from
  
  Sets the name of the field to get the terms from

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldname</strong>  The field name

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setTermsIncludeLowerBound
type: function
doc:
<comment>Description:</comment>
  Include the lower bound term in the result set
  
  Include the lower bound term in the result set.

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  Include the lower bound term in the result set

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setTermsIncludeUpperBound
type: function
doc:
<comment>Description:</comment>
  Include the upper bound term in the result set
  
  Include the upper bound term in the result set.

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  <info>true</info> or <info>false</info>

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setTermsLimit
type: function
doc:
<comment>Description:</comment>
  Sets the maximum number of terms to return
  
  Sets the maximum number of terms to return

<comment>Param:</comment>
  <info>int</info>  <strong>$limit</strong>  The maximum number of terms to return. All the terms will be returned if the limit is
               negative.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setTermsLowerBound
type: function
doc:
<comment>Description:</comment>
  Specifies the Term to start from
  
  Specifies the Term to start from

<comment>Param:</comment>
  <info>string</info>  <strong>$lowerBound</strong>  The lower bound Term

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setTermsMaxCount
type: function
doc:
<comment>Description:</comment>
  Sets the maximum document frequency
  
  Sets the maximum document frequency.

<comment>Param:</comment>
  <info>int</info>  <strong>$frequency</strong>  The maximum document frequency.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setTermsMinCount
type: function
doc:
<comment>Description:</comment>
  Sets the minimum document frequency
  
  Sets the minimum doc frequency to return in order to be included

<comment>Param:</comment>
  <info>int</info>  <strong>$frequency</strong>  The minimum frequency

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setTermsPrefix
type: function
doc:
<comment>Description:</comment>
  Restrict matches to terms that start with the prefix
  
  Restrict matches to terms that start with the prefix

<comment>Param:</comment>
  <info>string</info>  <strong>$prefix</strong>  Restrict matches to terms that start with the prefix

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setTermsReturnRaw
type: function
doc:
<comment>Description:</comment>
  Return the raw characters of the indexed term
  
  If true, return the raw characters of the indexed term, regardless of if it is human readable

<comment>Param:</comment>
  <info></info>  <strong>$value</strong>  <info>true</info> or <info>false</info>

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setTermsSort
type: function
doc:
<comment>Description:</comment>
  Specifies how to sort the returned terms
  
  If SolrQuery::TERMS_SORT_COUNT, sorts the terms by the term frequency (highest count first). If
  SolrQuery::TERMS_SORT_INDEX, returns the terms in index order

<comment>Param:</comment>
  <info>int</info>  <strong>$sortType</strong>  SolrQuery::TERMS_SORT_INDEX or SolrQuery::TERMS_SORT_COUNT

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setTermsUpperBound
type: function
doc:
<comment>Description:</comment>
  Sets the term to stop at
  
  Sets the term to stop at

<comment>Param:</comment>
  <info>string</info>  <strong>$upperBound</strong>  The term to stop at

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setTimeAllowed
type: function
doc:
<comment>Description:</comment>
  The time allowed for search to finish
  
  The time allowed for a search to finish. This value only applies to the search and not to requests
  in general. Time is in milliseconds. Values less than or equal to zero implies no time
  restriction. Partial results may be returned, if there are any.

<comment>Param:</comment>
  <info>int</info>  <strong>$timeAllowed</strong>  The time allowed for a search to finish.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrResponse::getDigestedResponse
type: function
doc:
<comment>Description:</comment>
  シリアライズされた PHP データとして XML レスポンスを返す
  
  シリアライズされた PHP データとして XML レスポンスを返します。

<comment>Return:</comment>
  <info>string</info>  シリアライズされた PHP データとして XML レスポンスを返します。


id: SolrResponse::getHttpStatus
type: function
doc:
<comment>Description:</comment>
  レスポンスの HTTP ステータスを返す
  
  レスポンスの HTTP ステータスを返します。

<comment>Return:</comment>
  <info>int</info>  レスポンスの HTTP ステータスを返します。


id: SolrResponse::getHttpStatusMessage
type: function
doc:
<comment>Description:</comment>
  HTTP ステータスに関する詳細を返す
  
  HTTP ステータスに関する詳細を返します。

<comment>Return:</comment>
  <info>string</info>  HTTP ステータスに関する詳細を返します。


id: SolrResponse::getRawRequest
type: function
doc:
<comment>Description:</comment>
  Solr サーバーに送られた生のリクエストを返す
  
  Solr サーバーに送られた生のリクエストを返します。

<comment>Return:</comment>
  <info>string</info>  Solr サーバーに送られた生のリクエストを返します。


id: SolrResponse::getRawRequestHeaders
type: function
doc:
<comment>Description:</comment>
  Solr サーバーに送られた生のリクエストヘッダを返す
  
  Solr サーバーに送られた生のリクエストヘッダを返します。

<comment>Return:</comment>
  <info>string</info>  Solr サーバーに送られた生のリクエストヘッダを返します。


id: SolrResponse::getRawResponse
type: function
doc:
<comment>Description:</comment>
  Solr サーバーからの生のレスポンスを返す
  
  Solr サーバーからの生のレスポンスを返します。

<comment>Return:</comment>
  <info>string</info>  Solr サーバーからの生のレスポンスを返します。


id: SolrResponse::getRawResponseHeaders
type: function
doc:
<comment>Description:</comment>
  Solr サーバーからの生のレスポンスヘッダを返す
  
  Solr サーバーからの生のレスポンスヘッダを返します。

<comment>Return:</comment>
  <info>string</info>  Solr サーバーからの生のレスポンスヘッダを返します。


id: SolrResponse::getRequestUrl
type: function
doc:
<comment>Description:</comment>
  リクエストが送られた完全な URL を返す
  
  リクエストが送られた完全な URL を返します。

<comment>Return:</comment>
  <info>string</info>  リクエストが送られた完全な URL を返します。


id: SolrResponse::getResponse
type: function
doc:
<comment>Description:</comment>
  サーバーからの XML レスポンスを表現する SolrObject を返す
  
  サーバーからの XML レスポンスを表現する SolrObject を返します。

<comment>Return:</comment>
  <info>SolrObject</info>  サーバーからの XML レスポンスを表現する SolrObject を返します。


id: SolrResponse::setParseMode
type: function
doc:
<comment>Description:</comment>
  パースモードを設定
  
  パースモードを設定します。

<comment>Param:</comment>
  <info>int</info>  <strong>$parser_mode</strong>  SolrResponse::PARSE_SOLR_DOC は、SolrDocument インスタンス内の文書をパースしま
                     す。 SolrResponse::PARSE_SOLR_OBJ は、SolrObjects 内に文書をパースします。

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


id: SolrResponse::success
type: function
doc:
<comment>Description:</comment>
  リクエストが成功したか
  
  サーバーへのリクエストが成功したかチェックするために使用されます。

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


id: SolrUtils
type: class
doc:
<comment>Description:</comment>
  拡張モジュールの現行バージョンを取得し、クエリ句を準備するための ユーティリティ・メソッドを含みま
  す。
  
  クエリ文字列をエスケープしたり、XML レスポンスをパースするためのメソッドも含みます。


id: SolrUtils::digestXmlResponse
type: function
doc:
<comment>Description:</comment>
  Parses an response XML string into a SolrObject
  
  This method parses an response XML string from the Apache Solr server into a SolrObject. It throws
  a SolrException if there was an error.

<comment>Param:</comment>
  <info>string</info>  <strong>$xmlresponse</strong>  The XML response string from the Solr server.
  <info>int</info>     <strong>$parse_mode</strong>   Use SolrResponse::PARSE_SOLR_OBJ or SolrResponse::PARSE_SOLR_DOC

<comment>Return:</comment>
  <info>SolrObject</info>  Returns the SolrObject representing the XML response.
              
              If the parse_mode parameter is set to SolrResponse::PARSE_SOLR_OBJ Solr documents will
              be parses as SolrObject instances.
              
              If it is set to SolrResponse::PARSE_SOLR_DOC, they will be parsed as SolrDocument
              instances.


id: SolrUtils::escapeQueryChars
type: function
doc:
<comment>Description:</comment>
  Escapes a lucene query string
  
  Lucene supports escaping special characters that are part of the query syntax.
  
  The current list special characters are:
  
  

<comment>Param:</comment>
  <info>string</info>  <strong>$str</strong>  This is the query string to be escaped.

<comment>Return:</comment>
  <info>string|false</info>  Returns the escaped string失敗した場合に <info>false</info> を返します.


id: SolrUtils::getSolrVersion
type: function
doc:
<comment>Description:</comment>
  Solr 拡張モジュールの現行バージョンを返す
  
  Solr の現行バージョンを返します。

<comment>Return:</comment>
  <info>string</info>  Apache Solr 拡張モジュールの現行バージョン。


id: SolrUtils::queryPhrase
type: function
doc:
<comment>Description:</comment>
  Prepares a phrase from an unescaped lucene string
  
  Prepares a phrase from an unescaped lucene string.

<comment>Param:</comment>
  <info>string</info>  <strong>$str</strong>  The lucene phrase.

<comment>Return:</comment>
  <info>string</info>  Returns the phrase contained in double quotes.


id: SplDoublyLinkedList::add
type: function
doc:
<comment>Description:</comment>
  特定のインデックスに新しい値を 追加/挿入 する
  
  指定された <strong>$index</strong> に <strong>$value</strong> を挿入し、 以前その位置にあった値(とそれ以後にあるリストの値すべて)を
  シャッフルします

<comment>Param:</comment>
  <info>int</info>    <strong>$index</strong>  新しい値が挿入されるインデックス
  <info>mixed</info>  <strong>$value</strong>  <strong>$index</strong> に入る新しい値

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


id: SplDoublyLinkedList::bottom
type: function
doc:
<comment>Description:</comment>
  双方向リンクリストの最初のノードを取得する

<comment>Return:</comment>
  <info>mixed</info>  最初のノードの値を返します。


id: SplDoublyLinkedList::count
type: function
doc:
<comment>Description:</comment>
  双方向リンクリストの要素数を数える

<comment>Return:</comment>
  <info>int</info>  双方向リンクリストの要素数を返します。


id: SplDoublyLinkedList::current
type: function
doc:
<comment>Description:</comment>
  現在の配列の要素を返す
  
  双方向リンクリストの現在のノードを取得します。

<comment>Return:</comment>
  <info>mixed</info>  現在のノードの値を返します。


id: SplDoublyLinkedList::getIteratorMode
type: function
doc:
<comment>Description:</comment>
  反復処理のモードを返す

<comment>Return:</comment>
  <info>int</info>  反復処理の才のモードおよびフラグを返します。


id: SplDoublyLinkedList::isEmpty
type: function
doc:
<comment>Description:</comment>
  双方向リンクリストが空かどうかを調べる

<comment>Return:</comment>
  <info>bool</info>  双方向リンクリストが空かどうかを返します。


id: SplDoublyLinkedList::key
type: function
doc:
<comment>Description:</comment>
  現在のノードのインデックスを返す
  
  この館数は、現在のノードのインデックスを返します。

<comment>Return:</comment>
  <info>int</info>  現在のノードのインデックスを返します。


id: SplDoublyLinkedList::next
type: function
doc:
<comment>Description:</comment>
  次のエントリに移動する
  
  イテレータを次のノードに移動します。

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


id: SplDoublyLinkedList::offsetExists
type: function
doc:
<comment>Description:</comment>
  指定した $index が存在するかどうかを返す

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  調べたいインデックス。

<comment>Return:</comment>
  <info>bool</info>  指定した <strong>$index</strong> が存在する場合に <info>true</info>、 それ以外の場合に <info>false</info> を返します。


id: SplDoublyLinkedList::offsetGet
type: function
doc:
<comment>Description:</comment>
  指定した $index の値を返す

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  値を取得したいインデックス。

<comment>Return:</comment>
  <info>mixed</info>  指定した <strong>$index</strong> の値を返します。


id: SplDoublyLinkedList::offsetSet
type: function
doc:
<comment>Description:</comment>
  指定した $index の値を $value に設定する
  
  指定した <strong>$index</strong> の値を <strong>$value</strong> に設定します。

<comment>Param:</comment>
  <info>int|null</info>  <strong>$index</strong>  設定したいインデックス。 <info>null</info> の場合、最後の項目の次の値が追加されます。
  <info>mixed</info>     <strong>$value</strong>  <strong>$index</strong> の新しい値。

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


id: SplDoublyLinkedList::offsetUnset
type: function
doc:
<comment>Description:</comment>
  指定した $index の値を削除する
  
  指定したインデックスの値を削除します。

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  削除したいインデックス。

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


id: SplDoublyLinkedList::pop
type: function
doc:
<comment>Description:</comment>
  双方向リンクリストの末尾からノードを取り出す

<comment>Return:</comment>
  <info>mixed</info>  取り出したノードの値を返します。


id: SplDoublyLinkedList::prev
type: function
doc:
<comment>Description:</comment>
  前のエントリに移動する
  
  イテレータを前のノードに移動します。

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


id: SplDoublyLinkedList::push
type: function
doc:
<comment>Description:</comment>
  双方向リンクリストの末尾に要素を追加する
  
  <strong>$value</strong> を双方向リンクリストの末尾に追加します。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  追加したい値。

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


id: SplDoublyLinkedList::rewind
type: function
doc:
<comment>Description:</comment>
  イテレータを先頭に巻き戻す
  
  イテレータを先頭に巻き戻します。

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


id: SplDoublyLinkedList::serialize
type: function
doc:
<comment>Description:</comment>
  ストレージをシリアライズする
  
  ストレージをシリアライズします。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>string</info>  シリアライズした文字列を返します。

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


id: SplDoublyLinkedList::setIteratorMode
type: function
doc:
<comment>Description:</comment>
  反復処理のモードを設定する

<comment>Param:</comment>
  <info>int</info>  <strong>$mode</strong>  次の 2 種類の直交するモードを設定できます。
              
              反復処理の方向 (いずれかを選択)
              
              <info>SplDoublyLinkedList::IT_MODE_LIFO</info> (スタック方式)
              
              <info>SplDoublyLinkedList::IT_MODE_FIFO</info> (キュー方式)
              
              イテレータの振る舞い (いずれかを選択)
              
              <info>SplDoublyLinkedList::IT_MODE_DELETE</info> (イテレータが要素を削除する)
              
              <info>SplDoublyLinkedList::IT_MODE_KEEP</info> (イテレータが要素を順にたどる)
              
              デフォルトのモードは <info>SplDoublyLinkedList::IT_MODE_FIFO</info> |
              <info>SplDoublyLnkedList::IT_MODE_KEEP</info> です。
              
              <class>SplStack</class> と <class>SplQueue</class> においては、反復処理の方向は変更できません。 これらのクラスでは、
              反復処理の方向は常に <info>SplDoublyLinkedList::IT_MODE_FIFO</info> になります。 この値を変更しよう
              とすると、<class>RuntimeException</class> がスローされます。

<comment>Return:</comment>
  <info>int</info>  反復処理に影響する、異なるモードとフラグの値を返します。


id: SplDoublyLinkedList::shift
type: function
doc:
<comment>Description:</comment>
  双方向リンクリストの先頭からノードを取り出す

<comment>Return:</comment>
  <info>mixed</info>  取り出したノードの値を返します。


id: SplDoublyLinkedList::top
type: function
doc:
<comment>Description:</comment>
  双方向リンクリストの最後のノードを取得する

<comment>Return:</comment>
  <info>mixed</info>  最後のノードの値を返します。


id: SplDoublyLinkedList::unserialize
type: function
doc:
<comment>Description:</comment>
  ストレージをアンシリアライズする
  
  SplDoublyLinkedList::serialize でシリアライズしたストレージを復元します。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  シリアライズした文字列。

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

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


id: SplDoublyLinkedList::unshift
type: function
doc:
<comment>Description:</comment>
  双方向リンクリストの先頭に要素を追加する
  
  <strong>$value</strong> を双方向リンクリストの先頭に追加します。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  追加する値。

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


id: SplDoublyLinkedList::valid
type: function
doc:
<comment>Description:</comment>
  双方向リンクリストにまだノードがあるかどうかを調べる
  
  双方向リンクリストにまだノードがあるかどうかを調べます。

<comment>Return:</comment>
  <info>bool</info>  双方向リンクリストにまだノードが含まれる場合に <info>true</info>、 そうでない場合に <info>false</info> を返します。


id: SplFileInfo::__construct
type: function
doc:
<comment>Description:</comment>
  新しい SplFileInfo オブジェクトを作成する
  
  file_name で指定したファイル用の新しい SplFileInfo オブジェクトを作成します。 ファイルが存在する必
  要はなく、また読み込み可能である必要もありません。

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


id: SplFileInfo::__toString
type: function
doc:
<comment>Description:</comment>
  ファイルへのパスを文字列で返す
  
  このメソッドは、参照するファイルのファイル名を返します。

<comment>Return:</comment>
  <info>string</info>  ファイルへのパスを返します。


id: SplFileInfo::getATime
type: function
doc:
<comment>Description:</comment>
  ファイルの最終アクセス時刻を取得する
  
  ファイルの最終アクセス時刻を取得します。

<comment>Return:</comment>
  <info>int|false</info>  成功時に、ファイルに最後にアクセスがあった時刻を返します。 失敗時に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>fileatime()</strong>
   * SplFileInfo::getCTime
   * SplFileInfo::getMTime


id: SplFileInfo::getBasename
type: function
doc:
<comment>Description:</comment>
  ファイルのベース名を取得する
  
  このメソッドは、ファイルやディレクトリそしてリンクからパス情報を除いたベース名を返します。
  
  <strong>SplFileInfo::getBasename()</strong> は、ロケールを認識します。 よって、マルチバイト文字が含まれたパスのベー
  ス名を正しく返させるためには、 そのパスと一致するロケールを <strong>setlocale()</strong> 関数で設定しなければなりま
  せん。

<comment>Param:</comment>
  <info>string</info>  <strong>$suffix</strong>  返されるベース名から取り除きたい、オプションのサフィックス。

<comment>Return:</comment>
  <info>string</info>  パス情報を含まないベース名を返します。

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


id: SplFileInfo::getCTime
type: function
doc:
<comment>Description:</comment>
  inode 変更時刻を取得する
  
  ファイルの inode が変更された時刻を返します。返される時刻は Unix タイムスタンプ形式です。

<comment>Return:</comment>
  <info>int|false</info>  最終変更時刻を Unix タイムスタンプで返します。 失敗時に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>filectime()</strong>
   * SplFileInfo::getATime
   * SplFileInfo::getMTime


id: SplFileInfo::getExtension
type: function
doc:
<comment>Description:</comment>
  ファイルの拡張子を取得する
  
  ファイルの拡張子を取得します。

<comment>Return:</comment>
  <info>string</info>  ファイルの拡張子を含む文字列を返します。 拡張子がないときは、空文字列を返します。

<comment>See Also:</comment>
   * SplFileInfo::getFilename
   * SplFileInfo::getBasename
   * <strong>pathinfo()</strong>


id: SplFileInfo::getFileInfo
type: function
doc:
<comment>Description:</comment>
  ファイルの SplFileInfo オブジェクトを取得する
  
  このメソッドは、参照先のファイルの <class>SplFileInfo</class> オブジェクトを取得します。

<comment>Param:</comment>
  <info>string|null</info>  <strong>$class</strong>  使用したい <class>SplFileInfo</class> 派生クラスの名前。

<comment>Return:</comment>
  <info>SplFileInfo</info>  そのファイル用に作成した <class>SplFileInfo</class> オブジェクトを返します。

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


id: SplFileInfo::getFilename
type: function
doc:
<comment>Description:</comment>
  ファイル名を取得する
  
  パス情報を一切含まないファイル名を取得します。

<comment>Return:</comment>
  <info>string</info>  ファイル名を返します。

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


id: SplFileInfo::getGroup
type: function
doc:
<comment>Description:</comment>
  ファイルのグループを取得する
  
  ファイルのグループを取得します。グループ ID を数値形式で返します。

<comment>Return:</comment>
  <info>int|false</info>  成功時に、グループ ID を数値形式で返します。 失敗時に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>filegroup()</strong>
   * <strong>posix_getgrgid()</strong>


id: SplFileInfo::getInode
type: function
doc:
<comment>Description:</comment>
  ファイルの inode を取得する
  
  ファイルシステムオブジェクトの inode 番号を取得します。

<comment>Return:</comment>
  <info>int|false</info>  ファイルシステムオブジェクトの inode 番号を返します。 失敗時に <info>false</info> を返します。

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


id: SplFileInfo::getLinkTarget
type: function
doc:
<comment>Description:</comment>
  リンク先を取得する
  
  ファイルシステムのリンク先を取得します。
  
  リンク先は、ファイルシステム上の実際のパスではないかもしれません。 SplFileInfo::getRealPath を使用
  して、ファイルシステム上の実際のパスを調べます。

<comment>Return:</comment>
  <info>string|false</info>  ファイルシステムのリンク先を返します。 失敗時に <info>false</info> を返します。

<comment>See Also:</comment>
   * SplFileInfo::isLink
   * SplFileInfo::getRealPath


id: SplFileInfo::getMTime
type: function
doc:
<comment>Description:</comment>
  最終変更時刻を取得する
  
  ファイルの中身が変更された時刻を返します。返される時刻は Unix タイムスタンプ形式となります。

<comment>Return:</comment>
  <info>int|false</info>  ファイルの最終変更時刻を Unix タイムスタンプで返します。 失敗時に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>filemtime()</strong>
   * SplFileInfo::getATime
   * SplFileInfo::getCTime


id: SplFileInfo::getOwner
type: function
doc:
<comment>Description:</comment>
  ファイルの所有者を取得する
  
  ファイルの所有者を取得します。オーナー ID は数値形式で返されます。

<comment>Return:</comment>
  <info>int|false</info>  オーナー ID を数値形式で返します。 失敗時に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>posix_getpwuid()</strong>
   * SplFileInfo::getGroup


id: SplFileInfo::getPath
type: function
doc:
<comment>Description:</comment>
  ファイル名を除いたパスを取得する
  
  ファイルへのパスを返します。ファイル名や最後のスラッシュは取り除きます。

<comment>Return:</comment>
  <info>string</info>  ファイルへのパスを返します。

<comment>See Also:</comment>
   * SplFileInfo::getRealPath
   * SplFileInfo::getFilename
   * SplFileInfo::getPathInfo


id: SplFileInfo::getPathInfo
type: function
doc:
<comment>Description:</comment>
  パスの SplFileInfo オブジェクトを取得する
  
  現在のファイルの親を表す <class>SplFileInfo</class> オブジェクトを取得します。

<comment>Param:</comment>
  <info>string|null</info>  <strong>$class</strong>  使用したい <class>SplFileInfo</class> 派生クラスの名前。 SplFileInfo 自体を使う場合は <info>null</info>
                       を指定します。

<comment>Return:</comment>
  <info>SplFileInfo|null</info>  ファイルの親のパスの <class>SplFileInfo</class> オブジェクトを返します。 失敗時に <info>null</info> を返しま
                    す。

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


id: SplFileInfo::getPathname
type: function
doc:
<comment>Description:</comment>
  ファイルへのパスを取得する
  
  ファイルへのパスを返します。

<comment>Return:</comment>
  <info>string</info>  ファイルへのパスを返します。

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


id: SplFileInfo::getPerms
type: function
doc:
<comment>Description:</comment>
  ファイルのパーミッションを取得する
  
  ファイルのパーミッションを取得します。

<comment>Return:</comment>
  <info>int|false</info>  ファイルのパーミッションを返します。 失敗時に <info>false</info> を返します。


id: SplFileInfo::getRealPath
type: function
doc:
<comment>Description:</comment>
  ファイルへの絶対パスを取得する
  
  このメソッドは、すべてのシンボリックリンクを展開して相対参照を解決し、 ファイルへの実際のパスを返
  します。

<comment>Return:</comment>
  <info>string|false</info>  ファイルへのパスを返します。ファイルが存在しない場合は <info>false</info> を返します。

<comment>See Also:</comment>
   * SplFileInfo::isLink
   * realpath


id: SplFileInfo::getSize
type: function
doc:
<comment>Description:</comment>
  ファイルサイズを取得する
  
  参照するファイルのファイルサイズをバイト数で返します。

<comment>Return:</comment>
  <info>int|false</info>  ファイルサイズをバイト数で返します。 失敗時に <info>false</info> を返します。

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


id: SplFileInfo::getType
type: function
doc:
<comment>Description:</comment>
  ファイルタイプを取得する
  
  参照するファイルの型を返します。

<comment>Return:</comment>
  <info>string|false</info>  このエントリの型を文字列で返します。 <return>file</return>, <return>link</return>, <return>dir</return>, <return>block</return>, <return>fifo</return>, <return>char</return>, <return>socket</return>,
                <return>unknown</return> のいずれかとなります。 失敗時に <info>false</info> を返します。


id: SplFileInfo::isDir
type: function
doc:
<comment>Description:</comment>
  ファイルがディレクトリかどうかを調べる
  
  このメソッドを使用して、ファイルがディレクトリかどうかを調べます。

<comment>Return:</comment>
  <info>bool</info>  ディレクトリである場合に <info>true</info>、そうでない場合に <info>false</info> を返します。


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

<comment>Return:</comment>
  <info>bool</info>  実行可能である場合に <info>true</info>、そうでない場合に <info>false</info> を返します。


id: SplFileInfo::isFile
type: function
doc:
<comment>Description:</comment>
  オブジェクトの参照先が通常のファイルであるかどうかを調べる
  
  この SplFileInfo オブジェクトが参照するファイルが存在し、通常のファイルであるかどうかを調べます。

<comment>Return:</comment>
  <info>bool</info>  ファイルが存在してかつ (リンクではない) 通常のファイルである場合に <info>true</info>、 そうでない場合に
        <info>false</info> を返します。


id: SplFileInfo::isLink
type: function
doc:
<comment>Description:</comment>
  ファイルがリンクであるかどうかを調べる
  
  このメソッドを使用して、SplFileInfo オブジェクトが参照するファイルがリンクであるかどうかを調べま
  す。

<comment>Return:</comment>
  <info>bool</info>  ファイルがリンクである場合に <info>true</info>、そうでない場合に <info>false</info> を返します。

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


id: SplFileInfo::isReadable
type: function
doc:
<comment>Description:</comment>
  ファイルが読み込み可能か調べる
  
  ファイルが読み込み可能かどうかを調べます。

<comment>Return:</comment>
  <info>bool</info>  読み込み可能である場合に <info>true</info>、そうでない場合に <info>false</info> を返します。


id: SplFileInfo::isWritable
type: function
doc:
<comment>Description:</comment>
  エントリが書き込み可能であるかどうかを調べる
  
  現在のエントリが書き込み可能かどうかを調べます。

<comment>Return:</comment>
  <info>bool</info>  書き込み可能な場合に <info>true</info>、そうでない場合に <info>false</info> を返します。


id: SplFileInfo::openFile
type: function
doc:
<comment>Description:</comment>
  ファイルの SplFileObject オブジェクトを取得する
  
  ファイルの <class>SplFileObject</class> オブジェクトを作成します。 これが便利なのは、<class>SplFileObject</class> にはファイルを
  操作するためのさまざまなメソッドが追加されているからです。 <class>SplFileInfo</class> には、 たとえばファイルが書
  き込み可能かどうかなどといった情報を取得するだけの機能しかありません。

<comment>Param:</comment>
  <info>string</info>         <strong>$mode</strong>            ファイルを開く際のモード。使用できるモードについての説明は <strong>fopen()</strong>
                                  のドキュメントを参照ください。 デフォルトは読み込み専用となりま
                                  す。
  <info>bool</info>           <strong>$useIncludePath</strong>  <info>true</info> に設定すると、このファイル名を
                                  include_path の中からも探します。
  <info>resource|null</info>  <strong>$context</strong>         <return>コンテキスト</return> についての説明は、
                                  マニュアルの コンテキスト の節を参照ください。

<comment>Return:</comment>
  <info>SplFileObject</info>  オープンしたファイルを <class>SplFileObject</class> オブジェクトで返します。

<comment>See Also:</comment>
   * <class>SplFileObject</class>
   * <strong>stream_context_create()</strong>
   * <strong>fopen()</strong>


id: SplFileInfo::setFileClass
type: function
doc:
<comment>Description:</comment>
  SplFileInfo::openFile で使用するクラスを設定する
  
  SplFileInfo::openFile が呼ばれたときに使用する、カスタムクラスを設定します。 このメソッドに渡すク
  ラス名は、<class>SplFileObject</class> あるいはその派生クラスのものでなければいけません。

<comment>Param:</comment>
  <info>string</info>  <strong>$class</strong>  SplFileInfo::openFile がコールされた際に使用するクラス名。

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

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


id: SplFileInfo::setInfoClass
type: function
doc:
<comment>Description:</comment>
  SplFileInfo::getFileInfo および SplFileInfo::getPathInfo で使用するクラスを設定する
  
  このメソッドで、 SplFileInfo::getFileInfo および SplFileInfo::getPathInfo がコールされた際に使用す
  るカスタムクラスを設定します。 このメソッドに渡すクラス名は、<class>SplFileInfo</class> あるいはその派生クラスの
  ものでなければいけません。

<comment>Param:</comment>
  <info>string</info>  <strong>$class</strong>  SplFileInfo::getFileInfo および SplFileInfo::getPathInfo がコールされた際に使用す
                  るクラス名。

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

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


id: SplFileObject::SKIP_EMPTY
type: constant
doc:
<comment>Description:</comment>
  ファイルの空行を読み飛ばします。期待通りに動作させるには、<info>READ_AHEAD</info> フラグを有効にしないといけま
  せん。


id: SplFileObject::__construct
type: function
doc:
<comment>Description:</comment>
  新しいファイルオブジェクトを作成する
  
  新しいファイルオブジェクトを作成します。

<comment>Param:</comment>
  <info>string</info>         <strong>$filename</strong>        読み込むファイル。
                                  
                                  fopen wrappers が有効の場合、この関数のファイル名として
                                  URL を使用することができます。ファイル名の指定方法に関する詳細は
                                  <strong>fopen()</strong> を参照ください。
                                   には、さまざまなラッパーの機能やその使用法、
                                  提供される定義済み変数などの情報がまとめられています。
  <info>string</info>         <strong>$mode</strong>            ファイルをオープンするときのモード。許可されるモードのリストは
                                  <strong>fopen()</strong> を参照。
  <info>bool</info>           <strong>$useIncludePath</strong>  <strong>$filename</strong> を探すのに include_path を探索するかどうか。
  <info>resource|null</info>  <strong>$context</strong>         <strong>stream_context_create()</strong> で作られる有効なコンテキストリソース。

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


id: SplFileObject::__toString
type: function
doc:
<comment>Description:</comment>
  現在の行を文字列として取得する
  
  このメソッドは、現在の行を文字列として取得します。

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


id: SplFileObject::current
type: function
doc:
<comment>Description:</comment>
  ファイルの現在の行を取得する
  
  ファイルの現在の行を取得します。

<comment>Return:</comment>
  <info>string|array|false</info>  ファイルの現在の行を取得します。<info>SplFileObject::READ_CSV</info> フラグがセットされてい
                      る場合、このメソッドは CSV データとして処理された現在の行を格納している配列を
                      返します。 ファイルの終端に達した場合、<info>false</info> を返します。

<comment>See Also:</comment>
   * SplFileObject::key
   * SplFileObject::seek
   * SplFileObject::next
   * SplFileObject::rewind
   * SplFileObject::valid


id: SplFileObject::eof
type: function
doc:
<comment>Description:</comment>
  ファイルの終端に到達しているか調べる
  
  ファイルの終端に到達しているか調べます。

<comment>Return:</comment>
  <info>bool</info>  ファイルが終端であれば <info>true</info>、そうでなければ <info>false</info> を返します。

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


id: SplFileObject::fflush
type: function
doc:
<comment>Description:</comment>
  出力をファイルにフラッシュする
  
  バッファリングされたすべての出力をファイルに強制的に書き込みます。

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

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


id: SplFileObject::fgetc
type: function
doc:
<comment>Description:</comment>
  ファイルから文字を取り出す
  
  ファイルから 1 文字取り出す。

<comment>Return:</comment>
  <info>string|false</info>  ファイルから読み込まれた 1 文字を含む文字列もしくは終端の場合は <info>false</info> を返します。
                
                この関数は論理値
                <info>false</info> を返す可能性がありますが、<info>false</info> として評価される値を返す可能性もあります。
                詳細については 論理値の
                セクションを参照してください。この関数の返り値を調べるには
                ===演算子 を
                使用してください。

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


id: SplFileObject::fgetcsv
type: function
doc:
<comment>Description:</comment>
  ファイルから行を取り出し CSV フィールドとして処理する
  
  CSV フォーマットのファイルから行を取り出し読み込まれたフィールドを含む配列を返します。
  
  この関数は、ロケール設定を考慮します。 <return>LC_CTYPE</return> がたとえば <return>en_US.UTF-8</return> だった場合、 ファイルの1バ
  イトのエンコーディングは、この関数では間違った読まれ方をする可能性があります。

<comment>Param:</comment>
  <info>string</info>  <strong>$separator</strong>  フィールドの区切り文字 (シングルバイト文字 1 文字のみ)。 デフォルトはカンマも
                      しくは SplFileObject::setCsvControl を使ってセットされた値です。
  <info>string</info>  <strong>$enclosure</strong>  フィールド囲み文字 (シングルバイト文字 1 文字のみ)。 デフォルトはダブルクォー
                      トもしくは SplFileObject::setCsvControl を使ってセットされた値です。
  <info>string</info>  <strong>$escape</strong>     エスケープ文字 (シングルバイト文字 最大で1文字)。 デフォルトはバックスラッシュ
                      (<return>\</return>) もしくは SplFileObject::setCsvControl を使ってセットされた値です。 空文字
                      列(<return>""</return>)の場合、(RFC 4180 に準拠していない) 独自仕様のエスケープ機構が無効になり
                      ます。
                      
                      <strong>$enclosure</strong> の文字は、フィールド内で2回出力される ことでエスケープされます。し
                      かし、 <strong>$escape</strong> 文字はその代替として使えます。 デフォルトのパラメータの値 <return>""</return> と
                      <return>\"</return> は同じ意味を持ちます。 <strong>$enclosure</strong> の文字を <strong>$escape</strong> 文字でエスケープすること
                      には、 特別な意味はありません。それ自身をエスケープする意味ですらありません。

<comment>Return:</comment>
  <info>array|false</info>  読み込まれたフィールドを含む数値添字配列もしくはエラーのときは <info>false</info> を返します。
               
               CSV ファイルの空白行は <info>SplFileObject::SKIP_EMPTY | SplFileObject::DROP_NEW_LINE</info> を使
               わない限り単独の <info>null</info> フィールドで構成される配列として返され、この場合空白行は読み飛
               ばされます。

<comment>See Also:</comment>
   * SplFileObject::setCsvControl
   * SplFileObject::setFlags
   * SplFileObject::READ_CSV
   * SplFileObject::current


id: SplFileObject::fgets
type: function
doc:
<comment>Description:</comment>
  ファイルから 1 行取り出す
  
  ファイルから 1 行取り出します。

<comment>Return:</comment>
  <info>string</info>  ファイルから次の行を含む文字列を返します。

<comment>See Also:</comment>
   * <strong>fgets()</strong>
   * SplFileObject::fgetss
   * SplFileObject::fgetc
   * SplFileObject::current


id: SplFileObject::fgetss
type: function
doc:
<comment>Description:</comment>
  ファイルから 1 行取り出し HTML タグを取り除く
  
  SplFileObject::fgetss 読み込むテキストから HTML と PHP タグを取り除こうとすること以外、
  SplFileObject::fgets と同じです。 この関数は、ある呼び出しから別の呼び出しの間のパースの状態を保持
  します。 したがって、これは SplFileObject::fgets の戻り値に対して <strong>strip_tags()</strong> 関数を呼び出すのと
  同じではありません。

<comment>Param:</comment>
  <info>string</info>  <strong>$allowable_tags</strong>  オプションのパラメータで、取り除きたくないタグを指定します。

<comment>Return:</comment>
  <info>string</info>  HTML と PHP コードが取り除かれたファイルの次の行を含む文字列、もしくは <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>fgetss()</strong>
   * SplFileObject::fgets
   * SplFileObject::fgetc
   * SplFileObject::current
   * The string.strip_tags filter


id: SplFileObject::flock
type: function
doc:
<comment>Description:</comment>
  簡易なファイルロックを行う
  
  <strong>flock()</strong> と同じ簡易な方法でファイルをロックもしくはロック解除する。

<comment>Param:</comment>
  <info>int</info>  <strong>$operation</strong>   <strong>$operation</strong> は次のいずれかです:  共有ロック (読み手) にするには <info>LOCK_SH</info>。  排他
                    ロック (書き手) にするには <info>LOCK_EX</info>。  (共有もしくは排他) ロックを解除するには
                    <info>LOCK_UN</info>。
                    
                    共有ロック (読み手) にするには <info>LOCK_SH</info>。
                    
                    排他ロック (書き手) にするには <info>LOCK_EX</info>。
                    
                    (共有もしくは排他) ロックを解除するには <info>LOCK_UN</info>。
                    
                    ロックを試みている間に <strong>flock()</strong> がブロックすべきでない場合は、上の操作のいずれか
                    に <info>LOCK_NB</info> をビットマスクとして追加できます。
  <info>int</info>  <strong>$wouldBlock</strong>  ロックがブロックされる場合 (errno が EWOULDBLOCK である)、<info>true</info> にセットします。

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

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


id: SplFileObject::fpassthru
type: function
doc:
<comment>Description:</comment>
  ファイルポインタに残っているデータをすべて出力する
  
  与えられたファイルポインタの現在位置から終端までを読み込み結果を出力バッファに書き出します。
  
  既にデータをファイルに書き込んでいる場合、ファイルポインタをファイルの始めにリセットするために
  SplFileObject::rewind を呼び出すことが必要になる場合があります。

<comment>Return:</comment>
  <info>int</info>  <strong>$handle</strong> から読み込まれ出力を通して渡された文字数を返します。

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


id: SplFileObject::fputcsv
type: function
doc:
<comment>Description:</comment>
  フィールドの配列を CSV の行として書き出す
  
  <strong>$fields</strong> の配列を、CSV の行としてファイルに書き出します。

<comment>Param:</comment>
  <info>array</info>   <strong>$fields</strong>     値の配列。
  <info>string</info>  <strong>$separator</strong>  オプションで指定する、フィールドの区切り文字 (シングルバイト文字 一文字のみ)。
  <info>string</info>  <strong>$enclosure</strong>  オプションで指定する。フィールドの囲み文字 (シングルバイト文字 一文字のみ)。
  <info>string</info>  <strong>$escape</strong>     オプションの <strong>$escape</strong> は、エスケープ文字 (シングルバイト文字 最大で一文字) を指
                      定します。 空文字列 (<return>""</return>) を与えると、(RFC 4180 に準拠していない) 独自仕様のエ
                      スケープ機構を無効にします。
  <info>string</info>  <strong>$eol</strong>        <strong>$eol</strong> は、 カスタムの行末シーケンスを設定するオプションの引数です。

<comment>Return:</comment>
  <info>int|false</info>  書き出した文字列の長さを返します。失敗した場合に <info>false</info> を返します。
             
             <strong>$separator</strong> や <strong>$enclosure</strong> が一文字でない場合は <info>false</info> を返し、何もファイルに書き出しませ
             ん。

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


id: SplFileObject::fread
type: function
doc:
<comment>Description:</comment>
  ファイルから読み取る
  
  ファイルから与えられたバイト数だけ読み取ります。

<comment>Param:</comment>
  <info>int</info>  <strong>$length</strong>  読み取るバイト数

<comment>Return:</comment>
  <info>string|false</info>  ファイルから読み取った文字列を返します。 失敗した場合に <info>false</info> を返します

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


id: SplFileObject::fscanf
type: function
doc:
<comment>Description:</comment>
  フォーマットに従ってファイルからの入力をパースする
  
  ファイルから 1 行読み込み、<strong>$format</strong> に従って解釈します。
  
  <strong>$format</strong> 文字列のホワイトスペースはファイルからの行のホワイトスペースとマッチします。このことが意味
  するのはフォーマット文字列のタブ (<return>\t</return>) でさえも入力ストリームの 1 つのスペース文字とマッチしてしま
  うということです。

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

<comment>Return:</comment>
  <info>array|int|null</info>  このメソッドに渡される引数がひとつしかない場合、処理される値は配列として返されま
                  す。そうでなければ、オプションパラメータが渡される場合、メソッドは割り当て値の個数
                  を返します。オプションパラメータは参照渡しでなければなりません。

<comment>See Also:</comment>
   * <strong>fscanf()</strong>
   * <strong>sscanf()</strong>
   * <strong>printf()</strong>
   * <strong>sprintf()</strong>


id: SplFileObject::fseek
type: function
doc:
<comment>Description:</comment>
  ファイルポインタを移動させる
  
  <strong>$offset</strong> を <strong>$whence</strong> で指定される位置に追加することで、ファイルの始めからバイト単位でファイルポイン
  トを移動させます。

<comment>Param:</comment>
  <info>int</info>  <strong>$offset</strong>  オフセットです。負の値はポインタを戻すために使うことができます。これは SEEK_END が
                <strong>$whence</strong> の値として使われるときに便利です。
  <info>int</info>  <strong>$whence</strong>  <strong>$whence</strong> の値は次のようなものになります: <info>SEEK_SET</info> - <strong>$offset</strong> バイトに等しい位置にセッ
                トします。<info>SEEK_CUR</info> - 現在の位置に <strong>$offset</strong> を加えた位置にセットします。<info>SEEK_END</info> - 終
                端に <strong>$offset</strong> を加えた位置にセットします。
                
                <strong>$whence</strong> が指定されない場合、<info>SEEK_SET</info> が前提になります。

<comment>Return:</comment>
  <info>int</info>  探索が成功した場合は 0、そうでなければ -1 が返されます。終端より先の位置を探索してもエラーに
       ならないことにご注意してください。

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


id: SplFileObject::fstat
type: function
doc:
<comment>Description:</comment>
  ファイルの情報を得る
  
  ファイルの統計情報を集めます。<strong>fstat()</strong> とまったく同じように振る舞います。

<comment>Return:</comment>
  <info>array</info>  ファイルの統計情報の配列を返します; 配列フォーマットの詳細は <strong>stat()</strong> のマニュアルページを参
         照ください。

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


id: SplFileObject::ftell
type: function
doc:
<comment>Description:</comment>
  ファイルポインタの現在位置を返す
  
  ファイルストリームにおいて現在のオフセットを表すファイルポインタの現在位置を返します。

<comment>Return:</comment>
  <info>int|false</info>  ファイルポインタの位置を整数として、もしくはエラーのときは <info>false</info> を返します。

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


id: SplFileObject::ftruncate
type: function
doc:
<comment>Description:</comment>
  ファイルを指定した長さに丸める
  
  ファイルを <strong>$size</strong> バイトに丸めます。

<comment>Param:</comment>
  <info>int</info>  <strong>$size</strong>  丸めるサイズ。
              
              <strong>$size</strong> がファイルのサイズより大きい場合、ファイルは null バイトで拡大されます。
              
              <strong>$size</strong> がファイルのサイズより小さい場合、余分なデータは失われます。

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

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


id: SplFileObject::fwrite
type: function
doc:
<comment>Description:</comment>
  ファイルに書き込む
  
  Writes the contents of <strong>$string</strong> to the file

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>    ファイルに書き込まれる文字列。
  <info>int</info>     <strong>$length</strong>  <strong>$length</strong> 引数が渡される場合、<strong>$length</strong> バイト分だけ書き込まれた後もしくは <strong>$string</strong> の
                   終端に達するのどちらか早い方の後で書き込みが停止します。

<comment>Return:</comment>
  <info>int|false</info>  書き込まれるバイト数、もしくはエラーの場合 <info>false</info> を返します。

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


id: SplFileObject::getChildren
type: function
doc:
<comment>Description:</comment>
  用途はなし
  
  <class>SplFileObject</class> は子を持たないのでこのメソッドは <info>null</info> を返します。

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

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


id: SplFileObject::getCsvControl
type: function
doc:
<comment>Description:</comment>
  CSV の区切り、囲み文字、エスケープ文字を取得する
  
  CSV フィールドを処理するのに使われる区切りと囲み文字とエスケープ文字を取得します。

<comment>Return:</comment>
  <info>array</info>  区切りと囲み文字とエスケープ文字を含む数字添字配列を返します。

<comment>See Also:</comment>
   * SplFileObject::setCsvControl
   * SplFileObject::fgetcsv


id: SplFileObject::getCurrentLine
type: function
doc:
<comment>Description:</comment>
  SplFileObject::fgets のエイリアス
  
  このメソッドは次のメソッドのエイリアスです。 SplFileObject::fgets


id: SplFileObject::getFlags
type: function
doc:
<comment>Description:</comment>
  SplFileObject のフラグを取得する
  
  SplFileObject のインスタンス用のフラグセットを <info>int</info> 形式で取得します。

<comment>Return:</comment>
  <info>int</info>  フラグを表す <info>int</info> を返します。

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


id: SplFileObject::getMaxLineLen
type: function
doc:
<comment>Description:</comment>
  行の最大バイト数を取得する
  
  SplFileObject::setMaxLineLen によってセットされる行の最大バイト数を取得します。

<comment>Return:</comment>
  <info>int</info>  SplFileObject::setMaxLineLen でセットされる場合は行の最大バイト数を返します。デフォルトは <return>0</return>
       です。

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


id: SplFileObject::hasChildren
type: function
doc:
<comment>Description:</comment>
  SplFileObject は子を持ちません
  
  <class>SplFileObject</class> は子を持たないのでこのメソッドは常に <info>false</info> を返します。

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

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


id: SplFileObject::key
type: function
doc:
<comment>Description:</comment>
  行番号を取得する
  
  現在の行番号を取得します。
  
  固定長のファイルを読み込むのに SplFileObject::setMaxLineLen が使われている場合 この数はファイルの
  実際の行番号を反映しない可能性があります。

<comment>Return:</comment>
  <info>int</info>  現在の行番号を返します。

<comment>See Also:</comment>
   * SplFileObject::current
   * SplFileObject::seek
   * SplFileObject::next
   * SplFileObject::rewind
   * SplFileObject::valid


id: SplFileObject::next
type: function
doc:
<comment>Description:</comment>
  次の行を読み出す
  
  ファイルの次の行に進みます。

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

<comment>See Also:</comment>
   * SplFileObject::current
   * SplFileObject::key
   * SplFileObject::seek
   * SplFileObject::rewind
   * SplFileObject::valid


id: SplFileObject::rewind
type: function
doc:
<comment>Description:</comment>
  ファイルポインタを先頭に巻き戻す
  
  ファイルポインタを先頭に巻き戻します。

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

<comment>See Also:</comment>
   * SplFileObject::current
   * SplFileObject::key
   * SplFileObject::seek
   * SplFileObject::next
   * SplFileObject::valid


id: SplFileObject::seek
type: function
doc:
<comment>Description:</comment>
  ファイルポインタを指定行に移動させる
  
  ファイルポインタを指定行に移動させます。

<comment>Param:</comment>
  <info>int</info>  <strong>$line</strong>  ゼロを起点とした移動させる行数。

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

<comment>See Also:</comment>
   * SplFileObject::current
   * SplFileObject::key
   * SplFileObject::next
   * SplFileObject::rewind
   * SplFileObject::valid


id: SplFileObject::setCsvControl
type: function
doc:
<comment>Description:</comment>
  CSV の区切り文字、囲み文字、エスケープ文字をセットする
  
  CSV フィールド処理用の区切り文字と囲み文字とエスケープ文字をセットします。

<comment>Param:</comment>
  <info>string</info>  <strong>$separator</strong>  フィールドの区切り文字 (シングルバイト文字 1 文字のみ)。
  <info>string</info>  <strong>$enclosure</strong>  フィールドの囲み文字 (シングルバイト文字 1 文字のみ)。
  <info>string</info>  <strong>$escape</strong>     フィールドのエスケープ文字 (シングルバイト文字 最大で1文字)。 空文字列(<return>""</return>)を指
                      定すると、(RFC 4180 に準拠していない) 独自仕様のエスケープ機構が無効になりま
                      す。

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

<comment>See Also:</comment>
   * SplFileObject::getCsvControl
   * SplFileObject::fgetcsv


id: SplFileObject::setFlags
type: function
doc:
<comment>Description:</comment>
  SplFileObject のフラグをセットする
  
  <class>SplFileObject</class> によって使われるフラグをセットします。

<comment>Param:</comment>
  <info>int</info>  <strong>$flags</strong>  セットするフラグのビットマスク。 利用可能なフラグは SplFileObject の定数 を参照くださ
               い。

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

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


id: SplFileObject::setMaxLineLen
type: function
doc:
<comment>Description:</comment>
  読み込む行の最大バイト数をセットする
  
  読み込む行の最大バイト数をセットします。

<comment>Param:</comment>
  <info>int</info>  <strong>$maxLength</strong>  行の最大バイト数。

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

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


id: SplFileObject::valid
type: function
doc:
<comment>Description:</comment>
  ファイル終端でないかチェックする
  
  ファイル終端に到達したかチェックします。

<comment>Return:</comment>
  <info>bool</info>  ファイル終端に到達していなければ <info>true</info>、そうでなければ <info>false</info> を返します。

<comment>See Also:</comment>
   * SplFileObject::current
   * SplFileObject::key
   * SplFileObject::seek
   * SplFileObject::next
   * SplFileObject::rewind


id: SplFixedArray
type: class
doc:
<comment>Description:</comment>
  SplFixedArray クラスは配列の主要な機能を提供します。 SplFixedArray と通常の PHP の配列との主な違い
  は、 SplFixedArray は手動でリサイズしなければならないことと、 整数値で指定した範囲内の添字しか使用
  できないところです。 これにより、標準の <info>array</info> よりメモリ消費が少なくて済みます。


id: SplFixedArray::__construct
type: function
doc:
<comment>Description:</comment>
  新しい固定長配列を作成する
  
  新しい固定長配列を作成します。要素の数は <strong>$size</strong> と等しく、値はすべて <info>null</info> となります。

<comment>Param:</comment>
  <info>int</info>  <strong>$size</strong>  固定長配列のサイズ。 <return>0</return> から <info>PHP_INT_MAX</info> までの数を指定します。


id: SplFixedArray::__serialize
type: function
doc:
<comment>Description:</comment>
  SplFixedArray オブジェクトをシリアライズする
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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


id: SplFixedArray::__unserialize
type: function
doc:
<comment>Description:</comment>
  data パラメータを SplFixedArray オブジェクトに復元する
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>array</info>  <strong>$data</strong>  アンシリアライズする値

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


id: SplFixedArray::__wakeup
type: function
doc:
<comment>Description:</comment>
  アンシリアライズ後に配列を再初期化する
  
  アンシリアライズ後に配列を再初期化します。

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


id: SplFixedArray::count
type: function
doc:
<comment>Description:</comment>
  配列のサイズを返す
  
  配列のサイズを返します。

<comment>Return:</comment>
  <info>int</info>  配列のサイズを返します。

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


id: SplFixedArray::current
type: function
doc:
<comment>Description:</comment>
  現在の配列の要素を返す
  
  現在の配列の要素を取得します。

<comment>Return:</comment>
  <info>mixed</info>  現在の要素の値を返します。


id: SplFixedArray::fromArray
type: function
doc:
<comment>Description:</comment>
  PHP の配列を SplFixedArray インスタンスにインポートする
  
  PHP の配列 <strong>$array</strong> を、新しい <class>SplFixedArray</class> インスタンスにインポートします。

<comment>Param:</comment>
  <info>array</info>  <strong>$array</strong>         インポートする配列。
  <info>bool</info>   <strong>$preserveKeys</strong>  元の配列で使っている数値添字を保存しようと試みる。

<comment>Return:</comment>
  <info>SplFixedArray</info>  配列の中身を含む <class>SplFixedArray</class>  のインスタンスを返します。


id: SplFixedArray::getIterator
type: function
doc:
<comment>Description:</comment>
  配列を走査するためのイテレータを取得する
  
  配列を走査するためのイテレータを取得します。

<comment>Return:</comment>
  <info>Iterator</info>  配列を走査するための <class>Iterator</class> を実装した、オブジェクトのインスタンスを返します。


id: SplFixedArray::getSize
type: function
doc:
<comment>Description:</comment>
  配列のサイズを取得する
  
  配列のサイズを取得します。

<comment>Return:</comment>
  <info>int</info>  配列のサイズを <info>int</info> で返します。

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


id: SplFixedArray::jsonSerialize
type: function
doc:
<comment>Description:</comment>
  JSON に変換可能な値の表現を返す
  
  <strong>json_encode()</strong> でネイティブにシリアライズ可能な値に、 配列をシリアライズします。

<comment>Return:</comment>
  <info>mixed</info>  <strong>json_encode()</strong> でシリアライズ可能な配列データを返します。 これは リソース 以外のあらゆる型の
         値になります。


id: SplFixedArray::key
type: function
doc:
<comment>Description:</comment>
  現在の配列の添字を返す
  
  現在の配列の添字を返します。

<comment>Return:</comment>
  <info>int</info>  現在の配列の添字を返します。


id: SplFixedArray::next
type: function
doc:
<comment>Description:</comment>
  次のエントリに進む
  
  イテレータを、次の配列の要素に進めます。

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


id: SplFixedArray::offsetExists
type: function
doc:
<comment>Description:</comment>
  指定した添字が存在するかどうかを返す
  
  <strong>$index</strong> で指定した添字が存在するかどうかを返します。

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  調べたい添字。

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


id: SplFixedArray::offsetGet
type: function
doc:
<comment>Description:</comment>
  指定した添字の値を返す
  
  <strong>$index</strong> で指定した添字の値を返します。

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  値を取得したい添字。

<comment>Return:</comment>
  <info>mixed</info>  <strong>$index</strong> で指定した添字の値を返します。


id: SplFixedArray::offsetSet
type: function
doc:
<comment>Description:</comment>
  指定した添字の新しい値を設定する
  
  <strong>$index</strong> で指定した添字の値を <strong>$value</strong> に設定します。

<comment>Param:</comment>
  <info>int</info>    <strong>$index</strong>  設定したい添字。
  <info>mixed</info>  <strong>$value</strong>  <strong>$index</strong> の新しい値。

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


id: SplFixedArray::offsetUnset
type: function
doc:
<comment>Description:</comment>
  指定した添字の値を消去する
  
  指定した添字の値を消去します。

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  消去したい添字。

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


id: SplFixedArray::setSize
type: function
doc:
<comment>Description:</comment>
  配列のサイズを変更する
  
  配列のサイズを、新しい値 <strong>$size</strong> に変更します。 <strong>$size</strong> が現在の配列のサイズより小さい場合は、 入りき
  らなかったそれ以降の値は破棄されます。 <strong>$size</strong> が現在の配列のサイズより大きい場合は、 増えた要素の値
  は <info>null</info> となります。

<comment>Param:</comment>
  <info>int</info>  <strong>$size</strong>  新しい配列のサイズ。 <return>0</return> から <info>PHP_INT_MAX</info> までの数を指定します。

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


id: SplFixedArray::toArray
type: function
doc:
<comment>Description:</comment>
  固定長配列から PHP の配列を返す
  
  固定長配列から PHP の配列を返します。

<comment>Return:</comment>
  <info>array</info>  固定長配列と同じ内容の PHP の配列を返します。


id: SplFixedArray::valid
type: function
doc:
<comment>Description:</comment>
  配列にまだ要素があるかどうかを調べる
  
  配列にまだ要素があるかどうかを調べます。

<comment>Return:</comment>
  <info>bool</info>  配列にまだ要素がある場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。


id: SplHeap::compare
type: function
doc:
<comment>Description:</comment>
  要素を比較し、ヒープ内の適切な位置に置く
  
  <strong>$value1</strong> と <strong>$value2</strong> を比較します。
  
  SplHeap::compare 内で例外がスローされると、ヒープが壊れてしまいブロックされた状態になることがあり
  ます。 SplHeap::recoverFromCorruption をコールすればブロック状態を解除することができます。 しか
  し、適切な場所に配置されていない要素が出てくることもあり、 ヒープの性質が失われてしまいます。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value1</strong>  比較したい最初のノード。
  <info>mixed</info>  <strong>$value2</strong>  比較したい 2 番目のノード。

<comment>Return:</comment>
  <info>int</info>  比較結果を返します。<strong>$value1</strong> が <strong>$value2</strong> より大きい場合は正の整数値、等しい場合は 0、 小さい場
       合は負の整数値となります。
       
       同一の値を持つ複数の要素をヒープ内に保持することはおすすめしません。 そうすると、ヒープ内の相
       対位置がはっきりしなくなってしまいます。


id: SplHeap::count
type: function
doc:
<comment>Description:</comment>
  ヒープ内の要素数を数える

<comment>Return:</comment>
  <info>int</info>  ヒープ内の要素数を返します。


id: SplHeap::current
type: function
doc:
<comment>Description:</comment>
  イテレータが指す現在のノードを返す
  
  現在のノードを取得します。

<comment>Return:</comment>
  <info>mixed</info>  現在のノードの値を返します。


id: SplHeap::extract
type: function
doc:
<comment>Description:</comment>
  ヒープの先頭からノードを取り出す

<comment>Return:</comment>
  <info>mixed</info>  取り出したノードの値を返します。


id: SplHeap::insert
type: function
doc:
<comment>Description:</comment>
  ヒープに要素を挿入する
  
  <strong>$value</strong> をヒープに挿入します。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  挿入する値。

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


id: SplHeap::isCorrupted
type: function
doc:
<comment>Description:</comment>
  ヒープが壊れているかを調べる

<comment>Return:</comment>
  <info>bool</info>  ヒープが壊れていたら <info>true</info> を、そうでなければ <info>false</info> を返します。


id: SplHeap::isEmpty
type: function
doc:
<comment>Description:</comment>
  ヒープが空かどうかを調べる

<comment>Return:</comment>
  <info>bool</info>  ヒープが空かどうかを返します。


id: SplHeap::key
type: function
doc:
<comment>Description:</comment>
  現在のノードのインデックスを返す
  
  この関数は、現在のノードのインデックスを返します。

<comment>Return:</comment>
  <info>int</info>  現在のノードのインデックスを返します。


id: SplHeap::next
type: function
doc:
<comment>Description:</comment>
  次のノードに移動する
  
  次のノードに移動します。これは、ヒープの先頭のノードを削除します。

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


id: SplHeap::recoverFromCorruption
type: function
doc:
<comment>Description:</comment>
  破壊されたヒープを復旧し、それ以降の操作をできるようにする

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


id: SplHeap::rewind
type: function
doc:
<comment>Description:</comment>
  イテレータを先頭に巻き戻す (何もしない)
  
  これは、イテレータを先頭に巻き戻します。ヒープの場合は何もしません。 というのもイテレータは仮想的
  なものであり、 実際はヒープの先頭から動くことがないからです。

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


id: SplHeap::top
type: function
doc:
<comment>Description:</comment>
  ヒープの先頭のノードを取り出す

<comment>Return:</comment>
  <info>mixed</info>  先頭のノードの値を返します。


id: SplHeap::valid
type: function
doc:
<comment>Description:</comment>
  ヒープにまだノードがあるかどうかを調べる
  
  ヒープにまだノードがあるかどうかを調べます。

<comment>Return:</comment>
  <info>bool</info>  ヒープにまだノードが含まれる場合に <info>true</info>、 そうでない場合に <info>false</info> を返します。


id: SplMaxHeap::compare
type: function
doc:
<comment>Description:</comment>
  要素を比較し、ヒープ内の適切な位置に置く
  
  <strong>$value1</strong> と <strong>$value2</strong> を比較します。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value1</strong>  比較したい最初のノード。
  <info>mixed</info>  <strong>$value2</strong>  比較したい 2 番目のノード。

<comment>Return:</comment>
  <info>int</info>  比較結果を返します。<strong>$value1</strong> が <strong>$value2</strong> より大きい場合は正の整数値、等しい場合は 0、 小さい場
       合は負の整数値となります。
       
       同一の値を持つ複数の要素をヒープ内に保持することはおすすめしません。 そうすると、ヒープ内の相
       対位置がはっきりしなくなってしまいます。


id: SplObjectStorage
type: class
doc:
<comment>Description:</comment>
  SplObjectStorage クラスは、オブジェクトをデータに対応させたり、 データを渡さずオブジェクトセットと
  して使用したりします。 これらはどちらも、オブジェクトを一意に特定したい場合に便利です。


id: SplObjectStorage::addAll
type: function
doc:
<comment>Description:</comment>
  別のストレージからすべてのオブジェクトを追加する
  
  別のストレージにあるすべてのオブジェクトとデータのペアを、 現在のストレージに追加します。

<comment>Param:</comment>
  <info>SplObjectStorage</info>  <strong>$storage</strong>  インポートしたいストレージ。

<comment>Return:</comment>
  <info>int</info>  ストレージにあるオブジェクトの数を返します。

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


id: SplObjectStorage::attach
type: function
doc:
<comment>Description:</comment>
  オブジェクトをストレージに追加する
  
  オブジェクトをストレージに追加し、 オプションでそれを何らかのデータに関連づけます。

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  追加したいオブジェクト。
  <info>mixed</info>   <strong>$info</strong>    <info>object</info> に関連づけるデータ。

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

<comment>See Also:</comment>
   * SplObjectStorage::detach
   * SplObjectStorage::offsetSet


id: SplObjectStorage::contains
type: function
doc:
<comment>Description:</comment>
  ストレージに特定のオブジェクトが含まれるかどうかを調べる
  
  指定したオブジェクトがストレージに含まれるかどうかを調べます。

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  探したいオブジェクト。

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

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


id: SplObjectStorage::count
type: function
doc:
<comment>Description:</comment>
  ストレージ内のオブジェクトの数を返す
  
  ストレージ内のオブジェクトの数を数えます。

<comment>Param:</comment>
  <info>int</info>  <strong>$mode</strong>  オプションの <strong>$mode</strong> 引数が <info>COUNT_RECURSIVE</info> (または 1) に設定された場合、
              <strong>SplObjectStorage::count()</strong> は再帰的にストレージを操作して数えます。

<comment>Return:</comment>
  <info>int</info>  ストレージ内のオブジェクトの数を返します。

<comment>See Also:</comment>
   * SplObjectStorage::attach
   * SplObjectStorage::detach


id: SplObjectStorage::current
type: function
doc:
<comment>Description:</comment>
  現在のストレージの要素を返す
  
  現在のストレージの要素を返します。

<comment>Return:</comment>
  <info>object</info>  現在のイテレータの位置にあるオブジェクトを返します。

<comment>See Also:</comment>
   * SplObjectStorage::rewind
   * SplObjectStorage::key
   * SplObjectStorage::next
   * SplObjectStorage::valid
   * SplObjectStorage::getInfo


id: SplObjectStorage::detach
type: function
doc:
<comment>Description:</comment>
  オブジェクトをストレージから取り除く
  
  オブジェクトをストレージから取り除きます。

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  取り除きたいオブジェクト。

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

<comment>See Also:</comment>
   * SplObjectStorage::attach
   * SplObjectStorage::removeAll


id: SplObjectStorage::getHash
type: function
doc:
<comment>Description:</comment>
  中に含むオブジェクトの一意な識別子を算出する
    
  
  このメソッドは、<class>SplObjectStorage</class> オブジェクトに追加されたオブジェクトの識別子を算出します。
  
  <class>SplObjectStorage</class> の実装では、 <strong>spl_object_hash()</strong> と同じ値を返します。
  
  ストレージオブジェクトには、同じ識別子のオブジェクトを複数格納することはできません。 それを利用し
  て、セット (一意な値のコレクション) を実装するのにも使えます。 オブジェクトが一意であるという性質
  は、この関数の返す値が一意であるということで実現できます。

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  識別子を算出したいオブジェクト。

<comment>Return:</comment>
  <info>string</info>  算出した識別子を文字列で返します。

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


id: SplObjectStorage::getInfo
type: function
doc:
<comment>Description:</comment>
  イテレータの現在のエントリに関連づけられたデータを返す
  
  イテレータの現在の位置が指すオブジェクトに関連づけられたデータあるいは情報を返します。

<comment>Return:</comment>
  <info>mixed</info>  イテレータの現在の位置に関連づけられたデータを返します。

<comment>See Also:</comment>
   * SplObjectStorage::current
   * SplObjectStorage::rewind
   * SplObjectStorage::key
   * SplObjectStorage::next
   * SplObjectStorage::valid
   * SplObjectStorage::setInfo


id: SplObjectStorage::key
type: function
doc:
<comment>Description:</comment>
  イテレータの現在位置を返す
  
  イテレータの現在位置を返します。

<comment>Return:</comment>
  <info>int</info>  イテレータの現在位置に対応するインデックスを返します。

<comment>See Also:</comment>
   * SplObjectStorage::rewind
   * SplObjectStorage::current
   * SplObjectStorage::next
   * SplObjectStorage::valid


id: SplObjectStorage::next
type: function
doc:
<comment>Description:</comment>
  次のエントリに移動する
  
  イテレータを、ストレージ内の次のオブジェクトに移動します。

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

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


id: SplObjectStorage::offsetExists
type: function
doc:
<comment>Description:</comment>
  オブジェクトがストレージ内に存在するかどうかを調べる
  
  オブジェクトがストレージ内に存在するかどうかを調べます。
  
  SplObjectStorage::offsetExists は、SplObjectStorage::contains のエイリアスです。

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  探したいオブジェクト。

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

<comment>See Also:</comment>
   * SplObjectStorage::offsetSet
   * SplObjectStorage::offsetGet
   * SplObjectStorage::offsetUnset


id: SplObjectStorage::offsetGet
type: function
doc:
<comment>Description:</comment>
  オブジェクトに関連づけられたデータを返す
  
  ストレージ内のオブジェクトに関連づけられたデータを返します。

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  探したいオブジェクト。

<comment>Return:</comment>
  <info>mixed</info>  ストレージ内のオブジェクトに関連づけられたデータを返します。

<comment>See Also:</comment>
   * SplObjectStorage::offsetSet
   * SplObjectStorage::offsetExists
   * SplObjectStorage::offsetUnset


id: SplObjectStorage::offsetSet
type: function
doc:
<comment>Description:</comment>
  ストレージ内のオブジェクトにデータを関連づける
  
  ストレージ内のオブジェクトにデータを関連づけます。
  
  SplObjectStorage::offsetSet は、 SplObjectStorage::attach のエイリアスです。

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  データを関連づけたいオブジェクト。
  <info>mixed</info>   <strong>$info</strong>    <info>object</info> に関連づけるデータ。

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

<comment>See Also:</comment>
   * SplObjectStorage::attach
   * SplObjectStorage::offsetGet
   * SplObjectStorage::offsetExists
   * SplObjectStorage::offsetUnset


id: SplObjectStorage::offsetUnset
type: function
doc:
<comment>Description:</comment>
  ストレージからオブジェクトを取り除く
  
  ストレージからオブジェクトを取り除きます。
  
  SplObjectStorage::offsetUnset は、 SplObjectStorage::detach のエイリアスです。

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  取り除きたいオブジェクト。

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

<comment>See Also:</comment>
   * SplObjectStorage::offsetGet
   * SplObjectStorage::offsetSet
   * SplObjectStorage::offsetExists


id: SplObjectStorage::removeAll
type: function
doc:
<comment>Description:</comment>
  別のストレージに含まれているオブジェクトを現在のストレージから取り除く
  
  別のストレージに含まれているオブジェクトを現在のストレージから取り除きます。

<comment>Param:</comment>
  <info>SplObjectStorage</info>  <strong>$storage</strong>  取り除きたい要素を含むストレージ。

<comment>Return:</comment>
  <info>int</info>  取り除かれた後に残ったオブジェクトの数を返します。

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


id: SplObjectStorage::removeAllExcept
type: function
doc:
<comment>Description:</comment>
  別のストレージに含まれているもの以外のすべてのオブジェクトを現在のストレージから取り除く
  
  別のストレージに含まれているもの以外のすべてのオブジェクトを現在のストレージから取り除きます。

<comment>Param:</comment>
  <info>SplObjectStorage</info>  <strong>$storage</strong>  現在のストレージに残しておきたい要素を含むストレージ。

<comment>Return:</comment>
  <info>int</info>  取り除かれた後に残ったオブジェクトの数を返します。


id: SplObjectStorage::rewind
type: function
doc:
<comment>Description:</comment>
  イテレータをストレージの最初の要素に巻き戻す
  
  イテレータをストレージの最初の要素に巻き戻します。

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

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


id: SplObjectStorage::serialize
type: function
doc:
<comment>Description:</comment>
  ストレージをシリアライズする
  
  ストレージの文字列表現を返します。

<comment>Return:</comment>
  <info>string</info>  ストレージの文字列表現を返します。

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


id: SplObjectStorage::setInfo
type: function
doc:
<comment>Description:</comment>
  イテレータの現在のエントリに関連づけるデータを設定する
  
  イテレータが現在指しているオブジェクトにデータあるいは情報を関連づけます。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$info</strong>  現在のイテレータのエントリに関連づけるデータ。

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

<comment>See Also:</comment>
   * SplObjectStorage::current
   * SplObjectStorage::rewind
   * SplObjectStorage::key
   * SplObjectStorage::next
   * SplObjectStorage::valid
   * SplObjectStorage::getInfo


id: SplObjectStorage::unserialize
type: function
doc:
<comment>Description:</comment>
  ストレージの文字列表現をアンシリアライズする
  
  ストレージのエントリをアンシリアライズし、現在のストレージに追加します。

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  ストレージをシリアライズしたもの。

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

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


id: SplObjectStorage::valid
type: function
doc:
<comment>Description:</comment>
  イテレータの現在のエントリが有効かどうかを返す
  
  イテレータの現在のエントリが有効かどうかを返します。

<comment>Return:</comment>
  <info>bool</info>  イテレータのエントリが有効な場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * SplObjectStorage::current
   * SplObjectStorage::getInfo


id: SplObserver
type: class
doc:
<comment>Description:</comment>
  <class>SplObserver</class> インターフェイスを <class>SplSubject</class> とともに使うと、Observer パターンを実装することができま
  す。


id: SplObserver::update
type: function
doc:
<comment>Description:</comment>
  subject の更新を受信する
  
  このメソッドは、オブザーバがアタッチされている任意の <class>SplSubject</class> が SplSubject::notify をコールした
  ときにコールされます。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>SplSubject</info>  <strong>$subject</strong>  observer に更新を通知する <class>SplSubject</class>。

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


id: SplPriorityQueue
type: class
doc:
<comment>Description:</comment>
  SplPriorityQueue クラスは、優先順位つきキューの主要な機能を提供します。 最大ヒープを使用して実装し
  ています。
  
  優先度が等しい要素の順番は 未定義 です。 優先度が等しい要素の順序は、挿入された順序と異なるかもし
  れません。


id: SplPriorityQueue::compare
type: function
doc:
<comment>Description:</comment>
  要素の優先順位を比較し、ヒープ内の適切な位置に置く
  
  <strong>$priority1</strong> と <strong>$priority2</strong> を比較します。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$priority1</strong>  比較したい最初のノードの優先順位。
  <info>mixed</info>  <strong>$priority2</strong>  比較したい 2 番目のノードの優先順位。

<comment>Return:</comment>
  <info>int</info>  比較結果を返します。<strong>$priority1</strong> が <strong>$priority2</strong> より大きい場合は正の整数値、等しい場合は 0、 小
       さい場合は負の整数値となります。
       
       同一の優先順位の要素が複数存在する場合は、 キューから取り出す際の順序が不定となります。


id: SplPriorityQueue::count
type: function
doc:
<comment>Description:</comment>
  キュー内の要素数を数える

<comment>Return:</comment>
  <info>int</info>  キュー内の要素数を返します。


id: SplPriorityQueue::current
type: function
doc:
<comment>Description:</comment>
  イテレータが指す現在のノードを返す
  
  現在のノードを取得します。

<comment>Return:</comment>
  <info>mixed</info>  現在のノードの値あるいは優先順位 (あるいはその両方) を、抽出フラグの設定に応じて返します。


id: SplPriorityQueue::extract
type: function
doc:
<comment>Description:</comment>
  ヒープの先頭からノードを取り出す

<comment>Return:</comment>
  <info>mixed</info>  取り出したノードの値あるいは優先順位 (あるいはその両方) を、抽出フラグの設定に応じて返しま
         す。


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

<comment>Return:</comment>
  <info>int</info>  展開時のフラグを返します。


id: SplPriorityQueue::insert
type: function
doc:
<comment>Description:</comment>
  キューに要素を挿入する
  
  <strong>$value</strong> を優先順位 <strong>$priority</strong> でキューに挿入します。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>     挿入する値。
  <info>mixed</info>  <strong>$priority</strong>  関連づける優先順位。

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


id: SplPriorityQueue::isCorrupted
type: function
doc:
<comment>Description:</comment>
  優先度付きキューが壊れているかを調べる

<comment>Return:</comment>
  <info>bool</info>  優先度付きキューが壊れていたら <info>true</info> を、そうでなければ <info>false</info> を返します。


id: SplPriorityQueue::isEmpty
type: function
doc:
<comment>Description:</comment>
  キューが空かどうかを調べる

<comment>Return:</comment>
  <info>bool</info>  キューが空かどうかを返します。


id: SplPriorityQueue::next
type: function
doc:
<comment>Description:</comment>
  次のノードに移動する
  
  キューから先頭のノードを取り出します。

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


id: SplPriorityQueue::recoverFromCorruption
type: function
doc:
<comment>Description:</comment>
  破壊されたキューを復旧し、それ以降の操作をできるようにする

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


id: SplPriorityQueue::setExtractFlags
type: function
doc:
<comment>Description:</comment>
  取り出しモードを設定する

<comment>Param:</comment>
  <info>int</info>  <strong>$flags</strong>  何を取り出すのかを SplPriorityQueue::current、 SplPriorityQueue::top および
               SplPriorityQueue::extract で指定します。
               
               <info>SplPriorityQueue::EXTR_DATA</info> (0x00000001): データを取り出す
               
               <info>SplPriorityQueue::EXTR_PRIORITY</info> (0x00000002): 優先順位を取り出す
               
               <info>SplPriorityQueue::EXTR_BOTH</info> (0x00000003): 両方を含む配列を取り出す
               
               デフォルトのモードは <info>SplPriorityQueue::EXTR_DATA</info> です。

<comment>Return:</comment>
  <info>int</info>  取り出す際のフラグを返します。


id: SplPriorityQueue::top
type: function
doc:
<comment>Description:</comment>
  キューの先頭のノードを取り出す

<comment>Return:</comment>
  <info>mixed</info>  先頭のノードの値あるいは優先順位 (あるいはその両方) を、抽出フラグの設定に応じて返します。


id: SplPriorityQueue::valid
type: function
doc:
<comment>Description:</comment>
  キューにまだノードがあるかどうかを調べる
  
  キューにまだノードがあるかどうかを調べます。

<comment>Return:</comment>
  <info>bool</info>  キューにまだノードが含まれる場合に <info>true</info>、 そうでない場合に <info>false</info> を返します。


id: SplQueue
type: class
doc:
<comment>Description:</comment>
  SplQueue クラスは、キューの主要な機能を提供します。 双方向リンクリストのイテレータのモードを
  <info>SplDoublyLinkedList::IT_MODE_FIFO</info> に設定することで実装しています。


id: SplQueue::dequeue
type: function
doc:
<comment>Description:</comment>
  キューからノードを取り出す
  
  <strong>$value</strong> をキューの先頭から取り出します。
  
  SplQueue::dequeue は SplDoublyLinkedList::shift のエイリアスです。

<comment>Return:</comment>
  <info>mixed</info>  キューから取り出したノードの値を返します。


id: SplQueue::enqueue
type: function
doc:
<comment>Description:</comment>
  要素をキューに追加する
  
  <strong>$value</strong> をキューの末尾に追加します。
  
  SplQueue::enqueue は SplDoublyLinkedList::push のエイリアスです。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  キューに追加する値。

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


id: SplStack
type: class
doc:
<comment>Description:</comment>
  SplStack クラスは、スタックの主要な機能を提供します。 双方向リンクリストのイテレータのモードを
  <info>SplDoublyLinkedList::IT_MODE_LIFO</info> に設定することで実装しています。


id: SplSubject
type: class
doc:
<comment>Description:</comment>
  <class>SplSubject</class> インターフェイスを <class>SplObserver</class> とともに使うと、Observer パターンを実装することができま
  す。


id: SplSubject::attach
type: function
doc:
<comment>Description:</comment>
  SplObserver をアタッチする
  
  <class>SplObserver</class> にアタッチし、更新を通知できるようにします。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>SplObserver</info>  <strong>$observer</strong>  アタッチする <class>SplObserver</class>。

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


id: SplSubject::detach
type: function
doc:
<comment>Description:</comment>
  observer をデタッチする
  
  observer をデタッチし、更新を通知しないようにします。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>SplObserver</info>  <strong>$observer</strong>  デタッチする <class>SplObserver</class>。

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


id: SplSubject::notify
type: function
doc:
<comment>Description:</comment>
  observer に通知する
  
  アタッチされたすべての observer に通知します。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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


id: SplTempFileObject::__construct
type: function
doc:
<comment>Description:</comment>
  新しい一時ファイルオブジェクトを作成する
  
  新しい一時ファイルオブジェクトを作成します。

<comment>Param:</comment>
  <info>int</info>  <strong>$maxMemory</strong>  一時ファイルに使うメモリの最大量(バイト単位、デフォルトは 2 MB)。  一時ファイルが
                   このサイズを越える場合、ファイルはシステムの一時ディレクトリに移動させられます。
                   
                   <strong>$maxMemory</strong> が負の値である場合、 メモリだけが使われます。<strong>$maxMemory</strong> がゼロの場合、
                   メモリは使われません。

<comment>See Also:</comment>
   * <class>SplFileObject</class>
   * PHP 入出力ストリーム 
     (<return>php://temp</return> および <return>php://memory</return> について)
    


id: Spoofchecker
type: class
doc:
<comment>Description:</comment>
  Unicode は非常にたくさんの文字と、 世界中の様々な表記体系を含んでいます。 そのため使い方を誤ると、
  文字の類似性を利用して、 プログラムやシステムに対するセキュリティ攻撃が成立する可能性があります。
  そのため、このクラスが提供されています。
  
  このクラスのメソッドを使うと、 個別の文字列が、文字の読み手を混乱させようとしている可能性があるか
  をチェック(<return>spoof detection</return>)できます。 たとえば、キリル文字の 'а' が混じった "pаypаl" のような文字
  列のようなものをチェックできます。


id: Spoofchecker::areConfusable
type: function
doc:
<comment>Description:</comment>
  指定された文字列が、読み手を混乱させうるかをチェックする
  
  ふたつの指定された文字列が、間違いやすいものかをチェックします。

<comment>Param:</comment>
  <info>string</info>  <strong>$string1</strong>    チェックするひとつめの文字列。
  <info>string</info>  <strong>$string2</strong>    チェックするふたつめの文字列。
  <info>int</info>     <strong>$errorCode</strong>  整数のリファレンスを設定します。 エラーがあった場合には、 エラーコード値を含み
                      ます。

<comment>Return:</comment>
  <info>bool</info>  ふたつの指定された文字列が、間違いやすいものであれば <info>true</info> を、 そうでない場合は <info>false</info> を返し
        ます。


id: Spoofchecker::isSuspicious
type: function
doc:
<comment>Description:</comment>
  指定されたテキストに、疑わしい文字が含まれていないかをチェックする
  
  指定された文字列に、見た目は殆ど同じように見えるが、 Unicode 文字的には異なる、疑わしい文字が含ま
  れているかを調べます。

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>     調べる文字列
  <info>int</info>     <strong>$errorCode</strong>  整数のリファレンスを設定します。 エラーがあった場合には、 エラーコード値を含み
                      ます。

<comment>Return:</comment>
  <info>bool</info>  疑わしい文字が含まれている場合は <info>true</info> を、 そうでない場合は <info>false</info> を返します。


id: Spoofchecker::setAllowedLocales
type: function
doc:
<comment>Description:</comment>
  チェック時に使うロケールを設定する
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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

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


id: Spoofchecker::setChecks
type: function
doc:
<comment>Description:</comment>
  実行するチェックを設定する
  
  SpoofChecker::isSuspicious で行われるチェックの種類を設定します。

<comment>Param:</comment>
  <info>int</info>  <strong>$checks</strong>  SpoofChecker::isSuspicious で行われるチェック。 以下からなるビットマスクの組み合わせ
                です。 <info>Spoofchecker::SINGLE_SCRIPT_CONFUSABLE</info>,
                <info>Spoofchecker::MIXED_SCRIPT_CONFUSABLE</info>, <info>Spoofchecker::WHOLE_SCRIPT_CONFUSABLE</info>,
                <info>Spoofchecker::ANY_CASE</info>, <info>Spoofchecker::SINGLE_SCRIPT</info>, <info>Spoofchecker::INVISIBLE</info>,
                <info>Spoofchecker::CHAR_LIMIT</info>。 ICU 58 以降では、デフォルトで全てのチェックが設定されま
                す。 それより前のバージョンでは、全てのチェックから <info>Spoofchecker::SINGLE_SCRIPT</info> が除
                外されていました。

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


id: Spoofchecker::setRestrictionLevel
type: function
doc:
<comment>Description:</comment>
  制限レベルを設定する
  
  SpoofChecker::isSuspicious の制限レベルを設定します。

<comment>Param:</comment>
  <info>int</info>  <strong>$level</strong>  SpoofChecker::isSuspicious の制限レベル。 以下のうちひとつを指定します:
               <info>Spoofchecker::ASCII</info>, <info>Spoofchecker::SINGLE_SCRIPT_RESTRICTIVE</info>,
               <info>Spoofchecker::HIGHLY_RESTRICTIVE</info>, <info>Spoofchecker::MODERATELY_RESTRICTIVE</info>,
               <info>Spoofchecker::MINIMALLY_RESTRICTIVE</info>, <info>Spoofchecker::UNRESTRICTIVE</info>. デフォルトは
               <info>Spoofchecker::HIGHLY_RESTRICTIVE</info> です。

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


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


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

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

<comment>Return:</comment>
  <info>mysql_xdevapi\SqlStatement</info>  


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

<comment>Return:</comment>
  <info>mysql_xdevapi\Result</info>  


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

<comment>Return:</comment>
  <info>mysql_xdevapi\Result</info>  


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

<comment>Return:</comment>
  <info>mysql_xdevapi\Result</info>  


id: SqlStatement::hasMoreResults
type: function
doc:
<comment>Description:</comment>
  さらに結果があるかを調べる
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>bool</info>  結果セットがさらにフェッチするオブジェクトを持っていれば <info>true</info> を返します


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


id: SqlStatementResult::fetchAll
type: function
doc:
<comment>Description:</comment>
  結果セットから全行取得する
  
  結果セットから全ての行を取得します。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>array</info>  クエリから取得した全ての行を数値インデックスの配列として返します。 個々の要素は連想配列で
         す。行が存在しない場合は空の配列を返します。


id: SqlStatementResult::fetchOne
type: function
doc:
<comment>Description:</comment>
  単一の行を取得する
  
  結果セットから一行取得します。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>array</info>  結果を連想配列で返します。 結果がなかった場合は、<info>null</info> が返されます。


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

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


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

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


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

<comment>Return:</comment>
  <info>Array</info>  


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

<comment>Return:</comment>
  <info>int</info>  カラムの数を返します。存在しない場合は、0を返します。


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

<comment>Return:</comment>
  <info>array</info>  直近の操作で生成された _id の配列を返します。 生成された _id がなければ、空の配列を返しま
         す。


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

<comment>Return:</comment>
  <info>String</info>  最後に挿入された操作のIDを返します。


id: SqlStatementResult::getWarnings
type: function
doc:
<comment>Description:</comment>
  直近の操作から発生した警告を取得する
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>array</info>  直近の操作によって発生した警告の数を返します。 個々のオブジェクトは、エラーの 'message',
         'level' そして 'code' を定義しています。 エラーが発生しなかった場合は空の配列が返されます。


id: SqlStatementResult::getWarningsCount
type: function
doc:
<comment>Description:</comment>
  直近の操作で発生した警告の数を取得する
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>int</info>  直近のCRUD操作の間に発生した警告の数を返します。


id: SqlStatementResult::hasData
type: function
doc:
<comment>Description:</comment>
  結果がデータを持っているかを調べる
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>bool</info>  結果がデータを持っていれば <info>true</info> を返します。


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

<comment>Return:</comment>
  <info>mysql_xdevapi\Result</info>  結果セットから、次の Result オブジェクトを返します。


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


id: Statement::hasMoreResults
type: function
doc:
<comment>Description:</comment>
  さらに結果があるかを調べる
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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


id: Stomp
type: class
doc:
<comment>Description:</comment>
  Represents a connection between PHP and a Stomp compliant Message Broker.


id: Stomp::__construct
type: function
doc:
<comment>Description:</comment>
  Opens a connection
  
  オブジェクト指向型 (constructor):
  
  手続き型:
  
  Opens a connection to a stomp compliant Message Broker.

<comment>Param:</comment>
  <info>string</info>  <strong>$broker</strong>    The broker URI
  <info>string</info>  <strong>$username</strong>  The username.
  <info>string</info>  <strong>$password</strong>  The password.
  <info>array</info>   <strong>$headers</strong>   追加のヘッダ (例: receipt) を含む連想配列。

<comment>Return:</comment>
  <info>resource</info>  トランザクションヘッダを指定し、そのメッセージがトランザクションの一部であることを示しま
            す。


id: Stomp::__destruct
type: function
doc:
<comment>Description:</comment>
  Closes stomp connection
  
  オブジェクト指向型 (destructor):
  
  手続き型:
  
  Closes a previously opened connection.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>  手続き型のみ: <strong>stomp_connect()</strong> が返す stomp リンク ID。

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


id: Stomp::abort
type: function
doc:
<comment>Description:</comment>
  Rolls back a transaction in progress
  
  オブジェクト指向型 (method):
  
  手続き型:
  
  Rolls back a transaction in progress.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>            手続き型のみ: <strong>stomp_connect()</strong> が返す stomp リンク ID。
  <info>string</info>    <strong>$transaction_id</strong>  The transaction to abort.
  <info>array</info>     <strong>$headers</strong>         追加のヘッダ (例: receipt) を含む連想配列。

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


id: Stomp::ack
type: function
doc:
<comment>Description:</comment>
  Acknowledges consumption of a message
  
  オブジェクト指向型 (method):
  
  手続き型:
  
  Acknowledges consumption of a message from a subscription using client acknowledgment.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>     手続き型のみ: <strong>stomp_connect()</strong> が返す stomp リンク ID。
  <info>mixed</info>     <strong>$msg</strong>      The message/messageId to be acknowledged.
  <info>array</info>     <strong>$headers</strong>  追加のヘッダ (例: receipt) を含む連想配列。

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


id: Stomp::begin
type: function
doc:
<comment>Description:</comment>
  Starts a transaction
  
  オブジェクト指向型 (method):
  
  手続き型:
  
  Starts a transaction.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>            手続き型のみ: <strong>stomp_connect()</strong> が返す stomp リンク ID。
  <info>string</info>    <strong>$transaction_id</strong>  The transaction id.
  <info>array</info>     <strong>$headers</strong>         追加のヘッダ (例: receipt) を含む連想配列。

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


id: Stomp::commit
type: function
doc:
<comment>Description:</comment>
  Commits a transaction in progress
  
  オブジェクト指向型 (method):
  
  手続き型:
  
  Commits a transaction in progress.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>            手続き型のみ: <strong>stomp_connect()</strong> が返す stomp リンク ID。
  <info>string</info>    <strong>$transaction_id</strong>  The transaction id.
  <info>array</info>     <strong>$headers</strong>         追加のヘッダ (例: receipt) を含む連想配列。

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


id: Stomp::error
type: function
doc:
<comment>Description:</comment>
  Gets the last stomp error
  
  オブジェクト指向型 (method):
  
  手続き型:
  
  Gets the last stomp error.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>  手続き型のみ: <strong>stomp_connect()</strong> が返す stomp リンク ID。

<comment>Return:</comment>
  <info>string</info>  Returns an error string or <info>false</info> if no error occurred.


id: Stomp::getReadTimeout
type: function
doc:
<comment>Description:</comment>
  Gets read timeout
  
  オブジェクト指向型 (method):
  
  手続き型:
  
  Gets read timeout

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>  手続き型のみ: <strong>stomp_connect()</strong> が返す stomp リンク ID。

<comment>Return:</comment>
  <info>array</info>  Returns an array with 2 elements: sec and usec.


id: Stomp::getSessionId
type: function
doc:
<comment>Description:</comment>
  Gets the current stomp session ID
  
  オブジェクト指向型 (method):
  
  手続き型:
  
  Gets the current stomp session ID.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>  手続き型のみ: <strong>stomp_connect()</strong> が返す stomp リンク ID。

<comment>Return:</comment>
  <info>string|false</info>  <info>string</info> session id on success失敗した場合に <info>false</info> を返します.


id: Stomp::hasFrame
type: function
doc:
<comment>Description:</comment>
  Indicates whether or not there is a frame ready to read
  
  オブジェクト指向型 (method):
  
  手続き型:
  
  Indicates whether or not there is a frame ready to read.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>  手続き型のみ: <strong>stomp_connect()</strong> が返す stomp リンク ID。

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if a frame is ready to read, or <info>false</info> otherwise.


id: Stomp::readFrame
type: function
doc:
<comment>Description:</comment>
  Reads the next frame
  
  オブジェクト指向型 (method):
  
  手続き型:
  
  Reads the next frame. It is possible to instantiate an object of a specific class, and pass
  parameters to that class's constructor.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>        手続き型のみ: <strong>stomp_connect()</strong> が返す stomp リンク ID。
  <info>string</info>    <strong>$class_name</strong>  The name of the class to instantiate. If not specified, a stompFrame object
                         is returned.

<comment>Return:</comment>
  <info>stompframe</info>  トランザクションヘッダを指定し、そのメッセージがトランザクションの一部であることを示し
              ます。


id: Stomp::send
type: function
doc:
<comment>Description:</comment>
  Sends a message
  
  オブジェクト指向型 (method):
  
  手続き型:
  
  Sends a message to the Message Broker.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>         手続き型のみ: <strong>stomp_connect()</strong> が返す stomp リンク ID。
  <info>string</info>    <strong>$destination</strong>  Where to send the message
  <info>mixed</info>     <strong>$msg</strong>          Message to send.
  <info>array</info>     <strong>$headers</strong>      追加のヘッダ (例: receipt) を含む連想配列。

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


id: Stomp::setReadTimeout
type: function
doc:
<comment>Description:</comment>
  Sets read timeout
  
  オブジェクト指向型 (method):
  
  手続き型:
  
  Sets read timeout.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>          手続き型のみ: <strong>stomp_connect()</strong> が返す stomp リンク ID。
  <info>int</info>       <strong>$seconds</strong>       The seconds part of the timeout to be set.
  <info>int</info>       <strong>$microseconds</strong>  The microseconds part of the timeout to be set.

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


id: Stomp::subscribe
type: function
doc:
<comment>Description:</comment>
  Registers to listen to a given destination
  
  オブジェクト指向型 (method):
  
  手続き型:
  
  Registers to listen to a given destination.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>         手続き型のみ: <strong>stomp_connect()</strong> が返す stomp リンク ID。
  <info>string</info>    <strong>$destination</strong>  Destination to subscribe to.
  <info>array</info>     <strong>$headers</strong>      追加のヘッダ (例: receipt) を含む連想配列。

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


id: Stomp::unsubscribe
type: function
doc:
<comment>Description:</comment>
  Removes an existing subscription
  
  オブジェクト指向型 (method):
  
  手続き型:
  
  Removes an existing subscription.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>         手続き型のみ: <strong>stomp_connect()</strong> が返す stomp リンク ID。
  <info>string</info>    <strong>$destination</strong>  Subscription to remove.
  <info>array</info>     <strong>$headers</strong>      追加のヘッダ (例: receipt) を含む連想配列。

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


id: StompException
type: class
doc:
<comment>Description:</comment>
  Represents an error raised by the stomp extension. See Exceptions for more information about
  Exceptions in PHP.


id: StompException::getDetails
type: function
doc:
<comment>Description:</comment>
  Get exception details
  
  Get exception details.

<comment>Return:</comment>
  <info>string</info>  <info>string</info> containing the error details.


id: StompFrame
type: class
doc:
<comment>Description:</comment>
  Represents a message which was sent or received from a Stomp compliant Message Broker.


id: StompFrame::__construct
type: function
doc:
<comment>Description:</comment>
  Constructor
  
  Constructor.

<comment>Param:</comment>
  <info>string</info>  <strong>$command</strong>  Frame command
  <info>array</info>   <strong>$headers</strong>  Frame headers (<info>array</info>).
  <info>string</info>  <strong>$body</strong>     Frame body.


id: Stringable
type: class
doc:
<comment>Description:</comment>
  Stringable インターフェイスは、 特定のクラスが __toString() メソッドを実装していることを示します。
  ほとんどのインターフェイスと異なり、 Stringable は、マジックメソッド __toString() が定義されている
  あらゆるクラスで 暗黙のうちに存在すると見なされますが、 明示的に宣言することもできますし、宣言すべ
  きです。
  
  このインターフェイスの一番の存在意義は、 文字列プリミティブや、 文字列にキャストできるオブジェクト
  を受け入れる union型 <return>string|Stringable</return> に対する型チェックを、関数ができるようにすることです。


id: Stringable::__toString
type: function
doc:
<comment>Description:</comment>
  オブジェクトの文字列表現を取得する

<comment>Return:</comment>
  <info>string</info>  オブジェクトの文字列表現を返します。

<comment>See Also:</comment>
   * __toString()


id: Swoole\Async::dnsLookup
type: function
doc:
<comment>Description:</comment>
  Async and non-blocking hostname to IP lookup.
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>string</info>    <strong>$hostname</strong>  The host name.
  <info>callable</info>  <strong>$callback</strong>  The host name.
                       
                       The IP address.
  <info>string</info>    <strong>$hostname</strong>  The host name.
  <info></info>          <strong>$IP</strong>        The IP address.

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


id: Swoole\Async::read
type: function
doc:
<comment>Description:</comment>
  Read file stream asynchronously.

<comment>Param:</comment>
  <info>string</info>    <strong>$filename</strong>    The name of the file.
  <info>callable</info>  <strong>$callback</strong>    The name of the file.
                         
                         The content readed from the file stream.
  <info>string</info>    <strong>$filename</strong>    The name of the file.
  <info>string</info>    <strong>$content</strong>     The content readed from the file stream.
  <info>int</info>       <strong>$chunk_size</strong>  The chunk length.
  <info>int</info>       <strong>$offset</strong>      The offset.

<comment>Return:</comment>
  <info>bool</info>  Whether the read is succeed.


id: Swoole\Async::readFile
type: function
doc:
<comment>Description:</comment>
  Read a file asynchronously.

<comment>Param:</comment>
  <info>string</info>    <strong>$filename</strong>  The filename of the file being read.
  <info>callable</info>  <strong>$callback</strong>  The name of the file.
                       
                       The content readed from the file.
  <info>string</info>    <strong>$filename</strong>  The name of the file.
  <info>string</info>    <strong>$content</strong>   The content readed from the file.

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


id: Swoole\Async::set
type: function
doc:
<comment>Description:</comment>
  Update the async I/O options.

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

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


id: Swoole\Async::write
type: function
doc:
<comment>Description:</comment>
  Write data to a file stream asynchronously.

<comment>Param:</comment>
  <info>string</info>    <strong>$filename</strong>  The filename being written.
  <info>string</info>    <strong>$content</strong>   The content writing to the file.
  <info>int</info>       <strong>$offset</strong>    The offset.
  <info>callable</info>  <strong>$callback</strong>  

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


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

<comment>Param:</comment>
  <info>string</info>    <strong>$filename</strong>  The filename being written.
  <info>string</info>    <strong>$content</strong>   The content writing to the file.
  <info>callable</info>  <strong>$callback</strong>  
  <info>string</info>    <strong>$flags</strong>     

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


id: Swoole\Atomic::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a swoole atomic object.
  
  Swoole atomic object is a integer variable allows any processor to atomically test and modify.  It
  is implemented based on CPU atomic instructions. The Swoole atomic variables have to  defined
  before swoole_server-&gt;start.
  
  Compare-and-swap (CAS) is an atomic instruction used in multithreading to achieve synchronization.
  It compares the content of a memory location with a given value and, only if they are the same,
  modifies the content of that memory location to a new given value.

<comment>Param:</comment>
  <info>int</info>  <strong>$value</strong>  The value of the atomic object.


id: Swoole\Atomic::add
type: function
doc:
<comment>Description:</comment>
  Add a number to the value to the atomic object.
  
  Add a number to the value to the atomic object.

<comment>Param:</comment>
  <info>int</info>  <strong>$add_value</strong>  The value which will be added to the current value.

<comment>Return:</comment>
  <info>int</info>  The new value of the atomic object.


id: Swoole\Atomic::cmpset
type: function
doc:
<comment>Description:</comment>
  Compare and set the value of the atomic object.

<comment>Param:</comment>
  <info>int</info>  <strong>$cmp_value</strong>  The value to compare with the current value of the atomic object.
  <info>int</info>  <strong>$new_value</strong>  The value to set to the atomic object if the cmp_value is the same as the current
                   value of the atomic object.

<comment>Return:</comment>
  <info>int</info>  The new value of the atomic object.


id: Swoole\Atomic::get
type: function
doc:
<comment>Description:</comment>
  Get the current value of the atomic object.
  
  Get the current value of the atomic object.

<comment>Return:</comment>
  <info>int</info>  The current value of the atomic object.


id: Swoole\Atomic::set
type: function
doc:
<comment>Description:</comment>
  Set a new value to the atomic object.
  
  Set a new value to the atomic object.
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>int</info>  <strong>$value</strong>  The value to set to the atomic object.

<comment>Return:</comment>
  <info>int</info>  The current value of the atomic object.


id: Swoole\Atomic::sub
type: function
doc:
<comment>Description:</comment>
  Subtract a number to the value of the atomic object.
  
  Subtract a number to the value of the atomic object.

<comment>Param:</comment>
  <info>int</info>  <strong>$sub_value</strong>  The value which will be subtracted to the current value.

<comment>Return:</comment>
  <info>int</info>  The current value of the atomic object.


id: Swoole\Buffer::__construct
type: function
doc:
<comment>Description:</comment>
  Fixed size memory blocks allocation.

<comment>Param:</comment>
  <info>int</info>  <strong>$size</strong>  The size of the memory to allocate.


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

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


id: Swoole\Buffer::__toString
type: function
doc:
<comment>Description:</comment>
  Get the string value of the memory buffer.

<comment>Return:</comment>
  <info>string</info>  The string value of the memory buffer.


id: Swoole\Buffer::append
type: function
doc:
<comment>Description:</comment>
  Append the string or binary data at the end of the memory buffer and return the new size of memory
  allocated.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  The string or binary data to append at the end of the memory buffer.

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


id: Swoole\Buffer::clear
type: function
doc:
<comment>Description:</comment>
  Reset the memory buffer.

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


id: Swoole\Buffer::expand
type: function
doc:
<comment>Description:</comment>
  Expand the size of memory buffer.

<comment>Param:</comment>
  <info>int</info>  <strong>$size</strong>  The new size of the memory buffer.

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


id: Swoole\Buffer::read
type: function
doc:
<comment>Description:</comment>
  Read data from the memory buffer based on offset and length.

<comment>Param:</comment>
  <info>int</info>  <strong>$offset</strong>  The offset.
  <info>int</info>  <strong>$length</strong>  The length.

<comment>Return:</comment>
  <info>string</info>  The data readed from the memory buffer.


id: Swoole\Buffer::recycle
type: function
doc:
<comment>Description:</comment>
  Release the memory to OS which is not used by the memory buffer.

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


id: Swoole\Buffer::substr
type: function
doc:
<comment>Description:</comment>
  Read data from the memory buffer based on offset and length. Or remove data from the memory
  buffer.
  
  If $remove is set to be true and $offset is set to be 0, the data will be removed from the buffer.
  The memory for storing the data will be released when the buffer object is deconstructed.

<comment>Param:</comment>
  <info>int</info>   <strong>$offset</strong>  The offset.
  <info>int</info>   <strong>$length</strong>  The length.
  <info>bool</info>  <strong>$remove</strong>  Whether to remove the data from the memory buffer.

<comment>Return:</comment>
  <info>string</info>  The data or string readed from the memory buffer.


id: Swoole\Buffer::write
type: function
doc:
<comment>Description:</comment>
  Write data to the memory buffer. The memory allocated for the buffer will not be changed.

<comment>Param:</comment>
  <info>int</info>     <strong>$offset</strong>  The offset.
  <info>string</info>  <strong>$data</strong>    The data to write to the memory buffer.

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


id: Swoole\Channel::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a Swoole Channel
  
  Swoole channel is memory data structure works like Chan in Golang, implemented based on  shared
  memory and mutex locks. It can be used as high performance message queue in memory. Construct a
  swoole channel with a fixed size. The minimum size of a swoole channel is 64KB. Exceptions will be
  thrown if there is not enough memory.

<comment>Param:</comment>
  <info>string</info>  <strong>$size</strong>  The size of the Swoole channel.


id: Swoole\Channel::__destruct
type: function
doc:
<comment>Description:</comment>
  Destruct a Swoole channel.

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


id: Swoole\Channel::pop
type: function
doc:
<comment>Description:</comment>
  Read and pop data from swoole channel.

<comment>Return:</comment>
  <info>mixed</info>  If the channel is empty, the function will return false, or return the unserialized data.


id: Swoole\Channel::push
type: function
doc:
<comment>Description:</comment>
  Write and push data into Swoole channel.
  
  Data can be any non-empty PHP variable, the variable will be serialized if it is not string type.
  
  If size of the data is more than 8KB, swoole channel will use temp files storage.
  
  The function will return true if the write operation is succeeded, or return false if there is not
  enough space.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  The data to push into the Swoole channel.

<comment>Return:</comment>
  <info>bool</info>  Wheter the data is pushed into he Swoole channel.


id: Swoole\Channel::stats
type: function
doc:
<comment>Description:</comment>
  Get stats of swoole channel.
  
  Get the numbers of queued elements and total size of the memory used by the queue.

<comment>Return:</comment>
  <info>array</info>  The stats of the Swoole channel.


id: Swoole\Client::__construct
type: function
doc:
<comment>Description:</comment>
  Create Swoole sync or async TCP/UDP client, with or without SSL.

<comment>Param:</comment>
  <info>int</info>  <strong>$sock_type</strong>  The type of socket: SWOOLE_TCP, SWOOLE_UDP, SWOOLE_ASYNC, SWOOLE_SSL,
                   SWOOLE_KEEP.
  <info>int</info>  <strong>$is_async</strong>   Synchronous or asynchronous client.


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

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


id: Swoole\Client::close
type: function
doc:
<comment>Description:</comment>
  Close the connection established.

<comment>Param:</comment>
  <info>bool</info>  <strong>$force</strong>  Whether force to close the connection.

<comment>Return:</comment>
  <info>bool</info>  Whether the connection is closed.


id: Swoole\Client::connect
type: function
doc:
<comment>Description:</comment>
  Connect to the remote TCP or UDP port.

<comment>Param:</comment>
  <info>string</info>  <strong>$host</strong>     The host name of the remote address.
  <info>int</info>     <strong>$port</strong>     The port number of the remote address.
  <info>int</info>     <strong>$timeout</strong>  The timeout(second) of connect/send/recv, the dafault value is 0.1s
  <info>int</info>     <strong>$flag</strong>     If the type of client is UDP, the $flag means if to enable the configuration
                    udp_connect.  If the configuration udp_connect is enabled, the client will only
                    receive the data from specified ip:port. If the type of client is TCP and the
                    $flag is set to 1, it must use swoole_client_select to check the connection
                    status before send/recv.

<comment>Return:</comment>
  <info>bool</info>  Whether the connection is established.


id: Swoole\Client::getpeername
type: function
doc:
<comment>Description:</comment>
  Get the remote socket name of the connection.

<comment>Return:</comment>
  <info>array</info>  The host and port of the remote socket.


id: Swoole\Client::getsockname
type: function
doc:
<comment>Description:</comment>
  Get the local socket name of the connection.

<comment>Return:</comment>
  <info>array</info>  The host and port of the local socket.


id: Swoole\Client::isConnected
type: function
doc:
<comment>Description:</comment>
  Check if the connection is established.
  
  This method returns the connection status of application layer.

<comment>Return:</comment>
  <info>bool</info>  Whether the connection is established.


id: Swoole\Client::on
type: function
doc:
<comment>Description:</comment>
  Add callback functions triggered by events.

<comment>Param:</comment>
  <info>string</info>    <strong>$event</strong>     
  <info>callable</info>  <strong>$callback</strong>  

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


id: Swoole\Client::pause
type: function
doc:
<comment>Description:</comment>
  Pause receiving data.

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


id: Swoole\Client::pipe
type: function
doc:
<comment>Description:</comment>
  Redirect the data to another file descriptor.

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

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


id: Swoole\Client::recv
type: function
doc:
<comment>Description:</comment>
  Receive data from the remote socket.
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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

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


id: Swoole\Client::resume
type: function
doc:
<comment>Description:</comment>
  Resume receiving data.

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


id: Swoole\Client::send
type: function
doc:
<comment>Description:</comment>
  Send data to the remote TCP socket.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  The data to send which can be string or binary
  <info>string</info>  <strong>$flag</strong>  

<comment>Return:</comment>
  <info>int</info>  If the client sends data successfully, it returns the length of data sent.  Or it returns
       false and sets $swoole_client-&gt;errCode. For sync client,  there is no limit for the data
       to send. For async client, The limit  for the data to send is socket_buffer_size.


id: Swoole\Client::sendfile
type: function
doc:
<comment>Description:</comment>
  Send file to the remote TCP socket.
  
  This is a wrapper of the Linux sendfile system call.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  File path of the file to send.
  <info>int</info>     <strong>$offset</strong>    Offset of the file to send

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


id: Swoole\Client::sendto
type: function
doc:
<comment>Description:</comment>
  Send data to the remote UDP address.
  
  The swoole client should be type of SWOOLE_SOCK_UDP or SWOOLE_SOCK_UDP6.

<comment>Param:</comment>
  <info>string</info>  <strong>$ip</strong>    The IP address of remote host, IPv4 or IPv6.
  <info>int</info>     <strong>$port</strong>  The port number of remote host.
  <info>string</info>  <strong>$data</strong>  The data to send which should be less-than 64K.

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


id: Swoole\Client::set
type: function
doc:
<comment>Description:</comment>
  Set the Swoole client parameters before the connection is established.

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

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


id: Swoole\Client::sleep
type: function
doc:
<comment>Description:</comment>
  Remove the TCP client from system event loop.
  
  Remove the TCP client from system event loop.

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


id: Swoole\Client::wakeup
type: function
doc:
<comment>Description:</comment>
  Add the TCP client back into the system event loop.

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


id: Swoole\Connection\Iterator::count
type: function
doc:
<comment>Description:</comment>
  Count connections.
  
  Gets the number of connections.

<comment>Return:</comment>
  <info>int</info>  The number of connections.


id: Swoole\Connection\Iterator::current
type: function
doc:
<comment>Description:</comment>
  Return current connection entry.
  
  Get current connection entry.

<comment>Return:</comment>
  <info>Connection</info>  The current connection entry.


id: Swoole\Connection\Iterator::key
type: function
doc:
<comment>Description:</comment>
  Return key of the current connection.
  
  This function returns key of the current connection.

<comment>Return:</comment>
  <info>int</info>  Key of the current connection.


id: Swoole\Connection\Iterator::next
type: function
doc:
<comment>Description:</comment>
  Move to the next connection.
  
  The iterator to the next connection.

<comment>Return:</comment>
  <info>Connection</info>  


id: Swoole\Connection\Iterator::offsetExists
type: function
doc:
<comment>Description:</comment>
  Check if offet exists.
  
  Check if offset exists.

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  The offset being checked.

<comment>Return:</comment>
  <info>bool</info>  Returns TRUE if the offset exists, otherwise FALSE.


id: Swoole\Connection\Iterator::offsetGet
type: function
doc:
<comment>Description:</comment>
  Offset to retrieve.
  
  Return the connection at specified offset.

<comment>Param:</comment>
  <info>string</info>  <strong>$index</strong>  The offset to retrieve.

<comment>Return:</comment>
  <info>Connection</info>  


id: Swoole\Connection\Iterator::offsetSet
type: function
doc:
<comment>Description:</comment>
  Assign a Connection to the specified offset.
  
  Assign a Connection to the specified offset.

<comment>Param:</comment>
  <info>int</info>    <strong>$offset</strong>      The offset to assign the Connection to.
  <info>mixed</info>  <strong>$connection</strong>  The connection to set.

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


id: Swoole\Connection\Iterator::offsetUnset
type: function
doc:
<comment>Description:</comment>
  Unset an offset.
  
  Unsets an offset.

<comment>Param:</comment>
  <info>int</info>  <strong>$offset</strong>  The offset to unset.

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


id: Swoole\Connection\Iterator::rewind
type: function
doc:
<comment>Description:</comment>
  Rewinds iterator

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


id: Swoole\Connection\Iterator::valid
type: function
doc:
<comment>Description:</comment>
  Check if current position is valid.
  
  Checks if the current position is valid.

<comment>Return:</comment>
  <info>bool</info>  Returns TRUE if the current iterator position is valid, otherwise FALSE.


id: Swoole\Coroutine::call_user_func
type: function
doc:
<comment>Description:</comment>
  Call a callback given by the first parameter
  
  Calls the <strong>$callback</strong> given by the first parameter and passes the remaining parameters as arguments.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  The <info>callable</info> to be called.
  <info>mixed</info>     <strong>$args</strong>      Zero or more parameters to be passed to the callback.

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


id: Swoole\Coroutine::call_user_func_array
type: function
doc:
<comment>Description:</comment>
  Call a callback with an array of parameters
  
  Calls the callback given by the first parameter with the parameters in param_array.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>     The <info>callable</info> to be called.
  <info>array</info>     <strong>$param_array</strong>  Zero or more parameters in the array to be passed to the callback.

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


id: Swoole\Coroutine::cli_wait
type: function
doc:
<comment>Description:</comment>
  Description

<comment>Return:</comment>
  <info>ReturnType</info>  


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

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Event::add
type: function
doc:
<comment>Description:</comment>
  Add new callback functions of a socket into the EventLoop.

<comment>Param:</comment>
  <info>int</info>       <strong>$fd</strong>              
  <info>callable</info>  <strong>$read_callback</strong>   
  <info>callable</info>  <strong>$write_callback</strong>  
  <info>string</info>    <strong>$events</strong>          

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


id: Swoole\Event::defer
type: function
doc:
<comment>Description:</comment>
  Add a callback function to the next event loop.

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

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


id: Swoole\Event::del
type: function
doc:
<comment>Description:</comment>
  Remove all event callback functions of a socket.

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

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


id: Swoole\Event::exit
type: function
doc:
<comment>Description:</comment>
  Exit the eventloop, only available at client side.

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


id: Swoole\Event::set
type: function
doc:
<comment>Description:</comment>
  Update the event callback functions of a socket.

<comment>Param:</comment>
  <info>int</info>     <strong>$fd</strong>              
  <info>string</info>  <strong>$read_callback</strong>   
  <info>string</info>  <strong>$write_callback</strong>  
  <info>string</info>  <strong>$events</strong>          

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


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

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


id: Swoole\Event::write
type: function
doc:
<comment>Description:</comment>
  Write data to the socket.

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

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


id: Swoole\Http\Client::__construct
type: function
doc:
<comment>Description:</comment>
  Construct the async HTTP client.

<comment>Param:</comment>
  <info>string</info>  <strong>$host</strong>  The hostname of the remote host.
  <info>string</info>  <strong>$port</strong>  The port number of the remote host.
  <info>bool</info>    <strong>$ssl</strong>   Whether to enable SSL.


id: Swoole\Http\Client::__destruct
type: function
doc:
<comment>Description:</comment>
  Destruct the HTTP client.

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


id: Swoole\Http\Client::addFile
type: function
doc:
<comment>Description:</comment>
  Add a file to the post form.

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>      
  <info>string</info>  <strong>$name</strong>      
  <info>string</info>  <strong>$type</strong>      
  <info>string</info>  <strong>$filename</strong>  
  <info>string</info>  <strong>$offset</strong>    

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


id: Swoole\Http\Client::close
type: function
doc:
<comment>Description:</comment>
  Close the http connection.

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


id: Swoole\Http\Client::download
type: function
doc:
<comment>Description:</comment>
  Download a file from the remote server.

<comment>Param:</comment>
  <info>string</info>    <strong>$path</strong>      
  <info>string</info>    <strong>$file</strong>      
  <info>callable</info>  <strong>$callback</strong>  
  <info>int</info>       <strong>$offset</strong>    

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


id: Swoole\Http\Client::execute
type: function
doc:
<comment>Description:</comment>
  Send the HTTP request after setting the parameters.

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

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


id: Swoole\Http\Client::get
type: function
doc:
<comment>Description:</comment>
  Send GET http request to the remote server.

<comment>Param:</comment>
  <info>string</info>    <strong>$path</strong>      
  <info>callable</info>  <strong>$callback</strong>  

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


id: Swoole\Http\Client::isConnected
type: function
doc:
<comment>Description:</comment>
  Check if the HTTP connection is connected.

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


id: Swoole\Http\Client::on
type: function
doc:
<comment>Description:</comment>
  Register callback function by event name.

<comment>Param:</comment>
  <info>string</info>    <strong>$event_name</strong>  
  <info>callable</info>  <strong>$callback</strong>    

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


id: Swoole\Http\Client::post
type: function
doc:
<comment>Description:</comment>
  Send POST http request to the remote server.

<comment>Param:</comment>
  <info>string</info>    <strong>$path</strong>      
  <info>string</info>    <strong>$data</strong>      
  <info>callable</info>  <strong>$callback</strong>  

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


id: Swoole\Http\Client::push
type: function
doc:
<comment>Description:</comment>
  Push data to websocket client.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>    
  <info>string</info>  <strong>$opcode</strong>  
  <info>string</info>  <strong>$finish</strong>  

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


id: Swoole\Http\Client::set
type: function
doc:
<comment>Description:</comment>
  Update the HTTP client paramters.

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

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


id: Swoole\Http\Client::setCookies
type: function
doc:
<comment>Description:</comment>
  Set the http request cookies.

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

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


id: Swoole\Http\Client::setData
type: function
doc:
<comment>Description:</comment>
  Set the HTTP request body data.
  
  The HTTP method will be changed to be POST.

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

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Http\Client::setHeaders
type: function
doc:
<comment>Description:</comment>
  Set the HTTP request headers.

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

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


id: Swoole\Http\Client::setMethod
type: function
doc:
<comment>Description:</comment>
  Set the HTTP request method.

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

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


id: Swoole\Http\Client::upgrade
type: function
doc:
<comment>Description:</comment>
  Upgrade to websocket protocol.

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

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


id: Swoole\Http\Request::__destruct
type: function
doc:
<comment>Description:</comment>
  Destruct the HTTP request.

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


id: Swoole\Http\Request::rawcontent
type: function
doc:
<comment>Description:</comment>
  Get the raw HTTP POST body.
  
  This method is used for the POST data which isn't in the form of
  `application/x-www-form-urlencoded`.
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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


id: Swoole\Http\Response::__destruct
type: function
doc:
<comment>Description:</comment>
  Destruct the HTTP response.

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


id: Swoole\Http\Response::cookie
type: function
doc:
<comment>Description:</comment>
  Set the cookies of the HTTP response.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>      
  <info>string</info>  <strong>$value</strong>     
  <info>string</info>  <strong>$expires</strong>   
  <info>string</info>  <strong>$path</strong>      
  <info>string</info>  <strong>$domain</strong>    
  <info>string</info>  <strong>$secure</strong>    
  <info>string</info>  <strong>$httponly</strong>  

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


id: Swoole\Http\Response::end
type: function
doc:
<comment>Description:</comment>
  Send data for the HTTP request and finish the response.

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

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


id: Swoole\Http\Response::gzip
type: function
doc:
<comment>Description:</comment>
  Enable the gzip of response content.
  
  
  The header about Content-Encoding will be added automatically.

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

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Http\Response::header
type: function
doc:
<comment>Description:</comment>
  Set the HTTP response headers.

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

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


id: Swoole\Http\Response::initHeader
type: function
doc:
<comment>Description:</comment>
  Init the HTTP response header.
  
  Init the HTTP response header.

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Http\Response::rawcookie
type: function
doc:
<comment>Description:</comment>
  Set the raw cookies to the HTTP response.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>      
  <info>string</info>  <strong>$value</strong>     
  <info>string</info>  <strong>$expires</strong>   
  <info>string</info>  <strong>$path</strong>      
  <info>string</info>  <strong>$domain</strong>    
  <info>string</info>  <strong>$secure</strong>    
  <info>string</info>  <strong>$httponly</strong>  

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Http\Response::sendfile
type: function
doc:
<comment>Description:</comment>
  Send file through the HTTP response.
  
  Send file through the HTTP response.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  
  <info>int</info>     <strong>$offset</strong>    

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Http\Response::status
type: function
doc:
<comment>Description:</comment>
  Set the status code of the HTTP response.
  
  Set the status code of the HTTP response.

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

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Http\Response::write
type: function
doc:
<comment>Description:</comment>
  Append HTTP body content to the HTTP response.
  
  Append HTTP body content to the HTTP response.

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

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


id: Swoole\Http\Server::on
type: function
doc:
<comment>Description:</comment>
  Bind callback function to HTTP server by event name.
  
  Bind callback function to HTTP server by event name.

<comment>Param:</comment>
  <info>string</info>    <strong>$event_name</strong>  
  <info>callable</info>  <strong>$callback</strong>    

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


id: Swoole\Http\Server::start
type: function
doc:
<comment>Description:</comment>
  Start the swoole http server.
  
  Start the swoole http server.

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


id: Swoole\Lock::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a memory lock.
  
  Swoole lock is used for data synchronization between multiple theads or processes.

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


id: Swoole\Lock::__destruct
type: function
doc:
<comment>Description:</comment>
  Destory a Swoole memory lock.

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


id: Swoole\Lock::lock
type: function
doc:
<comment>Description:</comment>
  Try to acquire the lock. It will block if the lock is not available.

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


id: Swoole\Lock::lock_read
type: function
doc:
<comment>Description:</comment>
  Lock a read-write lock for reading.
  
  Lock a read-write lock for reading.

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


id: Swoole\Lock::trylock
type: function
doc:
<comment>Description:</comment>
  Try to acquire the lock and return straight away even the lock is not available.

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


id: Swoole\Lock::trylock_read
type: function
doc:
<comment>Description:</comment>
  Try to lock a read-write lock for reading and return straight away even the lock is not available.

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


id: Swoole\Lock::unlock
type: function
doc:
<comment>Description:</comment>
  Release the lock.

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


id: Swoole\Mmap::open
type: function
doc:
<comment>Description:</comment>
  Map a file into memory and return the stream resource which can be used by PHP stream operations.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  
  <info>string</info>  <strong>$size</strong>      
  <info>string</info>  <strong>$offset</strong>    

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\MySQL::__construct
type: function
doc:
<comment>Description:</comment>
  Construct an async MySQL client.
  
  Construct an async MySQL client.


id: Swoole\MySQL::__destruct
type: function
doc:
<comment>Description:</comment>
  Destory the async MySQL client.

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


id: Swoole\MySQL::close
type: function
doc:
<comment>Description:</comment>
  Close the async MySQL connection.

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


id: Swoole\MySQL::connect
type: function
doc:
<comment>Description:</comment>
  Connect to the remote MySQL server.
  
  Connect to the remote MySQL server.

<comment>Param:</comment>
  <info>array</info>     <strong>$server_config</strong>  
  <info>callable</info>  <strong>$callback</strong>       

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


id: Swoole\MySQL::on
type: function
doc:
<comment>Description:</comment>
  Register callback function based on event name.
  
  Register callback function based on event name, current only 'close' event is supported.

<comment>Param:</comment>
  <info>string</info>    <strong>$event_name</strong>  
  <info>callable</info>  <strong>$callback</strong>    

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


id: Swoole\MySQL::query
type: function
doc:
<comment>Description:</comment>
  Run the SQL query.

<comment>Param:</comment>
  <info>string</info>    <strong>$sql</strong>       
  <info>callable</info>  <strong>$callback</strong>  

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Process::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a process.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>                   
  <info>bool</info>      <strong>$redirect_stdin_and_stdout</strong>  
  <info>int</info>       <strong>$pipe_type</strong>                  


id: Swoole\Process::__destruct
type: function
doc:
<comment>Description:</comment>
  Destory the process.

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


id: Swoole\Process::alarm
type: function
doc:
<comment>Description:</comment>
  High precision timer which triggers signal with fixed interval.

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

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


id: Swoole\Process::close
type: function
doc:
<comment>Description:</comment>
  Close the pipe to the child process.
  
  Close the pipe to the child process.

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


id: Swoole\Process::daemon
type: function
doc:
<comment>Description:</comment>
  Change the process to be a daemon process.
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>bool</info>  <strong>$nochdir</strong>  
  <info>bool</info>  <strong>$noclose</strong>  

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


id: Swoole\Process::exec
type: function
doc:
<comment>Description:</comment>
  Execute system commands.
  
  The process will be replaced to be the system command process, but the pipe to the parent process
  will be kept.

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

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Process::exit
type: function
doc:
<comment>Description:</comment>
  Stop the child processes.

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

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


id: Swoole\Process::freeQueue
type: function
doc:
<comment>Description:</comment>
  Destroy the message queue created by swoole_process::useQueue.

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


id: Swoole\Process::kill
type: function
doc:
<comment>Description:</comment>
  Send signal to the child process.
  
  Send signal to the child process.

<comment>Param:</comment>
  <info>int</info>  <strong>$pid</strong>        Process pid
  <info>int</info>  <strong>$signal_no</strong>  Signal to be sent

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


id: Swoole\Process::name
type: function
doc:
<comment>Description:</comment>
  Set name of the process.

<comment>Param:</comment>
  <info>string</info>  <strong>$process_name</strong>  Set name of the process.

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


id: Swoole\Process::pop
type: function
doc:
<comment>Description:</comment>
  Read and pop data from the message queue.

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

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


id: Swoole\Process::push
type: function
doc:
<comment>Description:</comment>
  Write and push data into the message queue.

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

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


id: Swoole\Process::read
type: function
doc:
<comment>Description:</comment>
  Read data sending to the process.

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

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


id: Swoole\Process::signal
type: function
doc:
<comment>Description:</comment>
  Send signal to the child processes.

<comment>Param:</comment>
  <info>string</info>    <strong>$signal_no</strong>  
  <info>callable</info>  <strong>$callback</strong>   

<comment>Return:</comment>
  <info>void</info>  If signal sent successfully, it returns TRUE, otherwise it returns FALSE.


id: Swoole\Process::start
type: function
doc:
<comment>Description:</comment>
  Start the process.

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


id: Swoole\Process::statQueue
type: function
doc:
<comment>Description:</comment>
  Get the stats of the message queue used as the communication method between processes.

<comment>Return:</comment>
  <info>array</info>  The array of status of the message queue.


id: Swoole\Process::useQueue
type: function
doc:
<comment>Description:</comment>
  Create a message queue as the communication method between the parent process and child processes.

<comment>Param:</comment>
  <info>int</info>  <strong>$key</strong>   
  <info>int</info>  <strong>$mode</strong>  

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


id: Swoole\Process::wait
type: function
doc:
<comment>Description:</comment>
  Wait for the events of child processes.

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

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


id: Swoole\Process::write
type: function
doc:
<comment>Description:</comment>
  Write data into the pipe and communicate with the parent process or child processes.

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

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


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

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

<comment>Return:</comment>
  <info>ReturnType</info>  


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

<comment>Param:</comment>
  <info>string</info>  <strong>$command</strong>                 
  <info>string</info>  <strong>$callback</strong>                
  <info>string</info>  <strong>$number_of_string_param</strong>  
  <info>string</info>  <strong>$type_of_array_param</strong>     

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Serialize::pack
type: function
doc:
<comment>Description:</comment>
  Serialize the data.
  
  Swoole provides a fast and high performance serialization module.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>     
  <info>int</info>     <strong>$is_fast</strong>  

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Serialize::unpack
type: function
doc:
<comment>Description:</comment>
  Unserialize the data.
  
  Unserialize the data.

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

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Server::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a Swoole server.

<comment>Param:</comment>
  <info>string</info>  <strong>$host</strong>       
  <info>int</info>     <strong>$port</strong>       
  <info>integr</info>  <strong>$mode</strong>       
  <info>int</info>     <strong>$sock_type</strong>  


id: Swoole\Server::addProcess
type: function
doc:
<comment>Description:</comment>
  Add a user defined swoole_process to the server.

<comment>Param:</comment>
  <info>swoole_process</info>  <strong>$process</strong>  

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


id: Swoole\Server::addlistener
type: function
doc:
<comment>Description:</comment>
  Add a new listener to the server.

<comment>Param:</comment>
  <info>string</info>  <strong>$host</strong>         
  <info>int</info>     <strong>$port</strong>         
  <info>string</info>  <strong>$socket_type</strong>  

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


id: Swoole\Server::after
type: function
doc:
<comment>Description:</comment>
  Trigger a callback function after a period of time.

<comment>Param:</comment>
  <info>int</info>       <strong>$after_time_ms</strong>  
  <info>callable</info>  <strong>$callback</strong>       
  <info>string</info>    <strong>$param</strong>          

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Server::bind
type: function
doc:
<comment>Description:</comment>
  Bind the connection to a user defined user ID.

<comment>Param:</comment>
  <info>int</info>  <strong>$fd</strong>   
  <info>int</info>  <strong>$uid</strong>  

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


id: Swoole\Server::clearTimer
type: function
doc:
<comment>Description:</comment>
  Stop and destory a timer.
  
  オブジェクト指向型 (method):
  
  手続き型:
  
  Stop and destory a timer

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

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


id: Swoole\Server::close
type: function
doc:
<comment>Description:</comment>
  Close a connection to the client.

<comment>Param:</comment>
  <info>int</info>   <strong>$fd</strong>     
  <info>bool</info>  <strong>$reset</strong>  

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


id: Swoole\Server::confirm
type: function
doc:
<comment>Description:</comment>
  Check status of the connection.

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

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


id: Swoole\Server::connection_info
type: function
doc:
<comment>Description:</comment>
  Get the connection info by file description.

<comment>Param:</comment>
  <info>int</info>  <strong>$fd</strong>          
  <info>int</info>  <strong>$reactor_id</strong>  

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


id: Swoole\Server::connection_list
type: function
doc:
<comment>Description:</comment>
  Get all of the established connections.

<comment>Param:</comment>
  <info>int</info>  <strong>$start_fd</strong>  
  <info>int</info>  <strong>$pagesize</strong>  

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


id: Swoole\Server::defer
type: function
doc:
<comment>Description:</comment>
  Delay execution of the callback function at the end of current EventLoop.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  

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


id: Swoole\Server::exist
type: function
doc:
<comment>Description:</comment>
  Check if the connection is existed.

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

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


id: Swoole\Server::finish
type: function
doc:
<comment>Description:</comment>
  Used in task process for sending result to the worker process when the task is finished.

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

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


id: Swoole\Server::getClientInfo
type: function
doc:
<comment>Description:</comment>
  Get the connection info by file description.

<comment>Param:</comment>
  <info>int</info>   <strong>$fd</strong>            File descriptors.
  <info>int</info>   <strong>$reactor_id</strong>    The Reactor thread ID where the connection is made.
  <info>bool</info>  <strong>$ignore_error</strong>  Whether to ignore errors, if set to true, connection information will be
                       returned even if the connection is closed.

<comment>Return:</comment>
  <info>array</info>  Returns information about the client connection.


id: Swoole\Server::getClientList
type: function
doc:
<comment>Description:</comment>
  Get all of the established connections.
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>int</info>  <strong>$start_fd</strong>  
  <info>int</info>  <strong>$pagesize</strong>  

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


id: Swoole\Server::getLastError
type: function
doc:
<comment>Description:</comment>
  Get the error code of the most recent error.

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


id: Swoole\Server::heartbeat
type: function
doc:
<comment>Description:</comment>
  Check all the connections on the server.

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

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


id: Swoole\Server::listen
type: function
doc:
<comment>Description:</comment>
  Listen on the given IP and port, socket type.

<comment>Param:</comment>
  <info>string</info>  <strong>$host</strong>         
  <info>int</info>     <strong>$port</strong>         
  <info>string</info>  <strong>$socket_type</strong>  

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


id: Swoole\Server::on
type: function
doc:
<comment>Description:</comment>
  Register a callback function by event name.

<comment>Param:</comment>
  <info>string</info>    <strong>$event_name</strong>  
  <info>callable</info>  <strong>$callback</strong>    

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


id: Swoole\Server::pause
type: function
doc:
<comment>Description:</comment>
  Stop receiving data from the connection.

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

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


id: Swoole\Server::protect
type: function
doc:
<comment>Description:</comment>
  Set the connection to be protected mode.

<comment>Param:</comment>
  <info>int</info>   <strong>$fd</strong>            
  <info>bool</info>  <strong>$is_protected</strong>  

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


id: Swoole\Server::reload
type: function
doc:
<comment>Description:</comment>
  Restart all the worker process.

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


id: Swoole\Server::resume
type: function
doc:
<comment>Description:</comment>
  Start receving data from the connection.

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

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


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

<comment>Param:</comment>
  <info>int</info>     <strong>$fd</strong>          
  <info>string</info>  <strong>$data</strong>        
  <info>int</info>     <strong>$reactor_id</strong>  

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


id: Swoole\Server::sendMessage
type: function
doc:
<comment>Description:</comment>
  Send message to worker processes by ID.

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

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


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

<comment>Param:</comment>
  <info>int</info>     <strong>$fd</strong>        
  <info>string</info>  <strong>$filename</strong>  
  <info>int</info>     <strong>$offset</strong>    

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


id: Swoole\Server::sendto
type: function
doc:
<comment>Description:</comment>
  Send data to the remote UDP address.

<comment>Param:</comment>
  <info>string</info>  <strong>$ip</strong>             
  <info>int</info>     <strong>$port</strong>           
  <info>string</info>  <strong>$data</strong>           
  <info>string</info>  <strong>$server_socket</strong>  

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


id: Swoole\Server::sendwait
type: function
doc:
<comment>Description:</comment>
  Send data to the remote socket in the blocking way.
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>int</info>     <strong>$fd</strong>    
  <info>string</info>  <strong>$data</strong>  

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


id: Swoole\Server::set
type: function
doc:
<comment>Description:</comment>
  Set the runtime settings of the swoole server.
  
  Set the runtime settings of the swoole server. The settings can be accessed by $server-&gt;setting
  when the swoole server has started.

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

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Server::shutdown
type: function
doc:
<comment>Description:</comment>
  Shutdown the master server process, this function can be called in worker processes.

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


id: Swoole\Server::start
type: function
doc:
<comment>Description:</comment>
  Start the Swoole server.

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


id: Swoole\Server::stats
type: function
doc:
<comment>Description:</comment>
  Get the stats of the Swoole server.

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


id: Swoole\Server::stop
type: function
doc:
<comment>Description:</comment>
  Stop the Swoole server.

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

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


id: Swoole\Server::task
type: function
doc:
<comment>Description:</comment>
  Send data to the task worker processes.
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>string</info>    <strong>$data</strong>           
  <info>int</info>       <strong>$dst_worker_id</strong>  
  <info>callable</info>  <strong>$callback</strong>       

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


id: Swoole\Server::taskWaitMulti
type: function
doc:
<comment>Description:</comment>
  Execute multiple tasks concurrently.

<comment>Param:</comment>
  <info>array</info>  <strong>$tasks</strong>       
  <info>float</info>  <strong>$timeout_ms</strong>  

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


id: Swoole\Server::taskwait
type: function
doc:
<comment>Description:</comment>
  Send data to the task worker processes in blocking way.
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>       
  <info>float</info>   <strong>$timeout</strong>    
  <info>int</info>     <strong>$worker_id</strong>  

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


id: Swoole\Server::tick
type: function
doc:
<comment>Description:</comment>
  Repeats a given function at every given time-interval.

<comment>Param:</comment>
  <info>int</info>       <strong>$interval_ms</strong>  
  <info>callable</info>  <strong>$callback</strong>     

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


id: Swoole\Server\Port::__destruct
type: function
doc:
<comment>Description:</comment>
  Destory server port

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


id: Swoole\Server\Port::on
type: function
doc:
<comment>Description:</comment>
  Register callback functions by event.

<comment>Param:</comment>
  <info>string</info>    <strong>$event_name</strong>  
  <info>callable</info>  <strong>$callback</strong>    

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Server\Port::set
type: function
doc:
<comment>Description:</comment>
  Set protocol of the server port.

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

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


id: Swoole\Table::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a Swoole memory table with fixed size.

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


id: Swoole\Table::column
type: function
doc:
<comment>Description:</comment>
  Set the data type and size of the columns.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  
  <info>string</info>  <strong>$type</strong>  
  <info>int</info>     <strong>$size</strong>  

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Table::count
type: function
doc:
<comment>Description:</comment>
  Count the rows in the table, or count all the elements in the table if $mode = 1.

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


id: Swoole\Table::create
type: function
doc:
<comment>Description:</comment>
  Create the swoole memory table.

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


id: Swoole\Table::current
type: function
doc:
<comment>Description:</comment>
  Get the current row.

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


id: Swoole\Table::decr
type: function
doc:
<comment>Description:</comment>
  Decrement the value in the Swoole table by $row_key and $column_key.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>     
  <info>string</info>  <strong>$column</strong>  
  <info>int</info>     <strong>$decrby</strong>  

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Table::del
type: function
doc:
<comment>Description:</comment>
  Delete a row in the Swoole table by $row_key.

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

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


id: Swoole\Table::destroy
type: function
doc:
<comment>Description:</comment>
  Destroy the Swoole table.

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


id: Swoole\Table::exist
type: function
doc:
<comment>Description:</comment>
  Check if a row is existed by $row_key.

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

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


id: Swoole\Table::get
type: function
doc:
<comment>Description:</comment>
  Get the value in the Swoole table by $row_key and $column_key.

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

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


id: Swoole\Table::incr
type: function
doc:
<comment>Description:</comment>
  Increment the value by $row_key and $column_key.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>     
  <info>string</info>  <strong>$column</strong>  
  <info>int</info>     <strong>$incrby</strong>  

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


id: Swoole\Table::key
type: function
doc:
<comment>Description:</comment>
  Get the key of current row.

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


id: Swoole\Table::next
type: function
doc:
<comment>Description:</comment>
  Iterator the next row.

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Table::rewind
type: function
doc:
<comment>Description:</comment>
  Rewind the iterator.

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


id: Swoole\Table::set
type: function
doc:
<comment>Description:</comment>
  Update a row of the table by $row_key.

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

<comment>Return:</comment>
  <info>VOID</info>  


id: Swoole\Table::valid
type: function
doc:
<comment>Description:</comment>
  Check current if the current row is valid.

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


id: Swoole\Timer::after
type: function
doc:
<comment>Description:</comment>
  Trigger a callback function after a period of time.
  
  Trigger a callback function after a period of time.

<comment>Param:</comment>
  <info>int</info>       <strong>$after_time_ms</strong>  
  <info>callable</info>  <strong>$callback</strong>       

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


id: Swoole\Timer::clear
type: function
doc:
<comment>Description:</comment>
  Delete a timer by timer ID.
  
  Delete a timer by timer ID.

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

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


id: Swoole\Timer::exists
type: function
doc:
<comment>Description:</comment>
  Check if a timer is existed.
  
  Check if a timer is existed.

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

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


id: Swoole\Timer::tick
type: function
doc:
<comment>Description:</comment>
  Repeats a given function at every given time-interval.

<comment>Param:</comment>
  <info>int</info>       <strong>$interval_ms</strong>  
  <info>callable</info>  <strong>$callback</strong>     
  <info>string</info>    <strong>$param</strong>        

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


id: Swoole\WebSocket\Server::exist
type: function
doc:
<comment>Description:</comment>
  Check if the file descriptor exists.

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

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


id: Swoole\WebSocket\Server::on
type: function
doc:
<comment>Description:</comment>
  Register event callback function
  
  Register event callback function

<comment>Param:</comment>
  <info>string</info>    <strong>$event_name</strong>  
  <info>callable</info>  <strong>$callback</strong>    

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\WebSocket\Server::pack
type: function
doc:
<comment>Description:</comment>
  Get a pack of binary data to send in a single frame.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>    
  <info>string</info>  <strong>$opcode</strong>  
  <info>string</info>  <strong>$finish</strong>  
  <info>string</info>  <strong>$mask</strong>    

<comment>Return:</comment>
  <info>binary</info>  


id: Swoole\WebSocket\Server::push
type: function
doc:
<comment>Description:</comment>
  Push data to the remote client.

<comment>Param:</comment>
  <info>string</info>  <strong>$fd</strong>      
  <info>string</info>  <strong>$data</strong>    
  <info>string</info>  <strong>$opcode</strong>  
  <info>string</info>  <strong>$finish</strong>  

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


id: Swoole\WebSocket\Server::unpack
type: function
doc:
<comment>Description:</comment>
  Unpack the binary data received from the client.

<comment>Param:</comment>
  <info>binary</info>  <strong>$data</strong>  

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


id: SyncEvent
type: class
doc:
<comment>Description:</comment>
  A cross-platform, native implementation of named and unnamed event objects.  Both automatic and
  manual event objects are supported.
  
  An event object waits, without polling, for the object to be fired/set. One instance waits on the
  event object while another instance fires/sets the event.  Event objects are useful wherever a
  long-running process would otherwise poll a resource (e.g. checking to see if uploaded data needs
  to be processed).


id: SyncEvent::__construct
type: function
doc:
<comment>Description:</comment>
  Constructs a new SyncEvent object
  
  Constructs a named or unnamed event object.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>     The name of the event if this is a named event object.
                    
                    If the name already exists, it must be able to be opened by the current user
                    that the process is running as or an exception will be thrown with a meaningless
                    error message.
  <info>bool</info>    <strong>$manual</strong>   Specifies whether or not the event object must be reset manually.
                    
                    Manual reset event objects allow all waiting processes through until the object
                    is reset.
  <info>bool</info>    <strong>$prefire</strong>  Specifies whether or not to prefire (signal) the event object.
                    
                    Only has impact if the calling process/thread is the first to create the object.

<comment>Return:</comment>
  <info>unknown</info>  The new <class>SyncEvent</class> object.

<comment>See Also:</comment>
   * SyncEvent::fire
   * SyncEvent::reset
   * SyncEvent::wait


id: SyncEvent::fire
type: function
doc:
<comment>Description:</comment>
  Fires/sets the event
  
  Fires/sets a <class>SyncEvent</class> object. Lets multiple threads through that are waiting if the event object
  was created with a manual value of <info>true</info>.

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

<comment>See Also:</comment>
   * SyncEvent::reset
   * SyncEvent::wait


id: SyncEvent::reset
type: function
doc:
<comment>Description:</comment>
  Resets a manual event
  
  Resets a <class>SyncEvent</class> object that has been fired/set. Only valid for manual event objects.

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

<comment>See Also:</comment>
   * SyncEvent::fire
   * SyncEvent::reset
   * SyncEvent::wait


id: SyncEvent::wait
type: function
doc:
<comment>Description:</comment>
  Waits for the event to be fired/set
  
  Waits for the <class>SyncEvent</class> object to be fired.

<comment>Param:</comment>
  <info>int</info>  <strong>$wait</strong>  The number of milliseconds to wait for the event to be fired. A value of -1 is
              infinite.

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

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


id: SyncMutex
type: class
doc:
<comment>Description:</comment>
  A cross-platform, native implementation of named and unnamed countable mutex objects.
  
  A mutex is a mutual exclusion object that restricts access to a shared resource (e.g. a file) to a
  single instance. Countable mutexes acquire the mutex a single time and internally track the number
  of times the mutex is locked. The mutex is unlocked as soon as it goes out of scope or is unlocked
  the same number of times that it was locked.


id: SyncMutex::__construct
type: function
doc:
<comment>Description:</comment>
  Constructs a new SyncMutex object
  
  Constructs a named or unnamed countable mutex.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  The name of the mutex if this is a named mutex object.
                 
                 If the name already exists, it must be able to be opened by the current user that
                 the process is running as or an exception will be thrown with a meaningless error
                 message.

<comment>Return:</comment>
  <info>unknown</info>  The new <class>SyncMutex</class> object.

<comment>See Also:</comment>
   * SyncMutex::lock
   * SyncMutex::unlock


id: SyncMutex::lock
type: function
doc:
<comment>Description:</comment>
  Waits for an exclusive lock
  
  Obtains an exclusive lock on a <class>SyncMutex</class> object. If the lock is already acquired, then this
  increments an internal counter.

<comment>Param:</comment>
  <info>int</info>  <strong>$wait</strong>  The number of milliseconds to wait for the exclusive lock. A value of -1 is infinite.

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

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


id: SyncMutex::unlock
type: function
doc:
<comment>Description:</comment>
  Unlocks the mutex
  
  Decreases the internal counter of a <class>SyncMutex</class> object. When the internal counter reaches zero, the
  actual lock on the object is released.

<comment>Param:</comment>
  <info>bool</info>  <strong>$all</strong>  Specifies whether or not to set the internal counter to zero and therefore release the
              lock.

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

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


id: SyncReaderWriter
type: class
doc:
<comment>Description:</comment>
  A cross-platform, native implementation of named and unnamed reader-writer objects.
  
  A reader-writer object allows many readers or one writer to access a resource. This is an
  efficient solution for managing resources where access will primarily be read-only but exclusive
  write access is occasionally necessary.


id: SyncReaderWriter::__construct
type: function
doc:
<comment>Description:</comment>
  Constructs a new SyncReaderWriter object
  
  Constructs a named or unnamed reader-writer object.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>        The name of the reader-writer if this is a named reader-writer object.
                       
                       If the name already exists, it must be able to be opened by the current user
                       that the process is running as or an exception will be thrown with a
                       meaningless error message.
                       
                       On Windows, <strong>$name</strong> must not contain backslashes.
  <info>int</info>     <strong>$autounlock</strong>  Specifies whether or not to automatically unlock the reader-writer at the
                       conclusion of the PHP script.
                       
                       If an object is:  A named reader-writer with an autounlock of FALSE, the
                       object is locked for either reading or writing, and the PHP script concludes
                       before the object is unlocked, then the underlying objects will end up in an
                       inconsistent state.

<comment>Return:</comment>
  <info>unknown</info>  The new <class>SyncReaderWriter</class> object.

<comment>See Also:</comment>
   * SyncReaderWriter::readlock
   * SyncReaderWriter::readunlock
   * SyncReaderWriter::writelock
   * SyncReaderWriter::writeunlock


id: SyncReaderWriter::readlock
type: function
doc:
<comment>Description:</comment>
  Waits for a read lock
  
  Obtains a read lock on a <class>SyncReaderWriter</class> object.

<comment>Param:</comment>
  <info>int</info>  <strong>$wait</strong>  The number of milliseconds to wait for a lock. A value of -1 is infinite.

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

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


id: SyncReaderWriter::readunlock
type: function
doc:
<comment>Description:</comment>
  Releases a read lock
  
  Releases a read lock on a <class>SyncReaderWriter</class> object.

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

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


id: SyncReaderWriter::writelock
type: function
doc:
<comment>Description:</comment>
  Waits for an exclusive write lock
  
  Obtains an exclusive write lock on a <class>SyncReaderWriter</class> object.

<comment>Param:</comment>
  <info>int</info>  <strong>$wait</strong>  The number of milliseconds to wait for a lock. A value of -1 is infinite.

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

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


id: SyncReaderWriter::writeunlock
type: function
doc:
<comment>Description:</comment>
  Releases a write lock
  
  Releases a write lock on a <class>SyncReaderWriter</class> object.

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

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


id: SyncSemaphore
type: class
doc:
<comment>Description:</comment>
  A cross-platform, native implementation of named and unnamed semaphore objects.
  
  A semaphore restricts access to a limited resource to a limited number of instances. Semaphores
  differ from mutexes in that they can allow more than one instance to access a resource at one time
  while a mutex only allows one instance at a time.


id: SyncSemaphore::__construct
type: function
doc:
<comment>Description:</comment>
  Constructs a new SyncSemaphore object
  
  Constructs a named or unnamed semaphore.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>        The name of the semaphore if this is a named semaphore object.
                       
                       If the name already exists, it must be able to be opened by the current user
                       that the process is running as or an exception will be thrown with a
                       meaningless error message.
  <info>int</info>     <strong>$initialval</strong>  The initial value of the semaphore. This is the number of locks that may be
                       obtained.
  <info>bool</info>    <strong>$autounlock</strong>  Specifies whether or not to automatically unlock the semaphore at the
                       conclusion of the PHP script.
                       
                       If an object is: A named semaphore with an autounlock of <info>false</info>, the object is
                       locked, and the PHP script concludes before the object is unlocked, then the
                       underlying semaphore will end up in an inconsistent state.

<comment>Return:</comment>
  <info>unknown</info>  The new <class>SyncSemaphore</class> object.

<comment>See Also:</comment>
   * SyncSemaphore::lock
   * SyncSemaphore::unlock


id: SyncSemaphore::lock
type: function
doc:
<comment>Description:</comment>
  Decreases the count of the semaphore or waits
  
  Decreases the count of a <class>SyncSemaphore</class> object or waits until the semaphore becomes non-zero.

<comment>Param:</comment>
  <info>int</info>  <strong>$wait</strong>  The number of milliseconds to wait for the semaphore. A value of -1 is infinite.

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

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


id: SyncSemaphore::unlock
type: function
doc:
<comment>Description:</comment>
  Increases the count of the semaphore
  
  Increases the count of a <class>SyncSemaphore</class> object.

<comment>Param:</comment>
  <info>int</info>  <strong>$prevcount</strong>  Returns the previous count of the semaphore.

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

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


id: SyncSharedMemory
type: class
doc:
<comment>Description:</comment>
  A cross-platform, native, consistent implementation of named shared memory objects.
  
  Shared memory lets two separate processes communicate without the need for complex pipes or
  sockets.  There are several integer-based shared memory implementations for PHP.  Named shared
  memory is an alternative.
  
  Synchronization objects (e.g. SyncMutex) are still required to protect most uses of shared memory.


id: SyncSharedMemory::__construct
type: function
doc:
<comment>Description:</comment>
  Constructs a new SyncSharedMemory object
  
  Constructs a named shared memory object.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  The name of the shared memory object.
                 
                 If the name already exists, it must be able to be opened by the current user that
                 the process is running as or an exception will be thrown with a meaningless error
                 message.
  <info>int</info>     <strong>$size</strong>  The size, in bytes, of shared memory to reserve.
                 
                 The amount of memory cannot be resized later.  Request sufficient storage up front.

<comment>Return:</comment>
  <info>unknown</info>  The new <class>SyncSharedMemory</class> object.

<comment>See Also:</comment>
   * SyncSharedMemory::first
   * SyncSharedMemory::size
   * SyncSharedMemory::write
   * SyncSharedMemory::read


id: SyncSharedMemory::first
type: function
doc:
<comment>Description:</comment>
  Check to see if the object is the first instance system-wide of named shared memory
  
  Retrieves the system-wide first instance status of a <class>SyncSharedMemory</class> object.

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

<comment>See Also:</comment>
   * SyncSharedMemory::write
   * SyncSharedMemory::read


id: SyncSharedMemory::read
type: function
doc:
<comment>Description:</comment>
  Copy data from named shared memory
  
  Copies data from named shared memory.

<comment>Param:</comment>
  <info>int</info>  <strong>$start</strong>   The start/offset, in bytes, to begin reading.
                
                If the value is negative, the starting position will begin at the specified number
                of bytes from the end of the shared memory segment.
  <info>int</info>  <strong>$length</strong>  The number of bytes to read.
                
                If unspecified, reading will stop at the end of the shared memory segment.
                
                If the value is negative, reading will stop the specified number of bytes from the
                end of the shared memory segment.

<comment>Return:</comment>
  <info>unknown</info>  A string containing the data read from shared memory.

<comment>See Also:</comment>
   * SyncSharedMemory::__construct
   * SyncSharedMemory::first
   * SyncSharedMemory::write
   * SyncSharedMemory::read


id: SyncSharedMemory::size
type: function
doc:
<comment>Description:</comment>
  Returns the size of the named shared memory
  
  Retrieves the shared memory size of a <class>SyncSharedMemory</class> object.

<comment>Return:</comment>
  <info>int</info>  An integer containing the size of the shared memory. This will be the same size that was
       passed to the constructor.

<comment>See Also:</comment>
   * SyncSharedMemory::__construct
   * SyncSharedMemory::write
   * SyncSharedMemory::read


id: SyncSharedMemory::write
type: function
doc:
<comment>Description:</comment>
  Copy data to named shared memory
  
  Copies data to named shared memory.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  The data to write to shared memory.
                   
                   If the size of the data exceeds the size of the shared memory, the number of
                   bytes written returned will be less than the length of the input.
  <info>int</info>     <strong>$start</strong>   The start/offset, in bytes, to begin writing.
                   
                   If the value is negative, the starting position will begin at the specified
                   number of bytes from the end of the shared memory segment.

<comment>Return:</comment>
  <info>unknown</info>  An integer containing the number of bytes written to shared memory.

<comment>See Also:</comment>
   * SyncSharedMemory::__construct
   * SyncSharedMemory::first
   * SyncSharedMemory::write
   * SyncSharedMemory::read


id: SysvMessageQueue
type: class
doc:
<comment>Description:</comment>
  PHP 8.0.0 以降、 <return>sysvmsg queue</return> リソースを置き換える、完全不定形クラスです。


id: Table::count
type: function
doc:
<comment>Description:</comment>
  行の数を取得する
  
  テーブルの行数を取得します。

<comment>Return:</comment>
  <info>int</info>  テーブルの合計の行数を返します。


id: Table::delete
type: function
doc:
<comment>Description:</comment>
  テーブルから行を削除する
  
  テーブルから行を削除します。

<comment>Return:</comment>
  <info>mysql_xdevapi\TableDelete</info>  TableDelete オブジェクトを返します。 delete 文を実行するには、execute()
                             メソッドを使ってください。


id: Table::existsInDatabase
type: function
doc:
<comment>Description:</comment>
  テーブルがデータベースに存在するかをチェックする
  
  このテーブルがデータベースに存在するかを検証します。

<comment>Return:</comment>
  <info>bool</info>  テーブルがデータベースに存在していれば <info>true</info> を返します。 そうでなければ、<info>false</info> を返します。


id: Table::getName
type: function
doc:
<comment>Description:</comment>
  テーブル名を取得する
  
  このデータベースオブジェクトの名前を返します。

<comment>Return:</comment>
  <info>string</info>  データベースオブジェクトの名前を返します。


id: Table::getSchema
type: function
doc:
<comment>Description:</comment>
  テーブルスキーマを取得する
  
  テーブルに紐付いたスキーマを取得します。

<comment>Return:</comment>
  <info>mysql_xdevapi\Schema</info>  Schema オブジェクトを返します。


id: Table::getSession
type: function
doc:
<comment>Description:</comment>
  テーブルを操作するためのセッションを取得する
  
  テーブルに紐付いたセッションを取得します。

<comment>Return:</comment>
  <info>mysql_xdevapi\Session</info>  Session オブジェクトを返します。


id: Table::insert
type: function
doc:
<comment>Description:</comment>
  テーブルに行を挿入する
  
  テーブルに行を挿入します。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$columns</strong>       データを挿入するカラム。 ひとつ以上の値を持つ配列か、文字列です。
  <info>mixed</info>  <strong>$more_columns</strong>  追加のカラム定義

<comment>Return:</comment>
  <info>mysql_xdevapi\TableInsert</info>  TableInsert オブジェクトを返します。 insert 文を実行するには、
                             execute() メソッドを使ってください。


id: Table::isView
type: function
doc:
<comment>Description:</comment>
  テーブルがビューかどうかを調べる
  
  オブジェクトがビューかそうでないかを調べます。

<comment>Return:</comment>
  <info>bool</info>  オブジェクトがビューであるなら <info>true</info> そうでないなら <info>false</info> を返します。


id: Table::select
type: function
doc:
<comment>Description:</comment>
  テーブルから行を選択する
  
  テーブルからデータを取得します。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$columns</strong>       データを選択するカラム。 一つ以上の値を持つ配列、または文字列。
  <info>mixed</info>  <strong>$more_columns</strong>  追加のカラムパラメータ

<comment>Return:</comment>
  <info>mysql_xdevapi\TableSelect</info>  TableSelect オブジェクトを返します。 select 文を実行し、RowResult オブ
                             ジェクトを得るには、 execute() メソッドを使ってください。


id: Table::update
type: function
doc:
<comment>Description:</comment>
  テーブルの行を更新する
  
  テーブルのカラムを更新します。

<comment>Return:</comment>
  <info>mysql_xdevapi\TableUpdate</info>  TableUpdate オブジェクトを返します。 update 文を実行するには、execute()
                             メソッドを使ってください。


id: TableDelete::bind
type: function
doc:
<comment>Description:</comment>
  delete のクエリパラメータをバインドする
  
  特定のプレースホルダーの値をバインドします。

<comment>Param:</comment>
  <info>array</info>  <strong>$placeholder_values</strong>  プレースホルダーの名前、およびバインドする値です。

<comment>Return:</comment>
  <info>mysql_xdevapi\TableDelete</info>  TableDelete オブジェクトを返します。


id: TableDelete::execute
type: function
doc:
<comment>Description:</comment>
  delete文を実行する
  
  delete文を実行します。

<comment>Return:</comment>
  <info>mysql_xdevapi\Result</info>  Result オブジェクトを返します。


id: TableDelete::limit
type: function
doc:
<comment>Description:</comment>
  削除する行を限定する
  
  削除するレコードまたはドキュメントの最大数を設定します

<comment>Param:</comment>
  <info>int</info>  <strong>$rows</strong>  削除するレコードまたはドキュメントの最大数

<comment>Return:</comment>
  <info>mysql_xdevapi\TableDelete</info>  TableDelete オブジェクトを返します。


id: TableDelete::orderby
type: function
doc:
<comment>Description:</comment>
  削除の際のソート条件を設定する
  
  結果セットのソート条件を設定します。

<comment>Param:</comment>
  <info>string</info>  <strong>$orderby_expr</strong>  ソート条件

<comment>Return:</comment>
  <info>mysql_xdevapi\TableDelete</info>  TableDelete オブジェクトを返します。


id: TableDelete::where
type: function
doc:
<comment>Description:</comment>
  削除時の検索条件を設定する
  
  フィルタのための検索条件を設定します。

<comment>Param:</comment>
  <info>string</info>  <strong>$where_expr</strong>  ドキュメントまたはレコードをフィルタする検索条件を定義します。

<comment>Return:</comment>
  <info>mysql_xdevapi\TableDelete</info>  TableDelete オブジェクトを返します。


id: TableInsert::execute
type: function
doc:
<comment>Description:</comment>
  insert クエリを実行する
  
  insert 文を実行します。

<comment>Return:</comment>
  <info>mysql_xdevapi\Result</info>  Result オブジェクトを返します。


id: TableInsert::values
type: function
doc:
<comment>Description:</comment>
  挿入する行の値を追加する
  
  挿入する値を設定します。

<comment>Param:</comment>
  <info>array</info>  <strong>$row_values</strong>  挿入するカラムの値(の配列)

<comment>Return:</comment>
  <info>mysql_xdevapi\TableInsert</info>  TableInsert オブジェクトを返します。


id: TableSelect::__construct
type: function
doc:
<comment>Description:</comment>
  TableSelect のコンストラクタ
  
  select() メソッドによって返されるオブジェクトです。 クエリを実行するには execute() を使ってくださ
  い。


id: TableSelect::bind
type: function
doc:
<comment>Description:</comment>
  select のクエリパラメータをバインドする
  
  特定のプレースホルダーの値をバインドします。

<comment>Param:</comment>
  <info>array</info>  <strong>$placeholder_values</strong>  プレースホルダーの名前、およびバインドする値

<comment>Return:</comment>
  <info>mysql_xdevapi\TableSelect</info>  TableSelect オブジェクトを返します。


id: TableSelect::execute
type: function
doc:
<comment>Description:</comment>
  select ステートメントを実行する
  
  execute() メソッドとチェインすることで、select ステートメントを実行します。

<comment>Return:</comment>
  <info>mysql_xdevapi\RowResult</info>  RowResult オブジェクトを返します。


id: TableSelect::groupBy
type: function
doc:
<comment>Description:</comment>
  select 時のグループ化の条件を設定する
  
  結果セットのグループ化条件を設定します。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$sort_expr</strong>  グループ化条件

<comment>Return:</comment>
  <info>mysql_xdevapi\TableSelect</info>  TableSelect オブジェクトを返します。


id: TableSelect::having
type: function
doc:
<comment>Description:</comment>
  select 句の having 条件を設定する
  
  集約関数の操作において考慮すべき、レコードの条件を設定します。

<comment>Param:</comment>
  <info>string</info>  <strong>$sort_expr</strong>  グループ化の条件で使われる、集約関数の条件

<comment>Return:</comment>
  <info>mysql_xdevapi\TableSelect</info>  TableSelect オブジェクトを返します。


id: TableSelect::limit
type: function
doc:
<comment>Description:</comment>
  選択される行の数を限定する
  
  返されるレコードまたはドキュメントの数の最大値を設定します。

<comment>Param:</comment>
  <info>int</info>  <strong>$rows</strong>  レコードまたはドキュメントの数の最大値

<comment>Return:</comment>
  <info>mysql_xdevapi\TableSelect</info>  TableSelect オブジェクトを返します


id: TableSelect::lockExclusive
type: function
doc:
<comment>Description:</comment>
  EXCLUSIVE LOCK を実行する
  
  EXCLUSIVE LOCK 付きで読み取り操作を実行します。 一度にアクティブになれるロックはひとつだけです。

<comment>Param:</comment>
  <info>int</info>  <strong>$lock_waiting_option</strong>  オプションで指定できる、ロック待ちのオプション。 デフォルトは
                             <info>MYSQLX_LOCK_DEFAULT</info> です。 有効な値は以下のとおりです:
                             
                             <info>MYSQLX_LOCK_DEFAULT</info>
                             
                             <info>MYSQLX_LOCK_NOWAIT</info>
                             
                             <info>MYSQLX_LOCK_SKIP_LOCKED</info>

<comment>Return:</comment>
  <info>mysql_xdevapi\TableSelect</info>  TableSelect オブジェクトを返します。


id: TableSelect::lockShared
type: function
doc:
<comment>Description:</comment>
  SHARED LOCK を実行する
  
  読み取り操作を SHARED LOCK 付きで実行します。 アクティブになれるロックは一度にひとつだけです。

<comment>Param:</comment>
  <info>int</info>  <strong>$lock_waiting_option</strong>  オプションで指定できる、ロック待ちのオプション。 デフォルトは
                             <info>MYSQLX_LOCK_DEFAULT</info> です。 有効な値は以下のとおりです:
                             
                             <info>MYSQLX_LOCK_DEFAULT</info>
                             
                             <info>MYSQLX_LOCK_NOWAIT</info>
                             
                             <info>MYSQLX_LOCK_SKIP_LOCKED</info>

<comment>Return:</comment>
  <info>mysql_xdevapi\TableSelect</info>  TableSelect オブジェクトを返します。


id: TableSelect::offset
type: function
doc:
<comment>Description:</comment>
  スキップするoffsetを設定する
  
  結果セットの行を、与えられた数だけスキップします

<comment>Param:</comment>
  <info>int</info>  <strong>$position</strong>  スキップするオフセットの数

<comment>Return:</comment>
  <info>mysql_xdevapi\TableSelect</info>  TableSelect オブジェクトを返します。


id: TableSelect::orderby
type: function
doc:
<comment>Description:</comment>
  select 文のソート条件を設定する
  
  ソート順の条件を設定します。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$sort_expr</strong>   ソート順の条件を定義した式。 単一の文字列化、ひとつ以上の式を持つ配列。
  <info>mixed</info>  <strong>$sort_exprs</strong>  追加の sort_expr パラメータ

<comment>Return:</comment>
  <info>mysql_xdevapi\TableSelect</info>  TableSelect オブジェクトを返します。


id: TableSelect::where
type: function
doc:
<comment>Description:</comment>
  select 文の検索条件を設定する
  
  フィルタのための検索条件を設定します。

<comment>Param:</comment>
  <info>string</info>  <strong>$where_expr</strong>  ドキュメントまたはレコードをフィルタするための検索条件

<comment>Return:</comment>
  <info>mysql_xdevapi\TableSelect</info>  TableSelect オブジェクトを返します。


id: TableUpdate::bind
type: function
doc:
<comment>Description:</comment>
  update のクエリパラメータをバインドする
  
  特定のプレースホルダーの値をバインドします。

<comment>Param:</comment>
  <info>array</info>  <strong>$placeholder_values</strong>  プレースホルダーの名前、およびバインドする値です。 JSON の配列として定
                              義されます。

<comment>Return:</comment>
  <info>mysql_xdevapi\TableUpdate</info>  TableUpdate オブジェクトを返します。


id: TableUpdate::execute
type: function
doc:
<comment>Description:</comment>
  update クエリを実行する
  
  update 文を実行します。

<comment>Return:</comment>
  <info>mysql_xdevapi\TableUpdate</info>  TableUpdate オブジェクトを返します。


id: TableUpdate::limit
type: function
doc:
<comment>Description:</comment>
  更新する行の数を限定する
  
  更新するレコードまたはドキュメントの数の最大値を設定します。

<comment>Param:</comment>
  <info>int</info>  <strong>$rows</strong>  更新するレコードまたはドキュメントの数の最大値

<comment>Return:</comment>
  <info>mysql_xdevapi\TableUpdate</info>  TableUpdate オブジェクトを返します


id: TableUpdate::orderby
type: function
doc:
<comment>Description:</comment>
  ソート条件を設定する
  
  ソート条件を設定します。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$orderby_expr</strong>   ソート条件を定義する式。 ひとつまたはそれ以上の式の配列、または文字列。
  <info>mixed</info>  <strong>$orderby_exprs</strong>  追加のソート条件のパラメータ

<comment>Return:</comment>
  <info>mysql_xdevapi\TableUpdate</info>  TableUpdate オブジェクトを返します。


id: TableUpdate::set
type: function
doc:
<comment>Description:</comment>
  更新されるフィールドを追加する
  
  テーブルのレコード上のカラムの値を更新します。

<comment>Param:</comment>
  <info>string</info>  <strong>$table_field</strong>            更新されるカラム名
  <info>string</info>  <strong>$expression_or_literal</strong>  指定されたカラムに設定する値

<comment>Return:</comment>
  <info>mysql_xdevapi\TableUpdate</info>  TableUpdate オブジェクトを返します。


id: TableUpdate::where
type: function
doc:
<comment>Description:</comment>
  検索フィルタを設定する
  
  フィルタのための検索条件を設定します。

<comment>Param:</comment>
  <info>string</info>  <strong>$where_expr</strong>  ドキュメントまたはレコードをフィルタする検索条件

<comment>Return:</comment>
  <info>mysql_xdevapi\TableUpdate</info>  TableUpdate オブジェクトを返します。


id: Thread
type: class
doc:
<comment>Description:</comment>
  このオブジェクトの start メソッドが呼ばれると、run メソッドのコードが個別のスレッドで並列処理され
  ます。
  
  run メソッドの実行後は Thread はすぐに終了し、作成元のスレッドに適切な時期に join します。
  
  Thread をいつ join させるのかをエンジンに決めさせていると、予期せぬ振る舞いを引き起こすことがあり
  ます。 可能な限り、プログラマーが明示的に指定するようにしましょう。


id: Thread::getCreatorId
type: function
doc:
<comment>Description:</comment>
  識別
  
  このスレッドを作ったスレッドの ID を返します。

<comment>Return:</comment>
  <info>int</info>  数値の ID を返します。


id: Thread::getCurrentThread
type: function
doc:
<comment>Description:</comment>
  Identification
  
  Return a reference to the currently executing Thread

<comment>Return:</comment>
  <info>Thread</info>  An object representing the currently executing Thread


id: Thread::getCurrentThreadId
type: function
doc:
<comment>Description:</comment>
  Identification
  
  Will return the identity of the currently executing Thread

<comment>Return:</comment>
  <info>int</info>  A numeric identity


id: Thread::getThreadId
type: function
doc:
<comment>Description:</comment>
  識別
  
  このスレッドの ID を返します。

<comment>Return:</comment>
  <info>int</info>  数値の ID を返します。


id: Thread::isJoined
type: function
doc:
<comment>Description:</comment>
  状態を検出する
  
  このスレッドが同期されているかどうかを調べます。

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


id: Thread::isStarted
type: function
doc:
<comment>Description:</comment>
  状態を検出する
  
  このスレッドが開始したかどうかを調べます。

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


id: Thread::join
type: function
doc:
<comment>Description:</comment>
  同期処理
  
  呼び出し元のコンテキストが、このスレッドの実行終了を待つようにします。

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


id: Thread::start
type: function
doc:
<comment>Description:</comment>
  実行する
  
  新しいスレッドを開始し、実装されている run メソッドを実行します。

<comment>Param:</comment>
  <info>int</info>  <strong>$options</strong>  オプションのマスク。継承に関する定数で、デフォルトは PTHREADS_INHERIT_ALL。

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


id: Threaded
type: class
doc:
<comment>Description:</comment>
  Threaded objects form the basis of pthreads ability to execute user code in parallel; they expose
  synchronization methods and various useful interfaces.
  
  Threaded objects, most importantly, provide implicit safety for the programmer; all operations on
  the object scope are safe.


id: Threaded::chunk
type: function
doc:
<comment>Description:</comment>
  Manipulation
  
  Fetches a chunk of the objects property table of the given size, optionally preserving keys

<comment>Param:</comment>
  <info>int</info>   <strong>$size</strong>      The number of items to fetch
  <info>bool</info>  <strong>$preserve</strong>  Preserve the keys of members, by default false

<comment>Return:</comment>
  <info>array</info>  An array of items from the objects property table


id: Threaded::count
type: function
doc:
<comment>Description:</comment>
  Manipulation
  
  Returns the number of properties for this object

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


id: Threaded::extend
type: function
doc:
<comment>Description:</comment>
  Runtime Manipulation
  
  Makes thread safe standard class at runtime

<comment>Param:</comment>
  <info>string</info>  <strong>$class</strong>  The class to extend

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


id: Threaded::isRunning
type: function
doc:
<comment>Description:</comment>
  State Detection
  
  Tell if the referenced object is executing

<comment>Return:</comment>
  <info>bool</info>  A boolean indication of state  A object is considered running while executing the run method 
        
        A object is considered running while executing the run method


id: Threaded::isTerminated
type: function
doc:
<comment>Description:</comment>
  State Detection
  
  Tell if the referenced object was terminated during execution; suffered fatal errors, or threw
  uncaught exceptions

<comment>Return:</comment>
  <info>bool</info>  A boolean indication of state


id: Threaded::merge
type: function
doc:
<comment>Description:</comment>
  Manipulation
  
  Merges data into the current object

<comment>Param:</comment>
  <info>mixed</info>  <strong>$from</strong>       The data to merge
  <info>bool</info>   <strong>$overwrite</strong>  Overwrite existing keys, by default true

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


id: Threaded::notify
type: function
doc:
<comment>Description:</comment>
  Synchronization
  
  Send notification to the referenced object

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


id: Threaded::notifyOne
type: function
doc:
<comment>Description:</comment>
  Synchronization
  
  Send notification to the referenced object. This unblocks at least one of the blocked threads (as
  opposed to unblocking all of them, as seen with Threaded::notify).

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


id: Threaded::pop
type: function
doc:
<comment>Description:</comment>
  Manipulation
  
  Pops an item from the objects property table

<comment>Return:</comment>
  <info>bool</info>  The last item from the objects property table


id: Threaded::run
type: function
doc:
<comment>Description:</comment>
  Execution
  
  The programmer should always implement the run method for objects that are intended for execution.

<comment>Return:</comment>
  <info>void</info>  The methods return value, if used, will be ignored


id: Threaded::shift
type: function
doc:
<comment>Description:</comment>
  Manipulation
  
  Shifts an item from the objects property table

<comment>Return:</comment>
  <info>mixed</info>  The first item from the objects property table


id: Threaded::synchronized
type: function
doc:
<comment>Description:</comment>
  Synchronization
  
  Executes the block while retaining the referenced objects synchronization lock for the calling
  context

<comment>Param:</comment>
  <info>Closure</info>  <strong>$block</strong>  The block of code to execute
  <info>mixed</info>    <strong>$args</strong>   Variable length list of arguments to use as function arguments to the block

<comment>Return:</comment>
  <info>mixed</info>  The return value from the block


id: Threaded::wait
type: function
doc:
<comment>Description:</comment>
  Synchronization
  
  Will cause the calling context to wait for notification from the referenced object

<comment>Param:</comment>
  <info>int</info>  <strong>$timeout</strong>  An optional timeout in microseconds

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


id: Throwable
type: class
doc:
<comment>Description:</comment>
  <class>Throwable</class> は、<return>throw</return> 文でスロー可能なあらゆるオブジェクトが実装する基底インターフェイスです。 <class>Error</class>
  や <class>Exception</class> も、これを実装しています。
  
  PHP のクラスが <class>Throwable</class> インターフェイスを直接実装することはできません。 そのかわりに、<class>Exception</class>
  を継承する必要があります。


id: Throwable::__toString
type: function
doc:
<comment>Description:</comment>
  スローされたオブジェクトの文字列表現を取得する

<comment>Return:</comment>
  <info>string</info>  スローされたオブジェクトの文字列表現を返します。

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


id: Throwable::getCode
type: function
doc:
<comment>Description:</comment>
  例外コードを取得する
  
  スローされたオブジェクトのエラーコードを返します。

<comment>Return:</comment>
  <info>int</info>  例外コードを返します。 <class>Exception</class> の場合は <info>int</info> ですが、 その派生クラスでは別の型かもしれません
       (たとえば <class>PDOException</class> の場合は <info>string</info> です)。

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


id: Throwable::getFile
type: function
doc:
<comment>Description:</comment>
  オブジェクトが作られたファイル名を取得する
  
  スローされたオブジェクトが作られたファイル名を取得します。

<comment>Return:</comment>
  <info>string</info>  スローされたオブジェクトが作られたファイル名を返します。

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


id: Throwable::getLine
type: function
doc:
<comment>Description:</comment>
  オブジェクトのインスタンスが作られた行番号を取得する
  
  スローされたオブジェクトのインスタンスが作られた行番号を返します。

<comment>Return:</comment>
  <info>int</info>  スローされたオブジェクトのインスタンスが作られた行番号を返します。

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


id: Throwable::getMessage
type: function
doc:
<comment>Description:</comment>
  メッセージを取得する
  
  スローされたオブジェクトに関連づけられたメッセージを返します。

<comment>Return:</comment>
  <info>string</info>  スローされたオブジェクトに関連づけられたメッセージを返します。

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


id: Throwable::getPrevious
type: function
doc:
<comment>Description:</comment>
  ひとつ前の Throwable を返す
  
  ひとつ前の Throwable (たとえば Exception::__construct の第三パラメータで指定したもの) を返します。

<comment>Return:</comment>
  <info>Throwable|null</info>  ひとつ前の <class>Throwable</class> が存在すればそれを返します。 存在しない場合は <info>null</info> を返しま
                  す。

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


id: Throwable::getTrace
type: function
doc:
<comment>Description:</comment>
  スタックトレースを取得する
  
  スタックトレースの配列を返します。

<comment>Return:</comment>
  <info>array</info>  スタックトレースの配列を返します。その書式は <strong>debug_backtrace()</strong> と同じです。

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


id: Throwable::getTraceAsString
type: function
doc:
<comment>Description:</comment>
  スタックトレースを文字列として取得する

<comment>Return:</comment>
  <info>string</info>  スタックトレースを文字列として返します。

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


id: Transliterator::__construct
type: function
doc:
<comment>Description:</comment>
  インスタンス化を拒否するために private にしたコンストラクタ
  
  このメソッドをコールしてはいけません。 new 演算子によるインスタンス化を拒否するために用意されたも
  のです。
  
  かわりに、ファクトリーメソッドである Transliterator::create あるいは
  Transliterator::createFromRules を使いましょう。

<comment>See Also:</comment>
   * Transliterator::create
   * Transliterator::createFromRules


id: Transliterator::create
type: function
doc:
<comment>Description:</comment>
  Transliterator を作成する
  
  オブジェクト指向型
  
  手続き型
  
  ID を指定して Transliterator をオープンします。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>string</info>  <strong>$id</strong>         ID を指定します。 全ての登録済みの transliterator ID は、
                      Transliterator::listIDs を使って取得できます。
  <info>int</info>     <strong>$direction</strong>  方向。デフォルトは Transliterator::FORWARD です。 Transliterator::REVERSE も指
                      定できます。

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

<comment>See Also:</comment>
   * Transliterator::getErrorMessage
   * Transliterator::__construct


id: Transliterator::createFromRules
type: function
doc:
<comment>Description:</comment>
  規則に基づいた Transliterator を作成する
  
  オブジェクト指向型
  
  手続き型
  
  規則に基づいた Transliterator を作成します。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>string</info>  <strong>$rules</strong>      UTS #35 (LDML) の "Transform Rules Syntax" で定義されている規則です。
  <info>int</info>     <strong>$direction</strong>  方向。デフォルトは Transliterator::FORWARD です。 Transliterator::REVERSE も指
                      定できます。

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

<comment>See Also:</comment>
   * Transliterator::getErrorMessage
   * Transliterator::create


id: Transliterator::createInverse
type: function
doc:
<comment>Description:</comment>
  逆方向の Transliterator を作成する
  
  オブジェクト指向型
  
  手続き型
  
  逆方向の Transliterator をオープンします。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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

<comment>See Also:</comment>
   * Transliterator::getErrorMessage
   * Transliterator::create


id: Transliterator::getErrorCode
type: function
doc:
<comment>Description:</comment>
  直近のエラーコードを取得する
  
  オブジェクト指向型
  
  手続き型
  
  この Transliterator の直近のエラーコードを取得します。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>Transliterator</info>  <strong>$transliterator</strong>  

<comment>Return:</comment>
  <info>int|false</info>  成功した場合にエラーコードを返します。 エラーがない場合や失敗した場合は <info>false</info> を返しま
             す。

<comment>See Also:</comment>
   * Transliterator::getErrorMessage
   * Transliterator::listIDs


id: Transliterator::getErrorMessage
type: function
doc:
<comment>Description:</comment>
  直近のエラーメッセージを取得する
  
  オブジェクト指向型
  
  手続き型
  
  この Transliterator の直近のエラーメッセージを取得します。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>Transliterator</info>  <strong>$transliterator</strong>  

<comment>Return:</comment>
  <info>string|false</info>  成功した場合にエラーメッセージを返します。 エラーがない場合や失敗した場合は <info>false</info> を
                返します。

<comment>See Also:</comment>
   * Transliterator::getErrorCode
   * Transliterator::listIDs


id: Transliterator::listIDs
type: function
doc:
<comment>Description:</comment>
  Transliterator の ID を取得する
  
  オブジェクト指向型
  
  手続き型
  
  登録されている Transliterator ID の配列を返します。

<comment>Return:</comment>
  <info>array|false</info>  成功した場合は登録されている Transliterator ID の配列を返します。 失敗した場合に
               <info>false</info> を返します。

<comment>See Also:</comment>
   * Transliterator::getErrorMessage
   * Transliterator::transliterate


id: Transliterator::transliterate
type: function
doc:
<comment>Description:</comment>
  文字列を音訳する
  
  オブジェクト指向型
  
  手続き型
  
  文字列あるいはその一部をICU の音訳器を使って変換します。

<comment>Param:</comment>
  <info>Transliterator|string</info>  <strong>$transliterator</strong>  手続き型の場合に、<class>Transliterator</class> あるいは <class>Transliterator</class>
                                          を作成できる文字列を指定します。
  <info>string</info>                 <strong>$string</strong>          変換する文字列。
  <info>int</info>                    <strong>$start</strong>           文字列の変換の開始位置を表すインデックス (UTF-16 コード単
                                          位) を指定します。指定した位置も、変換範囲に含まれます。
                                          インデックスは 0 から始まります。この位置より前にあるテキ
                                          ストは、そのまま残ります。
  <info>int</info>                    <strong>$end</strong>             文字列の変換の終了位置を表すインデックス (UTF-16 コード単
                                          位) を指定します。指定した位置は、変換範囲に含まれません。
                                          インデックスは 0 から始まります。この位置も含めてそれ以降
                                          にあるテキストは、そのまま残ります。

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

<comment>See Also:</comment>
   * Transliterator::getErrorMessage
   * Transliterator::__construct


id: Traversable
type: class
doc:
<comment>Description:</comment>
  そのクラスの中身が foreach を使用してたどれるかどうかを検出するインターフェイスです。
  
  これは抽象インターフェイスであり、単体で実装することはできません。 IteratorAggregate あるいは
  Iterator を実装しなければなりません。


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

<comment>Param:</comment>
  <info>string|null</info>  <strong>$destination_encoding</strong>  
  <info>string|null</info>  <strong>$source_encoding</strong>       


id: UConverter::convert
type: function
doc:
<comment>Description:</comment>
  ある文字セットから別の文字セットに文字列を変換する
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>string</info>  <strong>$str</strong>      
  <info>bool</info>    <strong>$reverse</strong>  

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


id: UConverter::fromUCallback
type: function
doc:
<comment>Description:</comment>
  デフォルトの "from" コールバック関数
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>int</info>    <strong>$reason</strong>     
  <info>array</info>  <strong>$source</strong>     
  <info>int</info>    <strong>$codePoint</strong>  
  <info>int</info>    <strong>$error</strong>      

<comment>Return:</comment>
  <info>string|int|array|null</info>  


id: UConverter::getAliases
type: function
doc:
<comment>Description:</comment>
  指定した名前のエイリアスを取得する
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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

<comment>Return:</comment>
  <info>array|false|null</info>  


id: UConverter::getAvailable
type: function
doc:
<comment>Description:</comment>
  利用可能なコンバーター名を取得する
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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


id: UConverter::getDestinationEncoding
type: function
doc:
<comment>Description:</comment>
  変換先エンコーディングを取得する
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>string|false|null</info>  


id: UConverter::getDestinationType
type: function
doc:
<comment>Description:</comment>
  変換先のコンバーターの型を取得する
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>int|false|null</info>  


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

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


id: UConverter::getErrorMessage
type: function
doc:
<comment>Description:</comment>
  直近のエラーメッセージを取得する
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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


id: UConverter::getSourceEncoding
type: function
doc:
<comment>Description:</comment>
  変換元エンコーディングを取得する
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>string|false|null</info>  


id: UConverter::getSourceType
type: function
doc:
<comment>Description:</comment>
  変換元のコンバーターの型を取得する
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>int|false|null</info>  


id: UConverter::getStandards
type: function
doc:
<comment>Description:</comment>
  コンバーター名に対応する標準を取得する
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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


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

<comment>Return:</comment>
  <info>string|false|null</info>  


id: UConverter::reasonText
type: function
doc:
<comment>Description:</comment>
  コールバックの理由を表す文字列を取得する
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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

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


id: UConverter::setDestinationEncoding
type: function
doc:
<comment>Description:</comment>
  変換先エンコーディングを設定する
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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

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


id: UConverter::setSourceEncoding
type: function
doc:
<comment>Description:</comment>
  変換元エンコーディングを設定する
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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

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


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

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

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


id: UConverter::toUCallback
type: function
doc:
<comment>Description:</comment>
  デフォルトの "to" コールバック関数
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>int</info>     <strong>$reason</strong>     
  <info>string</info>  <strong>$source</strong>     
  <info>string</info>  <strong>$codeUnits</strong>  
  <info>int</info>     <strong>$error</strong>      

<comment>Return:</comment>
  <info>string|int|array|null</info>  


id: UConverter::transcode
type: function
doc:
<comment>Description:</comment>
  ある文字エンコーディングから別の文字エンコーディングに文字列を変換する
  
  文字列 <strong>$str</strong> の文字エンコーディングを、 <strong>$fromEncoding</strong> から <strong>$toEncoding</strong> に変換します。

<comment>Param:</comment>
  <info>string</info>      <strong>$str</strong>           変換する文字列。
  <info>string</info>      <strong>$toEncoding</strong>    変換したいエンコーディング。
  <info>string</info>      <strong>$fromEncoding</strong>  <strong>$str</strong> の解釈に使われる文字セット。
  <info>array|null</info>  <strong>$options</strong>       オプションの配列。以下のキーが使えます: <return>'to_subst'</return> - <strong>$toEncoding</strong> ではエ
                             ンコードできない <strong>$str</strong> の文字を置き換えるのに使う文字。 これを指定する場
                             合、 変換先のエンコーディングのうちの一文字でなければいけません。

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

<comment>See Also:</comment>
   * <strong>mb_convert_encoding()</strong>
   * <strong>iconv()</strong>


id: UI\Area
type: class
doc:
<comment>Description:</comment>
  An Area represents a canvas which can be used to draw, and respond to mouse and key events.


id: UI\Area::Alt
type: constant
doc:
<comment>Description:</comment>
  Shall be set in the modifiers passed to key and mouse events when the ALT key is active


id: UI\Area::Ctrl
type: constant
doc:
<comment>Description:</comment>
  Shall be set in the modifiers passed to key and mouse events when the CTRL key is active


id: UI\Area::Shift
type: constant
doc:
<comment>Description:</comment>
  Shall be set in the modifiers passed to key and mouse events when the SHIFT key is active


id: UI\Area::onDraw
type: function
doc:
<comment>Description:</comment>
  Draw Callback
  
  Shall be invoked when this Area requires redrawing

<comment>Param:</comment>
  <info>UI\Draw\Pen</info>  <strong>$pen</strong>        A Pen suitable for drawing in this Area
  <info>UI\Size</info>      <strong>$areaSize</strong>   The size of the Area
  <info>UI\Point</info>     <strong>$clipPoint</strong>  The clip point of the Area
  <info>UI\Size</info>      <strong>$clipSize</strong>   The clip size of the Area


id: UI\Area::onKey
type: function
doc:
<comment>Description:</comment>
  Key Callback
  
  Shall be executed on key events

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>    The key pressed
  <info>int</info>     <strong>$ext</strong>    The extended key pressed
  <info>int</info>     <strong>$flags</strong>  Event modifiers


id: UI\Area::onMouse
type: function
doc:
<comment>Description:</comment>
  Mouse Callback
  
  Shall be executed on mouse events

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$areaPoint</strong>  The co-ordinates of the event
  <info>UI\Size</info>   <strong>$areaSize</strong>   The size of the area of the event
  <info>int</info>       <strong>$flags</strong>      Event modifiers


id: UI\Area::scrollTo
type: function
doc:
<comment>Description:</comment>
  Area Scroll
  
  Scroll this Area

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$point</strong>  The point to scroll to
  <info>UI\Size</info>   <strong>$size</strong>   The size of the scroll pane


id: UI\Area::setSize
type: function
doc:
<comment>Description:</comment>
  Set Size
  
  Sets the size of this Area

<comment>Param:</comment>
  <info>UI\Size</info>  <strong>$size</strong>  The new size


id: UI\Control::getParent
type: function
doc:
<comment>Description:</comment>
  Get Parent Control
  
  Shall return the parent Control

<comment>Return:</comment>
  <info>UI\Control</info>  


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

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


id: UI\Control::isEnabled
type: function
doc:
<comment>Description:</comment>
  Determine if Control is enabled
  
  Shall detect if this Control is enabled

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


id: UI\Control::isVisible
type: function
doc:
<comment>Description:</comment>
  Determine if Control is visible
  
  Shall detect if this Control is visible

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


id: UI\Control::setParent
type: function
doc:
<comment>Description:</comment>
  Set Parent Control
  
  Shall set the parent Control of this Control

<comment>Param:</comment>
  <info>UI\Control</info>  <strong>$parent</strong>  The parent Control


id: UI\Controls\Box::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Box
  
  Shall construct a new box

<comment>Param:</comment>
  <info>int</info>  <strong>$orientation</strong>  Box::Horizontal or Box::Vertical


id: UI\Controls\Box::append
type: function
doc:
<comment>Description:</comment>
  Append Control
  
  Shall append the given control to this Box

<comment>Param:</comment>
  <info>Control</info>  <strong>$control</strong>   The control to append
  <info>bool</info>     <strong>$stretchy</strong>  Set true to stretch the control

<comment>Return:</comment>
  <info>int</info>  Shall return the index of the appended control, may be 0


id: UI\Controls\Box::delete
type: function
doc:
<comment>Description:</comment>
  Delete Control
  
  Shall delete the control at the given index from this Box

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  The index of the control to delete

<comment>Return:</comment>
  <info>bool</info>  Indication of success


id: UI\Controls\Box::getOrientation
type: function
doc:
<comment>Description:</comment>
  Get Orientation
  
  Shall retrieve the orientation of this Box

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


id: UI\Controls\Box::isPadded
type: function
doc:
<comment>Description:</comment>
  Padding Detection
  
  Shall detect if padding is enabled on this Box

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


id: UI\Controls\Box::setPadded
type: function
doc:
<comment>Description:</comment>
  Set Padding
  
  Shall enable or disable padding on this Box

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


id: UI\Controls\Button::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Button
  
  Shall construct a new Button

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  The text (label) for this Button


id: UI\Controls\Button::getText
type: function
doc:
<comment>Description:</comment>
  Get Text
  
  Shall retrieve the text (label) for this Button

<comment>Return:</comment>
  <info>string</info>  The current text (label)


id: UI\Controls\Button::setText
type: function
doc:
<comment>Description:</comment>
  Set Text
  
  Shall set the text (label) for this Button

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  The new text (label)


id: UI\Controls\Check::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Check
  
  Shall construct a new Check

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  The text (label) for the Check box


id: UI\Controls\Check::getText
type: function
doc:
<comment>Description:</comment>
  Get Text
  
  Shall return the text (label) for this Check

<comment>Return:</comment>
  <info>string</info>  The current text (label)


id: UI\Controls\Check::isChecked
type: function
doc:
<comment>Description:</comment>
  Checked Detection
  
  Shall detect the status of this Check

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


id: UI\Controls\Check::onToggle
type: function
doc:
<comment>Description:</comment>
  Toggle Callback
  
  Shall be executed when the status of this Check is changed


id: UI\Controls\Check::setChecked
type: function
doc:
<comment>Description:</comment>
  Set Checked
  
  Shall change the status of this Check

<comment>Param:</comment>
  <info>bool</info>  <strong>$checked</strong>  The new status


id: UI\Controls\Check::setText
type: function
doc:
<comment>Description:</comment>
  Set Text
  
  Shall set the text (label) for this Check

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  The new text (label)


id: UI\Controls\ColorButton
type: class
doc:
<comment>Description:</comment>
  A Color Button is a button which displays a color picker when clicked


id: UI\Controls\ColorButton::getColor
type: function
doc:
<comment>Description:</comment>
  Get Color
  
  Shall retrieve the currently selected Color

<comment>Return:</comment>
  <info>UI\Color</info>  


id: UI\Controls\ColorButton::onChange
type: function
doc:
<comment>Description:</comment>
  Change Handler
  
  Shall be executed when the selected Color is changed


id: UI\Controls\ColorButton::setColor
type: function
doc:
<comment>Description:</comment>
  Set Color
  
  Shall set the currently selected Color

<comment>Param:</comment>
  <info>UI\Draw\Color</info>  <strong>$color</strong>  The new color


id: UI\Controls\Combo
type: class
doc:
<comment>Description:</comment>
  A Combo control represents a list of options, like the familiar select HTML element.


id: UI\Controls\Combo::append
type: function
doc:
<comment>Description:</comment>
  Append Option
  
  Append an option to this Combo

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  The text for the new option


id: UI\Controls\Combo::getSelected
type: function
doc:
<comment>Description:</comment>
  Get Selected Option
  
  Shall retrieve the index of the option selected in this Combo

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


id: UI\Controls\Combo::onSelected
type: function
doc:
<comment>Description:</comment>
  Selected Handler
  
  Shall be executed when an option is selected in this Combo


id: UI\Controls\Combo::setSelected
type: function
doc:
<comment>Description:</comment>
  Set Selected Option
  
  Shall set the currently selected option in this Combo

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  The index of the option to select


id: UI\Controls\EditableCombo
type: class
doc:
<comment>Description:</comment>
  An Editable Combo is a Combo which allows the user to enter custom options


id: UI\Controls\EditableCombo::append
type: function
doc:
<comment>Description:</comment>
  Append Option
  
  Shall append a new option to this Editable Combo

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  The text for the new option


id: UI\Controls\EditableCombo::getText
type: function
doc:
<comment>Description:</comment>
  Get Text
  
  Get the value of the currently selected option in this Editable Combo

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


id: UI\Controls\EditableCombo::onChange
type: function
doc:
<comment>Description:</comment>
  Change Handler
  
  Shall be executed when the value of this Editable Combobox changes


id: UI\Controls\EditableCombo::setText
type: function
doc:
<comment>Description:</comment>
  Set Text
  
  Shall set the text of the currently selected option in this Editable Combo

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  The new text


id: UI\Controls\Entry
type: class
doc:
<comment>Description:</comment>
  An Entry is a text entry control, suitable for entering plain text, passwords, or search terms.


id: UI\Controls\Entry::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Entry
  
  Construct a new entry of the given type

<comment>Param:</comment>
  <info>int</info>  <strong>$type</strong>  Entry::Normal, Entry::Password, or Entry::Search


id: UI\Controls\Entry::getText
type: function
doc:
<comment>Description:</comment>
  Get Text
  
  Shall return the current text from this Entry

<comment>Return:</comment>
  <info>string</info>  The current text


id: UI\Controls\Entry::isReadOnly
type: function
doc:
<comment>Description:</comment>
  Detect Read Only
  
  Shall detect if this Entry is read only

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


id: UI\Controls\Entry::onChange
type: function
doc:
<comment>Description:</comment>
  Change Handler
  
  Shall be executed when the text in this Entry changes


id: UI\Controls\Entry::setReadOnly
type: function
doc:
<comment>Description:</comment>
  Set Read Only
  
  Shall enable or disable read only for this Entry

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


id: UI\Controls\Entry::setText
type: function
doc:
<comment>Description:</comment>
  Set Text
  
  Shall set the text for this Entry

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  The new text


id: UI\Controls\Form
type: class
doc:
<comment>Description:</comment>
  A Form is a control which allows the arrangement of other controls into a familiar layout (the
  form).


id: UI\Controls\Form::append
type: function
doc:
<comment>Description:</comment>
  Append Control
  
  Shall append the control to the form, and set the label

<comment>Param:</comment>
  <info>string</info>      <strong>$label</strong>     The text for the label
  <info>UI\Control</info>  <strong>$control</strong>   A control
  <info>bool</info>        <strong>$stretchy</strong>  Should be set true to stretch the control

<comment>Return:</comment>
  <info>int</info>  Shall return the index of the appended control, may be 0


id: UI\Controls\Form::delete
type: function
doc:
<comment>Description:</comment>
  Delete Control
  
  Shall delete the control at the given index in this Form

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  The index of the control to remove

<comment>Return:</comment>
  <info>bool</info>  Indication of succcess


id: UI\Controls\Form::isPadded
type: function
doc:
<comment>Description:</comment>
  Padding Detection
  
  Shall detect if padding is enabled on this Form

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


id: UI\Controls\Form::setPadded
type: function
doc:
<comment>Description:</comment>
  Set Padding
  
  Shall enable or disable padding on this Form

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


id: UI\Controls\Grid
type: class
doc:
<comment>Description:</comment>
  A Grid is a control which is allows the arrangement of children into a grid


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

<comment>Param:</comment>
  <info>UI\Control</info>  <strong>$control</strong>  The Control to append
  <info>int</info>         <strong>$left</strong>     
  <info>int</info>         <strong>$top</strong>      
  <info>int</info>         <strong>$xspan</strong>    
  <info>int</info>         <strong>$yspan</strong>    
  <info>bool</info>        <strong>$hexpand</strong>  
  <info>int</info>         <strong>$halign</strong>   
  <info>bool</info>        <strong>$vexpand</strong>  
  <info>int</info>         <strong>$valign</strong>   


id: UI\Controls\Grid::isPadded
type: function
doc:
<comment>Description:</comment>
  Padding Detection
  
  Shall detect if padding is enabled on this Grid

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


id: UI\Controls\Grid::setPadded
type: function
doc:
<comment>Description:</comment>
  Set Padding
  
  Shall enable or disable padding for this Grid

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


id: UI\Controls\Group::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Group
  
  Shall construct a new Group with the given title

<comment>Param:</comment>
  <info>string</info>  <strong>$title</strong>  The text for the title label


id: UI\Controls\Group::append
type: function
doc:
<comment>Description:</comment>
  Append Control
  
  Shall append a control to this Group

<comment>Param:</comment>
  <info>UI\Control</info>  <strong>$control</strong>  The control to append


id: UI\Controls\Group::getTitle
type: function
doc:
<comment>Description:</comment>
  Get Title
  
  Shall return the current title for this Group

<comment>Return:</comment>
  <info>string</info>  The current title


id: UI\Controls\Group::hasMargin
type: function
doc:
<comment>Description:</comment>
  Margin Detection
  
  Shall detect if this Group has a margin

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


id: UI\Controls\Group::setMargin
type: function
doc:
<comment>Description:</comment>
  Set Margin
  
  Shall enable or disable margins for this Group

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


id: UI\Controls\Group::setTitle
type: function
doc:
<comment>Description:</comment>
  Set Title
  
  Shall set the title for this Group

<comment>Param:</comment>
  <info>string</info>  <strong>$title</strong>  The text for the new title


id: UI\Controls\Label
type: class
doc:
<comment>Description:</comment>
  A Label is a single line of text, meant to identify, for the user, some element of the interface.


id: UI\Controls\Label::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Label
  
  Shall construct a new Label

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  The text for this label


id: UI\Controls\Label::getText
type: function
doc:
<comment>Description:</comment>
  Get Text
  
  Shall return the current text for this Label
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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


id: UI\Controls\Label::setText
type: function
doc:
<comment>Description:</comment>
  Set Text
  
  Shall set the text for this Label

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  The new text


id: UI\Controls\MultilineEntry
type: class
doc:
<comment>Description:</comment>
  A Multiline Entry is a text entry control able to hold multiple lines of text, with or without
  wrapping.


id: UI\Controls\MultilineEntry::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Multiline Entry
  
  Shall construct a new Multiline Entry of the given type

<comment>Param:</comment>
  <info>int</info>  <strong>$type</strong>  MultilineEntry::Wrap or MultilineEntry::NoWrap


id: UI\Controls\MultilineEntry::append
type: function
doc:
<comment>Description:</comment>
  Append Text
  
  Shall append the given text to the text in this Multiline Entry

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  The text to append


id: UI\Controls\MultilineEntry::getText
type: function
doc:
<comment>Description:</comment>
  Get Text
  
  Shall return the text in this Multiline Entry

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


id: UI\Controls\MultilineEntry::isReadOnly
type: function
doc:
<comment>Description:</comment>
  Read Only Detection
  
  Shall detect if this Multiline Entry is read only

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


id: UI\Controls\MultilineEntry::onChange
type: function
doc:
<comment>Description:</comment>
  Change Handler
  
  Shall be executed when the text in this Multiline Entry is changed


id: UI\Controls\MultilineEntry::setReadOnly
type: function
doc:
<comment>Description:</comment>
  Set Read Only
  
  Shall enable or disable read only on this Multiline Entry

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


id: UI\Controls\MultilineEntry::setText
type: function
doc:
<comment>Description:</comment>
  Set Text
  
  Shall set the text in this Multiline Entry

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  The new text


id: UI\Controls\Picker
type: class
doc:
<comment>Description:</comment>
  A Picker represents a button which when clicked presents a native Date/Time/DateTime Picker
  interface to the user.


id: UI\Controls\Picker::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Picker
  
  Construct a new Picker of the given type

<comment>Param:</comment>
  <info>int</info>  <strong>$type</strong>  Picker::Date, Picker::Time, or Picker::DateTime


id: UI\Controls\Progress
type: class
doc:
<comment>Description:</comment>
  A Progress control is a familiar Progress bar: It represents progress as a percentage, with a
  possible range of 0 to 100 (inclusive).


id: UI\Controls\Progress::getValue
type: function
doc:
<comment>Description:</comment>
  Get Value
  
  Shall retrieve the current value of this Progress bar

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


id: UI\Controls\Progress::setValue
type: function
doc:
<comment>Description:</comment>
  Set Value
  
  Shall set the value for this Progress bar

<comment>Param:</comment>
  <info>int</info>  <strong>$value</strong>  An integer between 0 and 100 (inclusive)


id: UI\Controls\Radio::append
type: function
doc:
<comment>Description:</comment>
  Append Option
  
  Shall append a new option to this Radio

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  The text (label) for the option


id: UI\Controls\Radio::getSelected
type: function
doc:
<comment>Description:</comment>
  Get Selected Option
  
  Shall retrieve the index of the currently selected option in this Radio

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


id: UI\Controls\Radio::onSelected
type: function
doc:
<comment>Description:</comment>
  Selected Handler
  
  Shall be executed when the option selected in this Radio changes


id: UI\Controls\Radio::setSelected
type: function
doc:
<comment>Description:</comment>
  Set Selected Option
  
  Shall set the currently selected option in this Radio

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  The index of the option to select


id: UI\Controls\Separator
type: class
doc:
<comment>Description:</comment>
  A Separator represents a control separator, it has no other function.


id: UI\Controls\Separator::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Separator
  
  Shall construct a new Separator of the given type

<comment>Param:</comment>
  <info>int</info>  <strong>$type</strong>  Separator::Horizonal or Separator::Vertical


id: UI\Controls\Slider
type: class
doc:
<comment>Description:</comment>
  A Slider is a control which represents a range, and a current value in the range. The sliding
  element of the control (sometimes called the "thumb") reflects the value, and can be adjusted
  within the range.


id: UI\Controls\Slider::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Slider
  
  Construct a new Slider with the given range

<comment>Param:</comment>
  <info>int</info>  <strong>$min</strong>  The minimum allowed value
  <info>int</info>  <strong>$max</strong>  The maximum allowed value


id: UI\Controls\Slider::getValue
type: function
doc:
<comment>Description:</comment>
  Get Value
  
  Get the value from this Slider

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


id: UI\Controls\Slider::onChange
type: function
doc:
<comment>Description:</comment>
  Change Handler
  
  Shall be executed when the value of this Slider changes


id: UI\Controls\Slider::setValue
type: function
doc:
<comment>Description:</comment>
  Set Value
  
  Shall set the value for this Slider

<comment>Param:</comment>
  <info>int</info>  <strong>$value</strong>  The new value


id: UI\Controls\Spin
type: class
doc:
<comment>Description:</comment>
  A Spin box is a text box with an up-down control which changes the integer value in the box,
  within a defined range


id: UI\Controls\Spin::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Spin
  
  Constructs a new Spin with the given range

<comment>Param:</comment>
  <info>int</info>  <strong>$min</strong>  The minimum value allowed
  <info>int</info>  <strong>$max</strong>  The maximum value allowed


id: UI\Controls\Spin::getValue
type: function
doc:
<comment>Description:</comment>
  Get Value
  
  Get the value in this Spin

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


id: UI\Controls\Spin::onChange
type: function
doc:
<comment>Description:</comment>
  Change Handler
  
  Shall be executed when the value in this Spin changes


id: UI\Controls\Spin::setValue
type: function
doc:
<comment>Description:</comment>
  Set Value
  
  Set the value in this Spin

<comment>Param:</comment>
  <info>int</info>  <strong>$value</strong>  The new value


id: UI\Controls\Tab
type: class
doc:
<comment>Description:</comment>
  A Tab can contain many pages of Controls, each with a title, each selectable by the user.


id: UI\Controls\Tab::append
type: function
doc:
<comment>Description:</comment>
  Append Page
  
  Append a new page to this Tab

<comment>Param:</comment>
  <info>string</info>      <strong>$name</strong>     The name for the new page
  <info>UI\Control</info>  <strong>$control</strong>  The control for the new page

<comment>Return:</comment>
  <info>int</info>  Shall return the index of the appended control, may be 0


id: UI\Controls\Tab::delete
type: function
doc:
<comment>Description:</comment>
  Delete Page
  
  Shall remove the selected page from this Tab

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  The index of the page to remove

<comment>Return:</comment>
  <info>bool</info>  Indication of success


id: UI\Controls\Tab::hasMargin
type: function
doc:
<comment>Description:</comment>
  Margin Detection
  
  Shall detect if the given page has a margin.

<comment>Param:</comment>
  <info>int</info>  <strong>$page</strong>  The index of the page

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


id: UI\Controls\Tab::insertAt
type: function
doc:
<comment>Description:</comment>
  Insert Page
  
  Shall insert a new page into this Tab

<comment>Param:</comment>
  <info>string</info>      <strong>$name</strong>     The name for the new page
  <info>int</info>         <strong>$page</strong>     The index to perform the insertion before
  <info>UI\Control</info>  <strong>$control</strong>  The control for the new page


id: UI\Controls\Tab::pages
type: function
doc:
<comment>Description:</comment>
  Page Count
  
  Shall return the number of pages in this Tab

<comment>Return:</comment>
  <info>int</info>  The number of pages in this Tab


id: UI\Controls\Tab::setMargin
type: function
doc:
<comment>Description:</comment>
  Set Margin
  
  Shall enable or disable margins on the selected page

<comment>Param:</comment>
  <info>int</info>   <strong>$page</strong>    The page to select
  <info>bool</info>  <strong>$margin</strong>  Margin switch


id: UI\Draw\Brush::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Brush
  
  Shall construct a solid brush using the given color

<comment>Param:</comment>
  <info>UI\Draw\Color</info>  <strong>$color</strong>  Can be a UI\Draw\Color or RRGGBBAA


id: UI\Draw\Brush::getColor
type: function
doc:
<comment>Description:</comment>
  Get Color
  
  Shall return a UI\Draw\Color for this brush

<comment>Return:</comment>
  <info>UI\Draw\Color</info>  The current color of the brush


id: UI\Draw\Brush::setColor
type: function
doc:
<comment>Description:</comment>
  Set Color
  
  Shall set the color of this brush to the color provided

<comment>Param:</comment>
  <info>UI\Draw\Color</info>  <strong>$color</strong>  Can be a UI\Draw\Color or RRGGBBAA

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


id: UI\Draw\Brush\Gradient::addStop
type: function
doc:
<comment>Description:</comment>
  Stop Manipulation
  
  Shall at a stop of the given color at the given position

<comment>Param:</comment>
  <info>float</info>          <strong>$position</strong>  The position for the new stop
  <info>UI\Draw\Color</info>  <strong>$color</strong>     The color for the new stop, may be UI\Draw\Color or RRGGBBAA

<comment>Return:</comment>
  <info>int</info>  Total number of stops


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

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

<comment>Return:</comment>
  <info>int</info>  Total number of stops


id: UI\Draw\Brush\Gradient::setStop
type: function
doc:
<comment>Description:</comment>
  Stop Manipulation

<comment>Param:</comment>
  <info>int</info>            <strong>$index</strong>     The index of the stop to set
  <info>float</info>          <strong>$position</strong>  The position for the stop
  <info>UI\Draw\Color</info>  <strong>$color</strong>     The color for the stop, may be UI\Draw\Color or RRGGBBAA

<comment>Return:</comment>
  <info>bool</info>  Indication of success


id: UI\Draw\Brush\LinearGradient::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a Linear Gradient
  
  Shall construct a new linear gradient

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$start</strong>  
  <info>UI\Point</info>  <strong>$end</strong>    


id: UI\Draw\Brush\RadialGradient::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Radial Gradient
  
  Shall construct a new radial gradient

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$start</strong>   
  <info>UI\Point</info>  <strong>$outer</strong>   
  <info>float</info>     <strong>$radius</strong>  


id: UI\Draw\Color
type: class
doc:
<comment>Description:</comment>
  Represents RGBA colours, individual channels are accessible via public properties.


id: UI\Draw\Color::__construct
type: function
doc:
<comment>Description:</comment>
  Construct new Color
  
  Shall construct a new color

<comment>Param:</comment>
  <info>UI\Draw\Color</info>  <strong>$color</strong>  May be UI\Draw\Color or RRGGBBAA


id: UI\Draw\Color::getChannel
type: function
doc:
<comment>Description:</comment>
  Color Manipulation
  
  Shall retrieve the value for a channel

<comment>Param:</comment>
  <info>int</info>  <strong>$channel</strong>  Constant channel identity

<comment>Return:</comment>
  <info>float</info>  The current value of the requested channel


id: UI\Draw\Color::setChannel
type: function
doc:
<comment>Description:</comment>
  Color Manipulation
  
  Shall set the selected channel to the given value

<comment>Param:</comment>
  <info>int</info>    <strong>$channel</strong>  Constant channel identity
  <info>float</info>  <strong>$value</strong>    The new value for the selected channel

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


id: UI\Draw\Matrix::isInvertible
type: function
doc:
<comment>Description:</comment>
  Invertible Detection
  
  Shall detect if this Matrix may be inverted

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


id: UI\Draw\Matrix::multiply
type: function
doc:
<comment>Description:</comment>
  Multiply Matrix
  
  Shall multiply this matrix with the given matrix

<comment>Return:</comment>
  <info>UI\Draw\Matrix</info>  The new Matrix


id: UI\Draw\Matrix::rotate
type: function
doc:
<comment>Description:</comment>
  Rotate Matrix
  
  Shall rotate this Matrix

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$point</strong>   
  <info>float</info>     <strong>$amount</strong>  


id: UI\Draw\Matrix::scale
type: function
doc:
<comment>Description:</comment>
  Scale Matrix
  
  Shall scale this Matrix

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$center</strong>  
  <info>UI\Point</info>  <strong>$point</strong>   


id: UI\Draw\Matrix::skew
type: function
doc:
<comment>Description:</comment>
  Skew Matrix
  
  Shall skew this Matrix

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$point</strong>   
  <info>UI\Point</info>  <strong>$amount</strong>  


id: UI\Draw\Matrix::translate
type: function
doc:
<comment>Description:</comment>
  Translate Matrix
  
  Shall translate this Matrix

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$point</strong>  


id: UI\Draw\Path
type: class
doc:
<comment>Description:</comment>
  A Draw Path guides a Draw Pen, telling the Pen where to draw on an Area.


id: UI\Draw\Path::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Path
  
  Shall construct a new path in the given mode

<comment>Param:</comment>
  <info>int</info>  <strong>$mode</strong>  Path::Winding or Path::Alternate


id: UI\Draw\Path::addRectangle
type: function
doc:
<comment>Description:</comment>
  Draw a Rectangle
  
  Shall map the path of a rectangle of the given size, at the given point

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$point</strong>  The point to begin the shape
  <info>UI\Size</info>   <strong>$size</strong>   The size of the rectangle


id: UI\Draw\Path::arcTo
type: function
doc:
<comment>Description:</comment>
  Draw an Arc
  
  Shall map the path for an arc

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$point</strong>     The point to begin mapping
  <info>float</info>     <strong>$radius</strong>    The radius of the arc
  <info>float</info>     <strong>$angle</strong>     The angle of the arc
  <info>float</info>     <strong>$sweep</strong>     The sweep of the arc
  <info>float</info>     <strong>$negative</strong>  


id: UI\Draw\Path::bezierTo
type: function
doc:
<comment>Description:</comment>
  Draw Bezier Curve
  
  Shall draw a bezier curve

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$point</strong>     The point at which to begin mapping
  <info>float</info>     <strong>$radius</strong>    The radius of the curve
  <info>float</info>     <strong>$angle</strong>     The angle of the curve
  <info>float</info>     <strong>$sweep</strong>     The sweep of the curve
  <info>float</info>     <strong>$negative</strong>  


id: UI\Draw\Path::lineTo
type: function
doc:
<comment>Description:</comment>
  Draw a Line
  
  Shall map the path for a line

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$point</strong>     The point to begin mapping
  <info>float</info>     <strong>$radius</strong>    
  <info>float</info>     <strong>$angle</strong>     
  <info>float</info>     <strong>$sweep</strong>     
  <info>float</info>     <strong>$negative</strong>  


id: UI\Draw\Path::newFigure
type: function
doc:
<comment>Description:</comment>
  Draw Figure
  
  Shall map a new figure at the given point

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$point</strong>  The point to begin mapping


id: UI\Draw\Path::newFigureWithArc
type: function
doc:
<comment>Description:</comment>
  Draw Figure with Arc

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$point</strong>     
  <info>float</info>     <strong>$radius</strong>    
  <info>float</info>     <strong>$angle</strong>     
  <info>float</info>     <strong>$sweep</strong>     
  <info>float</info>     <strong>$negative</strong>  


id: UI\Draw\Pen
type: class
doc:
<comment>Description:</comment>
  The Pen is passed to the Area Draw event handler, it is used for clipping, filling, stroking, and
  writing to Draw Paths.


id: UI\Draw\Pen::clip
type: function
doc:
<comment>Description:</comment>
  Clip a Path
  
  Shall clip the given Path

<comment>Param:</comment>
  <info>UI\Draw\Path</info>  <strong>$path</strong>  The path to clip


id: UI\Draw\Pen::fill
type: function
doc:
<comment>Description:</comment>
  Fill a Path
  
  Shall fill the given path

<comment>Param:</comment>
  <info>UI\Draw\Path</info>   <strong>$path</strong>  The path to fill
  <info>UI\Draw\Brush</info>  <strong>$with</strong>  The color or brush to fill with


id: UI\Draw\Pen::stroke
type: function
doc:
<comment>Description:</comment>
  Stroke a Path
  
  Shall stroke the given path

<comment>Param:</comment>
  <info>UI\Draw\Path</info>    <strong>$path</strong>    The path to stroke
  <info>UI\Draw\Brush</info>   <strong>$with</strong>    The color or brush to stroke with
  <info>UI\Draw\Stroke</info>  <strong>$stroke</strong>  The configuration of the stroke


id: UI\Draw\Pen::transform
type: function
doc:
<comment>Description:</comment>
  Matrix Transform
  
  Shall perform matrix transformation

<comment>Param:</comment>
  <info>UI\Draw\Matrix</info>  <strong>$matrix</strong>  The matrix to use


id: UI\Draw\Pen::write
type: function
doc:
<comment>Description:</comment>
  Draw Text at Point
  
  Shall draw the given text layout at the given point

<comment>Param:</comment>
  <info>UI\Point</info>             <strong>$point</strong>   The point to perform the drawing
  <info>UI\Draw\Text\Layout</info>  <strong>$layout</strong>  The layout of the text to draw


id: UI\Draw\Stroke::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Stroke
  
  Shall construct a new Stroke

<comment>Param:</comment>
  <info>int</info>    <strong>$cap</strong>         UI\Draw\Line\Cap::Flat, UI\Draw\Line\Cap::Round, or UI\Draw\Line\Cap::Square
  <info>int</info>    <strong>$join</strong>        UI\Draw\Line\Join::Miter, UI\Draw\Line\Join::Round, or
                      UI\Draw\Line\Join::Bevel
  <info>float</info>  <strong>$thickness</strong>   The thickness of the stroke
  <info>float</info>  <strong>$miterLimit</strong>  Miter limit (default is sensible for all supported platforms)


id: UI\Draw\Stroke::getCap
type: function
doc:
<comment>Description:</comment>
  Get Line Cap
  
  Shall retrieve the line cap setting of this Stroke

<comment>Return:</comment>
  <info>int</info>  UI\Draw\Line\Cap::Flat, UI\Draw\Line\Cap::Round, or UI\Draw\Line\Cap::Square


id: UI\Draw\Stroke::getJoin
type: function
doc:
<comment>Description:</comment>
  Get Line Join
  
  Shall retrieve the line join setting of this Stroke

<comment>Return:</comment>
  <info>int</info>  UI\Draw\Line\Join::Miter, UI\Draw\Line\Join::Round, or UI\Draw\Line\Join::Bevel


id: UI\Draw\Stroke::getMiterLimit
type: function
doc:
<comment>Description:</comment>
  Get Miter Limit
  
  Shall retrieve the miter limit of this Stroke

<comment>Return:</comment>
  <info>float</info>  The current miter limit


id: UI\Draw\Stroke::getThickness
type: function
doc:
<comment>Description:</comment>
  Get Thickness
  
  Shall retrieve the thickness of this Stroke

<comment>Return:</comment>
  <info>float</info>  The current thickness


id: UI\Draw\Stroke::setCap
type: function
doc:
<comment>Description:</comment>
  Set Line Cap
  
  Shall set the line cap setting for this Stroke

<comment>Param:</comment>
  <info>int</info>  <strong>$cap</strong>  UI\Draw\Line\Cap::Flat, UI\Draw\Line\Cap::Round, or UI\Draw\Line\Cap::Square


id: UI\Draw\Stroke::setJoin
type: function
doc:
<comment>Description:</comment>
  Set Line Join
  
  Shall set the line join setting for this Stroke

<comment>Param:</comment>
  <info>int</info>  <strong>$join</strong>  UI\Draw\Line\Join::Miter, UI\Draw\Line\Join::Round, or UI\Draw\Line\Join::Bevel


id: UI\Draw\Stroke::setMiterLimit
type: function
doc:
<comment>Description:</comment>
  Set Miter Limit
  
  Set the miter limit for this Stroke

<comment>Param:</comment>
  <info>float</info>  <strong>$limit</strong>  The new limit


id: UI\Draw\Stroke::setThickness
type: function
doc:
<comment>Description:</comment>
  Set Thickness
  
  Shall set the thickness for this Stroke

<comment>Param:</comment>
  <info>float</info>  <strong>$thickness</strong>  The new thickness


id: UI\Draw\Text\Font::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Font
  
  Shall construct a new Font using the given descriptor

<comment>Param:</comment>
  <info>UI\Draw\Text\Font\Descriptor</info>  <strong>$descriptor</strong>  The descriptor for the Font


id: UI\Draw\Text\Font\Descriptor::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Font Descriptor
  
  Shall construct a new Font Descriptor

<comment>Param:</comment>
  <info>string</info>  <strong>$family</strong>   The name of a valid family of fonts
  <info>float</info>   <strong>$size</strong>     The preferred size
  <info>int</info>     <strong>$weight</strong>   UI\Draw\Text\Font\Weight constant
  <info>int</info>     <strong>$italic</strong>   UI\Draw\Text\Font\Italic constant
  <info>int</info>     <strong>$stretch</strong>  UI\Draw\Text\Font\Stretch constant


id: UI\Draw\Text\Font\Descriptor::getFamily
type: function
doc:
<comment>Description:</comment>
  Get Font Family
  
  Shall return the requested font family

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


id: UI\Draw\Text\Font\Descriptor::getItalic
type: function
doc:
<comment>Description:</comment>
  Style Detection
  
  Shall return constant setting

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


id: UI\Draw\Text\Font\Descriptor::getSize
type: function
doc:
<comment>Description:</comment>
  Size Detection
  
  Shall return the requested size

<comment>Return:</comment>
  <info>float</info>  


id: UI\Draw\Text\Font\Descriptor::getStretch
type: function
doc:
<comment>Description:</comment>
  Style Detection
  
  Shall return requested stretch

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


id: UI\Draw\Text\Font\Descriptor::getWeight
type: function
doc:
<comment>Description:</comment>
  Weight Detection
  
  Shall return requested weight

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


id: UI\Draw\Text\Font\fontFamilies
type: function
doc:
<comment>Description:</comment>
  Retrieve Font Families
  
  Returns an array of valid font families for the current system

<comment>Return:</comment>
  <info>array</info>  Returns an <info>array</info> of valid font families for the current system.


id: UI\Draw\Text\Layout
type: class
doc:
<comment>Description:</comment>
  A Text Layout represents the layout of text which will be drawn by the Pen


id: UI\Draw\Text\Layout::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Text Layout
  
  Shall construct a new Text Layout

<comment>Param:</comment>
  <info>string</info>             <strong>$text</strong>   The text for the layout
  <info>UI\Draw\Text\Font</info>  <strong>$font</strong>   The font to use for writing
  <info>float</info>              <strong>$width</strong>  The width of the layout


id: UI\Draw\Text\Layout::setColor
type: function
doc:
<comment>Description:</comment>
  Set Color
  
  Shall set the Color for all of, or a range of the text in the Layout

<comment>Param:</comment>
  <info>UI\Draw\Color</info>  <strong>$color</strong>  The color to use
  <info>int</info>            <strong>$start</strong>  The starting character
  <info>int</info>            <strong>$end</strong>    The ending character, by default the end of the string


id: UI\Draw\Text\Layout::setWidth
type: function
doc:
<comment>Description:</comment>
  Set Width
  
  Shall set the width of this Text Layout

<comment>Param:</comment>
  <info>float</info>  <strong>$width</strong>  The new width


id: UI\Executor
type: class
doc:
<comment>Description:</comment>
  This facility schedules repetitive execution of a callback, useful for animations and other such
  activities.


id: UI\Executor::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Executor
  
  Shall construct an executor with the given interval, will not start executing until main loop is
  entered

<comment>Param:</comment>
  <info>int</info>  <strong>$seconds</strong>       Seconds between executions
  <info>int</info>  <strong>$microseconds</strong>  Microseconds between executions


id: UI\Executor::kill
type: function
doc:
<comment>Description:</comment>
  Stop Executor
  
  Shall stop an executor, the executor cannot be restarted

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


id: UI\Executor::onExecute
type: function
doc:
<comment>Description:</comment>
  Execution Callback
  
  Shall be repetitively queued for execution in the main thread

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


id: UI\Executor::setInterval
type: function
doc:
<comment>Description:</comment>
  Interval Manipulation
  
  Shall set the new interval. An interval of 0 will pause the executor until a new interval has been
  set

<comment>Param:</comment>
  <info>int</info>  <strong>$seconds</strong>       
  <info>int</info>  <strong>$microseconds</strong>  

<comment>Return:</comment>
  <info>bool</info>  Indication of success


id: UI\Menu
type: class
doc:
<comment>Description:</comment>
  Menus must be constructed before the first Window, and can be shown on any Window


id: UI\Menu::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Menu
  
  Shall construct a new Menu

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  The name (text) for the menu


id: UI\Menu::append
type: function
doc:
<comment>Description:</comment>
  Append Menu Item
  
  Shall append a new Menu Item

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  The name (text) for the new item
  <info>string</info>  <strong>$type</strong>  The type for the new item

<comment>Return:</comment>
  <info>UI\MenuItem</info>  A constructed object of the given type


id: UI\Menu::appendAbout
type: function
doc:
<comment>Description:</comment>
  Append About Menu Item
  
  Shall append an About menu item

<comment>Param:</comment>
  <info>string</info>  <strong>$type</strong>  The type for the new item

<comment>Return:</comment>
  <info>UI\MenuItem</info>  A constructed About menu item of the given type


id: UI\Menu::appendCheck
type: function
doc:
<comment>Description:</comment>
  Append Checkable Menu Item
  
  Shall append a checkable menu item

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  The name (text) for the new item
  <info>string</info>  <strong>$type</strong>  The type for the new item

<comment>Return:</comment>
  <info>UI\MenuItem</info>  A constructed checkable menu item of the given type


id: UI\Menu::appendPreferences
type: function
doc:
<comment>Description:</comment>
  Append Preferences Menu Item
  
  Shall append a Preferences menu item

<comment>Param:</comment>
  <info>string</info>  <strong>$type</strong>  The type for the new item

<comment>Return:</comment>
  <info>UI\MenuItem</info>  A constructed Preferences menu item of the given type


id: UI\Menu::appendQuit
type: function
doc:
<comment>Description:</comment>
  Append Quit Menu Item
  
  Shall append a Quit menu item

<comment>Param:</comment>
  <info>string</info>  <strong>$type</strong>  The type for the new item

<comment>Return:</comment>
  <info>UI\MenuItem</info>  A constructed Quit menu item of the given type


id: UI\MenuItem::isChecked
type: function
doc:
<comment>Description:</comment>
  Detect Checked
  
  Shall detect if this Menu Item is checked

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


id: UI\MenuItem::onClick
type: function
doc:
<comment>Description:</comment>
  On Click Callback
  
  Shall be executed when this Menu Item is clicked


id: UI\MenuItem::setChecked
type: function
doc:
<comment>Description:</comment>
  Set Checked
  
  Shall set the checked status of this Menu Item

<comment>Param:</comment>
  <info>bool</info>  <strong>$checked</strong>  The new status


id: UI\Point
type: class
doc:
<comment>Description:</comment>
  Points are used throughout UI to represent co-ordinates on a screen, control, or area.


id: UI\Point::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Point
  
  Construct a new Point using new co-ordinates

<comment>Param:</comment>
  <info>float</info>  <strong>$x</strong>  The new X co-ordinate
  <info>float</info>  <strong>$y</strong>  The new Y co-ordinate


id: UI\Point::at
type: function
doc:
<comment>Description:</comment>
  Size Coercion
  
  Shall return a UI\Point object where x and y are equal to those supplied, either in float or
  UI\Size form

<comment>Param:</comment>
  <info>float</info>    <strong>$point</strong>  The value for x and y
  <info>UI\Size</info>  <strong>$size</strong>   The Size to convert

<comment>Return:</comment>
  <info>UI\Point</info>  The resulting Point


id: UI\Point::getX
type: function
doc:
<comment>Description:</comment>
  Retrieves X
  
  Retrieves the X co-ordinate

<comment>Return:</comment>
  <info>float</info>  The current X co-ordinate


id: UI\Point::getY
type: function
doc:
<comment>Description:</comment>
  Retrieves Y
  
  Retrieves the Y co-ordinate

<comment>Return:</comment>
  <info>float</info>  The current Y co-ordinate


id: UI\Point::setX
type: function
doc:
<comment>Description:</comment>
  Set X
  
  Set the X co-ordinate

<comment>Param:</comment>
  <info>float</info>  <strong>$point</strong>  The new X co-ordinate


id: UI\Point::setY
type: function
doc:
<comment>Description:</comment>
  Set Y
  
  Set the Y co-ordinate

<comment>Param:</comment>
  <info>float</info>  <strong>$point</strong>  The new Y co-ordinate


id: UI\Size
type: class
doc:
<comment>Description:</comment>
  Sizes are used throughout UI to represent the size of a screen, control, or area.


id: UI\Size::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Size
  
  Construct a new Size using new width and height

<comment>Param:</comment>
  <info>float</info>  <strong>$width</strong>   The new width
  <info>float</info>  <strong>$height</strong>  The new height


id: UI\Size::getHeight
type: function
doc:
<comment>Description:</comment>
  Retrieves Height
  
  Retrieves the Height

<comment>Return:</comment>
  <info>float</info>  The current Height


id: UI\Size::getWidth
type: function
doc:
<comment>Description:</comment>
  Retrives Width
  
  Retrieves the Width

<comment>Return:</comment>
  <info>float</info>  The current Width


id: UI\Size::of
type: function
doc:
<comment>Description:</comment>
  Point Coercion
  
  Shall return a UI\Size object where width and height are equal to those supplied, either in float
  or UI\Point form

<comment>Param:</comment>
  <info>float</info>     <strong>$size</strong>   The value for width and height
  <info>UI\Point</info>  <strong>$point</strong>  The Point to convert

<comment>Return:</comment>
  <info>UI\Size</info>  The resulting Size


id: UI\Size::setHeight
type: function
doc:
<comment>Description:</comment>
  Set Height
  
  Set new Height

<comment>Param:</comment>
  <info>float</info>  <strong>$size</strong>  The new Height


id: UI\Size::setWidth
type: function
doc:
<comment>Description:</comment>
  Set Width
  
  Set new Width

<comment>Param:</comment>
  <info>float</info>  <strong>$size</strong>  The new Width


id: UI\Window::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Window
  
  Shall construct a new Window

<comment>Param:</comment>
  <info>string</info>  <strong>$title</strong>  The title of the Window
  <info>Size</info>    <strong>$size</strong>   The size of the Window
  <info>bool</info>    <strong>$menu</strong>   Menu switch


id: UI\Window::add
type: function
doc:
<comment>Description:</comment>
  Add a Control
  
  Shall add a Control to this Window

<comment>Param:</comment>
  <info>UI\Control</info>  <strong>$control</strong>  The Control to add


id: UI\Window::error
type: function
doc:
<comment>Description:</comment>
  Show Error Box
  
  Shall show an error box

<comment>Param:</comment>
  <info>string</info>  <strong>$title</strong>  The title of the error box
  <info>string</info>  <strong>$msg</strong>    The message for the error box


id: UI\Window::getSize
type: function
doc:
<comment>Description:</comment>
  Get Window Size
  
  Shall return the size of this Window

<comment>Return:</comment>
  <info>UI\Size</info>  


id: UI\Window::getTitle
type: function
doc:
<comment>Description:</comment>
  Get Title
  
  Shall retrieve the title of this Window

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


id: UI\Window::hasBorders
type: function
doc:
<comment>Description:</comment>
  Border Detection
  
  Shall detect if borders are used on this Window

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


id: UI\Window::hasMargin
type: function
doc:
<comment>Description:</comment>
  Margin Detection
  
  Shall detect if margins are used on this Window

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


id: UI\Window::isFullScreen
type: function
doc:
<comment>Description:</comment>
  Full Screen Detection
  
  Shall detect if this Window us using the whole screen

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


id: UI\Window::msg
type: function
doc:
<comment>Description:</comment>
  Show Message Box
  
  Shall show a message box

<comment>Param:</comment>
  <info>string</info>  <strong>$title</strong>  The title of the message box
  <info>string</info>  <strong>$msg</strong>    The message


id: UI\Window::onClosing
type: function
doc:
<comment>Description:</comment>
  Closing Callback
  
  Should gracefully destroy this Window

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


id: UI\Window::open
type: function
doc:
<comment>Description:</comment>
  Open Dialog
  
  Shall show an open file dialog

<comment>Return:</comment>
  <info>string</info>  Returns the name of the file selected for opening


id: UI\Window::save
type: function
doc:
<comment>Description:</comment>
  Save Dialog
  
  Shall show a save dialog

<comment>Return:</comment>
  <info>string</info>  Returns the file name selecting for saving


id: UI\Window::setBorders
type: function
doc:
<comment>Description:</comment>
  Border Use
  
  Shall enable or disable the use of borders on this Window

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


id: UI\Window::setFullScreen
type: function
doc:
<comment>Description:</comment>
  Full Screen Use
  
  Shall enable or disable the use of the full screen for this Window
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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


id: UI\Window::setMargin
type: function
doc:
<comment>Description:</comment>
  Margin Use
  
  Shall enable or disable the use of margins for this Window

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


id: UI\Window::setSize
type: function
doc:
<comment>Description:</comment>
  Set Size
  
  Shall set the size of this Window

<comment>Param:</comment>
  <info>UI\Size</info>  <strong>$size</strong>  


id: UI\Window::setTitle
type: function
doc:
<comment>Description:</comment>
  Window Title
  
  Shall set the title for this Window

<comment>Param:</comment>
  <info>string</info>  <strong>$title</strong>  The new title


id: UI\quit
type: function
doc:
<comment>Description:</comment>
  Quit UI Loop
  
  Shall cause the main loop to be exited

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


id: UI\run
type: function
doc:
<comment>Description:</comment>
  Enter UI Loop
  
  Shall cause PHP to enter into the main loop, by default control will not be returned to the caller

<comment>Param:</comment>
  <info>int</info>  <strong>$flags</strong>  Set UI\Loop to return control, and UI\Wait to return control after waiting

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


id: UnitEnum
type: class
doc:
<comment>Description:</comment>
  <class>UnitEnum</class> インターフェイスは、 全ての列挙型に対して、PHP のエンジンが自動的に適用するものです。
  ユーザー定義のクラスとして実装してはいけません。 列挙型はメソッドのオーバーライドを禁止していま
  す。 デフォルトの実装は PHP のエンジンから提供されるからです。 このインターフェイスは、型チェック
  のためだけに存在しています。


id: UnitEnum::cases
type: function
doc:
<comment>Description:</comment>
  列挙型の case 一覧を生成する
  
  このメソッドは列挙型の全ての case を含む配列を返します。 要素は宣言された順に並びます。

<comment>Return:</comment>
  <info>array</info>  列挙型で定義されている全ての case を含む配列を返します。 要素は宣言された順に並びます。


id: V8Js
type: class
doc:
<comment>Description:</comment>
  これは V8Js 拡張モジュールのコアクラスです。 このクラスのインスタンスはそれぞれ個別のコンテキスト
  を持ち、 その中ですべての JavaScript をコンパイルして実行します。
  
  詳細は <strong>V8Js::__construct()</strong> を参照ください。


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

<comment>Param:</comment>
  <info>string</info>  <strong>$object_name</strong>                 JavaScript に渡すオブジェクトの名前。
  <info>array</info>   <strong>$variables</strong>                   JavaScript の中で使う PHP の変数のマップ。 <return>array("js で使うと
                                       きの名前" =&gt; "php の変数名")</return> 形式の連想配列でなければなり
                                       ません。デフォルトは空の配列です。
  <info>array</info>   <strong>$extensions</strong>                  <strong>V8Js::registerExtension()</strong> で登録した拡張の一覧。 作成した
                                       <class>V8Js</class> オブジェクトの JavaScript コンテキストで利用可能なもので
                                       なければなりません。  自動的に有効にするように登録した拡張に
                                       ついては、この配列で指定する必要はありません。 また、ある登録
                                       が別の拡張に依存している場合も、依存している拡張は省略できま
                                       す。デフォルトは空の配列です。
                                       
                                       自動的に有効にするように登録した拡張については、この配列で指
                                       定する必要はありません。 また、ある登録が別の拡張に依存してい
                                       る場合も、依存している拡張は省略できます。デフォルトは空の配
                                       列です。
  <info>bool</info>    <strong>$report_uncaught_exceptions</strong>  キャッチできなかった JavaScript の例外をその場ですぐに報告す
                                       るかどうかを制御します。 デフォルトは <info>true</info> です。<info>false</info> にした
                                       ときは、キャッチできなかった例外へのアクセスには
                                       <strong>V8Js::getPendingException()</strong> を使います。


id: V8Js::executeString
type: function
doc:
<comment>Description:</comment>
  文字列を JavaScript のコードとして実行する
  
  <strong>$script</strong> で渡した文字列を JavaScript のコードとしてコンパイルし、実行します。

<comment>Param:</comment>
  <info>string</info>  <strong>$script</strong>      実行したいコード文字列。
  <info>string</info>  <strong>$identifier</strong>  実行するコードの識別子となる文字列。デバッグ時に使います。
  <info>int</info>     <strong>$flags</strong>       実行フラグ。 <return>V8Js::FLAG_*</return> 定数のいずれかでなければならず、デフォルトは
                       <info>V8Js::FLAG_NONE</info> です。 <info>V8Js::FLAG_NONE</info>: 何もフラグが立っていません。
                       <info>V8Js::FLAG_FORCE_ARRAY</info>: PHP に渡されるすべての JS オブジェクトを連想配列にし
                       ます。
                       
                       <info>V8Js::FLAG_NONE</info>: 何もフラグが立っていません。
                       
                       <info>V8Js::FLAG_FORCE_ARRAY</info>: PHP に渡されるすべての JS オブジェクトを連想配列にし
                       ます。

<comment>Return:</comment>
  <info>mixed</info>  JavaScript のコード内で最後に生成された変数の値を PHP の変数の型に変換して返します。


id: V8Js::getExtensions
type: function
doc:
<comment>Description:</comment>
  登録された拡張の配列を返す
  
  この関数は、<strong>V8Js::registerExtension()</strong> で登録された JavaScript 拡張の配列を返します。

<comment>Return:</comment>
  <info>array</info>  登録された拡張の配列を返します。何も登録されていない場合は空の配列を返します。


id: V8Js::getPendingException
type: function
doc:
<comment>Description:</comment>
  キャッチされなかった JavaScript 例外の中で未処理のものを返す
  
  <strong>V8Js::executeString()</strong> をコールしたときに発生した JavaScript の例外の中で未処理のものを
  <class>V8JsException</class> で返します。

<comment>Return:</comment>
  <info>V8JsException</info>  <class>V8JsException</class> あるいは <info>null</info> を返します。


id: V8Js::registerExtension
type: function
doc:
<comment>Description:</comment>
  V8Js で使う JavaScript の拡張を登録する
  
  渡された JavaScript <strong>$script</strong> を <class>V8Js</class> コンテキストで利用する拡張として登録します。

<comment>Param:</comment>
  <info>string</info>  <strong>$extension_name</strong>  登録する拡張の名前。
  <info>string</info>  <strong>$script</strong>          登録する JavaScript コード。
  <info>array</info>   <strong>$dependencies</strong>    登録する拡張が依存している他の拡張の名前の配列。この拡張が読み込まれたと
                           きに、 これらの拡張も自動的に有効になります。  拡張を使う <class>V8Js</class> を作成する
                           前に、 その拡張自身と依存する拡張群をすべて登録しておかなければなりませ
                           ん。
                           
                           拡張を使う <class>V8Js</class> を作成する前に、 その拡張自身と依存する拡張群をすべて登録
                           しておかなければなりません。
  <info>bool</info>    <strong>$auto_enable</strong>     <info>true</info> にすると、この拡張がすべての <class>V8Js</class> コンテキストで自動的に有効となりま
                           す。

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


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

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


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

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


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

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


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

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


id: VAR_REPRESENTATION_SINGLE_LINE
type: constant
doc:
<comment>Description:</comment>
  <strong>var_representation()</strong> flag indicating that newlines  should not be used for whitespace in variable
  representations.


id: VAR_REPRESENTATION_UNESCAPED
type: constant
doc:
<comment>Description:</comment>
  <strong>var_representation()</strong> flag indicating that strings should be encoded as single quoted strings with
  unescaped control characters.


id: VT_ARRAY
type: constant
doc:
<comment>Description:</comment>
  型インジケータを <info>VT_ARRAY</info> と OR 演算子で組み合わせると、 その値は <return>SAFEARRAY</return> へのポインタとなりま
  す。 <info>VT_ARRAY</info> は、次のデータ型と OR で連結可能です。 <info>VT_I1</info>,  <info>VT_UI1</info>, <info>VT_I2</info>, <info>VT_UI2</info>,  <info>VT_I4</info>,
  <info>VT_UI4</info>, <info>VT_INT</info>,  <info>VT_UINT</info>, <info>VT_R4</info>, <info>VT_R8</info>,  <info>VT_BOOL</info>, <info>VT_DECIMAL</info>, <info>VT_ERROR</info>,  <info>VT_CY</info>, <info>VT_DATE</info>, <info>VT_BSTR</info>,
  <info>VT_DISPATCH</info>, <info>VT_UNKNOWN</info> および <info>VT_VARIANT</info>.


id: VT_BYREF
type: constant
doc:
<comment>Description:</comment>
  型インジケータを <info>VT_BYREF</info> と OR 演算子で組み合わせると、 その値は参照となります。参照型はデータへ
  の参照として扱われます。 C++ における参照型と同じです。


id: VT_DATE
type: constant
doc:
<comment>Description:</comment>
  64 ビット浮動小数点値で、1899 年 12 月 31 日からの経過日数 (秒ではありません) を表します。たとえば
  <return>January 1, 1900</return> は 2.0、 <return>January 2, 1900</return> は 3.0 のようになります。 格納されるときは <info>VT_R8</info> と同じ形
  式になります。


id: VT_EMPTY
type: constant
doc:
<comment>Description:</comment>
  型インジケータが <info>VT_EMPTY</info> であるプロパティには、 何もデータが関連づけられていません。つまり、この
  値のサイズはゼロです。


id: VT_VARIANT
type: constant
doc:
<comment>Description:</comment>
  対応する値を表す型インジケータ。 <info>VT_VARIANT</info> を使うのは、 <info>VT_BYREF</info> と組み合わせる場合のみです。


id: VarnishAdmin::__construct
type: function
doc:
<comment>Description:</comment>
  VarnishAdmin のコンストラクタ

<comment>Param:</comment>
  <info>array</info>  <strong>$args</strong>  設定用の引数。次のキーが使えます。
                


id: VarnishAdmin::auth
type: function
doc:
<comment>Description:</comment>
  varnish インスタンス上で認証する

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


id: VarnishAdmin::ban
type: function
doc:
<comment>Description:</comment>
  VCL の式を使って URL を禁止する

<comment>Param:</comment>
  <info>string</info>  <strong>$vcl_regex</strong>  Varnish VCL の式。varnish の ban コマンドに基づくもの。

<comment>Return:</comment>
  <info>int</info>  varnish のコマンドステータスを返します。


id: VarnishAdmin::banUrl
type: function
doc:
<comment>Description:</comment>
  VCL の式を使って URL を禁止する

<comment>Param:</comment>
  <info>string</info>  <strong>$vcl_regex</strong>  PCRE 互換形式で指定した、URL の正規表現。 varnish の ban.url コマンドに基づく
                      もの。

<comment>Return:</comment>
  <info>int</info>  varnish のコマンドステータスを返します。


id: VarnishAdmin::clearPanic
type: function
doc:
<comment>Description:</comment>
  varnish インスタンスのパニックメッセージをクリアする

<comment>Return:</comment>
  <info>int</info>  varnish のコマンドステータスを返します。


id: VarnishAdmin::connect
type: function
doc:
<comment>Description:</comment>
  varnish インスタンスの管理インターフェイスに接続する

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


id: VarnishAdmin::disconnect
type: function
doc:
<comment>Description:</comment>
  varnish インスタンスの管理インターフェイスとの接続を切断する

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


id: VarnishAdmin::getPanic
type: function
doc:
<comment>Description:</comment>
  varnish インスタンスの直近のパニックメッセージを取得する

<comment>Return:</comment>
  <info>string</info>  現在の varnish インスタンスの直近のパニックメッセージを返します。


id: VarnishAdmin::getParams
type: function
doc:
<comment>Description:</comment>
  現在の varnish インスタンスの設定パラメータを取得する

<comment>Return:</comment>
  <info>array</info>  varnish 設定パラメータの配列を返します。


id: VarnishAdmin::isRunning
type: function
doc:
<comment>Description:</comment>
  varnish のスレーブプロセスが現在実行中かどうかを調べる

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


id: VarnishAdmin::setCompat
type: function
doc:
<comment>Description:</comment>
  クラスのオプション compat を設定する

<comment>Param:</comment>
  <info>int</info>  <strong>$compat</strong>  Varnish の compat オプション。

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


id: VarnishAdmin::setHost
type: function
doc:
<comment>Description:</comment>
  クラスのオプション host を設定する

<comment>Param:</comment>
  <info>string</info>  <strong>$host</strong>  接続の host パラメータ。

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


id: VarnishAdmin::setIdent
type: function
doc:
<comment>Description:</comment>
  クラスのオプション ident を設定する

<comment>Param:</comment>
  <info>string</info>  <strong>$ident</strong>  接続の ident パラメータ。

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


id: VarnishAdmin::setParam
type: function
doc:
<comment>Description:</comment>
  現在の varnish インスタンスの構成パラメータを設定する

<comment>Param:</comment>
  <info>string</info>      <strong>$name</strong>   Varnish のパラメータ名。
  <info>string|int</info>  <strong>$value</strong>  Varnish のパラメータの値。

<comment>Return:</comment>
  <info>int</info>  varnish のコマンドステータスを返します。


id: VarnishAdmin::setPort
type: function
doc:
<comment>Description:</comment>
  クラスのオプション port を設定する

<comment>Param:</comment>
  <info>int</info>  <strong>$port</strong>  接続の port パラメータ。

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


id: VarnishAdmin::setSecret
type: function
doc:
<comment>Description:</comment>
  クラスのオプション secret を設定する

<comment>Param:</comment>
  <info>string</info>  <strong>$secret</strong>  接続の secret パラメータ。

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


id: VarnishAdmin::setTimeout
type: function
doc:
<comment>Description:</comment>
  クラスのオプション timeout を設定する

<comment>Param:</comment>
  <info>int</info>  <strong>$timeout</strong>  接続の timeout パラメータ。

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


id: VarnishAdmin::start
type: function
doc:
<comment>Description:</comment>
  varnish ワーカープロセスを開始する

<comment>Return:</comment>
  <info>int</info>  varnish のコマンドステータスを返します。


id: VarnishAdmin::stop
type: function
doc:
<comment>Description:</comment>
  varnish ワーカープロセスを停止する

<comment>Return:</comment>
  <info>int</info>  varnish のコマンドステータスを返します。


id: VarnishLog::__construct
type: function
doc:
<comment>Description:</comment>
  Varnishlog のコンストラクタ

<comment>Param:</comment>
  <info>array</info>  <strong>$args</strong>  設定用の引数。次のキーが使えます。
                


id: VarnishLog::getLine
type: function
doc:
<comment>Description:</comment>
  ログの次の行を取得する

<comment>Return:</comment>
  <info>array</info>  ログの行のデータを配列で返します。


id: VarnishLog::getTagName
type: function
doc:
<comment>Description:</comment>
  ログのタグ文字列を、インデックスから取得する

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  ログのタグのインデックス。

<comment>Return:</comment>
  <info>string</info>  ログのタグ名を文字列で返します。


id: VarnishStat::__construct
type: function
doc:
<comment>Description:</comment>
  VarnishStat のコンストラクタ

<comment>Param:</comment>
  <info>array</info>  <strong>$args</strong>  設定用の引数。次のキーが使えます。
                


id: VarnishStat::getSnapshot
type: function
doc:
<comment>Description:</comment>
  現在の varnish インスタンスの統計スナップショットを取得する

<comment>Return:</comment>
  <info>array</info>  varnish 統計のスナップショットを配列で返します。 配列のキーは varnishstat ツールと同じで
         す。


id: Volatile
type: class
doc:
<comment>Description:</comment>
  The <class>Volatile</class> class is new to pthreads v3. Its introduction is a consequence of the new
  immutability semantics of <class>Threaded</class> members of <class>Threaded</class> classes. The <class>Volatile</class> class enables for
  mutability of its <class>Threaded</class> members, and is also used to store PHP arrays in <class>Threaded</class> contexts.


id: Vtiful\Kernel\Excel::__construct
type: function
doc:
<comment>Description:</comment>
  Vtiful\Kernel\Excel constructor
  
  <class>Vtiful\Kernel\Excel</class> constructor, create a class object.

<comment>Param:</comment>
  <info>array</info>  <strong>$config</strong>  XLSX file export configuration


id: Vtiful\Kernel\Excel::addSheet
type: function
doc:
<comment>Description:</comment>
  Vtiful\Kernel\Excel addSheet
  
  Create a new worksheet in the xlsx file.

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

<comment>Return:</comment>
  <info>unknown</info>  <class>Vtiful\Kernel\Excel</class> instance


id: Vtiful\Kernel\Excel::autoFilter
type: function
doc:
<comment>Description:</comment>
  Vtiful\Kernel\Excel autoFilter
  
  Add autofilter to a worksheet.

<comment>Param:</comment>
  <info>string</info>  <strong>$scope</strong>  Cell start and end coordinate string.

<comment>Return:</comment>
  <info>unknown</info>  <class>Vtiful\Kernel\Excel</class> instance


id: Vtiful\Kernel\Excel::constMemory
type: function
doc:
<comment>Description:</comment>
  Vtiful\Kernel\Excel constMemory
  
  Write a large file with constant memory usage.

<comment>Param:</comment>
  <info>string</info>  <strong>$fileName</strong>   XLSX file name
  <info>string</info>  <strong>$sheetName</strong>  Worksheet name

<comment>Return:</comment>
  <info>unknown</info>  <class>Vtiful\Kernel\Excel</class> instance


id: Vtiful\Kernel\Excel::data
type: function
doc:
<comment>Description:</comment>
  Vtiful\Kernel\Excel data
  
  Write a data in the worksheet.

<comment>Param:</comment>
  <info>array</info>  <strong>$data</strong>  worksheet data

<comment>Return:</comment>
  <info>unknown</info>  <class>Vtiful\Kernel\Excel</class> instance


id: Vtiful\Kernel\Excel::fileName
type: function
doc:
<comment>Description:</comment>
  Vtiful\Kernel\Excel fileName
  
  Create a brand new xlsx file and create a worksheet.

<comment>Param:</comment>
  <info>string</info>  <strong>$fileName</strong>   XLSX file name
  <info>string</info>  <strong>$sheetName</strong>  Worksheet name

<comment>Return:</comment>
  <info>unknown</info>  <class>Vtiful\Kernel\Excel</class> instance


id: Vtiful\Kernel\Excel::getHandle
type: function
doc:
<comment>Description:</comment>
  Vtiful\Kernel\Excel getHandle
  
  Get the xlsx text resource handle.

<comment>Return:</comment>
  <info>unknown</info>  Resource


id: Vtiful\Kernel\Excel::header
type: function
doc:
<comment>Description:</comment>
  Vtiful\Kernel\Excel header
  
  Write a header in the worksheet.

<comment>Param:</comment>
  <info>array</info>  <strong>$headerData</strong>  worksheet header data

<comment>Return:</comment>
  <info>unknown</info>  <class>Vtiful\Kernel\Excel</class> instance


id: Vtiful\Kernel\Excel::insertFormula
type: function
doc:
<comment>Description:</comment>
  Vtiful\Kernel\Excel insertFormula
  
  Insert calculation formula.

<comment>Param:</comment>
  <info>int</info>     <strong>$row</strong>      cell row
  <info>int</info>     <strong>$column</strong>   cell column
  <info>string</info>  <strong>$formula</strong>  formula string

<comment>Return:</comment>
  <info>unknown</info>  <class>Vtiful\Kernel\Excel</class> instance


id: Vtiful\Kernel\Excel::insertImage
type: function
doc:
<comment>Description:</comment>
  Vtiful\Kernel\Excel insertImage
  
  Insert a local image into the cell.

<comment>Param:</comment>
  <info>int</info>     <strong>$row</strong>             cell row
  <info>int</info>     <strong>$column</strong>          cell column
  <info>string</info>  <strong>$localImagePath</strong>  local image path

<comment>Return:</comment>
  <info>unknown</info>  <class>Vtiful\Kernel\Excel</class> instance


id: Vtiful\Kernel\Excel::insertText
type: function
doc:
<comment>Description:</comment>
  Vtiful\Kernel\Excel insertText
  
  Write text in a cell.

<comment>Param:</comment>
  <info>int</info>               <strong>$row</strong>     cell row
  <info>int</info>               <strong>$column</strong>  cell column
  <info>int|float|string</info>  <strong>$data</strong>    data to be written
  <info>string</info>            <strong>$format</strong>  String format

<comment>Return:</comment>
  <info>unknown</info>  <class>Vtiful\Kernel\Excel</class> instance


id: Vtiful\Kernel\Excel::mergeCells
type: function
doc:
<comment>Description:</comment>
  Vtiful\Kernel\Excel mergeCells
  
  Merge Cells.

<comment>Param:</comment>
  <info>string</info>  <strong>$scope</strong>  cell start and end coordinate strings
  <info>string</info>  <strong>$data</strong>   string data

<comment>Return:</comment>
  <info>unknown</info>  <class>Vtiful\Kernel\Excel</class> instance


id: Vtiful\Kernel\Excel::output
type: function
doc:
<comment>Description:</comment>
  Vtiful\Kernel\Excel output
  
  Output xlsx file to disk.

<comment>Return:</comment>
  <info>unknown</info>  XLSX file path;


id: Vtiful\Kernel\Excel::setColumn
type: function
doc:
<comment>Description:</comment>
  Vtiful\Kernel\Excel setColumn
  
  Set the format of the column.

<comment>Param:</comment>
  <info>string</info>    <strong>$range</strong>   cell start and end coordinate strings
  <info>float</info>     <strong>$width</strong>   column width
  <info>resource</info>  <strong>$format</strong>  cell format resource

<comment>Return:</comment>
  <info>unknown</info>  <class>Vtiful\Kernel\Excel</class> instance


id: Vtiful\Kernel\Excel::setRow
type: function
doc:
<comment>Description:</comment>
  Vtiful\Kernel\Excel setRow
  
  Set the format of the column.

<comment>Param:</comment>
  <info>string</info>    <strong>$range</strong>   cell start and end coordinate strings
  <info>float</info>     <strong>$height</strong>  row height
  <info>resource</info>  <strong>$format</strong>  cell format resource

<comment>Return:</comment>
  <info>unknown</info>  <class>Vtiful\Kernel\Excel</class> instance


id: Vtiful\Kernel\Format::align
type: function
doc:
<comment>Description:</comment>
  Vtiful\Kernel\Format align
  
  set cell align

<comment>Param:</comment>
  <info>resource</info>  <strong>$handle</strong>  xlsx file handle
  <info>int</info>       <strong>$style</strong>   <class>Vtiful\Kernel\Format</class> constant

<comment>Return:</comment>
  <info>unknown</info>  Resource


id: Vtiful\Kernel\Format::bold
type: function
doc:
<comment>Description:</comment>
  Vtiful\Kernel\Format bold
  
  <class>Vtiful\Kernel\Format</class> bold format

<comment>Param:</comment>
  <info>resource</info>  <strong>$handle</strong>  xlsx file handle

<comment>Return:</comment>
  <info>unknown</info>  Resource


id: Vtiful\Kernel\Format::italic
type: function
doc:
<comment>Description:</comment>
  Vtiful\Kernel\Format italic
  
  <class>Vtiful\Kernel\Format</class> italic format

<comment>Param:</comment>
  <info>resource</info>  <strong>$handle</strong>  xlsx file handle

<comment>Return:</comment>
  <info>unknown</info>  Resource


id: Vtiful\Kernel\Format::underline
type: function
doc:
<comment>Description:</comment>
  Vtiful\Kernel\Format underline
  
  <class>Vtiful\Kernel\Format</class> underline format

<comment>Param:</comment>
  <info>resource</info>  <strong>$handle</strong>  xlsx file handle
  <info>int</info>       <strong>$style</strong>   <class>Vtiful\Kernel\Format</class> constant

<comment>Return:</comment>
  <info>unknown</info>  Resource


id: WIN32_ABOVE_NORMAL_PRIORITY_CLASS
type: constant
doc:
<comment>Description:</comment>
  WIN32_NORMAL_PRIORITY_CLASS よりも高いけれど WIN32_HIGH_PRIORITY_CLASS よりは低い優先度のプロセ
  ス。


id: WIN32_BELOW_NORMAL_PRIORITY_CLASS
type: constant
doc:
<comment>Description:</comment>
  WIN32_IDLE_PRIORITY_CLASS よりも高いけれど WIN32_NORMAL_PRIORITY_CLASS よりは低い優先度のプロセ
  ス。


id: WIN32_ERROR_FAILED_SERVICE_CONTROLLER_CONNECT
type: constant
doc:
<comment>Description:</comment>
  このエラーは、サービスではなくコンソールアプリケーションとしてプログラムを実行したときに返されま
  す。 デバッグ用にコンソールアプリケーションとして実行する場合は、 サービスに固有のコードをコールし
  ないようにしましょう。


id: WIN32_ERROR_INVALID_SERVICE_ACCOUNT
type: constant
doc:
<comment>Description:</comment>
  <strong>$user</strong> で指定したユーザーアカウントが存在しません。 <strong>win32_create_service()</strong> を参照ください。


id: WIN32_ERROR_SERVICE_CANNOT_ACCEPT_CTRL
type: constant
doc:
<comment>Description:</comment>
  指定した制御コードをサービスに送れませんでした。サービスの状態が <info>WIN32_SERVICE_STOPPED</info>、
  <info>WIN32_SERVICE_START_PENDING</info> あるいは <info>WIN32_SERVICE_STOP_PENDING</info> だったためです。


id: WIN32_ERROR_SERVICE_LOGON_FAILED
type: constant
doc:
<comment>Description:</comment>
  0x0000042D
  
  ログオンに失敗したためサービスを起動できません。このエラーが発生するのは、 そのサービスが "Log on
  as a service" 権限のないアカウントで動作するように設定されている場合です。


id: WIN32_ERROR_SERVICE_REQUEST_TIMEOUT
type: constant
doc:
<comment>Description:</comment>
  0x0000041D
  
  サービスのプロセスは起動しましたが StartServiceCtrlDispatcher をコールしていません。あるいは
  StartServiceCtrlDispatcher をコールしたスレッドが制御ハンドラ関数でブロックされています。


id: WIN32_HIGH_PRIORITY_CLASS
type: constant
doc:
<comment>Description:</comment>
  ただちに実行しなければならないような、時間制約の厳しいプロセス。 このプロセスのスレッドは、優先度
  クラスが NORMAL あるいは IDLE であるすべてのプロセスのスレッドを先取りします。 このクラスを使う例
  はタスクリストです。 タスクリストは、ユーザーが呼び出したときは OS の負荷にかかわらずすぐに反応し
  なければなりません。 この優先度クラスを使うときには細心の注意が必要です。 この優先度クラスのアプリ
  ケーションは CPU をほぼすべて使い切ってしまうこともあるからです。


id: WIN32_IDLE_PRIORITY_CLASS
type: constant
doc:
<comment>Description:</comment>
  システムがアイドル状態のときにだけスレッドが実行されるプロセス。 より優先度クラスの高いプロセスが
  実行中の場合は、 そちらのスレッドが優先的に実行されます。 このクラスを使う例はスクリーンセーバーで
  す。 この優先度クラスは、子プロセスにも引き継がれます。


id: WIN32_REALTIME_PRIORITY_CLASS
type: constant
doc:
<comment>Description:</comment>
  可能な限り優先度を高くするプロセス。 このプロセスのスレッドは、他のすべてのプロセスのスレッドを先
  取りします。 重要なタスクをこなす OS のプロセスであっても例外ではありません。 リアルタイムプロセス
  を非常に短い間隔で実行させると、 ディスクキャッシュがフラッシュされなくなったり マウスが反応しなく
  なったりすることがあり得ます。


id: WIN32_SERVICE_ACCEPT_HARDWAREPROFILECHANGE
type: constant
doc:
<comment>Description:</comment>
  コンピューターのハードウェアプロファイルが変化した場合にサービスに通知します。 これによって、シス
  テムは <info>WIN32_SERVICE_CONTROL_HARDWAREPROFILECHANGE</info> をサービスに通知できるようになります。


id: WIN32_SERVICE_ACCEPT_NETBINDCHANGE
type: constant
doc:
<comment>Description:</comment>
  このサービスは、停止や再起動なしに、 バインディングの変更を受け入れることができるネットワークコン
  ポーネントです。  この制御コードは、サービスが <info>WIN32_SERVICE_CONTROL_NETBINDADD</info>,
  <info>WIN32_SERVICE_CONTROL_NETBINDREMOVE</info>,  <info>WIN32_SERVICE_CONTROL_NETBINDENABLE</info> および
  <info>WIN32_SERVICE_CONTROL_NETBINDDISABLE</info> の通知を受け取れることを表します。


id: WIN32_SERVICE_ACCEPT_PARAMCHANGE
type: constant
doc:
<comment>Description:</comment>
  サービスを停止したり再起動することなく、スタートアップパラメータを再読込できるサービスです。 この
  制御コードは、サービスが <info>WIN32_SERVICE_CONTROL_PARAMCHANGE</info> の通知を受け取れることを表します。


id: WIN32_SERVICE_ACCEPT_PAUSE_CONTINUE
type: constant
doc:
<comment>Description:</comment>
  サービスは一時停止して続行できます。この制御コードは、サービスが <info>WIN32_SERVICE_CONTROL_PAUSE</info> およ
  び <info>WIN32_SERVICE_CONTROL_CONTINUE</info> の通知を受け取れることを表します。


id: WIN32_SERVICE_ACCEPT_POWEREVENT
type: constant
doc:
<comment>Description:</comment>
  コンピューターの電源状態が変化した時にサービスに通知します。 これによって、システムが
  <info>WIN32_SERVICE_CONTROL_POWEREVENT</info> 通知をサービスに送信できるようになります。


id: WIN32_SERVICE_ACCEPT_PRESHUTDOWN
type: constant
doc:
<comment>Description:</comment>
  サービスはシャットダウン前のタスクを処理できます。この制御コードは、サービスが
  <info>WIN32_SERVICE_CONTROL_PRESHUTDOWN</info> の通知を受け取れることを表します。 この値は Windows Server 2003
  や Windows XP/2000 以降では使えません。


id: WIN32_SERVICE_ACCEPT_SESSIONCHANGE
type: constant
doc:
<comment>Description:</comment>
  コンピューターのセッション状態が変更された場合にサービスに通知します。 これによって、システムは
  <info>WIN32_SERVICE_CONTROL_SESSIONCHANGE</info> 通知をサービスに送信できるようになります。 Windows 2000 では、
  この値は使えません。


id: WIN32_SERVICE_ACCEPT_SHUTDOWN
type: constant
doc:
<comment>Description:</comment>
  サービスはシステムのシャットダウン通知を受け取ります。この制御コードは、サービスが
  <info>WIN32_SERVICE_CONTROL_SHUTDOWN</info> の通知を受け取れることを表します。


id: WIN32_SERVICE_ACCEPT_STOP
type: constant
doc:
<comment>Description:</comment>
  サービスは終了できます。この制御コードは、サービスが <info>WIN32_SERVICE_CONTROL_STOP</info> の通知を受け取れる
  ことを表します。


id: WIN32_SERVICE_ACCEPT_TIMECHANGE
type: constant
doc:
<comment>Description:</comment>
  システム時刻が変更された場合にサービスに通知します。 これによって、システムは
  <info>WIN32_SERVICE_CONTROL_TIMECHANGE</info> 通知をサービスに送信できるようになります。 Windows Server 2008,
  Windows Vista, Windows Server 2003,  and Windows XP/2000 では、この制御コードはサポートされていま
  せん。


id: WIN32_SERVICE_ACCEPT_TRIGGEREVENT
type: constant
doc:
<comment>Description:</comment>
  サービスの登録イベントが起きた場合にサービスに通知します。 これによって、システムは
  <info>WIN32_SERVICE_CONTROL_TRIGGEREVENT</info> 通知をサービスに送信できるようになります。 Windows Server 2008,
  Windows Vista, Windows Server 2003,  and Windows XP/2000 では、この制御コードはサポートされていま
  せん。


id: WIN32_SERVICE_CONTROL_PRESHUTDOWN
type: constant
doc:
<comment>Description:</comment>
  0x0000000F
  
  サービスに、システムのシャットダウンを通知します。 この通知を処理するサービスは、サービスが終了す
  るかあるいはシャットダウン前のタイムアウトに達するまで システムのシャットダウンを待機させることが
  できます。 この値は、Windows Server 2003 および Windows XP/2000 以降では使えません。


id: WIN32_SERVICE_CONTROL_SHUTDOWN
type: constant
doc:
<comment>Description:</comment>
  サービスに、システムがシャットダウンするので後始末をするよう通知します。 サービスがこの制御コード
  を受け付けた場合は、 後始末のタスクを終えてからサービスを終了しなければなりません。 SCM がこの制御
  コードを送った後は、他の制御コードを送ることはできません。


id: WIN32_SERVICE_DISABLED
type: constant
doc:
<comment>Description:</comment>
  サービスを開始することができません。開始させようとすると、エラーコード
  <info>WIN32_ERROR_SERVICE_DISABLED</info> を返します。


id: WIN32_SERVICE_ERROR_CRITICAL
type: constant
doc:
<comment>Description:</comment>
  起動プログラムは可能であれば、エラーをイベントログに記録します。 最後に正常起動した構成で起動中の
  場合、 起動処理は失敗します。 そうでない場合、 システムは最後に正常起動した構成で再起動されます。


id: WIN32_SERVICE_ERROR_SEVERE
type: constant
doc:
<comment>Description:</comment>
  起動プログラムはエラーをイベントログに記録します。 最後に正常起動した構成で起動中の場合、 起動処理
  は続行されます。そうでない場合、 システムは最後に正常起動した構成で再起動されます。


id: WIN32_SERVICE_WIN32_OWN_PROCESS_INTERACTIVE
type: constant
doc:
<comment>Description:</comment>
  サービスは自分のプロセスで動作し、デスクトップとのやりとりができます。このオプションは、Windows
  Vista 以降では使えません。


id: WSDL_CACHE_BOTH
type: constant
doc:
<comment>Description:</comment>
  SoapClient::__construct や SoapServer::__construct に渡す soap.wsdl_cache や <return>wsdl_cache</return> オプション
  で オンメモリとディスク上の WDSL キャッシュを両方使うように指定します。


id: WSDL_CACHE_DISK
type: constant
doc:
<comment>Description:</comment>
  SoapClient::__construct や SoapServer::__construct に渡す soap.wsdl_cache や <return>wsdl_cache</return> オプション
  で ディスク上の WDSL キャッシュだけを使うことを指定します。


id: WSDL_CACHE_MEMORY
type: constant
doc:
<comment>Description:</comment>
  SoapClient::__construct や SoapServer::__construct に渡す soap.wsdl_cache や <return>wsdl_cache</return> オプション
  で オンメモリの WDSL キャッシュだけを使うことを指定します。


