Dolibarr ERP CRM Wiki

Changes

Sprachen und Programmierregeln (view source)

Revision as of 10:24, 8 March 2024

6 bytes removed ,  1 year ago
m
→‎Communication between business logic - data (ORM)
Line 18: Line 18:  
=Versionen=
 
=Versionen=
   −
*Dollibar muss funktionieren mit:
+
*Dolibarr muss funktionieren mit:
    
#Allen Betriebssystemen (Windows, Linux, MACOS...)
 
#Allen Betriebssystemen (Windows, Linux, MACOS...)
Line 28: Line 28:  
*Alle PHP-Dateien müssen mit einem Header beginnen, der folgendermaßen aussieht
 
*Alle PHP-Dateien müssen mit einem Header beginnen, der folgendermaßen aussieht
   −
<syntaxHighlight lang="php">
+
<syntaxhighlight lang="php">
 
<?php
 
<?php
 
/* Copyright (C) YYYY John Doe  <email@email.com>
 
/* Copyright (C) YYYY John Doe  <email@email.com>
Line 35: Line 35:  
  */
 
  */
 
...
 
...
−
</syntaxHighlight>
+
</syntaxhighlight>
 
Wenn Sie eine vorhandene Projektdatei bearbeiten, müssen Sie eine neue Copyright-Zeile im Header hinzufügen.
 
Wenn Sie eine vorhandene Projektdatei bearbeiten, müssen Sie eine neue Copyright-Zeile im Header hinzufügen.
   Line 43: Line 43:  
*Dolibarr ist in PHP geschrieben und unterstützt alle Versionen von PHP, welche höher sind, als {{PHPMinVersion}}. Alle Dateien müssen mit der Erweiterung .php enden.
 
*Dolibarr ist in PHP geschrieben und unterstützt alle Versionen von PHP, welche höher sind, als {{PHPMinVersion}}. Alle Dateien müssen mit der Erweiterung .php enden.
   −
*Die Verwendung von PHP superglobalen Variablen muss über die festgelegten Operatoren $_COOKIE, $_SERVER, $_ENV erfolgen.  
+
*Die Verwendung von PHP superglobalen Variablen muss über die festgelegten Operatoren $_COOKIE, $_SERVER, $_ENV erfolgen.
 
*Allerdings muss die Dolibarr-Funktion GETPOST () verwendet werden, um den Inhalt von $_GET oder $_POST abzurufen.
 
*Allerdings muss die Dolibarr-Funktion GETPOST () verwendet werden, um den Inhalt von $_GET oder $_POST abzurufen.
   Line 52: Line 52:  
*Wenn mehrere Variablen mit demselben Wert initialisiert werden sollen, müssen Sie einzelne Deklarationen verwenden (getrennt durch ''';''' ).
 
*Wenn mehrere Variablen mit demselben Wert initialisiert werden sollen, müssen Sie einzelne Deklarationen verwenden (getrennt durch ''';''' ).
   −
<syntaxHighlight lang="php">
+
<syntaxhighlight lang="php">
 
$var1=1;
 
$var1=1;
 
$var2=1;
 
$var2=1;
 
$var3=1;
 
$var3=1;
−
</syntaxHighlight>
+
</syntaxhighlight>
 
Anstelle von
 
Anstelle von
−
<syntaxHighlight lang="php">
+
<syntaxhighlight lang="php">
 
$var1=$var2=$var3=1;
 
$var1=$var2=$var3=1;
−
</syntaxHighlight>
+
</syntaxhighlight>
 
, weil es langsamer ist.
 
, weil es langsamer ist.
   Line 69: Line 69:  
*Zeichenfolgen müssen durch einfache oder doppelte Anführungszeichen begrenzt sein. Eine Variable innerhalb der Zeichenfolge muss außerhalb der Anführungszeichen liegen.
 
*Zeichenfolgen müssen durch einfache oder doppelte Anführungszeichen begrenzt sein. Eine Variable innerhalb der Zeichenfolge muss außerhalb der Anführungszeichen liegen.
   −
<syntaxHighlight lang="php">
+
<syntaxhighlight lang="php">
 
print 'My text show my '.$variable.' !';
 
print 'My text show my '.$variable.' !';
−
</syntaxHighlight>
+
</syntaxhighlight>
    
<br />
 
<br />
Line 79: Line 79:  
*Kommentare müssen die C-Syntax verwenden, das heißt einen doppelten Schrägstrich für einen Kommentar in einer Zeile oder einen Schrägstrich mit Stern, um einen Block für mehrere Zeilen zu öffnen
 
*Kommentare müssen die C-Syntax verwenden, das heißt einen doppelten Schrägstrich für einen Kommentar in einer Zeile oder einen Schrägstrich mit Stern, um einen Block für mehrere Zeilen zu öffnen
   −
<syntaxHighlight lang="php">
+
<syntaxhighlight lang="php">
 
/* Kommentarblock
 
/* Kommentarblock
 
  *
 
  *
Line 97: Line 97:  
     // Code
 
     // Code
 
}
 
}
−
</syntaxHighlight>
+
</syntaxhighlight>
    
*Funktionen müssen bei Erfolg einen Wert zurückgeben, der größer/gleich 0 ist und bei Fehlern zwingend kleiner als 0 ist
 
*Funktionen müssen bei Erfolg einen Wert zurückgeben, der größer/gleich 0 ist und bei Fehlern zwingend kleiner als 0 ist
Line 126: Line 126:  
==Dateiformat DDL==
 
==Dateiformat DDL==
 
Dateien, die die Definition der Datenbankstruktur enthalten (DDL-Dateien), benötigen 2 pro Tabelle:
 
Dateien, die die Definition der Datenbankstruktur enthalten (DDL-Dateien), benötigen 2 pro Tabelle:
 +
 
*Die erste Datei definiert die Tabelle und ihre Felder. Der Dateiname enthält den Tabellennamen, z. B. so: llx_mytable.sql
 
*Die erste Datei definiert die Tabelle und ihre Felder. Der Dateiname enthält den Tabellennamen, z. B. so: llx_mytable.sql
 +
 
Alle Tabellen sind mit einem Präfix versehen, um Namenskonflikte zu vermeiden. Das Präfix kann bei der Installation geändert werden. Der Standardwert ist llx_.
 
Alle Tabellen sind mit einem Präfix versehen, um Namenskonflikte zu vermeiden. Das Präfix kann bei der Installation geändert werden. Der Standardwert ist llx_.
   Line 136: Line 138:  
Example: '''file for creating the table llx_mytable will be llx_mytable.sql''':
 
Example: '''file for creating the table llx_mytable will be llx_mytable.sql''':
   −
<syntaxHighlight lang="sql">
+
<syntaxhighlight lang="sql">
 
-- ===========================================================================
 
-- ===========================================================================
 
-- Copyright (C) 2013 Author <email@author.com>
 
-- Copyright (C) 2013 Author <email@author.com>
Line 169: Line 171:  
   fk_user_mod    integer NOT NULL,                      -- Last updater, foreign key of llx_user
 
   fk_user_mod    integer NOT NULL,                      -- Last updater, foreign key of llx_user
 
   import_key varchar(14)                -- Use by import process
 
   import_key varchar(14)                -- Use by import process
−
)type=innodb;</syntaxHighlight>
+
)type=innodb;</syntaxhighlight>
    
Example: '''file for creating keys/indexes for the table llx_mytable will be llx_mytable.key.sql''':
 
Example: '''file for creating keys/indexes for the table llx_mytable will be llx_mytable.key.sql''':
   −
<syntaxHighlight lang="sql">
+
<syntaxhighlight lang="sql">
 
-- ===========================================================================
 
-- ===========================================================================
 
-- Copyright (C) 2013 Author <email@author.com>
 
-- Copyright (C) 2013 Author <email@author.com>
Line 194: Line 196:     
ALTER TABLE llx_mytable ADD CONSTRAINT fk_mytable_fk_field FOREIGN KEY (fk_field) REFERENCES llx_matablepere (rowid);
 
ALTER TABLE llx_mytable ADD CONSTRAINT fk_mytable_fk_field FOREIGN KEY (fk_field) REFERENCES llx_matablepere (rowid);
−
</syntaxHighlight>
+
</syntaxhighlight>
    
==Tabellen- und Feldstrukturen==
 
==Tabellen- und Feldstrukturen==
Line 271: Line 273:     
When doing select, we can use alias to simplify writing/reading of requests:
 
When doing select, we can use alias to simplify writing/reading of requests:
−
<syntaxHighlight lang="sql">
+
<syntaxhighlight lang="sql">
 
select chp1, chpxxx2 as chp2 from table2 as t1, table2 as t2 where t1.chpx = t2.chpy
 
select chp1, chpxxx2 as chp2 from table2 as t1, table2 as t2 where t1.chpx = t2.chpy
−
</syntaxHighlight>
+
</syntaxhighlight>
 
However, we must not used alias for update request as they are not compatible with Mysql 3.1.
 
However, we must not used alias for update request as they are not compatible with Mysql 3.1.
    
*Using SELECT * is forbidden ! When using SELECT you must define complete list of fields to get. This avoids confusion. And above all, this make reengeering of code easier and make impact analysis of change on a field possible. Example:
 
*Using SELECT * is forbidden ! When using SELECT you must define complete list of fields to get. This avoids confusion. And above all, this make reengeering of code easier and make impact analysis of change on a field possible. Example:
   −
<syntaxHighlight lang="sql">
+
<syntaxhighlight lang="sql">
 
SELECT field_a, field_b, field_c FROM table_1 WHERE field_d = '$id'
 
SELECT field_a, field_b, field_c FROM table_1 WHERE field_d = '$id'
−
</syntaxHighlight>
+
</syntaxhighlight>
    
*Into SQL requests, you must quote fields except the fields that contain amounts which must be stored as double or real type. Quotes on numbers may result in saving as a different value. For example 412.62 in an insert will be saved as value 412.61999512 into database (due to implicit conversion string to numeric) if the target field has type double(24,8). Only PHP see value 412.61999512. Other tools will see 412.62 giving a sense that there is no problem. But it's PHP that has the good vision. There is really a wrong value into database. By removing quotes on numbers, no problem occurs.
 
*Into SQL requests, you must quote fields except the fields that contain amounts which must be stored as double or real type. Quotes on numbers may result in saving as a different value. For example 412.62 in an insert will be saved as value 412.61999512 into database (due to implicit conversion string to numeric) if the target field has type double(24,8). Only PHP see value 412.61999512. Other tools will see 412.62 giving a sense that there is no problem. But it's PHP that has the good vision. There is really a wrong value into database. By removing quotes on numbers, no problem occurs.
    
Example:
 
Example:
−
<syntaxHighlight lang="sql">
+
<syntaxhighlight lang="sql">
 
Good:    INSERT INTO table_1 (field_txt, field_num) VALUES ('txt', 412.62)
 
Good:    INSERT INTO table_1 (field_txt, field_num) VALUES ('txt', 412.62)
 
Bad:      INSERT INTO table_1 (field_txt, field_num) VALUES ('txt', '412.62')
 
Bad:      INSERT INTO table_1 (field_txt, field_num) VALUES ('txt', '412.62')
−
</syntaxHighlight>
+
</syntaxhighlight>
    
Note, problem of float numbers is same problem on all langauges and not only when inserting data into database. It occurs also with any language when you work on "real" numbers, so numbers must be, as soon as they are affected, cleaned with function price2num with second parameter defined to :
 
Note, problem of float numbers is same problem on all langauges and not only when inserting data into database. It occurs also with any language when you work on "real" numbers, so numbers must be, as soon as they are affected, cleaned with function price2num with second parameter defined to :
Line 296: Line 298:     
For example, don't do:
 
For example, don't do:
−
<syntaxHighlight lang="php">
+
<syntaxhighlight lang="php">
 
$sql="SELECT rowid FROM table where datefield = NOW()";
 
$sql="SELECT rowid FROM table where datefield = NOW()";
−
</syntaxHighlight>
+
</syntaxhighlight>
 
but do:
 
but do:
−
<syntaxHighlight lang="php">
+
<syntaxhighlight lang="php">
 
$sql="SELECT rowid FROM table where datefield = '".$this->db->idate(dol_now())."'";
 
$sql="SELECT rowid FROM table where datefield = '".$this->db->idate(dol_now())."'";
−
</syntaxHighlight>
+
</syntaxhighlight>
    
For example, don't do:
 
For example, don't do:
−
<syntaxHighlight lang="php">
+
<syntaxhighlight lang="php">
 
$sql="SELECT rowid FROM table where DATEDIFF(table.datefield, NOW()) > 7";
 
$sql="SELECT rowid FROM table where DATEDIFF(table.datefield, NOW()) > 7";
−
</syntaxHighlight>
+
</syntaxhighlight>
 
but do:
 
but do:
−
<syntaxHighlight lang="php">
+
<syntaxhighlight lang="php">
 
$sql="SELECT rowid FROM table where datefield < '".$this->db->idate(dol_now() - (7 * 24 * 3600))."'";
 
$sql="SELECT rowid FROM table where datefield < '".$this->db->idate(dol_now() - (7 * 24 * 3600))."'";
−
</syntaxHighlight>
+
</syntaxhighlight>
    
An other advantage of this rule, is that request benefits of index because we are making a compare of a field with a fixed value. When using datediff, you make an operation on field before comparison, this means database can't use the index on field, resulting on very bad performance compared to solution without the datediff.
 
An other advantage of this rule, is that request benefits of index because we are making a compare of a field with a fixed value. When using datediff, you make an operation on field before comparison, this means database can't use the index on field, resulting on very bad performance compared to solution without the datediff.
Line 335: Line 337:     
To activate it (required when developing on Dolibarr), add the following line into the config file of your Mysql server (my.cnf or my.ini)
 
To activate it (required when developing on Dolibarr), add the following line into the config file of your Mysql server (my.cnf or my.ini)
−
<syntaxHighlight lang="ini">
+
<syntaxhighlight lang="ini">
 
sql-mode="STRICT_ALL_TABLES,ONLY_FULL_GROUP_BY,NO_ZERO_DATE"
 
sql-mode="STRICT_ALL_TABLES,ONLY_FULL_GROUP_BY,NO_ZERO_DATE"
−
</syntaxHighlight>
+
</syntaxhighlight>
    
==PostgreSQL specificities==
 
==PostgreSQL specificities==
Line 346: Line 348:     
MySQL Syntax:
 
MySQL Syntax:
−
<syntaxHighlight lang="sql">
+
<syntaxhighlight lang="sql">
 
UPDATE table_taget as target, table_source as source SET fieldtarget=source.fieldsource
 
UPDATE table_taget as target, table_source as source SET fieldtarget=source.fieldsource
 
WHERE source.rowid=target.rowid;
 
WHERE source.rowid=target.rowid;
−
</syntaxHighlight>
+
</syntaxhighlight>
    
PgSQL Syntax:
 
PgSQL Syntax:
−
<syntaxHighlight lang="sql">
+
<syntaxhighlight lang="sql">
 
UPDATE table_taget as target SET fieldtarget=source.fieldsource
 
UPDATE table_taget as target SET fieldtarget=source.fieldsource
 
FROM table_source as source WHERE source.rowid=target.rowid;
 
FROM table_source as source WHERE source.rowid=target.rowid;
−
</syntaxHighlight>
+
</syntaxhighlight>
    
There is no native SQL requests "UPDATE FROM" in all Dolibarr core. But if you use one in your own code of your module, you should do :
 
There is no native SQL requests "UPDATE FROM" in all Dolibarr core. But if you use one in your own code of your module, you should do :
−
<syntaxHighlight lang="php">
+
<syntaxhighlight lang="php">
 
if ($this->db->type=='pgsql') {
 
if ($this->db->type=='pgsql') {
 
$sql="UPDATE table_taget as target SET fieldtarget=source.fieldsource
 
$sql="UPDATE table_taget as target SET fieldtarget=source.fieldsource
Line 366: Line 368:  
WHERE source.rowid=target.rowid";
 
WHERE source.rowid=target.rowid";
 
}
 
}
−
</syntaxHighlight>
+
</syntaxhighlight>
    
=HTML norms=
 
=HTML norms=
Line 376: Line 378:     
For example:
 
For example:
−
<syntaxHighlight lang="php">
+
<syntaxhighlight lang="php">
 
print '<a href="'.dol_buildpath('/mydir/mypage.php').'">'.img_picto('Texte alt','namepictopng','').'</a>';
 
print '<a href="'.dol_buildpath('/mydir/mypage.php').'">'.img_picto('Texte alt','namepictopng','').'</a>';
−
</syntaxHighlight>
+
</syntaxhighlight>
    
*HTML tables must have columns with no forced width, except for columns that contains data we know the length. For example, a column with a picto only can be forced to with="20px".
 
*HTML tables must have columns with no forced width, except for columns that contains data we know the length. For example, a column with a picto only can be forced to with="20px".
Line 386: Line 388:  
*Javascript/ajax code and call to javascript files into php pages must be avoided. However, if you need to include javascript code, you must add a condition on "$conf->use_javascript_ajax"
 
*Javascript/ajax code and call to javascript files into php pages must be avoided. However, if you need to include javascript code, you must add a condition on "$conf->use_javascript_ajax"
   −
<syntaxHighlight lang="php">
+
<syntaxhighlight lang="php">
 
if ($conf->use_javascript_ajax) {
 
if ($conf->use_javascript_ajax) {
 
...  // php code generating javascript here
 
...  // php code generating javascript here
 
}
 
}
−
</syntaxHighlight>
+
</syntaxhighlight>
    
*Popup windows must not be used, except for tooltips (and must have a condition as explained before).
 
*Popup windows must not be used, except for tooltips (and must have a condition as explained before).
Line 449: Line 451:  
With PHP, like other languages (Java for exemple), non integer data (float, real, double) are not reliable for calculation.
 
With PHP, like other languages (Java for exemple), non integer data (float, real, double) are not reliable for calculation.
 
Try to make for example  
 
Try to make for example  
−
<syntaxHighlight lang="php">
+
<syntaxhighlight lang="php">
 
print 239.2 - 229.3 - 9.9;
 
print 239.2 - 229.3 - 9.9;
−
</syntaxHighlight>
+
</syntaxhighlight>
 
You wont get zero but a very small decimal number. If you get zero her, you should be able to find other examples that don't work.
 
You wont get zero but a very small decimal number. If you get zero her, you should be able to find other examples that don't work.
 
Problem of float is general, so a variable that is a result of a calculation using decimal numbers must ALWAYS be cleaned using the function '''price2num()''' with the econd parameter to: 'MU', 'MT' or 'MS' depending on need (see description of function).
 
Problem of float is general, so a variable that is a result of a calculation using decimal numbers must ALWAYS be cleaned using the function '''price2num()''' with the econd parameter to: 'MU', 'MT' or 'MS' depending on need (see description of function).
−
<syntaxHighlight lang="php">
+
<syntaxhighlight lang="php">
 
print price2num(239.2 - 229.3 - 9.9, 'MT');
 
print price2num(239.2 - 229.3 - 9.9, 'MT');
−
</syntaxHighlight>
+
</syntaxhighlight>
 
If data manipulated is not an amount, then using MU, MT, MS has no sense, and you must use the function '''round()'''.
 
If data manipulated is not an amount, then using MU, MT, MS has no sense, and you must use the function '''round()'''.
   Line 465: Line 467:  
==Comparing version==
 
==Comparing version==
 
If your code need to make different things depending on Dolibarr version, you can use the following tip to detect and compare versions
 
If your code need to make different things depending on Dolibarr version, you can use the following tip to detect and compare versions
−
<syntaxHighlight lang="php">
+
<syntaxhighlight lang="php">
 
$version=preg_split('/[\.-]/',DOL_VERSION);
 
$version=preg_split('/[\.-]/',DOL_VERSION);
 
if (versioncompare($version,array(5,0,-4)) >= 0) { //mycode for 5.0 only; } // For dolibarr 5.0.* (the -4 means we include also alpha, beta, rc and rcX)
 
if (versioncompare($version,array(5,0,-4)) >= 0) { //mycode for 5.0 only; } // For dolibarr 5.0.* (the -4 means we include also alpha, beta, rc and rcX)
−
</syntaxHighlight>
+
</syntaxhighlight>
    
But this solution need to include the function versioncompare. An alternative solution to test version is to do:
 
But this solution need to include the function versioncompare. An alternative solution to test version is to do:
−
<syntaxHighlight lang="php">
+
<syntaxhighlight lang="php">
 
if ((float) DOL_VERSION >= 5.0) { //mycode for 5.0 only; } // For dolibarr 5.0.*
 
if ((float) DOL_VERSION >= 5.0) { //mycode for 5.0 only; } // For dolibarr 5.0.*
−
</syntaxHighlight>
+
</syntaxhighlight>
    
==Logs==
 
==Logs==
 
Add logs to your code using function
 
Add logs to your code using function
−
<syntaxHighlight lang="php">
+
<syntaxhighlight lang="php">
 
dol_syslog($yourmessage, LOG_INFO|LOG_DEBUG|LOG_WARNING|LOG_ERR);
 
dol_syslog($yourmessage, LOG_INFO|LOG_DEBUG|LOG_WARNING|LOG_ERR);
−
</syntaxHighlight>
+
</syntaxhighlight>
    
==Working directory==
 
==Working directory==
Line 486: Line 488:     
The directory can be created into your code by the following function:
 
The directory can be created into your code by the following function:
−
<syntaxHighlight lang="php">
+
<syntaxhighlight lang="php">
 
$mymoduledir=DOL_DATA_ROOT.'/mymodule';
 
$mymoduledir=DOL_DATA_ROOT.'/mymodule';
 
dol_mkdir($mymoduledir);
 
dol_mkdir($mymoduledir);
−
</syntaxHighlight>
+
</syntaxhighlight>
    
If you need a directory to store temporary data, this directory must be '''DOL_DATA_ROOT.'/mymodule/temp''''
 
If you need a directory to store temporary data, this directory must be '''DOL_DATA_ROOT.'/mymodule/temp''''
Line 534: Line 536:  
*The '''Table And Row Data Gateway'''
 
*The '''Table And Row Data Gateway'''
   −
This is the most simple. You have one class per table and each class is a link to the table with CRUD methods (Ceate, Read, Update, Delete). A class instance is a record in the table. The class contains only code to reach lines and fields of table.
+
This is the most simple. You have one class per table and each class is a link to the table with CRUD methods (Create, Read, Update, Delete). A class instance is a record in the table. The class contains only code to reach lines and fields of table.
    
Example: This mode is used by some ORM Frameworks, like '''iBatis''' (http://ibatis.apache.org/).
 
Example: This mode is used by some ORM Frameworks, like '''iBatis''' (http://ibatis.apache.org/).
Line 549: Line 551:  
More "purist" on paper (closer of business), this method also has the disadvantage of being more complex in practice.
 
More "purist" on paper (closer of business), this method also has the disadvantage of being more complex in practice.
   −
Example: This is the choice if you use the ORM Framework '''Propel''' (http://propel.phpdb.org/trac/). We find this model in heavier applications, based on this ORM among others.
+
Example: This is the choice if you use the ORM Framework '''Propel''' (https://propelorm.org/). We find this model in heavier applications, based on this ORM among others.
   −
-> For Dolibarr development, it is recommended to use the connection mode '''Active Record''', which offers the advantages of a model close to the business without having the complexity, without obfuscating technical architecture. It is by this way that the development, understanding of code and technical maintenance and / or business behaviour seems the more productive (this is however an ongoing debate between the purists and the pragmatists, debate in which nobody can really be right, because it depends on the objectives).
+
-> For Dolibarr development, it is recommended to use the connection mode '''Active Record''', which offers the advantages of a model close to the business without having the complexity, without obfuscating technical architecture. It is by this way that the development, understanding of code and technical maintenance and / or business behavior seems the more productive (this is however an ongoing debate between the purists and the pragmatists, debate in which nobody can really be right, because it depends on the objectives).
Retrieved from "https://wiki.dolibarr.org/index.php?title=Special:MobileDiff/58687...59659"