Upgraded to PHP 8, including parameter and return types

Author: robtimus

.github/workflows/build.yml

@@ -28,10 +28,10 @@ jobs:
       - uses: actions/checkout@v5
         with:
           persist-credentials: false
-      - name: Set up PHP 7.4
+      - name: Set up PHP 8.0
         uses: shivammathur/setup-php@v2
         with:
-          php-version: '7.4'
+          php-version: '8.0'
           coverage: xdebug
           tools: phpstan
       - name: Cache Composer packages
@@ -47,21 +47,17 @@ jobs:
       - name: PHPStan
         run: phpstan analyse
 
-  test:
+  phpcs:
     runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        # PHP Unit 4.x is needed for PHP 5.4 but is not supported on PHP 8.x
-        php: [5.4, 5.6, 7.0, 7.4]
-      fail-fast: false
     steps:
       - uses: actions/checkout@v5
         with:
           persist-credentials: false
-      - uses: shivammathur/setup-php@v2
+      - name: Set up PHP 8.0
+        uses: shivammathur/setup-php@v2
         with:
-          php-version: ${{matrix.php}}
-          coverage: xdebug
+          php-version: '8.0'
+          tools: phpcs
       - name: Cache Composer packages
         id: composer-cache
         uses: actions/cache@v4
@@ -72,12 +68,10 @@ jobs:
             ${{ runner.os }}-php-
       - name: Install dependencies
         run: composer install -q --no-ansi --no-interaction --no-scripts --no-progress --prefer-dist
-      - name: PHP Unit
-        run: |
-          echo '{}' | jq '.http.upload.skip |= true' > tests/config.json
-          vendor/bin/phpunit tests
+      - name: PHPCS
+        run: phpcs src
 
-  test-php8:
+  test:
     runs-on: ubuntu-latest
     strategy:
       matrix:
@@ -87,23 +81,6 @@ jobs:
       - uses: actions/checkout@v5
         with:
           persist-credentials: false
-          fetch-depth: 0
-      - name: Rebase PHP8 branch
-        env:
-          USER_EMAIL: ${{ github.event.pusher.email }}
-          USER_NAME: ${{ github.event.pusher.name }}
-          REBASE_TARGET: ${{ github.head_ref || github.ref_name }}
-        run: |
-          git config user.email "$USER_EMAIL"
-          git config user.name "$USER_NAME"
-          git pull
-          git checkout php8
-          git rebase "$REBASE_TARGET" php8
-          git status
-          echo 'diff origin/php8:'
-          git diff origin/php8
-          echo 'diff current:'
-          git diff "$REBASE_TARGET"
       - uses: shivammathur/setup-php@v2
         with:
           php-version: ${{matrix.php}}
@@ -115,37 +92,10 @@ jobs:
           path: vendor
           key: ${{ runner.os }}-php-${{ hashFiles('**/composer.lock') }}
           restore-keys: |
-            ${{ runner.os }}-php8-
+            ${{ runner.os }}-php-
       - name: Install dependencies
         run: composer install -q --no-ansi --no-interaction --no-scripts --no-progress --prefer-dist
       - name: PHP Unit
         run: |
           echo '{}' | jq '.http.upload.skip |= true' > tests/config.json
           vendor/bin/phpunit tests
-
-  rebase-php8:
-    runs-on: ubuntu-latest
-    needs: test-php8
-    if: github.ref_name == 'master'
-    permissions:
-      contents: write
-    steps:
-      - uses: actions/checkout@v5
-        with:
-          ref: php8
-          fetch-depth: 0
-      - name: Rebase PHP8 branch
-        env:
-          USER_EMAIL: ${{ github.event.pusher.email }}
-          USER_NAME: ${{ github.event.pusher.name }}
-        run: |
-          git config user.email "$USER_EMAIL"
-          git config user.name "$USER_NAME"
-          git pull
-          git rebase origin/master php8
-          git status
-          echo 'diff origin/php8:'
-          git diff origin/php8
-          echo 'diff master:'
-          git diff origin/master
-          git push --force-with-lease

.github/workflows/http-upload-test.yml

@@ -30,7 +30,7 @@ jobs:
           persist-credentials: false
       - uses: shivammathur/setup-php@v2
         with:
-          php-version: '7.4'
+          php-version: '8.0'
           coverage: xdebug
       - name: Cache Composer packages
         id: composer-cache

.github/workflows/release-site.yml

@@ -28,15 +28,8 @@ jobs:
       - uses: actions/checkout@v5
         with:
           persist-credentials: false
-      - name: Set up PHP
-        uses: shivammathur/setup-php@v2
-        with:
-          # highest version to support apigen/apigen
-          php-version: '7.1'
-      - name: Install apigen
-        run: composer global require apigen/apigen
       - name: Generate API
-        run: apigen generate -s src -d docs
+        run: mkdir -p docs && docker run --rm -v "$GITHUB_WORKSPACE/code:/workspace" -w /workspace -u `id -u`:`id -g` apigen/apigen
       - uses: actions/upload-artifact@v4
         with:
           name: docs

.github/workflows/sonarcloud.yml

@@ -31,10 +31,10 @@ jobs:
       - uses: actions/checkout@v5
         with:
           fetch-depth: 0
-      - name: Set up PHP 7.4
+      - name: Set up PHP 8.0
         uses: shivammathur/setup-php@v2
         with:
-          php-version: '7.4'
+          php-version: '8.0'
           coverage: xdebug
       - name: Cache Composer packages
         id: composer-cache

.gitignore

@@ -1,6 +1,7 @@
-/composer.lock
 /vendor/
-/.buildpath
-/.project
-/.settings
+/docs/
+
+/.phpunit.cache
+.phpunit.result.cache
+
 tests/config.json

README.md

@@ -114,14 +114,14 @@ To send a multipart object with a cURL request, you need to follow some steps:
 
 * Set the request type using `CURLOPT_CUSTOMREQUEST`.
 * Set the `CURLOPT_UPLOAD` option to `true`.
-* Set the object's `curl_read` method as the `CURLOPT_READFUNCTION`.
+* Set the object's `curlRead` method as the `CURLOPT_READFUNCTION`.
 * Make sure the `Content-Type` and `Content-Length` headers are set. Note that the `Content-Length` header is optional.
 
 For instance:
 
     curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
     curl_setopt($ch, CURLOPT_UPLOAD, true);
-    curl_setopt($ch, CURLOPT_READFUNCTION, array($multipart, 'curl_read'));
+    curl_setopt($ch, CURLOPT_READFUNCTION, array($multipart, 'curlRead'));
 
     $headers = ['Content-Type: ' . $multipart->getContentType()];
     $contentLength = $multipart->getContentLength();
@@ -132,6 +132,6 @@ For instance:
 
 ## Non-streaming support
 
-If streaming is not possible (e.g. because a string is required, like in the `mail` function), you can buffer a multipart object in-memory by calling the `buffer` method. This method takes an optional buffer size, and returns the buffered contents. The content length will be set accordingly. Note that you should do this before calling `read` (or `curl_read`), otherwise the buffered contents may not contain all desired contents (especially if you're using resources or callables).
+If streaming is not possible (e.g. because a string is required, like in the `mail` function), you can buffer a multipart object in-memory by calling the `buffer` method. This method takes an optional buffer size, and returns the buffered contents. The content length will be set accordingly. Note that you should do this before calling `read` (or `curlRead`), otherwise the buffered contents may not contain all desired contents (especially if you're using resources or callables).
 
 `Multipart.__toString()` has been overridden to buffer the multipart object as well, so you can achieve the same by casting a multipart object to `string`. The difference is that `buffer` requires the multipart object to be finished.

composer.json

@@ -15,10 +15,10 @@
         "issues": "https://github.com/robtimus/php-multipart/issues"
     },
     "require": {
-        "php": ">=5.4"
+        "php": ">=8.0"
     },
     "require-dev": {
-        "phpunit/phpunit": "~4"
+        "phpunit/phpunit": "~9"
     },
     "autoload": {
         "psr-4": {