Difference between revisions of "File and Directory Structure"

From FusionPBX
Jump to: navigation, search
 
(8 intermediate revisions by one other user not shown)
Line 12: Line 12:
 
=App Structure=
 
=App Structure=
 
Design goal for applications are self contained application that is designed to plug in a simple way.
 
Design goal for applications are self contained application that is designed to plug in a simple way.
location fusionpx/app
+
 
 +
location: fusionpx/app
  
 
* root.php
 
* root.php
 
* app_config.php
 
* app_config.php
 
* app_defaults.php
 
* app_defaults.php
* app_languages.php
+
* [[app_languages.php]]
 
* resources
 
* resources
 
** classes
 
** classes
*** models
+
** models
*** views
+
** views
**** view name - support multiple sets of views.
+
*** images (global)
*** controllers
+
*** view - support multiple sets of views.
** images
+
**** images - images specific to this view
 +
** controllers
 
** xml
 
** xml
 
*** dialplan
 
*** dialplan
Line 30: Line 32:
 
=Core Structure=
 
=Core Structure=
 
Same as App Structure only the bare minimum applications belong in core such as menu, user managerment, groups, permissions, domains and default settings.
 
Same as App Structure only the bare minimum applications belong in core such as menu, user managerment, groups, permissions, domains and default settings.
 +
 +
location: fusionpx/core
  
 
=Future Improvements=
 
=Future Improvements=
Line 37: Line 41:
  
 
* includes directory
 
* includes directory
Considering renaming this directory to resources.
+
Consider renaming this directory to resources.
  
 
* includes classes
 
* includes classes

Latest revision as of 01:07, 5 June 2013

Current and proposed directory structure. Suggestions for improvements are welcome.


HMVC

Hierarchical model–view–controller

The concept of the directory and file structure is to create plug-able self contained applications. It is also designed as a move to refactor the project to use the HMVC design pattern. See the following links for additional information.

App Structure

Design goal for applications are self contained application that is designed to plug in a simple way.

location: fusionpx/app

  • root.php
  • app_config.php
  • app_defaults.php
  • app_languages.php
  • resources
    • classes
    • models
    • views
      • images (global)
      • view - support multiple sets of views.
        • images - images specific to this view
    • controllers
    • xml
      • dialplan

Core Structure

Same as App Structure only the bare minimum applications belong in core such as menu, user managerment, groups, permissions, domains and default settings.

location: fusionpx/core

Future Improvements

  • includes/lib_switch.php

Move the functions this file contains into classes in their respective directories.

  • includes directory

Consider renaming this directory to resources.

  • includes classes

Move the specific classes into their respective app/resources/classes directories.

  • includes/classes/install.php

Move the rest of the install.php file into methods of the install class.