1	<?php
2	declare(strict_types=1);
3	/**
4	* Pop PHP Framework (https://www.popphp.org/)
5	*
6	* @link       https://github.com/popphp/popphp-framework
7	* @author     Nick Sagona, III <nick@popphp.org>
8	* @copyright  Copyright (c) 2009-2026 Nick Sagona, III
9	* @license    https://www.popphp.org/license     New BSD License
10	*/
11
12	/**
13	* @namespace
14	*/
15	namespace Pop\Dispatch;
16
17	/**
18	* Dispatch maintenance interface
19	*
20	* @category   Pop
21	* @package    Pop
22	* @author     Nick Sagona, III <nick@popphp.org>
23	* @copyright  Copyright (c) 2009-2026 Nick Sagona, III
24	* @license    https://www.popphp.org/license     New BSD License
25	* @version    5.0.0
26	*/
27	interface MaintenanceInterface
28	{
29
30	/**
31	* Set the maintenance action
32	*
33	* @param  string $maintenance
34	* @return static
35	*/
36	public function setMaintenanceAction(string $maintenance): static;
37
38	/**
39	* Get the maintenance action
40	*
41	* @return string
42	*/
43	public function getMaintenanceAction(): string;
44
45	/**
46	* Check the bypass maintenance check
47	*
48	* @param  bool $bypass
49	* @return static
50	*/
51	public function setBypassMaintenance(bool $bypass = true): static;
52
53	/**
54	* Check the bypass maintenance check
55	*
56	* @return bool
57	*/
58	public function bypassMaintenance(): bool;
59
60	/**
61	* Dispatch the maintenance action
62	*
63	* @throws \Pop\Dispatch\Exception
64	* @return void
65	*/
66	public function dispatchMaintenance(): void;
67
68	}