From e016fd648d897c1c09e8714d5f4fd96559efacf8 Mon Sep 17 00:00:00 2001 From: Damien ALEXANDRE Date: Wed, 31 Jan 2024 11:44:40 +0100 Subject: [PATCH] chore(doc): Prepare release 1.9.0 --- CHANGELOG.md | 7 +++++++ README.md | 20 ++++++++++---------- 2 files changed, 17 insertions(+), 10 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 1c0eb36..521395d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] +## 1.9.0 + +### Added + +- Add support for Symfony 7 and PHP 8.3 +- Documentation improvements + ## 1.8.4 ### Added diff --git a/README.md b/README.md index 336ede6..ea19df6 100644 --- a/README.md +++ b/README.md @@ -53,7 +53,7 @@ use JoliCode\Elastically\Model\Document; $factory = new Factory([ // Where to find the mappings Factory::CONFIG_MAPPINGS_DIRECTORY => __DIR__.'/mappings', - // What object to find in each index + // What objects to find in each index Factory::CONFIG_INDEX_CLASS_MAPPING => [ 'beers' => Beer::class, ], @@ -177,24 +177,24 @@ An array of index name to class FQN. An instance of `MappingProviderInterface`. -If this option is not defined, the factory will fallback to `YamlProvider` and will use +If this option is not defined, the factory will fall back to `YamlProvider` and will use `Factory::CONFIG_MAPPINGS_DIRECTORY` option. There are two providers available in Elastically: `YamlProvider` and `PhpProvider`. ### `Factory::CONFIG_SERIALIZER` (optional) -A `SerializerInterface` compatible object that will by used on indexation. +A `SerializerInterface` compatible object that will be used on indexation. _Default to Symfony Serializer with Object Normalizer._ -A faster alternative is to use Jane to generate plain PHP Normalizer, see below. Also we recommend [customization to handle things like Date](https://symfony.com/doc/current/components/serializer.html#normalizers). +A faster alternative is to use Jane to generate plain PHP Normalizer, see below. Also, we recommend [customization to handle things like Date](https://symfony.com/doc/current/components/serializer.html#normalizers). ### `Factory::CONFIG_DENORMALIZER` (optional) -A `DenormalizerInterface` compatible object that will by used on search results to build your objects back. +A `DenormalizerInterface` compatible object that will be used on search results to build your objects back. -If this option is not defined, the factory will fallback to +If this option is not defined, the factory will fall back to `Factory::CONFIG_SERIALIZER` option. ### `Factory::CONFIG_SERIALIZER_CONTEXT_BUILDER` (optional) @@ -315,7 +315,7 @@ elastically: default: serializer: context_builder_service: App\Elastically\Serializer\ContextBuilder - # Do not defined "context_mapping" option anymore + # Do not define "context_mapping" option anymore ``` ##### Use a Custom Mapping provider @@ -326,7 +326,7 @@ elastically: connections: default: mapping_provider_service: App\Elastically\MappingProvider - # Do not defined "index_class_mapping" option anymore + # Do not define "index_class_mapping" option anymore ``` ##### Using HttpClient as Transport @@ -341,7 +341,7 @@ JoliCode\Elastically\Client: $config: host: '%env(ELASTICSEARCH_HOST)%' transport: 'JoliCode\Elastically\Transport\HttpClientTransport' - ... + # ... ``` #### Reference @@ -382,7 +382,7 @@ use JoliCode\Elastically\Messenger\IndexationRequestHandler; $bus->dispatch(new IndexationRequest(Product::class, '1234567890')); -// Third argument is the operation, so for a delete: +// Third argument is the operation, so for a "delete" add this argument: // new IndexationRequest(Product::class, 'ref9999', IndexationRequestHandler::OP_DELETE); ```