Difference between revisions of "Entwickler Dokumentation"
PolyglotBot (talk | contribs) m (Import interlang links (links to translated versions of this page in other languages) from origin English page "Developer_documentation".) |
|||
Line 13: | Line 13: | ||
− | = Entwicklungsorganisation und Tools = | + | =Entwicklungsorganisation und Tools= |
Dieses Kapitel enthält grundlegende Informationen, die genau vor dem Start jeder Entwicklungsarbeit mit Dolibarr gelesen werden müssen. | Dieses Kapitel enthält grundlegende Informationen, die genau vor dem Start jeder Entwicklungsarbeit mit Dolibarr gelesen werden müssen. | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | + | #[[Dolibarr Project|Organisation des Projekts (en)]] | |
− | # [[ | + | #[[To known before to start|To known before to start to develop]] |
− | # [[ | + | #[[Environment and development tools]] |
− | # [[ | + | #[[Dependencies and external libraries]] |
− | # | + | #[[FAQ_Get,update_project_sources|Get or update sources of a development version]] |
− | = Liste der Module = | + | =Codierungsregeln und Praxisbeispiele= |
+ | |||
+ | #[[Voraussetzungen|Voraussetzungen (de)]] | ||
+ | #[[Language and development rules|Language and development rules (PHP, SQL, HTML)]] | ||
+ | #[[:Category:Table SQL|Liste der Datenbanktabellen]] (en) | ||
+ | #Tree structure of files and classes are available onto [http://doxygen.dolibarr.org/ doxygen generated documentation] | ||
+ | |||
+ | =Liste der Module= | ||
Technical documentations on standard business modules are available on developer documentation of each modules. Choose page you are interested in to go on it: | Technical documentations on standard business modules are available on developer documentation of each modules. Choose page you are interested in to go on it: | ||
− | * List of standard modules is defined on page [[:Category:List of Modules (developer)|List of Modules]] | + | *List of standard modules is defined on page [[:Category:List of Modules (developer)|List of Modules]] |
− | * List of other modules is defined on page [[:Category:Complementary modules|Complementary modules]] | + | *List of other modules is defined on page [[:Category:Complementary modules|Complementary modules]] |
− | = Entwickeln eines Moduls/Addons für die GUI = | + | =Entwickeln eines Moduls/Addons für die GUI= |
This section describe how to develop a new module on Dolibarr that change how Dolibarr works. Such modules can have its own screens, its own data, its own CSS stylesheet, its own business code or all of this. | This section describe how to develop a new module on Dolibarr that change how Dolibarr works. Such modules can have its own screens, its own data, its own CSS stylesheet, its own business code or all of this. | ||
Script development is not included in this section (this is described in next chapter). | Script development is not included in this section (this is described in next chapter). | ||
Line 39: | Line 41: | ||
To develop your own module, go on tutorial: [[Module development]] | To develop your own module, go on tutorial: [[Module development]] | ||
− | = Ein command line script oder Batch erstellen = | + | =Ein command line script oder Batch erstellen= |
This chapter describe the way to develop its own command line script to realize Dolibarr treatments (read, update data...). | This chapter describe the way to develop its own command line script to realize Dolibarr treatments (read, update data...). | ||
Making modifications on user Gui interface (GUI) is not included in this chapter. See previous chapter for this. | Making modifications on user Gui interface (GUI) is not included in this chapter. See previous chapter for this. | ||
Line 45: | Line 47: | ||
To develop a script, like a cron script or an command line import tool to import data from an external source, you can have a look at the page: [[Script development]] | To develop a script, like a cron script or an command line import tool to import data from an external source, you can have a look at the page: [[Script development]] | ||
− | = Technische Elemente von Dolibarr = | + | =Technische Elemente von Dolibarr= |
− | == Dateistruktur == | + | ==Dateistruktur== |
Die Pfadhierarchie der aktuellen Version wird in der von Doxygen generierten Dokumentation abgebildet. [http://doxygen.dolibarr.org/ doxygen generated documentation] (generated "javadoc" like documentation) | Die Pfadhierarchie der aktuellen Version wird in der von Doxygen generierten Dokumentation abgebildet. [http://doxygen.dolibarr.org/ doxygen generated documentation] (generated "javadoc" like documentation) | ||
Die Pfade zum Hinzufügen neuer Dateien durch ein neues Modul sind jedoch in der Dokumentation zum Entwickeln eines neuen Moduls definiert (see [[Module development]]). | Die Pfade zum Hinzufügen neuer Dateien durch ein neues Modul sind jedoch in der Dokumentation zum Entwickeln eines neuen Moduls definiert (see [[Module development]]). | ||
− | == Speicherplatz einrichten == | + | ==Speicherplatz einrichten== |
− | + | Es gibt 3 Stellen für Setup-Parameter in Dolibarr: | |
− | |||
− | |||
− | |||
− | == Geschäftsobjekte == | + | *Dolibarr technical setup (authentication mode, database logins and storage area for files) are defined in only one setup file conf/conf.php. See [[Configuration file]] for more information. |
+ | *Global features parameters are stored in [[Table llx_const]]. See page [[Constants]] for more information. | ||
+ | *Feature parameters for particular users are stored in [[Table llx_user_param]]. See page [[Constants]] for more information. | ||
+ | |||
+ | ==Geschäftsobjekte== | ||
See page [[Business Objects]] | See page [[Business Objects]] | ||
− | == Menü-System == | + | ==Menü-System== |
See page [[Menus system]] | See page [[Menus system]] | ||
− | == Tab-System == | + | ==Tab-System== |
See page [[Tabs system]] | See page [[Tabs system]] | ||
− | == Skins/Themes == | + | ==Skins/Themes== |
Skins/Themes sind die Benutzeroberflächen (GUIs) | Skins/Themes sind die Benutzeroberflächen (GUIs) | ||
siehe [[Skins]] (englisch) | siehe [[Skins]] (englisch) | ||
− | == Box-System == | + | ==Box-System== |
siehe [[Box system]] (englisch) | siehe [[Box system]] (englisch) | ||
− | == Authentifizierungssystem == | + | ==Authentifizierungssystem== |
See page [[Authentication]] | See page [[Authentication]] | ||
− | == Berechtigungssystem == | + | ==Berechtigungssystem== |
See page [[Permissions En|Permissions]] | See page [[Permissions En|Permissions]] | ||
− | == Übersetzungs-System == | + | ==Übersetzungs-System== |
See page [[Translation system]] | See page [[Translation system]] | ||
− | == Fehler-Behandlung == | + | ==Fehler-Behandlung== |
See page [[Error reporting|Error reporting]] | See page [[Error reporting|Error reporting]] | ||
− | == Canvas-System == | + | ==Canvas-System== |
Canvas is a developer feature to replace sreens to create, update or view a card (products, thirdparties, contacts, ...). For example, you can replace the input form to create a new third party, or to edit it, or replace the card used to view it. | Canvas is a developer feature to replace sreens to create, update or view a card (products, thirdparties, contacts, ...). For example, you can replace the input form to create a new third party, or to edit it, or replace the card used to view it. | ||
See page [[Canvas development]] | See page [[Canvas development]] | ||
− | == Trigger-System == | + | ==Trigger-System== |
Triggers is a develop feature to execute personalized code during a Dolibarr "Business event" (creation of invoice, delete of user, update of thirdparty, etc...), and only for a business event. To personalize code for other contexts, see instead chapter '''Hooks system'''. | Triggers is a develop feature to execute personalized code during a Dolibarr "Business event" (creation of invoice, delete of user, update of thirdparty, etc...), and only for a business event. To personalize code for other contexts, see instead chapter '''Hooks system'''. | ||
For triggers usage, see [[Interfaces Dolibarr toward foreign systems|this page]]. | For triggers usage, see [[Interfaces Dolibarr toward foreign systems|this page]]. | ||
− | == Hook-System == | + | ==Hook-System== |
See page [[Hooks system]]. | See page [[Hooks system]]. | ||
− | == Variable substitution system == | + | ==Variable substitution system== |
See page [[Variable substitution system]]. | See page [[Variable substitution system]]. | ||
− | == Internetdienste == | + | ==Internetdienste== |
Dolibarr can be setup to provide some services. | Dolibarr can be setup to provide some services. | ||
See [[Module Web Services]] | See [[Module Web Services]] | ||
− | == Datei-/Dokumentspeicher verwalten == | + | ==Datei-/Dokumentspeicher verwalten== |
See page [[Generated documents]] | See page [[Generated documents]] | ||
− | == Module nummerieren == | + | ==Module nummerieren== |
For each entity created in the application, Dolibarr assigns a reference. In order to adapt the reference to any use, Dolibarr use modules to define the rule of generation of this reference. Several modules are supplied with application. Some are generic and are used to define the mask numbering (number on x characters, with or without prefix, including the date or not, etc.), which can meet most needs. However, there are still cases where the modules provided does not meet the need. In this case it is necessary to develop its own numbering module. | For each entity created in the application, Dolibarr assigns a reference. In order to adapt the reference to any use, Dolibarr use modules to define the rule of generation of this reference. Several modules are supplied with application. Some are generic and are used to define the mask numbering (number on x characters, with or without prefix, including the date or not, etc.), which can meet most needs. However, there are still cases where the modules provided does not meet the need. In this case it is necessary to develop its own numbering module. | ||
For more information, see on page [[Create numeration module]] | For more information, see on page [[Create numeration module]] | ||
− | == Dokumenttemplates und Dokumente erstellen == | + | ==Dokumenttemplates und Dokumente erstellen== |
More documentation about document generation from models is available on page [[Create a PDF document template]] or [[Create an ODT document template]] | More documentation about document generation from models is available on page [[Create a PDF document template]] or [[Create an ODT document template]] | ||
− | == Zusatzfelder== | + | ==Zusatzfelder== |
See page [[Extrafields]] | See page [[Extrafields]] | ||
− | == Andere interne Funktionen == | + | ==Andere interne Funktionen== |
There is a lot of internal libraries your code can use. | There is a lot of internal libraries your code can use. | ||
You may find a lot of generic functions into files functions.lib.php or functions2.lib.php or admin.lib.php. But any function found into htdocs/core/lib/*.lib files can be used. | You may find a lot of generic functions into files functions.lib.php or functions2.lib.php or admin.lib.php. But any function found into htdocs/core/lib/*.lib files can be used. | ||
Line 134: | Line 137: | ||
</source> | </source> | ||
− | = Massenimport /-export = | + | =Massenimport /-export= |
− | # [[Mass imports]] | + | |
− | # [[Module Exports En|Mass exports]] | + | #[[Mass imports]] |
+ | #[[Module Exports En|Mass exports]] | ||
+ | |||
+ | =Schnittstellen und Links mit anderen Anwendungen= | ||
− | + | #[[Interfaces Dolibarr toward foreign systems]] or toward Dolibarr (Dolibarr Triggers) | |
− | # [[Interfaces Dolibarr toward foreign systems]] or toward Dolibarr (Dolibarr Triggers) | + | #[[Interfaces from foreign systems toward Dolibarr]] |
− | # [[Interfaces from foreign systems toward Dolibarr]] | + | #[[Module Web Services|Web Services]] |
− | # [[Module Web Services|Web Services]] | ||
− | = FAQ = | + | =FAQ= |
All FAQ are available through index page [[:Category:FAQ EN|FAQ EN]] | All FAQ are available through index page [[:Category:FAQ EN|FAQ EN]] |
Revision as of 11:27, 17 September 2019
Diese Seite ist ein Index bezogen für die Artikel zu der Entwicklerdokumentation. Die Benutzerdokumentation, finden Sie hier.
Entwicklungsorganisation und Tools
Dieses Kapitel enthält grundlegende Informationen, die genau vor dem Start jeder Entwicklungsarbeit mit Dolibarr gelesen werden müssen.
- Organisation des Projekts (en)
- To known before to start to develop
- Environment and development tools
- Dependencies and external libraries
- Get or update sources of a development version
Codierungsregeln und Praxisbeispiele
- Voraussetzungen (de)
- Language and development rules (PHP, SQL, HTML)
- Liste der Datenbanktabellen (en)
- Tree structure of files and classes are available onto doxygen generated documentation
Liste der Module
Technical documentations on standard business modules are available on developer documentation of each modules. Choose page you are interested in to go on it:
- List of standard modules is defined on page List of Modules
- List of other modules is defined on page Complementary modules
Entwickeln eines Moduls/Addons für die GUI
This section describe how to develop a new module on Dolibarr that change how Dolibarr works. Such modules can have its own screens, its own data, its own CSS stylesheet, its own business code or all of this. Script development is not included in this section (this is described in next chapter).
To develop your own module, go on tutorial: Module development
Ein command line script oder Batch erstellen
This chapter describe the way to develop its own command line script to realize Dolibarr treatments (read, update data...). Making modifications on user Gui interface (GUI) is not included in this chapter. See previous chapter for this.
To develop a script, like a cron script or an command line import tool to import data from an external source, you can have a look at the page: Script development
Technische Elemente von Dolibarr
Dateistruktur
Die Pfadhierarchie der aktuellen Version wird in der von Doxygen generierten Dokumentation abgebildet. doxygen generated documentation (generated "javadoc" like documentation)
Die Pfade zum Hinzufügen neuer Dateien durch ein neues Modul sind jedoch in der Dokumentation zum Entwickeln eines neuen Moduls definiert (see Module development).
Speicherplatz einrichten
Es gibt 3 Stellen für Setup-Parameter in Dolibarr:
- Dolibarr technical setup (authentication mode, database logins and storage area for files) are defined in only one setup file conf/conf.php. See Configuration file for more information.
- Global features parameters are stored in Table llx_const. See page Constants for more information.
- Feature parameters for particular users are stored in Table llx_user_param. See page Constants for more information.
Geschäftsobjekte
See page Business Objects
Menü-System
See page Menus system
Tab-System
See page Tabs system
Skins/Themes
Skins/Themes sind die Benutzeroberflächen (GUIs)
siehe Skins (englisch)
Box-System
siehe Box system (englisch)
Authentifizierungssystem
See page Authentication
Berechtigungssystem
See page Permissions
Übersetzungs-System
See page Translation system
Fehler-Behandlung
See page Error reporting
Canvas-System
Canvas is a developer feature to replace sreens to create, update or view a card (products, thirdparties, contacts, ...). For example, you can replace the input form to create a new third party, or to edit it, or replace the card used to view it.
See page Canvas development
Trigger-System
Triggers is a develop feature to execute personalized code during a Dolibarr "Business event" (creation of invoice, delete of user, update of thirdparty, etc...), and only for a business event. To personalize code for other contexts, see instead chapter Hooks system.
For triggers usage, see this page.
Hook-System
See page Hooks system.
Variable substitution system
See page Variable substitution system.
Internetdienste
Dolibarr can be setup to provide some services. See Module Web Services
Datei-/Dokumentspeicher verwalten
See page Generated documents
Module nummerieren
For each entity created in the application, Dolibarr assigns a reference. In order to adapt the reference to any use, Dolibarr use modules to define the rule of generation of this reference. Several modules are supplied with application. Some are generic and are used to define the mask numbering (number on x characters, with or without prefix, including the date or not, etc.), which can meet most needs. However, there are still cases where the modules provided does not meet the need. In this case it is necessary to develop its own numbering module.
For more information, see on page Create numeration module
Dokumenttemplates und Dokumente erstellen
More documentation about document generation from models is available on page Create a PDF document template or Create an ODT document template
Zusatzfelder
See page Extrafields
Andere interne Funktionen
There is a lot of internal libraries your code can use. You may find a lot of generic functions into files functions.lib.php or functions2.lib.php or admin.lib.php. But any function found into htdocs/core/lib/*.lib files can be used.
To make a condition on Dolibarr version
For example, to make a condition on Dolibarr > 3.5, you can use versioncompare and versiondolibarrarray found into admin.lib.php
if (versioncompare(versiondolibarrarray(), array(3,5,0)) > 0)
{
...
}
Massenimport /-export
Schnittstellen und Links mit anderen Anwendungen
- Interfaces Dolibarr toward foreign systems or toward Dolibarr (Dolibarr Triggers)
- Interfaces from foreign systems toward Dolibarr
- Web Services
FAQ
All FAQ are available through index page FAQ EN