spryker / spryker-core

Bundles/DocumentationGeneratorRestApi/src/Spryker/Zed/DocumentationGeneratorRestApi/Business/Renderer/Component/SchemaItemsSpecificationComponent.php

<?php

/**
 * Copyright © 2016-present Spryker Systems GmbH. All rights reserved.
 * Use of this software requires acceptance of the Evaluation License Agreement. See LICENSE file.
 */

namespace Spryker\Zed\DocumentationGeneratorRestApi\Business\Renderer\Component;

use Generated\Shared\Transfer\SchemaItemsComponentTransfer;

/**
 * Specification:
 *  - This component describes a single Schema Object Property.
 *  - This component partly covers Schema Object Properties in OpenAPI specification format (see https://swagger.io/specification/#schemaObject).
 */
class SchemaItemsSpecificationComponent implements SchemaItemsSpecificationComponentInterface
{
    /**
     * @var string
     */
    protected const KEY_REF = '$ref';

    /**
     * @var string
     */
    protected const KEY_ITEMS = 'items';

    /**
     * @var string
     */
    protected const KEY_ONEOF = 'oneOf';

    /**
     * @var string
     */
    protected const KEY_TYPE = 'type';

    /**
     * @var string
     */
    protected const KEY_NULLABLE = 'nullable';

    /**
     * @var string
     */
    protected const VALUE_TYPE_ARRAY = 'array';

    /**
     * @var \Generated\Shared\Transfer\SchemaItemsComponentTransfer|null
     */
    protected $schemaItemsComponentTransfer;

    /**
     * @param \Generated\Shared\Transfer\SchemaItemsComponentTransfer $schemaItemsComponentTransfer
     *
     * @return void
     */
    public function setSchemaItemsComponentTransfer(SchemaItemsComponentTransfer $schemaItemsComponentTransfer): void
    {
        $this->schemaItemsComponentTransfer = $schemaItemsComponentTransfer;
    }

    /**
     * @return array
     */
    public function getSpecificationComponentData(): array
    {
        if (!$this->validateSchemaPropertyComponentTransfer()) {
            return [];
        }

        return $this->addOneOf();
    }

    /**
     * @return array
     */
    protected function addOneOf(): array
    {
        $schemaItems = [];

        if ($this->schemaItemsComponentTransfer->getOneOf()) {

The method getOneOf() does not exist on null.

            foreach ($this->schemaItemsComponentTransfer->getOneOf() as $ref) {
                $schemaItems[static::KEY_ONEOF][][static::KEY_REF] = $ref;
            }
        }

        return $schemaItems;
    }

    /**
     * @return bool
     */
    protected function validateSchemaPropertyComponentTransfer(): bool
    {
        if (!$this->schemaItemsComponentTransfer) {
            return false;
        }

        $this->schemaItemsComponentTransfer->requireOneOf();

        return true;
    }
}