Skip to content

[PHPDoc] Improved ContentService doc for API reference #379

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
alongosz merged 15 commits into from
Nov 5, 2024
Merged

[PHPDoc] Improved ContentService doc for API reference #379

Show file tree
Hide file tree
Changes from 14 commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
e3f12e0
Update ContentService::addRelation phpDoc
adriendupuis Jun 7, 2024
27606d0
ContentService remove bullet list from PHPDoc
adriendupuis Jun 7, 2024
d04b498
ContentService.php: Enh. phpDoc
adriendupuis Jun 21, 2024
2c0af13
Update src/contracts/Repository/ContentService.php
adriendupuis Jun 21, 2024
fb20a95
Update src/contracts/Repository/ContentService.php
adriendupuis Jun 21, 2024
80b737e
Apply suggestions from code review
adriendupuis Jun 21, 2024
237be18
ContentService.php: Enh. phpDoc
adriendupuis Jun 21, 2024
3d9c986
ContentService.php: Update phpstan-baseline*.neon
adriendupuis Jun 24, 2024
e7ebbce
ContentService.php: Update phpstan-baseline*.neon
adriendupuis Jun 24, 2024
cb5d796
ContentService.php: Update phpstan-baseline*.neon
adriendupuis Jun 24, 2024
ebf0e67
ContentService.php: Update phpstan-baseline*.neon
adriendupuis Jun 24, 2024
98167a0
ContentService.php: Enh. phpDoc
adriendupuis Jun 24, 2024
a0d5e23
ContentService.php: Enh. phpDoc
adriendupuis Jun 25, 2024
dc5dcff
Apply suggestions from code review
adriendupuis Jul 1, 2024
2892a1c
Apply suggestions from code review
adriendupuis Nov 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions phpstan-baseline-7.4.neon
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,17 @@ parameters:
path: src/bundle/Core/ApiLoader/StorageConnectionFactory.php

-
message: "#^Parameter \\#1 \\$input of function array_filter expects array, iterable\\<Ibexa\\\\Contracts\\\\Core\\\\Repository\\\\Values\\\\Content\\\\VersionInfo\\> given\\.$#"
message: "#^Parameter \\#1 \\$input of function array_filter expects array, iterable\\<int, Ibexa\\\\Contracts\\\\Core\\\\Repository\\\\Values\\\\Content\\\\VersionInfo\\> given\\.$#"
count: 1
path: src/bundle/Core/Command/CleanupVersionsCommand.php

-
message: "#^Parameter \\#1 \\$input of function array_slice expects array, iterable\\<Ibexa\\\\Contracts\\\\Core\\\\Repository\\\\Values\\\\Content\\\\VersionInfo\\> given\\.$#"
message: "#^Parameter \\#1 \\$input of function array_slice expects array, iterable\\<int, Ibexa\\\\Contracts\\\\Core\\\\Repository\\\\Values\\\\Content\\\\VersionInfo\\> given\\.$#"
count: 1
path: src/bundle/Core/Command/CleanupVersionsCommand.php

-
message: "#^Parameter \\#1 \\$var of function count expects array\\|Countable, iterable\\<Ibexa\\\\Contracts\\\\Core\\\\Repository\\\\Values\\\\Content\\\\VersionInfo\\> given\\.$#"
message: "#^Parameter \\#1 \\$var of function count expects array\\|Countable, iterable\\<int, Ibexa\\\\Contracts\\\\Core\\\\Repository\\\\Values\\\\Content\\\\VersionInfo\\> given\\.$#"
count: 1
path: src/bundle/Core/Command/CleanupVersionsCommand.php

Expand Down Expand Up @@ -171,7 +171,7 @@ parameters:
path: src/lib/MVC/Symfony/Component/Serializer/AbstractPropertyWhitelistNormalizer.php

-
message: "#^Parameter \\#1 \\$input of function array_keys expects array, iterable\\<Ibexa\\\\Contracts\\\\Core\\\\Repository\\\\Values\\\\Content\\\\ContentInfo\\> given\\.$#"
message: "#^Parameter \\#1 \\$input of function array_keys expects array, iterable\\<int, Ibexa\\\\Contracts\\\\Core\\\\Repository\\\\Values\\\\Content\\\\ContentInfo\\> given\\.$#"
count: 1
path: src/lib/MVC/Symfony/FieldType/RelationList/ParameterProvider.php

Expand Down Expand Up @@ -351,17 +351,17 @@ parameters:
path: tests/integration/Core/Repository/BaseTest.php

-
message: "#^Parameter \\#1 \\$var of function count expects array\\|Countable, iterable\\<Ibexa\\\\Contracts\\\\Core\\\\Repository\\\\Values\\\\Content\\\\Relation\\> given\\.$#"
message: "#^Parameter \\#1 \\$var of function count expects array\\|Countable, iterable\\<int, Ibexa\\\\Contracts\\\\Core\\\\Repository\\\\Values\\\\Content\\\\Relation\\> given\\.$#"
count: 4
path: tests/integration/Core/Repository/ContentServiceAuthorizationTest.php

-
message: "#^Parameter \\#1 \\$array_arg of function usort expects TArray of array, iterable\\<Ibexa\\\\Contracts\\\\Core\\\\Repository\\\\Values\\\\Content\\\\Relation\\> given\\.$#"
message: "#^Parameter \\#1 \\$array_arg of function usort expects TArray of array, iterable\\<int, Ibexa\\\\Contracts\\\\Core\\\\Repository\\\\Values\\\\Content\\\\Relation\\> given\\.$#"
count: 2
path: tests/integration/Core/Repository/ContentServiceTest.php

-
message: "#^Parameter \\#1 \\$input of function array_keys expects array, iterable\\<Ibexa\\\\Contracts\\\\Core\\\\Repository\\\\Values\\\\Content\\\\ContentInfo\\> given\\.$#"
message: "#^Parameter \\#1 \\$input of function array_keys expects array, iterable\\<int, Ibexa\\\\Contracts\\\\Core\\\\Repository\\\\Values\\\\Content\\\\ContentInfo\\> given\\.$#"
count: 1
path: tests/integration/Core/Repository/ContentServiceTest.php

Expand All @@ -381,12 +381,12 @@ parameters:
path: tests/integration/Core/Repository/ContentServiceTest.php

-
message: "#^Parameter \\#1 \\$var of function count expects array\\|Countable, iterable\\<Ibexa\\\\Contracts\\\\Core\\\\Repository\\\\Values\\\\Content\\\\Relation\\> given\\.$#"
message: "#^Parameter \\#1 \\$var of function count expects array\\|Countable, iterable\\<int, Ibexa\\\\Contracts\\\\Core\\\\Repository\\\\Values\\\\Content\\\\Relation\\> given\\.$#"
count: 1
path: tests/integration/Core/Repository/ContentServiceTest.php

-
message: "#^Parameter \\#1 \\$var of function count expects array\\|Countable, iterable\\<Ibexa\\\\Contracts\\\\Core\\\\Repository\\\\Values\\\\Content\\\\VersionInfo\\> given\\.$#"
message: "#^Parameter \\#1 \\$var of function count expects array\\|Countable, iterable\\<int, Ibexa\\\\Contracts\\\\Core\\\\Repository\\\\Values\\\\Content\\\\VersionInfo\\> given\\.$#"
count: 2
path: tests/integration/Core/Repository/ContentServiceTest.php

Expand Down
18 changes: 9 additions & 9 deletions phpstan-baseline-gte-8.0.neon
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,17 @@ parameters:
path: src/bundle/Core/ApiLoader/StorageConnectionFactory.php

-
message: "#^Parameter \\#1 \\$array of function array_filter expects array, iterable\\<Ibexa\\\\Contracts\\\\Core\\\\Repository\\\\Values\\\\Content\\\\VersionInfo\\> given\\.$#"
message: "#^Parameter \\#1 \\$array of function array_filter expects array, iterable\\<int, Ibexa\\\\Contracts\\\\Core\\\\Repository\\\\Values\\\\Content\\\\VersionInfo\\> given\\.$#"
count: 1
path: src/bundle/Core/Command/CleanupVersionsCommand.php

-
message: "#^Parameter \\#1 \\$array of function array_slice expects array, iterable\\<Ibexa\\\\Contracts\\\\Core\\\\Repository\\\\Values\\\\Content\\\\VersionInfo\\> given\\.$#"
message: "#^Parameter \\#1 \\$array of function array_slice expects array, iterable\\<int, Ibexa\\\\Contracts\\\\Core\\\\Repository\\\\Values\\\\Content\\\\VersionInfo\\> given\\.$#"
count: 1
path: src/bundle/Core/Command/CleanupVersionsCommand.php

-
message: "#^Parameter \\#1 \\$value of function count expects array\\|Countable, iterable\\<Ibexa\\\\Contracts\\\\Core\\\\Repository\\\\Values\\\\Content\\\\VersionInfo\\> given\\.$#"
message: "#^Parameter \\#1 \\$value of function count expects array\\|Countable, iterable\\<int, Ibexa\\\\Contracts\\\\Core\\\\Repository\\\\Values\\\\Content\\\\VersionInfo\\> given\\.$#"
count: 1
path: src/bundle/Core/Command/CleanupVersionsCommand.php

Expand Down Expand Up @@ -171,7 +171,7 @@ parameters:
path: src/lib/MVC/Symfony/Component/Serializer/AbstractPropertyWhitelistNormalizer.php

-
message: "#^Parameter \\#1 \\$array of function array_keys expects array, iterable\\<Ibexa\\\\Contracts\\\\Core\\\\Repository\\\\Values\\\\Content\\\\ContentInfo\\> given\\.$#"
message: "#^Parameter \\#1 \\$array of function array_keys expects array, iterable\\<int, Ibexa\\\\Contracts\\\\Core\\\\Repository\\\\Values\\\\Content\\\\ContentInfo\\> given\\.$#"
count: 1
path: src/lib/MVC/Symfony/FieldType/RelationList/ParameterProvider.php

Expand Down Expand Up @@ -306,12 +306,12 @@ parameters:
path: tests/integration/Core/Repository/BaseTest.php

-
message: "#^Parameter \\#1 \\$value of function count expects array\\|Countable, iterable\\<Ibexa\\\\Contracts\\\\Core\\\\Repository\\\\Values\\\\Content\\\\Relation\\> given\\.$#"
message: "#^Parameter \\#1 \\$value of function count expects array\\|Countable, iterable\\<int, Ibexa\\\\Contracts\\\\Core\\\\Repository\\\\Values\\\\Content\\\\Relation\\> given\\.$#"
count: 4
path: tests/integration/Core/Repository/ContentServiceAuthorizationTest.php

-
message: "#^Parameter \\#1 \\$array of function array_keys expects array, iterable\\<Ibexa\\\\Contracts\\\\Core\\\\Repository\\\\Values\\\\Content\\\\ContentInfo\\> given\\.$#"
message: "#^Parameter \\#1 \\$array of function array_keys expects array, iterable\\<int, Ibexa\\\\Contracts\\\\Core\\\\Repository\\\\Values\\\\Content\\\\ContentInfo\\> given\\.$#"
count: 1
path: tests/integration/Core/Repository/ContentServiceTest.php

Expand All @@ -321,7 +321,7 @@ parameters:
path: tests/integration/Core/Repository/ContentServiceTest.php

-
message: "#^Parameter \\#1 \\$array of function usort expects TArray of array, iterable\\<Ibexa\\\\Contracts\\\\Core\\\\Repository\\\\Values\\\\Content\\\\Relation\\> given\\.$#"
message: "#^Parameter \\#1 \\$array of function usort expects TArray of array, iterable\\<int, Ibexa\\\\Contracts\\\\Core\\\\Repository\\\\Values\\\\Content\\\\Relation\\> given\\.$#"
count: 2
path: tests/integration/Core/Repository/ContentServiceTest.php

Expand All @@ -336,12 +336,12 @@ parameters:
path: tests/integration/Core/Repository/ContentServiceTest.php

-
message: "#^Parameter \\#1 \\$value of function count expects array\\|Countable, iterable\\<Ibexa\\\\Contracts\\\\Core\\\\Repository\\\\Values\\\\Content\\\\Relation\\> given\\.$#"
message: "#^Parameter \\#1 \\$value of function count expects array\\|Countable, iterable\\<int, Ibexa\\\\Contracts\\\\Core\\\\Repository\\\\Values\\\\Content\\\\Relation\\> given\\.$#"
count: 1
path: tests/integration/Core/Repository/ContentServiceTest.php

-
message: "#^Parameter \\#1 \\$value of function count expects array\\|Countable, iterable\\<Ibexa\\\\Contracts\\\\Core\\\\Repository\\\\Values\\\\Content\\\\VersionInfo\\> given\\.$#"
message: "#^Parameter \\#1 \\$value of function count expects array\\|Countable, iterable\\<int, Ibexa\\\\Contracts\\\\Core\\\\Repository\\\\Values\\\\Content\\\\VersionInfo\\> given\\.$#"
count: 2
path: tests/integration/Core/Repository/ContentServiceTest.php

Expand Down
Loading
Loading