Page Menu
Home
WickedGov Phorge
Search
Configure Global Search
Log In
Files
F7401877
EditConstraintRunner.php
No One
Temporary
Actions
Download File
Edit File
Delete File
View Transforms
Subscribe
Flag For Later
Award Token
Size
3 KB
Referenced Files
None
Subscribers
None
EditConstraintRunner.php
View Options
<?php
/**
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
*/
namespace
MediaWiki\EditPage\Constraint
;
use
MediaWiki\Logger\LoggerFactory
;
use
Psr\Log\LoggerInterface
;
use
Wikimedia\Assert\Assert
;
/**
* Back end to process the edit constraints
*
* Constraints reflect possible errors that need to be checked
*
* @since 1.36
* @internal
* @author DannyS712
*/
class
EditConstraintRunner
{
private
LoggerInterface
$logger
;
/**
* @var IEditConstraint[]
*
* Constraints to check.
*/
private
$constraints
=
[];
/**
* @var IEditConstraint|false
*
* The constraint that failed, so that its status can be fetched, or false if none failed.
*/
private
$failedConstraint
=
false
;
/**
* Create a new runner
*/
public
function
__construct
()
{
// TODO allow passing an array here as the starting constraints?
// TODO consider injecting this?
$this
->
logger
=
LoggerFactory
::
getInstance
(
'EditConstraintRunner'
);
}
/**
* Add a constraint to check
*
* Not all constraints are applicable to the action api or other methods of submitting
* an edit
*
* For constraints that have dependencies, use the EditConstraintFactory.
*
* @param IEditConstraint $constraint
*/
public
function
addConstraint
(
IEditConstraint
$constraint
)
{
$this
->
constraints
[]
=
$constraint
;
}
/**
* Run constraint checks
*
* Returns true if all constraints pass, false otherwise.
* Check getLegacyStatus for the reason
*
* @return bool
*/
public
function
checkConstraints
():
bool
{
foreach
(
$this
->
constraints
as
$constraint
)
{
$result
=
$constraint
->
checkConstraint
();
if
(
$result
!==
IEditConstraint
::
CONSTRAINT_PASSED
)
{
// Use `info` instead of `debug` for the one constraint that failed
$this
->
logger
->
info
(
'Checked {name}, got result: {result}'
,
[
'name'
=>
$this
->
getConstraintName
(
$constraint
),
'result'
=>
$result
]
);
$this
->
failedConstraint
=
$constraint
;
return
false
;
}
// Pass, log at `debug` level
$this
->
logger
->
debug
(
'Checked {name}, got result: {result}'
,
[
'name'
=>
$this
->
getConstraintName
(
$constraint
),
'result'
=>
$result
]
);
}
return
true
;
}
/**
* @param IEditConstraint $constraint
* @return string
*/
private
function
getConstraintName
(
IEditConstraint
$constraint
):
string
{
// Used for debug logging
$fullClassName
=
explode
(
'
\\
'
,
get_class
(
$constraint
)
);
$constraintName
=
end
(
$fullClassName
);
if
(
$constraint
instanceof
PageSizeConstraint
)
{
// TODO "When you need to do this instanceof, it's a code smell"
// Convert IEditConstraint to abstract class with a getName method
// once the initial migration to edit constraints is complete
// PageSizeConstraint is used twice, make sure they can be told apart
$constraintName
.=
' '
.
$constraint
->
getType
();
}
return
$constraintName
;
}
/**
* Get the constraint that failed
*
* @return IEditConstraint
*/
public
function
getFailedConstraint
():
IEditConstraint
{
Assert
::
precondition
(
$this
->
failedConstraint
!==
false
,
'getFailedConstraint called with no failed constraint'
);
return
$this
->
failedConstraint
;
}
}
File Metadata
Details
Attached
Mime Type
text/x-php
Expires
Sat, Nov 21, 17:43 (16 h, 25 m)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
fc/4c/b545c56b3c67734a1f25e8a0d760
Default Alt Text
EditConstraintRunner.php (3 KB)
Attached To
Mode
rMWPROD MediaWiki Production
Attached
Detach File
Event Timeline
Log In to Comment