Back end to process the edit constraints. More...

Public Member Functions
	__construct (EditConstraint ... $constraints)
	Create a new runner.

	addConstraint (EditConstraint $constraint)
	Add a constraint to check.

	addConstraints (EditConstraint ... $constraints)
	Add multiple edit constraints to check.

	checkAllConstraints ()
	Run all constraint checks and merge the returned statuses.

	checkConstraints ()
	Run constraint checks until one fails.

Detailed Description

Back end to process the edit constraints.

Constraints reflect possible errors that need to be checked

Since: 1.36

Access: internal

Author: DannyS712

Definition at line 22 of file EditConstraintRunner.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\EditPage\Constraint\EditConstraintRunner::__construct ( EditConstraint ... $constraints )

Create a new runner.

Definition at line 36 of file EditConstraintRunner.php.

References MediaWiki\EditPage\Constraint\EditConstraintRunner\addConstraints().

Member Function Documentation

◆ addConstraint()

MediaWiki\EditPage\Constraint\EditConstraintRunner::addConstraint ( EditConstraint $constraint )

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.

Definition at line 50 of file EditConstraintRunner.php.

Referenced by MediaWiki\EditPage\Constraint\EditConstraintRunner\addConstraints().

◆ addConstraints()

MediaWiki\EditPage\Constraint\EditConstraintRunner::addConstraints ( EditConstraint ... $constraints )

Add multiple edit constraints to check.

See also: addConstraint()

Definition at line 58 of file EditConstraintRunner.php.

References MediaWiki\EditPage\Constraint\EditConstraintRunner\addConstraint().

Referenced by MediaWiki\EditPage\Constraint\EditConstraintRunner\__construct().

◆ checkAllConstraints()

MediaWiki\EditPage\Constraint\EditConstraintRunner::checkAllConstraints ( )

Run all constraint checks and merge the returned statuses.

Returns: EditPageStatus Good if all constraints pass, otherwise a status that was merged with all statuses that were returned by constraint checks. Note: This status does not have the failed constraint set, since multiple constraints may have failed.

Definition at line 90 of file EditConstraintRunner.php.

◆ checkConstraints()

MediaWiki\EditPage\Constraint\EditConstraintRunner::checkConstraints ( )

Run constraint checks until one fails.

Returns: EditPageStatus Good if all constraints pass, otherwise the status returned by the constraint that failed.

Definition at line 69 of file EditConstraintRunner.php.

The documentation for this class was generated from the following file:

includes/EditPage/Constraint/EditConstraintRunner.php

Public Member Functions