Part-DB-server/src/Services/InfoProviderSystem/DTOs/SearchResultDTO.php

<?php
/*
 * This file is part of Part-DB (https://github.com/Part-DB/Part-DB-symfony).
 *
 *  Copyright (C) 2019 - 2023 Jan Böhmer (https://github.com/jbtronics)
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU Affero General Public License as published
 *  by the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU Affero General Public License for more details.
 *
 *  You should have received a copy of the GNU Affero General Public License
 *  along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */

declare(strict_types=1);


namespace App\Services\InfoProviderSystem\DTOs;

use App\Entity\Parts\ManufacturingStatus;

/**
 * This DTO represents a search result for a part.
 * @see \App\Tests\Services\InfoProviderSystem\DTOs\SearchResultDTOTest
 */
class SearchResultDTO
{
    /** @var string|null An URL to a preview image */
    public readonly ?string $preview_image_url;
    /** @var FileDTO|null The preview image as FileDTO object */
    public readonly ?FileDTO $preview_image_file;

    public function __construct(
        /** @var string The provider key (e.g. "digikey") */
        public readonly string $provider_key,
        /** @var string The ID which identifies the part in the provider system */
        public readonly string $provider_id,
        /** @var string The name of the part  */
        public readonly string $name,
        /** @var string A short description of the part */
        public readonly string $description,
        /** @var string|null The category the distributor assumes for the part */
        public readonly ?string $category = null,
        /** @var string|null The manufacturer of the part */
        public readonly ?string $manufacturer = null,
        /** @var string|null The manufacturer part number */
        public readonly ?string $mpn = null,
        /** @var string|null An URL to a preview image */
        ?string $preview_image_url = null,
        /** @var ManufacturingStatus|null The manufacturing status of the part */
        public readonly ?ManufacturingStatus $manufacturing_status = null,
        /** @var string|null A link to the part on the providers page */
        public readonly ?string $provider_url = null,
        /** @var string|null A footprint representation of the providers page */
        public readonly ?string $footprint = null,
        /** @var string|null The GTIN / EAN of the part */
        public readonly ?string $gtin = null,
    )
    {
        if ($preview_image_url !== null) {
            //Utilize the escaping mechanism of FileDTO to ensure that the preview image URL is correctly encoded
            //See issue #521: https://github.com/Part-DB/Part-DB-server/issues/521
            $this->preview_image_file = new FileDTO($preview_image_url);
            $this->preview_image_url = $this->preview_image_file->url;
        } else {
            $this->preview_image_file = null;
            $this->preview_image_url = null;
        }
    }

    /**
     * This method creates a normalized array representation of the DTO.
     * @return array
     */
    public function toNormalizedSearchResultArray(): array
    {
        return [
            'provider_key' => $this->provider_key,
            'provider_id' => $this->provider_id,
            'name' => $this->name,
            'description' => $this->description,
            'category' => $this->category,
            'manufacturer' => $this->manufacturer,
            'mpn' => $this->mpn,
            'preview_image_url' => $this->preview_image_url,
            'manufacturing_status' => $this->manufacturing_status?->value,
            'provider_url' => $this->provider_url,
            'footprint' => $this->footprint,
            'gtin' => $this->gtin,
        ];
    }

    /**
     * Creates a SearchResultDTO from a normalized array representation.
     * @param  array  $data
     * @return self
     */
    public static function fromNormalizedSearchResultArray(array $data): self
    {
        return new self(
            provider_key: $data['provider_key'],
            provider_id: $data['provider_id'],
            name: $data['name'],
            description: $data['description'],
            category: $data['category'] ?? null,
            manufacturer: $data['manufacturer'] ?? null,
            mpn: $data['mpn'] ?? null,
            preview_image_url: $data['preview_image_url'] ?? null,
            manufacturing_status: isset($data['manufacturing_status']) ? ManufacturingStatus::tryFrom($data['manufacturing_status']) : null,
            provider_url: $data['provider_url'] ?? null,
            footprint: $data['footprint'] ?? null,
            gtin: $data['gtin'] ?? null,
        );
    }
}