Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. LockableTrait.php

trait LockableTrait

Basic lock feature for commands.

@author Geoffrey Brier <geoffrey.brier@gmail.com>

Hierarchy

  • trait \Symfony\Component\Console\Command\LockableTrait

File

vendor/symfony/console/Command/LockableTrait.php, line 25

Namespace

Symfony\Component\Console\Command
View source
trait LockableTrait {
    private ?LockInterface $lock = null;
    private ?LockFactory $lockFactory = null;
    
    /**
     * Locks a command.
     */
    private function lock(?string $name = null, bool $blocking = false) : bool {
        if (!class_exists(SemaphoreStore::class)) {
            throw new LogicException('To enable the locking feature you must install the symfony/lock component. Try running "composer require symfony/lock".');
        }
        if (null !== $this->lock) {
            throw new LogicException('A lock is already in place.');
        }
        if (null === $this->lockFactory) {
            if (SemaphoreStore::isSupported()) {
                $store = new SemaphoreStore();
            }
            else {
                $store = new FlockStore();
            }
            $this->lockFactory = new LockFactory($store);
        }
        $this->lock = $this->lockFactory
            ->createLock($name ?: $this->getName());
        if (!$this->lock
            ->acquire($blocking)) {
            $this->lock = null;
            return false;
        }
        return true;
    }
    
    /**
     * Releases the command lock if there is one.
     */
    private function release() : void {
        if ($this->lock) {
            $this->lock
                ->release();
            $this->lock = null;
        }
    }

}

Members

Title Sort descending Modifiers Object type Summary
LockableTrait::$lock private property
LockableTrait::$lockFactory private property
LockableTrait::lock private function Locks a command.
LockableTrait::release private function Releases the command lock if there is one.
RSS feed
Powered by Drupal