Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Correct title levels in custom entities doc #193

Merged
merged 1 commit into from
Oct 9, 2023
Merged

Correct title levels in custom entities doc #193

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/add_custom_entities.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,36 +64,36 @@ Also, the `public function getTarget(): string` method must return the value of

## Display your new entity in the search results

## Define your Instant Search request
### Define your Instant Search request

If you want to display your entity in the instant search (`instant_search_enabled` is `true` in configuration).

[Declare your instant search request service](../dist/src/Resources/config/services.yaml#L60).

[Don't forget to bind the parameter for the service](../dist/src/Resources/config/services.yaml#L6).

## Define your Search request
### Define your Search request

[Declare your search request service](../dist/src/Resources/config/services.yaml#L67).

[Don't forget to bind the parameter for the service](../dist/src/Resources/config/services.yaml#L6).

You can extends the `MonsieurBiz\SyliusSearchPlugin\Search\Request\Search` class to manage your aggregations like in [products](../src/Search/Request/ProductRequest/Search.php).

## Define your Search query filter
### Define your Search query filter

[Declare your search query filter for instant search](../dist/src/Resources/config/services.yaml#L77).

[Declare your search query filter for search](../dist/src/Resources/config/services.yaml#L87).

You can extends the `MonsieurBiz\SyliusSearchPlugin\Search\Request\QueryFilter\SearchTermFilter` class to manage your custom behaviour like in [products](../src/Search/Request/QueryFilter/Product/SearchTermFilter.php).

## Add the templates for display
### Add the templates for display

[Declare your templates for instant search](../dist/templates/bundles/MonsieurBizSyliusSearchPlugin/Instant/Taxon/_box.html.twig).

[Declare your templates for search](../dist/templates/bundles/MonsieurBizSyliusSearchPlugin/Search/Taxon/_box.html.twig).

## Add your document translation
### Add your document translation

[Declare your translations for your entity](../dist/translations/messages.en.yaml#L5).