<!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>Get collection table object</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="mysql-xdevapi-schema.getcollection.html">Schema::getCollection</a></div> <div class="next" style="text-align: right; float: right;"><a href="mysql-xdevapi-schema.getcollections.html">Schema::getCollections</a></div> <div class="up"><a href="class.mysql-xdevapi-schema.html">mysql_xdevapi\Schema</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="mysql-xdevapi-schema.getcollectionastable" class="refentry"> <div class="refnamediv"> <h1 class="refname">Schema::getCollectionAsTable</h1> <p class="verinfo">(No version information available, might only be in Git)</p><p class="refpurpose"><span class="refname">Schema::getCollectionAsTable</span> — <span class="dc-title">Get collection table object</span></p> </div> <div class="refsect1 description" id="refsect1-mysql-xdevapi-schema.getcollectionastable-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type"><span class="type mysql_xdevapi\Table">mysql_xdevapi\Table</span></span> <span class="methodname"><strong>mysql_xdevapi\Schema::getCollectionAsTable</strong></span> ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$name</code></span> )</div> <p class="para rdfs-comment"> Get a collection, but as a Table object instead of a Collection object. </p> </div> <div class="refsect1 parameters" id="refsect1-mysql-xdevapi-schema.getcollectionastable-parameters"> <h3 class="title">Parameters</h3> <dl> <dt> <code class="parameter">name</code></dt> <dd> <p class="para"> Name of the collection to instantiate a Table object from. </p> </dd> </dl> </div> <div class="refsect1 returnvalues" id="refsect1-mysql-xdevapi-schema.getcollectionastable-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> A table object for the collection. </p> </div> <div class="refsect1 examples" id="refsect1-mysql-xdevapi-schema.getcollectionastable-examples"> <h3 class="title">Examples</h3> <div class="example" id="example-2073"> <p><strong>Example #1 Schema::getCollectionAsTable example</strong></p> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br />$session </span><span style="color: #007700">= </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">-></span><span style="color: #0000BB">sql</span><span style="color: #007700">(</span><span style="color: #DD0000">"DROP DATABASE IF EXISTS addressbook"</span><span style="color: #007700">)-></span><span style="color: #0000BB">execute</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">$session</span><span style="color: #007700">-></span><span style="color: #0000BB">sql</span><span style="color: #007700">(</span><span style="color: #DD0000">"CREATE DATABASE addressbook"</span><span style="color: #007700">)-></span><span style="color: #0000BB">execute</span><span style="color: #007700">();<br /><br /></span><span style="color: #0000BB">$schema </span><span style="color: #007700">= </span><span style="color: #0000BB">$session</span><span style="color: #007700">-></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">$collect </span><span style="color: #007700">= </span><span style="color: #0000BB">$schema</span><span style="color: #007700">-></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">$collect</span><span style="color: #007700">-></span><span style="color: #0000BB">add</span><span style="color: #007700">(</span><span style="color: #DD0000">'{"name": "Fred", "age": 21, "job": "Construction"}'</span><span style="color: #007700">)-></span><span style="color: #0000BB">execute</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">$collect</span><span style="color: #007700">-></span><span style="color: #0000BB">add</span><span style="color: #007700">(</span><span style="color: #DD0000">'{"name": "Wilma", "age": 23, "job": "Teacher"}'</span><span style="color: #007700">)-></span><span style="color: #0000BB">execute</span><span style="color: #007700">();<br /><br /></span><span style="color: #0000BB">$table </span><span style="color: #007700">= </span><span style="color: #0000BB">$schema</span><span style="color: #007700">-></span><span style="color: #0000BB">getCollectionAsTable</span><span style="color: #007700">(</span><span style="color: #DD0000">"people"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$collection </span><span style="color: #007700">= </span><span style="color: #0000BB">$schema</span><span style="color: #007700">-></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">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$table</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$collection</span><span style="color: #007700">);</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> object(mysql_xdevapi\Table)#4 (1) { ["name"]=> string(6) "people" } object(mysql_xdevapi\Collection)#5 (1) { ["name"]=> string(6) "people" } </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-schema.getcollection.html">Schema::getCollection</a></div> <div class="next" style="text-align: right; float: right;"><a href="mysql-xdevapi-schema.getcollections.html">Schema::getCollections</a></div> <div class="up"><a href="class.mysql-xdevapi-schema.html">mysql_xdevapi\Schema</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>