EditConstraintRunner.php

Go to the documentation of this file.

<?php
namespace MediaWiki\EditPage\Constraint;
 
use MediaWiki\EditPage\EditPageStatus;
use MediaWiki\Logger\LoggerFactory;
use Psr\Log\LoggerInterface;
 
class EditConstraintRunner {
 
    private LoggerInterface $logger;
 
    private $constraints = [];
 
    public function __construct( EditConstraint ...$constraints ) {
        // TODO consider injecting this?
        $this->logger = LoggerFactory::getInstance( 'EditConstraintRunner' );
        $this->addConstraints( ...$constraints );
    }
 
    public function addConstraint( EditConstraint $constraint ) {
        $this->constraints[] = $constraint;
    }
 
    public function addConstraints( EditConstraint ...$constraints ) {
        foreach ( $constraints as $constraint ) {
            $this->addConstraint( $constraint );
        }
    }
 
    public function checkConstraints(): EditPageStatus {
        foreach ( $this->constraints as $constraint ) {
            $status = $constraint->checkConstraint();
            $this->logConstraintCheck( $constraint, $status );
 
            if ( !$status->isOK() ) {
                $status->setFailedConstraint( $constraint );
                return $status;
            }
        }
 
        return EditPageStatus::newGood();
    }
 
    public function checkAllConstraints(): EditPageStatus {
        $statusValue = EditPageStatus::newGood();
 
        foreach ( $this->constraints as $constraint ) {
            $constraintStatus = $constraint->checkConstraint();
            $this->logConstraintCheck( $constraint, $constraintStatus );
            $statusValue->merge( $constraintStatus );
        }
 
        return $statusValue;
    }
 
    private function logConstraintCheck( EditConstraint $constraint, EditPageStatus $status ): void {
        if ( $status->isOK() ) {
            $this->logger->debug(
                'Check for {name} succeeded',
                [
                    'name' => $constraint->getName(),
                ]
            );
        } else {
            $this->logger->info(
                'Check for {name} failed',
                [
                    'name' => $constraint->getName(),
                ]
            );
        }
    }
 
}