Result.php

Go to the documentation of this file.

<?php

namespace Elgg\Upgrade;

final class Result {

    private $errors = [];

    private $failure_count = 0;

    private $success_count = 0;

    private $is_complete = false;

    public function addError($message): void {
        if (is_array($message)) {
            $this->errors = $this->errors + $message;
        } else {
            $this->errors[] = $message;
        }
    }

    public function getErrors(): array {
        return $this->errors;
    }

    public function addFailures(int $num = 1): void {
        $this->failure_count += $num;
    }

    public function getFailureCount(): int {
        return $this->failure_count;
    }

    public function addSuccesses(int $num = 1): void {
        $this->success_count += $num;
    }

    public function getSuccessCount(): int {
        return $this->success_count;
    }

    public function markComplete(): void {
        $this->is_complete = true;
    }

    public function wasMarkedComplete(): bool {
        return $this->is_complete === true;
    }

    public function toArray(): array {
        return [
            'errors' => $this->getErrors(),
            'numErrors' => $this->getFailureCount(),
            'numSuccess' => $this->getSuccessCount(),
            'isComplete' => $this->wasMarkedComplete(),
        ];
    }
}