|
dolibarr 20.0.5
|
Class to manage Dolibarr database access for a SQLite database. More...


Public Member Functions | |
| __construct ($type, $host, $user, $pass, $name='', $port=0) | |
| Constructor. | |
| convertSQLFromMysql ($line, $type='ddl') | |
| Convert a SQL request in Mysql syntax to native syntax. | |
| select_db ($database) | |
| Select a database. | |
| connect ($host, $login, $passwd, $name, $port=0) | |
| Connection to server. | |
| getVersion () | |
| Return version of database server. | |
| getDriverInfo () | |
| Return version of database client driver. | |
| close () | |
| Close database connection. | |
| query ($query, $usesavepoint=0, $type='auto', $result_mode=0) | |
| Execute a SQL request and return the resultset. | |
| fetch_object ($resultset) | |
| Returns the current line (as an object) for the resultset cursor. | |
| fetch_array ($resultset) | |
| Return datas as an array. | |
| fetch_row ($resultset) | |
| Return datas as an array. | |
| num_rows ($resultset) | |
| Return number of lines for result of a SELECT. | |
| affected_rows ($resultset) | |
| Return number of lines for result of a SELECT. | |
| free ($resultset=null) | |
| Free last resultset used. | |
| escape ($stringtoencode) | |
| Escape a string to insert data. | |
| escapeforlike ($stringtoencode) | |
| Escape a string to insert data into a like. | |
| errno () | |
| Renvoie le code erreur generique de l'operation precedente. | |
| error () | |
| Renvoie le texte de l'erreur mysql de l'operation precedente. | |
| last_insert_id ($tab, $fieldid='rowid') | |
| Get last ID after an insert INSERT. | |
| encrypt ($fieldorvalue, $withQuotes=1) | |
| Encrypt sensitive data in database Warning: This function includes the escape and add the SQL simple quotes on strings. | |
| decrypt ($value) | |
| Decrypt sensitive data in database. | |
| DDLGetConnectId () | |
| Return connection ID. | |
| 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. | |
| DDLListTables ($database, $table='') | |
| List tables into a database. | |
| DDLListTablesFull ($database, $table='') | |
| List tables into a database with table type. | |
| DDLInfoTable ($table) | |
| List information of columns into a table. | |
| DDLCreateTable ($table, $fields, $primary_key, $type, $unique_keys=null, $fulltext_keys=null, $keys=null) | |
| Create a table into database. | |
| DDLDropTable ($table) | |
| Drop a table into database. | |
| DDLDescTable ($table, $field="") | |
| Return a pointer of line with description of a table or field. | |
| DDLAddField ($table, $field_name, $field_desc, $field_position="") | |
| Create a new field into table. | |
| DDLUpdateField ($table, $field_name, $field_desc) | |
| Update format of a field into a table. | |
| DDLDropField ($table, $field_name) | |
| Drop a field from table. | |
| 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) | |
| getDefaultCharacterSetDatabase () | |
| Return charset used to store data in database. | |
| getListOfCharacterSet () | |
| Return list of available charset that can be used to store data in database. | |
| getDefaultCollationDatabase () | |
| Return collation used in database. | |
| getListOfCollation () | |
| Return list of available collation that can be used for database. | |
| getPathOfDump () | |
| Return full path of dump program. | |
| getPathOfRestore () | |
| Return full path of restore program. | |
| getServerParametersValues ($filter='') | |
| Return value of server parameters. | |
| getServerStatusValues ($filter='') | |
| Return value of server status. | |
Public Member Functions inherited from DoliDB | |
| prefix () | |
| Return the DB prefix found into prefix_db (if it was set manually by doing $dbhandler->prefix_db=...). | |
| ifsql ($test, $resok, $resko) | |
| Format a SQL IF. | |
| stddevpop ($nameoffield) | |
| Return SQL string to aggregate using the Standard Deviation of population. | |
| hintindex ($nameofindex) | |
| Return SQL string to force an index. | |
| regexpsql ($subject, $pattern, $sqlstring=0) | |
| Format a SQL REGEXP. | |
| 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. | |
| lasterrno () | |
| Return last error code. | |
| sanitize ($stringtosanitize, $allowsimplequote=0, $allowsequals=0, $allowsspace=0, $allowschars=1) | |
| Sanitize a string for SQL forging. | |
| begin ($textinlog='') | |
| Start transaction. | |
| commit ($log='') | |
| Validate a database transaction. | |
| rollback ($log='') | |
| Cancel a transaction and go back to initial data values. | |
| plimit ($limit=0, $offset=0) | |
| Define limits and offset of request. | |
| getVersionArray () | |
| Return version of database server into an array. | |
| lastquery () | |
| Return last request executed with query() | |
| order ($sortfield='', $sortorder='') | |
| Define sort criteria of request. | |
| lasterror () | |
| Return last error label. | |
| jdate ($string, $gm='tzserver') | |
| Convert (by PHP) a PHP server TZ string date into a Timestamps date (GMT if gm=true) 19700101020000 -> 3600 with server TZ = +1 and $gm='tzserver' 19700101020000 -> 7200 whaterver is server TZ if $gm='gmt'. | |
| lastqueryerror () | |
| Return last query in error. | |
| 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. | |
| getRows ($sql) | |
| Return all results from query as an array of objects. | |
Public Member Functions inherited from Database | |
| idate ($param) | |
| Convert (by PHP) a GM Timestamp date into a string date with PHP server TZ to insert into a date field. | |
| sanitize ($stringtosanitize) | |
| Sanitize a string for SQL forging. | |
Public Attributes | |
| $type = 'sqlite3' | |
| Database type. | |
| const | LABEL = 'Sqlite3' |
| Database label. | |
| const | VERSIONMIN = '3.0.0' |
| Version min database. | |
Public Attributes inherited from DoliDB | |
| const | VERSIONMIN = self::VERSIONMIN |
| Force subclass to implement VERSIONMIN - required DB version. | |
| const | LABEL = self::LABEL |
| Force subclass to implement LABEL - description of DB type. | |
Private Member Functions | |
| addCustomFunction ($name, $arg_count=-1) | |
| Add a custom function in the database engine (STORED PROCEDURE) Notes: | |
Static Private Member Functions | |
| static | calc_daynr ($year, $month, $day) |
| calc_daynr | |
| static | calc_weekday ($daynr, $sunday_first_day_of_week) |
| calc_weekday | |
| static | calc_days_in_year ($year) |
| calc_days_in_year | |
| static | calc_week ($year, $month, $day, $week_behaviour, &$calc_year) |
| calc_week | |
Class to manage Dolibarr database access for a SQLite database.
Definition at line 34 of file sqlite3.class.php.
| DoliDBSqlite3::__construct | ( | $type, | |
| $host, | |||
| $user, | |||
| $pass, | |||
| $name = '', | |||
| $port = 0 ) |
Constructor.
This create an opened connection to a database server and eventually to a database
| string | $type | Type of database (mysql, pgsql...). Not used. |
| string | $host | Address of database server |
| string | $user | Nom de l'utilisateur autorise |
| string | $pass | Password |
| string | $name | Nom de la database |
| int | $port | Port of database server |
Definition at line 69 of file sqlite3.class.php.
References addCustomFunction(), connect(), dol_syslog(), and error().
|
private |
Add a custom function in the database engine (STORED PROCEDURE) Notes:
| string | $name | Function name to define in Sqlite |
| int | $arg_count | Arguments count |
Definition at line 1401 of file sqlite3.class.php.
References error().
Referenced by __construct().
| DoliDBSqlite3::affected_rows | ( | $resultset | ) |
Return number of lines for result of a SELECT.
| SQLite3Result | $resultset | Resulset of requests |
Implements Database.
Definition at line 608 of file sqlite3.class.php.
References num_rows().
|
staticprivate |
calc_daynr
| int | $year | Year |
| int | $month | Month |
| int | $day | Day |
Definition at line 1426 of file sqlite3.class.php.
Referenced by calc_week().
|
staticprivate |
calc_days_in_year
| int | $year | Year |
Definition at line 1465 of file sqlite3.class.php.
Referenced by calc_week().
|
staticprivate |
calc_week
| int | $year | Year |
| int | $month | Month |
| int | $day | Day |
| int | $week_behaviour | Week behaviour, bit masks: WEEK_MONDAY_FIRST, WEEK_YEAR, WEEK_FIRST_WEEKDEAY |
| int | $calc_year | ??? Year where the week started |
Definition at line 1482 of file sqlite3.class.php.
References calc_daynr(), calc_days_in_year(), and calc_weekday().
|
staticprivate |
calc_weekday
| int | $daynr | ??? |
| bool | $sunday_first_day_of_week | ??? |
Definition at line 1451 of file sqlite3.class.php.
Referenced by calc_week().
| DoliDBSqlite3::close | ( | ) |
Close database connection.
Implements Database.
Definition at line 382 of file sqlite3.class.php.
References dol_syslog().
| DoliDBSqlite3::connect | ( | $host, | |
| $login, | |||
| $passwd, | |||
| $name, | |||
| $port = 0 ) |
Connection to server.
| string | $host | database server host |
| string | $login | login |
| string | $passwd | password |
| string | $name | name of database (not used for mysql, used for pgsql) |
| integer | $port | Port of database server |
Implements Database.
Definition at line 326 of file sqlite3.class.php.
References dol_syslog(), and error().
Referenced by __construct().
| DoliDBSqlite3::convertSQLFromMysql | ( | $line, | |
| $type = 'ddl' ) |
Convert a SQL request in Mysql syntax to native syntax.
| string | $line | SQL request line to convert |
| string | $type | Type of SQL order ('ddl' for insert, update, select, delete or 'dml' for create, alter...) |
Implements Database.
Definition at line 145 of file sqlite3.class.php.
References $type, and dol_syslog().
Referenced by query().
| DoliDBSqlite3::DDLAddField | ( | $table, | |
| $field_name, | |||
| $field_desc, | |||
| $field_position = "" ) |
Create a new field into table.
| string | $table | Table name |
| string | $field_name | Field name to add |
| array{type:string,label:string,enabled:int<0,2>|string,position:int,notnull?:int,visible:int,noteditable?:int,default?:string,index?:int,foreignkey?:string,searchall?:int,isameasure?:int,css?:string,csslist?:string,help?:string,showoncombobox?:int,disabled?:int,arrayofkeyval?:array<int,string>,comment?:string} | $field_desc Associative table with description of field to insert [parameter name][parameter value] | |
| string | $field_position | Optional e.g.: "after some_field" |
Implements Database.
Definition at line 1104 of file sqlite3.class.php.
| DoliDBSqlite3::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.
| string | $database | Database name to create |
| string | $charset | Charset used to store data |
| string | $collation | Charset used to sort data |
| string | $owner | Username of database owner |
Implements Database.
Definition at line 849 of file sqlite3.class.php.
| DoliDBSqlite3::DDLCreateTable | ( | $table, | |
| $fields, | |||
| $primary_key, | |||
| $type, | |||
| $unique_keys = null, | |||
| $fulltext_keys = null, | |||
| $keys = null ) |
Create a table into database.
| string | $table | Nom de la table |
| array<string,array{type:string,label:string,enabled:int<0,2>|string,position:int,notnull?:int,visible:int,noteditable?:int,default?:string,index?:int,foreignkey?:string,searchall?:int,isameasure?:int,css?:string,csslist?:string,help?:string,showoncombobox?:int,disabled?:int,arrayofkeyval?:array<int,string>,comment?:string}> | $fields Tableau associatif [nom champ][tableau des descriptions] | |
| string | $primary_key | Nom du champ qui sera la clef primaire |
| string | $type | Type de la table |
| array | $unique_keys | Tableau associatifs Nom de champs qui seront clef unique => valeur |
| array | $fulltext_keys | Tableau des Nom de champs qui seront indexes en fulltext |
| array | $keys | Tableau des champs cles noms => valeur |
Implements Database.
Definition at line 973 of file sqlite3.class.php.
| DoliDBSqlite3::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)
| string | $dolibarr_main_db_host | Ip serveur |
| string | $dolibarr_main_db_user | Nom user a creer |
| string | $dolibarr_main_db_pass | Password user a creer |
| string | $dolibarr_main_db_name | Database name where user must be granted |
Implements Database.
Definition at line 1200 of file sqlite3.class.php.
| DoliDBSqlite3::DDLDescTable | ( | $table, | |
| $field = "" ) |
Return a pointer of line with description of a table or field.
| string | $table | Name of table |
| string | $field | Optionnel : Name of field if we want description of field |
Implements Database.
Definition at line 1084 of file sqlite3.class.php.
| DoliDBSqlite3::DDLDropField | ( | $table, | |
| $field_name ) |
Drop a field from table.
| string | $table | Name of table |
| string | $field_name | Name of field to drop |
Implements Database.
Definition at line 1176 of file sqlite3.class.php.
| DoliDBSqlite3::DDLDropTable | ( | $table | ) |
Drop a table into database.
| string | $table | Name of table |
Implements Database.
Definition at line 1062 of file sqlite3.class.php.
| DoliDBSqlite3::DDLGetConnectId | ( | ) |
Return connection ID.
Implements Database.
Definition at line 830 of file sqlite3.class.php.
| DoliDBSqlite3::DDLInfoTable | ( | $table | ) |
List information of columns into a table.
| string | $table | Name of table |
Implements Database.
Definition at line 941 of file sqlite3.class.php.
| DoliDBSqlite3::DDLListTables | ( | $database, | |
| $table = '' ) |
List tables into a database.
| string | $database | Name of database |
| string | $table | Name of table filter ('xxx') |
Implements Database.
Definition at line 877 of file sqlite3.class.php.
| DoliDBSqlite3::DDLListTablesFull | ( | $database, | |
| $table = '' ) |
List tables into a database with table type.
| string | $database | Name of database |
| string | $table | Name of table filter ('xxx') |
Implements Database.
Definition at line 909 of file sqlite3.class.php.
| DoliDBSqlite3::DDLUpdateField | ( | $table, | |
| $field_name, | |||
| $field_desc ) |
Update format of a field into a table.
| string | $table | Name of table |
| string | $field_name | Name of field to modify |
| array{type:string,label:string,enabled:int<0,2>|string,position:int,notnull?:int,visible:int,noteditable?:int,default?:string,index?:int,foreignkey?:string,searchall?:int,isameasure?:int,css?:string,csslist?:string,help?:string,showoncombobox?:int,disabled?:int,arrayofkeyval?:array<int,string>,comment?:string} | $field_desc Array with description of field format |
Implements Database.
Definition at line 1152 of file sqlite3.class.php.
| DoliDBSqlite3::decrypt | ( | $value | ) |
Decrypt sensitive data in database.
| string | $value | Value to decrypt |
Implements Database.
Definition at line 800 of file sqlite3.class.php.
| DoliDBSqlite3::encrypt | ( | $fieldorvalue, | |
| $withQuotes = 1 ) |
Encrypt sensitive data in database Warning: This function includes the escape and add the SQL simple quotes on strings.
| string | $fieldorvalue | Field name or value to encrypt |
| int | $withQuotes | Return string including the SQL simple quotes. This param must always be 1 (Value 0 is bugged and deprecated). |
Implements Database.
Definition at line 771 of file sqlite3.class.php.
References escape().
| DoliDBSqlite3::errno | ( | ) |
Renvoie le code erreur generique de l'operation precedente.
Implements Database.
Definition at line 670 of file sqlite3.class.php.
References error().
Referenced by query().
| DoliDBSqlite3::error | ( | ) |
Renvoie le texte de l'erreur mysql de l'operation precedente.
Implements Database.
Definition at line 739 of file sqlite3.class.php.
Referenced by __construct(), addCustomFunction(), connect(), errno(), and query().
| DoliDBSqlite3::escape | ( | $stringtoencode | ) |
Escape a string to insert data.
| string | $stringtoencode | String to escape |
Implements Database.
Definition at line 649 of file sqlite3.class.php.
| DoliDBSqlite3::escapeforlike | ( | $stringtoencode | ) |
Escape a string to insert data into a like.
| string | $stringtoencode | String to escape |
Implements Database.
Definition at line 660 of file sqlite3.class.php.
| DoliDBSqlite3::fetch_array | ( | $resultset | ) |
Return datas as an array.
| SQLite3Result | $resultset | Resultset of request |
Implements Database.
Definition at line 544 of file sqlite3.class.php.
Referenced by getPathOfDump(), and getPathOfRestore().
| DoliDBSqlite3::fetch_object | ( | $resultset | ) |
Returns the current line (as an object) for the resultset cursor.
| SQLite3Result | $resultset | Curseur de la requete voulue |
Implements Database.
Definition at line 521 of file sqlite3.class.php.
| DoliDBSqlite3::fetch_row | ( | $resultset | ) |
Return datas as an array.
| SQLite3Result | $resultset | Resultset of request |
Implements Database.
Definition at line 563 of file sqlite3.class.php.
Referenced by getServerParametersValues().
| DoliDBSqlite3::free | ( | $resultset = null | ) |
Free last resultset used.
| SQLite3Result | $resultset | Curseur de la requete voulue |
Implements Database.
Definition at line 631 of file sqlite3.class.php.
| DoliDBSqlite3::getDefaultCharacterSetDatabase | ( | ) |
Return charset used to store data in database.
Implements Database.
Definition at line 1240 of file sqlite3.class.php.
| DoliDBSqlite3::getDefaultCollationDatabase | ( | ) |
Return collation used in database.
Implements Database.
Definition at line 1264 of file sqlite3.class.php.
| DoliDBSqlite3::getDriverInfo | ( | ) |
Return version of database client driver.
Implements Database.
Definition at line 370 of file sqlite3.class.php.
| DoliDBSqlite3::getListOfCharacterSet | ( | ) |
Return list of available charset that can be used to store data in database.
Implements Database.
Definition at line 1250 of file sqlite3.class.php.
| DoliDBSqlite3::getListOfCollation | ( | ) |
Return list of available collation that can be used for database.
Implements Database.
Definition at line 1274 of file sqlite3.class.php.
| DoliDBSqlite3::getPathOfDump | ( | ) |
Return full path of dump program.
Implements Database.
Definition at line 1288 of file sqlite3.class.php.
References fetch_array().
| DoliDBSqlite3::getPathOfRestore | ( | ) |
Return full path of restore program.
Implements Database.
Definition at line 1307 of file sqlite3.class.php.
References fetch_array(), and query().
| DoliDBSqlite3::getServerParametersValues | ( | $filter = '' | ) |
Return value of server parameters.
| string | $filter | Filter list on a particular value |
Implements Database.
Definition at line 1327 of file sqlite3.class.php.
References fetch_row(), and query().
| DoliDBSqlite3::getServerStatusValues | ( | $filter = '' | ) |
Return value of server status.
| string | $filter | Filter list on a particular value |
Implements Database.
Definition at line 1374 of file sqlite3.class.php.
| DoliDBSqlite3::getVersion | ( | ) |
Return version of database server.
Implements Database.
Definition at line 359 of file sqlite3.class.php.
| DoliDBSqlite3::last_insert_id | ( | $tab, | |
| $fieldid = 'rowid' ) |
Get last ID after an insert INSERT.
| string | $tab | Table name concerned by insert. Ne sert pas sous MySql mais requis pour compatibilite avec Postgresql |
| string | $fieldid | Field name |
Implements Database.
Definition at line 757 of file sqlite3.class.php.
| DoliDBSqlite3::num_rows | ( | $resultset | ) |
Return number of lines for result of a SELECT.
| SQLite3Result | $resultset | Resulset of requests |
Implements Database.
Definition at line 586 of file sqlite3.class.php.
Referenced by affected_rows().
| DoliDBSqlite3::query | ( | $query, | |
| $usesavepoint = 0, | |||
| $type = 'auto', | |||
| $result_mode = 0 ) |
Execute a SQL request and return the resultset.
| string | $query | SQL query string |
| int | $usesavepoint | 0=Default mode, 1=Run a savepoint before and a rollbock to savepoint if error (this allow to have some request with errors inside global transactions). Note that with Mysql, this parameter is not used as Myssql can already commit a transaction even if one request is in error, without using savepoints. |
| string | $type | Type of SQL order ('ddl' for insert, update, select, delete or 'dml' for create, alter...) |
| int | $result_mode | Result mode (not used with sqlite) |
Implements Database.
Definition at line 406 of file sqlite3.class.php.
References $type, convertSQLFromMysql(), dol_syslog(), errno(), error(), escape(), DoliDB\lasterrno(), DoliDB\lasterror(), DoliDB\lastquery(), DoliDB\lastqueryerror(), and query().
Referenced by getPathOfRestore(), getServerParametersValues(), and query().
| DoliDBSqlite3::select_db | ( | $database | ) |
Select a database.
| string | $database | Name of database |
Implements Database.
Definition at line 305 of file sqlite3.class.php.
References dol_syslog().