From 467c28f05e3e6117baf85be0e22dda4984c535c1 Mon Sep 17 00:00:00 2001 From: Timothy Warren Date: Wed, 6 Jun 2012 16:55:34 -0400 Subject: [PATCH] Update docs --- docs/classes.svg | 393 +- docs/classes/DB_PDO.html | 714 ++++ docs/classes/DB_SQL.html | 306 ++ docs/classes/DB_Util.html | 217 + docs/classes/Firebird.html | 876 ++++ docs/classes/Firebird_Result.html | 512 +++ docs/classes/Firebird_SQL.html | 316 ++ docs/classes/Firebird_Util.html | 220 + docs/classes/MySQL.html | 912 +++++ docs/classes/MySQL_SQL.html | 321 ++ docs/classes/MySQL_Util.html | 216 + docs/classes/ODBC.html | 914 +++++ docs/classes/ODBC_SQL.html | 316 ++ docs/classes/ODBC_Util.html | 211 + docs/classes/PgSQL.html | 914 +++++ docs/classes/PgSQL_SQL.html | 316 ++ docs/classes/PgSQL_Util.html | 216 + docs/classes/Query_Builder.html | 1230 ++++++ docs/classes/SQLite.html | 929 +++++ docs/classes/SQLite_SQL.html | 316 ++ docs/classes/SQLite_Util.html | 216 + docs/classes/miniMVC.Controller.html | 7 +- docs/classes/miniMVC.DB.html | 1474 ++++++- docs/classes/miniMVC.Data_Store.html | 7 +- docs/classes/miniMVC.MM.html | 7 +- docs/classes/miniMVC.Model.html | 7 +- docs/classes/miniMVC.Output.html | 7 +- docs/classes/miniMVC.Page.html | 7 +- docs/classes/miniMVC.Session.html | 7 +- docs/classes/miniMVC.miniMVC.html | 7 +- docs/deprecated.html | 7 +- docs/errors.html | 28 +- docs/graph_class.html | 7 +- docs/index.html | 13 +- docs/markers.html | 109 +- docs/namespaces/default.html | 290 ++ docs/namespaces/miniMVC.html | 25 +- docs/packages/.html | 7 +- docs/packages/Default.html | 21 +- docs/packages/Query.Drivers.html | 219 + docs/packages/Query.Query.html | 123 + docs/packages/Query.html | 310 ++ docs/packages/miniMVC.Libraries.html | 9 +- docs/packages/miniMVC.System.html | 7 +- docs/packages/miniMVC.html | 28 +- docs/structure.xml | 5525 +++++++++++++++++++++++++- phpdoc.dist.xml | 4 +- sys/db | 2 +- 48 files changed, 18488 insertions(+), 357 deletions(-) create mode 100644 docs/classes/DB_PDO.html create mode 100644 docs/classes/DB_SQL.html create mode 100644 docs/classes/DB_Util.html create mode 100644 docs/classes/Firebird.html create mode 100644 docs/classes/Firebird_Result.html create mode 100644 docs/classes/Firebird_SQL.html create mode 100644 docs/classes/Firebird_Util.html create mode 100644 docs/classes/MySQL.html create mode 100644 docs/classes/MySQL_SQL.html create mode 100644 docs/classes/MySQL_Util.html create mode 100644 docs/classes/ODBC.html create mode 100644 docs/classes/ODBC_SQL.html create mode 100644 docs/classes/ODBC_Util.html create mode 100644 docs/classes/PgSQL.html create mode 100644 docs/classes/PgSQL_SQL.html create mode 100644 docs/classes/PgSQL_Util.html create mode 100644 docs/classes/Query_Builder.html create mode 100644 docs/classes/SQLite.html create mode 100644 docs/classes/SQLite_SQL.html create mode 100644 docs/classes/SQLite_Util.html create mode 100644 docs/namespaces/default.html create mode 100644 docs/packages/Query.Drivers.html create mode 100644 docs/packages/Query.Query.html create mode 100644 docs/packages/Query.html diff --git a/docs/classes.svg b/docs/classes.svg index d8a52ec..0e13a25 100644 --- a/docs/classes.svg +++ b/docs/classes.svg @@ -4,128 +4,371 @@ - - + + G - -cluster_miniMVC - - - - - - - - -miniMVC + +cluster_default + + + + + + + + + +cluster_miniMVC + + + + + + + + +miniMVC + + +\\DB_SQL + + +«abstract» +DB_SQL + + + +\\DB_PDO + + +«abstract» +DB_PDO + + + +\\PDO + +\PDO + + +\\DB_PDO->\\PDO + + + + +\\Query_Builder + + +Query_Builder + + + +\\DB_Util + + +«abstract» +DB_Util + + + +\\PgSQL_SQL + + +PgSQL_SQL + + + +\\PgSQL_SQL->\\DB_SQL + + + + +\\PgSQL_Util + + +PgSQL_Util + + + +\\PgSQL_Util->\\DB_Util + + + + +\\PgSQL + + +PgSQL + + + +\\PgSQL->\\DB_PDO + + + + +\\ODBC_Util + + +ODBC_Util + + + +\\ODBC_Util->\\DB_Util + + + + +\\ODBC_SQL + + +ODBC_SQL + + + +\\ODBC_SQL->\\DB_SQL + + + + +\\ODBC + + +ODBC + + + +\\ODBC->\\DB_PDO + + + + +\\MySQL_Util + + +MySQL_Util + + + +\\MySQL_Util->\\DB_Util + + + + +\\MySQL + + +MySQL + + + +\\MySQL->\\DB_PDO + + + + +\\MySQL_SQL + + +MySQL_SQL + + + +\\MySQL_SQL->\\DB_SQL + + + + +\\SQLite_Util + + +SQLite_Util + + + +\\SQLite_Util->\\DB_Util + + + + +\\SQLite + + +SQLite + + + +\\SQLite->\\DB_PDO + + + + +\\SQLite_SQL + + +SQLite_SQL + + + +\\SQLite_SQL->\\DB_SQL + + + + +\\Firebird_SQL + + +Firebird_SQL + + + +\\Firebird_SQL->\\DB_SQL + + + + +\\Firebird_Result + + +Firebird_Result + + + +\\PDOStatement + +\PDOStatement + + +\\Firebird_Result->\\PDOStatement + + + + +\\Firebird + + +Firebird + + + +\\Firebird->\\DB_PDO + + + + +\\Firebird_Util + + +Firebird_Util + + + +\\Firebird_Util->\\DB_Util + + -\\miniMVC\\Page +\\miniMVC\\Page - -Page + +Page -\\miniMVC\\Output +\\miniMVC\\Output - -Output + +Output -\\miniMVC\\Page->\\miniMVC\\Output - - +\\miniMVC\\Page->\\miniMVC\\Output + + -\\miniMVC\\Model +\\miniMVC\\Model - -Model + +Model -\\miniMVC\\miniMVC +\\miniMVC\\miniMVC - -miniMVC + +miniMVC -\\miniMVC\\Model->\\miniMVC\\miniMVC - - +\\miniMVC\\Model->\\miniMVC\\miniMVC + + -\\miniMVC\\Controller +\\miniMVC\\Controller - -Controller + +Controller -\\miniMVC\\Controller->\\miniMVC\\miniMVC - - +\\miniMVC\\Controller->\\miniMVC\\miniMVC + + -\\miniMVC\\DB +\\miniMVC\\DB - -DB + +DB - -\\Query_Builder - -\Query_Builder - -\\miniMVC\\DB->\\Query_Builder - - +\\miniMVC\\DB->\\Query_Builder + + -\\miniMVC\\MM +\\miniMVC\\MM - -MM + +MM -\\miniMVC\\miniMVC->\\miniMVC\\MM - - +\\miniMVC\\miniMVC->\\miniMVC\\MM + + -\\ArrayObject - -\ArrayObject +\\ArrayObject + +\ArrayObject -\\miniMVC\\MM->\\ArrayObject - - +\\miniMVC\\MM->\\ArrayObject + + -\\miniMVC\\Output->\\miniMVC\\MM - - - - -\\miniMVC\\Data_Store - - -Data_Store - +\\miniMVC\\Output->\\miniMVC\\MM + + -\\miniMVC\\Session - - -Session +\\miniMVC\\Session + + +Session + + + +\\miniMVC\\Data_Store + + +Data_Store diff --git a/docs/classes/DB_PDO.html b/docs/classes/DB_PDO.html new file mode 100644 index 0000000..3b29168 --- /dev/null +++ b/docs/classes/DB_PDO.html @@ -0,0 +1,714 @@ + + + + + +miniMVC » \DB_PDO + + + + + + + + + +
+
+miniMVC
+
+
Back to top  
+
+
+ +
+
+
+ +
+ +
+
+
+

Base Database class

+
+

Extends PDO to simplify cross-database issues

+ + + + + + + + + +
packageQuery
subpackageQuery
+

+ Methods

+
+

PDO constructor wrapper

+
__construct(string $dsn, string $username, string $password, array $driver_options) 
+
+
+

+

Parameters

+
+

$dsn

+string +
+
+

$username

+string +
+
+

$password

+string +
+
+

$driver_options

+array +
+
+
+
+

__sleep() +

+
__sleep() 
+
+
+

+ + + +
inherited_fromPDO::__sleep()
+
+
+
+

__wakeup() +

+
__wakeup() 
+
+
+

+ + + +
inherited_fromPDO::__wakeup()
+
+
+
+

Returns number of rows affected by an INSERT, UPDATE, DELETE type query

+
affected_rows(\PDOStatement $statement) : int
+
+
+

+

Parameters

+
+

$statement

+\PDOStatement +
+

Returns

+
int
+
+
+
+

beginTransaction() +

+
beginTransaction() 
+
+
+

+ + + +
inherited_fromPDO::beginTransaction()
+
+
+
+

commit() +

+
commit() 
+
+
+

+ + + +
inherited_fromPDO::commit()
+
+
+
+

Method to simplify retreiving db results for meta-data queries

+
driver_query(string $sql, bool $filtered_index) : mixed
+
+
+

+

Parameters

+
+

$sql

+string +
+
+

$filtered_index

+bool +
+

Returns

+
mixed
+
+
+
+

Deletes all the rows from a table. Does the same as the truncate +method if the database does not support 'TRUNCATE';

+
empty_table(string $table) : mixed
+
+
+

+

Parameters

+
+

$table

+string +
+

Returns

+
mixed
+
+
+
+

errorCode() +

+
errorCode() 
+
+
+

+ + + +
inherited_fromPDO::errorCode()
+
+
+
+

errorInfo() +

+
errorInfo() 
+
+
+

+ + + +
inherited_fromPDO::errorInfo()
+
+
+
+

exec() +

+
exec() 
+
+
+

+ + + +
inherited_fromPDO::exec()
+
+
+
+

getAttribute() +

+
getAttribute() 
+
+
+

+ + + +
inherited_fromPDO::getAttribute()
+
+
+
+

getAvailableDrivers() +

+
getAvailableDrivers() 
+
+
+

+ + + +
inherited_fromPDO::getAvailableDrivers()
+
+
+
+

Retrieve column information for the current database table

+
get_columns(string $table) : array
+
+
+

+

Parameters

+
+

$table

+string +
+

Returns

+
array
+
+
+
+

Return list of dbs for the current connection, if possible

+
get_dbs() : array
+
+
+

+

Returns

+
array
+
+
+
+

Return list of function for the current database

+
get_functions() : array
+
+
+

+

Returns

+
array
+
+
+
+

Return the last error for the current database connection

+
get_last_error() : string
+
+
+

+

Returns

+
string
+
+
+
+

Return list of stored procedures for the current database

+
get_procedures() : array
+
+
+

+

Returns

+
array
+
+
+
+

Retreives the data from a select query

+
get_query_data(\PDOStatement $statement) : array
+
+
+

+

Parameters

+
+

$statement

+\PDOStatement +
+

Returns

+
array
+
+
+
+

Return schemas for databases that list them

+
get_schemas() : array
+
+
+

+

Returns

+
array
+
+
+
+

Return list of sequences for the current database, if they exist

+
get_sequences() : array
+
+
+

+

Returns

+
array
+
+
+
+

Retreives an array of non-user-created tables for +the connection/database

+
get_system_tables() : array
+
+
+

+

Returns

+
array
+
+
+
+

Return list of tables for the current database

+
get_tables() : array
+
+
+

+

Returns

+
array
+
+
+
+

Return list of triggers for the current database

+
get_triggers() : array
+
+
+

+

Returns

+
array
+
+
+
+

Retrieve list of data types for the database

+
get_types() : array
+
+
+

+

Returns

+
array
+
+
+
+

Return list of views for the current database

+
get_views() : array
+
+
+

+

Returns

+
array
+
+
+
+

inTransaction() +

+
inTransaction() 
+
+
+

+ + + +
inherited_fromPDO::inTransaction()
+
+
+
+

lastInsertId() +

+
lastInsertId() 
+
+
+

+ + + +
inherited_fromPDO::lastInsertId()
+
+
+
+

Return the number of rows returned for a SELECT query

+
num_rows() : int
+
+
+

+

Returns

+
int
+
+
+
+

prepare() +

+
prepare() 
+
+
+

+ + + +
inherited_fromPDO::prepare()
+
+
+
+

Create and execute a prepared statement with the provided parameters

+
prepare_execute(string $sql, array $params) : \PDOStatement
+
+
+

+

Parameters

+
+

$sql

+string +
+
+

$params

+array +
+

Returns

+
\PDOStatement
+
+
+
+

Simplifies prepared statements for database queries

+
prepare_query(string $sql, array $data) : mixed
+
+
+

+

Parameters

+
+

$sql

+string +
+
+

$data

+array +
+

Returns

+
+mixedPDOStatement / FALSE
+
+
+
+

query() +

+
query() 
+
+
+

+ + + +
inherited_fromPDO::query()
+
+
+
+

quote() +

+
quote() 
+
+
+

+ + + +
inherited_fromPDO::quote()
+
+
+
+

Surrounds the string with the databases identifier escape characters

+
quote_ident(mixed $ident) : string
+
+
+

+

Parameters

+
+

$ident

+mixed +
+

Returns

+
string
+
+
+
+

rollBack() +

+
rollBack() 
+
+
+

+ + + +
inherited_fromPDO::rollBack()
+
+
+
+

setAttribute() +

+
setAttribute() 
+
+
+

+ + + +
inherited_fromPDO::setAttribute()
+
+
+
+

Connect to a different database

+
switch_db(string $name) : void
+
+
+

+

Parameters

+
+

$name

+string +
+
+
+
+

Empty the passed table

+
truncate(string $table) : void
+
+
+

+

Parameters

+
+

$table

+string +
+
+
+
+

Helper method for quote_ident

+
_quote(mixed $str) : mixed
+
+
+

+

Parameters

+
+

$str

+mixed +
+

Returns

+
mixed
+
+
+

+ Properties

+ 
+

Reference to sql sub class

+
$sql : Object
+
+

+
+ 
+

Reference to util sub class

+
$util : Object
+
+

+
+ 
+

Character to escape identifiers

+
$escape_char : string
+
+

+
+ 
+

Reference to the last executed query

+
$statement : mixed
+
+

+
+
+
+
+
+
+
+ + diff --git a/docs/classes/DB_SQL.html b/docs/classes/DB_SQL.html new file mode 100644 index 0000000..a32d3aa --- /dev/null +++ b/docs/classes/DB_SQL.html @@ -0,0 +1,306 @@ + + + + + +miniMVC » \DB_SQL + + + + + + + + + +
+
+miniMVC
+
+
Back to top  
+
+
+ +
+
+
+ +
+ +
+
+
+

Abstract parent for database manipulation subclasses

+
+

+ + + + + + + + + +
packageQuery
subpackageQuery
+

+ Methods

+
+

Get the 'average' keyword

+
avg() : string
+
+
+

+

Returns

+
string
+
+
+
+

Get information about the columns in the +specified table

+
column_list($table) : string
+
+
+

+

Parameters

+
+

$table

+

string

+

Returns

+
string
+
+
+
+

Returns sql to list other databases

+
db_list() : string
+
+
+

+

Returns

+
string
+
+
+
+

Get the 'distinct' keyword

+
distinct() : string
+
+
+

+

Returns

+
string
+
+
+
+

Return sql to list functions

+
function_list() : FALSE
+
+
+

+

Returns

+
FALSE
+
+
+
+

Get database specific sql for limit clause

+
limit(string $sql, int $limit, int $offset) : string
+
+
+

+ + + +
abstract
+

Parameters

+
+

$sql

+string +
+
+

$limit

+int +
+
+

$offset

+int +
+

Returns

+
string
+
+
+
+

Get the max keyword sql

+
max() : string
+
+
+

+

Returns

+
string
+
+
+
+

Get the min keyword sql

+
min() : string
+
+
+

+

Returns

+
string
+
+
+
+

Return sql to list stored procedures

+
procedure_list() : string
+
+
+

+

Returns

+
string
+
+
+
+

Get the sql for random ordering

+
random() : string
+
+
+

+ + + +
abstract
+

Returns

+
string
+
+
+
+

Return sql to list sequences

+
sequence_list() : string
+
+
+

+

Returns

+
string
+
+
+
+

Get the 'sum' keyword

+
sum() : string
+
+
+

+

Returns

+
string
+
+
+
+

Returns sql to list system tables

+
system_table_list() : string
+
+
+

+

Returns

+
string
+
+
+
+

Returns sql to list tables

+
table_list() : string
+
+
+

+

Returns

+
string
+
+
+
+

Returns sql to list triggers

+
trigger_list() : string
+
+
+

+

Returns

+
string
+
+
+
+

Return sql to list database field types

+
type_list() : mixed
+
+
+

+

Returns

+
mixed
+
+
+
+

Returns sql to list views

+
view_list() : string
+
+
+

+

Returns

+
string
+
+
+
+
+
+
+
+
+ + diff --git a/docs/classes/DB_Util.html b/docs/classes/DB_Util.html new file mode 100644 index 0000000..df27ad8 --- /dev/null +++ b/docs/classes/DB_Util.html @@ -0,0 +1,217 @@ + + + + + +miniMVC » \DB_Util + + + + + + + + + +
+
+miniMVC
+
+
Back to top  
+
+
+ +
+
+
+ +
+ +
+
+
+

Abstract class defining database / table creation methods

+
+

+ + + + + + + + + +
packageQuery
subpackageQuery
+

+ Methods

+
+

Enable calling driver methods

+
__call(string $method, array $args) 
+
+
+

+

Parameters

+
+

$method

+string +
+
+

$args

+array +
+
+
+
+

Save a reference to the connection object for later use

+
__construct(object $conn) 
+
+
+

+

Parameters

+
+

$conn

+object

&$conn

+
+
+
+
+

Return an SQL file with the database data as insert statements

+
backup_data() : string
+
+
+

+ + + +
abstract
+

Returns

+
string
+
+
+
+

Return an SQL file with the database table structure

+
backup_structure() : string
+
+
+

+ + + +
abstract
+

Returns

+
string
+
+
+
+

Get database-specific sql to create a new table

+
create_table(string $name, array $columns, array $constraints, array $indexes) : string
+
+
+

+ + + +
abstract
+

Parameters

+
+

$name

+string +
+
+

$columns

+array +
+
+

$constraints

+array +
+
+

$indexes

+array +
+

Returns

+
string
+
+
+
+

Get database-specific sql to drop a table

+
delete_table(string $name) : string
+
+
+

+ + + +
abstract
+

Parameters

+
+

$name

+string +
+

Returns

+
string
+
+
+

+ Properties

+ 
+

Reference to the current connection object

+
$conn 
+
+

+
+
+
+
+
+
+
+ + diff --git a/docs/classes/Firebird.html b/docs/classes/Firebird.html new file mode 100644 index 0000000..d318a4b --- /dev/null +++ b/docs/classes/Firebird.html @@ -0,0 +1,876 @@ + + + + + +miniMVC » \Firebird + + + + + + + + + +
+
+miniMVC
+
+
Back to top  
+
+
+ +
+
+
+ +
+ +
+
+
+

Firebird Database class

+
+

PDO-firebird isn't stable, so this is a wrapper of the fbird_ public functions.

+ + + + + + + + + +
packageQuery
subpackageDrivers
+

+ Methods

+
+

Open the link to the database

+
__construct(string $dbpath, string $user, string $pass) 
+
+
+

+

Parameters

+
+

$dbpath

+string +
+
+

$user

+string +
+
+

$pass

+string +
+
+
+
+

__sleep() +

+
__sleep() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::__sleep()
inherited_from\DB_PDO::__sleep()
+
+
+
+

__wakeup() +

+
__wakeup() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::__wakeup()
inherited_from\DB_PDO::__wakeup()
+
+
+
+

Returns number of rows affected by an INSERT, UPDATE, DELETE type query

+
affected_rows(\PDOStatement $statement) : int
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::affected_rows()
+

Parameters

+
+

$statement

+\PDOStatement +
+

Returns

+
int
+
+
+
+

Start a database transaction

+
beginTransaction() : bool
+
+
+

+

Returns

+
bool
+
+
+
+

Commit a database transaction

+
commit() : bool
+
+
+

+

Returns

+
bool
+
+
+
+

Method to simplify retreiving db results for meta-data queries

+
driver_query(string $sql, bool $filtered_index) : mixed
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::driver_query()
+

Parameters

+
+

$sql

+string +
+
+

$filtered_index

+bool +
+

Returns

+
mixed
+
+
+
+

Deletes all the rows from a table. Does the same as the truncate +method if the database does not support 'TRUNCATE';

+
empty_table(string $table) : mixed
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::empty_table()
+

Parameters

+
+

$table

+string +
+

Returns

+
mixed
+
+
+
+

Method to emulate PDO->errorCode

+
errorCode() : array
+
+
+

+

Returns

+
array
+
+
+
+

Method to emulate PDO->errorInfo / PDOStatement->errorInfo

+
errorInfo() : array
+
+
+

+

Returns

+
array
+
+
+
+

exec() +

+
exec() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::exec()
inherited_from\DB_PDO::exec()
+
+
+
+

getAttribute() +

+
getAttribute() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::getAttribute()
inherited_from\DB_PDO::getAttribute()
+
+
+
+

getAvailableDrivers() +

+
getAvailableDrivers() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::getAvailableDrivers()
inherited_from\DB_PDO::getAvailableDrivers()
+
+
+
+

Retrieve column information for the current database table

+
get_columns(string $table) : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_columns()
+

Parameters

+
+

$table

+string +
+

Returns

+
array
+
+
+
+

Return list of dbs for the current connection, if possible

+
get_dbs() : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_dbs()
+

Returns

+
array
+
+
+
+

Return list of function for the current database

+
get_functions() : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_functions()
+

Returns

+
array
+
+
+
+

Return the last error for the current database connection

+
get_last_error() : string
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_last_error()
+

Returns

+
string
+
+
+
+

Return list of stored procedures for the current database

+
get_procedures() : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_procedures()
+

Returns

+
array
+
+
+
+

Retreives the data from a select query

+
get_query_data(\PDOStatement $statement) : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_query_data()
+

Parameters

+
+

$statement

+\PDOStatement +
+

Returns

+
array
+
+
+
+

Return schemas for databases that list them

+
get_schemas() : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_schemas()
+

Returns

+
array
+
+
+
+

Return list of sequences for the current database, if they exist

+
get_sequences() : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_sequences()
+

Returns

+
array
+
+
+
+

Retreives an array of non-user-created tables for +the connection/database

+
get_system_tables() : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_system_tables()
+

Returns

+
array
+
+
+
+

Return list of tables for the current database

+
get_tables() : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_tables()
+

Returns

+
array
+
+
+
+

Return list of triggers for the current database

+
get_triggers() : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_triggers()
+

Returns

+
array
+
+
+
+

Retrieve list of data types for the database

+
get_types() : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_types()
+

Returns

+
array
+
+
+
+

Return list of views for the current database

+
get_views() : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_views()
+

Returns

+
array
+
+
+
+

inTransaction() +

+
inTransaction() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::inTransaction()
inherited_from\DB_PDO::inTransaction()
+
+
+
+

lastInsertId() +

+
lastInsertId() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::lastInsertId()
inherited_from\DB_PDO::lastInsertId()
+
+
+
+

Return the number of rows returned for a SELECT query

+
num_rows() : int
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::num_rows()
+

Returns

+
int
+
+
+
+

Emulate PDO prepare

+
prepare(string $query, array $options) : \Firebird
+
+
+

+ + + +
fluentThis method is part of a fluent interface and will return the same instance
+

Parameters

+
+

$query

+string +
+
+

$options

+array +
+

Returns

+
\Firebird
+
+
+
+

Prepare and execute a query

+
prepare_execute(string $sql, array $args) : resource
+
+
+

+

Parameters

+
+

$sql

+string +
+
+

$args

+array +
+

Returns

+
resource
+
+
+
+

Bind a prepared query with arguments for executing

+
prepare_query(string $sql, array $params) : FALSE
+
+
+

+

Parameters

+
+

$sql

+string +
+
+

$params

+array +
+

Returns

+
FALSE
+
+
+
+

Wrapper public function to better match PDO

+
query(string $sql) : \Firebird
+
+
+

+ + + +
fluentThis method is part of a fluent interface and will return the same instance
+

Parameters

+
+

$sql

+string +
+

Returns

+
\Firebird
+
+
+
+

Method to emulate PDO->quote

+
quote(string $str, int $param_type) : string
+
+
+

+

Parameters

+
+

$str

+string +
+
+

$param_type

+int +
+

Returns

+
string
+
+
+
+

Surrounds the string with the databases identifier escape characters

+
quote_ident(mixed $ident) : string
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::quote_ident()
+

Parameters

+
+

$ident

+mixed +
+

Returns

+
string
+
+
+
+

Rollback a transaction

+
rollBack() : bool
+
+
+

+

Returns

+
bool
+
+
+
+

setAttribute() +

+
setAttribute() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::setAttribute()
inherited_from\DB_PDO::setAttribute()
+
+
+
+

Doesn't apply to Firebird

+
switch_db(string $name) : FALSE
+
+
+

+

Parameters

+
+

$name

+string +
+

Returns

+
FALSE
+
+
+
+

Empty a database table

+
truncate(string $table) : void
+
+
+

+

Parameters

+
+

$table

+string +
+
+
+
+

Helper method for quote_ident

+
_quote(mixed $str) : mixed
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::_quote()
+

Parameters

+
+

$str

+mixed +
+

Returns

+
mixed
+
+
+

+ Properties

+ 
+

Reference to sql sub class

+
$sql : Object
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::$$sql
+
+
+ 
+

Reference to util sub class

+
$util : Object
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::$$util
+
+
+ 
+

Reference to the connection resource

+
$conn : resource
+
+

+
+ 
+

Character to escape identifiers

+
$escape_char : string
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::$$escape_char
+
+
+ 
+

Reference to the last query executed

+
$statement : object
+
+

+
+ 
+

Reference to the resource returned by +the last query executed

+
$statement_link : resource
+
+

+
+ 
+

Reference to the current transaction

+
$trans : resource
+
+

+
+
+
+
+
+
+
+ + diff --git a/docs/classes/Firebird_Result.html b/docs/classes/Firebird_Result.html new file mode 100644 index 0000000..217d472 --- /dev/null +++ b/docs/classes/Firebird_Result.html @@ -0,0 +1,512 @@ + + + + + +miniMVC » \Firebird_Result + + + + + + + + + +
+
+miniMVC
+
+
Back to top  
+
+
+ +
+
+
+ +
+ +
+
+
+

Firebird result class to emulate PDOStatement Class - only implements +data-fetching methods

+
+

+ + + + + + + + + +
packageQuery
subpackageDrivers
+

+ Methods

+
+

Create the object by passing the resource for +the query

+
__construct(resource $link) 
+
+
+

+

Parameters

+
+

$link

+resource +
+
+
+
+

__sleep() +

+
__sleep() 
+
+
+

+ + + +
inherited_fromPDOStatement::__sleep()
+
+
+
+

__wakeup() +

+
__wakeup() 
+
+
+

+ + + +
inherited_fromPDOStatement::__wakeup()
+
+
+
+

Invalidate method for data consistency

+
bindColumn(mixed $column, mixed $param, int $type, mixed $maxlen, array $driverdata) : FALSE
+
+
+

+

Parameters

+
+

$column

+mixed +
+
+

$param

+mixed

&$param

+
+
+

$type

+int +
+
+

$maxlen

+mixed +
+
+

$driverdata

+array +
+

Returns

+
FALSE
+
+
+
+

Invalidate method for data consistency

+
bindParam(mixed $parameter, mixed $variable, int $data_type, mixed $maxlen, array $driverdata) : FALSE
+
+
+

+

Parameters

+
+

$parameter

+mixed +
+
+

$variable

+mixed

&$variable

+
+
+

$data_type

+int +
+
+

$maxlen

+mixed +
+
+

$driverdata

+array +
+

Returns

+
FALSE
+
+
+
+

Invalidate method for data consistency

+
bindValue(mixed $parameter, mixed $variable, int $data_type) : FALSE
+
+
+

+

Parameters

+
+

$parameter

+mixed +
+
+

$variable

+mixed

&$variable

+
+
+

$data_type

+int +
+

Returns

+
FALSE
+
+
+
+

closeCursor() +

+
closeCursor() 
+
+
+

+ + + +
inherited_fromPDOStatement::closeCursor()
+
+
+
+

columnCount() +

+
columnCount() 
+
+
+

+ + + +
inherited_fromPDOStatement::columnCount()
+
+
+
+

debugDumpParams() +

+
debugDumpParams() 
+
+
+

+ + + +
inherited_fromPDOStatement::debugDumpParams()
+
+
+
+

Method to emulate PDOStatement->errorCode

+
errorCode() : string
+
+
+

+

Returns

+
string
+
+
+
+

Method to emulate PDO->errorInfo / PDOStatement->errorInfo

+
errorInfo() : array
+
+
+

+

Returns

+
array
+
+
+
+

Run a prepared statement query

+
execute(array $args) : bool
+
+
+

+

Parameters

+
+

$args

+array +
+

Returns

+
bool
+
+
+
+

Emulate PDO fetch public function

+
fetch(int $fetch_style, mixed $statement, mixed $offset) : mixed
+
+
+

+

Parameters

+
+

$fetch_style

+int +
+
+

$statement

+mixed +
+
+

$offset

+mixed +
+

Returns

+
mixed
+
+
+
+

Emulate PDO fetchAll public function

+
fetchAll(int $fetch_style, mixed $statement, mixed $ctor_args) : mixed
+
+
+

+

Parameters

+
+

$fetch_style

+int +
+
+

$statement

+mixed +
+
+

$ctor_args

+mixed +
+

Returns

+
mixed
+
+
+
+

Emulate PDOStatement::fetchColumn

+
fetchColumn(int $column_num) : mixed
+
+
+

+

Parameters

+
+

$column_num

+int +
+

Returns

+
mixed
+
+
+
+

Emulate PDOStatement::fetchObject, but only for the default use

+
fetchObject(string $class_name, array $ctor_args) : \stdClass
+
+
+

+

Parameters

+
+

$class_name

+string +
+
+

$ctor_args

+array +
+

Returns

+
\stdClass
+
+
+
+

getAttribute() +

+
getAttribute() 
+
+
+

+ + + +
inherited_fromPDOStatement::getAttribute()
+
+
+
+

getColumnMeta() +

+
getColumnMeta() 
+
+
+

+ + + +
inherited_fromPDOStatement::getColumnMeta()
+
+
+
+

nextRowset() +

+
nextRowset() 
+
+
+

+ + + +
inherited_fromPDOStatement::nextRowset()
+
+
+
+

Return the number of rows affected by the previous query

+
rowCount() : int
+
+
+

+

Returns

+
int
+
+
+
+

setAttribute() +

+
setAttribute() 
+
+
+

+ + + +
inherited_fromPDOStatement::setAttribute()
+
+
+
+

setFetchMode() +

+
setFetchMode() 
+
+
+

+ + + +
inherited_fromPDOStatement::setFetchMode()
+
+
+

+ Properties

+ 
+

Data pulled from query

+
$result 
+
+
+

+ + + +
param<p>mixed</p>
+
+
+ 
+

Current row in result array

+
$row : int
+
+

+
+ 
+

Reference to fbird resource

+
$statement : resource
+
+

+
+
+
+
+
+
+
+ + diff --git a/docs/classes/Firebird_SQL.html b/docs/classes/Firebird_SQL.html new file mode 100644 index 0000000..6e57232 --- /dev/null +++ b/docs/classes/Firebird_SQL.html @@ -0,0 +1,316 @@ + + + + + +miniMVC » \Firebird_SQL + + + + + + + + + +
+
+miniMVC
+
+
Back to top  
+
+
+ +
+
+
+ +
+ +
+
+
+

Firebird Specific SQL

+
+

+ + + + + + + + + +
packageQuery
subpackageDrivers
+

+ Methods

+
+

Get the 'average' keyword

+
avg() : string
+
Inherited
+
+

+ + + +
inherited_from\DB_SQL::avg()
+

Returns

+
string
+
+
+
+

Return sql to list columns of the specified table

+
column_list(string $table) : string
+
+
+

+

Parameters

+
+

$table

+string +
+

Returns

+
string
+
+
+
+

Returns sql to list other databases

+
db_list() : FALSE
+
+
+

+

Returns

+
FALSE
+
+
+
+

Get the 'distinct' keyword

+
distinct() : string
+
Inherited
+
+

+ + + +
inherited_from\DB_SQL::distinct()
+

Returns

+
string
+
+
+
+

Return sql to list functions

+
function_list() : string
+
+
+

+

Returns

+
string
+
+
+
+

Limit clause

+
limit(string $sql, int $limit, int $offset) : string
+
+
+

+

Parameters

+
+

$sql

+string +
+
+

$limit

+int +
+
+

$offset

+int +
+

Returns

+
string
+
+
+
+

Get the max keyword sql

+
max() : string
+
Inherited
+
+

+ + + +
inherited_from\DB_SQL::max()
+

Returns

+
string
+
+
+
+

Get the min keyword sql

+
min() : string
+
Inherited
+
+

+ + + +
inherited_from\DB_SQL::min()
+

Returns

+
string
+
+
+
+

Return sql to list stored procedures

+
procedure_list() : string
+
+
+

+

Returns

+
string
+
+
+
+

Random ordering keyword

+
random() : string
+
+
+

+

Returns

+
string
+
+
+
+

Return sql to list sequences

+
sequence_list() : string
+
+
+

+

Returns

+
string
+
+
+
+

Get the 'sum' keyword

+
sum() : string
+
Inherited
+
+

+ + + +
inherited_from\DB_SQL::sum()
+

Returns

+
string
+
+
+
+

Returns sql to list system tables

+
system_table_list() : string
+
+
+

+

Returns

+
string
+
+
+
+

Returns sql to list tables

+
table_list() : string
+
+
+

+

Returns

+
string
+
+
+
+

Returns sql to list triggers

+
trigger_list() : string
+
+
+

+

Returns

+
string
+
+
+
+

SQL to show list of field types

+
type_list() : string
+
+
+

+

Returns

+
string
+
+
+
+

Returns sql to list views

+
view_list() : string
+
+
+

+

Returns

+
string
+
+
+
+
+
+
+
+
+ + diff --git a/docs/classes/Firebird_Util.html b/docs/classes/Firebird_Util.html new file mode 100644 index 0000000..b8fe435 --- /dev/null +++ b/docs/classes/Firebird_Util.html @@ -0,0 +1,220 @@ + + + + + +miniMVC » \Firebird_Util + + + + + + + + + +
+
+miniMVC
+
+
Back to top  
+
+
+ +
+
+
+ +
+ +
+
+
+

Firebird-specific backup, import and creation methods

+
+

+ + + + + + + + + +
packageQuery
subpackageDrivers
+

+ Methods

+
+

Enable calling driver methods

+
__call(string $method, array $args) 
+
Inherited
+
+

+ + + +
inherited_from\DB_Util::__call()
+

Parameters

+
+

$method

+string +
+
+

$args

+array +
+
+
+
+

Save a reference to the current connection object

+
__construct(object $conn) : void
+
+
+

+

Parameters

+
+

$conn

+object

&$conn

+
+
+
+
+

Create an SQL backup file for the current database's data

+
backup_data(array $exclude, bool $system_tables) : string
+
+
+

+

Parameters

+
+

$exclude

+array +
+
+

$system_tables

+bool +
+

Returns

+
string
+
+
+
+

Create an SQL backup file for the current database's structure

+
backup_structure() : string
+
+
+

+

Returns

+
string
+
+
+
+

Convienience public function to generate sql for creating a db table

+
create_table(string $name, array $fields, array $constraints, array $indexes) : string
+
+
+

+

Parameters

+
+

$name

+string +
+
+

$fields

+array +
+
+

$constraints

+array +
+
+

$indexes

+array +
+

Returns

+
string
+
+
+
+

Drop the selected table

+
delete_table(string $name) : string
+
+
+

+

Parameters

+
+

$name

+string +
+

Returns

+
string
+
+
+

+ Properties

+ 
+

Reference to the current connection object

+
$conn 
+
Inherited
+
+

+ + + +
inherited_from\DB_Util::$$conn
+
+
+
+
+
+
+
+
+ + diff --git a/docs/classes/MySQL.html b/docs/classes/MySQL.html new file mode 100644 index 0000000..9ec1231 --- /dev/null +++ b/docs/classes/MySQL.html @@ -0,0 +1,912 @@ + + + + + +miniMVC » \MySQL + + + + + + + + + +
+
+miniMVC
+
+
Back to top  
+
+
+ +
+
+
+ +
+ +
+
+
+

MySQL specific class

+
+

Extends PDO to simplify cross-database issues

+ + + + + + + + + +
packageQuery
subpackageDrivers
+

+ Methods

+
+

Connect to MySQL Database

+
__construct(string $dsn, string $username, string $password, array $options) 
+
+
+

+

Parameters

+
+

$dsn

+string +
+
+

$username

+string +
+
+

$password

+string +
+
+

$options

+array +
+
+
+
+

__sleep() +

+
__sleep() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::__sleep()
inherited_from\DB_PDO::__sleep()
+
+
+
+

__wakeup() +

+
__wakeup() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::__wakeup()
inherited_from\DB_PDO::__wakeup()
+
+
+
+

Returns number of rows affected by an INSERT, UPDATE, DELETE type query

+
affected_rows(\PDOStatement $statement) : int
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::affected_rows()
+

Parameters

+
+

$statement

+\PDOStatement +
+

Returns

+
int
+
+
+
+

beginTransaction() +

+
beginTransaction() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::beginTransaction()
inherited_from\DB_PDO::beginTransaction()
+
+
+
+

commit() +

+
commit() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::commit()
inherited_from\DB_PDO::commit()
+
+
+
+

Method to simplify retreiving db results for meta-data queries

+
driver_query(string $sql, bool $filtered_index) : mixed
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::driver_query()
+

Parameters

+
+

$sql

+string +
+
+

$filtered_index

+bool +
+

Returns

+
mixed
+
+
+
+

Deletes all the rows from a table. Does the same as the truncate +method if the database does not support 'TRUNCATE';

+
empty_table(string $table) : mixed
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::empty_table()
+

Parameters

+
+

$table

+string +
+

Returns

+
mixed
+
+
+
+

errorCode() +

+
errorCode() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::errorCode()
inherited_from\DB_PDO::errorCode()
+
+
+
+

errorInfo() +

+
errorInfo() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::errorInfo()
inherited_from\DB_PDO::errorInfo()
+
+
+
+

exec() +

+
exec() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::exec()
inherited_from\DB_PDO::exec()
+
+
+
+

getAttribute() +

+
getAttribute() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::getAttribute()
inherited_from\DB_PDO::getAttribute()
+
+
+
+

getAvailableDrivers() +

+
getAvailableDrivers() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::getAvailableDrivers()
inherited_from\DB_PDO::getAvailableDrivers()
+
+
+
+

Retrieve column information for the current database table

+
get_columns(string $table) : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_columns()
+

Parameters

+
+

$table

+string +
+

Returns

+
array
+
+
+
+

Return list of dbs for the current connection, if possible

+
get_dbs() : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_dbs()
+

Returns

+
array
+
+
+
+

Return list of function for the current database

+
get_functions() : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_functions()
+

Returns

+
array
+
+
+
+

Return the last error for the current database connection

+
get_last_error() : string
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_last_error()
+

Returns

+
string
+
+
+
+

Return list of stored procedures for the current database

+
get_procedures() : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_procedures()
+

Returns

+
array
+
+
+
+

Retreives the data from a select query

+
get_query_data(\PDOStatement $statement) : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_query_data()
+

Parameters

+
+

$statement

+\PDOStatement +
+

Returns

+
array
+
+
+
+

Return schemas for databases that list them

+
get_schemas() : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_schemas()
+

Returns

+
array
+
+
+
+

Return list of sequences for the current database, if they exist

+
get_sequences() : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_sequences()
+

Returns

+
array
+
+
+
+

Retreives an array of non-user-created tables for +the connection/database

+
get_system_tables() : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_system_tables()
+

Returns

+
array
+
+
+
+

Return list of tables for the current database

+
get_tables() : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_tables()
+

Returns

+
array
+
+
+
+

Return list of triggers for the current database

+
get_triggers() : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_triggers()
+

Returns

+
array
+
+
+
+

Retrieve list of data types for the database

+
get_types() : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_types()
+

Returns

+
array
+
+
+
+

Return list of views for the current database

+
get_views() : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_views()
+

Returns

+
array
+
+
+
+

inTransaction() +

+
inTransaction() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::inTransaction()
inherited_from\DB_PDO::inTransaction()
+
+
+
+

lastInsertId() +

+
lastInsertId() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::lastInsertId()
inherited_from\DB_PDO::lastInsertId()
+
+
+
+

Return the number of rows returned for a SELECT query

+
num_rows() : int
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::num_rows()
+

Returns

+
int
+
+
+
+

prepare() +

+
prepare() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::prepare()
inherited_from\DB_PDO::prepare()
+
+
+
+

Create and execute a prepared statement with the provided parameters

+
prepare_execute(string $sql, array $params) : \PDOStatement
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::prepare_execute()
+

Parameters

+
+

$sql

+string +
+
+

$params

+array +
+

Returns

+
\PDOStatement
+
+
+
+

Simplifies prepared statements for database queries

+
prepare_query(string $sql, array $data) : mixed
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::prepare_query()
+

Parameters

+
+

$sql

+string +
+
+

$data

+array +
+

Returns

+
+mixedPDOStatement / FALSE
+
+
+
+

query() +

+
query() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::query()
inherited_from\DB_PDO::query()
+
+
+
+

quote() +

+
quote() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::quote()
inherited_from\DB_PDO::quote()
+
+
+
+

Surrounds the string with the databases identifier escape characters

+
quote_ident(mixed $ident) : string
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::quote_ident()
+

Parameters

+
+

$ident

+mixed +
+

Returns

+
string
+
+
+
+

rollBack() +

+
rollBack() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::rollBack()
inherited_from\DB_PDO::rollBack()
+
+
+
+

setAttribute() +

+
setAttribute() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::setAttribute()
inherited_from\DB_PDO::setAttribute()
+
+
+
+

Connect to a different database

+
switch_db(string $name) : void
+
+
+

+

Parameters

+
+

$name

+string +
+
+
+
+

Empty a table

+
truncate(string $table) : void
+
+
+

+

Parameters

+
+

$table

+string +
+
+
+
+

Helper method for quote_ident

+
_quote(mixed $str) : mixed
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::_quote()
+

Parameters

+
+

$str

+mixed +
+

Returns

+
mixed
+
+
+

+ Properties

+ 
+

Reference to sql sub class

+
$sql : Object
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::$$sql
+
+
+ 
+

Reference to util sub class

+
$util : Object
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::$$util
+
+
+ 
+

Set the backtick as the MySQL escape character

+
$escape_char : string
+
+

+
+ 
+

Reference to the last executed query

+
$statement : mixed
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::$$statement
+
+
+
+
+
+
+
+
+ + diff --git a/docs/classes/MySQL_SQL.html b/docs/classes/MySQL_SQL.html new file mode 100644 index 0000000..8f2b1f5 --- /dev/null +++ b/docs/classes/MySQL_SQL.html @@ -0,0 +1,321 @@ + + + + + +miniMVC » \MySQL_SQL + + + + + + + + + +
+
+miniMVC
+
+
Back to top  
+
+
+ +
+
+
+ +
+ +
+
+
+

MySQL specifc SQL

+
+

+ + + + + + + + + +
packageQuery
subpackageDrivers
+

+ Methods

+
+

Get the 'average' keyword

+
avg() : string
+
Inherited
+
+

+ + + +
inherited_from\DB_SQL::avg()
+

Returns

+
string
+
+
+
+

SQL to show infromation about columns in a table

+
column_list(string $table) : string
+
+
+

+

Parameters

+
+

$table

+string +
+

Returns

+
string
+
+
+
+

Returns sql to list other databases

+
db_list() : string
+
+
+

+

Returns

+
string
+
+
+
+

Get the 'distinct' keyword

+
distinct() : string
+
Inherited
+
+

+ + + +
inherited_from\DB_SQL::distinct()
+

Returns

+
string
+
+
+
+

Return sql to list functions

+
function_list() : string
+
+
+

+

Returns

+
string
+
+
+
+

Limit clause

+
limit(string $sql, int $limit, int $offset) : string
+
+
+

+

Parameters

+
+

$sql

+string +
+
+

$limit

+int +
+
+

$offset

+int +
+

Returns

+
string
+
+
+
+

Get the max keyword sql

+
max() : string
+
Inherited
+
+

+ + + +
inherited_from\DB_SQL::max()
+

Returns

+
string
+
+
+
+

Get the min keyword sql

+
min() : string
+
Inherited
+
+

+ + + +
inherited_from\DB_SQL::min()
+

Returns

+
string
+
+
+
+

Return sql to list stored procedures

+
procedure_list() : string
+
+
+

+

Returns

+
string
+
+
+
+

Random ordering keyword

+
random() : string
+
+
+

+

Returns

+
string
+
+
+
+

Return sql to list sequences

+
sequence_list() : FALSE
+
+
+

+

Returns

+
FALSE
+
+
+
+

Get the 'sum' keyword

+
sum() : string
+
Inherited
+
+

+ + + +
inherited_from\DB_SQL::sum()
+

Returns

+
string
+
+
+
+

Overridden in MySQL class

+
system_table_list() : string
+
+
+

+

Returns

+
string
+
+
+
+

Returns sql to list tables

+
table_list(string $database) : string
+
+
+

+

Parameters

+
+

$database

+string +
+

Returns

+
string
+
+
+
+

Returns sql to list triggers

+
trigger_list() : string
+
+
+

+

Returns

+
string
+
+
+
+

SQL to show list of field types

+
type_list() : string
+
+
+

+

Returns

+
string
+
+
+
+

Returns sql to list views

+
view_list() : string
+
+
+

+

Returns

+
string
+
+
+
+
+
+
+
+
+ + diff --git a/docs/classes/MySQL_Util.html b/docs/classes/MySQL_Util.html new file mode 100644 index 0000000..b414dc1 --- /dev/null +++ b/docs/classes/MySQL_Util.html @@ -0,0 +1,216 @@ + + + + + +miniMVC » \MySQL_Util + + + + + + + + + +
+
+miniMVC
+
+
Back to top  
+
+
+ +
+
+
+ +
+ +
+
+
+

MySQL-specific backup, import and creation methods

+
+

+ + + + + + + + + +
packageQuery
subpackageDrivers
+

+ Methods

+
+

Enable calling driver methods

+
__call(string $method, array $args) 
+
Inherited
+
+

+ + + +
inherited_from\DB_Util::__call()
+

Parameters

+
+

$method

+string +
+
+

$args

+array +
+
+
+
+

Save a reference to the current connection object

+
__construct(object $conn) : void
+
+
+

+

Parameters

+
+

$conn

+object

&$conn

+
+
+
+
+

Create an SQL backup file for the current database's data

+
backup_data(array $exclude) : string
+
+
+

+

Parameters

+
+

$exclude

+array +
+

Returns

+
string
+
+
+
+

Create an SQL backup file for the current database's structure

+
backup_structure() : string
+
+
+

+

Returns

+
string
+
+
+
+

Convienience public function for creating a new MySQL table

+
create_table(string $name, array $columns, array $constraints, array $indexes) : string
+
+
+

+

Parameters

+
+

$name

+string +
+
+

$columns

+array +
+
+

$constraints

+array +
+
+

$indexes

+array +
+

Returns

+
string
+
+
+
+

Convience public function for droping a table

+
delete_table(string $name) : string
+
+
+

+

Parameters

+
+

$name

+string +
+

Returns

+
string
+
+
+

+ Properties

+ 
+

Reference to the current connection object

+
$conn 
+
Inherited
+
+

+ + + +
inherited_from\DB_Util::$$conn
+
+
+
+
+
+
+
+
+ + diff --git a/docs/classes/ODBC.html b/docs/classes/ODBC.html new file mode 100644 index 0000000..a4b6815 --- /dev/null +++ b/docs/classes/ODBC.html @@ -0,0 +1,914 @@ + + + + + +miniMVC » \ODBC + + + + + + + + + +
+
+miniMVC
+
+
Back to top  
+
+
+ +
+
+
+ +
+ +
+
+
+

ODBC Database Driver

+
+

For general database access for databases not specified by the main drivers

+ + + + + + + + + +
packageQuery
subpackageDrivers
+

+ Methods

+
+

Use ODBC to connect to a database

+
__construct(string $dsn, string $username, string $password, array $options) 
+
+
+

+

Parameters

+
+

$dsn

+string +
+
+

$username

+string +
+
+

$password

+string +
+
+

$options

+array +
+
+
+
+

__sleep() +

+
__sleep() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::__sleep()
inherited_from\DB_PDO::__sleep()
+
+
+
+

__wakeup() +

+
__wakeup() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::__wakeup()
inherited_from\DB_PDO::__wakeup()
+
+
+
+

Returns number of rows affected by an INSERT, UPDATE, DELETE type query

+
affected_rows(\PDOStatement $statement) : int
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::affected_rows()
+

Parameters

+
+

$statement

+\PDOStatement +
+

Returns

+
int
+
+
+
+

beginTransaction() +

+
beginTransaction() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::beginTransaction()
inherited_from\DB_PDO::beginTransaction()
+
+
+
+

commit() +

+
commit() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::commit()
inherited_from\DB_PDO::commit()
+
+
+
+

Method to simplify retreiving db results for meta-data queries

+
driver_query(string $sql, bool $filtered_index) : mixed
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::driver_query()
+

Parameters

+
+

$sql

+string +
+
+

$filtered_index

+bool +
+

Returns

+
mixed
+
+
+
+

Deletes all the rows from a table. Does the same as the truncate +method if the database does not support 'TRUNCATE';

+
empty_table(string $table) : mixed
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::empty_table()
+

Parameters

+
+

$table

+string +
+

Returns

+
mixed
+
+
+
+

errorCode() +

+
errorCode() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::errorCode()
inherited_from\DB_PDO::errorCode()
+
+
+
+

errorInfo() +

+
errorInfo() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::errorInfo()
inherited_from\DB_PDO::errorInfo()
+
+
+
+

exec() +

+
exec() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::exec()
inherited_from\DB_PDO::exec()
+
+
+
+

getAttribute() +

+
getAttribute() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::getAttribute()
inherited_from\DB_PDO::getAttribute()
+
+
+
+

getAvailableDrivers() +

+
getAvailableDrivers() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::getAvailableDrivers()
inherited_from\DB_PDO::getAvailableDrivers()
+
+
+
+

Retrieve column information for the current database table

+
get_columns(string $table) : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_columns()
+

Parameters

+
+

$table

+string +
+

Returns

+
array
+
+
+
+

Return list of dbs for the current connection, if possible

+
get_dbs() : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_dbs()
+

Returns

+
array
+
+
+
+

Return list of function for the current database

+
get_functions() : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_functions()
+

Returns

+
array
+
+
+
+

Return the last error for the current database connection

+
get_last_error() : string
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_last_error()
+

Returns

+
string
+
+
+
+

Return list of stored procedures for the current database

+
get_procedures() : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_procedures()
+

Returns

+
array
+
+
+
+

Retreives the data from a select query

+
get_query_data(\PDOStatement $statement) : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_query_data()
+

Parameters

+
+

$statement

+\PDOStatement +
+

Returns

+
array
+
+
+
+

Return schemas for databases that list them

+
get_schemas() : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_schemas()
+

Returns

+
array
+
+
+
+

Return list of sequences for the current database, if they exist

+
get_sequences() : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_sequences()
+

Returns

+
array
+
+
+
+

Retreives an array of non-user-created tables for +the connection/database

+
get_system_tables() : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_system_tables()
+

Returns

+
array
+
+
+
+

Return list of tables for the current database

+
get_tables() : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_tables()
+

Returns

+
array
+
+
+
+

Return list of triggers for the current database

+
get_triggers() : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_triggers()
+

Returns

+
array
+
+
+
+

Retrieve list of data types for the database

+
get_types() : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_types()
+

Returns

+
array
+
+
+
+

Return list of views for the current database

+
get_views() : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_views()
+

Returns

+
array
+
+
+
+

inTransaction() +

+
inTransaction() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::inTransaction()
inherited_from\DB_PDO::inTransaction()
+
+
+
+

lastInsertId() +

+
lastInsertId() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::lastInsertId()
inherited_from\DB_PDO::lastInsertId()
+
+
+
+

Return the number of rows returned for a SELECT query

+
num_rows() : int
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::num_rows()
+

Returns

+
int
+
+
+
+

prepare() +

+
prepare() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::prepare()
inherited_from\DB_PDO::prepare()
+
+
+
+

Create and execute a prepared statement with the provided parameters

+
prepare_execute(string $sql, array $params) : \PDOStatement
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::prepare_execute()
+

Parameters

+
+

$sql

+string +
+
+

$params

+array +
+

Returns

+
\PDOStatement
+
+
+
+

Simplifies prepared statements for database queries

+
prepare_query(string $sql, array $data) : mixed
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::prepare_query()
+

Parameters

+
+

$sql

+string +
+
+

$data

+array +
+

Returns

+
+mixedPDOStatement / FALSE
+
+
+
+

query() +

+
query() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::query()
inherited_from\DB_PDO::query()
+
+
+
+

quote() +

+
quote() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::quote()
inherited_from\DB_PDO::quote()
+
+
+
+

Surrounds the string with the databases identifier escape characters

+
quote_ident(mixed $ident) : string
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::quote_ident()
+

Parameters

+
+

$ident

+mixed +
+

Returns

+
string
+
+
+
+

rollBack() +

+
rollBack() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::rollBack()
inherited_from\DB_PDO::rollBack()
+
+
+
+

setAttribute() +

+
setAttribute() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::setAttribute()
inherited_from\DB_PDO::setAttribute()
+
+
+
+

Doesn't apply to ODBC

+
switch_db(string $name) : bool
+
+
+

+

Parameters

+
+

$name

+string +
+

Returns

+
bool
+
+
+
+

Empty the current database

+
truncate(string $table) : void
+
+
+

+

Parameters

+
+

$table

+string +
+
+
+
+

Helper method for quote_ident

+
_quote(mixed $str) : mixed
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::_quote()
+

Parameters

+
+

$str

+mixed +
+

Returns

+
mixed
+
+
+

+ Properties

+ 
+

Reference to sql sub class

+
$sql : Object
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::$$sql
+
+
+ 
+

Reference to util sub class

+
$util : Object
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::$$util
+
+
+ 
+

Don't define the escape char - or define it in sub-drivers in a refactor

+
$escape_char : string
+
+

+
+ 
+

Reference to the last executed query

+
$statement : mixed
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::$$statement
+
+
+
+
+
+
+
+
+ + diff --git a/docs/classes/ODBC_SQL.html b/docs/classes/ODBC_SQL.html new file mode 100644 index 0000000..ea477fe --- /dev/null +++ b/docs/classes/ODBC_SQL.html @@ -0,0 +1,316 @@ + + + + + +miniMVC » \ODBC_SQL + + + + + + + + + +
+
+miniMVC
+
+
Back to top  
+
+
+ +
+
+
+ +
+ +
+
+
+

ODBC SQL Class

+
+

+ + + + + + + + + +
packageQuery
subpackageDrivers
+

+ Methods

+
+

Get the 'average' keyword

+
avg() : string
+
Inherited
+
+

+ + + +
inherited_from\DB_SQL::avg()
+

Returns

+
string
+
+
+
+

SQL to show infromation about columns in a table

+
column_list(string $table) : FALSE
+
+
+

+

Parameters

+
+

$table

+string +
+

Returns

+
FALSE
+
+
+
+

Returns sql to list other databases

+
db_list() : FALSE
+
+
+

+

Returns

+
FALSE
+
+
+
+

Get the 'distinct' keyword

+
distinct() : string
+
Inherited
+
+

+ + + +
inherited_from\DB_SQL::distinct()
+

Returns

+
string
+
+
+
+

Return sql to list functions

+
function_list() : FALSE
+
+
+

+

Returns

+
FALSE
+
+
+
+

Limit clause

+
limit(string $sql, int $limit, int $offset) : string
+
+
+

+

Parameters

+
+

$sql

+string +
+
+

$limit

+int +
+
+

$offset

+int +
+

Returns

+
string
+
+
+
+

Get the max keyword sql

+
max() : string
+
Inherited
+
+

+ + + +
inherited_from\DB_SQL::max()
+

Returns

+
string
+
+
+
+

Get the min keyword sql

+
min() : string
+
Inherited
+
+

+ + + +
inherited_from\DB_SQL::min()
+

Returns

+
string
+
+
+
+

Return sql to list stored procedures

+
procedure_list() : FALSE
+
+
+

+

Returns

+
FALSE
+
+
+
+

Random ordering keyword

+
random() : string
+
+
+

+

Returns

+
string
+
+
+
+

Return sql to list sequences

+
sequence_list() : FALSE
+
+
+

+

Returns

+
FALSE
+
+
+
+

Get the 'sum' keyword

+
sum() : string
+
Inherited
+
+

+ + + +
inherited_from\DB_SQL::sum()
+

Returns

+
string
+
+
+
+

Returns sql to list system tables

+
system_table_list() : FALSE
+
+
+

+

Returns

+
FALSE
+
+
+
+

Returns sql to list tables

+
table_list() : FALSE
+
+
+

+

Returns

+
FALSE
+
+
+
+

Returns sql to list triggers

+
trigger_list() : FALSE
+
+
+

+

Returns

+
FALSE
+
+
+
+

SQL to show list of field types

+
type_list() : FALSE
+
+
+

+

Returns

+
FALSE
+
+
+
+

Returns sql to list views

+
view_list() : FALSE
+
+
+

+

Returns

+
FALSE
+
+
+
+
+
+
+
+
+ + diff --git a/docs/classes/ODBC_Util.html b/docs/classes/ODBC_Util.html new file mode 100644 index 0000000..e34830b --- /dev/null +++ b/docs/classes/ODBC_Util.html @@ -0,0 +1,211 @@ + + + + + +miniMVC » \ODBC_Util + + + + + + + + + +
+
+miniMVC
+
+
Back to top  
+
+
+ +
+
+
+ +
+ +
+
+
+

ODBC-specific backup, import and creation methods

+
+

+ + + + + + + + + +
packageQuery
subpackageDrivers
+

+ Methods

+
+

Enable calling driver methods

+
__call(string $method, array $args) 
+
Inherited
+
+

+ + + +
inherited_from\DB_Util::__call()
+

Parameters

+
+

$method

+string +
+
+

$args

+array +
+
+
+
+

Save a reference to the current connection object

+
__construct(object $conn) : void
+
+
+

+

Parameters

+
+

$conn

+object

&$conn

+
+
+
+
+

Create an SQL backup file for the current database's data

+
backup_data() : string
+
+
+

+

Returns

+
string
+
+
+
+

Create an SQL backup file for the current database's structure

+
backup_structure() : string
+
+
+

+

Returns

+
string
+
+
+
+

Database-specific method to create a new table

+
create_table(string $name, array $columns, array $constraints, array $indexes) : string
+
+
+

+

Parameters

+
+

$name

+string +
+
+

$columns

+array +
+
+

$constraints

+array +
+
+

$indexes

+array +
+

Returns

+
string
+
+
+
+

Remove a table from the database

+
delete_table(string $name) : string
+
+
+

+

Parameters

+
+

$name

+string +
+

Returns

+
string
+
+
+

+ Properties

+ 
+

Reference to the current connection object

+
$conn 
+
Inherited
+
+

+ + + +
inherited_from\DB_Util::$$conn
+
+
+
+
+
+
+
+
+ + diff --git a/docs/classes/PgSQL.html b/docs/classes/PgSQL.html new file mode 100644 index 0000000..f862d96 --- /dev/null +++ b/docs/classes/PgSQL.html @@ -0,0 +1,914 @@ + + + + + +miniMVC » \PgSQL + + + + + + + + + +
+
+miniMVC
+
+
Back to top  
+
+
+ +
+
+
+ +
+ +
+
+
+

PostgreSQL specifc class

+
+

Extends PDO to simplify cross-database issues

+ + + + + + + + + +
packageQuery
subpackageDrivers
+

+ Methods

+
+

Connect to a PosgreSQL database

+
__construct(string $dsn, string $username, string $password, array $options) 
+
+
+

+

Parameters

+
+

$dsn

+string +
+
+

$username

+string +
+
+

$password

+string +
+
+

$options

+array +
+
+
+
+

__sleep() +

+
__sleep() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::__sleep()
inherited_from\DB_PDO::__sleep()
+
+
+
+

__wakeup() +

+
__wakeup() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::__wakeup()
inherited_from\DB_PDO::__wakeup()
+
+
+
+

Returns number of rows affected by an INSERT, UPDATE, DELETE type query

+
affected_rows(\PDOStatement $statement) : int
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::affected_rows()
+

Parameters

+
+

$statement

+\PDOStatement +
+

Returns

+
int
+
+
+
+

beginTransaction() +

+
beginTransaction() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::beginTransaction()
inherited_from\DB_PDO::beginTransaction()
+
+
+
+

commit() +

+
commit() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::commit()
inherited_from\DB_PDO::commit()
+
+
+
+

Method to simplify retreiving db results for meta-data queries

+
driver_query(string $sql, bool $filtered_index) : mixed
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::driver_query()
+

Parameters

+
+

$sql

+string +
+
+

$filtered_index

+bool +
+

Returns

+
mixed
+
+
+
+

Deletes all the rows from a table. Does the same as the truncate +method if the database does not support 'TRUNCATE';

+
empty_table(string $table) : mixed
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::empty_table()
+

Parameters

+
+

$table

+string +
+

Returns

+
mixed
+
+
+
+

errorCode() +

+
errorCode() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::errorCode()
inherited_from\DB_PDO::errorCode()
+
+
+
+

errorInfo() +

+
errorInfo() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::errorInfo()
inherited_from\DB_PDO::errorInfo()
+
+
+
+

exec() +

+
exec() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::exec()
inherited_from\DB_PDO::exec()
+
+
+
+

getAttribute() +

+
getAttribute() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::getAttribute()
inherited_from\DB_PDO::getAttribute()
+
+
+
+

getAvailableDrivers() +

+
getAvailableDrivers() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::getAvailableDrivers()
inherited_from\DB_PDO::getAvailableDrivers()
+
+
+
+

Retrieve column information for the current database table

+
get_columns(string $table) : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_columns()
+

Parameters

+
+

$table

+string +
+

Returns

+
array
+
+
+
+

Return list of dbs for the current connection, if possible

+
get_dbs() : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_dbs()
+

Returns

+
array
+
+
+
+

Return list of function for the current database

+
get_functions() : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_functions()
+

Returns

+
array
+
+
+
+

Return the last error for the current database connection

+
get_last_error() : string
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_last_error()
+

Returns

+
string
+
+
+
+

Return list of stored procedures for the current database

+
get_procedures() : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_procedures()
+

Returns

+
array
+
+
+
+

Retreives the data from a select query

+
get_query_data(\PDOStatement $statement) : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_query_data()
+

Parameters

+
+

$statement

+\PDOStatement +
+

Returns

+
array
+
+
+
+

Get a list of schemas for the current connection

+
get_schemas() : array
+
+
+

+

Returns

+
array
+
+
+
+

Return list of sequences for the current database, if they exist

+
get_sequences() : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_sequences()
+

Returns

+
array
+
+
+
+

Retreives an array of non-user-created tables for +the connection/database

+
get_system_tables() : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_system_tables()
+

Returns

+
array
+
+
+
+

Return list of tables for the current database

+
get_tables() : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_tables()
+

Returns

+
array
+
+
+
+

Return list of triggers for the current database

+
get_triggers() : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_triggers()
+

Returns

+
array
+
+
+
+

Retrieve list of data types for the database

+
get_types() : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_types()
+

Returns

+
array
+
+
+
+

Return list of views for the current database

+
get_views() : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_views()
+

Returns

+
array
+
+
+
+

inTransaction() +

+
inTransaction() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::inTransaction()
inherited_from\DB_PDO::inTransaction()
+
+
+
+

lastInsertId() +

+
lastInsertId() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::lastInsertId()
inherited_from\DB_PDO::lastInsertId()
+
+
+
+

Return the number of rows returned for a SELECT query

+
num_rows() : int
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::num_rows()
+

Returns

+
int
+
+
+
+

prepare() +

+
prepare() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::prepare()
inherited_from\DB_PDO::prepare()
+
+
+
+

Create and execute a prepared statement with the provided parameters

+
prepare_execute(string $sql, array $params) : \PDOStatement
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::prepare_execute()
+

Parameters

+
+

$sql

+string +
+
+

$params

+array +
+

Returns

+
\PDOStatement
+
+
+
+

Simplifies prepared statements for database queries

+
prepare_query(string $sql, array $data) : mixed
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::prepare_query()
+

Parameters

+
+

$sql

+string +
+
+

$data

+array +
+

Returns

+
+mixedPDOStatement / FALSE
+
+
+
+

query() +

+
query() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::query()
inherited_from\DB_PDO::query()
+
+
+
+

quote() +

+
quote() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::quote()
inherited_from\DB_PDO::quote()
+
+
+
+

Surrounds the string with the databases identifier escape characters

+
quote_ident(mixed $ident) : string
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::quote_ident()
+

Parameters

+
+

$ident

+mixed +
+

Returns

+
string
+
+
+
+

rollBack() +

+
rollBack() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::rollBack()
inherited_from\DB_PDO::rollBack()
+
+
+
+

setAttribute() +

+
setAttribute() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::setAttribute()
inherited_from\DB_PDO::setAttribute()
+
+
+
+

Connect to a different database

+
switch_db(string $name) : void
+
+
+

+

Parameters

+
+

$name

+string +
+
+
+
+

Empty a table

+
truncate(string $table) : void
+
+
+

+

Parameters

+
+

$table

+string +
+
+
+
+

Helper method for quote_ident

+
_quote(mixed $str) : mixed
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::_quote()
+

Parameters

+
+

$str

+mixed +
+

Returns

+
mixed
+
+
+

+ Properties

+ 
+

Reference to sql sub class

+
$sql : Object
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::$$sql
+
+
+ 
+

Reference to util sub class

+
$util : Object
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::$$util
+
+
+ 
+

Character to escape identifiers

+
$escape_char : string
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::$$escape_char
+
+
+ 
+

Reference to the last executed query

+
$statement : mixed
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::$$statement
+
+
+
+
+
+
+
+
+ + diff --git a/docs/classes/PgSQL_SQL.html b/docs/classes/PgSQL_SQL.html new file mode 100644 index 0000000..10e1caf --- /dev/null +++ b/docs/classes/PgSQL_SQL.html @@ -0,0 +1,316 @@ + + + + + +miniMVC » \PgSQL_SQL + + + + + + + + + +
+
+miniMVC
+
+
Back to top  
+
+
+ +
+
+
+ +
+ +
+
+
+

PostgreSQL specifc SQL

+
+

+ + + + + + + + + +
packageQuery
subpackageDrivers
+

+ Methods

+
+

Get the 'average' keyword

+
avg() : string
+
Inherited
+
+

+ + + +
inherited_from\DB_SQL::avg()
+

Returns

+
string
+
+
+
+

Return sql to list columns of the specified table

+
column_list(string $table) : string
+
+
+

+

Parameters

+
+

$table

+string +
+

Returns

+
string
+
+
+
+

Returns sql to list other databases

+
db_list() : string
+
+
+

+

Returns

+
string
+
+
+
+

Get the 'distinct' keyword

+
distinct() : string
+
Inherited
+
+

+ + + +
inherited_from\DB_SQL::distinct()
+

Returns

+
string
+
+
+
+

Return sql to list functions

+
function_list() : FALSE
+
+
+

+

Returns

+
FALSE
+
+
+
+

Limit clause

+
limit(string $sql, int $limit, int $offset) : string
+
+
+

+

Parameters

+
+

$sql

+string +
+
+

$limit

+int +
+
+

$offset

+int +
+

Returns

+
string
+
+
+
+

Get the max keyword sql

+
max() : string
+
Inherited
+
+

+ + + +
inherited_from\DB_SQL::max()
+

Returns

+
string
+
+
+
+

Get the min keyword sql

+
min() : string
+
Inherited
+
+

+ + + +
inherited_from\DB_SQL::min()
+

Returns

+
string
+
+
+
+

Return sql to list stored procedures

+
procedure_list() : string
+
+
+

+

Returns

+
string
+
+
+
+

Random ordering keyword

+
random() : string
+
+
+

+

Returns

+
string
+
+
+
+

Return sql to list sequences

+
sequence_list() : string
+
+
+

+

Returns

+
string
+
+
+
+

Get the 'sum' keyword

+
sum() : string
+
Inherited
+
+

+ + + +
inherited_from\DB_SQL::sum()
+

Returns

+
string
+
+
+
+

Returns sql to list system tables

+
system_table_list() : string
+
+
+

+

Returns

+
string
+
+
+
+

Returns sql to list tables

+
table_list() : string
+
+
+

+

Returns

+
string
+
+
+
+

Returns sql to list triggers

+
trigger_list() : string
+
+
+

+

Returns

+
string
+
+
+
+

SQL to show list of field types

+
type_list() : string
+
+
+

+

Returns

+
string
+
+
+
+

Returns sql to list views

+
view_list() : string
+
+
+

+

Returns

+
string
+
+
+
+
+
+
+
+
+ + diff --git a/docs/classes/PgSQL_Util.html b/docs/classes/PgSQL_Util.html new file mode 100644 index 0000000..35533a8 --- /dev/null +++ b/docs/classes/PgSQL_Util.html @@ -0,0 +1,216 @@ + + + + + +miniMVC » \PgSQL_Util + + + + + + + + + +
+
+miniMVC
+
+
Back to top  
+
+
+ +
+
+
+ +
+ +
+
+
+

Posgres-specific backup, import and creation methods

+
+

+ + + + + + + + + +
packageQuery
subpackageDrivers
+

+ Methods

+
+

Enable calling driver methods

+
__call(string $method, array $args) 
+
Inherited
+
+

+ + + +
inherited_from\DB_Util::__call()
+

Parameters

+
+

$method

+string +
+
+

$args

+array +
+
+
+
+

Save a reference to the current connection object

+
__construct(object $conn) : void
+
+
+

+

Parameters

+
+

$conn

+object

&$conn

+
+
+
+
+

Create an SQL backup file for the current database's data

+
backup_data(array $exclude) : string
+
+
+

+

Parameters

+
+

$exclude

+array +
+

Returns

+
string
+
+
+
+

Create an SQL backup file for the current database's structure

+
backup_structure() : string
+
+
+

+

Returns

+
string
+
+
+
+

Database-specific method to create a new table

+
create_table(string $name, array $columns, array $constraints, array $indexes) : string
+
+
+

+

Parameters

+
+

$name

+string +
+
+

$columns

+array +
+
+

$constraints

+array +
+
+

$indexes

+array +
+

Returns

+
string
+
+
+
+

Database-specific SQL for dropping a table

+
delete_table(string $name) : string
+
+
+

+

Parameters

+
+

$name

+string +
+

Returns

+
string
+
+
+

+ Properties

+ 
+

Reference to the current connection object

+
$conn 
+
Inherited
+
+

+ + + +
inherited_from\DB_Util::$$conn
+
+
+
+
+
+
+
+
+ + diff --git a/docs/classes/Query_Builder.html b/docs/classes/Query_Builder.html new file mode 100644 index 0000000..9a49294 --- /dev/null +++ b/docs/classes/Query_Builder.html @@ -0,0 +1,1230 @@ + + + + + +miniMVC » \Query_Builder + + + + + + + + + +
+
+miniMVC
+
+
Back to top  
+
+
+ +
+
+
+ +
+ +
+
+
+

Convienience class for creating sql queries - also the class that +instantiates the specific db driver

+
+

+ + + + + + + + + +
packageQuery
subpackageQuery
+

+ Methods

+
+

Calls a function further down the inheritence chain

+
__call(string $name, array $params) : mixed
+
+
+

+

Parameters

+
+

$name

+string +
+
+

$params

+array +
+

Returns

+
mixed
+
+
+
+

Constructor

+
__construct(object $params) 
+
+
+

+

Parameters

+
+

$params

+object
    +
  • the connection parametere
    • +
+
+
+
+
+

Retreive the number of rows in the selected table

+
count_all(string $table) : int
+
+
+

+

Parameters

+
+

$table

+string +
+

Returns

+
int
+
+
+
+

Retrieve the number of results for the generated query - used +in place of the get() method

+
count_all_results(string $table) : int
+
+
+

+

Parameters

+
+

$table

+string +
+

Returns

+
int
+
+
+
+

Deletes data from a table

+
delete(string $table, mixed $where) : mixed
+
+
+

+

Parameters

+
+

$table

+string +
+
+

$where

+mixed +
+

Returns

+
mixed
+
+
+
+

Adds the 'distinct' keyword to a query

+
distinct() : \Query_Builder
+
+
+

+ + + +
fluentThis method is part of a fluent interface and will return the same instance
+

Returns

+
\Query_Builder
+
+
+
+

Specify the database table to select from

+
from(string $dbname) : \Query_Builder
+
+
+

+ + + +
fluentThis method is part of a fluent interface and will return the same instance
+

Parameters

+
+

$dbname

+string +
+

Returns

+
\Query_Builder
+
+
+
+

Select and retrieve all records from the current table, and/or +execute current compiled query

+
get($table, int $limit, int $offset) : object
+
+
+

+

Parameters

+
+

$table

+ +
+
+

$limit

+int +
+
+

$offset

+int +
+

Returns

+
object
+
+
+
+

Convience method for get() with a where clause

+
get_where(string $table, array $where, int $limit, int $offset) : object
+
+
+

+

Parameters

+
+

$table

+string +
+
+

$where

+array +
+
+

$limit

+int +
+
+

$offset

+int +
+

Returns

+
object
+
+
+
+

Group the results by the selected field(s)

+
group_by(mixed $field) : \Query_Builder
+
+
+

+ + + +
fluentThis method is part of a fluent interface and will return the same instance
+

Parameters

+
+

$field

+mixed +
+

Returns

+
\Query_Builder
+
+
+
+

Ends a query group

+
group_end() : \Query_Builder
+
+
+

+ + + +
fluentThis method is part of a fluent interface and will return the same instance
+

Returns

+
\Query_Builder
+
+
+
+

Adds a paren to the current query for query grouping

+
group_start() : \Query_Builder
+
+
+

+ + + +
fluentThis method is part of a fluent interface and will return the same instance
+

Returns

+
\Query_Builder
+
+
+
+

Generates a 'Having' clause

+
having(mixed $key, mixed $val) : \Query_Builder
+
+
+

+ + + +
fluentThis method is part of a fluent interface and will return the same instance
+

Parameters

+
+

$key

+mixed +
+
+

$val

+mixed +
+

Returns

+
\Query_Builder
+
+
+
+

Creates an insert clause, and executes it

+
insert(string $table, mixed $data) : mixed
+
+
+

+

Parameters

+
+

$table

+string +
+
+

$data

+mixed +
+

Returns

+
mixed
+
+
+
+

Creates a join phrase in a compiled query

+
join(string $table, string $condition, string $type) : \Query_Builder
+
+
+

+ + + +
fluentThis method is part of a fluent interface and will return the same instance
+

Parameters

+
+

$table

+string +
+
+

$condition

+string +
+
+

$type

+string +
+

Returns

+
\Query_Builder
+
+
+ +
+

Set a limit on the current sql statement

+
limit(int $limit, int $offset) : string
+
+
+

+

Parameters

+
+

$limit

+int +
+
+

$offset

+int +
+

Returns

+
string
+
+
+
+

Generates a NOT LIKE clause

+
not_like(string $field, mixed $val, string $pos) : \Query_Builder
+
+
+

+ + + +
fluentThis method is part of a fluent interface and will return the same instance
+

Parameters

+
+

$field

+string +
+
+

$val

+mixed +
+
+

$pos

+string +
+

Returns

+
\Query_Builder
+
+
+
+

Adds a paren to the current query for query grouping, +prefixed with 'OR'

+
or_group_start() : \Query_Builder
+
+
+

+ + + +
fluentThis method is part of a fluent interface and will return the same instance
+

Returns

+
\Query_Builder
+
+
+
+

Generates a 'Having' clause prefixed with 'OR'

+
or_having(mixed $key, mixed $val) : \Query_Builder
+
+
+

+ + + +
fluentThis method is part of a fluent interface and will return the same instance
+

Parameters

+
+

$key

+mixed +
+
+

$val

+mixed +
+

Returns

+
\Query_Builder
+
+
+
+

Generates an OR Like clause

+
or_like(string $field, mixed $val, string $pos) : \Query_Builder
+
+
+

+ + + +
fluentThis method is part of a fluent interface and will return the same instance
+

Parameters

+
+

$field

+string +
+
+

$val

+mixed +
+
+

$pos

+string +
+

Returns

+
\Query_Builder
+
+
+
+

Adds a paren to the current query for query grouping, +prefixed with 'OR NOT'

+
or_not_group_start() : \Query_Builder
+
+
+

+ + + +
fluentThis method is part of a fluent interface and will return the same instance
+

Returns

+
\Query_Builder
+
+
+
+

Generates a OR NOT LIKE clause

+
or_not_like(string $field, mixed $val, string $pos) : \Query_Builder
+
+
+

+ + + +
fluentThis method is part of a fluent interface and will return the same instance
+

Parameters

+
+

$field

+string +
+
+

$val

+mixed +
+
+

$pos

+string +
+

Returns

+
\Query_Builder
+
+
+
+

Where clause prefixed with "OR"

+
or_where(string $key, mixed $val) : \Query_Builder
+
+
+

+ + + +
fluentThis method is part of a fluent interface and will return the same instance
+

Parameters

+
+

$key

+string +
+
+

$val

+mixed +
+

Returns

+
\Query_Builder
+
+
+
+

Where in statement prefixed with "or"

+
or_where_in(string $field, mixed $val) : \Query_Builder
+
+
+

+ + + +
fluentThis method is part of a fluent interface and will return the same instance
+

Parameters

+
+

$field

+string +
+
+

$val

+mixed +
+

Returns

+
\Query_Builder
+
+
+
+

OR WHERE NOT IN (FOO) clause

+
or_where_not_in(string $field, mixed $val) : \Query_Builder
+
+
+

+ + + +
fluentThis method is part of a fluent interface and will return the same instance
+

Parameters

+
+

$field

+string +
+
+

$val

+mixed +
+

Returns

+
\Query_Builder
+
+
+
+

Order the results by the selected field(s)

+
order_by(string $field, string $type) : \Query_Builder
+
+
+

+ + + +
fluentThis method is part of a fluent interface and will return the same instance
+

Parameters

+
+

$field

+string +
+
+

$type

+string +
+

Returns

+
\Query_Builder
+
+
+
+

Specifies rows to select in a query

+
select(string $fields) : \Query_Builder
+
+
+

+ + + +
fluentThis method is part of a fluent interface and will return the same instance
+

Parameters

+
+

$fields

+string +
+

Returns

+
\Query_Builder
+
+
+
+

Selects the average value of a field from a query

+
select_avg(string $field, string $as) : \Query_Builder
+
+
+

+ + + +
fluentThis method is part of a fluent interface and will return the same instance
+

Parameters

+
+

$field

+string +
+
+

$as

+string +
+

Returns

+
\Query_Builder
+
+
+
+

Selects the maximum value of a field from a query

+
select_max(string $field, string $as) : \Query_Builder
+
+
+

+ + + +
fluentThis method is part of a fluent interface and will return the same instance
+

Parameters

+
+

$field

+string +
+
+

$as

+string +
+

Returns

+
\Query_Builder
+
+
+
+

Selects the minimum value of a field from a query

+
select_min(string $field, string $as) : \Query_Builder
+
+
+

+ + + +
fluentThis method is part of a fluent interface and will return the same instance
+

Parameters

+
+

$field

+string +
+
+

$as

+string +
+

Returns

+
\Query_Builder
+
+
+
+

Selects the sum of a field from a query

+
select_sum(string $field, string $as) : \Query_Builder
+
+
+

+ + + +
fluentThis method is part of a fluent interface and will return the same instance
+

Parameters

+
+

$field

+string +
+
+

$as

+string +
+

Returns

+
\Query_Builder
+
+
+
+

Sets values for inserts / updates / deletes

+
set(mixed $key, mixed $val) : \Query_Builder
+
+
+

+ + + +
fluentThis method is part of a fluent interface and will return the same instance
+

Parameters

+
+

$key

+mixed +
+
+

$val

+mixed +
+

Returns

+
\Query_Builder
+
+
+
+

Creates an update clause, and executes it

+
update(string $table, mixed $data) : mixed
+
+
+

+

Parameters

+
+

$table

+string +
+
+

$data

+mixed +
+

Returns

+
mixed
+
+
+
+

Specify condition(s) in the where clause of a query +Note: this function works with key / value, or a +passed array with key / value pairs

+
where(mixed $key, mixed $val) : \Query_Builder
+
+
+

+ + + +
fluentThis method is part of a fluent interface and will return the same instance
+

Parameters

+
+

$key

+mixed +
+
+

$val

+mixed +
+

Returns

+
\Query_Builder
+
+
+
+

Where clause with 'IN' statement

+
where_in(mixed $field, mixed $val) : \Query_Builder
+
+
+

+ + + +
fluentThis method is part of a fluent interface and will return the same instance
+

Parameters

+
+

$field

+mixed +
+
+

$val

+mixed +
+

Returns

+
\Query_Builder
+
+
+
+

WHERE NOT IN (FOO) clause

+
where_not_in(string $field, mixed $val) : \Query_Builder
+
+
+

+ + + +
fluentThis method is part of a fluent interface and will return the same instance
+

Parameters

+
+

$field

+string +
+
+

$val

+mixed +
+

Returns

+
\Query_Builder
+
+
+
+

String together the sql statements for sending to the db

+
_compile(string $type, string $table) : \$string
+
+
+

+

Parameters

+
+

$type

+string +
+
+

$table

+string +
+

Returns

+
\$string
+
+
+
+

Simplify building having clauses

+
_having(mixed $key, mixed $val, string $conj) : \Query_Builder
+
+
+

+ + + +
fluentThis method is part of a fluent interface and will return the same instance
+

Parameters

+
+

$key

+mixed +
+
+

$val

+mixed +
+
+

$conj

+string +
+

Returns

+
\Query_Builder
+
+
+
+

Simplify 'like' methods

+
_like(string $field, mixed $val, string $pos, string $like, string $conj) : \Query_Builder
+
+
+

+ + + +
fluentThis method is part of a fluent interface and will return the same instance
+

Parameters

+
+

$field

+string +
+
+

$val

+mixed +
+
+

$pos

+string +
+
+

$like

+string +
+
+

$conj

+string +
+

Returns

+
\Query_Builder
+
+
+
+

Clear out the class variables, so the next query can be run

+
_reset() : void
+
+

+
+
+

Method to simplify select_ methods

+
_select(string $field, string $as) : string
+
+
+

+

Parameters

+
+

$field

+string +
+
+

$as

+string +
+

Returns

+
string
+
+
+
+

Do all the repeditive stuff for where/having type methods

+
_where(mixed $key, mixed $val) : array
+
+
+

+

Parameters

+
+

$key

+mixed +
+
+

$val

+mixed +
+

Returns

+
array
+
+
+
+

Simplify where_in methods

+
_where_in(mixed $key, mixed $val, $in, $conj) : \Query_Builder
+
+
+

+ + + +
fluentThis method is part of a fluent interface and will return the same instance
+

Parameters

+
+

$key

+mixed +
+
+

$val

+mixed +
+
+

$in

+

string

+
+

$conj

+

string

+

Returns

+
\Query_Builder
+
+
+
+

Simplify generating where string

+
_where_string(mixed $key, mixed $val, string $conj) : \Query_Builder
+
+
+

+ + + +
fluentThis method is part of a fluent interface and will return the same instance
+

Parameters

+
+

$key

+mixed +
+
+

$val

+mixed +
+
+

$conj

+string +
+

Returns

+
\Query_Builder
+
+
+

+ Properties

+ 
+

Convenience property for connection management

+
$conn_name : string
+
+

+
+ 
+

Alias to $this->db->sql

+
$sql : \DB_PDO
+
+

+
+ 
+

Compiled 'from' clause

+
$from_string : string
+
+

+
+ 
+

Key/val pairs for group by clause

+
$group_array : array
+
+

+
+ 
+

Group by clause

+
$group_string : string
+
+

+
+ 
+

Map for having clause

+
$having_map : array
+
+

+
+ 
+

Value for limit string

+
$limit : int
+
+

+
+ 
+

Value for offset in limit string

+
$offset : int
+
+

+
+ 
+

Key/val pairs for order by clause

+
$order_array : array
+
+

+
+ 
+

Order by clause

+
$order_string : string
+
+

+
+ 
+

Query component order mapping +for complex select queries

+
$query_map : array
+
+

Format:

+ +

array( + 'type' => 'where', + 'conjunction' => ' AND ', + 'string' => 'k=?' +)

+
+ 
+

Compiled 'select' clause

+
$select_string : string
+
+

+
+ 
+

Keys for insert/update statement

+
$set_array_keys : array
+
+

+
+ 
+

Compiled arguments for insert / update

+
$set_string : string
+
+

+
+ 
+

Values to apply to prepared statements

+
$values : array
+
+

+
+
+
+
+
+
+
+ + diff --git a/docs/classes/SQLite.html b/docs/classes/SQLite.html new file mode 100644 index 0000000..87f7092 --- /dev/null +++ b/docs/classes/SQLite.html @@ -0,0 +1,929 @@ + + + + + +miniMVC » \SQLite + + + + + + + + + +
+
+miniMVC
+
+
Back to top  
+
+
+ +
+
+
+ +
+ +
+
+
+

SQLite specific class

+
+

Extends PDO to simplify cross-database issues

+ + + + + + + + + +
packageQuery
subpackageDrivers
+

+ Methods

+
+

Open SQLite Database

+
__construct(string $dsn, string $user, string $pass) 
+
+
+

+

Parameters

+
+

$dsn

+string +
+
+

$user

+string +
+
+

$pass

+string +
+
+
+
+

__sleep() +

+
__sleep() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::__sleep()
inherited_from\DB_PDO::__sleep()
+
+
+
+

__wakeup() +

+
__wakeup() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::__wakeup()
inherited_from\DB_PDO::__wakeup()
+
+
+
+

Returns number of rows affected by an INSERT, UPDATE, DELETE type query

+
affected_rows(\PDOStatement $statement) : int
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::affected_rows()
+

Parameters

+
+

$statement

+\PDOStatement +
+

Returns

+
int
+
+
+
+

beginTransaction() +

+
beginTransaction() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::beginTransaction()
inherited_from\DB_PDO::beginTransaction()
+
+
+
+

commit() +

+
commit() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::commit()
inherited_from\DB_PDO::commit()
+
+
+
+

Method to simplify retreiving db results for meta-data queries

+
driver_query(string $sql, bool $filtered_index) : mixed
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::driver_query()
+

Parameters

+
+

$sql

+string +
+
+

$filtered_index

+bool +
+

Returns

+
mixed
+
+
+
+

Deletes all the rows from a table. Does the same as the truncate +method if the database does not support 'TRUNCATE';

+
empty_table(string $table) : mixed
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::empty_table()
+

Parameters

+
+

$table

+string +
+

Returns

+
mixed
+
+
+
+

errorCode() +

+
errorCode() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::errorCode()
inherited_from\DB_PDO::errorCode()
+
+
+
+

errorInfo() +

+
errorInfo() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::errorInfo()
inherited_from\DB_PDO::errorInfo()
+
+
+
+

exec() +

+
exec() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::exec()
inherited_from\DB_PDO::exec()
+
+
+
+

getAttribute() +

+
getAttribute() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::getAttribute()
inherited_from\DB_PDO::getAttribute()
+
+
+
+

getAvailableDrivers() +

+
getAvailableDrivers() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::getAvailableDrivers()
inherited_from\DB_PDO::getAvailableDrivers()
+
+
+
+

Retrieve column information for the current database table

+
get_columns(string $table) : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_columns()
+

Parameters

+
+

$table

+string +
+

Returns

+
array
+
+
+
+

Return list of dbs for the current connection, if possible

+
get_dbs() : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_dbs()
+

Returns

+
array
+
+
+
+

Return list of function for the current database

+
get_functions() : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_functions()
+

Returns

+
array
+
+
+
+

Return the last error for the current database connection

+
get_last_error() : string
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_last_error()
+

Returns

+
string
+
+
+
+

Return list of stored procedures for the current database

+
get_procedures() : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_procedures()
+

Returns

+
array
+
+
+
+

Retreives the data from a select query

+
get_query_data(\PDOStatement $statement) : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_query_data()
+

Parameters

+
+

$statement

+\PDOStatement +
+

Returns

+
array
+
+
+
+

Return schemas for databases that list them

+
get_schemas() : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_schemas()
+

Returns

+
array
+
+
+
+

Return list of sequences for the current database, if they exist

+
get_sequences() : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_sequences()
+

Returns

+
array
+
+
+
+

List system tables for the current database

+
get_system_tables() : array
+
+
+

+

Returns

+
array
+
+
+
+

List tables for the current database

+
get_tables() : mixed
+
+
+

+

Returns

+
mixed
+
+
+
+

Return list of triggers for the current database

+
get_triggers() : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_triggers()
+

Returns

+
array
+
+
+
+

Retrieve list of data types for the database

+
get_types() : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_types()
+

Returns

+
array
+
+
+
+

Return list of views for the current database

+
get_views() : array
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::get_views()
+

Returns

+
array
+
+
+
+

inTransaction() +

+
inTransaction() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::inTransaction()
inherited_from\DB_PDO::inTransaction()
+
+
+
+

lastInsertId() +

+
lastInsertId() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::lastInsertId()
inherited_from\DB_PDO::lastInsertId()
+
+
+
+

Load a database for the current connection

+
load_database(string $db, string $name) 
+
+
+

+

Parameters

+
+

$db

+string +
+
+

$name

+string +
+
+
+
+

Return the number of rows returned for a SELECT query

+
num_rows() : int
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::num_rows()
+

Returns

+
int
+
+
+
+

prepare() +

+
prepare() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::prepare()
inherited_from\DB_PDO::prepare()
+
+
+
+

Create and execute a prepared statement with the provided parameters

+
prepare_execute(string $sql, array $params) : \PDOStatement
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::prepare_execute()
+

Parameters

+
+

$sql

+string +
+
+

$params

+array +
+

Returns

+
\PDOStatement
+
+
+
+

Simplifies prepared statements for database queries

+
prepare_query(string $sql, array $data) : mixed
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::prepare_query()
+

Parameters

+
+

$sql

+string +
+
+

$data

+array +
+

Returns

+
+mixedPDOStatement / FALSE
+
+
+
+

query() +

+
query() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::query()
inherited_from\DB_PDO::query()
+
+
+
+

quote() +

+
quote() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::quote()
inherited_from\DB_PDO::quote()
+
+
+
+

Surrounds the string with the databases identifier escape characters

+
quote_ident(mixed $ident) : string
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::quote_ident()
+

Parameters

+
+

$ident

+mixed +
+

Returns

+
string
+
+
+
+

rollBack() +

+
rollBack() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::rollBack()
inherited_from\DB_PDO::rollBack()
+
+
+
+

setAttribute() +

+
setAttribute() 
+
Inherited
+
+

+ + + + + + + + + +
inherited_fromPDO::setAttribute()
inherited_from\DB_PDO::setAttribute()
+
+
+
+

Doesn't apply to sqlite

+
switch_db(string $name) : void
+
+
+

+

Parameters

+
+

$name

+string +
+
+
+
+

Empty a table

+
truncate(string $table) : void
+
+
+

+

Parameters

+
+

$table

+string +
+
+
+
+

Unload a database from the current connection

+
unload_database(string $name) 
+
+
+

+

Parameters

+
+

$name

+string +
+
+
+
+

Helper method for quote_ident

+
_quote(mixed $str) : mixed
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::_quote()
+

Parameters

+
+

$str

+mixed +
+

Returns

+
mixed
+
+
+

+ Properties

+ 
+

Reference to sql sub class

+
$sql : Object
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::$$sql
+
+
+ 
+

Reference to util sub class

+
$util : Object
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::$$util
+
+
+ 
+

Character to escape identifiers

+
$escape_char : string
+
Inherited
+
+

+ + + +
inherited_from\DB_PDO::$$escape_char
+
+
+ 
+

Reference to the last executed sql query

+
$statement : \PDOStatement
+
+

+
+
+
+
+
+
+
+ + diff --git a/docs/classes/SQLite_SQL.html b/docs/classes/SQLite_SQL.html new file mode 100644 index 0000000..7ab05df --- /dev/null +++ b/docs/classes/SQLite_SQL.html @@ -0,0 +1,316 @@ + + + + + +miniMVC » \SQLite_SQL + + + + + + + + + +
+
+miniMVC
+
+
Back to top  
+
+
+ +
+
+
+ +
+ +
+
+
+

SQLite Specific SQL

+
+

+ + + + + + + + + +
packageQuery
subpackageDrivers
+

+ Methods

+
+

Get the 'average' keyword

+
avg() : string
+
Inherited
+
+

+ + + +
inherited_from\DB_SQL::avg()
+

Returns

+
string
+
+
+
+

SQL to show infromation about columns in a table

+
column_list(string $table) : string
+
+
+

+

Parameters

+
+

$table

+string +
+

Returns

+
string
+
+
+
+

Returns sql to list other databases

+
db_list() : FALSE
+
+
+

+

Returns

+
FALSE
+
+
+
+

Get the 'distinct' keyword

+
distinct() : string
+
Inherited
+
+

+ + + +
inherited_from\DB_SQL::distinct()
+

Returns

+
string
+
+
+
+

Return sql to list functions

+
function_list() : FALSE
+
+
+

+

Returns

+
FALSE
+
+
+
+

Limit clause

+
limit(string $sql, int $limit, int $offset) : string
+
+
+

+

Parameters

+
+

$sql

+string +
+
+

$limit

+int +
+
+

$offset

+int +
+

Returns

+
string
+
+
+
+

Get the max keyword sql

+
max() : string
+
Inherited
+
+

+ + + +
inherited_from\DB_SQL::max()
+

Returns

+
string
+
+
+
+

Get the min keyword sql

+
min() : string
+
Inherited
+
+

+ + + +
inherited_from\DB_SQL::min()
+

Returns

+
string
+
+
+
+

Return sql to list stored procedures

+
procedure_list() : FALSE
+
+
+

+

Returns

+
FALSE
+
+
+
+

Random ordering keyword

+
random() : string
+
+
+

+

Returns

+
string
+
+
+
+

Return sql to list sequences

+
sequence_list() : FALSE
+
+
+

+

Returns

+
FALSE
+
+
+
+

Get the 'sum' keyword

+
sum() : string
+
Inherited
+
+

+ + + +
inherited_from\DB_SQL::sum()
+

Returns

+
string
+
+
+
+

Overridden in SQLite class

+
system_table_list() : string
+
+
+

+

Returns

+
string
+
+
+
+

Returns sql to list tables

+
table_list() : string
+
+
+

+

Returns

+
string
+
+
+
+

Returns sql to list triggers

+
trigger_list() : FALSE
+
+
+

+

Returns

+
FALSE
+
+
+
+

SQL to show list of field types

+
type_list() : array
+
+
+

+

Returns

+
array
+
+
+
+

Returns sql to list views

+
view_list() : string
+
+
+

+

Returns

+
string
+
+
+
+
+
+
+
+
+ + diff --git a/docs/classes/SQLite_Util.html b/docs/classes/SQLite_Util.html new file mode 100644 index 0000000..6443714 --- /dev/null +++ b/docs/classes/SQLite_Util.html @@ -0,0 +1,216 @@ + + + + + +miniMVC » \SQLite_Util + + + + + + + + + +
+
+miniMVC
+
+
Back to top  
+
+
+ +
+
+
+ +
+ +
+
+
+

SQLite-specific backup, import and creation methods

+
+

+ + + + + + + + + +
packageQuery
subpackageDrivers
+

+ Methods

+
+

Enable calling driver methods

+
__call(string $method, array $args) 
+
Inherited
+
+

+ + + +
inherited_from\DB_Util::__call()
+

Parameters

+
+

$method

+string +
+
+

$args

+array +
+
+
+
+

Save a reference to the current connection object

+
__construct(object $conn) : void
+
+
+

+

Parameters

+
+

$conn

+object

&$conn

+
+
+
+
+

Create an SQL backup file for the current database's data

+
backup_data(array $excluded) : string
+
+
+

+

Parameters

+
+

$excluded

+array +
+

Returns

+
string
+
+
+
+

Create an SQL backup file for the current database's structure

+
backup_structure() : string
+
+
+

+

Returns

+
string
+
+
+
+

Convenience public function to create a new table

+
create_table(string $name, array $columns, array $constraints, array $indexes) : string
+
+
+

+

Parameters

+
+

$name

+string

//Name of the table

+
+
+

$columns

+array

//columns as straight array and/or column => type pairs

+
+
+

$constraints

+array

// column => constraint pairs

+
+
+

$indexes

+array

// column => index pairs

+
+

Returns

+
string
+
+
+
+

SQL to drop the specified table

+
delete_table(string $name) : string
+
+
+

+

Parameters

+
+

$name

+string +
+

Returns

+
string
+
+
+

+ Properties

+ 
+

Reference to the current connection object

+
$conn 
+
Inherited
+
+

+ + + +
inherited_from\DB_Util::$$conn
+
+
+
+
+
+
+
+
+ + diff --git a/docs/classes/miniMVC.Controller.html b/docs/classes/miniMVC.Controller.html index 66cf03e..fac7a80 100644 --- a/docs/classes/miniMVC.Controller.html +++ b/docs/classes/miniMVC.Controller.html @@ -21,6 +21,7 @@ API Documentation @@ -34,7 +35,9 @@
  •  Errors  0
  •  Markers  -
      • +
    •  Deprecated elements  0
      • @@ -746,7 +749,7 @@ dynamic methods
      + generated on 2012-06-06T16:50:21-04:00.
      diff --git a/docs/classes/miniMVC.DB.html b/docs/classes/miniMVC.DB.html index 1851efe..4c99e8d 100644 --- a/docs/classes/miniMVC.DB.html +++ b/docs/classes/miniMVC.DB.html @@ -21,6 +21,7 @@ API Documentation @@ -34,7 +35,9 @@
    •  Errors  0
    •  Markers  -
        • +
      •  Deprecated elements  0
        • @@ -56,12 +59,87 @@
        @@ -90,6 +168,183 @@

         Methods

        +
        +

        Calls a function further down the inheritence chain

        +
        __call(string $name, array $params) : mixed
        +
        Inherited
        +
        +

        + + + +
        inherited_from\Query_Builder::__call()
        +

        Parameters

        +
        +

        $name

        +string +
        +
        +

        $params

        +array +
        +

        Returns

        +
        mixed
        +
        +
        +
        +

        Constructor

        +
        __construct(object $params) 
        +
        Inherited
        +
        +

        + + + +
        inherited_from\Query_Builder::__construct()
        +

        Parameters

        +
        +

        $params

        +object
          +
        • the connection parametere
          • +
        +
        +
        +
        +
        +

        Retreive the number of rows in the selected table

        +
        count_all(string $table) : int
        +
        Inherited
        +
        +

        + + + +
        inherited_from\Query_Builder::count_all()
        +

        Parameters

        +
        +

        $table

        +string +
        +

        Returns

        +
        int
        +
        +
        +
        +

        Retrieve the number of results for the generated query - used +in place of the get() method

        +
        count_all_results(string $table) : int
        +
        Inherited
        +
        +

        + + + +
        inherited_from\Query_Builder::count_all_results()
        +

        Parameters

        +
        +

        $table

        +string +
        +

        Returns

        +
        int
        +
        +
        +
        +

        Deletes data from a table

        +
        delete(string $table, mixed $where) : mixed
        +
        Inherited
        +
        +

        + + + +
        inherited_from\Query_Builder::delete()
        +

        Parameters

        +
        +

        $table

        +string +
        +
        +

        $where

        +mixed +
        +

        Returns

        +
        mixed
        +
        +
        +
        +

        Adds the 'distinct' keyword to a query

        +
        distinct() : \miniMVC\DB
        +
        Inherited
        +
        +

        + + + + + + + + + +
        inherited_from\Query_Builder::distinct()
        fluentThis method is part of a fluent interface and will return the same instance
        +

        Returns

        +
        \miniMVC\DB
        +
        +
        +
        +

        Specify the database table to select from

        +
        from(string $dbname) : \miniMVC\DB
        +
        Inherited
        +
        +

        + + + + + + + + + +
        inherited_from\Query_Builder::from()
        fluentThis method is part of a fluent interface and will return the same instance
        +

        Parameters

        +
        +

        $dbname

        +string +
        +

        Returns

        +
        \miniMVC\DB
        +
        +
        +
        +

        Select and retrieve all records from the current table, and/or +execute current compiled query

        +
        get($table, int $limit, int $offset) : object
        +
        Inherited
        +
        +

        + + + +
        inherited_from\Query_Builder::get()
        +

        Parameters

        +
        +

        $table

        + +
        +
        +

        $limit

        +int +
        +
        +

        $offset

        +int +
        +

        Returns

        +
        object
        +
        +

        Indexed singleton method

        get_instance(string $dbname, array $options) : \miniMVC\DB
        @@ -119,14 +374,1229 @@
        string
        +
        +

        Convience method for get() with a where clause

        +
        get_where(string $table, array $where, int $limit, int $offset) : object
        +
        Inherited
        +
        +

        + + + +
        inherited_from\Query_Builder::get_where()
        +

        Parameters

        +
        +

        $table

        +string +
        +
        +

        $where

        +array +
        +
        +

        $limit

        +int +
        +
        +

        $offset

        +int +
        +

        Returns

        +
        object
        +
        +
        +
        +

        Group the results by the selected field(s)

        +
        group_by(mixed $field) : \miniMVC\DB
        +
        Inherited
        +
        +

        + + + + + + + + + +
        inherited_from\Query_Builder::group_by()
        fluentThis method is part of a fluent interface and will return the same instance
        +

        Parameters

        +
        +

        $field

        +mixed +
        +

        Returns

        +
        \miniMVC\DB
        +
        +
        +
        +

        Ends a query group

        +
        group_end() : \miniMVC\DB
        +
        Inherited
        +
        +

        + + + + + + + + + +
        inherited_from\Query_Builder::group_end()
        fluentThis method is part of a fluent interface and will return the same instance
        +

        Returns

        +
        \miniMVC\DB
        +
        +
        +
        +

        Adds a paren to the current query for query grouping

        +
        group_start() : \miniMVC\DB
        +
        Inherited
        +
        +

        + + + + + + + + + +
        inherited_from\Query_Builder::group_start()
        fluentThis method is part of a fluent interface and will return the same instance
        +

        Returns

        +
        \miniMVC\DB
        +
        +
        +
        +

        Generates a 'Having' clause

        +
        having(mixed $key, mixed $val) : \miniMVC\DB
        +
        Inherited
        +
        +

        + + + + + + + + + +
        inherited_from\Query_Builder::having()
        fluentThis method is part of a fluent interface and will return the same instance
        +

        Parameters

        +
        +

        $key

        +mixed +
        +
        +

        $val

        +mixed +
        +

        Returns

        +
        \miniMVC\DB
        +
        +
        +
        +

        Creates an insert clause, and executes it

        +
        insert(string $table, mixed $data) : mixed
        +
        Inherited
        +
        +

        + + + +
        inherited_from\Query_Builder::insert()
        +

        Parameters

        +
        +

        $table

        +string +
        +
        +

        $data

        +mixed +
        +

        Returns

        +
        mixed
        +
        +
        +
        +

        Creates a join phrase in a compiled query

        +
        join(string $table, string $condition, string $type) : \miniMVC\DB
        +
        Inherited
        +
        +

        + + + + + + + + + +
        inherited_from\Query_Builder::join()
        fluentThis method is part of a fluent interface and will return the same instance
        +

        Parameters

        +
        +

        $table

        +string +
        +
        +

        $condition

        +string +
        +
        +

        $type

        +string +
        +

        Returns

        +
        \miniMVC\DB
        +
        +
        +
        +

        Creates a Like clause in the sql statement

        +
        like(string $field, mixed $val, string $pos) : \miniMVC\DB
        +
        Inherited
        +
        +

        + + + + + + + + + +
        inherited_from\Query_Builder::like()
        fluentThis method is part of a fluent interface and will return the same instance
        +

        Parameters

        +
        +

        $field

        +string +
        +
        +

        $val

        +mixed +
        +
        +

        $pos

        +string +
        +

        Returns

        +
        \miniMVC\DB
        +
        +
        +
        +

        Set a limit on the current sql statement

        +
        limit(int $limit, int $offset) : string
        +
        Inherited
        +
        +

        + + + +
        inherited_from\Query_Builder::limit()
        +

        Parameters

        +
        +

        $limit

        +int +
        +
        +

        $offset

        +int +
        +

        Returns

        +
        string
        +
        +
        +
        +

        Generates a NOT LIKE clause

        +
        not_like(string $field, mixed $val, string $pos) : \miniMVC\DB
        +
        Inherited
        +
        +

        + + + + + + + + + +
        inherited_from\Query_Builder::not_like()
        fluentThis method is part of a fluent interface and will return the same instance
        +

        Parameters

        +
        +

        $field

        +string +
        +
        +

        $val

        +mixed +
        +
        +

        $pos

        +string +
        +

        Returns

        +
        \miniMVC\DB
        +
        +
        +
        +

        Adds a paren to the current query for query grouping, +prefixed with 'OR'

        +
        or_group_start() : \miniMVC\DB
        +
        Inherited
        +
        +

        + + + + + + + + + +
        inherited_from\Query_Builder::or_group_start()
        fluentThis method is part of a fluent interface and will return the same instance
        +

        Returns

        +
        \miniMVC\DB
        +
        +
        +
        +

        Generates a 'Having' clause prefixed with 'OR'

        +
        or_having(mixed $key, mixed $val) : \miniMVC\DB
        +
        Inherited
        +
        +

        + + + + + + + + + +
        inherited_from\Query_Builder::or_having()
        fluentThis method is part of a fluent interface and will return the same instance
        +

        Parameters

        +
        +

        $key

        +mixed +
        +
        +

        $val

        +mixed +
        +

        Returns

        +
        \miniMVC\DB
        +
        +
        +
        +

        Generates an OR Like clause

        +
        or_like(string $field, mixed $val, string $pos) : \miniMVC\DB
        +
        Inherited
        +
        +

        + + + + + + + + + +
        inherited_from\Query_Builder::or_like()
        fluentThis method is part of a fluent interface and will return the same instance
        +

        Parameters

        +
        +

        $field

        +string +
        +
        +

        $val

        +mixed +
        +
        +

        $pos

        +string +
        +

        Returns

        +
        \miniMVC\DB
        +
        +
        +
        +

        Adds a paren to the current query for query grouping, +prefixed with 'OR NOT'

        +
        or_not_group_start() : \miniMVC\DB
        +
        Inherited
        +
        +

        + + + + + + + + + +
        inherited_from\Query_Builder::or_not_group_start()
        fluentThis method is part of a fluent interface and will return the same instance
        +

        Returns

        +
        \miniMVC\DB
        +
        +
        +
        +

        Generates a OR NOT LIKE clause

        +
        or_not_like(string $field, mixed $val, string $pos) : \miniMVC\DB
        +
        Inherited
        +
        +

        + + + + + + + + + +
        inherited_from\Query_Builder::or_not_like()
        fluentThis method is part of a fluent interface and will return the same instance
        +

        Parameters

        +
        +

        $field

        +string +
        +
        +

        $val

        +mixed +
        +
        +

        $pos

        +string +
        +

        Returns

        +
        \miniMVC\DB
        +
        +
        +
        +

        Where clause prefixed with "OR"

        +
        or_where(string $key, mixed $val) : \miniMVC\DB
        +
        Inherited
        +
        +

        + + + + + + + + + +
        inherited_from\Query_Builder::or_where()
        fluentThis method is part of a fluent interface and will return the same instance
        +

        Parameters

        +
        +

        $key

        +string +
        +
        +

        $val

        +mixed +
        +

        Returns

        +
        \miniMVC\DB
        +
        +
        +
        +

        Where in statement prefixed with "or"

        +
        or_where_in(string $field, mixed $val) : \miniMVC\DB
        +
        Inherited
        +
        +

        + + + + + + + + + +
        inherited_from\Query_Builder::or_where_in()
        fluentThis method is part of a fluent interface and will return the same instance
        +

        Parameters

        +
        +

        $field

        +string +
        +
        +

        $val

        +mixed +
        +

        Returns

        +
        \miniMVC\DB
        +
        +
        +
        +

        OR WHERE NOT IN (FOO) clause

        +
        or_where_not_in(string $field, mixed $val) : \miniMVC\DB
        +
        Inherited
        +
        +

        + + + + + + + + + +
        inherited_from\Query_Builder::or_where_not_in()
        fluentThis method is part of a fluent interface and will return the same instance
        +

        Parameters

        +
        +

        $field

        +string +
        +
        +

        $val

        +mixed +
        +

        Returns

        +
        \miniMVC\DB
        +
        +
        +
        +

        Order the results by the selected field(s)

        +
        order_by(string $field, string $type) : \miniMVC\DB
        +
        Inherited
        +
        +

        + + + + + + + + + +
        inherited_from\Query_Builder::order_by()
        fluentThis method is part of a fluent interface and will return the same instance
        +

        Parameters

        +
        +

        $field

        +string +
        +
        +

        $type

        +string +
        +

        Returns

        +
        \miniMVC\DB
        +
        +
        +
        +

        Specifies rows to select in a query

        +
        select(string $fields) : \miniMVC\DB
        +
        Inherited
        +
        +

        + + + + + + + + + +
        inherited_from\Query_Builder::select()
        fluentThis method is part of a fluent interface and will return the same instance
        +

        Parameters

        +
        +

        $fields

        +string +
        +

        Returns

        +
        \miniMVC\DB
        +
        +
        +
        +

        Selects the average value of a field from a query

        +
        select_avg(string $field, string $as) : \miniMVC\DB
        +
        Inherited
        +
        +

        + + + + + + + + + +
        inherited_from\Query_Builder::select_avg()
        fluentThis method is part of a fluent interface and will return the same instance
        +

        Parameters

        +
        +

        $field

        +string +
        +
        +

        $as

        +string +
        +

        Returns

        +
        \miniMVC\DB
        +
        +
        +
        +

        Selects the maximum value of a field from a query

        +
        select_max(string $field, string $as) : \miniMVC\DB
        +
        Inherited
        +
        +

        + + + + + + + + + +
        inherited_from\Query_Builder::select_max()
        fluentThis method is part of a fluent interface and will return the same instance
        +

        Parameters

        +
        +

        $field

        +string +
        +
        +

        $as

        +string +
        +

        Returns

        +
        \miniMVC\DB
        +
        +
        +
        +

        Selects the minimum value of a field from a query

        +
        select_min(string $field, string $as) : \miniMVC\DB
        +
        Inherited
        +
        +

        + + + + + + + + + +
        inherited_from\Query_Builder::select_min()
        fluentThis method is part of a fluent interface and will return the same instance
        +

        Parameters

        +
        +

        $field

        +string +
        +
        +

        $as

        +string +
        +

        Returns

        +
        \miniMVC\DB
        +
        +
        +
        +

        Selects the sum of a field from a query

        +
        select_sum(string $field, string $as) : \miniMVC\DB
        +
        Inherited
        +
        +

        + + + + + + + + + +
        inherited_from\Query_Builder::select_sum()
        fluentThis method is part of a fluent interface and will return the same instance
        +

        Parameters

        +
        +

        $field

        +string +
        +
        +

        $as

        +string +
        +

        Returns

        +
        \miniMVC\DB
        +
        +
        +
        +

        Sets values for inserts / updates / deletes

        +
        set(mixed $key, mixed $val) : \miniMVC\DB
        +
        Inherited
        +
        +

        + + + + + + + + + +
        inherited_from\Query_Builder::set()
        fluentThis method is part of a fluent interface and will return the same instance
        +

        Parameters

        +
        +

        $key

        +mixed +
        +
        +

        $val

        +mixed +
        +

        Returns

        +
        \miniMVC\DB
        +
        +
        +
        +

        Creates an update clause, and executes it

        +
        update(string $table, mixed $data) : mixed
        +
        Inherited
        +
        +

        + + + +
        inherited_from\Query_Builder::update()
        +

        Parameters

        +
        +

        $table

        +string +
        +
        +

        $data

        +mixed +
        +

        Returns

        +
        mixed
        +
        +
        +
        +

        Specify condition(s) in the where clause of a query +Note: this function works with key / value, or a +passed array with key / value pairs

        +
        where(mixed $key, mixed $val) : \miniMVC\DB
        +
        Inherited
        +
        +

        + + + + + + + + + +
        inherited_from\Query_Builder::where()
        fluentThis method is part of a fluent interface and will return the same instance
        +

        Parameters

        +
        +

        $key

        +mixed +
        +
        +

        $val

        +mixed +
        +

        Returns

        +
        \miniMVC\DB
        +
        +
        +
        +

        Where clause with 'IN' statement

        +
        where_in(mixed $field, mixed $val) : \miniMVC\DB
        +
        Inherited
        +
        +

        + + + + + + + + + +
        inherited_from\Query_Builder::where_in()
        fluentThis method is part of a fluent interface and will return the same instance
        +

        Parameters

        +
        +

        $field

        +mixed +
        +
        +

        $val

        +mixed +
        +

        Returns

        +
        \miniMVC\DB
        +
        +
        +
        +

        WHERE NOT IN (FOO) clause

        +
        where_not_in(string $field, mixed $val) : \miniMVC\DB
        +
        Inherited
        +
        +

        + + + + + + + + + +
        inherited_from\Query_Builder::where_not_in()
        fluentThis method is part of a fluent interface and will return the same instance
        +

        Parameters

        +
        +

        $field

        +string +
        +
        +

        $val

        +mixed +
        +

        Returns

        +
        \miniMVC\DB
        +
        +
        +
        +

        String together the sql statements for sending to the db

        +
        _compile(string $type, string $table) : \$string
        +
        Inherited
        +
        +

        + + + +
        inherited_from\Query_Builder::_compile()
        +

        Parameters

        +
        +

        $type

        +string +
        +
        +

        $table

        +string +
        +

        Returns

        +
        \$string
        +
        +
        +
        +

        Simplify building having clauses

        +
        _having(mixed $key, mixed $val, string $conj) : \miniMVC\DB
        +
        Inherited
        +
        +

        + + + + + + + + + +
        inherited_from\Query_Builder::_having()
        fluentThis method is part of a fluent interface and will return the same instance
        +

        Parameters

        +
        +

        $key

        +mixed +
        +
        +

        $val

        +mixed +
        +
        +

        $conj

        +string +
        +

        Returns

        +
        \miniMVC\DB
        +
        +
        +
        +

        Simplify 'like' methods

        +
        _like(string $field, mixed $val, string $pos, string $like, string $conj) : \miniMVC\DB
        +
        Inherited
        +
        +

        + + + + + + + + + +
        inherited_from\Query_Builder::_like()
        fluentThis method is part of a fluent interface and will return the same instance
        +

        Parameters

        +
        +

        $field

        +string +
        +
        +

        $val

        +mixed +
        +
        +

        $pos

        +string +
        +
        +

        $like

        +string +
        +
        +

        $conj

        +string +
        +

        Returns

        +
        \miniMVC\DB
        +
        +
        +
        +

        Clear out the class variables, so the next query can be run

        +
        _reset() : void
        +
        Inherited
        +
        +

        + + + +
        inherited_from\Query_Builder::_reset()
        +
        +
        +
        +

        Method to simplify select_ methods

        +
        _select(string $field, string $as) : string
        +
        Inherited
        +
        +

        + + + +
        inherited_from\Query_Builder::_select()
        +

        Parameters

        +
        +

        $field

        +string +
        +
        +

        $as

        +string +
        +

        Returns

        +
        string
        +
        +
        +
        +

        Do all the repeditive stuff for where/having type methods

        +
        _where(mixed $key, mixed $val) : array
        +
        Inherited
        +
        +

        + + + +
        inherited_from\Query_Builder::_where()
        +

        Parameters

        +
        +

        $key

        +mixed +
        +
        +

        $val

        +mixed +
        +

        Returns

        +
        array
        +
        +
        +
        +

        Simplify where_in methods

        +
        _where_in(mixed $key, mixed $val, $in, $conj) : \miniMVC\DB
        +
        Inherited
        +
        +

        + + + + + + + + + +
        inherited_from\Query_Builder::_where_in()
        fluentThis method is part of a fluent interface and will return the same instance
        +

        Parameters

        +
        +

        $key

        +mixed +
        +
        +

        $val

        +mixed +
        +
        +

        $in

        +

        string

        +
        +

        $conj

        +

        string

        +

        Returns

        +
        \miniMVC\DB
        +
        +
        +
        +

        Simplify generating where string

        +
        _where_string(mixed $key, mixed $val, string $conj) : \miniMVC\DB
        +
        Inherited
        +
        +

        + + + + + + + + + +
        inherited_from\Query_Builder::_where_string()
        fluentThis method is part of a fluent interface and will return the same instance
        +

        Parameters

        +
        +

        $key

        +mixed +
        +
        +

        $val

        +mixed +
        +
        +

        $conj

        +string +
        +

        Returns

        +
        \miniMVC\DB
        +
        +

         Properties

        + 
        +

        Convenience property for connection management

        +
        $conn_name : string
        +
        Inherited
        +
        +

        + + + +
        inherited_from\Query_Builder::$$conn_name
        +
        +
        + 
        +

        Alias to $this->db->sql

        +
        $sql : \DB_PDO
        +
        Inherited
        +
        +

        + + + +
        inherited_from\Query_Builder::$$sql
        +
        +
        + 
        +

        Compiled 'from' clause

        +
        $from_string : string
        +
        Inherited
        +
        +

        + + + +
        inherited_from\Query_Builder::$$from_string
        +
        +
        + 
        +

        Key/val pairs for group by clause

        +
        $group_array : array
        +
        Inherited
        +
        +

        + + + +
        inherited_from\Query_Builder::$$group_array
        +
        +
        + 
        +

        Group by clause

        +
        $group_string : string
        +
        Inherited
        +
        +

        + + + +
        inherited_from\Query_Builder::$$group_string
        +
        +
        + 
        +

        Map for having clause

        +
        $having_map : array
        +
        Inherited
        +
        +

        + + + +
        inherited_from\Query_Builder::$$having_map
        +
        +
         

        DB connection instances

        $instance : array

        + 
        +

        Value for limit string

        +
        $limit : int
        +
        Inherited
        +
        +

        + + + +
        inherited_from\Query_Builder::$$limit
        +
        +
        + 
        +

        Value for offset in limit string

        +
        $offset : int
        +
        Inherited
        +
        +

        + + + +
        inherited_from\Query_Builder::$$offset
        +
        +
        + 
        +

        Key/val pairs for order by clause

        +
        $order_array : array
        +
        Inherited
        +
        +

        + + + +
        inherited_from\Query_Builder::$$order_array
        +
        +
        + 
        +

        Order by clause

        +
        $order_string : string
        +
        Inherited
        +
        +

        + + + +
        inherited_from\Query_Builder::$$order_string
        +
        +
        + 
        +

        Query component order mapping +for complex select queries

        +
        $query_map : array
        +
        Inherited
        +
        +

        Format:

        + +

        array( + 'type' => 'where', + 'conjunction' => ' AND ', + 'string' => 'k=?' +)

        + + + +
        inherited_from\Query_Builder::$$query_map
        +
        +
        + 
        +

        Compiled 'select' clause

        +
        $select_string : string
        +
        Inherited
        +
        +

        + + + +
        inherited_from\Query_Builder::$$select_string
        +
        +
        + 
        +

        Keys for insert/update statement

        +
        $set_array_keys : array
        +
        Inherited
        +
        +

        + + + +
        inherited_from\Query_Builder::$$set_array_keys
        +
        +
        + 
        +

        Compiled arguments for insert / update

        +
        $set_string : string
        +
        Inherited
        +
        +

        + + + +
        inherited_from\Query_Builder::$$set_string
        +
        +
        + 
        +

        Values to apply to prepared statements

        +
        $values : array
        +
        Inherited
        +
        +

        + + + +
        inherited_from\Query_Builder::$$values
        +
        +
        @@ -134,7 +1604,7 @@
        + generated on 2012-06-06T16:50:21-04:00.
        diff --git a/docs/classes/miniMVC.Data_Store.html b/docs/classes/miniMVC.Data_Store.html index 00a89f4..66bb296 100644 --- a/docs/classes/miniMVC.Data_Store.html +++ b/docs/classes/miniMVC.Data_Store.html @@ -21,6 +21,7 @@ API Documentation @@ -34,7 +35,9 @@
      •  Errors  0
      •  Markers  -
          • +
        •  Deprecated elements  0
          • @@ -204,7 +207,7 @@ of the singleton
          + generated on 2012-06-06T16:50:21-04:00.
          diff --git a/docs/classes/miniMVC.MM.html b/docs/classes/miniMVC.MM.html index 47ae1bc..673774e 100644 --- a/docs/classes/miniMVC.MM.html +++ b/docs/classes/miniMVC.MM.html @@ -21,6 +21,7 @@ API Documentation @@ -34,7 +35,9 @@
        •  Errors  0
        •  Markers  -
            • +
          •  Deprecated elements  0
            • @@ -442,7 +445,7 @@ dynamic methods
            + generated on 2012-06-06T16:50:21-04:00.
            diff --git a/docs/classes/miniMVC.Model.html b/docs/classes/miniMVC.Model.html index 031b706..0ec7941 100644 --- a/docs/classes/miniMVC.Model.html +++ b/docs/classes/miniMVC.Model.html @@ -21,6 +21,7 @@ API Documentation @@ -34,7 +35,9 @@
          •  Errors  0
          •  Markers  -
              • +
            •  Deprecated elements  0
              • @@ -699,7 +702,7 @@ dynamic methods
              + generated on 2012-06-06T16:50:21-04:00.
              diff --git a/docs/classes/miniMVC.Output.html b/docs/classes/miniMVC.Output.html index cbf714b..74b1f51 100644 --- a/docs/classes/miniMVC.Output.html +++ b/docs/classes/miniMVC.Output.html @@ -21,6 +21,7 @@ API Documentation @@ -34,7 +35,9 @@
            •  Errors  0
            •  Markers  -
                • +
              •  Deprecated elements  0
                • @@ -648,7 +651,7 @@ Used for outputing HTML
                + generated on 2012-06-06T16:50:21-04:00.
                diff --git a/docs/classes/miniMVC.Page.html b/docs/classes/miniMVC.Page.html index a62bb1b..f7164bd 100644 --- a/docs/classes/miniMVC.Page.html +++ b/docs/classes/miniMVC.Page.html @@ -21,6 +21,7 @@ API Documentation @@ -34,7 +35,9 @@
              •  Errors  0
              •  Markers  -
                  • +
                •  Deprecated elements  0
                  • @@ -1174,7 +1177,7 @@ supports

                  + generated on 2012-06-06T16:50:21-04:00.
                  diff --git a/docs/classes/miniMVC.Session.html b/docs/classes/miniMVC.Session.html index ea99494..8eeb358 100644 --- a/docs/classes/miniMVC.Session.html +++ b/docs/classes/miniMVC.Session.html @@ -21,6 +21,7 @@ API Documentation @@ -34,7 +35,9 @@
                •  Errors  0
                •  Markers  -
                    • +
                  •  Deprecated elements  0
                    • @@ -152,7 +155,7 @@
                    + generated on 2012-06-06T16:50:21-04:00.
                    diff --git a/docs/classes/miniMVC.miniMVC.html b/docs/classes/miniMVC.miniMVC.html index aed8823..7e7c5b5 100644 --- a/docs/classes/miniMVC.miniMVC.html +++ b/docs/classes/miniMVC.miniMVC.html @@ -21,6 +21,7 @@ API Documentation @@ -34,7 +35,9 @@
                  •  Errors  0
                  •  Markers  -
                      • +
                    •  Deprecated elements  0
                      • @@ -601,7 +604,7 @@ dynamic methods
                      + generated on 2012-06-06T16:50:21-04:00.
                      diff --git a/docs/deprecated.html b/docs/deprecated.html index f6440c3..abb4502 100644 --- a/docs/deprecated.html +++ b/docs/deprecated.html @@ -21,6 +21,7 @@ API Documentation @@ -34,7 +35,9 @@
                    •  Errors  0
                    •  Markers  -
                        • +
                      •  Deprecated elements  0
                        • @@ -66,7 +69,7 @@
                        + generated on 2012-06-06T16:50:21-04:00.
                        diff --git a/docs/errors.html b/docs/errors.html index 09cfcec..0be3b35 100644 --- a/docs/errors.html +++ b/docs/errors.html @@ -21,6 +21,7 @@ API Documentation @@ -34,7 +35,9 @@
                      •  Errors  0
                      •  Markers  -
                          • +
                        •  Deprecated elements  0
                          • @@ -78,12 +81,33 @@
                          +
                          +
                          +
                          +
                          +
                          +
                          +
                          +
                          +
                          +
                          +
                          +
                          +
                          +
                          +
                          +
                          +
                          +
                          +
                          +
                          +
                          + generated on 2012-06-06T16:50:21-04:00.
                          diff --git a/docs/graph_class.html b/docs/graph_class.html index 2fa6ba8..35b2517 100644 --- a/docs/graph_class.html +++ b/docs/graph_class.html @@ -21,6 +21,7 @@ API Documentation @@ -34,7 +35,9 @@
                        •  Errors  0
                        •  Markers  -
                            • +
                          •  Deprecated elements  0
                            • @@ -63,7 +66,7 @@
                            + generated on 2012-06-06T16:50:21-04:00.
                            diff --git a/docs/index.html b/docs/index.html index 0a7b6a4..89cd6ec 100644 --- a/docs/index.html +++ b/docs/index.html @@ -21,6 +21,7 @@ API Documentation @@ -34,7 +35,9 @@
                          •  Errors  0
                          •  Markers  -
                              • +
                            •  Deprecated elements  0
                              • @@ -56,11 +59,13 @@
                              @@ -75,7 +80,9 @@
                            •  Errors  0
                            •  Markers  -
                                • +
                              •  Deprecated elements  0
                                • @@ -84,7 +91,7 @@
                                + generated on 2012-06-06T16:50:20-04:00.
                                diff --git a/docs/markers.html b/docs/markers.html index 98813f8..f9bf41d 100644 --- a/docs/markers.html +++ b/docs/markers.html @@ -21,6 +21,7 @@ API Documentation @@ -34,7 +35,9 @@
                              •  Errors  0
                              •  Markers  -
                                  • +
                                •  Deprecated elements  0
                                  • @@ -49,7 +52,14 @@ if Javascript is enabled.
                                  -
                                  • Navigation
                                  +
                                  • @@ -57,18 +67,105 @@
                                  • Markers
                                  -
                                  No markers have been found in this project.
                                  The following markers were found: -
                                    +
                                    • todo  + 5 +
                                    +
                                    +
                                    +
                                    +

                                    +sys/db/classes/query_builder.php1 +

                                    +
                                    + + + + + + + + + + +
                                    TypeLineDescription
                                    todo805make able to handle operators without spaces
                                    +
                                    +
                                    +

                                    +sys/db/drivers/pgsql/pgsql_util.php1 +

                                    +
                                    + + + + + + + + + + +
                                    TypeLineDescription
                                    todo114Implement Backup function
                                    +
                                    +
                                    +

                                    +sys/db/drivers/pgsql/pgsql_driver.php1 +

                                    +
                                    + + + + + + + + + + +
                                    TypeLineDescription
                                    todo46Implement
                                    +
                                    +
                                    +

                                    +sys/db/drivers/mysql/mysql_driver.php1 +

                                    +
                                    + + + + + + + + + + +
                                    TypeLineDescription
                                    todo57Implement
                                    +
                                    +
                                    +

                                    +sys/db/drivers/firebird/firebird_util.php1 +

                                    +
                                    + + + + + + + + + + +
                                    TypeLineDescription
                                    todo117Implement Backup structure function
                                    +
                                    -
                                    + generated on 2012-06-06T16:50:21-04:00.
                                    diff --git a/docs/namespaces/default.html b/docs/namespaces/default.html new file mode 100644 index 0000000..cf00674 --- /dev/null +++ b/docs/namespaces/default.html @@ -0,0 +1,290 @@ + + + + + +miniMVC » default + + + + + + + + + +
                                    +
                                    +miniMVC
                                    +
                                    +
                                    Back to top  
                                    +
                                    +
                                    + +
                                    +
                                    +
                                    + +
                                    + +
                                    +
                                    + +
                                    +

                                    + Functions

                                    +
                                    +

                                    Filter out db rows into one array

                                    +
                                    db_filter(array $array, mixed $index) : array
                                    +
                                    +
                                    +

                                    +

                                    Parameters

                                    +
                                    +

                                    $array

                                    +array +
                                    +
                                    +

                                    $index

                                    +mixed +
                                    +

                                    Returns

                                    +
                                    array
                                    +
                                    +
                                    +
                                    +

                                    Bulk directory loading workaround for use +with array_map and glob

                                    +
                                    do_include(string $path) : void
                                    +
                                    +
                                    +

                                    +

                                    Parameters

                                    +
                                    +

                                    $path

                                    +string +
                                    +
                                    +
                                    +
                                    +

                                    Load a Query class

                                    +
                                    query_autoload(string $class) 
                                    +
                                    +
                                    +

                                    +

                                    Parameters

                                    +
                                    +

                                    $class

                                    +string +
                                    +
                                    +
                                    +

                                    + Classes and interfaces

                                    +
                                    +

                                    DB_PDO +

                                    +

                                    Base Database class

                                    +
                                    +« More » +
                                    +
                                    +

                                    DB_SQL +

                                    +

                                    Abstract parent for database manipulation subclasses

                                    +
                                    +« More » +
                                    +
                                    +

                                    DB_Util +

                                    +

                                    Abstract class defining database / table creation methods

                                    +
                                    +« More » +
                                    +
                                    +

                                    Firebird +

                                    +

                                    Firebird Database class

                                    +
                                    +« More » +
                                    +
                                    +

                                    Firebird_Result +

                                    +

                                    Firebird result class to emulate PDOStatement Class - only implements +data-fetching methods

                                    +
                                    +« More » +
                                    +
                                    +

                                    Firebird_SQL +

                                    +

                                    Firebird Specific SQL

                                    +
                                    +« More » +
                                    +
                                    +

                                    Firebird_Util +

                                    +

                                    Firebird-specific backup, import and creation methods

                                    +
                                    +« More » +
                                    +
                                    +

                                    MySQL +

                                    +

                                    MySQL specific class

                                    +
                                    +« More » +
                                    +
                                    +

                                    MySQL_SQL +

                                    +

                                    MySQL specifc SQL

                                    +
                                    +« More » +
                                    +
                                    +

                                    MySQL_Util +

                                    +

                                    MySQL-specific backup, import and creation methods

                                    +
                                    +« More » +
                                    +
                                    +

                                    ODBC +

                                    +

                                    ODBC Database Driver

                                    +
                                    +« More » +
                                    +
                                    +

                                    ODBC_SQL +

                                    +

                                    ODBC SQL Class

                                    +
                                    +« More » +
                                    +
                                    +

                                    ODBC_Util +

                                    +

                                    ODBC-specific backup, import and creation methods

                                    +
                                    +« More » +
                                    +
                                    +

                                    PgSQL +

                                    +

                                    PostgreSQL specifc class

                                    +
                                    +« More » +
                                    +
                                    +

                                    PgSQL_SQL +

                                    +

                                    PostgreSQL specifc SQL

                                    +
                                    +« More » +
                                    +
                                    +

                                    PgSQL_Util +

                                    +

                                    Posgres-specific backup, import and creation methods

                                    +
                                    +« More » +
                                    +
                                    +

                                    Query_Builder +

                                    +

                                    Convienience class for creating sql queries - also the class that +instantiates the specific db driver

                                    +
                                    +« More » +
                                    +
                                    +

                                    SQLite +

                                    +

                                    SQLite specific class

                                    +
                                    +« More » +
                                    +
                                    +

                                    SQLite_SQL +

                                    +

                                    SQLite Specific SQL

                                    +
                                    +« More » +
                                    +
                                    +

                                    SQLite_Util +

                                    +

                                    SQLite-specific backup, import and creation methods

                                    +
                                    +« More » +
                                    +

                                    + Constants

                                    + 
                                    +

                                    Reference to root path

                                    +
                                    QBASE_PATH 
                                    +
                                    +

                                    +
                                    + 
                                    +

                                    Path to driver classes

                                    +
                                    QDRIVER_PATH 
                                    +
                                    +

                                    +
                                    +
                                    +
                                    +
                                    +
                                    +
                                    + + diff --git a/docs/namespaces/miniMVC.html b/docs/namespaces/miniMVC.html index ecd11b8..aaff546 100644 --- a/docs/namespaces/miniMVC.html +++ b/docs/namespaces/miniMVC.html @@ -21,6 +21,7 @@ API Documentation @@ -34,7 +35,9 @@
                                  •  Errors  0
                                  •  Markers  -
                                      • +
                                    •  Deprecated elements  0
                                      • @@ -151,9 +154,9 @@
                                      string
                                      -
                                      -

                                      Function to autoload libraries/classes

                                      -
                                      autoload($name) 
                                      +
                                      +

                                      Function to autoload system libraries

                                      +
                                      _autoload($name) 

                                      @@ -314,18 +317,6 @@ display them cleanly
                                      string
                                      -
                                      -

                                      Function to autoload system libraries

                                      -
                                      sys_autoload($name) 
                                      -
                                      -
                                      -

                                      -

                                      Parameters

                                      -
                                      -

                                      $name

                                      -

                                      string

                                      -
                                      -

                                      Prints out the contents of the object

                                      to_string(\miniMVC\object/array $data, string $method) : string
                                      @@ -448,7 +439,7 @@ display them cleanly
                                      + generated on 2012-06-06T16:50:20-04:00.
                                      diff --git a/docs/packages/.html b/docs/packages/.html index fe7edcd..24ad27b 100644 --- a/docs/packages/.html +++ b/docs/packages/.html @@ -21,6 +21,7 @@ API Documentation @@ -34,7 +35,9 @@
                                    •  Errors  0
                                    •  Markers  -
                                        • +
                                      •  Deprecated elements  0
                                        • @@ -66,7 +69,7 @@
                                        + generated on 2012-06-06T16:50:20-04:00.
                                        diff --git a/docs/packages/Default.html b/docs/packages/Default.html index 1eae254..7b02289 100644 --- a/docs/packages/Default.html +++ b/docs/packages/Default.html @@ -21,6 +21,7 @@ API Documentation @@ -34,7 +35,9 @@
                                      •  Errors  0
                                      •  Markers  -
                                          • +
                                        •  Deprecated elements  0
                                          • @@ -66,6 +69,8 @@
                                        • MM_BASE_PATH
                                          MM_BASE_PATH
                                        • MM_MOD_PATH
                                          MM_MOD_PATH
                                        • MM_SYS_PATH
                                          MM_SYS_PATH
                                          • +
                                        • Reference to root path
                                          QBASE_PATH
                                          • +
                                        • Path to driver classes
                                          QDRIVER_PATH
                                          • @@ -108,13 +113,25 @@

                                          + 
                                          +

                                          Reference to root path

                                          +
                                          QBASE_PATH 
                                          +
                                          +

                                          +
                                          + 
                                          +

                                          Path to driver classes

                                          +
                                          QDRIVER_PATH 
                                          +
                                          +

                                          +
                                          + generated on 2012-06-06T16:50:20-04:00.
                                          diff --git a/docs/packages/Query.Drivers.html b/docs/packages/Query.Drivers.html new file mode 100644 index 0000000..5cdfd58 --- /dev/null +++ b/docs/packages/Query.Drivers.html @@ -0,0 +1,219 @@ + + + + + +miniMVC » Query\Drivers + + + + + + + + + +
                                          +
                                          +miniMVC
                                          +
                                          +
                                          Back to top  
                                          +
                                          +
                                          + +
                                          +
                                          +
                                          + +
                                          + +
                                          +
                                          + +
                                          +

                                          + Classes and interfaces

                                          +
                                          +

                                          Firebird +

                                          +

                                          Firebird Database class

                                          +
                                          +« More » +
                                          +
                                          +

                                          Firebird_Result +

                                          +

                                          Firebird result class to emulate PDOStatement Class - only implements +data-fetching methods

                                          +
                                          +« More » +
                                          +
                                          +

                                          Firebird_SQL +

                                          +

                                          Firebird Specific SQL

                                          +
                                          +« More » +
                                          +
                                          +

                                          Firebird_Util +

                                          +

                                          Firebird-specific backup, import and creation methods

                                          +
                                          +« More » +
                                          +
                                          +

                                          MySQL +

                                          +

                                          MySQL specific class

                                          +
                                          +« More » +
                                          +
                                          +

                                          MySQL_SQL +

                                          +

                                          MySQL specifc SQL

                                          +
                                          +« More » +
                                          +
                                          +

                                          MySQL_Util +

                                          +

                                          MySQL-specific backup, import and creation methods

                                          +
                                          +« More » +
                                          +
                                          +

                                          ODBC +

                                          +

                                          ODBC Database Driver

                                          +
                                          +« More » +
                                          +
                                          +

                                          ODBC_SQL +

                                          +

                                          ODBC SQL Class

                                          +
                                          +« More » +
                                          +
                                          +

                                          ODBC_Util +

                                          +

                                          ODBC-specific backup, import and creation methods

                                          +
                                          +« More » +
                                          +
                                          +

                                          PgSQL +

                                          +

                                          PostgreSQL specifc class

                                          +
                                          +« More » +
                                          +
                                          +

                                          PgSQL_SQL +

                                          +

                                          PostgreSQL specifc SQL

                                          +
                                          +« More » +
                                          +
                                          +

                                          PgSQL_Util +

                                          +

                                          Posgres-specific backup, import and creation methods

                                          +
                                          +« More » +
                                          +
                                          +

                                          SQLite +

                                          +

                                          SQLite specific class

                                          +
                                          +« More » +
                                          +
                                          +

                                          SQLite_SQL +

                                          +

                                          SQLite Specific SQL

                                          +
                                          +« More » +
                                          +
                                          +

                                          SQLite_Util +

                                          +

                                          SQLite-specific backup, import and creation methods

                                          +
                                          +« More » +
                                          +
                                          +
                                          +
                                          +
                                          +
                                          + + diff --git a/docs/packages/Query.Query.html b/docs/packages/Query.Query.html new file mode 100644 index 0000000..e7443ae --- /dev/null +++ b/docs/packages/Query.Query.html @@ -0,0 +1,123 @@ + + + + + +miniMVC » Query\Query + + + + + + + + + +
                                          +
                                          +miniMVC
                                          +
                                          +
                                          Back to top  
                                          +
                                          +
                                          + +
                                          +
                                          +
                                          + +
                                          + +
                                          +
                                          + +
                                          +

                                          + Classes and interfaces

                                          +
                                          +

                                          DB_PDO +

                                          +

                                          Base Database class

                                          +
                                          +« More » +
                                          +
                                          +

                                          DB_SQL +

                                          +

                                          Abstract parent for database manipulation subclasses

                                          +
                                          +« More » +
                                          +
                                          +

                                          DB_Util +

                                          +

                                          Abstract class defining database / table creation methods

                                          +
                                          +« More » +
                                          +
                                          +

                                          Query_Builder +

                                          +

                                          Convienience class for creating sql queries - also the class that +instantiates the specific db driver

                                          +
                                          +« More » +
                                          +
                                          +
                                          +
                                          +
                                          +
                                          + + diff --git a/docs/packages/Query.html b/docs/packages/Query.html new file mode 100644 index 0000000..4caf09a --- /dev/null +++ b/docs/packages/Query.html @@ -0,0 +1,310 @@ + + + + + +miniMVC » Query + + + + + + + + + +
                                          +
                                          +miniMVC
                                          +
                                          +
                                          Back to top  
                                          +
                                          +
                                          + +
                                          +
                                          +
                                          + +
                                          + +
                                          +
                                          + +
                                          +

                                          + Functions

                                          +
                                          +

                                          Filter out db rows into one array

                                          +
                                          db_filter(array $array, mixed $index) : array
                                          +
                                          +
                                          +

                                          +

                                          Parameters

                                          +
                                          +

                                          $array

                                          +array +
                                          +
                                          +

                                          $index

                                          +mixed +
                                          +

                                          Returns

                                          +
                                          array
                                          +
                                          +
                                          +
                                          +

                                          Bulk directory loading workaround for use +with array_map and glob

                                          +
                                          do_include(string $path) : void
                                          +
                                          +
                                          +

                                          +

                                          Parameters

                                          +
                                          +

                                          $path

                                          +string +
                                          +
                                          +
                                          +
                                          +

                                          Load a Query class

                                          +
                                          query_autoload(string $class) 
                                          +
                                          +
                                          +

                                          +

                                          Parameters

                                          +
                                          +

                                          $class

                                          +string +
                                          +
                                          +
                                          + +
                                          +

                                          + Classes and interfaces

                                          +
                                          +

                                          Firebird +

                                          +

                                          Firebird Database class

                                          +
                                          +« More » +
                                          +
                                          +

                                          Firebird_Result +

                                          +

                                          Firebird result class to emulate PDOStatement Class - only implements +data-fetching methods

                                          +
                                          +« More » +
                                          +
                                          +

                                          Firebird_SQL +

                                          +

                                          Firebird Specific SQL

                                          +
                                          +« More » +
                                          +
                                          +

                                          Firebird_Util +

                                          +

                                          Firebird-specific backup, import and creation methods

                                          +
                                          +« More » +
                                          +
                                          +

                                          MySQL +

                                          +

                                          MySQL specific class

                                          +
                                          +« More » +
                                          +
                                          +

                                          MySQL_SQL +

                                          +

                                          MySQL specifc SQL

                                          +
                                          +« More » +
                                          +
                                          +

                                          MySQL_Util +

                                          +

                                          MySQL-specific backup, import and creation methods

                                          +
                                          +« More » +
                                          +
                                          +

                                          ODBC +

                                          +

                                          ODBC Database Driver

                                          +
                                          +« More » +
                                          +
                                          +

                                          ODBC_SQL +

                                          +

                                          ODBC SQL Class

                                          +
                                          +« More » +
                                          +
                                          +

                                          ODBC_Util +

                                          +

                                          ODBC-specific backup, import and creation methods

                                          +
                                          +« More » +
                                          +
                                          +

                                          PgSQL +

                                          +

                                          PostgreSQL specifc class

                                          +
                                          +« More » +
                                          +
                                          +

                                          PgSQL_SQL +

                                          +

                                          PostgreSQL specifc SQL

                                          +
                                          +« More » +
                                          +
                                          +

                                          PgSQL_Util +

                                          +

                                          Posgres-specific backup, import and creation methods

                                          +
                                          +« More » +
                                          +
                                          +

                                          SQLite +

                                          +

                                          SQLite specific class

                                          +
                                          +« More » +
                                          +
                                          +

                                          SQLite_SQL +

                                          +

                                          SQLite Specific SQL

                                          +
                                          +« More » +
                                          +
                                          +

                                          SQLite_Util +

                                          +

                                          SQLite-specific backup, import and creation methods

                                          +
                                          +« More » +
                                          +
                                          + +
                                          +

                                          + Classes and interfaces

                                          +
                                          +

                                          DB_PDO +

                                          +

                                          Base Database class

                                          +
                                          +« More » +
                                          +
                                          +

                                          DB_SQL +

                                          +

                                          Abstract parent for database manipulation subclasses

                                          +
                                          +« More » +
                                          +
                                          +

                                          DB_Util +

                                          +

                                          Abstract class defining database / table creation methods

                                          +
                                          +« More » +
                                          +
                                          +

                                          Query_Builder +

                                          +

                                          Convienience class for creating sql queries - also the class that +instantiates the specific db driver

                                          +
                                          +« More » +
                                          +
                                          +
                                          +
                                          +
                                          +
                                          +
                                          + + diff --git a/docs/packages/miniMVC.Libraries.html b/docs/packages/miniMVC.Libraries.html index c43f702..7b13ce3 100644 --- a/docs/packages/miniMVC.Libraries.html +++ b/docs/packages/miniMVC.Libraries.html @@ -21,6 +21,7 @@ API Documentation @@ -34,7 +35,9 @@
                                        •  Errors  0
                                        •  Markers  -
                                            • +
                                          •  Deprecated elements  0
                                            • @@ -61,8 +64,8 @@
                                          • Classes
                                            • -
                                          • Data_Store
                                          • Session
                                            • +
                                          • Data_Store
                                            • @@ -96,7 +99,7 @@
                                            + generated on 2012-06-06T16:50:20-04:00.
                                            diff --git a/docs/packages/miniMVC.System.html b/docs/packages/miniMVC.System.html index c9cbb1e..69cfe69 100644 --- a/docs/packages/miniMVC.System.html +++ b/docs/packages/miniMVC.System.html @@ -21,6 +21,7 @@ API Documentation @@ -34,7 +35,9 @@
                                          •  Errors  0
                                          •  Markers  -
                                              • +
                                            •  Deprecated elements  0
                                              • @@ -136,7 +139,7 @@
                                              + generated on 2012-06-06T16:50:20-04:00.
                                              diff --git a/docs/packages/miniMVC.html b/docs/packages/miniMVC.html index b41b328..978dae7 100644 --- a/docs/packages/miniMVC.html +++ b/docs/packages/miniMVC.html @@ -21,6 +21,7 @@ API Documentation @@ -34,7 +35,9 @@
                                            •  Errors  0
                                            •  Markers  -
                                                • +
                                              •  Deprecated elements  0
                                                • @@ -75,7 +78,7 @@
                                              • PHP magic method that is called when an object is treated as a function
                                                __invoke
                                              • PHP magic method that is called when an object is treated as a function
                                                __invoke
                                              • Prints out the contents of the object when used as a string
                                                __toString
                                                • -
                                              • Function to autoload libraries/classes
                                                autoload
                                                • +
                                              • Function to autoload system libraries
                                                _autoload
                                              • Returns routable methods for the specified controller class
                                                controller_methods
                                              • Array_map callback to load a folder of classes at once
                                                do_include
                                              • Singleton getter function
                                                get_instance
                                                • @@ -92,7 +95,6 @@ display them cleanly">Function to run on script shutdo -used to catch most fatal errors, and display them cleanly
                                                shutdown
                                              • Returns a full url from a url segment
                                                site_url
                                                • -
                                              • Function to autoload system libraries
                                                sys_autoload
                                              • Prints out the contents of the object
                                                to_string
                                                • @@ -186,9 +188,9 @@ display them cleanly
                                                shutdown
                                                string
                                                -
                                                -

                                                Function to autoload libraries/classes

                                                -
                                                autoload($name) 
                                                +
                                                +

                                                Function to autoload system libraries

                                                +
                                                _autoload($name) 

                                                @@ -349,18 +351,6 @@ display them cleanly
                                                string
                                                -
                                                -

                                                Function to autoload system libraries

                                                -
                                                sys_autoload($name) 
                                                -
                                                -
                                                -

                                                -

                                                Parameters

                                                -
                                                -

                                                $name

                                                -

                                                string

                                                -
                                                -

                                                Prints out the contents of the object

                                                to_string(\miniMVC\object/array $data, string $method) : string
                                                @@ -471,7 +461,7 @@ display them cleanly
                                                + generated on 2012-06-06T16:50:20-04:00.
                                                diff --git a/docs/structure.xml b/docs/structure.xml index 36ee117..7006fd2 100644 --- a/docs/structure.xml +++ b/docs/structure.xml @@ -1,13 +1,5145 @@ - + + + + Free Query Builder / Database Abstraction Layer

                                                ]]>                                                 + + + + + +                                                 + + DB_SQL + \DB_SQL + + + + + + + + + max + function + + + + + string + + + + + min + function + + + + + string + + + + + distinct + function + + + + + string + + + + + avg + function + + + + + string + + + + + sum + function + + + + + string + + + + + limit + function + + + + + + string + + + int + + + int + + + string + + + + $sql + + + + + $limit + + + + + $offset + + + + + + random + function + + + + + + string + + + + + db_list + function + + + + + string + + + + + table_list + function + + + + + string + + + + + system_table_list + function + + + + + string + + + + + view_list + function + + + + + string + + + + + trigger_list + function + + + + + string + + + + + function_list + function + + + + + FALSE + + + + + procedure_list + function + + + + + string + + + + + sequence_list + function + + + + + string + + + + + type_list + function + + + + + mixed + + + + + column_list + function + + + + + + string + + + + $table + + + + + +                                                 + + + + Free Query Builder / Database Abstraction Layer

                                                ]]>                                                 + + + + + +                                                 + + DB_PDO + \DB_PDO + \PDO + + + Extends PDO to simplify cross-database issues

                                                ]]>                                                 + + +                                                 + + $statement + + + + + + mixed + + + + + $escape_char + + + + + + string + + + + + $sql + + + + + + Object + + + + + $util + + + + + + Object + + + + + __construct + function + + + + + string + + + string + + + string + + + array + + + + $dsn + + + + + $username + + + + + $password + + + + + $driver_options + + + + + + prepare_query + function + + + + + string + + + array + + + mixed + + + + $sql + + + + + $data + + + + + + prepare_execute + function + + + + + string + + + array + + + \PDOStatement + + + + $sql + + + + + $params + + + + + + get_query_data + function + + + + + \PDOStatement + + + array + + + + $statement + + + + + + affected_rows + function + + + + + \PDOStatement + + + int + + + + $statement + + + + + + get_last_error + function + + + + + string + + + + + quote_ident + function + + + + + mixed + + + string + + + + $ident + + + + + + _quote + function + + + + + mixed + + + mixed + + + + $str + + + + + + empty_table + function + + + + + string + + + mixed + + + + $table + + + + + + get_schemas + function + + + + + array + + + + + get_tables + function + + + + + array + + + + + get_dbs + function + + + + + array + + + + + get_views + function + + + + + array + + + + + get_sequences + function + + + + + array + + + + + get_functions + function + + + + + array + + + + + get_procedures + function + + + + + array + + + + + get_triggers + function + + + + + array + + + + + get_system_tables + function + + + + + array + + + + + get_columns + function + + + + + string + + + array + + + + $table + + + + + + get_types + function + + + + + array + + + + + driver_query + function + + + + + string + + + bool + + + mixed + + + + $sql + + + + + $filtered_index + + + + + + num_rows + function + + + + + int + + + + + truncate + function + + + + + string + + + void + + + + $table + + + + + + switch_db + function + + + + + string + + + void + + + + $name + + + + +                                                 +                                                 + + + + Free Query Builder / Database Abstraction Layer

                                                ]]>                                                 + + + + + +                                                 + + make able to handle operators without spaces + + + Query_Builder + \Query_Builder + + + + + + + + + $select_string + + + + + + string + + + + + $from_string + + + + + + string + + + + + $set_string + + + + + + string + + + + + $order_string + + + + + + string + + + + + $group_string + + + + + + string + + + + + $set_array_keys + + + + + + array + + + + + $order_array + + + + + + array + + + + + $group_array + + + + + + array + + + + + $values + + + + + + array + + + + + $limit + + + + + + int + + + + + $offset + + + + + + int + + + + + $sql + + + db->sql]]> + + + \DB_PDO + + + + + $query_map + + + + Format:

                                                + +

                                                array( + 'type' => 'where', + 'conjunction' => ' AND ', + 'string' => 'k=?' +)

                                                ]]>                                                 + + array + +                                                 +                                                 + + $having_map + + + + + + array + + + + + $conn_name + + + + + + string + + + + + __construct + function + + + + + object + + + + $params + + + + + + select + function + + + + + string + + + \$this + + + + $fields + + + + + + _select + function + + + + + string + + + string + + + string + + + + $field + + + + + $as + + + + + + select_max + function + + + + + string + + + string + + + \$this + + + + $field + + + + + $as + + + + + + select_min + function + + + + + string + + + string + + + \$this + + + + $field + + + + + $as + + + + + + select_avg + function + + + + + string + + + string + + + \$this + + + + $field + + + + + $as + + + + + + select_sum + function + + + + + string + + + string + + + \$this + + + + $field + + + + + $as + + + + + + distinct + function + + + + + \$this + + + + + from + function + + + + + string + + + \$this + + + + $dbname + + + + + + _like + function + + + + + string + + + mixed + + + string + + + string + + + string + + + \$this + + + + $field + + + + + $val + + + + + $pos + + + + + $like + + + + + $conj + + + + + + like + function + + + + + string + + + mixed + + + string + + + \$this + + + + $field + + + + + $val + + + + + $pos + + + + + + or_like + function + + + + + string + + + mixed + + + string + + + \$this + + + + $field + + + + + $val + + + + + $pos + + + + + + not_like + function + + + + + string + + + mixed + + + string + + + \$this + + + + $field + + + + + $val + + + + + $pos + + + + + + or_not_like + function + + + + + string + + + mixed + + + string + + + \$this + + + + $field + + + + + $val + + + + + $pos + + + + + + _having + function + + + + + mixed + + + mixed + + + string + + + \$this + + + + $key + + + + + $val + + + + + $conj + + + + + + having + function + + + + + mixed + + + mixed + + + \$this + + + + $key + + + + + $val + + + + + + or_having + function + + + + + mixed + + + mixed + + + \$this + + + + $key + + + + + $val + + + + + + _where + function + + + + + mixed + + + mixed + + + array + + + + $key + + + + + $val + + + + + + _where_string + function + + + + + mixed + + + mixed + + + string + + + \$this + + + + $key + + + + + $val + + + + + $conj + + + + + + _where_in + function + + + + + mixed + + + mixed + + + + + \$this + + + + $key + + + + + $val + + + + + $in + + + + + $conj + + + + + + where + function + + + + + mixed + + + mixed + + + \$this + + + + $key + + + + + $val + + + + + + or_where + function + + + + + string + + + mixed + + + \$this + + + + $key + + + + + $val + + + + + + where_in + function + + + + + mixed + + + mixed + + + \$this + + + + $field + + + + + $val + + + + + + or_where_in + function + + + + + string + + + mixed + + + \$this + + + + $field + + + + + $val + + + + + + where_not_in + function + + + + + string + + + mixed + + + \$this + + + + $field + + + + + $val + + + + + + or_where_not_in + function + + + + + string + + + mixed + + + \$this + + + + $field + + + + + $val + + + + + + set + function + + + + + mixed + + + mixed + + + \$this + + + + $key + + + + + $val + + + + + + join + function + + + + + string + + + string + + + string + + + \$this + + + + $table + + + + + $condition + + + + + $type + + + + + + group_by + function + + + + + mixed + + + \$this + + + + $field + + + + + + order_by + function + + + + + string + + + string + + + \$this + + + + $field + + + + + $type + + + + + + limit + function + + + + + int + + + int + + + string + + + + $limit + + + + + $offset + + + + + + group_start + function + + + + + \$this + + + + + or_group_start + function + + + + + \$this + + + + + or_not_group_start + function + + + + + \$this + + + + + group_end + function + + + + + \$this + + + + + get + function + + + + + + int + + + int + + + object + + + + $table + + + + + $limit + + + + + $offset + + + + + + get_where + function + + + + + string + + + array + + + int + + + int + + + object + + + + $table + + + + + $where + + + + + $limit + + + + + $offset + + + + + + count_all + function + + + + + string + + + int + + + + $table + + + + + + count_all_results + function + + + + + string + + + int + + + + $table + + + + + + insert + function + + + + + string + + + mixed + + + mixed + + + + $table + + + + + $data + + + + + + update + function + + + + + string + + + mixed + + + mixed + + + + $table + + + + + $data + + + + + + delete + function + + + + + string + + + mixed + + + mixed + + + + $table + + + + + $where + + + + + + __call + function + + + + + string + + + array + + + mixed + + + + $name + + + + + $params + + + + + + _reset + function + + + + + void + + + + + _compile + function + + + + + string + + + string + + + \$string + + + + $type + + + + + $table + + + + +                                                 +                                                 + + + + Free Query Builder / Database Abstraction Layer

                                                ]]>                                                 + + + + + +                                                 + + DB_Util + \DB_Util + + + + + + + + + $conn + + + + + + + + __construct + function + + + + + object + + + + $conn + + + + + + __call + function + + + + + string + + + array + + + + $method + + + + + $args + + + + + + create_table + function + + + + + + string + + + array + + + array + + + array + + + string + + + + $name + + + + + $columns + + + + + $constraints + + array + + + $indexes + + array + + + + delete_table + function + + + + + + string + + + string + + + + $name + + + + + + backup_structure + function + + + + + + string + + + + + backup_data + function + + + + + + string + + + + +                                                 + + + + Free Query Builder / Database Abstraction Layer

                                                ]]>                                                 + + + + + +                                                 + + QBASE_PATH + + + + + + + + QDRIVER_PATH + + + + + + + + do_include + function + + + + + string + + + void + + + + $path + + + + + + query_autoload + function + + + + + string + + + + $class + + + + + + db_filter + function + + + + + array + + + mixed + + + array + + + + $array + + + + + $index + + + + +                                                 + + + + Free Query Builder / Database Abstraction Layer

                                                ]]>                                                 + + + + +                                                 + + PgSQL_SQL + \PgSQL_SQL + \DB_SQL + + + + + + + + limit + function + + + + + string + + + int + + + int + + + string + + + + $sql + + + + + $limit + + + + + $offset + + + + + + random + function + + + + + string + + + + + db_list + function + + + + + string + + + + + table_list + function + + + + + string + + + + + system_table_list + function + + + + + string + + + + + view_list + function + + + + + string + + + + + trigger_list + function + + + + + string + + + + + function_list + function + + + + + FALSE + + + + + procedure_list + function + + + + + string + + + + + sequence_list + function + + + + + string + + + + + column_list + function + + + + + string + + + string + + + + $table + + + + + + type_list + function + + + + + string + + + + +                                                 + + + + Free Query Builder / Database Abstraction Layer

                                                ]]>                                                 + + + + + +                                                 + + Implement Backup function + + + PgSQL_Util + \PgSQL_Util + \DB_Util + + + + + + + + __construct + function + + + + + object + + + void + + + + $conn + + + + + + create_table + function + + + + + string + + + array + + + array + + + array + + + string + + + + $name + + + + + $columns + + + + + $constraints + + array + + + $indexes + + array + + + + delete_table + function + + + + + string + + + string + + + + $name + + + + + + backup_structure + function + + + + + string + + + + + backup_data + function + + + + + array + + + string + + + + $exclude + + + + + +                                                 + + + + Free Query Builder / Database Abstraction Layer

                                                ]]>                                                 + + + + + +                                                 + + Implement + + + PgSQL + \PgSQL + \DB_PDO + + + + + + + + __construct + function + + + + + string + + + string + + + string + + + array + + + + $dsn + + + + + $username + + + + + $password + + + + + $options + + + + + + switch_db + function + + + + + string + + + + $name + + + + + + truncate + function + + + + + string + + + + $table + + + + + + get_schemas + function + + + + + array + + + + +                                                 + + + + Free Query Builder / Database Abstraction Layer

                                                ]]>                                                 + + + + + +                                                 + + ODBC_Util + \ODBC_Util + \DB_Util + + + + + + + + __construct + function + + + + + object + + + void + + + + $conn + + + + + + create_table + function + + + + + string + + + array + + + array + + + array + + + string + + + + $name + + + + + $columns + + + + + $constraints + + array + + + $indexes + + array + + + + delete_table + function + + + + + string + + + string + + + + $name + + + + + + backup_structure + function + + + + + string + + + + + backup_data + function + + + + + string + + + + +                                                 + + + + Free Query Builder / Database Abstraction Layer

                                                ]]>                                                 + + + + + +                                                 + + ODBC_SQL + \ODBC_SQL + \DB_SQL + + + + + + + + limit + function + + + + + string + + + int + + + int + + + string + + + + $sql + + + + + $limit + + + + + $offset + + + + + + random + function + + + + + string + + + + + db_list + function + + + + + FALSE + + + + + table_list + function + + + + + FALSE + + + + + system_table_list + function + + + + + FALSE + + + + + view_list + function + + + + + FALSE + + + + + trigger_list + function + + + + + FALSE + + + + + function_list + function + + + + + FALSE + + + + + procedure_list + function + + + + + FALSE + + + + + sequence_list + function + + + + + FALSE + + + + + type_list + function + + + + + FALSE + + + + + column_list + function + + + + + string + + + FALSE + + + + $table + + + + + +                                                 + + + + Free Query Builder / Database Abstraction Layer

                                                ]]>                                                 + + + + + +                                                 + + ODBC + \ODBC + \DB_PDO + + + For general database access for databases not specified by the main drivers

                                                ]]>                                                 + + +                                                 + + $escape_char + + + + + + + + __construct + function + + + + + string + + + string + + + string + + + array + + + + $dsn + + + + + $username + + + + + $password + + + + + $options + + + + + + switch_db + function + + + + + string + + + bool + + + + $name + + + + + + truncate + function + + + + + string + + + void + + + + $table + + + + +                                                 +                                                 + + + + Free Query Builder / Database Abstraction Layer

                                                ]]>                                                 + + + + + +                                                 + + MySQL_Util + \MySQL_Util + \DB_Util + + + + + + + + __construct + function + + + + + object + + + void + + + + $conn + + + + + + create_table + function + + + + + string + + + array + + + array + + + array + + + string + + + + $name + + + + + $columns + + + + + $constraints + + array + + + $indexes + + array + + + + delete_table + function + + + + + string + + + string + + + + $name + + + + + + backup_structure + function + + + + + string + + + + + backup_data + function + + + + + array + + + string + + + + $exclude + + + + + +                                                 + + + + Free Query Builder / Database Abstraction Layer

                                                ]]>                                                 + + + + + +                                                 + + Implement + + + MySQL + \MySQL + \DB_PDO + + + + + + + + $escape_char + + + + + + string + + + + + __construct + function + + + + + string + + + string + + + string + + + array + + + + $dsn + + + + + $username + + + + + $password + + + + + $options + + + + + + switch_db + function + + + + + string + + + + $name + + + + + + truncate + function + + + + + string + + + + $table + + + + + +                                                 + + + + Free Query Builder / Database Abstraction Layer

                                                ]]>                                                 + + + + + +                                                 + + MySQL_SQL + \MySQL_SQL + \DB_SQL + + + + + + + + limit + function + + + + + string + + + int + + + int + + + string + + + + $sql + + + + + $limit + + + + + $offset + + + + + + random + function + + + + + string + + + + + db_list + function + + + + + string + + + + + table_list + function + + + + + string + + + string + + + + $database + + + + + + system_table_list + function + + + + + string + + + + + view_list + function + + + + + string + + + + + trigger_list + function + + + + + string + + + + + function_list + function + + + + + string + + + + + procedure_list + function + + + + + string + + + + + sequence_list + function + + + + + FALSE + + + + + type_list + function + + + + + string + + + + + column_list + function + + + + + string + + + string + + + + $table + + + + + +                                                 + + + + Free Query Builder / Database Abstraction Layer

                                                ]]>                                                 + + + + + +                                                 + + SQLite_Util + \SQLite_Util + \DB_Util + + + + + + + + __construct + function + + + + + object + + + void + + + + $conn + + + + + + create_table + function + + + + + string + + + array + + + array + + + array + + + string + + + + $name + + + + + $columns + + + + + $constraints + + array + + + $indexes + + array + + + + delete_table + function + + + + + string + + + string + + + + $name + + + + + + backup_data + function + + + + + array + + + string + + + + $excluded + + + + + + backup_structure + function + + + + + string + + + + +                                                 + + + + Free Query Builder / Database Abstraction Layer

                                                ]]>                                                 + + + + + +                                                 + + SQLite + \SQLite + \DB_PDO + + + + + + + + $statement + + + + + + \PDOStatement + + + + + __construct + function + + + + + string + + + string + + + string + + + + $dsn + + + + + $user + + + + + $pass + + + + + + switch_db + function + + + + + string + + + + $name + + + + + + truncate + function + + + + + string + + + + $table + + + + + + get_tables + function + + + + + mixed + + + + + get_system_tables + function + + + + + array + + + + + load_database + function + + + + + string + + + string + + + + $db + + + + + $name + + + + + + unload_database + function + + + + + string + + + + $name + + + + + +                                                 + + + + Free Query Builder / Database Abstraction Layer

                                                ]]>                                                 + + + + + +                                                 + + SQLite_SQL + \SQLite_SQL + \DB_SQL + + + + + + + + limit + function + + + + + string + + + int + + + int + + + string + + + + $sql + + + + + $limit + + + + + $offset + + + + + + random + function + + + + + string + + + + + db_list + function + + + + + FALSE + + + + + table_list + function + + + + + string + + + + + system_table_list + function + + + + + string + + + + + view_list + function + + + + + string + + + + + trigger_list + function + + + + + FALSE + + + + + function_list + function + + + + + FALSE + + + + + procedure_list + function + + + + + FALSE + + + + + sequence_list + function + + + + + FALSE + + + + + type_list + function + + + + + array + + + + + column_list + function + + + + + string + + + string + + + + $table + + + + + +                                                 + + + + Free Query Builder / Database Abstraction Layer

                                                ]]>                                                 + + + + + +                                                 + + Firebird_SQL + \Firebird_SQL + \DB_SQL + + + + + + + + limit + function + + + + + string + + + int + + + int + + + string + + + + $sql + + + + + $limit + + + + + $offset + + + + + + random + function + + + + + string + + + + + db_list + function + + + + + FALSE + + + + + table_list + function + + + + + string + + + + + system_table_list + function + + + + + string + + + + + view_list + function + + + + + string + + + + + trigger_list + function + + + + + string + + + + + function_list + function + + + + + string + + + + + procedure_list + function + + + + + string + + + + + sequence_list + function + + + + + string + + + + + column_list + function + + + + + string + + + string + + + + $table + + + + + + type_list + function + + + + + string + + + + +                                                 + + + + Free Query Builder / Database Abstraction Layer

                                                ]]>                                                 + + + + + +                                                 + + Firebird_Result + \Firebird_Result + \PDOStatement + + + + + + + + $statement + + + + + + resource + + + + + $row + + + + + + int + + + + + $result + + + + + + + + + __construct + function + + + + + resource + + + + $link + + + + + + bindColumn + function + + + + + mixed + + + mixed + + + int + + + mixed + + + array + + + FALSE + + + + $column + + + + + $param + + + + + $type + + + + + $maxlen + + + + + $driverdata + + + + + + bindParam + function + + + + + mixed + + + mixed + + + int + + + mixed + + + array + + + FALSE + + + + $parameter + + + + + $variable + + + + + $data_type + + + + + $maxlen + + + + + $driverdata + + + + + + bindValue + function + + + + + mixed + + + mixed + + + int + + + FALSE + + + + $parameter + + + + + $variable + + + + + $data_type + + + + + + execute + function + + + + + array + + + bool + + + + $args + + + + + + fetch + function + + + + + int + + + mixed + + + mixed + + + mixed + + + + $fetch_style + + + + + $statement + + + + + $offset + + + + + + fetchAll + function + + + + + int + + + mixed + + + mixed + + + mixed + + + + $fetch_style + + + + + $statement + + + + + $ctor_args + + + + + + fetchColumn + function + + + + + int + + + mixed + + + + $column_num + + + + + + fetchObject + function + + + + + string + + + array + + + \stdClass + + + + $class_name + + + + + $ctor_args + + + + + + rowCount + function + + + + + int + + + + + errorCode + function + + errorCode]]> + + + string + + + + + errorInfo + function + + errorInfo / PDOStatement->errorInfo]]> + + + array + + + + +                                                 + + + + Free Query Builder / Database Abstraction Layer

                                                ]]>                                                 + + + + + +                                                 + + Firebird + \Firebird + \DB_PDO + + + PDO-firebird isn't stable, so this is a wrapper of the fbird_ public functions.

                                                ]]>                                                 + + +                                                 + + $statement + + + + + + object + + + + + $statement_link + + + + + + resource + + + + + $trans + + + + + + resource + + + + + $conn + + + + + + resource + + + + + __construct + function + + + + + string + + + string + + + string + + + + $dbpath + + + + + $user + + + + + $pass + + + + + + switch_db + function + + + + + string + + + FALSE + + + + $name + + + + + + truncate + function + + + + + string + + + + $table + + + + + + query + function + + + + + string + + + \$this + + + + $sql + + + + + + prepare + function + + + + + string + + + array + + + \$this + + + + $query + + + + + $options + + + + + + beginTransaction + function + + + + + bool + + + + + commit + function + + + + + bool + + + + + rollBack + function + + + + + bool + + + + + prepare_execute + function + + + + + string + + + array + + + resource + + + + $sql + + + + + $args + + + + + + quote + function + + quote]]> + + + string + + + int + + + string + + + + $str + + + + + $param_type + + + + + + errorInfo + function + + errorInfo / PDOStatement->errorInfo]]> + + + array + + + + + errorCode + function + + errorCode]]> + + + array + + + + + prepare_query + function + + + + + string + + + array + + + FALSE + + + + $sql + + + + + $params + + + + +                                                 +                                                 + + + + Free Query Builder / Database Abstraction Layer

                                                ]]>                                                 + + + + + +                                                 + + Implement Backup structure function + + + Firebird_Util + \Firebird_Util + \DB_Util + + + + + + + + __construct + function + + + + + object + + + void + + + + $conn + + + + + + create_table + function + + + + + string + + + array + + + array + + + array + + + string + + + + $name + + + + + $fields + + + + + $constraints + + array + + + $indexes + + array + + + + delete_table + function + + + + + string + + + string + + + + $name + + + + + + backup_structure + function + + + + + string + + + + + backup_data + function + + + + + array + + + bool + + + string + + + + $exclude + + + + + $system_tables + + + + + +                                                 + Convention-based micro-framework for PHP

                                                ]]>                                                 - +                                                 @@ -575,14 +5707,14 @@ page.

                                                ]]>                                                 - + Convention-based micro-framework for PHP

                                                ]]>                                                 - +                                                 @@ -616,14 +5748,14 @@ page.

                                                ]]>                                                 - + Convention-based micro-framework for PHP

                                                ]]>                                                 - +                                                 Generic @@ -674,14 +5806,14 @@ page.

                                                ]]>                                                 - + Convention-based micro-framework for PHP

                                                ]]>                                                 - +                                                 Generic @@ -729,14 +5861,14 @@ page.

                                                ]]>                                                 - + Convention-based micro-framework for PHP

                                                ]]>                                                 - +                                                 @@ -767,14 +5899,14 @@ page.

                                                ]]>                                                 - + Convention-based micro-framework for PHP

                                                ]]>                                                 - +                                                 @@ -873,14 +6005,14 @@ page.

                                                ]]>                                                 - + Convention-based micro-framework for PHP

                                                ]]>                                                 - +                                                 @@ -944,14 +6076,14 @@ page.

                                                ]]>                                                 - + Convention-based micro-framework for PHP

                                                ]]>                                                 - +                                                 @@ -1014,14 +6146,14 @@ page.

                                                ]]>                                                 - + Convention-based micro-framework for PHP

                                                ]]>                                                 - +                                                 @@ -1078,14 +6210,14 @@ dynamic methods]]>                                                 - + Convention-based micro-framework for PHP

                                                ]]>                                                 - +                                                 @@ -1209,14 +6341,112 @@ Used for outputing HTML]]>                                                 - + Convention-based micro-framework for PHP

                                                ]]>                                                 - + + +                                                 + + Session + \miniMVC\Session + + + + + + + + + $sess + + + + + + array + + + + + __construct + function + + + + + + + __set + function + + + + + string + + + mixed + + + void + + + + $key + + + + + $val + + + + + + __get + function + + + + + string + + + mixed + + + + $key + + + + + + destroy + function + + + + + void + + + + +                                                 + + + + Convention-based micro-framework for PHP

                                                ]]>                                                 + + + +                                                 @@ -1354,116 +6584,18 @@ of the singleton]]>                                                 - + Convention-based micro-framework for PHP

                                                ]]>                                                 - - -                                                 - - Session - \miniMVC\Session - - - - - - - - - $sess - - - - - - array - - - - - __construct - function - - - - - - - __set - function - - - - - string - - - mixed - - - void - - - - $key - - - - - $val - - - - - - __get - function - - - - - string - - - mixed - - - - $key - - - - - - destroy - function - - - - - void - - - - -                                                 - - - - Convention-based micro-framework for PHP

                                                ]]>                                                 - - - - +                                                 - sys_autoload + _autoload function @@ -1476,264 +6608,250 @@ of the singleton]]> - - autoload - function - - - - - - - $name - - - - - + shutdown function - + - + void - + on_error function - + - + int - + string - + string - + int - + \miniMVC\ErrorException - + $severity - + $message - + $filepath - + $line - + on_exception function - + - + \miniMVC\Exception - + void - + $exception - + show_404 function - + - + void - + show_error function - + - + string - + int - + $message - + $status_code - + is_like_array function - + - + mixed - + bool - + $var - + controller_methods function - + - + string - + array - + $controller - + site_url function - + - + string - + string - + $segment - + to_string function - + - + \miniMVC\object/array - + string - + string - + $data - + $method - + do_include function - + - + string - + void - + $path - + init function - + - + void - + route function - + - + void                                                 - + Convention-based micro-framework for PHP

                                                ]]>                                                 - +                                                 @@ -1765,12 +6883,17 @@ display them cleanly]]>                                                 + + + + + - todo + todo fixme                                                 diff --git a/phpdoc.dist.xml b/phpdoc.dist.xml index 4b51d78..0cde3b6 100644 --- a/phpdoc.dist.xml +++ b/phpdoc.dist.xml @@ -15,10 +15,10 @@ tests assets app - sys/db + sys/db/tests tests/* assets/* - sys/db/* + sys/db/tests/* app/* \ No newline at end of file diff --git a/sys/db b/sys/db index 2b0d1c2..9774349 160000 --- a/sys/db +++ b/sys/db @@ -1 +1 @@ -Subproject commit 2b0d1c207e6016e0fc114096b7900b6dfd01e45d +Subproject commit 977434977e4177fe5a09fffa0f3a152faa82f606