server/lib/public/Files/Search/ISearchOrder.php

49 lines
1.3 KiB
PHP
Raw Normal View History

<?php
/**
* @copyright Copyright (c) 2017 Robin Appelman <robin@icewind.nl>
*
* @author Robin Appelman <robin@icewind.nl>
*
* @license GNU AGPL version 3 or any later version
*
* 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 <http://www.gnu.org/licenses/>.
*
*/
namespace OCP\Files\Search;
/**
* @since 12.0.0
*/
interface ISearchOrder {
const DIRECTION_ASCENDING = 'asc';
const DIRECTION_DESCENDING = 'desc';
/**
* The direction to sort in, either ISearchOrder::DIRECTION_ASCENDING or ISearchOrder::DIRECTION_DESCENDING
*
* @return string
* @since 12.0.0
*/
public function getDirection();
/**
* The field to sort on
*
* @return string
* @since 12.0.0
*/
public function getField();
}