dolibarr  7.0.0-beta
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
DoliDBMssql Class Reference

Classe de gestion de la database de dolibarr. More...

+ Inheritance diagram for DoliDBMssql:
+ Collaboration diagram for DoliDBMssql:

Public Member Functions

 __construct ($type, $host, $user, $pass, $name='', $port=0)
 Constructor. More...
 
 select_db ($database)
 Select a database. More...
 
 connect ($host, $login, $passwd, $name, $port=0)
 Connexion to server. More...
 
 getVersion ()
 Return version of database server. More...
 
 getDriverInfo ()
 Return version of database client driver. More...
 
 close ()
 Close database connexion. More...
 
 begin ()
 Start transaction. More...
 
 commit ($log='')
 Validate a database transaction. More...
 
 rollback ($log='')
 Annulation d'une transaction et retour aux anciennes valeurs. More...
 
 query ($query, $usesavepoint=0, $type='auto')
 Execute a SQL request and return the resultset. More...
 
 fetch_object ($resultset)
 Renvoie la ligne courante (comme un objet) pour le curseur resultset. More...
 
 fetch_array ($resultset)
 Return datas as an array. More...
 
 fetch_row ($resultset)
 Return datas as an array. More...
 
 num_rows ($resultset)
 Return number of lines for result of a SELECT. More...
 
 affected_rows ($resultset)
 Renvoie le nombre de lignes dans le resultat d'une requete INSERT, DELETE ou UPDATE. More...
 
 free ($resultset=null)
 Free last resultset used. More...
 
 escape ($stringtoencode)
 Escape a string to insert data. More...
 
 idate ($param)
 Convert (by PHP) a GM Timestamp date into a PHP server TZ to insert into a date field. More...
 
 errno ()
 Return generic error code of last operation. More...
 
 error ()
 Return description of last error. More...
 
 last_insert_id ($tab, $fieldid='rowid')
 Get last ID after an insert INSERT. More...
 
 encrypt ($fieldorvalue, $withQuotes=0)
 Encrypt sensitive data in database Warning: This function includes the escape, so it must use direct value. More...
 
 decrypt ($value)
 Decrypt sensitive data in database. More...
 
 DDLGetConnectId ()
 Return connexion ID. 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...
 
 DDLListTables ($database, $table='')
 List tables into a database. More...
 
 DDLInfoTable ($table)
 List information of columns into a table. 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...
 
 DDLDescTable ($table, $field="")
 Return a pointer of line with description of a table or field. More...
 
 DDLAddField ($table, $field_name, $field_desc, $field_position="")
 Create a new field into table. More...
 
 DDLUpdateField ($table, $field_name, $field_desc)
 Update format of a field into a table. More...
 
 DDLDropField ($table, $field_name)
 Drop a field from table. 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...
 
 getDefaultCharacterSetDatabase ()
 Return charset used to store data in database. More...
 
 getListOfCharacterSet ()
 Return list of available charset that can be used to store data in database. More...
 
 getDefaultCollationDatabase ()
 Return collation used in database. More...
 
 getListOfCollation ()
 Return list of available collation that can be used for database. More...
 
 getPathOfDump ()
 Return full path of dump program. More...
 
 getPathOfRestore ()
 Return full path of restore program. More...
 
 getServerParametersValues ($filter='')
 Return value of server parameters. More...
 
 getServerStatusValues ($filter='')
 Return value of server status. More...
 
 EscapeFieldName ($fieldname)
 Escape a field name according to escape's syntax. More...
 
 GetFieldInformation ($table, $fields)
 Get information on field. More...
 
- Public Member Functions inherited from DoliDB
 ifsql ($test, $resok, $resko)
 Format a SQL IF. 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...
 
 lasterrno ()
 Return last error code. More...
 
 begin ()
 Start transaction. More...
 
 commit ($log='')
 Validate a database transaction. More...
 
 rollback ($log='')
 Annulation d'une transaction et retour aux anciennes valeurs. 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=false)
 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...
 

Static Public Member Functions

static convertSQLFromMysql ($line, $type='ddl')
 Convert a SQL request in Mysql syntax to native syntax. More...
 

Public Attributes

 $type ='mssql'
 Database type.
 
const LABEL ='MSSQL'
 Database label.
 
 $forcecharset ='latin1'
 Charset used to force charset when creating database.
 
 $forcecollate ='latin1_swedish_ci'
 Collate used to force collate when creating database.
 
const VERSIONMIN ='2000'
 Version min database.
 

Detailed Description

Classe de gestion de la database de dolibarr.

Definition at line 32 of file mssql.class.php.

Constructor & Destructor Documentation

DoliDBMssql::__construct (   $type,
  $host,
  $user,
  $pass,
  $name = '',
  $port = 0 
)

Constructor.

This create an opened connexion to a database server and eventually to a database

Parameters
string$typeType of database (mysql, pgsql...)
string$hostAddress of database server
string$userNom de l'utilisateur autorise
string$passMot de passe
string$nameNom de la database
int$portPort of database server

Definition at line 58 of file mssql.class.php.

References connect(), dol_syslog(), error(), and select_db().

Member Function Documentation

DoliDBMssql::affected_rows (   $resultset)

Renvoie le nombre de lignes dans le resultat d'une requete INSERT, DELETE ou UPDATE.

Parameters
resource$resultsetCurseur de la requete voulue
Returns
int Nombre de lignes
See also
num_rows

Implements Database.

Definition at line 523 of file mssql.class.php.

DoliDBMssql::begin ( )

Start transaction.

Returns
bool true if transaction successfuly opened or already opened, false if error

Implements Database.

Definition at line 236 of file mssql.class.php.

References dol_syslog().

DoliDBMssql::close ( )

Close database connexion.

Returns
bool True if disconnect successfull, false otherwise
See also
connect

Implements Database.

Definition at line 219 of file mssql.class.php.

References dol_syslog().

DoliDBMssql::commit (   $log = '')

Validate a database transaction.

Parameters
string$logAdd more log to default log line
Returns
bool true if validation is OK or transaction level no started, false if ERROR

Implements Database.

Definition at line 264 of file mssql.class.php.

References dol_syslog().

DoliDBMssql::connect (   $host,
  $login,
  $passwd,
  $name,
  $port = 0 
)

Connexion to server.

Parameters
string$hostdatabase server host
string$loginlogin
string$passwdpassword
string$namename of database (not used for mysql, used for pgsql)
int$portPort of database server
Returns
false|resource|true Database access handler
See also
close

Implements Database.

Definition at line 164 of file mssql.class.php.

References dol_syslog().

Referenced by __construct().

static DoliDBMssql::convertSQLFromMysql (   $line,
  $type = 'ddl' 
)
static

Convert a SQL request in Mysql syntax to native syntax.

Parameters
string$lineSQL request line to convert
string$typeType of SQL order ('ddl' for insert, update, select, delete or 'dml' for create, alter...)
Returns
string SQL request line converted

Implements Database.

Definition at line 137 of file mssql.class.php.

DoliDBMssql::DDLAddField (   $table,
  $field_name,
  $field_desc,
  $field_position = "" 
)

Create a new field into table.

Parameters
string$tableName of table
string$field_nameName of field to add
string$field_descTableau associatif de description du champ a inserer[nom du parametre][valeur du parametre]
string$field_positionOptionnel ex.: "after champtruc"
Returns
int <0 if KO, >0 if OK

Implements Database.

Definition at line 907 of file mssql.class.php.

References query().

DoliDBMssql::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.

Parameters
string$databaseDatabase name to create
string$charsetCharset used to store data
string$collationCharset used to sort data
string$ownerUsername of database owner
Returns
false|resource|true resource defined if OK, false if KO

Implements Database.

Definition at line 732 of file mssql.class.php.

References query(), and select_db().

DoliDBMssql::DDLCreateTable (   $table,
  $fields,
  $primary_key,
  $type,
  $unique_keys = null,
  $fulltext_keys = null,
  $keys = null 
)

Create a table into database.

Parameters
string$tableNom de la table
array$fieldsTableau associatif [nom champ][tableau des descriptions]
string$primary_keyNom du champ qui sera la clef primaire
string$typeType de la table
array$unique_keysTableau associatifs Nom de champs qui seront clef unique => valeur
array$fulltext_keysTableau des Nom de champs qui seront indexes en fulltext
array$keysTableau des champs cles noms => valeur
Returns
int <0 if KO, >=0 if OK

Implements Database.

Definition at line 799 of file mssql.class.php.

References dol_syslog(), and query().

DoliDBMssql::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)

Parameters
string$dolibarr_main_db_hostIp serveur
string$dolibarr_main_db_userNom user a creer
string$dolibarr_main_db_passMot de passe user a creer
string$dolibarr_main_db_nameDatabase name where user must be granted
Returns
int <0 if KO, >=0 if OK

Implements Database.

Definition at line 985 of file mssql.class.php.

References $resql, dol_syslog(), DoliDB\lasterrno(), query(), and select_db().

DoliDBMssql::DDLDescTable (   $table,
  $field = "" 
)

Return a pointer of line with description of a table or field.

Parameters
string$tableName of table
string$fieldOptionnel : Name of field if we want description of field
Returns
false|resource|true Resource

Implements Database.

Definition at line 889 of file mssql.class.php.

References dol_syslog(), and query().

DoliDBMssql::DDLDropField (   $table,
  $field_name 
)

Drop a field from table.

Parameters
string$tableName of table
string$field_nameName of field to drop
Returns
int <0 if KO, >0 if OK

Implements Database.

Definition at line 964 of file mssql.class.php.

References dol_syslog(), error(), DoliDB\lasterror(), and query().

DoliDBMssql::DDLDropTable (   $table)

Drop a table into database.

Parameters
string$tableName of table
Returns
int <0 if KO, >=0 if OK

Implements Database.

Definition at line 872 of file mssql.class.php.

References query().

DoliDBMssql::DDLGetConnectId ( )

Return connexion ID.

Returns
string Id connexion

Implements Database.

Definition at line 710 of file mssql.class.php.

References $resql, fetch_row(), and query().

DoliDBMssql::DDLInfoTable (   $table)

List information of columns into a table.

Parameters
string$tableName of table
Returns
array Tableau des informations des champs de la table

Implements Database.

Definition at line 776 of file mssql.class.php.

DoliDBMssql::DDLListTables (   $database,
  $table = '' 
)

List tables into a database.

Parameters
string$databaseName of database
string$tableNmae of table filter ('xxx')
Returns
array List of tables in an array

Implements Database.

Definition at line 764 of file mssql.class.php.

DoliDBMssql::DDLUpdateField (   $table,
  $field_name,
  $field_desc 
)

Update format of a field into a table.

Parameters
string$tableName of table
string$field_nameName of field to modify
string$field_descArray with description of field format
Returns
int <0 if KO, >0 if OK

Implements Database.

Definition at line 942 of file mssql.class.php.

References dol_syslog(), and query().

DoliDBMssql::decrypt (   $value)

Decrypt sensitive data in database.

Parameters
string$valueValue to decrypt
Returns
string Decrypted value if used

Implements Database.

Definition at line 690 of file mssql.class.php.

DoliDBMssql::encrypt (   $fieldorvalue,
  $withQuotes = 0 
)

Encrypt sensitive data in database Warning: This function includes the escape, so it must use direct value.

Parameters
string$fieldorvalueField name or value to encrypt
int$withQuotesReturn string with quotes
Returns
string XXX(field) or XXX('value') or field or 'value'

Implements Database.

Definition at line 670 of file mssql.class.php.

DoliDBMssql::errno ( )

Return generic error code of last operation.

Returns
string Error code (Exemples: DB_ERROR_TABLE_ALREADY_EXISTS, DB_ERROR_RECORD_ALREADY_EXISTS...)

Implements Database.

Definition at line 578 of file mssql.class.php.

References DoliDB\lasterrno().

DoliDBMssql::error ( )

Return description of last error.

Returns
string Error text

Implements Database.

Definition at line 631 of file mssql.class.php.

Referenced by __construct(), DDLDropField(), and query().

DoliDBMssql::escape (   $stringtoencode)

Escape a string to insert data.

Parameters
string$stringtoencodeString to escape
Returns
string String escaped

Implements Database.

Definition at line 555 of file mssql.class.php.

DoliDBMssql::EscapeFieldName (   $fieldname)

Escape a field name according to escape's syntax.

Parameters
string$fieldnameField's name to escape
Returns
string field's name escaped

Definition at line 1141 of file mssql.class.php.

DoliDBMssql::fetch_array (   $resultset)

Return datas as an array.

Parameters
resource$resultsetResultset of request
Returns
array|false Array or false if KO or end of cursor

Implements Database.

Definition at line 481 of file mssql.class.php.

Referenced by getDefaultCollationDatabase(), getVersion(), and last_insert_id().

DoliDBMssql::fetch_object (   $resultset)

Renvoie la ligne courante (comme un objet) pour le curseur resultset.

Parameters
resource$resultsetCurseur de la requete voulue
Returns
object|false Object result line or false if KO or end of cursor

Implements Database.

Definition at line 468 of file mssql.class.php.

DoliDBMssql::fetch_row (   $resultset)

Return datas as an array.

Parameters
resource$resultsetResultset of request
Returns
array|false Array or false if KO or end of cursor

Implements Database.

Definition at line 495 of file mssql.class.php.

Referenced by DDLGetConnectId().

DoliDBMssql::free (   $resultset = null)

Free last resultset used.

Parameters
resource$resultsetCurseur de la requete voulue
Returns
bool

Implements Database.

Definition at line 541 of file mssql.class.php.

DoliDBMssql::getDefaultCharacterSetDatabase ( )

Return charset used to store data in database.

Returns
string Charset

Implements Database.

Definition at line 1028 of file mssql.class.php.

DoliDBMssql::getDefaultCollationDatabase ( )

Return collation used in database.

Returns
string Collation value

Implements Database.

Definition at line 1054 of file mssql.class.php.

References $forcecollate, $resql, fetch_array(), and query().

DoliDBMssql::getDriverInfo ( )

Return version of database client driver.

Returns
string Version string

Implements Database.

Definition at line 208 of file mssql.class.php.

DoliDBMssql::GetFieldInformation (   $table,
  $fields 
)

Get information on field.

Parameters
string$tableTable name which contains fields
mixed$fieldsString for one field or array of string for multiple field
Returns
false|object

Definition at line 1153 of file mssql.class.php.

Referenced by query().

DoliDBMssql::getListOfCharacterSet ( )

Return list of available charset that can be used to store data in database.

Returns
array List of Charset

Implements Database.

Definition at line 1041 of file mssql.class.php.

DoliDBMssql::getListOfCollation ( )

Return list of available collation that can be used for database.

Returns
array Liste of Collation

Implements Database.

Definition at line 1070 of file mssql.class.php.

DoliDBMssql::getPathOfDump ( )

Return full path of dump program.

Returns
string Full path of dump program

Implements Database.

Definition at line 1083 of file mssql.class.php.

DoliDBMssql::getPathOfRestore ( )

Return full path of restore program.

Returns
string Full path of restore program

Implements Database.

Definition at line 1096 of file mssql.class.php.

DoliDBMssql::getServerParametersValues (   $filter = '')

Return value of server parameters.

Parameters
string$filterFilter list on a particular value
Returns
array Array of key-values (key=>value)

Implements Database.

Definition at line 1110 of file mssql.class.php.

DoliDBMssql::getServerStatusValues (   $filter = '')

Return value of server status.

Parameters
string$filterFilter list on a particular value
Returns
array Array of key-values (key=>value)

Implements Database.

Definition at line 1126 of file mssql.class.php.

DoliDBMssql::getVersion ( )

Return version of database server.

Returns
string Version string

Implements Database.

Definition at line 192 of file mssql.class.php.

References $resql, fetch_array(), and query().

DoliDBMssql::idate (   $param)

Convert (by PHP) a GM Timestamp date into a PHP server TZ to insert into a date field.

Function to use to build INSERT, UPDATE or WHERE predica

Parameters
string$paramDate TMS to convert
Returns
string Date in a string YYYY-MM-DD HH:MM:SS

Implements Database.

Definition at line 568 of file mssql.class.php.

References dol_print_date().

DoliDBMssql::last_insert_id (   $tab,
  $fieldid = 'rowid' 
)

Get last ID after an insert INSERT.

Parameters
string$tabTable name concerned by insert. Ne sert pas sous MySql mais requis pour compatibilite avec Postgresql
string$fieldidField name
Returns
int Id of row or -1 on error

Implements Database.

Definition at line 649 of file mssql.class.php.

References fetch_array(), and query().

DoliDBMssql::num_rows (   $resultset)

Return number of lines for result of a SELECT.

Parameters
resource$resultsetResulset of requests
Returns
int Nb of lines
See also
affected_rows

Implements Database.

Definition at line 509 of file mssql.class.php.

DoliDBMssql::query (   $query,
  $usesavepoint = 0,
  $type = 'auto' 
)

Execute a SQL request and return the resultset.

Parameters
string$querySQL query string
int$usesavepoint0=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$typeType of SQL order ('ddl' for insert, update, select, delete or 'dml' for create, alter...)
Returns
false|resource|true Resultset of answer

Implements Database.

Definition at line 325 of file mssql.class.php.

References $type, dol_syslog(), error(), GetFieldInformation(), DoliDB\lasterrno(), DoliDB\lasterror(), DoliDB\lastquery(), and DoliDB\lastqueryerror().

Referenced by DDLAddField(), DDLCreateDb(), DDLCreateTable(), DDLCreateUser(), DDLDescTable(), DDLDropField(), DDLDropTable(), DDLGetConnectId(), DDLUpdateField(), getDefaultCollationDatabase(), getVersion(), and last_insert_id().

DoliDBMssql::rollback (   $log = '')

Annulation d'une transaction et retour aux anciennes valeurs.

Parameters
string$logAdd more log to default log line
Returns
bool true si annulation ok ou transaction non ouverte, false en cas d'erreur

Implements Database.

Definition at line 297 of file mssql.class.php.

References dol_syslog().

DoliDBMssql::select_db (   $database)

Select a database.

Parameters
string$databaseName of database
Returns
boolean true if OK, false if KO

Implements Database.

Definition at line 148 of file mssql.class.php.

Referenced by __construct(), DDLCreateDb(), and DDLCreateUser().


The documentation for this class was generated from the following file: