lullabot/drupal-symfony-lock

Use Drupal's lock backends with Symfony's locking API.

1.2.0 2023-09-06 13:46 UTC

Requires

• php: ^8.0
• drupal/core: ^9.1||^10
• symfony/lock: ^4.4||^6

Requires (Dev)

• drupal/coder: 8.3.13
• phpunit/phpunit: ^6.5||^9.5
• squizlabs/php_codesniffer: 3.6.0

GPL-2.0-or-later

• Andrew Berry

README

Do you want to use a PHP library that requires Symfony's Lock Component in your Drupal site? This library maps Drupal's LockBackendInterface to a Symfony StoreInterface.

Usage

Require this library in your Drupal module:

$ composer require lullabot/drupal-symfony-lock

Inject lock service from the Drupal container, and use it when constructing this class:

<?php

$backend = \Drupal::lock();
$store = new \Lullabot\DrupalSymfonyLock\DrupalStore($backend);
$factory = new \Symfony\Component\Lock\Factory($store);
$lock = $factory->createLock('lock-identifier', 10);

// Blocking means this will throw an exception on failure.
$lock->acquire(true);