sebastian-meyer
/
php-basics
mirror of https://github.com/opencultureconsulting/php-basics.git
2
0
Fork 0
Code Issues
php-basics/doc/classes/OCC-Basics-DataStructures-S...

1487 lines
80 KiB
HTML
Raw Permalink Normal View History

Update API documentation
2024-02-12 17:21:57 +01:00
<!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">
Update documentation
2024-02-15 11:13:57 +01:00
<section class="phpdocumentor-sidebar__category -documentation">
<h2 class="phpdocumentor-sidebar__category-header">Documentation</h2>
Update API documentation
2024-02-12 17:21:57 +01:00
<h4 class="phpdocumentor-sidebar__root-namespace">
Update documentation
2024-02-15 11:13:57 +01:00
<a href="guides/overview/index.html#overview" class="">Overview</a>
</h4>
Update documentation
2024-03-26 20:10:30 +01:00
<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>
Update documentation
2024-02-15 11:13:57 +01:00
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="guides/usage/index.html#user-guide" class="">User Guide</a>
Update API documentation
2024-02-12 17:21:57 +01:00
</h4>
<ul class="phpdocumentor-list">
<li>
Update documentation
2024-02-15 11:13:57 +01:00
<a href="guides/usage/requirements.html#requirements" class="">Requirements</a>
</li>
<li>
<a href="guides/usage/installation.html#installation" class="">Installation</a>
Update API documentation
2024-02-12 17:21:57 +01:00
</li>
</ul>
<h4 class="phpdocumentor-sidebar__root-namespace">
Update documentation
2024-02-15 11:13:57 +01:00
<a href="guides/changelog.html#changelog" class="">Changelog</a>
Update API documentation
2024-02-12 17:21:57 +01:00
</h4>
</section>
Update documentation
2024-02-15 11:13:57 +01:00
<section class="phpdocumentor-sidebar__category -namespaces">
Update API documentation
2024-02-12 17:21:57 +01:00
<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>
Update documentation
2024-02-15 11:13:57 +01:00
<section class="phpdocumentor-sidebar__category -packages">
Update API documentation
2024-02-12 17:21:57 +01:00
<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>
Update documentation
2024-02-15 11:13:57 +01:00
<section class="phpdocumentor-sidebar__category -reports">
Update API documentation
2024-02-12 17:21:57 +01:00
<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>
Update documentation
2024-02-19 14:52:57 +01:00
<section class="phpdocumentor-sidebar__category -indices">
<h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
Update API documentation
2024-02-12 17:21:57 +01:00
<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-datastructures.html">DataStructures</a></li>
</ul>
<article class="phpdocumentor-element -class">
<h2 class="phpdocumentor-content__title">
StrictQueue
<span class="phpdocumentor-element__extends">
Update documentation
2024-03-26 20:10:30 +01:00
extends <abbr title="\SplQueue">SplQueue</abbr>
Update API documentation
2024-02-12 17:21:57 +01:00
</span>
<div class="phpdocumentor-element__package">
in package
<ul class="phpdocumentor-breadcrumbs">
<li class="phpdocumentor-breadcrumb"><a href="packages/Basics.html">Basics</a></li>
<li class="phpdocumentor-breadcrumb"><a href="packages/Basics-DataStructures.html">DataStructures</a></li>
</ul>
</div>
Update documentation
2024-03-26 20:10:30 +01:00
<span class="phpdocumentor-element__extends">
Uses
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html"><abbr title="\OCC\Basics\DataStructures\Traits\StrictSplDatastructureTrait">StrictSplDatastructureTrait</abbr></a> </span>
Update API documentation
2024-02-12 17:21:57 +01:00
</h2>
<div class="phpdocumentor-label-line">
</div>
<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>
:
Update documentation
2024-03-26 20:10:30 +01:00
<span class="phpdocumentor-element-found-in__line">45</span>
Update API documentation
2024-02-12 17:21:57 +01:00
Update documentation
2024-03-26 20:10:30 +01:00
<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>
Update API documentation
2024-02-12 17:21:57 +01:00
</aside>
<p class="phpdocumentor-summary">A type-sensitive, taversable queue (FIFO).</p>
Update documentation
2024-03-26 20:10:30 +01:00
<section class="phpdocumentor-description"><p>Extends <a href="https://www.php.net/splqueue">\SplQueue</a> with an option to restrict
the allowed data types for list items by providing the constructor with an
array of atomic types or fully qualified class names.</p>
Update API documentation
2024-02-12 17:21:57 +01:00
</section>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/OCC-Basics-DataStructures-StrictQueue.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>AllowedType of mixed</p>
</section>
</dd>
</dl>
<h3 id="toc">
Table of Contents
<a href="classes/OCC-Basics-DataStructures-StrictQueue.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<h4 id="toc-methods">
Methods
<a href="classes/OCC-Basics-DataStructures-StrictQueue.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">
Update documentation
2024-03-26 20:10:30 +01:00
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method___construct">__construct()</a>
Update API documentation
2024-02-12 17:21:57 +01:00
<span>
&nbsp;: void </span>
</dt>
Update documentation
2024-03-26 20:10:30 +01:00
<dd>Create a type-sensitive, traversable list of items.</dd>
Update API documentation
2024-02-12 17:21:57 +01:00
<dt class="phpdocumentor-table-of-contents__entry -method -public">
Update documentation
2024-03-26 20:10:30 +01:00
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_add">add()</a>
Update API documentation
2024-02-12 17:21:57 +01:00
<span>
&nbsp;: void </span>
</dt>
<dd>Add/insert a new item at the specified offset.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
Update documentation
2024-03-26 20:10:30 +01:00
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_append">append()</a>
Update API documentation
2024-02-12 17:21:57 +01:00
<span>
&nbsp;: void </span>
</dt>
<dd>Append items at the end of the list.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
Update documentation
2024-03-26 20:10:30 +01:00
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_clear">clear()</a>
Update API documentation
2024-02-12 17:21:57 +01:00
<span>
&nbsp;: void </span>
</dt>
<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_enqueue">enqueue()</a>
<span>
&nbsp;: void </span>
</dt>
<dd>Add an item to the queue.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
Update documentation
2024-03-26 20:10:30 +01:00
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_get">get()</a>
Update API documentation
2024-02-12 17:21:57 +01:00
<span>
Update documentation
2024-03-26 20:10:30 +01:00
&nbsp;: <abbr title="\OCC\Basics\DataStructures\Traits\AllowedType">AllowedType</abbr> </span>
Update API documentation
2024-02-12 17:21:57 +01:00
</dt>
<dd>Get the item at the specified index.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
Update documentation
2024-03-26 20:10:30 +01:00
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_isList">isList()</a>
Update API documentation
2024-02-12 17:21:57 +01:00
<span>
&nbsp;: true </span>
</dt>
<dd>Check if this can be considered a list.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
Update documentation
2024-03-26 20:10:30 +01:00
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_offsetSet">offsetSet()</a>
Update API documentation
2024-02-12 17:21:57 +01:00
<span>
&nbsp;: void </span>
</dt>
<dd>Set the item at the specified offset.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
Update documentation
2024-03-26 20:10:30 +01:00
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_prepend">prepend()</a>
Update API documentation
2024-02-12 17:21:57 +01:00
<span>
&nbsp;: void </span>
</dt>
<dd>Prepend items at the start of the list.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
Update documentation
2024-03-26 20:10:30 +01:00
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_push">push()</a>
Update API documentation
2024-02-12 17:21:57 +01:00
<span>
&nbsp;: void </span>
</dt>
<dd>Push an item at the end of the list.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
Update documentation
2024-03-26 20:10:30 +01:00
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_remove">remove()</a>
Update API documentation
2024-02-12 17:21:57 +01:00
<span>
&nbsp;: void </span>
</dt>
<dd>Remove an item from the list.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
Update documentation
2024-03-26 20:10:30 +01:00
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_set">set()</a>
Update API documentation
2024-02-12 17:21:57 +01:00
<span>
&nbsp;: void </span>
</dt>
<dd>Set an item at the specified index.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
Update documentation
2024-03-26 20:10:30 +01:00
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_toArray">toArray()</a>
Update API documentation
2024-02-12 17:21:57 +01:00
<span>
Update documentation
2024-03-26 20:10:30 +01:00
&nbsp;: array&lt;int, <abbr title="\OCC\Basics\DataStructures\Traits\AllowedType">AllowedType</abbr>&gt; </span>
Update API documentation
2024-02-12 17:21:57 +01:00
</dt>
<dd>Return array representation of list.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
Update documentation
2024-03-26 20:10:30 +01:00
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_toStrictCollection">toStrictCollection()</a>
Update API documentation
2024-02-12 17:21:57 +01:00
<span>
Update documentation
2024-03-26 20:10:30 +01:00
&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>
Update API documentation
2024-02-12 17:21:57 +01:00
</dt>
<dd>Turn list into a type-sensitive collection.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
Update documentation
2024-03-26 20:10:30 +01:00
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_unshift">unshift()</a>
Update API documentation
2024-02-12 17:21:57 +01:00
<span>
&nbsp;: void </span>
</dt>
<dd>Prepend the list with an item.</dd>
</dl>
<section class="phpdocumentor-methods">
<h3 class="phpdocumentor-elements__header" id="methods">
Methods
<a href="classes/OCC-Basics-DataStructures-StrictQueue.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___construct">
__construct()
Update documentation
2024-03-26 20:10:30 +01:00
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
Update API documentation
2024-02-12 17:21:57 +01:00
</h4>
<aside class="phpdocumentor-element-found-in">
Update documentation
2024-03-26 20:10:30 +01:00
<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>
Update API documentation
2024-02-12 17:21:57 +01:00
:
Add new datastructure StrictArray
2024-03-27 12:19:43 +01:00
<span class="phpdocumentor-element-found-in__line">368</span>
Update API documentation
2024-02-12 17:21:57 +01:00
Add new datastructure StrictArray
2024-03-27 12:19:43 +01:00
<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>
Update API documentation
2024-02-12 17:21:57 +01:00
</aside>
Update documentation
2024-03-26 20:10:30 +01:00
<p class="phpdocumentor-summary">Create a type-sensitive, traversable list of items.</p>
Update API documentation
2024-02-12 17:21:57 +01:00
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">__construct</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, string&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$allowedTypes</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">[]</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<div class="phpdocumentor-label-line">
</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">$allowedTypes</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, string&gt;</span>
= <span class="phpdocumentor-signature__argument__default-value">[]</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Allowed data types of items (optional)</p>
<p>If empty, all types are allowed.
Possible values are:</p>
<ul>
<li>&quot;array&quot;</li>
<li>&quot;bool&quot;</li>
<li>&quot;callable&quot;</li>
<li>&quot;countable&quot;</li>
<li>&quot;float&quot; or &quot;double&quot;</li>
<li>&quot;int&quot; or &quot;integer&quot; or &quot;long&quot;</li>
<li>&quot;iterable&quot;</li>
<li>&quot;null&quot;</li>
<li>&quot;numeric&quot;</li>
<li>&quot;object&quot; or FQCN</li>
<li>&quot;resource&quot;</li>
<li>&quot;scalar&quot;</li>
<li>&quot;string&quot;</li>
</ul>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
Update documentation
2024-03-26 20:10:30 +01:00
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method___construct#tags" class="headerlink"><i class="fas fa-link"></i></a>
Update API documentation
2024-02-12 17:21:57 +01:00
</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="\InvalidArgumentException">InvalidArgumentException</abbr></span>
<section class="phpdocumentor-description"><p>if any value of <code class="prettyprint">$allowedTypes</code> is not a string</p>
</section>
</dd>
</dl>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_add">
add()
Update documentation
2024-03-26 20:10:30 +01:00
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_add" class="headerlink"><i class="fas fa-link"></i></a>
Update API documentation
2024-02-12 17:21:57 +01:00
</h4>
<aside class="phpdocumentor-element-found-in">
Update documentation
2024-03-26 20:10:30 +01:00
<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>
Update API documentation
2024-02-12 17:21:57 +01:00
:
Add new datastructure StrictArray
2024-03-27 12:19:43 +01:00
<span class="phpdocumentor-element-found-in__line">71</span>
Update API documentation
2024-02-12 17:21:57 +01:00
Add new datastructure StrictArray
2024-03-27 12:19:43 +01:00
<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>
Update API documentation
2024-02-12 17:21:57 +01:00
</aside>
<p class="phpdocumentor-summary">Add/insert a new item at the specified offset.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
Update documentation
2024-03-26 20:10:30 +01:00
<span class="phpdocumentor-signature__name">add</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&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\DataStructures\Traits\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>
Update API documentation
2024-02-12 17:21:57 +01:00
<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">int</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The offset where the new item is to be inserted</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$value</span>
Update documentation
2024-03-26 20:10:30 +01:00
: <span class="phpdocumentor-signature__argument__return-type"><abbr title="\OCC\Basics\DataStructures\Traits\AllowedType">AllowedType</abbr></span>
Update API documentation
2024-02-12 17:21:57 +01:00
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The new item for the offset</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
Update documentation
2024-03-26 20:10:30 +01:00
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_add#tags" class="headerlink"><i class="fas fa-link"></i></a>
Update API documentation
2024-02-12 17:21:57 +01:00
</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">
Update documentation
2024-03-26 20:10:30 +01:00
<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>
Update API documentation
2024-02-12 17:21:57 +01:00
<section class="phpdocumentor-description"><p>if <code class="prettyprint">$value</code> is not of allowed type</p>
</section>
</dd>
<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="\OutOfRangeException">OutOfRangeException</abbr></span>
<section class="phpdocumentor-description"><p>when <code class="prettyprint">$offset</code> is out of bounds</p>
</section>
</dd>
</dl>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_append">
append()
Update documentation
2024-03-26 20:10:30 +01:00
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_append" class="headerlink"><i class="fas fa-link"></i></a>
Update API documentation
2024-02-12 17:21:57 +01:00
</h4>
<aside class="phpdocumentor-element-found-in">
Update documentation
2024-03-26 20:10:30 +01:00
<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>
Update API documentation
2024-02-12 17:21:57 +01:00
:
Add new datastructure StrictArray
2024-03-27 12:19:43 +01:00
<span class="phpdocumentor-element-found-in__line">87</span>
Update API documentation
2024-02-12 17:21:57 +01:00
Add new datastructure StrictArray
2024-03-27 12:19:43 +01:00
<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>
Update API documentation
2024-02-12 17:21:57 +01:00
</aside>
<p class="phpdocumentor-summary">Append items at the end of the list.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
Update documentation
2024-03-26 20:10:30 +01:00
<span class="phpdocumentor-signature__name">append</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><abbr title="\OCC\Basics\DataStructures\Traits\AllowedType">AllowedType</abbr>&nbsp;</span><span class="phpdocumentor-signature__argument__variadic-operator">...</span><span class="phpdocumentor-signature__argument__name">$values</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
Update API documentation
2024-02-12 17:21:57 +01:00
<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">$values</span>
Update documentation
2024-03-26 20:10:30 +01:00
: <span class="phpdocumentor-signature__argument__return-type"><abbr title="\OCC\Basics\DataStructures\Traits\AllowedType">AllowedType</abbr></span>
Update API documentation
2024-02-12 17:21:57 +01:00
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>One or more items to append</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
Update documentation
2024-03-26 20:10:30 +01:00
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_append#tags" class="headerlink"><i class="fas fa-link"></i></a>
Update API documentation
2024-02-12 17:21:57 +01:00
</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">
Update documentation
2024-03-26 20:10:30 +01:00
<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>
Update API documentation
2024-02-12 17:21:57 +01:00
<section class="phpdocumentor-description"><p>if any <code class="prettyprint">$values</code> is not of allowed type</p>
</section>
</dd>
</dl>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
Update documentation
2024-03-26 20:10:30 +01:00
<h4 class="phpdocumentor-element__name" id="method_clear">
clear()
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_clear" class="headerlink"><i class="fas fa-link"></i></a>
Update API documentation
2024-02-12 17:21:57 +01:00
</h4>
<aside class="phpdocumentor-element-found-in">
Update documentation
2024-03-26 20:10:30 +01:00
<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>
Update API documentation
2024-02-12 17:21:57 +01:00
:
Add new datastructure StrictArray
2024-03-27 12:19:43 +01:00
<span class="phpdocumentor-element-found-in__line">113</span>
Update API documentation
2024-02-12 17:21:57 +01:00
Add new datastructure StrictArray
2024-03-27 12:19:43 +01:00
<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>
Update API documentation
2024-02-12 17:21:57 +01:00
</aside>
Update documentation
2024-03-26 20:10:30 +01:00
<p class="phpdocumentor-summary">Clear the list of any items.</p>
Update API documentation
2024-02-12 17:21:57 +01:00
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
Update documentation
2024-03-26 20:10:30 +01:00
<span class="phpdocumentor-signature__name">clear</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
Update API documentation
2024-02-12 17:21:57 +01:00
<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_enqueue">
enqueue()
<a href="classes/OCC-Basics-DataStructures-StrictQueue.html#method_enqueue" 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>
:
Update documentation
2024-03-26 20:10:30 +01:00
<span class="phpdocumentor-element-found-in__line">61</span>
Update API documentation
2024-02-12 17:21:57 +01:00
Update documentation
2024-03-26 20:10:30 +01:00
<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>
Update API documentation
2024-02-12 17:21:57 +01:00
</aside>
<p class="phpdocumentor-summary">Add an item to the queue.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">enqueue</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 enqueue</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/OCC-Basics-DataStructures-StrictQueue.html#method_enqueue#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">
Update documentation
2024-03-26 20:10:30 +01:00
<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>
Update API documentation
2024-02-12 17:21:57 +01:00
<section class="phpdocumentor-description"><p>if <code class="prettyprint">$value</code> is not of allowed type</p>
</section>
</dd>
</dl>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_get">
get()
Update documentation
2024-03-26 20:10:30 +01:00
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_get" class="headerlink"><i class="fas fa-link"></i></a>
Update API documentation
2024-02-12 17:21:57 +01:00
</h4>
<aside class="phpdocumentor-element-found-in">
Update documentation
2024-03-26 20:10:30 +01:00
<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>
Update API documentation
2024-02-12 17:21:57 +01:00
:
Add new datastructure StrictArray
2024-03-27 12:19:43 +01:00
<span class="phpdocumentor-element-found-in__line">132</span>
Update API documentation
2024-02-12 17:21:57 +01:00
Add new datastructure StrictArray
2024-03-27 12:19:43 +01:00
<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>
Update API documentation
2024-02-12 17:21:57 +01:00
</aside>
<p class="phpdocumentor-summary">Get the item at the specified index.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
Update documentation
2024-03-26 20:10:30 +01:00
<span class="phpdocumentor-signature__name">get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">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\DataStructures\Traits\AllowedType">AllowedType</abbr></span></code>
Update API documentation
2024-02-12 17:21:57 +01:00
<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">int</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The item's index</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
Update documentation
2024-03-26 20:10:30 +01:00
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_get#tags" class="headerlink"><i class="fas fa-link"></i></a>
Update API documentation
2024-02-12 17:21:57 +01:00
</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="\OutOfRangeException">OutOfRangeException</abbr></span>
<section class="phpdocumentor-description"><p>when <code class="prettyprint">$offset</code> is out of bounds</p>
</section>
</dd>
</dl>
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
Update documentation
2024-03-26 20:10:30 +01:00
<span class="phpdocumentor-signature__response_type"><abbr title="\OCC\Basics\DataStructures\Traits\AllowedType">AllowedType</abbr></span>
Update API documentation
2024-02-12 17:21:57 +01:00
&mdash;
<section class="phpdocumentor-description"><p>The item</p>
</section>
Update documentation
2024-03-26 20:10:30 +01:00
</section>
Update API documentation
2024-02-12 17:21:57 +01:00
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
Update documentation
2024-03-26 20:10:30 +01:00
<h4 class="phpdocumentor-element__name" id="method_isList">
isList()
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_isList" class="headerlink"><i class="fas fa-link"></i></a>
Update API documentation
2024-02-12 17:21:57 +01:00
</h4>
<aside class="phpdocumentor-element-found-in">
Update documentation
2024-03-26 20:10:30 +01:00
<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>
Update API documentation
2024-02-12 17:21:57 +01:00
:
Add new datastructure StrictArray
2024-03-27 12:19:43 +01:00
<span class="phpdocumentor-element-found-in__line">144</span>
Update API documentation
2024-02-12 17:21:57 +01:00
Add new datastructure StrictArray
2024-03-27 12:19:43 +01:00
<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>
Update API documentation
2024-02-12 17:21:57 +01:00
</aside>
Update documentation
2024-03-26 20:10:30 +01:00
<p class="phpdocumentor-summary">Check if this can be considered a list.</p>
Update API documentation
2024-02-12 17:21:57 +01:00
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
Update documentation
2024-03-26 20:10:30 +01:00
<span class="phpdocumentor-signature__name">isList</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">true</span></code>
Update API documentation
2024-02-12 17:21:57 +01:00
<div class="phpdocumentor-label-line">
<div class="phpdocumentor-label phpdocumentor-label--success"><span>API</span><span>Yes</span></div>
</div>
Update documentation
2024-03-26 20:10:30 +01:00
<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">true</span>
&mdash;
<section class="phpdocumentor-description"><p>Always TRUE (this exists only for compatibility reasons)</p>
</section>
</section>
Update API documentation
2024-02-12 17:21:57 +01:00
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
Update documentation
2024-03-26 20:10:30 +01:00
<h4 class="phpdocumentor-element__name" id="method_offsetSet">
offsetSet()
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_offsetSet" class="headerlink"><i class="fas fa-link"></i></a>
Update API documentation
2024-02-12 17:21:57 +01:00
</h4>
<aside class="phpdocumentor-element-found-in">
Update documentation
2024-03-26 20:10:30 +01:00
<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>
Update API documentation
2024-02-12 17:21:57 +01:00
:
Add new datastructure StrictArray
2024-03-27 12:19:43 +01:00
<span class="phpdocumentor-element-found-in__line">162</span>
Update API documentation
2024-02-12 17:21:57 +01:00
Add new datastructure StrictArray
2024-03-27 12:19:43 +01:00
<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>
Update API documentation
2024-02-12 17:21:57 +01:00
</aside>
Update documentation
2024-03-26 20:10:30 +01:00
<p class="phpdocumentor-summary">Set the item at the specified offset.</p>
Update API documentation
2024-02-12 17:21:57 +01:00
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
Update documentation
2024-03-26 20:10:30 +01:00
<span class="phpdocumentor-signature__name">offsetSet</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">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\DataStructures\Traits\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>
Update API documentation
2024-02-12 17:21:57 +01:00
<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>
Update documentation
2024-03-26 20:10:30 +01:00
: <span class="phpdocumentor-signature__argument__return-type">int|null</span>
Update API documentation
2024-02-12 17:21:57 +01:00
</dt>
<dd class="phpdocumentor-argument-list__definition">
Update documentation
2024-03-26 20:10:30 +01:00
<section class="phpdocumentor-description"><p>The offset being set or NULL to append</p>
Update API documentation
2024-02-12 17:21:57 +01:00
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$value</span>
Update documentation
2024-03-26 20:10:30 +01:00
: <span class="phpdocumentor-signature__argument__return-type"><abbr title="\OCC\Basics\DataStructures\Traits\AllowedType">AllowedType</abbr></span>
Update API documentation
2024-02-12 17:21:57 +01:00
</dt>
<dd class="phpdocumentor-argument-list__definition">
Update documentation
2024-03-26 20:10:30 +01:00
<section class="phpdocumentor-description"><p>The new item for the offset</p>
Update API documentation
2024-02-12 17:21:57 +01:00
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
Update documentation
2024-03-26 20:10:30 +01:00
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_offsetSet#tags" class="headerlink"><i class="fas fa-link"></i></a>
Update API documentation
2024-02-12 17:21:57 +01:00
</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">
Update documentation
2024-03-26 20:10:30 +01:00
<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>
Update API documentation
2024-02-12 17:21:57 +01:00
<section class="phpdocumentor-description"><p>if <code class="prettyprint">$value</code> is not of allowed type</p>
</section>
Update documentation
2024-03-26 20:10:30 +01:00
</dd>
<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="\OutOfRangeException">OutOfRangeException</abbr></span>
<section class="phpdocumentor-description"><p>when <code class="prettyprint">$offset</code> is out of bounds</p>
</section>
Update API documentation
2024-02-12 17:21:57 +01:00
</dd>
</dl>
</article>
<article
class="phpdocumentor-element
-method
-public
Update documentation
2024-03-26 20:10:30 +01:00
"
Update API documentation
2024-02-12 17:21:57 +01:00
>
Update documentation
2024-03-26 20:10:30 +01:00
<h4 class="phpdocumentor-element__name" id="method_prepend">
prepend()
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_prepend" class="headerlink"><i class="fas fa-link"></i></a>
Update API documentation
2024-02-12 17:21:57 +01:00
</h4>
<aside class="phpdocumentor-element-found-in">
Update documentation
2024-03-26 20:10:30 +01:00
<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>
Update API documentation
2024-02-12 17:21:57 +01:00
:
Add new datastructure StrictArray
2024-03-27 12:19:43 +01:00
<span class="phpdocumentor-element-found-in__line">187</span>
Update API documentation
2024-02-12 17:21:57 +01:00
Add new datastructure StrictArray
2024-03-27 12:19:43 +01:00
<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>
Update API documentation
2024-02-12 17:21:57 +01:00
</aside>
Update documentation
2024-03-26 20:10:30 +01:00
<p class="phpdocumentor-summary">Prepend items at the start of the list.</p>
Update API documentation
2024-02-12 17:21:57 +01:00
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
Update documentation
2024-03-26 20:10:30 +01:00
<span class="phpdocumentor-signature__name">prepend</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><abbr title="\OCC\Basics\DataStructures\Traits\AllowedType">AllowedType</abbr>&nbsp;</span><span class="phpdocumentor-signature__argument__variadic-operator">...</span><span class="phpdocumentor-signature__argument__name">$values</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
Update API documentation
2024-02-12 17:21:57 +01:00
<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">
Update documentation
2024-03-26 20:10:30 +01:00
<span class="phpdocumentor-signature__argument__name">$values</span>
: <span class="phpdocumentor-signature__argument__return-type"><abbr title="\OCC\Basics\DataStructures\Traits\AllowedType">AllowedType</abbr></span>
Update API documentation
2024-02-12 17:21:57 +01:00
</dt>
<dd class="phpdocumentor-argument-list__definition">
Update documentation
2024-03-26 20:10:30 +01:00
<section class="phpdocumentor-description"><p>One or more items to prepend</p>
Update API documentation
2024-02-12 17:21:57 +01:00
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
Update documentation
2024-03-26 20:10:30 +01:00
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_prepend#tags" class="headerlink"><i class="fas fa-link"></i></a>
Update API documentation
2024-02-12 17:21:57 +01:00
</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">
Update documentation
2024-03-26 20:10:30 +01:00
<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>
Update API documentation
2024-02-12 17:21:57 +01:00
Update documentation
2024-03-26 20:10:30 +01:00
<section class="phpdocumentor-description"><p>if <code class="prettyprint">$value</code> is not of allowed type</p>
Update API documentation
2024-02-12 17:21:57 +01:00
</section>
</dd>
</dl>
Update documentation
2024-03-26 20:10:30 +01:00
Update API documentation
2024-02-12 17:21:57 +01:00
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
Update documentation
2024-03-26 20:10:30 +01:00
<h4 class="phpdocumentor-element__name" id="method_push">
push()
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_push" class="headerlink"><i class="fas fa-link"></i></a>
Update API documentation
2024-02-12 17:21:57 +01:00
</h4>
<aside class="phpdocumentor-element-found-in">
Update documentation
2024-03-26 20:10:30 +01:00
<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>
Update API documentation
2024-02-12 17:21:57 +01:00
:
Add new datastructure StrictArray
2024-03-27 12:19:43 +01:00
<span class="phpdocumentor-element-found-in__line">217</span>
Update API documentation
2024-02-12 17:21:57 +01:00
Add new datastructure StrictArray
2024-03-27 12:19:43 +01:00
<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>
Update API documentation
2024-02-12 17:21:57 +01:00
</aside>
Update documentation
2024-03-26 20:10:30 +01:00
<p class="phpdocumentor-summary">Push an item at the end of the list.</p>
Update API documentation
2024-02-12 17:21:57 +01:00
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
Update documentation
2024-03-26 20:10:30 +01:00
<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\Traits\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>
Update API documentation
2024-02-12 17:21:57 +01:00
<div class="phpdocumentor-label-line">
<div class="phpdocumentor-label phpdocumentor-label--success"><span>API</span><span>Yes</span></div>
</div>
Update documentation
2024-03-26 20:10:30 +01:00
<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\Traits\AllowedType">AllowedType</abbr></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The item to push</p>
</section>
</dd>
</dl>
Update API documentation
2024-02-12 17:21:57 +01:00
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
Update documentation
2024-03-26 20:10:30 +01:00
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_push#tags" class="headerlink"><i class="fas fa-link"></i></a>
Update API documentation
2024-02-12 17:21:57 +01:00
</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">
Update documentation
2024-03-26 20:10:30 +01:00
<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>
Update API documentation
2024-02-12 17:21:57 +01:00
Update documentation
2024-03-26 20:10:30 +01:00
<section class="phpdocumentor-description"><p>if <code class="prettyprint">$value</code> is not of allowed type</p>
Update API documentation
2024-02-12 17:21:57 +01:00
</section>
</dd>
</dl>
Update documentation
2024-03-26 20:10:30 +01:00
Update API documentation
2024-02-12 17:21:57 +01:00
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
Update documentation
2024-03-26 20:10:30 +01:00
<h4 class="phpdocumentor-element__name" id="method_remove">
remove()
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_remove" class="headerlink"><i class="fas fa-link"></i></a>
Update API documentation
2024-02-12 17:21:57 +01:00
</h4>
<aside class="phpdocumentor-element-found-in">
Update documentation
2024-03-26 20:10:30 +01:00
<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>
Update API documentation
2024-02-12 17:21:57 +01:00
:
Add new datastructure StrictArray
2024-03-27 12:19:43 +01:00
<span class="phpdocumentor-element-found-in__line">241</span>
Update API documentation
2024-02-12 17:21:57 +01:00
Add new datastructure StrictArray
2024-03-27 12:19:43 +01:00
<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>
Update API documentation
2024-02-12 17:21:57 +01:00
</aside>
Update documentation
2024-03-26 20:10:30 +01:00
<p class="phpdocumentor-summary">Remove an item from the list.</p>
Update API documentation
2024-02-12 17:21:57 +01:00
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
Update documentation
2024-03-26 20:10:30 +01:00
<span class="phpdocumentor-signature__name">remove</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">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>
Update API documentation
2024-02-12 17:21:57 +01:00
<div class="phpdocumentor-label-line">
<div class="phpdocumentor-label phpdocumentor-label--success"><span>API</span><span>Yes</span></div>
</div>
Update documentation
2024-03-26 20:10:30 +01:00
<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">int</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The item's index</p>
</section>
</dd>
</dl>
Update API documentation
2024-02-12 17:21:57 +01:00
Update documentation
2024-03-26 20:10:30 +01:00
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_remove#tags" class="headerlink"><i class="fas fa-link"></i></a>
Update API documentation
2024-02-12 17:21:57 +01:00
Update documentation
2024-03-26 20:10:30 +01:00
</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="\OutOfRangeException">OutOfRangeException</abbr></span>
<section class="phpdocumentor-description"><p>when <code class="prettyprint">$offset</code> is out of bounds</p>
Update API documentation
2024-02-12 17:21:57 +01:00
</section>
Update documentation
2024-03-26 20:10:30 +01:00
</dd>
</dl>
Update API documentation
2024-02-12 17:21:57 +01:00
Update documentation
2024-03-26 20:10:30 +01:00
Update API documentation
2024-02-12 17:21:57 +01:00
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
Update documentation
2024-03-26 20:10:30 +01:00
<h4 class="phpdocumentor-element__name" id="method_set">
set()
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_set" class="headerlink"><i class="fas fa-link"></i></a>
Update API documentation
2024-02-12 17:21:57 +01:00
</h4>
<aside class="phpdocumentor-element-found-in">
Update documentation
2024-03-26 20:10:30 +01:00
<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>
Update API documentation
2024-02-12 17:21:57 +01:00
:
Add new datastructure StrictArray
2024-03-27 12:19:43 +01:00
<span class="phpdocumentor-element-found-in__line">270</span>
Update API documentation
2024-02-12 17:21:57 +01:00
Add new datastructure StrictArray
2024-03-27 12:19:43 +01:00
<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>
Update API documentation
2024-02-12 17:21:57 +01:00
</aside>
Update documentation
2024-03-26 20:10:30 +01:00
<p class="phpdocumentor-summary">Set an item at the specified index.</p>
Update API documentation
2024-02-12 17:21:57 +01:00
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
Update documentation
2024-03-26 20:10:30 +01:00
<span class="phpdocumentor-signature__name">set</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&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\DataStructures\Traits\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>
Update API documentation
2024-02-12 17:21:57 +01:00
<div class="phpdocumentor-label-line">
<div class="phpdocumentor-label phpdocumentor-label--success"><span>API</span><span>Yes</span></div>
</div>
Update documentation
2024-03-26 20:10:30 +01:00
<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">int</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The item's index</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\DataStructures\Traits\AllowedType">AllowedType</abbr></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The item</p>
</section>
</dd>
</dl>
Update API documentation
2024-02-12 17:21:57 +01:00
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
Update documentation
2024-03-26 20:10:30 +01:00
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_set#tags" class="headerlink"><i class="fas fa-link"></i></a>
Update API documentation
2024-02-12 17:21:57 +01:00
</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">
Update documentation
2024-03-26 20:10:30 +01:00
<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>
Update API documentation
2024-02-12 17:21:57 +01:00
Update documentation
2024-03-26 20:10:30 +01:00
<section class="phpdocumentor-description"><p>if <code class="prettyprint">$value</code> is not of allowed type</p>
Update API documentation
2024-02-12 17:21:57 +01:00
</section>
</dd>
</dl>
Update documentation
2024-03-26 20:10:30 +01:00
Update API documentation
2024-02-12 17:21:57 +01:00
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
Update documentation
2024-03-26 20:10:30 +01:00
<h4 class="phpdocumentor-element__name" id="method_toArray">
toArray()
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_toArray" class="headerlink"><i class="fas fa-link"></i></a>
Update API documentation
2024-02-12 17:21:57 +01:00
</h4>
<aside class="phpdocumentor-element-found-in">
Update documentation
2024-03-26 20:10:30 +01:00
<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>
Update API documentation
2024-02-12 17:21:57 +01:00
:
Add new datastructure StrictArray
2024-03-27 12:19:43 +01:00
<span class="phpdocumentor-element-found-in__line">282</span>
Update API documentation
2024-02-12 17:21:57 +01:00
Add new datastructure StrictArray
2024-03-27 12:19:43 +01:00
<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>
Update API documentation
2024-02-12 17:21:57 +01:00
</aside>
Update documentation
2024-03-26 20:10:30 +01:00
<p class="phpdocumentor-summary">Return array representation of list.</p>
Update API documentation
2024-02-12 17:21:57 +01:00
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
Update documentation
2024-03-26 20:10:30 +01:00
<span class="phpdocumentor-signature__name">toArray</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;int, <abbr title="\OCC\Basics\DataStructures\Traits\AllowedType">AllowedType</abbr>&gt;</span></code>
Update API documentation
2024-02-12 17:21:57 +01:00
<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>
Update documentation
2024-03-26 20:10:30 +01:00
<span class="phpdocumentor-signature__response_type">array&lt;int, <abbr title="\OCC\Basics\DataStructures\Traits\AllowedType">AllowedType</abbr>&gt;</span>
Update API documentation
2024-02-12 17:21:57 +01:00
&mdash;
Update documentation
2024-03-26 20:10:30 +01:00
<section class="phpdocumentor-description"><p>Array of list items</p>
Update API documentation
2024-02-12 17:21:57 +01:00
</section>
</section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
Update documentation
2024-03-26 20:10:30 +01:00
<h4 class="phpdocumentor-element__name" id="method_toStrictCollection">
toStrictCollection()
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_toStrictCollection" class="headerlink"><i class="fas fa-link"></i></a>
Update API documentation
2024-02-12 17:21:57 +01:00
</h4>
<aside class="phpdocumentor-element-found-in">
Update documentation
2024-03-26 20:10:30 +01:00
<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>
Update API documentation
2024-02-12 17:21:57 +01:00
:
Add new datastructure StrictArray
2024-03-27 12:19:43 +01:00
<span class="phpdocumentor-element-found-in__line">294</span>
Update API documentation
2024-02-12 17:21:57 +01:00
Add new datastructure StrictArray
2024-03-27 12:19:43 +01:00
<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>
Update API documentation
2024-02-12 17:21:57 +01:00
</aside>
Update documentation
2024-03-26 20:10:30 +01:00
<p class="phpdocumentor-summary">Turn list into a type-sensitive collection.</p>
Update API documentation
2024-02-12 17:21:57 +01:00
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
Update documentation
2024-03-26 20:10:30 +01:00
<span class="phpdocumentor-signature__name">toStrictCollection</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><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></code>
Update API documentation
2024-02-12 17:21:57 +01:00
<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>
Update documentation
2024-03-26 20:10:30 +01:00
<span class="phpdocumentor-signature__response_type"><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>
Update API documentation
2024-02-12 17:21:57 +01:00
&mdash;
Update documentation
2024-03-26 20:10:30 +01:00
<section class="phpdocumentor-description"><p>A type-sensitive collection of the list's items</p>
Update API documentation
2024-02-12 17:21:57 +01:00
</section>
</section>
</article>
<article
class="phpdocumentor-element
-method
Update documentation
2024-03-26 20:10:30 +01:00
-public
Update API documentation
2024-02-12 17:21:57 +01:00
"
>
Update documentation
2024-03-26 20:10:30 +01:00
<h4 class="phpdocumentor-element__name" id="method_unshift">
unshift()
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_unshift" class="headerlink"><i class="fas fa-link"></i></a>
Update API documentation
2024-02-12 17:21:57 +01:00
</h4>
<aside class="phpdocumentor-element-found-in">
Update documentation
2024-03-26 20:10:30 +01:00
<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>
Update API documentation
2024-02-12 17:21:57 +01:00
:
Add new datastructure StrictArray
2024-03-27 12:19:43 +01:00
<span class="phpdocumentor-element-found-in__line">330</span>
Update API documentation
2024-02-12 17:21:57 +01:00
Add new datastructure StrictArray
2024-03-27 12:19:43 +01:00
<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>
Update API documentation
2024-02-12 17:21:57 +01:00
</aside>
Update documentation
2024-03-26 20:10:30 +01:00
<p class="phpdocumentor-summary">Prepend the list with an item.</p>
Update API documentation
2024-02-12 17:21:57 +01:00
<code class="phpdocumentor-code phpdocumentor-signature ">
Update documentation
2024-03-26 20:10:30 +01:00
<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\Traits\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>
Update API documentation
2024-02-12 17:21:57 +01:00
<div class="phpdocumentor-label-line">
Update documentation
2024-03-26 20:10:30 +01:00
<div class="phpdocumentor-label phpdocumentor-label--success"><span>API</span><span>Yes</span></div>
Update API documentation
2024-02-12 17:21:57 +01:00
</div>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
Update documentation
2024-03-26 20:10:30 +01:00
<span class="phpdocumentor-signature__argument__name">$value</span>
: <span class="phpdocumentor-signature__argument__return-type"><abbr title="\OCC\Basics\DataStructures\Traits\AllowedType">AllowedType</abbr></span>
</dt>
Update API documentation
2024-02-12 17:21:57 +01:00
<dd class="phpdocumentor-argument-list__definition">
Update documentation
2024-03-26 20:10:30 +01:00
<section class="phpdocumentor-description"><p>The item to unshift</p>
Update API documentation
2024-02-12 17:21:57 +01:00
</section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
Update documentation
2024-03-26 20:10:30 +01:00
<a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_unshift#tags" class="headerlink"><i class="fas fa-link"></i></a>
Update API documentation
2024-02-12 17:21:57 +01:00
</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">
Update documentation
2024-03-26 20:10:30 +01:00
<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>
Update API documentation
2024-02-12 17:21:57 +01:00
Update documentation
2024-03-26 20:10:30 +01:00
<section class="phpdocumentor-description"><p>if <code class="prettyprint">$value</code> is not of allowed type</p>
Update API documentation
2024-02-12 17:21:57 +01:00
</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/DataStructures/StrictQueue.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">
Update documentation
2024-03-26 20:10:30 +01:00
<li><a href="classes/OCC-Basics-DataStructures-StrictQueue.html#toc-methods">Methods</a></li>
Update API documentation
2024-02-12 17:21:57 +01:00
</ul>
</li>
<li class="phpdocumentor-on-this-page-section__title">Methods</li>
<li>
<ul class="phpdocumentor-list -clean">
Update documentation
2024-03-26 20:10:30 +01:00
<li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.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-StrictSplDatastructureTrait.html#method_append">append()</a></li>
<li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_clear">clear()</a></li>
Update API documentation
2024-02-12 17:21:57 +01:00
<li><a href="classes/OCC-Basics-DataStructures-StrictQueue.html#method_enqueue">enqueue()</a></li>
Update documentation
2024-03-26 20:10:30 +01:00
<li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.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-StrictSplDatastructureTrait.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-StrictSplDatastructureTrait.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-StrictSplDatastructureTrait.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-StrictSplDatastructureTrait.html#method_toStrictCollection">toStrictCollection()</a></li>
<li><a href="classes/OCC-Basics-DataStructures-Traits-StrictSplDatastructureTrait.html#method_unshift">unshift()</a></li>
Update API documentation
2024-02-12 17:21:57 +01:00
</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-DataStructures-StrictQueue.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>