From 9b250f51fbd26c7e366e5001eb6006395d7cd87a Mon Sep 17 00:00:00 2001
From: Julien Chaffraix <julien.chaffraix@gmail.com>
Date: Thu, 12 Dec 2024 14:51:20 -0800
Subject: [PATCH 1/2] Type pinc/ProjectSearch*

Typing all those files together made sense as
they are all helping the search feature.

TESTS=Run searches by different fields.
---
 pinc/ProjectSearchForm.inc          | 44 +++++++++--------
 pinc/ProjectSearchResults.inc       | 74 +++++++++++++++--------------
 pinc/ProjectSearchResultsConfig.inc | 26 +++++-----
 3 files changed, 76 insertions(+), 68 deletions(-)

diff --git a/pinc/ProjectSearchForm.inc b/pinc/ProjectSearchForm.inc
index d612ed5f7..c28ce5932 100644
--- a/pinc/ProjectSearchForm.inc
+++ b/pinc/ProjectSearchForm.inc
@@ -16,7 +16,7 @@ class ProjectSearchWidget
     private int $size;
     private array $options;
 
-    public function __construct($properties)
+    public function __construct(array $properties)
     {
         foreach ($properties as $property => $value) {
             $this->$property = $value;
@@ -76,7 +76,7 @@ class ProjectSearchWidget
         }
     }
 
-    public function echo_search_item()
+    public function echo_search_item(): void
     {
         // could fix width of heading cells so they line up when 2nd table is below
         echo "
@@ -86,11 +86,11 @@ class ProjectSearchWidget
             </tr>";
     }
 
-    public function get_sql_contribution()
+    public function get_sql_contribution(): string
     {
         $value = $_GET[$this->id] ?? '';
         if ($value == '') {
-            return null;
+            return '';
         }
         [$column_name, $comparator] = $this->q_contrib;
         if (@$this->can_be_multiple) {
@@ -102,7 +102,7 @@ class ProjectSearchWidget
                 // If $value isn't an array, someone is mucking with
                 // the URL -- return instead of erroring out below.
                 if (!is_array($values)) {
-                    return null;
+                    return '';
                 }
                 // If the user picks the 'any' option as well as some others,
                 // remove the any option.
@@ -110,7 +110,7 @@ class ProjectSearchWidget
                     unset($values[$key]);
                 }
                 if (empty($values)) {
-                    return null;
+                    return '';
                 }
             }
 
@@ -118,7 +118,7 @@ class ProjectSearchWidget
         } else {
             // if $value is an array, someone is mucking with URL
             if (is_array($value)) {
-                return null;
+                return '';
             }
 
             $value = DPDatabase::escape($value);
@@ -132,7 +132,7 @@ class ProjectSearchWidget
         return $contribution;
     }
 
-    public function sql_from_multi($values, $column_name, $comparator)
+    public function sql_from_multi(array $values, string $column_name, string $comparator): ?string
     {
         // if any $value is an array, someone is mucking with the URL
         foreach ($values as $value) {
@@ -157,7 +157,7 @@ class ProjectSearchWidget
 
 class SpecialDayWidget extends ProjectSearchWidget
 {
-    public function sql_from_multi($values, $column_name, $comparator)
+    public function sql_from_multi(array $values, string $column_name, string $comparator): ?string
     {
         // if any $value is an array, someone is mucking with the URL
         foreach ($values as $value) {
@@ -189,7 +189,7 @@ class HoldWidget extends ProjectSearchWidget
         return "<input type='checkbox' name='$this->id'$check>";
     }
 
-    public function get_sql_contribution()
+    public function get_sql_contribution(): string
     {
         if (isset($_GET[$this->id])) { // can only be 'on'
             return 'project_holds.projectid IS NOT NULL';
@@ -208,7 +208,8 @@ class ProjectSearchForm
         $this->define_form_widgets();
     }
 
-    public function all_special_day_options()
+    /** @return array<string, string> */
+    public function all_special_day_options(): array
     {
         return [
             '' => _('Any day'),
@@ -218,7 +219,8 @@ class ProjectSearchForm
         ] + $this->special_day_options();
     }
 
-    public static function special_day_options()
+    /** @return array<string, string> */
+    public static function special_day_options(): array
     {
         $special_days = load_special_days();
         sort_special_days($special_days, "open_month,open_day");
@@ -228,7 +230,8 @@ class ProjectSearchForm
         );
     }
 
-    public static function language_options()
+    /** @return array<string, string> */
+    public static function language_options(): array
     {
         $lang_options[''] = _('Any');
 
@@ -249,17 +252,20 @@ class ProjectSearchForm
         return $lang_options;
     }
 
-    public static function genre_options()
+    /** @return array<string, string> */
+    public static function genre_options(): array
     {
         return array_merge(['' => _('Any')], load_genre_translation_array());
     }
 
-    public static function difficulty_options()
+    /** @return array<string, string> */
+    public static function difficulty_options(): array
     {
         return array_merge(['' => _('Any')], get_project_difficulties());
     }
 
-    public static function state_options()
+    /** @return array<string, string> */
+    public static function state_options(): array
     {
         $state_options[''] = _('Any state');
         foreach (ProjectStates::get_states() as $proj_state) {
@@ -268,7 +274,7 @@ class ProjectSearchForm
         return $state_options;
     }
 
-    public function define_form_widgets()
+    public function define_form_widgets(): void
     {
         $this->widgets = [
             new ProjectSearchWidget([
@@ -374,7 +380,7 @@ class ProjectSearchForm
         ];
     }
 
-    public function render()
+    public function render(): void
     {
         echo "<p>" . _("Search for projects matching the following criteria:")."</p>\n";
         echo "<div class='search-columns'>
@@ -416,7 +422,7 @@ class ProjectSearchForm
         ";
     }
 
-    public function get_condition()
+    public function get_condition(): string
     {
         $condition = '1';
         foreach ($this->widgets as $widget) {
diff --git a/pinc/ProjectSearchResults.inc b/pinc/ProjectSearchResults.inc
index 2dada7242..3eac9d52f 100644
--- a/pinc/ProjectSearchResults.inc
+++ b/pinc/ProjectSearchResults.inc
@@ -20,7 +20,7 @@ class Column
     private Settings $userSettings;
     private string $search_origin;
 
-    public function __construct($id, $label, $long_label, $css_class, $default_display, $sortable, $db_column)
+    public function __construct(string $id, string $label, string $long_label, string $css_class, bool $default_display, bool $sortable, string $db_column)
     {
         $this->id = $id;
         $this->label = $label;
@@ -31,17 +31,17 @@ class Column
         $this->db_column = $db_column;
     }
 
-    public function get_label()
+    public function get_label(): string
     {
         return $this->label;
     }
 
-    public function get_warning()
+    public function get_warning(): string
     {
         return '';
     }
 
-    public function get_long_label()
+    public function get_long_label(): string
     {
         // can also be overridden
         if (empty($this->long_label)) {
@@ -50,7 +50,7 @@ class Column
         return $this->long_label;
     }
 
-    public function get_tooltip()
+    public function get_tooltip(): string
     {
         return $this->get_long_label();
     }
@@ -60,13 +60,13 @@ class Column
         return $this->db_column; // overridden by state column
     }
 
-    public function set_datastore($userSettings, $search_origin)
+    public function set_datastore(Settings $userSettings, string $search_origin): void
     {
         $this->userSettings = $userSettings;
         $this->search_origin = $search_origin;
     }
 
-    public function set_active($setting)
+    public function set_active(bool $setting): void
     {
         // We can't use set_boolean() because this actually has three states, not two:
         // * true
@@ -81,7 +81,7 @@ class Column
         $this->userSettings->set_value("search:{$this->search_origin}.column:$this->id", $value);
     }
 
-    public function is_active()
+    public function is_active(): bool
     {
         // See comment in set_active() for why we can't use get/set_boolean()
         $value = $this->userSettings->get_value("search:{$this->search_origin}.column:$this->id");
@@ -92,7 +92,7 @@ class Column
         return $value === 'yes';
     }
 
-    public function echo_header_cell($sort_column_id, $sql_sort_dir, $sec_sort)
+    public function echo_header_cell(string $sort_column_id, string $sql_sort_dir, string $sec_sort): void
     {
         $label = $this->get_label();
         if ($this->sortable) {
@@ -126,14 +126,14 @@ class Column
         echo "<th class='$this->css_class' title='", attr_safe($this->get_tooltip()), "'>$label</th>\n";
     }
 
-    public function echo_data_cell($project)
+    public function echo_data_cell(ProjectSearchResultEntry $project): void
     {
         echo "<td class='$this->css_class'>";
         $this->print_cell_data($project);
         echo "</td>\n";
     }
 
-    public function print_cell_data($project)
+    public function print_cell_data(ProjectSearchResultEntry $project): void
     {
         echo html_safe($project->{$this->db_column});
     }
@@ -143,13 +143,13 @@ class TimeColumn extends Column
 {
     private string $time_format;
 
-    public function __construct($id, $label, $long_label, $css_class, $default_display, $sortable, $db_column, $time_format)
+    public function __construct(string $id, string $label, string $long_label, string $css_class, bool $default_display, bool $sortable, string $db_column, string $time_format)
     {
         parent::__construct($id, $label, $long_label, $css_class, $default_display, $sortable, $db_column);
         $this->time_format = $time_format;
     }
 
-    public function get_label()
+    public function get_label(): string
     {
         $label = $this->label;
         if ($this->time_format == 'days') {
@@ -159,7 +159,7 @@ class TimeColumn extends Column
         return $label;
     }
 
-    public function print_cell_data($project)
+    public function print_cell_data(ProjectSearchResultEntry $project): void
     {
         $data = $project->{$this->db_column};
         if (0 == $data) {
@@ -179,7 +179,7 @@ class TimeColumn extends Column
 
 class PGColumn extends Column
 {
-    public function print_cell_data($project)
+    public function print_cell_data(ProjectSearchResultEntry $project): void
     {
         $postednum = $project->postednum;
         echo "<a href='", get_pg_catalog_url_for_etext($postednum), "'>$postednum</a>";
@@ -188,7 +188,7 @@ class PGColumn extends Column
 
 class TitleColumn extends Column
 {
-    public function print_cell_data($project)
+    public function print_cell_data(ProjectSearchResultEntry $project): void
     {
         global $code_url;
         echo "<a href='$code_url/project.php?id=$project->projectid'>" . html_safe($project->nameofwork) . "</a>";
@@ -197,7 +197,7 @@ class TitleColumn extends Column
 
 class LinkColumn extends Column
 {
-    public function print_cell_data($project)
+    public function print_cell_data(ProjectSearchResultEntry $project): void
     {
         $name = $project->{$this->db_column};
         if ($name != '') {
@@ -209,12 +209,12 @@ class LinkColumn extends Column
 
 class GenreColumn extends Column
 {
-    public function get_long_label()
+    public function get_long_label(): string
     {
         return _('Difficulty') . " + " . $this->label;
     }
 
-    public function print_cell_data($project)
+    public function print_cell_data(ProjectSearchResultEntry $project): void
     {
         $diff_prefix = [
             "beginner" => _("BEGINNERS"),
@@ -233,12 +233,12 @@ class GenreColumn extends Column
 
 class StateChangeColumn extends TimeColumn
 {
-    public function get_warning()
+    public function get_warning(): string
     {
         return _("The 'Last State Change' column tracks forward progress through the proofreading and formatting rounds well, but does not reflect Post-processing state changes or state changes to Unavailable accurately.");
     }
 
-    public function get_tooltip()
+    public function get_tooltip(): string
     {
         return _("Last State Change (see note above)");
     }
@@ -251,7 +251,7 @@ class StateColumn extends Column
         return sql_collator_for_project_state('state');
     }
 
-    public function print_cell_data($project)
+    public function print_cell_data(ProjectSearchResultEntry $project): void
     {
         global $pguser, $code_url;
 
@@ -280,13 +280,13 @@ class StateColumn extends Column
                     onchange='this.form.submit()'>
             ";
 
-            $this->_echo_project_state_option($project->state, 1);
+            $this->_echo_project_state_option($project->state, true);
 
             foreach ($transitions as $transition) {
                 $disabled = $transition->is_disabled($project);
                 $optional_reason = $transition->why_disabled($project);
 
-                $this->_echo_project_state_option($transition->to_state, 0, $disabled, $optional_reason);
+                $this->_echo_project_state_option($transition->to_state, false, $disabled, $optional_reason);
             }
 
             echo "
@@ -298,7 +298,7 @@ class StateColumn extends Column
         }
     }
 
-    private function _echo_project_state_option($project_state, $selected, $disabled = 0, $reason = '')
+    private function _echo_project_state_option(string $project_state, bool $selected, bool $disabled = false, $reason = ''): void
     {
         echo "<option value='" . attr_safe($project_state) . "'";
         if ($selected) {
@@ -322,7 +322,7 @@ class StateColumn extends Column
 
 class OptionsColumn extends Column
 {
-    public function print_cell_data($project)
+    public function print_cell_data(ProjectSearchResultEntry $project): void
     {
         global $pguser, $code_url;
         $projectid = $project->projectid;
@@ -379,7 +379,7 @@ class OptionsColumn extends Column
 
 class HoldColumn extends Column
 {
-    public function print_cell_data($project)
+    public function print_cell_data(ProjectSearchResultEntry $project): void
     {
         global $code_url;
 
@@ -405,7 +405,7 @@ class ColumnData
     protected string $search_origin;
     public array $columns;
 
-    public function __construct($userSettings, $search_origin, $time_format = '')
+    public function __construct(Settings $userSettings, string $search_origin, string $time_format = '')
     {
         global $pguser;
 
@@ -487,7 +487,7 @@ class ProjectSearchResults
     private string $sql_sort_dir;
     private string $sec_sort;
 
-    public function __construct($search_origin)
+    public function __construct(string $search_origin)
     {
         global $pguser;
 
@@ -516,7 +516,7 @@ class ProjectSearchResults
         $this->get_sorting();
     }
 
-    private function results_navigator($numrows, $num_found_rows, $results_offset)
+    private function results_navigator(int $numrows, int $num_found_rows, int $results_offset): void
     {
         if ($results_offset > 0) {
             $prev_offset = max(0, $results_offset - $this->page_size);
@@ -537,7 +537,7 @@ class ProjectSearchResults
         }
     }
 
-    private function get_sort_sql($col_id): ?string
+    private function get_sort_sql(string $col_id): ?string
     {
         foreach ($this->active_columns as $column) {
             if ($column->sortable && ($column->id == $col_id)) {
@@ -548,7 +548,7 @@ class ProjectSearchResults
         return null;
     }
 
-    private function get_sorting()
+    private function get_sorting(): void
     {
         // sets $this->sort_column_id, sort_sql and sql_sort_dir
         // if sort parameter is given, use it
@@ -598,7 +598,8 @@ class ProjectSearchResults
         $this->sort_sql .= ", $sec_sort_sql asc";
     }
 
-    private function _search($where_condition, $results_offset)
+    /** @return array{0: bool|mysqli_result, 1: int} */
+    private function _search(string $where_condition, int $results_offset): array
     {
         global $testing;
 
@@ -613,6 +614,7 @@ class ProjectSearchResults
         ";
         $result = DPDatabase::query($sql);
         [$num_found_rows] = mysqli_fetch_row($result);
+        $num_found_rows = (int)$num_found_rows;
 
         // load the result set
         $sql = "
@@ -633,7 +635,7 @@ class ProjectSearchResults
         return [$result, $num_found_rows];
     }
 
-    public function render($where_condition)
+    public function render(string $where_condition): void
     {
         global $pguser, $theme, $code_url;
 
@@ -710,7 +712,7 @@ class ProjectSearchResults
     }
 }
 
-function get_search_configure_link()
+function get_search_configure_link(): string
 {
     $origin = urlencode($_SERVER['REQUEST_URI']);
     return "<a href='?show=config&amp;origin=$origin'>" . _("Configure Result") . "</a>";
@@ -734,7 +736,7 @@ function get_refine_search_url(): string
     return make_search_page_url(['show' => 'search_form']);
 }
 
-function get_refine_search_link($label = null): string
+function get_refine_search_link(?string $label = null): string
 {
     if (!$label) {
         $label = _("Refine Search");
diff --git a/pinc/ProjectSearchResultsConfig.inc b/pinc/ProjectSearchResultsConfig.inc
index 88950a022..51069a94e 100644
--- a/pinc/ProjectSearchResultsConfig.inc
+++ b/pinc/ProjectSearchResultsConfig.inc
@@ -10,7 +10,7 @@ abstract class Selector
 
     abstract public function get_html_control(): string;
 
-    public function echo_select_item()
+    public function echo_select_item(): void
     {
         echo "
             <tr>
@@ -25,7 +25,7 @@ class ColumnSelector extends Selector
 {
     private Column $column;
 
-    public function __construct($column, $userSettings, $search_origin)
+    public function __construct(Column $column, Settings $userSettings, string $search_origin)
     {
         $this->column = $column;
         $this->label = $column->get_long_label();
@@ -46,7 +46,7 @@ class OptionSelector extends Selector
     private string $def_value;
     private array $options;
 
-    public function __construct($id, $label, $value, $options, $userSettings, $search_origin)
+    public function __construct(string $id, string $label, string $value, array $options, Settings $userSettings, string $search_origin)
     {
         $this->id = $id;
         $this->label = $label;
@@ -83,7 +83,7 @@ class OptionSelector extends Selector
         return $value;
     }
 
-    public function save_value($value)
+    public function save_value($value): void
     {
         // Save the value but only if it has changed and is a valid option
         if ($this->get_value() != $value && isset($this->options[$value])) {
@@ -99,12 +99,12 @@ class OptionData
     /** @var OptionSelector[] */
     public array $options;
 
-    public function __construct($userSettings, $search_origin)
+    public function __construct(Settings $userSettings, string $search_origin)
     {
         $this->results_per_page = new OptionSelector(
             'n_results_per_page',
             _('Results per page'),
-            100,
+            '100',
             [30 => 30, 100 => 100, 300 => 300],
             $userSettings,
             $search_origin
@@ -128,7 +128,7 @@ class ConfigForm extends ColumnData
     private array $column_selectors;
     private OptionData $option_data;
 
-    public function __construct($userSettings, $search_origin)
+    public function __construct(Settings $userSettings, string $search_origin)
     {
         parent::__construct($userSettings, $search_origin);
         foreach ($this->columns as $column) {
@@ -138,7 +138,7 @@ class ConfigForm extends ColumnData
         $this->option_data = new OptionData($userSettings, $search_origin);
     }
 
-    public function render($page_title)
+    public function render(string $page_title): void
     {
         global $code_url, $pguser;
 
@@ -182,12 +182,12 @@ class ConfigForm extends ColumnData
 
 class ConfigSaver extends ColumnData
 {
-    public function __construct($userSettings, $search_origin)
+    public function __construct(Settings $userSettings, string $search_origin)
     {
         parent::__construct($userSettings, $search_origin);
     }
 
-    public function store_data()
+    public function store_data(): void
     {
         global $pguser;
 
@@ -218,7 +218,7 @@ class ConfigSaver extends ColumnData
     }
 }
 
-function get_search_configure_button()
+function get_search_configure_button(): string
 {
     global $code_url;
     return "
@@ -229,7 +229,7 @@ function get_search_configure_button()
         </form>";
 }
 
-function handle_set_cols($show_view, $search_origin)
+function handle_set_cols(string $show_view, string $search_origin): void
 {
     global $pguser, $code_url;
 
@@ -242,7 +242,7 @@ function handle_set_cols($show_view, $search_origin)
     }
 }
 
-function handle_config($show_view, $search_origin, $page_title)
+function handle_config(string $show_view, string $search_origin, string $page_title): void
 {
     global $pguser;
 

From bc1c0444838a96f91c011a23dd81a4a919217936 Mon Sep 17 00:00:00 2001
From: Julien Chaffraix <julien.chaffraix@gmail.com>
Date: Sun, 22 Dec 2024 09:40:14 -0800
Subject: [PATCH 2/2] Add argument type

Co-authored-by: Casey Peel <cpeel@users.noreply.github.com>
---
 pinc/ProjectSearchResults.inc | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/pinc/ProjectSearchResults.inc b/pinc/ProjectSearchResults.inc
index 3eac9d52f..a59dc2f1e 100644
--- a/pinc/ProjectSearchResults.inc
+++ b/pinc/ProjectSearchResults.inc
@@ -298,7 +298,7 @@ class StateColumn extends Column
         }
     }
 
-    private function _echo_project_state_option(string $project_state, bool $selected, bool $disabled = false, $reason = ''): void
+    private function _echo_project_state_option(string $project_state, bool $selected, bool $disabled = false, string $reason = ''): void
     {
         echo "<option value='" . attr_safe($project_state) . "'";
         if ($selected) {