imbo/imbo-mongodb-adapters

MongoDB adapters for Imbo

dev-main 2023-04-09 08:21 UTC

Requires

• php: >=8.1
• ext-mongodb: ^1.10
• mongodb/mongodb: ^1.6

Requires (Dev)

• imbo/imbo: dev-main
• imbo/imbo-adapters-sdk: dev-main
• imbo/imbo-coding-standard: ^2.0
• phpunit/phpunit: ^10.0
• psalm/plugin-phpunit: ^0.18.4
• vimeo/psalm: ^5.5

MIT

• Christer Edvartsen
• Contributors

• imbo

README

MongoDB storage and database adapters for Imbo.

Installation

composer require imbo/imbo-mongodb-adapters

Usage

This package provides both storage and database adapters for Imbo, leveraging GridFS and MongoDB. The package also has a storage adapter for image variations.

$mainDatabaseAdapter = new Imbo\Database\MongoDB();
$mainStorageAdapter = new Imbo\Storage\GridFS();
$imageVariationsDatabaseAdapter = new Imbo\EventListener\ImageVariations\Database\MongoDB();
$imageVariationsStorageAdapter = new Imbo\EventListener\ImageVariations\Storage\GridFS();
$mutableAccessControlAdapter = new Imbo\Auth\AccessControl\Adapter\MongoDB();

Running integration tests

If you want to run the integration tests you will need a running MongoDB service. The repo contains a simple configuration file for Docker Compose that you can use to quickly run a MongoDB instance.

If you wish to use this, run the following command to start up the service after you have cloned the repo:

docker-compose up -d

After the service is running you can execute all tests by simply running PHPUnit:

composer run test # or ./vendor/bin/phpunit

License

MIT, see LICENSE.