From 2bc9f085df0088d1b37556dd2cd90ededf9372f2 Mon Sep 17 00:00:00 2001 From: Philipp Date: Sun, 12 Feb 2023 23:54:11 +0100 Subject: [PATCH] Add docs --- src/DI.php | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/src/DI.php b/src/DI.php index e5601f64d2..24f06d2793 100644 --- a/src/DI.php +++ b/src/DI.php @@ -37,6 +37,15 @@ abstract class DI /** @var Dice */ private static $dice; + /** + * Initialize the singleton DI container with the Dice instance + * + * @param Dice $dice The Dice instance + * @param bool $disableDepByHand If true, the database dependencies aren't set, thus any occurrence of logging or + * profiling in database methods would lead to an error. This flag is for testing only. + * + * @return void + */ public static function init(Dice $dice, bool $disableDepByHand = false) { self::$dice = $dice; @@ -48,8 +57,9 @@ abstract class DI /** * I HATE this method, but everything else needs refactoring at the database itself + * Set the database dependencies manually, because of current, circular dependencies between the database and the config table * - * @return void + * @todo Instead of this madness, split the database in a core driver-dependent (mysql, mariadb, postgresql, ..) part without any other dependency unlike credentials and in the full-featured, driver-independent database class with all dependencies */ public static function setCompositeRootDependencyByHand() {