Developer Guide: File Naming Conventions

When creating new files, here’s how to name them.

Classes

ThinkTank-wide class files should be located in the /thinktank/webapp/model/ folder, with the filename class.ClassName.php. The class and the DAO class should both appear in this file.

For example, the Post and Post DAO objects are in the /thinktank/webapp/common/class.Post.php file.

Plugin classes should be located in the /thinktank/webapp/plugins/pluginname/lib/ directory, using the same naming convention.

Templates

ThinkTank-wide templates are located in /thinktank/webapp/templates/ with the .tpl file extension. The template name should match the file name which calls it. Use dots to represent folders.

For example, the public.php file calls the public.tpl template.

The account/index.php file calls the account.index.tpl template.

Included template filenames should start with an underscore. For example, the header template is named _header.tpl.

Tests

There are three basic types of tests: DAO tests, Webapp tests, and plugin tests.

TODO: Come up with naming convention for each.

Test Data

Right now a dash represents a slash in test data file names.

TODO: Come up with file name conventions with appropriate replacements for /, ?, &, and =