2014-04-03 14:50:36 -04:00
<!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\Driver\Abstract_Util< / 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
2014-04-10 15:55:52 -04:00
< span class = "label label-info" > 2< / span > < / a > < / li >
2014-04-03 14:50:36 -04:00
< / 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___call" title = "__call() :: Enable calling driver methods" > < span class = "description" > Enable calling driver methods< / span > < pre > __call()< / pre > < / a > < / li >
< li class = "method public " > < a href = "#method___construct" title = "__construct() :: Save a reference to the connection object for later use" > < span class = "description" > Save a reference to the connection object for later use< / span > < pre > __construct()< / pre > < / a > < / li >
< li class = "method public " > < a href = "#method_backup_data" title = "backup_data() :: Return an SQL file with the database data as insert statements" > < span class = "description" > Return an SQL file with the database data as insert statements< / span > < pre > backup_data()< / pre > < / a > < / li >
< li class = "method public " > < a href = "#method_backup_structure" title = "backup_structure() :: Return an SQL file with the database table structure" > < span class = "description" > Return an SQL file with the database table structure< / span > < pre > backup_structure()< / pre > < / a > < / li >
< li class = "method public " > < a href = "#method_create_table" title = "create_table() :: Convienience public function to generate sql for creating a db table" > < span class = "description" > Convienience public function to generate sql for creating a db table< / span > < pre > create_table()< / pre > < / a > < / li >
< li class = "method public " > < a href = "#method_delete_table" title = "delete_table() :: Drop the selected table" > < span class = "description" > Drop the selected table< / span > < pre > delete_table()< / pre > < / a > < / li >
2014-04-09 13:19:59 -04:00
< li class = "method public " > < a href = "#method_quote_ident" title = "quote_ident() :: " > < span class = "description" > quote_ident()
< / span > < pre > quote_ident()< / pre > < / a > < / li >
< li class = "method public " > < a href = "#method_quote_table" title = "quote_table() :: " > < span class = "description" > quote_table()
< / span > < pre > quote_table()< / pre > < / a > < / li >
2014-04-03 14:50:36 -04:00
< / ul >
< / li >
< li class = "nav-header" >
< i title = "Properties" class = "icon-custom icon-property" > < / i > Properties
< ul > < / ul >
< / li >
< li class = "nav-header private" > » Private
< ul > < li class = "property private " > < a href = "#property_conn" title = "$conn() :: Reference to the current connection object" > < span class = "description" > < / span > < pre > $conn< / pre > < / a > < / li > < / ul >
< / li >
< / ul >
< / div >
< div class = "span8" >
< a id = "\Query\Driver\Abstract_Util" > < / 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 >
< span class = "divider" > \< / span > < a href = "../namespaces/Query.Driver.html" > Driver< / a >
< / li >
< li class = "active" >
< span class = "divider" > \< / span > < a href = "../classes/Query.Driver.Abstract_Util.html" > Abstract_Util< / 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.Drivers.html" > Query< / a > < / td >
< / tr >
< tr >
< th > subpackage< / th >
< td > Drivers< / td >
< / tr >
< / table >
< h3 >
< i title = "Methods" class = "icon-custom icon-method" > < / i > Methods< / h3 >
< a id = "method___call" > < / a > < div class = "element clickable method public method___call" data-toggle = "collapse" data-target = ".method___call .collapse" title = "public" >
< h2 > Enable calling driver methods< / h2 >
< pre > __call(string $method, array $args) : mixed< / 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 > $method< / h4 >
< code > string< / code >
< / div >
< div class = "subelement argument" >
< h4 > $args< / h4 >
< code > array< / code >
< / div >
< h3 > Returns< / h3 >
< div class = "subelement response" > < code > mixed< / code > < / div >
< / div > < / div >
< / div >
< a id = "method___construct" > < / a > < div class = "element clickable method public method___construct" data-toggle = "collapse" data-target = ".method___construct .collapse" title = "public" >
< h2 > Save a reference to the connection object for later use< / h2 >
2014-04-10 15:55:52 -04:00
< pre > __construct(\Query\Driver\Driver_Interface $conn) < / pre >
2014-04-03 14:50:36 -04:00
< 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 > $conn< / h4 >
2014-04-10 15:55:52 -04:00
< code > < a href = "../classes/Query.Driver.Driver_Interface.html" > \Query\Driver\Driver_Interface< / a > < / code >
2014-04-03 14:50:36 -04:00
< / div >
< / div > < / div >
< / div >
< a id = "method_backup_data" > < / a > < div class = "element clickable method public method_backup_data" data-toggle = "collapse" data-target = ".method_backup_data .collapse" title = "public" >
< h2 > Return an SQL file with the database data as insert statements< / h2 >
< pre > backup_data() : string< / pre >
< div class = "labels" > < / div >
< div class = "row collapse" > < div class = "detail-description" >
< div class = "long_description" > < / div >
< table class = "table table-bordered" > < tr >
< th > abstract< / th >
< td > < / td >
< / tr > < / table >
< h3 > Returns< / h3 >
< div class = "subelement response" > < code > string< / code > < / div >
< / div > < / div >
< / div >
< a id = "method_backup_structure" > < / a > < div class = "element clickable method public method_backup_structure" data-toggle = "collapse" data-target = ".method_backup_structure .collapse" title = "public" >
< h2 > Return an SQL file with the database table structure< / h2 >
< pre > backup_structure() : string< / pre >
< div class = "labels" > < / div >
< div class = "row collapse" > < div class = "detail-description" >
< div class = "long_description" > < / div >
< table class = "table table-bordered" > < tr >
< th > abstract< / th >
< td > < / td >
< / tr > < / table >
< h3 > Returns< / h3 >
< div class = "subelement response" > < code > string< / code > < / div >
< / div > < / div >
< / div >
< a id = "method_create_table" > < / a > < div class = "element clickable method public method_create_table" data-toggle = "collapse" data-target = ".method_create_table .collapse" title = "public" >
< h2 > Convienience public function to generate sql for creating a db table< / h2 >
2014-04-09 13:19:59 -04:00
< pre > create_table(string $name, array $fields, array $constraints< code > = array()< / code > ) : string< / pre >
2014-04-03 14:50:36 -04:00
< div class = "labels" > < / div >
< div class = "row collapse" > < div class = "detail-description" >
< div class = "long_description" > < / div >
2014-04-10 15:55:52 -04:00
< table class = "table table-bordered" > < tr >
< th > deprecated< / th >
< td > Use the table builder class instead< / td >
< / tr > < / table >
2014-04-03 14:50:36 -04:00
< h3 > Parameters< / h3 >
< div class = "subelement argument" >
< h4 > $name< / h4 >
< code > string< / code >
< / div >
< div class = "subelement argument" >
< h4 > $fields< / h4 >
< code > array< / code >
< / div >
< div class = "subelement argument" >
< h4 > $constraints< / h4 >
< code > array< / code >
< / div >
< h3 > Returns< / h3 >
< div class = "subelement response" > < code > string< / code > < / div >
< / div > < / div >
< / div >
< a id = "method_delete_table" > < / a > < div class = "element clickable method public method_delete_table" data-toggle = "collapse" data-target = ".method_delete_table .collapse" title = "public" >
< h2 > Drop the selected table< / h2 >
< pre > delete_table(string $name) : string< / 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 >
< h3 > Returns< / h3 >
< div class = "subelement response" > < code > string< / code > < / div >
< / div > < / div >
< / div >
2014-04-09 13:19:59 -04:00
< a id = "method_quote_ident" > < / a > < div class = "element clickable method public method_quote_ident" data-toggle = "collapse" data-target = ".method_quote_ident .collapse" title = "public" >
< h2 > quote_ident()
< / h2 >
< pre > quote_ident() : < / pre >
< div class = "labels" > < / div >
< div class = "row collapse" > < div class = "detail-description" >
< div class = "long_description" > < / div >
< table class = "table table-bordered" >
< tr >
< th > magic< / th >
< td > < / td >
< / tr >
< tr >
< th > method< / th >
< td > < / td >
< / tr >
< / table >
< h3 > Returns< / h3 >
< div class = "subelement response" > < code > < / code > < / div >
< / div > < / div >
< / div >
< a id = "method_quote_table" > < / a > < div class = "element clickable method public method_quote_table" data-toggle = "collapse" data-target = ".method_quote_table .collapse" title = "public" >
< h2 > quote_table()
< / h2 >
< pre > quote_table() : < / pre >
< div class = "labels" > < / div >
< div class = "row collapse" > < div class = "detail-description" >
< div class = "long_description" > < / div >
< table class = "table table-bordered" >
< tr >
< th > magic< / th >
< td > < / td >
< / tr >
< tr >
< th > method< / th >
< td > < / td >
< / tr >
< / table >
< h3 > Returns< / h3 >
< div class = "subelement response" > < code > < / code > < / div >
< / div > < / div >
< / div >
2014-04-03 14:50:36 -04:00
< h3 >
< i title = "Properties" class = "icon-custom icon-property" > < / i > Properties< / h3 >
< a id = "property_conn" > < / a > < div class = "element clickable property private property_conn" data-toggle = "collapse" data-target = ".property_conn .collapse" title = "private" >
< h2 > Reference to the current connection object< / h2 >
< pre > $conn < / pre >
< div class = "row collapse" > < div class = "detail-description" >
< h3 > Default< / h3 >
< div class = "subelement argument" > < / 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 >
2014-04-10 15:55:52 -04:00
generated on 2014-04-10T15:54:52-04:00.< br > < / footer > < / div >
2014-04-03 14:50:36 -04:00
< / div >
< / body >
< / html >