User Tools

Site Tools


content:servalmaps:visualisation_architecture

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision
Previous revision
content:servalmaps:visualisation_architecture [09/04/2013 20:24]
Corey Wallis created
content:servalmaps:visualisation_architecture [14/05/2013 23:18] (current)
Line 10: Line 10:
   * webroot/assets/ - assets used in the visualisation, including css files, images and javascript code   * webroot/assets/ - assets used in the visualisation, including css files, images and javascript code
   * webroot/admin/ - root of the application component of the website   * webroot/admin/ - root of the application component of the website
 +  * webroot/admin/index.php - entry point for the PHP application
   * webroot/admin/cache/ - cached and processed data used in the visualisation   * webroot/admin/cache/ - cached and processed data used in the visualisation
   * webroot/admin/data/ - raw data files, used to construct the cached data   * webroot/admin/data/ - raw data files, used to construct the cached data
   * webroot/admin/libraries/ - PHP libraries used by the website, as managed using [[http://getcomposer.org/|Composer]]   * webroot/admin/libraries/ - PHP libraries used by the website, as managed using [[http://getcomposer.org/|Composer]]
   * webroot/admin/logs/ - log files created by the website   * webroot/admin/logs/ - log files created by the website
-  * webroot/admin/ServalMaps/ - the custom PHP files that are used to manage the data and cache+  * webroot/admin/ServalMaps/ - the custom PHP files and classes that are used to manage the data and cache
   * webroot/admin/templates/ - static template files used to construct the admin panel   * webroot/admin/templates/ - static template files used to construct the admin panel
 +
 +The admin section of a visualisation is built using the [[http://www.slimframework.com/|Slim Framework]]. This is a lightweight PHP framework with support for things as pretty urls and application management. 
 +
 +===== PHP Classes =====
 +
 +The following PHP classes comprise the admin application
 +
 +  * CacheManager - provides functionality to reset the cache directories.
 +  * DownloadManager - manages the data related to making arbitrary downloads available, such as PDF files etc. 
 +  * ExportXFormInstance - maintains the spreadsheet that can be downloaded containing all data in the instance (completed survey) files
 +  * FileUtils - provides general file related utility methods
 +  * KmlManager - manages the construction of metadata used to access KML based GPS traces
 +  * MarkerIndex - creates the index data used to filter markers on the map
 +  * StringUtils - provides general string related utility methods
 +  * ValueMap - creates a map between the values recorded for an answer and their full text descriptions
 +  * XFormForm - manages all aspects of the creation of cached data related to the XForm definitions
 +  * XFormInstance - manages all aspects of the create of cached data related to completed forms
 +
 +Additional information related to each class is available as code comments in the PHP file for the class
  
  
content/servalmaps/visualisation_architecture.1365564241.txt.gz · Last modified: 09/04/2013 20:24 by Corey Wallis