Skip to content

Commit 74d0d72

Browse files
author
Josh Freeman
committed
Change some search params to be more specific
1 parent 747d297 commit 74d0d72

File tree

2 files changed

+17
-4
lines changed

2 files changed

+17
-4
lines changed

README.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,12 +70,25 @@ $api->search->find($string)->results();
7070

7171
Search modification methods are:
7272
```php
73-
$api->search->column($column);
74-
$api->search->algorithm($searchStringAlgorithm);
73+
// The column to search on
74+
$api->search->findColumn($column);
75+
76+
// the algorithm to use
77+
$api->search->findAlgorithm($searchStringAlgorithm);
78+
79+
// the page to start on
7580
$api->search->page($number);
81+
82+
// sorting order
7683
$api->search->sort($field, $order);
84+
85+
// limit results
7786
$api->search->limit($limit);
87+
88+
// columns in the results
7889
$api->search->columns($columns);
90+
91+
// change elastics filter bool condition (eg: should, must, must_not)
7992
$api->search->bool($bool);
8093
```
8194

src/XIVAPI/Api/Search.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,13 +55,13 @@ public function find(string $string): Search
5555
return $this;
5656
}
5757

58-
public function column(string $column): Search
58+
public function findColumn(string $column): Search
5959
{
6060
$this->options->string_column = trim($column);
6161
return $this;
6262
}
6363

64-
public function algorithm(string $searchStringAlgorithm): Search
64+
public function findAlgorithm(string $searchStringAlgorithm): Search
6565
{
6666
$this->options->string_algo = trim($searchStringAlgorithm);
6767
return $this;

0 commit comments

Comments
 (0)