PocketMine-MP/src/event/EventPriority.php
Dylan K. Taylor e9038336e3 EventPriority: hardcode name -> value mapping instead of using constant()
this would have caught fire if additional non-priority constants were added, or if the constants were renamed.
2020-10-23 20:14:37 +01:00

100 lines
2.3 KiB
PHP

<?php
/*
*
* ____ _ _ __ __ _ __ __ ____
* | _ \ ___ ___| | _____| |_| \/ (_)_ __ ___ | \/ | _ \
* | |_) / _ \ / __| |/ / _ \ __| |\/| | | '_ \ / _ \_____| |\/| | |_) |
* | __/ (_) | (__| < __/ |_| | | | | | | | __/_____| | | | __/
* |_| \___/ \___|_|\_\___|\__|_| |_|_|_| |_|\___| |_| |_|_|
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* @author PocketMine Team
* @link http://www.pocketmine.net/
*
*
*/
declare(strict_types=1);
namespace pocketmine\event;
use function mb_strtoupper;
/**
* List of event priorities
*
* Events will be called in this order:
* LOWEST -> LOW -> NORMAL -> HIGH -> HIGHEST -> MONITOR
*
* MONITOR events should not change the event outcome or contents
*/
final class EventPriority{
private function __construct(){
//NOOP
}
public const ALL = [
self::LOWEST,
self::LOW,
self::NORMAL,
self::HIGH,
self::HIGHEST,
self::MONITOR
];
/**
* Event call is of very low importance and should be ran first, to allow
* other plugins to further customise the outcome
*/
public const LOWEST = 5;
/**
* Event call is of low importance
*/
public const LOW = 4;
/**
* Event call is neither important or unimportant, and may be ran normally.
* This is the default priority.
*/
public const NORMAL = 3;
/**
* Event call is of high importance
*/
public const HIGH = 2;
/**
* Event call is critical and must have the final say in what happens
* to the event
*/
public const HIGHEST = 1;
/**
* Event is listened to purely for monitoring the outcome of an event.
*
* No modifications to the event should be made under this priority
*/
public const MONITOR = 0;
/**
* @throws \InvalidArgumentException
*/
public static function fromString(string $name) : int{
$value = [
"LOWEST" => self::LOWEST,
"LOW" => self::LOW,
"NORMAL" => self::NORMAL,
"HIGH" => self::HIGH,
"HIGHEST" => self::HIGHEST,
"MONITOR" => self::MONITOR
][mb_strtoupper($name)] ?? null;
if($value !== null){
return $value;
}
throw new \InvalidArgumentException("Unable to resolve priority \"$name\"");
}
}