Reference Guide

From PHPDevShell

Anatomy of PHPDevShell

PHPDevShell is based on several support classes which provides basic services to your scripts:

• core: general purpose, foundations methods - load files, deal with plugins, etc.
• db: database access and data clipping
• debug: built-in debugger
• email: email sending
• filemanager: file upload
• form: html form
• jquery:
• navigation: menus handling
• security: security related handling
• template: template handling
• thumbnail: thumbnail handling
• wysiwyg: wysiwyg handling

PHPDevShell also comes with several third-party libraries:

• TinyMCE
• jQuery
• MooTools
• FirePHP
• PHPMailer

Last but not least, a bunch of utility functions is provided.

Using the support classes

All classes are in the folder "includes" ; however you don't need to explicit include the source files, since an auto loading mechanism is provided. When needed, the classes from the library and from the plugins will be loaded.

The main utility classes (core, db, navigation, security, template) are instantiated at startup ; as only only one instance of them is needed, you just access them through the magical calls:

$my_query = $this->db->new_query($sql);

Several other classes are available, refer to each corresponding page on the wiki.

Note: during a transition time, one instance of each support class is available as global (or script local). That means you can write :

$my_query = $db->new_query($sql);

This may not be supported in the future, it's provided for backward compatibility.