Release v2.1.1

opencultureconsulting · Jul 11, 2024 · 209dd46 · 209dd46
1 parent 09d3940
commit 209dd46
Show file tree

Hide file tree

Showing 9 changed files with 80 additions and 14 deletions.
diff --git 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 <https://opencultureconsulting.github.io/php-basics/>`_
+
 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 <https://opencultureconsulting.github.io/php-basics/>`_
 
 v1.1.0
@@ -77,7 +91,7 @@ v1.1.0
 v1.0.1
 ======
 
-**New Features:**
+**Minor Changes:**
 
 * Improved exception handling in :php:trait:`Singleton <OCC\Basics\Traits\Singleton>` trait
 

diff --git 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
@@ -198,9 +198,9 @@ <h2 class="phpdocumentor-content__title">
         <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="src/ErrorHandlers/ThrowErrorException.php"><a href="files/src-errorhandlers-throwerrorexception.html"><abbr title="src/ErrorHandlers/ThrowErrorException.php">ThrowErrorException.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">41</span>
+    <span class="phpdocumentor-element-found-in__line">43</span>
 
-            <a href="classes/OCC-Basics-ErrorHandlers-ThrowErrorException.html#source-view.41" class="phpdocumentor-element-found-in__source" data-line="41" data-modal="source-view" data-src="files/src/ErrorHandlers/ThrowErrorException.php.txt"></a>
+            <a href="classes/OCC-Basics-ErrorHandlers-ThrowErrorException.html#source-view.43" class="phpdocumentor-element-found-in__source" data-line="43" data-modal="source-view" data-src="files/src/ErrorHandlers/ThrowErrorException.php.txt"></a>
     </aside>
 
             <p class="phpdocumentor-summary">Throws internal errors as exceptions.</p>
@@ -291,9 +291,9 @@ <h4 class="phpdocumentor-element__name" id="method___invoke">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="src/ErrorHandlers/ThrowErrorException.php"><a href="files/src-errorhandlers-throwerrorexception.html"><abbr title="src/ErrorHandlers/ThrowErrorException.php">ThrowErrorException.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">55</span>
+    <span class="phpdocumentor-element-found-in__line">57</span>
 
-            <a href="classes/OCC-Basics-ErrorHandlers-ThrowErrorException.html#source-view.55" class="phpdocumentor-element-found-in__source" data-line="55" data-modal="source-view" data-src="files/src/ErrorHandlers/ThrowErrorException.php.txt"></a>
+            <a href="classes/OCC-Basics-ErrorHandlers-ThrowErrorException.html#source-view.57" class="phpdocumentor-element-found-in__source" data-line="57" data-modal="source-view" data-src="files/src/ErrorHandlers/ThrowErrorException.php.txt"></a>
     </aside>
 
         <p class="phpdocumentor-summary">Convert an internal PHP error into an ErrorException.</p>

diff --git a/doc/classes/OCC-Basics-ErrorHandlers-TriggerExceptionError.html b/doc/classes/OCC-Basics-ErrorHandlers-TriggerExceptionError.html
@@ -198,9 +198,9 @@ <h2 class="phpdocumentor-content__title">
         <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="src/ErrorHandlers/TriggerExceptionError.php"><a href="files/src-errorhandlers-triggerexceptionerror.html"><abbr title="src/ErrorHandlers/TriggerExceptionError.php">TriggerExceptionError.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">42</span>
+    <span class="phpdocumentor-element-found-in__line">44</span>
 
-            <a href="classes/OCC-Basics-ErrorHandlers-TriggerExceptionError.html#source-view.42" class="phpdocumentor-element-found-in__source" data-line="42" data-modal="source-view" data-src="files/src/ErrorHandlers/TriggerExceptionError.php.txt"></a>
+            <a href="classes/OCC-Basics-ErrorHandlers-TriggerExceptionError.html#source-view.44" class="phpdocumentor-element-found-in__source" data-line="44" data-modal="source-view" data-src="files/src/ErrorHandlers/TriggerExceptionError.php.txt"></a>
     </aside>
 
             <p class="phpdocumentor-summary">Triggers errors for uncaught exceptions.</p>
@@ -291,9 +291,9 @@ <h4 class="phpdocumentor-element__name" id="method___invoke">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="src/ErrorHandlers/TriggerExceptionError.php"><a href="files/src-errorhandlers-triggerexceptionerror.html"><abbr title="src/ErrorHandlers/TriggerExceptionError.php">TriggerExceptionError.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">51</span>
+    <span class="phpdocumentor-element-found-in__line">53</span>
 
-            <a href="classes/OCC-Basics-ErrorHandlers-TriggerExceptionError.html#source-view.51" class="phpdocumentor-element-found-in__source" data-line="51" data-modal="source-view" data-src="files/src/ErrorHandlers/TriggerExceptionError.php.txt"></a>
+            <a href="classes/OCC-Basics-ErrorHandlers-TriggerExceptionError.html#source-view.53" class="phpdocumentor-element-found-in__source" data-line="53" data-modal="source-view" data-src="files/src/ErrorHandlers/TriggerExceptionError.php.txt"></a>
     </aside>
 
         <p class="phpdocumentor-summary">Convert an uncaught exception into an PHP error.</p>

diff --git 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 <sebastian.meyer@opencultureconsulting.com>
  * @package Basics\ErrorHandlers
  */

diff --git 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 <sebastian.meyer@opencultureconsulting.com>
  * @package Basics\ErrorHandlers
  */

diff --git a/doc/guides/changelog.html b/doc/guides/changelog.html
@@ -176,6 +176,12 @@ <h1>Changelog</h1>
         <div class="contents">
         <ul class="phpdocumentor-list">
     <li class="toc-item">
+    <a href="guides/changelog.html#v2-1-1">v2.1.1</a>
+
+
+</li>
+
+    <li class="toc-item">
     <a href="guides/changelog.html#v2-1-0">v2.1.0</a>
 
 
@@ -211,6 +217,33 @@ <h1>Changelog</h1>
     </div>
 </div>
 
+            <div class="section" id="v2-1-1">
+            <h2>v2.1.1</h2>
+
+
+    <p><strong>New Features:</strong>
+</p>
+
+
+
+<ul>
+    <li>Added Composer commands for development tools (PHP_CodeSniffer, PHP-CS-Fixer, PHPStan, Psalm and phpDocumentor)</li>
+
+</ul>
+
+
+    <p><strong>Minor Changes:</strong>
+</p>
+
+
+
+<ul>
+    <li>Extended <a href="https://opencultureconsulting.github.io/php-basics/">documentation</a></li>
+
+</ul>
+
+    </div>
+
             <div class="section" id="v2-1-0">
             <h2>v2.1.0</h2>
 
@@ -311,6 +344,15 @@ <h2>v2.0.0</h2>
     <li>Introduced <a href="classes/OCC-Basics-DataStructures-Exceptions-InvalidDataTypeException.html"><abbr title="\OCC\Basics\DataStructures\Exceptions\InvalidDataTypeException">InvalidDataTypeException</abbr></a>
  for strict datastructures</li>
 
+</ul>
+
+
+    <p><strong>Minor Changes:</strong>
+</p>
+
+
+
+<ul>
     <li>Extended <a href="https://opencultureconsulting.github.io/php-basics/">documentation</a></li>
 
 </ul>
@@ -345,7 +387,7 @@ <h2>v1.1.0</h2>
             <h2>v1.0.1</h2>
 
 
-    <p><strong>New Features:</strong>
+    <p><strong>Minor Changes:</strong>
 </p>
 
 

diff --git a/doc/guides/index.html b/doc/guides/index.html
@@ -227,6 +227,12 @@ <h1>Documentation</h1>
     <a href="guides/changelog.html#changelog">Changelog</a>
 
         <ul class="section-level-1">
+            <li class="toc-item">
+    <a href="guides/changelog.html#v2-1-1">v2.1.1</a>
+
+
+</li>
+
             <li class="toc-item">
     <a href="guides/changelog.html#v2-1-0">v2.1.0</a>
 

diff --git a/doc/guides/usage/installation.html b/doc/guides/usage/installation.html
@@ -238,8 +238,8 @@ <h2>Git</h2>
     <p>If you want to use a specific version other than the latest development state, you have to specify the desired tag as
 well:</p>
 
-            <pre><code class="language-shell"># This will clone the repository state at version &quot;2.1.0&quot; into the &quot;basics&quot; directory
-git clone --branch=v2.1.0 https://github.com/opencultureconsulting/php-basics.git basics</code></pre>
+            <pre><code class="language-shell"># This will clone the repository state at version &quot;2.1.1&quot; into the &quot;basics&quot; directory
+git clone --branch=v2.1.1 https://github.com/opencultureconsulting/php-basics.git basics</code></pre>
 
 
     <p>Be aware that you also need to make the classes and traits available in your application by either adding them to your