https://github.com/phpsocialnetwork/couchdb-extension

Couchdb extension for Phpfastcache v9.2 and greater
https://github.com/phpsocialnetwork/couchdb-extension

cache couchdb couchdb-client php phpfastcache

Last synced: about 1 month ago
JSON representation

Couchdb extension for Phpfastcache v9.2 and greater

• Host: GitHub
• URL: https://github.com/phpsocialnetwork/couchdb-extension
• Owner: PHPSocialNetwork
• License: mit
• Created: 2024-01-07T01:43:09.000Z (12 months ago)
• Default Branch: master
• Last Pushed: 2024-01-09T20:09:03.000Z (12 months ago)
• Last Synced: 2024-03-25T21:18:09.978Z (9 months ago)
• Topics: cache, couchdb, couchdb-client, php, phpfastcache
• Language: PHP
• Homepage:
• Size: 19.5 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
## Contributing [![PHP Tests](https://github.com/PHPSocialNetwork/couchdb-extension/actions/workflows/php.yml/badge.svg)](https://github.com/PHPSocialNetwork/couchdb-extension/actions/workflows/php.yml)

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:

```bash

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](https://github.com/PHPSocialNetwork/phpfastcache/issues).

## Composer installation:

```php

composer install phpfastcache/couchdb-extension

```

#### ⚠️ This extension requires:

1️ The composer `doctrine/couchdb` library `dev-master#9eeb9e5` at least.\

**You MUST ensure that the dependency is at least at commit `9eeb9e5` due to a serious bug in `doctrine/couchdb` that causes infinite loop.**

## Events

This driver is emitting [customs events](https://github.com/PHPSocialNetwork/phpfastcache/blob/master/docs/EVENTS.md):

- onCouchdbCreateOptions(*Callable* **$callback**)

    - **Callback arguments**

        - *ExtendedCacheItemPoolInterface* **$itemPool**

        - *EventReferenceParameter($options)* **$options** _via EventReferenceParameter object_ **(type modification forbidden)**

    - **Scope**

        - Couchdb Driver

    - **Description**

        - Allow you to alter the options built used to create the Couchdb client instance.

    - **Risky Circular Methods**: None