SQLite3::createAggregate

(PHP 5 >= 5.3.0, PHP 7)

SQLite3::createAggregate — SQL の集約関数として使用する PHP 関数を登録する

説明

public SQLite3::createAggregate ( string $name , mixed $step_callback , mixed $final_callback [, int $argument_count = -1 ] ) : bool

SQL の集約関数として使用する PHP 関数を登録します。 これは SQL 文の中で使用されるものです。

パラメータ

name

作成あるいは再定義したい SQL 集約関数の名前。

step_callback

集約対象のすべての項目に適用するコールバックとして指定する、 PHP の関数あるいはユーザー定義関数の名前。

final_callback

集約処理の最後に適用するコールバックとして指定する、 PHP の関数あるいはユーザー定義関数の名前。

argument_count

SQL 集約関数が受け取るパラメータの数。 負の値を指定すると、SQL 集約関数は任意の数の引数を受け取るようになります。

返り値

集約関数の作成に成功した場合に TRUE、失敗した場合に FALSE を返します。