TASK-1: Major refactor to implement design patterns

[andrewgos]

What

Major refactoring to implement design patterns:

• Repository pattern: to manage data access layering and promote SRP
• Builder pattern: to generate school hierarchy
• Composite pattern: to handle the previewing of the entities

Technical Decisions

• While building the school, the courses and users are looped separately to avoid redundant loops
• Directory aren't separated by Domain folder to avoid over-engineering the project structure
• Local file name data.json is stored in a constant instead of environment variable as it is a read-only at the moment

Future Improvements

• Normalise data.json to have separate "enrolments" to make it more modular and easier to maintain. It will be simpler without the need to loop through users every time we want to get enrolments. Plus, it will help if we migrate to databases and make it easier to work with ORM tools too
• Introduce containerisation for the Dependency Injection (at the moment its all through lib.php)
• If the complexity of the models arises, consider using Factory pattern
• Add identifiers to the users data (ie. IDs)
• Store the data source access data.json to be an environment variable

Tests

• Unit tested ✅
  

• Manually tested the CRUDs ✅ (screenshots are the read-all)

  • school.php
    

  • courses.php
    

  • users.php