Mar 24, 2025 · Mar 23, 2025 · Mar 24, 2025
diff --git a/src/Symfony/Component/Console/CHANGELOG.md b/src/Symfony/Component/Console/CHANGELOG.md
 * Add support for help definition via `AsCommand` attribute
 * Deprecate methods `Command::getDefaultName()` and `Command::getDefaultDescription()` in favor of the `#[AsCommand]` attribute
 * Add support for Markdown format in `Table`
 * Add support for `LockableTrait` in invokable commands

 7.2
 ---
diff --git a/src/Symfony/Component/Console/Command/LockableTrait.php b/src/Symfony/Component/Console/Command/LockableTrait.php

 namespaceSymfony\Component\Console\Command;

 useSymfony\Component\Console\Attribute\AsCommand;
 useSymfony\Component\Console\Exception\LogicException;
 useSymfony\Component\Lock\LockFactory;
 useSymfony\Component\Lock\LockInterface;
 $store =newFlockStore();
            }

 $this->lockFactory =(newLockFactory($store));
 $this->lockFactory =newLockFactory($store);
        }

 $this->lock =$this->lockFactory->createLock($name ?:$this->getName());
 if (!$name) {
 if ($thisinstanceof Command) {
 $name =$this->getName();
            }elseif ($attribute = (new \ReflectionClass($this::class))->getAttributes(AsCommand::class)) {
 $name =$attribute[0]->newInstance()->name;
            }else {
 thrownewLogicException(\sprintf('Lock name missing: provide it via "%s()", #[AsCommand] attribute, or by extending Command class.',__METHOD__));
            }
        }

 $this->lock =$this->lockFactory->createLock($name);
 if (!$this->lock->acquire($blocking)) {
 $this->lock =null;

diff --git a/src/Symfony/Component/Console/Tests/Command/LockableTraitTest.php b/src/Symfony/Component/Console/Tests/Command/LockableTraitTest.php
 namespace Symfony\Component\Console\Tests\Command;

 use PHPUnit\Framework\TestCase;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Tester\CommandTester;
 use Symfony\Component\Lock\LockFactory;
 use Symfony\Component\Lock\SharedLockInterface;
        require_once self::$fixturesPath.'/FooLockCommand.php';
        require_once self::$fixturesPath.'/FooLock2Command.php';
        require_once self::$fixturesPath.'/FooLock3Command.php';
        require_once self::$fixturesPath.'/FooLock4InvokableCommand.php';
    }

    public function testLockIsReleased()
        $lockFactory->expects(static::once())->method('createLock')->willReturn($lock);
        $this->assertSame(1, $tester->execute([]));
    }

    public function testLockInvokableCommandReturnsFalseIfAlreadyLockedByAnotherCommand()
    {
        $command = new Command('foo:lock4');
        $command->setCode(new \FooLock4InvokableCommand());

        if (SemaphoreStore::isSupported()) {
            $store = new SemaphoreStore();
        } else {
            $store = new FlockStore();
        }

        $lock = (new LockFactory($store))->createLock($command->getName());
        $lock->acquire();

        $tester = new CommandTester($command);
        $this->assertSame(Command::FAILURE, $tester->execute([]));

        $lock->release();
        $this->assertSame(Command::SUCCESS, $tester->execute([]));
    }
 }
diff --git a/src/Symfony/Component/Console/Tests/Fixtures/FooLock4InvokableCommand.php b/src/Symfony/Component/Console/Tests/Fixtures/FooLock4InvokableCommand.php
 <?php

 use Symfony\Component\Console\Attribute\AsCommand;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Command\LockableTrait;

 #[AsCommand(name: 'foo:lock4')]
 class FooLock4InvokableCommand
 {
    use LockableTrait;

    public function __invoke(): int
    {
        if (!$this->lock()) {
            return Command::FAILURE;
        }

        $this->release();

        return Command::SUCCESS;
    }
 }
Original file line number	Diff line number	Diff line change
Expand Up		@@ -11,6 +11,7 @@ CHANGELOG
		* Add support for help definition via `AsCommand` attribute
		* Deprecate methods `Command::getDefaultName()` and `Command::getDefaultDescription()` in favor of the `#[AsCommand]` attribute
		* Add support for Markdown format in `Table`
		* Add support for `LockableTrait` in invokable commands

		7.2
		---
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -11,6 +11,7 @@

		namespaceSymfony\Component\Console\Command;

		useSymfony\Component\Console\Attribute\AsCommand;
		useSymfony\Component\Console\Exception\LogicException;
		useSymfony\Component\Lock\LockFactory;
		useSymfony\Component\Lock\LockInterface;
Expand DownExpand Up		@@ -48,10 +49,20 @@ private function lock(?string $name = null, bool $blocking = false): bool
		$store =newFlockStore();
		}

		$this->lockFactory =(newLockFactory($store));
		$this->lockFactory =newLockFactory($store);
		}

		$this->lock =$this->lockFactory->createLock($name ?:$this->getName());
		if (!$name) {
		if ($thisinstanceof Command) {
		$name =$this->getName();
		}elseif ($attribute = (new \ReflectionClass($this::class))->getAttributes(AsCommand::class)) {
		$name =$attribute[0]->newInstance()->name;
		}else {
		thrownewLogicException(\sprintf('Lock name missing: provide it via "%s()", #[AsCommand] attribute, or by extending Command class.',__METHOD__));
		}
		}

		$this->lock =$this->lockFactory->createLock($name);
		if (!$this->lock->acquire($blocking)) {
		$this->lock =null;

Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -12,6 +12,7 @@
		namespace Symfony\Component\Console\Tests\Command;

		use PHPUnit\Framework\TestCase;
		use Symfony\Component\Console\Command\Command;
		use Symfony\Component\Console\Tester\CommandTester;
		use Symfony\Component\Lock\LockFactory;
		use Symfony\Component\Lock\SharedLockInterface;
Expand All		@@ -28,6 +29,7 @@ public static function setUpBeforeClass(): void
		require_once self::$fixturesPath.'/FooLockCommand.php';
		require_once self::$fixturesPath.'/FooLock2Command.php';
		require_once self::$fixturesPath.'/FooLock3Command.php';
		require_once self::$fixturesPath.'/FooLock4InvokableCommand.php';
		}

		public function testLockIsReleased()
Expand DownExpand Up		@@ -80,4 +82,25 @@ public function testCustomLockFactoryIsUsed()
		$lockFactory->expects(static::once())->method('createLock')->willReturn($lock);
		$this->assertSame(1, $tester->execute([]));
		}

		public function testLockInvokableCommandReturnsFalseIfAlreadyLockedByAnotherCommand()
		{
		$command = new Command('foo:lock4');
		$command->setCode(new \FooLock4InvokableCommand());

		if (SemaphoreStore::isSupported()) {
		$store = new SemaphoreStore();
		} else {
		$store = new FlockStore();
		}

		$lock = (new LockFactory($store))->createLock($command->getName());
		$lock->acquire();

		$tester = new CommandTester($command);
		$this->assertSame(Command::FAILURE, $tester->execute([]));

		$lock->release();
		$this->assertSame(Command::SUCCESS, $tester->execute([]));
		}
		}
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,22 @@
		<?php

		use Symfony\Component\Console\Attribute\AsCommand;
		use Symfony\Component\Console\Command\Command;
		use Symfony\Component\Console\Command\LockableTrait;

		#[AsCommand(name: 'foo:lock4')]
		class FooLock4InvokableCommand
		{
		use LockableTrait;

		public function __invoke(): int
		{
		if (!$this->lock()) {
		return Command::FAILURE;
		}

		$this->release();

		return Command::SUCCESS;
		}
		}