There have been no scans yet.
+ );
+ setSiteRecruitments(
+ json['studyprogression']['recruitment']['overall']
+ ['total_recruitment'] > 0
+ ? There have been no candidates registered yet.
+ );
+ setLoading(false);
+ }
+ }, [props.data]);
+
+ /**
+ * Renders the React component.
+ *
+ * @return {JSX.Element} - React markup for component.
+ */
+ return loading ?
+ {siteScans}
+ ,
+ title: 'Study Progression - site scans',
+ },
+ {
+ content: <>
+ {siteRecruitments}
+ ,
+ title: 'Study Progression - site recruitment',
+ },
+ ]}
+ />
+ );
+};
+StudyProgression.propTypes = {
+ data: PropTypes.object,
+};
+StudyProgression.defaultProps = {
+ data: {},
+};
+
+export default StudyProgression;
diff --git a/modules/statistics/php/module.class.inc b/modules/statistics/php/module.class.inc
index bc1186b5c24..d1486a3d861 100644
--- a/modules/statistics/php/module.class.inc
+++ b/modules/statistics/php/module.class.inc
@@ -73,257 +73,33 @@ class Module extends \Module
switch ($type) {
case 'dashboard':
$factory = \NDB_Factory::singleton();
- $config = $factory->config();
- $db = $factory->database();
$baseURL = $factory->settings()->getBaseURL();
-
- $recruitmentTarget = $config->getSetting('recruitmentTarget');
-
- $totalScans = $this->_getTotalRecruitment($db);
- $recruitment = [
- 'overall' => $this->_createProjectProgressBar(
- 'overall',
- "Overall Recruitment",
- $recruitmentTarget,
- $totalScans,
- $db,
- )
- ];
-
- $projects = \Utility::getProjectList();
- foreach (array_keys($projects) as $projectID) {
- $projectInfo = $config->getProjectSettings($projectID);
- if (is_null($projectInfo)) {
- throw new \LorisException(
- 'No project settings exist in the Database for ' .
- 'project ID ' . intval($projectID)
- );
- }
- $recruitment[$projectID] = $this->_createProjectProgressBar(
- $projectID,
- $projectInfo['Name'],
- $projectInfo['recruitmentTarget'],
- $this->getTotalRecruitmentByProject($db, $projectID),
- $db
- );
- }
-
- // These are just here to avoid phpcs complaining about line length.
- $overallstring = 'View overall recruitment';
- $sitebreakdownstring = 'View site breakdown';
- $projbreakdownstring = 'View project breakdown';
-
- $recpersite = 'View recruitment per site';
-
- return [
- new \LORIS\dashboard\Widget(
- new \LORIS\dashboard\WidgetContent(
- "Recruitment",
- $this->renderTemplate(
- "recruitment.tpl",
- [
- 'recruitment' => $recruitment
- ]
- ),
- "",
- ),
- new \LORIS\dashboard\WidgetDisplayProps(
- "normal",
- 10,
- [
- 'overall-recruitment' => $overallstring,
- 'recruitment-site-breakdown' => $sitebreakdownstring,
- 'recruitment-project-breakdown' => $projbreakdownstring,
- ]
- ),
- new \LORIS\dashboard\WidgetDependencies(
- [
- $baseURL . "/css/c3.css",
- $baseURL . "/statistics/css/recruitment.css"
- ],
- [
- $baseURL. '/js/d3.min.js',
- $baseURL . '/js/c3.min.js',
- $baseURL . "/statistics/js/recruitment.js"
- ],
- )
+ $widget = new \LORIS\dashboard\Widget(
+ new \LORIS\dashboard\WidgetContent(
+ '',
+ '',
+ '',
),
- new \LORIS\dashboard\Widget(
- new \LORIS\dashboard\WidgetContent(
- "Study Progression",
- $this->renderTemplate(
- "studyprogression.tpl",
- [
- 'total_scans' => $totalScans,
- 'recruitment' => $recruitment
- ]
- ),
- "",
- ),
- new \LORIS\dashboard\WidgetDisplayProps(
- "normal",
- 10,
- [
- 'scan-line-chart-panel' => 'View scans per site',
- 'recruitment-line-chart-panel' => $recpersite
- ]
- ),
- new \LORIS\dashboard\WidgetDependencies(
- [
- $baseURL . "/css/c3.css"
- ],
- [
- $baseURL . '/js/d3.min.js',
- $baseURL . '/js/c3.min.js',
- $baseURL . "/statistics/js/studyprogression.js"
- ],
- )
+ new \LORIS\dashboard\WidgetDisplayProps(
+ 'normal',
+ 10,
+ []
+ ),
+ new \LORIS\dashboard\WidgetDependencies(
+ [
+ $baseURL . '/css/c3.css',
+ $baseURL . '/statistics/css/recruitment.css'
+ ],
+ [
+ $baseURL . '/statistics/js/WidgetIndex.js'
+ ],
)
- ];
- }
- return [];
- }
-
- /**
- * Gets the total count of candidates associated with a specific project
- *
- * @param \Database $DB The database connection to get the count from.
- *
- * @return int
- */
- private function _getTotalRecruitment(\Database $DB): int
- {
- return $DB->pselectOneInt(
- "SELECT COUNT(*) FROM candidate c
- WHERE c.Active='Y' AND c.Entity_type='Human'
- AND c.RegistrationCenterID <> 1",
- []
- ) ?? 0;
- }
+ );
+ $widget->setTemplate('div.tpl');
+ $widget->setTemplateVariables(['id' => 'statistics_widgets']);
- /**
- * Generates the template data for a progress bar.
- *
- * @param string $ID The name of the progress bar being
- * created.
- * @param string $title The title to add to the template
- * variables.
- * @param int $recruitmentTarget The target for this recruitment type.
- * @param int $totalRecruitment The total number of candidates of all
- * types.
- * @param \Database $db The database connection to get data from.
- *
- * @return array Smarty template data
- */
- private function _createProjectProgressBar(
- $ID,
- $title,
- $recruitmentTarget,
- $totalRecruitment,
- \Database $db
- ): array {
- $rv = [
- 'total_recruitment' => $totalRecruitment,
- 'title' => $title,
- ];
- if (empty($recruitmentTarget)) {
- return $rv;
- }
-
- $rv['recruitment_target'] = $recruitmentTarget;
- if ($ID == 'overall') {
- $totalFemales = $this->_getTotalSex($db, "Female");
- } else {
- $totalFemales = $this->getTotalSexByProject($db, "Female", intval($ID));
- }
- $rv['female_total'] = $totalFemales;
- $rv['female_percent']
- = round($totalFemales / $recruitmentTarget * 100);
- if ($ID == 'overall') {
- $totalMales = $this->_getTotalSex($db, "Male");
- } else {
- $totalMales = $this->getTotalSexByProject($db, "Male", intval($ID));
+ return [$widget];
}
- $rv['male_total'] = $totalMales;
- $rv['male_percent']
- = round($totalMales / $recruitmentTarget * 100);
- if ($totalRecruitment > $recruitmentTarget) {
- $rv['surpassed_recruitment'] = "true";
-
- $rv['female_full_percent']
- = round($totalFemales / $totalRecruitment * 100);
-
- $rv['male_full_percent']
- = round($totalMales / $totalRecruitment * 100);
- }
- return $rv;
- }
-
- /**
- * Gets the total count of candidates of a specific sex
- *
- * @param \Database $db A database connection to retrieve information
- * from.
- * @param string $sex Biological sex (male or female)
- *
- * @return int
- */
- private function _getTotalSex(\Database $db, string $sex) : int
- {
- return $db->pselectOneInt(
- "SELECT COUNT(c.CandID)
- FROM candidate c
- WHERE c.Sex=:sex AND c.Active='Y' AND c.Entity_type='Human'
- AND c.RegistrationCenterID <> 1",
- ['sex' => $sex]
- ) ?? 0;
- }
-
- /**
- * Gets the total count of candidates of a specific sex,
- * associated with a specific project
- *
- * @param \Database $DB A database connection to retrieve information
- * from.
- * @param string $sex A biological sex (male or female)
- * @param int $projectID Project ID
- *
- * @return int
- */
- function getTotalSexByProject(\Database $DB, string $sex, int $projectID) : int
- {
- return $DB->pselectOneInt(
- "SELECT COUNT(c.CandID)
- FROM candidate c
- WHERE c.Sex=:sex AND c.Active='Y' AND c.RegistrationProjectID=:PID
- AND c.Entity_type='Human' AND c.RegistrationCenterID <> 1",
- [
- 'sex' => $sex,
- 'PID' => "$projectID",
- ]
- ) ?? 0;
- }
-
-
- /**
- * Gets the total count of candidates associated with a specific project.
- *
- * @param \Database $db A database connection to retrieve information
- * from.
- * @param int $projectID The Project ID to get recruitment for.
- *
- * @return int
- */
- function getTotalRecruitmentByProject(\Database $db, int $projectID): int
- {
- return $db->pselectOneInt(
- "SELECT COUNT(*)
- FROM candidate c
- WHERE c.Active='Y'
- AND c.RegistrationProjectID=:PID
- AND c.Entity_type='Human'
- AND c.RegistrationCenterID <> 1",
- ['PID' => "$projectID"]
- ) ?? 0;
+ return [];
}
}
diff --git a/modules/statistics/php/widgets.class.inc b/modules/statistics/php/widgets.class.inc
new file mode 100644
index 00000000000..9afb6d07466
--- /dev/null
+++ b/modules/statistics/php/widgets.class.inc
@@ -0,0 +1,275 @@
+
+ * @license http://www.gnu.org/licenses/gpl-3.0.txt GPLv3
+ * @link https://www.github.com/aces/Loris/
+ */
+class Widgets extends \NDB_Page implements ETagCalculator
+{
+ /**
+ * A cache of the endpoint results, so that it doesn't need to be
+ * recalculated for the ETag and handler.
+ */
+ private $_cache;
+
+ /**
+ * The handle function will return a json response.
+ *
+ * @param ServerRequestInterface $request The incoming PSR7 request
+ *
+ * @return ResponseInterface The outgoing PSR7 response
+ */
+ public function handle(ServerRequestInterface $request) : ResponseInterface
+ {
+ switch ($request->getMethod()) {
+ case 'GET':
+ $this->_cache = $this->_handleGET($request);
+ break;
+ default:
+ return new \LORIS\Http\Response\JSON\MethodNotAllowed(
+ $this->allowedMethods()
+ );
+ }
+ return $this->_cache;
+ }
+
+ /**
+ * Handles the retrieval of statistical data for the request.
+ *
+ * @param ServerRequestInterface $request The incoming PSR7 request.
+ *
+ * @return ResponseInterface The outgoing PSR7 response
+ */
+ private function _handleGET(ServerRequestInterface $request)
+ {
+ if (isset($this->_cache)) {
+ return $this->_cache;
+ }
+ $factory = \NDB_Factory::singleton();
+ $config = $factory->config();
+ $db = $request->getAttribute('loris')->getDatabaseConnection();
+
+ $recruitmentTarget = $config->getSetting('recruitmentTarget');
+
+ $totalScans = $this->_getTotalRecruitment($db);
+ $recruitment = [
+ 'overall' => $this->_createProjectProgressBar(
+ 'overall',
+ "Overall Recruitment",
+ $recruitmentTarget,
+ $totalScans,
+ $db,
+ )
+ ];
+
+ $projects = \Utility::getProjectList();
+ foreach (array_keys($projects) as $projectID) {
+ $projectInfo = $config->getProjectSettings($projectID);
+ if (is_null($projectInfo)) {
+ throw new \LorisException(
+ 'No project settings exist in the Database for ' .
+ 'project ID ' . intval($projectID)
+ );
+ }
+ $recruitment[$projectID] = $this->_createProjectProgressBar(
+ $projectID,
+ $projectInfo['Name'],
+ $projectInfo['recruitmentTarget'],
+ $this->getTotalRecruitmentByProject($db, $projectID),
+ $db
+ );
+ }
+
+ $values = [];
+ // Used for the react widget recruitment.js
+ $values['recruitment'] = $recruitment;
+ // Used for the react widget studyprogression.js
+ $values['studyprogression'] = [
+ 'total_scans' => $totalScans,
+ 'recruitment' => $recruitment
+ ];
+
+ $this->_cache = new \LORIS\Http\Response\JsonResponse($values);
+
+ return $this->_cache;
+ }
+
+ /**
+ * Gets the total count of candidates associated with a specific project
+ *
+ * @param \Database $DB The database connection to get the count from.
+ *
+ * @return int
+ */
+ private function _getTotalRecruitment(\Database $DB): int
+ {
+ return $DB->pselectOneInt(
+ "SELECT COUNT(*) FROM candidate c
+ WHERE c.Active='Y' AND c.Entity_type='Human'
+ AND c.RegistrationCenterID <> 1",
+ []
+ ) ?? 0;
+ }
+
+ /**
+ * Generates the template data for a progress bar.
+ *
+ * @param string $ID The name of the progress bar being
+ * created.
+ * @param string $title The title to add to the template
+ * variables.
+ * @param int $recruitmentTarget The target for this recruitment type.
+ * @param int $totalRecruitment The total number of candidates of all
+ * types.
+ * @param \Database $db The database connection to get data from.
+ *
+ * @return array Smarty template data
+ */
+ private function _createProjectProgressBar(
+ $ID,
+ $title,
+ $recruitmentTarget,
+ $totalRecruitment,
+ \Database $db
+ ): array {
+ $rv = [
+ 'total_recruitment' => $totalRecruitment,
+ 'title' => $title,
+ ];
+ if (empty($recruitmentTarget)) {
+ return $rv;
+ }
+
+ $rv['recruitment_target'] = $recruitmentTarget;
+ if ($ID == 'overall') {
+ $totalFemales = $this->_getTotalSex($db, "Female");
+ } else {
+ $totalFemales = $this->getTotalSexByProject($db, "Female", intval($ID));
+ }
+ $rv['female_total'] = $totalFemales;
+ $rv['female_percent']
+ = round($totalFemales / $recruitmentTarget * 100);
+ if ($ID == 'overall') {
+ $totalMales = $this->_getTotalSex($db, "Male");
+ } else {
+ $totalMales = $this->getTotalSexByProject($db, "Male", intval($ID));
+ }
+ $rv['male_total'] = $totalMales;
+ $rv['male_percent']
+ = round($totalMales / $recruitmentTarget * 100);
+ if ($totalRecruitment > $recruitmentTarget) {
+ $rv['surpassed_recruitment'] = "true";
+
+ $rv['female_full_percent']
+ = round($totalFemales / $totalRecruitment * 100);
+
+ $rv['male_full_percent']
+ = round($totalMales / $totalRecruitment * 100);
+ }
+ return $rv;
+ }
+
+ /**
+ * Gets the total count of candidates of a specific sex
+ *
+ * @param \Database $db A database connection to retrieve information
+ * from.
+ * @param string $sex Biological sex (male or female)
+ *
+ * @return int
+ */
+ private function _getTotalSex(\Database $db, string $sex) : int
+ {
+ return $db->pselectOneInt(
+ "SELECT COUNT(c.CandID)
+ FROM candidate c
+ WHERE c.Sex=:sex AND c.Active='Y' AND c.Entity_type='Human'
+ AND c.RegistrationCenterID <> 1",
+ ['sex' => $sex]
+ ) ?? 0;
+ }
+
+ /**
+ * Gets the total count of candidates of a specific sex,
+ * associated with a specific project
+ *
+ * @param \Database $DB A database connection to retrieve information
+ * from.
+ * @param string $sex A biological sex (male or female)
+ * @param int $projectID Project ID
+ *
+ * @return int
+ */
+ function getTotalSexByProject(\Database $DB, string $sex, int $projectID) : int
+ {
+ return $DB->pselectOneInt(
+ "SELECT COUNT(c.CandID)
+ FROM candidate c
+ WHERE c.Sex=:sex AND c.Active='Y' AND c.RegistrationProjectID=:PID
+ AND c.Entity_type='Human' AND c.RegistrationCenterID <> 1",
+ [
+ 'sex' => $sex,
+ 'PID' => "$projectID",
+ ]
+ ) ?? 0;
+ }
+
+ /**
+ * Gets the total count of candidates associated with a specific project.
+ *
+ * @param \Database $db A database connection to retrieve information
+ * from.
+ * @param int $projectID The Project ID to get recruitment for.
+ *
+ * @return int
+ */
+ function getTotalRecruitmentByProject(\Database $db, int $projectID): int
+ {
+ return $db->pselectOneInt(
+ "SELECT COUNT(*)
+ FROM candidate c
+ WHERE c.Active='Y'
+ AND c.RegistrationProjectID=:PID
+ AND c.Entity_type='Human'
+ AND c.RegistrationCenterID <> 1",
+ ['PID' => "$projectID"]
+ ) ?? 0;
+ }
+
+ /**
+ * The ETagCalculator provides the ability to calculate
+ * an ETag for an incoming HTTP request.
+ *
+ * @param ServerRequestInterface $request The incoming PSR7 request.
+ *
+ * @return string The value to use for the ETag header.
+ */
+ public function ETag(ServerRequestInterface $request): string
+ {
+ return md5(json_encode($this->_handleGET($request)->getBody()));
+ }
+
+ /**
+ * Return an array of valid HTTP methods for this endpoint.
+ *
+ * @return string[] Valid versions
+ */
+ protected function allowedMethods(): array
+ {
+ return ['GET'];
+ }
+}
diff --git a/modules/statistics/templates/progress_bar.tpl b/modules/statistics/templates/progress_bar.tpl
deleted file mode 100644
index f5a822a7ac5..00000000000
--- a/modules/statistics/templates/progress_bar.tpl
+++ /dev/null
@@ -1,43 +0,0 @@
- {if $project['recruitment_target']|default neq ""}
- {$project['title']}
- {if $project['surpassed_recruitment']|default eq "true"}
- The recruitment target ({$project['recruitment_target']}) has been passed.
-
-
-
- {$project['female_total']}
-
- Females
-
-
-
-
- {$project['male_total']}
-
- Males
-
-
-
Target: {$project['recruitment_target']}
-
-
-
- {$project['female_total']}
-
- Females
-
-
-
-
- {$project['male_total']}
-
- Males
-
-
-
Target: {$project['recruitment_target']}
-
- {include file='progress_bar.tpl' project=$recruitment["overall"]}
-
-
- {if $recruitment['overall']['total_recruitment'] neq 0}
-
-
-
Total recruitment per site
-
-
-
-
-
-
Biological sex breakdown by site
-
-
-
- {else}
-
There have been no candidates registered yet.
- {/if}
-
-{foreach from=$recruitment key=ID item=project}
- {if $ID != "overall"}
- {include file='progress_bar.tpl' project=$project}
- {/if}
-{/foreach}
-
diff --git a/modules/statistics/templates/studyprogression.tpl b/modules/statistics/templates/studyprogression.tpl
deleted file mode 100644
index 5cde6d2a56f..00000000000
--- a/modules/statistics/templates/studyprogression.tpl
+++ /dev/null
@@ -1,23 +0,0 @@
-
-
Scan sessions per site
- {if $total_scans neq 0}
-
- {else}
-
There have been no scans yet.
- {/if}
-
-
Recruitment per site
- {if $recruitment['overall']['total_recruitment'] neq 0}
-
- {else}
-
There have been no candidates registered yet.
- {/if}
-