Skip to content

Commit

Permalink
Minor updates to documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
stefangabos committed Mar 17, 2022
1 parent cc4fcf5 commit 5c8f9a6
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
6 changes: 3 additions & 3 deletions Zebra_cURL.php
Original file line number Diff line number Diff line change
Expand Up @@ -1499,7 +1499,7 @@ public function option($option, $value = '') {
* ...and will unset the following options:
*
* - `CURLOPT_BINARYTRANSFER`
* - `CURLOPT_HTTPGET` = `TRUE`
* - `CURLOPT_HTTPGET`
* - `CURLOPT_FILE`
*
* Multiple requests are processed asynchronously, in parallel, and the callback function is called for each and every
Expand Down Expand Up @@ -1626,7 +1626,7 @@ public function patch($urls, $callback = '') {
*
* - `CURLOPT_BINARYTRANSFER`
* - `CURLOPT_CUSTOMREQUEST`
* - `CURLOPT_HTTPGET` = `TRUE`
* - `CURLOPT_HTTPGET`
* - `CURLOPT_FILE`
*
* Multiple requests are processed asynchronously, in parallel, and the callback function is called for each and every
Expand Down Expand Up @@ -1952,7 +1952,7 @@ public function proxy($proxy, $port = 80, $username = '', $password = '') {
* ...and will unset the following options:
*
* - `CURLOPT_BINARYTRANSFER`
* - `CURLOPT_HTTPGET` = `TRUE`
* - `CURLOPT_HTTPGET`
* - `CURLOPT_FILE`
*
* Multiple requests are processed asynchronously, in parallel, and the callback function is called for each and every
Expand Down
6 changes: 3 additions & 3 deletions docs/Zebra_cURL/Zebra_cURL.html
Original file line number Diff line number Diff line change
Expand Up @@ -976,7 +976,7 @@ <h5>Arguments</h5>
</div>
<h4 id="methodpatch" class="method"><span><em>method</em></span> patch()</h4>
<p>Performs an HTTP <code>PATCH</code> request to one or more URLs and executes the callback function specified by the <em>$callback</em> argument for each and every request, as soon as the request finishes.</p>
<p>This method will automatically set the following options:</p><p><ul><li><code>CURLINFO_HEADER_OUT</code> - <code>TRUE</code></li><li><code>CURLOPT_CUSTOMREQUEST</code> - <code>PATCH</code></li><li><code>CURLOPT_HEADER</code> - <code>TRUE</code></li><li><code>CURLOPT_NOBODY</code> - <code>FALSE</code></li><li><code>CURLOPT_POST</code> - <code>FALSE</code></li><li><code>CURLOPT_POSTFIELDS</code> - the POST data</li></ul><p> ...and will unset the following options:</p><p><ul><li><code>CURLOPT_BINARYTRANSFER</code></li><li><code>CURLOPT_HTTPGET</code> = <code>TRUE</code></li><li><code>CURLOPT_FILE</code></li></ul><p> Multiple requests are processed asynchronously, in parallel, and the callback function is called for each and every request as soon as the request finishes. The number of parallel requests to be constantly processed, at all times, is set through the <a href="../Zebra_cURL/Zebra_cURL.html#var$threads">threads</a> property. See also <a href="../Zebra_cURL/Zebra_cURL.html#var$pause_interval">pause_interval</a>.</p><p class="highlight">Because requests are done asynchronously, when initiating multiple requests at once, these may not finish in the order in which they were initiated!</p><ol class="code"><li><div class="src-line"><span class="src-comm">//&nbsp;instantiate&nbsp;the&nbsp;class</span></div></li>
<p>This method will automatically set the following options:</p><p><ul><li><code>CURLINFO_HEADER_OUT</code> - <code>TRUE</code></li><li><code>CURLOPT_CUSTOMREQUEST</code> - <code>PATCH</code></li><li><code>CURLOPT_HEADER</code> - <code>TRUE</code></li><li><code>CURLOPT_NOBODY</code> - <code>FALSE</code></li><li><code>CURLOPT_POST</code> - <code>FALSE</code></li><li><code>CURLOPT_POSTFIELDS</code> - the POST data</li></ul><p> ...and will unset the following options:</p><p><ul><li><code>CURLOPT_BINARYTRANSFER</code></li><li><code>CURLOPT_HTTPGET</code></li><li><code>CURLOPT_FILE</code></li></ul><p> Multiple requests are processed asynchronously, in parallel, and the callback function is called for each and every request as soon as the request finishes. The number of parallel requests to be constantly processed, at all times, is set through the <a href="../Zebra_cURL/Zebra_cURL.html#var$threads">threads</a> property. See also <a href="../Zebra_cURL/Zebra_cURL.html#var$pause_interval">pause_interval</a>.</p><p class="highlight">Because requests are done asynchronously, when initiating multiple requests at once, these may not finish in the order in which they were initiated!</p><ol class="code"><li><div class="src-line"><span class="src-comm">//&nbsp;instantiate&nbsp;the&nbsp;class</span></div></li>
<li><div class="src-line"><span class="src-var">$curl&nbsp;</span>=&nbsp;<span class="src-key">new&nbsp;</span><span class="src-id"><a href="../Zebra_cURL/Zebra_cURL.html">Zebra_cURL</a></span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line">&nbsp;</div></li>
<li><div class="src-line"><span class="src-comm">//&nbsp;if&nbsp;making&nbsp;requests&nbsp;over&nbsp;HTTPS&nbsp;we&nbsp;need&nbsp;to&nbsp;load&nbsp;a&nbsp;CA&nbsp;bundle</span></div></li>
Expand Down Expand Up @@ -1057,7 +1057,7 @@ <h5>Tags</h5>
</div>
<h4 id="methodpost" class="method"><span><em>method</em></span> post()</h4>
<p>Performs an HTTP <code>POST</code> request to one or more URLs and executes the callback function specified by the <em>$callback</em> argument for each and every request, as soon as the request finishes.</p>
<p>This method will automatically set the following options:</p><p><ul><li><code>CURLINFO_HEADER_OUT</code> = <code>TRUE</code></li><li><code>CURLOPT_HEADER</code> = <code>TRUE</code></li><li><code>CURLOPT_NOBODY</code> = <code>FALSE</code></li><li><code>CURLOPT_POST</code> = <code>TRUE</code></li><li><code>CURLOPT_POSTFIELDS</code> = the POST data</li></ul><p> ...and will unset the following options:</p><p><ul><li><code>CURLOPT_BINARYTRANSFER</code></li><li><code>CURLOPT_CUSTOMREQUEST</code></li><li><code>CURLOPT_HTTPGET</code> = <code>TRUE</code></li><li><code>CURLOPT_FILE</code></li></ul><p> Multiple requests are processed asynchronously, in parallel, and the callback function is called for each and every request as soon as the request finishes. The number of parallel requests to be constantly processed, at all times, is set through the <a href="../Zebra_cURL/Zebra_cURL.html#var$threads">threads</a> property. See also <a href="../Zebra_cURL/Zebra_cURL.html#var$pause_interval">pause_interval</a>.</p><p class="highlight">Because requests are done asynchronously, when initiating multiple requests at once, these may not finish in the order in which they were initiated!</p><ol class="code"><li><div class="src-line"><span class="src-comm">//&nbsp;instantiate&nbsp;the&nbsp;class</span></div></li>
<p>This method will automatically set the following options:</p><p><ul><li><code>CURLINFO_HEADER_OUT</code> = <code>TRUE</code></li><li><code>CURLOPT_HEADER</code> = <code>TRUE</code></li><li><code>CURLOPT_NOBODY</code> = <code>FALSE</code></li><li><code>CURLOPT_POST</code> = <code>TRUE</code></li><li><code>CURLOPT_POSTFIELDS</code> = the POST data</li></ul><p> ...and will unset the following options:</p><p><ul><li><code>CURLOPT_BINARYTRANSFER</code></li><li><code>CURLOPT_CUSTOMREQUEST</code></li><li><code>CURLOPT_HTTPGET</code></li><li><code>CURLOPT_FILE</code></li></ul><p> Multiple requests are processed asynchronously, in parallel, and the callback function is called for each and every request as soon as the request finishes. The number of parallel requests to be constantly processed, at all times, is set through the <a href="../Zebra_cURL/Zebra_cURL.html#var$threads">threads</a> property. See also <a href="../Zebra_cURL/Zebra_cURL.html#var$pause_interval">pause_interval</a>.</p><p class="highlight">Because requests are done asynchronously, when initiating multiple requests at once, these may not finish in the order in which they were initiated!</p><ol class="code"><li><div class="src-line"><span class="src-comm">//&nbsp;instantiate&nbsp;the&nbsp;class</span></div></li>
<li><div class="src-line"><span class="src-var">$curl&nbsp;</span>=&nbsp;<span class="src-key">new&nbsp;</span><span class="src-id"><a href="../Zebra_cURL/Zebra_cURL.html">Zebra_cURL</a></span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line">&nbsp;</div></li>
<li><div class="src-line"><span class="src-comm">//&nbsp;if&nbsp;making&nbsp;requests&nbsp;over&nbsp;HTTPS&nbsp;we&nbsp;need&nbsp;to&nbsp;load&nbsp;a&nbsp;CA&nbsp;bundle</span></div></li>
Expand Down Expand Up @@ -1289,7 +1289,7 @@ <h5>Arguments</h5>
</div>
<h4 id="methodput" class="method"><span><em>method</em></span> put()</h4>
<p>Performs an HTTP <code>PUT</code> request to one or more URLs and executes the callback function specified by the <em>$callback</em> argument for each and every request, as soon as the request finishes.</p>
<p>This method will automatically set the following options:</p><p><ul><li><code>CURLINFO_HEADER_OUT</code> - <code>TRUE</code></li><li><code>CURLOPT_CUSTOMREQUEST</code> - <code>PUT</code></li><li><code>CURLOPT_HEADER</code> - <code>TRUE</code></li><li><code>CURLOPT_NOBODY</code> - <code>FALSE</code></li><li><code>CURLOPT_POST</code> - <code>FALSE</code></li><li><code>CURLOPT_POSTFIELDS</code> - the POST data</li></ul><p> ...and will unset the following options:</p><p><ul><li><code>CURLOPT_BINARYTRANSFER</code></li><li><code>CURLOPT_HTTPGET</code> = <code>TRUE</code></li><li><code>CURLOPT_FILE</code></li></ul><p> Multiple requests are processed asynchronously, in parallel, and the callback function is called for each and every request as soon as the request finishes. The number of parallel requests to be constantly processed, at all times, is set through the <a href="../Zebra_cURL/Zebra_cURL.html#var$threads">threads</a> property. See also <a href="../Zebra_cURL/Zebra_cURL.html#var$pause_interval">pause_interval</a>.</p><p class="highlight">Because requests are done asynchronously, when initiating multiple requests at once, these may not finish in the order in which they were initiated!</p><ol class="code"><li><div class="src-line"><span class="src-comm">//&nbsp;instantiate&nbsp;the&nbsp;class</span></div></li>
<p>This method will automatically set the following options:</p><p><ul><li><code>CURLINFO_HEADER_OUT</code> - <code>TRUE</code></li><li><code>CURLOPT_CUSTOMREQUEST</code> - <code>PUT</code></li><li><code>CURLOPT_HEADER</code> - <code>TRUE</code></li><li><code>CURLOPT_NOBODY</code> - <code>FALSE</code></li><li><code>CURLOPT_POST</code> - <code>FALSE</code></li><li><code>CURLOPT_POSTFIELDS</code> - the POST data</li></ul><p> ...and will unset the following options:</p><p><ul><li><code>CURLOPT_BINARYTRANSFER</code></li><li><code>CURLOPT_HTTPGET</code></li><li><code>CURLOPT_FILE</code></li></ul><p> Multiple requests are processed asynchronously, in parallel, and the callback function is called for each and every request as soon as the request finishes. The number of parallel requests to be constantly processed, at all times, is set through the <a href="../Zebra_cURL/Zebra_cURL.html#var$threads">threads</a> property. See also <a href="../Zebra_cURL/Zebra_cURL.html#var$pause_interval">pause_interval</a>.</p><p class="highlight">Because requests are done asynchronously, when initiating multiple requests at once, these may not finish in the order in which they were initiated!</p><ol class="code"><li><div class="src-line"><span class="src-comm">//&nbsp;instantiate&nbsp;the&nbsp;class</span></div></li>
<li><div class="src-line"><span class="src-var">$curl&nbsp;</span>=&nbsp;<span class="src-key">new&nbsp;</span><span class="src-id"><a href="../Zebra_cURL/Zebra_cURL.html">Zebra_cURL</a></span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
<li><div class="src-line">&nbsp;</div></li>
<li><div class="src-line"><span class="src-comm">//&nbsp;if&nbsp;making&nbsp;requests&nbsp;over&nbsp;HTTPS&nbsp;we&nbsp;need&nbsp;to&nbsp;load&nbsp;a&nbsp;CA&nbsp;bundle</span></div></li>
Expand Down

0 comments on commit 5c8f9a6

Please sign in to comment.