mirror of
https://github.com/firefly-iii/firefly-iii.git
synced 2025-09-19 02:45:58 +00:00
66 lines
1.4 KiB
PHP
66 lines
1.4 KiB
PHP
<?php
|
|
/**
|
|
* ConfiguratorInterface.php
|
|
* Copyright (c) 2017 thegrumpydictator@gmail.com
|
|
* This software may be modified and distributed under the terms of the Creative Commons Attribution-ShareAlike 4.0 International License.
|
|
*
|
|
* See the LICENSE file for details.
|
|
*/
|
|
|
|
declare(strict_types=1);
|
|
|
|
namespace FireflyIII\Import\Configurator;
|
|
|
|
use FireflyIII\Models\ImportJob;
|
|
|
|
/**
|
|
* Interface ConfiguratorInterface
|
|
*
|
|
* @package FireflyIII\Import\Configurator
|
|
*/
|
|
interface ConfiguratorInterface
|
|
{
|
|
/**
|
|
* ConfiguratorInterface constructor.
|
|
*/
|
|
public function __construct();
|
|
|
|
/**
|
|
* Store any data from the $data array into the job.
|
|
*
|
|
* @param array $data
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function configureJob(array $data): bool;
|
|
|
|
/**
|
|
* 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;
|
|
|
|
/**
|
|
* Returns true when the initial configuration for this job is complete.
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function isJobConfigured(): bool;
|
|
|
|
/**
|
|
* @param ImportJob $job
|
|
*
|
|
* @return void
|
|
*/
|
|
public function setJob(ImportJob $job);
|
|
|
|
}
|