spryker / spryker-core

Bundles/GlueApplication/src/Spryker/Glue/GlueApplication/Rest/JsonApi/RestResource.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\Glue\GlueApplication\Rest\JsonApi;

use ArrayObject;
use Spryker\Shared\Kernel\Transfer\AbstractTransfer;

/**
 * @deprecated Will be removed without replacement.
 */
class RestResource implements RestResourceInterface
{
    /**
     * @var string|null
     */
    protected $id;

    /**
     * @var string
     */
    protected $type;

    /**
     * @var array<\Spryker\Glue\GlueApplication\Rest\JsonApi\RestLinkInterface>
     */
    protected $links = [];

    /**
     * @var array
     */
    protected $relationships = [];

    /**
     * @var \Spryker\Shared\Kernel\Transfer\AbstractTransfer|null
     */
    protected $attributes;

    /**
     * @var \Spryker\Shared\Kernel\Transfer\AbstractTransfer|null
     */
    protected $payload;

    /**
     * @param string $type
     * @param string|null $id
     * @param \Spryker\Shared\Kernel\Transfer\AbstractTransfer|null $attributes
     */
    public function __construct(string $type, ?string $id = null, ?AbstractTransfer $attributes = null)
    {
        $this->type = $type;
        $this->id = $id;
        $this->attributes = $attributes;
    }

    /**
     * @param \Spryker\Glue\GlueApplication\Rest\JsonApi\RestResourceInterface $restResource
     *
     * @return \Spryker\Glue\GlueApplication\Rest\JsonApi\RestResourceInterface
     */
    public function addRelationship(RestResourceInterface $restResource): RestResourceInterface
    {
        if ($restResource->getId()) {
            $this->relationships[$restResource->getType()][$restResource->getId()] = $restResource;

            return $this;
        }

        $this->relationships[$restResource->getType()][] = $restResource;

        return $this;
    }

    /**
     * @param string $type
     *
     * @return array<\Spryker\Glue\GlueApplication\Rest\JsonApi\RestResourceInterface>
     */
    public function getRelationshipByType(string $type): array
    {
        return $this->relationships[$type];
    }

    /**
     * @return array
     */
    public function getRelationships(): array
    {
        return $this->relationships;
    }

    /**
     * @param string $name
     * @param string $resourceUri
     * @param array $meta
     *
     * @return \Spryker\Glue\GlueApplication\Rest\JsonApi\RestResourceInterface
     */
    public function addLink(string $name, string $resourceUri, array $meta = []): RestResourceInterface
    {
        $this->links[] = new RestLink($name, $resourceUri, $meta);

The class Spryker\Glue\GlueApplication\Rest\JsonApi\RestLink has been deprecated: Will be removed without replacement.

        return $this;
    }

    /**
     * @param string $name
     *
     * @return bool
     */
    public function hasLink(string $name): bool
    {
        foreach ($this->links as $link) {
            if ($name === $link->getName()) {
                return true;
            }
        }

        return false;
    }

    /**
     * @return string|null
     */
    public function getId(): ?string
    {
        return $this->id;
    }

    /**
     * @return string
     */
    public function getType(): string
    {
        return $this->type;
    }

    /**
     * @return \Spryker\Shared\Kernel\Transfer\AbstractTransfer|null
     */
    public function getAttributes(): ?AbstractTransfer
    {
        return $this->attributes;
    }

    /**
     * @return array
     */
    public function getLinks(): array
    {
        return $this->links;
    }

    /**
     * @param bool $includeRelations
     *
     * @return array
     */
    public function toArray($includeRelations = true): array
    {
        $response = [
            RestResourceInterface::RESOURCE_TYPE => $this->type,
            RestResourceInterface::RESOURCE_ID => $this->id,
        ];

        if ($this->attributes) {
            $response[RestResourceInterface::RESOURCE_ATTRIBUTES] = $this->transformTransferToArray($this->attributes);
        }

        $response = $this->addLinksDataToResponse($response);

        if (!$includeRelations) {
            return $response;
        }

        $relationships = $this->toArrayRelationships();
        if ($relationships) {
            $response[RestResourceInterface::RESOURCE_RELATIONSHIPS] = $relationships;
        }

        return $response;
    }

    /**
     * @param \Spryker\Shared\Kernel\Transfer\AbstractTransfer|null $payload
     *
     * @return $this
     */
    public function setPayload(?AbstractTransfer $payload)
    {
        $this->payload = $payload;

        return $this;
    }

    /**
     * @return \Spryker\Shared\Kernel\Transfer\AbstractTransfer|null
     */
    public function getPayload(): ?AbstractTransfer
    {
        return $this->payload;
    }

    /**
     * @param array $response
     *
     * @return array
     */
    protected function addLinksDataToResponse(array $response): array
    {
        if ($this->links) {
            $response[RestResourceInterface::RESOURCE_LINKS] = [];
            foreach ($this->links as $link) {
                $response[RestResourceInterface::RESOURCE_LINKS] += $link->toArray();
            }
        }

        return $response;
    }

    /**
     * @return array
     */
    protected function toArrayRelationships(): array
    {
        $relationships = [];
        foreach ($this->relationships as $type => $typeRelationships) {
            if (!isset($relationships[$type])) {
                $relationships[$type][RestResourceInterface::RESOURCE_DATA] = [];
            }

            foreach ($typeRelationships as $relationship) {
                $relationships[$type][RestResourceInterface::RESOURCE_DATA][] = [
                    RestResourceInterface::RESOURCE_TYPE => $type,
                    RestResourceInterface::RESOURCE_ID => $relationship->getId(),
                ];
            }
        }

        return $relationships;
    }

    /**
     * Used for preventing have empty object instead of empty arrays in the response.
     * Converts transfer object to array.
     * Replaces empty ArrayObjects to empty arrays.
     *
     * @param \Spryker\Shared\Kernel\Transfer\AbstractTransfer $transfer
     *
     * @return array
     */
    private function transformTransferToArray(AbstractTransfer $transfer): array
    {
        $transferData = $transfer->toArray(true, true);

        return $this->transformEmptyArrayObjectToArray($transferData);
    }

    /**
     * @param array $transferData
     *
     * @return array
     */
    private function transformEmptyArrayObjectToArray(array $transferData): array
    {
        foreach ($transferData as $key => $item) {
            if (is_array($item)) {
                $transferData[$key] = $this->transformEmptyArrayObjectToArray($item);
            }
            if (($item instanceof ArrayObject) && count($item) === 0) {
                $transferData[$key] = [];
            }
        }

        return $transferData;
    }
}