apie-lib / openapi-schema

src/Spec/Example.php

<?php


namespace Apie\OpenapiSchema\Spec;

use Apie\CommonValueObjects\Url;
use Apie\OpenapiSchema\Concerns\CompositeValueObjectWithExtension;
use Apie\OpenapiSchema\Exceptions\ExampleValueAndExternalValueAreMutuallyExclusive;
use Apie\OpenapiSchema\ValueObjects\SpecificationExtension;
use Apie\ValueObjects\ValueObjectInterface;

class Example implements ValueObjectInterface
{
    use CompositeValueObjectWithExtension;

The trait Apie\OpenapiSchema\Concerns\CompositeValueObjectWithExtension requires the property $name which is not provided by Apie\OpenapiSchema\Spec\Example.

    /**
     * @var string|null
     */
    private $summary;

The private property $summary is not used, and could be removed.

    /**
     * @var string|null
     */
    private $description;

The private property $description is not used, and could be removed.

    /**
     * @var mixed|null
     */
    private $value;

    /**
     * @var Url|null
     */
    private $externalValue;

    /**
     * @var SpecificationExtension
     */
    private $specificationExtension;

    public function __construct()
    {
        $this->specificationExtension = new SpecificationExtension([]);
    }

    private function validateProperties(): void
    {
        if (isset($this->value) && isset($this->externalValue)) {
            throw new ExampleValueAndExternalValueAreMutuallyExclusive();
        }
    }
}