From bbf9e64ddcff75aa6d404d9342f6ecf0ede5ac74 Mon Sep 17 00:00:00 2001 From: Sebastian Meyer Date: Sun, 28 Jan 2024 17:30:20 +0100 Subject: [PATCH] Initial documentation upload --- .github/workflows/pages.yml | 37 + .phpdoc/guide/index.rst | 11 + .phpdoc/guide/installation/index.rst | 7 + .phpdoc/guide/installation/test.rst | 14 + .../OCC-Basics-DataStructures-StrictList.html | 1580 +++++++++++++++ ...OCC-Basics-DataStructures-StrictQueue.html | 1712 +++++++++++++++++ ...OCC-Basics-DataStructures-StrictStack.html | 1712 +++++++++++++++++ ...ics-ErrorHandlers-ThrowErrorException.html | 499 +++++ ...s-ErrorHandlers-TriggerExceptionError.html | 449 +++++ ...sics-InterfaceTraits-ArrayAccessTrait.html | 711 +++++++ ...Basics-InterfaceTraits-CountableTrait.html | 517 +++++ ...nterfaceTraits-IteratorAggregateTrait.html | 517 +++++ ...-Basics-InterfaceTraits-IteratorTrait.html | 748 +++++++ docs/classes/OCC-Basics-Traits-Getter.html | 356 ++++ docs/classes/OCC-Basics-Traits-Setter.html | 356 ++++ docs/classes/OCC-Basics-Traits-Singleton.html | 482 +++++ docs/css/base.css | 1231 ++++++++++++ docs/css/normalize.css | 427 ++++ docs/css/template.css | 271 +++ docs/files/src-datastructures-strictlist.html | 347 ++++ .../files/src-datastructures-strictqueue.html | 347 ++++ .../files/src-datastructures-strictstack.html | 347 ++++ ...src-errorhandlers-throwerrorexception.html | 347 ++++ ...c-errorhandlers-triggerexceptionerror.html | 347 ++++ .../src-interfacetraits-arrayaccesstrait.html | 347 ++++ .../src-interfacetraits-countabletrait.html | 347 ++++ ...nterfacetraits-iteratoraggregatetrait.html | 347 ++++ .../src-interfacetraits-iteratortrait.html | 347 ++++ docs/files/src-traits-getter.html | 347 ++++ docs/files/src-traits-setter.html | 347 ++++ docs/files/src-traits-singleton.html | 347 ++++ .../src/DataStructures/StrictList.php.txt | 497 +++++ .../src/DataStructures/StrictQueue.php.txt | 143 ++ .../src/DataStructures/StrictStack.php.txt | 143 ++ .../ErrorHandlers/ThrowErrorException.php.txt | 63 + .../TriggerExceptionError.php.txt | 58 + .../InterfaceTraits/ArrayAccessTrait.php.txt | 111 ++ .../InterfaceTraits/CountableTrait.php.txt | 62 + .../IteratorAggregateTrait.php.txt | 63 + .../src/InterfaceTraits/IteratorTrait.php.txt | 122 ++ docs/files/src/Traits/Getter.php.txt | 86 + docs/files/src/Traits/Setter.php.txt | 85 + docs/files/src/Traits/Singleton.php.txt | 84 + docs/graphs/classes.html | 179 ++ docs/guides/index.html | 156 ++ docs/guides/installation/index.html | 167 ++ docs/guides/installation/test.html | 174 ++ docs/index.html | 222 +++ docs/indices/files.html | 214 +++ docs/js/search.js | 173 ++ docs/js/searchIndex.js | 319 +++ docs/js/template.js | 17 + docs/namespaces/default.html | 327 ++++ .../namespaces/occ-basics-datastructures.html | 329 ++++ docs/namespaces/occ-basics-errorhandlers.html | 329 ++++ .../occ-basics-interfacetraits.html | 329 ++++ docs/namespaces/occ-basics-traits.html | 329 ++++ docs/namespaces/occ-basics.html | 331 ++++ docs/namespaces/occ.html | 327 ++++ docs/packages/Basics-DataStructures.html | 328 ++++ docs/packages/Basics-ErrorHandlers.html | 328 ++++ docs/packages/Basics-InterfaceTraits.html | 328 ++++ docs/packages/Basics-Traits.html | 328 ++++ docs/packages/Basics.html | 330 ++++ docs/packages/default.html | 327 ++++ docs/reports/deprecated.html | 195 ++ docs/reports/errors.html | 194 ++ docs/reports/markers.html | 195 ++ phpdoc.dist.xml | 2 +- 69 files changed, 23794 insertions(+), 1 deletion(-) create mode 100644 .github/workflows/pages.yml create mode 100644 .phpdoc/guide/installation/index.rst create mode 100644 .phpdoc/guide/installation/test.rst create mode 100644 docs/classes/OCC-Basics-DataStructures-StrictList.html create mode 100644 docs/classes/OCC-Basics-DataStructures-StrictQueue.html create mode 100644 docs/classes/OCC-Basics-DataStructures-StrictStack.html create mode 100644 docs/classes/OCC-Basics-ErrorHandlers-ThrowErrorException.html create mode 100644 docs/classes/OCC-Basics-ErrorHandlers-TriggerExceptionError.html create mode 100644 docs/classes/OCC-Basics-InterfaceTraits-ArrayAccessTrait.html create mode 100644 docs/classes/OCC-Basics-InterfaceTraits-CountableTrait.html create mode 100644 docs/classes/OCC-Basics-InterfaceTraits-IteratorAggregateTrait.html create mode 100644 docs/classes/OCC-Basics-InterfaceTraits-IteratorTrait.html create mode 100644 docs/classes/OCC-Basics-Traits-Getter.html create mode 100644 docs/classes/OCC-Basics-Traits-Setter.html create mode 100644 docs/classes/OCC-Basics-Traits-Singleton.html create mode 100644 docs/css/base.css create mode 100644 docs/css/normalize.css create mode 100644 docs/css/template.css create mode 100644 docs/files/src-datastructures-strictlist.html create mode 100644 docs/files/src-datastructures-strictqueue.html create mode 100644 docs/files/src-datastructures-strictstack.html create mode 100644 docs/files/src-errorhandlers-throwerrorexception.html create mode 100644 docs/files/src-errorhandlers-triggerexceptionerror.html create mode 100644 docs/files/src-interfacetraits-arrayaccesstrait.html create mode 100644 docs/files/src-interfacetraits-countabletrait.html create mode 100644 docs/files/src-interfacetraits-iteratoraggregatetrait.html create mode 100644 docs/files/src-interfacetraits-iteratortrait.html create mode 100644 docs/files/src-traits-getter.html create mode 100644 docs/files/src-traits-setter.html create mode 100644 docs/files/src-traits-singleton.html create mode 100644 docs/files/src/DataStructures/StrictList.php.txt create mode 100644 docs/files/src/DataStructures/StrictQueue.php.txt create mode 100644 docs/files/src/DataStructures/StrictStack.php.txt create mode 100644 docs/files/src/ErrorHandlers/ThrowErrorException.php.txt create mode 100644 docs/files/src/ErrorHandlers/TriggerExceptionError.php.txt create mode 100644 docs/files/src/InterfaceTraits/ArrayAccessTrait.php.txt create mode 100644 docs/files/src/InterfaceTraits/CountableTrait.php.txt create mode 100644 docs/files/src/InterfaceTraits/IteratorAggregateTrait.php.txt create mode 100644 docs/files/src/InterfaceTraits/IteratorTrait.php.txt create mode 100644 docs/files/src/Traits/Getter.php.txt create mode 100644 docs/files/src/Traits/Setter.php.txt create mode 100644 docs/files/src/Traits/Singleton.php.txt create mode 100644 docs/graphs/classes.html create mode 100644 docs/guides/index.html create mode 100644 docs/guides/installation/index.html create mode 100644 docs/guides/installation/test.html create mode 100644 docs/index.html create mode 100644 docs/indices/files.html create mode 100644 docs/js/search.js create mode 100644 docs/js/searchIndex.js create mode 100644 docs/js/template.js create mode 100644 docs/namespaces/default.html create mode 100644 docs/namespaces/occ-basics-datastructures.html create mode 100644 docs/namespaces/occ-basics-errorhandlers.html create mode 100644 docs/namespaces/occ-basics-interfacetraits.html create mode 100644 docs/namespaces/occ-basics-traits.html create mode 100644 docs/namespaces/occ-basics.html create mode 100644 docs/namespaces/occ.html create mode 100644 docs/packages/Basics-DataStructures.html create mode 100644 docs/packages/Basics-ErrorHandlers.html create mode 100644 docs/packages/Basics-InterfaceTraits.html create mode 100644 docs/packages/Basics-Traits.html create mode 100644 docs/packages/Basics.html create mode 100644 docs/packages/default.html create mode 100644 docs/reports/deprecated.html create mode 100644 docs/reports/errors.html create mode 100644 docs/reports/markers.html diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml new file mode 100644 index 0000000..eda4fa6 --- /dev/null +++ b/.github/workflows/pages.yml @@ -0,0 +1,37 @@ +name: Deploy Documentation +on: + push: + branches: [ "main" ] + +permissions: + contents: read + pages: write + id-token: write + +concurrency: + group: "pages" + cancel-in-progress: false + +jobs: + GitHubPages: + name: GitHub Pages + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Setup Pages + uses: actions/configure-pages@v4 + + - name: Upload Artifact + uses: actions/upload-pages-artifact@v3 + with: + path: 'docs/' + + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 diff --git a/.phpdoc/guide/index.rst b/.phpdoc/guide/index.rst index e69de29..7d339b5 100644 --- a/.phpdoc/guide/index.rst +++ b/.phpdoc/guide/index.rst @@ -0,0 +1,11 @@ +Documentation +############# + +.. meta:: + :layout: landingpage + +.. toctree:: + :hidden: + :titlesonly: + + installation/index diff --git a/.phpdoc/guide/installation/index.rst b/.phpdoc/guide/installation/index.rst new file mode 100644 index 0000000..c514700 --- /dev/null +++ b/.phpdoc/guide/installation/index.rst @@ -0,0 +1,7 @@ +Installation +############ + +.. toctree:: + :maxdepth: 3 + + test diff --git a/.phpdoc/guide/installation/test.rst b/.phpdoc/guide/installation/test.rst new file mode 100644 index 0000000..e217a02 --- /dev/null +++ b/.phpdoc/guide/installation/test.rst @@ -0,0 +1,14 @@ +Test +#### + +Heading 1 +========= + +Heading 2 +--------- + +Heading 3 +^^^^^^^^^ + +Heading 4 +""""""""" diff --git a/docs/classes/OCC-Basics-DataStructures-StrictList.html b/docs/classes/OCC-Basics-DataStructures-StrictList.html new file mode 100644 index 0000000..caffe33 --- /dev/null +++ b/docs/classes/OCC-Basics-DataStructures-StrictList.html @@ -0,0 +1,1580 @@ + + + + + PHP Basics + + + + + + + + + + + + + + + + + + + + + +
+

PHP Basics

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

+ StrictList + + + extends SplDoublyLinkedList + + +
+ in package + +
+ + + implements + ArrayAccess, Countable, Iterator, Serializable + + + Uses + Getter +

+ +
+ + +
+ + + +

A type-sensitive, taversable list.

+ +

Extends \SplDoublyLinkedList with +an option to specify the allowed data types for list values.

+
+ + +
+ Tags + + +
+
+
+ author +
+
+ +

Sebastian Meyer sebastian.meyer@opencultureconsulting.com

+
+ +
+
+ template +
+
+ +

AllowedType of mixed

+
+ +
+
+ + + +

+ Table of Contents + + +

+ + + +

+ Interfaces + + +

+
+
ArrayAccess
Countable
Iterator
Serializable
+ + + + + + +

+ Properties + + +

+
+
+ $allowedTypes + +  : array<string|int, string> +
+ +
+ +

+ Methods + + +

+
+
+ __construct() + +  : void +
+
Create a type-sensitive, traversable list of values.
+ +
+ add() + +  : void +
+
Add/insert a new value at the specified offset.
+ +
+ append() + +  : void +
+
Append values at the end of the list.
+ +
+ bottom() + +  : AllowedType +
+
Peek at the value at the beginning of the list.
+ +
+ getAllowedTypes() + +  : array<string|int, string> +
+
Get allowed data types for list values.
+ +
+ getIteratorMode() + +  : int +
+
Get the mode of iteration.
+ +
+ isAllowedType() + +  : bool +
+
Check if the value's data type is allowed on the list.
+ +
+ offsetSet() + +  : void +
+
Set the value at the specified offset.
+ +
+ pop() + +  : AllowedType +
+
Pops an value from the end of the list.
+ +
+ prepend() + +  : void +
+
Prepend values at the start of the list.
+ +
+ push() + +  : void +
+
Push an value at the end of the list.
+ +
+ setIteratorMode() + +  : int +
+
Set the mode of iteration.
+ +
+ shift() + +  : AllowedType +
+
Shift an value from the beginning of the list.
+ +
+ top() + +  : AllowedType +
+
Peek at the value at the end of the list.
+ +
+ unshift() + +  : void +
+
Prepend the list with an value.
+ +
+ setAllowedTypes() + +  : void +
+
Set allowed data types of list values.
+ +
+ + + + + + + +
+

+ Properties + + +

+
+

+ $allowedTypes + + + + read-only +

+ + + + + public + array<string|int, string> + $allowedTypes + + +

The allowed data types for values.

+
+ + + + +
+
+ +
+

+ Methods + + +

+
+

+ __construct() + + +

+ + +

Create a type-sensitive, traversable list of values.

+ + + public + __construct([array<string|int, string> $allowedTypes = [] ]) : void + +
+
+ +
Parameters
+
+
+ $allowedTypes + : array<string|int, string> + = []
+
+

Allowed data types of values (optional)

+

If empty, all types are allowed. +Possible values are:

+
    +
  • "array"
  • +
  • "bool"
  • +
  • "callable"
  • +
  • "countable"
  • +
  • "float" or "double"
  • +
  • "int" or "integer" or "long"
  • +
  • "iterable"
  • +
  • "null"
  • +
  • "numeric"
  • +
  • "object" or FQCN
  • +
  • "resource"
  • +
  • "scalar"
  • +
  • "string"
  • +
+
+ +
+
+ + +
+ Tags + + +
+
+
+ throws +
+
+ InvalidArgumentException + + +
+
+ + +
+
+

+ add() + + +

+ + +

Add/insert a new value at the specified offset.

+ + + public + add(int $offset, AllowedType $value) : void + +
+
APIYes
+ +
+ +
Parameters
+
+
+ $offset + : int +
+
+

The offset where the new value is to be inserted

+
+ +
+
+ $value + : AllowedType +
+
+

The new value for the offset

+
+ +
+
+ + +
+ Tags + + +
+
+
+ throws +
+
+ InvalidArgumentException + + +
+
+ + +
+
+

+ append() + + +

+ + +

Append values at the end of the list.

+ + + public + append(AllowedType ...$values) : void + +
+
APIYes
+ +
+ +
Parameters
+
+
+ $values + : AllowedType +
+
+

One or more values to append

+
+ +
+
+ + +
+ Tags + + +
+
+
+ throws +
+
+ InvalidArgumentException + + +
+
+ + +
+
+

+ bottom() + + +

+ + +

Peek at the value at the beginning of the list.

+ + + public + bottom() : AllowedType + +
+
APIYes
+ +
+ + + +
+ Tags + + +
+
+
+ throws +
+
+ RuntimeException + + +
+
+ +
+
Return values
+ AllowedType + — +

The first value of the list

+
+ +
+ +
+
+

+ getAllowedTypes() + + +

+ + +

Get allowed data types for list values.

+ + + public + getAllowedTypes() : array<string|int, string> + +
+
APIYes
+ +
+ + + + +
+
Return values
+ array<string|int, string> + — +

The list of allowed data types

+
+ +
+ +
+
+

+ getIteratorMode() + + +

+ + +

Get the mode of iteration.

+ + + public + getIteratorMode() : int + +
+
APIYes
+ +
+ + + + +
+
Return values
+ int + — +

The set of flags and modes of iteration

+
+ +
+ +
+
+

+ isAllowedType() + + +

+ + +

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

+ + + public + isAllowedType(AllowedType $value) : bool + +
+
APIYes
+ +
+ +
Parameters
+
+
+ $value + : AllowedType +
+
+

The value to check

+
+ +
+
+ + + +
+
Return values
+ bool + — +

Whether the value's data type is allowed

+
+ +
+ +
+
+

+ offsetSet() + + +

+ + +

Set the value at the specified offset.

+ + + public + offsetSet(int|null $offset, AllowedType $value) : void + +
+
APIYes
+ +
+ +
Parameters
+
+
+ $offset + : int|null +
+
+

The offset being set or NULL to append

+
+ +
+
+ $value + : AllowedType +
+
+

The new value for the offset

+
+ +
+
+ + +
+ Tags + + +
+
+
+ throws +
+
+ InvalidArgumentException + + +
+
+ + +
+
+

+ pop() + + +

+ + +

Pops an value from the end of the list.

+ + + public + pop() : AllowedType + +
+
APIYes
+ +
+ + + +
+ Tags + + +
+
+
+ throws +
+
+ RuntimeException + + +
+
+ +
+
Return values
+ AllowedType + — +

The value from the end of the list

+
+ +
+ +
+
+

+ prepend() + + +

+ + +

Prepend values at the start of the list.

+ + + public + prepend(AllowedType ...$values) : void + +
+
APIYes
+ +
+ +
Parameters
+
+
+ $values + : AllowedType +
+
+

One or more values to prepend

+
+ +
+
+ + +
+ Tags + + +
+
+
+ throws +
+
+ InvalidArgumentException + + +
+
+ + +
+
+

+ push() + + +

+ + +

Push an value at the end of the list.

+ + + public + push(AllowedType $value) : void + +
+
APIYes
+ +
+ +
Parameters
+
+
+ $value + : AllowedType +
+
+

The value to push

+
+ +
+
+ + +
+ Tags + + +
+
+
+ throws +
+
+ InvalidArgumentException + + +
+
+ + +
+
+

+ setIteratorMode() + + +

+ + +

Set the mode of iteration.

+ + + public + setIteratorMode(int $mode) : int + +
+
APIYes
+ +
+ +
Parameters
+
+
+ $mode + : int +
+
+

The new iterator mode (0, 1, 2 or 3)

+

There are two orthogonal sets of modes that can be set.

+

The direction of iteration (either one or the other):

+
    +
  • StrictList::IT_MODE_FIFO (queue style)
  • +
  • StrictList::IT_MODE_LIFO (stack style)
  • +
+

The behavior of the iterator (either one or the other):

+
    +
  • StrictList::IT_MODE_DELETE (delete items)
  • +
  • StrictList::IT_MODE_KEEP (keep items)
  • +
+

The default mode is: IT_MODE_FIFO | IT_MODE_KEEP

+
+ +
+
+ + + +
+
Return values
+ int + — +

The set of flags and modes of iteration

+
+ +
+ +
+
+

+ shift() + + +

+ + +

Shift an value from the beginning of the list.

+ + + public + shift() : AllowedType + +
+
APIYes
+ +
+ + + +
+ Tags + + +
+
+
+ throws +
+
+ RuntimeException + + +
+
+ +
+
Return values
+ AllowedType + — +

The first value of the list

+
+ +
+ +
+
+

+ top() + + +

+ + +

Peek at the value at the end of the list.

+ + + public + top() : AllowedType + +
+
APIYes
+ +
+ + + +
+ Tags + + +
+
+
+ throws +
+
+ RuntimeException + + +
+
+ +
+
Return values
+ AllowedType + — +

The last value of the list

+
+ +
+ +
+
+

+ unshift() + + +

+ + +

Prepend the list with an value.

+ + + public + unshift(AllowedType $value) : void + +
+
APIYes
+ +
+ +
Parameters
+
+
+ $value + : AllowedType +
+
+

The value to unshift

+
+ +
+
+ + +
+ Tags + + +
+
+
+ throws +
+
+ InvalidArgumentException + + +
+
+ + +
+
+

+ setAllowedTypes() + + +

+ + +

Set allowed data types of list values.

+ + + protected + setAllowedTypes([array<string|int, string> $allowedTypes = [] ]) : void + +
+
+ +
Parameters
+
+
+ $allowedTypes + : array<string|int, string> + = []
+
+

Allowed data types of values

+
+ +
+
+ + +
+ Tags + + +
+
+
+ throws +
+
+ InvalidArgumentException + + +
+
+ + +
+
+ +
+
+
+
+

+        
+ +
+
+ + + +
+
+
+ +
+ On this page + + +
+ +
+
+
+
+
+

Search results

+ +
+
+
    +
    +
    +
    +
    + + +
    + + + + + + + + diff --git a/docs/classes/OCC-Basics-DataStructures-StrictQueue.html b/docs/classes/OCC-Basics-DataStructures-StrictQueue.html new file mode 100644 index 0000000..0cc5769 --- /dev/null +++ b/docs/classes/OCC-Basics-DataStructures-StrictQueue.html @@ -0,0 +1,1712 @@ + + + + + PHP Basics + + + + + + + + + + + + + + + + + + + + + +
    +

    PHP Basics

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

    + StrictQueue + + + extends StrictList + + +
    + in package + +
    + + + implements + ArrayAccess, Countable, Iterator, Serializable + +

    + +
    + + +
    + + + +

    A type-sensitive, taversable First In, First Out queue (FIFO).

    + +

    Extends \SplQueue with an option to specify +the allowed data types for list items.

    +
    + + +
    + Tags + + +
    +
    +
    + author +
    +
    + +

    Sebastian Meyer sebastian.meyer@opencultureconsulting.com

    +
    + +
    +
    + template +
    +
    + +

    AllowedType of mixed

    +
    + +
    +
    + + + +

    + Table of Contents + + +

    + + + +

    + Interfaces + + +

    +
    +
    ArrayAccess
    Countable
    Iterator
    Serializable
    + + + + + + +

    + Properties + + +

    +
    +
    + $allowedTypes + +  : array<string|int, string> +
    + +
    + +

    + Methods + + +

    +
    +
    + __construct() + +  : void +
    +
    Create a type-sensitive, traversable queue of items.
    + +
    + add() + +  : void +
    +
    Add/insert a new value at the specified offset.
    + +
    + append() + +  : void +
    +
    Append values at the end of the list.
    + +
    + bottom() + +  : AllowedType +
    +
    Peek at the value at the beginning of the list.
    + +
    + dequeue() + +  : AllowedType +
    +
    Dequeue an item from the queue.
    + +
    + enqueue() + +  : void +
    +
    Add an item to the queue.
    + +
    + getAllowedTypes() + +  : array<string|int, string> +
    +
    Get allowed data types for list values.
    + +
    + getIteratorMode() + +  : int +
    +
    Get the mode of iteration.
    + +
    + isAllowedType() + +  : bool +
    +
    Check if the value's data type is allowed on the list.
    + +
    + offsetSet() + +  : void +
    +
    Set the value at the specified offset.
    + +
    + pop() + +  : AllowedType +
    +
    Pops an value from the end of the list.
    + +
    + prepend() + +  : void +
    +
    Prepend values at the start of the list.
    + +
    + push() + +  : void +
    +
    Push an value at the end of the list.
    + +
    + setIteratorMode() + +  : int +
    +
    Set the mode of iteration.
    + +
    + shift() + +  : AllowedType +
    +
    Shift an value from the beginning of the list.
    + +
    + top() + +  : AllowedType +
    +
    Peek at the value at the end of the list.
    + +
    + unshift() + +  : void +
    +
    Prepend the list with an value.
    + +
    + setAllowedTypes() + +  : void +
    +
    Set allowed data types of list values.
    + +
    + + + + + + + +
    +

    + Properties + + +

    +
    +

    + $allowedTypes + + + + read-only +

    + + + + + public + array<string|int, string> + $allowedTypes + + +

    The allowed data types for values.

    +
    + + + + +
    +
    + +
    +

    + Methods + + +

    +
    +

    + __construct() + + +

    + + +

    Create a type-sensitive, traversable queue of items.

    + + + public + __construct([array<string|int, string> $allowedTypes = [] ]) : void + +
    +
    + +
    Parameters
    +
    +
    + $allowedTypes + : array<string|int, string> + = []
    +
    +

    Allowed data types of items (optional)

    +

    If empty, all types are allowed. +Possible values are:

    +
      +
    • "array"
    • +
    • "bool"
    • +
    • "callable"
    • +
    • "countable"
    • +
    • "float" or "double"
    • +
    • "int" or "integer" or "long"
    • +
    • "iterable"
    • +
    • "null"
    • +
    • "numeric"
    • +
    • "object" or FQCN
    • +
    • "resource"
    • +
    • "scalar"
    • +
    • "string"
    • +
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + throws +
    +
    + InvalidArgumentException + + +
    +
    + + +
    +
    +

    + add() + + +

    + + +

    Add/insert a new value at the specified offset.

    + + + public + add(int $offset, AllowedType $value) : void + +
    +
    APIYes
    + +
    + +
    Parameters
    +
    +
    + $offset + : int +
    +
    +

    The offset where the new value is to be inserted

    +
    + +
    +
    + $value + : AllowedType +
    +
    +

    The new value for the offset

    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + throws +
    +
    + InvalidArgumentException + + +
    +
    + + +
    +
    +

    + append() + + +

    + + +

    Append values at the end of the list.

    + + + public + append(AllowedType ...$values) : void + +
    +
    APIYes
    + +
    + +
    Parameters
    +
    +
    + $values + : AllowedType +
    +
    +

    One or more values to append

    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + throws +
    +
    + InvalidArgumentException + + +
    +
    + + +
    +
    +

    + bottom() + + +

    + + +

    Peek at the value at the beginning of the list.

    + + + public + bottom() : AllowedType + +
    +
    APIYes
    + +
    + + + +
    + Tags + + +
    +
    +
    + throws +
    +
    + RuntimeException + + +
    +
    + +
    +
    Return values
    + AllowedType + — +

    The first value of the list

    +
    + +
    + +
    +
    +

    + dequeue() + + +

    + + +

    Dequeue an item from the queue.

    + + + public + dequeue() : AllowedType + +
    +
    APIYes
    + +
    + + + + +
    +
    Return values
    + AllowedType + — +

    The dequeued item

    +
    + +
    + +
    +
    +

    + enqueue() + + +

    + + +

    Add an item to the queue.

    + + + public + enqueue(AllowedType $item) : void + +
    +
    APIYes
    + +
    + +
    Parameters
    +
    +
    + $item + : AllowedType +
    +
    +

    The item to enqueue

    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + throws +
    +
    + InvalidArgumentException + + +
    +
    + + +
    +
    +

    + getAllowedTypes() + + +

    + + +

    Get allowed data types for list values.

    + + + public + getAllowedTypes() : array<string|int, string> + +
    +
    APIYes
    + +
    + + + + +
    +
    Return values
    + array<string|int, string> + — +

    The list of allowed data types

    +
    + +
    + +
    +
    +

    + getIteratorMode() + + +

    + + +

    Get the mode of iteration.

    + + + public + getIteratorMode() : int + +
    +
    APIYes
    + +
    + + + + +
    +
    Return values
    + int + — +

    The set of flags and modes of iteration

    +
    + +
    + +
    +
    +

    + isAllowedType() + + +

    + + +

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

    + + + public + isAllowedType(AllowedType $value) : bool + +
    +
    APIYes
    + +
    + +
    Parameters
    +
    +
    + $value + : AllowedType +
    +
    +

    The value to check

    +
    + +
    +
    + + + +
    +
    Return values
    + bool + — +

    Whether the value's data type is allowed

    +
    + +
    + +
    +
    +

    + offsetSet() + + +

    + + +

    Set the value at the specified offset.

    + + + public + offsetSet(int|null $offset, AllowedType $value) : void + +
    +
    APIYes
    + +
    + +
    Parameters
    +
    +
    + $offset + : int|null +
    +
    +

    The offset being set or NULL to append

    +
    + +
    +
    + $value + : AllowedType +
    +
    +

    The new value for the offset

    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + throws +
    +
    + InvalidArgumentException + + +
    +
    + + +
    +
    +

    + pop() + + +

    + + +

    Pops an value from the end of the list.

    + + + public + pop() : AllowedType + +
    +
    APIYes
    + +
    + + + +
    + Tags + + +
    +
    +
    + throws +
    +
    + RuntimeException + + +
    +
    + +
    +
    Return values
    + AllowedType + — +

    The value from the end of the list

    +
    + +
    + +
    +
    +

    + prepend() + + +

    + + +

    Prepend values at the start of the list.

    + + + public + prepend(AllowedType ...$values) : void + +
    +
    APIYes
    + +
    + +
    Parameters
    +
    +
    + $values + : AllowedType +
    +
    +

    One or more values to prepend

    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + throws +
    +
    + InvalidArgumentException + + +
    +
    + + +
    +
    +

    + push() + + +

    + + +

    Push an value at the end of the list.

    + + + public + push(AllowedType $value) : void + +
    +
    APIYes
    + +
    + +
    Parameters
    +
    +
    + $value + : AllowedType +
    +
    +

    The value to push

    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + throws +
    +
    + InvalidArgumentException + + +
    +
    + + +
    +
    +

    + setIteratorMode() + + +

    + + +

    Set the mode of iteration.

    + + + public + final setIteratorMode(int $mode) : int + +
    +
    APIYes
    + +
    + +
    Parameters
    +
    +
    + $mode + : int +
    +
    +

    The new iterator mode (0 or 1)

    +

    There are two orthogonal sets of modes that can be set.

    +

    The direction of iteration (fixed for StrictQueue):

    +
      +
    • StrictQueue::IT_MODE_FIFO (queue style)
    • +
    +

    The behavior of the iterator (either one or the other):

    +
      +
    • StrictQueue::IT_MODE_DELETE (delete items)
    • +
    • StrictQueue::IT_MODE_KEEP (keep items)
    • +
    +

    The default mode is: IT_MODE_FIFO | IT_MODE_KEEP

    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + throws +
    +
    + RuntimeException + + +
    +
    + +
    +
    Return values
    + int + — +

    The set of flags and modes of iteration

    +
    + +
    + +
    +
    +

    + shift() + + +

    + + +

    Shift an value from the beginning of the list.

    + + + public + shift() : AllowedType + +
    +
    APIYes
    + +
    + + + +
    + Tags + + +
    +
    +
    + throws +
    +
    + RuntimeException + + +
    +
    + +
    +
    Return values
    + AllowedType + — +

    The first value of the list

    +
    + +
    + +
    +
    +

    + top() + + +

    + + +

    Peek at the value at the end of the list.

    + + + public + top() : AllowedType + +
    +
    APIYes
    + +
    + + + +
    + Tags + + +
    +
    +
    + throws +
    +
    + RuntimeException + + +
    +
    + +
    +
    Return values
    + AllowedType + — +

    The last value of the list

    +
    + +
    + +
    +
    +

    + unshift() + + +

    + + +

    Prepend the list with an value.

    + + + public + unshift(AllowedType $value) : void + +
    +
    APIYes
    + +
    + +
    Parameters
    +
    +
    + $value + : AllowedType +
    +
    +

    The value to unshift

    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + throws +
    +
    + InvalidArgumentException + + +
    +
    + + +
    +
    +

    + setAllowedTypes() + + +

    + + +

    Set allowed data types of list values.

    + + + protected + setAllowedTypes([array<string|int, string> $allowedTypes = [] ]) : void + +
    +
    + +
    Parameters
    +
    +
    + $allowedTypes + : array<string|int, string> + = []
    +
    +

    Allowed data types of values

    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + throws +
    +
    + InvalidArgumentException + + +
    +
    + + +
    +
    + +
    +
    +
    +
    +
    
    +        
    + +
    +
    + + + +
    +
    +
    + +
    + On this page + + +
    + +
    +
    +
    +
    +
    +

    Search results

    + +
    +
    +
      +
      +
      +
      +
      + + +
      + + + + + + + + diff --git a/docs/classes/OCC-Basics-DataStructures-StrictStack.html b/docs/classes/OCC-Basics-DataStructures-StrictStack.html new file mode 100644 index 0000000..d6a0ef0 --- /dev/null +++ b/docs/classes/OCC-Basics-DataStructures-StrictStack.html @@ -0,0 +1,1712 @@ + + + + + PHP Basics + + + + + + + + + + + + + + + + + + + + + +
      +

      PHP Basics

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

      + StrictStack + + + extends StrictList + + +
      + in package + +
      + + + implements + ArrayAccess, Countable, Iterator, Serializable + +

      + +
      + + +
      + + + +

      A type-sensitive, taversable Last In, First Out stack (LIFO).

      + +

      Extends \SplStack with an option to specify +the allowed data types for list items.

      +
      + + +
      + Tags + + +
      +
      +
      + author +
      +
      + +

      Sebastian Meyer sebastian.meyer@opencultureconsulting.com

      +
      + +
      +
      + template +
      +
      + +

      AllowedType of mixed

      +
      + +
      +
      + + + +

      + Table of Contents + + +

      + + + +

      + Interfaces + + +

      +
      +
      ArrayAccess
      Countable
      Iterator
      Serializable
      + + + + + + +

      + Properties + + +

      +
      +
      + $allowedTypes + +  : array<string|int, string> +
      + +
      + +

      + Methods + + +

      +
      +
      + __construct() + +  : void +
      +
      Create a type-sensitive, traversable stack of items.
      + +
      + add() + +  : void +
      +
      Add/insert a new value at the specified offset.
      + +
      + append() + +  : void +
      +
      Append values at the end of the list.
      + +
      + bottom() + +  : AllowedType +
      +
      Peek at the value at the beginning of the list.
      + +
      + getAllowedTypes() + +  : array<string|int, string> +
      +
      Get allowed data types for list values.
      + +
      + getIteratorMode() + +  : int +
      +
      Get the mode of iteration.
      + +
      + isAllowedType() + +  : bool +
      +
      Check if the value's data type is allowed on the list.
      + +
      + offsetSet() + +  : void +
      +
      Set the value at the specified offset.
      + +
      + pop() + +  : AllowedType +
      +
      Pops an value from the end of the list.
      + +
      + prepend() + +  : void +
      +
      Prepend values at the start of the list.
      + +
      + push() + +  : void +
      +
      Push an value at the end of the list.
      + +
      + setIteratorMode() + +  : int +
      +
      Set the mode of iteration.
      + +
      + shift() + +  : AllowedType +
      +
      Shift an value from the beginning of the list.
      + +
      + stack() + +  : void +
      +
      Add an item to the stack.
      + +
      + top() + +  : AllowedType +
      +
      Peek at the value at the end of the list.
      + +
      + unshift() + +  : void +
      +
      Prepend the list with an value.
      + +
      + unstack() + +  : AllowedType +
      +
      Unstack an item from the stack.
      + +
      + setAllowedTypes() + +  : void +
      +
      Set allowed data types of list values.
      + +
      + + + + + + + +
      +

      + Properties + + +

      +
      +

      + $allowedTypes + + + + read-only +

      + + + + + public + array<string|int, string> + $allowedTypes + + +

      The allowed data types for values.

      +
      + + + + +
      +
      + +
      +

      + Methods + + +

      +
      +

      + __construct() + + +

      + + +

      Create a type-sensitive, traversable stack of items.

      + + + public + __construct([array<string|int, string> $allowedTypes = [] ]) : void + +
      +
      + +
      Parameters
      +
      +
      + $allowedTypes + : array<string|int, string> + = []
      +
      +

      Allowed data types of items (optional)

      +

      If empty, all types are allowed. +Possible values are:

      +
        +
      • "array"
      • +
      • "bool"
      • +
      • "callable"
      • +
      • "countable"
      • +
      • "float" or "double"
      • +
      • "int" or "integer" or "long"
      • +
      • "iterable"
      • +
      • "null"
      • +
      • "numeric"
      • +
      • "object" or FQCN
      • +
      • "resource"
      • +
      • "scalar"
      • +
      • "string"
      • +
      +
      + +
      +
      + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + InvalidArgumentException + + +
      +
      + + +
      +
      +

      + add() + + +

      + + +

      Add/insert a new value at the specified offset.

      + + + public + add(int $offset, AllowedType $value) : void + +
      +
      APIYes
      + +
      + +
      Parameters
      +
      +
      + $offset + : int +
      +
      +

      The offset where the new value is to be inserted

      +
      + +
      +
      + $value + : AllowedType +
      +
      +

      The new value for the offset

      +
      + +
      +
      + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + InvalidArgumentException + + +
      +
      + + +
      +
      +

      + append() + + +

      + + +

      Append values at the end of the list.

      + + + public + append(AllowedType ...$values) : void + +
      +
      APIYes
      + +
      + +
      Parameters
      +
      +
      + $values + : AllowedType +
      +
      +

      One or more values to append

      +
      + +
      +
      + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + InvalidArgumentException + + +
      +
      + + +
      +
      +

      + bottom() + + +

      + + +

      Peek at the value at the beginning of the list.

      + + + public + bottom() : AllowedType + +
      +
      APIYes
      + +
      + + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + RuntimeException + + +
      +
      + +
      +
      Return values
      + AllowedType + — +

      The first value of the list

      +
      + +
      + +
      +
      +

      + getAllowedTypes() + + +

      + + +

      Get allowed data types for list values.

      + + + public + getAllowedTypes() : array<string|int, string> + +
      +
      APIYes
      + +
      + + + + +
      +
      Return values
      + array<string|int, string> + — +

      The list of allowed data types

      +
      + +
      + +
      +
      +

      + getIteratorMode() + + +

      + + +

      Get the mode of iteration.

      + + + public + getIteratorMode() : int + +
      +
      APIYes
      + +
      + + + + +
      +
      Return values
      + int + — +

      The set of flags and modes of iteration

      +
      + +
      + +
      +
      +

      + isAllowedType() + + +

      + + +

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

      + + + public + isAllowedType(AllowedType $value) : bool + +
      +
      APIYes
      + +
      + +
      Parameters
      +
      +
      + $value + : AllowedType +
      +
      +

      The value to check

      +
      + +
      +
      + + + +
      +
      Return values
      + bool + — +

      Whether the value's data type is allowed

      +
      + +
      + +
      +
      +

      + offsetSet() + + +

      + + +

      Set the value at the specified offset.

      + + + public + offsetSet(int|null $offset, AllowedType $value) : void + +
      +
      APIYes
      + +
      + +
      Parameters
      +
      +
      + $offset + : int|null +
      +
      +

      The offset being set or NULL to append

      +
      + +
      +
      + $value + : AllowedType +
      +
      +

      The new value for the offset

      +
      + +
      +
      + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + InvalidArgumentException + + +
      +
      + + +
      +
      +

      + pop() + + +

      + + +

      Pops an value from the end of the list.

      + + + public + pop() : AllowedType + +
      +
      APIYes
      + +
      + + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + RuntimeException + + +
      +
      + +
      +
      Return values
      + AllowedType + — +

      The value from the end of the list

      +
      + +
      + +
      +
      +

      + prepend() + + +

      + + +

      Prepend values at the start of the list.

      + + + public + prepend(AllowedType ...$values) : void + +
      +
      APIYes
      + +
      + +
      Parameters
      +
      +
      + $values + : AllowedType +
      +
      +

      One or more values to prepend

      +
      + +
      +
      + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + InvalidArgumentException + + +
      +
      + + +
      +
      +

      + push() + + +

      + + +

      Push an value at the end of the list.

      + + + public + push(AllowedType $value) : void + +
      +
      APIYes
      + +
      + +
      Parameters
      +
      +
      + $value + : AllowedType +
      +
      +

      The value to push

      +
      + +
      +
      + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + InvalidArgumentException + + +
      +
      + + +
      +
      +

      + setIteratorMode() + + +

      + + +

      Set the mode of iteration.

      + + + public + final setIteratorMode(int $mode) : int + +
      +
      APIYes
      + +
      + +
      Parameters
      +
      +
      + $mode + : int +
      +
      +

      The new iterator mode (2 or 3)

      +

      There are two orthogonal sets of modes that can be set.

      +

      The direction of iteration (fixed for StrictStack):

      +
        +
      • StrictStack::IT_MODE_LIFO (stack style)
      • +
      +

      The behavior of the iterator (either one or the other):

      +
        +
      • StrictStack::IT_MODE_DELETE (delete items)
      • +
      • StrictStack::IT_MODE_KEEP (keep items)
      • +
      +

      The default mode is: IT_MODE_LIFO | IT_MODE_KEEP

      +
      + +
      +
      + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + RuntimeException + + +
      +
      + +
      +
      Return values
      + int + — +

      The set of flags and modes of iteration

      +
      + +
      + +
      +
      +

      + shift() + + +

      + + +

      Shift an value from the beginning of the list.

      + + + public + shift() : AllowedType + +
      +
      APIYes
      + +
      + + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + RuntimeException + + +
      +
      + +
      +
      Return values
      + AllowedType + — +

      The first value of the list

      +
      + +
      + +
      +
      +

      + stack() + + +

      + + +

      Add an item to the stack.

      + + + public + stack(AllowedType $item) : void + +
      +
      APIYes
      + +
      + +
      Parameters
      +
      +
      + $item + : AllowedType +
      +
      +

      The item to stack

      +
      + +
      +
      + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + InvalidArgumentException + + +
      +
      + + +
      +
      +

      + top() + + +

      + + +

      Peek at the value at the end of the list.

      + + + public + top() : AllowedType + +
      +
      APIYes
      + +
      + + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + RuntimeException + + +
      +
      + +
      +
      Return values
      + AllowedType + — +

      The last value of the list

      +
      + +
      + +
      +
      +

      + unshift() + + +

      + + +

      Prepend the list with an value.

      + + + public + unshift(AllowedType $value) : void + +
      +
      APIYes
      + +
      + +
      Parameters
      +
      +
      + $value + : AllowedType +
      +
      +

      The value to unshift

      +
      + +
      +
      + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + InvalidArgumentException + + +
      +
      + + +
      +
      +

      + unstack() + + +

      + + +

      Unstack an item from the stack.

      + + + public + unstack() : AllowedType + +
      +
      APIYes
      + +
      + + + + +
      +
      Return values
      + AllowedType + — +

      The unstacked item

      +
      + +
      + +
      +
      +

      + setAllowedTypes() + + +

      + + +

      Set allowed data types of list values.

      + + + protected + setAllowedTypes([array<string|int, string> $allowedTypes = [] ]) : void + +
      +
      + +
      Parameters
      +
      +
      + $allowedTypes + : array<string|int, string> + = []
      +
      +

      Allowed data types of values

      +
      + +
      +
      + + +
      + Tags + + +
      +
      +
      + throws +
      +
      + InvalidArgumentException + + +
      +
      + + +
      +
      + +
      +
      +
      +
      +
      
      +        
      + +
      +
      + + + +
      +
      +
      + +
      + On this page + + +
      + +
      +
      +
      +
      +
      +

      Search results

      + +
      +
      +
        +
        +
        +
        +
        + + +
        + + + + + + + + diff --git a/docs/classes/OCC-Basics-ErrorHandlers-ThrowErrorException.html b/docs/classes/OCC-Basics-ErrorHandlers-ThrowErrorException.html new file mode 100644 index 0000000..4db2ceb --- /dev/null +++ b/docs/classes/OCC-Basics-ErrorHandlers-ThrowErrorException.html @@ -0,0 +1,499 @@ + + + + + PHP Basics + + + + + + + + + + + + + + + + + + + + + +
        +

        PHP Basics

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

        + ThrowErrorException + + +
        + in package + +
        + + +

        + +
        + + +
        + + + +

        Throw internal errors as exceptions.

        + +

        Usage: set_error_handler(new ThrowErrorException());

        +
        + + +
        + Tags + + +
        +
        +
        + author +
        +
        + +

        Sebastian Meyer sebastian.meyer@opencultureconsulting.com

        +
        + +
        +
        + + + +

        + Table of Contents + + +

        + + + + + + + + + + +

        + Methods + + +

        +
        +
        + __invoke() + +  : bool +
        +
        Convert an internal PHP error into an ErrorException.
        + +
        + + + + + + + + +
        +

        + Methods + + +

        +
        +

        + __invoke() + + +

        + + +

        Convert an internal PHP error into an ErrorException.

        + + + public + __invoke([int $errno = E_USER_ERROR ][, string $errstr = '' ][, string|null $errfile = null ][, int|null $errline = null ]) : bool + +
        +
        + +
        Parameters
        +
        +
        + $errno + : int + = E_USER_ERROR
        +
        +

        The severity of the error

        +
        + +
        +
        + $errstr + : string + = ''
        +
        +

        The error message

        +
        + +
        +
        + $errfile + : string|null + = null
        +
        +

        The name of the file the error was raised in

        +
        + +
        +
        + $errline + : int|null + = null
        +
        +

        The line number the error was raised in

        +
        + +
        +
        + + +
        + Tags + + +
        +
        +
        + throws +
        +
        + ErrorException + + +
        +
        + +
        +
        Return values
        + bool + — +

        Always returns FALSE when not throwing an exception

        +
        + +
        + +
        +
        + +
        +
        +
        +
        +
        
        +        
        + +
        +
        + + + +
        +
        +
        + +
        + On this page + + +
        + +
        +
        +
        +
        +
        +

        Search results

        + +
        +
        +
          +
          +
          +
          +
          + + +
          + + + + + + + + diff --git a/docs/classes/OCC-Basics-ErrorHandlers-TriggerExceptionError.html b/docs/classes/OCC-Basics-ErrorHandlers-TriggerExceptionError.html new file mode 100644 index 0000000..7914f1f --- /dev/null +++ b/docs/classes/OCC-Basics-ErrorHandlers-TriggerExceptionError.html @@ -0,0 +1,449 @@ + + + + + PHP Basics + + + + + + + + + + + + + + + + + + + + + +
          +

          PHP Basics

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

          + TriggerExceptionError + + +
          + in package + +
          + + +

          + +
          + + +
          + + + +

          Trigger errors for uncaught exceptions.

          + +

          Usage: set_exception_handler(new TriggerExceptionError());

          +
          + + +
          + Tags + + +
          +
          +
          + author +
          +
          + +

          Sebastian Meyer sebastian.meyer@opencultureconsulting.com

          +
          + +
          +
          + + + +

          + Table of Contents + + +

          + + + + + + + + + + +

          + Methods + + +

          +
          +
          + __invoke() + +  : void +
          +
          Convert an uncaught exception into an PHP error.
          + +
          + + + + + + + + +
          +

          + Methods + + +

          +
          +

          + __invoke() + + +

          + + +

          Convert an uncaught exception into an PHP error.

          + + + public + __invoke(Throwable $exception) : void + +
          +
          + +
          Parameters
          +
          +
          + $exception + : Throwable +
          +
          +

          The exception

          +
          + +
          +
          + + + + +
          +
          + +
          +
          +
          +
          +
          
          +        
          + +
          +
          + + + +
          +
          +
          + +
          + On this page + + +
          + +
          +
          +
          +
          +
          +

          Search results

          + +
          +
          +
            +
            +
            +
            +
            + + +
            + + + + + + + + diff --git a/docs/classes/OCC-Basics-InterfaceTraits-ArrayAccessTrait.html b/docs/classes/OCC-Basics-InterfaceTraits-ArrayAccessTrait.html new file mode 100644 index 0000000..3f364d2 --- /dev/null +++ b/docs/classes/OCC-Basics-InterfaceTraits-ArrayAccessTrait.html @@ -0,0 +1,711 @@ + + + + + PHP Basics + + + + + + + + + + + + + + + + + + + + + +
            +

            PHP Basics

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

            + ArrayAccessTrait +

            + + + +

            A generic implementation of the ArrayAccess interface.

            + + + +
            + Tags + + +
            +
            +
            + author +
            +
            + +

            Sebastian Meyer sebastian.meyer@opencultureconsulting.com

            +
            + +
            +
            + template +
            +
            + +

            TKey of int|string

            +
            + +
            +
            + template +
            +
            + +

            TValue of mixed

            +
            + +
            +
            + template +
            +
            + +

            TData of array<TKey, TValue>

            +
            + +
            +
            + + + +

            + Table of Contents + + +

            + + + + + + + + + +

            + Properties + + +

            +
            +
            + $data + +  : TData +
            +
            Holds the array-accessible data.
            + +
            + +

            + Methods + + +

            +
            +
            + offsetExists() + +  : bool +
            +
            Check if the specified offset exists.
            + +
            + offsetGet() + +  : TValue|null +
            +
            Retrieve data at the specified offset.
            + +
            + offsetSet() + +  : void +
            +
            Assign a value to the specified offset.
            + +
            + offsetUnset() + +  : void +
            +
            Unset the specified offset.
            + +
            + + + + + + + +
            +

            + Properties + + +

            +
            +

            + $data + + + + +

            + + +

            Holds the array-accessible data.

            + + + protected + TData + $data + = [] + + + + + +
            +
            + +
            +

            + Methods + + +

            +
            +

            + offsetExists() + + +

            + + +

            Check if the specified offset exists.

            + + + public + offsetExists(TKey $offset) : bool + +
            +
            APIYes
            + +
            + +
            Parameters
            +
            +
            + $offset + : TKey +
            +
            +

            The offset to check for

            +
            + +
            +
            + + + +
            +
            Return values
            + bool + — +

            Whether the offset exists

            +
            + +
            + +
            +
            +

            + offsetGet() + + +

            + + +

            Retrieve data at the specified offset.

            + + + public + offsetGet(TKey $offset) : TValue|null + +
            +
            APIYes
            + +
            + +
            Parameters
            +
            +
            + $offset + : TKey +
            +
            +

            The offset to retrieve at

            +
            + +
            +
            + + + +
            +
            Return values
            + TValue|null + — +

            The value at the offset or NULL

            +
            + +
            + +
            +
            +

            + offsetSet() + + +

            + + +

            Assign a value to the specified offset.

            + + + public + offsetSet(TKey|null $offset, TValue $value) : void + +
            +
            APIYes
            + +
            + +
            Parameters
            +
            +
            + $offset + : TKey|null +
            +
            +

            The offset to assign to or NULL to append

            +
            + +
            +
            + $value + : TValue +
            +
            +

            The value to set

            +
            + +
            +
            + + + + +
            +
            +

            + offsetUnset() + + +

            + + +

            Unset the specified offset.

            + + + public + offsetUnset(TKey $offset) : void + +
            +
            APIYes
            + +
            + +
            Parameters
            +
            +
            + $offset + : TKey +
            +
            +

            The offset to unset

            +
            + +
            +
            + + + + +
            +
            + +
            +
            +
            +
            +
            
            +        
            + +
            +
            + + + +
            +
            +
            + +
            + On this page + + +
            + +
            +
            +
            +
            +
            +

            Search results

            + +
            +
            +
              +
              +
              +
              +
              + + +
              + + + + + + + + diff --git a/docs/classes/OCC-Basics-InterfaceTraits-CountableTrait.html b/docs/classes/OCC-Basics-InterfaceTraits-CountableTrait.html new file mode 100644 index 0000000..dac62c1 --- /dev/null +++ b/docs/classes/OCC-Basics-InterfaceTraits-CountableTrait.html @@ -0,0 +1,517 @@ + + + + + PHP Basics + + + + + + + + + + + + + + + + + + + + + +
              +

              PHP Basics

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

              + CountableTrait +

              + + + +

              A generic implementation of the Countable interface.

              + + + +
              + Tags + + +
              +
              +
              + author +
              +
              + +

              Sebastian Meyer sebastian.meyer@opencultureconsulting.com

              +
              + +
              +
              + template +
              +
              + +

              TKey of int|string

              +
              + +
              +
              + template +
              +
              + +

              TValue of mixed

              +
              + +
              +
              + template +
              +
              + +

              TData of array<TKey, TValue>

              +
              + +
              +
              + + + +

              + Table of Contents + + +

              + + + + + + + + + +

              + Properties + + +

              +
              +
              + $data + +  : TData +
              +
              Holds the countable data.
              + +
              + +

              + Methods + + +

              +
              +
              + count() + +  : int +
              +
              Count the data items.
              + +
              + + + + + + + +
              +

              + Properties + + +

              +
              +

              + $data + + + + +

              + + +

              Holds the countable data.

              + + + protected + TData + $data + = [] + + + + + +
              +
              + +
              +

              + Methods + + +

              +
              +

              + count() + + +

              + + +

              Count the data items.

              + + + public + count() : int + +
              +
              APIYes
              + +
              + + + + +
              +
              Return values
              + int + — +

              The number of data items

              +
              + +
              + +
              +
              + +
              +
              +
              +
              +
              
              +        
              + +
              +
              + + + +
              +
              +
              + +
              + On this page + + +
              + +
              +
              +
              +
              +
              +

              Search results

              + +
              +
              +
                +
                +
                +
                +
                + + +
                + + + + + + + + diff --git a/docs/classes/OCC-Basics-InterfaceTraits-IteratorAggregateTrait.html b/docs/classes/OCC-Basics-InterfaceTraits-IteratorAggregateTrait.html new file mode 100644 index 0000000..1f2d50c --- /dev/null +++ b/docs/classes/OCC-Basics-InterfaceTraits-IteratorAggregateTrait.html @@ -0,0 +1,517 @@ + + + + + PHP Basics + + + + + + + + + + + + + + + + + + + + + +
                +

                PHP Basics

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

                + IteratorAggregateTrait +

                + + + +

                A generic implementation of the IteratorAggregate interface.

                + + + +
                + Tags + + +
                +
                +
                + author +
                +
                + +

                Sebastian Meyer sebastian.meyer@opencultureconsulting.com

                +
                + +
                +
                + template +
                +
                + +

                TKey of int|string

                +
                + +
                +
                + template +
                +
                + +

                TValue of mixed

                +
                + +
                +
                + template +
                +
                + +

                TData of array<TKey, TValue>

                +
                + +
                +
                + + + +

                + Table of Contents + + +

                + + + + + + + + + +

                + Properties + + +

                +
                +
                + $data + +  : TData +
                +
                Holds the iterable data.
                + +
                + +

                + Methods + + +

                +
                +
                + getIterator() + +  : ArrayIterator<TKey, TValue> +
                +
                Retrieve an external iterator.
                + +
                + + + + + + + +
                +

                + Properties + + +

                +
                +

                + $data + + + + +

                + + +

                Holds the iterable data.

                + + + protected + TData + $data + = [] + + + + + +
                +
                + +
                +

                + Methods + + +

                +
                +

                + getIterator() + + +

                + + +

                Retrieve an external iterator.

                + + + public + getIterator() : ArrayIterator<TKey, TValue> + +
                +
                APIYes
                + +
                + + + + +
                +
                Return values
                + ArrayIterator<TKey, TValue> + — +

                New array iterator for data array

                +
                + +
                + +
                +
                + +
                +
                +
                +
                +
                
                +        
                + +
                +
                + + + +
                +
                +
                + +
                + On this page + + +
                + +
                +
                +
                +
                +
                +

                Search results

                + +
                +
                +
                  +
                  +
                  +
                  +
                  + + +
                  + + + + + + + + diff --git a/docs/classes/OCC-Basics-InterfaceTraits-IteratorTrait.html b/docs/classes/OCC-Basics-InterfaceTraits-IteratorTrait.html new file mode 100644 index 0000000..49b2079 --- /dev/null +++ b/docs/classes/OCC-Basics-InterfaceTraits-IteratorTrait.html @@ -0,0 +1,748 @@ + + + + + PHP Basics + + + + + + + + + + + + + + + + + + + + + +
                  +

                  PHP Basics

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

                  + IteratorTrait +

                  + + + +

                  A generic implementation of the Iterator interface.

                  + + + +
                  + Tags + + +
                  +
                  +
                  + author +
                  +
                  + +

                  Sebastian Meyer sebastian.meyer@opencultureconsulting.com

                  +
                  + +
                  +
                  + template +
                  +
                  + +

                  TKey of int|string

                  +
                  + +
                  +
                  + template +
                  +
                  + +

                  TValue of mixed

                  +
                  + +
                  +
                  + template +
                  +
                  + +

                  TData of array<TKey, TValue>

                  +
                  + +
                  +
                  + + + +

                  + Table of Contents + + +

                  + + + + + + + + + +

                  + Properties + + +

                  +
                  +
                  + $data + +  : TData +
                  +
                  Holds the iterable data.
                  + +
                  + +

                  + Methods + + +

                  +
                  +
                  + current() + +  : TValue|false +
                  +
                  Return the current item.
                  + +
                  + key() + +  : TKey|null +
                  +
                  Return the current key.
                  + +
                  + next() + +  : void +
                  +
                  Move forward to next item.
                  + +
                  + prev() + +  : void +
                  +
                  Move back to previous item.
                  + +
                  + rewind() + +  : void +
                  +
                  Rewind the iterator to the first item.
                  + +
                  + valid() + +  : bool +
                  +
                  Check if current position is valid.
                  + +
                  + + + + + + + +
                  +

                  + Properties + + +

                  +
                  +

                  + $data + + + + +

                  + + +

                  Holds the iterable data.

                  + + + protected + TData + $data + = [] + + + + + +
                  +
                  + +
                  +

                  + Methods + + +

                  +
                  +

                  + current() + + +

                  + + +

                  Return the current item.

                  + + + public + current() : TValue|false + +
                  +
                  APIYes
                  + +
                  + + + + +
                  +
                  Return values
                  + TValue|false + — +

                  The current item or FALSE if invalid

                  +
                  + +
                  + +
                  +
                  +

                  + key() + + +

                  + + +

                  Return the current key.

                  + + + public + key() : TKey|null + +
                  +
                  APIYes
                  + +
                  + + + + +
                  +
                  Return values
                  + TKey|null + — +

                  The current key or NULL if invalid

                  +
                  + +
                  + +
                  +
                  +

                  + next() + + +

                  + + +

                  Move forward to next item.

                  + + + public + next() : void + +
                  +
                  APIYes
                  + +
                  + + + + + +
                  +
                  +

                  + prev() + + +

                  + + +

                  Move back to previous item.

                  + + + public + prev() : void + +
                  +
                  APIYes
                  + +
                  + + + + + +
                  +
                  +

                  + rewind() + + +

                  + + +

                  Rewind the iterator to the first item.

                  + + + public + rewind() : void + +
                  +
                  APIYes
                  + +
                  + + + + + +
                  +
                  +

                  + valid() + + +

                  + + +

                  Check if current position is valid.

                  + + + public + valid() : bool + +
                  +
                  APIYes
                  + +
                  + + + + +
                  +
                  Return values
                  + bool + — +

                  Whether the current position is valid

                  +
                  + +
                  + +
                  +
                  + +
                  +
                  +
                  +
                  +
                  
                  +        
                  + +
                  +
                  + + + +
                  +
                  +
                  + +
                  + On this page + + +
                  + +
                  +
                  +
                  +
                  +
                  +

                  Search results

                  + +
                  +
                  +
                    +
                    +
                    +
                    +
                    + + +
                    + + + + + + + + diff --git a/docs/classes/OCC-Basics-Traits-Getter.html b/docs/classes/OCC-Basics-Traits-Getter.html new file mode 100644 index 0000000..4767858 --- /dev/null +++ b/docs/classes/OCC-Basics-Traits-Getter.html @@ -0,0 +1,356 @@ + + + + + PHP Basics + + + + + + + + + + + + + + + + + + + + + +
                    +

                    PHP Basics

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

                    + Getter +

                    + + + +

                    Reads data from inaccessible properties by using magic methods.

                    + + + +
                    + Tags + + +
                    +
                    +
                    + author +
                    +
                    + +

                    Sebastian Meyer sebastian.meyer@opencultureconsulting.com

                    +
                    + +
                    +
                    + + + +

                    + Table of Contents + + +

                    + + + + + + + + + + + + + + + + + + + +
                    +
                    +
                    +
                    +
                    
                    +        
                    + +
                    +
                    + + + +
                    +
                    +
                    + +
                    + On this page + +
                      +
                    • Table Of Contents
                    • +
                    • +
                        +
                      +
                    • +
                    +
                    + +
                    +
                    +
                    +
                    +
                    +

                    Search results

                    + +
                    +
                    +
                      +
                      +
                      +
                      +
                      + + +
                      + + + + + + + + diff --git a/docs/classes/OCC-Basics-Traits-Setter.html b/docs/classes/OCC-Basics-Traits-Setter.html new file mode 100644 index 0000000..8cb5918 --- /dev/null +++ b/docs/classes/OCC-Basics-Traits-Setter.html @@ -0,0 +1,356 @@ + + + + + PHP Basics + + + + + + + + + + + + + + + + + + + + + +
                      +

                      PHP Basics

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

                      + Setter +

                      + + + +

                      Writes data to inaccessible properties by using magic methods.

                      + + + +
                      + Tags + + +
                      +
                      +
                      + author +
                      +
                      + +

                      Sebastian Meyer sebastian.meyer@opencultureconsulting.com

                      +
                      + +
                      +
                      + + + +

                      + Table of Contents + + +

                      + + + + + + + + + + + + + + + + + + + +
                      +
                      +
                      +
                      +
                      
                      +        
                      + +
                      +
                      + + + +
                      +
                      +
                      + +
                      + On this page + +
                        +
                      • Table Of Contents
                      • +
                      • +
                          +
                        +
                      • +
                      +
                      + +
                      +
                      +
                      +
                      +
                      +

                      Search results

                      + +
                      +
                      +
                        +
                        +
                        +
                        +
                        + + +
                        + + + + + + + + diff --git a/docs/classes/OCC-Basics-Traits-Singleton.html b/docs/classes/OCC-Basics-Traits-Singleton.html new file mode 100644 index 0000000..f35601d --- /dev/null +++ b/docs/classes/OCC-Basics-Traits-Singleton.html @@ -0,0 +1,482 @@ + + + + + PHP Basics + + + + + + + + + + + + + + + + + + + + + +
                        +

                        PHP Basics

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

                        + Singleton +

                        + + + +

                        Allows just a single instance of the class using this trait.

                        + + + +
                        + Tags + + +
                        +
                        +
                        + author +
                        +
                        + +

                        Sebastian Meyer sebastian.meyer@opencultureconsulting.com

                        +
                        + +
                        +
                        + + + +

                        + Table of Contents + + +

                        + + + + + + + + + + +

                        + Methods + + +

                        +
                        +
                        + getInstance() + +  : static +
                        +
                        Get a singleton instance of this class.
                        + +
                        + __construct() + +  : void +
                        +
                        This is a singleton class, thus the constructor is private.
                        + +
                        + + + + + + + + +
                        +

                        + Methods + + +

                        +
                        +

                        + getInstance() + + +

                        + + +

                        Get a singleton instance of this class.

                        + + + public + final static getInstance(mixed ...$args) : static + +
                        +
                        APIYes
                        + +
                        + +
                        Parameters
                        +
                        +
                        + $args + : mixed +
                        +
                        +

                        Constructor parameters

                        +
                        + +
                        +
                        + + + +
                        +
                        Return values
                        + static + — +

                        The singleton instance

                        +
                        + +
                        + +
                        +
                        +

                        + __construct() + + +

                        + + +

                        This is a singleton class, thus the constructor is private.

                        + + + private + abstract __construct() : void + +
                        +
                        +

                        Usage: Get an instance of this class by calling static::getInstance()

                        +
                        + + + + + +
                        +
                        + +
                        +
                        +
                        +
                        +
                        
                        +        
                        + +
                        +
                        + + + +
                        +
                        +
                        + +
                        + On this page + + +
                        + +
                        +
                        +
                        +
                        +
                        +

                        Search results

                        + +
                        +
                        +
                          +
                          +
                          +
                          +
                          + + +
                          + + + + + + + + diff --git a/docs/css/base.css b/docs/css/base.css new file mode 100644 index 0000000..8b182de --- /dev/null +++ b/docs/css/base.css @@ -0,0 +1,1231 @@ + + +:root { + /* Typography */ + --font-primary: 'Open Sans', Helvetica, Arial, sans-serif; + --font-secondary: 'Open Sans', Helvetica, Arial, sans-serif; + --font-monospace: 'Source Code Pro', monospace; + --line-height--primary: 1.6; + --letter-spacing--primary: .05rem; + --text-base-size: 1em; + --text-scale-ratio: 1.2; + + --text-xxs: calc(var(--text-base-size) / var(--text-scale-ratio) / var(--text-scale-ratio) / var(--text-scale-ratio)); + --text-xs: calc(var(--text-base-size) / var(--text-scale-ratio) / var(--text-scale-ratio)); + --text-sm: calc(var(--text-base-size) / var(--text-scale-ratio)); + --text-md: var(--text-base-size); + --text-lg: calc(var(--text-base-size) * var(--text-scale-ratio)); + --text-xl: calc(var(--text-base-size) * var(--text-scale-ratio) * var(--text-scale-ratio)); + --text-xxl: calc(var(--text-base-size) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio)); + --text-xxxl: calc(var(--text-base-size) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio)); + --text-xxxxl: calc(var(--text-base-size) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio)); + --text-xxxxxl: calc(var(--text-base-size) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio) * var(--text-scale-ratio)); + + --color-hue-red: 4; + --color-hue-pink: 340; + --color-hue-purple: 291; + --color-hue-deep-purple: 262; + --color-hue-indigo: 231; + --color-hue-blue: 207; + --color-hue-light-blue: 199; + --color-hue-cyan: 187; + --color-hue-teal: 174; + --color-hue-green: 122; + --color-hue-phpdocumentor-green: 96; + --color-hue-light-green: 88; + --color-hue-lime: 66; + --color-hue-yellow: 54; + --color-hue-amber: 45; + --color-hue-orange: 36; + --color-hue-deep-orange: 14; + --color-hue-brown: 16; + + /* Colors */ + --primary-color-hue: var(--color-hue-orange, --color-hue-phpdocumentor-green); + --primary-color-saturation: 57%; + --primary-color: hsl(var(--primary-color-hue), var(--primary-color-saturation), 60%); + --primary-color-darken: hsl(var(--primary-color-hue), var(--primary-color-saturation), 40%); + --primary-color-darker: hsl(var(--primary-color-hue), var(--primary-color-saturation), 25%); + --primary-color-darkest: hsl(var(--primary-color-hue), var(--primary-color-saturation), 10%); + --primary-color-lighten: hsl(var(--primary-color-hue), calc(var(--primary-color-saturation) - 20%), 85%); + --primary-color-lighter: hsl(var(--primary-color-hue), calc(var(--primary-color-saturation) - 45%), 97.5%); + --dark-gray: #d1d1d1; + --light-gray: #f0f0f0; + + --text-color: var(--primary-color-darkest); + + --header-height: var(--spacing-xxxxl); + --header-bg-color: var(--primary-color); + --code-background-color: var(--primary-color-lighter); + --code-border-color: --primary-color-lighten; + --button-border-color: var(--primary-color-darken); + --button-color: transparent; + --button-color-primary: var(--primary-color); + --button-text-color: #555; + --button-text-color-primary: white; + --popover-background-color: rgba(255, 255, 255, 0.75); + --link-color-primary: var(--primary-color-darker); + --link-hover-color-primary: var(--primary-color-darkest); + --form-field-border-color: var(--dark-gray); + --form-field-color: #fff; + --admonition-success-color: var(--primary-color); + --admonition-border-color: silver; + --table-separator-color: var(--primary-color-lighten); + --title-text-color: var(--primary-color); + + --sidebar-border-color: var(--primary-color-lighten); + + /* Grid */ + --container-width: 1400px; + + /* Spacing */ + --spacing-base-size: 1rem; + --spacing-scale-ratio: 1.5; + + --spacing-xxxs: calc(var(--spacing-base-size) / var(--spacing-scale-ratio) / var(--spacing-scale-ratio) / var(--spacing-scale-ratio) / var(--spacing-scale-ratio)); + --spacing-xxs: calc(var(--spacing-base-size) / var(--spacing-scale-ratio) / var(--spacing-scale-ratio) / var(--spacing-scale-ratio)); + --spacing-xs: calc(var(--spacing-base-size) / var(--spacing-scale-ratio) / var(--spacing-scale-ratio)); + --spacing-sm: calc(var(--spacing-base-size) / var(--spacing-scale-ratio)); + --spacing-md: var(--spacing-base-size); + --spacing-lg: calc(var(--spacing-base-size) * var(--spacing-scale-ratio)); + --spacing-xl: calc(var(--spacing-base-size) * var(--spacing-scale-ratio) * var(--spacing-scale-ratio)); + --spacing-xxl: calc(var(--spacing-base-size) * var(--spacing-scale-ratio) * var(--spacing-scale-ratio) * var(--spacing-scale-ratio)); + --spacing-xxxl: calc(var(--spacing-base-size) * var(--spacing-scale-ratio) * var(--spacing-scale-ratio) * var(--spacing-scale-ratio) * var(--spacing-scale-ratio)); + --spacing-xxxxl: calc(var(--spacing-base-size) * var(--spacing-scale-ratio) * var(--spacing-scale-ratio) * var(--spacing-scale-ratio) * var(--spacing-scale-ratio) * var(--spacing-scale-ratio)); + + --border-radius-base-size: 3px; +} + +/* Base Styles +-------------------------------------------------- */ +body { + color: var(--text-color); + font-family: var(--font-primary); + font-size: var(--text-md); + letter-spacing: var(--letter-spacing--primary); + line-height: var(--line-height--primary); + width: 100%; +} + +.phpdocumentor h1, +.phpdocumentor h2, +.phpdocumentor h3, +.phpdocumentor h4, +.phpdocumentor h5, +.phpdocumentor h6 { + margin-bottom: var(--spacing-lg); + margin-top: var(--spacing-lg); + font-weight: 600; +} + +.phpdocumentor h1 { + font-size: var(--text-xxxxl); + letter-spacing: var(--letter-spacing--primary); + line-height: 1.2; + margin-top: 0; +} + +.phpdocumentor h2 { + font-size: var(--text-xxxl); + letter-spacing: var(--letter-spacing--primary); + line-height: 1.25; +} + +.phpdocumentor h3 { + font-size: var(--text-xxl); + letter-spacing: var(--letter-spacing--primary); + line-height: 1.3; +} + +.phpdocumentor h4 { + font-size: var(--text-xl); + letter-spacing: calc(var(--letter-spacing--primary) / 2); + line-height: 1.35; + margin-bottom: var(--spacing-md); +} + +.phpdocumentor h5 { + font-size: var(--text-lg); + letter-spacing: calc(var(--letter-spacing--primary) / 4); + line-height: 1.5; + margin-bottom: var(--spacing-md); + margin-top: var(--spacing-md); +} + +.phpdocumentor h6 { + font-size: var(--text-md); + letter-spacing: 0; + line-height: var(--line-height--primary); + margin-bottom: var(--spacing-md); + margin-top: var(--spacing-md); +} +.phpdocumentor h1 .headerlink, +.phpdocumentor h2 .headerlink, +.phpdocumentor h3 .headerlink, +.phpdocumentor h4 .headerlink, +.phpdocumentor h5 .headerlink, +.phpdocumentor h6 .headerlink +{ + display: none; +} + +@media (min-width: 550px) { + .phpdocumentor h1 .headerlink, + .phpdocumentor h2 .headerlink, + .phpdocumentor h3 .headerlink, + .phpdocumentor h4 .headerlink, + .phpdocumentor h5 .headerlink, + .phpdocumentor h6 .headerlink { + display: inline; + transition: all .3s ease-in-out; + opacity: 0; + text-decoration: none; + color: silver; + font-size: 80%; + } + + .phpdocumentor h1:hover .headerlink, + .phpdocumentor h2:hover .headerlink, + .phpdocumentor h3:hover .headerlink, + .phpdocumentor h4:hover .headerlink, + .phpdocumentor h5:hover .headerlink, + .phpdocumentor h6:hover .headerlink { + opacity: 1; + } +} +.phpdocumentor p { + margin-top: 0; + margin-bottom: var(--spacing-md); +} +.phpdocumentor figure { + margin-bottom: var(--spacing-md); +} + +.phpdocumentor figcaption { + text-align: center; + font-style: italic; + font-size: 80%; +} + +.phpdocumentor-uml-diagram svg { + max-width: 100%; + height: auto !important; +} +.phpdocumentor-line { + border-top: 1px solid #E1E1E1; + border-width: 0; + margin-bottom: var(--spacing-xxl); + margin-top: var(--spacing-xxl); +} +.phpdocumentor-section { + box-sizing: border-box; + margin: 0 auto; + max-width: var(--container-width); + padding: 0 var(--spacing-sm); + position: relative; + width: 100%; +} + +@media (min-width: 550px) { + .phpdocumentor-section { + padding: 0 var(--spacing-lg); + } +} + +@media (min-width: 1200px) { + .phpdocumentor-section { + padding: 0; + width: 95%; + } +} +.phpdocumentor-column { + box-sizing: border-box; + float: left; + width: 100%; +} + +@media (min-width: 550px) { + .phpdocumentor-column { + margin-left: 4%; + } + + .phpdocumentor-column:first-child { + margin-left: 0; + } + + .-one.phpdocumentor-column { + width: 4.66666666667%; + } + + .-two.phpdocumentor-column { + width: 13.3333333333%; + } + + .-three.phpdocumentor-column { + width: 22%; + } + + .-four.phpdocumentor-column { + width: 30.6666666667%; + } + + .-five.phpdocumentor-column { + width: 39.3333333333%; + } + + .-six.phpdocumentor-column { + width: 48%; + } + + .-seven.phpdocumentor-column { + width: 56.6666666667%; + } + + .-eight.phpdocumentor-column { + width: 65.3333333333%; + } + + .-nine.phpdocumentor-column { + width: 74.0%; + } + + .-ten.phpdocumentor-column { + width: 82.6666666667%; + } + + .-eleven.phpdocumentor-column { + width: 91.3333333333%; + } + + .-twelve.phpdocumentor-column { + margin-left: 0; + width: 100%; + } + + .-one-third.phpdocumentor-column { + width: 30.6666666667%; + } + + .-two-thirds.phpdocumentor-column { + width: 65.3333333333%; + } + + .-one-half.phpdocumentor-column { + width: 48%; + } + + /* Offsets */ + .-offset-by-one.phpdocumentor-column { + margin-left: 8.66666666667%; + } + + .-offset-by-two.phpdocumentor-column { + margin-left: 17.3333333333%; + } + + .-offset-by-three.phpdocumentor-column { + margin-left: 26%; + } + + .-offset-by-four.phpdocumentor-column { + margin-left: 34.6666666667%; + } + + .-offset-by-five.phpdocumentor-column { + margin-left: 43.3333333333%; + } + + .-offset-by-six.phpdocumentor-column { + margin-left: 52%; + } + + .-offset-by-seven.phpdocumentor-column { + margin-left: 60.6666666667%; + } + + .-offset-by-eight.phpdocumentor-column { + margin-left: 69.3333333333%; + } + + .-offset-by-nine.phpdocumentor-column { + margin-left: 78.0%; + } + + .-offset-by-ten.phpdocumentor-column { + margin-left: 86.6666666667%; + } + + .-offset-by-eleven.phpdocumentor-column { + margin-left: 95.3333333333%; + } + + .-offset-by-one-third.phpdocumentor-column { + margin-left: 34.6666666667%; + } + + .-offset-by-two-thirds.phpdocumentor-column { + margin-left: 69.3333333333%; + } + + .-offset-by-one-half.phpdocumentor-column { + margin-left: 52%; + } +} +.phpdocumentor a { + color: var(--link-color-primary); +} + +.phpdocumentor a:hover { + color: var(--link-hover-color-primary); +} +.phpdocumentor-button { + background-color: var(--button-color); + border: 1px solid var(--button-border-color); + border-radius: var(--border-radius-base-size); + box-sizing: border-box; + color: var(--button-text-color); + cursor: pointer; + display: inline-block; + font-size: var(--text-sm); + font-weight: 600; + height: 38px; + letter-spacing: .1rem; + line-height: 38px; + padding: 0 var(--spacing-xxl); + text-align: center; + text-decoration: none; + text-transform: uppercase; + white-space: nowrap; + margin-bottom: var(--spacing-md); +} + +.phpdocumentor-button .-wide { + width: 100%; +} + +.phpdocumentor-button:hover, +.phpdocumentor-button:focus { + border-color: #888; + color: #333; + outline: 0; +} + +.phpdocumentor-button.-primary { + background-color: var(--button-color-primary); + border-color: var(--button-color-primary); + color: var(--button-text-color-primary); +} + +.phpdocumentor-button.-primary:hover, +.phpdocumentor-button.-primary:focus { + background-color: var(--link-color-primary); + border-color: var(--link-color-primary); + color: var(--button-text-color-primary); +} +.phpdocumentor form { + margin-bottom: var(--spacing-md); +} + +.phpdocumentor-field { + background-color: var(--form-field-color); + border: 1px solid var(--form-field-border-color); + border-radius: var(--border-radius-base-size); + box-shadow: none; + box-sizing: border-box; + height: 38px; + padding: var(--spacing-xxxs) var(--spacing-xxs); /* The 6px vertically centers text on FF, ignored by Webkit */ + margin-bottom: var(--spacing-md); +} + +/* Removes awkward default styles on some inputs for iOS */ +input[type="email"], +input[type="number"], +input[type="search"], +input[type="text"], +input[type="tel"], +input[type="url"], +input[type="password"], +textarea { + -moz-appearance: none; + -webkit-appearance: none; + appearance: none; +} + +.phpdocumentor-textarea { + min-height: 65px; + padding-bottom: var(--spacing-xxxs); + padding-top: var(--spacing-xxxs); +} + +.phpdocumentor-field:focus { + border: 1px solid var(--button-color-primary); + outline: 0; +} + +label.phpdocumentor-label { + display: block; + margin-bottom: var(--spacing-xs); +} + +.phpdocumentor-fieldset { + border-width: 0; + padding: 0; +} + +input[type="checkbox"].phpdocumentor-field, +input[type="radio"].phpdocumentor-field { + display: inline; +} +.phpdocumentor-column ul, +div.phpdocumentor-list > ul, +ul.phpdocumentor-list { + list-style: circle; +} + +.phpdocumentor-column ol, +div.phpdocumentor-list > ol, +ol.phpdocumentor-list { + list-style: decimal; +} + + +.phpdocumentor-column ul, +div.phpdocumentor-list > ul, +ol.phpdocumentor-list, +ul.phpdocumentor-list { + margin-top: 0; + padding-left: var(--spacing-md); + margin-bottom: var(--spacing-sm); +} + +.phpdocumentor-column ul.-clean, +div.phpdocumentor-list > ul.-clean, +ul.phpdocumentor-list.-clean { + list-style: none; + padding-left: 0; +} + +dl { + margin-bottom: var(--spacing-md); +} + +.phpdocumentor-column ul ul, +div.phpdocumentor-list > ul ul, +ul.phpdocumentor-list ul.phpdocumentor-list, +ul.phpdocumentor-list ol.phpdocumentor-list, +ol.phpdocumentor-list ol.phpdocumentor-list, +ol.phpdocumentor-list ul.phpdocumentor-list { + font-size: var(--text-sm); + margin: 0 0 0 calc(var(--spacing-xs) * 2); +} + +.phpdocumentor-column ul li, +.phpdocumentor-list li { + padding-bottom: var(--spacing-xs); +} + +.phpdocumentor dl dt { + margin-bottom: var(--spacing-xs); +} + +.phpdocumentor dl dd { + margin-bottom: var(--spacing-md); +} +.phpdocumentor pre { + margin-bottom: var(--spacing-md); +} + +.phpdocumentor-code { + font-family: var(--font-monospace); + background: var(--code-background-color); + border: 1px solid var(--code-border-color); + border-radius: var(--border-radius-base-size); + font-size: var(--text-sm); + padding: var(--spacing-sm) var(--spacing-md); + width: 100%; + box-sizing: border-box; +} + +.phpdocumentor-code.-dark { + background: var(--primary-color-darkest); + color: var(--light-gray); + box-shadow: 0 2px 3px var(--dark-gray); +} + +pre > .phpdocumentor-code { + display: block; + white-space: pre; +} +.phpdocumentor blockquote { + border-left: 4px solid var(--primary-color-darken); + margin: var(--spacing-md) 0; + padding: var(--spacing-xs) var(--spacing-sm); + color: var(--primary-color-darker); + font-style: italic; +} + +.phpdocumentor blockquote p:last-of-type { + margin-bottom: 0; +} +.phpdocumentor table { + margin-bottom: var(--spacing-md); +} + +th.phpdocumentor-heading, +td.phpdocumentor-cell { + border-bottom: 1px solid var(--table-separator-color); + padding: var(--spacing-sm) var(--spacing-md); + text-align: left; +} + +th.phpdocumentor-heading:first-child, +td.phpdocumentor-cell:first-child { + padding-left: 0; +} + +th.phpdocumentor-heading:last-child, +td.phpdocumentor-cell:last-child { + padding-right: 0; +} +.phpdocumentor-label-line { + display: flex; + flex-direction: row; + gap: 1rem +} + +.phpdocumentor-label { + background: #f6f6f6; + border-radius: .25rem; + font-size: 80%; + display: inline-block; + overflow: hidden +} + +/* +It would be better if the phpdocumentor-element class were to become a flex element with a gap, but for #3337 that +is too big a fix and needs to be done in a new design iteration. +*/ +.phpdocumentor-signature + .phpdocumentor-label-line .phpdocumentor-label { + margin-top: var(--spacing-sm); +} + +.phpdocumentor-label span { + display: inline-block; + padding: .125rem .5rem; +} + +.phpdocumentor-label--success span:last-of-type { + background: #abe1ab; +} + +.phpdocumentor-header { + display: flex; + flex-direction: row; + align-items: stretch; + flex-wrap: wrap; + justify-content: space-between; + height: auto; + padding: var(--spacing-md) var(--spacing-md); +} + +.phpdocumentor-header__menu-button { + position: absolute; + top: -100%; + left: -100%; +} + +.phpdocumentor-header__menu-icon { + font-size: 2rem; + color: var(--primary-color); +} + +.phpdocumentor-header__menu-button:checked ~ .phpdocumentor-topnav { + max-height: 250px; + padding-top: var(--spacing-md); +} + +@media (min-width: 1000px) { + .phpdocumentor-header { + flex-direction: row; + padding: var(--spacing-lg) var(--spacing-lg); + min-height: var(--header-height); + } + + .phpdocumentor-header__menu-icon { + display: none; + } +} + +@media (min-width: 1000px) { + .phpdocumentor-header { + padding-top: 0; + padding-bottom: 0; + } +} +@media (min-width: 1200px) { + .phpdocumentor-header { + padding: 0; + } +} +.phpdocumentor-title { + box-sizing: border-box; + color: var(--title-text-color); + font-size: var(--text-xxl); + letter-spacing: .05rem; + font-weight: normal; + width: auto; + margin: 0; + display: flex; + align-items: center; +} + +.phpdocumentor-title.-without-divider { + border: none; +} + +.phpdocumentor-title__link { + transition: all .3s ease-out; + display: flex; + color: var(--title-text-color); + text-decoration: none; + font-weight: normal; + white-space: nowrap; + transform: scale(.75); + transform-origin: left; +} + +.phpdocumentor-title__link:hover { + transform: perspective(15rem) translateX(.5rem); + font-weight: 600; +} + +@media (min-width: 1000px) { + .phpdocumentor-title { + width: 22%; + border-right: var(--sidebar-border-color) solid 1px; + } + + .phpdocumentor-title__link { + transform-origin: left; + } +} + +@media (min-width: 1000px) { + .phpdocumentor-title__link { + transform: scale(.85); + } +} + +@media (min-width: 1200px) { + .phpdocumentor-title__link { + transform: scale(1); + } +} +.phpdocumentor-topnav { + display: flex; + align-items: center; + margin: 0; + max-height: 0; + overflow: hidden; + transition: max-height 0.2s ease-out; + flex-basis: 100%; +} + +.phpdocumentor-topnav__menu { + text-align: right; + list-style: none; + margin: 0; + padding: 0; + flex: 1; + display: flex; + flex-flow: row wrap; + justify-content: center; +} + +.phpdocumentor-topnav__menu-item { + margin: 0; + width: 100%; + display: inline-block; + text-align: center; + padding: var(--spacing-sm) 0 +} + +.phpdocumentor-topnav__menu-item.-social { + width: auto; + padding: var(--spacing-sm) +} + +.phpdocumentor-topnav__menu-item a { + display: inline-block; + color: var(--text-color); + text-decoration: none; + font-size: var(--text-lg); + transition: all .3s ease-out; + border-bottom: 1px dotted transparent; + line-height: 1; +} + +.phpdocumentor-topnav__menu-item a:hover { + transform: perspective(15rem) translateY(.1rem); + border-bottom: 1px dotted var(--text-color); +} + +@media (min-width: 1000px) { + .phpdocumentor-topnav { + max-height: none; + overflow: visible; + flex-basis: auto; + } + + .phpdocumentor-topnav__menu { + display: flex; + flex-flow: row wrap; + justify-content: flex-end; + } + + .phpdocumentor-topnav__menu-item, + .phpdocumentor-topnav__menu-item.-social { + width: auto; + display: inline; + text-align: right; + padding: 0 0 0 var(--spacing-md) + } +} +.phpdocumentor-sidebar { + margin: 0; + overflow: hidden; + max-height: 0; +} + +.phpdocumentor .phpdocumentor-sidebar .phpdocumentor-list { + padding: var(--spacing-xs) var(--spacing-md); + list-style: none; + margin: 0; +} + +.phpdocumentor .phpdocumentor-sidebar li { + white-space: nowrap; + text-overflow: ellipsis; + overflow: hidden; + padding: 0 0 var(--spacing-xxxs) var(--spacing-md); +} + +.phpdocumentor .phpdocumentor-sidebar abbr, +.phpdocumentor .phpdocumentor-sidebar a { + text-decoration: none; + border-bottom: none; + color: var(--text-color); + font-size: var(--text-md); + padding-left: 0; + transition: padding-left .4s ease-out; +} + +.phpdocumentor .phpdocumentor-sidebar a:hover, +.phpdocumentor .phpdocumentor-sidebar a.-active { + padding-left: 5px; + font-weight: 600; +} + +.phpdocumentor .phpdocumentor-sidebar__category > * { + border-left: 1px solid var(--primary-color-lighten); +} + +.phpdocumentor .phpdocumentor-sidebar__category { + margin-bottom: var(--spacing-lg); +} + +.phpdocumentor .phpdocumentor-sidebar__category-header { + font-size: var(--text-md); + margin-top: 0; + margin-bottom: var(--spacing-xs); + color: var(--link-color-primary); + font-weight: 600; + border-left: 0; +} + +.phpdocumentor .phpdocumentor-sidebar__root-package, +.phpdocumentor .phpdocumentor-sidebar__root-namespace { + font-size: var(--text-md); + margin: 0; + padding-top: var(--spacing-xs); + padding-left: var(--spacing-md); + color: var(--text-color); + font-weight: normal; +} + +@media (min-width: 550px) { + .phpdocumentor-sidebar { + border-right: var(--sidebar-border-color) solid 1px; + } +} + +.phpdocumentor-sidebar__menu-button { + position: absolute; + top: -100%; + left: -100%; +} + +.phpdocumentor-sidebar__menu-icon { + font-size: var(--text-md); + font-weight: 600; + background: var(--primary-color); + color: white; + margin: 0 0 var(--spacing-lg); + display: block; + padding: var(--spacing-sm); + text-align: center; + border-radius: 3px; + text-transform: uppercase; + letter-spacing: .15rem; +} + +.phpdocumentor-sidebar__menu-button:checked ~ .phpdocumentor-sidebar { + max-height: 100%; + padding-top: var(--spacing-md); +} + +@media (min-width: 550px) { + .phpdocumentor-sidebar { + overflow: visible; + max-height: 100%; + } + + .phpdocumentor-sidebar__menu-icon { + display: none; + } +} +.phpdocumentor-admonition { + border: 1px solid var(--admonition-border-color); + border-radius: var(--border-radius-base-size); + border-color: var(--primary-color-lighten); + background-color: var(--primary-color-lighter); + padding: var(--spacing-lg); + margin: var(--spacing-lg) 0; + display: flex; + flex-direction: row; + align-items: flex-start; +} + +.phpdocumentor-admonition p:last-of-type { + margin-bottom: 0; +} + +.phpdocumentor-admonition--success, +.phpdocumentor-admonition.-success { + border-color: var(--admonition-success-color); +} + +.phpdocumentor-admonition__icon { + margin-right: var(--spacing-md); + color: var(--primary-color); + max-width: 3rem; +} +.phpdocumentor ul.phpdocumentor-breadcrumbs { + font-size: var(--text-md); + list-style: none; + margin: 0; + padding: 0; +} + +.phpdocumentor ul.phpdocumentor-breadcrumbs a { + color: var(--text-color); + text-decoration: none; +} + +.phpdocumentor ul.phpdocumentor-breadcrumbs > li { + display: inline-block; + margin: 0; +} + +.phpdocumentor ul.phpdocumentor-breadcrumbs > li + li:before { + color: var(--dark-gray); + content: "\\\A0"; + padding: 0; +} +.phpdocumentor .phpdocumentor-back-to-top { + position: fixed; + bottom: 2rem; + font-size: 2.5rem; + opacity: .25; + transition: all .3s ease-in-out; + right: 2rem; +} + +.phpdocumentor .phpdocumentor-back-to-top:hover { + color: var(--link-color-primary); + opacity: 1; +} +.phpdocumentor-search { + position: relative; + display: none; /** disable by default for non-js flow */ + opacity: .3; /** white-out default for loading indication */ + transition: opacity .3s, background .3s; + margin: var(--spacing-sm) 0; + flex: 1; + min-width: 100%; +} + +.phpdocumentor-search label { + display: flex; + align-items: center; + flex: 1; +} + +.phpdocumentor-search__icon { + color: var(--primary-color); + margin-right: var(--spacing-sm); + width: 1rem; + height: 1rem; +} + +.phpdocumentor-search--enabled { + display: flex; +} + +.phpdocumentor-search--active { + opacity: 1; +} + +.phpdocumentor-search input:disabled { + background-color: lightgray; +} + +.phpdocumentor-search__field:focus, +.phpdocumentor-search__field { + margin-bottom: 0; + border: 0; + border-bottom: 2px solid var(--primary-color); + padding: 0; + border-radius: 0; + flex: 1; +} + +@media (min-width: 1000px) { + .phpdocumentor-search { + min-width: auto; + max-width: 20rem; + margin: 0 0 0 auto; + } +} +.phpdocumentor-search-results { + backdrop-filter: blur(5px); + background: var(--popover-background-color); + position: fixed; + top: 0; + left: 0; + right: 0; + bottom: 0; + padding: 0; + opacity: 1; + pointer-events: all; + + transition: opacity .3s, background .3s; +} + +.phpdocumentor-search-results--hidden { + background: transparent; + backdrop-filter: blur(0); + opacity: 0; + pointer-events: none; +} + +.phpdocumentor-search-results__dialog { + width: 100%; + background: white; + max-height: 100%; + display: flex; + flex-direction: column; +} + +.phpdocumentor-search-results__body { + overflow: auto; +} + +.phpdocumentor-search-results__header { + padding: var(--spacing-lg); + display: flex; + justify-content: space-between; + background: var(--primary-color-darken); + color: white; + align-items: center; +} + +.phpdocumentor-search-results__close { + font-size: var(--text-xl); + background: none; + border: none; + padding: 0; + margin: 0; +} + +.phpdocumentor .phpdocumentor-search-results__title { + font-size: var(--text-xl); + margin-bottom: 0; +} + +.phpdocumentor-search-results__entries { + list-style: none; + padding: 0 var(--spacing-lg); + margin: 0; +} + +.phpdocumentor-search-results__entry { + border-bottom: 1px solid var(--table-separator-color); + padding: var(--spacing-sm) 0; + text-align: left; +} + +.phpdocumentor-search-results__entry a { + display: block; +} + +.phpdocumentor-search-results__entry small { + margin-top: var(--spacing-xs); + margin-bottom: var(--spacing-md); + color: var(--primary-color-darker); + display: block; + word-break: break-word; +} + +.phpdocumentor-search-results__entry h3 { + font-size: var(--text-lg); + margin: 0; +} + +@media (min-width: 550px) { + .phpdocumentor-search-results { + padding: 0 var(--spacing-lg); + } + + .phpdocumentor-search-results__entry h3 { + font-size: var(--text-xxl); + } + + .phpdocumentor-search-results__dialog { + margin: var(--spacing-xl) auto; + max-width: 40rem; + background: white; + border: 1px solid silver; + box-shadow: 0 2px 5px silver; + max-height: 40rem; + border-radius: 3px; + } +} +.phpdocumentor-modal { + position: fixed; + width: 100vw; + height: 100vh; + opacity: 0; + visibility: hidden; + transition: all 0.3s ease; + top: 0; + left: 0; + display: flex; + align-items: center; + justify-content: center; + z-index: 1; +} + +.phpdocumentor-modal__open { + visibility: visible; + opacity: 1; + transition-delay: 0s; +} + +.phpdocumentor-modal-bg { + position: absolute; + background: gray; + opacity: 50%; + width: 100%; + height: 100%; +} + +.phpdocumentor-modal-container { + border-radius: 1em; + background: #fff; + position: relative; + padding: 2em; + box-sizing: border-box; + max-width:100vw; +} + +.phpdocumentor-modal__close { + position: absolute; + right: 0.75em; + top: 0.75em; + outline: none; + appearance: none; + color: var(--primary-color); + background: none; + border: 0px; + font-weight: bold; + cursor: pointer; +} +.phpdocumentor-on-this-page__sidebar { + display: none; +} + +.phpdocumentor-on-this-page__title { + display: block; + font-weight: bold; + margin-bottom: var(--spacing-sm); + color: var(--link-color-primary); +} + +@media (min-width: 1000px) { + .phpdocumentor-on-this-page__sidebar { + display: block; + position: relative; + } + + .phpdocumentor-on-this-page__content::-webkit-scrollbar, + [scrollbars]::-webkit-scrollbar { + height: 8px; + width: 8px; + } + + .phpdocumentor-on-this-page__content::-webkit-scrollbar-corner, + [scrollbars]::-webkit-scrollbar-corner { + background: 0; + } + + .phpdocumentor-on-this-page__content::-webkit-scrollbar-thumb, + [scrollbars]::-webkit-scrollbar-thumb { + background: rgba(128,134,139,0.26); + border-radius: 8px; + } + + .phpdocumentor-on-this-page__content { + position: sticky; + height: calc(100vh - var(--header-height)); + overflow-y: auto; + border-left: 1px solid var(--sidebar-border-color); + padding-left: var(--spacing-lg); + font-size: 90%; + top: -1px; /* Needed for the javascript to make the .-stuck trick work */ + flex: 0 1 auto; + width: 15vw; + } + + .phpdocumentor-on-this-page__content.-stuck { + height: 100vh; + } + + .phpdocumentor-on-this-page__content li { + word-break: break-all; + line-height: normal; + } +} + +/* Used for screen readers and such */ +.visually-hidden { + display: none; +} + +.float-right { + float: right; +} + +.float-left { + float: left; +} diff --git a/docs/css/normalize.css b/docs/css/normalize.css new file mode 100644 index 0000000..653dc00 --- /dev/null +++ b/docs/css/normalize.css @@ -0,0 +1,427 @@ +/*! normalize.css v3.0.2 | MIT License | git.io/normalize */ + +/** + * 1. Set default font family to sans-serif. + * 2. Prevent iOS text size adjust after orientation change, without disabling + * user zoom. + */ + +html { + font-family: sans-serif; /* 1 */ + -ms-text-size-adjust: 100%; /* 2 */ + -webkit-text-size-adjust: 100%; /* 2 */ +} + +/** + * Remove default margin. + */ + +body { + margin: 0; +} + +/* HTML5 display definitions + ========================================================================== */ + +/** + * Correct `block` display not defined for any HTML5 element in IE 8/9. + * Correct `block` display not defined for `details` or `summary` in IE 10/11 + * and Firefox. + * Correct `block` display not defined for `main` in IE 11. + */ + +article, +aside, +details, +figcaption, +figure, +footer, +header, +hgroup, +main, +menu, +nav, +section, +summary { + display: block; +} + +/** + * 1. Correct `inline-block` display not defined in IE 8/9. + * 2. Normalize vertical alignment of `progress` in Chrome, Firefox, and Opera. + */ + +audio, +canvas, +progress, +video { + display: inline-block; /* 1 */ + vertical-align: baseline; /* 2 */ +} + +/** + * Prevent modern browsers from displaying `audio` without controls. + * Remove excess height in iOS 5 devices. + */ + +audio:not([controls]) { + display: none; + height: 0; +} + +/** + * Address `[hidden]` styling not present in IE 8/9/10. + * Hide the `template` element in IE 8/9/11, Safari, and Firefox < 22. + */ + +[hidden], +template { + display: none !important; +} + +/* Links + ========================================================================== */ + +/** + * Remove the gray background color from active links in IE 10. + */ + +a { + background-color: transparent; +} + +/** + * Improve readability when focused and also mouse hovered in all browsers. + */ + +a:active, +a:hover { + outline: 0; +} + +/* Text-level semantics + ========================================================================== */ + +/** + * Address styling not present in IE 8/9/10/11, Safari, and Chrome. + */ + +abbr[title] { + border-bottom: 1px dotted; +} + +/** + * Address style set to `bolder` in Firefox 4+, Safari, and Chrome. + */ + +b, +strong { + font-weight: bold; +} + +/** + * Address styling not present in Safari and Chrome. + */ + +dfn { + font-style: italic; +} + +/** + * Address variable `h1` font-size and margin within `section` and `article` + * contexts in Firefox 4+, Safari, and Chrome. + */ + +h1 { + font-size: 2em; + margin: 0.67em 0; +} + +/** + * Address styling not present in IE 8/9. + */ + +mark { + background: #ff0; + color: #000; +} + +/** + * Address inconsistent and variable font size in all browsers. + */ + +small { + font-size: 80%; +} + +/** + * Prevent `sub` and `sup` affecting `line-height` in all browsers. + */ + +sub, +sup { + font-size: 75%; + line-height: 0; + position: relative; + vertical-align: baseline; +} + +sup { + top: -0.5em; +} + +sub { + bottom: -0.25em; +} + +/* Embedded content + ========================================================================== */ + +/** + * Remove border when inside `a` element in IE 8/9/10. + */ + +img { + border: 0; +} + +/** + * Correct overflow not hidden in IE 9/10/11. + */ + +svg:not(:root) { + overflow: hidden; +} + +/* Grouping content + ========================================================================== */ + +/** + * Address margin not present in IE 8/9 and Safari. + */ + +figure { + margin: 1em 40px; +} + +/** + * Address differences between Firefox and other browsers. + */ + +hr { + -moz-box-sizing: content-box; + box-sizing: content-box; + height: 0; +} + +/** + * Contain overflow in all browsers. + */ + +pre { + overflow: auto; +} + +/** + * Address odd `em`-unit font size rendering in all browsers. + */ + +code, +kbd, +pre, +samp { + font-family: var(--font-monospace); + font-size: 1em; +} + +/* Forms + ========================================================================== */ + +/** + * Known limitation: by default, Chrome and Safari on OS X allow very limited + * styling of `select`, unless a `border` property is set. + */ + +/** + * 1. Correct color not being inherited. + * Known issue: affects color of disabled elements. + * 2. Correct font properties not being inherited. + * 3. Address margins set differently in Firefox 4+, Safari, and Chrome. + */ + +button, +input, +optgroup, +select, +textarea { + color: inherit; /* 1 */ + font: inherit; /* 2 */ + margin: 0; /* 3 */ +} + +/** + * Address `overflow` set to `hidden` in IE 8/9/10/11. + */ + +button { + overflow: visible; +} + +/** + * Address inconsistent `text-transform` inheritance for `button` and `select`. + * All other form control elements do not inherit `text-transform` values. + * Correct `button` style inheritance in Firefox, IE 8/9/10/11, and Opera. + * Correct `select` style inheritance in Firefox. + */ + +button, +select { + text-transform: none; +} + +/** + * 1. Avoid the WebKit bug in Android 4.0.* where (2) destroys native `audio` + * and `video` controls. + * 2. Correct inability to style clickable `input` types in iOS. + * 3. Improve usability and consistency of cursor style between image-type + * `input` and others. + */ + +button, +html input[type="button"], /* 1 */ +input[type="reset"], +input[type="submit"] { + -webkit-appearance: button; /* 2 */ + cursor: pointer; /* 3 */ +} + +/** + * Re-set default cursor for disabled elements. + */ + +button[disabled], +html input[disabled] { + cursor: default; +} + +/** + * Remove inner padding and border in Firefox 4+. + */ + +button::-moz-focus-inner, +input::-moz-focus-inner { + border: 0; + padding: 0; +} + +/** + * Address Firefox 4+ setting `line-height` on `input` using `!important` in + * the UA stylesheet. + */ + +input { + line-height: normal; +} + +/** + * It's recommended that you don't attempt to style these elements. + * Firefox's implementation doesn't respect box-sizing, padding, or width. + * + * 1. Address box sizing set to `content-box` in IE 8/9/10. + * 2. Remove excess padding in IE 8/9/10. + */ + +input[type="checkbox"], +input[type="radio"] { + box-sizing: border-box; /* 1 */ + padding: 0; /* 2 */ +} + +/** + * Fix the cursor style for Chrome's increment/decrement buttons. For certain + * `font-size` values of the `input`, it causes the cursor style of the + * decrement button to change from `default` to `text`. + */ + +input[type="number"]::-webkit-inner-spin-button, +input[type="number"]::-webkit-outer-spin-button { + height: auto; +} + +/** + * 1. Address `appearance` set to `searchfield` in Safari and Chrome. + * 2. Address `box-sizing` set to `border-box` in Safari and Chrome + * (include `-moz` to future-proof). + */ + +input[type="search"] { + -webkit-appearance: textfield; /* 1 */ + -moz-box-sizing: content-box; + -webkit-box-sizing: content-box; /* 2 */ + box-sizing: content-box; +} + +/** + * Remove inner padding and search cancel button in Safari and Chrome on OS X. + * Safari (but not Chrome) clips the cancel button when the search input has + * padding (and `textfield` appearance). + */ + +input[type="search"]::-webkit-search-cancel-button, +input[type="search"]::-webkit-search-decoration { + -webkit-appearance: none; +} + +/** + * Define consistent border, margin, and padding. + */ + +fieldset { + border: 1px solid #c0c0c0; + margin: 0 2px; + padding: 0.35em 0.625em 0.75em; +} + +/** + * 1. Correct `color` not being inherited in IE 8/9/10/11. + * 2. Remove padding so people aren't caught out if they zero out fieldsets. + */ + +legend { + border: 0; /* 1 */ + padding: 0; /* 2 */ +} + +/** + * Remove default vertical scrollbar in IE 8/9/10/11. + */ + +textarea { + overflow: auto; +} + +/** + * Don't inherit the `font-weight` (applied by a rule above). + * NOTE: the default cannot safely be changed in Chrome and Safari on OS X. + */ + +optgroup { + font-weight: bold; +} + +/* Tables + ========================================================================== */ + +/** + * Remove most spacing between table cells. + */ + +table { + border-collapse: collapse; + border-spacing: 0; +} + +td, +th { + padding: 0; +} diff --git a/docs/css/template.css b/docs/css/template.css new file mode 100644 index 0000000..a389966 --- /dev/null +++ b/docs/css/template.css @@ -0,0 +1,271 @@ + +.phpdocumentor-content { + position: relative; + display: flex; + gap: var(--spacing-md); +} + +.phpdocumentor-content > section:first-of-type { + width: 75%; + flex: 1 1 auto; +} + +@media (min-width: 1900px) { + .phpdocumentor-content > section:first-of-type { + width: 100%; + flex: 1 1 auto; + } +} + +.phpdocumentor .phpdocumentor-content__title { + margin-top: 0; +} +.phpdocumentor-summary { + font-style: italic; +} +.phpdocumentor-description { + margin-bottom: var(--spacing-md); +} +.phpdocumentor-element { + position: relative; +} + +.phpdocumentor-element .phpdocumentor-element { + border: 1px solid var(--primary-color-lighten); + margin-bottom: var(--spacing-md); + padding: var(--spacing-xs); + border-radius: 5px; +} + +.phpdocumentor-element.-deprecated .phpdocumentor-element__name { + text-decoration: line-through; +} + +@media (min-width: 550px) { + .phpdocumentor-element .phpdocumentor-element { + margin-bottom: var(--spacing-lg); + padding: var(--spacing-md); + } +} + +.phpdocumentor-element__modifier { + font-size: var(--text-xxs); + padding: calc(var(--spacing-base-size) / 4) calc(var(--spacing-base-size) / 2); + color: var(--text-color); + background-color: var(--light-gray); + border-radius: 3px; + text-transform: uppercase; +} + +.phpdocumentor .phpdocumentor-elements__header { + margin-top: var(--spacing-xxl); + margin-bottom: var(--spacing-lg); +} + +.phpdocumentor .phpdocumentor-element__name { + line-height: 1; + margin-top: 0; + font-weight: 300; + font-size: var(--text-lg); + word-break: break-all; + margin-bottom: var(--spacing-sm); +} + +@media (min-width: 550px) { + .phpdocumentor .phpdocumentor-element__name { + font-size: var(--text-xl); + margin-bottom: var(--spacing-xs); + } +} + +@media (min-width: 1200px) { + .phpdocumentor .phpdocumentor-element__name { + margin-bottom: var(--spacing-md); + } +} + +.phpdocumentor-element__package, +.phpdocumentor-element__extends, +.phpdocumentor-element__implements { + display: block; + font-size: var(--text-xxs); + font-weight: normal; + opacity: .7; +} + +.phpdocumentor-element__package .phpdocumentor-breadcrumbs { + display: inline; +} +.phpdocumentor .phpdocumentor-signature { + display: block; + font-size: var(--text-sm); + border: 1px solid #f0f0f0; +} + +.phpdocumentor .phpdocumentor-signature.-deprecated .phpdocumentor-signature__name { + text-decoration: line-through; +} + +@media (min-width: 550px) { + .phpdocumentor .phpdocumentor-signature { + margin-left: calc(var(--spacing-xl) * -1); + width: calc(100% + var(--spacing-xl)); + } +} + +.phpdocumentor-table-of-contents { +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry { + margin-bottom: var(--spacing-xxs); + margin-left: 2rem; + display: flex; +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry > a { + flex: 0 1 auto; +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry > span { + flex: 1; + white-space: nowrap; + text-overflow: ellipsis; + overflow: hidden; +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry:after { + content: ''; + height: 12px; + width: 12px; + left: 16px; + position: absolute; +} +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-private:after { + background: url('data:image/svg+xml;utf8,') no-repeat; +} +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-protected:after { + left: 13px; + background: url('data:image/svg+xml;utf8,') no-repeat; +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry:before { + width: 1.25rem; + height: 1.25rem; + line-height: 1.25rem; + background: transparent url('data:image/svg+xml;utf8,') no-repeat center center; + content: ''; + position: absolute; + left: 0; + border-radius: 50%; + font-weight: 600; + color: white; + text-align: center; + font-size: .75rem; + margin-top: .2rem; +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-method:before { + content: 'M'; + color: ''; + background-image: url('data:image/svg+xml;utf8,'); +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-function:before { + content: 'M'; + color: ' 36'; + background-image: url('data:image/svg+xml;utf8,'); +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-property:before { + content: 'P' +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-constant:before { + content: 'C'; + background-color: transparent; + background-image: url('data:image/svg+xml;utf8,'); +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-class:before { + content: 'C' +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-interface:before { + content: 'I' +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-trait:before { + content: 'T' +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-namespace:before { + content: 'N' +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-package:before { + content: 'P' +} + +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-enum:before { + content: 'E' +} + +.phpdocumentor-table-of-contents dd { + font-style: italic; + margin-left: 2rem; +} +.phpdocumentor-element-found-in { + display: none; +} + +@media (min-width: 550px) { + .phpdocumentor-element-found-in { + display: block; + font-size: var(--text-sm); + color: gray; + margin-bottom: 1rem; + } +} + +@media (min-width: 1200px) { + .phpdocumentor-element-found-in { + position: absolute; + top: var(--spacing-sm); + right: var(--spacing-sm); + font-size: var(--text-sm); + margin-bottom: 0; + } +} + +.phpdocumentor-element-found-in .phpdocumentor-element-found-in__source { + flex: 0 1 auto; + display: inline-flex; +} + +.phpdocumentor-element-found-in .phpdocumentor-element-found-in__source:after { + width: 1.25rem; + height: 1.25rem; + line-height: 1.25rem; + background: transparent url('data:image/svg+xml;utf8,') no-repeat center center; + content: ''; + left: 0; + border-radius: 50%; + font-weight: 600; + text-align: center; + font-size: .75rem; + margin-top: .2rem; +} +.phpdocumentor-class-graph { + width: 100%; height: 600px; border:1px solid black; overflow: hidden +} + +.phpdocumentor-class-graph__graph { + width: 100%; +} +.phpdocumentor-tag-list__definition { + display: flex; +} + +.phpdocumentor-tag-link { + margin-right: var(--spacing-sm); +} diff --git a/docs/files/src-datastructures-strictlist.html b/docs/files/src-datastructures-strictlist.html new file mode 100644 index 0000000..9a4ab44 --- /dev/null +++ b/docs/files/src-datastructures-strictlist.html @@ -0,0 +1,347 @@ + + + + + PHP Basics + + + + + + + + + + + + + + + + + + + + + +
                          +

                          PHP Basics

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

                          StrictList.php

                          + +

                          PHP Basics

                          + +

                          Copyright (C) 2024 Sebastian Meyer sebastian.meyer@opencultureconsulting.com

                          +

                          This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version.

                          +

                          This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details.

                          +

                          You should have received a copy of the GNU General Public License +along with this program. If not, see http://www.gnu.org/licenses/.

                          +
                          + + + + + +

                          + Table of Contents + + +

                          + + + + +

                          + Classes + + +

                          +
                          +
                          StrictList
                          A type-sensitive, taversable list.
                          + + + + + + + + + + + + + +
                          +
                          +
                          +
                          +
                          
                          +        
                          + +
                          +
                          + + + +
                          +
                          +
                          + +
                          + On this page + +
                            +
                          • Table Of Contents
                          • +
                          • + +
                          • + + +
                          +
                          + +
                          +
                          +
                          +
                          +
                          +

                          Search results

                          + +
                          +
                          +
                            +
                            +
                            +
                            +
                            + + +
                            + + + + + + + + diff --git a/docs/files/src-datastructures-strictqueue.html b/docs/files/src-datastructures-strictqueue.html new file mode 100644 index 0000000..c6d8f2e --- /dev/null +++ b/docs/files/src-datastructures-strictqueue.html @@ -0,0 +1,347 @@ + + + + + PHP Basics + + + + + + + + + + + + + + + + + + + + + +
                            +

                            PHP Basics

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

                            StrictQueue.php

                            + +

                            PHP Basics

                            + +

                            Copyright (C) 2024 Sebastian Meyer sebastian.meyer@opencultureconsulting.com

                            +

                            This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version.

                            +

                            This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details.

                            +

                            You should have received a copy of the GNU General Public License +along with this program. If not, see http://www.gnu.org/licenses/.

                            +
                            + + + + + +

                            + Table of Contents + + +

                            + + + + +

                            + Classes + + +

                            +
                            +
                            StrictQueue
                            A type-sensitive, taversable First In, First Out queue (FIFO).
                            + + + + + + + + + + + + + +
                            +
                            +
                            +
                            +
                            
                            +        
                            + +
                            +
                            + + + +
                            +
                            +
                            + +
                            + On this page + +
                              +
                            • Table Of Contents
                            • +
                            • + +
                            • + + +
                            +
                            + +
                            +
                            +
                            +
                            +
                            +

                            Search results

                            + +
                            +
                            +
                              +
                              +
                              +
                              +
                              + + +
                              + + + + + + + + diff --git a/docs/files/src-datastructures-strictstack.html b/docs/files/src-datastructures-strictstack.html new file mode 100644 index 0000000..11e3dc1 --- /dev/null +++ b/docs/files/src-datastructures-strictstack.html @@ -0,0 +1,347 @@ + + + + + PHP Basics + + + + + + + + + + + + + + + + + + + + + +
                              +

                              PHP Basics

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

                              StrictStack.php

                              + +

                              PHP Basics

                              + +

                              Copyright (C) 2024 Sebastian Meyer sebastian.meyer@opencultureconsulting.com

                              +

                              This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version.

                              +

                              This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details.

                              +

                              You should have received a copy of the GNU General Public License +along with this program. If not, see http://www.gnu.org/licenses/.

                              +
                              + + + + + +

                              + Table of Contents + + +

                              + + + + +

                              + Classes + + +

                              +
                              +
                              StrictStack
                              A type-sensitive, taversable Last In, First Out stack (LIFO).
                              + + + + + + + + + + + + + +
                              +
                              +
                              +
                              +
                              
                              +        
                              + +
                              +
                              + + + +
                              +
                              +
                              + +
                              + On this page + +
                                +
                              • Table Of Contents
                              • +
                              • + +
                              • + + +
                              +
                              + +
                              +
                              +
                              +
                              +
                              +

                              Search results

                              + +
                              +
                              +
                                +
                                +
                                +
                                +
                                + + +
                                + + + + + + + + diff --git a/docs/files/src-errorhandlers-throwerrorexception.html b/docs/files/src-errorhandlers-throwerrorexception.html new file mode 100644 index 0000000..f471697 --- /dev/null +++ b/docs/files/src-errorhandlers-throwerrorexception.html @@ -0,0 +1,347 @@ + + + + + PHP Basics + + + + + + + + + + + + + + + + + + + + + +
                                +

                                PHP Basics

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

                                ThrowErrorException.php

                                + +

                                PHP Basics

                                + +

                                Copyright (C) 2024 Sebastian Meyer sebastian.meyer@opencultureconsulting.com

                                +

                                This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version.

                                +

                                This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details.

                                +

                                You should have received a copy of the GNU General Public License +along with this program. If not, see http://www.gnu.org/licenses/.

                                +
                                + + + + + +

                                + Table of Contents + + +

                                + + + + +

                                + Classes + + +

                                +
                                +
                                ThrowErrorException
                                Throw internal errors as exceptions.
                                + + + + + + + + + + + + + +
                                +
                                +
                                +
                                +
                                
                                +        
                                + +
                                +
                                + + + +
                                +
                                +
                                + +
                                + On this page + +
                                  +
                                • Table Of Contents
                                • +
                                • + +
                                • + + +
                                +
                                + +
                                +
                                +
                                +
                                +
                                +

                                Search results

                                + +
                                +
                                +
                                  +
                                  +
                                  +
                                  +
                                  + + +
                                  + + + + + + + + diff --git a/docs/files/src-errorhandlers-triggerexceptionerror.html b/docs/files/src-errorhandlers-triggerexceptionerror.html new file mode 100644 index 0000000..ff3a078 --- /dev/null +++ b/docs/files/src-errorhandlers-triggerexceptionerror.html @@ -0,0 +1,347 @@ + + + + + PHP Basics + + + + + + + + + + + + + + + + + + + + + +
                                  +

                                  PHP Basics

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

                                  TriggerExceptionError.php

                                  + +

                                  PHP Basics

                                  + +

                                  Copyright (C) 2024 Sebastian Meyer sebastian.meyer@opencultureconsulting.com

                                  +

                                  This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version.

                                  +

                                  This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details.

                                  +

                                  You should have received a copy of the GNU General Public License +along with this program. If not, see http://www.gnu.org/licenses/.

                                  +
                                  + + + + + +

                                  + Table of Contents + + +

                                  + + + + +

                                  + Classes + + +

                                  +
                                  +
                                  TriggerExceptionError
                                  Trigger errors for uncaught exceptions.
                                  + + + + + + + + + + + + + +
                                  +
                                  +
                                  +
                                  +
                                  
                                  +        
                                  + +
                                  +
                                  + + + +
                                  +
                                  +
                                  + +
                                  + On this page + +
                                    +
                                  • Table Of Contents
                                  • +
                                  • + +
                                  • + + +
                                  +
                                  + +
                                  +
                                  +
                                  +
                                  +
                                  +

                                  Search results

                                  + +
                                  +
                                  +
                                    +
                                    +
                                    +
                                    +
                                    + + +
                                    + + + + + + + + diff --git a/docs/files/src-interfacetraits-arrayaccesstrait.html b/docs/files/src-interfacetraits-arrayaccesstrait.html new file mode 100644 index 0000000..1e7485c --- /dev/null +++ b/docs/files/src-interfacetraits-arrayaccesstrait.html @@ -0,0 +1,347 @@ + + + + + PHP Basics + + + + + + + + + + + + + + + + + + + + + +
                                    +

                                    PHP Basics

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

                                    ArrayAccessTrait.php

                                    + +

                                    PHP Basics

                                    + +

                                    Copyright (C) 2024 Sebastian Meyer sebastian.meyer@opencultureconsulting.com

                                    +

                                    This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version.

                                    +

                                    This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details.

                                    +

                                    You should have received a copy of the GNU General Public License +along with this program. If not, see http://www.gnu.org/licenses/.

                                    +
                                    + + + + + +

                                    + Table of Contents + + +

                                    + + + + + +

                                    + Traits + + +

                                    +
                                    +
                                    ArrayAccessTrait
                                    A generic implementation of the ArrayAccess interface.
                                    + + + + + + + + + + + + +
                                    +
                                    +
                                    +
                                    +
                                    
                                    +        
                                    + +
                                    +
                                    + + + +
                                    +
                                    +
                                    + +
                                    + On this page + +
                                      +
                                    • Table Of Contents
                                    • +
                                    • + +
                                    • + + +
                                    +
                                    + +
                                    +
                                    +
                                    +
                                    +
                                    +

                                    Search results

                                    + +
                                    +
                                    +
                                      +
                                      +
                                      +
                                      +
                                      + + +
                                      + + + + + + + + diff --git a/docs/files/src-interfacetraits-countabletrait.html b/docs/files/src-interfacetraits-countabletrait.html new file mode 100644 index 0000000..9f45b0b --- /dev/null +++ b/docs/files/src-interfacetraits-countabletrait.html @@ -0,0 +1,347 @@ + + + + + PHP Basics + + + + + + + + + + + + + + + + + + + + + +
                                      +

                                      PHP Basics

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

                                      CountableTrait.php

                                      + +

                                      PHP Basics

                                      + +

                                      Copyright (C) 2024 Sebastian Meyer sebastian.meyer@opencultureconsulting.com

                                      +

                                      This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version.

                                      +

                                      This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details.

                                      +

                                      You should have received a copy of the GNU General Public License +along with this program. If not, see http://www.gnu.org/licenses/.

                                      +
                                      + + + + + +

                                      + Table of Contents + + +

                                      + + + + + +

                                      + Traits + + +

                                      +
                                      +
                                      CountableTrait
                                      A generic implementation of the Countable interface.
                                      + + + + + + + + + + + + +
                                      +
                                      +
                                      +
                                      +
                                      
                                      +        
                                      + +
                                      +
                                      + + + +
                                      +
                                      +
                                      + +
                                      + On this page + +
                                        +
                                      • Table Of Contents
                                      • +
                                      • + +
                                      • + + +
                                      +
                                      + +
                                      +
                                      +
                                      +
                                      +
                                      +

                                      Search results

                                      + +
                                      +
                                      +
                                        +
                                        +
                                        +
                                        +
                                        + + +
                                        + + + + + + + + diff --git a/docs/files/src-interfacetraits-iteratoraggregatetrait.html b/docs/files/src-interfacetraits-iteratoraggregatetrait.html new file mode 100644 index 0000000..0e106f0 --- /dev/null +++ b/docs/files/src-interfacetraits-iteratoraggregatetrait.html @@ -0,0 +1,347 @@ + + + + + PHP Basics + + + + + + + + + + + + + + + + + + + + + +
                                        +

                                        PHP Basics

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

                                        IteratorAggregateTrait.php

                                        + +

                                        PHP Basics

                                        + +

                                        Copyright (C) 2024 Sebastian Meyer sebastian.meyer@opencultureconsulting.com

                                        +

                                        This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version.

                                        +

                                        This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details.

                                        +

                                        You should have received a copy of the GNU General Public License +along with this program. If not, see http://www.gnu.org/licenses/.

                                        +
                                        + + + + + +

                                        + Table of Contents + + +

                                        + + + + + +

                                        + Traits + + +

                                        +
                                        +
                                        IteratorAggregateTrait
                                        A generic implementation of the IteratorAggregate interface.
                                        + + + + + + + + + + + + +
                                        +
                                        +
                                        +
                                        +
                                        
                                        +        
                                        + +
                                        +
                                        + + + +
                                        +
                                        +
                                        + +
                                        + On this page + +
                                          +
                                        • Table Of Contents
                                        • +
                                        • + +
                                        • + + +
                                        +
                                        + +
                                        +
                                        +
                                        +
                                        +
                                        +

                                        Search results

                                        + +
                                        +
                                        +
                                          +
                                          +
                                          +
                                          +
                                          + + +
                                          + + + + + + + + diff --git a/docs/files/src-interfacetraits-iteratortrait.html b/docs/files/src-interfacetraits-iteratortrait.html new file mode 100644 index 0000000..4480d96 --- /dev/null +++ b/docs/files/src-interfacetraits-iteratortrait.html @@ -0,0 +1,347 @@ + + + + + PHP Basics + + + + + + + + + + + + + + + + + + + + + +
                                          +

                                          PHP Basics

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

                                          IteratorTrait.php

                                          + +

                                          PHP Basics

                                          + +

                                          Copyright (C) 2024 Sebastian Meyer sebastian.meyer@opencultureconsulting.com

                                          +

                                          This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version.

                                          +

                                          This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details.

                                          +

                                          You should have received a copy of the GNU General Public License +along with this program. If not, see http://www.gnu.org/licenses/.

                                          +
                                          + + + + + +

                                          + Table of Contents + + +

                                          + + + + + +

                                          + Traits + + +

                                          +
                                          +
                                          IteratorTrait
                                          A generic implementation of the Iterator interface.
                                          + + + + + + + + + + + + +
                                          +
                                          +
                                          +
                                          +
                                          
                                          +        
                                          + +
                                          +
                                          + + + +
                                          +
                                          +
                                          + +
                                          + On this page + +
                                            +
                                          • Table Of Contents
                                          • +
                                          • + +
                                          • + + +
                                          +
                                          + +
                                          +
                                          +
                                          +
                                          +
                                          +

                                          Search results

                                          + +
                                          +
                                          +
                                            +
                                            +
                                            +
                                            +
                                            + + +
                                            + + + + + + + + diff --git a/docs/files/src-traits-getter.html b/docs/files/src-traits-getter.html new file mode 100644 index 0000000..dd64026 --- /dev/null +++ b/docs/files/src-traits-getter.html @@ -0,0 +1,347 @@ + + + + + PHP Basics + + + + + + + + + + + + + + + + + + + + + +
                                            +

                                            PHP Basics

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

                                            Getter.php

                                            + +

                                            PHP Basics

                                            + +

                                            Copyright (C) 2024 Sebastian Meyer sebastian.meyer@opencultureconsulting.com

                                            +

                                            This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version.

                                            +

                                            This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details.

                                            +

                                            You should have received a copy of the GNU General Public License +along with this program. If not, see http://www.gnu.org/licenses/.

                                            +
                                            + + + + + +

                                            + Table of Contents + + +

                                            + + + + + +

                                            + Traits + + +

                                            +
                                            +
                                            Getter
                                            Reads data from inaccessible properties by using magic methods.
                                            + + + + + + + + + + + + +
                                            +
                                            +
                                            +
                                            +
                                            
                                            +        
                                            + +
                                            +
                                            + + + +
                                            +
                                            +
                                            + +
                                            + On this page + +
                                              +
                                            • Table Of Contents
                                            • +
                                            • + +
                                            • + + +
                                            +
                                            + +
                                            +
                                            +
                                            +
                                            +
                                            +

                                            Search results

                                            + +
                                            +
                                            +
                                              +
                                              +
                                              +
                                              +
                                              + + +
                                              + + + + + + + + diff --git a/docs/files/src-traits-setter.html b/docs/files/src-traits-setter.html new file mode 100644 index 0000000..e1ba710 --- /dev/null +++ b/docs/files/src-traits-setter.html @@ -0,0 +1,347 @@ + + + + + PHP Basics + + + + + + + + + + + + + + + + + + + + + +
                                              +

                                              PHP Basics

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

                                              Setter.php

                                              + +

                                              PHP Basics

                                              + +

                                              Copyright (C) 2024 Sebastian Meyer sebastian.meyer@opencultureconsulting.com

                                              +

                                              This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version.

                                              +

                                              This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details.

                                              +

                                              You should have received a copy of the GNU General Public License +along with this program. If not, see http://www.gnu.org/licenses/.

                                              +
                                              + + + + + +

                                              + Table of Contents + + +

                                              + + + + + +

                                              + Traits + + +

                                              +
                                              +
                                              Setter
                                              Writes data to inaccessible properties by using magic methods.
                                              + + + + + + + + + + + + +
                                              +
                                              +
                                              +
                                              +
                                              
                                              +        
                                              + +
                                              +
                                              + + + +
                                              +
                                              +
                                              + +
                                              + On this page + +
                                                +
                                              • Table Of Contents
                                              • +
                                              • + +
                                              • + + +
                                              +
                                              + +
                                              +
                                              +
                                              +
                                              +
                                              +

                                              Search results

                                              + +
                                              +
                                              +
                                                +
                                                +
                                                +
                                                +
                                                + + +
                                                + + + + + + + + diff --git a/docs/files/src-traits-singleton.html b/docs/files/src-traits-singleton.html new file mode 100644 index 0000000..0f416f6 --- /dev/null +++ b/docs/files/src-traits-singleton.html @@ -0,0 +1,347 @@ + + + + + PHP Basics + + + + + + + + + + + + + + + + + + + + + +
                                                +

                                                PHP Basics

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

                                                Singleton.php

                                                + +

                                                PHP Basics

                                                + +

                                                Copyright (C) 2024 Sebastian Meyer sebastian.meyer@opencultureconsulting.com

                                                +

                                                This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version.

                                                +

                                                This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details.

                                                +

                                                You should have received a copy of the GNU General Public License +along with this program. If not, see http://www.gnu.org/licenses/.

                                                +
                                                + + + + + +

                                                + Table of Contents + + +

                                                + + + + + +

                                                + Traits + + +

                                                +
                                                +
                                                Singleton
                                                Allows just a single instance of the class using this trait.
                                                + + + + + + + + + + + + +
                                                +
                                                +
                                                +
                                                +
                                                
                                                +        
                                                + +
                                                +
                                                + + + +
                                                +
                                                +
                                                + +
                                                + On this page + +
                                                  +
                                                • Table Of Contents
                                                • +
                                                • + +
                                                • + + +
                                                +
                                                + +
                                                +
                                                +
                                                +
                                                +
                                                +

                                                Search results

                                                + +
                                                +
                                                +
                                                  +
                                                  +
                                                  +
                                                  +
                                                  + + +
                                                  + + + + + + + + diff --git a/docs/files/src/DataStructures/StrictList.php.txt b/docs/files/src/DataStructures/StrictList.php.txt new file mode 100644 index 0000000..3244072 --- /dev/null +++ b/docs/files/src/DataStructures/StrictList.php.txt @@ -0,0 +1,497 @@ + + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +declare(strict_types=1); + +namespace OCC\Basics\DataStructures; + +use ArrayAccess; +use Countable; +use InvalidArgumentException; +use Iterator; +use RuntimeException; +use SplDoublyLinkedList; +use OCC\Basics\Traits\Getter; +use Serializable; + +/** + * A type-sensitive, taversable list. + * + * Extends [\SplDoublyLinkedList](https://www.php.net/spldoublylinkedlist) with + * an option to specify the allowed data types for list values. + * + * @author Sebastian Meyer + * @package Basics\DataStructures + * + * @property-read string[] $allowedTypes The allowed data types for values. + * + * @api + * + * @template AllowedType of mixed + * @extends SplDoublyLinkedList + * @implements ArrayAccess + * @implements Iterator + */ +class StrictList extends SplDoublyLinkedList implements ArrayAccess, Countable, Iterator, Serializable +{ + use Getter; + + /** + * The allowed data types for list values. + * + * @var string[] + * + * @internal + */ + protected array $allowedTypes = []; + + /** + * Add/insert a new value at the specified offset. + * + * @param int $offset The offset where the new value is to be inserted + * @param AllowedType $value The new value for the offset + * + * @return void + * + * @throws InvalidArgumentException + * + * @api + */ + public function add(int $offset, mixed $value): void + { + if (!$this->isAllowedType($value)) { + throw new InvalidArgumentException( + sprintf( + 'Parameter 2 must be an allowed type, %s given.', + get_debug_type($value) + ) + ); + } + parent::add($offset, $value); + } + + /** + * Append values at the end of the list. + * + * @param AllowedType ...$values One or more values to append + * + * @return void + * + * @throws InvalidArgumentException + * + * @api + */ + public function append(mixed ...$values): void + { + foreach ($values as $count => $value) { + if (!$this->isAllowedType($value)) { + throw new InvalidArgumentException( + sprintf( + 'Parameter %d must be an allowed type, %s given.', + (int) $count + 1, + get_debug_type($value) + ) + ); + } + } + foreach ($values as $value) { + parent::push($value); + } + } + + /** + * Peek at the value at the beginning of the list. + * + * @return AllowedType The first value of the list + * + * @throws RuntimeException + * + * @api + */ + public function bottom(): mixed + { + return parent::bottom(); + } + + /** + * Get allowed data types for list values. + * + * @return string[] The list of allowed data types + * + * @api + */ + public function getAllowedTypes(): array + { + return $this->allowedTypes; + } + + /** + * Get the mode of iteration. + * + * @return int The set of flags and modes of iteration + * + * @api + */ + public function getIteratorMode(): int + { + return parent::getIteratorMode(); + } + + /** + * Check if the value's data type is allowed on the list. + * + * @param AllowedType $value The value to check + * + * @return bool Whether the value's data type is allowed + * + * @api + */ + public function isAllowedType(mixed $value): bool + { + if (count($this->allowedTypes) === 0) { + return true; + } + foreach ($this->allowedTypes as $type) { + $function = 'is_' . $type; + if (function_exists($function) && $function($value)) { + return true; + } + /** @var class-string */ + $fqcn = ltrim($type, '\\'); + if (is_object($value) && is_a($value, $fqcn)) { + return true; + } + } + return false; + } + + /** + * Magic getter method for $this->allowedTypes. + * + * @return string[] The list of allowed data types + * + * @internal + */ + protected function magicGetAllowedTypes(): array + { + return $this->getAllowedTypes(); + } + + /** + * Set the value at the specified offset. + * + * @param ?int $offset The offset being set or NULL to append + * @param AllowedType $value The new value for the offset + * + * @return void + * + * @throws InvalidArgumentException + * + * @api + */ + public function offsetSet(mixed $offset, mixed $value): void + { + if (!$this->isAllowedType($value)) { + throw new InvalidArgumentException( + sprintf( + 'Parameter 2 must be an allowed type, %s given.', + get_debug_type($value) + ) + ); + } + /** @psalm-suppress PossiblyNullArgument */ + parent::offsetSet($offset, $value); + } + + /** + * Pops an value from the end of the list. + * + * @return AllowedType The value from the end of the list + * + * @throws RuntimeException + * + * @api + */ + public function pop(): mixed + { + return parent::pop(); + } + + /** + * Prepend values at the start of the list. + * + * @param AllowedType ...$values One or more values to prepend + * + * @return void + * + * @throws InvalidArgumentException + * + * @api + */ + public function prepend(mixed ...$values): void + { + foreach ($values as $count => $value) { + if (!$this->isAllowedType($value)) { + throw new InvalidArgumentException( + sprintf( + 'Parameter %d must be an allowed type, %s given.', + (int) $count + 1, + get_debug_type($value) + ) + ); + } + } + foreach ($values as $value) { + parent::unshift($value); + } + } + + /** + * Push an value at the end of the list. + * + * @param AllowedType $value The value to push + * + * @return void + * + * @throws InvalidArgumentException + * + * @api + */ + public function push(mixed $value): void + { + if (!$this->isAllowedType($value)) { + throw new InvalidArgumentException( + sprintf( + 'Parameter 1 must be an allowed type, %s given.', + get_debug_type($value) + ) + ); + } + parent::push($value); + } + + /** + * Get string representation of $this. + * + * @return string The string representation + * + * @internal + */ + public function serialize(): string + { + return serialize($this->__serialize()); + } + + /** + * Set allowed data types of list values. + * + * @param string[] $allowedTypes Allowed data types of values + * + * @return void + * + * @throws InvalidArgumentException + */ + protected function setAllowedTypes(array $allowedTypes = []): void + { + if (array_sum(array_map('is_string', $allowedTypes)) !== count($allowedTypes)) { + throw new InvalidArgumentException( + 'Allowed types must be array of strings or empty array.' + ); + } + $this->allowedTypes = $allowedTypes; + } + + /** + * Set the mode of iteration. + * + * @param int $mode The new iterator mode (0, 1, 2 or 3) + * + * There are two orthogonal sets of modes that can be set. + * + * The direction of iteration (either one or the other): + * - StrictList::IT_MODE_FIFO (queue style) + * - StrictList::IT_MODE_LIFO (stack style) + * + * The behavior of the iterator (either one or the other): + * - StrictList::IT_MODE_DELETE (delete items) + * - StrictList::IT_MODE_KEEP (keep items) + * + * The default mode is: IT_MODE_FIFO | IT_MODE_KEEP + * + * @return int The set of flags and modes of iteration + * + * @api + */ + public function setIteratorMode(int $mode): int + { + return parent::setIteratorMode($mode); + } + + /** + * Shift an value from the beginning of the list. + * + * @return AllowedType The first value of the list + * + * @throws RuntimeException + * + * @api + */ + public function shift(): mixed + { + return parent::shift(); + } + + /** + * Peek at the value at the end of the list. + * + * @return AllowedType The last value of the list + * + * @throws RuntimeException + * + * @api + */ + public function top(): mixed + { + return parent::top(); + } + + /** + * Restore $this from string representation. + * + * @param string $data The string representation + * + * @return void + * + * @internal + */ + public function unserialize($data): void + { + /** @var mixed[] $dataArray */ + $dataArray = unserialize($data); + $this->__unserialize($dataArray); + } + + /** + * Prepend the list with an value. + * + * @param AllowedType $value The value to unshift + * + * @return void + * + * @throws InvalidArgumentException + * + * @api + */ + public function unshift(mixed $value): void + { + if (!$this->isAllowedType($value)) { + throw new InvalidArgumentException( + sprintf( + 'Parameter 1 must be an allowed type, %s given.', + get_debug_type($value) + ) + ); + } + parent::unshift($value); + } + + /** + * Create a type-sensitive, traversable list of values. + * + * @param string[] $allowedTypes Allowed data types of values (optional) + * + * If empty, all types are allowed. + * Possible values are: + * - "array" + * - "bool" + * - "callable" + * - "countable" + * - "float" or "double" + * - "int" or "integer" or "long" + * - "iterable" + * - "null" + * - "numeric" + * - "object" or FQCN + * - "resource" + * - "scalar" + * - "string" + * + * @return void + * + * @throws InvalidArgumentException + */ + public function __construct(array $allowedTypes = []) + { + $this->setAllowedTypes($allowedTypes); + } + + /** + * Get debug information for $this. + * + * @return mixed[] The debug information + * + * @internal + */ + public function __debugInfo(): array + { + return $this->__serialize(); + } + + /** + * Get array representation of $this. + * + * @return mixed[] The array representation + * + * @internal + */ + public function __serialize(): array + { + return [ + 'StrictList::allowedTypes' => $this->allowedTypes, + 'SplDoublyLinkedList::dllist' => iterator_to_array($this), + 'SplDoublyLinkedList::flags' => $this->getIteratorMode() + ]; + } + + /** + * Restore $this from array representation. + * + * @param mixed[] $data The array representation + * + * @return void + * + * @internal + * + * @psalm-suppress MethodSignatureMismatch + */ + public function __unserialize(array $data): void + { + /** @var string[] $allowedTypes */ + $allowedTypes = $data['StrictList::allowedTypes']; + $this->setAllowedTypes($allowedTypes); + /** @var array $values */ + $values = $data['SplDoublyLinkedList::dllist']; + $this->append(...$values); + /** @var int $flags */ + $flags = $data['SplDoublyLinkedList::flags']; + $this->setIteratorMode($flags); + } +} diff --git a/docs/files/src/DataStructures/StrictQueue.php.txt b/docs/files/src/DataStructures/StrictQueue.php.txt new file mode 100644 index 0000000..a4758cf --- /dev/null +++ b/docs/files/src/DataStructures/StrictQueue.php.txt @@ -0,0 +1,143 @@ + + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +declare(strict_types=1); + +namespace OCC\Basics\DataStructures; + +use ArrayAccess; +use Countable; +use Iterator; +use RuntimeException; +use Serializable; + +/** + * A type-sensitive, taversable First In, First Out queue (FIFO). + * + * Extends [\SplQueue](https://www.php.net/splqueue) with an option to specify + * the allowed data types for list items. + * + * @author Sebastian Meyer + * @package Basics\DataStructures + * + * @api + * + * @template AllowedType of mixed + * @extends StrictList + * @implements ArrayAccess + * @implements Iterator + */ +class StrictQueue extends StrictList implements ArrayAccess, Countable, Iterator, Serializable +{ + /** + * Dequeue an item from the queue. + * + * @return AllowedType The dequeued item + * + * @api + */ + public function dequeue(): mixed + { + return parent::shift(); + } + + /** + * Add an item to the queue. + * + * @param AllowedType $item The item to enqueue + * + * @return void + * + * @throws \InvalidArgumentException + * + * @api + */ + public function enqueue(mixed $item): void + { + parent::push($item); + } + + /** + * Set the mode of iteration. + * + * @param int $mode The new iterator mode (0 or 1) + * + * There are two orthogonal sets of modes that can be set. + * + * The direction of iteration (fixed for StrictQueue): + * - StrictQueue::IT_MODE_FIFO (queue style) + * + * The behavior of the iterator (either one or the other): + * - StrictQueue::IT_MODE_DELETE (delete items) + * - StrictQueue::IT_MODE_KEEP (keep items) + * + * The default mode is: IT_MODE_FIFO | IT_MODE_KEEP + * + * @return int The set of flags and modes of iteration + * + * @throws RuntimeException + * + * @api + */ + final public function setIteratorMode(int $mode): int + { + if ($mode > 1) { + throw new RuntimeException( + sprintf( + 'Changing the iterator direction of %s is prohibited.', + static::class + ) + ); + } + return parent::setIteratorMode($mode); + } + + /** + * Create a type-sensitive, traversable queue of items. + * + * @param string[] $allowedTypes Allowed data types of items (optional) + * + * If empty, all types are allowed. + * Possible values are: + * - "array" + * - "bool" + * - "callable" + * - "countable" + * - "float" or "double" + * - "int" or "integer" or "long" + * - "iterable" + * - "null" + * - "numeric" + * - "object" or FQCN + * - "resource" + * - "scalar" + * - "string" + * + * @return void + * + * @throws \InvalidArgumentException + */ + public function __construct(array $allowedTypes = []) + { + parent::__construct($allowedTypes); + $this->setIteratorMode(0); + } +} diff --git a/docs/files/src/DataStructures/StrictStack.php.txt b/docs/files/src/DataStructures/StrictStack.php.txt new file mode 100644 index 0000000..afaf3b5 --- /dev/null +++ b/docs/files/src/DataStructures/StrictStack.php.txt @@ -0,0 +1,143 @@ + + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +declare(strict_types=1); + +namespace OCC\Basics\DataStructures; + +use ArrayAccess; +use Countable; +use Iterator; +use RuntimeException; +use Serializable; + +/** + * A type-sensitive, taversable Last In, First Out stack (LIFO). + * + * Extends [\SplStack](https://www.php.net/splstack) with an option to specify + * the allowed data types for list items. + * + * @author Sebastian Meyer + * @package Basics\DataStructures + * + * @api + * + * @template AllowedType of mixed + * @extends StrictList + * @implements ArrayAccess + * @implements Iterator + */ +class StrictStack extends StrictList implements ArrayAccess, Countable, Iterator, Serializable +{ + /** + * Add an item to the stack. + * + * @param AllowedType $item The item to stack + * + * @return void + * + * @throws \InvalidArgumentException + * + * @api + */ + public function stack(mixed $item): void + { + parent::push($item); + } + + /** + * Unstack an item from the stack. + * + * @return AllowedType The unstacked item + * + * @api + */ + public function unstack(): mixed + { + return parent::pop(); + } + + /** + * Set the mode of iteration. + * + * @param int $mode The new iterator mode (2 or 3) + * + * There are two orthogonal sets of modes that can be set. + * + * The direction of iteration (fixed for StrictStack): + * - StrictStack::IT_MODE_LIFO (stack style) + * + * The behavior of the iterator (either one or the other): + * - StrictStack::IT_MODE_DELETE (delete items) + * - StrictStack::IT_MODE_KEEP (keep items) + * + * The default mode is: IT_MODE_LIFO | IT_MODE_KEEP + * + * @return int The set of flags and modes of iteration + * + * @throws RuntimeException + * + * @api + */ + final public function setIteratorMode(int $mode): int + { + if ($mode < 2) { + throw new RuntimeException( + sprintf( + 'Changing the iterator direction of %s is prohibited.', + static::class + ) + ); + } + return parent::setIteratorMode($mode); + } + + /** + * Create a type-sensitive, traversable stack of items. + * + * @param string[] $allowedTypes Allowed data types of items (optional) + * + * If empty, all types are allowed. + * Possible values are: + * - "array" + * - "bool" + * - "callable" + * - "countable" + * - "float" or "double" + * - "int" or "integer" or "long" + * - "iterable" + * - "null" + * - "numeric" + * - "object" or FQCN + * - "resource" + * - "scalar" + * - "string" + * + * @return void + * + * @throws \InvalidArgumentException + */ + public function __construct(array $allowedTypes = []) + { + parent::__construct($allowedTypes); + $this->setIteratorMode(2); + } +} diff --git a/docs/files/src/ErrorHandlers/ThrowErrorException.php.txt b/docs/files/src/ErrorHandlers/ThrowErrorException.php.txt new file mode 100644 index 0000000..ed7c241 --- /dev/null +++ b/docs/files/src/ErrorHandlers/ThrowErrorException.php.txt @@ -0,0 +1,63 @@ + + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +declare(strict_types=1); + +namespace OCC\Basics\ErrorHandlers; + +use ErrorException; + +/** + * Throw internal errors as exceptions. + * + * Usage: set_error_handler(new ThrowErrorException()); + * + * @author Sebastian Meyer + * @package Basics\ErrorHandlers + * + * @api + */ +class ThrowErrorException +{ + /** + * Convert an internal PHP error into an ErrorException. + * + * @param int $errno The severity of the error + * @param string $errstr The error message + * @param ?string $errfile The name of the file the error was raised in + * @param ?int $errline The line number the error was raised in + * + * @return bool Always returns FALSE when not throwing an exception + * + * @throws ErrorException + */ + public function __invoke( + int $errno = E_USER_ERROR, + string $errstr = '', + ?string $errfile = null, + ?int $errline = null + ): bool { + if ((error_reporting() & $errno) > 0) { + throw new ErrorException($errstr, 0, $errno, $errfile, $errline); + } + return false; + } +} diff --git a/docs/files/src/ErrorHandlers/TriggerExceptionError.php.txt b/docs/files/src/ErrorHandlers/TriggerExceptionError.php.txt new file mode 100644 index 0000000..83b7f8c --- /dev/null +++ b/docs/files/src/ErrorHandlers/TriggerExceptionError.php.txt @@ -0,0 +1,58 @@ + + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +declare(strict_types=1); + +namespace OCC\Basics\ErrorHandlers; + +use Throwable; + +/** + * Trigger errors for uncaught exceptions. + * + * Usage: set_exception_handler(new TriggerExceptionError()); + * + * @author Sebastian Meyer + * @package Basics\ErrorHandlers + * + * @api + */ +class TriggerExceptionError +{ + /** + * Convert an uncaught exception into an PHP error. + * + * @param Throwable $exception The exception + * + * @return void + */ + public function __invoke(Throwable $exception): void + { + $message = sprintf( + 'Uncaught Exception [%d] in file %s on line %d: %s', + $exception->getCode(), + $exception->getFile(), + $exception->getLine(), + $exception->getMessage() + ); + trigger_error($message, E_USER_ERROR); + } +} diff --git a/docs/files/src/InterfaceTraits/ArrayAccessTrait.php.txt b/docs/files/src/InterfaceTraits/ArrayAccessTrait.php.txt new file mode 100644 index 0000000..69b540a --- /dev/null +++ b/docs/files/src/InterfaceTraits/ArrayAccessTrait.php.txt @@ -0,0 +1,111 @@ + + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +declare(strict_types=1); + +namespace OCC\Basics\InterfaceTraits; + +use ArrayAccess; + +/** + * A generic implementation of the ArrayAccess interface. + * + * @author Sebastian Meyer + * @package Basics\InterfaceTraits + * + * @api + * + * @template TKey of int|string + * @template TValue of mixed + * @template TData of array + * @implements ArrayAccess + * @phpstan-require-implements ArrayAccess + */ +trait ArrayAccessTrait +{ + /** + * Holds the array-accessible data. + * + * @var TData + */ + protected array $data = []; + + /** + * Check if the specified offset exists. + * + * @param TKey $offset The offset to check for + * + * @return bool Whether the offset exists + * + * @api + */ + public function offsetExists(mixed $offset): bool + { + return isset($this->data[$offset]); + } + + /** + * Retrieve data at the specified offset. + * + * @param TKey $offset The offset to retrieve at + * + * @return ?TValue The value at the offset or NULL + * + * @api + */ + public function offsetGet(mixed $offset): mixed + { + return $this->data[$offset] ?? null; + } + + /** + * Assign a value to the specified offset. + * + * @param ?TKey $offset The offset to assign to or NULL to append + * @param TValue $value The value to set + * + * @return void + * + * @api + */ + public function offsetSet(mixed $offset, mixed $value): void + { + if (is_null($offset)) { + $this->data[] = $value; + } else { + $this->data[$offset] = $value; + } + } + + /** + * Unset the specified offset. + * + * @param TKey $offset The offset to unset + * + * @return void + * + * @api + */ + public function offsetUnset(mixed $offset): void + { + unset($this->data[$offset]); + } +} diff --git a/docs/files/src/InterfaceTraits/CountableTrait.php.txt b/docs/files/src/InterfaceTraits/CountableTrait.php.txt new file mode 100644 index 0000000..69f10f8 --- /dev/null +++ b/docs/files/src/InterfaceTraits/CountableTrait.php.txt @@ -0,0 +1,62 @@ + + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +declare(strict_types=1); + +namespace OCC\Basics\InterfaceTraits; + +use Countable; + +/** + * A generic implementation of the Countable interface. + * + * @author Sebastian Meyer + * @package Basics\InterfaceTraits + * + * @api + * + * @template TKey of int|string + * @template TValue of mixed + * @template TData of array + * @implements Countable + * @phpstan-require-implements Countable + */ +trait CountableTrait +{ + /** + * Holds the countable data. + * + * @var TData + */ + protected array $data = []; + + /** + * Count the data items. + * + * @return int The number of data items + * + * @api + */ + public function count(): int + { + return count($this->data); + } +} diff --git a/docs/files/src/InterfaceTraits/IteratorAggregateTrait.php.txt b/docs/files/src/InterfaceTraits/IteratorAggregateTrait.php.txt new file mode 100644 index 0000000..83fc8d4 --- /dev/null +++ b/docs/files/src/InterfaceTraits/IteratorAggregateTrait.php.txt @@ -0,0 +1,63 @@ + + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +declare(strict_types=1); + +namespace OCC\Basics\InterfaceTraits; + +use ArrayIterator; +use IteratorAggregate; + +/** + * A generic implementation of the IteratorAggregate interface. + * + * @author Sebastian Meyer + * @package Basics\InterfaceTraits + * + * @api + * + * @template TKey of int|string + * @template TValue of mixed + * @template TData of array + * @implements IteratorAggregate + * @phpstan-require-implements IteratorAggregate + */ +trait IteratorAggregateTrait +{ + /** + * Holds the iterable data. + * + * @var TData + */ + protected array $data = []; + + /** + * Retrieve an external iterator. + * + * @return ArrayIterator New array iterator for data array + * + * @api + */ + public function getIterator(): ArrayIterator + { + return new ArrayIterator($this->data); + } +} diff --git a/docs/files/src/InterfaceTraits/IteratorTrait.php.txt b/docs/files/src/InterfaceTraits/IteratorTrait.php.txt new file mode 100644 index 0000000..c84a2f0 --- /dev/null +++ b/docs/files/src/InterfaceTraits/IteratorTrait.php.txt @@ -0,0 +1,122 @@ + + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +declare(strict_types=1); + +namespace OCC\Basics\InterfaceTraits; + +use Iterator; + +/** + * A generic implementation of the Iterator interface. + * + * @author Sebastian Meyer + * @package Basics\InterfaceTraits + * + * @api + * + * @template TKey of int|string + * @template TValue of mixed + * @template TData of array + * @implements Iterator + * @phpstan-require-implements Iterator + */ +trait IteratorTrait +{ + /** + * Holds the iterable data. + * + * @var TData + */ + protected array $data = []; + + /** + * Return the current item. + * + * @return TValue|false The current item or FALSE if invalid + * + * @api + */ + public function current(): mixed + { + return current($this->data); + } + + /** + * Return the current key. + * + * @return ?TKey The current key or NULL if invalid + * + * @api + */ + public function key(): mixed + { + return key($this->data); + } + + /** + * Move forward to next item. + * + * @return void + * + * @api + */ + public function next(): void + { + next($this->data); + } + + /** + * Move back to previous item. + * + * @return void + * + * @api + */ + public function prev(): void + { + prev($this->data); + } + + /** + * Rewind the iterator to the first item. + * + * @return void + * + * @api + */ + public function rewind(): void + { + reset($this->data); + } + + /** + * Check if current position is valid. + * + * @return bool Whether the current position is valid + * + * @api + */ + public function valid(): bool + { + return !is_null($this->key()); + } +} diff --git a/docs/files/src/Traits/Getter.php.txt b/docs/files/src/Traits/Getter.php.txt new file mode 100644 index 0000000..5ad7f6d --- /dev/null +++ b/docs/files/src/Traits/Getter.php.txt @@ -0,0 +1,86 @@ + + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +declare(strict_types=1); + +namespace OCC\Basics\Traits; + +use InvalidArgumentException; + +/** + * Reads data from inaccessible properties by using magic methods. + * + * @author Sebastian Meyer + * @package Basics\Traits + */ +trait Getter +{ + /** + * Read data from an inaccessible property. + * + * @param string $property The class property to get + * + * @return mixed The class property's current value + * + * @throws InvalidArgumentException + * + * @internal + */ + public function __get(string $property): mixed + { + $method = 'magicGet' . ucfirst($property); + if ( + property_exists(static::class, $property) + && method_exists(static::class, $method) + ) { + return $this->$method(); + } else { + throw new InvalidArgumentException( + sprintf( + 'Invalid property or missing getter method for property: %s->%s.', + static::class, + $property + ) + ); + } + } + + /** + * Check if an inaccessible property is set and not empty. + * + * @param string $property The class property to check + * + * @return bool Whether the class property is set and not empty + * + * @internal + */ + public function __isset(string $property): bool + { + try { + /** @var mixed $value */ + $value = $this->__get($property); + } catch (InvalidArgumentException) { + $value = null; + } finally { + return boolval($value ?? null) !== false; + } + } +} diff --git a/docs/files/src/Traits/Setter.php.txt b/docs/files/src/Traits/Setter.php.txt new file mode 100644 index 0000000..a44cd5e --- /dev/null +++ b/docs/files/src/Traits/Setter.php.txt @@ -0,0 +1,85 @@ + + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +declare(strict_types=1); + +namespace OCC\Basics\Traits; + +use InvalidArgumentException; + +/** + * Writes data to inaccessible properties by using magic methods. + * + * @author Sebastian Meyer + * @package Basics\Traits + */ +trait Setter +{ + /** + * Write data to an inaccessible property. + * + * @param string $property The class property to set + * @param mixed $value The new value of the property + * + * @return void + * + * @throws InvalidArgumentException + * + * @internal + */ + public function __set(string $property, mixed $value): void + { + $method = 'magicSet' . ucfirst($property); + if ( + property_exists(static::class, $property) + && method_exists(static::class, $method) + ) { + $this->$method($value); + } else { + throw new InvalidArgumentException( + sprintf( + 'Invalid property or missing setter method for property: %s->%s.', + static::class, + $property + ) + ); + } + } + + /** + * Unset an inaccessible property. + * + * @param string $property The class property to unset + * + * @return void + * + * @throws InvalidArgumentException + * + * @internal + */ + public function __unset(string $property): void + { + try { + $this->__set($property, null); + } catch (InvalidArgumentException) { + } + } +} diff --git a/docs/files/src/Traits/Singleton.php.txt b/docs/files/src/Traits/Singleton.php.txt new file mode 100644 index 0000000..80b5abe --- /dev/null +++ b/docs/files/src/Traits/Singleton.php.txt @@ -0,0 +1,84 @@ + + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +declare(strict_types=1); + +namespace OCC\Basics\Traits; + +use LogicException; + +/** + * Allows just a single instance of the class using this trait. + * + * @author Sebastian Meyer + * @package Basics\Traits + */ +trait Singleton +{ + /** + * Holds the singleton instance. + * + * @var array + * + * @internal + */ + private static array $singleton = []; + + /** + * Get a singleton instance of this class. + * + * @param mixed ...$args Constructor parameters + * + * @return static The singleton instance + * + * @api + */ + final public static function getInstance(mixed ...$args): static + { + if (!isset(static::$singleton[static::class])) { + static::$singleton[static::class] = new static(...$args); + } + return static::$singleton[static::class]; + } + + /** + * This is a singleton class, thus the constructor is private. + * + * Usage: Get an instance of this class by calling static::getInstance() + * + * @return void + */ + abstract private function __construct(); + + /** + * This is a singleton class, thus cloning is prohibited. + * + * @return void + * + * @throws LogicException + * + * @internal + */ + final public function __clone(): void + { + throw new LogicException('Cloning a singleton is prohibited.'); + } +} diff --git a/docs/graphs/classes.html b/docs/graphs/classes.html new file mode 100644 index 0000000..5f32b78 --- /dev/null +++ b/docs/graphs/classes.html @@ -0,0 +1,179 @@ + + + + + PHP Basics + + + + + + + + + +
                                                  +

                                                  PHP Basics

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

                                                  Search results

                                                  + +
                                                  +
                                                  +
                                                    +
                                                    +
                                                    +
                                                    +
                                                    + + +
                                                    + + + + + + + + diff --git a/docs/guides/index.html b/docs/guides/index.html new file mode 100644 index 0000000..415c078 --- /dev/null +++ b/docs/guides/index.html @@ -0,0 +1,156 @@ + + + + + + PHP Basics + + + + + + + + + + + + + + + + + + + + + + +
                                                    +

                                                    PHP Basics

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

                                                    Documentation

                                                    + + +
                                                    + +
                                                    +
                                                    +
                                                    +
                                                    +

                                                    Search results

                                                    + +
                                                    +
                                                    +
                                                      +
                                                      +
                                                      +
                                                      +
                                                      + + +
                                                      + + + + + + + + diff --git a/docs/guides/installation/index.html b/docs/guides/installation/index.html new file mode 100644 index 0000000..9a68432 --- /dev/null +++ b/docs/guides/installation/index.html @@ -0,0 +1,167 @@ + + + + + PHP Basics + + + + + + + + + + + + + + + + + + + + + + +
                                                      +

                                                      PHP Basics

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

                                                      Installation

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

                                                      Search results

                                                      + +
                                                      +
                                                      +
                                                        +
                                                        +
                                                        +
                                                        +
                                                        + + +
                                                        + + + + + + + + diff --git a/docs/guides/installation/test.html b/docs/guides/installation/test.html new file mode 100644 index 0000000..e2a1178 --- /dev/null +++ b/docs/guides/installation/test.html @@ -0,0 +1,174 @@ + + + + + PHP Basics + + + + + + + + + + + + + + + + + + + + + + +
                                                        +

                                                        PHP Basics

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

                                                        Test

                                                        + +
                                                        +

                                                        Heading 1

                                                        + +
                                                        +

                                                        Heading 2

                                                        + +
                                                        +

                                                        Heading 3

                                                        + +
                                                        +
                                                        Heading 4
                                                        + +
                                                        + +
                                                        + +
                                                        + +
                                                        + +
                                                        + +
                                                        +
                                                        +
                                                        +
                                                        +

                                                        Search results

                                                        + +
                                                        +
                                                        +
                                                          +
                                                          +
                                                          +
                                                          +
                                                          + + +
                                                          + + + + + + + + diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 0000000..10dc3aa --- /dev/null +++ b/docs/index.html @@ -0,0 +1,222 @@ + + + + + PHP Basics + + + + + + + + + + + + + + + + + + + + + +
                                                          +

                                                          PHP Basics

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

                                                          Documentation

                                                          + + + +

                                                          + Table of Contents + + +

                                                          + +

                                                          + Packages + + +

                                                          +
                                                          +
                                                          Basics
                                                          +
                                                          + +

                                                          + Namespaces + + +

                                                          +
                                                          +
                                                          OCC
                                                          +
                                                          + + + + + + + + + + + + + +
                                                          +
                                                          +
                                                          +
                                                          +
                                                          +

                                                          Search results

                                                          + +
                                                          +
                                                          +
                                                            +
                                                            +
                                                            +
                                                            +
                                                            + + +
                                                            + + + + + + + + diff --git a/docs/indices/files.html b/docs/indices/files.html new file mode 100644 index 0000000..6b056c4 --- /dev/null +++ b/docs/indices/files.html @@ -0,0 +1,214 @@ + + + + + PHP Basics + + + + + + + + + + + + + + + + + + + + + +
                                                            +

                                                            PHP Basics

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

                                                            Search results

                                                            + +
                                                            +
                                                            +
                                                              +
                                                              +
                                                              +
                                                              +
                                                              + + +
                                                              + + + + + + + + diff --git a/docs/js/search.js b/docs/js/search.js new file mode 100644 index 0000000..093d6d0 --- /dev/null +++ b/docs/js/search.js @@ -0,0 +1,173 @@ +// Search module for phpDocumentor +// +// This module is a wrapper around fuse.js that will use a given index and attach itself to a +// search form and to a search results pane identified by the following data attributes: +// +// 1. data-search-form +// 2. data-search-results +// +// The data-search-form is expected to have a single input element of type 'search' that will trigger searching for +// a series of results, were the data-search-results pane is expected to have a direct UL child that will be populated +// with rendered results. +// +// The search has various stages, upon loading this stage the data-search-form receives the CSS class +// 'phpdocumentor-search--enabled'; this indicates that JS is allowed and indices are being loaded. It is recommended +// to hide the form by default and show it when it receives this class to achieve progressive enhancement for this +// feature. +// +// After loading this module, it is expected to load a search index asynchronously, for example: +// +// +// +// In this script the generated index should attach itself to the search module using the `appendIndex` function. By +// doing it like this the page will continue loading, unhindered by the loading of the search. +// +// After the page has fully loaded, and all these deferred indexes loaded, the initialization of the search module will +// be called and the form will receive the class 'phpdocumentor-search--active', indicating search is ready. At this +// point, the input field will also have it's 'disabled' attribute removed. +var Search = (function () { + var fuse; + var index = []; + var options = { + shouldSort: true, + threshold: 0.6, + location: 0, + distance: 100, + maxPatternLength: 32, + minMatchCharLength: 1, + keys: [ + "fqsen", + "name", + "summary", + "url" + ] + }; + + // Credit David Walsh (https://davidwalsh.name/javascript-debounce-function) + // Returns a function, that, as long as it continues to be invoked, will not + // be triggered. The function will be called after it stops being called for + // N milliseconds. If `immediate` is passed, trigger the function on the + // leading edge, instead of the trailing. + function debounce(func, wait, immediate) { + var timeout; + + return function executedFunction() { + var context = this; + var args = arguments; + + var later = function () { + timeout = null; + if (!immediate) func.apply(context, args); + }; + + var callNow = immediate && !timeout; + clearTimeout(timeout); + timeout = setTimeout(later, wait); + if (callNow) func.apply(context, args); + }; + } + + function close() { + // Start scroll prevention: https://css-tricks.com/prevent-page-scrolling-when-a-modal-is-open/ + const scrollY = document.body.style.top; + document.body.style.position = ''; + document.body.style.top = ''; + window.scrollTo(0, parseInt(scrollY || '0') * -1); + // End scroll prevention + + var form = document.querySelector('[data-search-form]'); + var searchResults = document.querySelector('[data-search-results]'); + + form.classList.toggle('phpdocumentor-search--has-results', false); + searchResults.classList.add('phpdocumentor-search-results--hidden'); + var searchField = document.querySelector('[data-search-form] input[type="search"]'); + searchField.blur(); + } + + function search(event) { + // Start scroll prevention: https://css-tricks.com/prevent-page-scrolling-when-a-modal-is-open/ + document.body.style.position = 'fixed'; + document.body.style.top = `-${window.scrollY}px`; + // End scroll prevention + + // prevent enter's from autosubmitting + event.stopPropagation(); + + var form = document.querySelector('[data-search-form]'); + var searchResults = document.querySelector('[data-search-results]'); + var searchResultEntries = document.querySelector('[data-search-results] .phpdocumentor-search-results__entries'); + + searchResultEntries.innerHTML = ''; + + if (!event.target.value) { + close(); + return; + } + + form.classList.toggle('phpdocumentor-search--has-results', true); + searchResults.classList.remove('phpdocumentor-search-results--hidden'); + var results = fuse.search(event.target.value, {limit: 25}); + + results.forEach(function (result) { + var entry = document.createElement("li"); + entry.classList.add("phpdocumentor-search-results__entry"); + entry.innerHTML += '

                                                              ' + result.name + "

                                                              \n"; + entry.innerHTML += '' + result.fqsen + "\n"; + entry.innerHTML += '
                                                              ' + result.summary + '
                                                              '; + searchResultEntries.appendChild(entry) + }); + } + + function appendIndex(added) { + index = index.concat(added); + + // re-initialize search engine when appending an index after initialisation + if (typeof fuse !== 'undefined') { + fuse = new Fuse(index, options); + } + } + + function init() { + fuse = new Fuse(index, options); + + var form = document.querySelector('[data-search-form]'); + var searchField = document.querySelector('[data-search-form] input[type="search"]'); + + var closeButton = document.querySelector('.phpdocumentor-search-results__close'); + closeButton.addEventListener('click', function() { close() }.bind(this)); + + var searchResults = document.querySelector('[data-search-results]'); + searchResults.addEventListener('click', function() { close() }.bind(this)); + + form.classList.add('phpdocumentor-search--active'); + + searchField.setAttribute('placeholder', 'Search (Press "/" to focus)'); + searchField.removeAttribute('disabled'); + searchField.addEventListener('keyup', debounce(search, 300)); + + window.addEventListener('keyup', function (event) { + if (event.key === '/') { + searchField.focus(); + } + if (event.code === 'Escape') { + close(); + } + }.bind(this)); + } + + return { + appendIndex, + init + } +})(); + +window.addEventListener('DOMContentLoaded', function () { + var form = document.querySelector('[data-search-form]'); + + // When JS is supported; show search box. Must be before including the search for it to take effect immediately + form.classList.add('phpdocumentor-search--enabled'); +}); + +window.addEventListener('load', function () { + Search.init(); +}); diff --git a/docs/js/searchIndex.js b/docs/js/searchIndex.js new file mode 100644 index 0000000..b5217ad --- /dev/null +++ b/docs/js/searchIndex.js @@ -0,0 +1,319 @@ +Search.appendIndex( + [ + { + "fqsen": "\\OCC\\Basics\\DataStructures\\StrictList", + "name": "StrictList", + "summary": "A\u0020type\u002Dsensitive,\u0020taversable\u0020list.", + "url": "classes/OCC-Basics-DataStructures-StrictList.html" + }, { + "fqsen": "\\OCC\\Basics\\DataStructures\\StrictList\u003A\u003Aadd\u0028\u0029", + "name": "add", + "summary": "Add\/insert\u0020a\u0020new\u0020value\u0020at\u0020the\u0020specified\u0020offset.", + "url": "classes/OCC-Basics-DataStructures-StrictList.html#method_add" + }, { + "fqsen": "\\OCC\\Basics\\DataStructures\\StrictList\u003A\u003Aappend\u0028\u0029", + "name": "append", + "summary": "Append\u0020values\u0020at\u0020the\u0020end\u0020of\u0020the\u0020list.", + "url": "classes/OCC-Basics-DataStructures-StrictList.html#method_append" + }, { + "fqsen": "\\OCC\\Basics\\DataStructures\\StrictList\u003A\u003Abottom\u0028\u0029", + "name": "bottom", + "summary": "Peek\u0020at\u0020the\u0020value\u0020at\u0020the\u0020beginning\u0020of\u0020the\u0020list.", + "url": "classes/OCC-Basics-DataStructures-StrictList.html#method_bottom" + }, { + "fqsen": "\\OCC\\Basics\\DataStructures\\StrictList\u003A\u003AgetAllowedTypes\u0028\u0029", + "name": "getAllowedTypes", + "summary": "Get\u0020allowed\u0020data\u0020types\u0020for\u0020list\u0020values.", + "url": "classes/OCC-Basics-DataStructures-StrictList.html#method_getAllowedTypes" + }, { + "fqsen": "\\OCC\\Basics\\DataStructures\\StrictList\u003A\u003AgetIteratorMode\u0028\u0029", + "name": "getIteratorMode", + "summary": "Get\u0020the\u0020mode\u0020of\u0020iteration.", + "url": "classes/OCC-Basics-DataStructures-StrictList.html#method_getIteratorMode" + }, { + "fqsen": "\\OCC\\Basics\\DataStructures\\StrictList\u003A\u003AisAllowedType\u0028\u0029", + "name": "isAllowedType", + "summary": "Check\u0020if\u0020the\u0020value\u0027s\u0020data\u0020type\u0020is\u0020allowed\u0020on\u0020the\u0020list.", + "url": "classes/OCC-Basics-DataStructures-StrictList.html#method_isAllowedType" + }, { + "fqsen": "\\OCC\\Basics\\DataStructures\\StrictList\u003A\u003AoffsetSet\u0028\u0029", + "name": "offsetSet", + "summary": "Set\u0020the\u0020value\u0020at\u0020the\u0020specified\u0020offset.", + "url": "classes/OCC-Basics-DataStructures-StrictList.html#method_offsetSet" + }, { + "fqsen": "\\OCC\\Basics\\DataStructures\\StrictList\u003A\u003Apop\u0028\u0029", + "name": "pop", + "summary": "Pops\u0020an\u0020value\u0020from\u0020the\u0020end\u0020of\u0020the\u0020list.", + "url": "classes/OCC-Basics-DataStructures-StrictList.html#method_pop" + }, { + "fqsen": "\\OCC\\Basics\\DataStructures\\StrictList\u003A\u003Aprepend\u0028\u0029", + "name": "prepend", + "summary": "Prepend\u0020values\u0020at\u0020the\u0020start\u0020of\u0020the\u0020list.", + "url": "classes/OCC-Basics-DataStructures-StrictList.html#method_prepend" + }, { + "fqsen": "\\OCC\\Basics\\DataStructures\\StrictList\u003A\u003Apush\u0028\u0029", + "name": "push", + "summary": "Push\u0020an\u0020value\u0020at\u0020the\u0020end\u0020of\u0020the\u0020list.", + "url": "classes/OCC-Basics-DataStructures-StrictList.html#method_push" + }, { + "fqsen": "\\OCC\\Basics\\DataStructures\\StrictList\u003A\u003AsetAllowedTypes\u0028\u0029", + "name": "setAllowedTypes", + "summary": "Set\u0020allowed\u0020data\u0020types\u0020of\u0020list\u0020values.", + "url": "classes/OCC-Basics-DataStructures-StrictList.html#method_setAllowedTypes" + }, { + "fqsen": "\\OCC\\Basics\\DataStructures\\StrictList\u003A\u003AsetIteratorMode\u0028\u0029", + "name": "setIteratorMode", + "summary": "Set\u0020the\u0020mode\u0020of\u0020iteration.", + "url": "classes/OCC-Basics-DataStructures-StrictList.html#method_setIteratorMode" + }, { + "fqsen": "\\OCC\\Basics\\DataStructures\\StrictList\u003A\u003Ashift\u0028\u0029", + "name": "shift", + "summary": "Shift\u0020an\u0020value\u0020from\u0020the\u0020beginning\u0020of\u0020the\u0020list.", + "url": "classes/OCC-Basics-DataStructures-StrictList.html#method_shift" + }, { + "fqsen": "\\OCC\\Basics\\DataStructures\\StrictList\u003A\u003Atop\u0028\u0029", + "name": "top", + "summary": "Peek\u0020at\u0020the\u0020value\u0020at\u0020the\u0020end\u0020of\u0020the\u0020list.", + "url": "classes/OCC-Basics-DataStructures-StrictList.html#method_top" + }, { + "fqsen": "\\OCC\\Basics\\DataStructures\\StrictList\u003A\u003Aunshift\u0028\u0029", + "name": "unshift", + "summary": "Prepend\u0020the\u0020list\u0020with\u0020an\u0020value.", + "url": "classes/OCC-Basics-DataStructures-StrictList.html#method_unshift" + }, { + "fqsen": "\\OCC\\Basics\\DataStructures\\StrictList\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "Create\u0020a\u0020type\u002Dsensitive,\u0020traversable\u0020list\u0020of\u0020values.", + "url": "classes/OCC-Basics-DataStructures-StrictList.html#method___construct" + }, { + "fqsen": "\\OCC\\Basics\\DataStructures\\StrictQueue", + "name": "StrictQueue", + "summary": "A\u0020type\u002Dsensitive,\u0020taversable\u0020First\u0020In,\u0020First\u0020Out\u0020queue\u0020\u0028FIFO\u0029.", + "url": "classes/OCC-Basics-DataStructures-StrictQueue.html" + }, { + "fqsen": "\\OCC\\Basics\\DataStructures\\StrictQueue\u003A\u003Adequeue\u0028\u0029", + "name": "dequeue", + "summary": "Dequeue\u0020an\u0020item\u0020from\u0020the\u0020queue.", + "url": "classes/OCC-Basics-DataStructures-StrictQueue.html#method_dequeue" + }, { + "fqsen": "\\OCC\\Basics\\DataStructures\\StrictQueue\u003A\u003Aenqueue\u0028\u0029", + "name": "enqueue", + "summary": "Add\u0020an\u0020item\u0020to\u0020the\u0020queue.", + "url": "classes/OCC-Basics-DataStructures-StrictQueue.html#method_enqueue" + }, { + "fqsen": "\\OCC\\Basics\\DataStructures\\StrictQueue\u003A\u003AsetIteratorMode\u0028\u0029", + "name": "setIteratorMode", + "summary": "Set\u0020the\u0020mode\u0020of\u0020iteration.", + "url": "classes/OCC-Basics-DataStructures-StrictQueue.html#method_setIteratorMode" + }, { + "fqsen": "\\OCC\\Basics\\DataStructures\\StrictQueue\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "Create\u0020a\u0020type\u002Dsensitive,\u0020traversable\u0020queue\u0020of\u0020items.", + "url": "classes/OCC-Basics-DataStructures-StrictQueue.html#method___construct" + }, { + "fqsen": "\\OCC\\Basics\\DataStructures\\StrictStack", + "name": "StrictStack", + "summary": "A\u0020type\u002Dsensitive,\u0020taversable\u0020Last\u0020In,\u0020First\u0020Out\u0020stack\u0020\u0028LIFO\u0029.", + "url": "classes/OCC-Basics-DataStructures-StrictStack.html" + }, { + "fqsen": "\\OCC\\Basics\\DataStructures\\StrictStack\u003A\u003Astack\u0028\u0029", + "name": "stack", + "summary": "Add\u0020an\u0020item\u0020to\u0020the\u0020stack.", + "url": "classes/OCC-Basics-DataStructures-StrictStack.html#method_stack" + }, { + "fqsen": "\\OCC\\Basics\\DataStructures\\StrictStack\u003A\u003Aunstack\u0028\u0029", + "name": "unstack", + "summary": "Unstack\u0020an\u0020item\u0020from\u0020the\u0020stack.", + "url": "classes/OCC-Basics-DataStructures-StrictStack.html#method_unstack" + }, { + "fqsen": "\\OCC\\Basics\\DataStructures\\StrictStack\u003A\u003AsetIteratorMode\u0028\u0029", + "name": "setIteratorMode", + "summary": "Set\u0020the\u0020mode\u0020of\u0020iteration.", + "url": "classes/OCC-Basics-DataStructures-StrictStack.html#method_setIteratorMode" + }, { + "fqsen": "\\OCC\\Basics\\DataStructures\\StrictStack\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "Create\u0020a\u0020type\u002Dsensitive,\u0020traversable\u0020stack\u0020of\u0020items.", + "url": "classes/OCC-Basics-DataStructures-StrictStack.html#method___construct" + }, { + "fqsen": "\\OCC\\Basics\\ErrorHandlers\\ThrowErrorException", + "name": "ThrowErrorException", + "summary": "Throw\u0020internal\u0020errors\u0020as\u0020exceptions.", + "url": "classes/OCC-Basics-ErrorHandlers-ThrowErrorException.html" + }, { + "fqsen": "\\OCC\\Basics\\ErrorHandlers\\ThrowErrorException\u003A\u003A__invoke\u0028\u0029", + "name": "__invoke", + "summary": "Convert\u0020an\u0020internal\u0020PHP\u0020error\u0020into\u0020an\u0020ErrorException.", + "url": "classes/OCC-Basics-ErrorHandlers-ThrowErrorException.html#method___invoke" + }, { + "fqsen": "\\OCC\\Basics\\ErrorHandlers\\TriggerExceptionError", + "name": "TriggerExceptionError", + "summary": "Trigger\u0020errors\u0020for\u0020uncaught\u0020exceptions.", + "url": "classes/OCC-Basics-ErrorHandlers-TriggerExceptionError.html" + }, { + "fqsen": "\\OCC\\Basics\\ErrorHandlers\\TriggerExceptionError\u003A\u003A__invoke\u0028\u0029", + "name": "__invoke", + "summary": "Convert\u0020an\u0020uncaught\u0020exception\u0020into\u0020an\u0020PHP\u0020error.", + "url": "classes/OCC-Basics-ErrorHandlers-TriggerExceptionError.html#method___invoke" + }, { + "fqsen": "\\OCC\\Basics\\InterfaceTraits\\ArrayAccessTrait", + "name": "ArrayAccessTrait", + "summary": "A\u0020generic\u0020implementation\u0020of\u0020the\u0020ArrayAccess\u0020interface.", + "url": "classes/OCC-Basics-InterfaceTraits-ArrayAccessTrait.html" + }, { + "fqsen": "\\OCC\\Basics\\InterfaceTraits\\ArrayAccessTrait\u003A\u003AoffsetExists\u0028\u0029", + "name": "offsetExists", + "summary": "Check\u0020if\u0020the\u0020specified\u0020offset\u0020exists.", + "url": "classes/OCC-Basics-InterfaceTraits-ArrayAccessTrait.html#method_offsetExists" + }, { + "fqsen": "\\OCC\\Basics\\InterfaceTraits\\ArrayAccessTrait\u003A\u003AoffsetGet\u0028\u0029", + "name": "offsetGet", + "summary": "Retrieve\u0020data\u0020at\u0020the\u0020specified\u0020offset.", + "url": "classes/OCC-Basics-InterfaceTraits-ArrayAccessTrait.html#method_offsetGet" + }, { + "fqsen": "\\OCC\\Basics\\InterfaceTraits\\ArrayAccessTrait\u003A\u003AoffsetSet\u0028\u0029", + "name": "offsetSet", + "summary": "Assign\u0020a\u0020value\u0020to\u0020the\u0020specified\u0020offset.", + "url": "classes/OCC-Basics-InterfaceTraits-ArrayAccessTrait.html#method_offsetSet" + }, { + "fqsen": "\\OCC\\Basics\\InterfaceTraits\\ArrayAccessTrait\u003A\u003AoffsetUnset\u0028\u0029", + "name": "offsetUnset", + "summary": "Unset\u0020the\u0020specified\u0020offset.", + "url": "classes/OCC-Basics-InterfaceTraits-ArrayAccessTrait.html#method_offsetUnset" + }, { + "fqsen": "\\OCC\\Basics\\InterfaceTraits\\ArrayAccessTrait\u003A\u003A\u0024data", + "name": "data", + "summary": "Holds\u0020the\u0020array\u002Daccessible\u0020data.", + "url": "classes/OCC-Basics-InterfaceTraits-ArrayAccessTrait.html#property_data" + }, { + "fqsen": "\\OCC\\Basics\\InterfaceTraits\\CountableTrait", + "name": "CountableTrait", + "summary": "A\u0020generic\u0020implementation\u0020of\u0020the\u0020Countable\u0020interface.", + "url": "classes/OCC-Basics-InterfaceTraits-CountableTrait.html" + }, { + "fqsen": "\\OCC\\Basics\\InterfaceTraits\\CountableTrait\u003A\u003Acount\u0028\u0029", + "name": "count", + "summary": "Count\u0020the\u0020data\u0020items.", + "url": "classes/OCC-Basics-InterfaceTraits-CountableTrait.html#method_count" + }, { + "fqsen": "\\OCC\\Basics\\InterfaceTraits\\CountableTrait\u003A\u003A\u0024data", + "name": "data", + "summary": "Holds\u0020the\u0020countable\u0020data.", + "url": "classes/OCC-Basics-InterfaceTraits-CountableTrait.html#property_data" + }, { + "fqsen": "\\OCC\\Basics\\InterfaceTraits\\IteratorAggregateTrait", + "name": "IteratorAggregateTrait", + "summary": "A\u0020generic\u0020implementation\u0020of\u0020the\u0020IteratorAggregate\u0020interface.", + "url": "classes/OCC-Basics-InterfaceTraits-IteratorAggregateTrait.html" + }, { + "fqsen": "\\OCC\\Basics\\InterfaceTraits\\IteratorAggregateTrait\u003A\u003AgetIterator\u0028\u0029", + "name": "getIterator", + "summary": "Retrieve\u0020an\u0020external\u0020iterator.", + "url": "classes/OCC-Basics-InterfaceTraits-IteratorAggregateTrait.html#method_getIterator" + }, { + "fqsen": "\\OCC\\Basics\\InterfaceTraits\\IteratorAggregateTrait\u003A\u003A\u0024data", + "name": "data", + "summary": "Holds\u0020the\u0020iterable\u0020data.", + "url": "classes/OCC-Basics-InterfaceTraits-IteratorAggregateTrait.html#property_data" + }, { + "fqsen": "\\OCC\\Basics\\InterfaceTraits\\IteratorTrait", + "name": "IteratorTrait", + "summary": "A\u0020generic\u0020implementation\u0020of\u0020the\u0020Iterator\u0020interface.", + "url": "classes/OCC-Basics-InterfaceTraits-IteratorTrait.html" + }, { + "fqsen": "\\OCC\\Basics\\InterfaceTraits\\IteratorTrait\u003A\u003Acurrent\u0028\u0029", + "name": "current", + "summary": "Return\u0020the\u0020current\u0020item.", + "url": "classes/OCC-Basics-InterfaceTraits-IteratorTrait.html#method_current" + }, { + "fqsen": "\\OCC\\Basics\\InterfaceTraits\\IteratorTrait\u003A\u003Akey\u0028\u0029", + "name": "key", + "summary": "Return\u0020the\u0020current\u0020key.", + "url": "classes/OCC-Basics-InterfaceTraits-IteratorTrait.html#method_key" + }, { + "fqsen": "\\OCC\\Basics\\InterfaceTraits\\IteratorTrait\u003A\u003Anext\u0028\u0029", + "name": "next", + "summary": "Move\u0020forward\u0020to\u0020next\u0020item.", + "url": "classes/OCC-Basics-InterfaceTraits-IteratorTrait.html#method_next" + }, { + "fqsen": "\\OCC\\Basics\\InterfaceTraits\\IteratorTrait\u003A\u003Aprev\u0028\u0029", + "name": "prev", + "summary": "Move\u0020back\u0020to\u0020previous\u0020item.", + "url": "classes/OCC-Basics-InterfaceTraits-IteratorTrait.html#method_prev" + }, { + "fqsen": "\\OCC\\Basics\\InterfaceTraits\\IteratorTrait\u003A\u003Arewind\u0028\u0029", + "name": "rewind", + "summary": "Rewind\u0020the\u0020iterator\u0020to\u0020the\u0020first\u0020item.", + "url": "classes/OCC-Basics-InterfaceTraits-IteratorTrait.html#method_rewind" + }, { + "fqsen": "\\OCC\\Basics\\InterfaceTraits\\IteratorTrait\u003A\u003Avalid\u0028\u0029", + "name": "valid", + "summary": "Check\u0020if\u0020current\u0020position\u0020is\u0020valid.", + "url": "classes/OCC-Basics-InterfaceTraits-IteratorTrait.html#method_valid" + }, { + "fqsen": "\\OCC\\Basics\\InterfaceTraits\\IteratorTrait\u003A\u003A\u0024data", + "name": "data", + "summary": "Holds\u0020the\u0020iterable\u0020data.", + "url": "classes/OCC-Basics-InterfaceTraits-IteratorTrait.html#property_data" + }, { + "fqsen": "\\OCC\\Basics\\Traits\\Getter", + "name": "Getter", + "summary": "Reads\u0020data\u0020from\u0020inaccessible\u0020properties\u0020by\u0020using\u0020magic\u0020methods.", + "url": "classes/OCC-Basics-Traits-Getter.html" + }, { + "fqsen": "\\OCC\\Basics\\Traits\\Setter", + "name": "Setter", + "summary": "Writes\u0020data\u0020to\u0020inaccessible\u0020properties\u0020by\u0020using\u0020magic\u0020methods.", + "url": "classes/OCC-Basics-Traits-Setter.html" + }, { + "fqsen": "\\OCC\\Basics\\Traits\\Singleton", + "name": "Singleton", + "summary": "Allows\u0020just\u0020a\u0020single\u0020instance\u0020of\u0020the\u0020class\u0020using\u0020this\u0020trait.", + "url": "classes/OCC-Basics-Traits-Singleton.html" + }, { + "fqsen": "\\OCC\\Basics\\Traits\\Singleton\u003A\u003AgetInstance\u0028\u0029", + "name": "getInstance", + "summary": "Get\u0020a\u0020singleton\u0020instance\u0020of\u0020this\u0020class.", + "url": "classes/OCC-Basics-Traits-Singleton.html#method_getInstance" + }, { + "fqsen": "\\OCC\\Basics\\Traits\\Singleton\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "This\u0020is\u0020a\u0020singleton\u0020class,\u0020thus\u0020the\u0020constructor\u0020is\u0020private.", + "url": "classes/OCC-Basics-Traits-Singleton.html#method___construct" + }, { + "fqsen": "\\", + "name": "\\", + "summary": "", + "url": "namespaces/default.html" + }, { + "fqsen": "\\OCC\\Basics\\DataStructures", + "name": "DataStructures", + "summary": "", + "url": "namespaces/occ-basics-datastructures.html" + }, { + "fqsen": "\\OCC\\Basics", + "name": "Basics", + "summary": "", + "url": "namespaces/occ-basics.html" + }, { + "fqsen": "\\OCC", + "name": "OCC", + "summary": "", + "url": "namespaces/occ.html" + }, { + "fqsen": "\\OCC\\Basics\\ErrorHandlers", + "name": "ErrorHandlers", + "summary": "", + "url": "namespaces/occ-basics-errorhandlers.html" + }, { + "fqsen": "\\OCC\\Basics\\InterfaceTraits", + "name": "InterfaceTraits", + "summary": "", + "url": "namespaces/occ-basics-interfacetraits.html" + }, { + "fqsen": "\\OCC\\Basics\\Traits", + "name": "Traits", + "summary": "", + "url": "namespaces/occ-basics-traits.html" + } ] +); diff --git a/docs/js/template.js b/docs/js/template.js new file mode 100644 index 0000000..4938329 --- /dev/null +++ b/docs/js/template.js @@ -0,0 +1,17 @@ +(function(){ + window.addEventListener('load', () => { + const el = document.querySelector('.phpdocumentor-on-this-page__content') + if (!el) { + return; + } + + const observer = new IntersectionObserver( + ([e]) => { + e.target.classList.toggle("-stuck", e.intersectionRatio < 1); + }, + {threshold: [1]} + ); + + observer.observe(el); + }) +})(); diff --git a/docs/namespaces/default.html b/docs/namespaces/default.html new file mode 100644 index 0000000..2b1c8d7 --- /dev/null +++ b/docs/namespaces/default.html @@ -0,0 +1,327 @@ + + + + + PHP Basics + + + + + + + + + + + + + + + + + + + + + +
                                                              +

                                                              PHP Basics

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

                                                              API Documentation

                                                              + + +

                                                              + Table of Contents + + +

                                                              + + +

                                                              + Namespaces + + +

                                                              +
                                                              +
                                                              OCC
                                                              +
                                                              + + + + + + + + + + + + + +
                                                              +
                                                              +
                                                              +
                                                              +
                                                              
                                                              +        
                                                              + +
                                                              +
                                                              + + + +
                                                              +
                                                              +
                                                              + +
                                                              + On this page + +
                                                                +
                                                              • Table Of Contents
                                                              • +
                                                              • +
                                                                  +
                                                                +
                                                              • + + +
                                                              +
                                                              + +
                                                              +
                                                              +
                                                              +
                                                              +
                                                              +

                                                              Search results

                                                              + +
                                                              +
                                                              +
                                                                +
                                                                +
                                                                +
                                                                +
                                                                + + +
                                                                + + + + + + + + diff --git a/docs/namespaces/occ-basics-datastructures.html b/docs/namespaces/occ-basics-datastructures.html new file mode 100644 index 0000000..47938eb --- /dev/null +++ b/docs/namespaces/occ-basics-datastructures.html @@ -0,0 +1,329 @@ + + + + + PHP Basics + + + + + + + + + + + + + + + + + + + + + +
                                                                +

                                                                PHP Basics

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

                                                                DataStructures

                                                                + + +

                                                                + Table of Contents + + +

                                                                + + + + +

                                                                + Classes + + +

                                                                +
                                                                +
                                                                StrictList
                                                                A type-sensitive, taversable list.
                                                                StrictQueue
                                                                A type-sensitive, taversable First In, First Out queue (FIFO).
                                                                StrictStack
                                                                A type-sensitive, taversable Last In, First Out stack (LIFO).
                                                                + + + + + + + + + + + +
                                                                +
                                                                +
                                                                +
                                                                +
                                                                
                                                                +        
                                                                + +
                                                                +
                                                                + + + +
                                                                +
                                                                +
                                                                + +
                                                                + On this page + +
                                                                  +
                                                                • Table Of Contents
                                                                • +
                                                                • + +
                                                                • + + +
                                                                +
                                                                + +
                                                                +
                                                                +
                                                                +
                                                                +
                                                                +

                                                                Search results

                                                                + +
                                                                +
                                                                +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  + + +
                                                                  + + + + + + + + diff --git a/docs/namespaces/occ-basics-errorhandlers.html b/docs/namespaces/occ-basics-errorhandlers.html new file mode 100644 index 0000000..222aad7 --- /dev/null +++ b/docs/namespaces/occ-basics-errorhandlers.html @@ -0,0 +1,329 @@ + + + + + PHP Basics + + + + + + + + + + + + + + + + + + + + + +
                                                                  +

                                                                  PHP Basics

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

                                                                  ErrorHandlers

                                                                  + + +

                                                                  + Table of Contents + + +

                                                                  + + + + +

                                                                  + Classes + + +

                                                                  +
                                                                  +
                                                                  ThrowErrorException
                                                                  Throw internal errors as exceptions.
                                                                  TriggerExceptionError
                                                                  Trigger errors for uncaught exceptions.
                                                                  + + + + + + + + + + + +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  
                                                                  +        
                                                                  + +
                                                                  +
                                                                  + + + +
                                                                  +
                                                                  +
                                                                  + +
                                                                  + On this page + +
                                                                    +
                                                                  • Table Of Contents
                                                                  • +
                                                                  • + +
                                                                  • + + +
                                                                  +
                                                                  + +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  +

                                                                  Search results

                                                                  + +
                                                                  +
                                                                  +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    + + +
                                                                    + + + + + + + + diff --git a/docs/namespaces/occ-basics-interfacetraits.html b/docs/namespaces/occ-basics-interfacetraits.html new file mode 100644 index 0000000..511c470 --- /dev/null +++ b/docs/namespaces/occ-basics-interfacetraits.html @@ -0,0 +1,329 @@ + + + + + PHP Basics + + + + + + + + + + + + + + + + + + + + + +
                                                                    +

                                                                    PHP Basics

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

                                                                    InterfaceTraits

                                                                    + + +

                                                                    + Table of Contents + + +

                                                                    + + + + + +

                                                                    + Traits + + +

                                                                    +
                                                                    +
                                                                    ArrayAccessTrait
                                                                    A generic implementation of the ArrayAccess interface.
                                                                    CountableTrait
                                                                    A generic implementation of the Countable interface.
                                                                    IteratorAggregateTrait
                                                                    A generic implementation of the IteratorAggregate interface.
                                                                    IteratorTrait
                                                                    A generic implementation of the Iterator interface.
                                                                    + + + + + + + + + + +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    
                                                                    +        
                                                                    + +
                                                                    +
                                                                    + + + +
                                                                    +
                                                                    +
                                                                    + +
                                                                    + On this page + +
                                                                      +
                                                                    • Table Of Contents
                                                                    • +
                                                                    • + +
                                                                    • + + +
                                                                    +
                                                                    + +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    +

                                                                    Search results

                                                                    + +
                                                                    +
                                                                    +
                                                                      +
                                                                      +
                                                                      +
                                                                      +
                                                                      + + +
                                                                      + + + + + + + + diff --git a/docs/namespaces/occ-basics-traits.html b/docs/namespaces/occ-basics-traits.html new file mode 100644 index 0000000..a3831f6 --- /dev/null +++ b/docs/namespaces/occ-basics-traits.html @@ -0,0 +1,329 @@ + + + + + PHP Basics + + + + + + + + + + + + + + + + + + + + + +
                                                                      +

                                                                      PHP Basics

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

                                                                      Traits

                                                                      + + +

                                                                      + Table of Contents + + +

                                                                      + + + + + +

                                                                      + Traits + + +

                                                                      +
                                                                      +
                                                                      Getter
                                                                      Reads data from inaccessible properties by using magic methods.
                                                                      Setter
                                                                      Writes data to inaccessible properties by using magic methods.
                                                                      Singleton
                                                                      Allows just a single instance of the class using this trait.
                                                                      + + + + + + + + + + +
                                                                      +
                                                                      +
                                                                      +
                                                                      +
                                                                      
                                                                      +        
                                                                      + +
                                                                      +
                                                                      + + + +
                                                                      +
                                                                      +
                                                                      + +
                                                                      + On this page + +
                                                                        +
                                                                      • Table Of Contents
                                                                      • +
                                                                      • + +
                                                                      • + + +
                                                                      +
                                                                      + +
                                                                      +
                                                                      +
                                                                      +
                                                                      +
                                                                      +

                                                                      Search results

                                                                      + +
                                                                      +
                                                                      +
                                                                        +
                                                                        +
                                                                        +
                                                                        +
                                                                        + + +
                                                                        + + + + + + + + diff --git a/docs/namespaces/occ-basics.html b/docs/namespaces/occ-basics.html new file mode 100644 index 0000000..6aa8ea7 --- /dev/null +++ b/docs/namespaces/occ-basics.html @@ -0,0 +1,331 @@ + + + + + PHP Basics + + + + + + + + + + + + + + + + + + + + + +
                                                                        +

                                                                        PHP Basics

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

                                                                        Basics

                                                                        + + +

                                                                        + Table of Contents + + +

                                                                        + + +

                                                                        + Namespaces + + +

                                                                        +
                                                                        +
                                                                        DataStructures
                                                                        +
                                                                        ErrorHandlers
                                                                        +
                                                                        InterfaceTraits
                                                                        +
                                                                        Traits
                                                                        +
                                                                        + + + + + + + + + + + + + +
                                                                        +
                                                                        +
                                                                        +
                                                                        +
                                                                        
                                                                        +        
                                                                        + +
                                                                        +
                                                                        + + + +
                                                                        +
                                                                        +
                                                                        + +
                                                                        + On this page + +
                                                                          +
                                                                        • Table Of Contents
                                                                        • +
                                                                        • +
                                                                            +
                                                                          +
                                                                        • + + +
                                                                        +
                                                                        + +
                                                                        +
                                                                        +
                                                                        +
                                                                        +
                                                                        +

                                                                        Search results

                                                                        + +
                                                                        +
                                                                        +
                                                                          +
                                                                          +
                                                                          +
                                                                          +
                                                                          + + +
                                                                          + + + + + + + + diff --git a/docs/namespaces/occ.html b/docs/namespaces/occ.html new file mode 100644 index 0000000..21f265a --- /dev/null +++ b/docs/namespaces/occ.html @@ -0,0 +1,327 @@ + + + + + PHP Basics + + + + + + + + + + + + + + + + + + + + + +
                                                                          +

                                                                          PHP Basics

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

                                                                          OCC

                                                                          + + +

                                                                          + Table of Contents + + +

                                                                          + + +

                                                                          + Namespaces + + +

                                                                          +
                                                                          +
                                                                          Basics
                                                                          +
                                                                          + + + + + + + + + + + + + +
                                                                          +
                                                                          +
                                                                          +
                                                                          +
                                                                          
                                                                          +        
                                                                          + +
                                                                          +
                                                                          + + + +
                                                                          +
                                                                          +
                                                                          + +
                                                                          + On this page + +
                                                                            +
                                                                          • Table Of Contents
                                                                          • +
                                                                          • +
                                                                              +
                                                                            +
                                                                          • + + +
                                                                          +
                                                                          + +
                                                                          +
                                                                          +
                                                                          +
                                                                          +
                                                                          +

                                                                          Search results

                                                                          + +
                                                                          +
                                                                          +
                                                                            +
                                                                            +
                                                                            +
                                                                            +
                                                                            + + +
                                                                            + + + + + + + + diff --git a/docs/packages/Basics-DataStructures.html b/docs/packages/Basics-DataStructures.html new file mode 100644 index 0000000..cc962ac --- /dev/null +++ b/docs/packages/Basics-DataStructures.html @@ -0,0 +1,328 @@ + + + + + PHP Basics + + + + + + + + + + + + + + + + + + + + + +
                                                                            +

                                                                            PHP Basics

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

                                                                            DataStructures

                                                                            + + +

                                                                            + Table of Contents + + +

                                                                            + + + + +

                                                                            + Classes + + +

                                                                            +
                                                                            +
                                                                            StrictList
                                                                            A type-sensitive, taversable list.
                                                                            StrictQueue
                                                                            A type-sensitive, taversable First In, First Out queue (FIFO).
                                                                            StrictStack
                                                                            A type-sensitive, taversable Last In, First Out stack (LIFO).
                                                                            + + + + + + + + + + + +
                                                                            +
                                                                            +
                                                                            +
                                                                            +
                                                                            
                                                                            +        
                                                                            + +
                                                                            +
                                                                            + + + +
                                                                            +
                                                                            +
                                                                            + +
                                                                            + On this page + +
                                                                              +
                                                                            • Table Of Contents
                                                                            • +
                                                                            • + +
                                                                            • + + +
                                                                            +
                                                                            + +
                                                                            +
                                                                            +
                                                                            +
                                                                            +
                                                                            +

                                                                            Search results

                                                                            + +
                                                                            +
                                                                            +
                                                                              +
                                                                              +
                                                                              +
                                                                              +
                                                                              + + +
                                                                              + + + + + + + + diff --git a/docs/packages/Basics-ErrorHandlers.html b/docs/packages/Basics-ErrorHandlers.html new file mode 100644 index 0000000..a0e71b2 --- /dev/null +++ b/docs/packages/Basics-ErrorHandlers.html @@ -0,0 +1,328 @@ + + + + + PHP Basics + + + + + + + + + + + + + + + + + + + + + +
                                                                              +

                                                                              PHP Basics

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

                                                                              ErrorHandlers

                                                                              + + +

                                                                              + Table of Contents + + +

                                                                              + + + + +

                                                                              + Classes + + +

                                                                              +
                                                                              +
                                                                              ThrowErrorException
                                                                              Throw internal errors as exceptions.
                                                                              TriggerExceptionError
                                                                              Trigger errors for uncaught exceptions.
                                                                              + + + + + + + + + + + +
                                                                              +
                                                                              +
                                                                              +
                                                                              +
                                                                              
                                                                              +        
                                                                              + +
                                                                              +
                                                                              + + + +
                                                                              +
                                                                              +
                                                                              + +
                                                                              + On this page + +
                                                                                +
                                                                              • Table Of Contents
                                                                              • +
                                                                              • + +
                                                                              • + + +
                                                                              +
                                                                              + +
                                                                              +
                                                                              +
                                                                              +
                                                                              +
                                                                              +

                                                                              Search results

                                                                              + +
                                                                              +
                                                                              +
                                                                                +
                                                                                +
                                                                                +
                                                                                +
                                                                                + + +
                                                                                + + + + + + + + diff --git a/docs/packages/Basics-InterfaceTraits.html b/docs/packages/Basics-InterfaceTraits.html new file mode 100644 index 0000000..aacad61 --- /dev/null +++ b/docs/packages/Basics-InterfaceTraits.html @@ -0,0 +1,328 @@ + + + + + PHP Basics + + + + + + + + + + + + + + + + + + + + + +
                                                                                +

                                                                                PHP Basics

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

                                                                                InterfaceTraits

                                                                                + + +

                                                                                + Table of Contents + + +

                                                                                + + + + + +

                                                                                + Traits + + +

                                                                                +
                                                                                +
                                                                                ArrayAccessTrait
                                                                                A generic implementation of the ArrayAccess interface.
                                                                                CountableTrait
                                                                                A generic implementation of the Countable interface.
                                                                                IteratorAggregateTrait
                                                                                A generic implementation of the IteratorAggregate interface.
                                                                                IteratorTrait
                                                                                A generic implementation of the Iterator interface.
                                                                                + + + + + + + + + + +
                                                                                +
                                                                                +
                                                                                +
                                                                                +
                                                                                
                                                                                +        
                                                                                + +
                                                                                +
                                                                                + + + +
                                                                                +
                                                                                +
                                                                                + +
                                                                                + On this page + +
                                                                                  +
                                                                                • Table Of Contents
                                                                                • +
                                                                                • + +
                                                                                • + + +
                                                                                +
                                                                                + +
                                                                                +
                                                                                +
                                                                                +
                                                                                +
                                                                                +

                                                                                Search results

                                                                                + +
                                                                                +
                                                                                +
                                                                                  +
                                                                                  +
                                                                                  +
                                                                                  +
                                                                                  + + +
                                                                                  + + + + + + + + diff --git a/docs/packages/Basics-Traits.html b/docs/packages/Basics-Traits.html new file mode 100644 index 0000000..82a2fc4 --- /dev/null +++ b/docs/packages/Basics-Traits.html @@ -0,0 +1,328 @@ + + + + + PHP Basics + + + + + + + + + + + + + + + + + + + + + +
                                                                                  +

                                                                                  PHP Basics

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

                                                                                  Traits

                                                                                  + + +

                                                                                  + Table of Contents + + +

                                                                                  + + + + + +

                                                                                  + Traits + + +

                                                                                  +
                                                                                  +
                                                                                  Getter
                                                                                  Reads data from inaccessible properties by using magic methods.
                                                                                  Setter
                                                                                  Writes data to inaccessible properties by using magic methods.
                                                                                  Singleton
                                                                                  Allows just a single instance of the class using this trait.
                                                                                  + + + + + + + + + + +
                                                                                  +
                                                                                  +
                                                                                  +
                                                                                  +
                                                                                  
                                                                                  +        
                                                                                  + +
                                                                                  +
                                                                                  + + + +
                                                                                  +
                                                                                  +
                                                                                  + +
                                                                                  + On this page + +
                                                                                    +
                                                                                  • Table Of Contents
                                                                                  • +
                                                                                  • + +
                                                                                  • + + +
                                                                                  +
                                                                                  + +
                                                                                  +
                                                                                  +
                                                                                  +
                                                                                  +
                                                                                  +

                                                                                  Search results

                                                                                  + +
                                                                                  +
                                                                                  +
                                                                                    +
                                                                                    +
                                                                                    +
                                                                                    +
                                                                                    + + +
                                                                                    + + + + + + + + diff --git a/docs/packages/Basics.html b/docs/packages/Basics.html new file mode 100644 index 0000000..e32d0f1 --- /dev/null +++ b/docs/packages/Basics.html @@ -0,0 +1,330 @@ + + + + + PHP Basics + + + + + + + + + + + + + + + + + + + + + +
                                                                                    +

                                                                                    PHP Basics

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

                                                                                    Basics

                                                                                    + + +

                                                                                    + Table of Contents + + +

                                                                                    + +

                                                                                    + Packages + + +

                                                                                    +
                                                                                    +
                                                                                    DataStructures
                                                                                    +
                                                                                    ErrorHandlers
                                                                                    +
                                                                                    InterfaceTraits
                                                                                    +
                                                                                    Traits
                                                                                    +
                                                                                    + + + + + + + + + + + + + + +
                                                                                    +
                                                                                    +
                                                                                    +
                                                                                    +
                                                                                    
                                                                                    +        
                                                                                    + +
                                                                                    +
                                                                                    + + + +
                                                                                    +
                                                                                    +
                                                                                    + +
                                                                                    + On this page + +
                                                                                      +
                                                                                    • Table Of Contents
                                                                                    • +
                                                                                    • +
                                                                                        +
                                                                                      +
                                                                                    • + + +
                                                                                    +
                                                                                    + +
                                                                                    +
                                                                                    +
                                                                                    +
                                                                                    +
                                                                                    +

                                                                                    Search results

                                                                                    + +
                                                                                    +
                                                                                    +
                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      + + +
                                                                                      + + + + + + + + diff --git a/docs/packages/default.html b/docs/packages/default.html new file mode 100644 index 0000000..c37a255 --- /dev/null +++ b/docs/packages/default.html @@ -0,0 +1,327 @@ + + + + + PHP Basics + + + + + + + + + + + + + + + + + + + + + +
                                                                                      +

                                                                                      PHP Basics

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

                                                                                      API Documentation

                                                                                      + + +

                                                                                      + Table of Contents + + +

                                                                                      + +

                                                                                      + Packages + + +

                                                                                      +
                                                                                      +
                                                                                      Basics
                                                                                      +
                                                                                      + + + + + + + + + + + + + + +
                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      
                                                                                      +        
                                                                                      + +
                                                                                      +
                                                                                      + + + +
                                                                                      +
                                                                                      +
                                                                                      + +
                                                                                      + On this page + +
                                                                                        +
                                                                                      • Table Of Contents
                                                                                      • +
                                                                                      • +
                                                                                          +
                                                                                        +
                                                                                      • + + +
                                                                                      +
                                                                                      + +
                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      +

                                                                                      Search results

                                                                                      + +
                                                                                      +
                                                                                      +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        + + +
                                                                                        + + + + + + + + diff --git a/docs/reports/deprecated.html b/docs/reports/deprecated.html new file mode 100644 index 0000000..478c170 --- /dev/null +++ b/docs/reports/deprecated.html @@ -0,0 +1,195 @@ + + + + + PHP Basics » Deprecated elements + + + + + + + + + + + + + + + + + + + + + + +
                                                                                        +

                                                                                        PHP Basics

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

                                                                                        Deprecated

                                                                                        + + +
                                                                                        + No deprecated elements have been found in this project. +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +

                                                                                        Search results

                                                                                        + +
                                                                                        +
                                                                                        +
                                                                                          +
                                                                                          +
                                                                                          +
                                                                                          +
                                                                                          + + +
                                                                                          + + + + + + + + diff --git a/docs/reports/errors.html b/docs/reports/errors.html new file mode 100644 index 0000000..1bdc947 --- /dev/null +++ b/docs/reports/errors.html @@ -0,0 +1,194 @@ + + + + + PHP Basics » Compilation errors + + + + + + + + + + + + + + + + + + + + + + +
                                                                                          +

                                                                                          PHP Basics

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

                                                                                          Errors

                                                                                          + + +
                                                                                          No errors have been found in this project.
                                                                                          + +
                                                                                          +
                                                                                          +
                                                                                          +
                                                                                          +
                                                                                          +
                                                                                          +

                                                                                          Search results

                                                                                          + +
                                                                                          +
                                                                                          +
                                                                                            +
                                                                                            +
                                                                                            +
                                                                                            +
                                                                                            + + +
                                                                                            + + + + + + + + diff --git a/docs/reports/markers.html b/docs/reports/markers.html new file mode 100644 index 0000000..a35dc1e --- /dev/null +++ b/docs/reports/markers.html @@ -0,0 +1,195 @@ + + + + + PHP Basics » Markers + + + + + + + + + + + + + + + + + + + + + + +
                                                                                            +

                                                                                            PHP Basics

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

                                                                                            Markers

                                                                                            + +
                                                                                            + No markers have been found in this project. +
                                                                                            + +
                                                                                            +
                                                                                            +
                                                                                            +
                                                                                            +
                                                                                            +
                                                                                            +

                                                                                            Search results

                                                                                            + +
                                                                                            +
                                                                                            +
                                                                                              +
                                                                                              +
                                                                                              +
                                                                                              +
                                                                                              + + +
                                                                                              + + + + + + + + diff --git a/phpdoc.dist.xml b/phpdoc.dist.xml index b40c56a..8c5f41f 100644 --- a/phpdoc.dist.xml +++ b/phpdoc.dist.xml @@ -6,7 +6,7 @@ xsi:schemaLocation="https://www.phpdoc.org https://raw.githubusercontent.com/phpDocumentor/phpDocumentor/master/data/xsd/phpdoc.xsd"> PHP Basics - doc + docs .phpdoc/cache