Add type hinting and return types to all functions in library classes #4072
Description
We are making an effort to use typing everywhere we can in LORIS. This issue will track the status of which of the classes php/libraries have been covered.
In Progress
- UserPerms [Core: UserPermissions] Add type declarations to function signatures #4051
- Config [Core: Config] Add type declarations to function signatures #4127
- NDB_BVL_Instrument [Core: Instrument, Instrument_LINST, instrument_preview] Add type declarations to function signatures #4073
- NDB_BVL_InstrumentStatus and _ControlPanel [Core: InstrumentStatus] Add type declarations to function signatures #4126
- NDB_Caller [Core: NDB_Caller] Add type declarations to function signatures #4125
- CouchDB [Core: CouchDB] Add type declarations to function signatures #4089
- User [Core: User] Add type declarations to function signatures #4027
- NDB_Factory [Core: NDB_Factory] Add type declarations to function signatures #4123
TODO
- Everything else!
Done -- 21.0 release
- Candidate [Core: Candidate] Add type declarations to function signatures #4047
- Site [Core: Site] Add type declarations to function signatures #4045
- Project, ProjectDefault [Core: Project, ProjectDefault] Add type declarations to function signatures #4053
- SinglePointLogin [Core: SinglePointLogin] Add type declarations to function signatures #4048
- Utility [Core: Utility] Add type declarations to function signatures #4046
- Client [Core: Client] Add type declarations to function signatures #4091
- Settings [Core: Settings] Add type declarations to function signatures #4090
- Breadcrumbs*
- Visit*
- Database [Core: Database] Add type declarations to function signatures #3878
- TimePoint [Core: TimePoint] Add type declarations to function signatures #4049
- BVL_Feedback_Panel [Core: BVL_Feedback_Panel] Add type declarations to function signatures #4124
Postponed until LORIS 22
- LorisForm [Core: LorisForm] Add type declarations to function signatures #4122
- NDB_Page and child classes [Core: NDB Page and Children] Add return types to function signatures #4139
- NDB_Form
- NDB_Menu_Filter
- NDB_Menu_Filter_Form