2799 lines
141 KiB
HTML
2799 lines
141 KiB
HTML
<!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-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">
|
|
<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">
|
|
StrictList
|
|
|
|
<span class="phpdocumentor-element__extends">
|
|
extends <abbr title="\SplDoublyLinkedList">SplDoublyLinkedList</abbr>
|
|
</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>
|
|
|
|
<span class="phpdocumentor-element__implements">
|
|
implements
|
|
<abbr title="\ArrayAccess">ArrayAccess</abbr>, <abbr title="\Countable">Countable</abbr>, <abbr title="\Iterator">Iterator</abbr>, <abbr title="\Serializable">Serializable</abbr> </span>
|
|
|
|
<span class="phpdocumentor-element__extends">
|
|
Uses
|
|
<a href="classes/OCC-Basics-Traits-Getter.html"><abbr title="\OCC\Basics\Traits\Getter">Getter</abbr></a> </span>
|
|
</h2>
|
|
|
|
<div class="phpdocumentor-label-line">
|
|
|
|
|
|
</div>
|
|
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/StrictList.php"><a href="files/src-datastructures-strictlist.html"><abbr title="src/DataStructures/StrictList.php">StrictList.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">56</span>
|
|
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#source-view.56" class="phpdocumentor-element-found-in__source" data-line="56" data-modal="source-view" data-src="files/src/DataStructures/StrictList.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">A type-sensitive, taversable list.</p>
|
|
|
|
<section class="phpdocumentor-description"><p>Extends <a href="https://www.php.net/spldoublylinkedlist">\SplDoublyLinkedList</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>
|
|
</section>
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
Tags
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.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-StrictList.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h3>
|
|
|
|
|
|
|
|
<h4 id="toc-interfaces">
|
|
Interfaces
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#toc-interfaces" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<dl class="phpdocumentor-table-of-contents">
|
|
<dt class="phpdocumentor-table-of-contents__entry -interface"><abbr title="\ArrayAccess">ArrayAccess</abbr></dt> <dt class="phpdocumentor-table-of-contents__entry -interface"><abbr title="\Countable">Countable</abbr></dt> <dt class="phpdocumentor-table-of-contents__entry -interface"><abbr title="\Iterator">Iterator</abbr></dt> <dt class="phpdocumentor-table-of-contents__entry -interface"><abbr title="\Serializable">Serializable</abbr></dt> </dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h4 id="toc-properties">
|
|
Properties
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#toc-properties" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h4>
|
|
<dl class="phpdocumentor-table-of-contents">
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -public">
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#property_allowedTypes">$allowedTypes</a>
|
|
<span>
|
|
: array<string|int, string> </span>
|
|
</dt>
|
|
|
|
</dl>
|
|
|
|
<h4 id="toc-methods">
|
|
Methods
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.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-DataStructures-StrictList.html#method___construct">__construct()</a>
|
|
<span>
|
|
: void </span>
|
|
</dt>
|
|
<dd>Create a type-sensitive, traversable list of items.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/OCC-Basics-Traits-Getter.html#method___get">__get()</a>
|
|
<span>
|
|
: mixed </span>
|
|
</dt>
|
|
<dd>Read data from an inaccessible property.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/OCC-Basics-Traits-Getter.html#method___isset">__isset()</a>
|
|
<span>
|
|
: bool </span>
|
|
</dt>
|
|
<dd>Check if an inaccessible property is set and not empty.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#method_add">add()</a>
|
|
<span>
|
|
: void </span>
|
|
</dt>
|
|
<dd>Add/insert a new item at the specified offset.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#method_append">append()</a>
|
|
<span>
|
|
: void </span>
|
|
</dt>
|
|
<dd>Append items at the end of the list.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#method_bottom">bottom()</a>
|
|
<span>
|
|
: <abbr title="\OCC\Basics\DataStructures\AllowedType">AllowedType</abbr> </span>
|
|
</dt>
|
|
<dd>Peek at the item at the beginning of the list.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#method_clear">clear()</a>
|
|
<span>
|
|
: 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-StrictList.html#method_count">count()</a>
|
|
<span>
|
|
: int </span>
|
|
</dt>
|
|
<dd>Get the number of items on the list.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#method_current">current()</a>
|
|
<span>
|
|
: <abbr title="\OCC\Basics\DataStructures\AllowedType">AllowedType</abbr> </span>
|
|
</dt>
|
|
<dd>Get the current list item.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#method_get">get()</a>
|
|
<span>
|
|
: <abbr title="\OCC\Basics\DataStructures\AllowedType">AllowedType</abbr> </span>
|
|
</dt>
|
|
<dd>Get the item at the specified index.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#method_getAllowedTypes">getAllowedTypes()</a>
|
|
<span>
|
|
: array<string|int, string> </span>
|
|
</dt>
|
|
<dd>Get allowed data types for list items.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#method_getIteratorMode">getIteratorMode()</a>
|
|
<span>
|
|
: int </span>
|
|
</dt>
|
|
<dd>Get the mode of iteration.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#method_isAllowedType">isAllowedType()</a>
|
|
<span>
|
|
: bool </span>
|
|
</dt>
|
|
<dd>Check if the item's data type is allowed on the list.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#method_isEmpty">isEmpty()</a>
|
|
<span>
|
|
: bool </span>
|
|
</dt>
|
|
<dd>Check if list is empty.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#method_isList">isList()</a>
|
|
<span>
|
|
: true </span>
|
|
</dt>
|
|
<dd>Check if this can be considered a list.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#method_key">key()</a>
|
|
<span>
|
|
: int </span>
|
|
</dt>
|
|
<dd>Get the current list index.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#method_next">next()</a>
|
|
<span>
|
|
: void </span>
|
|
</dt>
|
|
<dd>Move the cursor to the next list index.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#method_offsetExists">offsetExists()</a>
|
|
<span>
|
|
: bool </span>
|
|
</dt>
|
|
<dd>Check if the specified index exists and is not empty.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#method_offsetGet">offsetGet()</a>
|
|
<span>
|
|
: <abbr title="\OCC\Basics\DataStructures\AllowedType">AllowedType</abbr> </span>
|
|
</dt>
|
|
<dd>Get the item from the specified index.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#method_offsetSet">offsetSet()</a>
|
|
<span>
|
|
: void </span>
|
|
</dt>
|
|
<dd>Set the item at the specified offset.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#method_offsetUnset">offsetUnset()</a>
|
|
<span>
|
|
: void </span>
|
|
</dt>
|
|
<dd>Unset the item at the specified index.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#method_pop">pop()</a>
|
|
<span>
|
|
: <abbr title="\OCC\Basics\DataStructures\AllowedType">AllowedType</abbr> </span>
|
|
</dt>
|
|
<dd>Pops an item from the end of the list.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#method_prepend">prepend()</a>
|
|
<span>
|
|
: void </span>
|
|
</dt>
|
|
<dd>Prepend items at the start of the list.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#method_prev">prev()</a>
|
|
<span>
|
|
: void </span>
|
|
</dt>
|
|
<dd>Move the cursor to the previous list index.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#method_push">push()</a>
|
|
<span>
|
|
: void </span>
|
|
</dt>
|
|
<dd>Push an item at the end of the list.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#method_remove">remove()</a>
|
|
<span>
|
|
: void </span>
|
|
</dt>
|
|
<dd>Remove an item from the list.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#method_rewind">rewind()</a>
|
|
<span>
|
|
: void </span>
|
|
</dt>
|
|
<dd>Rewind the iterator's cursor.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#method_set">set()</a>
|
|
<span>
|
|
: void </span>
|
|
</dt>
|
|
<dd>Set an item at the specified index.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#method_setIteratorMode">setIteratorMode()</a>
|
|
<span>
|
|
: int </span>
|
|
</dt>
|
|
<dd>Set the mode of iteration.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#method_shift">shift()</a>
|
|
<span>
|
|
: <abbr title="\OCC\Basics\DataStructures\AllowedType">AllowedType</abbr> </span>
|
|
</dt>
|
|
<dd>Shift an item from the beginning of the list.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#method_toArray">toArray()</a>
|
|
<span>
|
|
: array<string|int, <abbr title="\OCC\Basics\DataStructures\AllowedType">AllowedType</abbr>> </span>
|
|
</dt>
|
|
<dd>Return array representation of list.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#method_top">top()</a>
|
|
<span>
|
|
: <abbr title="\OCC\Basics\DataStructures\AllowedType">AllowedType</abbr> </span>
|
|
</dt>
|
|
<dd>Peek at the item at the end of the list.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#method_toStrictCollection">toStrictCollection()</a>
|
|
<span>
|
|
: <a href="classes/OCC-Basics-DataStructures-StrictCollection.html"><abbr title="\OCC\Basics\DataStructures\StrictCollection">StrictCollection</abbr></a><string|int, <abbr title="\OCC\Basics\DataStructures\AllowedType">AllowedType</abbr>> </span>
|
|
</dt>
|
|
<dd>Turn list into a type-sensitive collection.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#method_unshift">unshift()</a>
|
|
<span>
|
|
: void </span>
|
|
</dt>
|
|
<dd>Prepend the list with an item.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#method_valid">valid()</a>
|
|
<span>
|
|
: bool </span>
|
|
</dt>
|
|
<dd>Check if current cursor position is valid.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#method_setAllowedTypes">setAllowedTypes()</a>
|
|
<span>
|
|
: void </span>
|
|
</dt>
|
|
<dd>Set allowed data types of list items.</dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section class="phpdocumentor-properties">
|
|
<h3 class="phpdocumentor-elements__header" id="properties">
|
|
Properties
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
</h3>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-public
|
|
-read-only "
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_allowedTypes">
|
|
$allowedTypes
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#property_allowedTypes" class="headerlink"><i class="fas fa-link"></i></a>
|
|
|
|
<span class="phpdocumentor-element__modifiers">
|
|
<small class="phpdocumentor-element__modifier">read-only</small> </span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/DataStructures/StrictList.php"><a href="files/src-datastructures-strictlist.html"><abbr title="src/DataStructures/StrictList.php">StrictList.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">0</span>
|
|
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#source-view.0" class="phpdocumentor-element-found-in__source" data-line="0" data-modal="source-view" data-src="files/src/DataStructures/StrictList.php.txt"></a>
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">array<string|int, string></span>
|
|
<span class="phpdocumentor-signature__name">$allowedTypes</span>
|
|
</code>
|
|
|
|
<section class="phpdocumentor-description"><p>The allowed data types for values.</p>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
</article>
|
|
</section>
|
|
|
|
<section class="phpdocumentor-methods">
|
|
<h3 class="phpdocumentor-elements__header" id="methods">
|
|
Methods
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.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()
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#method___construct" 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/StrictList.php"><a href="files/src-datastructures-strictlist.html"><abbr title="src/DataStructures/StrictList.php">StrictList.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">696</span>
|
|
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#source-view.696" class="phpdocumentor-element-found-in__source" data-line="696" data-modal="source-view" data-src="files/src/DataStructures/StrictList.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Create a type-sensitive, traversable list of items.</p>
|
|
|
|
<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<string|int, string> </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<string|int, string></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>"array"</li>
|
|
<li>"bool"</li>
|
|
<li>"callable"</li>
|
|
<li>"countable"</li>
|
|
<li>"float" or "double"</li>
|
|
<li>"int" or "integer" or "long"</li>
|
|
<li>"iterable"</li>
|
|
<li>"null"</li>
|
|
<li>"numeric"</li>
|
|
<li>"object" or FQCN</li>
|
|
<li>"resource"</li>
|
|
<li>"scalar"</li>
|
|
<li>"string"</li>
|
|
</ul>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
Tags
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#method___construct#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="\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___get">
|
|
__get()
|
|
<a href="classes/OCC-Basics-Traits-Getter.html#method___get" 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/Traits/Getter.php"><a href="files/src-traits-getter.html"><abbr title="src/Traits/Getter.php">Getter.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">54</span>
|
|
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#source-view.54" class="phpdocumentor-element-found-in__source" data-line="54" data-modal="source-view" data-src="files/src/Traits/Getter.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Read data from an inaccessible property.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">__get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$property</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</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">$property</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>The class property to get</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
Tags
|
|
<a href="classes/OCC-Basics-Traits-Getter.html#method___get#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="\InvalidArgumentException">InvalidArgumentException</abbr></span>
|
|
|
|
<section class="phpdocumentor-description"><p>if the property or getter method do not exist</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">mixed</span>
|
|
—
|
|
<section class="phpdocumentor-description"><p>The class property's current value</p>
|
|
</section>
|
|
|
|
</section>
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method___isset">
|
|
__isset()
|
|
<a href="classes/OCC-Basics-Traits-Getter.html#method___isset" 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/Traits/Getter.php"><a href="files/src-traits-getter.html"><abbr title="src/Traits/Getter.php">Getter.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">77</span>
|
|
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#source-view.77" class="phpdocumentor-element-found-in__source" data-line="77" data-modal="source-view" data-src="files/src/Traits/Getter.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Check if an inaccessible property is set and not empty.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">__isset</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$property</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</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">$property</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>The class property to check</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">bool</span>
|
|
—
|
|
<section class="phpdocumentor-description"><p>Whether the class property is set and not empty</p>
|
|
</section>
|
|
|
|
</section>
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_add">
|
|
add()
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#method_add" 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/StrictList.php"><a href="files/src-datastructures-strictlist.html"><abbr title="src/DataStructures/StrictList.php">StrictList.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">82</span>
|
|
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#source-view.82" class="phpdocumentor-element-found-in__source" data-line="82" data-modal="source-view" data-src="files/src/DataStructures/StrictList.php.txt"></a>
|
|
</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>
|
|
<span class="phpdocumentor-signature__name">add</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int </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\AllowedType">AllowedType</abbr> </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">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>
|
|
: <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 new item for the offset</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
Tags
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#method_add#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="\InvalidArgumentException">InvalidArgumentException</abbr></span>
|
|
|
|
<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()
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#method_append" 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/StrictList.php"><a href="files/src-datastructures-strictlist.html"><abbr title="src/DataStructures/StrictList.php">StrictList.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">98</span>
|
|
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#source-view.98" class="phpdocumentor-element-found-in__source" data-line="98" data-modal="source-view" data-src="files/src/DataStructures/StrictList.php.txt"></a>
|
|
</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>
|
|
<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\AllowedType">AllowedType</abbr> </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>
|
|
|
|
<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>
|
|
: <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>One or more items to append</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
Tags
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#method_append#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="\InvalidArgumentException">InvalidArgumentException</abbr></span>
|
|
|
|
<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
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_bottom">
|
|
bottom()
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.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/StrictList.php"><a href="files/src-datastructures-strictlist.html"><abbr title="src/DataStructures/StrictList.php">StrictList.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">126</span>
|
|
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#source-view.126" class="phpdocumentor-element-found-in__source" data-line="126" data-modal="source-view" data-src="files/src/DataStructures/StrictList.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Peek at the item at the beginning of the list.</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-StrictList.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 list 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>
|
|
—
|
|
<section class="phpdocumentor-description"><p>The first item of the list</p>
|
|
</section>
|
|
|
|
</section>
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_clear">
|
|
clear()
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#method_clear" 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/StrictList.php"><a href="files/src-datastructures-strictlist.html"><abbr title="src/DataStructures/StrictList.php">StrictList.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">138</span>
|
|
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#source-view.138" class="phpdocumentor-element-found-in__source" data-line="138" data-modal="source-view" data-src="files/src/DataStructures/StrictList.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Clear the list of any items.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">clear</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_count">
|
|
count()
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.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/DataStructures/StrictList.php"><a href="files/src-datastructures-strictlist.html"><abbr title="src/DataStructures/StrictList.php">StrictList.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">153</span>
|
|
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#source-view.153" class="phpdocumentor-element-found-in__source" data-line="153" data-modal="source-view" data-src="files/src/DataStructures/StrictList.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Get the number of items on the list.</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</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</span>
|
|
—
|
|
<section class="phpdocumentor-description"><p>The number of items on the list</p>
|
|
</section>
|
|
|
|
</section>
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_current">
|
|
current()
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.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/DataStructures/StrictList.php"><a href="files/src-datastructures-strictlist.html"><abbr title="src/DataStructures/StrictList.php">StrictList.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">165</span>
|
|
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#source-view.165" class="phpdocumentor-element-found-in__source" data-line="165" data-modal="source-view" data-src="files/src/DataStructures/StrictList.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Get the current list 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\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>
|
|
|
|
|
|
|
|
|
|
<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>
|
|
—
|
|
<section class="phpdocumentor-description"><p>The current item</p>
|
|
</section>
|
|
|
|
</section>
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_get">
|
|
get()
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#method_get" 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/StrictList.php"><a href="files/src-datastructures-strictlist.html"><abbr title="src/DataStructures/StrictList.php">StrictList.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">181</span>
|
|
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#source-view.181" class="phpdocumentor-element-found-in__source" data-line="181" data-modal="source-view" data-src="files/src/DataStructures/StrictList.php.txt"></a>
|
|
</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>
|
|
<span class="phpdocumentor-signature__name">get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int </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\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-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
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#method_get#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="\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>
|
|
<span class="phpdocumentor-signature__response_type"><abbr title="\OCC\Basics\DataStructures\AllowedType">AllowedType</abbr></span>
|
|
—
|
|
<section class="phpdocumentor-description"><p>The item</p>
|
|
</section>
|
|
|
|
</section>
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_getAllowedTypes">
|
|
getAllowedTypes()
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#method_getAllowedTypes" 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/StrictList.php"><a href="files/src-datastructures-strictlist.html"><abbr title="src/DataStructures/StrictList.php">StrictList.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">193</span>
|
|
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#source-view.193" class="phpdocumentor-element-found-in__source" data-line="193" data-modal="source-view" data-src="files/src/DataStructures/StrictList.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Get allowed data types for list items.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">getAllowedTypes</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, string></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">array<string|int, string></span>
|
|
—
|
|
<section class="phpdocumentor-description"><p>The list of allowed data types</p>
|
|
</section>
|
|
|
|
</section>
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_getIteratorMode">
|
|
getIteratorMode()
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#method_getIteratorMode" 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/StrictList.php"><a href="files/src-datastructures-strictlist.html"><abbr title="src/DataStructures/StrictList.php">StrictList.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">205</span>
|
|
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#source-view.205" class="phpdocumentor-element-found-in__source" data-line="205" data-modal="source-view" data-src="files/src/DataStructures/StrictList.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Get the mode of iteration.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">getIteratorMode</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</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</span>
|
|
—
|
|
<section class="phpdocumentor-description"><p>The set of flags and modes of iteration</p>
|
|
</section>
|
|
|
|
</section>
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_isAllowedType">
|
|
isAllowedType()
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#method_isAllowedType" 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/StrictList.php"><a href="files/src-datastructures-strictlist.html"><abbr title="src/DataStructures/StrictList.php">StrictList.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">219</span>
|
|
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#source-view.219" class="phpdocumentor-element-found-in__source" data-line="219" data-modal="source-view" data-src="files/src/DataStructures/StrictList.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Check if the item's data type is allowed on the list.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">isAllowedType</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><abbr title="\OCC\Basics\DataStructures\AllowedType">AllowedType</abbr> </span><span class="phpdocumentor-signature__argument__name">$value</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">$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 check</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">bool</span>
|
|
—
|
|
<section class="phpdocumentor-description"><p>Whether the item's data type is allowed</p>
|
|
</section>
|
|
|
|
</section>
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_isEmpty">
|
|
isEmpty()
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#method_isEmpty" 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/StrictList.php"><a href="files/src-datastructures-strictlist.html"><abbr title="src/DataStructures/StrictList.php">StrictList.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">245</span>
|
|
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#source-view.245" class="phpdocumentor-element-found-in__source" data-line="245" data-modal="source-view" data-src="files/src/DataStructures/StrictList.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Check if list is empty.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">isEmpty</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>
|
|
—
|
|
<section class="phpdocumentor-description"><p>Whether the list contains no items</p>
|
|
</section>
|
|
|
|
</section>
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_isList">
|
|
isList()
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#method_isList" 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/StrictList.php"><a href="files/src-datastructures-strictlist.html"><abbr title="src/DataStructures/StrictList.php">StrictList.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">257</span>
|
|
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#source-view.257" class="phpdocumentor-element-found-in__source" data-line="257" data-modal="source-view" data-src="files/src/DataStructures/StrictList.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Check if this can be considered a list.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">isList</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">true</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">true</span>
|
|
—
|
|
<section class="phpdocumentor-description"><p>Always TRUE (this exists only for compatibility reasons)</p>
|
|
</section>
|
|
|
|
</section>
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_key">
|
|
key()
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.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/DataStructures/StrictList.php"><a href="files/src-datastructures-strictlist.html"><abbr title="src/DataStructures/StrictList.php">StrictList.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">269</span>
|
|
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#source-view.269" class="phpdocumentor-element-found-in__source" data-line="269" data-modal="source-view" data-src="files/src/DataStructures/StrictList.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Get the current list index.</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">int</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</span>
|
|
—
|
|
<section class="phpdocumentor-description"><p>The current list index</p>
|
|
</section>
|
|
|
|
</section>
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_next">
|
|
next()
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.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/DataStructures/StrictList.php"><a href="files/src-datastructures-strictlist.html"><abbr title="src/DataStructures/StrictList.php">StrictList.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">281</span>
|
|
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#source-view.281" class="phpdocumentor-element-found-in__source" data-line="281" data-modal="source-view" data-src="files/src/DataStructures/StrictList.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Move the cursor to the next list index.</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_offsetExists">
|
|
offsetExists()
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.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/DataStructures/StrictList.php"><a href="files/src-datastructures-strictlist.html"><abbr title="src/DataStructures/StrictList.php">StrictList.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">295</span>
|
|
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#source-view.295" class="phpdocumentor-element-found-in__source" data-line="295" data-modal="source-view" data-src="files/src/DataStructures/StrictList.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Check if the specified index exists and is not empty.</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">int </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">int</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>The index to check</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">bool</span>
|
|
—
|
|
<section class="phpdocumentor-description"><p>Whether the index exists and is not empty</p>
|
|
</section>
|
|
|
|
</section>
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_offsetGet">
|
|
offsetGet()
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.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/DataStructures/StrictList.php"><a href="files/src-datastructures-strictlist.html"><abbr title="src/DataStructures/StrictList.php">StrictList.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">311</span>
|
|
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#source-view.311" class="phpdocumentor-element-found-in__source" data-line="311" data-modal="source-view" data-src="files/src/DataStructures/StrictList.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Get the item from the specified index.</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">int </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\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-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
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#method_offsetGet#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="\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>
|
|
<span class="phpdocumentor-signature__response_type"><abbr title="\OCC\Basics\DataStructures\AllowedType">AllowedType</abbr></span>
|
|
—
|
|
<section class="phpdocumentor-description"><p>The item</p>
|
|
</section>
|
|
|
|
</section>
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_offsetSet">
|
|
offsetSet()
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.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/DataStructures/StrictList.php"><a href="files/src-datastructures-strictlist.html"><abbr title="src/DataStructures/StrictList.php">StrictList.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">329</span>
|
|
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#source-view.329" class="phpdocumentor-element-found-in__source" data-line="329" data-modal="source-view" data-src="files/src/DataStructures/StrictList.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Set the item at 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">int|null </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\AllowedType">AllowedType</abbr> </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">int|null</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>The offset being set 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\DataStructures\AllowedType">AllowedType</abbr></span>
|
|
</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
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#method_offsetSet#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="\InvalidArgumentException">InvalidArgumentException</abbr></span>
|
|
|
|
<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_offsetUnset">
|
|
offsetUnset()
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.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/DataStructures/StrictList.php"><a href="files/src-datastructures-strictlist.html"><abbr title="src/DataStructures/StrictList.php">StrictList.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">354</span>
|
|
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#source-view.354" class="phpdocumentor-element-found-in__source" data-line="354" data-modal="source-view" data-src="files/src/DataStructures/StrictList.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Unset the item at the specified index.</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">int </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">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
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#method_offsetUnset#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="\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_pop">
|
|
pop()
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.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/StrictList.php"><a href="files/src-datastructures-strictlist.html"><abbr title="src/DataStructures/StrictList.php">StrictList.php</abbr></a></abbr>
|
|
:
|
|
<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/StrictList.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Pops an item from the end of the list.</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-StrictList.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 list 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>
|
|
—
|
|
<section class="phpdocumentor-description"><p>The item from the end of the list</p>
|
|
</section>
|
|
|
|
</section>
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_prepend">
|
|
prepend()
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#method_prepend" 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/StrictList.php"><a href="files/src-datastructures-strictlist.html"><abbr title="src/DataStructures/StrictList.php">StrictList.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">384</span>
|
|
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#source-view.384" class="phpdocumentor-element-found-in__source" data-line="384" data-modal="source-view" data-src="files/src/DataStructures/StrictList.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Prepend items at the start of the list.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<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\AllowedType">AllowedType</abbr> </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>
|
|
|
|
<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>
|
|
: <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>One or more items to prepend</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
Tags
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#method_prepend#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="\InvalidArgumentException">InvalidArgumentException</abbr></span>
|
|
|
|
<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_prev">
|
|
prev()
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.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/DataStructures/StrictList.php"><a href="files/src-datastructures-strictlist.html"><abbr title="src/DataStructures/StrictList.php">StrictList.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">410</span>
|
|
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#source-view.410" class="phpdocumentor-element-found-in__source" data-line="410" data-modal="source-view" data-src="files/src/DataStructures/StrictList.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Move the cursor to the previous list index.</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_push">
|
|
push()
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.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/StrictList.php"><a href="files/src-datastructures-strictlist.html"><abbr title="src/DataStructures/StrictList.php">StrictList.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">426</span>
|
|
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#source-view.426" class="phpdocumentor-element-found-in__source" data-line="426" data-modal="source-view" data-src="files/src/DataStructures/StrictList.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Push an item at the end of the list.</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> </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-StrictList.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"><abbr title="\InvalidArgumentException">InvalidArgumentException</abbr></span>
|
|
|
|
<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_remove">
|
|
remove()
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#method_remove" 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/StrictList.php"><a href="files/src-datastructures-strictlist.html"><abbr title="src/DataStructures/StrictList.php">StrictList.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">450</span>
|
|
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#source-view.450" class="phpdocumentor-element-found-in__source" data-line="450" data-modal="source-view" data-src="files/src/DataStructures/StrictList.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Remove an item from the list.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">remove</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int </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">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
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#method_remove#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="\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_rewind">
|
|
rewind()
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.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/DataStructures/StrictList.php"><a href="files/src-datastructures-strictlist.html"><abbr title="src/DataStructures/StrictList.php">StrictList.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">462</span>
|
|
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#source-view.462" class="phpdocumentor-element-found-in__source" data-line="462" data-modal="source-view" data-src="files/src/DataStructures/StrictList.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Rewind the iterator's cursor.</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_set">
|
|
set()
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#method_set" 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/StrictList.php"><a href="files/src-datastructures-strictlist.html"><abbr title="src/DataStructures/StrictList.php">StrictList.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">491</span>
|
|
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#source-view.491" class="phpdocumentor-element-found-in__source" data-line="491" data-modal="source-view" data-src="files/src/DataStructures/StrictList.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Set an item at the specified index.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">set</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int </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\AllowedType">AllowedType</abbr> </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">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\AllowedType">AllowedType</abbr></span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>The item</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
Tags
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#method_set#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="\InvalidArgumentException">InvalidArgumentException</abbr></span>
|
|
|
|
<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_setIteratorMode">
|
|
setIteratorMode()
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#method_setIteratorMode" 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/StrictList.php"><a href="files/src-datastructures-strictlist.html"><abbr title="src/DataStructures/StrictList.php">StrictList.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">538</span>
|
|
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#source-view.538" class="phpdocumentor-element-found-in__source" data-line="538" data-modal="source-view" data-src="files/src/DataStructures/StrictList.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Set the mode of iteration.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">setIteratorMode</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$mode</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</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">$mode</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">int</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
<section class="phpdocumentor-description"><p>The new iterator mode (0, 1, 2 or 3)</p>
|
|
<p>There are two orthogonal sets of modes that can be set.</p>
|
|
<p>The direction of iteration (either one or the other):</p>
|
|
<ul>
|
|
<li>StrictList::IT_MODE_FIFO (queue style)</li>
|
|
<li>StrictList::IT_MODE_LIFO (stack style)</li>
|
|
</ul>
|
|
<p>The behavior of the iterator (either one or the other):</p>
|
|
<ul>
|
|
<li>StrictList::IT_MODE_DELETE (delete items)</li>
|
|
<li>StrictList::IT_MODE_KEEP (keep items)</li>
|
|
</ul>
|
|
<p>The default mode is: IT_MODE_FIFO | IT_MODE_KEEP</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
Tags
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#method_setIteratorMode#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="\RangeException">RangeException</abbr></span>
|
|
|
|
<section class="phpdocumentor-description"><p>if an invalid <code class="prettyprint">$mode</code> is given</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">int</span>
|
|
—
|
|
<section class="phpdocumentor-description"><p>The set of flags and modes of iteration</p>
|
|
</section>
|
|
|
|
</section>
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_shift">
|
|
shift()
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.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/StrictList.php"><a href="files/src-datastructures-strictlist.html"><abbr title="src/DataStructures/StrictList.php">StrictList.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">560</span>
|
|
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#source-view.560" class="phpdocumentor-element-found-in__source" data-line="560" data-modal="source-view" data-src="files/src/DataStructures/StrictList.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Shift an item from the beginning of the list.</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-StrictList.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 list 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>
|
|
—
|
|
<section class="phpdocumentor-description"><p>The first item of the list</p>
|
|
</section>
|
|
|
|
</section>
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_toArray">
|
|
toArray()
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#method_toArray" 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/StrictList.php"><a href="files/src-datastructures-strictlist.html"><abbr title="src/DataStructures/StrictList.php">StrictList.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">572</span>
|
|
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#source-view.572" class="phpdocumentor-element-found-in__source" data-line="572" data-modal="source-view" data-src="files/src/DataStructures/StrictList.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Return array representation of list.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">toArray</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, <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>
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type">array<string|int, <abbr title="\OCC\Basics\DataStructures\AllowedType">AllowedType</abbr>></span>
|
|
—
|
|
<section class="phpdocumentor-description"><p>Array of list items</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-StrictList.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/StrictList.php"><a href="files/src-datastructures-strictlist.html"><abbr title="src/DataStructures/StrictList.php">StrictList.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">602</span>
|
|
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#source-view.602" class="phpdocumentor-element-found-in__source" data-line="602" data-modal="source-view" data-src="files/src/DataStructures/StrictList.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Peek at the item at the end of the list.</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-StrictList.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 list 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>
|
|
—
|
|
<section class="phpdocumentor-description"><p>The last item of the list</p>
|
|
</section>
|
|
|
|
</section>
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_toStrictCollection">
|
|
toStrictCollection()
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#method_toStrictCollection" 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/StrictList.php"><a href="files/src-datastructures-strictlist.html"><abbr title="src/DataStructures/StrictList.php">StrictList.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">584</span>
|
|
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#source-view.584" class="phpdocumentor-element-found-in__source" data-line="584" data-modal="source-view" data-src="files/src/DataStructures/StrictList.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Turn list into a type-sensitive collection.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<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><string|int, <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>
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type"><a href="classes/OCC-Basics-DataStructures-StrictCollection.html"><abbr title="\OCC\Basics\DataStructures\StrictCollection">StrictCollection</abbr></a><string|int, <abbr title="\OCC\Basics\DataStructures\AllowedType">AllowedType</abbr>></span>
|
|
—
|
|
<section class="phpdocumentor-description"><p>A type-sensitive collection of the list's items</p>
|
|
</section>
|
|
|
|
</section>
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_unshift">
|
|
unshift()
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.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/StrictList.php"><a href="files/src-datastructures-strictlist.html"><abbr title="src/DataStructures/StrictList.php">StrictList.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">634</span>
|
|
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#source-view.634" class="phpdocumentor-element-found-in__source" data-line="634" data-modal="source-view" data-src="files/src/DataStructures/StrictList.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Prepend the list 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> </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-StrictList.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"><abbr title="\InvalidArgumentException">InvalidArgumentException</abbr></span>
|
|
|
|
<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_valid">
|
|
valid()
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.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/DataStructures/StrictList.php"><a href="files/src-datastructures-strictlist.html"><abbr title="src/DataStructures/StrictList.php">StrictList.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">654</span>
|
|
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#source-view.654" class="phpdocumentor-element-found-in__source" data-line="654" data-modal="source-view" data-src="files/src/DataStructures/StrictList.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Check if current cursor 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>
|
|
—
|
|
<section class="phpdocumentor-description"><p>Whether the current cursor position is valid</p>
|
|
</section>
|
|
|
|
</section>
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-protected
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_setAllowedTypes">
|
|
setAllowedTypes()
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#method_setAllowedTypes" 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/StrictList.php"><a href="files/src-datastructures-strictlist.html"><abbr title="src/DataStructures/StrictList.php">StrictList.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">505</span>
|
|
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#source-view.505" class="phpdocumentor-element-found-in__source" data-line="505" data-modal="source-view" data-src="files/src/DataStructures/StrictList.php.txt"></a>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Set allowed data types of list items.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">protected</span>
|
|
<span class="phpdocumentor-signature__name">setAllowedTypes</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">array<string|int, string> </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<string|int, string></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</p>
|
|
</section>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
<h5 class="phpdocumentor-tag-list__heading" id="tags">
|
|
Tags
|
|
<a href="classes/OCC-Basics-DataStructures-StrictList.html#method_setAllowedTypes#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="\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>
|
|
</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/StrictList.php.txt" class="language-php line-numbers linkable-line-numbers"></pre>
|
|
</div>
|
|
<button data-exit-button class="phpdocumentor-modal__close">×</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-DataStructures-StrictList.html#toc-properties">Properties</a></li>
|
|
<li><a href="classes/OCC-Basics-DataStructures-StrictList.html#toc-methods">Methods</a></li>
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="phpdocumentor-on-this-page-section__title">Properties</li>
|
|
<li>
|
|
<ul class="phpdocumentor-list -clean">
|
|
<li><a href="classes/OCC-Basics-DataStructures-StrictList.html#property_allowedTypes">$allowedTypes<a href="classes/OCC-Basics-DataStructures-StrictList.html"></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-DataStructures-StrictList.html#method___construct">__construct()</a></li>
|
|
<li><a href="classes/OCC-Basics-Traits-Getter.html#method___get">__get()</a></li>
|
|
<li><a href="classes/OCC-Basics-Traits-Getter.html#method___isset">__isset()</a></li>
|
|
<li><a href="classes/OCC-Basics-DataStructures-StrictList.html#method_add">add()</a></li>
|
|
<li><a href="classes/OCC-Basics-DataStructures-StrictList.html#method_append">append()</a></li>
|
|
<li><a href="classes/OCC-Basics-DataStructures-StrictList.html#method_bottom">bottom()</a></li>
|
|
<li><a href="classes/OCC-Basics-DataStructures-StrictList.html#method_clear">clear()</a></li>
|
|
<li><a href="classes/OCC-Basics-DataStructures-StrictList.html#method_count">count()</a></li>
|
|
<li><a href="classes/OCC-Basics-DataStructures-StrictList.html#method_current">current()</a></li>
|
|
<li><a href="classes/OCC-Basics-DataStructures-StrictList.html#method_get">get()</a></li>
|
|
<li><a href="classes/OCC-Basics-DataStructures-StrictList.html#method_getAllowedTypes">getAllowedTypes()</a></li>
|
|
<li><a href="classes/OCC-Basics-DataStructures-StrictList.html#method_getIteratorMode">getIteratorMode()</a></li>
|
|
<li><a href="classes/OCC-Basics-DataStructures-StrictList.html#method_isAllowedType">isAllowedType()</a></li>
|
|
<li><a href="classes/OCC-Basics-DataStructures-StrictList.html#method_isEmpty">isEmpty()</a></li>
|
|
<li><a href="classes/OCC-Basics-DataStructures-StrictList.html#method_isList">isList()</a></li>
|
|
<li><a href="classes/OCC-Basics-DataStructures-StrictList.html#method_key">key()</a></li>
|
|
<li><a href="classes/OCC-Basics-DataStructures-StrictList.html#method_next">next()</a></li>
|
|
<li><a href="classes/OCC-Basics-DataStructures-StrictList.html#method_offsetExists">offsetExists()</a></li>
|
|
<li><a href="classes/OCC-Basics-DataStructures-StrictList.html#method_offsetGet">offsetGet()</a></li>
|
|
<li><a href="classes/OCC-Basics-DataStructures-StrictList.html#method_offsetSet">offsetSet()</a></li>
|
|
<li><a href="classes/OCC-Basics-DataStructures-StrictList.html#method_offsetUnset">offsetUnset()</a></li>
|
|
<li><a href="classes/OCC-Basics-DataStructures-StrictList.html#method_pop">pop()</a></li>
|
|
<li><a href="classes/OCC-Basics-DataStructures-StrictList.html#method_prepend">prepend()</a></li>
|
|
<li><a href="classes/OCC-Basics-DataStructures-StrictList.html#method_prev">prev()</a></li>
|
|
<li><a href="classes/OCC-Basics-DataStructures-StrictList.html#method_push">push()</a></li>
|
|
<li><a href="classes/OCC-Basics-DataStructures-StrictList.html#method_remove">remove()</a></li>
|
|
<li><a href="classes/OCC-Basics-DataStructures-StrictList.html#method_rewind">rewind()</a></li>
|
|
<li><a href="classes/OCC-Basics-DataStructures-StrictList.html#method_set">set()</a></li>
|
|
<li><a href="classes/OCC-Basics-DataStructures-StrictList.html#method_setIteratorMode">setIteratorMode()</a></li>
|
|
<li><a href="classes/OCC-Basics-DataStructures-StrictList.html#method_shift">shift()</a></li>
|
|
<li><a href="classes/OCC-Basics-DataStructures-StrictList.html#method_toArray">toArray()</a></li>
|
|
<li><a href="classes/OCC-Basics-DataStructures-StrictList.html#method_top">top()</a></li>
|
|
<li><a href="classes/OCC-Basics-DataStructures-StrictList.html#method_toStrictCollection">toStrictCollection()</a></li>
|
|
<li><a href="classes/OCC-Basics-DataStructures-StrictList.html#method_unshift">unshift()</a></li>
|
|
<li><a href="classes/OCC-Basics-DataStructures-StrictList.html#method_valid">valid()</a></li>
|
|
<li><a href="classes/OCC-Basics-DataStructures-StrictList.html#method_setAllowedTypes">setAllowedTypes()</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-DataStructures-StrictList.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>
|