How quintoche/discite-php works
Project type and purpose
• This is an open-source PHP library (Discite-PHP) implementing a MySQLi-based, fluent, object-oriented query builder.
• Its purpose is to give PHP applications a modular, secure, configurable API to construct, format, execute, and retrieve SQL queries without hand-crafting SQL strings.
File structure
• Top-level directories:
• src/ — core library organized under DisciteDB namespace
• example/ — sample scripts demonstrating usage
• tests/ — PHPUnit test cases
• Under src/DisciteDB:
• Config — configuration definitions and enums
• Core — managers (QueryManager, TablesManager, etc.)
• Connection, Database, DisciteDB entry classes
• QueryHandler — builder, handlers, result classes
• Sql — clause/data/format/loading submodules
• Fields, Keys, Methods (condition, modifier), Operators, Security, Utilities, Exceptions
• Config files, traits, and enums show extensibility points; QueryHandler + Sql modules implement the builder and SQL formatting.
README insights
• External dependency: a MySQLi connection supplied by the host application
• Features: injection protection, modular configuration (charset, collation, naming, joins, etc.), strict/loose modes, key/table definitions
• Usage pattern: Application → Database class → Configuration → table(…) → listing() / count() → fetchAll()/fetchQuery()
a. Main components
1. Application Code
2. DisciteDB Entry Points
• Database (connection wrapper)
• DisciteDB (static constants)
3. Configuration Module
• Config classes & Enums
• Traits for KeysManager, TablesManager, LogsManager
4. Core Managers
• QueryManager
• TablesManager
• UsersManager, KeysManager, LogsManager
• SecurityManager, DebugManager, ExceptionsManager
5. Query Handler & Builder
• QueryBuilder, Handler classes (Argument, Structure, Template, Join, Modifier)
6. SQL Generator & Formatter
• Clause, Data, Format submodules under Sql/
7. Execution Layer
• Connection (wraps MySQLi)
• QueryHandler→QueryResult
8. Result Handling
• Result, ResultData, ResultInformations, ResultAsync
9. Utilities & Exceptions
• NameSanitizer, ValidateJson
• Exceptions hierarchy
10. External MySQL Server
b. Relationships & interactions
1. App calls Database($mysqli) → returns Database instance
2. App configures via Database->configuration() → updates Config module
3. App invokes table('name')->listing(…) → QueryManager uses Config to validate keys/tables
4. QueryManager constructs an abstract query representation using QueryHandler
5. QueryHandler delegates to Clause/Data/Format classes to generate SQL string
6. Generated SQL passes to Connection for execution on MySQL
7. MySQL response flows back into QueryResult classes → App fetches rows/information
8. SecurityManager & DebugManager intercept as configured (CSRF, sanitize, logs)
9. ExceptionsManager handles any errors from connection, query, or security violations
c. Architectural patterns & design principles
• Fluent Interface / Builder pattern (QueryBuilder)
• Modular configuration (Strategy via Config enums)
• Separation of Concerns: Connection vs. QueryBuilding vs. Formatting vs. Execution vs. Result
• Extensibility via Traits and Interfaces (custom keys, tables, handlers)
• Single Responsibility for each Manager and Handler
d. Key technologies, frameworks, libraries
• PHP (namespaces, Composer autoload)
• MySQLi (native PHP extension)
• PHPUnit (tests)