summaryrefslogtreecommitdiff
path: root/vendor/ruflin/elastica/lib/Elastica/SearchableInterface.php
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/ruflin/elastica/lib/Elastica/SearchableInterface.php')
-rw-r--r--vendor/ruflin/elastica/lib/Elastica/SearchableInterface.php52
1 files changed, 52 insertions, 0 deletions
diff --git a/vendor/ruflin/elastica/lib/Elastica/SearchableInterface.php b/vendor/ruflin/elastica/lib/Elastica/SearchableInterface.php
new file mode 100644
index 00000000..372bcb11
--- /dev/null
+++ b/vendor/ruflin/elastica/lib/Elastica/SearchableInterface.php
@@ -0,0 +1,52 @@
+<?php
+
+namespace Elastica;
+
+/**
+ * Elastica searchable interface
+ *
+ * @category Xodoa
+ * @package Elastica
+ * @author Thibault Duplessis <thibault.duplessis@gmail.com>
+ */
+interface SearchableInterface
+{
+ /**
+ * Searches results for a query
+ *
+ * TODO: Improve sample code
+ * {
+ * "from" : 0,
+ * "size" : 10,
+ * "sort" : {
+ * "postDate" : {"reverse" : true},
+ * "user" : { },
+ * "_score" : { }
+ * },
+ * "query" : {
+ * "term" : { "user" : "kimchy" }
+ * }
+ * }
+ *
+ * @param string|array|\Elastica\Query $query Array with all query data inside or a Elastica\Query object
+ * @return \Elastica\ResultSet ResultSet with all results inside
+ */
+ public function search($query = '', $options = null);
+
+ /**
+ * Counts results for a query
+ *
+ * If no query is set, matchall query is created
+ *
+ * @param string|array|\Elastica\Query $query Array with all query data inside or a Elastica\Query object
+ * @return int number of documents matching the query
+ */
+ public function count($query = '');
+
+ /**
+ * @param \Elastica\Query $query
+ * @param array $options
+ * @return \Elastica\Search
+ */
+ public function createSearch($query = '', $options = null);
+}