sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-16 00:48:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

documentation for mysqli_set_local_infile_handler added

Browse source 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@250511 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Hartmut Holzgraefe 2008-01-13 00:45:06 +00:00
parent ea0a5aaed3
commit 50aba4e9e3
1 changed files with 166 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

169
reference/mysqli/mysqli/set-local-infile-handler.xml
View file

@ -1,10 +1,10 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry xml:id="mysqli.set-local-infile-handler" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mysqli::set_local_infile_handler</refname>
<refname>mysqli_set_local_infile_handler</refname>
<refpurpose>Set callback functions for LOAD DATA LOCAL INFILE command</refpurpose>
<refpurpose>Set callback function for LOAD DATA LOCAL INFILE command</refpurpose>
</refnamediv>
<refsect1 role="description">
@ -14,9 +14,172 @@
<methodparam><type>mysqli</type><parameter>link</parameter></methodparam>
<methodparam><type>callback</type><parameter>read_func</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style (method)</para>
<classsynopsis>
<ooclass><classname>mysqli</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>set_local_infile_handler</methodname>
<methodparam><type>mysqli</type><parameter>link</parameter></methodparam>
<methodparam><type>callback</type><parameter>read_func</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>Set callback function for LOAD DATA LOCAL INFILE command</para>
&warn.undocumented.func;
<para>
The callbacks task is to read input from the file specified in the
<literal>LOAD DATA LOCAL INFILE</literal> and to reformat it into
the format understood by <literal>LOAD DATA INFILE</literal>.
</para>
<para>
The returned data needs to match the format speficied in the
<literal>LOAD DATA</literal>
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&mysqli.link.description;
<varlistentry>
<term><parameter>read_func</parameter></term>
<listitem>
<para>
A callback function or object method taking the following parameters:
</para>
<variablelist>
<varlistentry>
<term><parameter>stream</parameter></term>
<listitem><para>A PHP stream associated with the SQL commands INFILE</para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>&amp;buffer</parameter></term>
<listitem><para>A string buffer to store the rewritten input into</para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>buflen</parameter></term>
<listitem><para>The maximum number of characters to be stored in the buffer</para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>&amp;errormsg</parameter></term>
<listitem><para>If an error occures you can store an error message in here</para></listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
</para>
<para>
The callback function should return the number of characters stored
in the <parameter>buffer</parameter> or a negative value if an error
occured.
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Object oriented style</title>
<programlisting role="php">
<![CDATA[
<?php
$db = mysqli_init();
$db->real_connect("localhost","root","","test");
function callme($stream, &$buffer, $buflen, &$errmsg)
{
$buffer = fgets($stream);
echo $buffer;
// convert to upper case and replace "," delimiter with [TAB]
$buffer = strtoupper(str_replace(",", "\t", $buffer));
return strlen($buffer);
}
$db->set_local_infile_handler("callme");
echo "Input:\n";
$db->query("LOAD DATA LOCAL INFILE 'input.txt' INTO TABLE t1");
$res = $db->query("SELECT * FROM t1");
echo "\nResult:\n";
while ($row = $res->fetch_assoc()) {
echo join(",", $row)."\n";
}
?>
]]>
</programlisting>
</example>
<example>
<title>Procedural style</title>
<programlisting role="php">
<![CDATA[
<?php
$db = mysqli_init();
mysqli_real_connect($db, "localhost","root","","test");
function callme($stream, &$buffer, $buflen, &$errmsg)
{
$buffer = fgets($stream);
echo $buffer;
// convert to upper case and replace "," delimiter with [TAB]
$buffer = strtoupper(str_replace(",", "\t", $buffer));
return strlen($buffer);
}
mysqli_set_local_infile_handler($db, "callme");
echo "Input:\n";
mysqli_query($db, "LOAD DATA LOCAL INFILE 'input.txt' INTO TABLE t1");
$res = mysqli_query($db, "SELECT * FROM t1");
echo "\nResult:\n";
while ($row = mysqli_fetch_assoc($res)) {
echo join(",", $row)."\n";
}
?>
]]>
</programlisting>
</example>
&example.outputs;
<screen>
<![CDATA[
Input:
23,foo
42,bar
Output:
23,FOO
42,BAR
]]>
</screen>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>mysqli_set_local_infile_default</function></member>
</simplelist>
</para>
</refsect1>
</refentry>