https://github.com/netgen/ezplatform-search-extra
Netgen's extra bits for eZ Platform search
https://github.com/netgen/ezplatform-search-extra
ezplatform ezpublish php search solr
Last synced: 8 months ago
JSON representation
Netgen's extra bits for eZ Platform search
- Host: GitHub
- URL: https://github.com/netgen/ezplatform-search-extra
- Owner: netgen
- License: gpl-2.0
- Created: 2018-03-24T09:36:19.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2023-02-01T12:16:03.000Z (over 3 years ago)
- Last Synced: 2025-09-29T08:49:23.167Z (9 months ago)
- Topics: ezplatform, ezpublish, php, search, solr
- Language: PHP
- Homepage: https://netgen.io
- Size: 441 KB
- Stars: 13
- Watchers: 6
- Forks: 4
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Netgen's extra bits for eZ Platform search
[](https://travis-ci.com/netgen/ezplatform-search-extra)
[](https://netgen-ezplatform-search-extra.readthedocs.io/en/latest/index.html)
[](https://packagist.org/packages/netgen/ezplatform-search-extra)
[](https://packagist.org/packages/netgen/ezplatform-search-extra)
[](https://ezplatform.com/)
[](https://packagist.org/packages/netgen/ezplatform-search-extra)
### Other versions
- release compatible with eZ Platform `3.1` is `2.4`
- release compatible with eZ Platform `2.x` is `1.14`
## Features
This only lists all implemented features, see the
[documentation](https://netgen-ezplatform-search-extra.readthedocs.io)
for more details on specific ones.
- [`ContentName`](https://github.com/netgen/ezplatform-search-extra/blob/1.13/lib/API/Values/Content/Query/Criterion/ContentName.php) criterion that works on matched translation's Content name (`solr`, `legacy`)
- [`ContentName`](https://github.com/netgen/ezplatform-search-extra/blob/1.13/lib/API/Values/Content/Query/SortClause/ContentName.php) sort clause that works on matched translation's Content name (`solr`, `legacy`)
- [`ContentId`](https://github.com/netgen/ezplatform-search-extra/blob/master/lib/API/Values/Content/Query/Criterion/ContentId.php) and [`LocationId`](https://github.com/netgen/ezplatform-search-extra/blob/master/lib/API/Values/Content/Query/Criterion/LocationId.php) criteria with support for range operators (`solr`, `legacy`)
Supported operators are: `EQ`, `IN`, `GT`, `GTE`, `LT`, `LTE`, `BETWEEN`.
- [`Visible`](https://github.com/netgen/ezplatform-search-extra/blob/master/lib/API/Values/Content/Query/Criterion/Visible.php) criterion (`solr`, `legacy`),
usable in both Content and Location search. The criterion works on compound visiblity of Content and Location objects:
the Content is visible if it's marked as visible; the Location is visible if it's marked as visible, is not hidden by
one of its ancestor Locations, and it's Content is visible.
- [Spellcheck suggestions support](https://docs.netgen.io/projects/search-extra/en/latest/reference/spellcheck_suggestions.html) (`solr`)
- [`CustomField`](https://github.com/netgen/ezplatform-search-extra/blob/master/lib/API/Values/Content/Query/SortClause/CustomField.php) sort clause (`solr`)
Provides a way to sort directly on Solr field by its name.
- Pagerfanta adapters providing access to extra information returned by the search
engine, like facets, aggregations, max score and execution time (`solr`, `legacy`):
- [`SearchAdapter`](https://github.com/netgen/ezplatform-search-extra/blob/master/lib/Core/Pagination/Pagerfanta/SearchAdapter.php) when using `API` search service
- [`SearchHandlerAdapter`](https://github.com/netgen/ezplatform-search-extra/blob/master/lib/Core/Pagination/Pagerfanta/SearchHandlerAdapter.php) when using `SPI` search handler
- A set of User related criteria (`legacy`):
- [`HasUser`](https://github.com/netgen/ezplatform-search-extra/blob/master/lib/API/Values/Content/Query/Criterion/HasUser.php) criterion
- [`UserEmail`](https://github.com/netgen/ezplatform-search-extra/blob/master/lib/API/Values/Content/Query/Criterion/UserEmail.php) criterion
- [`UserEnabled`](https://github.com/netgen/ezplatform-search-extra/blob/master/lib/API/Values/Content/Query/Criterion/UserEnabled.php) criterion
- [`UserId`](https://github.com/netgen/ezplatform-search-extra/blob/master/lib/API/Values/Content/Query/Criterion/UserId.php) criterion
- [`UserLogin`](https://github.com/netgen/ezplatform-search-extra/blob/master/lib/API/Values/Content/Query/Criterion/UserLogin.php) criterion
- [`IsFieldEmpty`](https://github.com/netgen/ezplatform-search-extra/blob/master/lib/API/Values/Content/Query/Criterion/IsFieldEmpty.php) criterion (`solr`)
Requires initial reindexing after installation.
- [`ObjectStateIdentifier`](https://github.com/netgen/ezplatform-search-extra/blob/master/lib/API/Values/Content/Query/Criterion/ObjectStateIdentifier.php) criterion (`solr`, `legacy`)
- [`SectionIdentifier`](https://github.com/netgen/ezplatform-search-extra/blob/master/lib/API/Values/Content/Query/Criterion/SectionIdentifier.php) criterion (`solr`, `legacy`)
- Support for custom Content subdocuments (Solr search engine) (`solr`)
Provides a way to index custom subdocuments to Content document and
[`SubdocumentQuery`](https://github.com/netgen/ezplatform-search-extra/blob/master/lib/API/Values/Content/Query/Criterion/SubdocumentQuery.php)
criterion, available in Content search to define grouped conditions for a custom subdocument.
- [`SubdocumentField`](https://github.com/netgen/ezplatform-search-extra/blob/master/lib/API/Values/Content/Query/SortClause/SubdocumentField.php) sort clause (`solr`)
Provides a way to sort Content by a subdocument field, choosing score calculation mode and optionally limiting with `SubdocumentQuery` criterion.
**Note:** This will require Solr `6.6` or higher in order to work correctly with all scoring modes.
- [`LocationQuery`](https://github.com/netgen/ezplatform-search-extra/blob/master/lib/API/Values/Content/Query/Criterion/LocationQuery.php) criterion (`solr`, `legacy`)
Allows grouping of Location criteria so that they apply together on a Location.
- [`CustomFieldFacetBuilder`](https://github.com/netgen/ezplatform-search-extra/blob/master/lib/API/Values/Content/Query/FacetBuilder/CustomFieldFacetBuilder.php) facet builder (`solr`)
Allows building facets on custom Solr fields.
- [`RawFacetBuilder`](https://github.com/netgen/ezplatform-search-extra/blob/master/lib/Core/Search/Solr/API/FacetBuilder/RawFacetBuilder.php) facet builder (`solr`)
Exposes Solr's [JSON facet API](https://lucene.apache.org/solr/guide/7_4/json-facet-api.html) in full.
- [`Score`](https://github.com/netgen/ezplatform-search-extra/blob/master/lib/API/Values/Content/Query/SortClause/Score.php) sort clause (`solr`)
Provides a way to sort Content by score value.
- [`Random`](https://github.com/netgen/ezplatform-search-extra/blob/master/lib/API/Values/Content/Query/SortClause/Random.php) sort clause (`solr`)
Provides a way to sort Content randomly.
- Indexable implementations for [`RichText`](https://github.com/netgen/ezplatform-search-extra/blob/master/lib/Core/FieldType/RichText/Indexable.php) and [`XmlText`](https://github.com/netgen/ezplatform-search-extra/blob/master/lib/Core/FieldType/XmlText/Indexable.php) (`solr`)
These implementations shorten text indexed as keyword to 256 characters, which prevents failures
when the field's content is too big for Solr's string field. They can be controlled with
semantic configuration (showing defaults):
```yaml
netgen_ez_platform_search_extra:
indexable_field_type:
ezxmltext:
enabled: true
short_text_limit: 256
ezrichtext:
enabled: true
short_text_limit: 256
```
- [`Loading`](https://github.com/netgen/ezplatform-search-extra/blob/master/lib/Core/Search/Solr/ResultExtractor/LoadingResultExtractor.php) implementation of result extractor (`solr`)
Loading result extractor gets it's value objects by loading them from the persistence. This
prevents:
- `UnauthorizedException` failures because of the missing `content/versionread` permission
when Content is updated and incremented current version number is not yet indexed in Solr
- `NotFoundException` failures when Content/Location is deleted and the corresponding document
is not yet removed from Solr index
Usage of loading result extractor can be controlled with semantic configuration (showing defaults):
```yaml
netgen_ez_platform_search_extra:
use_loading_search_result_extractor: true
```
## Installation
To install eZ Platform Search Extra first add it as a dependency to your project:
```sh
composer require netgen/ezplatform-search-extra:^2.5
```
Once the added dependency is installed, activate the bundle in `app/AppKernel.php` file by adding it to the `$bundles` array in `registerBundles()` method, together with other required bundles:
```php
public function registerBundles()
{
...
$bundles[] = new Netgen\Bundle\EzPlatformSearchExtraBundle\NetgenEzPlatformSearchExtraBundle;
return $bundles;
}
```