Class: DB_QueryTool_Query
Source Location: /DB_QueryTool-1.1.2/QueryTool/Query.php
DB_QueryTool_Query class
Author(s):
Copyright:
- 2003-2007 Wolfram Kriesing, Paolo Panto, Lorenzo Alberton
|
|
|
Child classes:
|
Inherited Variables
|
Inherited Methods
|
Class Details
Class Variables
Method Detail
DB_QueryTool_Query (Constructor) [line 263]
DB_QueryTool_Query DB_QueryTool_Query(
[mixed
$dsn = false], [array
$options = array()])
|
|
Constructor
Parameters:
add [line 729]
mixed add(
array
$newData)
|
|
add a new member in the DB
Parameters:
addHaving [line 1212]
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 don't want to overwrite the currently set HAVING clause, but extend it.
Parameters:
addJoin [line 1389]
void addJoin(
string
$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 made 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>
Parameters:
addLeftJoin [line 1294]
void addLeftJoin(
string
$table, string
$where, [string
$type = 'left'])
|
|
add a LEFT JOIN clause
Parameters:
addMultiple [line 783]
mixed addMultiple(
array
$data)
|
|
adds multiple new members in the DB
Parameters:
addOrder [line 1137]
void addOrder(
[string
$orderCondition = ''], [boolean
$desc = false])
|
|
Add a ORDER BY parameter to the query.
Parameters:
addSelect [line 1506]
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)
Parameters:
addWhere [line 1060]
void addWhere(
string
$where, [string
$connectString = 'AND'])
|
|
only adds a string to the WHERE clause
Parameters:
addWhereSearch [line 1089]
void addWhereSearch(
string
$column, string
$string, [string
$connectString = '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
Parameters:
connect [line 303]
void connect(
mixed
$dsn, [array
$options = array()])
|
|
use this method if you want to connect manually
Parameters:
debug [line 1753]
void debug(
string
$string)
|
|
overwrite this method and i.e. print the query $string to see the final query
Parameters:
execute [line 2406]
resultSet execute(
[string
$query = null], [string
$method = 'getAll'])
|
|
Execute the query
Parameters:
get [line 369]
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!
Parameters:
getAll [line 454]
mixed getAll(
[int
$from = 0], [int
$count = 0], [string
$method = 'getAll'])
|
|
get all entries from the DB for sorting use setOrder!!!, the last 2 parameters are deprecated
Parameters:
getCol [line 487]
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 be an array with all the id's
Parameters:
getCount [line 515]
get the number of entries
getDbInstance [line 326]
reference &getDbInstance(
)
|
|
Get the current DB instance
getDefaultValues [line 562]
array getDefaultValues(
)
|
|
return an empty element where all the array elements do already exist corresponding to the columns in the DB
getDontSelect [line 1555]
Get the column(s) to be ignored
getEmptyElement [line 582]
getGroup [line 1468]
gets the group condition which is used for the current instance
getHaving [line 1192]
gets the HAVING definition which is used for the current instance
getIndex [line 2623]
getJoin [line 1336]
array getJoin(
[string
$what = null])
|
|
gets the join-condition
Parameters:
getLimit [line 1002]
getMultiple [line 406]
mixed getMultiple(
array
$ids, [string
$column = ''])
|
|
gets the data of the given ids
Parameters:
getOne [line 431]
get the first value of the first row
getOption [line 1629]
string getOption(
string
$option)
|
|
Get the option value
Parameters:
getOrder [line 1158]
gets the ORDER BY condition which is used for the current instance
getQueryString [line 595]
Render the current query and return it as a string.
getSelect [line 1525]
getTable [line 1430]
gets the table this class is currently working on
getTableShortName [line 1962]
string getTableShortName(
string
$table)
|
|
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
Parameters:
getTableSpec [line 1990]
array getTableSpec(
[boolean
$shortNameIndexed = true], [array
$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
Parameters:
getWhere [line 1040]
gets the WHERE condition which is used for the current instance
metadata [line 1776]
resultSet metadata(
[string
$table = ''])
|
|
!!!! query COPIED FROM db_oci8.inc - from PHPLIB !!!!
Parameters:
remove [line 863]
boolean remove(
mixed
$data, [string
$whereCol = ''])
|
|
removes a member from the DB
Parameters:
removeAll [line 903]
removeMultiple [line 923]
resultSet removeMultiple(
array
$ids, [string
$colName = ''])
|
|
remove the datasets with the given ids
Parameters:
removePrimary [line 955]
boolean removePrimary(
integer
$id, string
$colName, object
$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
Parameters:
reset [line 1574]
void reset(
[array
$what = array()])
|
|
reset all the set* settings; with no parameter given, it resets them all.
Parameters:
returnResult [line 2510]
mixed returnResult(
object
$result)
|
|
Return the chosen result type
Parameters:
save [line 671]
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.
Parameters:
setDbInstance [line 343]
void setDbInstance(
object
&$dbh)
|
|
Setup using an existing connection. this also sets the DB_FETCHMODE_ASSOC since this class needs this to be set!
Parameters:
setDontSelect [line 1541]
void setDontSelect(
[string
$what = ''])
|
|
Do not select the given column
Parameters:
setErrorCallback [line 2675]
void setErrorCallback(
[string
$param = ''])
|
|
set both callbacks
Parameters:
setErrorLogCallback [line 2691]
void setErrorLogCallback(
[string
$param = ''])
|
|
Set the name of the error log callback function
Parameters:
setErrorSetCallback [line 2707]
void setErrorSetCallback(
[string
$param = ''])
|
|
Set the name of the error log callback function
Parameters:
setGroup [line 1448]
void setGroup(
[string
$group = ''])
|
|
sets the group-by condition
Parameters:
setHaving [line 1176]
void setHaving(
[string
$having = ''])
|
|
sets the HAVING definition
Parameters:
setIndex [line 2593]
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!
Parameters:
setJoin [line 1236]
void setJoin(
[string|array
$table = null], [string
$where = null], [string
$joinType = 'default'])
|
|
sets a join-condition
Parameters:
setLeftJoin [line 1276]
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
Parameters:
setLimit [line 984]
void setLimit(
[integer
$from = 0], [integer
$count = 0])
|
|
sets query limits
Parameters:
setOption [line 1613]
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
Parameters:
setOrder [line 1118]
void setOrder(
[string
$orderCondition = ''], [boolean
$desc = false])
|
|
sets the ORDER BY condition which is used for the current instance
Parameters:
setRightJoin [line 1320]
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 //FIXXME check if the above sentence is necessary and if sql doesn't allow the use of both
Parameters:
setSelect [line 1484]
void setSelect(
[string
$what = '*'])
|
|
limit the result to return only the columns given in $what
Parameters:
setTable [line 1414]
void setTable(
string
$table)
|
|
sets the table this class is currently working on
Parameters:
setWhere [line 1020]
void setWhere(
[string
$whereCondition = ''])
|
|
sets the WHERE condition which is used for the current instance
Parameters:
update [line 693]
mixed update(
array
$newData)
|
|
update the member data of a data set
Parameters:
useResult [line 2643]
void useResult(
[string
$type = 'array'])
|
|
Choose the type of the returned result
Parameters:
writeLog [line 2448]
void writeLog(
[string
$text = 'START'])
|
|
Write events to the logfile. It does some additional work, like time measuring etc. to see some additional info
Parameters:
_checkColumns [line 1714]
array _checkColumns(
array
$newData, [string
$method = 'unknown'])
|
|
checks if the columns which are given as the array's indexes really exist if not it will be unset anyway
Parameters:
_makeIndexed [line 2541]
mixed &_makeIndexed(
mixed
&$data)
|
|
Make the data indexed
Parameters:
Documentation generated on Mon, 11 Mar 2019 15:14:42 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.
|
|