README.md

January 7, 2024 · View on GitHub

Contributing PHP Tests

Merge requests are welcome but will require the tests plus the quality tools to pass:

(Commands must be run from the repository root)

PHPCS, PHPMD, PHPSTAN (Level 6), unit tests:

composer run-script quality
composer run-script tests

# In case you want to fix the code style automatically: 
composer run-script phpcbf

Support & Security

Support for this extension must be posted to the main Phpfastcache repository.

Composer installation:

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:

  • onArangodbConnection(Callable $callback)

    • Callback arguments
      • ExtendedCacheItemPoolInterface $itemPool
      • EventReferenceParameter(connectionOptions)∗∗∗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)* **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