Sophie

Sophie

distrib > Mageia > 7 > armv7hl > by-pkgid > 2b917e0437961edec048f1d15e2d7449 > files > 10421

php-manual-en-7.2.11-1.mga7.noarch.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
 <head>
  <meta http-equiv="content-type" content="text/html; charset=UTF-8">
  <title>Skip given number of elements to be returned</title>

 </head>
 <body><div class="manualnavbar" style="text-align: center;">
 <div class="prev" style="text-align: left; float: left;"><a href="mysql-xdevapi-collectionfind.lockshared.html">CollectionFind::lockShared</a></div>
 <div class="next" style="text-align: right; float: right;"><a href="mysql-xdevapi-collectionfind.sort.html">CollectionFind::sort</a></div>
 <div class="up"><a href="class.mysql-xdevapi-collectionfind.html">mysql_xdevapi\CollectionFind</a></div>
 <div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="mysql-xdevapi-collectionfind.offset" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">CollectionFind::offset</h1>
  <p class="verinfo">(No version information available, might only be in Git)</p><p class="refpurpose"><span class="refname">CollectionFind::offset</span> &mdash; <span class="dc-title">Skip given number of elements to be returned</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-mysql-xdevapi-collectionfind.offset-description">
  <h3 class="title">Description</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="type"><span class="type mysql_xdevapi\CollectionFind">mysql_xdevapi\CollectionFind</span></span> <span class="methodname"><strong>mysql_xdevapi\CollectionFind::offset</strong></span>
    ( <span class="methodparam"><span class="type">integer</span> <code class="parameter">$position</code></span>
   )</div>

  <p class="para rdfs-comment">
   Skip (offset) these number of elements that otherwise would be returned
   by the find operation. Use with the limit() method.
  </p>
  <p class="para">
   Defining an offset larger than the result set size results in an empty set.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-mysql-xdevapi-collectionfind.offset-parameters">
  <h3 class="title">Parameters</h3>
  <dl>

   
    <dt>
<code class="parameter">position</code></dt>

    <dd>

     <p class="para">
      Number of elements to skip for the limit() operation.
     </p>
    </dd>

   
  </dl>

 </div>


 <div class="refsect1 returnvalues" id="refsect1-mysql-xdevapi-collectionfind.offset-returnvalues">
  <h3 class="title">Return Values</h3>
  <p class="para">
   A CollectionFind object that can be used for additional processing.
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-mysql-xdevapi-collectionfind.offset-examples">
  <h3 class="title">Examples</h3>
  <div class="example" id="example-2006">
   <p><strong>Example #1 <span class="function"><strong>mysql_xdevapi\CollectionFind::offset()</strong></span> example</strong></p>
   <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB">&lt;?php<br />$session&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">mysql_xdevapi</span><span style="color: #007700">\</span><span style="color: #0000BB">getSession</span><span style="color: #007700">(</span><span style="color: #DD0000">"mysqlx://user:password@localhost"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$session</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">sql</span><span style="color: #007700">(</span><span style="color: #DD0000">"DROP&nbsp;DATABASE&nbsp;IF&nbsp;EXISTS&nbsp;addressbook"</span><span style="color: #007700">)-&gt;</span><span style="color: #0000BB">execute</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">$session</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">sql</span><span style="color: #007700">(</span><span style="color: #DD0000">"CREATE&nbsp;DATABASE&nbsp;addressbook"</span><span style="color: #007700">)-&gt;</span><span style="color: #0000BB">execute</span><span style="color: #007700">();<br /><br /></span><span style="color: #0000BB">$schema&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">$session</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">getSchema</span><span style="color: #007700">(</span><span style="color: #DD0000">"addressbook"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$create&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">$schema</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">createCollection</span><span style="color: #007700">(</span><span style="color: #DD0000">"people"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$create<br />&nbsp;&nbsp;</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">add</span><span style="color: #007700">(</span><span style="color: #DD0000">'{"name":&nbsp;"Alfred",&nbsp;"age":&nbsp;18,&nbsp;"job":&nbsp;"Butler"}'</span><span style="color: #007700">)<br />&nbsp;&nbsp;-&gt;</span><span style="color: #0000BB">execute</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">$create<br />&nbsp;&nbsp;</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">add</span><span style="color: #007700">(</span><span style="color: #DD0000">'{"name":&nbsp;"Reginald",&nbsp;"age":&nbsp;42,&nbsp;"job":&nbsp;"Butler"}'</span><span style="color: #007700">)<br />&nbsp;&nbsp;-&gt;</span><span style="color: #0000BB">execute</span><span style="color: #007700">();<br /><br /></span><span style="color: #FF8000">//&nbsp;...<br /><br /></span><span style="color: #0000BB">$collection&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">$schema</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">getCollection</span><span style="color: #007700">(</span><span style="color: #DD0000">"people"</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$result&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">$collection<br />&nbsp;&nbsp;</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">find</span><span style="color: #007700">()<br />&nbsp;&nbsp;-&gt;</span><span style="color: #0000BB">sort</span><span style="color: #007700">(</span><span style="color: #DD0000">'age&nbsp;asc'</span><span style="color: #007700">)<br />&nbsp;&nbsp;-&gt;</span><span style="color: #0000BB">offset</span><span style="color: #007700">(</span><span style="color: #0000BB">1</span><span style="color: #007700">)<br />&nbsp;&nbsp;-&gt;</span><span style="color: #0000BB">limit</span><span style="color: #007700">(</span><span style="color: #0000BB">1</span><span style="color: #007700">)<br />&nbsp;&nbsp;-&gt;</span><span style="color: #0000BB">execute</span><span style="color: #007700">();<br /><br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$result</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">fetchAll</span><span style="color: #007700">());<br /></span><span style="color: #0000BB">?&gt;</span>
</span>
</code></div>
   </div>

   <div class="example-contents"><p>The above example will output
something similar to:</p></div>
   <div class="example-contents screen">
<div class="cdata"><pre>
array(1) {
  [0]=&gt;
  array(4) {
    [&quot;_id&quot;]=&gt;
    string(28) &quot;00005b6b536100000000000000f3&quot;
    [&quot;age&quot;]=&gt;
    int(42)
    [&quot;job&quot;]=&gt;
    string(6) &quot;Butler&quot;
    [&quot;name&quot;]=&gt;
    string(8) &quot;Reginald&quot;
  }
}
</pre></div>
   </div>
  </div>
 </div>


</div><hr /><div class="manualnavbar" style="text-align: center;">
 <div class="prev" style="text-align: left; float: left;"><a href="mysql-xdevapi-collectionfind.lockshared.html">CollectionFind::lockShared</a></div>
 <div class="next" style="text-align: right; float: right;"><a href="mysql-xdevapi-collectionfind.sort.html">CollectionFind::sort</a></div>
 <div class="up"><a href="class.mysql-xdevapi-collectionfind.html">mysql_xdevapi\CollectionFind</a></div>
 <div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>