PDO::sqliteCreateFunction
Registers a User Defined Function for use in SQL statements
&reftitle.description;
publicboolPDO::sqliteCreateFunctionstringfunction_namecallablecallbackintnum_args-1intflags0
&warn.experimental.func;
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.
&reftitle.parameters;
function_name
The name of the function used in SQL statements.
callback
Callback function to handle the defined SQL function.
Callback functions should return a type understood by SQLite (i.e.
scalar type).
This function need to be defined as:
mixedcallbackmixedvaluemixedvaluesvalue
The first argument passed to the SQL function.
values
Further arguments passed to the SQL function.
num_args
The number of arguments that the SQL function takes. If
this parameter is -1, then the SQL function may take
any number of arguments.
flags
A bitwise conjunction of flags. Currently, only
PDO::SQLITE_DETERMINISTIC is supported, which specifies
that the function always returns the same result given the same inputs
within a single SQL statement.
&reftitle.returnvalues;
&return.success;
&reftitle.changelog;
&Version;&Description;7.1.4
The flags parameter has been added.
&reftitle.examples;
PDO::sqliteCreateFunction example
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.
You can use and
to override SQLite
native SQL functions.
&reftitle.seealso;
sqlite_create_functionsqlite_create_aggregate