How subjectsplus/subjectsplus works
Project type and purpose
• Full-stack, monolithic PHP web application (LAMP/WAMP)
• Two main “faces”: an administrative backend (“control” directory) and a public site (“subjects” directory)
File structure
• Top-level web entry points
– index.php (root) → routes to control (admin) or public modules based on URL
– healthcheck.php
• Directories
– control/ → PHP scripts and helpers for admin UI (user management, guide‐building, stats, LTI)
– subjects/ → public site scripts, theming, view templates
– api/ → lightweight endpoints (e.g., adddisciplinedescription.php)
– addons/ → LTI integrations (Blackboard LTI 1.x & 1.3)
– lib/ → third-party libraries and core business logic (“SubjectsPlus/Control”, “SubjectsPlus/API”)
– assets/ → CSS, JS, images, localization files
– oai/ → OAI-PMH XML feeds and XSLT transforms
• Configuration & build files
– composer.json / composer.lock
– .htaccess-default in api/
– control/includes/config-default.php
README
• Tech stack requirements: PHP 5.3–5.6, MySQL 4–5.6, Apache (or IIS)
• PHP extensions: cURL, mbstring, simplexml, json, gettext, gd
• Links out to API documentation, installation wiki
Main components & interactions
A. Web Server Layer
– Apache (or IIS)
– Virtual hosts pointing at document root
B. PHP Application Layer
1. Front Controllers
• root/index.php → dispatch to control/ or subjects/ modules
• api/index.php → handles REST-like calls
2. Admin UI (control/)
• PHP pages + includes → call into lib/SubjectsPlus/Control classes
• LTI controller (control/lti_controller/)
3. Public Site (subjects/)
• Themed scripts + view includes → call into lib/SubjectsPlus/Control and API classes
4. Core Business Logic (lib/SubjectsPlus/Control & lib/SubjectsPlus/API)
• Controllers orchestrate operations, data validation, templating
• API layer (DatabaseWebService, GuidesWebService, etc.) provides JSON/XML endpoints
C. Data Layer
– MySQL database
– Tables for guides, disciplines, staff, FAQs, videos, logs, LTI credentials
D. Static Asset Pipeline
– Assetic (lib/Assetic) compiles & caches CSS/JS/images
– CKEditor (ckeditor/) integrated for rich text editing in admin
– Select2, jQuery, FontAwesome under assets/
E. External Services
– SMTP server via PHPMailer (lib/PHPMailer) for email notifications
– Google reCAPTCHA (lib/ReCaptcha) for spam prevention
– Blackboard LTI tool providers (api, addons/bb-lti)
– OAI-PMH consumers (oai/)
– Optional: external resource APIs via pluslets (e.g., Google Books)
Architectural patterns & design principles
• Layered architecture (Presentation → Business Logic → Data)
• Modular separation: Admin (“control”) vs. Public (“subjects”) vs. API vs. LTI vs. OAI
• Dependency management via Composer (third-party libs under lib/)
• CSRF protection via CSRF-Protector (lib/CSRF-Protector-PHP-nojs)
• Internationalization via gettext (assets/locale)
Essential elements
• Component labels (e.g., “control/index.php”, “SubjectsPlus/Control/Guide”, “MySQL DB”)
– Blue for application modules
– Green for infrastructure (web server, DB)
– Orange for external integrations