SQLite3::createCollation

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

SQLite3::createCollation — SQLのcollate関数として使うPHP関数を登録する

説明

public SQLite3::createCollation(string $name, callable $callback): bool

SQL文の中でcollate関数として使うPHP関数、またはユーザー定義の関数を登録します。

パラメータ

name

作成、または再定義するSQL collate 関数の名前

callback

collation の振る舞いを定義する、PHP関数または、コールバックとして適用するユーザー定義関数。 2つの値を受けとり、strcmp() 関数が返すのと同じ値を返します。つまり、はじめの文字列が前の文字列より前にソートされる場合に-1、後にソートされる場合に1、等しい場合に0を返します。

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

collation(mixed $value1, mixed $value2): int

戻り値

成功した場合に true を、失敗した場合に false を返します。

例

例1 SQLite3::createCollation() の例

SQLite3 データベースの中で、シーケンスを並べる strnatcmp() 関数を登録します。

<?php

$db = new SQLite3(":memory:");
$db->exec("CREATE TABLE test (col1 string)");
$db->exec("INSERT INTO test VALUES ('a1')");
$db->exec("INSERT INTO test VALUES ('a10')");
$db->exec("INSERT INTO test VALUES ('a2')");

$db->createCollation('NATURAL_CMP', 'strnatcmp');

$defaultSort = $db->query("SELECT col1 FROM test ORDER BY col1");
$naturalSort = $db->query("SELECT col1 FROM test ORDER BY col1 COLLATE NATURAL_CMP");

echo "default:\n";
while ($row = $defaultSort->fetchArray()){
    echo $row['col1'], "\n";
}

echo "\nnatural:\n";
while ($row = $naturalSort->fetchArray()){
    echo $row['col1'], "\n";
}

$db->close();

?>

上の例の出力は以下となります。

default:
a1
a10
a2

natural:
a1
a2
a10

参考

SQLite collation ドキュメント: » http://sqlite.org/datatype3.html#collation