PDO::sqliteCreateFunction

(PHP 5 >= 5.1.0, PECL pdo_sqlite >= 1.0.0)

PDO::sqliteCreateFunction — Registers a User Defined Function for use in SQL statements

설명

public bool PDO::sqliteCreateFunction ( string $function_name , callable $callback [, int $num_args ] )

Warning

이 함수는 실험적입니다. 이 함수의 작동, 함수의 이름, 그리고 관련된 모든 문서는 이후의 PHP 릴리즈에서 예고 없이 변경할 수 있습니다. 이 함수의 사용에 관한 것은 사용자 책임입니다.

This method allows you to register a PHP function with SQLite as an UDF (User Defined Function), so that it can be called from within your SQL statements.

The UDF can be used in any SQL statement that can call functions, such as SELECT and UPDATE statements and also in triggers.

인수

function_name: The name of the function used in SQL statements.
callback: Callback function to handle the defined SQL function.

Note: Callback functions should return a type understood by SQLite (i.e. scalar type).
num_args: Hint to the SQLite parser if the callback function accepts a predetermined number of arguments.

반환값

성공 시 TRUE를, 실패 시 FALSE를 반환합니다.

예제

Example #1 PDO::sqliteCreateFunction() example


<?php
function md5_and_reverse($string) 
{
    return strrev(md5($string));
}

$db = new PDO('sqlite:sqlitedb');
$db->sqliteCreateFunction('md5rev', 'md5_and_reverse', 1);
$rows = $db->query('SELECT md5rev(filename) FROM files')->fetchAll();
?>

In this example, we have a function that calculates the md5 sum of a string, and then reverses it. When the SQL statement executes, it returns the value of the filename transformed by our function. The data returned in $rows contains the processed result.

The beauty of this technique is that you do not need to process the result using a foreach loop after you have queried for the data.

Tip

You can use PDO::sqliteCreateFunction and PDO::sqliteCreateAggregate to override SQLite native SQL functions.

Note:
This method is not available with the SQLite2 driver. Use the old style sqlite API for that instead.

참고

PDO::sqliteCreateAggregate
sqlite_create_function() - Registers a "regular" User Defined Function for use in SQL statements
sqlite_create_aggregate() - Register an aggregating UDF for use in SQL statements