1	<?php
2	/**
3	* This program is free software; you can redistribute it and/or modify
4	* it under the terms of the GNU General Public License as published by
5	* the Free Software Foundation; either version 2 of the License, or
6	* (at your option) any later version.
7	*
8	* This program is distributed in the hope that it will be useful,
9	* but WITHOUT ANY WARRANTY; without even the implied warranty of
10	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11	* GNU General Public License for more details.
12	*
13	* You should have received a copy of the GNU General Public License along
14	* with this program; if not, write to the Free Software Foundation, Inc.,
15	* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
16	* http://www.gnu.org/copyleft/gpl.html
17	*
18	* @file
19	*/
20
21	namespace MediaWiki\EditPage\Constraint;
22
23	use MediaWiki\EditPage\IEditObject;
24	use StatusValue;
25
26	/**
27	* Interface for all constraints that can prevent edits
28	*
29	* @since 1.36
30	* @internal
31	* @author DannyS712
32	*/
33	interface IEditConstraint extends IEditObject {
34
35	/** @var string - Constraint passed, no error */
36	public const CONSTRAINT_PASSED = 'constraint-passed';
37
38	/** @var string - Constraint failed, use getLegacyStatus to see the failure */
39	public const CONSTRAINT_FAILED = 'constraint-failed';
40
41	/**
42	* @return string whether the constraint passed, either CONSTRAINT_PASSED or CONSTRAINT_FAILED
43	*/
44	public function checkConstraint(): string;
45
46	/**
47	* Get the legacy status for failure (or success)
48	*
49	* Called "legacy" status because this part of the interface should probably be redone;
50	* Currently Status objects have a value of an IEditObject constant, as well as a fatal
51	* message
52	*
53	* @return StatusValue
54	*/
55	public function getLegacyStatus(): StatusValue;
56
57	}