View source for Breaking Changes in v1.10.00

Customizing and migrating to v1.10.00 will require some new changes.

== Queries ==

There are three main changes that affect all database queries in XMB.

=== Global $db Service Locator ===

Instead of providing a global variable named <code>$db</code>, XMB now offers two services named <code>db</code> and <code>sql</code>.

For a direct replacement of the global shared object reference, just add this near the top of your file:

<code>
$db = \XMB\Services\db();
</code>

If you need to create a 2nd database connection (to a different account or server) within your script, then use the revised class name instead:

<pre>
$db2 = new \XMB\MySQLiDatabase(debug: false, logErrors: true);
$db2->connect(...);
</pre>

Internally, XMB is starting to use methods of the shared <code>sql</code> service instead of direct or prepared statements.  This results in cleaner and more secure code.  For example, to get the shared service and check your inbox:

<pre>
$sql = \XMB\Services\sql();
$vars = \XMB\Services\vars();

$msgCount = $sql->countU2UInbox($vars->self['username']);
</pre>

If you wish to write similar query methods, the best practice is to create your own object class rather than try to modify the XMB service.

=== The tablepre Variable ===

Instead of providing a global constant named <code>X_PREFIX</code>, XMB now stores the <code>$tablepre</code> variable from <code>config.php</code> as a property of the shared <code>vars</code> service.  The direct replacement looks like this:

<pre>
$vars = \XMB\Services\vars();

$statement = 'SELECT * FROM' . $vars->tablepre . 'ranks';
</pre>

=== Example ===

Here is an actual query from the old <code>cp2.php</code> file:

<pre>
require ROOT . 'header.php';

$query = $db->query("SELECT * FROM ".X_PREFIX."restricted ORDER BY id");
</pre>

Here is how it changed in the new <code>restrictions.php</code> file during development of v1.10.00:

<pre>
require ROOT . 'header.php';

$db = \XMB\Services\db();
$vars = \XMB\Services\vars();

$query = $db->query("SELECT * FROM " . $vars->tablepre . "restricted ORDER BY id");
</pre>