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" >
< title > Query » \Firebird< / 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 > 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" >
< span 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 > < / span > < 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 >
< ul class = "side-nav nav nav-list" >
< li class = "nav-header" >
2013-12-06 23:00:32 -05:00
< i class = "icon-custom icon-method" > < / i >
< ul >
< li class = "method public " > < a href = "#method___construct" title = "__construct() :: Open the link to the database" > < span class = "description" > Open the link to the database< / span > < pre > __construct()< / pre > < / a > < / li >
< li class = "method public " > < a href = "#method_beginTransaction" title = "beginTransaction() :: Start a database transaction" > < span class = "description" > Start a database transaction< / span > < pre > beginTransaction()< / pre > < / a > < / li >
< li class = "method public " > < a href = "#method_commit" title = "commit() :: Commit a database transaction" > < span class = "description" > Commit a database transaction< / span > < pre > commit()< / pre > < / a > < / li >
< li class = "method public " > < a href = "#method_errorCode" title = "errorCode() :: Method to emulate PDO->errorCode" > < span class = "description" > Method to emulate PDO-> errorCode< / span > < pre > errorCode()< / pre > < / a > < / li >
< li class = "method public " > < a href = "#method_errorInfo" title = "errorInfo() :: Method to emulate PDO->errorInfo / PDOStatement->errorInfo" > < span class = "description" > Method to emulate PDO-> errorInfo / PDOStatement-> errorInfo< / span > < pre > errorInfo()< / 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_prepare" title = "prepare() :: Emulate PDO prepare" > < span class = "description" > Emulate PDO prepare< / span > < pre > prepare()< / pre > < / a > < / li >
< li class = "method public " > < a href = "#method_prepare_execute" title = "prepare_execute() :: Prepare and execute a query" > < span class = "description" > Prepare and execute a query< / span > < pre > prepare_execute()< / pre > < / a > < / li >
< li class = "method public " > < a href = "#method_prepare_query" title = "prepare_query() :: Bind a prepared query with arguments for executing" > < span class = "description" > Bind a prepared query with arguments for executing< / span > < pre > prepare_query()< / pre > < / a > < / li >
< li class = "method public " > < a href = "#method_query" title = "query() :: Wrapper public function to better match PDO" > < span class = "description" > Wrapper public function to better match PDO< / span > < pre > query()< / pre > < / a > < / li >
< li class = "method public " > < a href = "#method_quote" title = "quote() :: Method to emulate PDO->quote" > < span class = "description" > Method to emulate PDO-> quote< / span > < pre > quote()< / pre > < / a > < / li >
< li class = "method public " > < a href = "#method_rollBack" title = "rollBack() :: Rollback a transaction" > < span class = "description" > Rollback a transaction< / span > < pre > rollBack()< / pre > < / a > < / li >
< li class = "method public " > < a href = "#method_truncate" title = "truncate() :: Empty a database table" > < span class = "description" > Empty a database table< / span > < pre > truncate()< / pre > < / a > < / li >
< / ul >
< / li >
2012-09-13 11:45:27 -04:00
< li class = "nav-header" >
2013-12-06 23:00:32 -05:00
< i class = "icon-custom icon-property" > < / i >
< ul > < / ul >
< / li >
< li class = "nav-header protected" > » Protected
< ul >
< li class = "property protected " > < a href = "#property_conn" title = "$conn() :: Reference to the connection resource" > < span class = "description" > < / span > < pre > $conn< / pre > < / a > < / li >
< li class = "property protected " > < a href = "#property_statement" title = "$statement() :: Reference to the last query executed" > < span class = "description" > < / span > < pre > $statement< / pre > < / a > < / li >
< li class = "property protected " > < a href = "#property_statement_link" title = "$statement_link() :: Reference to the resource returned by
the last query executed">< span class = "description" > < / span > < pre > $statement_link< / pre > < / a > < / li >
< li class = "property protected " > < a href = "#property_trans" title = "$trans() :: Reference to the current transaction" > < span class = "description" > < / span > < pre > $trans< / pre > < / a > < / li >
< / ul >
< / li >
2012-09-13 11:45:27 -04:00
< / ul >
< / div >
< div class = "span8" >
2013-12-06 23:00:32 -05:00
< a id = "\Firebird" > < / a > < ul class = "breadcrumb" >
< li >
< a href = "../index.html" > < i class = "icon-custom icon-class" > < / i > < / a > < span class = "divider" > \< / span >
< / li >
< li class = "active" >
< span class = "divider" > \< / span > < a href = "../classes/Firebird.html" > Firebird< / a >
< / li >
< / ul >
< div class = "element class" >
2012-09-13 11:45:27 -04:00
< p class = "short_description" > Firebird Database class< / p >
< div class = "details" >
2013-12-06 23:00:32 -05:00
< div class = "long_description" > PDO-firebird isn't stable, so this is a wrapper of the fbird_ public functions.< / div >
2012-09-13 11:45:27 -04:00
< table class = "table table-bordered" >
< tr >
< th > package< / th >
2013-12-06 23:00:32 -05:00
< td > < a href = "../packages/Query.Drivers.html" > Query< / a > < / td >
2012-09-13 11:45:27 -04:00
< / tr >
< tr >
< th > subpackage< / th >
< td > Drivers< / td >
< / tr >
< / table >
< h3 >
< i class = "icon-custom icon-method" > < / i > < / h3 >
2013-12-06 23:00:32 -05:00
< a id = "method___construct" > < / a > < div class = "element clickable method public method___construct" data-toggle = "collapse" data-target = ".method___construct .collapse" >
2012-09-13 11:45:27 -04:00
< h2 > Open the link to the database< / h2 >
< pre > __construct(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 > $dbpath< / h4 >
< code > string< / code >
< / div >
< div class = "subelement argument" >
< h4 > $user< / h4 >
< code > string< / code >
< / div >
< div class = "subelement argument" >
< h4 > $pass< / h4 >
< code > string< / code >
< / div >
< / div > < / div >
< / div >
2013-12-06 23:00:32 -05:00
< a id = "method_beginTransaction" > < / a > < div class = "element clickable method public method_beginTransaction" data-toggle = "collapse" data-target = ".method_beginTransaction .collapse" >
2012-09-13 11:45:27 -04:00
< h2 > Start a database transaction< / h2 >
< pre > beginTransaction() < / 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 > bool< / code > < / div >
< / div > < / div >
< / div >
2013-12-06 23:00:32 -05:00
< a id = "method_commit" > < / a > < div class = "element clickable method public method_commit" data-toggle = "collapse" data-target = ".method_commit .collapse" >
2012-09-13 11:45:27 -04:00
< h2 > Commit a database transaction< / h2 >
< pre > commit() < / 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 > bool< / code > < / div >
< / div > < / div >
< / div >
2013-12-06 23:00:32 -05:00
< a id = "method_errorCode" > < / a > < div class = "element clickable method public method_errorCode" data-toggle = "collapse" data-target = ".method_errorCode .collapse" >
2012-09-13 11:45:27 -04:00
< h2 > Method to emulate PDO-> errorCode< / h2 >
< pre > errorCode() < / 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 >
2013-12-06 23:00:32 -05:00
< a id = "method_errorInfo" > < / a > < div class = "element clickable method public method_errorInfo" data-toggle = "collapse" data-target = ".method_errorInfo .collapse" >
2012-09-13 11:45:27 -04:00
< h2 > Method to emulate PDO-> errorInfo / PDOStatement-> errorInfo< / h2 >
< pre > errorInfo() < / 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 >
2013-12-06 23:00:32 -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" >
2013-05-03 13:07:34 -04:00
< h2 > Create sql for batch insert< / h2 >
< pre > insert_batch(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 >
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 >
2013-12-06 23:00:32 -05:00
< a id = "method_prepare" > < / a > < div class = "element clickable method public method_prepare" data-toggle = "collapse" data-target = ".method_prepare .collapse" >
2012-09-13 11:45:27 -04:00
< h2 > Emulate PDO prepare< / h2 >
2013-12-06 23:00:32 -05:00
< pre > prepare(string < / 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
< table class = "table table-bordered" > < tr >
< th > fluent< / th >
< td > This method is part of a fluent interface and will return the same instance< / td >
< / tr > < / table >
< h3 > Parameters< / h3 >
< div class = "subelement argument" >
< h4 > $query< / h4 >
< code > string< / code >
< / div >
< div class = "subelement argument" >
< h4 > $options< / h4 >
< code > array< / code >
< / div >
< h3 > Returns< / h3 >
2013-12-06 23:00:32 -05:00
< div class = "subelement response" > < code > \Firebird< / code > < / div >
2012-09-13 11:45:27 -04:00
< / div > < / div >
< / div >
2013-12-06 23:00:32 -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" >
2012-09-13 11:45:27 -04:00
< h2 > Prepare and execute a query< / h2 >
< pre > prepare_execute(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 > $sql< / h4 >
< code > string< / code >
< / div >
< div class = "subelement argument" >
< h4 > $args< / h4 >
< code > array< / code >
< / div >
< h3 > Returns< / h3 >
< div class = "subelement response" > < code > resource< / code > < / div >
< / div > < / div >
< / div >
2013-12-06 23:00:32 -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" >
2012-09-13 11:45:27 -04:00
< h2 > Bind a prepared query with arguments for executing< / h2 >
2013-05-01 15:59:23 -04:00
< pre > prepare_query(string < / 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 >
2013-05-01 15:59:23 -04:00
< div class = "subelement response" > < code > NULL< / code > < / div >
2012-09-13 11:45:27 -04:00
< / div > < / div >
< / div >
2013-12-06 23:00:32 -05:00
< a id = "method_query" > < / a > < div class = "element clickable method public method_query" data-toggle = "collapse" data-target = ".method_query .collapse" >
2012-09-13 11:45:27 -04:00
< h2 > Wrapper public function to better match PDO< / h2 >
2013-12-06 23:00:32 -05:00
< pre > query(string < / 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
< table class = "table table-bordered" > < tr >
< th > fluent< / th >
< td > This method is part of a fluent interface and will return the same instance< / td >
< / tr > < / table >
< h3 > Parameters< / h3 >
< div class = "subelement argument" >
< h4 > $sql< / h4 >
< code > string< / code >
< / div >
< h3 > Returns< / h3 >
2013-12-06 23:00:32 -05:00
< div class = "subelement response" > < code > \Firebird< / code > < / div >
2012-09-13 11:45:27 -04:00
< / div > < / div >
< / div >
2013-12-06 23:00:32 -05:00
< a id = "method_quote" > < / a > < div class = "element clickable method public method_quote" data-toggle = "collapse" data-target = ".method_quote .collapse" >
2012-09-13 11:45:27 -04:00
< h2 > Method to emulate PDO-> quote< / h2 >
< pre > quote(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 > $str< / h4 >
< code > string< / code >
< / div >
< div class = "subelement argument" >
< h4 > $param_type< / h4 >
< code > int< / code >
< / div >
< h3 > Returns< / h3 >
< div class = "subelement response" > < code > string< / code > < / div >
< / div > < / div >
< / div >
2013-12-06 23:00:32 -05:00
< a id = "method_rollBack" > < / a > < div class = "element clickable method public method_rollBack" data-toggle = "collapse" data-target = ".method_rollBack .collapse" >
2012-09-13 11:45:27 -04:00
< h2 > Rollback a transaction< / h2 >
< pre > rollBack() < / 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 > bool< / code > < / div >
< / div > < / div >
< / div >
2013-12-06 23:00:32 -05:00
< a id = "method_truncate" > < / a > < div class = "element clickable method public method_truncate" data-toggle = "collapse" data-target = ".method_truncate .collapse" >
2012-09-13 11:45:27 -04:00
< h2 > Empty a database table< / h2 >
2013-12-06 23:00:32 -05:00
< pre > truncate(string < / 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 > $table< / h4 >
< code > string< / code >
< / div >
< / div > < / div >
< / div >
< h3 >
< i class = "icon-custom icon-property" > < / i > < / h3 >
2013-12-06 23:00:32 -05:00
< a id = "property_conn" > < / a > < div class = "element clickable property protected property_conn" data-toggle = "collapse" data-target = ".property_conn .collapse" >
2012-09-13 11:45:27 -04:00
< h2 > Reference to the connection resource< / h2 >
< pre > $conn < / 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 > < / div > < / div >
2012-09-13 11:45:27 -04:00
< / div >
2013-12-06 23:00:32 -05:00
< a id = "property_statement" > < / a > < div class = "element clickable property protected property_statement" data-toggle = "collapse" data-target = ".property_statement .collapse" >
2012-09-13 11:45:27 -04:00
< h2 > Reference to the last query executed< / h2 >
< pre > $statement < / 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 > < / div > < / div >
2012-09-13 11:45:27 -04:00
< / div >
2013-12-06 23:00:32 -05:00
< a id = "property_statement_link" > < / a > < div class = "element clickable property protected property_statement_link" data-toggle = "collapse" data-target = ".property_statement_link .collapse" >
2012-09-13 11:45:27 -04:00
< h2 > Reference to the resource returned by
the last query executed< / h2 >
< pre > $statement_link < / 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 > < / div > < / div >
2012-09-13 11:45:27 -04:00
< / div >
2013-12-06 23:00:32 -05:00
< a id = "property_trans" > < / a > < div class = "element clickable property protected property_trans" data-toggle = "collapse" data-target = ".property_trans .collapse" >
2012-09-13 11:45:27 -04:00
< h2 > Reference to the current transaction< / h2 >
< pre > $trans < / 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 > < / 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 >
2013-12-06 23:00:32 -05:00
Documentation is powered by < a href = "http://www.phpdoc.org/" > phpDocumentor 2.1.0
< / a > and< br >
2013-12-09 19:46:34 -05:00
generated on 2013-12-09T19:45:45-05:00.< br > < / footer > < / div >
2012-09-13 11:45:27 -04:00
< / div >
< / body >
< / html >
