PlatformRequest.php

<?php declare(strict_types=1);

namespace Shopware\Core;

use Shopware\Core\Framework\Log\Package;

#[Package('framework')]
final class PlatformRequest
{
    /**
     * Response Headers
     */
    public const HEADER_FRAME_OPTIONS = 'x-frame-options';

    /**
     * Context headers
     */
    public const HEADER_CONTEXT_TOKEN = 'sw-context-token';
    public const HEADER_CONTEXT_SOURCE = 'sw-context-source';
    public const HEADER_ACCESS_KEY = 'sw-access-key';
    public const HEADER_LANGUAGE_ID = 'sw-language-id';
    public const HEADER_CURRENCY_ID = 'sw-currency-id';
    public const HEADER_INHERITANCE = 'sw-inheritance';
    public const HEADER_VERSION_ID = 'sw-version-id';
    public const HEADER_INCLUDE_SEO_URLS = 'sw-include-seo-urls';
    public const HEADER_INCLUDE_SEARCH_INFO = 'sw-include-search-info';
    public const HEADER_SKIP_TRIGGER_FLOW = 'sw-skip-trigger-flow';
    public const HEADER_APP_INTEGRATION_ID = 'sw-app-integration-id';
    public const HEADER_APP_USER_ID = 'sw-app-user-id';
    public const HEADER_INDEXING_BEHAVIOR = 'indexing-behavior';
    public const HEADER_INDEXING_SKIP = 'indexing-skip';
    public const HEADER_INDEXING_ONLY = 'indexing-only';
    public const HEADER_FORCE_CACHE_INVALIDATE = 'sw-force-cache-invalidate';

    public const HEADER_MEASUREMENT_WEIGHT_UNIT = 'sw-measurement-weight-unit';

    public const HEADER_MEASUREMENT_LENGTH_UNIT = 'sw-measurement-length-unit';

    /**
     * MCP Streamable HTTP transport headers (Model Context Protocol)
     */
    public const HEADER_MCP_SESSION_ID = 'mcp-session-id';
    public const HEADER_MCP_PROTOCOL_VERSION = 'mcp-protocol-version';

    /**
     * API Expectation headers to check requirements are fulfilled
     */
    public const HEADER_EXPECT_PACKAGES = 'sw-expect-packages';

    /**
     * Context hash header used for cache differentiation on user-independent routes
     *
     * The hash is used to differentiate cache entries for the same route when the context
     * changes (e.g., different language, currency, or rules). This ensures that
     * user-independent routes like product listings, category pages, and search results
     * are properly cached per context variation while maintaining cache efficiency.
     *
     * The header is automatically added to Store API responses and included in the Vary
     * header together with HEADER_LANGUAGE_ID and HEADER_CURRENCY_ID to ensure proper
     * cache separation by reverse proxies and CDNs.
     *
     * Header has to be included in every request to ensure cache hits.
     *
     * @deprecated tag:v6.8.0 - Will be removed, use HttpCacheKeyGenerator::CONTEXT_CACHE_COOKIE instead
     */
    public const HEADER_CONTEXT_HASH = 'sw-context-hash';

    /**
     * Context attributes
     */
    public const ATTRIBUTE_CONTEXT_OBJECT = 'sw-context';
    public const ATTRIBUTE_SALES_CHANNEL_CONTEXT_OBJECT = 'sw-sales-channel-context';
    public const ATTRIBUTE_SALES_CHANNEL_ID = 'sw-sales-channel-id';
    public const ATTRIBUTE_IMITATING_USER_ID = 'sw-imitating-user-id';
    public const ATTRIBUTE_CRITERIA = 'sw-criteria';

    /**
     * Order-based state of a route that opted in with {@see self::ATTRIBUTE_ALLOW_ORDER_RESTORATION}.
     * The value resolvers inject it for that route, the canonical context attributes above stay the session state.
     */
    public const ATTRIBUTE_EFFECTIVE_CONTEXT_OBJECT = 'sw-effective-context';
    public const ATTRIBUTE_EFFECTIVE_SALES_CHANNEL_CONTEXT_OBJECT = 'sw-effective-sales-channel-context';
    public const ATTRIBUTE_EFFECTIVE_CART_OBJECT = 'sw-effective-cart';

    public const ATTRIBUTE_ACL = '_acl';
    public const ATTRIBUTE_CAPTCHA = '_captcha';
    public const ATTRIBUTE_ROUTE_SCOPE = '_routeScope';
    public const ATTRIBUTE_ENTITY = '_entity';
    public const ATTRIBUTE_OPENAPI = '_openapi';
    public const ATTRIBUTE_NO_STORE = '_noStore';
    public const ATTRIBUTE_HTTP_CACHE = '_httpCache';
    public const ATTRIBUTE_CONTEXT_TOKEN_REQUIRED = '_contextTokenRequired';
    public const ATTRIBUTE_LOGIN_REQUIRED = '_loginRequired';
    public const ATTRIBUTE_LOGIN_REQUIRED_ALLOW_GUEST = '_loginRequiredAllowGuest';
    public const ATTRIBUTE_IS_ALLOWED_IN_MAINTENANCE = 'allow_maintenance';

    public const ATTRIBUTE_CLEAR_SITE_DATA = '_clearSiteData';

    /**
     * Opts a read-only Store API route in to being evaluated against an existing order, given as `orderId`
     */
    public const ATTRIBUTE_ALLOW_ORDER_RESTORATION = '_allowOrderRestoration';

    public const ATTRIBUTE_INTERNAL_ROUTE_PARAMS = [
        self::ATTRIBUTE_CAPTCHA,
        self::ATTRIBUTE_ROUTE_SCOPE,
        self::ATTRIBUTE_ENTITY,
        self::ATTRIBUTE_NO_STORE,
        self::ATTRIBUTE_HTTP_CACHE,
        self::ATTRIBUTE_CONTEXT_TOKEN_REQUIRED,
        self::ATTRIBUTE_LOGIN_REQUIRED,
        self::ATTRIBUTE_LOGIN_REQUIRED_ALLOW_GUEST,
        self::ATTRIBUTE_IS_ALLOWED_IN_MAINTENANCE,
        self::ATTRIBUTE_ALLOW_ORDER_RESTORATION,
    ];

    /**
     * CSP
     */
    public const ATTRIBUTE_CSP_NONCE = '_cspNonce';

    /**
     * OAuth attributes
     */
    public const ATTRIBUTE_OAUTH_ACCESS_TOKEN_ID = 'oauth_access_token_id';
    public const ATTRIBUTE_OAUTH_CLIENT_ID = 'oauth_client_id';
    public const ATTRIBUTE_OAUTH_USER_ID = 'oauth_user_id';
    public const ATTRIBUTE_OAUTH_SCOPES = 'oauth_scopes';
    public const ATTRIBUTE_OAUTH_PRE_AUTHENTICATED = 'oauth_pre_authenticated';

    public const FALLBACK_SESSION_NAME = 'session-';

    private function __construct()
    {
    }
}