The PHP SDK

composer require bifrost-orbit/cms-sdk

1CMS_API_URL=https://api.bifrostorbit.com/cms2CMS_PUBLIC_KEY=cms_pk_...        # published content3CMS_PREVIEW_KEY=cms_sk_...       # drafts; staging only4CMS_WEBHOOK_SECRET=...           # verifies publish webhooks5CMS_DEFAULT_REGION=germany       # the region's key, from Configuration › Environments

1use BifrostOrbit\Cms\Client;23$cms = new Client(4    apiKey: getenv('CMS_PUBLIC_KEY'),5    baseUrl: getenv('CMS_API_URL'),6    previewKey: getenv('CMS_PREVIEW_KEY') ?: null,7    defaultRegion: getenv('CMS_DEFAULT_REGION') ?: null,8);

1use BifrostOrbit\Cms\Seo;23$path = parse_url($_SERVER['REQUEST_URI'], PHP_URL_PATH);4$result = $cms->resolve($path, ['referrer' => $_SERVER['HTTP_REFERER'] ?? null]);56switch ($result['kind']) {7    case 'redirect':8        header('Location: ' . $result['to'], true, $result['status']);9        exit;10    case 'gone':11        http_response_code(410);12        exit;13    case 'notFound':14        http_response_code(404);15        exit;16}1718$page = $result['page'];19echo Seo::headTags($page);   // title, description, canonical, robots, hreflang, Open Graph and X card20echo Seo::jsonLd($page);

1$page = $cms->getPage('/products/hiking-boots', ['region' => 'ch', 'locale' => 'fr-CH', 'strict' => true]);2if ($page['meta']['fallbackApplied']) {3    // another language answered4}

1$header = $cms->getNavigation('header');2$footer = $cms->getGlobal('footer', ['region' => 'ch']);3$articles = $cms->list('article', ['sort' => '-publishedAt', 'perPage' => 12]);4$faqs = $cms->list('faqEntry', ['category' => 'pricing', 'include' => ['fields']]);5$products = $cms->list('product', ['filter' => ['activity' => 'hiking']]);

1$page = 1;2do {3    $batch = $cms->list('article', ['page' => $page++, 'perPage' => 100]);4    foreach ($batch['items'] as $item) {5        // ...6    }7} while ($batch['hasMore']);

1function renderBlock(array $block): string2{3    $f = $block['fields'];4    $e = fn ($value) => htmlspecialchars((string) $value, ENT_QUOTES);56    switch ($block['type']) {7        case 'hero':8            return '<section data-cms-id="' . $e($block['id']) . '">'9                . '<h1>' . $e($f['heading'] ?? '') . '</h1>'10                . ($f['description'] ?? '')11                . (isset($f['button']) ? renderBlock($f['button']) : '')12                . '</section>';13        case 'button':14            return '<a href="' . $e($f['link']['href'] ?? '#') . '">' . $e($f['label'] ?? '') . '</a>';15        default:16            return '';17    }18}1920echo implode('', array_map('renderBlock', $page['components']));

1use BifrostOrbit\Cms\BlockRenderer;23$blocks = new BlockRenderer([4    'hero' => fn (array $block) => view('blocks.hero', ['block' => $block]),5    'cardGrid' => fn (array $block, BlockRenderer $blocks) => '<div class="grid">' . $blocks->slot($block, 'cards') . '</div>',6]);78echo $blocks->render($page['components']);

npx --package @bifrost-orbit-cms/sdk cms-orbit generate --lang php --out src/Cms/Types.php --namespace "App\\Cms"

1use BifrostOrbit\Cms\Insights;23echo Insights::tags($page);4// or with your own key and a first-party address:5echo Insights::tags($page, ['site' => getenv('INSIGHTS_SITE'), 'src' => '/stats/script.js', 'api' => '/stats/collect']);

1use BifrostOrbit\Cms\Preview;23$token = $cms->verifyPreviewToken($_GET['preview'] ?? $_GET['token'] ?? '');4if ($token === null) {5    http_response_code(401);6    exit('That preview link is invalid or has expired');7}8setcookie('cms_preview', '1', ['httponly' => true, 'secure' => true, 'samesite' => 'None', 'path' => '/']);9header('Location: ' . Preview::redirectPath($_GET['path'] ?? null, $token));

$preview = isset($_COOKIE['cms_preview']);$result = $cms->resolve($path, ['preview' => $preview]);echo $preview ? Preview::bridgeScript($cms) : '';

1use BifrostOrbit\Cms\Webhook;23$message = Webhook::parse(getenv('CMS_WEBHOOK_SECRET'), getallheaders(), file_get_contents('php://input'));4if ($message === null) {5    http_response_code(401);6    exit;7}8$tags = Webhook::tagsForEvent($message['event'], $message['data']);9// clear the cache entries with these tags10http_response_code(204);

1header('Content-Type: application/xml; charset=utf-8');2echo Seo::sitemapXml($cms->getSitemap(['region' => 'germany']));3// or, for the index of every region:4echo Seo::sitemapIndexXml($cms->getSitemapIndex());

1use BifrostOrbit\Cms\Exception\NotFoundException;2use BifrostOrbit\Cms\Exception\RateLimitException;3use BifrostOrbit\Cms\Exception\UnavailableException;45try {6    $footer = $cms->getGlobal('footer');7} catch (NotFoundException) {8    $footer = null;9} catch (RateLimitException $error) {10    header('Retry-After: ' . $error->retryAfter);11    http_response_code(503);12    exit;13} catch (UnavailableException) {14    $footer = $lastKnownFooter;15}

1// app/Providers/AppServiceProvider.php2use BifrostOrbit\Cms\Client;34public function register(): void5{6    $this->app->singleton(Client::class, fn () => new Client(7        apiKey: config('services.cms.key'),8        baseUrl: config('services.cms.url'),9        previewKey: config('services.cms.preview_key'),10        defaultRegion: config('services.cms.region'),11    ));12}

1// app/Http/Controllers/PageController.php2public function show(Client $cms, ?string $path = null)3{4    $result = Cache::remember('cms:page:/' . $path, 60, fn () => $cms->resolve('/' . $path));56    return match ($result['kind']) {7        'redirect' => redirect($result['to'], $result['status']),8        'gone' => abort(410),9        'notFound' => abort(404),10        'page' => view('page', ['page' => $result['page']]),11    };12}

1# config/services.yaml2services:3    BifrostOrbit\Cms\Client:4        arguments:5            $apiKey: '%env(CMS_PUBLIC_KEY)%'6            $baseUrl: '%env(CMS_API_URL)%'7            $previewKey: '%env(default::CMS_PREVIEW_KEY)%'8            $defaultRegion: '%env(default::CMS_DEFAULT_REGION)%'

1#[Route('/{path}', requirements: ['path' => '.*'], priority: -100)]2public function show(Client $cms, string $path = ''): Response3{4    $result = $cms->resolve('/' . $path);56    return match ($result['kind']) {7        'redirect' => new RedirectResponse($result['to'], $result['status']),8        'gone' => new Response('', 410),9        'notFound' => throw new NotFoundHttpException(),10        'page' => $this->render('page.html.twig', ['page' => $result['page']]),11    };12}

1use BifrostOrbit\Cms\Testing\FakeTransport;23$transport = (new FakeTransport())->json(['data' => ['key' => 'main', 'name' => 'Main menu', 'items' => []]]);4$cms = new Client(apiKey: 'cms_pk_test', httpClient: $transport);