netgen/ezplatform-search-extra

Netgen's extra bits for eZ Platform search

2.6.0 2021-03-26 13:10 UTC

Requires

• ext-dom: *
• ext-json: *
• ezsystems/ezplatform-kernel: ^1.2

Requires (Dev)

• ezsystems/ezplatform-solr-search-engine: ^3.1
• ezsystems/ezplatform-xmltext-fieldtype: ^2.0
• matthiasnoback/symfony-dependency-injection-test: ^4.1
• netgen/ezplatform-site-api: ^4.3
• phpunit/phpunit: ^8.2

Suggests

• ezsystems/ezplatform-solr-search-engine: Supports advanced capabilities with eZ Platform search API, ^1.4 is required
• netgen/ezplatform-site-api: Boost your site-building productivity with eZ Platform

Conflicts

• symfony/cache: 5.0.11 || 5.1.3

GPL-2.0-only

• Petar Španja

README

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 for more details on specific ones.

• ContentName criterion that works on matched translation's Content name (solr, legacy)

• ContentName sort clause that works on matched translation's Content name (solr, legacy)

• ContentId and LocationId criteria with support for range operators (solr, legacy)

  Supported operators are: EQ, IN, GT, GTE, LT, LTE, BETWEEN.

• Visible 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 (solr)

• CustomField 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 when using API search service
  • SearchHandlerAdapter when using SPI search handler

• A set of User related criteria (legacy):

  • HasUser criterion
  • UserEmail criterion
  • UserEnabled criterion
  • UserId criterion
  • UserLogin criterion

• IsFieldEmpty criterion (solr)

  Requires initial reindexing after installation.

• ObjectStateIdentifier criterion (solr, legacy)

• SectionIdentifier criterion (solr, legacy)

• Support for custom Content subdocuments (Solr search engine) (solr)

  Provides a way to index custom subdocuments to Content document and SubdocumentQuery criterion, available in Content search to define grouped conditions for a custom subdocument.

• SubdocumentField 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 criterion (solr, legacy)

  Allows grouping of Location criteria so that they apply together on a Location.

• CustomFieldFacetBuilder facet builder (solr)

  Allows building facets on custom Solr fields.

• RawFacetBuilder facet builder (solr)

  Exposes Solr's JSON facet API in full.

• Score sort clause (solr)

  Provides a way to sort Content by score value.

• Random sort clause (solr)

  Provides a way to sort Content randomly.

• Indexable implementations for RichText and XmlText (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):

  netgen_ez_platform_search_extra:
      indexable_field_type:
          ezxmltext:
              enabled: true
              short_text_limit: 256
          ezrichtext:
              enabled: true
              short_text_limit: 256

• Loading 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):

  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:

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:

public function registerBundles()
{
    ...

    $bundles[] = new Netgen\Bundle\EzPlatformSearchExtraBundle\NetgenEzPlatformSearchExtraBundle;

    return $bundles;
}