spryker / spryker-core

Bundles/DocumentationGeneratorRestApi/src/Spryker/Zed/DocumentationGeneratorRestApi/Business/Renderer/Component/SchemaSpecificationComponent.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\SchemaComponentTransfer;

/**
 * Specification:
 *  - This component describes a single Schema Object.
 *  - This component partly covers Schema Object in OpenAPI specification format (see https://swagger.io/specification/#schemaObject).
 */
class SchemaSpecificationComponent implements SchemaSpecificationComponentInterface
{
    /**
     * @var \Generated\Shared\Transfer\SchemaComponentTransfer|null
     */
    protected $schemaComponentTransfer;

    /**
     * @param \Generated\Shared\Transfer\SchemaComponentTransfer $schemaComponentTransfer
     *
     * @return void
     */
    public function setSchemaComponentTransfer(SchemaComponentTransfer $schemaComponentTransfer): void
    {
        $this->schemaComponentTransfer = $schemaComponentTransfer;
    }

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

        if (count($this->schemaComponentTransfer->getProperties()) === 0 && !$this->schemaComponentTransfer->getItems()) {
            //empty object is needed for generation of valid OpenAPI scheme
            return [
                $this->schemaComponentTransfer->getName() => (object)[],
            ];
        }

        $schemaData = [];
        $schemaData = $this->addProperties($schemaData);
        $schemaData = $this->addItems($schemaData);
        $schemaData = $this->addRequired($schemaData);
        $schemaData = $this->addType($schemaData);

        return $schemaData;
    }

    /**
     * @param array $schemaData
     *
     * @return array
     */
    protected function addProperties(array $schemaData): array
    {
        if (count($this->schemaComponentTransfer->getProperties())) {

The method getProperties() does not exist on null.

            $schemaData[$this->schemaComponentTransfer->getName()][SchemaComponentTransfer::PROPERTIES] = array_merge(...$this->schemaComponentTransfer->getProperties());
        }

        return $schemaData;
    }

    /**
     * @param array $schemaData
     *
     * @return array
     */
    protected function addItems(array $schemaData): array
    {
        if ($this->schemaComponentTransfer->getItems()) {
            $schemaData[$this->schemaComponentTransfer->getName()][SchemaComponentTransfer::ITEMS] = $this->schemaComponentTransfer->getItems();
        }

        return $schemaData;
    }

    /**
     * @param array $schemaData
     *
     * @return array
     */
    protected function addRequired(array $schemaData): array
    {
        if ($this->schemaComponentTransfer->getRequired()) {
            $schemaData[$this->schemaComponentTransfer->getName()][SchemaComponentTransfer::REQUIRED] = $this->schemaComponentTransfer->getRequired();
        }

        return $schemaData;
    }

    /**
     * @param array $schemaData
     *
     * @return array
     */
    protected function addType(array $schemaData): array
    {
        if ($this->schemaComponentTransfer->getType()) {
            $schemaData[$this->schemaComponentTransfer->getName()][SchemaComponentTransfer::TYPE] = $this->schemaComponentTransfer->getType();
        }

        return $schemaData;
    }

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

        $this->schemaComponentTransfer->requireName();

        return true;
    }
}