Basic expense tracking software. This is my first project using the Fat-Free Framework.

It uses the Fat Free Framework, a lightweight PHP framework, and follows the example in Fat-Free CRUD with MVC

It also makes use of the following components:

• sorttable: HTML5/Javascript table with sorting capabilities. It is quite handy when working with data.
• phpGraph: SVG charts from PHP data
• PhpSpreadsheet: For importing XLSX files.
• parsecsv-for-php: For importing csv files.
• pdfparser: For importing PDF files.

The code is structured as follows:

• app : Actual application code. Follows an MVC arrangement.
  • classes : Misc classes that are autoloaded by the Framework.
    1. Fm : Form shortcuts
    2. phpGraph : PHP SVG graph class
    3. Sc : Misc. Shorcuts (to use in view templates and reduce typing)
  • models : Data Access Objects.
  • controllers : Main classes that do stuff. Some classes worth mentioning:
    1. AppMain : Main window (shows the welcome dashboard)
    2. BackupController : Handles backups and restores
    3. ImportController : Manages bulk imports
    4. RptSummary : Generate year summary reports
  • views : Mostly PHP templates as HTML with embedded codes. But also JavaScript is in there.
• config : FatFree configuration files.
• data : contains data that will be editable from the web interface.
  • rules.php : Used to assign categories to posting date.
  • triggers.php : Used to generate postings automatically (i.e. to balance accounts)
  • Importers/ : Contains classes used when importing bank data
• lib : symlink to PHP libraries
• scripts : utility scripts for bootstraping and maintenance
  • init.sql : Use php index.php /restore scripts/init.sql to initialize the MySQL database.
  • newtest : ./scripts/newtest ../NeuSol ../NeuDev to copy production to test.
  • secfg : Apply selinux contexts and UNIX permissions.
  • upgrade.sql : Upgrade schema.
• submodules : where all the git modules are registered.
• ui : static files that used for rendering the user interface.

• Web Server (Tested on Apache 2.4.52)
• PHP (Tested on 7.4.26)
• MariaDB (Tested on 10.3.32)

The web server must have mod_rewrite enabled and allow .htaccess overrides.

1. Create a directory in your web server, e.g. NeuSol. The name NeuDev is special for a test instance. In that case the nonprod-config.ini is also read and needs to be configured.
2. git clone --recursive https://github.com/iliu-net/NeuSol.git NeuSol
3. If on a SELINUX system you may need to run:
   • scripts/secfg
4. Create a database and a database user
   • create database pfm;
   • GRANT ALL PRIVILEGES ON pfm.* TO 'pfm'@'localhost' IDENTIFIED BY 'mypass';
5. Configure this in config/config.ini
6. Initialize the database schema:
   • php index.php /orestore scripts/init.sql
7. Point your web-browser to your app directory.

• More in-depth business rules can be created in:
  • data/rules.php
  • data/triggers.php
• Custom importers can be added in:
  • data/Importers/*.php

• Balance is the amount at the end of the day.

OK, so this is my first try at an FatFree MVC web application. So somethings I learned:

1. We need to dwelve better into FatFree's autoloading capabilities and how namespaces are handled.
2. In routes.ini we declare route => {controller}->{method}, I think it would be cleaner if we had: route => {controller}->view, and then in the view function we declare: function view($f3,$params). Well, $params[0] has the route itself, which actually should refer to a view in the view folder.
3. The models are actually DAO. We should name these accordingly with a DAO suffix. (This has to do with the fact that we are using a flat namespace)
4. There ought to be a good way to abstract how reports are done. We are not there yet.
5. When FatFree makes the Hive available in templates as variables, these variables are already escaped. If you want to use the raw variables (unscaped) you should use the $f3->get method to read the Hive directly.