Skip to content

Commit e016fd6

Browse files
committedJan 31, 2024·
chore(doc): Prepare release 1.9.0
1 parent a29c613 commit e016fd6

File tree

2 files changed

+17
-10
lines changed

2 files changed

+17
-10
lines changed
 

‎CHANGELOG.md

+7
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
77

88
## [Unreleased]
99

10+
## 1.9.0
11+
12+
### Added
13+
14+
- Add support for Symfony 7 and PHP 8.3
15+
- Documentation improvements
16+
1017
## 1.8.4
1118

1219
### Added

‎README.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ use JoliCode\Elastically\Model\Document;
5353
$factory = new Factory([
5454
// Where to find the mappings
5555
Factory::CONFIG_MAPPINGS_DIRECTORY => __DIR__.'/mappings',
56-
// What object to find in each index
56+
// What objects to find in each index
5757
Factory::CONFIG_INDEX_CLASS_MAPPING => [
5858
'beers' => Beer::class,
5959
],
@@ -177,24 +177,24 @@ An array of index name to class FQN.
177177

178178
An instance of `MappingProviderInterface`.
179179

180-
If this option is not defined, the factory will fallback to `YamlProvider` and will use
180+
If this option is not defined, the factory will fall back to `YamlProvider` and will use
181181
`Factory::CONFIG_MAPPINGS_DIRECTORY` option.
182182

183183
There are two providers available in Elastically: `YamlProvider` and `PhpProvider`.
184184

185185
### `Factory::CONFIG_SERIALIZER` (optional)
186186

187-
A `SerializerInterface` compatible object that will by used on indexation.
187+
A `SerializerInterface` compatible object that will be used on indexation.
188188

189189
_Default to Symfony Serializer with Object Normalizer._
190190

191-
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).
191+
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).
192192

193193
### `Factory::CONFIG_DENORMALIZER` (optional)
194194

195-
A `DenormalizerInterface` compatible object that will by used on search results to build your objects back.
195+
A `DenormalizerInterface` compatible object that will be used on search results to build your objects back.
196196

197-
If this option is not defined, the factory will fallback to
197+
If this option is not defined, the factory will fall back to
198198
`Factory::CONFIG_SERIALIZER` option.
199199

200200
### `Factory::CONFIG_SERIALIZER_CONTEXT_BUILDER` (optional)
@@ -315,7 +315,7 @@ elastically:
315315
default:
316316
serializer:
317317
context_builder_service: App\Elastically\Serializer\ContextBuilder
318-
# Do not defined "context_mapping" option anymore
318+
# Do not define "context_mapping" option anymore
319319
```
320320

321321
##### Use a Custom Mapping provider
@@ -326,7 +326,7 @@ elastically:
326326
connections:
327327
default:
328328
mapping_provider_service: App\Elastically\MappingProvider
329-
# Do not defined "index_class_mapping" option anymore
329+
# Do not define "index_class_mapping" option anymore
330330
```
331331

332332
##### Using HttpClient as Transport
@@ -341,7 +341,7 @@ JoliCode\Elastically\Client:
341341
$config:
342342
host: '%env(ELASTICSEARCH_HOST)%'
343343
transport: 'JoliCode\Elastically\Transport\HttpClientTransport'
344-
...
344+
# ...
345345
```
346346

347347
#### Reference
@@ -382,7 +382,7 @@ use JoliCode\Elastically\Messenger\IndexationRequestHandler;
382382
383383
$bus->dispatch(new IndexationRequest(Product::class, '1234567890'));
384384
385-
// Third argument is the operation, so for a delete:
385+
// Third argument is the operation, so for a "delete" add this argument:
386386
// new IndexationRequest(Product::class, 'ref9999', IndexationRequestHandler::OP_DELETE);
387387
```
388388

0 commit comments

Comments
 (0)
Please sign in to comment.