Status.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Status;
 
use MediaWiki\Context\IContextSource;
use MediaWiki\Context\RequestContext;
use MediaWiki\Language\Language;
use MediaWiki\MediaWikiServices;
use MediaWiki\Message\Message;
use MediaWiki\StubObject\StubUserLang;
use MessageLocalizer;
use RuntimeException;
use StatusValue;
 
class Status extends StatusValue {
    public $cleanCallback = false;
 
    protected $messageLocalizer;
 
    private ?StatusFormatter $formatter = null;
 
    public static function wrap( $sv ) {
        if ( $sv instanceof static ) {
            return $sv;
        }
 
        $result = new static();
        $result->ok =& $sv->ok;
        $result->errors =& $sv->errors;
        $result->value =& $sv->value;
        $result->successCount =& $sv->successCount;
        $result->failCount =& $sv->failCount;
        $result->success =& $sv->success;
        $result->statusData =& $sv->statusData;
 
        return $result;
    }
 
    public function __get( $name ) {
        if ( $name === 'ok' ) {
            return $this->isOK();
        }
        if ( $name === 'errors' ) {
            return $this->getErrors();
        }
 
        throw new RuntimeException( "Cannot get '$name' property." );
    }
 
    public function __set( $name, $value ) {
        if ( $name === 'ok' ) {
            $this->setOK( $value );
        } else {
            throw new RuntimeException( "Cannot set '$name' property." );
        }
    }
 
    public function setMessageLocalizer( MessageLocalizer $messageLocalizer ) {
        // TODO: hard deprecate after switching callers to StatusFormatter
        $this->messageLocalizer = $messageLocalizer;
        $this->formatter = null;
    }
 
    private function getFormatter(): StatusFormatter {
        if ( !$this->formatter ) {
            $context = RequestContext::getMain();
 
            // HACK: only works for IContextSource objects.
            if ( $this->messageLocalizer && $this->messageLocalizer instanceof IContextSource ) {
                $context = $this->messageLocalizer;
            }
 
            $formatterFactory = MediaWikiServices::getInstance()->getFormatterFactory();
            $this->formatter = $formatterFactory->getStatusFormatter( $context );
        }
 
        return $this->formatter;
    }
 
    public function splitByErrorType() {
        [ $errorsOnlyStatus, $warningsOnlyStatus ] = parent::splitByErrorType();
        // phan/phan#2133?
        '@phan-var Status $errorsOnlyStatus';
        '@phan-var Status $warningsOnlyStatus';
 
        if ( $this->messageLocalizer ) {
            $errorsOnlyStatus->setMessageLocalizer = $this->messageLocalizer;
            $warningsOnlyStatus->setMessageLocalizer = $this->messageLocalizer;
        }
 
        if ( $this->formatter ) {
            $errorsOnlyStatus->formatter = $this->formatter;
            $warningsOnlyStatus->formatter = $this->formatter;
        }
 
        $errorsOnlyStatus->cleanCallback = $warningsOnlyStatus->cleanCallback = $this->cleanCallback;
 
        return [ $errorsOnlyStatus, $warningsOnlyStatus ];
    }
 
    public function getStatusValue() {
        return $this;
    }
 
    public function getWikiText( $shortContext = false, $longContext = false, $lang = null ) {
        return $this->getFormatter()->getWikiText( $this, [
            'shortContext' => $shortContext,
            'longContext' => $longContext,
            'lang' => $lang,
            'cleanCallback' => $this->cleanCallback
        ] );
    }
 
    public function getMessage( $shortContext = false, $longContext = false, $lang = null ) {
        return $this->getFormatter()->getMessage( $this, [
            'shortContext' => $shortContext,
            'longContext' => $longContext,
            'lang' => $lang,
            'cleanCallback' => $this->cleanCallback
        ] );
    }
 
    public function getPsr3MessageAndContext( array $context = [] ): array {
        return $this->getFormatter()->getPsr3MessageAndContext( $this, $context );
    }
 
    public function getHTML( $shortContext = false, $longContext = false, $lang = null ) {
        return $this->getFormatter()->getHTML( $this, [
            'shortContext' => $shortContext,
            'longContext' => $longContext,
            'lang' => $lang,
            'cleanCallback' => $this->cleanCallback
        ] );
    }
 
    public function getErrorsArray() {
        return $this->getStatusArray( 'error' );
    }
 
    public function getWarningsArray() {
        return $this->getStatusArray( 'warning' );
    }
 
    public function __sleep() {
        $keys = array_keys( get_object_vars( $this ) );
        return array_diff( $keys, [ 'cleanCallback', 'messageLocalizer', 'formatter' ] );
    }
 
    public function __wakeup() {
        $this->cleanCallback = false;
        $this->messageLocalizer = null;
        $this->formatter = null;
    }
 
}
 
class_alias( Status::class, 'Status' );