firefly-iii/app/Support/Search/SearchInterface.php

64 lines
1.5 KiB
PHP
Raw Normal View History

2015-02-27 04:09:23 -06:00
<?php
/**
* SearchInterface.php
2017-10-21 01:40:00 -05:00
* Copyright (c) 2017 thegrumpydictator@gmail.com
*
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:44:05 -06:00
* along with Firefly III. If not, see <http://www.gnu.org/licenses/>.
*/
declare(strict_types=1);
2015-02-27 04:09:23 -06:00
namespace FireflyIII\Support\Search;
2017-02-05 09:16:15 -06:00
use FireflyIII\User;
2019-02-27 12:08:09 -06:00
use Illuminate\Pagination\LengthAwarePaginator;
2015-02-27 04:09:23 -06:00
use Illuminate\Support\Collection;
/**
2017-11-15 05:25:49 -06:00
* Interface SearchInterface.
2015-02-27 04:09:23 -06:00
*/
2015-03-29 14:27:51 -05:00
interface SearchInterface
{
2015-02-27 04:09:23 -06:00
/**
* @return string
*/
public function getWordsAsString(): string;
/**
* @return bool
*/
public function hasModifiers(): bool;
/**
* @param string $query
*/
public function parseQuery(string $query);
2015-02-27 04:09:23 -06:00
/**
2019-02-27 12:08:09 -06:00
* @return LengthAwarePaginator
2015-02-27 04:09:23 -06:00
*/
2019-02-27 12:08:09 -06:00
public function searchTransactions(): LengthAwarePaginator;
/**
* @param int $limit
*/
public function setLimit(int $limit);
2017-02-16 23:42:36 -06:00
/**
* @param User $user
*/
public function setUser(User $user);
2015-03-29 01:14:32 -05:00
}