smrealms / smr

src/lib/Smr/Messages.php

<?php declare(strict_types=1);

namespace Smr;

use Exception;
use SmrPlayer;

/**
 * Collection of functions to help display messages and message boxes.
 */
class Messages {

	/**
	 * @return ($typeID is null ? array<int, string> : string)

The doc comment ($typeID at position 1 could not be parsed: Unknown type name '$typeID' at position 1 in ($typeID.

	 */
	public static function getMessageTypeNames(int $typeID = null): array|string {
		$typeNames = [
			MSG_PLAYER => 'Player Messages',
			MSG_PLANET => 'Planet Messages',
			MSG_SCOUT => 'Scout Messages',
			MSG_ALLIANCE => 'Alliance Messages',
			MSG_POLITICAL => 'Political Messages',
			MSG_GLOBAL => 'Global Messages',
			MSG_ADMIN => 'Admin Messages',
			MSG_CASINO => 'Casino Messages',
			MSG_SENT => 'Sent Messages',
		];
		return $typeID === null ? $typeNames : $typeNames[$typeID];
	}

	public static function getMessageTypeImage(int $typeID): string {
		return match ($typeID) {
			MSG_PLAYER => 'images/personal_msg.png',
			MSG_PLANET => 'images/planet_msg.png',
			MSG_SCOUT => 'images/scout_msg.png',
			MSG_ALLIANCE => 'images/alliance_msg.png',
			MSG_POLITICAL => 'images/council_msg.png',
			MSG_GLOBAL => 'images/global_msg.png',
			MSG_ADMIN => 'images/admin_msg.png',
			MSG_CASINO => 'images/casino_msg.png',
			default => throw new Exception('No image for message type ID: ' . $typeID),
		};
	}

	/**
	 * @return array<int, string>
	 */
	public static function getAdminBoxNames(): array {
		return [
			BOX_BUGS_AUTO => 'Automatic Bug Reports',
			BOX_BUGS_REPORTED => 'Player Bug Reports',
			BOX_GLOBALS => 'Global Messages',
			BOX_ALLIANCE_DESCRIPTIONS => 'Alliance Descriptions',
			BOX_ALBUM_COMMENTS => 'Photo Album Comments',
			BOX_BARTENDER => 'Bartender Gossip',
		];
	}

	public static function getMessagePlayer(int $accountID, int $gameID, int $messageType = null): string|SmrPlayer {
		if ($accountID == ACCOUNT_ID_PORT) {
			$return = '<span class="yellow">Port Defenses</span>';
		} elseif ($accountID == ACCOUNT_ID_ADMIN) {
			$return = '<span class="admin">Administrator</span>';
		} elseif ($accountID == ACCOUNT_ID_PLANET) {
			$return = '<span class="yellow">Planetary Defenses</span>';
		} elseif ($accountID == ACCOUNT_ID_ALLIANCE_AMBASSADOR) {
			$return = '<span class="green">Alliance Ambassador</span>';
		} elseif ($accountID == ACCOUNT_ID_CASINO) {
			$return = '<span class="yellow">Casino</span>';
		} elseif ($accountID == ACCOUNT_ID_FED_CLERK) {
			$return = '<span class="yellow">Federal Clerk</span>';
		} elseif ($accountID == ACCOUNT_ID_OP_ANNOUNCE || $accountID == ACCOUNT_ID_ALLIANCE_COMMAND) {
			$return = '<span class="green">Alliance Command</span>';
		} else {
			foreach (Race::getAllNames() as $raceID => $raceName) {
				if ($accountID == ACCOUNT_ID_GROUP_RACES + $raceID) {
					return '<span class="yellow">' . $raceName . ' Government</span>';
				}
			}
			if (!empty($accountID)) {
				$return = SmrPlayer::getPlayer($accountID, $gameID);
			} else {
				$return = match ($messageType) {
					MSG_ADMIN => '<span class="admin">Administrator</span>',
					MSG_ALLIANCE => '<span class="green">Alliance Ambassador</span>',
					default => 'Unknown',
				};
			}
		}
		return $return;
	}

}