mysqli_driver.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<phpdoc:classref xml:id="class.mysqli-driver" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
 <title>The mysqli_driver class</title>
 <titleabbrev>mysqli_driver</titleabbrev>
 
 <partintro>
 
<!-- {{{ ClassName intro -->
  <section xml:id="mysqli-driver.intro">
   &reftitle.intro;
   <para>
    The <classname>mysqli_driver</classname> class is an instance of the monostate
    pattern, i.e. there is only one driver which can be accessed though an arbitrary
    amount of <classname>mysqli_driver</classname> instances.
   </para>
  </section>
<!-- }}} -->
 
  <section xml:id="mysqli-driver.synopsis">
   &reftitle.classsynopsis;
 
<!-- {{{ Synopsis -->
   <classsynopsis class="class">
    <ooclass>
     <modifier>final</modifier>
     <classname>mysqli_driver</classname>
    </ooclass>

    <classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>readonly</modifier>
     <type>string</type>
     <varname linkend="mysqli-driver.props.client-info">client_info</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>readonly</modifier>
     <type>int</type>
     <varname linkend="mysqli-driver.props.client-version">client_version</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>readonly</modifier>
     <type>int</type>
     <varname linkend="mysqli-driver.props.driver-version">driver_version</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <type>int</type>
     <varname linkend="mysqli-driver.props.report-mode">report_mode</varname>
    </fieldsynopsis>
   </classsynopsis>
<!-- }}} -->
 
  </section>
<!-- {{{ mysqli_driver properties -->
  <section xml:id="mysqli-driver.props">
   &reftitle.properties;
   <variablelist>
    <varlistentry xml:id="mysqli-driver.props.client-info">
     <term><varname>client_info</varname></term>
     <listitem>
      <para>The Client API header version</para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="mysqli-driver.props.client-version">
     <term><varname>client_version</varname></term>
     <listitem>
      <para>The Client version</para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="mysqli-driver.props.driver-version">
     <term><varname>driver_version</varname></term>
     <listitem>
      <para>The MySQLi Driver version</para>
      <warning><simpara>This property has
      been <emphasis>deprecated</emphasis> as of PHP 8.1.0. Relying on this
      property is highly discouraged.</simpara></warning>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="mysqli-driver.props.embedded">
     <term><varname>embedded</varname></term>
     <listitem>
      <para>Whether MySQLi Embedded support is enabled</para>
      <warning><simpara>This property has
      been <emphasis>removed</emphasis> as of PHP 8.0.0.</simpara></warning>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="mysqli-driver.props.reconnect">
     <term><varname>reconnect</varname></term>
     <listitem>
      <para>Allow or prevent reconnect (see the <link linkend="ini.mysqli.reconnect">mysqli.reconnect</link> INI directive)</para>
      <warning>
       <simpara>This property has been <emphasis>removed</emphasis>
        along with the <link linkend="ini.mysqli.reconnect">mysqli.reconnect</link> INI directive as of PHP 8.2.0.
       </simpara>
      </warning>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="mysqli-driver.props.report-mode">
     <term><varname>report_mode</varname></term>
     <listitem>
      <para>
       Set to <constant>MYSQLI_REPORT_OFF</constant>,
       <constant>MYSQLI_REPORT_ALL</constant> or any combination of
       <constant>MYSQLI_REPORT_STRICT</constant> (throw Exceptions for errors),
       <constant>MYSQLI_REPORT_ERROR</constant> (report errors) and
       <constant>MYSQLI_REPORT_INDEX</constant> (errors regarding indexes).
       See also <function>mysqli_report</function>.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </section>
<!-- }}} -->

  <section role="changelog">
   &reftitle.changelog;
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>8.2.0</entry>
       <entry>
         <property>mysqli_driver::$reconnect</property> was removed.
       </entry>
      </row>
      <row>
       <entry>8.1.0</entry>
       <entry>
        <property>mysqli_driver::$driver_version</property> has been deprecated.
       </entry>
      </row>
      <row>
       <entry>8.0.0</entry>
       <entry>
        <property>mysqli_driver::$embedded</property> was removed.
       </entry>
      </row>
      <row>
       <entry>7.4.0</entry>
       <entry>
        <methodname>mysqli_driver::embedded_server_start</methodname> and
        <methodname>mysqli_driver:embedded_server_end</methodname> were removed.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </section>
  
 </partintro>
 
 &reference.mysqli.entities.mysqli-driver;

</phpdoc:classref>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->