File loaders can now set the type to load explicitly #7353
Conversation
|
👍 for the changes, but we should document the version this feature was added to |
There was a problem hiding this comment.
👍
The changes in the dependency injection component doc look perfect as is, but I think it misses an import example, as in the original issue:
# app/config/config.yml
imports:
- { resource: my_custom_config.ext, type: yml }Is there any suitable place where it can be added?
| .. tip:: | ||
|
|
||
| If your application uses unconventional file extensions (for example, your | ||
| YAML files have a ``.res`` extension) you can pass the file type as the |
There was a problem hiding this comment.
Actually, it depends on the loader implementation. The one described in this part of the documentation (YamlUserLoader code above) totally ignores the type argument, as was done before by the DIC loaders 😅 (I think it should not appear at all in the Config component doc)
There was a problem hiding this comment.
Are there plans to add this feature to these loaders too ... or it doesn't make sense? Thanks!
There was a problem hiding this comment.
The only other loaders implementing LoaderInterface from the Config component are the routing ones.
They handle the $type argument quite differently:
# Symfony\Component\Routing\Loader\YamlFileLoader
/**
* {@inheritdoc}
*/
public function supports($resource, $type = null)
{
return is_string($resource) && in_array(pathinfo($resource, PATHINFO_EXTENSION), array('yml', 'yaml'), true) && (!$type || 'yaml' === $type);
}The type cannot be forced, but should be empty or match the extension. Maybe it can be updated to match the new behavior introduced in the di loaders.
But I still think this note should not appear in the Config component documentation, as it should described the LoaderInterface and what it is used for. It should not document implementations from other components.
There was a problem hiding this comment.
👍 thanks for the explanation.
| /* | ||
| The YamlUserLoader will be used to load this resource, | ||
| // YamlUserLoader is used to load this resource because it supports | ||
| // files with the '.yml' extension | ||
| since it supports files with a "yml" extension |
There was a problem hiding this comment.
This line should be removed, right?
|
Oops! Looks like I forgot something here: Status: Reviewed |
|
Thank you Javier. |
This fixes #7352.
I propose to document this in a subtle manner because this is rarely needed by users.
Ping @ogizanagi because he was the original author of the related PR. Thanks!