sebastian-meyer
/
php-basics
mirror of https://github.com/opencultureconsulting/php-basics.git
2
0
Fork 0
Code Issues

Update documentation

This commit is contained in:
Sebastian Meyer 2024-04-03 22:32:46 +02:00 committed by Sebastian Meyer
parent 22a3774dcf
commit e3c315d149
47 changed files with 1090 additions and 10241 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1073
doc/classes/OCC-Basics-DataStructures-Collection.html
View File

File diff suppressed because it is too large Load Diff

420
doc/classes/OCC-Basics-DataStructures-StrictArray.html
View File

@ -207,9 +207,9 @@
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/StrictArray.php"><a href="files/src-datastructures-strictarray.html"><abbr title="src/DataStructures/StrictArray.php">StrictArray.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/StrictArray.php"><a href="files/src-datastructures-strictarray.html"><abbr title="src/DataStructures/StrictArray.php">StrictArray.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">48</span> <span class="phpdocumentor-element-found-in__line">50</span>
<a href="classes/OCC-Basics-DataStructures-StrictArray.html#source-view.48" class="phpdocumentor-element-found-in__source" data-line="48" data-modal="source-view" data-src="files/src/DataStructures/StrictArray.php.txt"></a> <a href="classes/OCC-Basics-DataStructures-StrictArray.html#source-view.50" class="phpdocumentor-element-found-in__source" data-line="50" data-modal="source-view" data-src="files/src/DataStructures/StrictArray.php.txt"></a>
</aside> </aside>
<p class="phpdocumentor-summary">A type-sensitive, traversable array.</p> <p class="phpdocumentor-summary">A type-sensitive, traversable array.</p>
@ -292,6 +292,13 @@ names.</p>
</dt> </dt>
<dd>Add/insert a item at the specified index.</dd> <dd>Add/insert a item at the specified index.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-DataStructures-StrictArray.html#method_bottom">bottom()</a>
<span>
&nbsp;: <abbr title="\OCC\Basics\DataStructures\AllowedType">AllowedType</abbr> </span>
</dt>
<dd>Peek at the first item of the array.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-DataStructures-StrictCollection.html#method_clear">clear()</a> <a href="classes/OCC-Basics-DataStructures-StrictCollection.html#method_clear">clear()</a>
<span> <span>
@ -397,6 +404,13 @@ names.</p>
</dt> </dt>
<dd>Unset the specified offset.</dd> <dd>Unset the specified offset.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-DataStructures-StrictArray.html#method_pop">pop()</a>
<span>
&nbsp;: <abbr title="\OCC\Basics\DataStructures\AllowedType">AllowedType</abbr> </span>
</dt>
<dd>Pop the item from the end of the array.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-Interfaces-IteratorTrait.html#method_prev">prev()</a> <a href="classes/OCC-Basics-Interfaces-IteratorTrait.html#method_prev">prev()</a>
<span> <span>
@ -404,6 +418,13 @@ names.</p>
</dt> </dt>
<dd>Move back to previous item.</dd> <dd>Move back to previous item.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-DataStructures-StrictArray.html#method_push">push()</a>
<span>
&nbsp;: void </span>
</dt>
<dd>Push an item at the end of the array.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-DataStructures-StrictCollection.html#method_remove">remove()</a> <a href="classes/OCC-Basics-DataStructures-StrictCollection.html#method_remove">remove()</a>
<span> <span>
@ -439,6 +460,13 @@ names.</p>
</dt> </dt>
<dd>Set allowed data types.</dd> <dd>Set allowed data types.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-DataStructures-StrictArray.html#method_shift">shift()</a>
<span>
&nbsp;: <abbr title="\OCC\Basics\DataStructures\AllowedType">AllowedType</abbr> </span>
</dt>
<dd>Shift the item from the beginning of the array.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-DataStructures-StrictCollection.html#method_toArray">toArray()</a> <a href="classes/OCC-Basics-DataStructures-StrictCollection.html#method_toArray">toArray()</a>
<span> <span>
@ -446,6 +474,13 @@ names.</p>
</dt> </dt>
<dd>Return array representation of collection.</dd> <dd>Return array representation of collection.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-DataStructures-StrictArray.html#method_top">top()</a>
<span>
&nbsp;: <abbr title="\OCC\Basics\DataStructures\AllowedType">AllowedType</abbr> </span>
</dt>
<dd>Peek at the last item of the array.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-DataStructures-StrictCollection.html#method_toStrictList">toStrictList()</a> <a href="classes/OCC-Basics-DataStructures-StrictCollection.html#method_toStrictList">toStrictList()</a>
<span> <span>
@ -460,6 +495,13 @@ names.</p>
</dt> </dt>
<dd>Restore $this from string representation.</dd> <dd>Restore $this from string representation.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-DataStructures-StrictArray.html#method_unshift">unshift()</a>
<span>
&nbsp;: void </span>
</dt>
<dd>Prepend the array with an item.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-Interfaces-IteratorTrait.html#method_valid">valid()</a> <a href="classes/OCC-Basics-Interfaces-IteratorTrait.html#method_valid">valid()</a>
<span> <span>
@ -633,6 +675,66 @@ Possible values are:</p>
</dl> </dl>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_bottom">
bottom()
<a href="classes/OCC-Basics-DataStructures-StrictArray.html#method_bottom" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/StrictArray.php"><a href="files/src-datastructures-strictarray.html"><abbr title="src/DataStructures/StrictArray.php">StrictArray.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">64</span>
<a href="classes/OCC-Basics-DataStructures-StrictArray.html#source-view.64" class="phpdocumentor-element-found-in__source" data-line="64" data-modal="source-view" data-src="files/src/DataStructures/StrictArray.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">Peek at the first item of the array.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">bottom</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><abbr title="\OCC\Basics\DataStructures\AllowedType">AllowedType</abbr></span></code>
<div class="phpdocumentor-label-line">
<div class="phpdocumentor-label phpdocumentor-label--success"><span>API</span><span>Yes</span></div>
</div>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/OCC-Basics-DataStructures-StrictArray.html#method_bottom#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\RuntimeException">RuntimeException</abbr></span>
<section class="phpdocumentor-description"><p>if the array is empty</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><abbr title="\OCC\Basics\DataStructures\AllowedType">AllowedType</abbr></span>
&mdash;
<section class="phpdocumentor-description"><p>The first item of the array</p>
</section>
</section>
</article> </article>
<article <article
class="phpdocumentor-element class="phpdocumentor-element
@ -1374,6 +1476,66 @@ from <code class="prettyprint">0</code>.</p>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_pop">
pop()
<a href="classes/OCC-Basics-DataStructures-StrictArray.html#method_pop" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/StrictArray.php"><a href="files/src-datastructures-strictarray.html"><abbr title="src/DataStructures/StrictArray.php">StrictArray.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">84</span>
<a href="classes/OCC-Basics-DataStructures-StrictArray.html#source-view.84" class="phpdocumentor-element-found-in__source" data-line="84" data-modal="source-view" data-src="files/src/DataStructures/StrictArray.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">Pop the item from the end of the array.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">pop</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><abbr title="\OCC\Basics\DataStructures\AllowedType">AllowedType</abbr></span></code>
<div class="phpdocumentor-label-line">
<div class="phpdocumentor-label phpdocumentor-label--success"><span>API</span><span>Yes</span></div>
</div>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/OCC-Basics-DataStructures-StrictArray.html#method_pop#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\RuntimeException">RuntimeException</abbr></span>
<section class="phpdocumentor-description"><p>if the array is empty</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><abbr title="\OCC\Basics\DataStructures\AllowedType">AllowedType</abbr></span>
&mdash;
<section class="phpdocumentor-description"><p>The last item of the array</p>
</section>
</section>
</article> </article>
<article <article
class="phpdocumentor-element class="phpdocumentor-element
@ -1409,6 +1571,70 @@ from <code class="prettyprint">0</code>.</p>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_push">
push()
<a href="classes/OCC-Basics-DataStructures-StrictArray.html#method_push" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/StrictArray.php"><a href="files/src-datastructures-strictarray.html"><abbr title="src/DataStructures/StrictArray.php">StrictArray.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">105</span>
<a href="classes/OCC-Basics-DataStructures-StrictArray.html#source-view.105" class="phpdocumentor-element-found-in__source" data-line="105" data-modal="source-view" data-src="files/src/DataStructures/StrictArray.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">Push an item at the end of the array.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">push</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><abbr title="\OCC\Basics\DataStructures\AllowedType">AllowedType</abbr>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<div class="phpdocumentor-label-line">
<div class="phpdocumentor-label phpdocumentor-label--success"><span>API</span><span>Yes</span></div>
</div>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$value</span>
: <span class="phpdocumentor-signature__argument__return-type"><abbr title="\OCC\Basics\DataStructures\AllowedType">AllowedType</abbr></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The item to push</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/OCC-Basics-DataStructures-StrictArray.html#method_push#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/OCC-Basics-DataStructures-Exceptions-InvalidDataTypeException.html"><abbr title="\OCC\Basics\DataStructures\Exceptions\InvalidDataTypeException">InvalidDataTypeException</abbr></a></span>
<section class="phpdocumentor-description"><p>if <code class="prettyprint">$value</code> is not of allowed type</p>
</section>
</dd>
</dl>
</article> </article>
<article <article
class="phpdocumentor-element class="phpdocumentor-element
@ -1686,6 +1912,66 @@ from <code class="prettyprint">0</code>.</p>
</dl> </dl>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_shift">
shift()
<a href="classes/OCC-Basics-DataStructures-StrictArray.html#method_shift" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/StrictArray.php"><a href="files/src-datastructures-strictarray.html"><abbr title="src/DataStructures/StrictArray.php">StrictArray.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">127</span>
<a href="classes/OCC-Basics-DataStructures-StrictArray.html#source-view.127" class="phpdocumentor-element-found-in__source" data-line="127" data-modal="source-view" data-src="files/src/DataStructures/StrictArray.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">Shift the item from the beginning of the array.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">shift</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><abbr title="\OCC\Basics\DataStructures\AllowedType">AllowedType</abbr></span></code>
<div class="phpdocumentor-label-line">
<div class="phpdocumentor-label phpdocumentor-label--success"><span>API</span><span>Yes</span></div>
</div>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/OCC-Basics-DataStructures-StrictArray.html#method_shift#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\RuntimeException">RuntimeException</abbr></span>
<section class="phpdocumentor-description"><p>if the array is empty</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><abbr title="\OCC\Basics\DataStructures\AllowedType">AllowedType</abbr></span>
&mdash;
<section class="phpdocumentor-description"><p>The first item of the array</p>
</section>
</section>
</article> </article>
<article <article
class="phpdocumentor-element class="phpdocumentor-element
@ -1729,6 +2015,66 @@ from <code class="prettyprint">0</code>.</p>
</section> </section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_top">
top()
<a href="classes/OCC-Basics-DataStructures-StrictArray.html#method_top" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/StrictArray.php"><a href="files/src-datastructures-strictarray.html"><abbr title="src/DataStructures/StrictArray.php">StrictArray.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">146</span>
<a href="classes/OCC-Basics-DataStructures-StrictArray.html#source-view.146" class="phpdocumentor-element-found-in__source" data-line="146" data-modal="source-view" data-src="files/src/DataStructures/StrictArray.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">Peek at the last item of the array.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">top</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><abbr title="\OCC\Basics\DataStructures\AllowedType">AllowedType</abbr></span></code>
<div class="phpdocumentor-label-line">
<div class="phpdocumentor-label phpdocumentor-label--success"><span>API</span><span>Yes</span></div>
</div>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/OCC-Basics-DataStructures-StrictArray.html#method_top#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\RuntimeException">RuntimeException</abbr></span>
<section class="phpdocumentor-description"><p>if the array is empty</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><abbr title="\OCC\Basics\DataStructures\AllowedType">AllowedType</abbr></span>
&mdash;
<section class="phpdocumentor-description"><p>The last item of the array</p>
</section>
</section>
</article> </article>
<article <article
class="phpdocumentor-element class="phpdocumentor-element
@ -1842,6 +2188,70 @@ from <code class="prettyprint">0</code>.</p>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_unshift">
unshift()
<a href="classes/OCC-Basics-DataStructures-StrictArray.html#method_unshift" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/StrictArray.php"><a href="files/src-datastructures-strictarray.html"><abbr title="src/DataStructures/StrictArray.php">StrictArray.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">168</span>
<a href="classes/OCC-Basics-DataStructures-StrictArray.html#source-view.168" class="phpdocumentor-element-found-in__source" data-line="168" data-modal="source-view" data-src="files/src/DataStructures/StrictArray.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">Prepend the array with an item.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">unshift</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><abbr title="\OCC\Basics\DataStructures\AllowedType">AllowedType</abbr>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<div class="phpdocumentor-label-line">
<div class="phpdocumentor-label phpdocumentor-label--success"><span>API</span><span>Yes</span></div>
</div>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$value</span>
: <span class="phpdocumentor-signature__argument__return-type"><abbr title="\OCC\Basics\DataStructures\AllowedType">AllowedType</abbr></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The item to unshift</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/OCC-Basics-DataStructures-StrictArray.html#method_unshift#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/OCC-Basics-DataStructures-Exceptions-InvalidDataTypeException.html"><abbr title="\OCC\Basics\DataStructures\Exceptions\InvalidDataTypeException">InvalidDataTypeException</abbr></a></span>
<section class="phpdocumentor-description"><p>if <code class="prettyprint">$value</code> is not of allowed type</p>
</section>
</dd>
</dl>
</article> </article>
<article <article
class="phpdocumentor-element class="phpdocumentor-element
@ -2001,6 +2411,7 @@ from <code class="prettyprint">0</code>.</p>
<ul class="phpdocumentor-list -clean"> <ul class="phpdocumentor-list -clean">
<li><a href="classes/OCC-Basics-DataStructures-StrictCollection.html#method___construct">__construct()</a></li> <li><a href="classes/OCC-Basics-DataStructures-StrictCollection.html#method___construct">__construct()</a></li>
<li><a href="classes/OCC-Basics-DataStructures-StrictCollection.html#method_add">add()</a></li> <li><a href="classes/OCC-Basics-DataStructures-StrictCollection.html#method_add">add()</a></li>
<li><a href="classes/OCC-Basics-DataStructures-StrictArray.html#method_bottom">bottom()</a></li>
<li><a href="classes/OCC-Basics-DataStructures-StrictCollection.html#method_clear">clear()</a></li> <li><a href="classes/OCC-Basics-DataStructures-StrictCollection.html#method_clear">clear()</a></li>
<li><a href="classes/OCC-Basics-Interfaces-CountableTrait.html#method_count">count()</a></li> <li><a href="classes/OCC-Basics-Interfaces-CountableTrait.html#method_count">count()</a></li>
<li><a href="classes/OCC-Basics-Interfaces-IteratorTrait.html#method_current">current()</a></li> <li><a href="classes/OCC-Basics-Interfaces-IteratorTrait.html#method_current">current()</a></li>
@ -2016,15 +2427,20 @@ from <code class="prettyprint">0</code>.</p>
<li><a href="classes/OCC-Basics-Interfaces-ArrayAccessTrait.html#method_offsetGet">offsetGet()</a></li> <li><a href="classes/OCC-Basics-Interfaces-ArrayAccessTrait.html#method_offsetGet">offsetGet()</a></li>
<li><a href="classes/OCC-Basics-Interfaces-ArrayAccessTrait.html#method_offsetSet">offsetSet()</a></li> <li><a href="classes/OCC-Basics-Interfaces-ArrayAccessTrait.html#method_offsetSet">offsetSet()</a></li>
<li><a href="classes/OCC-Basics-Interfaces-ArrayAccessTrait.html#method_offsetUnset">offsetUnset()</a></li> <li><a href="classes/OCC-Basics-Interfaces-ArrayAccessTrait.html#method_offsetUnset">offsetUnset()</a></li>
<li><a href="classes/OCC-Basics-DataStructures-StrictArray.html#method_pop">pop()</a></li>
<li><a href="classes/OCC-Basics-Interfaces-IteratorTrait.html#method_prev">prev()</a></li> <li><a href="classes/OCC-Basics-Interfaces-IteratorTrait.html#method_prev">prev()</a></li>
<li><a href="classes/OCC-Basics-DataStructures-StrictArray.html#method_push">push()</a></li>
<li><a href="classes/OCC-Basics-DataStructures-StrictCollection.html#method_remove">remove()</a></li> <li><a href="classes/OCC-Basics-DataStructures-StrictCollection.html#method_remove">remove()</a></li>
<li><a href="classes/OCC-Basics-Interfaces-IteratorTrait.html#method_rewind">rewind()</a></li> <li><a href="classes/OCC-Basics-Interfaces-IteratorTrait.html#method_rewind">rewind()</a></li>
<li><a href="classes/OCC-Basics-DataStructures-StrictCollection.html#method_serialize">serialize()</a></li> <li><a href="classes/OCC-Basics-DataStructures-StrictCollection.html#method_serialize">serialize()</a></li>
<li><a href="classes/OCC-Basics-DataStructures-StrictCollection.html#method_set">set()</a></li> <li><a href="classes/OCC-Basics-DataStructures-StrictCollection.html#method_set">set()</a></li>
<li><a href="classes/OCC-Basics-Traits-TypeChecker.html#method_setAllowedTypes">setAllowedTypes()</a></li> <li><a href="classes/OCC-Basics-Traits-TypeChecker.html#method_setAllowedTypes">setAllowedTypes()</a></li>
<li><a href="classes/OCC-Basics-DataStructures-StrictArray.html#method_shift">shift()</a></li>
<li><a href="classes/OCC-Basics-DataStructures-StrictCollection.html#method_toArray">toArray()</a></li> <li><a href="classes/OCC-Basics-DataStructures-StrictCollection.html#method_toArray">toArray()</a></li>
<li><a href="classes/OCC-Basics-DataStructures-StrictArray.html#method_top">top()</a></li>
<li><a href="classes/OCC-Basics-DataStructures-StrictCollection.html#method_toStrictList">toStrictList()</a></li> <li><a href="classes/OCC-Basics-DataStructures-StrictCollection.html#method_toStrictList">toStrictList()</a></li>
<li><a href="classes/OCC-Basics-DataStructures-StrictCollection.html#method_unserialize">unserialize()</a></li> <li><a href="classes/OCC-Basics-DataStructures-StrictCollection.html#method_unserialize">unserialize()</a></li>
<li><a href="classes/OCC-Basics-DataStructures-StrictArray.html#method_unshift">unshift()</a></li>
<li><a href="classes/OCC-Basics-Interfaces-IteratorTrait.html#method_valid">valid()</a></li> <li><a href="classes/OCC-Basics-Interfaces-IteratorTrait.html#method_valid">valid()</a></li>
</ul> </ul>
</li> </li>

162
doc/classes/OCC-Basics-DataStructures-StrictList.html
View File

@ -193,7 +193,7 @@
<span class="phpdocumentor-element__extends"> <span class="phpdocumentor-element__extends">
Uses Uses
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html"><abbr title="\OCC\Basics\DataStructures\Traits\StrictSplDatastructureTrait">StrictSplDatastructureTrait</abbr></a> </span> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html"><abbr title="\OCC\Basics\DataStructures\Traits\StrictSplDoublyLinkedListTrait">StrictSplDoublyLinkedListTrait</abbr></a> </span>
</h2> </h2>
<div class="phpdocumentor-label-line"> <div class="phpdocumentor-label-line">
@ -267,98 +267,98 @@ constructor with an array of atomic types or fully qualified class names.</p>
</h4> </h4>
<dl class="phpdocumentor-table-of-contents"> <dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method___construct">__construct()</a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method___construct">__construct()</a>
<span> <span>
&nbsp;: void </span> &nbsp;: void </span>
</dt> </dt>
<dd>Create a type-sensitive, traversable list of items.</dd> <dd>Create a type-sensitive, traversable list of items.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_add">add()</a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_add">add()</a>
<span> <span>
&nbsp;: void </span> &nbsp;: void </span>
</dt> </dt>
<dd>Add/insert a new item at the specified offset.</dd> <dd>Add/insert a new item at the specified offset.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_append">append()</a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_append">append()</a>
<span> <span>
&nbsp;: void </span> &nbsp;: void </span>
</dt> </dt>
<dd>Append items at the end of the list.</dd> <dd>Append items at the end of the list.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_clear">clear()</a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_clear">clear()</a>
<span> <span>
&nbsp;: void </span> &nbsp;: void </span>
</dt> </dt>
<dd>Clear the list of any items.</dd> <dd>Clear the list of any items.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_get">get()</a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_get">get()</a>
<span> <span>
&nbsp;: <abbr title="\OCC\Basics\DataStructures\Traits\AllowedType">AllowedType</abbr> </span> &nbsp;: <abbr title="\OCC\Basics\DataStructures\Traits\AllowedType">AllowedType</abbr> </span>
</dt> </dt>
<dd>Get the item at the specified index.</dd> <dd>Get the item at the specified index.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_isList">isList()</a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_isList">isList()</a>
<span> <span>
&nbsp;: true </span> &nbsp;: true </span>
</dt> </dt>
<dd>Check if this can be considered a list.</dd> <dd>Check if this can be considered a list.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_offsetSet">offsetSet()</a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_offsetSet">offsetSet()</a>
<span> <span>
&nbsp;: void </span> &nbsp;: void </span>
</dt> </dt>
<dd>Set the item at the specified offset.</dd> <dd>Set the item at the specified offset.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_prepend">prepend()</a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_prepend">prepend()</a>
<span> <span>
&nbsp;: void </span> &nbsp;: void </span>
</dt> </dt>
<dd>Prepend items at the start of the list.</dd> <dd>Prepend items at the start of the list.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_push">push()</a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_push">push()</a>
<span> <span>
&nbsp;: void </span> &nbsp;: void </span>
</dt> </dt>
<dd>Push an item at the end of the list.</dd> <dd>Push an item at the end of the list.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_remove">remove()</a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_remove">remove()</a>
<span> <span>
&nbsp;: void </span> &nbsp;: void </span>
</dt> </dt>
<dd>Remove an item from the list.</dd> <dd>Remove an item from the list.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_set">set()</a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_set">set()</a>
<span> <span>
&nbsp;: void </span> &nbsp;: void </span>
</dt> </dt>
<dd>Set an item at the specified index.</dd> <dd>Set an item at the specified index.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_toArray">toArray()</a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_toArray">toArray()</a>
<span> <span>
&nbsp;: array&lt;int, <abbr title="\OCC\Basics\DataStructures\Traits\AllowedType">AllowedType</abbr>&gt; </span> &nbsp;: array&lt;int, <abbr title="\OCC\Basics\DataStructures\Traits\AllowedType">AllowedType</abbr>&gt; </span>
</dt> </dt>
<dd>Return array representation of list.</dd> <dd>Return array representation of list.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_toStrictCollection">toStrictCollection()</a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_toStrictCollection">toStrictCollection()</a>
<span> <span>
&nbsp;: <a href="classes/OCC-Basics-DataStructures-StrictCollection.html"><abbr title="\OCC\Basics\DataStructures\StrictCollection">StrictCollection</abbr></a>&lt;string|int, <abbr title="\OCC\Basics\DataStructures\Traits\AllowedType">AllowedType</abbr>&gt; </span> &nbsp;: <a href="classes/OCC-Basics-DataStructures-StrictCollection.html"><abbr title="\OCC\Basics\DataStructures\StrictCollection">StrictCollection</abbr></a>&lt;string|int, <abbr title="\OCC\Basics\DataStructures\Traits\AllowedType">AllowedType</abbr>&gt; </span>
</dt> </dt>
<dd>Turn list into a type-sensitive collection.</dd> <dd>Turn list into a type-sensitive collection.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_unshift">unshift()</a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_unshift">unshift()</a>
<span> <span>
&nbsp;: void </span> &nbsp;: void </span>
</dt> </dt>
@ -387,15 +387,15 @@ constructor with an array of atomic types or fully qualified class names.</p>
> >
<h4 class="phpdocumentor-element__name" id="method___construct"> <h4 class="phpdocumentor-element__name" id="method___construct">
__construct() __construct()
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDatastructureTrait.php"><a href="files/src-datastructures-traits-strictspldatastructuretrait.html"><abbr title="src/DataStructures/Traits/StrictSplDatastructureTrait.php">StrictSplDatastructureTrait.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php"><a href="files/src-datastructures-traits-strictspldoublylinkedlisttrait.html"><abbr title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php">StrictSplDoublyLinkedListTrait.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">368</span> <span class="phpdocumentor-element-found-in__line">368</span>
<a href="classes/OCC-Basics-DataStructures-StrictList.html#source-view.368" class="phpdocumentor-element-found-in__source" data-line="368" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDatastructureTrait.php.txt"></a> <a href="classes/OCC-Basics-DataStructures-StrictList.html#source-view.368" class="phpdocumentor-element-found-in__source" data-line="368" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php.txt"></a>
</aside> </aside>
<p class="phpdocumentor-summary">Create a type-sensitive, traversable list of items.</p> <p class="phpdocumentor-summary">Create a type-sensitive, traversable list of items.</p>
@ -440,7 +440,7 @@ Possible values are:</p>
<h5 class="phpdocumentor-tag-list__heading" id="tags"> <h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags Tags
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method___construct#tags" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method___construct#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
@ -466,15 +466,15 @@ Possible values are:</p>
> >
<h4 class="phpdocumentor-element__name" id="method_add"> <h4 class="phpdocumentor-element__name" id="method_add">
add() add()
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_add" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_add" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDatastructureTrait.php"><a href="files/src-datastructures-traits-strictspldatastructuretrait.html"><abbr title="src/DataStructures/Traits/StrictSplDatastructureTrait.php">StrictSplDatastructureTrait.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php"><a href="files/src-datastructures-traits-strictspldoublylinkedlisttrait.html"><abbr title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php">StrictSplDoublyLinkedListTrait.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">71</span> <span class="phpdocumentor-element-found-in__line">71</span>
<a href="classes/OCC-Basics-DataStructures-StrictList.html#source-view.71" class="phpdocumentor-element-found-in__source" data-line="71" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDatastructureTrait.php.txt"></a> <a href="classes/OCC-Basics-DataStructures-StrictList.html#source-view.71" class="phpdocumentor-element-found-in__source" data-line="71" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php.txt"></a>
</aside> </aside>
<p class="phpdocumentor-summary">Add/insert a new item at the specified offset.</p> <p class="phpdocumentor-summary">Add/insert a new item at the specified offset.</p>
@ -513,7 +513,7 @@ Possible values are:</p>
<h5 class="phpdocumentor-tag-list__heading" id="tags"> <h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags Tags
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_add#tags" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_add#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
@ -549,15 +549,15 @@ Possible values are:</p>
> >
<h4 class="phpdocumentor-element__name" id="method_append"> <h4 class="phpdocumentor-element__name" id="method_append">
append() append()
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_append" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_append" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDatastructureTrait.php"><a href="files/src-datastructures-traits-strictspldatastructuretrait.html"><abbr title="src/DataStructures/Traits/StrictSplDatastructureTrait.php">StrictSplDatastructureTrait.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php"><a href="files/src-datastructures-traits-strictspldoublylinkedlisttrait.html"><abbr title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php">StrictSplDoublyLinkedListTrait.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">87</span> <span class="phpdocumentor-element-found-in__line">87</span>
<a href="classes/OCC-Basics-DataStructures-StrictList.html#source-view.87" class="phpdocumentor-element-found-in__source" data-line="87" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDatastructureTrait.php.txt"></a> <a href="classes/OCC-Basics-DataStructures-StrictList.html#source-view.87" class="phpdocumentor-element-found-in__source" data-line="87" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php.txt"></a>
</aside> </aside>
<p class="phpdocumentor-summary">Append items at the end of the list.</p> <p class="phpdocumentor-summary">Append items at the end of the list.</p>
@ -587,7 +587,7 @@ Possible values are:</p>
<h5 class="phpdocumentor-tag-list__heading" id="tags"> <h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags Tags
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_append#tags" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_append#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
@ -613,15 +613,15 @@ Possible values are:</p>
> >
<h4 class="phpdocumentor-element__name" id="method_clear"> <h4 class="phpdocumentor-element__name" id="method_clear">
clear() clear()
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_clear" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_clear" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDatastructureTrait.php"><a href="files/src-datastructures-traits-strictspldatastructuretrait.html"><abbr title="src/DataStructures/Traits/StrictSplDatastructureTrait.php">StrictSplDatastructureTrait.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php"><a href="files/src-datastructures-traits-strictspldoublylinkedlisttrait.html"><abbr title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php">StrictSplDoublyLinkedListTrait.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">113</span> <span class="phpdocumentor-element-found-in__line">113</span>
<a href="classes/OCC-Basics-DataStructures-StrictList.html#source-view.113" class="phpdocumentor-element-found-in__source" data-line="113" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDatastructureTrait.php.txt"></a> <a href="classes/OCC-Basics-DataStructures-StrictList.html#source-view.113" class="phpdocumentor-element-found-in__source" data-line="113" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php.txt"></a>
</aside> </aside>
<p class="phpdocumentor-summary">Clear the list of any items.</p> <p class="phpdocumentor-summary">Clear the list of any items.</p>
@ -648,15 +648,15 @@ Possible values are:</p>
> >
<h4 class="phpdocumentor-element__name" id="method_get"> <h4 class="phpdocumentor-element__name" id="method_get">
get() get()
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_get" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDatastructureTrait.php"><a href="files/src-datastructures-traits-strictspldatastructuretrait.html"><abbr title="src/DataStructures/Traits/StrictSplDatastructureTrait.php">StrictSplDatastructureTrait.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php"><a href="files/src-datastructures-traits-strictspldoublylinkedlisttrait.html"><abbr title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php">StrictSplDoublyLinkedListTrait.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">132</span> <span class="phpdocumentor-element-found-in__line">132</span>
<a href="classes/OCC-Basics-DataStructures-StrictList.html#source-view.132" class="phpdocumentor-element-found-in__source" data-line="132" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDatastructureTrait.php.txt"></a> <a href="classes/OCC-Basics-DataStructures-StrictList.html#source-view.132" class="phpdocumentor-element-found-in__source" data-line="132" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php.txt"></a>
</aside> </aside>
<p class="phpdocumentor-summary">Get the item at the specified index.</p> <p class="phpdocumentor-summary">Get the item at the specified index.</p>
@ -686,7 +686,7 @@ Possible values are:</p>
<h5 class="phpdocumentor-tag-list__heading" id="tags"> <h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags Tags
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_get#tags" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_get#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
@ -720,15 +720,15 @@ Possible values are:</p>
> >
<h4 class="phpdocumentor-element__name" id="method_isList"> <h4 class="phpdocumentor-element__name" id="method_isList">
isList() isList()
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_isList" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_isList" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDatastructureTrait.php"><a href="files/src-datastructures-traits-strictspldatastructuretrait.html"><abbr title="src/DataStructures/Traits/StrictSplDatastructureTrait.php">StrictSplDatastructureTrait.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php"><a href="files/src-datastructures-traits-strictspldoublylinkedlisttrait.html"><abbr title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php">StrictSplDoublyLinkedListTrait.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">144</span> <span class="phpdocumentor-element-found-in__line">144</span>
<a href="classes/OCC-Basics-DataStructures-StrictList.html#source-view.144" class="phpdocumentor-element-found-in__source" data-line="144" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDatastructureTrait.php.txt"></a> <a href="classes/OCC-Basics-DataStructures-StrictList.html#source-view.144" class="phpdocumentor-element-found-in__source" data-line="144" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php.txt"></a>
</aside> </aside>
<p class="phpdocumentor-summary">Check if this can be considered a list.</p> <p class="phpdocumentor-summary">Check if this can be considered a list.</p>
@ -763,15 +763,15 @@ Possible values are:</p>
> >
<h4 class="phpdocumentor-element__name" id="method_offsetSet"> <h4 class="phpdocumentor-element__name" id="method_offsetSet">
offsetSet() offsetSet()
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_offsetSet" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_offsetSet" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDatastructureTrait.php"><a href="files/src-datastructures-traits-strictspldatastructuretrait.html"><abbr title="src/DataStructures/Traits/StrictSplDatastructureTrait.php">StrictSplDatastructureTrait.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php"><a href="files/src-datastructures-traits-strictspldoublylinkedlisttrait.html"><abbr title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php">StrictSplDoublyLinkedListTrait.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">162</span> <span class="phpdocumentor-element-found-in__line">162</span>
<a href="classes/OCC-Basics-DataStructures-StrictList.html#source-view.162" class="phpdocumentor-element-found-in__source" data-line="162" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDatastructureTrait.php.txt"></a> <a href="classes/OCC-Basics-DataStructures-StrictList.html#source-view.162" class="phpdocumentor-element-found-in__source" data-line="162" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php.txt"></a>
</aside> </aside>
<p class="phpdocumentor-summary">Set the item at the specified offset.</p> <p class="phpdocumentor-summary">Set the item at the specified offset.</p>
@ -810,7 +810,7 @@ Possible values are:</p>
<h5 class="phpdocumentor-tag-list__heading" id="tags"> <h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags Tags
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_offsetSet#tags" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_offsetSet#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
@ -846,15 +846,15 @@ Possible values are:</p>
> >
<h4 class="phpdocumentor-element__name" id="method_prepend"> <h4 class="phpdocumentor-element__name" id="method_prepend">
prepend() prepend()
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_prepend" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_prepend" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDatastructureTrait.php"><a href="files/src-datastructures-traits-strictspldatastructuretrait.html"><abbr title="src/DataStructures/Traits/StrictSplDatastructureTrait.php">StrictSplDatastructureTrait.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php"><a href="files/src-datastructures-traits-strictspldoublylinkedlisttrait.html"><abbr title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php">StrictSplDoublyLinkedListTrait.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">187</span> <span class="phpdocumentor-element-found-in__line">187</span>
<a href="classes/OCC-Basics-DataStructures-StrictList.html#source-view.187" class="phpdocumentor-element-found-in__source" data-line="187" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDatastructureTrait.php.txt"></a> <a href="classes/OCC-Basics-DataStructures-StrictList.html#source-view.187" class="phpdocumentor-element-found-in__source" data-line="187" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php.txt"></a>
</aside> </aside>
<p class="phpdocumentor-summary">Prepend items at the start of the list.</p> <p class="phpdocumentor-summary">Prepend items at the start of the list.</p>
@ -884,7 +884,7 @@ Possible values are:</p>
<h5 class="phpdocumentor-tag-list__heading" id="tags"> <h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags Tags
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_prepend#tags" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_prepend#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
@ -910,15 +910,15 @@ Possible values are:</p>
> >
<h4 class="phpdocumentor-element__name" id="method_push"> <h4 class="phpdocumentor-element__name" id="method_push">
push() push()
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_push" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_push" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDatastructureTrait.php"><a href="files/src-datastructures-traits-strictspldatastructuretrait.html"><abbr title="src/DataStructures/Traits/StrictSplDatastructureTrait.php">StrictSplDatastructureTrait.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php"><a href="files/src-datastructures-traits-strictspldoublylinkedlisttrait.html"><abbr title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php">StrictSplDoublyLinkedListTrait.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">217</span> <span class="phpdocumentor-element-found-in__line">217</span>
<a href="classes/OCC-Basics-DataStructures-StrictList.html#source-view.217" class="phpdocumentor-element-found-in__source" data-line="217" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDatastructureTrait.php.txt"></a> <a href="classes/OCC-Basics-DataStructures-StrictList.html#source-view.217" class="phpdocumentor-element-found-in__source" data-line="217" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php.txt"></a>
</aside> </aside>
<p class="phpdocumentor-summary">Push an item at the end of the list.</p> <p class="phpdocumentor-summary">Push an item at the end of the list.</p>
@ -948,7 +948,7 @@ Possible values are:</p>
<h5 class="phpdocumentor-tag-list__heading" id="tags"> <h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags Tags
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_push#tags" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_push#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
@ -974,15 +974,15 @@ Possible values are:</p>
> >
<h4 class="phpdocumentor-element__name" id="method_remove"> <h4 class="phpdocumentor-element__name" id="method_remove">
remove() remove()
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_remove" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_remove" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDatastructureTrait.php"><a href="files/src-datastructures-traits-strictspldatastructuretrait.html"><abbr title="src/DataStructures/Traits/StrictSplDatastructureTrait.php">StrictSplDatastructureTrait.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php"><a href="files/src-datastructures-traits-strictspldoublylinkedlisttrait.html"><abbr title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php">StrictSplDoublyLinkedListTrait.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">241</span> <span class="phpdocumentor-element-found-in__line">241</span>
<a href="classes/OCC-Basics-DataStructures-StrictList.html#source-view.241" class="phpdocumentor-element-found-in__source" data-line="241" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDatastructureTrait.php.txt"></a> <a href="classes/OCC-Basics-DataStructures-StrictList.html#source-view.241" class="phpdocumentor-element-found-in__source" data-line="241" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php.txt"></a>
</aside> </aside>
<p class="phpdocumentor-summary">Remove an item from the list.</p> <p class="phpdocumentor-summary">Remove an item from the list.</p>
@ -1012,7 +1012,7 @@ Possible values are:</p>
<h5 class="phpdocumentor-tag-list__heading" id="tags"> <h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags Tags
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_remove#tags" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_remove#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
@ -1038,15 +1038,15 @@ Possible values are:</p>
> >
<h4 class="phpdocumentor-element__name" id="method_set"> <h4 class="phpdocumentor-element__name" id="method_set">
set() set()
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_set" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_set" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDatastructureTrait.php"><a href="files/src-datastructures-traits-strictspldatastructuretrait.html"><abbr title="src/DataStructures/Traits/StrictSplDatastructureTrait.php">StrictSplDatastructureTrait.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php"><a href="files/src-datastructures-traits-strictspldoublylinkedlisttrait.html"><abbr title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php">StrictSplDoublyLinkedListTrait.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">270</span> <span class="phpdocumentor-element-found-in__line">270</span>
<a href="classes/OCC-Basics-DataStructures-StrictList.html#source-view.270" class="phpdocumentor-element-found-in__source" data-line="270" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDatastructureTrait.php.txt"></a> <a href="classes/OCC-Basics-DataStructures-StrictList.html#source-view.270" class="phpdocumentor-element-found-in__source" data-line="270" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php.txt"></a>
</aside> </aside>
<p class="phpdocumentor-summary">Set an item at the specified index.</p> <p class="phpdocumentor-summary">Set an item at the specified index.</p>
@ -1085,7 +1085,7 @@ Possible values are:</p>
<h5 class="phpdocumentor-tag-list__heading" id="tags"> <h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags Tags
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_set#tags" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_set#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
@ -1111,15 +1111,15 @@ Possible values are:</p>
> >
<h4 class="phpdocumentor-element__name" id="method_toArray"> <h4 class="phpdocumentor-element__name" id="method_toArray">
toArray() toArray()
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_toArray" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_toArray" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDatastructureTrait.php"><a href="files/src-datastructures-traits-strictspldatastructuretrait.html"><abbr title="src/DataStructures/Traits/StrictSplDatastructureTrait.php">StrictSplDatastructureTrait.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php"><a href="files/src-datastructures-traits-strictspldoublylinkedlisttrait.html"><abbr title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php">StrictSplDoublyLinkedListTrait.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">282</span> <span class="phpdocumentor-element-found-in__line">282</span>
<a href="classes/OCC-Basics-DataStructures-StrictList.html#source-view.282" class="phpdocumentor-element-found-in__source" data-line="282" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDatastructureTrait.php.txt"></a> <a href="classes/OCC-Basics-DataStructures-StrictList.html#source-view.282" class="phpdocumentor-element-found-in__source" data-line="282" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php.txt"></a>
</aside> </aside>
<p class="phpdocumentor-summary">Return array representation of list.</p> <p class="phpdocumentor-summary">Return array representation of list.</p>
@ -1154,15 +1154,15 @@ Possible values are:</p>
> >
<h4 class="phpdocumentor-element__name" id="method_toStrictCollection"> <h4 class="phpdocumentor-element__name" id="method_toStrictCollection">
toStrictCollection() toStrictCollection()
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_toStrictCollection" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_toStrictCollection" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDatastructureTrait.php"><a href="files/src-datastructures-traits-strictspldatastructuretrait.html"><abbr title="src/DataStructures/Traits/StrictSplDatastructureTrait.php">StrictSplDatastructureTrait.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php"><a href="files/src-datastructures-traits-strictspldoublylinkedlisttrait.html"><abbr title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php">StrictSplDoublyLinkedListTrait.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">294</span> <span class="phpdocumentor-element-found-in__line">294</span>
<a href="classes/OCC-Basics-DataStructures-StrictList.html#source-view.294" class="phpdocumentor-element-found-in__source" data-line="294" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDatastructureTrait.php.txt"></a> <a href="classes/OCC-Basics-DataStructures-StrictList.html#source-view.294" class="phpdocumentor-element-found-in__source" data-line="294" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php.txt"></a>
</aside> </aside>
<p class="phpdocumentor-summary">Turn list into a type-sensitive collection.</p> <p class="phpdocumentor-summary">Turn list into a type-sensitive collection.</p>
@ -1197,15 +1197,15 @@ Possible values are:</p>
> >
<h4 class="phpdocumentor-element__name" id="method_unshift"> <h4 class="phpdocumentor-element__name" id="method_unshift">
unshift() unshift()
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_unshift" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_unshift" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDatastructureTrait.php"><a href="files/src-datastructures-traits-strictspldatastructuretrait.html"><abbr title="src/DataStructures/Traits/StrictSplDatastructureTrait.php">StrictSplDatastructureTrait.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php"><a href="files/src-datastructures-traits-strictspldoublylinkedlisttrait.html"><abbr title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php">StrictSplDoublyLinkedListTrait.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">330</span> <span class="phpdocumentor-element-found-in__line">330</span>
<a href="classes/OCC-Basics-DataStructures-StrictList.html#source-view.330" class="phpdocumentor-element-found-in__source" data-line="330" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDatastructureTrait.php.txt"></a> <a href="classes/OCC-Basics-DataStructures-StrictList.html#source-view.330" class="phpdocumentor-element-found-in__source" data-line="330" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php.txt"></a>
</aside> </aside>
<p class="phpdocumentor-summary">Prepend the list with an item.</p> <p class="phpdocumentor-summary">Prepend the list with an item.</p>
@ -1235,7 +1235,7 @@ Possible values are:</p>
<h5 class="phpdocumentor-tag-list__heading" id="tags"> <h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags Tags
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_unshift#tags" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_unshift#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
@ -1366,20 +1366,20 @@ Possible values are:</p>
<li class="phpdocumentor-on-this-page-section__title">Methods</li> <li class="phpdocumentor-on-this-page-section__title">Methods</li>
<li> <li>
<ul class="phpdocumentor-list -clean"> <ul class="phpdocumentor-list -clean">
<li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method___construct">__construct()</a></li> <li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method___construct">__construct()</a></li>
<li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_add">add()</a></li> <li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_add">add()</a></li>
<li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_append">append()</a></li> <li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_append">append()</a></li>
<li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_clear">clear()</a></li> <li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_clear">clear()</a></li>
<li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_get">get()</a></li> <li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_get">get()</a></li>
<li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_isList">isList()</a></li> <li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_isList">isList()</a></li>
<li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_offsetSet">offsetSet()</a></li> <li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_offsetSet">offsetSet()</a></li>
<li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_prepend">prepend()</a></li> <li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_prepend">prepend()</a></li>
<li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_push">push()</a></li> <li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_push">push()</a></li>
<li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_remove">remove()</a></li> <li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_remove">remove()</a></li>
<li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_set">set()</a></li> <li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_set">set()</a></li>
<li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_toArray">toArray()</a></li> <li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_toArray">toArray()</a></li>
<li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_toStrictCollection">toStrictCollection()</a></li> <li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_toStrictCollection">toStrictCollection()</a></li>
<li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_unshift">unshift()</a></li> <li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_unshift">unshift()</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>

238
doc/classes/OCC-Basics-DataStructures-StrictQueue.html
View File

@ -193,7 +193,7 @@
<span class="phpdocumentor-element__extends"> <span class="phpdocumentor-element__extends">
Uses Uses
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html"><abbr title="\OCC\Basics\DataStructures\Traits\StrictSplDatastructureTrait">StrictSplDatastructureTrait</abbr></a> </span> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html"><abbr title="\OCC\Basics\DataStructures\Traits\StrictSplDoublyLinkedListTrait">StrictSplDoublyLinkedListTrait</abbr></a> </span>
</h2> </h2>
<div class="phpdocumentor-label-line"> <div class="phpdocumentor-label-line">
@ -204,9 +204,9 @@
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/StrictQueue.php"><a href="files/src-datastructures-strictqueue.html"><abbr title="src/DataStructures/StrictQueue.php">StrictQueue.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/StrictQueue.php"><a href="files/src-datastructures-strictqueue.html"><abbr title="src/DataStructures/StrictQueue.php">StrictQueue.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">45</span> <span class="phpdocumentor-element-found-in__line">46</span>
<a href="classes/OCC-Basics-DataStructures-StrictQueue.html#source-view.45" class="phpdocumentor-element-found-in__source" data-line="45" data-modal="source-view" data-src="files/src/DataStructures/StrictQueue.php.txt"></a> <a href="classes/OCC-Basics-DataStructures-StrictQueue.html#source-view.46" class="phpdocumentor-element-found-in__source" data-line="46" data-modal="source-view" data-src="files/src/DataStructures/StrictQueue.php.txt"></a>
</aside> </aside>
<p class="phpdocumentor-summary">A type-sensitive, taversable queue (FIFO).</p> <p class="phpdocumentor-summary">A type-sensitive, taversable queue (FIFO).</p>
@ -267,33 +267,40 @@ array of atomic types or fully qualified class names.</p>
</h4> </h4>
<dl class="phpdocumentor-table-of-contents"> <dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method___construct">__construct()</a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method___construct">__construct()</a>
<span> <span>
&nbsp;: void </span> &nbsp;: void </span>
</dt> </dt>
<dd>Create a type-sensitive, traversable list of items.</dd> <dd>Create a type-sensitive, traversable list of items.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_add">add()</a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_add">add()</a>
<span> <span>
&nbsp;: void </span> &nbsp;: void </span>
</dt> </dt>
<dd>Add/insert a new item at the specified offset.</dd> <dd>Add/insert a new item at the specified offset.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_append">append()</a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_append">append()</a>
<span> <span>
&nbsp;: void </span> &nbsp;: void </span>
</dt> </dt>
<dd>Append items at the end of the list.</dd> <dd>Append items at the end of the list.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_clear">clear()</a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_clear">clear()</a>
<span> <span>
&nbsp;: void </span> &nbsp;: void </span>
</dt> </dt>
<dd>Clear the list of any items.</dd> <dd>Clear the list of any items.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-DataStructures-StrictQueue.html#method_dequeue">dequeue()</a>
<span>
&nbsp;: <abbr title="\OCC\Basics\DataStructures\AllowedType">AllowedType</abbr> </span>
</dt>
<dd>Dequeue an item from the queue.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-DataStructures-StrictQueue.html#method_enqueue">enqueue()</a> <a href="classes/OCC-Basics-DataStructures-StrictQueue.html#method_enqueue">enqueue()</a>
<span> <span>
@ -302,70 +309,70 @@ array of atomic types or fully qualified class names.</p>
<dd>Add an item to the queue.</dd> <dd>Add an item to the queue.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_get">get()</a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_get">get()</a>
<span> <span>
&nbsp;: <abbr title="\OCC\Basics\DataStructures\Traits\AllowedType">AllowedType</abbr> </span> &nbsp;: <abbr title="\OCC\Basics\DataStructures\Traits\AllowedType">AllowedType</abbr> </span>
</dt> </dt>
<dd>Get the item at the specified index.</dd> <dd>Get the item at the specified index.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_isList">isList()</a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_isList">isList()</a>
<span> <span>
&nbsp;: true </span> &nbsp;: true </span>
</dt> </dt>
<dd>Check if this can be considered a list.</dd> <dd>Check if this can be considered a list.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_offsetSet">offsetSet()</a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_offsetSet">offsetSet()</a>
<span> <span>
&nbsp;: void </span> &nbsp;: void </span>
</dt> </dt>
<dd>Set the item at the specified offset.</dd> <dd>Set the item at the specified offset.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_prepend">prepend()</a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_prepend">prepend()</a>
<span> <span>
&nbsp;: void </span> &nbsp;: void </span>
</dt> </dt>
<dd>Prepend items at the start of the list.</dd> <dd>Prepend items at the start of the list.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_push">push()</a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_push">push()</a>
<span> <span>
&nbsp;: void </span> &nbsp;: void </span>
</dt> </dt>
<dd>Push an item at the end of the list.</dd> <dd>Push an item at the end of the list.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_remove">remove()</a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_remove">remove()</a>
<span> <span>
&nbsp;: void </span> &nbsp;: void </span>
</dt> </dt>
<dd>Remove an item from the list.</dd> <dd>Remove an item from the list.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_set">set()</a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_set">set()</a>
<span> <span>
&nbsp;: void </span> &nbsp;: void </span>
</dt> </dt>
<dd>Set an item at the specified index.</dd> <dd>Set an item at the specified index.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_toArray">toArray()</a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_toArray">toArray()</a>
<span> <span>
&nbsp;: array&lt;int, <abbr title="\OCC\Basics\DataStructures\Traits\AllowedType">AllowedType</abbr>&gt; </span> &nbsp;: array&lt;int, <abbr title="\OCC\Basics\DataStructures\Traits\AllowedType">AllowedType</abbr>&gt; </span>
</dt> </dt>
<dd>Return array representation of list.</dd> <dd>Return array representation of list.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_toStrictCollection">toStrictCollection()</a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_toStrictCollection">toStrictCollection()</a>
<span> <span>
&nbsp;: <a href="classes/OCC-Basics-DataStructures-StrictCollection.html"><abbr title="\OCC\Basics\DataStructures\StrictCollection">StrictCollection</abbr></a>&lt;string|int, <abbr title="\OCC\Basics\DataStructures\Traits\AllowedType">AllowedType</abbr>&gt; </span> &nbsp;: <a href="classes/OCC-Basics-DataStructures-StrictCollection.html"><abbr title="\OCC\Basics\DataStructures\StrictCollection">StrictCollection</abbr></a>&lt;string|int, <abbr title="\OCC\Basics\DataStructures\Traits\AllowedType">AllowedType</abbr>&gt; </span>
</dt> </dt>
<dd>Turn list into a type-sensitive collection.</dd> <dd>Turn list into a type-sensitive collection.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_unshift">unshift()</a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_unshift">unshift()</a>
<span> <span>
&nbsp;: void </span> &nbsp;: void </span>
</dt> </dt>
@ -394,15 +401,15 @@ array of atomic types or fully qualified class names.</p>
> >
<h4 class="phpdocumentor-element__name" id="method___construct"> <h4 class="phpdocumentor-element__name" id="method___construct">
__construct() __construct()
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDatastructureTrait.php"><a href="files/src-datastructures-traits-strictspldatastructuretrait.html"><abbr title="src/DataStructures/Traits/StrictSplDatastructureTrait.php">StrictSplDatastructureTrait.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php"><a href="files/src-datastructures-traits-strictspldoublylinkedlisttrait.html"><abbr title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php">StrictSplDoublyLinkedListTrait.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">368</span> <span class="phpdocumentor-element-found-in__line">368</span>
<a href="classes/OCC-Basics-DataStructures-StrictQueue.html#source-view.368" class="phpdocumentor-element-found-in__source" data-line="368" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDatastructureTrait.php.txt"></a> <a href="classes/OCC-Basics-DataStructures-StrictQueue.html#source-view.368" class="phpdocumentor-element-found-in__source" data-line="368" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php.txt"></a>
</aside> </aside>
<p class="phpdocumentor-summary">Create a type-sensitive, traversable list of items.</p> <p class="phpdocumentor-summary">Create a type-sensitive, traversable list of items.</p>
@ -447,7 +454,7 @@ Possible values are:</p>
<h5 class="phpdocumentor-tag-list__heading" id="tags"> <h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags Tags
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method___construct#tags" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method___construct#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
@ -473,15 +480,15 @@ Possible values are:</p>
> >
<h4 class="phpdocumentor-element__name" id="method_add"> <h4 class="phpdocumentor-element__name" id="method_add">
add() add()
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_add" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_add" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDatastructureTrait.php"><a href="files/src-datastructures-traits-strictspldatastructuretrait.html"><abbr title="src/DataStructures/Traits/StrictSplDatastructureTrait.php">StrictSplDatastructureTrait.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php"><a href="files/src-datastructures-traits-strictspldoublylinkedlisttrait.html"><abbr title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php">StrictSplDoublyLinkedListTrait.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">71</span> <span class="phpdocumentor-element-found-in__line">71</span>
<a href="classes/OCC-Basics-DataStructures-StrictQueue.html#source-view.71" class="phpdocumentor-element-found-in__source" data-line="71" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDatastructureTrait.php.txt"></a> <a href="classes/OCC-Basics-DataStructures-StrictQueue.html#source-view.71" class="phpdocumentor-element-found-in__source" data-line="71" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php.txt"></a>
</aside> </aside>
<p class="phpdocumentor-summary">Add/insert a new item at the specified offset.</p> <p class="phpdocumentor-summary">Add/insert a new item at the specified offset.</p>
@ -520,7 +527,7 @@ Possible values are:</p>
<h5 class="phpdocumentor-tag-list__heading" id="tags"> <h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags Tags
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_add#tags" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_add#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
@ -556,15 +563,15 @@ Possible values are:</p>
> >
<h4 class="phpdocumentor-element__name" id="method_append"> <h4 class="phpdocumentor-element__name" id="method_append">
append() append()
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_append" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_append" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDatastructureTrait.php"><a href="files/src-datastructures-traits-strictspldatastructuretrait.html"><abbr title="src/DataStructures/Traits/StrictSplDatastructureTrait.php">StrictSplDatastructureTrait.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php"><a href="files/src-datastructures-traits-strictspldoublylinkedlisttrait.html"><abbr title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php">StrictSplDoublyLinkedListTrait.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">87</span> <span class="phpdocumentor-element-found-in__line">87</span>
<a href="classes/OCC-Basics-DataStructures-StrictQueue.html#source-view.87" class="phpdocumentor-element-found-in__source" data-line="87" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDatastructureTrait.php.txt"></a> <a href="classes/OCC-Basics-DataStructures-StrictQueue.html#source-view.87" class="phpdocumentor-element-found-in__source" data-line="87" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php.txt"></a>
</aside> </aside>
<p class="phpdocumentor-summary">Append items at the end of the list.</p> <p class="phpdocumentor-summary">Append items at the end of the list.</p>
@ -594,7 +601,7 @@ Possible values are:</p>
<h5 class="phpdocumentor-tag-list__heading" id="tags"> <h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags Tags
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_append#tags" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_append#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
@ -620,15 +627,15 @@ Possible values are:</p>
> >
<h4 class="phpdocumentor-element__name" id="method_clear"> <h4 class="phpdocumentor-element__name" id="method_clear">
clear() clear()
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_clear" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_clear" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDatastructureTrait.php"><a href="files/src-datastructures-traits-strictspldatastructuretrait.html"><abbr title="src/DataStructures/Traits/StrictSplDatastructureTrait.php">StrictSplDatastructureTrait.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php"><a href="files/src-datastructures-traits-strictspldoublylinkedlisttrait.html"><abbr title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php">StrictSplDoublyLinkedListTrait.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">113</span> <span class="phpdocumentor-element-found-in__line">113</span>
<a href="classes/OCC-Basics-DataStructures-StrictQueue.html#source-view.113" class="phpdocumentor-element-found-in__source" data-line="113" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDatastructureTrait.php.txt"></a> <a href="classes/OCC-Basics-DataStructures-StrictQueue.html#source-view.113" class="phpdocumentor-element-found-in__source" data-line="113" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php.txt"></a>
</aside> </aside>
<p class="phpdocumentor-summary">Clear the list of any items.</p> <p class="phpdocumentor-summary">Clear the list of any items.</p>
@ -646,6 +653,66 @@ Possible values are:</p>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_dequeue">
dequeue()
<a href="classes/OCC-Basics-DataStructures-StrictQueue.html#method_dequeue" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/StrictQueue.php"><a href="files/src-datastructures-strictqueue.html"><abbr title="src/DataStructures/StrictQueue.php">StrictQueue.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">60</span>
<a href="classes/OCC-Basics-DataStructures-StrictQueue.html#source-view.60" class="phpdocumentor-element-found-in__source" data-line="60" data-modal="source-view" data-src="files/src/DataStructures/StrictQueue.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">Dequeue an item from the queue.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">dequeue</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><abbr title="\OCC\Basics\DataStructures\AllowedType">AllowedType</abbr></span></code>
<div class="phpdocumentor-label-line">
<div class="phpdocumentor-label phpdocumentor-label--success"><span>API</span><span>Yes</span></div>
</div>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/OCC-Basics-DataStructures-StrictQueue.html#method_dequeue#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\RuntimeException">RuntimeException</abbr></span>
<section class="phpdocumentor-description"><p>if the queue is empty</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><abbr title="\OCC\Basics\DataStructures\AllowedType">AllowedType</abbr></span>
&mdash;
<section class="phpdocumentor-description"><p>The dequeued item</p>
</section>
</section>
</article> </article>
<article <article
class="phpdocumentor-element class="phpdocumentor-element
@ -661,9 +728,9 @@ Possible values are:</p>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/StrictQueue.php"><a href="files/src-datastructures-strictqueue.html"><abbr title="src/DataStructures/StrictQueue.php">StrictQueue.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/StrictQueue.php"><a href="files/src-datastructures-strictqueue.html"><abbr title="src/DataStructures/StrictQueue.php">StrictQueue.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">61</span> <span class="phpdocumentor-element-found-in__line">76</span>
<a href="classes/OCC-Basics-DataStructures-StrictQueue.html#source-view.61" class="phpdocumentor-element-found-in__source" data-line="61" data-modal="source-view" data-src="files/src/DataStructures/StrictQueue.php.txt"></a> <a href="classes/OCC-Basics-DataStructures-StrictQueue.html#source-view.76" class="phpdocumentor-element-found-in__source" data-line="76" data-modal="source-view" data-src="files/src/DataStructures/StrictQueue.php.txt"></a>
</aside> </aside>
<p class="phpdocumentor-summary">Add an item to the queue.</p> <p class="phpdocumentor-summary">Add an item to the queue.</p>
@ -719,15 +786,15 @@ Possible values are:</p>
> >
<h4 class="phpdocumentor-element__name" id="method_get"> <h4 class="phpdocumentor-element__name" id="method_get">
get() get()
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_get" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDatastructureTrait.php"><a href="files/src-datastructures-traits-strictspldatastructuretrait.html"><abbr title="src/DataStructures/Traits/StrictSplDatastructureTrait.php">StrictSplDatastructureTrait.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php"><a href="files/src-datastructures-traits-strictspldoublylinkedlisttrait.html"><abbr title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php">StrictSplDoublyLinkedListTrait.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">132</span> <span class="phpdocumentor-element-found-in__line">132</span>
<a href="classes/OCC-Basics-DataStructures-StrictQueue.html#source-view.132" class="phpdocumentor-element-found-in__source" data-line="132" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDatastructureTrait.php.txt"></a> <a href="classes/OCC-Basics-DataStructures-StrictQueue.html#source-view.132" class="phpdocumentor-element-found-in__source" data-line="132" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php.txt"></a>
</aside> </aside>
<p class="phpdocumentor-summary">Get the item at the specified index.</p> <p class="phpdocumentor-summary">Get the item at the specified index.</p>
@ -757,7 +824,7 @@ Possible values are:</p>
<h5 class="phpdocumentor-tag-list__heading" id="tags"> <h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags Tags
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_get#tags" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_get#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
@ -791,15 +858,15 @@ Possible values are:</p>
> >
<h4 class="phpdocumentor-element__name" id="method_isList"> <h4 class="phpdocumentor-element__name" id="method_isList">
isList() isList()
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_isList" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_isList" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDatastructureTrait.php"><a href="files/src-datastructures-traits-strictspldatastructuretrait.html"><abbr title="src/DataStructures/Traits/StrictSplDatastructureTrait.php">StrictSplDatastructureTrait.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php"><a href="files/src-datastructures-traits-strictspldoublylinkedlisttrait.html"><abbr title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php">StrictSplDoublyLinkedListTrait.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">144</span> <span class="phpdocumentor-element-found-in__line">144</span>
<a href="classes/OCC-Basics-DataStructures-StrictQueue.html#source-view.144" class="phpdocumentor-element-found-in__source" data-line="144" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDatastructureTrait.php.txt"></a> <a href="classes/OCC-Basics-DataStructures-StrictQueue.html#source-view.144" class="phpdocumentor-element-found-in__source" data-line="144" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php.txt"></a>
</aside> </aside>
<p class="phpdocumentor-summary">Check if this can be considered a list.</p> <p class="phpdocumentor-summary">Check if this can be considered a list.</p>
@ -834,15 +901,15 @@ Possible values are:</p>
> >
<h4 class="phpdocumentor-element__name" id="method_offsetSet"> <h4 class="phpdocumentor-element__name" id="method_offsetSet">
offsetSet() offsetSet()
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_offsetSet" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_offsetSet" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDatastructureTrait.php"><a href="files/src-datastructures-traits-strictspldatastructuretrait.html"><abbr title="src/DataStructures/Traits/StrictSplDatastructureTrait.php">StrictSplDatastructureTrait.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php"><a href="files/src-datastructures-traits-strictspldoublylinkedlisttrait.html"><abbr title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php">StrictSplDoublyLinkedListTrait.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">162</span> <span class="phpdocumentor-element-found-in__line">162</span>
<a href="classes/OCC-Basics-DataStructures-StrictQueue.html#source-view.162" class="phpdocumentor-element-found-in__source" data-line="162" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDatastructureTrait.php.txt"></a> <a href="classes/OCC-Basics-DataStructures-StrictQueue.html#source-view.162" class="phpdocumentor-element-found-in__source" data-line="162" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php.txt"></a>
</aside> </aside>
<p class="phpdocumentor-summary">Set the item at the specified offset.</p> <p class="phpdocumentor-summary">Set the item at the specified offset.</p>
@ -881,7 +948,7 @@ Possible values are:</p>
<h5 class="phpdocumentor-tag-list__heading" id="tags"> <h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags Tags
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_offsetSet#tags" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_offsetSet#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
@ -917,15 +984,15 @@ Possible values are:</p>
> >
<h4 class="phpdocumentor-element__name" id="method_prepend"> <h4 class="phpdocumentor-element__name" id="method_prepend">
prepend() prepend()
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_prepend" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_prepend" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDatastructureTrait.php"><a href="files/src-datastructures-traits-strictspldatastructuretrait.html"><abbr title="src/DataStructures/Traits/StrictSplDatastructureTrait.php">StrictSplDatastructureTrait.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php"><a href="files/src-datastructures-traits-strictspldoublylinkedlisttrait.html"><abbr title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php">StrictSplDoublyLinkedListTrait.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">187</span> <span class="phpdocumentor-element-found-in__line">187</span>
<a href="classes/OCC-Basics-DataStructures-StrictQueue.html#source-view.187" class="phpdocumentor-element-found-in__source" data-line="187" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDatastructureTrait.php.txt"></a> <a href="classes/OCC-Basics-DataStructures-StrictQueue.html#source-view.187" class="phpdocumentor-element-found-in__source" data-line="187" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php.txt"></a>
</aside> </aside>
<p class="phpdocumentor-summary">Prepend items at the start of the list.</p> <p class="phpdocumentor-summary">Prepend items at the start of the list.</p>
@ -955,7 +1022,7 @@ Possible values are:</p>
<h5 class="phpdocumentor-tag-list__heading" id="tags"> <h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags Tags
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_prepend#tags" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_prepend#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
@ -981,15 +1048,15 @@ Possible values are:</p>
> >
<h4 class="phpdocumentor-element__name" id="method_push"> <h4 class="phpdocumentor-element__name" id="method_push">
push() push()
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_push" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_push" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDatastructureTrait.php"><a href="files/src-datastructures-traits-strictspldatastructuretrait.html"><abbr title="src/DataStructures/Traits/StrictSplDatastructureTrait.php">StrictSplDatastructureTrait.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php"><a href="files/src-datastructures-traits-strictspldoublylinkedlisttrait.html"><abbr title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php">StrictSplDoublyLinkedListTrait.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">217</span> <span class="phpdocumentor-element-found-in__line">217</span>
<a href="classes/OCC-Basics-DataStructures-StrictQueue.html#source-view.217" class="phpdocumentor-element-found-in__source" data-line="217" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDatastructureTrait.php.txt"></a> <a href="classes/OCC-Basics-DataStructures-StrictQueue.html#source-view.217" class="phpdocumentor-element-found-in__source" data-line="217" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php.txt"></a>
</aside> </aside>
<p class="phpdocumentor-summary">Push an item at the end of the list.</p> <p class="phpdocumentor-summary">Push an item at the end of the list.</p>
@ -1019,7 +1086,7 @@ Possible values are:</p>
<h5 class="phpdocumentor-tag-list__heading" id="tags"> <h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags Tags
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_push#tags" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_push#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
@ -1045,15 +1112,15 @@ Possible values are:</p>
> >
<h4 class="phpdocumentor-element__name" id="method_remove"> <h4 class="phpdocumentor-element__name" id="method_remove">
remove() remove()
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_remove" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_remove" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDatastructureTrait.php"><a href="files/src-datastructures-traits-strictspldatastructuretrait.html"><abbr title="src/DataStructures/Traits/StrictSplDatastructureTrait.php">StrictSplDatastructureTrait.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php"><a href="files/src-datastructures-traits-strictspldoublylinkedlisttrait.html"><abbr title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php">StrictSplDoublyLinkedListTrait.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">241</span> <span class="phpdocumentor-element-found-in__line">241</span>
<a href="classes/OCC-Basics-DataStructures-StrictQueue.html#source-view.241" class="phpdocumentor-element-found-in__source" data-line="241" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDatastructureTrait.php.txt"></a> <a href="classes/OCC-Basics-DataStructures-StrictQueue.html#source-view.241" class="phpdocumentor-element-found-in__source" data-line="241" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php.txt"></a>
</aside> </aside>
<p class="phpdocumentor-summary">Remove an item from the list.</p> <p class="phpdocumentor-summary">Remove an item from the list.</p>
@ -1083,7 +1150,7 @@ Possible values are:</p>
<h5 class="phpdocumentor-tag-list__heading" id="tags"> <h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags Tags
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_remove#tags" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_remove#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
@ -1109,15 +1176,15 @@ Possible values are:</p>
> >
<h4 class="phpdocumentor-element__name" id="method_set"> <h4 class="phpdocumentor-element__name" id="method_set">
set() set()
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_set" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_set" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDatastructureTrait.php"><a href="files/src-datastructures-traits-strictspldatastructuretrait.html"><abbr title="src/DataStructures/Traits/StrictSplDatastructureTrait.php">StrictSplDatastructureTrait.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php"><a href="files/src-datastructures-traits-strictspldoublylinkedlisttrait.html"><abbr title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php">StrictSplDoublyLinkedListTrait.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">270</span> <span class="phpdocumentor-element-found-in__line">270</span>
<a href="classes/OCC-Basics-DataStructures-StrictQueue.html#source-view.270" class="phpdocumentor-element-found-in__source" data-line="270" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDatastructureTrait.php.txt"></a> <a href="classes/OCC-Basics-DataStructures-StrictQueue.html#source-view.270" class="phpdocumentor-element-found-in__source" data-line="270" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php.txt"></a>
</aside> </aside>
<p class="phpdocumentor-summary">Set an item at the specified index.</p> <p class="phpdocumentor-summary">Set an item at the specified index.</p>
@ -1156,7 +1223,7 @@ Possible values are:</p>
<h5 class="phpdocumentor-tag-list__heading" id="tags"> <h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags Tags
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_set#tags" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_set#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
@ -1182,15 +1249,15 @@ Possible values are:</p>
> >
<h4 class="phpdocumentor-element__name" id="method_toArray"> <h4 class="phpdocumentor-element__name" id="method_toArray">
toArray() toArray()
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_toArray" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_toArray" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDatastructureTrait.php"><a href="files/src-datastructures-traits-strictspldatastructuretrait.html"><abbr title="src/DataStructures/Traits/StrictSplDatastructureTrait.php">StrictSplDatastructureTrait.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php"><a href="files/src-datastructures-traits-strictspldoublylinkedlisttrait.html"><abbr title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php">StrictSplDoublyLinkedListTrait.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">282</span> <span class="phpdocumentor-element-found-in__line">282</span>
<a href="classes/OCC-Basics-DataStructures-StrictQueue.html#source-view.282" class="phpdocumentor-element-found-in__source" data-line="282" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDatastructureTrait.php.txt"></a> <a href="classes/OCC-Basics-DataStructures-StrictQueue.html#source-view.282" class="phpdocumentor-element-found-in__source" data-line="282" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php.txt"></a>
</aside> </aside>
<p class="phpdocumentor-summary">Return array representation of list.</p> <p class="phpdocumentor-summary">Return array representation of list.</p>
@ -1225,15 +1292,15 @@ Possible values are:</p>
> >
<h4 class="phpdocumentor-element__name" id="method_toStrictCollection"> <h4 class="phpdocumentor-element__name" id="method_toStrictCollection">
toStrictCollection() toStrictCollection()
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_toStrictCollection" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_toStrictCollection" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDatastructureTrait.php"><a href="files/src-datastructures-traits-strictspldatastructuretrait.html"><abbr title="src/DataStructures/Traits/StrictSplDatastructureTrait.php">StrictSplDatastructureTrait.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php"><a href="files/src-datastructures-traits-strictspldoublylinkedlisttrait.html"><abbr title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php">StrictSplDoublyLinkedListTrait.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">294</span> <span class="phpdocumentor-element-found-in__line">294</span>
<a href="classes/OCC-Basics-DataStructures-StrictQueue.html#source-view.294" class="phpdocumentor-element-found-in__source" data-line="294" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDatastructureTrait.php.txt"></a> <a href="classes/OCC-Basics-DataStructures-StrictQueue.html#source-view.294" class="phpdocumentor-element-found-in__source" data-line="294" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php.txt"></a>
</aside> </aside>
<p class="phpdocumentor-summary">Turn list into a type-sensitive collection.</p> <p class="phpdocumentor-summary">Turn list into a type-sensitive collection.</p>
@ -1268,15 +1335,15 @@ Possible values are:</p>
> >
<h4 class="phpdocumentor-element__name" id="method_unshift"> <h4 class="phpdocumentor-element__name" id="method_unshift">
unshift() unshift()
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_unshift" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_unshift" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDatastructureTrait.php"><a href="files/src-datastructures-traits-strictspldatastructuretrait.html"><abbr title="src/DataStructures/Traits/StrictSplDatastructureTrait.php">StrictSplDatastructureTrait.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php"><a href="files/src-datastructures-traits-strictspldoublylinkedlisttrait.html"><abbr title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php">StrictSplDoublyLinkedListTrait.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">330</span> <span class="phpdocumentor-element-found-in__line">330</span>
<a href="classes/OCC-Basics-DataStructures-StrictQueue.html#source-view.330" class="phpdocumentor-element-found-in__source" data-line="330" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDatastructureTrait.php.txt"></a> <a href="classes/OCC-Basics-DataStructures-StrictQueue.html#source-view.330" class="phpdocumentor-element-found-in__source" data-line="330" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php.txt"></a>
</aside> </aside>
<p class="phpdocumentor-summary">Prepend the list with an item.</p> <p class="phpdocumentor-summary">Prepend the list with an item.</p>
@ -1306,7 +1373,7 @@ Possible values are:</p>
<h5 class="phpdocumentor-tag-list__heading" id="tags"> <h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags Tags
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_unshift#tags" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_unshift#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
@ -1437,21 +1504,22 @@ Possible values are:</p>
<li class="phpdocumentor-on-this-page-section__title">Methods</li> <li class="phpdocumentor-on-this-page-section__title">Methods</li>
<li> <li>
<ul class="phpdocumentor-list -clean"> <ul class="phpdocumentor-list -clean">
<li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method___construct">__construct()</a></li> <li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method___construct">__construct()</a></li>
<li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_add">add()</a></li> <li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_add">add()</a></li>
<li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_append">append()</a></li> <li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_append">append()</a></li>
<li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_clear">clear()</a></li> <li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_clear">clear()</a></li>
<li><a href="classes/OCC-Basics-DataStructures-StrictQueue.html#method_dequeue">dequeue()</a></li>
<li><a href="classes/OCC-Basics-DataStructures-StrictQueue.html#method_enqueue">enqueue()</a></li> <li><a href="classes/OCC-Basics-DataStructures-StrictQueue.html#method_enqueue">enqueue()</a></li>
<li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_get">get()</a></li> <li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_get">get()</a></li>
<li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_isList">isList()</a></li> <li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_isList">isList()</a></li>
<li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_offsetSet">offsetSet()</a></li> <li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_offsetSet">offsetSet()</a></li>
<li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_prepend">prepend()</a></li> <li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_prepend">prepend()</a></li>
<li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_push">push()</a></li> <li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_push">push()</a></li>
<li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_remove">remove()</a></li> <li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_remove">remove()</a></li>
<li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_set">set()</a></li> <li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_set">set()</a></li>
<li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_toArray">toArray()</a></li> <li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_toArray">toArray()</a></li>
<li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_toStrictCollection">toStrictCollection()</a></li> <li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_toStrictCollection">toStrictCollection()</a></li>
<li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_unshift">unshift()</a></li> <li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_unshift">unshift()</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>

1390
doc/classes/OCC-Basics-DataStructures-StrictSplDatastructureTrait.html
View File

File diff suppressed because it is too large Load Diff

164
doc/classes/OCC-Basics-DataStructures-StrictStack.html
View File

@ -193,7 +193,7 @@
<span class="phpdocumentor-element__extends"> <span class="phpdocumentor-element__extends">
Uses Uses
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html"><abbr title="\OCC\Basics\DataStructures\Traits\StrictSplDatastructureTrait">StrictSplDatastructureTrait</abbr></a> </span> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html"><abbr title="\OCC\Basics\DataStructures\Traits\StrictSplDoublyLinkedListTrait">StrictSplDoublyLinkedListTrait</abbr></a> </span>
</h2> </h2>
<div class="phpdocumentor-label-line"> <div class="phpdocumentor-label-line">
@ -267,77 +267,77 @@ array of atomic types or fully qualified class names.</p>
</h4> </h4>
<dl class="phpdocumentor-table-of-contents"> <dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method___construct">__construct()</a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method___construct">__construct()</a>
<span> <span>
&nbsp;: void </span> &nbsp;: void </span>
</dt> </dt>
<dd>Create a type-sensitive, traversable list of items.</dd> <dd>Create a type-sensitive, traversable list of items.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_add">add()</a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_add">add()</a>
<span> <span>
&nbsp;: void </span> &nbsp;: void </span>
</dt> </dt>
<dd>Add/insert a new item at the specified offset.</dd> <dd>Add/insert a new item at the specified offset.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_append">append()</a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_append">append()</a>
<span> <span>
&nbsp;: void </span> &nbsp;: void </span>
</dt> </dt>
<dd>Append items at the end of the list.</dd> <dd>Append items at the end of the list.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_clear">clear()</a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_clear">clear()</a>
<span> <span>
&nbsp;: void </span> &nbsp;: void </span>
</dt> </dt>
<dd>Clear the list of any items.</dd> <dd>Clear the list of any items.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_get">get()</a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_get">get()</a>
<span> <span>
&nbsp;: <abbr title="\OCC\Basics\DataStructures\Traits\AllowedType">AllowedType</abbr> </span> &nbsp;: <abbr title="\OCC\Basics\DataStructures\Traits\AllowedType">AllowedType</abbr> </span>
</dt> </dt>
<dd>Get the item at the specified index.</dd> <dd>Get the item at the specified index.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_isList">isList()</a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_isList">isList()</a>
<span> <span>
&nbsp;: true </span> &nbsp;: true </span>
</dt> </dt>
<dd>Check if this can be considered a list.</dd> <dd>Check if this can be considered a list.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_offsetSet">offsetSet()</a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_offsetSet">offsetSet()</a>
<span> <span>
&nbsp;: void </span> &nbsp;: void </span>
</dt> </dt>
<dd>Set the item at the specified offset.</dd> <dd>Set the item at the specified offset.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_prepend">prepend()</a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_prepend">prepend()</a>
<span> <span>
&nbsp;: void </span> &nbsp;: void </span>
</dt> </dt>
<dd>Prepend items at the start of the list.</dd> <dd>Prepend items at the start of the list.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_push">push()</a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_push">push()</a>
<span> <span>
&nbsp;: void </span> &nbsp;: void </span>
</dt> </dt>
<dd>Push an item at the end of the list.</dd> <dd>Push an item at the end of the list.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_remove">remove()</a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_remove">remove()</a>
<span> <span>
&nbsp;: void </span> &nbsp;: void </span>
</dt> </dt>
<dd>Remove an item from the list.</dd> <dd>Remove an item from the list.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_set">set()</a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_set">set()</a>
<span> <span>
&nbsp;: void </span> &nbsp;: void </span>
</dt> </dt>
@ -351,21 +351,21 @@ array of atomic types or fully qualified class names.</p>
<dd>Add an item to the stack.</dd> <dd>Add an item to the stack.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_toArray">toArray()</a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_toArray">toArray()</a>
<span> <span>
&nbsp;: array&lt;int, <abbr title="\OCC\Basics\DataStructures\Traits\AllowedType">AllowedType</abbr>&gt; </span> &nbsp;: array&lt;int, <abbr title="\OCC\Basics\DataStructures\Traits\AllowedType">AllowedType</abbr>&gt; </span>
</dt> </dt>
<dd>Return array representation of list.</dd> <dd>Return array representation of list.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_toStrictCollection">toStrictCollection()</a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_toStrictCollection">toStrictCollection()</a>
<span> <span>
&nbsp;: <a href="classes/OCC-Basics-DataStructures-StrictCollection.html"><abbr title="\OCC\Basics\DataStructures\StrictCollection">StrictCollection</abbr></a>&lt;string|int, <abbr title="\OCC\Basics\DataStructures\Traits\AllowedType">AllowedType</abbr>&gt; </span> &nbsp;: <a href="classes/OCC-Basics-DataStructures-StrictCollection.html"><abbr title="\OCC\Basics\DataStructures\StrictCollection">StrictCollection</abbr></a>&lt;string|int, <abbr title="\OCC\Basics\DataStructures\Traits\AllowedType">AllowedType</abbr>&gt; </span>
</dt> </dt>
<dd>Turn list into a type-sensitive collection.</dd> <dd>Turn list into a type-sensitive collection.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_unshift">unshift()</a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_unshift">unshift()</a>
<span> <span>
&nbsp;: void </span> &nbsp;: void </span>
</dt> </dt>
@ -401,15 +401,15 @@ array of atomic types or fully qualified class names.</p>
> >
<h4 class="phpdocumentor-element__name" id="method___construct"> <h4 class="phpdocumentor-element__name" id="method___construct">
__construct() __construct()
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDatastructureTrait.php"><a href="files/src-datastructures-traits-strictspldatastructuretrait.html"><abbr title="src/DataStructures/Traits/StrictSplDatastructureTrait.php">StrictSplDatastructureTrait.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php"><a href="files/src-datastructures-traits-strictspldoublylinkedlisttrait.html"><abbr title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php">StrictSplDoublyLinkedListTrait.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">368</span> <span class="phpdocumentor-element-found-in__line">368</span>
<a href="classes/OCC-Basics-DataStructures-StrictStack.html#source-view.368" class="phpdocumentor-element-found-in__source" data-line="368" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDatastructureTrait.php.txt"></a> <a href="classes/OCC-Basics-DataStructures-StrictStack.html#source-view.368" class="phpdocumentor-element-found-in__source" data-line="368" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php.txt"></a>
</aside> </aside>
<p class="phpdocumentor-summary">Create a type-sensitive, traversable list of items.</p> <p class="phpdocumentor-summary">Create a type-sensitive, traversable list of items.</p>
@ -454,7 +454,7 @@ Possible values are:</p>
<h5 class="phpdocumentor-tag-list__heading" id="tags"> <h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags Tags
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method___construct#tags" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method___construct#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
@ -480,15 +480,15 @@ Possible values are:</p>
> >
<h4 class="phpdocumentor-element__name" id="method_add"> <h4 class="phpdocumentor-element__name" id="method_add">
add() add()
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_add" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_add" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDatastructureTrait.php"><a href="files/src-datastructures-traits-strictspldatastructuretrait.html"><abbr title="src/DataStructures/Traits/StrictSplDatastructureTrait.php">StrictSplDatastructureTrait.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php"><a href="files/src-datastructures-traits-strictspldoublylinkedlisttrait.html"><abbr title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php">StrictSplDoublyLinkedListTrait.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">71</span> <span class="phpdocumentor-element-found-in__line">71</span>
<a href="classes/OCC-Basics-DataStructures-StrictStack.html#source-view.71" class="phpdocumentor-element-found-in__source" data-line="71" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDatastructureTrait.php.txt"></a> <a href="classes/OCC-Basics-DataStructures-StrictStack.html#source-view.71" class="phpdocumentor-element-found-in__source" data-line="71" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php.txt"></a>
</aside> </aside>
<p class="phpdocumentor-summary">Add/insert a new item at the specified offset.</p> <p class="phpdocumentor-summary">Add/insert a new item at the specified offset.</p>
@ -527,7 +527,7 @@ Possible values are:</p>
<h5 class="phpdocumentor-tag-list__heading" id="tags"> <h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags Tags
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_add#tags" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_add#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
@ -563,15 +563,15 @@ Possible values are:</p>
> >
<h4 class="phpdocumentor-element__name" id="method_append"> <h4 class="phpdocumentor-element__name" id="method_append">
append() append()
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_append" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_append" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDatastructureTrait.php"><a href="files/src-datastructures-traits-strictspldatastructuretrait.html"><abbr title="src/DataStructures/Traits/StrictSplDatastructureTrait.php">StrictSplDatastructureTrait.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php"><a href="files/src-datastructures-traits-strictspldoublylinkedlisttrait.html"><abbr title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php">StrictSplDoublyLinkedListTrait.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">87</span> <span class="phpdocumentor-element-found-in__line">87</span>
<a href="classes/OCC-Basics-DataStructures-StrictStack.html#source-view.87" class="phpdocumentor-element-found-in__source" data-line="87" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDatastructureTrait.php.txt"></a> <a href="classes/OCC-Basics-DataStructures-StrictStack.html#source-view.87" class="phpdocumentor-element-found-in__source" data-line="87" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php.txt"></a>
</aside> </aside>
<p class="phpdocumentor-summary">Append items at the end of the list.</p> <p class="phpdocumentor-summary">Append items at the end of the list.</p>
@ -601,7 +601,7 @@ Possible values are:</p>
<h5 class="phpdocumentor-tag-list__heading" id="tags"> <h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags Tags
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_append#tags" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_append#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
@ -627,15 +627,15 @@ Possible values are:</p>
> >
<h4 class="phpdocumentor-element__name" id="method_clear"> <h4 class="phpdocumentor-element__name" id="method_clear">
clear() clear()
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_clear" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_clear" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDatastructureTrait.php"><a href="files/src-datastructures-traits-strictspldatastructuretrait.html"><abbr title="src/DataStructures/Traits/StrictSplDatastructureTrait.php">StrictSplDatastructureTrait.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php"><a href="files/src-datastructures-traits-strictspldoublylinkedlisttrait.html"><abbr title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php">StrictSplDoublyLinkedListTrait.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">113</span> <span class="phpdocumentor-element-found-in__line">113</span>
<a href="classes/OCC-Basics-DataStructures-StrictStack.html#source-view.113" class="phpdocumentor-element-found-in__source" data-line="113" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDatastructureTrait.php.txt"></a> <a href="classes/OCC-Basics-DataStructures-StrictStack.html#source-view.113" class="phpdocumentor-element-found-in__source" data-line="113" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php.txt"></a>
</aside> </aside>
<p class="phpdocumentor-summary">Clear the list of any items.</p> <p class="phpdocumentor-summary">Clear the list of any items.</p>
@ -662,15 +662,15 @@ Possible values are:</p>
> >
<h4 class="phpdocumentor-element__name" id="method_get"> <h4 class="phpdocumentor-element__name" id="method_get">
get() get()
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_get" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDatastructureTrait.php"><a href="files/src-datastructures-traits-strictspldatastructuretrait.html"><abbr title="src/DataStructures/Traits/StrictSplDatastructureTrait.php">StrictSplDatastructureTrait.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php"><a href="files/src-datastructures-traits-strictspldoublylinkedlisttrait.html"><abbr title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php">StrictSplDoublyLinkedListTrait.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">132</span> <span class="phpdocumentor-element-found-in__line">132</span>
<a href="classes/OCC-Basics-DataStructures-StrictStack.html#source-view.132" class="phpdocumentor-element-found-in__source" data-line="132" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDatastructureTrait.php.txt"></a> <a href="classes/OCC-Basics-DataStructures-StrictStack.html#source-view.132" class="phpdocumentor-element-found-in__source" data-line="132" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php.txt"></a>
</aside> </aside>
<p class="phpdocumentor-summary">Get the item at the specified index.</p> <p class="phpdocumentor-summary">Get the item at the specified index.</p>
@ -700,7 +700,7 @@ Possible values are:</p>
<h5 class="phpdocumentor-tag-list__heading" id="tags"> <h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags Tags
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_get#tags" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_get#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
@ -734,15 +734,15 @@ Possible values are:</p>
> >
<h4 class="phpdocumentor-element__name" id="method_isList"> <h4 class="phpdocumentor-element__name" id="method_isList">
isList() isList()
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_isList" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_isList" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDatastructureTrait.php"><a href="files/src-datastructures-traits-strictspldatastructuretrait.html"><abbr title="src/DataStructures/Traits/StrictSplDatastructureTrait.php">StrictSplDatastructureTrait.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php"><a href="files/src-datastructures-traits-strictspldoublylinkedlisttrait.html"><abbr title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php">StrictSplDoublyLinkedListTrait.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">144</span> <span class="phpdocumentor-element-found-in__line">144</span>
<a href="classes/OCC-Basics-DataStructures-StrictStack.html#source-view.144" class="phpdocumentor-element-found-in__source" data-line="144" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDatastructureTrait.php.txt"></a> <a href="classes/OCC-Basics-DataStructures-StrictStack.html#source-view.144" class="phpdocumentor-element-found-in__source" data-line="144" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php.txt"></a>
</aside> </aside>
<p class="phpdocumentor-summary">Check if this can be considered a list.</p> <p class="phpdocumentor-summary">Check if this can be considered a list.</p>
@ -777,15 +777,15 @@ Possible values are:</p>
> >
<h4 class="phpdocumentor-element__name" id="method_offsetSet"> <h4 class="phpdocumentor-element__name" id="method_offsetSet">
offsetSet() offsetSet()
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_offsetSet" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_offsetSet" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDatastructureTrait.php"><a href="files/src-datastructures-traits-strictspldatastructuretrait.html"><abbr title="src/DataStructures/Traits/StrictSplDatastructureTrait.php">StrictSplDatastructureTrait.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php"><a href="files/src-datastructures-traits-strictspldoublylinkedlisttrait.html"><abbr title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php">StrictSplDoublyLinkedListTrait.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">162</span> <span class="phpdocumentor-element-found-in__line">162</span>
<a href="classes/OCC-Basics-DataStructures-StrictStack.html#source-view.162" class="phpdocumentor-element-found-in__source" data-line="162" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDatastructureTrait.php.txt"></a> <a href="classes/OCC-Basics-DataStructures-StrictStack.html#source-view.162" class="phpdocumentor-element-found-in__source" data-line="162" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php.txt"></a>
</aside> </aside>
<p class="phpdocumentor-summary">Set the item at the specified offset.</p> <p class="phpdocumentor-summary">Set the item at the specified offset.</p>
@ -824,7 +824,7 @@ Possible values are:</p>
<h5 class="phpdocumentor-tag-list__heading" id="tags"> <h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags Tags
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_offsetSet#tags" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_offsetSet#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
@ -860,15 +860,15 @@ Possible values are:</p>
> >
<h4 class="phpdocumentor-element__name" id="method_prepend"> <h4 class="phpdocumentor-element__name" id="method_prepend">
prepend() prepend()
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_prepend" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_prepend" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDatastructureTrait.php"><a href="files/src-datastructures-traits-strictspldatastructuretrait.html"><abbr title="src/DataStructures/Traits/StrictSplDatastructureTrait.php">StrictSplDatastructureTrait.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php"><a href="files/src-datastructures-traits-strictspldoublylinkedlisttrait.html"><abbr title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php">StrictSplDoublyLinkedListTrait.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">187</span> <span class="phpdocumentor-element-found-in__line">187</span>
<a href="classes/OCC-Basics-DataStructures-StrictStack.html#source-view.187" class="phpdocumentor-element-found-in__source" data-line="187" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDatastructureTrait.php.txt"></a> <a href="classes/OCC-Basics-DataStructures-StrictStack.html#source-view.187" class="phpdocumentor-element-found-in__source" data-line="187" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php.txt"></a>
</aside> </aside>
<p class="phpdocumentor-summary">Prepend items at the start of the list.</p> <p class="phpdocumentor-summary">Prepend items at the start of the list.</p>
@ -898,7 +898,7 @@ Possible values are:</p>
<h5 class="phpdocumentor-tag-list__heading" id="tags"> <h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags Tags
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_prepend#tags" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_prepend#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
@ -924,15 +924,15 @@ Possible values are:</p>
> >
<h4 class="phpdocumentor-element__name" id="method_push"> <h4 class="phpdocumentor-element__name" id="method_push">
push() push()
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_push" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_push" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDatastructureTrait.php"><a href="files/src-datastructures-traits-strictspldatastructuretrait.html"><abbr title="src/DataStructures/Traits/StrictSplDatastructureTrait.php">StrictSplDatastructureTrait.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php"><a href="files/src-datastructures-traits-strictspldoublylinkedlisttrait.html"><abbr title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php">StrictSplDoublyLinkedListTrait.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">217</span> <span class="phpdocumentor-element-found-in__line">217</span>
<a href="classes/OCC-Basics-DataStructures-StrictStack.html#source-view.217" class="phpdocumentor-element-found-in__source" data-line="217" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDatastructureTrait.php.txt"></a> <a href="classes/OCC-Basics-DataStructures-StrictStack.html#source-view.217" class="phpdocumentor-element-found-in__source" data-line="217" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php.txt"></a>
</aside> </aside>
<p class="phpdocumentor-summary">Push an item at the end of the list.</p> <p class="phpdocumentor-summary">Push an item at the end of the list.</p>
@ -962,7 +962,7 @@ Possible values are:</p>
<h5 class="phpdocumentor-tag-list__heading" id="tags"> <h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags Tags
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_push#tags" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_push#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
@ -988,15 +988,15 @@ Possible values are:</p>
> >
<h4 class="phpdocumentor-element__name" id="method_remove"> <h4 class="phpdocumentor-element__name" id="method_remove">
remove() remove()
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_remove" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_remove" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDatastructureTrait.php"><a href="files/src-datastructures-traits-strictspldatastructuretrait.html"><abbr title="src/DataStructures/Traits/StrictSplDatastructureTrait.php">StrictSplDatastructureTrait.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php"><a href="files/src-datastructures-traits-strictspldoublylinkedlisttrait.html"><abbr title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php">StrictSplDoublyLinkedListTrait.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">241</span> <span class="phpdocumentor-element-found-in__line">241</span>
<a href="classes/OCC-Basics-DataStructures-StrictStack.html#source-view.241" class="phpdocumentor-element-found-in__source" data-line="241" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDatastructureTrait.php.txt"></a> <a href="classes/OCC-Basics-DataStructures-StrictStack.html#source-view.241" class="phpdocumentor-element-found-in__source" data-line="241" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php.txt"></a>
</aside> </aside>
<p class="phpdocumentor-summary">Remove an item from the list.</p> <p class="phpdocumentor-summary">Remove an item from the list.</p>
@ -1026,7 +1026,7 @@ Possible values are:</p>
<h5 class="phpdocumentor-tag-list__heading" id="tags"> <h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags Tags
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_remove#tags" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_remove#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
@ -1052,15 +1052,15 @@ Possible values are:</p>
> >
<h4 class="phpdocumentor-element__name" id="method_set"> <h4 class="phpdocumentor-element__name" id="method_set">
set() set()
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_set" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_set" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDatastructureTrait.php"><a href="files/src-datastructures-traits-strictspldatastructuretrait.html"><abbr title="src/DataStructures/Traits/StrictSplDatastructureTrait.php">StrictSplDatastructureTrait.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php"><a href="files/src-datastructures-traits-strictspldoublylinkedlisttrait.html"><abbr title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php">StrictSplDoublyLinkedListTrait.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">270</span> <span class="phpdocumentor-element-found-in__line">270</span>
<a href="classes/OCC-Basics-DataStructures-StrictStack.html#source-view.270" class="phpdocumentor-element-found-in__source" data-line="270" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDatastructureTrait.php.txt"></a> <a href="classes/OCC-Basics-DataStructures-StrictStack.html#source-view.270" class="phpdocumentor-element-found-in__source" data-line="270" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php.txt"></a>
</aside> </aside>
<p class="phpdocumentor-summary">Set an item at the specified index.</p> <p class="phpdocumentor-summary">Set an item at the specified index.</p>
@ -1099,7 +1099,7 @@ Possible values are:</p>
<h5 class="phpdocumentor-tag-list__heading" id="tags"> <h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags Tags
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_set#tags" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_set#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
@ -1189,15 +1189,15 @@ Possible values are:</p>
> >
<h4 class="phpdocumentor-element__name" id="method_toArray"> <h4 class="phpdocumentor-element__name" id="method_toArray">
toArray() toArray()
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_toArray" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_toArray" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDatastructureTrait.php"><a href="files/src-datastructures-traits-strictspldatastructuretrait.html"><abbr title="src/DataStructures/Traits/StrictSplDatastructureTrait.php">StrictSplDatastructureTrait.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php"><a href="files/src-datastructures-traits-strictspldoublylinkedlisttrait.html"><abbr title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php">StrictSplDoublyLinkedListTrait.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">282</span> <span class="phpdocumentor-element-found-in__line">282</span>
<a href="classes/OCC-Basics-DataStructures-StrictStack.html#source-view.282" class="phpdocumentor-element-found-in__source" data-line="282" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDatastructureTrait.php.txt"></a> <a href="classes/OCC-Basics-DataStructures-StrictStack.html#source-view.282" class="phpdocumentor-element-found-in__source" data-line="282" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php.txt"></a>
</aside> </aside>
<p class="phpdocumentor-summary">Return array representation of list.</p> <p class="phpdocumentor-summary">Return array representation of list.</p>
@ -1232,15 +1232,15 @@ Possible values are:</p>
> >
<h4 class="phpdocumentor-element__name" id="method_toStrictCollection"> <h4 class="phpdocumentor-element__name" id="method_toStrictCollection">
toStrictCollection() toStrictCollection()
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_toStrictCollection" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_toStrictCollection" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDatastructureTrait.php"><a href="files/src-datastructures-traits-strictspldatastructuretrait.html"><abbr title="src/DataStructures/Traits/StrictSplDatastructureTrait.php">StrictSplDatastructureTrait.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php"><a href="files/src-datastructures-traits-strictspldoublylinkedlisttrait.html"><abbr title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php">StrictSplDoublyLinkedListTrait.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">294</span> <span class="phpdocumentor-element-found-in__line">294</span>
<a href="classes/OCC-Basics-DataStructures-StrictStack.html#source-view.294" class="phpdocumentor-element-found-in__source" data-line="294" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDatastructureTrait.php.txt"></a> <a href="classes/OCC-Basics-DataStructures-StrictStack.html#source-view.294" class="phpdocumentor-element-found-in__source" data-line="294" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php.txt"></a>
</aside> </aside>
<p class="phpdocumentor-summary">Turn list into a type-sensitive collection.</p> <p class="phpdocumentor-summary">Turn list into a type-sensitive collection.</p>
@ -1275,15 +1275,15 @@ Possible values are:</p>
> >
<h4 class="phpdocumentor-element__name" id="method_unshift"> <h4 class="phpdocumentor-element__name" id="method_unshift">
unshift() unshift()
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_unshift" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_unshift" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDatastructureTrait.php"><a href="files/src-datastructures-traits-strictspldatastructuretrait.html"><abbr title="src/DataStructures/Traits/StrictSplDatastructureTrait.php">StrictSplDatastructureTrait.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php"><a href="files/src-datastructures-traits-strictspldoublylinkedlisttrait.html"><abbr title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php">StrictSplDoublyLinkedListTrait.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">330</span> <span class="phpdocumentor-element-found-in__line">330</span>
<a href="classes/OCC-Basics-DataStructures-StrictStack.html#source-view.330" class="phpdocumentor-element-found-in__source" data-line="330" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDatastructureTrait.php.txt"></a> <a href="classes/OCC-Basics-DataStructures-StrictStack.html#source-view.330" class="phpdocumentor-element-found-in__source" data-line="330" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php.txt"></a>
</aside> </aside>
<p class="phpdocumentor-summary">Prepend the list with an item.</p> <p class="phpdocumentor-summary">Prepend the list with an item.</p>
@ -1313,7 +1313,7 @@ Possible values are:</p>
<h5 class="phpdocumentor-tag-list__heading" id="tags"> <h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags Tags
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_unshift#tags" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_unshift#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
@ -1375,7 +1375,7 @@ Possible values are:</p>
<dd class="phpdocumentor-tag-list__definition"> <dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\RuntimeException">RuntimeException</abbr></span> <span class="phpdocumentor-tag-link"><abbr title="\RuntimeException">RuntimeException</abbr></span>
<section class="phpdocumentor-description"><p>if the list is empty</p> <section class="phpdocumentor-description"><p>if the stack is empty</p>
</section> </section>
</dd> </dd>
@ -1504,21 +1504,21 @@ Possible values are:</p>
<li class="phpdocumentor-on-this-page-section__title">Methods</li> <li class="phpdocumentor-on-this-page-section__title">Methods</li>
<li> <li>
<ul class="phpdocumentor-list -clean"> <ul class="phpdocumentor-list -clean">
<li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method___construct">__construct()</a></li> <li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method___construct">__construct()</a></li>
<li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_add">add()</a></li> <li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_add">add()</a></li>
<li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_append">append()</a></li> <li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_append">append()</a></li>
<li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_clear">clear()</a></li> <li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_clear">clear()</a></li>
<li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_get">get()</a></li> <li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_get">get()</a></li>
<li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_isList">isList()</a></li> <li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_isList">isList()</a></li>
<li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_offsetSet">offsetSet()</a></li> <li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_offsetSet">offsetSet()</a></li>
<li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_prepend">prepend()</a></li> <li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_prepend">prepend()</a></li>
<li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_push">push()</a></li> <li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_push">push()</a></li>
<li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_remove">remove()</a></li> <li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_remove">remove()</a></li>
<li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_set">set()</a></li> <li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_set">set()</a></li>
<li><a href="classes/OCC-Basics-DataStructures-StrictStack.html#method_stack">stack()</a></li> <li><a href="classes/OCC-Basics-DataStructures-StrictStack.html#method_stack">stack()</a></li>
<li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_toArray">toArray()</a></li> <li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_toArray">toArray()</a></li>
<li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_toStrictCollection">toStrictCollection()</a></li> <li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_toStrictCollection">toStrictCollection()</a></li>
<li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_unshift">unshift()</a></li> <li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_unshift">unshift()</a></li>
<li><a href="classes/OCC-Basics-DataStructures-StrictStack.html#method_unstack">unstack()</a></li> <li><a href="classes/OCC-Basics-DataStructures-StrictStack.html#method_unstack">unstack()</a></li>
</ul> </ul>
</li> </li>

180
doc/classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html → doc/classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html
View File

@ -177,15 +177,15 @@
<article class="phpdocumentor-element -trait"> <article class="phpdocumentor-element -trait">
<h2 class="phpdocumentor-content__title"> <h2 class="phpdocumentor-content__title">
StrictSplDatastructureTrait StrictSplDoublyLinkedListTrait
</h2> </h2>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDatastructureTrait.php"><a href="files/src-datastructures-traits-strictspldatastructuretrait.html"><abbr title="src/DataStructures/Traits/StrictSplDatastructureTrait.php">StrictSplDatastructureTrait.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php"><a href="files/src-datastructures-traits-strictspldoublylinkedlisttrait.html"><abbr title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php">StrictSplDoublyLinkedListTrait.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">52</span> <span class="phpdocumentor-element-found-in__line">52</span>
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#source-view.52" class="phpdocumentor-element-found-in__source" data-line="52" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDatastructureTrait.php.txt"></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#source-view.52" class="phpdocumentor-element-found-in__source" data-line="52" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php.txt"></a>
</aside> </aside>
<p class="phpdocumentor-summary">The common interface of all type-sensitive, SPL-based datastructures.</p> <p class="phpdocumentor-summary">The common interface of all type-sensitive, SPL-based datastructures.</p>
@ -198,7 +198,7 @@ by type-checking to only allow specified data types on the list.</p>
<h5 class="phpdocumentor-tag-list__heading" id="tags"> <h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags Tags
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#tags" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
@ -235,7 +235,7 @@ by type-checking to only allow specified data types on the list.</p>
<h3 id="toc"> <h3 id="toc">
Table of Contents Table of Contents
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#toc" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
</h3> </h3>
@ -250,103 +250,103 @@ by type-checking to only allow specified data types on the list.</p>
<h4 id="toc-methods"> <h4 id="toc-methods">
Methods Methods
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#toc-methods" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#toc-methods" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<dl class="phpdocumentor-table-of-contents"> <dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method___construct">__construct()</a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method___construct">__construct()</a>
<span> <span>
&nbsp;: void </span> &nbsp;: void </span>
</dt> </dt>
<dd>Create a type-sensitive, traversable list of items.</dd> <dd>Create a type-sensitive, traversable list of items.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_add">add()</a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_add">add()</a>
<span> <span>
&nbsp;: void </span> &nbsp;: void </span>
</dt> </dt>
<dd>Add/insert a new item at the specified offset.</dd> <dd>Add/insert a new item at the specified offset.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_append">append()</a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_append">append()</a>
<span> <span>
&nbsp;: void </span> &nbsp;: void </span>
</dt> </dt>
<dd>Append items at the end of the list.</dd> <dd>Append items at the end of the list.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_clear">clear()</a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_clear">clear()</a>
<span> <span>
&nbsp;: void </span> &nbsp;: void </span>
</dt> </dt>
<dd>Clear the list of any items.</dd> <dd>Clear the list of any items.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_get">get()</a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_get">get()</a>
<span> <span>
&nbsp;: <abbr title="\OCC\Basics\DataStructures\Traits\AllowedType">AllowedType</abbr> </span> &nbsp;: <abbr title="\OCC\Basics\DataStructures\Traits\AllowedType">AllowedType</abbr> </span>
</dt> </dt>
<dd>Get the item at the specified index.</dd> <dd>Get the item at the specified index.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_isList">isList()</a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_isList">isList()</a>
<span> <span>
&nbsp;: true </span> &nbsp;: true </span>
</dt> </dt>
<dd>Check if this can be considered a list.</dd> <dd>Check if this can be considered a list.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_offsetSet">offsetSet()</a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_offsetSet">offsetSet()</a>
<span> <span>
&nbsp;: void </span> &nbsp;: void </span>
</dt> </dt>
<dd>Set the item at the specified offset.</dd> <dd>Set the item at the specified offset.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_prepend">prepend()</a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_prepend">prepend()</a>
<span> <span>
&nbsp;: void </span> &nbsp;: void </span>
</dt> </dt>
<dd>Prepend items at the start of the list.</dd> <dd>Prepend items at the start of the list.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_push">push()</a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_push">push()</a>
<span> <span>
&nbsp;: void </span> &nbsp;: void </span>
</dt> </dt>
<dd>Push an item at the end of the list.</dd> <dd>Push an item at the end of the list.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_remove">remove()</a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_remove">remove()</a>
<span> <span>
&nbsp;: void </span> &nbsp;: void </span>
</dt> </dt>
<dd>Remove an item from the list.</dd> <dd>Remove an item from the list.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_set">set()</a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_set">set()</a>
<span> <span>
&nbsp;: void </span> &nbsp;: void </span>
</dt> </dt>
<dd>Set an item at the specified index.</dd> <dd>Set an item at the specified index.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_toArray">toArray()</a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_toArray">toArray()</a>
<span> <span>
&nbsp;: array&lt;int, <abbr title="\OCC\Basics\DataStructures\Traits\AllowedType">AllowedType</abbr>&gt; </span> &nbsp;: array&lt;int, <abbr title="\OCC\Basics\DataStructures\Traits\AllowedType">AllowedType</abbr>&gt; </span>
</dt> </dt>
<dd>Return array representation of list.</dd> <dd>Return array representation of list.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_toStrictCollection">toStrictCollection()</a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_toStrictCollection">toStrictCollection()</a>
<span> <span>
&nbsp;: <a href="classes/OCC-Basics-DataStructures-StrictCollection.html"><abbr title="\OCC\Basics\DataStructures\StrictCollection">StrictCollection</abbr></a>&lt;string|int, <abbr title="\OCC\Basics\DataStructures\Traits\AllowedType">AllowedType</abbr>&gt; </span> &nbsp;: <a href="classes/OCC-Basics-DataStructures-StrictCollection.html"><abbr title="\OCC\Basics\DataStructures\StrictCollection">StrictCollection</abbr></a>&lt;string|int, <abbr title="\OCC\Basics\DataStructures\Traits\AllowedType">AllowedType</abbr>&gt; </span>
</dt> </dt>
<dd>Turn list into a type-sensitive collection.</dd> <dd>Turn list into a type-sensitive collection.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public"> <dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_unshift">unshift()</a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_unshift">unshift()</a>
<span> <span>
&nbsp;: void </span> &nbsp;: void </span>
</dt> </dt>
@ -364,7 +364,7 @@ by type-checking to only allow specified data types on the list.</p>
<section class="phpdocumentor-methods"> <section class="phpdocumentor-methods">
<h3 class="phpdocumentor-elements__header" id="methods"> <h3 class="phpdocumentor-elements__header" id="methods">
Methods Methods
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#methods" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
</h3> </h3>
<article <article
@ -375,15 +375,15 @@ by type-checking to only allow specified data types on the list.</p>
> >
<h4 class="phpdocumentor-element__name" id="method___construct"> <h4 class="phpdocumentor-element__name" id="method___construct">
__construct() __construct()
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDatastructureTrait.php"><a href="files/src-datastructures-traits-strictspldatastructuretrait.html"><abbr title="src/DataStructures/Traits/StrictSplDatastructureTrait.php">StrictSplDatastructureTrait.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php"><a href="files/src-datastructures-traits-strictspldoublylinkedlisttrait.html"><abbr title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php">StrictSplDoublyLinkedListTrait.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">368</span> <span class="phpdocumentor-element-found-in__line">368</span>
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#source-view.368" class="phpdocumentor-element-found-in__source" data-line="368" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDatastructureTrait.php.txt"></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#source-view.368" class="phpdocumentor-element-found-in__source" data-line="368" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php.txt"></a>
</aside> </aside>
<p class="phpdocumentor-summary">Create a type-sensitive, traversable list of items.</p> <p class="phpdocumentor-summary">Create a type-sensitive, traversable list of items.</p>
@ -428,7 +428,7 @@ Possible values are:</p>
<h5 class="phpdocumentor-tag-list__heading" id="tags"> <h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags Tags
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method___construct#tags" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method___construct#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
@ -454,15 +454,15 @@ Possible values are:</p>
> >
<h4 class="phpdocumentor-element__name" id="method_add"> <h4 class="phpdocumentor-element__name" id="method_add">
add() add()
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_add" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_add" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDatastructureTrait.php"><a href="files/src-datastructures-traits-strictspldatastructuretrait.html"><abbr title="src/DataStructures/Traits/StrictSplDatastructureTrait.php">StrictSplDatastructureTrait.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php"><a href="files/src-datastructures-traits-strictspldoublylinkedlisttrait.html"><abbr title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php">StrictSplDoublyLinkedListTrait.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">71</span> <span class="phpdocumentor-element-found-in__line">71</span>
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#source-view.71" class="phpdocumentor-element-found-in__source" data-line="71" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDatastructureTrait.php.txt"></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#source-view.71" class="phpdocumentor-element-found-in__source" data-line="71" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php.txt"></a>
</aside> </aside>
<p class="phpdocumentor-summary">Add/insert a new item at the specified offset.</p> <p class="phpdocumentor-summary">Add/insert a new item at the specified offset.</p>
@ -501,7 +501,7 @@ Possible values are:</p>
<h5 class="phpdocumentor-tag-list__heading" id="tags"> <h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags Tags
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_add#tags" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_add#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
@ -537,15 +537,15 @@ Possible values are:</p>
> >
<h4 class="phpdocumentor-element__name" id="method_append"> <h4 class="phpdocumentor-element__name" id="method_append">
append() append()
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_append" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_append" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDatastructureTrait.php"><a href="files/src-datastructures-traits-strictspldatastructuretrait.html"><abbr title="src/DataStructures/Traits/StrictSplDatastructureTrait.php">StrictSplDatastructureTrait.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php"><a href="files/src-datastructures-traits-strictspldoublylinkedlisttrait.html"><abbr title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php">StrictSplDoublyLinkedListTrait.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">87</span> <span class="phpdocumentor-element-found-in__line">87</span>
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#source-view.87" class="phpdocumentor-element-found-in__source" data-line="87" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDatastructureTrait.php.txt"></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#source-view.87" class="phpdocumentor-element-found-in__source" data-line="87" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php.txt"></a>
</aside> </aside>
<p class="phpdocumentor-summary">Append items at the end of the list.</p> <p class="phpdocumentor-summary">Append items at the end of the list.</p>
@ -575,7 +575,7 @@ Possible values are:</p>
<h5 class="phpdocumentor-tag-list__heading" id="tags"> <h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags Tags
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_append#tags" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_append#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
@ -601,15 +601,15 @@ Possible values are:</p>
> >
<h4 class="phpdocumentor-element__name" id="method_clear"> <h4 class="phpdocumentor-element__name" id="method_clear">
clear() clear()
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_clear" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_clear" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDatastructureTrait.php"><a href="files/src-datastructures-traits-strictspldatastructuretrait.html"><abbr title="src/DataStructures/Traits/StrictSplDatastructureTrait.php">StrictSplDatastructureTrait.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php"><a href="files/src-datastructures-traits-strictspldoublylinkedlisttrait.html"><abbr title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php">StrictSplDoublyLinkedListTrait.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">113</span> <span class="phpdocumentor-element-found-in__line">113</span>
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#source-view.113" class="phpdocumentor-element-found-in__source" data-line="113" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDatastructureTrait.php.txt"></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#source-view.113" class="phpdocumentor-element-found-in__source" data-line="113" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php.txt"></a>
</aside> </aside>
<p class="phpdocumentor-summary">Clear the list of any items.</p> <p class="phpdocumentor-summary">Clear the list of any items.</p>
@ -636,15 +636,15 @@ Possible values are:</p>
> >
<h4 class="phpdocumentor-element__name" id="method_get"> <h4 class="phpdocumentor-element__name" id="method_get">
get() get()
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_get" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_get" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDatastructureTrait.php"><a href="files/src-datastructures-traits-strictspldatastructuretrait.html"><abbr title="src/DataStructures/Traits/StrictSplDatastructureTrait.php">StrictSplDatastructureTrait.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php"><a href="files/src-datastructures-traits-strictspldoublylinkedlisttrait.html"><abbr title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php">StrictSplDoublyLinkedListTrait.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">132</span> <span class="phpdocumentor-element-found-in__line">132</span>
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#source-view.132" class="phpdocumentor-element-found-in__source" data-line="132" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDatastructureTrait.php.txt"></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#source-view.132" class="phpdocumentor-element-found-in__source" data-line="132" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php.txt"></a>
</aside> </aside>
<p class="phpdocumentor-summary">Get the item at the specified index.</p> <p class="phpdocumentor-summary">Get the item at the specified index.</p>
@ -674,7 +674,7 @@ Possible values are:</p>
<h5 class="phpdocumentor-tag-list__heading" id="tags"> <h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags Tags
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_get#tags" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_get#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
@ -708,15 +708,15 @@ Possible values are:</p>
> >
<h4 class="phpdocumentor-element__name" id="method_isList"> <h4 class="phpdocumentor-element__name" id="method_isList">
isList() isList()
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_isList" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_isList" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDatastructureTrait.php"><a href="files/src-datastructures-traits-strictspldatastructuretrait.html"><abbr title="src/DataStructures/Traits/StrictSplDatastructureTrait.php">StrictSplDatastructureTrait.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php"><a href="files/src-datastructures-traits-strictspldoublylinkedlisttrait.html"><abbr title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php">StrictSplDoublyLinkedListTrait.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">144</span> <span class="phpdocumentor-element-found-in__line">144</span>
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#source-view.144" class="phpdocumentor-element-found-in__source" data-line="144" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDatastructureTrait.php.txt"></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#source-view.144" class="phpdocumentor-element-found-in__source" data-line="144" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php.txt"></a>
</aside> </aside>
<p class="phpdocumentor-summary">Check if this can be considered a list.</p> <p class="phpdocumentor-summary">Check if this can be considered a list.</p>
@ -751,15 +751,15 @@ Possible values are:</p>
> >
<h4 class="phpdocumentor-element__name" id="method_offsetSet"> <h4 class="phpdocumentor-element__name" id="method_offsetSet">
offsetSet() offsetSet()
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_offsetSet" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_offsetSet" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDatastructureTrait.php"><a href="files/src-datastructures-traits-strictspldatastructuretrait.html"><abbr title="src/DataStructures/Traits/StrictSplDatastructureTrait.php">StrictSplDatastructureTrait.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php"><a href="files/src-datastructures-traits-strictspldoublylinkedlisttrait.html"><abbr title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php">StrictSplDoublyLinkedListTrait.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">162</span> <span class="phpdocumentor-element-found-in__line">162</span>
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#source-view.162" class="phpdocumentor-element-found-in__source" data-line="162" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDatastructureTrait.php.txt"></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#source-view.162" class="phpdocumentor-element-found-in__source" data-line="162" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php.txt"></a>
</aside> </aside>
<p class="phpdocumentor-summary">Set the item at the specified offset.</p> <p class="phpdocumentor-summary">Set the item at the specified offset.</p>
@ -798,7 +798,7 @@ Possible values are:</p>
<h5 class="phpdocumentor-tag-list__heading" id="tags"> <h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags Tags
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_offsetSet#tags" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_offsetSet#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
@ -834,15 +834,15 @@ Possible values are:</p>
> >
<h4 class="phpdocumentor-element__name" id="method_prepend"> <h4 class="phpdocumentor-element__name" id="method_prepend">
prepend() prepend()
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_prepend" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_prepend" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDatastructureTrait.php"><a href="files/src-datastructures-traits-strictspldatastructuretrait.html"><abbr title="src/DataStructures/Traits/StrictSplDatastructureTrait.php">StrictSplDatastructureTrait.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php"><a href="files/src-datastructures-traits-strictspldoublylinkedlisttrait.html"><abbr title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php">StrictSplDoublyLinkedListTrait.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">187</span> <span class="phpdocumentor-element-found-in__line">187</span>
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#source-view.187" class="phpdocumentor-element-found-in__source" data-line="187" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDatastructureTrait.php.txt"></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#source-view.187" class="phpdocumentor-element-found-in__source" data-line="187" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php.txt"></a>
</aside> </aside>
<p class="phpdocumentor-summary">Prepend items at the start of the list.</p> <p class="phpdocumentor-summary">Prepend items at the start of the list.</p>
@ -872,7 +872,7 @@ Possible values are:</p>
<h5 class="phpdocumentor-tag-list__heading" id="tags"> <h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags Tags
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_prepend#tags" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_prepend#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
@ -898,15 +898,15 @@ Possible values are:</p>
> >
<h4 class="phpdocumentor-element__name" id="method_push"> <h4 class="phpdocumentor-element__name" id="method_push">
push() push()
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_push" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_push" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDatastructureTrait.php"><a href="files/src-datastructures-traits-strictspldatastructuretrait.html"><abbr title="src/DataStructures/Traits/StrictSplDatastructureTrait.php">StrictSplDatastructureTrait.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php"><a href="files/src-datastructures-traits-strictspldoublylinkedlisttrait.html"><abbr title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php">StrictSplDoublyLinkedListTrait.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">217</span> <span class="phpdocumentor-element-found-in__line">217</span>
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#source-view.217" class="phpdocumentor-element-found-in__source" data-line="217" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDatastructureTrait.php.txt"></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#source-view.217" class="phpdocumentor-element-found-in__source" data-line="217" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php.txt"></a>
</aside> </aside>
<p class="phpdocumentor-summary">Push an item at the end of the list.</p> <p class="phpdocumentor-summary">Push an item at the end of the list.</p>
@ -936,7 +936,7 @@ Possible values are:</p>
<h5 class="phpdocumentor-tag-list__heading" id="tags"> <h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags Tags
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_push#tags" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_push#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
@ -962,15 +962,15 @@ Possible values are:</p>
> >
<h4 class="phpdocumentor-element__name" id="method_remove"> <h4 class="phpdocumentor-element__name" id="method_remove">
remove() remove()
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_remove" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_remove" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDatastructureTrait.php"><a href="files/src-datastructures-traits-strictspldatastructuretrait.html"><abbr title="src/DataStructures/Traits/StrictSplDatastructureTrait.php">StrictSplDatastructureTrait.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php"><a href="files/src-datastructures-traits-strictspldoublylinkedlisttrait.html"><abbr title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php">StrictSplDoublyLinkedListTrait.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">241</span> <span class="phpdocumentor-element-found-in__line">241</span>
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#source-view.241" class="phpdocumentor-element-found-in__source" data-line="241" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDatastructureTrait.php.txt"></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#source-view.241" class="phpdocumentor-element-found-in__source" data-line="241" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php.txt"></a>
</aside> </aside>
<p class="phpdocumentor-summary">Remove an item from the list.</p> <p class="phpdocumentor-summary">Remove an item from the list.</p>
@ -1000,7 +1000,7 @@ Possible values are:</p>
<h5 class="phpdocumentor-tag-list__heading" id="tags"> <h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags Tags
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_remove#tags" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_remove#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
@ -1026,15 +1026,15 @@ Possible values are:</p>
> >
<h4 class="phpdocumentor-element__name" id="method_set"> <h4 class="phpdocumentor-element__name" id="method_set">
set() set()
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_set" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_set" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDatastructureTrait.php"><a href="files/src-datastructures-traits-strictspldatastructuretrait.html"><abbr title="src/DataStructures/Traits/StrictSplDatastructureTrait.php">StrictSplDatastructureTrait.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php"><a href="files/src-datastructures-traits-strictspldoublylinkedlisttrait.html"><abbr title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php">StrictSplDoublyLinkedListTrait.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">270</span> <span class="phpdocumentor-element-found-in__line">270</span>
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#source-view.270" class="phpdocumentor-element-found-in__source" data-line="270" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDatastructureTrait.php.txt"></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#source-view.270" class="phpdocumentor-element-found-in__source" data-line="270" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php.txt"></a>
</aside> </aside>
<p class="phpdocumentor-summary">Set an item at the specified index.</p> <p class="phpdocumentor-summary">Set an item at the specified index.</p>
@ -1073,7 +1073,7 @@ Possible values are:</p>
<h5 class="phpdocumentor-tag-list__heading" id="tags"> <h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags Tags
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_set#tags" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_set#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
@ -1099,15 +1099,15 @@ Possible values are:</p>
> >
<h4 class="phpdocumentor-element__name" id="method_toArray"> <h4 class="phpdocumentor-element__name" id="method_toArray">
toArray() toArray()
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_toArray" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_toArray" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDatastructureTrait.php"><a href="files/src-datastructures-traits-strictspldatastructuretrait.html"><abbr title="src/DataStructures/Traits/StrictSplDatastructureTrait.php">StrictSplDatastructureTrait.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php"><a href="files/src-datastructures-traits-strictspldoublylinkedlisttrait.html"><abbr title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php">StrictSplDoublyLinkedListTrait.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">282</span> <span class="phpdocumentor-element-found-in__line">282</span>
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#source-view.282" class="phpdocumentor-element-found-in__source" data-line="282" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDatastructureTrait.php.txt"></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#source-view.282" class="phpdocumentor-element-found-in__source" data-line="282" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php.txt"></a>
</aside> </aside>
<p class="phpdocumentor-summary">Return array representation of list.</p> <p class="phpdocumentor-summary">Return array representation of list.</p>
@ -1142,15 +1142,15 @@ Possible values are:</p>
> >
<h4 class="phpdocumentor-element__name" id="method_toStrictCollection"> <h4 class="phpdocumentor-element__name" id="method_toStrictCollection">
toStrictCollection() toStrictCollection()
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_toStrictCollection" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_toStrictCollection" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDatastructureTrait.php"><a href="files/src-datastructures-traits-strictspldatastructuretrait.html"><abbr title="src/DataStructures/Traits/StrictSplDatastructureTrait.php">StrictSplDatastructureTrait.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php"><a href="files/src-datastructures-traits-strictspldoublylinkedlisttrait.html"><abbr title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php">StrictSplDoublyLinkedListTrait.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">294</span> <span class="phpdocumentor-element-found-in__line">294</span>
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#source-view.294" class="phpdocumentor-element-found-in__source" data-line="294" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDatastructureTrait.php.txt"></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#source-view.294" class="phpdocumentor-element-found-in__source" data-line="294" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php.txt"></a>
</aside> </aside>
<p class="phpdocumentor-summary">Turn list into a type-sensitive collection.</p> <p class="phpdocumentor-summary">Turn list into a type-sensitive collection.</p>
@ -1185,15 +1185,15 @@ Possible values are:</p>
> >
<h4 class="phpdocumentor-element__name" id="method_unshift"> <h4 class="phpdocumentor-element__name" id="method_unshift">
unshift() unshift()
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_unshift" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_unshift" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDatastructureTrait.php"><a href="files/src-datastructures-traits-strictspldatastructuretrait.html"><abbr title="src/DataStructures/Traits/StrictSplDatastructureTrait.php">StrictSplDatastructureTrait.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php"><a href="files/src-datastructures-traits-strictspldoublylinkedlisttrait.html"><abbr title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php">StrictSplDoublyLinkedListTrait.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">330</span> <span class="phpdocumentor-element-found-in__line">330</span>
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#source-view.330" class="phpdocumentor-element-found-in__source" data-line="330" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDatastructureTrait.php.txt"></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#source-view.330" class="phpdocumentor-element-found-in__source" data-line="330" data-modal="source-view" data-src="files/src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php.txt"></a>
</aside> </aside>
<p class="phpdocumentor-summary">Prepend the list with an item.</p> <p class="phpdocumentor-summary">Prepend the list with an item.</p>
@ -1223,7 +1223,7 @@ Possible values are:</p>
<h5 class="phpdocumentor-tag-list__heading" id="tags"> <h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags Tags
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_unshift#tags" class="headerlink"><i class="fas fa-link"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_unshift#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5> </h5>
<dl class="phpdocumentor-tag-list"> <dl class="phpdocumentor-tag-list">
@ -1247,7 +1247,7 @@ Possible values are:</p>
<div class="phpdocumentor-modal-bg" data-exit-button></div> <div class="phpdocumentor-modal-bg" data-exit-button></div>
<div class="phpdocumentor-modal-container"> <div class="phpdocumentor-modal-container">
<div class="phpdocumentor-modal-content"> <div class="phpdocumentor-modal-content">
<pre style="max-height: 500px; overflow-y: scroll" data-src="files/src/DataStructures/Traits/StrictSplDatastructureTrait.php.txt" class="language-php line-numbers linkable-line-numbers"></pre> <pre style="max-height: 500px; overflow-y: scroll" data-src="files/src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php.txt" class="language-php line-numbers linkable-line-numbers"></pre>
</div> </div>
<button data-exit-button class="phpdocumentor-modal__close">&times;</button> <button data-exit-button class="phpdocumentor-modal__close">&times;</button>
</div> </div>
@ -1346,26 +1346,26 @@ Possible values are:</p>
<li class="phpdocumentor-on-this-page-section__title">Table Of Contents</li> <li class="phpdocumentor-on-this-page-section__title">Table Of Contents</li>
<li> <li>
<ul class="phpdocumentor-list -clean"> <ul class="phpdocumentor-list -clean">
<li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#toc-methods">Methods</a></li> <li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#toc-methods">Methods</a></li>
</ul> </ul>
</li> </li>
<li class="phpdocumentor-on-this-page-section__title">Methods</li> <li class="phpdocumentor-on-this-page-section__title">Methods</li>
<li> <li>
<ul class="phpdocumentor-list -clean"> <ul class="phpdocumentor-list -clean">
<li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method___construct">__construct()</a></li> <li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method___construct">__construct()</a></li>
<li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_add">add()</a></li> <li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_add">add()</a></li>
<li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_append">append()</a></li> <li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_append">append()</a></li>
<li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_clear">clear()</a></li> <li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_clear">clear()</a></li>
<li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_get">get()</a></li> <li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_get">get()</a></li>
<li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_isList">isList()</a></li> <li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_isList">isList()</a></li>
<li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_offsetSet">offsetSet()</a></li> <li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_offsetSet">offsetSet()</a></li>
<li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_prepend">prepend()</a></li> <li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_prepend">prepend()</a></li>
<li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_push">push()</a></li> <li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_push">push()</a></li>
<li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_remove">remove()</a></li> <li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_remove">remove()</a></li>
<li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_set">set()</a></li> <li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_set">set()</a></li>
<li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_toArray">toArray()</a></li> <li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_toArray">toArray()</a></li>
<li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_toStrictCollection">toStrictCollection()</a></li> <li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_toStrictCollection">toStrictCollection()</a></li>
<li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_unshift">unshift()</a></li> <li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_unshift">unshift()</a></li>
</ul> </ul>
</li> </li>
</ul> </ul>
@ -1385,7 +1385,7 @@ Possible values are:</p>
</section> </section>
</section> </section>
</div> </div>
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a> <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
</main> </main>

621
doc/classes/OCC-Basics-InterfaceTraits-ArrayAccessTrait.html
View File

@ -1,621 +0,0 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>PHP Basics</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<base href="../">
<link rel="icon" href="images/favicon.ico"/>
<link rel="stylesheet" href="css/normalize.css">
<link rel="stylesheet" href="css/base.css">
<link rel="preconnect" href="https://fonts.gstatic.com">
<link href="https://fonts.googleapis.com/css2?family=Open+Sans:wght@100;200;300;400;600;700&display=swap" rel="stylesheet">
<link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet">
<link rel="stylesheet" href="css/template.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
<script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
<script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
<script src="js/template.js"></script>
<script src="js/search.js"></script>
<script defer src="js/searchIndex.js"></script>
</head>
<body id="top">
<header class="phpdocumentor-header phpdocumentor-section">
<h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">PHP Basics</a></h1>
<input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
<label class="phpdocumentor-header__menu-icon" for="menu-button">
<i class="fas fa-bars"></i>
</label>
<section data-search-form class="phpdocumentor-search">
<label>
<span class="visually-hidden">Search for</span>
<svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
<circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
<line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
</svg>
<input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
</label>
</section>
<nav class="phpdocumentor-topnav">
<ul class="phpdocumentor-topnav__menu">
<li class="phpdocumentor-topnav__menu-item -menu">
<a href="https://packagist.org/packages/opencultureconsulting/basics">
<span>
<i class="fab fa-php"></i>
</span>
</a>
</li>
<li class="phpdocumentor-topnav__menu-item -menu">
<a href="https://github.com/opencultureconsulting/php-basics">
<span>
<i class="fab fa-github"></i>
</span>
</a>
</li>
</ul>
</nav>
</header>
<main class="phpdocumentor">
<div class="phpdocumentor-section">
<input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
<label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
Menu
</label>
<aside class="phpdocumentor-column -three phpdocumentor-sidebar">
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Documentation</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="guides/installation/index.html#installation" class="">Installation</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="guides/installation/test.html#test" class="">Test</a>
</li>
</ul>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="guides/changelog/index.html#changelog" class="">Changelog</a>
</h4>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="namespaces/occ.html" class="">OCC</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="namespaces/occ-basics.html" class="">Basics</a>
</li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="packages/Basics.html" class="">Basics</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="packages/Basics-DataStructures.html" class="">DataStructures</a>
</li>
<li>
<a href="packages/Basics-ErrorHandlers.html" class="">ErrorHandlers</a>
</li>
<li>
<a href="packages/Basics-InterfaceTraits.html" class="">InterfaceTraits</a>
</li>
<li>
<a href="packages/Basics-Traits.html" class="">Traits</a>
</li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
</section>
</aside>
<div class="phpdocumentor-column -nine phpdocumentor-content">
<section>
<ul class="phpdocumentor-breadcrumbs">
<li class="phpdocumentor-breadcrumb"><a href="namespaces/occ.html">OCC</a></li>
<li class="phpdocumentor-breadcrumb"><a href="namespaces/occ-basics.html">Basics</a></li>
<li class="phpdocumentor-breadcrumb"><a href="namespaces/occ-basics-interfacetraits.html">InterfaceTraits</a></li>
</ul>
<article class="phpdocumentor-element -trait">
<h2 class="phpdocumentor-content__title">
ArrayAccessTrait
</h2>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/InterfaceTraits/ArrayAccessTrait.php"><a href="files/src-interfacetraits-arrayaccesstrait.html"><abbr title="src/InterfaceTraits/ArrayAccessTrait.php">ArrayAccessTrait.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">42</span>
<a href="classes/OCC-Basics-InterfaceTraits-ArrayAccessTrait.html#source-view.42" class="phpdocumentor-element-found-in__source" data-line="42" data-modal="source-view" data-src="files/src/InterfaceTraits/ArrayAccessTrait.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">A generic implementation of the ArrayAccess interface.</p>
<section class="phpdocumentor-description"><p>Internally it accesses the protected <code class="prettyprint">$_data</code> array.</p>
</section>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/OCC-Basics-InterfaceTraits-ArrayAccessTrait.html#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">author</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>Sebastian Meyer <a href="mailto:sebastian.meyer@opencultureconsulting.com">sebastian.meyer@opencultureconsulting.com</a></p>
</section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">template</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>TValue of mixed</p>
</section>
</dd>
</dl>
<h3 id="toc">
Table of Contents
<a href="classes/OCC-Basics-InterfaceTraits-ArrayAccessTrait.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<h4 id="toc-methods">
Methods
<a href="classes/OCC-Basics-InterfaceTraits-ArrayAccessTrait.html#toc-methods" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-InterfaceTraits-ArrayAccessTrait.html#method_offsetExists">offsetExists()</a>
<span>
&nbsp;: bool </span>
</dt>
<dd>Check if the specified offset exists.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-InterfaceTraits-ArrayAccessTrait.html#method_offsetGet">offsetGet()</a>
<span>
&nbsp;: <abbr title="\OCC\Basics\InterfaceTraits\TValue">TValue</abbr>|null </span>
</dt>
<dd>Retrieve data at the specified offset.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-InterfaceTraits-ArrayAccessTrait.html#method_offsetSet">offsetSet()</a>
<span>
&nbsp;: void </span>
</dt>
<dd>Assign a value to the specified offset.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-InterfaceTraits-ArrayAccessTrait.html#method_offsetUnset">offsetUnset()</a>
<span>
&nbsp;: void </span>
</dt>
<dd>Unset the specified offset.</dd>
</dl>
<section class="phpdocumentor-methods">
<h3 class="phpdocumentor-elements__header" id="methods">
Methods
<a href="classes/OCC-Basics-InterfaceTraits-ArrayAccessTrait.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_offsetExists">
offsetExists()
<a href="classes/OCC-Basics-InterfaceTraits-ArrayAccessTrait.html#method_offsetExists" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/InterfaceTraits/ArrayAccessTrait.php"><a href="files/src-interfacetraits-arrayaccesstrait.html"><abbr title="src/InterfaceTraits/ArrayAccessTrait.php">ArrayAccessTrait.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">62</span>
<a href="classes/OCC-Basics-InterfaceTraits-ArrayAccessTrait.html#source-view.62" class="phpdocumentor-element-found-in__source" data-line="62" data-modal="source-view" data-src="files/src/InterfaceTraits/ArrayAccessTrait.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">Check if the specified offset exists.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">offsetExists</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string|int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$offset</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<div class="phpdocumentor-label-line">
<div class="phpdocumentor-label phpdocumentor-label--success"><span>API</span><span>Yes</span></div>
</div>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$offset</span>
: <span class="phpdocumentor-signature__argument__return-type">string|int</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The offset to check for</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
&mdash;
<section class="phpdocumentor-description"><p>Whether the offset exists</p>
</section>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_offsetGet">
offsetGet()
<a href="classes/OCC-Basics-InterfaceTraits-ArrayAccessTrait.html#method_offsetGet" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/InterfaceTraits/ArrayAccessTrait.php"><a href="files/src-interfacetraits-arrayaccesstrait.html"><abbr title="src/InterfaceTraits/ArrayAccessTrait.php">ArrayAccessTrait.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">76</span>
<a href="classes/OCC-Basics-InterfaceTraits-ArrayAccessTrait.html#source-view.76" class="phpdocumentor-element-found-in__source" data-line="76" data-modal="source-view" data-src="files/src/InterfaceTraits/ArrayAccessTrait.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">Retrieve data at the specified offset.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">offsetGet</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string|int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$offset</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><abbr title="\OCC\Basics\InterfaceTraits\TValue">TValue</abbr>|null</span></code>
<div class="phpdocumentor-label-line">
<div class="phpdocumentor-label phpdocumentor-label--success"><span>API</span><span>Yes</span></div>
</div>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$offset</span>
: <span class="phpdocumentor-signature__argument__return-type">string|int</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The offset to retrieve</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><abbr title="\OCC\Basics\InterfaceTraits\TValue">TValue</abbr>|null</span>
&mdash;
<section class="phpdocumentor-description"><p>The value at the offset or NULL if invalid</p>
</section>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_offsetSet">
offsetSet()
<a href="classes/OCC-Basics-InterfaceTraits-ArrayAccessTrait.html#method_offsetSet" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/InterfaceTraits/ArrayAccessTrait.php"><a href="files/src-interfacetraits-arrayaccesstrait.html"><abbr title="src/InterfaceTraits/ArrayAccessTrait.php">ArrayAccessTrait.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">91</span>
<a href="classes/OCC-Basics-InterfaceTraits-ArrayAccessTrait.html#source-view.91" class="phpdocumentor-element-found-in__source" data-line="91" data-modal="source-view" data-src="files/src/InterfaceTraits/ArrayAccessTrait.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">Assign a value to the specified offset.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">offsetSet</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string|int|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$offset</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><abbr title="\OCC\Basics\InterfaceTraits\TValue">TValue</abbr>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<div class="phpdocumentor-label-line">
<div class="phpdocumentor-label phpdocumentor-label--success"><span>API</span><span>Yes</span></div>
</div>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$offset</span>
: <span class="phpdocumentor-signature__argument__return-type">string|int|null</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The offset to assign to or NULL to append</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$value</span>
: <span class="phpdocumentor-signature__argument__return-type"><abbr title="\OCC\Basics\InterfaceTraits\TValue">TValue</abbr></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The value to set</p>
</section>
</dd>
</dl>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_offsetUnset">
offsetUnset()
<a href="classes/OCC-Basics-InterfaceTraits-ArrayAccessTrait.html#method_offsetUnset" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/InterfaceTraits/ArrayAccessTrait.php"><a href="files/src-interfacetraits-arrayaccesstrait.html"><abbr title="src/InterfaceTraits/ArrayAccessTrait.php">ArrayAccessTrait.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">109</span>
<a href="classes/OCC-Basics-InterfaceTraits-ArrayAccessTrait.html#source-view.109" class="phpdocumentor-element-found-in__source" data-line="109" data-modal="source-view" data-src="files/src/InterfaceTraits/ArrayAccessTrait.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">Unset the specified offset.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">offsetUnset</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string|int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$offset</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<div class="phpdocumentor-label-line">
<div class="phpdocumentor-label phpdocumentor-label--success"><span>API</span><span>Yes</span></div>
</div>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$offset</span>
: <span class="phpdocumentor-signature__argument__return-type">string|int</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The offset to unset</p>
</section>
</dd>
</dl>
</article>
</section>
<div class="phpdocumentor-modal" id="source-view">
<div class="phpdocumentor-modal-bg" data-exit-button></div>
<div class="phpdocumentor-modal-container">
<div class="phpdocumentor-modal-content">
<pre style="max-height: 500px; overflow-y: scroll" data-src="files/src/InterfaceTraits/ArrayAccessTrait.php.txt" class="language-php line-numbers linkable-line-numbers"></pre>
</div>
<button data-exit-button class="phpdocumentor-modal__close">&times;</button>
</div>
</div>
<script type="text/javascript">
(function () {
function loadExternalCodeSnippet(el, url, line) {
Array.prototype.slice.call(el.querySelectorAll('pre[data-src]')).forEach((pre) => {
const src = url || pre.getAttribute('data-src').replace(/\\/g, '/');
const language = 'php';
const code = document.createElement('code');
code.className = 'language-' + language;
pre.textContent = '';
pre.setAttribute('data-line', line)
code.textContent = 'Loading…';
pre.appendChild(code);
var xhr = new XMLHttpRequest();
xhr.open('GET', src, true);
xhr.onreadystatechange = function () {
if (xhr.readyState !== 4) {
return;
}
if (xhr.status < 400 && xhr.responseText) {
code.textContent = xhr.responseText;
Prism.highlightElement(code);
return;
}
if (xhr.status === 404) {
code.textContent = '✖ Error: File could not be found';
return;
}
if (xhr.status >= 400) {
code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
return;
}
code.textContent = '✖ Error: An unknown error occurred';
};
xhr.send(null);
});
}
const modalButtons = document.querySelectorAll("[data-modal]");
const openedAsLocalFile = window.location.protocol === 'file:';
if (modalButtons.length > 0 && openedAsLocalFile) {
console.warn(
'Viewing the source code is unavailable because you are opening this page from the file:// scheme; ' +
'browsers block XHR requests when a page is opened this way'
);
}
modalButtons.forEach(function (trigger) {
if (openedAsLocalFile) {
trigger.setAttribute("hidden", "hidden");
}
trigger.addEventListener("click", function (event) {
event.preventDefault();
const modal = document.getElementById(trigger.dataset.modal);
if (!modal) {
console.error(`Modal with id "${trigger.dataset.modal}" could not be found`);
return;
}
modal.classList.add("phpdocumentor-modal__open");
loadExternalCodeSnippet(modal, trigger.dataset.src || null, trigger.dataset.line)
const exits = modal.querySelectorAll("[data-exit-button]");
exits.forEach(function (exit) {
exit.addEventListener("click", function (event) {
event.preventDefault();
modal.classList.remove("phpdocumentor-modal__open");
});
});
});
});
})();
</script>
</article>
</section>
<section class="phpdocumentor-on-this-page__sidebar">
<section class="phpdocumentor-on-this-page__content">
<strong class="phpdocumentor-on-this-page__title">On this page</strong>
<ul class="phpdocumentor-list -clean">
<li class="phpdocumentor-on-this-page-section__title">Table Of Contents</li>
<li>
<ul class="phpdocumentor-list -clean">
<li><a href="classes/OCC-Basics-InterfaceTraits-ArrayAccessTrait.html#toc-methods">Methods</a></li>
</ul>
</li>
<li class="phpdocumentor-on-this-page-section__title">Methods</li>
<li>
<ul class="phpdocumentor-list -clean">
<li><a href="classes/OCC-Basics-InterfaceTraits-ArrayAccessTrait.html#method_offsetExists">offsetExists()</a></li>
<li><a href="classes/OCC-Basics-InterfaceTraits-ArrayAccessTrait.html#method_offsetGet">offsetGet()</a></li>
<li><a href="classes/OCC-Basics-InterfaceTraits-ArrayAccessTrait.html#method_offsetSet">offsetSet()</a></li>
<li><a href="classes/OCC-Basics-InterfaceTraits-ArrayAccessTrait.html#method_offsetUnset">offsetUnset()</a></li>
</ul>
</li>
</ul>
</section>
</section>
</div>
<section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
<section class="phpdocumentor-search-results__dialog">
<header class="phpdocumentor-search-results__header">
<h2 class="phpdocumentor-search-results__title">Search results</h2>
<button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
</header>
<section class="phpdocumentor-search-results__body">
<ul class="phpdocumentor-search-results__entries"></ul>
</section>
</section>
</section>
</div>
<a href="classes/OCC-Basics-InterfaceTraits-ArrayAccessTrait.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
</main>
<script>
cssVars({});
</script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
</body>
</html>

427
doc/classes/OCC-Basics-InterfaceTraits-CountableTrait.html
View File

@ -1,427 +0,0 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>PHP Basics</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<base href="../">
<link rel="icon" href="images/favicon.ico"/>
<link rel="stylesheet" href="css/normalize.css">
<link rel="stylesheet" href="css/base.css">
<link rel="preconnect" href="https://fonts.gstatic.com">
<link href="https://fonts.googleapis.com/css2?family=Open+Sans:wght@100;200;300;400;600;700&display=swap" rel="stylesheet">
<link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet">
<link rel="stylesheet" href="css/template.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
<script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
<script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
<script src="js/template.js"></script>
<script src="js/search.js"></script>
<script defer src="js/searchIndex.js"></script>
</head>
<body id="top">
<header class="phpdocumentor-header phpdocumentor-section">
<h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">PHP Basics</a></h1>
<input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
<label class="phpdocumentor-header__menu-icon" for="menu-button">
<i class="fas fa-bars"></i>
</label>
<section data-search-form class="phpdocumentor-search">
<label>
<span class="visually-hidden">Search for</span>
<svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
<circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
<line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
</svg>
<input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
</label>
</section>
<nav class="phpdocumentor-topnav">
<ul class="phpdocumentor-topnav__menu">
<li class="phpdocumentor-topnav__menu-item -menu">
<a href="https://packagist.org/packages/opencultureconsulting/basics">
<span>
<i class="fab fa-php"></i>
</span>
</a>
</li>
<li class="phpdocumentor-topnav__menu-item -menu">
<a href="https://github.com/opencultureconsulting/php-basics">
<span>
<i class="fab fa-github"></i>
</span>
</a>
</li>
</ul>
</nav>
</header>
<main class="phpdocumentor">
<div class="phpdocumentor-section">
<input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
<label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
Menu
</label>
<aside class="phpdocumentor-column -three phpdocumentor-sidebar">
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Documentation</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="guides/installation/index.html#installation" class="">Installation</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="guides/installation/test.html#test" class="">Test</a>
</li>
</ul>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="guides/changelog/index.html#changelog" class="">Changelog</a>
</h4>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="namespaces/occ.html" class="">OCC</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="namespaces/occ-basics.html" class="">Basics</a>
</li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="packages/Basics.html" class="">Basics</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="packages/Basics-DataStructures.html" class="">DataStructures</a>
</li>
<li>
<a href="packages/Basics-ErrorHandlers.html" class="">ErrorHandlers</a>
</li>
<li>
<a href="packages/Basics-InterfaceTraits.html" class="">InterfaceTraits</a>
</li>
<li>
<a href="packages/Basics-Traits.html" class="">Traits</a>
</li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
</section>
</aside>
<div class="phpdocumentor-column -nine phpdocumentor-content">
<section>
<ul class="phpdocumentor-breadcrumbs">
<li class="phpdocumentor-breadcrumb"><a href="namespaces/occ.html">OCC</a></li>
<li class="phpdocumentor-breadcrumb"><a href="namespaces/occ-basics.html">Basics</a></li>
<li class="phpdocumentor-breadcrumb"><a href="namespaces/occ-basics-interfacetraits.html">InterfaceTraits</a></li>
</ul>
<article class="phpdocumentor-element -trait">
<h2 class="phpdocumentor-content__title">
CountableTrait
</h2>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/InterfaceTraits/CountableTrait.php"><a href="files/src-interfacetraits-countabletrait.html"><abbr title="src/InterfaceTraits/CountableTrait.php">CountableTrait.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">42</span>
<a href="classes/OCC-Basics-InterfaceTraits-CountableTrait.html#source-view.42" class="phpdocumentor-element-found-in__source" data-line="42" data-modal="source-view" data-src="files/src/InterfaceTraits/CountableTrait.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">A generic implementation of the Countable interface.</p>
<section class="phpdocumentor-description"><p>Internally it counts the values of the protected <code class="prettyprint">$_data</code> array.</p>
</section>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/OCC-Basics-InterfaceTraits-CountableTrait.html#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">author</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>Sebastian Meyer <a href="mailto:sebastian.meyer@opencultureconsulting.com">sebastian.meyer@opencultureconsulting.com</a></p>
</section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">template</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>TValue of mixed</p>
</section>
</dd>
</dl>
<h3 id="toc">
Table of Contents
<a href="classes/OCC-Basics-InterfaceTraits-CountableTrait.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<h4 id="toc-methods">
Methods
<a href="classes/OCC-Basics-InterfaceTraits-CountableTrait.html#toc-methods" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-InterfaceTraits-CountableTrait.html#method_count">count()</a>
<span>
&nbsp;: int<0, max> </span>
</dt>
<dd>Count the data items.</dd>
</dl>
<section class="phpdocumentor-methods">
<h3 class="phpdocumentor-elements__header" id="methods">
Methods
<a href="classes/OCC-Basics-InterfaceTraits-CountableTrait.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_count">
count()
<a href="classes/OCC-Basics-InterfaceTraits-CountableTrait.html#method_count" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/InterfaceTraits/CountableTrait.php"><a href="files/src-interfacetraits-countabletrait.html"><abbr title="src/InterfaceTraits/CountableTrait.php">CountableTrait.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">60</span>
<a href="classes/OCC-Basics-InterfaceTraits-CountableTrait.html#source-view.60" class="phpdocumentor-element-found-in__source" data-line="60" data-modal="source-view" data-src="files/src/InterfaceTraits/CountableTrait.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">Count the data items.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">count</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int<0, max></span></code>
<div class="phpdocumentor-label-line">
<div class="phpdocumentor-label phpdocumentor-label--success"><span>API</span><span>Yes</span></div>
</div>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">int<0, max></span>
&mdash;
<section class="phpdocumentor-description"><p>The number of data items</p>
</section>
</section>
</article>
</section>
<div class="phpdocumentor-modal" id="source-view">
<div class="phpdocumentor-modal-bg" data-exit-button></div>
<div class="phpdocumentor-modal-container">
<div class="phpdocumentor-modal-content">
<pre style="max-height: 500px; overflow-y: scroll" data-src="files/src/InterfaceTraits/CountableTrait.php.txt" class="language-php line-numbers linkable-line-numbers"></pre>
</div>
<button data-exit-button class="phpdocumentor-modal__close">&times;</button>
</div>
</div>
<script type="text/javascript">
(function () {
function loadExternalCodeSnippet(el, url, line) {
Array.prototype.slice.call(el.querySelectorAll('pre[data-src]')).forEach((pre) => {
const src = url || pre.getAttribute('data-src').replace(/\\/g, '/');
const language = 'php';
const code = document.createElement('code');
code.className = 'language-' + language;
pre.textContent = '';
pre.setAttribute('data-line', line)
code.textContent = 'Loading…';
pre.appendChild(code);
var xhr = new XMLHttpRequest();
xhr.open('GET', src, true);
xhr.onreadystatechange = function () {
if (xhr.readyState !== 4) {
return;
}
if (xhr.status < 400 && xhr.responseText) {
code.textContent = xhr.responseText;
Prism.highlightElement(code);
return;
}
if (xhr.status === 404) {
code.textContent = '✖ Error: File could not be found';
return;
}
if (xhr.status >= 400) {
code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
return;
}
code.textContent = '✖ Error: An unknown error occurred';
};
xhr.send(null);
});
}
const modalButtons = document.querySelectorAll("[data-modal]");
const openedAsLocalFile = window.location.protocol === 'file:';
if (modalButtons.length > 0 && openedAsLocalFile) {
console.warn(
'Viewing the source code is unavailable because you are opening this page from the file:// scheme; ' +
'browsers block XHR requests when a page is opened this way'
);
}
modalButtons.forEach(function (trigger) {
if (openedAsLocalFile) {
trigger.setAttribute("hidden", "hidden");
}
trigger.addEventListener("click", function (event) {
event.preventDefault();
const modal = document.getElementById(trigger.dataset.modal);
if (!modal) {
console.error(`Modal with id "${trigger.dataset.modal}" could not be found`);
return;
}
modal.classList.add("phpdocumentor-modal__open");
loadExternalCodeSnippet(modal, trigger.dataset.src || null, trigger.dataset.line)
const exits = modal.querySelectorAll("[data-exit-button]");
exits.forEach(function (exit) {
exit.addEventListener("click", function (event) {
event.preventDefault();
modal.classList.remove("phpdocumentor-modal__open");
});
});
});
});
})();
</script>
</article>
</section>
<section class="phpdocumentor-on-this-page__sidebar">
<section class="phpdocumentor-on-this-page__content">
<strong class="phpdocumentor-on-this-page__title">On this page</strong>
<ul class="phpdocumentor-list -clean">
<li class="phpdocumentor-on-this-page-section__title">Table Of Contents</li>
<li>
<ul class="phpdocumentor-list -clean">
<li><a href="classes/OCC-Basics-InterfaceTraits-CountableTrait.html#toc-methods">Methods</a></li>
</ul>
</li>
<li class="phpdocumentor-on-this-page-section__title">Methods</li>
<li>
<ul class="phpdocumentor-list -clean">
<li><a href="classes/OCC-Basics-InterfaceTraits-CountableTrait.html#method_count">count()</a></li>
</ul>
</li>
</ul>
</section>
</section>
</div>
<section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
<section class="phpdocumentor-search-results__dialog">
<header class="phpdocumentor-search-results__header">
<h2 class="phpdocumentor-search-results__title">Search results</h2>
<button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
</header>
<section class="phpdocumentor-search-results__body">
<ul class="phpdocumentor-search-results__entries"></ul>
</section>
</section>
</section>
</div>
<a href="classes/OCC-Basics-InterfaceTraits-CountableTrait.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
</main>
<script>
cssVars({});
</script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
</body>
</html>

427
doc/classes/OCC-Basics-InterfaceTraits-IteratorAggregateTrait.html
View File

@ -1,427 +0,0 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>PHP Basics</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<base href="../">
<link rel="icon" href="images/favicon.ico"/>
<link rel="stylesheet" href="css/normalize.css">
<link rel="stylesheet" href="css/base.css">
<link rel="preconnect" href="https://fonts.gstatic.com">
<link href="https://fonts.googleapis.com/css2?family=Open+Sans:wght@100;200;300;400;600;700&display=swap" rel="stylesheet">
<link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet">
<link rel="stylesheet" href="css/template.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
<script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
<script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
<script src="js/template.js"></script>
<script src="js/search.js"></script>
<script defer src="js/searchIndex.js"></script>
</head>
<body id="top">
<header class="phpdocumentor-header phpdocumentor-section">
<h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">PHP Basics</a></h1>
<input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
<label class="phpdocumentor-header__menu-icon" for="menu-button">
<i class="fas fa-bars"></i>
</label>
<section data-search-form class="phpdocumentor-search">
<label>
<span class="visually-hidden">Search for</span>
<svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
<circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
<line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
</svg>
<input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
</label>
</section>
<nav class="phpdocumentor-topnav">
<ul class="phpdocumentor-topnav__menu">
<li class="phpdocumentor-topnav__menu-item -menu">
<a href="https://packagist.org/packages/opencultureconsulting/basics">
<span>
<i class="fab fa-php"></i>
</span>
</a>
</li>
<li class="phpdocumentor-topnav__menu-item -menu">
<a href="https://github.com/opencultureconsulting/php-basics">
<span>
<i class="fab fa-github"></i>
</span>
</a>
</li>
</ul>
</nav>
</header>
<main class="phpdocumentor">
<div class="phpdocumentor-section">
<input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
<label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
Menu
</label>
<aside class="phpdocumentor-column -three phpdocumentor-sidebar">
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Documentation</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="guides/installation/index.html#installation" class="">Installation</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="guides/installation/test.html#test" class="">Test</a>
</li>
</ul>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="guides/changelog/index.html#changelog" class="">Changelog</a>
</h4>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="namespaces/occ.html" class="">OCC</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="namespaces/occ-basics.html" class="">Basics</a>
</li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="packages/Basics.html" class="">Basics</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="packages/Basics-DataStructures.html" class="">DataStructures</a>
</li>
<li>
<a href="packages/Basics-ErrorHandlers.html" class="">ErrorHandlers</a>
</li>
<li>
<a href="packages/Basics-InterfaceTraits.html" class="">InterfaceTraits</a>
</li>
<li>
<a href="packages/Basics-Traits.html" class="">Traits</a>
</li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
</section>
</aside>
<div class="phpdocumentor-column -nine phpdocumentor-content">
<section>
<ul class="phpdocumentor-breadcrumbs">
<li class="phpdocumentor-breadcrumb"><a href="namespaces/occ.html">OCC</a></li>
<li class="phpdocumentor-breadcrumb"><a href="namespaces/occ-basics.html">Basics</a></li>
<li class="phpdocumentor-breadcrumb"><a href="namespaces/occ-basics-interfacetraits.html">InterfaceTraits</a></li>
</ul>
<article class="phpdocumentor-element -trait">
<h2 class="phpdocumentor-content__title">
IteratorAggregateTrait
</h2>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/InterfaceTraits/IteratorAggregateTrait.php"><a href="files/src-interfacetraits-iteratoraggregatetrait.html"><abbr title="src/InterfaceTraits/IteratorAggregateTrait.php">IteratorAggregateTrait.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">43</span>
<a href="classes/OCC-Basics-InterfaceTraits-IteratorAggregateTrait.html#source-view.43" class="phpdocumentor-element-found-in__source" data-line="43" data-modal="source-view" data-src="files/src/InterfaceTraits/IteratorAggregateTrait.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">A generic implementation of the IteratorAggregate interface.</p>
<section class="phpdocumentor-description"><p>Internally it iterates over the protected <code class="prettyprint">$_data</code> array.</p>
</section>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/OCC-Basics-InterfaceTraits-IteratorAggregateTrait.html#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">author</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>Sebastian Meyer <a href="mailto:sebastian.meyer@opencultureconsulting.com">sebastian.meyer@opencultureconsulting.com</a></p>
</section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">template</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>TValue of mixed</p>
</section>
</dd>
</dl>
<h3 id="toc">
Table of Contents
<a href="classes/OCC-Basics-InterfaceTraits-IteratorAggregateTrait.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<h4 id="toc-methods">
Methods
<a href="classes/OCC-Basics-InterfaceTraits-IteratorAggregateTrait.html#toc-methods" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-InterfaceTraits-IteratorAggregateTrait.html#method_getIterator">getIterator()</a>
<span>
&nbsp;: <abbr title="\ArrayIterator">ArrayIterator</abbr>&lt;string|int, <abbr title="\OCC\Basics\InterfaceTraits\TValue">TValue</abbr>&gt; </span>
</dt>
<dd>Retrieve an external iterator.</dd>
</dl>
<section class="phpdocumentor-methods">
<h3 class="phpdocumentor-elements__header" id="methods">
Methods
<a href="classes/OCC-Basics-InterfaceTraits-IteratorAggregateTrait.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getIterator">
getIterator()
<a href="classes/OCC-Basics-InterfaceTraits-IteratorAggregateTrait.html#method_getIterator" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/InterfaceTraits/IteratorAggregateTrait.php"><a href="files/src-interfacetraits-iteratoraggregatetrait.html"><abbr title="src/InterfaceTraits/IteratorAggregateTrait.php">IteratorAggregateTrait.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">61</span>
<a href="classes/OCC-Basics-InterfaceTraits-IteratorAggregateTrait.html#source-view.61" class="phpdocumentor-element-found-in__source" data-line="61" data-modal="source-view" data-src="files/src/InterfaceTraits/IteratorAggregateTrait.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">Retrieve an external iterator.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getIterator</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><abbr title="\ArrayIterator">ArrayIterator</abbr>&lt;string|int, <abbr title="\OCC\Basics\InterfaceTraits\TValue">TValue</abbr>&gt;</span></code>
<div class="phpdocumentor-label-line">
<div class="phpdocumentor-label phpdocumentor-label--success"><span>API</span><span>Yes</span></div>
</div>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><abbr title="\ArrayIterator">ArrayIterator</abbr>&lt;string|int, <abbr title="\OCC\Basics\InterfaceTraits\TValue">TValue</abbr>&gt;</span>
&mdash;
<section class="phpdocumentor-description"><p>New iterator for the data array</p>
</section>
</section>
</article>
</section>
<div class="phpdocumentor-modal" id="source-view">
<div class="phpdocumentor-modal-bg" data-exit-button></div>
<div class="phpdocumentor-modal-container">
<div class="phpdocumentor-modal-content">
<pre style="max-height: 500px; overflow-y: scroll" data-src="files/src/InterfaceTraits/IteratorAggregateTrait.php.txt" class="language-php line-numbers linkable-line-numbers"></pre>
</div>
<button data-exit-button class="phpdocumentor-modal__close">&times;</button>
</div>
</div>
<script type="text/javascript">
(function () {
function loadExternalCodeSnippet(el, url, line) {
Array.prototype.slice.call(el.querySelectorAll('pre[data-src]')).forEach((pre) => {
const src = url || pre.getAttribute('data-src').replace(/\\/g, '/');
const language = 'php';
const code = document.createElement('code');
code.className = 'language-' + language;
pre.textContent = '';
pre.setAttribute('data-line', line)
code.textContent = 'Loading…';
pre.appendChild(code);
var xhr = new XMLHttpRequest();
xhr.open('GET', src, true);
xhr.onreadystatechange = function () {
if (xhr.readyState !== 4) {
return;
}
if (xhr.status < 400 && xhr.responseText) {
code.textContent = xhr.responseText;
Prism.highlightElement(code);
return;
}
if (xhr.status === 404) {
code.textContent = '✖ Error: File could not be found';
return;
}
if (xhr.status >= 400) {
code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
return;
}
code.textContent = '✖ Error: An unknown error occurred';
};
xhr.send(null);
});
}
const modalButtons = document.querySelectorAll("[data-modal]");
const openedAsLocalFile = window.location.protocol === 'file:';
if (modalButtons.length > 0 && openedAsLocalFile) {
console.warn(
'Viewing the source code is unavailable because you are opening this page from the file:// scheme; ' +
'browsers block XHR requests when a page is opened this way'
);
}
modalButtons.forEach(function (trigger) {
if (openedAsLocalFile) {
trigger.setAttribute("hidden", "hidden");
}
trigger.addEventListener("click", function (event) {
event.preventDefault();
const modal = document.getElementById(trigger.dataset.modal);
if (!modal) {
console.error(`Modal with id "${trigger.dataset.modal}" could not be found`);
return;
}
modal.classList.add("phpdocumentor-modal__open");
loadExternalCodeSnippet(modal, trigger.dataset.src || null, trigger.dataset.line)
const exits = modal.querySelectorAll("[data-exit-button]");
exits.forEach(function (exit) {
exit.addEventListener("click", function (event) {
event.preventDefault();
modal.classList.remove("phpdocumentor-modal__open");
});
});
});
});
})();
</script>
</article>
</section>
<section class="phpdocumentor-on-this-page__sidebar">
<section class="phpdocumentor-on-this-page__content">
<strong class="phpdocumentor-on-this-page__title">On this page</strong>
<ul class="phpdocumentor-list -clean">
<li class="phpdocumentor-on-this-page-section__title">Table Of Contents</li>
<li>
<ul class="phpdocumentor-list -clean">
<li><a href="classes/OCC-Basics-InterfaceTraits-IteratorAggregateTrait.html#toc-methods">Methods</a></li>
</ul>
</li>
<li class="phpdocumentor-on-this-page-section__title">Methods</li>
<li>
<ul class="phpdocumentor-list -clean">
<li><a href="classes/OCC-Basics-InterfaceTraits-IteratorAggregateTrait.html#method_getIterator">getIterator()</a></li>
</ul>
</li>
</ul>
</section>
</section>
</div>
<section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
<section class="phpdocumentor-search-results__dialog">
<header class="phpdocumentor-search-results__header">
<h2 class="phpdocumentor-search-results__title">Search results</h2>
<button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
</header>
<section class="phpdocumentor-search-results__body">
<ul class="phpdocumentor-search-results__entries"></ul>
</section>
</section>
</section>
</div>
<a href="classes/OCC-Basics-InterfaceTraits-IteratorAggregateTrait.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
</main>
<script>
cssVars({});
</script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
</body>
</html>

658
doc/classes/OCC-Basics-InterfaceTraits-IteratorTrait.html
View File

@ -1,658 +0,0 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>PHP Basics</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<base href="../">
<link rel="icon" href="images/favicon.ico"/>
<link rel="stylesheet" href="css/normalize.css">
<link rel="stylesheet" href="css/base.css">
<link rel="preconnect" href="https://fonts.gstatic.com">
<link href="https://fonts.googleapis.com/css2?family=Open+Sans:wght@100;200;300;400;600;700&display=swap" rel="stylesheet">
<link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet">
<link rel="stylesheet" href="css/template.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
<script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
<script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
<script src="js/template.js"></script>
<script src="js/search.js"></script>
<script defer src="js/searchIndex.js"></script>
</head>
<body id="top">
<header class="phpdocumentor-header phpdocumentor-section">
<h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">PHP Basics</a></h1>
<input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
<label class="phpdocumentor-header__menu-icon" for="menu-button">
<i class="fas fa-bars"></i>
</label>
<section data-search-form class="phpdocumentor-search">
<label>
<span class="visually-hidden">Search for</span>
<svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
<circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
<line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
</svg>
<input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
</label>
</section>
<nav class="phpdocumentor-topnav">
<ul class="phpdocumentor-topnav__menu">
<li class="phpdocumentor-topnav__menu-item -menu">
<a href="https://packagist.org/packages/opencultureconsulting/basics">
<span>
<i class="fab fa-php"></i>
</span>
</a>
</li>
<li class="phpdocumentor-topnav__menu-item -menu">
<a href="https://github.com/opencultureconsulting/php-basics">
<span>
<i class="fab fa-github"></i>
</span>
</a>
</li>
</ul>
</nav>
</header>
<main class="phpdocumentor">
<div class="phpdocumentor-section">
<input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
<label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
Menu
</label>
<aside class="phpdocumentor-column -three phpdocumentor-sidebar">
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Documentation</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="guides/installation/index.html#installation" class="">Installation</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="guides/installation/test.html#test" class="">Test</a>
</li>
</ul>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="guides/changelog/index.html#changelog" class="">Changelog</a>
</h4>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="namespaces/occ.html" class="">OCC</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="namespaces/occ-basics.html" class="">Basics</a>
</li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="packages/Basics.html" class="">Basics</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="packages/Basics-DataStructures.html" class="">DataStructures</a>
</li>
<li>
<a href="packages/Basics-ErrorHandlers.html" class="">ErrorHandlers</a>
</li>
<li>
<a href="packages/Basics-InterfaceTraits.html" class="">InterfaceTraits</a>
</li>
<li>
<a href="packages/Basics-Traits.html" class="">Traits</a>
</li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
</section>
</aside>
<div class="phpdocumentor-column -nine phpdocumentor-content">
<section>
<ul class="phpdocumentor-breadcrumbs">
<li class="phpdocumentor-breadcrumb"><a href="namespaces/occ.html">OCC</a></li>
<li class="phpdocumentor-breadcrumb"><a href="namespaces/occ-basics.html">Basics</a></li>
<li class="phpdocumentor-breadcrumb"><a href="namespaces/occ-basics-interfacetraits.html">InterfaceTraits</a></li>
</ul>
<article class="phpdocumentor-element -trait">
<h2 class="phpdocumentor-content__title">
IteratorTrait
</h2>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/InterfaceTraits/IteratorTrait.php"><a href="files/src-interfacetraits-iteratortrait.html"><abbr title="src/InterfaceTraits/IteratorTrait.php">IteratorTrait.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">42</span>
<a href="classes/OCC-Basics-InterfaceTraits-IteratorTrait.html#source-view.42" class="phpdocumentor-element-found-in__source" data-line="42" data-modal="source-view" data-src="files/src/InterfaceTraits/IteratorTrait.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">A generic implementation of the Iterator interface.</p>
<section class="phpdocumentor-description"><p>Internally it iterates over the protected <code class="prettyprint">$_data</code> array.</p>
</section>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/OCC-Basics-InterfaceTraits-IteratorTrait.html#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">author</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>Sebastian Meyer <a href="mailto:sebastian.meyer@opencultureconsulting.com">sebastian.meyer@opencultureconsulting.com</a></p>
</section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">template</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>TValue of mixed</p>
</section>
</dd>
</dl>
<h3 id="toc">
Table of Contents
<a href="classes/OCC-Basics-InterfaceTraits-IteratorTrait.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<h4 id="toc-methods">
Methods
<a href="classes/OCC-Basics-InterfaceTraits-IteratorTrait.html#toc-methods" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-InterfaceTraits-IteratorTrait.html#method_current">current()</a>
<span>
&nbsp;: <abbr title="\OCC\Basics\InterfaceTraits\TValue">TValue</abbr>|null </span>
</dt>
<dd>Return the current item.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-InterfaceTraits-IteratorTrait.html#method_key">key()</a>
<span>
&nbsp;: string|int|null </span>
</dt>
<dd>Return the current key.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-InterfaceTraits-IteratorTrait.html#method_next">next()</a>
<span>
&nbsp;: void </span>
</dt>
<dd>Move forward to next item.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-InterfaceTraits-IteratorTrait.html#method_prev">prev()</a>
<span>
&nbsp;: void </span>
</dt>
<dd>Move back to previous item.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-InterfaceTraits-IteratorTrait.html#method_rewind">rewind()</a>
<span>
&nbsp;: void </span>
</dt>
<dd>Rewind the iterator to the first item.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/OCC-Basics-InterfaceTraits-IteratorTrait.html#method_valid">valid()</a>
<span>
&nbsp;: bool </span>
</dt>
<dd>Check if current position is valid.</dd>
</dl>
<section class="phpdocumentor-methods">
<h3 class="phpdocumentor-elements__header" id="methods">
Methods
<a href="classes/OCC-Basics-InterfaceTraits-IteratorTrait.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_current">
current()
<a href="classes/OCC-Basics-InterfaceTraits-IteratorTrait.html#method_current" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/InterfaceTraits/IteratorTrait.php"><a href="files/src-interfacetraits-iteratortrait.html"><abbr title="src/InterfaceTraits/IteratorTrait.php">IteratorTrait.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">60</span>
<a href="classes/OCC-Basics-InterfaceTraits-IteratorTrait.html#source-view.60" class="phpdocumentor-element-found-in__source" data-line="60" data-modal="source-view" data-src="files/src/InterfaceTraits/IteratorTrait.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">Return the current item.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">current</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><abbr title="\OCC\Basics\InterfaceTraits\TValue">TValue</abbr>|null</span></code>
<div class="phpdocumentor-label-line">
<div class="phpdocumentor-label phpdocumentor-label--success"><span>API</span><span>Yes</span></div>
</div>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><abbr title="\OCC\Basics\InterfaceTraits\TValue">TValue</abbr>|null</span>
&mdash;
<section class="phpdocumentor-description"><p>The current item or NULL if invalid</p>
</section>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_key">
key()
<a href="classes/OCC-Basics-InterfaceTraits-IteratorTrait.html#method_key" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/InterfaceTraits/IteratorTrait.php"><a href="files/src-interfacetraits-iteratortrait.html"><abbr title="src/InterfaceTraits/IteratorTrait.php">IteratorTrait.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">76</span>
<a href="classes/OCC-Basics-InterfaceTraits-IteratorTrait.html#source-view.76" class="phpdocumentor-element-found-in__source" data-line="76" data-modal="source-view" data-src="files/src/InterfaceTraits/IteratorTrait.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">Return the current key.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">key</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string|int|null</span></code>
<div class="phpdocumentor-label-line">
<div class="phpdocumentor-label phpdocumentor-label--success"><span>API</span><span>Yes</span></div>
</div>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string|int|null</span>
&mdash;
<section class="phpdocumentor-description"><p>The current key or NULL if invalid</p>
</section>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_next">
next()
<a href="classes/OCC-Basics-InterfaceTraits-IteratorTrait.html#method_next" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/InterfaceTraits/IteratorTrait.php"><a href="files/src-interfacetraits-iteratortrait.html"><abbr title="src/InterfaceTraits/IteratorTrait.php">IteratorTrait.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">88</span>
<a href="classes/OCC-Basics-InterfaceTraits-IteratorTrait.html#source-view.88" class="phpdocumentor-element-found-in__source" data-line="88" data-modal="source-view" data-src="files/src/InterfaceTraits/IteratorTrait.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">Move forward to next item.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">next</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<div class="phpdocumentor-label-line">
<div class="phpdocumentor-label phpdocumentor-label--success"><span>API</span><span>Yes</span></div>
</div>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_prev">
prev()
<a href="classes/OCC-Basics-InterfaceTraits-IteratorTrait.html#method_prev" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/InterfaceTraits/IteratorTrait.php"><a href="files/src-interfacetraits-iteratortrait.html"><abbr title="src/InterfaceTraits/IteratorTrait.php">IteratorTrait.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">100</span>
<a href="classes/OCC-Basics-InterfaceTraits-IteratorTrait.html#source-view.100" class="phpdocumentor-element-found-in__source" data-line="100" data-modal="source-view" data-src="files/src/InterfaceTraits/IteratorTrait.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">Move back to previous item.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">prev</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<div class="phpdocumentor-label-line">
<div class="phpdocumentor-label phpdocumentor-label--success"><span>API</span><span>Yes</span></div>
</div>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_rewind">
rewind()
<a href="classes/OCC-Basics-InterfaceTraits-IteratorTrait.html#method_rewind" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/InterfaceTraits/IteratorTrait.php"><a href="files/src-interfacetraits-iteratortrait.html"><abbr title="src/InterfaceTraits/IteratorTrait.php">IteratorTrait.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">112</span>
<a href="classes/OCC-Basics-InterfaceTraits-IteratorTrait.html#source-view.112" class="phpdocumentor-element-found-in__source" data-line="112" data-modal="source-view" data-src="files/src/InterfaceTraits/IteratorTrait.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">Rewind the iterator to the first item.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">rewind</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<div class="phpdocumentor-label-line">
<div class="phpdocumentor-label phpdocumentor-label--success"><span>API</span><span>Yes</span></div>
</div>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_valid">
valid()
<a href="classes/OCC-Basics-InterfaceTraits-IteratorTrait.html#method_valid" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/InterfaceTraits/IteratorTrait.php"><a href="files/src-interfacetraits-iteratortrait.html"><abbr title="src/InterfaceTraits/IteratorTrait.php">IteratorTrait.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">124</span>
<a href="classes/OCC-Basics-InterfaceTraits-IteratorTrait.html#source-view.124" class="phpdocumentor-element-found-in__source" data-line="124" data-modal="source-view" data-src="files/src/InterfaceTraits/IteratorTrait.php.txt"></a>
</aside>
<p class="phpdocumentor-summary">Check if current position is valid.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">valid</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<div class="phpdocumentor-label-line">
<div class="phpdocumentor-label phpdocumentor-label--success"><span>API</span><span>Yes</span></div>
</div>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
&mdash;
<section class="phpdocumentor-description"><p>Whether the current position is valid</p>
</section>
</section>
</article>
</section>
<div class="phpdocumentor-modal" id="source-view">
<div class="phpdocumentor-modal-bg" data-exit-button></div>
<div class="phpdocumentor-modal-container">
<div class="phpdocumentor-modal-content">
<pre style="max-height: 500px; overflow-y: scroll" data-src="files/src/InterfaceTraits/IteratorTrait.php.txt" class="language-php line-numbers linkable-line-numbers"></pre>
</div>
<button data-exit-button class="phpdocumentor-modal__close">&times;</button>
</div>
</div>
<script type="text/javascript">
(function () {
function loadExternalCodeSnippet(el, url, line) {
Array.prototype.slice.call(el.querySelectorAll('pre[data-src]')).forEach((pre) => {
const src = url || pre.getAttribute('data-src').replace(/\\/g, '/');
const language = 'php';
const code = document.createElement('code');
code.className = 'language-' + language;
pre.textContent = '';
pre.setAttribute('data-line', line)
code.textContent = 'Loading…';
pre.appendChild(code);
var xhr = new XMLHttpRequest();
xhr.open('GET', src, true);
xhr.onreadystatechange = function () {
if (xhr.readyState !== 4) {
return;
}
if (xhr.status < 400 && xhr.responseText) {
code.textContent = xhr.responseText;
Prism.highlightElement(code);
return;
}
if (xhr.status === 404) {
code.textContent = '✖ Error: File could not be found';
return;
}
if (xhr.status >= 400) {
code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
return;
}
code.textContent = '✖ Error: An unknown error occurred';
};
xhr.send(null);
});
}
const modalButtons = document.querySelectorAll("[data-modal]");
const openedAsLocalFile = window.location.protocol === 'file:';
if (modalButtons.length > 0 && openedAsLocalFile) {
console.warn(
'Viewing the source code is unavailable because you are opening this page from the file:// scheme; ' +
'browsers block XHR requests when a page is opened this way'
);
}
modalButtons.forEach(function (trigger) {
if (openedAsLocalFile) {
trigger.setAttribute("hidden", "hidden");
}
trigger.addEventListener("click", function (event) {
event.preventDefault();
const modal = document.getElementById(trigger.dataset.modal);
if (!modal) {
console.error(`Modal with id "${trigger.dataset.modal}" could not be found`);
return;
}
modal.classList.add("phpdocumentor-modal__open");
loadExternalCodeSnippet(modal, trigger.dataset.src || null, trigger.dataset.line)
const exits = modal.querySelectorAll("[data-exit-button]");
exits.forEach(function (exit) {
exit.addEventListener("click", function (event) {
event.preventDefault();
modal.classList.remove("phpdocumentor-modal__open");
});
});
});
});
})();
</script>
</article>
</section>
<section class="phpdocumentor-on-this-page__sidebar">
<section class="phpdocumentor-on-this-page__content">
<strong class="phpdocumentor-on-this-page__title">On this page</strong>
<ul class="phpdocumentor-list -clean">
<li class="phpdocumentor-on-this-page-section__title">Table Of Contents</li>
<li>
<ul class="phpdocumentor-list -clean">
<li><a href="classes/OCC-Basics-InterfaceTraits-IteratorTrait.html#toc-methods">Methods</a></li>
</ul>
</li>
<li class="phpdocumentor-on-this-page-section__title">Methods</li>
<li>
<ul class="phpdocumentor-list -clean">
<li><a href="classes/OCC-Basics-InterfaceTraits-IteratorTrait.html#method_current">current()</a></li>
<li><a href="classes/OCC-Basics-InterfaceTraits-IteratorTrait.html#method_key">key()</a></li>
<li><a href="classes/OCC-Basics-InterfaceTraits-IteratorTrait.html#method_next">next()</a></li>
<li><a href="classes/OCC-Basics-InterfaceTraits-IteratorTrait.html#method_prev">prev()</a></li>
<li><a href="classes/OCC-Basics-InterfaceTraits-IteratorTrait.html#method_rewind">rewind()</a></li>
<li><a href="classes/OCC-Basics-InterfaceTraits-IteratorTrait.html#method_valid">valid()</a></li>
</ul>
</li>
</ul>
</section>
</section>
</div>
<section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
<section class="phpdocumentor-search-results__dialog">
<header class="phpdocumentor-search-results__header">
<h2 class="phpdocumentor-search-results__title">Search results</h2>
<button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
</header>
<section class="phpdocumentor-search-results__body">
<ul class="phpdocumentor-search-results__entries"></ul>
</section>
</section>
</section>
</div>
<a href="classes/OCC-Basics-InterfaceTraits-IteratorTrait.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
</main>
<script>
cssVars({});
</script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
</body>
</html>

332
doc/files/src-datastructures-collection.html
View File

@ -1,332 +0,0 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>PHP Basics</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<base href="../">
<link rel="icon" href="images/favicon.ico"/>
<link rel="stylesheet" href="css/normalize.css">
<link rel="stylesheet" href="css/base.css">
<link rel="preconnect" href="https://fonts.gstatic.com">
<link href="https://fonts.googleapis.com/css2?family=Open+Sans:wght@100;200;300;400;600;700&display=swap" rel="stylesheet">
<link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet">
<link rel="stylesheet" href="css/template.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
<script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
<script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
<script src="js/template.js"></script>
<script src="js/search.js"></script>
<script defer src="js/searchIndex.js"></script>
</head>
<body id="top">
<header class="phpdocumentor-header phpdocumentor-section">
<h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">PHP Basics</a></h1>
<input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
<label class="phpdocumentor-header__menu-icon" for="menu-button">
<i class="fas fa-bars"></i>
</label>
<section data-search-form class="phpdocumentor-search">
<label>
<span class="visually-hidden">Search for</span>
<svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
<circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
<line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
</svg>
<input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
</label>
</section>
<nav class="phpdocumentor-topnav">
<ul class="phpdocumentor-topnav__menu">
<li class="phpdocumentor-topnav__menu-item -menu">
<a href="https://packagist.org/packages/opencultureconsulting/basics">
<span>
<i class="fab fa-php"></i>
</span>
</a>
</li>
<li class="phpdocumentor-topnav__menu-item -menu">
<a href="https://github.com/opencultureconsulting/php-basics">
<span>
<i class="fab fa-github"></i>
</span>
</a>
</li>
</ul>
</nav>
</header>
<main class="phpdocumentor">
<div class="phpdocumentor-section">
<input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
<label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
Menu
</label>
<aside class="phpdocumentor-column -three phpdocumentor-sidebar">
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Documentation</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="guides/installation/index.html#installation" class="">Installation</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="guides/installation/test.html#test" class="">Test</a>
</li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="namespaces/occ.html" class="">OCC</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="namespaces/occ-basics.html" class="">Basics</a>
</li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="packages/Basics.html" class="">Basics</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="packages/Basics-DataStructures.html" class="">DataStructures</a>
</li>
<li>
<a href="packages/Basics-ErrorHandlers.html" class="">ErrorHandlers</a>
</li>
<li>
<a href="packages/Basics-InterfaceTraits.html" class="">InterfaceTraits</a>
</li>
<li>
<a href="packages/Basics-Traits.html" class="">Traits</a>
</li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
</section>
</aside>
<div class="phpdocumentor-column -nine phpdocumentor-content">
<section>
<ul class="phpdocumentor-breadcrumbs">
</ul>
<article class="phpdocumentor-element -file">
<h2 class="phpdocumentor-content__title">Collection.php</h2>
<p class="phpdocumentor-summary">PHP Basics</p>
<section class="phpdocumentor-description"><p>Copyright (C) 2024 Sebastian Meyer <a href="mailto:sebastian.meyer@opencultureconsulting.com">sebastian.meyer@opencultureconsulting.com</a></p>
<p>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.</p>
<p>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.</p>
<p>You should have received a copy of the GNU General Public License
along with this program. If not, see <a href="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</a>.</p>
</section>
<h3 id="toc">
Table of Contents
<a href="files/src-datastructures-collection.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<h4 id="toc-classes">
Classes
<a href="files/src-datastructures-collection.html#toc-classes" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/OCC-Basics-DataStructures-Collection.html"><abbr title="\OCC\Basics\DataStructures\Collection">Collection</abbr></a></dt><dd>A generic collection of items.</dd> </dl>
<div class="phpdocumentor-modal" id="source-view">
<div class="phpdocumentor-modal-bg" data-exit-button></div>
<div class="phpdocumentor-modal-container">
<div class="phpdocumentor-modal-content">
<pre style="max-height: 500px; overflow-y: scroll" data-src="files/src/DataStructures/Collection.php.txt" class="language-php line-numbers linkable-line-numbers"></pre>
</div>
<button data-exit-button class="phpdocumentor-modal__close">&times;</button>
</div>
</div>
<script type="text/javascript">
(function () {
function loadExternalCodeSnippet(el, url, line) {
Array.prototype.slice.call(el.querySelectorAll('pre[data-src]')).forEach((pre) => {
const src = url || pre.getAttribute('data-src').replace(/\\/g, '/');
const language = 'php';
const code = document.createElement('code');
code.className = 'language-' + language;
pre.textContent = '';
pre.setAttribute('data-line', line)
code.textContent = 'Loading…';
pre.appendChild(code);
var xhr = new XMLHttpRequest();
xhr.open('GET', src, true);
xhr.onreadystatechange = function () {
if (xhr.readyState !== 4) {
return;
}
if (xhr.status < 400 && xhr.responseText) {
code.textContent = xhr.responseText;
Prism.highlightElement(code);
return;
}
if (xhr.status === 404) {
code.textContent = '✖ Error: File could not be found';
return;
}
if (xhr.status >= 400) {
code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
return;
}
code.textContent = '✖ Error: An unknown error occurred';
};
xhr.send(null);
});
}
const modalButtons = document.querySelectorAll("[data-modal]");
const openedAsLocalFile = window.location.protocol === 'file:';
if (modalButtons.length > 0 && openedAsLocalFile) {
console.warn(
'Viewing the source code is unavailable because you are opening this page from the file:// scheme; ' +
'browsers block XHR requests when a page is opened this way'
);
}
modalButtons.forEach(function (trigger) {
if (openedAsLocalFile) {
trigger.setAttribute("hidden", "hidden");
}
trigger.addEventListener("click", function (event) {
event.preventDefault();
const modal = document.getElementById(trigger.dataset.modal);
if (!modal) {
console.error(`Modal with id "${trigger.dataset.modal}" could not be found`);
return;
}
modal.classList.add("phpdocumentor-modal__open");
loadExternalCodeSnippet(modal, trigger.dataset.src || null, trigger.dataset.line)
const exits = modal.querySelectorAll("[data-exit-button]");
exits.forEach(function (exit) {
exit.addEventListener("click", function (event) {
event.preventDefault();
modal.classList.remove("phpdocumentor-modal__open");
});
});
});
});
})();
</script>
</article>
</section>
<section class="phpdocumentor-on-this-page__sidebar">
<section class="phpdocumentor-on-this-page__content">
<strong class="phpdocumentor-on-this-page__title">On this page</strong>
<ul class="phpdocumentor-list -clean">
<li class="phpdocumentor-on-this-page-section__title">Table Of Contents</li>
<li>
<ul class="phpdocumentor-list -clean">
<li><a href="files/src-datastructures-collection.html#toc-classes">Classes</a></li>
</ul>
</li>
</ul>
</section>
</section>
</div>
<section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
<section class="phpdocumentor-search-results__dialog">
<header class="phpdocumentor-search-results__header">
<h2 class="phpdocumentor-search-results__title">Search results</h2>
<button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
</header>
<section class="phpdocumentor-search-results__body">
<ul class="phpdocumentor-search-results__entries"></ul>
</section>
</section>
</section>
</div>
<a href="files/src-datastructures-collection.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
</main>
<script>
cssVars({});
</script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
</body>
</html>

362
doc/files/src-datastructures-strictspldatastructuretrait.html
View File

@ -1,362 +0,0 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>PHP Basics</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<base href="../">
<link rel="icon" href="images/favicon.ico"/>
<link rel="stylesheet" href="css/normalize.css">
<link rel="stylesheet" href="css/base.css">
<link rel="preconnect" href="https://fonts.gstatic.com">
<link href="https://fonts.googleapis.com/css2?family=Open+Sans:wght@100;200;300;400;600;700&display=swap" rel="stylesheet">
<link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet">
<link rel="stylesheet" href="css/template.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
<script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
<script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
<script src="js/template.js"></script>
<script src="js/search.js"></script>
<script defer src="js/searchIndex.js"></script>
</head>
<body id="top">
<header class="phpdocumentor-header phpdocumentor-section">
<h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">PHP Basics</a></h1>
<input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
<label class="phpdocumentor-header__menu-icon" for="menu-button">
<i class="fas fa-bars"></i>
</label>
<section data-search-form class="phpdocumentor-search">
<label>
<span class="visually-hidden">Search for</span>
<svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
<circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
<line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
</svg>
<input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
</label>
</section>
<nav class="phpdocumentor-topnav">
<ul class="phpdocumentor-topnav__menu">
<li class="phpdocumentor-topnav__menu-item -menu">
<a href="https://packagist.org/packages/opencultureconsulting/basics">
<span>
<i class="fab fa-php"></i>
</span>
</a>
</li>
<li class="phpdocumentor-topnav__menu-item -menu">
<a href="https://github.com/opencultureconsulting/php-basics">
<span>
<i class="fab fa-github"></i>
</span>
</a>
</li>
</ul>
</nav>
</header>
<main class="phpdocumentor">
<div class="phpdocumentor-section">
<input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
<label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
Menu
</label>
<aside class="phpdocumentor-column -three phpdocumentor-sidebar">
<section class="phpdocumentor-sidebar__category -documentation">
<h2 class="phpdocumentor-sidebar__category-header">Documentation</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="guides/overview/index.html#overview" class="">Overview</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="guides/overview/datastructures.html#typed-datastructures" class="">Typed Datastructures</a>
</li>
<li>
<a href="guides/overview/errorhandlers.html#error-and-exception-handlers" class="">Error and Exception Handlers</a>
</li>
<li>
<a href="guides/overview/interfaces.html#interface-traits" class="">Interface Traits</a>
</li>
<li>
<a href="guides/overview/traits.html#traits" class="">Traits</a>
</li>
</ul>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="guides/usage/index.html#user-guide" class="">User Guide</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="guides/usage/requirements.html#requirements" class="">Requirements</a>
</li>
<li>
<a href="guides/usage/installation.html#installation" class="">Installation</a>
</li>
</ul>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="guides/changelog.html#changelog" class="">Changelog</a>
</h4>
</section>
<section class="phpdocumentor-sidebar__category -namespaces">
<h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="namespaces/occ.html" class="">OCC</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="namespaces/occ-basics.html" class="">Basics</a>
</li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category -packages">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="packages/Basics.html" class="">Basics</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="packages/Basics-DataStructures.html" class="">DataStructures</a>
</li>
<li>
<a href="packages/Basics-ErrorHandlers.html" class="">ErrorHandlers</a>
</li>
<li>
<a href="packages/Basics-Interfaces.html" class="">Interfaces</a>
</li>
<li>
<a href="packages/Basics-Traits.html" class="">Traits</a>
</li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category -reports">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
</section>
<section class="phpdocumentor-sidebar__category -indices">
<h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
</section>
</aside>
<div class="phpdocumentor-column -nine phpdocumentor-content">
<section>
<ul class="phpdocumentor-breadcrumbs">
</ul>
<article class="phpdocumentor-element -file">
<h2 class="phpdocumentor-content__title">StrictSplDatastructureTrait.php</h2>
<p class="phpdocumentor-summary">PHP Basics</p>
<section class="phpdocumentor-description"><p>Copyright (C) 2024 Sebastian Meyer <a href="mailto:sebastian.meyer@opencultureconsulting.com">sebastian.meyer@opencultureconsulting.com</a></p>
<p>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.</p>
<p>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.</p>
<p>You should have received a copy of the GNU General Public License
along with this program. If not, see <a href="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</a>.</p>
</section>
<h3 id="toc">
Table of Contents
<a href="files/src-datastructures-strictspldatastructuretrait.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<h4 id="toc-traits">
Traits
<a href="files/src-datastructures-strictspldatastructuretrait.html#toc-traits" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -trait"><a href="classes/OCC-Basics-DataStructures-StrictSplDatastructureTrait.html"><abbr title="\OCC\Basics\DataStructures\StrictSplDatastructureTrait">StrictSplDatastructureTrait</abbr></a></dt><dd>The common interface of all type-sensitive, SPL-based datastructures.</dd> </dl>
<div class="phpdocumentor-modal" id="source-view">
<div class="phpdocumentor-modal-bg" data-exit-button></div>
<div class="phpdocumentor-modal-container">
<div class="phpdocumentor-modal-content">
<pre style="max-height: 500px; overflow-y: scroll" data-src="files/src/DataStructures/StrictSplDatastructureTrait.php.txt" class="language-php line-numbers linkable-line-numbers"></pre>
</div>
<button data-exit-button class="phpdocumentor-modal__close">&times;</button>
</div>
</div>
<script type="text/javascript">
(function () {
function loadExternalCodeSnippet(el, url, line) {
Array.prototype.slice.call(el.querySelectorAll('pre[data-src]')).forEach((pre) => {
const src = url || pre.getAttribute('data-src').replace(/\\/g, '/');
const language = 'php';
const code = document.createElement('code');
code.className = 'language-' + language;
pre.textContent = '';
pre.setAttribute('data-line', line)
code.textContent = 'Loading…';
pre.appendChild(code);
var xhr = new XMLHttpRequest();
xhr.open('GET', src, true);
xhr.onreadystatechange = function () {
if (xhr.readyState !== 4) {
return;
}
if (xhr.status < 400 && xhr.responseText) {
code.textContent = xhr.responseText;
Prism.highlightElement(code);
return;
}
if (xhr.status === 404) {
code.textContent = '✖ Error: File could not be found';
return;
}
if (xhr.status >= 400) {
code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
return;
}
code.textContent = '✖ Error: An unknown error occurred';
};
xhr.send(null);
});
}
const modalButtons = document.querySelectorAll("[data-modal]");
const openedAsLocalFile = window.location.protocol === 'file:';
if (modalButtons.length > 0 && openedAsLocalFile) {
console.warn(
'Viewing the source code is unavailable because you are opening this page from the file:// scheme; ' +
'browsers block XHR requests when a page is opened this way'
);
}
modalButtons.forEach(function (trigger) {
if (openedAsLocalFile) {
trigger.setAttribute("hidden", "hidden");
}
trigger.addEventListener("click", function (event) {
event.preventDefault();
const modal = document.getElementById(trigger.dataset.modal);
if (!modal) {
console.error(`Modal with id "${trigger.dataset.modal}" could not be found`);
return;
}
modal.classList.add("phpdocumentor-modal__open");
loadExternalCodeSnippet(modal, trigger.dataset.src || null, trigger.dataset.line)
const exits = modal.querySelectorAll("[data-exit-button]");
exits.forEach(function (exit) {
exit.addEventListener("click", function (event) {
event.preventDefault();
modal.classList.remove("phpdocumentor-modal__open");
});
});
});
});
})();
</script>
</article>
</section>
<section class="phpdocumentor-on-this-page__sidebar">
<section class="phpdocumentor-on-this-page__content">
<strong class="phpdocumentor-on-this-page__title">On this page</strong>
<ul class="phpdocumentor-list -clean">
<li class="phpdocumentor-on-this-page-section__title">Table Of Contents</li>
<li>
<ul class="phpdocumentor-list -clean">
<li><a href="files/src-datastructures-strictspldatastructuretrait.html#toc-traits">Traits</a></li>
</ul>
</li>
</ul>
</section>
</section>
</div>
<section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
<section class="phpdocumentor-search-results__dialog">
<header class="phpdocumentor-search-results__header">
<h2 class="phpdocumentor-search-results__title">Search results</h2>
<button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
</header>
<section class="phpdocumentor-search-results__body">
<ul class="phpdocumentor-search-results__entries"></ul>
</section>
</section>
</section>
</div>
<a href="files/src-datastructures-strictspldatastructuretrait.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
</main>
<script>
cssVars({});
</script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
</body>
</html>

14
doc/files/src-datastructures-traits-strictspldatastructuretrait.html → doc/files/src-datastructures-traits-strictspldoublylinkedlisttrait.html
View File

@ -172,7 +172,7 @@
</ul> </ul>
<article class="phpdocumentor-element -file"> <article class="phpdocumentor-element -file">
<h2 class="phpdocumentor-content__title">StrictSplDatastructureTrait.php</h2> <h2 class="phpdocumentor-content__title">StrictSplDoublyLinkedListTrait.php</h2>
<p class="phpdocumentor-summary">PHP Basics</p> <p class="phpdocumentor-summary">PHP Basics</p>
@ -195,7 +195,7 @@ along with this program. If not, see <a href="http://www.gnu.org/licenses/">http
<h3 id="toc"> <h3 id="toc">
Table of Contents Table of Contents
<a href="files/src-datastructures-traits-strictspldatastructuretrait.html#toc" class="headerlink"><i class="fas fa-link"></i></a> <a href="files/src-datastructures-traits-strictspldoublylinkedlisttrait.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
</h3> </h3>
@ -205,11 +205,11 @@ along with this program. If not, see <a href="http://www.gnu.org/licenses/">http
<h4 id="toc-traits"> <h4 id="toc-traits">
Traits Traits
<a href="files/src-datastructures-traits-strictspldatastructuretrait.html#toc-traits" class="headerlink"><i class="fas fa-link"></i></a> <a href="files/src-datastructures-traits-strictspldoublylinkedlisttrait.html#toc-traits" class="headerlink"><i class="fas fa-link"></i></a>
</h4> </h4>
<dl class="phpdocumentor-table-of-contents"> <dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -trait"><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html"><abbr title="\OCC\Basics\DataStructures\Traits\StrictSplDatastructureTrait">StrictSplDatastructureTrait</abbr></a></dt><dd>The common interface of all type-sensitive, SPL-based datastructures.</dd> </dl> <dt class="phpdocumentor-table-of-contents__entry -trait"><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html"><abbr title="\OCC\Basics\DataStructures\Traits\StrictSplDoublyLinkedListTrait">StrictSplDoublyLinkedListTrait</abbr></a></dt><dd>The common interface of all type-sensitive, SPL-based datastructures.</dd> </dl>
@ -226,7 +226,7 @@ along with this program. If not, see <a href="http://www.gnu.org/licenses/">http
<div class="phpdocumentor-modal-bg" data-exit-button></div> <div class="phpdocumentor-modal-bg" data-exit-button></div>
<div class="phpdocumentor-modal-container"> <div class="phpdocumentor-modal-container">
<div class="phpdocumentor-modal-content"> <div class="phpdocumentor-modal-content">
<pre style="max-height: 500px; overflow-y: scroll" data-src="files/src/DataStructures/Traits/StrictSplDatastructureTrait.php.txt" class="language-php line-numbers linkable-line-numbers"></pre> <pre style="max-height: 500px; overflow-y: scroll" data-src="files/src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php.txt" class="language-php line-numbers linkable-line-numbers"></pre>
</div> </div>
<button data-exit-button class="phpdocumentor-modal__close">&times;</button> <button data-exit-button class="phpdocumentor-modal__close">&times;</button>
</div> </div>
@ -325,7 +325,7 @@ along with this program. If not, see <a href="http://www.gnu.org/licenses/">http
<li class="phpdocumentor-on-this-page-section__title">Table Of Contents</li> <li class="phpdocumentor-on-this-page-section__title">Table Of Contents</li>
<li> <li>
<ul class="phpdocumentor-list -clean"> <ul class="phpdocumentor-list -clean">
<li><a href="files/src-datastructures-traits-strictspldatastructuretrait.html#toc-traits">Traits</a></li> <li><a href="files/src-datastructures-traits-strictspldoublylinkedlisttrait.html#toc-traits">Traits</a></li>
</ul> </ul>
</li> </li>
@ -347,7 +347,7 @@ along with this program. If not, see <a href="http://www.gnu.org/licenses/">http
</section> </section>
</section> </section>
</div> </div>
<a href="files/src-datastructures-traits-strictspldatastructuretrait.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a> <a href="files/src-datastructures-traits-strictspldoublylinkedlisttrait.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
</main> </main>

336
doc/files/src-interfacetraits-arrayaccesstrait.html
View File

@ -1,336 +0,0 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>PHP Basics</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<base href="../">
<link rel="icon" href="images/favicon.ico"/>
<link rel="stylesheet" href="css/normalize.css">
<link rel="stylesheet" href="css/base.css">
<link rel="preconnect" href="https://fonts.gstatic.com">
<link href="https://fonts.googleapis.com/css2?family=Open+Sans:wght@100;200;300;400;600;700&display=swap" rel="stylesheet">
<link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet">
<link rel="stylesheet" href="css/template.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
<script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
<script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
<script src="js/template.js"></script>
<script src="js/search.js"></script>
<script defer src="js/searchIndex.js"></script>
</head>
<body id="top">
<header class="phpdocumentor-header phpdocumentor-section">
<h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">PHP Basics</a></h1>
<input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
<label class="phpdocumentor-header__menu-icon" for="menu-button">
<i class="fas fa-bars"></i>
</label>
<section data-search-form class="phpdocumentor-search">
<label>
<span class="visually-hidden">Search for</span>
<svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
<circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
<line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
</svg>
<input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
</label>
</section>
<nav class="phpdocumentor-topnav">
<ul class="phpdocumentor-topnav__menu">
<li class="phpdocumentor-topnav__menu-item -menu">
<a href="https://packagist.org/packages/opencultureconsulting/basics">
<span>
<i class="fab fa-php"></i>
</span>
</a>
</li>
<li class="phpdocumentor-topnav__menu-item -menu">
<a href="https://github.com/opencultureconsulting/php-basics">
<span>
<i class="fab fa-github"></i>
</span>
</a>
</li>
</ul>
</nav>
</header>
<main class="phpdocumentor">
<div class="phpdocumentor-section">
<input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
<label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
Menu
</label>
<aside class="phpdocumentor-column -three phpdocumentor-sidebar">
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Documentation</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="guides/installation/index.html#installation" class="">Installation</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="guides/installation/test.html#test" class="">Test</a>
</li>
</ul>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="guides/changelog/index.html#changelog" class="">Changelog</a>
</h4>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="namespaces/occ.html" class="">OCC</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="namespaces/occ-basics.html" class="">Basics</a>
</li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="packages/Basics.html" class="">Basics</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="packages/Basics-DataStructures.html" class="">DataStructures</a>
</li>
<li>
<a href="packages/Basics-ErrorHandlers.html" class="">ErrorHandlers</a>
</li>
<li>
<a href="packages/Basics-InterfaceTraits.html" class="">InterfaceTraits</a>
</li>
<li>
<a href="packages/Basics-Traits.html" class="">Traits</a>
</li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
</section>
</aside>
<div class="phpdocumentor-column -nine phpdocumentor-content">
<section>
<ul class="phpdocumentor-breadcrumbs">
</ul>
<article class="phpdocumentor-element -file">
<h2 class="phpdocumentor-content__title">ArrayAccessTrait.php</h2>
<p class="phpdocumentor-summary">PHP Basics</p>
<section class="phpdocumentor-description"><p>Copyright (C) 2024 Sebastian Meyer <a href="mailto:sebastian.meyer@opencultureconsulting.com">sebastian.meyer@opencultureconsulting.com</a></p>
<p>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.</p>
<p>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.</p>
<p>You should have received a copy of the GNU General Public License
along with this program. If not, see <a href="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</a>.</p>
</section>
<h3 id="toc">
Table of Contents
<a href="files/src-interfacetraits-arrayaccesstrait.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<h4 id="toc-traits">
Traits
<a href="files/src-interfacetraits-arrayaccesstrait.html#toc-traits" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -trait"><a href="classes/OCC-Basics-InterfaceTraits-ArrayAccessTrait.html"><abbr title="\OCC\Basics\InterfaceTraits\ArrayAccessTrait">ArrayAccessTrait</abbr></a></dt><dd>A generic implementation of the ArrayAccess interface.</dd> </dl>
<div class="phpdocumentor-modal" id="source-view">
<div class="phpdocumentor-modal-bg" data-exit-button></div>
<div class="phpdocumentor-modal-container">
<div class="phpdocumentor-modal-content">
<pre style="max-height: 500px; overflow-y: scroll" data-src="files/src/InterfaceTraits/ArrayAccessTrait.php.txt" class="language-php line-numbers linkable-line-numbers"></pre>
</div>
<button data-exit-button class="phpdocumentor-modal__close">&times;</button>
</div>
</div>
<script type="text/javascript">
(function () {
function loadExternalCodeSnippet(el, url, line) {
Array.prototype.slice.call(el.querySelectorAll('pre[data-src]')).forEach((pre) => {
const src = url || pre.getAttribute('data-src').replace(/\\/g, '/');
const language = 'php';
const code = document.createElement('code');
code.className = 'language-' + language;
pre.textContent = '';
pre.setAttribute('data-line', line)
code.textContent = 'Loading…';
pre.appendChild(code);
var xhr = new XMLHttpRequest();
xhr.open('GET', src, true);
xhr.onreadystatechange = function () {
if (xhr.readyState !== 4) {
return;
}
if (xhr.status < 400 && xhr.responseText) {
code.textContent = xhr.responseText;
Prism.highlightElement(code);
return;
}
if (xhr.status === 404) {
code.textContent = '✖ Error: File could not be found';
return;
}
if (xhr.status >= 400) {
code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
return;
}
code.textContent = '✖ Error: An unknown error occurred';
};
xhr.send(null);
});
}
const modalButtons = document.querySelectorAll("[data-modal]");
const openedAsLocalFile = window.location.protocol === 'file:';
if (modalButtons.length > 0 && openedAsLocalFile) {
console.warn(
'Viewing the source code is unavailable because you are opening this page from the file:// scheme; ' +
'browsers block XHR requests when a page is opened this way'
);
}
modalButtons.forEach(function (trigger) {
if (openedAsLocalFile) {
trigger.setAttribute("hidden", "hidden");
}
trigger.addEventListener("click", function (event) {
event.preventDefault();
const modal = document.getElementById(trigger.dataset.modal);
if (!modal) {
console.error(`Modal with id "${trigger.dataset.modal}" could not be found`);
return;
}
modal.classList.add("phpdocumentor-modal__open");
loadExternalCodeSnippet(modal, trigger.dataset.src || null, trigger.dataset.line)
const exits = modal.querySelectorAll("[data-exit-button]");
exits.forEach(function (exit) {
exit.addEventListener("click", function (event) {
event.preventDefault();
modal.classList.remove("phpdocumentor-modal__open");
});
});
});
});
})();
</script>
</article>
</section>
<section class="phpdocumentor-on-this-page__sidebar">
<section class="phpdocumentor-on-this-page__content">
<strong class="phpdocumentor-on-this-page__title">On this page</strong>
<ul class="phpdocumentor-list -clean">
<li class="phpdocumentor-on-this-page-section__title">Table Of Contents</li>
<li>
<ul class="phpdocumentor-list -clean">
<li><a href="files/src-interfacetraits-arrayaccesstrait.html#toc-traits">Traits</a></li>
</ul>
</li>
</ul>
</section>
</section>
</div>
<section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
<section class="phpdocumentor-search-results__dialog">
<header class="phpdocumentor-search-results__header">
<h2 class="phpdocumentor-search-results__title">Search results</h2>
<button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
</header>
<section class="phpdocumentor-search-results__body">
<ul class="phpdocumentor-search-results__entries"></ul>
</section>
</section>
</section>
</div>
<a href="files/src-interfacetraits-arrayaccesstrait.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
</main>
<script>
cssVars({});
</script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
</body>
</html>

336
doc/files/src-interfacetraits-countabletrait.html
View File

@ -1,336 +0,0 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>PHP Basics</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<base href="../">
<link rel="icon" href="images/favicon.ico"/>
<link rel="stylesheet" href="css/normalize.css">
<link rel="stylesheet" href="css/base.css">
<link rel="preconnect" href="https://fonts.gstatic.com">
<link href="https://fonts.googleapis.com/css2?family=Open+Sans:wght@100;200;300;400;600;700&display=swap" rel="stylesheet">
<link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet">
<link rel="stylesheet" href="css/template.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
<script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
<script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
<script src="js/template.js"></script>
<script src="js/search.js"></script>
<script defer src="js/searchIndex.js"></script>
</head>
<body id="top">
<header class="phpdocumentor-header phpdocumentor-section">
<h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">PHP Basics</a></h1>
<input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
<label class="phpdocumentor-header__menu-icon" for="menu-button">
<i class="fas fa-bars"></i>
</label>
<section data-search-form class="phpdocumentor-search">
<label>
<span class="visually-hidden">Search for</span>
<svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
<circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
<line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
</svg>
<input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
</label>
</section>
<nav class="phpdocumentor-topnav">
<ul class="phpdocumentor-topnav__menu">
<li class="phpdocumentor-topnav__menu-item -menu">
<a href="https://packagist.org/packages/opencultureconsulting/basics">
<span>
<i class="fab fa-php"></i>
</span>
</a>
</li>
<li class="phpdocumentor-topnav__menu-item -menu">
<a href="https://github.com/opencultureconsulting/php-basics">
<span>
<i class="fab fa-github"></i>
</span>
</a>
</li>
</ul>
</nav>
</header>
<main class="phpdocumentor">
<div class="phpdocumentor-section">
<input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
<label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
Menu
</label>
<aside class="phpdocumentor-column -three phpdocumentor-sidebar">
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Documentation</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="guides/installation/index.html#installation" class="">Installation</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="guides/installation/test.html#test" class="">Test</a>
</li>
</ul>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="guides/changelog/index.html#changelog" class="">Changelog</a>
</h4>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="namespaces/occ.html" class="">OCC</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="namespaces/occ-basics.html" class="">Basics</a>
</li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="packages/Basics.html" class="">Basics</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="packages/Basics-DataStructures.html" class="">DataStructures</a>
</li>
<li>
<a href="packages/Basics-ErrorHandlers.html" class="">ErrorHandlers</a>
</li>
<li>
<a href="packages/Basics-InterfaceTraits.html" class="">InterfaceTraits</a>
</li>
<li>
<a href="packages/Basics-Traits.html" class="">Traits</a>
</li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
</section>
</aside>
<div class="phpdocumentor-column -nine phpdocumentor-content">
<section>
<ul class="phpdocumentor-breadcrumbs">
</ul>
<article class="phpdocumentor-element -file">
<h2 class="phpdocumentor-content__title">CountableTrait.php</h2>
<p class="phpdocumentor-summary">PHP Basics</p>
<section class="phpdocumentor-description"><p>Copyright (C) 2024 Sebastian Meyer <a href="mailto:sebastian.meyer@opencultureconsulting.com">sebastian.meyer@opencultureconsulting.com</a></p>
<p>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.</p>
<p>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.</p>
<p>You should have received a copy of the GNU General Public License
along with this program. If not, see <a href="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</a>.</p>
</section>
<h3 id="toc">
Table of Contents
<a href="files/src-interfacetraits-countabletrait.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<h4 id="toc-traits">
Traits
<a href="files/src-interfacetraits-countabletrait.html#toc-traits" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -trait"><a href="classes/OCC-Basics-InterfaceTraits-CountableTrait.html"><abbr title="\OCC\Basics\InterfaceTraits\CountableTrait">CountableTrait</abbr></a></dt><dd>A generic implementation of the Countable interface.</dd> </dl>
<div class="phpdocumentor-modal" id="source-view">
<div class="phpdocumentor-modal-bg" data-exit-button></div>
<div class="phpdocumentor-modal-container">
<div class="phpdocumentor-modal-content">
<pre style="max-height: 500px; overflow-y: scroll" data-src="files/src/InterfaceTraits/CountableTrait.php.txt" class="language-php line-numbers linkable-line-numbers"></pre>
</div>
<button data-exit-button class="phpdocumentor-modal__close">&times;</button>
</div>
</div>
<script type="text/javascript">
(function () {
function loadExternalCodeSnippet(el, url, line) {
Array.prototype.slice.call(el.querySelectorAll('pre[data-src]')).forEach((pre) => {
const src = url || pre.getAttribute('data-src').replace(/\\/g, '/');
const language = 'php';
const code = document.createElement('code');
code.className = 'language-' + language;
pre.textContent = '';
pre.setAttribute('data-line', line)
code.textContent = 'Loading…';
pre.appendChild(code);
var xhr = new XMLHttpRequest();
xhr.open('GET', src, true);
xhr.onreadystatechange = function () {
if (xhr.readyState !== 4) {
return;
}
if (xhr.status < 400 && xhr.responseText) {
code.textContent = xhr.responseText;
Prism.highlightElement(code);
return;
}
if (xhr.status === 404) {
code.textContent = '✖ Error: File could not be found';
return;
}
if (xhr.status >= 400) {
code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
return;
}
code.textContent = '✖ Error: An unknown error occurred';
};
xhr.send(null);
});
}
const modalButtons = document.querySelectorAll("[data-modal]");
const openedAsLocalFile = window.location.protocol === 'file:';
if (modalButtons.length > 0 && openedAsLocalFile) {
console.warn(
'Viewing the source code is unavailable because you are opening this page from the file:// scheme; ' +
'browsers block XHR requests when a page is opened this way'
);
}
modalButtons.forEach(function (trigger) {
if (openedAsLocalFile) {
trigger.setAttribute("hidden", "hidden");
}
trigger.addEventListener("click", function (event) {
event.preventDefault();
const modal = document.getElementById(trigger.dataset.modal);
if (!modal) {
console.error(`Modal with id "${trigger.dataset.modal}" could not be found`);
return;
}
modal.classList.add("phpdocumentor-modal__open");
loadExternalCodeSnippet(modal, trigger.dataset.src || null, trigger.dataset.line)
const exits = modal.querySelectorAll("[data-exit-button]");
exits.forEach(function (exit) {
exit.addEventListener("click", function (event) {
event.preventDefault();
modal.classList.remove("phpdocumentor-modal__open");
});
});
});
});
})();
</script>
</article>
</section>
<section class="phpdocumentor-on-this-page__sidebar">
<section class="phpdocumentor-on-this-page__content">
<strong class="phpdocumentor-on-this-page__title">On this page</strong>
<ul class="phpdocumentor-list -clean">
<li class="phpdocumentor-on-this-page-section__title">Table Of Contents</li>
<li>
<ul class="phpdocumentor-list -clean">
<li><a href="files/src-interfacetraits-countabletrait.html#toc-traits">Traits</a></li>
</ul>
</li>
</ul>
</section>
</section>
</div>
<section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
<section class="phpdocumentor-search-results__dialog">
<header class="phpdocumentor-search-results__header">
<h2 class="phpdocumentor-search-results__title">Search results</h2>
<button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
</header>
<section class="phpdocumentor-search-results__body">
<ul class="phpdocumentor-search-results__entries"></ul>
</section>
</section>
</section>
</div>
<a href="files/src-interfacetraits-countabletrait.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
</main>
<script>
cssVars({});
</script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
</body>
</html>

336
doc/files/src-interfacetraits-iteratoraggregatetrait.html
View File

@ -1,336 +0,0 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>PHP Basics</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<base href="../">
<link rel="icon" href="images/favicon.ico"/>
<link rel="stylesheet" href="css/normalize.css">
<link rel="stylesheet" href="css/base.css">
<link rel="preconnect" href="https://fonts.gstatic.com">
<link href="https://fonts.googleapis.com/css2?family=Open+Sans:wght@100;200;300;400;600;700&display=swap" rel="stylesheet">
<link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet">
<link rel="stylesheet" href="css/template.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
<script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
<script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
<script src="js/template.js"></script>
<script src="js/search.js"></script>
<script defer src="js/searchIndex.js"></script>
</head>
<body id="top">
<header class="phpdocumentor-header phpdocumentor-section">
<h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">PHP Basics</a></h1>
<input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
<label class="phpdocumentor-header__menu-icon" for="menu-button">
<i class="fas fa-bars"></i>
</label>
<section data-search-form class="phpdocumentor-search">
<label>
<span class="visually-hidden">Search for</span>
<svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
<circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
<line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
</svg>
<input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
</label>
</section>
<nav class="phpdocumentor-topnav">
<ul class="phpdocumentor-topnav__menu">
<li class="phpdocumentor-topnav__menu-item -menu">
<a href="https://packagist.org/packages/opencultureconsulting/basics">
<span>
<i class="fab fa-php"></i>
</span>
</a>
</li>
<li class="phpdocumentor-topnav__menu-item -menu">
<a href="https://github.com/opencultureconsulting/php-basics">
<span>
<i class="fab fa-github"></i>
</span>
</a>
</li>
</ul>
</nav>
</header>
<main class="phpdocumentor">
<div class="phpdocumentor-section">
<input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
<label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
Menu
</label>
<aside class="phpdocumentor-column -three phpdocumentor-sidebar">
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Documentation</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="guides/installation/index.html#installation" class="">Installation</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="guides/installation/test.html#test" class="">Test</a>
</li>
</ul>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="guides/changelog/index.html#changelog" class="">Changelog</a>
</h4>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="namespaces/occ.html" class="">OCC</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="namespaces/occ-basics.html" class="">Basics</a>
</li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="packages/Basics.html" class="">Basics</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="packages/Basics-DataStructures.html" class="">DataStructures</a>
</li>
<li>
<a href="packages/Basics-ErrorHandlers.html" class="">ErrorHandlers</a>
</li>
<li>
<a href="packages/Basics-InterfaceTraits.html" class="">InterfaceTraits</a>
</li>
<li>
<a href="packages/Basics-Traits.html" class="">Traits</a>
</li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
</section>
</aside>
<div class="phpdocumentor-column -nine phpdocumentor-content">
<section>
<ul class="phpdocumentor-breadcrumbs">
</ul>
<article class="phpdocumentor-element -file">
<h2 class="phpdocumentor-content__title">IteratorAggregateTrait.php</h2>
<p class="phpdocumentor-summary">PHP Basics</p>
<section class="phpdocumentor-description"><p>Copyright (C) 2024 Sebastian Meyer <a href="mailto:sebastian.meyer@opencultureconsulting.com">sebastian.meyer@opencultureconsulting.com</a></p>
<p>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.</p>
<p>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.</p>
<p>You should have received a copy of the GNU General Public License
along with this program. If not, see <a href="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</a>.</p>
</section>
<h3 id="toc">
Table of Contents
<a href="files/src-interfacetraits-iteratoraggregatetrait.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<h4 id="toc-traits">
Traits
<a href="files/src-interfacetraits-iteratoraggregatetrait.html#toc-traits" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -trait"><a href="classes/OCC-Basics-InterfaceTraits-IteratorAggregateTrait.html"><abbr title="\OCC\Basics\InterfaceTraits\IteratorAggregateTrait">IteratorAggregateTrait</abbr></a></dt><dd>A generic implementation of the IteratorAggregate interface.</dd> </dl>
<div class="phpdocumentor-modal" id="source-view">
<div class="phpdocumentor-modal-bg" data-exit-button></div>
<div class="phpdocumentor-modal-container">
<div class="phpdocumentor-modal-content">
<pre style="max-height: 500px; overflow-y: scroll" data-src="files/src/InterfaceTraits/IteratorAggregateTrait.php.txt" class="language-php line-numbers linkable-line-numbers"></pre>
</div>
<button data-exit-button class="phpdocumentor-modal__close">&times;</button>
</div>
</div>
<script type="text/javascript">
(function () {
function loadExternalCodeSnippet(el, url, line) {
Array.prototype.slice.call(el.querySelectorAll('pre[data-src]')).forEach((pre) => {
const src = url || pre.getAttribute('data-src').replace(/\\/g, '/');
const language = 'php';
const code = document.createElement('code');
code.className = 'language-' + language;
pre.textContent = '';
pre.setAttribute('data-line', line)
code.textContent = 'Loading…';
pre.appendChild(code);
var xhr = new XMLHttpRequest();
xhr.open('GET', src, true);
xhr.onreadystatechange = function () {
if (xhr.readyState !== 4) {
return;
}
if (xhr.status < 400 && xhr.responseText) {
code.textContent = xhr.responseText;
Prism.highlightElement(code);
return;
}
if (xhr.status === 404) {
code.textContent = '✖ Error: File could not be found';
return;
}
if (xhr.status >= 400) {
code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
return;
}
code.textContent = '✖ Error: An unknown error occurred';
};
xhr.send(null);
});
}
const modalButtons = document.querySelectorAll("[data-modal]");
const openedAsLocalFile = window.location.protocol === 'file:';
if (modalButtons.length > 0 && openedAsLocalFile) {
console.warn(
'Viewing the source code is unavailable because you are opening this page from the file:// scheme; ' +
'browsers block XHR requests when a page is opened this way'
);
}
modalButtons.forEach(function (trigger) {
if (openedAsLocalFile) {
trigger.setAttribute("hidden", "hidden");
}
trigger.addEventListener("click", function (event) {
event.preventDefault();
const modal = document.getElementById(trigger.dataset.modal);
if (!modal) {
console.error(`Modal with id "${trigger.dataset.modal}" could not be found`);
return;
}
modal.classList.add("phpdocumentor-modal__open");
loadExternalCodeSnippet(modal, trigger.dataset.src || null, trigger.dataset.line)
const exits = modal.querySelectorAll("[data-exit-button]");
exits.forEach(function (exit) {
exit.addEventListener("click", function (event) {
event.preventDefault();
modal.classList.remove("phpdocumentor-modal__open");
});
});
});
});
})();
</script>
</article>
</section>
<section class="phpdocumentor-on-this-page__sidebar">
<section class="phpdocumentor-on-this-page__content">
<strong class="phpdocumentor-on-this-page__title">On this page</strong>
<ul class="phpdocumentor-list -clean">
<li class="phpdocumentor-on-this-page-section__title">Table Of Contents</li>
<li>
<ul class="phpdocumentor-list -clean">
<li><a href="files/src-interfacetraits-iteratoraggregatetrait.html#toc-traits">Traits</a></li>
</ul>
</li>
</ul>
</section>
</section>
</div>
<section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
<section class="phpdocumentor-search-results__dialog">
<header class="phpdocumentor-search-results__header">
<h2 class="phpdocumentor-search-results__title">Search results</h2>
<button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
</header>
<section class="phpdocumentor-search-results__body">
<ul class="phpdocumentor-search-results__entries"></ul>
</section>
</section>
</section>
</div>
<a href="files/src-interfacetraits-iteratoraggregatetrait.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
</main>
<script>
cssVars({});
</script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
</body>
</html>

336
doc/files/src-interfacetraits-iteratortrait.html
View File

@ -1,336 +0,0 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>PHP Basics</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<base href="../">
<link rel="icon" href="images/favicon.ico"/>
<link rel="stylesheet" href="css/normalize.css">
<link rel="stylesheet" href="css/base.css">
<link rel="preconnect" href="https://fonts.gstatic.com">
<link href="https://fonts.googleapis.com/css2?family=Open+Sans:wght@100;200;300;400;600;700&display=swap" rel="stylesheet">
<link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet">
<link rel="stylesheet" href="css/template.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
<script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
<script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
<script src="js/template.js"></script>
<script src="js/search.js"></script>
<script defer src="js/searchIndex.js"></script>
</head>
<body id="top">
<header class="phpdocumentor-header phpdocumentor-section">
<h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">PHP Basics</a></h1>
<input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
<label class="phpdocumentor-header__menu-icon" for="menu-button">
<i class="fas fa-bars"></i>
</label>
<section data-search-form class="phpdocumentor-search">
<label>
<span class="visually-hidden">Search for</span>
<svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
<circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
<line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
</svg>
<input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
</label>
</section>
<nav class="phpdocumentor-topnav">
<ul class="phpdocumentor-topnav__menu">
<li class="phpdocumentor-topnav__menu-item -menu">
<a href="https://packagist.org/packages/opencultureconsulting/basics">
<span>
<i class="fab fa-php"></i>
</span>
</a>
</li>
<li class="phpdocumentor-topnav__menu-item -menu">
<a href="https://github.com/opencultureconsulting/php-basics">
<span>
<i class="fab fa-github"></i>
</span>
</a>
</li>
</ul>
</nav>
</header>
<main class="phpdocumentor">
<div class="phpdocumentor-section">
<input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
<label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
Menu
</label>
<aside class="phpdocumentor-column -three phpdocumentor-sidebar">
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Documentation</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="guides/installation/index.html#installation" class="">Installation</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="guides/installation/test.html#test" class="">Test</a>
</li>
</ul>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="guides/changelog/index.html#changelog" class="">Changelog</a>
</h4>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="namespaces/occ.html" class="">OCC</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="namespaces/occ-basics.html" class="">Basics</a>
</li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="packages/Basics.html" class="">Basics</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="packages/Basics-DataStructures.html" class="">DataStructures</a>
</li>
<li>
<a href="packages/Basics-ErrorHandlers.html" class="">ErrorHandlers</a>
</li>
<li>
<a href="packages/Basics-InterfaceTraits.html" class="">InterfaceTraits</a>
</li>
<li>
<a href="packages/Basics-Traits.html" class="">Traits</a>
</li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
</section>
</aside>
<div class="phpdocumentor-column -nine phpdocumentor-content">
<section>
<ul class="phpdocumentor-breadcrumbs">
</ul>
<article class="phpdocumentor-element -file">
<h2 class="phpdocumentor-content__title">IteratorTrait.php</h2>
<p class="phpdocumentor-summary">PHP Basics</p>
<section class="phpdocumentor-description"><p>Copyright (C) 2024 Sebastian Meyer <a href="mailto:sebastian.meyer@opencultureconsulting.com">sebastian.meyer@opencultureconsulting.com</a></p>
<p>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.</p>
<p>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.</p>
<p>You should have received a copy of the GNU General Public License
along with this program. If not, see <a href="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</a>.</p>
</section>
<h3 id="toc">
Table of Contents
<a href="files/src-interfacetraits-iteratortrait.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<h4 id="toc-traits">
Traits
<a href="files/src-interfacetraits-iteratortrait.html#toc-traits" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -trait"><a href="classes/OCC-Basics-InterfaceTraits-IteratorTrait.html"><abbr title="\OCC\Basics\InterfaceTraits\IteratorTrait">IteratorTrait</abbr></a></dt><dd>A generic implementation of the Iterator interface.</dd> </dl>
<div class="phpdocumentor-modal" id="source-view">
<div class="phpdocumentor-modal-bg" data-exit-button></div>
<div class="phpdocumentor-modal-container">
<div class="phpdocumentor-modal-content">
<pre style="max-height: 500px; overflow-y: scroll" data-src="files/src/InterfaceTraits/IteratorTrait.php.txt" class="language-php line-numbers linkable-line-numbers"></pre>
</div>
<button data-exit-button class="phpdocumentor-modal__close">&times;</button>
</div>
</div>
<script type="text/javascript">
(function () {
function loadExternalCodeSnippet(el, url, line) {
Array.prototype.slice.call(el.querySelectorAll('pre[data-src]')).forEach((pre) => {
const src = url || pre.getAttribute('data-src').replace(/\\/g, '/');
const language = 'php';
const code = document.createElement('code');
code.className = 'language-' + language;
pre.textContent = '';
pre.setAttribute('data-line', line)
code.textContent = 'Loading…';
pre.appendChild(code);
var xhr = new XMLHttpRequest();
xhr.open('GET', src, true);
xhr.onreadystatechange = function () {
if (xhr.readyState !== 4) {
return;
}
if (xhr.status < 400 && xhr.responseText) {
code.textContent = xhr.responseText;
Prism.highlightElement(code);
return;
}
if (xhr.status === 404) {
code.textContent = '✖ Error: File could not be found';
return;
}
if (xhr.status >= 400) {
code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
return;
}
code.textContent = '✖ Error: An unknown error occurred';
};
xhr.send(null);
});
}
const modalButtons = document.querySelectorAll("[data-modal]");
const openedAsLocalFile = window.location.protocol === 'file:';
if (modalButtons.length > 0 && openedAsLocalFile) {
console.warn(
'Viewing the source code is unavailable because you are opening this page from the file:// scheme; ' +
'browsers block XHR requests when a page is opened this way'
);
}
modalButtons.forEach(function (trigger) {
if (openedAsLocalFile) {
trigger.setAttribute("hidden", "hidden");
}
trigger.addEventListener("click", function (event) {
event.preventDefault();
const modal = document.getElementById(trigger.dataset.modal);
if (!modal) {
console.error(`Modal with id "${trigger.dataset.modal}" could not be found`);
return;
}
modal.classList.add("phpdocumentor-modal__open");
loadExternalCodeSnippet(modal, trigger.dataset.src || null, trigger.dataset.line)
const exits = modal.querySelectorAll("[data-exit-button]");
exits.forEach(function (exit) {
exit.addEventListener("click", function (event) {
event.preventDefault();
modal.classList.remove("phpdocumentor-modal__open");
});
});
});
});
})();
</script>
</article>
</section>
<section class="phpdocumentor-on-this-page__sidebar">
<section class="phpdocumentor-on-this-page__content">
<strong class="phpdocumentor-on-this-page__title">On this page</strong>
<ul class="phpdocumentor-list -clean">
<li class="phpdocumentor-on-this-page-section__title">Table Of Contents</li>
<li>
<ul class="phpdocumentor-list -clean">
<li><a href="files/src-interfacetraits-iteratortrait.html#toc-traits">Traits</a></li>
</ul>
</li>
</ul>
</section>
</section>
</div>
<section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
<section class="phpdocumentor-search-results__dialog">
<header class="phpdocumentor-search-results__header">
<h2 class="phpdocumentor-search-results__title">Search results</h2>
<button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
</header>
<section class="phpdocumentor-search-results__body">
<ul class="phpdocumentor-search-results__entries"></ul>
</section>
</section>
</section>
</div>
<a href="files/src-interfacetraits-iteratortrait.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
</main>
<script>
cssVars({});
</script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
</body>
</html>

195
doc/files/src/DataStructures/Collection.php.txt
View File

@ -1,195 +0,0 @@
<?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/>.
*/
declare(strict_types=1);
namespace OCC\Basics\DataStructures;
use ArrayAccess;
use Countable;
use IteratorAggregate;
use OCC\Basics\InterfaceTraits\ArrayAccessTrait;
use OCC\Basics\InterfaceTraits\CountableTrait;
use OCC\Basics\InterfaceTraits\IteratorAggregateTrait;
/**
* A generic collection of items.
*
* @author Sebastian Meyer <sebastian.meyer@opencultureconsulting.com>
* @package Basics\DataStructures
*
* @api
*
* @template Item of mixed
* @implements ArrayAccess<array-key, Item>
* @implements IteratorAggregate<Item>
*/
class Collection implements ArrayAccess, Countable, IteratorAggregate
{
/** @use ArrayAccessTrait<Item> */
use ArrayAccessTrait;
/** @use CountableTrait<Item> */
use CountableTrait;
/** @use IteratorAggregateTrait<Item> */
use IteratorAggregateTrait;
/**
* Add an item to the collection.
*
* @param Item $item The new item
*
* @return void
*
* @api
*/
public function add(mixed $item): void
{
$this->data[] = $item;
}
/**
* Clear the collection of any items.
*
* @return void
*
* @api
*/
public function clear(): void
{
$this->data = [];
}
/**
* Get a new collection with the same set of items.
*
* @return Collection<Item> The new collection with the same items
*
* @api
*/
public function copy(): Collection
{
return new Collection($this->data);
}
/**
* Get the item at the specified index.
*
* @param array-key $key The item's index
*
* @return ?Item The item or NULL if key is invalid
*
* @api
*/
public function get(int|string $key): mixed
{
return $this->data[$key] ?? null;
}
/**
* Check if collection is empty.
*
* @return bool Whether the collection contains any items
*
* @api
*/
public function isEmpty(): bool
{
return $this->count() === 0;
}
/**
* Remove an item from the collection.
*
* @param array-key $key The item's key
*
* @return void
*
* @api
*/
public function remove(int|string $key): void
{
unset($this->data[$key]);
}
/**
* Set the item at the specified index.
*
* @param array-key $key The new item's index
* @param Item $item The new item
*
* @return void
*
* @api
*/
public function set(int|string $key, mixed $item): void
{
$this->data[$key] = $item;
}
/**
* Return array representation of collection.
*
* @return array<Item> Array of collection items
*
* @api
*/
public function toArray(): array
{
return $this->data;
}
/**
* Create a collection of items.
*
* @param array<Item> $items Initial set of items
*
* @return void
*/
public function __construct(array $items = [])
{
$this->data = $items;
}
/**
* Magic method to read collection items as properties.
*
* @param array-key $key The item's index
*
* @return ?Item The item or NULL if key is invalid
*/
public function __get(int|string $key): mixed
{
return $this->get($key);
}
/**
* Magic method to write collection items as properties.
*
* @param array-key $key The new item's index
* @param Item $item The new item
*
* @return void
*/
public function __set(int|string $key, mixed $item): void
{
$this->set($key, $item);
}
}

128
doc/files/src/DataStructures/StrictArray.php.txt
View File

@ -24,7 +24,9 @@ declare(strict_types=1);
namespace OCC\Basics\DataStructures; namespace OCC\Basics\DataStructures;
use Iterator; use Iterator;
use OCC\Basics\DataStructures\Exceptions\InvalidDataTypeException;
use OCC\Basics\Interfaces\IteratorTrait; use OCC\Basics\Interfaces\IteratorTrait;
use RuntimeException;
/** /**
* A type-sensitive, traversable array. * A type-sensitive, traversable array.
@ -49,4 +51,130 @@ class StrictArray extends StrictCollection implements Iterator
{ {
/** @use IteratorTrait<AllowedType> */ /** @use IteratorTrait<AllowedType> */
use IteratorTrait; use IteratorTrait;
/**
* Peek at the first item of the array.
*
* @return AllowedType The first item of the array
*
* @throws RuntimeException if the array is empty
*
* @api
*/
public function bottom(): mixed
{
$key = array_key_first($this->_data);
if (is_null($key)) {
throw new RuntimeException(
'Cannot return bottom item: array is empty.'
);
}
return $this->_data[$key];
}
/**
* Pop the item from the end of the array.
*
* @return AllowedType The last item of the array
*
* @throws RuntimeException if the array is empty
*
* @api
*/
public function pop(): mixed
{
if ($this->count() === 0) {
throw new RuntimeException(
'Cannot return last item: array is empty.'
);
}
return array_pop($this->_data);
}
/**
* Push an item at the end of the array.
*
* @param AllowedType $value The item to push
*
* @return void
*
* @throws InvalidDataTypeException if `$value` is not of allowed type
*
* @api
*/
public function push(mixed $value): void
{
if (!$this->hasAllowedType($value)) {
throw new InvalidDataTypeException(
sprintf(
'Parameter 1 must be an allowed type, %s given.',
get_debug_type($value)
)
);
}
array_push($this->_data, $value);
}
/**
* Shift the item from the beginning of the array.
*
* @return AllowedType The first item of the array
*
* @throws RuntimeException if the array is empty
*
* @api
*/
public function shift(): mixed
{
if ($this->count() === 0) {
throw new RuntimeException(
'Cannot return first item: array is empty.'
);
}
return array_shift($this->_data);
}
/**
* Peek at the last item of the array.
*
* @return AllowedType The last item of the array
*
* @throws RuntimeException if the array is empty
*
* @api
*/
public function top(): mixed
{
$key = array_key_last($this->_data);
if (is_null($key)) {
throw new RuntimeException(
'Cannot return top item: array is empty.'
);
}
return $this->_data[$key];
}
/**
* Prepend the array with an item.
*
* @param AllowedType $value The item to unshift
*
* @return void
*
* @throws InvalidDataTypeException if `$value` is not of allowed type
*
* @api
*/
public function unshift(mixed $value): void
{
if (!$this->hasAllowedType($value)) {
throw new InvalidDataTypeException(
sprintf(
'Parameter 1 must be an allowed type, %s given.',
get_debug_type($value)
)
);
}
array_unshift($this->_data, $value);
}
} }

6
doc/files/src/DataStructures/StrictList.php.txt
View File

@ -23,7 +23,7 @@ declare(strict_types=1);
namespace OCC\Basics\DataStructures; namespace OCC\Basics\DataStructures;
use OCC\Basics\DataStructures\Traits\StrictSplDatastructureTrait; use OCC\Basics\DataStructures\Traits\StrictSplDoublyLinkedListTrait;
use SplDoublyLinkedList; use SplDoublyLinkedList;
/** /**
@ -43,6 +43,6 @@ use SplDoublyLinkedList;
*/ */
class StrictList extends SplDoublyLinkedList class StrictList extends SplDoublyLinkedList
{ {
/** @use StrictSplDatastructureTrait<AllowedType> */ /** @use StrictSplDoublyLinkedListTrait<AllowedType> */
use StrictSplDatastructureTrait; use StrictSplDoublyLinkedListTrait;
} }

21
doc/files/src/DataStructures/StrictQueue.php.txt
View File

@ -24,7 +24,8 @@ declare(strict_types=1);
namespace OCC\Basics\DataStructures; namespace OCC\Basics\DataStructures;
use OCC\Basics\DataStructures\Exceptions\InvalidDataTypeException; use OCC\Basics\DataStructures\Exceptions\InvalidDataTypeException;
use OCC\Basics\DataStructures\Traits\StrictSplDatastructureTrait; use OCC\Basics\DataStructures\Traits\StrictSplDoublyLinkedListTrait;
use RuntimeException;
use SplQueue; use SplQueue;
/** /**
@ -44,8 +45,22 @@ use SplQueue;
*/ */
class StrictQueue extends SplQueue class StrictQueue extends SplQueue
{ {
/** @use StrictSplDatastructureTrait<AllowedType> */ /** @use StrictSplDoublyLinkedListTrait<AllowedType> */
use StrictSplDatastructureTrait; use StrictSplDoublyLinkedListTrait;
/**
* Dequeue an item from the queue.
*
* @return AllowedType The dequeued item
*
* @throws RuntimeException if the queue is empty
*
* @api
*/
public function dequeue(): mixed
{
return $this->shift();
}
/** /**
* Add an item to the queue. * Add an item to the queue.

420
doc/files/src/DataStructures/StrictSplDatastructureTrait.php.txt
View File

@ -1,420 +0,0 @@
<?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/>.
*/
declare(strict_types=1);
namespace OCC\Basics\DataStructures;
use InvalidArgumentException;
use OCC\Basics\Traits\TypeChecker;
use OutOfRangeException;
use function get_debug_type;
use function iterator_to_array;
use function serialize;
use function sprintf;
use function unserialize;
/**
* The common interface of all type-sensitive, SPL-based datastructures.
*
* This extends all methods of the common interface of the Standard PHP Library
* [Doubly Linked List Datastructures](https://www.php.net/spl.datastructures)
* by type-checking to only allow specified data types on the list.
*
* @author Sebastian Meyer <sebastian.meyer@opencultureconsulting.com>
* @package Basics\DataStructures
*
* @template AllowedType of mixed
*/
trait StrictSplDatastructureTrait
{
use TypeChecker {
setAllowedTypes as protected;
}
/**
* Add/insert a new item at the specified offset.
*
* @param int $offset The offset where the new item is to be inserted
* @param AllowedType $value The new item for the offset
*
* @return void
*
* @throws InvalidArgumentException if `$value` is not of allowed type
* @throws OutOfRangeException when `$offset` is out of bounds
*
* @api
*/
public function add(int $offset, mixed $value): void
{
$this->offsetSet($offset, $value);
}
/**
* Append items at the end of the list.
*
* @param AllowedType ...$values One or more items to append
*
* @return void
*
* @throws InvalidArgumentException if any `$values` is not of allowed type
*
* @api
*/
public function append(mixed ...$values): void
{
/** @var array<int, AllowedType> $values */
foreach ($values as $count => $value) {
if (!$this->hasAllowedType($value)) {
throw new InvalidArgumentException(
sprintf(
'Parameter %d must be an allowed type, %s given.',
$count + 1,
get_debug_type($value)
)
);
}
}
foreach ($values as $value) {
parent::push($value);
}
}
/**
* Clear the list of any items.
*
* @return void
*
* @api
*/
public function clear(): void
{
while (!$this->isEmpty()) {
$this->pop();
}
$this->rewind();
}
/**
* Get the item at the specified index.
*
* @param int $offset The item's index
*
* @return AllowedType The item
*
* @throws OutOfRangeException when `$offset` is out of bounds
*
* @api
*/
public function get(int $offset): mixed
{
return $this->offsetGet($offset);
}
/**
* Check if this can be considered a list.
*
* @return true Always TRUE (this exists only for compatibility reasons)
*
* @api
*/
public function isList(): bool
{
return true;
}
/**
* Set the item at the specified offset.
*
* @param ?int $offset The offset being set or NULL to append
* @param AllowedType $value The new item for the offset
*
* @return void
*
* @throws InvalidArgumentException if `$value` is not of allowed type
* @throws OutOfRangeException when `$offset` is out of bounds
*
* @api
*/
public function offsetSet(mixed $offset, mixed $value): void
{
if (!$this->hasAllowedType($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);
}
/**
* Prepend items at the start of the list.
*
* @param AllowedType ...$values One or more items to prepend
*
* @return void
*
* @throws InvalidArgumentException if `$value` is not of allowed type
*
* @api
*/
public function prepend(mixed ...$values): void
{
/** @var array<int, AllowedType> $values */
foreach ($values as $count => $value) {
if (!$this->hasAllowedType($value)) {
throw new InvalidArgumentException(
sprintf(
'Parameter %d must be an allowed type, %s given.',
$count + 1,
get_debug_type($value)
)
);
}
}
foreach ($values as $value) {
parent::unshift($value);
}
}
/**
* Push an item at the end of the list.
*
* @param AllowedType $value The item to push
*
* @return void
*
* @throws InvalidArgumentException if `$value` is not of allowed type
*
* @api
*/
public function push(mixed $value): void
{
if (!$this->hasAllowedType($value)) {
throw new InvalidArgumentException(
sprintf(
'Parameter 1 must be an allowed type, %s given.',
get_debug_type($value)
)
);
}
parent::push($value);
}
/**
* Remove an item from the list.
*
* @param int $offset The item's index
*
* @return void
*
* @throws OutOfRangeException when `$offset` is out of bounds
*
* @api
*/
public function remove(int $offset): void
{
$this->offsetUnset($offset);
}
/**
* Get string representation of $this.
*
* @return string The string representation
*
* @internal
*/
public function serialize(): string
{
return serialize($this->__serialize());
}
/**
* Set an item at the specified index.
*
* @param int $offset The item's index
* @param AllowedType $value The item
*
* @return void
*
* @throws InvalidArgumentException if `$value` is not of allowed type
*
* @api
*/
public function set(int $offset, mixed $value): void
{
$this->offsetSet($offset, $value);
}
/**
* Return array representation of list.
*
* @return array<int, AllowedType> Array of list items
*
* @api
*/
public function toArray(): array
{
return iterator_to_array($this, true);
}
/**
* Turn list into a type-sensitive collection.
*
* @return StrictCollection<AllowedType> A type-sensitive collection of the list's items
*
* @api
*/
public function toStrictCollection(): StrictCollection
{
$strictCollection = new StrictCollection($this->getAllowedTypes());
foreach ($this->toArray() as $offset => $value) {
$strictCollection[$offset] = $value;
}
return $strictCollection;
}
/**
* 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 item.
*
* @param AllowedType $value The item to unshift
*
* @return void
*
* @throws InvalidArgumentException if `$value` is not of allowed type
*
* @api
*/
public function unshift(mixed $value): void
{
if (!$this->hasAllowedType($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 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 if any value of `$allowedTypes` is not a string
*/
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 [
'StrictSplDatastructure::allowedTypes' => $this->getAllowedTypes(),
'StrictSplDatastructure::dllist' => $this->toArray(),
'StrictSplDatastructure::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['StrictSplDatastructure::allowedTypes'];
$this->setAllowedTypes($allowedTypes);
/** @var array<int, AllowedType> $values */
$values = $data['StrictSplDatastructure::dllist'];
$this->append(...$values);
/** @var int $flags */
$flags = $data['StrictSplDatastructure::flags'];
$this->setIteratorMode($flags);
}
}

8
doc/files/src/DataStructures/StrictStack.php.txt
View File

@ -24,7 +24,7 @@ declare(strict_types=1);
namespace OCC\Basics\DataStructures; namespace OCC\Basics\DataStructures;
use OCC\Basics\DataStructures\Exceptions\InvalidDataTypeException; use OCC\Basics\DataStructures\Exceptions\InvalidDataTypeException;
use OCC\Basics\DataStructures\Traits\StrictSplDatastructureTrait; use OCC\Basics\DataStructures\Traits\StrictSplDoublyLinkedListTrait;
use RuntimeException; use RuntimeException;
use SplStack; use SplStack;
@ -45,8 +45,8 @@ use SplStack;
*/ */
class StrictStack extends SplStack class StrictStack extends SplStack
{ {
/** @use StrictSplDatastructureTrait<AllowedType> */ /** @use StrictSplDoublyLinkedListTrait<AllowedType> */
use StrictSplDatastructureTrait; use StrictSplDoublyLinkedListTrait;
/** /**
* Add an item to the stack. * Add an item to the stack.
@ -69,7 +69,7 @@ class StrictStack extends SplStack
* *
* @return AllowedType The unstacked item * @return AllowedType The unstacked item
* *
* @throws RuntimeException if the list is empty * @throws RuntimeException if the stack is empty
* *
* @api * @api
*/ */

2
doc/files/src/DataStructures/Traits/StrictSplDatastructureTrait.php.txt → doc/files/src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php.txt
View File

@ -49,7 +49,7 @@ use function unserialize;
* @template AllowedType of mixed * @template AllowedType of mixed
* @phpstan-require-extends SplDoublyLinkedList * @phpstan-require-extends SplDoublyLinkedList
*/ */
trait StrictSplDatastructureTrait trait StrictSplDoublyLinkedListTrait
{ {
use TypeChecker { use TypeChecker {
setAllowedTypes as protected; setAllowedTypes as protected;

8
doc/files/src/ErrorHandlers/ThrowErrorException.php.txt
View File

@ -52,8 +52,12 @@ class ThrowErrorException
* *
* @throws ErrorException if `error_reporting` is set to report the error * @throws ErrorException if `error_reporting` is set to report the error
*/ */
public function __invoke(int $errno = E_USER_ERROR, string $errstr = '', ?string $errfile = null, ?int $errline = null): bool public function __invoke(
{ int $errno = \E_USER_ERROR,
string $errstr = '',
?string $errfile = null,
?int $errline = null
): bool {
if ((error_reporting() & $errno) > 0) { if ((error_reporting() & $errno) > 0) {
throw new ErrorException($errstr, 0, $errno, $errfile, $errline); throw new ErrorException($errstr, 0, $errno, $errfile, $errline);
} }

2
doc/files/src/ErrorHandlers/TriggerExceptionError.php.txt
View File

@ -57,6 +57,6 @@ class TriggerExceptionError
$exception->getLine(), $exception->getLine(),
$exception->getMessage() $exception->getMessage()
); );
trigger_error($message, E_USER_ERROR); trigger_error($message, \E_USER_ERROR);
} }
} }

113
doc/files/src/InterfaceTraits/ArrayAccessTrait.php.txt
View File

@ -1,113 +0,0 @@
<?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/>.
*/
declare(strict_types=1);
namespace OCC\Basics\InterfaceTraits;
use ArrayAccess;
/**
* A generic implementation of the ArrayAccess interface.
*
* Internally it accesses the protected `$_data` array.
*
* @author Sebastian Meyer <sebastian.meyer@opencultureconsulting.com>
* @package Basics\InterfaceTraits
*
* @api
*
* @template TValue of mixed
* @implements ArrayAccess<array-key, TValue>
* @phpstan-require-implements ArrayAccess
*/
trait ArrayAccessTrait
{
/**
* Holds the array-accessible data.
*
* @var TValue[]
*
* @internal
*/
protected array $_data = [];
/**
* Check if the specified offset exists.
*
* @param array-key $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 array-key $offset The offset to retrieve
*
* @return ?TValue The value at the offset or NULL if invalid
*
* @api
*/
public function offsetGet(mixed $offset): mixed
{
return $this->_data[$offset] ?? null;
}
/**
* Assign a value to the specified offset.
*
* @param ?array-key $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 array-key $offset The offset to unset
*
* @return void
*
* @api
*/
public function offsetUnset(mixed $offset): void
{
unset($this->_data[$offset]);
}
}

64
doc/files/src/InterfaceTraits/CountableTrait.php.txt
View File

@ -1,64 +0,0 @@
<?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/>.
*/
declare(strict_types=1);
namespace OCC\Basics\InterfaceTraits;
use Countable;
/**
* A generic implementation of the Countable interface.
*
* Internally it counts the values of the protected `$_data` array.
*
* @author Sebastian Meyer <sebastian.meyer@opencultureconsulting.com>
* @package Basics\InterfaceTraits
*
* @api
*
* @template TValue of mixed
* @implements Countable<TValue>
* @phpstan-require-implements Countable
*/
trait CountableTrait
{
/**
* Holds the countable data.
*
* @var TValue[]
*
* @internal
*/
protected array $_data = [];
/**
* Count the data items.
*
* @return int<0, max> The number of data items
*
* @api
*/
public function count(): int
{
return count($this->_data);
}
}

65
doc/files/src/InterfaceTraits/IteratorAggregateTrait.php.txt
View File

@ -1,65 +0,0 @@
<?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/>.
*/
declare(strict_types=1);
namespace OCC\Basics\InterfaceTraits;
use ArrayIterator;
use IteratorAggregate;
/**
* A generic implementation of the IteratorAggregate interface.
*
* Internally it iterates over the protected `$_data` array.
*
* @author Sebastian Meyer <sebastian.meyer@opencultureconsulting.com>
* @package Basics\InterfaceTraits
*
* @api
*
* @template TValue of mixed
* @implements IteratorAggregate<TValue>
* @phpstan-require-implements IteratorAggregate
*/
trait IteratorAggregateTrait
{
/**
* Holds the iterable data.
*
* @var TValue[]
*
* @internal
*/
protected array $_data = [];
/**
* Retrieve an external iterator.
*
* @return ArrayIterator<array-key, TValue> New iterator for the data array
*
* @api
*/
public function getIterator(): ArrayIterator
{
return new ArrayIterator($this->_data);
}
}

128
doc/files/src/InterfaceTraits/IteratorTrait.php.txt
View File

@ -1,128 +0,0 @@
<?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/>.
*/
declare(strict_types=1);
namespace OCC\Basics\InterfaceTraits;
use Iterator;
/**
* A generic implementation of the Iterator interface.
*
* Internally it iterates over the protected `$_data` array.
*
* @author Sebastian Meyer <sebastian.meyer@opencultureconsulting.com>
* @package Basics\InterfaceTraits
*
* @api
*
* @template TValue of mixed
* @implements Iterator<TValue>
* @phpstan-require-implements Iterator
*/
trait IteratorTrait
{
/**
* Holds the iterable data.
*
* @var TValue[]
*
* @internal
*/
protected array $_data = [];
/**
* Return the current item.
*
* @return ?TValue The current item or NULL if invalid
*
* @api
*/
public function current(): mixed
{
if ($this->valid()) {
/** @var TValue */
return current($this->_data);
}
return null;
}
/**
* Return the current key.
*
* @return ?array-key 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());
}
}

29
doc/guides/changelog.html
View File

@ -173,10 +173,35 @@
<div class="admonition-wrapper"> <div class="admonition-wrapper">
<div class="admonition admonition-sidebar"><p class="sidebar-title">Table of Contents</p> <div class="admonition admonition-sidebar"><p class="sidebar-title">Table of Contents</p>
<div class="contents"><ul class="phpdocumentor-list"><li class="toc-item"><a href="guides/changelog.html#v2-0-0">v2.0.0</a></li><li class="toc-item"><a href="guides/changelog.html#v1-1-0">v1.1.0</a></li><li class="toc-item"><a href="guides/changelog.html#v1-0-1">v1.0.1</a></li><li class="toc-item"><a href="guides/changelog.html#v1-0-0">v1.0.0</a></li></ul></div> <div class="contents"><ul class="phpdocumentor-list"><li class="toc-item"><a href="guides/changelog.html#v2-1-0">v2.1.0</a></li><li class="toc-item"><a href="guides/changelog.html#v2-0-0">v2.0.0</a></li><li class="toc-item"><a href="guides/changelog.html#v1-1-0">v1.1.0</a></li><li class="toc-item"><a href="guides/changelog.html#v1-0-1">v1.0.1</a></li><li class="toc-item"><a href="guides/changelog.html#v1-0-0">v1.0.0</a></li></ul></div>
</div> </div>
</div> </div>
<div class="section" id="v2-1-0">
<h2>v2.1.0</h2>
<p><strong>Breaking Changes:</strong></p>
<ul>
<li><a href="namespaces/occ-basics-datastructures-traits.html"><abbr title="\OCC\Basics\DataStructures\Traits">Traits</abbr></a>
for datastructures renamed to
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html"><abbr title="\OCC\Basics\DataStructures\Traits\StrictSplDoublyLinkedListTrait">StrictSplDoublyLinkedListTrait</abbr></a>
</li>
</ul>
<p><strong>New Features:</strong></p>
<ul>
<li>Extended API for <a href="classes/OCC-Basics-DataStructures-StrictArray.html"><abbr title="\OCC\Basics\DataStructures\StrictArray">StrictArray</abbr></a>
</li>
</ul>
</div>
<div class="section" id="v2-0-0"> <div class="section" id="v2-0-0">
<h2>v2.0.0</h2> <h2>v2.0.0</h2>
@ -226,7 +251,7 @@ function _magicSet{Property}(mixed $value): void</code></pre></li>
<li>Added new trait <a href="classes/OCC-Basics-Traits-TypeChecker.html"><abbr title="\OCC\Basics\Traits\TypeChecker">TypeChecker</abbr></a> <li>Added new trait <a href="classes/OCC-Basics-Traits-TypeChecker.html"><abbr title="\OCC\Basics\Traits\TypeChecker">TypeChecker</abbr></a>
</li> </li>
<li>Extended API for all datastructures (see <a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html"><abbr title="\OCC\Basics\DataStructures\Traits\StrictSplDatastructureTrait">StrictSplDatastructureTrait</abbr></a> <li>Extended API for all datastructures (see <a href=""></a>
)</li> )</li>
<li>Introduced <a href="classes/OCC-Basics-DataStructures-Exceptions-InvalidDataTypeException.html"><abbr title="\OCC\Basics\DataStructures\Exceptions\InvalidDataTypeException">InvalidDataTypeException</abbr></a> <li>Introduced <a href="classes/OCC-Basics-DataStructures-Exceptions-InvalidDataTypeException.html"><abbr title="\OCC\Basics\DataStructures\Exceptions\InvalidDataTypeException">InvalidDataTypeException</abbr></a>

206
doc/guides/changelog/index.html
View File

@ -1,206 +0,0 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>PHP Basics</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<base href="../../">
<link rel="icon" href="images/favicon.ico"/>
<link rel="stylesheet" href="css/normalize.css">
<link rel="stylesheet" href="css/base.css">
<link rel="preconnect" href="https://fonts.gstatic.com">
<link href="https://fonts.googleapis.com/css2?family=Open+Sans:wght@100;200;300;400;600;700&display=swap" rel="stylesheet">
<link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet">
<link rel="stylesheet" href="css/template.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
<script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
<script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
<script src="js/template.js"></script>
<script src="js/search.js"></script>
<script defer src="js/searchIndex.js"></script>
</head>
<body id="top">
<header class="phpdocumentor-header phpdocumentor-section">
<h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">PHP Basics</a></h1>
<input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
<label class="phpdocumentor-header__menu-icon" for="menu-button">
<i class="fas fa-bars"></i>
</label>
<section data-search-form class="phpdocumentor-search">
<label>
<span class="visually-hidden">Search for</span>
<svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
<circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
<line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
</svg>
<input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
</label>
</section>
<nav class="phpdocumentor-topnav">
<ul class="phpdocumentor-topnav__menu">
<li class="phpdocumentor-topnav__menu-item -menu">
<a href="https://packagist.org/packages/opencultureconsulting/basics">
<span>
<i class="fab fa-php"></i>
</span>
</a>
</li>
<li class="phpdocumentor-topnav__menu-item -menu">
<a href="https://github.com/opencultureconsulting/php-basics">
<span>
<i class="fab fa-github"></i>
</span>
</a>
</li>
</ul>
</nav>
</header>
<main class="phpdocumentor">
<div class="phpdocumentor-section">
<input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
<label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
Menu
</label>
<aside class="phpdocumentor-column -three phpdocumentor-sidebar">
<section class="phpdocumentor-sidebar__category -documentation">
<h2 class="phpdocumentor-sidebar__category-header">Documentation</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="guides/installation/index.html#installation" class="">Installation</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="guides/installation/test.html#test" class="">Test</a>
</li>
</ul>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="guides/changelog/index.html#changelog" class="">Changelog</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="guides/changelog/v1.0.0.html#v1-0-0" class="">v1.0.0</a>
</li>
<li>
<a href="guides/changelog/v1.0.1.html#v1-0-1" class="">v1.0.1</a>
</li>
<li>
<a href="guides/changelog/v1.1.0.html#v1-1-0" class="">v1.1.0</a>
</li>
<li>
<a href="guides/changelog/v2.0.0.html#v2-0-0" class="">v2.0.0</a>
</li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category -namespaces">
<h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="namespaces/occ.html" class="">OCC</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="namespaces/occ-basics.html" class="">Basics</a>
</li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category -packages">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="packages/Basics.html" class="">Basics</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="packages/Basics-DataStructures.html" class="">DataStructures</a>
</li>
<li>
<a href="packages/Basics-ErrorHandlers.html" class="">ErrorHandlers</a>
</li>
<li>
<a href="packages/Basics-Interfaces.html" class="">Interfaces</a>
</li>
<li>
<a href="packages/Basics-Traits.html" class="">Traits</a>
</li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
</section>
</aside>
<div class="phpdocumentor-column -nine phpdocumentor-content">
<div class="section" id="changelog">
<h1>Changelog</h1>
<div class="toc">
<ul class="phpdocumentor-list">
<li class="toc-item"><a href="guides/changelog/v1.0.0.html#v1-0-0">v1.0.0</a></li>
<li class="toc-item"><a href="guides/changelog/v1.0.1.html#v1-0-1">v1.0.1</a></li>
<li class="toc-item"><a href="guides/changelog/v1.1.0.html#v1-1-0">v1.1.0</a></li>
<li class="toc-item"><a href="guides/changelog/v2.0.0.html#v2-0-0">v2.0.0</a></li>
</ul>
</div>
</div>
</div>
<section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
<section class="phpdocumentor-search-results__dialog">
<header class="phpdocumentor-search-results__header">
<h2 class="phpdocumentor-search-results__title">Search results</h2>
<button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
</header>
<section class="phpdocumentor-search-results__body">
<ul class="phpdocumentor-search-results__entries"></ul>
</section>
</section>
</section>
</div>
<a href="guides/changelog/index.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
</main>
<script>
cssVars({});
</script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
</body>
</html>

194
doc/guides/changelog/v1.0.0.html
View File

@ -1,194 +0,0 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>PHP Basics</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<base href="../../">
<link rel="icon" href="images/favicon.ico"/>
<link rel="stylesheet" href="css/normalize.css">
<link rel="stylesheet" href="css/base.css">
<link rel="preconnect" href="https://fonts.gstatic.com">
<link href="https://fonts.googleapis.com/css2?family=Open+Sans:wght@100;200;300;400;600;700&display=swap" rel="stylesheet">
<link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet">
<link rel="stylesheet" href="css/template.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
<script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
<script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
<script src="js/template.js"></script>
<script src="js/search.js"></script>
<script defer src="js/searchIndex.js"></script>
</head>
<body id="top">
<header class="phpdocumentor-header phpdocumentor-section">
<h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">PHP Basics</a></h1>
<input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
<label class="phpdocumentor-header__menu-icon" for="menu-button">
<i class="fas fa-bars"></i>
</label>
<section data-search-form class="phpdocumentor-search">
<label>
<span class="visually-hidden">Search for</span>
<svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
<circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
<line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
</svg>
<input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
</label>
</section>
<nav class="phpdocumentor-topnav">
<ul class="phpdocumentor-topnav__menu">
<li class="phpdocumentor-topnav__menu-item -menu">
<a href="https://packagist.org/packages/opencultureconsulting/basics">
<span>
<i class="fab fa-php"></i>
</span>
</a>
</li>
<li class="phpdocumentor-topnav__menu-item -menu">
<a href="https://github.com/opencultureconsulting/php-basics">
<span>
<i class="fab fa-github"></i>
</span>
</a>
</li>
</ul>
</nav>
</header>
<main class="phpdocumentor">
<div class="phpdocumentor-section">
<input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
<label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
Menu
</label>
<aside class="phpdocumentor-column -three phpdocumentor-sidebar">
<section class="phpdocumentor-sidebar__category -documentation">
<h2 class="phpdocumentor-sidebar__category-header">Documentation</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="guides/installation/index.html#installation" class="">Installation</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="guides/installation/test.html#test" class="">Test</a>
</li>
</ul>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="guides/changelog/index.html#changelog" class="">Changelog</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="guides/changelog/v1.0.0.html#v1-0-0" class="">v1.0.0</a>
</li>
<li>
<a href="guides/changelog/v1.0.1.html#v1-0-1" class="">v1.0.1</a>
</li>
<li>
<a href="guides/changelog/v1.1.0.html#v1-1-0" class="">v1.1.0</a>
</li>
<li>
<a href="guides/changelog/v2.0.0.html#v2-0-0" class="">v2.0.0</a>
</li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category -namespaces">
<h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="namespaces/occ.html" class="">OCC</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="namespaces/occ-basics.html" class="">Basics</a>
</li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category -packages">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="packages/Basics.html" class="">Basics</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="packages/Basics-DataStructures.html" class="">DataStructures</a>
</li>
<li>
<a href="packages/Basics-ErrorHandlers.html" class="">ErrorHandlers</a>
</li>
<li>
<a href="packages/Basics-Interfaces.html" class="">Interfaces</a>
</li>
<li>
<a href="packages/Basics-Traits.html" class="">Traits</a>
</li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
</section>
</aside>
<div class="phpdocumentor-column -nine phpdocumentor-content">
<div class="section" id="v1-0-0">
<h1>v1.0.0</h1>
<p>intial release</p>
</div>
</div>
<section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
<section class="phpdocumentor-search-results__dialog">
<header class="phpdocumentor-search-results__header">
<h2 class="phpdocumentor-search-results__title">Search results</h2>
<button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
</header>
<section class="phpdocumentor-search-results__body">
<ul class="phpdocumentor-search-results__entries"></ul>
</section>
</section>
</section>
</div>
<a href="guides/changelog/v1.0.0.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
</main>
<script>
cssVars({});
</script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
</body>
</html>

195
doc/guides/changelog/v1.0.1.html
View File

@ -1,195 +0,0 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>PHP Basics</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<base href="../../">
<link rel="icon" href="images/favicon.ico"/>
<link rel="stylesheet" href="css/normalize.css">
<link rel="stylesheet" href="css/base.css">
<link rel="preconnect" href="https://fonts.gstatic.com">
<link href="https://fonts.googleapis.com/css2?family=Open+Sans:wght@100;200;300;400;600;700&display=swap" rel="stylesheet">
<link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet">
<link rel="stylesheet" href="css/template.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
<script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
<script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
<script src="js/template.js"></script>
<script src="js/search.js"></script>
<script defer src="js/searchIndex.js"></script>
</head>
<body id="top">
<header class="phpdocumentor-header phpdocumentor-section">
<h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">PHP Basics</a></h1>
<input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
<label class="phpdocumentor-header__menu-icon" for="menu-button">
<i class="fas fa-bars"></i>
</label>
<section data-search-form class="phpdocumentor-search">
<label>
<span class="visually-hidden">Search for</span>
<svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
<circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
<line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
</svg>
<input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
</label>
</section>
<nav class="phpdocumentor-topnav">
<ul class="phpdocumentor-topnav__menu">
<li class="phpdocumentor-topnav__menu-item -menu">
<a href="https://packagist.org/packages/opencultureconsulting/basics">
<span>
<i class="fab fa-php"></i>
</span>
</a>
</li>
<li class="phpdocumentor-topnav__menu-item -menu">
<a href="https://github.com/opencultureconsulting/php-basics">
<span>
<i class="fab fa-github"></i>
</span>
</a>
</li>
</ul>
</nav>
</header>
<main class="phpdocumentor">
<div class="phpdocumentor-section">
<input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
<label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
Menu
</label>
<aside class="phpdocumentor-column -three phpdocumentor-sidebar">
<section class="phpdocumentor-sidebar__category -documentation">
<h2 class="phpdocumentor-sidebar__category-header">Documentation</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="guides/installation/index.html#installation" class="">Installation</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="guides/installation/test.html#test" class="">Test</a>
</li>
</ul>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="guides/changelog/index.html#changelog" class="">Changelog</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="guides/changelog/v1.0.0.html#v1-0-0" class="">v1.0.0</a>
</li>
<li>
<a href="guides/changelog/v1.0.1.html#v1-0-1" class="">v1.0.1</a>
</li>
<li>
<a href="guides/changelog/v1.1.0.html#v1-1-0" class="">v1.1.0</a>
</li>
<li>
<a href="guides/changelog/v2.0.0.html#v2-0-0" class="">v2.0.0</a>
</li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category -namespaces">
<h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="namespaces/occ.html" class="">OCC</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="namespaces/occ-basics.html" class="">Basics</a>
</li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category -packages">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="packages/Basics.html" class="">Basics</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="packages/Basics-DataStructures.html" class="">DataStructures</a>
</li>
<li>
<a href="packages/Basics-ErrorHandlers.html" class="">ErrorHandlers</a>
</li>
<li>
<a href="packages/Basics-Interfaces.html" class="">Interfaces</a>
</li>
<li>
<a href="packages/Basics-Traits.html" class="">Traits</a>
</li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
</section>
</aside>
<div class="phpdocumentor-column -nine phpdocumentor-content">
<div class="section" id="v1-0-1">
<h1>v1.0.1</h1>
<p>new:
- add exception handling to singleton trait</p>
</div>
</div>
<section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
<section class="phpdocumentor-search-results__dialog">
<header class="phpdocumentor-search-results__header">
<h2 class="phpdocumentor-search-results__title">Search results</h2>
<button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
</header>
<section class="phpdocumentor-search-results__body">
<ul class="phpdocumentor-search-results__entries"></ul>
</section>
</section>
</section>
</div>
<a href="guides/changelog/v1.0.1.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
</main>
<script>
cssVars({});
</script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
</body>
</html>

195
doc/guides/changelog/v1.1.0.html
View File

@ -1,195 +0,0 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>PHP Basics</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<base href="../../">
<link rel="icon" href="images/favicon.ico"/>
<link rel="stylesheet" href="css/normalize.css">
<link rel="stylesheet" href="css/base.css">
<link rel="preconnect" href="https://fonts.gstatic.com">
<link href="https://fonts.googleapis.com/css2?family=Open+Sans:wght@100;200;300;400;600;700&display=swap" rel="stylesheet">
<link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet">
<link rel="stylesheet" href="css/template.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
<script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
<script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
<script src="js/template.js"></script>
<script src="js/search.js"></script>
<script defer src="js/searchIndex.js"></script>
</head>
<body id="top">
<header class="phpdocumentor-header phpdocumentor-section">
<h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">PHP Basics</a></h1>
<input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
<label class="phpdocumentor-header__menu-icon" for="menu-button">
<i class="fas fa-bars"></i>
</label>
<section data-search-form class="phpdocumentor-search">
<label>
<span class="visually-hidden">Search for</span>
<svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
<circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
<line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
</svg>
<input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
</label>
</section>
<nav class="phpdocumentor-topnav">
<ul class="phpdocumentor-topnav__menu">
<li class="phpdocumentor-topnav__menu-item -menu">
<a href="https://packagist.org/packages/opencultureconsulting/basics">
<span>
<i class="fab fa-php"></i>
</span>
</a>
</li>
<li class="phpdocumentor-topnav__menu-item -menu">
<a href="https://github.com/opencultureconsulting/php-basics">
<span>
<i class="fab fa-github"></i>
</span>
</a>
</li>
</ul>
</nav>
</header>
<main class="phpdocumentor">
<div class="phpdocumentor-section">
<input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
<label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
Menu
</label>
<aside class="phpdocumentor-column -three phpdocumentor-sidebar">
<section class="phpdocumentor-sidebar__category -documentation">
<h2 class="phpdocumentor-sidebar__category-header">Documentation</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="guides/installation/index.html#installation" class="">Installation</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="guides/installation/test.html#test" class="">Test</a>
</li>
</ul>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="guides/changelog/index.html#changelog" class="">Changelog</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="guides/changelog/v1.0.0.html#v1-0-0" class="">v1.0.0</a>
</li>
<li>
<a href="guides/changelog/v1.0.1.html#v1-0-1" class="">v1.0.1</a>
</li>
<li>
<a href="guides/changelog/v1.1.0.html#v1-1-0" class="">v1.1.0</a>
</li>
<li>
<a href="guides/changelog/v2.0.0.html#v2-0-0" class="">v2.0.0</a>
</li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category -namespaces">
<h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="namespaces/occ.html" class="">OCC</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="namespaces/occ-basics.html" class="">Basics</a>
</li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category -packages">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="packages/Basics.html" class="">Basics</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="packages/Basics-DataStructures.html" class="">DataStructures</a>
</li>
<li>
<a href="packages/Basics-ErrorHandlers.html" class="">ErrorHandlers</a>
</li>
<li>
<a href="packages/Basics-Interfaces.html" class="">Interfaces</a>
</li>
<li>
<a href="packages/Basics-Traits.html" class="">Traits</a>
</li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
</section>
</aside>
<div class="phpdocumentor-column -nine phpdocumentor-content">
<div class="section" id="v1-1-0">
<h1>v1.1.0</h1>
<p>breaking changes:
- removed first parameter (initial items) from constructor of data structures to improve compatibility with SplDoublyLinkedList</p>
</div>
</div>
<section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
<section class="phpdocumentor-search-results__dialog">
<header class="phpdocumentor-search-results__header">
<h2 class="phpdocumentor-search-results__title">Search results</h2>
<button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
</header>
<section class="phpdocumentor-search-results__body">
<ul class="phpdocumentor-search-results__entries"></ul>
</section>
</section>
</section>
</div>
<a href="guides/changelog/v1.1.0.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
</main>
<script>
cssVars({});
</script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
</body>
</html>

204
doc/guides/changelog/v2.0.0.html
View File

@ -1,204 +0,0 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>PHP Basics</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<base href="../../">
<link rel="icon" href="images/favicon.ico"/>
<link rel="stylesheet" href="css/normalize.css">
<link rel="stylesheet" href="css/base.css">
<link rel="preconnect" href="https://fonts.gstatic.com">
<link href="https://fonts.googleapis.com/css2?family=Open+Sans:wght@100;200;300;400;600;700&display=swap" rel="stylesheet">
<link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet">
<link rel="stylesheet" href="css/template.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
<script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
<script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
<script src="js/template.js"></script>
<script src="js/search.js"></script>
<script defer src="js/searchIndex.js"></script>
</head>
<body id="top">
<header class="phpdocumentor-header phpdocumentor-section">
<h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">PHP Basics</a></h1>
<input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
<label class="phpdocumentor-header__menu-icon" for="menu-button">
<i class="fas fa-bars"></i>
</label>
<section data-search-form class="phpdocumentor-search">
<label>
<span class="visually-hidden">Search for</span>
<svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
<circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
<line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
</svg>
<input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
</label>
</section>
<nav class="phpdocumentor-topnav">
<ul class="phpdocumentor-topnav__menu">
<li class="phpdocumentor-topnav__menu-item -menu">
<a href="https://packagist.org/packages/opencultureconsulting/basics">
<span>
<i class="fab fa-php"></i>
</span>
</a>
</li>
<li class="phpdocumentor-topnav__menu-item -menu">
<a href="https://github.com/opencultureconsulting/php-basics">
<span>
<i class="fab fa-github"></i>
</span>
</a>
</li>
</ul>
</nav>
</header>
<main class="phpdocumentor">
<div class="phpdocumentor-section">
<input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
<label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
Menu
</label>
<aside class="phpdocumentor-column -three phpdocumentor-sidebar">
<section class="phpdocumentor-sidebar__category -documentation">
<h2 class="phpdocumentor-sidebar__category-header">Documentation</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="guides/installation/index.html#installation" class="">Installation</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="guides/installation/test.html#test" class="">Test</a>
</li>
</ul>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="guides/changelog/index.html#changelog" class="">Changelog</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="guides/changelog/v1.0.0.html#v1-0-0" class="">v1.0.0</a>
</li>
<li>
<a href="guides/changelog/v1.0.1.html#v1-0-1" class="">v1.0.1</a>
</li>
<li>
<a href="guides/changelog/v1.1.0.html#v1-1-0" class="">v1.1.0</a>
</li>
<li>
<a href="guides/changelog/v2.0.0.html#v2-0-0" class="">v2.0.0</a>
</li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category -namespaces">
<h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="namespaces/occ.html" class="">OCC</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="namespaces/occ-basics.html" class="">Basics</a>
</li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category -packages">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="packages/Basics.html" class="">Basics</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="packages/Basics-DataStructures.html" class="">DataStructures</a>
</li>
<li>
<a href="packages/Basics-ErrorHandlers.html" class="">ErrorHandlers</a>
</li>
<li>
<a href="packages/Basics-Interfaces.html" class="">Interfaces</a>
</li>
<li>
<a href="packages/Basics-Traits.html" class="">Traits</a>
</li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
</section>
</aside>
<div class="phpdocumentor-column -nine phpdocumentor-content">
<div class="section" id="v2-0-0">
<h1>v2.0.0</h1>
<p>breaking changes:
- requirements: php 8.0 -&gt; php 8.1
- namespace: InterfaceTraits -&gt; Interfaces
- magic methods for getter and setter: magicGet.../magicSet... -&gt; _magicGet.../_magicSet...</p>
<p>new:
- strictcollection
- triggererrorexception
- overloadinggetter
- overloadingsetter
- extended API for data structures
- extended documentation</p>
</div>
</div>
<section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
<section class="phpdocumentor-search-results__dialog">
<header class="phpdocumentor-search-results__header">
<h2 class="phpdocumentor-search-results__title">Search results</h2>
<button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
</header>
<section class="phpdocumentor-search-results__body">
<ul class="phpdocumentor-search-results__entries"></ul>
</section>
</section>
</section>
</div>
<a href="guides/changelog/v2.0.0.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
</main>
<script>
cssVars({});
</script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
</body>
</html>

212
doc/guides/cheatsheet.html
View File

@ -1,212 +0,0 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>PHP Basics</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<base href="../">
<link rel="icon" href="images/favicon.ico"/>
<link rel="stylesheet" href="css/normalize.css">
<link rel="stylesheet" href="css/base.css">
<link rel="preconnect" href="https://fonts.gstatic.com">
<link href="https://fonts.googleapis.com/css2?family=Open+Sans:wght@100;200;300;400;600;700&display=swap" rel="stylesheet">
<link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet">
<link rel="stylesheet" href="css/template.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
<script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
<script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
<script src="js/template.js"></script>
<script src="js/search.js"></script>
<script defer src="js/searchIndex.js"></script>
</head>
<body id="top">
<header class="phpdocumentor-header phpdocumentor-section">
<h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">PHP Basics</a></h1>
<input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
<label class="phpdocumentor-header__menu-icon" for="menu-button">
<i class="fas fa-bars"></i>
</label>
<section data-search-form class="phpdocumentor-search">
<label>
<span class="visually-hidden">Search for</span>
<svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
<circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
<line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
</svg>
<input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
</label>
</section>
<nav class="phpdocumentor-topnav">
<ul class="phpdocumentor-topnav__menu">
<li class="phpdocumentor-topnav__menu-item -menu">
<a href="https://packagist.org/packages/opencultureconsulting/basics">
<span>
<i class="fab fa-php"></i>
</span>
</a>
</li>
<li class="phpdocumentor-topnav__menu-item -menu">
<a href="https://github.com/opencultureconsulting/php-basics">
<span>
<i class="fab fa-github"></i>
</span>
</a>
</li>
</ul>
</nav>
</header>
<main class="phpdocumentor">
<div class="phpdocumentor-section">
<input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
<label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
Menu
</label>
<aside class="phpdocumentor-column -three phpdocumentor-sidebar">
<section class="phpdocumentor-sidebar__category -documentation">
<h2 class="phpdocumentor-sidebar__category-header">Documentation</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="guides/overview/index.html#overview" class="">Overview</a>
</h4>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="guides/usage/index.html#user-guide" class="">User Guide</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="guides/usage/requirements.html#requirements" class="">Requirements</a>
</li>
<li>
<a href="guides/usage/installation.html#installation" class="">Installation</a>
</li>
</ul>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="guides/changelog.html#changelog" class="">Changelog</a>
</h4>
</section>
<section class="phpdocumentor-sidebar__category -namespaces">
<h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="namespaces/occ.html" class="">OCC</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="namespaces/occ-basics.html" class="">Basics</a>
</li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category -packages">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="packages/Basics.html" class="">Basics</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="packages/Basics-DataStructures.html" class="">DataStructures</a>
</li>
<li>
<a href="packages/Basics-ErrorHandlers.html" class="">ErrorHandlers</a>
</li>
<li>
<a href="packages/Basics-Interfaces.html" class="">Interfaces</a>
</li>
<li>
<a href="packages/Basics-Traits.html" class="">Traits</a>
</li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category -reports">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
</section>
<section class="phpdocumentor-sidebar__category -indices">
<h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
</section>
</aside>
<div class="phpdocumentor-column -nine phpdocumentor-content">
<div class="section" id="helpful-reminders">
<h1>Helpful Reminders</h1>
<div class="phpdocumentor-admonition ">
<article>
<p>Plain Box</p>
</article>
</div>
<div class="phpdocumentor-admonition caution">
<svg class="phpdocumentor-admonition__icon" fill="none" stroke="currentColor" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-3L13.732 4c-.77-1.333-2.694-1.333-3.464 0L3.34 16c-.77 1.333.192 3 1.732 3z"></path></svg>
<article>
<p>Exclamation Mark</p>
</article>
</div>
<div class="phpdocumentor-admonition hint">
<svg class="phpdocumentor-admonition__icon" fill="none" stroke="currentColor" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M18.364 5.636l-3.536 3.536m0 5.656l3.536 3.536M9.172 9.172L5.636 5.636m3.536 9.192l-3.536 3.536M21 12a9 9 0 11-18 0 9 9 0 0118 0zm-5 0a4 4 0 11-8 0 4 4 0 018 0z"></path></svg>
<article>
<p>Lifebuoy</p>
</article>
</div>
<div class="phpdocumentor-admonition note">
<svg class="phpdocumentor-admonition__icon" fill="none" stroke="currentColor" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M7 8h10M7 12h4m1 8l-4-4H5a2 2 0 01-2-2V6a2 2 0 012-2h14a2 2 0 012 2v8a2 2 0 01-2 2h-3l-4 4z"></path></svg>
<article>
<p>Speech Bubble</p>
</article>
</div>
<pre><code class="language-php">// Code Block</code></pre>
<div class="contents"><ul class="phpdocumentor-list"></ul></div>
</div>
</div>
<section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
<section class="phpdocumentor-search-results__dialog">
<header class="phpdocumentor-search-results__header">
<h2 class="phpdocumentor-search-results__title">Search results</h2>
<button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
</header>
<section class="phpdocumentor-search-results__body">
<ul class="phpdocumentor-search-results__entries"></ul>
</section>
</section>
</section>
</div>
<a href="guides/cheatsheet.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
</main>
<script>
cssVars({});
</script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
</body>
</html>

2
doc/guides/index.html
View File

@ -192,6 +192,8 @@
</ul></li> </ul></li>
<li class="toc-item"><a href="guides/changelog.html#changelog">Changelog</a> <ul class="section-level-1"> <li class="toc-item"><a href="guides/changelog.html#changelog">Changelog</a> <ul class="section-level-1">
<li class="toc-item"><a href="guides/changelog.html#v2-1-0">v2.1.0</a></li>
<li class="toc-item"><a href="guides/changelog.html#v2-0-0">v2.0.0</a></li> <li class="toc-item"><a href="guides/changelog.html#v2-0-0">v2.0.0</a></li>
<li class="toc-item"><a href="guides/changelog.html#v1-1-0">v1.1.0</a></li> <li class="toc-item"><a href="guides/changelog.html#v1-1-0">v1.1.0</a></li>

189
doc/guides/installation/index.html
View File

@ -1,189 +0,0 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>PHP Basics</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<base href="../../">
<link rel="icon" href="images/favicon.ico"/>
<link rel="stylesheet" href="css/normalize.css">
<link rel="stylesheet" href="css/base.css">
<link rel="preconnect" href="https://fonts.gstatic.com">
<link href="https://fonts.googleapis.com/css2?family=Open+Sans:wght@100;200;300;400;600;700&display=swap" rel="stylesheet">
<link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet">
<link rel="stylesheet" href="css/template.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
<script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
<script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
<script src="js/template.js"></script>
<script src="js/search.js"></script>
<script defer src="js/searchIndex.js"></script>
</head>
<body id="top">
<header class="phpdocumentor-header phpdocumentor-section">
<h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">PHP Basics</a></h1>
<input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
<label class="phpdocumentor-header__menu-icon" for="menu-button">
<i class="fas fa-bars"></i>
</label>
<section data-search-form class="phpdocumentor-search">
<label>
<span class="visually-hidden">Search for</span>
<svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
<circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
<line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
</svg>
<input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
</label>
</section>
<nav class="phpdocumentor-topnav">
<ul class="phpdocumentor-topnav__menu">
<li class="phpdocumentor-topnav__menu-item -menu">
<a href="https://packagist.org/packages/opencultureconsulting/basics">
<span>
<i class="fab fa-php"></i>
</span>
</a>
</li>
<li class="phpdocumentor-topnav__menu-item -menu">
<a href="https://github.com/opencultureconsulting/php-basics">
<span>
<i class="fab fa-github"></i>
</span>
</a>
</li>
</ul>
</nav>
</header>
<main class="phpdocumentor">
<div class="phpdocumentor-section">
<input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
<label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
Menu
</label>
<aside class="phpdocumentor-column -three phpdocumentor-sidebar">
<section class="phpdocumentor-sidebar__category -documentation">
<h2 class="phpdocumentor-sidebar__category-header">Documentation</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="guides/installation/index.html#installation" class="">Installation</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="guides/installation/test.html#test" class="">Test</a>
</li>
</ul>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="guides/changelog.html#changelog" class="">Changelog</a>
</h4>
</section>
<section class="phpdocumentor-sidebar__category -namespaces">
<h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="namespaces/occ.html" class="">OCC</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="namespaces/occ-basics.html" class="">Basics</a>
</li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category -packages">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="packages/Basics.html" class="">Basics</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="packages/Basics-DataStructures.html" class="">DataStructures</a>
</li>
<li>
<a href="packages/Basics-ErrorHandlers.html" class="">ErrorHandlers</a>
</li>
<li>
<a href="packages/Basics-Interfaces.html" class="">Interfaces</a>
</li>
<li>
<a href="packages/Basics-Traits.html" class="">Traits</a>
</li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
</section>
</aside>
<div class="phpdocumentor-column -nine phpdocumentor-content">
<div class="section" id="installation">
<h1>Installation</h1>
<div class="toc">
<ul class="phpdocumentor-list">
<li class="toc-item"><a href="guides/installation/test.html#test">Test</a> <ul class="section-level-1">
<li class="toc-item"><a href="guides/installation/test.html#heading-1">Heading 1</a> <ul class="section-level-2">
<li class="toc-item"><a href="guides/installation/test.html#heading-2">Heading 2</a></li>
</ul></li>
</ul></li>
</ul>
</div>
<pre><code class="language-shell">composer require opencultureconsulting/basics</code></pre>
</div>
</div>
<section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
<section class="phpdocumentor-search-results__dialog">
<header class="phpdocumentor-search-results__header">
<h2 class="phpdocumentor-search-results__title">Search results</h2>
<button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
</header>
<section class="phpdocumentor-search-results__body">
<ul class="phpdocumentor-search-results__entries"></ul>
</section>
</section>
</section>
</div>
<a href="guides/installation/index.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
</main>
<script>
cssVars({});
</script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
</body>
</html>

195
doc/guides/installation/test.html
View File

@ -1,195 +0,0 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>PHP Basics</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<base href="../../">
<link rel="icon" href="images/favicon.ico"/>
<link rel="stylesheet" href="css/normalize.css">
<link rel="stylesheet" href="css/base.css">
<link rel="preconnect" href="https://fonts.gstatic.com">
<link href="https://fonts.googleapis.com/css2?family=Open+Sans:wght@100;200;300;400;600;700&display=swap" rel="stylesheet">
<link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet">
<link rel="stylesheet" href="css/template.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
<script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
<script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
<script src="js/template.js"></script>
<script src="js/search.js"></script>
<script defer src="js/searchIndex.js"></script>
</head>
<body id="top">
<header class="phpdocumentor-header phpdocumentor-section">
<h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">PHP Basics</a></h1>
<input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
<label class="phpdocumentor-header__menu-icon" for="menu-button">
<i class="fas fa-bars"></i>
</label>
<section data-search-form class="phpdocumentor-search">
<label>
<span class="visually-hidden">Search for</span>
<svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
<circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
<line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
</svg>
<input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
</label>
</section>
<nav class="phpdocumentor-topnav">
<ul class="phpdocumentor-topnav__menu">
<li class="phpdocumentor-topnav__menu-item -menu">
<a href="https://packagist.org/packages/opencultureconsulting/basics">
<span>
<i class="fab fa-php"></i>
</span>
</a>
</li>
<li class="phpdocumentor-topnav__menu-item -menu">
<a href="https://github.com/opencultureconsulting/php-basics">
<span>
<i class="fab fa-github"></i>
</span>
</a>
</li>
</ul>
</nav>
</header>
<main class="phpdocumentor">
<div class="phpdocumentor-section">
<input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
<label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
Menu
</label>
<aside class="phpdocumentor-column -three phpdocumentor-sidebar">
<section class="phpdocumentor-sidebar__category -documentation">
<h2 class="phpdocumentor-sidebar__category-header">Documentation</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="guides/installation/index.html#installation" class="">Installation</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="guides/installation/test.html#test" class="">Test</a>
</li>
</ul>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="guides/changelog.html#changelog" class="">Changelog</a>
</h4>
</section>
<section class="phpdocumentor-sidebar__category -namespaces">
<h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="namespaces/occ.html" class="">OCC</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="namespaces/occ-basics.html" class="">Basics</a>
</li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category -packages">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="packages/Basics.html" class="">Basics</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="packages/Basics-DataStructures.html" class="">DataStructures</a>
</li>
<li>
<a href="packages/Basics-ErrorHandlers.html" class="">ErrorHandlers</a>
</li>
<li>
<a href="packages/Basics-Interfaces.html" class="">Interfaces</a>
</li>
<li>
<a href="packages/Basics-Traits.html" class="">Traits</a>
</li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
</section>
</aside>
<div class="phpdocumentor-column -nine phpdocumentor-content">
<div class="section" id="test">
<h1>Test</h1>
<div class="section" id="heading-1">
<h2>Heading 1</h2>
<div class="section" id="heading-2">
<h3>Heading 2</h3>
<div class="section" id="heading-3">
<h4>Heading 3</h4>
<div class="section" id="heading-4">
<h5>Heading 4</h5>
</div>
</div>
</div>
</div>
</div>
</div>
<section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
<section class="phpdocumentor-search-results__dialog">
<header class="phpdocumentor-search-results__header">
<h2 class="phpdocumentor-search-results__title">Search results</h2>
<button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
</header>
<section class="phpdocumentor-search-results__body">
<ul class="phpdocumentor-search-results__entries"></ul>
</section>
</section>
</section>
</div>
<a href="guides/installation/test.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
</main>
<script>
cssVars({});
</script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
</body>
</html>

2
doc/indices/files.html
View File

@ -201,7 +201,7 @@
<li><a href="files/src-datastructures-strictcollection.html"><abbr title="src/DataStructures/StrictCollection.php">StrictCollection.php</abbr></a></li> <li><a href="files/src-datastructures-strictcollection.html"><abbr title="src/DataStructures/StrictCollection.php">StrictCollection.php</abbr></a></li>
<li><a href="files/src-datastructures-strictlist.html"><abbr title="src/DataStructures/StrictList.php">StrictList.php</abbr></a></li> <li><a href="files/src-datastructures-strictlist.html"><abbr title="src/DataStructures/StrictList.php">StrictList.php</abbr></a></li>
<li><a href="files/src-datastructures-strictqueue.html"><abbr title="src/DataStructures/StrictQueue.php">StrictQueue.php</abbr></a></li> <li><a href="files/src-datastructures-strictqueue.html"><abbr title="src/DataStructures/StrictQueue.php">StrictQueue.php</abbr></a></li>
<li><a href="files/src-datastructures-traits-strictspldatastructuretrait.html"><abbr title="src/DataStructures/Traits/StrictSplDatastructureTrait.php">StrictSplDatastructureTrait.php</abbr></a></li> <li><a href="files/src-datastructures-traits-strictspldoublylinkedlisttrait.html"><abbr title="src/DataStructures/Traits/StrictSplDoublyLinkedListTrait.php">StrictSplDoublyLinkedListTrait.php</abbr></a></li>
<li><a href="files/src-datastructures-strictstack.html"><abbr title="src/DataStructures/StrictStack.php">StrictStack.php</abbr></a></li> <li><a href="files/src-datastructures-strictstack.html"><abbr title="src/DataStructures/StrictStack.php">StrictStack.php</abbr></a></li>
</ul> </ul>
<h3>T</h3> <h3>T</h3>

97
doc/js/searchIndex.js
View File

@ -10,6 +10,36 @@ Search.appendIndex(
"name": "StrictArray", "name": "StrictArray",
"summary": "A\u0020type\u002Dsensitive,\u0020traversable\u0020array.", "summary": "A\u0020type\u002Dsensitive,\u0020traversable\u0020array.",
"url": "classes/OCC-Basics-DataStructures-StrictArray.html" "url": "classes/OCC-Basics-DataStructures-StrictArray.html"
}, {
"fqsen": "\\OCC\\Basics\\DataStructures\\StrictArray\u003A\u003Abottom\u0028\u0029",
"name": "bottom",
"summary": "Peek\u0020at\u0020the\u0020first\u0020item\u0020of\u0020the\u0020array.",
"url": "classes/OCC-Basics-DataStructures-StrictArray.html#method_bottom"
}, {
"fqsen": "\\OCC\\Basics\\DataStructures\\StrictArray\u003A\u003Apop\u0028\u0029",
"name": "pop",
"summary": "Pop\u0020the\u0020item\u0020from\u0020the\u0020end\u0020of\u0020the\u0020array.",
"url": "classes/OCC-Basics-DataStructures-StrictArray.html#method_pop"
}, {
"fqsen": "\\OCC\\Basics\\DataStructures\\StrictArray\u003A\u003Apush\u0028\u0029",
"name": "push",
"summary": "Push\u0020an\u0020item\u0020at\u0020the\u0020end\u0020of\u0020the\u0020array.",
"url": "classes/OCC-Basics-DataStructures-StrictArray.html#method_push"
}, {
"fqsen": "\\OCC\\Basics\\DataStructures\\StrictArray\u003A\u003Ashift\u0028\u0029",
"name": "shift",
"summary": "Shift\u0020the\u0020item\u0020from\u0020the\u0020beginning\u0020of\u0020the\u0020array.",
"url": "classes/OCC-Basics-DataStructures-StrictArray.html#method_shift"
}, {
"fqsen": "\\OCC\\Basics\\DataStructures\\StrictArray\u003A\u003Atop\u0028\u0029",
"name": "top",
"summary": "Peek\u0020at\u0020the\u0020last\u0020item\u0020of\u0020the\u0020array.",
"url": "classes/OCC-Basics-DataStructures-StrictArray.html#method_top"
}, {
"fqsen": "\\OCC\\Basics\\DataStructures\\StrictArray\u003A\u003Aunshift\u0028\u0029",
"name": "unshift",
"summary": "Prepend\u0020the\u0020array\u0020with\u0020an\u0020item.",
"url": "classes/OCC-Basics-DataStructures-StrictArray.html#method_unshift"
}, { }, {
"fqsen": "\\OCC\\Basics\\DataStructures\\StrictCollection", "fqsen": "\\OCC\\Basics\\DataStructures\\StrictCollection",
"name": "StrictCollection", "name": "StrictCollection",
@ -90,6 +120,11 @@ Search.appendIndex(
"name": "StrictQueue", "name": "StrictQueue",
"summary": "A\u0020type\u002Dsensitive,\u0020taversable\u0020queue\u0020\u0028FIFO\u0029.", "summary": "A\u0020type\u002Dsensitive,\u0020taversable\u0020queue\u0020\u0028FIFO\u0029.",
"url": "classes/OCC-Basics-DataStructures-StrictQueue.html" "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", "fqsen": "\\OCC\\Basics\\DataStructures\\StrictQueue\u003A\u003Aenqueue\u0028\u0029",
"name": "enqueue", "name": "enqueue",
@ -111,80 +146,80 @@ Search.appendIndex(
"summary": "Unstack\u0020an\u0020item\u0020from\u0020the\u0020stack.", "summary": "Unstack\u0020an\u0020item\u0020from\u0020the\u0020stack.",
"url": "classes/OCC-Basics-DataStructures-StrictStack.html#method_unstack" "url": "classes/OCC-Basics-DataStructures-StrictStack.html#method_unstack"
}, { }, {
"fqsen": "\\OCC\\Basics\\DataStructures\\Traits\\StrictSplDatastructureTrait", "fqsen": "\\OCC\\Basics\\DataStructures\\Traits\\StrictSplDoublyLinkedListTrait",
"name": "StrictSplDatastructureTrait", "name": "StrictSplDoublyLinkedListTrait",
"summary": "The\u0020common\u0020interface\u0020of\u0020all\u0020type\u002Dsensitive,\u0020SPL\u002Dbased\u0020datastructures.", "summary": "The\u0020common\u0020interface\u0020of\u0020all\u0020type\u002Dsensitive,\u0020SPL\u002Dbased\u0020datastructures.",
"url": "classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html" "url": "classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html"
}, { }, {
"fqsen": "\\OCC\\Basics\\DataStructures\\Traits\\StrictSplDatastructureTrait\u003A\u003Aadd\u0028\u0029", "fqsen": "\\OCC\\Basics\\DataStructures\\Traits\\StrictSplDoublyLinkedListTrait\u003A\u003Aadd\u0028\u0029",
"name": "add", "name": "add",
"summary": "Add\/insert\u0020a\u0020new\u0020item\u0020at\u0020the\u0020specified\u0020offset.", "summary": "Add\/insert\u0020a\u0020new\u0020item\u0020at\u0020the\u0020specified\u0020offset.",
"url": "classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_add" "url": "classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_add"
}, { }, {
"fqsen": "\\OCC\\Basics\\DataStructures\\Traits\\StrictSplDatastructureTrait\u003A\u003Aappend\u0028\u0029", "fqsen": "\\OCC\\Basics\\DataStructures\\Traits\\StrictSplDoublyLinkedListTrait\u003A\u003Aappend\u0028\u0029",
"name": "append", "name": "append",
"summary": "Append\u0020items\u0020at\u0020the\u0020end\u0020of\u0020the\u0020list.", "summary": "Append\u0020items\u0020at\u0020the\u0020end\u0020of\u0020the\u0020list.",
"url": "classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_append" "url": "classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_append"
}, { }, {
"fqsen": "\\OCC\\Basics\\DataStructures\\Traits\\StrictSplDatastructureTrait\u003A\u003Aclear\u0028\u0029", "fqsen": "\\OCC\\Basics\\DataStructures\\Traits\\StrictSplDoublyLinkedListTrait\u003A\u003Aclear\u0028\u0029",
"name": "clear", "name": "clear",
"summary": "Clear\u0020the\u0020list\u0020of\u0020any\u0020items.", "summary": "Clear\u0020the\u0020list\u0020of\u0020any\u0020items.",
"url": "classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_clear" "url": "classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_clear"
}, { }, {
"fqsen": "\\OCC\\Basics\\DataStructures\\Traits\\StrictSplDatastructureTrait\u003A\u003Aget\u0028\u0029", "fqsen": "\\OCC\\Basics\\DataStructures\\Traits\\StrictSplDoublyLinkedListTrait\u003A\u003Aget\u0028\u0029",
"name": "get", "name": "get",
"summary": "Get\u0020the\u0020item\u0020at\u0020the\u0020specified\u0020index.", "summary": "Get\u0020the\u0020item\u0020at\u0020the\u0020specified\u0020index.",
"url": "classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_get" "url": "classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_get"
}, { }, {
"fqsen": "\\OCC\\Basics\\DataStructures\\Traits\\StrictSplDatastructureTrait\u003A\u003AisList\u0028\u0029", "fqsen": "\\OCC\\Basics\\DataStructures\\Traits\\StrictSplDoublyLinkedListTrait\u003A\u003AisList\u0028\u0029",
"name": "isList", "name": "isList",
"summary": "Check\u0020if\u0020this\u0020can\u0020be\u0020considered\u0020a\u0020list.", "summary": "Check\u0020if\u0020this\u0020can\u0020be\u0020considered\u0020a\u0020list.",
"url": "classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_isList" "url": "classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_isList"
}, { }, {
"fqsen": "\\OCC\\Basics\\DataStructures\\Traits\\StrictSplDatastructureTrait\u003A\u003AoffsetSet\u0028\u0029", "fqsen": "\\OCC\\Basics\\DataStructures\\Traits\\StrictSplDoublyLinkedListTrait\u003A\u003AoffsetSet\u0028\u0029",
"name": "offsetSet", "name": "offsetSet",
"summary": "Set\u0020the\u0020item\u0020at\u0020the\u0020specified\u0020offset.", "summary": "Set\u0020the\u0020item\u0020at\u0020the\u0020specified\u0020offset.",
"url": "classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_offsetSet" "url": "classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_offsetSet"
}, { }, {
"fqsen": "\\OCC\\Basics\\DataStructures\\Traits\\StrictSplDatastructureTrait\u003A\u003Aprepend\u0028\u0029", "fqsen": "\\OCC\\Basics\\DataStructures\\Traits\\StrictSplDoublyLinkedListTrait\u003A\u003Aprepend\u0028\u0029",
"name": "prepend", "name": "prepend",
"summary": "Prepend\u0020items\u0020at\u0020the\u0020start\u0020of\u0020the\u0020list.", "summary": "Prepend\u0020items\u0020at\u0020the\u0020start\u0020of\u0020the\u0020list.",
"url": "classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_prepend" "url": "classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_prepend"
}, { }, {
"fqsen": "\\OCC\\Basics\\DataStructures\\Traits\\StrictSplDatastructureTrait\u003A\u003Apush\u0028\u0029", "fqsen": "\\OCC\\Basics\\DataStructures\\Traits\\StrictSplDoublyLinkedListTrait\u003A\u003Apush\u0028\u0029",
"name": "push", "name": "push",
"summary": "Push\u0020an\u0020item\u0020at\u0020the\u0020end\u0020of\u0020the\u0020list.", "summary": "Push\u0020an\u0020item\u0020at\u0020the\u0020end\u0020of\u0020the\u0020list.",
"url": "classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_push" "url": "classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_push"
}, { }, {
"fqsen": "\\OCC\\Basics\\DataStructures\\Traits\\StrictSplDatastructureTrait\u003A\u003Aremove\u0028\u0029", "fqsen": "\\OCC\\Basics\\DataStructures\\Traits\\StrictSplDoublyLinkedListTrait\u003A\u003Aremove\u0028\u0029",
"name": "remove", "name": "remove",
"summary": "Remove\u0020an\u0020item\u0020from\u0020the\u0020list.", "summary": "Remove\u0020an\u0020item\u0020from\u0020the\u0020list.",
"url": "classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_remove" "url": "classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_remove"
}, { }, {
"fqsen": "\\OCC\\Basics\\DataStructures\\Traits\\StrictSplDatastructureTrait\u003A\u003Aset\u0028\u0029", "fqsen": "\\OCC\\Basics\\DataStructures\\Traits\\StrictSplDoublyLinkedListTrait\u003A\u003Aset\u0028\u0029",
"name": "set", "name": "set",
"summary": "Set\u0020an\u0020item\u0020at\u0020the\u0020specified\u0020index.", "summary": "Set\u0020an\u0020item\u0020at\u0020the\u0020specified\u0020index.",
"url": "classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_set" "url": "classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_set"
}, { }, {
"fqsen": "\\OCC\\Basics\\DataStructures\\Traits\\StrictSplDatastructureTrait\u003A\u003AtoArray\u0028\u0029", "fqsen": "\\OCC\\Basics\\DataStructures\\Traits\\StrictSplDoublyLinkedListTrait\u003A\u003AtoArray\u0028\u0029",
"name": "toArray", "name": "toArray",
"summary": "Return\u0020array\u0020representation\u0020of\u0020list.", "summary": "Return\u0020array\u0020representation\u0020of\u0020list.",
"url": "classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_toArray" "url": "classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_toArray"
}, { }, {
"fqsen": "\\OCC\\Basics\\DataStructures\\Traits\\StrictSplDatastructureTrait\u003A\u003AtoStrictCollection\u0028\u0029", "fqsen": "\\OCC\\Basics\\DataStructures\\Traits\\StrictSplDoublyLinkedListTrait\u003A\u003AtoStrictCollection\u0028\u0029",
"name": "toStrictCollection", "name": "toStrictCollection",
"summary": "Turn\u0020list\u0020into\u0020a\u0020type\u002Dsensitive\u0020collection.", "summary": "Turn\u0020list\u0020into\u0020a\u0020type\u002Dsensitive\u0020collection.",
"url": "classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_toStrictCollection" "url": "classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_toStrictCollection"
}, { }, {
"fqsen": "\\OCC\\Basics\\DataStructures\\Traits\\StrictSplDatastructureTrait\u003A\u003Aunshift\u0028\u0029", "fqsen": "\\OCC\\Basics\\DataStructures\\Traits\\StrictSplDoublyLinkedListTrait\u003A\u003Aunshift\u0028\u0029",
"name": "unshift", "name": "unshift",
"summary": "Prepend\u0020the\u0020list\u0020with\u0020an\u0020item.", "summary": "Prepend\u0020the\u0020list\u0020with\u0020an\u0020item.",
"url": "classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_unshift" "url": "classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method_unshift"
}, { }, {
"fqsen": "\\OCC\\Basics\\DataStructures\\Traits\\StrictSplDatastructureTrait\u003A\u003A__construct\u0028\u0029", "fqsen": "\\OCC\\Basics\\DataStructures\\Traits\\StrictSplDoublyLinkedListTrait\u003A\u003A__construct\u0028\u0029",
"name": "__construct", "name": "__construct",
"summary": "Create\u0020a\u0020type\u002Dsensitive,\u0020traversable\u0020list\u0020of\u0020items.", "summary": "Create\u0020a\u0020type\u002Dsensitive,\u0020traversable\u0020list\u0020of\u0020items.",
"url": "classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method___construct" "url": "classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html#method___construct"
}, { }, {
"fqsen": "\\OCC\\Basics\\ErrorHandlers\\ThrowErrorException", "fqsen": "\\OCC\\Basics\\ErrorHandlers\\ThrowErrorException",
"name": "ThrowErrorException", "name": "ThrowErrorException",

2
doc/namespaces/occ-basics-datastructures-traits.html
View File

@ -194,7 +194,7 @@
</h4> </h4>
<dl class="phpdocumentor-table-of-contents"> <dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -trait"><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html"><abbr title="\OCC\Basics\DataStructures\Traits\StrictSplDatastructureTrait">StrictSplDatastructureTrait</abbr></a></dt><dd>The common interface of all type-sensitive, SPL-based datastructures.</dd> </dl> <dt class="phpdocumentor-table-of-contents__entry -trait"><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html"><abbr title="\OCC\Basics\DataStructures\Traits\StrictSplDoublyLinkedListTrait">StrictSplDoublyLinkedListTrait</abbr></a></dt><dd>The common interface of all type-sensitive, SPL-based datastructures.</dd> </dl>

318
doc/namespaces/occ-basics-interfacetraits.html
View File

@ -1,318 +0,0 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>PHP Basics</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<base href="../">
<link rel="icon" href="images/favicon.ico"/>
<link rel="stylesheet" href="css/normalize.css">
<link rel="stylesheet" href="css/base.css">
<link rel="preconnect" href="https://fonts.gstatic.com">
<link href="https://fonts.googleapis.com/css2?family=Open+Sans:wght@100;200;300;400;600;700&display=swap" rel="stylesheet">
<link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet">
<link rel="stylesheet" href="css/template.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
<script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
<script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
<script src="js/template.js"></script>
<script src="js/search.js"></script>
<script defer src="js/searchIndex.js"></script>
</head>
<body id="top">
<header class="phpdocumentor-header phpdocumentor-section">
<h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">PHP Basics</a></h1>
<input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
<label class="phpdocumentor-header__menu-icon" for="menu-button">
<i class="fas fa-bars"></i>
</label>
<section data-search-form class="phpdocumentor-search">
<label>
<span class="visually-hidden">Search for</span>
<svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
<circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
<line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
</svg>
<input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
</label>
</section>
<nav class="phpdocumentor-topnav">
<ul class="phpdocumentor-topnav__menu">
<li class="phpdocumentor-topnav__menu-item -menu">
<a href="https://packagist.org/packages/opencultureconsulting/basics">
<span>
<i class="fab fa-php"></i>
</span>
</a>
</li>
<li class="phpdocumentor-topnav__menu-item -menu">
<a href="https://github.com/opencultureconsulting/php-basics">
<span>
<i class="fab fa-github"></i>
</span>
</a>
</li>
</ul>
</nav>
</header>
<main class="phpdocumentor">
<div class="phpdocumentor-section">
<input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
<label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
Menu
</label>
<aside class="phpdocumentor-column -three phpdocumentor-sidebar">
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Documentation</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="guides/installation/index.html#installation" class="">Installation</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="guides/installation/test.html#test" class="">Test</a>
</li>
</ul>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="guides/changelog/index.html#changelog" class="">Changelog</a>
</h4>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="namespaces/occ.html" class="">OCC</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="namespaces/occ-basics.html" class="">Basics</a>
</li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="packages/Basics.html" class="">Basics</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="packages/Basics-DataStructures.html" class="">DataStructures</a>
</li>
<li>
<a href="packages/Basics-ErrorHandlers.html" class="">ErrorHandlers</a>
</li>
<li>
<a href="packages/Basics-InterfaceTraits.html" class="">InterfaceTraits</a>
</li>
<li>
<a href="packages/Basics-Traits.html" class="">Traits</a>
</li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
</section>
</aside>
<div class="phpdocumentor-column -nine phpdocumentor-content">
<section>
<ul class="phpdocumentor-breadcrumbs">
<li class="phpdocumentor-breadcrumb"><a href="namespaces/occ.html">OCC</a></li>
<li class="phpdocumentor-breadcrumb"><a href="namespaces/occ-basics.html">Basics</a></li>
</ul>
<article class="phpdocumentor-element -namespace">
<h2 class="phpdocumentor-content__title">InterfaceTraits</h2>
<h3 id="toc">
Table of Contents
<a href="namespaces/occ-basics-interfacetraits.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<h4 id="toc-traits">
Traits
<a href="namespaces/occ-basics-interfacetraits.html#toc-traits" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -trait"><a href="classes/OCC-Basics-InterfaceTraits-ArrayAccessTrait.html"><abbr title="\OCC\Basics\InterfaceTraits\ArrayAccessTrait">ArrayAccessTrait</abbr></a></dt><dd>A generic implementation of the ArrayAccess interface.</dd> <dt class="phpdocumentor-table-of-contents__entry -trait"><a href="classes/OCC-Basics-InterfaceTraits-CountableTrait.html"><abbr title="\OCC\Basics\InterfaceTraits\CountableTrait">CountableTrait</abbr></a></dt><dd>A generic implementation of the Countable interface.</dd> <dt class="phpdocumentor-table-of-contents__entry -trait"><a href="classes/OCC-Basics-InterfaceTraits-IteratorAggregateTrait.html"><abbr title="\OCC\Basics\InterfaceTraits\IteratorAggregateTrait">IteratorAggregateTrait</abbr></a></dt><dd>A generic implementation of the IteratorAggregate interface.</dd> <dt class="phpdocumentor-table-of-contents__entry -trait"><a href="classes/OCC-Basics-InterfaceTraits-IteratorTrait.html"><abbr title="\OCC\Basics\InterfaceTraits\IteratorTrait">IteratorTrait</abbr></a></dt><dd>A generic implementation of the Iterator interface.</dd> </dl>
<div class="phpdocumentor-modal" id="source-view">
<div class="phpdocumentor-modal-bg" data-exit-button></div>
<div class="phpdocumentor-modal-container">
<div class="phpdocumentor-modal-content">
<pre style="max-height: 500px; overflow-y: scroll" data-src="" class="language-php line-numbers linkable-line-numbers"></pre>
</div>
<button data-exit-button class="phpdocumentor-modal__close">&times;</button>
</div>
</div>
<script type="text/javascript">
(function () {
function loadExternalCodeSnippet(el, url, line) {
Array.prototype.slice.call(el.querySelectorAll('pre[data-src]')).forEach((pre) => {
const src = url || pre.getAttribute('data-src').replace(/\\/g, '/');
const language = 'php';
const code = document.createElement('code');
code.className = 'language-' + language;
pre.textContent = '';
pre.setAttribute('data-line', line)
code.textContent = 'Loading…';
pre.appendChild(code);
var xhr = new XMLHttpRequest();
xhr.open('GET', src, true);
xhr.onreadystatechange = function () {
if (xhr.readyState !== 4) {
return;
}
if (xhr.status < 400 && xhr.responseText) {
code.textContent = xhr.responseText;
Prism.highlightElement(code);
return;
}
if (xhr.status === 404) {
code.textContent = '✖ Error: File could not be found';
return;
}
if (xhr.status >= 400) {
code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
return;
}
code.textContent = '✖ Error: An unknown error occurred';
};
xhr.send(null);
});
}
const modalButtons = document.querySelectorAll("[data-modal]");
const openedAsLocalFile = window.location.protocol === 'file:';
if (modalButtons.length > 0 && openedAsLocalFile) {
console.warn(
'Viewing the source code is unavailable because you are opening this page from the file:// scheme; ' +
'browsers block XHR requests when a page is opened this way'
);
}
modalButtons.forEach(function (trigger) {
if (openedAsLocalFile) {
trigger.setAttribute("hidden", "hidden");
}
trigger.addEventListener("click", function (event) {
event.preventDefault();
const modal = document.getElementById(trigger.dataset.modal);
if (!modal) {
console.error(`Modal with id "${trigger.dataset.modal}" could not be found`);
return;
}
modal.classList.add("phpdocumentor-modal__open");
loadExternalCodeSnippet(modal, trigger.dataset.src || null, trigger.dataset.line)
const exits = modal.querySelectorAll("[data-exit-button]");
exits.forEach(function (exit) {
exit.addEventListener("click", function (event) {
event.preventDefault();
modal.classList.remove("phpdocumentor-modal__open");
});
});
});
});
})();
</script>
</article>
</section>
<section class="phpdocumentor-on-this-page__sidebar">
<section class="phpdocumentor-on-this-page__content">
<strong class="phpdocumentor-on-this-page__title">On this page</strong>
<ul class="phpdocumentor-list -clean">
<li class="phpdocumentor-on-this-page-section__title">Table Of Contents</li>
<li>
<ul class="phpdocumentor-list -clean">
<li><a href="namespaces/occ-basics-interfacetraits.html#toc-traits">Traits</a></li>
</ul>
</li>
</ul>
</section>
</section>
</div>
<section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
<section class="phpdocumentor-search-results__dialog">
<header class="phpdocumentor-search-results__header">
<h2 class="phpdocumentor-search-results__title">Search results</h2>
<button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
</header>
<section class="phpdocumentor-search-results__body">
<ul class="phpdocumentor-search-results__entries"></ul>
</section>
</section>
</section>
</div>
<a href="namespaces/occ-basics-interfacetraits.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
</main>
<script>
cssVars({});
</script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
</body>
</html>

2
doc/packages/Basics-DataStructures.html
View File

@ -199,7 +199,7 @@
</h4> </h4>
<dl class="phpdocumentor-table-of-contents"> <dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -trait"><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html"><abbr title="\OCC\Basics\DataStructures\Traits\StrictSplDatastructureTrait">StrictSplDatastructureTrait</abbr></a></dt><dd>The common interface of all type-sensitive, SPL-based datastructures.</dd> </dl> <dt class="phpdocumentor-table-of-contents__entry -trait"><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDoublyLinkedListTrait.html"><abbr title="\OCC\Basics\DataStructures\Traits\StrictSplDoublyLinkedListTrait">StrictSplDoublyLinkedListTrait</abbr></a></dt><dd>The common interface of all type-sensitive, SPL-based datastructures.</dd> </dl>

317
doc/packages/Basics-InterfaceTraits.html
View File

@ -1,317 +0,0 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>PHP Basics</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<base href="../">
<link rel="icon" href="images/favicon.ico"/>
<link rel="stylesheet" href="css/normalize.css">
<link rel="stylesheet" href="css/base.css">
<link rel="preconnect" href="https://fonts.gstatic.com">
<link href="https://fonts.googleapis.com/css2?family=Open+Sans:wght@100;200;300;400;600;700&display=swap" rel="stylesheet">
<link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet">
<link rel="stylesheet" href="css/template.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
<script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
<script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
<script src="js/template.js"></script>
<script src="js/search.js"></script>
<script defer src="js/searchIndex.js"></script>
</head>
<body id="top">
<header class="phpdocumentor-header phpdocumentor-section">
<h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">PHP Basics</a></h1>
<input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
<label class="phpdocumentor-header__menu-icon" for="menu-button">
<i class="fas fa-bars"></i>
</label>
<section data-search-form class="phpdocumentor-search">
<label>
<span class="visually-hidden">Search for</span>
<svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
<circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
<line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
</svg>
<input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
</label>
</section>
<nav class="phpdocumentor-topnav">
<ul class="phpdocumentor-topnav__menu">
<li class="phpdocumentor-topnav__menu-item -menu">
<a href="https://packagist.org/packages/opencultureconsulting/basics">
<span>
<i class="fab fa-php"></i>
</span>
</a>
</li>
<li class="phpdocumentor-topnav__menu-item -menu">
<a href="https://github.com/opencultureconsulting/php-basics">
<span>
<i class="fab fa-github"></i>
</span>
</a>
</li>
</ul>
</nav>
</header>
<main class="phpdocumentor">
<div class="phpdocumentor-section">
<input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
<label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
Menu
</label>
<aside class="phpdocumentor-column -three phpdocumentor-sidebar">
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Documentation</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="guides/installation/index.html#installation" class="">Installation</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="guides/installation/test.html#test" class="">Test</a>
</li>
</ul>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="guides/changelog/index.html#changelog" class="">Changelog</a>
</h4>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="namespaces/occ.html" class="">OCC</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="namespaces/occ-basics.html" class="">Basics</a>
</li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="packages/Basics.html" class="">Basics</a>
</h4>
<ul class="phpdocumentor-list">
<li>
<a href="packages/Basics-DataStructures.html" class="">DataStructures</a>
</li>
<li>
<a href="packages/Basics-ErrorHandlers.html" class="">ErrorHandlers</a>
</li>
<li>
<a href="packages/Basics-InterfaceTraits.html" class="-active">InterfaceTraits</a>
</li>
<li>
<a href="packages/Basics-Traits.html" class="">Traits</a>
</li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
</section>
</aside>
<div class="phpdocumentor-column -nine phpdocumentor-content">
<section>
<ul class="phpdocumentor-breadcrumbs">
<li class="phpdocumentor-breadcrumb"><a href="packages/Basics.html">Basics</a></li>
</ul>
<article class="phpdocumentor-element -package">
<h2 class="phpdocumentor-content__title">InterfaceTraits</h2>
<h3 id="toc">
Table of Contents
<a href="packages/Basics-InterfaceTraits.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<h4 id="toc-traits">
Traits
<a href="packages/Basics-InterfaceTraits.html#toc-traits" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -trait"><a href="classes/OCC-Basics-InterfaceTraits-ArrayAccessTrait.html"><abbr title="\OCC\Basics\InterfaceTraits\ArrayAccessTrait">ArrayAccessTrait</abbr></a></dt><dd>A generic implementation of the ArrayAccess interface.</dd> <dt class="phpdocumentor-table-of-contents__entry -trait"><a href="classes/OCC-Basics-InterfaceTraits-CountableTrait.html"><abbr title="\OCC\Basics\InterfaceTraits\CountableTrait">CountableTrait</abbr></a></dt><dd>A generic implementation of the Countable interface.</dd> <dt class="phpdocumentor-table-of-contents__entry -trait"><a href="classes/OCC-Basics-InterfaceTraits-IteratorAggregateTrait.html"><abbr title="\OCC\Basics\InterfaceTraits\IteratorAggregateTrait">IteratorAggregateTrait</abbr></a></dt><dd>A generic implementation of the IteratorAggregate interface.</dd> <dt class="phpdocumentor-table-of-contents__entry -trait"><a href="classes/OCC-Basics-InterfaceTraits-IteratorTrait.html"><abbr title="\OCC\Basics\InterfaceTraits\IteratorTrait">IteratorTrait</abbr></a></dt><dd>A generic implementation of the Iterator interface.</dd> </dl>
<div class="phpdocumentor-modal" id="source-view">
<div class="phpdocumentor-modal-bg" data-exit-button></div>
<div class="phpdocumentor-modal-container">
<div class="phpdocumentor-modal-content">
<pre style="max-height: 500px; overflow-y: scroll" data-src="" class="language-php line-numbers linkable-line-numbers"></pre>
</div>
<button data-exit-button class="phpdocumentor-modal__close">&times;</button>
</div>
</div>
<script type="text/javascript">
(function () {
function loadExternalCodeSnippet(el, url, line) {
Array.prototype.slice.call(el.querySelectorAll('pre[data-src]')).forEach((pre) => {
const src = url || pre.getAttribute('data-src').replace(/\\/g, '/');
const language = 'php';
const code = document.createElement('code');
code.className = 'language-' + language;
pre.textContent = '';
pre.setAttribute('data-line', line)
code.textContent = 'Loading…';
pre.appendChild(code);
var xhr = new XMLHttpRequest();
xhr.open('GET', src, true);
xhr.onreadystatechange = function () {
if (xhr.readyState !== 4) {
return;
}
if (xhr.status < 400 && xhr.responseText) {
code.textContent = xhr.responseText;
Prism.highlightElement(code);
return;
}
if (xhr.status === 404) {
code.textContent = '✖ Error: File could not be found';
return;
}
if (xhr.status >= 400) {
code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
return;
}
code.textContent = '✖ Error: An unknown error occurred';
};
xhr.send(null);
});
}
const modalButtons = document.querySelectorAll("[data-modal]");
const openedAsLocalFile = window.location.protocol === 'file:';
if (modalButtons.length > 0 && openedAsLocalFile) {
console.warn(
'Viewing the source code is unavailable because you are opening this page from the file:// scheme; ' +
'browsers block XHR requests when a page is opened this way'
);
}
modalButtons.forEach(function (trigger) {
if (openedAsLocalFile) {
trigger.setAttribute("hidden", "hidden");
}
trigger.addEventListener("click", function (event) {
event.preventDefault();
const modal = document.getElementById(trigger.dataset.modal);
if (!modal) {
console.error(`Modal with id "${trigger.dataset.modal}" could not be found`);
return;
}
modal.classList.add("phpdocumentor-modal__open");
loadExternalCodeSnippet(modal, trigger.dataset.src || null, trigger.dataset.line)
const exits = modal.querySelectorAll("[data-exit-button]");
exits.forEach(function (exit) {
exit.addEventListener("click", function (event) {
event.preventDefault();
modal.classList.remove("phpdocumentor-modal__open");
});
});
});
});
})();
</script>
</article>
</section>
<section class="phpdocumentor-on-this-page__sidebar">
<section class="phpdocumentor-on-this-page__content">
<strong class="phpdocumentor-on-this-page__title">On this page</strong>
<ul class="phpdocumentor-list -clean">
<li class="phpdocumentor-on-this-page-section__title">Table Of Contents</li>
<li>
<ul class="phpdocumentor-list -clean">
<li><a href="packages/Basics-InterfaceTraits.html#toc-traits">Traits</a></li>
</ul>
</li>
</ul>
</section>
</section>
</div>
<section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
<section class="phpdocumentor-search-results__dialog">
<header class="phpdocumentor-search-results__header">
<h2 class="phpdocumentor-search-results__title">Search results</h2>
<button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
</header>
<section class="phpdocumentor-search-results__body">
<ul class="phpdocumentor-search-results__entries"></ul>
</section>
</section>
</section>
</div>
<a href="packages/Basics-InterfaceTraits.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
</main>
<script>
cssVars({});
</script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
</body>
</html>