firefly-iii/app/Export/Collector/CollectorInterface.php

55 lines
1.3 KiB
PHP
Raw Normal View History

2016-02-04 10:16:16 -06:00
<?php
/**
* CollectorInterface.php
2017-10-21 01:40:00 -05:00
* Copyright (c) 2017 thegrumpydictator@gmail.com
2016-02-04 10:16:16 -06:00
*
2017-10-21 01:40:00 -05:00
* This file is part of Firefly III.
*
2017-10-21 01:40:00 -05:00
* 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
2017-12-17 07:41:58 -06:00
* along with Firefly III. If not, see <http://www.gnu.org/licenses/>.
2016-02-04 10:16:16 -06:00
*/
declare(strict_types=1);
2016-02-04 10:16:16 -06:00
namespace FireflyIII\Export\Collector;
2017-02-05 08:58:55 -06:00
use FireflyIII\Models\ExportJob;
2016-02-05 02:25:15 -06:00
use Illuminate\Support\Collection;
2016-02-04 10:16:16 -06:00
/**
2017-11-15 05:25:49 -06:00
* Interface CollectorInterface.
2016-02-04 10:16:16 -06:00
*/
interface CollectorInterface
{
2016-02-05 02:25:15 -06:00
/**
* @return Collection
2016-02-05 02:25:15 -06:00
*/
2016-10-23 02:44:14 -05:00
public function getEntries(): Collection;
2016-02-04 10:16:16 -06:00
2016-02-05 02:25:15 -06:00
/**
* @return bool
2016-02-05 02:25:15 -06:00
*/
2016-04-06 09:37:28 -05:00
public function run(): bool;
2016-02-05 02:25:15 -06:00
/**
2016-10-23 02:44:14 -05:00
* @param Collection $entries
2016-02-05 02:25:15 -06:00
*/
2016-10-23 02:44:14 -05:00
public function setEntries(Collection $entries);
2016-02-05 02:25:15 -06:00
2017-02-16 23:42:36 -06:00
/**
* @param ExportJob $job
*
* @return mixed
*/
public function setJob(ExportJob $job);
2016-02-10 09:01:18 -06:00
}