Merge pull request #249 from MarcinOrlowski/dev

Release 11.0.0
MarcinOrlowski · May 6, 2024 · d2fa82d · d2fa82d
2 parents 9b6d00a + ff6a490
commit d2fa82d
Show file tree

Hide file tree

Showing 86 changed files with 102 additions and 102 deletions.
diff --git a/.codecov.yml b/.codecov.yml
@@ -3,7 +3,7 @@
 # Laravel API Response Builder CodeCov.io config file
 #
 # @author    Marcin Orlowski <mail (#) marcinOrlowski (.) com>
-# @copyright 2016-2023 Marcin Orlowski
+# @copyright 2016-2024 Marcin Orlowski
 # @license   http://www.opensource.org/licenses/mit-license.php MIT
 # @link      https://github.com/MarcinOrlowski/laravel-api-response-builder
 #

diff --git a/.github/workflows/coding-standards.yml b/.github/workflows/coding-standards.yml
@@ -3,7 +3,7 @@
 # Laravel API Response Builder Static code analysis Github Action config
 #
 # @author    Marcin Orlowski <mail (#) marcinOrlowski (.) com>
-# @copyright 2016-2023 Marcin Orlowski
+# @copyright 2016-2024 Marcin Orlowski
 # @license   http://www.opensource.org/licenses/mit-license.php MIT
 # @link      https://github.com/MarcinOrlowski/laravel-api-response-builder
 #

diff --git a/.github/workflows/coverage.yml b/.github/workflows/coverage.yml
@@ -3,7 +3,7 @@
 # Laravel API Response Builder Unit tests Github Action config
 #
 # @author    Marcin Orlowski <mail (#) marcinOrlowski (.) com>
-# @copyright 2016-2023 Marcin Orlowski
+# @copyright 2016-2024 Marcin Orlowski
 # @license   http://www.opensource.org/licenses/mit-license.php MIT
 # @link      https://github.com/MarcinOrlowski/laravel-api-response-builder
 #

diff --git a/.github/workflows/phpstan.yml b/.github/workflows/phpstan.yml
@@ -3,7 +3,7 @@
 # Laravel API Response Builder Static code analysis Github Action config
 #
 # @author    Marcin Orlowski <mail (#) marcinOrlowski (.) com>
-# @copyright 2016-2023 Marcin Orlowski
+# @copyright 2016-2024 Marcin Orlowski
 # @license   http://www.opensource.org/licenses/mit-license.php MIT
 # @link      https://github.com/MarcinOrlowski/laravel-api-response-builder
 #

diff --git a/.github/workflows/phpunit.yml b/.github/workflows/phpunit.yml
@@ -3,7 +3,7 @@
 # Laravel API Response Builder Unit tests Github Action config
 #
 # @author    Marcin Orlowski <mail (#) marcinOrlowski (.) com>
-# @copyright 2016-2023 Marcin Orlowski
+# @copyright 2016-2024 Marcin Orlowski
 # @license   http://www.opensource.org/licenses/mit-license.php MIT
 # @link      https://github.com/MarcinOrlowski/laravel-api-response-builder
 #
@@ -34,17 +34,16 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
+      # https://github.com/marketplace/actions/setup-php-action
+      - name: "Setup PHP ${{ matrix.php }}"
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: "${{ matrix.php }}"
+
+      # https://github.com/marketplace/actions/checkout
       - name: "Checkout repository..."
         uses: actions/checkout@v4
 
-      # https://github.com/marketplace/actions/composer-php-actions
-      - name: "Installing dependencies..."
-        uses: php-actions/composer@v6
-        with:
-          version: 2
-          php_version: "${{ matrix.php }}"
-          dev: yes
-
       - name: "Running PHPUnit..."
         shell: bash
         run: |

diff --git a/README.md b/README.md
@@ -66,5 +66,5 @@ Development branch:
 
 ## License ##
 
-* Written and copyrighted &copy;2016-2023 by Marcin Orlowski <mail (#) marcinorlowski (.) com>
+* Written and copyrighted &copy;2016-2024 by Marcin Orlowski <mail (#) marcinorlowski (.) com>
 * ResponseBuilder is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT)
diff --git a/config/response_builder.php b/config/response_builder.php
@@ -7,7 +7,7 @@
  * See docs/config.md for detailed documentation
  *
  * @author    Marcin Orlowski <mail (#) marcinOrlowski (.) com>
- * @copyright 2016-2023 Marcin Orlowski
+ * @copyright 2016-2024 Marcin Orlowski
  * @license   http://www.opensource.org/licenses/mit-license.php MIT
  * @link      https://github.com/MarcinOrlowski/laravel-api-response-builder
  *

diff --git a/docs/CHANGES.md b/docs/CHANGES.md
@@ -18,7 +18,8 @@ should be able to easily backport future new features to older versions rather e
 
 ## CHANGE LOG ##
 
-* dev
+* v11.0.0 (2023-02-20)
+  * **BACKWARD INCOMPATIBLE CHANGES** ([more info](compatibility.md)).
   * Added support for Laravel v11.
   * Corrected documentation (thanks to Ehsan Soleimanian)
 

diff --git a/docs/compatibility.md b/docs/compatibility.md
@@ -5,6 +5,7 @@
 [« Documentation table of contents](README.md)
 
 * [Important incompatibile changes](#incompatibility-notes)
+  * [Changes in v11.*](#v11)
   * [Changes in v10.*](#v10)
   * [Changes in v9.4](#v94)
   * [Changes in v9.*](#v9) (up to v9.3)
@@ -23,6 +24,10 @@
 
 Backward (in)compatibility notes. Pay attention if you are upgrading.
 
+## v11 ##
+
+* Requires Laravel 11.0+ and PHP 8.2+
+
 ## v10 ##
 
 * Requires Laravel 10.0+ and PHP 8.1+

diff --git a/phpcs.xml b/phpcs.xml
@@ -3,7 +3,7 @@
  * Laravel API Response Builder - PHP Code Sniffer config file
  *
  * @author    Marcin Orlowski <mail (#) marcinOrlowski (.) com>
- * @copyright 2016-2023 Marcin Orlowski
+ * @copyright 2016-2024 Marcin Orlowski
  * @license   http://www.opensource.org/licenses/mit-license.php MIT
  * @link      https://github.com/MarcinOrlowski/laravel-api-response-builder
  *

diff --git a/phpstan.neon b/phpstan.neon
@@ -3,7 +3,7 @@
 # Laravel API Response Builder PHPStan config file
 #
 # @author    Marcin Orlowski <mail (#) marcinOrlowski (.) com>
-# @copyright 2016-2023 Marcin Orlowski
+# @copyright 2016-2024 Marcin Orlowski
 # @license   http://www.opensource.org/licenses/mit-license.php MIT
 # @link      https://github.com/MarcinOrlowski/laravel-api-response-builder
 #

diff --git a/src/ApiCodesHelpers.php b/src/ApiCodesHelpers.php
@@ -7,7 +7,7 @@
  * Laravel API Response Builder
  *
  * @author    Marcin Orlowski <mail (#) marcinOrlowski (.) com>
- * @copyright 2016-2023 Marcin Orlowski
+ * @copyright 2016-2024 Marcin Orlowski
  * @license   http://www.opensource.org/licenses/mit-license.php MIT
  * @link      https://github.com/MarcinOrlowski/laravel-api-response-builder
  */

diff --git a/src/ApiResponse.php b/src/ApiResponse.php
@@ -7,7 +7,7 @@
  * Laravel API Response Builder
  *
  * @author    Marcin Orlowski <mail (#) marcinOrlowski (.) com>
- * @copyright 2016-2023 Marcin Orlowski
+ * @copyright 2016-2024 Marcin Orlowski
  * @license   http://www.opensource.org/licenses/mit-license.php MIT
  * @link      https://github.com/MarcinOrlowski/laravel-api-response-builder
  */

diff --git a/src/BaseApiCodes.php b/src/BaseApiCodes.php
@@ -7,7 +7,7 @@
  * Laravel API Response Builder
  *
  * @author    Marcin Orlowski <mail (#) marcinOrlowski (.) com>
- * @copyright 2016-2023 Marcin Orlowski
+ * @copyright 2016-2024 Marcin Orlowski
  * @license   http://www.opensource.org/licenses/mit-license.php MIT
  * @link      https://github.com/MarcinOrlowski/laravel-api-response-builder
  */

diff --git a/src/Contracts/ConverterContract.php b/src/Contracts/ConverterContract.php
@@ -7,7 +7,7 @@
  * Laravel API Response Builder
  *
  * @author    Marcin Orlowski <mail (#) marcinOrlowski (.) com>
- * @copyright 2016-2023 Marcin Orlowski
+ * @copyright 2016-2024 Marcin Orlowski
  * @license   http://www.opensource.org/licenses/mit-license.php MIT
  * @link      https://github.com/MarcinOrlowski/laravel-api-response-builder
  */

diff --git a/src/Contracts/ExceptionHandlerContract.php b/src/Contracts/ExceptionHandlerContract.php
@@ -7,7 +7,7 @@
  * Laravel API Response Builder
  *
  * @author    Marcin Orlowski <mail (#) marcinOrlowski (.) com>
- * @copyright 2016-2023 Marcin Orlowski
+ * @copyright 2016-2024 Marcin Orlowski
  * @license   http://www.opensource.org/licenses/mit-license.php MIT
  * @link      https://github.com/MarcinOrlowski/laravel-api-response-builder
  */

diff --git a/src/Contracts/InvalidTypeExceptionContract.php b/src/Contracts/InvalidTypeExceptionContract.php
@@ -7,7 +7,7 @@
  * Laravel API Response Builder
  *
  * @author    Marcin Orlowski <mail (#) marcinOrlowski (.) com>
- * @copyright 2016-2023 Marcin Orlowski
+ * @copyright 2016-2024 Marcin Orlowski
  * @license   http://www.opensource.org/licenses/mit-license.php MIT
  * @link      https://github.com/MarcinOrlowski/laravel-api-response-builder
  */

diff --git a/src/Converter.php b/src/Converter.php
@@ -7,7 +7,7 @@
  * Laravel API Response Builder
  *
  * @author    Marcin Orlowski <mail (#) marcinOrlowski (.) com>
- * @copyright 2016-2023 Marcin Orlowski
+ * @copyright 2016-2024 Marcin Orlowski
  * @license   http://www.opensource.org/licenses/mit-license.php MIT
  * @link      https://github.com/MarcinOrlowski/laravel-api-response-builder
  */

diff --git a/src/Converters/ArrayableConverter.php b/src/Converters/ArrayableConverter.php
@@ -7,7 +7,7 @@
  * Laravel API Response Builder
  *
  * @author    Marcin Orlowski <mail (#) marcinOrlowski (.) com>
- * @copyright 2016-2023 Marcin Orlowski
+ * @copyright 2016-2024 Marcin Orlowski
  * @license   http://www.opensource.org/licenses/mit-license.php MIT
  * @link      https://github.com/MarcinOrlowski/laravel-api-response-builder
  */

diff --git a/src/Converters/JsonSerializableConverter.php b/src/Converters/JsonSerializableConverter.php
@@ -7,7 +7,7 @@
  * Laravel API Response Builder
  *
  * @author    Marcin Orlowski <mail (#) marcinOrlowski (.) com>
- * @copyright 2016-2023 Marcin Orlowski
+ * @copyright 2016-2024 Marcin Orlowski
  * @license   http://www.opensource.org/licenses/mit-license.php MIT
  * @link      https://github.com/MarcinOrlowski/laravel-api-response-builder
  */

diff --git a/src/Converters/ToArrayConverter.php b/src/Converters/ToArrayConverter.php
@@ -7,7 +7,7 @@
  * Laravel API Response Builder
  *
  * @author    Marcin Orlowski <mail (#) marcinOrlowski (.) com>
- * @copyright 2016-2023 Marcin Orlowski
+ * @copyright 2016-2024 Marcin Orlowski
  * @license   http://www.opensource.org/licenses/mit-license.php MIT
  * @link      https://github.com/MarcinOrlowski/laravel-api-response-builder
  */

diff --git a/src/ExceptionHandlerHelper.php b/src/ExceptionHandlerHelper.php
@@ -7,7 +7,7 @@
  * Laravel API Response Builder
  *
  * @author    Marcin Orlowski <mail (#) marcinOrlowski (.) com>
- * @copyright 2016-2023 Marcin Orlowski
+ * @copyright 2016-2024 Marcin Orlowski
  * @license   http://www.opensource.org/licenses/mit-license.php MIT
  * @link      https://github.com/MarcinOrlowski/laravel-api-response-builder
  */

diff --git a/src/ExceptionHandlers/DefaultExceptionHandler.php b/src/ExceptionHandlers/DefaultExceptionHandler.php
@@ -7,7 +7,7 @@
  * Laravel API Response Builder
  *
  * @author    Marcin Orlowski <mail (#) marcinOrlowski (.) com>
- * @copyright 2016-2023 Marcin Orlowski
+ * @copyright 2016-2024 Marcin Orlowski
  * @license   http://www.opensource.org/licenses/mit-license.php MIT
  * @link      https://github.com/MarcinOrlowski/laravel-api-response-builder
  */

diff --git a/src/ExceptionHandlers/HttpExceptionHandler.php b/src/ExceptionHandlers/HttpExceptionHandler.php
@@ -7,7 +7,7 @@
  * Laravel API Response Builder
  *
  * @author    Marcin Orlowski <mail (#) marcinOrlowski (.) com>
- * @copyright 2016-2023 Marcin Orlowski
+ * @copyright 2016-2024 Marcin Orlowski
  * @license   http://www.opensource.org/licenses/mit-license.php MIT
  * @link      https://github.com/MarcinOrlowski/laravel-api-response-builder
  */

diff --git a/src/ExceptionHandlers/ValidationExceptionHandler.php b/src/ExceptionHandlers/ValidationExceptionHandler.php
@@ -7,7 +7,7 @@
  * Laravel API Response Builder
  *
  * @author    Marcin Orlowski <mail (#) marcinOrlowski (.) com>
- * @copyright 2016-2023 Marcin Orlowski
+ * @copyright 2016-2024 Marcin Orlowski
  * @license   http://www.opensource.org/licenses/mit-license.php MIT
  * @link      https://github.com/MarcinOrlowski/laravel-api-response-builder
  */

diff --git a/src/Exceptions/ArrayWithMixedKeysException.php b/src/Exceptions/ArrayWithMixedKeysException.php
@@ -7,14 +7,14 @@
  * Laravel API Response Builder
  *
  * @author    Marcin Orlowski <mail (#) marcinOrlowski (.) com>
- * @copyright 2016-2023 Marcin Orlowski
+ * @copyright 2016-2024 Marcin Orlowski
  * @license   http://www.opensource.org/licenses/mit-license.php MIT
  * @link      https://github.com/MarcinOrlowski/laravel-api-response-builder
  */
 final class ArrayWithMixedKeysException extends \Exception
 {
-	/** @var string */
-	protected $message =
-		'Invalid data array. Either set own keys for all the items or do not specify any keys at all. ' .
-		'Arrays with mixed keys are not supported by design.';
+    /** @var string */
+    protected $message =
+        'Invalid data array. Either set own keys for all the items or do not specify any keys at all. ' .
+        'Arrays with mixed keys are not supported by design.';
 }
diff --git a/src/Exceptions/ClassNotFound.php b/src/Exceptions/ClassNotFound.php
@@ -7,7 +7,7 @@
  * Laravel API Response Builder
  *
  * @author    Marcin Orlowski <mail (#) marcinOrlowski (.) com>
- * @copyright 2016-2023 Marcin Orlowski
+ * @copyright 2016-2024 Marcin Orlowski
  * @license   http://www.opensource.org/licenses/mit-license.php MIT
  * @link      https://github.com/MarcinOrlowski/laravel-api-response-builder
  */

diff --git a/src/Exceptions/ConfigurationException.php b/src/Exceptions/ConfigurationException.php
@@ -7,7 +7,7 @@
  * Laravel API Response Builder
  *
  * @author    Marcin Orlowski <mail (#) marcinOrlowski (.) com>
- * @copyright 2016-2023 Marcin Orlowski
+ * @copyright 2016-2024 Marcin Orlowski
  * @license   http://www.opensource.org/licenses/mit-license.php MIT
  * @link      https://github.com/MarcinOrlowski/laravel-api-response-builder
  */

diff --git a/src/Exceptions/ConfigurationNotFoundException.php b/src/Exceptions/ConfigurationNotFoundException.php
@@ -7,7 +7,7 @@
  * Laravel API Response Builder
  *
  * @author    Marcin Orlowski <mail (#) marcinOrlowski (.) com>
- * @copyright 2016-2023 Marcin Orlowski
+ * @copyright 2016-2024 Marcin Orlowski
  * @license   http://www.opensource.org/licenses/mit-license.php MIT
  * @link      https://github.com/MarcinOrlowski/laravel-api-response-builder
  */

diff --git a/src/Exceptions/IncompatibleTypeException.php b/src/Exceptions/IncompatibleTypeException.php
@@ -7,7 +7,7 @@
  * Laravel API Response Builder
  *
  * @author    Marcin Orlowski <mail (#) marcinOrlowski (.) com>
- * @copyright 2016-2023 Marcin Orlowski
+ * @copyright 2016-2024 Marcin Orlowski
  * @license   http://www.opensource.org/licenses/mit-license.php MIT
  * @link      https://github.com/MarcinOrlowski/laravel-api-response-builder
  */

diff --git a/src/Exceptions/IncompleteConfigurationException.php b/src/Exceptions/IncompleteConfigurationException.php
@@ -7,7 +7,7 @@
  * Laravel API Response Builder
  *
  * @author    Marcin Orlowski <mail (#) marcinOrlowski (.) com>
- * @copyright 2016-2023 Marcin Orlowski
+ * @copyright 2016-2024 Marcin Orlowski
  * @license   http://www.opensource.org/licenses/mit-license.php MIT
  * @link      https://github.com/MarcinOrlowski/laravel-api-response-builder
  */

diff --git a/src/Exceptions/InvalidConfigurationElementException.php b/src/Exceptions/InvalidConfigurationElementException.php
@@ -7,7 +7,7 @@
  * Laravel API Response Builder
  *
  * @author    Marcin Orlowski <mail (#) marcinOrlowski (.) com>
- * @copyright 2016-2023 Marcin Orlowski
+ * @copyright 2016-2024 Marcin Orlowski
  * @license   http://www.opensource.org/licenses/mit-license.php MIT
  * @link      https://github.com/MarcinOrlowski/laravel-api-response-builder
  */

diff --git a/src/Exceptions/InvalidConfigurationException.php b/src/Exceptions/InvalidConfigurationException.php
@@ -7,7 +7,7 @@
  * Laravel API Response Builder
  *
  * @author    Marcin Orlowski <mail (#) marcinOrlowski (.) com>
- * @copyright 2016-2023 Marcin Orlowski
+ * @copyright 2016-2024 Marcin Orlowski
  * @license   http://www.opensource.org/licenses/mit-license.php MIT
  * @link      https://github.com/MarcinOrlowski/laravel-api-response-builder
  */

diff --git a/src/Exceptions/InvalidTypeException.php b/src/Exceptions/InvalidTypeException.php
@@ -9,7 +9,7 @@
  * Laravel API Response Builder
  *
  * @author    Marcin Orlowski <mail (#) marcinOrlowski (.) com>
- * @copyright 2016-2023 Marcin Orlowski
+ * @copyright 2016-2024 Marcin Orlowski
  * @license   http://www.opensource.org/licenses/mit-license.php MIT
  * @link      https://github.com/MarcinOrlowski/laravel-api-response-builder
  */

diff --git a/src/Exceptions/MissingConfigurationKeyException.php b/src/Exceptions/MissingConfigurationKeyException.php
@@ -7,7 +7,7 @@
  * Laravel API Response Builder
  *
  * @author    Marcin Orlowski <mail (#) marcinOrlowski (.) com>
- * @copyright 2016-2023 Marcin Orlowski
+ * @copyright 2016-2024 Marcin Orlowski
  * @license   http://www.opensource.org/licenses/mit-license.php MIT
  * @link      https://github.com/MarcinOrlowski/laravel-api-response-builder
  */

diff --git a/src/Exceptions/NotArrayException.php b/src/Exceptions/NotArrayException.php
@@ -7,7 +7,7 @@
  * Laravel API Response Builder
  *
  * @author    Marcin Orlowski <mail (#) marcinOrlowski (.) com>
- * @copyright 2016-2023 Marcin Orlowski
+ * @copyright 2016-2024 Marcin Orlowski
  * @license   http://www.opensource.org/licenses/mit-license.php MIT
  * @link      https://github.com/MarcinOrlowski/laravel-api-response-builder
  */

diff --git a/src/Exceptions/NotBooleanException.php b/src/Exceptions/NotBooleanException.php
@@ -7,7 +7,7 @@
  * Laravel API Response Builder
  *
  * @author    Marcin Orlowski <mail (#) marcinOrlowski (.) com>
- * @copyright 2016-2023 Marcin Orlowski
+ * @copyright 2016-2024 Marcin Orlowski
  * @license   http://www.opensource.org/licenses/mit-license.php MIT
  * @link      https://github.com/MarcinOrlowski/laravel-api-response-builder
  */

diff --git a/src/Exceptions/NotIntegerException.php b/src/Exceptions/NotIntegerException.php
@@ -7,7 +7,7 @@
  * Laravel API Response Builder
  *
  * @author    Marcin Orlowski <mail (#) marcinOrlowski (.) com>
- * @copyright 2016-2023 Marcin Orlowski
+ * @copyright 2016-2024 Marcin Orlowski
  * @license   http://www.opensource.org/licenses/mit-license.php MIT
  * @link      https://github.com/MarcinOrlowski/laravel-api-response-builder
  */

diff --git a/src/Exceptions/NotObjectException.php b/src/Exceptions/NotObjectException.php
@@ -7,7 +7,7 @@
  * Laravel API Response Builder
  *
  * @author    Marcin Orlowski <mail (#) marcinOrlowski (.) com>
- * @copyright 2016-2023 Marcin Orlowski
+ * @copyright 2016-2024 Marcin Orlowski
  * @license   http://www.opensource.org/licenses/mit-license.php MIT
  * @link      https://github.com/MarcinOrlowski/laravel-api-response-builder
  */