Merge remote-tracking branch 'origin/master' into search-page

Author: adriendupuis

.github/pull_request_template.md

@@ -2,6 +2,7 @@
 | ------------- | ---
 | JIRA Ticket   | <!-- URLs to GitHub or JIRA issue(s) (or N/A) -->
 | Versions      | <!-- product version number, e.g.: 1.7, 1.13, 2.0 -->
+| Edition       | <!-- Content/Headless, Experience, Commerce -->
 
 <!-- Replace this comment with Pull Request description -->
 

.github/workflows/build.yaml

@@ -9,18 +9,30 @@ on:
 
 jobs:
     build:
+        permissions:
+          # Give the default GITHUB_TOKEN write permission to commit and push the
+          # added or changed files to the repository.
+          contents: write
 
         runs-on: ubuntu-latest
         strategy:
             matrix:
                 python-version: [3.8]
 
         steps:
-            -   uses: actions/checkout@v2
+            -   uses: actions/checkout@v3
             -   name: Set up Python ${{ matrix.python-version }}
-                uses: actions/setup-python@v2
+                uses: actions/setup-python@v3
                 with:
                     python-version: ${{ matrix.python-version }}
+            -   name: Install php-cs-fixer
+                run: composer require friendsofphp/php-cs-fixer --dev
+            -   name: Run PHP CS Fixer
+                run: ./vendor/bin/php-cs-fixer fix --config=.php-cs-fixer.php -v --show-progress=dots
+            -   name: Commit changes
+                uses: stefanzweifel/git-auto-commit-action@v4
+                with:
+                    commit_message: PHP CS Fixes
             -   name: Install dependencies
                 run: |
                     python -m pip install --upgrade pip

.gitignore

@@ -3,3 +3,5 @@
 __pycache__/*
 /site/
 **/.idea/
+.php-cs-fixer.cache
+composer.lock

.readthedocs.yml

@@ -4,8 +4,12 @@ mkdocs:
   configuration: mkdocs.yml
   fail_on_warning: true
 
+build:
+  os: ubuntu-20.04
+  tools:
+    python: "3.11"
+
 python:
-  version: 3.8
   install:
     - requirements: pip_require.txt
     - requirements: requirements.txt

README.md

@@ -1,36 +1,55 @@
-# eZ Platform Developer Documentation
+# Ibexa DXP Developer Documentation
 
-This repository is the source for the [developer documentation for Ibexa DXP](https://doc.ibexa.co/en/latest),
-a DXP platform that is based on the Symfony Full Stack Framework in PHP.
+This repository is the source for the [developer documentation for Ibexa](https://doc.ibexa.co/en/latest),
+a digital experience platform that is based on the Symfony Full Stack Framework in PHP.
 
 # Resources
 
 1. Ibexa DXP Developer Hub: https://developers.ibexa.co
-1. Ibexa DXP Repository: https://github.com/ezsystems/ezplatform
+1. Ibexa DXP Repository: https://github.com/ibexa/oss
 1. Open JIRA board: https://issues.ibexa.co
 1. Ibexa Website: https://ibexa.co
 1. User documentation: https://doc.ibexa.co/projects/userguide
 
 ## How to contribute
-https://doc.ibexa.co/en/master/community_resources/contributing
 
-Invite yourself to the community Slack and join `#documentation-contrib`
+To contribute to the documentation, you can open a PR in this repository.
 
-https://ez-community-on-slack.herokuapp.com/
+If you'd like to see Ibexa DXP in your language, you can [contribute to the translations](https://doc.ibexa.co/en/latest/resources/contributing/contribute_translations/).
+
+### Contribute to API reference
+
+The REST API Reference is located in the `docs/api/rest_api/rest_api_reference/rest_api_reference.html` 
+file, which is generated automatically by the RAML2HTML tool.
+It is based on `*.raml` files located in the `docs/api/rest_api/rest_api_reference/input` directory that you can edit in your editor/IDE.
+
+After you modify relevant files in the input folder, you can generate an HTML file from repository root (this step can also be performed by one of the Tech Writers during PR review): 
+
+`php tools/raml2html/raml2html.php build --non-standard-http-methods=COPY,MOVE,PUBLISH,SWAP -t default -o docs/api/rest_api/rest_api_reference/output/ docs/api/rest_api/rest_api_reference/input/ez.raml`
+
+In case of errors, look for mistakes in the RAML file, for example, double apostrophes.
+Move `rest_api_reference.html`  from the output folder to `docs/api/rest_api/rest_api_reference/` root.
+
+See `tools/raml2html/README.md` for more information.
+
+## Build and preview documentation
+
+To build and preview your changes locally, you need to install Python along with its package manager (`pip`).
+Other required tools will be installed by using the following command:
 
-## Building & preview
-To build and preview your changes locally, you will need Python along with its package manager (`pip`).
-Other required tools will be installed by `pip` using the following command:
 ```bash
 pip install -r requirements.txt
 ```
 
 Then you can run:
+
 ```bash
 mkdocs serve
 ```
+
 After a short while your documentation should be reachable at http://localhost:8000. If it isn't, check the output
 of the command.
 
 ## Where to View
+
 https://doc.ibexa.co

code_samples/api/commerce/config/packages/custom_routes.yaml

@@ -0,0 +1,4 @@
+custom_checkout:
+    path: /custom_checkout
+    defaults:
+        _controller: App\Controller\CustomCheckoutController::showContentAction

code_samples/api/commerce/src/Command/CartCommand.php

@@ -0,0 +1,139 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Command;
+
+use Ibexa\Contracts\Cart\CartServiceInterface;
+use Ibexa\Contracts\Cart\Value\CartCreateStruct;
+use Ibexa\Contracts\Cart\Value\CartMetadataUpdateStruct;
+use Ibexa\Contracts\Cart\Value\CartQuery;
+use Ibexa\Contracts\Cart\Value\EntryAddStruct;
+use Ibexa\Contracts\Cart\Value\EntryUpdateStruct;
+use Ibexa\Contracts\Core\Repository\UserService;
+use Ibexa\Contracts\ProductCatalog\CurrencyServiceInterface;
+use Ibexa\Contracts\ProductCatalog\ProductServiceInterface;
+use Ibexa\Core\Repository\Permission\PermissionResolver;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+
+final class CartCommand extends Command
+{
+    private PermissionResolver $permissionResolver;
+
+    private UserService $userService;
+
+    private CartServiceInterface $cartService;
+
+    private CurrencyServiceInterface $currencyService;
+
+    private ProductServiceInterface $productService;
+
+    public function __construct(
+        PermissionResolver $permissionResolver,
+        UserService $userService,
+        CartServiceInterface $cartService,
+        CurrencyServiceInterface $currencyService,
+        ProductServiceInterface $productService
+    ) {
+        $this->cartService = $cartService;
+        $this->permissionResolver = $permissionResolver;
+        $this->userService = $userService;
+        $this->currencyService = $currencyService;
+        $this->productService = $productService;
+
+        parent::__construct('doc:cart');
+    }
+
+    public function configure(): void
+    {
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output): int
+    {
+        $this->permissionResolver->setCurrentUserReference(
+            $this->userService->loadUserByLogin('admin')
+        );
+
+        // Query for carts
+        $cartQuery = new CartQuery();
+        $cartQuery->setOwnerId(14); // carts created by User ID: 14
+        $cartQuery->setLimit(20); // fetch 20 carts
+
+        $cartsList = $this->cartService->findCarts($cartQuery);
+
+        $cartsList->getCarts(); // array of CartInterface objects
+        $cartsList->getTotalCount(); // number of returned carts
+
+        foreach ($cartsList as $cart) {
+            $output->writeln($cart->getIdentifier() . ': ' . $cart->getName());
+        }
+
+        // Get a single cart
+        $cart = $this->cartService->getCart('1844450e-61da-4814-8d82-9301a3df0054');
+
+        $output->writeln($cart->getName());
+
+        // Create a new cart
+        $currency = $this->currencyService->getCurrencyByCode('EUR');
+
+        $cartCreateStruct = new CartCreateStruct(
+            'Default cart',
+            $currency // Ibexa\Contracts\ProductCatalog\Values\CurrencyInterface
+        );
+
+        $cart = $this->cartService->createCart($cartCreateStruct);
+
+        $output->writeln($cart->getName()); // prints 'Default cart' to the console
+
+        // Update a cart
+        $newCurrency = $this->currencyService->getCurrencyByCode('PLN');
+
+        $cartUpdateMetadataStruct = new CartMetadataUpdateStruct();
+        $cartUpdateMetadataStruct->setName('New name');
+        $cartUpdateMetadataStruct->setCurrency($newCurrency);
+
+        $updatedCart = $this->cartService->updateCartMetadata($cart, $cartUpdateMetadataStruct);
+
+        $output->writeln($updatedCart->getName()); // prints 'New name' to the console
+
+        // Empty a cart
+        $this->cartService->emptyCart($cart);
+
+        // Validate a cart
+        $violationList = $this->cartService->validateCart($cart); // Symfony\Component\Validator\ConstraintViolationListInterface
+
+        // Add product to a cart
+        $product = $this->productService->getProduct('desk1');
+
+        $entryAddStruct = new EntryAddStruct($product);
+        $entryAddStruct->setQuantity(10);
+
+        $cart = $this->cartService->addEntry($cart, $entryAddStruct);
+
+        $entry = $cart->getEntries()->first();
+        $output->writeln($entry->getProduct()->getName()); // prints product name to the console
+
+        // Remove an entry from a cart
+        // find entry you would like to remove from cart
+        $entry = $cart->getEntries()->first();
+
+        $cart = $this->cartService->removeEntry($cart, $entry); // updated Cart object
+
+        // Update entry in a cart
+        $entryUpdateStruct = new EntryUpdateStruct(5);
+        $entryUpdateStruct->setQuantity(10);
+
+        $cart = $this->cartService->updateEntry(
+            $cart,
+            $entry,
+            $entryUpdateStruct
+        ); // updated Cart object
+
+        // Delete a cart permanently
+        $this->cartService->deleteCart($cart);
+
+        return self::SUCCESS;
+    }
+}