Adding upstream version 2.12.1.upstream/2.12.1upstream

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 49 insertions, 0 deletions

diff --git a/library/Icinga/Data/Sortable.php b/library/Icinga/Data/Sortable.php
new file mode 100644
index 0000000..11d38c3
--- /dev/null
+++ b/library/Icinga/Data/Sortable.php
@@ -0,0 +1,49 @@
+<?php
+/* Icinga Web 2 | (c) 2014 Icinga Development Team | GPLv2+ */
+
+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();
+}