Skip to content

Documented the Lockable Trait #6953

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions console/lockable_trait.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
Prevent Multiple Executions of a Console Command
================================================

A simple but effective way to prevent multiple executions of the same command in
a single server is to use **file locks**. The Filesystem component provides a
:doc:`LockHandler </components/filesystem/lock_handler>` class that eases the
creation and release of these locks.

In addition, the Console component provides a PHP trait called ``LockableTrait``
that adds two convenient methods to lock and release commands::

// ...
use Symfony\Component\Console\Command\LockableTrait;

class UpdateContentsCommand extends Command
{
use LockableTrait;

// ...

protected function execute(InputInterface $input, OutputInterface $output)
{
if (!$this->lock()) {
$output->writeln('The command is already running in another process.');

return 0;
}

// If you prefer to wait until the lock is released, use this:
// $this->lock(true);

// ...

// if not released explicitly, Symfony releases the lock
// automatically when the execution of the command ends
$this->release();
}
}