Copix main file tree
When you uncompress Copix, you will get the following directories:
- var/ by convention, all non temporary files used by Copix are kept here. This path is given by the COPIX_VAR_PATH constant.
- temp/ all buffer files, generated by Copix (dao, resources, paramaters, ...). This path is given by the COPIX_TEMP_PATH constant.
- project/ All project specific elements. his path is given by the COPIX_PROJECT_PATH constant.
- config/ default place for configuration file (copix.conf.php).
- modules/ Where you'll work! usually (but it's not mendatory) all modules are placed here.
- project.inc.php
- utils/ All files required by Copix (the framework itself).
- www/ The files that are to be published in the web server in the "DocumentRoot".
- index.php The only PHP file that MUST be accessible to users in order to run Copix.
file tree of a module
In Copix, we often develop new modules to satisfy the clients' needs. These modules have the following file tree:
- module_name (in lowercase)
- actiongroups the actions groups (surprising he?). They are the page controlers.
- classes where you place all the business specific file.
- resources where you place all i18n files and the DAO declarations.
- templates all the display templates are here.
- zones zones are objects that can handle independant graphical element (eg a login window).
- module.xml the signature of your module. It is required.