[PHP] Migrated include_file to include_code. Added remove_indent for partial includes (#3209)

* [PHP] Migrated include_file to include_code. Added remove_indent for partial includes

* Bumped file limit

Author: mnocon

.github/workflows/preview_comment.yaml

@@ -28,7 +28,7 @@ jobs:
 
             -   name: Create comment for changed files
                 run: |
-                    file_limit=100
+                    file_limit=150
                     build_url="https://ez-systems-developer-documentation--${{ github.event.pull_request.number }}.com.readthedocs.build/${{inputs.project}}en/${{ github.event.pull_request.number }}/"
 
                     md_change_list=$(git diff --name-only HEAD "origin/$GITHUB_BASE_REF" -- docs/ | grep -E "^docs\/.*\.md$" | sed -E "s|^docs/(.*)\.md$|- [docs/\1.md](${build_url}\1/)|")

docs/administration/back_office/add_user_setting.md

@@ -13,7 +13,7 @@ To do so, create a setting class implementing two interfaces: `ValueDefinitionIn
 In this example the class is located in `src/Setting/Unit.php` and enables the user to select their preference for metric or imperial unit systems.
 
 ``` php
-[[= include_file('code_samples/back_office/settings/src/Setting/Unit.php') =]]
+[[= include_code('code_samples/back_office/settings/src/Setting/Unit.php') =]]
 ```
 
 Register the setting as a service:
@@ -30,7 +30,7 @@ It can be one of the built-in groups, or a custom one.
 To create a custom setting group, create an `App/Setting/Group/MyGroup.php` file:
 
 ``` php
-[[= include_file('code_samples/back_office/settings/src/Setting/Group/MyGroup.php') =]]
+[[= include_code('code_samples/back_office/settings/src/Setting/Group/MyGroup.php') =]]
 ```
 
 Register the setting group as a service:

docs/administration/back_office/back_office_elements/extending_thumbnails.md

@@ -42,7 +42,7 @@ First, create base strategy for returning custom thumbnails from a static file.
 Create `StaticStrategy.php` in `src/Strategy`.
 
 ```php
-[[= include_file('code_samples/back_office/thumbnails/src/Strategy/StaticThumbnailStrategy.php') =]]
+[[= include_code('code_samples/back_office/thumbnails/src/Strategy/StaticThumbnailStrategy.php') =]]
 ```
 
 Next, add the strategy with the `ibexa.repository.thumbnail.strategy.content` tag and `priority: 100` to `config/services.yaml`:

docs/administration/back_office/back_office_menus/add_menu_item.md

@@ -35,7 +35,7 @@ The route indicates a controller that fetches all visible content items and rend
 Create the following controller file in `src/Controller/AllContentListController.php`:
 
 ``` php
-[[= include_file('code_samples/back_office/menu/menu_item/src/Controller/AllContentListController.php') =]]
+[[= include_code('code_samples/back_office/menu/menu_item/src/Controller/AllContentListController.php') =]]
 ```
 
 ## Add template

docs/administration/back_office/back_office_menus/back_office_menus.md

@@ -72,7 +72,7 @@ To add an inactive menu section, don't add a route to its parameters.
 The following method adds a new menu section under **Content**, and under it, a new item with custom attributes:
 
 ``` php
-[[= include_file('code_samples/back_office/menu/menu_item/src/EventSubscriber/MyMenuSubscriber.php', 30, 43) =]]
+[[= include_code('code_samples/back_office/menu/menu_item/src/EventSubscriber/MyMenuSubscriber.php', 31, 43, remove_indent=True) =]]
 ```
 
 `label` is used for the new menu item in the interface.
@@ -127,13 +127,13 @@ You can use the `extras.icon` parameter to define an icon for a menu item.
 For example, the following code changes the default icon for the **Create content** button in content view:
 
 ``` php
-[[= include_file('code_samples/back_office/menu/menu_item/src/EventSubscriber/MyMenuSubscriber.php', 46, 48) =]]
+[[= include_code('code_samples/back_office/menu/menu_item/src/EventSubscriber/MyMenuSubscriber.php', 47, 48, remove_indent=True) =]]
 ```
 
 ## Removing menu items
 
 To remove a menu item, for example, to remove the **Copy subtree** item from the right menu in content view, use the following event listener:
 
 ``` php
-[[= include_file('code_samples/back_office/menu/menu_item/src/EventSubscriber/MyMenuSubscriber.php', 44, 45) =]]
+[[= include_code('code_samples/back_office/menu/menu_item/src/EventSubscriber/MyMenuSubscriber.php', 45, 45, remove_indent=True) =]]
 ```

docs/administration/back_office/back_office_tabs/back_office_tabs.md

@@ -47,7 +47,7 @@ You can order the tabs by making the tab implement `OrderedTabInterface`.
 The order depends on the numerical value returned by the `getOrder` method:
 
 ``` php
-[[= include_file('code_samples/back_office/dashboard/article_tab/src/Tab/Dashboard/Everyone/EveryoneArticleTab.php', 37, 41) =]]
+[[= include_code('code_samples/back_office/dashboard/article_tab/src/Tab/Dashboard/Everyone/EveryoneArticleTab.php', 38, 41, remove_indent=True) =]]
 ```
 
 Tabs are displayed according to this value in ascending order.

docs/administration/back_office/back_office_tabs/create_dashboard_tab.md

@@ -8,7 +8,7 @@ To create a new tab in the dashboard, create an `EveryoneArticleTab.php` file in
 This adds a tab to the **Common content** dashboard block that displays all articles in the repository.
 
 ``` php hl_lines="17 38 50-53 64-66"
-[[= include_file('code_samples/back_office/dashboard/article_tab/src/Tab/Dashboard/Everyone/EveryoneArticleTab.php') =]]
+[[= include_code('code_samples/back_office/dashboard/article_tab/src/Tab/Dashboard/Everyone/EveryoneArticleTab.php') =]]
 ```
 
 This tab searches for content with content type "Article" (lines 50-53) and uses the built-in `all_content.html.twig` template to render the results, which ensures that the tab looks the same as the existing tabs (lines 64-66).

docs/administration/back_office/content_tab_switcher.md

@@ -74,7 +74,7 @@ The `meta_field_groups_list` configuration can be overridden.
 First, create an event listener in the `src/EventListener/TextAnchorMenuTabListener.php`:
 
 ``` php hl_lines="28 31"
-[[= include_file('code_samples/back_office/content_type/src/EventListener/TextAnchorMenuTabListener.php') =]]
+[[= include_code('code_samples/back_office/content_type/src/EventListener/TextAnchorMenuTabListener.php') =]]
 ```
 
 A new custom tab is defined in the line 28, the line 31 defines items for the second level.

docs/administration/back_office/customize_calendar.md

@@ -40,15 +40,15 @@ The following example shows how to create custom events which add different holi
 First, create a new event in `src/Calendar/Holidays/Event.php`:
 
 ``` php
-[[= include_file('code_samples/back_office/calendar/src/Calendar/Holidays/Event.php') =]]
+[[= include_code('code_samples/back_office/calendar/src/Calendar/Holidays/Event.php') =]]
 ```
 
 Here, you define a new class for your event based on `Ibexa\Contracts\Calendar\Event`.
 
 Next, create `src/Calendar/Holidays/EventType.php`:
 
 ```php hl_lines="20-23"
-[[= include_file('code_samples/back_office/calendar/src/Calendar/Holidays/EventType.php') =]]
+[[= include_code('code_samples/back_office/calendar/src/Calendar/Holidays/EventType.php') =]]
 ```
 
 You can use the identifier defined in lines 20-23 to configure [event colors](#customize-colors-and-icons).
@@ -109,7 +109,7 @@ To do this, place the following `holidays.json` file in `src/Calendar/Holidays`:
 Next, import this file in `src/Calendar/Holidays/EventSourceFactory.php`:
 
 ``` php hl_lines="6-9"
-[[= include_file('code_samples/back_office/calendar/src/Calendar/Holidays/EventSourceFactory.php', 16, 30) =]]
+[[= include_code('code_samples/back_office/calendar/src/Calendar/Holidays/EventSourceFactory.php', 17, 30, remove_indent=True) =]]
 ```
 
 The calendar now displays the events listed in the JSON file.

docs/administration/back_office/customize_integrated_help.md

@@ -96,7 +96,7 @@ In this example, it removes a product roadmap entry from the menu and adds a hel
 The tab is displayed in a production environment only.
 
 ``` php
-[[= include_file('code_samples/back_office/menu/menu_item/src/EventSubscriber/HelpMenuSubscriber.php') =]]
+[[= include_code('code_samples/back_office/menu/menu_item/src/EventSubscriber/HelpMenuSubscriber.php') =]]
 ```
 
 !!! tip