Standardize signature for queryData() methods

Signed-off-by: Jon Stovell <[email protected]>

Sources/Alert.php

@@ -774,6 +774,7 @@ public static function load(int|array $ids = [], array $query_customizations = [
 		$joins = $query_customizations['joins'] ?? [];
 		$where = $query_customizations['where'] ?? [];
 		$order = $query_customizations['order'] ?? ['a.id_alert DESC'];
+		$group = $query_customizations['group'] ?? [];
 		$limit = $query_customizations['limit'] ?? min(!empty(Config::$modSettings['alerts_per_page']) ? Config::$modSettings['alerts_per_page'] : 1000, 1000);
 		$params = $query_customizations['params'] ?? [];
 
@@ -1594,20 +1595,23 @@ protected static function deleteInvisible(array &$alerts, int $memID): void
 	 *    If this is left empty, no WHERE clause will be used.
 	 * @param array $order Zero or more conditions for the ORDER BY clause.
 	 *    If this is left empty, no ORDER BY clause will be used.
+	 * @param array $group Zero or more conditions for the GROUP BY clause.
+	 *    If this is left empty, no GROUP BY clause will be used.
 	 * @param int|string $limit Maximum number of results to retrieve.
 	 *    If this is left empty, all results will be retrieved.
 	 *
 	 * @return Generator<array> Iterating over the result gives database rows.
 	 */
-	protected static function queryData(array $selects, array $params = [], array $joins = [], array $where = [], array $order = [], int|string $limit = 0)
+	protected static function queryData(array $selects, array $params = [], array $joins = [], array $where = [], array $order = [], array $group = [], int|string $limit = 0)
 	{
 		$request = Db::$db->query(
 			'',
 			'SELECT
 				' . implode(', ', $selects) . '
 			FROM {db_prefix}user_alerts AS a' . (empty($joins) ? '' : '
 				' . implode("\n\t\t\t\t", $joins)) . (empty($where) ? '' : '
-			WHERE (' . implode(') AND (', $where) . ')') . (empty($order) ? '' : '
+			WHERE (' . implode(') AND (', $where) . ')') . (empty($group) ? '' : '
+			GROUP BY ' . implode(', ', $group)) . (empty($order) ? '' : '
 			ORDER BY ' . implode(', ', $order)) . (!empty($limit) ? '
 			LIMIT ' . $limit : ''),
 			$params,

Sources/Board.php

@@ -53,7 +53,6 @@ class Board implements \ArrayAccess
 			'getModeratorGroups' => 'getBoardModeratorGroups',
 			'isChildOf' => 'isChildOf',
 			'getParents' => 'getBoardParents',
-			'queryData' => 'queryData',
 		],
 		'prop_names' => [
 			'board_id' => 'board',
@@ -2189,12 +2188,14 @@ public static function getParents(int $id_parent): array
 	 *    If this is left empty, no WHERE clause will be used.
 	 * @param array $order Zero or more conditions for the ORDER BY clause.
 	 *    If this is left empty, no ORDER BY clause will be used.
+	 * @param array $group Zero or more conditions for the GROUP BY clause.
+	 *    If this is left empty, no GROUP BY clause will be used.
 	 * @param int $limit Maximum number of results to retrieve.
 	 *    If this is left empty, all results will be retrieved.
 	 *
 	 * @return Generator<array> Iterating over the result gives database rows.
 	 */
-	public static function queryData(array $selects, array $params = [], array $joins = [], array $where = [], array $order = [], int $limit = 0)
+	public static function queryData(array $selects, array $params = [], array $joins = [], array $where = [], array $order = [], array $group = [], int $limit = 0)
 	{
 		// If we only want some child boards, use a CTE query for improved performance.
 		if (!empty($params['id_parent']) && in_array('b.id_parent != 0', $where) && Db::$db->cte_support()) {

Sources/Event.php

@@ -955,6 +955,7 @@ public static function get(string $low_date, string $high_date, bool $use_permis
 			'cal.end_date >= {date:low_date}',
 		];
 		$order = $query_customizations['order'] ?? [];
+		$group = $query_customizations['group'] ?? [];
 		$limit = $query_customizations['limit'] ?? 0;
 		$params = $query_customizations['params'] ?? [
 			'high_date' => $high_date,
@@ -966,9 +967,9 @@ public static function get(string $low_date, string $high_date, bool $use_permis
 			$where[] = '(cal.id_board = {int:no_board_link} OR {query_wanna_see_board})';
 		}
 
-		IntegrationHook::call('integrate_query_event', [&$selects, &$params, &$joins, &$where, &$order, &$limit]);
+		IntegrationHook::call('integrate_query_event', [&$selects, &$params, &$joins, &$where, &$order, &$group, &$limit]);
 
-		foreach(self::queryData($selects, $params, $joins, $where, $order, $limit) as $row) {
+		foreach(self::queryData($selects, $params, $joins, $where, $order, $group, $limit) as $row) {
 			// If the attached topic is not approved then for the moment pretend it doesn't exist.
 			if (!empty($row['id_first_msg']) && Config::$modSettings['postmod_active'] && !$row['approved']) {
 				continue;
@@ -1169,20 +1170,23 @@ protected function fixEndDate(): void
 	 *    If this is left empty, no WHERE clause will be used.
 	 * @param array $order Zero or more conditions for the ORDER BY clause.
 	 *    If this is left empty, no ORDER BY clause will be used.
+	 * @param array $group Zero or more conditions for the GROUP BY clause.
+	 *    If this is left empty, no GROUP BY clause will be used.
 	 * @param int|string $limit Maximum number of results to retrieve.
 	 *    If this is left empty, all results will be retrieved.
 	 *
 	 * @return Generator<array> Iterating over the result gives database rows.
 	 */
-	protected static function queryData(array $selects, array $params = [], array $joins = [], array $where = [], array $order = [], int|string $limit = 0)
+	protected static function queryData(array $selects, array $params = [], array $joins = [], array $where = [], array $order = [], array $group = [], int|string $limit = 0)
 	{
 		$request = Db::$db->query(
 			'',
 			'SELECT
 				' . implode(', ', $selects) . '
 			FROM {db_prefix}calendar AS cal' . (empty($joins) ? '' : '
 				' . implode("\n\t\t\t\t", $joins)) . (empty($where) ? '' : '
-			WHERE (' . implode(') AND (', $where) . ')') . (empty($order) ? '' : '
+			WHERE (' . implode(') AND (', $where) . ')') . (empty($group) ? '' : '
+			GROUP BY ' . implode(', ', $group)) . (empty($order) ? '' : '
 			ORDER BY ' . implode(', ', $order)) . (!empty($limit) ? '
 			LIMIT ' . $limit : ''),
 			$params,

Sources/Group.php

@@ -2611,6 +2611,8 @@ protected static function getLink(object $group): string
 	 *    If this is left empty, no WHERE clause will be used.
 	 * @param array $order Zero or more conditions for the ORDER BY clause.
 	 *    If this is left empty, no ORDER BY clause will be used.
+	 * @param array $group Zero or more conditions for the GROUP BY clause.
+	 *    If this is left empty, no GROUP BY clause will be used.
 	 * @param int|string $limit Maximum number of results to retrieve.
 	 *    If this is left empty, all results will be retrieved.
 	 *

Sources/Msg.php

@@ -575,6 +575,7 @@ public static function get($ids, array $query_customizations = [])
 		$order = $query_customizations['order'] ?? [
 			'm.id_msg' . (empty(Theme::$current->options['view_newest_first']) ? '' : ' DESC'),
 		];
+		$group = $query_customizations['group'] ?? [];
 		$limit = $query_customizations['limit'] ?? 0;
 		$params = $query_customizations['params'] ?? [
 			'new_from' => Topic::$info->new_from ?? Config::$modSettings['maxMsgID'] + 1,
@@ -587,9 +588,9 @@ public static function get($ids, array $query_customizations = [])
 		// Just FYI, for historical reasons the order in which the arguments are
 		// passed to this hook is different than the order in which they are
 		// passed to the queryData() method.
-		IntegrationHook::call('integrate_query_message', [&$selects, &$joins, &$params, &$where, &$order, &$limit]);
+		IntegrationHook::call('integrate_query_message', [&$selects, &$joins, &$params, &$where, &$order, &$group, &$limit]);
 
-		foreach(self::queryData($selects, $params, $joins, $where, $order, $limit) as $row) {
+		foreach(self::queryData($selects, $params, $joins, $where, $order, $group, $limit) as $row) {
 			$id = (int) $row['id_msg'];
 
 			yield (new self($id, $row));
@@ -3009,20 +3010,23 @@ public static function spell_suggest($dict, $word): array
 	 *    If this is left empty, no WHERE clause will be used.
 	 * @param array $order Zero or more conditions for the ORDER BY clause.
 	 *    If this is left empty, no ORDER BY clause will be used.
+	 * @param array $group Zero or more conditions for the GROUP BY clause.
+	 *    If this is left empty, no GROUP BY clause will be used.
 	 * @param int|string $limit Maximum number of results to retrieve.
 	 *    If this is left empty, all results will be retrieved.
 	 *
 	 * @return Generator<array> Iterating over the result gives database rows.
 	 */
-	protected static function queryData(array $selects, array $params = [], array $joins = [], array $where = [], array $order = [], int|string $limit = 0)
+	protected static function queryData(array $selects, array $params = [], array $joins = [], array $where = [], array $order = [], array $group = [], int|string $limit = 0)
 	{
 		self::$messages_request = Db::$db->query(
 			'',
 			'SELECT
 				' . implode(', ', $selects) . '
 			FROM {db_prefix}messages AS m' . (empty($joins) ? '' : '
 				' . implode("\n\t\t\t\t", $joins)) . (empty($where) ? '' : '
-			WHERE (' . implode(') AND (', $where) . ')') . (empty($order) ? '' : '
+			WHERE (' . implode(') AND (', $where) . ')') . (empty($group) ? '' : '
+			GROUP BY ' . implode(', ', $group)) . (empty($order) ? '' : '
 			ORDER BY ' . implode(', ', $order)) . (!empty($limit) ? '
 			LIMIT ' . $limit : ''),
 			$params,

Sources/Search/SearchResult.php

@@ -462,6 +462,7 @@ public static function get($ids, array $query_customizations = [])
 			Db::$db->custom_order('m.id_msg', $ids),
 		];
 
+		$group = $query_customizations['group'] ?? [];
 		$limit = $query_customizations['limit'] ?? '{int:limit}';
 
 		$params = $query_customizations['params'] ?? [
@@ -475,7 +476,7 @@ public static function get($ids, array $query_customizations = [])
 			$params['message_list'] = self::$messages_to_get = array_filter(array_unique(array_map('intval', (array) $ids)));
 		}
 
-		foreach(self::queryData($selects, $params, $joins, $where, $order, $limit) as $row) {
+		foreach(self::queryData($selects, $params, $joins, $where, $order, $group, $limit) as $row) {
 			$id = (int) $row['id_msg'];
 
 			yield (new self($id, $row));