getBoardList()

Complexity

Conditions	36
Paths	> 20000

Size

Total Lines	191
Code Lines	92

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	40
CRAP Score	222.2522

Importance

Changes

0

<?php
function getBoardList($boardListOptions = [], $simple = false)
{
	global $modSettings;

	$db = database();

	if ((isset($boardListOptions['excluded_boards']) || isset($boardListOptions['allowed_to'])) && isset($boardListOptions['included_boards']))
	{
		trigger_error('getBoardList(): Setting both excluded_boards and included_boards is not allowed.', E_USER_ERROR);
	}

	$where = [];
	$join = [];
	$select = '';
	$where_parameters = [];

	// Any boards to exclude
	if (isset($boardListOptions['excluded_boards']))
	{
		$where[] = 'b.id_board NOT IN ({array_int:excluded_boards})';
		$where_parameters['excluded_boards'] = $boardListOptions['excluded_boards'];
	}

	// Get list of boards to which they have specific permissions
	if (isset($boardListOptions['allowed_to']))
	{
		$boardListOptions['included_boards'] = boardsAllowedTo($boardListOptions['allowed_to']);
		if (in_array(0, $boardListOptions['included_boards']))
		{
			unset($boardListOptions['included_boards']);
		}
	}

	// Just want to include certain boards in the query
	if (isset($boardListOptions['included_boards']))
	{
		$where[] = 'b.id_board IN ({array_int:included_boards})';
		$where_parameters['included_boards'] = $boardListOptions['included_boards'];
	}

	// Determine if they can access a given board and return yea or nay in the results array
	if (isset($boardListOptions['access']))
	{
		$select .= ',
			FIND_IN_SET({string:current_group}, b.member_groups) != 0 AS can_access,
			FIND_IN_SET({string:current_group}, b.deny_member_groups) != 0 AS cannot_access';
		$where_parameters['current_group'] = $boardListOptions['access'];
	}

	// Leave out the boards that the user may be ignoring
	if (isset($boardListOptions['ignore']))
	{
		$select .= ',' . (!empty($boardListOptions['ignore']) ? 'b.id_board IN ({array_int:ignore_boards})' : '0') . ' AS is_ignored';
		$where_parameters['ignore_boards'] = $boardListOptions['ignore'];
	}

	// Want to check if the member is a moderators for any boards
	if (isset($boardListOptions['moderator']))
	{
		$join[] = '
			LEFT JOIN {db_prefix}moderators AS mods ON (mods.id_board = b.id_board AND mods.id_member = {int:current_member})';
		$select .= ', b.id_profile, b.member_groups, COALESCE(mods.id_member, 0) AS is_mod';
		$where_parameters['current_member'] = $boardListOptions['moderator'];
	}

	if (!empty($boardListOptions['ignore_boards']) && empty($boardListOptions['override_permissions']))
	{
		$where[] = '{query_wanna_see_board}';
	}
	elseif (empty($boardListOptions['override_permissions']))
	{
		$where[] = '{query_see_board}';
	}

	if (!empty($boardListOptions['not_redirection']))
	{
		$where[] = 'b.redirect = {string:blank_redirect}';
		$where_parameters['blank_redirect'] = '';
	}

	// Bring all the options together and make the query
	$request = $db->query('', '
		SELECT 
			c.name AS cat_name, c.id_cat, 
			b.id_board, b.name AS board_name, b.child_level' . $select . '
		FROM {db_prefix}boards AS b
			LEFT JOIN {db_prefix}categories AS c ON (c.id_cat = b.id_cat)' . (empty($join) ? '' : implode(' ', $join)) . (empty($where) ? '' : '
		WHERE ' . implode('
			AND ', $where)) . '
		ORDER BY c.cat_order, b.board_order',
		$where_parameters
	);

	// Build our output arrays, simple or complete
	if ($simple)
	{
		$return_value = [];
		while (($row = $request->fetch_assoc()))
		{
			$return_value[$row['id_board']] = [
				'id_cat' => (int) $row['id_cat'],
				'cat_name' => $row['cat_name'],
				'id_board' => (int) $row['id_board'],
				'board_name' => $row['board_name'],
				'child_level' => (int) $row['child_level'],
			];

			// Do we want access information?
			if (isset($boardListOptions['access']) && $boardListOptions['access'] !== false)
			{
				$return_value[$row['id_board']]['allow'] = !(empty($row['can_access']) || $row['can_access'] === 'f');
				$return_value[$row['id_board']]['deny'] = !(empty($row['cannot_access']) || $row['cannot_access'] === 'f');
			}

			// Do we want moderation information?
			if (!empty($boardListOptions['moderator']))
			{
				$return_value[$row['id_board']] += [
					'id_profile' => (int) $row['id_profile'],
					'member_groups' => $row['member_groups'],
					'is_mod' => $row['is_mod'],
				];
			}
		}
	}
	else
	{
		$return_value = [
			'num_boards' => $request->num_rows(),
			'boards_check_all' => true,
			'boards_current_disabled' => true,
			'categories' => [],
		];
		while (($row = $request->fetch_assoc()))
		{
			// This category hasn't been set up yet..
			if (!isset($return_value['categories'][$row['id_cat']]))
			{
				$return_value['categories'][$row['id_cat']] = [
					'id' => (int) $row['id_cat'],
					'name' => $row['cat_name'],
					'boards' => [],
				];
			}

			// Shortcuts are useful to keep things simple
			$this_cat = &$return_value['categories'][$row['id_cat']];

			$this_cat['boards'][(int) $row['id_board']] = [
				'id' => (int) $row['id_board'],
				'name' => $row['board_name'],
				'child_level' => (int) $row['child_level'],
				'allow' => false,
				'deny' => false,
				'selected' => isset($boardListOptions['selected_board']) && $boardListOptions['selected_board'] == $row['id_board'],
			];
			// Do we want access information?

			if (!empty($boardListOptions['access']))
			{
				$this_cat['boards'][$row['id_board']]['allow'] = !(empty($row['can_access']) || $row['can_access'] === 'f');
				$this_cat['boards'][$row['id_board']]['deny'] = !(empty($row['cannot_access']) || $row['cannot_access'] === 'f');
			}

			// If is_ignored is set, it means we could have to deselect a board
			if (isset($row['is_ignored']))
			{
				$this_cat['boards'][$row['id_board']]['selected'] = $row['is_ignored'];

				// If a board wasn't checked that probably should have been ensure the board selection is selected, yo!
				if (!empty($this_cat['boards'][$row['id_board']]['selected']) && (empty($modSettings['recycle_enable']) || $row['id_board'] != $modSettings['recycle_board']))
				{
					$return_value['boards_check_all'] = false;
				}
			}

			// Do we want moderation information?
			if (!empty($boardListOptions['moderator']))
			{
				$this_cat['boards'][(int) $row['id_board']] += [
					'id_profile' => (int) $row['id_profile'],
					'member_groups' => $row['member_groups'],
					'is_mod' => $row['is_mod'],
				];
			}
		}
	}

	$request->free_result();

	return $return_value;
}