firefly-iii/app/Repositories/Journal/JournalRepositoryInterface.php

<?php
/**
 * JournalRepositoryInterface.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\Repositories\Journal;

use Carbon\Carbon;
use FireflyIII\Models\Transaction;
use FireflyIII\Models\TransactionGroup;
use FireflyIII\Models\TransactionJournal;
use FireflyIII\Models\TransactionJournalLink;
use FireflyIII\Models\TransactionJournalMeta;
use FireflyIII\User;
use Illuminate\Support\Collection;

/**
 * Interface JournalRepositoryInterface.
 * TODO needs cleaning up. Remove unused methods.
 */
interface JournalRepositoryInterface
{

    /**
     * TODO maybe create JSON repository?
     *
     * Search in journal descriptions.
     *
     * @param string $search
     * @return Collection
     */
    public function searchJournalDescriptions(string $search): Collection;

    /**
     * TODO maybe create command line repository?
     *
     * Get all transaction journals with a specific type, regardless of user.
     *
     * @param array $types
     * @return Collection
     */
    public function getAllJournals(array $types): Collection;

    /**
     * Deletes a transaction group.
     *
     * @param TransactionGroup $transactionGroup
     */
    public function destroyGroup(TransactionGroup $transactionGroup): void;

    /**
     * Deletes a journal.
     *
     * @param TransactionJournal $journal
     */
    public function destroyJournal(TransactionJournal $journal): void;


    /**
     * TODO move to import repository.
     *
     * Find a journal by its hash.
     *
     * @param string $hash
     *
     * @return TransactionJournalMeta|null
     */
    public function findByHash(string $hash): ?TransactionJournalMeta;

    /**
     * TODO Refactor to "find".
     * Find a specific journal.
     *
     * @param int $journalId
     *
     * @return TransactionJournal|null
     */
    public function findNull(int $journalId): ?TransactionJournal;

    /**
     * Get users very first transaction journal.
     *
     * @return TransactionJournal|null
     */
    public function firstNull(): ?TransactionJournal;

    /**
     * TODO console repository?
     *
     * Return the ID of the budget linked to the journal (if any) or the transactions (if any).
     *
     * @param TransactionJournal $journal
     *
     * @return int
     */
    public function getJournalBudgetId(TransactionJournal $journal): int;

    /**
     * TODO console repository?
     *
     * Return the ID of the category linked to the journal (if any) or to the transactions (if any).
     *
     * @param TransactionJournal $journal
     *
     * @return int
     */
    public function getJournalCategoryId(TransactionJournal $journal): int;

    /**
     * TODO this method is no longer well-fitted in 4.8.0. Should be refactored and/or removed.
     * Return a list of all destination accounts related to journal.
     *
     * @param TransactionJournal $journal
     * @deprecated
     * @return Collection
     */
    public function getJournalDestinationAccounts(TransactionJournal $journal): Collection;

    /**
     * TODO this method is no longer well-fitted in 4.8.0. Should be refactored and/or removed.
     * Return a list of all source accounts related to journal.
     *
     * @param TransactionJournal $journal
     * @deprecated
     * @return Collection
     */
    public function getJournalSourceAccounts(TransactionJournal $journal): Collection;

    /**
     * Return total amount of journal. Is always positive.
     *
     * @param TransactionJournal $journal
     *
     * @return string
     */
    public function getJournalTotal(TransactionJournal $journal): string;

    /**
     * TODO only used on command line.
     * Return all journals without a group, used in an upgrade routine.
     *
     * @return array
     */
    public function getJournalsWithoutGroup(): array;

    /**
     * TODO used only in transformer, so only for API use.
     * @param TransactionJournalLink $link
     *
     * @return string
     */
    public function getLinkNoteText(TransactionJournalLink $link): string;

    /**
     * TODO used only on console
     * Return Carbon value of a meta field (or NULL).
     *
     * @param TransactionJournal $journal
     * @param string $field
     *
     * @return null|Carbon
     */
    public function getMetaDate(TransactionJournal $journal, string $field): ?Carbon;

    /**
     * Return Carbon value of a meta field (or NULL).
     *
     * @param int $journalId
     * @param string             $field
     *
     * @return null|Carbon
     */
    public function getMetaDateById(int $journalId, string $field): ?Carbon;

    /**
     * TODO used only on the console.
     *
     * Return value of a meta field (or NULL).
     *
     * @param TransactionJournal $journal
     * @param string $field
     *
     * @return null|string
     */
    public function getMetaField(TransactionJournal $journal, string $field): ?string;

    /**
     * TODO used only on the console.
     *
     * Return text of a note attached to journal, or NULL
     *
     * @param TransactionJournal $journal
     *
     * @return string|null
     */
    public function getNoteText(TransactionJournal $journal): ?string;

    /**
     * TODO used only on the console.
     *
     * Returns all journals with more than 2 transactions. Should only return empty collections
     * in Firefly III > v4.8.0.
     *
     * @return Collection
     */
    public function getSplitJournals(): Collection;

    /**
     * TODO used only on the console.
     *
     * Return all tags as strings in an array.
     *
     * @param TransactionJournal $journal
     *
     * @return array
     */
    public function getTags(TransactionJournal $journal): array;

    /**
     * TODO maybe move to account repository?
     *
     * @param int $journalId
     */
    public function reconcileById(int $journalId): void;

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

    /**
     * Update budget for a journal.
     *
     * @param TransactionJournal $journal
     * @param int $budgetId
     *
     * @return TransactionJournal
     */
    public function updateBudget(TransactionJournal $journal, int $budgetId): TransactionJournal;

    /**
     * Update category for a journal.
     *
     * @param TransactionJournal $journal
     * @param string $category
     *
     * @return TransactionJournal
     */
    public function updateCategory(TransactionJournal $journal, string $category): TransactionJournal;

    /**
     * Update tag(s) for a journal.
     *
     * @param TransactionJournal $journal
     * @param array $tags
     *
     * @return TransactionJournal
     */
    public function updateTags(TransactionJournal $journal, array $tags): TransactionJournal;
}