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

Updating mysqli: fixing mysqli_report

Browse source 
Co-authored-by: Anna Filina <afilina@gmail.com>
Co-authored-by: Christoph M. Becker <cmbecker69@gmx.de>

Closes GH-180.
This commit is contained in:
Dharman 2021-01-07 23:42:11 +01:00 committed by Christoph M. Becker
parent a714378ed8
commit 2bd21ff7be
2 changed files with 45 additions and 36 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

78
reference/mysqli/mysqli_driver/report-mode.xml
View file

@ -4,7 +4,7 @@
<refnamediv>
<refname>mysqli_driver::$report_mode</refname>
<refname>mysqli_report</refname>
<refpurpose>Enables or disables internal report functions</refpurpose>
<refpurpose>Sets mysqli error reporting mode</refpurpose>
</refnamediv>
<refsect1 role="description">
@ -19,9 +19,12 @@
<methodparam><type>int</type><parameter>flags</parameter></methodparam>
</methodsynopsis>
<para>
A function helpful in improving queries during code development and testing.
Depending on the flags, it reports errors from mysqli function calls or
queries that don't use an index (or use a bad index).
Depending on the flags, it sets mysqli error reporting mode to exception, warning or none.
When set to <constant>MYSQLI_REPORT_ALL</constant> or <constant>MYSQLI_REPORT_INDEX</constant>
it will also inform about queries that don't use an index (or use a bad index).
</para>
<para>
The default setting is <constant>MYSQLI_REPORT_OFF</constant>.
</para>
</refsect1>
@ -79,7 +82,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
Returns &true;.
</para>
</refsect1>
@ -91,35 +94,22 @@
<![CDATA[
<?php
$mysqli = new mysqli("localhost", "my_user", "my_password", "world");
/* check connection */
if (mysqli_connect_errno()) {
printf("Connect failed: %s\n", mysqli_connect_error());
exit();
}
/* activate reporting */
$driver = new mysqli_driver();
$driver->report_mode = MYSQLI_REPORT_ALL;
try {
/* if the connection fails, a mysqli_sql_exception will be thrown */
$mysqli = new mysqli("localhost", "my_user", "my_password", "my_db");
/* this query should report an error */
$result = $mysqli->query("SELECT Name FROM Nonexistingtable WHERE population > 50000");
/* this query should report a bad index */
/* this query should report a bad index if the column population doesn't have an index */
$result = $mysqli->query("SELECT Name FROM City WHERE population > 50000");
$result->close();
$mysqli->close();
} catch (mysqli_sql_exception $e) {
echo $e->__toString();
error_log($e->__toString());
}
?>
]]>
</programlisting>
</example>
@ -128,27 +118,45 @@ try {
<programlisting role="php">
<![CDATA[
<?php
/* activate reporting */
mysqli_report(MYSQLI_REPORT_ALL);
$link = mysqli_connect("localhost", "my_user", "my_password", "world");
try {
$link = mysqli_connect("localhost", "my_user", "my_password", "my_db");
/* check connection */
if (mysqli_connect_errno()) {
printf("Connect failed: %s\n", mysqli_connect_error());
exit();
/* this query should report an error */
$result = mysqli_query($link, "SELECT Name FROM Nonexistingtable WHERE population > 50000");
/* this query should report a bad index if the column population doesn't have an index */
$result = mysqli_query($link, "SELECT Name FROM City WHERE population > 50000");
} catch (mysqli_sql_exception $e) {
error_log($e->__toString());
}
]]>
</programlisting>
</example>
<example>
<title>Error reporting except bad index errors</title>
<programlisting role="php">
<![CDATA[
<?php
/* this query should report an error */
$result = mysqli_query("SELECT Name FROM Nonexistingtable WHERE population > 50000");
/* activate reporting */
mysqli_report(MYSQLI_REPORT_ERROR | MYSQLI_REPORT_STRICT);
/* this query should report a bad index */
$result = mysqli_query("SELECT Name FROM City WHERE population > 50000");
try {
/* if the connection fails, a mysqli_sql_exception will be thrown */
$mysqli = new mysqli("localhost", "my_user", "my_password", "my_db");
mysqli_free_result($result);
/* this query should report an error */
$result = $mysqli->query("SELECT Name FROM Nonexistingtable WHERE population > 50000");
mysqli_close($link);
?>
/* this WILL NOT report any errors even if index is not available */
$result = $mysqli->query("SELECT Name FROM City WHERE population > 50000");
} catch (mysqli_sql_exception $e) {
error_log($e->__toString());
}
]]>
</programlisting>
</example>
@ -158,8 +166,6 @@ mysqli_close($link);
&reftitle.seealso;
<para>
<simplelist>
<member><function>mysqli_debug</function></member>
<member><function>mysqli_dump_debug_info</function></member>
<member><classname>mysqli_sql_exception</classname></member>
<member><function>set_exception_handler</function></member>
<member><function>error_reporting</function></member>

3
reference/mysqli/summary.xml
View file

@ -677,7 +677,10 @@
<entry><emphasis role="bold">Properties</emphasis></entry>
</row>
<row>
<entry><link linkend="mysqli-driver.report-mode">$mysqli_driver::mysqli_report</link></entry>
<entry><function>mysqli_report</function></entry>
<entry>N/A</entry>
<entry>Sets mysqli error reporting mode</entry>
</row>
<row>
<entry><emphasis role="bold">Methods</emphasis></entry>