elkarte / Elkarte

sources/database/Database.subs.php

<?php

/**
 * This file has all the main functions in it that set up the database connection
 * and initializes the appropriate adapters.
 *
 * @package   ElkArte Forum
 * @copyright ElkArte Forum contributors
 * @license   BSD http://opensource.org/licenses/BSD-3-Clause (see accompanying LICENSE.txt file)
 *
 * @version 2.0 dev
 *
 */

/**
 * Initialize database classes and connection.
 *
 * @param string $db_server server name
 * @param string $db_name database name like forum
 * @param string $db_user userid to attempt db connection
 * @param string $db_passwd password of user to attempt db connection
 * @param string $db_prefix prefix of the database, like elkarte_
 * @param mixed[] $db_options
 * @param string $db_type
 *
 * @return \ElkArte\Database\QueryInterface
 */
function elk_db_initiate($db_server, $db_name, $db_user, $db_passwd, $db_prefix, $db_options = array(), $db_type = 'mysql')

The parameter $db_user is not used and could be removed.

The parameter $db_server is not used and could be removed.

The parameter $db_name is not used and could be removed.

The parameter $db_options is not used and could be removed.

The parameter $db_prefix is not used and could be removed.

The parameter $db_type is not used and could be removed.

The parameter $db_passwd is not used and could be removed.

{
	return database(false);
}

/**
 * Retrieve existing instance of the active database class.
 *
 * @param bool $fatal - Stop the execution or throw an \Exception
 * @param bool $force - Force the re-creation of the database instance.
 *                      If set to true, from that moment onwards the old
 *                      instance will be lost and only the new one returned
 *
 * @return \ElkArte\Database\QueryInterface
 * @throws \Exception if fatal is false
 */
function database($fatal = true, $force = false)
{
	static $db = null;

	if ($db === null || $force === true)
	{
		global $db_persist, $db_server, $db_user, $db_passwd, $db_port;
		global $db_type, $db_name, $db_prefix, $mysql_set_mode;

		$db_options = [
			'persist' => $db_persist,
			'select_db' => true,
			'port' => $db_port,
			'mysql_set_mode' => (bool) ($mysql_set_mode ?? false)
		];
		$type = strtolower($db_type);
		$type = $type === 'mysql' ? 'mysqli' : $type;

		/** @var \ElkArte\Database\Mysqli\Connection $class */
		$class = '\\ElkArte\\Database\\' . ucfirst($type) . '\\Connection';
		try
		{
			$db = $class::initiate($db_server, $db_name, $db_user, $db_passwd, $db_prefix, $db_options);
		}
		catch (\Exception $e)
		{
			if ($fatal === true)
			{
				\ElkArte\Errors\Errors::instance()->display_db_error($e->getMessage());

The type ElkArte\Errors\Errors was not found. Maybe you did not declare it correctly or list all dependencies?

			}
			else
			{
				throw $e;
			}
		}
	}

	return $db;
}

/**
 * This function retrieves an existing instance of \ElkArte\AbstractTable
 * and returns it.
 *
 * @param object|null $db - A database object (e.g. \ElkArte\Mysqli\Query)
 * @param bool $fatal - Stop the execution or throw an \Exception
 *
 * @return \ElkArte\Database\AbstractTable
 */
function db_table($db = null, $fatal = false)
{
	global $db_prefix, $db_type;
	static $db_table = null;

	if ($db_table === null)
	{
		if ($db === null)
		{
			$db = database();
		}
		$db_type = strtolower($db_type);
		$db_type = $db_type === 'mysql' ? 'mysqli' : $db_type;
		$class = '\\ElkArte\\Database\\' . ucfirst($db_type) . '\\Table';
		try
		{
			$db_table = new $class($db, $db_prefix);
		}
		catch (\Exception $e)
		{
			if ($fatal === true)
			{
				\ElkArte\Errors\Errors::instance()->display_db_error($e->getMessage());
			}
			else
			{
				throw $e;
			}
		}
	}

	return $db_table;
}

/**
 * This function returns an instance of \ElkArte\AbstractSearch,
 * specifically designed for database utilities related to search.
 *
 * @return \ElkArte\Database\AbstractSearch
 */
function db_search()
{
	global $db_type;
	static $db_search = null;

	if ($db_search === null)
	{
		$db = database();
		$db_type = strtolower($db_type);
		$db_type = $db_type === 'mysql' ? 'mysqli' : $db_type;
		$class = '\\ElkArte\\Database\\' . ucfirst($db_type) . '\\Search';
		try
		{
			$db_search = new $class($db);
		}
		catch (\Exception $e)
		{
			\ElkArte\Errors\Errors::instance()->display_db_error($e->getMessage());
		}
	}

	return $db_search;
}