2016-02-04 17:16:16 +01:00
|
|
|
<?php
|
|
|
|
/**
|
|
|
|
* ExporterInterface.php
|
2016-04-01 16:44:46 +02:00
|
|
|
* Copyright (C) 2016 thegrumpydictator@gmail.com
|
2016-02-04 17:16:16 +01:00
|
|
|
*
|
2016-10-05 06:52:15 +02:00
|
|
|
* 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.
|
2016-02-04 17:16:16 +01:00
|
|
|
*/
|
|
|
|
|
2017-04-09 07:44:22 +02:00
|
|
|
declare(strict_types=1);
|
2016-05-20 12:27:31 +02:00
|
|
|
|
2016-02-04 17:16:16 +01:00
|
|
|
namespace FireflyIII\Export\Exporter;
|
2016-03-14 20:53:56 +01:00
|
|
|
|
2017-02-05 15:58:42 +01:00
|
|
|
use FireflyIII\Models\ExportJob;
|
2016-02-04 17:16:16 +01:00
|
|
|
use Illuminate\Support\Collection;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Interface ExporterInterface
|
|
|
|
*
|
|
|
|
* @package FireflyIII\Export\Exporter
|
|
|
|
*/
|
|
|
|
interface ExporterInterface
|
|
|
|
{
|
|
|
|
/**
|
|
|
|
* @return Collection
|
|
|
|
*/
|
2016-04-06 16:37:28 +02:00
|
|
|
public function getEntries(): Collection;
|
2016-02-04 17:16:16 +01:00
|
|
|
|
2016-03-14 20:53:56 +01:00
|
|
|
/**
|
|
|
|
* @return string
|
|
|
|
*/
|
2016-04-06 16:37:28 +02:00
|
|
|
public function getFileName(): string;
|
2016-03-14 20:53:56 +01:00
|
|
|
|
2016-02-04 17:16:16 +01:00
|
|
|
/**
|
2016-04-06 16:37:28 +02:00
|
|
|
* @return bool
|
2016-02-04 17:16:16 +01:00
|
|
|
*/
|
2016-04-06 16:37:28 +02:00
|
|
|
public function run(): bool;
|
2016-02-04 17:16:16 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @param Collection $entries
|
|
|
|
*
|
2017-01-02 20:42:29 +01:00
|
|
|
* @return void
|
|
|
|
*
|
2016-02-04 17:16:16 +01:00
|
|
|
*/
|
|
|
|
public function setEntries(Collection $entries);
|
|
|
|
|
2017-02-05 15:58:42 +01:00
|
|
|
/**
|
|
|
|
* @param ExportJob $job
|
|
|
|
*/
|
|
|
|
public function setJob(ExportJob $job);
|
|
|
|
|
2016-02-10 16:01:18 +01:00
|
|
|
}
|