Create script to check PHP for syntac compatibility

.github/actions/php-linter/Dockerfile

@@ -0,0 +1,5 @@
+FROM php:7.4
+
+COPY tester.sh /tester.sh
+
+CMD ["/tester.sh", "/work"]

.github/actions/php-linter/tester.sh

@@ -0,0 +1,25 @@
+#!/bin/bash
+
+cd "$1"
+
+ret=0
+
+while IFS= read -d '' file
+do
+	php -l "$file" > /tmp/msg
+	retSingle=$?
+
+	if [ $retSingle -eq 0 ]
+	then
+		cat /tmp/msg | sed 's@^@::debug::@'
+	else
+		ret=1
+		msg="$(cat /tmp/msg)"
+		echo "$msg" | sed 's@^\s*$@@' | grep -v '^$' > /tmp/msg
+		line=$(cat /tmp/msg | grep -o ' on line [0-9]*' | sed -E 's@ on line ([0-9]*)$@\1@')
+		prefix="::error file=$file,line=$line,title=PHP linter failed::"
+		sed "s@^@$prefix@" /tmp/msg 
+	fi
+done < <(find lib -type f -name '*.php' -print0)
+
+exit $ret

.github/workflows/pages.yml

@@ -67,7 +67,7 @@ jobs:
       name: github-pages
       url: ${{ steps.deployment.outputs.page_url }}
     runs-on: ubuntu-22.04
-    if: github.event.ref == 'refs/heads/master'
+    if: github.event.ref == 'refs/heads/master' && github.repository == 'nextcloud/cookbook'
     needs: build
     steps:
       - name: Deploy to GitHub Pages

.github/workflows/tests.yml

@@ -370,9 +370,6 @@ jobs:
 
   source-package:
     name: Create source code artifacts
-    needs:
-        - unit-tests
-        - code-lint
     runs-on: ubuntu-22.04
 
     steps:
@@ -443,4 +440,30 @@ jobs:
         path: ${{ github.event_path }}
         retention-days: 1
 
+  lint-php:
+    name: "Lint PHP files to be compatible"
+    runs-on: ubuntu-22.04
+    defaults:
+      run:
+        shell: bash
+    steps:
+    - name: Checkout of the app
+      uses: actions/checkout@v4
+    - name: build docker container image
+      run: docker build -t php-lint-tester .github/actions/php-linter
+    - name: Check the code base
+      run: docker run --rm -v $(pwd):/work:ro php-lint-tester
 
+  successful_run:
+    name: The tests have successfully run
+    runs-on: ubuntu-22.04
+    needs:
+      - unit-tests
+      - code-lint
+      - source-package
+      - lint-php
+      - event_file
+    steps:
+      - name: Run successfully
+        shell: bash
+        run: echo "The tests have been running successfully"

CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+### Maintenance
+- Add PHP lint checker to ensure valid (legacy) PHP syntax
+  [#1931](https://github.com/nextcloud/cookbook/pull/1931) @christianlupus
+
 
 ## 0.10.3 - 2023-12-04
 

lib/Helper/Filter/JSON/AbstractJSONFilter.php

@@ -26,7 +26,7 @@ abstract public function apply(array &$json): bool;
 	/**
 	 * @param string|int|float|array $value
 	 */
-	protected function setJSONValue(array &$json, string $key, string|int|float|array $value): bool {
+	protected function setJSONValue(array &$json, string $key, $value): bool {
 		if (!array_key_exists($key, $json)) {
 			$json[$key] = $value;
 			return true;

lib/Helper/Filter/Output/RecipeStubFilter.php

@@ -12,7 +12,7 @@ class RecipeStubFilter {
 
 	public function __construct(
 		RecipeIdTypeFilter $recipeIdTypeFilter,
-		RecipeIdCopyFilter $recipeIdCopyFilter,
+		RecipeIdCopyFilter $recipeIdCopyFilter
 	) {
 		$this->filters = [
 			$recipeIdCopyFilter,

lib/Helper/TimestampHelper.php

@@ -45,7 +45,7 @@ public function parseTimestamp(string $timestamp): string {
 		// For now, we only support the ISO8601 format because it is required in the schema.org standard
 		try {
 			return $this->parseIsoFormat($timestamp);
-		} catch (InvalidTimestampException) {
+		} catch (InvalidTimestampException $ex) {
 			// We do nothing here. Check the next format
 		}
 
@@ -65,15 +65,15 @@ public function parseTimestamp(string $timestamp): string {
 	private function parseIsoFormat(string $timestamp): string {
 		try {
 			return $this->parseIsoCalendarDateFormat($timestamp, '-');
-		} catch (InvalidTimestampException) { // Check next format
+		} catch (InvalidTimestampException $ex) { // Check next format
 		}
 		try {
 			return $this->parseIsoCalendarDateFormat($timestamp, '');
-		} catch (InvalidTimestampException) { // Check next format
+		} catch (InvalidTimestampException $ex) { // Check next format
 		}
 		try {
 			return $this->parseIsoWeekDateFormat($timestamp, '-');
-		} catch (InvalidTimestampException) { // Check next format
+		} catch (InvalidTimestampException $ex) { // Check next format
 		}
 
 		return $this->parseIsoWeekDateFormat($timestamp, '');