VITEC-website/packages/vitec/Classes/UserFunc/UsecaseListJsonRenderer.php

<?php

declare(strict_types=1);

namespace Evomedien\Vitec\UserFunc;

use Doctrine\DBAL\ParameterType;
use Evomedien\Vitec\Service\LinkResolver;
use Evomedien\Vitec\Service\UsecaseSerializer;
use TYPO3\CMS\Core\Attribute\AsAllowedCallable;
use TYPO3\CMS\Core\Database\ConnectionPool;
use TYPO3\CMS\Core\Service\FlexFormService;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer;

/**
 * UserFunc: render the Success Story list as JSON (headless).
 *
 * `render()` = top-level plugin / page discovery. `renderForRecord()` = one
 * specific tt_content row (reused by ContainerChildrenProcessor for nested
 * usecase-list plugins). All serialisation is delegated to UsecaseSerializer.
 * Exception-safe.
 *
 * Payload: { "layout": "grid|list|carousel|50-50", "usecases": [ … ] }
 *
 * The editor may pick individual stories in the FlexForm; the arranged order is
 * the display order. No selection means all stories, featured first.
 */
class UsecaseListJsonRenderer
{
    private ?ContentObjectRenderer $cObj = null;

    /**
     * TYPO3 v14 hands the ContentObjectRenderer over through this setter only -
     * ContentObjectRenderer::callUserFunction() duck-types it with
     * is_callable([$classObj, 'setContentObjectRenderer']). Without the method
     * $this->cObj stays null, the cObj branch of render() never fires and the
     * call falls through to page discovery, which picks the FIRST element of
     * this CType on the page rather than the one actually being rendered.
     */
    public function setContentObjectRenderer(ContentObjectRenderer $cObj): void
    {
        $this->cObj = $cObj;
    }

    private const TABLE = 'tx_vitec_domain_model_usecase';

    #[AsAllowedCallable]
    public function render(string $content, array $conf): string
    {
        $row = is_array($this->cObj?->data ?? null) ? $this->cObj->data : null;
        if ($row && (string)($row['CType'] ?? '') === 'vitec_usecaselist') {
            return $this->renderForRecord($row);
        }

        $pageId = 0;
        $request = $GLOBALS['TYPO3_REQUEST'] ?? null;
        if ($request !== null) {
            $pageInfo = $request->getAttribute('frontend.page.information');
            if ($pageInfo !== null) {
                $pageId = (int)$pageInfo->getId();
            }
        }
        if ($pageId <= 0) {
            $pageId = (int)($GLOBALS['TSFE']->id ?? 0);
        }
        if ($pageId <= 0) {
            return '';
        }

        $qb = GeneralUtility::makeInstance(ConnectionPool::class)->getQueryBuilderForTable('tt_content');
        $ces = $qb
            ->select('*')
            ->from('tt_content')
            ->where(
                $qb->expr()->eq('pid', $qb->createNamedParameter($pageId, ParameterType::INTEGER)),
                $qb->expr()->eq('CType', $qb->createNamedParameter('vitec_usecaselist', ParameterType::STRING)),
                $qb->expr()->eq('deleted', 0),
                $qb->expr()->eq('hidden', 0)
            )
            ->executeQuery()
            ->fetchAllAssociative();

        if (empty($ces)) {
            return '';
        }

        return $this->renderForRecord($ces[0]);
    }

    /**
     * @param array<string,mixed> $contentElement
     */
    public function renderForRecord(array $contentElement): string
    {
        try {
            // Detail context: when the request carries a story argument the
            // list stays silent — the usecaseshow plugin on the same page
            // renders the story. Keeps old SEO URLs on one page.
            $request = $GLOBALS['TYPO3_REQUEST'] ?? null;
            $routing = $request?->getAttribute('routing');
            $detailParam = null;
            if ($routing instanceof \TYPO3\CMS\Core\Routing\PageArguments) {
                $detailParam = $routing->getRouteArguments()['tx_vitec_usecaseshow']['usecase'] ?? null;
            }
            if ($detailParam === null || $detailParam === '') {
                $detailParam = ($request?->getQueryParams() ?? [])['tx_vitec_usecaseshow']['usecase'] ?? null;
            }
            if ($detailParam !== null && $detailParam !== '') {
                return '';
            }

            $flexFormService = GeneralUtility::makeInstance(FlexFormService::class);
            $flexFormData = $flexFormService->convertFlexFormContentToArray($contentElement['pi_flexform'] ?? '');
            $settings = $flexFormData['settings'] ?? [];
            $debugMode = (bool)($settings['debug'] ?? false);
            $layout = (string)($settings['layout'] ?? 'grid');
            $selectedUids = GeneralUtility::intExplode(',', (string)($settings['usecases'] ?? ''), true);

            $qb = GeneralUtility::makeInstance(ConnectionPool::class)->getQueryBuilderForTable(self::TABLE);
            $rows = $qb
                ->select('*')
                ->from(self::TABLE)
                ->where(
                    $qb->expr()->eq('deleted', 0),
                    $qb->expr()->eq('hidden', 0),
                    $qb->expr()->eq('hideonwebsite', 0)
                )
                ->orderBy('featured', 'DESC')
                ->addOrderBy('title', 'ASC')
                ->executeQuery()
                ->fetchAllAssociative();

            $serializer = GeneralUtility::makeInstance(UsecaseSerializer::class);

            // Detail links: the PUBLIC URL is the PARENT path of the
            // FlexForm-selected "Single PID" page plus the story slug —
            // /success-stories/<slug>, not /success-stories/story/<slug>.
            // The SuccessStoryPathRewrite middleware maps it back to the
            // detail subpage at request time.
            $singlePid = (int)($settings['singlePid'] ?? 0);
            $detailBase = '';
            if ($singlePid > 0) {
                $detailPath = rtrim($this->resolvePageUrl($singlePid), '/');
                $parent = str_contains($detailPath, '/') ? substr($detailPath, 0, (int)strrpos($detailPath, '/')) : '';
                $detailBase = $parent !== '' ? $parent : $detailPath;
            }

            // Editor-picked stories keep the order they were arranged in. The
            // full (small) table is fetched once and the sequence rebuilt here:
            // a SQL IN() would hand the rows back in storage order, and a story
            // that has meanwhile been hidden simply drops out. Same approach as
            // MarketListJsonRenderer.
            if ($selectedUids !== []) {
                $byUid = [];
                foreach ($rows as $r) {
                    $byUid[(int)$r['uid']] = $r;
                }
                $ordered = [];
                foreach ($selectedUids as $uid) {
                    if (isset($byUid[$uid])) {
                        $ordered[] = $byUid[$uid];
                    }
                }
                $rows = $ordered;
            }

            $usecases = array_map(
                static function (array $u) use ($serializer, $detailBase): array {
                    $item = $serializer->serializeListItem($u);
                    // A story with its own detail page wins; only the others
                    // fall back to the Single PID plus the slug, so nothing
                    // changes for the stories that have no page assigned.
                    if (($item['detailUrl'] ?? null) === null) {
                        $item['detailUrl'] = ($detailBase !== '' && ($item['slug'] ?? '') !== '')
                            ? $detailBase . '/' . ltrim((string)$item['slug'], '/')
                            : null;
                    }
                    return $item;
                },
                $rows
            );

            // Envelope with the layout, matching vitec_marketlist. This changed
            // the payload from a bare array to an object - the front end has to
            // read `usecases.usecases` instead of iterating `usecases` directly.
            $response = [
                'layout' => $layout,
                'showToolbar' => (bool)($settings['showtoolbar'] ?? false),
                'usecases' => $usecases,
            ];

            if ($debugMode) {
                $response['debug'] = [
                    'count' => count($usecases),
                    'selected' => $selectedUids,
                    'settings' => $settings,
                ];
            }

            return (string)json_encode($response);
        } catch (\Throwable $e) {
            return '';
        }
    }

    /**
     * Resolve a page uid to its frontend path (route enhancer aware).
     *
     * Callers here build paths by concatenation, so the empty string stays the
     * "no link" value; LinkResolver's null is coalesced away.
     */
    private function resolvePageUrl(int $pageUid): string
    {
        return LinkResolver::pageUrl($pageUid) ?? '';
    }
}