Merge pull request #433 from WoltLab/box-config

Document migration to new box commands
WoltLab · May 8, 2024 · 81172da · 81172da
2 parents 8b3a387 + 0bf1492
commit 81172da
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 0 deletions.
diff --git a/docs/migration/wsc60/deprecations_removals.md b/docs/migration/wsc60/deprecations_removals.md
@@ -16,6 +16,8 @@ With version 6.1, we have deprecated certain components and removed several othe
 
 - `wcf\system\session\SessionHandler::resetSessions()` ([WoltLab/WCF#3767](https://github.com/WoltLab/WCF/pull/3767))
 - `wcf\system\comment\manager\ICommentManager::canModerate()` ([WoltLab/WCF#5852](https://github.com/WoltLab/WCF/pull/5852/))
+- `wcf\system\box\BoxHandler::createBoxCondition()` ([WoltLab/WCF#5906](https://github.com/WoltLab/WCF/pull/5906))
+- `wcf\system\box\BoxHandler::addBoxToPageAssignments()` ([WoltLab/WCF#5906](https://github.com/WoltLab/WCF/pull/5906))
 
 ### JavaScript
 

diff --git a/docs/migration/wsc60/php.md b/docs/migration/wsc60/php.md
@@ -66,3 +66,25 @@ $event->setDescription(
 );
 $event->setLink($object->getLink());
 ```
+
+## Box Configuration
+
+The Methods `wcf\system\box\BoxHandler::createBoxCondition()` and `wcf\system\box\BoxHandler::addBoxToPageAssignments()` were used for the configuration of boxes during package installation. These methods were deprecated with version 6.1, as they led to an initialization of the box handler and can therefore cause undesirable side effects.
+
+The new commands `wcf\system\box\command\CreateBoxCondition` and `wcf\system\box\command\CreateBoxToPageAssignments` can be used instead.
+
+Example:
+
+```php
+(new \wcf\system\box\command\CreateBoxCondition(
+    'boxIdentifier',
+    'conditionDefinition',
+    'conditionObjectType',
+    ['parameter' => 12345]
+))();
+
+(new \wcf\system\box\command\CreateBoxToPageAssignments(
+    'boxIdentifier',
+    ['pageIdentifier']
+))();
+```