Dual procedural and object-oriented interface (original) (raw)

The mysqli extension features a dual interface. It supports the procedural and object-oriented programming paradigm.

Users migrating from the old mysql extension may prefer the procedural interface. The procedural interface is similar to that of the old mysql extension. In many cases, the function names differ only by prefix. Some mysqli functions take a connection handle as their first argument, whereas matching functions in the old mysql interface take it as an optional last argument.

Example #1 Easy migration from the old mysql extension

<?php $mysqli = mysqli_connect("example.com", "user", "password", "database"); <math xmlns="http://www.w3.org/1998/Math/MathML"><semantics><mrow><mi>r</mi><mi>e</mi><mi>s</mi><mo>=</mo><mi>m</mi><mi>y</mi><mi>s</mi><mi>q</mi><mi>l</mi><msub><mi>i</mi><mi>q</mi></msub><mi>u</mi><mi>e</mi><mi>r</mi><mi>y</mi><mo stretchy="false">(</mo></mrow><annotation encoding="application/x-tex">res = mysqli_query(</annotation></semantics></math>res=mysqliquery(mysqli, "SELECT 'Please, do not use ' AS _msg FROM DUAL"); <math xmlns="http://www.w3.org/1998/Math/MathML"><semantics><mrow><mi>r</mi><mi>o</mi><mi>w</mi><mo>=</mo><mi>m</mi><mi>y</mi><mi>s</mi><mi>q</mi><mi>l</mi><msub><mi>i</mi><mi>f</mi></msub><mi>e</mi><mi>t</mi><mi>c</mi><msub><mi>h</mi><mi>a</mi></msub><mi>s</mi><mi>s</mi><mi>o</mi><mi>c</mi><mo stretchy="false">(</mo></mrow><annotation encoding="application/x-tex">row = mysqli_fetch_assoc(</annotation></semantics></math>row=mysqlifetchassoc(res); echo <math xmlns="http://www.w3.org/1998/Math/MathML"><semantics><mrow><mi>r</mi><mi>o</mi><mi>w</mi><msubsup><mo stretchy="false">[</mo><mi>m</mi><mo mathvariant="normal" lspace="0em" rspace="0em">′</mo></msubsup><mi>s</mi><msup><mi>g</mi><mo mathvariant="normal" lspace="0em" rspace="0em">′</mo></msup><mo stretchy="false">]</mo><mo separator="true">;</mo></mrow><annotation encoding="application/x-tex">row['_msg'];</annotation></semantics></math>row[m′sg′];mysql = mysql_connect("example.com", "user", "password"); mysql_select_db("test"); <math xmlns="http://www.w3.org/1998/Math/MathML"><semantics><mrow><mi>r</mi><mi>e</mi><mi>s</mi><mo>=</mo><mi>m</mi><mi>y</mi><mi>s</mi><mi>q</mi><msub><mi>l</mi><mi>q</mi></msub><mi>u</mi><mi>e</mi><mi>r</mi><mi>y</mi><mo stretchy="false">(</mo><mi mathvariant="normal">"</mi><mi>S</mi><mi>E</mi><mi>L</mi><mi>E</mi><mi>C</mi><msup><mi>T</mi><mo mathvariant="normal" lspace="0em" rspace="0em">′</mo></msup><mi>t</mi><mi>h</mi><mi>e</mi><mi>m</mi><mi>y</mi><mi>s</mi><mi>q</mi><mi>l</mi><mi>e</mi><mi>x</mi><mi>t</mi><mi>e</mi><mi>n</mi><mi>s</mi><mi>i</mi><mi>o</mi><mi>n</mi><mi>f</mi><mi>o</mi><mi>r</mi><mi>n</mi><mi>e</mi><mi>w</mi><mi>d</mi><mi>e</mi><mi>v</mi><mi>e</mi><mi>l</mi><mi>o</mi><mi>p</mi><mi>m</mi><mi>e</mi><mi>n</mi><mi>t</mi><mi>s</mi><msup><mi mathvariant="normal">.</mi><mo mathvariant="normal" lspace="0em" rspace="0em">′</mo></msup><mi>A</mi><msub><mi>S</mi><mi>m</mi></msub><mi>s</mi><mi>g</mi><mi>F</mi><mi>R</mi><mi>O</mi><mi>M</mi><mi>D</mi><mi>U</mi><mi>A</mi><mi>L</mi><mi mathvariant="normal">"</mi><mo separator="true">,</mo></mrow><annotation encoding="application/x-tex">res = mysql_query("SELECT 'the mysql extension for new developments.' AS _msg FROM DUAL", </annotation></semantics></math>res=mysqlquery("SELECT′themysqlextensionfornewdevelopments.′ASmsgFROMDUAL",mysql); <math xmlns="http://www.w3.org/1998/Math/MathML"><semantics><mrow><mi>r</mi><mi>o</mi><mi>w</mi><mo>=</mo><mi>m</mi><mi>y</mi><mi>s</mi><mi>q</mi><msub><mi>l</mi><mi>f</mi></msub><mi>e</mi><mi>t</mi><mi>c</mi><msub><mi>h</mi><mi>a</mi></msub><mi>s</mi><mi>s</mi><mi>o</mi><mi>c</mi><mo stretchy="false">(</mo></mrow><annotation encoding="application/x-tex">row = mysql_fetch_assoc(</annotation></semantics></math>row=mysqlfetchassoc(res); echo $row['_msg']; ?>

The above example will output:

Please, do not use the mysql extension for new developments.

The object-oriented interface

In addition to the classical procedural interface, users can choose to use the object-oriented interface. The documentation is organized using the object-oriented interface. The object-oriented interface shows functions grouped by their purpose, making it easier to get started. The reference section gives examples for both syntax variants.

There are no significant performance differences between the two interfaces. Users can base their choice on personal preference.

Example #2 Object-oriented and procedural interface

<?php $mysqli = mysqli_connect("example.com", "user", "password", "database"); if (mysqli_connect_errno()) { echo "Failed to connect to MySQL: " . mysqli_connect_error(); }$res = mysqli_query($mysqli, "SELECT 'A world full of ' AS _msg FROM DUAL"); <math xmlns="http://www.w3.org/1998/Math/MathML"><semantics><mrow><mi>r</mi><mi>o</mi><mi>w</mi><mo>=</mo><mi>m</mi><mi>y</mi><mi>s</mi><mi>q</mi><mi>l</mi><msub><mi>i</mi><mi>f</mi></msub><mi>e</mi><mi>t</mi><mi>c</mi><msub><mi>h</mi><mi>a</mi></msub><mi>s</mi><mi>s</mi><mi>o</mi><mi>c</mi><mo stretchy="false">(</mo></mrow><annotation encoding="application/x-tex">row = mysqli_fetch_assoc(</annotation></semantics></math>row=mysqlifetchassoc(res); echo <math xmlns="http://www.w3.org/1998/Math/MathML"><semantics><mrow><mi>r</mi><mi>o</mi><mi>w</mi><msubsup><mo stretchy="false">[</mo><mi>m</mi><mo mathvariant="normal" lspace="0em" rspace="0em">′</mo></msubsup><mi>s</mi><msup><mi>g</mi><mo mathvariant="normal" lspace="0em" rspace="0em">′</mo></msup><mo stretchy="false">]</mo><mo separator="true">;</mo></mrow><annotation encoding="application/x-tex">row['_msg'];</annotation></semantics></math>row[m′sg′];mysqli = new mysqli("example.com", "user", "password", "database"); if ($mysqli->connect_errno) { echo "Failed to connect to MySQL: " . $mysqli->connect_error; }$res = $mysqli->query("SELECT 'choices to please everybody.' AS _msg FROM DUAL"); <math xmlns="http://www.w3.org/1998/Math/MathML"><semantics><mrow><mi>r</mi><mi>o</mi><mi>w</mi><mo>=</mo></mrow><annotation encoding="application/x-tex">row = </annotation></semantics></math>row=res->fetch_assoc(); echo $row['_msg']; ?>

The above example will output:

A world full of choices to please everybody.

The object oriented interface is used for the quickstart because the reference section is organized that way.

Mixing styles

It is possible to switch between styles at any time. Mixing both styles is not recommended for code clarity and coding style reasons.

Example #3 Bad coding style

`<?php
$mysqli = new mysqli("example.com", "user", "password", "database");
if ($mysqli->connect_errno) {
echo "Failed to connect to MySQL: " . $mysqli->connect_error;
}$res = mysqli_query($mysqli, "SELECT 'Possible but bad style.' AS _msg FROM DUAL");
if (!$res) {
echo "Failed to run query: (" . mysqli−>errno.")".mysqli->errno . ") " . mysqli−>errno.")".mysqli->error;
}

if ( row=row = row=res->fetch_assoc()) {
echo $row['_msg'];
}
?> `

The above example will output:

See also