EditConstraintRunner.php

Go to the documentation of this file.

<?php
namespace MediaWiki\EditPage\Constraint;
 
use MediaWiki\Logger\LoggerFactory;
use Psr\Log\LoggerInterface;
use Wikimedia\Assert\Assert;
 
class EditConstraintRunner {
 
    private $logger;
 
    private $constraints = [];
 
    private $failedConstraint = false;
 
    public function __construct() {
        // TODO allow passing an array here as the starting constraints?
        // TODO consider injecting this?
        $this->logger = LoggerFactory::getInstance( 'EditConstraintRunner' );
    }
 
    public function addConstraint( IEditConstraint $constraint ) {
        $this->constraints[] = $constraint;
    }
 
    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;
    }
 
    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;
    }
 
    public function getFailedConstraint(): IEditConstraint {
        Assert::precondition(
            $this->failedConstraint !== false,
            'getFailedConstraint called with no failed constraint'
        );
        return $this->failedConstraint;
    }
 
}