Fix existing inline PHP snippets

[mnocon]

This PR fixes the existing inlined PHP code samples, using the following tools:

• PHPStan
• Rector
• CS-Fixer
• Deptrac

[github-actions]

Preview of modified files: Too many files modified in a single PR, preview link list is skipped. (298 files > 150)

[sonarqubecloud]

Quality Gate passed

Issues
1 New issue
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[mnocon]

@ibexa/php-dev @vidarl @reithor could you please help me and confirm that this change is ok?

Request::HEADER_X_FORWARDED_ALL is removed in Symfony 6/7, I found this:

https://github.com/symfony/symfony/blame/b01d14a27dcd5ca91c5af11ca3cb41ffbe639de7/src/Symfony/Component/HttpFoundation/CHANGELOG.md#L128

I'm sure about other changes in this PR, but for this one would like a confirmation

[reithor]

@mnocon sorry, but i totally missed that you pinged me here a while ago.
Change looks good to me but I am not 100% sure - so would prefer getting approval from @ibexa/php-dev .

[bnowak]

I checked that and can confirm it is a secure 1:1 replacement 👍

[github-actions]

Summary

Status	Count
🔍 Total	758313
🔗 Unique	15003
✅ Successful	7263
⏳ Timeouts	0
🔀 Redirected	0
👻 Excluded	751050
❓ Unknown	0
🚫 Errors	0
⛔ Unsupported	0

Full Github Actions output

[adriendupuis]

It's OK for two lines but here…

Suggested change

	/** @var \Ibexa\Contracts\Core\Repository\Values\Content\ContentInfo $contentInfo */
	/** @var int $versionFromId */
	/** @var int $versionToId */
	/** @var \Ibexa\Contracts\Core\Repository\ContentService $contentService */
	/** @var \Ibexa\Contracts\VersionComparison\Service\VersionComparisonServiceInterface $comparisonService */
	/**
	* @var \Ibexa\Contracts\Core\Repository\Values\Content\ContentInfo $contentInfo
	* @var int $versionFromId
	* @var int $versionToId
	* @var \Ibexa\Contracts\Core\Repository\ContentService $contentService
	* @var \Ibexa\Contracts\VersionComparison\Service\VersionComparisonServiceInterface
	*/

[mnocon]

Modified for all entries where there is more than a single line, to make it unified:
0c7bbb0

I've checked and there's no hl_lines usage, no need to adjust that

[github-actions]

code_samples/ change report

Before (on target branch)	After (in current PR)
code_samples/api/public_php_api/src/Command/SegmentCommand.php docs/users/segment_api.md@17:``` php docs/users/segment_api.md@18:[[= include_code('code_samples/api/public_php_api/src/Command/SegmentCommand.php', 49, 55, remove_indent=True) =]] docs/users/segment_api.md@19:``` 001⫶$segmentGroup = $this->segmentationService->loadSegmentGroupByIdentifier('custom_group'); 002⫶ 003⫶$segments = $this->segmentationService->loadSegmentsAssignedToGroup($segmentGroup); 004⫶ 005⫶foreach ($segments as $segment) { 006⫶ $output->writeln('Segment identifier: ' . $segment->getIdentifier() . ', name: ' . $segment->getName()); 007⫶} docs/users/segment_api.md@23:``` php docs/users/segment_api.md@24:[[= include_code('code_samples/api/public_php_api/src/Command/SegmentCommand.php', 57, 57, remove_indent=True) =]] docs/users/segment_api.md@25:``` 001⫶$segment = $this->segmentationService->loadSegmentByIdentifier('segment_1'); docs/users/segment_api.md@31:``` php docs/users/segment_api.md@32:[[= include_code('code_samples/api/public_php_api/src/Command/SegmentCommand.php', 61, 65, remove_indent=True) =]] docs/users/segment_api.md@33:``` 001⫶$output->writeln(( 002⫶ $this->segmentationService->isUserAssignedToSegment($user, $segment) 003⫶ ? 'The user is assigned to the segment.' 004⫶ : 'The user is not assigned to the segment.' 005⫶)); docs/users/segment_api.md@39:``` php docs/users/segment_api.md@40:[[= include_code('code_samples/api/public_php_api/src/Command/SegmentCommand.php', 59, 59, remove_indent=True) =]] docs/users/segment_api.md@41:``` 001⫶$this->segmentationService->assignUserToSegment($user, $segment); docs/users/segment_api.md@49:``` php docs/users/segment_api.md@50:[[= include_code('code_samples/api/public_php_api/src/Command/SegmentCommand.php', 33, 39, remove_indent=True) =]] docs/users/segment_api.md@51:``` 001⫶$segmentGroupCreateStruct = new SegmentGroupCreateStruct([ 002⫶ 'name' => 'Custom Group', 003⫶ 'identifier' => 'custom_group', 004⫶ 'createSegments' => [], 005⫶]); 006⫶ 007⫶$newSegmentGroup = $this->segmentationService->createSegmentGroup($segmentGroupCreateStruct); docs/users/segment_api.md@55:``` php docs/users/segment_api.md@56:[[= include_code('code_samples/api/public_php_api/src/Command/SegmentCommand.php', 41, 47, remove_indent=True) =]] docs/users/segment_api.md@57:``` 001⫶$segmentCreateStruct = new SegmentCreateStruct([ 002⫶ 'name' => 'Segment 1', 003⫶ 'identifier' => 'segment_1', 004⫶ 'group' => $newSegmentGroup, 005⫶]); 006⫶ 007⫶$newSegment = $this->segmentationService->createSegment($segmentCreateStruct);	code_samples/api/public_php_api/src/Command/SegmentCommand.php docs/users/segment_api.md@17:``` php docs/users/segment_api.md@18:[[= include_code('code_samples/api/public_php_api/src/Command/SegmentCommand.php', 49, 55, remove_indent=True) =]] docs/users/segment_api.md@19:``` 001⫶$segmentGroup = $this->segmentationService->loadSegmentGroupByIdentifier('custom_group'); 002⫶ 003⫶$segments = $this->segmentationService->loadSegmentsAssignedToGroup($segmentGroup); 004⫶ 005⫶foreach ($segments as $segment) { 006⫶ $output->writeln('Segment identifier: ' . $segment->getIdentifier() . ', name: ' . $segment->getName()); 007⫶} docs/users/segment_api.md@23:``` php docs/users/segment_api.md@24:[[= include_code('code_samples/api/public_php_api/src/Command/SegmentCommand.php', 57, 57, remove_indent=True) =]] docs/users/segment_api.md@25:``` 001⫶$segment = $this->segmentationService->loadSegmentByIdentifier('segment_1'); docs/users/segment_api.md@31:``` php docs/users/segment_api.md@32:[[= include_code('code_samples/api/public_php_api/src/Command/SegmentCommand.php', 61, 65, remove_indent=True) =]] docs/users/segment_api.md@33:``` 001⫶$output->writeln(( 002⫶ $this->segmentationService->isUserAssignedToSegment($user, $segment) 003⫶ ? 'The user is assigned to the segment.' 004⫶ : 'The user is not assigned to the segment.' 005⫶)); docs/users/segment_api.md@39:``` php docs/users/segment_api.md@40:[[= include_code('code_samples/api/public_php_api/src/Command/SegmentCommand.php', 59, 59, remove_indent=True) =]] docs/users/segment_api.md@41:``` 001⫶$this->segmentationService->assignUserToSegment($user, $segment); docs/users/segment_api.md@49:``` php docs/users/segment_api.md@50:[[= include_code('code_samples/api/public_php_api/src/Command/SegmentCommand.php', 33, 39, remove_indent=True) =]] docs/users/segment_api.md@51:``` 001⫶$segmentGroupCreateStruct = new SegmentGroupCreateStruct([ 002⫶ 'name' => 'Custom Group', 003⫶ 'identifier' => 'custom_group', 004⫶ 'createSegments' => [], 005⫶]); 006⫶ 007⫶$newSegmentGroup = $this->segmentationService->createSegmentGroup($segmentGroupCreateStruct); docs/users/segment_api.md@55:``` php docs/users/segment_api.md@56:[[= include_code('code_samples/api/public_php_api/src/Command/SegmentCommand.php', 41, 47, remove_indent=True) =]] docs/users/segment_api.md@57:``` 001⫶$segmentCreateStruct = new SegmentCreateStruct([ 002⫶ 'name' => 'Segment 1', 003⫶ 'identifier' => 'segment_1', 004⫶ 'group' => $newSegmentGroup, 005⫶]); 006⫶ 007⫶$newSegment = $this->segmentationService->createSegment($segmentCreateStruct);
	docs/users/segment_api.md@67:``` php docs/users/segment_api.md@68:[[= include_code('code_samples/api/public_php_api/src/Command/SegmentCommand.php', 67, 67, remove_indent=True) =]] docs/users/segment_api.md@69:``` 001⫶$this->segmentationService->removeSegmentGroup($segmentGroup);

Download colorized diff

[adriendupuis]

I would only simplify use Ibexa\Core\FieldType\Url as Url; and keep the rest for another time.

[adriendupuis]

I prefer the original Checkbox\Value (like previously in $authorList = new Author\Value)

use Ibexa\Core\FieldType\Checkbox

// Instantiates a checkbox value with a default state (false)
$checkboxValue = new Checkbox\Value();

Afterward, there were some wrong new Type\Value that might be a reminiscence of this preference but with a bad copy-pasting spreading the wrong use …\Type without understanding.

[adriendupuis]

Side-note: How this $settings is supposed to be used? It's like the example stop too soon.

[adriendupuis]

Url as Url?

Suggested change

	use Ibexa\Core\FieldType\Url as Url;
	use Ibexa\Core\FieldType\Url;