[NDB_Page] Add default maxYear for date elements (#9498)

Changed NDB_Page to have a default maxYear that is set for all date elements to '9999' if the page does not override that field with its own dateOptions * Resolves #9497
aces · Dec 10, 2024 · 4eb8f6c · 4eb8f6c
1 parent 009297f
commit 4eb8f6c
Show file tree

Hide file tree

Showing 4 changed files with 27 additions and 28 deletions.
diff --git a/php/libraries/NDB_BVL_Instrument.class.inc b/php/libraries/NDB_BVL_Instrument.class.inc
@@ -24,13 +24,6 @@ abstract class NDB_BVL_Instrument extends NDB_Page
      */
     protected $jsonData = false;
 
-    /**
-     * The form object for this instrument.
-     *
-     * @var LorisForm
-     */
-    public $form;
-
     /**
      * Variable defining the type of form in use
      *
@@ -40,13 +33,6 @@ abstract class NDB_BVL_Instrument extends NDB_Page
      */
     public $formType;
 
-    /**
-     * Array holding the date format
-     *
-     * @var array
-     */
-    public $dateOptions;
-
     /**
      * Type of instrument. Can be 'normal' or 'DirectEntry'
      *

diff --git a/php/libraries/NDB_Page.class.inc b/php/libraries/NDB_Page.class.inc
@@ -98,11 +98,13 @@ class NDB_Page extends \LORIS\Http\Endpoint implements RequestHandlerInterface
      * The default dateOptions to send to LorisForm to render elements
      * on this page. This is usually set by subclasses of NDB_Page which
      * need to modify the options to show on a date (ie. min year, max year,
-     * etc.)
+     * etc.). Default values can be added here, which can be overriden.
      *
      * @var array
      */
-    public $dateOptions;
+    public $dateOptions = [
+        'maxYear' => '9999'
+    ];
 
     /**
      * Does the setup required for this page. By default, sets up elements
@@ -315,9 +317,7 @@ class NDB_Page extends \LORIS\Http\Endpoint implements RequestHandlerInterface
             'style' => 'max-width:33%; display:inline-block;',
         ]
     ) {
-        if ($options === [] && !empty($this->dateOptions)) {
-            $options = $this->dateOptions;
-        }
+        $options = ($options ?? []) + $this->dateOptions;
         $this->form->addElement('date', $field, $label, $options, $attribs);
     }
 
@@ -592,7 +592,7 @@ class NDB_Page extends \LORIS\Http\Endpoint implements RequestHandlerInterface
     function createDate(
         $field,
         $label,
-        $dateOptions=null,
+        $dateOptions=[],
         $attribs=[
             'class' => 'form-control input-sm',
             'style' => 'max-width:33%; display:inline-block;',
@@ -602,7 +602,7 @@ class NDB_Page extends \LORIS\Http\Endpoint implements RequestHandlerInterface
             "date",
             $field,
             $label,
-            $dateOptions,
+            ($dateOptions ?? []) + $this->dateOptions,
             $attribs
         );
     }

diff --git a/test/unittests/NDB_BVL_Instrument_Test.php b/test/unittests/NDB_BVL_Instrument_Test.php
@@ -546,7 +546,10 @@ function testAddCustomDateElement()
                         'type'    => 'date',
                         'html'    => $this->_instrument->form
                             ->renderElement($groupEl['elements'][0]),
-                        'options' => ['value' => 'Option']
+                        'options' => [
+                            'value'   => 'Option',
+                            'maxYear' => '9999'
+                        ]
                     ],
                     [
                         'label'   => null,

diff --git a/test/unittests/NDB_PageTest.php b/test/unittests/NDB_PageTest.php
@@ -243,7 +243,7 @@ public function testAddBasicTextArea()
     /**
      * Test that addBasicDate calls addElement from LorisForm and properly adds
      * an element to the page's form when dateOptions is not set. Since
-     * dateOptions is not set, the options array should remain empty.
+     * dateOptions is not set, the options array should have the default maxYear.
      *
      * @covers NDB_Page::addBasicDate
      * @return void
@@ -256,7 +256,9 @@ public function testAddBasicDateWithNoDateOptions()
                 'label'   => 'test_label',
                 'type'    => 'date',
                 'class'   => 'form-control input-sm',
-                'options' => []
+                'options' => [
+                    'maxYear' => '9999'
+                ]
             ],
             $this->_page->form->form['test_name']
         );
@@ -265,21 +267,27 @@ public function testAddBasicDateWithNoDateOptions()
     /**
      * Test that addBasicDate calls addElement from LorisForm and properly adds
      * an element to the page's form when dateOptions is set. Since
-     * dateOptions is set, the options array should have information in it.
+     * dateOptions is set, the options array should have that information in it
      *
      * @covers NDB_Page::addBasicDate
      * @return void
      */
     public function testAddBasicDateWithDateOptionsSet()
     {
-        $this->_page->dateOptions = ['someOption' => 'true'];
+        $this->_page->dateOptions = [
+            'someOption' => 'true',
+            'maxYear'    => '2028'
+        ];
         $this->_page->addBasicDate("test_name", "test_label");
         $this->assertEquals(
             ['name'    => 'test_name',
                 'label'   => 'test_label',
                 'type'    => 'date',
                 'class'   => 'form-control input-sm',
-                'options' => ['someOption' => 'true']
+                'options' => [
+                    'someOption' => 'true',
+                    'maxYear'    => '2028'
+                ]
             ],
             $this->_page->form->form['test_name']
         );
@@ -603,7 +611,9 @@ public function testCreateDate()
                 'label'   => 'test_label',
                 'type'    => 'date',
                 'class'   => 'form-control input-sm',
-                'options' => null
+                'options' => [
+                    'maxYear' => '9999'
+                ]
             ],
             $this->_page->createDate("test_field", "test_label")
         );