Mention new database PIP in PHP database API documentation
authorMatthias Schmidt <gravatronics@live.com>
Tue, 16 Mar 2021 13:22:38 +0000 (14:22 +0100)
committerMatthias Schmidt <gravatronics@live.com>
Tue, 16 Mar 2021 13:22:38 +0000 (14:22 +0100)
docs/package/database-php-api.md

index 1b391c2370213ac0930f7fe3b6e0f76f10913392..26a84eefc3940f4cd579b6dcf67616cb4a0e2ac9 100644 (file)
@@ -7,7 +7,7 @@ We have added a new PHP-based API to manipulate the database scheme which can be
 
 ```php
 $tables = [
-       // TODO
+       // list of `DatabaseTable` objects
 ];
 
 (new DatabaseTableChangeProcessor(
@@ -20,6 +20,14 @@ $tables = [
 
 All of the relevant components can be found in the `wcf\system\database\table` namespace.
 
+With WoltLab Suite 5.4, you should use the new [database](pip/database.md) package installation plugin for which you only have to return the array of affected database tables:
+
+```php
+return [
+       // list of `DatabaseTable` objects
+];
+```
+
 
 ## Database Tables