Skip to content

[Console] Add doc about lockableTrait #19697

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

Merged
merged 1 commit into from
Apr 2, 2024
Merged
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
20 changes: 20 additions & 0 deletions console/lockable_trait.rst
Original file line number Diff line number Diff line change
Expand Up @@ -43,4 +43,24 @@ that adds two convenient methods to lock and release commands::
}
}

The LockableTrait will use the ``SemaphoreStore`` if available and will default
to ``FlockStore`` otherwise. You can override this behavior by setting
a ``$lockFactory`` property with your own lock factory::

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

class UpdateContentsCommand extends Command
{
use LockableTrait;

public function __construct(private LockFactory $lockFactory)
{
}

// ...
}

.. _`locks`: https://en.wikipedia.org/wiki/Lock_(computer_science)