mirror of
https://github.com/Icinga/icingaweb2.git
synced 2026-04-14 13:36:13 -04:00
662de28f85
Add SPDX license headers and mark source files as GPL-3.0-or-later to preserve the option to relicense under later GPL versions.
51 lines
890 B
PHP
51 lines
890 B
PHP
<?php
|
|
|
|
// SPDX-FileCopyrightText: 2018 Icinga GmbH <https://icinga.com>
|
|
// SPDX-License-Identifier: GPL-3.0-or-later
|
|
|
|
namespace Icinga\Data;
|
|
|
|
/**
|
|
* Interface for sorting a result set
|
|
*/
|
|
interface Sortable
|
|
{
|
|
/**
|
|
* Sort ascending
|
|
*/
|
|
const SORT_ASC = 'ASC';
|
|
|
|
/**
|
|
* Sort descending
|
|
*/
|
|
const SORT_DESC = 'DESC';
|
|
|
|
/**
|
|
* Sort result set by the given field (and direction)
|
|
*
|
|
* Preferred usage:
|
|
* <code>
|
|
* $query->order('field, 'ASC')
|
|
* </code>
|
|
*
|
|
* @param string $field
|
|
* @param string $direction
|
|
*
|
|
* @return self
|
|
*/
|
|
public function order($field, $direction = null);
|
|
|
|
/**
|
|
* Whether an order is set
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function hasOrder();
|
|
|
|
/**
|
|
* Get the order if any
|
|
*
|
|
* @return array|null
|
|
*/
|
|
public function getOrder();
|
|
}
|