SQL のスカラー関数として使用する PHP 関数を登録する

# SQLite3::createFunction

(PHP 5 >= 5.3.0, PHP 7, PHP 8)

SQLite3::createFunction — SQL のスカラー関数として使用する PHP 関数を登録する

### 説明

public function SQLite3::createFunction(
string `$name`,
callable `$callback`,
int `$argCount` = -1,
int `$flags` = 0
): bool

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

### パラメータ

`name`

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

`callback`

  コールバックとして指定する、 PHP の関数あるいはユーザー定義関数の名前。 これが SQL 関数の振る舞いを定義します。

  この関数は、以下のように定義されるべきです:

  function callback(mixed `$value`, mixed `...$values`): mixed
  `value`

    SQL 関数に渡される最初の引数

  `values`

    SQL 関数に渡されるふたつめ以降の引数

`argCount`

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

`flags`

  フラグのビット単位の組み合わせ。 現状では、 `SQLITE3_DETERMINISTIC` だけがサポートされています。 これは、単一のSQLの範囲の中では、同じ入力を与えると常に同じ結果が返るということを指定します。

### 戻り値

関数の作成に成功した場合に `true`、失敗した場合に `false` を返します。

### 変更履歴

バージョン | 説明
--- | ---
7.1.4 | `flags` パラメータが追加されました。

### 例

例1 SQLite3::createFunction() の例

    <?php
    function my_udf_md5($string) {
        return hash('md5', $string);
    }

    $db = new SQLite3('mysqlitedb.db');
    $db->createFunction('my_udf_md5', 'my_udf_md5');

    var_dump($db->querySingle('SELECT my_udf_md5("test")'));
    ?>

上の例の出力は、 たとえば以下のようになります。

    string(32) "098f6bcd4621d373cade4e832627b4f6"

`↑` and `↓` to navigate • `Enter` to select • `Esc` to close • `/` to open