firefly-iii/app/Repositories/Currency/CurrencyRepositoryInterface.php
James Cole 5c7df5c04d
Copyright notices. [skip ci]
Signed-off-by: James Cole <thegrumpydictator@gmail.com>
2016-05-20 12:41:23 +02:00

97 lines
2.1 KiB
PHP

<?php
/**
* CurrencyRepositoryInterface.php
* Copyright (C) 2016 thegrumpydictator@gmail.com
*
* This software may be modified and distributed under the terms
* of the MIT license. See the LICENSE file for details.
*/
declare(strict_types = 1);
namespace FireflyIII\Repositories\Currency;
use FireflyIII\Models\Preference;
use FireflyIII\Models\TransactionCurrency;
use Illuminate\Support\Collection;
/**
* Interface CurrencyRepositoryInterface
*
* @package FireflyIII\Repositories\Currency
*/
interface CurrencyRepositoryInterface
{
/**
* @param TransactionCurrency $currency
*
* @return int
*/
public function countJournals(TransactionCurrency $currency): int;
/**
* Find by ID
*
* @param int $currencyId
*
* @return TransactionCurrency
*/
public function find(int $currencyId) : TransactionCurrency;
/**
* Find by currency code
*
* @param string $currencyCode
*
* @return TransactionCurrency
*/
public function findByCode(string $currencyCode) : TransactionCurrency;
/**
* Find by currency name
*
* @param string $currencyName
*
* @return TransactionCurrency
*/
public function findByName(string $currencyName) : TransactionCurrency;
/**
* Find by currency symbol
*
* @param string $currencySymbol
*
* @return TransactionCurrency
*/
public function findBySymbol(string $currencySymbol) : TransactionCurrency;
/**
* @return Collection
*/
public function get(): Collection;
/**
* @param Preference $preference
*
* @return TransactionCurrency
*/
public function getCurrencyByPreference(Preference $preference): TransactionCurrency;
/**
* @param array $data
*
* @return TransactionCurrency
*/
public function store(array $data): TransactionCurrency;
/**
* @param TransactionCurrency $currency
* @param array $data
*
* @return TransactionCurrency
*/
public function update(TransactionCurrency $currency, array $data): TransactionCurrency;
}