Pimcore Demo

https://github.com/pimcore/demo
Admin
Pimcore Demo is a blueprint application for newcomers to learn and explore Pimcore's CMS, DAM, PIM,...
Tokens:72,283
Snippets:635
Trust Score:9.9
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install Pimcore demo with Composer

Source: https://github.com/pimcore/demo/blob/2025.x/README.md

Use this command sequence to create a new Pimcore demo project, install assets, run the installer, and clear the cache. Requires Composer and a PHP environment.

```bash
COMPOSER_MEMORY_LIMIT=-1 composer create-project --no-scripts pimcore/demo my-project
cd ./my-project
./bin/console assets:install --symlink --relative
./vendor/bin/pimcore-install
./bin/console cache:clear
```

--------------------------------

### bundleSetup method signature

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/api-reference/event-listeners.md

Public method signature for bundleSetup, which handles the bundle setup event. It calls clearBundlesAndRecommendations to skip the bundle installation question during install.

```php
public function bundleSetup(BundleSetupEvent $event): void
```

--------------------------------

### Start Docker services

Source: https://github.com/pimcore/demo/blob/2025.x/README.md

Start the required services defined in the docker-compose.yaml file.

```bash
docker compose up -d
```

--------------------------------

### Install assets via Docker

Source: https://github.com/pimcore/demo/blob/2025.x/README.md

Install the assets by running this script inside the PHP container.

```bash
docker compose exec php bin/console assets:install --symlink --relative
```

--------------------------------

### Install Pimcore and initialize DB via Docker

Source: https://github.com/pimcore/demo/blob/2025.x/README.md

Run the Pimcore installer with MySQL connection parameters. You will be prompted for an admin user and password. This can take up to 20 minutes.

```bash
docker compose exec php vendor/bin/pimcore-install --mysql-host-socket=db --mysql-username=pimcore --mysql-password=pimcore --mysql-database=pimcore
```

--------------------------------

### Usage example for getParentCategoryList

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/api-reference/models.md

Usage example showing how to get the parent category chain and build a URL path. Uses the root category property from the document.

```php
$chain = $category->getParentCategoryList(
    $this->document->getProperty(AbstractProductLinkGenerator::ROOT_CATEGORY_PROPERTY_NAME)
);
$path = implode('/', array_map($chain, fn ($c) => Text::toUrl($c->getName())));
```

--------------------------------

### LoginActivity usage example

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/api-reference/models.md

Example of tracking a LoginActivity using the activity manager, as used in AuthenticationLoginListener::doEcommerceFrameworkLogin.

```php
$this->activityManager->trackActivity(new LoginActivity($customer));
```

--------------------------------

### Usage example for BaseController subclass

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/api-reference/controllers.md

Example of a subclass using getAllParameters and verifyPreviewRequest to handle a request and render a template.

```php
class MyController extends BaseController
{
    public function myAction(Request $request): Response
    {
        $params = $this->getAllParameters($request);   // body + query merged
        if ($this->verifyPreviewRequest($request, $someObject)) {
            // admin preview allowed
        }
        return $this->render('my/template.html.twig', $params);
    }
}
```

--------------------------------

### OrderActivity usage example

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/api-reference/models.md

Example of tracking an OrderActivity using the activity manager, as used in CheckoutEventListener::postCommitOrder.

```php
$this->activityManager->trackActivity(new OrderActivity($order->getCustomer(), $order));
```

--------------------------------

### Usage example for doEcommerceFrameworkLogin

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/api-reference/event-listeners.md

Shows how to call doEcommerceFrameworkLogin directly, as done by AccountController::registerAction.

```php
$authenticationLoginListener->doEcommerceFrameworkLogin($customer);
```

--------------------------------

### Usage Example: handleDoubleOptInConfirmation

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/api-reference/services.md

Example of using handleDoubleOptInConfirmation in a controller action, redirecting on success or throwing NotFoundHttpException on invalid token.

```php
$customer = $newsletterDoubleOptInService->handleDoubleOptInConfirmation($request->query->getString('token'));
if ($customer) {
    return $this->redirectToRoute('account-index');
}
throw new NotFoundHttpException('Invalid token');
```

--------------------------------

### AbstractProduct usage example

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/api-reference/models.md

Shows how to retrieve a product by ID and access its price system name if it is an AbstractProduct with a price set.

```php
$product = AbstractProduct::getById($id);          // static helpers from generated class
if ($product instanceof AbstractProduct && $product->getPrice()) {
    echo $product->getPriceSystemName();           // "default"
}
```

--------------------------------

### Car usage example from ProductController::detailAction

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/api-reference/models.md

Shows how to check if a product is an actual car and track impressions for its accessories.

```php
if ($product instanceof Car && $product->getObjectType() === Car::OBJECT_TYPE_ACTUAL_CAR) {
    foreach ($product->getAccessories() as $accessory) {
        $trackingManager->trackProductImpression($accessory, 'crosssells');
    }
}
```

--------------------------------

### Registration form usage example

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/api-reference/forms.md

Shows how to create and handle the registration form with hidePassword option.

```php
$form = $this->createForm(RegistrationFormType::class, $formData, ['hidePassword' => false]);
$form->handleRequest($request);
if ($form->isSubmitted() && $form->isValid()) {
    $registrationFormHandler->updateCustomerFromForm($customer, $form);
    // ...
}
```

--------------------------------

### NewsLinkGenerator usage example

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/api-reference/link-generators.md

Example of generating a news link with document and locale parameters, producing a URL like /de/News/demo-news~n123.

```php
$link = $newsLinkGenerator->generate($news, [
    'document' => Document::getByPath('/en/News'),
    'locale'   => 'de'
]);
// -> /de/News/demo-news~n123 (route news-detail)
```

--------------------------------

### GET /{_locale}/checkout-start-payment

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/endpoints.md

Initializes the order payment with the payment provider and returns the provider's response as JSON.

```APIDOC
## GET /{_locale}/checkout-start-payment

### Description
Initializes the order payment with the payment provider and returns the provider's response as JSON.

### Method
GET

### Endpoint
/{_locale}/checkout-start-payment

### Parameters
#### Path Parameters
- **_locale** (string) - Required - The locale for the request (e.g., en, de).

### Response
#### Success Response (200)
Returns the payment provider's JSON response verbatim.

#### Response Example
{
  "provider": "response"
}

```

--------------------------------

### Usage example with error handling

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/api-reference/services.md

Example of calling sendRecoveryMail with try-catch to handle mail errors. Used by AccountController::sendPasswordRecoveryMailAction.

```php
try {
    $service->sendRecoveryMail($request->query->getString('email', ''), $this->document->getProperty('password_reset_mail'));
    $this->addFlash('success', $translator->trans('account.reset-mail-sent-when-possible'));
} catch (\Exception $e) {
    $this->addFlash('danger', $e->getMessage());   // mail errors surface here
}
```

--------------------------------

### Twig usage of app_product_detaillink and colorname

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/api-reference/twig-extensions.md

Example Twig template using the app_product_detaillink function and colorname filter.

```twig
<a href="{{ app_product_detaillink(product) }}">{{ product.osName }}</a>
<span>{{ product.color|colorname }}</span>
```

--------------------------------

### Usage example: accessing the cart programmatically

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/api-reference/controllers.md

Shows how to retrieve the cart by its canonical name and add an item if conditions are met.

```php
// the constant is the canonical cart name used across the demo
$manager = $this->factory->getCartManager();
$cart = $manager->getOrCreateCartByName(CartController::DEFAULT_CART_NAME);
if (!$cart->isEmpty() && $cart->getItemCount() <= 99) {
    $cart->addItem($product, 1);
    $cart->save();
}
```

--------------------------------

### Text::toUrl usage example

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/api-reference/link-generators.md

Example usage of Text::toUrl and Text::cutStringRespectingWhitespace. The toUrl call matches route requirements [\w-]+.

```php
Text::toUrl('Österreichische Autos & Lawinen') // matches route requirements [\w-]+
Text::cutStringRespectingWhitespace("A very long title ...", 12)
```

--------------------------------

### GET /{_locale}/shop/{path}{productname}~p{product}

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/endpoints.md

Fetches and renders the detail page for a specific product. Redirects to the canonical URL if needed and tracks product views and impressions.

```APIDOC
## GET /{_locale}/shop/{path}{productname}~p{product}

### Description
Fetches and renders the detail page for a specific product. Redirects to the canonical URL if needed and tracks product views and impressions.

### Method
GET

### Endpoint
/{_locale}/shop/{path}{productname}~p{product}

### Parameters
#### Path Parameters
- **path** (string) - Optional - URL path segment before the `~` (regex `.*?`, default `''`)
- **productname** (string) - Required - URL slug (regex `[\w-]+`)
- **product** (int) - Required - Object id (regex `\d+`)

### Response
#### Success Response (200)
- Renders `product/detail.html.twig` (Car) or `product/detail_accessory.html.twig` (AccessoryPart)
- Redirects (301) to canonical URL if the generated URL differs from the request path

#### Error Response
- **404 Not Found** - `NotFoundHttpException('Product not found.')` for unpublished products (without preview rights), non-Car/non-AccessoryPart objects, or when `product` is null
- **404 Not Found** - `NotFoundHttpException('Unsupported Product type.')` for any other product type
```

--------------------------------

### Twig usage example for PrintCatalogExtension

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/api-reference/twig-extensions.md

Example Twig template using the registered functions to create a register, output its name, and render a spec value.

```twig
{{ app_print_create_register('Engine', 'engine') }}
<span class="page {{ app_print_get_register_name('Engine') }}">…</span>
{{ app_print_output_spec_value(outputElement, 'print_thumbnail') }}
```

--------------------------------

### GET|POST /{_locale}/account/register

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/endpoints.md

Handles user registration. Accepts GET to display the registration form and POST to create a new customer account. On success, logs the user in and redirects to the account index.

```APIDOC
## GET|POST /{_locale}/account/register

### Description
Handles user registration. Accepts GET to display the registration form and POST to create a new customer account. On success, logs the user in and redirects to the account index.

### Method
GET|POST

### Endpoint
/{_locale}/account/register

### Parameters
#### Path Parameters
- **_locale** (string) - Required - Locale code (e.g., en, de)

#### Request Body (POST)
- **email** (string) - Required - Customer email address
- **firstname** (string) - Required - Customer first name
- **lastname** (string) - Required - Customer last name
- **password** (string) - Optional - Customer password (hidden when option hidePassword is set)
- **newsletter** (boolean) - Optional - Consent to newsletter (checkbox)
- **profiling** (boolean) - Optional - Consent to profiling (checkbox)
- **oAuthKey** (string) - Optional - OAuth key (hidden)
- **_submit** (string) - Optional - Submit button value

### Request Example
{
  "email": "user@example.com",
  "firstname": "John",
  "lastname": "Doe",
  "password": "secret",
  "newsletter": true,
  "profiling": false,
  "oAuthKey": "",
  "_submit": "Register"
}

### Response
#### Success Response (200)
- Redirects to account index on success.

#### Response Example
Redirect to /{_locale}/account/index
```

--------------------------------

### Routing configuration in config/routes.yaml

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/endpoints.md

Defines the routing setup for the demo, including the Pimcore core routes, localized and non-localized controller routes, and the logout route. The routes are registered with prefixes for English and German locales.

```yaml
_pimcore:
    resource: "@PimcoreCoreBundle/config/routing.yaml"
app_localized:
    resource: "../src/Controller/"
    type:     attribute
    prefix:
        en: /en
        de: /de
app:
    resource: "../src/Controller/"
    type:     attribute
account-logout:
    path: '{_locale}/account/logout'
```

--------------------------------

### GET|POST /{_locale}/account/login

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/endpoints.md

Handles user login. Accepts GET to display the login form and POST to authenticate. On success, redirects to the account index or target path.

```APIDOC
## GET|POST /{_locale}/account/login

### Description
Handles user login. Accepts GET to display the login form and POST to authenticate. On success, redirects to the account index or target path.

### Method
GET|POST

### Endpoint
/{_locale}/account/login

### Parameters
#### Path Parameters
- **_locale** (string) - Required - Locale code (e.g., en, de)

#### Request Body (POST)
- **_username** (string) - Required - User email address
- **_password** (string) - Required - User password
- **_target_path** (string) - Optional - Path to redirect after login
- **_submit** (string) - Optional - Submit button value

### Request Example
{
  "_username": "user@example.com",
  "_password": "secret",
  "_target_path": "/account",
  "_submit": "Login"
}

### Response
#### Success Response (200)
- Redirects to account index or target path on success.

#### Response Example
Redirect to /{_locale}/account/index
```

--------------------------------

### JavaScript fetch to start payment

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/api-reference/controllers.md

Calls the '/en/checkout-start-payment' endpoint and processes the JSON response. The response contains the raw PayPal Smart Payment Button JSON string.

```javascript
// template payment/checkout_payment.html.twig (JavaScript)
fetch('/en/checkout-start-payment')
    .then(r => r.json())
    .then(paymentData => {
        // paymentData is the raw PayPal Smart Payment Button JSON string
    });
```

--------------------------------

### NewsLinkGenerator error handling example

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/api-reference/link-generators.md

Example of catching InvalidArgumentException when generating a news link fails, logging the error message.

```php
// error handling
try {
    return $newsLinkGenerator->generate($object);
} catch (\InvalidArgumentException $e) {
    logError("No valid news link derivable: " . $e->getMessage());
}
```

--------------------------------

### BreadcrumbHelperService usage example

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/api-reference/services.md

Example of injecting BreadcrumbHelperService via method injection and using enrichGenericDynamicPage to add a breadcrumb for a search result page. The method is called with a translated label, then a template is rendered.

```php
// inject App\Website\Navigation\BreadcrumbHelperService via method injection
public function myAction(BreadcrumbHelperService $breadcrumbs): Response
{
    $breadcrumbs->enrichGenericDynamicPage($this->translator->trans('shop.search-result', [$term]));
    return $this->render('my/template.html.twig');
}
```

--------------------------------

### LoginFormType usage example in AccountController

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/api-reference/forms.md

Shows how to create the login form in AccountController::loginAction, passing the last username and setting the action URL. The form view is then rendered in the login template.

```php
$form = $this->createForm(LoginFormType::class, [
    '_username' => $authenticationUtils->getLastUsername(),
], [
    'action' => $this->generateUrl('account-login'),
]);
return $this->render('account/login.html.twig', ['form' => $form->createView(), ...]);

```

--------------------------------

### GET /{_locale}/shop/{path}{categoryname}~c{category}

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/endpoints.md

Renders a category listing or product grid with optional pagination and filtering. Supports a no-layout mode for AJAX requests.

```APIDOC
## GET /{_locale}/shop/{path}{categoryname}~c{category}

### Description
Renders a category listing or product grid with optional pagination and filtering. Supports a no-layout mode for AJAX requests.

### Method
GET

### Endpoint
/{_locale}/shop/{path}{categoryname}~c{category}

### Parameters
#### Path Parameters
- **path** (string) - Optional - URL path segment (regex `.*?`, default `''`)
- **categoryname** (string) - Required - Category slug (regex `[\w-]+`)
- **category** (int) - Required - Category object id

#### Query Parameters
- **page** (int) - Optional - Page number, default `1`
- **filterdefinition** (FilterDefinition) - Optional - Filter definition object parameter
- **filter params** (mixed) - Optional - Additional filter parameters from the category's `FilterDefinition` (via `ListHelper::setupProductList`)

### Response
#### Success Response (200)
- Renders `product/listing.html.twig` (or `product/listing_content.html.twig` when `noLayout` request attribute is set)
- Sets page title, breadcrumbs, tracks segments and category page view
- Falls back to `Config::getWebsiteConfig()['fallbackFilterdefinition']` when no filter definition exists
```

--------------------------------

### GET|POST /{_locale}/checkout-payment

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/endpoints.md

Displays the payment step. GET renders the payment page with the cart and payment SDK URL. POST is not explicitly documented but the route accepts both methods.

```APIDOC
## GET|POST /{_locale}/checkout-payment

### Description
Displays the payment step. GET renders the payment page with the cart and payment SDK URL. POST is not explicitly documented but the route accepts both methods.

### Method
GET, POST

### Endpoint
/{_locale}/checkout-payment

### Parameters
#### Path Parameters
- **_locale** (string) - Required - The locale for the request (e.g., en, de).

### Response
#### Success Response (200)
Renders the payment page.

#### Redirect (302)
If the cart is empty, redirects to the cart detail page.

```

--------------------------------

### Subclassing AbstractAreabrick to add a new brick

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/api-reference/areabricks.md

Example of creating a new brick by extending AbstractAreabrick and overriding getName(). The template lives at templates/areas/my-brick.html.twig.

```php
namespace App\Document\Areabrick;

class MyBrick extends AbstractAreabrick
{
    public function getName(): string
    {
        return 'My Brick';
    }
}
// template lives at: templates/areas/my-brick.html.twig
```

--------------------------------

### PasswordMaxLengthTrait usage and error handling example

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/api-reference/forms.md

Shows how to use checkPassword in AccountController::registerAction, catching ValidationException to collect error messages. The commented line shows an alternative call for resetPasswordAction.

```php
try {
    $this->checkPassword($form->getData()['password']);
    // $this->checkPassword($newPassword);   // resetPasswordAction
} catch (ValidationException $e) {
    $errors[] = $e->getMessage();   // "Given password is too long."
}
```

--------------------------------

### GET|POST /{_locale}/account/reset-password?token={token}

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/endpoints.md

Resets the user's password using a token. Accepts GET to display the reset form and POST to set the new password. Public endpoint.

```APIDOC
## GET|POST /{_locale}/account/reset-password?token={token}

### Description
Resets the user's password using a token. Accepts GET to display the reset form and POST to set the new password. Public endpoint.

### Method
GET|POST

### Endpoint
/{_locale}/account/reset-password?token={token}

### Parameters
#### Path Parameters
- **_locale** (string) - Required - Locale code (e.g., en, de)

#### Query Parameters
- **token** (string) - Required - Password reset token

#### Request Body (POST)
- **password** (string) - Required - New password

### Request Example
{
  "password": "newpassword"
}

### Response
#### Success Response (200)
- Sets flash message and redirects to login page.

#### Error Response (404)
- Invalid token returns flash message.

#### Response Example
Redirect to /{_locale}/account/login?no-referer-redirect=1
```

--------------------------------

### GET|POST /{_locale}/account/send-password-recovery?email={email}

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/endpoints.md

Sends a password recovery email. Accepts GET to display the form and POST to send the email. Public endpoint.

```APIDOC
## GET|POST /{_locale}/account/send-password-recovery?email={email}

### Description
Sends a password recovery email. Accepts GET to display the form and POST to send the email. Public endpoint.

### Method
GET|POST

### Endpoint
/{_locale}/account/send-password-recovery?email={email}

### Parameters
#### Path Parameters
- **_locale** (string) - Required - Locale code (e.g., en, de)

#### Query Parameters
- **email** (string) - Optional - Email address to send recovery link to

### Response
#### Success Response (200)
- Sets flash message and redirects to login page.

#### Response Example
Redirect to /{_locale}/account/login?no-referer-redirect=1
```

--------------------------------

### GET|POST /{_locale}/checkout-address

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/endpoints.md

Handles the delivery address step of the checkout. GET renders the address form pre-filled with the logged-in customer's data; POST submits the form and advances to the payment step on success.

```APIDOC
## GET|POST /{_locale}/checkout-address

### Description
Handles the delivery address step of the checkout. GET renders the address form pre-filled with the logged-in customer's data; POST submits the form and advances to the payment step on success.

### Method
GET, POST

### Endpoint
/{_locale}/checkout-address

### Parameters
#### Path Parameters
- **_locale** (string) - Required - The locale for the request (e.g., en, de).

#### Request Body (POST)
- **deliveryAddress** (object) - Required - The delivery address form data.
  - **email** (string) - Required - Customer email.
  - **firstname** (string) - Required - Customer first name.
  - **lastname** (string) - Required - Customer last name.
  - **street** (string) - Required - Street address.
  - **zip** (string) - Required - ZIP code.
  - **city** (string) - Required - City.
  - **countryCode** (string) - Required - ISO country code.

### Request Example
{
  "deliveryAddress": {
    "email": "customer@example.com",
    "firstname": "John",
    "lastname": "Doe",
    "street": "Main St 1",
    "zip": "12345",
    "city": "Springfield",
    "countryCode": "US"
  }
}

### Response
#### Success Response (302)
Redirects to the payment step.

#### Error Response (200)
Re-renders the form with errors.

```

--------------------------------

### Initialize demo project with Docker

Source: https://github.com/pimcore/demo/blob/2025.x/README.md

Run this command to create a new Pimcore demo project using the pimcore/pimcore Docker image. Your user must be allowed to run Docker commands.

```bash
docker run -u `id -u`:`id -g` --rm -v `pwd`:/var/www/html pimcore/pimcore:php8.3-latest composer create-project --no-scripts pimcore/demo my-project
```

--------------------------------

### Change to project directory

Source: https://github.com/pimcore/demo/blob/2025.x/README.md

Navigate into the newly created project directory.

```bash
cd my-project/
```

--------------------------------

### prepare method for ProductInterestSegmentBuilder

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/api-reference/ecommerce.md

No-op implementation of the prepare method. Does nothing in this builder.

```php
public function prepare(SegmentManagerInterface $segmentManager): void
```

--------------------------------

### GET /{_locale}/checkout-completed

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/endpoints.md

Displays the order completion page after a successful checkout.

```APIDOC
## GET /{_locale}/checkout-completed

### Description
Displays the order completion page after a successful checkout.

### Method
GET

### Endpoint
/{_locale}/checkout-completed

### Parameters
#### Path Parameters
- **_locale** (string) - Required - The locale for the request (e.g., en, de).

### Response
#### Success Response (200)
Renders the order completion page.

```

--------------------------------

### AuthenticationLoginListener constructor

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/api-reference/event-listeners.md

Constructor injecting EnvironmentInterface, ActivityManagerInterface, and Factory. All parameters are required.

```php
public function __construct(
    protected EnvironmentInterface $environment,
    protected ActivityManagerInterface $activityManager,
    protected Factory $factory)
```

--------------------------------

### GET /{_locale}/account/logout

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/endpoints.md

Logs out the current user. Handled by the firewall, not a controller action.

```APIDOC
## GET /{_locale}/account/logout

### Description
Logs out the current user. Handled by the firewall, not a controller action.

### Method
GET

### Endpoint
/{_locale}/account/logout

### Parameters
#### Path Parameters
- **_locale** (string) - Required - Locale code (e.g., en, de)

### Response
#### Success Response (200)
- Redirects to login page or home.

#### Response Example
Redirect to /{_locale}/account/login
```

--------------------------------

### Constructor with dependencies

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/api-reference/event-listeners.md

Constructor injecting the ecommerce factory, activity manager, and locale service.

```php
public function __construct(
    protected Factory $ecommerceFactory,
    protected ActivityManagerInterface $activityManager,
    protected LocaleServiceInterface $localeService
)
```

--------------------------------

### GET /{_locale}/payment-error

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/endpoints.md

Displays a payment error message and redirects back to the payment step.

```APIDOC
## GET /{_locale}/payment-error

### Description
Displays a payment error message and redirects back to the payment step.

### Method
GET

### Endpoint
/{_locale}/payment-error

### Parameters
#### Path Parameters
- **_locale** (string) - Required - The locale for the request (e.g., en, de).

### Response
#### Redirect (302)
Redirects to the payment step with an error flash message.

```

--------------------------------

### GET /{_locale}/account/confirm-newsletter?token={token}

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/endpoints.md

Confirms newsletter subscription using a token. Public endpoint.

```APIDOC
## GET /{_locale}/account/confirm-newsletter?token={token}

### Description
Confirms newsletter subscription using a token. Public endpoint.

### Method
GET

### Endpoint
/{_locale}/account/confirm-newsletter?token={token}

### Parameters
#### Path Parameters
- **_locale** (string) - Required - Locale code (e.g., en, de)

#### Query Parameters
- **token** (string) - Required - Confirmation token

### Response
#### Success Response (200)
- Sets success flash and redirects to account index.

#### Error Response (404)
- Invalid token returns NotFoundHttpException.

#### Response Example
Redirect to /{_locale}/account/index
```

--------------------------------

### Run app:asset-copyright command

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/api-reference/console-and-kernel.md

Runs the console command to backfill asset copyright metadata. The output shows progress messages for each processed asset.

```bash
./bin/console app:asset-copyright
# Processing asset 219... updating asset copyright ...done
```

--------------------------------

### Constructor: NewsletterDoubleOptInService::__construct

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/api-reference/services.md

Constructor injecting UrlGeneratorInterface and CustomerProviderInterface dependencies.

```php
public function __construct(
    protected UrlGeneratorInterface $urlGenerator,
    protected CustomerProviderInterface $customerProvider
)
```

--------------------------------

### Twig usage for language switcher

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/api-reference/twig-extensions.md

Example Twig template for rendering a language switcher using the get_localized_links function.

```twig
<ul class="language-switcher">
    {% for locale, entry in get_localized_links(document) %}
        <li><a href="{{ entry.link }}" title="{{ entry.text }}">{{ entry.text }}</a></li>
    {% endfor %}
</ul>
```

--------------------------------

### GET /{_locale}/account/index

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/endpoints.md

Displays the account index page with a list of orders for the current user. Requires authentication.

```APIDOC
## GET /{_locale}/account/index

### Description
Displays the account index page with a list of orders for the current user. Requires authentication.

### Method
GET

### Endpoint
/{_locale}/account/index

### Parameters
#### Path Parameters
- **_locale** (string) - Required - Locale code (e.g., en, de)

### Response
#### Success Response (200)
- Renders account/index.html.twig with order list.

#### Response Example
HTML page with order list
```

--------------------------------

### Twig usage of currency filter

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/api-reference/twig-extensions.md

Example of using the 'currency' filter in a Twig template to format a product price in EUR.

```twig
{{ product.price|currency('EUR') }}
```

--------------------------------

### NavigationExtension::__construct

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/api-reference/twig-extensions.md

Constructor for NavigationExtension, injecting navigation helper, placeholder helper, and category link generator.

```APIDOC
## Constructor

### Description
Initializes the NavigationExtension with required dependencies.

### Method
__construct

### Signature
```php
public function __construct(
    protected Navigation $navigationHelper,
    protected Placeholder $placeholderHelper,
    protected CategoryLinkGenerator $categoryLinkGenerator
)
```

### Parameters
- **$navigationHelper** (Pimcore\Twig\Extension\Templating\Navigation) - Required - Navigation builder.
- **$placeholderHelper** (Pimcore\Twig\Extension\Templating\Placeholder) - Required - Placeholder access.
- **$categoryLinkGenerator** (CategoryLinkGenerator) - Required - Category link generation.

```

--------------------------------

### LoginActivity constructor

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/api-reference/models.md

Constructor for LoginActivity. Requires a CustomerInterface instance and optionally an integer activity date (unix timestamp), defaulting to null which resolves to time().

```php
public function __construct(CustomerInterface $customer, int $activityDate = null)
```

--------------------------------

### generateWithMockup method signature

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/api-reference/link-generators.md

Like generate but accepts any ProductInterface, used for unsaved or mockup products such as search autocomplete.

```php
public function generateWithMockup(ProductInterface $object, array $params = []): string
```

--------------------------------

### Constructor: SegmentTrackingHelperService::__construct

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/api-reference/services.md

Constructor with dependency injection for VisitorInfoStorage, SegmentTracker, SegmentGetter, and SegmentManagerInterface. All parameters are required.

```php
public function __construct(
    protected VisitorInfoStorage $visitorInfoStorage,
    protected SegmentTracker $segmentTracker,
    protected SegmentGetter $segmentGetter,
    protected SegmentManagerInterface $segmentManager
)
```

--------------------------------

### Navigation extension point constant

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/api-reference/twig-extensions.md

Defines the constant NAVIGATION_EXTENSION_POINT_PROPERTY used to identify pages that should get category navigation injected.

```php
const NAVIGATION_EXTENSION_POINT_PROPERTY = 'navigation_extension_point';
```

--------------------------------

### Twig usage of country filter

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/api-reference/twig-extensions.md

Example of using the 'country' filter in a Twig template with a German locale, e.g., 'Österreich' for Austria.

```twig
{{ item.countryCode|country('de') }}   {# e.g. "Österreich" #}
```

--------------------------------

### Twig usage for category filter

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/api-reference/twig-extensions.md

Example Twig template using the registered functions to prepare and display category filter links.

```twig
{% set filterData = app_category_filter_prepare_data(currentCategoryId, rootCategory) %}
{% for category in filterData.subCategories %}
    <a href="{{ app_category_filter_generate_link(category, rootCategory, true) }}">{{ category.name }}</a>
{% endfor %}
```

--------------------------------

### GET /{_locale}/payment-commit-order

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/endpoints.md

Handles the payment provider's return, commits the order payment, and redirects to the order completion page.

```APIDOC
## GET /{_locale}/payment-commit-order

### Description
Handles the payment provider's return, commits the order payment, and redirects to the order completion page.

### Method
GET

### Endpoint
/{_locale}/payment-commit-order

### Parameters
#### Path Parameters
- **_locale** (string) - Required - The locale for the request (e.g., en, de).

#### Query Parameters
- **token** (string) - Optional - Payment token from provider.
- **PayerID** (string) - Optional - Payer ID from provider.
- Additional provider-specific parameters may be included.

### Response
#### Redirect (302)
Redirects to the order completion page.

```

--------------------------------

### ProductPageExtension constructor

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/api-reference/twig-extensions.md

Constructor injecting ProductLinkGenerator and Translator dependencies.

```php
public function __construct(protected ProductLinkGenerator $productLinkGenerator, protected Translator $translator)
```

--------------------------------

### AbstractProductLinkGenerator constructor

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/api-reference/link-generators.md

Constructor injecting DocumentResolver, RequestStack, and PimcoreUrl dependencies.

```php
public function __construct(
    protected DocumentResolver $documentResolver,
    protected RequestStack $requestStack,
    protected PimcoreUrl $pimcoreUrl
)
```

--------------------------------

### Retrieve local user and group ID

Source: https://github.com/pimcore/demo/blob/2025.x/README.md

Run this command to get your local user and group ID, which may be needed to update the docker-compose.yaml file.

```bash
echo `id -u`:`id -g`
```

--------------------------------

### NavigationExtension constructor

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/api-reference/twig-extensions.md

Injects the Navigation, Placeholder, and CategoryLinkGenerator helpers. All parameters are required.

```php
public function __construct(
    protected Navigation $navigationHelper,
    protected Placeholder $placeholderHelper,
    protected CategoryLinkGenerator $categoryLinkGenerator
)
```

--------------------------------

### GET /{_locale}/search

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/endpoints.md

Performs a full-text search across products. Returns a paginated search page or a JSON array for autocomplete when the `autocomplete` parameter is present.

```APIDOC
## GET /{_locale}/search

### Description
Performs a full-text search across products. Returns a paginated search page or a JSON array for autocomplete when the `autocomplete` parameter is present.

### Method
GET

### Endpoint
/{_locale}/search

### Parameters
#### Query Parameters
- **term** (string) - Required - Search term (HTML-stripped); empty on MySQL still lists products
- **category** (int) - Optional - Category object id; `-1` when absent
- **page** (int) - Optional - Page number, default `1`
- **autocomplete** (any) - Optional - If present, returns a JSON array (max 10 results) instead of the search page
- **filter params** (mixed) - Optional - Additional filter parameters handed to `ListHelper::setupProductList`

### Response
#### Success Response (200)
- Normal: Renders `product/search.html.twig`, paginated with `fallbackFilterdefinition` page limit, tracks impressions (`search-results`), adds breadcrumb and sets head title
- Autocomplete: JSON array of `{ 'href': string, 'product': string }` — href generated via `ProductLinkGenerator::generateWithMockup`, product is `getOSName()` (+ `getColor()[0]`, `getCarClass()` for cars)

### Notes
- No CSRF required
- MySQL default query splits the term on whitespace and adds each token as a query condition
- ElasticSearch uses a `function_score` `multi_match` query on `attributes.*` fields
```

--------------------------------

### LanguageSwitcherExtension getLanguageFlagFile static method

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/api-reference/twig-extensions.md

Returns the raw icon path using the language country mapping table.

```php
public static function getLanguageFlagFile(string $language): string
```

--------------------------------

### doGenerate method signature

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/api-reference/link-generators.md

Protected method that performs the actual URL generation. Uses inherited values, checks urlSlug, and generates shop-detail route URL with productname, product, path, page, and locale parameters.

```php
protected function doGenerate(ProductInterface $object, array $params): string
```

--------------------------------

### Currency extension constructor

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/api-reference/twig-extensions.md

Constructor for the Currency extension, injecting an IntlFormatter instance for currency formatting.

```php
public function __construct(protected IntlFormatter $formatter)
```

--------------------------------

### DefaultController class definition

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/api-reference/controllers.md

Defines the DefaultController class extending BaseController. This controller handles default pages such as examples, default page, generic mail preview, and gallery renderlet.

```php
class DefaultController extends BaseController
```

--------------------------------

### Clear and warm up cache via Docker

Source: https://github.com/pimcore/demo/blob/2025.x/README.md

Clear and warm up the cache inside the PHP container.

```bash
docker compose exec php bin/console cache:clear
```

--------------------------------

### getNavigationPath method

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/api-reference/link-generators.md

Builds the URL path prefix from the category chain. Returns an empty string when no category or empty chain.

```php
public function getNavigationPath(?Category $category, ?Category $rootCategory = null, string $locale = null)
```

--------------------------------

### onLoginSuccess method signature

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/api-reference/event-listeners.md

Handles the LoginSuccessEvent. Only proceeds when the event passport is a Passport with a PasswordUpgradeBadge and the user has a password and is a CustomerInterface.

```php
public function onLoginSuccess(LoginSuccessEvent $event): void
```

--------------------------------

### BundleSetupSubscriber class declaration

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/api-reference/event-listeners.md

Declares the BundleSetupSubscriber class implementing EventSubscriberInterface. Registered in config/installer.yaml.

```php
class BundleSetupSubscriber implements EventSubscriberInterface
```

--------------------------------

### doEcommerceFrameworkLogin method signature

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/api-reference/event-listeners.md

Logs a customer into the e-commerce environment. Migrates the anonymous cart, tracks a LoginActivity, and saves the environment. If customer is null, sets current user ID to -1.

```php
public function doEcommerceFrameworkLogin(CustomerInterface $customer): void
```

--------------------------------

### LanguageSwitcherExtension constructor

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/api-reference/twig-extensions.md

Constructor for LanguageSwitcherExtension, injecting document service, URL generator, request stack, and link generators.

```php
public function __construct(
    private Service $documentService,
    private UrlGeneratorInterface $urlGenerator,
    private RequestStack $requestStack,
    private CategoryLinkGenerator $categoryLinkGenerator,
    private NewsLinkGenerator $newsLinkGenerator,
    private ProductLinkGenerator $productLinkGenerator
)
```

--------------------------------

### PasswordRecoveryInterface definition

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/types.md

Defines the custom interface for password recovery functionality. Includes fluent methods for setting and getting a recovery token and its date, persisting the customer, and managing the email and password. The interface is implemented by App\Model\Customer and consumed by App\Services\PasswordRecoveryService.

```php
interface PasswordRecoveryInterface
{
    /**
     * @return $this
     */
    public function setPasswordRecoveryToken(?string $token): static;

    public function getPasswordRecoveryToken(): ?string;

    /**
     * @return $this
     */
    public function setPasswordRecoveryTokenDate(?Carbon $tokenDate): static;

    public function getPasswordRecoveryTokenDate(): ?Carbon;

    /**
     * @return $this
     */
    public function save(): static;

    public function getEmail(): ?string;

    /**
     * @return $this
     */
    public function setPassword(?string $password): static;
}
```

--------------------------------

### GET /{_locale}/cart/apply-voucher

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/endpoints.md

Applies a voucher code to the cart. The voucher code is provided in the form body. On success, the voucher is added and the cart is updated; on failure, an error flash message is set. Always redirects to the cart detail page.

```APIDOC
## GET /{_locale}/cart/apply-voucher

### Description
Applies a voucher code to the cart. The voucher code is provided in the form body. On success, the voucher is added and the cart is updated; on failure, an error flash message is set. Always redirects to the cart detail page.

### Method
GET

### Endpoint
/{_locale}/cart/apply-voucher

### Parameters
#### Path Parameters
- **_locale** (string) - Required - Locale code (e.g., en, de)

#### Query Parameters
- None

#### Request Body
- **voucher-code** (string) - Optional - Voucher code to apply (empty allowed)

### Request Example
GET /en/cart/apply-voucher
Content-Type: application/x-www-form-urlencoded

voucher-code=SUMMER2024

### Response
#### Success Response (302)
- Redirects to the cart detail page

#### Response Example
(Redirect to /en/cart)

### Error Handling
- Flash message on failure: 'cart.voucher-code-could-not-be-added' or 'cart.error-voucher-code-{code}'
```

--------------------------------

### Method: trackSegmentsForProduct

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/api-reference/services.md

Tracks segments for a visited product. Only acts when visitor info is present, resolving segments via SegmentGetter and tracking them via SegmentTracker.

```php
public function trackSegmentsForProduct(AbstractProduct $product): void
```

--------------------------------

### OrderActivity constructor

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/api-reference/models.md

Constructor for OrderActivity. Requires a CustomerInterface instance and an AbstractOrder instance representing the committed order.

```php
public function __construct(CustomerInterface $customer, AbstractOrder $order)
```

--------------------------------

### SegmentGetter get method

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/api-reference/ecommerce.md

Returns an array of calculated segments based on the object type. For Car objects, it maps manufacturer, carClass, and body style to respective segment groups. For AccessoryPart, it maps manufacturer. Otherwise returns an empty array.

```php
public function get($object, ?array $config = null): array
```

--------------------------------

### GET|POST /{_locale}/cart

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/endpoints.md

Lists the current cart contents or performs a bulk update of cart items. On GET, renders the cart listing or empty cart template. On POST, validates CSRF token and updates item quantities before saving the cart.

```APIDOC
## GET|POST /{_locale}/cart

### Description
Lists the current cart contents (GET) or performs a bulk update of cart item quantities (POST). On GET, renders the cart listing or empty cart template. On POST, validates the CSRF token and updates item quantities before saving the cart.

### Method
GET, POST

### Endpoint
/{_locale}/cart

### Parameters
#### Path Parameters
- **_locale** (string) - Required - Locale code (e.g., en, de)

#### Query Parameters
- None

#### Request Body (POST only)
- **items** (object) - Required - Map of product IDs to quantities, e.g., {"123": 2, "456": 1}
- **_csrf_token** (string) - Required - CSRF token for the 'cartListing' context

### Request Example
{
  "items": {"123": 2, "456": 1},
  "_csrf_token": "csrf-token-value"
}

### Response
#### Success Response (200)
- Renders HTML template (cart listing or empty cart)

#### Response Example
(HTML content of the cart listing page)

### Error Handling
- 403 Forbidden if CSRF token is invalid
- Non-numeric quantities are skipped; loop aborts if cart count exceeds 99
```

--------------------------------

### PrintCatalogExtension constructor

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/api-reference/twig-extensions.md

Constructor for PrintCatalogExtension, injecting Translator and Placeholder helpers.

```php
public function __construct(protected Translator $translator, protected Placeholder $placeholderHelper)
```

--------------------------------

### GET /{_locale}/cart/remove-voucher?voucher-code={code}

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/endpoints.md

Removes a voucher code from the cart. The voucher code is provided as a query parameter. On success, the voucher is removed and a success flash message is set; on failure, an error flash message is set. Redirects to the cart detail page.

```APIDOC
## GET /{_locale}/cart/remove-voucher?voucher-code={code}

### Description
Removes a voucher code from the cart. The voucher code is provided as a query parameter. On success, the voucher is removed and a success flash message is set; on failure, an error flash message is set. Redirects to the cart detail page.

### Method
GET

### Endpoint
/{_locale}/cart/remove-voucher?voucher-code={code}

### Parameters
#### Path Parameters
- **_locale** (string) - Required - Locale code (e.g., en, de)

#### Query Parameters
- **voucher-code** (string) - Optional - Voucher code to remove (empty allowed)

### Request Example
GET /en/cart/remove-voucher?voucher-code=SUMMER2024

### Response
#### Success Response (302)
- Redirects to the cart detail page

#### Response Example
(Redirect to /en/cart)

### Error Handling
- Flash message on failure: 'cart.error-voucher-code-{code}'
```

--------------------------------

### PersonalizedProductTeaser constructor

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/api-reference/areabricks.md

Constructor injecting VisitorInfoStorage, SegmentTracker, SegmentManagerInterface, and EcommerceFramework Factory.

```php
public function __construct(VisitorInfoStorage $visitorInfoStorage, SegmentTracker $segmentTracker, SegmentManagerInterface $segmentManager, Factory $ecommerceFactory)
```

--------------------------------

### NewsExtension constructor

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/api-reference/twig-extensions.md

Constructor for NewsExtension, injecting a NewsLinkGenerator instance.

```php
public function __construct(protected NewsLinkGenerator $newsLinkGenerator)
```

--------------------------------

### Constructor for Product\AdminStyle\Car

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/api-reference/models.md

Constructor that accepts an ElementInterface parameter. When the element is an \App\Model\Product\Car with object type 'actual-car', it sets the element icon to a car emoji SVG inside useInheritedValues(true).

```php
public function __construct(ElementInterface $element)
```

--------------------------------

### configureOptions method signature

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/api-reference/ecommerce.md

Protected method that sets default options for baseCharge and carCharge.

```php
protected function configureOptions(OptionsResolver $resolver): void
```

--------------------------------

### configure method signature

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/api-reference/console-and-kernel.md

Signature for the configure method. Sets the command name to 'app:data-command'.

```php
public function configure(): void
```

--------------------------------

### ProductGrid class declaration

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/api-reference/areabricks.md

Declares the ProductGrid areabrick class extending AbstractAreabrick.

```php
class ProductGrid extends AbstractAreabrick
```

--------------------------------

### generate method signature

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/api-reference/link-generators.md

Public method to generate a product URL. Accepts an object that must be Car or AccessoryPart, with optional params for document, locale, and rootCategory. Throws InvalidArgumentException for other types.

```php
public function generate(object $object, array $params = []): string
```

--------------------------------

### Constructor: __construct

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/api-reference/forms.md

Constructor accepting a LocaleServiceInterface instance, stored as a protected property. The locale service provides region display names for the country select.

```php
public function __construct(protected LocaleServiceInterface $locale)
```

--------------------------------

### NameSettingListener onPreAdd method

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/api-reference/event-listeners.md

Defines the onPreAdd method that handles the pre-add event for BodyStyle, Category, or Manufacturer objects, setting the name from the object key.

```php
public function onPreAdd(DataObjectEvent $event): void
```

--------------------------------

### processOptions method signature

Source: https://github.com/pimcore/demo/blob/2025.x/_autodocs/api-reference/ecommerce.md

Protected method that parses options into Decimal values.

```php
protected function processOptions(array $options): void
```
Tokens:
Raw