From 209dd469c43e0a16c79cf2d9181fda0f9a39a598 Mon Sep 17 00:00:00 2001 From: Sebastian Meyer Date: Thu, 11 Jul 2024 13:14:31 +0200 Subject: [PATCH] Release v2.1.1 --- .phpdoc/guide/changelog.rst | 16 ++++++- .phpdoc/guide/usage/installation.rst | 4 +- ...ics-ErrorHandlers-ThrowErrorException.html | 8 ++-- ...s-ErrorHandlers-TriggerExceptionError.html | 8 ++-- .../ErrorHandlers/ThrowErrorException.php.txt | 2 + .../TriggerExceptionError.php.txt | 2 + doc/guides/changelog.html | 44 ++++++++++++++++++- doc/guides/index.html | 6 +++ doc/guides/usage/installation.html | 4 +- 9 files changed, 80 insertions(+), 14 deletions(-) diff --git a/.phpdoc/guide/changelog.rst b/.phpdoc/guide/changelog.rst index 3dd0437..f1e4cc9 100644 --- a/.phpdoc/guide/changelog.rst +++ b/.phpdoc/guide/changelog.rst @@ -6,6 +6,17 @@ Changelog .. sidebar:: Table of Contents .. contents:: +v2.1.1 +====== + +**New Features:** + +* Added Composer commands for development tools (PHP_CodeSniffer, PHP-CS-Fixer, PHPStan, Psalm and phpDocumentor) + +**Minor Changes:** + +* Extended `documentation `_ + v2.1.0 ====== @@ -56,6 +67,9 @@ v2.0.0 * Added new trait :php:trait:`OCC\Basics\Traits\TypeChecker` * Extended API for all datastructures (see :php:trait:`OCC\Basics\DataStructures\Traits\StrictSplDoublyLinkedListTrait`) * Introduced :php:class:`OCC\Basics\DataStructures\Exceptions\InvalidDataTypeException` for strict datastructures + +**Minor Changes:** + * Extended `documentation `_ v1.1.0 @@ -77,7 +91,7 @@ v1.1.0 v1.0.1 ====== -**New Features:** +**Minor Changes:** * Improved exception handling in :php:trait:`Singleton ` trait diff --git a/.phpdoc/guide/usage/installation.rst b/.phpdoc/guide/usage/installation.rst index 47dba9b..89553c4 100644 --- a/.phpdoc/guide/usage/installation.rst +++ b/.phpdoc/guide/usage/installation.rst @@ -46,8 +46,8 @@ well: .. code-block:: shell - # This will clone the repository state at version "2.1.0" into the "basics" directory - git clone --branch=v2.1.0 https://github.com/opencultureconsulting/php-basics.git basics + # This will clone the repository state at version "2.1.1" into the "basics" directory + git clone --branch=v2.1.1 https://github.com/opencultureconsulting/php-basics.git basics Be aware that you also need to make the classes and traits available in your application by either adding them to your autoloader or by including all files individually in PHP. diff --git a/doc/classes/OCC-Basics-ErrorHandlers-ThrowErrorException.html b/doc/classes/OCC-Basics-ErrorHandlers-ThrowErrorException.html index 241f123..2ff480e 100644 --- a/doc/classes/OCC-Basics-ErrorHandlers-ThrowErrorException.html +++ b/doc/classes/OCC-Basics-ErrorHandlers-ThrowErrorException.html @@ -198,9 +198,9 @@

Throws internal errors as exceptions.

@@ -291,9 +291,9 @@

Convert an internal PHP error into an ErrorException.

diff --git a/doc/classes/OCC-Basics-ErrorHandlers-TriggerExceptionError.html b/doc/classes/OCC-Basics-ErrorHandlers-TriggerExceptionError.html index c5ddbb2..b8ad1b3 100644 --- a/doc/classes/OCC-Basics-ErrorHandlers-TriggerExceptionError.html +++ b/doc/classes/OCC-Basics-ErrorHandlers-TriggerExceptionError.html @@ -198,9 +198,9 @@

Triggers errors for uncaught exceptions.

@@ -291,9 +291,9 @@

Convert an uncaught exception into an PHP error.

diff --git a/doc/files/src/ErrorHandlers/ThrowErrorException.php.txt b/doc/files/src/ErrorHandlers/ThrowErrorException.php.txt index 271b77b..695ce23 100644 --- a/doc/files/src/ErrorHandlers/ThrowErrorException.php.txt +++ b/doc/files/src/ErrorHandlers/ThrowErrorException.php.txt @@ -35,6 +35,8 @@ use function error_reporting; * * > Usage: `set_error_handler(new ThrowErrorException());` * + * @api + * * @author Sebastian Meyer * @package Basics\ErrorHandlers */ diff --git a/doc/files/src/ErrorHandlers/TriggerExceptionError.php.txt b/doc/files/src/ErrorHandlers/TriggerExceptionError.php.txt index 16e9527..dcc08fc 100644 --- a/doc/files/src/ErrorHandlers/TriggerExceptionError.php.txt +++ b/doc/files/src/ErrorHandlers/TriggerExceptionError.php.txt @@ -36,6 +36,8 @@ use function trigger_error; * * > Usage: `set_exception_handler(new TriggerExceptionError());` * + * @api + * * @author Sebastian Meyer * @package Basics\ErrorHandlers */ diff --git a/doc/guides/changelog.html b/doc/guides/changelog.html index 50284ca..fff628e 100644 --- a/doc/guides/changelog.html +++ b/doc/guides/changelog.html @@ -176,6 +176,12 @@

Changelog

+
+

v2.1.1

+ + +

New Features: +

+ + + +
    +
  • Added Composer commands for development tools (PHP_CodeSniffer, PHP-CS-Fixer, PHPStan, Psalm and phpDocumentor)
  • + +
+ + +

Minor Changes: +

+ + + + + +
+

v2.1.0

@@ -311,6 +344,15 @@

v2.0.0

  • Introduced InvalidDataTypeException for strict datastructures
  • + + + +

    Minor Changes: +

    + + + + @@ -345,7 +387,7 @@

    v1.1.0

    v1.0.1

    -

    New Features: +

    Minor Changes:

    diff --git a/doc/guides/index.html b/doc/guides/index.html index 6487c41..ff67c83 100644 --- a/doc/guides/index.html +++ b/doc/guides/index.html @@ -227,6 +227,12 @@

    Documentation

    Changelog
      +
    • + v2.1.1 + + +
    • +
    • v2.1.0 diff --git a/doc/guides/usage/installation.html b/doc/guides/usage/installation.html index a57edcd..aaf0641 100644 --- a/doc/guides/usage/installation.html +++ b/doc/guides/usage/installation.html @@ -238,8 +238,8 @@

      Git

      If you want to use a specific version other than the latest development state, you have to specify the desired tag as well:

      -
      # This will clone the repository state at version "2.1.0" into the "basics" directory
      -git clone --branch=v2.1.0 https://github.com/opencultureconsulting/php-basics.git basics
      +
      # This will clone the repository state at version "2.1.1" into the "basics" directory
      +git clone --branch=v2.1.1 https://github.com/opencultureconsulting/php-basics.git basics

      Be aware that you also need to make the classes and traits available in your application by either adding them to your