Documentation config exposed to the Generator #495
Conversation
…an benefit from it When creating a custom processor, the documentation configuration is not Exposed to the Generator class. This makes any kind of documentation-based processing no possible.
…an benefit from it When creating a custom processor, the documentation configuration is not exposed to the Generator class. This makes any kind of documentation-based processing not possible.
|
It might be worth keeping in mind that https://github.com/zircote/swagger-php/blob/master/tests/GeneratorTest.php#L127 |
| /** | ||
| * @var array | ||
| */ | ||
| protected $config; |
There was a problem hiding this comment.
Can we be more precise and name this something like documentationConfig.
On the other hand - in the factory now we destruct whole documentationConfig and pass it's parts to generator as a separate params. This prop will hold everything now, so we will have duplication... 🤔
| ?Filesystem $filesystem = null, | ||
| array $config |
| @@ -229,7 +236,9 @@ protected function setProcessors(OpenApiGenerator $generator): void | |||
| $processors[] = $processor; | |||
| if ($processor instanceof \OpenApi\Processors\BuildPaths) { | |||
| foreach ($processorClasses as $customProcessor) { | |||
| $processors[] = new $customProcessor(); | |||
| $customProcessorObj = new $customProcessor(); | |||
| $customProcessorObj->config = $this->config; | |||
There was a problem hiding this comment.
processors in swagger-php have no common interface, so this will only work if client will add config prop to it's processor. This will create a dynamic prop in the class now, but this is going to be deprecated in php8.2
So we need to thing about some internal interface, which has defined setConfig() method and only if custom processor implements it - do the setting.
There was a problem hiding this comment.
I have had similar thoughts, but since processors can also be callables this didn't get very far.
That's why I opened for checking for matching setXXX() setter methods...
When in the process of creating a custom processor to filter Annotations based on custom properties, I realized there was no access to the configuration of the documentation itself. This code pushes the individual documentation config to the Generator so that the processor can use it.