mirror of
https://github.com/firefly-iii/firefly-iii.git
synced 2024-11-30 12:43:57 -06:00
70 lines
1.5 KiB
PHP
70 lines
1.5 KiB
PHP
<?php
|
|
|
|
/**
|
|
* ExporterInterface.php
|
|
* Copyright (c) 2018 thegrumpydictator@gmail.com
|
|
*
|
|
* This file is part of Firefly III.
|
|
*
|
|
* Firefly III is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* Firefly III 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 General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with Firefly III. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
declare(strict_types=1);
|
|
|
|
namespace FireflyIII\Export\Exporter;
|
|
|
|
use FireflyIII\Models\ExportJob;
|
|
use Illuminate\Support\Collection;
|
|
|
|
/**
|
|
* Interface ExporterInterface.
|
|
*/
|
|
interface ExporterInterface
|
|
{
|
|
/**
|
|
* Get entries.
|
|
*
|
|
* @return Collection
|
|
*/
|
|
public function getEntries(): Collection;
|
|
|
|
/**
|
|
* Get file name.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getFileName(): string;
|
|
|
|
/**
|
|
* Run exporter.
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function run(): bool;
|
|
|
|
/**
|
|
* Set entries.
|
|
*
|
|
* @param Collection $entries
|
|
*/
|
|
public function setEntries(Collection $entries);
|
|
|
|
/**
|
|
* Set job.
|
|
*
|
|
* @param ExportJob $job
|
|
*/
|
|
public function setJob(ExportJob $job);
|
|
}
|