mirror of
https://github.com/firefly-iii/firefly-iii.git
synced 2025-10-31 10:47:00 +00:00
116 lines
2.8 KiB
PHP
116 lines
2.8 KiB
PHP
<?php
|
|
/**
|
|
* MetaPieChartInterface.php
|
|
* Copyright (c) 2017 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\Helpers\Chart;
|
|
|
|
use Carbon\Carbon;
|
|
use FireflyIII\User;
|
|
use Illuminate\Support\Collection;
|
|
|
|
/**
|
|
* Interface MetaPieChartInterface.
|
|
*/
|
|
interface MetaPieChartInterface
|
|
{
|
|
/**
|
|
* Generate a chart.
|
|
*
|
|
* @param string $direction
|
|
* @param string $group
|
|
*
|
|
* @return array
|
|
*/
|
|
public function generate(string $direction, string $group): array;
|
|
|
|
/**
|
|
* Accounts setter.
|
|
*
|
|
* @param Collection $accounts
|
|
*
|
|
* @return MetaPieChartInterface
|
|
*/
|
|
public function setAccounts(Collection $accounts): MetaPieChartInterface;
|
|
|
|
/**
|
|
* Budgets setter.
|
|
*
|
|
* @param Collection $budgets
|
|
*
|
|
* @return MetaPieChartInterface
|
|
*/
|
|
public function setBudgets(Collection $budgets): MetaPieChartInterface;
|
|
|
|
/**
|
|
* Categories setter.
|
|
*
|
|
* @param Collection $categories
|
|
*
|
|
* @return MetaPieChartInterface
|
|
*/
|
|
public function setCategories(Collection $categories): MetaPieChartInterface;
|
|
|
|
/**
|
|
* Set if other objects should be collected.
|
|
*
|
|
* @param bool $collectOtherObjects
|
|
*
|
|
* @return MetaPieChartInterface
|
|
*/
|
|
public function setCollectOtherObjects(bool $collectOtherObjects): MetaPieChartInterface;
|
|
|
|
/**
|
|
* Set the end date.
|
|
*
|
|
* @param Carbon $end
|
|
*
|
|
* @return MetaPieChartInterface
|
|
*/
|
|
public function setEnd(Carbon $end): MetaPieChartInterface;
|
|
|
|
/**
|
|
* Set the start date.
|
|
*
|
|
* @param Carbon $start
|
|
*
|
|
* @return MetaPieChartInterface
|
|
*/
|
|
public function setStart(Carbon $start): MetaPieChartInterface;
|
|
|
|
/**
|
|
* Set the tags.
|
|
*
|
|
* @param Collection $tags
|
|
*
|
|
* @return MetaPieChartInterface
|
|
*/
|
|
public function setTags(Collection $tags): MetaPieChartInterface;
|
|
|
|
/**
|
|
* Set the user.
|
|
*
|
|
* @param User $user
|
|
*
|
|
* @return MetaPieChartInterface
|
|
*/
|
|
public function setUser(User $user): MetaPieChartInterface;
|
|
}
|