Skip to content

Commit 108491c

Browse files
authored
[server process monitor] minor doc comment changes (#9457)
Minor documentation changes of the server process monitor that were present in #9154 and extracted into a new PR.
1 parent 80b3982 commit 108491c

File tree

2 files changed

+15
-15
lines changed

2 files changed

+15
-15
lines changed

modules/server_processes_manager/php/mriuploadserverprocess.class.inc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -52,25 +52,25 @@ class MriUploadServerProcess extends AbstractServerProcess
5252
private $_sourceLocation;
5353

5454
/**
55-
* Root of the MRI files directory.
55+
* The value of MRICodePath config setting.
5656
*
5757
* @var string
5858
*/
5959
private $_mriCodePath;
6060

6161
/**
62-
* Path of the environment file (relative to $_mriCodePath).
62+
* The value of MriConfigFile config setting.
6363
*
6464
* @var string
6565
*/
66-
private $_environmentFile;
66+
private $_prodFile;
6767

6868
/**
69-
* Path of the prod file (relative to $_mriCodePath/dicom-archive/.loris-mri).
69+
* The value of EnvironmentFile config setting.
7070
*
7171
* @var string
7272
*/
73-
private $_prodFile;
73+
private $_environmentFile;
7474

7575
/**
7676
* Builds a new MriUploadServerProcess
@@ -99,7 +99,7 @@ class MriUploadServerProcess extends AbstractServerProcess
9999
$config =& \NDB_Config::singleton();
100100
if (is_null($config)) {
101101
throw new \RuntimeException(
102-
"Cannot construct MriUploadTask: unable to instantiate
102+
"Cannot construct MriUploadTask: unable to instantiate
103103
configuration object"
104104
);
105105
}

modules/server_processes_manager/php/serverprocessesmonitor.class.inc

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -72,14 +72,14 @@ class ServerProcessesMonitor
7272
* whatever is stored in the database for that process, the information
7373
* stored in the database is updated to reflect the current process state.
7474
*
75-
* @param array $idsToMonitor IDs of the server processes to monitor.
76-
* If null, then the state of all the processes
77-
* stored in the database is returned.
78-
* @param string $userid only the processes run by the user with name
79-
* $userid are considered. If null, then the userid
80-
* check is not performed.
81-
* @param string $type the type of server processes to retrieve. If null
82-
* then all types are considered.
75+
* @param array $idsToMonitor IDs of the server processes to monitor.
76+
* If null, then the state of all the processes
77+
* stored in the database is returned.
78+
* @param string|null $userid Only the processes run by the user with name
79+
* $userid are considered. If null, then the
80+
* userid check is not performed.
81+
* @param string|null $type The type of server processes to retrieve. If
82+
* null then all types are considered.
8383
*
8484
* @return array (associative) of the current state of the processes.
8585
* @throws \DatabaseException if connection to the database cannot be
@@ -93,7 +93,7 @@ class ServerProcessesMonitor
9393
//------------------------------------------------------
9494
$db = $this->getDatabaseProvider()->getDatabase();
9595

96-
$query = "SELECT id, pid, type, userid, stdout_file, stderr_file,
96+
$query = "SELECT id, pid, type, userid, stdout_file, stderr_file,
9797
exit_code_file, exit_code, start_time, end_time,
9898
exit_text
9999
FROM server_processes

0 commit comments

Comments
 (0)