App\Services\Sync\JobStatus\ProgressInformation

Complexity

Total Complexity

7

Size/Duplication

Total Lines	86
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	addWarning()	0	9	1
A	addMessage()	0	9	1
A	getErrors()	0	3	1
A	setIdentifier()	0	3	1
A	getWarnings()	0	3	1
A	addError()	0	9	1
A	getMessages()	0	3	1

<?php

declare(strict_types=1);
/**
 * ProgressInformation.php
 * Copyright (c) 2020 james@firefly-iii.org.
 *
 * This file is part of the Firefly III bunq importer
 * (https://github.com/firefly-iii/bunq-importer).
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */

namespace App\Services\Sync\JobStatus;

/**
 * Trait ProgressInformation.
 */
trait ProgressInformation
{
    /** @var array */
    protected $errors;
    /** @var string */
    protected $identifier;
    /** @var array */
    protected $messages;
    /** @var array */
    protected $warnings;

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

    /**
     * @return array
     */
    public function getMessages(): array
    {
        return $this->messages ?? [];
    }

    /**
     * @return array
     */
    public function getWarnings(): array
    {
        return $this->warnings ?? [];
    }

    /**
     * @param string $identifier
     */
    public function setIdentifier(string $identifier): void
    {
        $this->identifier = $identifier;
    }

    /**
     * @param int    $index
     * @param string $error
     */
    protected function addError(int $index, string $error): void
    {
        $this->errors           = $this->errors ?? [];
        $this->errors[$index]   = $this->errors[$index] ?? [];
        $this->errors[$index][] = $error;

        // write errors
        app('log')->error(sprintf('Error: %s %d: %s', $this->identifier, $index, $error));
        JobStatusManager::addError($this->identifier, $index, $error);
    }

    /**
     * @param int    $index
     * @param string $message
     */
    protected function addMessage(int $index, string $message): void
    {
        $this->messages           = $this->messages ?? [];
        $this->messages[$index]   = $this->messages[$index] ?? [];
        $this->messages[$index][] = $message;

        // write message
        app('log')->info(sprintf('Message: %s %d: %s', $this->identifier, $index, $message));
        JobStatusManager::addMessage($this->identifier, $index, $message);
    }

    /**
     * @param int    $index
     * @param string $warning
     */
    protected function addWarning(int $index, string $warning): void
    {
        $this->warnings           = $this->warnings ?? [];
        $this->warnings[$index]   = $this->warnings[$index] ?? [];
        $this->warnings[$index][] = $warning;

        // write warning
        app('log')->warning(sprintf('Warning: %s %d: %s', $this->identifier, $index, $warning));
        JobStatusManager::addWarning($this->identifier, $index, $warning);
    }
}