BotRiconferme\TaskHelper\TaskResult

Complexity

Total Complexity

8

Size/Duplication

Total Lines	69
Duplicated Lines	0 %

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	3	1
A	isOK()	0	2	1
A	getStatus()	0	2	1
A	__toString()	0	13	3
A	merge()	0	3	1
A	getErrors()	0	2	1

<?php declare( strict_types=1 );

namespace BotRiconferme\TaskHelper;

/**
 * Object wrapping the result of the execution of a task.
 */
class TaskResult {
	// Status codes. GOOD = everything fine, NOTHING = nothing to do, ERROR = found non-fatal errors
	public const STATUS_NOTHING = 0;
	public const STATUS_GOOD = 1;
	public const STATUS_ERROR = 3;

	/** @var string[] */
	private $errors;

	/** @var int */
	private $status;

	/**
	 * @param int $status One of the Task::STATUS_* constants
	 * @param string[] $errors
	 */
	public function __construct( int $status, array $errors = [] ) {
		$this->status = $status;
		$this->errors = $errors;
	}

	/**
	 * @return int
	 */
	public function getStatus() : int {
		return $this->status;
	}

	/**
	 * @return string[]
	 * @suppress PhanUnreferencedPublicMethod
	 */
	public function getErrors() : array {
		return $this->errors;
	}

	/**
	 * @param TaskResult $that
	 */
	public function merge( TaskResult $that ) : void {
		$this->status |= $that->status;
		$this->errors = array_merge( $this->errors, $that->errors );
	}

	/**
	 * @return string
	 */
	public function __toString() {
		if ( $this->isOK() ) {
			$stat = 'OK';
			$errs = "\tNo errors.";
		} else {
			$stat = 'ERROR';
			$formattedErrs = [];
			foreach ( $this->errors as $err ) {
				$formattedErrs[] = "\t - $err";
			}
			$errs = implode( "\n", $formattedErrs );
		}
		return "=== RESULT ===\n - Status: $stat\n - Errors:\n$errs\n";
	}

	/**
	 * Shorthand
	 *
	 * @return bool
	 */
	public function isOK() : bool {
		return ( $this->status | self::STATUS_GOOD ) === self::STATUS_GOOD;
	}
}