Pimcore

https://docs.pimcore.com
Admin
Pimcore is a comprehensive digital experience platform that combines a core framework with optional...
Tokens:540,105
Snippets:6,770
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### Install the bundle via console

Source: https://docs.pimcore.com/platform/Backend_Power_Tools/Installation

Execute the installation command to finalize the bundle setup.

```bash
bin/console pimcore:bundle:install PimcoreBackendPowerToolsBundle
```

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

### Implement InstallProfileInterface

Source: https://docs.pimcore.com/platform/Getting_Started/Installation/Advanced_Installation_Topics/Install_Profiles

A complete example of a custom install profile class defining bundles, environment variables, and post-install commands.

```php
<?php  
declare(strict_types=1);  
  
namespace App\/Installer;  
  
use Pimcore\Bundle\InstallBundle\EnvVarDefinition\Definitions\DatabaseEnvVarDefinition;  
use Pimcore\Bundle\InstallBundle\EnvVarDefinition\Definitions\OpenSearchEnvVarDefinition;  
use Pimcore\Bundle\InstallBundle\EnvVarDefinition\EnvVarDefinitionInterface;  
use Pimcore\Bundle\InstallBundle\Profile\DataSource\DataSourceInterface;  
use Pimcore\Bundle\InstallBundle\Profile\InstallProfileInterface;  
use Pimcore\Bundle\InstallBundle\Profile\PostInstallCommand;  
  
final class MyProjectProfile implements InstallProfileInterface  
{  
    public function getName(): string  
    {  
        return 'My Project';  
    }  
  
    public function getDescription(): string  
    {  
        return 'Standard installation for the My Project application.';  
    }  
  
    public function getBundles(): array  
    {  
        return [  
            \Pimcore\Bundle\ApplicationLoggerBundle\PimcoreApplicationLoggerBundle::class,  
            \Pimcore\Bundle\CustomReportsBundle\PimcoreCustomReportsBundle::class,  
        ];  
    }  
  
    public function getEnvVarDefinitions(): array  
    {  
        return [  
            new DatabaseEnvVarDefinition(),  
            new OpenSearchEnvVarDefinition(),  
        ];  
    }  
  
    public function getDataSource(): ?DataSourceInterface  
    {  
        return null; // no pre-built content  
    }  
  
    public function getPostInstallCommands(): array  
    {  
        return [  
            new PostInstallCommand(  
                command: 'cache:clear',  
                label: 'Clearing cache',  
                priority: 100,  
            ),  
        ];  
    }  
}  
```

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

### Install Copilot Bundle

Source: https://docs.pimcore.com/platform/Copilot/Installation

Execute the bundle installation command after registering it in the configuration.

```bash
bin/console pimcore:bundle:install PimcoreCopilotBundle
```

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

### Implement Bundle Installer

Source: https://docs.pimcore.com/platform/Pimcore/Extending_Pimcore/Pimcore_Bundle_Developers_Guide/Pimcore_Bundles/Installers

Return an instance of your installer from the getInstaller method in your bundle class.

```php
<?php  
  
namespace App;  
  
use Pimcore\Extension\Bundle\AbstractPimcoreBundle;  
  
class App extends AbstractPimcoreBundle  
{  
    public function getInstaller(): Installer  
    {  
        return $this->container->get(Installer::class);  
    }  
}  
```

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

### Run the Installer

Source: https://docs.pimcore.com/platform/Getting_Started/Installation/Demo_Enterprise_Installation

Executes the Pimcore installer using the demo enterprise profile.

```bash
docker compose exec php vendor/bin/pimcore-install \
  --install-profile='App\Installer\DemoEnterpriseProfile'
```

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

### Install PaaS Bundle

Source: https://docs.pimcore.com/platform/Paas/Quick_Start_Existing_Project

Install the required PaaS bundle via Composer.

```bash
composer require pimcore/paas  
```

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

### Verify Prerequisites for Composer Setup

Source: https://docs.pimcore.com/platform/Paas/Quick_Start_New_Project

Check that PHP 8.4+, Composer, Git, and the Pimcore CLI are correctly installed in your local environment.

```bash
php --version        # Should show 8.4 or higher  
composer --version   # Should show Composer is installed  
git --version        # Should show Git is installed  
pimcore-cloud --version  # Should show Pimcore CLI is installed  
```

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

### Run the Pimcore installer

Source: https://docs.pimcore.com/platform/Getting_Started/Installation/Skeleton_Installation

Executes the installation script using the skeleton profile.

```bash
docker compose exec php vendor/bin/pimcore-install --install-profile='App\Installer\SkeletonProfile'  
```

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

### Install Datahub and Simple REST bundles

Source: https://docs.pimcore.com/platform/Datahub_Simple_Rest/Installation

Run the console commands to install the Datahub and Simple REST bundles.

```bash
bin/console pimcore:bundle:install PimcoreDataHubBundle
```

```bash
bin/console pimcore:bundle:install PimcoreDataHubSimpleRestBundle
```

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

### Verify Prerequisites for Docker Setup

Source: https://docs.pimcore.com/platform/Paas/Quick_Start_New_Project

Check that Docker, Docker Compose, Git, and the Pimcore CLI are correctly installed in your local environment.

```bash
docker --version           # Should show Docker is installed  
docker compose version     # Should show Docker Compose is installed  
git --version              # Should show Git is installed  
pimcore-cloud --version    # Should show Pimcore CLI is installed  
```

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

### Build and Start Agent-Server

Source: https://docs.pimcore.com/platform/Pimcore_Agent/Installation

Build the agent-server image and start the container in detached mode.

```bash
docker compose up -d --build agent-server  
```

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

### Install Showcase Bundle

Source: https://docs.pimcore.com/platform/Copilot/Installation

Optional command to install additional showcase actions for Pimcore Copilot.

```bash
composer require pimcore/copilot-showcase-bundle
```

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

### Run Bundle Installation Command

Source: https://docs.pimcore.com/platform/Data_Quality_Management/Installation

Execute the console command to finalize the bundle installation.

```bash
bin/console pimcore:bundle:install PimcoreDataQualityManagementBundle
```

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

### Install Pimcore locally

Source: https://docs.pimcore.com/platform/Paas/Quick_Start_New_Project

Runs the interactive installation profile to set up the local database and services.

```bash
docker compose exec php ./vendor/bin/pimcore-install --install-profile='Pimcore\Paas\Install\PaasProfile'  
```

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

### Run bundle installation

Source: https://docs.pimcore.com/platform/Customer_Management_Framework/Installation

Execute the console command to finalize the bundle installation and register necessary database tables and permissions.

```bash
bin/console pimcore:bundle:install PimcoreCustomerManagementFrameworkBundle
```

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

### Install PaaS Configuration Files

Source: https://docs.pimcore.com/platform/Paas/Quick_Start_Existing_Project

Generate the necessary infrastructure and configuration files for the project.

```bash
./vendor/bin/pimcore-paas-install-config  
```

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

### Install frontend dependencies

Source: https://docs.pimcore.com/platform/Portal_Engine/Development_Documentation/Customize_Appearance/Customize_Frontend_Build

Install the required node packages after generating the package.json file.

```bash
npm install  
```

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

### Manage Template Examples via CLI

Source: https://docs.pimcore.com/platform/Pimcore_Agent/Extending/Template_Examples

Commands to discover editable names, validate example files, and manage the template schema.

```bash
# 1. Discover the legal editable names for the template/brick  
bin/console pimcore-agent:document-schema:names --brick=standard-teaser  
bin/console pimcore-agent:document-schema:names content/portal.html.twig  
  
# 2. Author JSON files in the sibling <stem>.examples/ folder  
  
# 3. Validate  
bin/console pimcore-agent:document-schema:lint
```

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

### Install PimcoreSeoBundle

Source: https://docs.pimcore.com/platform/Pimcore/Documents/Robots_txt

Command to install the required SEO bundle for robots.txt functionality.

```bash
bin/console pimcore:bundle:install PimcoreSeoBundle
```

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

### Install Headless Documents bundle

Source: https://docs.pimcore.com/platform/Headless_Documents/Installation

Run the console command to finalize the installation of the Headless Documents bundle.

```bash
bin/console pimcore:bundle:install PimcoreHeadlessDocumentsBundle
```

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

### Install enterprise dependencies

Source: https://docs.pimcore.com/platform/Paas/Quick_Start_New_Project

Installs the required enterprise packages using the configured credentials.

```bash
docker compose exec php composer install  
```

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

### Install Datahub and Webhooks Bundles

Source: https://docs.pimcore.com/platform/Datahub_Webhooks/Installation

Run the console commands to install the Datahub and Webhooks bundles.

```bash
bin/console pimcore:bundle:install PimcoreDataHubBundle
```

```bash
bin/console pimcore:bundle:install PimcoreDataHubWebhooksBundle
```

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

### Install Dependent Bundles

Source: https://docs.pimcore.com/platform/Copilot/Installation

Install the required generic data index and execution engine bundles before installing Copilot.

```bash
bin/console pimcore:bundle:install PimcoreGenericDataIndexBundle  
bin/console pimcore:bundle:install PimcoreGenericExecutionEngineBundle
```

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

### Start Docker services

Source: https://docs.pimcore.com/platform/Getting_Started/Installation/Skeleton_Installation

Configures the container user to match the local system user and starts the project services.

```bash
sed -i "s|user: '1000:1000'|user: '$(id -u):$(id -g)'|g" docker-compose.yaml  
docker compose up -d  
```

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

### Install Bundle via Console

Source: https://docs.pimcore.com/platform/Datahub/Installation_and_Upgrade

Run the Pimcore console command to finalize the bundle installation.

```bash
bin/console pimcore:bundle:install PimcoreDataHubBundle
```

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

### Install Pimcore Agent Bundle

Source: https://docs.pimcore.com/platform/Pimcore_Agent/Installation

Executes the bundle installation and clears the cache via the CLI.

```bash
docker compose exec php bin/console pimcore:bundle:install PimcoreAgentBundle  
docker compose exec php bin/console cache:clear  
```

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

### Install dependencies via Composer

Source: https://docs.pimcore.com/platform/Enterprise_Metadata/Installation

Install the required bundle package using Composer.

```bash
composer require pimcore/asset-metadata-class-definitions
```

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

### Start Docker Services

Source: https://docs.pimcore.com/platform/Getting_Started/Installation/Demo_Enterprise_Installation

Starts the pre-configured Docker services defined in the docker-compose.yaml file.

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

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

### Run Pimcore Installation on PaaS

Source: https://docs.pimcore.com/platform/Paas/Configuration

Executes the non-interactive installation process during the first deployment.

```bash
php vendor/bin/pimcore-install --install-profile='Pimcore\Paas\Install\PaasProfile' --no-interaction  
```

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

### Filter Syntax Examples

Source: https://docs.pimcore.com/platform/Headless_Documents/DataHub_Integration/Search_Endpoint

Examples of filter parameters and their corresponding SQL logic.

```json
filter={"modificationDate" : "1000"}  
  
... SQL equivalent ...  
where ((`modificationDate` = '1000') )
```

```json
filter=[{"creationDate" : "1000"}, {"modificationDate" : "9999"}]  
...  
where ( ((`creationDate` = '1000') )  AND  ((`modificationDate` = '9999') )  )
```

```json
filter={"modificationDate" : "1000", "$or": [{"id": "3"}, {"key": "lorem-ipsum"}]}  
...  
where ((`modificationDate` = '1000') AND ((`id` = '3') OR (`key` = 'lorem-ipsum')  )  )
```

```json
filter={"$and" : [{"published": "0"}, {"modificationDate" : "1000", "$or": [{"id": "3"}, {"key": "lorem-ipsum"}]}]}  
...          
where ( ((`published` = '0') )  AND  ((`modificationDate` = '1000') AND ((`id` = '3') OR (`key` = 'lorem-ipsum') )  )  )
```

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

### Install Custom Reports Bundle

Source: https://docs.pimcore.com/platform/Pimcore/Reporting/Custom_Reports

Run this command via the console to complete the bundle installation.

```bash
bin/console pimcore:bundle:install PimcoreCustomReportsBundle
```

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

### Install required bundles via console

Source: https://docs.pimcore.com/platform/Datahub_Productsup/Installation

Run the installation commands for Datahub, Datahub File Export, and the Productsup bundle to initialize necessary database tables and permissions.

```bash
bin/console pimcore:bundle:install PimcoreDataHubBundle
```

```bash
bin/console pimcore:bundle:install PimcoreDataHubFileExportBundle
```

```bash
bin/console pimcore:bundle:install PimcoreDataHubProductsupBundle
```

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

### Install Datahub and Data Importer bundles

Source: https://docs.pimcore.com/platform/Data_Importer/Installation

Execute the console commands to install the Datahub and Data Importer bundles.

```bash
bin/console pimcore:bundle:install PimcoreDataHubBundle
```

```bash
bin/console pimcore:bundle:install PimcoreDataImporterBundle
```

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

### Create indices and queue elements

Source: https://docs.pimcore.com/platform/Generic_Data_Index/Installation

Initialize indices and queue all elements for indexing after installation.

```bash
bin/console generic-data-index:update:index -r
```

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

### Install Datahub Webhooks via Composer

Source: https://docs.pimcore.com/platform/Datahub_Webhooks/Installation

Use Composer to install the bundle and its dependencies.

```bash
composer require pimcore/data-hub-webhooks --with-all-dependencies
```

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

### Verify Bundle Installation

Source: https://docs.pimcore.com/platform/Ecommerce_Framework/Installation

Check the status of installed bundles to confirm the E-Commerce Framework is correctly registered.

```bash
php bin/console pimcore:bundle:list
+---------------------------------+---------+-----------+----+-----+-----+
| Bundle                          | Enabled | Installed | I? | UI? | UP? |
+---------------------------------+---------+-----------+----+-----+-----+
| PimcoreEcommerceFrameworkBundle  | ✔     | ✔        | ❌  | ✔ | ❌ |
+---------------------------------+---------+-----------+----+-----+-----+
```

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

### Install File Export Bundle

Source: https://docs.pimcore.com/platform/Datahub_File_Export/Installation

Run the console command to finalize the installation of the File Export bundle and its required database schema.

```bash
bin/console pimcore:bundle:install PimcoreDataHubFileExportBundle
```

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

### Implement InstallStepFilterInterface

Source: https://docs.pimcore.com/platform/Getting_Started/Installation/Advanced_Installation_Topics/Install_Step_Filtering

Profiles must implement this interface to define which installation steps should be skipped.

```php
<?php  
declare(strict_types=1);  
  
namespace Pimcoreundle
InstallBundle\Profile;  
  
interface InstallStepFilterInterface  
{  
    /**  
     * @return list<InstallStep>  
     */  
    public function getSkippedInstallSteps(): array;  
}  
```

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

### Create a Custom Install Profile

Source: https://docs.pimcore.com/platform/Paas/Configuration

Defines a custom profile class by implementing InstallProfileInterface and InstallStepFilterInterface to manage installation steps.

```php
namespace App\Install;  
  
use Pimcore\Bundle\InstallBundle\Profile\InstallProfileInterface;  
use Pimcore\Bundle\InstallBundle\Profile\InstallStep;  
use Pimcore\Bundle\InstallBundle\Profile\InstallStepFilterInterface;  
  
final readonly class MyProjectProfile implements InstallProfileInterface, InstallStepFilterInterface  
{  
    public function getSkippedInstallSteps(): array  
    {  
        return [  
            InstallStep::WriteEnv,  
            InstallStep::WriteDoctrineConfig,  
            InstallStep::RegisterBundles,  
            InstallStep::InstallAssets,  
            InstallStep::RunMaintenance,  
        ];  
    }  
  
    // ... implement remaining InstallProfileInterface methods  
}  
```

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

### Implement SettingsStoreAwareInstaller

Source: https://docs.pimcore.com/platform/Pimcore/Extending_Pimcore/Pimcore_Bundle_Developers_Guide/Pimcore_Bundles/Installers

Extend SettingsStoreAwareInstaller to track installation state and optionally mark migrations as completed.

```php
<?php  
  
namespace Pimcore\Bundle\DummyBundle;  
  
use Pimcore\Bundle\DummyBundle\Migrations\Version20210304111225;  
use Pimcore\Extension\Bundle\Installer\SettingsStoreAwareInstaller;  
  
class Installer extends SettingsStoreAwareInstaller  
{  
    public function getLastMigrationVersionClassName(): ?string  
    {  
        // return fully qualified classname of last migration that should be marked as migrated during install  
        return Version20210304111225::class;  
    }  
  
    public function install(): void  
    {  
        //do your install stuff     
  
        $this->markInstalled();  
        //or call parent::install();       
    }  
  
    public function uninstall(): void  
    {  
        //do your uninstall stuff  
  
        $this->markUninstalled();  
        //or call parent::uninstall();     
    }  
}  
```

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

### Install Bundle via Console

Source: https://docs.pimcore.com/platform/Direct_Edit/Installation

Run the Symfony console command to finalize the bundle installation.

```bash
bin/console pimcore:bundle:install PimcoreDirectEditBundle
```

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

### Run bundle installers

Source: https://docs.pimcore.com/platform/Workflow_Automation/Installation

Execute the console commands to install the Datahub and Workflow Automation Integration bundles.

```bash
bin/console pimcore:bundle:install PimcoreDataHubBundle  
bin/console pimcore:bundle:install PimcoreWorkflowAutomationIntegrationBundle
```

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

### Install OpenID Connect Package

Source: https://docs.pimcore.com/platform/OpenID_Connect/Installation

Use Composer to add the OpenID Connect bundle to your project.

```bash
composer require pimcore/openid-connect
```

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

### Configure Startup Logic

Source: https://docs.pimcore.com/platform/Pimcore/Development_Details/Configuration

Example of executing custom logic during the bootstrap process by using the startup.php file.

```php
<?php  
  
// /config/pimcore/startup.php  
  
use \Symfony\Component\HttpFoundation\Request;  
  
Request::setTrustedProxies(['192.0.0.1', '10.0.0.0/8'], Request::HEADER_X_FORWARDED_ALL);  
```

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

### Implement a Platform.sh Installation Profile

Source: https://docs.pimcore.com/platform/Getting_Started/Installation/Advanced_Installation_Topics/Install_Step_Filtering

Defines a custom installation profile that implements InstallStepFilterInterface to skip steps handled by the Platform.sh deployment pipeline.

```php
<?php  
declare(strict_types=1);  
  
namespace App\Installer;  
  
use Pimcore\Bundle\InstallBundle\EnvVarDefinition\Definitions\DatabaseEnvVarDefinition;  
use Pimcore\Bundle\InstallBundle\EnvVarDefinition\Definitions\OpenSearchEnvVarDefinition;  
use Pimcore\Bundle\InstallBundle\EnvVarDefinition\Definitions\RedisEnvVarDefinition;  
use Pimcore\Bundle\InstallBundle\Profile\DataSource\DataSourceInterface;  
use Pimcore\Bundle\InstallBundle\Profile\InstallProfileInterface;  
use Pimcore\Bundle\InstallBundle\Profile\InstallStep;  
use Pimcore\Bundle\InstallBundle\Profile\InstallStepFilterInterface;  
use Pimcore\Bundle\InstallBundle\Profile\PostInstallCommand;  
  
final readonly class PlatformShProfile implements InstallProfileInterface, InstallStepFilterInterface  
{  
    public function getName(): string  
    {  
        return 'Platform.sh';  
    }  
  
    public function getDescription(): string  
    {  
        return 'Pimcore installation for Platform.sh deployments.';  
    }  
  
    public function getBundles(): array  
    {  
        return [  
            \Pimcore\Bundle\ApplicationLoggerBundle\PimcoreApplicationLoggerBundle::class,  
            \Pimcore\Bundle\CustomReportsBundle\PimcoreCustomReportsBundle::class,  
            \Pimcore\Bundle\GlossaryBundle\PimcoreGlossaryBundle::class,  
        ];  
    }  
  
    public function getEnvVarDefinitions(): array  
    {  
        return [  
            new DatabaseEnvVarDefinition(),  
            new OpenSearchEnvVarDefinition(),  
            new RedisEnvVarDefinition(),  
        ];  
    }  
  
    public function getDataSource(): ?DataSourceInterface  
    {  
        return null;  
    }  
  
    public function getPostInstallCommands(): array  
    {  
        return [  
            new PostInstallCommand(  
                command: 'cache:clear',  
                label: 'Clearing cache',  
                priority: 100,  
            ),  
        ];  
    }  
  
    public function getSkippedInstallSteps(): array  
    {  
        return [  
            // Env vars are set via the Platform.sh dashboard, not .env.local  
            InstallStep::WriteEnv,  
  
            // doctrine_mapping_types.yaml is committed to the repository  
            InstallStep::WriteDoctrineConfig,  
  
            // Assets are built by the Platform.sh build hook  
            InstallStep::InstallAssets,  
        ];  
    }  
}  
```

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

### Create Pimcore PaaS Project

Source: https://docs.pimcore.com/platform/Paas/Quick_Start_New_Project

Initialize a new project using the Pimcore PaaS skeleton.

```bash
COMPOSER_MEMORY_LIMIT=-1 composer create-project pimcore/paas-skeleton my-project  
cd my-project  

```

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

### Install Pimcore Locally

Source: https://docs.pimcore.com/platform/Paas/Quick_Start_New_Project

Execute the local installation using the PaaS profile, with an optional flag to skip service validation.

```bash
./vendor/bin/pimcore-install --install-profile='Pimcore\Paas\Install\PaasProfile'  

```

```bash
./vendor/bin/pimcore-install --install-profile='Pimcore\Paas\Install\PaasProfile' --skip-validation=gotenberg  

```

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

### Install CMF dependencies

Source: https://docs.pimcore.com/platform/Customer_Management_Framework/Installation

Run this command to install the Customer Management Framework bundle via Composer.

```bash
composer require pimcore/customer-management-framework-bundle
```

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

### Register user permissions

Source: https://docs.pimcore.com/platform/Studio_Dashboards/Installation

Run the bundle installer to register required permissions.

```bash
bin/console pimcore:bundle:install PimcoreStudioDashboardsBundle
```

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

### Install AWS S3 Adapter

Source: https://docs.pimcore.com/platform/Getting_Started/Installation/System_Setup_and_Hosting/File_Storage_Setup

Install the required Flysystem AWS S3 package via Composer.

```bash
composer require league/flysystem-aws-s3-v3  
```

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

### GET /index/filter-field-values

Source: https://docs.pimcore.com/platform/Ecommerce_Framework/Studio

Get all values for a filter field.

```APIDOC
## GET /index/filter-field-values

### Description
Get all values for a filter field.

### Method
GET

### Endpoint
/index/filter-field-values

### Parameters
#### Query Parameters
- **field** (string) - Required - The field name.
- **tenant** (string) - Required - The tenant identifier.
```

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

### Enable E-Commerce Framework Bundle

Source: https://docs.pimcore.com/platform/Ecommerce_Framework/Installation

Run the console command to install and enable the bundle within the Pimcore environment.

```bash
php bin/console pimcore:bundle:install PimcoreEcommerceFrameworkBundle
```

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

### Hugging Face Text to Image Example

Source: https://docs.pimcore.com/platform/Copilot/Included_Actions/AI_Integrations_Powered_By_Hugging_Face/Hugging_Face_Text_to_Image

A complete configuration example using the stabilityai/stable-diffusion-3-medium-diffusers model with specific generation parameters and caching options.

```yaml
# Specifies the model's endpoint.  
model_endpoint: 'https://router.huggingface.co/hf-inference/models/stabilityai/stable-diffusion-3-medium-diffusers'  
  
# Specifies the folder for storing generated images.  
asset_folder: '/AI Generated'  
  
# This field within the Data Object is where the generated image will be stored.  
output_field: 'AIGeneratedImage'  
  
# Twig template that constructs the prompt sent to the image generation model.  
prompt_template: "Realistic picture of {{ subject.name }}, production year: {{ subject.productionYear }}, {{ subject.color|join(',') }}, detailed, 8k"  
  
# Twig template to generate the filename based on Data Object or Asset fields.  
filename_template: "{{ subject.name|replace({' ': '-'}) }}-{{ random() }}"  
  
parameters:  
  height: 600  
  width: 800  
  negative_prompt: "ugly, deformed, disfigured, poor details, bad anatomy"  
  guidance_scale: 8.5  
  num_inference_steps: 80  
  
options:  
  # Uses cached images for similar requests to speed up response times. Set to false for new images per request.  
  use_cache: true
```

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

### Document Payload Example

Source: https://docs.pimcore.com/platform/Datahub_Webhooks/Request_Structure

Example payload for a Document update event.

```json
{
  "general": {  
    "eventName": "pimcore.document.postUpdate",  
    "timestamp": 1690975115,  
    "subjectType": "document",  
    "versionOnly": false  
  },
  "subject": {  
    "id": 65,  
    "path": "/en/News",  
    "userModification": 25,  
    "userModificationName": "admin",  
    "published": true,  
    "type": "page"  
  }
}
```

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

### Install Gotenberg PHP Library

Source: https://docs.pimcore.com/platform/Getting_Started/Installation/Advanced_Installation_Topics

Install the required PHP library to enable Gotenberg document preview support.

```bash
composer require gotenberg/gotenberg-php ^2.0
```

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

### Asset Payload Example

Source: https://docs.pimcore.com/platform/Datahub_Webhooks/Request_Structure

Example payload for an Asset update event.

```json
{
  "general": {  
    "eventName": "pimcore.asset.postUpdate",  
    "timestamp": 1690975091,  
    "subjectType": "asset",  
    "versionOnly": false  
  },
  "subject": {  
    "id": 83,  
    "path": "/Car Images/ferrari/061_-_Ferrari_Testarossa_-_Flickr_-_Price-Photography.jpg",  
    "userModification": 25,  
    "userModificationName": "admin",  
    "type": "image",  
    "mimeType": "image/jpeg"  
  }
}
```

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

### Install Copilot Bundle via Composer

Source: https://docs.pimcore.com/platform/Copilot/Installation

Run this command to install the required Pimcore Copilot bundle dependencies.

```bash
composer require pimcore/copilot-bundle
```

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

### Install the bundle package

Source: https://docs.pimcore.com/platform/Backend_Power_Tools/Installation

Use Composer to add the bundle to your project dependencies.

```bash
composer require pimcore/backend-power-tools-bundle
```

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

### Implementing PostInstallCommandsProviderInterface

Source: https://docs.pimcore.com/platform/Getting_Started/Installation/Advanced_Installation_Topics/Post_Install_Commands

Registers multiple post-install commands by implementing the provider interface in a bundle installer.

```php
<?php  
declare(strict_types=1);  
  
namespace App\Installer;  
  
use Pimcore\Bundle\InstallBundle\Profile\PostInstallCommand;  
use Pimcore\Bundle\InstallBundle\Profile\PostInstallCommandsProviderInterface;  
  
final class ProjectSetupCommands implements PostInstallCommandsProviderInterface  
{  
    public function getPostInstallCommands(): array  
    {  
        return [  
            new PostInstallCommand(  
                command: 'app:import-fixtures',  
                label: 'Importing project fixtures',  
                priority: 50,  
            ),  
            new PostInstallCommand(  
                command: 'messenger:setup-transports',  
                label: 'Creating messenger transport tables',  
                priority: 40,  
            ),  
        ];  
    }  
}  
```

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

### Prepare Bind-Mount Directories

Source: https://docs.pimcore.com/platform/Pimcore_Agent/Installation

Create the necessary directories for agent state and uploads before starting the container to avoid root ownership issues.

```bash
mkdir -p var/tmp/copilot-state var/tmp/agent-uploads  
```

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

### Switch Directory

Source: https://docs.pimcore.com/platform/Getting_Started/Installation/Demo_Enterprise_Installation

Navigates into the newly created project directory.

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

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

### Examples of Property-Based Retrieval

Source: https://docs.pimcore.com/platform/Pimcore/Objects/Working_with_Objects_via_PHP_API

Practical examples of fetching lists or single objects using generated getter methods.

```php
<?php  
  
use \Pimcore\Model\DataObject;  
  
// get a list of cities in Austria  
$list = DataObject\City::getByCountry("AT");  
foreach ($list as $city) {  
    // do something with the cities  
    $city->getZip();  
    ...  
}  
   
   
// get a city by zip  
$city = DataObject\City::getByZip(5020, 1);  
$city->getZip(); // do something with the city  
   
   
   
// get the first 10 cities in Austria  
$list = DataObject\City::getByCountry("AT", 10);  
foreach ($list as $city) {  
    // do something with the cities  
    $city->getZip();  
}
```

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

### Sorting Examples

Source: https://docs.pimcore.com/platform/Datahub_Simple_Rest/Filtering_and_Paging

Practical examples of sorting by single fields, multiple fields, and using explicit unmapped types.

```text
system.modificationDate
```

```json
{"system.modificationDate": "desc"}
```

```json
{"data.price": "asc"}
```

```json
{"data.price": {"order": "asc", "unmapped_type": "double"}}
```

```json
{"data.category": "asc", "data.price": "desc", "system.id": "asc"}
```

```json
{"data.price": {"order": "asc", "unmapped_type": "double"}, "system.id": "asc"}
```

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

### GET /pricing/rules/{id}

Source: https://docs.pimcore.com/platform/Ecommerce_Framework/Studio

Get full details of a specific pricing rule.

```APIDOC
## GET /pricing/rules/{id}

### Description
Get full details of a rule.

### Method
GET

### Endpoint
/pricing/rules/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - The ID of the pricing rule.
```

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

### Create the Project

Source: https://docs.pimcore.com/platform/Getting_Started/Installation/Demo_Enterprise_Installation

Initializes the project using the Pimcore enterprise repository. Requires valid credentials for the repository.

```bash
docker run --rm -v `pwd`:/var/www/html -it pimcore/pimcore:php8.5-latest sh -c \
  'composer --global config repositories.pimcore composer https://repo.pimcore.com/<YOUR_USERNAME>/ ; \
   composer create-project --no-scripts pimcore/demo-enterprise my-project \
   --repository="{\"url\": \"https://token:<YOUR_TOKEN>@repo.pimcore.com/<YOUR_USERNAME>/\", \"type\": \"composer\"}" \
   -n --ignore-platform-req=php --no-scripts'
```

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

### Install Studio Backend Bundle dependencies

Source: https://docs.pimcore.com/platform/Studio_Backend/Installation_and_Configuration

Use Composer to add the bundle to your project dependencies.

```bash
composer require pimcore/studio-backend-bundle
```

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

### Start Docker services

Source: https://docs.pimcore.com/platform/Paas/Quick_Start_New_Project

Launches the required local development services including MariaDB, Redis, and PHP.

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

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

### Implementing PostInstallHookInterface

Source: https://docs.pimcore.com/platform/Getting_Started/Installation/Advanced_Installation_Topics/Post_Install_Commands

Executes custom logic requiring direct database access after all post-install commands have finished.

```php
<?php  
declare(strict_types=1);  
  
namespace App\Installer;  
  
use Doctrine\DBAL\Connection;  
use Pimcore\Bundle\InstallBundle\Profile\PostInstallHookInterface;  
use Symfony\Component\Console\Output\OutputInterface;  
  
final class CustomDataMigration implements PostInstallHookInterface  
{  
    public function postInstall(Connection $connection, OutputInterface $output): void  
    {  
        $output->writeln('Running custom data migration...');  
        $connection->executeStatement('INSERT INTO ...');  
    }  
}  
```

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

### GraphQL Response Example

Source: https://docs.pimcore.com/platform/Datahub/GraphQL/Query/Query_Samples/Sample_GetAsset

Example JSON response returned by the getAsset query.

```json
{
  "data": {
    "getAsset": {
        {
          "data": {
            "getAsset": {
              "id": "4",
              "fullpath": "/Car%20Images/jaguar/auto-automobile-automotive-192499.jpg",
              "assetThumb": "/Car%20Images/jaguar/4/image-thumb__4__exampleCover/auto-automobile-automotive-192499.jpg",
              "assetThumb2": "/Car%20Images/jaguar/4/image-thumb__4__content/auto-automobile-automotive-192499.webp",
              "resolutions": [
                {
                  "url": "//Car%20Images/jaguar/image-thumb__4__content/auto-automobile-automotive-192499~-~768w@2x.jpg",
                  "resolution": 2
                },
                {
                  "url": "//Car%20Images/jaguar/image-thumb__4__content/auto-automobile-automotive-192499~-~768w@5x.jpg",
                  "resolution": 5
                }
              ]
              "srcset": [
                {
                  "descriptor": "768w",
                  "url": "//Car%20Images/jaguar/image-thumb__4__content/auto-automobile-automotive-192499~-~768w.webp"
                  "resolutions": [
                    {
                      "url": "//Car%20Images/jaguar/image-thumb__4__content/auto-automobile-automotive-192499~-~768w@2x.webp",
                      "resolution": 2
                    },
                    {
                      "url": "//Car%20Images/jaguar/image-thumb__4__content/auto-automobile-automotive-192499~-~768w@5x.webp",
                      "resolution": 5
                    }
                  ]
                }
              ],
              "type": "image",
              "mimetype": "image/jpeg",
              "filesize": 113895,
              "data": "UklGRjh............."
            }
          }
        }
```

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

### Usage of Custom Model

Source: https://docs.pimcore.com/platform/Pimcore/Extending_Pimcore/Custom_Extension_Guides/Custom_Persistent_Models

Example of instantiating and saving a custom model.

```php
$vote = new \App\Model\Vote();  
$vote->setScore(3);  
$vote->setUsername('foobar!' . random_int(1, 999));  
$vote->save();  
```

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

### Example Endpoint URL

Source: https://docs.pimcore.com/platform/Datahub/GraphQL/Configuration/Customize_Endpoint_URL

A concrete example of a constructed endpoint URL using a specific configuration name and API key.

```text
/pimcore-graphql-webservices/blogdemo?apikey=12345  
```

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

### Run Product Registration

Source: https://docs.pimcore.com/platform/Paas/Quick_Start_Existing_Project

Execute the registration script to generate necessary product keys and identifiers.

```bash
./vendor/bin/pimcore-paas-product-registration  

```

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

### Install the Productsup package

Source: https://docs.pimcore.com/platform/Datahub_Productsup/Installation

Use Composer to add the Datahub Productsup bundle to your project.

```bash
composer require pimcore/data-hub-productsup
```

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

### Register SettingsStoreAwareInstaller Service

Source: https://docs.pimcore.com/platform/Pimcore/Extending_Pimcore/Pimcore_Bundle_Developers_Guide/Pimcore_Bundles/Installers

Configure the installer service with the bundle argument.

```yaml
    Pimcore\Bundle\DummyBundle\Installer:  
        public: true  
        arguments:  
            $bundle: "@=service('kernel').getBundle('PimcoreDummyBundle')"  
```

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

### Initialize Host Directories

Source: https://docs.pimcore.com/platform/Pimcore_Agent/Development

Create necessary host directories before starting the container to ensure correct ownership and prevent root-owned mount points.

```bash
mkdir -p var/tmp/copilot-state var/tmp/agent-uploads  
mkdir -p dev/pimcore/pimcore-agent-bundle/agent-server/var
```

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

### Run Pimcore Installation Locally

Source: https://docs.pimcore.com/platform/Paas/Configuration

Commands for running the install profile in a local environment, including an option to skip specific service validations.

```bash
./vendor/bin/pimcore-install --install-profile='Pimcore\Paas\Install\PaasProfile'  
```

```bash
./vendor/bin/pimcore-install --install-profile='Pimcore\Paas\Install\PaasProfile' --skip-validation=gotenberg  
```

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

### Initialize frontend build dependencies

Source: https://docs.pimcore.com/platform/Portal_Engine/Development_Documentation/Customize_Appearance/Customize_Frontend_Build

Use the console command to generate or update the package.json file in the project root.

```bash
bin/console portal-engine:update:frontend-build  
```

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

### Install Headless Documents package

Source: https://docs.pimcore.com/platform/Headless_Documents/Installation

Use Composer to add the Headless Documents bundle to the project.

```bash
composer require pimcore/headless-documents
```

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

### Create a Pricing Rule

Source: https://docs.pimcore.com/platform/Ecommerce_Framework/Studio

Example response and request for creating a new pricing rule.

```json
{ "id": 42 }
```

```http
POST /pricing/rules  
Content-Type: application/json  
  
{ "name": "summer_sale" }
```

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

### Install bundle dependencies

Source: https://docs.pimcore.com/platform/Studio_Dashboards/Installation

Use Composer to add the Studio Dashboards Bundle to your project.

```bash
composer require pimcore/studio-dashboards-bundle
```

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

### Marker Data Structure Example

Source: https://docs.pimcore.com/platform/Pimcore/Objects/Object_Classes/Data_Types/Image_Types

Example of the array structure returned by the getMarker() method.

```text
Array  
(  
    [0] => Array  
        (  
            [top] => 3.8922155688623  
            [left] => 48.076923076923  
        )  
   
    [1] => Array  
        (  
            [top] => 8.9820359281437  
            [left] => 70.897435897436  
        )  
   
)
```

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

### Example Output for getHotspots

Source: https://docs.pimcore.com/platform/Pimcore/Documents/Templates/Editables/Image

Shows the structure of the array returned by the getHotspots() method.

```php
array(1) {  
  [0] => array(6) {  
    ["top"] => float(36.8)  
    ["left"] => float(39.5)  
    ["width"] => int(5)  
    ["height"] => float(6.6666666666667)  
    ["data"] => array(2) {  
      [0] => object(Pimcore\Model\Element\Data\MarkerHotspotItem)#171 (3) {  
        ["name"] => string(30) "checkbox_data_added_to_hotspot"  
        ["type"] => string(8) "checkbox"  
        ["value"] => bool(true)  
      }  
      [1] => object(Pimcore\Model\Element\Data\MarkerHotspotItem)#172 (3) {  
        ["name"] => string(28) "object_data_added_to_hotspot"  
        ["type"] => string(6) "object"  
        ["value"] => int(6)  
      }  
    }  
    ["name"] => NULL  
  }  
}
```

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

### Hotspot Data Structure Example

Source: https://docs.pimcore.com/platform/Pimcore/Objects/Object_Classes/Data_Types/Image_Types

Example of the array structure returned by the getHotspots() method.

```text
Array  
(  
    [0] => Array  
        (  
            [name] => hotspot1  
            [top] => 3.8922155688623  
            [left] => 48.076923076923  
            [width] => 8.3333333333333  
            [height] => 48.802395209581  
        )  
   
    [1] => Array  
        (  
            [name] => hotspot2  
            [top] => 8.9820359281437  
            [left] => 70.897435897436  
            [width] => 14.230769230769  
            [height] => 44.011976047904  
        )  
   
)
```

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

### Data Object Payload Example

Source: https://docs.pimcore.com/platform/Datahub_Webhooks/Request_Structure

Example payload for a Data Object update event.

```json
{
  "general": {  
    "eventName": "pimcore.dataobject.postUpdate",  
    "timestamp": 1690975273,  
    "subjectType": "object",  
    "versionOnly": false  
  },
  "subject": {  
    "id": 260,  
    "path": "/Product Data/Cars/alfa romeo/1900",  
    "name": "1900",  
    "description": "<p>The Alfa Romeo 1900 is an automobile produced by Alfa Romeo from 1950 to 1959.</p>",  
    "userModification": 25,  
    "userModificationName": "admin",  
    "published": false,  
    "type": "Car"  
  }
}
```

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

### Asset Translation Example

Source: https://docs.pimcore.com/platform/Copilot/Included_Actions/AI_Integrations_Powered_By_Hugging_Face/Hugging_Face_Automated_Translation

Example configuration for translating asset metadata from English to Spanish.

```yaml
model_endpoint: '<YOUR_ENDPOINT_URL>'  
input_source: 'subject'  
output_targets:  
  save_on_subject: true  
  save_on_execution_context: true  
input_field: CarImages.title  
input_language: en  
output_field: CarImages.title  
output_language: es  
options:  
  use_cache: false  
```

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

### Example Output for getMarker

Source: https://docs.pimcore.com/platform/Pimcore/Documents/Templates/Editables/Image

Shows the structure of the array returned by the getMarker() method.

```php
array(1) {  
  [0] => array(4) {  
    ["top"] => float(35.466666666667)  
    ["left"] => float(69.9)  
    ["data"] => array(1) {  
      [0] => object(Pimcore\Model\Element\Data\MarkerHotspotItem)#173 (3) {  
        ["name"] => string(31) "Textarea data added to the marker"  
        ["type"] => string(8) "textarea"  
        ["value"] => string(38) "Here is a description of marked place."  
      }  
    }  
    ["name"] => NULL  
  }  
}
```

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

### Start Symfony Messenger Worker

Source: https://docs.pimcore.com/platform/Data_Importer/Installation

Run this command to start a worker for the pimcore_data_import transport.

```bash
bin/console messenger:consume pimcore_data_import  
```

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

### Install bundle dependencies

Source: https://docs.pimcore.com/platform/Statistics_Explorer/Installation_and_Configuration

Use Composer to add the Statistics Explorer bundle to your project.

```bash
composer require pimcore/statistics-explorer
```

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

### Define Installer Service

Source: https://docs.pimcore.com/platform/Pimcore/Extending_Pimcore/Pimcore_Bundle_Developers_Guide/Pimcore_Bundles/Installers

Register the installer as a public service in your bundle's service configuration.

```yaml
services:  
    App\Installer:  
        public: true  
```

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

### Implementing PDF Configuration Listener for PDF/X Conformance

Source: https://docs.pimcore.com/platform/Web_To_Print/Web2Print_Extending_Config_for_PDFX_conformance

Example implementation to configure PDF/X conformance settings for the PDF Reactor processor.

```php
<?php   
namespace App\EventListener;  
  
class PDFConfigListener  
{  
    public function modifyProcessingOptions(\Pimcore\Bundle\WebToPrintBundle\Event\Model\PrintConfigEvent $event): void  
    {  
        //optionally add some configuration options for user interface here - e.g. some select options for user  
    }  
  
    public function modifyConfig(\Pimcore\Bundle\WebToPrintBundle\Event\Model\PrintConfigEvent $event): void  
    {  
        $arguments = $event->getArguments();  
  
        $processor = $event->getProcessor();  
        if($processor instanceof \Pimcore\Bundle\WebToPrintBundle\Processor\PdfReactor) {  
              
            //Set pdf reactor config for generating PDF/X conform PDF    
            $arguments['reactorConfig']['conformance'] = \Conformance::PDFX4;  
            $arguments['reactorConfig']["outputIntent"] = [  
                'identifier' => "ISO Coated v2 300% (ECI)",  
                'data' => base64_encode(file_get_contents('/path-to-color-profile/ISOcoated_v2_300_eci.icc'))  
            ];  
        }  
  
        $event->setArguments($arguments);  
    }  
}  
```

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

### Configuring Automation Action Steps

Source: https://docs.pimcore.com/platform/Copilot/Extending_Copilot/Extending_Automation_Actions/Implement_Custom_Job_Steps

Example YAML configuration for a custom step implementation including specific configuration options.

```yaml
steps:  
    - step_implementation: 'variant_generator'  
      name: 'Generate Variants'  
      condition: 'Symfony Expression can be used here'  
      configuration:  
          class_name: 'Pimcore\Model\DataObject\Car'  
          matrix_variable: Variants  
```

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

### Initialize Local Test Environment

Source: https://docs.pimcore.com/platform/Studio_Backend/Development_Details/API_Testing

Commands to navigate to the test directory and execute the environment boot script.

```bash
cd tests/Api  
sudo chmod +x boot-test-env.sh  
./boot-test-env.sh  
```

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

### Create Bootstrap File

Source: https://docs.pimcore.com/platform/Pimcore/Development_Details/Testing/Application_Testing

PHP script to initialize the Pimcore project root and bootstrap the application before test execution.

```php
<?php  
  
// tests/bootstrap.php  
  
include "../../vendor/autoload.php";  
  
\Pimcore\Bootstrap::setProjectRoot();  
\Pimcore\Bootstrap::bootstrap();
```

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

### Pimcore Controller Implementation Examples

Source: https://docs.pimcore.com/platform/Pimcore/Documents/Controller

Demonstrates standard controller actions including template rendering, attribute-based view resolution, response headers, and JSON responses.

```php
<?php  
  
namespace App\Controller;  
  
use Pimcore\Controller\FrontendController;  
use Symfony\Component\HttpFoundation\JsonResponse;  
use Symfony\Component\HttpFoundation\Request;  
use Symfony\Component\HttpFoundation\Response;  
use Pimcore\Controller\Attribute\ResponseHeader;  
  
class DefaultController extends FrontendController  
{     
    /**  
    * Very simple example using $this->render() and passing the parameter 'foo'  
    */  
    public function myAction(): Response  
    {  
        return $this->render('content/default.html.twig', ["foo" => "bar"]);  
    }  
  
    /**  
     * Example using the #[Template] attribute to resolve the view.   
     * The frontend controller also provides methods to add response headers or via attributes without having  
     * access to the final response object (as it is automatically created when rendering the view).  
     *  
     */  
     #[Template('/default/header.html.twig')]  
     #[ResponseHeader(key: "X-Foo", values: ["123456", "98765"])]  
    public function headerAction(Request $request): array  
    {  
        // schedule a response header via code  
        $this->addResponseHeader('X-Foo', 'bar', false, $request);  
          
        return ["foo" => "bar"];  
    }  
      
    /**  
     * This action returns a JSON response.   
    */  
    public function jsonAction(Request $request): JsonResponse  
    {  
        return $this->json(array('key' => 'value'));  
    }  
      
    /**  
     * This returns a standard symfony Response object   
    */  
    public function customAction(Request $request): Response  
    {  
        return new Response("Just some text");  
    }  
}  
```

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

### Workflow Event Payload Example

Source: https://docs.pimcore.com/platform/Datahub_Webhooks/Request_Structure

Example payload for a workflow event, including the workflowData section.

```json
{
  "workflowData": {  
    "workflow": {  
      "name": "product_approval"  
    },
    "transition": {  
      "name": "submit",  
      "options": [],  
      "froms": ["draft"],  
      "tos": ["review"]  
    },
    "marking": {  
      "places": {  
        "review": 1  
      }
    }
  },
  "general": {  
    "eventName": "workflow.entered",  
    "timestamp": 1690975273,  
    "subjectType": "object",  
    "versionOnly": false  
  },
  "subject": {  
    "id": 260,  
    "path": "/Product Data/Cars/alfa romeo/1900",  
    "userModification": 25,  
    "userModificationName": "admin",  
    "published": true,  
    "type": "Car"  
  }
}
```

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

### Instantiating a PostInstallCommand

Source: https://docs.pimcore.com/platform/Getting_Started/Installation/Advanced_Installation_Topics/Post_Install_Commands

Creates a value object representing a console command to be executed during the installation process.

```php
use Pimcoreundle
InstallBundle
Profile
PostInstallCommand;  
  
new PostInstallCommand(  
    command: 'app:import-fixtures',  
    label: 'Importing project fixtures',  
    priority: 50,  
    arguments: ['--env=prod'],  
);
```

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

### Field Level Response Example

Source: https://docs.pimcore.com/platform/Datahub/GraphQL/Query/Localization

Example JSON response showing localized field values.

```json
{
  "data": {
    "getUser": {
      "myAdvancedObjects": [
        {
          "element": {
            "id": "8",
            "classname": "news",
            "title": "In enim justo",
            "deTitle": "Li Europan lingues es membres",
            "shortText": "Lor separat existentie es un myth. Por scientie, musica, sport etc, litot Europa usa li sam vocabular."
          },
          "metadata": [
            {
              "name": "altname",
              "value": "Ratman"
            },
            {
              "name": "name",
              "value": "Canine"
            }
          ]
        },
        {
          "element": {
            "id": "3",
            "classname": "news",
            "title": "Lorem ipsum dolor sit amet",
            "deTitle": "Er hörte leise Schritte hinter sich",
            "shortText": "Das bedeutete nichts Gutes. Wer würde ihm schon folgen, spät in der Nacht und dazu noch in dieser engen Gasse mitten im übel beleumundeten Hafenviertel?"
          },
          "metadata": [
            {
              "name": "altname",
              "value": "Spike"
            },
            {
              "name": "name",
              "value": "Doctor"
            }
          ]
        }
      ]
    }
  }
}


```

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

### Initialize Filter Service in Controller

Source: https://docs.pimcore.com/platform/Ecommerce_Framework/Filter_Service

Demonstrates how to instantiate the Filter Service and configure a product listing with KnpPaginator within a controller action.

```php
<?php   
$ecommerceFactory = \Pimcore\Bundle\EcommerceFrameworkBundle\Factory::getInstance();  
  
$templateParams = [];  
$params = array_merge($request->query->all(), $request->attributes->all());  
  
$indexService = $ecommerceFactory->getIndexService();  
$productListing = $indexService->getProductListForCurrentTenant();  
$templateParams['productListing'] = $productListing;  
  
//get filter definition from document, category or global settings  
$filterDefinition = //TODO ...get from somewhere;  
  
// create and init filter service  
$filterService = $ecommerceFactory->getFilterService();  
(new \Pimcore\Bundle\EcommerceFrameworkBundle\FilterService\ListHelper)->setupProductList($filterDefinition, $productListing, $params, $filterService, true, true);  
$templateParams['filterService'] = $filterService;  
$templateParams['filterDefinition'] = $filterDefinition;  
  
// inject and use Knp Paginator service: PaginatorInterface $paginator  
$paginator = $paginator->paginate(  
    $productListing,  
    $request->get('page', 1),  
    18  
);  
$templateParams['results'] = $paginator;  
$templateParams['paginationVariables'] = $paginator->getPaginationData();  
  
return $this->render('Path/template.html.twig', $templateParams);
```

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

### Execute Custom Install Profile

Source: https://docs.pimcore.com/platform/Paas/Configuration

Updates the deployment script to use a custom project-specific install profile.

```bash
php vendor/bin/pimcore-install --install-profile='App\Install\MyProjectProfile' --no-interaction  
```

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

### Initialize index mapping and indices

Source: https://docs.pimcore.com/platform/Datahub_Simple_Rest/Installation

Run these commands after configuring the search client to prepare the indices.

```bash
bin/console datahub:simple-rest:create-or-update-mapping  
bin/console datahub:simple-rest:init-index
```

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

### Create the Pimcore skeleton project

Source: https://docs.pimcore.com/platform/Getting_Started/Installation/Skeleton_Installation

Initializes a new project directory using the Pimcore skeleton template via Docker.

```bash
docker run -u `id -u`:`id -g` --rm -v `pwd`:/var/www/html pimcore/pimcore:php8.5-latest composer create-project pimcore/skeleton --no-scripts my-project  
cd my-project/  
```
Tokens:
Raw