29,033
edits
Changes
m
no edit summary
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
−<source 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:
*/
*/
...
...
−</source>
+</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 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 ''';''' ).
−<source lang="php">
+<syntaxHighlight lang="php">
$var1=1;
$var1=1;
$var2=1;
$var2=1;
$var3=1;
$var3=1;
−</source>
+</syntaxHighlight>
Anstelle von
Anstelle von
−<source lang="php">
+<syntaxHighlight lang="php">
$var1=$var2=$var3=1;
$var1=$var2=$var3=1;
−</source>
+</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.
−<source lang="php">
+<syntaxHighlight lang="php">
print 'My text show my '.$variable.' !';
print 'My text show my '.$variable.' !';
−</source>
+</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
−<source lang="php">
+<syntaxHighlight lang="php">
/* Kommentarblock
/* Kommentarblock
*
*
Line 97:
Line 97:
// Code
// Code
}
}
−</source>
+</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 175:
Line 175:
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''':
−<source lang="sql">
+<syntaxHighlight lang="sql">
-- ===========================================================================
-- ===========================================================================
-- Copyright (C) 2013 Author <email@author.com>
-- Copyright (C) 2013 Author <email@author.com>
Line 196:
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);
−</source>
+</syntaxHighlight>
==Table and fields structures==
==Table and fields structures==
Line 273:
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:
−<source 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
−</source>
+</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:
−<source 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'
−</source>
+</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.
Line 298:
Line 298:
For example, don't do:
For example, don't do:
−<source lang="php">
+<syntaxHighlight lang="php">
$sql="SELECT rowid FROM table where datefield = NOW()";
$sql="SELECT rowid FROM table where datefield = NOW()";
−</source>
+</syntaxHighlight>
but do:
but do:
−<source 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())."'";
−</source>
+</syntaxHighlight>
For example, don't do:
For example, don't do:
−<source 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";
−</source>
+</syntaxHighlight>
but do:
but do:
−<source 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))."'";
−</source>
+</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 337:
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)
−<source 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"
−</source>
+</syntaxHighlight>
==PostgreSQL specificities==
==PostgreSQL specificities==
Line 348:
Line 348:
MySQL Syntax:
MySQL Syntax:
−<source 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;
−</source>
+</syntaxHighlight>
PgSQL Syntax:
PgSQL Syntax:
−<source 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;
−</source>
+</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 :
−<source 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 368:
Line 368:
WHERE source.rowid=target.rowid";
WHERE source.rowid=target.rowid";
}
}
−</source>
+</syntaxHighlight>
=HTML norms=
=HTML norms=
Line 378:
Line 378:
For example:
For example:
−<source 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>';
−</source>
+</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 388:
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"
−<source 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
}
}
−</source>
+</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 451:
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
−<source lang="php">
+<syntaxHighlight lang="php">
print 239.2 - 229.3 - 9.9;
print 239.2 - 229.3 - 9.9;
−</source>
+</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).
−<source lang="php">
+<syntaxHighlight lang="php">
print price2num(239.2 - 229.3 - 9.9, 'MT');
print price2num(239.2 - 229.3 - 9.9, 'MT');
−</source>
+</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 467:
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
−<source 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)
−</source>
+</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:
−<source 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.*
−</source>
+</syntaxHighlight>
==Logs==
==Logs==
Add logs to your code using function
Add logs to your code using function
−<source 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);
−</source>
+</syntaxHighlight>
==Working directory==
==Working directory==
Line 488:
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:
−<source lang="php">
+<syntaxHighlight lang="php">
$mymoduledir=DOL_DATA_ROOT.'/mymodule';
$mymoduledir=DOL_DATA_ROOT.'/mymodule';
dol_mkdir($mymoduledir);
dol_mkdir($mymoduledir);
−</source>
+</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''''