Class to manage Dolibarr database access. More...
Inheritance diagram for DoliDB:
Collaboration diagram for DoliDB:
Public Member Functions | |
| ifsql ($test, $resok, $resko) | |
| Format a SQL IF. More... | |
| idate ($param, $gm= 'tzserver') | |
| Convert (by PHP) a GM Timestamp date into a string date with PHP server TZ to insert into a date field. More... | |
| lasterrno () | |
| Return last error code. More... | |
| sanitize ($stringtosanitize, $allowsimplequote=0) | |
| Sanitize a string for SQL forging. More... | |
| begin () | |
| Start transaction. More... | |
| commit ($log= '') | |
| Validate a database transaction. More... | |
| rollback ($log= '') | |
| Cancel a transaction and go back to initial data values. More... | |
| plimit ($limit=0, $offset=0) | |
| Define limits and offset of request. More... | |
| getVersionArray () | |
| Return version of database server into an array. More... | |
| lastquery () | |
| Return last request executed with query() More... | |
| order ($sortfield=null, $sortorder=null) | |
| Define sort criteria of request. More... | |
| lasterror () | |
| Return last error label. More... | |
| jdate ($string, $gm= 'tzserver') | |
| Convert (by PHP) a PHP server TZ string date into a Timestamps date (GMT if gm=true) 19700101020000 -> 3600 with TZ+1 and gmt=0 19700101020000 -> 7200 whaterver is TZ if gmt=1. More... | |
| lastqueryerror () | |
| Return last query in error. More... | |
| getRow ($sql) | |
| Return first result from query as object Note : This method executes a given SQL query and retrieves the first row of results as an object. More... | |
| getRows ($sql) | |
| return all results from query as an array of objects Note : This method executes a given SQL query and retrieves all row of results as an array of objects. More... | |
| Public Member Functions inherited from Database | |
| fetch_row ($resultset) | |
| Return datas as an array. More... | |
| idate ($param) | |
| Convert (by PHP) a GM Timestamp date into a string date with PHP server TZ to insert into a date field. More... | |
| DDLCreateDb ($database, $charset= '', $collation= '', $owner= '') | |
| Create a new database Do not use function xxx_create_db (xxx=mysql, ...) as they are deprecated We force to create database with charset this->forcecharset and collate this->forcecollate. More... | |
| affected_rows ($resultset) | |
| Return the number of lines in the result of a request INSERT, DELETE or UPDATE. More... | |
| error () | |
| Return description of last error. More... | |
| DDLListTables ($database, $table= '') | |
| List tables into a database. More... | |
| decrypt ($value) | |
| Decrypt sensitive data in database. More... | |
| fetch_array ($resultset) | |
| Return datas as an array. More... | |
| escape ($stringtoencode) | |
| Escape a string to insert data. More... | |
| sanitize ($stringtosanitize) | |
| Sanitize a string for SQL forging. More... | |
| last_insert_id ($tab, $fieldid= 'rowid') | |
| Get last ID after an insert INSERT. More... | |
| getPathOfRestore () | |
| Return full path of restore program. More... | |
| query ($query, $usesavepoint=0, $type= 'auto') | |
| Execute a SQL request and return the resultset. More... | |
| connect ($host, $login, $passwd, $name, $port=0) | |
| Connexion to server. More... | |
| getServerParametersValues ($filter= '') | |
| Return value of server parameters. More... | |
| getServerStatusValues ($filter= '') | |
| Return value of server status. More... | |
| getDefaultCollationDatabase () | |
| Return collation used in database. More... | |
| num_rows ($resultset) | |
| Return number of lines for result of a SELECT. More... | |
| getPathOfDump () | |
| Return full path of dump program. More... | |
| getDriverInfo () | |
| Return version of database client driver. More... | |
| errno () | |
| Return generic error code of last operation. More... | |
| DDLCreateTable ($table, $fields, $primary_key, $type, $unique_keys=null, $fulltext_keys=null, $keys=null) | |
| Create a table into database. More... | |
| DDLDropTable ($table) | |
| Drop a table into database. More... | |
| getListOfCharacterSet () | |
| Return list of available charset that can be used to store data in database. More... | |
| DDLAddField ($table, $field_name, $field_desc, $field_position="") | |
| Create a new field into table. More... | |
| DDLDropField ($table, $field_name) | |
| Drop a field from table. More... | |
| DDLUpdateField ($table, $field_name, $field_desc) | |
| Update format of a field into a table. More... | |
| getListOfCollation () | |
| Return list of available collation that can be used for database. More... | |
| DDLDescTable ($table, $field="") | |
| Return a pointer of line with description of a table or field. More... | |
| getVersion () | |
| Return version of database server. More... | |
| getDefaultCharacterSetDatabase () | |
| Return charset used to store data in database. More... | |
| DDLCreateUser ($dolibarr_main_db_host, $dolibarr_main_db_user, $dolibarr_main_db_pass, $dolibarr_main_db_name) | |
| Create a user and privileges to connect to database (even if database does not exists yet) More... | |
| encrypt ($fieldorvalue, $withQuotes=0) | |
| Encrypt sensitive data in database Warning: This function includes the escape, so it must use direct value. More... | |
| DDLInfoTable ($table) | |
| List information of columns into a table. More... | |
| free ($resultset=null) | |
| Free last resultset used. More... | |
| close () | |
| Close database connexion. More... | |
| DDLGetConnectId () | |
| Return connexion ID. More... | |
| fetch_object ($resultset) | |
| Returns the current line (as an object) for the resultset cursor. More... | |
| select_db ($database) | |
| Select a database. More... | |
Additional Inherited Members | |
| Static Public Member Functions inherited from Database | |
| static | convertSQLFromMysql ($line, $type= 'ddl') |
| Convert a SQL request in Mysql syntax to native syntax. More... | |
Detailed Description
Class to manage Dolibarr database access.
Definition at line 30 of file DoliDB.class.php.
Member Function Documentation
| DoliDB::begin | ( | ) |
Start transaction.
- Returns
- int 1 if transaction successfuly opened or already opened, 0 if error
Implements Database.
Definition at line 128 of file DoliDB.class.php.
References dol_syslog(), and Database\query().
| DoliDB::commit | ( | $log = '' | ) |
Validate a database transaction.
- Parameters
-
string $log Add more log to default log line
- Returns
- int 1 if validation is OK or transaction level no started, 0 if ERROR
Implements Database.
Definition at line 153 of file DoliDB.class.php.
References dol_syslog(), and Database\query().
| DoliDB::getRow | ( | $sql | ) |
Return first result from query as object Note : This method executes a given SQL query and retrieves the first row of results as an object.
It should only be used with SELECT queries Dont add LIMIT to your query, it will be added by this method
- Parameters
-
string $sql the sql query string
- Returns
- bool| object
Definition at line 319 of file DoliDB.class.php.
References Database\fetch_object(), and Database\query().
| DoliDB::getRows | ( | $sql | ) |
return all results from query as an array of objects Note : This method executes a given SQL query and retrieves all row of results as an array of objects.
It should only be used with SELECT queries be carefull with this method use it only with some limit of results to avoid performences loss
- Parameters
-
string $sql the sql query string
- Returns
- bool| array
Definition at line 339 of file DoliDB.class.php.
References Database\fetch_object(), Database\num_rows(), and Database\query().
| DoliDB::getVersionArray | ( | ) |
Return version of database server into an array.
- Returns
- array Version array
Implements Database.
Definition at line 215 of file DoliDB.class.php.
References Database\getVersion().
| DoliDB::idate | ( | $param, | |
$gm = 'tzserver' |
|||
| ) |
Convert (by PHP) a GM Timestamp date into a string date with PHP server TZ to insert into a date field.
Function to use to build INSERT, UPDATE or WHERE predica
- Parameters
-
int $param Date TMS to convert mixed $gm 'gmt'=Input informations are GMT values, 'tzserver'=Local to server TZ
- Returns
- string Date in a string YYYY-MM-DD HH:MM:SS
Definition at line 91 of file DoliDB.class.php.
References dol_print_date().
| DoliDB::ifsql | ( | $test, | |
| $resok, | |||
| $resko | |||
| ) |
Format a SQL IF.
- Parameters
-
string $test Test string (example: 'cd.statut=0', 'field IS NULL') string $resok resultat si test egal string $resko resultat si test non egal
- Returns
- string SQL string
Implements Database.
Definition at line 78 of file DoliDB.class.php.
| DoliDB::jdate | ( | $string, | |
$gm = 'tzserver' |
|||
| ) |
Convert (by PHP) a PHP server TZ string date into a Timestamps date (GMT if gm=true) 19700101020000 -> 3600 with TZ+1 and gmt=0 19700101020000 -> 7200 whaterver is TZ if gmt=1.
- Parameters
-
string $string Date in a string (YYYYMMDDHHMMSS, YYYYMMDD, YYYY-MM-DD HH:MM:SS) mixed $gm 'gmt'=Input informations are GMT values, 'tzserver'=Local to server TZ
- Returns
- int|string Date TMS or ''
Implements Database.
Definition at line 292 of file DoliDB.class.php.
References dol_mktime().
| DoliDB::lasterrno | ( | ) |
Return last error code.
- Returns
- string lasterrno
Implements Database.
Definition at line 102 of file DoliDB.class.php.
Referenced by DoliDBMysqli\query(), DoliDBSqlite3\query(), and DoliDBPgsql\query().
| DoliDB::lasterror | ( | ) |
Return last error label.
- Returns
- string Last error
Implements Database.
Definition at line 278 of file DoliDB.class.php.
Referenced by DoliDBPgsql\DDLDropField(), DoliDBMysqli\query(), DoliDBSqlite3\query(), and DoliDBPgsql\query().
| DoliDB::lastquery | ( | ) |
Return last request executed with query()
- Returns
- string Last query
Implements Database.
Definition at line 225 of file DoliDB.class.php.
Referenced by DoliDBMysqli\query(), DoliDBSqlite3\query(), and DoliDBPgsql\query().
| DoliDB::lastqueryerror | ( | ) |
Return last query in error.
- Returns
- string lastqueryerror
Implements Database.
Definition at line 307 of file DoliDB.class.php.
Referenced by DoliDBMysqli\query(), DoliDBSqlite3\query(), and DoliDBPgsql\query().
| DoliDB::order | ( | $sortfield = null, |
|
$sortorder = null |
|||
| ) |
Define sort criteria of request.
- Parameters
-
string $sortfield List of sort fields, separated by comma. Example: 't1.fielda,t2.fieldb' string $sortorder Sort order, separated by comma. Example: 'ASC,DESC';
- Returns
- string String to provide syntax of a sort sql string
Implements Database.
Definition at line 237 of file DoliDB.class.php.
| DoliDB::plimit | ( | $limit = 0, |
|
$offset = 0 |
|||
| ) |
Define limits and offset of request.
- Parameters
-
int $limit Maximum number of lines returned (-1=conf->liste_limit, 0=no limit) int $offset Numero of line from where starting fetch
- Returns
- string String with SQL syntax to add a limit and offset
Implements Database.
Definition at line 201 of file DoliDB.class.php.
| DoliDB::rollback | ( | $log = '' | ) |
Cancel a transaction and go back to initial data values.
- Parameters
-
string $log Add more log to default log line
- Returns
- resource|int 1 if cancelation is ok or transaction not open, 0 if error
Implements Database.
Definition at line 179 of file DoliDB.class.php.
References dol_syslog(), and Database\query().
| DoliDB::sanitize | ( | $stringtosanitize, | |
$allowsimplequote = 0 |
|||
| ) |
Sanitize a string for SQL forging.
- Parameters
-
string $stringtosanitize String to escape int $allowsimplequote Allow simple quote
- Returns
- string String escaped
Definition at line 114 of file DoliDB.class.php.
The documentation for this class was generated from the following file:
- htdocs/core/db/DoliDB.class.php