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.php22
1 files changed, 11 insertions, 11 deletions
diff --git a/vendor/ruflin/elastica/lib/Elastica/SearchableInterface.php b/vendor/ruflin/elastica/lib/Elastica/SearchableInterface.php
index 372bcb11..abfacb85 100644
--- a/vendor/ruflin/elastica/lib/Elastica/SearchableInterface.php
+++ b/vendor/ruflin/elastica/lib/Elastica/SearchableInterface.php
@@ -1,18 +1,15 @@
<?php
-
namespace Elastica;
/**
- * Elastica searchable interface
+ * Elastica searchable interface.
*
- * @category Xodoa
- * @package Elastica
* @author Thibault Duplessis <thibault.duplessis@gmail.com>
*/
interface SearchableInterface
{
/**
- * Searches results for a query
+ * Searches results for a query.
*
* TODO: Improve sample code
* {
@@ -28,24 +25,27 @@ interface SearchableInterface
* }
* }
*
- * @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
+ * @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
+ * 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
+ * @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
+ * @param array $options
+ *
* @return \Elastica\Search
*/
public function createSearch($query = '', $options = null);