From 3db89b5841a355440ca0177c96c4e87c89cf5cfc Mon Sep 17 00:00:00 2001 From: Sebastian Meyer Date: Mon, 19 Feb 2024 14:52:57 +0100 Subject: [PATCH] Update documentation --- .phpdoc/guide/changelog.rst | 35 ++- .phpdoc/guide/index.rst | 11 +- .phpdoc/guide/usage/installation.rst | 50 ++++- .phpdoc/guide/usage/requirements.rst | 15 +- ...asics-DataStructures-StrictCollection.html | 107 ++++----- .../OCC-Basics-DataStructures-StrictList.html | 163 +++++++------- ...OCC-Basics-DataStructures-StrictQueue.html | 171 +++++++------- ...OCC-Basics-DataStructures-StrictStack.html | 171 +++++++------- ...ics-ErrorHandlers-ThrowErrorException.html | 23 +- ...s-ErrorHandlers-TriggerExceptionError.html | 23 +- ...CC-Basics-Interfaces-ArrayAccessTrait.html | 35 +-- .../OCC-Basics-Interfaces-CountableTrait.html | 23 +- ...ics-Interfaces-IteratorAggregateTrait.html | 15 +- .../OCC-Basics-Interfaces-IteratorTrait.html | 43 ++-- doc/classes/OCC-Basics-Traits-Getter.html | 27 +-- .../OCC-Basics-Traits-OverloadingGetter.html | 27 +-- .../OCC-Basics-Traits-OverloadingSetter.html | 15 +- doc/classes/OCC-Basics-Traits-Setter.html | 27 +-- doc/classes/OCC-Basics-Traits-Singleton.html | 15 +- doc/css/template.css | 2 +- .../src-datastructures-strictcollection.html | 15 +- doc/files/src-datastructures-strictlist.html | 15 +- doc/files/src-datastructures-strictqueue.html | 15 +- doc/files/src-datastructures-strictstack.html | 15 +- ...src-errorhandlers-throwerrorexception.html | 15 +- ...c-errorhandlers-triggerexceptionerror.html | 15 +- .../src-interfaces-arrayaccesstrait.html | 15 +- doc/files/src-interfaces-countabletrait.html | 15 +- ...src-interfaces-iteratoraggregatetrait.html | 15 +- doc/files/src-interfaces-iteratortrait.html | 15 +- doc/files/src-traits-getter.html | 15 +- doc/files/src-traits-overloadinggetter.html | 15 +- doc/files/src-traits-overloadingsetter.html | 15 +- doc/files/src-traits-setter.html | 15 +- doc/files/src-traits-singleton.html | 15 +- .../DataStructures/StrictCollection.php.txt | 28 +++ .../src/DataStructures/StrictList.php.txt | 30 +++ .../src/DataStructures/StrictQueue.php.txt | 2 + .../src/DataStructures/StrictStack.php.txt | 2 + .../ErrorHandlers/ThrowErrorException.php.txt | 2 + .../TriggerExceptionError.php.txt | 3 + .../src/Interfaces/ArrayAccessTrait.php.txt | 2 + .../src/Interfaces/CountableTrait.php.txt | 2 + .../src/Interfaces/IteratorTrait.php.txt | 7 + doc/files/src/Traits/Getter.php.txt | 6 + .../src/Traits/OverloadingGetter.php.txt | 2 + doc/files/src/Traits/Setter.php.txt | 5 + doc/graphs/classes.html | 15 +- doc/guides/changelog.html | 59 ++--- doc/guides/cheatsheet.html | 212 ++++++++++++++++++ doc/guides/index.html | 15 +- doc/guides/overview/index.html | 15 +- doc/guides/usage/index.html | 31 +-- doc/guides/usage/installation.html | 56 +++-- doc/guides/usage/requirements.html | 32 +-- doc/index.html | 15 +- doc/indices/files.html | 15 +- doc/namespaces/default.html | 15 +- doc/namespaces/occ-basics-datastructures.html | 15 +- doc/namespaces/occ-basics-errorhandlers.html | 15 +- doc/namespaces/occ-basics-interfaces.html | 15 +- doc/namespaces/occ-basics-traits.html | 15 +- doc/namespaces/occ-basics.html | 15 +- doc/namespaces/occ.html | 15 +- doc/packages/Basics-DataStructures.html | 15 +- doc/packages/Basics-ErrorHandlers.html | 15 +- doc/packages/Basics-Interfaces.html | 15 +- doc/packages/Basics-Traits.html | 15 +- doc/packages/Basics.html | 15 +- doc/packages/default.html | 15 +- doc/reports/deprecated.html | 15 +- doc/reports/errors.html | 15 +- doc/reports/markers.html | 15 +- 73 files changed, 910 insertions(+), 1109 deletions(-) create mode 100644 doc/guides/cheatsheet.html diff --git a/.phpdoc/guide/changelog.rst b/.phpdoc/guide/changelog.rst index 00d0f88..ab8d7be 100644 --- a/.phpdoc/guide/changelog.rst +++ b/.phpdoc/guide/changelog.rst @@ -3,32 +3,35 @@ Changelog ######### -* :ref:`v2-0-0` -* :ref:`v1-1-0` -* :ref:`v1-0-1` -* :ref:`v1-0-0` - -.. _v2-0-0: +.. contents:: v2.0.0 ====== **Breaking Changes:** -* Raised minimum PHP version from 8.0 to 8.1 -* Renamed traits for :php:namespace:`OCC\Basics\Interfaces` and moved to different namespace +* Raised minimum PHP version from 8.0 to 8.1 in order to use `new features `_ like + `array_is_list() `_ and the spread operator on string-keyed arrays +* :php:namespace:`OCC\Basics\Interfaces` traits renamed and moved to different namespace + + .. code-block:: + OCC\Basics\InterfaceTraits\ArrayAccess -> OCC\Basics\Interfaces\ArrayAccessTrait + OCC\Basics\InterfaceTraits\Countable -> OCC\Basics\Interfaces\CountableTrait + OCC\Basics\InterfaceTraits\IteratorAggregate -> OCC\Basics\Interfaces\IteratorAggregateTrait + OCC\Basics\InterfaceTraits\Iterator -> OCC\Basics\Interfaces\IteratorTrait + * Renamed internal methods for :php:trait:`OCC\Basics\Traits\Getter` and :php:trait:`OCC\Basics\Traits\Setter` to avoid - confusion with regular class method + confusion with regular class methods .. code-block:: php // old methods - protected function magicGet{PascalCasePropertyName}(): mixed - protected function magicSet{PascalCasePropertyName}(mixed $value): void + function magicGet{PascalCasePropertyName}(): mixed + function magicSet{PascalCasePropertyName}(mixed $value): void .. code-block:: php // new methods - protected function _magicGet{PascalCasePropertyName}(): mixed - protected function _magicSet{PascalCasePropertyName}(mixed $value): void + function _magicGet{PascalCasePropertyName}(): mixed + function _magicSet{PascalCasePropertyName}(mixed $value): void **New Features:** @@ -39,8 +42,6 @@ v2.0.0 * Extended API for all datastructures * Extended `documentation `_ -.. _v1-1-0: - v1.1.0 ====== @@ -57,8 +58,6 @@ v1.1.0 // new constructor signature public function __construct(array $allowedTypes = []) -.. _v1-0-1: - v1.0.1 ====== @@ -66,8 +65,6 @@ v1.0.1 * Improved exception handling in :php:trait:`Singleton ` trait -.. _v1-0-0: - v1.0.0 ====== diff --git a/.phpdoc/guide/index.rst b/.phpdoc/guide/index.rst index e3f6b33..c2a08f9 100644 --- a/.phpdoc/guide/index.rst +++ b/.phpdoc/guide/index.rst @@ -4,12 +4,11 @@ Documentation ############# .. meta:: - :layout: landingpage + :layout: landingpage .. toctree:: - :hidden: - :titlesonly: + :hidden: - overview/index - usage/index - changelog + overview/index + usage/index + changelog diff --git a/.phpdoc/guide/usage/installation.rst b/.phpdoc/guide/usage/installation.rst index c0dcfbd..ad96dc2 100644 --- a/.phpdoc/guide/usage/installation.rst +++ b/.phpdoc/guide/usage/installation.rst @@ -3,6 +3,54 @@ Installation ############ +Composer +======== + +The intended and recommended way of re-using this package is via `Composer `_. The following +command will get you the latest version and make it a dependency of your project. It will also register all classes and +traits with the autoloader to make them available inside the application. + .. code-block:: shell - composer require opencultureconsulting/basics + # This will install the latest stable version suitable for your project + composer require "opencultureconsulting/basics" + +If you want to use a specific version other than the latest available for your environment, you can do so by appending +the desired version constraint: + +.. code-block:: shell + + # This will install the latest patch level version of 2.0 (i. e. >=2.0.0 && <2.1.0) + composer require "opencultureconsulting/basics:~2.0" + +All available versions as well as further information about :doc:`requirements` and dependencies can be found on +`Packagist `_. + +Git +=== + +Alternatively, you can fetch the files from `GitHub `_ and add +them to your project manually. The best way is by cloning the repository, because then you can easily update to a newer +version by just pulling the changes and checking out a different version tag. + +.. code-block:: shell + + # This will clone the repository into the "basics" directory + git clone https://github.com/opencultureconsulting/php-basics.git basics + +If you want to use a specific version other than the latest development state, you have to specify the desired tag as +well: + +.. code-block:: shell + + # This will clone the repository state at version "2.0.0" into the "basics" directory + git clone --branch=v2.0.0 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. + +Download +======== + +As a last resort you can also just download the files. You can find all available versions as well as the current +development state on the `GitHub release page `_. diff --git a/.phpdoc/guide/usage/requirements.rst b/.phpdoc/guide/usage/requirements.rst index 5f8a60d..a46e1a2 100644 --- a/.phpdoc/guide/usage/requirements.rst +++ b/.phpdoc/guide/usage/requirements.rst @@ -3,5 +3,16 @@ Requirements ############ -PHP 8.1 -Composer 2 +Environment +=========== + +This package requires at least **PHP 8.1**. + +It is highly recommended to use `Composer `_ for dependency management and autoloading, +although it is technically not strictly required for re-using any of these classes and traits. But it certainly +makes it a lot easier! + +Dependencies +============ + +This package does not have any external dependencies. diff --git a/doc/classes/OCC-Basics-DataStructures-StrictCollection.html b/doc/classes/OCC-Basics-DataStructures-StrictCollection.html index b4dbb74..a73c5a9 100644 --- a/doc/classes/OCC-Basics-DataStructures-StrictCollection.html +++ b/doc/classes/OCC-Basics-DataStructures-StrictCollection.html @@ -142,8 +142,8 @@

Markers

-
-

Index

+
+

Indices

Files

@@ -186,9 +186,9 @@

A type-sensitive, unsorted collection.

@@ -496,9 +496,9 @@ names.

Create a type-sensitive collection of items.

@@ -575,9 +575,9 @@ Possible values are:

Read data from an inaccessible property.

@@ -645,9 +645,9 @@ Possible values are:

Check if an inaccessible property is set and not empty.

@@ -698,9 +698,9 @@ Possible values are:

Add/insert a new item at the specified index.

@@ -771,9 +771,9 @@ Possible values are:

Clear the collection of any items.

@@ -806,9 +806,9 @@ Possible values are:

Count the data items.

@@ -849,9 +849,9 @@ Possible values are:

Get the item at the specified index.

@@ -904,9 +904,9 @@ Possible values are:

Get allowed data types for collection items.

@@ -947,9 +947,9 @@ Possible values are:

Check if the item's data type is allowed in the collection.

@@ -1002,9 +1002,9 @@ Possible values are:

Check if collection is empty.

@@ -1045,9 +1045,9 @@ Possible values are:

Check if this collection can be considered a list.

@@ -1106,9 +1106,9 @@ from 0.

Check if the specified offset exists.

@@ -1161,9 +1161,9 @@ from 0.

Retrieve data at the specified offset.

@@ -1216,9 +1216,9 @@ from 0.

Set the item at the specified offset.

@@ -1289,9 +1289,9 @@ from 0.

Unset the specified offset.

@@ -1336,9 +1336,9 @@ from 0.

Remove an item from the collection.

@@ -1383,9 +1383,9 @@ from 0.

Get string representation of $this.

@@ -1424,9 +1424,9 @@ from 0.

Set an item at the specified index.

@@ -1497,9 +1497,9 @@ from 0.

Return array representation of collection.

@@ -1540,9 +1540,9 @@ from 0.

Turn collection into a type-sensitive list.

@@ -1608,9 +1608,9 @@ from 0.

Restore $this from string representation.

@@ -1653,9 +1653,9 @@ from 0.

Set allowed data types of collection items.

@@ -1854,17 +1854,6 @@ from 0.

Search results

-
- -
-
diff --git a/doc/classes/OCC-Basics-DataStructures-StrictList.html b/doc/classes/OCC-Basics-DataStructures-StrictList.html index 1d66cd2..72bc23b 100644 --- a/doc/classes/OCC-Basics-DataStructures-StrictList.html +++ b/doc/classes/OCC-Basics-DataStructures-StrictList.html @@ -142,8 +142,8 @@

Markers

-
-

Index

+
+

Indices

Files

@@ -189,9 +189,9 @@

A type-sensitive, taversable list.

@@ -595,9 +595,9 @@ constructor with an array of atomic types or fully qualified class names.

Create a type-sensitive, traversable list of items.

@@ -674,9 +674,9 @@ Possible values are:

Read data from an inaccessible property.

@@ -744,9 +744,9 @@ Possible values are:

Check if an inaccessible property is set and not empty.

@@ -797,9 +797,9 @@ Possible values are:

Add/insert a new item at the specified offset.

@@ -880,9 +880,9 @@ Possible values are:

Append items at the end of the list.

@@ -944,9 +944,9 @@ Possible values are:

Peek at the item at the beginning of the list.

@@ -1004,9 +1004,9 @@ Possible values are:

Clear the list of any items.

@@ -1039,9 +1039,9 @@ Possible values are:

Get the number of items on the list.

@@ -1082,9 +1082,9 @@ Possible values are:

Get the current list item.

@@ -1125,9 +1125,9 @@ Possible values are:

Get the item at the specified index.

@@ -1197,9 +1197,9 @@ Possible values are:

Get allowed data types for list items.

@@ -1240,9 +1240,9 @@ Possible values are:

Get the mode of iteration.

@@ -1283,9 +1283,9 @@ Possible values are:

Check if the item's data type is allowed on the list.

@@ -1338,9 +1338,9 @@ Possible values are:

Check if list is empty.

@@ -1381,9 +1381,9 @@ Possible values are:

Check if this can be considered a list.

@@ -1424,9 +1424,9 @@ Possible values are:

Get the current list index.

@@ -1467,9 +1467,9 @@ Possible values are:

Move the cursor to the next list index.

@@ -1502,9 +1502,9 @@ Possible values are:

Check if the specified index exists and is not empty.

@@ -1557,9 +1557,9 @@ Possible values are:

Get the item from the specified index.

@@ -1629,9 +1629,9 @@ Possible values are:

Set the item at the specified offset.

@@ -1712,9 +1712,9 @@ Possible values are:

Unset the item at the specified index.

@@ -1776,9 +1776,9 @@ Possible values are:

Pops an item from the end of the list.

@@ -1836,9 +1836,9 @@ Possible values are:

Prepend items at the start of the list.

@@ -1900,9 +1900,9 @@ Possible values are:

Move the cursor to the previous list index.

@@ -1935,9 +1935,9 @@ Possible values are:

Push an item at the end of the list.

@@ -1999,9 +1999,9 @@ Possible values are:

Remove an item from the list.

@@ -2063,9 +2063,9 @@ Possible values are:

Rewind the iterator's cursor.

@@ -2098,9 +2098,9 @@ Possible values are:

Set an item at the specified index.

@@ -2171,9 +2171,9 @@ Possible values are:

Set the mode of iteration.

@@ -2255,9 +2255,9 @@ Possible values are:

Shift an item from the beginning of the list.

@@ -2315,9 +2315,9 @@ Possible values are:

Return array representation of list.

@@ -2358,9 +2358,9 @@ Possible values are:

Peek at the item at the end of the list.

@@ -2418,9 +2418,9 @@ Possible values are:

Turn list into a type-sensitive collection.

@@ -2461,9 +2461,9 @@ Possible values are:

Prepend the list with an item.

@@ -2525,9 +2525,9 @@ Possible values are:

Check if current cursor position is valid.

@@ -2568,9 +2568,9 @@ Possible values are:

Set allowed data types of list items.

@@ -2783,17 +2783,6 @@ Possible values are:

Search results

-
- -
-
diff --git a/doc/classes/OCC-Basics-DataStructures-StrictQueue.html b/doc/classes/OCC-Basics-DataStructures-StrictQueue.html index 6f8b4b9..414e310 100644 --- a/doc/classes/OCC-Basics-DataStructures-StrictQueue.html +++ b/doc/classes/OCC-Basics-DataStructures-StrictQueue.html @@ -142,8 +142,8 @@

Markers

-
-

Index

+
+

Indices

Files

@@ -186,9 +186,9 @@

A type-sensitive, taversable queue (FIFO).

@@ -608,9 +608,9 @@ like \SplQueue.

Create a type-sensitive, traversable queue of items.

@@ -687,9 +687,9 @@ Possible values are:

Read data from an inaccessible property.

@@ -757,9 +757,9 @@ Possible values are:

Check if an inaccessible property is set and not empty.

@@ -810,9 +810,9 @@ Possible values are:

Add/insert a new item at the specified offset.

@@ -893,9 +893,9 @@ Possible values are:

Append items at the end of the list.

@@ -957,9 +957,9 @@ Possible values are:

Peek at the item at the beginning of the list.

@@ -1017,9 +1017,9 @@ Possible values are:

Clear the list of any items.

@@ -1052,9 +1052,9 @@ Possible values are:

Get the number of items on the list.

@@ -1095,9 +1095,9 @@ Possible values are:

Get the current list item.

@@ -1138,9 +1138,9 @@ Possible values are:

Dequeue an item from the queue.

@@ -1181,9 +1181,9 @@ Possible values are:

Add an item to the queue.

@@ -1245,9 +1245,9 @@ Possible values are:

Get the item at the specified index.

@@ -1317,9 +1317,9 @@ Possible values are:

Get allowed data types for list items.

@@ -1360,9 +1360,9 @@ Possible values are:

Get the mode of iteration.

@@ -1403,9 +1403,9 @@ Possible values are:

Check if the item's data type is allowed on the list.

@@ -1458,9 +1458,9 @@ Possible values are:

Check if list is empty.

@@ -1501,9 +1501,9 @@ Possible values are:

Check if this can be considered a list.

@@ -1544,9 +1544,9 @@ Possible values are:

Get the current list index.

@@ -1587,9 +1587,9 @@ Possible values are:

Move the cursor to the next list index.

@@ -1622,9 +1622,9 @@ Possible values are:

Check if the specified index exists and is not empty.

@@ -1677,9 +1677,9 @@ Possible values are:

Get the item from the specified index.

@@ -1749,9 +1749,9 @@ Possible values are:

Set the item at the specified offset.

@@ -1832,9 +1832,9 @@ Possible values are:

Unset the item at the specified index.

@@ -1896,9 +1896,9 @@ Possible values are:

Pops an item from the end of the list.

@@ -1956,9 +1956,9 @@ Possible values are:

Prepend items at the start of the list.

@@ -2020,9 +2020,9 @@ Possible values are:

Move the cursor to the previous list index.

@@ -2055,9 +2055,9 @@ Possible values are:

Push an item at the end of the list.

@@ -2119,9 +2119,9 @@ Possible values are:

Remove an item from the list.

@@ -2183,9 +2183,9 @@ Possible values are:

Rewind the iterator's cursor.

@@ -2218,9 +2218,9 @@ Possible values are:

Set an item at the specified index.

@@ -2291,9 +2291,9 @@ Possible values are:

Set the mode of iteration.

@@ -2384,9 +2384,9 @@ Possible values are:

Shift an item from the beginning of the list.

@@ -2444,9 +2444,9 @@ Possible values are:

Return array representation of list.

@@ -2487,9 +2487,9 @@ Possible values are:

Peek at the item at the end of the list.

@@ -2547,9 +2547,9 @@ Possible values are:

Turn list into a type-sensitive collection.

@@ -2590,9 +2590,9 @@ Possible values are:

Prepend the list with an item.

@@ -2654,9 +2654,9 @@ Possible values are:

Check if current cursor position is valid.

@@ -2697,9 +2697,9 @@ Possible values are:

Set allowed data types of list items.

@@ -2914,17 +2914,6 @@ Possible values are:

Search results

-
- -
-
diff --git a/doc/classes/OCC-Basics-DataStructures-StrictStack.html b/doc/classes/OCC-Basics-DataStructures-StrictStack.html index 4763121..a0c75a1 100644 --- a/doc/classes/OCC-Basics-DataStructures-StrictStack.html +++ b/doc/classes/OCC-Basics-DataStructures-StrictStack.html @@ -142,8 +142,8 @@

Markers

-
-

Index

+
+

Indices

Files

@@ -186,9 +186,9 @@

A type-sensitive, taversable stack (LIFO).

@@ -608,9 +608,9 @@ like \SplStack.

Create a type-sensitive, traversable stack of items.

@@ -687,9 +687,9 @@ Possible values are:

Read data from an inaccessible property.

@@ -757,9 +757,9 @@ Possible values are:

Check if an inaccessible property is set and not empty.

@@ -810,9 +810,9 @@ Possible values are:

Add/insert a new item at the specified offset.

@@ -893,9 +893,9 @@ Possible values are:

Append items at the end of the list.

@@ -957,9 +957,9 @@ Possible values are:

Peek at the item at the beginning of the list.

@@ -1017,9 +1017,9 @@ Possible values are:

Clear the list of any items.

@@ -1052,9 +1052,9 @@ Possible values are:

Get the number of items on the list.

@@ -1095,9 +1095,9 @@ Possible values are:

Get the current list item.

@@ -1138,9 +1138,9 @@ Possible values are:

Get the item at the specified index.

@@ -1210,9 +1210,9 @@ Possible values are:

Get allowed data types for list items.

@@ -1253,9 +1253,9 @@ Possible values are:

Get the mode of iteration.

@@ -1296,9 +1296,9 @@ Possible values are:

Check if the item's data type is allowed on the list.

@@ -1351,9 +1351,9 @@ Possible values are:

Check if list is empty.

@@ -1394,9 +1394,9 @@ Possible values are:

Check if this can be considered a list.

@@ -1437,9 +1437,9 @@ Possible values are:

Get the current list index.

@@ -1480,9 +1480,9 @@ Possible values are:

Move the cursor to the next list index.

@@ -1515,9 +1515,9 @@ Possible values are:

Check if the specified index exists and is not empty.

@@ -1570,9 +1570,9 @@ Possible values are:

Get the item from the specified index.

@@ -1642,9 +1642,9 @@ Possible values are:

Set the item at the specified offset.

@@ -1725,9 +1725,9 @@ Possible values are:

Unset the item at the specified index.

@@ -1789,9 +1789,9 @@ Possible values are:

Pops an item from the end of the list.

@@ -1849,9 +1849,9 @@ Possible values are:

Prepend items at the start of the list.

@@ -1913,9 +1913,9 @@ Possible values are:

Move the cursor to the previous list index.

@@ -1948,9 +1948,9 @@ Possible values are:

Push an item at the end of the list.

@@ -2012,9 +2012,9 @@ Possible values are:

Remove an item from the list.

@@ -2076,9 +2076,9 @@ Possible values are:

Rewind the iterator's cursor.

@@ -2111,9 +2111,9 @@ Possible values are:

Set an item at the specified index.

@@ -2184,9 +2184,9 @@ Possible values are:

Set the mode of iteration.

@@ -2277,9 +2277,9 @@ Possible values are:

Shift an item from the beginning of the list.

@@ -2337,9 +2337,9 @@ Possible values are:

Add an item to the stack.

@@ -2401,9 +2401,9 @@ Possible values are:

Return array representation of list.

@@ -2444,9 +2444,9 @@ Possible values are:

Peek at the item at the end of the list.

@@ -2504,9 +2504,9 @@ Possible values are:

Turn list into a type-sensitive collection.

@@ -2547,9 +2547,9 @@ Possible values are:

Prepend the list with an item.

@@ -2611,9 +2611,9 @@ Possible values are:

Unstack an item from the stack.

@@ -2654,9 +2654,9 @@ Possible values are:

Check if current cursor position is valid.

@@ -2697,9 +2697,9 @@ Possible values are:

Set allowed data types of list items.

@@ -2914,17 +2914,6 @@ Possible values are:

Search results

-
- -
-
diff --git a/doc/classes/OCC-Basics-ErrorHandlers-ThrowErrorException.html b/doc/classes/OCC-Basics-ErrorHandlers-ThrowErrorException.html index 8c46aaf..e4425cf 100644 --- a/doc/classes/OCC-Basics-ErrorHandlers-ThrowErrorException.html +++ b/doc/classes/OCC-Basics-ErrorHandlers-ThrowErrorException.html @@ -142,8 +142,8 @@

Markers

-
-

Index

+
+

Indices

Files

@@ -180,9 +180,9 @@

Throws internal errors as exceptions.

@@ -271,9 +271,9 @@

Convert an internal PHP error into an ErrorException.

@@ -479,17 +479,6 @@

Search results

-
- -
-
diff --git a/doc/classes/OCC-Basics-ErrorHandlers-TriggerExceptionError.html b/doc/classes/OCC-Basics-ErrorHandlers-TriggerExceptionError.html index 069a382..d6b9827 100644 --- a/doc/classes/OCC-Basics-ErrorHandlers-TriggerExceptionError.html +++ b/doc/classes/OCC-Basics-ErrorHandlers-TriggerExceptionError.html @@ -142,8 +142,8 @@

Markers

-
-

Index

+
+

Indices

Files

@@ -180,9 +180,9 @@

Triggers errors for uncaught exceptions.

@@ -271,9 +271,9 @@ converts it into an internal PHP error of severity E_U

Convert an uncaught exception into an PHP error.

@@ -427,17 +427,6 @@ converts it into an internal PHP error of severity E_U

Search results

-
- -
-
diff --git a/doc/classes/OCC-Basics-Interfaces-ArrayAccessTrait.html b/doc/classes/OCC-Basics-Interfaces-ArrayAccessTrait.html index 27b9d54..8d893c7 100644 --- a/doc/classes/OCC-Basics-Interfaces-ArrayAccessTrait.html +++ b/doc/classes/OCC-Basics-Interfaces-ArrayAccessTrait.html @@ -142,8 +142,8 @@

Markers

-
-

Index

+
+

Indices

Files

@@ -164,9 +164,9 @@

A generic implementation of the ArrayAccess interface.

@@ -281,9 +281,9 @@

Check if the specified offset exists.

@@ -336,9 +336,9 @@

Retrieve data at the specified offset.

@@ -391,9 +391,9 @@

Assign a value to the specified offset.

@@ -447,9 +447,9 @@

Unset the specified offset.

@@ -606,17 +606,6 @@

Search results

-
- -
-
diff --git a/doc/classes/OCC-Basics-Interfaces-CountableTrait.html b/doc/classes/OCC-Basics-Interfaces-CountableTrait.html index 27962ca..e74e7d8 100644 --- a/doc/classes/OCC-Basics-Interfaces-CountableTrait.html +++ b/doc/classes/OCC-Basics-Interfaces-CountableTrait.html @@ -142,8 +142,8 @@

Markers

-
-

Index

+
+

Indices

Files

@@ -164,9 +164,9 @@

A generic implementation of the Countable interface.

@@ -260,9 +260,9 @@

Count the data items.

@@ -412,17 +412,6 @@

Search results

-
- -
-
diff --git a/doc/classes/OCC-Basics-Interfaces-IteratorAggregateTrait.html b/doc/classes/OCC-Basics-Interfaces-IteratorAggregateTrait.html index 8fa24fb..67cbba8 100644 --- a/doc/classes/OCC-Basics-Interfaces-IteratorAggregateTrait.html +++ b/doc/classes/OCC-Basics-Interfaces-IteratorAggregateTrait.html @@ -142,8 +142,8 @@

Markers

-
-

Index

+
+

Indices

Files

@@ -412,17 +412,6 @@

Search results

-
- -
-
diff --git a/doc/classes/OCC-Basics-Interfaces-IteratorTrait.html b/doc/classes/OCC-Basics-Interfaces-IteratorTrait.html index 571b15e..af7105a 100644 --- a/doc/classes/OCC-Basics-Interfaces-IteratorTrait.html +++ b/doc/classes/OCC-Basics-Interfaces-IteratorTrait.html @@ -142,8 +142,8 @@

Markers

-
-

Index

+
+

Indices

Files

@@ -164,9 +164,9 @@

A generic implementation of the Iterator interface.

@@ -295,9 +295,9 @@

Return the current item.

@@ -338,9 +338,9 @@

Return the current key.

@@ -381,9 +381,9 @@

Move forward to next item.

@@ -416,9 +416,9 @@

Move back to previous item.

@@ -451,9 +451,9 @@

Rewind the iterator to the first item.

@@ -486,9 +486,9 @@

Check if current position is valid.

@@ -643,17 +643,6 @@

Search results

-
- -
-
diff --git a/doc/classes/OCC-Basics-Traits-Getter.html b/doc/classes/OCC-Basics-Traits-Getter.html index 253331d..695d39a 100644 --- a/doc/classes/OCC-Basics-Traits-Getter.html +++ b/doc/classes/OCC-Basics-Traits-Getter.html @@ -142,8 +142,8 @@

Markers

-
-

Index

+
+

Indices

Files

@@ -164,9 +164,9 @@

Reads data from inaccessible properties by using magic methods.

@@ -266,9 +266,9 @@ a context where it normally would not be accessible.

Read data from an inaccessible property.

@@ -336,9 +336,9 @@ a context where it normally would not be accessible.

Check if an inaccessible property is set and not empty.

@@ -499,17 +499,6 @@ a context where it normally would not be accessible.

Search results

-
- -
-
diff --git a/doc/classes/OCC-Basics-Traits-OverloadingGetter.html b/doc/classes/OCC-Basics-Traits-OverloadingGetter.html index 8c4d2f7..09fa1e8 100644 --- a/doc/classes/OCC-Basics-Traits-OverloadingGetter.html +++ b/doc/classes/OCC-Basics-Traits-OverloadingGetter.html @@ -142,8 +142,8 @@

Markers

-
-

Index

+
+

Indices

Files

@@ -164,9 +164,9 @@

Overloads a class with readable magic properties.

@@ -262,9 +262,9 @@ as property names.

Read data from an overloaded property.

@@ -315,9 +315,9 @@ as property names.

Check if an overloaded property is set and not empty.

@@ -478,17 +478,6 @@ as property names.

Search results

-
- -
-
diff --git a/doc/classes/OCC-Basics-Traits-OverloadingSetter.html b/doc/classes/OCC-Basics-Traits-OverloadingSetter.html index f287002..ea9d3d2 100644 --- a/doc/classes/OCC-Basics-Traits-OverloadingSetter.html +++ b/doc/classes/OCC-Basics-Traits-OverloadingSetter.html @@ -142,8 +142,8 @@

Markers

-
-

Index

+
+

Indices

Files

@@ -471,17 +471,6 @@ as property names.

Search results

-
- -
-
diff --git a/doc/classes/OCC-Basics-Traits-Setter.html b/doc/classes/OCC-Basics-Traits-Setter.html index c5f6c60..d804505 100644 --- a/doc/classes/OCC-Basics-Traits-Setter.html +++ b/doc/classes/OCC-Basics-Traits-Setter.html @@ -142,8 +142,8 @@

Markers

-
-

Index

+
+

Indices

Files

@@ -164,9 +164,9 @@

Writes data to inaccessible properties by using magic methods.

@@ -266,9 +266,9 @@ to in a context where it normally would not be accessible.

Write data to an inaccessible property.

@@ -337,9 +337,9 @@ to in a context where it normally would not be accessible.

Unset an inaccessible property.

@@ -492,17 +492,6 @@ to in a context where it normally would not be accessible.

Search results

-
- -
-
diff --git a/doc/classes/OCC-Basics-Traits-Singleton.html b/doc/classes/OCC-Basics-Traits-Singleton.html index ffe7c8a..80c4648 100644 --- a/doc/classes/OCC-Basics-Traits-Singleton.html +++ b/doc/classes/OCC-Basics-Traits-Singleton.html @@ -142,8 +142,8 @@

Markers

-
-

Index

+
+

Indices

Files

@@ -536,17 +536,6 @@ as private to prevent direct instantiation of t

Search results

-
- -
-
diff --git a/doc/css/template.css b/doc/css/template.css index e0db992..6dd70bf 100644 --- a/doc/css/template.css +++ b/doc/css/template.css @@ -300,7 +300,7 @@ aside.phpdocumentor-sidebar } aside.phpdocumentor-sidebar - section.-index + section.-indices { order: 5; } diff --git a/doc/files/src-datastructures-strictcollection.html b/doc/files/src-datastructures-strictcollection.html index c25c737..c51b3db 100644 --- a/doc/files/src-datastructures-strictcollection.html +++ b/doc/files/src-datastructures-strictcollection.html @@ -142,8 +142,8 @@

Markers

-
-

Index

+
+

Indices

Files

@@ -321,17 +321,6 @@ along with this program. If not, see http

Search results

-
- -
-
diff --git a/doc/files/src-datastructures-strictlist.html b/doc/files/src-datastructures-strictlist.html index 3fcfa78..1018b28 100644 --- a/doc/files/src-datastructures-strictlist.html +++ b/doc/files/src-datastructures-strictlist.html @@ -142,8 +142,8 @@

Markers

-
-

Index

+
+

Indices

Files

@@ -321,17 +321,6 @@ along with this program. If not, see http

Search results

-
- -
-
diff --git a/doc/files/src-datastructures-strictqueue.html b/doc/files/src-datastructures-strictqueue.html index cfb48da..3957f9a 100644 --- a/doc/files/src-datastructures-strictqueue.html +++ b/doc/files/src-datastructures-strictqueue.html @@ -142,8 +142,8 @@

Markers

-
-

Index

+
+

Indices

Files

@@ -321,17 +321,6 @@ along with this program. If not, see http

Search results

-
- -
-
diff --git a/doc/files/src-datastructures-strictstack.html b/doc/files/src-datastructures-strictstack.html index d1efd44..cb3832b 100644 --- a/doc/files/src-datastructures-strictstack.html +++ b/doc/files/src-datastructures-strictstack.html @@ -142,8 +142,8 @@

Markers

-
-

Index

+
+

Indices

Files

@@ -321,17 +321,6 @@ along with this program. If not, see http

Search results

-
- -
-
diff --git a/doc/files/src-errorhandlers-throwerrorexception.html b/doc/files/src-errorhandlers-throwerrorexception.html index 37e25ff..90b53a9 100644 --- a/doc/files/src-errorhandlers-throwerrorexception.html +++ b/doc/files/src-errorhandlers-throwerrorexception.html @@ -142,8 +142,8 @@

Markers

-
-

Index

+
+

Indices

Files

@@ -321,17 +321,6 @@ along with this program. If not, see http

Search results

-
- -
-
diff --git a/doc/files/src-errorhandlers-triggerexceptionerror.html b/doc/files/src-errorhandlers-triggerexceptionerror.html index 827d923..0d586fc 100644 --- a/doc/files/src-errorhandlers-triggerexceptionerror.html +++ b/doc/files/src-errorhandlers-triggerexceptionerror.html @@ -142,8 +142,8 @@

Markers

-
-

Index

+
+

Indices

Files

@@ -321,17 +321,6 @@ along with this program. If not, see http

Search results

-
- -
-
diff --git a/doc/files/src-interfaces-arrayaccesstrait.html b/doc/files/src-interfaces-arrayaccesstrait.html index 53150b2..9ec30cd 100644 --- a/doc/files/src-interfaces-arrayaccesstrait.html +++ b/doc/files/src-interfaces-arrayaccesstrait.html @@ -142,8 +142,8 @@

Markers

-
-

Index

+
+

Indices

Files

@@ -321,17 +321,6 @@ along with this program. If not, see http

Search results

-
- -
-
diff --git a/doc/files/src-interfaces-countabletrait.html b/doc/files/src-interfaces-countabletrait.html index 681ee02..9308df4 100644 --- a/doc/files/src-interfaces-countabletrait.html +++ b/doc/files/src-interfaces-countabletrait.html @@ -142,8 +142,8 @@

Markers

-
-

Index

+
+

Indices

Files

@@ -321,17 +321,6 @@ along with this program. If not, see http

Search results

-
- -
-
diff --git a/doc/files/src-interfaces-iteratoraggregatetrait.html b/doc/files/src-interfaces-iteratoraggregatetrait.html index 67fefc7..d5e889d 100644 --- a/doc/files/src-interfaces-iteratoraggregatetrait.html +++ b/doc/files/src-interfaces-iteratoraggregatetrait.html @@ -142,8 +142,8 @@

Markers

-
-

Index

+
+

Indices

Files

@@ -321,17 +321,6 @@ along with this program. If not, see http

Search results

-
- -
-
diff --git a/doc/files/src-interfaces-iteratortrait.html b/doc/files/src-interfaces-iteratortrait.html index b834138..1a33a9f 100644 --- a/doc/files/src-interfaces-iteratortrait.html +++ b/doc/files/src-interfaces-iteratortrait.html @@ -142,8 +142,8 @@

Markers

-
-

Index

+
+

Indices

Files

@@ -321,17 +321,6 @@ along with this program. If not, see http

Search results

-
- -
-
diff --git a/doc/files/src-traits-getter.html b/doc/files/src-traits-getter.html index a345201..d9c2226 100644 --- a/doc/files/src-traits-getter.html +++ b/doc/files/src-traits-getter.html @@ -142,8 +142,8 @@

Markers

-
-

Index

+
+

Indices

Files

@@ -321,17 +321,6 @@ along with this program. If not, see http

Search results

-
- -
-
diff --git a/doc/files/src-traits-overloadinggetter.html b/doc/files/src-traits-overloadinggetter.html index 603e539..429c8e8 100644 --- a/doc/files/src-traits-overloadinggetter.html +++ b/doc/files/src-traits-overloadinggetter.html @@ -142,8 +142,8 @@

Markers

-
-

Index

+
+

Indices

Files

@@ -321,17 +321,6 @@ along with this program. If not, see http

Search results

-
- -
-
diff --git a/doc/files/src-traits-overloadingsetter.html b/doc/files/src-traits-overloadingsetter.html index 2f9f222..bb9a5c7 100644 --- a/doc/files/src-traits-overloadingsetter.html +++ b/doc/files/src-traits-overloadingsetter.html @@ -142,8 +142,8 @@

Markers

-
-

Index

+
+

Indices

Files

@@ -321,17 +321,6 @@ along with this program. If not, see http

Search results

-
- -
-
diff --git a/doc/files/src-traits-setter.html b/doc/files/src-traits-setter.html index 4e3fffe..58da7f8 100644 --- a/doc/files/src-traits-setter.html +++ b/doc/files/src-traits-setter.html @@ -142,8 +142,8 @@

Markers

-
-

Index

+
+

Indices

Files

@@ -321,17 +321,6 @@ along with this program. If not, see http

Search results

-
- -
-
diff --git a/doc/files/src-traits-singleton.html b/doc/files/src-traits-singleton.html index 4d0e07f..f053c3f 100644 --- a/doc/files/src-traits-singleton.html +++ b/doc/files/src-traits-singleton.html @@ -142,8 +142,8 @@

Markers

-
-

Index

+
+

Indices

Files

@@ -321,17 +321,6 @@ along with this program. If not, see http

Search results

-
- -
-
diff --git a/doc/files/src/DataStructures/StrictCollection.php.txt b/doc/files/src/DataStructures/StrictCollection.php.txt index 96726e5..d814faa 100644 --- a/doc/files/src/DataStructures/StrictCollection.php.txt +++ b/doc/files/src/DataStructures/StrictCollection.php.txt @@ -32,6 +32,34 @@ use OCC\Basics\Interfaces\CountableTrait; use OCC\Basics\Traits\Getter; use Serializable; +use function array_is_list; +use function array_map; +use function array_sum; +use function count; +use function function_exists; +use function get_debug_type; +use function is_a; +use function is_array; +use function is_bool; +use function is_callable; +use function is_countable; +use function is_double; +use function is_float; +use function is_int; +use function is_integer; +use function is_iterable; +use function is_long; +use function is_null; +use function is_numeric; +use function is_resource; +use function is_scalar; +use function is_string; +use function is_object; +use function ltrim; +use function serialize; +use function sprintf; +use function unserialize; + /** * A type-sensitive, unsorted collection. * diff --git a/doc/files/src/DataStructures/StrictList.php.txt b/doc/files/src/DataStructures/StrictList.php.txt index 5c3bd4c..db1ec77 100644 --- a/doc/files/src/DataStructures/StrictList.php.txt +++ b/doc/files/src/DataStructures/StrictList.php.txt @@ -34,6 +34,36 @@ use SplDoublyLinkedList; use OCC\Basics\Traits\Getter; use Serializable; +use function array_map; +use function array_sum; +use function count; +use function function_exists; +use function get_debug_type; +use function in_array; +use function is_a; +use function is_array; +use function is_bool; +use function is_callable; +use function is_countable; +use function is_double; +use function is_float; +use function is_int; +use function is_integer; +use function is_iterable; +use function is_long; +use function is_null; +use function is_numeric; +use function is_resource; +use function is_scalar; +use function is_string; +use function is_object; +use function iterator_to_array; +use function ltrim; +use function range; +use function serialize; +use function sprintf; +use function unserialize; + /** * A type-sensitive, taversable list. * diff --git a/doc/files/src/DataStructures/StrictQueue.php.txt b/doc/files/src/DataStructures/StrictQueue.php.txt index 90bbe00..f132fd7 100644 --- a/doc/files/src/DataStructures/StrictQueue.php.txt +++ b/doc/files/src/DataStructures/StrictQueue.php.txt @@ -31,6 +31,8 @@ use RangeException; use RuntimeException; use Serializable; +use function sprintf; + /** * A type-sensitive, taversable queue (FIFO). * diff --git a/doc/files/src/DataStructures/StrictStack.php.txt b/doc/files/src/DataStructures/StrictStack.php.txt index 00c355c..357897e 100644 --- a/doc/files/src/DataStructures/StrictStack.php.txt +++ b/doc/files/src/DataStructures/StrictStack.php.txt @@ -31,6 +31,8 @@ use RangeException; use RuntimeException; use Serializable; +use function sprintf; + /** * A type-sensitive, taversable stack (LIFO). * diff --git a/doc/files/src/ErrorHandlers/ThrowErrorException.php.txt b/doc/files/src/ErrorHandlers/ThrowErrorException.php.txt index f580b6b..f0ccd93 100644 --- a/doc/files/src/ErrorHandlers/ThrowErrorException.php.txt +++ b/doc/files/src/ErrorHandlers/ThrowErrorException.php.txt @@ -25,6 +25,8 @@ namespace OCC\Basics\ErrorHandlers; use ErrorException; +use function error_reporting; + /** * Throws internal errors as exceptions. * diff --git a/doc/files/src/ErrorHandlers/TriggerExceptionError.php.txt b/doc/files/src/ErrorHandlers/TriggerExceptionError.php.txt index 98d0f02..feddf1c 100644 --- a/doc/files/src/ErrorHandlers/TriggerExceptionError.php.txt +++ b/doc/files/src/ErrorHandlers/TriggerExceptionError.php.txt @@ -25,6 +25,9 @@ namespace OCC\Basics\ErrorHandlers; use Throwable; +use function sprintf; +use function trigger_error; + /** * Triggers errors for uncaught exceptions. * diff --git a/doc/files/src/Interfaces/ArrayAccessTrait.php.txt b/doc/files/src/Interfaces/ArrayAccessTrait.php.txt index 2cc109d..974da74 100644 --- a/doc/files/src/Interfaces/ArrayAccessTrait.php.txt +++ b/doc/files/src/Interfaces/ArrayAccessTrait.php.txt @@ -25,6 +25,8 @@ namespace OCC\Basics\Interfaces; use ArrayAccess; +use function is_null; + /** * A generic implementation of the ArrayAccess interface. * diff --git a/doc/files/src/Interfaces/CountableTrait.php.txt b/doc/files/src/Interfaces/CountableTrait.php.txt index 039a725..7e40b10 100644 --- a/doc/files/src/Interfaces/CountableTrait.php.txt +++ b/doc/files/src/Interfaces/CountableTrait.php.txt @@ -25,6 +25,8 @@ namespace OCC\Basics\Interfaces; use Countable; +use function count; + /** * A generic implementation of the Countable interface. * diff --git a/doc/files/src/Interfaces/IteratorTrait.php.txt b/doc/files/src/Interfaces/IteratorTrait.php.txt index f29c5ae..f222078 100644 --- a/doc/files/src/Interfaces/IteratorTrait.php.txt +++ b/doc/files/src/Interfaces/IteratorTrait.php.txt @@ -25,6 +25,13 @@ namespace OCC\Basics\Interfaces; use Iterator; +use function current; +use function is_null; +use function key; +use function next; +use function prev; +use function reset; + /** * A generic implementation of the Iterator interface. * diff --git a/doc/files/src/Traits/Getter.php.txt b/doc/files/src/Traits/Getter.php.txt index 68a5d21..5fb7559 100644 --- a/doc/files/src/Traits/Getter.php.txt +++ b/doc/files/src/Traits/Getter.php.txt @@ -25,6 +25,12 @@ namespace OCC\Basics\Traits; use InvalidArgumentException; +use function boolval; +use function method_exists; +use function property_exists; +use function sprintf; +use function ucfirst; + /** * Reads data from inaccessible properties by using magic methods. * diff --git a/doc/files/src/Traits/OverloadingGetter.php.txt b/doc/files/src/Traits/OverloadingGetter.php.txt index a1a858e..633df97 100644 --- a/doc/files/src/Traits/OverloadingGetter.php.txt +++ b/doc/files/src/Traits/OverloadingGetter.php.txt @@ -23,6 +23,8 @@ declare(strict_types=1); namespace OCC\Basics\Traits; +use function boolval; + /** * Overloads a class with readable magic properties. * diff --git a/doc/files/src/Traits/Setter.php.txt b/doc/files/src/Traits/Setter.php.txt index 77c8a99..6580164 100644 --- a/doc/files/src/Traits/Setter.php.txt +++ b/doc/files/src/Traits/Setter.php.txt @@ -25,6 +25,11 @@ namespace OCC\Basics\Traits; use InvalidArgumentException; +use function method_exists; +use function property_exists; +use function sprintf; +use function ucfirst; + /** * Writes data to inaccessible properties by using magic methods. * diff --git a/doc/graphs/classes.html b/doc/graphs/classes.html index 6d58ee9..ec4f91d 100644 --- a/doc/graphs/classes.html +++ b/doc/graphs/classes.html @@ -130,8 +130,8 @@

Markers

-
-

Index

+
+

Indices

Files

@@ -153,17 +153,6 @@

Search results

-
- -
-
diff --git a/doc/guides/changelog.html b/doc/guides/changelog.html index 02282b8..b2a7442 100644 --- a/doc/guides/changelog.html +++ b/doc/guides/changelog.html @@ -143,8 +143,8 @@

Markers

-
-

Index

+
+

Indices

Files

@@ -153,44 +153,31 @@

Changelog

- - - - +

v2.0.0

-

Breaking Changes:

    -
  • Raised minimum PHP version from 8.0 to 8.1
    • +
  • Raised minimum PHP version from 8.0 to 8.1 in order to use new features like +array_is_list() and the spread operator on string-keyed arrays
    • -
  • Renamed traits for Interfaces - and moved to different namespace
    • +

  • Interfaces + traits renamed and moved to different namespace

    OCC\Basics\InterfaceTraits\ArrayAccess       -> OCC\Basics\Interfaces\ArrayAccessTrait
+OCC\Basics\InterfaceTraits\Countable         -> OCC\Basics\Interfaces\CountableTrait
+OCC\Basics\InterfaceTraits\IteratorAggregate -> OCC\Basics\Interfaces\IteratorAggregateTrait
+OCC\Basics\InterfaceTraits\Iterator          -> OCC\Basics\Interfaces\IteratorTrait

  • Renamed internal methods for Getter and Setter to avoid -confusion with regular class method

    // old methods
-protected function magicGet{PascalCasePropertyName}(): mixed
-protected function magicSet{PascalCasePropertyName}(mixed $value): void
    // new methods
-protected function _magicGet{PascalCasePropertyName}(): mixed
-protected function _magicSet{PascalCasePropertyName}(mixed $value): void
    • +confusion with regular class methods

    // old methods
+function magicGet{PascalCasePropertyName}(): mixed
+function magicSet{PascalCasePropertyName}(mixed $value): void
    // new methods
+function _magicGet{PascalCasePropertyName}(): mixed
+function _magicSet{PascalCasePropertyName}(mixed $value): void
@@ -212,7 +199,7 @@ protected function _magicSet{PascalCasePropertyName}(mixed $value): void<
  • Extended API for all datastructures
    • -
  • Extended documentation
    • +
  • Extended documentation
    • @@ -221,7 +208,6 @@ protected function _magicSet{PascalCasePropertyName}(mixed $value): void<

    v1.1.0

    -

    Breaking Changes:

    @@ -239,7 +225,6 @@ public function __construct(array $allowedTypes = [])

    v1.0.1

    -

    New Features:

    @@ -254,7 +239,6 @@ public function __construct(array $allowedTypes = [])

    v1.0.0

    -

    Initial Release

    @@ -265,17 +249,6 @@ public function __construct(array $allowedTypes = [])

    Search results

    -
    - -
    -
    diff --git a/doc/guides/cheatsheet.html b/doc/guides/cheatsheet.html new file mode 100644 index 0000000..8fe127d --- /dev/null +++ b/doc/guides/cheatsheet.html @@ -0,0 +1,212 @@ + + + + + PHP Basics + + + + + + + + + + + + + + + + + + + + + + +
    +

    PHP Basics

    + + +
    + +
    + + + +
    + +
    +
    + + + + +
    +
    +

    Helpful Reminders

    + +
    +
    +

    Plain Box

    +
    +
    + +
    + +
    +

    Exclamation Mark

    +
    +
    + +
    + +
    +

    Lifebuoy

    +
    +
    + +
    + +
    +

    Speech Bubble

    +
    +
    + + 
    // Code Block
    +
      +
      + +
      +
      +
      +
      +

      Search results

      + +
      +
      +
        +
        +
        +
        +
        + + +
        + + + + + + + + diff --git a/doc/guides/index.html b/doc/guides/index.html index bcfdda8..fb669ee 100644 --- a/doc/guides/index.html +++ b/doc/guides/index.html @@ -144,8 +144,8 @@

        Markers

        -
        -

        Index

        +
        +

        Indices

        Files

        @@ -162,17 +162,6 @@

        Search results

        -
        - -
        -
        diff --git a/doc/guides/overview/index.html b/doc/guides/overview/index.html index 58ea944..31beab0 100644 --- a/doc/guides/overview/index.html +++ b/doc/guides/overview/index.html @@ -143,8 +143,8 @@

        Markers

        -
        -

        Index

        +
        +

        Indices

        Files

        @@ -160,17 +160,6 @@

        Search results

        -
        - -
        -
        diff --git a/doc/guides/usage/index.html b/doc/guides/usage/index.html index d032033..f101f71 100644 --- a/doc/guides/usage/index.html +++ b/doc/guides/usage/index.html @@ -143,8 +143,8 @@

        Markers

        -
        -

        Index

        +
        +

        Indices

        Files

        @@ -155,9 +155,21 @@
        @@ -169,17 +181,6 @@

        Search results

        -
        - -
        -
        diff --git a/doc/guides/usage/installation.html b/doc/guides/usage/installation.html index 50a4175..76c321e 100644 --- a/doc/guides/usage/installation.html +++ b/doc/guides/usage/installation.html @@ -143,8 +143,8 @@

        Markers

        -
        -

        Index

        +
        +

        Indices

        Files

        @@ -153,7 +153,46 @@

        Installation

        - 
        composer require opencultureconsulting/basics
        +
        +

        Composer

        + +

        The intended and recommended way of re-using this package is via Composer. The following +command will get you the latest version and make it a dependency of your project. It will also register all classes and +traits with the autoloader to make them available inside the application.

        + 
        # This will install the latest stable version suitable for your project
+composer require "opencultureconsulting/basics"
        +

        If you want to use a specific version other than the latest available for your environment, you can do so by appending +the desired version constraint:

        + 
        # This will install the latest patch level version of 2.0 (i. e. >=2.0.0 && <2.1.0)
+composer require "opencultureconsulting/basics:~2.0"
        +

        All available versions as well as further information about Requirements + and dependencies can be found on +Packagist.

        +
        + +
        +

        Git

        + +

        Alternatively, you can fetch the files from GitHub and add +them to your project manually. The best way is by cloning the repository, because then you can easily update to a newer +version by just pulling the changes and checking out a different version tag.

        + 
        # This will clone the repository into the "basics" directory
+git clone https://github.com/opencultureconsulting/php-basics.git basics
        +

        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.0.0" into the "basics" directory
+git clone --branch=v2.0.0 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.

        +
        + +
        +

        Download

        + +

        As a last resort you can also just download the files. You can find all available versions as well as the current +development state on the GitHub release page.

        +
        +
        @@ -161,17 +200,6 @@

        Search results

        -
        - -
        -
        diff --git a/doc/guides/usage/requirements.html b/doc/guides/usage/requirements.html index cdb3e55..b084828 100644 --- a/doc/guides/usage/requirements.html +++ b/doc/guides/usage/requirements.html @@ -143,8 +143,8 @@

        Markers

        -
        -

        Index

        +
        +

        Indices

        Files

        @@ -153,8 +153,21 @@

        Requirements

        -

        PHP 8.1 -Composer 2

        +
        +

        Environment

        + +

        This package requires at least PHP 8.1.

        +

        It is highly recommended to use Composer for dependency management and autoloading, +although it is technically not strictly required for re-using any of these classes and traits. But it certainly +makes it a lot easier!

        +
        + +
        +

        Dependencies

        + +

        This package does not have any external dependencies.

        +
        +
        @@ -162,17 +175,6 @@ Composer 2

        Search results

        -
        - -
        -
        diff --git a/doc/index.html b/doc/index.html index acaf16f..16568bb 100644 --- a/doc/index.html +++ b/doc/index.html @@ -142,8 +142,8 @@

        Markers

        -
        -

        Index

        +
        +

        Indices

        Files

        @@ -202,17 +202,6 @@

        Search results

        -
        - -
        -
        diff --git a/doc/indices/files.html b/doc/indices/files.html index 387a731..3fb0b07 100644 --- a/doc/indices/files.html +++ b/doc/indices/files.html @@ -142,8 +142,8 @@

        Markers

        -
        -

        Index

        +
        +

        Indices

        Files

        @@ -194,17 +194,6 @@

        Search results

        -
        - -
        -
        diff --git a/doc/namespaces/default.html b/doc/namespaces/default.html index c791d63..7e1c2ad 100644 --- a/doc/namespaces/default.html +++ b/doc/namespaces/default.html @@ -142,8 +142,8 @@

        Markers

        -
        -

        Index

        +
        +

        Indices

        Files

        @@ -301,17 +301,6 @@

        Search results

        -
        - -
        -
        diff --git a/doc/namespaces/occ-basics-datastructures.html b/doc/namespaces/occ-basics-datastructures.html index d0e17e4..07c5e8f 100644 --- a/doc/namespaces/occ-basics-datastructures.html +++ b/doc/namespaces/occ-basics-datastructures.html @@ -142,8 +142,8 @@

        Markers

        -
        -

        Index

        +
        +

        Indices

        Files

        @@ -303,17 +303,6 @@

        Search results

        -
        - -
        -
        diff --git a/doc/namespaces/occ-basics-errorhandlers.html b/doc/namespaces/occ-basics-errorhandlers.html index cb3f786..dca3451 100644 --- a/doc/namespaces/occ-basics-errorhandlers.html +++ b/doc/namespaces/occ-basics-errorhandlers.html @@ -142,8 +142,8 @@

        Markers

        -
        -

        Index

        +
        +

        Indices

        Files

        @@ -303,17 +303,6 @@

        Search results

        -
        - -
        -
        diff --git a/doc/namespaces/occ-basics-interfaces.html b/doc/namespaces/occ-basics-interfaces.html index 3bb62fe..16acbf2 100644 --- a/doc/namespaces/occ-basics-interfaces.html +++ b/doc/namespaces/occ-basics-interfaces.html @@ -142,8 +142,8 @@

        Markers

        -
        -

        Index

        +
        +

        Indices

        Files

        @@ -303,17 +303,6 @@

        Search results

        -
        - -
        -
        diff --git a/doc/namespaces/occ-basics-traits.html b/doc/namespaces/occ-basics-traits.html index 0382a25..e15f93a 100644 --- a/doc/namespaces/occ-basics-traits.html +++ b/doc/namespaces/occ-basics-traits.html @@ -142,8 +142,8 @@

        Markers

        -
        -

        Index

        +
        +

        Indices

        Files

        @@ -303,17 +303,6 @@

        Search results

        -
        - -
        -
        diff --git a/doc/namespaces/occ-basics.html b/doc/namespaces/occ-basics.html index 5e867b3..5694a09 100644 --- a/doc/namespaces/occ-basics.html +++ b/doc/namespaces/occ-basics.html @@ -142,8 +142,8 @@

        Markers

        -
        -

        Index

        +
        +

        Indices

        Files

        @@ -305,17 +305,6 @@

        Search results

        -
        - -
        -
        diff --git a/doc/namespaces/occ.html b/doc/namespaces/occ.html index 9cb0435..9ce3c48 100644 --- a/doc/namespaces/occ.html +++ b/doc/namespaces/occ.html @@ -142,8 +142,8 @@

        Markers

        -
        -

        Index

        +
        +

        Indices

        Files

        @@ -301,17 +301,6 @@

        Search results

        -
        - -
        -
        diff --git a/doc/packages/Basics-DataStructures.html b/doc/packages/Basics-DataStructures.html index 8b06e67..11e8cfc 100644 --- a/doc/packages/Basics-DataStructures.html +++ b/doc/packages/Basics-DataStructures.html @@ -142,8 +142,8 @@

        Markers

        -
        -

        Index

        +
        +

        Indices

        Files

        @@ -302,17 +302,6 @@

        Search results

        -
        - -
        -
        diff --git a/doc/packages/Basics-ErrorHandlers.html b/doc/packages/Basics-ErrorHandlers.html index fea8417..f2c9cf4 100644 --- a/doc/packages/Basics-ErrorHandlers.html +++ b/doc/packages/Basics-ErrorHandlers.html @@ -142,8 +142,8 @@

        Markers

        -
        -

        Index

        +
        +

        Indices

        Files

        @@ -302,17 +302,6 @@

        Search results

        -
        - -
        -
        diff --git a/doc/packages/Basics-Interfaces.html b/doc/packages/Basics-Interfaces.html index 624a83f..d27f811 100644 --- a/doc/packages/Basics-Interfaces.html +++ b/doc/packages/Basics-Interfaces.html @@ -142,8 +142,8 @@

        Markers

        -
        -

        Index

        +
        +

        Indices

        Files

        @@ -302,17 +302,6 @@

        Search results

        -
        - -
        -
        diff --git a/doc/packages/Basics-Traits.html b/doc/packages/Basics-Traits.html index a0f0701..ffb5b6d 100644 --- a/doc/packages/Basics-Traits.html +++ b/doc/packages/Basics-Traits.html @@ -142,8 +142,8 @@

        Markers

        -
        -

        Index

        +
        +

        Indices

        Files

        @@ -302,17 +302,6 @@

        Search results

        -
        - -
        -
        diff --git a/doc/packages/Basics.html b/doc/packages/Basics.html index 45b3d29..34b853b 100644 --- a/doc/packages/Basics.html +++ b/doc/packages/Basics.html @@ -142,8 +142,8 @@

        Markers

        -
        -

        Index

        +
        +

        Indices

        Files

        @@ -304,17 +304,6 @@

        Search results

        -
        - -
        -
        diff --git a/doc/packages/default.html b/doc/packages/default.html index 2ee297c..c36deb0 100644 --- a/doc/packages/default.html +++ b/doc/packages/default.html @@ -142,8 +142,8 @@

        Markers

        -
        -

        Index

        +
        +

        Indices

        Files

        @@ -301,17 +301,6 @@

        Search results

        -
        - -
        -
        diff --git a/doc/reports/deprecated.html b/doc/reports/deprecated.html index dce70ec..cd152be 100644 --- a/doc/reports/deprecated.html +++ b/doc/reports/deprecated.html @@ -143,8 +143,8 @@

        Markers

        -
        -

        Index

        +
        +

        Indices

        Files

        @@ -169,17 +169,6 @@

        Search results

        -
        - -
        -
        diff --git a/doc/reports/errors.html b/doc/reports/errors.html index 4dd0a28..beef8c4 100644 --- a/doc/reports/errors.html +++ b/doc/reports/errors.html @@ -143,8 +143,8 @@

        Markers

        -
        -

        Index

        +
        +

        Indices

        Files

        @@ -168,17 +168,6 @@

        Search results

        -
        - -
        -
        diff --git a/doc/reports/markers.html b/doc/reports/markers.html index d9b2760..aa4fa05 100644 --- a/doc/reports/markers.html +++ b/doc/reports/markers.html @@ -143,8 +143,8 @@

        Markers

        -
        -

        Index

        +
        +

        Indices

        Files

        @@ -169,17 +169,6 @@

        Search results

        -
        - -
        -