Docs For Class MDB_QueryTool

MDB_QueryTool_Query (Constructor) [line 237]

MDB_QueryTool_Query MDB_QueryTool_Query(
[mixed
$dsn = false], [array
$options = array()])

Access: public

Parameters:

mixed	`$dsn`	—	DSN string, DSN array or MDB object
array	`$options`	—

[ Top ]

add [line 603]

mixed add(
array
$newData)

add a new member in the DB

Return: the inserted id on success, or false otherwise
Access: public

Parameters:

array $newData — contains the new data that shall be saved in the DB

[ Top ]

addHaving [line 993]

void addHaving(
[string
$what = '*'], [string
$connectString = ' AND '])

Extend the current having clause. This is very useful, when you are building this clause from different places and dont want to overwrite the currently set having clause, but extend it.

Access: public

Parameters:

string	`$what`	—	this is a having clause, i.e. 'column' or 'table.column' or 'MAX(column)'
string	`$connectString`	—	the connection string, which usually stays the default, which is ',' (a comma)

[ Top ]

addJoin [line 1147]

void addJoin(
array
$table, string
$where, [string
$type = 'default'])

adds a table and a where clause that shall be used for the join

instead of calling setJoin(array(table1,table2),'<where clause1> AND <where clause2>') you can also call setJoin(table1,'<where clause1>') addJoin(table2,'<where clause2>') or where it makes more sense is to build a query which is build out of a left join and a standard join setLeftJoin(table1,'<where clause1>') // results in ... FROM $this->table LEFT JOIN table ON <where clause1> addJoin(table2,'<where clause2>') // results in ... FROM $this->table,table2 LEFT JOIN table ON <where clause1> WHERE <where clause2>

Access: public

Parameters:

array	`$table`	—
string	`$where`	—
string	`$type`	—

[ Top ]

addLeftJoin [line 1061]

void addLeftJoin(
string
$table, string
$where, [string
$type = 'left'])

Access: public

Parameters:

string	`$table`	—	the table(s) to be left-joined
string	`$where`	—	the where clause for the join
string	`$type`	—	join type

[ Top ]

addMultiple [line 644]

mixed addMultiple(
array
$data)

adds multiple new members in the DB

Return: the inserted ids on success, or false otherwise
Access: public

Parameters:

array $data — contains an array of new data that shall be saved in the DB the key-value pairs have to be the same for all the data!!!

[ Top ]

addOrder [line 929]

void addOrder(
[string
$orderCondition = ''], [boolean
$desc = false])

Add a order parameter to the query.

Access: public

Parameters:

string	`$orderCondition`	—	the where condition, this can be complete like 'X=7 AND Y=8'
boolean	`$desc`	—	sorting order (TRUE => ASC, FALSE => DESC)

[ Top ]

addSelect [line 1244]

void addSelect(
[string
$what = '*'], [string
$connectString = ','])

add a string to the select part of the query

add a string to the select-part of the query and connects it to an existing string using the $connectString, which by default is a comma. (SELECT xxx FROM - xxx is the select-part of a query)

Access: public

Parameters:

string	`$what`	—	the string that shall be added to the select-part
string	`$connectString`	—	the string to connect the new string with the existing one

[ Top ]

addWhere [line 865]

void addWhere(
string
$where, [string
$condition = 'AND'])

only adds a string to the where clause

Access: public

Parameters:

string	`$where`	—	the where clause to add to the existing one
string	`$condition`	—	the condition for how to concatenate the new where clause to the existing one

[ Top ]

addWhereSearch [line 889]

void addWhereSearch(
string
$column, string
$string, [string
$condition = 'AND'])

add a where-like clause which works like a search for the given string

i.e. calling it like this: $this->addWhereSearch('name', 'otto hans') produces a where clause like this one LOWER(name) LIKE "%otto%hans%" so the search finds the given string

Access: public

Parameters:

string	`$column`	—	the column to search in for
string	`$string`	—	the string to search for
string	`$condition`	—	the condition

[ Top ]

connect [line 277]

void connect(
mixed
$dsn, [array
$options = array()])

use this method if you want to connect manually

Parameters:

mixed	`$dsn`	—	DSN string, DSN array or MDB object
array	`$options`	—

[ Top ]

debug [line 1438]

void debug(
string
$string)

overwrite this method and i.e. print the query $string to see the final query

Access: public

Parameters:

string $string — the query mostly

[ Top ]

execute [line 1977]

resultSet execute(
[string
$query = null], [string
$method = 'getAll'])

Return: or false on error
Access: public

Parameters:

string	`$query`	—
string	`$method`	—	method

[ Top ]

get [line 338]

mixed get(
integer
$id, [string
$column = ''])

get the data of a single entry if the second parameter is only one column the result will be returned directly not as an array!

Return: (1) an array of the retreived data (2) if the second parameter is given and its only one column, only this column's data will be returned (3) false in case of failure
Access: public

Parameters:

integer	`$id`	—	the id of the element to retreive
string	`$column`	—	if this is given only one row shall be returned, directly, not an array

[ Top ]

getAll [line 397]

mixed getAll(
[int
$from = 0], [int
$count = 0], [
$method = 'getAll'])

get all entries from the DB for sorting use setOrder!!!, the last 2 parameters are deprecated

Return: an array of the retreived data, or false in case of failure when failing an error is set in $this->_error
Access: public

Parameters:

int	`$from`	—	to start from
int	`$count`	—	the number of rows to show
	`$method`	—

[ Top ]

getCol [line 426]

mixed getCol(
[string
$column = null], [int
$from = 0], [int
$count = 0])

this method only returns one column, so the result will be a one dimensional array

this does also mean that using setSelect() should be set to *one* column, the one you want to have returned a most common use case for this could be: $table->setSelect('id'); $ids = $table->getCol(); OR $ids = $table->getCol('id'); so ids will ba an array with all the id's

Return: an array of the retreived data, or false in case of failure when failing an error is set in $this->_error
Access: public

Parameters:

string	`$column`	—	the column that shall be retreived
int	`$from`	—	to start from
int	`$count`	—	the number of rows to show

[ Top ]

getCount [line 451]

mixed getCount(
)

get the number of entries

Return: an array of the retreived data, or false in case of failure when failing an error is set in $this->_error
Access: public

[ Top ]

getDbInstance [line 299]

object MDB &getDbInstance(
)

Return: Object
Access: public

[ Top ]

getDefaultValues [line 493]

array getDefaultValues(
)

return an empty element where all the array elements do already exist corresponding to the columns in the DB

Return: an empty, or pre-initialized element
Access: public

[ Top ]

getDontSelect [line 1282]

void getDontSelect(
)

Access: public

[ Top ]

getEmptyElement [line 511]

void getEmptyElement(
)

this is just for BC

Deprecated:

[ Top ]

getGroup [line 1212]

string getGroup(
)

gets the group condition which is used for the current instance

Return: the group condition
Access: public

[ Top ]

getHaving [line 976]

string getHaving(
)

gets the having definition which is used for the current instance

Return: the having definition
Access: public

[ Top ]

getIndex [line 2179]

string getIndex(
)

Return: index
Access: public

[ Top ]

getJoin [line 1098]

array getJoin(
[string
$what = null])

gets the join-condition

Return: gets the join parameters
Access: public

Parameters:

[ Top ]

getLimit [line 819]

array getLimit(
)

gets query limits

Return: (start index, number of results)
Access: public

[ Top ]

getMultiple [line 369]

mixed getMultiple(
array
$ids, [string
$column = ''])

gets the data of the given ids

Return: an array of the retreived data, or false in case of failure when failing an error is set in $this->_error
Access: public

Parameters:

array	`$ids`	—	this is an array of ids to retreive
string	`$column`	—	the column to search in for

[ Top ]

getOption [line 1342]

void getOption(
string
$option)

Access: public

Parameters:

string $option — name of the option to retrieve

[ Top ]

getOrder [line 948]

string getOrder(
)

gets the order condition which is used for the current instance

Return: the order condition, this can be complete like 'ID,TIMESTAMP DESC'
Access: public

[ Top ]

getQueryString [line 524]

string getQueryString(
)

Render the current query and return it as a string.

Return: the current query

[ Top ]

getSelect [line 1260]

void getSelect(
)

Access: public

[ Top ]

getTable [line 1182]

string getTable(
)

gets the table this class is currently working on

Return: the table name
Access: public

[ Top ]

getTableShortName [line 1593]

string getTableShortName(
string
$table)

this method gets the short name for a table

get the short name for a table, this is needed to properly build the 'AS' parts in the select query

Return: the table's short name
Access: public

Parameters:

string $table — the real table name

[ Top ]

getTableSpec [line 1620]

array getTableSpec(
[array
$shortNameIndexed = true], [boolean
$tables = array()])

gets the tableSpec either indexed by the short name or the name returns the array for the tables given as parameter or if no parameter given for all tables that exist in the tableSpec

Return: the tableSpec indexed
Access: public

Parameters:

array	`$shortNameIndexed`	—	table names (not the short names!)
boolean	`$tables`	—	if true the table is returned indexed by the shortName otherwise indexed by the name

[ Top ]

getWhere [line 849]

string getWhere(
)

gets the where condition which is used for the current instance

Return: the where condition, this can be complete like 'X=7 AND Y=8'
Access: public

[ Top ]

metadata [line 1457]

resultSet metadata(
[string
$table = ''])

!!!! query COPIED FROM db_oci8.inc - from PHPLIB !!!!

Return: or false on error
See: db_oci8.inc - PHPLIB
Access: public

Parameters:

string $table —

[ Top ]

remove [line 690]

boolean remove(
mixed
$data, [string
$whereCol = ''])

removes a member from the DB

Access: public

Parameters:

mixed	`$data`	—	integer/string - the value of the column that shall be removed array - multiple columns that shall be matched, the second parameter will be ommited
string	`$whereCol`	—	the column to match the data against, only if $data is not an array

[ Top ]

removeAll [line 726]

resultSet removeAll(
)

empty a table

Return: or false on error [execute() result]
Access: public

[ Top ]

removeMultiple [line 742]

resultSet removeMultiple(
array
$ids, [
$colName = ''])

remove the datasets with the given ids

Return: or false on error [execute() result]
Access: public

Parameters:

array	`$ids`	—	the ids to remove
	`$colName`	—

[ Top ]

removePrimary [line 771]

boolean removePrimary(
integer
$id, string
$colName, object just
$atLeastOneObject)

removes a member from the DB and calls the remove methods of the given objects so all rows in another table that refer to this table are erased too

Access: public

Parameters:

integer	`$id`	—	the value of the primary key
string	`$colName`	—	the column name of the tables with the foreign keys
object just	`$atLeastOneObject`	—	for convinience, so nobody forgets to call this method with at least one object as a parameter

[ Top ]

reset [line 1296]

void reset(
[
$what = array()])

reset all the set* settings, with no parameter given it resets all

Access: public

Parameters:

$what —

[ Top ]

returnResult [line 2079]

mixed returnResult(
object reference
&$result)

Return the chosen result type

Return: [boolean, array or object]
Access: public

Parameters:

object reference &$result —

[ Top ]

save [line 551]

mixed save(
array
$data)

save data, calls either update or add if the primaryCol is given in the data this method knows that the data passed to it are meant to be updated (call 'update'), otherwise it will call the method 'add'.

If you dont like this behaviour simply stick with the methods 'add' and 'update' and ignore this one here. This method is very useful when you have validation checks that have to be done for both adding and updating, then you can simply overwrite this method and do the checks in here, and both cases will be validated first.

Return: the data returned by either add or update-method
Access: public

Parameters:

array $data — contains the new data that shall be saved in the DB

[ Top ]

setDbInstance [line 315]

void setDbInstance(
object a
&$dbh)

Setup using an existing connection.

this also sets the MDB_FETCHMODE_ASSOC since this class needs this to be set!

Parameters:

object a &$dbh — reference to an existing DB-object

[ Top ]

setDontSelect [line 1271]

void setDontSelect(
[
$what = ''])

Access: public

Parameters:

$what —

[ Top ]

setErrorCallback [line 2223]

void setErrorCallback(
[
$param = ''])

set both callbacks

Access: public

Parameters:

$param —

[ Top ]

setErrorLogCallback [line 2235]

void setErrorLogCallback(
[string
$param = ''])

Parameters:

string $param —

[ Top ]

setErrorSetCallback [line 2247]

void setErrorSetCallback(
[string
$param = ''])

Parameters:

string $param —

[ Top ]

setGroup [line 1196]

void setGroup(
[string
$group = ''])

sets the group-by condition

Access: public

Parameters:

string $group — the group condition

[ Top ]

setHaving [line 962]

void setHaving(
[string
$having = ''])

sets the having definition

Access: public

Parameters:

string $having — the having definition

[ Top ]

setIndex [line 2151]

void setIndex(
[string
$key = null])

format the result to be indexed by $key

NOTE: be careful, when using this you should be aware, that if you use an index which's value appears multiple times you may loose data since a key cant exist multiple times!! the result for a result to be indexed by a key(=columnName) (i.e. 'relationtoMe') which's values are 'brother' and 'sister' or alike normally returns this: $res['brother'] = array('name'=>'xxx') $res['sister'] = array('name'=>'xxx') but if the column 'relationtoMe' contains multiple entries for 'brother' then the returned dataset will only contain one brother, since the value from the column 'relationtoMe' is used and which 'brother' you get depends on a lot of things, like the sortorder, how the db saves the data, and whatever else

you can also set indexes which depend on 2 columns, simply pass the parameters like 'table1.id,table2.id' it will be used as a string for indexing the result and the index will be built using the 2 values given, so a possible index might be '1,2' or '2108,29389' this way you can access data which have 2 primary keys. Be sure to remember that the index is a string!

Access: public

Parameters:

string $key —

[ Top ]

setJoin [line 1013]

void setJoin(
[mixed
$table = null], [string
$where = null], [
$joinType = 'default'])

sets a join-condition

Access: public

Parameters:

mixed	`$table`	—	either a string or an array that contains the table(s) to join on the current table
string	`$where`	—	the where clause for the join
	`$joinType`	—

[ Top ]

setLeftJoin [line 1046]

void setLeftJoin(
[string
$table = null], [string
$where = null])

if you do a left join on $this->table you will get all entries

from $this->table, also if there are no entries for them in the joined table if both parameters are not given the left-join will be removed NOTE: be sure to only use either a right or a left join

Access: public

Parameters:

string	`$table`	—	the table(s) to be left-joined
string	`$where`	—	the where clause for the join

[ Top ]

setLimit [line 801]

void setLimit(
[integer
$from = 0], [integer
$count = 0])

sets query limits

Access: public

Parameters:

integer	`$from`	—	start index
integer	`$count`	—	number of results

[ Top ]

setOption [line 1330]

void setOption(
string
$option, mixed
$value)

set mode the class shall work in currently we have the modes: 'raw' does not quote the data before building the query

Access: public

Parameters:

string	`$option`	—	the mode to be set
mixed	`$value`	—	the value of the mode

[ Top ]

setOrder [line 914]

void setOrder(
[string
$orderCondition = ''], [boolean
$desc = false])

sets the order condition which is used for the current instance

Access: public

Parameters:

string	`$orderCondition`	—	the where condition, this can be complete like 'X=7 AND Y=8'
boolean	`$desc`	—	sorting order (TRUE => ASC, FALSE => DESC)

[ Top ]

setRightJoin [line 1083]

void setRightJoin(
[string
$table = null], [string
$where = null])

see setLeftJoin for further explaination on what a left/right join is NOTE: be sure to only use either a right or a left join

See: MDB_QueryTool_Query::setLeftJoin()
Access: public

Parameters:

string	`$table`	—	the table(s) to be right-joined
string	`$where`	—	the where clause for the join

[ Top ]

setSelect [line 1224]

void setSelect(
[
$what = '*'])

limit the result to return only the columns given in $what

Access: public

Parameters:

$what —

[ Top ]

setTable [line 1168]

void setTable(
string
$table)

sets the table this class is currently working on

Access: public

Parameters:

string $table — the table name

[ Top ]

setWhere [line 833]

void setWhere(
[string
$whereCondition = ''])

sets the where condition which is used for the current instance

Access: public

Parameters:

string $whereCondition — the where condition, this can be complete like 'X=7 AND Y=8'

[ Top ]

update [line 570]

mixed update(
array
$newData)

update the member data of a data set

Return: true on success, or false otherwise
Access: public

Parameters:

array $newData — contains the new data that shall be saved in the DB the id has to be given in the field with the key 'ID'

[ Top ]

useResult [line 2195]

void useResult(
[string
$type = 'array'])

Choose the type of the returned result

Access: public

Parameters:

string $type — ['array' | 'object' | 'none'] For BC reasons, $type=true is equal to 'array', $type=false is equal to 'none'

[ Top ]

writeLog [line 2019]

void writeLog(
[string
$text = 'START'])

Write events to the logfile.

It does some additional work, like time measuring etc. to see some additional info

Access: public

Parameters:

string $text —

[ Top ]

_checkColumns [line 1401]

void _checkColumns(
string
$newData, [integer
$method = 'unknown'])

checks if the columns which are given as the array's indexes really exist if not it will be unset anyway

Access: public

Parameters:

string	`$newData`	—	the actual message, first word should always be the method name, to build the message like this: className::methodname
integer	`$method`	—	the line number

[ Top ]

_makeIndexed [line 2104]

mixed &_makeIndexed(

&$data, mixed
$data)

Return: or array $indexedData
Access: public

Parameters:

mixed	`$data`	—
	`&$data`	—

[ Top ]

Class: MDB_QueryTool_Query

Class Overview

Author(s):

Variables

Methods

Child classes:

Inherited Variables

Inherited Methods

Class Details

Class Variables

$db = null

$primaryCol = 'id'

$sequenceName = null

$table = ''

$tableSpec = array()

Method Detail

MDB_QueryTool_Query (Constructor) [line 237]

Parameters:

add [line 603]

Parameters:

addHaving [line 993]

Parameters:

addJoin [line 1147]

Parameters:

addLeftJoin [line 1061]

Parameters:

addMultiple [line 644]

Parameters:

addOrder [line 929]

Parameters:

addSelect [line 1244]

Parameters:

addWhere [line 865]

Parameters:

addWhereSearch [line 889]

Parameters:

connect [line 277]

Parameters:

debug [line 1438]

Parameters:

execute [line 1977]

Parameters:

get [line 338]

Parameters:

getAll [line 397]

Parameters:

getCol [line 426]

Parameters:

getCount [line 451]

getDbInstance [line 299]

getDefaultValues [line 493]

getDontSelect [line 1282]

getEmptyElement [line 511]

getGroup [line 1212]

getHaving [line 976]

getIndex [line 2179]

getJoin [line 1098]

Parameters:

getLimit [line 819]

getMultiple [line 369]

Parameters:

getOption [line 1342]

Parameters:

getOrder [line 948]

getQueryString [line 524]

getSelect [line 1260]

getTable [line 1182]

getTableShortName [line 1593]

Parameters:

getTableSpec [line 1620]

Parameters:

getWhere [line 849]

metadata [line 1457]

Parameters:

remove [line 690]

Parameters:

removeAll [line 726]

removeMultiple [line 742]

Parameters:

removePrimary [line 771]