Add @api annotation to the ScopeConfig WriterInterface

[navarr]

Description

I would like a more official way of writing config that's part of the API.

Currently, You should use Magento\Config\Model\ResourceModel\Config::saveConfig - which is @api annotated.

That class implements Magento\Framework\App\Config\ConfigResource\ConfigInterface (which is not annotated) - and that class is used by Magento\Framework\App\Config\Storage\WriterInterface (which is not annotated - but I propose to do so here)

Contribution checklist

• Pull request has a meaningful description of its purpose
• All commits are accompanied by meaningful commit messages
• All new or changed code is covered with unit/integration tests (if applicable)
• All automated tests passed successfully (all builds on Travis CI are green)

[magento-engcom-team]

Hi @larsroettig, thank you for the review.
ENGCOM-1097 has been created to process this Pull Request

[magento-engcom-team]

@navarr thank you for contributing. Please accept Community Contributors team invitation here to gain extended permissions for this repository.

[navarr]

@magento-engcom-team That link just takes me to the magento user page on github.

[larsroettig]

@navarr Because you are already in Magento org :-) maybe we should fix this in automation 🔍

[sidolov]

Hi @navarr , I see that in namespace \Magento\Framework\App\Config we have several interfaces without @api annotation, so, can you describe the scenario when you need write to storage with usage \Magento\Framework\App\Config\Storage\WriterInterface?

[navarr]

@sidolov Yes. Our team was writing a log rotator (for the database), where older logs are deleted.

To accomplish this, we had two config fields: a start time, and a frequency. These are then compiled into a configuration setting that contains the actual cron format.

We needed a method to write to the config during this compilation step. The developer's first go was to use the config Value model and save it - but that's not the Magento way, so we went down the rabbit hole of trying to figure out how we're supposed to save config.

The internet likes WriterInterface - but it's not annotated, so I went down the chain of things it does to find something annotated.

Unfortunately what we found was Magento\Config\Model\ResourceModel\Config. While we can use that (since it's annotated) - using another module's resourcemodel seems very wrong.

The ideal situation is that there is an api annotated interface for setting config. WriterInterface seems like the best choice.

[sidolov]

@navarr I see that it useful for you, thank you for fast response!