Introduce MetadataValidators to test arbitrary metadata for freshness. #15692
Fix tests while keeping ConfigCacheFactory unchanged (from a client p…
…erspective)
- Loading branch information
commit b8bb60a7cdba5757c75e516b28244875acacefa3
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
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,64 @@ | ||
| <?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\Config; | ||
|
|
||
| /** | ||
| * A ConfigCacheFactory implementation that validates the | ||
| * cache with an arbitrary set of metadata validators. | ||
| * | ||
| * @author Matthias Pigulla <mp@webfactory.de> | ||
| */ | ||
| class ValidatorConfigCacheFactory implements ConfigCacheFactoryInterface | ||
| { | ||
| /** | ||
| * @var bool | ||
| */ | ||
| private $debug; | ||
|
|
||
| /** | ||
| * @var MetadataValidatorInterface[] | ||
| */ | ||
| private $validators = array(); | ||
|
|
||
| /** | ||
| * @param bool $debug The debug flag to pass to ConfigCache | ||
| */ | ||
| public function __construct($debug) | ||
| { | ||
| $this->debug = $debug; | ||
| } | ||
|
|
||
| /** | ||
| * @param MetadataValidatorInterface $validator | ||
| */ | ||
| public function addValidator(MetadataValidatorInterface $validator) | ||
| { | ||
| $this->validators[] = $validator; | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| public function cache($file, $callback) | ||
| { | ||
| if (!is_callable($callback)) { | ||
| throw new \InvalidArgumentException(sprintf('Invalid type for callback argument. Expected callable, but got "%s".', gettype($callback))); | ||
| } | ||
|
|
||
| $cache = new ConfigCache($file, $this->debug); | ||
| if (!$cache->isFresh($this->validators)) { | ||
| call_user_func($callback, $cache); | ||
| } | ||
|
|
||
| return $cache; | ||
| } | ||
| } | ||
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.
Why creating a whole new config cache factory given adding validators to the old one is doable without BC break ? (But will prevent the deprecation due to https://github.com/symfony/symfony/pull/15692/files#diff-9f40590069e1fa6582e56bcea49e09a4R77)
Will the
ConfigCacheFactorytrigger a deprecation saying to use the newValidatorConfigCacheFactoryinstead ?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.
For BC reasons, the
RouterandTranslatorneed to create aConfigCacheFactorythemselves if none is injected. If that factory comes without the defaultResourceInterfaceValidator, they'd have to add one themselves and that would cause unnecessary dependencies. Having a defaultResourceInterfaceValidatorinConfigCacheFactorywould be weird as well.So this way, use a
ConfigCacheFactoryif you don't care about special validations and you'll get the same behaviour as in the past.Use a ValidatorConfigCacheFactory if you care about special validations or if you get the instance injected anyway and don't care about the hassle of setting it up.