mirror of
https://github.com/firefly-iii/firefly-iii.git
synced 2025-01-16 11:42:06 -06:00
74 lines
2.0 KiB
PHP
74 lines
2.0 KiB
PHP
<?php
|
|
/**
|
|
* JobConfigurationInterface.php
|
|
* Copyright (c) 2019 james@firefly-iii.org
|
|
*
|
|
* This file is part of Firefly III (https://github.com/firefly-iii).
|
|
*
|
|
* 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/>.
|
|
*/
|
|
declare(strict_types=1);
|
|
|
|
namespace FireflyIII\Import\JobConfiguration;
|
|
|
|
use FireflyIII\Models\ImportJob;
|
|
use Illuminate\Support\MessageBag;
|
|
|
|
/**
|
|
* Interface JobConfigurationInterface.
|
|
*
|
|
* @deprecated
|
|
* @codeCoverageIgnore
|
|
*/
|
|
interface JobConfigurationInterface
|
|
{
|
|
/**
|
|
* Returns true when the initial configuration for this job is complete.
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function configurationComplete(): bool;
|
|
|
|
/**
|
|
* Store any data from the $data array into the job. Anything in the message bag will be flashed
|
|
* as an error to the user, regardless of its content.
|
|
*
|
|
* @param array $data
|
|
*
|
|
* @return MessageBag
|
|
*/
|
|
public function configureJob(array $data): MessageBag;
|
|
|
|
/**
|
|
* Return the data required for the next step in the job configuration.
|
|
*
|
|
* @return array
|
|
*/
|
|
public function getNextData(): array;
|
|
|
|
/**
|
|
* Returns the view of the next step in the job configuration.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getNextView(): string;
|
|
|
|
/**
|
|
* Set import job.
|
|
*
|
|
* @param ImportJob $importJob
|
|
*/
|
|
public function setImportJob(ImportJob $importJob): void;
|
|
}
|