Cleans up the phpdoc comments

main
Yasen Pramatarov 2024-11-29 18:38:49 +02:00
parent 28f9fa1007
commit b94613f049
9 changed files with 20 additions and 8 deletions

View File

@ -12,6 +12,7 @@ class Config {
* *
* @param array $updatedConfig Key-value pairs of configuration options to update. * @param array $updatedConfig Key-value pairs of configuration options to update.
* @param string $config_file Path to the configuration file. * @param string $config_file Path to the configuration file.
*
* @return mixed Returns true on success, or an error message on failure. * @return mixed Returns true on success, or an error message on failure.
*/ */
public function editConfigFile($updatedConfig, $config_file) { public function editConfigFile($updatedConfig, $config_file) {
@ -55,6 +56,7 @@ class Config {
* *
* @param string $jitsiUrl The base URL of the Jitsi server. * @param string $jitsiUrl The base URL of the Jitsi server.
* @param bool $raw Whether to return the full file (true) or only uncommented values (false). * @param bool $raw Whether to return the full file (true) or only uncommented values (false).
*
* @return string The content of the config.js file or an error message. * @return string The content of the config.js file or an error message.
*/ */
public function getPlatformConfigjs($jitsiUrl, $raw = false) { public function getPlatformConfigjs($jitsiUrl, $raw = false) {
@ -103,6 +105,7 @@ class Config {
* *
* @param string $jitsiUrl The base URL of the Jitsi server. * @param string $jitsiUrl The base URL of the Jitsi server.
* @param bool $raw Whether to return the full file (true) or only uncommented values (false). * @param bool $raw Whether to return the full file (true) or only uncommented values (false).
*
* @return string The content of the interface_config.js file or an error message. * @return string The content of the interface_config.js file or an error message.
*/ */
public function getPlatformInterfaceConfigjs($jitsiUrl, $raw = false) { public function getPlatformInterfaceConfigjs($jitsiUrl, $raw = false) {

View File

@ -1,7 +1,7 @@
<?php <?php
/** /**
* Class Database * class Database
* *
* Manages database connections for SQLite and MySQL (or MariaDB). * Manages database connections for SQLite and MySQL (or MariaDB).
*/ */

View File

@ -1,7 +1,7 @@
<?php <?php
/** /**
* Class Host * class Host
* *
* Manages the hosts in the database, providing methods to retrieve, add, edit, and delete host entries. * Manages the hosts in the database, providing methods to retrieve, add, edit, and delete host entries.
*/ */

View File

@ -1,7 +1,7 @@
<?php <?php
/** /**
* Class Log * class Log
* *
* Handles logging events into a database and reading log entries. * Handles logging events into a database and reading log entries.
*/ */

View File

@ -1,7 +1,7 @@
<?php <?php
/** /**
* Class Participant * class Participant
* *
* This class provides methods to retrieve information about participants and their related conference data. * This class provides methods to retrieve information about participants and their related conference data.
* It supports querying participant details by ID, name, or IP, as well as listing all participants and counting them within a specific time frame. * It supports querying participant details by ID, name, or IP, as well as listing all participants and counting them within a specific time frame.

View File

@ -1,7 +1,7 @@
<?php <?php
/** /**
* Class Platform * class Platform
* *
* Handles platform management in the database, including retrieving, adding, editing, and deleting platforms. * Handles platform management in the database, including retrieving, adding, editing, and deleting platforms.
*/ */

View File

@ -1,7 +1,7 @@
<?php <?php
/** /**
* Class Router * class Router
* *
* A simple Router class to manage URL-to-callback mapping and dispatch requests to the appropriate controllers and methods. * A simple Router class to manage URL-to-callback mapping and dispatch requests to the appropriate controllers and methods.
* The class supports defining routes, matching URLs against patterns, and invoking callbacks for matched routes. * The class supports defining routes, matching URLs against patterns, and invoking callbacks for matched routes.

View File

@ -1,7 +1,7 @@
<?php <?php
/** /**
* Class Server * class Server
* *
* Handles server-related operations, including retrieving server status. * Handles server-related operations, including retrieving server status.
*/ */
@ -26,6 +26,7 @@ class Server {
* @param string $host The server hostname or IP address (default: '127.0.0.1'). * @param string $host The server hostname or IP address (default: '127.0.0.1').
* @param int $port The port on which the server is running (default: 8080). * @param int $port The port on which the server is running (default: 8080).
* @param string $endpoint The health check endpoint path (default: '/health'). * @param string $endpoint The health check endpoint path (default: '/health').
*
* @return bool True if the server returns a 200 OK status, otherwise false. * @return bool True if the server returns a 200 OK status, otherwise false.
*/ */
public function getServerStatus($host = '127.0.0.1', $port = 8080, $endpoint = '/health') { public function getServerStatus($host = '127.0.0.1', $port = 8080, $endpoint = '/health') {

View File

@ -1,7 +1,7 @@
<?php <?php
/** /**
* Class User * class User
* *
* Handles user-related functionalities such as registration, login, rights management, and profile updates. * Handles user-related functionalities such as registration, login, rights management, and profile updates.
*/ */
@ -25,6 +25,7 @@ class User {
* *
* @param string $username The username of the new user. * @param string $username The username of the new user.
* @param string $password The password for the new user. * @param string $password The password for the new user.
*
* @return bool|string True if registration is successful, error message otherwise. * @return bool|string True if registration is successful, error message otherwise.
*/ */
public function register($username, $password) { public function register($username, $password) {
@ -80,6 +81,7 @@ class User {
* *
* @param string $username The username of the user. * @param string $username The username of the user.
* @param string $password The password of the user. * @param string $password The password of the user.
*
* @return bool True if login is successful, false otherwise. * @return bool True if login is successful, false otherwise.
*/ */
public function login($username, $password) { public function login($username, $password) {
@ -101,6 +103,7 @@ class User {
* Retrieves a user ID based on the username. * Retrieves a user ID based on the username.
* *
* @param string $username The username to look up. * @param string $username The username to look up.
*
* @return array|null User ID details or null if not found. * @return array|null User ID details or null if not found.
*/ */
// FIXME not used now? // FIXME not used now?
@ -119,6 +122,7 @@ class User {
* Fetches user details by user ID. * Fetches user details by user ID.
* *
* @param int $user_id The user ID. * @param int $user_id The user ID.
*
* @return array|null User details or null if not found. * @return array|null User details or null if not found.
*/ */
public function getUserDetails($user_id) { public function getUserDetails($user_id) {
@ -146,6 +150,7 @@ class User {
* *
* @param int $user_id The user ID. * @param int $user_id The user ID.
* @param int $right_id The right ID to grant. * @param int $right_id The right ID to grant.
*
* @return void * @return void
*/ */
public function addUserRight($user_id, $right_id) { public function addUserRight($user_id, $right_id) {
@ -165,6 +170,7 @@ class User {
* *
* @param int $user_id The user ID. * @param int $user_id The user ID.
* @param int $right_id The right ID to revoke. * @param int $right_id The right ID to revoke.
*
* @return void * @return void
*/ */
public function removeUserRight($user_id, $right_id) { public function removeUserRight($user_id, $right_id) {
@ -202,6 +208,7 @@ class User {
* Retrieves the rights assigned to a specific user. * Retrieves the rights assigned to a specific user.
* *
* @param int $user_id The user ID. * @param int $user_id The user ID.
*
* @return array List of user rights. * @return array List of user rights.
*/ */
public function getUserRights($user_id) { public function getUserRights($user_id) {
@ -264,6 +271,7 @@ class User {
* *
* @param int $user_id The user ID. * @param int $user_id The user ID.
* @param string $right_name The human-readable name of the user right. * @param string $right_name The human-readable name of the user right.
*
* @return bool True if the user has the right, false otherwise. * @return bool True if the user has the right, false otherwise.
*/ */
function hasRight($user_id, $right_name) { function hasRight($user_id, $right_name) {