MadelineProto/src/danog/MadelineProto/Shutdown.php

93 lines
2.6 KiB
PHP
Raw Normal View History

2019-06-06 19:54:22 +02:00
<?php
2020-01-31 19:29:43 +01:00
2019-06-06 19:54:22 +02:00
/**
* Shutdown module.
*
* This file is part of MadelineProto.
* MadelineProto is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
* MadelineProto is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
* See the GNU Affero General Public License for more details.
* You should have received a copy of the GNU General Public License along with MadelineProto.
* If not, see <http://www.gnu.org/licenses/>.
*
* @author Daniil Gentili <daniil@daniil.it>
2020-02-17 14:13:46 +01:00
* @copyright 2016-2020 Daniil Gentili <daniil@daniil.it>
2019-06-06 19:54:22 +02:00
* @license https://opensource.org/licenses/AGPL-3.0 AGPLv3
*
2019-10-31 15:07:35 +01:00
* @link https://docs.madelineproto.xyz MadelineProto documentation
2019-06-06 19:54:22 +02:00
*/
namespace danog\MadelineProto;
/**
* Class that controls script shutdown.
2019-06-06 19:54:22 +02:00
*/
class Shutdown
{
/**
2019-09-02 17:08:36 +02:00
* Callbacks to call on shutdown.
2019-06-06 19:54:22 +02:00
*
* @var array<callable>
*/
private static $callbacks = [];
/**
2019-09-02 17:08:36 +02:00
* Whether the main shutdown was registered.
2019-06-06 19:54:22 +02:00
*
* @var boolean
*/
private static $registered = false;
/**
2019-09-02 17:08:36 +02:00
* Incremental ID for new callback.
2019-06-06 19:54:22 +02:00
*
* @var integer
*/
private static $id = 0;
/**
2019-09-02 17:08:36 +02:00
* Function to be called on shutdown.
*
2019-06-06 19:54:22 +02:00
* @return void
*/
public static function shutdown()
{
foreach (self::$callbacks as $callback) {
$callback();
}
Magic::shutdown(0);
2019-06-06 19:54:22 +02:00
}
/**
2019-09-02 17:08:36 +02:00
* Add a callback for script shutdown.
*
2019-06-06 19:54:22 +02:00
* @param callable $callback The callback to set
* @param null|string $id The optional callback ID
2019-09-02 17:08:36 +02:00
*
2020-09-22 23:10:56 +02:00
* @return int|string The callback ID
2019-06-06 19:54:22 +02:00
*/
public static function addCallback($callback, $id = null)
{
if (!$id) {
$id = self::$id++;
}
self::$callbacks[$id] = $callback;
if (!self::$registered) {
2019-09-02 17:08:36 +02:00
\register_shutdown_function([__CLASS__, 'shutdown']);
2019-06-06 19:54:22 +02:00
self::$registered = true;
}
return $id;
}
/**
2019-09-02 17:08:36 +02:00
* Remove a callback from the script shutdown callable list.
*
2020-09-22 23:10:56 +02:00
* @param null|string|int $id The optional callback ID
2019-09-02 17:08:36 +02:00
*
2019-06-06 19:54:22 +02:00
* @return bool true if the callback was removed correctly, false otherwise
*/
public static function removeCallback($id)
{
if (isset(self::$callbacks[$id])) {
unset(self::$callbacks[$id]);
return true;
}
return false;
}
2019-09-02 17:08:36 +02:00
}