docu_system/classes/ScssPhp-ScssPhp-Collection-Map.html
Ulf Gebhardt 50de610cf6
generated new version
missing changes

more

more

more
2024-11-21 02:49:15 +01:00

719 lines
45 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=0"/>
<meta charset="utf-8"/>
<title> SYSTEM - PHP Framework &raquo; \ScssPhp\ScssPhp\Collection\Map
</title>
<meta name="author" content=""/>
<meta name="description" content=""/>
<base href="../">
<link href="css/template.css" rel="stylesheet" media="all"/>
<!--[if lt IE 9]>
<script src="https://html5shim.googlecode.com/svn/trunk/html5.js" type="text/javascript"></script>
<![endif]-->
<script src="js/jquery-1.7.1.min.js" type="text/javascript"></script>
<script src="js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script>
<script src="js/jquery.mousewheel.min.js" type="text/javascript"></script>
<script src="js/bootstrap.js" type="text/javascript"></script>
<script src="js/template.js" type="text/javascript"></script>
<script src="js/prettify/prettify.min.js" type="text/javascript"></script>
<link rel="shortcut icon" href="img/favicon.ico"/>
<link rel="apple-touch-icon" href="img/apple-touch-icon.png"/>
<link rel="apple-touch-icon" sizes="72x72" href="img/apple-touch-icon-72x72.png"/>
<link rel="apple-touch-icon" sizes="114x114" href="img/apple-touch-icon-114x114.png"/>
</head>
<body>
<div class="navbar navbar-fixed-top">
<div class="navbar-inner">
<div class="container">
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
<span class="icon-bar"></span> <span class="icon-bar"></span>
<span class="icon-bar"></span> </a>
<a class="brand" href="index.html">SYSTEM - PHP Framework</a>
<div class="nav-collapse">
<ul class="nav">
<li class="dropdown">
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
API Documentation <b class="caret"></b>
</a>
<ul class="dropdown-menu">
<li><a>Namespaces</a></li>
<li><a href="\LIB">LIB</a></li>
<li><a href="\GIT">GIT</a></li>
<li><a href="\vakata">vakata</a></li>
<li><a href="\Michelf">Michelf</a></li>
<li><a href="\MatthiasMullie">MatthiasMullie</a></li>
<li><a href="\PHPDocMD">PHPDocMD</a></li>
<li><a href="\ScssPhp">ScssPhp</a></li>
<li><a href="\SYSTEM">SYSTEM</a></li>
</ul>
</li>
<li class="dropdown" id="charts-menu">
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
Charts <b class="caret"></b>
</a>
<ul class="dropdown-menu">
<li>
<a href="graph_class.html">
<i class="icon-list-alt"></i>&#160;Class hierarchy diagram
</a>
</li>
</ul>
</li>
<li class="dropdown" id="reports-menu">
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b>
</a>
<ul class="dropdown-menu">
<li>
<a href="errors.html">
<i class="icon-list-alt"></i>&#160;Errors
</a>
</li>
<li>
<a href="markers.html">
<i class="icon-list-alt"></i>&#160;Markers
</a>
</li>
<li>
<a href="deprecated.html">
<i class="icon-list-alt"></i>&#160;Deprecated
</a>
</li>
</ul>
</li>
</ul>
</div>
</div>
</div>
<div class="go_to_top">
<a href="#___" style="color: inherit">Back to top&#160;&#160;<i class="icon-upload icon-white"></i></a>
</div>
</div>
<div id="___" class="container">
<noscript>
<div class="alert alert-warning">
Javascript is disabled; several features are only available if Javascript is enabled.
</div>
</noscript>
<style>
.deprecated h2 {
text-decoration: line-through;
}
</style>
<div class="row">
<div class="span4">
<div class="btn-group view pull-right" data-toggle="buttons-radio">
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button>
<button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
</div>
<div class="btn-group visibility" data-toggle="buttons-checkbox">
<button class="btn public active" title="Show public elements">Public</button>
<button class="btn protected" title="Show protected elements">Protected</button>
<button class="btn private" title="Show private elements">Private</button>
<button class="btn inherited active" title="Show inherited elements">Inherited</button>
</div>
<ul class="side-nav nav nav-list">
<li class="nav-header">
<i class="icon-custom icon-method"></i> Methods
<ul>
<li class="method public">
<a href="#method_count" title="count :: ">
<span class="description"></span><pre>count</pre>
</a>
</li>
<li class="method public">
<a href="#method_get" title="get :: The value for the given key, or `null` if $key is not in the map.">
<span class="description">The value for the given key, or `null` if $key is not in the map.</span><pre>get</pre>
</a>
</li>
<li class="method public">
<a href="#method_getIterator" title="getIterator :: ">
<span class="description"></span><pre>getIterator</pre>
</a>
</li>
<li class="method public">
<a href="#method_of" title="of :: Returns a modifiable version of the Map.">
<span class="description">Returns a modifiable version of the Map.</span><pre>of</pre>
</a>
</li>
<li class="method public">
<a href="#method_put" title="put :: Associates the key with the given value.">
<span class="description">Associates the key with the given value.</span><pre>put</pre>
</a>
</li>
<li class="method public">
<a href="#method_remove" title="remove :: Removes $key and its associated value, if present, from the map.">
<span class="description">Removes $key and its associated value, if present, from the map.</span><pre>remove</pre>
</a>
</li>
<li class="method public">
<a href="#method_unmodifiable" title="unmodifiable :: Returns an unmodifiable version of the Map.">
<span class="description">Returns an unmodifiable version of the Map.</span><pre>unmodifiable</pre>
</a>
</li>
</ul>
</li>
<li class="nav-header protected">» Protected
<ul>
</ul>
</li>
<li class="nav-header private">» Private
<ul>
<li class="method private">
<a href="#method_assertModifiable" title="assertModifiable :: ">
<span class="description"></span><pre>assertModifiable</pre>
</a>
</li>
</ul>
</li>
<li class="nav-header">
<i class="icon-custom icon-constant"></i> Constants
<ul>
</ul>
</li>
</ul>
</div>
<div class="span8">
<div class="element class">
<h1>Map</h1>
<small style="display: block; text-align: right">
Implements <abbr title="\Countable">Countable</abbr>, <abbr title="\IteratorAggregate">IteratorAggregate</abbr>
</small>
<p class="short_description">A map using Sass values as keys based on Value::equals.</p>
<div class="details">
<div class="long_description">
<p>The map can be either modifiable or unmodifiable. For unmodifiable
maps, all mutators will throw a LogicException.</p>
<p>Iteration preserves the order in which keys have been inserted.</p>
</div>
<table class="table table-bordered">
<tr>
<th>
template
</th>
<td>
<p>T</p>
</td>
</tr>
<tr>
<th>
template-implements
</th>
<td>
<p>\IteratorAggregate&lt;Value, T&gt;</p>
</td>
</tr>
<tr>
<th>
package
</th>
<td>
<p>Application</p>
</td>
</tr>
</table>
<h3><i class="icon-custom icon-method"></i> Methods</h3>
<a id="method_assertModifiable"></a>
<div class="element clickable method private method_assertModifiable" data-toggle="collapse" data-target=".method_assertModifiable .collapse">
<h2>assertModifiable</h2>
<pre>assertModifiable() : void</pre>
<div class="labels">
</div>
<div class="row collapse">
<div class="detail-description">
<div class="long_description"></div>
<table class="table">
<tr>
<th>
</th>
<td>
</td>
</tr>
<tr>
<th>
</th>
<td>
</td>
</tr>
</table>
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
</div>
</div>
</div>
<a id="method_count"></a>
<div class="element clickable method public method_count" data-toggle="collapse" data-target=".method_count .collapse">
<h2>count</h2>
<pre>count() : int</pre>
<div class="labels">
</div>
<div class="row collapse">
<div class="detail-description">
<div class="long_description"></div>
<table class="table">
<tr>
<th>
</th>
<td>
</td>
</tr>
<tr>
<th>
</th>
<td>
</td>
</tr>
</table>
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
<h3>Response</h3>
<code>
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
int</code><p></p>
</div>
</div>
</div>
<a id="method_get"></a>
<div class="element clickable method public method_get" data-toggle="collapse" data-target=".method_get .collapse">
<h2>The value for the given key, or `null` if $key is not in the map.</h2>
<pre>get(\ScssPhp\ScssPhp\Value\Valuekey) : \ScssPhp\ScssPhp\Collection\T|null</pre>
<div class="labels">
</div>
<div class="row collapse">
<div class="detail-description">
<div class="long_description"></div>
<table class="table">
<tr>
<th>
</th>
<td>
</td>
</tr>
<tr>
<th>
</th>
<td>
</td>
</tr>
</table>
<h3>Arguments</h3>
<div class="subelement argument">
<h4>key</h4>
<code>
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
\ScssPhp\ScssPhp\Value\Value</code><p></p>
</div>
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
<h3>Response</h3>
<code>
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
\ScssPhp\ScssPhp\Collection\T|null</code><p></p>
</div>
</div>
</div>
<a id="method_getIterator"></a>
<div class="element clickable method public method_getIterator" data-toggle="collapse" data-target=".method_getIterator .collapse">
<h2>getIterator</h2>
<pre>getIterator() : \Traversable</pre>
<div class="labels">
</div>
<div class="row collapse">
<div class="detail-description">
<div class="long_description"></div>
<table class="table">
<tr>
<th>
</th>
<td>
</td>
</tr>
<tr>
<th>
</th>
<td>
</td>
</tr>
</table>
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
<h3>Response</h3>
<code>
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
\Traversable</code><p></p>
</div>
</div>
</div>
<a id="method_of"></a>
<div class="element clickable method public method_of" data-toggle="collapse" data-target=".method_of .collapse">
<h2>Returns a modifiable version of the Map.</h2>
<pre>of(\ScssPhp\ScssPhp\Collection\Map&lt;\ScssPhp\ScssPhp\Collection\V&gt;map) : \ScssPhp\ScssPhp\Collection\Map&lt;\ScssPhp\ScssPhp\Collection\V&gt;</pre>
<div class="labels">
<span class="label">static</span> </div>
<div class="row collapse">
<div class="detail-description">
<div class="long_description"></div>
<table class="table">
<tr>
<th>
template
</th>
<td>
<p>V</p>
</td>
</tr>
<tr>
<th>
</th>
<td>
</td>
</tr>
</table>
<h3>Arguments</h3>
<div class="subelement argument">
<h4>map</h4>
<code>
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
\ScssPhp\ScssPhp\Collection\Map<\ScssPhp\ScssPhp\Collection\V></code><p></p>
</div>
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
<h3>Response</h3>
<code>
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
\ScssPhp\ScssPhp\Collection\Map<\ScssPhp\ScssPhp\Collection\V></code><p></p>
</div>
</div>
</div>
<a id="method_put"></a>
<div class="element clickable method public method_put" data-toggle="collapse" data-target=".method_put .collapse">
<h2>Associates the key with the given value.</h2>
<pre>put(\ScssPhp\ScssPhp\Value\Valuekey, \ScssPhp\ScssPhp\Collection\Tvalue) : void</pre>
<div class="labels">
</div>
<div class="row collapse">
<div class="detail-description">
<div class="long_description"><p>If the key was already in the map, its associated value is changed.
Otherwise the key/value pair is added to the map.</p>
</div>
<table class="table">
<tr>
<th>
</th>
<td>
</td>
</tr>
<tr>
<th>
</th>
<td>
</td>
</tr>
</table>
<h3>Arguments</h3>
<div class="subelement argument">
<h4>key</h4>
<code>
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
\ScssPhp\ScssPhp\Value\Value</code><p></p>
</div>
<div class="subelement argument">
<h4>value</h4>
<code>
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
\ScssPhp\ScssPhp\Collection\T</code><p></p>
</div>
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
</div>
</div>
</div>
<a id="method_remove"></a>
<div class="element clickable method public method_remove" data-toggle="collapse" data-target=".method_remove .collapse">
<h2>Removes $key and its associated value, if present, from the map.</h2>
<pre>remove(\ScssPhp\ScssPhp\Value\Valuekey) : \ScssPhp\ScssPhp\Collection\T|null</pre>
<div class="labels">
</div>
<div class="row collapse">
<div class="detail-description">
<div class="long_description"><p>Returns the value associated with <code class="prettyprint">key</code> before it was removed.
Returns <code class="prettyprint">null</code> if <code class="prettyprint">key</code> was not in the map.</p>
<p>Note that some maps allow <code class="prettyprint">null</code> as a value,
so a returned <code class="prettyprint">null</code> value doesn't always mean that the key was absent.</p>
</div>
<table class="table">
<tr>
<th>
</th>
<td>
</td>
</tr>
<tr>
<th>
</th>
<td>
</td>
</tr>
</table>
<h3>Arguments</h3>
<div class="subelement argument">
<h4>key</h4>
<code>
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
\ScssPhp\ScssPhp\Value\Value</code><p></p>
</div>
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
<h3>Response</h3>
<code>
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
\ScssPhp\ScssPhp\Collection\T|null</code><p></p>
</div>
</div>
</div>
<a id="method_unmodifiable"></a>
<div class="element clickable method public method_unmodifiable" data-toggle="collapse" data-target=".method_unmodifiable .collapse">
<h2>Returns an unmodifiable version of the Map.</h2>
<pre>unmodifiable(\ScssPhp\ScssPhp\Collection\Map&lt;\ScssPhp\ScssPhp\Collection\V&gt;map) : \ScssPhp\ScssPhp\Collection\Map&lt;\ScssPhp\ScssPhp\Collection\V&gt;</pre>
<div class="labels">
<span class="label">static</span> </div>
<div class="row collapse">
<div class="detail-description">
<div class="long_description"><p>All mutators will throw a LogicException when trying to use them.</p>
</div>
<table class="table">
<tr>
<th>
template
</th>
<td>
<p>V</p>
</td>
</tr>
<tr>
<th>
</th>
<td>
</td>
</tr>
</table>
<h3>Arguments</h3>
<div class="subelement argument">
<h4>map</h4>
<code>
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
\ScssPhp\ScssPhp\Collection\Map<\ScssPhp\ScssPhp\Collection\V></code><p></p>
</div>
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
<h3>Response</h3>
<code>
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
\ScssPhp\ScssPhp\Collection\Map<\ScssPhp\ScssPhp\Collection\V></code><p></p>
</div>
</div>
</div>
<h3><i class="icon-custom icon-property"></i> Properties</h3>
<a id="property_modifiable"> </a>
<div class="element clickable property private property_modifiable" data-toggle="collapse" data-target=".property_modifiable .collapse">
<h2>modifiable</h2>
<pre>modifiable : bool</pre>
<div class="labels">
</div>
<div class="row collapse">
<div class="detail-description">
<div class="long_description"></div>
<table class="table">
<tr>
<th>
</th>
<td>
</td>
</tr>
<tr>
<th>
</th>
<td>
</td>
</tr>
</table>
<h3>Type(s)</h3>
<code>bool</code>
</div>
</div>
</div>
<a id="property_pairs"> </a>
<div class="element clickable property private property_pairs" data-toggle="collapse" data-target=".property_pairs .collapse">
<h2></h2>
<pre>pairs : array&lt;int,array{: \ScssPhp\ScssPhp\Value\Value, : \ScssPhp\ScssPhp\Collection\T}&gt;</pre>
<div class="labels">
</div>
<div class="row collapse">
<div class="detail-description">
<div class="long_description"></div>
<table class="table">
<tr>
<th>
var
</th>
<td>
</td>
</tr>
<tr>
<th>
</th>
<td>
</td>
</tr>
</table>
<h3>Type(s)</h3>
<code>array&lt;int, <abbr title="array{: \ScssPhp\ScssPhp\Value\Value, : \ScssPhp\ScssPhp\Collection\T}">T}</abbr>&gt;</code>
</div>
</div>
</div>
</div>
</div>
<a id="\ScssPhp\ScssPhp\Collection\Map"></a>
<ul class="breadcrumb">
<li><a href="index.html"><i class="icon-custom icon-class"></i></a></li>
<li><span class="divider">\</span><a href="\ScssPhp\ScssPhp\Collection">Collection</a></li>
<li class="active"><span class="divider">\</span><a href="\ScssPhp\ScssPhp\Collection\Map">Map</a></li>
</ul>
</div>
</div>
</div>
<footer class="span12">
Template is built using <a href="https://getbootstrap.com/">Twitter Bootstrap 2</a> and icons provided by
<a href="https://glyphicons.com/">Glyphicons</a>.<br/>
Documentation is powered by <a href="https://www.phpdoc.org/">phpDocumentor </a> and<br/>
generated on Thu, 21 Nov 2024 01:33:24 +0000.<br/>
</footer>
</body>
</html>