evolix/evoadmin-web
22
0
Fork 1
Code Issues 32 Pull requests 5 Releases 1 Wiki Activity

Add some PHPDoc comments for ease of programming #87

Merged
lpoujol merged 6 commits from mtrossevin/evoadmin-web:doc-comments into unstable 2024-04-22 16:58:40 +02:00
Conversation 4 Commits 6 Files changed 7 +17 -17
1 changed files with 17 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files
Showing only changes of commit 659575960d - Show all commits

34
lib/bdd.php
View file

@ -1,7 +1,7 @@
<?php <?php
/** /**
* @desc mini class to manipulate sqlite db for evocluster. * mini class to manipulate sqlite db for evocluster.
* *
* @example * @example
* <?php * <?php
@ -43,7 +43,7 @@ class bdd {
private $db; /* resource of a created database */ private $db; /* resource of a created database */
/** /**
* @desc Open a sqlite database in rw mode. Create it if it doesn't exist. * Open a sqlite database in rw mode. Create it if it doesn't exist.
* @param string $db_name Name of the sqlite database * @param string $db_name Name of the sqlite database
*/ */
public function open($db_name) public function open($db_name)
@ -58,9 +58,9 @@ class bdd {
} }
/** /**
* @desc Close the current database instance * Close the current database instance
* *
* Note: php close automatically the instance on exit * Note: php automatically close the instance on exit
*/ */
public function close() public function close()
{ {
@ -68,7 +68,7 @@ class bdd {
} }
/** /**
* @desc Install the table structure on a new sqlite database * Install the table structure on a new sqlite database
* @param string $dn_name Name of the sqlite database * @param string $dn_name Name of the sqlite database
*/ */
public function create($db_name) public function create($db_name)
@ -136,7 +136,7 @@ class bdd {
} }
/** /**
* @desc Get the account id of an account_name * Get the account id of an account_name
* @param string $account_name Name of the account * @param string $account_name Name of the account
* @return int 0 if account_name doesn't exist, * @return int 0 if account_name doesn't exist,
* id else * id else
@ -159,8 +159,8 @@ class bdd {
} }
/** /**
* @desc Get account * Get account
* @param account name * @param string $account_name account name
* @return array * @return array
*/ */
public function get_account($account_name) public function get_account($account_name)
@ -183,7 +183,7 @@ class bdd {
} }
/** /**
* @desc Check if account_name entry exists on table Accounts * Check if account_name entry exists on table Accounts
* @param string $account_name Name of the account * @param string $account_name Name of the account
* @return int 1 if it exists, * @return int 1 if it exists,
* 0 else * 0 else
@ -194,7 +194,7 @@ class bdd {
} }
/** /**
* @desc Add an account to the table Accounts * Add an account to the table Accounts
* @param array { * @param array {
* 'name' => "$name", * 'name' => "$name",
* 'domain' => "$domain", * 'domain' => "$domain",
@ -236,7 +236,7 @@ class bdd {
/** /**
* @desc Add an alias to the table Serveralias * Add an alias to the table Serveralias
* @param array { * @param array {
* 'domain' => "$domain", * 'domain' => "$domain",
* 'alias' => "$alias", * 'alias' => "$alias",
@ -264,7 +264,7 @@ class bdd {
} }
/** /**
* @desc Del an alias from the table Serveralias * Delete an alias from the table Serveralias
* @param array { * @param array {
* 'domain' => "$domain", * 'domain' => "$domain",
* 'alias' => "$alias", * 'alias' => "$alias",
@ -289,7 +289,7 @@ class bdd {
} }
/** /**
* @desc Get the server id of a server_name * Get the server id of a server_name
* @param string $server_name Name of the server * @param string $server_name Name of the server
* @return int 0 if server_name doesn't exist, * @return int 0 if server_name doesn't exist,
* id else * id else
@ -312,7 +312,7 @@ class bdd {
} }
/** /**
* @desc Check if server_name entry exists on table Servers * Check if server_name entry exists on table Servers
* @param string $server_name Name of the server * @param string $server_name Name of the server
* @return int 1 if it exists, * @return int 1 if it exists,
* 0 else * 0 else
@ -324,7 +324,7 @@ class bdd {
/** /**
* @desc Add an server to the table Servers * Add an server to the table Servers
* @param array { * @param array {
* 'name' => "$name", * 'name' => "$name",
* } * }
@ -353,7 +353,7 @@ class bdd {
} }
/** /**
* @desc Add a role to the table Roles * Add a role to the table Roles
* @param string $account_name * @param string $account_name
* string $server_name * string $server_name
* string $role master or slave * string $role master or slave
@ -397,7 +397,7 @@ class bdd {
/** /**
* @desc List domains by server's role * List domains by server's role
* @param none * @param none
* @return list of array * @return list of array
* example : Array ( * example : Array (