docs/class-GuzzleHttp.Promise.EachPromise.html
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class GuzzleHttp\Promise\EachPromise | ξ ^ω^)ξ Baguette PHP Mastodon API Client / SDK</title>
<link rel="stylesheet" href="resources/style.css?c2f33731c1948fbed7c333554678bfa68d4817da">
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li>
<a href="namespace-Baguette.html">
Baguette<span></span>
</a>
<ul>
<li>
<a href="namespace-Baguette.Mastodon.html">
Mastodon<span></span>
</a>
<ul>
<li class="main">
<a href="namespace-Baguette.Mastodon.Config.html">
Config </a>
</li>
<li class="main">
<a href="namespace-Baguette.Mastodon.Entity.html">
Entity </a>
</li>
<li class="main">
<a href="namespace-Baguette.Mastodon.Grant.html">
Grant </a>
</li>
<li class="main">
<a href="namespace-Baguette.Mastodon.Service.html">
Service </a>
</li>
</ul></li></ul></li>
<li class="active">
<a href="namespace-GuzzleHttp.html">
GuzzleHttp<span></span>
</a>
<ul>
<li>
<a href="namespace-GuzzleHttp.Cookie.html">
Cookie </a>
</li>
<li>
<a href="namespace-GuzzleHttp.Exception.html">
Exception </a>
</li>
<li>
<a href="namespace-GuzzleHttp.Handler.html">
Handler </a>
</li>
<li class="active">
<a href="namespace-GuzzleHttp.Promise.html">
Promise </a>
</li>
</ul></li>
<li>
<a href="namespace-Psr.html">
Psr<span></span>
</a>
<ul>
<li>
<a href="namespace-Psr.Http.html">
Http<span></span>
</a>
<ul>
<li>
<a href="namespace-Psr.Http.Message.html">
Message </a>
</li>
</ul></li></ul></li>
<li>
<a href="namespace-Teto.html">
Teto<span></span>
</a>
<ul>
<li>
<a href="namespace-Teto.Object.html">
Object </a>
</li>
</ul></li>
</ul>
</div>
<hr>
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-GuzzleHttp.Promise.Coroutine.html">Coroutine</a></li>
<li class="active"><a href="class-GuzzleHttp.Promise.EachPromise.html">EachPromise</a></li>
<li><a href="class-GuzzleHttp.Promise.FulfilledPromise.html">FulfilledPromise</a></li>
<li><a href="class-GuzzleHttp.Promise.Promise.html">Promise</a></li>
<li><a href="class-GuzzleHttp.Promise.RejectedPromise.html">RejectedPromise</a></li>
<li><a href="class-GuzzleHttp.Promise.TaskQueue.html">TaskQueue</a></li>
</ul>
<h3>Interfaces</h3>
<ul>
<li><a href="class-GuzzleHttp.Promise.PromiseInterface.html">PromiseInterface</a></li>
<li><a href="class-GuzzleHttp.Promise.PromisorInterface.html">PromisorInterface</a></li>
<li><a href="class-GuzzleHttp.Promise.TaskQueueInterface.html">TaskQueueInterface</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-GuzzleHttp.Promise.AggregateException.html">AggregateException</a></li>
<li><a href="class-GuzzleHttp.Promise.CancellationException.html">CancellationException</a></li>
<li><a href="class-GuzzleHttp.Promise.RejectionException.html">RejectionException</a></li>
</ul>
<h3>Functions</h3>
<ul>
<li><a href="function-GuzzleHttp.Promise.all.html">all</a></li>
<li><a href="function-GuzzleHttp.Promise.any.html">any</a></li>
<li><a href="function-GuzzleHttp.Promise.coroutine.html">coroutine</a></li>
<li><a href="function-GuzzleHttp.Promise.each.html">each</a></li>
<li><a href="function-GuzzleHttp.Promise.each_limit.html">each_limit</a></li>
<li><a href="function-GuzzleHttp.Promise.each_limit_all.html">each_limit_all</a></li>
<li><a href="function-GuzzleHttp.Promise.exception_for.html">exception_for</a></li>
<li><a href="function-GuzzleHttp.Promise.inspect.html">inspect</a></li>
<li><a href="function-GuzzleHttp.Promise.inspect_all.html">inspect_all</a></li>
<li><a href="function-GuzzleHttp.Promise.is_fulfilled.html">is_fulfilled</a></li>
<li><a href="function-GuzzleHttp.Promise.is_rejected.html">is_rejected</a></li>
<li><a href="function-GuzzleHttp.Promise.is_settled.html">is_settled</a></li>
<li><a href="function-GuzzleHttp.Promise.iter_for.html">iter_for</a></li>
<li><a href="function-GuzzleHttp.Promise.promise_for.html">promise_for</a></li>
<li><a href="function-GuzzleHttp.Promise.queue.html">queue</a></li>
<li><a href="function-GuzzleHttp.Promise.rejection_for.html">rejection_for</a></li>
<li><a href="function-GuzzleHttp.Promise.settle.html">settle</a></li>
<li><a href="function-GuzzleHttp.Promise.some.html">some</a></li>
<li><a href="function-GuzzleHttp.Promise.task.html">task</a></li>
<li><a href="function-GuzzleHttp.Promise.unwrap.html">unwrap</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="">
<input type="hidden" name="ie" value="UTF-8">
<input type="text" name="q" class="text" placeholder="Search">
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-GuzzleHttp.Promise.html" title="Summary of GuzzleHttp\Promise"><span>Namespace</span></a>
</li>
<li class="active">
<span>Class</span> </li>
</ul>
<ul>
</ul>
<ul>
</ul>
</div>
<div id="content" class="class">
<h1>Class EachPromise</h1>
<div class="description">
<p>Represents a promise that iterates over many promises and invokes
side-effect functions in the process.</p>
</div>
<dl class="tree">
<dd style="padding-left:0px">
<b><span>GuzzleHttp\Promise\EachPromise</span></b>
implements
<a href="class-GuzzleHttp.Promise.PromisorInterface.html"><span>GuzzleHttp\Promise\PromisorInterface</span></a>
</dd>
</dl>
<div class="info">
<b>Namespace:</b> <a href="namespace-GuzzleHttp.html">GuzzleHttp</a>\<a href="namespace-GuzzleHttp.Promise.html">Promise</a><br>
<b>Located at</b> <a href="source-class-GuzzleHttp.Promise.EachPromise.html#4-229" title="Go to source code">EachPromise.php</a>
<br>
</div>
<table class="summary methods" id="methods">
<caption>Methods summary</caption>
<tr data-order="__construct" id="___construct">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#___construct">#</a>
<code><a href="source-class-GuzzleHttp.Promise.EachPromise.html#30-66" title="Go to source code">__construct</a>( <span>mixed <var>$iterable</var></span>, <span>array <var>$config</var> = []</span> )</code>
<div class="description short">
<p>Configuration hash can include the following key value pairs:</p>
</div>
<div class="description detailed hidden">
<p>Configuration hash can include the following key value pairs:</p>
<ul>
<li>fulfilled: (callable) Invoked when a promise fulfills. The function is invoked with three arguments: the fulfillment value, the index position from the iterable list of the promise, and the aggregate promise that manages all of the promises. The aggregate promise may be resolved from within the callback to short-circuit the promise.</li>
<li>rejected: (callable) Invoked when a promise is rejected. The function is invoked with three arguments: the rejection reason, the index position from the iterable list of the promise, and the aggregate promise that manages all of the promises. The aggregate promise may be resolved from within the callback to short-circuit the promise.</li>
<li>concurrency: (integer) Pass this configuration option to limit the allowed number of outstanding concurrently executing promises, creating a capped pool of promises. There is no limit by default.</li>
</ul>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$iterable</var></dt>
<dd>Promises or values to iterate.</dd>
<dt><var>$config</var></dt>
<dd>Configuration options</dd>
</dl></div>
</div>
</div></td>
</tr>
<tr data-order="promise" id="_promise">
<td class="attributes"><code>
public
<code><a href="class-GuzzleHttp.Promise.PromiseInterface.html">GuzzleHttp\Promise\PromiseInterface</a></code>
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_promise">#</a>
<code><a href="source-class-GuzzleHttp.Promise.EachPromise.html#68-85" title="Go to source code">promise</a>( )</code>
<div class="description short">
<p>Returns a promise.</p>
</div>
<div class="description detailed hidden">
<p>Returns a promise.</p>
<h4>Returns</h4>
<div class="list">
<code><a href="class-GuzzleHttp.Promise.PromiseInterface.html">GuzzleHttp\Promise\PromiseInterface</a></code>
</div>
<h4>Implementation of</h4>
<div class="list"><code><a href="class-GuzzleHttp.Promise.PromisorInterface.html#_promise">GuzzleHttp\Promise\PromisorInterface::promise()</a></code></div>
</div>
</div></td>
</tr>
</table>
</div>
<div id="footer">
ξ ^ω^)ξ Baguette PHP Mastodon API Client / SDK API documentation generated by <a href="http://apigen.org">ApiGen</a>
</div>
</div>
</div>
<script src="resources/combined.js"></script>
<script src="elementlist.js"></script>
</body>
</html>