Skip to content

Commit

Permalink
docs: add simple search engine
Browse files Browse the repository at this point in the history
  • Loading branch information
adrianschubek committed Oct 30, 2024
1 parent d1e8efa commit b7c1db4
Showing 1 changed file with 17 additions and 5 deletions.
22 changes: 17 additions & 5 deletions docs/docs/configuration/search.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,15 @@ sidebar_position: 3

Click on the column header to sort by that column. Click again to reverse the sort order.

Click on the search icon to open the search input field. Both `glob` and `regex` engines are available to search the current folder and all descendants of the current folder.
Click on the search icon to open the search input field. All engines search the current folder and all descendants of the current folder.

### Simple search

Most intuitive string-matching search engine with basic functionality.

### Glob-based search

This is the recommended search engine for most users. It is simple to use and faster than the regex engine.
More powerful search engine for advanced users. It is simple to use and faster than the regex engine.

| Pattern | Description |
|----------------|--------------------------------------------------------------------------------------------------------------------------------------------|
Expand All @@ -21,12 +25,20 @@ This is the recommended search engine for most users. It is simple to use and fa
| `[...]` | Matches one character from a group of characters. If the first character is `!`, it matches any character *not* in the group. |
| `\` | Escapes the following character. |

[Learn more](https://en.wikipedia.org/wiki/Glob_(programming))
:::info
Expansion `{a,b,c}` is not available because it is not supported by the underlying base image (Alpine Linux).

Globestar `**` is not supported by PHP natively and might be implemented in the future.
:::

> [Learn more](https://en.wikipedia.org/wiki/Glob_(programming))
### Regex-based search

[Learn more](https://en.wikipedia.org/wiki/Regular_expression)
This engine is the most powerful but slower than the glob engine. It is useful for complex searches.

> [Learn more](https://en.wikipedia.org/wiki/Regular_expression)
import EnvConfig from '@site/src/components/EnvConfig';

<EnvConfig name="SEARCH|SEARCH_ENGINE|SEARCH_MAX_DEPTH|SEARCH_MAX_RESULTS|REVERSE_SORT" init="true|glob|25|100|false" values="true,false|glob,regex|integer|integer|true,false" versions="3.7|3.7|3.7|3.7|1.0" desc="Enables or disables the search functionality|Search engine to evaluate query|Maximum recursive search depth (regex engine only)|Maximum number of results in a single request|By default files and folders are sorted by name using natural sort."/>
<EnvConfig name="SEARCH|SEARCH_ENGINE|SEARCH_MAX_DEPTH|SEARCH_MAX_RESULTS|REVERSE_SORT" init="true|simple|25|100|false" values="true,false|simple,glob,regex|integer|integer|true,false" versions="3.7|3.7|3.7|3.7|1.0" desc="Enables or disables the search functionality|Search engine to evaluate query|Maximum recursive search depth (simple and regex engine only)|Maximum number of results in a single request|By default files and folders are sorted by name using natural sort."/>

0 comments on commit b7c1db4

Please sign in to comment.