Fix PHP code samples

Author: mnocon

code_samples/api/public_php_api/src/Command/SegmentCommand.php

@@ -64,6 +64,8 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             : 'The user is not assigned to the segment.'
         ));
 
+        $this->segmentationService->removeSegmentGroup($segmentGroup);
+
         return self::SUCCESS;
     }
 }

deptrac.baseline.yaml

@@ -1,5 +1,7 @@
 deptrac:
   skip_violations:
+    AcmeFeatureBundle:
+      - Ibexa\Bundle\Core\DependencyInjection\IbexaCoreExtension
     App\AutomatedTranslation\ImageFieldEncoder:
       - Ibexa\Core\FieldType\Image\Value
     App\Block\Listener\MyBlockListener:
@@ -92,6 +94,9 @@ deptrac:
       - Ibexa\Core\MVC\Symfony\View\View
     App\Controller\RelationController:
       - Ibexa\Core\MVC\Symfony\View\View
+    App\Controller\RideController:
+      - Ibexa\Bundle\Core\Controller
+      - Ibexa\Core\MVC\Symfony\View\ContentView
     App\Controller\SvgController:
       - Ibexa\Core\Helper\TranslationHelper
       - Ibexa\Core\IO\IOServiceInterface
@@ -130,13 +135,19 @@ deptrac:
       - Ibexa\FormBuilder\Event\FormEvents
     App\EventSubscriber\HelpMenuSubscriber:
       - Ibexa\AdminUi\Menu\Event\ConfigureMenuEvent
+    App\EventSubscriber\LoginFormViewSubscriber:
+      - Ibexa\Core\MVC\Symfony\Event\PreContentViewEvent
+      - Ibexa\Core\MVC\Symfony\MVCEvents
+      - Ibexa\Core\MVC\Symfony\View\LoginFormView
     App\EventSubscriber\MyMenuSubscriber:
       - Ibexa\AdminUi\Menu\Event\ConfigureMenuEvent
       - Ibexa\AdminUi\Menu\MainMenuBuilder
     App\EventSubscriber\NotificationScenarioSubscriber:
       - Ibexa\IntegratedHelp\ProductTour\Block\LinkBlock
       - Ibexa\IntegratedHelp\ProductTour\Block\TextBlock
       - Ibexa\IntegratedHelp\ProductTour\ProductTourStep
+    App\EventSubscriber\ResolveCampaginEventSubscriber:
+      - Ibexa\ConnectorActito\Campaign\Campaign
     App\Event\RandomBlockListener:
       - Ibexa\FieldTypePage\FieldType\Page\Block\Renderer\BlockRenderEvents
       - Ibexa\FieldTypePage\FieldType\Page\Block\Renderer\Event\PreRenderEvent
@@ -194,6 +205,8 @@ deptrac:
       - Ibexa\Migration\ValueObject\Step\StepInterface
     App\Migrations\Step\ReplaceNameStepNormalizer:
       - Ibexa\Migration\ValueObject\Step\StepInterface
+    App\MyService:
+      - Ibexa\Core\MVC\Symfony\SiteAccess\SiteAccessServiceInterface
     App\Notification\ListRenderer:
       - Ibexa\Core\Notification\Renderer\NotificationRenderer
       - Ibexa\Core\Notification\Renderer\TypedNotificationRendererInterface
@@ -212,6 +225,8 @@ deptrac:
     App\QueryType\OptionsBasedLatestContentQueryType:
       - Ibexa\Core\QueryType\OptionsResolverBasedQueryType
       - Ibexa\Core\QueryType\QueryType
+    App\QueryType\RideQueryType:
+      - Ibexa\Core\QueryType\QueryType
     App\Search\Model\Suggestion\ProductSuggestion:
       - Ibexa\ProductCatalog\Local\Repository\Values\Product
     App\Security\FormPolicyProvider:
@@ -236,6 +251,8 @@ deptrac:
       - Ibexa\AdminUi\Limitation\LimitationValueMapperInterface
     App\Security\MyPolicyProvider:
       - Ibexa\Bundle\Core\DependencyInjection\Security\PolicyProvider\YamlPolicyProvider
+    App\Service\MyService:
+      - Ibexa\User\UserSetting\DateTimeFormat\FormatterInterface
     App\Setting\Group\MyGroup:
       - Ibexa\User\UserSetting\Group\AbstractGroup
     App\Setting\Unit:
@@ -254,3 +271,9 @@ deptrac:
       - Ibexa\Core\MVC\Symfony\View\View
     AttributeTypeExtension:
       - Ibexa\PageBuilder\Form\Type\Attribute\AttributeType
+    CustomRepositoryConfigParser:
+      - Ibexa\Bundle\Core\DependencyInjection\Configuration\RepositoryConfigParserInterface
+    JohnDoeCanSelectMore:
+      - Ibexa\AdminUi\UniversalDiscovery\Event\ConfigResolveEvent
+    MyMapper:
+      - Ibexa\ContentForms\Form\Type\FieldType\CheckboxFieldType

docs/administration/back_office/back_office_elements/extending_thumbnails.md

@@ -74,16 +74,16 @@ It enables you to add a thumbnail URL in the text field.
 
 Add `FieldValueUrl.php` in `src/Thumbnails`.
 
-``` php {skip-validation}
+``` php
 <?php
 
 declare(strict_types=1);
 
 namespace App\Thumbnails;
 
+use Ibexa\Contracts\Core\Repository\Strategy\ContentThumbnail\Field\FieldTypeBasedThumbnailStrategy;
 use Ibexa\Contracts\Core\Repository\Values\Content\Field;
 use Ibexa\Contracts\Core\Repository\Values\Content\Thumbnail;
-use Ibexa\Contracts\Core\Repository\Strategy\ContentThumbnail\Field\FieldTypeBasedThumbnailStrategy;
 use Ibexa\Contracts\Core\Repository\Values\Content\VersionInfo;
 
 class FieldValueUrl implements FieldTypeBasedThumbnailStrategy

docs/administration/back_office/back_office_elements/formatting_date_and_time.md

@@ -19,7 +19,7 @@ You can format date and time by using the following services:
 
 To use them, create an `src/Service/MyService.php` file containing:
 
-``` php {skip-validation}
+``` php
 <?php
 
 namespace App\Service;
@@ -28,19 +28,12 @@ use Ibexa\User\UserSetting\DateTimeFormat\FormatterInterface;
 
 class MyService
 {
-    /** @var \Ibexa\User\UserSetting\DateTimeFormat\FormatterInterface */
-    private $shortDateTimeFormatter;
-
-    public function __construct(FormatterInterface $shortDateTimeFormatter)
+    public function __construct(private readonly FormatterInterface $shortDateTimeFormatter)
     {
         // your code
-
-        $this->shortDateTimeFormatter = $shortDateTimeFormatter;
-
-        // your code
     }
 
-    public function foo()
+    public function foo(): void
     {
         // your code
 

docs/administration/back_office/back_office_menus/back_office_menus.md

@@ -85,7 +85,8 @@ The following method adds a new menu section under **Content**, and under it, a
 
 You can also pass parameters to templates used to render menu items with `template_parameters`:
 
-``` php {skip-validation}
+``` php
+/** @var \Knp\Menu\ItemInterface $menu */
 $menu->addChild(
     'all_content_list',
     [
@@ -105,7 +106,8 @@ You can then use the variable `custom_parameter` in `templates/themes/admin/list
 
 To have translatable labels, use `translation.key` from the `messages` domain:
 
-``` php {skip-validation}
+``` php
+/** @var \Knp\Menu\ItemInterface $menu */
 $menu->addChild(
     'all_content_list',
     [

docs/administration/back_office/browser/browser.md

@@ -146,40 +146,42 @@ If an event listener catches additional parameters passed with context, it uses
 
 In the example below, the `johndoe` parameter enables the user to choose multiple items from a **Browser window** by changing `multiple: false` from `my_custom_udw` configuration to `multiple: true`.
 
-``` php {skip-validation} hl_lines="29 30 31"
+``` php hl_lines="31-35"
+<?php
+
+use Ibexa\AdminUi\UniversalDiscovery\Event\ConfigResolveEvent;
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+
 class JohnDoeCanSelectMore implements EventSubscriberInterface
 {
-    private const CONFIGURATION_NAME = 'my_custom_udw';
+    private const string CONFIGURATION_NAME = 'my_custom_udw';
 
     /**
      * Returns an array of event names this subscriber wants to listen to.
      *
-     * @return array The event names to listen to
+     * @return array<string, string> The event names to listen to
      */
-    public static function getSubscribedEvents()
+    public static function getSubscribedEvents(): array
     {
         return [
             ConfigResolveEvent::NAME => 'onUdwConfigResolve',
         ];
     }
 
-    /**
-     * @param \Ibexa\AdminUi\UniversalDiscovery\Event $event
-     */
-    public function onUdwConfigResolve(ConfigResolveEvent $event)
+    public function onUdwConfigResolve(ConfigResolveEvent $event): void
     {
         if ($event->getConfigName() !== self::CONFIGURATION_NAME) {
-		    return;
-		}
+            return;
+        }
 
         $config = $event->getConfig();
-		$context = $event->getContext();
+        $context = $event->getContext();
 
         if (isset($context['some_contextual_parameter'])) {
-			if ($context['some_contextual_parameter'] === 'johndoe') {
-			    $config['multiple'] = true;
-			}
-		}
+            if ($context['some_contextual_parameter'] === 'johndoe') {
+                $config['multiple'] = true;
+            }
+        }
 
         $event->setConfig($config);
     }

docs/administration/back_office/customize_calendar.md

@@ -80,11 +80,16 @@ To add an in-memory collection as an event source, create `src/Calendar/Holidays
 
     For example:
 
-    ``` php {skip-validation}
+    ``` php
+    use App\Calendar\Holidays\Event;
+    use Ibexa\Contracts\Calendar\EventCollection;
+
+    /** @var \App\Calendar\Holidays\EventType $eventType */
     $collection = new EventCollection([
-        $this->createEvent("Event 1", new DateTime("2024-01-01")),
-        $this->createEvent("Event 2", new DateTime("2024-01-02")),
+        new Event('Event 1', new DateTime('2024-01-01'), $eventType),
+        new Event('Event 2', new DateTime('2024-01-02'), $eventType),
         // ...
+    ]);
     ```
 
 Next, register the event source as a service:

docs/administration/back_office/notifications.md

@@ -25,8 +25,9 @@ There are four types of notifications: `info`, `success`, `warning` and `error`.
 
 To send a notification from PHP, inject the `TranslatableNotificationHandlerInterface` into your class.
 
-``` php {skip-validation}
-$this->notificationHandler->info(
+``` php
+/** @var \Ibexa\Contracts\AdminUi\Notification\TranslatableNotificationHandlerInterface $notificationHandler */
+$notificationHandler->info(
     /** @Desc("Notification text") */
     'example.notification.text',
     [],

docs/administration/configuration/configuration.md

@@ -72,9 +72,10 @@ parameters:
         an_array: [apple, banana, pear]
 ```
 
-``` php {skip-validation}
+``` php
 // Usage inside a controller
-$myParameter = $this->container->getParameter( 'myapp.parameter.name' );
+/** @var \Symfony\Component\DependencyInjection\ContainerInterface $container */
+$myParameter = $container->getParameter('myapp.parameter.name');
 ```
 
 ## Configuration settings

docs/administration/configuration/dynamic_configuration.md

@@ -27,11 +27,11 @@ parameters:
     myapp.default.my_param: Default value
 ```
 
-Inside a controller, in `site_group` SiteAccess, you can use the parameters in the following way (the same applies for `hasParameter()`):
+Inside a controller extending the `Ibexa\Core\MVC\Symfony\Controller\Controller` class, in `site_group` SiteAccess, you can use the parameters in the following way (the same applies for `hasParameter()`):
 
 ``` php {skip-validation}
 $configResolver = $this->getConfigResolver();
- 
+
 // ibexa.site_access.config is the default namespace, so no need to specify it
 // The following will resolve ibexa.site_access.config.<siteaccessName>.content.default_ttl
 // In the case of site_group, it will return 3600.
@@ -77,24 +77,18 @@ For more information about dependency injection, see [Service container](php_api
     Don't store the retrieved config value unless you know what you're doing.
     SiteAccess can change during code execution, which means you might work on the wrong value.
 
-``` php {skip-validation}
+``` php
 namespace App;
 
 use Ibexa\Contracts\Core\SiteAccess\ConfigResolverInterface;
- 
+
 class Service
 {
-    /**
-     * @var \Ibexa\Contracts\Core\SiteAccess\ConfigResolverInterface
-     */
-    private $configResolver;
- 
-    public function __construct( ConfigResolverInterface $configResolver )
+    public function __construct(private readonly ConfigResolverInterface $configResolver)
     {
-        $this->configResolver = $configResolver;
     }
 
-    public function someMethodThatNeedConfig()
+    public function someMethodThatNeedConfig(): void
     {
         $configValue = $this->configResolver->getParameter('my_param', 'myapp');
     }