Phpstan level 1 issues

.github/workflows/pull-requests.yml

@@ -40,6 +40,7 @@ jobs:
       - name: Run tests
         timeout-minutes: 5
         run: |
-          pnpm prettier
           composer run phpcs:ci
           composer run phpstan:ci
+          composer run phpunit
+          pnpm prettier

.gitignore

@@ -4,10 +4,14 @@
 vendor/
 node_modules/
 
+# testing and code styling output
+/build/
+.php-cs-fixer.cache
+.phpunit.result.cache
+
 # misc
 .DS_Store
 .env
 .idea/
-.php-cs-fixer.cache
 *.swp
 

Jenkinsfile

@@ -30,6 +30,12 @@ pipeline {
             }
         }
 
+        stage('Run Test Suite') {
+            steps {
+                sh 'composer run phpunit'
+            }
+        }
+
         stage('Check Formating') {
             steps {
                 sh 'n -d exec engine pnpm prettier'

Swat/SwatByteCellRenderer.php

@@ -14,7 +14,7 @@ class SwatByteCellRenderer extends SwatCellRenderer
     /**
      * Value in bytes.
      *
-     * @var float
+     * @var int
      */
     public $value;
 

Swat/SwatCascadeFlydown.php

@@ -166,7 +166,7 @@ protected function &getOptions()
             // if the options array doesn't exist for this parent_value, then
             // assume that means we don't want any values in this flydown for
             // that option.
-            $options = [new SwatOption(null, null)];
+            $options = [new SwatOption(null, '')];
         }
 
         return $options;

Swat/SwatCellRendererSet.php

@@ -212,7 +212,7 @@ public function getRendererByPosition($position = 0)
         throw new SwatObjectNotFoundException(
             'Set does not contain that many renderers.',
             0,
-            $position,
+            (string) $position,
         );
     }
 

Swat/SwatCheckboxCellRenderer.php

@@ -153,7 +153,7 @@ public function render()
         echo '<span class="swat-checkbox-shim"></span>';
         echo '</span>';
 
-        if ($this->title !== null) {
+        if (isset($label_tag)) {
             $label_tag->displayContent();
             $label_tag->close();
         }

Swat/SwatCheckboxTree.php

@@ -170,7 +170,7 @@ protected function validate(SwatDataTreeNode $node, $is_parent_selected)
                 : $is_parent_selected && !$is_selected;
 
         return array_reduce(
-            $node->getChildren(),
+            iterator_to_array($node->getChildren()),
             function ($carry, $child) use ($is_selected) {
                 return $carry && $this->validate($child, $is_selected);
             },
@@ -269,7 +269,7 @@ private function displayNode(
 
         // display children
         $child_nodes = $node->getChildren();
-        if (count($child_nodes) > 0) {
+        if (iterator_count($child_nodes) > 0) {
             echo '<ul>';
             foreach ($child_nodes as $child_node) {
                 $nodes = $this->displayNode($child_node, $nodes, $index);

Swat/SwatContainer.php

@@ -481,7 +481,7 @@ public function hasMessage()
      * called elsewhere. To add a widget to a container use
      * {@link SwatContainer::add()}.
      *
-     * @param SwatWidget $child a reference to the child object to add
+     * @param SwatObject $child a reference to the child object to add
      *
      * @throws SwatInvalidClassException
      */

Swat/SwatDate.php

@@ -692,8 +692,6 @@ public static function getFormatLikeIntlById($id): string
      */
     public static function getTimeZoneAbbreviations(): array
     {
-        static $shortnames = null;
-
         if (self::$tz_abbreviations === null) {
             self::$tz_abbreviations = [];
 
@@ -737,10 +735,10 @@ public static function getTimeZoneAbbreviation(
         $key = $time_zone->getName();
 
         if (array_key_exists($key, $abbreviations)) {
-            $abbreviation = $abbreviations[$key];
+            return $abbreviations[$key];
         }
 
-        return $abbreviation;
+        return [];
     }
 
     /**
@@ -905,7 +903,7 @@ public function getMinute(): int
      *
      * This method is provided for backwards compatibility with PEAR::Date.
      *
-     * @return float the second of this date
+     * @return int the second of this date
      */
     public function getSecond()
     {
@@ -1143,7 +1141,7 @@ public function convertTZById($time_zone_name): DateTime
      */
     public function setTZ(DateTimeZone $time_zone): DateTime
     {
-        return $this->addSeconds($this->format('Z'))
+        return $this->addSeconds((float) $this->format('Z'))
             ->setTimezone($time_zone)
             ->subtractSeconds($this->format('Z'));
     }
@@ -1482,7 +1480,15 @@ public function setMinute($minute): DateTime
      */
     public function setSecond($second): DateTime
     {
-        return $this->setTime($this->getHour(), $this->getMinute(), $second);
+        $whole_second = (int) $second;
+        $microsecond = (int) (abs($second - $whole_second) * 1_000_000);
+
+        return $this->setTime(
+            $this->getHour(),
+            $this->getMinute(),
+            $whole_second,
+            $microsecond
+        );
     }
 
     /**

Swat/SwatDateEntry.php

@@ -393,7 +393,7 @@ public function getState()
     /**
      * Sets the current state of this date entry widget.
      *
-     * @param bool $state the new state of this date entry widget
+     * @param mixed $state the new state of this date entry widget
      *
      * @see SwatState::setState()
      */
@@ -530,11 +530,7 @@ protected function isStartDateValid()
     {
         $this->valid_range_start->setTZById('UTC');
 
-        return SwatDate::compare(
-            $this->value,
-            $this->valid_range_start,
-            true,
-        ) >= 0;
+        return SwatDate::compare($this->value, $this->valid_range_start) >= 0;
     }
 
     /**
@@ -548,7 +544,7 @@ protected function isEndDateValid()
     {
         $this->valid_range_end->setTZById('UTC');
 
-        return SwatDate::compare($this->value, $this->valid_range_end, true)
+        return SwatDate::compare($this->value, $this->valid_range_end)
             < 0;
     }
 
@@ -720,7 +716,7 @@ protected function getMonthOptionText($month)
         $text = '';
 
         if ($this->show_month_number) {
-            $text .= str_pad($month, 2, '0', STR_PAD_LEFT) . ' - ';
+            $text .= sprintf('%02d', $month) . ' - ';
         }
 
         $date = new SwatDate('2010-' . $month . '-01');
@@ -764,7 +760,7 @@ protected function createDayFlydown()
             for ($i = $start_day; $i <= $end_day; $i++) {
                 $flydown->addOption($i, $i);
             }
-        } elseif (SwatDate::compare($end_check, $range_end, true) != -1) {
+        } elseif (SwatDate::compare($end_check, $range_end) != -1) {
             // extra days at the beginning of the next month allowed
             $days_in_month = $this->valid_range_start->getDaysInMonth();
 

Swat/SwatEntry.php

@@ -350,7 +350,7 @@ protected function getCSSClassNames()
     protected function getNonce()
     {
         if ($this->nonce === null) {
-            $this->nonce = 'n' . md5(rand());
+            $this->nonce = 'n' . md5((string) rand());
         }
 
         return $this->nonce;

Swat/SwatError.php

@@ -323,8 +323,8 @@ public function toString()
             }
 
             printf(
-                "%s. In file '%s' on line %s.\n%sMethod: %s%s%s(%s)\n",
-                str_pad(--$count, 6, ' ', STR_PAD_LEFT),
+                "%6d. In file '%s' on line %s.\n%sMethod: %s%s%s(%s)\n",
+                --$count,
                 array_key_exists('file', $entry) ? $entry['file'] : 'unknown',
                 array_key_exists('line', $entry) ? $entry['line'] : 'unknown',
                 str_repeat(' ', 8),
@@ -379,9 +379,12 @@ public function toXHTML()
 
             if (array_key_exists('args', $entry)) {
                 $arguments = htmlspecialchars(
-                    $this->getArguments($entry['args'], $function, $class),
-                    null,
-                    'UTF-8',
+                    string: $this->getArguments(
+                        $entry['args'],
+                        $function,
+                        $class
+                    ),
+                    encoding: 'UTF-8',
                 );
             } else {
                 $arguments = '';

Swat/SwatGroupedFlydown.php

@@ -119,7 +119,7 @@ protected function displayNode(
 
         if (
             $level == 1
-            && count($children) > 0
+            && iterator_count($children) > 0
             && end($flydown_option->value) === null
             && !($flydown_option instanceof SwatFlydownDivider)
         ) {

Swat/SwatHtmlHeadEntrySetDisplayer.php

@@ -139,13 +139,13 @@ protected function getCombinedEntries(array $entries)
         // add combines to set of entries
         foreach ($info['combines'] as $combine) {
             if (mb_substr($combine, -4) === '.css') {
-                $class_name = 'SwatStyleSheetHtmlHeadEntry';
+                $class_name = SwatStyleSheetHtmlHeadEntry::class;
             } elseif (mb_substr($combine, -5) === '.less') {
-                $class_name = 'SwatLessStyleSheetHtmlHeadEntry';
+                $class_name = SwatLessStyleSheetHtmlHeadEntry::class;
             } else {
-                $class_name = 'SwatJavaScriptHtmlHeadEntry';
+                $class_name = SwatJavaScriptHtmlHeadEntry::class;
             }
-            $entries[$combine] = new $class_name($combine, '__combine__');
+            $entries[$combine] = new $class_name($combine);
         }
 
         // remove files included in combines

Swat/SwatInputCell.php

@@ -124,7 +124,7 @@ public function process($row_identifier)
      * This creates a cloned widget for the given numeric identifier and then
      * displays the widget.
      *
-     * @param mixed $row_identifier
+     * @param int $row_identifier
      */
     public function display($row_identifier)
     {
@@ -228,9 +228,8 @@ public function getWidget($row_identifier, $widget_id = null)
      *
      * This is useful if you are deleting a row from an input row.
      *
-     * @param int replicator_id the replicator id of the cloned widget to
-     *                 unset
-     * @param mixed $replicator_id
+     * @param int $replicator_id the replicator id of the cloned widget to
+     *                           unset
      *
      * @see SwatTableViewInputRow::removeReplicatedRow()
      */
@@ -469,11 +468,11 @@ protected function getInputRow()
     /**
      * Gets a cloned widget given a unique identifier.
      *
-     * @param string $replicator_id the unique identifier of the new cloned
-     *                              widget. The actual cloned widget id is
-     *                              constructed from this identifier and from
-     *                              the input row that this input cell belongs
-     *                              to.
+     * @param int $replicator_id the unique identifier of the new cloned
+     *                           widget. The actual cloned widget id is
+     *                           constructed from this identifier and from
+     *                           the input row that this input cell belongs
+     *                           to.
      *
      * @return SwatWidget the new cloned widget or the cloned widget retrieved
      *                    from the {@link SwatInputCell::$clones} array

Swat/SwatNumber.php

@@ -84,18 +84,19 @@ public static function ordinal($value)
 
         if (extension_loaded('intl')) {
             // get current locale
-            $locale = setlocale(LC_ALL, 0);
+            $locale = setlocale(LC_ALL, '0');
 
             static $formatters = [];
-            if (!isset($formatter[$locale])) {
-                $formatter[$locale] = new NumberFormatter(
+
+            if (!isset($formatters[$locale])) {
+                $formatters[$locale] = new NumberFormatter(
                     $locale,
                     NumberFormatter::ORDINAL,
                 );
             }
 
             // format ordinal
-            $ordinal_value = $formatter[$locale]->format($value);
+            $ordinal_value = $formatters[$locale]->format($value);
 
             // decompose to latin-1 characters (removes superscripts)
             $ordinal_value = Normalizer::normalize(

Swat/SwatNumericEntry.php

@@ -74,7 +74,7 @@ public function process()
                 $minimum_value = str_replace(
                     '%',
                     '%%',
-                    $this->getDisplayValue($this->minimum_value),
+                    $this->getDisplayValue((string) $this->minimum_value),
                 );
 
                 $message->primary_content = sprintf(
@@ -92,7 +92,7 @@ public function process()
                 $maximum_value = str_replace(
                     '%',
                     '%%',
-                    $this->getDisplayValue($this->maximum_value),
+                    $this->getDisplayValue((string) $this->maximum_value),
                 );
 
                 $message->primary_content = sprintf(

Swat/SwatPercentageEntry.php

@@ -22,7 +22,7 @@ protected function getDisplayValue($value)
     {
         if (is_numeric($value)) {
             $value = $value * 100;
-            $value = parent::getDisplayValue($value);
+            $value = parent::getDisplayValue((string) $value);
             $value = $value . '%';
         } else {
             $value = parent::getDisplayValue($value);

Swat/SwatRadioButtonCellRenderer.php

@@ -144,7 +144,7 @@ public function render()
         echo '<span class="swat-radio-shim"></span>';
         echo '</span>';
 
-        if ($this->title !== null) {
+        if (isset($label_tag)) {
             $label_tag->displayContent();
             $label_tag->close();
         }