Query/src/common.php

<?php declare(strict_types=1);
/**
 * Query
 *
 * SQL Query Builder / Database Abstraction Layer
 *
 * PHP version 8.1
 *
 * @package     Query
 * @author      Timothy J. Warren <tim@timshome.page>
 * @copyright   2012 - 2023 Timothy J. Warren
 * @license     http://www.opensource.org/licenses/mit-license.html  MIT License
 * @link        https://git.timshomepage.net/aviat/Query
 * @version     4.0.0
 */

use Query\{ConnectionManager, QueryBuilderInterface};

/**
 * Global functions that don't really fit anywhere else
 */
/**
 * Multibyte-safe trim function
 */
function mb_trim(string $string): string
{
	return preg_replace('/(^\s+)|(\s+$)/u', '', $string);
}

/**
 * Filter out db rows into one array
 */
function dbFilter(array $array, mixed $index): array
{
	$newArray = [];

	foreach ($array as $a)
	{
		$newArray[] = $a[$index];
	}

	return $newArray;
}

/**
 * Zip a set of arrays together on common keys
 *
 * The $zipperInput array is an array of arrays indexed by their place in the output
 * array.
 */
function arrayZipper(array $zipperInput): array
{
	$output = [];

	foreach ($zipperInput as $appendKey => $values)
	{
		foreach ($values as $index => $value)
		{
			if ( ! isset($output[$index]))
			{
				$output[$index] = [];
			}
			$output[$index][$appendKey] = $value;
		}
	}

	return $output;
}

/**
 * Determine whether a value in the passed array matches the pattern
 * passed
 */
function regexInArray(array $array, string $pattern): bool
{
	if (empty($array))
	{
		return FALSE;
	}

	foreach ($array as $item)
	{
		if (is_scalar($item) && preg_match($pattern, (string) $item))
		{
			return TRUE;
		}
	}

	return FALSE;
}

/**
 * Connection function
 *
 * Send an array or object as connection parameters to create a connection. If
 * the array or object has an 'alias' parameter, passing that string to this
 * function will return that connection. Passing no parameters returns the last
 * connection created.
 */
function Query(string|object|array|null $params = ''): ?QueryBuilderInterface
{
	if ($params === NULL)
	{
		return NULL;
	}

	$manager = ConnectionManager::getInstance();

	// If you are getting a previously created connection
	if (is_string($params))
	{
		return $manager->getConnection($params);
	}

	$paramsObject = (object) $params;

	// Otherwise, return a new connection
	return $manager->connect($paramsObject);
}

// End of common.php