EQdkp Plus Navigation:   Home  |   Forum  |   Wiki  |   Translate  |   Bugtracker  |   WebSVN  |  USVN

Coding Guidelines

From EQdkp Plus Wiki

Contents

Coding Guidelines

Basics

  • Use the classes in the Libraries instead of using own
  • Use the dbal abstraction & mysql class instead of php mysql functions
  • Use already existing PLUS Functions instead of writing own
  • Never use js code directly out of the libraries, p.e. to open the js windows. Use the Helper classes
  • Produce secure Code
  • Comment your SourceCode
  • Abstract your Language. Not every person is talking your tounge..

Libraries

You should use the libraries if you want to develop plugins. The libraries are a toolkit for plugins, and for the eqdkp itsself. It contains often used functioniality, p.e. an database updater for your plugins, or an update check. The libraries are modulary build, and could be updated seperatly from eqdkp. Because of that, its a powerfull tool. The main purpose of the libraries is, to reduce redundant file includes. In the past, every plugin brought their own stuff. Now, the libraries are used to share stuff between plugins AND eqdkp

Secure Coding

See here: Security

FAQ

Please use the Discussion to ask questions