W2w\Laravel\Apie\Events\OpenApiSpecGenerated

Complexity

Total Complexity

3

Size/Duplication

Total Lines	30
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	3	1
A	getDocument()	0	3	1
A	overrideDocument()	0	3	1

<?php
namespace W2w\Laravel\Apie\Events;

use erasys\OpenApi\Spec\v3\Document;

/**
 * Event triggered that an OpenAPI document was created. This can be used to modify the OpenApi spec being generated.
 */
class OpenApiSpecGenerated
{
    private $openApiDoc;

    /**
     * @param Document $openApiDoc
     */
    public function __construct(Document $openApiDoc)
    {
        $this->openApiDoc = $openApiDoc;
    }

    /**
     * @return Document
     */
    public function getDocument(): Document
    {
        return $this->openApiDoc;
    }

    /**
     * Replace the document. It's advisable to stop event propagation by returning false afterwards in your
     * listener.
     *
     * @param Document $document
     * @return OpenApiSpecGenerated
     */
    public function overrideDocument(Document $document): self {
        $this->openApiDoc = $document;
        return $this;
    }
}