-
-
Notifications
You must be signed in to change notification settings - Fork 9.6k
[Lock] Re-add the Lock component in 3.4 #22597
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
Closed
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
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 hidden or 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
This file contains hidden or 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 |
---|---|---|
@@ -0,0 +1,3 @@ | ||
composer.lock | ||
phpunit.xml | ||
vendor/ |
This file contains hidden or 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 |
---|---|---|
@@ -0,0 +1,7 @@ | ||
CHANGELOG | ||
========= | ||
|
||
3.3.0 | ||
----- | ||
|
||
* added the component |
21 changes: 21 additions & 0 deletions
21
src/Symfony/Component/Lock/Exception/ExceptionInterface.php
This file contains hidden or 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 |
---|---|---|
@@ -0,0 +1,21 @@ | ||
<?php | ||
|
||
/* | ||
* This file is part of the Symfony package. | ||
* | ||
* (c) Fabien Potencier <fabien@symfony.com> | ||
* | ||
* For the full copyright and license information, please view the LICENSE | ||
* file that was distributed with this source code. | ||
*/ | ||
|
||
namespace Symfony\Component\Lock\Exception; | ||
|
||
/** | ||
* Base ExceptionInterface for the Lock Component. | ||
* | ||
* @author Jérémy Derussé <jeremy@derusse.com> | ||
*/ | ||
interface ExceptionInterface | ||
{ | ||
} |
19 changes: 19 additions & 0 deletions
19
src/Symfony/Component/Lock/Exception/InvalidArgumentException.php
This file contains hidden or 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 |
---|---|---|
@@ -0,0 +1,19 @@ | ||
<?php | ||
|
||
/* | ||
* This file is part of the Symfony package. | ||
* | ||
* (c) Fabien Potencier <fabien@symfony.com> | ||
* | ||
* For the full copyright and license information, please view the LICENSE | ||
* file that was distributed with this source code. | ||
*/ | ||
|
||
namespace Symfony\Component\Lock\Exception; | ||
|
||
/** | ||
* @author Jérémy Derussé <jeremy@derusse.com> | ||
*/ | ||
class InvalidArgumentException extends \InvalidArgumentException implements ExceptionInterface | ||
{ | ||
} |
21 changes: 21 additions & 0 deletions
21
src/Symfony/Component/Lock/Exception/LockAcquiringException.php
This file contains hidden or 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 |
---|---|---|
@@ -0,0 +1,21 @@ | ||
<?php | ||
|
||
/* | ||
* This file is part of the Symfony package. | ||
* | ||
* (c) Fabien Potencier <fabien@symfony.com> | ||
* | ||
* For the full copyright and license information, please view the LICENSE | ||
* file that was distributed with this source code. | ||
*/ | ||
|
||
namespace Symfony\Component\Lock\Exception; | ||
|
||
/** | ||
* LockAcquiringException is thrown when an issue happens during the acquisition of a lock. | ||
* | ||
* @author Jérémy Derussé <jeremy@derusse.com> | ||
*/ | ||
class LockAcquiringException extends \RuntimeException implements ExceptionInterface | ||
{ | ||
} |
21 changes: 21 additions & 0 deletions
21
src/Symfony/Component/Lock/Exception/LockConflictedException.php
This file contains hidden or 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 |
---|---|---|
@@ -0,0 +1,21 @@ | ||
<?php | ||
|
||
/* | ||
* This file is part of the Symfony package. | ||
* | ||
* (c) Fabien Potencier <fabien@symfony.com> | ||
* | ||
* For the full copyright and license information, please view the LICENSE | ||
* file that was distributed with this source code. | ||
*/ | ||
|
||
namespace Symfony\Component\Lock\Exception; | ||
|
||
/** | ||
* LockConflictedException is thrown when a lock is acquired by someone else. | ||
* | ||
* @author Jérémy Derussé <jeremy@derusse.com> | ||
*/ | ||
class LockConflictedException extends \RuntimeException implements ExceptionInterface | ||
{ | ||
} |
21 changes: 21 additions & 0 deletions
21
src/Symfony/Component/Lock/Exception/LockReleasingException.php
This file contains hidden or 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 |
---|---|---|
@@ -0,0 +1,21 @@ | ||
<?php | ||
|
||
/* | ||
* This file is part of the Symfony package. | ||
* | ||
* (c) Fabien Potencier <fabien@symfony.com> | ||
* | ||
* For the full copyright and license information, please view the LICENSE | ||
* file that was distributed with this source code. | ||
*/ | ||
|
||
namespace Symfony\Component\Lock\Exception; | ||
|
||
/** | ||
* LockReleasingException is thrown when an issue happens during the release of a lock. | ||
* | ||
* @author Jérémy Derussé <jeremy@derusse.com> | ||
*/ | ||
class LockReleasingException extends \RuntimeException implements ExceptionInterface | ||
{ | ||
} |
21 changes: 21 additions & 0 deletions
21
src/Symfony/Component/Lock/Exception/LockStorageException.php
This file contains hidden or 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 |
---|---|---|
@@ -0,0 +1,21 @@ | ||
<?php | ||
|
||
/* | ||
* This file is part of the Symfony package. | ||
* | ||
* (c) Fabien Potencier <fabien@symfony.com> | ||
* | ||
* For the full copyright and license information, please view the LICENSE | ||
* file that was distributed with this source code. | ||
*/ | ||
|
||
namespace Symfony\Component\Lock\Exception; | ||
|
||
/** | ||
* LockStorageException is thrown when an issue happens during the manipulation of a lock in a store. | ||
* | ||
* @author Jérémy Derussé <jeremy@derusse.com> | ||
*/ | ||
class LockStorageException extends \RuntimeException implements ExceptionInterface | ||
{ | ||
} |
21 changes: 21 additions & 0 deletions
21
src/Symfony/Component/Lock/Exception/NotSupportedException.php
This file contains hidden or 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 |
---|---|---|
@@ -0,0 +1,21 @@ | ||
<?php | ||
|
||
/* | ||
* This file is part of the Symfony package. | ||
* | ||
* (c) Fabien Potencier <fabien@symfony.com> | ||
* | ||
* For the full copyright and license information, please view the LICENSE | ||
* file that was distributed with this source code. | ||
*/ | ||
|
||
namespace Symfony\Component\Lock\Exception; | ||
|
||
/** | ||
* NotSupportedException is thrown when an unsupported method is called. | ||
* | ||
* @author Jérémy Derussé <jeremy@derusse.com> | ||
*/ | ||
class NotSupportedException extends \LogicException implements ExceptionInterface | ||
{ | ||
} |
This file contains hidden or 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 |
---|---|---|
@@ -0,0 +1,51 @@ | ||
<?php | ||
|
||
/* | ||
* This file is part of the Symfony package. | ||
* | ||
* (c) Fabien Potencier <fabien@symfony.com> | ||
* | ||
* For the full copyright and license information, please view the LICENSE | ||
* file that was distributed with this source code. | ||
*/ | ||
|
||
namespace Symfony\Component\Lock; | ||
|
||
use Psr\Log\LoggerAwareInterface; | ||
use Psr\Log\LoggerAwareTrait; | ||
use Psr\Log\NullLogger; | ||
|
||
/** | ||
* Factory provides method to create locks. | ||
* | ||
* @author Jérémy Derussé <jeremy@derusse.com> | ||
*/ | ||
class Factory implements LoggerAwareInterface | ||
{ | ||
use LoggerAwareTrait; | ||
|
||
private $store; | ||
|
||
public function __construct(StoreInterface $store) | ||
{ | ||
$this->store = $store; | ||
|
||
$this->logger = new NullLogger(); | ||
} | ||
|
||
/** | ||
* Creates a lock for the given resource. | ||
* | ||
* @param string $resource The resource to lock | ||
* @param float $ttl maximum expected lock duration | ||
* | ||
* @return Lock | ||
*/ | ||
public function createLock($resource, $ttl = 300.0) | ||
{ | ||
$lock = new Lock(new Key($resource), $this->store, $ttl); | ||
$lock->setLogger($this->logger); | ||
|
||
return $lock; | ||
} | ||
} |
This file contains hidden or 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 |
---|---|---|
@@ -0,0 +1,73 @@ | ||
<?php | ||
|
||
/* | ||
* This file is part of the Symfony package. | ||
* | ||
* (c) Fabien Potencier <fabien@symfony.com> | ||
* | ||
* For the full copyright and license information, please view the LICENSE | ||
* file that was distributed with this source code. | ||
*/ | ||
|
||
namespace Symfony\Component\Lock; | ||
|
||
/** | ||
* Key is a container for the state of the locks in stores. | ||
* | ||
* @author Jérémy Derussé <jeremy@derusse.com> | ||
*/ | ||
final class Key | ||
{ | ||
private $resource; | ||
private $state = array(); | ||
|
||
/** | ||
* @param string $resource | ||
*/ | ||
public function __construct($resource) | ||
{ | ||
$this->resource = (string) $resource; | ||
} | ||
|
||
public function __toString() | ||
{ | ||
return $this->resource; | ||
} | ||
|
||
/** | ||
* @param string $stateKey | ||
* | ||
* @return bool | ||
*/ | ||
public function hasState($stateKey) | ||
{ | ||
return isset($this->state[$stateKey]); | ||
} | ||
|
||
/** | ||
* @param string $stateKey | ||
* @param mixed $state | ||
*/ | ||
public function setState($stateKey, $state) | ||
{ | ||
$this->state[$stateKey] = $state; | ||
} | ||
|
||
/** | ||
* @param string $stateKey | ||
*/ | ||
public function removeState($stateKey) | ||
{ | ||
unset($this->state[$stateKey]); | ||
} | ||
|
||
/** | ||
* @param $stateKey | ||
* | ||
* @return mixed | ||
*/ | ||
public function getState($stateKey) | ||
{ | ||
return $this->state[$stateKey]; | ||
} | ||
} |
This file contains hidden or 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 |
---|---|---|
@@ -0,0 +1,19 @@ | ||
Copyright (c) 2016-2017 Fabien Potencier | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is furnished | ||
to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
THE SOFTWARE. |
Oops, something went wrong.
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.
should be 3.4.0