2014-04-15 16:13:18 -04:00
|
|
|
|
<!DOCTYPE html>
|
|
|
|
|
|
<html lang="en">
|
2014-04-02 17:08:50 -04:00
|
|
|
|
<head>
|
2014-04-15 16:13:18 -04:00
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=0"/>
|
|
|
|
|
|
<meta charset="utf-8"/>
|
|
|
|
|
|
<title>Query</title>
|
|
|
|
|
|
<meta name="author" content=""/>
|
|
|
|
|
|
<meta name="description" content=""/>
|
|
|
|
|
|
|
|
|
|
|
|
<link href="https://netdna.bootstrapcdn.com/twitter-bootstrap/2.3.2/css/bootstrap-combined.no-icons.min.css" rel="stylesheet">
|
|
|
|
|
|
<link href="https://netdna.bootstrapcdn.com/font-awesome/3.2.1/css/font-awesome.min.css" rel="stylesheet">
|
|
|
|
|
|
<link href="../css/prism.css" rel="stylesheet" media="all"/>
|
|
|
|
|
|
<link href="../css/template.css" rel="stylesheet" media="all"/>
|
|
|
|
|
|
|
|
|
|
|
|
<!--[if lt IE 9]>
|
|
|
|
|
|
<script src="https://html5shim.googlecode.com/svn/trunk/html5.js" type="text/javascript"></script>
|
|
|
|
|
|
<![endif]-->
|
|
|
|
|
|
<script src="https://code.jquery.com/jquery-1.10.2.min.js" type="text/javascript"></script>
|
|
|
|
|
|
<script src="https://code.jquery.com/ui/1.10.3/jquery-ui.min.js" type="text/javascript"></script>
|
|
|
|
|
|
<script src="https://netdna.bootstrapcdn.com/twitter-bootstrap/2.3.2/js/bootstrap.min.js"></script>
|
|
|
|
|
|
<script src="../js/jquery.smooth-scroll.js"></script>
|
|
|
|
|
|
<script src="../js/prism.min.js"></script>
|
|
|
|
|
|
<!-- TODO: Add http://jscrollpane.kelvinluck.com/ to style the scrollbars for browsers not using webkit-->
|
|
|
|
|
|
<script type="text/javascript">
|
|
|
|
|
|
function loadExternalCodeSnippets() {
|
|
|
|
|
|
Array.prototype.slice.call(document.querySelectorAll('pre[data-src]')).forEach(function (pre) {
|
|
|
|
|
|
var src = pre.getAttribute('data-src');
|
|
|
|
|
|
var extension = (src.match(/\.(\w+)$/) || [, ''])[1];
|
|
|
|
|
|
var language = 'php';
|
|
|
|
|
|
|
|
|
|
|
|
var code = document.createElement('code');
|
|
|
|
|
|
code.className = 'language-' + language;
|
|
|
|
|
|
|
|
|
|
|
|
pre.textContent = '';
|
|
|
|
|
|
|
|
|
|
|
|
code.textContent = 'Loading…';
|
|
|
|
|
|
|
|
|
|
|
|
pre.appendChild(code);
|
|
|
|
|
|
|
|
|
|
|
|
var xhr = new XMLHttpRequest();
|
|
|
|
|
|
|
|
|
|
|
|
xhr.open('GET', src, true);
|
|
|
|
|
|
|
|
|
|
|
|
xhr.onreadystatechange = function () {
|
|
|
|
|
|
if (xhr.readyState == 4) {
|
|
|
|
|
|
|
|
|
|
|
|
if (xhr.status < 400 && xhr.responseText) {
|
|
|
|
|
|
code.textContent = xhr.responseText;
|
|
|
|
|
|
|
|
|
|
|
|
Prism.highlightElement(code);
|
|
|
|
|
|
}
|
|
|
|
|
|
else if (xhr.status >= 400) {
|
|
|
|
|
|
code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
|
|
|
|
|
|
}
|
|
|
|
|
|
else {
|
|
|
|
|
|
code.textContent = '✖ Error: File does not exist or is empty';
|
|
|
|
|
|
}
|
|
|
|
|
|
}
|
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
|
xhr.send(null);
|
|
|
|
|
|
});
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
$(document).ready(function(){
|
|
|
|
|
|
loadExternalCodeSnippets();
|
|
|
|
|
|
});
|
|
|
|
|
|
$('#source-view').on('shown', function () {
|
|
|
|
|
|
loadExternalCodeSnippets();
|
|
|
|
|
|
})
|
|
|
|
|
|
</script>
|
|
|
|
|
|
|
|
|
|
|
|
<link rel="shortcut icon" href="../images/favicon.ico"/>
|
|
|
|
|
|
<link rel="apple-touch-icon" href="../images/apple-touch-icon.png"/>
|
|
|
|
|
|
<link rel="apple-touch-icon" sizes="72x72" href="../images/apple-touch-icon-72x72.png"/>
|
|
|
|
|
|
<link rel="apple-touch-icon" sizes="114x114" href="../images/apple-touch-icon-114x114.png"/>
|
2014-04-02 17:08:50 -04:00
|
|
|
|
</head>
|
|
|
|
|
|
<body>
|
2014-04-15 16:13:18 -04:00
|
|
|
|
|
2014-04-02 17:08:50 -04:00
|
|
|
|
<div class="navbar navbar-fixed-top">
|
2014-04-15 16:13:18 -04:00
|
|
|
|
<div class="navbar-inner">
|
|
|
|
|
|
<div class="container">
|
|
|
|
|
|
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
|
|
|
|
|
|
<i class="icon-ellipsis-vertical"></i>
|
|
|
|
|
|
</a>
|
|
|
|
|
|
<a class="brand" href="../index.html">Query</a>
|
|
|
|
|
|
|
|
|
|
|
|
<div class="nav-collapse">
|
|
|
|
|
|
<ul class="nav pull-right">
|
|
|
|
|
|
<li class="dropdown">
|
|
|
|
|
|
<a href="../index.html" class="dropdown-toggle" data-toggle="dropdown">
|
|
|
|
|
|
API Documentation <b class="caret"></b>
|
|
|
|
|
|
</a>
|
|
|
|
|
|
<ul class="dropdown-menu">
|
|
|
|
|
|
<li><a href="../namespaces/Query.html">\Query</a></li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
<li class="dropdown" id="charts-menu">
|
|
|
|
|
|
<a href="#" class="dropdown-toggle" data-toggle="dropdown">
|
|
|
|
|
|
Charts <b class="caret"></b>
|
|
|
|
|
|
</a>
|
|
|
|
|
|
<ul class="dropdown-menu">
|
|
|
|
|
|
<li>
|
|
|
|
|
|
<a href="../graphs/class.html">
|
|
|
|
|
|
<i class="icon-list-alt"></i> Class hierarchy diagram
|
|
|
|
|
|
</a>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
<li class="dropdown" id="reports-menu">
|
|
|
|
|
|
<a href="#" class="dropdown-toggle" data-toggle="dropdown">
|
|
|
|
|
|
Reports <b class="caret"></b>
|
|
|
|
|
|
</a>
|
|
|
|
|
|
<ul class="dropdown-menu">
|
|
|
|
|
|
<li>
|
|
|
|
|
|
<a href="../reports/errors.html">
|
|
|
|
|
|
<i class="icon-list-alt"></i> Errors <span class="label label-info pull-right">0</span>
|
|
|
|
|
|
</a>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
<li>
|
|
|
|
|
|
<a href="../reports/markers.html">
|
|
|
|
|
|
<i class="icon-list-alt"></i> Markers <span class="label label-info pull-right">1</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>-->
|
2014-04-02 17:08:50 -04:00
|
|
|
|
</div>
|
2014-04-15 16:13:18 -04:00
|
|
|
|
|
|
|
|
|
|
<div id="___" class="container-fluid">
|
|
|
|
|
|
<section class="row-fluid">
|
|
|
|
|
|
<div class="span2 sidebar">
|
|
|
|
|
|
<div class="accordion" style="margin-bottom: 0">
|
|
|
|
|
|
<div class="accordion-group">
|
|
|
|
|
|
<div class="accordion-heading">
|
2014-04-24 16:25:33 -04:00
|
|
|
|
<a class="accordion-toggle " data-toggle="collapse" data-target="#namespace-1978328210"></a>
|
2014-04-15 16:13:18 -04:00
|
|
|
|
<a href="../namespaces/default.html" style="margin-left: 30px; padding-left: 0">\</a>
|
|
|
|
|
|
</div>
|
2014-04-24 16:25:33 -04:00
|
|
|
|
<div id="namespace-1978328210" class="accordion-body collapse in">
|
2014-04-15 16:13:18 -04:00
|
|
|
|
<div class="accordion-inner">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="accordion" style="margin-bottom: 0">
|
|
|
|
|
|
<div class="accordion-group">
|
|
|
|
|
|
<div class="accordion-heading">
|
2014-04-24 16:25:33 -04:00
|
|
|
|
<a class="accordion-toggle collapsed" data-toggle="collapse" data-target="#namespace-1409805457"></a>
|
2014-04-15 16:13:18 -04:00
|
|
|
|
<a href="../namespaces/Query.html" style="margin-left: 30px; padding-left: 0">Query</a>
|
|
|
|
|
|
</div>
|
2014-04-24 16:25:33 -04:00
|
|
|
|
<div id="namespace-1409805457" class="accordion-body collapse ">
|
2014-04-15 16:13:18 -04:00
|
|
|
|
<div class="accordion-inner">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="accordion" style="margin-bottom: 0">
|
|
|
|
|
|
<div class="accordion-group">
|
|
|
|
|
|
<div class="accordion-heading">
|
2014-04-24 16:25:33 -04:00
|
|
|
|
<a class="accordion-toggle collapsed" data-toggle="collapse" data-target="#namespace-1699773343"></a>
|
2014-04-15 16:13:18 -04:00
|
|
|
|
<a href="../namespaces/Query.Table.html" style="margin-left: 30px; padding-left: 0">Table</a>
|
|
|
|
|
|
</div>
|
2014-04-24 16:25:33 -04:00
|
|
|
|
<div id="namespace-1699773343" class="accordion-body collapse ">
|
2014-04-15 16:13:18 -04:00
|
|
|
|
<div class="accordion-inner">
|
|
|
|
|
|
|
|
|
|
|
|
|
2014-04-02 17:08:50 -04:00
|
|
|
|
<ul>
|
2014-04-15 16:13:18 -04:00
|
|
|
|
<li class="class"><a href="../classes/Query.Table.Abstract_Table.html">Abstract_Table</a></li>
|
|
|
|
|
|
<li class="class"><a href="../classes/Query.Table.Table_Builder.html">Table_Builder</a></li>
|
|
|
|
|
|
<li class="class"><a href="../classes/Query.Table.Table_Foreign_Key.html">Table_Foreign_Key</a></li>
|
|
|
|
|
|
<li class="class"><a href="../classes/Query.Table.Table_Column.html">Table_Column</a></li>
|
|
|
|
|
|
<li class="class"><a href="../classes/Query.Table.Table_Index.html">Table_Index</a></li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<div class="accordion" style="margin-bottom: 0">
|
|
|
|
|
|
<div class="accordion-group">
|
|
|
|
|
|
<div class="accordion-heading">
|
2014-04-24 16:25:33 -04:00
|
|
|
|
<a class="accordion-toggle collapsed" data-toggle="collapse" data-target="#namespace-1124011176"></a>
|
2014-04-15 16:13:18 -04:00
|
|
|
|
<a href="../namespaces/Query.Driver.html" style="margin-left: 30px; padding-left: 0">Driver</a>
|
|
|
|
|
|
</div>
|
2014-04-24 16:25:33 -04:00
|
|
|
|
<div id="namespace-1124011176" class="accordion-body collapse ">
|
2014-04-15 16:13:18 -04:00
|
|
|
|
<div class="accordion-inner">
|
|
|
|
|
|
|
2014-04-24 15:32:28 -04:00
|
|
|
|
<div class="accordion" style="margin-bottom: 0">
|
|
|
|
|
|
<div class="accordion-group">
|
|
|
|
|
|
<div class="accordion-heading">
|
2014-04-24 16:25:33 -04:00
|
|
|
|
<a class="accordion-toggle collapsed" data-toggle="collapse" data-target="#namespace-772499390"></a>
|
2014-04-24 15:32:28 -04:00
|
|
|
|
<a href="../namespaces/Query.Driver.SQL.html" style="margin-left: 30px; padding-left: 0">SQL</a>
|
|
|
|
|
|
</div>
|
2014-04-24 16:25:33 -04:00
|
|
|
|
<div id="namespace-772499390" class="accordion-body collapse ">
|
2014-04-24 15:32:28 -04:00
|
|
|
|
<div class="accordion-inner">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<ul>
|
|
|
|
|
|
<li class="interface"><a href="../classes/Query.Driver.SQL.SQL_Interface.html">SQL_Interface</a></li>
|
|
|
|
|
|
<li class="class"><a href="../classes/Query.Driver.SQL.Abstract_SQL.html">Abstract_SQL</a></li>
|
|
|
|
|
|
<li class="class"><a href="../classes/Query.Driver.SQL.PgSQL_SQL.html">PgSQL_SQL</a></li>
|
|
|
|
|
|
<li class="class"><a href="../classes/Query.Driver.SQL.MySQL_SQL.html">MySQL_SQL</a></li>
|
|
|
|
|
|
<li class="class"><a href="../classes/Query.Driver.SQL.Firebird_SQL.html">Firebird_SQL</a></li>
|
|
|
|
|
|
<li class="class"><a href="../classes/Query.Driver.SQL.SQLite_SQL.html">SQLite_SQL</a></li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<div class="accordion" style="margin-bottom: 0">
|
|
|
|
|
|
<div class="accordion-group">
|
|
|
|
|
|
<div class="accordion-heading">
|
2014-04-24 16:25:33 -04:00
|
|
|
|
<a class="accordion-toggle collapsed" data-toggle="collapse" data-target="#namespace-943417262"></a>
|
2014-04-24 15:32:28 -04:00
|
|
|
|
<a href="../namespaces/Query.Driver.Util.html" style="margin-left: 30px; padding-left: 0">Util</a>
|
|
|
|
|
|
</div>
|
2014-04-24 16:25:33 -04:00
|
|
|
|
<div id="namespace-943417262" class="accordion-body collapse ">
|
2014-04-24 15:32:28 -04:00
|
|
|
|
<div class="accordion-inner">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<ul>
|
|
|
|
|
|
<li class="class"><a href="../classes/Query.Driver.Util.Firebird_Util.html">Firebird_Util</a></li>
|
|
|
|
|
|
<li class="class"><a href="../classes/Query.Driver.Util.MySQL_Util.html">MySQL_Util</a></li>
|
|
|
|
|
|
<li class="class"><a href="../classes/Query.Driver.Util.Abstract_Util.html">Abstract_Util</a></li>
|
|
|
|
|
|
<li class="class"><a href="../classes/Query.Driver.Util.SQLite_Util.html">SQLite_Util</a></li>
|
|
|
|
|
|
<li class="class"><a href="../classes/Query.Driver.Util.PgSQL_Util.html">PgSQL_Util</a></li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
2014-04-15 16:13:18 -04:00
|
|
|
|
|
2014-04-02 17:08:50 -04:00
|
|
|
|
<ul>
|
2014-04-15 16:13:18 -04:00
|
|
|
|
<li class="interface"><a href="../classes/Query.Driver.Driver_Interface.html">Driver_Interface</a></li>
|
2014-04-24 15:32:28 -04:00
|
|
|
|
<li class="class"><a href="../classes/Query.Driver.Firebird_Result.html">Firebird_Result</a></li>
|
2014-04-15 16:13:18 -04:00
|
|
|
|
<li class="class"><a href="../classes/Query.Driver.Firebird.html">Firebird</a></li>
|
|
|
|
|
|
<li class="class"><a href="../classes/Query.Driver.Abstract_Driver.html">Abstract_Driver</a></li>
|
|
|
|
|
|
<li class="class"><a href="../classes/Query.Driver.SQLite.html">SQLite</a></li>
|
|
|
|
|
|
<li class="class"><a href="../classes/Query.Driver.PgSQL.html">PgSQL</a></li>
|
|
|
|
|
|
<li class="class"><a href="../classes/Query.Driver.MySQL.html">MySQL</a></li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<ul>
|
|
|
|
|
|
<li class="interface"><a href="../classes/Query.Query_Builder_Interface.html">Query_Builder_Interface</a></li>
|
|
|
|
|
|
<li class="class"><a href="../classes/Query.Query_Parser.html">Query_Parser</a></li>
|
|
|
|
|
|
<li class="class"><a href="../classes/Query.Query_Builder.html">Query_Builder</a></li>
|
|
|
|
|
|
<li class="class"><a href="../classes/Query.BadDBDriverException.html">BadDBDriverException</a></li>
|
|
|
|
|
|
<li class="class"><a href="../classes/Query.Connection_Manager.html">Connection_Manager</a></li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<ul>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<section class="row-fluid">
|
|
|
|
|
|
<div class="span10 offset2">
|
|
|
|
|
|
<div class="row-fluid">
|
|
|
|
|
|
<div class="span8 content class">
|
|
|
|
|
|
<nav>
|
|
|
|
|
|
<a href="../namespaces/Query.Table.html">\Query\Table</a> <i class="icon-level-up"></i>
|
|
|
|
|
|
</nav>
|
|
|
|
|
|
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal"><i class="icon-code"></i></a>
|
|
|
|
|
|
|
|
|
|
|
|
<h1><small>\Query\Table</small>Table_Builder</h1>
|
|
|
|
|
|
<p><em>Abstract class defining database / table creation methods</em></p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section id="summary">
|
|
|
|
|
|
<h2>Summary</h2>
|
|
|
|
|
|
<section class="row-fluid heading">
|
|
|
|
|
|
<section class="span4">
|
|
|
|
|
|
<a href="#methods">Methods</a>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<section class="span4">
|
|
|
|
|
|
<a href="#properties">Properties</a>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<section class="span4">
|
|
|
|
|
|
<a href="#constants">Constants</a>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<section class="row-fluid public">
|
|
|
|
|
|
<section class="span4">
|
|
|
|
|
|
<a href="../classes/Query.Table.Table_Builder.html#method___construct" class="">__construct()</a><br />
|
|
|
|
|
|
<a href="../classes/Query.Table.Table_Builder.html#method___invoke" class="">__invoke()</a><br />
|
|
|
|
|
|
<a href="../classes/Query.Table.Table_Builder.html#method_set_driver" class="">set_driver()</a><br />
|
|
|
|
|
|
<a href="../classes/Query.Table.Table_Builder.html#method_get_driver" class="">get_driver()</a><br />
|
|
|
|
|
|
<a href="../classes/Query.Table.Table_Builder.html#method_add_column" class="">add_column()</a><br />
|
|
|
|
|
|
<a href="../classes/Query.Table.Table_Builder.html#method_remove_column" class="">remove_column()</a><br />
|
|
|
|
|
|
<a href="../classes/Query.Table.Table_Builder.html#method_rename_column" class="">rename_column()</a><br />
|
|
|
|
|
|
<a href="../classes/Query.Table.Table_Builder.html#method_change_column" class="">change_column()</a><br />
|
|
|
|
|
|
<a href="../classes/Query.Table.Table_Builder.html#method_has_column" class="">has_column()</a><br />
|
|
|
|
|
|
<a href="../classes/Query.Table.Table_Builder.html#method_add_index" class="">add_index()</a><br />
|
|
|
|
|
|
<a href="../classes/Query.Table.Table_Builder.html#method_remove_index" class="">remove_index()</a><br />
|
|
|
|
|
|
<a href="../classes/Query.Table.Table_Builder.html#method_remove_index_by_name" class="">remove_index_by_name()</a><br />
|
|
|
|
|
|
<a href="../classes/Query.Table.Table_Builder.html#method_has_index" class="">has_index()</a><br />
|
|
|
|
|
|
<a href="../classes/Query.Table.Table_Builder.html#method_add_foreign_key" class="">add_foreign_key()</a><br />
|
|
|
|
|
|
<a href="../classes/Query.Table.Table_Builder.html#method_drop_foreign_key" class="">drop_foreign_key()</a><br />
|
|
|
|
|
|
<a href="../classes/Query.Table.Table_Builder.html#method_has_foreign_key" class="">has_foreign_key()</a><br />
|
|
|
|
|
|
<a href="../classes/Query.Table.Table_Builder.html#method_exists" class="">exists()</a><br />
|
|
|
|
|
|
<a href="../classes/Query.Table.Table_Builder.html#method_drop" class="">drop()</a><br />
|
|
|
|
|
|
<a href="../classes/Query.Table.Table_Builder.html#method_rename" class="">rename()</a><br />
|
|
|
|
|
|
<a href="../classes/Query.Table.Table_Builder.html#method_get_columns" class="">get_columns()</a><br />
|
|
|
|
|
|
<a href="../classes/Query.Table.Table_Builder.html#method_create" class="">create()</a><br />
|
|
|
|
|
|
<a href="../classes/Query.Table.Table_Builder.html#method_update" class="">update()</a><br />
|
|
|
|
|
|
<a href="../classes/Query.Table.Table_Builder.html#method_save" class="">save()</a><br />
|
|
|
|
|
|
<a href="../classes/Query.Table.Table_Builder.html#method_reset" class="">reset()</a><br />
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<section class="span4">
|
|
|
|
|
|
<em>No public properties found</em>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<section class="span4">
|
|
|
|
|
|
<em>No constants found</em>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<section class="row-fluid protected">
|
|
|
|
|
|
<section class="span4">
|
|
|
|
|
|
<em>No protected methods found</em>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<section class="span4">
|
|
|
|
|
|
<a href="../classes/Query.Table.Table_Builder.html#property_name" class="">$name</a><br />
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<section class="span4">
|
|
|
|
|
|
<em>N/A</em>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<section class="row-fluid private">
|
|
|
|
|
|
<section class="span4">
|
|
|
|
|
|
<em>No private methods found</em>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<section class="span4">
|
|
|
|
|
|
<a href="../classes/Query.Table.Table_Builder.html#property_driver" class="">$driver</a><br />
|
|
|
|
|
|
<a href="../classes/Query.Table.Table_Builder.html#property_table_options" class="">$table_options</a><br />
|
|
|
|
|
|
<a href="../classes/Query.Table.Table_Builder.html#property_columns" class="">$columns</a><br />
|
|
|
|
|
|
<a href="../classes/Query.Table.Table_Builder.html#property_indexes" class="">$indexes</a><br />
|
|
|
|
|
|
<a href="../classes/Query.Table.Table_Builder.html#property_foreign_keys" class="">$foreign_keys</a><br />
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<section class="span4">
|
|
|
|
|
|
<em>N/A</em>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<aside class="span4 detailsbar">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl>
|
|
|
|
|
|
<dt>File</dt>
|
|
|
|
|
|
<dd><a href="../files/core.table_builder.php.html"><div class="path-wrapper">core/table_builder.php</div></a></dd>
|
|
|
|
|
|
<dt>Package</dt>
|
|
|
|
|
|
<dd><div class="namespace-wrapper">\Query\Table_Builder\Table_Builder</div></dd>
|
|
|
|
|
|
<dt>Class hierarchy</dt>
|
|
|
|
|
|
<dd class="hierarchy">
|
|
|
|
|
|
<div class="namespace-wrapper">\Query\Table\Table_Builder</div>
|
|
|
|
|
|
</dd>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<h2>Tags</h2>
|
|
|
|
|
|
<table class="table table-condensed">
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<th>
|
|
|
|
|
|
todo
|
|
|
|
|
|
</th>
|
|
|
|
|
|
<td>
|
|
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
</table>
|
|
|
|
|
|
</aside>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="properties" name="properties"></a>
|
|
|
|
|
|
<div class="row-fluid">
|
|
|
|
|
|
<div class="span8 content class">
|
|
|
|
|
|
<h2>Properties</h2>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<aside class="span4 detailsbar"></aside>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<div class="row-fluid">
|
|
|
|
|
|
<div class="span8 content class">
|
|
|
|
|
|
<a id="property_name" name="property_name" class="anchor"></a>
|
|
|
|
|
|
<article class="property">
|
|
|
|
|
|
<h3 class="protected ">$name</h3>
|
|
|
|
|
|
<pre class="signature">$name : string</pre>
|
|
|
|
|
|
<p><em>The name of the current table</em></p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h4>Type</h4>
|
|
|
|
|
|
string
|
|
|
|
|
|
</article>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<aside class="span4 detailsbar">
|
|
|
|
|
|
<h1><i class="icon-arrow-down"></i></h1>
|
|
|
|
|
|
<dl>
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<h2>Tags</h2>
|
|
|
|
|
|
<table class="table table-condensed">
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<th>
|
|
|
|
|
|
todo
|
|
|
|
|
|
</th>
|
|
|
|
|
|
<td>
|
|
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
</table>
|
|
|
|
|
|
</aside>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<div class="row-fluid">
|
|
|
|
|
|
<div class="span8 content class">
|
|
|
|
|
|
<a id="property_driver" name="property_driver" class="anchor"></a>
|
|
|
|
|
|
<article class="property">
|
|
|
|
|
|
<h3 class="private ">$driver</h3>
|
|
|
|
|
|
<pre class="signature">$driver : \Query\Driver\Driver_Interface</pre>
|
|
|
|
|
|
<p><em>Driver for the current db</em></p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h4>Type</h4>
|
|
|
|
|
|
<a href="../classes/Query.Driver.Driver_Interface.html">\Query\Driver\Driver_Interface</a>
|
|
|
|
|
|
</article>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<aside class="span4 detailsbar">
|
|
|
|
|
|
<h1><i class="icon-arrow-down"></i></h1>
|
|
|
|
|
|
<dl>
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<h2>Tags</h2>
|
|
|
|
|
|
<table class="table table-condensed">
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<th>
|
|
|
|
|
|
todo
|
|
|
|
|
|
</th>
|
|
|
|
|
|
<td>
|
|
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
</table>
|
|
|
|
|
|
</aside>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<div class="row-fluid">
|
|
|
|
|
|
<div class="span8 content class">
|
|
|
|
|
|
<a id="property_table_options" name="property_table_options" class="anchor"></a>
|
|
|
|
|
|
<article class="property">
|
|
|
|
|
|
<h3 class="private ">$table_options</h3>
|
|
|
|
|
|
<pre class="signature">$table_options : array</pre>
|
|
|
|
|
|
<p><em>Options for the current table</em></p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h4>Type</h4>
|
|
|
|
|
|
array
|
|
|
|
|
|
</article>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<aside class="span4 detailsbar">
|
|
|
|
|
|
<h1><i class="icon-arrow-down"></i></h1>
|
|
|
|
|
|
<dl>
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<h2>Tags</h2>
|
|
|
|
|
|
<table class="table table-condensed">
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<th>
|
|
|
|
|
|
todo
|
|
|
|
|
|
</th>
|
|
|
|
|
|
<td>
|
|
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
</table>
|
|
|
|
|
|
</aside>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<div class="row-fluid">
|
|
|
|
|
|
<div class="span8 content class">
|
|
|
|
|
|
<a id="property_columns" name="property_columns" class="anchor"></a>
|
|
|
|
|
|
<article class="property">
|
|
|
|
|
|
<h3 class="private ">$columns</h3>
|
|
|
|
|
|
<pre class="signature">$columns : array</pre>
|
|
|
|
|
|
<p><em>Columns to be added/updated for the current table</em></p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h4>Type</h4>
|
|
|
|
|
|
array
|
|
|
|
|
|
</article>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<aside class="span4 detailsbar">
|
|
|
|
|
|
<h1><i class="icon-arrow-down"></i></h1>
|
|
|
|
|
|
<dl>
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<h2>Tags</h2>
|
|
|
|
|
|
<table class="table table-condensed">
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<th>
|
|
|
|
|
|
todo
|
|
|
|
|
|
</th>
|
|
|
|
|
|
<td>
|
|
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
</table>
|
|
|
|
|
|
</aside>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<div class="row-fluid">
|
|
|
|
|
|
<div class="span8 content class">
|
|
|
|
|
|
<a id="property_indexes" name="property_indexes" class="anchor"></a>
|
|
|
|
|
|
<article class="property">
|
|
|
|
|
|
<h3 class="private ">$indexes</h3>
|
|
|
|
|
|
<pre class="signature">$indexes : array</pre>
|
|
|
|
|
|
<p><em>Indexes to be added/updated for the current table</em></p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h4>Type</h4>
|
|
|
|
|
|
array
|
|
|
|
|
|
</article>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<aside class="span4 detailsbar">
|
|
|
|
|
|
<h1><i class="icon-arrow-down"></i></h1>
|
|
|
|
|
|
<dl>
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<h2>Tags</h2>
|
|
|
|
|
|
<table class="table table-condensed">
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<th>
|
|
|
|
|
|
todo
|
|
|
|
|
|
</th>
|
|
|
|
|
|
<td>
|
|
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
</table>
|
|
|
|
|
|
</aside>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<div class="row-fluid">
|
|
|
|
|
|
<div class="span8 content class">
|
|
|
|
|
|
<a id="property_foreign_keys" name="property_foreign_keys" class="anchor"></a>
|
|
|
|
|
|
<article class="property">
|
|
|
|
|
|
<h3 class="private ">$foreign_keys</h3>
|
|
|
|
|
|
<pre class="signature">$foreign_keys : array</pre>
|
|
|
|
|
|
<p><em>Foreign keys to be added/updated for the current table</em></p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h4>Type</h4>
|
|
|
|
|
|
array
|
|
|
|
|
|
</article>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<aside class="span4 detailsbar">
|
|
|
|
|
|
<h1><i class="icon-arrow-down"></i></h1>
|
|
|
|
|
|
<dl>
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<h2>Tags</h2>
|
|
|
|
|
|
<table class="table table-condensed">
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<th>
|
|
|
|
|
|
todo
|
|
|
|
|
|
</th>
|
|
|
|
|
|
<td>
|
|
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
</table>
|
|
|
|
|
|
</aside>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a id="methods" name="methods"></a>
|
|
|
|
|
|
<div class="row-fluid">
|
|
|
|
|
|
<div class="span8 content class"><h2>Methods</h2></div>
|
|
|
|
|
|
<aside class="span4 detailsbar"></aside>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<div class="row-fluid">
|
|
|
|
|
|
<div class="span8 content class">
|
|
|
|
|
|
<a id="method___construct" name="method___construct" class="anchor"></a>
|
|
|
|
|
|
<article class="method">
|
|
|
|
|
|
<h3 class="public ">__construct()</h3>
|
|
|
|
|
|
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
|
|
|
|
|
|
<pre class="signature" style="margin-right: 54px;">__construct(string <span class="argument">$name</span>, array <span class="argument">$options</span>, \Query\Driver\Driver_Interface <span class="argument">$driver</span>) : \Query\Table\Table_Builder</pre>
|
|
|
|
|
|
<p><em>Constructor</em></p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h4>Parameters</h4>
|
|
|
|
|
|
<table class="table table-condensed table-hover">
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<td>string</td>
|
|
|
|
|
|
<td>$name</td>
|
|
|
|
|
|
<td></td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<td>array</td>
|
|
|
|
|
|
<td>$options</td>
|
|
|
|
|
|
<td></td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<td><a href="../classes/Query.Driver.Driver_Interface.html">\Query\Driver\Driver_Interface</a></td>
|
|
|
|
|
|
<td>$driver</td>
|
|
|
|
|
|
<td></td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h4>Returns</h4>
|
|
|
|
|
|
<a href="../classes/Query.Table.Table_Builder.html">\Query\Table\Table_Builder</a>
|
|
|
|
|
|
</article>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<aside class="span4 detailsbar">
|
|
|
|
|
|
<h1><i class="icon-arrow-down"></i></h1>
|
|
|
|
|
|
<dl>
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<h2>Tags</h2>
|
|
|
|
|
|
<table class="table table-condensed">
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<th>
|
|
|
|
|
|
todo
|
|
|
|
|
|
</th>
|
|
|
|
|
|
<td>
|
|
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
</table>
|
|
|
|
|
|
</aside>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<div class="row-fluid">
|
|
|
|
|
|
<div class="span8 content class">
|
|
|
|
|
|
<a id="method___invoke" name="method___invoke" class="anchor"></a>
|
|
|
|
|
|
<article class="method">
|
|
|
|
|
|
<h3 class="public ">__invoke()</h3>
|
|
|
|
|
|
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
|
|
|
|
|
|
<pre class="signature" style="margin-right: 54px;">__invoke(string <span class="argument">$name</span>, array <span class="argument">$options</span>, \Query\Driver\Driver_Interface <span class="argument">$driver</span>) : \Query\Table\Table_Builder</pre>
|
|
|
|
|
|
<p><em>Alias to constructor</em></p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h4>Parameters</h4>
|
|
|
|
|
|
<table class="table table-condensed table-hover">
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<td>string</td>
|
|
|
|
|
|
<td>$name</td>
|
|
|
|
|
|
<td></td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<td>array</td>
|
|
|
|
|
|
<td>$options</td>
|
|
|
|
|
|
<td></td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<td><a href="../classes/Query.Driver.Driver_Interface.html">\Query\Driver\Driver_Interface</a></td>
|
|
|
|
|
|
<td>$driver</td>
|
|
|
|
|
|
<td></td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h4>Returns</h4>
|
|
|
|
|
|
<a href="../classes/Query.Table.Table_Builder.html">\Query\Table\Table_Builder</a>
|
|
|
|
|
|
</article>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<aside class="span4 detailsbar">
|
|
|
|
|
|
<h1><i class="icon-arrow-down"></i></h1>
|
|
|
|
|
|
<dl>
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<h2>Tags</h2>
|
|
|
|
|
|
<table class="table table-condensed">
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<th>
|
|
|
|
|
|
todo
|
|
|
|
|
|
</th>
|
|
|
|
|
|
<td>
|
|
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
</table>
|
|
|
|
|
|
</aside>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<div class="row-fluid">
|
|
|
|
|
|
<div class="span8 content class">
|
|
|
|
|
|
<a id="method_set_driver" name="method_set_driver" class="anchor"></a>
|
|
|
|
|
|
<article class="method">
|
|
|
|
|
|
<h3 class="public ">set_driver()</h3>
|
|
|
|
|
|
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
|
|
|
|
|
|
<pre class="signature" style="margin-right: 54px;">set_driver(\Query\Driver\Driver_Interface <span class="argument">$driver</span>) : \Query\Table\Table_Builder</pre>
|
|
|
|
|
|
<p><em>Set the reference to the current database driver</em></p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h4>Parameters</h4>
|
|
|
|
|
|
<table class="table table-condensed table-hover">
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<td><a href="../classes/Query.Driver.Driver_Interface.html">\Query\Driver\Driver_Interface</a></td>
|
|
|
|
|
|
<td>$driver</td>
|
|
|
|
|
|
<td></td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h4>Returns</h4>
|
|
|
|
|
|
<a href="../classes/Query.Table.Table_Builder.html">\Query\Table\Table_Builder</a>
|
|
|
|
|
|
</article>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<aside class="span4 detailsbar">
|
|
|
|
|
|
<h1><i class="icon-arrow-down"></i></h1>
|
|
|
|
|
|
<dl>
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<h2>Tags</h2>
|
|
|
|
|
|
<table class="table table-condensed">
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<th>
|
|
|
|
|
|
todo
|
|
|
|
|
|
</th>
|
|
|
|
|
|
<td>
|
|
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
</table>
|
|
|
|
|
|
</aside>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<div class="row-fluid">
|
|
|
|
|
|
<div class="span8 content class">
|
|
|
|
|
|
<a id="method_get_driver" name="method_get_driver" class="anchor"></a>
|
|
|
|
|
|
<article class="method">
|
|
|
|
|
|
<h3 class="public ">get_driver()</h3>
|
|
|
|
|
|
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
|
|
|
|
|
|
<pre class="signature" style="margin-right: 54px;">get_driver() : \Query\Driver\Driver_Interface</pre>
|
|
|
|
|
|
<p><em>Get the current DB Driver</em></p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h4>Returns</h4>
|
|
|
|
|
|
<a href="../classes/Query.Driver.Driver_Interface.html">\Query\Driver\Driver_Interface</a>
|
|
|
|
|
|
</article>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<aside class="span4 detailsbar">
|
|
|
|
|
|
<h1><i class="icon-arrow-down"></i></h1>
|
|
|
|
|
|
<dl>
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<h2>Tags</h2>
|
|
|
|
|
|
<table class="table table-condensed">
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<th>
|
|
|
|
|
|
todo
|
|
|
|
|
|
</th>
|
|
|
|
|
|
<td>
|
|
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
</table>
|
|
|
|
|
|
</aside>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<div class="row-fluid">
|
|
|
|
|
|
<div class="span8 content class">
|
|
|
|
|
|
<a id="method_add_column" name="method_add_column" class="anchor"></a>
|
|
|
|
|
|
<article class="method">
|
|
|
|
|
|
<h3 class="public ">add_column()</h3>
|
|
|
|
|
|
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
|
|
|
|
|
|
<pre class="signature" style="margin-right: 54px;">add_column(string <span class="argument">$column_name</span>, string <span class="argument">$type</span>, array <span class="argument">$options</span>) : \Query\Table\Table_Builder</pre>
|
|
|
|
|
|
<p><em>Add a column to the current table</em></p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h4>Parameters</h4>
|
|
|
|
|
|
<table class="table table-condensed table-hover">
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<td>string</td>
|
|
|
|
|
|
<td>$column_name</td>
|
|
|
|
|
|
<td></td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<td>string</td>
|
|
|
|
|
|
<td>$type</td>
|
|
|
|
|
|
<td></td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<td>array</td>
|
|
|
|
|
|
<td>$options</td>
|
|
|
|
|
|
<td></td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h4>Returns</h4>
|
|
|
|
|
|
<a href="../classes/Query.Table.Table_Builder.html">\Query\Table\Table_Builder</a>
|
|
|
|
|
|
</article>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<aside class="span4 detailsbar">
|
|
|
|
|
|
<h1><i class="icon-arrow-down"></i></h1>
|
|
|
|
|
|
<dl>
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<h2>Tags</h2>
|
|
|
|
|
|
<table class="table table-condensed">
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<th>
|
|
|
|
|
|
todo
|
|
|
|
|
|
</th>
|
|
|
|
|
|
<td>
|
|
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
</table>
|
|
|
|
|
|
</aside>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<div class="row-fluid">
|
|
|
|
|
|
<div class="span8 content class">
|
|
|
|
|
|
<a id="method_remove_column" name="method_remove_column" class="anchor"></a>
|
|
|
|
|
|
<article class="method">
|
|
|
|
|
|
<h3 class="public ">remove_column()</h3>
|
|
|
|
|
|
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
|
|
|
|
|
|
<pre class="signature" style="margin-right: 54px;">remove_column(string <span class="argument">$column_name</span>) : \Query\Table\Table_Builder</pre>
|
|
|
|
|
|
<p><em>Remove the specified column name from the current table</em></p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h4>Parameters</h4>
|
|
|
|
|
|
<table class="table table-condensed table-hover">
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<td>string</td>
|
|
|
|
|
|
<td>$column_name</td>
|
|
|
|
|
|
<td></td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h4>Returns</h4>
|
|
|
|
|
|
<a href="../classes/Query.Table.Table_Builder.html">\Query\Table\Table_Builder</a>
|
|
|
|
|
|
</article>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<aside class="span4 detailsbar">
|
|
|
|
|
|
<h1><i class="icon-arrow-down"></i></h1>
|
|
|
|
|
|
<dl>
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<h2>Tags</h2>
|
|
|
|
|
|
<table class="table table-condensed">
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<th>
|
|
|
|
|
|
todo
|
|
|
|
|
|
</th>
|
|
|
|
|
|
<td>
|
|
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
</table>
|
|
|
|
|
|
</aside>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<div class="row-fluid">
|
|
|
|
|
|
<div class="span8 content class">
|
|
|
|
|
|
<a id="method_rename_column" name="method_rename_column" class="anchor"></a>
|
|
|
|
|
|
<article class="method">
|
|
|
|
|
|
<h3 class="public ">rename_column()</h3>
|
|
|
|
|
|
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
|
|
|
|
|
|
<pre class="signature" style="margin-right: 54px;">rename_column(string <span class="argument">$old_name</span>, string <span class="argument">$new_name</span>) : \Query\Table\Table_Builder</pre>
|
|
|
|
|
|
<p><em>Rename the specified column on the current table</em></p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h4>Parameters</h4>
|
|
|
|
|
|
<table class="table table-condensed table-hover">
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<td>string</td>
|
|
|
|
|
|
<td>$old_name</td>
|
|
|
|
|
|
<td></td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<td>string</td>
|
|
|
|
|
|
<td>$new_name</td>
|
|
|
|
|
|
<td></td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h4>Returns</h4>
|
|
|
|
|
|
<a href="../classes/Query.Table.Table_Builder.html">\Query\Table\Table_Builder</a>
|
|
|
|
|
|
</article>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<aside class="span4 detailsbar">
|
|
|
|
|
|
<h1><i class="icon-arrow-down"></i></h1>
|
|
|
|
|
|
<dl>
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<h2>Tags</h2>
|
|
|
|
|
|
<table class="table table-condensed">
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<th>
|
|
|
|
|
|
todo
|
|
|
|
|
|
</th>
|
|
|
|
|
|
<td>
|
|
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
</table>
|
|
|
|
|
|
</aside>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<div class="row-fluid">
|
|
|
|
|
|
<div class="span8 content class">
|
|
|
|
|
|
<a id="method_change_column" name="method_change_column" class="anchor"></a>
|
|
|
|
|
|
<article class="method">
|
|
|
|
|
|
<h3 class="public ">change_column()</h3>
|
|
|
|
|
|
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
|
|
|
|
|
|
<pre class="signature" style="margin-right: 54px;">change_column(string <span class="argument">$column_name</span>, string <span class="argument">$new_column_type</span>, array <span class="argument">$options</span>) : \Query\Table\Table_Builder</pre>
|
|
|
|
|
|
<p><em>Change the specified column on the current table</em></p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h4>Parameters</h4>
|
|
|
|
|
|
<table class="table table-condensed table-hover">
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<td>string</td>
|
|
|
|
|
|
<td>$column_name</td>
|
|
|
|
|
|
<td></td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<td>string</td>
|
|
|
|
|
|
<td>$new_column_type</td>
|
|
|
|
|
|
<td></td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<td>array</td>
|
|
|
|
|
|
<td>$options</td>
|
|
|
|
|
|
<td></td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h4>Returns</h4>
|
|
|
|
|
|
<a href="../classes/Query.Table.Table_Builder.html">\Query\Table\Table_Builder</a>
|
|
|
|
|
|
</article>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<aside class="span4 detailsbar">
|
|
|
|
|
|
<h1><i class="icon-arrow-down"></i></h1>
|
|
|
|
|
|
<dl>
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<h2>Tags</h2>
|
|
|
|
|
|
<table class="table table-condensed">
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<th>
|
|
|
|
|
|
todo
|
|
|
|
|
|
</th>
|
|
|
|
|
|
<td>
|
|
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
</table>
|
|
|
|
|
|
</aside>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<div class="row-fluid">
|
|
|
|
|
|
<div class="span8 content class">
|
|
|
|
|
|
<a id="method_has_column" name="method_has_column" class="anchor"></a>
|
|
|
|
|
|
<article class="method">
|
|
|
|
|
|
<h3 class="public ">has_column()</h3>
|
|
|
|
|
|
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
|
|
|
|
|
|
<pre class="signature" style="margin-right: 54px;">has_column(string <span class="argument">$column_name</span>, array <span class="argument">$options</span>) : bool</pre>
|
|
|
|
|
|
<p><em>Determine whether the column currently exists on the current table</em></p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h4>Parameters</h4>
|
|
|
|
|
|
<table class="table table-condensed table-hover">
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<td>string</td>
|
|
|
|
|
|
<td>$column_name</td>
|
|
|
|
|
|
<td></td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<td>array</td>
|
|
|
|
|
|
<td>$options</td>
|
|
|
|
|
|
<td></td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h4>Returns</h4>
|
|
|
|
|
|
bool
|
|
|
|
|
|
</article>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<aside class="span4 detailsbar">
|
|
|
|
|
|
<h1><i class="icon-arrow-down"></i></h1>
|
|
|
|
|
|
<dl>
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<h2>Tags</h2>
|
|
|
|
|
|
<table class="table table-condensed">
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<th>
|
|
|
|
|
|
todo
|
|
|
|
|
|
</th>
|
|
|
|
|
|
<td>
|
|
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
</table>
|
|
|
|
|
|
</aside>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<div class="row-fluid">
|
|
|
|
|
|
<div class="span8 content class">
|
|
|
|
|
|
<a id="method_add_index" name="method_add_index" class="anchor"></a>
|
|
|
|
|
|
<article class="method">
|
|
|
|
|
|
<h3 class="public ">add_index()</h3>
|
|
|
|
|
|
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
|
|
|
|
|
|
<pre class="signature" style="margin-right: 54px;">add_index(array <span class="argument">$columns</span>, array <span class="argument">$options</span>) : \Query\Table\Table_Builder</pre>
|
|
|
|
|
|
<p><em>Add an index to the current table</em></p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h4>Parameters</h4>
|
|
|
|
|
|
<table class="table table-condensed table-hover">
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<td>array</td>
|
|
|
|
|
|
<td>$columns</td>
|
|
|
|
|
|
<td></td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<td>array</td>
|
|
|
|
|
|
<td>$options</td>
|
|
|
|
|
|
<td></td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h4>Returns</h4>
|
|
|
|
|
|
<a href="../classes/Query.Table.Table_Builder.html">\Query\Table\Table_Builder</a>
|
|
|
|
|
|
</article>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<aside class="span4 detailsbar">
|
|
|
|
|
|
<h1><i class="icon-arrow-down"></i></h1>
|
|
|
|
|
|
<dl>
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<h2>Tags</h2>
|
|
|
|
|
|
<table class="table table-condensed">
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<th>
|
|
|
|
|
|
todo
|
|
|
|
|
|
</th>
|
|
|
|
|
|
<td>
|
|
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
</table>
|
|
|
|
|
|
</aside>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<div class="row-fluid">
|
|
|
|
|
|
<div class="span8 content class">
|
|
|
|
|
|
<a id="method_remove_index" name="method_remove_index" class="anchor"></a>
|
|
|
|
|
|
<article class="method">
|
|
|
|
|
|
<h3 class="public ">remove_index()</h3>
|
|
|
|
|
|
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
|
|
|
|
|
|
<pre class="signature" style="margin-right: 54px;">remove_index(array <span class="argument">$columns</span>, array <span class="argument">$options</span>) : \Query\Table\Table_Builder</pre>
|
|
|
|
|
|
<p><em>Remove an index from the current table</em></p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h4>Parameters</h4>
|
|
|
|
|
|
<table class="table table-condensed table-hover">
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<td>array</td>
|
|
|
|
|
|
<td>$columns</td>
|
|
|
|
|
|
<td></td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<td>array</td>
|
|
|
|
|
|
<td>$options</td>
|
|
|
|
|
|
<td></td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h4>Returns</h4>
|
|
|
|
|
|
<a href="../classes/Query.Table.Table_Builder.html">\Query\Table\Table_Builder</a>
|
|
|
|
|
|
</article>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<aside class="span4 detailsbar">
|
|
|
|
|
|
<h1><i class="icon-arrow-down"></i></h1>
|
|
|
|
|
|
<dl>
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<h2>Tags</h2>
|
|
|
|
|
|
<table class="table table-condensed">
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<th>
|
|
|
|
|
|
todo
|
|
|
|
|
|
</th>
|
|
|
|
|
|
<td>
|
|
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
</table>
|
|
|
|
|
|
</aside>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<div class="row-fluid">
|
|
|
|
|
|
<div class="span8 content class">
|
|
|
|
|
|
<a id="method_remove_index_by_name" name="method_remove_index_by_name" class="anchor"></a>
|
|
|
|
|
|
<article class="method">
|
|
|
|
|
|
<h3 class="public ">remove_index_by_name()</h3>
|
|
|
|
|
|
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
|
|
|
|
|
|
<pre class="signature" style="margin-right: 54px;">remove_index_by_name(string <span class="argument">$name</span>) : \Query\Table\Table_Builder</pre>
|
|
|
|
|
|
<p><em>Remove an index by its name from the current table</em></p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h4>Parameters</h4>
|
|
|
|
|
|
<table class="table table-condensed table-hover">
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<td>string</td>
|
|
|
|
|
|
<td>$name</td>
|
|
|
|
|
|
<td></td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h4>Returns</h4>
|
|
|
|
|
|
<a href="../classes/Query.Table.Table_Builder.html">\Query\Table\Table_Builder</a>
|
|
|
|
|
|
</article>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<aside class="span4 detailsbar">
|
|
|
|
|
|
<h1><i class="icon-arrow-down"></i></h1>
|
|
|
|
|
|
<dl>
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<h2>Tags</h2>
|
|
|
|
|
|
<table class="table table-condensed">
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<th>
|
|
|
|
|
|
todo
|
|
|
|
|
|
</th>
|
|
|
|
|
|
<td>
|
|
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
</table>
|
|
|
|
|
|
</aside>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<div class="row-fluid">
|
|
|
|
|
|
<div class="span8 content class">
|
|
|
|
|
|
<a id="method_has_index" name="method_has_index" class="anchor"></a>
|
|
|
|
|
|
<article class="method">
|
|
|
|
|
|
<h3 class="public ">has_index()</h3>
|
|
|
|
|
|
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
|
|
|
|
|
|
<pre class="signature" style="margin-right: 54px;">has_index(array <span class="argument">$columns</span>, array <span class="argument">$options</span>) : bool</pre>
|
|
|
|
|
|
<p><em>Check if the current table has an index on the specified columns</em></p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h4>Parameters</h4>
|
|
|
|
|
|
<table class="table table-condensed table-hover">
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<td>array</td>
|
|
|
|
|
|
<td>$columns</td>
|
|
|
|
|
|
<td></td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<td>array</td>
|
|
|
|
|
|
<td>$options</td>
|
|
|
|
|
|
<td></td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h4>Returns</h4>
|
|
|
|
|
|
bool
|
|
|
|
|
|
</article>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<aside class="span4 detailsbar">
|
|
|
|
|
|
<h1><i class="icon-arrow-down"></i></h1>
|
|
|
|
|
|
<dl>
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<h2>Tags</h2>
|
|
|
|
|
|
<table class="table table-condensed">
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<th>
|
|
|
|
|
|
todo
|
|
|
|
|
|
</th>
|
|
|
|
|
|
<td>
|
|
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
</table>
|
|
|
|
|
|
</aside>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<div class="row-fluid">
|
|
|
|
|
|
<div class="span8 content class">
|
|
|
|
|
|
<a id="method_add_foreign_key" name="method_add_foreign_key" class="anchor"></a>
|
|
|
|
|
|
<article class="method">
|
|
|
|
|
|
<h3 class="public ">add_foreign_key()</h3>
|
|
|
|
|
|
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
|
|
|
|
|
|
<pre class="signature" style="margin-right: 54px;">add_foreign_key(array <span class="argument">$columns</span>, string <span class="argument">$referenced_table</span>, array <span class="argument">$referenced_columns</span>, array <span class="argument">$options</span>) : \Query\Table\Table_Builder</pre>
|
|
|
|
|
|
<p><em>Add a foreign key to the current table</em></p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h4>Parameters</h4>
|
|
|
|
|
|
<table class="table table-condensed table-hover">
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<td>array</td>
|
|
|
|
|
|
<td>$columns</td>
|
|
|
|
|
|
<td></td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<td>string</td>
|
|
|
|
|
|
<td>$referenced_table</td>
|
|
|
|
|
|
<td></td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<td>array</td>
|
|
|
|
|
|
<td>$referenced_columns</td>
|
|
|
|
|
|
<td></td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<td>array</td>
|
|
|
|
|
|
<td>$options</td>
|
|
|
|
|
|
<td></td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h4>Returns</h4>
|
|
|
|
|
|
<a href="../classes/Query.Table.Table_Builder.html">\Query\Table\Table_Builder</a>
|
|
|
|
|
|
</article>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<aside class="span4 detailsbar">
|
|
|
|
|
|
<h1><i class="icon-arrow-down"></i></h1>
|
|
|
|
|
|
<dl>
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<h2>Tags</h2>
|
|
|
|
|
|
<table class="table table-condensed">
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<th>
|
|
|
|
|
|
todo
|
|
|
|
|
|
</th>
|
|
|
|
|
|
<td>
|
|
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
</table>
|
|
|
|
|
|
</aside>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<div class="row-fluid">
|
|
|
|
|
|
<div class="span8 content class">
|
|
|
|
|
|
<a id="method_drop_foreign_key" name="method_drop_foreign_key" class="anchor"></a>
|
|
|
|
|
|
<article class="method">
|
|
|
|
|
|
<h3 class="public ">drop_foreign_key()</h3>
|
|
|
|
|
|
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
|
|
|
|
|
|
<pre class="signature" style="margin-right: 54px;">drop_foreign_key(array <span class="argument">$columns</span>, string <span class="argument">$constraint</span>) : \Query\Table\Table_Builder</pre>
|
|
|
|
|
|
<p><em>Drop the foreign key from the current table</em></p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h4>Parameters</h4>
|
|
|
|
|
|
<table class="table table-condensed table-hover">
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<td>array</td>
|
|
|
|
|
|
<td>$columns</td>
|
|
|
|
|
|
<td></td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<td>string</td>
|
|
|
|
|
|
<td>$constraint</td>
|
|
|
|
|
|
<td></td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h4>Returns</h4>
|
|
|
|
|
|
<a href="../classes/Query.Table.Table_Builder.html">\Query\Table\Table_Builder</a>
|
|
|
|
|
|
</article>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<aside class="span4 detailsbar">
|
|
|
|
|
|
<h1><i class="icon-arrow-down"></i></h1>
|
|
|
|
|
|
<dl>
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<h2>Tags</h2>
|
|
|
|
|
|
<table class="table table-condensed">
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<th>
|
|
|
|
|
|
todo
|
|
|
|
|
|
</th>
|
|
|
|
|
|
<td>
|
|
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
</table>
|
|
|
|
|
|
</aside>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<div class="row-fluid">
|
|
|
|
|
|
<div class="span8 content class">
|
|
|
|
|
|
<a id="method_has_foreign_key" name="method_has_foreign_key" class="anchor"></a>
|
|
|
|
|
|
<article class="method">
|
|
|
|
|
|
<h3 class="public ">has_foreign_key()</h3>
|
|
|
|
|
|
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
|
|
|
|
|
|
<pre class="signature" style="margin-right: 54px;">has_foreign_key(array <span class="argument">$columns</span>, string <span class="argument">$constraint</span>) : bool</pre>
|
|
|
|
|
|
<p><em>Determine whether the current table has the specified foreign key</em></p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h4>Parameters</h4>
|
|
|
|
|
|
<table class="table table-condensed table-hover">
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<td>array</td>
|
|
|
|
|
|
<td>$columns</td>
|
|
|
|
|
|
<td></td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<td>string</td>
|
|
|
|
|
|
<td>$constraint</td>
|
|
|
|
|
|
<td></td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h4>Returns</h4>
|
|
|
|
|
|
bool
|
|
|
|
|
|
</article>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<aside class="span4 detailsbar">
|
|
|
|
|
|
<h1><i class="icon-arrow-down"></i></h1>
|
|
|
|
|
|
<dl>
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<h2>Tags</h2>
|
|
|
|
|
|
<table class="table table-condensed">
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<th>
|
|
|
|
|
|
todo
|
|
|
|
|
|
</th>
|
|
|
|
|
|
<td>
|
|
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
</table>
|
|
|
|
|
|
</aside>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<div class="row-fluid">
|
|
|
|
|
|
<div class="span8 content class">
|
|
|
|
|
|
<a id="method_exists" name="method_exists" class="anchor"></a>
|
|
|
|
|
|
<article class="method">
|
|
|
|
|
|
<h3 class="public ">exists()</h3>
|
|
|
|
|
|
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
|
|
|
|
|
|
<pre class="signature" style="margin-right: 54px;">exists() : bool</pre>
|
|
|
|
|
|
<p><em>Check whether the current table exists</em></p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h4>Returns</h4>
|
|
|
|
|
|
bool
|
|
|
|
|
|
</article>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<aside class="span4 detailsbar">
|
|
|
|
|
|
<h1><i class="icon-arrow-down"></i></h1>
|
|
|
|
|
|
<dl>
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<h2>Tags</h2>
|
|
|
|
|
|
<table class="table table-condensed">
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<th>
|
|
|
|
|
|
todo
|
|
|
|
|
|
</th>
|
|
|
|
|
|
<td>
|
|
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
</table>
|
|
|
|
|
|
</aside>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<div class="row-fluid">
|
|
|
|
|
|
<div class="span8 content class">
|
|
|
|
|
|
<a id="method_drop" name="method_drop" class="anchor"></a>
|
|
|
|
|
|
<article class="method">
|
|
|
|
|
|
<h3 class="public ">drop()</h3>
|
|
|
|
|
|
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
|
|
|
|
|
|
<pre class="signature" style="margin-right: 54px;">drop() : void</pre>
|
|
|
|
|
|
<p><em>Drop the current table</em></p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<aside class="span4 detailsbar">
|
|
|
|
|
|
<h1><i class="icon-arrow-down"></i></h1>
|
|
|
|
|
|
<dl>
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<h2>Tags</h2>
|
|
|
|
|
|
<table class="table table-condensed">
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<th>
|
|
|
|
|
|
todo
|
|
|
|
|
|
</th>
|
|
|
|
|
|
<td>
|
|
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
</table>
|
|
|
|
|
|
</aside>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<div class="row-fluid">
|
|
|
|
|
|
<div class="span8 content class">
|
|
|
|
|
|
<a id="method_rename" name="method_rename" class="anchor"></a>
|
|
|
|
|
|
<article class="method">
|
|
|
|
|
|
<h3 class="public ">rename()</h3>
|
|
|
|
|
|
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
|
|
|
|
|
|
<pre class="signature" style="margin-right: 54px;">rename(string <span class="argument">$new_table_name</span>) : void</pre>
|
|
|
|
|
|
<p><em>Rename the current table</em></p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h4>Parameters</h4>
|
|
|
|
|
|
<table class="table table-condensed table-hover">
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<td>string</td>
|
|
|
|
|
|
<td>$new_table_name</td>
|
|
|
|
|
|
<td></td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<aside class="span4 detailsbar">
|
|
|
|
|
|
<h1><i class="icon-arrow-down"></i></h1>
|
|
|
|
|
|
<dl>
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<h2>Tags</h2>
|
|
|
|
|
|
<table class="table table-condensed">
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<th>
|
|
|
|
|
|
todo
|
|
|
|
|
|
</th>
|
|
|
|
|
|
<td>
|
|
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
</table>
|
|
|
|
|
|
</aside>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<div class="row-fluid">
|
|
|
|
|
|
<div class="span8 content class">
|
|
|
|
|
|
<a id="method_get_columns" name="method_get_columns" class="anchor"></a>
|
|
|
|
|
|
<article class="method">
|
|
|
|
|
|
<h3 class="public ">get_columns()</h3>
|
|
|
|
|
|
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
|
|
|
|
|
|
<pre class="signature" style="margin-right: 54px;">get_columns() : array</pre>
|
|
|
|
|
|
<p><em>Get the list of columns for the current table</em></p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h4>Returns</h4>
|
|
|
|
|
|
array
|
|
|
|
|
|
</article>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<aside class="span4 detailsbar">
|
|
|
|
|
|
<h1><i class="icon-arrow-down"></i></h1>
|
|
|
|
|
|
<dl>
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<h2>Tags</h2>
|
|
|
|
|
|
<table class="table table-condensed">
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<th>
|
|
|
|
|
|
todo
|
|
|
|
|
|
</th>
|
|
|
|
|
|
<td>
|
|
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
</table>
|
|
|
|
|
|
</aside>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<div class="row-fluid">
|
|
|
|
|
|
<div class="span8 content class">
|
|
|
|
|
|
<a id="method_create" name="method_create" class="anchor"></a>
|
|
|
|
|
|
<article class="method">
|
|
|
|
|
|
<h3 class="public ">create()</h3>
|
|
|
|
|
|
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
|
|
|
|
|
|
<pre class="signature" style="margin-right: 54px;">create() : void</pre>
|
|
|
|
|
|
<p><em>Create the table from the previously set options</em></p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<aside class="span4 detailsbar">
|
|
|
|
|
|
<h1><i class="icon-arrow-down"></i></h1>
|
|
|
|
|
|
<dl>
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<h2>Tags</h2>
|
|
|
|
|
|
<table class="table table-condensed">
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<th>
|
|
|
|
|
|
todo
|
|
|
|
|
|
</th>
|
|
|
|
|
|
<td>
|
|
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
</table>
|
|
|
|
|
|
</aside>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<div class="row-fluid">
|
|
|
|
|
|
<div class="span8 content class">
|
|
|
|
|
|
<a id="method_update" name="method_update" class="anchor"></a>
|
|
|
|
|
|
<article class="method">
|
|
|
|
|
|
<h3 class="public ">update()</h3>
|
|
|
|
|
|
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
|
|
|
|
|
|
<pre class="signature" style="margin-right: 54px;">update() : void</pre>
|
|
|
|
|
|
<p><em>Update the current table with the changes made</em></p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<aside class="span4 detailsbar">
|
|
|
|
|
|
<h1><i class="icon-arrow-down"></i></h1>
|
|
|
|
|
|
<dl>
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<h2>Tags</h2>
|
|
|
|
|
|
<table class="table table-condensed">
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<th>
|
|
|
|
|
|
todo
|
|
|
|
|
|
</th>
|
|
|
|
|
|
<td>
|
|
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
</table>
|
|
|
|
|
|
</aside>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<div class="row-fluid">
|
|
|
|
|
|
<div class="span8 content class">
|
|
|
|
|
|
<a id="method_save" name="method_save" class="anchor"></a>
|
|
|
|
|
|
<article class="method">
|
|
|
|
|
|
<h3 class="public ">save()</h3>
|
|
|
|
|
|
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
|
|
|
|
|
|
<pre class="signature" style="margin-right: 54px;">save() : void</pre>
|
|
|
|
|
|
<p><em>Save the changes made to the table</em></p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<aside class="span4 detailsbar">
|
|
|
|
|
|
<h1><i class="icon-arrow-down"></i></h1>
|
|
|
|
|
|
<dl>
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<h2>Tags</h2>
|
|
|
|
|
|
<table class="table table-condensed">
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<th>
|
|
|
|
|
|
todo
|
|
|
|
|
|
</th>
|
|
|
|
|
|
<td>
|
|
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
</table>
|
|
|
|
|
|
</aside>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<div class="row-fluid">
|
|
|
|
|
|
<div class="span8 content class">
|
|
|
|
|
|
<a id="method_reset" name="method_reset" class="anchor"></a>
|
|
|
|
|
|
<article class="method">
|
|
|
|
|
|
<h3 class="public ">reset()</h3>
|
|
|
|
|
|
<a href="#source-view" role="button" class="pull-right btn" data-toggle="modal" style="font-size: 1.1em; padding: 9px 14px"><i class="icon-code"></i></a>
|
|
|
|
|
|
<pre class="signature" style="margin-right: 54px;">reset() : void</pre>
|
|
|
|
|
|
<p><em>Reset the state of the table builder</em></p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<aside class="span4 detailsbar">
|
|
|
|
|
|
<h1><i class="icon-arrow-down"></i></h1>
|
|
|
|
|
|
<dl>
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
<h2>Tags</h2>
|
|
|
|
|
|
<table class="table table-condensed">
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<th>
|
|
|
|
|
|
todo
|
|
|
|
|
|
</th>
|
|
|
|
|
|
<td>
|
|
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
</table>
|
|
|
|
|
|
</aside>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
<div id="source-view" class="modal hide fade" tabindex="-1" role="dialog" aria-labelledby="source-view-label" aria-hidden="true">
|
|
|
|
|
|
<div class="modal-header">
|
|
|
|
|
|
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button>
|
|
|
|
|
|
<h3 id="source-view-label">table_builder.php</h3>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div class="modal-body">
|
|
|
|
|
|
<pre data-src="../files/core/table_builder.php.txt" class="language-php line-numbers"></pre>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<footer class="row-fluid">
|
|
|
|
|
|
<section class="span10 offset2">
|
|
|
|
|
|
<section class="row-fluid">
|
|
|
|
|
|
<section class="span10 offset1">
|
|
|
|
|
|
<section class="row-fluid footer-sections">
|
|
|
|
|
|
<section class="span4">
|
|
|
|
|
|
<h1><i class="icon-code"></i></h1>
|
|
|
|
|
|
<div>
|
|
|
|
|
|
<ul>
|
|
|
|
|
|
<li><a href="../namespaces/Query.html">\Query</a></li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<section class="span4">
|
|
|
|
|
|
<h1><i class="icon-bar-chart"></i></h1>
|
|
|
|
|
|
<div>
|
|
|
|
|
|
<ul>
|
|
|
|
|
|
<li><a href="../graphs/class.html">Class Hierarchy Diagram</a></li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<section class="span4">
|
|
|
|
|
|
<h1><i class="icon-pushpin"></i></h1>
|
|
|
|
|
|
<div>
|
|
|
|
|
|
<ul>
|
|
|
|
|
|
<li><a href="../reports/errors.html">Errors</a></li>
|
|
|
|
|
|
<li><a href="../reports/markers.html">Markers</a></li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
<section class="row-fluid">
|
|
|
|
|
|
<section class="span10 offset1">
|
|
|
|
|
|
<hr />
|
|
|
|
|
|
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and authored
|
2014-04-24 16:25:33 -04:00
|
|
|
|
on April 24th, 2014 at 16:24.
|
2014-04-15 16:13:18 -04:00
|
|
|
|
</section>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
</footer>
|
2014-04-02 17:08:50 -04:00
|
|
|
|
</div>
|
2014-04-15 16:13:18 -04:00
|
|
|
|
|
2014-04-02 17:08:50 -04:00
|
|
|
|
</body>
|
|
|
|
|
|
</html>
|
