From 5478de08a0ba06336599017d4de30b7ed6593152 Mon Sep 17 00:00:00 2001 From: "Timothy J. Warren" Date: Thu, 24 Apr 2014 14:54:08 -0400 Subject: [PATCH] Update docs [ci-skip] --- docs/classes/Query.BadDBDriverException.html | 18 +- docs/classes/Query.Connection_Manager.html | 18 +- .../classes/Query.Driver.Abstract_Driver.html | 186 +++--- docs/classes/Query.Driver.Abstract_SQL.html | 18 +- docs/classes/Query.Driver.Abstract_Util.html | 43 +- .../Query.Driver.Driver_Interface.html | 592 +++++++++++++++++- docs/classes/Query.Driver.Firebird.html | 108 ++-- .../classes/Query.Driver.Firebird_Result.html | 18 +- docs/classes/Query.Driver.Firebird_SQL.html | 18 +- docs/classes/Query.Driver.Firebird_Util.html | 163 +---- docs/classes/Query.Driver.MySQL.html | 108 ++-- docs/classes/Query.Driver.MySQL_SQL.html | 18 +- docs/classes/Query.Driver.MySQL_Util.html | 240 +------ docs/classes/Query.Driver.PgSQL.html | 108 ++-- docs/classes/Query.Driver.PgSQL_SQL.html | 18 +- docs/classes/Query.Driver.PgSQL_Util.html | 107 +--- docs/classes/Query.Driver.SQL_Interface.html | 18 +- docs/classes/Query.Driver.SQLite.html | 108 ++-- docs/classes/Query.Driver.SQLite_SQL.html | 18 +- docs/classes/Query.Driver.SQLite_Util.html | 43 +- docs/classes/Query.Query_Builder.html | 18 +- .../Query.Query_Builder_Interface.html | 18 +- docs/classes/Query.Query_Parser.html | 18 +- docs/classes/Query.Table.Abstract_Table.html | 18 +- docs/classes/Query.Table.Table_Builder.html | 18 +- docs/classes/Query.Table.Table_Column.html | 18 +- .../Query.Table.Table_Foreign_Key.html | 18 +- docs/classes/Query.Table.Table_Index.html | 18 +- docs/files/autoload.php.html | 18 +- docs/files/common.php.html | 121 +++- docs/files/common.php.txt | 49 ++ .../core.abstract.abstract_driver.php.html | 18 +- .../files/core.abstract.abstract_sql.php.html | 18 +- .../core.abstract.abstract_table.php.html | 18 +- .../core.abstract.abstract_util.php.html | 18 +- docs/files/core.connection_manager.php.html | 18 +- .../core.interfaces.driver_interface.php.html | 18 +- ...nterfaces.query_builder_interface.php.html | 18 +- .../core.interfaces.sql_interface.php.html | 18 +- docs/files/core.query_builder.php.html | 18 +- docs/files/core.query_parser.php.html | 18 +- docs/files/core.table_builder.php.html | 18 +- docs/files/core.table_column.php.html | 18 +- docs/files/core.table_foreign_key.php.html | 18 +- docs/files/core.table_index.php.html | 18 +- .../core/abstract/abstract_driver.php.txt | 113 ++-- .../files/core/abstract/abstract_util.php.txt | 40 +- docs/files/core/connection_manager.php.txt | 9 +- .../core/interfaces/driver_interface.php.txt | 116 ++++ docs/files/core/query_builder.php.txt | 16 +- .../drivers.firebird.firebird_driver.php.html | 18 +- .../drivers.firebird.firebird_result.php.html | 18 +- .../drivers.firebird.firebird_sql.php.html | 18 +- .../drivers.firebird.firebird_util.php.html | 18 +- .../files/drivers.mysql.mysql_driver.php.html | 18 +- docs/files/drivers.mysql.mysql_sql.php.html | 18 +- docs/files/drivers.mysql.mysql_util.php.html | 18 +- .../files/drivers.pgsql.pgsql_driver.php.html | 18 +- docs/files/drivers.pgsql.pgsql_sql.php.html | 18 +- docs/files/drivers.pgsql.pgsql_util.php.html | 18 +- .../drivers.sqlite.sqlite_driver.php.html | 18 +- docs/files/drivers.sqlite.sqlite_sql.php.html | 18 +- .../files/drivers.sqlite.sqlite_util.php.html | 18 +- .../drivers/firebird/firebird_driver.php.txt | 2 + .../drivers/firebird/firebird_util.php.txt | 19 +- docs/files/drivers/mysql/mysql_util.php.txt | 18 +- docs/files/drivers/pgsql/pgsql_util.php.txt | 8 +- docs/files/drivers/sqlite/sqlite_util.php.txt | 8 +- docs/graphs/class.html | 2 +- docs/namespaces/Query.Driver.html | 18 +- docs/namespaces/Query.Table.html | 18 +- docs/namespaces/Query.html | 18 +- docs/namespaces/default.html | 121 +++- docs/reports/deprecated.html | 2 +- docs/reports/errors.html | 2 +- docs/reports/markers.html | 4 +- 76 files changed, 1902 insertions(+), 1418 deletions(-) diff --git a/docs/classes/Query.BadDBDriverException.html b/docs/classes/Query.BadDBDriverException.html index 20c269c..226e151 100644 --- a/docs/classes/Query.BadDBDriverException.html +++ b/docs/classes/Query.BadDBDriverException.html @@ -139,28 +139,28 @@
- + \
-
+
- + Query
-
+
- + Table
-
+
@@ -179,10 +179,10 @@
- + Driver
-
+
@@ -380,7 +380,7 @@
Documentation is powered by phpDocumentor and authored - on April 24th, 2014 at 11:24. + on April 24th, 2014 at 14:53.
diff --git a/docs/classes/Query.Connection_Manager.html b/docs/classes/Query.Connection_Manager.html index b3228ca..dcf97e3 100644 --- a/docs/classes/Query.Connection_Manager.html +++ b/docs/classes/Query.Connection_Manager.html @@ -139,28 +139,28 @@
- + \
-
+
- + Query
-
+
- + Table
-
+
@@ -179,10 +179,10 @@
- + Driver
-
+
@@ -804,7 +804,7 @@ Query method

Documentation is powered by phpDocumentor and authored - on April 24th, 2014 at 11:24. + on April 24th, 2014 at 14:53.
diff --git a/docs/classes/Query.Driver.Abstract_Driver.html b/docs/classes/Query.Driver.Abstract_Driver.html index 32c97fc..71262ca 100644 --- a/docs/classes/Query.Driver.Abstract_Driver.html +++ b/docs/classes/Query.Driver.Abstract_Driver.html @@ -139,28 +139,28 @@
- + \
-
+
- + Query
-
+
- + Table
-
+
@@ -179,10 +179,10 @@
- + Driver
-
+
@@ -272,7 +272,6 @@ prefix_table()
quote_table()
quote_ident()
- _quote()
get_schemas()
get_tables()
get_dbs()
@@ -288,8 +287,9 @@ get_types()
driver_query()
num_rows()
- truncate()
insert_batch()
+ _quote()
+ truncate()
$sql
@@ -1017,47 +1017,6 @@
- -
-

_quote()

- - 
_quote(mixed $str) : mixed
-

Helper method for quote_ident

- - -

Parameters

- - - - - - -
mixed$str
- - -

Returns

- mixed -
-
- -
- -
-

get_schemas()

@@ -1228,7 +1187,7 @@

get_functions()

get_functions() : array
-

Return list of function for the current database

+

Return list of functions for the current database

@@ -1593,46 +1552,6 @@ the connection/database

- -
-

truncate()

- - 
truncate(string $table) : void
-

Empty the passed table

- - -

Parameters

- - - - - - -
string$table
- - -
-
- -
- -
-

insert_batch()

@@ -1677,6 +1596,87 @@ the connection/database

+
+
+ +
+

_quote()

+ + 
_quote(mixed $str) : mixed
+

Helper method for quote_ident

+ + +

Parameters

+ + + + + + +
mixed$str
+ + +

Returns

+ mixed +
+
+ +
+ +
+
+ +
+

truncate()

+ + 
truncate(string $table) : void
+

Empty the passed table

+ + +

Parameters

+ + + + + + +
string$table
+ + +
+
+ +
+
@@ -1768,7 +1768,7 @@ the connection/database

Documentation is powered by phpDocumentor and authored - on April 24th, 2014 at 11:24. + on April 24th, 2014 at 14:53.
diff --git a/docs/classes/Query.Driver.Abstract_SQL.html b/docs/classes/Query.Driver.Abstract_SQL.html index ae80cef..135a25b 100644 --- a/docs/classes/Query.Driver.Abstract_SQL.html +++ b/docs/classes/Query.Driver.Abstract_SQL.html @@ -139,28 +139,28 @@
- + \
-
+
- + Query
-
+
- + Table
-
+
@@ -179,10 +179,10 @@
- + Driver
-
+
@@ -436,7 +436,7 @@
Documentation is powered by phpDocumentor and authored - on April 24th, 2014 at 11:24. + on April 24th, 2014 at 14:53.
diff --git a/docs/classes/Query.Driver.Abstract_Util.html b/docs/classes/Query.Driver.Abstract_Util.html index 47023aa..447756f 100644 --- a/docs/classes/Query.Driver.Abstract_Util.html +++ b/docs/classes/Query.Driver.Abstract_Util.html @@ -139,28 +139,28 @@
- + \
-
+
- + Query
-
+
- + Table
-
+
@@ -179,10 +179,10 @@
- + Driver
-
+
@@ -263,7 +263,7 @@
__construct()
- __call()
+ get_driver()
create_table()
delete_table()
backup_structure()
@@ -419,31 +419,18 @@
- +
-

__call()

+

get_driver()

- 
__call(string $method, array $args) : mixed
-

Enable calling driver methods

+ 
get_driver() : \Query\Driver\Driver_Interface
+

Get the driver object for the current connection

-

Parameters

- - - - - - - - - - - -
string$method
array$args

Returns

- mixed + \Query\Driver\Driver_Interface
diff --git a/docs/classes/Query.Driver.Driver_Interface.html b/docs/classes/Query.Driver.Driver_Interface.html index 8d9862e..82109fc 100644 --- a/docs/classes/Query.Driver.Driver_Interface.html +++ b/docs/classes/Query.Driver.Driver_Interface.html @@ -139,28 +139,28 @@
- + \
-
+
- + Query
-
+
- + Table
-
+
@@ -179,10 +179,10 @@
- + Driver
-
+
@@ -260,6 +260,7 @@
__construct()
+ prepare_query()
beginTransaction()
commit()
errorCode()
@@ -269,13 +270,27 @@ rollback()
setAttribute()
get_columns()
+ get_types()
+ get_indexes()
get_fks()
get_tables()
+ get_system_tables()
+ get_dbs()
+ get_views()
+ get_sequences()
+ get_functions()
+ get_procedures()
+ get_triggers()
quote_ident()
quote_table()
prepare_execute()
get_sql()
get_util()
+ driver_query()
+ affected_rows()
+ num_rows()
+ prefix_table()
+ insert_batch()
No constants found @@ -384,6 +399,58 @@
+ +
+

prepare_query()

+ + 
prepare_query(string $sql, array $data) : \PDOStatement
+

Simplifies prepared statements for database queries

+ + +

Parameters

+ + + + + + + + + + + +
string$sql
array$data
+ +

Throws

+
+
\InvalidArgumentException
+
+
+ +

Returns

+ \PDOStatement + —

| FALSE

+
+
+ +
+ +
+

beginTransaction()

@@ -685,6 +752,80 @@

Retrieve column information for the current database table

+

Parameters

+ + + + + + +
string$table
+ + +

Returns

+ array +
+
+ +
+ +
+
+ +
+

get_types()

+ + 
get_types() : array
+

Retrieve list of data types for the database

+ + + + +

Returns

+ array +
+
+ +
+ +
+
+ +
+

get_indexes()

+ + 
get_indexes(string $table) : array
+

Retrieve indexes for the table

+ +

Parameters

@@ -769,6 +910,238 @@ +

Returns

+ array + + +
+ + + + +
+ todo + +
+ +
+ +
+
+ +
+

get_system_tables()

+ + 
get_system_tables() : array
+

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

+ + + + +

Returns

+ array +
+
+ +
+ +
+
+ +
+

get_dbs()

+ + 
get_dbs() : array
+

Return list of dbs for the current connection, if possible

+ + + + +

Returns

+ array +
+
+ +
+ +
+
+ +
+

get_views()

+ + 
get_views() : array
+

Return list of views for the current database

+ + + + +

Returns

+ array +
+
+ +
+ +
+
+ +
+

get_sequences()

+ + 
get_sequences() : array
+

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

+ + + + +

Returns

+ array +
+
+ +
+ +
+
+ +
+

get_functions()

+ + 
get_functions() : array
+

Return list of functions for the current database

+ + + + +

Returns

+ array +
+
+ +
+ +
+
+ +
+

get_procedures()

+ + 
get_procedures() : array
+

Return list of stored procedures for the current database

+ + + + +

Returns

+ array +
+
+ +
+ +
+
+ +
+

get_triggers()

+ + 
get_triggers() : array
+

Return list of triggers for the current database

+ + + +

Returns

array
@@ -984,6 +1357,207 @@
+
+
+ +
+

driver_query()

+ + 
driver_query(string|array|null $query, bool $filtered_index) : array
+

Method to simplify retrieving db results for meta-data queries

+ + +

Parameters

+ + + + + + + + + + + +
string|array|null$query
bool$filtered_index
+ + +

Returns

+ array +
+
+ +
+ +
+
+ +
+

affected_rows()

+ + 
affected_rows() : int
+

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

+ + + + +

Returns

+ int +
+
+ +
+ +
+
+ +
+

num_rows()

+ + 
num_rows() : int
+

Return the number of rows returned for a SELECT query

+ + + + +

Returns

+ int +
+
+ +
+ +
+
+ +
+

prefix_table()

+ + 
prefix_table(string $table) : string
+

Prefixes a table if it is not already prefixed

+ + +

Parameters

+ + + + + + +
string$table
+ + +

Returns

+ string +
+
+ +
+ +
+
+ +
+

insert_batch()

+ + 
insert_batch(string $table, array $data) : array
+

Create sql for batch insert

+ + +

Parameters

+ + + + + + + + + + + +
string$table
array$data
+ + +

Returns

+ array +
+
+ +
+
@@ -1034,7 +1608,7 @@
Documentation is powered by phpDocumentor and authored - on April 24th, 2014 at 11:24. + on April 24th, 2014 at 14:53.
diff --git a/docs/classes/Query.Driver.Firebird.html b/docs/classes/Query.Driver.Firebird.html index 33ce028..2cd3d6d 100644 --- a/docs/classes/Query.Driver.Firebird.html +++ b/docs/classes/Query.Driver.Firebird.html @@ -139,28 +139,28 @@
- + \
-
+
- + Query
-
+
- + Table
-
+
@@ -179,10 +179,10 @@
- + Driver
-
+
@@ -289,7 +289,6 @@ prefix_table()
quote_table()
quote_ident()
- _quote()
get_schemas()
get_tables()
get_dbs()
@@ -305,6 +304,7 @@ get_types()
driver_query()
num_rows()
+ _quote()
$sql
@@ -1864,49 +1864,6 @@ the last query executed

- -
-

_quote()

- - 
_quote(mixed $str) : mixed
-

Helper method for quote_ident

- - -

Parameters

- - - - - - -
mixed$str
- - -

Returns

- mixed -
-
- -
- -
-

get_schemas()

@@ -2087,7 +2044,7 @@ the last query executed

get_functions()

get_functions() : array
-

Return list of function for the current database

+

Return list of functions for the current database

@@ -2470,6 +2427,49 @@ the connection/database

+
+
+ +
+

_quote()

+ + 
_quote(mixed $str) : mixed
+

Helper method for quote_ident

+ + +

Parameters

+ + + + + + +
mixed$str
+ + +

Returns

+ mixed +
+
+ +
+
@@ -2563,7 +2563,7 @@ the connection/database

Documentation is powered by phpDocumentor and authored - on April 24th, 2014 at 11:24. + on April 24th, 2014 at 14:53.
diff --git a/docs/classes/Query.Driver.Firebird_Result.html b/docs/classes/Query.Driver.Firebird_Result.html index 3b51d37..61192a9 100644 --- a/docs/classes/Query.Driver.Firebird_Result.html +++ b/docs/classes/Query.Driver.Firebird_Result.html @@ -139,28 +139,28 @@
- + \
-
+
- + Query
-
+
- + Table
-
+
@@ -179,10 +179,10 @@
- + Driver
-
+
@@ -1082,7 +1082,7 @@ the query

Documentation is powered by phpDocumentor and authored - on April 24th, 2014 at 11:24. + on April 24th, 2014 at 14:53.
diff --git a/docs/classes/Query.Driver.Firebird_SQL.html b/docs/classes/Query.Driver.Firebird_SQL.html index 5b976e2..b5d49f8 100644 --- a/docs/classes/Query.Driver.Firebird_SQL.html +++ b/docs/classes/Query.Driver.Firebird_SQL.html @@ -139,28 +139,28 @@
- + \
-
+
- + Query
-
+
- + Table
-
+
@@ -179,10 +179,10 @@
- + Driver
-
+
@@ -948,7 +948,7 @@ table

Documentation is powered by phpDocumentor and authored - on April 24th, 2014 at 11:24. + on April 24th, 2014 at 14:53.
diff --git a/docs/classes/Query.Driver.Firebird_Util.html b/docs/classes/Query.Driver.Firebird_Util.html index 451d0fe..2372685 100644 --- a/docs/classes/Query.Driver.Firebird_Util.html +++ b/docs/classes/Query.Driver.Firebird_Util.html @@ -139,28 +139,28 @@
- + \
-
+
- + Query
-
+
- + Table
-
+
@@ -179,10 +179,10 @@
- + Driver
-
+
@@ -267,11 +267,7 @@ backup_structure()
backup_data()
__construct()
- __call()
- get_system_tables()
- get_tables()
- query()
- get_service()
+ get_driver()
quote_ident()
quote_table()
@@ -605,31 +601,18 @@
- +
-

__call()

+

get_driver()

- 
__call(string $method, array $args) : mixed
-

Enable calling driver methods

+ 
get_driver() : \Query\Driver\Driver_Interface
+

Get the driver object for the current connection

-

Parameters

- - - - - - - - - - - -
string$method
array$args

Returns

- mixed + \Query\Driver\Driver_Interface
+
+
+ +
+

_quote()

+ + 
_quote(mixed $str) : mixed
+

Helper method for quote_ident

+ + +

Parameters

+ + + + + + +
mixed$str
+ + +

Returns

+ mixed +
+
+ +
+
@@ -1841,7 +1841,7 @@ the connection/database

Documentation is powered by phpDocumentor and authored - on April 24th, 2014 at 11:24. + on April 24th, 2014 at 14:53.
diff --git a/docs/classes/Query.Driver.MySQL_SQL.html b/docs/classes/Query.Driver.MySQL_SQL.html index 8747d45..7dff64f 100644 --- a/docs/classes/Query.Driver.MySQL_SQL.html +++ b/docs/classes/Query.Driver.MySQL_SQL.html @@ -139,28 +139,28 @@
- + \
-
+
- + Query
-
+
- + Table
-
+
@@ -179,10 +179,10 @@
- + Driver
-
+
@@ -956,7 +956,7 @@ table

Documentation is powered by phpDocumentor and authored - on April 24th, 2014 at 11:24. + on April 24th, 2014 at 14:53.
diff --git a/docs/classes/Query.Driver.MySQL_Util.html b/docs/classes/Query.Driver.MySQL_Util.html index c3612bd..4e3b9a6 100644 --- a/docs/classes/Query.Driver.MySQL_Util.html +++ b/docs/classes/Query.Driver.MySQL_Util.html @@ -139,28 +139,28 @@
- + \
-
+
- + Query
-
+
- + Table
-
+
@@ -179,10 +179,10 @@
- + Driver
-
+
@@ -265,15 +265,9 @@ backup_structure()
backup_data()
__construct()
- __call()
+ get_driver()
create_table()
delete_table()
- get_dbs()
- driver_query()
- get_system_tables()
- get_tables()
- query()
- quote()
quote_ident()
quote_table()
@@ -502,31 +496,18 @@
- +
-

__call()

+

get_driver()

- 
__call(string $method, array $args) : mixed
-

Enable calling driver methods

+ 
get_driver() : \Query\Driver\Driver_Interface
+

Get the driver object for the current connection

-

Parameters

- - - - - - - - - - - -
string$method
array$args

Returns

- mixed + \Query\Driver\Driver_Interface
+
+
+ +
+

_quote()

+ + 
_quote(mixed $str) : mixed
+

Helper method for quote_ident

+ + +

Parameters

+ + + + + + +
mixed$str
+ + +

Returns

+ mixed +
+
+ +
+
@@ -1841,7 +1841,7 @@ the connection/database

Documentation is powered by phpDocumentor and authored - on April 24th, 2014 at 11:24. + on April 24th, 2014 at 14:53.
diff --git a/docs/classes/Query.Driver.PgSQL_SQL.html b/docs/classes/Query.Driver.PgSQL_SQL.html index 4ec7fe4..4edf10b 100644 --- a/docs/classes/Query.Driver.PgSQL_SQL.html +++ b/docs/classes/Query.Driver.PgSQL_SQL.html @@ -139,28 +139,28 @@
- + \
-
+
- + Query
-
+
- + Table
-
+
@@ -179,10 +179,10 @@
- + Driver
-
+
@@ -948,7 +948,7 @@ table

Documentation is powered by phpDocumentor and authored - on April 24th, 2014 at 11:24. + on April 24th, 2014 at 14:53.
diff --git a/docs/classes/Query.Driver.PgSQL_Util.html b/docs/classes/Query.Driver.PgSQL_Util.html index 7412c63..be71952 100644 --- a/docs/classes/Query.Driver.PgSQL_Util.html +++ b/docs/classes/Query.Driver.PgSQL_Util.html @@ -139,28 +139,28 @@
- + \
-
+
- + Query
-
+
- + Table
-
+
@@ -179,10 +179,10 @@
- + Driver
-
+
@@ -265,11 +265,9 @@ backup_structure()
backup_data()
__construct()
- __call()
+ get_driver()
create_table()
delete_table()
- query()
- get_tables()
quote_ident()
quote_table()
@@ -498,31 +496,18 @@
- +
-

__call()

+

get_driver()

- 
__call(string $method, array $args) : mixed
-

Enable calling driver methods

+ 
get_driver() : \Query\Driver\Driver_Interface
+

Get the driver object for the current connection

-

Parameters

- - - - - - - - - - - -
string$method
array$args

Returns

- mixed + \Query\Driver\Driver_Interface
+
+
+ +
+

_quote()

+ + 
_quote(mixed $str) : mixed
+

Helper method for quote_ident

+ + +

Parameters

+ + + + + + +
mixed$str
+ + +

Returns

+ mixed +
+
+ +
+
@@ -1841,7 +1841,7 @@ the connection/database

Documentation is powered by phpDocumentor and authored - on April 24th, 2014 at 11:24. + on April 24th, 2014 at 14:53.
diff --git a/docs/classes/Query.Driver.SQLite_SQL.html b/docs/classes/Query.Driver.SQLite_SQL.html index 521ae6a..9916b18 100644 --- a/docs/classes/Query.Driver.SQLite_SQL.html +++ b/docs/classes/Query.Driver.SQLite_SQL.html @@ -139,28 +139,28 @@
- + \
-
+
- + Query
-
+
- + Table
-
+
@@ -179,10 +179,10 @@
- + Driver
-
+
@@ -948,7 +948,7 @@ table

Documentation is powered by phpDocumentor and authored - on April 24th, 2014 at 11:24. + on April 24th, 2014 at 14:53.
diff --git a/docs/classes/Query.Driver.SQLite_Util.html b/docs/classes/Query.Driver.SQLite_Util.html index 2957dde..0ff44d7 100644 --- a/docs/classes/Query.Driver.SQLite_Util.html +++ b/docs/classes/Query.Driver.SQLite_Util.html @@ -139,28 +139,28 @@
- + \
-
+
- + Query
-
+
- + Table
-
+
@@ -179,10 +179,10 @@
- + Driver
-
+
@@ -265,7 +265,7 @@ backup_data()
backup_structure()
__construct()
- __call()
+ get_driver()
create_table()
delete_table()
query()
@@ -498,31 +498,18 @@
- +
-

__call()

+

get_driver()

- 
__call(string $method, array $args) : mixed
-

Enable calling driver methods

+ 
get_driver() : \Query\Driver\Driver_Interface
+

Get the driver object for the current connection

-

Parameters

- - - - - - - - - - - -
string$method
array$args

Returns

- mixed + \Query\Driver\Driver_Interface