includes/editpage/Constraint/MissingCommentConstraint.php

   1 <?php
   2 /**
   3  * This program is free software; you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation; either version 2 of the License, or
   6  * (at your option) any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along
  14  * with this program; if not, write to the Free Software Foundation, Inc.,
  15  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  16  * http://www.gnu.org/copyleft/gpl.html
  17  *
  18  * @file
  19  */
  20
  21 namespace MediaWiki\EditPage\Constraint;
  22
  23 use StatusValue;
  24
  25 /**
  26  * Do not allow the user to post an empty comment (only used for new section)
  27  *
  28  * @since 1.36
  29  * @internal
  30  * @author DannyS712
  31  */
  32 class MissingCommentConstraint implements IEditConstraint {
  33
  34         /** @var string */
  35         private $userComment;
  36
  37         /**
  38          * @param string $userComment
  39          */
  40         public function __construct( string $userComment ) {
  41                 $this->userComment = $userComment;
  42         }
  43
  44         public function checkConstraint() : string {
  45                 if ( $this->userComment == '' ) {
  46                         // TODO this was == in EditPage, can it be === ?
  47                         return self::CONSTRAINT_FAILED;
  48                 }
  49                 return self::CONSTRAINT_PASSED;
  50         }
  51
  52         public function getLegacyStatus() : StatusValue {
  53                 $statusValue = StatusValue::newGood();
  54                 if ( $this->userComment == '' ) {
  55                         $statusValue->fatal( 'missingcommenttext' );
  56                         $statusValue->value = self::AS_TEXTBOX_EMPTY;
  57                 }
  58                 return $statusValue;
  59         }
  60
  61 }