### Start Apache Service (Windows)

Source: https://github.com/ibexa/documentation-developer/blob/5.0/docs/getting_started/install_on_mac_os_and_windows.md

Start the Apache service after installing it.

```bash
httpd.exe -k start
```

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

### Install Remote PIM Example Package

Source: https://github.com/ibexa/documentation-developer/blob/5.0/docs/product_catalog/add_remote_pim_support.md

Add the example in-memory product catalog package to your project. This package provides a foundation for custom PIM integrations.

```bash
composer config repositories.remote-pim vcs https://github.com/ibexa/example-in-memory-product-catalog
composer require ibexa/example-in-memory-product-catalog:

```

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

### Install Ibexa Cloud Package and Setup

Source: https://github.com/ibexa/documentation-developer/blob/5.0/docs/ibexa_cloud/install_on_ibexa_cloud.md

Run these commands to add the necessary package and configuration files for Ibexa Cloud.

```bash
composer require ibexa/cloud
php/bin/console ibexa:cloud:setup --upsun
```

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

### Install Ibexa DXP and Create Database

Source: https://github.com/ibexa/documentation-developer/blob/5.0/docs/getting_started/install_ibexa_dxp.md

Run this command to install Ibexa DXP and create the necessary database. The installer will prompt for an admin user password. Ensure the database user has sufficient permissions.

```bash
php bin/console ibexa:install
```

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

### Install Experience Recipes

Source: https://github.com/ibexa/documentation-developer/blob/5.0/docs/update_and_migration/from_5.0/update_from_5.0.md

Force install the recipes for Ibexa Experience to apply necessary configurations.

```bash
composer recipes:install ibexa/experience --force -v
```

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

### Install Commerce Recipes

Source: https://github.com/ibexa/documentation-developer/blob/5.0/docs/update_and_migration/from_5.0/update_from_5.0.md

Force install the recipes for Ibexa Commerce to apply necessary configurations.

```bash
composer recipes:install ibexa/commerce --force -v
```

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

### Product Attributes GET Example

Source: https://github.com/ibexa/documentation-developer/blob/5.0/docs/api/rest_api/rest_api_reference/rest_api_reference.html

Example JSON response for retrieving a list of product attributes. This endpoint is deprecated.

```json
{
  "AttributeList": {
    "_media-type": "application/vnd.ibexa.api.AttributeList+json",
    "Attribute": [
      {
        "_media-type": "application/vnd.ibexa.api.Attribute+json",
        "identifier": "attrib1",
        "name": "Attrib1",
        "description": "",
        "type": "Checkbox",
        "type_identifier": "checkbox",
        "value": true,
        "group": "Attribute Group Test",
        "position": 0,
        "options": []
      },
      {
        "_media-type": "application/vnd.ibexa.api.Attribute+json",
        "identifier": "attrib2",
        "name": "Attrib2",
        "description": "",
        "type": "Checkbox",
        "type_identifier": "checkbox",
        "value": true,
        "group": "Attribute Group Test",
        "position": 0,
        "options": []
      },
      {
        "_media-type": "application/vnd.ibexa.api.Attribute+json",
        "identifier": "attrib3",
        "name": "Attrib3",
        "description": "",
        "type": "Checkbox",
        "type_identifier": "checkbox",
        "value": true,
        "group": "Attribute Group Test",
        "position": 0,
        "options": []
      }
    ]
  }
}
```

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

### Install Documentation Dependencies

Source: https://github.com/ibexa/documentation-developer/blob/5.0/README.md

Installs the necessary Python packages for building and previewing the documentation locally. Ensure Python and pip are installed first.

```bash
pip install -r requirements.txt
```

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

### Install Headless Recipes

Source: https://github.com/ibexa/documentation-developer/blob/5.0/docs/update_and_migration/from_5.0/update_from_5.0.md

Force install the recipes for Ibexa Headless to apply necessary configurations.

```bash
composer recipes:install ibexa/headless --force -v
```

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

### Get Action Configuration XML Example

Source: https://github.com/ibexa/documentation-developer/blob/5.0/docs/api/rest_api/rest_api_reference/rest_api_reference.html

Example response for retrieving an AI action configuration in XML format. It details the 'rewrite_with_friendly_tone' action, including its handler, options, and timestamps.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<ActionConfiguration media-type="application/vnd.ibexa.api.ai.ActionConfiguration+xml">
 <identifier>rewrite_with_friendly_tone</identifier>
 <name>Rewrite in friendly tone</name>
 <description></description>
 <enabled>1</enabled>
 <ActionType media-type="application/vnd.ibexa.api.ai.ActionType+xml">
 <identifier>refine_text</identifier>
 <name>Refine text</name>
 <inputIdentifier>text</inputIdentifier>
 <outputIdentifier>text</outputIdentifier>
 <options/>
 </ActionType>
 <actionTypeOptions/>
 <actionHandlerIdentifier>openai-text-to-text</actionHandlerIdentifier>
 <actionHandlerOptions>
 <max_tokens>4000</max_tokens>
 <temperature>1</temperature>
 <prompt>Rewrite text in friendly tone. Preserve meaning and crucial information.</prompt>
 <model>gpt-4-turbo</model>
 </actionHandlerOptions>
 <createdAt>2025-08-07T13:16:47+02:00</createdAt>
 <updatedAt>2025-08-07T13:16:47+02:00</updatedAt>
</ActionConfiguration>

```

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

### Install and Configure Solr with DDEV

Source: https://github.com/ibexa/documentation-developer/blob/5.0/docs/infrastructure_and_maintenance/clustering/clustering_with_ddev.md

Installs the Solr add-on, configures it as the search engine, sets the DSN and core, starts the DDEV cluster, copies Solr configuration files, restarts the cluster, clears cache, and reindexes content. Use this to integrate Solr for search functionality.

```bash
ddev add-on get ddev/ddev-solr
ddev config --web-environment-add SEARCH_ENGINE=solr
ddev config --web-environment-add SOLR_DSN=http://solr:8983/solr
ddev config --web-environment-add SOLR_CORE=collection1
ddev start
mkdir .ddev/solr/configsets/collection1
ddev exec -s solr cp -R /opt/solr/server/solr/configsets/_default/conf/* /mnt/ddev_config/solr/configsets/collection1/
cp -R vendor/ibexa/solr/src/lib/Resources/config/solr/* .ddev/solr/configsets/collection1/
ddev restart
ddev php bin/console cache:clear
ddev php bin/console ibexa:reindex
```

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

### Apply Ibexa Experience Recipe

Source: https://github.com/ibexa/documentation-developer/blob/5.0/docs/update_and_migration/from_4.6/update_to_5.0.md

Use this command to install the Ibexa Experience recipe. Ensure you have Composer installed.

```bash
composer recipes:install ibexa/experience --reset --force --yes
```

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

### Create Policy Example (XML)

Source: https://github.com/ibexa/documentation-developer/blob/5.0/docs/api/rest_api/rest_api_reference/rest_api_reference.html

This example demonstrates creating a policy using XML format, specifying module, function, and limitations.

```xml
<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<PolicyCreate>\n <module>content</module>\n <function>create</function>\n <limitations>\n <limitation identifier=\"Class\">\n <values>\n <ref href=\"2\"/>\n </values>\n </limitation>\n <limitation identifier=\"ParentClass\">\n <values>\n <ref href=\"1\"/>\n </values>\n </limitation>\n </limitations>\n</PolicyCreate>
```

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

### GET Request Example

Source: https://github.com/ibexa/documentation-developer/blob/5.0/docs/api/rest_api/rest_api_reference/rest_api_reference.html

This snippet demonstrates how to make a GET request to retrieve data from a specific endpoint. Ensure you have the correct API key and endpoint URL.

```bash
curl -X GET "https://api.example.com/v1/resource" \
     -H "Authorization: Bearer YOUR_API_KEY" \
     -H "Content-Type: application/json"
```

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

### Load Policies Example (XML)

Source: https://github.com/ibexa/documentation-developer/blob/5.0/docs/api/rest_api/rest_api_reference/rest_api_reference.html

This example demonstrates how to load policies for a given role, with the response formatted in XML.

```xml
<Policy href=\"5\" media-type=\"application/vnd.ibexa.api.Policy+xml\">\n <id>5</id>\n <module>content</module>\n <function>create</function>\n <limitations>\n <limitation identifier=\"Class\">\n <values>\n <ref media-type=\"application/vnd.ibexa.api.ref+xml\" href=\"5\"/>\n <ref media-type=\"application/vnd.ibexa.api.ref+xml\" href=\"12\"/>\n </values>\n </limitation>\n </limitations>\n </Policy>\n <Policy media-type=\"application/vnd.ibexa.api.Policy+xml\" href=\"352\">\n <id>352</id>\n <module>user</module>\n <function>register</function>\n </Policy>\n <Policy media-type=\"application/vnd.ibexa.api.Policy+xml\" href=\"353\">\n <id>353</id>\n <module>user</module>\n <function>password</function>\n </Policy>
```

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

### Tracking code quickstart

Source: https://github.com/ibexa/documentation-developer/blob/5.0/docs/personalization/tracking_with_ibexa-tracker.md

A quickstart guide to integrate the Personalization JavaScript tracker into your website pages. This involves including the tracker script and using the _ycq.push method to set the mandator and track events.

```APIDOC
## Tracking code quickstart

The Personalization JavaScript is a Google-like tracking API (ga.js) that you can paste into your pages. It activates the tracking by inserting <https://cdn.perso.ibexa.co/ibexa-tracker.js> or <https://cdn.perso.ibexa.co/ibexa-tracker.min.js> into the page.

To use this mechanism on your pages, copy the code snippet below, and replace:

- `<YOUR_MANDATOR_ID>` with the customer ID
- `<CONTENT_TYPE_ID>` with the content type ID
- `<CONTENT_ID>` with the content item ID
- `<USER_ID>` with an empty string for cookie based anonymous user or with the value generated by your user identifier system for logged-in user. In case user activity should not be tracked, 'not_defined' value should be used to still have an event stored without a link to the user.

All identifiers can be any form of string.
Paste this snippet into your website template page so that it appears before the closing `</head>` tag.

``` js
<script type="text/javascript">
  var _ycq = _ycq || [];
  _ycq.push(['_setMandator', '<YOUR_MANDATOR_ID>']);
  _ycq.push(['_trackEvent', '<CONTENT_TYPE_ID>', 'click', '<CONTENT_ID>', '<USER_ID>']);

  (function() {
    var yc = document.createElement('script');
    yc.type = 'text/javascript';
    yc.async = true;
    yc.src = ('https:' == document.location.protocol ? 'https://' : 'http://') + 'cdn.perso.ibexa.co/ibexa-tracker.min.js';
    var ycs = document.getElementsByTagName('script')[0];
    ycs.parentNode.insertBefore(yc, ycs);
  })();

</script>
```
```

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

### Create View Example

Source: https://github.com/ibexa/documentation-developer/blob/5.0/docs/api/rest_api/rest_api_reference/rest_api_reference.html

Example of creating a content view with specific query parameters, sorting, and faceting. Returns a ViewResult.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<View href="/views/TitleView" media-type="application/vnd.ibexa.api.View+xml; version=1.1">
 <identifier>TitleView</identifier>
 <User href="/user/users/14" media-type="vnd.ibexa.api.User+xml"/>
 <public>false</public>
 <LocationQuery>
 <Filter>
 <ParentLocationIdCriterion>2</ParentLocationIdCriterion>
 </Filter>
 <limit>10</limit>
 <offset>0</offset>
 <SortClauses>
 <ContentName>ascending</ContentName>
 </SortClauses>
 <FacetBuilders>
 <contentTypeFacetBuilder/>
 </FacetBuilders>
 </LocationQuery>
 <Result href="/content/views/view1234/results"
 media-type="application/vnd.ibexa.api.ViewResult+xml" count="34" time="31" maxScore="1.0">
 <searchHits>
 <searchHit score="1.0" index="installid1234567890">
 <hightlight/>
 <value>
 <Location media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1/2">
 <id>2</id>
 <priority>0</priority>
 <hidden>false</hidden>
 <invisible>false</invisible>
 <ParentLocation media-type="application/vnd.ibexa.api.Location+xml" href="/api/ibexa/v2/content/locations/1"/>
 <pathString>/1/2/</pathString>
 <depth>1</depth>
 <childCount>8</childCount>
 <remoteId>f3e90596361e31d496d4026eb624c983</remoteId>
 <Children media-type="application/vnd.ibexa.api.LocationList+xml" href="/api/ibexa/v2/content/locations/1/2/children"/>
 <Content media-type="application/vnd.ibexa.api.Content+xml" href="/api/ibexa/v2/content/objects/57"/>
 <sortField>PRIORITY</sortField>
 <sortOrder>ASC</sortOrder>
 <UrlAliases media-type="application/vnd.ibexa.api.UrlAliasRefList+xml" href="/api/ibexa/v2/content/locations/1/2/urlaliases"/>
 </Location>

 </value>
 </searchHit>
 <!-- ... 
```

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

### Manage Shopping List via REST API

Source: https://github.com/ibexa/documentation-developer/blob/5.0/docs/commerce/shopping_list/shopping_list_api.md

This example demonstrates how to log in, find, clear, and add products to a shopping list using `curl` and `jq`. It requires prior setup for authentication and assumes a default shopping list exists.

```bash
curl -X POST https://example.com/api/authentication/login -d "username=user&password=password" -c cookies.txt
curl -X GET https://example.com/api/shopping-list/me -b cookies.txt -c cookies.txt | jq '.[] | select(.name=="Default") | .identifier' > shopping_list_id.txt
if [ -s shopping_list_id.txt ]; then
    SHOPPING_LIST_ID=$(cat shopping_list_id.txt)
    curl -X DELETE https://example.com/api/shopping-list/$SHOPPING_LIST_ID/entries -b cookies.txt -c cookies.txt
fi
curl -X POST https://example.com/api/shopping-list/add-product -d "product_id=123&quantity=1" -b cookies.txt -c cookies.txt
```

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

### Start DDEV Environment

Source: https://github.com/ibexa/documentation-developer/blob/5.0/docs/getting_started/install_with_ddev.md

Start the DDEV environment after configuration.

```bash
ddev start
```

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

### Install Google Gemini Connector

Source: https://github.com/ibexa/documentation-developer/blob/5.0/docs/ai/ai_actions/configure_ai_actions.md

Install the Ibexa Gemini connector package using Composer.

```bash
composer require ibexa/connector-gemini
```

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

### Install Apache as Windows Service

Source: https://github.com/ibexa/documentation-developer/blob/5.0/docs/getting_started/install_on_mac_os_and_windows.md

Run this command in CMD as administrator to install Apache as a Windows service.

```bash
httpd.exe -k -install
```

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

### Install Ibexa DXP Platform and Database

Source: https://github.com/ibexa/documentation-developer/blob/5.0/docs/getting_started/install_with_ddev.md

Install the Ibexa DXP platform and its database. The installer will prompt for an admin user password that meets specific complexity requirements.

```bash
ddev php bin/console ibexa:install
```

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

### Install PNG Optimizer

Source: https://github.com/ibexa/documentation-developer/blob/5.0/docs/content_management/images/images.md

Installs the OptiPNG library using apt-get for PNG image optimization.

```bash
sudo apt-get install optipng
```

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

### Create Policy Example (JSON)

Source: https://github.com/ibexa/documentation-developer/blob/5.0/docs/api/rest_api/rest_api_reference/rest_api_reference.html

This example shows how to create a new policy for a user role, with the request and response in JSON format.

```json
{
 "Policy": {
 "_media-type": "application/vnd.ibexa.api.Policy+json",
 "_href": "/api/ibexa/v2/user/roles/1/policies/352",
 "id": 352,
 "module": "user",
 "function": "register"
 }
}
```

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

### Create Policy Response Example (XML)

Source: https://github.com/ibexa/documentation-developer/blob/5.0/docs/api/rest_api/rest_api_reference/rest_api_reference.html

This example shows the XML response after successfully creating a policy, including its details and limitations.

```xml
<Policy href=\"55\" media-type=\"application/vnd.ibexa.api.Policy+xml\">\n <id>55</id>\n <module>content</module>\n <function>create</function>\n <limitations>\n <limitation identifier=\"Class\">\n <values>\n <ref href=\"/content/types/14\"/>\n </values>\n </limitation>\n <limitation identifier=\"ParentClass\">\n <values>\n <ref href=\"10\"/>\n </values>\n </limitation>\n </limitations>\n </Policy>
```

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

### Install OAuth2 Server Package

Source: https://github.com/ibexa/documentation-developer/blob/5.0/docs/users/oauth_server.md

Install the Ibexa OAuth2 Server package and its dependencies using Composer.

```bash
composer require ibexa/oauth2-server --with-all-dependencies
```

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

### Populate Database and Launch Project

Source: https://github.com/ibexa/documentation-developer/blob/5.0/docs/getting_started/install_with_ddev.md

Install Ibexa DXP, migrate content types, and launch the project in the browser.

```bash
# Populate the database with a clean install
ddev php bin/console ibexa:install
# Add some content types using a migration file (previously created on another installation) and update the GraphQL schema
ddev php bin/console ibexa:migrations:migrate --file=project_content_types.yaml
# Open the project in the default browser which should display the default SiteAccess frontpage
ddev launch
```

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

### List URL Wildcards (XML Example)

Source: https://github.com/ibexa/documentation-developer/blob/5.0/docs/api/rest_api/rest_api_reference/rest_api_reference.html

Example of an XML response listing URL wildcards. This provides the same information as the JSON example but in XML format, detailing each wildcard's properties.

```xml
<?xml version=\"1.0\" encoding=\"UTF-8\"?>
<UrlWildcardList media-type=\"application/vnd.ibexa.api.UrlWildcardList+xml\" href=\" /api/ibexa/v2/content/urlwildcards\">
 <UrlWildcard media-type=\"application/vnd.ibexa.api.UrlWildcard+xml\" href=\" /api/ibexa/v2/content/urlwildcards/1\" id=\"1\">
 <sourceUrl>/api/ibexa/v2/content/location/2</sourceUrl>
 <destinationUrl>/api/ibexa/v2/content/location/59</destinationUrl>
 <forward>true</forward>
 </UrlWildcard>
</UrlWildcardList>

```

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

### Start Docker Compose with Site Factory

Source: https://github.com/ibexa/documentation-developer/blob/5.0/docs/multisite/site_factory/site_factory.md

Command to start the Docker environment with the necessary configuration files for Site Factory.

```bash
export COMPOSE_FILE="doc/docker/base-dev.yml:doc/docker/multihost.yml"
docker-compose up
```

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

### HTTP Response for GET Request (XML)

Source: https://github.com/ibexa/documentation-developer/blob/5.0/docs/api/rest_api/extending_rest_api/creating_new_rest_resource.md

Example HTTP response in XML format for a GET request to the greet resource.

```http
HTTP/1.1 200 OK
Content-Type: application/vnd.ibexa.api.greeting+xml

<?xml version="1.0" encoding="UTF-8"?>
<Greeting media-type="application/vnd.ibexa.api.Greeting+xml" href="/api/ibexa/v2/greet">
 <Salutation>Hello</Salutation>
 <Recipient>World</Recipient>
 <Sentence>Hello World</Sentence>
</Greeting>
```

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

### Set Up Local DDEV Project from Ibexa Cloud

Source: https://github.com/ibexa/documentation-developer/blob/5.0/docs/ibexa_cloud/ddev_and_ibexa_cloud.md

Use this command sequence to download your Ibexa Cloud project, configure DDEV, and set up local development environment. Ensure you replace `<project-ID>` with your actual project ID and `<installation-key>` and `<token-password>` with your Ibexa Cloud credentials.

```bash
ibexa_cloud project:get <project-ID> my-ddev-project && cd my-ddev-project
ddev config --project-type=php --php-version 8.3 --docroot=public --web-environment-add DATABASE_URL=mysql://db:db@db:3306/db
echo '.ddev/' >> .gitignore
ddev start
ddev composer config --global http-basic.updates.ibexa.co <installation-key> <token-password>
ibexa_cloud db:dump --gzip --file=production.sql.gz
ddev import-db --file=production.sql.gz && rm production.sql.gz
ibexa_cloud mount:download --mount public/var --target public/var
ddev composer install
ddev describe
ddev launch
```

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

### getStartTime

Source: https://github.com/ibexa/documentation-developer/blob/5.0/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Discounts-Admin-Form-Data-AbstractGeneralProperties.html

Gets the start time for the general properties.

```APIDOC
## getStartTime

### Description
Gets the start time for the general properties.

### Method
public final getStartTime()

### Return Values
DateTimeImmutable|null
```

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

### Apply Ibexa Headless Recipe

Source: https://github.com/ibexa/documentation-developer/blob/5.0/docs/update_and_migration/from_4.6/update_to_5.0.md

Use this command to install the Ibexa Headless recipe. Ensure you have Composer installed.

```bash
composer recipes:install ibexa/headless --reset --force --yes
```

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

### Apply Ibexa Commerce Recipe

Source: https://github.com/ibexa/documentation-developer/blob/5.0/docs/update_and_migration/from_4.6/update_to_5.0.md

Use this command to install the Ibexa Commerce recipe. Ensure you have Composer installed.

```bash
composer recipes:install ibexa/commerce --reset --force --yes
```

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

### Get Company Members (JSON Response Example)

Source: https://github.com/ibexa/documentation-developer/blob/5.0/docs/api/rest_api/rest_api_reference/rest_api_reference.html

This is an example of a successful JSON response when retrieving a list of members for a specific company.

```json
{
  "MemberList": {
    "_media-type": "application/vnd.ibexa.api.MemberList+json",
    "_href": "/api/ibexa/v2/corporate/companies/139/members",
    "members": [
      {
        "_media-type": "application/vnd.ibexa.api.Member+json",
        "_href": "/api/ibexa/v2/corporate/companies/139/members/144",
        "id": 144,
        "name": "Jay Kowalski",
        "Company": {
          "_media-type": "application/vnd.ibexa.api.Company+json",
          "id": 139,
          "name": "Ibexa Sp. z o. o.",
          "Content": {
            "_media-type": "application/vnd.ibexa.api.Content+json",
            "_href": "/api/ibexa/v2/content/objects/139",
            "_remoteId": "b16d06d4c5ba7c37b26fa167b551dfc2",
            "_id": 139,
            "ContentType": {
              "_media-type": "application/vnd.ibexa.api.ContentType+json",
              "_href": "/api/ibexa/v2/content/types/48"
            },
            "Name": "Ibexa Sp. z o. o.",
            "TranslatedName": "Ibexa Sp. z o. o.",
            "Versions": {
              "_media-type": "application/vnd.ibexa.api.VersionList+json",
              "_href": "/api/ibexa/v2/content/objects/139/versions"
            },
            "CurrentVersion": {
              "_media-type": "application/vnd.ibexa.api.Version+json",
              "_href": "/api/ibexa/v2/content/objects/139/currentversion",
              "Version": {
                "_media-type": "application/vnd.ibexa.api.Version+json",
                "_href": "/api/ibexa/v2/content/objects/139/versions/6",
                "VersionInfo": {
                  "id": 677,
                  "versionNo": 6,
                  "status": "PUBLISHED",
                  "modificationDate": "2023-04-28T16:10:13+02:00",
                  "Creator": {
                    "_media-type": "application/vnd.ibexa.api.User+json",
                    "_href": "/api/ibexa/v2/user/users/14"
                  },
                  "creationDate": "2023-04-28T16:10:13+02:00",
                  "initialLanguageCode": "eng-GB",
                  "languageCodes": "eng-GB",
                  "VersionTranslationInfo": {
                    "_media-type": "application/vnd.ibexa.api.VersionTranslationInfo+json",
                    "Language": [
                      {
                        "languageCode": "eng-GB"
                      }
                    ]
                  },
                  "names": {
                    "value": [
                      {
                        "_languageCode": "eng-GB",
                        "#text": "Ibexa Sp. z o. o."
                      }
                    ]
                  },
                  "Content": {
                    "_media-type": "application/vnd.ibexa.api.ContentInfo+json",
                    "_href": "/api/ibexa/v2/content/objects/139"
                  }
                }
              }
            }
          }
        }
      }
    ]
  }
}
```

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

### Install Ibexa DXP with Limited RAM

Source: https://github.com/ibexa/documentation-developer/blob/5.0/docs/getting_started/troubleshooting.md

When installing on systems with limited RAM, enable swap space to allow the operating system to use disk storage as virtual RAM. This command allows the installation to proceed even with memory constraints.

```bash
php -d memory_limit=-1 bin/console ibexa:install
```

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

### getStartDate()

Source: https://github.com/ibexa/documentation-developer/blob/5.0/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Discounts-Value-DiscountInterface.html

Gets the start date of the discount's validity.

```APIDOC
## getStartDate()

### Description
Gets the start date of the discount's validity.

### Method
GET

### Endpoint
N/A (This is an interface method, not an HTTP endpoint)

### Return Value
DateTimeInterface
```

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

### Start Ibexa Messenger Worker

Source: https://github.com/ibexa/documentation-developer/blob/5.0/docs/infrastructure_and_maintenance/background_tasks.md

Command to start a background worker for consuming messages from the 'ibexa.messenger.transport'. Use the `--siteaccess` option for multi-repository setups.

```bash
php bin/console messenger:consume ibexa.messenger.transport --bus=ibexa.messenger.bus --siteaccess=<OPTIONAL>
```

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

### Install Ibexa Cloud Package

Source: https://github.com/ibexa/documentation-developer/blob/5.0/docs/update_and_migration/from_5.0/update_from_5.0.md

Install the 'ibexa/cloud' package using Composer. This is a prerequisite for updating cloud configurations.

```bash
composer require ibexa/cloud
```

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

### Configure Local Ibexa Cloud Project with DDEV Add-ons

Source: https://github.com/ibexa/documentation-developer/blob/5.0/docs/ibexa_cloud/ddev_and_ibexa_cloud.md

This sequence of commands sets up a DDEV project for Ibexa Cloud using specific add-ons. It involves downloading the project, configuring DDEV, setting up authentication, and pulling cloud content. Ensure you replace placeholders like `<project-ID>`, `<api-token>`, and `<path-to-an>/auth.json` with your actual values.

```bash
ibexa_cloud project:get <project-ID> my-ddev-project && cd my-ddev-project
ddev config --project-type=php --php-version 8.3 --web-environment-add COMPOSER_AUTH='',DATABASE_URL=mysql://db:db@db:3306/db
ddev config --web-environment-add IBEXA_PROJECT=<project-ID>,IBEXA_ENVIRONMENT=production,IBEXA_APP=app
ddev config --web-environment-add IBEXA_CLI_TOKEN=<api-token>
echo '.ddev/' >> .gitignore
mkdir -p .ddev/homeadditions/.composer && cp <path-to-an>/auth.json .ddev/homeadditions/.composer
ddev add-on get ddev/ddev-upsun
sed -i 's/maxmemory-policy allkeys-lfu/maxmemory-policy volatile-lfu/' .ddev/redis/redis.conf
ddev add-on get ddev/ddev-ibexa-cloud
ddev start
ddev pull ibexa-cloud -y
ddev describe
ddev launch
```

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

### Install Ibexa Experience Recipes

Source: https://github.com/ibexa/documentation-developer/blob/5.0/docs/update_and_migration/from_3.3/update_from_3.3.md

After updating the Flex server configuration, install the Ibexa Experience recipes. Use the --force flag to overwrite existing recipes and -v for verbose output. Follow with a post-install command.

```bash
composer recipes:install ibexa/experience --force -v
composer run post-install-cmd
```

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

### Get Content Type Draft Response (JSON)

Source: https://github.com/ibexa/documentation-developer/blob/5.0/docs/api/rest_api/rest_api_reference/rest_api_reference.html

Example JSON response for retrieving a content type draft, including its metadata, field definitions, and various properties. This example is truncated.

```json
{"ContentType":{"_media-type":"application/vnd.ibexa.api.ContentType+json","_href":"/api/ibexa/v2/content/types/2","id":2,"status":"DEFINED","identifier":"article","names":{"value":[{"_languageCode":"eng-GB","#text":"Article"}]},"descriptions":{"value":[{"_languageCode":"eng-GB","#text":null}]},"creationDate":"2002-06-18T09:21:38+00:00","modificationDate":"2021-06-28T11:31:22+00:00","Creator":{"_media-type":"application/vnd.ibexa.api.User+json","_href":"/api/ibexa/v2/user/users/14"},"Modifier":{"_media-type":"application/vnd.ibexa.api.User+json","_href":"/api/ibexa/v2/user/users/14"},"Groups":{"_media-type":"application/vnd.ibexa.api.ContentTypeGroupRefList+json","_href":"/api/ibexa/v2/content/types/2/groups"},"Draft":{"_media-type":"application/vnd.ibexa.api.ContentType+json","_href":"/api/ibexa/v2/content/types/2/draft"},"remoteId":"c15b600eb9198b1924063b5a68758232","urlAliasSchema":"","nameSchema":"<short_title|title>","isContainer":true,"mainLanguageCode":"eng-GB","defaultAlwaysAvailable":false,"defaultSortField":"PATH","defaultSortOrder":"ASC","FieldDefinitions":{"_media-type":"application/vnd.ibexa.api.FieldDefinitionList+json","_href":"/api/ibexa/v2/content/types/2/fieldDefinitions","FieldDefinition":[{"_media-type":"application/vnd.ibexa.api.FieldDefinition+json","_href":"/api/ibexa/v2/content/types/2/fieldDefinitions/1","id":1,"identifier":"title","fieldType":"ibexa_string","fieldGroup":"","position":1,"isTranslatable":true,"isRequired":true,"isInfoCollector":false,"defaultValue":"New article","isSearchable":true,"names":{"value":[{"_languageCode":"eng-GB","#text":"Title"}]},"descriptions":{"value":[{"_languageCode":"eng-GB","#text":null}]},"fieldSettings":[],"validatorConfiguration":{"StringLengthValidator":{"maxStringLength":255,"minStringLength":null}}},{"_media-type":"application/vnd.ibexa.api.FieldDefinition+json","_href":"/api/ibexa/v2/content/types/2/fieldDefinitions/152","id":152,"identifier":"short_title","fieldType":"ibexa_string","fieldGroup":"","position":2,"isTranslatable":true,"isRequired":false,"isInfoCollector":false,"defaultValue":null,"isSearchable":true,"names":{"value":[{"_languageCode":"eng-GB","#text":"Short title"}]},"descriptions":{"value":[{"_languageCode":"eng-GB","#text":null}]},"fieldSettings":[],"validatorConfiguration":{"StringLengthValidator":{"maxStringLength":255,"minStringLength":null}}},{"_media-type":"application/vnd.ibexa.api.FieldDefinition+json","_href":"/api/ibexa/v2/content/types/2/fieldDefinitions/153","id":153,"identifier":"author","fieldType":"ibexa_author","fieldGroup":"","position":3,"isTranslatable":true,"isRequired":false,"isInfoCollector":false,"defaultValue":[],"isSearchable":false,"names":{"value":[{"_languageCode":"eng-GB","#text":"Author"}]},"descriptions":{"value":[{"_languageCode":"eng-GB","#text":null}]},"fieldSettings":{"defaultAuthor":1},"validatorConfiguration":[]},{"_media-type":"application/vnd.ibexa.api.FieldDefinition+json","_href":"/api/ibexa/v2/content/types/2/fieldDefinitions/120","id":120,"identifier":"intro","fieldType":"ibexa_richtext","fieldGroup":"","position":4,"isTranslatable":true,"isRequired":true,"isInfoCollector":false,"defaultValue":{"xml":"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<section xmlns=\"http://docbook.org/ns/docbook\" xmlns:xlink=\"http://www.w3.org/1999/xlink\"
```

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

### Configure Storefront to Show All Products

Source: https://github.com/ibexa/documentation-developer/blob/5.0/docs/commerce/storefront/configure_storefront.md

Set the catalog configuration to null to make the main product catalog visible to all users.

```yaml
ibexa:
    system:
        site:
            storefront:
                catalog: ~
```

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

### Set Up Customer Credentials for Personalization

Source: https://github.com/ibexa/documentation-developer/blob/5.0/docs/personalization/enable_personalization.md

Add these lines to your .env.local file with your customer ID, license key, and host URI to enable the Personalization service.

```bash
PERSONALIZATION_CUSTOMER_ID=12345
PERSONALIZATION_LICENSE_KEY=67890-1234-5678-90123-4567
PERSONALIZATION_HOST_URI=https://server_uri
```

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

### Get Prompt JSON Output

Source: https://github.com/ibexa/documentation-developer/blob/5.0/docs/ai/mcp/mcp_usage.md

Example JSON output containing the details of the 'greet' prompt.

```json
{
  "name": "greet",
  "description": "A prompt that greets the user.",
  "parameters": [
    {
      "name": "name",
      "type": "string"
    }
  ]
}
```

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

### Create Experience Project (No Install)

Source: https://github.com/ibexa/documentation-developer/blob/5.0/docs/getting_started/install_ibexa_dxp.md

Use this command to create a new Ibexa DXP Experience project without installing dependencies, useful for older PHP versions. Run 'composer update' afterwards.

```bash
composer create-project ibexa/experience-skeleton --no-install .
composer update
```

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

### Example API Endpoint

Source: https://github.com/ibexa/documentation-developer/blob/5.0/docs/api/rest_api/rest_api_reference/rest_api_reference.html

This is a placeholder for an example API endpoint. Actual endpoints would be detailed here.

```APIDOC
## GET /example/resource

### Description
Retrieves a specific resource identified by its ID.

### Method
GET

### Endpoint
/example/resource/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the resource.

#### Query Parameters
- **fields** (string) - Optional - Comma-separated list of fields to include in the response.

### Request Example
```json
{
  "example": "request body"
}
```

### Response
#### Success Response (200)
- **id** (string) - The unique identifier of the resource.
- **name** (string) - The name of the resource.

#### Response Example
```json
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Example Resource"
}
```
```

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

### Configure SolrCloud Setup

Source: https://github.com/ibexa/documentation-developer/blob/5.0/docs/search/search_engines/solr_search_engine/install_solr.md

Configure SolrCloud by specifying the data distribution strategy using the `distribution_strategy` option set to `cloud`. This example assumes a multi-core setup where language analysis options are configured at the collection level.

```yaml
ibexa_solr:
    endpoints:
        main:
            dsn: '%env(string:SOLR_DSN)%' 
            core: '%solr_main_core%'
        en:
            dsn: '%env(string:SOLR_DSN)%' 
            core: '%solr_en_core%'
        fr:
            dsn: '%env(string:SOLR_DSN)%' 
            core: '%solr_fr_core%'
        # ...
    connections:
        default:
            distribution_strategy: cloud
            entry_endpoints:
                - main
                - en
                - fr
             # -  ...
            mapping:
                translations:
                    eng-GB: en
                    fre-FR: fr
                    # ...
                main_translations: main
```

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

### Get URL Alias (XML Example)

Source: https://github.com/ibexa/documentation-developer/blob/5.0/docs/api/rest_api/rest_api_reference/rest_api_reference.html

Example of an XML response when retrieving a URL alias. This mirrors the JSON structure with elements for media type, href, ID, resource, path, language codes, and forwarding settings.

```xml
<?xml version=\"1.0\" encoding=\"UTF-8\"?>
<UrlAlias media-type=\"application/vnd.ibexa.api.UrlAlias+xml\" href=\" /api/ibexa/v2/content/urlaliases/0-2cecdff5f90b8595d76b68c417b09f36\" id=\"0-2cecdff5f90b8595d76b68c417b09f36\" type=\"RESOURCE\">
 <resource>content/view/full</resource>
 <path>/example-global</path>
 <languageCodes>eng-GB</languageCodes>
 <alwaysAvailable>true</alwaysAvailable>
 <isHistory>false</isHistory>
 <forward>true</forward>
 <custom>true</custom>
</UrlAlias>

```

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

### Get Role Policies (XML)

Source: https://github.com/ibexa/documentation-developer/blob/5.0/docs/api/rest_api/rest_api_reference/rest_api_reference.html

Example response for retrieving a list of policies associated with a user role in XML format.

```xml
<?xml version=\"1.0\" encoding=\"UTF-8\"?>
<PolicyList media-type=\"application/vnd.ibexa.api.PolicyList+xml\" href=\"/api/ibexa/v2/user/roles/1/policies\">
 <Policy media-type=\"application/vnd.ibexa.api.Policy+xml\" href=\" /api/ibexa/v2/user/roles/1/policies/349\">
 <id>349</id>
 <module>content</module>
 <function>read</function>
 <limitations>
 <limitation identifier=\"Section\">
 <values>
 <ref media-type=\"application/vnd.ibexa.api.ref+xml\" href=\"1\"/>
 <ref media-type=\"application/vnd.ibexa.api.ref+xml\" href=\"3\"/>
 <ref media-type=\"application/vnd.ibexa.api.ref+xml\" href=\"6\"/>
 </values>
 </limitation>
 </limitations>
 </Policy>
 <Policy media-type=\"application/vnd.ibexa.api.Policy+xml\" href=\" /api/ibexa/v2/user/roles/1/policies/350\">
 <id>350</id>
 <module>user</module>
 <function>login</function>
 <limitations>
 <limitation identifier=\"SiteAccess\">
 <values>
 <ref media-type=\"application/vnd.ibexa.api.ref+xml\" href=\"2282622326\"/>
 <ref media-type=\"application/vnd.ibexa.api.ref+xml\" href=\"1766001124\"/>
 </values>
 </limitation>
 </limitations>
 </Policy>
 <Policy media-type=\"application/vnd.ibexa.api.Policy+xml\" href=\" /api/ibexa/v2/user/roles/1/policies/351\">
 <id>351</id>
 <module>content</module>
 <function>view_embed</function>
 <limitations>
 
```

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

### Run Image Picker Migration Import

Source: https://github.com/ibexa/documentation-developer/blob/5.0/docs/update_and_migration/from_4.5/update_from_4.5.md

Import the Image picker migration configuration.

```bash
php bin/console ibexa:migrations:import vendor/ibexa/image-picker/src/bundle/Resources/migrations/2023_12_06_15_00_image_content_type.yaml --name=2023_12_06_15_00_image_content_type.yaml
```

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

### Example XML Response for a Section

Source: https://github.com/ibexa/documentation-developer/blob/5.0/docs/api/rest_api/rest_api_reference/rest_api_reference.html

This example demonstrates the structure of a successful XML response when retrieving a Section resource.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<Section media-type="application/vnd.ibexa.api.Section+xml" href="/api/ibexa/v2/content/sections/7">
 <sectionId>7</sectionId>
 <identifier>template</identifier>
 <name>Template</name>
</Section>
```

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

### Example Migration Script Command

Source: https://github.com/ibexa/documentation-developer/blob/5.0/docs/update_and_migration/migrate_to_ibexa_dxp/migrating_from_ez_publish_platform.md

An example of how to run the migration script, specifying the legacy application path and a block definition INI file.

```bash
bin/console ezflow:migrate /var/www/legacy.application.com/ —ini=extension/myapplication/settings/block.ini.append.php
```

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

### Get Role Policies (JSON)

Source: https://github.com/ibexa/documentation-developer/blob/5.0/docs/api/rest_api/rest_api_reference/rest_api_reference.html

Example response for retrieving a list of policies associated with a user role in JSON format.

```json
{
  "PolicyList": {
    "_media-type": "application/vnd.ibexa.api.PolicyList+json",
    "_href": "/api/ibexa/v2/user/roles/1/policies",
    "Policy": [
      {
        "_media-type": "application/vnd.ibexa.api.Policy+json",
        "_href": "/api/ibexa/v2/user/roles/1/policies/349",
        "id": 349,
        "module": "content",
        "function": "read",
        "limitations": {
          "limitation": [
            {
              "_identifier": "Section",
              "values": {
                "ref": [
                  {
                    "_media-type": "application/vnd.ibexa.api.ref+json",
                    "_href": "1"
                  },
                  {
                    "_media-type": "application/vnd.ibexa.api.ref+json",
                    "_href": "3"
                  },
                  {
                    "_media-type": "application/vnd.ibexa.api.ref+json",
                    "_href": "6"
                  }
                ]
              }
            }
          ]
        }
      },
      {
        "_media-type": "application/vnd.ibexa.api.Policy+json",
        "_href": "/api/ibexa/v2/user/roles/1/policies/350",
        "id": 350,
        "module": "user",
        "function": "login",
        "limitations": {
          "limitation": [
            {
              "_identifier": "SiteAccess",
              "values": {
                "ref": [
                  {
                    "_media-type": "application/vnd.ibexa.api.ref+json",
                    "_href": "2282622326"
                  },
                  {
                    "_media-type": "application/vnd.ibexa.api.ref+json",
                    "_href": "1766001124"
                  }
                ]
              }
            }
          ]
        }
      },
      {
        "_media-type": "application/vnd.ibexa.api.Policy+json",
        "_href": "/api/ibexa/v2/user/roles/1/policies/351",
        "id": 351,
        "module": "content",
        "function": "view_embed",
        "limitations": {
          "limitation": [
            {
              "_identifier": "Class",
              "values": {
                "ref": [
                  {
                    "_media-type": "application/vnd.ibexa.api.ref+json",
                    "_href": "5"
                  },
                  {
                    "_media-type": "application/vnd.ibexa.api.ref+json",
                    "_href": "12"
                  }
                ]
              }
            }
          ]
        }
      },
      {
        "_media-type": "application/vnd.ibexa.api.Policy+json",
        "_href": "/api/ibexa/v2/user/roles/1/policies/352",
        "id": 352,
        "module": "user",
        "function": "register"
      },
      {
        "_media-type": "application/vnd.ibexa.api.Policy+json",
        "_href": "/api/ibexa/v2/user/roles/1/policies/353",
        "id": 353,
        "module": "user",
        "function": "password"
      }
    ]
  }
}
```

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

### Create URL Wildcard (XML Example)

Source: https://github.com/ibexa/documentation-developer/blob/5.0/docs/api/rest_api/rest_api_reference/rest_api_reference.html

Example of an XML response after successfully creating a URL wildcard. It includes the details of the newly created wildcard, such as its ID, source and destination URLs, and forwarding status.

```xml
<?xml version=\"1.0\" encoding=\"UTF-8\"?>
<UrlWildcard media-type=\"application/vnd.ibexa.api.UrlWildcard+xml\" href=\" /api/ibexa/v2/content/urlwildcards/4\" id=\"4\">
 <sourceUrl>/api/ibexa/v2/content/location/2</sourceUrl>
 <destinationUrl>/api/ibexa/v2/content/location/59</destinationUrl>
 <forward>true</forward>
 </UrlWildcard>

```

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

### Install Discounts Schemas (PostgreSQL)

Source: https://github.com/ibexa/documentation-developer/blob/5.0/docs/update_and_migration/from_4.6/update_to_5.0.md

Installs schemas for discounts and discount codes on PostgreSQL. Review generated SQL files before execution.

```bash
php bin/console ibexa:doctrine:schema:dump-sql vendor/ibexa/discounts/src/bundle/Resources/config/schema.yaml > schema_discounts.sql
php bin/console ibexa:doctrine:schema:dump-sql vendor/ibexa/discounts-codes/src/bundle/Resources/config/schema.yaml > schema_discounts-codes.sql
# Pause to review schema_discounts.sql and schema_discounts-codes.sql
psql <database_name> < schema_discounts.sql
psql <database_name> < schema_discounts-codes.sql
```

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

### Load, Use, and Save References

Source: https://github.com/ibexa/documentation-developer/blob/5.0/docs/content_management/data_migration/managing_migrations.md

This example shows how to load references from a file, use them in subsequent migration steps (like creating content), and then save new references to a file. Ensure references are loaded before use and saved after creation.

```yaml
- 
    type: reference
    mode: load
    filename: 'references/references.yaml' # Load references created by other migrations

# Use them
- 
    type: content
    mode: create
    # ...

# Save any new references if needed
- 
    type: reference
    mode: save
    filename: 'references/new_references.yaml'

```

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

### Get Events

Source: https://github.com/ibexa/documentation-developer/blob/5.0/docs/api/rest_api/rest_api_reference/rest_api_reference.html

Retrieves a list of events within a specified date range. The results are paginated and can be filtered by start and end dates.

```APIDOC
## GET /api/ibexa/v2/calendar/event

### Description
Retrieves a list of events within a specified date range. The results are paginated and can be filtered by start and end dates.

### Method
GET

### Endpoint
/api/ibexa/v2/calendar/event

### Parameters
#### Query Parameters
- **start** (integer) - Required - The start timestamp for the date range.
- **end** (integer) - Required - The end timestamp for the date range.
- **count** (integer) - Optional - The number of events to retrieve per page.

### Response
#### Success Response (200)
- **_currentPage** (string) - The URL for the current page of results.
- **DateRange** (object) - An object containing the start and end dates for the current range.
  - **_media-type** (string) - The media type of the DateRange object.
  - **startDate** (string) - The start date of the range.
  - **endDate** (string) - The end date of the range.
- **totalCount** (integer) - The total number of events found.
- **events** (array) - An array of event objects.

### Response Example
{
  "_media-type": "application/vnd.ibexa.api.EventGroup+json",
  "_currentPage": "/api/ibexa/v2/calendar/event?start=1597536000&end=1597622400&count=10",
  "DateRange": {
    "_media-type": "application/vnd.ibexa.api.DateRange+json",
    "startDate": "1597536000",
    "endDate": "1597622400"
  },
  "totalCount": 1,
  "events": []
}
```

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

### Get Current Session (XML)

Source: https://github.com/ibexa/documentation-developer/blob/5.0/docs/api/rest_api/rest_api_reference/rest_api_reference.html

Example of retrieving the current user session details in XML format. Includes session identifier and CSRF token.

```xml
<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<Session media-type=\"application/vnd.ibexa.api.Session+xml\" href=\"/api/ibexa/v2/user/sessions/ABCDEFGHIJKLMNOPQRSTUVWXYZ\">\n <name>IBX_SESSION_ID0123456789ABCDEFGHIJKLMNOPQRSTUV</name>\n <identifier>ABCDEFGHIJKLMNOPQRSTUVWXYZ</identifier>\n <csrfToken>0123456789ABCDEF.GHIJKLMNOP_QRSTUVWXYZabcdefghijklmnopqrstuv.wxyz0123456-789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopq</csrfToken>\n <User media-type=\"application/vnd.ibexa.api.User+xml\" href=\"/api/ibexa/v2/user/users/14\"/>\n</Session>
```

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

### Install Ibexa Content Recipes

Source: https://github.com/ibexa/documentation-developer/blob/5.0/docs/update_and_migration/from_3.3/update_from_3.3.md

After updating the Flex server configuration, install the Ibexa Content recipes. Use the --force flag to overwrite existing recipes and -v for verbose output. Follow with a post-install command.

```bash
composer recipes:install ibexa/content --force -v
composer run post-install-cmd
```

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

### Get Location Children

Source: https://github.com/ibexa/documentation-developer/blob/5.0/docs/api/graphql/graphql_queries.md

Retrieve the children of a specific location using the `children` property. This example demonstrates fetching the name and type of each child content item.

```graphql
{
  item(locationId: 2) {
    _location {
      children {
        edges {
          node {
            content {
              _name
              _type {
                name
              }
            }
          }
        }
      }
    }
  }
}
```

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

### Request Sample: Load Attribute Group

Source: https://github.com/ibexa/documentation-developer/blob/5.0/docs/api/rest_api/rest_api_reference/rest_api_reference.html

Example of a request payload to load an attribute group, specifying the desired language. This is used with the GET /product/catalog/attribute_groups/{id} endpoint.

```json
{
  "AttributeGroupGet": {
    "languages": [
      "eng-GB"
    ]
  }
}
```