oxid-professional-services/usercentrics

OXID Cookie Management powered by usercentrics

v3.0.0 2024-03-15 10:29 UTC

Requires

• php: ^8.1
• ext-json: *
• symfony/yaml: > 3

Requires (Dev)

• ext-dom: *
• ext-libxml: *
• oxid-esales/oxideshop-ce: dev-b-7.1.x
• phpmd/phpmd: ^2.15
• phpstan/phpstan: ^1.10
• phpunit/phpunit: ^10.5
• squizlabs/php_codesniffer: ^3.8

proprietary

README

This module provides the Usercentrics functionality for the OXID eShop allowing you to use their Consent Management Platform.

Usage

This assumes you have OXID eShop (at least the v6.2.0 compilation) up and running.

Install

The Usercentrics module is already included in the OXID eShop compilation.

Module can be installed manually, by using composer:

$ composer require oxid-professional-services/usercentrics

After requiring the module, you need to activate it, either via OXID eShop admin or CLI.

Navigate to oxideshop folder and execute the following:

$ vendor/bin/oe-console oe:module:activate oxps_usercentrics

How to use

Activate the module and enter your usercentrics ID in the module settings.

User documentation: DE

Branch Compatibility

• b-7.3.x branch for b-7.3.x shop compilation branches
• b-7.2.x branch and v3.0.0 for b-7.2.x shop compilation branches
• b-7.1.x branch and v3.0.0 for b-7.1.x shop compilation branches
• b-7.0.x branch and v3.0.0 for b-7.0.x shop compilation branches
• b-6.5.x branch for b-6.5.x shop compilation branches
• b-6.3.x branch for b-6.3.x and b-6.4.x shop compilation branches
• b-6.2.x branch for b-6.2.x shop compilation branches

Developer installation

1. Clone the SDK to MyProject directory in this case:

echo MyProject && git clone https://github.com/OXID-eSales/docker-eshop-sdk.git $_ && cd $_

1. Clone recipes

git clone --recurse-submodules https://github.com/OXID-eSales/docker-eshop-sdk-recipes recipes/oxid-esales

1. And last - run the module recipe:

./recipes/oxid-esales/module-usercentrics/b-7.3.x-root.sh

Testing

Linting, syntax check, static analysis

$ composer update
$ composer static

Unit/Integration/Acceptance tests

• Install this module in a running OXID eShop
• Reset the shop's database

$ bin/oe-console oe:database:reset --db-host=db-host --db-port=db-port --db-name=db-name --db-user=db-user --db-password=db-password --force

• Run all the tests

$ composer tests-all

• Or the desired suite

$ composer tests-unit
$ composer tests-integration
$ composer tests-codeception

Contributing

You like to contribute? 🙌 AWESOME 🙌
Go and check the contribution guidelines

Issues

To report issues with the module, please use the OXID eShop bugtracking system - module Usercentrics project.

License

OXID Module and Component License, see LICENSE file.