-
-
Notifications
You must be signed in to change notification settings - Fork 5.2k
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
Reworded the explanation about when a lock is released #4903
Merged
Merged
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
82a9635
Reworded the explanation about when a lock is released
javiereguiluz 89a7320
Added the new documentation inside a "caution" admonition
javiereguiluz e632d49
Fixed the errors spotted by Wouter
javiereguiluz 6e14bac
Fixed minor grammar issues
javiereguiluz File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -62,8 +62,24 @@ You can pass an optional blocking argument as the first argument to the | |
``lock()`` method, which defaults to ``false``. If this is set to ``true``, your | ||
PHP code will wait indefinitely until the lock is released by another process. | ||
|
||
The resource is automatically released by PHP at the end of the script. In | ||
addition, you can invoke the | ||
:method:`Symfony\\Component\\Filesystem\\LockHandler::release` method to release | ||
the lock explicitly. Once it's released, any other process can lock the | ||
resource. | ||
.. caution:: | ||
|
||
Be aware of the fact that the resource lock is automatically released as soon | ||
as PHP applies the garbage-collection process to the ``LockHandler`` object. | ||
This means that if you refactor the first example showed in this article as | ||
follows:: | ||
|
||
use Symfony\Component\Filesystem\LockHandler; | ||
|
||
if (!(new LockHandler('hello.lock'))->lock()) { | ||
// the resource "hello" is already locked by another process | ||
|
||
return 0; | ||
} | ||
|
||
Now the code won't work as expected, because PHP's garbage collection mechanism | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Do we really need a comma before "because"? |
||
removes the reference to the ``LockHandler`` object and thus, the lock is released | ||
just after it's been created. | ||
|
||
Another alternative way to release the lock explicitly when needed is to use the | ||
:method:`Symfony\\Component\\Filesystem\\LockHandler::release` method. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
shown