From f42266f26e193311aa6f23e65c88077ae4cc88de Mon Sep 17 00:00:00 2001 From: Georges Date: Sun, 7 Jan 2024 05:01:49 +0100 Subject: [PATCH] Updated README --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/README.md b/README.md index 7112f5a..aad7ba8 100644 --- a/README.md +++ b/README.md @@ -24,3 +24,25 @@ composer install phpfastcache/arangodb-extension #### ⚠️ This extension requires: 1️ The composer `triagens/arangodb` library 3.8 at least. + +## Events +This driver is emitting [customs events](https://github.com/PHPSocialNetwork/phpfastcache/blob/master/docs/EVENTS.md): +- onArangodbConnection(*Callable* **$callback**) + - **Callback arguments** + - *ExtendedCacheItemPoolInterface* **$itemPool** + - *EventReferenceParameter($connectionOptions)* **$connectionOptions** _via EventReferenceParameter object_ **(type modification forbidden)** + - **Scope** + - Arangodb Driver + - **Description** + - Allow you to alter the parameters built used to connect to Arangodb server + - **Risky Circular Methods**: None + +- onArangodbCollectionParams(*Callable* **$callback**) + - **Callback arguments** + - *ExtendedCacheItemPoolInterface* **$itemPool** + - *EventReferenceParameter($params)* **$params** _via EventReferenceParameter object_ **(type modification forbidden)** + - **Scope** + - Arangodb Driver + - **Description** + - Allow you to alter the parameters built used to create the collection + - **Risky Circular Methods**: None