wikimedia / mediawiki-extensions-Lingo

src/MessageLog.php

<?php

/**
 * File holding the Lingo\MessageLog class.
 *
 * This file is part of the MediaWiki extension Lingo.
 *
 * @copyright 2011 - 2018, Stephan Gambke
 * @license GPL-2.0-or-later
 *
 * The Lingo extension is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by the Free
 * Software Foundation; either version 2 of the License, or (at your option) any
 * later version.
 *
 * The Lingo extension is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program. If not, see <http://www.gnu.org/licenses/>.
 *
 * @author Stephan Gambke
 *
 * @file
 * @ingroup Lingo
 */

namespace Lingo;

use Html;
use Parser;
use ParserOptions;

/**
 * This class holds messages (errors, warnings, notices) for Lingo
 *
 * Contains a static function to initiate the parsing.
 *
 * @ingroup Lingo
 */
class MessageLog {

	private $mMessages = [];
	private $mParser = null;

	const MESSAGE_ERROR = 1;
	const MESSAGE_WARNING = 2;
	const MESSAGE_NOTICE = 3;

	/**
	 * @param string $message
	 * @param int $severity
	 */
	public function addMessage( $message, $severity = self::MESSAGE_NOTICE ) {
		$this->mMessages[] = [ $message, $severity ];

		// log errors and warnings in debug log
		if ( $severity == self::MESSAGE_WARNING ||

Operator == prohibited; use === instead

			$severity == self::MESSAGE_ERROR

Operator == prohibited; use === instead

		) {
			wfDebug( $message );
		}
	}

	/**
	 * @param string $message
	 */
	public function addError( $message ) {
		$this->mMessages[] = [ $message, self::MESSAGE_ERROR ];
		wfDebug( "Error: $message\n" );

As per coding-style, please use concatenation or sprintf for the variable $message instead of interpolation.

	}

	/**
	 * @param string $message
	 */
	public function addWarning( $message ) {
		$this->mMessages[] = [ $message, self::MESSAGE_WARNING ];
		wfDebug( "Warning: $message\n" );

As per coding-style, please use concatenation or sprintf for the variable $message instead of interpolation.

	}

	/**
	 * @param string $message
	 */
	public function addNotice( $message ) {
		$this->mMessages[] = [ $message, self::MESSAGE_NOTICE ];
	}

	/**
	 * @param int $severity
	 * @param null $header

Are you sure the doc-type for parameter $header is correct as it would always require null to be passed?

	 * @return null|string
	 */
	public function getMessagesFormatted( $severity = self::MESSAGE_WARNING, $header = null ) {
		global $wgTitle, $wgUser;

		$ret = '';

		foreach ( $this->mMessages as $message ) {
			if ( $message[ 1 ] <= $severity ) {
				$ret .= '* ' . $message[ 0 ] . "\n";
			}
		}

		if ( $ret != '' ) {

Operator != prohibited; use !== instead

			if ( !$this->mParser ) {
				$parser = new Parser();
			}

			if ( $header == null ) {

Operator == prohibited; use === instead

				$header = '';
			} elseif ( $header != '' ) {

Operator != prohibited; use !== instead

				$header = Html::rawElement( 'div', [ 'class' => 'heading' ], $header );
			}

			$ret = Html::rawElement( 'div', [ 'class' => 'messages' ],
				$header . "\n" .
				$ret
			);

			// FIXME: Variable 'parser' might have not been defined

Comment refers to a FIXME task "Variable 'parser' might have not been defined"

			// FIXME: $parser->parse returns ParserOutput, not String

Comment refers to a FIXME task "$parser->parse returns ParserOutput, not String"

			$ret = $parser->parse( $ret, $wgTitle, ParserOptions::newFromUser( $wgUser ) );
		} else {
			// FIXME: Should probably return '' (and throw an error if necessary)

Comment refers to a FIXME task "Should probably return '' (and throw an error if necessary"

			$ret = null;
		}

		return $ret;
	}

}