mirror of
https://github.com/firefly-iii/firefly-iii.git
synced 2024-12-02 05:29:12 -06:00
47 lines
1.1 KiB
PHP
47 lines
1.1 KiB
PHP
|
<?php
|
||
|
|
/**
|
||
|
|
* PrerequisitesInterface.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\Support\Import\Prerequisites;
|
||
|
|
|
||
|
|
|
||
|
|
use FireflyIII\User;
|
||
|
|
|
||
|
|
interface PrerequisitesInterface
|
||
|
|
{
|
||
|
|
/**
|
||
|
|
* Set the user for this Prerequisites-routine. Class is expected to implement and save this.
|
||
|
|
*
|
||
|
|
* @param User $user
|
||
|
|
*/
|
||
|
|
public function setUser(User $user): void;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Returns view name that allows user to fill in prerequisites.
|
||
|
|
*
|
||
|
|
* @return string
|
||
|
|
*/
|
||
|
|
public function getView(): string;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Returns any values required for the prerequisites-view.
|
||
|
|
*
|
||
|
|
* @return array
|
||
|
|
*/
|
||
|
|
public function getViewParameters(): array;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Returns if this import method has any special prerequisites such as config
|
||
|
|
* variables or other things.
|
||
|
|
*
|
||
|
|
* @return bool
|
||
|
|
*/
|
||
|
|
public function hasPrerequisites(): bool;
|
||
|
|
}
|