Added a ClosureTask implementation for easier task scheduling (#2497)

This commit is contained in:
Dylan T 2018-11-04 22:55:40 +00:00 committed by GitHub
parent 3dabf90b0e
commit 755db3dac8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 71 additions and 0 deletions

View File

@ -0,0 +1,58 @@
<?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\scheduler;
use pocketmine\utils\Utils;
/**
* Task implementation which allows closures to be called by a scheduler.
*
* Example usage:
*
* ```
* TaskScheduler->scheduleTask(new ClosureTask(function(int $currentTick) : void{
* echo "HI on $currentTick\n";
* });
* ```
*/
class ClosureTask extends Task{
/** @var \Closure */
private $closure;
/**
* @param \Closure $closure Must accept only ONE parameter, $currentTick
*/
public function __construct(\Closure $closure){
$this->closure = $closure;
}
public function getName() : string{
return Utils::getNiceClosureName($this->closure);
}
public function onRun(int $currentTick){
($this->closure)($currentTick);
}
}

View File

@ -52,6 +52,19 @@ class Utils{
}
}
/**
* Returns a readable identifier for the given Closure, including file and line.
*
* @param \Closure $closure
*
* @return string
* @throws \ReflectionException
*/
public static function getNiceClosureName(\Closure $closure) : string{
$func = new \ReflectionFunction($closure);
return "closure@" . self::cleanPath($func->getFileName()) . "#L" . $func->getStartLine();
}
/**
* Returns a readable identifier for the class of the given object. Sanitizes class names for anonymous classes.
*