Query/docs/classes/Query.Table_Builder.html
2014-04-02 17:09:34 -04:00

424 lines
22 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html><html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
<meta charset="utf-8">
<title>Query » \Query\Table_Builder</title>
<meta name="author" content="Mike van Riel">
<meta name="description" content="">
<link href="../css/template.css" rel="stylesheet" media="all">
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
</head>
<body>
<div class="navbar navbar-fixed-top">
<div class="navbar-inner"><div class="container">
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">Query</a><div class="nav-collapse"><ul class="nav">
<li class="dropdown">
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
<li><a>Namespaces</a></li>
<li><a href="../namespaces/Query.html"><i class="icon-th"></i> Query</a></li>
<li><a href="../namespaces/global.html"><i class="icon-th"></i> global</a></li>
<li><a>Packages</a></li>
<li><a href="../packages/Query.html"><i class="icon-folder-open"></i> Query</a></li>
</ul>
</li>
<li class="dropdown" id="charts-menu">
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
</li>
<li class="dropdown" id="reports-menu">
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
<span class="label label-info">0</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
<ul></ul></a></li>
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
<span class="label label-info">0</span></a></li>
</ul>
</li>
</ul></div>
</div></div>
<div class="go_to_top"><a href="#___" style="color: inherit">Back to top  <i class="icon-upload icon-white"></i></a></div>
</div>
<div id="___" class="container">
<noscript><div class="alert alert-warning">
Javascript is disabled; several features are only available
if Javascript is enabled.
</div></noscript>
<div class="row">
<div class="span4">
<div class="btn-toolbar">
<div class="btn-group visibility" data-toggle="buttons-checkbox">
<button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button>
</div>
<div class="btn-group view pull-right" data-toggle="buttons-radio">
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
</div>
</div>
<ul class="side-nav nav nav-list">
<li class="nav-header">
<i title="Methods" class="icon-custom icon-method"></i> Methods
<ul>
<li class="method public "><a href="#method___construct" title="__construct() :: Constructor"><span class="description">Constructor</span><pre>__construct()</pre></a></li>
<li class="method public "><a href="#method_add_column" title="add_column() :: "><span class="description">add_column()
</span><pre>add_column()</pre></a></li>
<li class="method public "><a href="#method_add_foreign_key" title="add_foreign_key() :: "><span class="description">add_foreign_key()
</span><pre>add_foreign_key()</pre></a></li>
<li class="method public "><a href="#method_add_index" title="add_index() :: "><span class="description">add_index()
</span><pre>add_index()</pre></a></li>
<li class="method public "><a href="#method_change_column" title="change_column() :: "><span class="description">change_column()
</span><pre>change_column()</pre></a></li>
<li class="method public "><a href="#method_create" title="create() :: "><span class="description">create()
</span><pre>create()</pre></a></li>
<li class="method public "><a href="#method_drop" title="drop() :: "><span class="description">drop()
</span><pre>drop()</pre></a></li>
<li class="method public "><a href="#method_drop_foreign_key" title="drop_foreign_key() :: "><span class="description">drop_foreign_key()
</span><pre>drop_foreign_key()</pre></a></li>
<li class="method public "><a href="#method_exists" title="exists() :: "><span class="description">exists()
</span><pre>exists()</pre></a></li>
<li class="method public "><a href="#method_get_columns" title="get_columns() :: "><span class="description">get_columns()
</span><pre>get_columns()</pre></a></li>
<li class="method public "><a href="#method_has_column" title="has_column() :: "><span class="description">has_column()
</span><pre>has_column()</pre></a></li>
<li class="method public "><a href="#method_has_foreign_key" title="has_foreign_key() :: "><span class="description">has_foreign_key()
</span><pre>has_foreign_key()</pre></a></li>
<li class="method public "><a href="#method_has_index" title="has_index() :: "><span class="description">has_index()
</span><pre>has_index()</pre></a></li>
<li class="method public "><a href="#method_remove_column" title="remove_column() :: "><span class="description">remove_column()
</span><pre>remove_column()</pre></a></li>
<li class="method public "><a href="#method_remove_index" title="remove_index() :: "><span class="description">remove_index()
</span><pre>remove_index()</pre></a></li>
<li class="method public "><a href="#method_remove_index_by_name" title="remove_index_by_name() :: "><span class="description">remove_index_by_name()
</span><pre>remove_index_by_name()</pre></a></li>
<li class="method public "><a href="#method_rename" title="rename() :: "><span class="description">rename()
</span><pre>rename()</pre></a></li>
<li class="method public "><a href="#method_rename_column" title="rename_column() :: "><span class="description">rename_column()
</span><pre>rename_column()</pre></a></li>
<li class="method public "><a href="#method_reset" title="reset() :: "><span class="description">reset()
</span><pre>reset()</pre></a></li>
<li class="method public "><a href="#method_save" title="save() :: "><span class="description">save()
</span><pre>save()</pre></a></li>
<li class="method public "><a href="#method_update" title="update() :: "><span class="description">update()
</span><pre>update()</pre></a></li>
</ul>
</li>
<li class="nav-header">
<i title="Properties" class="icon-custom icon-property"></i> Properties
<ul></ul>
</li>
<li class="nav-header protected">» Protected
<ul><li class="property protected "><a href="#property_name" title="$name() :: The name of the current table"><span class="description"></span><pre>$name</pre></a></li></ul>
</li>
<li class="nav-header private">» Private
<ul>
<li class="property private "><a href="#property_driver" title="$driver() :: Driver for the current db"><span class="description"></span><pre>$driver</pre></a></li>
<li class="property private "><a href="#property_table_options" title="$table_options() :: Options for the current table"><span class="description"></span><pre>$table_options</pre></a></li>
</ul>
</li>
</ul>
</div>
<div class="span8">
<a id="\Query\Table_Builder"></a><ul class="breadcrumb">
<li>
<a href="../index.html"><i title="Classes" class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li>
<li><a href="../namespaces/Query.html">Query</a></li>
<li class="active">
<span class="divider">\</span><a href="../classes/Query.Table_Builder.html">Table_Builder</a>
</li>
</ul>
<div class="element class">
<p class="short_description">Abstract class defining database / table creation methods</p>
<div class="details">
<div class="long_description"></div>
<table class="table table-bordered">
<tr>
<th>package</th>
<td><a href="../packages/Query.Table_Builder.html">Query</a></td>
</tr>
<tr>
<th>subpackage</th>
<td>Table_Builder</td>
</tr>
</table>
<h3>
<i title="Methods" class="icon-custom icon-method"></i> Methods</h3>
<a id="method___construct"></a><div class="element clickable method public method___construct" data-toggle="collapse" data-target=".method___construct .collapse" title="public">
<h2>Constructor</h2>
<pre>__construct(string $name, array $options<code> = array()</code>, \Query\Driver_Interface $driver<code> = NULL</code>) : <a href="../classes/Query.Table_Builder.html">\Query\Table_Builder</a></pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$name</h4>
<code>string</code>
</div>
<div class="subelement argument">
<h4>$options</h4>
<code>array</code>
</div>
<div class="subelement argument">
<h4>$driver</h4>
<code><a href="Driver_Interface.html">\Query\Driver_Interface</a></code>
</div>
<h3>Returns</h3>
<div class="subelement response"><code><a href="../classes/Query.Table_Builder.html">\Query\Table_Builder</a></code></div>
</div></div>
</div>
<a id="method_add_column"></a><div class="element clickable method public method_add_column" data-toggle="collapse" data-target=".method_add_column .collapse" title="public">
<h2>add_column()
</h2>
<pre>add_column($column_name, $type<code> = NULL</code>, $options<code> = array()</code>) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument"><h4>$column_name</h4></div>
<div class="subelement argument"><h4>$type</h4></div>
<div class="subelement argument"><h4>$options</h4></div>
</div></div>
</div>
<a id="method_add_foreign_key"></a><div class="element clickable method public method_add_foreign_key" data-toggle="collapse" data-target=".method_add_foreign_key .collapse" title="public">
<h2>add_foreign_key()
</h2>
<pre>add_foreign_key($columns, $referenced_table, $referenced_columns<code> = array('id')</code>, $options<code> = array()</code>) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument"><h4>$columns</h4></div>
<div class="subelement argument"><h4>$referenced_table</h4></div>
<div class="subelement argument"><h4>$referenced_columns</h4></div>
<div class="subelement argument"><h4>$options</h4></div>
</div></div>
</div>
<a id="method_add_index"></a><div class="element clickable method public method_add_index" data-toggle="collapse" data-target=".method_add_index .collapse" title="public">
<h2>add_index()
</h2>
<pre>add_index($columns, $options<code> = array()</code>) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument"><h4>$columns</h4></div>
<div class="subelement argument"><h4>$options</h4></div>
</div></div>
</div>
<a id="method_change_column"></a><div class="element clickable method public method_change_column" data-toggle="collapse" data-target=".method_change_column .collapse" title="public">
<h2>change_column()
</h2>
<pre>change_column($column_name, $new_column_type, $options<code> = array()</code>) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument"><h4>$column_name</h4></div>
<div class="subelement argument"><h4>$new_column_type</h4></div>
<div class="subelement argument"><h4>$options</h4></div>
</div></div>
</div>
<a id="method_create"></a><div class="element clickable method public method_create" data-toggle="collapse" data-target=".method_create .collapse" title="public">
<h2>create()
</h2>
<pre>create() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="method_drop"></a><div class="element clickable method public method_drop" data-toggle="collapse" data-target=".method_drop .collapse" title="public">
<h2>drop()
</h2>
<pre>drop() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="method_drop_foreign_key"></a><div class="element clickable method public method_drop_foreign_key" data-toggle="collapse" data-target=".method_drop_foreign_key .collapse" title="public">
<h2>drop_foreign_key()
</h2>
<pre>drop_foreign_key($columns, $constraint<code> = NULL</code>) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument"><h4>$columns</h4></div>
<div class="subelement argument"><h4>$constraint</h4></div>
</div></div>
</div>
<a id="method_exists"></a><div class="element clickable method public method_exists" data-toggle="collapse" data-target=".method_exists .collapse" title="public">
<h2>exists()
</h2>
<pre>exists() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="method_get_columns"></a><div class="element clickable method public method_get_columns" data-toggle="collapse" data-target=".method_get_columns .collapse" title="public">
<h2>get_columns()
</h2>
<pre>get_columns() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="method_has_column"></a><div class="element clickable method public method_has_column" data-toggle="collapse" data-target=".method_has_column .collapse" title="public">
<h2>has_column()
</h2>
<pre>has_column($column_name, $options<code> = array()</code>) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument"><h4>$column_name</h4></div>
<div class="subelement argument"><h4>$options</h4></div>
</div></div>
</div>
<a id="method_has_foreign_key"></a><div class="element clickable method public method_has_foreign_key" data-toggle="collapse" data-target=".method_has_foreign_key .collapse" title="public">
<h2>has_foreign_key()
</h2>
<pre>has_foreign_key($columns, $constraint<code> = NULL</code>) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument"><h4>$columns</h4></div>
<div class="subelement argument"><h4>$constraint</h4></div>
</div></div>
</div>
<a id="method_has_index"></a><div class="element clickable method public method_has_index" data-toggle="collapse" data-target=".method_has_index .collapse" title="public">
<h2>has_index()
</h2>
<pre>has_index($columns, $options<code> = array()</code>) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument"><h4>$columns</h4></div>
<div class="subelement argument"><h4>$options</h4></div>
</div></div>
</div>
<a id="method_remove_column"></a><div class="element clickable method public method_remove_column" data-toggle="collapse" data-target=".method_remove_column .collapse" title="public">
<h2>remove_column()
</h2>
<pre>remove_column($column_name) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument"><h4>$column_name</h4></div>
</div></div>
</div>
<a id="method_remove_index"></a><div class="element clickable method public method_remove_index" data-toggle="collapse" data-target=".method_remove_index .collapse" title="public">
<h2>remove_index()
</h2>
<pre>remove_index($columns, $options<code> = array()</code>) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument"><h4>$columns</h4></div>
<div class="subelement argument"><h4>$options</h4></div>
</div></div>
</div>
<a id="method_remove_index_by_name"></a><div class="element clickable method public method_remove_index_by_name" data-toggle="collapse" data-target=".method_remove_index_by_name .collapse" title="public">
<h2>remove_index_by_name()
</h2>
<pre>remove_index_by_name($name) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument"><h4>$name</h4></div>
</div></div>
</div>
<a id="method_rename"></a><div class="element clickable method public method_rename" data-toggle="collapse" data-target=".method_rename .collapse" title="public">
<h2>rename()
</h2>
<pre>rename($new_table_name) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument"><h4>$new_table_name</h4></div>
</div></div>
</div>
<a id="method_rename_column"></a><div class="element clickable method public method_rename_column" data-toggle="collapse" data-target=".method_rename_column .collapse" title="public">
<h2>rename_column()
</h2>
<pre>rename_column($old_name, $new_name) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument"><h4>$old_name</h4></div>
<div class="subelement argument"><h4>$new_name</h4></div>
</div></div>
</div>
<a id="method_reset"></a><div class="element clickable method public method_reset" data-toggle="collapse" data-target=".method_reset .collapse" title="public">
<h2>reset()
</h2>
<pre>reset() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="method_save"></a><div class="element clickable method public method_save" data-toggle="collapse" data-target=".method_save .collapse" title="public">
<h2>save()
</h2>
<pre>save() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="method_update"></a><div class="element clickable method public method_update" data-toggle="collapse" data-target=".method_update .collapse" title="public">
<h2>update()
</h2>
<pre>update() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<h3>
<i title="Properties" class="icon-custom icon-property"></i> Properties</h3>
<a id="property_name"> </a><div class="element clickable property protected property_name" data-toggle="collapse" data-target=".property_name .collapse" title="protected">
<h2>The name of the current table</h2>
<pre>$name : string</pre>
<div class="row collapse"><div class="detail-description">
<h3>Default</h3>
<div class="subelement argument"><code>''</code></div>
</div></div>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="property_driver"> </a><div class="element clickable property private property_driver" data-toggle="collapse" data-target=".property_driver .collapse" title="private">
<h2>Driver for the current db</h2>
<pre>$driver : <a href="Driver_Interface.html">\Query\Driver_Interface</a></pre>
<div class="row collapse"><div class="detail-description">
<h3>Default</h3>
<div class="subelement argument"><code>NULL</code></div>
</div></div>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="property_table_options"> </a><div class="element clickable property private property_table_options" data-toggle="collapse" data-target=".property_table_options .collapse" title="private">
<h2>Options for the current table</h2>
<pre>$table_options : array</pre>
<div class="row collapse"><div class="detail-description">
<h3>Default</h3>
<div class="subelement argument"><code>array()</code></div>
</div></div>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
</div>
</div>
</div>
</div>
<div class="row"><footer class="span12">
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.2.0
</a> and<br>
generated on 2014-04-02T17:09:12-04:00.<br></footer></div>
</div>
</body>
</html>