Documentation
This commit is contained in:
parent
4f0c9e1ff4
commit
2ec5ffee48
@ -1,7 +1,9 @@
|
||||
README (English)
|
||||
--------------------------------
|
||||
This directory contains sub-directories to provide
|
||||
tools or documentation for developers.
|
||||
This directory contains sub-directories to provide tools or
|
||||
documentation for developers.
|
||||
Note: All files in this directory are in CVS only and are not
|
||||
provided with a standard release.
|
||||
|
||||
|
||||
There is also some documentation (in French) on Dolibarr
|
||||
|
||||
@ -1,24 +1,24 @@
|
||||
README (english)
|
||||
--------------------------------
|
||||
This directory contains PHP script samples that can be used to start a development on Dolibarr.
|
||||
|
||||
|
||||
modMyModule.class.php:
|
||||
Is a sample of module descriptor you can use if you want to build a new module/plugin for
|
||||
Dolibarr.
|
||||
|
||||
skeleton_script.php:
|
||||
Is a sample you can use as an example if you need to build a script to run on command line
|
||||
|
||||
skeleton_page.php:
|
||||
Is a sample you can use as an example if you need to build an HTML page to include in Dolibarr GUI.
|
||||
|
||||
skeleton_class.class.php:
|
||||
Is a sample you can use as an example if you need to build a class file to access a new table
|
||||
required by a Dolibarr development.
|
||||
However it is better to run the script build_class_from_table.php that accept a table name as a
|
||||
parameter and will used table description in database and the skeleton_class.class.php file to
|
||||
generate full code for your class file.
|
||||
After running this script, the class to access your table (insert a record, update, delete and select)
|
||||
is directly finished and can be used by your business code. No more coding for accesser on table
|
||||
is needed with this script as the file is completely generated once.
|
||||
README (English)
|
||||
--------------------------------
|
||||
This directory contains PHP script samples that can be used to start a development on Dolibarr.
|
||||
|
||||
|
||||
modMyModule.class.php:
|
||||
Is a sample of module descriptor you can use if you want to build a new module/plugin for
|
||||
Dolibarr.
|
||||
|
||||
skeleton_script.php:
|
||||
Is a sample you can use as an example if you need to build a script to run on command line
|
||||
|
||||
skeleton_page.php:
|
||||
Is a sample you can use as an example if you need to build an HTML page to include in Dolibarr GUI.
|
||||
|
||||
skeleton_class.class.php:
|
||||
Is a sample you can use as an example if you need to build a class file to access a new table
|
||||
required by a Dolibarr development.
|
||||
However it is better to run the script build_class_from_table.php that accept a table name as a
|
||||
parameter and will used table description in database and the skeleton_class.class.php file to
|
||||
generate full code for your class file.
|
||||
After running this script, the class to access your table (insert a record, update, delete and select)
|
||||
is directly finished and can be used by your business code. No more coding for accesser on table
|
||||
is needed with this script as the file is completely generated once.
|
||||
|
||||
Loading…
Reference in New Issue
Block a user