Folders and Structure
Overview
Folder | Description |
---|---|
/ADMINFOLDER/ | Files related to the administrator dashboard. This folder is different for each site and depends on your settings. (see /modules/custom-definitions.php for details) |
/account/ | Files related to the user dashboard. |
/api/ | Files related to the built-in API functionality. This feature needs to be enabled and relates to the dao structure. |
/assets/ | The assets related to the site's front-end. |
/awstats/ | Used for reviewing the site's server statistics. This feature only works on Apache servers and needs to be configured correctly to work properly. |
/controllers/ | PHP controllers that connect the back-end objects to the front-end Twig engine. |
/data/ | Um ... data stuff? Not sure, this is new to me (dev guys, you want to weigh in?) |
/documentation/ | Is supposed to contain documentation but is mostly a mess. "Will someday contain documentation" is a more accurate description. |
/files/ | Contains files uploaded by administrators. This folder is used by the rich-text editor to allow for custom uploads. |
/images/ | Stores image files for administrator dashboard tools. |
/modules/ | All of the settings and modules for the back-end. This folder does almost all of the "heavy lifting" for the framework. |
/process/ | Contains special endpoints to be triggered by JavaScript functionality from the front-end. Generally used when a "raw" API call doesn't contain the business logic needed to complete a function and we are already passed the "controller" layer. |
/templates/ | Old-school folder containing template files still used by some parts of the administrator dashboard. This folder is due to be depracted. |
/tpl/ | Contains the twig files for the Twig Templating Engine. |
/vendor/ | Files from libraries imported by Composer upon installation / development. |