Skip to content

Add information about ValueObject replacement #2847

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
merged 4 commits into from
Jul 24, 2025
Merged

Add information about ValueObject replacement #2847

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7403a63
Add information about ValueObject replacement
dabrt Jul 23, 2025
c8cc6b6
Apply suggestions from code review
dabrt Jul 24, 2025
e263a9c
Add an introduction for the examples.
dabrt Jul 24, 2025
0674ec4
Update docs/release_notes/ibexa_dxp_v5.0_deprecations.md
dabrt Jul 24, 2025
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
104 changes: 104 additions & 0 deletions docs/release_notes/ibexa_dxp_v5.0_deprecations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,7 @@
| `ezurl` | `ibexa_url` |
| `ezuser` | `ibexa_user` |


## PHP API classes and methods

!!! note "[[= product_name_base =]] Rector"
Expand Down Expand Up @@ -515,6 +516,109 @@
| `\Ibexa\Contracts\Workflow\Service\WorkflowServiceInterface::loadWorkflowMetadataOriginatedByUser` | Removed |
| `\Ibexa\Contracts\Workflow\Service\WorkflowServiceInterface::loadAllWorkflowMetadata` | Removed |

## PHP method parameters

The `ValueObject` argument was replaced by `object` in a number of interfaces in `core` and `migrations` package.
In `core`, this change improves extensibility by enabling the use of custom object types to be interpreted by `PermissionResolver`.
In `migrations`, it makes it easier to integrate custom data types, especially when using `AbstractStepFactory`.

!!! note "Change examples"

Below the lists you may find examples of changes in those interfaces or classes that you are most likely to use in your work.

Check warning on line 528 in docs/release_notes/ibexa_dxp_v5.0_deprecations.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/release_notes/ibexa_dxp_v5.0_deprecations.md#L528 

[Ibexa.EOLWhitespace] Remove whitespace characters from the end of the line.
Raw output 
{"message": "[Ibexa.EOLWhitespace] Remove whitespace characters from the end of the line.", "location": {"path": "docs/release_notes/ibexa_dxp_v5.0_deprecations.md", "range": {"start": {"line": 528, "column": 1}}}, "severity": "WARNING"}
### ibexa/core

| PHP Interface or class | Methods |
|:------------------------------------------------------|:------------------------------------------------------------------------|
| `Ibexa\Contracts\Core\Repository\PermissionResolver` | `canUser`, `lookupLimitations` |
| `Ibexa\Contracts\Core\Limitation/TargetAwareType` | `evaluate` |
| `Ibexa\Contracts\Core\Limitation/Type` | `evaluate` |
| `Ibexa\Core\Limitation\BlockingLimitationType` | `evaluate` |
| `Ibexa\Core\Limitation\ChangeOwnerLimitationType` | `evaluate` |
| `Ibexa\Core\Limitation\ContentTypeLimitationType` | `evaluate` |
| `Ibexa\Core\Limitation\LanguageLimitationType` | `evaluate` |
| `Ibexa\Core\Limitation\LocationLimitationType` | `evaluate` |
| `Ibexa\Core\Limitation\MemberOfLimitationType` | `evaluate` |
| `Ibexa\Core\Limitation\NewObjectStateLimitationType` | `evaluate` |
| `Ibexa\Core\Limitation\NewSectionLimitationType` | `evaluate` |
| `Ibexa\Core\Limitation\ObjectStateLimitationType` | `evaluate` |
| `Ibexa\Core\Limitation\OwnerLimitationType` | `evaluate` |
| `Ibexa\Core\Limitation\ParentContentTypeLimitationType` | `evaluate` |
| `Ibexa\Core\Limitation\ParentDepthLimitationType` | `evaluate` |
| `Ibexa\Core\Limitation\ParentOwnerLimitationType` | `evaluate` |
| `Ibexa\Core\Limitation\ParentUserGroupLimitationType` | `evaluate` |
| `Ibexa\Core\Limitation\RoleLimitationType` | `evaluate` |
| `Ibexa\Core\Limitation\SectionLimitationType` | `evaluate` |
| `Ibexa\Core\Limitation\SiteAccessLimitationType` | `evaluate` |
| `Ibexa\Core\Limitation\StatusLimitationType` | `evaluate` |
| `Ibexa\Core\Limitation\SubtreeLimitationType` | `evaluate` |
| `Ibexa\Core\Limitation\UserGroupLimitationType` | `evaluate` |
| `Ibexa\Core\Repository\Permission\CachedPermissionService` | `canUser`, `lookupLimitations` |
| `Ibexa\Core\Repository\Permission\PermissionResolver` | `canUser`, `lookupLimitations` |

??? note "Changes in `src/contracts/Repository/PermissionResolver.php`"

![`PermissionResolver.php`](5.0_Repository.PermissionResolver.png)

### ibexa/migrations

| PHP Interface or class | Methods |
|:------------------------------------------------------|:------------------------------------------------------------------------|
| `Ibexa\Contracts\Migration\StepExecutor\AbstractStepExecutor` | `doCollectReferences`, `handleActions` |
| `Ibexa\Migration\Generator\Content\StepBuilder\Create` | `build` |
| `Ibexa\Migration\Generator\Content\StepBuilder\Delete` | `build` |
| `Ibexa\Migration\Generator\Content\StepBuilder\Factory` | `prepareLogMessage` |
| `Ibexa\Migration\Generator\Content\StepBuilder\Update` | `build` |
| `Ibexa\Migration\Generator\ContentTypeGroup\StepBuilder\Create` | `build` |
| `Ibexa\Migration\Generator\ContentTypeGroup\StepBuilder\Delete` | `build` |
| `Ibexa\Migration\Generator\ContentTypeGroup\StepBuilder\Factory` | `prepareLogMessage` |
| `Ibexa\Migration\Generator\ContentTypeGroup\StepBuilder\Update` | `build` |
| `Ibexa\Migration\Generator\Language\StepBuilder\Create` | `build` |
| `Ibexa\Migration\Generator\Language\StepBuilder\Factory` | `prepareLogMessage` |
| `Ibexa\Migration\Generator\Location\StepBuilder\Factory` | `prepareLogMessage` |
| `Ibexa\Migration\Generator\Location\StepBuilder\Update` | `build` |
| `Ibexa\Migration\Generator\ObjectState\StepBuilder\Create` | `build` |
| `Ibexa\Migration\Generator\ObjectState\StepBuilder\Factory` | `prepareLogMessage` |
| `Ibexa\Migration\Generator\ObjectStateGroup\StepBuilder\Create` | `build` |
| `Ibexa\Migration\Generator\ObjectStateGroup\StepBuilder\Factory` | `prepareLogMessage` |
| `Ibexa\Migration\Generator\Role\StepBuilder\RoleCreateStepBuilder` | `build` |
| `Ibexa\Migration\Generator\Role\StepBuilder\RoleDeleteStepBuilder` | `build` |
| `Ibexa\Migration\Generator\Role\StepBuilder\RoleStepFactory` | `prepareLogMessage` |
| `Ibexa\Migration\Generator\Role\StepBuilder\RoleUpdateStepBuilder` | `build` |
| `Ibexa\Migration\Generator\Section\StepBuilder\Create` | `build` |
| `Ibexa\Migration\Generator\Section\StepBuilder\Factory` | `prepareLogMessage` |
| `Ibexa\Migration\Generator\Section\StepBuilder\Update` | `build` |
| `Ibexa\Migration\Generator\StepBuilder\AbstractStepFactory` | `create`, `log`, `prepareLogMessage` |
| `Ibexa\Migration\Generator\StepBuilder\ContentTypeCreateStepBuilder` | `build` |
| `Ibexa\Migration\Generator\StepBuilder\ContentTypeDeleteStepBuilder` | `build` |
| `Ibexa\Migration\Generator\StepBuilder\ContentTypeStepFactory` | `prepareLogMessage` |
| `Ibexa\Migration\Generator\StepBuilder\ContentTypeUpdateStepBuilder` | `build` |
| `Ibexa\Migration\Generator\StepBuilder\LoggerContentTypeCreateStepBuilder` | `build` |
| `Ibexa\Migration\Generator\StepBuilder\StepBuilderInterface` | `build` |
| `Ibexa\Migration\Generator\StepBuilder\StepFactoryInterface` | `build` |
| `Ibexa\Migration\Generator\User\StepBuilder\Create` | `build` |
| `Ibexa\Migration\Generator\User\StepBuilder\Factory` | `prepareLogMessage` |
| `Ibexa\Migration\Generator\User\StepBuilder\Update` | `build` |
| `Ibexa\Migration\Generator\UserGroup\StepBuilder\Create` | `build` |
| `Ibexa\Migration\Generator\UserGroup\StepBuilder\Delete` | `build` |
| `Ibexa\Migration\Generator\UserGroup\StepBuilder\Factory` | `prepareLogMessage` |
| `Ibexa\Migration\Generator\UserGroup\StepBuilder\Update` | `build` |
| `Ibexa\Migration\StepExecutor\ReferenceDefinition\Resolver` | `resolve` |
| `Ibexa\Migration\StepExecutor\ReferenceDefinition\ResolverInterface` | `resolve` |


??? note "Changes in `Ibexa\Migration\Generator\StepBuilder\StepFactoryInterface`"

![`StepFactoryInterface.php`](5.0_StepBuilder.StepFactoryInterface.png)

??? note "Changes in `Ibexa\Migration\StepExecutor\ReferenceDefinition\ResolverInterface`"

![`ResolverInterface.php`](5.0_StepExecutor.ReferenceDefinition.ResolverInterface.png)

??? note "Changes in `Ibexa\Migration\Generator\StepBuilder\AbstractStepFactory`"

![`AbstractStepFactory.php`](5.0_StepBuilder.AbstractStepFactory.png)

## Services

The following service definitions have been removed:
Expand Down
Binary file added docs/release_notes/img/5.0_Repository.PermissionResolver.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/release_notes/img/5.0_StepBuilder.AbstractStepFactory.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/release_notes/img/5.0_StepBuilder.StepFactoryInterface.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/release_notes/img/5.0_StepExecutor.ReferenceDefinition.ResolverInterface.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading