Cleans up the phpdoc comments

main
Yasen Pramatarov 2024-11-29 18:47:18 +02:00
parent b94613f049
commit 161f74f6bd
7 changed files with 14 additions and 7 deletions

View File

@ -13,8 +13,9 @@ class Host {
/** /**
* Host constructor. * Host constructor.
* Initializes the database connection.
* *
* @param Database $database The database connection object. * @param object $database The database object to initialize the connection.
*/ */
public function __construct($database) { public function __construct($database) {
$this->db = $database->getConnection(); $this->db = $database->getConnection();

View File

@ -12,9 +12,10 @@ class Log {
private $db; private $db;
/** /**
* Constructor to initialize the database connection. * Logs constructor.
* Initializes the database connection.
* *
* @param object $database An object providing the database connection. * @param object $database The database object to initialize the connection.
*/ */
public function __construct($database) { public function __construct($database) {
$this->db = $database->getConnection(); $this->db = $database->getConnection();

View File

@ -14,8 +14,9 @@ class Participant {
/** /**
* Constructor * Constructor
* Initializes the database connection.
* *
* @param object $database Database instance to retrieve a connection. * @param object $database The database object to initialize the connection.
*/ */
public function __construct($database) { public function __construct($database) {
$this->db = $database->getConnection(); $this->db = $database->getConnection();

View File

@ -13,8 +13,9 @@ class Platform {
/** /**
* Platform constructor. * Platform constructor.
* Initializes the database connection.
* *
* @param Database $database The database connection object. * @param object $database The database object to initialize the connection.
*/ */
public function __construct($database) { public function __construct($database) {
$this->db = $database->getConnection(); $this->db = $database->getConnection();

View File

@ -13,8 +13,9 @@ class Server {
/** /**
* Server constructor. * Server constructor.
* Initializes the database connection.
* *
* @param object $database An instance of a database connection handler. * @param object $database The database object to initialize the connection.
*/ */
public function __construct($database) { public function __construct($database) {
$this->db = $database->getConnection(); $this->db = $database->getConnection();

View File

@ -13,8 +13,9 @@ class User {
/** /**
* User constructor. * User constructor.
* Initializes the database connection.
* *
* @param object $database Database instance to retrieve a connection. * @param object $database The database object to initialize the connection.
*/ */
public function __construct($database) { public function __construct($database) {
$this->db = $database->getConnection(); $this->db = $database->getConnection();

View File

@ -9,6 +9,7 @@
* @param string $message A user-friendly message to display. * @param string $message A user-friendly message to display.
* @param string $error The detailed error message for debugging (optional). * @param string $error The detailed error message for debugging (optional).
* @param string|null $environment The environment type ('production', 'development', etc.). If null, defaults to the configured environment. * @param string|null $environment The environment type ('production', 'development', etc.). If null, defaults to the configured environment.
*
* @return string The appropriate message based on the environment. * @return string The appropriate message based on the environment.
*/ */
function getError($message, $error = '', $environment = null) { function getError($message, $error = '', $environment = null) {