Helix Installation   Getting Started   Reference Documentation   Global Functions   Quick Start
Getting StartedHelpful ResourcesAsk questions on the Help ForumRead the User GuideBrowse the Reference DocumentationSubscribe to the Helix Mailing ListLearning HelixAdvanced Topics

Helix Folder Structure

Every Helix installation uses the same folder structure to hold the site files and resources.  Several sites can be run on several different domains using a single Helix installation.  The Helix folder structure is shown below:

Helix/
    etc/
    modules/
    sites/

The etc Folder

The etc folder contains two files that are necessary on every request.

Helix/
    etc/
        parser.php
        util.php
    modules/
    sites/

The parser.php file holds the code that breaks down the requested URL and determines what to do with the request.  The util.php file is a collection of globally available functions that can be used anywhere in your application.

The modules Folder

The modules folder contains all of the built-in Helix Modules and functionality to be used anywhere in your application.

Helix/
    etc/
    modules/
        am/
        aws/
        bus/
        cal/
        cms/
        com/
        cont/
        cor/
        crm/
        doc/
        fa/
        forum/
        hr/
        ifc/
        member/
        prj/
        qi/
        rating/
        rpt/
        skel/
        vid/
        wfm/
    sites/

Each module is a collection of classes for manipulating records in the database, accessing related classes, and performing many other useful functions.  The complete documentation for all of the Helix modules allows you to look through the classes and see properties, methods, accessors and source code.

The sites Folder

The sites folder contains one folder for each site run on the Helix installation.

Helix/
    etc/
    modules/
    sites/
        docs/
        helix/
        mysite/
           .
           .
           .
        anothersite/

The docs site and the helix site are included with the Helix Framework.  Your site folder will be created during the Helix Installation, and you can create as many sites as you want by re-running the installation.

A Single Site Folder

Each site folder will contain folders to hold the configuration, pages, class libraries, and resources like images, stylesheets, javascript, flash and more.

Helix/
    etc/
    modules/
    sites/
        docs/
        helix/
        mysite/
            etc/
            interface/
                pages/
                templates/
            lib/
                custom/
                database/
                extended/
                final/
                ndo/
            resources/
                audio/
                bin/
                data/
                docs/
                flash/
                fonts/
                images/
                java/
                scripts/
                styles/
                video/

The etc folder will have a file called config.php that holds the site configuration settings.  Most of the other folders are pretty self-explanatory, but it is important to note that you can customize any of the built-in Helix classes by creating a file with the class name in the lib/final folder for your site.  Any classes you write for your site should be placed in the lib/ndo folder ("ndo" stands for "non-data objects").

Get Helix PHP Framework at SourceForge.net. Fast, secure and Free Open Source software downloads