phpdoc/Patterns/Interfaces/ArrayInterface.html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="robots" content="index, follow, all" />
<title>Patterns\Interfaces\ArrayInterface | Patterns</title>
<link rel="stylesheet" type="text/css" href="../../css/bootstrap.min.css">
<link rel="stylesheet" type="text/css" href="../../css/bootstrap-theme.min.css">
<link rel="stylesheet" type="text/css" href="../../css/sami.css">
<script src="../../js/jquery-1.11.1.min.js"></script>
<script src="../../js/bootstrap.min.js"></script>
<script src="../../js/typeahead.min.js"></script>
<script src="../../sami.js"></script>
<meta name="MobileOptimized" content="width">
<meta name="HandheldFriendly" content="true">
<meta name="viewport" content="width=device-width,initial-scale=1,maximum-scale=1">
</head>
<body id="class" data-name="class:Patterns_Interfaces_ArrayInterface" data-root-path="../../">
<div id="content">
<div id="left-column">
<div id="control-panel">
<form id="search-form" action="../../search.html" method="GET">
<span class="glyphicon glyphicon-search"></span>
<input name="search"
class="typeahead form-control"
type="search"
placeholder="Search">
</form>
</div>
<div id="api-tree"></div>
</div>
<div id="right-column">
<nav id="site-nav" class="navbar navbar-default" role="navigation">
<div class="container-fluid">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar-elements">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../../index.html">Patterns</a>
</div>
<div class="collapse navbar-collapse" id="navbar-elements">
<ul class="nav navbar-nav">
<li><a href="../../classes.html">Classes</a></li>
<li><a href="../../namespaces.html">Namespaces</a></li>
<li><a href="../../interfaces.html">Interfaces</a></li>
<li><a href="../../traits.html">Traits</a></li>
<li><a href="../../doc-index.html">Index</a></li>
<li><a href="../../search.html">Search</a></li>
</ul>
</div>
</div>
</nav>
<div class="namespace-breadcrumbs">
<ol class="breadcrumb">
<li><span class="label label-default">interface</span></li>
<li><a href="../../Patterns.html">Patterns</a></li>
<li><a href="../../Patterns/Interfaces.html">Interfaces</a></li>
<li>ArrayInterface</li>
</ol>
</div>
<div id="page-content">
<div class="page-header">
<h1>ArrayInterface</h1>
</div>
<p> interface
<strong>ArrayInterface</strong> implements
<a target="_blank" href="http://php.net/ArrayAccess"><abbr title="ArrayAccess">ArrayAccess</abbr></a>
</p>
<div class="description">
<p>Array interface</p> </div>
<h2>Methods</h2>
<div class="container-fluid underlined">
<div class="row">
<div class="col-md-2 type">
</div>
<div class="col-md-8 type">
<a href="#method_shift">shift</a>()
<p>Deletes a value at the beginning of the collection</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
</div>
<div class="col-md-8 type">
<a href="#method_pop">pop</a>()
<p>Deletes a value at the end of the collection</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
</div>
<div class="col-md-8 type">
<a href="#method_unshift">unshift</a>(
mixed $value)
<p>Pushes a new value at the beginning of the collection, with no specific index</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
</div>
<div class="col-md-8 type">
<a href="#method_push">push</a>(
mixed $value)
<p>Pushes a new value at the end of the collection, with no specific index</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
int
</div>
<div class="col-md-8 type">
<a href="#method_count">count</a>()
<p>Counts the number of entries in the collection</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
</div>
<div class="col-md-8 type">
<a href="#method_each">each</a>()
<p>Returns the current key=>value pair and put increase the index</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
bool
</div>
<div class="col-md-8 type">
<a href="#method_in_array">in_array</a>(
mixed $value)
<p>Search a value in the current array and returns true if so</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
bool
</div>
<div class="col-md-8 type">
<a href="#method_key_exists">key_exists</a>(
mixed $index)
<p>Search if an entry exists with this key</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
array
</div>
<div class="col-md-8 type">
<a href="#method_values">values</a>()
<p>Returns an array with all values of the original array</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
array
</div>
<div class="col-md-8 type">
<a href="#method_keys">keys</a>()
<p>Returns an array with all keys of the original array</p> </div>
<div class="col-md-2"></div>
</div>
</div>
<h2>Details</h2>
<div id="method-details">
<div class="method-item">
<h3 id="method_shift">
<div class="location">at line 39</div>
<code>
<strong>shift</strong>()</code>
</h3>
<div class="details">
<div class="method-description">
<p>Deletes a value at the beginning of the collection</p> </div>
<div class="tags">
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_pop">
<div class="location">at line 44</div>
<code>
<strong>pop</strong>()</code>
</h3>
<div class="details">
<div class="method-description">
<p>Deletes a value at the end of the collection</p> </div>
<div class="tags">
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_unshift">
<div class="location">at line 50</div>
<code>
<strong>unshift</strong>(
mixed $value)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Pushes a new value at the beginning of the collection, with no specific index</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
mixed</td>
<td>$value</td>
<td>The new value to add in the collection</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_push">
<div class="location">at line 56</div>
<code>
<strong>push</strong>(
mixed $value)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Pushes a new value at the end of the collection, with no specific index</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
mixed</td>
<td>$value</td>
<td>The new value to add in the collection</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_count">
<div class="location">at line 62</div>
<code>
int
<strong>count</strong>()</code>
</h3>
<div class="details">
<div class="method-description">
<p>Counts the number of entries in the collection</p> </div>
<div class="tags">
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
int</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_each">
<div class="location">at line 67</div>
<code>
<strong>each</strong>()</code>
</h3>
<div class="details">
<div class="method-description">
<p>Returns the current key=>value pair and put increase the index</p> </div>
<div class="tags">
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_in_array">
<div class="location">at line 74</div>
<code>
bool
<strong>in_array</strong>(
mixed $value)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Search a value in the current array and returns true if so</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
mixed</td>
<td>$value</td>
<td>The value to test</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
bool</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_key_exists">
<div class="location">at line 81</div>
<code>
bool
<strong>key_exists</strong>(
mixed $index)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Search if an entry exists with this key</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
mixed</td>
<td>$index</td>
<td>The index to test</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
bool</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_values">
<div class="location">at line 87</div>
<code>
array
<strong>values</strong>()</code>
</h3>
<div class="details">
<div class="method-description">
<p>Returns an array with all values of the original array</p> </div>
<div class="tags">
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
array</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_keys">
<div class="location">at line 93</div>
<code>
array
<strong>keys</strong>()</code>
</h3>
<div class="details">
<div class="method-description">
<p>Returns an array with all keys of the original array</p> </div>
<div class="tags">
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
array</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
</div>
</div>
<div id="footer">
Generated by <a href="http://sami.sensiolabs.org/">Sami, the API Documentation Generator</a>.
</div>
</div>
</div>
</body>
</html>