Skip to content

Commit

Permalink
Add acp search result provider PIP documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Gravatronics committed Apr 22, 2017
1 parent a5e61e4 commit 99b0bad
Showing 1 changed file with 30 additions and 1 deletion.
31 changes: 30 additions & 1 deletion pages/package/pip/package_pip_acp-search-provider.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,33 @@ folder: package/pip
parent: package_pip
---

*Content will follow soon*
Registers data provider for the admin panel search.

## Components

Each acp search result provider is described as an `<acpsearchprovider>` element with the mandatory attribute `name`.

### `<classname>`

The name of the class providing the search results.
The class has to implement the `wcf\system\search\acp\IACPSearchResultProvider` interface.

### `<showorder>`

{% include callout.html content="Optional" type="info" %}

Determines at which position of the search result list the provided results are shown.

## Example

```xml
<?xml version="1.0" encoding="UTF-8"?>
<data xmlns="http://www.woltlab.com" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.woltlab.com http://www.woltlab.com/XSD/vortex/acpSearchProvider.xsd">
<import>
<acpsearchprovider name="com.woltlab.wcf.example">
<classname>wcf\system\search\acp\ExampleACPSearchResultProvider</classname>
<showorder>1</showorder>
</acpsearchprovider>
</import>
</data>
```

0 comments on commit 99b0bad

Please sign in to comment.