<?php
/**
 * BudgetRepositoryInterface.php
 * Copyright (c) 2019 james@firefly-iii.org
 *
 * This file is part of Firefly III (https://github.com/firefly-iii).
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
declare(strict_types=1);

namespace FireflyIII\Repositories\Budget;

use Carbon\Carbon;
use FireflyIII\Exceptions\FireflyException;
use FireflyIII\Models\AutoBudget;
use FireflyIII\Models\Budget;
use FireflyIII\User;
use Illuminate\Support\Collection;

/**
 * Interface BudgetRepositoryInterface.
 */
interface BudgetRepositoryInterface
{
    /**
     * @param string $query
     * @param int    $limit
     *
     * @return Collection
     */
    public function budgetEndsWith(string $query, int $limit): Collection;

    /**
     * @param string $query
     * @param int    $limit
     *
     * @return Collection
     */
    public function budgetStartsWith(string $query, int $limit): Collection;

    /**
     * Returns the amount that is budgeted in a period.
     *
     * @param Carbon $start
     * @param Carbon $end
     * @return array
     */
    public function budgetedInPeriod(Carbon $start, Carbon $end): array;

    /**
     * @return bool
     */
    public function cleanupBudgets(): bool;

    /**
     * @param Budget $budget
     *
     * @return bool
     */
    public function destroy(Budget $budget): bool;

    /**
     * Destroy all budgets.
     */
    public function destroyAll(): void;

    /**
     * @param Budget $budget
     */
    public function destroyAutoBudget(Budget $budget): void;

    /**
     *
     * @param int|null $budgetId
     *
     * @return Budget|null
     */
    public function find(int $budgetId = null): ?Budget;

    /**
     * @param int|null    $budgetId
     * @param string|null $budgetName
     *
     * @return Budget|null
     */
    public function findBudget(?int $budgetId, ?string $budgetName): ?Budget;

    /**
     * Find budget by name.
     *
     * @param string|null $name
     *
     * @return Budget|null
     */
    public function findByName(?string $name): ?Budget;

    /**
     * This method returns the oldest journal or transaction date known to this budget.
     * Will cache result.
     *
     * @param Budget $budget
     *
     * @return Carbon|null
     */
    public function firstUseDate(Budget $budget): ?Carbon;

    /**
     * @return Collection
     */
    public function getActiveBudgets(): Collection;

    /**
     * @param Budget $budget
     *
     * @return Collection
     */
    public function getAttachments(Budget $budget): Collection;

    /**
     * @param Budget $budget
     *
     * @return AutoBudget|null
     */
    public function getAutoBudget(Budget $budget): ?AutoBudget;

    /**
     * @return Collection
     */
    public function getBudgets(): Collection;

    /**
     * Get all budgets with these ID's.
     *
     * @param array $budgetIds
     *
     * @return Collection
     */
    public function getByIds(array $budgetIds): Collection;

    /**
     * @return Collection
     */
    public function getInactiveBudgets(): Collection;

    /**
     * @return int
     */
    public function getMaxOrder(): int;

    /**
     * @param Budget $budget
     * @return string|null
     */
    public function getNoteText(Budget $budget): ?string;

    /**
     * @param string $query
     * @param int    $limit
     *
     * @return Collection
     */
    public function searchBudget(string $query, int $limit): Collection;

    /**
     * @param Budget $budget
     * @param int    $order
     */
    public function setBudgetOrder(Budget $budget, int $order): void;

    /**
     * @param User $user
     */
    public function setUser(User $user);

    /**
     * Used in the v2 API to calculate the amount of money spent in all active budgets.
     *
     * @param Carbon $start
     * @param Carbon $end
     *
     * @return array
     */
    public function spentInPeriod(Carbon $start, Carbon $end): array;

    /**
     * @param array $data
     *
     * @return Budget
     * @throws FireflyException
     */
    public function store(array $data): Budget;

    /**
     * @param Budget $budget
     * @param array  $data
     *
     * @return Budget
     */
    public function update(Budget $budget, array $data): Budget;
}