Release v2.1.1

This commit is contained in:
Sebastian Meyer 2024-07-11 13:14:31 +02:00
parent 09d3940a1f
commit 209dd469c4
9 changed files with 80 additions and 14 deletions

View File

@ -6,6 +6,17 @@ Changelog
.. sidebar:: Table of Contents .. sidebar:: Table of Contents
.. 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 v2.1.0
====== ======
@ -56,6 +67,9 @@ v2.0.0
* Added new trait :php:trait:`OCC\Basics\Traits\TypeChecker` * Added new trait :php:trait:`OCC\Basics\Traits\TypeChecker`
* Extended API for all datastructures (see :php:trait:`OCC\Basics\DataStructures\Traits\StrictSplDoublyLinkedListTrait`) * Extended API for all datastructures (see :php:trait:`OCC\Basics\DataStructures\Traits\StrictSplDoublyLinkedListTrait`)
* Introduced :php:class:`OCC\Basics\DataStructures\Exceptions\InvalidDataTypeException` for strict datastructures * Introduced :php:class:`OCC\Basics\DataStructures\Exceptions\InvalidDataTypeException` for strict datastructures
**Minor Changes:**
* Extended `documentation <https://opencultureconsulting.github.io/php-basics/>`_ * Extended `documentation <https://opencultureconsulting.github.io/php-basics/>`_
v1.1.0 v1.1.0
@ -77,7 +91,7 @@ v1.1.0
v1.0.1 v1.0.1
====== ======
**New Features:** **Minor Changes:**
* Improved exception handling in :php:trait:`Singleton <OCC\Basics\Traits\Singleton>` trait * Improved exception handling in :php:trait:`Singleton <OCC\Basics\Traits\Singleton>` trait

View File

@ -46,8 +46,8 @@ well:
.. code-block:: shell .. code-block:: shell
# This will clone the repository state at version "2.1.0" into the "basics" directory # This will clone the repository state at version "2.1.1" into the "basics" directory
git clone --branch=v2.1.0 https://github.com/opencultureconsulting/php-basics.git basics 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 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. autoloader or by including all files individually in PHP.

View File

@ -198,9 +198,9 @@
<aside class="phpdocumentor-element-found-in"> <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> <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> </aside>
<p class="phpdocumentor-summary">Throws internal errors as exceptions.</p> <p class="phpdocumentor-summary">Throws internal errors as exceptions.</p>
@ -291,9 +291,9 @@
<aside class="phpdocumentor-element-found-in"> <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> <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> </aside>
<p class="phpdocumentor-summary">Convert an internal PHP error into an ErrorException.</p> <p class="phpdocumentor-summary">Convert an internal PHP error into an ErrorException.</p>

View File

@ -198,9 +198,9 @@
<aside class="phpdocumentor-element-found-in"> <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> <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> </aside>
<p class="phpdocumentor-summary">Triggers errors for uncaught exceptions.</p> <p class="phpdocumentor-summary">Triggers errors for uncaught exceptions.</p>
@ -291,9 +291,9 @@ converts it into an internal PHP error of severity <code class="prettyprint">E_U
<aside class="phpdocumentor-element-found-in"> <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> <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> </aside>
<p class="phpdocumentor-summary">Convert an uncaught exception into an PHP error.</p> <p class="phpdocumentor-summary">Convert an uncaught exception into an PHP error.</p>

View File

@ -35,6 +35,8 @@ use function error_reporting;
* *
* > Usage: `set_error_handler(new ThrowErrorException());` * > Usage: `set_error_handler(new ThrowErrorException());`
* *
* @api
*
* @author Sebastian Meyer <sebastian.meyer@opencultureconsulting.com> * @author Sebastian Meyer <sebastian.meyer@opencultureconsulting.com>
* @package Basics\ErrorHandlers * @package Basics\ErrorHandlers
*/ */

View File

@ -36,6 +36,8 @@ use function trigger_error;
* *
* > Usage: `set_exception_handler(new TriggerExceptionError());` * > Usage: `set_exception_handler(new TriggerExceptionError());`
* *
* @api
*
* @author Sebastian Meyer <sebastian.meyer@opencultureconsulting.com> * @author Sebastian Meyer <sebastian.meyer@opencultureconsulting.com>
* @package Basics\ErrorHandlers * @package Basics\ErrorHandlers
*/ */

View File

@ -176,6 +176,12 @@
<div class="contents"> <div class="contents">
<ul class="phpdocumentor-list"> <ul class="phpdocumentor-list">
<li class="toc-item"> <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> <a href="guides/changelog.html#v2-1-0">v2.1.0</a>
@ -211,6 +217,33 @@
</div> </div>
</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"> <div class="section" id="v2-1-0">
<h2>v2.1.0</h2> <h2>v2.1.0</h2>
@ -311,6 +344,15 @@ function _magicSet{Property}(mixed $value): void</code></pre>
<li>Introduced <a href="classes/OCC-Basics-DataStructures-Exceptions-InvalidDataTypeException.html"><abbr title="\OCC\Basics\DataStructures\Exceptions\InvalidDataTypeException">InvalidDataTypeException</abbr></a> <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> 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> <li>Extended <a href="https://opencultureconsulting.github.io/php-basics/">documentation</a></li>
</ul> </ul>
@ -345,7 +387,7 @@ public function __construct(array $allowedTypes = [])</code></pre>
<h2>v1.0.1</h2> <h2>v1.0.1</h2>
<p><strong>New Features:</strong> <p><strong>Minor Changes:</strong>
</p> </p>

View File

@ -227,6 +227,12 @@
<a href="guides/changelog.html#changelog">Changelog</a> <a href="guides/changelog.html#changelog">Changelog</a>
<ul class="section-level-1"> <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"> <li class="toc-item">
<a href="guides/changelog.html#v2-1-0">v2.1.0</a> <a href="guides/changelog.html#v2-1-0">v2.1.0</a>

View File

@ -238,8 +238,8 @@ git clone https://github.com/opencultureconsulting/php-basics.git basics</code><
<p>If you want to use a specific version other than the latest development state, you have to specify the desired tag as <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> 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 <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.0 https://github.com/opencultureconsulting/php-basics.git basics</code></pre> 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 <p>Be aware that you also need to make the classes and traits available in your application by either adding them to your