AutoSummaryMissingSummaryConstraint.php

Go to the documentation of this file.

<?php
namespace MediaWiki\EditPage\Constraint;
 
use Content;
use StatusValue;
 
class AutoSummaryMissingSummaryConstraint implements IEditConstraint {
 
    private $userSummary;
 
    private $autoSummary;
 
    private $allowBlankSummary;
 
    private $newContent;
 
    private $originalContent;
 
    private $result;
 
    public function __construct(
        string $userSummary,
        string $autoSummary,
        bool $allowBlankSummary,
        Content $newContent,
        Content $originalContent
    ) {
        $this->userSummary = $userSummary;
        $this->autoSummary = $autoSummary;
        $this->allowBlankSummary = $allowBlankSummary;
        $this->newContent = $newContent;
        $this->originalContent = $originalContent;
    }
 
    public function checkConstraint(): string {
        if (
            !$this->allowBlankSummary &&
            !$this->newContent->equals( $this->originalContent ) &&
            !$this->newContent->isRedirect() &&
            md5( $this->userSummary ) == $this->autoSummary
        ) {
            // TODO this was == in EditPage, can it be === ?
            $this->result = self::CONSTRAINT_FAILED;
        } else {
            $this->result = self::CONSTRAINT_PASSED;
        }
        return $this->result;
    }
 
    public function getLegacyStatus(): StatusValue {
        $statusValue = StatusValue::newGood();
        if ( $this->result === self::CONSTRAINT_FAILED ) {
            $statusValue->fatal( 'missingsummary' );
            $statusValue->value = self::AS_SUMMARY_NEEDED;
        }
        return $statusValue;
    }
 
}