2013-12-06 23:00:32 -05:00
<!DOCTYPE html> < html lang = "en" >
2012-09-13 11:45:27 -04:00
< 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" >
2014-04-02 17:08:50 -04:00
< title > Query » \Query\Driver\Abstract_Driver< / title >
2012-09-13 11:45:27 -04:00
< 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" >
2014-04-02 17:08:50 -04:00
< li > < a > Namespaces< / a > < / li >
< li > < a href = "../namespaces/Query.html" > < i class = "icon-th" > < / i > < / a > < / li >
< li > < a href = "../namespaces/global.html" > < i class = "icon-th" > < / i > < / a > < / li >
2012-09-13 11:45:27 -04:00
< li > < a > Packages< / a > < / li >
< li > < a href = "../packages/Query.html" > < i class = "icon-folder-open" > < / i > < / 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 > < / 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 >
2013-12-06 23:00:32 -05:00
< span class = "label label-info" > 0< / span > < / a > < / li >
2012-09-13 11:45:27 -04:00
< li > < a href = "../markers.html" > < i class = "icon-map-marker" > < / i >
2013-12-06 23:00:32 -05:00
< ul > < / ul > < / a > < / li >
2012-09-13 11:45:27 -04:00
< li > < a href = "../deprecated.html" > < i class = "icon-stop" > < / i >
< 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" >
2014-02-18 15:16:34 -05:00
< 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" >
2012-09-13 11:45:27 -04:00
< 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 >
2014-02-18 15:16:34 -05:00
< / div >
2012-09-13 11:45:27 -04:00
< ul class = "side-nav nav nav-list" >
< li class = "nav-header" >
2014-02-18 15:16:34 -05:00
< i title = "Methods" class = "icon-custom icon-method" > < / i >
2013-12-06 23:00:32 -05:00
< ul >
< li class = "method public " > < a href = "#method___construct" title = "__construct() :: PDO constructor wrapper" > < span class = "description" > PDO constructor wrapper< / span > < pre > __construct()< / pre > < / a > < / li >
2014-02-18 15:16:34 -05:00
< li class = "method public " > < a href = "#method__quote" title = "_quote() :: Helper method for quote_ident" > < span class = "description" > Helper method for quote_ident< / span > < pre > _quote()< / pre > < / a > < / li >
2013-12-06 23:00:32 -05:00
< li class = "method public " > < a href = "#method_affected_rows" title = "affected_rows() :: Returns number of rows affected by an INSERT, UPDATE, DELETE type query" > < span class = "description" > Returns number of rows affected by an INSERT, UPDATE, DELETE type query< / span > < pre > affected_rows()< / pre > < / a > < / li >
< li class = "method public " > < a href = "#method_driver_query" title = "driver_query() :: Method to simplify retreiving db results for meta-data queries" > < span class = "description" > Method to simplify retreiving db results for meta-data queries< / span > < pre > driver_query()< / pre > < / a > < / li >
< li class = "method public " > < a href = "#method_get_columns" title = "get_columns() :: Retrieve column information for the current database table" > < span class = "description" > Retrieve column information for the current database table< / span > < pre > get_columns()< / pre > < / a > < / li >
< li class = "method public " > < a href = "#method_get_dbs" title = "get_dbs() :: Return list of dbs for the current connection, if possible" > < span class = "description" > Return list of dbs for the current connection, if possible< / span > < pre > get_dbs()< / pre > < / a > < / li >
< li class = "method public " > < a href = "#method_get_functions" title = "get_functions() :: Return list of function for the current database" > < span class = "description" > Return list of function for the current database< / span > < pre > get_functions()< / pre > < / a > < / li >
< li class = "method public " > < a href = "#method_get_procedures" title = "get_procedures() :: Return list of stored procedures for the current database" > < span class = "description" > Return list of stored procedures for the current database< / span > < pre > get_procedures()< / pre > < / a > < / li >
< li class = "method public " > < a href = "#method_get_schemas" title = "get_schemas() :: Return schemas for databases that list them" > < span class = "description" > Return schemas for databases that list them< / span > < pre > get_schemas()< / pre > < / a > < / li >
< li class = "method public " > < a href = "#method_get_sequences" title = "get_sequences() :: Return list of sequences for the current database, if they exist" > < span class = "description" > Return list of sequences for the current database, if they exist< / span > < pre > get_sequences()< / pre > < / a > < / li >
< li class = "method public " > < a href = "#method_get_system_tables" title = "get_system_tables() :: Retreives an array of non-user-created tables for
2012-09-13 11:45:27 -04:00
the connection/database">< span class = "description" > Retreives an array of non-user-created tables for
the connection/database< / span > < pre > get_system_tables()< / pre > < / a > < / li >
2013-12-06 23:00:32 -05:00
< li class = "method public " > < a href = "#method_get_tables" title = "get_tables() :: Return list of tables for the current database" > < span class = "description" > Return list of tables for the current database< / span > < pre > get_tables()< / pre > < / a > < / li >
< li class = "method public " > < a href = "#method_get_triggers" title = "get_triggers() :: Return list of triggers for the current database" > < span class = "description" > Return list of triggers for the current database< / span > < pre > get_triggers()< / pre > < / a > < / li >
< li class = "method public " > < a href = "#method_get_types" title = "get_types() :: Retrieve list of data types for the database" > < span class = "description" > Retrieve list of data types for the database< / span > < pre > get_types()< / pre > < / a > < / li >
< li class = "method public " > < a href = "#method_get_views" title = "get_views() :: Return list of views for the current database" > < span class = "description" > Return list of views for the current database< / span > < pre > get_views()< / pre > < / a > < / li >
< li class = "method public " > < a href = "#method_insert_batch" title = "insert_batch() :: Create sql for batch insert" > < span class = "description" > Create sql for batch insert< / span > < pre > insert_batch()< / pre > < / a > < / li >
< li class = "method public " > < a href = "#method_num_rows" title = "num_rows() :: Return the number of rows returned for a SELECT query" > < span class = "description" > Return the number of rows returned for a SELECT query< / span > < pre > num_rows()< / pre > < / a > < / li >
< li class = "method public " > < a href = "#method_prepare_execute" title = "prepare_execute() :: Create and execute a prepared statement with the provided parameters" > < span class = "description" > Create and execute a prepared statement with the provided parameters< / span > < pre > prepare_execute()< / pre > < / a > < / li >
< li class = "method public " > < a href = "#method_prepare_query" title = "prepare_query() :: Simplifies prepared statements for database queries" > < span class = "description" > Simplifies prepared statements for database queries< / span > < pre > prepare_query()< / pre > < / a > < / li >
< li class = "method public " > < a href = "#method_quote_ident" title = "quote_ident() :: Surrounds the string with the databases identifier escape characters" > < span class = "description" > Surrounds the string with the databases identifier escape characters< / span > < pre > quote_ident()< / pre > < / a > < / li >
< li class = "method public " > < a href = "#method_quote_table" title = "quote_table() :: Quote database table name, and set prefix" > < span class = "description" > Quote database table name, and set prefix< / span > < pre > quote_table()< / pre > < / a > < / li >
< li class = "method public " > < a href = "#method_truncate" title = "truncate() :: Empty the passed table" > < span class = "description" > Empty the passed table< / span > < pre > truncate()< / pre > < / a > < / li >
< / ul >
< / li >
< li class = "nav-header protected" > » Protected
2014-02-18 15:16:34 -05:00
< ul > < li class = "method protected " > < a href = "#method__prefix" title = "_prefix() :: Sets the table prefix on the passed string" > < span class = "description" > Sets the table prefix on the passed string< / span > < pre > _prefix()< / pre > < / a > < / li > < / ul >
2013-12-06 23:00:32 -05:00
< / li >
2012-09-13 11:45:27 -04:00
< li class = "nav-header" >
2014-02-18 15:16:34 -05:00
< i title = "Properties" class = "icon-custom icon-property" > < / i >
2013-12-06 23:00:32 -05:00
< ul >
2014-03-31 16:01:58 -04:00
< li class = "property public " > < a href = "#property_last_query" title = "$last_query() :: Last query executed" > < span class = "description" > < / span > < pre > $last_query< / pre > < / a > < / li >
< li class = "property public " > < a href = "#property_sql" title = "$sql() :: Reference to sql class" > < span class = "description" > < / span > < pre > $sql< / pre > < / a > < / li >
< li class = "property public " > < a href = "#property_table_prefix" title = "$table_prefix() :: Prefix to apply to table names" > < span class = "description" > < / span > < pre > $table_prefix< / pre > < / a > < / li >
< li class = "property public " > < a href = "#property_util" title = "$util() :: Reference to util class" > < span class = "description" > < / span > < pre > $util< / pre > < / a > < / li >
2013-12-06 23:00:32 -05:00
< / ul >
< / li >
< li class = "nav-header protected" > » Protected
< ul >
2014-03-31 16:01:58 -04:00
< li class = "property protected " > < a href = "#property_escape_char" title = "$escape_char() :: Character to escape indentifiers" > < span class = "description" > < / span > < pre > $escape_char< / pre > < / a > < / li >
< li class = "property protected " > < a href = "#property_statement" title = "$statement() :: Reference to the last executed query" > < span class = "description" > < / span > < pre > $statement< / pre > < / a > < / li >
2013-12-06 23:00:32 -05:00
< / ul >
< / li >
2012-09-13 11:45:27 -04:00
< / ul >
< / div >
< div class = "span8" >
2014-04-02 17:08:50 -04:00
< a id = "\Query\Driver\Abstract_Driver" > < / a > < ul class = "breadcrumb" >
2013-12-06 23:00:32 -05:00
< li >
2014-02-18 15:16:34 -05:00
< a href = "../index.html" > < i title = "Classes" class = "icon-custom icon-class" > < / i > < / a > < span class = "divider" > \< / span >
2013-12-06 23:00:32 -05:00
< / li >
2014-04-02 17:08:50 -04:00
< li > < a href = "../namespaces/Query.html" > Query< / a > < / li >
< li >
< span class = "divider" > \< / span > < a href = "../namespaces/Query.Driver.html" > Driver< / a >
< / li >
2013-12-06 23:00:32 -05:00
< li class = "active" >
2014-04-02 17:08:50 -04:00
< span class = "divider" > \< / span > < a href = "../classes/Query.Driver.Abstract_Driver.html" > Abstract_Driver< / a >
2013-12-06 23:00:32 -05:00
< / li >
< / ul >
< div class = "element class" >
2012-09-13 11:45:27 -04:00
< p class = "short_description" > Base Database class< / p >
< div class = "details" >
2013-12-06 23:00:32 -05:00
< div class = "long_description" > Extends PDO to simplify cross-database issues< / div >
2012-09-13 11:45:27 -04:00
< table class = "table table-bordered" >
< tr >
< th > package< / th >
2014-03-31 16:01:58 -04:00
< td > < a href = "../packages/Query.Drivers.html" > Query< / a > < / td >
2012-09-13 11:45:27 -04:00
< / tr >
< tr >
< th > subpackage< / th >
2014-03-31 16:01:58 -04:00
< td > Drivers< / td >
2012-09-13 11:45:27 -04:00
< / tr >
< / table >
< h3 >
2014-02-18 15:16:34 -05:00
< i title = "Methods" class = "icon-custom icon-method" > < / i > < / h3 >
< a id = "method___construct" > < / a > < div class = "element clickable method public method___construct" data-toggle = "collapse" data-target = ".method___construct .collapse" title = "public" >
2012-09-13 11:45:27 -04:00
< h2 > PDO constructor wrapper< / h2 >
2014-02-18 15:16:34 -05:00
< pre > __construct(string < code > < / code > , string < code > < / code > , array < code > < / code > ) < / pre >
2012-09-13 11:45:27 -04:00
< div class = "labels" > < / div >
2013-12-06 23:00:32 -05:00
< div class = "row collapse" > < div class = "detail-description" >
< div class = "long_description" > < / div >
2012-09-13 11:45:27 -04:00
< h3 > Parameters< / h3 >
< div class = "subelement argument" >
< h4 > $dsn< / h4 >
< code > string< / code >
< / div >
< div class = "subelement argument" >
< h4 > $username< / h4 >
< code > string< / code >
< / div >
< div class = "subelement argument" >
< h4 > $password< / h4 >
< code > string< / code >
< / div >
< div class = "subelement argument" >
< h4 > $driver_options< / h4 >
< code > array< / code >
< / div >
< / div > < / div >
< / div >
2014-02-18 15:16:34 -05:00
< a id = "method__quote" > < / a > < div class = "element clickable method public method__quote" data-toggle = "collapse" data-target = ".method__quote .collapse" title = "public" >
< h2 > Helper method for quote_ident< / h2 >
< pre > _quote(mixed < / pre >
2012-09-13 11:45:27 -04:00
< div class = "labels" > < / div >
2013-12-06 23:00:32 -05:00
< div class = "row collapse" > < div class = "detail-description" >
< div class = "long_description" > < / div >
2012-09-13 11:45:27 -04:00
< h3 > Parameters< / h3 >
< div class = "subelement argument" >
2014-02-18 15:16:34 -05:00
< h4 > $str< / h4 >
< code > mixed< / code >
< / div >
< h3 > Returns< / h3 >
< div class = "subelement response" > < code > mixed< / code > < / div >
< / div > < / div >
2012-09-13 11:45:27 -04:00
< / div >
2014-02-18 15:16:34 -05:00
< a id = "method_affected_rows" > < / a > < div class = "element clickable method public method_affected_rows" data-toggle = "collapse" data-target = ".method_affected_rows .collapse" title = "public" >
< h2 > Returns number of rows affected by an INSERT, UPDATE, DELETE type query< / h2 >
< pre > affected_rows() < / pre >
< div class = "labels" > < / div >
< div class = "row collapse" > < div class = "detail-description" >
< div class = "long_description" > < / div >
2012-09-13 11:45:27 -04:00
< h3 > Returns< / h3 >
< div class = "subelement response" > < code > int< / code > < / div >
< / div > < / div >
< / div >
2014-02-18 15:16:34 -05:00
< a id = "method_driver_query" > < / a > < div class = "element clickable method public method_driver_query" data-toggle = "collapse" data-target = ".method_driver_query .collapse" title = "public" >
2012-09-13 11:45:27 -04:00
< h2 > Method to simplify retreiving db results for meta-data queries< / h2 >
2014-04-02 17:08:50 -04:00
< pre > driver_query(string|array|null < code > < / code > ) < / pre >
2012-09-13 11:45:27 -04:00
< div class = "labels" > < / div >
2013-12-06 23:00:32 -05:00
< div class = "row collapse" > < div class = "detail-description" >
< div class = "long_description" > < / div >
2012-09-13 11:45:27 -04:00
< h3 > Parameters< / h3 >
< div class = "subelement argument" >
< h4 > $sql< / h4 >
2014-04-02 17:08:50 -04:00
< code > string< / code > < code > array< / code > < code > null< / code >
2012-09-13 11:45:27 -04:00
< / div >
< div class = "subelement argument" >
< h4 > $filtered_index< / h4 >
< code > bool< / code >
< / div >
< h3 > Returns< / h3 >
2014-04-02 11:02:18 -04:00
< div class = "subelement response" > < code > array< / code > < / div >
2012-09-13 11:45:27 -04:00
< / div > < / div >
< / div >
2014-02-18 15:16:34 -05:00
< 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" >
2012-09-13 11:45:27 -04:00
< h2 > Retrieve column information for the current database table< / h2 >
< pre > get_columns(string < / pre >
< div class = "labels" > < / div >
2013-12-06 23:00:32 -05:00
< div class = "row collapse" > < div class = "detail-description" >
< div class = "long_description" > < / div >
2012-09-13 11:45:27 -04:00
< h3 > Parameters< / h3 >
< div class = "subelement argument" >
< h4 > $table< / h4 >
< code > string< / code >
< / div >
< h3 > Returns< / h3 >
< div class = "subelement response" > < code > array< / code > < / div >
< / div > < / div >
< / div >
2014-02-18 15:16:34 -05:00
< a id = "method_get_dbs" > < / a > < div class = "element clickable method public method_get_dbs" data-toggle = "collapse" data-target = ".method_get_dbs .collapse" title = "public" >
2012-09-13 11:45:27 -04:00
< h2 > Return list of dbs for the current connection, if possible< / h2 >
< pre > get_dbs() < / pre >
< div class = "labels" > < / div >
2013-12-06 23:00:32 -05:00
< div class = "row collapse" > < div class = "detail-description" >
< div class = "long_description" > < / div >
2012-09-13 11:45:27 -04:00
< h3 > Returns< / h3 >
< div class = "subelement response" > < code > array< / code > < / div >
< / div > < / div >
< / div >
2014-02-18 15:16:34 -05:00
< a id = "method_get_functions" > < / a > < div class = "element clickable method public method_get_functions" data-toggle = "collapse" data-target = ".method_get_functions .collapse" title = "public" >
2012-09-13 11:45:27 -04:00
< h2 > Return list of function for the current database< / h2 >
< pre > get_functions() < / pre >
< div class = "labels" > < / div >
2013-12-06 23:00:32 -05:00
< div class = "row collapse" > < div class = "detail-description" >
< div class = "long_description" > < / div >
2012-09-13 11:45:27 -04:00
< h3 > Returns< / h3 >
< div class = "subelement response" > < code > array< / code > < / div >
< / div > < / div >
< / div >
2014-02-18 15:16:34 -05:00
< a id = "method_get_procedures" > < / a > < div class = "element clickable method public method_get_procedures" data-toggle = "collapse" data-target = ".method_get_procedures .collapse" title = "public" >
2012-09-13 11:45:27 -04:00
< h2 > Return list of stored procedures for the current database< / h2 >
< pre > get_procedures() < / pre >
< div class = "labels" > < / div >
2013-12-06 23:00:32 -05:00
< div class = "row collapse" > < div class = "detail-description" >
< div class = "long_description" > < / div >
2012-09-13 11:45:27 -04:00
< h3 > Returns< / h3 >
< div class = "subelement response" > < code > array< / code > < / div >
< / div > < / div >
< / div >
2014-02-18 15:16:34 -05:00
< a id = "method_get_schemas" > < / a > < div class = "element clickable method public method_get_schemas" data-toggle = "collapse" data-target = ".method_get_schemas .collapse" title = "public" >
2012-09-13 11:45:27 -04:00
< h2 > Return schemas for databases that list them< / h2 >
< pre > get_schemas() < / pre >
< div class = "labels" > < / div >
2013-12-06 23:00:32 -05:00
< div class = "row collapse" > < div class = "detail-description" >
< div class = "long_description" > < / div >
2012-09-13 11:45:27 -04:00
< h3 > Returns< / h3 >
< div class = "subelement response" > < code > array< / code > < / div >
< / div > < / div >
< / div >
2014-02-18 15:16:34 -05:00
< a id = "method_get_sequences" > < / a > < div class = "element clickable method public method_get_sequences" data-toggle = "collapse" data-target = ".method_get_sequences .collapse" title = "public" >
2012-09-13 11:45:27 -04:00
< h2 > Return list of sequences for the current database, if they exist< / h2 >
< pre > get_sequences() < / pre >
< div class = "labels" > < / div >
2013-12-06 23:00:32 -05:00
< div class = "row collapse" > < div class = "detail-description" >
< div class = "long_description" > < / div >
2012-09-13 11:45:27 -04:00
< h3 > Returns< / h3 >
< div class = "subelement response" > < code > array< / code > < / div >
< / div > < / div >
< / div >
2014-02-18 15:16:34 -05:00
< a id = "method_get_system_tables" > < / a > < div class = "element clickable method public method_get_system_tables" data-toggle = "collapse" data-target = ".method_get_system_tables .collapse" title = "public" >
2012-09-13 11:45:27 -04:00
< h2 > Retreives an array of non-user-created tables for
the connection/database< / h2 >
< pre > get_system_tables() < / pre >
< div class = "labels" > < / div >
2013-12-06 23:00:32 -05:00
< div class = "row collapse" > < div class = "detail-description" >
< div class = "long_description" > < / div >
2012-09-13 11:45:27 -04:00
< h3 > Returns< / h3 >
< div class = "subelement response" > < code > array< / code > < / div >
< / div > < / div >
< / div >
2014-02-18 15:16:34 -05:00
< a id = "method_get_tables" > < / a > < div class = "element clickable method public method_get_tables" data-toggle = "collapse" data-target = ".method_get_tables .collapse" title = "public" >
2012-09-13 11:45:27 -04:00
< h2 > Return list of tables for the current database< / h2 >
< pre > get_tables() < / pre >
< div class = "labels" > < / div >
2013-12-06 23:00:32 -05:00
< div class = "row collapse" > < div class = "detail-description" >
< div class = "long_description" > < / div >
2012-09-13 11:45:27 -04:00
< h3 > Returns< / h3 >
< div class = "subelement response" > < code > array< / code > < / div >
< / div > < / div >
< / div >
2014-02-18 15:16:34 -05:00
< a id = "method_get_triggers" > < / a > < div class = "element clickable method public method_get_triggers" data-toggle = "collapse" data-target = ".method_get_triggers .collapse" title = "public" >
2012-09-13 11:45:27 -04:00
< h2 > Return list of triggers for the current database< / h2 >
< pre > get_triggers() < / pre >
< div class = "labels" > < / div >
2013-12-06 23:00:32 -05:00
< div class = "row collapse" > < div class = "detail-description" >
< div class = "long_description" > < / div >
2012-09-13 11:45:27 -04:00
< h3 > Returns< / h3 >
< div class = "subelement response" > < code > array< / code > < / div >
< / div > < / div >
< / div >
2014-02-18 15:16:34 -05:00
< a id = "method_get_types" > < / a > < div class = "element clickable method public method_get_types" data-toggle = "collapse" data-target = ".method_get_types .collapse" title = "public" >
2012-09-13 11:45:27 -04:00
< h2 > Retrieve list of data types for the database< / h2 >
< pre > get_types() < / pre >
< div class = "labels" > < / div >
2013-12-06 23:00:32 -05:00
< div class = "row collapse" > < div class = "detail-description" >
< div class = "long_description" > < / div >
2012-09-13 11:45:27 -04:00
< h3 > Returns< / h3 >
< div class = "subelement response" > < code > array< / code > < / div >
< / div > < / div >
< / div >
2014-02-18 15:16:34 -05:00
< a id = "method_get_views" > < / a > < div class = "element clickable method public method_get_views" data-toggle = "collapse" data-target = ".method_get_views .collapse" title = "public" >
2012-09-13 11:45:27 -04:00
< h2 > Return list of views for the current database< / h2 >
< pre > get_views() < / pre >
< div class = "labels" > < / div >
2013-12-06 23:00:32 -05:00
< div class = "row collapse" > < div class = "detail-description" >
< div class = "long_description" > < / div >
2012-09-13 11:45:27 -04:00
< h3 > Returns< / h3 >
< div class = "subelement response" > < code > array< / code > < / div >
< / div > < / div >
< / div >
2014-02-18 15:16:34 -05:00
< a id = "method_insert_batch" > < / a > < div class = "element clickable method public method_insert_batch" data-toggle = "collapse" data-target = ".method_insert_batch .collapse" title = "public" >
2013-05-03 13:07:34 -04:00
< h2 > Create sql for batch insert< / h2 >
2014-02-18 15:16:34 -05:00
< pre > insert_batch(string < code > < / code > ) < / pre >
2013-05-03 13:07:34 -04:00
< div class = "labels" > < / div >
2013-12-06 23:00:32 -05:00
< div class = "row collapse" > < div class = "detail-description" >
< div class = "long_description" > < / div >
2013-05-03 13:07:34 -04:00
< h3 > Parameters< / h3 >
< div class = "subelement argument" >
< h4 > $table< / h4 >
< code > string< / code >
< / div >
< div class = "subelement argument" >
< h4 > $data< / h4 >
< code > array< / code >
< / div >
< h3 > Returns< / h3 >
< div class = "subelement response" > < code > string< / code > < / div >
< / div > < / div >
< / div >
2014-02-18 15:16:34 -05:00
< a id = "method_num_rows" > < / a > < div class = "element clickable method public method_num_rows" data-toggle = "collapse" data-target = ".method_num_rows .collapse" title = "public" >
2012-09-13 11:45:27 -04:00
< h2 > Return the number of rows returned for a SELECT query< / h2 >
< pre > num_rows() < / pre >
< div class = "labels" > < / div >
2013-12-06 23:00:32 -05:00
< div class = "row collapse" > < div class = "detail-description" >
< div class = "long_description" > < / div >
2012-10-30 12:14:57 -04:00
< table class = "table table-bordered" > < tr >
< th > see< / th >
2014-04-02 17:08:50 -04:00
< td > < a href = "%5CQuery%5CDriver%5Chttp://us3.php.net/manual/en/pdostatement.rowcount.php#87110" > < / a > < / td >
2012-10-30 12:14:57 -04:00
< / tr > < / table >
2012-09-13 11:45:27 -04:00
< h3 > Returns< / h3 >
< div class = "subelement response" > < code > int< / code > < / div >
< / div > < / div >
< / div >
2014-02-18 15:16:34 -05:00
< a id = "method_prepare_execute" > < / a > < div class = "element clickable method public method_prepare_execute" data-toggle = "collapse" data-target = ".method_prepare_execute .collapse" title = "public" >
2012-09-13 11:45:27 -04:00
< h2 > Create and execute a prepared statement with the provided parameters< / h2 >
2014-04-02 17:08:50 -04:00
< pre > prepare_execute(string < a href = "PDOStatement.html" > \Query\Driver\PDOStatement< / a > < / pre >
2012-09-13 11:45:27 -04:00
< div class = "labels" > < / div >
2013-12-06 23:00:32 -05:00
< div class = "row collapse" > < div class = "detail-description" >
< div class = "long_description" > < / div >
2012-09-13 11:45:27 -04:00
< h3 > Parameters< / h3 >
< div class = "subelement argument" >
< h4 > $sql< / h4 >
< code > string< / code >
< / div >
< div class = "subelement argument" >
< h4 > $params< / h4 >
< code > array< / code >
< / div >
< h3 > Returns< / h3 >
2014-04-02 17:08:50 -04:00
< div class = "subelement response" > < code > < a href = "PDOStatement.html" > \Query\Driver\PDOStatement< / a > < / code > < / div >
2012-09-13 11:45:27 -04:00
< / div > < / div >
< / div >
2014-02-18 15:16:34 -05:00
< a id = "method_prepare_query" > < / a > < div class = "element clickable method public method_prepare_query" data-toggle = "collapse" data-target = ".method_prepare_query .collapse" title = "public" >
2012-09-13 11:45:27 -04:00
< h2 > Simplifies prepared statements for database queries< / h2 >
2014-04-02 17:08:50 -04:00
< pre > prepare_query(string < a href = "PDOStatement.html" > \Query\Driver\PDOStatement< / a > < / pre >
2012-09-13 11:45:27 -04:00
< div class = "labels" > < / div >
2013-12-06 23:00:32 -05:00
< div class = "row collapse" > < div class = "detail-description" >
< div class = "long_description" > < / div >
2012-09-13 11:45:27 -04:00
< h3 > Parameters< / h3 >
< div class = "subelement argument" >
< h4 > $sql< / h4 >
< code > string< / code >
< / div >
< div class = "subelement argument" >
< h4 > $data< / h4 >
< code > array< / code >
< / div >
2014-02-14 10:38:25 -05:00
< h3 > Exceptions< / h3 >
< table class = "table table-bordered" > < tr >
2014-04-02 17:08:50 -04:00
< th > < code > < a href = "InvalidArgumentException.html" > \Query\Driver\InvalidArgumentException< / a > < / code > < / th >
2014-02-14 10:38:25 -05:00
< td > < / td >
< / tr > < / table >
2012-09-13 11:45:27 -04:00
< h3 > Returns< / h3 >
< div class = "subelement response" >
2014-04-02 17:08:50 -04:00
< code > < a href = "PDOStatement.html" > \Query\Driver\PDOStatement< / a > < / code > PDOStatement / FALSE< / div >
2012-09-13 11:45:27 -04:00
< / div > < / div >
< / div >
2014-02-18 15:16:34 -05: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" >
2012-09-13 11:45:27 -04:00
< h2 > Surrounds the string with the databases identifier escape characters< / h2 >
< pre > quote_ident(mixed < / pre >
< div class = "labels" > < / div >
2013-12-06 23:00:32 -05:00
< div class = "row collapse" > < div class = "detail-description" >
< div class = "long_description" > < / div >
2012-09-13 11:45:27 -04:00
< h3 > Parameters< / h3 >
< div class = "subelement argument" >
< h4 > $ident< / h4 >
< code > mixed< / code >
< / div >
< h3 > Returns< / h3 >
< div class = "subelement response" > < code > string< / code > < / div >
< / div > < / div >
< / div >
2014-02-18 15:16:34 -05:00
< 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" >
2012-11-07 08:57:29 -05:00
< h2 > Quote database table name, and set prefix< / h2 >
2012-11-08 14:31:25 -05:00
< pre > quote_table(string < / pre >
2012-11-07 08:57:29 -05:00
< div class = "labels" > < / div >
2013-12-06 23:00:32 -05:00
< div class = "row collapse" > < div class = "detail-description" >
< div class = "long_description" > < / div >
2012-11-07 08:57:29 -05:00
< h3 > Parameters< / h3 >
< div class = "subelement argument" >
< h4 > $table< / h4 >
2012-11-08 14:31:25 -05:00
< code > string< / code >
2012-11-07 08:57:29 -05:00
< / div >
< h3 > Returns< / h3 >
< div class = "subelement response" > < code > string< / code > < / div >
< / div > < / div >
< / div >
2014-02-18 15:16:34 -05:00
< a id = "method_truncate" > < / a > < div class = "element clickable method public method_truncate" data-toggle = "collapse" data-target = ".method_truncate .collapse" title = "public" >
2012-09-13 11:45:27 -04:00
< h2 > Empty the passed table< / h2 >
< pre > truncate(string < / pre >
< div class = "labels" > < / div >
2013-12-06 23:00:32 -05:00
< div class = "row collapse" > < div class = "detail-description" >
< div class = "long_description" > < / div >
2012-09-13 11:45:27 -04:00
< h3 > Parameters< / h3 >
< div class = "subelement argument" >
< h4 > $table< / h4 >
< code > string< / code >
< / div >
< / div > < / div >
< / div >
2014-02-18 15:16:34 -05:00
< a id = "method__prefix" > < / a > < div class = "element clickable method protected method__prefix" data-toggle = "collapse" data-target = ".method__prefix .collapse" title = "protected" >
2012-11-07 08:57:29 -05:00
< h2 > Sets the table prefix on the passed string< / h2 >
< pre > _prefix(string < / pre >
< div class = "labels" > < / div >
2013-12-06 23:00:32 -05:00
< div class = "row collapse" > < div class = "detail-description" >
< div class = "long_description" > < / div >
2012-11-07 08:57:29 -05:00
< h3 > Parameters< / h3 >
< div class = "subelement argument" >
< h4 > $str< / h4 >
< code > string< / code >
< / div >
< h3 > Returns< / h3 >
< div class = "subelement response" > < code > string< / code > < / div >
< / div > < / div >
< / div >
2012-09-13 11:45:27 -04:00
< h3 >
2014-02-18 15:16:34 -05:00
< i title = "Properties" class = "icon-custom icon-property" > < / i > < / h3 >
< a id = "property_last_query" > < / a > < div class = "element clickable property public property_last_query" data-toggle = "collapse" data-target = ".property_last_query .collapse" title = "public" >
2014-03-31 16:01:58 -04:00
< h2 > Last query executed< / h2 >
< pre > $last_query < / pre >
2014-02-18 15:16:34 -05:00
< div class = "row collapse" > < div class = "detail-description" >
< h3 > Default< / h3 >
< div class = "subelement argument" > < / div >
< / div > < / div >
2012-10-30 12:14:57 -04:00
< div class = "labels" > < / div >
2013-12-06 23:00:32 -05:00
< div class = "row collapse" > < div class = "detail-description" > < div class = "long_description" > < / div > < / div > < / div >
2012-10-30 12:14:57 -04:00
< / div >
2014-02-18 15:16:34 -05:00
< a id = "property_sql" > < / a > < div class = "element clickable property public property_sql" data-toggle = "collapse" data-target = ".property_sql .collapse" title = "public" >
2014-03-31 16:01:58 -04:00
< h2 > Reference to sql class< / h2 >
2014-04-02 17:08:50 -04:00
< pre > $sql < a href = "../classes/Query.Driver.SQL_Interface.html" > \Query\Driver\SQL_Interface< / a > < / pre >
2014-02-18 15:16:34 -05:00
< div class = "row collapse" > < div class = "detail-description" >
< h3 > Default< / h3 >
< div class = "subelement argument" > < / div >
< / div > < / div >
2012-11-07 08:57:29 -05:00
< div class = "labels" > < / div >
2013-12-06 23:00:32 -05:00
< div class = "row collapse" > < div class = "detail-description" > < div class = "long_description" > < / div > < / div > < / div >
2012-11-07 08:57:29 -05:00
< / div >
2014-02-18 15:16:34 -05:00
< a id = "property_table_prefix" > < / a > < div class = "element clickable property public property_table_prefix" data-toggle = "collapse" data-target = ".property_table_prefix .collapse" title = "public" >
2014-03-31 16:01:58 -04:00
< h2 > Prefix to apply to table names< / h2 >
< pre > $table_prefix < / pre >
2014-02-18 15:16:34 -05:00
< div class = "row collapse" > < div class = "detail-description" >
< h3 > Default< / h3 >
< div class = "subelement argument" > < code > ''< / code > < / div >
< / div > < / div >
2012-09-13 11:45:27 -04:00
< div class = "labels" > < / div >
2013-12-06 23:00:32 -05:00
< div class = "row collapse" > < div class = "detail-description" > < div class = "long_description" > < / div > < / div > < / div >
2012-09-13 11:45:27 -04:00
< / div >
2014-02-18 15:16:34 -05:00
< a id = "property_util" > < / a > < div class = "element clickable property public property_util" data-toggle = "collapse" data-target = ".property_util .collapse" title = "public" >
2014-03-31 16:01:58 -04:00
< h2 > Reference to util class< / h2 >
2014-04-02 17:08:50 -04:00
< pre > $util < a href = "../classes/Query.Driver.DB_Util.html" > \Query\Driver\DB_Util< / a > < / pre >
2014-02-18 15:16:34 -05:00
< div class = "row collapse" > < div class = "detail-description" >
< h3 > Default< / h3 >
< div class = "subelement argument" > < / div >
< / div > < / div >
2012-09-13 11:45:27 -04:00
< div class = "labels" > < / div >
2013-12-06 23:00:32 -05:00
< div class = "row collapse" > < div class = "detail-description" > < div class = "long_description" > < / div > < / div > < / div >
2012-09-13 11:45:27 -04:00
< / div >
2014-02-18 15:16:34 -05:00
< a id = "property_escape_char" > < / a > < div class = "element clickable property protected property_escape_char" data-toggle = "collapse" data-target = ".property_escape_char .collapse" title = "protected" >
2014-03-31 16:01:58 -04:00
< h2 > Character to escape indentifiers< / h2 >
< pre > $escape_char < / pre >
2014-02-18 15:16:34 -05:00
< div class = "row collapse" > < div class = "detail-description" >
< h3 > Default< / h3 >
< div class = "subelement argument" > < code > '"'< / code > < / div >
< / div > < / div >
2012-09-13 11:45:27 -04:00
< div class = "labels" > < / div >
2013-12-06 23:00:32 -05:00
< div class = "row collapse" > < div class = "detail-description" > < div class = "long_description" > < / div > < / div > < / div >
2012-09-13 11:45:27 -04:00
< / div >
2014-02-18 15:16:34 -05:00
< a id = "property_statement" > < / a > < div class = "element clickable property protected property_statement" data-toggle = "collapse" data-target = ".property_statement .collapse" title = "protected" >
2014-03-31 16:01:58 -04:00
< h2 > Reference to the last executed query< / h2 >
2014-04-02 17:08:50 -04:00
< pre > $statement < a href = "PDOStatement.html" > \Query\Driver\PDOStatement< / a > < / pre >
2014-02-18 15:16:34 -05:00
< div class = "row collapse" > < div class = "detail-description" >
< h3 > Default< / h3 >
< div class = "subelement argument" > < / div >
< / div > < / div >
2012-09-13 11:45:27 -04:00
< div class = "labels" > < / div >
2013-12-06 23:00:32 -05:00
< div class = "row collapse" > < div class = "detail-description" > < div class = "long_description" > < / div > < / div > < / div >
2012-09-13 11:45:27 -04:00
< / 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 >
2014-02-18 15:16:34 -05:00
Documentation is powered by < a href = "http://www.phpdoc.org/" > phpDocumentor 2.2.0
2013-12-06 23:00:32 -05:00
< / a > and< br >
2014-04-02 17:09:34 -04:00
generated on 2014-04-02T17:09:12-04:00.< br > < / footer > < / div >
2012-09-13 11:45:27 -04:00
< / div >
< / body >
< / html >
