Revision history for GettingStartedDeveloping
Additions:
[[PhpScripts Description of the function of each of the webERP Scripts]] This will always be out of date.... there is a table in the database called naturally enough scripts - that describes the function of each script and is kept up to date.
===Getting to Know Your Way Around the Scripts===
~webERP uses a few common include files throughout that must be understood:
~includes/ConnectDB.inc - database abstraction
~includes/session.inc - initiation of session and security checking
~includes/header.inc - page headings and quick menu links
~includes/footer.inc - page footer
~includes/DateFunctions.inc - Date functions (included in session.inc)
~includes/MiscFunctions.inc - Functions for printing messages prnMsg
~includes/PDFStarter.inc - PDF report generation
~includes/SQL_CommonFunctions.inc - common functions that retrieve database info or update the database eg GetNextTransNo
~and config.php which is included by includes/session.inc and is separate from session.inc only because it requires user editing to enter the database user and password.
~Most scripts use all the first 6.
~Transactional scripts also use an includes/DefineXXXXXXClass.php script.
~PDF reporting scripts generally have an includes/PDFXXXXXXXPageHeader.inc script for the report page titles.
~Apart from these files above, most scripts are otherwise self contained so that a knowledge of these includes and the main script should be all that's needed to be confident in modifying the script.
===More Help Getting to Grips with webERP code===
===Getting to Know Your Way Around the Scripts===
~webERP uses a few common include files throughout that must be understood:
~includes/ConnectDB.inc - database abstraction
~includes/session.inc - initiation of session and security checking
~includes/header.inc - page headings and quick menu links
~includes/footer.inc - page footer
~includes/DateFunctions.inc - Date functions (included in session.inc)
~includes/MiscFunctions.inc - Functions for printing messages prnMsg
~includes/PDFStarter.inc - PDF report generation
~includes/SQL_CommonFunctions.inc - common functions that retrieve database info or update the database eg GetNextTransNo
~and config.php which is included by includes/session.inc and is separate from session.inc only because it requires user editing to enter the database user and password.
~Most scripts use all the first 6.
~Transactional scripts also use an includes/DefineXXXXXXClass.php script.
~PDF reporting scripts generally have an includes/PDFXXXXXXXPageHeader.inc script for the report page titles.
~Apart from these files above, most scripts are otherwise self contained so that a knowledge of these includes and the main script should be all that's needed to be confident in modifying the script.
===More Help Getting to Grips with webERP code===
Deletions:
Additions:
webERP is written with nice simple PHP - as simple as possible so I could understand it ... it is therefore not a bad program to learn some PHP with. Having read a couple of the articles above - there is no substitute for diving in. PHP is very flexible but webERP scripts try to follow a series of conventions as rigorously as possible - see [[ContributingtowebERP Coding Style Guide and Project Goals]]
Of course accounting applications are database applications and an understanding of the data structure is also required to make sense of the code .... the code does use english names for variables and data throughout and error messages are in the code where you'd expect them to be so you can figure out the code quite easily. There is a [[DatabaseStructure start on a document]] that describes the database tables and there is a [[http://www.weberp.org/3rdPartyStuff/weberp_db.png database diagram]] showing the relationships between tables for your reference on this wiki.
Of course accounting applications are database applications and an understanding of the data structure is also required to make sense of the code .... the code does use english names for variables and data throughout and error messages are in the code where you'd expect them to be so you can figure out the code quite easily. There is a [[DatabaseStructure start on a document]] that describes the database tables and there is a [[http://www.weberp.org/3rdPartyStuff/weberp_db.png database diagram]] showing the relationships between tables for your reference on this wiki.
Deletions:
Of course accounting applications are database applications and an understanding of the data structure is also required to make sense of the code .... the code does use english names for variables and data throughout and error messages are in the code where you'd expect them to be so you can figure out the code quite easily. There is a [[DatabaseStructure start on a document]] that describes the database tables and there is a database diagram showing the relationships between tables for your reference on this wiki.
Additions:
webERP is written with nice simple PHP - as simple as possible so I could understand it ... it is therefore not a bad program to learn some PHP with. Having read a couple of the articles above - there is no substitute for diving in. PHP is very flexible but webERP scripts try to follow a series of conventions as rigorously as possible - see
Deletions:
Additions:
webERP is written with nice simple PHP - as simple as possible so I could understand it ... it is therefore not a bad program to learn some PHP with. Having read a couple of the articles above - there is no substitute for diving in.
[[PhpScripts Description of the function of each of the webERP Scripts]] This will always be out of date....
I would strongly recommend using an editor with syntax highlighting - this changes the colour and bolds keywords of the programming code so you can see what words are variables and what words are PHP functions etc as they are displayed in a different colour. I use [[http://www.contexteditor.org/ Context Editor]] in windows there are probably better ones - but this is a free download and is small and fast - working on the same principles as webERP.... in linux I use geany or KATE - K Advanced Text Editor which comes with every distribution of linux. There are other Integrated Development Environments IDEs but I am a purist and these simple tools I have recommended suffice.
Of course accounting applications are database applications and an understanding of the data structure is also required to make sense of the code .... the code does use english names for variables and data throughout and error messages are in the code where you'd expect them to be so you can figure out the code quite easily. There is a [[DatabaseStructure start on a document]] that describes the database tables and there is a database diagram showing the relationships between tables for your reference on this wiki.
[[PhpScripts Description of the function of each of the webERP Scripts]] This will always be out of date....
I would strongly recommend using an editor with syntax highlighting - this changes the colour and bolds keywords of the programming code so you can see what words are variables and what words are PHP functions etc as they are displayed in a different colour. I use [[http://www.contexteditor.org/ Context Editor]] in windows there are probably better ones - but this is a free download and is small and fast - working on the same principles as webERP.... in linux I use geany or KATE - K Advanced Text Editor which comes with every distribution of linux. There are other Integrated Development Environments IDEs but I am a purist and these simple tools I have recommended suffice.
Of course accounting applications are database applications and an understanding of the data structure is also required to make sense of the code .... the code does use english names for variables and data throughout and error messages are in the code where you'd expect them to be so you can figure out the code quite easily. There is a [[DatabaseStructure start on a document]] that describes the database tables and there is a database diagram showing the relationships between tables for your reference on this wiki.
Deletions:
Of course accounting applications are database applications and an understanding of the data structure is also required to make sense of the code .... the code does use english names for variables and data throughout and error messages are in the code where you'd expect them to be so you can figure out the code quite easily. There is a start on a document that describes the database tables and there is a database diagram showing the relationships between tables for your reference on this wiki.
Additions:
With the source code available it is possible to make webERP do pretty much anything you want... BUT you need to understand the program scripts that make up webERP.
All these scripts use the PHP programming language... a tutorial on PHP programming is outside the scope of the webERP documentation but there is extensive information available and many online tutorials:
~- I think I learned my first PHP off a [[http://www.webmonkey.com/webmonkey/01/48/index2a.html?tw=programming tutorial on web-monkey]]
~- The main [[http://nz.php.net/tut.php PHP web-site has a good tutorial]] also.
~- I have also subscribed to and read many of the [[http://www.devshed.com/c/a/PHP/Programming-PHP-A-Beginners-Guide/ useful articles on Dev-Shed]].
webERP is written with nice simple PHP - as simple as possible so I could understand it ... it is therefore not a bad program to learn some PHP with. Having read a couple of the articles above - there is no substitute for diving in. I would strongly recommend using an editor with syntax highlighting - this changes the colour and bolds keywords of the programming code so you can see what words are variables and what words are PHP functions etc as they are displayed in a different colour. I use [[http://www.contexteditor.org/ Context Editor]] in windows there are probably better ones - but this is a free download and is small and fast - working on the same principles as webERP.... in linux I use geany or KATE - K Advanced Text Editor which comes with every distribution of linux. There are other Integrated Development Environments IDEs but I am a purist and these simple tools I have recommended suffice.
Of course accounting applications are database applications and an understanding of the data structure is also required to make sense of the code .... the code does use english names for variables and data throughout and error messages are in the code where you'd expect them to be so you can figure out the code quite easily. There is a start on a document that describes the database tables and there is a database diagram showing the relationships between tables for your reference on this wiki.
The [[http://www.weberp.org/weberp/doc/Manual/ManualContents.php?ViewTopic=NewScripts manual describes the foundations]] for all scripts to give you a starting point to understanding the code. There are other resources under the Development section of this Wiki that help you understand which scripts use which tables and what each script does etc...
All these scripts use the PHP programming language... a tutorial on PHP programming is outside the scope of the webERP documentation but there is extensive information available and many online tutorials:
~- I think I learned my first PHP off a [[http://www.webmonkey.com/webmonkey/01/48/index2a.html?tw=programming tutorial on web-monkey]]
~- The main [[http://nz.php.net/tut.php PHP web-site has a good tutorial]] also.
~- I have also subscribed to and read many of the [[http://www.devshed.com/c/a/PHP/Programming-PHP-A-Beginners-Guide/ useful articles on Dev-Shed]].
webERP is written with nice simple PHP - as simple as possible so I could understand it ... it is therefore not a bad program to learn some PHP with. Having read a couple of the articles above - there is no substitute for diving in. I would strongly recommend using an editor with syntax highlighting - this changes the colour and bolds keywords of the programming code so you can see what words are variables and what words are PHP functions etc as they are displayed in a different colour. I use [[http://www.contexteditor.org/ Context Editor]] in windows there are probably better ones - but this is a free download and is small and fast - working on the same principles as webERP.... in linux I use geany or KATE - K Advanced Text Editor which comes with every distribution of linux. There are other Integrated Development Environments IDEs but I am a purist and these simple tools I have recommended suffice.
Of course accounting applications are database applications and an understanding of the data structure is also required to make sense of the code .... the code does use english names for variables and data throughout and error messages are in the code where you'd expect them to be so you can figure out the code quite easily. There is a start on a document that describes the database tables and there is a database diagram showing the relationships between tables for your reference on this wiki.
The [[http://www.weberp.org/weberp/doc/Manual/ManualContents.php?ViewTopic=NewScripts manual describes the foundations]] for all scripts to give you a starting point to understanding the code. There are other resources under the Development section of this Wiki that help you understand which scripts use which tables and what each script does etc...
Deletions:
webERP is written with nice simple PHP - it had to be so I could understand it ... it is therefore not a bad program to learn some PHP with. Having read a couple of the articles above - there is no substitute for diving in. I would strongly recommend using an editor with syntax highlighting - this changes the colour and bolds keywords of the programming code so you can see what words are variables and what words are PHP functions etc as they are displayed in a different colour. I use [[http://www.contexteditor.org/ Context Editor]] in windows there are probably better ones - but this is a free download and is small and fast - working on the same principles as webERP.... in linux I use geany or KATE - K Advanced Text Editor which comes with every distribution of linux. There are other Integrated Development Environments IDEs but I am a purist and these simple tools I have recommended suffice.
The [[http://www.weberp.org/weberp/doc/Manual/ManualContents.php?ViewTopic=NewScripts manual]] describes the foundations for all scripts to give you a starting point to understanding the code. There are other resources under the Development section of this Wiki that help you understand which scripts use which tables and what each script does etc...
Additions:
With the source code available it is possible to make webERP do most anything... but you need to understand the program scripts that make up webERP. All these scripts use the PHP programming language... a tutorial on PHP programming is outside the scope of the webERP documentation but there is extensive information available and many online tutorials - I think I learned my first PHP off a [[http://www.webmonkey.com/webmonkey/01/48/index2a.html?tw=programming tutorial on web-monkey]] - The main [[http://nz.php.net/tut.php PHP web-site has a good tutorial]] also. I have also subscribed to and read many of the [[http://www.devshed.com/c/a/PHP/Programming-PHP-A-Beginners-Guide/ useful articles on Dev-Shed]].
Deletions:
Additions:
With the source code available it is possible to make webERP do most anything... but you need to understand the program scripts that make up webERP. All these scripts use the PHP programming language... a tutorial on PHP programming is outside the scope of the webERP documentation but there is extensive information available and many online tutorials - I think I learned my first PHP off a [[http://www.webmonkey.com/webmonkey/01/48/index2a.html?tw=programming tutorial on web-monkey]] - The main [[http://nz.php.net/tut.php PHP web-site has a good tutorial]] also. I have also subscribed to and read many of the [[http://www.devshed.com/c/a/PHP/Programming-PHP-A-Beginners-Guide.html useful articles on Dev-Shed]].
Deletions:
Additions:
With the source code available it is possible to make webERP do most anything... but you need to understand the program scripts that make up webERP. All these scripts use the PHP programming language... a tutorial on PHP programming is outside the scope of the webERP documentation but there is extensive information available and many online tutorials - I think I learned my first PHP off a [[http://www.webmonkey.com/webmonkey/01/48/index2a.html?tw=programming tutorial on web-monkey]] - The main [[http://nz.php.net/tut.php PHP web-site has a good tutorial]] also. I have also subscribed to and read many of the [[ http://www.devshed.com/c/a/PHP/Programming-PHP-A-Beginners-Guide useful articles on Dev-Shed Dev-Shed Articles on PHP]].