LanguageListController.php

<?php

/**
 * @copyright Copyright (C) Ibexa AS. All rights reserved.
 * @license For full copyright and license information view LICENSE file distributed with this source code.
 */
declare(strict_types=1);

namespace Ibexa\Rest\Server\Controller\Language;

use ApiPlatform\Metadata\Get;
use ApiPlatform\OpenApi\Factory\OpenApiFactory;
use ApiPlatform\OpenApi\Model;
use Ibexa\Contracts\Core\Repository\LanguageService;
use Ibexa\Rest\Server\Controller as RestController;
use Ibexa\Rest\Server\Values\LanguageList;
use Symfony\Component\HttpFoundation\Response;
use Traversable;

#[Get(
    uriTemplate: '/languages',
    extraProperties: [OpenApiFactory::OVERRIDE_OPENAPI_RESPONSES => false],
    openapi: new Model\Operation(
        operationId: 'ibexa.rest.languages.list',
        summary: 'Language list',
        description: 'Lists languages',
        tags: [
            'Language',
        ],
        responses: [
            Response::HTTP_OK => [
                'description' => 'If set, the list is returned in XML or JSON format.',
                'content' => [
                    'application/vnd.ibexa.api.LanguageList+json' => [
                        'schema' => [
                            '$ref' => '#/components/schemas/LanguageListWrapper',
                        ],
                        'x-ibexa-example-file' => '@IbexaRestBundle/Resources/api_platform/examples/languages/GET/LanguageList.json.example',
                    ],
                    'application/vnd.ibexa.api.LanguageList+xml' => [
                        'schema' => [
                            '$ref' => '#/components/schemas/LanguageList',
                        ],
                        'x-ibexa-example-file' => '@IbexaRestBundle/Resources/api_platform/examples/languages/GET/LanguageList.xml.example',
                    ],
                ],
            ],
        ],
    ),
)]
final class LanguageListController extends RestController
{
    private LanguageService $languageService;

    public function __construct(LanguageService $languageService)
    {
        $this->languageService = $languageService;
    }

    public function listLanguages(): LanguageList
    {
        $languages = $this->languageService->loadLanguages();

        if ($languages instanceof Traversable) {
            $languages = iterator_to_array($languages);
        }

        return new LanguageList($languages);
    }
}